swagger-typescript-api 10.0.2 → 11.0.0--alpha

package/src/util/file-system.js

@@ -0,0 +1,76 @@
+const fs = require("fs");
+const makeDir = require("make-dir");
+const { resolve } = require("path");
+const _ = require("lodash");
+
+const FILE_PREFIX = `/* eslint-disable */
+/* tslint:disable */
+/*
+ * ---------------------------------------------------------------
+ * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
+ * ##                                                           ##
+ * ## AUTHOR: acacode                                           ##
+ * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
+ * ---------------------------------------------------------------
+ */
+
+`;
+
+class FileSystem {
+  constructor() {}
+
+  getFileContent = (path) => {
+    return fs.readFileSync(path, { encoding: "UTF-8" });
+  };
+
+  pathIsDir = (path) => {
+    if (!path) return false;
+
+    try {
+      const stat = fs.statSync(path);
+      return stat.isDirectory();
+    } catch (e) {
+      return false;
+    }
+  };
+
+  cropExtension = (fileName) => {
+    const fileNameParts = _.split(fileName, ".");
+
+    if (fileNameParts.length > 1) {
+      fileNameParts.pop();
+    }
+
+    return fileNameParts.join(".");
+  };
+
+  removeDir = (path) => {
+    try {
+      if (typeof fs.rmSync === "function") {
+        fs.rmSync(path, { recursive: true });
+      } else {
+        fs.rmdirSync(path, { recursive: true });
+      }
+    } catch (e) {}
+  };
+
+  createDir = (path) => {
+    try {
+      makeDir.sync(path);
+    } catch (e) {}
+  };
+
+  cleanDir = (path) => {
+    removeDir(path);
+    createDir(path);
+  };
+
+  pathIsExist = (path) => path && fs.existsSync(path);
+
+  createFile = ({ path, fileName, content, withPrefix }) =>
+    fs.writeFileSync(resolve(__dirname, path, `./${fileName}`), `${withPrefix ? FILE_PREFIX : ""}${content}`, _.noop);
+}
+
+module.exports = {
+  FileSystem,
+};

package/src/{utils → util}/id.js

@@ -1,9 +1,9 @@
-const { customAlphabet } = require("nanoid");
-
-const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
-
-const generateId = customAlphabet(ALPHABET, 12);
-
-module.exports = {
-  generateId,
-};
+const { customAlphabet } = require("nanoid");
+
+const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
+
+const generateId = customAlphabet(ALPHABET, 12);
+
+module.exports = {
+  generateId,
+};

package/src/util/internal-case.js

@@ -0,0 +1,5 @@
+const _ = require("lodash");
+
+module.exports = {
+  internalCase: (value) => _.camelCase(_.lowerCase(value)),
+};

package/src/util/logger.js

@@ -0,0 +1,100 @@
+const { emojify } = require("node-emoji");
+const _ = require("lodash");
+
+class Logger {
+  firstLog = true;
+  /**
+   * @type {Configuration}
+   */
+  config;
+
+  constructor(config) {
+    this.config = config;
+  }
+
+  createLogMessage = ({ type, emojiName, messages }) => {
+    if (this.config.silent) return;
+
+    const emoji = emojify(emojiName);
+
+    if (this.firstLog) {
+      this.firstLog = false;
+      this.log(
+        `swagger-typescript-api(${this.config.version}),${
+          process.env.npm_config_user_agent || `nodejs(${process.version})`
+        }`,
+      );
+    }
+
+    console[type](
+      emoji,
+      " ",
+      ..._.map(messages, (message) =>
+        _.startsWith(message, "\n") ? `\n${emoji}   ${message.replace(/\n/, "")}` : message,
+      ),
+    );
+  };
+
+  /**
+   *
+   * @param messages {any[]}
+   */
+  log = (...messages) =>
+    this.createLogMessage({
+      type: "log",
+      emojiName: ":sparkles:",
+      messages,
+    });
+
+  /**
+   *
+   * @param messages {any[]}
+   * @return {void}
+   */
+  event = (...messages) =>
+    this.createLogMessage({
+      type: "log",
+      emojiName: ":comet: ",
+      messages,
+    });
+
+  /**
+   *
+   * @param messages {any[]}
+   * @return {void}
+   */
+  success = (...messages) =>
+    this.createLogMessage({
+      type: "log",
+      emojiName: ":white_check_mark:",
+      messages,
+    });
+
+  /**
+   *
+   * @param messages {any[]}
+   * @return {void}
+   */
+  warn = (...messages) =>
+    this.createLogMessage({
+      type: "warn",
+      emojiName: ":warning: ",
+      messages,
+    });
+
+  /**
+   *
+   * @param messages {any[]}
+   * @return {void}
+   */
+  error = (...messages) =>
+    this.createLogMessage({
+      type: "error",
+      emojiName: ":exclamation:",
+      messages,
+    });
+}
+
+module.exports = {
+  Logger,
+};

