onebots 0.4.12 → 0.4.14

package/README.md

@@ -74,64 +74,71 @@ general: # 通用配置，在单个配置省略时的默认值
     use_ws: true # 是否启用 websocket
     webhook: [ ] # http 上报地址
     ws_reverse: [ ] # 反向ws连接地址
+  protocol:
+    platform: 2
+    sign_api_addr: '' #你的签名地址
+    password: '' # 账号密码，未配置则扫码登陆
+    # ...其他配置项参考icqq的Config配置
 # 每个账号的单独配置(用于覆盖通用配置)
 123456789:
   version: V11 # 使用的oneBot版本
-  password: abcedfghi # 账号密码，未配置则扫码登陆
-  # 。。。其他配置项参见上方对应oneBot版本的通用配置
-
+  # ...其他配置项参见上方对应oneBot版本的通用配置
+  protocol:
+    platform: 2
+    sign_api_addr: '' #你的签名地址
+    password: '' # 账号密码，未配置则扫码登陆
+    # ...其他配置项参考icqq的Config配置
 ```
 # 配置解释
 ## 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[] | - | 机器人配置|
+| 配置项      | 类型                           | 默认值     | desc   |
+|:---------|:-----------------------------|:--------|:-------|
+| port     | number                       | 6727    | 服务监听端口 |
+| logLevel | string                       | info    | 日志级别   |
+| general  | OneBotConfig                 | general | 通用配置   |
+| [number] | OneBotConfig\|OneBotConfig[] | -       | 机器人配置  |
 ## OneBotConfig
-| 配置项  | 类型     | 默认值  | desc                                        |
-|:-----|:-------|:-----|:--------------------------------------------|
-| V11| ConfigV11| configV11| V11配置|
-| V12| ConfigV12| configV12| V12配置|
+| 配置项      | 类型        | 默认值       | desc   |
+|:---------|:----------|:----------|:-------|
+| V11      | ConfigV11 | configV11 | V11配置  |
+| V12      | ConfigV12 | configV12 | V12配置  |
+| protocol | Config    | {}        | icqq配置 |
 ## 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连接地址  |
+| 配置项                 | 类型       | 默认值    | 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连接地址   |
+| 配置项                 | 类型       | 默认值   | 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                           |
-|:--------| :--- |:----------------|:-------------------------------|
-| /list   | GET |                 | 获取当前运行的机器人列表                   |
-| /detail | GET | uin             | 获取指定机器人配置                      |
-| /qrcode | GET | uin             | 获取指定机器人登录二维码                   |
-| /add    | POST | {uin,...config} | 添加机器人 config 为机器人配置            |
-| /edit   | POST | {uin,...config} | 修改机器人配置 config 为机器人配置          |
-| /remove | get | uin,force       | 移除机器人,force为true时，将删除机器人data目录 |
+|:--------|:-------|:----------------|:-------------------------------|
+| /list   | GET    |                 | 获取当前运行的机器人列表                   |
+| /detail | GET    | uin             | 获取指定机器人配置                      |
+| /qrcode | GET    | uin             | 获取指定机器人登录二维码                   |
+| /add    | POST   | {uin,...config} | 添加机器人 config 为机器人配置            |
+| /edit   | POST   | {uin,...config} | 修改机器人配置 config 为机器人配置          |
+| /remove | get    | uin,force       | 移除机器人,force为true时，将删除机器人data目录 |
 
 # 鸣谢
 1. [icqqjs/icqq](https://github.com/icqqjs/icqq) 底层服务支持

package/lib/config.sample.yaml

@@ -26,8 +26,11 @@ general: # 通用配置，在单个配置省略时的默认值
     use_ws: true # 是否启用 websocket
     webhook: [ ] # http 上报地址
     ws_reverse: [ ] # 反向ws连接地址
+  protocol:
+    platform: 2
 # 每个账号的单独配置(用于覆盖通用配置)
 123456789:
   version: V11 # 使用的oneBot版本
-  password: abcedfghi # 账号密码，未配置则扫码登陆
+  protocol: # 将会覆盖通用配置中的protocol
+    platform: 1
   # 。。。其他配置项参见上方对应oneBot版本的通用配置

package/lib/onebot.d.ts

@@ -2,7 +2,8 @@
 import 'icqq-cq-enable';
 import { EventEmitter } from 'events';
 import { App } from "./server/app";
-import { Client, Platform } from "icqq";
+import { Client } from "icqq";
+import { Config as IcqqConfig } from 'icqq';
 import { V11 } from "./service/V11";
 import { V12 } from "./service/V12";
 import { MayBeArray } from "./types";
@@ -32,8 +33,7 @@ export declare namespace OneBot {
     type Version = 'V11' | 'V12';
     type Config<V extends Version = 'V11'> = ({
         version?: V;
-        platform?: Platform;
-        password?: string;
+        protocol?: IcqqConfig;
     } & (V extends 'V11' ? V11.Config : V12.Config));
     interface Base {
         start(path?: string): any;

package/lib/onebot.js

@@ -47,15 +47,16 @@ class OneBot extends events_1.EventEmitter {
         this.app = app;
         this.uin = uin;
         config = [].concat(config);
-        let platform = this.app.config.platform;
-        let sign_api_addr = this.app.config.sign_api_addr;
+        const protocolConfig = {
+            data_dir: (0, path_1.join)(app_1.App.configDir, 'data'),
+            ...this.app.config.general.protocol
+        };
         this.config = config.map(c => {
-            if (c.platform)
-                platform = c.platform;
-            if (c.password)
-                this.password = c.password;
             if (!c.version)
                 c.version = 'V11';
+            if (!c.protocol)
+                c.protocol = {};
+            Object.assign(protocolConfig, c.protocol);
             switch (c.version) {
                 case 'V11':
                     return (0, utils_1.deepMerge)((0, utils_1.deepClone)(this.app.config.general.V11), c);
@@ -65,13 +66,13 @@ class OneBot extends events_1.EventEmitter {
                     throw new Error('不支持的oneBot版本：' + c.version);
             }
         });
-        this.client = new icqq_1.Client({ platform, sign_api_addr, data_dir: (0, path_1.join)(app_1.App.configDir, 'data') });
+        this.client = new icqq_1.Client(protocolConfig);
         this.instances = this.config.map(c => {
             switch (c.version) {
                 case 'V11':
-                    return new V11_1.V11(this, this.client, (0, utils_1.omit)(c, ['version', 'password']));
+                    return new V11_1.V11(this, this.client, c);
                 case 'V12':
-                    return new V12_1.V12(this, this.client, (0, utils_1.omit)(c, ['version', 'password']));
+                    return new V12_1.V12(this, this.client, c);
                 default:
                     throw new Error('不支持的oneBot版本：' + c.version);
             }

package/lib/server/app.d.ts

@@ -3,12 +3,12 @@
 import Koa from 'koa';
 import { Logger } from "log4js";
 import { Server } from "http";
+import { Config as IcqqConfig } from "icqq";
 import { OneBot } from "../onebot";
 import { Router } from "./router";
 import { V11 } from "../service/V11";
 import { V12 } from "../service/V12";
 import { LogLevel, MayBeArray } from "../types";
-import { Platform } from "icqq";
 export interface KoaOptions {
     env?: string;
     keys?: string[];
@@ -43,11 +43,10 @@ export declare namespace App {
         path?: string;
         timeout?: number;
         log_level?: LogLevel;
-        sign_api_addr?: string;
-        platform?: Platform;
         general?: {
             V11?: V11.Config;
             V12?: V12.Config;
+            protocol?: IcqqConfig;
         };
     } & KoaOptions & Record<`${number}`, MayBeArray<OneBot.Config<OneBot.Version>>>;
     const defaultConfig: Config;

package/lib/server/app.js

@@ -47,7 +47,7 @@ class App extends koa_1.default {
     constructor(config = {}) {
         super(config);
         this.oneBots = [];
-        this.config = (0, utils_1.deepMerge)((0, utils_1.deepClone)(App.defaultConfig), config);
+        this.config = (0, utils_1.deepMerge)((0, utils_1.deepClone)(_a.defaultConfig), config);
         this.logger = (0, log4js_1.getLogger)('[icqq-OneBot]');
         this.logger.level = this.config.log_level;
         this.router = new router_1.Router({ prefix: config.path });
@@ -86,7 +86,7 @@ class App extends koa_1.default {
         this.config[uin] = config;
         const oneBot = this.createOneBot(uin, config);
         oneBot.startListen();
-        (0, fs_1.writeFileSync)(App.configPath, js_yaml_1.default.dump((0, utils_1.deepClone)(this.config)));
+        (0, fs_1.writeFileSync)(_a.configPath, js_yaml_1.default.dump((0, utils_1.deepClone)(this.config)));
     }
     updateAccount(uin, config) {
         if (typeof uin !== "number")
@@ -112,7 +112,7 @@ class App extends koa_1.default {
         oneBot.stop(force);
         delete this.config[uin];
         this.oneBots.splice(currentIdx, 1);
-        (0, fs_1.writeFileSync)(App.configPath, js_yaml_1.default.dump(this.config));
+        (0, fs_1.writeFileSync)(_a.configPath, js_yaml_1.default.dump(this.config));
     }
     createOneBot(uin, config) {
         const oneBot = new onebot_1.OneBot(this, uin, config);
@@ -125,18 +125,18 @@ class App extends koa_1.default {
             ctx.body = this.oneBots.map(bot => {
                 return {
                     uin: bot.uin,
-                    config: bot.config.map(c => (0, utils_1.protectedFields)(c, 'password', "access_token")),
+                    config: bot.config.map(c => (0, utils_1.protectedFields)(c, 'protocol', "access_token")),
                     urls: bot.config.map(c => `/${c.version}/${bot.uin}`)
                 };
             });
         });
         this.router.get('/qrcode', (ctx) => {
             const { uin } = ctx.query;
-            const uinUrl = path.join(App.configDir, 'data', uin);
+            const uinUrl = path.join(_a.configDir, 'data', uin);
             if (!(0, fs_1.existsSync)(uinUrl)) {
                 return ctx.res.writeHead(400).end('未登录');
             }
-            const qrcodePath = path.join(App.configDir, 'data', uin, 'qrcode.png');
+            const qrcodePath = path.join(_a.configDir, 'data', uin, 'qrcode.png');
             let file = null;
             try {
                 file = (0, fs_2.readFileSync)(qrcodePath); //读取文件
@@ -153,7 +153,7 @@ class App extends koa_1.default {
             const oneBot = this.oneBots.find(bot => bot.uin === Number(uin));
             ctx.body = {
                 uin,
-                config: oneBot.config.map(c => (0, utils_1.protectedFields)(c, 'password', "access_token")),
+                config: oneBot.config.map(c => (0, utils_1.protectedFields)(c, 'protocol', "access_token")),
                 urls: oneBot.config.map(c => `/${uin}/${c.version}`)
             };
         });
@@ -234,10 +234,12 @@ exports.defineConfig = defineConfig;
     App.defaultConfig = {
         port: 6727,
         timeout: 30,
-        platform: 5,
         general: {
             V11: V11_1.V11.defaultConfig,
-            V12: V12_1.V12.defaultConfig
+            V12: V12_1.V12.defaultConfig,
+            protocol: {
+                platform: 2
+            }
         },
         log_level: 'info',
     };

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

@@ -17,9 +17,5 @@ export declare class GuildAction {
      * @param channel_id {string} 子频道id
      * @param message {import('icqq/lib/service').Sendable} 消息
      */
-    sendGuildMsg(this: V12, guild_id: string, channel_id: string, message: V12.Sendable): Promise<{
-        seq: number;
-        rand: number;
-        time: number;
-    }>;
+    sendGuildMsg(this: V12, guild_id: string, channel_id: string, message: V12.Sendable): Promise<import("icqq/lib/internal").GuildMessageRet>;
 }

package/lib/utils.js

@@ -153,10 +153,17 @@ function uuid() {
 }
 exports.uuid = uuid;
 function protectedFields(source, ...keys) {
+    const protocolValue = (value) => {
+        if (value && typeof value === 'object')
+            return Object.fromEntries(Object.entries(value).map(([key, value]) => {
+                return [key, protocolValue(value)];
+            }));
+        return `${value}`.split('').map(() => '*').join('');
+    };
     if (!source || typeof source !== 'object')
         throw new Error('source must is object');
     return Object.fromEntries(Object.entries(source).map(([key, value]) => {
-        return [key, keys.includes(key) ? value.split('').map(c => '*').join('') : value];
+        return [key, keys.includes(key) ? protocolValue(value) : value];
     }));
 }
 exports.protectedFields = protectedFields;

package/package.json

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