@nest-omni/core 4.1.3-1 → 4.1.3-10

package/validators/custom-validate.examples.js

@@ -0,0 +1,400 @@
+"use strict";
+/**
+ * @CustomValidate 使用示例
+ *
+ * 这个文件包含了各种使用场景的示例代码
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Example9_CachedValidation = exports.CachedValidationService = exports.Example8_ThirdPartyAPI = exports.ThirdPartyValidationService = exports.Example7_DynamicMessage = exports.Example6_FileUpload = exports.FileValidationService = exports.Example5_ComplexValidation = exports.Example4_LazyReference = exports.Example3_ServiceValidation = exports.ExampleValidationService = exports.Example2_EntityMethod = exports.Example1_InlineValidation = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("@nestjs/typeorm");
+const typeorm_2 = require("typeorm");
+const custom_validate_validator_1 = require("../validators/custom-validate.validator");
+// ============================================================================
+// Mock Entity（需要在使用前定义）
+// ============================================================================
+class UserEntity {
+}
+// ============================================================================
+// 示例 1: 内联函数验证
+// ============================================================================
+class Example1_InlineValidation {
+}
+exports.Example1_InlineValidation = Example1_InlineValidation;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value) => value > 0, { message: '价格必须大于0' }),
+    __metadata("design:type", Number)
+], Example1_InlineValidation.prototype, "price", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value) => __awaiter(void 0, void 0, void 0, function* () {
+        const response = yield fetch(`/api/check/${value}`);
+        return response.ok;
+    }), { message: '验证失败' }),
+    __metadata("design:type", String)
+], Example1_InlineValidation.prototype, "code", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value, context) => {
+        // 可以访问其他属性
+        const minValue = context.object.minPrice || 0;
+        return value > minValue;
+    }, { message: '最大价格必须大于最小价格' }),
+    __metadata("design:type", Number)
+], Example1_InlineValidation.prototype, "maxPrice", void 0);
+// ============================================================================
+// 示例 2: Entity 方法验证
+// ============================================================================
+class Example2_EntityMethod {
+    // 同步验证方法
+    validateVersion(value) {
+        return /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/.test(value);
+    }
+    // 异步验证方法（可访问 this）
+    checkDates(value, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return value >= this.createdAt;
+        });
+    }
+}
+exports.Example2_EntityMethod = Example2_EntityMethod;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)('validateVersion', {
+        message: '版本号格式必须为 x.y.z'
+    }),
+    __metadata("design:type", String)
+], Example2_EntityMethod.prototype, "version", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)('checkDates'),
+    __metadata("design:type", Date)
+], Example2_EntityMethod.prototype, "publishedAt", void 0);
+// ============================================================================
+// 示例 3: Service 验��
+// ============================================================================
+// 验证 Service
+let ExampleValidationService = class ExampleValidationService {
+    constructor(userRepository) {
+        this.userRepository = userRepository;
+    }
+    /**
+     * 检查用户名是否可用
+     */
+    usernameAvailable(username) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const count = yield this.userRepository.count({
+                where: { username }
+            });
+            return count === 0;
+        });
+    }
+    /**
+     * 检查邮箱格式
+     */
+    validateEmail(email) {
+        return /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(email);
+    }
+    /**
+     * 检查数值范围（带额外参数）
+     */
+    checkRange(value, context, min, max) {
+        return value >= min && value <= max;
+    }
+    /**
+     * 复杂的业务验证
+     */
+    validateBusinessRule(value, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 复杂的业务逻辑
+            const user = yield this.userRepository.findOne({
+                where: { id: context.object.userId },
+                relations: ['profile', 'permissions']
+            });
+            if (!user) {
+                return false;
+            }
+            // 可以访问关联数据进行复杂验证
+            return user.profile.isVerified && user.permissions.length > 0;
+        });
+    }
+};
+exports.ExampleValidationService = ExampleValidationService;
+exports.ExampleValidationService = ExampleValidationService = __decorate([
+    (0, common_1.Injectable)(),
+    __param(0, (0, typeorm_1.InjectRepository)(UserEntity)),
+    __metadata("design:paramtypes", [typeorm_2.Repository])
+], ExampleValidationService);
+// 使用 Service 验证
+class Example3_ServiceValidation {
+}
+exports.Example3_ServiceValidation = Example3_ServiceValidation;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ExampleValidationService, 'usernameAvailable'], { message: '用户名已被使用' }),
+    __metadata("design:type", String)
+], Example3_ServiceValidation.prototype, "username", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ExampleValidationService, 'validateEmail'], { message: '邮箱格式不正确' }),
+    __metadata("design:type", String)
+], Example3_ServiceValidation.prototype, "email", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ExampleValidationService, 'checkRange', 18, 100], { message: '年龄必须在 18-100 之间' }),
+    __metadata("design:type", Number)
+], Example3_ServiceValidation.prototype, "age", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ExampleValidationService, 'validateBusinessRule'], { message: '业务规则验证失败' }),
+    __metadata("design:type", String)
+], Example3_ServiceValidation.prototype, "businessField", void 0);
+// ============================================================================
+// 示例 4: 延迟引用（解决循环依赖）
+// ============================================================================
+class Example4_LazyReference {
+}
+exports.Example4_LazyReference = Example4_LazyReference;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([() => ExampleValidationService, 'usernameAvailable'], { message: '用户名已存在' }),
+    __metadata("design:type", String)
+], Example4_LazyReference.prototype, "username", void 0);
+// ============================================================================
+// 示例 5: 复杂验证场景
+// ============================================================================
+class Example5_ComplexValidation {
+}
+exports.Example5_ComplexValidation = Example5_ComplexValidation;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value, context) => __awaiter(void 0, void 0, void 0, function* () {
+        // 条件1：长度检查
+        if (value.length < 8) {
+            return false;
+        }
+        // 条件2：复杂度检查
+        const hasUpperCase = /[A-Z]/.test(value);
+        const hasLowerCase = /[a-z]/.test(value);
+        const hasNumber = /\d/.test(value);
+        const hasSpecial = /[@$!%*?&]/.test(value);
+        if (!(hasUpperCase && hasLowerCase && hasNumber && hasSpecial)) {
+            return false;
+        }
+        // 条件3���异步检查（是否在弱密码列表中）
+        const response = yield fetch(`/api/check-weak-password`, {
+            method: 'POST',
+            body: JSON.stringify({ password: value }),
+            headers: { 'Content-Type': 'application/json' }
+        });
+        const data = yield response.json();
+        return !data.isWeak;
+    }), { message: '密码不符合安全要求：至少8位，包含大小写字母、数字和特殊字符，且不在弱密码列表中' }),
+    __metadata("design:type", String)
+], Example5_ComplexValidation.prototype, "password", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value, context) => {
+        return value === context.object.password;
+    }, { message: '两次密码输入不一致' }),
+    __metadata("design:type", String)
+], Example5_ComplexValidation.prototype, "confirmPassword", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value, context) => {
+        // 只有当 requiresApproval 为 true 时才验证 approverId
+        if (context.object.requiresApproval) {
+            return value && value.length > 0;
+        }
+        return true; // 不需要审批时，总是通过
+    }, { message: '需要审批时必须指定审批人' }),
+    __metadata("design:type", String)
+], Example5_ComplexValidation.prototype, "approverId", void 0);
+// ============================================================================
+// 示例 6: 文件验证
+// ============================================================================
+let FileValidationService = class FileValidationService {
+    constructor() {
+        this.allowedMimeTypes = [
+            'image/jpeg',
+            'image/png',
+            'image/gif',
+            'application/pdf'
+        ];
+        this.maxFileSize = 5 * 1024 * 1024; // 5MB
+    }
+    checkFileType(mimeType) {
+        return this.allowedMimeTypes.includes(mimeType);
+    }
+    checkFileSize(size, context, maxSize) {
+        const limit = maxSize || this.maxFileSize;
+        return size <= limit;
+    }
+    checkFileHash(hash) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 检查文件是否已存在（防重复上传）
+            // 实际实现：查询数据库
+            return true;
+        });
+    }
+};
+exports.FileValidationService = FileValidationService;
+exports.FileValidationService = FileValidationService = __decorate([
+    (0, common_1.Injectable)()
+], FileValidationService);
+class Example6_FileUpload {
+}
+exports.Example6_FileUpload = Example6_FileUpload;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([FileValidationService, 'checkFileType'], { message: '文件类型不支���，仅支持 JPEG, PNG, GIF, PDF' }),
+    __metadata("design:type", String)
+], Example6_FileUpload.prototype, "mimeType", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([FileValidationService, 'checkFileSize', 10 * 1024 * 1024], // 10MB
+    { message: '文件大小不能超过 10MB' }),
+    __metadata("design:type", Number)
+], Example6_FileUpload.prototype, "size", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([FileValidationService, 'checkFileHash'], { message: '文件已存在' }),
+    __metadata("design:type", String)
+], Example6_FileUpload.prototype, "hash", void 0);
+// ============================================================================
+// 示例 7: 动态错误消息
+// ============================================================================
+class Example7_DynamicMessage {
+}
+exports.Example7_DynamicMessage = Example7_DynamicMessage;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)((value) => value > 0 && value <= 100, {
+        message: (args) => {
+            const value = args.value;
+            if (value <= 0) {
+                return '折扣必须大于 0';
+            }
+            if (value > 100) {
+                return `折扣 ${value}% 超过了最大值 100%`;
+            }
+            return '折扣值无效';
+        }
+    }),
+    __metadata("design:type", Number)
+], Example7_DynamicMessage.prototype, "discount", void 0);
+// ============================================================================
+// 示例 8: 使用第三方 API 验证
+// ============================================================================
+let ThirdPartyValidationService = class ThirdPartyValidationService {
+    /**
+     * 验证地址是否真实存在
+     */
+    validateAddress(address) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield fetch(`https://maps.googleapis.com/maps/api/geocode/json?address=${encodeURIComponent(address)}`);
+                const data = yield response.json();
+                return data.status === 'OK' && data.results.length > 0;
+            }
+            catch (error) {
+                console.error('Address validation error:', error);
+                return false;
+            }
+        });
+    }
+    /**
+     * 验证税号是否有效
+     */
+    validateTaxId(taxId, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield fetch(`https://api.tax-service.com/validate`, {
+                    method: 'POST',
+                    headers: { 'Content-Type': 'application/json' },
+                    body: JSON.stringify({ taxId, country: context.object.country })
+                });
+                const data = yield response.json();
+                return data.valid;
+            }
+            catch (error) {
+                console.error('Tax ID validation error:', error);
+                return false;
+            }
+        });
+    }
+};
+exports.ThirdPartyValidationService = ThirdPartyValidationService;
+exports.ThirdPartyValidationService = ThirdPartyValidationService = __decorate([
+    (0, common_1.Injectable)()
+], ThirdPartyValidationService);
+class Example8_ThirdPartyAPI {
+}
+exports.Example8_ThirdPartyAPI = Example8_ThirdPartyAPI;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ThirdPartyValidationService, 'validateAddress'], { message: '地址无效，请输入真实存在的地址' }),
+    __metadata("design:type", String)
+], Example8_ThirdPartyAPI.prototype, "address", void 0);
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([ThirdPartyValidationService, 'validateTaxId'], { message: '税号无效' }),
+    __metadata("design:type", String)
+], Example8_ThirdPartyAPI.prototype, "taxId", void 0);
+// ============================================================================
+// 示例 9: 性能优化 - 缓存
+// ============================================================================
+let CachedValidationService = class CachedValidationService {
+    constructor() {
+        this.cache = new Map();
+        this.cacheTTL = 5 * 60 * 1000; // 5分钟
+    }
+    expensiveValidation(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const now = Date.now();
+            // 检查缓存
+            const cached = this.cache.get(value);
+            if (cached && (now - cached.timestamp) < this.cacheTTL) {
+                console.log(`[Cache Hit] Value: ${value}`);
+                return cached.result;
+            }
+            // 执行昂贵的验证
+            console.log(`[Cache Miss] Performing validation for: ${value}`);
+            const result = yield this.doExpensiveCheck(value);
+            // 更新缓存
+            this.cache.set(value, { result, timestamp: now });
+            // 清理过期缓存
+            this.cleanExpiredCache();
+            return result;
+        });
+    }
+    doExpensiveCheck(value) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // 模拟耗时操作（数据库查询、外部 API 等）
+            yield new Promise(resolve => setTimeout(resolve, 1000));
+            return true;
+        });
+    }
+    cleanExpiredCache() {
+        const now = Date.now();
+        for (const [key, value] of this.cache.entries()) {
+            if (now - value.timestamp >= this.cacheTTL) {
+                this.cache.delete(key);
+            }
+        }
+    }
+};
+exports.CachedValidationService = CachedValidationService;
+exports.CachedValidationService = CachedValidationService = __decorate([
+    (0, common_1.Injectable)()
+], CachedValidationService);
+class Example9_CachedValidation {
+}
+exports.Example9_CachedValidation = Example9_CachedValidation;
+__decorate([
+    (0, custom_validate_validator_1.CustomValidate)([CachedValidationService, 'expensiveValidation'], { message: '验证失败' }),
+    __metadata("design:type", String)
+], Example9_CachedValidation.prototype, "field", void 0);