package/src/{utils/resolveName.js → util/name-resolver.js}

@@ -1,97 +1,94 @@
-const _ = require("lodash");
-const { getRandomInt } = require("./random");
-
-class NameResolver {
-  reservedNames = [];
-  getDefaultName = null;
-
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames, getDefaultName) {
-    this.getDefaultName = getDefaultName;
-    this.reserve(reservedNames);
-  }
-
-  /**
-   *
-   * @param {string[]} names
-   */
-  reserve(names) {
-    this.reservedNames.push(..._.uniq(_.compact(names)));
-  }
-
-  unreserve(names) {
-    this.reservedNames.filter((reservedName) => !names.some((name) => name === reservedName));
-  }
-
-  isReserved(name) {
-    return _.some(this.reservedNames, (reservedName) => reservedName === name);
-  }
-
-  /**
-   *
-   * @param {string[]} variants
-   * @param {((variant: string) => string) | undefined} onSelectMutation
-   * @returns {string | null}
-   */
-  resolve(variants, onSelectMutation) {
-    let usageName = null;
-    const uniqVariants = _.uniq(_.compact(variants));
-
-    _.forEach(uniqVariants, (variant) => {
-      const mutatedVariant = onSelectMutation ? onSelectMutation(variant) : variant;
-      if (!usageName && !this.isReserved(mutatedVariant)) {
-        usageName = mutatedVariant;
-      }
-    });
-
-    if (usageName) {
-      this.reserve([usageName]);
-      return usageName;
-    }
-
-    const defaultName = this.getDefaultName && this.getDefaultName(variants);
-
-    if (defaultName) {
-      this.reserve([onSelectMutation ? onSelectMutation(defaultName) : defaultName]);
-      return defaultName;
-    }
-
-    return null;
-  }
-}
-
-class SpecificArgNameResolver extends NameResolver {
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
-      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
-    });
-  }
-}
-
-class ComponentTypeNameResolver extends NameResolver {
-  /**
-   *
-   * @param {string[]} reservedNames
-   */
-  constructor(reservedNames) {
-    super(reservedNames, (variants) => {
-      return (
-        (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) ||
-        `ComponentType${getRandomInt(1, 10)}`
-      );
-    });
-  }
-}
-
-module.exports = {
-  NameResolver,
-  SpecificArgNameResolver,
-  ComponentTypeNameResolver,
-};
+const _ = require("lodash");
+const { getRandomInt } = require("./random.js");
+
+class NameResolver {
+  reservedNames = [];
+  getDefaultName = null;
+
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames, getDefaultName) {
+    this.getDefaultName = getDefaultName;
+    this.reserve(reservedNames);
+  }
+
+  /**
+   *
+   * @param {string[]} names
+   */
+  reserve(names) {
+    this.reservedNames.push(..._.uniq(_.compact(names)));
+  }
+
+  unreserve(names) {
+    this.reservedNames.filter((reservedName) => !names.some((name) => name === reservedName));
+  }
+
+  isReserved(name) {
+    return _.some(this.reservedNames, (reservedName) => reservedName === name);
+  }
+
+  /**
+   *
+   * @param {string[]} variants
+   * @param {((variant: string) => string) | undefined} onSelectMutation
+   * @returns {string | null}
+   */
+  resolve(variants, onSelectMutation) {
+    let usageName = null;
+    const uniqVariants = _.uniq(_.compact(variants));
+
+    _.forEach(uniqVariants, (variant) => {
+      const mutatedVariant = onSelectMutation ? onSelectMutation(variant) : variant;
+      if (!usageName && !this.isReserved(mutatedVariant)) {
+        usageName = mutatedVariant;
+      }
+    });
+
+    if (usageName) {
+      this.reserve([usageName]);
+      return usageName;
+    }
+
+    const defaultName = this.getDefaultName && this.getDefaultName(variants);
+
+    if (defaultName) {
+      this.reserve([onSelectMutation ? onSelectMutation(defaultName) : defaultName]);
+      return defaultName;
+    }
+
+    return null;
+  }
+}
+
+class SpecificArgNameResolver extends NameResolver {
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames) {
+    super(reservedNames, (variants) => {
+      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
+    });
+  }
+}
+
+class ComponentTypeNameResolver extends NameResolver {
+  /**
+   *
+   * @param {string[]} reservedNames
+   */
+  constructor(reservedNames) {
+    super(reservedNames, (variants) => {
+      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `ComponentType${getRandomInt(1, 10)}`;
+    });
+  }
+}
+
+module.exports = {
+  NameResolver,
+  SpecificArgNameResolver,
+  ComponentTypeNameResolver,
+};

