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

package/http-client/examples/basic-usage.example.d.ts

@@ -1,19 +1,55 @@
 import { HttpClientService, HttpLogQueryService } from '../services';
 import { HttpLogQueryOptions } from '../entities';
+/**
+ * 基本使用示例
+ */
 export declare class BasicHttpExample {
     private readonly httpClient;
     private readonly logQueryService;
     constructor(httpClient: HttpClientService, logQueryService: HttpLogQueryService);
+    /**
+     * 简单GET请求
+     */
     getUser(id: string): Promise<any>;
+    /**
+     * 带参数的GET请求
+     */
     searchUsers(query: string, page?: number, limit?: number): Promise<any>;
+    /**
+     * POST请求
+     */
     createUser(userData: any): Promise<any>;
+    /**
+     * PUT请求
+     */
     updateUser(id: string, userData: any): Promise<any>;
+    /**
+     * DELETE请求
+     */
     deleteUser(id: string): Promise<any>;
+    /**
+     * 文件上传
+     */
     uploadFile(file: Buffer, filename: string): Promise<any>;
+    /**
+     * 自定义请求配置
+     */
     customRequest(): Promise<any>;
+    /**
+     * 获取统计信息
+     */
     getStatistics(): any;
+    /**
+     * 重置统计信息
+     */
     resetStatistics(): void;
+    /**
+     * 生成curl命令
+     */
     generateCurlForRequest(url: string, method?: string, data?: any): string;
+    /**
+     * 查询HTTP日志
+     */
     queryHttpLogs(options?: HttpLogQueryOptions): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -21,18 +57,30 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 查询错误日志
+     */
     findErrorLogs(limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 查询慢请求
+     */
     findSlowRequests(minResponseTime?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 查询重试日志
+     */
     findRetryLogs(minRetries?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
     }>;
+    /**
+     * 根据服务名称查询日志
+     */
     findLogsByServiceName(serviceName: string, limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -40,6 +88,9 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 根据操作名称查询日志
+     */
     findLogsByOperationName(operationName: string, limit?: number): Promise<{
         logs: import("../entities").HttpLogEntity[];
         total: number;
@@ -47,7 +98,16 @@ export declare class BasicHttpExample {
         limit: number;
         totalPages: number;
     }>;
+    /**
+     * 获取HTTP统计信息
+     */
     getHttpStats(startDate?: Date, endDate?: Date): Promise<import("../entities").HttpLogStats>;
+    /**
+     * 根据请求ID查询日志
+     */
     findLogByRequestId(requestId: string): Promise<import("../entities").HttpLogEntity>;
+    /**
+     * 清理旧日志
+     */
     cleanupOldLogs(daysToKeep?: number): Promise<number>;
 }

package/http-client/examples/basic-usage.example.js

@@ -21,16 +21,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.BasicHttpExample = void 0;
 const common_1 = require("@nestjs/common");
 const services_1 = require("../services");
+/**
+ * 基本使用示例
+ */
 let BasicHttpExample = class BasicHttpExample {
     constructor(httpClient, logQueryService) {
         this.httpClient = httpClient;
         this.logQueryService = logQueryService;
     }
+    /**
+     * 简单GET请求
+     */
     getUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.get(`/users/${id}`);
         });
     }
+    /**
+     * 带参数的GET请求
+     */
     searchUsers(query_1) {
         return __awaiter(this, arguments, void 0, function* (query, page = 1, limit = 10) {
             return this.httpClient.get('/users', {
@@ -42,6 +51,9 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * POST请求
+     */
     createUser(userData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.post('/users', userData, {
@@ -51,16 +63,25 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * PUT请求
+     */
     updateUser(id, userData) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.put(`/users/${id}`, userData);
         });
     }
+    /**
+     * DELETE请求
+     */
     deleteUser(id) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.delete(`/users/${id}`);
         });
     }
+    /**
+     * 文件上传
+     */
     uploadFile(file, filename) {
         return __awaiter(this, void 0, void 0, function* () {
             const formData = new FormData();
@@ -72,6 +93,9 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * 自定义请求配置
+     */
     customRequest() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.httpClient.request({
@@ -89,12 +113,21 @@ let BasicHttpExample = class BasicHttpExample {
             });
         });
     }
+    /**
+     * 获取统计信息
+     */
     getStatistics() {
         return this.httpClient.getStats();
     }
+    /**
+     * 重置统计信息
+     */
     resetStatistics() {
         this.httpClient.resetStats();
     }
+    /**
+     * 生成curl命令
+     */
     generateCurlForRequest(url, method = 'GET', data) {
         const config = {
             url,
@@ -107,46 +140,73 @@ let BasicHttpExample = class BasicHttpExample {
         };
         return this.httpClient.generateCurlCommand(config);
     }
+    /**
+     * 查询HTTP日志
+     */
     queryHttpLogs() {
         return __awaiter(this, arguments, void 0, function* (options = {}) {
             return this.logQueryService.findLogs(options);
         });
     }
+    /**
+     * 查询错误日志
+     */
     findErrorLogs() {
         return __awaiter(this, arguments, void 0, function* (limit = 10) {
             return this.logQueryService.findErrorLogs({ limit });
         });
     }
+    /**
+     * 查询慢请求
+     */
     findSlowRequests() {
         return __awaiter(this, arguments, void 0, function* (minResponseTime = 5000) {
             return this.logQueryService.findSlowRequests(minResponseTime);
         });
     }
+    /**
+     * 查询重试日志
+     */
     findRetryLogs() {
         return __awaiter(this, arguments, void 0, function* (minRetries = 2) {
             return this.logQueryService.findRetryLogs({ minRetries });
         });
     }
+    /**
+     * 根据服务名称查询日志
+     */
     findLogsByServiceName(serviceName_1) {
         return __awaiter(this, arguments, void 0, function* (serviceName, limit = 20) {
             return this.logQueryService.findLogs({ serviceName, limit });
         });
     }
+    /**
+     * 根据操作名称查询日志
+     */
     findLogsByOperationName(operationName_1) {
         return __awaiter(this, arguments, void 0, function* (operationName, limit = 20) {
             return this.logQueryService.findLogs({ operationName, limit });
         });
     }
+    /**
+     * 获取HTTP统计信息
+     */
     getHttpStats(startDate, endDate) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.logQueryService.getStats({ startDate, endDate });
         });
     }
+    /**
+     * 根据请求ID查询日志
+     */
     findLogByRequestId(requestId) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.logQueryService.findLogByRequestId(requestId);
         });
     }
