Merge remote-tracking branch 'upstream/master'

Author: Hampus Joakim Borgos

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

@@ -6,7 +6,7 @@ const path = require('path');
 const program = require('commander');
 const pkg = require('../package.json');
 
-program
+const params = program
     .name('openapi')
     .usage('[options]')
     .version(pkg.version)
@@ -19,21 +19,24 @@ 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)
-    .parse(process.argv);
+    .option('--request <value>', 'Path to custom request file')
+    .parse(process.argv)
+    .opts();
 
 const OpenAPI = require(path.resolve(__dirname, '../dist/index.js'));
 
 if (OpenAPI) {
     OpenAPI.generate({
-        input: program.input,
-        output: program.output,
-        httpClient: program.client,
-        useOptions: program.useOptions,
-        useUnionTypes: program.useUnionTypes,
-        exportCore: JSON.parse(program.exportCore) === true,
-        exportServices: JSON.parse(program.exportServices) === true,
-        exportModels: JSON.parse(program.exportModels) === true,
-        exportSchemas: JSON.parse(program.exportSchemas) === true,
+        input: params.input,
+        output: params.output,
+        httpClient: params.client,
+        useOptions: params.useOptions,
+        useUnionTypes: params.useUnionTypes,
+        exportCore: JSON.parse(params.exportCore) === true,
+        exportServices: JSON.parse(params.exportServices) === true,
+        exportModels: JSON.parse(params.exportModels) === true,
+        exportSchemas: JSON.parse(params.exportSchemas) === true,
+        request: params.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,7 +1,7 @@
 {
     "name": "openapi-typescript-codegen",
-    "version": "0.7.0-beta",
-    "description": "NodeJS library that generates Typescript or Javascript clients based on the OpenAPI specification.",
+    "version": "0.9.0",
+    "description": "Library that generates Typescript clients based on the OpenAPI specification.",
     "author": "Ferdi Koomen",
     "homepage": "https://github.com/ferdikoomen/openapi-typescript-codegen",
     "repository": {
@@ -19,7 +19,6 @@
         "generator",
         "client",
         "typescript",
-        "javascript",
         "yaml",
         "json",
         "fetch",
@@ -62,44 +61,46 @@
         "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": "^7.0.0",
+        "handlebars": "^4.7.6",
+        "js-yaml": "^4.0.0",
+        "json-schema-ref-parser": "^9.0.7",
+        "mkdirp": "^1.0.4",
+        "rimraf": "^3.0.2"
     },
     "devDependencies": {
-        "@babel/cli": "7.12.1",
-        "@babel/core": "7.12.3",
-        "@babel/preset-env": "7.12.1",
-        "@babel/preset-typescript": "7.12.1",
-        "@rollup/plugin-commonjs": "16.0.0",
-        "@rollup/plugin-node-resolve": "10.0.0",
-        "@types/express": "4.17.9",
-        "@types/jest": "26.0.15",
-        "@types/js-yaml": "3.12.5",
-        "@types/node": "14.14.7",
-        "@types/node-fetch": "2.5.7",
-        "@typescript-eslint/eslint-plugin": "4.7.0",
-        "@typescript-eslint/parser": "4.7.0",
+        "@babel/cli": "7.12.16",
+        "@babel/core": "7.12.17",
+        "@babel/preset-env": "7.12.17",
+        "@babel/preset-typescript": "7.12.17",
+        "@rollup/plugin-commonjs": "17.1.0",
+        "@rollup/plugin-node-resolve": "11.2.0",
+        "@types/express": "4.17.11",
+        "@types/jest": "26.0.20",
+        "@types/js-yaml": "4.0.0",
+        "@types/node": "14.14.31",
+        "@types/node-fetch": "2.5.8",
+        "@types/qs": "6.9.5",
+        "@typescript-eslint/eslint-plugin": "4.15.1",
+        "@typescript-eslint/parser": "4.15.1",
         "codecov": "3.8.1",
-        "eslint": "7.13.0",
-        "eslint-config-prettier": "6.15.0",
-        "eslint-plugin-prettier": "3.1.4",
-        "eslint-plugin-simple-import-sort": "6.0.0",
+        "eslint": "7.20.0",
+        "eslint-config-prettier": "8.0.0",
+        "eslint-plugin-prettier": "3.3.1",
+        "eslint-plugin-simple-import-sort": "7.0.0",
         "express": "4.17.1",
-        "form-data": "3.0.0",
+        "form-data": "4.0.0",
         "glob": "7.1.6",
         "jest": "26.6.3",
         "jest-cli": "26.6.3",
         "node-fetch": "2.6.1",
-        "prettier": "2.1.2",
-        "puppeteer": "5.4.1",
-        "rollup": "2.33.2",
+        "prettier": "2.2.1",
+        "puppeteer": "7.1.0",
+        "qs": "6.9.6",
+        "rollup": "2.39.0",
         "rollup-plugin-terser": "7.0.2",
-        "rollup-plugin-typescript2": "0.29.0",
-        "typescript": "4.0.5"
+        "rollup-plugin-typescript2": "0.30.0",
+        "typescript": "4.1.5"
     }
 }

rollup.config.js

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

samples/spec/v2.json

@@ -978,6 +978,13 @@
         "Order": {
             "type": "object",
             "properties": {
+                "bool": {
+                    "description": "Simple boolean enum",
+                    "type": "boolean",
+                    "enum": [
+                        true
+                    ]
+                },
                 "id": {
                     "type": "integer",
                     "format": "int64"

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,26 +50,31 @@ export async function generate({
     exportServices = true,
     exportModels = true,
     exportSchemas = false,
+    request,
     write = true,
 }: Options): Promise<void> {
     const openApi = isString(input) ? await getOpenApiSpec(input) : input;
     const openApiVersion = getOpenApiVersion(openApi);
-    const templates = registerHandlebarTemplates();
+    const templates = registerHandlebarTemplates({
+        httpClient,
+        useUnionTypes,
+        useOptions,
+    });
 
     switch (openApiVersion) {
         case OpenApiVersion.V2: {
             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\\`');
+}