onebots 0.0.14 → 0.0.16

package/README.md

@@ -18,35 +18,56 @@
 </div>
 
 # 使用示例
-1. 新建一个node项目
+## 全局安装
+### 1 安装依赖
+```shell
+npm install -g onebots
+```
+### 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项目中启动
+## 1 初始化node项目
 ```shell
 npm init -y
 ```
-2. 安装onebots
+## 2. 安装onebots
 ```shell
 npm install onebots
 ```
-3. 在项目跟目录添加配置文件config.yaml
+## 3. 在项目跟目录添加配置文件config.yaml
 ```yaml
 port: 6727 # 项目onebots监听的端口(默认：6727)
 1472258369: # 你的机器人账户
   version: V11 # oneBot版本（V11 或 V12）
 ```
-4. 新建入口文件`index.js`并输入一下内容
+## 4. 新建入口文件`index.js`并输入一下内容
 ```javascript
 const {createApp}=require('onebots')
-createApp()
+createApp('config.yaml')
 .start()
 ```
-5. 启动项目
+## 5. 启动项目
 ```shell
 node ./index.js
 ```
-# 使用命令行启动
-```shell
-npm install -g onebots
-onebots
-```
 # 使用接口管理oneBot
 
 | url     | method | params          | desc                           |

package/lib/bin.js

@@ -2,4 +2,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const app_1 = require("./server/app");
-(0, app_1.createApp)().start();
+const execArgv = process.argv.splice(2);
+const obj = {};
+for (let i = 0; i < execArgv.length; i += 2) {
+    obj[execArgv[i]] = execArgv[i + 1];
+}
+console.log(obj);
+(0, app_1.createApp)(obj['-c']).start();

package/lib/onebot.js

