@robot-admin/request-core 0.2.0 → 0.4.1

package/dist/axios.d.ts

@@ -1,232 +1,67 @@
-import { AxiosRequestConfig, AxiosInstance, InternalAxiosRequestConfig } from 'axios';
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { b as CacheStore, o as RequestPolicyDefaults, e as EnhancedAxiosRequestConfig, p as RequestScope, E as EnhancedAxiosInstance, g as RequestClientConfig, f as RequestClient, M as MemoryCacheOptions, m as RequestKeyOptions } from './types-BVJhlSuh.js';
+export { B as BusinessErrorDescriptor, C as CacheConfig, a as CacheItem, c as CancelConfig, d as ConcurrencyPolicy, D as DedupeConfig, F as FieldAliases, I as InterceptorConfig, R as RequestAuthConfig, h as RequestConfig, i as RequestCoreConfig, j as RequestError, k as RequestHooks, l as RequestInterceptors, n as RequestKeyParams, q as ResponseAdapter, r as RetryConfig, s as RetryContext, t as createRequestCore, u as getGlobalConfig, v as isCanceledError, w as isRequestError, x as normalizeRequestError } from './types-BVJhlSuh.js';
+import 'vue';
 
-/**
- * 请求去重配置
- */
-interface DedupeConfig {
-    /** 是否启用去重（默认 true） */
-    enabled?: boolean;
-    /** 自定义请求 key 生成函数 */
-    keyGenerator?: (config: AxiosRequestConfig) => string;
-}
-/**
- * 请求缓存配置
- */
-interface CacheConfig {
-    /** 是否启用缓存（默认 false，只对 GET 请求有效） */
-    enabled?: boolean;
-    /** 缓存时间（毫秒，默认 5 分钟） */
-    ttl?: number;
-    /** 是否强制刷新缓存 */
-    forceUpdate?: boolean;
-}
-/**
- * 请求重试配置
- */
-interface RetryConfig {
-    /** 是否启用重试（默认 false） */
-    enabled?: boolean;
-    /** 重试次数（默认 3） */
-    count?: number;
-    /** 重试延迟（毫秒，默认 1000） */
-    delay?: number;
-    /** 是否使用指数退避（默认 true） */
-    exponentialBackoff?: boolean;
-    /** 是否启用随机抖动（默认 true），避免重试风暴 */
-    jitter?: boolean;
-    /** 可重试的 HTTP 状态码 */
-    retryableStatusCodes?: number[];
-    /** 允许重试的 HTTP 方法（默认仅幂等方法，避免对非幂等 POST/PUT/DELETE 重复执行副作用） */
-    retryableMethods?: string[];
-}
-/**
- * 路由取消配置
- */
-interface CancelConfig {
-    /** 是否启用路由切换时自动取消（默认 true） */
-    enabled?: boolean;
-    /** 白名单：不需要取消的请求 URL 模式 */
-    whitelist?: RegExp[];
-}
-/**
- * 扩展的 Axios 请求配置
- */
-interface EnhancedAxiosRequestConfig extends AxiosRequestConfig {
-    /** 请求去重配置 */
-    dedupe?: boolean | DedupeConfig;
-    /** 请求缓存配置 */
-    cache?: boolean | CacheConfig;
-    /** 请求重试配置 */
-    retry?: boolean | RetryConfig;
-    /** 路由取消配置 */
-    cancel?: boolean | CancelConfig;
-    /** 内部标记：当前重试次数 */
-    __retryCount?: number;
-    /** 内部标记：取消请求 ID */
-    __cancelId?: string;
-    /** 内部标记：去重请求键 */
-    __requestKey?: string;
-    /** 内部标记：是否来自缓存 */
-    __fromCache?: boolean;
-    /** 内部标记：共享的 AbortController（dedupe 与 cancel 复用，避免 signal 互相覆盖） */
-    __abortController?: EnhancedAbortController;
-    /** 内部标记：调用方原始 AbortSignal，用于在最终响应阶段恢复配置 */
-    __externalSignal?: AxiosRequestConfig["signal"];
-    /** 内部标记：移除外部 AbortSignal 桥接监听器 */
-    __abortCleanup?: () => void;
-    /** 内部标记：是否被 cancel 插件管理（保留兼容） */
-    __managedByCancel?: boolean;
-    /** 内部标记：是否正在处理 401 错误 */
-    __handling401?: boolean;
-}
-/**
- * 缓存项
- */
-interface CacheItem<T = any> {
-    /** 缓存数据 */
-    data: T;
-    /** 过期时间戳 */
-    expireAt: number;
-}
-/**
- * 请求 key 生成器参数
- */
-interface RequestKeyParams {
-    method?: string;
-    url?: string;
-    params?: any;
-    data?: any;
-}
-/**
- * 扩展的 AbortController 接口
- */
-interface EnhancedAbortController extends AbortController {
-    /** 请求开始时间 */
-    _startTime?: number;
+interface CreateRequestRuntimeOptions {
+    cache?: CacheStore;
+    defaults?: RequestPolicyDefaults;
 }
 
 declare function setGlobalAxiosInstance(instance: AxiosInstance): void;
 declare function getGlobalAxiosInstance(): AxiosInstance;
-declare function getData<T = any>(url: string, config?: EnhancedAxiosRequestConfig): Promise<T>;
-declare function postData<T = any>(url: string, data?: any, config?: EnhancedAxiosRequestConfig): Promise<T>;
-declare function putData<T = any>(url: string, data?: any, config?: EnhancedAxiosRequestConfig): Promise<T>;
-declare function deleteData<T = any>(url: string, config?: EnhancedAxiosRequestConfig): Promise<T>;
+declare function getData<T = unknown>(url: string, config?: EnhancedAxiosRequestConfig): Promise<T>;
+declare function postData<T = unknown, D = unknown>(url: string, data?: D, config?: EnhancedAxiosRequestConfig<D>): Promise<T>;
+declare function putData<T = unknown, D = unknown>(url: string, data?: D, config?: EnhancedAxiosRequestConfig<D>): Promise<T>;
+declare function patchData<T = unknown, D = unknown>(url: string, data?: D, config?: EnhancedAxiosRequestConfig<D>): Promise<T>;
+declare function deleteData<T = unknown>(url: string, config?: EnhancedAxiosRequestConfig): Promise<T>;
+
+declare function waitForReLogin(instance?: AxiosInstance): Promise<void>;
+declare function getReLoginPromise(instance?: AxiosInstance): Promise<void> | null;
 
-/**
- * 创建重新登录 Promise
- */
-declare function waitForReLogin(): Promise<void>;
-/**
- * 获取重新登录 Promise
- */
-declare function getReLoginPromise(): Promise<void> | null;
+declare function cancelAllPendingRequests(instance?: AxiosInstance): void;
+declare function getPendingRequestCount(instance?: AxiosInstance): number;
 
-/**
- * 取消所有待处理的请求
- *
- * 使用场景：
- * - 用户登出时清理所有请求
- * - 网络异常时重置请求状态
- * - 调试和测试场景
- *
- * 安全机制：
- * - 捕获每个取消操作的异常
- * - 确保一个请求的失败不影响其他请求的取消
- * - 完全清理 Map 中的所有引用
- */
-declare function cancelAllPendingRequests(): void;
-/**
- * 获取待处理请求数量
- *
- * @returns 当前待处理的请求数量
- *
- * 监控用途：
- * - 性能监控和分析
- * - 调试请求状态
- * - 检测潜在的请求泄漏
- * - 评估去重效果
- */
-declare function getPendingRequestCount(): number;
+declare function clearAllCache(instance?: AxiosInstance): void;
+declare function clearCache(config: AxiosRequestConfig, instance?: AxiosInstance): boolean;
+declare function clearCacheByPrefix(prefix: string, instance?: AxiosInstance): number;
+declare function clearCacheByTag(tag: string, instance?: AxiosInstance): number;
+declare function cleanupExpiredCache(instance?: AxiosInstance): void;
+declare function getCacheSize(instance?: AxiosInstance): number;
 
-/**
- * 清空所有缓存
- *
- * 用于：
- * - 用户登出时清理敏感数据
- * - 开发调试时重置缓存状态
- */
-declare function clearAllCache(): void;
-/**
- * 删除指定缓存
- *
- * @param config 请求配置
- * @returns 是否删除成功
- *
- * 用于：
- * - 数据更新时清理特定缓存
- * - 缓存失效时的精确清理
- */
-declare function clearCache(config: InternalAxiosRequestConfig): boolean;
-/**
- * 清理过期缓存
- *
- * 自动清理机制：
- * - 由 globalCache 内部实现
- * - 基于 TTL 过期时间
- * - 定期清理防止内存泄漏
- */
-declare function cleanupExpiredCache(): void;
-/**
- * 获取缓存大小
- *
- * @returns 当前缓存条目数量
- *
- * 用于：
- * - 监控缓存使用情况
- * - 性能分析和调试
- */
-declare function getCacheSize(): number;
+declare function cancelAllRequests(instance?: AxiosInstance): void;
+declare function cancelRequestScope(scope: RequestScope, instance?: AxiosInstance): number;
+declare function getCancelableRequestCount(instance?: AxiosInstance): number;
 
-/**
- * 取消所有待处理的请求
- *
- * 使用场景：
- * - 路由切换时取消当前页面的所有请求
- * - 用户登出时清理所有请求
- * - 网络异常时重置请求状态
- *
- * 安全机制：
- * - 捕获每个取消操作的异常
- * - 确保一个请求的失败不影响其他请求的取消
- */
-declare function cancelAllRequests(): void;
-/**
- * 获取待取消请求数量
- *
- * @returns 当前待取消的请求数量
- *
- * 监控用途：
- * - 性能监控和分析
- * - 调试请求状态
- * - 检测潜在的请求泄漏
- */
-declare function getCancelableRequestCount(): number;
+/** Creates an isolated Axios instance with request-core lifecycle policies. */
+declare function createAxiosInstance(config?: AxiosRequestConfig, runtimeOptions?: CreateRequestRuntimeOptions): EnhancedAxiosInstance;
 
-/**
- * 创建 axios 实例
- * @param config axios 配置
- */
-declare function createAxiosInstance(config?: AxiosRequestConfig): AxiosInstance;
+declare const onReLoginSuccess: (instance?: AxiosInstance) => void;
+declare const onReLoginCancel: (instance?: AxiosInstance) => void;
 
-/**
- * 重新登录成功后的回调
- * 调用此函数会 resolve 所有等待中的请求
- */
-declare const onReLoginSuccess: () => void;
-/**
- * 重新登录取消后的回调
- * 调用此函数会 reject 所有等待中的请求
- */
-declare const onReLoginCancel: () => void;
+declare function createRequestClient(config?: RequestClientConfig): RequestClient;
+declare function setDefaultRequestClient(client: RequestClient): void;
+
+declare function generateRequestKey(config: AxiosRequestConfig, options?: RequestKeyOptions): string;
+declare class MemoryCache implements CacheStore {
+    private readonly cache;
+    private readonly accessOrder;
+    private maxSize;
+    private readonly cloneValue;
+    constructor(options?: MemoryCacheOptions);
+    get<T = unknown>(key: string): T | null;
+    set<T = unknown>(key: string, data: T, ttl: number, options?: {
+        tags?: readonly string[];
+    }): void;
+    delete(key: string): boolean;
+    clear(): void;
+    cleanup(): void;
+    deleteByPrefix(prefix: string): number;
+    deleteByTag(tag: string): number;
+    get size(): number;
+    setMaxSize(size: number): void;
+    private assertMaxSize;
+    private evictOldest;
+}
 
-export { type CacheConfig, type CacheItem, type CancelConfig, type DedupeConfig, type EnhancedAxiosRequestConfig, type RequestKeyParams, type RetryConfig, cancelAllPendingRequests, cancelAllRequests, cleanupExpiredCache, clearAllCache, clearCache, createAxiosInstance, deleteData, getCacheSize, getCancelableRequestCount, getData, getGlobalAxiosInstance, getPendingRequestCount, getReLoginPromise, onReLoginCancel, onReLoginSuccess, postData, putData, setGlobalAxiosInstance, waitForReLogin };
+export { CacheStore, EnhancedAxiosInstance, EnhancedAxiosRequestConfig, MemoryCache, MemoryCacheOptions, RequestClient, RequestClientConfig, RequestKeyOptions, RequestPolicyDefaults, RequestScope, cancelAllPendingRequests, cancelAllRequests, cancelRequestScope, cleanupExpiredCache, clearAllCache, clearCache, clearCacheByPrefix, clearCacheByTag, createAxiosInstance, createRequestClient, deleteData, generateRequestKey, getCacheSize, getCancelableRequestCount, getData, getGlobalAxiosInstance, getPendingRequestCount, getReLoginPromise, onReLoginCancel, onReLoginSuccess, patchData, postData, putData, setDefaultRequestClient, setGlobalAxiosInstance, waitForReLogin };