swagger-typescript-api 10.0.3 → 11.0.0--alpha

package/index.js

@@ -6,110 +6,237 @@
 // License text available at https://opensource.org/licenses/MIT
 // Repository https://github.com/acacode/swagger-typescript-api
 
-const { Command } = require("commander");
-const { resolve } = require("path");
+const _ = require("lodash");
+const { version, name } = require("./package.json");
+const { cli } = require("./cli");
 const { generateApi } = require("./src");
-const { version, name: packageName } = require("./package.json");
-const { TS_KEYWORDS, HTTP_CLIENT } = require("./src/constants");
-
-const program = new Command(packageName);
+const { HTTP_CLIENT } = require("./src/constants");
+const { resolve } = require("path");
 
-const options = program
-  .alias("sta")
-  .version(version, "-v, --version", "output the current version")
-  .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.")
-  .requiredOption("-p, --path <string>", "path/url to swagger scheme")
-  .option("-o, --output <string>", "output path of typescript api file", "./")
-  .option("-n, --name <string>", "name of output typescript api file", "Api.ts")
-  .option("-t, --templates <string>", "path to folder containing templates")
-  .option(
-    "-d, --default-as-success",
-    'use "default" response status code as success response too.\n' +
-      'some swagger schemas use "default" response status code as success response type by default.',
-    false,
-  )
-  .option(
-    "-r, --responses",
-    "generate additional information about request responses\n" + "also add typings for bad responses",
-    false,
-  )
-  .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
-  .option("--add-readonly", "generate readonly properties", false)
-  .option("--route-types", "generate type definitions for API routes", false)
-  .option("--no-client", "do not generate an API class", true)
-  .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
-  .option(
-    "--extract-request-params",
-    "extract request params to data contract (Also combine path params and query params into one object)",
-    false,
-  )
-  .option("--extract-request-body", "extract request body type to data contract", false)
-  .option("--extract-response-body", "extract response body type to data contract", false)
-  .option("--extract-response-error", "extract response error type to data contract", false)
-  .option("--modular", "generate separated files for http client, data contracts, and routes", false)
-  .option("--js", "generate js api module with declaration file", false)
-  .option(
-    "--module-name-index <number>",
-    "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
-    0,
-  )
-  .option("--module-name-first-tag", "splits routes based on the first tag", false)
-  .option("--disableStrictSSL", "disabled strict SSL", false)
-  .option("--disableProxy", "disabled proxy", false)
-  .option("--axios", "generate axios http client", false)
-  .option("--unwrap-response-data", "unwrap the data item from the response", false)
-  .option("--disable-throw-on-error", "Do not throw an error when response.ok is not true", false)
-  .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
-  .option("--silent", "Output only errors to console", false)
-  .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
-  .option("--type-prefix <string>", "data contract name prefix", "")
-  .option("--type-suffix <string>", "data contract name suffix", "")
-  .option("--clean-output", "clean output folder before generate api. WARNING: May cause data loss", false)
-  .option("--api-class-name <string>", "name of the api class")
-  .option("--patch", "fix up small errors in the swagger source definition", false)
-  .option("--debug", "additional information about processes inside this tool", false)
-  .parse(process.argv)
-  .opts();
+const program = cli({
+  name: name,
+  alias: "sta",
+  version: version,
+  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",
+      required: true,
+    },
+    {
+      flags: "-o, --output <string>",
+      description: "output path of typescript api file",
+      default: "./",
+    },
+    {
+      flags: "-n, --name <string>",
+      description: "name of output typescript api file",
+      default: "Api.ts",
+    },
+    {
+      flags: "-t, --templates <string>",
+      description: "path to folder containing templates",
+    },
+    {
+      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: false,
+    },
+    {
+      flags: "-r, --responses",
+      description: "generate additional information about request responses\n" + "also add typings for bad responses",
+      default: false,
+    },
+    {
+      flags: "--union-enums",
+      description: 'generate all "enum" types as union types (T1 | T2 | TN)',
+      default: false,
+    },
+    {
+      flags: "--add-readonly",
+      description: "generate readonly properties",
+      default: false,
+    },
+    {
+      flags: "--route-types",
+      description: "generate type definitions for API routes",
+      default: false,
+    },
+    {
+      flags: "--no-client",
+      description: "do not generate an API class",
+      default: true,
+    },
+    {
+      flags: "--enum-names-as-values",
+      description: "use values in 'x-enumNames' as enum values (not only as keys)",
+      default: false,
+    },
+    {
+      flags: "--extract-request-params",
+      description:
+        "extract request params to data contract (Also combine path params and query params into one object)",
+      default: false,
+    },
+    {
+      flags: "--extract-request-body",
+      description: "extract request body type to data contract",
+      default: false,
+    },
+    {
+      flags: "--extract-response-body",
+      description: "extract response body type to data contract",
+      default: false,
+    },
+    {
+      flags: "--extract-response-error",
+      description: "extract response error type to data contract",
+      default: false,
+    },
+    {
+      flags: "--modular",
+      description: "generate separated files for http client, data contracts, and routes",
+      default: false,
+    },
+    {
+      flags: "--js",
+      description: "generate js api module with declaration file",
+      default: false,
+    },
+    {
+      flags: "--module-name-index <number>",
+      description:
+        "determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)",
+      default: 0,
+    },
+    {
+      flags: "--module-name-first-tag",
+      description: "splits routes based on the first tag",
+      default: false,
+    },
+    {
+      flags: "--disableStrictSSL",
+      description: "disabled strict SSL",
+      default: false,
+    },
+    {
+      flags: "--disableProxy",
+      description: "disabled proxy",
+      default: false,
+    },
+    {
+      flags: "--axios",
+      description: "generate axios http client",
+      default: false,
+    },
+    {
+      flags: "--unwrap-response-data",
+      description: "unwrap the data item from the response",
+      default: false,
+    },
+    {
+      flags: "--disable-throw-on-error",
+      description: "Do not throw an error when response.ok is not true",
+      default: false,
+    },
+    {
+      flags: "--single-http-client",
+      description: "Ability to send HttpClient instance to Api constructor",
+      default: false,
+    },
+    {
+      flags: "--silent",
+      description: "Output only errors to console",
+      default: false,
+    },
+    {
+      flags: "--default-response <type>",
+      description: "default type for empty response schema",
+      default: "void",
+    },
+    {
+      flags: "--type-prefix <string>",
+      description: "data contract name prefix",
+      default: "",
+    },
+    {
+      flags: "--type-suffix <string>",
+      description: "data contract name suffix",
+      default: "",
+    },
+    {
+      flags: "--clean-output",
+      description: "clean output folder before generate api. WARNING: May cause data loss",
+      default: false,
+    },
+    {
+      flags: "--api-class-name <string>",
+      description: "name of the api class",
+    },
+    {
+      flags: "--patch",
+      description: "fix up small errors in the swagger source definition",
+      default: false,
+    },
+    {
+      flags: "--debug",
+      description: "additional information about processes inside this tool",
+      default: false,
+    },
+    {
+      flags: "--another-array-type",
+      description: "generate array types as Array<Type> (by default Type[])",
+      default: false,
+    },
+  ],
+});
 
