@zhin.js/adapter-dingtalk 1.0.81 → 1.1.0

package/lib/webhook.js

@@ -0,0 +1,47 @@
+import { formatCompact, getLogger } from '@zhin.js/logger';
+import { headerValue, readTextBody, verifySignature, } from './protocol.js';
+const logger = getLogger('dingtalk');
+export function registerDingTalkWebhookRoutes(http, handler) {
+    const path = handler.config.webhookPath;
+    return [
+        http.route('POST', path, async (request, response) => {
+            await handleDingTalkWebhookRequest(request, response, handler);
+        }, { summary: 'DingTalk robot webhook', tags: ['dingtalk'] }),
+    ];
+}
+export async function handleDingTalkWebhookRequest(request, response, handler) {
+    try {
+        // DingTalk outgoing callbacks put timestamp/sign on the URL query;
+        // headers are accepted as a fallback for legacy senders.
+        const query = new URL(request.url ?? '/', 'http://localhost').searchParams;
+        const timestamp = query.get('timestamp') || headerValue(request.headers, 'timestamp');
+        const sign = query.get('sign') || headerValue(request.headers, 'sign');
+        // Missing credentials must never be admitted: verify unconditionally.
+        if (!timestamp || !sign || !verifySignature(handler.config.appSecret, timestamp, sign)) {
+            logger.warn(formatCompact({ op: 'webhook', ok: false, error: 'invalid signature' }));
+            response.writeHead(403, { 'Content-Type': 'application/json' });
+            response.end(JSON.stringify({ code: -1, msg: 'Forbidden' }));
+            return;
+        }
+        const rawBody = await readTextBody(request);
+        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.msgtype && handler.isOpen) {
+            handler.admit(event);
+        }
+        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-dingtalk",
-  "version": "1.0.81",
-  "description": "Zhin.js adapter for DingTalk (钉钉)",
+  "version": "1.1.0",
+  "description": "Zhin.js DingTalk (钉钉) adapter for Plugin Runtime (HTTP webhook)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -32,39 +32,85 @@
     "type": "git",
     "directory": "plugins/adapters/dingtalk"
   },
