@lark-apaas/nestjs-capability 0.1.5-alpha.7 → 0.1.5

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Logger, OnModuleInit, OnModuleDestroy, DynamicModule } from '@nestjs/common';
-import { PlatformHttpClient, RequestContextService } from '@lark-apaas/nestjs-common';
+import { PlatformHttpClient, RequestContextService, HttpClientFactory } from '@lark-apaas/nestjs-common';
 import { ZodSchema } from 'zod';
 import { Response } from 'express';
 
@@ -9,6 +9,8 @@ interface UserContext {
     appId: string;
 }
 interface PluginActionContext {
+    /** 插件标识（如 @official/ai-chat） */
+    pluginKey: string;
     logger: Logger;
     platformHttpClient: PlatformHttpClient;
     userContext: UserContext;
@@ -48,6 +50,8 @@ interface SuccessResponse<T> {
 interface ErrorResponse {
     status_code: string;
     error_msg: string;
+    /** 是否为计费受限错误（当 status_code 为业务错误码时为 true） */
+    is_rate_limit_error?: boolean;
 }
 /**
  * Debug 信息
@@ -106,8 +110,11 @@ interface StreamErrorResponse {
     data: {
         type: 'error';
         error: {
-            code: number;
+            /** 错误码，计费受限时为业务错误码（如 k_st_ec_400002687），其他情况为框架错误码 */
+            code: string;
             message: string;
+            /** 是否为计费受限错误 */
+            isRateLimitError?: boolean;
         };
     };
 }
@@ -133,6 +140,10 @@ interface StreamError {
     code: string;
     message: string;
     details?: unknown;
+    /** 计费受限时的业务错误码（仅 code 为 RATE_LIMIT_EXCEEDED 时存在） */
+    rateLimitCode?: string;
+    /** 计费受限时的业务错误消息（仅 code 为 RATE_LIMIT_EXCEEDED 时存在） */
+    rateLimitMessage?: string;
 }
 /**
  * 流事件类型
@@ -197,6 +208,8 @@ declare const ErrorCodes: {
     readonly PARAMS_VALIDATION_ERROR: "k_ec_cap_004";
     /** 执行失败 */
     readonly EXECUTION_ERROR: "k_ec_cap_005";
+    /** 计费受限 */
+    readonly RATE_LIMIT_EXCEEDED: "k_ec_cap_006";
 };
 type ErrorCode = (typeof ErrorCodes)[keyof typeof ErrorCodes];
 
@@ -366,7 +379,7 @@ interface CapabilityModuleOptions {
 }
 declare class CapabilityService implements OnModuleInit, OnModuleDestroy {
     private readonly requestContextService;
-    private readonly platformHttpClient;
+    private readonly httpClientFactory;
     private readonly pluginLoaderService;
     private readonly templateEngineService;
     private readonly logger;
@@ -376,7 +389,7 @@ declare class CapabilityService implements OnModuleInit, OnModuleDestroy {
     private capabilitiesDir;
     private fileWatcher;
     private options;
-    constructor(requestContextService: RequestContextService, platformHttpClient: PlatformHttpClient, pluginLoaderService: PluginLoaderService, templateEngineService: TemplateEngineService);
+    constructor(requestContextService: RequestContextService, httpClientFactory: HttpClientFactory, pluginLoaderService: PluginLoaderService, templateEngineService: TemplateEngineService);
     /**
      * 设置模块配置
      */
@@ -448,7 +461,22 @@ declare class CapabilityService implements OnModuleInit, OnModuleDestroy {
      * - 如果插件不支持，则包装 runStream/run 为 StreamEvent
      */
     private executeCallStreamWithEvents;
+    /**
+     * 从错误对象提取错误信息
+     * 支持 PluginError 和 RateLimitError
+     */
+    private extractErrorInfo;
     private buildActionContext;
+    /**
+     * 为指定插件创建独立的 HttpClient 实例
+     * 自动添加 x-plugin-key header
+     */
+    private createPluginHttpClient;
+    /**
+     * 将 HttpClient 包装为受保护的 PlatformHttpClient
+     * 只暴露请求方法，不暴露 interceptors
+     */
+    private wrapAsProtectedClient;
     private getUserContext;
 }
 

package/dist/index.js

@@ -14,7 +14,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
@@ -380,7 +382,7 @@ PluginLoaderService = _ts_decorate2([
 
 // src/services/capability.service.ts
 import { Injectable as Injectable3, Logger as Logger2, Inject } from "@nestjs/common";
-import { RequestContextService, PLATFORM_HTTP_CLIENT } from "@lark-apaas/nestjs-common";
+import { RequestContextService, HTTP_CLIENT_FACTORY } from "@lark-apaas/nestjs-common";
 import * as fs2 from "fs";
 import * as path2 from "path";
 import * as chokidar from "chokidar";
@@ -489,7 +491,7 @@ var CapabilityService = class _CapabilityService {
     __name(this, "CapabilityService");
   }
   requestContextService;
-  platformHttpClient;
+  httpClientFactory;
   pluginLoaderService;
   templateEngineService;
   logger = new Logger2(_CapabilityService.name);
@@ -499,9 +501,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";
@@ -741,7 +743,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,
@@ -791,7 +793,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,
@@ -841,7 +843,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,
@@ -907,21 +909,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 {
@@ -933,11 +983,11 @@ var CapabilityService = class _CapabilityService {
 };
 CapabilityService = _ts_decorate3([
   Injectable3(),
-  _ts_param(1, Inject(PLATFORM_HTTP_CLIENT)),
+  _ts_param(1, Inject(HTTP_CLIENT_FACTORY)),
   _ts_metadata("design:type", Function),
   _ts_metadata("design:paramtypes", [
     typeof RequestContextService === "undefined" ? Object : RequestContextService,
-    typeof PlatformHttpClient === "undefined" ? Object : PlatformHttpClient,
+    typeof HttpClientFactory === "undefined" ? Object : HttpClientFactory,
     typeof PluginLoaderService === "undefined" ? Object : PluginLoaderService,
     typeof TemplateEngineService === "undefined" ? Object : TemplateEngineService
   ])
@@ -1078,6 +1128,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)}`
@@ -1146,13 +1204,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
                 }
               }
             };
@@ -1179,14 +1239,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
           }
         }
       };
@@ -1330,6 +1392,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)}`
@@ -1392,13 +1462,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
                 }
               }
             };
@@ -1425,14 +1497,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
           }
         }
       };
@@ -1489,7 +1563,7 @@ WebhookController = _ts_decorate5([
 
 // src/capability.module.ts
 import { Module } from "@nestjs/common";
-import { CommonModule, RequestContextService as RequestContextService2, PLATFORM_HTTP_CLIENT as PLATFORM_HTTP_CLIENT2 } from "@lark-apaas/nestjs-common";
+import { CommonModule, RequestContextService as RequestContextService2, HTTP_CLIENT_FACTORY as HTTP_CLIENT_FACTORY2 } from "@lark-apaas/nestjs-common";
 function _ts_decorate6(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
   if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
@@ -1527,8 +1601,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);
             }
@@ -1536,7 +1610,7 @@ var CapabilityModule = class _CapabilityModule {
           }, "useFactory"),
           inject: [
             RequestContextService2,
-            PLATFORM_HTTP_CLIENT2,
+            HTTP_CLIENT_FACTORY2,
             PluginLoaderService,
             TemplateEngineService,
             CAPABILITY_OPTIONS