swagger-typescript-api 10.0.2 → 10.0.3

package/src/render/utils/index.js

@@ -1,31 +1,31 @@
-const { classNameCase, formatDescription, internalCase } = require("../../common");
-const { getComponentByRef } = require("../../components");
-const { formatModelName } = require("../../modelNames");
-const {
-  getInlineParseContent,
-  getParseContent,
-  parseSchema,
-  checkAndAddNull,
-  isNeedToAddNull,
-} = require("../../schema");
-const { formatters, inlineExtraFormatters } = require("../../typeFormatters");
-const { NameResolver } = require("../../utils/resolveName");
-
-module.exports = {
-  formatDescription,
-  internalCase,
-  classNameCase,
-  getInlineParseContent,
-  getParseContent,
-  getComponentByRef,
-  parseSchema,
-  formatters,
-  checkAndAddNull,
-  isNeedToAddNull,
-  inlineExtraFormatters,
-  formatModelName,
-  fmtToJSDocLine: require("./fmtToJSDocLine"),
-  NameResolver: NameResolver,
-  _: require("lodash"),
-  require: require("./templateRequire").templateRequire,
-};
+const { classNameCase, formatDescription, internalCase } = require("../../common");
+const { getComponentByRef } = require("../../components");
+const { formatModelName } = require("../../modelNames");
+const {
+  getInlineParseContent,
+  getParseContent,
+  parseSchema,
+  checkAndAddNull,
+  isNeedToAddNull,
+} = require("../../schema");
+const { formatters, inlineExtraFormatters } = require("../../typeFormatters");
+const { NameResolver } = require("../../utils/resolveName");
+
+module.exports = {
+  formatDescription,
+  internalCase,
+  classNameCase,
+  getInlineParseContent,
+  getParseContent,
+  getComponentByRef,
+  parseSchema,
+  formatters,
+  checkAndAddNull,
+  isNeedToAddNull,
+  inlineExtraFormatters,
+  formatModelName,
+  fmtToJSDocLine: require("./fmtToJSDocLine"),
+  NameResolver: NameResolver,
+  _: require("lodash"),
+  require: require("./templateRequire").templateRequire,
+};

package/src/render/utils/templateRequire.js

@@ -1,17 +1,17 @@
-const _ = require("lodash");
-const path = require("path");
-const { config } = require("../../config");
-
-const templateRequire = (packageOrPath) => {
-  const isPath = _.startsWith(packageOrPath, "./") || _.startsWith(packageOrPath, "../");
-
-  if (isPath) {
-    return require(path.resolve(config.templates, packageOrPath));
-  }
-
-  return require(packageOrPath);
-};
-
-module.exports = {
-  templateRequire,
-};
+const _ = require("lodash");
+const path = require("path");
+const { config } = require("../../config");
+
+const templateRequire = (packageOrPath) => {
+  const isPath = _.startsWith(packageOrPath, "./") || _.startsWith(packageOrPath, "../");
+
+  if (isPath) {
+    return require(path.resolve(config.templates, packageOrPath));
+  }
+
+  return require(packageOrPath);
+};
+
+module.exports = {
+  templateRequire,
+};

package/src/routeNames.js

