rxtutils 1.1.2-beta.12 → 1.1.2-beta.13

package/cjs/cache/index.d.ts

@@ -0,0 +1,141 @@
+import { IndexedDBStorage } from './indexDB.js';
+
+/**
+ * 缓存存储类型
+ * - sessionStorage: 会话存储，浏览器关闭后清除
+ * - localStorage: 本地存储，永久保存
+ * - indexedDB: IndexedDB 数据库存储
+ */
+type StorageType = "sessionStorage" | "localStorage" | "indexedDB";
+/**
+ * 缓存项接口定义
+ * 定义了单个缓存项的数据结构
+ *
+ * @template Param 缓存参数类型
+ * @template Data 缓存数据类型
+ */
+interface ICache<Param, Data> {
+    /**
+     * 缓存的参数
+     * 用于标识和查找缓存项
+     */
+    params: Param;
+    /**
+     * 缓存的数据
+     * 实际存储的内容
+     */
+    data: Data;
+    /**
+     * 过期时间
+     * - ISO 8601 格式的字符串
+     * - 由 moment().add(cacheTime, 'seconds').toJSON() 生成
+     * - 示例：'2025-06-12T10:30:00.000Z'
+     */
+    expireTime: string;
+}
+/**
+ * 缓存选项接口
+ * @template Param 缓存参数类型
+ */
+interface ICacheOptions<Param> {
+    /**
+     * 存储类型
+     * - 'sessionStorage': 会话存储，浏览器关闭后清除
+     * - 'localStorage': 本地存储，永久保存
+     * - 'indexedDB': IndexedDB 数据库存储
+     * - undefined: 仅在内存中缓存（默认值）
+     */
+    storageType?: StorageType;
+    /**
+     * 缓存键名
+     * - 当使用 localStorage/sessionStorage 时必须提供
+     * - 用于在存储中标识不同的缓存数据
+     * @default undefined 不使用持久化存储
+     */
+    cacheKey?: string;
+    /**
+     * 缓存时间（秒）
+     * - 超过这个时间的缓存项会被自动清除
+     * @default 60 一分钟
+     */
+    cacheTime?: number;
+    /**
+     * 缓存键比较函数
+     * - 用于判断两个缓存参数是否相等
+     * - 相等则认为是同一个缓存项
+     * @param prev 前一个参数
+     * @param next 后一个参数
+     * @returns 是否相等
+     * @default defaultEquals 使用 JSON.stringify 进行比较
+     */
+    cacheKeyEquals: (prev: Param, next: Param) => boolean;
+    /**
+     * IndexedDB 数据库名称
+     * - 仅在 storageType 为 'indexedDB' 时使用
+     * @default '__apiCacheDatabase__'
+     */
+    indexDBName?: string;
+}
+/** 存储类型映射表 */
+declare const StorageMap: Record<StorageType | string, Storage>;
+/**
+ * 缓存类
+ * @template Param 缓存参数类型
+ * @template Data 缓存数据类型
+ */
+declare class Cache<Param, Data> {
+    /** 内存中的缓存数组 */
+    cache: ICache<Param, Data>[];
+    /** 缓存选项 */
+    private cacheOptions;
+    /** 存储实例 */
+    storage?: Storage | IndexedDBStorage;
+    /**
+     * 构造函数
+     * @param cacheType 存储类型
+     * @param cacheKey 缓存键名
+     * @param cacheTime 缓存时间（秒）
+     * @param indexDBName IndexedDB 数据库名称，默认值为 '__apiCacheDatabase__'
+     * @param cacheKeyEquals 缓存键比较函数，默认使用 defaultEquals
+     */
+    constructor(cacheType?: StorageType, cacheKey?: string, cacheTime?: number, indexDBName?: string, cacheKeyEquals?: (prev: Param, next: Param) => boolean);
+    /**
+     * 初始化缓存
+     * 从存储中加载已保存的缓存数据，并进行解析和过期处理
+     * @private
+     */
+    private _init;
+    /**
+     * 过滤掉已过期的缓存项
+     * 通过比较当前时间和过期时间，移除过期的缓存项
+     * @private
+     */
+    private _filterExpired;
+    /**
+     * 将当前缓存数据保存到存储中
+     * 如果设置了缓存键名且存储实例存在，则将缓存数据序列化后保存
+     * @private
+     */
+    private _saveToStorage;
+    /**
+     * 设置缓存数据
+     * @param params 缓存的参数
+     * @param data 要缓存的数据
+     * @param cacheOptions 可选的缓存配置，可以覆盖默认的缓存时间
+     */
+    setCache(params: Param, data: Data, cacheOptions?: Omit<ICacheOptions<Param>, "storageType" | "cacheKey" | "cacheKeyEquals">): void;
+    /**
+     * 获取缓存数据
+     * @param params 查询参数
+     * @returns 如果找到有效的缓存数据则返回数据，否则返回 null
+     */
+    getCache(params: Param): Data;
+    /**
+     * 清空所有缓存数据
+     * 清空内存中的缓存数组并同步到存储中
+     */
+    clear(): void;
+}
+
+export { StorageMap, Cache as default };
+export type { ICache, ICacheOptions, StorageType };

