@zhin.js/adapter-kook 1.0.83 → 1.1.0

package/lib/index.js

@@ -1,342 +1,6 @@
-/**
- * KOOK 适配器入口：类型扩展、导出、注册
- */
-import path from "node:path";
-import { usePlugin, createGroupManagementTools } from "zhin.js";
-import { KookAdapter } from "./adapter.js";
-export * from "./types.js";
-export { KookBot } from "./bot.js";
-export { KookAdapter } from "./adapter.js";
-const plugin = usePlugin();
-const { provide, useContext } = plugin;
-provide({
-    name: "kook",
-    description: "KOOK Adapter",
-    mounted: async (p) => {
-        const adapter = new KookAdapter(p);
-        await adapter.start();
-        return adapter;
-    },
-    dispose: async (adapter) => {
-        await adapter.stop();
-    },
-});
-useContext('tool', 'kook', (toolService, kook) => {
-    const groupTools = createGroupManagementTools(kook, 'kook');
-    const disposers = groupTools.map(t => toolService.addTool(t, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_grant_role',
-        description: '给用户授予 KOOK 服务器角色',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-                user_id: { type: 'string', description: '用户 ID' },
-                role_id: { type: 'string', description: '角色 ID' },
-            },
-            required: ['bot', 'guild_id', 'user_id', 'role_id'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            const success = await bot.grantRole(args.guild_id, args.user_id, args.role_id);
-            return { success, message: success ? `已授予用户 ${args.user_id} 角色 ${args.role_id}` : '授予角色失败' };
-        },
-    }, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_revoke_role',
-        description: '撤销用户的 KOOK 服务器角色',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-                user_id: { type: 'string', description: '用户 ID' },
-                role_id: { type: 'string', description: '角色 ID' },
-            },
-            required: ['bot', 'guild_id', 'user_id', 'role_id'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            const success = await bot.revokeRole(args.guild_id, args.user_id, args.role_id);
-            return { success, message: success ? `已撤销用户 ${args.user_id} 的角色 ${args.role_id}` : '撤销角色失败' };
-        },
-    }, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_list_roles',
-        description: '获取 KOOK 服务器的角色列表',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-            },
-            required: ['bot', 'guild_id'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            const roles = await bot.getRoleList(args.guild_id);
-            return {
-                roles: roles.map((r) => ({
-                    id: r.role_id,
-                    name: r.name,
-                    color: r.color,
-                    position: r.position,
-                    permissions: r.permissions,
-                })),
-                count: roles.length,
-            };
-        },
-    }, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_create_role',
-        description: '在 KOOK 服务器中创建新角色',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-                name: { type: 'string', description: '角色名称' },
-            },
-            required: ['bot', 'guild_id', 'name'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            const role = await bot.createRole(args.guild_id, args.name);
-            return {
-                success: true,
-                message: `已创建角色 "${args.name}"`,
-                role: { id: role.role_id, name: role.name },
-            };
-        },
-    }, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_delete_role',
-        description: '删除 KOOK 服务器中的角色',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-                role_id: { type: 'string', description: '角色 ID' },
-            },
-            required: ['bot', 'guild_id', 'role_id'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            const success = await bot.deleteRole(args.guild_id, args.role_id);
-            return { success, message: success ? `已删除角色 ${args.role_id}` : '删除角色失败' };
-        },
-    }, plugin.name));
-    disposers.push(toolService.addTool({
-        name: 'kook_blacklist',
-        description: 'KOOK 服务器黑名单管理：添加/移除',
-        parameters: {
-            type: 'object',
-            properties: {
-                bot: { type: 'string', description: 'Bot 名称' },
-                guild_id: { type: 'string', description: '服务器 ID' },
-                action: { type: 'string', description: 'add|remove', enum: ['add', 'remove'] },
-                user_id: { type: 'string', description: '用户 ID' },
-                remark: { type: 'string', description: '备注（add 可选）' },
-            },
-            required: ['bot', 'guild_id', 'action', 'user_id'],
-        },
-        platforms: ['kook'],
-        tags: ['kook'],
-        execute: async (args) => {
-            const bot = kook.bots.get(args.bot);
-            if (!bot)
-                throw new Error(`Bot ${args.bot} 不存在`);
-            switch (args.action) {
-                case 'add': {
-                    const success = await bot.addToBlacklist(args.guild_id, args.user_id, args.remark);
-                    return { success, message: success ? `已将 ${args.user_id} 加入黑名单` : '操作失败' };
-                }
-                case 'remove': {
-                    const success = await bot.removeFromBlacklist(args.guild_id, args.user_id);
-                    return { success, message: success ? `已将 ${args.user_id} 从黑名单移除` : '操作失败' };
-                }
-                default:
-                    return { success: false, message: `未知操作: ${args.action}` };
-            }
-        },
-    }, plugin.name));
-    return () => disposers.forEach(d => d());
-});
-// ── Web 控制台 ─────────────────────────────────────────────────────────
-useContext("web", (pageManager) => {
-    pageManager.addEntry({
-        id: "kook",
-        development: path.resolve(import.meta.dirname, "../client/index.tsx"),
-        production: path.resolve(import.meta.dirname, "../dist/index.js"),
-        meta: { name: "KOOK" },
-    });
-});
-useContext("router", "kook", (router, kook) => {
-    router.get("/api/kook/bots", async (ctx) => {
-        try {
-            const bots = Array.from(kook.bots.values());
-            const result = bots.map((bot) => {
-                try {
-                    return {
-                        name: bot.$config.name,
-                        connected: bot.$connected || false,
-                        guildCount: bot.guilds?.size || 0,
-                        status: bot.$connected ? "online" : "offline",
-                    };
-                }
-                catch {
-                    return { name: bot.$config.name, connected: false, guildCount: 0, status: "error" };
-                }
-            });
-            ctx.body = { success: true, data: result };
-        }
-        catch {
-            ctx.status = 500;
-            ctx.body = { success: false, error: "获取机器人数据失败" };
-        }
-    });
-    // Bot 连接/断开
-    router.post("/api/kook/bots/:name/connect", async (ctx) => {
-        try {
-            const bot = kook.bots.get(ctx.params.name);
-            if (!bot) {
-                ctx.status = 404;
-                ctx.body = { success: false, error: "Bot 不存在" };
-                return;
-            }
-            if (bot.$connected) {
-                ctx.body = { success: true, message: "已经在线" };
-                return;
-            }
-            await bot.$connect();
-            ctx.body = { success: true, message: "连接成功" };
-        }
-        catch (e) {
-            ctx.status = 500;
-            ctx.body = { success: false, error: e?.message || "连接失败" };
-        }
-    });
-    router.post("/api/kook/bots/:name/disconnect", async (ctx) => {
-        try {
-            const bot = kook.bots.get(ctx.params.name);
-            if (!bot) {
-                ctx.status = 404;
-                ctx.body = { success: false, error: "Bot 不存在" };
-                return;
-            }
-            if (!bot.$connected) {
-                ctx.body = { success: true, message: "已经离线" };
-                return;
-            }
-            await bot.$disconnect();
-            ctx.body = { success: true, message: "已断开" };
-        }
-        catch (e) {
-            ctx.status = 500;
-            ctx.body = { success: false, error: e?.message || "断开失败" };
-        }
-    });
-    // 角色列表
-    router.get("/api/kook/bots/:name/guilds/:guildId/roles", async (ctx) => {
-        try {
-            const bot = kook.bots.get(ctx.params.name);
-            if (!bot) {
-                ctx.status = 404;
-                ctx.body = { success: false, error: "Bot 不存在" };
-                return;
-            }
-            if (!bot.$connected) {
-                ctx.status = 400;
-                ctx.body = { success: false, error: "Bot 未连接" };
-                return;
-            }
-            const roles = await bot.getRoleList(ctx.params.guildId);
-            ctx.body = {
-                success: true,
-                data: roles.map((r) => ({
-                    id: r.role_id,
-                    name: r.name,
-                    color: r.color,
-                    position: r.position,
-                })),
-            };
-        }
-        catch (e) {
-            ctx.status = 500;
-            ctx.body = { success: false, error: e?.message || "获取角色列表失败" };
-        }
-    });
-    // 创建角色
-    router.post("/api/kook/bots/:name/guilds/:guildId/roles", async (ctx) => {
-        try {
-            const bot = kook.bots.get(ctx.params.name);
-            if (!bot) {
-                ctx.status = 404;
-                ctx.body = { success: false, error: "Bot 不存在" };
-                return;
-            }
-            if (!bot.$connected) {
-                ctx.status = 400;
-                ctx.body = { success: false, error: "Bot 未连接" };
-                return;
-            }
-            const { name } = ctx.request.body || {};
-            if (!name) {
-                ctx.status = 400;
-                ctx.body = { success: false, error: "缺少角色名称" };
-                return;
-            }
-            const role = await bot.createRole(ctx.params.guildId, name);
-            ctx.body = { success: true, data: { id: role.role_id, name: role.name } };
-        }
-        catch (e) {
-            ctx.status = 500;
-            ctx.body = { success: false, error: e?.message || "创建角色失败" };
-        }
-    });
-    // 删除角色
-    router.delete("/api/kook/bots/:name/guilds/:guildId/roles/:roleId", async (ctx) => {
-        try {
-            const bot = kook.bots.get(ctx.params.name);
-            if (!bot) {
-                ctx.status = 404;
-                ctx.body = { success: false, error: "Bot 不存在" };
-                return;
-            }
-            if (!bot.$connected) {
-                ctx.status = 400;
-                ctx.body = { success: false, error: "Bot 未连接" };
-                return;
-            }
-            const success = await bot.deleteRole(ctx.params.guildId, ctx.params.roleId);
-            ctx.body = { success, message: success ? "角色已删除" : "删除失败" };
-        }
-        catch (e) {
-            ctx.status = 500;
-            ctx.body = { success: false, error: e?.message || "删除角色失败" };
-        }
-    });
-});
-//# sourceMappingURL=index.js.map
+export { formatInboundContent, formatOutboundKmarkdown, resolveKookConfig, senderDisplayName, KookPermission, } from './protocol.js';
+export { KookWebhookEndpoint, KookWebsocketEndpoint, } from './endpoint.js';
+export { registerKookWebhookRoutes, handleKookWebhookRequest, } from './webhook.js';
+export { defaultCreateClient, defaultCreateWebhookClient, normalizeKookMessage, } from './ws.js';
+export { kookClient } from './client.js';
+export { checkKookPlatformPermit, kookGroupPermitResolver, normalizeKookSenderForPermit, platformPermit, } from './platform-permit.js';

