@zhin.js/adapter-discord 1.1.17 → 1.1.19

package/src/adapter.ts

@@ -0,0 +1,38 @@
+import { Adapter, type AdapterContext, type EndpointCreationContext } from 'zhin.js/adapter';
+import { httpHostToken } from '@zhin.js/host-http';
+import { REST, Routes } from 'discord.js';
+import { DiscordGatewayEndpoint, DiscordInteractionsEndpoint } from './endpoint.js';
+import { createDiscordRestApiAgent } from './rest-api-proxy.js';
+import { resolveDiscordConfig, type DiscordEndpointConfig } from './protocol.js';
+import type { DiscordClientEventMap } from './client.js';
+
+export class DiscordAdapter extends Adapter<DiscordGatewayEndpoint | DiscordInteractionsEndpoint, DiscordEndpointConfig, DiscordClientEventMap> {
+  constructor(private readonly context: AdapterContext<DiscordEndpointConfig>) { super(); }
+  override get configurationIdentityFields(): readonly string[] { return ['id', 'applicationId']; }
+  override get configurationIdentityProbeFields(): readonly string[] { return ['token', 'publicKey']; }
+  override get configurationUpdateFields(): readonly string[] { return ['token', 'connection', 'restApiProxy', 'restApiProxy.port',
+    'gatewayFaultProxyUrl', 'intents', 'defaultActivity', 'defaultActivity.name', 'defaultActivity.type', 'defaultActivity.url', 'publicKey', 'interactionsPath']; }
+  protected override validateConfiguration(input: DiscordEndpointConfig): void { resolveDiscordConfig(input); }
+  protected override async identifyConfiguration(input: DiscordEndpointConfig, signal: AbortSignal): Promise<string> {
+    const config = resolveDiscordConfig(input);
+    const agent = config.connection === 'gateway' && config.restApiProxy ? createDiscordRestApiAgent(config.restApiProxy) : undefined;
+    const rest = new REST({ version: '10', retries: 0, rejectOnRateLimit: () => true, ...(agent ? { agent } : {}) }).setToken(config.token);
+    try {
+      const application = await rest.get(Routes.currentApplication(), { signal }) as { id?: unknown; verify_key?: unknown };
+      if (typeof application?.id !== 'string' || !application.id.trim()) throw new Error('Discord identity response is incomplete');
+      if (config.connection === 'interactions' && application.id !== config.applicationId) throw new Error('Discord application identity configuration does not match');
+      if (config.connection === 'interactions' && (typeof application.verify_key !== 'string'
+        || application.verify_key.toLowerCase() !== config.publicKey.toLowerCase())) {
+        throw new Error('Discord verification key does not match the application identity');
+      }
+      return JSON.stringify(['discord', application.id]);
+    } finally { rest.clearHashSweeper(); rest.clearHandlerSweeper(); await agent?.destroyProxy(); }
+  }
+  protected async createEndpoint(input: DiscordEndpointConfig, execution: EndpointCreationContext): Promise<DiscordGatewayEndpoint | DiscordInteractionsEndpoint> {
+    const config = resolveDiscordConfig(input);
+    if (config.connection === 'interactions') return new DiscordInteractionsEndpoint({ id: execution.canonicalId, config, http: this.context.use(httpHostToken) });
+    const restApiAgent = config.restApiProxy ? createDiscordRestApiAgent(config.restApiProxy) : undefined;
+    try { return new DiscordGatewayEndpoint({ id: execution.canonicalId, config, restApiAgent }); }
+    catch (error) { await restApiAgent?.destroyProxy(); throw error; }
+  }
+}

package/src/client.ts

@@ -1,10 +1,11 @@
-import { defineEndpointClient } from 'zhin.js/adapter';
-import type { DiscordRestClient } from './endpoint.js';
+import type { ClientEvents } from 'discord.js';
+import type { DiscordAdapter } from './adapter.js';
+import type { DiscordGatewayEndpoint, DiscordInteractionsEndpoint } 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>;
+export type DiscordClient = DiscordGatewayEndpoint | DiscordInteractionsEndpoint;
+export type DiscordClientEventMap = { readonly [K in keyof ClientEvents]: ClientEvents[K][0] } & Record<string, unknown>;
 
 /** Narrow an adapter Client for Gateway-only SDK operations. */
 export function requireDiscordGatewayClient(client: DiscordClient): DiscordClientTransport {
@@ -13,12 +14,5 @@ export function requireDiscordGatewayClient(client: DiscordClient): DiscordClien
 }
 
 declare module '@zhin.js/feature-kit' {
-  interface AdapterClientRegistry {
-    readonly discord: {
-      readonly client: DiscordClient;
-      readonly events: DiscordClientEventMap;
-    };
-  }
+  interface AdapterRegistry { readonly discord: DiscordAdapter; }
 }
-
-export const discordClient = defineEndpointClient<DiscordClient, DiscordClientEventMap>('discord');

package/src/console-spec.ts

@@ -0,0 +1,24 @@
+/**
+ * Discord Console 页面元数据（浏览器与服务端共享；不要在这里 import 服务端代码）。
+ */
+import type { AdapterConsoleField } from 'zhin.js/adapter';
+
+export const discordConsoleSpec = {
+  adapterKey: 'discord',
+  adapterDisplayName: 'Discord',
+  fields: [
+    { key: 'token', required: true, env: true, description: 'Discord bot token' },
+    { key: 'connection', description: 'gateway or interactions' },
+    { key: 'applicationId', description: 'Application ID for Interactions; identity changes replace the account' },
+    { key: 'publicKey', description: 'Application Ed25519 public key' },
+    { key: 'interactionsPath', description: 'Local Interactions route' },
+    { key: 'restApiProxy.port', type: 'number', description: 'Configured REST loopback proxy port' },
+    { key: 'gatewayFaultProxyUrl', description: 'Configured local Gateway fault proxy URL' },
+    { key: 'defaultActivity.name', description: 'SDK activity name' },
+    { key: 'defaultActivity.type', description: 'PLAYING, STREAMING, LISTENING, WATCHING or COMPETING' },
+    { key: 'defaultActivity.url', description: 'SDK activity URL' },
+  ] as readonly AdapterConsoleField[],
+  docsUrl: 'https://zhin.js.org/adapters/discord',
+  readPermission: 'discord:read',
+  writePermission: 'discord:write',
+} as const;

package/src/console.ts

@@ -0,0 +1,17 @@
+/**
+ * Discord Console RPC：运行状态 + endpoint 增删（原 `discord endpoint` 聊天命令）。
+ *
+ * 页面绑定 `pages/index`，读取 / 写入分别要求 `<adapter>:read` / `<adapter>:write`。
+ */
+import { createAdapterConsoleRpc } from 'zhin.js/adapter';
+import type { PluginConsoleRpc } from 'zhin.js';
+import { discordConsoleSpec } from './console-spec.js';
+
+export function createDiscordConsoleRpc(
+  getConfig: () => unknown,
+): PluginConsoleRpc {
+  return createAdapterConsoleRpc({
+    ...discordConsoleSpec,
+    getConfig,
+  });
+}