@nest-omni/core 4.1.3-25 → 4.1.3-27

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

@@ -166,7 +166,12 @@ export interface LoggingConfig {
     logHeaders?: boolean;
     logBody?: boolean;
     maxBodyLength?: number;
-    sanitizeHeaders?: string[];
+    /**
+     * 脱敏配置
+     * 敏感字段列表，统一适用于 headers、body、query string
+     * 例如：['password', 'token', 'secret', 'apiKey']
+     */
+    sanitize?: string[];
     logLevel?: 'debug' | 'info' | 'warn' | 'error';
     databaseLogging?: {
         enabled?: boolean;

package/http-client/services/api-client-registry.service.d.ts

@@ -1,7 +1,7 @@
 import { ApiClientConfig, ApiClientInstanceConfig, ApiClientRegistryConfig, AuthType, ResponseTransformerConfig } from '../interfaces/api-client-config.interface';
 import { HttpCircuitBreakerService } from './circuit-breaker.service';
 import { HttpLoggingService } from './logging.service';
-export { ApiClientInstanceConfig, AuthType, ResponseTransformerConfig, };
+export { ApiClientInstanceConfig, AuthType, ResponseTransformerConfig };
 /**
  * API客户端注册服务
  * 负责管理多个 HttpClientService 实例
@@ -19,11 +19,6 @@ export declare class ApiClientRegistryService {
      * 使用 HttpClientService.createApiClient 静态方法创建
      */
     createClient<T = any>(config: ApiClientInstanceConfig): T;
-    /**
-     * 深度合并配置（已废弃，不再需要）
-     * @deprecated 配置结构简化后不再需要此方法
-     */
-    private deepMergeConfigs;
     /**
      * 获取已注册的客户端
      */
@@ -78,6 +73,11 @@ export declare class ApiClientRegistryService {
             error?: string;
         }>;
     }>;
+    /**
+     * 深度合并配置（已废弃，不再需要）
+     * @deprecated 配置结构简化后不再需要此方法
+     */
+    private deepMergeConfigs;
     /**
      * 合并环境特定配置
      */

package/http-client/services/api-client-registry.service.js

@@ -47,7 +47,7 @@ let ApiClientRegistryService = ApiClientRegistryService_1 = class ApiClientRegis
                     logHeaders: true,
                     logBody: true,
                     maxBodyLength: 10000,
-                    sanitizeHeaders: ['authorization', 'api-key'],
+                    sanitize: ['authorization', 'api-key'],
                     logLevel: 'info',
                 },
                 timeout: 30000,
@@ -74,7 +74,7 @@ let ApiClientRegistryService = ApiClientRegistryService_1 = class ApiClientRegis
         // 1. 从全局默认配置开始
         // 2. 合并 ApiClient 的 httpConfig
         // 3. 应用 ApiClient 特有的 retry 配置（兼容旧代码）
-        let mergedHttpConfig = Object.assign(Object.assign({}, this.globalDefaults.globalDefaults), finalConfig.httpConfig);
+        const mergedHttpConfig = Object.assign(Object.assign({}, this.globalDefaults.globalDefaults), finalConfig.httpConfig);
         // 兼容：如果 ApiClientConfig 顶层有 retry 配置，合并到 httpConfig.retry
         if (finalConfig.retry) {
             mergedHttpConfig.retry = Object.assign(Object.assign({}, mergedHttpConfig.retry), finalConfig.retry);
@@ -95,13 +95,6 @@ let ApiClientRegistryService = ApiClientRegistryService_1 = class ApiClientRegis
         this.logger.log(`Created API client: ${clientName}`);
         return httpClient;
     }
-    /**
-     * 深度合并配置（已废弃，不再需要）
-     * @deprecated 配置结构简化后不再需要此方法
-     */
-    deepMergeConfigs(defaults, userConfig) {
-        return Object.assign(Object.assign({}, defaults), userConfig);
-    }
     /**
      * 获取已注册的客户端
      */
@@ -226,6 +219,13 @@ let ApiClientRegistryService = ApiClientRegistryService_1 = class ApiClientRegis
             };
         });
     }
+    /**
+     * 深度合并配置（已废弃，不再需要）
+     * @deprecated 配置结构简化后不再需要此方法
+     */
+    deepMergeConfigs(defaults, userConfig) {
+        return Object.assign(Object.assign({}, defaults), userConfig);
+    }
     /**
      * 合并环境特定配置
      */

package/http-client/services/circuit-breaker.service.d.ts