@@ -1,46 +1,46 @@
-const { config } = require("./config");
-const { logger } = require("./logger");
-const { renderTemplate } = require("./templates");
-
-const getRouteName = (routeInfo) => {
-  const { moduleName } = routeInfo;
-  const { routeNameDuplicatesMap, templatesToRender } = config;
-  const routeNameTemplate = templatesToRender.routeName;
-
-  const routeNameFromTemplate = renderTemplate(routeNameTemplate, {
-    routeInfo: routeInfo,
-    utils: require("./render/utils"),
-    config,
-  });
-
-  const routeName = config.hooks.onFormatRouteName(routeInfo, routeNameFromTemplate) || routeNameFromTemplate;
-
-  const duplicateIdentifier = `${moduleName}|${routeName}`;
-
-  if (routeNameDuplicatesMap.has(duplicateIdentifier)) {
-    routeNameDuplicatesMap.set(duplicateIdentifier, routeNameDuplicatesMap.get(duplicateIdentifier) + 1);
-
-    logger.warn(
-      `Module "${moduleName}" already has method "${routeName}()"`,
-      `\nThis method has been renamed to "${
-        routeName + routeNameDuplicatesMap.get(duplicateIdentifier)
-      }()" to solve conflict names.`,
-    );
-  } else {
-    routeNameDuplicatesMap.set(duplicateIdentifier, 1);
-  }
-
-  const duplicates = routeNameDuplicatesMap.get(duplicateIdentifier);
-
-  const routeNameInfo = {
-    usage: routeName + (duplicates > 1 ? duplicates : ""),
-    original: routeName,
-    duplicate: duplicates > 1,
-  };
-
-  return config.hooks.onCreateRouteName(routeNameInfo, routeInfo) || routeNameInfo;
-};
-
-module.exports = {
-  getRouteName,
-};
+const { config } = require("./config");
+const { logger } = require("./logger");
+const { renderTemplate } = require("./templates");
+
+const getRouteName = (routeInfo) => {
+  const { moduleName } = routeInfo;
+  const { routeNameDuplicatesMap, templatesToRender } = config;
+  const routeNameTemplate = templatesToRender.routeName;
+
+  const routeNameFromTemplate = renderTemplate(routeNameTemplate, {
+    routeInfo: routeInfo,
+    utils: require("./render/utils"),
+    config,
+  });
+
+  const routeName = config.hooks.onFormatRouteName(routeInfo, routeNameFromTemplate) || routeNameFromTemplate;
+
+  const duplicateIdentifier = `${moduleName}|${routeName}`;
+
+  if (routeNameDuplicatesMap.has(duplicateIdentifier)) {
+    routeNameDuplicatesMap.set(duplicateIdentifier, routeNameDuplicatesMap.get(duplicateIdentifier) + 1);
+
+    logger.warn(
+      `Module "${moduleName}" already has method "${routeName}()"`,
+      `\nThis method has been renamed to "${
+        routeName + routeNameDuplicatesMap.get(duplicateIdentifier)
+      }()" to solve conflict names.`,
+    );
+  } else {
+    routeNameDuplicatesMap.set(duplicateIdentifier, 1);
+  }
+
+  const duplicates = routeNameDuplicatesMap.get(duplicateIdentifier);
+
+  const routeNameInfo = {
+    usage: routeName + (duplicates > 1 ? duplicates : ""),
+    original: routeName,
+    duplicate: duplicates > 1,
+  };
+
+  return config.hooks.onCreateRouteName(routeNameInfo, routeInfo) || routeNameInfo;
+};
+
+module.exports = {
+  getRouteName,
+};

package/src/templates.js

