swagger-typescript-api 10.0.0 → 10.0.2

package/src/modelNames.js

@@ -1,78 +1,78 @@
-const _ = require("lodash");
-const { config } = require("./config");
-const { logger } = require("./logger");
-
-const isValidName = (name) => /^([A-Za-z$_]{1,})$/g.test(name);
-
-const formattedModelNamesMap = new Map();
-
-const fixModelName = (name) => {
-  if (!isValidName(name)) {
-    if (!/^[a-zA-Z_$]/g.test(name)) {
-      name = `Type ${name}`;
-    }
-
-    // specific replaces for TSOA 3.x
-    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(/__+$/, "");
-
-    if (name.includes("-")) name = _.startCase(name).replace(/ /g, "");
-  }
-
-  return name;
-};
-
-/**
- *
- * @param {string} name
- * @param {{ ignorePrefix?: boolean; ignoreSuffix?: boolean }} options
- * @returns
- */
-const formatModelName = (name, options) => {
-  const typePrefix = options && options.ignorePrefix ? "" : config.typePrefix;
-  const typeSuffix = options && options.ignoreSuffix ? "" : config.typeSuffix;
-  const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
-
-  if (typeof name !== "string") {
-    logger.warn("wrong name of the model name", name);
-    return name;
-  }
-
-  if (/^([A-Z_]{1,})$/g.test(name)) {
-    return _.compact([typePrefix, name, typeSuffix]).join("_");
-  }
-
-  if (formattedModelNamesMap.has(hashKey)) {
-    return formattedModelNamesMap.get(hashKey);
-  }
-
-  const fixedModelName = fixModelName(name);
-
-  const formattedModelName = _.replace(
-    _.startCase(`${typePrefix}_${fixedModelName}_${typeSuffix}`),
-    /\s/g,
-    "",
-  );
-  const modelName = config.hooks.onFormatTypeName(formattedModelName, name) || formattedModelName;
-
-  formattedModelNamesMap.set(hashKey, modelName);
-
-  return modelName;
-};
-
-const formatEnumKey = (key) =>
-  formatModelName(key, {
-    ignorePrefix: true,
-    ignoreSuffix: true,
-  });
-
-module.exports = {
-  formatModelName: formatModelName,
-  formatEnumKey: formatEnumKey,
-  isValidName,
-};
+const _ = require("lodash");
+const { config } = require("./config");
+const { logger } = require("./logger");
+
+const isValidName = (name) => /^([A-Za-z$_]{1,})$/g.test(name);
+
+const formattedModelNamesMap = new Map();
+
+const fixModelName = (name) => {
+  if (!isValidName(name)) {
+    if (!/^[a-zA-Z_$]/g.test(name)) {
+      name = `Type ${name}`;
+    }
+
+    // specific replaces for TSOA 3.x
+    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(/__+$/, "");
+
+    if (name.includes("-")) name = _.startCase(name).replace(/ /g, "");
+  }
+
+  return name;
+};
+
+/**
+ *
+ * @param {string} name
+ * @param {{ ignorePrefix?: boolean; ignoreSuffix?: boolean }} options
+ * @returns
+ */
+const formatModelName = (name, options) => {
+  const typePrefix = options && options.ignorePrefix ? "" : config.typePrefix;
+  const typeSuffix = options && options.ignoreSuffix ? "" : config.typeSuffix;
+  const hashKey = `${typePrefix}_${name}_${typeSuffix}`;
+
+  if (typeof name !== "string") {
+    logger.warn("wrong name of the model name", name);
+    return name;
+  }
+
+  if (/^([A-Z_]{1,})$/g.test(name)) {
+    return _.compact([typePrefix, name, typeSuffix]).join("_");
+  }
+
+  if (formattedModelNamesMap.has(hashKey)) {
+    return formattedModelNamesMap.get(hashKey);
+  }
+
+  const fixedModelName = fixModelName(name);
+
+  const formattedModelName = _.replace(
+    _.startCase(`${typePrefix}_${fixedModelName}_${typeSuffix}`),
+    /\s/g,
+    "",
+  );
+  const modelName = config.hooks.onFormatTypeName(formattedModelName, name) || formattedModelName;
+
+  formattedModelNamesMap.set(hashKey, modelName);
+
+  return modelName;
+};
+
+const formatEnumKey = (key) =>
+  formatModelName(key, {
+    ignorePrefix: true,
+    ignoreSuffix: true,
+  });
+
+module.exports = {
+  formatModelName: formatModelName,
+  formatEnumKey: formatEnumKey,
+  isValidName,
+};

package/src/modelTypes.js

