@zhin.js/adapter-onebot11 1.0.0 → 1.0.2

package/package.json

@@ -1,25 +1,39 @@
 {
   "name": "@zhin.js/adapter-onebot11",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "zhin adapter for onebot11",
   "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
+      "types": "./lib/index.d.ts",
+      "import": "./lib/index.js"
     }
   },
+  "dependencies": {
+    "ws": "^8.18.3"
+  },
   "devDependencies": {
-    "typescript": "^5.3.0",
-    "@zhin.js/types": "1.0.0"
+    "@types/node": "^24.3.0",
+    "@types/ws": "^8.18.1",
+    "typescript": "^5.3.0"
   },
   "peerDependencies": {
-    "zhin.js": "1.0.0"
+    "zhin.js": "1.0.2",
+    "@zhin.js/types": "1.0.1",
+    "@zhin.js/http": "1.0.1"
+  },
+  "peerDependenciesMeta": {
+    "@zhin.js/types": {
+      "optional": true
+    },
+    "@zhin.js/http": {
+      "optional": true
+    }
   },
   "scripts": {
     "build": "tsc",
-    "clean": "rm -rf dist"
+    "clean": "rm -rf lib"
   }
 }

package/src/index.ts

@@ -1,26 +1,57 @@
-import WebSocket from 'ws';
+import WebSocket, {WebSocketServer} from 'ws';
 import {EventEmitter} from "events";
