@zhin.js/adapter-discord 1.1.17 → 1.1.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,32 @@
1
1
  # @zhin.js/adapter-discord
2
2
 
3
+ ## 1.1.18
4
+
5
+ ### Patch Changes
6
+
7
+ - 6345a38: feat(adapters): add per-adapter Console pages
8
+
9
+ Every platform adapter now ships a `pages/index` Console page backed by a shared
10
+ `createAdapterConsolePage` component and `createAdapterConsoleRpc` server helper:
11
+
12
+ - See running endpoints, test connectivity, and manage
13
+ `plugins.<adapter>.endpoints` (add/remove writes `.env` references) from the
14
+ Console instead of chat commands.
15
+ - Surface LoginAssist pending tasks (QR / slider / SMS / device) so ICQQ login no
16
+ longer requires the terminal.
17
+ - QQ moves its QR binding flow (`qq endpoint add`) into Console actions with
18
+ public/private selection.
19
+ - Pages are permission-gated by `<adapter>:read`; writes need `<adapter>:write`.
20
+
21
+ - Updated dependencies [6345a38]
22
+ - Updated dependencies [ff3efe7]
23
+ - Updated dependencies [c58c589]
24
+ - @zhin.js/adapter@1.1.25
25
+ - @zhin.js/client@1.1.21
26
+ - @zhin.js/core@1.1.53
27
+ - @zhin.js/im-contract@1.1.9
28
+ - @zhin.js/tool@1.1.12
29
+
3
30
  ## 1.1.17
4
31
 
5
32
  ### Patch Changes
package/README.md CHANGED
@@ -87,6 +87,16 @@ discord:
87
87
  3. 开启 **MESSAGE CONTENT INTENT**
88
88
  4. 通过 OAuth2 URL 邀请 Bot 加入服务器
89
89
 
90
+ ## Console 页面
91
+
92
+ 启动后打开 Console 的「Discord」页(地址 `/discord`),可以:
93
+
94
+ - 查看运行中的连接、点「测试连接」做连通性诊断;
95
+ - 增删 `plugins.discord.endpoints`(凭据写入 `.env`,配置里只保留 `${ENV}` 引用);
96
+ - 如果适配器要求登录,页面会显示 LoginAssist 的扫码 / 滑块 / 设备确认待办;
97
+
98
+ 读取需要 `discord:read`,写操作需要 `discord:write`;管理员 full token 不受限。页面里的「添加 endpoint」等价于原来的 `discord endpoint add`。
99
+
90
100
  ## 故障排查
91
101
 
92
102
  | 现象 | 排查 |
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Discord Console 页面元数据(浏览器与服务端共享;不要在这里 import 服务端代码)。
3
+ */
4
+ import type { AdapterConsoleField } from 'zhin.js/adapter';
5
+ export declare const discordConsoleSpec: {
6
+ readonly adapterKey: "discord";
7
+ readonly adapterDisplayName: "Discord";
8
+ readonly fields: readonly AdapterConsoleField[];
9
+ readonly docsUrl: "https://zhin.js.org/adapters/discord";
10
+ readonly readPermission: "discord:read";
11
+ readonly writePermission: "discord:write";
12
+ };
@@ -0,0 +1,10 @@
1
+ export const discordConsoleSpec = {
2
+ adapterKey: 'discord',
3
+ adapterDisplayName: 'Discord',
4
+ fields: [
5
+ { key: 'token', required: true, env: true, description: 'Discord bot token' },
6
+ ],
7
+ docsUrl: 'https://zhin.js.org/adapters/discord',
8
+ readPermission: 'discord:read',
9
+ writePermission: 'discord:write',
10
+ };
@@ -0,0 +1,8 @@
1
+ /**
2
+ * Discord Console RPC:运行状态 + endpoint 增删(原 `discord endpoint` 聊天命令)。
3
+ *
4
+ * 页面绑定 `pages/index`,读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
5
+ */
6
+ import { type AdapterConsoleResources } from 'zhin.js/adapter';
7
+ import type { PluginConsoleRpc } from 'zhin.js';
8
+ export declare function createDiscordConsoleRpc(resources: AdapterConsoleResources, getConfig: () => unknown): PluginConsoleRpc;
package/lib/console.js ADDED
@@ -0,0 +1,16 @@
1
+ /**
2
+ * Discord Console RPC:运行状态 + endpoint 增删(原 `discord endpoint` 聊天命令)。
3
+ *
4
+ * 页面绑定 `pages/index`,读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
5
+ */
6
+ import { createAdapterConsoleRpc } from 'zhin.js/adapter';
7
+ import { discordRuntimeStateToken } from './discord-runtime-state.js';
8
+ import { discordConsoleSpec } from './console-spec.js';
9
+ export function createDiscordConsoleRpc(resources, getConfig) {
10
+ const state = resources.use(discordRuntimeStateToken);
11
+ return createAdapterConsoleRpc({
12
+ ...discordConsoleSpec,
13
+ running: () => state.endpoints.values(),
14
+ getConfig,
15
+ }, resources);
16
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zhin.js/adapter-discord",
3
- "version": "1.1.17",
3
+ "version": "1.1.18",
4
4
  "description": "Zhin.js Discord adapter for Plugin Runtime (Gateway WebSocket)",
5
5
  "type": "module",
6
6
  "main": "./lib/index.js",
@@ -31,27 +31,30 @@
31
31
  "directory": "plugins/adapters/discord"
32
32
  },
