Merge branch 'master' into keywords

ferdikoomen · web-flow · commit 31ce4a23dfbb · 2022-10-28T10:41:27.000+02:00
diff --git a/README.md b/README.md
@@ -48,7 +48,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     -h, --help                display help for command
 
diff --git a/bin/index.js b/bin/index.js
@@ -21,7 +21,9 @@ const params = program
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
     .option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
-    .option('--postfix <value>', 'Service name postfix', 'Service')
+    .option('--postfix <value>', 'Deprecated: Use --postfixServices instead. Service name postfix', 'Service')
+    .option('--postfixServices <value>', 'Service name postfix', 'Service')
+    .option('--postfixModels <value>', 'Model name postfix')
     .option('--request <value>', 'Path to custom request file')
     .parse(process.argv)
     .opts();
@@ -41,7 +43,8 @@ if (OpenAPI) {
         exportModels: JSON.parse(params.exportModels) === true,
         exportSchemas: JSON.parse(params.exportSchemas) === true,
         indent: params.indent,
-        postfix: params.postfix,
+        postfixServices: params.postfixServices ?? params.postfix,
+        postfixModels: params.postfixModels,
         request: params.request,
     })
         .then(() => {
diff --git a/bin/index.spec.js b/bin/index.spec.js
@@ -34,8 +34,10 @@ describe('bin', () => {
             'true',
             '--indent',
             '4',
-            '--postfix',
+            '--postfixServices',
             'Service',
+            '--postfixModels',
+            'Dto',
         ]);
         expect(result.stdout.toString()).toBe('');
         expect(result.stderr.toString()).toBe('');
@@ -67,4 +69,18 @@ describe('bin', () => {
         expect(result.stdout.toString()).toContain(`-o, --output <value>`);
         expect(result.stderr.toString()).toBe('');
     });
+
+    it('should still support the deprecated --postfix parameter', () => {
+        const result = crossSpawn.sync('node', [
+            './bin/index.js',
+            '--input',
+            './test/spec/v3.json',
+            '--output',
+            './test/generated/bin',
+            '--postfix',
+            'Service',
+        ]);
+        expect(result.stdout.toString()).toBe('');
+        expect(result.stderr.toString()).toBe('');
+    });
 });
diff --git a/docs/basic-usage.md b/docs/basic-usage.md
@@ -18,7 +18,8 @@ $ openapi --help
     --exportModels <value>    Write models to disk (default: true)
     --exportSchemas <value>   Write schemas to disk (default: false)
     --indent <value>          Indentation options [4, 2, tab] (default: "4")
-    --postfix <value>         Service name postfix (default: "Service")
+    --postfixServices         Service name postfix (default: "Service")
+    --postfixModels           Model name postfix
     --request <value>         Path to custom request file
     -h, --help                display help for command
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -78,27 +78,27 @@
         "@angular/platform-browser-dynamic": "14.0.1",
         "@angular/router": "14.0.1",
         "@babel/cli": "7.18.10",
-        "@babel/core": "7.18.10",
-        "@babel/preset-env": "7.18.10",
+        "@babel/core": "7.18.13",
+        "@babel/preset-env": "7.19.0",
         "@babel/preset-typescript": "7.18.6",
         "@rollup/plugin-commonjs": "22.0.2",
         "@rollup/plugin-node-resolve": "13.3.0",
-        "@rollup/plugin-typescript": "8.3.4",
+        "@rollup/plugin-typescript": "8.5.0",
         "@types/cross-spawn": "6.0.2",
         "@types/express": "4.17.13",
         "@types/fs-extra": "^9.0.13",
         "@types/glob": "7.2.0",
-        "@types/jest": "28.1.6",
-        "@types/node": "18.6.5",
+        "@types/jest": "28.1.8",
+        "@types/node": "18.7.17",
         "@types/node-fetch": "2.6.1",
         "@types/qs": "6.9.7",
