rxtutils 1.1.1 → 1.1.2-beta.10

package/cjs/request/index.cjs

@@ -0,0 +1,150 @@
+'use strict';
+
+var tslib = require('tslib');
+var axios = require('axios');
+var lodash = require('lodash');
+var defaultHandlers = require('./defaultHandlers.cjs');
+var defaultEquals = require('../defaultEquals.cjs');
+var index = require('../cache/index.cjs');
+var error = require('./error.cjs');
+
+/**
+ * 创建基础请求实例
+ * @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 = tslib.__assign({}, requestOptions), method = _a.method, url = _a.url;
+        var _b = tslib.__assign(tslib.__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 index.default(cacheDataInStorage, cacheDataKey, cacheTime, indexDBName, cacheKeyEquals);
+        function request(requestParam, options) {
+            var _this = this;
+            var _a = tslib.__assign(tslib.__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 = tslib.__assign(tslib.__assign(tslib.__assign({}, baseOptions), createOptions), options).defaultMessageShower, defaultMessageShower = _d === void 0 ? console.error : _d;
+            var _e = tslib.__assign(tslib.__assign(tslib.__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 ? defaultHandlers._defaultErrorCodeHandler.bind(null, defaultMessageShower) : _h, _j = _e.defaultHttpErrorCodeHandler, defaultHttpErrorCodeHandler = _j === void 0 ? defaultHandlers._defaultHttpErrorCodeHandler.bind(null, defaultMessageShower) : _j, _k = _e.otherErrorHandler, otherErrorHandler = _k === void 0 ? defaultHandlers._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(tslib.__assign({ method: method, url: url, data: data, params: params }, axiosOptions))
+                .then(function (res) { return tslib.__awaiter(_this, void 0, void 0, function () {
+                var errorCode, _a, _b, _c, customHandler, err, _d, _e, replaceResData, _f, handlerThrowError, _g;
+                return tslib.__generator(this, function (_h) {
+                    switch (_h.label) {
+                        case 0:
+                            errorCode = String(lodash.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 error("服务端错误", "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, tslib.__assign(tslib.__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$1) { return tslib.__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 tslib.__generator(this, function (_m) {
+                    switch (_m.label) {
+                        case 0:
+                            if (!error$1.response) return [3 /*break*/, 4];
+                            resData = error$1;
+                            _a = httpErrorCodeMap, _b = error$1.response.status, _c = _a[_b], customHandler = _c === void 0 ? defaultHttpErrorCodeHandler : _c;
+                            err = new error("服务端错误", "http", error$1);
+                            if (!(typeof customHandler === "string")) return [3 /*break*/, 1];
+                            defaultMessageShower(customHandler);
+                            return [3 /*break*/, 3];
+                        case 1:
+                            _g = Object;
+                            return [4 /*yield*/, customHandler(error$1.response.status, error$1, tslib.__assign(tslib.__assign({}, requestOptions), requestParam))];
+                        case 2:
+                            _d = _g.apply(void 0, [(_m.sent())]), _e = _d.replaceResData, replaceResData = _e === void 0 ? error$1 : _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$1;
+                            err = new error("服务端错误", "http", error$1);
+                            err.type = "http";
+                            err.data = error$1;
+                            _l = Object;
+                            return [4 /*yield*/, otherErrorHandler(error$1)];
+                        case 5:
+                            _h = (_l.apply(void 0, [(_m.sent())])), _j = _h.replaceResData, replaceResData = _j === void 0 ? error$1 : _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;
+    };
+}
+
+module.exports = createBaseRequest;

package/{dist/types → cjs}/request/index.d.ts

@@ -14,7 +14,7 @@ type ErrorHandlerReturnType<D> = {
      * - false: 不抛出错误
      * - 'default': 使用默认错误处理逻辑
      */
-    throwError?: boolean | 'default';
+    throwError?: boolean | "default";
 };
 /**
  * 请求配置选项接口
@@ -53,7 +53,8 @@ interface Options<Params = any, Data = any> {
      * 缓存时间（秒）
      * @default 60
      */
