axios-wrapper-pro 1.0.4 → 1.0.5

package/dist/index.d.mts

@@ -0,0 +1,209 @@
+import * as axios from 'axios';
+import { InternalAxiosRequestConfig, AxiosError, AxiosResponse, AxiosRequestConfig, AxiosInstance } from 'axios';
+
+/**
+ * 扩展 Axios 类型，添加自定义字段
+ */
+declare module "axios" {
+    interface InternalAxiosRequestConfig {
+        /** 内部使用的请求键（用于在响应拦截器中清理 AbortController） */
+        _requestKey?: RequestKey;
+    }
+}
+/** 请求键类型（字符串或符号） */
+type RequestKey = string | symbol;
+/**
+ * 重试配置接口（完整配置）
+ */
+interface RetryConfig {
+    /** 重试次数，默认 0 */
+    count: number;
+    /** 重试延迟（毫秒），默认 1000 */
+    delay: number;
+    /** 重试条件判断函数 */
+    condition: (error: AxiosError) => boolean;
+}
+/**
+ * 拦截器配置接口
+ */
+interface InterceptorConfig {
+    /** 请求拦截器 */
+    request: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
+    /** 请求错误拦截器 */
+    requestError: (error: AxiosError) => Promise<any>;
+    /** 响应拦截器 */
+    response: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
+    /** 响应错误拦截器 */
+    responseError: (error: AxiosError) => Promise<any>;
+}
+/**
+ * 请求配置扩展接口
+ */
+interface RequestConfig extends AxiosRequestConfig {
+    /** 自定义请求标识（用于去重和取消请求） */
+    requestKey?: RequestKey;
+    /** 单次请求的重试配置 */
+    retry?: Partial<RetryConfig>;
+}
+/**
+ * AxiosWrapperPro 构造函数配置选项
+ */
+interface AxiosWrapperProOptions {
+    /** 基础 URL */
+    baseURL?: string;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 默认请求头 */
+    headers?: Record<string, string>;
+    /** 参数序列化函数 */
+    paramsSerializer?: (params: any) => string;
+    /** 拦截器配置 */
+    interceptors?: Partial<InterceptorConfig>;
+    /** 重试配置 */
+    retry?: Partial<RetryConfig>;
+}
+
+declare class AxiosWrapperPro {
+    /** 中断控制器 */
+    private _abortControllers;
+    /** 请求拦截器ID */
+    private _requestInterceptorId;
+    /** 响应拦截器ID */
+    private _responseInterceptorId;
+    /** 拦截器配置 */
+    private _interceptorConfig;
+    /** 重试配置（完整配置） */
+    private _retryConfig;
+    /** 参数序列化函数 */
+    private _paramsSerializer;
+    /** Axios实例 */
+    private _instance;
+    constructor(options?: AxiosWrapperProOptions);
+    /**
+     * 获取拦截器配置，未配置的使用默认值
+     * @returns {InterceptorConfig} 完整的拦截器配置
+     */
+    _getInterceptors(): InterceptorConfig;
+    /**
+     * 初始化请求拦截器
+     */
+    _initRequestInterceptors(): void;
+    /**
+     * 初始化响应拦截器
+     */
+    _initResponseInterceptors(): void;
+    /**
+     * 设置请求拦截器，移除旧拦截器，更新拦截器配置，重新初始化拦截器
+     * @param {InterceptorConfig["request"]} interceptor 拦截器
+     * @param {InterceptorConfig["requestError"]} errorInterceptor 错误拦截器
+     */
+    setRequestInterceptor(interceptor: InterceptorConfig["request"], errorInterceptor: InterceptorConfig["requestError"]): void;
+    /**
+     * 设置响应拦截器，移除旧拦截器，更新拦截器配置，重新初始化拦截器
+     * @param {InterceptorConfig["response"]} interceptor 拦截器
+     * @param {InterceptorConfig["responseError"]} errorInterceptor 错误拦截器
+     */
+    setResponseInterceptor(interceptor: InterceptorConfig["response"], errorInterceptor: InterceptorConfig["responseError"]): void;
+    /**
+     * 设置取消控制器
+     * @param {AxiosRequestConfig} config 请求配置
+     * @param {RequestKey} customKey 自定义key
+     * @returns {InternalAxiosRequestConfig} 处理后的配置
+     */
+    _setupAbortController(config: AxiosRequestConfig, customKey: RequestKey): InternalAxiosRequestConfig;
+    /**
+     * 生成请求唯一标识
+     * @param {AxiosRequestConfig} config 请求配置
+     * @returns {string} 请求唯一标识
+     */
+    _generateRequestKey(config: AxiosRequestConfig): string;
+    /**
+     * 稳定的JSON序列化，确保相同内容生成相同字符串
+     * @param {any} obj 待序列化对象
+     * @returns {string} 序列化后的字符串
+     */
+    _stableStringify(obj: any): string;
+    /**
+     * 取消指定请求
+     * @param {RequestKey} key 请求标识
+     * @param {string} [reason] 取消原因
+     * @returns {boolean} 是否成功取消
+     */
+    cancelRequest(key: RequestKey, reason?: string): boolean;
+    /**
+     * 取消所有请求
+     * @param {string} [reason] 取消原因
+     * @returns {number} 被取消的请求数量
+     */
+    cancelAllRequests(reason?: string): number;
+    /**
+     * 设置默认请求头
+     * @param {string} key 请求头名称
+     * @param {string} value 请求头值
+     */
+    setHeader(key: string, value: string): void;
+    /**
+     * 批量设置请求头
+     * @param {Record<string, string>} headers 请求头对象
+     */
+    setHeaders(headers: Record<string, string>): void;
+    /**
+     * 移除请求头
+     * @param {string} key 请求头名称
+     */
+    removeHeader(key: string): void;
+    /** 获取基础URL */
+    getBaseURL(): string;
+    /** 设置基础URL */
+    setBaseURL(url: string): void;
+    /** 获取 Axios 实例 */
+    getInstance(): AxiosInstance;
+    /**
+     * 通用请求方法
+     * @param {string} method 请求方法
+     * @param {string} url 请求地址
+     * @param {RequestConfig} [config={}] 请求配置
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    request(method: string, url: string, config?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+    /**
+     * GET请求
+     * @param {string} url 请求地址
+     * @param {RequestConfig} [options] 请求选项
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    get(url: string, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+    /**
+     * POST请求
+     * @param {string} url 请求地址
+     * @param {any} [data] 请求数据
+     * @param {RequestConfig} [options] 其他选项
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    post(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+    /**
+     * PUT请求
+     * @param {string} url 请求地址
+     * @param {any} [data] 请求数据
+     * @param {RequestConfig} [options] 其他选项
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    put(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+    /**
+     * DELETE请求
+     * @param {string} url 请求地址
+     * @param {RequestConfig} [options] 请求选项
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    delete(url: string, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+    /**
+     * PATCH请求
+     * @param {string} url 请求地址
+     * @param {any} [data] 请求数据
+     * @param {RequestConfig} [options] 其他选项
+     * @returns {Promise<AxiosResponse>} 响应数据
+     */
+    patch(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
+}
+
+export { AxiosWrapperPro, type AxiosWrapperProOptions, type InterceptorConfig, type RequestConfig, type RequestKey, type RetryConfig };

package/dist/index.d.ts

@@ -1,5 +1,68 @@
-import { AxiosInstance, AxiosRequestConfig, InternalAxiosRequestConfig } from "axios";
-import type { AxiosWrapperProOptions, InterceptorConfig, RequestConfig, RequestKey } from "./types";
+import * as axios from 'axios';
+import { InternalAxiosRequestConfig, AxiosError, AxiosResponse, AxiosRequestConfig, AxiosInstance } from 'axios';
+
+/**
+ * 扩展 Axios 类型，添加自定义字段
+ */
+declare module "axios" {
+    interface InternalAxiosRequestConfig {
+        /** 内部使用的请求键（用于在响应拦截器中清理 AbortController） */
+        _requestKey?: RequestKey;
+    }
+}
+/** 请求键类型（字符串或符号） */
+type RequestKey = string | symbol;
+/**
+ * 重试配置接口（完整配置）
+ */
+interface RetryConfig {
+    /** 重试次数，默认 0 */
+    count: number;
+    /** 重试延迟（毫秒），默认 1000 */
+    delay: number;
+    /** 重试条件判断函数 */
+    condition: (error: AxiosError) => boolean;
+}
+/**
+ * 拦截器配置接口
+ */
+interface InterceptorConfig {
+    /** 请求拦截器 */
+    request: (config: InternalAxiosRequestConfig) => InternalAxiosRequestConfig | Promise<InternalAxiosRequestConfig>;
+    /** 请求错误拦截器 */
+    requestError: (error: AxiosError) => Promise<any>;
+    /** 响应拦截器 */
+    response: (response: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>;
+    /** 响应错误拦截器 */
+    responseError: (error: AxiosError) => Promise<any>;
+}
+/**
+ * 请求配置扩展接口
+ */
+interface RequestConfig extends AxiosRequestConfig {
+    /** 自定义请求标识（用于去重和取消请求） */
+    requestKey?: RequestKey;
+    /** 单次请求的重试配置 */
+    retry?: Partial<RetryConfig>;
+}
+/**
+ * AxiosWrapperPro 构造函数配置选项
+ */
+interface AxiosWrapperProOptions {
+    /** 基础 URL */
+    baseURL?: string;
+    /** 超时时间（毫秒） */
+    timeout?: number;
+    /** 默认请求头 */
+    headers?: Record<string, string>;
+    /** 参数序列化函数 */
+    paramsSerializer?: (params: any) => string;
+    /** 拦截器配置 */
+    interceptors?: Partial<InterceptorConfig>;
+    /** 重试配置 */
+    retry?: Partial<RetryConfig>;
+}
+
 declare class AxiosWrapperPro {
     /** 中断控制器 */
     private _abortControllers;
@@ -102,14 +165,14 @@ declare class AxiosWrapperPro {
      * @param {RequestConfig} [config={}] 请求配置
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    request(method: string, url: string, config?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    request(method: string, url: string, config?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
     /**
      * GET请求
      * @param {string} url 请求地址
      * @param {RequestConfig} [options] 请求选项
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    get(url: string, options?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    get(url: string, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
     /**
      * POST请求
      * @param {string} url 请求地址
@@ -117,7 +180,7 @@ declare class AxiosWrapperPro {
      * @param {RequestConfig} [options] 其他选项
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    post(url: string, data?: any, options?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    post(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
     /**
      * PUT请求
      * @param {string} url 请求地址
@@ -125,14 +188,14 @@ declare class AxiosWrapperPro {
      * @param {RequestConfig} [options] 其他选项
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    put(url: string, data?: any, options?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    put(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
     /**
      * DELETE请求
      * @param {string} url 请求地址
      * @param {RequestConfig} [options] 请求选项
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    delete(url: string, options?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    delete(url: string, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
     /**
      * PATCH请求
      * @param {string} url 请求地址
@@ -140,8 +203,7 @@ declare class AxiosWrapperPro {
      * @param {RequestConfig} [options] 其他选项
      * @returns {Promise<AxiosResponse>} 响应数据
      */
-    patch(url: string, data?: any, options?: RequestConfig): Promise<import("axios").AxiosResponse<any, any, {}>>;
+    patch(url: string, data?: any, options?: RequestConfig): Promise<axios.AxiosResponse<any, any, {}>>;
 }
-export { AxiosWrapperPro };
-export type { AxiosWrapperProOptions, RetryConfig, InterceptorConfig, RequestConfig, RequestKey } from "./types";
-//# sourceMappingURL=index.d.ts.map
+
+export { AxiosWrapperPro, type AxiosWrapperProOptions, type InterceptorConfig, type RequestConfig, type RequestKey, type RetryConfig };