swagger-typescript-api 13.0.0-experimental-1 → 13.0.1

package/index.js

@@ -6,245 +6,296 @@
 // License text available at https://opensource.org/licenses/MIT
 // Repository https://github.com/acacode/swagger-typescript-api
 
-const _ = require("lodash");
-const { version, name } = require("./package.json");
-const { cli } = require("./cli");
-const { generateApi, generateTemplates } = require("./src");
-const { HTTP_CLIENT } = require("./src/constants");
-const { resolve } = require("path");
-const { CodeGenConfig } = require("./src/configuration");
-const { TemplatesGenConfig } = require("./src/commands/generate-templates/configuration");
+const { version, name } = require('./package.json');
+const { cli } = require('./cli');
+const { generateApi, generateTemplates } = require('./src');
+const { HTTP_CLIENT } = require('./src/constants');
+const { resolve } = require('path');
+const { CodeGenConfig } = require('./src/configuration');
+const {
+  TemplatesGenConfig,
+} = require('./src/commands/generate-templates/configuration');
 
 const codeGenBaseConfig = new CodeGenConfig({});
 const templateGenBaseConfig = new TemplatesGenConfig({});
 
 const program = cli({
   name: name,
-  alias: "sta",
+  alias: 'sta',
   version: version,
-  description: "Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.",
+  description:
+    'Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.',
   options: [
     {
-      flags: "-p, --path <string>",
-      description: "path/url to swagger scheme",
+      flags: '-p, --path <string>',
+      description: 'path/url to swagger scheme',
       required: true,
     },
     {
-      flags: "-o, --output <string>",
-      description: "output path of typescript api file",
-      default: "./",
+      flags: '-o, --output <string>',
+      description: 'output path of typescript api file',
+      default: './',
     },
     {
-      flags: "-n, --name <string>",
-      description: "name of output typescript api file",
+      flags: '-n, --name <string>',
+      description: 'name of output typescript api file',
       default: codeGenBaseConfig.fileName,
     },
     {
-      flags: "-t, --templates <string>",
-      description: "path to folder containing templates",
+      flags: '-t, --templates <string>',
+      description: 'path to folder containing templates',
     },
     {
-      flags: "-d, --default-as-success",
+      flags: '-d, --default-as-success',
       description:
         'use "default" response status code as success response too.\n' +
         'some swagger schemas use "default" response status code as success response type by default.',
       default: codeGenBaseConfig.defaultResponseAsSuccess,
+      internal: { name: 'defaultResponseAsSuccess' },
     },
     {
-      flags: "-r, --responses",
-      description: "generate additional information about request responses\n" + "also add typings for bad responses",
+      flags: '-r, --responses',
+      description:
+        'generate additional information about request responses\n' +
+        'also add typings for bad responses',
       default: codeGenBaseConfig.generateResponses,
+      internal: { name: 'generateResponses' },
     },
     {
-      flags: "--union-enums",
+      flags: '--union-enums',
       description: 'generate all "enum" types as union types (T1 | T2 | TN)',
       default: codeGenBaseConfig.generateUnionEnums,
+      internal: { name: 'generateUnionEnums' },
     },
     {
-      flags: "--add-readonly",
-      description: "generate readonly properties",
+      flags: '--add-readonly',
+      description: 'generate readonly properties',
       default: codeGenBaseConfig.addReadonly,
     },
     {
-      flags: "--route-types",
-      description: "generate type definitions for API routes",
+      flags: '--route-types',
+      description: 'generate type definitions for API routes',
       default: codeGenBaseConfig.generateRouteTypes,
+      internal: { name: 'generateRouteTypes' },
     },
     {
-      flags: "--no-client",
-      description: "do not generate an API class",
+      flags: '--no-client',
+      description: 'do not generate an API class',
       default: codeGenBaseConfig.generateClient,
     },
     {
-      flags: "--enum-names-as-values",
-      description: "use values in 'x-enumNames' as enum values (not only as keys)",
+      flags: '--enum-names-as-values',
+      description:
+        "use values in 'x-enumNames' as enum values (not only as keys)",
       default: codeGenBaseConfig.enumNamesAsValues,
     },
     {
-      flags: "--extract-request-params",
+      flags: '--extract-request-params',
       description:
-        "extract request params to data contract (Also combine path params and query params into one object)",
+        'extract request params to data contract (Also combine path params and query params into one object)',
       default: codeGenBaseConfig.extractRequestParams,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--extract-request-body",
-      description: "extract request body type to data contract",
+      flags: '--extract-request-body',
+      description: 'extract request body type to data contract',
       default: codeGenBaseConfig.extractRequestBody,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--extract-response-body",
-      description: "extract response body type to data contract",
+      flags: '--extract-response-body',
+      description: 'extract response body type to data contract',
       default: codeGenBaseConfig.extractResponseBody,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--extract-response-error",
-      description: "extract response error type to data contract",
+      flags: '--extract-response-error',
+      description: 'extract response error type to data contract',
       default: codeGenBaseConfig.extractResponseError,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--modular",
-      description: "generate separated files for http client, data contracts, and routes",
+      flags: '--extract-responses',
+      description: 'extract all responses described in /components/responses',
+      default: codeGenBaseConfig.extractResponses,
+      internal: { formatter: Boolean },
+    },
+    {
+      flags: '--modular',
+      description:
+        'generate separated files for http client, data contracts, and routes',
       default: codeGenBaseConfig.modular,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--js",
-      description: "generate js api module with declaration file",
+      flags: '--js',
+      description: 'generate js api module with declaration file',
       default: codeGenBaseConfig.toJS,
+      internal: { formatter: Boolean, name: 'toJS' },
     },
     {
-      flags: "--module-name-index <number>",
+      flags: '--module-name-index <number>',
       description:
-        "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
+        'determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)',
       default: codeGenBaseConfig.moduleNameIndex,
+      internal: { formatter: (moduleNameIndex) => +moduleNameIndex || 0 },
     },
     {
-      flags: "--module-name-first-tag",
-      description: "splits routes based on the first tag",
+      flags: '--module-name-first-tag',
+      description: 'splits routes based on the first tag',
       default: codeGenBaseConfig.moduleNameFirstTag,
     },
     {
-      flags: "--disableStrictSSL",
-      description: "disabled strict SSL",
+      flags: '--disableStrictSSL',
+      description: 'disabled strict SSL',
       default: codeGenBaseConfig.disableStrictSSL,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--disableProxy",
-      description: "disabled proxy",
+      flags: '--disableProxy',
+      description: 'disabled proxy',
       default: codeGenBaseConfig.disableProxy,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--axios",
-      description: "generate axios http client",
-      default: codeGenBaseConfig.httpClientType === "axios",
+      flags: '--axios',
+      description: 'generate axios http client',
+      default: codeGenBaseConfig.httpClientType === HTTP_CLIENT.AXIOS,
     },
     {
-      flags: "--unwrap-response-data",
-      description: "unwrap the data item from the response",
+      flags: '--unwrap-response-data',
+      description: 'unwrap the data item from the response',
       default: codeGenBaseConfig.unwrapResponseData,
     },
     {
-      flags: "--disable-throw-on-error",
-      description: "Do not throw an error when response.ok is not true",
+      flags: '--disable-throw-on-error',
+      description: 'Do not throw an error when response.ok is not true',
       default: codeGenBaseConfig.disableThrowOnError,
     },
     {
-      flags: "--single-http-client",
-      description: "Ability to send HttpClient instance to Api constructor",
+      flags: '--single-http-client',
+      description: 'Ability to send HttpClient instance to Api constructor',
       default: codeGenBaseConfig.singleHttpClient,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--silent",
-      description: "Output only errors to console",
+      flags: '--silent',
+      description: 'Output only errors to console',
       default: codeGenBaseConfig.silent,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--default-response <type>",
-      description: "default type for empty response schema",
+      flags: '--default-response <type>',
+      description: 'default type for empty response schema',
       default: codeGenBaseConfig.defaultResponseType,
+      internal: { name: 'defaultResponseType' },
     },
     {
-      flags: "--type-prefix <string>",
-      description: "data contract name prefix",
+      flags: '--type-prefix <string>',
+      description: 'data contract name prefix',
       default: codeGenBaseConfig.typePrefix,
     },
     {
-      flags: "--type-suffix <string>",
-      description: "data contract name suffix",
+      flags: '--type-suffix <string>',
+      description: 'data contract name suffix',
       default: codeGenBaseConfig.typeSuffix,
     },
     {
-      flags: "--clean-output",
-      description: "clean output folder before generate api. WARNING: May cause data loss",
+      flags: '--clean-output',
+      description:
+        'clean output folder before generate api. WARNING: May cause data loss',
       default: codeGenBaseConfig.cleanOutput,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--api-class-name <string>",
-      description: "name of the api class",
+      flags: '--api-class-name <string>',
+      description: 'name of the api class',
       default: codeGenBaseConfig.apiClassName,
     },
     {
-      flags: "--patch",
-      description: "fix up small errors in the swagger source definition",
+      flags: '--patch',
+      description: 'fix up small errors in the swagger source definition',
       default: codeGenBaseConfig.patch,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--debug",
-      description: "additional information about processes inside this tool",
+      flags: '--debug',
+      description: 'additional information about processes inside this tool',
       default: codeGenBaseConfig.debug,
     },
     {
-      flags: "--another-array-type",
-      description: "generate array types as Array<Type> (by default Type[])",
+      flags: '--another-array-type',
+      description: 'generate array types as Array<Type> (by default Type[])',
       default: codeGenBaseConfig.anotherArrayType,
     },
     {
-      flags: "--sort-types",
-      description: "sort fields and types",
+      flags: '--sort-types',
+      description: 'sort fields and types',
       default: codeGenBaseConfig.sortTypes,
     },
     {
-      flags: "--extract-enums",
-      description: "extract all enums from inline interface\\type content to typescript enum construction",
+      flags: '--extract-enums',
+      description:
+        'extract all enums from inline interface\\type content to typescript enum construction',
       default: codeGenBaseConfig.extractEnums,
     },
+    {
+      flags: '--sort-routes',
+      description: 'sort routes in alphabetical order',
+      default: codeGenBaseConfig.sortRoutes,
+    },
+    {
+      flags: '--custom-config <string>',
+      description: 'custom config: primitiveTypeConstructs, hooks, ... ',
+      default: '',
+    },
   ],
 });
 
 program.addCommand({
-  name: "generate-templates",
+  name: 'generate-templates',
   description: `Generate ".ejs" templates needed for generate api`,
   options: [
     {
-      flags: "-o, --output <string>",
-      description: "output path of generated templates",
+      flags: '-o, --output <string>',
+      description: 'output path of generated templates',
       default: templateGenBaseConfig.output,
     },
     {
-      flags: "-m, --modular",
-      description: "generate templates needed to separate files for http client, data contracts, and routes",
+      flags: '-m, --modular',
+      description:
+        'generate templates needed to separate files for http client, data contracts, and routes',
       default: templateGenBaseConfig.modular,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--http-client <string>",
-      description: `http client type (possible values: ${Object.values(HTTP_CLIENT)
+      flags: '--http-client <string>',
+      description: `http client type (possible values: ${Object.values(
+        HTTP_CLIENT,
+      )
         .map((v) => `"${v}"`)
-        .join(", ")})`,
+        .join(', ')})`,
       default: templateGenBaseConfig.httpClientType,
+      internal: { name: 'httpClientType' },
     },
     {
-      flags: "-c, --clean-output",
-      description: "clean output folder before generate template. WARNING: May cause data loss",
+      flags: '-c, --clean-output',
+      description:
+        'clean output folder before generate template. WARNING: May cause data loss',
       default: templateGenBaseConfig.cleanOutput,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "-r, --rewrite",
-      description: "rewrite content in existing templates",
+      flags: '-r, --rewrite',
+      description: 'rewrite content in existing templates',
       default: templateGenBaseConfig.rewrite,
+      internal: { formatter: Boolean },
     },
     {
-      flags: "--silent",
-      description: "Output only errors to console",
+      flags: '--silent',
+      description: 'Output only errors to console',
       default: templateGenBaseConfig.silent,
+      internal: { formatter: Boolean },
     },
   ],
 });
