@nest-omni/core 4.1.3-2 → 4.1.3-4

package/decorators/validator.decorators.js

@@ -1,193 +1,25 @@
 "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;
-};
-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.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;
-exports.CustomValidation = CustomValidation;
-exports.CustomValidationMethod = CustomValidationMethod;
-const class_validator_1 = require("class-validator");
-const lodash_1 = require("lodash");
-const nestjs_i18n_1 = require("nestjs-i18n");
-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);
-                },
-            },
-        });
-    };
-}
-function IsPhoneNumber(validationOptions) {
-    return (0, class_validator_1.IsPhoneNumber)(validationOptions === null || validationOptions === void 0 ? void 0 : validationOptions.region, Object.assign({ message: 'error.phoneNumber' }, validationOptions));
-}
-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';
-                },
-            },
-        });
-    };
-}
-function IsUndefinable(options) {
-    return (0, class_validator_1.ValidateIf)((obj, value) => value !== undefined, options);
-}
-function IsEmptyable(options) {
-    return (0, class_validator_1.ValidateIf)((obj, value) => !(value === null ||
-        value === undefined ||
-        ((0, lodash_1.isString)(value) && value.trim() === '')), options);
-}
-function IsNullable(options) {
-    return (0, class_validator_1.ValidateIf)((obj, value) => value !== null, options);
-}
-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://';
-                },
-            },
-        });
-    };
-}
-let AtLeastOneFieldConstraint = class AtLeastOneFieldConstraint {
-    validate(value, args) {
-        const object = args.object;
-        const [requiredProperties] = args.constraints;
-        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(', ')}`;
+/**
+ * Validator decorators
+ *
+ * 所有验证装饰器已迁移到 validators 目录
+ * 此文件仅用于重新导出，保持导入路径的一致性
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.AtLeastOneFieldConstraint = AtLeastOneFieldConstraint;
-exports.AtLeastOneFieldConstraint = AtLeastOneFieldConstraint = __decorate([
-    (0, class_validator_1.ValidatorConstraint)({ name: 'atLeastOneField', async: false })
-], AtLeastOneFieldConstraint);
-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,
-        });
-    };
-}
-function CustomValidation(validationCallback, validationOptions) {
-    return function (object, propertyName) {
-        (0, class_validator_1.registerDecorator)({
-            name: 'customValidation',
-            target: object.constructor,
-            propertyName,
-            options: Object.assign({ message: (0, nestjs_i18n_1.i18nValidationMessage)('validation.CUSTOM_VALIDATION') }, validationOptions),
-            validator: {
-                validate(value, args) {
-                    return __awaiter(this, void 0, void 0, function* () {
-                        try {
-                            return yield validationCallback(value, args);
-                        }
-                        catch (error) {
-                            console.error('CustomValidation error:', error);
-                            return false;
-                        }
-                    });
-                },
-                defaultMessage(args) {
-                    return `Validation failed for ${args.property}`;
-                },
-            },
-        });
-    };
-}
-function CustomValidationMethod(methodName, validationOptions) {
-    return function (object, propertyName) {
-        (0, class_validator_1.registerDecorator)({
-            name: 'customValidationMethod',
-            target: object.constructor,
-            propertyName,
-            constraints: [methodName],
-            options: Object.assign({ message: (0, nestjs_i18n_1.i18nValidationMessage)('validation.CUSTOM_VALIDATION_METHOD') }, validationOptions),
-            validator: {
-                validate(value, args) {
-                    return __awaiter(this, void 0, void 0, function* () {
-                        const [method] = args.constraints;
-                        const object = args.object;
-                        if (typeof object[method] !== 'function') {
-                            console.error(`CustomValidationMethod: Method '${method}' not found on object`);
-                            return false;
-                        }
-                        try {
-                            const result = yield object[method](value, args);
-                            return Boolean(result);
-                        }
-                        catch (error) {
-                            console.error(`CustomValidationMethod error in '${method}':`, error);
-                            return false;
-                        }
-                    });
-                },
-                defaultMessage(args) {
-                    const [method] = args.constraints;
-                    return `Validation failed for ${args.property} using method ${method}`;
-                },
-            },
-        });
-    };
-}
+Object.defineProperty(exports, "__esModule", { value: true });
+// 重新导出所有验证装饰器
+__exportStar(require("../validators/common-validators"), exports);
+__exportStar(require("../validators/custom-validate.validator"), exports);

package/filters/constraint-errors.js

@@ -1,4 +1,5 @@
 "use strict";
+/* eslint-disable @typescript-eslint/naming-convention */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.constraintErrors = void 0;
 exports.constraintErrors = {

package/helpers/common.helper.d.ts

@@ -1,3 +1,16 @@
+/**
+ * 将枚举值转换成数组
+ * @param Enum 枚举
+ */
 export declare function enumToArray<E>(Enum: any): E[];
+/**
+ * 生成随机字符串
+ * @param {number} length 生成长度
+ * @param {string} charSet 指定字符集
+ * @returns {string} 生成字符串
+ */
 export declare const randomString: (length?: number, charSet?: string) => string;
+/**
+ * 获取服务部署 IP 地址
+ */
 export declare function getIPAdress(): string;

package/helpers/common.helper.js

@@ -4,11 +4,21 @@ exports.randomString = void 0;
 exports.enumToArray = enumToArray;
 exports.getIPAdress = getIPAdress;
 const os_1 = require("os");
+/**
+ * 将枚举值转换成数组
+ * @param Enum 枚举
+ */
 function enumToArray(Enum) {
     return Object.keys(Enum)
         .filter((key) => typeof Enum[key] === 'number')
         .map((key) => Enum[key]);
 }
+/**
+ * 生成随机字符串
+ * @param {number} length 生成长度
+ * @param {string} charSet 指定字符集
+ * @returns {string} 生成字符串
+ */
 const randomString = (length = 8, charSet) => {
     charSet =
         charSet || 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
@@ -20,6 +30,9 @@ const randomString = (length = 8, charSet) => {
     return randomString;
 };
 exports.randomString = randomString;
+/**
+ * 获取服务部署 IP 地址
+ */
 function getIPAdress() {
     const interfaces = (0, os_1.networkInterfaces)();
     for (const devName in interfaces) {

package/http-client/config/http-client.config.d.ts

@@ -1,6 +1,21 @@
 import { HttpClientConfig } from '../interfaces/http-client-config.interface';
+/**
+ * HTTP客户端默认配置
+ */
 export declare const DEFAULT_HTTP_CLIENT_CONFIG: Partial<HttpClientConfig>;
+/**
+ * 开发环境配置
+ */
 export declare const DEVELOPMENT_HTTP_CLIENT_CONFIG: Partial<HttpClientConfig>;
+/**
+ * 生产环境配置
+ */
 export declare const PRODUCTION_HTTP_CLIENT_CONFIG: Partial<HttpClientConfig>;
+/**
+ * 测试环境配置
+ */
 export declare const TEST_HTTP_CLIENT_CONFIG: Partial<HttpClientConfig>;
+/**
+ * 根据环境获取配置
+ */
 export declare function getHttpClientConfig(env?: string): Partial<HttpClientConfig>;

package/http-client/config/http-client.config.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.TEST_HTTP_CLIENT_CONFIG = exports.PRODUCTION_HTTP_CLIENT_CONFIG = exports.DEVELOPMENT_HTTP_CLIENT_CONFIG = exports.DEFAULT_HTTP_CLIENT_CONFIG = void 0;
 exports.getHttpClientConfig = getHttpClientConfig;
 const cache_options_interface_1 = require("../../cache/interfaces/cache-options.interface");
+/**
+ * HTTP客户端默认配置
+ */
 exports.DEFAULT_HTTP_CLIENT_CONFIG = {
     timeout: 30000,
     retry: {
@@ -10,10 +13,11 @@ exports.DEFAULT_HTTP_CLIENT_CONFIG = {
         retries: 3,
         retryDelay: (retryCount) => Math.pow(2, retryCount) * 1000,
         retryCondition: (error) => {
+            // 默认重试条件：网络错误、超时、5xx错误、429错误
             if (!error.response)
-                return true;
+                return true; // 网络错误
             const status = error.response.status;
-            return status >= 500 || status === 429;
+            return status >= 500 || status === 429; // 服务器错误或限流
         },
         shouldResetTimeout: true,
     },
@@ -27,7 +31,7 @@ exports.DEFAULT_HTTP_CLIENT_CONFIG = {
     },
     cache: {
         enabled: true,
-        defaultTtl: 300000,
+        defaultTtl: 300000, // 5分钟
         cacheableMethods: ['GET', 'HEAD'],
         cacheableStatusCodes: [200, 201, 304],
         options: {
@@ -39,37 +43,49 @@ exports.DEFAULT_HTTP_CLIENT_CONFIG = {
         logRequests: true,
         logResponses: true,
         logErrors: true,
-        logHeaders: false,
+        logHeaders: false, // 默认不记录头信息（安全考虑）
         logBody: true,
         maxBodyLength: 1000,
         sanitizeHeaders: ['authorization', 'apikey', 'password', 'token', 'cookie'],
         logLevel: 'info',
         databaseLogging: {
-            enabled: false,
+            enabled: false, // 默认不启用数据库日志
             dataSource: 'default',
             tableName: 'http_logs',
         },
     },
     logCleanup: {
-        enabled: false,
+        enabled: false, // 默认不启用日志清理
         retentionDays: 30,
         maxRecords: 100000,
         batchSize: 1000,
-        schedule: '0 2 * * *',
+        schedule: '0 2 * * *', // 每天凌晨2点
         strategy: 'retention',
     },
 };
+/**
+ * 开发环境配置
+ */
 exports.DEVELOPMENT_HTTP_CLIENT_CONFIG = Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG), { logging: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logging), { enabled: true, logHeaders: true, logBody: true, logLevel: 'debug', databaseLogging: {
-            enabled: true,
+            enabled: true, // 开发环境启用数据库日志
             dataSource: 'default',
             tableName: 'http_logs',
         } }), logCleanup: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logCleanup), { enabled: false }) });
+/**
+ * 生产环境配置
+ */
 exports.PRODUCTION_HTTP_CLIENT_CONFIG = Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG), { timeout: 60000, retry: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.retry), { retries: 5 }), circuitBreaker: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.circuitBreaker), { failureThreshold: 3, recoveryTimeoutMs: 120000 }), logging: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logging), { enabled: true, logHeaders: false, logBody: false, logLevel: 'warn', databaseLogging: {
-            enabled: true,
+            enabled: true, // 生产环境启用数据库日志
             dataSource: 'default',
             tableName: 'http_logs',
         } }), logCleanup: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logCleanup), { enabled: true, retentionDays: 7, maxRecords: 50000, schedule: '0 3 * * *' }) });
+/**
+ * 测试环境配置
+ */
 exports.TEST_HTTP_CLIENT_CONFIG = Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG), { timeout: 10000, retry: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.retry), { retries: 1 }), circuitBreaker: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.circuitBreaker), { failureThreshold: 10, recoveryTimeoutMs: 5000 }), logging: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logging), { enabled: false }), logCleanup: Object.assign(Object.assign({}, exports.DEFAULT_HTTP_CLIENT_CONFIG.logCleanup), { enabled: false }) });
+/**
+ * 根据环境获取配置
+ */
 function getHttpClientConfig(env) {
     switch (env === null || env === void 0 ? void 0 : env.toLowerCase()) {
         case 'development':

package/http-client/decorators/http-client.decorators.d.ts

@@ -8,7 +8,15 @@ export declare const LOGGING_OPTIONS_KEY = "http_logging_options";
 export declare const TIMEOUT_OPTIONS_KEY = "http_timeout_options";
 export declare const PROXY_OPTIONS_KEY = "http_proxy_options";
 export declare const CALL_INFO_KEY = "http_call_info";
+/**
+ * HTTP客户端装饰器
+ * 类似Spring Boot的@RestClient注解
+ */
 export declare const HttpClient: (options?: HttpClientConfig) => (target: any) => void;
+/**
+ * 重试装饰器
+ * 基于axios-retry库
+ */
 export declare const HttpRetry: (options?: {
     retries?: number;
     retryDelay?: (retryCount: number) => number;
@@ -16,20 +24,38 @@ export declare const HttpRetry: (options?: {
     shouldResetTimeout?: boolean;
     onRetry?: (retryCount: number, error: any, requestConfig: any) => void;
 }) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * 熔断器装饰器
+ * 类似Spring Cloud CircuitBreaker的@CircuitBreaker注解
+ */
 export declare const HttpCircuitBreaker: (options?: {
     failureThreshold?: number;
     recoveryTimeoutMs?: number;
     monitoringPeriodMs?: number;
     minimumThroughputThreshold?: number;
 }) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * HTTP缓存装饰器
+ * 集成现有的三层缓存架构
+ */
 export declare const HttpCacheable: (options?: {
+    /** 缓存TTL（毫秒） */
     ttl?: number;
+    /** 缓存键 */
     key?: string | ((...args: any[]) => string);
+    /** 缓存层 */
     layers?: Array<"cls" | "memory" | "redis">;
+    /** 缓存条件 */
     condition?: (...args: any[]) => boolean | Promise<boolean>;
+    /** 除非条件 */
     unless?: string | ((result: any, args: any[]) => boolean);
+    /** 命名空间 */
     namespace?: string;
 }) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * 请求日志装饰器
+ * 类似Spring Boot的@LogRequest注解
+ */
 export declare const HttpLogRequest: (options?: {
     logHeaders?: boolean;
     logBody?: boolean;
@@ -40,7 +66,14 @@ export declare const HttpLogRequest: (options?: {
     methodName?: string;
     operationName?: string;
 }) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * 超时装饰器
+ * 类似Spring的@Timeout注解
+ */
 export declare const HttpTimeout: (timeoutMs: number) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * 代理装饰器
+ */
 export declare const HttpUseProxy: (options: {
     host: string;
     port: number;
@@ -50,15 +83,45 @@ export declare const HttpUseProxy: (options: {
         password: string;
     };
 }) => (target: any, propertyKey: string, descriptor: PropertyDescriptor) => PropertyDescriptor;
+/**
+ * 装饰器工具函数
+ */
 export declare class HttpDecoratorUtils {
+    /**
+     * 获取方法上的重试配置
+     */
     static getRetryOptions(target: any, propertyKey: string): RetryConfig | undefined;
+    /**
+     * 获取方法上的熔断器配置
+     */
     static getCircuitBreakerOptions(target: any, propertyKey: string): CircuitBreakerConfig | undefined;
+    /**
+     * 获取方法上的缓存配置
+     */
     static getCacheOptions(target: any, propertyKey: string): HttpCacheConfig | undefined;
+    /**
+     * 获取方法上的日志配置
+     */
     static getLoggingOptions(target: any, propertyKey: string): any;
+    /**
+     * 获取方法上的超时配置
+     */
     static getTimeoutOptions(target: any, propertyKey: string): number | undefined;
+    /**
+     * 获取方法上的代理配置
+     */
     static getProxyOptions(target: any, propertyKey: string): any;
+    /**
+     * 获取类上的HTTP客户端配置
+     */
     static getHttpClientOptions(target: any): HttpClientConfig;
+    /**
+     * 获取方法上的调用信息配置
+     */
     static getCallInfoOptions(target: any, propertyKey: string): any;
+    /**
+     * 获取所有装饰器配置
+     */
     static getAllDecoratorConfigs(target: any, propertyKey: string): {
         retry?: RetryConfig;
         circuitBreaker?: CircuitBreakerConfig;