@zhin.js/adapter-satori 1.0.1 → 1.1.2

package/src/api.ts

@@ -1,48 +0,0 @@
-/**
- * Satori HTTP API 封装：POST /v1/{resource}.{method}，头 Satori-Platform、Satori-User-ID、Authorization
- * 参考 https://satori.chat/en-US/protocol/api.html
- */
-export interface SatoriApiOptions {
-  baseUrl: string;
-  platform: string;
-  userId: string;
-  token?: string;
-}
-
-/**
- * 调用 Satori API：POST {baseUrl}/v1/{resource}.{method}，JSON body
- */
-export async function callSatoriApi<T = unknown>(
-  options: SatoriApiOptions,
-  resource: string,
-  method: string,
-  params: Record<string, unknown> = {},
-): Promise<T> {
-  const { baseUrl, platform, userId, token } = options;
-  const url = `${baseUrl.replace(/\/$/, '')}/v1/${resource}.${method}`;
-  const headers: Record<string, string> = {
-    'Content-Type': 'application/json',
-    'Satori-Platform': platform,
-    'Satori-User-ID': userId,
-  };
-  if (token) headers['Authorization'] = `Bearer ${token}`;
-
-  const res = await fetch(url, {
-    method: 'POST',
-    headers,
-    body: JSON.stringify(params),
-  });
-
-  const text = await res.text();
-  if (res.status === 401) throw new Error(`Satori API 认证失败: ${text}`);
-  if (res.status === 403) throw new Error(`Satori API 权限不足: ${text}`);
-  if (res.status === 404) throw new Error(`Satori API 不存在: ${resource}.${method}`);
-  if (res.status >= 400) throw new Error(`Satori API 错误 ${res.status}: ${text}`);
-
-  if (!text || text.trim() === '') return undefined as T;
-  try {
-    return JSON.parse(text) as T;
-  } catch {
-    throw new Error(`Satori API 无效 JSON: ${text.slice(0, 200)}`);
-  }
-}

package/src/endpoint-webhook.ts

@@ -1,117 +0,0 @@
-/**
- * Satori WebHook Bot：应用提供 POST path，SDK 推送 EVENT（Satori-Opcode: 0）
- */
-import { EventEmitter } from 'events';
-import { formatCompact, Endpoint, Message, segment, SendOptions } from 'zhin.js';
-import { registerFetchRoute, type Router, type RouterContext } from '@zhin.js/host-router/router';
-import { callSatoriApi } from './api.js';
-import type { SatoriWebhookConfig, SatoriEventBody, SatoriLogin } from './types.js';
-import { SatoriOpcode } from './types.js';
-import type { SatoriAdapter } from './adapter.js';
-import { formatSatoriMessagePayload, isMessageEvent } from './utils.js';
-
-export class SatoriWebhookEndpoint extends EventEmitter implements Endpoint<SatoriWebhookConfig, SatoriEventBody> {
-  $connected: boolean = true;
-  /** 从首个事件的 login 得到，用于 API 的 platform / userId */
-  private login?: SatoriLogin;
-
-  get logger() {
-    return this.adapter.plugin.logger;
-  }
-
-  constructor(
-    public adapter: SatoriAdapter,
-    public router: Router,
-    public $config: SatoriWebhookConfig,
-  ) {
-    super();
-  }
-
-  get $id() {
-    return this.$config.name;
-  }
-
-  private apiOptions(): { baseUrl: string; platform: string; userId: string; token?: string } {
-    const platform = this.login?.platform ?? '';
-    const userId = this.login?.user?.id ?? '';
-    return { baseUrl: this.$config.baseUrl, platform, userId, token: this.$config.token };
-  }
-
-  async $connect(): Promise<void> {
-    const path = this.$config.path.startsWith('/') ? this.$config.path : `/${this.$config.path}`;
-    registerFetchRoute(this.router, 'POST', path, async (ctx: RouterContext) => {
-      const opcode = parseInt(ctx.get('satori-opcode') ?? '', 10);
-      const body = ctx.request.body as SatoriEventBody | undefined;
-      if (opcode === SatoriOpcode.EVENT && body) {
-        if (body.login && !this.login) this.login = body.login;
-        this.handleEvent(body);
-      }
-      ctx.status = 200;
-      ctx.body = {};
-    });
-    this.logger.info(formatCompact( { op: 'webhook', path }));
-  }
-
-  async $disconnect(): Promise<void> {
-    this.$connected = false;
-  }
-
-  private handleEvent(body: SatoriEventBody): void {
-    if (isMessageEvent(body)) {
-      const message = this.$formatMessage(body);
-      this.adapter.emit('message.receive', message);
-      this.logger.debug(
-        `${this.$config.name} recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`,
-      );
-    }
-  }
-
-  $formatMessage(body: SatoriEventBody): Message<SatoriEventBody> {
-    if (!isMessageEvent(body)) {
-      return Message.from(body, {
-        $id: '',
-        $adapter: 'satori',
-        $endpoint: this.$config.name,
-        $channel: { id: '', type: 'private' },
-        $sender: { id: '', name: '' },
-        $content: [],
-        $raw: '',
-        $timestamp: body.timestamp ?? 0,
-        $recall: async () => {},
-        $reply: async () => '',
-      });
-    }
-    const payload = formatSatoriMessagePayload(
-      body,
-      'satori',
-      this.$config.name,
-      (id) => this.$recallMessage(id),
-      (channel, content, _quote) =>
-        this.adapter.sendMessage({
-          ...channel,
-          context: 'satori',
-          endpoint: this.$config.name,
-          content: content as import('zhin.js').SendContent,
-        }),
-    );
-    return Message.from(body, payload);
-  }
-
-  async $sendMessage(options: SendOptions): Promise<string> {
-    const channelId = options.id;
-    const contentRaw = segment.raw(options.content);
-    const result = await callSatoriApi(this.apiOptions(), 'message', 'create', {
-      channel_id: channelId,
-      content: contentRaw,
-    });
-    const list = Array.isArray(result) ? result : (result as { data?: unknown[] })?.data;
-    const msg = list?.[0] as { id?: string } | undefined;
-    const msgId = msg?.id ?? '';
-    return msgId ? `${channelId}:${msgId}` : '';
-  }
-
-  async $recallMessage(id: string): Promise<void> {
-    const [channelId, messageId] = id.includes(':') ? id.split(':') : ['', id];
-    await callSatoriApi(this.apiOptions(), 'message', 'delete', { channel_id: channelId, message_id: messageId });
-  }
-}