@@ -1,30 +1,31 @@
-const { formatters } = require("./typeFormatters");
-const { formatModelName } = require("./modelNames");
-const { config } = require("./config");
-const { getTypeData } = require("./components");
-
-/**
- *
- * @param {import("./components").TypeInfo} typeInfo
- * @returns
- */
-const prepareModelType = (typeInfo) => {
-  const typeData = getTypeData(typeInfo);
-  let { typeIdentifier, name: originalName, content, type, description } = typeData;
-
-  const resultContent = formatters[type] ? formatters[type](content) : content;
-  const name = formatModelName(originalName);
-
-  return {
-    typeIdentifier,
-    name,
-    description,
-    rawContent: content,
-    content: resultContent,
-    typeData,
-  };
-};
-
-module.exports = {
-  prepareModelType,
-};
+const { formatters } = require("./typeFormatters");
+const { formatModelName } = require("./modelNames");
+const { config } = require("./config");
+const { getTypeData } = require("./components");
+
+/**
+ *
+ * @param {import("./components").TypeInfo} typeInfo
+ * @returns
+ */
+const prepareModelType = (typeInfo) => {
+  const rawTypeData = getTypeData(typeInfo);
+  const typeData = formatters[rawTypeData.type] ? formatters[rawTypeData.type](rawTypeData) : rawTypeData;
+  let { typeIdentifier, name: originalName, content, description } = typeData;
+  const name = formatModelName(originalName);
+
+  return {
+    ...typeData,
+    typeIdentifier,
+    name,
+    description,
+    $content: rawTypeData.content,
+    rawContent: rawTypeData.content,
+    content: content,
+    typeData,
+  };
+};
+
+module.exports = {
+  prepareModelType,
+};

package/src/output.js

