@zhin.js/adapter-kook 1.0.83 → 1.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/adapter-kook",
-  "version": "1.0.83",
-  "description": "Zhin.js adapter for KOOK (开黑啦)",
+  "version": "1.1.0",
+  "description": "Zhin.js KOOK adapter for Plugin Runtime (WebSocket gateway or Webhook)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -33,53 +33,85 @@
     "directory": "plugins/adapters/kook"
   },
   "dependencies": {
-    "kook-client": "^1.0.4"
-  },
-  "devDependencies": {
-    "@types/react": "^19.2.14",
-    "@types/react-dom": "^19.2.3",
-    "lucide-react": "^1.14.0",
-    "typescript": "^6.0.3",
-    "@zhin.js/cli": "1.0.76",
-    "@zhin.js/console": "2.0.23",
-    "zhin.js": "1.0.80"
+    "kook-client": "^1.0.4",
+    "@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",
+    "@zhin.js/permission": "1.1.0"
   },
   "peerDependencies": {
-    "@zhin.js/client": "1.0.18",
-    "@zhin.js/console": "2.0.23",
-    "@zhin.js/http": "1.0.73",
-    "@zhin.js/logger": "0.1.62",
-    "zhin.js": "1.0.80"
+    "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": "^1.1.0"
   },
   "peerDependenciesMeta": {
-    "@zhin.js/client": {
+    "@zhin.js/agent": {
+      "optional": true
+    },
+    "@zhin.js/command": {
       "optional": true
     },
-    "@zhin.js/http": {
+    "zhin.js": {
       "optional": true
     },
-    "@zhin.js/console": {
+    "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/host-http": "1.1.0",
+    "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": "zhin build",
-    "clean": "rimraf lib dist",
-    "build:node": "tsc"
+    "build": "tsc",
+    "clean": "rimraf lib",
+    "test": "NODE_OPTIONS=--experimental-strip-types vitest run --root ../../.. plugins/adapters/kook/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 { checkKookPlatformPermit } from "./lib/platform-permit.js";
+import { kookRuntimeStateToken } from "./lib/kook-runtime-state.js";
+export default definePlugin({
+    name: 'kook',
+    metadata: {
+        displayName: 'KOOK WebSocket Adapter',
+    },
+    setup(context) {
+        context.resources.provide(kookRuntimeStateToken, createEndpointRuntimeState());
+        if (context.resources.has(permissionHostToken)) {
+            const host = context.resources.use(permissionHostToken);
+            return host.registerPlatform('kook', checkKookPlatformPermit);
+        }
+    },
+});

package/schema.json

@@ -0,0 +1,128 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "connection": {
+      "type": "string",
+      "enum": [
+        "websocket",
+        "webhook"
+      ],
+      "default": "websocket",
+      "description": "WebSocket gateway (default). webhook requires httpHostToken, verify_token, and a public HTTPS callback URL."
+    },
+    "webhookPath": {
+      "type": "string",
+      "default": "/kook/webhook",
+      "description": "POST path registered via httpHostToken when connection is webhook."
+    },
+    "data_dir": {
+      "type": "string"
+    },
+    "timeout": {
+      "type": "number",
+      "default": 10000
+    },
+    "max_retry": {
+      "type": "number",
+      "default": 3
+    },
+    "ignore": {
+      "type": "string",
+      "enum": [
+        "bot",
+        "self"
+      ],
+      "default": "bot"
+    },
+    "logLevel": {
+      "type": "string",
+      "enum": [
+        "trace",
+        "debug",
+        "info",
+        "warn",
+        "error",
+        "fatal",
+        "mark",
+        "off"
+      ],
+      "default": "info"
+    },
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（KOOK user id；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "Trusted KOOK user id"
+      },
+      "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（KOOK user id）；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "Trusted KOOK user id"
+            },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "token": {
+            "type": "string",
+            "description": "KOOK bot token"
+          },
+          "verify_token": {
+            "type": "string",
+            "description": "KOOK developer console verify token (required for webhook mode)."
+          },
+          "encrypt_key": {
+            "type": "string",
+            "description": "Optional Encrypt Key when message encryption is enabled in KOOK console."
+          },
+          "id": {
+            "type": "string",
+            "description": "KOOK bot name"
+          }
+        },
+        "required": [
+          "id",
+          "token"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}

package/src/client.ts

@@ -0,0 +1,15 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+import type { KookClientTransport } from './ws.js';
+
+export type KookClientEventMap = Record<string, unknown>;
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly kook: {
+      readonly client: KookClientTransport;
+      readonly events: KookClientEventMap;
+    };
+  }
+}
+
+export const kookClient = defineEndpointClient<KookClientTransport, KookClientEventMap>('kook');