package/src/endpoint-ws.ts

@@ -1,214 +0,0 @@
-/**
- * Satori WebSocket Bot：应用连 SDK /v1/events，IDENTIFY 认证，收 EVENT 转 Message
- */
-import WebSocket from 'ws';
-import { EventEmitter } from 'events';
-import { clearInterval } from 'node:timers';
-import { formatCompact, Endpoint, Message, segment, SendOptions } from 'zhin.js';
-import { callSatoriApi } from './api.js';
-import type { SatoriWsConfig, SatoriSignal, SatoriEventBody, SatoriLogin } from './types.js';
-import { SatoriOpcode } from './types.js';
-import type { SatoriAdapter } from './adapter.js';
-import { formatSatoriMessagePayload, isMessageEvent } from './utils.js';
-
-export class SatoriWsClient extends EventEmitter implements Endpoint<SatoriWsConfig, SatoriEventBody> {
-  $connected: boolean;
-  private ws?: WebSocket;
-  private reconnectTimer?: NodeJS.Timeout;
-  private heartbeatTimer?: NodeJS.Timeout;
-  /** READY 后得到的当前登录，用于 API 的 platform / userId */
-  private login?: SatoriLogin;
-  private lastSn?: number;
-
-  get logger() {
-    return this.adapter.plugin.logger;
-  }
-
-  constructor(public adapter: SatoriAdapter, public $config: SatoriWsConfig) {
-    super();
-    this.$connected = false;
-  }
-
-  get $id() {
-    return this.$config.name;
-  }
-
-  private get wsUrl(): string {
-    const base = this.$config.baseUrl.replace(/\/$/, '');
-    const url=new URL(base);
-    if(this.$config.token) {
-      url.searchParams.set('access_token', this.$config.token);
-    }
-    return url.toString();
-  }
-
-  private apiOptions(): { baseUrl: string; platform: string; userId: string; token?: string } {
-    const platform = this.login?.platform ?? '';
-    const userId = this.login?.user?.id ?? '';
-    return { baseUrl: this.$config.baseUrl, platform, userId, token: this.$config.token };
-  }
-
-  private sendSignal(op: number, body?: Record<string, unknown>): void {
-    if (!this.ws || this.ws.readyState !== WebSocket.OPEN) return;
-    this.ws.send(JSON.stringify({ op, body: body ?? {} }));
-  }
-
-  private startHeartbeat(): void {
-    const interval = this.$config.heartbeat_interval ?? 10000;
-    this.heartbeatTimer = setInterval(() => {
-      this.sendSignal(SatoriOpcode.PING);
-    }, interval);
-  }
-
-  private scheduleReconnect(): void {
-    if (this.reconnectTimer) return;
-    const delay = 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);
-  }
-
-  async $connect(): Promise<void> {
-    return new Promise((resolve, reject) => {
-      const headers: Record<string, string> = {};
-      if (this.$config.token) headers['Authorization'] = `Bearer ${this.$config.token}`
-      this.ws = new WebSocket(this.wsUrl, { headers });
-
-      this.ws.on('open', () => {
-        this.$connected = true;
-        this.logger.info(formatCompact({ endpoint: this.$id, mode: 'ws' }));
-        this.sendSignal(SatoriOpcode.IDENTIFY, {
-          token: this.$config.token,
-          sn: this.lastSn,
-        });
-        this.startHeartbeat();
-        resolve();
-      });
-
-      this.ws.on('message', (data) => {
-        try {
-          const signal = JSON.parse(data.toString()) as SatoriSignal;
-          if (signal.op === SatoriOpcode.READY && signal.body?.logins) {
-            const logins = signal.body.logins as SatoriLogin[];
-            this.login = logins[0];
-            if (!this.login?.platform || !this.login?.user?.id) {
-              this.logger.warn(formatCompact( { op: 'ready', ok: false, error: 'missing platform/user' }));
-            }
-          } else if (signal.op === SatoriOpcode.EVENT && signal.body) {
-            if (signal.body.sn != null) this.lastSn = signal.body.sn as number;
-            this.handleEvent(signal.body as SatoriEventBody);
-          }
-        } 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: 5000,
-        }));
-        reject(new Error(`Satori WS closed: ${code} ${reasonStr}`));
-        this.scheduleReconnect();
-      });
-
-      this.ws.on('error', (error) => {
-        this.logger.warn(formatCompact( {
-          op: 'ws_error',
-          endpoint: this.$config.name,
-          ok: false,
-          error: error instanceof Error ? error.message : String(error),
-        }));
-        reject(error);
-      });
-    });
-  }
-
-  async $disconnect(): Promise<void> {
-    if (this.reconnectTimer) {
-      clearTimeout(this.reconnectTimer);
-      this.reconnectTimer = undefined;
-    }
-    if (this.heartbeatTimer) {
-      clearInterval(this.heartbeatTimer);
-      this.heartbeatTimer = undefined;
-    }
-    if (this.ws) {
-      this.ws.close();
-      this.ws = undefined;
-    }
-    this.$connected = false;
-  }
-
-  private handleEvent(body: SatoriEventBody): void {
-    if (isMessageEvent(body)) {
-      const message = this.$formatMessage(body);
-      this.adapter.emit('message.receive', message);
-      this.logger.debug(
-        `${this.$config.name} recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`,
-      );
-    }
-  }
-
-  $formatMessage(body: SatoriEventBody): Message<SatoriEventBody> {
-    if (!isMessageEvent(body)) {
-      return Message.from(body, {
-        $id: '',
-        $adapter: 'satori',
-        $endpoint: this.$config.name,
-        $channel: { id: '', type: 'private' },
-        $sender: { id: '', name: '' },
-        $content: [],
-        $raw: '',
-        $timestamp: body.timestamp ?? 0,
-        $recall: async () => {},
-        $reply: async () => '',
-      });
-    }
-    const payload = formatSatoriMessagePayload(
-      body,
-      'satori',
-      this.$config.name,
-      (id) => this.$recallMessage(id),
-      (channel, content, _quote) =>
-        this.adapter.sendMessage({
-          ...channel,
-          context: 'satori',
-          endpoint: this.$config.name,
-          content: content as import('zhin.js').SendContent,
-        }),
-    );
-    return Message.from(body, payload);
-  }
-
-  async $sendMessage(options: SendOptions): Promise<string> {
-    const channelId = options.id;
-    const contentRaw = segment.raw(options.content);
-    const result = await callSatoriApi(this.apiOptions(), 'message', 'create', {
-      channel_id: channelId,
-      content: contentRaw,
-    });
-    const list = Array.isArray(result) ? result : (result as { data?: unknown[] })?.data;
-    const msg = list?.[0] as { id?: string } | undefined;
-    const msgId = msg?.id ?? '';
-    this.logger.debug(`${this.$config.name} send ${options.type}(${channelId}):${contentRaw}`);
-    return msgId ? `${channelId}:${msgId}` : '';
-  }
-
-  async $recallMessage(id: string): Promise<void> {
-    const [channelId, messageId] = id.includes(':') ? id.split(':') : ['', id];
-    await callSatoriApi(this.apiOptions(), 'message', 'delete', { channel_id: channelId, message_id: messageId });
-  }
-}

