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

package/http-client/examples/axios-config-extended.example.js

@@ -0,0 +1,313 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.httpAgentExample = httpAgentExample;
+exports.redirectAndValidationExample = redirectAndValidationExample;
+exports.responseTypeExample = responseTypeExample;
+exports.sizeAndRateLimitExample = sizeAndRateLimitExample;
+exports.paramsSerializationExample = paramsSerializationExample;
+exports.formSerializationExample = formSerializationExample;
+exports.securityOptionsExample = securityOptionsExample;
+exports.abortControllerExample = abortControllerExample;
+exports.transitionalOptionsExample = transitionalOptionsExample;
+exports.progressEventsExample = progressEventsExample;
+exports.comprehensiveConfigExample = comprehensiveConfigExample;
+exports.environmentSpecificConfig = environmentSpecificConfig;
+const http_1 = require("http");
+const https_1 = require("https");
+/**
+ * axiosConfig 透传配置示例
+ * 展示如何通过 axiosConfig 直接传递 Axios 原生配置
+ */
+// ============================================================================
+// 示例 1: 使用 httpAgent 和 httpsAgent 启用连接池
+// ============================================================================
+function httpAgentExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        timeout: 30000,
+        // 通过 axiosConfig 透传 Axios 原生配置
+        axiosConfig: {
+            // 启用 HTTP keep-alive 连接池
+            httpAgent: new http_1.Agent({
+                keepAlive: true,
+                keepAliveMsecs: 1000,
+                maxSockets: 50,
+                maxFreeSockets: 10,
+                timeout: 60000,
+            }),
+            // 启用 HTTPS keep-alive 连接池
+            httpsAgent: new https_1.Agent({
+                keepAlive: true,
+                keepAliveMsecs: 1000,
+                maxSockets: 50,
+                maxFreeSockets: 10,
+                timeout: 60000,
+                // 可选：跳过证书验证（不推荐用于生产环境）
+                rejectUnauthorized: true,
+            }),
+        },
+    };
+    // 创建 HttpClientService 实例...
+}
+// ============================================================================
+// 示例 2: 配置重定向和响应验证
+// ============================================================================
+function redirectAndValidationExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            // 禁止自动跟随重定向
+            maxRedirects: 0,
+            // 或者限制重定向次数
+            // maxRedirects: 5,
+            // 自定义状态码验证逻辑
+            validateStatus: (status) => {
+                // 将 400-499 视为成功（不抛出异常）
+                return status >= 200 && status < 500;
+            },
+            // 重定向前回调
+            beforeRedirect: (options, { headers }) => {
+                // 可以在这里修改重定向请求
+                if (options.hostname === 'restricted.com') {
+                    throw new Error('Redirect to restricted domain not allowed');
+                }
+            },
+        },
+    };
+}
+// ============================================================================
+// 示例 3: 配置响应类型和数据转换
+// ============================================================================
+function responseTypeExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            // 指定响应类型
+            responseType: 'arraybuffer', // 'arraybuffer' | 'document' | 'json' | 'text' | 'stream' | 'blob'
+            responseEncoding: 'utf8',
+            // 自定义请求/响应转换器
+            transformRequest: [
+                (data, headers) => {
+                    // 在发送前修改数据
+                    if (typeof data === 'object') {
+                        // 自动添加时间戳
+                        data.timestamp = Date.now();
+                    }
+                    return JSON.stringify(data);
+                },
+                ...require('axios').defaults.transformRequest,
+            ],
+            transformResponse: [
+                (data) => {
+                    // 在接收后修改数据
+                    if (typeof data === 'string') {
+                        try {
+                            const parsed = JSON.parse(data);
+                            // 统一处理响应格式
+                            return parsed.data || parsed;
+                        }
+                        catch (_a) {
+                            return data;
+                        }
+                    }
+                    return data;
+                },
+                ...require('axios').defaults.transformResponse,
+            ],
+        },
+    };
+}
+// ============================================================================
+// 示例 4: 配置大小限制和速率限制
+// ============================================================================
+function sizeAndRateLimitExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            // 响应体大小限制（字节）
+            maxContentLength: 10 * 1024 * 1024, // 10MB
+            // 请求体大小限制（字节）
+            maxBodyLength: 5 * 1024 * 1024, // 5MB
+            // 速率限制 [上传 B/s, 下载 B/s]
+            maxRate: [1024 * 1024, 2 * 1024 * 1024], // 上传 1MB/s, 下载 2MB/s
+        },
+    };
+}
+// ============================================================================
+// 示例 5: 配置参数序列化
+// ============================================================================
+function paramsSerializationExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            paramsSerializer: {
+                // 自定义编码函数
+                encode: (param) => {
+                    return encodeURIComponent(param)
+                        .replace(/%40/gi, '@')
+                        .replace(/%3A/gi, ':')
+                        .replace(/%24/g, '$')
+                        .replace(/%2C/gi, ',')
+                        .replace(/%20/g, '+');
+                },
+                // 数组索引格式
+                indexes: true, // true=a[0]=b, false=a[]=b, null=a=b
+            },
+        },
+    };
+}
+// ============================================================================
+// 示例 6: 配置表单序列化
+// ============================================================================
+function formSerializationExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            formSerializer: {
+                // 自定义访问器
+                visitor: (value, key, path) => {
+                    // 自定义值转换逻辑
+                    if (value instanceof Date) {
+                        return value.toISOString();
+                    }
+                    return value;
+                },
+                // 使用点符号而不是括号
+                dots: true,
+                // 保留特殊结尾（如 {}）
+                metaTokens: true,
+                // 数组索引格式
+                indexes: true,
+            },
+        },
+    };
+}
+// ============================================================================
+// 示例 7: 配置安全选项
+// ============================================================================
+function securityOptionsExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            // 是否允许绝对 URL 覆盖 baseURL
+            allowAbsoluteUrls: true,
+            // 跨域请求是否携带凭证
+            withCredentials: true,
+            // 禁用自动解压
+            decompress: false,
+            // 使用不安全的 HTTP 解析器（允许无效的 HTTP 头）
+            // 警告：仅在与非标准 HTTP 实现交互时使用
+            insecureHTTPParser: false,
+        },
+    };
+}
+// ============================================================================
+// 示例 8: 使用 AbortSignal 取消请求
+// ============================================================================
+function abortControllerExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+        // 可以在每次请求时动态设置
+        // signal: new AbortController().signal,
+        },
+    };
+    // 使用示例：
+    // const abortController = new AbortController();
+    // config.axiosConfig!.signal = abortController.signal;
+    //
+    // setTimeout(() => abortController.abort(), 5000); // 5秒后取消
+}
+// ============================================================================
+// 示例 9: 向后兼容选项
+// ============================================================================
+function transitionalOptionsExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            transitional: {
+                // 静默 JSON 解析错误（旧行为）
+                silentJSONParsing: false,
+                // 即使 responseType 不是 'json' 也尝试解析
+                forcedJSONParsing: true,
+                // 超时时抛出明确的 ETIMEDOUT 错误
+                clarifyTimeoutError: true,
+            },
+        },
+    };
+}
+// ============================================================================
+// 示例 10: 进度事件（浏览器环境）
+// ============================================================================
+function progressEventsExample() {
+    const config = {
+        baseURL: 'https://api.example.com',
+        axiosConfig: {
+            // 上传进度
+            onUploadProgress: (progressEvent) => {
+                const percentCompleted = Math.round((progressEvent.loaded * 100) / (progressEvent.total || 1));
+                console.log(`Upload ${percentCompleted}%`);
+            },
+            // 下载进度
+            onDownloadProgress: (progressEvent) => {
+                const percentCompleted = Math.round((progressEvent.loaded * 100) / (progressEvent.total || 1));
+                console.log(`Download ${percentCompleted}%`);
+            },
+        },
+    };
+}
+// ============================================================================
+// 示例 11: 综合配置
+// ============================================================================
+function comprehensiveConfigExample() {
+    const config = {
+        // 显式配置（优先级高）
+        baseURL: 'https://api.example.com',
+        timeout: 30000,
+        // 内置功能配置
+        retry: {
+            enabled: true,
+            retries: 3,
+        },
+        circuitBreaker: {
+            enabled: true,
+            failureThreshold: 5,
+        },
+        logging: {
+            enabled: true,
+            logLevel: 'info',
+        },
+        // Axios 原生配置透传（优先级低，会被显式配置覆盖）
+        axiosConfig: {
+            httpAgent: new http_1.Agent({ keepAlive: true }),
+            httpsAgent: new https_1.Agent({ keepAlive: true }),
+            maxRedirects: 5,
+            responseType: 'json',
+            validateStatus: (status) => status >= 200 && status < 300,
+            maxContentLength: 10 * 1024 * 1024,
+        },
+    };
+    return config;
+}
+// ============================================================================
+// 示例 12: 环境相关的配置
+// ============================================================================
+function environmentSpecificConfig() {
+    const isDevelopment = process.env.NODE_ENV === 'development';
+    const config = {
+        baseURL: isDevelopment
+            ? 'https://dev-api.example.com'
+            : 'https://api.example.com',
+        axiosConfig: {
+            // 开发环境使用更宽松的验证
+            validateStatus: isDevelopment
+                ? (status) => status >= 200 && status < 500
+                : (status) => status >= 200 && status < 300,
+            // 开发环境禁用 keep-alive 以便调试
+            httpAgent: isDevelopment
+                ? undefined
+                : new http_1.Agent({ keepAlive: true }),
+        },
+    };
+    return config;
+}

