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

package/validators/common-validators.d.ts

@@ -0,0 +1,143 @@
+import type { ValidationOptions } from 'class-validator';
+import { IsPhoneNumber as isPhoneNumber, ValidationArguments, ValidatorConstraintInterface } from 'class-validator';
+/**
+ * 验证密码格式（只允许字母、数字和特定特殊字符）
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsPassword({ message: 'Invalid password format' })
+ *   password: string;
+ * }
+ * ```
+ */
+export declare function IsPassword(validationOptions?: ValidationOptions): PropertyDecorator;
+/**
+ * 验证手机号码（支持指定国家/地区）
+ *
+ * @param validationOptions 验证选项，可以指定 region
+ *
+ * @example
+ * ```typescript
+ * class ContactDto {
+ *   @IsPhoneNumber({ region: 'CN' })
+ *   phone: string;
+ * }
+ * ```
+ */
+export declare function IsPhoneNumber(validationOptions?: ValidationOptions & {
+    region?: Parameters<typeof isPhoneNumber>[0];
+}): PropertyDecorator;
+/**
+ * 验证临时文件路径（必须以 tmp/ 开头）
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class FileDto {
+ *   @IsTmpKey()
+ *   filePath: string; // 必须是 'tmp/...'
+ * }
+ * ```
+ */
+export declare function IsTmpKey(validationOptions?: ValidationOptions): PropertyDecorator;
+/**
+ * 允许字段为 undefined，如果不是 undefined 才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsUndefinable()
+ *   @IsString()
+ *   nickname?: string; // undefined 或字符串
+ * }
+ * ```
+ */
+export declare function IsUndefinable(options?: ValidationOptions): PropertyDecorator;
+/**
+ * 允许字段为空值（null、undefined 或空字符串），如果不为空才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsEmptyable()
+ *   @IsEmail()
+ *   email?: string; // 可以为空，或者必须是有效邮箱
+ * }
+ * ```
+ */
+export declare function IsEmptyable(options?: ValidationOptions): PropertyDecorator;
+/**
+ * 允许字段为 null，如果不是 null 才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsNullable()
+ *   @IsNumber()
+ *   age?: number | null; // null 或数字
+ * }
+ * ```
+ */
+export declare function IsNullable(options?: ValidationOptions): PropertyDecorator;
+/**
+ * 验证 HTTP/HTTPS URL
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class WebsiteDto {
+ *   @IsHttpUrl({ message: 'Invalid URL' })
+ *   url: string;
+ * }
+ * ```
+ */
+export declare function IsHttpUrl(validationOptions?: ValidationOptions): (object: any, propertyName: string) => void;
+/**
+ * Validator constraint for AtLeastOneField decorator
+ */
+export declare class AtLeastOneFieldConstraint implements ValidatorConstraintInterface {
+    validate(value: any, args: ValidationArguments): boolean;
+    defaultMessage(args: ValidationArguments): string;
+}
+/**
+ * 验证至少提供指定字段中的一个
+ *
+ * @param properties 要检查的属性名数组
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class ContactDto {
+ *   @AtLeastOneField(['email', 'phone'], {
+ *     message: 'Either email or phone must be provided'
+ *   })
+ *   email?: string;
+ *
+ *   phone?: string;
+ * }
+ * ```
+ *
+ * @example
+ * 使用虚拟字段（推荐用于类级别验证）：
+ * ```typescript
+ * class ContactDto {
+ *   @AtLeastOneField(['email', 'phone'])
+ *   _atLeastOne: any; // 虚拟字段用于验证
+ *
+ *   email?: string;
+ *   phone?: string;
+ * }
+ * ```
+ */
+export declare function AtLeastOneField(properties: string[], validationOptions?: ValidationOptions): PropertyDecorator;

package/validators/common-validators.js

