@swiftcrab/request 1.0.1

package/README.md

@@ -0,0 +1,78 @@
+## 使用示例
+
+- 安装: pnpm add @swiftcrab/request
+
+#### 创建 request.ts
+
+```typescript
+import {
+  RequestClient,
+  formatToken,
+  defaultResponseInterceptor,
+  authenticateResponseInterceptor,
+  errorMessageResponseInterceptor,
+} from '@swiftcrab/request'
+
+const baseURL = '/api'
+
+function createRequestClient(baseURL: string) {
+  const client = new RequestClient({
+    baseURL,
+  })
+
+  /** 处理重新认证 */
+  async function doReAuthenticate() {
+    message.error('Access token or refresh token is invalid or expired. ')
+  }
+
+  /** 处理刷新令牌 */
+  async function doRefreshToken() {}
+
+  // 处理请求头处理
+  client.addRequestInterceptor({
+    fulfilled: config => {},
+  })
+
+  // 返回数据格式 { data: any, info: { code: number, message: string, status: boolean } }
+  client.addResponseInterceptor(
+    defaultResponseInterceptor({
+      /** 响应数据中代表访问结果的字段名 */
+      codeField: 'code',
+      /** 响应数据中装载实际数据的字段名，或者提供一个函数从响应数据中解析需要返回的数据 */
+      dataField: 'data',
+      /** 当codeField所指定的字段值与successCode相同时，代表接口访问成功。如果提供一个函数，则返回true代表接口访问成功 */
+      successCode: [200],
+    }),
+  )
+
+  client.addResponseInterceptor(
+    authenticateResponseInterceptor({
+      client,
+      doReAuthenticate,
+      doRefreshToken,
+      /** 是否启用刷新令牌 */
+      enableRefreshToken: true,
+    }),
+  )
+
+  client.addResponseInterceptor(
+    errorMessageResponseInterceptor((msg: string, error) => {
+      /** 处理错误消息 */
+    }),
+  )
+
+  return client
+}
+
+export const requestClient = createRequestClient(baseURL)
+export const baseRequestClient = new RequestClient({ baseURL })
+```
+
+#### 使用 requestClient
+
+```typescript
+import { requestClient } from './request'
+requestClient.get('/user').then(res => {
+  console.log(res)
+})
+```

package/dist/index.d.mts

