@zhin.js/adapter-lark 4.0.2 → 5.0.0

package/lib/protocol.js

@@ -0,0 +1,204 @@
+/**
+ * Lark/Feishu protocol helpers — no legacy Adapter/Endpoint / segment-mapper.
+ * Canonicalization is owned by gateway/core before endpoint.send.
+ */
+import { createHash, timingSafeEqual } from 'node:crypto';
+export function resolveLarkConfig(config = {}) {
+    const entry = config.endpoints?.find((item) => item.context === 'lark');
+    const appId = config.appId ?? entry?.appId ?? process.env.LARK_APP_ID;
+    const appSecret = config.appSecret ?? entry?.appSecret ?? process.env.LARK_APP_SECRET;
+    if (!appId || !appSecret) {
+        throw new TypeError('Lark adapter requires appId + appSecret (plugins.<key> or endpoints with context: lark)');
+    }
+    const isFeishu = config.isFeishu ?? entry?.isFeishu ?? true;
+    const name = (typeof config.name === 'string' && config.name)
+        || (typeof entry?.name === 'string' && entry.name)
+        || process.env.LARK_BOT_NAME
+        || 'lark-bot';
+    const webhookPath = normalizeWebhookPath(config.webhookPath ?? entry?.webhookPath ?? '/lark/webhook');
+    const defaultBase = isFeishu
+        ? 'https://open.feishu.cn/open-apis'
+        : 'https://open.larksuite.com/open-apis';
+    const apiBaseUrl = (config.apiBaseUrl ?? entry?.apiBaseUrl ?? defaultBase).replace(/\/$/, '');
+    const encryptKey = config.encryptKey ?? entry?.encryptKey;
+    const verificationToken = config.verificationToken ?? entry?.verificationToken;
+    return {
+        context: 'lark',
+        name,
+        appId,
+        appSecret,
+        ...(encryptKey ? { encryptKey } : {}),
+        ...(verificationToken ? { verificationToken } : {}),
+        webhookPath,
+        apiBaseUrl,
+        isFeishu,
+    };
+}
+export function normalizeWebhookPath(path) {
+    const trimmed = path.trim() || '/lark/webhook';
+    return trimmed.startsWith('/') ? trimmed : `/${trimmed}`;
+}
+export function resolveChatType(chatId) {
+    return chatId?.startsWith('oc_') ? 'group' : 'private';
+}
+export function resolveTarget(msg) {
+    return msg.chat_id || 'unknown';
+}
+export function resolveSender(msg) {
+    return msg.sender?.sender_id?.open_id
+        || msg.sender?.sender_id?.user_id
+        || 'unknown';
+}
+export function generateMessageId(msg) {
+    return msg.message_id || `${msg.create_time ?? Date.now()}`;
+}
+/** Build inbound text for MessageGateway.receive. */
+export function formatInboundContent(msg) {
+    if (!msg.content || !msg.message_type)
+        return '';
+    try {
+        const parsed = JSON.parse(msg.content);
+        switch (msg.message_type) {
+            case 'text':
+                return typeof parsed.text === 'string' ? parsed.text : '';
+            case 'image':
+                return '[image]';
+            case 'file': {
+                const name = typeof parsed.file_name === 'string' ? parsed.file_name : '';
+                return name ? `[file: ${name}]` : '[file]';
+            }
+            case 'audio':
+                return '[audio]';
+            case 'video':
+                return '[video]';
+            case 'sticker':
+                return '[sticker]';
+            case 'post':
+            case 'interactive':
+                return `[${msg.message_type}]`;
+            case 'rich_text':
+                return '[rich_text]';
+            default:
+                return `[${msg.message_type}]`;
+        }
+    }
+    catch {
+        return '[消息解析失败]';
+    }
+}
+export function verifySignature(encryptKey, timestamp, nonce, body, signature) {
+    try {
+        const stringToSign = `${timestamp}${nonce}${encryptKey}${body}`;
+        const calculated = createHash('sha256').update(stringToSign).digest('hex');
+        const a = Buffer.from(calculated);
+        const b = Buffer.from(signature);
+        if (a.length !== b.length)
+            return false;
+        return timingSafeEqual(a, b);
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Wire-encode an already-rendered outbound payload into Lark im/v1 message body.
+ * Segment canonicalization is intentionally not done here.
+ */
+export function formatOutboundBody(payload) {
+    if (typeof payload === 'string') {
+        return {
+            msg_type: 'text',
+            content: JSON.stringify({ text: payload }),
+        };
+    }
+    const items = Array.isArray(payload)
+        ? payload
+        : payload && typeof payload === 'object' && 'type' in payload
+            ? [payload]
+            : [];
+    if (items.length === 0) {
+        const text = payload == null
+            ? ''
+            : typeof payload === 'object'
+                ? JSON.stringify(payload)
+                : String(payload);
+        return {
+            msg_type: 'text',
+            content: JSON.stringify({ text }),
+        };
+    }
+    const textParts = [];
+    let media = null;
+    for (const item of items) {
+        if (typeof item === 'string') {
+            textParts.push(item);
+            continue;
+        }
+        const data = item.data ?? {};
+        switch (item.type) {
+            case 'text':
+                textParts.push(String(data.content ?? data.text ?? ''));
+                break;
+            case 'at':
+                textParts.push(`<at user_id="${String(data.id ?? '')}">${String(data.name || data.id || '')}</at>`);
+                break;
+            case 'image':
+                if (!media) {
+                    media = {
+                        msg_type: 'image',
+                        content: JSON.stringify({
+                            image_key: data.file_key ?? data.key ?? data.url,
+                        }),
+                    };
+                }
+                break;
+            case 'file':
+                if (!media) {
+                    media = {
+                        msg_type: 'file',
+                        content: JSON.stringify({
+                            file_key: data.file_key ?? data.key,
+                        }),
+                    };
+                }
+                break;
+            case 'card':
+                if (!media) {
+                    media = {
+                        msg_type: 'interactive',
+                        content: JSON.stringify(data),
+                    };
+                }
+                break;
+            default:
+                textParts.push(`[${item.type}]`);
+        }
+    }
+    if (media)
+        return media;
+    return {
+        msg_type: 'text',
+        content: JSON.stringify({ text: textParts.join('') }),
+    };
+}
+export function headerValue(headers, name) {
+    const value = headers[name] ?? headers[name.toLowerCase()];
+    if (Array.isArray(value))
+        return value[0] ?? '';
+    return value ?? '';
+}
+export async function readTextBody(request, options = {}) {
+    const limit = options.limit ?? 1_048_576;
+    const chunks = [];
+    let size = 0;
+    for await (const chunk of request) {
+        const buffer = Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk);
+        size += buffer.length;
+        if (size > limit) {
+            request.destroy();
+            throw new Error(`Request body exceeds ${limit} bytes`);
+        }
+        chunks.push(buffer);
+    }
+    return Buffer.concat(chunks).toString('utf8');
+}

package/lib/webhook.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Lark/Feishu webhook HTTP: verification → signature → challenge/event → admit.
+ */
+import type { IncomingMessage, ServerResponse } from 'node:http';
+import type { HttpHost, HttpRouteRegistration } from '@zhin.js/host-http';
+import { type LarkMessage, type ResolvedLarkConfig } from './protocol.js';
+export interface LarkWebhookHandler {
+    readonly config: ResolvedLarkConfig;
+    readonly isOpen: boolean;
+    admit(msg: LarkMessage): void;
+}
+export declare function registerLarkWebhookRoutes(http: HttpHost, handler: LarkWebhookHandler): HttpRouteRegistration[];
+export declare function handleLarkWebhookRequest(request: IncomingMessage, response: ServerResponse, handler: LarkWebhookHandler): Promise<void>;

package/lib/webhook.js

@@ -0,0 +1,67 @@
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { headerValue, readTextBody, verifySignature, } from './protocol.js';
+const logger = getLogger('lark');
+export function registerLarkWebhookRoutes(http, handler) {
+    const path = handler.config.webhookPath;
+    return [
+        http.route('POST', path, async (request, response) => {
+            await handleLarkWebhookRequest(request, response, handler);
+        }, { summary: 'Lark/Feishu event webhook', tags: ['lark'] }),
+    ];
+}
+export async function handleLarkWebhookRequest(request, response, handler) {
+    try {
+        const rawBody = await readTextBody(request);
+        if (handler.config.verificationToken) {
+            const token = headerValue(request.headers, 'x-lark-request-token');
+            if (token !== handler.config.verificationToken) {
+                logger.warn(formatCompact({ op: 'webhook', ok: false, error: 'invalid verification token' }));
+                response.writeHead(403, { 'Content-Type': 'text/plain' });
+                response.end('Forbidden');
+                return;
+            }
+        }
+        if (handler.config.encryptKey) {
+            const timestamp = headerValue(request.headers, 'x-lark-request-timestamp');
+            const nonce = headerValue(request.headers, 'x-lark-request-nonce');
+            const signature = headerValue(request.headers, 'x-lark-signature');
+            if (!timestamp
+                || !nonce
+                || !signature
+                || !verifySignature(handler.config.encryptKey, timestamp, nonce, rawBody, signature)) {
+                logger.warn(formatCompact({ op: 'webhook', ok: false, error: 'invalid signature' }));
+                response.writeHead(403, { 'Content-Type': 'text/plain' });
+                response.end('Forbidden');
+                return;
+            }
+        }
+        let event;
+        try {
+            event = JSON.parse(rawBody);
+        }
+        catch {
+            response.writeHead(200, { 'Content-Type': 'application/json' });
+            response.end(JSON.stringify({ code: 0, msg: 'success' }));
+            return;
+        }
+        if (event.type === 'url_verification') {
+            response.writeHead(200, { 'Content-Type': 'application/json' });
+            response.end(JSON.stringify({ challenge: event.challenge }));
+            return;
+        }
+        if (event.type === 'event_callback' && event.event?.message && handler.isOpen) {
+            const message = {
+                ...event.event.message,
+                sender: event.event.message.sender ?? event.event.sender,
+            };
+            handler.admit(message);
+        }
+        response.writeHead(200, { 'Content-Type': 'application/json' });
+        response.end(JSON.stringify({ code: 0, msg: 'success' }));
+    }
+    catch (error) {
+        logger.error('Webhook error:', error);
+        response.writeHead(500, { 'Content-Type': 'application/json' });
+        response.end(JSON.stringify({ code: -1, msg: 'Internal Server Error' }));
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/adapter-lark",
-  "version": "4.0.2",
-  "description": "Zhin.js adapter for Lark/Feishu (飞书)",
+  "version": "5.0.0",
+  "description": "Zhin.js Lark/Feishu (飞书) adapter for Plugin Runtime (HTTP webhook)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -34,43 +34,48 @@
     "directory": "plugins/adapters/lark"
   },
   "dependencies": {
-    "axios": "^1.18.0"
-  },
-  "devDependencies": {
-    "@types/koa": "^3.0.3",
-    "@types/node": "^26.1.0",
-    "typescript": "^6.0.3",
-    "zod": "^4.4.3",
-    "@zhin.js/host-router": "2.0.3",
-    "zhin.js": "4.1.2",
-    "@zhin.js/agent": "1.0.3"
+    "@zhin.js/adapter": "1.1.0",
+    "@zhin.js/core": "1.4.0",
+    "@zhin.js/host-http": "1.0.2",
+    "@zhin.js/logger": "1.0.75",
+    "@zhin.js/plugin-runtime": "1.1.0"
   },
   "peerDependencies": {
     "zod": "^4.0.0",
-    "@zhin.js/agent": "1.0.3",
-    "@zhin.js/host-router": "2.0.3",
-    "zhin.js": "4.1.2"
+    "@zhin.js/adapter": "1.1.0",
+    "@zhin.js/agent": "1.0.5",
+    "@zhin.js/core": "1.4.0",
+    "@zhin.js/host-http": "1.0.2",
+    "@zhin.js/plugin-runtime": "1.1.0",
+    "zhin.js": "5.0.0"
   },
   "peerDependenciesMeta": {
-    "@zhin.js/agent": {
+    "zhin.js": {
       "optional": true
     },
-    "@zhin.js/host-router": {
-      "optional": false
+    "@zhin.js/agent": {
+      "optional": true
     },
     "zod": {
       "optional": true
     }
   },
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10",
+    "zod": "^4.4.3",
+    "@zhin.js/agent": "1.0.5",
+    "zhin.js": "5.0.0"
+  },
   "files": [
+    "adapters",
+    "plugin.ts",
+    "schema.json",
     "src",
     "lib",
     "agent",
-    "client",
-    "dist",
-    "plugin.yml",
     "README.md",
-    "node",
     "CHANGELOG.md"
   ],
   "publishConfig": {
@@ -80,9 +85,23 @@
   "engines": {
     "node": "^20.19.0 || >=22.12.0"
   },
+  "zhin": {
+    "protocol": 1,
+    "type": "plugin",
+    "entry": "./plugin.ts",
+    "engine": "^1.0.0",
+    "runtime": "trusted",
+    "features": [
+      {
+        "package": "@zhin.js/adapter",
+        "api": "^1.0.0"
+      }
+    ],
+    "plugins": []
+  },
   "scripts": {
-    "build": "pnpm build:node",
+    "build": "tsc",
     "clean": "rimraf lib",
-    "build:node": "tsc"
+    "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/adapters/lark/tests"
   }
 }

package/plugin.ts

@@ -0,0 +1,12 @@
+import { definePlugin } from '@zhin.js/plugin-runtime';
+import { registerLarkPlatformPermitChecker } from './src/platform-permit.js';
+
+export default definePlugin({
+  name: 'lark',
+  metadata: {
+    displayName: 'Lark/Feishu (飞书) Adapter',
+  },
+  setup() {
+    return registerLarkPlatformPermitChecker();
+  },
+});

package/schema.json

@@ -0,0 +1,61 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "webhookPath": {
+      "type": "string",
+      "default": "/lark/webhook"
+    },
+    "apiBaseUrl": {
+      "type": "string"
+    },
+    "isFeishu": {
+      "type": "boolean",
+      "default": true
+    },
+    "endpoints": {
+      "type": "array",
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（name 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "Lark bot name"
+          },
+          "appId": {
+            "type": "string",
+            "description": "Lark app ID"
+          },
+          "appSecret": {
+            "type": "string",
+            "description": "Lark app secret"
+          },
+          "encryptKey": {
+            "type": "string",
+            "description": "Lark encrypt key"
+          },
+          "verificationToken": {
+            "type": "string",
+            "description": "Lark verification token"
+          }
+        },
+        "required": [
+          "name",
+          "appId",
+          "appSecret"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}