@@ -1,166 +1,165 @@
-const _ = require("lodash");
-const { getFileContent } = require("./files");
-const { classNameCase } = require("./render/utils");
-const { renderTemplate } = require("./templates");
-const { translate: translateToJS } = require("./translators/JavaScript");
-const ts = require("typescript");
-const formatFileContent = require("./formatFileContent");
-
-const getFileNameWithoutExt = (fileName) => {
-  const fileNameParts = _.split(fileName, ".");
-
-  if (fileNameParts.length > 1) {
-    fileNameParts.pop();
-  }
-
-  return fileNameParts.join(".");
-};
-
-const createFileInfo = (configuration, fileName, content) => {
-  const fixedFileName = getFileNameWithoutExt(fileName);
-
-  if (configuration.translateToJavaScript) {
-    const { sourceContent, declarationContent } = translateToJS(
-      `${fixedFileName}${ts.Extension.Ts}`,
-      content,
-    );
-
-    return {
-      name: `${fixedFileName}${ts.Extension.Js}`,
-      content: formatFileContent(sourceContent),
-      declaration: {
-        name: `${fixedFileName}${ts.Extension.Dts}`,
-        content: formatFileContent(declarationContent),
-      },
-    };
-  }
-
-  return {
-    name: `${fixedFileName}${ts.Extension.Ts}`,
-    content: formatFileContent(content),
-    declaration: null,
-  };
-};
-
-const createMultipleFileInfos = (templatesToRender, configuration) => {
-  const { routes } = configuration;
-  const { fileNames, generateRouteTypes, generateClient } = configuration.config;
-  const modularApiFileInfos = [];
-
-  if (routes.$outOfModule) {
-    if (generateRouteTypes) {
-      const outOfModuleRouteContent = renderTemplate(templatesToRender.routeTypes, {
-        ...configuration,
-        route: configuration.routes.$outOfModule,
-      });
-
-      modularApiFileInfos.push(
-        createFileInfo(configuration, fileNames.outOfModuleApi, outOfModuleRouteContent),
-      );
-    }
-    if (generateClient) {
-      const outOfModuleApiContent = renderTemplate(templatesToRender.api, {
-        ...configuration,
-        route: configuration.routes.$outOfModule,
-      });
-
-      modularApiFileInfos.push(
-        createFileInfo(configuration, fileNames.outOfModuleApi, outOfModuleApiContent),
-      );
-    }
-  }
-
-  if (routes.combined) {
-    modularApiFileInfos.push(
-      ..._.reduce(
-        routes.combined,
-        (apiFileInfos, route) => {
-          if (generateRouteTypes) {
-            const routeModuleContent = renderTemplate(templatesToRender.routeTypes, {
-              ...configuration,
-              route,
-            });
-
-            apiFileInfos.push(
-              createFileInfo(
-                configuration,
-                classNameCase(`${route.moduleName}_Route`),
-                routeModuleContent,
-              ),
-            );
-          }
-
-          if (generateClient) {
-            const apiModuleContent = renderTemplate(templatesToRender.api, {
-              ...configuration,
-              route,
-            });
-
-            apiFileInfos.push(
-              createFileInfo(configuration, classNameCase(route.moduleName), apiModuleContent),
-            );
-          }
-
-          return apiFileInfos;
-        },
-        [],
-      ),
-    );
-  }
-
-  return [
-    createFileInfo(
-      configuration,
-      fileNames.dataContracts,
-      renderTemplate(templatesToRender.dataContracts, configuration),
-    ),
-    generateClient &&
-      createFileInfo(
-        configuration,
-        fileNames.httpClient,
-        renderTemplate(templatesToRender.httpClient, configuration),
-      ),
-    ...modularApiFileInfos,
-  ];
-};
-
-const createSingleFileInfo = (templatesToRender, configuration) => {
-  const { generateRouteTypes, generateClient } = configuration.config;
-
-  return [
-    createFileInfo(
-      configuration,
-      configuration.fileName,
-      _.compact([
-        renderTemplate(templatesToRender.dataContracts, configuration),
-        generateRouteTypes && renderTemplate(templatesToRender.routeTypes, configuration),
-        generateClient && renderTemplate(templatesToRender.httpClient, configuration),
-        generateClient && renderTemplate(templatesToRender.api, configuration),
-      ]).join("\n"),
-    ),
-  ];
-};
-
-const createExtraFileInfos = (configuration) => {
-  return _.map(configuration.extraTemplates, (extraTemplate) => {
-    return createFileInfo(
-      configuration,
-      extraTemplate.name,
-      renderTemplate(getFileContent(extraTemplate.path), configuration),
-    );
-  });
-};
-
-module.exports = {
-  generateOutputFiles: ({ modular, templatesToRender, configuration }) => {
-    const output = modular
-      ? createMultipleFileInfos(templatesToRender, configuration)
-      : createSingleFileInfo(templatesToRender, configuration);
-
-    if (!_.isEmpty(configuration.extraTemplates)) {
-      output.push(...createExtraFileInfos(configuration));
-    }
-
-    return output.filter((fileInfo) => !!fileInfo && !!fileInfo.content);
-  },
-};
+const _ = require("lodash");
+const { getFileContent } = require("./files");
+const { classNameCase } = require("./render/utils");
+const { renderTemplate } = require("./templates");
+const { translate: translateToJS } = require("./translators/JavaScript");
+const ts = require("typescript");
+const formatFileContent = require("./formatFileContent");
+const { config } = require("./config");
+
+const getFileNameWithoutExt = (fileName) => {
+  const fileNameParts = _.split(fileName, ".");
+
+  if (fileNameParts.length > 1) {
+    fileNameParts.pop();
+  }
+
+  return fileNameParts.join(".");
+};
+
+const createFileInfo = (configuration, fileName, content) => {
+  const fixedFileName = getFileNameWithoutExt(fileName);
+
+  if (configuration.translateToJavaScript) {
+    const { sourceContent, declarationContent } = translateToJS(`${fixedFileName}${ts.Extension.Ts}`, content);
+
+    if (config.debug) {
+      console.info("generating output for", `${fixedFileName}${ts.Extension.Js}`);
+      console.info(sourceContent);
+    }
+
+    if (config.debug) {
+      console.info("generating output for", `${fixedFileName}${ts.Extension.Dts}`);
+      console.info(declarationContent);
+    }
+
+    return {
+      name: `${fixedFileName}${ts.Extension.Js}`,
+      content: formatFileContent(sourceContent),
+      declaration: {
+        name: `${fixedFileName}${ts.Extension.Dts}`,
+        content: formatFileContent(declarationContent),
+      },
+    };
+  }
+
+  if (config.debug) {
+    console.info("generating output for", `${fixedFileName}${ts.Extension.Ts}`);
+    console.info(content);
+  }
+
+  return {
+    name: `${fixedFileName}${ts.Extension.Ts}`,
+    content: formatFileContent(content),
+    declaration: null,
+  };
+};
+
+const createMultipleFileInfos = (templatesToRender, configuration) => {
+  const { routes } = configuration;
+  const { fileNames, generateRouteTypes, generateClient } = configuration.config;
+  const modularApiFileInfos = [];
+
+  if (routes.$outOfModule) {
+    if (generateRouteTypes) {
+      const outOfModuleRouteContent = renderTemplate(templatesToRender.routeTypes, {
+        ...configuration,
+        route: configuration.routes.$outOfModule,
+      });
+
+      modularApiFileInfos.push(createFileInfo(configuration, fileNames.outOfModuleApi, outOfModuleRouteContent));
+    }
+    if (generateClient) {
+      const outOfModuleApiContent = renderTemplate(templatesToRender.api, {
+        ...configuration,
+        route: configuration.routes.$outOfModule,
+      });
+
+      modularApiFileInfos.push(createFileInfo(configuration, fileNames.outOfModuleApi, outOfModuleApiContent));
+    }
+  }
+
+  if (routes.combined) {
+    modularApiFileInfos.push(
+      ..._.reduce(
+        routes.combined,
+        (apiFileInfos, route) => {
+          if (generateRouteTypes) {
+            const routeModuleContent = renderTemplate(templatesToRender.routeTypes, {
+              ...configuration,
+              route,
+            });
+
+            apiFileInfos.push(
+              createFileInfo(configuration, classNameCase(`${route.moduleName}_Route`), routeModuleContent),
+            );
+          }
+
+          if (generateClient) {
+            const apiModuleContent = renderTemplate(templatesToRender.api, {
+              ...configuration,
+              route,
+            });
+
+            apiFileInfos.push(createFileInfo(configuration, classNameCase(route.moduleName), apiModuleContent));
+          }
+
+          return apiFileInfos;
+        },
+        [],
+      ),
+    );
+  }
+
+  return [
+    createFileInfo(
+      configuration,
+      fileNames.dataContracts,
+      renderTemplate(templatesToRender.dataContracts, configuration),
+    ),
+    generateClient &&
+      createFileInfo(configuration, fileNames.httpClient, renderTemplate(templatesToRender.httpClient, configuration)),
+    ...modularApiFileInfos,
+  ];
+};
+
+const createSingleFileInfo = (templatesToRender, configuration) => {
+  const { generateRouteTypes, generateClient } = configuration.config;
+
+  return [
+    createFileInfo(
+      configuration,
+      configuration.fileName,
+      _.compact([
+        renderTemplate(templatesToRender.dataContracts, configuration),
+        generateRouteTypes && renderTemplate(templatesToRender.routeTypes, configuration),
+        generateClient && renderTemplate(templatesToRender.httpClient, configuration),
+        generateClient && renderTemplate(templatesToRender.api, configuration),
+      ]).join("\n"),
+    ),
+  ];
+};
+
+const createExtraFileInfos = (configuration) => {
+  return _.map(configuration.extraTemplates, (extraTemplate) => {
+    return createFileInfo(
+      configuration,
+      extraTemplate.name,
+      renderTemplate(getFileContent(extraTemplate.path), configuration),
+    );
+  });
+};
+
+module.exports = {
+  generateOutputFiles: ({ modular, templatesToRender, configuration }) => {
+    const output = modular
+      ? createMultipleFileInfos(templatesToRender, configuration)
+      : createSingleFileInfo(templatesToRender, configuration);
+
+    if (!_.isEmpty(configuration.extraTemplates)) {
+      output.push(...createExtraFileInfos(configuration));
+    }
+
+    return output.filter((fileInfo) => !!fileInfo && !!fileInfo.content);
+  },
+};

