@zhin.js/adapter-onebot12 3.0.2 → 4.0.0

package/src/endpoint-ws.ts

@@ -1,228 +0,0 @@
-/**
- * OneBot 12 正向 WebSocket Bot：应用连 OneBot 实现的 WS，收事件、发动作
- */
-import WebSocket from 'ws';
-import { EventEmitter } from 'events';
-import { clearInterval, clearTimeout } from 'node:timers';
-import { formatCompact, Endpoint, Message, segment, SendOptions, expandInteractiveSegmentsInContent,} from 'zhin.js';
-import type { OneBot12WsConfig, OneBot12Event, OneBot12ActionRequest, OneBot12ActionResponse } from './types.js';
-import type { OneBot12Adapter } from './adapter.js';
-import { formatOneBot12MessagePayload, isMessageEvent, contentToOb12Segments } from './utils.js';
-import { fromCanonicalSegments } from './segment-mapper.js';
-
-export class OneBot12WsClient extends EventEmitter implements Endpoint<OneBot12WsConfig, OneBot12Event> {
-  $connected: boolean;
-  private ws?: WebSocket;
-  private reconnectTimer?: NodeJS.Timeout;
-  private heartbeatTimer?: NodeJS.Timeout;
-  private requestId = 0;
-  private pendingRequests = new Map<string, { resolve: (value: unknown) => void; reject: (err: Error) => void; timeout: NodeJS.Timeout }>();
-
-  get logger() {
-    return this.adapter.plugin.logger;
-  }
-
-  constructor(public adapter: OneBot12Adapter, public $config: OneBot12WsConfig) {
-    super();
-    this.$connected = false;
-  }
-
-  get $id() {
-    return this.$config.name;
-  }
-
-  private startHeartbeat(): void {
-    const interval = this.$config.heartbeat_interval ?? 30000;
-    this.heartbeatTimer = setInterval(() => {
-      this.callAction('get_status', {}).catch(() => {});
-    }, interval);
-  }
-
-  private scheduleReconnect(): void {
-    if (this.reconnectTimer) return;
-    const delay = this.$config.reconnect_interval ?? 5000;
-    this.reconnectTimer = setTimeout(() => {
-      this.reconnectTimer = undefined;
-      this.$connect().catch((err) => this.logger.warn(formatCompact( {
-        op: 'reconnect',
-        endpoint: this.$id,
-        ok: false,
-        error: err instanceof Error ? err.message : String(err),
-      })));
-    }, delay);
-  }
-
-  private callAction(action: string, params: Record<string, unknown>): Promise<OneBot12ActionResponse['data']> {
-    if (!this.ws || this.ws.readyState !== WebSocket.OPEN) {
-      return Promise.reject(new Error('WebSocket 未连接'));
-    }
-    const echo = `ob12_${++this.requestId}`;
-    const req: OneBot12ActionRequest = { action, params, echo };
-    return new Promise((resolve, reject) => {
-      const timeout = setTimeout(() => {
-        this.pendingRequests.delete(echo);
-        reject(new Error(`OneBot12 动作超时: ${action}`));
-      }, 30000);
-      this.pendingRequests.set(echo, {
-        resolve: (data: unknown) => resolve(data as OneBot12ActionResponse['data']),
-        reject,
-        timeout,
-      });
-      this.ws!.send(JSON.stringify(req));
-    });
-  }
-
-  async $connect(): Promise<void> {
-    return new Promise((resolve, reject) => {
-      const headers: Record<string, string> = {};
-      let connectUrl = this.$config.url;
-      if (this.$config.access_token) {
-        headers['Authorization'] = `Bearer ${this.$config.access_token}`;
-        const url = new URL(this.$config.url);
-        url.searchParams.set('access_token', this.$config.access_token);
-        connectUrl = url.toString();
-      }
-      this.ws = new WebSocket(connectUrl, { headers });
-
-      this.ws.on('open', () => {
-        this.$connected = true;
-        const safeUrl = new URL(connectUrl);
-        safeUrl.searchParams.delete('access_token');
-        this.logger.debug(formatCompact({ endpoint: this.$id, mode: 'ws' }));
-        this.startHeartbeat();
-        resolve();
-      });
-
-      this.ws.on('message', (data) => {
-        try {
-          const msg = JSON.parse(data.toString()) as OneBot12Event | OneBot12ActionResponse;
-          if ('echo' in msg && typeof (msg as OneBot12ActionResponse).echo === 'string') {
-            const resp = msg as OneBot12ActionResponse;
-            const pending = this.pendingRequests.get(resp.echo!);
-            if (pending) {
-              this.pendingRequests.delete(resp.echo!);
-              clearTimeout(pending.timeout);
-              if (resp.status === 'ok') pending.resolve(resp.data);
-              else pending.reject(new Error(`OneBot12 retcode=${resp.retcode}: ${resp.message}`));
-            }
-            return;
-          }
-          const ev = msg as OneBot12Event;
-          if (ev.type === 'message' && isMessageEvent(ev)) {
-            const message = this.$formatMessage(ev);
-            this.adapter.emit('message.receive', message);
-            this.logger.debug(`${this.$config.name} recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`);
-          }
-        } catch (error) {
-          this.emit('error', error);
-        }
-      });
-
-      this.ws.on('close', (code, reason) => {
-        this.$connected = false;
-        const reasonStr = reason?.toString?.() || String(reason);
-        const codeHint = code === 1005 ? ' [无状态，多为服务端/代理未发 close 帧即断开]' : code === 1006 ? ' [异常关闭]' : '';
-        this.logger.warn(formatCompact( {
-          op: 'disconnect',
-          endpoint: this.$config.name,
-          code,
-          error: `${reasonStr || 'closed'}${codeHint}`,
-          reconnect_ms: this.$config.reconnect_interval ?? 5000,
-        }));
-        reject(new Error(`OneBot12 WS 关闭: ${code} ${reasonStr}`));
-        this.scheduleReconnect();
-      });
-
-      this.ws.on('error', (err) => {
-        this.logger.warn(formatCompact( {
-          op: 'ws_error',
-          endpoint: this.$config.name,
-          ok: false,
-          error: err instanceof Error ? err.message : String(err),
-        }));
-        reject(err);
-      });
-    });
-  }
-
-  async $disconnect(): Promise<void> {
-    if (this.reconnectTimer) {
-      clearTimeout(this.reconnectTimer);
-      this.reconnectTimer = undefined;
-    }
-    if (this.heartbeatTimer) {
-      clearInterval(this.heartbeatTimer);
-      this.heartbeatTimer = undefined;
-    }
-    for (const [, p] of this.pendingRequests) {
-      clearTimeout(p.timeout);
-      p.reject(new Error('连接已关闭'));
-    }
-    this.pendingRequests.clear();
-    if (this.ws) {
-      this.ws.close();
-      this.ws = undefined;
-    }
-    this.$connected = false;
-  }
-
-  $formatMessage(ev: OneBot12Event): Message<OneBot12Event> {
-    if (!isMessageEvent(ev)) {
-      return Message.from(ev, {
-        $id: '',
-        $adapter: 'onebot12',
-        $endpoint: this.$config.name,
-        $channel: { id: '', type: 'private' },
-        $sender: { id: '', name: '' },
-        $content: [],
-        $raw: '',
-        $timestamp: ev.time ?? 0,
-        $recall: async () => {},
-        $reply: async () => '',
-      });
-    }
-    const payload = formatOneBot12MessagePayload(
-      ev,
-      this.$config.name,
-      (id) => this.$recallMessage(id),
-      (channel, content, _quote) =>
-        this.adapter.sendMessage({
-          ...channel,
-          context: 'onebot12',
-          endpoint: this.$config.name,
-          content: content as import('zhin.js').SendContent,
-        }),
-    );
-    return Message.from(ev, payload);
-  }
-
-  async $sendMessage(options: SendOptions): Promise<string> {
-    const expanded = expandInteractiveSegmentsInContent(options.content);
-    const arr = Array.isArray(expanded) ? expanded : [expanded];
-    const wire = fromCanonicalSegments(
-      arr.map((c) => (typeof c === 'string' ? { type: 'text' as const, data: { text: c } } : c)),
-    );
-    const message = contentToOb12Segments(wire);
-    const params: Record<string, unknown> = { message };
-    if (options.type === 'private') {
-      params.detail_type = 'private';
-      params.user_id = options.id;
-    } else if (options.type === 'group') {
-      params.detail_type = 'group';
-      params.group_id = options.id;
-    } else {
-      const [guildId, channelId] = options.id.includes(':') ? options.id.split(':') : [undefined, options.id];
-      params.detail_type = 'channel';
-      params.channel_id = channelId ?? options.id;
-      if (guildId) params.guild_id = guildId;
-    }
-    const data = await this.callAction('send_message', params) as { message_id?: string } | undefined;
-    const msgId = data?.message_id ?? '';
-    this.logger.debug(`${this.$config.name} send ${options.type}(${options.id}):${segment.raw(options.content)}`);
-    return msgId;
-  }
-
-  async $recallMessage(id: string): Promise<void> {
-    await this.callAction('delete_message', { message_id: id });
-  }
-}

