feishu-openclaw 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Alex Yang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,107 @@
+# feishu-openclaw
+
+[![npm version](https://img.shields.io/npm/v/feishu-openclaw.svg)](https://www.npmjs.com/package/feishu-openclaw)
+
+> **🆕 2025.1.31 更新**：v0.2.0 多版本兼容，修复 Zod schema 问题，支持 Clawdbot / OpenClaw
+
+让 AI 助手接入飞书，无需服务器。  
+Connect your AI assistant to Feishu (Lark) — no server required.
+
+---
+
+## 🚀 三种安装方式 / Three Install Methods
+
+| 方式 | 命令 | 适合 | 链接 |
+|------|------|------|------|
+| **① Clawdbot 一键** | 告诉 Clawdbot：`帮我安装飞书插件` | 新手首选 | — |
+| **② npm 插件** ⬅️ | `clawdbot plugins install feishu-openclaw` | 开发者 | [npm](https://www.npmjs.com/package/feishu-openclaw) |
+| **③ 独立桥接** | `git clone` + 手动启动 | 生产/隔离 | [GitHub](https://github.com/AlexAnys/feishu-openclaw) |
+
+### 方式对比 / Comparison
+
+| | 插件 (①②) | 桥接 (③) |
+|---|---|---|
+| 进程数 | 1 个（内置 Gateway） | 2 个（独立进程） |
+| 崩溃影响 | 影响 Gateway | 互不影响 |
+| 配置方式 | `clawdbot config` | 环境变量 |
+| 适合场景 | 日常使用 | 生产/隔离部署 |
+
+---
+
+## 📋 你必须做的事 / What You Must Do
+
+### 1. 创建飞书机器人 / Create Feishu Bot
+
+1. [飞书开放平台](https://open.feishu.cn/app) → 创建企业自建应用
+2. 添加「机器人」能力
+3. **权限配置** — 开启：
+   - `im:message`
+   - `im:message.group_at_msg`
+   - `im:message.p2p_msg`
+4. **事件订阅** → `im.message.receive_v1` → ⚠️ **选「长连接」不是 webhook**
+5. 版本管理 → 创建版本 → 发布上线
+6. 记下 **App ID** (`cli_xxx`) 和 **App Secret**
+
+### 2. 配置 / Configure
+
+```bash
+clawdbot config set channels.feishu.enabled true --json
+clawdbot config set channels.feishu.appId "cli_你的AppID"
+clawdbot config set channels.feishu.appSecret "你的AppSecret"
+clawdbot gateway restart
+```
+
+### 3. 测试 / Test
+
+去飞书私聊或群里 @机器人 🎉
+
+---
+
+## ⚠️ 常见问题 / Troubleshooting
+
+### 收不到消息？ / Not receiving messages?
+
+| 检查项 | Check |
+|--------|-------|
+| 应用已发布（不是草稿） | App is published (not draft) |
+| 事件订阅用「长连接」 | Event uses "long connection" |
+| 权限都已开启 | All permissions enabled |
+
+### 报错 `not configured`？
+
+**必须用 `appSecret`，不是 `appSecretPath`**：
+
+```bash
+# ✅ 正确
+clawdbot config set channels.feishu.appSecret "你的secret"
+
+# ❌ 错误 — 插件不支持
+clawdbot config set channels.feishu.appSecretPath "/path/to/file"
+```
+
+### 群聊不回复？ / No response in groups?
+
+@机器人，或消息末尾加问号。
+
+---
+
+## 特点 / Features
+
+- **无需服务器** — WebSocket 长连接
+- **私聊+群聊** — 都支持
+- **图片文件** — 收发都行
+- **多账号** — 可同时接多个机器人
+
+---
+
+## 链接 / Links
+
+- 📦 [npm: feishu-openclaw](https://www.npmjs.com/package/feishu-openclaw)
+- 🔌 [GitHub: feishu-openclaw](https://github.com/AlexAnys/feishu-openclaw) (插件)
+- 🌉 [GitHub: feishu-openclaw](https://github.com/AlexAnys/feishu-openclaw) (桥接)
+- 📖 [Clawdbot 文档](https://docs.clawd.bot)
+- 🐛 [问题反馈](https://github.com/AlexAnys/feishu-openclaw/issues)
+
+## License
+
+MIT

package/clawdbot.plugin.json

@@ -0,0 +1,12 @@
+{
+  "id": "moltbot-feishu",
+  "name": "Feishu",
+  "description": "Feishu (飞书/Lark) channel plugin — WebSocket long-connection bot",
+  "version": "0.1.0",
+  "channels": ["feishu"],
+  "configSchema": {
+    "type": "object",
+    "additionalProperties": false,
+    "properties": {}
+  }
+}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Feishu (Lark) channel plugin for Clawdbot/Moltbot.
+ *
+ * Connects Feishu bots via WebSocket long-connection (no public server required).
+ */
+import type { ClawdbotPluginApi } from "clawdbot/plugin-sdk";
+declare const plugin: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: unknown;
+    register(api: ClawdbotPluginApi): void;
+};
+export default plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAO7D,QAAA,MAAM,MAAM;;;;;kBASI,iBAAiB;CAIhC,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -0,0 +1,22 @@
+/**
+ * Feishu (Lark) channel plugin for Clawdbot/Moltbot.
+ *
+ * Connects Feishu bots via WebSocket long-connection (no public server required).
+ */
+import { emptyPluginConfigSchema } from "clawdbot/plugin-sdk";
+import { feishuDock, feishuPlugin } from "./src/channel.js";
+import { setFeishuRuntime } from "./src/runtime.js";
+const plugin = {
+    id: "moltbot-feishu",
+    name: "Feishu",
+    description: "Feishu (Lark) channel plugin — WebSocket long-connection bot",
+    // This plugin registers a channel whose config lives under channels.feishu.*.
+    // Plugin-level config (plugins.entries.*.config) is intentionally empty.
+    configSchema: emptyPluginConfigSchema(),
+    register(api) {
+        setFeishuRuntime(api.runtime);
+        api.registerChannel({ plugin: feishuPlugin, dock: feishuDock });
+    },
+};
+export default plugin;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAE9D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,MAAM,MAAM,GAAG;IACb,EAAE,EAAE,gBAAgB;IACpB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,8DAA8D;IAE3E,8EAA8E;IAC9E,yEAAyE;IACzE,YAAY,EAAE,uBAAuB,EAAE;IAEvC,QAAQ,CAAC,GAAsB;QAC7B,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,GAAG,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;IAClE,CAAC;CACF,CAAC;AAEF,eAAe,MAAM,CAAC"}

package/dist/src/accounts.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Feishu account resolution — multi-account support.
+ */
+import type { ClawdbotConfig } from "clawdbot/plugin-sdk";
+import type { ResolvedFeishuAccount } from "./types.js";
+/** List all configured Feishu account IDs (falls back to ["default"]). */
+export declare function listFeishuAccountIds(cfg: ClawdbotConfig): string[];
+/** Resolve the default account ID. */
+export declare function resolveDefaultFeishuAccountId(cfg: ClawdbotConfig): string;
+/** Fully resolve a Feishu account. */
+export declare function resolveFeishuAccount(params: {
+    cfg: ClawdbotConfig;
+    accountId?: string | null;
+}): ResolvedFeishuAccount;
+/** List all enabled Feishu accounts. */
+export declare function listEnabledFeishuAccounts(cfg: ClawdbotConfig): ResolvedFeishuAccount[];
+//# sourceMappingURL=accounts.d.ts.map

package/dist/src/accounts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.d.ts","sourceRoot":"","sources":["../../src/accounts.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAG1D,OAAO,KAAK,EAGV,qBAAqB,EACtB,MAAM,YAAY,CAAC;AAQpB,0EAA0E;AAC1E,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,EAAE,CAIlE;AAED,sCAAsC;AACtC,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,CAMzE;AA2CD,sCAAsC;AACtC,wBAAgB,oBAAoB,CAAC,MAAM,EAAE;IAC3C,GAAG,EAAE,cAAc,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,GAAG,qBAAqB,CAiBxB;AAED,wCAAwC;AACxC,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,cAAc,GAAG,qBAAqB,EAAE,CAItF"}

package/dist/src/accounts.js

@@ -0,0 +1,81 @@
+/**
+ * Feishu account resolution — multi-account support.
+ */
+import { DEFAULT_ACCOUNT_ID, normalizeAccountId } from "clawdbot/plugin-sdk";
+function listConfiguredAccountIds(cfg) {
+    const accounts = cfg.channels?.feishu?.accounts;
+    if (!accounts || typeof accounts !== "object")
+        return [];
+    return Object.keys(accounts).filter(Boolean);
+}
+/** List all configured Feishu account IDs (falls back to ["default"]). */
+export function listFeishuAccountIds(cfg) {
+    const ids = listConfiguredAccountIds(cfg);
+    if (ids.length === 0)
+        return [DEFAULT_ACCOUNT_ID];
+    return ids.sort((a, b) => a.localeCompare(b));
+}
+/** Resolve the default account ID. */
+export function resolveDefaultFeishuAccountId(cfg) {
+    const feishuConfig = cfg.channels?.feishu;
+    if (feishuConfig?.defaultAccount?.trim())
+        return feishuConfig.defaultAccount.trim();
+    const ids = listFeishuAccountIds(cfg);
+    if (ids.includes(DEFAULT_ACCOUNT_ID))
+        return DEFAULT_ACCOUNT_ID;
+    return ids[0] ?? DEFAULT_ACCOUNT_ID;
+}
+function resolveAccountConfig(cfg, accountId) {
+    const accounts = cfg.channels?.feishu?.accounts;
+    if (!accounts || typeof accounts !== "object")
+        return undefined;
+    return accounts[accountId];
+}
+function mergeFeishuAccountConfig(cfg, accountId) {
+    const raw = (cfg.channels?.feishu ?? {});
+    const { accounts: _ignored, defaultAccount: _ignored2, ...base } = raw;
+    const account = resolveAccountConfig(cfg, accountId) ?? {};
+    return { ...base, ...account };
+}
+/**
+ * Resolve appId + appSecret for an account.
+ * Checks: account config → base config → plugin config.
+ */
+function resolveCredentials(cfg, merged) {
+    // From channel config
+    if (merged.appId?.trim() && merged.appSecret?.trim()) {
+        return { appId: merged.appId.trim(), appSecret: merged.appSecret.trim(), source: "config" };
+    }
+    // From plugin config (plugins.entries.feishu.config)
+    const pluginCfg = cfg.plugins;
+    const feishuPluginCfg = pluginCfg?.entries?.feishu?.config;
+    if (feishuPluginCfg?.appId?.trim() && feishuPluginCfg?.appSecret?.trim()) {
+        return { appId: feishuPluginCfg.appId.trim(), appSecret: feishuPluginCfg.appSecret.trim(), source: "plugin" };
+    }
+    return { appId: "", appSecret: "", source: "none" };
+}
+/** Fully resolve a Feishu account. */
+export function resolveFeishuAccount(params) {
+    const accountId = normalizeAccountId(params.accountId);
+    const baseEnabled = params.cfg.channels?.feishu?.enabled !== false;
+    const merged = mergeFeishuAccountConfig(params.cfg, accountId);
+    const accountEnabled = merged.enabled !== false;
+    const enabled = baseEnabled && accountEnabled;
+    const creds = resolveCredentials(params.cfg, merged);
+    return {
+        accountId,
+        name: merged.name?.trim() || undefined,
+        enabled,
+        appId: creds.appId,
+        appSecret: creds.appSecret,
+        tokenSource: creds.source,
+        config: merged,
+    };
+}
+/** List all enabled Feishu accounts. */
+export function listEnabledFeishuAccounts(cfg) {
+    return listFeishuAccountIds(cfg)
+        .map((accountId) => resolveFeishuAccount({ cfg, accountId }))
+        .filter((account) => account.enabled);
+}
+//# sourceMappingURL=accounts.js.map

package/dist/src/accounts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"accounts.js","sourceRoot":"","sources":["../../src/accounts.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAQ7E,SAAS,wBAAwB,CAAC,GAAmB;IACnD,MAAM,QAAQ,GAAI,GAAG,CAAC,QAAQ,EAAE,MAAmC,EAAE,QAAQ,CAAC;IAC9E,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,EAAE,CAAC;IACzD,OAAO,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC/C,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,oBAAoB,CAAC,GAAmB;IACtD,MAAM,GAAG,GAAG,wBAAwB,CAAC,GAAG,CAAC,CAAC;IAC1C,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAClD,OAAO,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,6BAA6B,CAAC,GAAmB;IAC/D,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,EAAE,MAAkC,CAAC;IACtE,IAAI,YAAY,EAAE,cAAc,EAAE,IAAI,EAAE;QAAE,OAAO,YAAY,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IACpF,MAAM,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC;IACtC,IAAI,GAAG,CAAC,QAAQ,CAAC,kBAAkB,CAAC;QAAE,OAAO,kBAAkB,CAAC;IAChE,OAAO,GAAG,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC;AACtC,CAAC;AAED,SAAS,oBAAoB,CAC3B,GAAmB,EACnB,SAAiB;IAEjB,MAAM,QAAQ,GAAI,GAAG,CAAC,QAAQ,EAAE,MAAmC,EAAE,QAAQ,CAAC;IAC9E,IAAI,CAAC,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChE,OAAO,QAAQ,CAAC,SAAS,CAAoC,CAAC;AAChE,CAAC;AAED,SAAS,wBAAwB,CAAC,GAAmB,EAAE,SAAiB;IACtE,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAiB,CAAC;IACzD,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,cAAc,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,GAAG,CAAC;IACvE,MAAM,OAAO,GAAG,oBAAoB,CAAC,GAAG,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC;IAC3D,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC;AACjC,CAAC;AAED;;;GAGG;AACH,SAAS,kBAAkB,CACzB,GAAmB,EACnB,MAA2B;IAE3B,sBAAsB;IACtB,IAAI,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,MAAM,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC;QACrD,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAC9F,CAAC;IAED,qDAAqD;IACrD,MAAM,SAAS,GAAI,GAA+B,CAAC,OAEtC,CAAC;IACd,MAAM,eAAe,GAAG,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC;IAC3D,IAAI,eAAe,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,eAAe,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,CAAC;QACzE,OAAO,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,eAAe,CAAC,SAAS,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;IAChH,CAAC;IAED,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACtD,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,oBAAoB,CAAC,MAGpC;IACC,MAAM,SAAS,GAAG,kBAAkB,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACvD,MAAM,WAAW,GAAI,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAmC,EAAE,OAAO,KAAK,KAAK,CAAC;IACjG,MAAM,MAAM,GAAG,wBAAwB,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAC/D,MAAM,cAAc,GAAG,MAAM,CAAC,OAAO,KAAK,KAAK,CAAC;IAChD,MAAM,OAAO,GAAG,WAAW,IAAI,cAAc,CAAC;IAC9C,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAErD,OAAO;QACL,SAAS;QACT,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,SAAS;QACtC,OAAO;QACP,KAAK,EAAE,KAAK,CAAC,KAAK;QAClB,SAAS,EAAE,KAAK,CAAC,SAAS;QAC1B,WAAW,EAAE,KAAK,CAAC,MAAM;QACzB,MAAM,EAAE,MAAM;KACf,CAAC;AACJ,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,yBAAyB,CAAC,GAAmB;IAC3D,OAAO,oBAAoB,CAAC,GAAG,CAAC;SAC7B,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;SAC5D,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1C,CAAC"}

package/dist/src/channel.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Feishu ChannelPlugin + ChannelDock — core channel integration.
+ */
+import type { ChannelDock, ChannelPlugin } from "clawdbot/plugin-sdk";
+import type { ResolvedFeishuAccount } from "./types.js";
+export declare const feishuDock: ChannelDock;
+export declare const feishuPlugin: ChannelPlugin<ResolvedFeishuAccount>;
+//# sourceMappingURL=channel.d.ts.map

package/dist/src/channel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.d.ts","sourceRoot":"","sources":["../../src/channel.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAEV,WAAW,EACX,aAAa,EAEd,MAAM,qBAAqB,CAAC;AAkB7B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAsCxD,eAAO,MAAM,UAAU,EAAE,WA0BxB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,aAAa,CAAC,qBAAqB,CAsU7D,CAAC"}