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

package/src/commands/generate-templates/templates-gen-process.js

@@ -0,0 +1,140 @@
+const _ = require("lodash");
+const { TemplatesGenConfig } = require("./configuration");
+const { FileSystem } = require("../../util/file-system");
+const { Logger } = require("../../util/logger");
+const path = require("path");
+
+class TemplatesGenProcess {
+  /**
+   * @type {TemplatesGenConfig}
+   */
+  config;
+  /**
+   * @type {FileSystem}
+   */
+  fileSystem;
+  /**
+   * @type {Logger}
+   */
+  logger;
+
+  rootDir = path.resolve(__dirname, "../../../");
+
+  paths = {
+    baseTemplates: "templates/base",
+    httpClientTemplates: "templates/base/http-clients",
+    moduleApiTemplates: "templates/modular",
+    defaultApiTemplates: "templates/default",
+  };
+
+  importTemplatePrefixes = ["@base", "@modular", "@default"];
+
+  constructor(config) {
+    this.config = new TemplatesGenConfig(config);
+    this.logger = new Logger(this.config);
+    this.fileSystem = new FileSystem();
+  }
+
+  /**
+   * @return {Promise<GenerateTemplatesOutput>}
+   */
+  async start() {
+    const templates = this.getTemplates();
+
+    if (this.config.output) {
+      const outputPath = path.resolve(process.cwd(), this.config.output);
+
+      if (this.fileSystem.pathIsExist(outputPath)) {
+        if (this.config.cleanOutput) {
+          this.fileSystem.cleanDir(outputPath);
+        }
+      } else {
+        this.fileSystem.createDir(outputPath);
+      }
+
+      templates.forEach((template) => {
+        this.fileSystem.createFile({
+          path: outputPath,
+          fileName: template.name,
+          content: template.content,
+          withPrefix: false,
+        });
+      });
+    }
+
+    return {
+      files: templates,
+      configuration: this.config,
+      createFile: this.fileSystem.createFile,
+    };
+  }
+
+  getTemplates = () => {
+    const outputFiles = [];
+    const baseTemplates = this.getTemplateNamesFromDir(this.paths.baseTemplates);
+    const httpClientTemplates = this.getTemplateNamesFromDir(this.paths.httpClientTemplates);
+    const apiTemplatesPath = this.config.modular ? this.paths.moduleApiTemplates : this.paths.defaultApiTemplates;
+    const apiTemplates = this.getTemplateNamesFromDir(apiTemplatesPath);
+
+    for (const fileName of baseTemplates) {
+      outputFiles.push({
+        name: fileName,
+        content: this.fixTemplateContent(this.getTemplateContent(`${this.paths.baseTemplates}/${fileName}`)),
+      });
+    }
+
+    const usingHttpClientTemplate = httpClientTemplates.find((template) =>
+      template.startsWith(`${this.config.httpClientType}-`),
+    );
+
+    if (usingHttpClientTemplate) {
+      outputFiles.push({
+        name: usingHttpClientTemplate,
+        content: this.fixTemplateContent(
+          this.getTemplateContent(`${this.paths.httpClientTemplates}/${usingHttpClientTemplate}`),
+        ),
+      });
+    }
+
+    for (const fileName of apiTemplates) {
+      outputFiles.push({
+        name: fileName,
+        content: this.fixTemplateContent(this.getTemplateContent(`${apiTemplatesPath}/${fileName}`)),
+      });
+    }
+
+    return outputFiles;
+  };
+
+  fixTemplateContent = (content) => {
+    const importsRegExp1 = new RegExp(
+      `includeFile\\\("(${this.importTemplatePrefixes.map((v) => `(${v})`).join("|")})\/`,
+      "g",
+    );
+    const importsRegExp2 = new RegExp(
+      `includeFile\\\(\`(${this.importTemplatePrefixes.map((v) => `(${v})`).join("|")})\/`,
+      "g",
+    );
+    const importsRegExp3 = new RegExp(
+      `includeFile\\\(\'(${this.importTemplatePrefixes.map((v) => `(${v})`).join("|")})\/`,
+      "g",
+    );
+
+    return content
+      .replace(importsRegExp1, 'includeFile("./')
+      .replace(importsRegExp2, "includeFile(`./")
+      .replace(importsRegExp3, "includeFile('./");
+  };
+
+  getTemplateNamesFromDir = (dir) => {
+    return this.fileSystem.readDir(path.resolve(this.rootDir, dir)).filter((file) => file.endsWith(".ejs"));
+  };
+
+  getTemplateContent = (pathToFile) => {
+    return this.fileSystem.getFileContent(path.resolve(this.rootDir, pathToFile));
+  };
+}
+
+module.exports = {
+  TemplatesGenProcess,
+};

package/src/configuration.js

@@ -1,10 +1,8 @@
 const { objectAssign } = require("./util/object-assign");
 const _ = require("lodash");
-const constantsBase = require("./constants.js");
-const packageJson = require("../package.json");
-const { NameResolver, ComponentTypeNameResolver } = require("./util/name-resolver");
-const { cosmiconfigSync } = require("cosmiconfig");
 const CONSTANTS = require("./constants");
