swagger-typescript-api 12.0.2 → 12.0.4

package/README.md

@@ -2,7 +2,7 @@
 
 [![NPM badge](https://img.shields.io/npm/v/swagger-typescript-api.svg)](https://www.npmjs.com/package/swagger-typescript-api) 
 [![CI](https://github.com/acacode/swagger-typescript-api/actions/workflows/main.yml/badge.svg?branch=next)](https://github.com/acacode/swagger-typescript-api/actions/workflows/main.yml) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-32-orange.svg)](#contributors)
+[![All Contributors](https://img.shields.io/badge/all_contributors-33-orange.svg)](#contributors)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 <img src="https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/swagger-typescript-api-logo.png" align="left"
@@ -21,9 +21,15 @@ Any questions you can ask [**here**](https://github.com/acacode/swagger-typescri
 
 ![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/components-converter-example.jpg)    
 
-👀 This project is looking for a code maintainer 👀    
 P.S. If you are creating the PR, please check your changes with using command `npm run prepare`  
-P.S. If you want to contribute please use branch `next`. All PRs which will have target `master` will be declined  
+P.S. If you want to contribute please use the `next` branch. All PRs that has target `master` will be declined!  
+
+
+Thanks to [Jetbrains](https://www.jetbrains.com/?from=swaggertypescriptapi) for providing a free license for their excellent Webstorm IDE.  
+<a href="https://www.jetbrains.com/?from=swaggertypescriptapi">
+  <img src="https://upload.wikimedia.org/wikipedia/commons/1/1a/JetBrains_Logo_2016.svg" alt="Jetbrains">
+</a>
+
 
 ## 👀 Examples  
 
@@ -124,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,
@@ -529,6 +536,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
       <td align="center"><a href="https://github.com/ApacheEx"><img src="https://avatars.githubusercontent.com/u/1918108?v=4?s=100" width="100px;" alt="Oleg Kuzava"/><br /><sub><b>Oleg Kuzava</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=ApacheEx" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AApacheEx" title="Bug reports">🐛</a></td>
       <td align="center"><a href="http://nikz.se"><img src="https://avatars.githubusercontent.com/u/7352072?v=4?s=100" width="100px;" alt="Niklas Frank"/><br /><sub><b>Niklas Frank</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=nksfrank" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3Anksfrank" title="Bug reports">🐛</a></td>
       <td align="center"><a href="https://quentinbrunet.com"><img src="https://avatars.githubusercontent.com/u/20137632?v=4?s=100" width="100px;" alt="Quentin Brunet"/><br /><sub><b>Quentin Brunet</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=qboot" title="Code">💻</a></td>
+      <td align="center"><a href="https://github.com/Soarc"><img src="https://avatars.githubusercontent.com/u/3385495?v=4?s=100" width="100px;" alt="Gor Rustamyan"/><br /><sub><b>Gor Rustamyan</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=Soarc" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3ASoarc" title="Bug reports">🐛</a></td>
+      <td align="center"><a href="https://github.com/JochenDiekenbrock"><img src="https://avatars.githubusercontent.com/u/1625222?v=4?s=100" width="100px;" alt="Jochen Diekenbrock"/><br /><sub><b>Jochen Diekenbrock</b></sub></a><br /><a href="https://github.com/acacode/swagger-typescript-api/commits?author=JochenDiekenbrock" title="Code">💻</a> <a href="https://github.com/acacode/swagger-typescript-api/issues?q=author%3AJochenDiekenbrock" title="Bug reports">🐛</a></td>
     </tr>
   </tbody>
 </table>

package/index.d.ts

@@ -144,20 +144,28 @@ interface GenerateApiParamsBase {
 
   /** extract all enums from nested types\interfaces to `enum` construction */
   extractEnums?: boolean;
+
   /** prefix string value needed to fix invalid type names (default: 'Type') */
   fixInvalidTypeNamePrefix?: string;
+
   /** prefix string value needed to fix invalid enum keys (default: 'Value') */
   fixInvalidEnumKeyPrefix?: string;
+
   /** prefix string value for enum keys */
   enumKeyPrefix?: string;
+
   /** suffix string value for enum keys */
   enumKeySuffix?: string;
+
   /** prefix string value for type names */
   typePrefix?: string;
+
   /** suffix string value for type names */
   typeSuffix?: string;
+
   /** extra configuration for extracting type names operations */
   extractingOptions?: Partial<ExtractingOptions>;
+
   /** configuration for fetching swagger schema requests */
   requestOptions?: null | Partial<import("node-fetch").RequestInit>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "12.0.2",
+  "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",
@@ -80,7 +80,7 @@
     "@types/swagger-schema-official": "2.0.22",
     "cosmiconfig": "7.0.1",
     "didyoumean": "^1.2.2",
-    "eta": "1.12.3",
+    "eta": "^2.0.0",
     "js-yaml": "4.1.0",
     "lodash": "4.17.21",
     "make-dir": "3.1.0",

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/README.md

@@ -1,17 +1,17 @@
-# swagger-typescript-api  
-
-# templates  
-
-Templates:  
-- `api.ejs` - *(generates file)* Api class module (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/api.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/api.ejs))  
-- `data-contracts.ejs` - *(generates file)* all types (data contracts) from swagger schema (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contracts.ejs))  
-- `http-client.ejs` - *(generates file)* HttpClient class module (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-client.ejs))  
-- `procedure-call.ejs` - *(subtemplate)* route in Api class (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/procedure-call.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/procedure-call.ejs))  
-- `route-docs.ejs` - *(generates file)* documentation for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-docs.ejs))  
-- `route-name.ejs` - *(subtemplate)* route name for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-name.ejs))  
-- `route-type.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-type.ejs))  
-- `route-types.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-types.ejs))  - `data-contract-jsdoc.ejs` - *(subtemplate)* generates JSDOC for data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contract-jsdoc.ejs))
-
-[//]: # (- `enum-data-contract.ejs` - *(subtemplate)* generates `enum` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/enum-data-contract.ejs)))
-[//]: # (- `interface-data-contract.ejs` - *(subtemplate)* generates `interface` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/interface-data-contract.ejs)))
-[//]: # (- `type-data-contract.ejs` - *(subtemplate)* generates `type` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/type-data-contract.ejs)))
+# swagger-typescript-api  
+
+# templates  
+
+Templates:  
+- `api.ejs` - *(generates file)* Api class module (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/api.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/api.ejs))  
+- `data-contracts.ejs` - *(generates file)* all types (data contracts) from swagger schema (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contracts.ejs))  
+- `http-client.ejs` - *(generates file)* HttpClient class module (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/http-client.ejs))  
+- `procedure-call.ejs` - *(subtemplate)* route in Api class (locations: [default](https://github.com/acacode/swagger-typescript-api/tree/next/templates/default/procedure-call.ejs), [modular](https://github.com/acacode/swagger-typescript-api/tree/next/templates/modular/procedure-call.ejs))  
+- `route-docs.ejs` - *(generates file)* documentation for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-docs.ejs))  
+- `route-name.ejs` - *(subtemplate)* route name for route in Api class (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-name.ejs))  
+- `route-type.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-type.ejs))  
+- `route-types.ejs` - *(`--route-types` option)* *(subtemplate)* (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/route-types.ejs))  - `data-contract-jsdoc.ejs` - *(subtemplate)* generates JSDOC for data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/data-contract-jsdoc.ejs))
+
+[//]: # (- `enum-data-contract.ejs` - *(subtemplate)* generates `enum` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/enum-data-contract.ejs)))
+[//]: # (- `interface-data-contract.ejs` - *(subtemplate)* generates `interface` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/interface-data-contract.ejs)))
+[//]: # (- `type-data-contract.ejs` - *(subtemplate)* generates `type` data contract (locations: [base](https://github.com/acacode/swagger-typescript-api/tree/next/templates/base/type-data-contract.ejs)))

package/templates/base/README.md

@@ -1,8 +1,8 @@
-# swagger-typescript-api  
-
-# templates/base  
-
-This templates use both for multiple api files and single api file  
-
-
+# swagger-typescript-api  
+
+# templates/base  
+
+This templates use both for multiple api files and single api file  
+
+
 path prefix `@base`  

package/templates/default/README.md

@@ -1,7 +1,7 @@
-# swagger-typescript-api  
-
-# templates/default  
-
-This templates use for single api file (without `--modular` option)  
-
+# swagger-typescript-api  
+
+# templates/default  
+
+This templates use for single api file (without `--modular` option)  
+
 path prefix `@default`  

package/templates/modular/README.md

@@ -1,7 +1,7 @@
-# swagger-typescript-api  
-
-# templates/modular  
-
-This templates use for multiple api files (`--modular` option)  
-
+# swagger-typescript-api  
+
+# templates/modular  
+
+This templates use for multiple api files (`--modular` option)  
+
 path prefix `@modular`