swagger-typescript-api 10.0.3 → 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/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,5 +1,5 @@
 const _ = require("lodash");
-const { getRandomInt } = require("./random");
+const { getRandomInt } = require("./random.js");
 
 class NameResolver {
   reservedNames = [];

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

@@ -9,6 +9,6 @@ const getRandomInt = (min = 0, max = 1) => {
 };
 
 module.exports = {
-  getRandomFloat,
   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`,

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/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/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 }) %>

package/src/apiConfig.js

@@ -1,30 +0,0 @@
-const _ = require("lodash");
-
-const createApiConfig = (swaggerSchema) => {
-  const { info, servers, host, basePath, externalDocs, tags } = swaggerSchema;
-  const server = (servers && servers[0]) || { url: "" };
-  const { title = "No title", version, description: schemaDescription = "" } = info || {};
-  const { url: serverUrl } = server;
-
-  return {
-    info: info || {},
-    servers: servers || [],
-    basePath,
-    host,
-    externalDocs: _.merge(
-      {
-        url: "",
-        description: "",
-      },
-      externalDocs,
-    ),
-    tags: _.compact(tags),
-    baseUrl: serverUrl,
-    title,
-    version,
-  };
-};
-
-module.exports = {
-  createApiConfig,
-};

package/src/common.js

@@ -1,28 +0,0 @@
-const _ = require("lodash");
-
-module.exports = {
-  formatDescription: (description, inline) => {
-    if (!description) return "";
-
-    let prettified = description;
-
-    prettified = _.replace(prettified, /\*\//g, "*/");
-
-    const hasMultipleLines = _.includes(prettified, "\n");
-
-    if (!hasMultipleLines) return prettified;
-
-    if (inline) {
-      return _(prettified)
-        .split(/\n/g)
-        .map((part) => _.trim(part))
-        .compact()
-        .join(" ")
-        .valueOf();
-    }
-
-    return _.replace(prettified, /\n$/g, "");
-  },
-  internalCase: (value) => _.camelCase(_.lowerCase(value)),
-  classNameCase: (value) => _.upperFirst(_.camelCase(value)),
-};

package/src/components.js

@@ -1,91 +0,0 @@
-const _ = require("lodash");
-const { parseSchema } = require("./schema");
-const { config } = require("./config");
-
-/**
- * @typedef {"schemas" | "examples" | "headers" | "parameters" | "requestBodies" | "responses" | "securitySchemes"} ComponentName
- * @typedef {object} RawTypeData
- * @typedef {{ type, typeIdentifier, name, description, content }} TypeData
- *
- * @typedef {{
- *  typeName: string;
- *  componentName: ComponentName;
- *  rawTypeData: RawTypeData;
- *  typeData: TypeData | null;
- * }} TypeInfo
- */
-
-/**
- *
- * @param {ComponentName} componentName
- * @param {string} typeName
- * @param {RawTypeData} rawTypeData
- * @returns {TypeInfo}
- */
-const createComponent = (componentName, typeName, rawTypeData) => {
-  const $ref = `#/components/${componentName}/${typeName}`;
-
-  const componentSchema = {
-    $ref,
-    typeName,
-    rawTypeData,
-    componentName,
-    typeData: null,
-  };
-
-  const usageComponent = config.hooks.onCreateComponent(componentSchema) || componentSchema;
-
-  config.componentsMap[$ref] = usageComponent;
-
-  return usageComponent;
-};
-
-/**
- * @returns {{ [key: string]: TypeInfo }}
- */
-const createComponentsMap = (components) => {
-  config.componentsMap = {};
-
-  _.each(components, (component, componentName) =>
-    _.each(component, (rawTypeData, typeName) => createComponent(componentName, typeName, rawTypeData)),
-  );
-
-  return config.componentsMap;
-};
-
-/**
- *
- * @param {{ [key: string]: TypeInfo }} componentsMap
- * @param {ComponentName} componentName
- * @returns {TypeInfo[]}
- */
-const filterComponentsMap = (componentsMap, componentName) =>
-  _.filter(componentsMap, (v, ref) => _.startsWith(ref, `#/components/${componentName}`));
-
-/**
- *
- * @param {TypeInfo} typeInfo
- * @returns {TypeData}
- */
-const getTypeData = (typeInfo) => {
-  if (!typeInfo.typeData) {
-    typeInfo.typeData = parseSchema(typeInfo.rawTypeData, typeInfo.typeName);
-  }
-
-  return typeInfo.typeData;
-};
-
-/**
- *
- * @param {string} ref
- * @returns {TypeInfo | null}
- */
-const getComponentByRef = (ref) => config.componentsMap[ref] || null;
-
-module.exports = {
-  getTypeData,
-  createComponent,
-  createComponentsMap,
-  filterComponentsMap,
-  getComponentByRef,
-};

package/src/config.js

@@ -1,108 +0,0 @@
-const { HTTP_CLIENT, TS_KEYWORDS, PRETTIER_OPTIONS } = require("./constants");
-const { NameResolver } = require("./utils/resolveName");
-const packageJson = require("../package.json");
-
-const config = {
-  version: packageJson.version,
-  /** CLI flag */
-  templates: "../templates/default",
-  /** CLI flag */
-  generateResponses: false,
-  /** CLI flag */
-  defaultResponseAsSuccess: false,
-  /** CLI flag */
-  generateRouteTypes: false,
-  /** CLI flag */
-  generateClient: true,
-  /** CLI flag */
-  generateUnionEnums: false,
-  /** CLI flag */
-  addReadonly: false,
-  enumNamesAsValues: false,
-  /** parsed swagger schema from getSwaggerObject() */
-
-  /** parsed swagger schema ref */
-  swaggerSchema: null,
-  /** original (converted to json) swagger schema ref */
-  originalSchema: null,
-
-  /** { "#/components/schemas/Foo": @TypeInfo, ... } */
-  componentsMap: {},
-  /** flag for catching convertion from swagger 2.0 */
-  convertedFromSwagger2: false,
-
-  /** url index from paths used for merging into modules */
-  moduleNameIndex: 0,
-
-  /** use the first tag for the module name */
-  moduleNameFirstTag: false,
-  disableStrictSSL: false,
-  disableProxy: false,
-  extractRequestParams: false,
-  extractRequestBody: false,
-  extractResponseBody: false,
-  extractResponseError: false,
-  fileNames: {
-    dataContracts: "data-contracts",
-    routeTypes: "route-types",
-    httpClient: "http-client",
-    outOfModuleApi: "Common",
-  },
-  routeNameDuplicatesMap: new Map(),
-  prettierOptions: PRETTIER_OPTIONS,
-  hooks: {
-    onCreateComponent: (schema) => schema,
-    onParseSchema: (originalSchema, parsedSchema) => parsedSchema,
-    onCreateRoute: (routeData) => routeData,
-    onInit: (config) => config,
-    onPrepareConfig: (apiConfig) => apiConfig,
-    onCreateRequestParams: (rawType) => {},
-    onCreateRouteName: () => {},
-    onFormatTypeName: (typeName, rawTypeName) => {},
-    onFormatRouteName: (routeInfo, templateRouteName) => {},
-  },
-  defaultResponseType: TS_KEYWORDS.VOID,
-  singleHttpClient: false,
-  httpClientType: HTTP_CLIENT.FETCH,
-  unwrapResponseData: false,
-  disableThrowOnError: false,
-  sortTypes: false,
-  templatePaths: {
-    /** `templates/base` */
-    base: "",
-    /** `templates/default` */
-    default: "",
-    /** `templates/modular` */
-    modular: "",
-    /** usage path if `--templates` option is not set */
-    original: "",
-    /** custom path to templates (`--templates`) */
-    custom: "",
-  },
-  /** Record<templateName, templateContent> */
-  templatesToRender: {
-    api: "",
-    dataContracts: "",
-    httpClient: "",
-    routeTypes: "",
-    routeName: "",
-  },
-  toJS: false,
-  silent: false,
-  typePrefix: "",
-  typeSuffix: "",
-  patch: false,
-  componentTypeNameResolver: new NameResolver([]),
-  /** name of the main exported class */
-  apiClassName: "Api",
-  debug: false,
-  internalTemplateOptions: {
-    addUtilRequiredKeysType: false,
-  },
-};
-
-/** needs to use data everywhere in project */
-module.exports = {
-  addToConfig: (configParts) => Object.assign(config, configParts),
-  config,
-};

package/src/filePrefix.js

@@ -1,14 +0,0 @@
-module.exports = {
-  filePrefix: `/* eslint-disable */
-/* tslint:disable */
-/*
- * ---------------------------------------------------------------
- * ## THIS FILE WAS GENERATED VIA SWAGGER-TYPESCRIPT-API        ##
- * ##                                                           ##
- * ## AUTHOR: acacode                                           ##
- * ## SOURCE: https://github.com/acacode/swagger-typescript-api ##
- * ---------------------------------------------------------------
- */
-
-`,
-};