package/src/types.ts

@@ -1,91 +0,0 @@
-/**
- * Satori 适配器类型（参考 https://satori.chat 协议）
- */
-
-/** 配置公共字段；单一适配器 context 均为 'satori'，连接方式由 connection 区分 */
-export interface SatoriConfigBase {
-  context: 'satori';
-  name: string;
-  baseUrl: string;
-  /** 认证 token，API 用 Authorization: Bearer，WebSocket IDENTIFY 用 token 字段 */
-  token?: string;
-}
-
-/** WebSocket 连接（应用连 SDK /v1/events） */
-export interface SatoriWsConfig extends SatoriConfigBase {
-  connection: 'ws';
-  /** 心跳间隔（毫秒），默认 10000 */
-  heartbeat_interval?: number;
-}
-
-/** WebHook（SDK POST 到应用提供的 path） */
-export interface SatoriWebhookConfig extends SatoriConfigBase {
-  connection: 'webhook';
-  path: string;
-}
-
-export type SatoriEndpointConfig = SatoriWsConfig | SatoriWebhookConfig;
-
-/** WebSocket/API 信号：op + body */
-export interface SatoriSignal {
-  op: number;
-  body?: Record<string, unknown>;
-}
-
-/** Opcode：EVENT=0, PING=1, PONG=2, IDENTIFY=3, READY=4, META=5 */
-export const SatoriOpcode = {
-  EVENT: 0,
-  PING: 1,
-  PONG: 2,
-  IDENTIFY: 3,
-  READY: 4,
-  META: 5,
-} as const;
-
-/** 事件体（EVENT 的 body）：type、sn、timestamp、login、message、channel、user 等 */
-export interface SatoriEventBody {
-  type?: string;
-  sn?: number;
-  timestamp?: number;
-  login?: SatoriLogin;
-  message?: SatoriMessage;
-  channel?: SatoriChannel;
-  user?: SatoriUser;
-  guild?: { id: string; name?: string };
-  member?: { user?: SatoriUser; nick?: string; roles?: string[] };
-  [key: string]: unknown;
-}
-
-/** Login 资源（READY 与事件中） */
-export interface SatoriLogin {
-  platform?: string;
-  user?: SatoriUser;
-  status?: number;
-  sn?: number;
-}
-
-/** Channel 资源：id, type (0=TEXT,1=DIRECT,2=CATEGORY,3=VOICE) */
-export interface SatoriChannel {
-  id: string;
-  type?: number;
-  name?: string;
-  parent_id?: string;
-}
-
-/** User 资源 */
-export interface SatoriUser {
-  id: string;
-  name?: string;
-  avatar?: string;
-}
-
-/** Message 资源：id, content（元素字符串）, channel, user 等 */
-export interface SatoriMessage {
-  id: string;
-  content?: string;
-  channel?: SatoriChannel;
-  user?: SatoriUser;
-  member?: { user?: SatoriUser; nick?: string };
-  created_at?: number;
-  updated_at?: number;
-}

