@zhin.js/adapter-milky 1.0.0 → 1.1.0

package/src/bot-wss.ts

@@ -1,268 +0,0 @@
-/**
- * Milky 反向 WebSocket Bot：应用开 WS 服务端，协议端来连；鉴权后收事件同正向
- */
-import { IncomingMessage } from 'http';
-import WebSocket, { WebSocketServer } from 'ws';
-import { EventEmitter } from 'events';
-import { clearInterval } from 'node:timers';
-import { formatCompact, Bot, Message, segment, SendOptions } from 'zhin.js';
-import type { Router } from '@zhin.js/host-router';
-import { callApi } from './api.js';
-import type { MilkyWssConfig, MilkyEvent } from './types.js';
-import type { MilkyAdapter } from './adapter.js';
-import {
-  formatMilkyMessagePayload,
-  parseMessageReceiveData,
-  toMilkyOutgoingSegments,
-  parseMilkyMessageId,
-} from './utils.js';
-
-function getAccessTokenFromWsRequest(req: IncomingMessage): string | undefined {
-  const auth = req.headers['authorization'];
-  if (typeof auth === 'string' && auth.startsWith('Bearer ')) return auth.slice(7);
-  const url = req.url ?? '';
-  const idx = url.indexOf('?');
-  if (idx >= 0) {
-    const params = new URLSearchParams(url.slice(idx));
-    return params.get('access_token') ?? undefined;
-  }
-  return undefined;
-}
-
-export class MilkyWssServer extends EventEmitter implements Bot<MilkyWssConfig, MilkyEvent> {
-  $connected: boolean;
-  #wss?: WebSocketServer;
-  #client?: WebSocket;
-  private heartbeatTimer?: NodeJS.Timeout;
-
-  get logger() {
-    return this.adapter.plugin.logger;
-  }
-
-  constructor(
-    public adapter: MilkyAdapter,
-    public router: Router,
-    public $config: MilkyWssConfig,
-  ) {
-    super();
-    this.$connected = false;
-  }
-
-  get $id() {
-    return this.$config.name;
-  }
-
-  private apiOptions() {
-    return { baseUrl: this.$config.baseUrl, access_token: this.$config.access_token };
-  }
-
-  async $connect(): Promise<void> {
-    const path = this.$config.path.startsWith('/') ? this.$config.path : `/${this.$config.path}`;
-    const token = this.$config.access_token;
-    if (!token) this.logger.warn(formatCompact({ bot: this.$id, ok: false, error: 'missing access_token' }));
-
-    this.#wss = this.router.ws(path, {
-      verifyClient: (info: { req: IncomingMessage }) => {
-        const received = getAccessTokenFromWsRequest(info.req);
-        if (token && received !== token) {
-          this.logger.error('反向 WS 鉴权失败');
-          return false;
-        }
-        return true;
-      },
-    });
-
-    this.$connected = true;
-    this.logger.info(formatCompact( { op: 'listen', bot: this.$id, mode: 'wss', path }));
-
-    this.#wss.on('connection', (client, req) => {
-      this.#client = client;
-      this.startHeartbeat();
-      this.logger.info(formatCompact({ bot: this.$id, peer: req.socket?.remoteAddress }));
-
-      client.on('message', (data) => {
-        try {
-          const event = JSON.parse(data.toString()) as MilkyEvent;
-          this.handleEvent(event);
-        } catch (err) {
-          this.emit('error', err);
-        }
-      });
-
-      client.on('close', () => {
-        this.#client = undefined;
-        this.logger.warn(formatCompact( { op: 'disconnect', bot: this.$id }));
-      });
-
-      client.on('error', (err) => this.logger.error('反向 WS 连接错误', err));
-    });
-  }
-
-  async $disconnect(): Promise<void> {
-    if (this.heartbeatTimer) {
-      clearInterval(this.heartbeatTimer);
-      this.heartbeatTimer = undefined;
-    }
-    this.#wss?.close();
-    this.#wss = undefined;
-    this.#client = undefined;
-    this.$connected = false;
-  }
-
-  $formatMessage(event: MilkyEvent): Message<MilkyEvent> {
-    const data = parseMessageReceiveData(event);
-    if (!data) {
-      return Message.from(event, {
-        $id: '',
-        $adapter: 'milky',
-        $bot: this.$config.name,
-        $channel: { id: '', type: 'private' },
-        $sender: { id: '', name: '' },
-        $content: [],
-        $raw: '',
-        $timestamp: event.time ?? 0,
-        $recall: async () => {},
-        $reply: async () => '',
-      });
-    }
-    const payload = formatMilkyMessagePayload(
-      event,
-      data,
-      (id) => this.$recallMessage(id),
-      (channel, content) =>
-        this.adapter.sendMessage({
-          ...channel,
-          context: 'milky',
-          bot: this.$config.name,
-          content: content as import('zhin.js').SendContent,
-        }),
-      'milky',
-      this.$config.name,
-    );
-    return Message.from(event, payload);
-  }
-
-  private handleEvent(event: MilkyEvent): void {
-    const data = parseMessageReceiveData(event);
-    if (data) {
-      const message = this.$formatMessage(event);
-      this.adapter.emit('message.receive', message);
-      this.logger.debug(
-        `${this.$config.name} recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`,
-      );
-    }
-  }
-
-  async $sendMessage(options: SendOptions): Promise<string> {
-    const content = Array.isArray(options.content) ? options.content : [options.content];
-    const segments = content.map((c) =>
-      typeof c === 'string' ? { type: 'text' as const, data: { text: c } } : (c as { type: string; data?: Record<string, unknown> }),
-    );
-    const message = toMilkyOutgoingSegments(segments);
-    if (options.type === 'group') {
-      const result = await callApi(this.apiOptions(), 'send_group_message', {
-        group_id: parseInt(options.id, 10),
-        message,
-      });
-      const seq = (result as { message_seq?: number }).message_seq;
-      this.logger.debug(`${this.$config.name} send group(${options.id}):${segment.raw(options.content)}`);
-      return seq != null ? `group:${options.id}:${seq}` : '';
-    }
-    if (options.type === 'private') {
-      const result = await callApi(this.apiOptions(), 'send_private_message', {
-        user_id: parseInt(options.id, 10),
-        message,
-      });
-      const seq = (result as { message_seq?: number }).message_seq;
-      this.logger.debug(`${this.$config.name} send private(${options.id}):${segment.raw(options.content)}`);
-      return seq != null ? `friend:${options.id}:${seq}` : '';
-    }
-    throw new Error('Either group or private must be provided');
-  }
-
-  async $recallMessage(id: string): Promise<void> {
-    const parsed = parseMilkyMessageId(id);
-    if (!parsed) throw new Error(`Invalid message id: ${id}`);
-    if (parsed.message_scene === 'group') {
-      await callApi(this.apiOptions(), 'recall_group_message', {
-        group_id: parsed.peer_id,
-        message_seq: parsed.message_seq,
-      });
-    } else {
-      await callApi(this.apiOptions(), 'recall_private_message', {
-        user_id: parsed.peer_id,
-        message_seq: parsed.message_seq,
-      });
-    }
-  }
-
-  async kickMember(groupId: number, userId: number, rejectAddRequest = false): Promise<boolean> {
-    await callApi(this.apiOptions(), 'kick_group_member', {
-      group_id: groupId,
-      user_id: userId,
-      reject_add_request: rejectAddRequest,
-    });
-    return true;
-  }
-
-  async muteMember(groupId: number, userId: number, duration = 600): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_member_mute', {
-      group_id: groupId,
-      user_id: userId,
-      duration,
-    });
-    return true;
-  }
-
-  async muteAll(groupId: number, enable = true): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_whole_mute', { group_id: groupId, is_mute: enable });
-    return true;
-  }
-
-  async setAdmin(groupId: number, userId: number, enable = true): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_member_admin', {
-      group_id: groupId,
-      user_id: userId,
-      is_set: enable,
-    });
-    return true;
-  }
-
-  async setCard(groupId: number, userId: number, card: string): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_member_card', {
-      group_id: groupId,
-      user_id: userId,
-      card,
-    });
-    return true;
-  }
-
-  async setTitle(groupId: number, userId: number, title: string): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_member_special_title', {
-      group_id: groupId,
-      user_id: userId,
-      special_title: title,
-    });
-    return true;
-  }
-
-  async setGroupName(groupId: number, name: string): Promise<boolean> {
-    await callApi(this.apiOptions(), 'set_group_name', { group_id: groupId, new_group_name: name });
-    return true;
-  }
-
-  async getMemberList(groupId: number): Promise<unknown[]> {
-    return callApi(this.apiOptions(), 'get_group_member_list', { group_id: groupId }) as Promise<unknown[]>;
-  }
-
-  async getGroupInfo(groupId: number): Promise<unknown> {
-    return callApi(this.apiOptions(), 'get_group_info', { group_id: groupId });
-  }
-
-  private startHeartbeat(): void {
-    const interval = this.$config.heartbeat_interval ?? 30000;
-    this.heartbeatTimer = setInterval(() => {
-      if (this.#client?.readyState === WebSocket.OPEN) this.#client.ping();
-    }, interval);
-  }
-}