@@ -1,155 +1,155 @@
-const _ = require("lodash");
-const Eta = require("eta");
-const { getFileContent, pathIsExist } = require("./files");
-const { config } = require("./config");
-const { resolve } = require("path");
-const { logger } = require("./logger");
-
-const TEMPLATE_EXTENSIONS = [".eta", ".ejs"];
-
-/**
- * name - project template name,
- * fileName - template file name,
- */
-const TEMPLATE_INFOS = [
-  { name: "api", fileName: "api" },
-  { name: "dataContracts", fileName: "data-contracts" },
-  { name: "dataContractJsDoc", fileName: "data-contract-jsdoc" },
-  { name: "interfaceDataContract", fileName: "interface-data-contract" },
-  { name: "typeDataContract", fileName: "type-data-contract" },
-  { name: "enumDataContract", fileName: "enum-data-contract" },
-  { name: "objectFieldJsDoc", fileName: "object-field-jsdoc" },
-  { name: "httpClient", fileName: "http-client" },
-  { name: "routeTypes", fileName: "route-types" },
-  { name: "routeName", fileName: "route-name" },
-];
-
-const getTemplatePaths = ({ templates, modular }) => {
-  const baseTemplatesPath = resolve(__dirname, "../templates/base");
-  const defaultTemplatesPath = resolve(__dirname, "../templates/default");
-  const modularTemplatesPath = resolve(__dirname, "../templates/modular");
-  const originalTemplatesPath = modular ? modularTemplatesPath : defaultTemplatesPath;
-  const customTemplatesPath = templates ? resolve(process.cwd(), templates) : originalTemplatesPath;
-
-  return {
-    /** `templates/base` */
-    base: baseTemplatesPath,
-    /** `templates/default` */
-    default: defaultTemplatesPath,
-    /** `templates/modular` */
-    modular: modularTemplatesPath,
-    /** usage path if `--templates` option is not set */
-    original: originalTemplatesPath,
-    /** custom path to templates (`--templates`) */
-    custom: customTemplatesPath,
-  };
-};
-
-const cropExtension = (path) =>
-  TEMPLATE_EXTENSIONS.reduce((path, ext) => (_.endsWith(path, ext) ? path.replace(ext, "") : path), path);
-
-const getTemplateFullPath = (path, fileName) => {
-  const raw = resolve(path, "./", cropExtension(fileName));
-  const pathVariants = TEMPLATE_EXTENSIONS.map((extension) => `${raw}${extension}`);
-
-  return pathVariants.find((variant) => !!pathIsExist(variant));
-};
-
-const getTemplate = ({ fileName, name, path }) => {
-  const { templatePaths } = config;
-
-  if (path) {
-    return getFileContent(path);
-  }
-
-  if (!fileName) return "";
-
-  const customFullPath = getTemplateFullPath(templatePaths.custom, fileName);
-  let fileContent = customFullPath && getFileContent(customFullPath);
-
-  if (!fileContent) {
-    const baseFullPath = getTemplateFullPath(templatePaths.base, fileName);
-
-    if (baseFullPath) {
-      fileContent = getFileContent(baseFullPath);
-    } else {
-      logger.warn(
-        `${_.lowerCase(name)} template not found in ${customFullPath}`,
-        `\nCode generator will use the default template`,
-      );
-    }
-
-    const originalFullPath = getTemplateFullPath(templatePaths.original, fileName);
-
-    if (originalFullPath) {
-      fileContent = getFileContent(originalFullPath);
-    }
-  }
-
-  return fileContent;
-};
-
-const getTemplates = ({ templatePaths }) => {
-  logger.log(`try to read templates from directory "${templatePaths.custom}"`);
-
-  const templatesMap = _.reduce(
-    TEMPLATE_INFOS,
-    (acc, { fileName, name }) => ({
-      ...acc,
-      [name]: getTemplate({ fileName, name }),
-    }),
-    {},
-  );
-
-  return templatesMap;
-};
-
-const getTemplateContent = (path) => {
-  const foundTemplatePathKey = _.keys(config.templatePaths).find((key) => _.startsWith(path, `@${key}`));
-
-  const findPathWithExt = (path) => {
-    const raw = cropExtension(path);
-    const pathVariants = TEMPLATE_EXTENSIONS.map((extension) => `${raw}${extension}`);
-    return pathVariants.find((variant) => pathIsExist(variant));
-  };
-
-  const rawPath = resolve(_.replace(path, `@${foundTemplatePathKey}`, config.templatePaths[foundTemplatePathKey]));
-  const fixedPath = findPathWithExt(rawPath);
-
-  if (fixedPath) {
-    return getFileContent(fixedPath);
-  }
-
-  const customPath = findPathWithExt(resolve(config.templatePaths.custom, path));
-
-  if (customPath) {
-    return getFileContent(customPath);
-  }
-
-  const originalPath = findPathWithExt(resolve(config.templatePaths.original, path));
-
-  if (originalPath) {
-    return getFileContent(originalPath);
-  }
-
-  return "";
-};
-
-const renderTemplate = (template, configuration, options) => {
-  if (!template) return "";
-
-  return Eta.render(template, configuration, {
-    async: false,
-    ...(options || {}),
-    includeFile: (path, payload, options) => {
-      return renderTemplate(getTemplateContent(path), payload, options);
-    },
-  });
-};
-
-module.exports = {
-  getTemplate,
-  getTemplates,
-  getTemplatePaths,
-  renderTemplate,
-};
+const _ = require("lodash");
+const Eta = require("eta");
+const { getFileContent, pathIsExist } = require("./files");
+const { config } = require("./config");
+const { resolve } = require("path");
+const { logger } = require("./logger");
+
+const TEMPLATE_EXTENSIONS = [".eta", ".ejs"];
+
+/**
+ * name - project template name,
+ * fileName - template file name,
+ */
+const TEMPLATE_INFOS = [
+  { name: "api", fileName: "api" },
+  { name: "dataContracts", fileName: "data-contracts" },
+  { name: "dataContractJsDoc", fileName: "data-contract-jsdoc" },
+  { name: "interfaceDataContract", fileName: "interface-data-contract" },
+  { name: "typeDataContract", fileName: "type-data-contract" },
+  { name: "enumDataContract", fileName: "enum-data-contract" },
+  { name: "objectFieldJsDoc", fileName: "object-field-jsdoc" },
+  { name: "httpClient", fileName: "http-client" },
+  { name: "routeTypes", fileName: "route-types" },
+  { name: "routeName", fileName: "route-name" },
+];
+
+const getTemplatePaths = ({ templates, modular }) => {
+  const baseTemplatesPath = resolve(__dirname, "../templates/base");
+  const defaultTemplatesPath = resolve(__dirname, "../templates/default");
+  const modularTemplatesPath = resolve(__dirname, "../templates/modular");
+  const originalTemplatesPath = modular ? modularTemplatesPath : defaultTemplatesPath;
+  const customTemplatesPath = templates ? resolve(process.cwd(), templates) : originalTemplatesPath;
+
+  return {
+    /** `templates/base` */
+    base: baseTemplatesPath,
+    /** `templates/default` */
+    default: defaultTemplatesPath,
+    /** `templates/modular` */
+    modular: modularTemplatesPath,
+    /** usage path if `--templates` option is not set */
+    original: originalTemplatesPath,
+    /** custom path to templates (`--templates`) */
+    custom: customTemplatesPath,
+  };
+};
+
+const cropExtension = (path) =>
+  TEMPLATE_EXTENSIONS.reduce((path, ext) => (_.endsWith(path, ext) ? path.replace(ext, "") : path), path);
+
+const getTemplateFullPath = (path, fileName) => {
+  const raw = resolve(path, "./", cropExtension(fileName));
+  const pathVariants = TEMPLATE_EXTENSIONS.map((extension) => `${raw}${extension}`);
+
+  return pathVariants.find((variant) => !!pathIsExist(variant));
+};
+
+const getTemplate = ({ fileName, name, path }) => {
+  const { templatePaths } = config;
+
+  if (path) {
+    return getFileContent(path);
+  }
+
+  if (!fileName) return "";
+
+  const customFullPath = getTemplateFullPath(templatePaths.custom, fileName);
+  let fileContent = customFullPath && getFileContent(customFullPath);
+
+  if (!fileContent) {
+    const baseFullPath = getTemplateFullPath(templatePaths.base, fileName);
+
+    if (baseFullPath) {
+      fileContent = getFileContent(baseFullPath);
+    } else {
+      logger.warn(
+        `${_.lowerCase(name)} template not found in ${customFullPath}`,
+        `\nCode generator will use the default template`,
+      );
+    }
+
+    const originalFullPath = getTemplateFullPath(templatePaths.original, fileName);
+
+    if (originalFullPath) {
+      fileContent = getFileContent(originalFullPath);
+    }
+  }
+
+  return fileContent;
+};
+
+const getTemplates = ({ templatePaths }) => {
+  logger.log(`try to read templates from directory "${templatePaths.custom}"`);
+
+  const templatesMap = _.reduce(
+    TEMPLATE_INFOS,
+    (acc, { fileName, name }) => ({
+      ...acc,
+      [name]: getTemplate({ fileName, name }),
+    }),
+    {},
+  );
+
+  return templatesMap;
+};
+
+const getTemplateContent = (path) => {
+  const foundTemplatePathKey = _.keys(config.templatePaths).find((key) => _.startsWith(path, `@${key}`));
+
+  const findPathWithExt = (path) => {
+    const raw = cropExtension(path);
+    const pathVariants = TEMPLATE_EXTENSIONS.map((extension) => `${raw}${extension}`);
+    return pathVariants.find((variant) => pathIsExist(variant));
+  };
+
+  const rawPath = resolve(_.replace(path, `@${foundTemplatePathKey}`, config.templatePaths[foundTemplatePathKey]));
+  const fixedPath = findPathWithExt(rawPath);
+
+  if (fixedPath) {
+    return getFileContent(fixedPath);
+  }
+
+  const customPath = findPathWithExt(resolve(config.templatePaths.custom, path));
+
+  if (customPath) {
+    return getFileContent(customPath);
+  }
+
+  const originalPath = findPathWithExt(resolve(config.templatePaths.original, path));
+
+  if (originalPath) {
+    return getFileContent(originalPath);
+  }
+
+  return "";
+};
+
+const renderTemplate = (template, configuration, options) => {
+  if (!template) return "";
+
+  return Eta.render(template, configuration, {
+    async: false,
+    ...(options || {}),
+    includeFile: (path, payload, options) => {
+      return renderTemplate(getTemplateContent(path), payload, options);
+    },
+  });
+};
+
+module.exports = {
+  getTemplate,
+  getTemplates,
+  getTemplatePaths,
+  renderTemplate,
+};

