rxtutils 1.1.2-beta.2 → 1.1.2-beta.21

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;

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 };

package/cjs/validator/index.cjs

@@ -0,0 +1,19 @@
+'use strict';
+
+var validator = require('./validator.cjs');
+var decorators = require('./decorators.cjs');
+
+
+
+exports.BaseValidator = validator.BaseValidator;
+exports.VArray = decorators.VArray;
+exports.VBoolean = decorators.VBoolean;
+exports.VEmail = decorators.VEmail;
+exports.VMax = decorators.VMax;
+exports.VMaxLength = decorators.VMaxLength;
+exports.VMin = decorators.VMin;
+exports.VMinLength = decorators.VMinLength;
+exports.VNumber = decorators.VNumber;
+exports.VPattern = decorators.VPattern;
+exports.VRequired = decorators.VRequired;
+exports.VString = decorators.VString;

package/cjs/validator/index.d.ts

@@ -0,0 +1,2 @@
+export { BaseValidator } from './validator.js';
+export { VArray, VBoolean, VEmail, VMax, VMaxLength, VMin, VMinLength, VNumber, VPattern, VRequired, VString } from './decorators.js';

package/{dist/cjs → cjs}/validator/validator.cjs

@@ -2,16 +2,31 @@
 
 var tslib = require('tslib');
 
