@zhin.js/adapter-kook 5.0.1 → 5.0.3

package/src/kook-side-events.ts

@@ -1,250 +0,0 @@
-/**
- * KOOK Gateway 非聊天入站：系统消息 (type=255) / BROADCAST → Notice
- * @see https://developer.kookapp.cn/doc/event/event-introduction
- */
-import { Notice, formatCompact, Message, type NoticeType } from "zhin.js";
-
-/** KOOK WebSocket s=0 时 d 字段（kook-client Receiver 入参） */
-export interface KookGatewayEvent {
-  channel_type?: string;
-  type?: number;
-  target_id?: string;
-  author_id?: string;
-  content?: string;
-  msg_id?: string;
-  msg_timestamp?: number;
-  nonce?: string;
-  extra?: KookGatewayExtra;
-  [key: string]: unknown;
-}
-
-export interface KookGatewayExtra {
-  type?: string;
-  body?: Record<string, unknown>;
-  guild_id?: string;
-  channel_id?: string;
-  channel_name?: string;
-  author?: { id?: string; username?: string; nickname?: string };
-  [key: string]: unknown;
-}
-
-const SYSTEM_MESSAGE_TYPE = 255;
-
-/** 是否应由适配器作为 notice 处理（kook-client 对 notice 的 transform 为空实现） */
-export function isKookNoticeGatewayEvent(data: unknown): data is KookGatewayEvent {
-  if (!data || typeof data !== "object") return false;
-  const ev = data as KookGatewayEvent;
-  if (ev.type === SYSTEM_MESSAGE_TYPE) return true;
-  return ev.channel_type === "BROADCAST";
-}
-
-export function resolveKookSideEventDedupeKey(
-  event: KookGatewayEvent,
-  kind: "notice" | "gateway",
-): string {
-  if (event.msg_id) return `${kind}:${event.msg_id}`;
-  const extra = event.extra ?? {};
-  const noticeType = extra.type ?? String(event.type ?? "");
-  const scope = event.target_id ?? "";
-  const ts = event.msg_timestamp ?? 0;
-  return `${kind}:${ts}_${noticeType}_${scope}`;
-}
-
-const NOTICE_TYPE_MAP: Record<string, NoticeType> = {
-  joined_guild: "group_member_increase",
-  exited_guild: "group_member_decrease",
-  deleted_message: "group_recall",
-  deleted_private_message: "friend_recall",
-  added_reaction: "group_emoji_reaction",
-  deleted_reaction: "group_emoji_reaction",
-  private_added_reaction: "group_emoji_reaction",
-  private_deleted_reaction: "group_emoji_reaction",
-};
-
-function resolveNoticeZhinType(rawType: string): NoticeType {
-  return NOTICE_TYPE_MAP[rawType] ?? rawType;
-}
-
-function senderFromId(id: unknown, name?: string) {
-  if (id == null || id === "") return undefined;
-  const s = String(id);
-  return { id: s, name: name ?? s };
-}
-
-function readString(obj: Record<string, unknown> | undefined, key: string): string | undefined {
-  const v = obj?.[key];
-  if (v == null || v === "") return undefined;
-  return String(v);
-}
-
-/** 解析 notice 发生的频道 / 群 / 私聊 */
-export function resolveKookNoticeChannel(
-  event: KookGatewayEvent,
-): { id: string; type: "group" | "private" | "channel" } {
-  const extra = event.extra ?? {};
-  const body = extra.body ?? {};
-  const rawType = String(extra.type ?? "");
-
-  if (event.channel_type === "BROADCAST") {
-    const guildId =
-      readString(body, "guild_id")
-      ?? extra.guild_id
-      ?? event.target_id
-      ?? "";
-    return { id: guildId, type: "group" };
-  }
-
-  if (event.type === SYSTEM_MESSAGE_TYPE && event.channel_type === "GROUP") {
-    const guildId =
-      readString(body, "guild_id")
-      ?? extra.guild_id
-      ?? event.target_id
-      ?? "";
-    if (
-      rawType === "joined_guild"
-      || rawType === "exited_guild"
-      || rawType === "updated_guild"
-      || rawType === "deleted_guild"
-      || rawType.startsWith("added_role")
-      || rawType.startsWith("deleted_role")
-      || rawType.startsWith("updated_role")
-      || rawType.startsWith("added_block")
-      || rawType.startsWith("deleted_block")
-      || rawType === "self_joined_guild"
-      || rawType === "self_exited_guild"
-    ) {
-      return { id: guildId, type: "group" };
-    }
-    const channelId =
-      readString(body, "channel_id")
-      ?? extra.channel_id
-      ?? event.target_id
-      ?? "";
-    return { id: channelId, type: "channel" };
-  }
-
-  if (
-    rawType.startsWith("private_")
-    || rawType.includes("private_message")
-    || event.channel_type === "PERSON"
-  ) {
-    const userId =
-      readString(body, "user_id")
-      ?? readString(body, "target_id")
-      ?? event.target_id
-      ?? event.author_id
-      ?? "";
-    return { id: userId, type: "private" };
-  }
-
-  const channelId =
-    readString(body, "channel_id")
-    ?? extra.channel_id
-    ?? event.target_id
-    ?? "";
-  return { id: channelId, type: "channel" };
-}
-
-export function enrichKookGatewayForPlugins(event: KookGatewayEvent): KookGatewayEvent {
-  const extra = event.extra ?? {};
-  const noticeType = extra.type;
-  if (!isKookNoticeGatewayEvent(event)) {
-    return { ...(event as object), post_type: "message" } as KookGatewayEvent;
-  }
-  return {
-    ...(event as object),
-    post_type: "notice",
-    notice_type: noticeType ?? "system",
-  } as KookGatewayEvent;
-}
-
-export function formatKookNotice(
-  event: KookGatewayEvent,
-  endpointName: string,
-): ReturnType<typeof Notice.from<KookGatewayEvent>> {
-  const extra = event.extra ?? {};
-  const body = extra.body ?? {};
-  const rawType = String(extra.type ?? "unknown");
-  const $type = resolveNoticeZhinType(rawType);
-  const channel = resolveKookNoticeChannel(event);
-  const ts = event.msg_timestamp ?? Date.now();
-
-  const targetId =
-    readString(body, "user_id")
-    ?? readString(body, "msg_id")
-    ?? readString(body, "target_id");
-  const operatorId =
-    readString(body, "operator_id")
-    ?? (event.author_id !== "1" ? event.author_id : undefined);
-
-  const mapped = NOTICE_TYPE_MAP[rawType] != null;
-
-  return Notice.from(event, {
-    $id: resolveKookSideEventDedupeKey(event, "notice"),
-    $adapter: "kook",
-    $endpoint: endpointName,
-    $type,
-    $subType: mapped ? rawType : undefined,
-    $channel: channel,
-    $operator: senderFromId(operatorId),
-    $target: senderFromId(targetId),
-    $timestamp: ts,
-  });
-}
-
-export function formatKookNoticeLog(notice: ReturnType<typeof formatKookNotice>): string {
-  return formatCompact({
-    notice: notice.$type,
-    kook_type: notice.$subType,
-    channel: `${notice.$channel.type}(${notice.$channel.id})`,
-    endpoint: notice.$endpoint,
-  });
-}
-
-/** KOOK 卡片按钮点击（type=255, extra.type=message_btn_click） */
-export function isKookButtonClickEvent(event: KookGatewayEvent): boolean {
-  return event.type === SYSTEM_MESSAGE_TYPE && event.extra?.type === 'message_btn_click';
-}
-
-export function formatKookButtonClickMessage(
-  event: KookGatewayEvent,
-  endpointName: string,
-): ReturnType<typeof Message.from<KookGatewayEvent>> {
-  const extra = event.extra ?? {};
-  const body = extra.body ?? {};
-  const payload = String(body.value ?? '');
-  const userInfo = body.user_info as { id?: string; username?: string; nickname?: string } | undefined;
-  const userId = String(body.user_id ?? userInfo?.id ?? event.author_id ?? '');
-  const userName = userInfo?.nickname ?? userInfo?.username ?? userId;
-  const sourceMessageId = String(body.msg_id ?? '');
-
-  let channelType: 'private' | 'channel' = 'private';
-  let channelId = String(body.target_id ?? event.target_id ?? userId);
-  if (body.channel_type === 'GROUP' || event.channel_type === 'GROUP') {
-    channelType = 'channel';
-    channelId = String(body.target_id ?? event.target_id ?? channelId);
-  } else if (body.channel_type === 'PERSON' || event.channel_type === 'PERSON') {
-    channelType = 'private';
-    channelId = String(body.target_id ?? event.target_id ?? userId);
-  }
-
-  return Message.from(event, {
-    $id: event.msg_id ?? `btn:${Date.now()}`,
-    $adapter: 'kook',
-    $endpoint: endpointName,
-    $sender: { id: userId, name: userName },
-    $channel: { id: channelId, type: channelType },
-    $content: [{
-      type: 'action',
-      data: {
-        id: payload,
-        payload,
-        sourceMessageId,
-      },
-    }],
-    $raw: payload,
-    $timestamp: event.msg_timestamp ?? Date.now(),
-    $recall: async () => {},
-    $reply: async () => '',
-  });
-}

