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

package/http-client/entities/http-log.entity.d.ts

@@ -1,98 +1,307 @@
 import { AbstractUuidPrimaryEntity } from '../../common';
+/**
+ * HTTP请求日志实体
+ * 用于TypeORM数据库记录
+ */
 export declare class HttpLogEntity extends AbstractUuidPrimaryEntity {
+    /**
+     * 请求ID（从ContextProvider获取）
+     */
     requestId?: string;
+    /**
+     * 用户ID（从ContextProvider获取）
+     */
     userId?: string;
+    /**
+     * HTTP方法
+     */
     method: string;
+    /**
+     * 请求URL
+     */
     url: string;
+    /**
+     * 请求头信息（JSON格式）
+     */
     headers?: Record<string, string>;
+    /**
+     * 请求体内容
+     */
     body?: string;
+    /**
+     * 查询参数（JSON格式）
+     */
     params?: Record<string, any>;
+    /**
+     * HTTP状态码
+     */
     statusCode?: number;
+    /**
+     * 响应时间（毫秒）
+     */
     responseTime: number;
+    /**
+     * 尝试次数
+     */
     attemptCount: number;
+    /**
+     * 是否成功
+     */
     success: boolean;
+    /**
+     * 错误信息
+     */
     errorMessage?: string;
+    /**
+     * 错误堆栈
+     */
     errorStack?: string;
+    /**
+     * 错误代码
+     */
     errorCode?: string;
+    /**
+     * 响应头信息（JSON格式）
+     */
     responseHeaders?: Record<string, string>;
+    /**
+     * 响应体内容
+     */
     responseBody?: string;
-    responseSize?: number;
-    requestSize?: number;
+    /**
+     * 服务名称（用于微服务环境）
+     */
     serviceName?: string;
+    /**
+     * 自定义操作名称（用于业务标识）
+     */
     operationName?: string;
+    /**
+     * 客户端IP地址
+     */
     clientIp?: string;
+    /**
+     * 请求来源
+     */
     source?: string;
+    /**
+     * 请求标签（用于分类）
+     */
     tags?: string[];
+    /**
+     * 请求元数据（JSON格式）
+     */
     metadata?: Record<string, any>;
+    /**
+     * 重试记录（JSON格式）
+     */
     retryRecords?: RetryRecord[];
-    cacheHit?: boolean;
+    /**
+     * 熔断器状态
+     */
     circuitBreakerState?: string;
 }
+/**
+ * 重试记录接口
+ */
 export interface RetryRecord {
+    /**
+     * 重试次数
+     */
     attempt: number;
+    /**
+     * 重试时间
+     */
     timestamp: Date;
+    /**
+     * 重试原因
+     */
     reason: string;
+    /**
+     * 重试延迟（毫秒）
+     */
     delay: number;
+    /**
+     * 错误信息
+     */
     error?: {
         message: string;
         code?: string;
         statusCode?: number;
     };
+    /**
+     * 请求配置（简化版）
+     */
     requestConfig?: {
         method: string;
         url: string;
         headers: Record<string, string>;
     };
 }
+/**
+ * HTTP日志查询选项
+ */
 export interface HttpLogQueryOptions {
+    /**
+     * 请求ID
+     */
     requestId?: string;
+    /**
+     * 用户ID
+     */
     userId?: string;
+    /**
+     * HTTP方法
+     */
     method?: string | string[];
+    /**
+     * URL（支持模糊搜索）
+     */
     url?: string;
+    /**
+     * 状态码
+     */
     statusCode?: number | number[];
+    /**
+     * 是否成功
+     */
     success?: boolean;
+    /**
+     * 服务名称
+     */
     serviceName?: string;
+    /**
+     * 操作名称
+     */
     operationName?: string;
+    /**
+     * 客户端IP
+     */
     clientIp?: string;
+    /**
+     * 请求来源
+     */
     source?: string;
+    /**
+     * 标签
+     */
     tags?: string[];
+    /**
+     * 错误代码
+     */
     errorCode?: string;
+    /**
+     * 最小响应时间
+     */
     minResponseTime?: number;
+    /**
+     * 最大响应时间
+     */
     maxResponseTime?: number;
+    /**
+     * 开始时间
+     */
     startDate?: Date;
+    /**
+     * 结束时间
+     */
     endDate?: Date;
+    /**
+     * 搜索关键词
+     */
     keyword?: string;
+    /**
+     * 分页参数
+     */
     page?: number;
+    /**
+     * 每页数量
+     */
     limit?: number;
+    /**
+     * 排序字段
+     */
     sortBy?: 'createdAt' | 'responseTime' | 'statusCode' | 'url';
+    /**
+     * 排序方向
+     */
     sortOrder?: 'ASC' | 'DESC';
+    /**
+     * 是否包含详细数据
+     */
     includeDetails?: boolean;
 }
