@nextclaw/channel-plugin-feishu 0.2.12 → 0.2.14

package/README.md

@@ -1,3 +1,5 @@
 # @nextclaw/channel-plugin-feishu
 
-Builtin NextClaw `feishu` channel plugin in OpenClaw-compatible format.
+NextClaw bundled Feishu/Lark channel plugin.
+
+This package vendors the Feishu-specific implementation from the official OpenClaw plugin, then runs it through the NextClaw OpenClaw-compat loader so NextClaw can expose Feishu chat, doc, wiki, drive, scopes, and bitable capabilities without taking a runtime dependency on the upstream plugin package.

package/index.ts

@@ -0,0 +1,65 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk/feishu";
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk/feishu";
+import { registerFeishuBitableTools } from "./src/bitable.js";
+import { feishuPlugin } from "./src/channel.js";
+import { registerFeishuChatTools } from "./src/chat.js";
+import { registerFeishuDocTools } from "./src/docx.js";
+import { registerFeishuDriveTools } from "./src/drive.js";
+import { registerFeishuPermTools } from "./src/perm.js";
+import { setFeishuRuntime } from "./src/runtime.js";
+import { registerFeishuWikiTools } from "./src/wiki.js";
+
+export { monitorFeishuProvider } from "./src/monitor.js";
+export {
+  sendMessageFeishu,
+  sendCardFeishu,
+  updateCardFeishu,
+  editMessageFeishu,
+  getMessageFeishu,
+} from "./src/send.js";
+export {
+  uploadImageFeishu,
+  uploadFileFeishu,
+  sendImageFeishu,
+  sendFileFeishu,
+  sendMediaFeishu,
+} from "./src/media.js";
+export { probeFeishu } from "./src/probe.js";
+export {
+  addReactionFeishu,
+  removeReactionFeishu,
+  listReactionsFeishu,
+  FeishuEmoji,
+} from "./src/reactions.js";
+export {
+  extractMentionTargets,
+  extractMessageBody,
+  isMentionForwardRequest,
+  formatMentionForText,
+  formatMentionForCard,
+  formatMentionAllForText,
+  formatMentionAllForCard,
+  buildMentionedMessage,
+  buildMentionedCardContent,
+  type MentionTarget,
+} from "./src/mention.js";
+export { feishuPlugin } from "./src/channel.js";
+
+const plugin = {
+  id: "feishu",
+  name: "Feishu",
+  description: "Feishu/Lark channel plugin",
+  configSchema: emptyPluginConfigSchema(),
+  register(api: OpenClawPluginApi) {
+    setFeishuRuntime(api.runtime);
+    api.registerChannel({ plugin: feishuPlugin });
+    registerFeishuDocTools(api);
+    registerFeishuChatTools(api);
+    registerFeishuWikiTools(api);
+    registerFeishuDriveTools(api);
+    registerFeishuPermTools(api);
+    registerFeishuBitableTools(api);
+  },
+};
+
+export default plugin;

package/openclaw.plugin.json