package/src/util/object-assign.js

@@ -0,0 +1,11 @@
+const _ = require("lodash");
+
+const objectAssign = (target, updaterFn) => {
+  if (!updaterFn) return;
+  const updated = typeof updaterFn === "function" ? updaterFn(target) : updaterFn;
+  Object.assign(target, _.merge(target, updated));
+};
+
+module.exports = {
+  objectAssign,
+};

package/src/util/pascal-case.js

@@ -0,0 +1,5 @@
+const _ = require("lodash");
+
+module.exports = {
+  pascalCase: (value) => _.upperFirst(_.camelCase(value)),
+};

package/src/{utils → util}/random.js

@@ -1,14 +1,14 @@
-const getRandomFloat = (min = 0, max = 1) => {
-  return Math.random() * (max - min) + min;
-};
-
-const getRandomInt = (min = 0, max = 1) => {
-  if (min === max) return min;
-
-  return Math.round(getRandomFloat(min, max));
-};
-
-module.exports = {
-  getRandomFloat,
-  getRandomInt,
-};
+const getRandomFloat = (min = 0, max = 1) => {
+  return Math.random() * (max - min) + min;
+};
+
+const getRandomInt = (min = 0, max = 1) => {
+  if (min === max) return min;
+
+  return Math.round(getRandomFloat(min, max));
+};
+
+module.exports = {
+  getRandomInt,
+  getRandomFloat,
+};

package/templates/base/data-contract-jsdoc.ejs

@@ -1,32 +1,37 @@
 <%
-const { contract, utils } = it;
+const { data, utils } = it;
 const { formatDescription, require, _ } = utils;
 
-let jsDocLines = [];
+const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value
 
