onebots 0.4.9 → 0.4.11

package/README.md

@@ -17,57 +17,112 @@
 </div>
 
 # 使用示例
-## 全局安装
+## 全局安装(0.4.8以后不推荐)
 ### 1 安装依赖
 ```shell
 npm install -g onebots
+# 0.4.8以上版本需要安装icqq
+npm install -g icqq
 ```
 ### 2 初始化配置文件
-(1) 配置文件存到(用户目录/.onebots/config.yaml)
+在你想存放配置文件的目录执行如下命令
 ```shell
 onebots
 ```
-(2) 配置文件存到(当前目录/config.yaml)
-```shell
-onebots -c config.yaml
-```
-二选一即可
-### 3 更改配置文件后，启动项目
-
-(1) 使用全局配置文件(用户目录/.onebots/config.yaml)
-```shell
-onebots
-```
-(2) 使用指定配置文件(当前目录/config.yaml)
-```shell
-onebots -c config.yaml
-```
-# 2 在NodeJS项目中启动
+### 3 更改生成的默认配置文件成你想要的配置配置后再次运行上面的指令，启动项目
+## 局部安装
 ## 1 初始化node项目
 ```shell
 npm init -y
 ```
-## 2. 安装onebots
+## 2. 安装onebots和icqq
 ```shell
-npm install onebots
-```
-## 3. 在项目跟目录添加配置文件config.yaml
-```yaml
-port: 6727 # 项目onebots监听的端口(默认：6727)
-1472258369: # 你的机器人账户
-  version: V11 # oneBot版本（V11 或 V12）
-```
-## 4. 新建入口文件`index.js`并输入一下内容
-```javascript
-const {createApp}=require('onebots')
-createApp('config.yaml')
-.start()
+npm install onebots icqq
 ```
-## 5. 启动项目
+## 3. 执行如下命令生成配置文件
 ```shell
-node ./index.js
+npx onebots
+```
+## 4. 更改生成的默认配置文件成你想要的配置配置后再次运行上面的指令，启动项目
+# 默认配置文件
+```yaml
+port: 6727 # 监听端口
+log_level: info # 日志等级
+platform: 5 # 机器人客户端协议（1:Android 2:APad 3:Watch 4:IMac 5:IPad）
+timeout: 30 #登录超时时间(秒)
+general: # 通用配置，在单个配置省略时的默认值
+  V11: # oneBotV11的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    post_timeout: 15 # 上报超时时间，(秒)
+    secret: '' # 上报数据的sha1签名密钥
+    rate_limit_interval: 4 # ws心跳间隔(秒)
+    post_message_format: string # "string"或"array"
+    reconnect_interval: 3 # 重连间隔 (秒)
+    use_http: true # 是否使用 http
+    enable_cors: true # 是否允许跨域
+    use_ws: true # 是否使用websocket
+    http_reverse: [ ] # http上报地址
+    ws_reverse: [ ] # 反向ws连接地址
+  V12: # oneBotV12的通用配置
+    heartbeat: 3 # 心跳间隔 (秒)
+    access_token: '' # 访问api的token
+    request_timeout: 15 # 上报超时时间 (秒)
+    reconnect_interval: 3 # 重连间隔 (秒)
+    enable_cors: true # 是否允许跨域
+    use_http: true # 是否启用http
+    use_ws: true # 是否启用 websocket
+    webhook: [ ] # http 上报地址
+    ws_reverse: [ ] # 反向ws连接地址
+# 每个账号的单独配置(用于覆盖通用配置)
+123456789:
+  version: V11 # 使用的oneBot版本
+  password: abcedfghi # 账号密码，未配置则扫码登陆
+  # 。。。其他配置项参见上方对应oneBot版本的通用配置
+
 ```