package/src/endpoint-wss.ts

@@ -1,208 +0,0 @@
-/**
- * OneBot 12 反向 WebSocket Bot：应用开 WS 服务端，OneBot 实现连上来
- */
-import WebSocket, { WebSocketServer } from 'ws';
-import { EventEmitter } from 'events';
-import { clearInterval, clearTimeout } from 'node:timers';
-import { IncomingMessage } from 'http';
-import { formatCompact, Endpoint, Message, segment, SendOptions, expandInteractiveSegmentsInContent,} from 'zhin.js';
-import type { Router } from '@zhin.js/host-router';
-import type { OneBot12WssConfig, OneBot12Event, OneBot12ActionRequest, OneBot12ActionResponse } from './types.js';
-import type { OneBot12Adapter } from './adapter.js';
-import { formatOneBot12MessagePayload, isMessageEvent, contentToOb12Segments } from './utils.js';
-import { fromCanonicalSegments } from './segment-mapper.js';
-
-export class OneBot12WssServer extends EventEmitter implements Endpoint<OneBot12WssConfig, OneBot12Event> {
-  $connected: boolean = false;
-  #wss?: WebSocketServer;
-  #client?: WebSocket;
-  private heartbeatTimer?: NodeJS.Timeout;
-  private requestId = 0;
-  private pendingRequests = new Map<string, { resolve: (value: unknown) => void; reject: (err: Error) => void; timeout: NodeJS.Timeout }>();
-
-  get logger() {
-    return this.adapter.plugin.logger;
-  }
-
-  constructor(
-    public adapter: OneBot12Adapter,
-    public router: Router,
-    public $config: OneBot12WssConfig,
-  ) {
-    super();
-  }
-
-  get $id() {
-    return this.$config.name;
-  }
-
-  private getClient(): WebSocket | undefined {
-    return this.#client && this.#client.readyState === WebSocket.OPEN ? this.#client : undefined;
-  }
-
-  private callAction(action: string, params: Record<string, unknown>): Promise<OneBot12ActionResponse['data']> {
-    const client = this.getClient();
-    if (!client) return Promise.reject(new Error('反向 WebSocket 未连接'));
-    const echo = `ob12wss_${++this.requestId}`;
-    const req: OneBot12ActionRequest = { action, params, echo };
-    return new Promise((resolve, reject) => {
-      const timeout = setTimeout(() => {
-        this.pendingRequests.delete(echo);
-        reject(new Error(`OneBot12 动作超时: ${action}`));
-      }, 30000);
-      this.pendingRequests.set(echo, {
-        resolve: (data: unknown) => resolve(data as OneBot12ActionResponse['data']),
-        reject,
-        timeout,
-      });
-      client.send(JSON.stringify(req));
-    });
-  }
-
-  async $connect(): Promise<void> {
-    const path = this.$config.path.startsWith('/') ? this.$config.path : `/${this.$config.path}`;
-    this.#wss = this.router.ws(path, {
-      verifyClient: (info: { req: IncomingMessage }) => {
-        const auth = info.req.headers['authorization'];
-        if (this.$config.access_token && auth !== `Bearer ${this.$config.access_token}`) {
-          this.logger.error('OneBot12 反向 WS 鉴权失败');
-          return false;
-        }
-        return true;
-      },
-    });
-
-    this.#wss.on('connection', (ws: WebSocket) => {
-      if (this.#client && this.#client.readyState === WebSocket.OPEN) {
-        this.#client.close();
-      }
-      this.#client = ws;
-      this.$connected = true;
-      this.logger.debug(formatCompact({ endpoint: this.$config.name, mode: 'wss' }));
-
-      ws.on('message', (data) => {
-        try {
-          const msg = JSON.parse(data.toString()) as OneBot12Event | OneBot12ActionResponse;
-          if ('echo' in msg && typeof (msg as OneBot12ActionResponse).echo === 'string') {
-            const resp = msg as OneBot12ActionResponse;
-            const pending = this.pendingRequests.get(resp.echo!);
-            if (pending) {
-              this.pendingRequests.delete(resp.echo!);
-              clearTimeout(pending.timeout);
-              if (resp.status === 'ok') pending.resolve(resp.data);
-              else pending.reject(new Error(`OneBot12 retcode=${resp.retcode}: ${resp.message}`));
-            }
-            return;
-          }
-          const ev = msg as OneBot12Event;
-          if (ev.type === 'message' && isMessageEvent(ev)) {
-            const message = this.$formatMessage(ev);
-            this.adapter.emit('message.receive', message);
-            this.logger.debug(`${this.$config.name} recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`);
-          }
-        } catch (error) {
-          this.emit('error', error);
-        }
-      });
-
-      ws.on('close', (code, reason) => {
-        this.$connected = false;
-        this.#client = undefined;
-        const reasonStr = reason?.toString?.() || String(reason ?? '');
-        const codeHint = code === 1005 ? ' [无状态]' : code === 1006 ? ' [异常关闭]' : '';
-        this.logger.warn(formatCompact( {
-          op: 'disconnect',
-          endpoint: this.$config.name,
-          code: code ?? '?',
-          error: `${reasonStr || 'closed'}${codeHint}`,
-        }));
-      });
-
-      ws.on('error', (err) => {
-        this.logger.warn(formatCompact( {
-          op: 'ws_error',
-          endpoint: this.$config.name,
-          ok: false,
-          error: err instanceof Error ? err.message : String(err),
-        }));
-      });
-    });
-  }
-
-  async $disconnect(): Promise<void> {
-    if (this.heartbeatTimer) {
-      clearInterval(this.heartbeatTimer);
-      this.heartbeatTimer = undefined;
-    }
-    for (const [, p] of this.pendingRequests) {
-      clearTimeout(p.timeout);
-      p.reject(new Error('连接已关闭'));
-    }
-    this.pendingRequests.clear();
-    if (this.#client) {
-      this.#client.close();
-      this.#client = undefined;
-    }
-    this.#wss?.close();
-    this.#wss = undefined;
-    this.$connected = false;
-  }
-
-  $formatMessage(ev: OneBot12Event): Message<OneBot12Event> {
-    if (!isMessageEvent(ev)) {
-      return Message.from(ev, {
-        $id: '',
-        $adapter: 'onebot12',
-        $endpoint: this.$config.name,
-        $channel: { id: '', type: 'private' },
-        $sender: { id: '', name: '' },
-        $content: [],
-        $raw: '',
-        $timestamp: ev.time ?? 0,
-        $recall: async () => {},
-        $reply: async () => '',
-      });
-    }
-    const payload = formatOneBot12MessagePayload(
-      ev,
-      this.$config.name,
-      (id) => this.$recallMessage(id),
-      (channel, content, _quote) =>
-        this.adapter.sendMessage({
-          ...channel,
-          context: 'onebot12',
-          endpoint: this.$config.name,
-          content: content as import('zhin.js').SendContent,
-        }),
-    );
-    return Message.from(ev, payload);
-  }
-
-  async $sendMessage(options: SendOptions): Promise<string> {
-    const expanded = expandInteractiveSegmentsInContent(options.content);
-    const arr = Array.isArray(expanded) ? expanded : [expanded];
-    const wire = fromCanonicalSegments(
-      arr.map((c) => (typeof c === 'string' ? { type: 'text' as const, data: { text: c } } : c)),
-    );
-    const message = contentToOb12Segments(wire);
-    const params: Record<string, unknown> = { message };
-    if (options.type === 'private') {
-      params.detail_type = 'private';
-      params.user_id = options.id;
-    } else if (options.type === 'group') {
-      params.detail_type = 'group';
-      params.group_id = options.id;
-    } else {
-      const [guildId, channelId] = options.id.includes(':') ? options.id.split(':') : [undefined, options.id];
-      params.detail_type = 'channel';
-      params.channel_id = channelId ?? options.id;
-      if (guildId) params.guild_id = guildId;
-    }
-    const data = await this.callAction('send_message', params) as { message_id?: string } | undefined;
-    return data?.message_id ?? '';
-  }
-
-  async $recallMessage(id: string): Promise<void> {
-    await this.callAction('delete_message', { message_id: id });
-  }
-}

