swagger-typescript-api 10.0.3 → 11.0.0--alpha

package/src/files.js

@@ -1,56 +0,0 @@
-const _ = require("lodash");
-const fs = require("fs");
-const { resolve } = require("path");
-const { filePrefix } = require("./filePrefix");
-const makeDir = require("make-dir");
-
-const getFileContent = (path) => {
-  return fs.readFileSync(path, { encoding: "UTF-8" });
-};
-
-const pathIsDir = (path) => {
-  if (!path) return false;
-
-  try {
-    const stat = fs.statSync(path);
-    return stat.isDirectory();
-  } catch (e) {
-    return false;
-  }
-};
-
-const removeDir = (path) => {
-  try {
-    if (typeof fs.rmSync === "function") {
-      fs.rmSync(path, { recursive: true });
-    } else {
-      fs.rmdirSync(path, { recursive: true });
-    }
-  } catch (e) {}
-};
-
-const createDir = (path) => {
-  try {
-    makeDir.sync(path);
-  } catch (e) {}
-};
-
-const cleanDir = (path) => {
-  removeDir(path);
-  createDir(path);
-};
-
-const pathIsExist = (path) => path && fs.existsSync(path);
-
-const createFile = ({ path, fileName, content, withPrefix }) =>
-  fs.writeFileSync(resolve(__dirname, path, `./${fileName}`), `${withPrefix ? filePrefix : ""}${content}`, _.noop);
-
-module.exports = {
-  createFile,
-  pathIsDir,
-  cleanDir,
-  pathIsExist,
-  createDir,
-  removeDir,
-  getFileContent,
-};

package/src/formatFileContent.js

@@ -1,81 +0,0 @@
-const _ = require("lodash");
-const prettier = require("prettier");
-const { config } = require("./config");
-const ts = require("typescript");
-
-class LanguageServiceHost {
-  constructor(fileName, content) {
-    const tsconfig = ts.findConfigFile(fileName, ts.sys.fileExists);
-
-    Object.assign(this, {
-      fileName,
-      content,
-      compilerOptions: tsconfig
-        ? ts.convertCompilerOptionsFromJson(ts.readConfigFile(tsconfig, ts.sys.readFile).config.compilerOptions).options
-        : ts.getDefaultCompilerOptions(),
-    });
-  }
-
-  getNewLine() {
-    return "newLine" in ts.sys ? ts.sys.newLine : "\n";
-  }
-  getScriptFileNames() {
-    return [this.fileName];
-  }
-  getCompilationSettings() {
-    return this.compilerOptions;
-  }
-  getDefaultLibFileName() {
-    return ts.getDefaultLibFileName(this.getCompilationSettings());
-  }
-  getCurrentDirectory() {
-    return process.cwd();
-  }
-  getScriptVersion() {
-    return ts.version;
-  }
-  getScriptSnapshot() {
-    return ts.ScriptSnapshot.fromString(this.content);
-  }
-  readFile(fileName, encoding) {
-    if (fileName === this.fileName) {
-      return this.content;
-    }
-
-    return ts.sys.readFile(fileName, encoding);
-  }
-  fileExists(path) {
-    return ts.sys.fileExists(path);
-  }
-}
-
-const removeUnusedImports = (content) => {
-  const tempFileName = "file.ts";
-
-  const host = new LanguageServiceHost(tempFileName, content);
-  const languageService = ts.createLanguageService(host);
-
-  const fileTextChanges = languageService.organizeImports(
-    { type: "file", fileName: tempFileName },
-    { newLineCharacter: ts.sys.newLine },
-  )[0];
-
-  if (fileTextChanges && fileTextChanges.textChanges.length) {
-    return _.reduceRight(
-      fileTextChanges.textChanges,
-      (content, { span, newText }) =>
-        `${content.slice(0, span.start)}${newText}${content.slice(span.start + span.length)}`,
-      content,
-    );
-  }
-
-  return content;
-};
-
-const prettierFormat = (content) => {
-  return prettier.format(content, config.prettierOptions);
-};
-
-const formatters = [removeUnusedImports, prettierFormat];
-
-module.exports = (content) => formatters.reduce((fixedContent, formatter) => formatter(fixedContent), content);

package/src/logger.js

@@ -1,68 +0,0 @@
-const _ = require("lodash");
-const { config } = require("./config");
-const { emojify, emoji } = require("node-emoji");
-
-let firstLog = true;
-
-/**
- *
- * @param {{ type: "warn" | "log" | "error", emojiName: keyof emoji, messages: unknown[] }} payload
- * @returns {void}
- */
-const createLogMessage = ({ type, emojiName, messages }) => {
-  if (config.silent) return;
-
-  const emoji = emojify(emojiName);
-
-  if (firstLog) {
-    firstLog = false;
-    logger.log(
-      `swagger-typescript-api(${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,
-    ),
-  );
-};
-
-const logger = {
-  log: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":sparkles:",
-      messages,
-    }),
-  event: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":comet: ",
-      messages,
-    }),
-  success: (...messages) =>
-    createLogMessage({
-      type: "log",
-      emojiName: ":white_check_mark:",
-      messages,
-    }),
-  warn: (...messages) =>
-    createLogMessage({
-      type: "warn",
-      emojiName: ":warning: ",
-      messages,
-    }),
-  error: (...messages) =>
-    createLogMessage({
-      type: "error",
-      emojiName: ":exclamation:",
-      messages,
-    }),
-};
-
-module.exports = {
-  logger,
-};

package/src/modelNames.js

@@ -1,74 +0,0 @@
-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,31 +0,0 @@
-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,165 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-/**
- * 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" : ""}`;
-};

package/src/render/utils/index.js

@@ -1,31 +0,0 @@
-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 +0,0 @@
-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 +0,0 @@
-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,
-};