@@ -0,0 +1,249 @@
+"use strict";
+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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AtLeastOneFieldConstraint = void 0;
+exports.IsPassword = IsPassword;
+exports.IsPhoneNumber = IsPhoneNumber;
+exports.IsTmpKey = IsTmpKey;
+exports.IsUndefinable = IsUndefinable;
+exports.IsEmptyable = IsEmptyable;
+exports.IsNullable = IsNullable;
+exports.IsHttpUrl = IsHttpUrl;
+exports.AtLeastOneField = AtLeastOneField;
+const class_validator_1 = require("class-validator");
+const lodash_1 = require("lodash");
+const nestjs_i18n_1 = require("nestjs-i18n");
+/**
+ * 验证密码格式（只允许字母、数字和特定特殊字符）
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsPassword({ message: 'Invalid password format' })
+ *   password: string;
+ * }
+ * ```
+ */
+function IsPassword(validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            propertyName,
+            name: 'isPassword',
+            target: object.constructor,
+            constraints: [],
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return /^[\d!#$%&*@A-Z^a-z]*$/.test(value);
+                },
+            },
+        });
+    };
+}
+/**
+ * 验证手机号码（支持指定国家/地区）
+ *
+ * @param validationOptions 验证选项，可以指定 region
+ *
+ * @example
+ * ```typescript
+ * class ContactDto {
+ *   @IsPhoneNumber({ region: 'CN' })
+ *   phone: string;
+ * }
+ * ```
+ */
+function IsPhoneNumber(validationOptions) {
+    return (0, class_validator_1.IsPhoneNumber)(validationOptions === null || validationOptions === void 0 ? void 0 : validationOptions.region, Object.assign({ message: 'error.phoneNumber' }, validationOptions));
+}
+/**
+ * 验证临时文件路径（必须以 tmp/ 开头）
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class FileDto {
+ *   @IsTmpKey()
+ *   filePath: string; // 必须是 'tmp/...'
+ * }
+ * ```
+ */
+function IsTmpKey(validationOptions) {
+    return (object, propertyName) => {
+        (0, class_validator_1.registerDecorator)({
+            propertyName,
+            name: 'tmpKey',
+            target: object.constructor,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    return (0, lodash_1.isString)(value) && /^tmp\//.test(value);
+                },
+                defaultMessage() {
+                    return 'error.invalidTmpKey';
+                },
+            },
+        });
+    };
+}
+/**
+ * 允许字段为 undefined，如果不是 undefined 才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsUndefinable()
+ *   @IsString()
+ *   nickname?: string; // undefined 或字符串
+ * }
+ * ```
+ */
+function IsUndefinable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => value !== undefined, options);
+}
+/**
+ * 允许字段为空值（null、undefined 或空字符串），如果不为空才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsEmptyable()
+ *   @IsEmail()
+ *   email?: string; // 可以为空，或者必须是有效邮箱
+ * }
+ * ```
+ */
+function IsEmptyable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => !(value === null ||
+        value === undefined ||
+        ((0, lodash_1.isString)(value) && value.trim() === '')), options);
+}
+/**
+ * 允许字段为 null，如果不是 null 才执行其他验证
+ *
+ * @param options 验证选项
+ *
+ * @example
+ * ```typescript
+ * class UserDto {
+ *   @IsNullable()
+ *   @IsNumber()
+ *   age?: number | null; // null 或数字
+ * }
+ * ```
+ */
+function IsNullable(options) {
+    return (0, class_validator_1.ValidateIf)((obj, value) => value !== null, options);
+}
+/**
+ * 验证 HTTP/HTTPS URL
+ *
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class WebsiteDto {
+ *   @IsHttpUrl({ message: 'Invalid URL' })
+ *   url: string;
+ * }
+ * ```
+ */
+function IsHttpUrl(validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            name: 'isHttpUrl',
+            target: object.constructor,
+            propertyName: propertyName,
+            options: validationOptions,
+            validator: {
+                validate(value) {
+                    const httpUrlPattern = /^(https?:\/\/)/i;
+                    return typeof value === 'string' && httpUrlPattern.test(value);
+                },
+                defaultMessage() {
+                    return 'URL must start with http:// or https://';
+                },
+            },
+        });
+    };
+}
+/**
+ * Validator constraint for AtLeastOneField decorator
+ */
+let AtLeastOneFieldConstraint = class AtLeastOneFieldConstraint {
+    validate(value, args) {
+        const object = args.object;
+        const [requiredProperties] = args.constraints;
+        // Check if at least one property has a value
+        return requiredProperties.some((property) => {
+            const propValue = object[property];
+            return (propValue !== null &&
+                propValue !== undefined &&
+                propValue !== '' &&
+                !(Array.isArray(propValue) && propValue.length === 0));
+        });
+    }
+    defaultMessage(args) {
+        const [requiredProperties] = args.constraints;
+        return `At least one of the following fields must be provided: ${requiredProperties.join(', ')}`;
+    }
+};
+exports.AtLeastOneFieldConstraint = AtLeastOneFieldConstraint;
+exports.AtLeastOneFieldConstraint = AtLeastOneFieldConstraint = __decorate([
+    (0, class_validator_1.ValidatorConstraint)({ name: 'atLeastOneField', async: false })
+], AtLeastOneFieldConstraint);
+/**
+ * 验证至少提供指定字段中的一个
+ *
+ * @param properties 要检查的属性名数组
+ * @param validationOptions 验证选项
+ *
+ * @example
+ * ```typescript
+ * class ContactDto {
+ *   @AtLeastOneField(['email', 'phone'], {
+ *     message: 'Either email or phone must be provided'
+ *   })
+ *   email?: string;
+ *
+ *   phone?: string;
+ * }
+ * ```
+ *
+ * @example
+ * 使用虚拟字段（推荐用于类级别验证）：
+ * ```typescript
+ * class ContactDto {
+ *   @AtLeastOneField(['email', 'phone'])
+ *   _atLeastOne: any; // 虚拟字段用于验证
+ *
+ *   email?: string;
+ *   phone?: string;
+ * }
+ * ```
+ */
+function AtLeastOneField(properties, validationOptions) {
+    return function (object, propertyName) {
+        (0, class_validator_1.registerDecorator)({
+            target: object.constructor,
+            propertyName: propertyName,
+            options: Object.assign({ message: (0, nestjs_i18n_1.i18nValidationMessage)('validation.AT_LEAST_ONE_FIELD', {
+                    properties: properties.join(', '),
+                }) }, validationOptions),
+            constraints: [properties],
+            validator: AtLeastOneFieldConstraint,
+        });
+    };
+}

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

