@zhin.js/adapter-lark 4.0.1 → 4.0.3

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.1",
-  "description": "Zhin.js adapter for Lark/Feishu (飞书)",
+  "version": "4.0.3",
+  "description": "Zhin.js Lark/Feishu (飞书) adapter for Plugin Runtime (HTTP webhook)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -34,33 +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",
-    "@zhin.js/host-router": "2.0.2",
-    "zhin.js": "4.1.1"
+    "@zhin.js/adapter": "1.0.1",
+    "@zhin.js/core": "1.3.5",
+    "@zhin.js/host-http": "1.0.1",
+    "@zhin.js/logger": "1.0.75",
+    "@zhin.js/plugin-runtime": "1.0.1"
   },
   "peerDependencies": {
-    "zhin.js": "4.1.1",
-    "@zhin.js/host-router": "2.0.2"
+    "zod": "^4.0.0",
+    "@zhin.js/adapter": "1.0.1",
+    "@zhin.js/agent": "1.0.4",
+    "@zhin.js/core": "1.3.5",
+    "@zhin.js/host-http": "1.0.1",
+    "@zhin.js/plugin-runtime": "1.0.1",
+    "zhin.js": "4.1.3"
   },
   "peerDependenciesMeta": {
-    "@zhin.js/host-router": {
-      "optional": false
+    "zhin.js": {
+      "optional": true
+    },
+    "@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.4",
+    "zhin.js": "4.1.3"
+  },
   "files": [
+    "adapters",
+    "plugin.ts",
+    "schema.json",
     "src",
     "lib",
-    "client",
-    "dist",
-    "skills",
-    "plugin.yml",
+    "agent",
     "README.md",
-    "node",
     "CHANGELOG.md"
   ],
   "publishConfig": {
@@ -70,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,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "name": {
+      "type": "string",
+      "default": "lark-bot"
+    },
+    "appId": { "type": "string" },
+    "appSecret": { "type": "string" },
+    "encryptKey": { "type": "string" },
+    "verificationToken": { "type": "string" },
+    "webhookPath": {
+      "type": "string",
+      "default": "/lark/webhook"
+    },
+    "apiBaseUrl": { "type": "string" },
+    "isFeishu": {
+      "type": "boolean",
+      "default": true
+    }
+  },
+  "required": ["appId", "appSecret"]
+}