package/cjs/cache/indexDB.d.ts

@@ -0,0 +1,52 @@
+/**
+ * IndexedDB 存储类
+ * 提供了对 IndexedDB 数据库操作的简单封装
+ */
+declare class IndexedDBStorage {
+    /** 数据库名称 */
+    private dbName;
+    /** 存储对象名称 */
+    private storeName;
+    /** 数据库连接实例 */
+    private db;
+    /**
+     * 构造函数
+     * @param dbName 数据库名称
+     * @param storeName 存储对象名称
+     */
+    constructor(dbName: string, storeName: string);
+    /**
+     * 打开数据库连接
+     * 如果数据库不存在则创建新的数据库和存储对象
+     * @private
+     * @returns Promise<IDBDatabase> 数据库连接实例
+     */
+    private _open;
+    /**
+     * 获取存储对象
+     * @param mode 事务模式，默认为只读模式
+     * - readonly: 只读模式
+     * - readwrite: 读写模式
+     * @private
+     * @returns Promise<IDBObjectStore> 存储对象实例
+     */
+    private _getStore;
+    /**
+     * 设置键值对
+     * @param key 键名
+     * @param value 要存储的值
+     * @returns Promise<void> 存储操作的结果
+     * @throws 当存储操作失败时抛出错误
+     */
+    setItem<T>(key: string, value: T): Promise<void>;
+    /**
+     * 获取键对应的值
+     * @param key 要获取的键名
+     * @returns Promise<T> 返回存储的值，如果不存在则返回 undefined
+     * @throws 当获取操作失败时抛出错误
+     * @template T 存储值的类型，默认为 any
+     */
+    getItem<T = any>(key: string): Promise<T>;
+}
+
+export { IndexedDBStorage };

package/cjs/index.d.ts

@@ -0,0 +1,7 @@
+export { default as Cache, ICache, ICacheOptions, StorageMap, StorageType } from './cache/index.js';
+export { ErrorHandlerReturnType, Options, RequestOptions, default as createBaseRequest } from './request/index.js';
+export { createStoreGetter, createStoreGetterMemo } from './store/createGetter/index.js';
+export { IHookStateInitAction, IHookStateInitialSetter, IHookStateResolvable, IHookStateSetAction, IHookStateSetter, default as createStateStore } from './store/createStateStore/index.js';
+export { BaseValidator } from './validator/validator.js';
+export { VArray, VBoolean, VEmail, VMax, VMaxLength, VMin, VMinLength, VNumber, VPattern, VRequired, VString } from './validator/decorators.js';
+export { default as RequestError, RequestErrorType } from './request/error.js';

package/cjs/request/error.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 请求错误类型
+ * - server: 服务端业务错误
+ * - http: HTTP 网络错误
+ */
+type RequestErrorType = 'server' | 'http';
+/**
+ * 请求错误类
+ * 用于统一处理请求过程中的各种错误
+ *
+ * @template Data 错误数据类型
+ * @extends Error
+ */
+declare class RequestError<Data = any> extends Error {
+    /** 错误码 */
+    code: string;
+    /** 错误类型 */
+    type: RequestErrorType;
+    /** 错误相关的数据 */
+    data?: Data;
+    /**
+     * 构造函数
+     * @param message 错误消息
+     * @param type 错误类型
+     * @param data 错误相关的数据
+     */
+    constructor(message: string, type: RequestErrorType, data?: Data);
+}
+
+export { RequestError as default };
+export type { RequestErrorType };

