Merge branch 'master' of github.com:ferdikoomen/openapi-typescript-codegen

ferdikoomen · ferdikoomen · commit c39e82fff50d · 2021-12-22T17:33:57.000+01:00
diff --git a/rollup.config.js b/rollup.config.js
@@ -32,6 +32,7 @@ const handlebarsPlugin = () => ({
                 preventIndent: true,
                 knownHelpersOnly: true,
                 knownHelpers: {
+                    escapeSinglequotes: true,
                     equals: true,
                     notEquals: true,
                     containsSpaces: true,
diff --git a/src/openApi/v2/parser/getOperationParameterName.ts b/src/openApi/v2/parser/getOperationParameterName.ts
@@ -1,7 +1,6 @@
 import camelCase from 'camelcase';
 
-const reservedWords =
-    /^(arguments|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|eval|export|extends|false|finally|for|function|if|implements|import|in|instanceof|interface|let|new|null|package|private|protected|public|return|static|super|switch|this|throw|true|try|typeof|var|void|while|with|yield)$/g;
+const reservedWords = /^(arguments|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|eval|export|extends|false|finally|for|function|if|implements|import|in|instanceof|interface|let|new|null|package|private|protected|public|return|static|super|switch|this|throw|true|try|typeof|var|void|while|with|yield)$/g;
 
 /**
  * Replaces any invalid characters from a parameter name.
diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -165,7 +165,7 @@ export function getModel(
         model.default = getModelDefault(definition, model);
 
         if (definition.properties) {
-            const modelProperties = getModelProperties(openApi, definition, getModel);
+            const modelProperties = getModelProperties(openApi, definition, getModel, model);
             modelProperties.forEach(modelProperty => {
                 model.imports.push(...modelProperty.imports);
                 model.enums.push(...modelProperty.enums);
diff --git a/src/openApi/v3/parser/getModelProperties.ts b/src/openApi/v3/parser/getModelProperties.ts
@@ -1,4 +1,5 @@
 import type { Model } from '../../../client/interfaces/Model';
+import { findOneOfParentDiscriminator, mapPropertyValue } from '../../../utils/discriminator';
 import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
@@ -10,77 +11,82 @@ import { getType } from './getType';
 // Fix for circular dependency
 export type GetModelFn = typeof getModel;
 
-export function getModelProperties(openApi: OpenApi, definition: OpenApiSchema, getModel: GetModelFn): Model[] {
+export function getModelProperties(
+    openApi: OpenApi,
+    definition: OpenApiSchema,
+    getModel: GetModelFn,
+    parent?: Model
+): Model[] {
     const models: Model[] = [];
+    const discriminator = findOneOfParentDiscriminator(openApi, parent);
     for (const propertyName in definition.properties) {
         if (definition.properties.hasOwnProperty(propertyName)) {
             const property = definition.properties[propertyName];
             const propertyRequired = !!definition.required?.includes(propertyName);
-            if (property.$ref) {
+            const propertyValues = {
+                name: escapeName(propertyName),
+                description: getComment(property.description),
+                isDefinition: false,
+                isReadOnly: property.readOnly === true,
+                isRequired: propertyRequired,
+                format: property.format,
+                maximum: property.maximum,
+                exclusiveMaximum: property.exclusiveMaximum,
+                minimum: property.minimum,
+                exclusiveMinimum: property.exclusiveMinimum,
+                multipleOf: property.multipleOf,
+                maxLength: property.maxLength,
+                minLength: property.minLength,
+                maxItems: property.maxItems,
+                minItems: property.minItems,
+                uniqueItems: property.uniqueItems,
+                maxProperties: property.maxProperties,
+                minProperties: property.minProperties,
+                pattern: getPattern(property.pattern),
+            };
+            if (parent && discriminator?.propertyName == propertyName) {
+                models.push({
+                    export: 'reference',
+                    type: 'string',
+                    base: `'${mapPropertyValue(discriminator, parent)}'`,
+                    template: null,
+                    isNullable: property.nullable === true,
+                    link: null,
+                    imports: [],
+                    enum: [],
+                    enums: [],
+                    properties: [],
+                    ...propertyValues,
+                });
+            } else if (property.$ref) {
                 const model = getType(property.$ref);
                 models.push({
-                    name: escapeName(propertyName),
                     export: 'reference',
                     type: model.type,
                     base: model.base,
                     template: model.template,
                     link: null,
-                    description: getComment(property.description),
-                    isDefinition: false,
-                    isReadOnly: property.readOnly === true,
-                    isRequired: propertyRequired,
                     isNullable: model.isNullable || property.nullable === true,
-                    format: property.format,
-                    maximum: property.maximum,
-                    exclusiveMaximum: property.exclusiveMaximum,
-                    minimum: property.minimum,
-                    exclusiveMinimum: property.exclusiveMinimum,
-                    multipleOf: property.multipleOf,
-                    maxLength: property.maxLength,
-                    minLength: property.minLength,
-                    maxItems: property.maxItems,
-                    minItems: property.minItems,
-                    uniqueItems: property.uniqueItems,
-                    maxProperties: property.maxProperties,
-                    minProperties: property.minProperties,
-                    pattern: getPattern(property.pattern),
                     imports: model.imports,
                     enum: [],
                     enums: [],
                     properties: [],
+                    ...propertyValues,
                 });
             } else {
                 const model = getModel(openApi, property);
                 models.push({
-                    name: escapeName(propertyName),
                     export: model.export,
                     type: model.type,
                     base: model.base,
                     template: model.template,
                     link: model.link,
-                    description: getComment(property.description),
-                    isDefinition: false,
-                    isReadOnly: property.readOnly === true,
-                    isRequired: propertyRequired,
                     isNullable: model.isNullable || property.nullable === true,
-                    format: property.format,
-                    maximum: property.maximum,
-                    exclusiveMaximum: property.exclusiveMaximum,
-                    minimum: property.minimum,
-                    exclusiveMinimum: property.exclusiveMinimum,
-                    multipleOf: property.multipleOf,
-                    maxLength: property.maxLength,
-                    minLength: property.minLength,
-                    maxItems: property.maxItems,
-                    minItems: property.minItems,
-                    uniqueItems: property.uniqueItems,
-                    maxProperties: property.maxProperties,
-                    minProperties: property.minProperties,
-                    pattern: getPattern(property.pattern),
                     imports: model.imports,
                     enum: model.enum,
                     enums: model.enums,
                     properties: model.properties,
+                    ...propertyValues,
                 });
             }
         }
diff --git a/src/openApi/v3/parser/getOperationParameterName.ts b/src/openApi/v3/parser/getOperationParameterName.ts
@@ -1,7 +1,6 @@
 import camelCase from 'camelcase';
 
-const reservedWords =
-    /^(arguments|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|eval|export|extends|false|finally|for|function|if|implements|import|in|instanceof|interface|let|new|null|package|private|protected|public|return|static|super|switch|this|throw|true|try|typeof|var|void|while|with|yield)$/g;
+const reservedWords = /^(arguments|break|case|catch|class|const|continue|debugger|default|delete|do|else|enum|eval|export|extends|false|finally|for|function|if|implements|import|in|instanceof|interface|let|new|null|package|private|protected|public|return|static|super|switch|this|throw|true|try|typeof|var|void|while|with|yield)$/g;
 
 /**
  * Replaces any invalid characters from a parameter name.
diff --git a/src/templates/core/fetch/getHeaders.hbs b/src/templates/core/fetch/getHeaders.hbs
@@ -33,7 +33,7 @@ async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
             headers.append('Content-Type', options.body.type || 'application/octet-stream');
         } else if (isString(options.body)) {
             headers.append('Content-Type', 'text/plain');
-        } else {
+        } else if (!isFormData(options.body)) {
             headers.append('Content-Type', 'application/json');
         }
     }
diff --git a/src/templates/core/fetch/getRequestBody.hbs b/src/templates/core/fetch/getRequestBody.hbs
@@ -2,7 +2,7 @@ function getRequestBody(options: ApiRequestOptions): BodyInit | undefined {
     if (options.body) {
         if (options.mediaType?.includes('/json')) {
             return JSON.stringify(options.body)
-        } else if (isString(options.body) || isBlob(options.body)) {
+        } else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) {
             return options.body;
         } else {
             return JSON.stringify(options.body);
diff --git a/src/templates/core/fetch/request.hbs b/src/templates/core/fetch/request.hbs
@@ -19,6 +19,9 @@ import { OpenAPI } from './OpenAPI';
 {{>functions/isBlob}}
 
 
+{{>functions/isFormData}}
+
+
 {{>functions/base64}}
 
 
diff --git a/src/templates/core/functions/isFormData.hbs b/src/templates/core/functions/isFormData.hbs
@@ -0,0 +1,3 @@
+function isFormData(value: any): value is FormData {
+    return value instanceof FormData;
+}
diff --git a/src/templates/core/node/getHeaders.hbs b/src/templates/core/node/getHeaders.hbs
@@ -33,7 +33,7 @@ async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
             headers.append('Content-Type', 'application/octet-stream');
         } else if (isString(options.body)) {
             headers.append('Content-Type', 'text/plain');
-        } else {
+        } else if (!isFormData(options.body)) {
             headers.append('Content-Type', 'application/json');
         }
     }
diff --git a/src/templates/core/node/getRequestBody.hbs b/src/templates/core/node/getRequestBody.hbs
@@ -2,7 +2,7 @@ function getRequestBody(options: ApiRequestOptions): BodyInit | undefined {
     if (options.body) {
         if (options.mediaType?.includes('/json')) {
             return JSON.stringify(options.body)
-        } else if (isString(options.body) || isBlob(options.body)) {
+        } else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) {
             return options.body as any;
         } else {
             return JSON.stringify(options.body);
diff --git a/src/templates/core/xhr/getHeaders.hbs b/src/templates/core/xhr/getHeaders.hbs
@@ -33,7 +33,7 @@ async function getHeaders(options: ApiRequestOptions): Promise<Headers> {
             headers.append('Content-Type', options.body.type || 'application/octet-stream');
         } else if (isString(options.body)) {
             headers.append('Content-Type', 'text/plain');
-        } else {
+        } else if (!isFormData(options.body)) {
             headers.append('Content-Type', 'application/json');
         }
     }
diff --git a/src/templates/core/xhr/getRequestBody.hbs b/src/templates/core/xhr/getRequestBody.hbs
@@ -2,7 +2,7 @@ function getRequestBody(options: ApiRequestOptions): any {
     if (options.body) {
         if (options.mediaType?.includes('/json')) {
             return JSON.stringify(options.body)
-        } else if (isString(options.body) || isBlob(options.body)) {
+        } else if (isString(options.body) || isBlob(options.body) || isFormData(options.body)) {
             return options.body;
         } else {
             return JSON.stringify(options.body);
diff --git a/src/templates/partials/schemaComposition.hbs b/src/templates/partials/schemaComposition.hbs
@@ -1,5 +1,8 @@
 {
     type: '{{export}}',
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
+{{/if}}
     contains: [{{#each properties}}{{>schema}}{{#unless @last}}, {{/unless}}{{/each}}],
 {{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
diff --git a/src/templates/partials/schemaGeneric.hbs b/src/templates/partials/schemaGeneric.hbs
@@ -1,6 +1,9 @@
 {
 {{#if type}}
-    type: '{{{base}}}',
+    type: '{{{type}}}',
+{{/if}}
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
 {{/if}}
 {{#if isReadOnly}}
     isReadOnly: {{{isReadOnly}}},
diff --git a/src/templates/partials/schemaInterface.hbs b/src/templates/partials/schemaInterface.hbs
@@ -1,4 +1,7 @@
 {
+{{#if description}}
+    description: '{{{escapeSinglequotes description}}}',
+{{/if}}
     properties: {
 {{#if properties}}
     {{#each properties}}
diff --git a/src/utils/discriminator.ts b/src/utils/discriminator.ts
@@ -0,0 +1,46 @@
+import { Model } from '../client/interfaces/Model';
+import { OpenApi } from '../openApi/v3/interfaces/OpenApi';
+import { OpenApiDiscriminator } from '../openApi/v3/interfaces/OpenApiDiscriminator';
+import { stripNamespace } from '../openApi/v3/parser/stripNamespace';
+import { Dictionary } from './types';
+
+const inverseDictionary = (mapObj: Dictionary<string>) => {
+    const m2: Dictionary<string> = {};
+    for (const key in mapObj) {
+        m2[mapObj[key]] = key;
+    }
+    return m2;
+};
+
+export function findOneOfParentDiscriminator(openApi: OpenApi, parent?: Model): OpenApiDiscriminator | undefined {
+    if (openApi.components) {
+        for (const definitionName in openApi.components.schemas) {
+            if (openApi.components.schemas.hasOwnProperty(definitionName)) {
+                const schema = openApi.components.schemas[definitionName];
+                if (parent && schema.oneOf?.length && schema.discriminator) {
+                    const isPartOf =
+                        schema.oneOf
+                            .map(definition => {
+                                return definition.$ref && stripNamespace(definition.$ref) == parent.name;
+                            })
+                            .filter(Boolean).length > 0;
+                    if (isPartOf) {
+                        return schema.discriminator;
+                    }
+                }
+            }
+        }
+    }
+    return undefined;
+}
+
+export function mapPropertyValue(discriminator: OpenApiDiscriminator, parent: Model): string {
+    if (discriminator.mapping) {
+        const mapping = inverseDictionary(discriminator.mapping);
+        const key = Object.keys(mapping).find(item => stripNamespace(item) == parent.name);
+        if (key && mapping[key]) {
+            return mapping[key];
+        }
+    }
+    return parent.name;
+}
diff --git a/src/utils/registerHandlebarHelpers.ts b/src/utils/registerHandlebarHelpers.ts
@@ -10,6 +10,10 @@ export function registerHandlebarHelpers(root: {
     useOptions: boolean;
     useUnionTypes: boolean;
 }): void {
+    Handlebars.registerHelper('escapeQuotes', function (value: string): string {
+        return value.replace(/(')/g, '\\$1');
+    });
+
     Handlebars.registerHelper(
         'equals',
         function (this: any, a: string, b: string, options: Handlebars.HelperOptions): string {
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -24,6 +24,7 @@ import functionGetQueryString from '../templates/core/functions/getQueryString.h
 import functionGetUrl from '../templates/core/functions/getUrl.hbs';
 import functionIsBlob from '../templates/core/functions/isBlob.hbs';
 import functionIsDefined from '../templates/core/functions/isDefined.hbs';
+import functionIsFormData from '../templates/core/functions/isFormData.hbs';
 import functionIsString from '../templates/core/functions/isString.hbs';
 import functionIsStringWithValue from '../templates/core/functions/isStringWithValue.hbs';
 import functionIsSuccess from '../templates/core/functions/isSuccess.hbs';
@@ -157,6 +158,7 @@ export function registerHandlebarTemplates(root: {
     Handlebars.registerPartial('functions/getUrl', Handlebars.template(functionGetUrl));
     Handlebars.registerPartial('functions/isBlob', Handlebars.template(functionIsBlob));
     Handlebars.registerPartial('functions/isDefined', Handlebars.template(functionIsDefined));
+    Handlebars.registerPartial('functions/isFormData', Handlebars.template(functionIsFormData));
     Handlebars.registerPartial('functions/isString', Handlebars.template(functionIsString));
     Handlebars.registerPartial('functions/isStringWithValue', Handlebars.template(functionIsStringWithValue));
     Handlebars.registerPartial('functions/isSuccess', Handlebars.template(functionIsSuccess));
diff --git a/test/__snapshots__/index.spec.js.snap b/test/__snapshots__/index.spec.js.snap
diff --git a/test/spec/v3.json b/test/spec/v3.json

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ async function getHeaders(options: ApiRequestOptions): Promise<Headers> {`
`33`	`33`	`headers.append('Content-Type', options.body.type \|\| 'application/octet-stream');`
`34`	`34`	`} else if (isString(options.body)) {`
`35`	`35`	`headers.append('Content-Type', 'text/plain');`
`36`		`- } else {`
	`36`	`+ } else if (!isFormData(options.body)) {`
`37`	`37`	`headers.append('Content-Type', 'application/json');`
`38`	`38`	`}`
`39`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+function isFormData(value: any): value is FormData {`
	`2`	`+ return value instanceof FormData;`
	`3`	`+}`