@vui-design/openclaw-plugin-feishu-progress 0.1.6 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vui-design/openclaw-plugin-feishu-progress",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "飞书任务进度卡片插件 — 在 AI 执行复杂多步骤任务时，实时更新飞书进度卡片",
   "keywords": [
     "openclaw-plugin",

package/src/feishu-client.ts

@@ -65,6 +65,27 @@ export class FeishuClient {
     return data.data.message_id;
   }
 
+  async sendText(chatId: string, text: string): Promise<string> {
+    const token = await this.getToken();
+    const res = await fetch(
+      `${this.baseUrl}/open-apis/im/v1/messages?receive_id_type=chat_id`,
+      {
+        method: 'POST',
+        headers: {
+          Authorization: `Bearer ${token}`,
+          'Content-Type': 'application/json',
+        },
+        body: JSON.stringify({
+          receive_id: chatId,
+          msg_type: 'text',
+          content: JSON.stringify({ text }),
+        }),
+      }
+    );
+    const data = (await res.json()) as { data: { message_id: string } };
+    return data.data.message_id;
+  }
+
   async updateCard(messageId: string, card: object): Promise<void> {
     const token = await this.getToken();
     await fetch(`${this.baseUrl}/open-apis/im/v1/messages/${messageId}`, {

package/src/index.ts

@@ -1,43 +1,34 @@
 import { FeishuClient } from './feishu-client.js';
-import { buildProgressCard } from './card-builder.js';
-import { sessionStore } from './session-store.js';
-import type { StepEntry } from './session-store.js';
 
-// ── 注入到系统提示的 Skill 说明 ──────────────────────────────────────────────
-const SKILL_PROMPT = `
-## 任务进度报告规范（report_progress 工具）
-
-当你需要执行包含 **3 个或以上独立工具调用** 的复杂任务时，必须遵守以下规范：
+// 常见工具名称中文映射
+const TOOL_LABEL: Record<string, string> = {
+  read_file: '读取文件',
+  write_file: '写入文件',
+  list_directory: '浏览目录',
+  bash: '执行命令',
+  web_search: '网络搜索',
+  tavily_search: '网络搜索',
+  web_fetch: '抓取网页',
+  computer: '操作电脑',
+  screenshot: '截图',
+  str_replace_editor: '编辑文件',
+  create_file: '创建文件',
+  delete_file: '删除文件',
+};
 
-1. **任务最开始**：调用 \`report_progress\`，提供完整的 \`allSteps\` 步骤列表、\`stepIndex: 1\`、当前步骤描述
-2. **每个主要步骤开始前**：调用 \`report_progress\` 更新 \`stepIndex\` 和 \`step\`
-3. **所有步骤完成后**：调用 \`report_progress\` 并设置 \`done: true\`
+function toolLabel(name: string): string {
+  return TOOL_LABEL[name] ?? name;
+}
 
-规则：
-- \`allSteps\` 只在第一次调用时传入，后续调用省略
-- \`step\` 应简洁，10 字以内
-- 不要等待 \`report_progress\` 的返回结果影响主任务，它只是通知机制
-`.trim();
+// sessionKey → conversationId（飞书 chat_id）
+const sessionChatMap = new Map<string, string>();
 
-// ── 插件定义 ─────────────────────────────────────────────────────────────────
 export default {
   id: 'feishu-progress',
 
   register(api: any) {
-    const cfg = api.config ?? {};
-    const client = new FeishuClient({
-      appId: cfg.appId,
-      appSecret: cfg.appSecret,
-      domain: cfg.domain ?? 'feishu',
-    });
-
-    // 将 Skill 说明注入系统提示（before_prompt_build 是稳定的生命周期钩子）
-    api.on('before_prompt_build', async (event: any) => {
-      event.appendSystemSection?.('feishu-progress-skill', SKILL_PROMPT);
-    });
+    const cfg = api.pluginConfig ?? {};
 
-    // 注册 report_progress 工具
-    // 凭据未配置时跳过工具注册，避免运行时 crash
     if (!cfg.appId || !cfg.appSecret) {
       api.logger?.warn(
         '[feishu-progress] appId / appSecret 未配置，进度卡片功能已禁用。\n' +
@@ -49,126 +40,38 @@ export default {
       return;
     }
 
-    api.registerTool((ctx: any) => ({
-      name: 'report_progress',
-      description:
-        '向飞书发送或更新任务进度卡片。在每个关键步骤开始前调用，让用户实时了解任务进展。',
-      inputSchema: {
-        type: 'object',
-        properties: {
-          step: {
-            type: 'string',
-            description: '当前正在执行的步骤描述（简洁，10 字以内）',
-          },
-          stepIndex: {
-            type: 'number',
-            description: '当前第几步（从 1 开始）',
-          },
-          totalSteps: {
-            type: 'number',
-            description: '本次任务的总步骤数',
-          },
-          allSteps: {
-            type: 'array',
-            items: { type: 'string' },
-            description: '所有步骤名称列表，仅首次调用时传入',
-          },
-          done: {
-            type: 'boolean',
-            description: '是否所有步骤已全部完成，完成时设为 true',
-          },
-        },
-        required: ['step', 'stepIndex', 'totalSteps'],
-      },
-
-      execute: async (input: {
-        step: string;
-        stepIndex: number;
-        totalSteps: number;
-        allSteps?: string[];
-        done?: boolean;
-      }) => {
-        // 优先取飞书 chat_id（兼容不同版本的 ctx 字段名）
-        const chatId: string | undefined =
-          ctx.channelMeta?.chatId ??
-          ctx.channelMeta?.chat_id ??
-          ctx.channelContext?.chatId ??
-          ctx.chatId;
-
-        if (!chatId) {
-          return { ok: false, reason: '无法获取飞书 chat_id，跳过进度更新' };
-        }
-
-        // minSteps 未达到时静默跳过
-        const minSteps: number = cfg.minSteps ?? 3;
-        if (input.totalSteps < minSteps) {
-          return { ok: true, skipped: true };
-        }
-
-        const sessionKey = `${chatId}:${ctx.sessionKey ?? ctx.runId ?? 'default'}`;
-        const existing = sessionStore.get(sessionKey);
-
-        // 构造步骤状态列表
-        let steps: StepEntry[];
-        if (!existing) {
-          // 首次调用：用 allSteps 或自动生成占位标签
-          const labels: string[] =
-            input.allSteps ??
-            Array.from({ length: input.totalSteps }, (_, i) =>
-              i + 1 === input.stepIndex ? input.step : `步骤 ${i + 1}`
-            );
-          steps = labels.map((label, i) => ({
-            label,
-            status:
-              i + 1 < input.stepIndex
-                ? 'done'
-                : i + 1 === input.stepIndex
-                  ? 'active'
-                  : 'pending',
-          }));
-        } else {
-          // 后续调用：更新已有步骤状态
-          steps = existing.steps.map((s, i) => ({
-            ...s,
-            status:
-              i + 1 < input.stepIndex
-                ? 'done'
-                : i + 1 === input.stepIndex && !input.done
-                  ? 'active'
-                  : 'pending',
-          }));
-        }
-
-        // done=true 时所有步骤标为 done
-        if (input.done) {
-          steps = steps.map((s) => ({ ...s, status: 'done' as const }));
-        }
-
-        const startTime = existing?.startTime ?? Date.now();
-        const card = buildProgressCard(
-          { stepIndex: input.stepIndex, totalSteps: input.totalSteps, done: input.done },
-          { steps, startTime }
-        );
+    const client = new FeishuClient({
+      appId: cfg.appId,
+      appSecret: cfg.appSecret,
+      domain: cfg.domain ?? 'feishu',
+    });
 
-        try {
-          if (!existing) {
-            const msgId = await client.sendCard(chatId, card);
-            sessionStore.set(sessionKey, { msgId, chatId, startTime, steps });
-          } else {
-            await client.updateCard(existing.msgId, card);
-            sessionStore.set(sessionKey, { ...existing, steps });
-          }
+    // ── 1. 收到用户消息时，记录当前会话对应的飞书 chat_id ────────────────────
+    api.on('message_received', async (_event: any, ctx: any) => {
+      if (ctx.channelId !== 'feishu') return;
+      if (!ctx.conversationId) return;
+      const key = ctx.sessionKey ?? ctx.accountId ?? 'default';
+      sessionChatMap.set(key, ctx.conversationId);
+    });
 
-          // 任务完成后 30s 清理 session，避免内存泄漏
-          if (input.done) {
-            setTimeout(() => sessionStore.delete(sessionKey), 30_000);
-          }
+    // ── 2. 每次工具调用前，自动推送进度到飞书 ──────────────────────────────
+    api.on('before_tool_call', async (event: any, ctx: any) => {
+      const key = ctx.sessionKey ?? 'default';
+      const chatId = sessionChatMap.get(key);
+      if (!chatId) return;
+
+      const label = toolLabel(event.toolName);
+      try {
+        await client.sendText(chatId, `🔧 正在执行：${label}`);
+      } catch (err: any) {
+        api.logger?.warn(`[feishu-progress] 推送失败: ${err?.message}`);
+      }
+    });
 
-          return { ok: true };
-        } catch (err: any) {
-          return { ok: false, reason: err?.message ?? String(err) };
-        }
-      },
-    }));
+    // ── 3. 任务结束后清理 session 映射 ───────────────────────────────────────
+    api.on('agent_end', async (_event: any, ctx: any) => {
+      const key = ctx.sessionKey ?? 'default';
+      sessionChatMap.delete(key);
+    });
   },
 };