-jsDocLines.push(
-    contract.title,
-    contract.description && formatDescription(contract.description),
-)
-
-if (contract.typeData) {
-  jsDocLines.push(
-      contract.typeData.deprecated === true && '@deprecated',
-      !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
-      !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
-      !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,
-      !_.isUndefined(contract.typeData.pattern) && `@pattern ${contract.typeData.pattern}`,
-      !_.isUndefined(contract.typeData.example) && `@example ${
-              _.isObject(contract.typeData.example) ? JSON.stringify(contract.typeData.example) : contract.typeData.example
-      }`
-  )
-}
-
-jsDocLines = _.compact(jsDocLines);
+const jsDocLines = _.compact([
+    data.title,
+    data.description && formatDescription(data.description),
+    data.deprecated === true && '@deprecated',
+    !_.isUndefined(data.format) && `@format ${data.format}`,
+    !_.isUndefined(data.minimum) && `@min ${data.minimum}`,
+    !_.isUndefined(data.multipleOf) && `@multipleOf ${data.multipleOf}`,
+    !_.isUndefined(data.exclusiveMinimum) && `@exclusiveMin ${data.exclusiveMinimum}`,
+    !_.isUndefined(data.maximum) && `@max ${data.maximum}`,
+    !_.isUndefined(data.minLength) && `@minLength ${data.minLength}`,
+    !_.isUndefined(data.maxLength) && `@maxLength ${data.maxLength}`,
+    !_.isUndefined(data.exclusiveMaximum) && `@exclusiveMax ${data.exclusiveMaximum}`,
+    !_.isUndefined(data.maxItems) && `@maxItems ${data.maxItems}`,
+    !_.isUndefined(data.minItems) && `@minItems ${data.minItems}`,
+    !_.isUndefined(data.uniqueItems) && `@uniqueItems ${data.uniqueItems}`,
+    !_.isUndefined(data.default) && `@default ${stringify(data.default)}`,
+    !_.isUndefined(data.pattern) && `@pattern ${data.pattern}`,
+    !_.isUndefined(data.example) && `@example ${stringify(data.example)}`
+]).join('\n').split('\n');
 %>
-<% if (jsDocLines.length) { %>
+<% if (jsDocLines.every(_.isEmpty)) { %>
+<% } else if (jsDocLines.length === 1) { %>
+/** <%~ jsDocLines[0] %> */
+<% } else if (jsDocLines.length) { %>
 /**
-<%~ jsDocLines.map(part => `* ${part}`).join("\n") %>
+<% for (jsDocLine of jsDocLines) { %>
+ * <%~ jsDocLine %>
 
-*/
 <% } %>
+ */
+<% } %>

package/templates/base/data-contracts.ejs

@@ -1,6 +1,6 @@
 <%
 const { modelTypes, utils, config } = it;
