@zhin.js/adapter-discord 1.0.87 → 1.1.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zhin.js/adapter-discord",
-  "version": "1.0.87",
-  "description": "Zhin.js adapter for Discord",
+  "version": "1.1.0",
+  "description": "Zhin.js Discord adapter for Plugin Runtime (Gateway WebSocket)",
   "type": "module",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
@@ -32,52 +32,85 @@
     "directory": "plugins/adapters/discord"
   },
   "dependencies": {
-    "discord.js": "^14.26.4",
-    "tweetnacl": "^1.0.3"
-  },
-  "devDependencies": {
-    "@types/koa": "^3.0.0",
-    "@types/node": "^25.8.0",
-    "@types/react": "^19.2.14",
-    "@types/react-dom": "^19.2.3",
-    "lucide-react": "^1.16.0",
-    "typescript": "^6.0.3",
-    "@zhin.js/cli": "1.0.77",
-    "@zhin.js/console": "2.0.24",
-    "zhin.js": "1.0.81"
+    "discord.js": "^14.27.0",
+    "@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.24",
-    "@zhin.js/http": "1.0.74",
-    "zhin.js": "1.0.81"
+    "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": {
       "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/discord/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 { checkDiscordPlatformPermit } from "./lib/platform-permit.js";
+import { discordRuntimeStateToken } from "./lib/discord-runtime-state.js";
+export default definePlugin({
+    name: 'discord',
+    metadata: {
+        displayName: 'Discord Gateway Adapter',
+    },
+    setup(context) {
+        context.resources.provide(discordRuntimeStateToken, createEndpointRuntimeState());
+        if (context.resources.has(permissionHostToken)) {
+            const host = context.resources.use(permissionHostToken);
+            return host.registerPlatform('discord', checkDiscordPlatformPermit);
+        }
+    },
+});

package/schema.json

@@ -0,0 +1,141 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "connection": {
+      "type": "string",
+      "enum": [
+        "gateway",
+        "interactions"
+      ],
+      "default": "gateway",
+      "description": "Gateway WebSocket (default). interactions uses httpHostToken POST + Ed25519 verify."
+    },
+    "intents": {
+      "type": "array",
+      "items": {
+        "type": "number"
+      }
+    },
+    "enableSlashCommands": {
+      "type": "boolean",
+      "default": false
+    },
+    "globalCommands": {
+      "type": "boolean",
+      "default": false
+    },
+    "defaultActivity": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "PLAYING",
+            "STREAMING",
+            "LISTENING",
+            "WATCHING",
+            "COMPETING"
+          ]
+        },
+        "url": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "type"
+      ]
+    },
+    "slashCommands": {
+      "type": "array",
+      "items": {
+        "type": "object"
+      }
+    },
+    "applicationId": {
+      "type": "string",
+      "description": "Required when connection is interactions."
+    },
+    "publicKey": {
+      "type": "string",
+      "description": "Required when connection is interactions (hex Ed25519 public key)."
+    },
+    "interactionsPath": {
+      "type": "string",
+      "default": "/discord/interactions",
+      "description": "POST path on httpHostToken when connection is interactions."
+    },
+    "master": {
+      "type": [
+        "string",
+        "number"
+      ],
+      "description": "框架 master（Discord user snowflake；AI/工具权限、endpoint 管理）。endpoints[i].master 可逐项覆盖"
+    },
+    "trusted": {
+      "type": "array",
+      "items": {
+        "type": [
+          "string",
+          "number"
+        ],
+        "description": "Trusted Discord user snowflake"
+      },
+      "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（Discord user snowflake）；覆盖顶层 master"
+          },
+          "trusted": {
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "number"
+              ],
+              "description": "Trusted Discord user snowflake"
+            },
+            "description": "本 endpoint 的 trusted 列表"
+          },
+          "token": {
+            "type": "string",
+            "description": "Discord bot token"
+          },
+          "id": {
+            "type": "string",
+            "description": "Discord bot name"
+          }
+        },
+        "required": [
+          "id",
+          "token"
+        ]
+      }
+    },
+    "commandPrefix": {
+      "type": "string",
+      "default": "",
+      "description": "命令前缀（默认 '' 无前缀，任意文本按命令匹配；如 '/' 要求 / 开头）。endpoints[i] 可逐项覆盖"
+    }
+  },
+  "required": [
+    "endpoints"
+  ]
+}

package/src/client.ts

@@ -0,0 +1,24 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+import type { DiscordRestClient } from './endpoint.js';
+import type { DiscordClientTransport } from './gateway.js';
+
+/** Exact Client variants produced by the Gateway and Interactions Endpoints. */
+export type DiscordClient = DiscordClientTransport | DiscordRestClient;
+export type DiscordClientEventMap = Record<string, unknown>;
+
+/** Narrow an adapter Client for Gateway-only SDK operations. */
+export function requireDiscordGatewayClient(client: DiscordClient): DiscordClientTransport {
+  if ('guilds' in client && 'channels' in client) return client;
+  throw new Error('This Discord tool requires a Gateway Endpoint Client');
+}
+
+declare module '@zhin.js/feature-kit' {
+  interface AdapterClientRegistry {
+    readonly discord: {
+      readonly client: DiscordClient;
+      readonly events: DiscordClientEventMap;
+    };
+  }
+}
+
+export const discordClient = defineEndpointClient<DiscordClient, DiscordClientEventMap>('discord');

package/src/discord-endpoint-commands.ts

@@ -0,0 +1,19 @@
+/**
+ * `discord.endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ * 注：applicationId / publicKey 为顶层共享字段（slash commands / interactions 用），
+ * endpoints[i] 仅需 name + token（见 schema.json），故 add 只录入 token。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { discordRuntimeStateToken } from './discord-runtime-state.js';
+
+export const discordEndpointCommands = createEndpointCommands({
+  adapterKey: 'discord',
+  adapterDisplayName: 'Discord',
+  fields: [
+    { key: 'token', required: true, env: true, description: 'Discord bot token' },
+  ],
+  running: (use) => use(discordRuntimeStateToken).endpoints.values(),
+  describeEntry: (entry) => `token: ${String(entry.token)}`,
+}, defineCommand);

package/src/discord-runtime-state.ts

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