33
33
  "dependencies": {
34
- "discord.js": "^14.27.0",
35
- "@discordjs/ws": "1.2.3",
36
34
  "@discordjs/collection": "2.1.1",
35
+ "@discordjs/ws": "1.2.3",
36
+ "discord.js": "^14.27.0",
37
37
  "undici": "6.29.1",
38
- "@zhin.js/adapter": "1.1.24",
38
+ "@zhin.js/adapter": "1.1.25",
39
39
  "@zhin.js/agent-feature": "1.1.10",
40
- "@zhin.js/core": "1.1.52",
40
+ "@zhin.js/client": "1.1.21",
41
+ "@zhin.js/console-contract": "1.1.3",
42
+ "@zhin.js/core": "1.1.53",
41
43
  "@zhin.js/feature-kit": "1.1.9",
42
44
  "@zhin.js/host-http": "1.1.11",
43
- "@zhin.js/im-contract": "1.1.8",
45
+ "@zhin.js/im-contract": "1.1.9",
44
46
  "@zhin.js/logger": "1.1.2",
47
+ "@zhin.js/page": "1.1.10",
45
48
  "@zhin.js/permission": "1.1.9",
46
49
  "@zhin.js/skill": "1.1.10",
47
- "@zhin.js/tool": "1.1.11"
50
+ "@zhin.js/tool": "1.1.12"
48
51
  },
49
52
  "peerDependencies": {
50
53
  "zod": "^4.0.0",
51
- "@zhin.js/adapter": "^1.1.24",
54
+ "@zhin.js/adapter": "^1.1.25",
52
55
  "@zhin.js/command": "^1.1.11",
53
- "@zhin.js/core": "^1.1.52",
54
- "zhin.js": "^1.1.17"
56
+ "@zhin.js/core": "^1.1.53",
57
+ "zhin.js": "^1.1.18"
55
58
  },
