swagger-typescript-api 9.2.0 → 10.0.0

package/CHANGELOG.md

@@ -1,5 +1,38 @@
 # next release  
 
+# 10.0.0  
+
+- `--extract-response-body` option - extract response body type to data contract  
+- `--extract-response-error` option - extract response error type to data contract   
+- `--add-readonly` option - generate readonly properties  
+- `authorizationToken` for axios fetch swagger schema request  
+- fix: change COMPLEX_NOT_OF to COMPLEX_NOT (internal)
+- feat: improve `@deprecated` jsdoc info
+- feat: improve `required` field in complex data schemas (anyOf, oneOf, allOf etc)  
+- feat: abortSignal for fetch http client
+- chore: improve typings in index.d.ts
+- fixed [Request falls if FormData attachment is File instance](https://github.com/acacode/swagger-typescript-api/issues/293)
+- fixed [Response format - global default or override ?](https://github.com/acacode/swagger-typescript-api/issues/251)
+
+> Co-authored-by: Sergey S. Volkov <js2me@outlook.com>  
+> Co-authored-by: Xavier Cassel <57092100+xcassel@users.noreply.github.com>  
+> Co-authored-by: cassel <xavier.cassel35@gmail.com>  
+> Co-authored-by: Adrian Wieprzkowicz <Argeento@users.noreply.github.com>  
+> Co-authored-by: EvgenBabenko <evgen.babenko@gmail.com>  
+> Co-authored-by: RoCat <catoio.romain@gmail.com>  
+> Co-authored-by: rcatoio <rcatoio@doubletrade.com>  
+> Co-authored-by: 卡色 <cipchk@qq.com>  
+> Co-authored-by: 江麻妞 <50100681+jiangmaniu@users.noreply.github.com>  
+> Co-authored-by: Kasper Moskwiak <kasper.moskwiak@gmail.com>  
+> Co-authored-by: Ben Watkins <ben@outdatedversion.com>  
+> Co-authored-by: bonukai <bonukai@protonmail.com>  
+> Co-authored-by: baggoedw <92381702+baggoedw@users.noreply.github.com>  
+> Co-authored-by: Marcus Dunn <51931484+MarcusDunn@users.noreply.github.com>  
+> Co-authored-by: Daniele De Matteo <daniele@kuama.net>  
+> Co-authored-by: Daniel Playfair Cal <daniel.playfair.cal@gmail.com>  
+> Co-authored-by: Anders Cassidy <anders.cassidy@dailypay.com>  
+> Co-authored-by: Daniel Playfair Cal <dcal@atlassian.com>  
+
 # 9.2.0  
 
 Features:  

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

@@ -19,7 +19,11 @@ Any questions you can ask [**here**](https://github.com/acacode/swagger-typescri
   
 <br>  
 
-![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/components-converter-example.jpg)  
+![](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  
 
 ## 👀 Examples  
 
@@ -38,32 +42,34 @@ Options:
   -n, --name <name>             name of output typescript api file (default: "Api.ts")
   -t, --templates <path>        path to folder containing templates
   -d, --default-as-success      use "default" response status code as success response too.
-                                some swagger schemas use "default" response status code
-                                as success response type by default. (default: false)
+                                some swagger schemas use "default" response status code as success response type by default. (default: false)
   -r, --responses               generate additional information about request responses
                                 also add typings for bad responses (default: false)
   --union-enums                 generate all "enum" types as union types (T1 | T2 | TN) (default: false)
+  --add-readonly                generate readonly properties (default: false)
   --route-types                 generate type definitions for API routes (default: false)
   --no-client                   do not generate an API class
   --enum-names-as-values        use values in 'x-enumNames' as enum values (not only as keys) (default: false)
-  --js                          generate js api module with declaration file (default: false)
-  --extract-request-params      extract request params to data contract (default: false)
-                                Also combine path params and query params into one object
-  --extract-request-body        extract request body type to data contract (default: false)                         
-  --module-name-index <number>  determines which path index should be used for routes separation (default: 0)
-                                (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites)
-  --module-name-first-tag       splits routes based on the first tag
+  --extract-request-params      extract request params to data contract (Also combine path params and query params into one object) (default: false)
+  --extract-request-body        extract request body type to data contract (default: false)
+  --extract-response-body       extract response body type to data contract (default: false)
+  --extract-response-error      extract response error type to data contract (default: false)
   --modular                     generate separated files for http client, data contracts, and routes (default: false)
+  --js                          generate js api module with declaration file (default: false)
+  --module-name-index <number>  determines which path index should be used for routes separation (example: GET:/fruites/getFruit -> index:0 -> moduleName -> fruites) (default: 0)
+  --module-name-first-tag       splits routes based on the first tag (default: false)
   --disableStrictSSL            disabled strict SSL (default: false)
   --disableProxy                disabled proxy (default: false)
-  --clean-output                clean output folder before generate api. WARNING: May cause data loss (default: false)
   --axios                       generate axios http client (default: false)
+  --unwrap-response-data        unwrap the data item from the response (default: false)
+  --disable-throw-on-error      Do not throw an error when response.ok is not true (default: false)
   --single-http-client          Ability to send HttpClient instance to Api constructor (default: false)
   --silent                      Output only errors to console (default: false)
   --default-response <type>     default type for empty response schema (default: "void")
   --type-prefix <string>        data contract name prefix (default: "")
   --type-suffix <string>        data contract name suffix (default: "")
-  -h, --help                    display help for command
+  --clean-output                clean output folder before generate api. WARNING: May cause data loss (default: false)
+  --patch                       fix up small errors in the swagger source definition (default: false)
 ```
 
 Also you can use `npx`:  
@@ -99,7 +105,7 @@ generateApi({
   toJS: false,
   extractRequestParams: false,
   extractRequestBody: false,
-  prettier: {
+  prettier: { // By default prettier config is load from your project
     printWidth: 120,
     tabWidth: 2,
     trailingComma: "all",

package/index.d.ts

@@ -1,19 +1,4 @@
-interface GenerateApiParams {
-  /**
-   * path to swagger schema
-   */
-  input: string;
-
-  /**
-   * url to swagger schema
-   */
-  url: string;
-
-  /**
-   * swagger schema JSON
-   */
-  spec: import("swagger-schema-official").Spec;
-
+interface GenerateApiParamsBase {
   /**
    * default 'api.ts'
    */
@@ -25,7 +10,7 @@ interface GenerateApiParams {
   output?: string;
 
   /**
-   * path to folder containing templates (default: ./scr/templates)
+   * path to folder containing templates (default: ./src/templates)
    */
   templates?: string;
 
@@ -88,6 +73,18 @@ interface GenerateApiParams {
    * extract request params to data contract (Also combine path params and query params into one object)
    */
   extractRequestParams?: boolean;
+  /**
+   * extract request body type to data contract
+   */
+  extractRequestBody?: boolean;
+  /**
+   * extract response body type to data contract
+   */
+  extractResponseBody?: boolean;
+  /**
+   * extract response error type to data contract
+   */
+  extractResponseError?: boolean;
   /**
    * prettier configuration
    */
@@ -112,8 +109,40 @@ interface GenerateApiParams {
    *  extra templates
    */
   extraTemplates?: { name: string; path: string }[];
+
+  /**
+   * fix up small errors in the swagger source definition
+   */
+  patch?: boolean;
+  /**
+   *  authorization token
+   */
+  authorizationToken?: string;
+}
+
+interface GenerateApiParamsFromPath extends GenerateApiParamsBase {
+  /**
+   * path to swagger schema
+   */
+  input: string;
+}
+
+interface GenerateApiParamsFromUrl extends GenerateApiParamsBase {
+  /**
+   * url to swagger schema
+   */
+  url: string;
+}
+
+interface GenerateApiParamsFromSpecLiteral extends GenerateApiParamsBase {
+  /**
+   * swagger schema JSON
+   */
+  spec: import("swagger-schema-official").Spec;
 }
 
+export type GenerateApiParams = GenerateApiParamsFromPath | GenerateApiParamsFromUrl | GenerateApiParamsFromSpecLiteral;
+
 export interface Hooks {
   /** calls after parse schema component */
   onCreateComponent: (component: SchemaComponent) => SchemaComponent | void;
@@ -126,14 +155,9 @@ export interface Hooks {
   /** customize configuration object before sending it to ETA templates */
   onPrepareConfig?: <C extends GenerateApiConfiguration>(currentConfiguration: C) => C | void;
   /** customize route name as you need */
-  onCreateRouteName?: (
-    routeNameInfo: RouteNameInfo,
-    rawRouteInfo: RawRouteInfo,
-  ) => RouteNameInfo | void;
+  onCreateRouteName?: (routeNameInfo: RouteNameInfo, rawRouteInfo: RawRouteInfo) => RouteNameInfo | void;
   /** customize request params (path params, query params) */
-  onCreateRequestParams?: (
-    rawType: SchemaComponent["rawTypeData"],
-  ) => SchemaComponent["rawTypeData"] | void;
+  onCreateRequestParams?: (rawType: SchemaComponent["rawTypeData"]) => SchemaComponent["rawTypeData"] | void;
   /** customize name of model type */
   onFormatTypeName?: (typeName: string, rawTypeName?: string) => string | void;
   /** customize name of route (operationId), you can do it with using onCreateRouteName too */
@@ -210,14 +234,10 @@ export interface SchemaComponent {
     discriminator?: {
       propertyName?: string;
     };
-    $parsed: ParsedSchema<
-      SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent
-    >;
+    $parsed: ParsedSchema<SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent>;
   };
   componentName: string;
-  typeData: ParsedSchema<
-    SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent
-  > | null;
+  typeData: ParsedSchema<SchemaTypeObjectContent | SchemaTypeEnumContent | SchemaTypePrimitiveContent> | null;
 }
 
 export enum RequestContentKind {
@@ -323,6 +343,7 @@ export interface GenerateApiConfiguration {
       routeName: string;
     };
     routeNameDuplicatesMap: Map<string, string>;
+    apiClassName: string
   };
   modelTypes: ModelType[];
   rawModelTypes: SchemaComponent[];
@@ -341,10 +362,7 @@ export interface GenerateApiConfiguration {
     formatDescription: (description: string, inline?: boolean) => string;
     internalCase: (value: string) => string;
     classNameCase: (value: string) => string;
-    getInlineParseContent: (
-      rawTypeData: SchemaComponent["rawTypeData"],
-      typeName?: string,
-    ) => string;
+    getInlineParseContent: (rawTypeData: SchemaComponent["rawTypeData"], typeName?: string) => string;
     getParseContent: (rawTypeData: SchemaComponent["rawTypeData"], typeName?: string) => ModelType;
     getComponentByRef: (ref: string) => SchemaComponent;
     parseSchema: (
@@ -352,14 +370,8 @@ export interface GenerateApiConfiguration {
       typeName?: string,
       formattersMap?: Record<MAIN_SCHEMA_TYPES, (content: ModelType) => string>,
     ) => ModelType;
-    formatters: Record<
-      MAIN_SCHEMA_TYPES,
-      (content: string | object | string[] | object[]) => string
-    >;
-    inlineExtraFormatters: Record<
-      Exclude<MAIN_SCHEMA_TYPES, SCHEMA_TYPES.PRIMITIVE>,
-      (schema: ModelType) => string
-    >;
+    formatters: Record<MAIN_SCHEMA_TYPES, (content: string | object | string[] | object[]) => string>;
+    inlineExtraFormatters: Record<Exclude<MAIN_SCHEMA_TYPES, SCHEMA_TYPES.PRIMITIVE>, (schema: ModelType) => string>;
     formatModelName: (name: string) => string;
     fmtToJSDocLine: (line: string, params?: { eol?: boolean }) => string;
     _: import("lodash").LoDashStatic;
@@ -370,12 +382,7 @@ export interface GenerateApiConfiguration {
 export interface GenerateApiOutput {
   configuration: GenerateApiConfiguration;
   files: { name: string; content: string; declaration: { name: string; content: string } | null }[];
-  createFile: (params: {
-    path: string;
-    fileName: string;
-    content: string;
-    withPrefix?: boolean;
-  }) => void;
+  createFile: (params: { path: string; fileName: string; content: string; withPrefix?: boolean }) => void;
   renderTemplate: (
     templateContent: string,
     data: Record<string, unknown>,
@@ -385,12 +392,4 @@ export interface GenerateApiOutput {
   formatTSContent: (content: string) => string;
 }
 
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "url" | "spec">,
-): Promise<GenerateApiOutput>;
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "input" | "spec">,
-): Promise<GenerateApiOutput>;
-export declare function generateApi(
-  params: Omit<GenerateApiParams, "input" | "url">,
-): Promise<GenerateApiOutput>;
+export declare function generateApi(params: GenerateApiParams): Promise<GenerateApiOutput>;

package/index.js

@@ -33,29 +33,23 @@ program
   )
   .option(
     "-r, --responses",
-    "generate additional information about request responses\n" +
-      "also add typings for bad responses",
+    "generate additional information about request responses\n" + "also add typings for bad responses",
     false,
   )
   .option("--union-enums", 'generate all "enum" types as union types (T1 | T2 | TN)', false)
+  .option("--add-readonly", "generate readonly properties", false)
   .option("--route-types", "generate type definitions for API routes", false)
   .option("--no-client", "do not generate an API class", false)
-  .option(
-    "--enum-names-as-values",
-    "use values in 'x-enumNames' as enum values (not only as keys)",
-    false,
-  )
+  .option("--enum-names-as-values", "use values in 'x-enumNames' as enum values (not only as keys)", false)
   .option(
     "--extract-request-params",
     "extract request params to data contract (Also combine path params and query params into one object)",
     false,
   )
   .option("--extract-request-body", "extract request body type to data contract", false)
-  .option(
-    "--modular",
-    "generate separated files for http client, data contracts, and routes",
-    false,
-  )
+  .option("--extract-response-body", "extract response body type to data contract", false)
+  .option("--extract-response-error", "extract response error type to data contract", false)
+  .option("--modular", "generate separated files for http client, data contracts, and routes", false)
   .option("--js", "generate js api module with declaration file", false)
   .option(
     "--module-name-index <number>",
@@ -67,74 +61,55 @@ program
   .option("--disableProxy", "disabled proxy", false)
   .option("--axios", "generate axios http client", false)
   .option("--unwrap-response-data", "unwrap the data item from the response", false)
+  .option("--disable-throw-on-error", "Do not throw an error when response.ok is not true", false)
   .option("--single-http-client", "Ability to send HttpClient instance to Api constructor", false)
   .option("--silent", "Output only errors to console", false)
   .option("--default-response <type>", "default type for empty response schema", TS_KEYWORDS.VOID)
   .option("--type-prefix <string>", "data contract name prefix", "")
   .option("--type-suffix <string>", "data contract name suffix", "")
-  .option(
-    "--clean-output",
-    "clean output folder before generate api. WARNING: May cause data loss",
-    false,
-  );
+  .option("--clean-output", "clean output folder before generate api. WARNING: May cause data loss", false)
+  .option("--patch", "fix up small errors in the swagger source definition", false);
 
 program.parse(process.argv);
 
-const {
-  path,
-  output,
-  name,
-  templates,
-  unionEnums,
-  routeTypes,
-  client,
-  defaultAsSuccess,
-  responses,
-  modular,
-  js,
-  moduleNameIndex,
-  moduleNameFirstTag,
-  extractRequestParams,
-  extractRequestBody,
-  enumNamesAsValues,
-  disableStrictSSL,
-  disableProxy,
-  cleanOutput,
-  defaultResponse,
-  unwrapResponseData,
-  singleHttpClient,
-  axios,
-  silent,
-  typePrefix,
-  typeSuffix,
-} = program;
-
 generateApi({
-  name,
-  url: path,
-  generateRouteTypes: routeTypes,
-  generateClient: !!(axios || client),
-  httpClientType: axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
-  defaultResponseAsSuccess: defaultAsSuccess,
-  defaultResponseType: defaultResponse,
-  unwrapResponseData: unwrapResponseData,
-  generateUnionEnums: unionEnums,
-  generateResponses: responses,
-  extractRequestParams: !!extractRequestParams,
-  extractRequestBody: !!extractRequestBody,
-  input: resolve(process.cwd(), path),
-  output: resolve(process.cwd(), output || "."),
-  templates,
-  modular: !!modular,
-  toJS: !!js,
-  enumNamesAsValues: enumNamesAsValues,
-  moduleNameIndex: +(moduleNameIndex || 0),
-  moduleNameFirstTag: moduleNameFirstTag,
-  disableStrictSSL: !!disableStrictSSL,
-  disableProxy: !!disableProxy,
-  singleHttpClient: !!singleHttpClient,
-  cleanOutput: !!cleanOutput,
-  silent: !!silent,
-  typePrefix,
-  typeSuffix,
+  name: program.name,
+  url: program.path,
+  generateRouteTypes: program.routeTypes,
+  generateClient: !!(program.axios || program.client),
+  httpClientType: program.axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
+  defaultResponseAsSuccess: program.defaultAsSuccess,
+  defaultResponseType: program.defaultResponse,
+  unwrapResponseData: program.unwrapResponseData,
+  disableThrowOnError: program.disableThrowOnError,
+  sortTypes: program.sortTypes,
+  generateUnionEnums: program.unionEnums,
+  addReadonly: program.addReadonly,
+  generateResponses: program.responses,
+  extractRequestParams: !!program.extractRequestParams,
+  extractRequestBody: !!program.extractRequestBody,
+  extractResponseBody: !!program.extractResponseBody,
+  extractResponseError: !!program.extractResponseError,
+  input: resolve(process.cwd(), program.path),
+  output: resolve(process.cwd(), program.output || "."),
+  templates: program.templates,
+  modular: !!program.modular,
+  toJS: !!program.js,
+  enumNamesAsValues: program.enumNamesAsValues,
+  moduleNameIndex: +(program.moduleNameIndex || 0),
+  moduleNameFirstTag: program.moduleNameFirstTag,
+  disableStrictSSL: !!program.disableStrictSSL,
+  disableProxy: !!program.disableProxy,
+  singleHttpClient: !!program.singleHttpClient,
+  cleanOutput: !!program.cleanOutput,
+  silent: !!program.silent,
+  typePrefix: program.typePrefix,
+  typeSuffix: program.typeSuffix,
+  patch: !!program.patch,
+  apiClassName,
+}).catch((err) => {
+  // NOTE collect all errors on top level and shows to users in any case
+  console.error(err);
+
+  process.exit(1);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "9.2.0",
+  "version": "10.0.0",
   "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",
@@ -23,6 +23,7 @@
     "test:--default-as-success": "node tests/spec/defaultAsSuccess/test.js",
     "test:--templates": "node tests/spec/templates/test.js",
     "test:--union-enums": "node tests/spec/unionEnums/test.js",
+    "test:--add-readonly": "node tests/spec/readonly/test.js",
     "test:--responses": "node tests/spec/responses/test.js",
     "test:specProperty": "node tests/spec/specProperty/test.js",
     "test:--module-name-index": "node tests/spec/moduleNameIndex/test.js",
@@ -31,6 +32,8 @@
     "test:--single-http-client": "node tests/spec/singleHttpClient/test.js",
     "test:--extract-request-params": "node tests/spec/extractRequestParams/test.js",
     "test:--extract-request-body": "node tests/spec/extractRequestBody/test.js",
+    "test:--extract-response-body": "node tests/spec/extractResponseBody/test.js",
+    "test:--extract-response-error": "node tests/spec/extractResponseError/test.js",
     "test:--enum-names-as-values": "node tests/spec/enumNamesAsValues/test.js",
     "test:--default-response": "node tests/spec/defaultResponse/test.js",
     "test:--js": "node tests/spec/js/test.js",
@@ -39,34 +42,37 @@
     "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
     "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
-    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"
+    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
+    "test:--patch": "node tests/spec/patch/test.js"
   },
   "author": "acacode",
   "license": "MIT",
   "typings": "./index.d.ts",
   "main": "src/index.js",
   "devDependencies": {
-    "@types/lodash": "^4.14.166",
+    "@types/axios": "^0.14.0",
+    "@types/lodash": "^4.14.182",
     "@types/node": "^15.0.2",
-    "@types/prettier": "^2.1.6",
-    "all-contributors-cli": "^6.19.0",
+    "@types/prettier": "^2.7.0",
+    "all-contributors-cli": "^6.20.0",
     "husky": "^4.3.6",
     "pretty-quick": "^3.1.0"
   },
   "dependencies": {
-    "@types/swagger-schema-official": "2.0.21",
-    "axios": "^0.21.1",
-    "commander": "^6.2.1",
-    "eta": "^1.12.1",
-    "js-yaml": "^4.0.0",
+    "axios": "^0.27.2",
+    "@types/swagger-schema-official": "2.0.22",
+    "commander": "^9.4.0",
+    "cosmiconfig": "^7.0.1",
+    "eta": "^1.12.3",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
     "make-dir": "^3.1.0",
-    "nanoid": "^3.1.22",
-    "node-emoji": "^1.10.0",
-    "prettier": "^2.2.1",
+    "nanoid": "^3.3.4",
+    "node-emoji": "^1.11.0",
+    "prettier": "^2.7.1",
     "swagger-schema-official": "2.0.0-bab6bed",
-    "swagger2openapi": "^7.0.5",
-    "typescript": "^4.2.4"
+    "swagger2openapi": "^7.0.8",
+    "typescript": "^4.7.4"
   },
   "bin": {
     "swagger-typescript-api": "index.js",

package/src/config.js

@@ -14,6 +14,8 @@ const config = {
   generateClient: true,
   /** CLI flag */
   generateUnionEnums: false,
+  /** CLI flag */
+  addReadonly: false,
   enumNamesAsValues: false,
   /** parsed swagger schema from getSwaggerObject() */
 
@@ -36,6 +38,8 @@ const config = {
   disableProxy: false,
   extractRequestParams: false,
   extractRequestBody: false,
+  extractResponseBody: false,
+  extractResponseError: false,
   fileNames: {
     dataContracts: "data-contracts",
     routeTypes: "route-types",
@@ -59,6 +63,8 @@ const config = {
   singleHttpClient: false,
   httpClientType: HTTP_CLIENT.FETCH,
   unwrapResponseData: false,
+  disableThrowOnError: false,
+  sortTypes: false,
   templatePaths: {
     /** `templates/base` */
     base: "",
@@ -83,7 +89,10 @@ const config = {
   silent: false,
   typePrefix: "",
   typeSuffix: "",
+  patch: false,
   componentTypeNameResolver: new NameResolver([]),
+  /** name of the main exported class */
+  apiClassName: "Api",
 };
 
 /** needs to use data everywhere in project */