feat: axiosImport 修改为 axiosImportPath

Author: cloudcome

package.json

@@ -25,16 +25,16 @@
             "require": "./dist/index.cjs"
         },
         "./package.json": "./package.json",
-        "./helpers": {
-            "import": "./dist/helpers.mjs",
-            "require": "./dist/helpers.cjs"
+        "./client": {
+            "import": "./dist/client.mjs",
+            "require": "./dist/client.cjs"
         }
     },
     "types": "./dist/index.d.ts",
     "typesVersions": {
         "*": {
-            "helpers": [
-                "./dist/helpers.d.ts"
+            "client": [
+                "./dist/client.d.ts"
             ]
         }
     },

src/helpers.ts renamed to src/client.ts

@@ -14,6 +14,9 @@ export const HTTP_METHODS: OpenAPIV3.HttpMethods[] = [
 export const JSON_MIME = 'application/json';
 export const BLOB_MIME = 'application/octet-stream';
 
+export const AXIOS_QUEST_CONFIG_TYPE_NAME = 'AxiosRequestConfig';
+export const AXIOS_PROMISE_TYPE_NAME = 'AxiosPromise';
+
 // 内部名称，文档里如果重复了会生成新的唯一值
 export const INTERNAL_NAMES = [
     // native
@@ -22,7 +25,6 @@ export const INTERNAL_NAMES = [
     'OneOf',
     // @ref PathsWriter
     'axios',
-    'request',
     'DELETE',
     'GET',
     'HEAD',
@@ -33,8 +35,8 @@ export const INTERNAL_NAMES = [
     'TRACE',
     'resolveURL',
     'BASE_URL',
-    'AxiosPromise',
-    'AxiosRequestConfig',
+    AXIOS_QUEST_CONFIG_TYPE_NAME,
+    AXIOS_PROMISE_TYPE_NAME,
 ];
 
 // @ref https://www.w3schools.com/js/js_reserved.asp

src/parsers/const.ts

@@ -4,11 +4,11 @@ import type { StrictPrinterOptions, PrinterOptions } from './types';
 
 export class BasePrinter {
     static defaults: StrictPrinterOptions = {
-        axiosImport: `import axios from 'axios';`,
+        axiosImportPath: 'axios',
         requestPathArgName: 'path',
         requestQueryArgName: 'params',
         requestBodyArgName: 'data',
-        responseTypeName: 'AxiosPromise',
+        requestConfigArgName: 'config',
     };
 
     options: StrictPrinterOptions;

src/printers/BasePrinter.ts

@@ -1,3 +1,4 @@
+import { pkgName } from '../const';
 import type { TypeItem, TypeOrigin } from '../parsers/types';
 import { joinSlices, toTypePath } from '../utils/string';
 import { BasePrinter } from './BasePrinter';
@@ -6,7 +7,7 @@ import { CommentsPrinter } from './CommentsPrinter';
 export class ComponentsPrinter extends CommentsPrinter {
     protected init() {
         super.init();
-        this.imports.push('import type { OneOf } from "openapi-axios/helpers"');
+        this.imports.push(`import type { OneOf } from "${pkgName}/client"`);
     }
 
     printComponents() {

src/printers/ComponentsPrinter.ts

@@ -1,5 +1,7 @@
 import type { AxiosRequestConfig } from 'axios';
 import { groupBy } from 'lodash';
+import { pkgName } from '../const';
+import { AXIOS_PROMISE_TYPE_NAME, AXIOS_QUEST_CONFIG_TYPE_NAME } from '../parsers/const';
 import type { TypeItem, TypeList, TypeOperation, TypeOperations, TypeOrigin } from '../parsers/types';
 import { joinSlices, nextUniqueName, varString } from '../utils/string';
 import { isBoolean, isString } from '../utils/type-is';
@@ -10,10 +12,9 @@ const { stringify } = JSON;
 export class PathsPrinter extends ComponentsPrinter {
     protected init() {
         super.init();
-        this.imports.push('import type { AxiosPromise, AxiosRequestConfig } from "axios";');
-        this.imports.push('import { DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, resolveURL } from "openapi-axios/helpers";');
-        this.imports.push(this.options.axiosImport);
-        this.helpers.push(`const request = axios.request;`);
+        this.imports.push(`import { DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, resolveURL } from "${pkgName}/client";`);
+        this.imports.push(`import type {AxiosRequestConfig, AxiosPromise} from "${this.options.axiosImportPath}";`);
+        this.imports.push(`import axios from "${this.options.axiosImportPath}";`);
         if (this.document.info.baseURL) this.helpers.push(`const BASE_URL = ${stringify(this.document.info.baseURL)};`);
     }
 
@@ -40,32 +41,30 @@ export class PathsPrinter extends ComponentsPrinter {
             request: { path, query, body: reqBody },
             response: { body: resBody },
         } = type;
-        const { responseTypeName } = this.options;
         const argNameCountMap = new Map<string, number>();
         const requestPathArgName = nextUniqueName(this.options.requestPathArgName, argNameCountMap);
         const requestQueryArgName = nextUniqueName(this.options.requestQueryArgName, argNameCountMap);
         const requestBodyArgName = nextUniqueName(this.options.requestBodyArgName, argNameCountMap);
-        const configArgName = nextUniqueName('config', argNameCountMap);
+        const requestConfigArgName = nextUniqueName(this.options.requestConfigArgName, argNameCountMap);
         const comments = this.printComments(type, true);
-        const argsGroup = groupBy(
-            [
-                this.printArg(requestPathArgName, path),
-                this.printArg(requestQueryArgName, query),
-                this.printArg(requestBodyArgName, reqBody),
-                this.printArg(configArgName, 'AxiosRequestConfig', false),
-            ],
-            (item) => item?.required,
-        );
-        const args_ = joinSlices(
+        const args = [
+            //
+            this.printArg(requestPathArgName, path),
+            this.printArg(requestQueryArgName, query),
+            this.printArg(requestBodyArgName, reqBody),
+            this.printArg(requestConfigArgName, AXIOS_QUEST_CONFIG_TYPE_NAME, false),
+        ];
+        const argsGroup = groupBy(args, (item) => item?.required);
+        const argStr = joinSlices(
             [
                 // 可能没有任何必填参数
                 ...(argsGroup['true'] || []),
-                // 至少有一个 config 可选参数
-                ...argsGroup['false'],
+                // 可能没有任何可选参数
+                ...(argsGroup['false'] || []),
             ].map((desc) => desc?.text),
             ', ',
         );
-        const return_ = `${responseTypeName}<${resBody?.name || 'never'}>`;
+        const return_ = `${AXIOS_PROMISE_TYPE_NAME}<${resBody?.name || 'never'}>`;
         const url_ = this.printAxiosProp('url', this.toURL(type, requestPathArgName));
         const method_ = this.printAxiosProp('method', type.method.toUpperCase());
         const params_ = this.printAxiosProp('params', query ? requestQueryArgName : '');
@@ -76,11 +75,11 @@ export class PathsPrinter extends ComponentsPrinter {
             method_,
             params_,
             data_,
-            `...${configArgName}`,
+            `...${requestConfigArgName}`,
         ]);
 
-        return `${comments}export async function ${name}(${args_}): ${return_}  {
-              return request({
+        return `${comments}export async function ${name}(${argStr}): ${return_}  {
+              return axios({
                 ${props}
               });
             }`;

src/printers/PathsPrinter.ts

@@ -1,9 +1,13 @@
 export interface PrinterOptions {
     /**
-     * axios 导入，必须有名称 axios，且 axios.request 是一个请求方法
-     * @default import axios from 'axios';
+     * axios 导入，必须有 axios 默认方法和 AxiosRequestConfig、AxiosPromise 两个类型
+     * 可以修改为当前工程的 axios 实例，或其他类 axios 方法，类型导出不要忘记了
+     * @example
+     * import type {AxiosRequestConfig, AxiosPromise} from 'axios';
+     * import axios from 'axios';
+     * @default axios
      */
-    axiosImport?: string;
+    axiosImportPath?: string;
 
     /**
      * 请求路径的参数名称
@@ -24,9 +28,9 @@ export interface PrinterOptions {
     requestBodyArgName?: string;
 
     /**
-     * 自定义响应包装类型
-     * @default AxiosPromise
+     * 请求配置的参数名称
+     * @default config
      */
-    responseTypeName?: 'Promise' | 'AxiosPromise' | string;
+    requestConfigArgName?: string;
 }
 export type StrictPrinterOptions = Required<PrinterOptions>;

src/printers/types.ts

@@ -1,4 +1,4 @@
-import { resolveURL } from '../src/helpers';
+import { resolveURL } from '../src/client';
 
 test('resolveBaseURL', () => {
     expect(resolveURL('/', '/a/b')).toEqual('/a/b');

test/helpers.test.ts

@@ -28,7 +28,7 @@ export default defineConfig({
         lib: {
             entry: {
                 index: 'src/index.ts',
-                helpers: 'src/helpers.ts',
+                client: 'src/client.ts',
             },
         },
         rollupOptions: {