package/cjs/request/index.d.ts

@@ -0,0 +1,139 @@
+import { AxiosResponse, Method, AxiosRequestConfig } from 'axios';
+import { StorageType } from '../cache/index.js';
+
+/**
+ * 错误处理器返回类型
+ * @template D 响应数据类型
+ */
+type ErrorHandlerReturnType<D> = {
+    /** 替换响应数据 */
+    replaceResData?: D;
+    /**
+     * 是否抛出错误
+     * - true: 强制抛出错误
+     * - false: 不抛出错误
+     * - 'default': 使用默认错误处理逻辑
+     */
+    throwError?: boolean | "default";
+};
+/**
+ * 请求配置选项接口
+ * @template Params 请求参数类型
+ * @template Data 响应数据类型
+ */
+interface Options<Params = any, Data = any> {
+    /** 请求基础URL，默认为空字符串 */
+    baseURL?: string;
+    /**
+     * 是否抛出错误
+     * @default true
+     */
+    throwError?: boolean;
+    /**
+     * 默认的消息展示函数
+     * @default window.alert
+     */
+    defaultMessageShower?: (message: string) => void;
+    /**
+     * 是否启用缓存功能
+     * @default false
+     */
+    enableCache?: boolean;
+    /**
+     * 缓存键比较函数
+     * @default defaultEquals 使用 JSON.stringify 进行比较
+     */
+    cacheKeyEquals?: (prev: Params, next: Params) => boolean;
+    /**
+     * 是否将响应数据存入缓存
+     * @default false
+     */
+    cacheData?: boolean;
+    /**
+     * 缓存时间（秒）
+     * @default 60
+     */
+    cacheTime?: number;
+    /**
+     * 缓存数据的存储类型
+     * - localStorage: 使用浏览器本地存储，数据永久保存
+     * - sessionStorage: 使用会话存储，关闭浏览器后清除
+     * - indexedDB: 使用 IndexedDB 数据库存储
+     * - 不填则仅在内存中缓存，页面刷新后清除
+     */
+    cacheDataInStorage?: StorageType;
+    /**
+     * 缓存数据的键名
+     * @default `${method}:${baseURL}${url}` 默认使用请求方法、基础URL和请求路径组合
+     */
+    cacheDataKey?: string;
+    /**
+     * IndexedDB 数据库名称
+     * @default '__apiCacheDatabase__'
+     */
+    indexDBName?: string;
+    /**
+     * 错误码在响应数据中的路径
+     * @default 'code'
+     */
+    errorCodePath?: string;
+    /**
+     * 错误码映射表
+     * 可以配置错误码对应的错误信息或处理函数
+     * @default {} 空对象，使用默认处理函数
+     */
+    errorCodeMap?: Record<string, string | ((code: string, data: Data, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => ErrorHandlerReturnType<Data> | void)>;
+    /**
+     * 默认错误码处理函数
+     * 当错误码不在 errorCodeMap 中时调用
+     */
+    defaultErrorCodeHandler?: (code: string, data: Data, res: AxiosResponse<Data>) => Promise<ErrorHandlerReturnType<Data> | void>;
+    /**
+     * 成功状态的错误码列表
+     * @default ['0', '200']
+     */
+    successCodes?: string[];
+    /**
+     * HTTP 错误码映射表
+     * 可以配置 HTTP 状态码对应的错误信息或处理函数
+     * @default {} 空对象，使用默认处理函数
+     */
+    httpErrorCodeMap?: Record<string, string | ((code: number, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => Promise<ErrorHandlerReturnType<Data> | void>)>;
+    /**
+     * 默认 HTTP 错误码处理函数
+     * 当 HTTP 状态码不在 httpErrorCodeMap 中时调用
+     */
+    defaultHttpErrorCodeHandler?: (code: number, error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
+    /**
+     * 其他错误处理函数
+     * 处理非 HTTP 错误和非业务错误码的错误
+     */
+    otherErrorHandler?: (error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
+    axiosOptions?: Omit<AxiosRequestConfig<Params>, "method" | "url" | "params" | "data">;
+}
+/**
+ * 请求参数接口
+ * @template Param 请求参数类型
+ */
+interface RequestOptions<Param> {
+    /** HTTP 请求方法 */
+    method: Method;
+    /** 请求URL */
+    url: string;
+    /** POST/PUT 等请求的数据 */
+    data?: Param;
+    /** URL 查询参数 */
+    params?: Param;
+}
+/**
+ * 创建基础请求实例
+ * @param baseOptions 基础配置选项
+ * @returns 请求创建函数
+ */
+declare function createBaseRequest(baseOptions?: Options): <Param, Data extends Record<any, any>>(requestOptions: RequestOptions<Param>, createOptions?: Omit<Options<Param, Data>, "baseURL">) => {
+    (requestParam?: Omit<RequestOptions<Param>, "url" | "method">, options?: Omit<Options<Param, Data>, "baseURL" | "cacheDataKey" | "cacheDataInStorage" | "cacheKeyEquals">): Promise<Data>;
+    clearCache(): void;
+};
+
+export { createBaseRequest as default };
+export type { ErrorHandlerReturnType, Options, RequestOptions };

package/cjs/store/createGetter/index.d.ts

@@ -0,0 +1,30 @@
+import createStateStore from '../createStateStore/index.js';
+
+type StoreGetter<S = any> = {
+    [K in string]: (store: S) => any;
+};
+type GetterNameMap<G extends StoreGetter<any>> = {
+    [K in keyof G]: string;
+};
+type ReducedData<G extends StoreGetter<any>, M extends GetterNameMap<G>> = {
+    [K in keyof M as M[K]]: G[K extends keyof G ? K : never] extends (store: any) => infer R ? R : never;
+};
+/**
+ * 创建 store getter
+ * @param store store实例
+ * @param getters getter函数
+ * @param getterNameMaps 将 getter 函数和 getter 名称一一映射
+ * @returns getter object
+ */
+declare const createStoreGetter: <S, G extends StoreGetter<S>, M extends GetterNameMap<G>>(store: ReturnType<typeof createStateStore<S>>, getters: G, getterNameMaps: M) => ReducedData<G, M>;
+/**
+ *
+ * @param store store实例
+ * @param getters getter函数
+ * @param getterNameMaps 将 getter 函数和 getter 名称一一映射
+ * @returns getter memo hook
+ */
+declare const createStoreGetterMemo: <S, G extends StoreGetter<S>, M extends GetterNameMap<G>>(store: ReturnType<typeof createStateStore<S>>, getters: G, getterNameMaps: M) => () => ReducedData<G, M>;
+
+export { createStoreGetter, createStoreGetterMemo };
+export type { GetterNameMap, ReducedData, StoreGetter };

package/cjs/store/createStateStore/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 状态初始化设置器类型
+ * 用于延迟初始化状态的函数类型
+ */
+type IHookStateInitialSetter<S> = () => S;
+/**
+ * 状态初始化动作类型
+ * 可以是直接的状态值或初始化设置器
+ */
+type IHookStateInitAction<S> = S | IHookStateInitialSetter<S>;
+/**
+ * 状态设置器类型
+ * 可以是接收前一个状态的函数或无参数的函数
+ */
+type IHookStateSetter<S> = ((prevState: S) => S) | (() => S);
+/**
+ * 状态设置动作类型
+ * 可以是直接的状态值或状态设置器
+ */
+type IHookStateSetAction<S> = S | IHookStateSetter<S>;
+/**
+ * 可解析的状态类型
+ * 包含所有可能的状态值或状态设置函数
+ */
+type IHookStateResolvable<S> = S | IHookStateInitialSetter<S> | IHookStateSetter<S>;
+/**
+ * 创建状态存储
+ * 提供一个简单的状态管理解决方案，支持组件间状态共享
+ *
+ * @template S 状态类型
+ * @param initialState 初始状态值或初始化函数
+ * @returns 包含状态操作方法的对象
+ */
+declare function createStateStore<S>(initialState?: S): {
+    use: () => [S, (state: IHookStateSetAction<S>) => void];
+    get: () => S;
+    set: (state: IHookStateSetAction<S>) => void;
+    watch: (callback: (state: S) => S | void) => () => void;
+};
+
+export { createStateStore as default };
+export type { IHookStateInitAction, IHookStateInitialSetter, IHookStateResolvable, IHookStateSetAction, IHookStateSetter };

package/cjs/validator/decorators.d.ts

@@ -0,0 +1,159 @@
+import { BaseValidator } from './validator.js';
+
+/**
+ * 验证器装饰器模块
+ * 提供一系列用于数据验证的装饰器，可用于类属性的验证规则定义
+ * 这些装饰器基于 BaseValidator 的 decoratorCreator 方法创建
+ */
+
+/**
+ * 必填项验证装饰器
+ * 验证值是否存在且不在指定的无效值列表中
+ *
+ * @param noneVals 被视为无效的值数组，默认为 [undefined]
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VRequired()('用户名不能为空'))
+ *   username?: string;
+ * }
+ */
+declare function VRequired(noneVals?: any[]): (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 字符串类型验证装饰器
+ * 验证值是否为字符串类型
+ *
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @VString('用户名必须为字符串')
+ *   username?: string;
+ * }
+ */
+declare const VString: (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 数字类型验证装饰器
+ * 验证值是否为数字类型
+ *
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @VNumber('年龄必须为数字')
+ *   age?: number;
+ * }
+ */
+declare const VNumber: (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 数组类型验证装饰器
+ * 验证值是否为数组类型
+ *
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @VArray('标签必须为数组')
+ *   tags?: string[];
+ * }
+ */
+declare const VArray: (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 布尔类型验证装饰器
+ * 验证值是否为布尔类型
+ *
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @VBoolean('状态必须为布尔值')
+ *   active?: boolean;
+ * }
+ */
+declare const VBoolean: (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 最小值验证装饰器
+ * 验证数字是否大于或等于指定的最小值
+ *
+ * @param min 最小值
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VMin(18)('年龄必须大于或等于18岁'))
+ *   age?: number;
+ * }
+ */
+declare const VMin: (min: number) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 最大值验证装饰器
+ * 验证数字是否小于或等于指定的最大值
+ *
+ * @param max 最大值
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VMax(120)('年龄必须小于或等于120岁'))
+ *   age?: number;
+ * }
+ */
+declare const VMax: (max: number) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 最小长度验证装饰器
+ * 验证字符串或数组的长度是否大于或等于指定的最小长度
+ *
+ * @param minLen 最小长度
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VMinLength(6)('密码长度不能少于6位'))
+ *   password?: string;
+ * }
+ */
+declare const VMinLength: (minLen: number) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 最大长度验证装饰器
+ * 验证字符串或数组的长度是否小于或等于指定的最大长度
+ *
+ * @param maxLen 最大长度
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VMaxLength(20)('用户名长度不能超过20位'))
+ *   username?: string;
+ * }
+ */
+declare const VMaxLength: (maxLen: number) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 邮箱格式验证装饰器
+ * 验证字符串是否符合邮箱格式
+ *
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @VEmail('邮箱格式不正确')
+ *   email?: string;
+ * }
+ */
+declare const VEmail: (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+/**
+ * 正则表达式验证装饰器
+ * 验证字符串是否匹配指定的正则表达式模式
+ *
+ * @param pattern 正则表达式
+ * @returns 装饰器工厂函数，可接收自定义错误消息
+ *
+ * @example
+ * class User extends BaseValidator {
+ *   @(VPattern(/^1[3-9]\d{9}$/)('手机号格式不正确'))
+ *   phone?: string;
+ * }
+ */
+declare const VPattern: (pattern: RegExp) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+
+export { VArray, VBoolean, VEmail, VMax, VMaxLength, VMin, VMinLength, VNumber, VPattern, VRequired, VString };