@nokecy/qc-ui 1.0.93 → 1.0.94

package/dist/esm/ag-grid-plus/schemes/storage/remoteStorageAdapter.d.ts

@@ -0,0 +1,139 @@
+import { ColumnScheme, StorageAdapter } from '../types';
+/**
+ * 存储错误类型
+ */
+export declare enum StorageErrorType {
+    /** 网络错误 */
+    NETWORK_ERROR = "NETWORK_ERROR",
+    /** 请求超时 */
+    TIMEOUT = "TIMEOUT",
+    /** 认证失败 */
+    UNAUTHORIZED = "UNAUTHORIZED",
+    /** 资源不存在 */
+    NOT_FOUND = "NOT_FOUND",
+    /** 服务器错误 */
+    SERVER_ERROR = "SERVER_ERROR",
+    /** 未知错误 */
+    UNKNOWN = "UNKNOWN"
+}
+/**
+ * 存储错误类
+ */
+export declare class StorageError extends Error {
+    type: StorageErrorType;
+    originalError?: any;
+    constructor(type: StorageErrorType, message: string, originalError?: any);
+}
+/**
+ * 远程存储适配器配置
+ */
+export interface RemoteStorageConfig {
+    /** API 基础路径 */
+    apiBaseUrl: string;
+    /** 认证令牌 */
+    getToken?: () => string | null;
+    /** 用户标识获取函数 */
+    getUserId?: () => string | null;
+    /** API 版本,默认 'v1' */
+    apiVersion?: string;
+    /** API 前缀,默认 '/api' */
+    apiPrefix?: string;
+    /** 获取方案列表的 API 路径,如不指定则使用 {apiPrefix}/{apiVersion}/schemes */
+    getSchemesPath?: string;
+    /** 保存方案列表的 API 路径,如不指定则使用 {apiPrefix}/{apiVersion}/schemes */
+    saveSchemesPath?: string;
+    /** 获取当前方案ID的 API 路径,如不指定则使用 {apiPrefix}/{apiVersion}/schemes/current */
+    getCurrentSchemePath?: string;
+    /** 保存当前方案ID的 API 路径,如不指定则使用 {apiPrefix}/{apiVersion}/schemes/current */
+    saveCurrentSchemePath?: string;
+    /** 请求超时时间(毫秒),默认 10000 */
+    timeout?: number;
+    /** 最大重试次数,默认 3 */
+    maxRetries?: number;
+    /** 重试延迟(毫秒),默认 1000 */
+    retryDelay?: number;
+    /** 启用请求缓存,默认 true */
+    enableCache?: boolean;
+    /** 缓存策略,默认 'time-based' */
+    cacheStrategy?: 'time-based' | 'none' | 'forever';
+    /** 缓存过期时间(毫秒),默认 60000 (1分钟) */
+    cacheExpiration?: number;
+    /** 缓存失效回调 */
+    onCacheInvalidate?: (gridId: string) => void;
+}
+export declare class RemoteStorageAdapter implements StorageAdapter {
+    private config;
+    private schemeCache;
+    private currentSchemeCache;
+    private requestControllers;
+    private saveDebouncers;
+    constructor(config: RemoteStorageConfig);
+    /**
+     * 生成请求头
+     */
+    private getHeaders;
+    /**
+     * 生成包含用户ID的完整 URL
+     */
+    private buildUrl;
+    /**
+     * 延迟函数
+     */
+    private delay;
+    /**
+     * 判断错误是否可重试
+     */
+    private isRetryable;
+    /**
+     * 发送 HTTP 请求(带重试机制)
+     */
+    private requestWithRetry;
+    /**
+     * 发送 HTTP 请求(基础实现)
+     */
+    private request;
+    /**
+     * 检查缓存是否有效
+     */
+    private isCacheValid;
+    /**
+     * 智能缓存失效
+     */
+    private invalidateCache;
+    /**
+     * 获取指定表格的所有方案
+     */
+    getSchemes(gridId: string): Promise<ColumnScheme[]>;
+    /**
+     * 保存方案列表到远端
+     */
+    saveSchemes(gridId: string, schemes: ColumnScheme[]): Promise<void>;
+    /**
+     * 清除指定表格的所有方案
+     */
+    clearSchemes(gridId: string): Promise<void>;
+    /**
+     * 获取当前激活的方案ID
+     */
+    getCurrentSchemeId(gridId: string): Promise<string | null>;
+    /**
+     * 保存当前激活的方案ID
+     */
+    saveCurrentSchemeId(gridId: string, schemeId: string | null): Promise<void>;
+    /**
+     * 批量使缓存失效(例如用户登出时)
+     */
+    invalidateAllCache(reason?: string): void;
+    /**
+     * 清除所有缓存
+     */
+    clearCache(): void;
+    /**
+     * 清除指定 gridId 的缓存
+     */
+    clearCacheForGrid(gridId: string): void;
+    /**
+     * 清理资源
+     */
+    dispose(): void;
+}