feat: add custom axios config typings merge (#4278)

package.json

@@ -18,7 +18,7 @@
     "tree-kill": "1.2.2",
     "ts-jest": "29.2.5",
     "ts-node": "10.9.2",
-    "typedoc": "^0.26.0",
+    "typedoc": "^0.26.11",
     "typescript": "5.3.3",
     "why-is-node-running": "2.3.0",
     "zx": "8.2.4"

packages/axios/index.d.ts

@@ -1,4 +1,4 @@
-import { AxiosRequestConfig } from 'axios';
+import { AxiosRequestConfig } from './dist/index';
 
 export * from './dist/index';
 

packages/axios/src/http-service.factory.ts

@@ -6,7 +6,8 @@ import {
   ScopeEnum,
   ServiceFactory,
 } from '@midwayjs/core';
-import axios, { AxiosInstance, CreateAxiosDefaults } from 'axios';
+import * as axios from 'axios';
+import { AxiosInstance, CreateAxiosDefaults } from 'axios';
 
 @Provide()
 @Scope(ScopeEnum.Singleton)

packages/axios/src/http-service.ts

@@ -6,12 +6,13 @@ import {
   ScopeEnum,
   MidwayCommonError,
 } from '@midwayjs/core';
-import { Axios, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AxiosInstance } from 'axios';
 import { HttpServiceFactory } from './http-service.factory';
+import { AxiosRequestConfig, AxiosResponse } from './interface';
 
 @Provide()
 @Scope(ScopeEnum.Singleton)
-export class HttpService implements Axios {
+export class HttpService {
   private instance: AxiosInstance;
 
   @Inject()
@@ -120,3 +121,5 @@ export class HttpService implements Axios {
     return this.instance.patchForm(url, data, config);
   }
 }
+
+export interface HttpService extends AxiosInstance {}

packages/axios/src/index.ts

@@ -1,13 +1,8 @@
 import * as axios from 'axios';
-import * as Axios from 'axios';
+const Axios = axios['default'];
 
 export { AxiosConfiguration as Configuration } from './configuration';
 export * from './http-service.factory';
 export * from './http-service';
-export {
-  /**
-   * @deprecated Use `Axios` directly
-   */
-  axios,
-  Axios,
-};
+export * from './interface';
+export { Axios };

packages/axios/src/interface.ts

@@ -0,0 +1,15 @@
+import {
+  AxiosRequestConfig as OriginAxiosRequestConfig,
+  AxiosRequestHeaders,
+  AxiosResponse as OriginAxiosResponse
+} from 'axios';
+
+/**
+ * Interface for custom axios request config merging.
+ */
+export interface AxiosRequestConfig<D = any> extends OriginAxiosRequestConfig<D> {}
+export interface AxiosResponse<T = any, D = any> extends OriginAxiosResponse<T, D> {
+  config: AxiosRequestConfig<D> & {
+    headers: AxiosRequestHeaders;
+  };
+}

packages/axios/test/index.test.ts

@@ -1,5 +1,5 @@
 import { join } from 'path';
-import { HttpService, axios } from '../src';
+import { HttpService, Axios } from '../src';
 import { createLightApp } from '@midwayjs/mock';
 import * as nock from 'nock';
 
@@ -68,8 +68,9 @@ describe('/test/index.test.ts', () => {
   });
 
   it('should test defaults and interceptors', () => {
-    expect(httpService.defaults).toStrictEqual(axios.defaults);
-    expect(httpService.interceptors).toStrictEqual(axios.interceptors);
+    expect(Axios.get).toBeDefined();
+    expect(httpService.defaults).toStrictEqual(Axios.defaults);
+    expect(httpService.interceptors).toStrictEqual(Axios.interceptors);
   });
 
   it('should test get method', async () => {

packages/bullmq/package.json

@@ -24,8 +24,8 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@midwayjs/core": "^3.19.0",
-    "@midwayjs/mock": "^3.19.2"
+    "@midwayjs/core": "workspace:^",
+    "@midwayjs/mock": "workspace:^"
   },
   "dependencies": {
     "bullmq": "5.39.1"