@zhin.js/adapter-kook 5.0.1 → 5.0.3

package/src/index.ts

@@ -1,331 +1,55 @@
-/**
- * KOOK 适配器入口：类型扩展、导出、注册
- */
-import path from "node:path";
-import { usePlugin, type Plugin, type ISceneManagement, createSceneManagementTools, type ToolFeature } from "zhin.js";
-import { KookAdapter } from "./adapter.js";
-import { kookGroupPermitResolver, platformPermit, registerKookPlatformPermitChecker } from "./platform-permit.js";
-import { PageManager } from "@zhin.js/host-api";
-
-declare module "zhin.js" {
-  namespace Plugin {
-    interface Contexts {
-      web: PageManager;
-    }
-  }
-}
-
-declare module "zhin.js" {
-  interface Adapters {
-    kook: KookAdapter;
-  }
-}
-
-export * from "./types.js";
-export { KookEndpoint } from "./endpoint.js";
-export { KookAdapter } from "./adapter.js";
-
-const plugin = usePlugin();
-const { provide, useContext } = plugin;
-
-provide({
-  name: "kook",
-  description: "KOOK Adapter",
-  mounted: async (p: Plugin) => {
-    const adapter = new KookAdapter(p);
-    await adapter.start();
-    return adapter;
-  },
-  dispose: async (adapter: KookAdapter) => {
-    await adapter.stop();
-  },
-});
-
-useContext('tool', 'kook', (toolService: ToolFeature, kook: KookAdapter) => {
-  const disposers: (() => void)[] = [];
-  disposers.push(registerKookPlatformPermitChecker());
-  const sceneTools = createSceneManagementTools(
-    kook as unknown as ISceneManagement,
-    'kook',
-    { permitResolver: kookGroupPermitResolver, registerChecker: false },
-  );
-  disposers.push(...sceneTools.map(t => toolService.addTool(t, plugin.name)));
-
-  disposers.push(toolService.addTool({
-    name: 'kook_grant_role',
-    description: '给用户授予 KOOK 服务器角色',
-    parameters: {
-      type: 'object',
-      properties: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        guild_id: { type: 'string', description: '服务器 ID' },
-        user_id: { type: 'string', description: '用户 ID' },
-        role_id: { type: 'string', description: '角色 ID' },
-      },
-      required: ['endpoint_id', 'guild_id', 'user_id', 'role_id'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    permissions: [platformPermit('manage_roles')],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      const success = await endpoint.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: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        guild_id: { type: 'string', description: '服务器 ID' },
-        user_id: { type: 'string', description: '用户 ID' },
-        role_id: { type: 'string', description: '角色 ID' },
-      },
-      required: ['endpoint_id', 'guild_id', 'user_id', 'role_id'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    permissions: [platformPermit('manage_roles')],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      const success = await endpoint.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: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        guild_id: { type: 'string', description: '服务器 ID' },
-      },
-      required: ['endpoint_id', 'guild_id'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      const roles = await endpoint.getRoleList(args.guild_id);
-      return {
-        roles: roles.map((r: any) => ({
-          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: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        guild_id: { type: 'string', description: '服务器 ID' },
-        name: { type: 'string', description: '角色名称' },
-      },
-      required: ['endpoint_id', 'guild_id', 'name'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    permissions: [platformPermit('guild_owner')],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      const role = await endpoint.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: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        guild_id: { type: 'string', description: '服务器 ID' },
-        role_id: { type: 'string', description: '角色 ID' },
-      },
-      required: ['endpoint_id', 'guild_id', 'role_id'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    permissions: [platformPermit('guild_owner')],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      const success = await endpoint.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: {
-        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
-        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: ['endpoint_id', 'guild_id', 'action', 'user_id'],
-    },
-    platforms: ['kook'],
-    tags: ['kook'],
-    permissions: [platformPermit('guild_admin')],
-    execute: async (args: Record<string, any>) => {
-      const endpoint = kook.endpoints.get(args.endpoint_id);
-      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
-      switch (args.action) {
-        case 'add': {
-          const success = await endpoint.addToBlacklist(args.guild_id, args.user_id, args.remark);
-          return { success, message: success ? `已将 ${args.user_id} 加入黑名单` : '操作失败' };
-        }
-        case 'remove': {
-          const success = await endpoint.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: any, kook: KookAdapter) => {
-  router.get("/api/kook/endpoints", async (ctx: any) => {
-    try {
-      const endpoints = Array.from(kook.endpoints.values());
-      const result = endpoints.map((endpoint: any) => {
-        try {
-          return {
-            name: endpoint.$config.name,
-            connected: endpoint.$connected || false,
-            guildCount: endpoint.guilds?.size || 0,
-            status: endpoint.$connected ? "online" : "offline",
-          };
-        } catch {
-          return { name: endpoint.$config.name, connected: false, guildCount: 0, status: "error" };
-        }
-      });
-      ctx.body = { success: true, data: result };
-    } catch {
-      ctx.status = 500;
-      ctx.body = { success: false, error: "获取 Endpoint 数据失败" };
-    }
-  });
-
-  // Endpoint 连接/断开
-  router.post("/api/kook/endpoints/:name/connect", async (ctx: any) => {
-    try {
-      const endpoint = kook.endpoints.get(ctx.params.name);
-      if (!endpoint) { ctx.status = 404; ctx.body = { success: false, error: "Endpoint 不存在" }; return; }
-      if (endpoint.$connected) { ctx.body = { success: true, message: "已经在线" }; return; }
-      await endpoint.$connect();
-      ctx.body = { success: true, message: "连接成功" };
-    } catch (e: unknown) {
-      ctx.status = 500;
-      ctx.body = { success: false, error: e instanceof Error ? e.message : "连接失败" };
-    }
-  });
-
-  router.post("/api/kook/endpoints/:name/disconnect", async (ctx: any) => {
-    try {
-      const endpoint = kook.endpoints.get(ctx.params.name);
-      if (!endpoint) { ctx.status = 404; ctx.body = { success: false, error: "Endpoint 不存在" }; return; }
-      if (!endpoint.$connected) { ctx.body = { success: true, message: "已经离线" }; return; }
-      await endpoint.$disconnect();
-      ctx.body = { success: true, message: "已断开" };
-    } catch (e: unknown) {
-      ctx.status = 500;
-      ctx.body = { success: false, error: e instanceof Error ? e.message : "断开失败" };
-    }
-  });
-
-  // 角色列表
-  router.get("/api/kook/endpoints/:name/guilds/:guildId/roles", async (ctx: any) => {
-    try {
-      const endpoint: any = kook.endpoints.get(ctx.params.name);
-      if (!endpoint) { ctx.status = 404; ctx.body = { success: false, error: "Endpoint 不存在" }; return; }
-      if (!endpoint.$connected) { ctx.status = 400; ctx.body = { success: false, error: "Endpoint 未连接" }; return; }
-      const roles = await endpoint.getRoleList(ctx.params.guildId);
-      ctx.body = {
-        success: true,
-        data: roles.map((r: any) => ({
-          id: r.role_id,
-          name: r.name,
-          color: r.color,
-          position: r.position,
-        })),
-      };
-    } catch (e: unknown) {
-      ctx.status = 500;
-      ctx.body = { success: false, error: e instanceof Error ? e.message : "获取角色列表失败" };
-    }
-  });
-
-  // 创建角色
-  router.post("/api/kook/endpoints/:name/guilds/:guildId/roles", async (ctx: any) => {
-    try {
-      const endpoint: any = kook.endpoints.get(ctx.params.name);
-      if (!endpoint) { ctx.status = 404; ctx.body = { success: false, error: "Endpoint 不存在" }; return; }
-      if (!endpoint.$connected) { ctx.status = 400; ctx.body = { success: false, error: "Endpoint 未连接" }; return; }
-      const { name } = ctx.request.body || {};
-      if (!name) { ctx.status = 400; ctx.body = { success: false, error: "缺少角色名称" }; return; }
-      const role = await endpoint.createRole(ctx.params.guildId, name);
-      ctx.body = { success: true, data: { id: role.role_id, name: role.name } };
-    } catch (e: unknown) {
-      ctx.status = 500;
-      ctx.body = { success: false, error: e instanceof Error ? e.message : "创建角色失败" };
-    }
-  });
-
-  // 删除角色
-  router.delete("/api/kook/endpoints/:name/guilds/:guildId/roles/:roleId", async (ctx: any) => {
-    try {
-      const endpoint: any = kook.endpoints.get(ctx.params.name);
-      if (!endpoint) { ctx.status = 404; ctx.body = { success: false, error: "Endpoint 不存在" }; return; }
-      if (!endpoint.$connected) { ctx.status = 400; ctx.body = { success: false, error: "Endpoint 未连接" }; return; }
-      const success = await endpoint.deleteRole(ctx.params.guildId, ctx.params.roleId);
-      ctx.body = { success, message: success ? "角色已删除" : "删除失败" };
-    } catch (e: unknown) {
-      ctx.status = 500;
-      ctx.body = { success: false, error: e instanceof Error ? e.message : "删除角色失败" };
-    }
-  });
-});
+export {
+  formatInboundContent,
+  formatInboundTarget,
+  formatOutboundKmarkdown,
+  parseSendTarget,
+  resolveKookConfig,
+  senderDisplayName,
+  KookPermission,
+  type KookAdapterConfig,
+  type KookInboundMessage,
+  type KookWireSegment,
+  type LogLevel,
+  type ParsedSendTarget,
+  type ResolvedKookConfig,
+  type ResolvedKookWebhookConfig,
+  type ResolvedKookWebsocketConfig,
+} from './protocol.js';
+
+export {
+  KookWebhookEndpoint,
+  KookWebsocketEndpoint,
+  type KookEndpointOptions,
+  type KookWebhookEndpointOptions,
+} from './endpoint.js';
+
+export {
+  registerKookWebhookRoutes,
+  handleKookWebhookRequest,
+  type KookWebhookHandler,
+} from './webhook.js';
+
+export {
+  defaultCreateClient,
+  defaultCreateWebhookClient,
+  normalizeKookMessage,
+  type CreateKookClient,
+  type KookClientTransport,
+} from './ws.js';
+
+export {
+  getKookAgentDeps,
+  registerKookAgentEndpoint,
+  setKookAgentDeps,
+  type KookAgentDeps,
+  type KookAgentEndpoint,
+} from './kook-agent-deps.js';
+
+export {
+  checkKookPlatformPermit,
+  kookGroupPermitResolver,
+  normalizeKookSenderForPermit,
+  platformPermit,
+  registerKookPlatformPermitChecker,
+  type KookSenderInfo,
+} from './platform-permit.js';

package/src/kook-agent-deps.ts

@@ -0,0 +1,55 @@
+/**
+ * Agent tool deps for kook.
+ * Endpoints register themselves on start; tools look up by config name / endpoint id.
+ */
+
+export interface KookAgentEndpoint {
+  getRoleList(guildId: string): Promise<Array<{
+    role_id: string | number;
+    name: string;
+    color?: number;
+    position?: number;
+    permissions?: unknown;
+  }>>;
+  createRole(guildId: string, name: string): Promise<{ role_id: string | number; name: string }>;
+  deleteRole(guildId: string, roleId: string): Promise<boolean>;
+  grantRole(guildId: string, userId: string, roleId: string): Promise<boolean>;
+  revokeRole(guildId: string, userId: string, roleId: string): Promise<boolean>;
+  addToBlacklist(guildId: string, userId: string, remark?: string): Promise<boolean>;
+  removeFromBlacklist(guildId: string, userId: string): Promise<boolean>;
+}
+
+export interface KookAgentDeps {
+  getEndpoint: (endpointId: string) => KookAgentEndpoint;
+}
+
+const endpoints = new Map<string, KookAgentEndpoint>();
+let override: KookAgentDeps | null = null;
+
+export function registerKookAgentEndpoint(
+  endpointId: string,
+  endpoint: KookAgentEndpoint,
+): () => void {
+  endpoints.set(endpointId, endpoint);
+  return () => {
+    if (endpoints.get(endpointId) === endpoint) {
+      endpoints.delete(endpointId);
+    }
+  };
+}
+
+/** Optional override used by tests / transitional callers. Pass `null` to clear. */
+export function setKookAgentDeps(deps: KookAgentDeps | null): void {
+  override = deps;
+}
+
+export function getKookAgentDeps(): KookAgentDeps {
+  if (override) return override;
+  return {
+    getEndpoint(endpointId: string): KookAgentEndpoint {
+      const registered = endpoints.get(endpointId);
+      if (!registered) throw new Error(`Endpoint ${endpointId} 不存在`);
+      return registered;
+    },
+  };
+}

package/src/platform-permit.ts

@@ -1,10 +1,8 @@
 /**
  * KOOK platform permit — guild / channel 差异化门禁
  */
-import type { Message } from 'zhin.js';
-import { registerPlatformPermitChecker } from 'zhin.js';
-import { KookPermission } from './types.js';
-import type { KookSenderInfo } from './types.js';
+import { registerPlatformPermitChecker, type Message } from '@zhin.js/core';
+import { KookPermission } from './protocol.js';
 
 const ADAPTER = 'kook';
 
@@ -21,6 +19,17 @@ export function kookGroupPermitResolver(logicalPerm: string): string {
   return platformPermit(FACTORY_PERM_MAP[logicalPerm] ?? logicalPerm);
 }
 
+export interface KookSenderInfo {
+  id: string;
+  name: string;
+  permission?: KookPermission;
+  roles?: number[];
+  isGuildOwner?: boolean;
+  isAdmin?: boolean;
+  role?: string;
+  permissions?: string[];
+}
+
 export function normalizeKookSenderForPermit(
   info: KookSenderInfo,
   isChannel: boolean,