swagger-typescript-api 12.0.3 → 12.0.4

package/LICENSE

@@ -1,22 +1,22 @@
-MIT License
-
-Copyright (c) 2019-present acacode
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+MIT License
+
+Copyright (c) 2019-present acacode
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -130,6 +130,7 @@ generateApi({
   toJS: false,
   extractRequestParams: false,
   extractRequestBody: false,
+  extractEnums: false,
   unwrapResponseData: false,
   prettier: { // By default prettier config is load from your project
     printWidth: 120,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "12.0.3",
+  "version": "12.0.4",
   "description": "Generate typescript/javascript api from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts",
@@ -14,7 +14,6 @@
     "test-all-extended": "node --unhandled-rejections=strict ./scriptsRunner.js generate-extended validate generate validate test:*",
     "test-specific": "node ./scriptsRunner.js generate validate test:*",
     "test-specific-only": "node ./scriptsRunner.js test:*",
-    "prepare": "npm run test-all-extended",
     "generate": "node tests/generate.js",
     "generate-extended": "node tests/generate-extended.js",
     "generate:debug": "node --nolazy tests/generate.js",

package/src/schema-parser/schema-parser.js

@@ -92,7 +92,7 @@ class SchemaParser {
   baseSchemaParsers = {
     [SCHEMA_TYPES.ENUM]: (schema, typeName) => {
       if (this.config.extractEnums && !typeName) {
-        const generatedTypeName = this.config.componentTypeNameResolver.resolve([this.buildTypeNameFromPath()]);
+        const generatedTypeName = this.config.componentTypeNameResolver.resolve([this.buildTypeNameFromPath()], false);
         const schemaComponent = this.schemaComponentsMap.createComponent("schemas", generatedTypeName, { ...schema });
         return this.parseSchema(schemaComponent, generatedTypeName);
       }
@@ -391,9 +391,9 @@ class SchemaParser {
       _.merge(schema, this.config.hooks.onPreParseSchema(schema, typeName, schemaType));
       parsedSchema = this.baseSchemaParsers[schemaType](schema, typeName);
       schema.$parsed = this.config.hooks.onParseSchema(schema, parsedSchema) || parsedSchema;
-    }
 
-    this.$processingSchemaPath.pop();
+      this.$processingSchemaPath.pop();
+    }
 
     return schema.$parsed;
   };

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

@@ -383,7 +383,7 @@ class SchemaRoutes {
       [],
     );
 
-  getResponseBodyInfo = (routeInfo, routeParams, parsedSchemas) => {
+  getResponseBodyInfo = (routeInfo, parsedSchemas) => {
     const { produces, operationId, responses } = routeInfo;
 
     const contentTypes = this.getContentTypes(responses, [...(produces || []), routeInfo["x-accepts"]]);
@@ -720,12 +720,13 @@ class SchemaRoutes {
     const pathArgs = routeParams.path.map((pathArgSchema) => ({
       name: pathArgSchema.name,
       optional: !pathArgSchema.required,
-      type: this.schemaParser.getInlineParseContent(pathArgSchema.schema),
+      // mark it as any for now, because "getInlineParseContent" breaks type names of extracted enums
+      type: this.config.Ts.Keyword.Any,
       description: pathArgSchema.description,
     }));
     const pathArgsNames = pathArgs.map((arg) => arg.name);
 
-    const responseBodyInfo = this.getResponseBodyInfo(routeInfo, routeParams, parsedSchemas);
+    const responseBodyInfo = this.getResponseBodyInfo(routeInfo, parsedSchemas);
 
     const rawRouteInfo = {
       ...otherInfo,
@@ -767,9 +768,22 @@ class SchemaRoutes {
       this.extractResponseErrorIfItNeeded(routeInfo, responseBodyInfo, routeName);
     }
 
-    const queryType = routeParams.query.length ? this.schemaParser.getInlineParseContent(queryObjectSchema) : null;
-    const pathType = routeParams.path.length ? this.schemaParser.getInlineParseContent(pathObjectSchema) : null;
-    const headersType = routeParams.header.length ? this.schemaParser.getInlineParseContent(headersObjectSchema) : null;
+    const typeName = this.schemaUtils.resolveTypeName(
+      routeName.usage,
+      this.config.extractingOptions.requestParamsSuffix,
+      this.config.extractingOptions.requestParamsNameResolver,
+      false,
+    );
+
+    const queryType = routeParams.query.length
+      ? this.schemaParser.getInlineParseContent(queryObjectSchema, typeName)
+      : null;
+    const pathType = routeParams.path.length
+      ? this.schemaParser.getInlineParseContent(pathObjectSchema, typeName)
+      : null;
+    const headersType = routeParams.header.length
+      ? this.schemaParser.getInlineParseContent(headersObjectSchema, typeName)
+      : null;
 
     const nameResolver = new SpecificArgNameResolver(this.logger, pathArgsNames);
 
@@ -804,6 +818,10 @@ class SchemaRoutes {
         : void 0,
     };
 
+    pathArgs.forEach((pathArg, i) => {
+      pathArg.type = this.schemaParser.getInlineParseContent(routeParams.path[i].schema, typeName);
+    });
+
     return {
       id: routeId,
       namespace: _.replace(moduleName, /^(\d)/, "v$1"),
@@ -854,19 +872,21 @@ class SchemaRoutes {
       _.forEach(routeInfosMap, (routeInfo, method) => {
         const parsedRouteInfo = this.parseRouteInfo(rawRouteName, routeInfo, method, usageSchema, parsedSchemas);
         const processedRouteInfo = this.config.hooks.onCreateRoute(parsedRouteInfo);
-        const route = processedRouteInfo || parsedRouteInfo;
-
-        if (!this.hasSecurityRoutes && route.security) {
-          this.hasSecurityRoutes = route.security;
-        }
-        if (!this.hasQueryRoutes && route.hasQuery) {
-          this.hasQueryRoutes = route.hasQuery;
+        if (processedRouteInfo !== false) {
+            const route = processedRouteInfo || parsedRouteInfo;
+
+            if (!this.hasSecurityRoutes && route.security) {
+                this.hasSecurityRoutes = route.security;
+            }
+            if (!this.hasQueryRoutes && route.hasQuery) {
+                this.hasQueryRoutes = route.hasQuery;
+            }
+            if (!this.hasFormDataRoutes && route.hasFormDataParams) {
+                this.hasFormDataRoutes = route.hasFormDataParams;
+            }
+
+            this.routes.push(route);
         }
-        if (!this.hasFormDataRoutes && route.hasFormDataParams) {
-          this.hasFormDataRoutes = route.hasFormDataParams;
-        }
-
-        this.routes.push(route);
       });
     });
   };

package/src/schema-parser/schema-utils.js

@@ -145,7 +145,7 @@ class SchemaUtils {
     return _.uniq(_.filter(contents, (type) => filterFn(type)));
   };
 
-  resolveTypeName = (typeName, suffixes, resolver) => {
+  resolveTypeName = (typeName, suffixes, resolver, shouldReserve = true) => {
     if (resolver) {
       return this.config.componentTypeNameResolver.resolve((reserved) => {
         const variant = resolver(pascalCase(typeName), reserved);
@@ -155,6 +155,7 @@ class SchemaUtils {
     } else {
       return this.config.componentTypeNameResolver.resolve(
         suffixes.map((suffix) => pascalCase(`${typeName} ${suffix}`)),
+        shouldReserve,
       );
     }
   };

package/src/util/name-resolver.js

@@ -40,7 +40,7 @@ class NameResolver {
    * @param {(string[]) | ((reserved: string[]) => string)} variantsOrResolver
    * @returns {string | null}
    */
-  resolve(variantsOrResolver) {
+  resolve(variantsOrResolver, shouldReserve = true) {
     this.logger.debug("resolving name with using", variantsOrResolver);
     if (Array.isArray(variantsOrResolver)) {
       const variants = variantsOrResolver;
@@ -48,13 +48,13 @@ class NameResolver {
       const uniqVariants = _.uniq(_.compact(variants));
 
       _.forEach(uniqVariants, (variant) => {
-        if (!usageName && !this.isReserved(variant)) {
+        if (!usageName && (!shouldReserve || !this.isReserved(variant))) {
           usageName = variant;
         }
       });
 
       if (usageName) {
-        this.reserve([usageName]);
+        shouldReserve && this.reserve([usageName]);
         return usageName;
       }
 
@@ -74,7 +74,7 @@ class NameResolver {
         }
       }
 
-      this.reserve([usageName]);
+      shouldReserve && this.reserve([usageName]);
       return usageName;
     }
 

package/templates/base/data-contract-jsdoc.ejs

@@ -1,37 +1,37 @@
-<%
-const { data, utils } = it;
-const { formatDescription, require, _ } = utils;
-
-const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value
-
-const jsDocLines = _.compact([
-    data.title,
-    data.description && formatDescription(data.description),
-    !_.isUndefined(data.deprecated) && data.deprecated && '@deprecated',
-    !_.isUndefined(data.format) && `@format ${data.format}`,
-    !_.isUndefined(data.minimum) && `@min ${data.minimum}`,
-    !_.isUndefined(data.multipleOf) && `@multipleOf ${data.multipleOf}`,
-    !_.isUndefined(data.exclusiveMinimum) && `@exclusiveMin ${data.exclusiveMinimum}`,
-    !_.isUndefined(data.maximum) && `@max ${data.maximum}`,
-    !_.isUndefined(data.minLength) && `@minLength ${data.minLength}`,
-    !_.isUndefined(data.maxLength) && `@maxLength ${data.maxLength}`,
-    !_.isUndefined(data.exclusiveMaximum) && `@exclusiveMax ${data.exclusiveMaximum}`,
-    !_.isUndefined(data.maxItems) && `@maxItems ${data.maxItems}`,
-    !_.isUndefined(data.minItems) && `@minItems ${data.minItems}`,
-    !_.isUndefined(data.uniqueItems) && `@uniqueItems ${data.uniqueItems}`,
-    !_.isUndefined(data.default) && `@default ${stringify(data.default)}`,
-    !_.isUndefined(data.pattern) && `@pattern ${data.pattern}`,
-    !_.isUndefined(data.example) && `@example ${stringify(data.example)}`
-]).join('\n').split('\n');
-%>
-<% if (jsDocLines.every(_.isEmpty)) { %>
-<% } else if (jsDocLines.length === 1) { %>
-/** <%~ jsDocLines[0] %> */
-<% } else if (jsDocLines.length) { %>
-/**
-<% for (jsDocLine of jsDocLines) { %>
- * <%~ jsDocLine %>
-
-<% } %>
- */
-<% } %>
+<%
+const { data, utils } = it;
+const { formatDescription, require, _ } = utils;
+
+const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value
+
+const jsDocLines = _.compact([
+    data.title,
+    data.description && formatDescription(data.description),
+    !_.isUndefined(data.deprecated) && data.deprecated && '@deprecated',
+    !_.isUndefined(data.format) && `@format ${data.format}`,
+    !_.isUndefined(data.minimum) && `@min ${data.minimum}`,
+    !_.isUndefined(data.multipleOf) && `@multipleOf ${data.multipleOf}`,
+    !_.isUndefined(data.exclusiveMinimum) && `@exclusiveMin ${data.exclusiveMinimum}`,
+    !_.isUndefined(data.maximum) && `@max ${data.maximum}`,
+    !_.isUndefined(data.minLength) && `@minLength ${data.minLength}`,
+    !_.isUndefined(data.maxLength) && `@maxLength ${data.maxLength}`,
+    !_.isUndefined(data.exclusiveMaximum) && `@exclusiveMax ${data.exclusiveMaximum}`,
+    !_.isUndefined(data.maxItems) && `@maxItems ${data.maxItems}`,
+    !_.isUndefined(data.minItems) && `@minItems ${data.minItems}`,
+    !_.isUndefined(data.uniqueItems) && `@uniqueItems ${data.uniqueItems}`,
+    !_.isUndefined(data.default) && `@default ${stringify(data.default)}`,
+    !_.isUndefined(data.pattern) && `@pattern ${data.pattern}`,
+    !_.isUndefined(data.example) && `@example ${stringify(data.example)}`
+]).join('\n').split('\n');
+%>
+<% if (jsDocLines.every(_.isEmpty)) { %>
+<% } else if (jsDocLines.length === 1) { %>
+/** <%~ jsDocLines[0] %> */
+<% } else if (jsDocLines.length) { %>
+/**
+<% for (jsDocLine of jsDocLines) { %>
+ * <%~ jsDocLine %>
+
+<% } %>
+ */
+<% } %>

package/templates/base/data-contracts.ejs

@@ -1,28 +1,28 @@
-<%
-const { modelTypes, utils, config } = it;
-const { formatDescription, require, _, Ts } = utils;
-
-
-const dataContractTemplates = {
-  enum: (contract) => {
-    return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
-  },
-  interface: (contract) => {
-    return `interface ${contract.name} {\r\n${contract.content}}`;
-  },
-  type: (contract) => {
-    return `type ${contract.name} = ${contract.content}`;
-  },
-}
-%>
-
-<% if (config.internalTemplateOptions.addUtilRequiredKeysType) { %>
-type <%~ config.Ts.CodeGenKeyword.UtilRequiredKeys %><T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
-<% } %>
-
-<% modelTypes.forEach((contract) => { %>
-  <%~ includeFile('@base/data-contract-jsdoc.ejs', { ...it, data: { ...contract, ...contract.typeData } }) %>
-  export <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
-
-
-<% }) %>
+<%
+const { modelTypes, utils, config } = it;
+const { formatDescription, require, _, Ts } = utils;
+
+
+const dataContractTemplates = {
+  enum: (contract) => {
+    return `enum ${contract.name} {\r\n${contract.content} \r\n }`;
+  },
+  interface: (contract) => {
+    return `interface ${contract.name} {\r\n${contract.content}}`;
+  },
+  type: (contract) => {
+    return `type ${contract.name} = ${contract.content}`;
+  },
+}
+%>
+
+<% if (config.internalTemplateOptions.addUtilRequiredKeysType) { %>
+type <%~ config.Ts.CodeGenKeyword.UtilRequiredKeys %><T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>
+<% } %>
+
+<% modelTypes.forEach((contract) => { %>
+  <%~ includeFile('@base/data-contract-jsdoc.ejs', { ...it, data: { ...contract, ...contract.typeData } }) %>
+  export <%~ (dataContractTemplates[contract.typeIdentifier] || dataContractTemplates.type)(contract) %>
+
+
+<% }) %>

package/templates/base/enum-data-contract.ejs

@@ -1,12 +1,12 @@
-<%
-const { contract, utils, config } = it;
-const { formatDescription, require, _ } = utils;
-const { name, $content } = contract;
-%>
-<% if (config.generateUnionEnums) { %>
-  export type <%~ name %> = <%~ _.map($content, ({ value }) => value).join(" | ") %>
-<% } else { %>
-  export enum <%~ name %> {
-    <%~ _.map($content, ({ key, value }) => `${key} = ${value}`).join(",\n") %>
-  }
-<% } %>
+<%
+const { contract, utils, config } = it;
+const { formatDescription, require, _ } = utils;
+const { name, $content } = contract;
+%>
+<% if (config.generateUnionEnums) { %>
+  export type <%~ name %> = <%~ _.map($content, ({ value }) => value).join(" | ") %>
+<% } else { %>
+  export enum <%~ name %> {
+    <%~ _.map($content, ({ key, value }) => `${key} = ${value}`).join(",\n") %>
+  }
+<% } %>

package/templates/base/http-client.ejs

@@ -1,3 +1,3 @@
-<% const { config } = it; %>
-<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
+<% const { config } = it; %>
+<% /* https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-clients/ */ %>
 <%~ includeFile(`@base/http-clients/${config.httpClientType}-http-client`, it) %>