package/src/segment-mapper.ts

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

package/src/types.ts

@@ -1,86 +0,0 @@
-/**
- * OneBot 12 适配器类型（参考 https://12.onebot.dev/ ）
- */
-
-/** 配置公共字段；单一适配器 context 均为 'onebot12'，连接方式由 connection 区分 */
-export interface OneBot12ConfigBase {
-  context: 'onebot12';
-  name: string;
-  /** 访问令牌，鉴权用 */
-  access_token?: string;
-}
-
-/** 正向 WebSocket：应用连 OneBot 实现的 WS 服务器 */
-export interface OneBot12WsConfig extends OneBot12ConfigBase {
-  connection: 'ws';
-  /** OneBot 实现提供的 WebSocket 地址，如 ws://127.0.0.1:6700 */
-  url: string;
-  reconnect_interval?: number;
-  heartbeat_interval?: number;
-}
-
-/** HTTP Webhook：OneBot 实现 POST 事件到应用提供的 path */
-export interface OneBot12WebhookConfig extends OneBot12ConfigBase {
-  connection: 'webhook';
-  /** 应用接收事件的 POST 路径 */
-  path: string;
-  /** 可选：OneBot 实现的 HTTP 端点，用于发消息等动作（实现 POST 事件到我们，我们 POST 动作到该 url） */
-  api_url?: string;
-}
-
-/** 反向 WebSocket：应用开 WS 服务端，OneBot 实现连上来 */
-export interface OneBot12WssConfig extends OneBot12ConfigBase {
-  connection: 'wss';
-  /** 应用侧 WS 路径 */
-  path: string;
-  heartbeat_interval?: number;
-}
-
-export type OneBot12EndpointConfig = OneBot12WsConfig | OneBot12WebhookConfig | OneBot12WssConfig;
-
-/** 机器人自身标识（事件与动作中的 self） */
-export interface OneBot12Self {
-  platform: string;
-  user_id: string;
-}
-
-/** 事件（实现推送给应用） */
-export interface OneBot12Event {
-  id: string;
-  time: number;
-  type: 'meta' | 'message' | 'notice' | 'request';
-  detail_type: string;
-  sub_type: string;
-  self?: OneBot12Self;
-  message_id?: string;
-  message?: OneBot12Segment[];
-  alt_message?: string;
-  user_id?: string;
-  group_id?: string;
-  channel_id?: string;
-  guild_id?: string;
-  [key: string]: unknown;
-}
-
-/** 消息段 */
-export interface OneBot12Segment {
-  type: string;
-  data?: Record<string, unknown>;
-}
-
-/** 动作请求（应用发给实现） */
-export interface OneBot12ActionRequest {
-  action: string;
-  params: Record<string, unknown>;
-  echo?: string;
-  self?: OneBot12Self;
-}
-
-/** 动作响应（实现返回给应用） */
-export interface OneBot12ActionResponse {
-  status: 'ok' | 'failed';
-  retcode: number;
-  data?: unknown;
-  message: string;
-  echo?: string;
-}