+    /**
+     * 清理旧日志
+     */
     cleanupOldLogs() {
         return __awaiter(this, arguments, void 0, function* (daysToKeep = 30) {
             return this.logQueryService.deleteOldLogs(daysToKeep);

package/http-client/examples/multi-api-configuration.example.d.ts

@@ -1,10 +1,19 @@
 import { ApiClientInstanceConfig, ApiClientRegistryService } from '../services/api-client-registry.service';
+/**
+ * GitHub API 客户端示例
+ */
 export declare class GitHubApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
+    /**
+     * 获取GitHub客户端
+     */
     get github(): GitHubApiClient;
     private initializeClients;
 }
+/**
+ * GitHub API 类型定义
+ */
 export interface GitHubApiClient {
     get<T = any>(url: string, config?: any): Promise<T>;
     post<T = any>(url: string, data?: any, config?: any): Promise<T>;
@@ -14,6 +23,9 @@ export interface GitHubApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * Stripe API 客户端示例
+ */
 export declare class StripeApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -27,6 +39,9 @@ export interface StripeApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * 微信API客户端示例
+ */
 export declare class WeChatApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -40,6 +55,9 @@ export interface WeChatApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * 自定义API客户端示例（复杂响应格式）
+ */
 export declare class CustomApiService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
@@ -59,12 +77,27 @@ export interface CustomApiClient {
     getStats(): any;
     resetStats(): void;
 }
+/**
+ * API管理服务示例
+ */
 export declare class ApiManagementService {
     private readonly apiRegistry;
     constructor(apiRegistry: ApiClientRegistryService);
+    /**
+     * 动态创建API客户端
+     */
     createDynamicClient(name: string, config: Partial<ApiClientInstanceConfig>): any;
+    /**
+     * 获取所有客户端统计信息
+     */
     getAllStats(): Record<string, any>;
+    /**
+     * 重置所有统计信息
+     */
     resetAllStats(): void;
+    /**
+     * 健康检查
+     */
     healthCheck(): Promise<{
         status: "healthy" | "unhealthy";
         clients: Record<string, {
@@ -72,9 +105,18 @@ export declare class ApiManagementService {
             error?: string;
         }>;
     }>;
+    /**
+     * 批量创建客户端
+     */
     createMultipleClients(configs: ApiClientInstanceConfig[]): void;
+    /**
+     * 获取客户端列表
+     */
     listClients(): string[];
 }
+/**
+ * 使用示例控制器
+ */
 export declare class ExampleController {
     private readonly githubApi;
     private readonly stripeApi;
@@ -82,11 +124,29 @@ export declare class ExampleController {
     private readonly customApi;
     private readonly apiManagement;
     constructor(githubApi: GitHubApiService, stripeApi: StripeApiService, wechatApi: WeChatApiService, customApi: CustomApiService, apiManagement: ApiManagementService);
+    /**
+     * GitHub API 示例
+     */
     getGitHubUser(username: string): Promise<any>;
+    /**
+     * Stripe API 示例
+     */
     createStripePayment(amount: number, currency: string): Promise<any>;
+    /**
+     * 微信 API 示例
+     */
     sendWeChatMessage(openid: string, content: string): Promise<any>;
+    /**
+     * 自定义API 示例
+     */
     getCustomData(id: string): Promise<any>;
+    /**
+     * 动态API示例
+     */
     callDynamicApi(url: string): Promise<any>;
+    /**
+     * API管理示例
+     */
     getApiHealth(): Promise<{
         status: "healthy" | "unhealthy";
         clients: Record<string, {

package/http-client/examples/multi-api-configuration.example.js

@@ -21,11 +21,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExampleController = exports.ApiManagementService = exports.CustomApiService = exports.WeChatApiService = exports.StripeApiService = exports.GitHubApiService = void 0;
 const common_1 = require("@nestjs/common");
 const api_client_registry_service_1 = require("../services/api-client-registry.service");
+/**
+ * GitHub API 客户端示例
+ */
 let GitHubApiService = class GitHubApiService {
     constructor(apiRegistry) {
         this.apiRegistry = apiRegistry;
         this.initializeClients();
     }
+    /**
+     * 获取GitHub客户端
+     */
     get github() {
         return this.apiRegistry.getClient('github');
     }
@@ -40,10 +46,11 @@ let GitHubApiService = class GitHubApiService {
                 },
             },
             responseTransformer: {
-                dataPath: 'data',
+                dataPath: 'data', // GitHub API通常返回 { data: [...] }
                 success: (response) => response.data,
                 error: (error) => {
                     var _a, _b;
+                    // GitHub API 错误处理
                     if ((_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.message) {
                         throw new Error(`GitHub API Error: ${error.response.data.message}`);
                     }
@@ -55,10 +62,11 @@ let GitHubApiService = class GitHubApiService {
                 retries: 3,
                 retryCondition: (error) => {
                     var _a, _b;
+                    // GitHub API 速率限制时重试
                     return (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 403 || ((_b = error.response) === null || _b === void 0 ? void 0 : _b.status) === 429);
                 },
             },
-            responseTimeWarningThreshold: 2000,
+            responseTimeWarningThreshold: 2000, // 2秒警告
             tags: ['github', 'vcs'],
         });
     }
@@ -68,6 +76,9 @@ exports.GitHubApiService = GitHubApiService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [api_client_registry_service_1.ApiClientRegistryService])
 ], GitHubApiService);
+/**
+ * Stripe API 客户端示例
+ */
 let StripeApiService = class StripeApiService {
     constructor(apiRegistry) {
         this.apiRegistry = apiRegistry;
@@ -94,13 +105,14 @@ let StripeApiService = class StripeApiService {
                 dataPath: 'data',
                 error: (error) => {
                     var _a, _b, _c;
+                    // Stripe API 错误处理
                     if ((_c = (_b = (_a = error.response) === null || _a === void 0 ? void 0 : _a.data) === null || _b === void 0 ? void 0 : _b.error) === null || _c === void 0 ? void 0 : _c.message) {
                         throw new Error(`Stripe API Error: ${error.response.data.error.message}`);
                     }
                     throw error;
                 },
             },
-            responseTimeWarningThreshold: 3000,
+            responseTimeWarningThreshold: 3000, // 3秒警告
             tags: ['stripe', 'payment'],
         });
     }
@@ -110,6 +122,9 @@ exports.StripeApiService = StripeApiService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [api_client_registry_service_1.ApiClientRegistryService])
 ], StripeApiService);
+/**
+ * 微信API客户端示例
+ */
 let WeChatApiService = class WeChatApiService {
     constructor(apiRegistry) {
         this.apiRegistry = apiRegistry;
@@ -123,10 +138,11 @@ let WeChatApiService = class WeChatApiService {
             name: 'wechat',
             baseURL: 'https://api.weixin.qq.com',
             auth: {
-                type: api_client_registry_service_1.AuthType.NONE,
+                type: api_client_registry_service_1.AuthType.NONE, // 微信API通常使用签名验证
             },
             responseTransformer: {
                 success: (response) => {
+                    // 微信API响应格式: { errcode: 0, errmsg: 'success', data: {...} }
                     if (response.data.errcode !== 0) {
                         throw new Error(`WeChat API Error (${response.data.errcode}): ${response.data.errmsg}`);
                     }
@@ -136,7 +152,7 @@ let WeChatApiService = class WeChatApiService {
             tags: ['wechat', 'social'],
             environments: {
                 development: {
-                    baseURL: 'https://api.tunnel.com/wechat',
+                    baseURL: 'https://api.tunnel.com/wechat', // 开发环境使用隧道
                 },
             },
         });
@@ -147,6 +163,9 @@ exports.WeChatApiService = WeChatApiService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [api_client_registry_service_1.ApiClientRegistryService])
 ], WeChatApiService);
+/**
+ * 自定义API客户端示例（复杂响应格式）
+ */
 let CustomApiService = class CustomApiService {
     constructor(apiRegistry) {
         this.apiRegistry = apiRegistry;
@@ -164,6 +183,7 @@ let CustomApiService = class CustomApiService {
                 config: {
                     authenticator(config) {
                         return __awaiter(this, void 0, void 0, function* () {
+                            // 自定义JWT token刷新逻辑
                             const token = yield this.getValidToken();
                             config.headers = Object.assign(Object.assign({}, config.headers), { Authorization: `Bearer ${token}`, 'X-Timestamp': Date.now().toString(), 'X-Signature': this.generateSignature(config) });
                             return config;
@@ -172,6 +192,7 @@ let CustomApiService = class CustomApiService {
                     refresher(config, error) {
                         return __awaiter(this, void 0, void 0, function* () {
                             var _a;
+                            // Token过期时自动刷新
                             if (((_a = error.response) === null || _a === void 0 ? void 0 : _a.status) === 401) {
                                 const newToken = yield this.refreshToken();
                                 config.headers['Authorization'] = `Bearer ${newToken}`;
@@ -184,10 +205,13 @@ let CustomApiService = class CustomApiService {
             },
             responseTransformer: {
                 success: (response) => {
+                    // 复杂响应格式处理
                     const result = response.data;
+                    // 统一成功格式
                     if (result.success === false) {
                         throw new Error(result.message || 'API request failed');
                     }
+                    // 数据包装处理
                     return {
                         data: result.data || result,
                         code: result.code || 0,
@@ -198,6 +222,7 @@ let CustomApiService = class CustomApiService {
                 },
                 error: (error) => {
                     var _a;
+                    // 统一错误格式
                     if ((_a = error.response) === null || _a === void 0 ? void 0 : _a.data) {
                         const errorData = error.response.data;
                         const customError = new Error(errorData.message || 'API request failed');
@@ -216,6 +241,7 @@ let CustomApiService = class CustomApiService {
                 enabled: true,
                 retries: 2,
                 retryCondition: (error) => {
+                    // 只对网络错误和5xx错误重试
                     if (!error.response)
                         return true;
                     return error.response.status >= 500;
@@ -226,15 +252,18 @@ let CustomApiService = class CustomApiService {
     }
     getValidToken() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 实现token获取逻辑
             return 'mock-jwt-token';
         });
     }
     refreshToken() {
         return __awaiter(this, void 0, void 0, function* () {
+            // 实现token刷新逻辑
             return 'refreshed-jwt-token';
         });
     }
     generateSignature(config) {
+        // 实现签名生成逻辑
         return 'mock-signature';
     }
 };
@@ -243,27 +272,48 @@ exports.CustomApiService = CustomApiService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [api_client_registry_service_1.ApiClientRegistryService])
 ], CustomApiService);
+/**
+ * API管理服务示例
+ */
 let ApiManagementService = class ApiManagementService {
     constructor(apiRegistry) {
         this.apiRegistry = apiRegistry;
     }
+    /**
+     * 动态创建API客户端
+     */
     createDynamicClient(name, config) {
         return this.apiRegistry.createClient(Object.assign({ name, baseURL: config.baseURL || '' }, config));
     }
+    /**
+     * 获取所有客户端统计信息
+     */
     getAllStats() {
         return this.apiRegistry.getAllStats();
     }
+    /**
+     * 重置所有统计信息
+     */
     resetAllStats() {
         this.apiRegistry.resetAllStats();
     }
+    /**
+     * 健康检查
+     */
     healthCheck() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.apiRegistry.healthCheck();
         });
     }
+    /**
+     * 批量创建客户端
+     */
     createMultipleClients(configs) {
         this.apiRegistry.createClients(configs);
     }
+    /**
+     * 获取客户端列表
+     */
     listClients() {
         return this.apiRegistry.listClients();
     }
@@ -273,6 +323,9 @@ exports.ApiManagementService = ApiManagementService = __decorate([
     (0, common_1.Injectable)(),
     __metadata("design:paramtypes", [api_client_registry_service_1.ApiClientRegistryService])
 ], ApiManagementService);
+/**
+ * 使用示例控制器
+ */
 let ExampleController = class ExampleController {
     constructor(githubApi, stripeApi, wechatApi, customApi, apiManagement) {
         this.githubApi = githubApi;
@@ -281,12 +334,18 @@ let ExampleController = class ExampleController {
         this.customApi = customApi;
         this.apiManagement = apiManagement;
     }
+    /**
+     * GitHub API 示例
+     */
     getGitHubUser(username) {
         return __awaiter(this, void 0, void 0, function* () {
             const github = this.githubApi.github;
             return github.get(`/users/${username}`);
         });
     }
+    /**
+     * Stripe API 示例
+     */
     createStripePayment(amount, currency) {
         return __awaiter(this, void 0, void 0, function* () {
             const stripe = this.stripeApi.stripe;
@@ -297,6 +356,9 @@ let ExampleController = class ExampleController {
             });
         });
     }
+    /**
+     * 微信 API 示例
+     */
     sendWeChatMessage(openid, content) {
         return __awaiter(this, void 0, void 0, function* () {
             const wechat = this.wechatApi.wechat;
@@ -309,12 +371,18 @@ let ExampleController = class ExampleController {
             });
         });
     }
+    /**
+     * 自定义API 示例
+     */
     getCustomData(id) {
         return __awaiter(this, void 0, void 0, function* () {
             const custom = this.customApi.customApi;
             return custom.get(`/data/${id}`);
         });
     }
+    /**
+     * 动态API示例
+     */
     callDynamicApi(url) {
         return __awaiter(this, void 0, void 0, function* () {
             const client = this.apiManagement.createDynamicClient('dynamic', {
@@ -331,6 +399,9 @@ let ExampleController = class ExampleController {
             return client.get('/');
         });
     }
+    /**
+     * API管理示例
+     */
     getApiHealth() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.apiManagement.healthCheck();