@@ -0,0 +1,96 @@
+/**
+ * @CustomValidate 使用示例
+ *
+ * 这个文件包含了各种使用场景的示例代码
+ */
+import { Repository } from 'typeorm';
+import { ValidationContext } from '../validators/custom-validate.validator';
+export declare class Example1_InlineValidation {
+    price: number;
+    code: string;
+    maxPrice: number;
+    minPrice: number;
+}
+export declare class Example2_EntityMethod {
+    version: string;
+    publishedAt: Date;
+    createdAt: Date;
+    validateVersion(value: string): boolean;
+    checkDates(value: Date, context: ValidationContext): Promise<boolean>;
+}
+export declare class ExampleValidationService {
+    private readonly userRepository;
+    constructor(userRepository: Repository<any>);
+    /**
+     * 检查用户名是否可用
+     */
+    usernameAvailable(username: string): Promise<boolean>;
+    /**
+     * 检查邮箱格式
+     */
+    validateEmail(email: string): boolean;
+    /**
+     * 检查数值范围（带额外参数）
+     */
+    checkRange(value: number, context: ValidationContext, min: number, max: number): boolean;
+    /**
+     * 复杂的业务验证
+     */
+    validateBusinessRule(value: any, context: ValidationContext): Promise<boolean>;
+}
+export declare class Example3_ServiceValidation {
+    username: string;
+    email: string;
+    age: number;
+    businessField: string;
+    userId: string;
+}
+export declare class Example4_LazyReference {
+    username: string;
+}
+export declare class Example5_ComplexValidation {
+    password: string;
+    confirmPassword: string;
+    approverId?: string;
+    requiresApproval: boolean;
+}
+export declare class FileValidationService {
+    private readonly allowedMimeTypes;
+    private readonly maxFileSize;
+    checkFileType(mimeType: string): boolean;
+    checkFileSize(size: number, context: ValidationContext, maxSize?: number): boolean;
+    checkFileHash(hash: string): Promise<boolean>;
+}
+export declare class Example6_FileUpload {
+    mimeType: string;
+    size: number;
+    hash: string;
+}
+export declare class Example7_DynamicMessage {
+    discount: number;
+}
+export declare class ThirdPartyValidationService {
+    /**
+     * 验证地址是否真实存在
+     */
+    validateAddress(address: string): Promise<boolean>;
+    /**
+     * 验证税号是否有效
+     */
+    validateTaxId(taxId: string, context: ValidationContext): Promise<boolean>;
+}
+export declare class Example8_ThirdPartyAPI {
+    address: string;
+    taxId: string;
+    country: string;
+}
+export declare class CachedValidationService {
+    private cache;
+    private readonly cacheTTL;
+    expensiveValidation(value: string): Promise<boolean>;
+    private doExpensiveCheck;
+    private cleanExpiredCache;
+}
+export declare class Example9_CachedValidation {
+    field: string;
+}