opencode-chat-channel 1.0.0

package/README.md

@@ -0,0 +1,298 @@
+# opencode-chat-channel
+
+An [opencode](https://opencode.ai) plugin that connects your Feishu (Lark) bot to opencode via **WebSocket long connection** — no public IP required.
+
+[中文说明](#中文说明) · [English](#english)
+
+---
+
+## English
+
+### How It Works
+
+```
+Feishu User sends message
+    ↓ WebSocket long connection
+Feishu Open Platform
+    ↓ @larksuiteoapi/node-sdk WSClient
+chat-channel plugin (this repo)
+    ↓ client.session.prompt()
+opencode AI (Sisyphus)
+    ↓ text reply
+Feishu User receives reply
+```
+
+- Each Feishu user (`open_id`) gets their own persistent opencode session
+- Sessions expire after 2 hours of inactivity (auto-cleanup)
+- Replies longer than 4000 characters are automatically split into multiple messages
+
+---
+
+### Quick Install (Recommended)
+
+Run this single command in your terminal:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/coneycode/opencode-chat-channel/main/install.sh | bash
+```
+
+The installer will:
+1. Download the plugin to `~/.config/opencode/plugins/chat-channel.ts`
+2. Add `@larksuiteoapi/node-sdk` to `~/.config/opencode/package.json`
+3. Run `bun install` to install dependencies
+4. Prompt you for your Feishu **App ID** (saved to `.env`) and **App Secret** (saved to macOS Keychain)
+
+After installation, start opencode and you should see:
+```
+[chat-channel] 飞书机器人已启动（长连接模式），appId=cli_xxx***
+```
+
+> **Requirements**: `bun` and `curl` must be installed. macOS is required for Keychain-based secret storage.
+
+---
+
+### Manual Installation
+
+1. **Copy the plugin file** to your opencode plugins directory:
+
+```bash
+cp src/index.ts ~/.config/opencode/plugins/chat-channel.ts
+```
+
+2. **Add the dependency** to `~/.config/opencode/package.json`:
+
+```json
+{
+  "dependencies": {
+    "@larksuiteoapi/node-sdk": "^1.37.0"
+  }
+}
+```
+
+Then run `bun install` in `~/.config/opencode/`.
+
+### Configuration
+
+#### Step 1: Create a Feishu Self-Built App
+
+1. Visit [Feishu Open Platform](https://open.feishu.cn/app) and create a **self-built app**
+2. Note your **App ID** and **App Secret**
+3. Under "Add App Capabilities", enable **Bot**
+4. Under "Permissions", add:
+   - `im:message` (read/send messages)
+   - `im:message.group_at_msg` (receive group @ messages, optional)
+5. Under "Event Subscriptions":
+   - Select **"Use long connection to receive events"** (no webhook URL needed)
+   - Add event: `Receive Message v2.0` (`im.message.receive_v1`)
+6. Publish the app version
+
+#### Step 2: Store Credentials
+
+**App ID** (non-sensitive, store in `.env`):
+
+```bash
+# ~/.config/opencode/.env
+FEISHU_APP_ID=cli_xxxxxxxxxxxxxxxx
+
+# Optional: custom opencode API URL (default: http://localhost:4321)
+# OPENCODE_BASE_URL=http://localhost:4321
+```
+
+**App Secret** (sensitive, store in macOS Keychain):
+
+```bash
+security add-generic-password -a chat-channel -s opencode-chat-channel -w <your-app-secret> -U
+```
+
+Verify:
+
+```bash
+security find-generic-password -a chat-channel -s opencode-chat-channel -w
+```
+
+#### Step 3: Start opencode
+
+```bash
+opencode
+```
+
+You should see in the logs:
+
+```
+[chat-channel] 飞书机器人已启动（长连接模式），appId=cli_xxx***
+```
+
+### File Structure
+
+```
+~/.config/opencode/
+├── plugins/
+│   └── chat-channel.ts    # plugin file (copied from src/index.ts)
+├── package.json          # dependencies (add @larksuiteoapi/node-sdk)
+└── .env                  # FEISHU_APP_ID (App Secret in Keychain)
+```
+
+### FAQ
+
+**Q: Plugin starts but bot receives no messages**
+- Ensure event subscription is set to "long connection", not "HTTP callback URL"
+- Ensure the app version is published and online
+- Verify App ID / Secret are correct
+
+**Q: Replies are slow**
+- AI processing takes time; complex tasks may need 10–30 seconds
+- Simple conversations typically 3–8 seconds
+
+**Q: How to reset conversation history**
+- Restart opencode (sessions follow process lifecycle)
+- Or wait 2 hours for session TTL to expire
+
+---
+
+## 中文说明
+
+### 工作原理
+
+```
+飞书用户发消息
+    ↓ WebSocket 长连接
+飞书开放平台
+    ↓ @larksuiteoapi/node-sdk WSClient
+chat-channel 插件（本仓库）
+    ↓ client.session.prompt()
+opencode AI (Sisyphus)
+    ↓ 回复文本
+飞书用户
+```
+
+- 每个飞书用户（`open_id`）独享一个 opencode session，**对话历史持久保留**
+- session 闲置 2 小时后自动回收，下次对话开新 session
+- AI 回复超过 4000 字时自动分段发送
+
+---
+
+### 一键安装（推荐）
+
+在终端执行以下命令：
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/coneycode/opencode-chat-channel/main/install.sh | bash
+```
+
+安装程序会自动完成：
+1. 下载插件文件到 `~/.config/opencode/plugins/chat-channel.ts`
+2. 将 `@larksuiteoapi/node-sdk` 添加到 `~/.config/opencode/package.json`
+3. 执行 `bun install` 安装依赖
+4. 交互式询问你的 **App ID**（保存到 `.env`）和 **App Secret**（保存到 macOS 钥匙串）
+
+安装完成后，启动 opencode 即可看到：
+```
+[chat-channel] 飞书机器人已启动（长连接模式），appId=cli_xxx***
+```
+
+> **前置条件**：需要已安装 `bun` 和 `curl`；App Secret 安全存储依赖 macOS 钥匙串。
+
+---
+
+### 手动安装
+### 安装
+
+1. **复制插件文件** 到 opencode 插件目录：
+
+```bash
+cp src/index.ts ~/.config/opencode/plugins/chat-channel.ts
+```
+
+2. **添加依赖** 到 `~/.config/opencode/package.json`：
+
+```json
+{
+  "dependencies": {
+    "@larksuiteoapi/node-sdk": "^1.37.0"
+  }
+}
+```
+
+然后在 `~/.config/opencode/` 目录运行 `bun install`。
+
+### 配置步骤
+
+#### 第一步：创建飞书自建应用
+
+1. 访问 [飞书开放平台](https://open.feishu.cn/app)，新建**企业自建应用**
+2. 记录 **App ID** 和 **App Secret**
+3. 在「添加应用能力」中开启**机器人**
+4. 在「权限管理」中添加以下权限：
+   - `im:message`（读取/发送消息）
+   - `im:message.group_at_msg`（接收群组 @ 消息，按需）
+5. 在「事件订阅」中：
+   - 选择**使用长连接接收事件**（无需填写请求地址）
+   - 添加事件：`接收消息 v2.0`（即 `im.message.receive_v1`）
+6. 发布应用版本
+
+#### 第二步：写入凭证
+
+**App ID**（非敏感，明文存 `.env`）：
+
+```bash
+# ~/.config/opencode/.env
+FEISHU_APP_ID=cli_xxxxxxxxxxxxxxxx
+
+# 可选：自定义 opencode API 地址（默认： http://localhost:4321）
+# OPENCODE_BASE_URL=http://localhost:4321
+```
+
+**App Secret**（敏感，存 macOS Keychain，不落盘明文）：
+
+```bash
+security add-generic-password -a chat-channel -s opencode-chat-channel -w <你的AppSecret> -U
+```
+
+验证写入是否成功：
+
+```bash
+security find-generic-password -a chat-channel -s opencode-chat-channel -w
+```
+
+#### 第三步：启动 opencode
+
+```bash
+opencode
+```
+
+启动后日志中会看到：
+
+```
+[chat-channel] 飞书机器人已启动（长连接模式），appId=cli_xxx***
+```
+
+### 文件位置
+
+```
+~/.config/opencode/
+├── plugins/
+│   └── chat-channel.ts    # 插件主文件（从 src/index.ts 复制）
+├── package.json          # 依赖（含 @larksuiteoapi/node-sdk）
+└── .env                  # 环境变量（FEISHU_APP_ID；App Secret 存 Keychain）
+```
+
+### 常见问题
+
+**Q: 插件启动后收不到消息**
+- 确认飞书应用事件订阅选择的是「长连接」而非「HTTP 请求地址」
+- 确认应用已发布且版本已上线
+- 确认 App ID/Secret 正确
+
+**Q: 回复很慢**
+- AI 处理需要时间，复杂问题可能需要 10-30 秒
+- 简单对话通常 3-8 秒
+
+**Q: 想重置对话历史**
+- 关闭 opencode 重启即可（session 随进程生命周期）
+- 或等待 2 小时 session 超时自动重置
+
+---
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * opencode-chat-channel — opencode 飞书机器人插件
+ *
+ * 通过飞书长连接（WebSocket）接收消息，驱动 opencode AI 回复。
+ *
+ * 凭证存储方案（macOS Keychain）：
+ *   FEISHU_APP_ID 存放在 ~/.config/opencode/.env（非敏感，可见）
+ *   FEISHU_APP_SECRET 存放在系统钥匙串，service=opencode-chat-channel，account=chat-channel
+ *   写入命令：
+ *     security add-generic-password -a chat-channel -s opencode-chat-channel -w <secret> -U
+ *
+ * 每个飞书用户（open_id）独享一个 opencode session，对话历史保留。
+ */
+import type { Plugin } from "@opencode-ai/plugin";
+export declare const ChatChannelPlugin: Plugin;
+export default ChatChannelPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAgDlD,eAAO,MAAM,iBAAiB,EAAE,MAsR/B,CAAC;AAEF,eAAe,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,242 @@
+// src/index.ts
+import * as Lark from "@larksuiteoapi/node-sdk";
+import { execFileSync } from "child_process";
+import { readFileSync } from "fs";
+import { join } from "path";
+function loadDotEnv(envPath) {
+  try {
+    const content = readFileSync(envPath, "utf8");
+    for (const line of content.split(`
+`)) {
+      const trimmed = line.trim();
+      if (!trimmed || trimmed.startsWith("#"))
+        continue;
+      const eqIdx = trimmed.indexOf("=");
+      if (eqIdx < 1)
+        continue;
+      const key = trimmed.slice(0, eqIdx).trim();
+      const value = trimmed.slice(eqIdx + 1).trim();
+      if (!process.env[key]) {
+        process.env[key] = value;
+      }
+    }
+  } catch {}
+}
+var SESSION_TTL_MS = 2 * 60 * 60 * 1000;
+var OPENCODE_BASE_URL = process.env["OPENCODE_BASE_URL"] ?? "http://localhost:4321";
+var ChatChannelPlugin = async ({ client }) => {
+  const configDir = join(process.env["HOME"] ?? "/Users/" + (process.env["USER"] ?? "unknown"), ".config", "opencode");
+  loadDotEnv(join(configDir, ".env"));
+  const appId = process.env["FEISHU_APP_ID"];
+  let appSecret;
+  try {
+    const stdout = execFileSync("security", [
+      "find-generic-password",
+      "-a",
+      "chat-channel",
+      "-s",
+      "opencode-chat-channel",
+      "-w"
+    ], { encoding: "utf8" });
+    appSecret = stdout.trim() || undefined;
+  } catch {
+    appSecret = undefined;
+  }
+  if (!appId || !appSecret) {
+    await client.app.log({
+      body: {
+        service: "chat-channel",
+        level: "warn",
+        message: !appId ? "FEISHU_APP_ID 未设置（请在 .env 中添加），飞书机器人插件已跳过" : "FEISHU_APP_SECRET 未找到（请写入 Keychain），飞书机器人插件已跳过"
+      }
+    });
+    return {};
+  }
+  const larkClient = new Lark.Client({
+    appId,
+    appSecret,
+    appType: Lark.AppType.SelfBuild,
+    domain: Lark.Domain.Feishu
+  });
+  const userSessions = new Map;
+  const processedMessages = new Set;
+  const MAX_PROCESSED = 500;
+  async function getOrCreateSession(openId) {
+    const existing = userSessions.get(openId);
+    const now = Date.now();
+    if (existing && now - existing.lastActivity < SESSION_TTL_MS) {
+      existing.lastActivity = now;
+      return existing.sessionId;
+    }
+    const res = await client.session.create({
+      body: { title: `飞书对话 · ${openId}` }
+    });
+    const sessionId = res.data.id;
+    userSessions.set(openId, { sessionId, lastActivity: now });
+    await client.app.log({
+      body: {
+        service: "chat-channel",
+        level: "info",
+        message: `创建新 session: ${sessionId}`,
+        extra: { openId }
+      }
+    });
+    return sessionId;
+  }
+  function cleanupExpiredSessions() {
+    const now = Date.now();
+    for (const [openId, meta] of userSessions.entries()) {
+      if (now - meta.lastActivity > SESSION_TTL_MS) {
+        userSessions.delete(openId);
+      }
+    }
+  }
+  setInterval(cleanupExpiredSessions, 30 * 60 * 1000);
+  async function replyToFeishu(chatId, text) {
+    const MAX_LEN = 4000;
+    const chunks = [];
+    for (let i = 0;i < text.length; i += MAX_LEN) {
+      chunks.push(text.slice(i, i + MAX_LEN));
+    }
+    for (const chunk of chunks) {
+      await larkClient.im.message.create({
+        params: { receive_id_type: "chat_id" },
+        data: {
+          receive_id: chatId,
+          content: JSON.stringify({ text: chunk }),
+          msg_type: "text"
+        }
+      });
+    }
+  }
+  async function sendThinking(chatId) {
+    await larkClient.im.message.create({
+      params: { receive_id_type: "chat_id" },
+      data: {
+        receive_id: chatId,
+        content: JSON.stringify({ text: "⏳ 正在思考..." }),
+        msg_type: "text"
+      }
+    });
+  }
+  function extractResponseText(parts) {
+    if (!Array.isArray(parts))
+      return "";
+    return parts.filter((p) => p?.type === "text").map((p) => p?.text ?? "").join("").trim();
+  }
+  async function handleMessage(data) {
+    const { message, sender } = data;
+    if (message.message_type !== "text") {
+      await larkClient.im.message.create({
+        params: { receive_id_type: "chat_id" },
+        data: {
+          receive_id: message.chat_id,
+          content: JSON.stringify({ text: "暂时只支持文本消息 \uD83D\uDE0A" }),
+          msg_type: "text"
+        }
+      });
+      return;
+    }
+    const msgId = message.message_id;
+    if (processedMessages.has(msgId)) {
+      await client.app.log({
+        body: {
+          service: "chat-channel",
+          level: "info",
+          message: `重复消息已忽略: ${msgId}`
+        }
+      });
+      return;
+    }
+    if (processedMessages.size >= MAX_PROCESSED)
+      processedMessages.clear();
+    processedMessages.add(msgId);
+    let userText;
+    try {
+      userText = JSON.parse(message.content).text?.trim();
+    } catch {
+      return;
+    }
+    if (!userText)
+      return;
+    const openId = sender.sender_id?.open_id ?? message.chat_id;
+    const chatId = message.chat_id;
+    await client.app.log({
+      body: {
+        service: "chat-channel",
+        level: "info",
+        message: `收到消息: "${userText.slice(0, 80)}${userText.length > 80 ? "..." : ""}"`,
+        extra: { openId, chatId }
+      }
+    });
+    await sendThinking(chatId);
+    let responseText = null;
+    try {
+      const sessionId = await getOrCreateSession(openId);
+      const result = await client.session.prompt({
+        path: { id: sessionId },
+        body: {
+          parts: [{ type: "text", text: userText }],
+          model: {
+            providerID: "Mify-Anthropic",
+            modelID: "ppio/pa/claude-sonnet-4-6"
+          }
+        }
+      });
+      responseText = extractResponseText(result.data?.parts ?? []);
+    } catch (err) {
+      const errorMsg = err?.data?.message ?? err?.message ?? String(err);
+      await client.app.log({
+        body: {
+          service: "chat-channel",
+          level: "error",
+          message: `处理消息失败: ${errorMsg}`,
+          extra: { openId }
+        }
+      });
+      await replyToFeishu(chatId, `⚠️ 出错了：${errorMsg}`);
+      return;
+    }
+    if (responseText) {
+      await replyToFeishu(chatId, responseText);
+    } else {
+      await replyToFeishu(chatId, "（AI 没有返回文字回复）");
+    }
+  }
+  const wsClient = new Lark.WSClient({
+    appId,
+    appSecret,
+    loggerLevel: Lark.LoggerLevel.warn
+  });
+  wsClient.start({
+    eventDispatcher: new Lark.EventDispatcher({}).register({
+      "im.message.receive_v1": handleMessage
+    })
+  });
+  await client.app.log({
+    body: {
+      service: "chat-channel",
+      level: "info",
+      message: `飞书机器人已启动（长连接模式），appId=${appId.slice(0, 8)}***`
+    }
+  });
+  return {
+    event: async ({ event }) => {
+      if (event.type === "session.error") {
+        await client.app.log({
+          body: {
+            service: "chat-channel",
+            level: "warn",
+            message: "opencode session 出现错误",
+            extra: event.properties
+          }
+        });
+      }
+    }
+  };
+};
+var src_default = ChatChannelPlugin;
+export {
+  src_default as default,
+  ChatChannelPlugin
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "opencode-chat-channel",
+  "version": "1.0.0",
+  "description": "opencode plugin — Feishu (Lark) bot channel via WebSocket long connection",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "bun run build:clean && bun run build:js && bun run build:types",
+    "build:clean": "rm -rf dist",
+    "build:js": "bun build ./src/index.ts --outdir ./dist --target node --format esm --packages external",
+    "build:types": "bunx tsc -p tsconfig.build.json",
+    "prepublishOnly": "bun run build",
+    "prepack": "bun run build"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "feishu",
+    "lark",
+    "bot",
+    "websocket"
+  ],
+  "author": "",
+  "license": "MIT",
+  "dependencies": {
+    "@larksuiteoapi/node-sdk": "^1.37.0"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": "*"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "*",
+    "typescript": "^5.0.0"
+  },
+  "engines": {
+    "bun": ">=1.2.0"
+  }
+}