@zhin.js/adapter-wecom 2.0.2 → 3.0.0

package/lib/webhook.js

@@ -0,0 +1,86 @@
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { decryptMessage, extractEncryptFromXml, normalizeEchostrParam, parseXmlMessage, queryParam, readTextBody, verifySignature, } from './protocol.js';
+const logger = getLogger('wecom');
+export function registerWecomWebhookRoutes(http, handler) {
+    const path = handler.config.webhookPath;
+    return [
+        http.route('GET', path, (request, response, url) => {
+            handleWecomVerificationRequest(request, response, url, handler);
+        }, { summary: 'WeCom URL verification', tags: ['wecom'] }),
+        http.route('POST', path, async (request, response, url) => {
+            await handleWecomWebhookRequest(request, response, url, handler);
+        }, { summary: 'WeCom inbound webhook', tags: ['wecom'] }),
+    ];
+}
+export function handleWecomVerificationRequest(_request, response, url, handler) {
+    try {
+        const msgSignature = queryParam(url.searchParams.get('msg_signature'));
+        const timestamp = queryParam(url.searchParams.get('timestamp'));
+        const nonce = queryParam(url.searchParams.get('nonce'));
+        const echostr = normalizeEchostrParam(queryParam(url.searchParams.get('echostr')));
+        const { token, encodingAESKey, corpId } = handler.config;
+        if (!msgSignature || !timestamp || !nonce || !echostr) {
+            response.writeHead(400, { 'Content-Type': 'text/plain' });
+            response.end('Missing required query parameters');
+            return;
+        }
+        if (!verifySignature(token, timestamp, nonce, echostr, msgSignature)) {
+            logger.warn(formatCompact({ op: 'verify', ok: false, error: 'invalid signature' }));
+            response.writeHead(403, { 'Content-Type': 'text/plain' });
+            response.end('Forbidden');
+            return;
+        }
+        const decrypted = decryptMessage(echostr, encodingAESKey, corpId);
+        if (!decrypted) {
+            response.writeHead(400, { 'Content-Type': 'text/plain' });
+            response.end('Decryption failed');
+            return;
+        }
+        response.writeHead(200, { 'Content-Type': 'text/plain' });
+        response.end(decrypted);
+    }
+    catch (error) {
+        logger.error('URL verification error:', error);
+        response.writeHead(500, { 'Content-Type': 'text/plain' });
+        response.end('Internal Server Error');
+    }
+}
+export async function handleWecomWebhookRequest(request, response, url, handler) {
+    try {
+        const msgSignature = queryParam(url.searchParams.get('msg_signature'));
+        const timestamp = queryParam(url.searchParams.get('timestamp'));
+        const nonce = queryParam(url.searchParams.get('nonce'));
+        const { token, encodingAESKey, corpId } = handler.config;
+        const rawBody = await readTextBody(request);
+        const encrypted = extractEncryptFromXml(rawBody);
+        if (!encrypted) {
+            logger.warn(formatCompact({ op: 'webhook', ok: false, error: 'no Encrypt field' }));
+            response.writeHead(200, { 'Content-Type': 'text/plain' });
+            response.end('success');
+            return;
+        }
+        if (!verifySignature(token, timestamp, nonce, encrypted, msgSignature)) {
+            logger.warn(formatCompact({ op: 'webhook', ok: false, error: 'invalid signature' }));
+            response.writeHead(403, { 'Content-Type': 'text/plain' });
+            response.end('Forbidden');
+            return;
+        }
+        const decryptedXml = decryptMessage(encrypted, encodingAESKey, corpId);
+        if (!decryptedXml) {
+            response.writeHead(200, { 'Content-Type': 'text/plain' });
+            response.end('success');
+            return;
+        }
+        const message = parseXmlMessage(decryptedXml);
+        if (message && handler.isOpen) {
+            handler.admit(message);
+        }
+        response.writeHead(200, { 'Content-Type': 'text/plain' });
+        response.end('success');
+    }
+    catch (error) {
+        logger.error('Webhook error:', error);
+        response.writeHead(200, { 'Content-Type': 'text/plain' });
+        response.end('success');
+    }
+}

