@zhin.js/adapter-discord 1.0.87 → 1.1.2

package/agents/discord/skills/discord/tools/remove_role/index.js

@@ -0,0 +1,24 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { requireDiscordGatewayClient } from '@zhin.js/adapter-discord';
+import { platformPermission } from '@zhin.js/permission';
+export default defineAgentTool({
+    description: '移除成员的 Discord 角色',
+    inputSchema: z.object({
+        guild_id: z.string().describe('服务器 ID'),
+        user_id: z.string().describe('用户 ID'),
+        role_id: z.string().describe('角色 ID'),
+    }),
+    adapter: 'discord',
+    tags: ['discord'],
+    permissions: [platformPermission('discord', 'manage_roles')],
+    async execute({ guild_id, user_id, role_id }, context) {
+        const client = requireDiscordGatewayClient(context.$client);
+        const guild = await client.guilds.fetch(guild_id);
+        const member = await guild.members.fetch(user_id);
+        await member.roles.remove(role_id);
+        const success = true;
+        return { success, message: success ? `已移除用户 ${user_id} 的角色` : '操作失败' };
+    },
+});

package/agents/discord/skills/discord/tools/remove_role/index.ts

@@ -0,0 +1,26 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { requireDiscordGatewayClient } from '@zhin.js/adapter-discord';
+import { platformPermission } from '@zhin.js/permission';
+
+export default defineAgentTool<{ guild_id: string; user_id: string; role_id: string }>({
+  description: '移除成员的 Discord 角色',
+  inputSchema: z.object({
+    guild_id: z.string().describe('服务器 ID'),
+    user_id: z.string().describe('用户 ID'),
+    role_id: z.string().describe('角色 ID'),
+  }),
+  adapter: 'discord',
+  tags: ['discord'],
+  permissions: [platformPermission('discord', 'manage_roles')],
+  async execute({ guild_id, user_id, role_id  }: { guild_id: string; user_id: string; role_id: string }, context) {
+    const client = requireDiscordGatewayClient(context.$client);
+    const guild = await client.guilds.fetch(guild_id);
+    const member = await guild.members.fetch(user_id) as {
+      roles: { remove(id: string): Promise<unknown> };
+    };
+    await member.roles.remove(role_id);
+    const success = true;
+    return { success, message: success ? `已移除用户 ${user_id} 的角色` : '操作失败' };
+  },
+});

package/agents/discord/skills/discord/tools/send_embed/index.js

@@ -0,0 +1,43 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { requireDiscordGatewayClient } from '@zhin.js/adapter-discord';
+export default defineAgentTool({
+    description: '发送 Discord 富文本嵌入消息（Embed）',
+    inputSchema: z.object({
+        channel_id: z.string().describe('频道 ID'),
+        title: z.string().optional().describe('Embed 标题'),
+        description: z.string().optional().describe('Embed 描述'),
+        color: z.number().optional().describe('颜色值（十进制，如 0x00ff00 = 65280）'),
+        url: z.string().optional().describe('标题链接（可选）'),
+        fields: z.string().optional().describe('字段，JSON 格式: [{"name":"k","value":"v","inline":false}]'),
+    }),
+    adapter: 'discord',
+    tags: ['discord'],
+    async execute({ channel_id, title, description, color, url, fields }, context) {
+        const client = requireDiscordGatewayClient(context.$client);
+        const embedData = {};
+        if (title)
+            embedData.title = title;
+        if (description)
+            embedData.description = description;
+        if (color)
+            embedData.color = color;
+        if (url)
+            embedData.url = url;
+        if (fields) {
+            try {
+                embedData.fields = JSON.parse(fields);
+            }
+            catch {
+                return { success: false, message: 'fields 格式错误，应为 JSON 数组' };
+            }
+        }
+        const channel = await client.channels.fetch(channel_id);
+        if (!channel?.isTextBased() || !channel.send) {
+            throw new Error(`Channel ${channel_id} 不是文本频道`);
+        }
+        const msg = await channel.send({ embeds: [embedData] });
+        return { success: true, message_id: msg.id, message: 'Embed 已发送' };
+    },
+});

package/agents/discord/skills/discord/tools/send_embed/index.ts