@@ -51,6 +51,53 @@ class OneBot extends events_1.EventEmitter {
     }
     async start() {
         this.startListen();
+        const disposeArr = [];
+        const clean = () => {
+            while (disposeArr.length) {
+                disposeArr.shift()();
+            }
+        };
+        this.client.on('system.login.qrcode', function qrcodeHelper() {
+            console.log('扫码后回车继续');
+            process.stdin.once('data', () => {
+                this.login();
+            });
+            disposeArr.push(() => {
+                this.off('system.login.qrcode', qrcodeHelper);
+            });
+        });
+        this.client.on('system.login.device', function deviceHelper() {
+            console.log('请输入密保手机接收的验证码');
+            this.sendSmsCode();
+            process.stdin.once('data', (e) => {
+                this.submitSmsCode(e.toString().trim());
+            });
+            disposeArr.push(() => {
+                this.off('system.login.device', deviceHelper);
+            });
+        });
+        this.client.on('system.login.error', function errorHandler(e) {
+            if (e.message.includes('密码错误')) {
+                process.stdin.once('data', (e) => {
+                    this.login(e.toString().trim());
+                });
+            }
+            else {
+                process.exit();
+            }
+            this.off('system.login.error', errorHandler);
+        });
+        this.client.on('system.login.slider', function sliderHelper(e) {
+            console.log('滑块验证地址：' + e.url);
+            console.log('请输入滑块验证返回的ticket');
+            process.stdin.once('data', (e) => {
+                this.submitSlider(e.toString().trim());
+            });
+            disposeArr.push(() => {
+                this.off('system.login.slider', sliderHelper);
+            });
+        });
+        this.client.on('system.online', clean);
         await this.client.login(this.password);
     }
     startListen() {

package/lib/server/app.js

@@ -32,7 +32,6 @@ const koa_1 = __importDefault(require("koa"));
 const os = __importStar(require("os"));
 const fs_1 = require("fs");
 const log4js_1 = require("log4js");
-const path_1 = require("path");
 const http_1 = require("http");
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const koa_bodyparser_1 = __importDefault(require("koa-bodyparser"));
@@ -43,6 +42,7 @@ const router_1 = require("./router");
 const fs_2 = require("fs");
 const V11_1 = require("../service/V11");
 const V12_1 = require("../service/V12");
+const path = __importStar(require("path"));
 class App extends koa_1.default {
     constructor(config = {}) {
         super(config);
@@ -135,11 +135,11 @@ class App extends koa_1.default {
         });
         this.router.get('/qrcode', (ctx) => {
             const { uin } = ctx.query;
-            const uinUrl = (0, path_1.join)(App.configDir, 'data', uin);
+            const uinUrl = path.join(App.configDir, 'data', uin);
             if (!(0, fs_1.existsSync)(uinUrl)) {
                 return ctx.res.writeHead(400).end('未登录');
             }
-            const qrcodePath = (0, path_1.join)(App.configDir, 'data', uin, 'qrcode.png');
+            const qrcodePath = path.join(App.configDir, 'data', uin, 'qrcode.png');
             let file = null;
             try {
                 file = (0, fs_2.readFileSync)(qrcodePath); //读取文件
@@ -161,7 +161,7 @@ class App extends koa_1.default {
             };
         });
         this.router.post('/add', (ctx, next) => {
-            const { uin, ...config } = ctx.request.body;
+            const { uin, ...config } = (ctx.request.body || {});
             try {
                 this.addAccount(uin, config);
                 ctx.body = `添加成功`;
@@ -171,7 +171,7 @@ class App extends koa_1.default {
             }
         });
         this.router.post('/edit', (ctx, next) => {
-            const { uin, ...config } = ctx.request.body;
+            const { uin, ...config } = (ctx.request.body || {});
             try {
                 this.updateAccount(Number(uin), config);
                 ctx.body = `修改成功`;
@@ -196,16 +196,19 @@ class App extends koa_1.default {
 }
 exports.App = App;
 _a = App;
-App.configDir = (0, path_1.join)(os.homedir(), '.onebots');
-App.configPath = (0, path_1.join)(_a.configDir, 'config.yaml');
+App.configDir = path.join(os.homedir(), '.onebots');
+App.configPath = path.join(_a.configDir, 'config.yaml');
 function createApp(config = 'config.yaml') {
     if (typeof config === 'string') {
+        config = path.resolve(process.cwd(), config);
+        App.configDir = path.dirname(config);
+        App.configPath = config;
         if (!(0, fs_1.existsSync)(App.configDir)) {
             (0, fs_1.mkdirSync)(App.configDir);
         }
-        App.configPath = (0, path_1.join)(App.configDir, config);
+        App.configPath = path.resolve(App.configDir, config);
         if (!(0, fs_1.existsSync)(App.configPath)) {
-            (0, fs_1.copyFileSync)((0, path_1.resolve)(__dirname, '../config.sample.yaml'), App.configPath);
+            (0, fs_1.copyFileSync)(path.resolve(__dirname, '../config.sample.yaml'), App.configPath);
             console.log('未找到对应配置文件，已自动生成默认配置文件，请修改配置文件后重新启动');
             console.log(`配置文件在:  ${App.configPath}`);
             process.exit();

package/lib/service/V11/index.js

@@ -229,7 +229,7 @@ class V11 extends events_1.EventEmitter {
         }
         else if (ctx.method === "POST") {
             try {
-                const params = { ...ctx.query, ...ctx.request.body };
+                const params = { ...(ctx.request.query || {}), ...(ctx.request.body || {}) };
                 const ret = await this.apply({ action, params });
                 ctx.res.writeHead(200).end(ret);
             }

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

@@ -11,10 +11,14 @@ export declare class CommonAction {
     getSelfInfo(this: V12): {
         user_id: number;
         nickname: string;
+        user_displayname: string;
     };
     getStatus(this: V12): {
-        online: OnlineStatus;
         good: boolean;
+        bots: {
+            self: any;
+            online: OnlineStatus;
+        }[];
     };
     getLatestEvents(this: V12, limit?: number, timout?: number): Promise<V12.Payload<keyof Action>[]>;
     getVersion(this: V12): {

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

@@ -16,13 +16,19 @@ class CommonAction {
     getSelfInfo() {
         return {
             user_id: this.client.uin,
-            nickname: this.client.nickname
+            nickname: this.client.nickname,
+            user_displayname: ''
         };
     }
     getStatus() {
         return {
-            online: this.client.status = oicq_1.OnlineStatus.Online,
-            good: this.oneBot.status === onebot_1.OneBotStatus.Good
+            good: this.oneBot.status === onebot_1.OneBotStatus.Good,
+            bots: [
+                {
+                    self: this.action.getSelfInfo.apply(this),
+                    online: this.client.status = oicq_1.OnlineStatus.Online,
+                }
+            ]
         };
     }
     getLatestEvents(limit = 0, timout = 0) {
@@ -37,7 +43,7 @@ class CommonAction {
         return {
             impl: 'onebots',
             platform: 'qq',
-            version: '0.0.5',
+            version: '0.0.15',
             onebot_version: '12'
         };
     }

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

@@ -29,7 +29,7 @@ export declare class V12 extends EventEmitter implements OneBot.Base {
     private startWs;
     private startWsReverse;
     stop(force?: boolean): Promise<void>;
-    dispatch<T extends Record<string, any>>(data?: T): void;
+    dispatch(data: Record<string, any>): void;
     apply(req: any): Promise<string>;
     private _httpRequestHandler;
     /**
@@ -68,7 +68,7 @@ export declare namespace V12 {
         url: string;
     }
     interface Result<T extends any> {
-        status: 'success' | 'failed';
+        status: 'ok' | 'failed';
         retcode: 0 | 10001 | 10002 | 10003 | 10004 | 10005 | 10006 | 10007;
         data: T;
         message: string;
@@ -78,8 +78,12 @@ export declare namespace V12 {
     type Payload<T extends any> = {
         id: string;
         impl: 'oicq_onebot';
+        version: 12;
         platform: 'qq';
-        self_id: `${number}`;
+        self: {
+            platform: 'qq';
+            user_id: `${number}`;
+        };
         time: number;
         type: 'meta' | 'message' | 'notice' | 'request';
         detail_type: string;
@@ -90,13 +94,28 @@ export declare namespace V12 {
         params: any;
         echo?: string;
     }
+    type MetaEventMap = {
+        connect: {
+            detail_type: 'connect';
+            version: ReturnType<Action['getVersion']>;
+        };
+        heartbeat: {
+            detail_type: 'heartbeat';
+            interval: number;
+        };
+        status_update: {
+            detail_type: 'status_update';
+            status: ReturnType<Action['getStatus']>;
+        };
+    };
     function success<T extends any>(data: T, retcode?: Result<T>['retcode'], echo?: string): Result<T>;
     function error(message: string, retcode?: Result<null>['retcode'], echo?: string): Result<null>;
-    function genMetaEvent(uin: number, type: string): {
+    function genMetaEvent<K extends keyof MetaEventMap>(uin: number, type: K, data: Omit<MetaEventMap[K], K>): {
         self_id: number;
         time: number;
         type: string;
-        detail_type: string;
+        status: string;
+        detail_type: K;
         sub_type: string;
-    };
+    } & Omit<MetaEventMap[K], K>;
 }

package/lib/service/V12/index.js

@@ -88,14 +88,10 @@ class V12 extends events_1.EventEmitter {
         });
         if (this.config.heartbeat) {
             this.heartbeat = setInterval(() => {
-                this.dispatch({
-                    self_id: this.client.uin,
-                    time: Math.floor(Date.now() / 1000),
-                    type: "meta",
+                this.dispatch(V12.genMetaEvent(this.client.uin, 'heartbeat', {
                     detail_type: "heartbeat",
-                    interval: this.config.heartbeat * 1000,
-                    status: this.action.getStatus.apply(this)
-                });
+                    interval: new Date().getTime() + this.config.heartbeat * 1000
+                }));
             }, this.config.heartbeat * 1000);
         }
     }
@@ -207,41 +203,38 @@ class V12 extends events_1.EventEmitter {
             (0, fs_1.rmSync)(this.client.dir, { force: true, recursive: true });
         }
     }
-    dispatch(data = {}) {
-        if (!data)
-            data = {};
-        if (!data.post_type) {
-            // @ts-ignore
-            data.sub_type = 'online';
-            if (data.image) {
-                // @ts-ignore
-                data.system_type = 'login';
-                // @ts-ignore
-                data.sub_type = 'qrcode';
+    dispatch(data) {
+        if (!data || typeof data !== "object")
+            data = { args: data || [] };
+        if (!data['post_type']) {
+            data['sub_type'] = 'online';
+            if (data['image']) {
+                data['system_type'] = 'login';
+                data['sub_type'] = 'qrcode';
             }
-            else if (data.url) {
-                // @ts-ignore
-                data.system_type = 'login';
-                // @ts-ignore
+            else if (data['url']) {
+                data['system_type'] = 'login';
                 data.sub_type = 'slider';
                 if (data.phone) {
-                    // @ts-ignore
                     data.sub_type = 'device';
                 }
             }
             else if (data.message) {
-                // @ts-ignore
                 data.system_type = 'login';
-                // @ts-ignore
                 data.sub_type = 'error';
             }
         }
         const payload = {
             id: (0, utils_1.uuid)(),
             impl: 'oicq_onebot',
+            version: 12,
             platform: 'qq',
-            self_id: `${this.client.uin}`,
+            self: {
+                platform: 'qq',
+                user_id: `${this.client.uin}`
+            },
             type: data.post_type || 'meta',
+            alt_message: data.raw_message,
             detail_type: data.message_type || data.notice_type || data.request_type || data.system_type,
             ...data,
         };
@@ -368,7 +361,7 @@ class V12 extends events_1.EventEmitter {
         }
         else if (ctx.method === "POST") {
             try {
-                const params = { ...ctx.query, ...ctx.request.body };
+                const params = { ...(ctx.request.query || {}), ...(ctx.request.body || {}) };
                 const ret = await this.apply({ action, params });
                 ctx.res.writeHead(200).end(ret);
             }
@@ -414,7 +407,8 @@ class V12 extends events_1.EventEmitter {
         const headers = {
             "X-Self-ID": String(this.client.uin),
             "X-Client-Role": "Universal",
-            "User-Agent": "OneBot",
+            "User-Agent": "OneBot/12 (qq) node-Onebots/0.0.15",
+            "Sec-WebSocket-Protocol": "12.onebots.v0.0.15"
         };
         if (config.access_token)
             headers.Authorization = "Bearer " + config.access_token;
@@ -435,7 +429,7 @@ class V12 extends events_1.EventEmitter {
             setTimeout(() => {
                 if (timestmap < this.timestamp)
                     return;
-                this._createWsr(url, config);
+                this.startWsReverse(config);
             }, this.config.reconnect_interval * 1000);
         });
         return ws;
@@ -455,7 +449,7 @@ class V12 extends events_1.EventEmitter {
                     this._quickOperate(event, res);
                     ret = JSON.stringify({
                         retcode: 0,
-                        status: "success",
+                        status: "ok",
                         data: null,
                         message: null,
                         echo: data.echo
@@ -487,8 +481,8 @@ class V12 extends events_1.EventEmitter {
                 }));
             }
         });
-        this.dispatch(V12.genMetaEvent(this.client.uin, "connect"));
-        this.dispatch(V12.genMetaEvent(this.client.uin, "enable"));
+        this.dispatch(V12.genMetaEvent(this.client.uin, "connect", this.action.getVersion.apply(this)));
+        this.dispatch(V12.genMetaEvent(this.client.uin, "status_update", this.action.getStatus.apply(this)));
     }
 }
 exports.V12 = V12;
@@ -507,7 +501,7 @@ exports.V12 = V12;
     function success(data, retcode = 0, echo) {
         return {
             retcode,
-            status: retcode === 0 ? 'success' : 'failed',
+            status: retcode === 0 ? 'ok' : 'failed',
             data,
             message: '',
             echo
@@ -524,13 +518,15 @@ exports.V12 = V12;
         };
     }
     V12.error = error;
-    function genMetaEvent(uin, type) {
+    function genMetaEvent(uin, type, data) {
         return {
             self_id: uin,
             time: Math.floor(Date.now() / 1000),
             type: "meta",
-            detail_type: "lifecycle",
-            sub_type: type,
+            status: 'ok',
+            detail_type: type,
+            sub_type: '',
+            ...data
         };
     }
     V12.genMetaEvent = genMetaEvent;

package/lib/utils.d.ts

@@ -1,6 +1,6 @@
 export declare function deepMerge<T extends any>(base: T, ...from: T[]): T;
 export declare function deepClone<T extends any>(obj: T): T;
-export declare function pick<T, K extends keyof T>(source: T, keys?: Iterable<K>, forced?: boolean): Pick<T, K>;
+export declare function pick<T extends object, K extends keyof T>(source: T, keys?: Iterable<K>, forced?: boolean): Pick<T, K>;
 export declare function omit<T, K extends keyof T>(source: T, keys?: Iterable<K>): Omit<T, K>;
 export interface Class {
     new (...args: any[]): any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebots",
-  "version": "0.0.14",
+  "version": "0.0.16",
   "description": "基于oicq的多例oneBot实现",
   "main": "lib/index.js",
   "bin": {
@@ -9,7 +9,7 @@
   "scripts": {
     "start": "node .",
     "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
-    "dev": "ts-node-dev -r tsconfig-paths/register ./src/test.ts",
+    "dev": "ts-node-dev -r tsconfig-paths/register ./src/bin.ts -c config.yaml",
     "pub": "npm publish --access public",
     "test": "echo \"Error: no test specified\" && exit 1"
   },