@@ -0,0 +1,89 @@
+import { AxiosRequestConfig, InternalAxiosRequestConfig, AxiosResponse, CreateAxiosDefaults, AxiosInstance } from 'axios';
+export { AxiosRequestConfig } from 'axios';
+
+type ExtendOptions<T = any> = {
+    paramsSerializer?: 'brackets' | 'comma' | 'indices' | 'repeat' | AxiosRequestConfig<T>['paramsSerializer'];
+    responseReturn?: 'body' | 'data' | 'raw';
+};
+type RequestClientConfig<T = any> = AxiosRequestConfig<T> & ExtendOptions<T>;
+type RequestResponse<T = any> = AxiosResponse<T> & {
+    config: RequestClientConfig<T>;
+};
+type RequestContentType = 'application/json;charset=utf-8' | 'application/octet-stream;charset=utf-8' | 'application/x-www-form-urlencoded;charset=utf-8' | 'multipart/form-data;charset=utf-8';
+type RequestClientOptions = CreateAxiosDefaults & ExtendOptions;
+interface SseRequestOptions extends RequestInit {
+    onMessage?: (message: string) => void;
+    onEnd?: () => void;
+}
+interface RequestInterceptorConfig {
+    fulfilled?: (config: ExtendOptions & InternalAxiosRequestConfig) => (ExtendOptions & InternalAxiosRequestConfig<any>) | Promise<ExtendOptions & InternalAxiosRequestConfig<any>>;
+    rejected?: (error: any) => any;
+}
+interface ResponseInterceptorConfig<T = any> {
+    fulfilled?: (response: RequestResponse<T>) => Promise<RequestResponse> | RequestResponse;
+    rejected?: (error: any) => any;
+}
+type MakeErrorMessageFn = (message: string, error: any) => void;
+interface HttpResponse<T = any> {
+    code: number;
+    data: T;
+    message: string;
+}
+
+declare class FileDownloader {
+    private client;
+    constructor(client: RequestClient);
+    download(url: string, config?: AxiosRequestConfig): Promise<RequestResponse<Blob>>;
+}
+
+declare class InterceptorManager {
+    private axiosInstance;
+    constructor(instance: AxiosInstance);
+    addRequestInterceptor({ fulfilled, rejected, }?: RequestInterceptorConfig): void;
+    addResponseInterceptor<T = any>({ fulfilled, rejected, }?: ResponseInterceptorConfig<T>): void;
+}
+
+declare class FileUploader {
+    private client;
+    constructor(client: RequestClient);
+    upload(url: string, data: {
+        file: Blob | File;
+    } & Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse>;
+}
+
+declare class RequestClient {
+    private readonly instance;
+    addRequestInterceptor: InterceptorManager['addRequestInterceptor'];
+    addResponseInterceptor: InterceptorManager['addResponseInterceptor'];
+    download: FileDownloader['download'];
+    isRefreshing: boolean;
+    refreshTokenQueue: ((token: string) => void)[];
+    upload: FileUploader['upload'];
+    constructor(options?: RequestClientOptions);
+    delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    setDefaultHeader(name: string, value: string): void;
+    request<T>(url: string, config: AxiosRequestConfig): Promise<T>;
+}
+
+declare function formatToken(token: null | string): string | null;
+declare const defaultRequestInterceptor: ({ token }: {
+    token: string;
+}) => RequestInterceptorConfig;
+declare const defaultResponseInterceptor: ({ codeField, dataField, successCode, }: {
+    codeField: string;
+    dataField: ((response: any) => any) | string;
+    successCode: ((code: any) => boolean) | number | string;
+}) => ResponseInterceptorConfig;
+declare const authenticateResponseInterceptor: ({ client, doReAuthenticate, doRefreshToken, enableRefreshToken, }: {
+    client: RequestClient;
+    doReAuthenticate: () => Promise<void>;
+    doRefreshToken: () => Promise<string>;
+    enableRefreshToken: boolean;
+}) => ResponseInterceptorConfig;
+declare const errorMessageResponseInterceptor: (makeErrorMessage?: MakeErrorMessageFn) => ResponseInterceptorConfig;
+
+export { RequestClient, authenticateResponseInterceptor, defaultRequestInterceptor, defaultResponseInterceptor, errorMessageResponseInterceptor, formatToken };
+export type { HttpResponse, MakeErrorMessageFn, RequestClientConfig, RequestClientOptions, RequestContentType, RequestInterceptorConfig, RequestResponse, ResponseInterceptorConfig, SseRequestOptions };

package/dist/index.d.ts

@@ -0,0 +1,89 @@
+import { AxiosRequestConfig, InternalAxiosRequestConfig, AxiosResponse, CreateAxiosDefaults, AxiosInstance } from 'axios';
+export { AxiosRequestConfig } from 'axios';
+
+type ExtendOptions<T = any> = {
+    paramsSerializer?: 'brackets' | 'comma' | 'indices' | 'repeat' | AxiosRequestConfig<T>['paramsSerializer'];
+    responseReturn?: 'body' | 'data' | 'raw';
+};
+type RequestClientConfig<T = any> = AxiosRequestConfig<T> & ExtendOptions<T>;
+type RequestResponse<T = any> = AxiosResponse<T> & {
+    config: RequestClientConfig<T>;
+};
+type RequestContentType = 'application/json;charset=utf-8' | 'application/octet-stream;charset=utf-8' | 'application/x-www-form-urlencoded;charset=utf-8' | 'multipart/form-data;charset=utf-8';
+type RequestClientOptions = CreateAxiosDefaults & ExtendOptions;
+interface SseRequestOptions extends RequestInit {
+    onMessage?: (message: string) => void;
+    onEnd?: () => void;
+}
+interface RequestInterceptorConfig {
+    fulfilled?: (config: ExtendOptions & InternalAxiosRequestConfig) => (ExtendOptions & InternalAxiosRequestConfig<any>) | Promise<ExtendOptions & InternalAxiosRequestConfig<any>>;
+    rejected?: (error: any) => any;
+}
+interface ResponseInterceptorConfig<T = any> {
+    fulfilled?: (response: RequestResponse<T>) => Promise<RequestResponse> | RequestResponse;
+    rejected?: (error: any) => any;
+}
+type MakeErrorMessageFn = (message: string, error: any) => void;
+interface HttpResponse<T = any> {
+    code: number;
+    data: T;
+    message: string;
+}
+
+declare class FileDownloader {
+    private client;
+    constructor(client: RequestClient);
+    download(url: string, config?: AxiosRequestConfig): Promise<RequestResponse<Blob>>;
+}
+
+declare class InterceptorManager {
+    private axiosInstance;
+    constructor(instance: AxiosInstance);
+    addRequestInterceptor({ fulfilled, rejected, }?: RequestInterceptorConfig): void;
+    addResponseInterceptor<T = any>({ fulfilled, rejected, }?: ResponseInterceptorConfig<T>): void;
+}
+
+declare class FileUploader {
+    private client;
+    constructor(client: RequestClient);
+    upload(url: string, data: {
+        file: Blob | File;
+    } & Record<string, any>, config?: AxiosRequestConfig): Promise<AxiosResponse>;
+}
+
+declare class RequestClient {
+    private readonly instance;
+    addRequestInterceptor: InterceptorManager['addRequestInterceptor'];
+    addResponseInterceptor: InterceptorManager['addResponseInterceptor'];
+    download: FileDownloader['download'];
+    isRefreshing: boolean;
+    refreshTokenQueue: ((token: string) => void)[];
+    upload: FileUploader['upload'];
+    constructor(options?: RequestClientOptions);
+    delete<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    get<T = any>(url: string, config?: AxiosRequestConfig): Promise<T>;
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig): Promise<T>;
+    setDefaultHeader(name: string, value: string): void;
+    request<T>(url: string, config: AxiosRequestConfig): Promise<T>;
+}
+
+declare function formatToken(token: null | string): string | null;
+declare const defaultRequestInterceptor: ({ token }: {
+    token: string;
+}) => RequestInterceptorConfig;
+declare const defaultResponseInterceptor: ({ codeField, dataField, successCode, }: {
+    codeField: string;
+    dataField: ((response: any) => any) | string;
+    successCode: ((code: any) => boolean) | number | string;
+}) => ResponseInterceptorConfig;
+declare const authenticateResponseInterceptor: ({ client, doReAuthenticate, doRefreshToken, enableRefreshToken, }: {
+    client: RequestClient;
+    doReAuthenticate: () => Promise<void>;
+    doRefreshToken: () => Promise<string>;
+    enableRefreshToken: boolean;
+}) => ResponseInterceptorConfig;
+declare const errorMessageResponseInterceptor: (makeErrorMessage?: MakeErrorMessageFn) => ResponseInterceptorConfig;
+
+export { RequestClient, authenticateResponseInterceptor, defaultRequestInterceptor, defaultResponseInterceptor, errorMessageResponseInterceptor, formatToken };
+export type { HttpResponse, MakeErrorMessageFn, RequestClientConfig, RequestClientOptions, RequestContentType, RequestInterceptorConfig, RequestResponse, ResponseInterceptorConfig, SseRequestOptions };