@@ -0,0 +1,38 @@
+import { defineAgentTool } from '@zhin.js/tool';
+import { z } from 'zod';
+import { requireDiscordGatewayClient } from '@zhin.js/adapter-discord';
+
+export default defineAgentTool<{ channel_id: string; title?: string; description?: string; color?: number; url?: string; fields?: string }>({
+  description: '发送 Discord 富文本嵌入消息（Embed）',
+  inputSchema: z.object({
+    channel_id: z.string().describe('频道 ID'),
+    title: z.string().optional().describe('Embed 标题'),
+    description: z.string().optional().describe('Embed 描述'),
+    color: z.number().optional().describe('颜色值（十进制，如 0x00ff00 = 65280）'),
+    url: z.string().optional().describe('标题链接（可选）'),
+    fields: z.string().optional().describe('字段，JSON 格式: [{"name":"k","value":"v","inline":false}]'),
+  }),
+  adapter: 'discord',
+  tags: ['discord'],
+  async execute({ channel_id, title, description, color, url, fields  }: { channel_id: string; title?: string; description?: string; color?: number; url?: string; fields?: string }, context) {
+    const client = requireDiscordGatewayClient(context.$client);
+    const embedData: Record<string, unknown> = {};
+    if (title) embedData.title = title;
+    if (description) embedData.description = description;
+    if (color) embedData.color = color;
+    if (url) embedData.url = url;
+    if (fields) {
+      try {
+        embedData.fields = JSON.parse(fields);
+      } catch {
+        return { success: false, message: 'fields 格式错误，应为 JSON 数组' };
+      }
+    }
+    const channel = await client.channels.fetch(channel_id);
+    if (!channel?.isTextBased() || !channel.send) {
+      throw new Error(`Channel ${channel_id} 不是文本频道`);
+    }
+    const msg = await channel.send({ embeds: [embedData] } as never);
+    return { success: true, message_id: msg.id, message: 'Embed 已发送' };
+  },
+});

package/agents/discord/system.md

@@ -0,0 +1,3 @@
+# DISCORD Platform Agent
+
+You are the discord platform specialist. Interpret requests in the current discord conversation and load only the narrowest private Skill needed for the task.

package/commands/discord/endpoint/add/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { discordEndpointCommands } from '../../definition.js';
+export default discordEndpointCommands.add;

package/commands/discord/endpoint/add/[id]/index.ts

@@ -0,0 +1,3 @@
+import { discordEndpointCommands } from '../../definition.js';
+
+export default discordEndpointCommands.add;

package/commands/discord/endpoint/definition.js

@@ -0,0 +1,19 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+/**
+ * `discord endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/discord/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ * 注：applicationId / publicKey 为顶层共享字段（slash commands / interactions 用），
+ * endpoints[i] 仅需 id + token（见 schema.json），故 add 只录入 token。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { discordRuntimeStateToken } from "../../../lib/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/commands/discord/endpoint/definition.ts

@@ -0,0 +1,19 @@
+/**
+ * `discord endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/discord/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ * 注：applicationId / publicKey 为顶层共享字段（slash commands / interactions 用），
+ * endpoints[i] 仅需 id + token（见 schema.json），故 add 只录入 token。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { discordRuntimeStateToken } from '../../../src/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/commands/discord/endpoint/list/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { discordEndpointCommands } from '../definition.js';
+export default discordEndpointCommands.list;

package/commands/discord/endpoint/list/index.ts

@@ -0,0 +1,3 @@
+import { discordEndpointCommands } from '../definition.js';
+
+export default discordEndpointCommands.list;

package/commands/discord/endpoint/remove/[id]/index.js

@@ -0,0 +1,3 @@
+// Generated by build-plugin-runtime-entries.mjs. Do not edit.
+import { discordEndpointCommands } from '../../definition.js';
+export default discordEndpointCommands.remove;

package/commands/discord/endpoint/remove/[id]/index.ts

@@ -0,0 +1,3 @@
+import { discordEndpointCommands } from '../../definition.js';
+
+export default discordEndpointCommands.remove;

package/lib/client.d.ts

@@ -0,0 +1,16 @@
+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 declare function requireDiscordGatewayClient(client: DiscordClient): DiscordClientTransport;
+declare module '@zhin.js/feature-kit' {
+    interface AdapterClientRegistry {
+        readonly discord: {
+            readonly client: DiscordClient;
+            readonly events: DiscordClientEventMap;
+        };
+    }
+}
+export declare const discordClient: import("@zhin.js/adapter").EndpointClientToken<DiscordClient, DiscordClientEventMap>;

package/lib/client.js

@@ -0,0 +1,8 @@
+import { defineEndpointClient } from 'zhin.js/adapter';
+/** Narrow an adapter Client for Gateway-only SDK operations. */
+export function requireDiscordGatewayClient(client) {
+    if ('guilds' in client && 'channels' in client)
+        return client;
+    throw new Error('This Discord tool requires a Gateway Endpoint Client');
+}
+export const discordClient = defineEndpointClient('discord');