-        "@typescript-eslint/eslint-plugin": "5.33.0",
-        "@typescript-eslint/parser": "5.33.0",
+        "@typescript-eslint/eslint-plugin": "5.36.2",
+        "@typescript-eslint/parser": "5.37.0",
         "abort-controller": "3.0.0",
         "axios": "0.27.2",
         "codecov": "3.8.3",
         "cross-spawn": "7.0.3",
-        "eslint": "8.21.0",
+        "eslint": "8.23.1",
         "eslint-config-prettier": "8.5.0",
         "eslint-plugin-prettier": "4.2.1",
         "eslint-plugin-simple-import-sort": "7.0.0",
@@ -111,13 +111,13 @@
         "puppeteer": "15.5.0",
         "qs": "6.11.0",
         "rimraf": "3.0.2",
-        "rollup": "2.77.2",
+        "rollup": "2.79.0",
         "rollup-plugin-terser": "7.0.2",
         "rxjs": "7.5.6",
         "ts-node": "10.9.1",
         "tslib": "2.4.0",
         "typescript": "4.7.3",
-        "zone.js": "0.11.7"
+        "zone.js": "0.11.8"
     },
     "resolutions": {
         "node-fetch": "2.6.7"
diff --git a/src/index.ts b/src/index.ts
@@ -24,7 +24,8 @@ export type Options = {
     exportModels?: boolean;
     exportSchemas?: boolean;
     indent?: Indent;
-    postfix?: string;
+    postfixServices?: string;
+    postfixModels?: string;
     request?: string;
     write?: boolean;
 };
@@ -44,7 +45,8 @@ export type Options = {
  * @param exportModels Generate models
  * @param exportSchemas Generate schemas
  * @param indent Indentation options (4, 2 or tab)
- * @param postfix Service name postfix
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
  * @param request Path to custom request file
  * @param write Write the files to disk (true or false)
  */
@@ -60,7 +62,8 @@ export const generate = async ({
     exportModels = true,
     exportSchemas = false,
     indent = Indent.SPACE_4,
-    postfix = 'Service',
+    postfixServices = 'Service',
+    postfixModels = '',
     request,
     write = true,
 }: Options): Promise<void> => {
@@ -89,7 +92,8 @@ export const generate = async ({
                 exportModels,
                 exportSchemas,
                 indent,
-                postfix,
+                postfixServices,
+                postfixModels,
                 clientName,
                 request
             );
@@ -112,7 +116,8 @@ export const generate = async ({
                 exportModels,
                 exportSchemas,
                 indent,
-                postfix,
+                postfixServices,
+                postfixModels,
                 clientName,
                 request
             );
diff --git a/src/openApi/v3/parser/getModel.ts b/src/openApi/v3/parser/getModel.ts
@@ -95,9 +95,13 @@ export const getModel = (
         }
     }
 
-    if (definition.type === 'object' && typeof definition.additionalProperties === 'object') {
-        if (definition.additionalProperties.$ref) {
-            const additionalProperties = getType(definition.additionalProperties.$ref);
+    if (
+        definition.type === 'object' &&
+        (typeof definition.additionalProperties === 'object' || definition.additionalProperties === true)
+    ) {
+        const ap = typeof definition.additionalProperties === 'object' ? definition.additionalProperties : {};
+        if (ap.$ref) {
+            const additionalProperties = getType(ap.$ref);
             model.export = 'dictionary';
             model.type = additionalProperties.type;
             model.base = additionalProperties.base;
@@ -106,7 +110,7 @@ export const getModel = (
             model.default = getModelDefault(definition, model);
             return model;
         } else {
-            const additionalProperties = getModel(openApi, definition.additionalProperties);
+            const additionalProperties = getModel(openApi, ap);
             model.export = 'dictionary';
             model.type = additionalProperties.type;
             model.base = additionalProperties.base;
@@ -146,12 +150,12 @@ export const getModel = (
     }
 
     if (definition.type === 'object') {
-        model.export = 'interface';
-        model.type = 'any';
-        model.base = 'any';
-        model.default = getModelDefault(definition, model);
-
         if (definition.properties) {
+            model.export = 'interface';
+            model.type = 'any';
+            model.base = 'any';
+            model.default = getModelDefault(definition, model);
+
             const modelProperties = getModelProperties(openApi, definition, getModel, model);
             modelProperties.forEach(modelProperty => {
                 model.imports.push(...modelProperty.imports);
@@ -161,8 +165,18 @@ export const getModel = (
                     model.enums.push(modelProperty);
                 }
             });
+            return model;
+        } else {
+            const additionalProperties = getModel(openApi, {});
+            model.export = 'dictionary';
+            model.type = additionalProperties.type;
+            model.base = additionalProperties.base;
+            model.template = additionalProperties.template;
+            model.link = additionalProperties;
+            model.imports.push(...additionalProperties.imports);
+            model.default = getModelDefault(definition, model);
+            return model;
         }
-        return model;
     }
 
     // If the schema has a type than it can be a basic or generic type.
diff --git a/src/templates/core/fetch/getResponseBody.hbs b/src/templates/core/fetch/getResponseBody.hbs
@@ -3,7 +3,8 @@ const getResponseBody = async (response: Response): Promise<any> => {
 		try {
 			const contentType = response.headers.get('Content-Type');
 			if (contentType) {
-				const isJSON = contentType.toLowerCase().startsWith('application/json');
+				const jsonTypes = ['application/json', 'application/problem+json']
+				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return await response.json();
 				} else {
diff --git a/src/templates/core/node/getResponseBody.hbs b/src/templates/core/node/getResponseBody.hbs
@@ -3,7 +3,8 @@ const getResponseBody = async (response: Response): Promise<any> => {
 		try {
 			const contentType = response.headers.get('Content-Type');
 			if (contentType) {
-				const isJSON = contentType.toLowerCase().startsWith('application/json');
+				const jsonTypes = ['application/json', 'application/problem+json']
+				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return await response.json();
 				} else {
diff --git a/src/templates/core/xhr/getResponseBody.hbs b/src/templates/core/xhr/getResponseBody.hbs
@@ -3,7 +3,8 @@ const getResponseBody = (xhr: XMLHttpRequest): any => {
 		try {
 			const contentType = xhr.getResponseHeader('Content-Type');
 			if (contentType) {
-				const isJSON = contentType.toLowerCase().startsWith('application/json');
+				const jsonTypes = ['application/json', 'application/problem+json']
+				const isJSON = jsonTypes.some(type => contentType.toLowerCase().startsWith(type));
 				if (isJSON) {
 					return JSON.parse(xhr.responseText);
 				} else {
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -32,7 +32,9 @@ import { request as __request } from '../core/request';
 {{/if}}
 
 {{#equals @root.httpClient 'angular'}}
-@Injectable()
+@Injectable({
+  providedIn: 'root',
+})
 {{/equals}}
 export class {{{name}}}{{{@root.postfix}}} {
 	{{#if @root.exportClient}}
diff --git a/src/templates/index.hbs b/src/templates/index.hbs
@@ -18,13 +18,13 @@ export type { OpenAPIConfig } from './core/OpenAPI';
 
 {{#each models}}
 {{#if @root.useUnionTypes}}
-export type { {{{name}}} } from './models/{{{name}}}';
+export type { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else if enum}}
-export { {{{name}}} } from './models/{{{name}}}';
+export { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else if enums}}
-export { {{{name}}} } from './models/{{{name}}}';
+export { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{else}}
-export type { {{{name}}} } from './models/{{{name}}}';
+export type { {{{name}}}{{#if @root.postfixModels}} as {{{name}}}{{{@root.postfixModels}}}{{/if}} } from './models/{{{name}}}';
 {{/if}}
 {{/each}}
 {{/if}}
@@ -41,7 +41,7 @@ export { ${{{name}}} } from './schemas/${{{name}}}';
 {{#if services}}
 
 {{#each services}}
-export { {{{name}}}{{{@root.postfix}}} } from './services/{{{name}}}{{{@root.postfix}}}';
+export { {{{name}}}{{{@root.postfixServices}}} } from './services/{{{name}}}{{{@root.postfixServices}}}';
 {{/each}}
 {{/if}}
 {{/if}}
diff --git a/src/utils/getPattern.spec.ts b/src/utils/getPattern.spec.ts
@@ -10,5 +10,7 @@ describe('getPattern', () => {
         expect(getPattern('\\')).toEqual('\\\\');
         expect(getPattern('\\/')).toEqual('\\\\/');
         expect(getPattern('\\/\\/')).toEqual('\\\\/\\\\/');
+        // eslint-disable-next-line prettier/prettier
+        expect(getPattern("'")).toEqual("\\'");
     });
 });
diff --git a/src/utils/getPattern.ts b/src/utils/getPattern.ts
@@ -3,8 +3,12 @@
  * However, to use it in HTML or inside new RegExp() we need to
  * escape the pattern to become: '^\\d{3}-\\d{2}-\\d{4}$' in order
  * to make it a valid regexp string.
+ *
+ * Also, escape single quote characters, because the output uses single quotes for strings
+ *
  * @param pattern
  */
 export const getPattern = (pattern?: string): string | undefined => {
-    return pattern?.replace(/\\/g, '\\\\');
+    // eslint-disable-next-line prettier/prettier
+    return pattern?.replace(/\\/g, '\\\\').replace(/'/g, "\\'");
 };
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -28,7 +28,8 @@ import { writeClientServices } from './writeClientServices';
  * @param exportSchemas Generate schemas
  * @param exportSchemas Generate schemas
  * @param indent Indentation options (4, 2 or tab)
- * @param postfix Service name postfix
+ * @param postfixServices Service name postfix
+ * @param postfixModels Model name postfix
  * @param clientName Custom client class name
  * @param request Path to custom request file
  */
@@ -44,7 +45,8 @@ export const writeClient = async (
     exportModels: boolean,
     exportSchemas: boolean,
     indent: Indent,
-    postfix: string,
+    postfixServices: string,
+    postfixModels: string,
     clientName?: string,
     request?: string
 ): Promise<void> => {
@@ -75,7 +77,7 @@ export const writeClient = async (
             useUnionTypes,
             useOptions,
             indent,
-            postfix,
+            postfixServices,
             clientName
         );
     }
@@ -94,7 +96,7 @@ export const writeClient = async (
 
     if (isDefined(clientName)) {
         await mkdir(outputPath);
-        await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfix);
+        await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfixServices);
     }
 
     if (exportCore || exportServices || exportSchemas || exportModels) {
@@ -108,7 +110,8 @@ export const writeClient = async (
             exportServices,
             exportModels,
             exportSchemas,
-            postfix,
+            postfixServices,
+            postfixModels,
             clientName
         );
     }
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -34,7 +34,7 @@ describe('writeClientIndex', () => {
             },
         };
 
-        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service');
+        await writeClientIndex(client, templates, '/', true, true, true, true, true, 'Service', '');
 
         expect(writeFile).toBeCalledWith('/index.ts', 'index');
     });
diff --git a/src/utils/writeClientIndex.ts b/src/utils/writeClientIndex.ts
diff --git a/test/__snapshots__/index.spec.ts.snap b/test/__snapshots__/index.spec.ts.snap
diff --git a/test/index.spec.ts b/test/index.spec.ts
diff --git a/test/spec/v2.json b/test/spec/v2.json
diff --git a/test/spec/v3.json b/test/spec/v3.json
diff --git a/types/index.d.ts b/types/index.d.ts