56
59
  "peerDependenciesMeta": {
57
60
  "@zhin.js/command": {
@@ -70,11 +73,12 @@
70
73
  "vitest": "^4.1.10",
71
74
  "zod": "^4.4.3",
72
75
  "@zhin.js/host-http": "1.1.11",
73
- "zhin.js": "1.1.17"
76
+ "zhin.js": "1.1.18"
74
77
  },
75
78
  "files": [
76
79
  "adapters",
77
80
  "commands",
81
+ "pages",
78
82
  "plugin.js",
79
83
  "schema.json",
80
84
  "src",
@@ -117,6 +121,10 @@
117
121
  {
118
122
  "package": "@zhin.js/agent-feature",
119
123
  "api": "^1.0.0"
124
+ },
125
+ {
126
+ "package": "@zhin.js/page",
127
+ "api": "^1.0.0"
120
128
  }
121
129
  ],
122
130
  "plugins": []
@@ -0,0 +1,15 @@
1
+ // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
+ import { definePage } from '@zhin.js/console-contract';
3
+ import { createAdapterConsolePage } from '@zhin.js/client';
4
+ export const meta = definePage({
5
+ title: 'Discord',
6
+ titleI18n: { en: 'Discord' },
7
+ icon: 'MessageCircle',
8
+ order: 62,
9
+ requiredPermissions: ['discord:read'],
10
+ });
11
+ /**
12
+ * Convention page: `pages/index/index.ts` → `/discord`(插件路径)。
13
+ * 连接状态、连接测试、endpoint 增删;登录待办来自 LoginAssist(ICQQ 等)。
14
+ */
15
+ export default createAdapterConsolePage('discord');
@@ -0,0 +1,16 @@
1
+ import { definePage } from '@zhin.js/console-contract';
2
+ import { createAdapterConsolePage } from '@zhin.js/client';
3
+
4
+ export const meta = definePage({
5
+ title: 'Discord',
6
+ titleI18n: { en: 'Discord' },
7
+ icon: 'MessageCircle',
8
+ order: 62,
9
+ requiredPermissions: ['discord:read'],
10
+ });
11
+
12
+ /**
13
+ * Convention page: `pages/index/index.ts` → `/discord`(插件路径)。
14
+ * 连接状态、连接测试、endpoint 增删;登录待办来自 LoginAssist(ICQQ 等)。
15
+ */
16
+ export default createAdapterConsolePage('discord');
package/plugin.js CHANGED
@@ -1,9 +1,10 @@
1
1
  // Generated by build-plugin-runtime-entries.mjs. Do not edit.
2
2
  import { createEndpointRuntimeState } from 'zhin.js/adapter';
3
- import { definePlugin } from 'zhin.js';
3
+ import { definePlugin, pluginConsoleRpcToken } from 'zhin.js';
4
4
  import { permissionHostToken } from '@zhin.js/permission';
5
5
  import { checkDiscordPlatformPermit } from "./lib/platform-permit.js";
6
6
  import { discordRuntimeStateToken } from "./lib/discord-runtime-state.js";
7
+ import { createDiscordConsoleRpc } from "./lib/console.js";
7
8
  export default definePlugin({
8
9
  name: 'discord',
9
10
  metadata: {
@@ -11,6 +12,7 @@ export default definePlugin({
11
12
  },
12
13
  setup(context) {
13
14
  context.resources.provide(discordRuntimeStateToken, createEndpointRuntimeState());
15
+ context.resources.provide(pluginConsoleRpcToken, createDiscordConsoleRpc(context.resources, () => context.config.get()));
14
16
  if (context.resources.has(permissionHostToken)) {
15
17
  const host = context.resources.use(permissionHostToken);
16
18
  return host.registerPlatform('discord', checkDiscordPlatformPermit);
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Discord Console 页面元数据(浏览器与服务端共享;不要在这里 import 服务端代码)。
3
+ */
4
+ import type { AdapterConsoleField } from 'zhin.js/adapter';
5
+
6
+ export const discordConsoleSpec = {
7
+ adapterKey: 'discord',
8
+ adapterDisplayName: 'Discord',
9
+ fields: [
10
+ { key: 'token', required: true, env: true, description: 'Discord bot token' },
11
+ ] as readonly AdapterConsoleField[],
12
+ docsUrl: 'https://zhin.js.org/adapters/discord',
13
+ readPermission: 'discord:read',
14
+ writePermission: 'discord:write',
15
+ } as const;
package/src/console.ts ADDED
@@ -0,0 +1,21 @@
1
+ /**
2
+ * Discord Console RPC:运行状态 + endpoint 增删(原 `discord endpoint` 聊天命令)。
3
+ *
4
+ * 页面绑定 `pages/index`,读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
5
+ */
6
+ import { createAdapterConsoleRpc, type AdapterConsoleResources } from 'zhin.js/adapter';
7
+ import type { PluginConsoleRpc } from 'zhin.js';
8
+ import { discordRuntimeStateToken } from './discord-runtime-state.js';
9
+ import { discordConsoleSpec } from './console-spec.js';
10
+
11
+ export function createDiscordConsoleRpc(
12
+ resources: AdapterConsoleResources,
13
+ getConfig: () => unknown,
14
+ ): PluginConsoleRpc {
15
+ const state = resources.use(discordRuntimeStateToken);
16
+ return createAdapterConsoleRpc({
17
+ ...discordConsoleSpec,
18
+ running: () => state.endpoints.values(),
19
+ getConfig,
20
+ }, resources);
21
+ }