@lark-apaas/nestjs-capability 0.0.1-alpha.12 → 0.0.1-alpha.14

package/dist/index.d.ts

@@ -228,6 +228,7 @@ declare class TemplateEngineService {
 }
 
 declare class PluginNotFoundError extends Error {
+    readonly pluginKey: string;
     constructor(pluginKey: string);
 }
 declare class PluginLoadError extends Error {
@@ -264,9 +265,12 @@ declare class PluginLoaderService {
 }
 
 declare class CapabilityNotFoundError extends Error {
+    readonly capabilityId: string;
     constructor(capabilityId: string);
 }
 declare class ActionNotFoundError extends Error {
+    readonly pluginKey: string;
+    readonly actionName: string;
     constructor(pluginKey: string, actionName: string);
 }
 interface CapabilityExecutor {
@@ -396,7 +400,7 @@ declare class DebugController {
     private readonly templateEngineService;
     private readonly logger;
     constructor(capabilityService: CapabilityService, pluginLoaderService: PluginLoaderService, templateEngineService: TemplateEngineService);
-    list(): SuccessResponse<ListResponseData>;
+    list(res: Response): void;
     /**
      * 获取 capability 配置
      * 优先使用 body.capability，否则从服务获取
@@ -407,7 +411,11 @@ declare class DebugController {
      * 优先使用传入的 action，否则使用插件第一个 action
      */
     private getActionName;
-    debug(capabilityId: string, body: DebugRequestBody): Promise<SuccessResponse<DebugExecuteResponseData> | ErrorResponse>;
+    debug(capabilityId: string, body: DebugRequestBody, res: Response): Promise<void>;
+    /**
+     * 构建错误响应
+     */
+    private buildErrorResponse;
     debugStream(capabilityId: string, body: DebugRequestBody, res: Response): Promise<void>;
 }
 
@@ -419,8 +427,12 @@ declare class WebhookController {
     private readonly capabilityService;
     private readonly logger;
     constructor(capabilityService: CapabilityService);
-    list(): SuccessResponse<ListResponseData>;
-    execute(capabilityId: string, body: ExecuteRequestBody): Promise<SuccessResponse<ExecuteResponseData> | ErrorResponse>;
+    list(res: Response): void;
+    execute(capabilityId: string, body: ExecuteRequestBody, res: Response): Promise<void>;
+    /**
+     * 构建错误响应
+     */
+    private buildErrorResponse;
     executeStream(capabilityId: string, body: ExecuteRequestBody, res: Response): Promise<void>;
 }
 
@@ -428,4 +440,68 @@ declare class CapabilityModule {
     static forRoot(options?: CapabilityModuleOptions): DynamicModule;
 }
 
-export { ActionNotFoundError, type ActionSchema, type CapabilityConfig, type CapabilityExecutor, type CapabilityListItem, CapabilityModule, type CapabilityModuleOptions, CapabilityNotFoundError, CapabilityService, DebugController, type DebugExecuteResponseData, type DebugInfo, type ErrorCode, ErrorCodes, type ErrorResponse, type ExecuteResponseData, type JSONSchema, type ListResponseData, type PluginActionContext, type PluginInstance, PluginLoadError, PluginLoaderService, PluginNotFoundError, type PluginPackage, type StreamContentResponse, type StreamDoneMetadata, type StreamError, type StreamErrorResponse, type StreamEvent, type StreamResponse, type SuccessResponse, TemplateEngineService, type UserContext, WebhookController };
+/**
+ * Migration Adaptor
+ *
+ * 用于迁移老版本 capability 调用代码，将新版本的返回结果包装为老版本的 Response 结构
+ */
+/**
+ * 失败输出结构
+ */
+interface FailureOutput {
+    response: {
+        status: {
+            /** 协议层返回码（如 HTTP 状态码） */
+            protocolStatusCode: string;
+            /** 业务应用状态码 */
+            appStatusCode: string;
+        };
+        /** 返回体（JSON 字符串形式） */
+        body: string;
+    };
+}
+/**
+ * 老版本 capability 调用的 Response 结构
+ *
+ * 注意：output 使用 any 类型以简化迁移代码，避免类型断言
+ */
+interface MigrationResponse {
+    /** 当 code=0 时表示执行成功，当 code!=0 时表示执行失败 */
+    code: number;
+    data?: {
+        /** 执行成功时的输出结果（any 类型，兼容迁移场景） */
+        output?: any;
+        /** 执行结果，'success' 或 'error' */
+        outcome?: 'success' | 'error';
+        /** 执行失败时的输出结果 */
+        failureOutput?: FailureOutput;
+    };
+    /** 发生错误时的错误信息 */
+    message?: string;
+}
+/**
+ * 迁移适配器
+ *
+ * 将 CapabilityService.load().call() 的返回结果包装为老版本的 Response 结构
+ *
+ * @example
+ * // 老代码
+ * const result = await generateTaskDescription(params);
+ *
+ * // 新代码
+ * const result = await migrationAdaptor(
+ *   this.capabilityService.load('ai_generate_task_description').call('run', params)
+ * );
+ *
+ * // result 结构
+ * // {
+ * //   code: 0,
+ * //   data: {
+ * //     output: { ... },  // 能力执行结果
+ * //     outcome: 'success'
+ * //   }
+ * // }
+ */
+declare function migrationAdaptor(promise: Promise<unknown>): Promise<MigrationResponse>;
+
+export { ActionNotFoundError, type ActionSchema, type CapabilityConfig, type CapabilityExecutor, type CapabilityListItem, CapabilityModule, type CapabilityModuleOptions, CapabilityNotFoundError, CapabilityService, DebugController, type DebugExecuteResponseData, type DebugInfo, type ErrorCode, ErrorCodes, type ErrorResponse, type ExecuteResponseData, type FailureOutput, type JSONSchema, type ListResponseData, type MigrationResponse, type PluginActionContext, type PluginInstance, PluginLoadError, PluginLoaderService, PluginNotFoundError, type PluginPackage, type StreamContentResponse, type StreamDoneMetadata, type StreamError, type StreamErrorResponse, type StreamEvent, type StreamResponse, type SuccessResponse, TemplateEngineService, type UserContext, WebhookController, migrationAdaptor };

package/dist/index.js

@@ -31,9 +31,9 @@ var TemplateEngineService = class {
     __name(this, "TemplateEngineService");
   }
   // 匹配 {{input.xxx}} 或 {{input.xxx.yyy}} 表达式
-  EXPR_REGEX = /\{\{input\.([a-zA-Z_][a-zA-Z_0-9]*(?:\.[a-zA-Z_][a-zA-Z_0-9]*)*)\}\}/g;
+  EXPR_REGEX = /\{\{\s*input\.([a-zA-Z_][a-zA-Z_0-9]*(?:\.[a-zA-Z_][a-zA-Z_0-9]*)*\s*)\}\}/g;
   // 匹配整串单个表达式
-  WHOLE_STRING_EXPR_REGEX = /^\{\{input\.([a-zA-Z_][a-zA-Z_0-9]*(?:\.[a-zA-Z_][a-zA-Z_0-9]*)*)\}\}$/;
+  WHOLE_STRING_EXPR_REGEX = /^\{\{\s*input\.([a-zA-Z_][a-zA-Z_0-9]*(?:\.[a-zA-Z_][a-zA-Z_0-9]*)*)\s*\}\}$/;
   resolve(template, input) {
     if (typeof template === "string") {
       return this.resolveString(template, input);
@@ -106,9 +106,11 @@ var PluginNotFoundError = class extends Error {
   static {
     __name(this, "PluginNotFoundError");
   }
+  pluginKey;
   constructor(pluginKey) {
     super(`Plugin not found: ${pluginKey}`);
     this.name = "PluginNotFoundError";
+    this.pluginKey = pluginKey;
   }
 };
 var PluginLoadError = class extends Error {
@@ -252,6 +254,43 @@ function stringifyForLog(value, maxLength = DEFAULT_MAX_LENGTH) {
 }
 __name(stringifyForLog, "stringifyForLog");
 
+// src/utils/migration-adaptor.ts
+async function migrationAdaptor(promise) {
+  try {
+    const result = await promise;
+    return {
+      code: 0,
+      data: {
+        output: result,
+        outcome: "success"
+      }
+    };
+  } catch (error) {
+    const errorMessage = error instanceof Error ? error.message : String(error);
+    const appStatusCode = error instanceof Error && "code" in error ? String(error.code) : "EXECUTION_ERROR";
+    return {
+      code: -1,
+      data: {
+        outcome: "error",
+        failureOutput: {
+          response: {
+            status: {
+              protocolStatusCode: "500",
+              appStatusCode
+            },
+            body: JSON.stringify({
+              error: errorMessage,
+              stack: error instanceof Error ? error.stack : void 0
+            })
+          }
+        }
+      },
+      message: errorMessage
+    };
+  }
+}
+__name(migrationAdaptor, "migrationAdaptor");
+
 // src/services/capability.service.ts
 function _ts_decorate3(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
@@ -274,18 +313,24 @@ var CapabilityNotFoundError = class extends Error {
   static {
     __name(this, "CapabilityNotFoundError");
   }
+  capabilityId;
   constructor(capabilityId) {
     super(`Capability not found: ${capabilityId}`);
     this.name = "CapabilityNotFoundError";
+    this.capabilityId = capabilityId;
   }
 };
 var ActionNotFoundError = class extends Error {
   static {
     __name(this, "ActionNotFoundError");
   }
+  pluginKey;
+  actionName;
   constructor(pluginKey, actionName) {
     super(`Action '${actionName}' not found in plugin ${pluginKey}`);
     this.name = "ActionNotFoundError";
+    this.pluginKey = pluginKey;
+    this.actionName = actionName;
   }
 };
 var CapabilityService = class _CapabilityService {
@@ -731,7 +776,7 @@ CapabilityService = _ts_decorate3([
 ], CapabilityService);
 
 // src/controllers/debug.controller.ts
-import { Controller, Post, Get, Param, Body, Res, HttpException, HttpStatus, Logger as Logger3 } from "@nestjs/common";
+import { Controller, Post, Get, Param, Body, Res, HttpStatus, Logger as Logger3 } from "@nestjs/common";
 function _ts_decorate4(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);
@@ -762,19 +807,27 @@ var DebugController = class _DebugController {
     this.pluginLoaderService = pluginLoaderService;
     this.templateEngineService = templateEngineService;
   }
-  list() {
-    const capabilities = this.capabilityService.listCapabilities();
-    return {
-      status_code: ErrorCodes.SUCCESS,
-      data: {
-        capabilities: capabilities.map((c) => ({
-          id: c.id,
-          name: c.name,
-          pluginID: c.pluginKey,
-          pluginVersion: c.pluginVersion
-        }))
-      }
-    };
+  list(res) {
+    try {
+      const capabilities = this.capabilityService.listCapabilities();
+      res.status(HttpStatus.OK).json({
+        status_code: ErrorCodes.SUCCESS,
+        data: {
+          capabilities: capabilities.map((c) => ({
+            id: c.id,
+            name: c.name,
+            pluginID: c.pluginKey,
+            pluginVersion: c.pluginVersion
+          }))
+        }
+      });
+    } catch (error) {
+      this.logger.error("Failed to list capabilities", error);
+      res.status(HttpStatus.INTERNAL_SERVER_ERROR).json({
+        status_code: ErrorCodes.EXECUTION_ERROR,
+        error_msg: `Failed to list capabilities: ${error instanceof Error ? error.message : String(error)}`
+      });
+    }
   }
   /**
   * 获取 capability 配置
@@ -786,11 +839,7 @@ var DebugController = class _DebugController {
     }
     const config = this.capabilityService.getCapability(capabilityId);
     if (!config) {
-      throw new HttpException({
-        code: 1,
-        message: `Capability not found: ${capabilityId}`,
-        error: "CAPABILITY_NOT_FOUND"
-      }, HttpStatus.NOT_FOUND);
+      throw new CapabilityNotFoundError(capabilityId);
     }
     return config;
   }
@@ -805,25 +854,21 @@ var DebugController = class _DebugController {
     const pluginInstance = await this.pluginLoaderService.loadPlugin(pluginKey);
     const actions = pluginInstance.listActions();
     if (actions.length === 0) {
-      throw new HttpException({
-        code: 1,
-        message: `Plugin ${pluginKey} has no actions`,
-        error: "NO_ACTIONS"
-      }, HttpStatus.BAD_REQUEST);
+      throw new Error(`Plugin ${pluginKey} has no actions`);
     }
     return actions[0];
   }
-  async debug(capabilityId, body) {
+  async debug(capabilityId, body, res) {
     const startTime = Date.now();
     const params = body.params ?? {};
-    const config = this.getCapabilityConfig(capabilityId, body.capability);
-    const action = await this.getActionName(config.pluginKey, body.action);
-    const resolvedParams = this.templateEngineService.resolve(config.formValue, params);
     try {
+      const config = this.getCapabilityConfig(capabilityId, body.capability);
+      const action = await this.getActionName(config.pluginKey, body.action);
+      const resolvedParams = this.templateEngineService.resolve(config.formValue, params);
       const result = await this.capabilityService.loadWithConfig(config).call(action, params, {
         isDebug: true
       });
-      return {
+      res.status(HttpStatus.OK).json({
         status_code: ErrorCodes.SUCCESS,
         data: {
           output: result,
@@ -835,31 +880,38 @@ var DebugController = class _DebugController {
             action
           }
         }
-      };
+      });
     } catch (error) {
-      if (error instanceof CapabilityNotFoundError) {
-        throw new HttpException({
-          status_code: ErrorCodes.CAPABILITY_NOT_FOUND,
-          error_msg: `Capability not found: ${capabilityId}`
-        }, HttpStatus.NOT_FOUND);
-      }
-      if (error instanceof PluginNotFoundError) {
-        throw new HttpException({
-          status_code: ErrorCodes.PLUGIN_NOT_FOUND,
-          error_msg: `Plugin not found: ${config.pluginKey}`
-        }, HttpStatus.INTERNAL_SERVER_ERROR);
-      }
-      if (error instanceof ActionNotFoundError) {
-        throw new HttpException({
-          status_code: ErrorCodes.ACTION_NOT_FOUND,
-          error_msg: `Action '${action}' not found in plugin ${config.pluginKey}`
-        }, HttpStatus.BAD_REQUEST);
-      }
-      throw new HttpException({
-        status_code: ErrorCodes.EXECUTION_ERROR,
-        error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
-      }, HttpStatus.INTERNAL_SERVER_ERROR);
+      this.logger.error("Debug execution failed", error);
+      res.status(HttpStatus.INTERNAL_SERVER_ERROR).json(this.buildErrorResponse(error));
+    }
+  }
+  /**
+  * 构建错误响应
+  */
+  buildErrorResponse(error) {
+    if (error instanceof CapabilityNotFoundError) {
+      return {
+        status_code: ErrorCodes.CAPABILITY_NOT_FOUND,
+        error_msg: `Capability not found: ${error.capabilityId}`
+      };
+    }
+    if (error instanceof PluginNotFoundError) {
+      return {
+        status_code: ErrorCodes.PLUGIN_NOT_FOUND,
+        error_msg: `Plugin not found, please install plugin: ${error.pluginKey}`
+      };
+    }
+    if (error instanceof ActionNotFoundError) {
+      return {
+        status_code: ErrorCodes.ACTION_NOT_FOUND,
+        error_msg: `Action '${error.actionName}' not found in plugin ${error.pluginKey}`
+      };
     }
+    return {
+      status_code: ErrorCodes.EXECUTION_ERROR,
+      error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
+    };
   }
   async debugStream(capabilityId, body, res) {
     const params = body.params ?? {};
@@ -977,18 +1029,23 @@ var DebugController = class _DebugController {
 };
 _ts_decorate4([
   Get("list"),
+  _ts_param2(0, Res()),
   _ts_metadata2("design:type", Function),
-  _ts_metadata2("design:paramtypes", []),
-  _ts_metadata2("design:returntype", typeof SuccessResponse === "undefined" ? Object : SuccessResponse)
+  _ts_metadata2("design:paramtypes", [
+    typeof Response === "undefined" ? Object : Response
+  ]),
+  _ts_metadata2("design:returntype", void 0)
 ], DebugController.prototype, "list", null);
 _ts_decorate4([
   Post("debug/:capability_id"),
   _ts_param2(0, Param("capability_id")),
   _ts_param2(1, Body()),
+  _ts_param2(2, Res()),
   _ts_metadata2("design:type", Function),
   _ts_metadata2("design:paramtypes", [
     String,
-    typeof DebugRequestBody === "undefined" ? Object : DebugRequestBody
+    typeof DebugRequestBody === "undefined" ? Object : DebugRequestBody,
+    typeof Response === "undefined" ? Object : Response
   ]),
   _ts_metadata2("design:returntype", Promise)
 ], DebugController.prototype, "debug", null);
@@ -1016,7 +1073,7 @@ DebugController = _ts_decorate4([
 ], DebugController);
 
 // src/controllers/webhook.controller.ts
-import { Controller as Controller2, Get as Get2, Post as Post2, Param as Param2, Body as Body2, Res as Res2, HttpException as HttpException2, HttpStatus as HttpStatus2, Logger as Logger4 } from "@nestjs/common";
+import { Controller as Controller2, Get as Get2, Post as Post2, Param as Param2, Body as Body2, Res as Res2, HttpStatus as HttpStatus2, Logger as Logger4 } from "@nestjs/common";
 function _ts_decorate5(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);
@@ -1043,53 +1100,68 @@ var WebhookController = class _WebhookController {
   constructor(capabilityService) {
     this.capabilityService = capabilityService;
   }
-  list() {
-    const capabilities = this.capabilityService.listCapabilities();
-    return {
-      status_code: ErrorCodes.SUCCESS,
-      data: {
-        capabilities: capabilities.map((c) => ({
-          id: c.id,
-          name: c.name,
-          pluginID: c.pluginKey,
-          pluginVersion: c.pluginVersion
-        }))
-      }
-    };
+  list(res) {
+    try {
+      const capabilities = this.capabilityService.listCapabilities();
+      res.status(HttpStatus2.OK).json({
+        status_code: ErrorCodes.SUCCESS,
+        data: {
+          capabilities: capabilities.map((c) => ({
+            id: c.id,
+            name: c.name,
+            pluginID: c.pluginKey,
+            pluginVersion: c.pluginVersion
+          }))
+        }
+      });
+    } catch (error) {
+      this.logger.error("Failed to list capabilities", error);
+      res.status(HttpStatus2.INTERNAL_SERVER_ERROR).json({
+        status_code: ErrorCodes.EXECUTION_ERROR,
+        error_msg: `Failed to list capabilities: ${error instanceof Error ? error.message : String(error)}`
+      });
+    }
   }
-  async execute(capabilityId, body) {
+  async execute(capabilityId, body, res) {
     try {
       const result = await this.capabilityService.load(capabilityId).call(body.action, body.params);
-      return {
+      res.status(HttpStatus2.OK).json({
         status_code: ErrorCodes.SUCCESS,
         data: {
           output: result
         }
-      };
+      });
     } catch (error) {
-      if (error instanceof CapabilityNotFoundError) {
-        throw new HttpException2({
-          status_code: ErrorCodes.CAPABILITY_NOT_FOUND,
-          error_msg: `Capability not found: ${capabilityId}`
-        }, HttpStatus2.NOT_FOUND);
-      }
-      if (error instanceof PluginNotFoundError) {
-        throw new HttpException2({
-          status_code: ErrorCodes.PLUGIN_NOT_FOUND,
-          error_msg: `Plugin not found`
-        }, HttpStatus2.INTERNAL_SERVER_ERROR);
-      }
-      if (error instanceof ActionNotFoundError) {
-        throw new HttpException2({
-          status_code: ErrorCodes.ACTION_NOT_FOUND,
-          error_msg: `Action '${body.action}' not found`
-        }, HttpStatus2.BAD_REQUEST);
-      }
-      throw new HttpException2({
-        status_code: ErrorCodes.EXECUTION_ERROR,
-        error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
-      }, HttpStatus2.INTERNAL_SERVER_ERROR);
+      this.logger.error("Capability execution failed", error);
+      res.status(HttpStatus2.INTERNAL_SERVER_ERROR).json(this.buildErrorResponse(error));
+    }
+  }
+  /**
+  * 构建错误响应
+  */
+  buildErrorResponse(error) {
+    if (error instanceof CapabilityNotFoundError) {
+      return {
+        status_code: ErrorCodes.CAPABILITY_NOT_FOUND,
+        error_msg: `Capability not found: ${error.capabilityId}`
+      };
+    }
+    if (error instanceof PluginNotFoundError) {
+      return {
+        status_code: ErrorCodes.PLUGIN_NOT_FOUND,
+        error_msg: `Plugin not found, please install plugin: ${error.pluginKey}`
+      };
+    }
+    if (error instanceof ActionNotFoundError) {
+      return {
+        status_code: ErrorCodes.ACTION_NOT_FOUND,
+        error_msg: `Action '${error.actionName}' not found in plugin ${error.pluginKey}`
+      };
     }
+    return {
+      status_code: ErrorCodes.EXECUTION_ERROR,
+      error_msg: `Execution failed: ${error instanceof Error ? error.message : String(error)}`
+    };
   }
   async executeStream(capabilityId, body, res) {
     const loggerContext = {
@@ -1201,18 +1273,23 @@ var WebhookController = class _WebhookController {
 };
 _ts_decorate5([
   Get2("list"),
+  _ts_param3(0, Res2()),
   _ts_metadata3("design:type", Function),
-  _ts_metadata3("design:paramtypes", []),
-  _ts_metadata3("design:returntype", typeof SuccessResponse === "undefined" ? Object : SuccessResponse)
+  _ts_metadata3("design:paramtypes", [
+    typeof Response === "undefined" ? Object : Response
+  ]),
+  _ts_metadata3("design:returntype", void 0)
 ], WebhookController.prototype, "list", null);
 _ts_decorate5([
   Post2(":capability_id"),
   _ts_param3(0, Param2("capability_id")),
   _ts_param3(1, Body2()),
+  _ts_param3(2, Res2()),
   _ts_metadata3("design:type", Function),
   _ts_metadata3("design:paramtypes", [
     String,
-    typeof ExecuteRequestBody === "undefined" ? Object : ExecuteRequestBody
+    typeof ExecuteRequestBody === "undefined" ? Object : ExecuteRequestBody,
+    typeof Response === "undefined" ? Object : Response
   ]),
   _ts_metadata3("design:returntype", Promise)
 ], WebhookController.prototype, "execute", null);
@@ -1328,6 +1405,7 @@ export {
   PluginLoaderService,
   PluginNotFoundError,
   TemplateEngineService,
-  WebhookController
+  WebhookController,
+  migrationAdaptor
 };
 //# sourceMappingURL=index.js.map