@@ -1,11 +1,7 @@
 {
-  "id": "builtin-channel-feishu",
-  "name": "Builtin Feishu Channel",
-  "description": "Builtin NextClaw channel plugin for feishu",
-  "version": "0.1.0",
-  "channels": [
-    "feishu"
-  ],
+  "id": "feishu",
+  "channels": ["feishu"],
+  "skills": ["./skills"],
   "configSchema": {
     "type": "object",
     "additionalProperties": false,

package/package.json

@@ -1,28 +1,52 @@
 {
   "name": "@nextclaw/channel-plugin-feishu",
-  "version": "0.2.12",
+  "version": "0.2.14",
   "private": false,
-  "description": "NextClaw Feishu channel plugin (OpenClaw-compatible)",
+  "description": "NextClaw Feishu/Lark channel plugin with doc/wiki/drive tools.",
   "type": "module",
   "exports": {
     ".": {
-      "default": "./index.js"
+      "default": "./index.ts"
     }
   },
   "files": [
-    "index.js",
+    "index.ts",
     "openclaw.plugin.json",
-    "README.md"
+    "README.md",
+    "skills",
+    "src"
   ],
   "openclaw": {
     "extensions": [
-      "index.js"
-    ]
+      "./index.ts"
+    ],
+    "channel": {
+      "id": "feishu",
+      "label": "Feishu",
+      "selectionLabel": "Feishu/Lark (飞书)",
+      "docsPath": "/channels/feishu",
+      "docsLabel": "feishu",
+      "blurb": "飞书/Lark enterprise messaging with doc/wiki/drive tools.",
+      "aliases": [
+        "lark"
+      ],
+      "order": 35,
+      "quickstartAllowFrom": true
+    },
+    "install": {
+      "npmSpec": "@nextclaw/channel-plugin-feishu",
+      "localPath": "packages/extensions/nextclaw-channel-plugin-feishu",
+      "defaultChoice": "npm"
+    }
   },
   "dependencies": {
-    "@nextclaw/channel-runtime": "0.2.12"
+    "@larksuiteoapi/node-sdk": "^1.59.0",
+    "@sinclair/typebox": "0.34.48",
+    "https-proxy-agent": "^8.0.0",
+    "openclaw": "2026.3.13",
+    "zod": "^4.3.6"
   },
   "scripts": {
-    "lint": "eslint index.js"
+    "lint": "eslint index.ts"
   }
 }

package/skills/feishu-doc/SKILL.md

@@ -0,0 +1,211 @@
+---
+name: feishu-doc
+description: |
+  Feishu document read/write operations. Activate when user mentions Feishu docs, cloud docs, or docx links.
+---
+
+# Feishu Document Tool
+
+Single tool `feishu_doc` with action parameter for all document operations, including table creation for Docx.
+
+## Token Extraction
+
+From URL `https://xxx.feishu.cn/docx/ABC123def` → `doc_token` = `ABC123def`
+
+## Actions
+
+### Read Document
+
+```json
+{ "action": "read", "doc_token": "ABC123def" }
+```
+
+Returns: title, plain text content, block statistics. Check `hint` field - if present, structured content (tables, images) exists that requires `list_blocks`.
+
+### Write Document (Replace All)
+
+```json
+{ "action": "write", "doc_token": "ABC123def", "content": "# Title\n\nMarkdown content..." }
+```
+
+Replaces entire document with markdown content. Supports: headings, lists, code blocks, quotes, links, images (`![](url)` auto-uploaded), bold/italic/strikethrough.
+
+**Limitation:** Markdown tables are NOT supported.
+
+### Append Content
+
+```json
+{ "action": "append", "doc_token": "ABC123def", "content": "Additional content" }
+```
+
+Appends markdown to end of document.
+
+### Create Document
+
+```json
+{ "action": "create", "title": "New Document", "owner_open_id": "ou_xxx" }
+```
+
+With folder:
+
+```json
+{
+  "action": "create",
+  "title": "New Document",
+  "folder_token": "fldcnXXX",
+  "owner_open_id": "ou_xxx"
+}
+```
+
+**Important:** Always pass `owner_open_id` with the requesting user's `open_id` (from inbound metadata `sender_id`) so the user automatically gets `full_access` permission on the created document. Without this, only the bot app has access.
+
+### List Blocks
+
+```json
+{ "action": "list_blocks", "doc_token": "ABC123def" }
+```
+
+Returns full block data including tables, images. Use this to read structured content.
+
+### Get Single Block
+
+```json
+{ "action": "get_block", "doc_token": "ABC123def", "block_id": "doxcnXXX" }
+```
+
+### Update Block Text
+
+```json
+{
+  "action": "update_block",
+  "doc_token": "ABC123def",
+  "block_id": "doxcnXXX",
+  "content": "New text"
+}
+```
+
+### Delete Block
+
+```json
+{ "action": "delete_block", "doc_token": "ABC123def", "block_id": "doxcnXXX" }
+```
+
+### Create Table (Docx Table Block)
+
+```json
+{
+  "action": "create_table",
+  "doc_token": "ABC123def",
+  "row_size": 2,
+  "column_size": 2,
+  "column_width": [200, 200]
+}
+```
+
+Optional: `parent_block_id` to insert under a specific block.
+
+### Write Table Cells
+
+```json
+{
+  "action": "write_table_cells",
+  "doc_token": "ABC123def",
+  "table_block_id": "doxcnTABLE",
+  "values": [
+    ["A1", "B1"],
+    ["A2", "B2"]
+  ]
+}
+```
+
+### Create Table With Values (One-step)
+
+```json
+{
+  "action": "create_table_with_values",
+  "doc_token": "ABC123def",
+  "row_size": 2,
+  "column_size": 2,
+  "column_width": [200, 200],
+  "values": [
+    ["A1", "B1"],
+    ["A2", "B2"]
+  ]
+}
+```
+
+Optional: `parent_block_id` to insert under a specific block.
+
+### Upload Image to Docx (from URL or local file)
+
+```json
+{
+  "action": "upload_image",
+  "doc_token": "ABC123def",
+  "url": "https://example.com/image.png"
+}
+```
+
+Or local path with position control:
+
+```json
+{
+  "action": "upload_image",
+  "doc_token": "ABC123def",
+  "file_path": "/tmp/image.png",
+  "parent_block_id": "doxcnParent",
+  "index": 5
+}
+```
+
+Optional `index` (0-based) inserts the image at a specific position among sibling blocks. Omit to append at end.
+
+**Note:** Image display size is determined by the uploaded image's pixel dimensions. For small images (e.g. 480x270 GIFs), scale to 800px+ width before uploading to ensure proper display.
+
+### Upload File Attachment to Docx (from URL or local file)
+
+```json
+{
+  "action": "upload_file",
+  "doc_token": "ABC123def",
+  "url": "https://example.com/report.pdf"
+}
+```
+
+Or local path:
+
+```json
+{
+  "action": "upload_file",
+  "doc_token": "ABC123def",
+  "file_path": "/tmp/report.pdf",
+  "filename": "Q1-report.pdf"
+}
+```
+
+Rules:
+
+- exactly one of `url` / `file_path`
+- optional `filename` override
+- optional `parent_block_id`
+
+## Reading Workflow
+
+1. Start with `action: "read"` - get plain text + statistics
+2. Check `block_types` in response for Table, Image, Code, etc.
+3. If structured content exists, use `action: "list_blocks"` for full data
+
+## Configuration
+
+```yaml
+channels:
+  feishu:
+    tools:
+      doc: true # default: true
+```
+
+**Note:** `feishu_wiki` depends on this tool - wiki page content is read/written via `feishu_doc`.
+
+## Permissions
+
+Required: `docx:document`, `docx:document:readonly`, `docx:document.block:convert`, `drive:drive`

package/skills/feishu-doc/references/block-types.md

@@ -0,0 +1,103 @@
+# Feishu Block Types Reference
+
+Complete reference for Feishu document block types. Use with `feishu_doc_list_blocks`, `feishu_doc_update_block`, and `feishu_doc_delete_block`.
+
+## Block Type Table
+
+| block_type | Name            | Description                    | Editable |
+| ---------- | --------------- | ------------------------------ | -------- |
+| 1          | Page            | Document root (contains title) | No       |
+| 2          | Text            | Plain text paragraph           | Yes      |
+| 3          | Heading1        | H1 heading                     | Yes      |
+| 4          | Heading2        | H2 heading                     | Yes      |
+| 5          | Heading3        | H3 heading                     | Yes      |
+| 6          | Heading4        | H4 heading                     | Yes      |
+| 7          | Heading5        | H5 heading                     | Yes      |
+| 8          | Heading6        | H6 heading                     | Yes      |
+| 9          | Heading7        | H7 heading                     | Yes      |
+| 10         | Heading8        | H8 heading                     | Yes      |
+| 11         | Heading9        | H9 heading                     | Yes      |
+| 12         | Bullet          | Unordered list item            | Yes      |
+| 13         | Ordered         | Ordered list item              | Yes      |
+| 14         | Code            | Code block                     | Yes      |
+| 15         | Quote           | Blockquote                     | Yes      |
+| 16         | Equation        | LaTeX equation                 | Partial  |
+| 17         | Todo            | Checkbox / task item           | Yes      |
+| 18         | Bitable         | Multi-dimensional table        | No       |
+| 19         | Callout         | Highlight block                | Yes      |
+| 20         | ChatCard        | Chat card embed                | No       |
+| 21         | Diagram         | Diagram embed                  | No       |
+| 22         | Divider         | Horizontal rule                | No       |
+| 23         | File            | File attachment                | No       |
+| 24         | Grid            | Grid layout container          | No       |
+| 25         | GridColumn      | Grid column                    | No       |
+| 26         | Iframe          | Embedded iframe                | No       |
+| 27         | Image           | Image                          | Partial  |
+| 28         | ISV             | Third-party widget             | No       |
+| 29         | MindnoteBlock   | Mindmap embed                  | No       |
+| 30         | Sheet           | Spreadsheet embed              | No       |
+| 31         | Table           | Table                          | Partial  |
+| 32         | TableCell       | Table cell                     | Yes      |
+| 33         | View            | View embed                     | No       |
+| 34         | Undefined       | Unknown type                   | No       |
+| 35         | QuoteContainer  | Quote container                | No       |
+| 36         | Task            | Lark Tasks integration         | No       |
+| 37         | OKR             | OKR integration                | No       |
+| 38         | OKRObjective    | OKR objective                  | No       |
+| 39         | OKRKeyResult    | OKR key result                 | No       |
+| 40         | OKRProgress     | OKR progress                   | No       |
+| 41         | AddOns          | Add-ons block                  | No       |
+| 42         | JiraIssue       | Jira issue embed               | No       |
+| 43         | WikiCatalog     | Wiki catalog                   | No       |
+| 44         | Board           | Board embed                    | No       |
+| 45         | Agenda          | Agenda block                   | No       |
+| 46         | AgendaItem      | Agenda item                    | No       |
+| 47         | AgendaItemTitle | Agenda item title              | No       |
+| 48         | SyncedBlock     | Synced block reference         | No       |
+
+## Editing Guidelines
+
+### Text-based blocks (2-17, 19)
+
+Update text content using `feishu_doc_update_block`:
+
+```json
+{
+  "doc_token": "ABC123",
+  "block_id": "block_xxx",
+  "content": "New text content"
+}
+```
+
+### Image blocks (27)
+
+Images cannot be updated directly via `update_block`. Use `feishu_doc_write` or `feishu_doc_append` with markdown to add new images.
+
+### Table blocks (31)
+
+**Important:** Table blocks CANNOT be created via the `documentBlockChildren.create` API (error 1770029). This affects `feishu_doc_write` and `feishu_doc_append` - markdown tables will be skipped with a warning.
+
+Tables can only be read (via `list_blocks`) and individual cells (type 32) can be updated, but new tables cannot be inserted programmatically via markdown.
+
+### Container blocks (24, 25, 35)
+
+Grid and QuoteContainer are layout containers. Edit their child blocks instead.
+
+## Common Patterns
+
+### Replace specific paragraph
+
+1. `feishu_doc_list_blocks` - find the block_id
+2. `feishu_doc_update_block` - update its content
+
+### Insert content at specific location
+
+Currently, the API only supports appending to document end. For insertion at specific positions, consider:
+
+1. Read existing content
+2. Delete affected blocks
+3. Rewrite with new content in desired order
+
+### Delete multiple blocks
+
+Blocks must be deleted one at a time. Delete child blocks before parent containers.

package/skills/feishu-drive/SKILL.md

@@ -0,0 +1,97 @@
+---
+name: feishu-drive
+description: |
+  Feishu cloud storage file management. Activate when user mentions cloud space, folders, drive.
+---
+
+# Feishu Drive Tool
+
+Single tool `feishu_drive` for cloud storage operations.
+
+## Token Extraction
+
+From URL `https://xxx.feishu.cn/drive/folder/ABC123` → `folder_token` = `ABC123`
+
+## Actions
+
+### List Folder Contents
+
+```json
+{ "action": "list" }
+```
+
+Root directory (no folder_token).
+
+```json
+{ "action": "list", "folder_token": "fldcnXXX" }
+```
+
+Returns: files with token, name, type, url, timestamps.
+
+### Get File Info
+
+```json
+{ "action": "info", "file_token": "ABC123", "type": "docx" }
+```
+
+Searches for the file in the root directory. Note: file must be in root or use `list` to browse folders first.
+
+`type`: `doc`, `docx`, `sheet`, `bitable`, `folder`, `file`, `mindnote`, `shortcut`
+
+### Create Folder
+
+```json
+{ "action": "create_folder", "name": "New Folder" }
+```
+
+In parent folder:
+
+```json
+{ "action": "create_folder", "name": "New Folder", "folder_token": "fldcnXXX" }
+```
+
+### Move File
+
+```json
+{ "action": "move", "file_token": "ABC123", "type": "docx", "folder_token": "fldcnXXX" }
+```
+
+### Delete File
+
+```json
+{ "action": "delete", "file_token": "ABC123", "type": "docx" }
+```
+
+## File Types
+
+| Type       | Description             |
+| ---------- | ----------------------- |
+| `doc`      | Old format document     |
+| `docx`     | New format document     |
+| `sheet`    | Spreadsheet             |
+| `bitable`  | Multi-dimensional table |
+| `folder`   | Folder                  |
+| `file`     | Uploaded file           |
+| `mindnote` | Mind map                |
+| `shortcut` | Shortcut                |
+
+## Configuration
+
+```yaml
+channels:
+  feishu:
+    tools:
+      drive: true # default: true
+```
+
+## Permissions
+
+- `drive:drive` - Full access (create, move, delete)
+- `drive:drive:readonly` - Read only (list, info)
+
+## Known Limitations
+
+- **Bots have no root folder**: Feishu bots use `tenant_access_token` and don't have their own "My Space". The root folder concept only exists for user accounts. This means:
+  - `create_folder` without `folder_token` will fail (400 error)
+  - Bot can only access files/folders that have been **shared with it**
+  - **Workaround**: User must first create a folder manually and share it with the bot, then bot can create subfolders inside it

package/skills/feishu-perm/SKILL.md

@@ -0,0 +1,119 @@
+---
+name: feishu-perm
+description: |
+  Feishu permission management for documents and files. Activate when user mentions sharing, permissions, collaborators.
+---
+
+# Feishu Permission Tool
+
+Single tool `feishu_perm` for managing file/document permissions.
+
+## Actions
+
+### List Collaborators
+
+```json
+{ "action": "list", "token": "ABC123", "type": "docx" }
+```
+
+Returns: members with member_type, member_id, perm, name.
+
+### Add Collaborator
+
+```json
+{
+  "action": "add",
+  "token": "ABC123",
+  "type": "docx",
+  "member_type": "email",
+  "member_id": "user@example.com",
+  "perm": "edit"
+}
+```
+
+### Remove Collaborator
+
+```json
+{
+  "action": "remove",
+  "token": "ABC123",
+  "type": "docx",
+  "member_type": "email",
+  "member_id": "user@example.com"
+}
+```
+
+## Token Types
+
+| Type       | Description             |
+| ---------- | ----------------------- |
+| `doc`      | Old format document     |
+| `docx`     | New format document     |
+| `sheet`    | Spreadsheet             |
+| `bitable`  | Multi-dimensional table |
+| `folder`   | Folder                  |
+| `file`     | Uploaded file           |
+| `wiki`     | Wiki node               |
+| `mindnote` | Mind map                |
+
+## Member Types
+
+| Type               | Description        |
+| ------------------ | ------------------ |
+| `email`            | Email address      |
+| `openid`           | User open_id       |
+| `userid`           | User user_id       |
+| `unionid`          | User union_id      |
+| `openchat`         | Group chat open_id |
+| `opendepartmentid` | Department open_id |
+
+## Permission Levels
+
+| Perm          | Description                          |
+| ------------- | ------------------------------------ |
+| `view`        | View only                            |
+| `edit`        | Can edit                             |
+| `full_access` | Full access (can manage permissions) |
+
+## Examples
+
+Share document with email:
+
+```json
+{
+  "action": "add",
+  "token": "doxcnXXX",
+  "type": "docx",
+  "member_type": "email",
+  "member_id": "alice@company.com",
+  "perm": "edit"
+}
+```
+
+Share folder with group:
+
+```json
+{
+  "action": "add",
+  "token": "fldcnXXX",
+  "type": "folder",
+  "member_type": "openchat",
+  "member_id": "oc_xxx",
+  "perm": "view"
+}
+```
+
+## Configuration
+
+```yaml
+channels:
+  feishu:
+    tools:
+      perm: true # default: false (disabled)
+```
+
+**Note:** This tool is disabled by default because permission management is a sensitive operation. Enable explicitly if needed.
+
+## Permissions
+
+Required: `drive:permission`