-    cacheTime?: number; /**
+    cacheTime?: number;
+    /**
      * 缓存数据的存储类型
      * - localStorage: 使用浏览器本地存储，数据永久保存
      * - sessionStorage: 使用会话存储，关闭浏览器后清除
@@ -75,7 +76,8 @@ interface Options<Params = any, Data = any> {
      * 错误码在响应数据中的路径
      * @default 'code'
      */
-    errorCodePath?: string; /**
+    errorCodePath?: string;
+    /**
      * 错误码映射表
      * 可以配置错误码对应的错误信息或处理函数
      * @default {} 空对象，使用默认处理函数
@@ -85,7 +87,8 @@ interface Options<Params = any, Data = any> {
      * 默认错误码处理函数
      * 当错误码不在 errorCodeMap 中时调用
      */
-    defaultErrorCodeHandler?: (code: string, data: Data, res: AxiosResponse<Data>) => ErrorHandlerReturnType<Data> | void; /**
+    defaultErrorCodeHandler?: (code: string, data: Data, res: AxiosResponse<Data>) => Promise<ErrorHandlerReturnType<Data> | void>;
+    /**
      * 成功状态的错误码列表
      * @default ['0', '200']
      */
@@ -95,18 +98,18 @@ interface Options<Params = any, Data = any> {
      * 可以配置 HTTP 状态码对应的错误信息或处理函数
      * @default {} 空对象，使用默认处理函数
      */
-    httpErrorCodeMap?: Record<string, string | ((code: number, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => ErrorHandlerReturnType<Data> | void)>;
+    httpErrorCodeMap?: Record<string, string | ((code: number, res: AxiosResponse<Data>, requestParam: RequestOptions<Params>) => Promise<ErrorHandlerReturnType<Data> | void>)>;
     /**
      * 默认 HTTP 错误码处理函数
      * 当 HTTP 状态码不在 httpErrorCodeMap 中时调用
      */
-    defaultHttpErrorCodeHandler?: (code: number, error: any) => ErrorHandlerReturnType<Data> | void;
+    defaultHttpErrorCodeHandler?: (code: number, error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
     /**
      * 其他错误处理函数
      * 处理非 HTTP 错误和非业务错误码的错误
      */
-    otherErrorHandler?: (error: any) => ErrorHandlerReturnType<Data> | void;
-    axiosOptions?: Omit<AxiosRequestConfig<Params>, 'method' | 'url' | 'params' | 'data'>;
+    otherErrorHandler?: (error: any) => Promise<ErrorHandlerReturnType<Data> | void>;
+    axiosOptions?: Omit<AxiosRequestConfig<Params>, "method" | "url" | "params" | "data">;
 }
 /**
  * 请求参数接口

package/cjs/store/createGetter/index.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+var react = require('react');
+
+/**
+ * 创建 store getter
+ * @param store store实例
+ * @param getters getter函数
+ * @param getterNameMaps 将 getter 函数和 getter 名称一一映射
+ * @returns getter object
+ */
+var createStoreGetter = function (store, getters, getterNameMaps) {
+    var gettersObj = {};
+    Object.keys(getters).forEach(function (key) {
+        Object.defineProperty(gettersObj, getterNameMaps[key], {
+            get: function () { return getters[key](store.get()); }
+        });
+    });
+    return gettersObj;
+};
+/**
+ *
+ * @param store store实例
+ * @param getters getter函数
+ * @param getterNameMaps 将 getter 函数和 getter 名称一一映射
+ * @returns getter memo hook
+ */
+var createStoreGetterMemo = function (store, getters, getterNameMaps) {
+    // 创建缓存数据 hook
+    return function () {
+        var storeData = store.use()[0];
+        var reducedData = react.useMemo(function () {
+            return Object.keys(getters).reduce(function (acc, key) {
+                var mappedKey = getterNameMaps[key];
+                var getterValue = getters[key](storeData);
+                acc[mappedKey] = getterValue;
+                return acc;
+            }, {});
+        }, [storeData]);
+        return reducedData;
+    };
+};
+
+exports.createStoreGetter = createStoreGetter;
+exports.createStoreGetterMemo = createStoreGetterMemo;

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/validator/decorators.cjs

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