-  "devDependencies": {
-    "@types/koa": "^3.0.3",
-    "@types/node": "^25.9.1",
-    "typescript": "^6.0.3",
-    "zhin.js": "1.0.93"
+  "dependencies": {
+    "@zhin.js/adapter": "1.1.12",
+    "@zhin.js/core": "1.1.35",
+    "@zhin.js/feature-kit": "1.1.0",
+    "@zhin.js/host-http": "1.1.0",
+    "@zhin.js/im-contract": "1.1.0",
+    "@zhin.js/logger": "1.1.0"
   },
   "peerDependencies": {
-    "@zhin.js/host-router": "0.0.3",
-    "zhin.js": "1.0.93"
+    "zod": "^4.0.0",
+    "@zhin.js/adapter": "^1.1.12",
+    "@zhin.js/agent": "^1.1.23",
+    "@zhin.js/command": "^1.1.0",
+    "@zhin.js/core": "^1.1.35",
+    "@zhin.js/host-http": "^1.1.0",
+    "@zhin.js/permission": "^1.1.0",
+    "zhin.js": "^1.1.0"
   },
   "peerDependenciesMeta": {
-    "@zhin.js/host-router": {
-      "optional": false
+    "@zhin.js/agent": {
+      "optional": true
+    },
+    "@zhin.js/command": {
+      "optional": true
+    },
+    "zhin.js": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
     }
   },
+  "devDependencies": {
+    "@types/node": "^26.1.2",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.10",
+    "zod": "^4.4.3",
+    "@zhin.js/agent": "1.1.23",
+    "zhin.js": "1.1.0"
+  },
   "files": [
+    "adapters",
+    "commands",
+    "plugin.js",
+    "schema.json",
     "src",
     "lib",
-    "client",
-    "dist",
-    "skills",
-    "plugin.yml",
+    "agent",
     "README.md",
-    "node",
     "CHANGELOG.md"
   ],
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "zhin": {
+    "protocol": 1,
+    "type": "plugin",
+    "entry": "./plugin.js",
+    "engine": "^1.0.0",
+    "runtime": "trusted",
+    "features": [
+      {
+        "package": "@zhin.js/adapter",
+        "api": "^1.0.0"
+      },
+      {
+        "package": "@zhin.js/command",
+        "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/dingtalk/tests"
   }
 }

package/plugin.js

@@ -0,0 +1,19 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { createEndpointRuntimeState } from 'zhin.js/adapter';
+import { definePlugin } from 'zhin.js';
+import { permissionHostToken } from '@zhin.js/permission';
+import { checkDingtalkPlatformPermit } from "./lib/platform-permit.js";
+import { dingtalkRuntimeStateToken } from "./lib/dingtalk-runtime-state.js";
+export default definePlugin({
+    name: 'dingtalk',
+    metadata: {
+        displayName: 'DingTalk (钉钉) Adapter',
+    },
+    setup(context) {
+        context.resources.provide(dingtalkRuntimeStateToken, createEndpointRuntimeState());
+        if (context.resources.has(permissionHostToken)) {
+            const host = context.resources.use(permissionHostToken);
+            return host.registerPlatform('dingtalk', checkDingtalkPlatformPermit);
+        }
+    },
+});

package/schema.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "apiBaseUrl": {
+      "type": "string",
+      "default": "https://oapi.dingtalk.com"
+    },
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（DingTalk userid；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "Trusted DingTalk userid"
+      },
+      "description": "框架 trusted 用户列表（弱于 master）。endpoints[i].trusted 可逐项追加"
+    },
+    "endpoints": {
+      "type": "array",
+      "description": "多账号：一个插件实例挂多个 endpoint。每项与顶层字段同构（id 必填，其余覆盖顶层）",
+      "items": {
+        "type": "object",
+        "additionalProperties": true,
+        "properties": {
+          "master": {
+            "type": [
+              "string",
+              "number"
+            ],
+            "description": "本 endpoint 的框架 master（DingTalk userid）；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "Trusted DingTalk userid"
+            },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "appKey": {
+            "type": "string",
+            "description": "Dingtalk app key"
+          },
+          "appSecret": {
+            "type": "string",
+            "description": "Dingtalk app secret"
+          },
+          "webhookPath": {
+            "type": "string",
+            "description": "Dingtalk webhook path"
+          },
+          "robotCode": {
+            "type": "string",
+            "description": "Dingtalk robot code"
+          },
+          "id": {
+            "type": "string",
+            "description": "Dingtalk bot name"
+          }
+        },
+        "required": [
+          "id",
+          "appKey",
+          "appSecret",
+          "webhookPath",
+          "robotCode"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}

package/src/client.ts

@@ -0,0 +1,16 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+import type { DingTalkClient } from './endpoint.js';
+import type { DingTalkEvent } from './protocol.js';
+
+export type DingtalkClientEventMap = Record<string, DingTalkEvent>;
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly dingtalk: {
+      readonly client: DingTalkClient;
+      readonly events: DingtalkClientEventMap;
+    };
+  }
+}
+
+export const dingtalkClient = defineEndpointClient<DingTalkClient, DingtalkClientEventMap>('dingtalk');

package/src/dingtalk-endpoint-commands.ts

@@ -0,0 +1,19 @@
+/**
+ * `dingtalk.endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { dingtalkRuntimeStateToken } from './dingtalk-runtime-state.js';
+
+export const dingtalkEndpointCommands = createEndpointCommands({
+  adapterKey: 'dingtalk',
+  adapterDisplayName: 'DingTalk',
+  fields: [
+    { key: 'appKey', required: true, env: true, description: '钉钉 AppKey' },
+    { key: 'appSecret', required: true, env: true, description: '钉钉 AppSecret' },
+    { key: 'robotCode', required: true, env: true, description: '机器人 Code（出站 senderStaffId）' },
+  ],
+  running: (use) => use(dingtalkRuntimeStateToken).endpoints.values(),
+  describeEntry: (entry) => `appKey: ${String(entry.appKey)}`,
+}, defineCommand);

package/src/dingtalk-runtime-state.ts

@@ -0,0 +1,7 @@
+/**
+ * DingTalk 插件实例的运行时状态：adapter create() 注册的 endpoint 列表。
+ * 由 plugin.ts setup() provide，adapter create 与 `dingtalk.endpoint` 命令共享（同一 owner generation）。
+ */
+import { defineEndpointRuntimeStateToken } from 'zhin.js/adapter';
+
+export const dingtalkRuntimeStateToken = defineEndpointRuntimeStateToken('dingtalk');