package/lib/discord-runtime-state.d.ts

@@ -0,0 +1 @@
+export declare const discordRuntimeStateToken: import("zhin.js").Token<import("@zhin.js/adapter").EndpointRuntimeState>;

package/lib/discord-runtime-state.js

@@ -0,0 +1,6 @@
+/**
+ * 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');

package/lib/endpoint.d.ts

@@ -0,0 +1,72 @@
+import { Endpoint } from 'zhin.js/adapter';
+import type { EndpointContentPort, EndpointControl, EndpointManagement, EndpointSendRequest } from 'zhin.js/adapter';
+import type { HttpHost } from '@zhin.js/host-http';
+import { type MessageRef } from '@zhin.js/im-contract';
+import type { CapabilityId } from 'zhin.js';
+import { type CreateDiscordClient, type DiscordClientTransport } from './gateway.js';
+import { type DiscordButtonInbound, type DiscordInboundMessage, type ResolvedDiscordGatewayConfig, type ResolvedDiscordInteractionsConfig } from './protocol.js';
+export type { CreateDiscordClient, DiscordClientTransport, } from './gateway.js';
+export interface DiscordEndpointOptions {
+    readonly id: CapabilityId;
+    readonly config: ResolvedDiscordGatewayConfig;
+    readonly createClient?: CreateDiscordClient;
+    readonly fetch?: typeof globalThis.fetch;
+}
+export declare class DiscordGatewayEndpoint extends Endpoint<DiscordClientTransport> {
+    #private;
+    readonly management: EndpointManagement;
+    readonly control: EndpointControl;
+    readonly content: EndpointContentPort;
+    constructor(options: DiscordEndpointOptions);
+    /** The actual discord.js-compatible client used by this connection. */
+    get client(): DiscordClientTransport;
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
+    recallMessage(message: MessageRef): Promise<void>;
+    /** Test / internal: admit a message when open. */
+    admit(msg: DiscordInboundMessage): void;
+    /** Test / internal: admit a button interaction when open. */
+    admitButton(interaction: DiscordButtonInbound): void;
+}
+export interface DiscordInteractionsEndpointOptions {
+    readonly id: CapabilityId;
+    readonly http: HttpHost;
+    readonly config: ResolvedDiscordInteractionsConfig;
+    readonly fetch?: typeof globalThis.fetch;
+}
+/** Minimal Discord REST client used when Gateway is intentionally disabled. */
+export declare class DiscordRestClient {
+    readonly token: string;
+    readonly fetch: typeof globalThis.fetch;
+    constructor(token: string, fetch?: typeof globalThis.fetch);
+    request<T = unknown>(method: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE', path: string, body?: unknown): Promise<T>;
+    createMessage(channelId: string, body: unknown): Promise<{
+        id?: string;
+    }>;
+    deleteMessage(channelId: string, messageId: string): Promise<void>;
+}
+export declare class DiscordInteractionsEndpoint extends Endpoint<DiscordRestClient> {
+    #private;
+    readonly client: DiscordRestClient;
+    readonly control: EndpointControl;
+    readonly content: EndpointContentPort;
+    constructor(options: DiscordInteractionsEndpointOptions);
+    get isOpen(): boolean;
+    get config(): ResolvedDiscordInteractionsConfig;
+    start(): Promise<void>;
+    open(): void;
+    close(): void;
+    stop(): Promise<void>;
+    send({ conversation, payload }: EndpointSendRequest): Promise<string>;
+    recallMessage(message: MessageRef): Promise<void>;
+    admit(msg: DiscordInboundMessage): void;
+    admitPlatform(event: Record<string, unknown>): void;
+}
+/**
+ * DiscordGatewayEndpoint 的 EndpointManagement 语义端口（参照 qq 的工厂模式）。
+ * 数据源为 discord.js SDK 缓存：guilds.cache / guild.channels.cache / guild.members。
+ */
+export declare function createDiscordEndpointManagement(requireClient: () => DiscordClientTransport): EndpointManagement;