package/lib/kook-endpoint-commands.d.ts

@@ -0,0 +1 @@
+export declare const kookEndpointCommands: import("@zhin.js/adapter").EndpointCommands<Readonly<import("@zhin.js/command").CommandDefinition<unknown, unknown, import("@zhin.js/command").CommandMessage, string | undefined>>>;

package/lib/kook-endpoint-commands.js

@@ -0,0 +1,18 @@
+/**
+ * `kook.endpoint` 命令族：由 @zhin.js/adapter 的 createEndpointCommands 套件生成。
+ * commands/endpoint/ 下的 list / add / remove 直接默认导出这三项。
+ */
+import { createEndpointCommands } from 'zhin.js/adapter';
+import { defineCommand } from 'zhin.js/command';
+import { kookRuntimeStateToken } from './kook-runtime-state.js';
+export const kookEndpointCommands = createEndpointCommands({
+    adapterKey: 'kook',
+    adapterDisplayName: 'KOOK',
+    fields: [
+        { key: 'token', required: true, env: true, description: 'KOOK bot token' },
+        { key: 'encrypt_key', env: true, description: 'webhook 加密密钥（connection: webhook）' },
+        { key: 'verify_token', env: true, description: 'webhook 验证 token（connection: webhook）' },
+    ],
+    running: (use) => use(kookRuntimeStateToken).endpoints.values(),
+    describeEntry: (entry) => `token: ${String(entry.token)}`,
+}, defineCommand);

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

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

