Merge remote-tracking branch 'upstream/master'

Author: markygab

README.md

@@ -130,7 +130,7 @@ The OpenAPI spec allows you to define [enums](https://swagger.io/docs/specificat
 data model. By default, we convert these enums definitions to [TypeScript enums](https://www.typescriptlang.org/docs/handbook/enums.html).
 However, these enums are merged inside the namespace of the model, this is unsupported by Babel, [see docs](https://babeljs.io/docs/en/babel-plugin-transform-typescript#impartial-namespace-support).
 Because we also want to support projects that use Babel [@babel/plugin-transform-typescript](https://babeljs.io/docs/en/babel-plugin-transform-typescript),
-we offer the flag `--useOptions` to generate [union types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-types)
+we offer the flag `--useUnionTypes` to generate [union types](https://www.typescriptlang.org/docs/handbook/unions-and-intersections.html#union-types)
 instead of the traditional enums. The difference can be seen below:
 
 **Enums:**

bin/index.js

@@ -19,6 +19,7 @@ program
     .option('--exportServices <value>', 'Write services to disk', true)
     .option('--exportModels <value>', 'Write models to disk', true)
     .option('--exportSchemas <value>', 'Write schemas to disk', false)
+    .option('--request <value>', 'Path to custom request file')
     .parse(process.argv);
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
@@ -34,6 +35,7 @@ if (OpenAPI) {
         exportServices: JSON.parse(program.exportServices) === true,
         exportModels: JSON.parse(program.exportModels) === true,
         exportSchemas: JSON.parse(program.exportSchemas) === true,
+        request: program.request,
     })
         .then(() => {
             process.exit(0);

jest.config.js

@@ -9,6 +9,7 @@ module.exports = {
                 '<rootDir>/src/**/*.spec.ts',
                 '<rootDir>/test/index.spec.js',
             ],
+            moduleFileExtensions: ['js', 'ts', 'd.ts'],
             moduleNameMapper: {
                 '\\.hbs$': '<rootDir>/src/templates/__mocks__/index.js',
             },

package.json

@@ -1,6 +1,6 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.7.0-beta-3",
+    "version": "0.7.2",
     "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
@@ -61,44 +61,45 @@
         "codecov": "codecov --token=66c30c23-8954-4892-bef9-fbaed0a2e42b"
     },
     "dependencies": {
-        "camelcase": "6.2.0",
-        "commander": "6.2.0",
-        "handlebars": "4.7.6",
-        "js-yaml": "3.14.0",
-        "mkdirp": "1.0.4",
-        "path": "0.12.7",
-        "rimraf": "3.0.2"
+        "camelcase": "^6.2.0",
+        "commander": "^6.2.0",
+        "handlebars": "^4.7.6",
+        "js-yaml": "^3.14.0",
+        "mkdirp": "^1.0.4",
+        "rimraf": "^3.0.2"
     },
     "devDependencies": {
-        "@babel/cli": "7.12.7",
-        "@babel/core": "7.12.3",
-        "@babel/preset-env": "7.12.1",
+        "@babel/cli": "7.12.10",
+        "@babel/core": "7.12.10",
+        "@babel/preset-env": "7.12.11",
         "@babel/preset-typescript": "7.12.7",
-        "@rollup/plugin-commonjs": "16.0.0",
-        "@rollup/plugin-node-resolve": "10.0.0",
+        "@rollup/plugin-commonjs": "17.0.0",
+        "@rollup/plugin-node-resolve": "11.0.1",
         "@types/express": "4.17.9",
-        "@types/jest": "26.0.15",
+        "@types/jest": "26.0.19",
         "@types/js-yaml": "3.12.5",
-        "@types/node": "14.14.9",
+        "@types/node": "14.14.19",
         "@types/node-fetch": "2.5.7",
-        "@typescript-eslint/eslint-plugin": "4.8.1",
-        "@typescript-eslint/parser": "4.8.1",
+        "@types/qs": "6.9.5",
+        "@typescript-eslint/eslint-plugin": "4.11.1",
+        "@typescript-eslint/parser": "4.11.1",
         "codecov": "3.8.1",
-        "eslint": "7.14.0",
-        "eslint-config-prettier": "6.15.0",
-        "eslint-plugin-prettier": "3.1.4",
-        "eslint-plugin-simple-import-sort": "6.0.1",
+        "eslint": "7.17.0",
+        "eslint-config-prettier": "7.1.0",
+        "eslint-plugin-prettier": "3.3.0",
+        "eslint-plugin-simple-import-sort": "7.0.0",
         "express": "4.17.1",
         "form-data": "3.0.0",
         "glob": "7.1.6",
         "jest": "26.6.3",
         "jest-cli": "26.6.3",
         "node-fetch": "2.6.1",
-        "prettier": "2.2.0",
-        "puppeteer": "5.4.1",
-        "rollup": "2.33.3",
+        "prettier": "2.2.1",
+        "puppeteer": "5.5.0",
+        "qs": "6.9.4",
+        "rollup": "2.35.1",
         "rollup-plugin-terser": "7.0.2",
         "rollup-plugin-typescript2": "0.29.0",
-        "typescript": "4.0.5"
+        "typescript": "4.1.3"
     }
 }

rollup.config.js

@@ -34,6 +34,8 @@ const handlebarsPlugin = () => ({
                 knownHelpers: {
                     equals: true,
                     notEquals: true,
+                    containsSpaces: true,
+                    union: true,
                 },
             });
             return `export default ${templateSpec};`;
@@ -65,6 +67,7 @@ module.exports = {
         'fs',
         'os',
         'util',
+        'path',
         'http',
         'https',
         'handlebars/runtime',

src/HttpClient.ts

@@ -0,0 +1,5 @@
+export enum HttpClient {
+    FETCH = 'fetch',
+    XHR = 'xhr',
+    NODE = 'node',
+}

src/index.ts

@@ -1,3 +1,4 @@
+import { HttpClient } from './HttpClient';
 import { parse as parseV2 } from './openApi/v2';
 import { parse as parseV3 } from './openApi/v3';
 import { getOpenApiSpec } from './utils/getOpenApiSpec';
@@ -7,11 +8,7 @@ import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
 
-export enum HttpClient {
-    FETCH = 'fetch',
-    XHR = 'xhr',
-    NODE = 'node',
-}
+export { HttpClient } from './HttpClient';
 
 export type Options = {
     input: string | Record<string, any>;
@@ -23,6 +20,7 @@ export type Options = {
     exportServices?: boolean;
     exportModels?: boolean;
     exportSchemas?: boolean;
+    request?: string;
     write?: boolean;
 };
 
@@ -39,6 +37,7 @@ export type Options = {
  * @param exportServices: Generate services
  * @param exportModels: Generate models
  * @param exportSchemas: Generate schemas
+ * @param request: Path to custom request file
  * @param write Write the files to disk (true or false)
  */
 export async function generate({
@@ -51,6 +50,7 @@ export async function generate({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    request,
     write = true,
 }: Options): Promise<void> {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
@@ -62,15 +62,15 @@ 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);
+            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);
+            await writeClient(clientFinal, templates, output, httpClient, useOptions, useUnionTypes, exportCore, exportServices, exportModels, exportSchemas, request);
             break;
         }
     }

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

@@ -0,0 +1,13 @@
+import { escapeDescription } from './escapeDescription';
+
+describe('escapeDescription', () => {
+    it('should escape', () => {
+        expect(escapeDescription('foo `test` bar')).toEqual('foo \\`test\\` bar');
+    });
+
+    it('should not escape', () => {
+        expect(escapeDescription('')).toEqual('');
+        expect(escapeDescription('fooBar')).toEqual('fooBar');
+        expect(escapeDescription('foo \\`test\\` bar')).toEqual('foo \\`test\\` bar');
+    });
+});

src/openApi/v2/parser/escapeDescription.ts

@@ -0,0 +1,3 @@
+export function escapeDescription(value: string): string {
+    return value.replace(/([^\\])`/g, '$1\\`');
+}

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

@@ -1,10 +1,10 @@
-import * as os from 'os';
+import { EOL } from 'os';
 
 import { getComment } from './getComment';
 
 describe('getComment', () => {
     it('should parse comments', () => {
-        const multiline = 'Testing multiline comments.' + os.EOL + ' * This must go to the next line.' + os.EOL + ' * ' + os.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!');

src/openApi/v2/parser/getComment.ts

@@ -1,4 +1,4 @@
-import * as os from 'os';
+import { EOL } from 'os';
 
 /**
  * Cleanup comment and prefix multiline comments with "*",
@@ -7,7 +7,7 @@ import * as os from 'os';
  */
 export function getComment(comment?: string): string | null {
     if (comment) {
-        return comment.replace(/\r?\n(.*)/g, (_, w) => `${os.EOL} * ${w.trim()}`);
+        return comment.replace(/\r?\n(.*)/g, (_, w) => `${EOL} * ${w.trim()}`);
     }
     return null;
 }

src/openApi/v2/parser/getEnum.ts

@@ -1,5 +1,5 @@
 import type { Enum } from '../../../client/interfaces/Enum';
-import { isDefined } from './isDefined';
+import { isDefined } from '../../../utils/isDefined';
 
 export function getEnum(values?: (string | number)[]): Enum[] {
     if (Array.isArray(values)) {

src/openApi/v2/parser/getModel.ts

@@ -1,4 +1,5 @@
 import type { Model } from '../../../client/interfaces/Model';
+import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { extendEnum } from './extendEnum';
@@ -7,7 +8,6 @@ import { getEnum } from './getEnum';
 import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModelComposition } from './getModelComposition';
 import { getModelProperties } from './getModelProperties';
-import { getPattern } from './getPattern';
 import { getType } from './getType';
 
 export function getModel(openApi: OpenApi, definition: OpenApiSchema, isDefinition: boolean = false, name: string = ''): Model {

src/openApi/v2/parser/getModelComposition.ts

@@ -14,12 +14,20 @@ export function getModelComposition(openApi: OpenApi, definitions: OpenApiSchema
         properties: [],
     };
 
-    const modes = definitions.map(definition => getModel(openApi, definition));
-    modes.forEach(model => {
-        composition.imports.push(...model.imports);
-        composition.enums.push(...model.enums);
-        composition.properties.push(model);
-    });
+    const models = definitions.map(definition => getModel(openApi, definition));
+    models
+        .filter(model => {
+            const hasProperties = model.properties.length;
+            const hasEnums = model.enums.length;
+            const isObject = model.type === 'any';
+            const isEmpty = isObject && !hasProperties && !hasEnums;
+            return !isEmpty;
+        })
+        .forEach(model => {
+            composition.imports.push(...model.imports);
+            composition.enums.push(...model.enums);
+            composition.properties.push(model);
+        });
 
     return composition;
 }

src/openApi/v2/parser/getModelProperties.ts

@@ -1,10 +1,10 @@
 import type { Model } from '../../../client/interfaces/Model';
+import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiSchema } from '../interfaces/OpenApiSchema';
 import { escapeName } from './escapeName';
 import { getComment } from './getComment';
 import type { getModel } from './getModel';
-import { getPattern } from './getPattern';
 import { getType } from './getType';
 
 // Fix for circular dependency

src/openApi/v2/parser/getOperationErrors.ts

@@ -1,5 +1,6 @@
 import type { OperationError } from '../../../client/interfaces/OperationError';
 import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import { escapeDescription } from './escapeDescription';
 
 export function getOperationErrors(operationResponses: OperationResponse[]): OperationError[] {
     return operationResponses
@@ -8,6 +9,6 @@ export function getOperationErrors(operationResponses: OperationResponse[]): Ope
         })
         .map(response => ({
             code: response.code,
-            description: response.description!,
+            description: escapeDescription(response.description!),
         }));
 }

src/openApi/v2/parser/getOperationParameter.ts

@@ -1,4 +1,5 @@
 import type { OperationParameter } from '../../../client/interfaces/OperationParameter';
+import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiParameter } from '../interfaces/OpenApiParameter';
 import { extendEnum } from './extendEnum';
@@ -8,7 +9,6 @@ import { getEnumFromDescription } from './getEnumFromDescription';
 import { getModel } from './getModel';
 import { getOperationParameterDefault } from './getOperationParameterDefault';
 import { getOperationParameterName } from './getOperationParameterName';
-import { getPattern } from './getPattern';
 import { getType } from './getType';
 
 export function getOperationParameter(openApi: OpenApi, parameter: OpenApiParameter): OperationParameter {

src/openApi/v2/parser/getOperationResponse.ts

@@ -1,9 +1,9 @@
 import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
+import { getPattern } from '../../../utils/getPattern';
 import type { OpenApi } from '../interfaces/OpenApi';
 import type { OpenApiResponse } from '../interfaces/OpenApiResponse';
 import { getComment } from './getComment';
 import { getModel } from './getModel';
-import { getPattern } from './getPattern';
 import { getType } from './getType';
 
 export function getOperationResponse(openApi: OpenApi, response: OpenApiResponse, responseCode: number): OperationResponse {

src/openApi/v3/parser/escapeDescription.spec.ts

@@ -0,0 +1,13 @@
+import { escapeDescription } from './escapeDescription';
+
+describe('escapeDescription', () => {
+    it('should escape', () => {
+        expect(escapeDescription('foo `test` bar')).toEqual('foo \\`test\\` bar');
+    });
+
+    it('should not escape', () => {
+        expect(escapeDescription('')).toEqual('');
+        expect(escapeDescription('fooBar')).toEqual('fooBar');
+        expect(escapeDescription('foo \\`test\\` bar')).toEqual('foo \\`test\\` bar');
+    });
+});

src/openApi/v3/parser/escapeDescription.ts

@@ -0,0 +1,3 @@
+export function escapeDescription(value: string): string {
+    return value.replace(/([^\\])`/g, '$1\\`');
+}

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

@@ -1,10 +1,10 @@
-import * as os from 'os';
+import { EOL } from 'os';
 
 import { getComment } from './getComment';
 
 describe('getComment', () => {
     it('should parse comments', () => {
-        const multiline = 'Testing multiline comments.' + os.EOL + ' * This must go to the next line.' + os.EOL + ' * ' + os.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!');

src/openApi/v3/parser/getComment.ts

@@ -1,4 +1,4 @@
-import * as os from 'os';
+import { EOL } from 'os';
 
 /**
  * Cleanup comment and prefix multiline comments with "*",
@@ -7,7 +7,7 @@ import * as os from 'os';
  */
 export function getComment(comment?: string): string | null {
     if (comment) {
-        return comment.replace(/\r?\n(.*)/g, (_, w) => `${os.EOL} * ${w.trim()}`);
+        return comment.replace(/\r?\n(.*)/g, (_, w) => `${EOL} * ${w.trim()}`);
     }
     return null;
 }

src/openApi/v3/parser/getEnum.ts

@@ -1,5 +1,5 @@
 import type { Enum } from '../../../client/interfaces/Enum';
-import { isDefined } from './isDefined';
+import { isDefined } from '../../../utils/isDefined';
 
 export function getEnum(values?: (string | number)[]): Enum[] {
     if (Array.isArray(values)) {