@@ -55,15 +55,6 @@ export declare class HttpCircuitBreakerService {
      * 清理超过最大空闲时间的Circuit Breaker
      */
     cleanupIdle(): number;
-    /**
-     * 基于LRU策略清理Circuit Breaker
-     * 删除最久未访问的Circuit Breaker直到数量降到maxSize以下
-     */
-    private cleanupLRU;
-    /**
-     * 启动定期清理任务
-     */
-    private startCleanupTask;
     /**
      * 手动触发清理（用于测试）
      */
@@ -76,6 +67,15 @@ export declare class HttpCircuitBreakerService {
      * 获取清理配置
      */
     getCleanupConfig(): CircuitBreakerCleanupConfig;
+    /**
+     * 基于LRU策略清理Circuit Breaker
+     * 删除最久未访问的Circuit Breaker直到数量降到maxSize以下
+     */
+    private cleanupLRU;
+    /**
+     * 启动定期清理任务
+     */
+    private startCleanupTask;
 }
 /**
  * 熔断器类

package/http-client/services/circuit-breaker.service.js

@@ -160,6 +160,30 @@ let HttpCircuitBreakerService = HttpCircuitBreakerService_1 = class HttpCircuitB
         }
         return keysToDelete.length;
     }
+    /**
+     * 手动触发清理（用于测试）
+     */
+    manualCleanup() {
+        return this.cleanupIdle();
+    }
+    /**
+     * 设置清理配置
+     */
+    setCleanupConfig(config) {
+        Object.assign(this.cleanupConfig, config);
+        // 重启清理任务
+        if (this.cleanupTimer) {
+            clearInterval(this.cleanupTimer);
+        }
+        this.startCleanupTask();
+        this.logger.log(`Circuit breaker cleanup config updated: ${JSON.stringify(this.cleanupConfig)}`);
+    }
+    /**
+     * 获取清理配置
+     */
+    getCleanupConfig() {
+        return Object.assign({}, this.cleanupConfig);
+    }
     /**
      * 基于LRU策略清理Circuit Breaker
      * 删除最久未访问的Circuit Breaker直到数量降到maxSize以下
@@ -194,30 +218,6 @@ let HttpCircuitBreakerService = HttpCircuitBreakerService_1 = class HttpCircuitB
         }, this.cleanupConfig.cleanupIntervalMs);
         this.logger.log(`Circuit breaker cleanup task started (interval: ${this.cleanupConfig.cleanupIntervalMs}ms, maxIdleTime: ${this.cleanupConfig.maxIdleTimeMs}ms)`);
     }
-    /**
-     * 手动触发清理（用于测试）
-     */
-    manualCleanup() {
-        return this.cleanupIdle();
-    }
-    /**
-     * 设置清理配置
-     */
-    setCleanupConfig(config) {
-        Object.assign(this.cleanupConfig, config);
-        // 重启清理任务
-        if (this.cleanupTimer) {
-            clearInterval(this.cleanupTimer);
-        }
-        this.startCleanupTask();
-        this.logger.log(`Circuit breaker cleanup config updated: ${JSON.stringify(this.cleanupConfig)}`);
-    }
-    /**
-     * 获取清理配置
-     */
-    getCleanupConfig() {
-        return Object.assign({}, this.cleanupConfig);
-    }
 };
 exports.HttpCircuitBreakerService = HttpCircuitBreakerService;
 exports.HttpCircuitBreakerService = HttpCircuitBreakerService = HttpCircuitBreakerService_1 = __decorate([

package/http-client/services/http-client.service.d.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { HttpClientConfig } from '../interfaces/http-client-config.interface';
-import { AuthType, ApiKeyConfig, BasicAuthConfig, BearerTokenConfig, CustomAuthConfig, OAuth2Config } from '../interfaces/api-client-config.interface';
+import { ApiKeyConfig, AuthType, BasicAuthConfig, BearerTokenConfig, CustomAuthConfig, OAuth2Config } from '../interfaces/api-client-config.interface';
 import { HttpCircuitBreakerService } from './circuit-breaker.service';
 import { HttpLoggingService } from './logging.service';
 import { RedisLockService } from '../../redis-lock/redis-lock.service';
@@ -11,6 +11,15 @@ interface ExtendedAxiosRequestConfig extends AxiosRequestConfig {
         [key: string]: any;
     };
 }
+/**
+ * 请求返回选项
+ */
+interface RequestReturnOptions {
+    /** 返回类型: 'data'(默认) | 'full' | 'custom' */
+    returnType?: 'data' | 'full' | 'custom';
+    /** 自定义返回转换函数 */
+    transform?: (response: AxiosResponse) => any;
+}
 /**
  * 认证配置接口
  */
@@ -55,8 +64,16 @@ export declare class HttpClientService {
     }): HttpClientService;
     /**
      * 执行HTTP请求
+     * @param config 请求配置
+     * @param decoratorContext 装饰器上下文
+     * @param clientName 客户端名称
+     * @param returnOptions 返回选项
+     *   - returnType: 'data'(默认)只返回response.data
+     *   - returnType: 'full'返回完整AxiosResponse对象
+     *   - returnType: 'custom'使用自定义转换函数
+     *   - transform: 自定义转换函数，接收完整response返回任意数据
      */