-const { formatDescription, require, _ } = utils;
+const { formatDescription, require, _, Ts } = utils;
 
 
 const dataContractTemplates = {
@@ -17,11 +17,11 @@ const dataContractTemplates = {
 %>
 
 <% if (config.internalTemplateOptions.addUtilRequiredKeysType) { %>
-type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+type <%~ config.Ts.CodeGenKeyword.UtilRequiredKeys %><T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
 <% } %>
 
 <% modelTypes.forEach((contract) => { %>
-  <%~ includeFile('@base/data-contract-jsdoc.ejs', { ...it, contract }) %>
+  <%~ includeFile('@base/data-contract-jsdoc.ejs', { ...it, data: { ...contract, ...contract.typeData } }) %>
   export <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
 
 

package/templates/base/interface-data-contract.ejs

@@ -1,6 +1,7 @@
 <%
 const { contract, utils } = it;
 const { formatDescription, require, _ } = utils;
+console.info('contract', contract.name, contract)
 %>
 export interface <%~ contract.name %> {
   <% _.forEach(contract.$content, (field) => { %>

package/templates/base/route-docs.ejs

@@ -1,6 +1,6 @@
 <%
 const { config, route, utils } = it;
-const { _, formatDescription, fmtToJSDocLine, classNameCase, require } = utils;
+const { _, formatDescription, fmtToJSDocLine, pascalCase, require } = utils;
 const { raw, request, routeName } = route;
 
 const jsDocDescription = raw.description ?
@@ -8,7 +8,7 @@ const jsDocDescription = raw.description ?
     fmtToJSDocLine('No description', { eol: false });
 const jsDocLines = _.compact([
     _.size(raw.tags) && ` * @tags ${raw.tags.join(", ")}`,
-    ` * @name ${classNameCase(routeName.usage)}`,
+    ` * @name ${pascalCase(routeName.usage)}`,
     raw.summary && ` * @summary ${raw.summary}`,
     ` * @request ${_.upperCase(request.method)}:${raw.route}`,
     raw.deprecated && ` * @deprecated`,
@@ -21,8 +21,7 @@ const jsDocLines = _.compact([
             ` * @response \`${status}\` \`${_.replace(_.replace(type, /\/\*/g, "\\*"), /\*\//g, "*\\")}\` ${description}`,
         )
     : []),
-]).join("\n");
-
+]).map(str => str.trimEnd()).join("\n");
 
 return {
   description: jsDocDescription,

package/templates/base/route-type.ejs

@@ -1,10 +1,10 @@
 <%
 const { route, utils, config } = it;
-const { _, classNameCase, require } = utils;
+const { _, pascalCase, require } = utils;
 const { query, payload, pathParams, headers } = route.request;
 
 const routeDocs = includeFile("@base/route-docs", { config, route, utils });
-const routeNamespace = classNameCase(route.routeName.usage);
+const routeNamespace = pascalCase(route.routeName.usage);
 
 %>
 /**

package/templates/default/procedure-call.ejs

@@ -81,7 +81,7 @@ const describeReturnType = () => {
 /**
 <%~ routeDocs.description %>
 
- * <% /* Here you can add some other JSDoc tags */ %>
+ *<% /* Here you can add some other JSDoc tags */ %>
 
 <%~ routeDocs.lines %>
 
@@ -96,4 +96,4 @@ const describeReturnType = () => {
         <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
         <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
         ...<%~ _.get(requestConfigParam, "name") %>,
-    })<%~ route.namespace ? ',' : '' %>
+    })<%~ route.namespace ? ',' : '' %>

package/templates/default/route-types.ejs

@@ -1,6 +1,6 @@
 <%
 const { utils, config, routes, modelTypes } = it;
-const { _, classNameCase } = utils;
+const { _, pascalCase } = utils;
 const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
 %>
 
@@ -19,7 +19,7 @@ import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataCont
 <% }) %>
 
 <% routes.combined && routes.combined.forEach(({ routes = [], moduleName }) => { %>
-    export namespace <%~ classNameCase(moduleName) %> {
+    export namespace <%~ pascalCase(moduleName) %> {
     <% routes.forEach((route) => { %>
         <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>
     <% }) %>

package/templates/modular/api.ejs

@@ -1,7 +1,7 @@
 <%
 const { utils, route, config, modelTypes } = it;
-const { _, classNameCase, require } = utils;
-const apiClassName = classNameCase(route.moduleName);
+const { _, pascalCase, require } = utils;
+const apiClassName = pascalCase(route.moduleName);
 const routes = route.routes;
 const dataContracts = _.map(modelTypes, "name");
 %>

package/templates/modular/procedure-call.ejs

@@ -81,7 +81,7 @@ const describeReturnType = () => {
 /**
 <%~ routeDocs.description %>
 
- * <% /* Here you can add some other JSDoc tags */ %>
+ *<% /* Here you can add some other JSDoc tags */ %>
 
 <%~ routeDocs.lines %>
 
@@ -96,4 +96,4 @@ const describeReturnType = () => {
         <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
         <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
         ...<%~ _.get(requestConfigParam, "name") %>,
-    })
+    })

package/templates/modular/route-types.ejs

@@ -1,6 +1,6 @@
 <%
 const { utils, config, route, modelTypes } = it;
-const { _, classNameCase } = utils;
+const { _, pascalCase } = utils;
 const { routes, moduleName } = route;
 const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
 
@@ -9,7 +9,7 @@ const dataContracts = config.modular ? _.map(modelTypes, "name") : [];
 import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
 <% } %>
 
-export namespace <%~ classNameCase(moduleName) %> {
+export namespace <%~ pascalCase(moduleName) %> {
     <% _.forEach(routes, (route) => { %>
 
         <%~ includeFile('@base/route-type.ejs', { ...it, route }) %>