Release 6.1.1 (Bugfix) (#186)

* internal: beatify output for spec tests

* docs: update title text in README

* bump: 6.1.1 version; fix: --axios, --modular options

Author: js2me

CHANGELOG.md

@@ -1,5 +1,14 @@
 # next release  
 
+# 6.1.1  
+
+Fixes:  
+- Problems with `--axios` option  
+  - ignoring `path`, `format`, `type` payload properties in `request()` method of `HttpClient`  
+- Missing `format` property for requests in `--modular` option  
+
+# 6.1.0  
+
 Features:  
 - `--silent` option. Output only errors to console (default: false)  
 

README.md

@@ -11,7 +11,7 @@
 
 Generate api via swagger scheme.  
 Supports OA 3.0, 2.0, JSON, yaml  
-Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to make requests.  
+Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests.  
 
 <br>
 <br>

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "swagger-typescript-api",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "Create typescript api module from swagger schema",
   "scripts": {
     "cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts --extract-request-params --enum-names-as-values",
@@ -32,6 +32,7 @@
     "test:--js": "node tests/spec/js/test.js",
     "test:--js--axios": "node tests/spec/jsAxios/test.js",
     "test:--axios": "node tests/spec/axios/test.js",
+    "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
     "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"
   },

package.json

@@ -1,12 +1,11 @@
 <%
 const { apiConfig, generateResponses } = it;
 %>
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
 
 export type QueryParamsType = Record<string | number, any>;
-export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
 
-export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params"> {
+export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
   /** set parameter to `true` for call `securityWorker` for this request */
   secure?: boolean;
   /** request path */
@@ -16,7 +15,7 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
   /** query params */
   query?: QueryParamsType;
   /** format of response (i.e. response.json() -> format: "json") */
-  format?: keyof Omit<Body, "body" | "bodyUsed">;
+  format?: ResponseType;
   /** request body */
   body?: unknown;
 }
@@ -77,7 +76,9 @@ export class HttpClient<SecurityDataType = unknown> {
                 ...(requestParams.headers || {}),
             },
             params: query,
+            responseType: format,
             data: body,
+            url: path,
         });
     };
 }

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

@@ -15,7 +15,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
   /** query params */
   query?: QueryParamsType;
   /** format of response (i.e. response.json() -> format: "json") */
-  format?: keyof Omit<Body, "body" | "bodyUsed">;
+  format?: ResponseFormat;
   /** request body */
   body?: unknown;
   /** base url */

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

@@ -7,6 +7,7 @@ const { type, errorType, contentTypes } = route.response;
 const routeDocs = includeFile("@base/route-docs", { config, route, utils });
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
+const isFetchTemplate = config.httpClientType === config.constants.HTTP_CLIENT.FETCH;
 
 const requestConfigParam = {
     name: pathParams.some((pathArg) => pathArg.name === "params") ? "requestParams" : "params",
@@ -51,7 +52,7 @@ const requestContentKind = {
 const responseContentKind = {
     "JSON": '"json"',
     "IMAGE": '"blob"',
-    "FORM_DATA": '"formData"'
+    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
 }
 
 const bodyTmpl = _.get(payload, "name") || null;

templates/default/procedure-call.eta

@@ -7,6 +7,7 @@ const { type, errorType, contentTypes } = route.response;
 const routeDocs = includeFile("@base/route-docs", { config, route, utils });
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
+const isFetchTemplate = config.httpClientType === config.constants.HTTP_CLIENT.FETCH;
 
 const requestConfigParam = {
     name: pathParams.some((pathArg) => pathArg.name === "params") ? "requestParams" : "params",
@@ -51,7 +52,7 @@ const requestContentKind = {
 const responseContentKind = {
     "JSON": '"json"',
     "IMAGE": '"blob"',
-    "FORM_DATA": '"formData"'
+    "FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
 }
 
 const bodyTmpl = _.get(payload, "name") || null;
@@ -90,5 +91,6 @@ const describeReturnType = () => {
         <%~ bodyTmpl ? `body: ${bodyTmpl},` : '' %>
         <%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
         <%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
+        <%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
         ...<%~ _.get(requestConfigParam, "name") %>,
     })

templates/modular/procedure-call.eta

@@ -177,7 +177,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
   /** query params */
   query?: QueryParamsType;
   /** format of response (i.e. response.json() -> format: "json") */
-  format?: keyof Omit<Body, "body" | "bodyUsed">;
+  format?: ResponseFormat;
   /** request body */
   body?: unknown;
   /** base url */

tests/generated/v2.0/adafruit.ts

@@ -153,7 +153,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
   /** query params */
   query?: QueryParamsType;
   /** format of response (i.e. response.json() -> format: "json") */
-  format?: keyof Omit<Body, "body" | "bodyUsed">;
+  format?: ResponseFormat;
   /** request body */
   body?: unknown;
   /** base url */