-# 使用接口管理oneBot
+# 配置解释
+## Config
+| 配置项  | 类型     | 默认值  | desc                                        |
+|:-----|:-------|:-----|:--------------------------------------------|
+| port | number | 6727 | 服务监听端口                                      |
+| logLevel| string | info | 日志级别                                        |
+| platform | number | 5    | 机器人平台,1:android 2:aPid 3:watch 4:mac 5:iPad |
+| sign_api_addr| string | -    | 签名API地址|
+| general | OneBotConfig | general | 通用配置|
+| [number] | OneBotConfig\|OneBotConfig[] | - | 机器人配置|
+## OneBotConfig
+| 配置项  | 类型     | 默认值  | desc                                        |
+|:-----|:-------|:-----|:--------------------------------------------|
+| V11| ConfigV11| configV11| V11配置|
+| V12| ConfigV12| configV12| V12配置|
+## ConfigV11
+| 配置项  | 类型       | 默认值 | desc       |
+|:-----|:---------|:----|:-----------|
+| heartbeat| number   | 3   | 心跳间隔 单位：秒  |
+| access_token| string   | -   | 访问令牌       |
+| secret| string   | -   | 签名密钥       |
+|rate_limit_interval| number   | 4   | 限速间隔 单位：秒  |
+| post_message_format| string   | string   | 消息格式化      |
+|reconnect_interval| number   | 3   | 重连间隔 单位：秒  |
+| use_http| boolean  | false   | 是否使用http协议 |
+| enable_cors| boolean  | false   | 是否允许跨域     |
+| use_ws| boolean  | false   | 是否使用ws协议   |
+|http_reverse_url| string[] | -   | http上报地址地址 |
+| ws_reverse_url| string[] | -   | 反向ws连接地址  |
+## ConfigV12
+| 配置项  | 类型       | 默认值 | desc        |
+|:-----|:---------|:----|:------------|
+| heartbeat| number   | 3   | 心跳间隔 单位：秒   |
+| access_token| string   | -   | 访问令牌        |
+| request_timeout| number   | 15  | 请求超时 单位：秒   |
+| reconnect_interval| number   | 3   | 重连间隔 单位：秒   |
+|enable_cors| boolean  | false   | 是否允许跨域      |
+|use_http| boolean  | false   | 是否使用http协议  |
+|use_ws| boolean  | false   | 是否使用ws协议    |
+|webhook_reverse_url| string[] | -   | webhook上报地址 |
+|ws_reverse_url| string[] | -   | 反向ws连接地址   |
+# 使用API管理oneBot
 
 | url     | method | params          | desc                           |
 |:--------| :--- |:----------------|:-------------------------------|

package/lib/service/V11/action/common.d.ts

