- Working on support for formData in v3

Author: Ferdi Koomen

.prettierrc.json

@@ -3,6 +3,6 @@
     "singleQuote": true,
     "trailingComma": "es5",
     "arrowParens": "avoid",
-    "printWidth": 200,
+    "printWidth": 120,
     "tabWidth": 4
 }

src/client/interfaces/Schema.d.ts

@@ -3,7 +3,18 @@ export interface Schema {
     isReadOnly: boolean;
     isRequired: boolean;
     isNullable: boolean;
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    format?:
+        | 'int32'
+        | 'int64'
+        | 'float'
+        | 'double'
+        | 'string'
+        | 'boolean'
+        | 'byte'
+        | 'binary'
+        | 'date'
+        | 'date-time'
+        | 'password';
     maximum?: number;
     exclusiveMaximum?: boolean;
     minimum?: number;

src/index.ts

@@ -66,15 +66,39 @@ export async function generate({
             const client = parseV2(openApi);
             const clientFinal = postProcessClient(client);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+            await writeClient(
+                clientFinal,
+                templates,
+                output,
+                httpClient,
+                useOptions,
+                useUnionTypes,
+                exportCore,
+                exportServices,
+                exportModels,
+                exportSchemas,
+                request
+            );
             break;
         }
 
         case OpenApiVersion.V3: {
             const client = parseV3(openApi);
             const clientFinal = postProcessClient(client);
             if (!write) break;
-            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
+            await writeClient(
+                clientFinal,
+                templates,
+                output,
+                httpClient,
+                useOptions,
+                useUnionTypes,
+                exportCore,
+                exportServices,
+                exportModels,
+                exportSchemas,
+                request
+            );
             break;
         }
     }

src/openApi/v2/interfaces/OpenApiHeader.d.ts

@@ -7,7 +7,18 @@ import type { OpenApiItems } from './OpenApiItems';
 export interface OpenApiHeader {
     description?: string;
     type: 'string' | 'number' | 'integer' | 'boolean' | 'array';
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    format?:
+        | 'int32'
+        | 'int64'
+        | 'float'
+        | 'double'
+        | 'string'
+        | 'boolean'
+        | 'byte'
+        | 'binary'
+        | 'date'
+        | 'date-time'
+        | 'password';
     items?: Dictionary<OpenApiItems>;
     collectionFormat?: 'csv' | 'ssv' | 'tsv' | 'pipes';
     default?: any;

src/openApi/v2/interfaces/OpenApiItems.d.ts

@@ -5,7 +5,18 @@ import type { WithEnumExtension } from './Extensions/WithEnumExtension';
  */
 export interface OpenApiItems extends WithEnumExtension {
     type?: string;
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    format?:
+        | 'int32'
+        | 'int64'
+        | 'float'
+        | 'double'
+        | 'string'
+        | 'boolean'
+        | 'byte'
+        | 'binary'
+        | 'date'
+        | 'date-time'
+        | 'password';
     items?: OpenApiItems;
     collectionFormat?: 'csv' | 'ssv' | 'tsv' | 'pipes';
     default?: any;

src/openApi/v2/interfaces/OpenApiParameter.d.ts

@@ -14,7 +14,18 @@ export interface OpenApiParameter extends OpenApiReference, WithEnumExtension, W
     required?: boolean;
     schema?: OpenApiSchema;
     type?: string;
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    format?:
+        | 'int32'
+        | 'int64'
+        | 'float'
+        | 'double'
+        | 'string'
+        | 'boolean'
+        | 'byte'
+        | 'binary'
+        | 'date'
+        | 'date-time'
+        | 'password';
     allowEmptyValue?: boolean;
     items?: OpenApiItems;
     collectionFormat?: 'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';

src/openApi/v2/interfaces/OpenApiSchema.d.ts

@@ -28,7 +28,18 @@ export interface OpenApiSchema extends OpenApiReference, WithEnumExtension, With
     required?: string[];
     enum?: (string | number)[];
     type?: string;
-    format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+    format?:
+        | 'int32'
+        | 'int64'
+        | 'float'
+        | 'double'
+        | 'string'
+        | 'boolean'
+        | 'byte'
+        | 'binary'
+        | 'date'
+        | 'date-time'
+        | 'password';
     items?: OpenApiSchema;
     allOf?: OpenApiSchema[];
     properties?: Dictionary<OpenApiSchema>;

src/openApi/v2/parser/getComment.spec.ts

@@ -4,12 +4,25 @@ import { getComment } from './getComment';
 
 describe('getComment', () => {
     it('should parse comments', () => {
-        const multiline = 'Testing multiline comments.' + EOL + ' * This must go to the next line.' + EOL + ' * ' + EOL + ' * This will contain a break.';
+        const multiline =
+            'Testing multiline comments.' +
+            EOL +
+            ' * This must go to the next line.' +
+            EOL +
+            ' * ' +
+            EOL +
+            ' * This will contain a break.';
         expect(getComment('')).toEqual(null);
         expect(getComment('Hello')).toEqual('Hello');
         expect(getComment('Hello World!')).toEqual('Hello World!');
         expect(getComment('Testing */escape/*')).toEqual('Testing *_/escape/*');
-        expect(getComment('Testing multiline comments.\nThis must go to the next line.\n\nThis will contain a break.')).toEqual(multiline);
-        expect(getComment('Testing multiline comments.\r\nThis must go to the next line.\r\n\r\nThis will contain a break.')).toEqual(multiline);
+        expect(
+            getComment('Testing multiline comments.\nThis must go to the next line.\n\nThis will contain a break.')
+        ).toEqual(multiline);
+        expect(
+            getComment(
+                'Testing multiline comments.\r\nThis must go to the next line.\r\n\r\nThis will contain a break.'
+            )
+        ).toEqual(multiline);
     });
 });

src/openApi/v2/parser/getModel.ts

@@ -10,7 +10,12 @@ import { getModelComposition } from './getModelComposition';
 import { getModelProperties } from './getModelProperties';
 import { getType } from './getType';
 
-export function getModel(openApi: OpenApi, definition: OpenApiSchema, isDefinition: boolean = false, name: string = ''): Model {
+export function getModel(
+    openApi: OpenApi,
+    definition: OpenApiSchema,
+    isDefinition: boolean = false,
+    name: string = ''
+): Model {
     const model: Model = {
         name,
         export: 'interface',

src/openApi/v2/parser/getModelComposition.ts

@@ -9,7 +9,13 @@ import { getRequiredPropertiesFromComposition } from './getRequiredPropertiesFro
 // Fix for circular dependency
 export type GetModelFn = typeof getModel;
 
-export function getModelComposition(openApi: OpenApi, definition: OpenApiSchema, definitions: OpenApiSchema[], type: 'one-of' | 'any-of' | 'all-of', getModel: GetModelFn): ModelComposition {
+export function getModelComposition(
+    openApi: OpenApi,
+    definition: OpenApiSchema,
+    definitions: OpenApiSchema[],
+    type: 'one-of' | 'any-of' | 'all-of',
+    getModel: GetModelFn
+): ModelComposition {
     const composition: ModelComposition = {
         type,
         imports: [],
@@ -35,7 +41,12 @@ export function getModelComposition(openApi: OpenApi, definition: OpenApiSchema,
         });
 
     if (definition.required) {
-        const requiredProperties = getRequiredPropertiesFromComposition(openApi, definition.required, definitions, getModel);
+        const requiredProperties = getRequiredPropertiesFromComposition(
+            openApi,
+            definition.required,
+            definitions,
+            getModel
+        );
         requiredProperties.forEach(requiredProperty => {
             composition.imports.push(...requiredProperty.imports);
             composition.enums.push(...requiredProperty.enums);