swagger-typescript-api - npm Package Compare versions

Comparing version 13.0.24 to 13.0.25

CHANGELOG.md

 # swagger-typescript-api
 
+## 13.0.25
+
+### Patch Changes
+
+- [#1102](https://github.com/acacode/swagger-typescript-api/pull/1102) [`13da52a`](https://github.com/acacode/swagger-typescript-api/commit/13da52aa9eab24f90f06316943e810b34767324b) Thanks [@smorimoto](https://github.com/smorimoto)! - Fix CLI executable by adding the required shebang to the entry file.
+
+- [#1102](https://github.com/acacode/swagger-typescript-api/pull/1102) [`13da52a`](https://github.com/acacode/swagger-typescript-api/commit/13da52aa9eab24f90f06316943e810b34767324b) Thanks [@smorimoto](https://github.com/smorimoto)! - Fix query params detection on route name parsing
+
+- [#1102](https://github.com/acacode/swagger-typescript-api/pull/1102) [`13da52a`](https://github.com/acacode/swagger-typescript-api/commit/13da52aa9eab24f90f06316943e810b34767324b) Thanks [@smorimoto](https://github.com/smorimoto)! - Improve type safety by adding proper types to SchemaComponent and introducing flags for extracted elements such as request parameters, request body, response body, and response errors.
+
 ## 13.0.24
@@ -4,0 +14,0 @@

dist/cli.js

@@ -1,2 +0,3 @@
-import {e,f as f$1,b as b$1,d,a,g}from'./chunk-FXBGNN2X.js';import*as i from'node:path';import*as f from'node:url';import {defineCommand,runMain}from'citty';import {consola}from'consola';var o=new e({}),b=defineCommand({meta:{name:"generate-templates",description:'Generate ".ejs" templates needed for generate api'},args:{"clean-output":{type:"boolean",description:"clean output folder before generate template. WARNING: May cause data loss",default:o.cleanOutput},"http-client":{type:"string",description:`http client type (possible values: ${Object.values(b$1)})`,default:o.httpClientType},modular:{type:"boolean",description:"generate templates needed to separate files for http client, data contracts, and routes",default:o.modular},output:{type:"string",alias:"o",description:"output path of generated templates",default:o.output},rewrite:{type:"boolean",alias:"r",description:"rewrite content in existing templates",default:o.rewrite},silent:{type:"boolean",description:"Output only errors to console",default:o.silent},debug:{type:"boolean",description:"additional information about processes inside this tool",default:o.debug}},run:async({args:e})=>{await f$1({cleanOutput:e["clean-output"],httpClientType:e["http-client"],modular:e.modular,output:e.output,rewrite:e.rewrite,silent:e.silent,debug:e.debug});}}),t=new d({}),h=defineCommand({meta:{name:"generate",description:a.description},args:{path:{type:"string",alias:"p",description:"path/url to swagger scheme",required:true},output:{type:"string",alias:"o",description:"output path of typescript api file",default:"./"},name:{type:"string",alias:"n",description:"name of output typescript api file",default:t.fileName},templates:{type:"string",alias:"t",description:"path to folder containing templates"},"default-as-success":{type:"boolean",alias:"d",description:'use "default" response status code as success response too. some swagger schemas use "default" response status code as success response type by default.',default:t.defaultResponseAsSuccess},responses:{type:"boolean",alias:"r",description:"generate additional information about request responses also add typings for bad responses",default:t.generateResponses},"union-enums":{type:"boolean",description:'generate all "enum" types as union types (T1 | T2 | TN)',default:t.generateUnionEnums},"add-readonly":{type:"boolean",description:"generate readonly properties",default:t.addReadonly},"route-types":{type:"boolean",description:"generate type definitions for API routes",default:t.generateRouteTypes},"no-client":{type:"boolean",description:"do not generate an API class",default:t.generateClient},"enum-names-as-values":{type:"boolean",description:"use values in 'x-enumNames' as enum values (not only as keys)",default:t.enumNamesAsValues},"extract-request-params":{description:"extract request params to data contract (Also combine path params and query params into one object)",default:t.extractRequestParams},"extract-request-body":{type:"boolean",description:"extract request body type to data contract",default:t.extractRequestBody},"extract-response-body":{type:"boolean",description:"extract response body type to data contract",default:t.extractResponseBody},"extract-response-error":{type:"boolean",description:"extract response error type to data contract",default:t.extractResponseError},"extract-responses":{type:"boolean",description:"extract all responses described in /components/responses",default:t.extractResponses},modular:{type:"boolean",description:"generate separated files for http client, data contracts, and routes",default:t.modular},js:{type:"boolean",description:"generate js api module with declaration file",default:t.toJS},"module-name-index":{type:"string",description:"determines which path index should be used for routes separation (example: GET:/fruits/getFruit -> index:0 -> moduleName -> fruits)",default:t.moduleNameIndex.toString()},"module-name-first-tag":{type:"boolean",description:"splits routes based on the first tag",default:t.moduleNameFirstTag},axios:{type:"boolean",description:"generate axios http client",default:false},"unwrap-response-data":{type:"boolean",description:"unwrap the data item from the response",default:t.unwrapResponseData},"disable-throw-on-error":{type:"boolean",description:"Do not throw an error when response.ok is not true",default:t.disableThrowOnError},"single-http-client":{type:"boolean",description:"Ability to send HttpClient instance to Api constructor",default:t.singleHttpClient},silent:{type:"boolean",description:"Output only errors to console",default:t.silent},"default-response":{type:"string",description:"default type for empty response schema",default:t.defaultResponseType},"type-prefix":{type:"string",description:"data contract name prefix",default:t.typePrefix},"type-suffix":{type:"string",description:"data contract name suffix",default:t.typeSuffix},"clean-output":{type:"boolean",description:"clean output folder before generate api. WARNING: May cause data loss",default:t.cleanOutput},"api-class-name":{type:"string",description:"name of the api class",default:t.apiClassName},patch:{type:"boolean",description:"fix up small errors in the swagger source definition",default:t.patch},debug:{type:"boolean",description:"additional information about processes inside this tool",default:t.debug},"another-array-type":{type:"boolean",description:"generate array types as Array<Type> (by default Type[])",default:t.anotherArrayType},"sort-types":{type:"boolean",description:"sort fields and types",default:t.sortTypes},"extract-enums":{type:"boolean",description:"extract all enums from inline interface/type content to typescript enum construction",default:t.extractEnums},"sort-routes":{type:"boolean",description:"sort routes in alphabetical order",default:t.sortRoutes},"custom-config":{type:"string",description:"custom config: primitiveTypeConstructs, hooks, ... "}},run:async({args:e})=>{let a;if(e["custom-config"])try{let s=f.pathToFileURL(i.resolve(process.cwd(),e["custom-config"])).toString();a=await import(s),a=a.default||a,a&&consola.info(`Found custom config at: ${s}`);}catch(s){consola.error("Error loading custom config:",s);}await g({addReadonly:e["add-readonly"],anotherArrayType:e["another-array-type"],apiClassName:e["api-class-name"],cleanOutput:e["clean-output"],debug:e.debug,defaultResponseAsSuccess:e["default-as-success"],defaultResponseType:e["default-response"],disableThrowOnError:e["disable-throw-on-error"],enumNamesAsValues:e["enum-names-as-values"],extractEnums:e["extract-enums"],extractRequestBody:e["extract-request-body"],extractRequestParams:e["extract-request-params"],extractResponseBody:e["extract-response-body"],extractResponseError:e["extract-response-error"],extractResponses:e["extract-responses"],fileName:e.name,generateClient:!(e.axios||e["no-client"]),generateResponses:e.responses,generateRouteTypes:e["route-types"],generateUnionEnums:e["union-enums"],httpClientType:e["http-client"]||e.axios?b$1.AXIOS:b$1.FETCH,input:i.resolve(process.cwd(),e.path),modular:e.modular,moduleNameFirstTag:e["module-name-first-tag"],moduleNameIndex:+e["module-name-index"]||0,output:i.resolve(process.cwd(),e.output||"."),patch:e.patch,silent:e.silent,singleHttpClient:e["single-http-client"],sortRoutes:e["sort-routes"],sortTypes:e["sort-types"],templates:e.templates,toJS:e.js,typePrefix:e["type-prefix"],typeSuffix:e["type-suffix"],unwrapResponseData:e["unwrap-response-data"],url:e.path,...a});}}),x=defineCommand({meta:{name:a.name,description:a.description,version:a.version},subCommands:{generate:h,"generate-templates":b}});runMain(x);//# sourceMappingURL=cli.js.map
+#!/usr/bin/env node
+import {e,f as f$1,b as b$1,d,a,g}from'./chunk-TXFFSIK5.js';import*as i from'node:path';import*as f from'node:url';import {defineCommand,runMain}from'citty';import {consola}from'consola';var o=new e({}),b=defineCommand({meta:{name:"generate-templates",description:'Generate ".ejs" templates needed for generate api'},args:{"clean-output":{type:"boolean",description:"clean output folder before generate template. WARNING: May cause data loss",default:o.cleanOutput},"http-client":{type:"string",description:`http client type (possible values: ${Object.values(b$1)})`,default:o.httpClientType},modular:{type:"boolean",description:"generate templates needed to separate files for http client, data contracts, and routes",default:o.modular},output:{type:"string",alias:"o",description:"output path of generated templates",default:o.output},rewrite:{type:"boolean",alias:"r",description:"rewrite content in existing templates",default:o.rewrite},silent:{type:"boolean",description:"Output only errors to console",default:o.silent},debug:{type:"boolean",description:"additional information about processes inside this tool",default:o.debug}},run:async({args:e})=>{await f$1({cleanOutput:e["clean-output"],httpClientType:e["http-client"],modular:e.modular,output:e.output,rewrite:e.rewrite,silent:e.silent,debug:e.debug});}}),t=new d({}),h=defineCommand({meta:{name:"generate",description:a.description},args:{path:{type:"string",alias:"p",description:"path/url to swagger scheme",required:true},output:{type:"string",alias:"o",description:"output path of typescript api file",default:"./"},name:{type:"string",alias:"n",description:"name of output typescript api file",default:t.fileName},templates:{type:"string",alias:"t",description:"path to folder containing templates"},"default-as-success":{type:"boolean",alias:"d",description:'use "default" response status code as success response too. some swagger schemas use "default" response status code as success response type by default.',default:t.defaultResponseAsSuccess},responses:{type:"boolean",alias:"r",description:"generate additional information about request responses also add typings for bad responses",default:t.generateResponses},"union-enums":{type:"boolean",description:'generate all "enum" types as union types (T1 | T2 | TN)',default:t.generateUnionEnums},"add-readonly":{type:"boolean",description:"generate readonly properties",default:t.addReadonly},"route-types":{type:"boolean",description:"generate type definitions for API routes",default:t.generateRouteTypes},"no-client":{type:"boolean",description:"do not generate an API class",default:t.generateClient},"enum-names-as-values":{type:"boolean",description:"use values in 'x-enumNames' as enum values (not only as keys)",default:t.enumNamesAsValues},"extract-request-params":{description:"extract request params to data contract (Also combine path params and query params into one object)",default:t.extractRequestParams},"extract-request-body":{type:"boolean",description:"extract request body type to data contract",default:t.extractRequestBody},"extract-response-body":{type:"boolean",description:"extract response body type to data contract",default:t.extractResponseBody},"extract-response-error":{type:"boolean",description:"extract response error type to data contract",default:t.extractResponseError},"extract-responses":{type:"boolean",description:"extract all responses described in /components/responses",default:t.extractResponses},modular:{type:"boolean",description:"generate separated files for http client, data contracts, and routes",default:t.modular},js:{type:"boolean",description:"generate js api module with declaration file",default:t.toJS},"module-name-index":{type:"string",description:"determines which path index should be used for routes separation (example: GET:/fruits/getFruit -> index:0 -> moduleName -> fruits)",default:t.moduleNameIndex.toString()},"module-name-first-tag":{type:"boolean",description:"splits routes based on the first tag",default:t.moduleNameFirstTag},axios:{type:"boolean",description:"generate axios http client",default:false},"unwrap-response-data":{type:"boolean",description:"unwrap the data item from the response",default:t.unwrapResponseData},"disable-throw-on-error":{type:"boolean",description:"Do not throw an error when response.ok is not true",default:t.disableThrowOnError},"single-http-client":{type:"boolean",description:"Ability to send HttpClient instance to Api constructor",default:t.singleHttpClient},silent:{type:"boolean",description:"Output only errors to console",default:t.silent},"default-response":{type:"string",description:"default type for empty response schema",default:t.defaultResponseType},"type-prefix":{type:"string",description:"data contract name prefix",default:t.typePrefix},"type-suffix":{type:"string",description:"data contract name suffix",default:t.typeSuffix},"clean-output":{type:"boolean",description:"clean output folder before generate api. WARNING: May cause data loss",default:t.cleanOutput},"api-class-name":{type:"string",description:"name of the api class",default:t.apiClassName},patch:{type:"boolean",description:"fix up small errors in the swagger source definition",default:t.patch},debug:{type:"boolean",description:"additional information about processes inside this tool",default:t.debug},"another-array-type":{type:"boolean",description:"generate array types as Array<Type> (by default Type[])",default:t.anotherArrayType},"sort-types":{type:"boolean",description:"sort fields and types",default:t.sortTypes},"extract-enums":{type:"boolean",description:"extract all enums from inline interface/type content to typescript enum construction",default:t.extractEnums},"sort-routes":{type:"boolean",description:"sort routes in alphabetical order",default:t.sortRoutes},"custom-config":{type:"string",description:"custom config: primitiveTypeConstructs, hooks, ... "}},run:async({args:e})=>{let a;if(e["custom-config"])try{let s=f.pathToFileURL(i.resolve(process.cwd(),e["custom-config"])).toString();a=await import(s),a=a.default||a,a&&consola.info(`Found custom config at: ${s}`);}catch(s){consola.error("Error loading custom config:",s);}await g({addReadonly:e["add-readonly"],anotherArrayType:e["another-array-type"],apiClassName:e["api-class-name"],cleanOutput:e["clean-output"],debug:e.debug,defaultResponseAsSuccess:e["default-as-success"],defaultResponseType:e["default-response"],disableThrowOnError:e["disable-throw-on-error"],enumNamesAsValues:e["enum-names-as-values"],extractEnums:e["extract-enums"],extractRequestBody:e["extract-request-body"],extractRequestParams:e["extract-request-params"],extractResponseBody:e["extract-response-body"],extractResponseError:e["extract-response-error"],extractResponses:e["extract-responses"],fileName:e.name,generateClient:!(e.axios||e["no-client"]),generateResponses:e.responses,generateRouteTypes:e["route-types"],generateUnionEnums:e["union-enums"],httpClientType:e["http-client"]||e.axios?b$1.AXIOS:b$1.FETCH,input:i.resolve(process.cwd(),e.path),modular:e.modular,moduleNameFirstTag:e["module-name-first-tag"],moduleNameIndex:+e["module-name-index"]||0,output:i.resolve(process.cwd(),e.output||"."),patch:e.patch,silent:e.silent,singleHttpClient:e["single-http-client"],sortRoutes:e["sort-routes"],sortTypes:e["sort-types"],templates:e.templates,toJS:e.js,typePrefix:e["type-prefix"],typeSuffix:e["type-suffix"],unwrapResponseData:e["unwrap-response-data"],url:e.path,...a});}}),x=defineCommand({meta:{name:a.name,description:a.description,version:a.version},subCommands:{generate:h,"generate-templates":b}});runMain(x);//# sourceMappingURL=cli.js.map
 //# sourceMappingURL=cli.js.map

dist/lib.js

@@ -1,2 +0,2 @@
-export{c as constants,g as generateApi,f as generateTemplates}from'./chunk-FXBGNN2X.js';//# sourceMappingURL=lib.js.map
+export{c as constants,g as generateApi,f as generateTemplates}from'./chunk-TXFFSIK5.js';//# sourceMappingURL=lib.js.map
 //# sourceMappingURL=lib.js.map

package.json

 {
   "name": "swagger-typescript-api",
-  "version": "13.0.24",
+  "version": "13.0.25",
   "description": "Generate the API client for Fetch or Axios from an OpenAPI Specification",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/acacode/swagger-typescript-api",

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 2 instances in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

841287

0.4%

Lines of code

692

0.44%

No dependency changes