@be-link/shield-for-tcb-node-sdk 1.0.7 → 1.0.9

package/index.d.ts

@@ -2,3 +2,5 @@ export { backendConfigService } from './modules/config/service';
 export type { Service as ConfigControllerTypes } from './modules/config/types';
 export { backendConfigServiceV2, ConfigServiceV2 } from './modules/config/serviceV2';
 export type { ServiceV2 as ConfigControllerTypesV2 } from './modules/config/typesV2';
+export { ShieldConfigManager, backendShieldConfigManager, } from './modules/config/ShieldConfigManager';
+export type { ShieldConfigManagerOptions, Logger } from './modules/config/ShieldConfigManager';

package/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigServiceV2 = exports.backendConfigServiceV2 = exports.backendConfigService = void 0;
+exports.backendShieldConfigManager = exports.ShieldConfigManager = exports.ConfigServiceV2 = exports.backendConfigServiceV2 = exports.backendConfigService = void 0;
 // V1 SDK (YAML 数据源)
 var service_1 = require("./modules/config/service");
 Object.defineProperty(exports, "backendConfigService", { enumerable: true, get: function () { return service_1.backendConfigService; } });
@@ -8,3 +8,7 @@ Object.defineProperty(exports, "backendConfigService", { enumerable: true, get:
 var serviceV2_1 = require("./modules/config/serviceV2");
 Object.defineProperty(exports, "backendConfigServiceV2", { enumerable: true, get: function () { return serviceV2_1.backendConfigServiceV2; } });
 Object.defineProperty(exports, "ConfigServiceV2", { enumerable: true, get: function () { return serviceV2_1.ConfigServiceV2; } });
+// ShieldConfigManager
+var ShieldConfigManager_1 = require("./modules/config/ShieldConfigManager");
+Object.defineProperty(exports, "ShieldConfigManager", { enumerable: true, get: function () { return ShieldConfigManager_1.ShieldConfigManager; } });
+Object.defineProperty(exports, "backendShieldConfigManager", { enumerable: true, get: function () { return ShieldConfigManager_1.backendShieldConfigManager; } });

package/modules/config/ShieldConfigManager.d.ts

@@ -0,0 +1,81 @@
+/**
+ * ShieldConfigManager - SDK 级别的配置管理器
+ *
+ * 提供配置自动拉取、缓存、定时刷新功能
+ *
+ * @example
+ * ```ts
+ * // 方式一：使用单例（推荐）
+ * import { backendShieldConfigManager } from '@be-link/shield-for-tcb-node-sdk'
+ *
+ * await backendShieldConfigManager.setup('BackendBff', 'local')
+ * const config = backendShieldConfigManager.getConfig<MyConfig>()
+ * backendShieldConfigManager.stop()
+ *
+ * // 方式二：创建独立实例
+ * import { ShieldConfigManager } from '@be-link/shield-for-tcb-node-sdk'
+ *
+ * const manager = new ShieldConfigManager({
+ *   serviceName: 'BackendBff',
+ *   env: 'local',
+ * })
+ *
+ * await manager.setup()
+ * const config = manager.getConfig<MyConfig>()
+ * manager.stop()
+ * ```
+ */
+export interface ShieldConfigManagerOptions {
+    /** 服务名称 */
+    serviceName: string;
+    /** 环境，默认取 NODE_ENV */
+    env?: string;
+    /** 刷新间隔(ms)，默认 5000 */
+    refreshIntervalMs?: number;
+    /** 请求超时(ms)，默认 10000 */
+    fetchTimeoutMs?: number;
+    /** 自定义日志函数，默认 console */
+    logger?: Logger;
+}
+export interface Logger {
+    info: (message: string, ...args: any[]) => void;
+    warn: (message: string, ...args: any[]) => void;
+    error: (message: string, ...args: any[]) => void;
+}
+/**
+ * 配置管理器
+ *
+ * 自动从 Shield 配置中心拉取服务配置，支持定时刷新和泛型类型推导
+ */
+export declare class ShieldConfigManager<T = Record<string, any>> {
+    #private;
+    constructor(options: ShieldConfigManagerOptions);
+    /** 当前缓存的配置副本（原始 Record） */
+    get config(): Record<string, any> | null;
+    /** 是否已完成初始化 */
+    get isSetup(): boolean;
+    /**
+     * 等待初始化完成
+     * @returns Promise，初始化完成后 resolve
+     */
+    waitForSetup(): Promise<void>;
+    /**
+     * 初始化配置管理器，启动定时刷新
+     * 幂等：重复调用无效
+     */
+    setup(): Promise<void>;
+    /**
+     * 手动刷新配置（立即触发一次拉取）
+     */
+    refresh(): Promise<void>;
+    /**
+     * 获取类型化的配置
+     * @returns 泛型 T 类型的配置对象
+     */
+    getConfig(): T | null;
+    /**
+     * 停止定时刷新，清理资源
+     */
+    stop(): void;
+}
+export declare const backendShieldConfigManager: ShieldConfigManager<Record<string, any>>;

package/modules/config/ShieldConfigManager.js

@@ -0,0 +1,218 @@
+"use strict";
+/**
+ * ShieldConfigManager - SDK 级别的配置管理器
+ *
+ * 提供配置自动拉取、缓存、定时刷新功能
+ *
+ * @example
+ * ```ts
+ * // 方式一：使用单例（推荐）
+ * import { backendShieldConfigManager } from '@be-link/shield-for-tcb-node-sdk'
+ *
+ * await backendShieldConfigManager.setup('BackendBff', 'local')
+ * const config = backendShieldConfigManager.getConfig<MyConfig>()
+ * backendShieldConfigManager.stop()
+ *
+ * // 方式二：创建独立实例
+ * import { ShieldConfigManager } from '@be-link/shield-for-tcb-node-sdk'
+ *
+ * const manager = new ShieldConfigManager({
+ *   serviceName: 'BackendBff',
+ *   env: 'local',
+ * })
+ *
+ * await manager.setup()
+ * const config = manager.getConfig<MyConfig>()
+ * manager.stop()
+ * ```
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _ShieldConfigManager_instances, _ShieldConfigManager_serviceName, _ShieldConfigManager_env, _ShieldConfigManager_refreshIntervalMs, _ShieldConfigManager_fetchTimeoutMs, _ShieldConfigManager_logger, _ShieldConfigManager_config, _ShieldConfigManager_refreshTimer, _ShieldConfigManager_isSetup, _ShieldConfigManager_setupPromise, _ShieldConfigManager_doSetup, _ShieldConfigManager_startRefreshTimer;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.backendShieldConfigManager = exports.ShieldConfigManager = void 0;
+const serviceV2_1 = require("./serviceV2");
+const shieldClient = __importStar(require("./service"));
+const defaultLogger = {
+    info: (msg, ...args) => console.log(`[ShieldConfigManager] ${msg}`, ...args),
+    warn: (msg, ...args) => console.warn(`[ShieldConfigManager] ${msg}`, ...args),
+    error: (msg, ...args) => console.error(`[ShieldConfigManager] ${msg}`, ...args),
+};
+const DEFAULT_REFRESH_INTERVAL_MS = 5 * 1000;
+const DEFAULT_FETCH_TIMEOUT_MS = 10 * 1000;
+function withTimeout(promise, timeoutMs) {
+    return Promise.race([
+        promise,
+        new Promise((_resolve, reject) => setTimeout(() => reject(new Error(`ShieldConfigManager fetch timeout after ${timeoutMs}ms`)), timeoutMs)),
+    ]);
+}
+/**
+ * 配置管理器
+ *
+ * 自动从 Shield 配置中心拉取服务配置，支持定时刷新和泛型类型推导
+ */
+class ShieldConfigManager {
+    constructor(options) {
+        _ShieldConfigManager_instances.add(this);
+        _ShieldConfigManager_serviceName.set(this, void 0);
+        _ShieldConfigManager_env.set(this, void 0);
+        _ShieldConfigManager_refreshIntervalMs.set(this, void 0);
+        _ShieldConfigManager_fetchTimeoutMs.set(this, void 0);
+        _ShieldConfigManager_logger.set(this, void 0);
+        _ShieldConfigManager_config.set(this, null);
+        _ShieldConfigManager_refreshTimer.set(this, null);
+        _ShieldConfigManager_isSetup.set(this, false);
+        _ShieldConfigManager_setupPromise.set(this, null);
+        if (!options.serviceName) {
+            throw new Error('[ShieldConfigManager] serviceName is required');
+        }
+        __classPrivateFieldSet(this, _ShieldConfigManager_serviceName, options.serviceName, "f");
+        __classPrivateFieldSet(this, _ShieldConfigManager_env, options.env || process.env.NODE_ENV, "f");
+        __classPrivateFieldSet(this, _ShieldConfigManager_refreshIntervalMs, options.refreshIntervalMs ?? DEFAULT_REFRESH_INTERVAL_MS, "f");
+        __classPrivateFieldSet(this, _ShieldConfigManager_fetchTimeoutMs, options.fetchTimeoutMs ?? DEFAULT_FETCH_TIMEOUT_MS, "f");
+        __classPrivateFieldSet(this, _ShieldConfigManager_logger, options.logger ?? defaultLogger, "f");
+    }
+    /** 当前缓存的配置副本（原始 Record） */
+    get config() {
+        return __classPrivateFieldGet(this, _ShieldConfigManager_config, "f");
+    }
+    /** 是否已完成初始化 */
+    get isSetup() {
+        return __classPrivateFieldGet(this, _ShieldConfigManager_isSetup, "f");
+    }
+    /**
+     * 等待初始化完成
+     * @returns Promise，初始化完成后 resolve
+     */
+    async waitForSetup() {
+        if (!__classPrivateFieldGet(this, _ShieldConfigManager_setupPromise, "f")) {
+            __classPrivateFieldSet(this, _ShieldConfigManager_setupPromise, __classPrivateFieldGet(this, _ShieldConfigManager_instances, "m", _ShieldConfigManager_doSetup).call(this), "f");
+        }
+        return __classPrivateFieldGet(this, _ShieldConfigManager_setupPromise, "f");
+    }
+    /**
+     * 初始化配置管理器，启动定时刷新
+     * 幂等：重复调用无效
+     */
+    async setup() {
+        if (__classPrivateFieldGet(this, _ShieldConfigManager_isSetup, "f")) {
+            __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").warn('ShieldConfigManager already initialized, skipping...');
+            return;
+        }
+        return this.waitForSetup();
+    }
+    /**
+     * 手动刷新配置（立即触发一次拉取）
+     */
+    async refresh() {
+        try {
+            const config = await withTimeout(serviceV2_1.backendConfigServiceV2.fetchAllConfigs(__classPrivateFieldGet(this, _ShieldConfigManager_serviceName, "f"), __classPrivateFieldGet(this, _ShieldConfigManager_env, "f")), __classPrivateFieldGet(this, _ShieldConfigManager_fetchTimeoutMs, "f"));
+            if (config && Object.keys(config).length > 0) {
+                __classPrivateFieldSet(this, _ShieldConfigManager_config, config, "f");
+                __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").info('ShieldConfigManager config refreshed', { keys: Object.keys(config) });
+            }
+            else {
+                __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").warn('ShieldConfigManager fetched empty config');
+            }
+        }
+        catch (error) {
+            __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").error('ShieldConfigManager refresh error', error);
+        }
+        // 兼容旧的逻辑
+        try {
+            const dynamicConfig = await withTimeout(shieldClient.backendConfigService.fetchGlobalDynamicConfig(), __classPrivateFieldGet(this, _ShieldConfigManager_fetchTimeoutMs, "f"));
+            if (dynamicConfig) {
+                process.env.authorizationTokenInside = dynamicConfig.tokenKey;
+            }
+        }
+        catch (error) {
+            __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").error('fetch dynamic config error', error);
+        }
+        __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").info('ShieldConfigManager config refreshed finally', { config: __classPrivateFieldGet(this, _ShieldConfigManager_config, "f") });
+    }
+    /**
+     * 获取类型化的配置
+     * @returns 泛型 T 类型的配置对象
+     */
+    getConfig() {
+        return __classPrivateFieldGet(this, _ShieldConfigManager_config, "f") ?? null;
+    }
+    /**
+     * 停止定时刷新，清理资源
+     */
+    stop() {
+        if (__classPrivateFieldGet(this, _ShieldConfigManager_refreshTimer, "f")) {
+            clearInterval(__classPrivateFieldGet(this, _ShieldConfigManager_refreshTimer, "f"));
+            __classPrivateFieldSet(this, _ShieldConfigManager_refreshTimer, null, "f");
+        }
+        __classPrivateFieldSet(this, _ShieldConfigManager_isSetup, false, "f");
+        __classPrivateFieldSet(this, _ShieldConfigManager_setupPromise, null, "f");
+        __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").info('ShieldConfigManager stopped');
+    }
+}
+exports.ShieldConfigManager = ShieldConfigManager;
+_ShieldConfigManager_serviceName = new WeakMap(), _ShieldConfigManager_env = new WeakMap(), _ShieldConfigManager_refreshIntervalMs = new WeakMap(), _ShieldConfigManager_fetchTimeoutMs = new WeakMap(), _ShieldConfigManager_logger = new WeakMap(), _ShieldConfigManager_config = new WeakMap(), _ShieldConfigManager_refreshTimer = new WeakMap(), _ShieldConfigManager_isSetup = new WeakMap(), _ShieldConfigManager_setupPromise = new WeakMap(), _ShieldConfigManager_instances = new WeakSet(), _ShieldConfigManager_doSetup = async function _ShieldConfigManager_doSetup() {
+    try {
+        await this.refresh();
+    }
+    catch (error) {
+        __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").error('ShieldConfigManager initial refresh failed', error);
+    }
+    if (!__classPrivateFieldGet(this, _ShieldConfigManager_config, "f")) {
+        __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").error('ShieldConfigManager config is empty after initial refresh');
+    }
+    __classPrivateFieldGet(this, _ShieldConfigManager_instances, "m", _ShieldConfigManager_startRefreshTimer).call(this);
+    __classPrivateFieldSet(this, _ShieldConfigManager_isSetup, true, "f");
+    __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").info('ShieldConfigManager initialized successfully');
+}, _ShieldConfigManager_startRefreshTimer = function _ShieldConfigManager_startRefreshTimer() {
+    __classPrivateFieldSet(this, _ShieldConfigManager_refreshTimer, setInterval(() => {
+        this.refresh().catch((error) => {
+            __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").error('ShieldConfigManager timer refresh error', error);
+        });
+    }, __classPrivateFieldGet(this, _ShieldConfigManager_refreshIntervalMs, "f")), "f");
+    __classPrivateFieldGet(this, _ShieldConfigManager_logger, "f").info(`ShieldConfigManager refresh timer started (interval: ${__classPrivateFieldGet(this, _ShieldConfigManager_refreshIntervalMs, "f")}ms)`);
+};
+// 导出单例
+exports.backendShieldConfigManager = new ShieldConfigManager({ serviceName: '' });

package/modules/config/service.js

@@ -15,7 +15,7 @@ class ConfigService extends BaseService_1.default {
         return (0, http_1.callApi)(this.getApiUrl(this.fetchConfig), req);
     }
     fetchGlobalDynamicConfig() {
-        return (0, http_1.callApi)(this.getApiUrl(this.fetchGlobalDynamicConfig), undefined);
+        return (0, http_1.callApi)(this.getApiUrl(this.fetchGlobalDynamicConfig), undefined).catch(() => ({}));
     }
     getCosTempSecret() {
         return (0, http_1.callApi)(this.getApiUrl(this.getCosTempSecret), undefined);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@be-link/shield-for-tcb-node-sdk",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "ShieldForTCB Node.js SDK",
   "main": "index.js",
   "types": "index.d.ts",