package/src/utils.ts

@@ -1,89 +0,0 @@
-/**
- * OneBot 12 事件与 zhin Message 的转换、消息段转换
- */
-import type { SendContent } from 'zhin.js';
-import type { OneBot12Event, OneBot12Segment } from './types.js';
-import { toCanonicalSegments } from './segment-mapper.js';
-
-/** 判断是否为消息事件（type=message） */
-export function isMessageEvent(ev: OneBot12Event): ev is OneBot12Event & { message_id: string; message?: OneBot12Segment[] } {
-  return ev.type === 'message' && !!ev.message_id;
-}
-
-/** 从事件得到 zhin 场景 id：私聊 user_id，群 group_id，频道 channel_id 或 guild_id:channel_id */
-export function getChannelId(ev: OneBot12Event): string {
-  if (ev.detail_type === 'private' && ev.user_id) return ev.user_id;
-  if (ev.detail_type === 'group' && ev.group_id) return ev.group_id;
-  if (ev.detail_type === 'channel' && ev.channel_id) {
-    return ev.guild_id ? `${ev.guild_id}:${ev.channel_id}` : ev.channel_id;
-  }
-  return '';
-}
-
-/** 从事件得到 channel 类型 */
-export function getChannelType(ev: OneBot12Event): 'private' | 'group' {
-  if (ev.detail_type === 'private') return 'private';
-  return 'group';
-}
-
-/** 将 OneBot 12 消息事件转为 zhin Message 的 MessageBase 所需字段 */
-export function formatOneBot12MessagePayload(
-  ev: OneBot12Event,
-  endpointName: string,
-  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>,
-): {
-  $id: string;
-  $adapter: 'onebot12';
-  $endpoint: string;
-  $channel: { id: string; type: 'group' | 'private' };
-  $sender: { id: string; name: string };
-  $content: Array<{ type: string; data: Record<string, unknown> }>;
-  $raw: string;
-  $timestamp: number;
-  $recall: () => Promise<void>;
-  $reply: (content: SendContent, quote?: boolean | string) => Promise<string>;
-} {
-  const channelId = getChannelId(ev);
-  const channelType = getChannelType(ev);
-  const raw = ev.alt_message ?? (Array.isArray(ev.message) ? ev.message.map((s) => (s.type === 'text' ? (s.data?.text as string) ?? '' : '')).join('') : '');
-  const wire = Array.isArray(ev.message)
-    ? ev.message.map((s) => ({ type: s.type, data: (s.data ?? {}) as Record<string, unknown> }))
-    : [{ type: 'text', data: { text: raw } }];
-  const content = toCanonicalSegments(wire);
-  const senderId = ev.user_id ?? '';
-  const senderName = (ev as Record<string, unknown>)['user.name'] as string | undefined ?? (ev as Record<string, unknown>)['qq.nickname'] as string | undefined ?? senderId;
-
-  return {
-    $id: ev.message_id!,
-    $adapter: 'onebot12',
-    $endpoint: endpointName,
-    $channel: { id: channelId, type: channelType },
-    $sender: { id: senderId, name: senderName },
-    $content: content,
-    $raw: raw,
-    $timestamp: ev.time ?? 0,
-    $recall: () => recallFn(ev.message_id!),
-    $reply: (cnt: SendContent, quote?: boolean | string) =>
-      replyFn(
-        { id: channelId, type: channelType },
-        (Array.isArray(cnt) ? cnt : [cnt]) as (string | { type: string; data?: Record<string, unknown> })[],
-        quote,
-      ),
-  };
-}
-
-/** 将 zhin 的 content（segment 数组或字符串）转为 OneBot 12 message 段数组；简单实现仅 text */
-export function contentToOb12Segments(content: SendContent): OneBot12Segment[] {
-  const arr = Array.isArray(content) ? content : [content];
-  const segs: OneBot12Segment[] = [];
-  for (const c of arr) {
-    if (typeof c === 'string') {
-      segs.push({ type: 'text', data: { text: c } });
-    } else if (c && typeof c === 'object' && 'type' in c) {
-      const el = c as { type: string; data?: Record<string, unknown> };
-      segs.push({ type: el.type, data: el.data ?? {} });
-    }
-  }
-  return segs.length ? segs : [{ type: 'text', data: { text: '' } }];
-}