@lark-apaas/nestjs-capability 0.1.4-beta.4 → 0.1.4-beta.5

package/README.md

@@ -419,8 +419,9 @@ interface PluginInstance {
 
 ```typescript
 interface PluginActionContext {
+  pluginKey: string;        // 插件标识（如 @official/ai-chat）
   logger: Logger;           // 日志记录器
-  httpClient: PlatformHttpClient; // HTTP 客户端（平台鉴权）
+  platformHttpClient: PlatformHttpClient; // HTTP 客户端（自动携带 x-plugin-key header）
   userContext: {
     userId: string;         // 用户 ID
     tenantId: string;       // 租户 ID
@@ -430,6 +431,11 @@ interface PluginActionContext {
 }
 ```
 
+**pluginKey 说明：**
+- 每次插件调用都会传入当前插件的标识
+- 插件的 HttpClient 会自动在请求头中携带 `x-plugin-key` header
+- 用于计费追踪、日志关联等场景
+
 **isDebug 说明：**
 - `DebugController` 调用时 `isDebug = true`
 - `WebhookController` 或其他调用时 `isDebug = false`

package/dist/index.cjs

@@ -63,7 +63,9 @@ var ErrorCodes = {
   /** 参数验证失败 */
   PARAMS_VALIDATION_ERROR: "k_ec_cap_004",
   /** 执行失败 */
-  EXECUTION_ERROR: "k_ec_cap_005"
+  EXECUTION_ERROR: "k_ec_cap_005",
+  /** 计费受限 */
+  RATE_LIMIT_EXCEEDED: "k_ec_cap_006"
 };
 
 // src/services/template-engine.service.ts
@@ -538,7 +540,7 @@ var CapabilityService = class _CapabilityService {
     __name(this, "CapabilityService");
   }
   requestContextService;
-  platformHttpClient;
+  httpClientFactory;
   pluginLoaderService;
   templateEngineService;
   logger = new import_common3.Logger(_CapabilityService.name);
@@ -548,9 +550,9 @@ var CapabilityService = class _CapabilityService {
   capabilitiesDir;
   fileWatcher = null;
   options = {};
-  constructor(requestContextService, platformHttpClient, pluginLoaderService, templateEngineService) {
+  constructor(requestContextService, httpClientFactory, pluginLoaderService, templateEngineService) {
     this.requestContextService = requestContextService;
-    this.platformHttpClient = platformHttpClient;
+    this.httpClientFactory = httpClientFactory;
     this.pluginLoaderService = pluginLoaderService;
     this.templateEngineService = templateEngineService;
     const isDev = process.env.NODE_ENV === "development";
@@ -790,7 +792,7 @@ var CapabilityService = class _CapabilityService {
       if (!pluginInstance.hasAction(actionName)) {
         throw new ActionNotFoundError(config.pluginKey, actionName);
       }
-      const context = this.buildActionContext(contextOverride);
+      const context = this.buildActionContext(config.pluginKey, contextOverride);
       const isStream = pluginInstance.isStreamAction?.(actionName) ?? false;
       this.logger.log("Executing capability (call)", {
         ...loggerContext,
@@ -840,7 +842,7 @@ var CapabilityService = class _CapabilityService {
       if (!pluginInstance.hasAction(actionName)) {
         throw new ActionNotFoundError(config.pluginKey, actionName);
       }
-      const context = this.buildActionContext(contextOverride);
+      const context = this.buildActionContext(config.pluginKey, contextOverride);
       const isStream = pluginInstance.isStreamAction?.(actionName) ?? false;
       this.logger.log("Executing capability (stream)", {
         ...loggerContext,
@@ -890,7 +892,7 @@ var CapabilityService = class _CapabilityService {
       if (!pluginInstance.hasAction(actionName)) {
         throw new ActionNotFoundError(config.pluginKey, actionName);
       }
-      const context = this.buildActionContext(contextOverride);
+      const context = this.buildActionContext(config.pluginKey, contextOverride);
       const isStream = pluginInstance.isStreamAction?.(actionName) ?? false;
       this.logger.log("Executing capability (streamWithEvents)", {
         ...loggerContext,
@@ -956,21 +958,69 @@ var CapabilityService = class _CapabilityService {
       });
       yield {
         type: "error",
-        error: {
-          code: "EXECUTION_ERROR",
-          message: error instanceof Error ? error.message : String(error)
-        }
+        error: this.extractErrorInfo(error)
       };
     }
   }
-  buildActionContext(override) {
+  /**
+  * 从错误对象提取错误信息
+  * 支持 PluginError 和 RateLimitError
+  */
+  extractErrorInfo(error) {
+    const err = error;
+    const code = err?.code ?? "EXECUTION_ERROR";
+    const message = err instanceof Error ? err.message : String(err);
+    if (code === "RATE_LIMIT_EXCEEDED" && err?.rateLimitCode) {
+      return {
+        code,
+        message,
+        rateLimitCode: err.rateLimitCode,
+        rateLimitMessage: err.rateLimitMessage
+      };
+    }
     return {
+      code,
+      message
+    };
+  }
+  buildActionContext(pluginKey, override) {
+    return {
+      pluginKey,
       logger: this.logger,
-      platformHttpClient: this.platformHttpClient,
+      platformHttpClient: this.createPluginHttpClient(pluginKey),
       userContext: override?.userContext ?? this.getUserContext(),
       isDebug: override?.isDebug ?? false
     };
   }
+  /**
+  * 为指定插件创建独立的 HttpClient 实例
+  * 自动添加 x-plugin-key header
+  */
+  createPluginHttpClient(pluginKey) {
+    const client = this.httpClientFactory.create();
+    client.interceptors.request.use((config) => {
+      config.headers = {
+        ...config.headers,
+        "x-plugin-key": pluginKey
+      };
+      return config;
+    });
+    return this.wrapAsProtectedClient(client);
+  }
+  /**
+  * 将 HttpClient 包装为受保护的 PlatformHttpClient
+  * 只暴露请求方法，不暴露 interceptors
+  */
+  wrapAsProtectedClient(client) {
+    return {
+      request: /* @__PURE__ */ __name((config) => client.request(config), "request"),
+      get: /* @__PURE__ */ __name((url, config) => client.get(url, config), "get"),
+      post: /* @__PURE__ */ __name((url, data, config) => client.post(url, data, config), "post"),
+      put: /* @__PURE__ */ __name((url, data, config) => client.put(url, data, config), "put"),
+      patch: /* @__PURE__ */ __name((url, data, config) => client.patch(url, data, config), "patch"),
+      delete: /* @__PURE__ */ __name((url, config) => client.delete(url, config), "delete")
+    };
+  }
   getUserContext() {
     const ctx = this.requestContextService.getContext();
     return {
@@ -982,11 +1032,11 @@ var CapabilityService = class _CapabilityService {
 };
 CapabilityService = _ts_decorate3([
   (0, import_common3.Injectable)(),
-  _ts_param(1, (0, import_common3.Inject)(import_nestjs_common.PLATFORM_HTTP_CLIENT)),
+  _ts_param(1, (0, import_common3.Inject)(import_nestjs_common.HTTP_CLIENT_FACTORY)),
   _ts_metadata("design:type", Function),
   _ts_metadata("design:paramtypes", [
     typeof import_nestjs_common.RequestContextService === "undefined" ? Object : import_nestjs_common.RequestContextService,
-    typeof PlatformHttpClient === "undefined" ? Object : PlatformHttpClient,
+    typeof HttpClientFactory === "undefined" ? Object : HttpClientFactory,
     typeof PluginLoaderService === "undefined" ? Object : PluginLoaderService,
     typeof TemplateEngineService === "undefined" ? Object : TemplateEngineService
   ])
@@ -1127,6 +1177,14 @@ var DebugController = class _DebugController {
         error_msg: `Action '${error.actionName}' not found in plugin ${error.pluginKey}`
       };
     }
+    const err = error;
+    if (err?.code === "RATE_LIMIT_EXCEEDED" && err?.rateLimitCode) {
+      return {
+        status_code: err.rateLimitCode,
+        error_msg: err.rateLimitMessage || err.message,
+        is_rate_limit_error: true
+      };
+    }
     return {
       status_code: ErrorCodes.EXECUTION_ERROR,
       error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
@@ -1195,13 +1253,15 @@ var DebugController = class _DebugController {
             return;
           }
           case "error": {
+            const isRateLimitError = event.error.code === "RATE_LIMIT_EXCEEDED" && !!event.error.rateLimitCode;
             const response = {
               status_code: ErrorCodes.SUCCESS,
               data: {
                 type: "error",
                 error: {
-                  code: 0,
-                  message: event.error.message
+                  code: isRateLimitError ? event.error.rateLimitCode : event.error.code,
+                  message: isRateLimitError ? event.error.rateLimitMessage : event.error.message,
+                  isRateLimitError: isRateLimitError || void 0
                 }
               }
             };
@@ -1228,14 +1288,16 @@ var DebugController = class _DebugController {
       }
       res.end();
     } catch (error) {
-      const errorMsg = error instanceof Error ? error.message : String(error);
+      const err = error;
+      const isRateLimitError = err?.code === "RATE_LIMIT_EXCEEDED" && !!err?.rateLimitCode;
       const response = {
         status_code: ErrorCodes.SUCCESS,
         data: {
           type: "error",
           error: {
-            code: 0,
-            message: errorMsg
+            code: isRateLimitError ? err.rateLimitCode : err?.code ?? "EXECUTION_ERROR",
+            message: isRateLimitError ? err.rateLimitMessage : error instanceof Error ? error.message : String(error),
+            isRateLimitError: isRateLimitError || void 0
           }
         }
       };
@@ -1379,6 +1441,14 @@ var WebhookController = class _WebhookController {
         error_msg: `Action '${error.actionName}' not found in plugin ${error.pluginKey}`
       };
     }
+    const err = error;
+    if (err?.code === "RATE_LIMIT_EXCEEDED" && err?.rateLimitCode) {
+      return {
+        status_code: err.rateLimitCode,
+        error_msg: err.rateLimitMessage || err.message,
+        is_rate_limit_error: true
+      };
+    }
     return {
       status_code: ErrorCodes.EXECUTION_ERROR,
       error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
@@ -1441,13 +1511,15 @@ var WebhookController = class _WebhookController {
             return;
           }
           case "error": {
+            const isRateLimitError = event.error.code === "RATE_LIMIT_EXCEEDED" && !!event.error.rateLimitCode;
             const response = {
               status_code: ErrorCodes.SUCCESS,
               data: {
                 type: "error",
                 error: {
-                  code: 0,
-                  message: event.error.message
+                  code: isRateLimitError ? event.error.rateLimitCode : event.error.code,
+                  message: isRateLimitError ? event.error.rateLimitMessage : event.error.message,
+                  isRateLimitError: isRateLimitError || void 0
                 }
               }
             };
@@ -1474,14 +1546,16 @@ var WebhookController = class _WebhookController {
       }
       res.end();
     } catch (error) {
-      const errorMsg = error instanceof Error ? error.message : String(error);
+      const err = error;
+      const isRateLimitError = err?.code === "RATE_LIMIT_EXCEEDED" && !!err?.rateLimitCode;
       const response = {
         status_code: ErrorCodes.SUCCESS,
         data: {
           type: "error",
           error: {
-            code: 0,
-            message: errorMsg
+            code: isRateLimitError ? err.rateLimitCode : err?.code ?? "EXECUTION_ERROR",
+            message: isRateLimitError ? err.rateLimitMessage : error instanceof Error ? error.message : String(error),
+            isRateLimitError: isRateLimitError || void 0
           }
         }
       };
@@ -1576,8 +1650,8 @@ var CapabilityModule = class _CapabilityModule {
         },
         {
           provide: CapabilityService,
-          useFactory: /* @__PURE__ */ __name((requestContextService, httpClient, pluginLoader, templateEngine, moduleOptions) => {
-            const service = new CapabilityService(requestContextService, httpClient, pluginLoader, templateEngine);
+          useFactory: /* @__PURE__ */ __name((requestContextService, httpClientFactory, pluginLoader, templateEngine, moduleOptions) => {
+            const service = new CapabilityService(requestContextService, httpClientFactory, pluginLoader, templateEngine);
             if (moduleOptions) {
               service.setOptions(moduleOptions);
             }
@@ -1585,7 +1659,7 @@ var CapabilityModule = class _CapabilityModule {
           }, "useFactory"),
           inject: [
             import_nestjs_common2.RequestContextService,
-            import_nestjs_common2.PLATFORM_HTTP_CLIENT,
+            import_nestjs_common2.HTTP_CLIENT_FACTORY,
             PluginLoaderService,
             TemplateEngineService,
             CAPABILITY_OPTIONS