rxtutils 1.1.2-beta.1 → 1.1.2-beta.10

package/es/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/es/request/index.mjs

@@ -0,0 +1,148 @@
+import { __assign, __awaiter, __generator } from 'tslib';
+import axios from 'axios';
+import { at } from 'lodash';
+import { _defaultErrorCodeHandler, _defaultHttpErrorCodeHandler, _defaultOtherErrorCodeHandler } from './defaultHandlers.mjs';
+import defaultEquals from '../defaultEquals.mjs';
+import Cache from '../cache/index.mjs';
+import RequestError from './error.mjs';
+
+/**
+ * 创建基础请求实例
+ * @param baseOptions 基础配置选项
+ * @returns 请求创建函数
+ */
+function createBaseRequest(baseOptions) {
+    var baseURL = Object(baseOptions).baseURL;
+    // 创建新的 Axios 实例并配置基础URL和跨域凭证
+    var instance = axios.create({
+        baseURL: baseURL,
+        withCredentials: true,
+    });
+    /**
+     * 创建请求函数
+     * @template Param 请求参数类型
+     * @template Data 响应数据类型，必须是对象类型
+     * @param requestOptions 请求配置
+     * @param createOptions 创建选项（覆盖基础配置）
+     * @returns 发送请求的函数
+     */
+    return function createRequest(requestOptions, createOptions) {
+        var _a = __assign({}, requestOptions), method = _a.method, url = _a.url;
+        var _b = __assign(__assign({}, baseOptions), createOptions), baseURL = _b.baseURL, _c = _b.cacheDataKey, cacheDataKey = _c === void 0 ? "".concat(method, ":").concat(baseURL).concat(url) : _c, cacheDataInStorage = _b.cacheDataInStorage, _d = _b.cacheKeyEquals, cacheKeyEquals = _d === void 0 ? defaultEquals : _d, cacheTime = _b.cacheTime, _e = _b.indexDBName, indexDBName = _e === void 0 ? "__apiCacheDatabase__" : _e;
+        var cache = new Cache(cacheDataInStorage, cacheDataKey, cacheTime, indexDBName, cacheKeyEquals);
+        function request(requestParam, options) {
+            var _this = this;
+            var _a = __assign(__assign({}, requestOptions), requestParam), method = _a.method, url = _a.url, _b = _a.data, data = _b === void 0 ? {} : _b, _c = _a.params, params = _c === void 0 ? {} : _c;
+            var requestDataOrParams = params;
+            if (method.toLowerCase() === "post") {
+                requestDataOrParams = data;
+            }
+            var _d = __assign(__assign(__assign({}, baseOptions), createOptions), options).defaultMessageShower, defaultMessageShower = _d === void 0 ? console.error : _d;
+            var _e = __assign(__assign(__assign({}, baseOptions), createOptions), options), _f = _e.enableCache, enableCache = _f === void 0 ? false : _f, _g = _e.cacheData, cacheData = _g === void 0 ? false : _g, _h = _e.defaultErrorCodeHandler, defaultErrorCodeHandler = _h === void 0 ? _defaultErrorCodeHandler.bind(null, defaultMessageShower) : _h, _j = _e.defaultHttpErrorCodeHandler, defaultHttpErrorCodeHandler = _j === void 0 ? _defaultHttpErrorCodeHandler.bind(null, defaultMessageShower) : _j, _k = _e.otherErrorHandler, otherErrorHandler = _k === void 0 ? _defaultOtherErrorCodeHandler.bind(null, defaultMessageShower) : _k, _l = _e.errorCodePath, errorCodePath = _l === void 0 ? "code" : _l, _m = _e.cacheTime, cacheTime = _m === void 0 ? 60 : _m, _o = _e.errorCodeMap, errorCodeMap = _o === void 0 ? {} : _o, _p = _e.successCodes, successCodes = _p === void 0 ? ["0", "200"] : _p, _q = _e.httpErrorCodeMap, httpErrorCodeMap = _q === void 0 ? {} : _q, _r = _e.axiosOptions, axiosOptions = _r === void 0 ? {} : _r, _s = _e.throwError, throwError = _s === void 0 ? true : _s;
+            if (enableCache) {
+                var cacheItem = cache.getCache(requestDataOrParams);
+                if (cacheItem) {
+                    return Promise.resolve(cacheItem);
+                }
+            }
+            return instance
+                .request(__assign({ method: method, url: url, data: data, params: params }, axiosOptions))
+                .then(function (res) { return __awaiter(_this, void 0, void 0, function () {
+                var errorCode, _a, _b, _c, customHandler, err, _d, _e, replaceResData, _f, handlerThrowError, _g;
+                return __generator(this, function (_h) {
+                    switch (_h.label) {
+                        case 0:
+                            errorCode = String(at(res.data, errorCodePath));
+                            if (successCodes.includes(errorCode)) {
+                                if (cacheData) {
+                                    cache.setCache(requestDataOrParams, res.data, { cacheTime: cacheTime });
+                                }
+                                return [2 /*return*/, res.data];
+                            }
+                            _a = errorCodeMap, _b = errorCode, _c = _a[_b], customHandler = _c === void 0 ? defaultErrorCodeHandler : _c;
+                            err = new RequestError("服务端错误", "server", res);
+                            if (!(typeof customHandler === "string")) return [3 /*break*/, 1];
+                            defaultMessageShower(customHandler);
+                            return [3 /*break*/, 3];
+                        case 1:
+                            _g = Object;
+                            return [4 /*yield*/, customHandler(errorCode, res.data, res, __assign(__assign({}, requestOptions), requestParam))];
+                        case 2:
+                            _d = _g.apply(void 0, [(_h.sent())]), _e = _d.replaceResData, replaceResData = _e === void 0 ? res.data : _e, _f = _d.throwError, handlerThrowError = _f === void 0 ? "default" : _f;
+                            res.data = replaceResData;
+                            switch (handlerThrowError) {
+                                case true:
+                                    throw err;
+                                case false:
+                                    return [2 /*return*/, res.data];
+                            }
+                            _h.label = 3;
+                        case 3:
+                            if (throwError) {
+                                throw err;
+                            }
+                            return [2 /*return*/, res.data];
+                    }
+                });
+            }); }, function (error) { return __awaiter(_this, void 0, void 0, function () {
+                var resData, _a, _b, _c, customHandler, err, _d, _e, replaceResData, _f, handlerThrowError, _g, resData, err, _h, _j, replaceResData, _k, handlerThrowError, _l;
+                return __generator(this, function (_m) {
+                    switch (_m.label) {
+                        case 0:
+                            if (!error.response) return [3 /*break*/, 4];
+                            resData = error;
+                            _a = httpErrorCodeMap, _b = error.response.status, _c = _a[_b], customHandler = _c === void 0 ? defaultHttpErrorCodeHandler : _c;
+                            err = new RequestError("服务端错误", "http", error);
+                            if (!(typeof customHandler === "string")) return [3 /*break*/, 1];
+                            defaultMessageShower(customHandler);
+                            return [3 /*break*/, 3];
+                        case 1:
+                            _g = Object;
+                            return [4 /*yield*/, customHandler(error.response.status, error, __assign(__assign({}, requestOptions), requestParam))];
+                        case 2:
+                            _d = _g.apply(void 0, [(_m.sent())]), _e = _d.replaceResData, replaceResData = _e === void 0 ? error : _e, _f = _d.throwError, handlerThrowError = _f === void 0 ? "default" : _f;
+                            resData = replaceResData;
+                            switch (handlerThrowError) {
+                                case true:
+                                    throw err;
+                                case false:
+                                    return [2 /*return*/, resData];
+                            }
+                            _m.label = 3;
+                        case 3:
+                            if (throwError) {
+                                throw err;
+                            }
+                            return [2 /*return*/, resData];
+                        case 4:
+                            resData = error;
+                            err = new RequestError("服务端错误", "http", error);
+                            err.type = "http";
+                            err.data = error;
+                            _l = Object;
+                            return [4 /*yield*/, otherErrorHandler(error)];
+                        case 5:
+                            _h = (_l.apply(void 0, [(_m.sent())])), _j = _h.replaceResData, replaceResData = _j === void 0 ? error : _j, _k = _h.throwError, handlerThrowError = _k === void 0 ? "default" : _k;
+                            resData = replaceResData;
+                            switch (handlerThrowError) {
+                                case true:
+                                    throw err;
+                                case false:
+                                    return [2 /*return*/, resData];
+                            }
+                            if (throwError) {
+                                throw err;
+                            }
+                            return [2 /*return*/, resData];
+                    }
+                });
+            }); });
+        }
+        request.clearCache = function () {
+            cache.clear();
+        };
+        return request;
+    };
+}
+
+export { createBaseRequest as default };

package/es/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/es/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/es/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 };