+const { ComponentTypeNameResolver } = require("./util/name-resolver");
+const { cosmiconfigSync } = require("cosmiconfig");
 
 const TsKeyword = {
   Number: "number",
@@ -34,8 +32,8 @@ const TsCodeGenKeyword = {
 /**
  * @type {GenerateApiConfiguration["config"]}}
  */
-class Configuration {
-  version = packageJson.version;
+class CodeGenConfig {
+  version = CONSTANTS.PROJECT_VERSION;
   /** CLI flag */
   templates = "../templates/default";
   /** CLI flag */
@@ -315,7 +313,7 @@ class Configuration {
       prettierOptions: prettierOptions === undefined ? getDefaultPrettierOptions() : prettierOptions,
       hooks: _.merge(this.hooks, hooks || {}),
       constants: {
-        ...constantsBase,
+        ...CONSTANTS,
         ...constants,
       },
       templateInfos: templateInfos || this.templateInfos,
@@ -348,5 +346,5 @@ const getDefaultPrettierOptions = () => {
 };
 
 module.exports = {
-  Configuration,
+  CodeGenConfig,
 };

package/src/constants.js

@@ -1,3 +1,4 @@
+const packageJson = require("../package.json");
 const RESERVED_QUERY_ARG_NAMES = ["query", "queryParams", "queryArg"];
 const RESERVED_BODY_ARG_NAMES = ["data", "body", "reqBody"];
 const RESERVED_REQ_PARAMS_ARG_NAMES = ["params", "requestParams", "reqParams", "httpParams"];
@@ -23,6 +24,8 @@ const HTTP_CLIENT = {
   AXIOS: "axios",
 };
 
+const PROJECT_VERSION = packageJson.version;
+
 const FILE_PREFIX = `/* eslint-disable */
 /* tslint:disable */
 /*
@@ -39,6 +42,7 @@ const FILE_PREFIX = `/* eslint-disable */
 module.exports = {
   FILE_PREFIX,
   DEFAULT_BODY_ARG_NAME: "data",
+  PROJECT_VERSION,
   SCHEMA_TYPES,
   HTTP_CLIENT,
   RESERVED_QUERY_ARG_NAMES,

package/src/index.js

@@ -9,6 +9,7 @@
 const _ = require("lodash");
 const constants = require("./constants");
 const { CodeGenProcess } = require("./code-gen-process.js");
+const { generateTemplates } = require("./commands/generate-templates");
 
 module.exports = {
   constants: constants,
@@ -20,5 +21,7 @@ module.exports = {
     });
     return await codeGenProcess.start();
   },
-  generateTemplates: (config) => {},
+  generateTemplates: async (config) => {
+    return await generateTemplates(config);
+  },
 };

package/src/schema-components-map.js

@@ -6,7 +6,7 @@ class SchemaComponentsMap {
    */
   data = {};
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
 

package/src/schema-parser/schema-formatters.js

@@ -3,7 +3,7 @@ const _ = require("lodash");
 
 class SchemaFormatters {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
   /**

package/src/schema-parser/schema-parser.js

@@ -5,7 +5,7 @@ const { internalCase } = require("../util/internal-case");
 
 class SchemaParser {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
 

package/src/schema-parser/schema-routes.js

@@ -20,7 +20,7 @@ const CONTENT_KIND = {
 
 class SchemaRoutes {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
   /**

package/src/swagger-schema-resolver.js

@@ -1,4 +1,3 @@
-const { Configuration } = require("./configuration.js");
 const _ = require("lodash");
 const converter = require("swagger2openapi");
 const https = require("https");
@@ -7,7 +6,7 @@ const yaml = require("js-yaml");
 
 class SwaggerSchemaResolver {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
   /**

package/src/templates.js

@@ -5,7 +5,7 @@ const path = require("path");
 
 class Templates {
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
 

package/src/type-name.js

@@ -4,7 +4,7 @@ class TypeName {
   /** @type {Map<string, string>} */
   formattedModelNamesMap = new Map();
 
-  /** @type {Configuration} */
+  /** @type {CodeGenConfig} */
   config;
 
   /** @type {Logger} */

package/src/util/file-system.js

@@ -23,6 +23,10 @@ class FileSystem {
     return fs.readFileSync(path, { encoding: "UTF-8" });
   };
 
+  readDir = (path) => {
+    return fs.readdirSync(path);
+  };
+
   pathIsDir = (path) => {
     if (!path) return false;
 

package/src/util/logger.js

@@ -4,7 +4,7 @@ const _ = require("lodash");
 class Logger {
   firstLog = true;
   /**
-   * @type {Configuration}
+   * @type {CodeGenConfig}
    */
   config;
 

package/templates/base/http-clients/axios-http-client.ejs

@@ -79,7 +79,7 @@ export class HttpClient<SecurityDataType = unknown> {
     protected createFormData(input: Record<string, unknown>): FormData {
       return Object.keys(input || {}).reduce((formData, key) => {
         const property = input[key];
-        const propertyContent: Iterable<any> = (property instanceof Array) ? property : [property]
+        const propertyContent: any[] = (property instanceof Array) ? property : [property]
 
         for (const formItem of propertyContent) {
           const isFileType = formItem instanceof Blob || formItem instanceof File;