package/http-client/examples/index.d.ts

@@ -1,3 +1,5 @@
 export * from './basic-usage.example';
 export * from './advanced-usage.example';
 export * from './multi-api-configuration.example';
+export * from './axios-config-extended.example';
+export * from './ssl-certificate.example';

package/http-client/examples/index.js

@@ -17,3 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./basic-usage.example"), exports);
 __exportStar(require("./advanced-usage.example"), exports);
 __exportStar(require("./multi-api-configuration.example"), exports);
+__exportStar(require("./axios-config-extended.example"), exports);
+__exportStar(require("./ssl-certificate.example"), exports);

package/http-client/examples/ssl-certificate.example.d.ts

@@ -0,0 +1,47 @@
+import { HttpClientConfig } from '../index';
+/**
+ * SSL/TLS 证书配置示例
+ * 解决自签名证书、客户端证书认证等问题
+ */
+export declare function disableSslVerificationExample(): void;
+export declare function selfSignedCaExample(): HttpClientConfig;
+export declare function multipleCaCertsExample(): HttpClientConfig;
+export declare function clientCertificateExample(): HttpClientConfig;
+export declare function tlsVersionAndCiphersExample(): HttpClientConfig;
+export declare function certFromEnvExample(): HttpClientConfig;
+export declare function productionSslConfigExample(): HttpClientConfig;
+export declare function environmentBasedSslConfig(): HttpClientConfig;
+export declare function handleCertExpirationExample(): HttpClientConfig;
+export declare function directHttpsAgentExample(): HttpClientConfig;
+export declare function sslErrorHandlingExample(): Promise<void>;
+export declare class DynamicCertificateManager {
+    private circuitBreakerService;
+    private loggingService;
+    private certPaths;
+    private httpClient;
+    private certCache;
+    private lastUpdate;
+    private cacheDuration;
+    constructor(circuitBreakerService: any, loggingService: any, certPaths: {
+        ca?: string;
+        cert?: string;
+        key?: string;
+    });
+    private loadCerts;
+    private buildConfig;
+    refreshCerts(): Promise<void>;
+    get(url: string): Promise<void>;
+}
+export declare const sslEnvVars: {
+    SSL_CA_PATH: string;
+    SSL_CLIENT_CERT_PATH: string;
+    SSL_CLIENT_KEY_PATH: string;
+    SSL_PASSPHRASE: string;
+    SSL_REJECT_UNAUTHORIZED: string;
+    SSL_MIN_VERSION: string;
+    SSL_CIPHERS: string;
+    SSL_CA_CERT: string;
+    SSL_CLIENT_CERT: string;
+    SSL_CLIENT_KEY: string;
+};
+export declare function diagnoseSslConfig(apiUrl: string): Promise<unknown>;