package/src/outbound-keyboard.ts

@@ -1,78 +0,0 @@
-/**
- * core keyboard 段 → KOOK 卡片消息（action-group + button）
- */
-import type { KeyboardSegmentData, MessageElement } from "zhin.js";
-import { KeyboardSegment, isKeyboardSegment } from "zhin.js";
-
-function asKeyboardElement(
-  el: MessageElement,
-): (MessageElement & { data: KeyboardSegmentData }) | null {
-  if (el instanceof KeyboardSegment) {
-    return { type: "keyboard", data: el.data };
-  }
-  if (isKeyboardSegment(el)) return el;
-  return null;
-}
-
-function textFromElements(elements: MessageElement[]): string {
-  return elements
-    .filter((el) => el.type === "text" && typeof el.data.text === "string")
-    .map((el) => el.data.text as string)
-    .join("\n")
-    .trim();
-}
-
-/** core keyboard 布局 → KOOK card[]（可直接传给 sendChannelMsg / sendPrivateMsg） */
-export function coreKeyboardToKookCard(
-  data: KeyboardSegmentData,
-  prefixElements: MessageElement[] = [],
-): Array<Record<string, unknown>> {
-  const modules: Array<Record<string, unknown>> = [];
-  const prefixText = textFromElements(prefixElements);
-  if (prefixText) {
-    modules.push({
-      type: "section",
-      text: { type: "plain-text", content: prefixText },
-    });
-  }
-
-  for (const row of data.rows ?? []) {
-    modules.push({
-      type: "action-group",
-      elements: row.map((btn) => ({
-        type: "button",
-        theme: btn.disabled ? "secondary" : "primary",
-        value: btn.payload,
-        click: "return-val",
-        text: { type: "plain-text", content: btn.label },
-      })),
-    });
-  }
-
-  return [{
-    type: "card",
-    theme: "secondary",
-    size: "sm",
-    modules,
-  }];
-}
-
-export function findKeyboardSegment(
-  elements: MessageElement[],
-): { keyboard: MessageElement & { data: KeyboardSegmentData }; rest: MessageElement[] } | null {
-  let keyboard: (MessageElement & { data: KeyboardSegmentData }) | undefined;
-  const rest: MessageElement[] = [];
-
-  for (const el of elements) {
-    const kb = asKeyboardElement(el);
-    if (kb) {
-      if (keyboard) return null;
-      keyboard = kb;
-      continue;
-    }
-    rest.push(el);
-  }
-
-  if (!keyboard) return null;
-  return { keyboard, rest };
-}