@@ -16,7 +16,7 @@ export declare class CommonAction {
      * 获取消息
      * @param message_id {string} 消息id
      */
-    getMsg(this: V11, message_id: string): Promise<import("icqq").GroupMessage | import("icqq").PrivateMessage>;
+    getMsg(this: V11, message_id: number): Promise<import("icqq").GroupMessage | import("icqq").PrivateMessage>;
     /**
      * 获取合并消息
      * @param id {string} 合并id

package/lib/service/V11/action/common.js

@@ -25,7 +25,8 @@ class CommonAction {
      * @param message_id {string} 消息id
      */
     getMsg(message_id) {
-        return this.client.getMsg(message_id);
+        const messageId = this.db.get(`KVMap.${message_id}`);
+        return this.client.getMsg(messageId);
     }
     /**
      * 获取合并消息

package/lib/service/V11/index.d.ts

@@ -8,6 +8,8 @@ import { Logger } from "log4js";
 import { WebSocket, WebSocketServer } from "ws";
 import { Dispose } from "../../types";
 import { EventEmitter } from "events";
+import { Database } from "../../db";
+import { V12 } from "../../service/V12";
 export declare class V11 extends EventEmitter implements OneBot.Base {
     oneBot: OneBot<'V11'>;
     client: Client;
@@ -17,6 +19,11 @@ export declare class V11 extends EventEmitter implements OneBot.Base {
     protected timestamp: number;
     protected heartbeat?: NodeJS.Timeout;
     private path;
+    db: Database<{
+        eventBuffer: V12.Payload<keyof Action>[];
+        KVMap: Record<number, string>;
+        files: Record<string, V12.FileInfo>;
+    }>;
     disposes: Dispose[];
     protected _queue: Array<{
         method: keyof Action;
@@ -68,7 +75,7 @@ export declare namespace V11 {
     function error(error: string, retcode?: number): Result<any>;
     const defaultConfig: Config;
     function genMetaEvent(uin: number, type: string): {
-        self_id: string;
+        self_id: number;
         time: number;
         post_type: string;
         meta_event_type: string;

package/lib/service/V11/index.js

@@ -16,6 +16,9 @@ const http_1 = __importDefault(require("http"));
 const https_1 = __importDefault(require("https"));
 const events_1 = require("events");
 const fs_1 = require("fs");
+const db_1 = require("../../db");
+const path_1 = require("path");
+const app_1 = require("../../server/app");
 class V11 extends events_1.EventEmitter {
     constructor(oneBot, client, config) {
         super();
@@ -28,6 +31,8 @@ class V11 extends events_1.EventEmitter {
         this.queue_running = false;
         this.wsr = new Set();
         this.action = new action_1.Action();
+        this.db = new db_1.Database((0, path_1.join)(app_1.App.configDir, 'data', this.oneBot.uin + '.json'));
+        this.db.sync({ eventBuffer: [], KVMap: {}, files: {} });
         this.logger = this.oneBot.app.getLogger(this.oneBot.uin, this.version);
     }
     start(path) {
@@ -61,7 +66,7 @@ class V11 extends events_1.EventEmitter {
         if (this.config.heartbeat) {
             this.heartbeat = setInterval(() => {
                 this.dispatch({
-                    self_id: this.oneBot.uin + '',
+                    self_id: this.oneBot.uin,
                     status: {
                         online: this.client.status === icqq_1.OnlineStatus.Online,
                         good: this.oneBot.status === onebot_1.OneBotStatus.Good
@@ -193,12 +198,20 @@ class V11 extends events_1.EventEmitter {
         if (data.message && data.post_type === 'message') {
             data.message = this.config.post_message_format === 'array' ? (0, icqq_cq_enable_1.toSegment)(data.message) : (0, icqq_cq_enable_1.toCqcode)(data);
         }
+        if (data.message_id) {
+            this.db.set(`KVMap.${data.seq}`, data.message_id);
+            data.message_id = data.seq;
+        }
+        if (data.font) {
+            const fontNo = Buffer.from(data.font).readUInt32BE();
+            this.db.set(`KVMap.${data.fontNo}`, data.font);
+            data.font = fontNo;
+        }
         data.time = Math.floor(Date.now() / 1000);
-        data = (0, utils_1.transformObj)(data, (key, value) => {
-            if (!['user_id', 'group_id', 'discuss_id', 'member_id', 'channel_id', 'guild_id'].includes(key))
-                return value;
-            return value + '';
-        });
+        // data = transformObj(data, (key, value) => {
+        //     if (!['user_id', 'group_id', 'discuss_id', 'member_id', 'channel_id', 'guild_id'].includes(key)) return value
+        //     return value + ''
+        // })
         this.emit('dispatch', JSON.stringify(data));
     }
     async _httpRequestHandler(ctx) {
@@ -498,7 +511,7 @@ exports.V11 = V11;
     };
     function genMetaEvent(uin, type) {
         return {
-            self_id: uin + '',
+            self_id: uin,
             time: Math.floor(Date.now() / 1000),
             post_type: "meta_event",
             meta_event_type: "lifecycle",

package/lib/service/V12/action/guild.d.ts

@@ -8,9 +8,9 @@ export declare class GuildAction {
         guild_id: string;
         channel_id: string;
         channel_name: string;
-        channel_type: import("icqq/lib/channel").ChannelType;
+        channel_type: import("icqq").ChannelType;
     }[];
-    getGuildMemberList(this: V12, guild_id: string): never[] | Promise<import("icqq/lib/guild").GuildMember[]>;
+    getGuildMemberList(this: V12, guild_id: string): never[] | Promise<import("icqq").GuildMember[]>;
     /**
      * 发送群聊消息
      * @param guild_id {number} 频道id

package/lib/service/V12/index.d.ts

@@ -44,7 +44,7 @@ export declare class V12 extends EventEmitter implements OneBot.Base {
         sub_type: string;
     } & Omit<V12.BotEventMap[E], E> & {
         group: any;
-        frind: any;
+        friend: any;
         member: any;
     };
     dispatch(data: Record<string, any>): void;
@@ -229,7 +229,7 @@ export declare namespace V12 {
         sub_type: string;
     } & Omit<BotEventMap[K], K> & {
         group: any;
-        frind: any;
+        friend: any;
         member: any;
     };
     type RequestAction = {

package/lib/service/V12/index.js

@@ -29,7 +29,7 @@ class V12 extends events_1.EventEmitter {
         this.timestamp = Date.now();
         this.wsr = new Set();
         this.db = new db_1.Database((0, path_1.join)(app_1.App.configDir, 'data', this.oneBot.uin + '.json'));
-        this.db.sync({ eventBuffer: [], files: {} });
+        this.db.sync({ eventBuffer: [], msgIdMap: {}, files: {} });
         this.action = new action_1.Action();
         this.logger = this.oneBot.app.getLogger(this.oneBot.uin, this.version);
     }
@@ -570,7 +570,7 @@ class V12 extends events_1.EventEmitter {
             setTimeout(() => {
                 if (timestmap < this.timestamp)
                     return;
-                this.startWsReverse(config);
+                this._createWsr(url, config);
             }, this.config.reconnect_interval * 1000);
         });
     }
@@ -723,7 +723,7 @@ exports.V12 = V12;
             sub_type: '',
             ...data,
             group: data['group']?.info,
-            frind: data['friend']?.info,
+            friend: data['friend']?.info,
             member: data['member']?.info,
         };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebots",
-  "version": "0.4.9",
+  "version": "0.4.11",
   "description": "基于icqq的多例oneBot实现",
   "engines": {
     "node": ">=16"