package/src/translators/JavaScript.js

@@ -1,60 +1,49 @@
-const ts = require("typescript");
-
-function translate(fileName, content, options) {
-  const output = {};
-  const host = ts.createCompilerHost(options, true);
-  const fileNames = [fileName];
-  const originalSourceFileGet = host.getSourceFile.bind(host);
-  host.getSourceFile = (sourceFileName, languageVersion, onError, shouldCreateNewSourceFile) => {
-    if (sourceFileName !== fileName)
-      return originalSourceFileGet(
-        sourceFileName,
-        languageVersion,
-        onError,
-        shouldCreateNewSourceFile,
-      );
-
-    return ts.createSourceFile(
-      sourceFileName,
-      content,
-      languageVersion,
-      true,
-      ts.ScriptKind.External,
-    );
-  };
-
-  host.writeFile = (fileName, contents) => {
-    output[fileName] = contents;
-  };
-
-  ts.createProgram(fileNames, options, host).emit();
-
-  return output;
-}
-
-module.exports = {
-  translate: (fileName, sourceTypeScript) => {
-    const translated = translate(fileName, sourceTypeScript, {
-      module: "ESNext",
-      noImplicitReturns: true,
-      alwaysStrict: true,
-      target: ts.ScriptTarget.ESNext,
-      declaration: true,
-      noImplicitAny: false,
-      sourceMap: false,
-      removeComments: false,
-      disableSizeLimit: true,
-      esModuleInterop: true,
-      emitDecoratorMetadata: true,
-      skipLibCheck: true,
-    });
-
-    const sourceFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Js);
-    const declarationFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Dts);
-
-    return {
-      sourceContent: translated[sourceFileName],
-      declarationContent: translated[declarationFileName],
-    };
-  },
-};
+const ts = require("typescript");
+
+function translate(fileName, content, options) {
+  const output = {};
+  const host = ts.createCompilerHost(options, true);
+  const fileNames = [fileName];
+  const originalSourceFileGet = host.getSourceFile.bind(host);
+  host.getSourceFile = (sourceFileName, languageVersion, onError, shouldCreateNewSourceFile) => {
+    if (sourceFileName !== fileName)
+      return originalSourceFileGet(sourceFileName, languageVersion, onError, shouldCreateNewSourceFile);
+
+    return ts.createSourceFile(sourceFileName, content, languageVersion, true, ts.ScriptKind.External);
+  };
+
+  host.writeFile = (fileName, contents) => {
+    output[fileName] = contents;
+  };
+
+  ts.createProgram(fileNames, options, host).emit();
+
+  return output;
+}
+
+module.exports = {
+  translate: (fileName, sourceTypeScript) => {
+    const translated = translate(fileName, sourceTypeScript, {
+      module: "ESNext",
+      noImplicitReturns: true,
+      alwaysStrict: true,
+      target: ts.ScriptTarget.ESNext,
+      declaration: true,
+      noImplicitAny: false,
+      sourceMap: false,
+      removeComments: false,
+      disableSizeLimit: true,
+      esModuleInterop: true,
+      emitDecoratorMetadata: true,
+      skipLibCheck: true,
+    });
+
+    const sourceFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Js);
+    const declarationFileName = fileName.replace(ts.Extension.Ts, ts.Extension.Dts);
+
+    return {
+      sourceContent: translated[sourceFileName],
+      declarationContent: translated[declarationFileName],
+    };
+  },
+};