package/src/utils.ts

@@ -1,64 +0,0 @@
-/**
- * Satori 事件与 zhin Message 的转换
- */
-import type { SendContent } from 'zhin.js';
-import { Message } from 'zhin.js';
-import type { SatoriEventBody, SatoriMessage, SatoriChannel } from './types.js';
-
-/** Satori Channel.type: 0=TEXT, 1=DIRECT, 2=CATEGORY, 3=VOICE */
-export function isPrivateChannel(channel?: SatoriChannel): boolean {
-  return channel?.type === 1;
-}
-
-/** 将 Satori 事件体转为 zhin Message 的 MessageBase（仅 message-created/updated，供 $formatMessage 使用） */
-export function formatSatoriMessagePayload(
-  body: SatoriEventBody,
-  adapterName: 'satori',
-  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: 'satori';
-  $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 msg = body.message!;
-  const channel = body.channel ?? msg.channel;
-  const user = body.user ?? msg.user ?? msg.member?.user;
-  const channelId = channel?.id ?? '';
-  const isPrivate = isPrivateChannel(channel);
-  const content = msg.content ?? '';
-  const raw = typeof content === 'string' ? content : String(content);
-  const senderId = user?.id ?? '';
-  const senderName = user?.name ?? msg.member?.nick ?? senderId;
-
-  return {
-    $id: `${channelId}:${msg.id}`,
-    $adapter: 'satori',
-    $endpoint: endpointName,
-    $channel: { id: channelId, type: isPrivate ? 'private' : 'group' },
-    $sender: { id: senderId, name: senderName },
-    $content: [{ type: 'text', data: { text: raw } }],
-    $raw: raw,
-    $timestamp: body.timestamp ?? msg.created_at ?? Math.floor(Date.now() / 1000),
-    $recall: () => recallFn(`${channelId}:${msg.id}`),
-    $reply: (cnt: SendContent, quote?: boolean | string) =>
-      replyFn(
-        { id: channelId, type: isPrivate ? 'private' : 'group' },
-        (Array.isArray(cnt) ? cnt : [cnt]) as (string | { type: string; data?: Record<string, unknown> })[],
-        quote,
-      ),
-  };
-}
-
-/** 判断是否为消息相关事件（message-created / message-updated） */
-export function isMessageEvent(body: SatoriEventBody): body is SatoriEventBody & { message: SatoriMessage } {
-  return (body.type === 'message-created' || body.type === 'message-updated') && !!body.message?.id;
-}