swagger-typescript-api 11.0.0--beta-3 → 11.0.0--beta-4

package/cli/execute.js

@@ -13,6 +13,7 @@ const execute = (params, commands, instance) => {
 
     if (error) {
       reject(new Error(error));
+      return;
     }
 
     if (!usageOptions.length && command.name === root_command) {
@@ -91,9 +92,22 @@ const processArgs = (commands, args) => {
     if (error) return;
 
     if (i === 0) {
-      command = commands[arg] || commands[root_command];
-      allFlagKeys = command.options.reduce((acc, option) => [...acc, ...option.flags.keys], []);
+      command = commands[arg];
+
+      if (!command && !arg.startsWith("-")) {
+        const tip = didYouMean(arg, _.keys(commands));
+        error = `unknown command ${arg}${tip ? `\n(Did you mean ${tip} ?)` : ""}`;
+      } else if (!command) {
+        command = commands[root_command];
+      }
+
+      if (command) {
+        allFlagKeys = command.options.reduce((acc, option) => [...acc, ...option.flags.keys], []);
+      }
     }
+
+    if (error) return;
+
     if (arg.startsWith("-")) {
       const option = command.options.find((option) => option.flags.keys.includes(arg));
 
@@ -127,6 +141,14 @@ const processArgs = (commands, args) => {
   });
   command = command || commands[root_command];
 
+  if (error) {
+    return {
+      command: null,
+      usageOptions: [],
+      error,
+    };
+  }
+
   return {
     command,
     usageOptions,

package/cli/index.js

@@ -8,13 +8,33 @@ const { displayVersion } = require("./operations/display-version");
 const cli = (input) => {
   const commands = {};
 
-  const addCommand = (command) => {
+  const addCommand = (command, { addVersion = false, addHelp = true } = {}) => {
     commands[command.name] = {
       name: command.name,
       description: `${command.description || ""}`,
       options: _.compact(_.map(command.options, processOption)),
     };
 
+    if (addVersion) {
+      commands[command.name].options.unshift(
+        processOption({
+          flags: "-v, --version",
+          description: "output the current version",
+          operation: () => displayVersion(instance),
+        }),
+      );
+    }
+
+    if (addHelp) {
+      commands[command.name].options.push(
+        processOption({
+          flags: "-h, --help",
+          description: "display help for command",
+          operation: () => displayHelp(commands, instance, commands[command.name]),
+        }),
+      );
+    }
+
     return instance;
   };
 
@@ -25,10 +45,16 @@ const cli = (input) => {
     execute: (params) => execute(params, commands, instance),
   };
 
-  addCommand({
-    name: root_command,
-    options: [],
-  });
+  addCommand(
+    {
+      name: root_command,
+      options: [],
+    },
+    {
+      addVersion: false,
+      addHelp: false,
+    },
+  );
 
   _.forEach(input.options, (option) => {
     const processed = processOption(option);
@@ -55,7 +81,7 @@ const cli = (input) => {
     processOption({
       flags: "-h, --help",
       description: "display help for command",
-      operation: () => displayHelp(commands, instance),
+      operation: () => displayHelp(commands, instance, commands[root_command]),
     }),
   );
 

package/cli/operations/display-help.js

@@ -1,33 +1,56 @@
 const _ = require("lodash");
 const { root_command } = require("../constants");
 
-const displayHelp = (commands, instance) => {
-  const generateOptionsOutput = (options) =>
-    options.reduce(
-      (acc, option) => {
-        const flags = `${option.flags.keys.join(", ")}${option.flags.value?.raw ? ` ${option.flags.value?.raw}` : ""}`;
-        const description = `${option.description || ""}${
-          option.default === undefined || (option.flags.isNoFlag && option.default === true)
-            ? ""
-            : ` (default: ${typeof option.default === "string" ? `"${option.default}"` : option.default})`
-        }`;
-
-        if (flags.length > acc.maxLength) {
-          acc.maxLength = flags.length;
-        }
-
-        acc.options.push({
-          flags,
-          description,
-        });
-        return acc;
-      },
-      {
-        options: [],
-        maxLength: 0,
-      },
-    );
+const generateOptionsOutput = (options) =>
+  options.reduce(
+    (acc, option) => {
+      const flags = `${option.flags.keys.join(", ")}${option.flags.value?.raw ? ` ${option.flags.value?.raw}` : ""}`;
+      const description = `${option.description || ""}${
+        option.default === undefined || (option.flags.isNoFlag && option.default === true)
+          ? ""
+          : ` (default: ${typeof option.default === "string" ? `"${option.default}"` : option.default})`
+      }`;
+
+      if (flags.length > acc.maxLength) {
+        acc.maxLength = flags.length;
+      }
+
+      acc.options.push({
+        flags,
+        description,
+      });
+      return acc;
+    },
+    {
+      options: [],
+      maxLength: 0,
+    },
+  );
+
+const generateOptionsTextOutput = (options, maxLength, spaces) =>
+  options
+    .map((option) => {
+      const spacesText = Array(spaces).fill(" ").join("");
+      const leftStr = `${spacesText}${option.flags.padEnd(maxLength, " ")}  `;
+      const leftStrFiller = Array(leftStr.length).fill(" ").join("");
+      const descriptionLines = option.description.split("\n");
+
+      return (
+        leftStr +
+        descriptionLines
+          .map((line, i) => {
+            if (i === 0) {
+              return line;
+            }
+
+            return `\n${leftStrFiller}${line}`;
+          })
+          .join("")
+      );
+    })
+    .join("\n");
 
+const displayAllHelp = (commands, instance) => {
   const { options, maxLength: maxOptionLength } = generateOptionsOutput(commands[root_command].options);
 
   const { commands: commandLabels, maxLength: maxCommandLength } = _.filter(
@@ -57,29 +80,6 @@ const displayHelp = (commands, instance) => {
     },
   );
 
-  const generateOptionsTextOutput = (options, maxLength, spaces) =>
-    options
-      .map((option) => {
-        const spacesText = Array(spaces).fill(" ").join("");
-        const leftStr = `${spacesText}${option.flags.padEnd(maxLength, " ")}  `;
-        const leftStrFiller = Array(leftStr.length).fill(" ").join("");
-        const descriptionLines = option.description.split("\n");
-
-        return (
-          leftStr +
-          descriptionLines
-            .map((line, i) => {
-              if (i === 0) {
-                return line;
-              }
-
-              return `\n${leftStrFiller}${line}`;
-            })
-            .join("")
-        );
-      })
-      .join("\n");
-
   const optionsOutput = generateOptionsTextOutput(options, maxOptionLength, 2);
 
   const commandsOutput = commandLabels
@@ -128,6 +128,31 @@ ${instance.input.description}`
 ${outputTest}`);
 };
 
+const displayHelp = (commands, instance, command) => {
+  const rootCommand = commands[root_command];
+  if (command.name === root_command) return displayAllHelp(commands, instance);
+
+  const { options, maxLength: maxOptionLength } = generateOptionsOutput(command.options);
+  const optionsOutput = generateOptionsTextOutput(options, maxOptionLength, 2);
+
+  const outputTest = [
+    optionsOutput &&
+      `Options:
+${optionsOutput}`,
+  ]
+    .filter(Boolean)
+    .join("\n\n");
+
+  console.log(`Usage: ${instance.input.name} ${command.name}${optionsOutput ? " [options]" : ""}
+${
+  command.description &&
+  `
+${command.description}`
+}
+
+${outputTest}`);
+};
+
 module.exports = {
   displayHelp,
 };

package/index.d.ts

@@ -1,3 +1,5 @@
+type HttpClientType = "axios" | "fetch";
+
 interface GenerateApiParamsBase {
   /**
    * default 'api.ts'
@@ -34,7 +36,7 @@ interface GenerateApiParamsBase {
   /**
    * generated http client type
    */
-  httpClientType?: "axios" | "fetch";
+  httpClientType?: HttpClientType;
   /**
    * use "default" response status code as success response too.
    * some swagger schemas use "default" response status code as success response type by default.
@@ -499,3 +501,15 @@ export interface GenerateApiOutput {
 }
 
 export declare function generateApi(params: GenerateApiParams): Promise<GenerateApiOutput>;
+
+export interface GenerateTemplatesParams {
+  cleanOutput?: boolean;
+  output?: string;
+  httpClientType?: HttpClientType;
+  modular?: boolean;
+  silent?: boolean;
+}
+
+export interface GenerateTemplatesOutput extends Pick<GenerateApiOutput, "files" | "createFile"> {}
+
+export declare function generateTemplates(params: GenerateTemplatesParams): Promise<GenerateTemplatesOutput>;

package/index.js

@@ -9,9 +9,14 @@
 const _ = require("lodash");
 const { version, name } = require("./package.json");
 const { cli } = require("./cli");
-const { generateApi } = require("./src");
+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,
@@ -32,7 +37,7 @@ const program = cli({
     {
       flags: "-n, --name <string>",
       description: "name of output typescript api file",
-      default: "Api.ts",
+      default: `${codeGenBaseConfig.apiClassName}.ts`,
     },
     {
       flags: "-t, --templates <string>",
@@ -43,134 +48,134 @@ const program = cli({
       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,
+      default: codeGenBaseConfig.defaultResponseAsSuccess,
     },
     {
       flags: "-r, --responses",
       description: "generate additional information about request responses\n" + "also add typings for bad responses",
-      default: false,
+      default: codeGenBaseConfig.generateResponses,
     },
     {
       flags: "--union-enums",
       description: 'generate all "enum" types as union types (T1 | T2 | TN)',
-      default: false,
+      default: codeGenBaseConfig.generateUnionEnums,
     },
     {
       flags: "--add-readonly",
       description: "generate readonly properties",
-      default: false,
+      default: codeGenBaseConfig.addReadonly,
     },
     {
       flags: "--route-types",
       description: "generate type definitions for API routes",
-      default: false,
+      default: codeGenBaseConfig.generateRouteTypes,
     },
     {
       flags: "--no-client",
       description: "do not generate an API class",
-      default: true,
+      default: codeGenBaseConfig.generateClient,
     },
     {
       flags: "--enum-names-as-values",
       description: "use values in 'x-enumNames' as enum values (not only as keys)",
-      default: false,
+      default: codeGenBaseConfig.enumNamesAsValues,
     },
     {
       flags: "--extract-request-params",
       description:
         "extract request params to data contract (Also combine path params and query params into one object)",
-      default: false,
+      default: codeGenBaseConfig.extractRequestParams,
     },
     {
       flags: "--extract-request-body",
       description: "extract request body type to data contract",
-      default: false,
+      default: codeGenBaseConfig.extractRequestBody,
     },
     {
       flags: "--extract-response-body",
       description: "extract response body type to data contract",
-      default: false,
+      default: codeGenBaseConfig.extractResponseBody,
     },
     {
       flags: "--extract-response-error",
       description: "extract response error type to data contract",
-      default: false,
+      default: codeGenBaseConfig.extractResponseError,
     },
     {
       flags: "--modular",
       description: "generate separated files for http client, data contracts, and routes",
-      default: false,
+      default: codeGenBaseConfig.modular,
     },
     {
       flags: "--js",
       description: "generate js api module with declaration file",
-      default: false,
+      default: codeGenBaseConfig.toJS,
     },
     {
       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,
+      default: codeGenBaseConfig.moduleNameIndex,
     },
     {
       flags: "--module-name-first-tag",
       description: "splits routes based on the first tag",
-      default: false,
+      default: codeGenBaseConfig.moduleNameFirstTag,
     },
     {
       flags: "--disableStrictSSL",
       description: "disabled strict SSL",
-      default: false,
+      default: codeGenBaseConfig.disableStrictSSL,
     },
     {
       flags: "--disableProxy",
       description: "disabled proxy",
-      default: false,
+      default: codeGenBaseConfig.disableProxy,
     },
     {
       flags: "--axios",
       description: "generate axios http client",
-      default: false,
+      default: codeGenBaseConfig.httpClientType === "axios",
     },
     {
       flags: "--unwrap-response-data",
       description: "unwrap the data item from the response",
-      default: false,
+      default: codeGenBaseConfig.unwrapResponseData,
     },
     {
       flags: "--disable-throw-on-error",
       description: "Do not throw an error when response.ok is not true",
-      default: false,
+      default: codeGenBaseConfig.disableThrowOnError,
     },
     {
       flags: "--single-http-client",
       description: "Ability to send HttpClient instance to Api constructor",
-      default: false,
+      default: codeGenBaseConfig.singleHttpClient,
     },
     {
       flags: "--silent",
       description: "Output only errors to console",
-      default: false,
+      default: codeGenBaseConfig.silent,
     },
     {
       flags: "--default-response <type>",
       description: "default type for empty response schema",
-      default: "void",
+      default: codeGenBaseConfig.defaultResponseType,
     },
     {
       flags: "--type-prefix <string>",
       description: "data contract name prefix",
-      default: "",
+      default: codeGenBaseConfig.typePrefix,
     },
     {
       flags: "--type-suffix <string>",
       description: "data contract name suffix",
-      default: "",
+      default: codeGenBaseConfig.typeSuffix,
     },
     {
       flags: "--clean-output",
       description: "clean output folder before generate api. WARNING: May cause data loss",
-      default: false,
+      default: codeGenBaseConfig.cleanOutput,
     },
     {
       flags: "--api-class-name <string>",
@@ -179,22 +184,56 @@ const program = cli({
     {
       flags: "--patch",
       description: "fix up small errors in the swagger source definition",
-      default: false,
+      default: codeGenBaseConfig.patch,
     },
     {
       flags: "--debug",
       description: "additional information about processes inside this tool",
-      default: false,
+      default: codeGenBaseConfig.debug,
     },
     {
       flags: "--another-array-type",
       description: "generate array types as Array<Type> (by default Type[])",
-      default: false,
+      default: codeGenBaseConfig.anotherArrayType,
     },
     {
       flags: "--sort-types",
       description: "sort fields and types",
-      default: false,
+      default: codeGenBaseConfig.sortTypes,
+    },
+  ],
+});
+
+program.addCommand({
+  name: "generate-templates",
+  description: `Generate ".ejs" templates needed for generate api`,
+  options: [
+    {
+      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",
+      default: templateGenBaseConfig.modular,
+    },
+    {
+      flags: "--http-client <string>",
+      description: `http client type (possible values: ${Object.values(HTTP_CLIENT)
+        .map((v) => `"${v}"`)
+        .join(", ")})`,
+      default: templateGenBaseConfig.httpClientType,
+    },
+    {
+      flags: "-c, --clean-output",
+      description: "clean output folder before generate template. WARNING: May cause data loss",
+      default: templateGenBaseConfig.cleanOutput,
+    },
+    {
+      flags: "--silent",
+      description: "Output only errors to console",
+      default: templateGenBaseConfig.silent,
     },
   ],
 });
@@ -246,7 +285,7 @@ const main = async () => {
         break;
       }
       case "generate-templates": {
-        console.info("todo");
+        await generateTemplates(options);
         break;
       }
       default: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "11.0.0--beta-3",
+  "version": "11.0.0--beta-4",
   "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",

package/src/code-formatter.js

@@ -4,7 +4,7 @@ const prettier = require("prettier");
 
 class CodeFormatter {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
 

package/src/code-gen-process.js

@@ -6,7 +6,7 @@ const { TypeName } = require("./type-name.js");
 const _ = require("lodash");
 const { SchemaParser } = require("./schema-parser/schema-parser.js");
 const { SchemaRoutes } = require("./schema-parser/schema-routes.js");
-const { Configuration } = require("./configuration.js");
+const { CodeGenConfig } = require("./configuration.js");
 const { FileSystem } = require("./util/file-system");
 const { Templates } = require("./templates");
 const { translate: translateToJS } = require("./translators/JavaScript");
@@ -17,7 +17,7 @@ const { internalCase } = require("./util/internal-case");
 
 class CodeGenProcess {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
   /**
@@ -58,7 +58,7 @@ class CodeGenProcess {
    * @param config {Partial<import("../index.d.ts").GenerateApiConfiguration['config']>}
    */
   constructor(config) {
-    this.config = new Configuration(config);
+    this.config = new CodeGenConfig(config);
     this.logger = new Logger(this.config);
     this.fileSystem = new FileSystem();
     this.swaggerSchemaResolver = new SwaggerSchemaResolver(this.config, this.logger, this.fileSystem);

package/src/commands/generate-templates/configuration.js

@@ -0,0 +1,32 @@
+const { objectAssign } = require("../../util/object-assign");
+const { HTTP_CLIENT, PROJECT_VERSION } = require("../../constants");
+
+/**
+ * @type {GenerateTemplatesParams}}
+ */
+class TemplatesGenConfig {
+  cleanOutput = false;
+  output = undefined;
+  httpClientType = HTTP_CLIENT.FETCH;
+  modular = false;
+  silent = false;
+  version = PROJECT_VERSION;
+
+  /**
+   * @param config {GenerateTemplatesParams}
+   */
+  constructor(config) {
+    this.update(config);
+  }
+
+  /**
+   * @param update {Partial<GenerateTemplatesParams>}
+   */
+  update = (update) => {
+    objectAssign(this, update);
+  };
+}
+
+module.exports = {
+  TemplatesGenConfig,
+};

package/src/commands/generate-templates/index.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+// Copyright (c) 2019-present acacode
+// Node module: swagger-typescript-api
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+// Repository https://github.com/acacode/swagger-typescript-api
+
+const _ = require("lodash");
+const { TemplatesGenProcess } = require("./templates-gen-process");
+
+module.exports = {
+  generateTemplates: async (config) => {
+    const codeGenProcess = new TemplatesGenProcess(config);
+    return await codeGenProcess.start();
+  },
+};