Merge branch 'master' of https://github.com/Kimiyori/openapi-typescript-codegen

Максим Калин · Максим Калин · commit 02c4b15adf42 · 2024-01-30T11:45:10.000+03:00
diff --git a/src/client/interfaces/OperationParameter.d.ts b/src/client/interfaces/OperationParameter.d.ts
@@ -1,7 +1,7 @@
 import type { Model } from './Model';
 
 export interface OperationParameter extends Model {
-    in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie';
+    in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie' | 'axios';
     prop: string;
     mediaType: string | null;
 }
diff --git a/src/openApi/v2/parser/getServices.ts b/src/openApi/v2/parser/getServices.ts
@@ -31,8 +31,27 @@ export const getServices = (openApi: OpenApi): Service[] => {
                             const tags = op.tags?.length ? op.tags.filter(unique) : ['Default'];
                             tags.forEach(tag => {
                                 const operation = getOperation(openApi, url, method, tag, op, pathParams);
-
-                                // If we have already declared a service, then we should fetch that and
+                                operation.parameters.push({
+                                    in: 'axios',
+                                    prop: 'axiosConfig',
+                                    export: 'generic',
+                                    name: 'axiosConfig',
+                                    type: 'AxiosRequestConfig',
+                                    base: 'AxiosRequestConfig',
+                                    template: null,
+                                    link: null,
+                                    description: 'AxiosConfig',
+                                    isDefinition: false,
+                                    isReadOnly: false,
+                                    isRequired: false,
+                                    isNullable: false,
+                                    imports: [],
+                                    enum: [],
+                                    enums: [],
+                                    properties: [],
+                                    mediaType: null,
+                                });
+                                // If we have already de    clared a service, then we should fetch that and
                                 // append the new method to it. Otherwise we should create a new service object.
                                 const service: Service = services.get(operation.service) || {
                                     name: operation.service,
diff --git a/src/openApi/v3/parser/getServices.ts b/src/openApi/v3/parser/getServices.ts
@@ -31,7 +31,26 @@ export const getServices = (openApi: OpenApi): Service[] => {
                             const tags = op.tags?.length ? op.tags.filter(unique) : ['Default'];
                             tags.forEach(tag => {
                                 const operation = getOperation(openApi, url, method, tag, op, pathParams);
-
+                                operation.parameters.push({
+                                    in: 'axios',
+                                    prop: 'axiosConfig',
+                                    export: 'generic',
+                                    name: 'axiosConfig',
+                                    type: 'AxiosRequestConfig',
+                                    base: 'AxiosRequestConfig',
+                                    template: null,
+                                    link: null,
+                                    description: 'AxiosConfig',
+                                    isDefinition: false,
+                                    isReadOnly: false,
+                                    isRequired: false,
+                                    isNullable: false,
+                                    imports: [],
+                                    enum: [],
+                                    enums: [],
+                                    properties: [],
+                                    mediaType: null,
+                                });
                                 // If we have already declared a service, then we should fetch that and
                                 // append the new method to it. Otherwise we should create a new service object.
                                 const service: Service = services.get(operation.service) || {
diff --git a/src/templates/core/BaseHttpRequest.hbs b/src/templates/core/BaseHttpRequest.hbs
@@ -7,6 +7,7 @@ import type { Observable } from 'rxjs';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { OpenAPIConfig } from './OpenAPI';
 {{else}}
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
 import type { ApiRequestOptions } from './ApiRequestOptions';
 import type { CancelablePromise } from './CancelablePromise';
 import type { OpenAPIConfig } from './OpenAPI';
@@ -26,6 +27,7 @@ export abstract class BaseHttpRequest {
 	{{#equals @root.httpClient 'angular'}}
 	public abstract request<T>(options: ApiRequestOptions): Observable<T>;
 	{{else}}
-	public abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
+	public axiosInstance: AxiosInstance;
+	public abstract request<T>(options: ApiRequestOptions, axiosConfig?: AxiosRequestConfig): CancelablePromise<T>;
 	{{/equals}}
 }
diff --git a/src/templates/core/axios/request.hbs b/src/templates/core/axios/request.hbs
@@ -70,7 +70,7 @@ import type { OpenAPIConfig } from './OpenAPI';
  * @returns CancelablePromise<T>
  * @throws ApiError
  */
-export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, axiosClient: AxiosInstance = axios): CancelablePromise<T> => {
+export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, axiosClient: AxiosInstance = axios, axiosConfig?: AxiosRequestConfig,): CancelablePromise<T> => {
 	return new CancelablePromise(async (resolve, reject, onCancel) => {
 		try {
 			const url = getUrl(config, options);
@@ -79,7 +79,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions, ax
 			const headers = await getHeaders(config, options, formData);
 
 			if (!onCancel.isCancelled) {
-				const response = await sendRequest<T>(config, options, url, body, formData, headers, onCancel, axiosClient);
+				const response = await sendRequest<T>(config, options, url, body, formData, headers, onCancel, axiosClient, axiosConfig);
 				const responseBody = getResponseBody(response);
 				const responseHeader = getResponseHeader(response, options.responseHeader);
 
diff --git a/src/templates/core/axios/sendRequest.hbs b/src/templates/core/axios/sendRequest.hbs
@@ -6,7 +6,8 @@ export const sendRequest = async <T>(
 	formData: FormData | undefined,
 	headers: Record<string, string>,
 	onCancel: OnCancel,
-	axiosClient: AxiosInstance
+	axiosClient: AxiosInstance,
+	axiosConfig?: AxiosRequestConfig,
 ): Promise<AxiosResponse<T>> => {
 	const source = axios.CancelToken.source();
 
@@ -17,6 +18,7 @@ export const sendRequest = async <T>(
 		method: options.method,
 		withCredentials: config.WITH_CREDENTIALS,
 		cancelToken: source.token,
+		...axiosConfig,
 	};
 
 	onCancel(() => source.cancel('The user aborted a request.'));
diff --git a/src/templates/exportService.hbs b/src/templates/exportService.hbs
@@ -1,5 +1,5 @@
 {{>header}}
-
+import { AxiosRequestConfig } from "axios";
 {{#equals @root.httpClient 'angular'}}
 {{#if @root.exportClient}}
 import { Injectable } from '@angular/core';
@@ -145,7 +145,7 @@ export class {{{name}}}{{{@root.postfix}}} {
 				{{/each}}
 			},
 			{{/if}}
-		});
+		}, axiosConfig);
 	}
 
 	{{/each}}
diff --git a/src/templates/index.hbs b/src/templates/index.hbs
@@ -2,6 +2,7 @@
 
 {{#if @root.exportClient}}
 export { {{{clientName}}} } from './{{{clientName}}}';
+export { {{{clientName}}}Client } from "./instance";
 
 {{/if}}
 {{#if @root.exportCore}}
diff --git a/src/templates/instance.hbs b/src/templates/instance.hbs
@@ -0,0 +1,36 @@
+import Axios, { AxiosRequestConfig } from 'axios';
+import axiosRetry from 'axios-retry';
+
+import { BaseHttpRequest } from './core/BaseHttpRequest';
+import { OpenAPIConfig } from './core/OpenAPI';
+import { ApiRequestOptions } from './core/ApiRequestOptions';
+import { CancelablePromise } from './core/CancelablePromise';
+import { request as __request } from './core/request';
+
+import { {{clientName}} } from './{{clientName}}';
+
+type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
+
+export class AxiosHttpRequestWithRetry extends BaseHttpRequest {
+  axiosInstance = Axios.create();
+
+  constructor(config: OpenAPIConfig) {
+    super(config);
+    axiosRetry(this.axiosInstance, {
+      retryCondition: (error) => {
+        if (!error.response) return false;
+
+        return error.response.status >= 400;
+      },
+    });
+  }
+
+  public override request<T>(options: ApiRequestOptions, axiosConfig?: AxiosRequestConfig): CancelablePromise<T> {
+    return __request(this.config, options, this.axiosInstance, axiosConfig);
+  }
+}
+
+export const {{clientName}}Client = (
+  config?: Partial<OpenAPIConfig>,
+  HttpRequest: HttpRequestConstructor = AxiosHttpRequestWithRetry
+) => new {{clientName}}(config, HttpRequest);
diff --git a/src/utils/registerHandlebarTemplates.ts b/src/utils/registerHandlebarTemplates.ts
@@ -56,6 +56,7 @@ import templateExportModel from '../templates/exportModel.hbs';
 import templateExportSchema from '../templates/exportSchema.hbs';
 import templateExportService from '../templates/exportService.hbs';
 import templateIndex from '../templates/index.hbs';
+import templateInstance from '../templates/instance.hbs';
 import partialBase from '../templates/partials/base.hbs';
 import partialExportComposition from '../templates/partials/exportComposition.hbs';
 import partialExportEnum from '../templates/partials/exportEnum.hbs';
@@ -88,6 +89,7 @@ import { registerHandlebarHelpers } from './registerHandlebarHelpers';
 export interface Templates {
     index: Handlebars.TemplateDelegate;
     client: Handlebars.TemplateDelegate;
+    instance: Handlebars.TemplateDelegate;
     exports: {
         model: Handlebars.TemplateDelegate;
         schema: Handlebars.TemplateDelegate;
@@ -119,6 +121,7 @@ export const registerHandlebarTemplates = (root: {
     // Main templates (entry points for the files we write to disk)
     const templates: Templates = {
         index: Handlebars.template(templateIndex),
+        instance: Handlebars.template(templateInstance),
         client: Handlebars.template(templateClient),
         exports: {
             model: Handlebars.template(templateExportModel),
diff --git a/src/utils/writeClient.spec.ts b/src/utils/writeClient.spec.ts
@@ -19,6 +19,7 @@ describe('writeClient', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClient.ts b/src/utils/writeClient.ts
@@ -13,6 +13,7 @@ import { writeClientIndex } from './writeClientIndex';
 import { writeClientModels } from './writeClientModels';
 import { writeClientSchemas } from './writeClientSchemas';
 import { writeClientServices } from './writeClientServices';
+import { writeInstance } from './writeInstance';
 
 /**
  * Write our OpenAPI client, using the given templates at the given output
@@ -97,6 +98,7 @@ export const writeClient = async (
     if (isDefined(clientName)) {
         await mkdir(outputPath);
         await writeClientClass(client, templates, outputPath, httpClient, clientName, indent, postfixServices);
+        await writeInstance(templates, outputPath, clientName, indent);
     }
 
     if (exportCore || exportServices || exportSchemas || exportModels) {
diff --git a/src/utils/writeClientClass.spec.ts b/src/utils/writeClientClass.spec.ts
@@ -19,6 +19,7 @@ describe('writeClientClass', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClientCore.spec.ts b/src/utils/writeClientCore.spec.ts
@@ -22,6 +22,7 @@ describe('writeClientCore', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClientIndex.spec.ts b/src/utils/writeClientIndex.spec.ts
@@ -19,6 +19,7 @@ describe('writeClientIndex', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClientModels.spec.ts b/src/utils/writeClientModels.spec.ts
@@ -35,6 +35,7 @@ describe('writeClientModels', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClientSchemas.spec.ts b/src/utils/writeClientSchemas.spec.ts
@@ -35,6 +35,7 @@ describe('writeClientSchemas', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeClientServices.spec.ts b/src/utils/writeClientServices.spec.ts
@@ -23,6 +23,7 @@ describe('writeClientServices', () => {
         const templates: Templates = {
             index: () => 'index',
             client: () => 'client',
+            instance: () => 'instance',
             exports: {
                 model: () => 'model',
                 schema: () => 'schema',
diff --git a/src/utils/writeInstance.ts b/src/utils/writeInstance.ts
@@ -0,0 +1,27 @@
+import { resolve } from 'path';
+
+import type { Indent } from '../Indent';
+import { writeFile } from './fileSystem';
+import { formatCode as f } from './formatCode';
+import { formatIndentation as i } from './formatIndentation';
+import type { Templates } from './registerHandlebarTemplates';
+
+/**
+ * Generate the OpenAPI instance client index file using the Handlebar template and write it to disk.
+ * The index file just contains all the exports you need to use the client as a standalone
+ * library. But yuo can also import individual models and services directly.
+ * @param templates The loaded handlebar templates
+ * @param outputPath Directory to write the generated files to
+ * @param clientName Custom client class name
+ * @param indent Indentation options (4, 2 or tab)
+ */
+export const writeInstance = async (
+    templates: Templates,
+    outputPath: string,
+    clientName: string,
+    indent: Indent
+): Promise<void> => {
+    const templateResult = templates.instance({ clientName });
+
+    await writeFile(resolve(outputPath, `instance.ts`), i(f(templateResult), indent));
+};

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`import type { Model } from './Model';`
`2`	`2`
`3`	`3`	`export interface OperationParameter extends Model {`
`4`		`- in: 'path' \| 'query' \| 'header' \| 'formData' \| 'body' \| 'cookie';`
	`4`	`+ in: 'path' \| 'query' \| 'header' \| 'formData' \| 'body' \| 'cookie' \| 'axios';`
`5`	`5`	`prop: string;`
`6`	`6`	`mediaType: string \| null;`
`7`	`7`	`}`