package/src/outbound-media.ts

@@ -1,67 +0,0 @@
-/**
- * KOOK 出站 media：base64 / 本地文件须先走 /v3/asset/create 上传，再嵌入 KMarkdown。
- */
-import type { MessageElement, MessageSegment, SendContent } from "zhin.js";
-import {
-  asMessageElements,
-  extractBase64Buffer,
-  isMediaSegmentType,
-  isRemoteUrl,
-  resolveLocalMediaPath,
-} from "zhin.js";
-
-export interface KookMediaUploader {
-  uploadMedia(data: string | Buffer): Promise<string>;
-}
-
-function isMessageSegment(seg: MessageElement): seg is MessageSegment {
-  return typeof seg.type === "string";
-}
-
-function withUploadedUrl(seg: MessageSegment, uploadedUrl: string): MessageSegment {
-  const data = { ...seg.data } as Record<string, unknown>;
-  data.url = uploadedUrl;
-  data.file = uploadedUrl;
-  delete data.base64;
-  return { type: seg.type, data } as MessageSegment;
-}
-
-async function resolveMediaSegment(
-  uploader: KookMediaUploader,
-  seg: MessageSegment,
-): Promise<MessageSegment> {
-  if (!isMediaSegmentType(seg.type)) return seg;
-
-  const data = seg.data as Record<string, unknown>;
-  const url = typeof data.url === "string" ? data.url : undefined;
-  const file = typeof data.file === "string" ? data.file : undefined;
-  if ((url && isRemoteUrl(url)) || (file && isRemoteUrl(file))) {
-    return seg;
-  }
-
-  const buffer = extractBase64Buffer(data);
-  if (buffer) {
-    const uploaded = await uploader.uploadMedia(buffer);
-    return withUploadedUrl(seg, uploaded);
-  }
-
-  const local = resolveLocalMediaPath(data);
-  if (local) {
-    const uploaded = await uploader.uploadMedia(local);
-    return withUploadedUrl(seg, uploaded);
-  }
-
-  return seg;
-}
-
-/** 将 base64 / 本地媒体上传为 KOOK 可访问 URL */
-export async function materializeOutboundMedia(
-  uploader: KookMediaUploader,
-  content: SendContent,
-): Promise<MessageElement[]> {
-  const segments = asMessageElements(content);
-  return Promise.all(segments.map(async (item) => {
-    if (!isMessageSegment(item)) return item;
-    return resolveMediaSegment(uploader, item);
-  }));
-}

package/src/outbound-sendable.ts

