swagger-typescript-api 12.0.4 → 13.0.0

package/src/{type-name.js → type-name-formatter.js}

@@ -1,10 +1,10 @@
-const _ = require("lodash");
+const _ = require('lodash');
 
 /**
  * @typedef {"enum-key" | "type-name"} FormattingSchemaType
  */
 
-class TypeName {
+class TypeNameFormatter {
   /** @type {Map<string, string>} */
   formattedModelNamesMap = new Map();
 
@@ -14,7 +14,7 @@ class TypeName {
   /** @type {Logger} */
   logger;
 
-  constructor(config, logger) {
+  constructor({ config, logger }) {
     this.config = config;
     this.logger = logger;
   }
@@ -30,20 +30,27 @@ class TypeName {
     /**
      * @type {FormattingSchemaType}
      */
-    const schemaType = options.type || "type-name";
+    const schemaType = options.type || 'type-name';
 
-    const typePrefix = schemaType === "enum-key" ? this.config.enumKeyPrefix : this.config.typePrefix;
-    const typeSuffix = schemaType === "enum-key" ? this.config.enumKeySuffix : this.config.typeSuffix;
+    const typePrefix =
+      schemaType === 'enum-key'
+        ? this.config.enumKeyPrefix
+        : this.config.typePrefix;
+    const typeSuffix =
+      schemaType === 'enum-key'
+        ? this.config.enumKeySuffix
+        : this.config.typeSuffix;
 
     const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
 
-    if (typeof name !== "string") {
-      this.logger.warn("wrong name of the model name", name);
+    if (typeof name !== 'string') {
+      this.logger.warn('wrong name of the model name', name);
       return name;
     }
 
+    // constant names like LEFT_ARROW, RIGHT_FORWARD, ETC_KEY, _KEY_NUM_
     if (/^([A-Z_]{1,})$/g.test(name)) {
-      return _.compact([typePrefix, name, typeSuffix]).join("_");
+      return _.compact([typePrefix, name, typeSuffix]).join('_');
     }
 
     if (this.formattedModelNamesMap.has(hashKey)) {
@@ -52,8 +59,14 @@ class TypeName {
 
     const fixedModelName = this.fixModelName(name, { type: schemaType });
 
-    const formattedName = _.replace(_.startCase(`${typePrefix}_${fixedModelName}_${typeSuffix}`), /\s/g, "");
-    const formattedResultName = this.config.hooks.onFormatTypeName(formattedName, name, schemaType) || formattedName;
+    const formattedName = _.replace(
+      _.startCase(`${typePrefix}_${fixedModelName}_${typeSuffix}`),
+      /\s/g,
+      '',
+    );
+    const formattedResultName =
+      this.config.hooks.onFormatTypeName(formattedName, name, schemaType) ||
+      formattedName;
 
     this.formattedModelNamesMap.set(hashKey, formattedResultName);
 
@@ -68,25 +81,27 @@ class TypeName {
    * @return {string}
    */
   fixModelName = (name, options) => {
+    const { type } = options || {};
+
     if (!this.isValidName(name)) {
       if (!/^[a-zA-Z_$]/g.test(name)) {
         const fixPrefix =
-          options && options.type === "enum-key"
+          type === 'enum-key'
             ? this.config.fixInvalidEnumKeyPrefix
             : this.config.fixInvalidTypeNamePrefix;
         name = `${fixPrefix} ${name}`;
       }
 
       // specific replaces for TSOA 3.x
-      if (name.includes("."))
+      if (name.includes('.'))
         name = name
-          .replace(/Exclude_keyof[A-Za-z]{1,}/g, (match) => "ExcludeKeys")
-          .replace(/%22\~AND\~%22/g, "And")
-          .replace(/%22\~OR\~%22/g, "Or")
-          .replace(/(\.?%22)|\./g, "_")
-          .replace(/__+$/, "");
+          .replace(/Exclude_keyof[A-Za-z]+/g, () => 'ExcludeKeys')
+          .replace(/%22~AND~%22/g, 'And')
+          .replace(/%22~OR~%22/g, 'Or')
+          .replace(/(\.?%22)|\./g, '_')
+          .replace(/__+$/, '');
 
-      if (name.includes("-")) name = _.startCase(name).replace(/ /g, "");
+      if (name.includes('-')) name = _.startCase(name).replace(/ /g, '');
     }
 
     return name;
@@ -94,5 +109,5 @@ class TypeName {
 }
 
 module.exports = {
-  TypeName,
+  TypeNameFormatter,
 };

package/src/util/file-system.js

@@ -1,7 +1,8 @@
-const fs = require("fs");
-const makeDir = require("make-dir");
-const { resolve } = require("path");
-const _ = require("lodash");
+const fs = require('fs');
+const makeDir = require('make-dir');
+const { resolve } = require('path');
+const _ = require('lodash');
+const { Logger } = require('./logger');
 
 const FILE_PREFIX = `/* eslint-disable */
 /* tslint:disable */
@@ -17,10 +18,15 @@ const FILE_PREFIX = `/* eslint-disable */
 `;
 
 class FileSystem {
-  constructor() {}
+  /** @type {Logger} */
+  logger;
+
+  constructor({ logger = new Logger('file-system') } = {}) {
+    this.logger = logger;
+  }
 
   getFileContent = (path) => {
-    return fs.readFileSync(path, { encoding: "UTF-8" });
+    return fs.readFileSync(path, { encoding: 'UTF-8' });
   };
 
   readDir = (path) => {
@@ -39,29 +45,33 @@ class FileSystem {
   };
 
   cropExtension = (fileName) => {
-    const fileNameParts = _.split(fileName, ".");
+    const fileNameParts = _.split(fileName, '.');
 
     if (fileNameParts.length > 1) {
       fileNameParts.pop();
     }
 
-    return fileNameParts.join(".");
+    return fileNameParts.join('.');
   };
 
   removeDir = (path) => {
     try {
-      if (typeof fs.rmSync === "function") {
+      if (typeof fs.rmSync === 'function') {
         fs.rmSync(path, { recursive: true });
       } else {
         fs.rmdirSync(path, { recursive: true });
       }
-    } catch (e) {}
+    } catch (e) {
+      this.logger.debug('failed to remove dir', e);
+    }
   };
 
   createDir = (path) => {
     try {
       makeDir.sync(path);
-    } catch (e) {}
+    } catch (e) {
+      this.logger.debug('failed to create dir', e);
+    }
   };
 
   cleanDir = (path) => {
@@ -69,10 +79,16 @@ class FileSystem {
     this.createDir(path);
   };
 
-  pathIsExist = (path) => path && fs.existsSync(path);
+  pathIsExist = (path) => {
+    return !!path && fs.existsSync(path);
+  };
+
+  createFile = ({ path, fileName, content, withPrefix }) => {
+    const absolutePath = resolve(__dirname, path, `./${fileName}`);
+    const fileContent = `${withPrefix ? FILE_PREFIX : ''}${content}`;
 
-  createFile = ({ path, fileName, content, withPrefix }) =>
-    fs.writeFileSync(resolve(__dirname, path, `./${fileName}`), `${withPrefix ? FILE_PREFIX : ""}${content}`, _.noop);
+    return fs.writeFileSync(absolutePath, fileContent, _.noop);
+  };
 }
 
 module.exports = {

package/src/util/id.js

@@ -1,6 +1,6 @@
-const { customAlphabet } = require("nanoid");
+const { customAlphabet } = require('nanoid');
 
-const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
+const ALPHABET = 'abcdefghijklmnopqrstuvwxyz0123456789';
 
 const generateId = customAlphabet(ALPHABET, 12);
 

package/src/util/internal-case.js

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

package/src/util/logger.js

@@ -1,5 +1,5 @@
-const { emojify } = require("node-emoji");
-const _ = require("lodash");
+const { emojify } = require('node-emoji');
+const _ = require('lodash');
 
 class Logger {
   firstLog = true;
@@ -8,11 +8,11 @@ class Logger {
    */
   config;
 
-  constructor(config) {
+  constructor({ config }) {
     this.config = config;
   }
 
-  createLogMessage = ({ type, emojiName, messages, raw }) => {
+  createLogMessage = ({ type, emojiName, messages }) => {
     if (this.config.silent) return;
 
     const emoji = emojify(emojiName);
@@ -22,20 +22,44 @@ class Logger {
       this.log(
         `swagger-typescript-api(${this.config.version}),${
           process.env.npm_config_user_agent || `nodejs(${process.version})`
-        }`,
+        },debug mode ${this.config.debug ? 'ENABLED' : 'DISABLED'}`,
       );
     }
 
-    if (raw) {
-      console.log(...raw);
+    if (type === 'debug' || this.config.debug) {
+      const trace = new Error().stack
+        .split('\n')
+        .splice(3)
+        .filter(
+          (line) =>
+            !line.includes('swagger-typescript-api\\node_modules') &&
+            !line.includes('swagger-typescript-api/node_modules'),
+        )
+        .slice(0, 10);
+      const logFn = console[type] || console.log;
+      logFn(`${emoji}  [${type}]`, new Date().toISOString());
+      if (this.config.debugExtras && Array.isArray(this.config.debugExtras)) {
+        logFn(`[${this.config.debugExtras.join(' ')}]`);
+      }
+      logFn(
+        '[message]',
+        ..._.map(messages, (message) =>
+          _.startsWith(message, '\n')
+            ? `\n          ${message.replace(/\n/, '')}`
+            : message,
+        ),
+      );
+      logFn(trace.join('\n') + '\n---');
       return;
     }
 
     console[type](
       emoji,
-      " ",
+      ' ',
       ..._.map(messages, (message) =>
-        _.startsWith(message, "\n") ? `\n${emoji}   ${message.replace(/\n/, "")}` : message,
+        _.startsWith(message, '\n')
+          ? `\n${emoji}   ${message.replace(/\n/, '')}`
+          : message,
       ),
     );
   };
@@ -46,8 +70,8 @@ class Logger {
    */
   log = (...messages) =>
     this.createLogMessage({
-      type: "log",
-      emojiName: ":sparkles:",
+      type: 'log',
+      emojiName: ':sparkles:',
       messages,
     });
 
@@ -58,8 +82,8 @@ class Logger {
    */
   event = (...messages) =>
     this.createLogMessage({
-      type: "log",
-      emojiName: ":comet: ",
+      type: 'log',
+      emojiName: ':star:',
       messages,
     });
 
@@ -70,8 +94,8 @@ class Logger {
    */
   success = (...messages) =>
     this.createLogMessage({
-      type: "log",
-      emojiName: ":white_check_mark:",
+      type: 'log',
+      emojiName: ':white_check_mark:',
       messages,
     });
 
@@ -82,8 +106,8 @@ class Logger {
    */
   warn = (...messages) =>
     this.createLogMessage({
-      type: "warn",
-      emojiName: ":warning: ",
+      type: 'warn',
+      emojiName: ':exclamation:',
       messages,
     });
 
@@ -94,8 +118,8 @@ class Logger {
    */
   error = (...messages) =>
     this.createLogMessage({
-      type: "error",
-      emojiName: ":exclamation:",
+      type: 'error',
+      emojiName: ':no_entry:',
       messages,
     });
 
@@ -108,7 +132,9 @@ class Logger {
     if (!this.config.debug) return;
 
     this.createLogMessage({
-      raw: messages,
+      type: 'debug',
+      emojiName: ':black_large_square:',
+      messages,
     });
   };
 }

package/src/util/name-resolver.js

@@ -1,20 +1,21 @@
-const _ = require("lodash");
-const { getRandomInt } = require("./random.js");
+const _ = require('lodash');
 
 class NameResolver {
   reservedNames = [];
   getFallbackName = null;
 
-  /**
-   * @type {Logger}
-   */
+  /** @type {CodeGenConfig} */
+  config;
+  /** @type {Logger} */
   logger;
 
   /**
+   * @param {CodeGenConfig} config;
    * @param {Logger} logger;
    * @param {string[]} reservedNames
    */
-  constructor(logger, reservedNames, getFallbackName) {
+  constructor(config, logger, reservedNames, getFallbackName) {
+    this.config = config;
     this.logger = logger;
     this.getFallbackName = getFallbackName;
     this.reserve(reservedNames);
@@ -24,11 +25,18 @@ class NameResolver {
    * @param {string[]} names
    */
   reserve(names) {
-    this.reservedNames.push(..._.uniq(_.compact(names)));
+    const fixedNames = _.uniq(_.compact(names));
+    for (const name of fixedNames) {
+      if (this.reservedNames.indexOf(name) === -1) {
+        this.reservedNames.push(name);
+      }
+    }
   }
 
   unreserve(names) {
-    this.reservedNames.filter((reservedName) => !names.some((name) => name === reservedName));
+    this.reservedNames.filter(
+      (reservedName) => !names.some((name) => name === reservedName),
+    );
   }
 
   isReserved(name) {
@@ -37,13 +45,32 @@ class NameResolver {
 
   /**
    *
-   * @param {(string[]) | ((reserved: string[]) => string)} variantsOrResolver
+   * @param {(string[])} variants
+   * @param {(reserved: string[]) => string)} [resolver]
+   * @param {any} [extras]
    * @returns {string | null}
    */
-  resolve(variantsOrResolver, shouldReserve = true) {
-    this.logger.debug("resolving name with using", variantsOrResolver);
-    if (Array.isArray(variantsOrResolver)) {
-      const variants = variantsOrResolver;
+  resolve(variants, resolver, extras, shouldReserve = true) {
+    if (typeof resolver === 'function') {
+      let usageName = null;
+      while (usageName === null) {
+        const variant = resolver(variants, extras);
+
+        if (variant === undefined) {
+          this.logger.warn(
+            'unable to resolve name. current reserved names: ',
+            this.reservedNames,
+          );
+          return null;
+        }
+        if (!shouldReserve || !this.isReserved(variant)) {
+          usageName = variant;
+        }
+      }
+
+      shouldReserve && this.reserve([usageName]);
+      return usageName;
+    } else if (Array.isArray(variants)) {
       let usageName = null;
       const uniqVariants = _.uniq(_.compact(variants));
 
@@ -58,56 +85,21 @@ class NameResolver {
         return usageName;
       }
 
-      this.logger.debug("trying to resolve name with using fallback name generator");
-      return this.resolve(this.getFallbackName);
-    } else if (typeof variantsOrResolver === "function") {
-      let usageName = null;
-      while (usageName === null) {
-        const variant = variantsOrResolver(this.reservedNames);
-
-        if (variant === undefined) {
-          this.logger.warn("unable to resolve name. current reserved names: ", this.reservedNames);
-          return null;
-        }
-        if (!this.isReserved(variant)) {
-          usageName = variant;
-        }
-      }
-
-      shouldReserve && this.reserve([usageName]);
-      return usageName;
+      this.logger.debug(
+        'trying to resolve name with using fallback name generator using variants',
+        variants,
+      );
+      return this.resolve(variants, this.getFallbackName, extras);
     }
 
-    this.logger.debug("problem with reserving names. current reserved names: ", this.reservedNames);
+    this.logger.debug(
+      'problem with reserving names. current reserved names: ',
+      this.reservedNames,
+    );
     return null;
   }
 }
 
-class SpecificArgNameResolver extends NameResolver {
-  /**
-   * @param {Logger} logger;
-   * @param {string[]} reservedNames
-   */
-  constructor(logger, reservedNames) {
-    super(logger, reservedNames, (variants) => {
-      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `arg${getRandomInt(1, 10)}`;
-    });
-  }
-}
-
-class ComponentTypeNameResolver extends NameResolver {
-  /**
-   * @param {Logger} logger;
-   * @param {string[]} reservedNames
-   */
-  constructor(logger, reservedNames) {
-    super(logger, reservedNames, (variants) => {
-      return (variants[0] && `${variants[0]}${getRandomInt(1, 10)}`) || `ComponentType${getRandomInt(1, 10)}`;
-    });
-  }
-}
-
 module.exports = {
-  SpecificArgNameResolver,
-  ComponentTypeNameResolver,
+  NameResolver,
 };

package/src/util/object-assign.js

@@ -1,9 +1,13 @@
-const _ = require("lodash");
+const _ = require('lodash');
 
 const objectAssign = (target, updaterFn) => {
   if (!updaterFn) return;
-  const update = typeof updaterFn === "function" ? updaterFn(target) : updaterFn;
-  const undefinedKeys = _.map(update, (value, key) => value === undefined && key).filter(Boolean);
+  const update =
+    typeof updaterFn === 'function' ? updaterFn(target) : updaterFn;
+  const undefinedKeys = _.map(
+    update,
+    (value, key) => value === undefined && key,
+  ).filter(Boolean);
   Object.assign(target, _.merge(target, update));
   undefinedKeys.forEach((key) => {
     target[key] = undefined;

package/src/util/pascal-case.js

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

package/src/util/request.js

@@ -1,6 +1,6 @@
-const _ = require("lodash");
-const https = require("https");
-const fetch = require("node-fetch-h2");
+const _ = require('lodash');
+const https = require('https');
+const fetch = require('node-fetch-h2');
 
 class Request {
   /**
@@ -31,7 +31,7 @@ class Request {
      */
     const requestOptions = {};
 
-    if (disableStrictSSL && !_.startsWith(url, "http://")) {
+    if (disableStrictSSL && !_.startsWith(url, 'http://')) {
       requestOptions.agent = new https.Agent({
         rejectUnauthorized: false,
       });
@@ -49,7 +49,7 @@ class Request {
       return await response.text();
     } catch (error) {
       const message = `error while fetching data from URL "${url}"`;
-      this.logger.error(message, "response" in error ? error.response : error);
+      this.logger.error(message, 'response' in error ? error.response : error);
       return message;
     }
   }

package/src/util/sort-by-property.js

@@ -0,0 +1,17 @@
+/**
+ * @param propertyName {string}
+ * @returns {(o1: Record<string, any>, o2: Record<string, any>) => 1 | -1 | 0}
+ */
+const sortByProperty = (propertyName) => (o1, o2) => {
+  if (o1[propertyName] > o2[propertyName]) {
+    return 1;
+  }
+  if (o1[propertyName] < o2[propertyName]) {
+    return -1;
+  }
+  return 0;
+};
+
+module.exports = {
+  sortByProperty,
+};

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

@@ -1,37 +1,37 @@
-<%
-const { data, utils } = it;
-const { formatDescription, require, _ } = utils;
-
-const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value
-
-const jsDocLines = _.compact([
-    data.title,
-    data.description && formatDescription(data.description),
-    !_.isUndefined(data.deprecated) && data.deprecated && '@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.every(_.isEmpty)) { %>
-<% } else if (jsDocLines.length === 1) { %>
-/** <%~ jsDocLines[0] %> */
-<% } else if (jsDocLines.length) { %>
-/**
-<% for (jsDocLine of jsDocLines) { %>
- * <%~ jsDocLine %>
-
-<% } %>
- */
-<% } %>
+<%
+const { data, utils } = it;
+const { formatDescription, require, _ } = utils;
+
+const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value
+
+const jsDocLines = _.compact([
+    data.title,
+    data.description && formatDescription(data.description),
+    !_.isUndefined(data.deprecated) && data.deprecated && '@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.every(_.isEmpty)) { %>
+<% } else if (jsDocLines.length === 1) { %>
+/** <%~ jsDocLines[0] %> */
+<% } else if (jsDocLines.length) { %>
+/**
+<% for (jsDocLine of jsDocLines) { %>
+ * <%~ jsDocLine %>
+
+<% } %>
+ */
+<% } %>