package/src/types.ts

@@ -1,73 +0,0 @@
-/**
- * Milky 适配器类型与配置（与官方文档一致）
- */
-
-/** 配置公共字段；单一适配器下 context 均为 'milky'，连接方式由 connection 区分 */
-export interface MilkyConfigBase {
-  context: 'milky';
-  name: string;
-  baseUrl: string;
-  access_token?: string;
-}
-
-/** WebSocket 正向连接 */
-export interface MilkyWsConfig extends MilkyConfigBase {
-  connection: 'ws';
-  reconnect_interval?: number;
-  heartbeat_interval?: number;
-}
-
-/** SSE 连接 */
-export interface MilkySseConfig extends MilkyConfigBase {
-  connection: 'sse';
-}
-
-/** Webhook（协议端 POST 到应用） */
-export interface MilkyWebhookConfig extends MilkyConfigBase {
-  connection: 'webhook';
-  path: string;
-}
-
-/** WebSocket 反向（协议端连应用） */
-export interface MilkyWssConfig extends MilkyConfigBase {
-  connection: 'wss';
-  path: string;
-  heartbeat_interval?: number;
-}
-
-export type MilkyBotConfig = MilkyWsConfig | MilkySseConfig | MilkyWebhookConfig | MilkyWssConfig;
-
-/** 协议端 API 响应：status、retcode、data?、message? */
-export interface MilkyApiResponse<T = unknown> {
-  status: string;
-  retcode: number;
-  data?: T;
-  message?: string;
-}
-
-/** 事件结构：event_type、time、self_id、data */
-export interface MilkyEvent {
-  event_type: string;
-  time: number;
-  self_id: number;
-  data?: Record<string, unknown>;
-}
-
-/** 接收消息 data（message_receive）：message_scene、peer_id、message_seq、sender_id、time、segments、可选 friend/group/group_member */
-export interface MilkyIncomingMessage {
-  message_scene: 'friend' | 'group' | 'temp';
-  peer_id: number;
-  message_seq: number;
-  sender_id: number;
-  time: number;
-  segments: MilkyIncomingSegment[];
-  friend?: { user_id: number; nickname?: string };
-  group?: { group_id: number; group_name?: string };
-  group_member?: { user_id: number; nickname?: string; card?: string; role?: string };
-}
-
-/** 接收消息段：type、data */
-export interface MilkyIncomingSegment {
-  type: string;
-  data?: Record<string, unknown>;
-}