-generateApi({
-  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,
-}).catch((err) => {
-  // NOTE collect all errors on top level and shows to users in any case
-  console.error(err);
+const main = async () => {
+  const { command, options } = await program.execute({ args: process.argv });
+  if (command === "generate-templates") {
+  } else if (command === null) {
+    await generateApi({
+      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,
+    });
+  }
+};
 
-  process.exit(1);
-});
+main();

package/package.json

@@ -1,119 +1,121 @@
-{
-  "name": "swagger-typescript-api",
-  "version": "10.0.3",
-  "description": "Generate typescript/javascript api from swagger schema",
-  "scripts": {
-    "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:*",
-    "prepare": "npm run test-all-extended",
-    "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",
-    "test:--no-client": "node tests/spec/noClient/test.js",
-    "test:--default-as-success": "node tests/spec/defaultAsSuccess/test.js",
-    "test:--templates": "node tests/spec/templates/test.js",
-    "test:--union-enums": "node tests/spec/unionEnums/test.js",
-    "test:--add-readonly": "node tests/spec/readonly/test.js",
-    "test:--responses": "node tests/spec/responses/test.js",
-    "test:specProperty": "node tests/spec/specProperty/test.js",
-    "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",
-    "test:--module-name-first-tag": "node tests/spec/moduleNameFirstTag/test.js",
-    "test:--modular": "node tests/spec/modular/test.js",
-    "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
-    "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",
-    "test:--extract-request-body": "node tests/spec/extractRequestBody/test.js",
-    "test:--extract-response-body": "node tests/spec/extractResponseBody/test.js",
-    "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:--js": "node tests/spec/js/test.js",
-    "test:--js--axios": "node tests/spec/jsAxios/test.js",
-    "test:--axios": "node tests/spec/axios/test.js",
-    "test:--object-types": "node tests/spec/object-types/test.js",
-    "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
-    "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/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 --type-prefix Prefix --api-class-name MySuperApi --no-client",
-    "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
-    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
-    "test:--patch": "node tests/spec/patch/test.js"
-  },
-  "author": "acacode",
-  "license": "MIT",
-  "typings": "./index.d.ts",
-  "main": "src/index.js",
-  "devDependencies": {
-    "cross-env": "^7.0.3",
-    "@types/axios": "^0.14.0",
-    "@types/lodash": "^4.14.182",
-    "@types/node": "^15.0.2",
-    "@types/prettier": "^2.7.0",
-    "all-contributors-cli": "^6.20.0",
-    "git-diff": "^2.0.6",
-    "husky": "^4.3.6",
-    "pretty-quick": "^3.1.0"
-  },
-  "dependencies": {
-    "@types/swagger-schema-official": "2.0.22",
-    "axios": "0.27.2",
-    "commander": "9.4.1",
-    "cosmiconfig": "7.0.1",
-    "eta": "1.12.3",
-    "js-yaml": "4.1.0",
-    "lodash": "4.17.21",
-    "make-dir": "3.1.0",
-    "nanoid": "3.3.4",
-    "node-emoji": "1.11.0",
-    "prettier": "2.7.1",
-    "swagger-schema-official": "2.0.0-bab6bed",
-    "swagger2openapi": "7.0.8",
-    "typescript": "4.8.4"
-  },
-  "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",
-    "typescript",
-    "api",
-    "javascript",
-    "rest",
-    "codegen",
-    "generation",
-    "http"
-  ],
-  "files": [
-    "src",
-    "index.js",
-    "index.d.ts",
-    "templates",
-    "LICENSE"
-  ],
-  "bugs": {
-    "url": "https://github.com/acacode/swagger-typescript-api/issues"
-  },
-  "homepage": "https://github.com/acacode/swagger-typescript-api",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/acacode/swagger-typescript-api"
-  }
-}
+{
+  "name": "swagger-typescript-api",
+  "version": "11.0.0--alpha",
+  "description": "Generate typescript/javascript api from swagger schema",
+  "scripts": {
+    "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:*",
+    "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",
+    "test:--no-client": "node tests/spec/noClient/test.js",
+    "test:--default-as-success": "node tests/spec/defaultAsSuccess/test.js",
+    "test:--templates": "node tests/spec/templates/test.js",
+    "test:--union-enums": "node tests/spec/unionEnums/test.js",
+    "test:--add-readonly": "node tests/spec/readonly/test.js",
+    "test:--responses": "node tests/spec/responses/test.js",
+    "test:specProperty": "node tests/spec/specProperty/test.js",
+    "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",
+    "test:--module-name-first-tag": "node tests/spec/moduleNameFirstTag/test.js",
+    "test:--modular": "node tests/spec/modular/test.js",
+    "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
+    "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",
+    "test:--extract-request-body": "node tests/spec/extractRequestBody/test.js",
+    "test:--extract-response-body": "node tests/spec/extractResponseBody/test.js",
+    "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:--js": "node tests/spec/js/test.js",
+    "test:--js--axios": "node tests/spec/jsAxios/test.js",
+    "test:--axios": "node tests/spec/axios/test.js",
+    "test:--another-array-type": "node tests/spec/another-array-type/test.js",
+    "test:--object-types": "node tests/spec/object-types/test.js",
+    "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
+    "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 --type-prefix Prefix --api-class-name MySuperApi --no-client",
+    "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
+    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
+    "test:--patch": "node tests/spec/patch/test.js"
+  },
+  "author": "acacode",
+  "license": "MIT",
+  "typings": "./index.d.ts",
+  "main": "src/index.js",
+  "devDependencies": {
+    "@types/axios": "^0.14.0",
+    "@types/lodash": "^4.14.182",
+    "@types/node": "^15.0.2",
+    "@types/prettier": "^2.7.0",
+    "all-contributors-cli": "^6.20.0",
+    "cross-env": "^7.0.3",
+    "git-diff": "^2.0.6",
+    "husky": "^4.3.6",
+    "pretty-quick": "^3.1.0"
+  },
+  "dependencies": {
+    "@types/swagger-schema-official": "2.0.22",
+    "axios": "0.27.2",
+    "cosmiconfig": "7.0.1",
+    "didyoumean": "^1.2.2",
+    "eta": "1.12.3",
+    "js-yaml": "4.1.0",
+    "lodash": "4.17.21",
+    "make-dir": "3.1.0",
+    "nanoid": "3.3.4",
+    "node-emoji": "1.11.0",
+    "prettier": "2.7.1",
+    "swagger-schema-official": "2.0.0-bab6bed",
+    "swagger2openapi": "7.0.8",
+    "typescript": "4.8.4"
+  },
+  "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",
+    "typescript",
+    "api",
+    "javascript",
+    "rest",
+    "codegen",
+    "generation",
+    "http"
+  ],
+  "files": [
+    "src",
+    "index.js",
+    "index.d.ts",
+    "templates",
+    "LICENSE"
+  ],
+  "bugs": {
+    "url": "https://github.com/acacode/swagger-typescript-api/issues"
+  },
+  "homepage": "https://github.com/acacode/swagger-typescript-api",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/acacode/swagger-typescript-api"
+  }
+}