package/validators/custom-validate.validator.d.ts

@@ -0,0 +1,134 @@
+import type { ValidationArguments, ValidationOptions, ValidatorConstraintInterface } from 'class-validator';
+import { ModuleRef } from '@nestjs/core';
+/**
+ * 验证上下文，传递给验证函数
+ */
+export interface ValidationContext {
+    /** 当前验证的值 */
+    value: any;
+    /** 当前对象实例 */
+    object: any;
+    /** 属性名 */
+    property: string;
+    /** 约束参数（包含验证函数和额外参数） */
+    constraints: any[];
+    /** 类名 */
+    targetName: string;
+    /** 所有验证参数（原始 ValidationArguments） */
+    args: ValidationArguments;
+}
+/**
+ * 验证函数类型
+ * @param value 当前验证的值
+ * @param context 验证上下文
+ * @param extraArgs 额外参数（可选）
+ * @returns boolean 或 Promise<boolean>
+ */
+export type ValidatorFunction = (value: any, context: ValidationContext, ...extraArgs: any[]) => boolean | Promise<boolean>;
+/**
+ * 验证约束类型
+ *
+ * 支持以下几种形式：
+ * 1. 直接函数：(value, context) => boolean
+ * 2. Entity 方法名：'methodName'
+ * 3. Service + 方法名：[ServiceClass, 'methodName']
+ * 4. 延迟引用 Service：[() => ServiceClass, 'methodName']
+ * 5. 带额外参数：[ServiceClass, 'methodName', arg1, arg2, ...]
+ */
+export type ValidationConstraint = ValidatorFunction | string | [Function | (() => Function), string, ...any[]];
+/**
+ * 装饰器选项
+ */
+export interface CustomValidateOptions extends ValidationOptions {
+    /** 错误消息（支持字符串、函数、i18n key） */
+    message?: string | ((args: ValidationArguments) => string);
+    /** 是否异步（可选，会自动检测） */
+    async?: boolean;
+}
+export declare class CustomValidateValidator implements ValidatorConstraintInterface {
+    private readonly moduleRef;
+    constructor(moduleRef: ModuleRef);
+    /**
+     * 验证入口
+     */
+    validate(value: any, args: ValidationArguments): Promise<boolean>;
+    /**
+     * 调用内联函数
+     */
+    private callFunction;
+    /**
+     * 调用 Entity 方法
+     */
+    private callEntityMethod;
+    /**
+     * 调用 Service 方法
+     */
+    private callServiceMethod;
+    /**
+     * 默认错误消息
+     */
+    defaultMessage(args: ValidationArguments): string;
+}
+/**
+ * @CustomValidate 装饰器
+ *
+ * 支持多种验证方式的灵活验证装饰器
+ *
+ * @example
+ *
+ * // 1. 内联函数（同步）
+ * @CustomValidate(
+ *   (value) => value > 0,
+ *   { message: '价格必须大于0' }
+ * )
+ * price: number;
+ *
+ * @example
+ * // 2. 内联函数（异步）
+ * @CustomValidate(
+ *   async (value, context) => {
+ *     const response = await fetch(`/api/check/${value}`);
+ *     return response.ok;
+ *   }
+ * )
+ * username: string;
+ *
+ * @example
+ * // 3. Entity 方法
+ * @CustomValidate('validateVersion')
+ * version: string;
+ *
+ * validateVersion(value: string): boolean {
+ *   return /^\d+\.\d+\.\d+$/.test(value);
+ * }
+ *
+ * @example
+ * // 4. Service 方法
+ * @CustomValidate([UserValidationService, 'checkUsername'])
+ * username: string;
+ *
+ * @example
+ * // 5. 延迟引用（解决循环依赖）
+ * @CustomValidate([() => UserValidationService, 'checkUsername'])
+ * username: string;
+ *
+ * @example
+ * // 6. 带额外参数
+ * @CustomValidate(
+ *   [ValidationService, 'checkRange', 0, 100],
+ *   { message: '价格必须在 0-100 之间' }
+ * )
+ * price: number;
+ *
+ * @example
+ * // 7. 使用 i18n
+ * @CustomValidate(
+ *   (value) => value.length >= 6,
+ *   { message: 'validation.PASSWORD_TOO_SHORT' }
+ * )
+ * password: string;
+ *
+ * @param constraint 验证约束（函数、方法名、或 [Service, 方法名]）
+ * @param validationOptions 验证选项
+ */
+export declare function CustomValidate(constraint: ValidationConstraint, validationOptions?: CustomValidateOptions): PropertyDecorator;