package/src/utils.ts

@@ -1,174 +0,0 @@
-/**
- * Milky 事件/消息段与 zhin Message 的转换
- */
-import type { MessageBase, SendContent } from 'zhin.js';
-import { Message } from 'zhin.js';
-import type { MilkyEvent, MilkyIncomingMessage, MilkyIncomingSegment } from './types.js';
-
-/** 将 Milky 接收消息段转为 zhin 的 $content（MessageSegment[]） */
-export function formatMilkySegments(segments: MilkyIncomingSegment[]): Array<{ type: string; data: Record<string, unknown> }> {
-  return segments.map((seg) => {
-    const type = seg.type;
-    const data = seg.data ?? {};
-    switch (type) {
-      case 'text':
-        return { type: 'text', data: { text: (data as { text?: string }).text ?? '' } };
-      case 'mention':
-        return { type: 'at', data: { id: String((data as { user_id?: number }).user_id ?? '') } };
-      case 'mention_all':
-        return { type: 'at', data: { type: 'all' } };
-      case 'face':
-        return { type: 'face', data: { id: (data as { face_id?: string }).face_id ?? '' } };
-      case 'reply':
-        return {
-          type: 'reply',
-          data: { message_seq: (data as { message_seq?: number }).message_seq },
-        };
-      case 'image':
-        return {
-          type: 'image',
-          data: {
-            url: (data as { temp_url?: string }).temp_url ?? (data as { resource_id?: string }).resource_id ?? '',
-          },
-        };
-      case 'record':
-        return {
-          type: 'record',
-          data: {
-            url: (data as { temp_url?: string }).temp_url ?? (data as { resource_id?: string }).resource_id ?? '',
-          },
-        };
-      case 'video':
-        return {
-          type: 'video',
-          data: {
-            url: (data as { temp_url?: string }).temp_url ?? (data as { resource_id?: string }).resource_id ?? '',
-          },
-        };
-      case 'file':
-        return {
-          type: 'file',
-          data: {
-            file_id: (data as { file_id?: string }).file_id,
-            name: (data as { file_name?: string }).file_name,
-          },
-        };
-      default:
-        return { type, data: data as Record<string, unknown> };
-    }
-  });
-}
-
-/** message_receive 事件的 data 转为 zhin Message 的构造参数（含 $adapter、$bot） */
-export function formatMilkyMessagePayload(
-  event: MilkyEvent,
-  data: MilkyIncomingMessage,
-  recallFn: (msgId: string) => Promise<void>,
-  replyFn: (channel: { id: string; type: 'group' | 'private' }, content: (string | { type: string; data?: Record<string, unknown> })[], quote?: boolean | string) => Promise<string>,
-  adapterName: 'milky',
-  botName: string,
-): MessageBase {
-  const scene = data.message_scene;
-  const isGroup = scene === 'group';
-  const channelId = data.peer_id.toString();
-  const msgId = `${data.message_scene}:${data.peer_id}:${data.message_seq}`;
-  const channel = { id: channelId, type: (isGroup ? 'group' : 'private') as 'group' | 'private' };
-  const senderId = data.sender_id.toString();
-  const senderName =
-    (isGroup ? data.group_member?.card ?? data.group_member?.nickname : data.friend?.nickname) ?? senderId;
-  const content = formatMilkySegments(data.segments);
-  const raw = content.map((c) => (c.type === 'text' ? (c.data as { text?: string }).text : '')).join('');
-
-  return {
-    $id: msgId,
-    $adapter: 'milky',
-    $bot: botName,
-    $channel: channel,
-    $sender: { id: senderId, name: senderName },
-    $content: content,
-    $raw: raw,
-    $timestamp: data.time,
-    $recall: () => recallFn(msgId),
-    $reply: (cnt: SendContent, quote?: boolean | string) =>
-      replyFn(channel, (Array.isArray(cnt) ? cnt : [cnt]) as (string | { type: string; data?: Record<string, unknown> })[], quote),
-  };
-}
-
-/** 根据 event_type 判断是否为 message_receive，并解析 data 为 MilkyIncomingMessage */
-export function parseMessageReceiveData(event: MilkyEvent): MilkyIncomingMessage | null {
-  if (event.event_type !== 'message_receive' || !event.data) return null;
-  const data = event.data as unknown as MilkyIncomingMessage;
-  if (!data.message_scene || !Number.isInteger(data.peer_id) || !Array.isArray(data.segments)) return null;
-  return data;
-}
-
-/** zhin SendContent（string | MessageElement 或数组）转为 Milky OutgoingSegment[]（发送用） */
-export function toMilkyOutgoingSegments(
-  content: (string | { type: string; data?: Record<string, unknown> })[],
-): Array<{ type: string; data: Record<string, unknown> }> {
-  const out: Array<{ type: string; data: Record<string, unknown> }> = [];
-  for (const seg of content) {
-    const type = typeof seg === 'string' ? 'text' : seg.type;
-    const data = typeof seg === 'string' ? { text: seg } : (seg.data ?? {});
-    switch (type) {
-      case 'text':
-        out.push({ type: 'text', data: { text: String((data as { text?: string }).text ?? '') } });
-        break;
-      case 'at':
-        if ((data as { type?: string }).type === 'all') {
-          out.push({ type: 'mention_all', data: {} });
-        } else {
-          const id = (data as { id?: string }).id;
-          if (id) out.push({ type: 'mention', data: { user_id: Number(id) || 0 } });
-        }
-        break;
-      case 'face':
-        out.push({ type: 'face', data: { face_id: String((data as { id?: string }).id ?? ''), is_large: false } });
-        break;
-      case 'reply':
-        // message_id 可能为 scene:peer:seq 或仅 message_seq
-        const mid = (data as { message_id?: string; message_seq?: number }).message_id ?? (data as { message_seq?: number }).message_seq;
-        const seq = typeof mid === 'number' ? mid : parseInt(String(mid).split(':').pop() ?? '0', 10);
-        out.push({ type: 'reply', data: { message_seq: seq } });
-        break;
-      case 'image':
-        out.push({
-          type: 'image',
-          data: { uri: String((data as { url?: string }).url ?? (data as { uri?: string }).uri ?? '') },
-        });
-        break;
-      case 'record':
-        out.push({
-          type: 'record',
-          data: { uri: String((data as { url?: string }).url ?? (data as { uri?: string }).uri ?? '') },
-        });
-        break;
-      case 'video':
-        out.push({
-          type: 'video',
-          data: {
-            uri: String((data as { url?: string }).url ?? (data as { uri?: string }).uri ?? ''),
-            thumb_uri: (data as { thumb_uri?: string }).thumb_uri,
-          },
-        });
-        break;
-      default:
-        out.push({ type, data: data as Record<string, unknown> });
-    }
-  }
-  return out;
-}
-
-/** 解析 $id 为 message_scene、peer_id、message_seq（用于撤回） */
-export function parseMilkyMessageId(
-  msgId: string,
-): { message_scene: 'friend' | 'group' | 'temp'; peer_id: number; message_seq: number } | null {
-  const parts = msgId.split(':');
-  if (parts.length < 3) return null;
-  const [scene, peer, seq] = parts;
-  if (scene !== 'friend' && scene !== 'group' && scene !== 'temp') return null;
-  const peerId = parseInt(peer, 10);
-  const messageSeq = parseInt(seq, 10);
-  if (Number.isNaN(peerId) || Number.isNaN(messageSeq)) return null;
-  return { message_scene: scene, peer_id: peerId, message_seq: messageSeq };
-}