package/lib/kook-runtime-state.js

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

package/lib/platform-permit.d.ts

@@ -0,0 +1,22 @@
+/**
+ * KOOK platform permit — guild / channel 差异化门禁
+ */
+import type { PermissionSubject } from '@zhin.js/permission';
+import { KookPermission } from './protocol.js';
+export declare function platformPermit(perm: string): string;
+export declare function kookGroupPermitResolver(logicalPerm: string): string;
+export interface KookSenderInfo {
+    id: string;
+    name: string;
+    permission?: KookPermission;
+    roles?: number[];
+    isGuildOwner?: boolean;
+    isAdmin?: boolean;
+    role?: string;
+    permissions?: string[];
+}
+export declare function normalizeKookSenderForPermit(info: KookSenderInfo, isChannel: boolean): {
+    role?: string;
+    permissions?: string[];
+};
+export declare function checkKookPlatformPermit(perm: string, subject: PermissionSubject): boolean;

package/lib/platform-permit.js

@@ -0,0 +1,48 @@
+import { KookPermission } from './protocol.js';
+const ADAPTER = 'kook';
+export function platformPermit(perm) {
+    return `platform(${ADAPTER},${perm})`;
+}
+const FACTORY_PERM_MAP = {
+    scene_admin: 'guild_admin',
+    scene_owner: 'guild_owner',
+};
+export function kookGroupPermitResolver(logicalPerm) {
+    return platformPermit(FACTORY_PERM_MAP[logicalPerm] ?? logicalPerm);
+}
+export function normalizeKookSenderForPermit(info, isChannel) {
+    const permissions = [];
+    if (info.roles?.length) {
+        permissions.push(...info.roles.map((r) => `role:${r}`));
+    }
+    if (info.isGuildOwner || info.permission === KookPermission.Owner) {
+        permissions.push('guild_owner', 'guild_admin');
+        return { role: 'owner', permissions };
+    }
+    if (info.permission === KookPermission.ChannelAdmin && isChannel) {
+        permissions.push('channel_admin', 'guild_admin');
+        return { role: 'channel_admin', permissions };
+    }
+    if (info.isAdmin || info.permission === KookPermission.Admin) {
+        permissions.push('guild_admin');
+        return { role: 'admin', permissions };
+    }
+    return { role: 'member', permissions };
+}
+export function checkKookPlatformPermit(perm, subject) {
+    const role = subject.sender?.role?.[0];
+    const permissions = subject.sender?.permissions ?? [];
+    const has = (t) => permissions.includes(t);
+    switch (perm) {
+        case 'guild_owner':
+            return role === 'owner' || has('guild_owner');
+        case 'guild_admin':
+            return role === 'owner' || role === 'admin' || role === 'channel_admin' || has('guild_admin') || has('channel_admin');
+        case 'channel_admin':
+            return role === 'owner' || role === 'admin' || role === 'channel_admin' || has('channel_admin') || has('guild_admin');
+        case 'manage_roles':
+            return role === 'owner' || role === 'admin' || has('guild_owner') || has('guild_admin');
+        default:
+            return false;
+    }
+}