package/dist/index.mjs

@@ -0,0 +1,273 @@
+import axios from 'axios';
+import { defu } from 'defu';
+
+class FileDownloader {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  async download(url, config) {
+    const finalConfig = {
+      ...config,
+      responseType: "blob"
+    };
+    const response = await this.client.get(
+      url,
+      finalConfig
+    );
+    return response;
+  }
+}
+
+const defaultRequestInterceptorConfig = {
+  fulfilled: (response) => response,
+  rejected: (error) => Promise.reject(error)
+};
+const defaultResponseInterceptorConfig = {
+  fulfilled: (response) => response,
+  rejected: (error) => Promise.reject(error)
+};
+class InterceptorManager {
+  axiosInstance;
+  constructor(instance) {
+    this.axiosInstance = instance;
+  }
+  addRequestInterceptor({
+    fulfilled,
+    rejected
+  } = defaultRequestInterceptorConfig) {
+    this.axiosInstance.interceptors.request.use(fulfilled, rejected);
+  }
+  addResponseInterceptor({
+    fulfilled,
+    rejected
+  } = defaultResponseInterceptorConfig) {
+    this.axiosInstance.interceptors.response.use(fulfilled, rejected);
+  }
+}
+
+class FileUploader {
+  client;
+  constructor(client) {
+    this.client = client;
+  }
+  async upload(url, data, config) {
+    const formData = new FormData();
+    Object.entries(data).forEach(([key, value]) => {
+      formData.append(key, value);
+    });
+    const finalConfig = {
+      ...config,
+      headers: {
+        "Content-Type": "multipart/form-data",
+        ...config?.headers
+      }
+    };
+    return this.client.post(url, formData, finalConfig);
+  }
+}
+
+class RequestClient {
+  instance;
+  addRequestInterceptor;
+  addResponseInterceptor;
+  download;
+  // 是否正在刷新token
+  isRefreshing = false;
+  // 刷新token队列
+  refreshTokenQueue = [];
+  upload;
+  /**
+   * 构造函数，用于创建Axios实例
+   * @param options - Axios请求配置，可选
+   */
+  constructor(options = {}) {
+    const defaultConfig = {
+      headers: {
+        "Content-Type": "application/json;charset=utf-8"
+      },
+      // 默认超时时间
+      timeout: 1e4
+    };
+    const { ...axiosConfig } = options;
+    const requestConfig = defu(axiosConfig, defaultConfig);
+    this.instance = axios.create(requestConfig);
+    const interceptorManager = new InterceptorManager(this.instance);
+    this.addRequestInterceptor = interceptorManager.addRequestInterceptor.bind(interceptorManager);
+    this.addResponseInterceptor = interceptorManager.addResponseInterceptor.bind(interceptorManager);
+    const fileUploader = new FileUploader(this);
+    this.upload = fileUploader.upload.bind(fileUploader);
+    const fileDownloader = new FileDownloader(this);
+    this.download = fileDownloader.download.bind(fileDownloader);
+  }
+  /**
+   * DELETE请求方法
+   */
+  delete(url, config) {
+    return this.request(url, { ...config, method: "DELETE" });
+  }
+  /**
+   * GET请求方法
+   */
+  get(url, config) {
+    return this.request(url, { ...config, method: "GET" });
+  }
+  /**
+   * POST请求方法
+   */
+  post(url, data, config) {
+    return this.request(url, { ...config, data, method: "POST" });
+  }
+  /**
+   * PUT请求方法
+   */
+  put(url, data, config) {
+    return this.request(url, { ...config, data, method: "PUT" });
+  }
+  setDefaultHeader(name, value) {
+    this.instance.defaults.headers.common[name] = value;
+  }
+  /**
+   * 通用的请求方法
+   */
+  async request(url, config) {
+    try {
+      const response = await this.instance({
+        url,
+        ...config
+      });
+      return response;
+    } catch (error) {
+      throw error.response ? error.response.data : error;
+    }
+  }
+}
+
+const isFunction = (val) => typeof val === "function";
+function formatToken(token) {
+  return token ? `Bearer ${token}` : null;
+}
+const defaultRequestInterceptor = ({ token }) => {
+  return {
+    fulfilled: (config) => {
+      config.headers.authorization = formatToken(token);
+      return config;
+    }
+  };
+};
+const defaultResponseInterceptor = ({
+  codeField = "code",
+  dataField = "data",
+  successCode = 200
+}) => {
+  return {
+    fulfilled: (response) => {
+      const { config, data: responseData, status } = response;
+      if (config.responseReturn === "raw") {
+        return response;
+      }
+      if (status >= 200 && status < 400) {
+        if (config.responseReturn === "body") {
+          return responseData;
+        } else if (isFunction(successCode) ? successCode(responseData[codeField]) : responseData["info"][codeField] === successCode) {
+          return isFunction(dataField) ? dataField(responseData) : responseData[dataField];
+        }
+      }
+      throw Object.assign({}, response, { response });
+    }
+  };
+};
+const authenticateResponseInterceptor = ({
+  client,
+  doReAuthenticate,
+  doRefreshToken,
+  enableRefreshToken
+}) => {
+  return {
+    rejected: async (error) => {
+      const { config, response } = error;
+      if (response?.status !== 401) {
+        throw error;
+      }
+      if (!enableRefreshToken || config.__isRetryRequest) {
+        await doReAuthenticate();
+        throw error;
+      }
+      if (client.isRefreshing) {
+        return new Promise((resolve) => {
+          client.refreshTokenQueue.push((newToken) => {
+            config.headers.Authorization = formatToken(newToken);
+            resolve(client.request(config.url, { ...config }));
+          });
+        });
+      }
+      client.isRefreshing = true;
+      config.__isRetryRequest = true;
+      try {
+        const newToken = await doRefreshToken();
+        client.refreshTokenQueue.forEach((callback) => callback(newToken));
+        client.refreshTokenQueue = [];
+        return client.request(error.config.url, { ...error.config });
+      } catch (refreshError) {
+        console.log("object", refreshError);
+        client.refreshTokenQueue.forEach((callback) => callback(""));
+        client.refreshTokenQueue = [];
+        await doReAuthenticate();
+        throw refreshError;
+      } finally {
+        client.isRefreshing = false;
+      }
+    }
+  };
+};
+const errorMessageResponseInterceptor = (makeErrorMessage) => {
+  return {
+    rejected: (error) => {
+      if (axios.isCancel(error)) {
+        return Promise.reject(error);
+      }
+      const err = error?.toString?.() ?? "";
+      let errMsg = "";
+      if (err?.includes("Network Error")) {
+        errMsg = "\u7F51\u7EDC\u5F02\u5E38\uFF0C\u8BF7\u68C0\u67E5\u60A8\u7684\u7F51\u7EDC\u8FDE\u63A5\u540E\u91CD\u8BD5\u3002";
+      } else if (error?.message?.includes?.("timeout")) {
+        errMsg = "\u8BF7\u6C42\u8D85\u65F6\uFF0C\u8BF7\u7A0D\u540E\u518D\u8BD5\u3002";
+      }
+      if (errMsg) {
+        makeErrorMessage?.(errMsg, error);
+        return Promise.reject(error);
+      }
+      let errorMessage = "";
+      const status = error?.response?.status;
+      switch (status) {
+        case 400: {
+          errorMessage = "\u8BF7\u6C42\u9519\u8BEF\u3002\u8BF7\u68C0\u67E5\u60A8\u7684\u8F93\u5165\u5E76\u91CD\u8BD5\u3002";
+          break;
+        }
+        case 401: {
+          errorMessage = "\u767B\u5F55\u8BA4\u8BC1\u8FC7\u671F\uFF0C\u8BF7\u91CD\u65B0\u767B\u5F55\u540E\u7EE7\u7EED\u3002";
+          break;
+        }
+        case 403: {
+          errorMessage = "\u7981\u6B62\u8BBF\u95EE, \u60A8\u6CA1\u6709\u6743\u9650\u8BBF\u95EE\u6B64\u8D44\u6E90\u3002";
+          break;
+        }
+        case 404: {
+          errorMessage = "\u672A\u627E\u5230, \u8BF7\u6C42\u7684\u8D44\u6E90\u4E0D\u5B58\u5728\u3002";
+          break;
+        }
+        case 408: {
+          errorMessage = "\u8BF7\u6C42\u8D85\u65F6\uFF0C\u8BF7\u7A0D\u540E\u518D\u8BD5\u3002";
+          break;
+        }
+        default: {
+          errorMessage = "\u5185\u90E8\u670D\u52A1\u5668\u9519\u8BEF\uFF0C\u8BF7\u7A0D\u540E\u518D\u8BD5\u3002";
+        }
+      }
+      makeErrorMessage?.(errorMessage, error);
+      return Promise.reject(error);
+    }
+  };
+};
+
+export { RequestClient, authenticateResponseInterceptor, defaultRequestInterceptor, defaultResponseInterceptor, errorMessageResponseInterceptor, formatToken };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@swiftcrab/request",
+  "version": "1.0.1",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "defu": "^6.1.4",
+    "axios": "^1.9.0"
+  },
+  "devDependencies": {
+    "unbuild": "^3.5.0",
+    "typescript": "^5.8.3",
+    "@swiftcrab/tsconfig": "1.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "build": "pnpm unbuild"
+  }
+}