+/**
+ * 基础验证器类
+ * 提供字段验证功能，可通过装饰器为类属性添加验证规则
+ */
 var BaseValidator = /** @class */ (function () {
+    /**
+     * 构造函数
+     * 初始化验证器映射存储
+     */
     function BaseValidator() {
-        this.__keySymbol = Symbol('key-description');
-        this.__keySymbol = Symbol('key-description');
+        /** 用于存储验证器映射的私有符号 */
+        this.__keySymbol = Symbol("key-description");
+        this.__keySymbol = Symbol("key-description");
         this[this.__keySymbol] = {};
     }
+    /**
+     * 验证单个字段
+     * @param itemKey 要验证的字段名
+     * @param itemAll 是否验证所有规则，为true时会验证该字段的所有规则，为false时遇到第一个失败的规则就停止
+     * @returns 验证错误数组，如果没有错误则返回null
+     */
     BaseValidator.prototype.validate = function (itemKey, itemAll) {
         if (itemAll === void 0) { itemAll = false; }
         var validatorMap = this[this.__keySymbol];
-        var errors = [];
+        var errors = {};
         // 校验每个 key
         var validators = validatorMap[itemKey];
         if (!validators) {
@@ -21,21 +36,33 @@ var BaseValidator = /** @class */ (function () {
             var validator = validators_1[_i];
             var res = validator(this[itemKey]);
             if (!res.status) {
-                errors.push(res);
+                if (Array.isArray(errors[res.name])) {
+                    errors[res.name].push(res.message);
+                }
+                else {
+                    errors[res.name] = [res.message];
+                }
                 if (!itemAll)
                     break;
             }
         }
-        if (errors.length) {
+        if (Object.keys(errors).length) {
             return errors;
         }
         return null;
     };
-    BaseValidator.prototype.validateAll = function (itemAll, everyItem, order) {
+    /**
+     * 验证多个或所有字段
+     * @param itemAll 是否验证每个字段的所有规则，为true时会验证字段的所有规则，为false时遇到第一个失败的规则就停止
+     * @param everyItem 是否验证所有字段，为true时会验证所有字段，为false时遇到第一个失败的字段就停止
+     * @param order 验证字段的顺序，可以指定验证的字段名数组及其顺序
+     * @returns 验证错误数组，如果没有错误则返回null
+     */
+    BaseValidator.prototype.validateAll = function (order, itemAll, everyItem) {
         if (itemAll === void 0) { itemAll = false; }
         if (everyItem === void 0) { everyItem = false; }
         var validatorMap = this[this.__keySymbol];
-        var errors = [];
+        var errors = {};
         // 校验每个 key
         var keys = order || Object.keys(validatorMap);
         for (var _i = 0, keys_1 = keys; _i < keys_1.length; _i++) {
@@ -47,7 +74,12 @@ var BaseValidator = /** @class */ (function () {
                 var fn = fns_1[_a];
                 var res = fn(value);
                 if (!res.status) {
-                    errors.push(res);
+                    if (Array.isArray(errors[res.name])) {
+                        errors[res.name].push(res.message);
+                    }
+                    else {
+                        errors[res.name] = [res.message];
+                    }
                     if (!itemAll)
                         break;
                 }
@@ -56,11 +88,44 @@ var BaseValidator = /** @class */ (function () {
                 break;
             }
         }
-        if (errors.length) {
+        if (Object.keys(errors).length) {
             return errors;
         }
         return null;
     };
+    /**
+     * 装饰器创建器
+     * 用于创建属性验证装饰器的工厂函数
+     *
+     * @param func 验证函数，接收属性值并返回布尔值表示验证结果
+     * @returns 返回一个接收错误消息的函数，该函数再返回实际的装饰器
+     *
+     * @example
+     * // 创建一个验证字符串的装饰器
+     * const VString = BaseValidator.decoratorCreator(
+     *   (val) => typeof val === 'string' || val === undefined
+     * );
+     *
+     * // 创建一个验证必填项的装饰器
+     * const VRequired = BaseValidator.decoratorCreator(
+     *   (val) => val !== undefined && val !== null && val !== ''
+     * );
+     *
+     * // 在类中使用这些装饰器
+     * class User extends BaseValidator {
+     *   @VString('名称必须为字符串')
+     *   @(VRequired()('名称必须填写'))
+     *   name?: string;
+     *
+     *   // 验证使用
+     *   validateName() {
+     *     return this.validate('name');
+     *   }
+     * }
+     *
+     * const user = new User();
+     * console.log(user.validateName()); // 显示错误信息：名称必须填写
+     */
     BaseValidator.decoratorCreator = function (func) {
         return function (message) {
             if (message === void 0) { message = function (val, value, context) { return "".concat(String(context.name), "\u683C\u5F0F\u9519\u8BEF"); }; }
@@ -75,17 +140,17 @@ var BaseValidator = /** @class */ (function () {
                     var validator = function (val) {
                         var validateStatus = func(val, value, context);
                         if (validateStatus) {
-                            return { status: true };
+                            return { name: name, status: true };
                         }
                         else {
-                            var msg = '';
-                            if (typeof message === 'function') {
+                            var msg = "";
+                            if (typeof message === "function") {
                                 msg = message(val, value, context);
                             }
                             else {
                                 msg = message;
                             }
-                            return { status: false, message: msg };
+                            return { name: name, status: false, message: msg };
                         }
                     };
                     if (validators[name]) {

package/cjs/validator/validator.d.ts

@@ -0,0 +1,84 @@
+/**
+ * 验证器函数类型，接收任意值并返回验证结果
+ * @param val 需要验证的值
+ * @returns 包含验证状态和可选错误消息的对象
+ */
+type Validator = (val: any) => {
+    name: string;
+    status: boolean;
+    message?: string;
+};
+/**
+ * 验证器映射类型，用于存储字段名到验证器数组的映射
+ */
+type ValidatorMap = {
+    [key: string]: Validator[];
+};
+/**
+ * 基础验证器类
+ * 提供字段验证功能，可通过装饰器为类属性添加验证规则
+ */
+declare class BaseValidator {
+    /** 用于存储验证器映射的私有符号 */
+    private __keySymbol;
+    /** 用于存储验证器映射的索引签名 */
+    [key: symbol]: ValidatorMap;
+    /** 用于存储类属性的索引签名 */
+    [key: string]: any;
+    /**
+     * 构造函数
+     * 初始化验证器映射存储
+     */
+    constructor();
+    /**
+     * 验证单个字段
+     * @param itemKey 要验证的字段名
+     * @param itemAll 是否验证所有规则，为true时会验证该字段的所有规则，为false时遇到第一个失败的规则就停止
+     * @returns 验证错误数组，如果没有错误则返回null
+     */
+    validate(itemKey: string, itemAll?: boolean): Record<string, string[]>;
+    /**
+     * 验证多个或所有字段
+     * @param itemAll 是否验证每个字段的所有规则，为true时会验证字段的所有规则，为false时遇到第一个失败的规则就停止
+     * @param everyItem 是否验证所有字段，为true时会验证所有字段，为false时遇到第一个失败的字段就停止
+     * @param order 验证字段的顺序，可以指定验证的字段名数组及其顺序
+     * @returns 验证错误数组，如果没有错误则返回null
+     */
+    validateAll(order?: string[], itemAll?: boolean, everyItem?: boolean): Record<string, string[]>;
+    /**
+     * 装饰器创建器
+     * 用于创建属性验证装饰器的工厂函数
+     *
+     * @param func 验证函数，接收属性值并返回布尔值表示验证结果
+     * @returns 返回一个接收错误消息的函数，该函数再返回实际的装饰器
+     *
+     * @example
+     * // 创建一个验证字符串的装饰器
+     * const VString = BaseValidator.decoratorCreator(
+     *   (val) => typeof val === 'string' || val === undefined
+     * );
+     *
+     * // 创建一个验证必填项的装饰器
+     * const VRequired = BaseValidator.decoratorCreator(
+     *   (val) => val !== undefined && val !== null && val !== ''
+     * );
+     *
+     * // 在类中使用这些装饰器
+     * class User extends BaseValidator {
+     *   @VString('名称必须为字符串')
+     *   @(VRequired()('名称必须填写'))
+     *   name?: string;
+     *
+     *   // 验证使用
+     *   validateName() {
+     *     return this.validate('name');
+     *   }
+     * }
+     *
+     * const user = new User();
+     * console.log(user.validateName()); // 显示错误信息：名称必须填写
+     */
+    static decoratorCreator: (func: (val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => boolean) => (message?: ((val: any, value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => string) | string) => (value: undefined, context: ClassFieldDecoratorContext<BaseValidator>) => void;
+}
+
+export { BaseValidator };