+/**
+ * HTTP日志统计结果
+ */
 export interface HttpLogStats {
+    /**
+     * 总请求数
+     */
     totalRequests: number;
+    /**
+     * 成功请求数
+     */
     successfulRequests: number;
+    /**
+     * 失败请求数
+     */
     failedRequests: number;
+    /**
+     * 成功率
+     */
     successRate: number;
+    /**
+     * 平均响应时间
+     */
     averageResponseTime: number;
+    /**
+     * 最小响应时间
+     */
     minResponseTime: number;
+    /**
+     * 最大响应时间
+     */
     maxResponseTime: number;
+    /**
+     * P50响应时间
+     */
     p50ResponseTime: number;
+    /**
+     * P95响应时间
+     */
     p95ResponseTime: number;
+    /**
+     * P99响应时间
+     */
     p99ResponseTime: number;
+    /**
+     * 按方法统计
+     */
     requestsByMethod: Record<string, number>;
+    /**
+     * 按状态码统计
+     */
     requestsByStatus: Record<string, number>;
+    /**
+     * 按服务统计
+     */
     requestsByService: Record<string, number>;
+    /**
+     * 按来源统计
+     */
     requestsBySource: Record<string, number>;
+    /**
+     * 错误统计
+     */
     errorsByCode: Record<string, number>;
+    /**
+     * 重试统计
+     */
     retryStats: {
         totalRetries: number;
         averageRetries: number;
         maxRetries: number;
         retryRate: number;
     };
-    cacheStats: {
-        cacheHits: number;
-        cacheMisses: number;
-        cacheHitRate: number;
-    };
 }

package/http-client/entities/http-log.entity.js

@@ -12,27 +12,27 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpLogEntity = void 0;
 const typeorm_1 = require("typeorm");
 const common_1 = require("../../common");