package/lib/protocol.d.ts

@@ -0,0 +1,144 @@
+/**
+ * KOOK protocol helpers — no legacy Adapter/Endpoint / segment-mapper.
+ * Canonicalization is owned by gateway/core before endpoint.send.
+ */
+import type { IncomingMessage } from 'node:http';
+import type { ConversationRef } from '@zhin.js/im-contract';
+export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal' | 'mark' | 'off';
+export declare enum KookPermission {
+    Normal = 1,
+    Admin = 2,
+    Owner = 4,
+    ChannelAdmin = 5
+}
+/** Plugin Runtime owner config (`plugins.<instanceKey>` / schema.json). */
+export interface KookAdapterConfig {
+    readonly id?: string;
+    readonly token?: string;
+    /** Default `websocket`. `webhook` requires httpHostToken + verify_token. */
+    readonly connection?: 'websocket' | 'webhook';
+    readonly webhookPath?: string;
+    readonly verify_token?: string;
+    readonly encrypt_key?: string;
+    readonly data_dir?: string;
+    readonly timeout?: number;
+    readonly max_retry?: number;
+    readonly ignore?: 'bot' | 'self';
+    readonly logLevel?: LogLevel;
+    /** Transitional: legacy root `endpoints[]` with `context: kook`. */
+    readonly endpoints?: ReadonlyArray<{
+        readonly context?: string;
+        readonly id?: string;
+        readonly token?: string;
+        readonly connection?: 'websocket' | 'webhook';
+        readonly webhookPath?: string;
+        readonly verify_token?: string;
+        readonly encrypt_key?: string;
+        readonly data_dir?: string;
+        readonly timeout?: number;
+        readonly max_retry?: number;
+        readonly ignore?: 'bot' | 'self';
+        readonly logLevel?: LogLevel;
+    }>;
+}
+export interface ResolvedKookWebsocketConfig {
+    readonly context: 'kook';
+    readonly connection: 'websocket';
+    readonly id: string;
+    readonly token: string;
+    readonly data_dir?: string;
+    readonly timeout: number;
+    readonly max_retry: number;
+    readonly ignore: 'bot' | 'self';
+    readonly logLevel: LogLevel;
+}
+export interface ResolvedKookWebhookConfig {
+    readonly context: 'kook';
+    readonly connection: 'webhook';
+    readonly id: string;
+    readonly token: string;
+    readonly webhookPath: string;
+    readonly verifyToken: string;
+    readonly encryptKey?: string;
+    readonly ignore: 'bot' | 'self';
+    readonly logLevel: LogLevel;
+}
+export interface KookWebhookEventData {
+    readonly channel_type?: string;
+    readonly type?: number;
+    readonly target_id?: string;
+    readonly author_id?: string;
+    readonly content?: string;
+    readonly msg_id?: string;
+    readonly msg_timestamp?: number;
+    readonly verify_token?: string;
+    readonly challenge?: string;
+    readonly extra?: {
+        readonly guild_id?: string;
+        readonly author?: {
+            readonly id?: string;
+            readonly username?: string;
+            readonly bot?: boolean;
+            readonly roles?: number[];
+        };
+    };
+}
+export interface KookWebhookFrame {
+    readonly s?: number;
+    readonly sn?: number;
+    readonly d?: KookWebhookEventData;
+    readonly encrypt?: string;
+}
+export type ResolvedKookConfig = ResolvedKookWebsocketConfig | ResolvedKookWebhookConfig;
+export interface KookInboundMessage {
+    readonly id: string;
+    readonly content: string;
+    readonly channelKind: 'private' | 'channel';
+    readonly channelId: string;
+    readonly authorId: string;
+    readonly authorName: string;
+    readonly authorBot?: boolean;
+    readonly authorRoles?: number[];
+    readonly timestamp: number;
+    readonly guildId?: string;
+    readonly rawMessage?: string;
+}
+export interface KookWireSegment {
+    readonly type: string;
+    readonly data?: Record<string, unknown>;
+}
+export declare function resolveKookConfig(config?: KookAdapterConfig): ResolvedKookConfig;
+/**
+ * 入站归一化 → ConversationRef：频道消息的所属 guild 进 `parent`（guild 容器
+ * 映射为 channel 容器）；私聊（PERSON）无容器，直接 kind 'private'。
+ */
+export declare function kookInboundConversation(endpointKey: string, msg: KookInboundMessage): ConversationRef;
+export declare function senderDisplayName(msg: KookInboundMessage): string;
+/** Build inbound text for OutboundMessageService.receive */
+export declare function formatInboundContent(msg: KookInboundMessage): string;
+/**
+ * KOOK @ 用户标记为 `(met)<userId>(met)`；content 含 `(met)<botId>(met)` 时视为 @ 机器人。
+ * botId 取 client 缓存的 self_id（/me 类接口），拿不到则不标注。
+ */
+export declare function isKookBotMentioned(msg: KookInboundMessage, selfId?: string): boolean;
+/**
+ * Wire-encode an already-rendered outbound payload into KOOK KMarkdown.
+ * Segment canonicalization is intentionally not done here.
+ */
+export declare function formatOutboundKmarkdown(payload: unknown): string;
+export declare function normalizeWebhookPath(path: string): string;
+export declare function readTextBody(request: IncomingMessage, options?: {
+    readonly limit?: number;
+}): Promise<string>;
+export declare function readRequestBody(request: IncomingMessage, options?: {
+    readonly limit?: number;
+}): Promise<Buffer>;
+export declare function padKookEncryptKey(key: string): Buffer;
+export declare function decryptKookWebhookPayload(encrypted: string, encryptKey: string): Buffer;
+export declare function parseKookWebhookBody(rawBody: Buffer, encryptKey?: string): KookWebhookFrame;
+export declare function isKookWebhookChallenge(event: KookWebhookEventData): boolean;
+export declare function verifyKookWebhookToken(expected: string, actual?: string): boolean;
+export declare function normalizeKookWebhookEvent(event: KookWebhookEventData, options?: {
+    readonly ignore?: 'bot' | 'self';
+    readonly selfId?: string;
+}): KookInboundMessage | null;