swagger-typescript-api 9.2.0 → 10.0.0

package/src/swagger.js

@@ -17,8 +17,8 @@ const parseSwaggerFile = (file) => {
   }
 };
 
-const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
-  new Promise((resolve) => {
+const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy, authorizationToken) =>
+  new Promise((resolve, reject) => {
     if (pathIsExist(pathToSwagger)) {
       logger.log(`try to get swagger by path "${pathToSwagger}"`);
       resolve(getFileContent(pathToSwagger));
@@ -33,21 +33,40 @@ const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disablePr
         });
       }
       //
+      if (authorizationToken) {
+        axiosOptions.headers = {
+          Authorization: authorizationToken,
+        };
+      }
+      //
       if (disableProxy) axiosOptions.proxy = false;
       //
       axios
         .get(urlToSwagger, axiosOptions)
         .then((res) => resolve(res.data))
-        .catch((err) => logger.error(`error while getting swagger by URL ${urlToSwagger}:`, err));
+        .catch((error) => {
+          const message = `error while getting swagger by URL ${urlToSwagger}`;
+
+          logger.error(message, "response" in error ? error.response : error);
+
+          reject(message);
+        });
     }
   });
 
-const getSwaggerObject = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
-  getSwaggerFile(pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy).then((file) =>
-    convertSwaggerObject(parseSwaggerFile(file)),
+const getSwaggerObject = (
+  pathToSwagger,
+  urlToSwagger,
+  disableStrictSSL,
+  disableProxy,
+  authorizationToken,
+  converterOptions,
+) =>
+  getSwaggerFile(pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy, authorizationToken).then((file) =>
+    convertSwaggerObject(parseSwaggerFile(file), converterOptions),
   );
 
-const convertSwaggerObject = (swaggerSchema) => {
+const convertSwaggerObject = (swaggerSchema, converterOptions) => {
   return new Promise((resolve) => {
     swaggerSchema.info = _.merge(
       {
@@ -63,6 +82,7 @@ const convertSwaggerObject = (swaggerSchema) => {
       converter.convertObj(
         swaggerSchema,
         {
+          ...converterOptions,
           warnOnly: true,
           refSiblings: "preserve",
           rbname: "requestBodyName",

package/src/typeFormatters.js

@@ -18,10 +18,10 @@ const formatters = {
       const extraSpace = "  ";
       const result = `${extraSpace}${part.field};\n`;
 
-      const comments = _.compact([part.title, part.description]).reduce(
+      const comments = _.uniq(_.compact([part.title, part.description]).reduce(
         (acc, comment) => [...acc, ...comment.split(/\n/g)],
         [],
-      );
+      ));
 
       const commonText = comments.length
         ? [

package/src/utils/id.js

@@ -0,0 +1,9 @@
+const { customAlphabet } = require("nanoid");
+
+const ALPHABET = "abcdefghijklmnopqrstuvwxyz0123456789";
+
+const generateId = customAlphabet(ALPHABET, 12);
+
+module.exports = {
+  generateId,
+};

package/templates/base/data-contracts.eta

@@ -1,7 +1,7 @@
 <%
   const { modelTypes, utils } = it;
   const { formatDescription, require, _ } = utils;
-  
+
 
   const dataContractTemplates = {
     enum: (contract) => {
@@ -20,6 +20,7 @@
 
     return _.compact([
         contract.description && formatDescription(contract.description),
+        contract.typeData.deprecated === true && '@deprecated',
         !_.isUndefined(contract.typeData.format) && `@format ${contract.typeData.format}`,
         !_.isUndefined(contract.typeData.minimum) && `@min ${contract.typeData.minimum}`,
         !_.isUndefined(contract.typeData.maximum) && `@max ${contract.typeData.maximum}`,

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

@@ -2,7 +2,7 @@
 const { apiConfig, generateResponses, config } = it;
 %>
 
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType, HeadersDefaults } from "axios";
 
 export type QueryParamsType = Record<string | number, any>;
 
@@ -53,20 +53,44 @@ export class HttpClient<SecurityDataType = unknown> {
         this.securityData = data
     }
 
-    private mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
-        return {
-            ...this.instance.defaults,
-            ...params1,
-            ...(params2 || {}),
-            headers: {
-                ...(this.instance.defaults.headers || {}),
-                ...(params1.headers || {}),
-                ...((params2 && params2.headers) || {}),
-            },
-        };
+    protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig {
+      const method = params1.method || (params2 && params2.method)
+
+      return {
+        ...this.instance.defaults,
+        ...params1,
+        ...(params2 || {}),
+        headers: {
+          ...((method && this.instance.defaults.headers[method.toLowerCase() as keyof HeadersDefaults]) || {}),
+          ...(params1.headers || {}),
+          ...((params2 && params2.headers) || {}),
+        },
+      };
     }
 
-    private createFormData(input: Record<string, unknown>): FormData {
+    protected stringifyFormItem(formItem: unknown) {
+      if (typeof formItem === "object" && formItem !== null) {
+        return JSON.stringify(formItem);
+      } else {
+        return `${formItem}`;
+      }
+    }
+
+    protected createFormData(input: Record<string, unknown>): FormData {
+      return Object.keys(input || {}).reduce((formData, key) => {
+        const property = input[key];
+        const propertyContent: Iterable<any> = (property instanceof Array) ? property : [property]
+
+        for (const formItem of propertyContent) {
+          const isFileType = formItem instanceof Blob || formItem instanceof File;
+          formData.append(
+            key,
+            isFileType ? formItem : this.stringifyFormItem(formItem)
+            );
+        }
+
+        return formData;
+      }, new FormData());
       return Object.keys(input || {}).reduce((formData, key) => {
         const property = input[key];
         formData.append(
@@ -96,13 +120,9 @@ export class HttpClient<SecurityDataType = unknown> {
 <% } %>
         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;
+        const responseFormat = (format || this.format) || undefined;
 
         if (type === ContentType.FormData && body && body !== null && typeof body === "object") {
-          requestParams.headers.common = { Accept: "*/*" };
-          requestParams.headers.post = {};
-          requestParams.headers.put = {};
-
           body = this.createFormData(body as Record<string, unknown>);
         }
 

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

@@ -68,17 +68,17 @@ export class HttpClient<SecurityDataType = unknown> {
     public setSecurityData = (data: SecurityDataType | null) => {
         this.securityData = data;
     }
-    
-    private encodeQueryParam(key: string, value: any) {
+
+    protected encodeQueryParam(key: string, value: any) {
         const encodedKey = encodeURIComponent(key);
         return `${encodedKey}=${encodeURIComponent(typeof value === "number" ? value : `${value}`)}`;
     }
 
-    private addQueryParam(query: QueryParamsType, key: string) {
+    protected addQueryParam(query: QueryParamsType, key: string) {
         return this.encodeQueryParam(key, query[key]);
     }
 
-    private addArrayQueryParam(query: QueryParamsType, key: string) {
+    protected addArrayQueryParam(query: QueryParamsType, key: string) {
         const value = query[key];
         return value.map((v: any) => this.encodeQueryParam(key, v)).join("&");
     }
@@ -118,7 +118,7 @@ export class HttpClient<SecurityDataType = unknown> {
         [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
     }
 
-    private mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams {
+    protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams {
         return {
             ...this.baseApiParams,
             ...params1,
@@ -131,7 +131,7 @@ export class HttpClient<SecurityDataType = unknown> {
         };
     }
 
-    private createAbortSignal = (cancelToken: CancelToken): AbortSignal | undefined => {
+    protected createAbortSignal = (cancelToken: CancelToken): AbortSignal | undefined => {
         if (this.abortControllers.has(cancelToken)) {
             const abortController = this.abortControllers.get(cancelToken);
             if (abortController) {
@@ -183,7 +183,7 @@ export class HttpClient<SecurityDataType = unknown> {
             ...(type && type !== ContentType.FormData ? { "Content-Type": type } : {}),
             ...(requestParams.headers || {}),
             },
-            signal: cancelToken ? this.createAbortSignal(cancelToken) : void 0,
+            signal: cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal,
             body: typeof body === "undefined" || body === null ? null : payloadFormatter(body),
         }
         ).then(async (response) => {
@@ -209,7 +209,9 @@ export class HttpClient<SecurityDataType = unknown> {
                 this.abortControllers.delete(cancelToken);
             }
 
+<% if (!config.disableThrowOnError) { %>
             if (!response.ok) throw data;
+<% } %>
 <% if (config.unwrapResponseData) { %>
             return data.data;
 <% } else { %>

package/templates/default/api.eta

@@ -36,7 +36,7 @@ const descriptionLines = _.compact([
 <% }) %>
 */
 <% } %>
-export class Api<SecurityDataType extends unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
+export class <%~ config.apiClassName %><SecurityDataType extends unknown><% if (!config.singleHttpClient) { %> extends HttpClient<SecurityDataType> <% } %> {
 
 <% if(config.singleHttpClient) { %>
   http: HttpClient<SecurityDataType>;

package/templates/modular/api.eta

@@ -8,7 +8,7 @@ const dataContracts = _.map(modelTypes, "name");
 
 <% if (config.httpClientType === config.constants.HTTP_CLIENT.AXIOS) { %> import { AxiosRequestConfig, AxiosResponse } from "axios"; <% } %>
 
-import { HttpClient, RequestParams, ContentType } from "./<%~ config.fileNames.httpClient %>";
+import { HttpClient, RequestParams, ContentType, HttpResponse } from "./<%~ config.fileNames.httpClient %>";
 <% if (dataContracts.length) { %>
 import { <%~ dataContracts.join(", ") %> } from "./<%~ config.fileNames.dataContracts %>"
 <% } %>