package/lib/wecom-agent-deps.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Agent tool deps for wecom (get_user / departments / send_text).
+ * Endpoints register themselves on start; tools look up by endpoint id.
+ */
+export interface WecomAgentEndpoint {
+    getUserInfo(userId: string): Promise<unknown>;
+    getDepartmentUsers(deptId: number): Promise<unknown[]>;
+    getDepartmentList(deptId?: number): Promise<unknown[]>;
+    sendTextMessage(userId: string, content: string): Promise<boolean>;
+}
+export interface WecomAgentDeps {
+    getEndpoint: (endpointId: string) => WecomAgentEndpoint;
+}
+export declare function registerWecomAgentEndpoint(endpointId: string, endpoint: WecomAgentEndpoint): () => void;
+/** Optional override used by tests / transitional callers. Pass `null` to clear. */
+export declare function setWecomAgentDeps(deps: WecomAgentDeps | null): void;
+export declare function getWecomAgentDeps(): WecomAgentDeps;

package/lib/wecom-agent-deps.js

@@ -0,0 +1,30 @@
+/**
+ * Agent tool deps for wecom (get_user / departments / send_text).
+ * Endpoints register themselves on start; tools look up by endpoint id.
+ */
+const endpoints = new Map();
+let override = null;
+export function registerWecomAgentEndpoint(endpointId, endpoint) {
+    endpoints.set(endpointId, endpoint);
+    return () => {
+        if (endpoints.get(endpointId) === endpoint) {
+            endpoints.delete(endpointId);
+        }
+    };
+}
+/** Optional override used by tests / transitional callers. Pass `null` to clear. */
+export function setWecomAgentDeps(deps) {
+    override = deps;
+}
+export function getWecomAgentDeps() {
+    if (override)
+        return override;
+    return {
+        getEndpoint(endpointId) {
+            const endpoint = endpoints.get(endpointId);
+            if (!endpoint)
+                throw new Error(`Endpoint ${endpointId} 不存在`);
+            return endpoint;
+        },
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/adapter-wecom",
-  "version": "2.0.2",
-  "description": "Zhin.js adapter for WeCom (企业微信)",
+  "version": "3.0.0",
+  "description": "Zhin.js WeCom (企业微信) adapter for Plugin Runtime (HTTP webhook)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -33,24 +33,25 @@
     "type": "git",
     "directory": "plugins/adapters/wecom"
   },
-  "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"
+  "dependencies": {
+    "@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/host-router": "2.0.3",
-    "zhin.js": "4.1.2",
-    "@zhin.js/agent": "1.0.3"
+    "@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/host-router": {
-      "optional": false
+    "zhin.js": {
+      "optional": true
     },
     "@zhin.js/agent": {
       "optional": true
@@ -59,13 +60,23 @@
       "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",
-    "plugin.yml",
+    "agent",
     "README.md",
-    "CHANGELOG.md",
-    "agent"
+    "CHANGELOG.md"
   ],
   "publishConfig": {
     "access": "public",
@@ -74,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/wecom/tests"
   }
 }

package/plugin.ts

@@ -0,0 +1,12 @@
+import { definePlugin } from '@zhin.js/plugin-runtime';
+import { registerWecomPlatformPermitChecker } from './src/platform-permit.js';
+
+export default definePlugin({
+  name: 'wecom',
+  metadata: {
+    displayName: 'WeCom (企业微信) Adapter',
+  },
+  setup() {
+    return registerWecomPlatformPermitChecker();
+  },
+});

package/schema.json

@@ -0,0 +1,60 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "webhookPath": {
+      "type": "string",
+      "default": "/wecom/callback"
+    },
+    "apiBaseUrl": {
+      "type": "string",
+      "default": "https://qyapi.weixin.qq.com"
+    },
+    "endpoints": {
+      "type": "array",
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（name 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "WeCom bot name"
+          },
+          "corpId": {
+            "type": "string",
+            "description": "WeCom corp ID"
+          },
+          "agentSecret": {
+            "type": "string",
+            "description": "WeCom agent secret"
+          },
+          "token": {
+            "type": "string",
+            "description": "WeCom callback token"
+          },
+          "encodingAESKey": {
+            "type": "string",
+            "description": "WeCom encoding AES key"
+          }
+        },
+        "required": [
+          "name",
+          "corpId",
+          "agentSecret",
+          "token",
+          "encodingAESKey"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}