-    request<T = any>(config: ExtendedAxiosRequestConfig, decoratorContext?: any, clientName?: string): Promise<T>;
+    request<T = any>(config: ExtendedAxiosRequestConfig, decoratorContext?: any, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
     /**
      * 生成curl命令（动态生成，不存储）
      */
@@ -77,16 +94,11 @@ export declare class HttpClientService {
      * 获取客户端名称
      */
     getName(): string | undefined;
-    /**
-     * Capture calling context information
-     * @returns Calling context with service class and method name
-     */
-    private captureCallingContext;
-    get<T = any>(url: string, config?: AxiosRequestConfig, clientName?: string): Promise<T>;
-    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string): Promise<T>;
-    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string): Promise<T>;
-    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string): Promise<T>;
-    delete<T = any>(url: string, config?: AxiosRequestConfig, clientName?: string): Promise<T>;
+    get<T = any>(url: string, config?: AxiosRequestConfig, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
+    post<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
+    put<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
+    patch<T = any>(url: string, data?: any, config?: AxiosRequestConfig, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
+    delete<T = any>(url: string, config?: AxiosRequestConfig, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
     /**
      * 带等待锁的认证请求方法
      * 用于需要确保只有一个进程执行认证相关操作的场景
@@ -101,7 +113,7 @@ export declare class HttpClientService {
         lockTimeout?: number;
         waitTimeout?: number;
         enableRetry?: boolean;
-    }, clientName?: string): Promise<T>;
+    }, clientName?: string, returnOptions?: RequestReturnOptions): Promise<T>;
     /**
      * 带等待锁的批量认证请求
      * 用于需要批量执行认证相关操作但避免重复认证的场景
@@ -120,6 +132,11 @@ export declare class HttpClientService {
         waitTimeout?: number;
         maxConcurrency?: number;
     }, clientName?: string): Promise<Array<T | null>>;
+    /**
+     * Capture calling context information
+     * @returns Calling context with service class and method name
+     */
+    private captureCallingContext;
     /**
      * 创建Axios实例并配置axios-retry
      */

package/http-client/services/http-client.service.js

@@ -92,8 +92,16 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
     }
     /**
      * 执行HTTP请求
+     * @param config 请求配置
+     * @param decoratorContext 装饰器上下文
+     * @param clientName 客户端名称
+     * @param returnOptions 返回选项
+     *   - returnType: 'data'(默认)只返回response.data
+     *   - returnType: 'full'返回完整AxiosResponse对象
+     *   - returnType: 'custom'使用自定义转换函数
+     *   - transform: 自定义转换函数，接收完整response返回任意数据
      */
-    request(config, decoratorContext, clientName) {
+    request(config, decoratorContext, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
             // Use the instance's clientName as fallback if not provided
@@ -107,7 +115,10 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
             const baseURL = config.baseURL || this.defaultConfig.baseURL || '';
             // 构建完整的URL用于验证
             let fullURL = requestURL;
-            if (requestURL && !requestURL.startsWith('http://') && !requestURL.startsWith('https://') && baseURL) {
+            if (requestURL &&
+                !requestURL.startsWith('http://') &&
+                !requestURL.startsWith('https://') &&
+                baseURL) {
                 // 处理相对URL
                 try {
                     fullURL = new URL(requestURL, baseURL).href;
@@ -118,7 +129,8 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
                 }
             }
             // 执行URL安全验证（只对完整URL进行验证）
-            if (fullURL && (fullURL.startsWith('http://') || fullURL.startsWith('https://'))) {
+            if (fullURL &&
+                (fullURL.startsWith('http://') || fullURL.startsWith('https://'))) {
                 const sanitizeResult = security_validator_util_1.SecurityValidator.sanitizeURL(fullURL, {
                     urlConfig: (_a = this.defaultConfig.security) === null || _a === void 0 ? void 0 : _a.urlValidation,
                     ssrfConfig: (_b = this.defaultConfig.security) === null || _b === void 0 ? void 0 : _b.ssrfProtection,
@@ -143,7 +155,7 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
             let circuitBreakerState;
             try {
                 // 应用认证配置
-                let authConfig = yield this.applyAuthToConfig(config);
+                const authConfig = yield this.applyAuthToConfig(config);
                 // 应用装饰器配置
                 const enhancedConfig = this.applyDecoratorConfig(authConfig, decoratorContext);
                 // 将 retryRecorder 存储到 config metadata 中,供 onRetry 回调使用
@@ -191,7 +203,24 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
                 }
                 // 更新统计信息
                 this.updateRequestStats(true, Date.now() - startTime, ((_f = response.config) === null || _f === void 0 ? void 0 : _f.method) || 'GET', response.status);
-                return response.data;
+                // 根据返回选项处理响应
+                const options = returnOptions || { returnType: 'data' };
+                switch (options.returnType) {
+                    case 'full':
+                        // 返回完整响应对象
+                        return response;
+                    case 'custom':
+                        // 使用自定义转换函数
+                        if (options.transform) {
+                            return options.transform(response);
+                        }
+                        // 如果没有提供转换函数，回退到返回data
+                        return response.data;
+                    case 'data':
+                    default:
+                        // 默认只返回data（保持向后兼容）
+                        return response.data;
+                }
             }
             catch (error) {
                 // 错误日志
@@ -265,58 +294,30 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
     getName() {
         return this.clientName;
     }
-    /**
-     * Capture calling context information
-     * @returns Calling context with service class and method name
-     */
-    captureCallingContext() {
-        try {
-            // Use CallStackExtractor to get the calling context
-            const stackInfo = call_stack_extractor_util_1.CallStackExtractor.getCallInfo();
-            // Skip internal HTTP client calls
-            if (stackInfo.serviceClass && stackInfo.methodName) {
-                // Check if it's an internal call
-                const isInternal = call_stack_extractor_util_1.CallStackExtractor['isInternalCall'](stackInfo.serviceClass);
-                if (!isInternal) {
-                    return {
-                        serviceClass: stackInfo.serviceClass,
-                        methodName: stackInfo.methodName,
-                        operationName: stackInfo.operationName,
-                    };
-                }
-            }
-            // If no useful context found, return empty
-            return {};
-        }
-        catch (error) {
-            this.logger.warn('Failed to capture calling context:', error.message);
-            return {};
-        }
-    }
     // 便捷方法
-    get(url, config, clientName) {
+    get(url, config, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(Object.assign(Object.assign({}, config), { method: 'GET', url }), undefined, clientName);
+            return this.request(Object.assign(Object.assign({}, config), { method: 'GET', url }), undefined, clientName, returnOptions);
         });
     }
-    post(url, data, config, clientName) {
+    post(url, data, config, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(Object.assign(Object.assign({}, config), { method: 'POST', url, data }), undefined, clientName);
+            return this.request(Object.assign(Object.assign({}, config), { method: 'POST', url, data }), undefined, clientName, returnOptions);
         });
     }
-    put(url, data, config, clientName) {
+    put(url, data, config, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(Object.assign(Object.assign({}, config), { method: 'PUT', url, data }), undefined, clientName);
+            return this.request(Object.assign(Object.assign({}, config), { method: 'PUT', url, data }), undefined, clientName, returnOptions);
         });
     }
-    patch(url, data, config, clientName) {
+    patch(url, data, config, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(Object.assign(Object.assign({}, config), { method: 'PATCH', url, data }), undefined, clientName);
+            return this.request(Object.assign(Object.assign({}, config), { method: 'PATCH', url, data }), undefined, clientName, returnOptions);
         });
     }
-    delete(url, config, clientName) {
+    delete(url, config, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
-            return this.request(Object.assign(Object.assign({}, config), { method: 'DELETE', url }), undefined, clientName);
+            return this.request(Object.assign(Object.assign({}, config), { method: 'DELETE', url }), undefined, clientName, returnOptions);
         });
     }
     /**
@@ -328,12 +329,12 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
      * @param options 等待锁选项
      * @returns 响应数据
      */
-    authRequest(config, tokenProvider, options, clientName) {
+    authRequest(config, tokenProvider, options, clientName, returnOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             const effectiveClientName = clientName || this.clientName;
             if (!this.redisLockService) {
                 this.logger.warn('RedisLockService not available, proceeding without lock');
-                return this.request(config, undefined, effectiveClientName);
+                return this.request(config, undefined, effectiveClientName, returnOptions);
             }
             const { lockKey = `auth-request:${(0, request_id_util_1.generateRequestId)()}`, lockTimeout = 30000, waitTimeout = 60000, enableRetry = true, } = options || {};
             try {
@@ -344,7 +345,7 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
                     // 添加认证头
                     const authConfig = Object.assign(Object.assign({}, config), { headers: Object.assign(Object.assign({}, config.headers), { Authorization: `Bearer ${token}` }) });
                     // 执行请求
-                    return this.request(authConfig, undefined, effectiveClientName);
+                    return this.request(authConfig, undefined, effectiveClientName, returnOptions);
                 }), {
                     ttl: lockTimeout,
                     retryCount: enableRetry ? 3 : 0,
@@ -466,6 +467,34 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
             }
         });
     }
+    /**
+     * Capture calling context information
+     * @returns Calling context with service class and method name
+     */
+    captureCallingContext() {
+        try {
+            // Use CallStackExtractor to get the calling context
+            const stackInfo = call_stack_extractor_util_1.CallStackExtractor.getCallInfo();
+            // Skip internal HTTP client calls
+            if (stackInfo.serviceClass && stackInfo.methodName) {
+                // Check if it's an internal call
+                const isInternal = call_stack_extractor_util_1.CallStackExtractor['isInternalCall'](stackInfo.serviceClass);
+                if (!isInternal) {
+                    return {
+                        serviceClass: stackInfo.serviceClass,
+                        methodName: stackInfo.methodName,
+                        operationName: stackInfo.operationName,
+                    };
+                }
+            }
+            // If no useful context found, return empty
+            return {};
+        }
+        catch (error) {
+            this.logger.warn('Failed to capture calling context:', error.message);
+            return {};
+        }
+    }
     /**
      * 创建Axios实例并配置axios-retry
      */
@@ -687,7 +716,7 @@ let HttpClientService = HttpClientService_1 = class HttpClientService {
                 logHeaders: true,
                 logBody: true,
                 maxBodyLength: 1000,
-                sanitizeHeaders: ['authorization', 'apikey', 'password', 'token'],
+                sanitize: ['password', 'secret', 'token', 'apiKey', 'authorization', 'cookie'],
                 logLevel: 'info',
                 databaseLogging: {
                     enabled: true,

package/http-client/services/logging.service.d.ts

@@ -33,7 +33,7 @@ export declare class HttpLoggingService implements OnModuleDestroy {
     private isProcessing;
     constructor();
     onModuleDestroy(): void;
-    initRepository(dataSource: string, tableName: string): Repository<HttpLogEntity>;
+    initRepository(dataSource: string, tableName: string): Repository<HttpLogEntity> | null;
     /**
      * 记录请求开始
      */
@@ -77,6 +77,22 @@ export declare class HttpLoggingService implements OnModuleDestroy {
         endDate?: Date;
         userId?: string;
     }): Promise<any>;
+    /**
+     * 获取日志队列统计信息
+     */
+    getQueueStats(): {
+        queueSize: number;
+        isProcessing: boolean;
+        config: AsyncLogConfig;
+    };
+    /**
+     * 手动刷新日志队列
+     */
+    manualFlush(): Promise<void>;
+    /**
+     * 设置异步日志配置
+     */
+    setAsyncConfig(config: Partial<AsyncLogConfig>): void;
     /**
      * 提取调用信息
      */
@@ -103,38 +119,6 @@ export declare class HttpLoggingService implements OnModuleDestroy {
      * 同步保存日志到数据库（用于异步模式内部）
      */
     private saveLogToDatabase;
-    /**
-     * 获取日志队列统计信息
-     */
-    getQueueStats(): {
-        queueSize: number;
-        isProcessing: boolean;
-        config: AsyncLogConfig;
-    };
-    /**
-     * 手动刷新日志队列
-     */
-    manualFlush(): Promise<void>;
-    /**
-     * 设置异步日志配置
-     */
-    setAsyncConfig(config: Partial<AsyncLogConfig>): void;
-    /**
-     * 转换请求体为字符串
-     */
-    private sanitizeBodyAsString;
-    /**
-     * 清理敏感头信息
-     */
-    private sanitizeHeaders;
-    /**
-     * 清理敏感请求体信息
-     */
-    private sanitizeBody;
-    /**
-     * 递归清理对象中的敏感字段
-     */
-    private sanitizeObject;
     /**
      * 获取完整URL
      * @param config Axios请求配置