@@ -252,58 +303,36 @@ program.addCommand({
 const main = async () => {
   const { command, options } = await program.execute({ args: process.argv });
 
+  let customConfig = null;
+
+  if (options.customConfig) {
+    try {
+      const customConfigPath = resolve(process.cwd(), options.customConfig);
+      console.log(`✨ found custom config at: ${customConfigPath}`);
+      customConfig = require(customConfigPath);
+    } catch (e) {
+      /* empty */
+    }
+  }
+
   try {
     switch (command) {
       case null: {
         await generateApi({
+          ...options,
           name: options.name,
           url: options.path,
           generateRouteTypes: options.routeTypes,
           generateClient: !!(options.axios || options.client),
           httpClientType: options.axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
-          defaultResponseAsSuccess: options.defaultAsSuccess,
-          defaultResponseType: options.defaultResponse,
-          unwrapResponseData: options.unwrapResponseData,
-          disableThrowOnError: options.disableThrowOnError,
-          sortTypes: options.sortTypes,
-          generateUnionEnums: options.unionEnums,
-          addReadonly: options.addReadonly,
-          generateResponses: options.responses,
-          extractRequestParams: !!options.extractRequestParams,
-          extractRequestBody: !!options.extractRequestBody,
-          extractResponseBody: !!options.extractResponseBody,
-          extractResponseError: !!options.extractResponseError,
           input: resolve(process.cwd(), options.path),
-          output: resolve(process.cwd(), options.output || "."),
-          templates: options.templates,
-          modular: !!options.modular,
-          toJS: !!options.js,
-          enumNamesAsValues: options.enumNamesAsValues,
-          moduleNameIndex: +(options.moduleNameIndex || 0),
-          moduleNameFirstTag: options.moduleNameFirstTag,
-          disableStrictSSL: !!options.disableStrictSSL,
-          disableProxy: !!options.disableProxy,
-          singleHttpClient: !!options.singleHttpClient,
-          cleanOutput: !!options.cleanOutput,
-          silent: !!options.silent,
-          typePrefix: options.typePrefix,
-          typeSuffix: options.typeSuffix,
-          patch: !!options.patch,
-          apiClassName: options.apiClassName,
-          debug: options.debug,
-          anotherArrayType: options.anotherArrayType,
+          output: resolve(process.cwd(), options.output || '.'),
+          ...customConfig,
         });
         break;
       }
-      case "generate-templates": {
-        await generateTemplates({
-          cleanOutput: options.cleanOutput,
-          output: options.output,
-          httpClientType: options.httpClient,
-          modular: options.modular,
-          silent: options.silent,
-          rewrite: options.rewrite,
-        });
+      case 'generate-templates': {
+        await generateTemplates(options);
         break;
       }
       default: {

package/package.json

@@ -1,22 +1,25 @@
 {
   "name": "swagger-typescript-api",
-  "version": "13.0.0-experimental-1",
+  "version": "13.0.1",
   "description": "Generate typescript/javascript api from swagger schema",
   "scripts": {
+    "update-deps-to-latest": "npx --yes npm-check-updates && npm i",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
     "cli:yaml": "node index.js -r -d -p ./swagger-test-cli.yaml -n swagger-test-cli.ts",
     "node": "node swagger-test-cli/generate.js",
     "node:debug": "node --nolazy swagger-test-cli/generate.js",
     "contributors": "all-contributors generate",
     "cli:help": "node index.js -h",
-    "test-all": "node --unhandled-rejections=strict ./scriptsRunner.js generate validate test:*",
-    "test-all(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true node --unhandled-rejections=strict ./scriptsRunner.js generate validate test:*",
-    "test-all-extended": "node --unhandled-rejections=strict ./scriptsRunner.js generate-extended validate generate validate test:*",
-    "test-specific": "node ./scriptsRunner.js generate validate test:*",
-    "test-specific-only": "node ./scriptsRunner.js test:*",
+    "test-all": "npm run test-extended && npm run test-simple && npm run test-specific",
+    "test-all(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true npm run test-all",
+    "test-simple": "node --unhandled-rejections=strict scripts_runner.js generate validate",
+    "test-extended": "node --unhandled-rejections=strict scripts_runner.js generate-extended validate",
+    "test-specific": "node --unhandled-rejections=strict scripts_runner.js test:*",
+    "test-specific(update-snapshots)": "cross-env UPDATE_SNAPSHOTS=true node --unhandled-rejections=strict scripts_runner.js test:*",
     "generate": "node tests/generate.js",
     "generate-extended": "node tests/generate-extended.js",
-    "generate:debug": "node --nolazy tests/generate.js",
     "validate": "node tests/validate.js",
     "validate:debug": "node --nolazy tests/validate.js",
     "test:--route-types": "node tests/spec/routeTypes/test.js",
@@ -37,6 +40,7 @@
     "test:--extract-response-error": "node tests/spec/extractResponseError/test.js",
     "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
     "test:--default-response": "node tests/spec/defaultResponse/test.js",
+    "test:const-keyword": "node tests/spec/const-keyword/test.js",
     "test:--js": "node tests/spec/js/test.js",
     "test:jsSingleHttpClientModular": "node tests/spec/jsSingleHttpClientModular/test.js",
     "test:--js--axios": "node tests/spec/jsAxios/test.js",
@@ -47,7 +51,7 @@
     "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
     "test:--dot-path-params": "node tests/spec/dot-path-params/test.js",
     "test:--primitive-type-constructs": "node tests/spec/primitive-type-constructs/test.js",
-    "test:--cli": "node index.js -p tests/spec/cli/schema.json -o tests/spec/cli -n schema.ts --extract-response-body --extract-response-error --api-class-name MySuperApi --type-prefix Prefix && node tests/spec/cli/test.js",
+    "test:--cli": "rimraf tests/spec/cli/schema.ts && node index.js -p tests/spec/cli/schema.json -o tests/spec/cli -n schema.ts --extract-response-body --extract-response-error --api-class-name MySuperApi --type-prefix Prefix && node tests/spec/cli/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
     "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
     "test:--patch": "node tests/spec/patch/test.js",
@@ -59,49 +63,51 @@
     "test:another-query-params": "node tests/spec/another-query-params/test.js",
     "test:on-insert-path-param": "node tests/spec/on-insert-path-param/test.js",
     "test:extra-templates": "node tests/spec/extra-templates/test.js",
-    "test:extract-enums": "node tests/spec/extract-enums/test.js"
+    "test:extract-enums": "node tests/spec/extract-enums/test.js",
+    "test:discriminator": "node tests/spec/discriminator/test.js",
+    "test:sort-types": "node tests/spec/sortTypes/test.js",
+    "test:sort-types-false": "node tests/spec/sortTypes-false/test.js"
   },
   "author": "acacode",
   "license": "MIT",
   "typings": "./index.d.ts",
   "main": "src/index.js",
   "devDependencies": {
-    "@types/lodash": "^4.14.186",
-    "@types/node": "^18.11.7",
-    "@types/prettier": "^2.7.1",
-    "all-contributors-cli": "^6.20.0",
-    "axios": "^1.1.3",
+    "eslint": "^8.44.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "@types/lodash": "^4.14.195",
+    "@types/node": "^20.4.1",
+    "@types/prettier": "^2.7.3",
+    "all-contributors-cli": "^6.26.1",
+    "axios": "^1.4.0",
     "cross-env": "^7.0.3",
+    "dotenv": "^16.3.1",
     "git-diff": "^2.0.6",
-    "husky": "^4.3.6",
-    "pretty-quick": "^3.1.0"
+    "husky": "^8.0.3",
+    "pretty-quick": "^3.1.3",
+    "rimraf": "^5.0.1"
   },
   "dependencies": {
     "@types/swagger-schema-official": "2.0.22",
-    "cosmiconfig": "7.0.1",
+    "cosmiconfig": "8.2.0",
     "didyoumean": "^1.2.2",
-    "eta": "1.12.3",
+    "eta": "^2.2.0",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
-    "make-dir": "3.1.0",
-    "nanoid": "3.3.4",
-    "node-emoji": "1.11.0",
-    "node-fetch": "^3.2.10",
-    "prettier": "2.7.1",
+    "make-dir": "4.0.0",
+    "nanoid": "3.3.6",
+    "node-emoji": "2.1.0",
+    "node-fetch": "^3.3.1",
+    "prettier": "3.0.0",
     "swagger-schema-official": "2.0.0-bab6bed",
     "swagger2openapi": "7.0.8",
-    "typescript": "4.8.4"
+    "typescript": "5.1.6"
   },
   "bin": {
     "swagger-typescript-api": "index.js",
     "sta": "index.js"
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "pretty-quick --staged",
-      "post-commit": "git update-index -g"
-    }
-  },
   "keywords": [
     "openapi",
     "swagger",