swagger-typescript-api 13.0.3 → 13.0.4

package/src/schema-routes/schema-routes.js

@@ -1,24 +1,24 @@
-const _ = require('lodash');
-const { generateId } = require('../util/id.js');
+const _ = require("lodash");
+const { generateId } = require("../util/id.js");
 const {
   SpecificArgNameResolver,
-} = require('./util/specific-arg-name-resolver');
+} = require("./util/specific-arg-name-resolver");
 const {
   DEFAULT_BODY_ARG_NAME,
   RESERVED_BODY_ARG_NAMES,
   RESERVED_HEADER_ARG_NAMES,
   RESERVED_PATH_ARG_NAMES,
   RESERVED_QUERY_ARG_NAMES,
-} = require('../constants.js');
-const { camelCase } = require('lodash');
+} = require("../constants.js");
+const { camelCase } = require("lodash");
 
 const CONTENT_KIND = {
-  JSON: 'JSON',
-  URL_ENCODED: 'URL_ENCODED',
-  FORM_DATA: 'FORM_DATA',
-  IMAGE: 'IMAGE',
-  OTHER: 'OTHER',
-  TEXT: 'TEXT',
+  JSON: "JSON",
+  URL_ENCODED: "URL_ENCODED",
+  FORM_DATA: "FORM_DATA",
+  IMAGE: "IMAGE",
+  OTHER: "OTHER",
+  TEXT: "TEXT",
 };
 
 class SchemaRoutes {
@@ -75,20 +75,20 @@ class SchemaRoutes {
     this.templatesWorker = templatesWorker;
 
     this.FORM_DATA_TYPES = _.uniq([
-      this.schemaUtils.getSchemaType({ type: 'string', format: 'file' }),
-      this.schemaUtils.getSchemaType({ type: 'string', format: 'binary' }),
+      this.schemaUtils.getSchemaType({ type: "string", format: "file" }),
+      this.schemaUtils.getSchemaType({ type: "string", format: "binary" }),
     ]);
   }
 
   createRequestsMap = (routeInfoByMethodsMap) => {
-    const parameters = _.get(routeInfoByMethodsMap, 'parameters');
+    const parameters = _.get(routeInfoByMethodsMap, "parameters");
 
     return _.reduce(
       routeInfoByMethodsMap,
       (acc, requestInfo, method) => {
         if (
-          _.startsWith(method, 'x-') ||
-          ['parameters', '$ref'].includes(method)
+          _.startsWith(method, "x-") ||
+          ["parameters", "$ref"].includes(method)
         ) {
           return acc;
         }
@@ -109,7 +109,7 @@ class SchemaRoutes {
       this.config.hooks.onPreBuildRoutePath(originalRouteName) ||
       originalRouteName;
 
-    const pathParamMatches = (routeName || '').match(
+    const pathParamMatches = (routeName || "").match(
       /({(([A-z]){1}([a-zA-Z0-9]-?_?\.?)+)([0-9]+)?})|(:(([A-z]){1}([a-zA-Z0-9]-?_?\.?)+)([0-9]+)?:?)/g,
     );
 
@@ -117,24 +117,24 @@ class SchemaRoutes {
     const pathParams = _.reduce(
       pathParamMatches,
       (pathParams, match) => {
-        const paramName = _.replace(match, /\{|\}|:/g, '');
+        const paramName = _.replace(match, /\{|\}|:/g, "");
 
         if (!paramName) return pathParams;
 
-        if (_.includes(paramName, '-')) {
-          this.logger.warn('wrong path param name', paramName);
+        if (_.includes(paramName, "-")) {
+          this.logger.warn("wrong path param name", paramName);
         }
 
         pathParams.push({
           $match: match,
           name: _.camelCase(paramName),
           required: true,
-          type: 'string',
-          description: '',
+          type: "string",
+          description: "",
           schema: {
-            type: 'string',
+            type: "string",
           },
-          in: 'path',
+          in: "path",
         });
 
         return pathParams;
@@ -154,7 +154,7 @@ class SchemaRoutes {
           ) || pathParam.name;
         return _.replace(fixedRoute, pathParam.$match, `\${${insertion}}`);
       },
-      routeName || '',
+      routeName || "",
     );
 
     const queryParamMatches = fixedRoute.match(/(\{\?.*\})/g);
@@ -162,35 +162,35 @@ class SchemaRoutes {
 
     if (queryParamMatches && queryParamMatches.length) {
       queryParamMatches.forEach((match) => {
-        fixedRoute = fixedRoute.replace(match, '');
+        fixedRoute = fixedRoute.replace(match, "");
       });
 
       _.uniq(
         queryParamMatches
-          .join(',')
-          .replace(/(\{\?)|(\})|\s/g, '')
-          .split(','),
+          .join(",")
+          .replace(/(\{\?)|(\})|\s/g, "")
+          .split(","),
       ).forEach((paramName) => {
-        if (_.includes(paramName, '-')) {
-          this.logger.warn('wrong query param name', paramName);
+        if (_.includes(paramName, "-")) {
+          this.logger.warn("wrong query param name", paramName);
         }
 
         queryParams.push({
           $match: paramName,
           name: _.camelCase(paramName),
           required: true,
-          type: 'string',
-          description: '',
+          type: "string",
+          description: "",
           schema: {
-            type: 'string',
+            type: "string",
           },
-          in: 'query',
+          in: "query",
         });
       });
     }
 
     const result = {
-      originalRoute: originalRouteName || '',
+      originalRoute: originalRouteName || "",
       route: fixedRoute,
       pathParams,
       queryParams,
@@ -246,7 +246,7 @@ class SchemaRoutes {
         };
       }
 
-      if (routeParam.in === 'path') {
+      if (routeParam.in === "path") {
         if (!routeParam.name) return;
 
         routeParam.name = _.camelCase(routeParam.name);
@@ -300,29 +300,29 @@ class SchemaRoutes {
   getContentKind = (contentTypes) => {
     if (
       _.some(contentTypes, (contentType) =>
-        _.startsWith(contentType, 'application/json'),
+        _.startsWith(contentType, "application/json"),
       ) ||
-      _.some(contentTypes, (contentType) => _.endsWith(contentType, '+json'))
+      _.some(contentTypes, (contentType) => _.endsWith(contentType, "+json"))
     ) {
       return CONTENT_KIND.JSON;
     }
 
-    if (contentTypes.includes('application/x-www-form-urlencoded')) {
+    if (contentTypes.includes("application/x-www-form-urlencoded")) {
       return CONTENT_KIND.URL_ENCODED;
     }
 
-    if (contentTypes.includes('multipart/form-data')) {
+    if (contentTypes.includes("multipart/form-data")) {
       return CONTENT_KIND.FORM_DATA;
     }
 
     if (
-      _.some(contentTypes, (contentType) => _.includes(contentType, 'image/'))
+      _.some(contentTypes, (contentType) => _.includes(contentType, "image/"))
     ) {
       return CONTENT_KIND.IMAGE;
     }
 
     if (
-      _.some(contentTypes, (contentType) => _.startsWith(contentType, 'text/'))
+      _.some(contentTypes, (contentType) => _.startsWith(contentType, "text/"))
     ) {
       return CONTENT_KIND.TEXT;
     }
@@ -331,13 +331,13 @@ class SchemaRoutes {
   };
 
   isSuccessStatus = (status) =>
-    (this.config.defaultResponseAsSuccess && status === 'default') ||
+    (this.config.defaultResponseAsSuccess && status === "default") ||
     (+status >= this.config.successResponseStatusRange[0] &&
       +status <= this.config.successResponseStatusRange[1]) ||
-    status === '2xx';
+    status === "2xx";
 
   getSchemaFromRequestType = (requestInfo) => {
-    const content = _.get(requestInfo, 'content');
+    const content = _.get(requestInfo, "content");
 
     if (!content) return null;
 
@@ -398,7 +398,7 @@ class SchemaRoutes {
       const typeNameWithoutOpId = _.replace(
         refTypeInfo.typeName,
         operationId,
-        '',
+        "",
       );
       if (
         _.find(parsedSchemas, (schema) => schema.name === typeNameWithoutOpId)
@@ -407,10 +407,10 @@ class SchemaRoutes {
       }
 
       switch (refTypeInfo.componentName) {
-        case 'schemas':
+        case "schemas":
           return this.typeNameFormatter.format(refTypeInfo.typeName);
-        case 'responses':
-        case 'requestBodies':
+        case "responses":
+        case "requestBodies":
           return this.schemaParserFabric.getInlineParseContent(
             this.getSchemaFromRequestType(refTypeInfo.rawTypeData),
             refTypeInfo.typeName || null,
@@ -456,7 +456,7 @@ class SchemaRoutes {
             ),
             description:
               this.schemaParserFabric.schemaFormatters.formatDescription(
-                requestInfo.description || '',
+                requestInfo.description || "",
                 true,
               ),
             status: _.isNaN(+status) ? status : +status,
@@ -472,7 +472,7 @@ class SchemaRoutes {
 
     const contentTypes = this.getContentTypes(responses, [
       ...(produces || []),
-      routeInfo['x-accepts'],
+      routeInfo["x-accepts"],
     ]);
 
     const responseInfos = this.getRequestInfoTypes({
@@ -492,7 +492,7 @@ class SchemaRoutes {
 
     const handleResponseHeaders = (src) => {
       if (!src) {
-        return 'headers: {},';
+        return "headers: {},";
       }
       const headerTypes = Object.fromEntries(
         Object.entries(src).map(([k, v]) => {
@@ -501,7 +501,7 @@ class SchemaRoutes {
       );
       const r = `headers: { ${Object.entries(headerTypes)
         .map(([k, v]) => `"${k}": ${v}`)
-        .join(',')} },`;
+        .join(",")} },`;
       return r;
     };
 
@@ -545,7 +545,7 @@ class SchemaRoutes {
 
         let usageName = `${schemaPart.name}`;
 
-        if (usageName.includes('.')) {
+        if (usageName.includes(".")) {
           usageName = camelCase(usageName);
         }
 
@@ -564,7 +564,7 @@ class SchemaRoutes {
       },
       {
         properties: {},
-        type: 'object',
+        type: "object",
       },
     );
   };
@@ -576,7 +576,7 @@ class SchemaRoutes {
 
     const contentTypes = this.getContentTypes(
       [requestBody],
-      [...(consumes || []), routeInfo['x-contentType']],
+      [...(consumes || []), routeInfo["x-contentType"]],
     );
     let contentKind = this.getContentKind(contentTypes);
 
@@ -650,7 +650,7 @@ class SchemaRoutes {
       type: content,
       required:
         requestBody &&
-        (typeof requestBody.required === 'undefined' || !!requestBody.required),
+        (typeof requestBody.required === "undefined" || !!requestBody.required),
     };
   };
 
@@ -669,7 +669,7 @@ class SchemaRoutes {
         if (pathArgSchema.name) {
           acc[pathArgSchema.name] = {
             ...pathArgSchema,
-            in: 'path',
+            in: "path",
           };
         }
 
@@ -679,12 +679,12 @@ class SchemaRoutes {
     );
 
     const fixedQueryParams = _.reduce(
-      _.get(queryObjectSchema, 'properties', {}),
+      _.get(queryObjectSchema, "properties", {}),
       (acc, property, name) => {
         if (name && _.isObject(property)) {
           acc[name] = {
             ...property,
-            in: 'query',
+            in: "query",
           };
         }
 
@@ -784,17 +784,17 @@ class SchemaRoutes {
           title: errorSchemas
             .map((schema) => schema.title)
             .filter(Boolean)
-            .join(' '),
+            .join(" "),
           description: errorSchemas
             .map((schema) => schema.description)
             .filter(Boolean)
-            .join('\n'),
+            .join("\n"),
         },
         null,
         [routeInfo.operationId],
       );
       const component = this.schemaComponentsMap.createComponent(
-        this.schemaComponentsMap.createRef(['components', 'schemas', typeName]),
+        this.schemaComponentsMap.createRef(["components", "schemas", typeName]),
         { ...schema },
       );
       responseBodyInfo.error.schemas = [component];
@@ -843,7 +843,7 @@ class SchemaRoutes {
     const duplicates = routeNameDuplicatesMap.get(duplicateIdentifier);
 
     const routeNameInfo = {
-      usage: routeName + (duplicates > 1 ? duplicates : ''),
+      usage: routeName + (duplicates > 1 ? duplicates : ""),
       original: routeName,
       duplicate: duplicates > 1,
     };
@@ -891,7 +891,7 @@ class SchemaRoutes {
     const moduleName =
       moduleNameFirstTag && firstTag
         ? _.camelCase(firstTag)
-        : _.camelCase(_.compact(_.split(route, '/'))[moduleNameIndex]);
+        : _.camelCase(_.compact(_.split(route, "/"))[moduleNameIndex]);
     let hasSecurity = !!(globalSecurity && globalSecurity.length);
     if (security) {
       hasSecurity = security.length > 0;
@@ -1059,7 +1059,7 @@ class SchemaRoutes {
 
     return {
       id: routeId,
-      namespace: _.replace(moduleName, /^(\d)/, 'v$1'),
+      namespace: _.replace(moduleName, /^(\d)/, "v$1"),
       routeName,
       routeParams,
       requestBodyInfo,
@@ -1156,7 +1156,7 @@ class SchemaRoutes {
     const routeGroups = _.reduce(
       groupedRoutes,
       (acc, routesGroup, moduleName) => {
-        if (moduleName === '$outOfModule') {
+        if (moduleName === "$outOfModule") {
           acc.outOfModule = routesGroup;
         } else {
           if (!acc.combined) acc.combined = [];

package/src/schema-routes/util/specific-arg-name-resolver.js

@@ -1,4 +1,4 @@
-const { NameResolver } = require('../../util/name-resolver');
+const { NameResolver } = require("../../util/name-resolver");
 
 class SpecificArgNameResolver extends NameResolver {
   counter = 1;
@@ -13,7 +13,7 @@ class SpecificArgNameResolver extends NameResolver {
         (variants[0] && `${variants[0]}${this.counter++}`) ||
         `${this.config.specificArgNameResolverName}${this.counter++}`;
       this.logger.debug(
-        'generated fallback type name for specific arg - ',
+        "generated fallback type name for specific arg - ",
         generatedVariant,
       );
       return generatedVariant;

package/src/schema-walker.js

@@ -1,4 +1,4 @@
-const _ = require('lodash');
+const _ = require("lodash");
 
 // TODO: WIP
 // this class will be needed to walk by schema everywhere
@@ -32,7 +32,7 @@ class SchemaWalker {
    * @returns {any}
    */
   findByRef = (ref) => {
-    this.logger.debug('try to resolve ref by path', ref);
+    this.logger.debug("try to resolve ref by path", ref);
 
     if (this.caches.has(ref)) {
       return this.caches.get(ref);
@@ -47,10 +47,10 @@ class SchemaWalker {
         }
       }
     } else if (this._isRemoteRef(ref)) {
-      this.logger.debug('remote refs not supported', ref);
+      this.logger.debug("remote refs not supported", ref);
       return null;
     } else {
-      const [address, path] = path.split('#');
+      const [address, path] = path.split("#");
       let swaggerSchemaObject;
 
       if (this.schemas.has(address)) {
@@ -71,15 +71,15 @@ class SchemaWalker {
   };
 
   _isLocalRef = (ref) => {
-    return ref.startsWith('#');
+    return ref.startsWith("#");
   };
 
   _isRemoteRef = (ref) => {
-    return ref.startsWith('http://') || ref.startsWith('https://');
+    return ref.startsWith("http://") || ref.startsWith("https://");
   };
 
   _getRefDataFromSchema = (schema, ref) => {
-    const path = ref.replace('#', '').split('/');
+    const path = ref.replace("#", "").split("/");
     const refData = _.get(schema, path);
     if (refData) {
       this.caches.set(ref, refData);

package/src/swagger-schema-resolver.js

@@ -1,7 +1,7 @@
-const _ = require('lodash');
-const converter = require('swagger2openapi');
-const yaml = require('js-yaml');
-const { Request } = require('./util/request');
+const _ = require("lodash");
+const converter = require("swagger2openapi");
+const yaml = require("js-yaml");
+const { Request } = require("./util/request");
 
 class SwaggerSchemaResolver {
   /**
@@ -70,8 +70,8 @@ class SwaggerSchemaResolver {
       const result = _.cloneDeep(swaggerSchema);
       result.info = _.merge(
         {
-          title: 'No title',
-          version: '',
+          title: "No title",
+          version: "",
         },
         result.info,
       );
@@ -84,14 +84,14 @@ class SwaggerSchemaResolver {
           {
             ...converterOptions,
             warnOnly: true,
-            refSiblings: 'preserve',
-            rbname: 'requestBodyName',
+            refSiblings: "preserve",
+            rbname: "requestBodyName",
           },
           (err, options) => {
             const parsedSwaggerSchema = _.get(
               err,
-              'options.openapi',
-              _.get(options, 'openapi'),
+              "options.openapi",
+              _.get(options, "openapi"),
             );
             if (!parsedSwaggerSchema && err) {
               throw new Error(err);
@@ -138,7 +138,7 @@ class SwaggerSchemaResolver {
   }
 
   processSwaggerSchemaFile(file) {
-    if (typeof file !== 'string') return file;
+    if (typeof file !== "string") return file;
 
     try {
       return JSON.parse(file);
@@ -148,8 +148,8 @@ class SwaggerSchemaResolver {
   }
 
   fixSwaggerSchema({ usageSchema, originalSchema }) {
-    const usagePaths = _.get(usageSchema, 'paths');
-    const originalPaths = _.get(originalSchema, 'paths');
+    const usagePaths = _.get(usageSchema, "paths");
+    const originalPaths = _.get(originalSchema, "paths");
 
     // walk by routes
     _.each(usagePaths, (usagePathObject, route) => {
@@ -158,10 +158,10 @@ class SwaggerSchemaResolver {
       // walk by methods
       _.each(usagePathObject, (usageRouteInfo, methodName) => {
         const originalRouteInfo = _.get(originalPathObject, methodName);
-        const usageRouteParams = _.get(usageRouteInfo, 'parameters', []);
-        const originalRouteParams = _.get(originalRouteInfo, 'parameters', []);
+        const usageRouteParams = _.get(usageRouteInfo, "parameters", []);
+        const originalRouteParams = _.get(originalRouteInfo, "parameters", []);
 
-        if (typeof usageRouteInfo === 'object') {
+        if (typeof usageRouteInfo === "object") {
           usageRouteInfo.consumes = _.uniq(
             _.compact([
               ...(usageRouteInfo.consumes || []),

package/src/templates-worker.js

@@ -1,7 +1,7 @@
-const { resolve } = require('path');
-const _ = require('lodash');
-const Eta = require('eta');
-const path = require('path');
+const { resolve } = require("node:path");
+const _ = require("lodash");
+const Eta = require("eta");
+const path = require("node:path");
 
 class TemplatesWorker {
   /**
@@ -34,9 +34,9 @@ class TemplatesWorker {
    * @returns {CodeGenConfig.templatePaths}
    */
   getTemplatePaths = (config) => {
-    const baseTemplatesPath = resolve(__dirname, '../templates/base');
-    const defaultTemplatesPath = resolve(__dirname, '../templates/default');
-    const modularTemplatesPath = resolve(__dirname, '../templates/modular');
+    const baseTemplatesPath = resolve(__dirname, "../templates/base");
+    const defaultTemplatesPath = resolve(__dirname, "../templates/default");
+    const modularTemplatesPath = resolve(__dirname, "../templates/modular");
     const originalTemplatesPath = config.modular
       ? modularTemplatesPath
       : defaultTemplatesPath;
@@ -59,12 +59,12 @@ class TemplatesWorker {
 
   cropExtension = (path) =>
     this.config.templateExtensions.reduce(
-      (path, ext) => (_.endsWith(path, ext) ? path.replace(ext, '') : path),
+      (path, ext) => (_.endsWith(path, ext) ? path.replace(ext, "") : path),
       path,
     );
 
   getTemplateFullPath = (path, fileName) => {
-    const raw = resolve(path, './', this.cropExtension(fileName));
+    const raw = resolve(path, "./", this.cropExtension(fileName));
     const pathVariants = this.config.templateExtensions.map(
       (extension) => `${raw}${extension}`,
     );
@@ -76,13 +76,16 @@ class TemplatesWorker {
 
   requireFnFromTemplate = (packageOrPath) => {
     const isPath =
-      _.startsWith(packageOrPath, './') || _.startsWith(packageOrPath, '../');
+      _.startsWith(packageOrPath, "./") || _.startsWith(packageOrPath, "../");
 
     if (isPath) {
-      return require(path.resolve(
-        this.config.templatePaths.custom || this.config.templatePaths.original,
-        packageOrPath,
-      ));
+      return require(
+        path.resolve(
+          this.config.templatePaths.custom ||
+            this.config.templatePaths.original,
+          packageOrPath,
+        ),
+      );
     }
 
     return require(packageOrPath);
@@ -95,7 +98,7 @@ class TemplatesWorker {
       return this.fileSystem.getFileContent(path);
     }
 
-    if (!fileName) return '';
+    if (!fileName) return "";
 
     const customFullPath =
       templatePaths.custom &&
@@ -120,7 +123,7 @@ class TemplatesWorker {
           `"${_.lowerCase(name)}" template not found in "${
             templatePaths.custom
           }"`,
-          `\nCode generator will use the default template`,
+          "\nCode generator will use the default template",
         );
       } else {
         this.logger.log(
@@ -202,7 +205,7 @@ class TemplatesWorker {
       return this.fileSystem.getFileContent(originalPath);
     }
 
-    return '';
+    return "";
   };
 
   /**
@@ -212,7 +215,7 @@ class TemplatesWorker {
    * @returns {Promise<string|string|void>}
    */
   renderTemplate = (template, configuration, options) => {
-    if (!template) return '';
+    if (!template) return "";
 
     return Eta.render(
       template,

package/src/translators/javascript.js

@@ -1,5 +1,5 @@
-const ts = require('typescript');
-const { Translator } = require('./translator');
+const ts = require("typescript");
+const { Translator } = require("./translator");
 
 class JavascriptTranslator extends Translator {
   /**
@@ -51,17 +51,17 @@ class JavascriptTranslator extends Translator {
     const dtsFileName = `${input.fileName}${ts.Extension.Dts}`;
     const sourceContent = compiled[jsFileName];
     const tsImportRows = input.fileContent
-      .split('\n')
-      .filter((line) => line.startsWith('import '));
+      .split("\n")
+      .filter((line) => line.startsWith("import "));
     const declarationContent = compiled[dtsFileName]
-      .split('\n')
+      .split("\n")
       .map((line) => {
-        if (line.startsWith('import ')) {
+        if (line.startsWith("import ")) {
           return tsImportRows.shift();
         }
         return line;
       })
-      .join('\n');
+      .join("\n");
 
     return [
       {

package/src/translators/translator.js

@@ -26,7 +26,7 @@ class Translator {
    */
   // eslint-disable-next-line no-unused-vars
   translate(input) {
-    throw new Error('not implemented');
+    throw new Error("not implemented");
   }
 }