swagger-typescript-api 10.0.2 → 11.0.0--alpha

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,106 +0,0 @@
-const { HTTP_CLIENT, TS_KEYWORDS, PRETTIER_OPTIONS } = require("./constants");
-const { NameResolver } = require("./utils/resolveName");
-
-const config = {
-  /** 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 ##
- * ---------------------------------------------------------------
- */
-
-`,
-};

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,59 +0,0 @@
-const _ = require("lodash");
-const { config } = require("./config");
-const { emojify, emoji } = require("node-emoji");
-
-/**
- *
- * @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);
-
-  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,78 +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,
-};