+/**
+ * HTTP请求日志实体
+ * 用于TypeORM数据库记录
+ */
 let HttpLogEntity = class HttpLogEntity extends common_1.AbstractUuidPrimaryEntity {
 };
 exports.HttpLogEntity = HttpLogEntity;
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 36, nullable: true }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "requestId", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 36, nullable: true }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "userId", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 10 }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "method", void 0);
 __decorate([
-    (0, typeorm_1.Column)({ type: 'text' }),
-    (0, typeorm_1.Index)(),
+    (0, typeorm_1.Column)({ type: 'varchar' }),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "url", void 0);
 __decorate([
@@ -49,7 +49,6 @@ __decorate([
 ], HttpLogEntity.prototype, "params", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'int', nullable: true }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", Number)
 ], HttpLogEntity.prototype, "statusCode", void 0);
 __decorate([
@@ -62,7 +61,6 @@ __decorate([
 ], HttpLogEntity.prototype, "attemptCount", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'boolean', default: false }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", Boolean)
 ], HttpLogEntity.prototype, "success", void 0);
 __decorate([
@@ -85,25 +83,17 @@ __decorate([
     (0, typeorm_1.Column)({ type: 'text', nullable: true }),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "responseBody", void 0);
-__decorate([
-    (0, typeorm_1.Column)({ type: 'int', nullable: true }),
-    __metadata("design:type", Number)
-], HttpLogEntity.prototype, "responseSize", void 0);
-__decorate([
-    (0, typeorm_1.Column)({ type: 'int', nullable: true }),
-    __metadata("design:type", Number)
-], HttpLogEntity.prototype, "requestSize", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 100, nullable: true }),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "serviceName", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 200, nullable: true }),
-    (0, typeorm_1.Index)(),
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "operationName", void 0);
 __decorate([
-    (0, typeorm_1.Column)({ type: 'varchar', length: 45, nullable: true }),
+    (0, typeorm_1.Column)({ type: 'varchar', length: 45, nullable: true }) // 支持IPv6
+    ,
     __metadata("design:type", String)
 ], HttpLogEntity.prototype, "clientIp", void 0);
 __decorate([
@@ -122,10 +112,6 @@ __decorate([
     (0, typeorm_1.Column)({ type: 'json', nullable: true }),
     __metadata("design:type", Array)
 ], HttpLogEntity.prototype, "retryRecords", void 0);
-__decorate([
-    (0, typeorm_1.Column)({ type: 'boolean', nullable: true }),
-    __metadata("design:type", Boolean)
-], HttpLogEntity.prototype, "cacheHit", void 0);
 __decorate([
     (0, typeorm_1.Column)({ type: 'varchar', length: 20, nullable: true }),
     __metadata("design:type", String)
@@ -135,7 +121,6 @@ exports.HttpLogEntity = HttpLogEntity = __decorate([
     (0, typeorm_1.Index)(['requestId']),
     (0, typeorm_1.Index)(['userId']),
     (0, typeorm_1.Index)(['method']),
-    (0, typeorm_1.Index)(['url']),
     (0, typeorm_1.Index)(['statusCode']),
     (0, typeorm_1.Index)(['success']),
     (0, typeorm_1.Index)(['createdAt']),

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

@@ -1,3 +1,6 @@
+/**
+ * HTTP客户端基础错误类
+ */
 export declare class HttpClientError extends Error {
     readonly code: string;
     readonly statusCode?: number;
@@ -5,52 +8,106 @@ export declare class HttpClientError extends Error {
     readonly config?: any;
     constructor(message: string, code?: string, statusCode?: number, response?: any, config?: any);
 }
+/**
+ * 网络错误
+ */
 export declare class NetworkError extends HttpClientError {
     constructor(message: string, config?: any);
 }
+/**
+ * 超时错误
+ */
 export declare class TimeoutError extends HttpClientError {
     constructor(message: string, config?: any);
 }
+/**
+ * 重试失败错误
+ */
 export declare class RetryExhaustedError extends HttpClientError {
     readonly attempts: number;
     readonly lastError: any;
     constructor(message: string, attempts: number, lastError: any, config?: any);
 }
+/**
+ * 熔断器开启错误
+ */
 export declare class CircuitBreakerOpenError extends HttpClientError {
     readonly circuitName: string;
     readonly failureCount: number;
     constructor(message: string, circuitName: string, failureCount: number, config?: any);
 }
+/**
+ * API认证错误
+ */
 export declare class AuthenticationError extends HttpClientError {
     constructor(message: string, statusCode?: number, response?: any, config?: any);
 }
+/**
+ * API授权错误
+ */
 export declare class AuthorizationError extends HttpClientError {
     constructor(message: string, statusCode?: number, response?: any, config?: any);
 }
+/**
+ * 限流错误
+ */
 export declare class RateLimitError extends HttpClientError {
     readonly retryAfter?: number;
     readonly limit?: number;
     readonly remaining?: number;
     constructor(message: string, statusCode?: number, response?: any, config?: any, retryAfter?: number, limit?: number, remaining?: number);
 }
+/**
+ * 服务器错误
+ */
 export declare class ServerError extends HttpClientError {
     constructor(message: string, statusCode?: number, response?: any, config?: any);
 }
+/**
+ * 响应格式错误
+ */
 export declare class ResponseFormatError extends HttpClientError {
     readonly responseData: any;
     constructor(message: string, responseData: any, config?: any);
 }
+/**
+ * API客户端配置错误
+ */
 export declare class ApiClientConfigError extends HttpClientError {
     constructor(message: string, config?: any);
 }
+/**
+ * 缓存错误
+ */
 export declare class CacheError extends HttpClientError {
     constructor(message: string, config?: any);
 }
+/**
+ * 错误工厂函数
+ */
 export declare class ErrorFactory {
+    /**
+     * 根据axios错误创建对应的HTTP客户端错误
+     */
     static fromAxiosError(error: any): HttpClientError;
+    /**
+     * 创建重试失败错误
+     */
     static createRetryExhaustedError(attempts: number, lastError: any, config?: any): RetryExhaustedError;
+    /**
+     * 创建熔断器开启错误
+     */
     static createCircuitBreakerOpenError(circuitName: string, failureCount: number, config?: any): CircuitBreakerOpenError;
+    /**
+     * 创建响应格式错误
+     */
     static createResponseFormatError(message: string, responseData: any, config?: any): ResponseFormatError;
+    /**
+     * 创建API客户端配置错误
+     */
     static createApiClientConfigError(message: string, config?: any): ApiClientConfigError;
+    /**
+     * 创建缓存错误
+     */
     static createCacheError(message: string, config?: any): CacheError;
 }

package/http-client/errors/http-client.errors.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorFactory = exports.CacheError = exports.ApiClientConfigError = exports.ResponseFormatError = exports.ServerError = exports.RateLimitError = exports.AuthorizationError = exports.AuthenticationError = exports.CircuitBreakerOpenError = exports.RetryExhaustedError = exports.TimeoutError = exports.NetworkError = exports.HttpClientError = void 0;
+/**
+ * HTTP客户端基础错误类
+ */
 class HttpClientError extends Error {
     constructor(message, code = 'HTTP_CLIENT_ERROR', statusCode, response, config) {
         super(message);
@@ -13,6 +16,9 @@ class HttpClientError extends Error {
     }
 }
 exports.HttpClientError = HttpClientError;
+/**
+ * 网络错误
+ */
 class NetworkError extends HttpClientError {
     constructor(message, config) {
         super(message, 'NETWORK_ERROR', undefined, undefined, config);
@@ -20,6 +26,9 @@ class NetworkError extends HttpClientError {
     }
 }
 exports.NetworkError = NetworkError;
+/**
+ * 超时错误
+ */
 class TimeoutError extends HttpClientError {
     constructor(message, config) {
         super(message, 'TIMEOUT_ERROR', undefined, undefined, config);
@@ -27,6 +36,9 @@ class TimeoutError extends HttpClientError {
     }
 }
 exports.TimeoutError = TimeoutError;
+/**
+ * 重试失败错误
+ */
 class RetryExhaustedError extends HttpClientError {
     constructor(message, attempts, lastError, config) {
         super(message, 'RETRY_EXHAUSTED', undefined, undefined, config);
@@ -36,6 +48,9 @@ class RetryExhaustedError extends HttpClientError {
     }
 }
 exports.RetryExhaustedError = RetryExhaustedError;
+/**
+ * 熔断器开启错误
+ */
 class CircuitBreakerOpenError extends HttpClientError {
     constructor(message, circuitName, failureCount, config) {
         super(message, 'CIRCUIT_BREAKER_OPEN', 503, undefined, config);
@@ -45,6 +60,9 @@ class CircuitBreakerOpenError extends HttpClientError {
     }
 }
 exports.CircuitBreakerOpenError = CircuitBreakerOpenError;
+/**
+ * API认证错误
+ */
 class AuthenticationError extends HttpClientError {
     constructor(message, statusCode = 401, response, config) {
         super(message, 'AUTHENTICATION_ERROR', statusCode, response, config);
@@ -52,6 +70,9 @@ class AuthenticationError extends HttpClientError {
     }
 }
 exports.AuthenticationError = AuthenticationError;
+/**
+ * API授权错误
+ */
 class AuthorizationError extends HttpClientError {
     constructor(message, statusCode = 403, response, config) {
         super(message, 'AUTHORIZATION_ERROR', statusCode, response, config);
@@ -59,6 +80,9 @@ class AuthorizationError extends HttpClientError {
     }
 }
 exports.AuthorizationError = AuthorizationError;
+/**
+ * 限流错误
+ */
 class RateLimitError extends HttpClientError {
     constructor(message, statusCode = 429, response, config, retryAfter, limit, remaining) {
         super(message, 'RATE_LIMIT_ERROR', statusCode, response, config);
@@ -69,6 +93,9 @@ class RateLimitError extends HttpClientError {
     }
 }
 exports.RateLimitError = RateLimitError;
+/**
+ * 服务器错误
+ */
 class ServerError extends HttpClientError {
     constructor(message, statusCode = 500, response, config) {
         super(message, 'SERVER_ERROR', statusCode, response, config);
@@ -76,6 +103,9 @@ class ServerError extends HttpClientError {
     }
 }
 exports.ServerError = ServerError;
+/**
+ * 响应格式错误
+ */
 class ResponseFormatError extends HttpClientError {
     constructor(message, responseData, config) {
         super(message, 'RESPONSE_FORMAT_ERROR', undefined, undefined, config);
@@ -84,6 +114,9 @@ class ResponseFormatError extends HttpClientError {
     }
 }
 exports.ResponseFormatError = ResponseFormatError;
+/**
+ * API客户端配置错误
+ */
 class ApiClientConfigError extends HttpClientError {
     constructor(message, config) {
         super(message, 'API_CLIENT_CONFIG_ERROR', 500, undefined, config);
@@ -91,6 +124,9 @@ class ApiClientConfigError extends HttpClientError {
     }
 }
 exports.ApiClientConfigError = ApiClientConfigError;
+/**
+ * 缓存错误
+ */
 class CacheError extends HttpClientError {
     constructor(message, config) {
         super(message, 'CACHE_ERROR', undefined, undefined, config);
@@ -98,11 +134,18 @@ class CacheError extends HttpClientError {
     }
 }
 exports.CacheError = CacheError;
+/**
+ * 错误工厂函数
+ */
 class ErrorFactory {
+    /**
+     * 根据axios错误创建对应的HTTP客户端错误
+     */
     static fromAxiosError(error) {
         const config = error.config;
         const response = error.response;
         const message = error.message || 'Unknown error';
+        // 网络错误
         if (!error.response) {
             if (error.code === 'ECONNABORTED') {
                 return new TimeoutError(`Request timeout: ${message}`, config);
@@ -130,18 +173,33 @@ class ErrorFactory {
                 return new HttpClientError((responseData === null || responseData === void 0 ? void 0 : responseData.message) || `HTTP error (${statusCode})`, 'HTTP_ERROR', statusCode, response, config);
         }
     }
+    /**
+     * 创建重试失败错误
+     */
     static createRetryExhaustedError(attempts, lastError, config) {
         return new RetryExhaustedError(`Retry failed after ${attempts} attempts. Last error: ${lastError.message}`, attempts, lastError, config);
     }
+    /**
+     * 创建熔断器开启错误
+     */
     static createCircuitBreakerOpenError(circuitName, failureCount, config) {
         return new CircuitBreakerOpenError(`Circuit breaker '${circuitName}' is open after ${failureCount} failures`, circuitName, failureCount, config);
     }
+    /**
+     * 创建响应格式错误
+     */
     static createResponseFormatError(message, responseData, config) {
         return new ResponseFormatError(message, responseData, config);
     }
+    /**
+     * 创建API客户端配置错误
+     */
     static createApiClientConfigError(message, config) {
         return new ApiClientConfigError(message, config);
     }
+    /**
+     * 创建缓存错误
+     */
     static createCacheError(message, config) {
         return new CacheError(message, config);
     }