@@ -1,73 +0,0 @@
-/**
- * Zhin 消息段 → kook-client Sendable。
- * 图片/音视频须用 segment 发送对应 msg_type，不能写成 Markdown ![alt](url)。
- */
-import { segment, type MessageSegment as KookMessageSegment } from "kook-client";
-import type { MessageElement } from "zhin.js";
-import { coreKeyboardToKookCard, findKeyboardSegment } from "./outbound-keyboard.js";
-
-export type KookSendable = string | KookMessageSegment[] | Array<Record<string, unknown>>;
-
-function mediaUrl(data: Record<string, unknown>): string {
-  return String(data.url ?? data.file ?? "");
-}
-
-/**
- * 单张图片（可带 reply）→ kook image 消息段（type=2）
- */
-export function convertToKookSendable(
-  elements: MessageElement[],
-  formatText: (content: MessageElement[]) => string,
-): KookSendable {
-  const keyboardBundle = findKeyboardSegment(elements);
-  if (keyboardBundle) {
-    const { keyboard, rest } = keyboardBundle;
-    const nonReplyRest = rest.filter((el) => el.type !== "reply");
-    if (nonReplyRest.every((el) => el.type === "text" || el.type === "reply")) {
-      return coreKeyboardToKookCard(keyboard.data, nonReplyRest.filter((el) => el.type === "text"));
-    }
-  }
-
-  const replies: string[] = [];
-  const images: string[] = [];
-  const videos: string[] = [];
-  const audios: string[] = [];
-  const rest: MessageElement[] = [];
-
-  for (const el of elements) {
-    if (el.type === "reply" && el.data.id) {
-      replies.push(String(el.data.id));
-      continue;
-    }
-    if (el.type === "image") {
-      const url = mediaUrl(el.data as Record<string, unknown>);
-      if (url) images.push(url);
-      continue;
-    }
-    if (el.type === "video") {
-      const url = mediaUrl(el.data as Record<string, unknown>);
-      if (url) videos.push(url);
-      continue;
-    }
-    if (el.type === "audio") {
-      const url = mediaUrl(el.data as Record<string, unknown>);
-      if (url) audios.push(url);
-      continue;
-    }
-    rest.push(el);
-  }
-
-  const replySegs = replies.map((id) => segment.reply(id));
-
-  if (images.length === 1 && videos.length === 0 && audios.length === 0 && rest.length === 0) {
-    return [...replySegs, segment.image(images[0])];
-  }
-  if (videos.length === 1 && images.length === 0 && audios.length === 0 && rest.length === 0) {
-    return [...replySegs, segment.video(videos[0])];
-  }
-  if (audios.length === 1 && images.length === 0 && videos.length === 0 && rest.length === 0) {
-    return [...replySegs, segment.audio(audios[0])];
-  }
-
-  return formatText(elements);
-}

package/src/segment-mapper.ts

@@ -1 +0,0 @@
-export { toCanonicalSegments, fromCanonicalSegments } from 'zhin.js';

package/src/types.ts

@@ -1,59 +0,0 @@
-/**
- * KOOK 适配器类型与配置
- */
-import type { PrivateMessageEvent, ChannelMessageEvent } from "kook-client";
-import type { LogLevel } from "kook-client";
-
-export type { LogLevel };
-
-export enum KookPermission {
-  Normal = 1,
-  Admin = 2,
-  Owner = 4,
-  ChannelAdmin = 5,
-}
-
-export interface KookSenderInfo {
-  id: string;
-  name: string;
-  permission?: KookPermission;
-  roles?: number[];
-  isGuildOwner?: boolean;
-  isAdmin?: boolean;
-  /** 归一化平台身份（供 platform checker） */
-  role?: string;
-  permissions?: string[];
-}
-
-export interface KookTypingIndicatorConfig {
-  enabled?: boolean;
-  defaultEmoji?: string;
-  autoRemove?: boolean;
-  removeDelay?: number;
-  privateConfig?: {
-    type?: 'reaction' | 'message' | 'typing' | 'none';
-    emoji?: string;
-    message?: string;
-  };
-  /** 频道/群聊（KOOK channel 走 groupConfig 合并逻辑） */
-  groupConfig?: {
-    type?: 'reaction' | 'message' | 'typing' | 'none';
-    emoji?: string;
-    message?: string;
-  };
-}
-
-export interface KookEndpointConfig {
-  context: "kook";
-  name: string;
-  token: string;
-  data_dir?: string;
-  timeout?: number;
-  max_retry?: number;
-  ignore?: "bot" | "self";
-  logLevel?: LogLevel;
-  /** AI 处理中提示（reaction 推荐：不打断会话） */
-  typingIndicator?: KookTypingIndicatorConfig;
-}
-
-export type KookRawMessage = PrivateMessageEvent | ChannelMessageEvent;