-import { Bot,Plugin,Adapter,BotConfig,Message,registerAdapter, User, Group, MessageSegment, SendOptions } from 'zhin.js';
-
-declare module '@zhin.js/types'{
-  interface GlobalContext{
-    onebot11:Adapter<OneBot11WsClient>
+import {
+  Bot,
+  Plugin,
+  Adapter,
+  BotConfig,
+  Message,
+  registerAdapter,
+  User,
+  Group,
+  MessageSegment,
+  SendOptions,
+  MessageType, segment, useContext, SendContent
+} from 'zhin.js';
+import type {Router} from '@zhin.js/http'
+import {IncomingMessage} from "http";
+import {clearInterval} from "node:timers";
+
+declare module 'zhin.js'{
+  interface RegisteredAdapters{
+    'onebot11':Adapter<OneBot11WsClient>
+    'onebot11.wss':Adapter<OneBot11WsServer>
   }
 }
 // ============================================================================
 // OneBot11 配置和类型
 // ============================================================================
 
-export interface OneBotV11Config extends BotConfig {
+export interface OneBot11Config extends BotConfig {
   context: 'onebot11';
-  url: string;
+  type:string
   access_token?: string;
+}
+export interface OneBot11WsClientConfig extends OneBot11Config{
+  type:'ws'
+  url: string;
   reconnect_interval?: number;
   heartbeat_interval?: number;
 }
+export interface OneBot11WsServerConfig extends OneBot11Config{
+  type:'ws_reverse'
+  path:string
+  heartbeat_interval?: number;
+}
+export interface OneBot11HTTPConfig extends OneBot11Config{
+  type:'http_sse'
+  port:number
+  path:string
+}
 
 interface OneBot11Message {
   post_type: string;
+  self_id:string
   message_type?: string;
   sub_type?: string;
   message_id: number;
@@ -45,8 +76,8 @@ interface ApiResponse<T = any> {
 // OneBot11 适配器实现
 // ============================================================================
 
-export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Config> {
-  connected?:boolean
+export class OneBot11WsClient extends EventEmitter implements Bot<OneBot11Message,OneBot11WsClientConfig> {
+  $connected?:boolean
   private ws?: WebSocket;
   private reconnectTimer?: NodeJS.Timeout;
   private heartbeatTimer?: NodeJS.Timeout;
@@ -57,23 +88,25 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
     timeout: NodeJS.Timeout;
   }>();
 
-  constructor(public plugin:Plugin,public config: OneBotV11Config) {
+  constructor(public plugin:Plugin,public $config: OneBot11WsClientConfig) {
     super();
+    this.$connected=false
   }
 
 
-  async connect(): Promise<void> {
+  async $connect(): Promise<void> {
     return new Promise((resolve, reject) => {
-      let wsUrl = this.config.url;
+      let wsUrl = this.$config.url;
       const headers: Record<string, string> = {};
 
-      if (this.config.access_token) {
-        headers['Authorization'] = `Bearer ${this.config.access_token}`;
+      if (this.$config.access_token) {
+        headers['Authorization'] = `Bearer ${this.$config.access_token}`;
       }
       this.ws = new WebSocket(wsUrl,{headers});
 
       this.ws.on('open', () => {
-        this.connected=true;
+        this.$connected=true;
+        if(!this.$config.access_token) this.plugin.logger.warn(`missing 'access_token', your OneBot protocol is not safely`)
         this.startHeartbeat();
         resolve();
       });
@@ -88,7 +121,7 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
       });
 
       this.ws.on('close', (code,reason) => {
-        this.connected=false
+        this.$connected=false
         reject({code,reason})
         this.scheduleReconnect();
       });
@@ -99,7 +132,7 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
     });
   }
 
-  async disconnect(): Promise<void> {
+  async $disconnect(): Promise<void> {
     if (this.reconnectTimer) {
       clearTimeout(this.reconnectTimer);
       this.reconnectTimer = undefined;
@@ -122,53 +155,56 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
       this.ws = undefined;
     }
   }
+  $formatMessage(onebotMsg: OneBot11Message){
+    const message=Message.from(onebotMsg,{
+      $id: onebotMsg.message_id.toString(),
+      $adapter:'onebot11',
+      $bot:`${this.$config.name}`,
+      $sender:{
+        id:onebotMsg.user_id.toString(),
+        name:onebotMsg.user_id.toString()
+      },
+      $channel:{
+        id: (onebotMsg.group_id || onebotMsg.user_id).toString(),
+        type:onebotMsg.group_id?'group':'private'
+      },
+      $content: onebotMsg.message,
+      $raw: onebotMsg.raw_message,
+      $timestamp: onebotMsg.time,
+      $reply:async (content: MessageSegment[], quote?: boolean|string):Promise<void>=> {
+        if(quote) content.unshift({type:'reply',data:{message_id:message.$id}})
+        this.plugin.dispatch('message.send',{
+          ...message.$channel,
+          context:'onebot11',
+          bot:`${this.$config.name}`,
+          content
+        })
+      }
+    })
+    return message
+  }
 
-  async sendMessage(options: SendOptions): Promise<void> {
+  async $sendMessage(options: SendOptions): Promise<void> {
     options=await this.plugin.app.handleBeforeSend(options)
-    this.plugin.logger.info(`send ${options.type}(${options.id}):`,options.content)
     const messageData: any = {
       message: options.content
     };
-
     if (options.type==='group') {
       await this.callApi('send_group_msg', {
         group_id: parseInt(options.id),
         ...messageData
       });
+      this.plugin.logger.info(`send ${options.type}(${options.id}):${segment.raw(options.content)}`)
     } else if (options.type==='private') {
       await this.callApi('send_private_msg', {
         user_id: parseInt(options.id),
         ...messageData
       });
+      this.plugin.logger.info(`send ${options.type}(${options.id}):${segment.raw(options.content)}`)
     } else {
       throw new Error('Either group_id or user_id must be provided');
     }
   }
-
-  async getUser(userId: string): Promise<User> {
-    const response = await this.callApi('get_stranger_info', {
-      user_id: parseInt(userId)
-    });
-
-    return {
-      user_id: userId,
-      nickname: response.nickname,
-      card: response.card
-    };
-  }
-
-  async getGroup(groupId: string): Promise<Group> {
-    const response = await this.callApi('get_group_info', {
-      group_id: parseInt(groupId)
-    });
-
-    return {
-      group_id: groupId,
-      group_name: response.group_name,
-      member_count: response.member_count
-    };
-  }
-
   private async callApi(action: string, params: any = {}): Promise<any> {
     if (!this.ws || this.ws.readyState !== WebSocket.OPEN) {
       throw new Error('WebSocket is not connected');
@@ -215,38 +251,14 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
   }
 
   private handleOneBot11Message(onebotMsg: OneBot11Message): void {
-    const message: Message = {
-      id: onebotMsg.message_id.toString(),
-      adapter:'onebot11',
-      bot:`${this.config.name}`,
-      sender:{
-        id:onebotMsg.user_id.toString(),
-        name:onebotMsg.user_id.toString()
-      },
-      channel:{
-        id:(onebotMsg.group_id||onebotMsg.user_id).toString(),
-        type:onebotMsg.group_id?'group':'private'
-      },
-      content: onebotMsg.message,
-      raw: onebotMsg.raw_message,
-      timestamp: onebotMsg.time,
-      reply:async (content: MessageSegment[], quote?: boolean|string):Promise<void>=> {
-        if(quote) content.unshift({type:'reply',data:{message_id:message.id}})
-        this.plugin.dispatch('message.send',{
-          ...message.channel,
-          context:'onebot11',
-          bot:`${this.config.name}`,
-          content
-        })
-      }
-    };
+    const message = this.$formatMessage(onebotMsg);
     this.plugin.dispatch('message.receive',message)
-    this.plugin.logger.info(`recv ${message.channel.type}(${message.channel.id}):`,message.content)
-    this.plugin.dispatch(`message.${message.channel.type}.receive`,message)
+    this.plugin.logger.info(`recv ${message.$channel.type}(${message.$channel.id}):${segment.raw(message.$content)}`)
+    this.plugin.dispatch(`message.${message.$channel.type}.receive`,message)
   }
 
   private startHeartbeat(): void {
-    const interval = this.config.heartbeat_interval || 30000;
+    const interval = this.$config.heartbeat_interval || 30000;
     this.heartbeatTimer = setInterval(() => {
       if (this.ws && this.ws.readyState === WebSocket.OPEN) {
         this.ws.ping();
@@ -259,11 +271,11 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
       return;
     }
 
-    const interval = this.config.reconnect_interval || 5000;
+    const interval = this.$config.reconnect_interval || 5000;
     this.reconnectTimer = setTimeout(async () => {
       this.reconnectTimer = undefined;
       try {
-        await this.connect();
+        await this.$connect();
       } catch (error) {
         this.emit('error',new Error(`Reconnection failed: ${error}`));
         this.scheduleReconnect();
@@ -271,4 +283,198 @@ export class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Confi
     }, interval);
   }
 }
-registerAdapter(new Adapter('onebot11',OneBot11WsClient))
+export class OneBot11WsServer extends EventEmitter implements Bot<OneBot11Message,OneBot11WsServerConfig> {
+  $connected?:boolean
+  #wss?:WebSocketServer
+  #clientMap:Map<string,WebSocket>=new Map<string,WebSocket>()
+  private heartbeatTimer?: NodeJS.Timeout;
+  private requestId = 0;
+  private pendingRequests = new Map<string, {
+    resolve: (value: any) => void;
+    reject: (error: Error) => void;
+    timeout: NodeJS.Timeout;
+  }>();
+
+  constructor(public plugin:Plugin,public router:Router,public $config: OneBot11WsServerConfig) {
+    super();
+    this.$connected=false
+  }
+  async $connect(): Promise<void> {
+    if(!this.$config.access_token) this.plugin.logger.warn(`missing 'access_token', your OneBot protocol is not safely`)
+    this.#wss=this.router.ws(this.$config.path,{verifyClient:(info:{ origin: string; secure: boolean; req: IncomingMessage })=>{
+        const {
+          req: { headers },
+        } = info;
+        const authorization = headers['authorization'] || '';
+        if (this.$config.access_token && authorization !== `Bearer ${this.$config.access_token}`) {
+          this.plugin.logger.error('鉴权失败');
+          return false;
+        }
+        return true;
+      }})
+    this.$connected=true;
+    this.plugin.logger.info(`ws server start at path:${this.$config.path}`)
+    this.#wss.on('connection', (client,req) => {
+      this.startHeartbeat();
+      this.plugin.logger.info(`已连接到协议端：${req.socket.remoteAddress}`);
+      client.on('error', err => {
+        this.plugin.logger.error('连接出错：', err);
+      });
+      client.on('close', code => {
+        this.plugin.logger.error(`与连接端(${req.socket.remoteAddress})断开，错误码：${code}`);
+        for(const [key,value] of this.#clientMap){
+          if(client===value) this.#clientMap.delete(key)
+        }
+      });
+      client.on('message',(data) => {
+        try {
+          const message = JSON.parse(data.toString());
+          this.handleWebSocketMessage(client,message);
+        } catch (error) {
+          this.emit('error',error)
+        }
+      })
+    });
+  }
+
+  async $disconnect(): Promise<void> {
+    this.#wss?.close();
+    if(this.heartbeatTimer){
+      clearInterval(this.heartbeatTimer)
+      delete this.heartbeatTimer;
+    }
+  }
+  $formatMessage(onebotMsg: OneBot11Message){
+    const message=Message.from(onebotMsg,{
+      $id: onebotMsg.message_id.toString(),
+      $adapter:'onebot11',
+      $bot:`${this.$config.name}`,
+      $sender:{
+        id:onebotMsg.user_id.toString(),
+        name:onebotMsg.user_id.toString()
+      },
+      $channel:{
+        id:[onebotMsg.self_id,(onebotMsg.group_id||onebotMsg.user_id)].join(':'),
+        type:onebotMsg.group_id?'group':'private'
+      },
+      $content: onebotMsg.message,
+      $raw: onebotMsg.raw_message,
+      $timestamp: onebotMsg.time,
+      $reply:async (content: SendContent, quote?: boolean|string):Promise<void>=> {
+        if(!Array.isArray(content)) content=[content];
+        if(quote) content.unshift({type:'reply',data:{message_id:message.$id}})
+        this.plugin.dispatch('message.send',{
+          ...message.$channel,
+          context:'onebot11',
+          bot:`${this.$config.name}`,
+          content
+        })
+      }
+    })
+    return message
+  }
+
+  async $sendMessage(options: SendOptions): Promise<void> {
+    options=await this.plugin.app.handleBeforeSend(options)
+    const messageData: any = {
+      message: options.content
+    };
+    if (options.type==='group') {
+      const [self_id,id]=options.id.split(':')
+      await this.callApi(self_id,'send_group_msg', {
+        group_id: parseInt(id),
+        ...messageData
+      });
+      this.plugin.logger.info(`send ${options.type}(${id}):${segment.raw(options.content)}`)
+    } else if (options.type==='private') {
+      const [self_id,id]=options.id.split(':')
+      await this.callApi(self_id,'send_private_msg', {
+        user_id: parseInt(id),
+        ...messageData
+      });
+      this.plugin.logger.info(`send ${options.type}(${id}):${segment.raw(options.content)}`)
+    } else {
+      throw new Error('Either group_id or user_id must be provided');
+    }
+  }
+  private async callApi(self_id:string,action: string, params: any = {}): Promise<any> {
+    const client=this.#clientMap.get(self_id)
+    if (!client || client.readyState !== WebSocket.OPEN) {
+      throw new Error('WebSocket is not connected');
+    }
+
+    const echo = `req_${++this.requestId}`;
+    const message = {
+      action,
+      params,
+      echo
+    };
+
+    return new Promise((resolve, reject) => {
+      const timeout = setTimeout(() => {
+        this.pendingRequests.delete(echo);
+        reject(new Error(`API call timeout: ${action}`));
+      }, 30000); // 30秒超时
+
+      this.pendingRequests.set(echo, { resolve, reject, timeout });
+      client.send(JSON.stringify(message));
+    });
+  }
+
+  private handleWebSocketMessage(client:WebSocket,message: any): void {
+    // 处理API响应
+    if (message.echo && this.pendingRequests.has(message.echo)) {
+      const request = this.pendingRequests.get(message.echo)!;
+      this.pendingRequests.delete(message.echo);
+      clearTimeout(request.timeout);
+
+      const response = message as ApiResponse;
+      if (response.status === 'ok') {
+        return request.resolve(response.data);
+      }
+      return request.reject(new Error(`API error: ${response.retcode}`));
+    }
+    switch (message.post_type){
+      case 'message':
+        return this.handleMessage(message);
+      case 'meta_event':
+        return this.handleMetaEvent(client,message)
+    }
+    // 处理事件消息
+    if (message.post_type === 'message') {
+    } else if (message.post_type === 'meta_event' && message.meta_event_type === 'heartbeat') {
+      // 心跳消息，暂时忽略
+    }
+  }
+  private handleMetaEvent(client:WebSocket,message:any){
+    switch (message.sub_type){
+      case 'heartbeat':
+        break;
+      case 'connect':
+        this.#clientMap.set(message.self_id,client);
+        this.plugin.logger.info(`client ${message.self_id} of ${this.$config.name} by ${this.$config.context} connected`)
+        break;
+    }
+  }
+  private handleMessage(onebotMsg: OneBot11Message): void {
+    const message = this.$formatMessage(onebotMsg);
+    this.plugin.dispatch('message.receive',message)
+    this.plugin.logger.info(`recv ${message.$channel.type}(${onebotMsg.group_id||onebotMsg.user_id}):${segment.raw(message.$content)}`)
+    this.plugin.dispatch(`message.${message.$channel.type}.receive`,message)
+  }
+
+  private startHeartbeat(): void {
+    const interval = this.$config.heartbeat_interval || 30000;
+    this.heartbeatTimer = setInterval(() => {
+      for(const client of this.#wss?.clients||[]){
+        if (client && client.readyState === WebSocket.OPEN) {
+          client.ping();
+        }
+      }
+    }, interval);
+  }
+}
+registerAdapter(new Adapter('onebot11',OneBot11WsClient))
+useContext('router',(router)=>{
+  registerAdapter(new Adapter('onebot11.wss',(p,c:OneBot11WsServerConfig)=>new OneBot11WsServer(p,router,c)));
+})

package/tsconfig.json

@@ -2,8 +2,8 @@
   "compilerOptions": {
     "target": "ES2022",
     "module": "ESNext",
-    "moduleResolution": "node",
-    "outDir": "./dist",
+    "moduleResolution": "bundler",
+    "outDir": "./lib",
     "rootDir": "./src",
     "strict": true,
     "esModuleInterop": true,
@@ -17,9 +17,8 @@
     "declaration": true,
     "declarationMap": true,
     "sourceMap": true,
-    "composite": true,
     "verbatimModuleSyntax": false
   },
   "include": ["src/**/*"],
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["lib", "node_modules"]
 } 

package/dist/index.d.ts

@@ -1,36 +0,0 @@
-import { EventEmitter } from "events";
-import { Bot, Plugin, Adapter, BotConfig, User, Group, SendOptions } from 'zhin.js';
-declare module '@zhin.js/types' {
-    interface GlobalContext {
-        onebot11: Adapter<OneBot11WsClient>;
-    }
-}
-export interface OneBotV11Config extends BotConfig {
-    context: 'onebot11';
-    url: string;
-    access_token?: string;
-    reconnect_interval?: number;
-    heartbeat_interval?: number;
-}
-export declare class OneBot11WsClient extends EventEmitter implements Bot<OneBotV11Config> {
-    plugin: Plugin;
-    config: OneBotV11Config;
-    connected?: boolean;
-    private ws?;
-    private reconnectTimer?;
-    private heartbeatTimer?;
-    private requestId;
-    private pendingRequests;
-    constructor(plugin: Plugin, config: OneBotV11Config);
-    connect(): Promise<void>;
-    disconnect(): Promise<void>;
-    sendMessage(options: SendOptions): Promise<void>;
-    getUser(userId: string): Promise<User>;
-    getGroup(groupId: string): Promise<Group>;
-    private callApi;
-    private handleWebSocketMessage;
-    private handleOneBot11Message;
-    private startHeartbeat;
-    private scheduleReconnect;
-}
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,GAAG,EAAC,MAAM,EAAC,OAAO,EAAC,SAAS,EAA0B,IAAI,EAAE,KAAK,EAAkB,WAAW,EAAE,MAAM,SAAS,CAAC;AAEzH,OAAO,QAAQ,gBAAgB,CAAA;IAC7B,UAAU,aAAa;QACrB,QAAQ,EAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;KACnC;CACF;AAKD,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,OAAO,EAAE,UAAU,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AA4BD,qBAAa,gBAAiB,SAAQ,YAAa,YAAW,GAAG,CAAC,eAAe,CAAC;IAY7D,MAAM,EAAC,MAAM;IAAQ,MAAM,EAAE,eAAe;IAX/D,SAAS,CAAC,EAAC,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,CAAC,CAAY;IACvB,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,cAAc,CAAC,CAAiB;IACxC,OAAO,CAAC,SAAS,CAAK;IACtB,OAAO,CAAC,eAAe,CAIlB;gBAEc,MAAM,EAAC,MAAM,EAAQ,MAAM,EAAE,eAAe;IAKzD,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAqCxB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB3B,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBhD,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYtC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;YAYjC,OAAO;IAuBrB,OAAO,CAAC,sBAAsB;IAsB9B,OAAO,CAAC,qBAAqB;IA+B7B,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,iBAAiB;CAgB1B"}