@lark-apaas/nestjs-capability 0.1.4 → 0.1.5-alpha.0

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

@@ -538,7 +538,7 @@ var CapabilityService = class _CapabilityService {
     __name(this, "CapabilityService");
   }
   requestContextService;
-  platformHttpClient;
+  httpClientFactory;
   pluginLoaderService;
   templateEngineService;
   logger = new import_common3.Logger(_CapabilityService.name);
@@ -548,9 +548,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 +790,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 +840,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 +890,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,
@@ -963,14 +963,44 @@ var CapabilityService = class _CapabilityService {
       };
     }
   }
-  buildActionContext(override) {
+  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 +1012,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
   ])
@@ -1576,8 +1606,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 +1615,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