package/src/prettierOptions.js

@@ -1,23 +1,23 @@
-const { cosmiconfigSync } = require("cosmiconfig");
-const constants = require("./constants");
-
-/**
- * Get prettier options from user's project or return the default one
- * @return {import('prettier').Options} Prettier options
- */
-function getPrettierOptions() {
-  const prettier = cosmiconfigSync("prettier").search();
-
-  if (prettier) {
-    return {
-      ...prettier.config,
-      parser: "typescript",
-    };
-  }
-
-  return constants.PRETTIER_OPTIONS;
-}
-
-module.exports = {
-  getPrettierOptions,
-};
+const { cosmiconfigSync } = require("cosmiconfig");
+const constants = require("./constants");
+
+/**
+ * Get prettier options from user's project or return the default one
+ * @return {import('prettier').Options} Prettier options
+ */
+function getPrettierOptions() {
+  const prettier = cosmiconfigSync("prettier").search();
+
+  if (prettier) {
+    return {
+      ...prettier.config,
+      parser: "typescript",
+    };
+  }
+
+  return constants.PRETTIER_OPTIONS;
+}
+
+module.exports = {
+  getPrettierOptions,
+};

package/src/render/utils/fmtToJSDocLine.js

@@ -1,10 +1,10 @@
-/**
- * Format a line in JSDOC line by adding ' *' at the beginning and \n character at the end
- *
- * @example 'abc' -> ' * abc\n'
- * @param line
- * @return {string}
- */
-module.exports = function fmtToJSDocLine(line, { eol = true }) {
-  return ` * ${line}${eol ? "\n" : ""}`;
-};
+/**
+ * Format a line in JSDOC line by adding ' *' at the beginning and \n character at the end
+ *
+ * @example 'abc' -> ' * abc\n'
+ * @param line
+ * @return {string}
+ */
+module.exports = function fmtToJSDocLine(line, { eol = true }) {
+  return ` * ${line}${eol ? "\n" : ""}`;
+};