Release 9.2.0 (#278)

* added --unwrap-response-data to unwrap the data item from the response (#268)

* added --unwrap-response-data to unwrap the data item from the response

* add axios --unwrap-response-data

Co-authored-by: Christian Zangl <[email protected]>

* fix: formdata in axios template (#277)

Co-authored-by: Tiago Kaneta <[email protected]>

* Feature: add full response typing for status code, data and headers. (#272)

This commit adds additional type information to the route's response
object that allows types to be created that express the combination
of status code, data and headers for each response.

This type information can be used to "narrow" a response type based on
an HTTP status code. This narrowing is useful since it can prevent type
mismatches where a status code is presumed to have one type but in actuality
it returns another.

Additionally, response headers are now associated with data types and status
codes rather than being free form.

A caveat right now is that only there are no response codes like 3XX or
5XX, every code must be explicitly listed.

* bump: up version to 9.2.0

Co-authored-by: Christian Zangl <[email protected]>
Co-authored-by: Christian Zangl <[email protected]>
Co-authored-by: Tiago Surjus Kaneta <[email protected]>
Co-authored-by: Tiago Kaneta <[email protected]>
Co-authored-by: Rusty Conover <[email protected]>

Author: 6 people

CHANGELOG.md

@@ -1,5 +1,14 @@
 # next release  
 
+# 9.2.0  
+
+Features:  
+- full response typing for status code, data and headers. (#272, thanks @rustyconover)  
+- --unwrap-response-data to unwrap the data item from the response (#268, thanks @laktak)  
+
+Fixes:  
+- fix: formdata in axios template (#277, thanks @tiagoskaneta)  
+
 # 9.1.2
 
 Fixes:  

index.js

@@ -66,6 +66,7 @@ program
   .option("--disableStrictSSL", "disabled strict SSL", false)
   .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("--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)
@@ -100,6 +101,7 @@ const {
   disableProxy,
   cleanOutput,
   defaultResponse,
+  unwrapResponseData,
   singleHttpClient,
   axios,
   silent,
@@ -115,6 +117,7 @@ generateApi({
   httpClientType: axios ? HTTP_CLIENT.AXIOS : HTTP_CLIENT.FETCH,
   defaultResponseAsSuccess: defaultAsSuccess,
   defaultResponseType: defaultResponse,
+  unwrapResponseData: unwrapResponseData,
   generateUnionEnums: unionEnums,
   generateResponses: responses,
   extractRequestParams: !!extractRequestParams,

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "9.1.2",
+  "version": "9.2.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",

package.json

@@ -58,6 +58,7 @@ const config = {
   defaultResponseType: TS_KEYWORDS.VOID,
   singleHttpClient: false,
   httpClientType: HTTP_CLIENT.FETCH,
+  unwrapResponseData: false,
   templatePaths: {
     /** `templates/base` */
     base: "",

src/config.js

@@ -44,6 +44,7 @@ module.exports = {
     extractRequestParams = config.extractRequestParams,
     extractRequestBody = config.extractRequestBody,
     defaultResponseType = config.defaultResponseType,
+    unwrapResponseData = config.unwrapResponseData,
     singleHttpClient = config.singleHttpClient,
     prettier: prettierOptions = constants.PRETTIER_OPTIONS,
     hooks: rawHooks,
@@ -77,6 +78,7 @@ module.exports = {
         disableProxy,
         cleanOutput,
         defaultResponseType,
+        unwrapResponseData,
         singleHttpClient,
         constants,
         silent,

src/index.js

@@ -2,6 +2,7 @@ const _ = require("lodash");
 const {
   types,
   parseSchema,
+  getType,
   getRefType,
   getInlineParseContent,
   checkAndAddNull,
@@ -475,6 +476,21 @@ const getResponseBodyInfo = (routeInfo, routeParams, parsedSchemas) => {
     (response) => !response.isSuccess && response.type !== TS_KEYWORDS.ANY,
   );
 
+  const handleResponseHeaders = (src) => {
+    if (!src) {
+      return "headers: {},";
+    }
+    const headerTypes = Object.fromEntries(
+      Object.entries(src).map(([k, v]) => {
+        return [k, getType(v)];
+      }),
+    );
+    const r = `headers: { ${Object.entries(headerTypes)
+      .map(([k, v]) => `"${k}": ${v}`)
+      .join(",")} },`;
+    return r;
+  };
+
   return {
     contentTypes,
     responses: responseInfos,
@@ -486,6 +502,19 @@ const getResponseBodyInfo = (routeInfo, routeParams, parsedSchemas) => {
       schemas: errorResponses,
       type: _.uniq(errorResponses.map((response) => response.type)).join(" | ") || TS_KEYWORDS.ANY,
     },
+    full: {
+      types:
+        responseInfos
+          .map(
+            (response) => `{
+      data: ${response.type}, status: ${response.status}, statusCode: ${
+              response.status
+            }, statusText: "${response.description}", ${handleResponseHeaders(
+              response.headers,
+            )} config: {} }`,
+          )
+          .join(" | ") || TS_KEYWORDS.ANY,
+    },
   };
 };
 
@@ -685,6 +714,7 @@ const parseRoutes = ({
               contentTypes: responseBodyInfo.contentTypes,
               type: responseBodyInfo.success.type,
               errorType: responseBodyInfo.error.type,
+              fullTypes: responseBodyInfo.full.types,
             },
             raw: rawRouteInfo,
           };

src/routes.js

@@ -1,5 +1,5 @@
 <%
-const { apiConfig, generateResponses } = it;
+const { apiConfig, generateResponses, config } = it;
 %>
 
 import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
@@ -89,7 +89,11 @@ export class HttpClient<SecurityDataType = unknown> {
         format,
         body,
         ...params
+<% if (config.unwrapResponseData) { %>
+    }: FullRequestParams): Promise<T> => {
+<% } else { %>
     }: FullRequestParams): Promise<AxiosResponse<T>> => {
+<% } %>
         const secureParams = ((typeof secure === 'boolean' ? secure : this.secure) && this.securityWorker && (await this.securityWorker(this.securityData))) || {};
         const requestParams = this.mergeRequestParams(params, secureParams);
         const responseFormat = (format && this.format) || void 0;
@@ -99,7 +103,7 @@ export class HttpClient<SecurityDataType = unknown> {
           requestParams.headers.post = {};
           requestParams.headers.put = {};
 
-          const formData = this.createFormData(body as Record<string, unknown>);
+          body = this.createFormData(body as Record<string, unknown>);
         }
 
         return this.instance.request({
@@ -112,6 +116,10 @@ export class HttpClient<SecurityDataType = unknown> {
             responseType: responseFormat,
             data: body,
             url: path,
+<% if (config.unwrapResponseData) { %>
+        }).then(response => response.data);
+<% } else { %>
         });
+<% } %>
     };
 }

templates/base/http-clients/axios-http-client.eta

@@ -1,5 +1,5 @@
 <%
-const { apiConfig, generateResponses } = it;
+const { apiConfig, generateResponses, config } = it;
 %>
 
 export type QueryParamsType = Record<string | number, any>;
@@ -164,7 +164,11 @@ export class HttpClient<SecurityDataType = unknown> {
         baseUrl,
         cancelToken,
         ...params
+<% if (config.unwrapResponseData) { %>
+    }: FullRequestParams): Promise<T> => {
+<% } else { %>
     }: FullRequestParams): Promise<HttpResponse<T, E>> => {
+<% } %>
         const secureParams = ((typeof secure === 'boolean' ? secure : this.baseApiParams.secure) && this.securityWorker && await this.securityWorker(this.securityData)) || {};
         const requestParams = this.mergeRequestParams(params, secureParams);
         const queryString = query && this.toQueryString(query);
@@ -206,7 +210,11 @@ export class HttpClient<SecurityDataType = unknown> {
             }
 
             if (!response.ok) throw data;
+<% if (config.unwrapResponseData) { %>
+            return data.data;
+<% } else { %>
             return data;
+<% } %>
         });
     };
 }

templates/base/http-clients/fetch-http-client.eta

@@ -1547,7 +1547,7 @@ export class HttpClient<SecurityDataType = unknown> {
       requestParams.headers.post = {};
       requestParams.headers.put = {};
 
-      const formData = this.createFormData(body as Record<string, unknown>);
+      body = this.createFormData(body as Record<string, unknown>);
     }
 
     return this.instance.request({

tests/spec/axios/schema.ts

@@ -1547,7 +1547,7 @@ export class HttpClient<SecurityDataType = unknown> {
       requestParams.headers.post = {};
       requestParams.headers.put = {};
 
-      const formData = this.createFormData(body as Record<string, unknown>);
+      body = this.createFormData(body as Record<string, unknown>);
     }
 
     return this.instance.request({

tests/spec/axiosSingleHttpClient/schema.ts

@@ -34,7 +34,7 @@ export class HttpClient {
         requestParams.headers.common = { Accept: "*/*" };
         requestParams.headers.post = {};
         requestParams.headers.put = {};
-        const formData = this.createFormData(body);
+        body = this.createFormData(body);
       }
       return this.instance.request({
         ...requestParams,