mirai-js 2.0.2 → 2.3.0

package/dist/node/core/verify.js

@@ -17,6 +17,10 @@ if (!process.browser) {
 }
 
 const errorHandler = require('../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
 /**
  * @description 校验 sessionKey，将一个 session 绑定到指定的 qq 上
  * @param {string}  baseUrl    mirai-api-http server 的地址
@@ -26,7 +30,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {Object} 结构 { message, code }
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -50,7 +53,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.verify 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -63,6 +66,7 @@ module.exports = async ({
       code
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/docs/checkDocShouldBuild.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+echo "🛑 - Build cancelled"
+exit 0;

package/package.json

@@ -1,11 +1,11 @@
 {
     "name": "mirai-js",
-    "version": "2.0.2",
+    "version": "2.3.0",
     "description": "QQ robot development framework based on Mirai-api-http.",
     "main": "dist/node/index.js",
     "scripts": {
         "lint": "eslint --fix .",
-        "build": "webpack &&　babel src --out-dir dist/node --copy-files",
+        "build": "webpack && babel src --out-dir dist/node --copy-files",
         "prepare": "husky install"
     },
     "lint-staged": {
@@ -30,19 +30,19 @@
     "homepage": "https://drincann.github.io/Mirai-js/",
     "license": "AGPL-3.0",
     "dependencies": {
-        "axios": "^0.21.1",
+        "axios": "^0.24.0",
         "form-data": "^3.0.0",
-        "ws": "^7.4.2"
+        "ws": "^8.4.0"
     },
     "devDependencies": {
         "@babel/cli": "^7.13.14",
         "@babel/core": "^7.13.14",
         "@babel/preset-env": "^7.13.12",
-        "@typescript-eslint/eslint-plugin": "^4.15.2",
-        "@typescript-eslint/parser": "^4.15.2",
-        "eslint": "^7.19.0",
+        "@typescript-eslint/eslint-plugin": "^5.4.0",
+        "@typescript-eslint/parser": "^5.5.0",
+        "eslint": "^8.2.0",
         "husky": "^6.0.0",
-        "lint-staged": "^10.5.4",
+        "lint-staged": "^12.0.2",
         "path-browserify": "^1.0.1",
         "process": "^0.11.10",
         "typescript": "^4.2.2",

package/src/Bot.d.ts

@@ -146,9 +146,9 @@ export class Bot implements BotConfigGetable {
 
     /**
      * @description 上传语音至服务器，返回 voiceId, url 及 path
-     * @param {string} type     目前仅支持 "group"，请忽略该参数
-     * @param {Buffer} voice    二选一，语音二进制数据
-     * @param {string} filename 二选一，语音文件路径
+     * @param type     目前仅支持 "group"，请忽略该参数
+     * @param voice    二选一，语音二进制数据
+     * @param filename 二选一，语音文件路径
      */
     uploadVoice({ type, voice, filename }: Bot.UploadVoiceOptions): Promise<Bot.VoiceInfo>;
 
@@ -181,8 +181,9 @@ export class Bot implements BotConfigGetable {
      * @param qq    必选，群成员的 qq 号
      * @param name  可选，要设置的群名片
      * @param title 可选，要设置的群头衔
+     * @param permission 可选，要设置的群头衔
      */
-    setMemberInfo({ group, qq, name, title }: Bot.SetMemberInfoOptions): Promise<void>;
+    setMemberInfo({ group, qq, name, title, permission }: Bot.SetMemberInfoOptions): Promise<void>;
 
     /**
      * @description 禁言群成员
@@ -219,6 +220,12 @@ export class Bot implements BotConfigGetable {
      */
     removeMember({ group, qq, message }: Bot.RemoveMemberOptions): Promise<void>;
 
+    /**
+     * @description 删除好友
+     * @param qq 欲删除的好友 qq 号
+     */
+    removeFriend({ qq }: Bot.RemoveFriendOptions): Promise<void>;
+
     /**
      * @description 移除群成员
      * @param group   必选，欲移除的成员所在群号
@@ -253,6 +260,11 @@ export class Bot implements BotConfigGetable {
      */
     setEssence({ messageId }: Bot.SetEssenceOptions): Promise<void>;
 
+    /**
+     * @description 向 mirai-console 发送指令
+     * @param command 必选，指令名
+     */
+    sendCommand({ command }: Bot.SendCommandOptions): Promise<Bot.MiraiConsoleMessage>;
 
     // 类方法
     /**
@@ -263,17 +275,6 @@ export class Bot implements BotConfigGetable {
      */
     static isBotLoggedIn({ baseUrl, verifyKey, qq }: Bot.IsBotLoggedInOptions): Promise<boolean>;
 
-    /**
-     * @description 向 mirai-console 发送指令
-     * @param baseUrl 必选，mirai-api-http server 的地址
-     * @param verifyKey 必选，mirai-api-http server 设置的 verifyKey
-     * @param command 必选，指令名
-     * @param args    可选，指令的参数
-     */
-    static sendCommand({
-        baseUrl, verifyKey,
-        command, args,
-    }: Bot.SendCommandOptions): Promise<Bot.MiraiConsoleMessage>;
 }
 
 // 类型
@@ -383,6 +384,7 @@ declare namespace Bot {
         qq: number;
         name?: string;
         title?: string;
+        permission?: GroupPermission
     }
 
     interface MuteOptions {
@@ -410,6 +412,10 @@ declare namespace Bot {
         message?: string;
     }
 
+    interface RemoveFriendOptions {
+        qq: number;
+    }
+
     interface QuitGroupOptions {
         group: number;
     }
@@ -442,10 +448,7 @@ declare namespace Bot {
     }
 
     interface SendCommandOptions {
-        baseUrl: string;
-        verifyKey: string;
-        command: string;
-        args: string[];
+        command: string[];
     }
 
     interface IsBotLoggedInOptions {

package/src/Bot.js

@@ -16,12 +16,14 @@ const _getGroupList = require('./core/getGroupList');
 const _getMemberList = require('./core/getMemberList');
 const _getMemberInfo = require('./core/getMemberInfo');
 const _setMemberInfo = require('./core/setMemberInfo');
+const _setMemberAdmin = require('./core/setMemberAdmin');
 const _recall = require('./core/recall');
 const _mute = require('./core/mute');
 const _muteAll = require('./core/muteAll');
 const _unmute = require('./core/unmute');
 const _unmuteAll = require('./core/unmuteAll');
 const _removeMember = require('./core/removeMember');
+const _removeFriend = require('./core/removeFriend');
 const _quitGroup = require('./core/quitGroup');
 const _getGroupConfig = require('./core/getGroupConfig');
 const _setGroupConfig = require('./core/setGroupConfig');
@@ -51,7 +53,6 @@ const { MessageChainGetable, BotConfigGetable } = require('./interface');
 class Bot extends BotConfigGetable {
     constructor() {
         super();
-        // 实例化一个内部类 Waiter
         this.waiter = new Waiter(this);
         this.config = undefined;
         this.eventProcessorMap = {};
@@ -726,9 +727,11 @@ class Bot extends BotConfigGetable {
      * @param {number} qq    必选，群成员的 qq 号
      * @param {string} name  可选，要设置的群名片
      * @param {string} title 可选，要设置的群头衔
+     * @param {boolean} permission 可选，要设置的权限，
+     * 使用枚举值：Bot.Permission.Admin, Bot.Permission.Member
      * @returns {void}
      */
-    async setMemberInfo({ group, qq, name, title }) {
+    async setMemberInfo({ group, qq, name, title, permission }) {
         // 检查对象状态
         if (!this.config) {
             throw new Error('setMemberInfo 请先调用 open，建立一个会话');
@@ -740,13 +743,28 @@ class Bot extends BotConfigGetable {
                 group, qq
             })} 参数`);
         }
+        if (permission != undefined
+            && permission != Bot.groupPermission.ADMINISTRATOR
+            && permission != Bot.groupPermission.MEMBER) {
+            throw new Error('setMemberInfo admin 参数只能是 Bot.groupPermission.ADMINISTRATOR 或 Bot.groupPermission.Member');
+        }
 
-        // 获取列表
+        // setMemberInfo
         const { baseUrl, sessionKey } = this.config;
-        await _setMemberInfo({
-            baseUrl, sessionKey, target: group, memberId: qq,
-            name, specialTitle: title,
-        });
+        if (name != undefined || title != undefined) {
+            await _setMemberInfo({
+                baseUrl, sessionKey, target: group, memberId: qq,
+                name, specialTitle: title,
+            });
+        }
+
+        // setPermission
+        if (permission != undefined) {
+            await _setMemberAdmin({
+                baseUrl, sessionKey, target: group, memberId: qq,
+                assign: permission == Bot.groupPermission.ADMINISTRATOR ? true : false,
+            });
+        }
     }
 
     /**
@@ -859,13 +877,35 @@ class Bot extends BotConfigGetable {
         await _removeMember({ baseUrl, sessionKey, target: group, memberId: qq, msg: message });
     }
 
+    /**
+     * @description 删除好友
+     * @param {*} qq 欲删除的好友 qq 号
+     * @returns {void}
+     */
+    async removeFriend({ qq }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('removeFriend 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!qq) {
+            throw new Error('removeFriend 缺少必要的 qq 参数');
+        }
+
+        const { baseUrl, sessionKey } = this.config;
+
+        // 删除好友
+        await _removeFriend({ baseUrl, sessionKey, target: qq });
+    }
+
     /**
      * @description 移除群成员
      * @param {number} group   必选，欲移除的成员所在群号
      * @returns {void}
      */
     async quitGroup({ group }) {
-        // 检查对象状态
+        // 检查对象状态 
         if (!this.config) {
             throw new Error('quitGroup 请先调用 open，建立一个会话');
         }
@@ -966,6 +1006,35 @@ class Bot extends BotConfigGetable {
         await _setEssence({ baseUrl, sessionKey, target: messageId });
     }
 
+    /**
+     * @description 向 mirai-console 发送指令
+     * @param {string[]}   command 必选，指令和参数
+     * @returns {Object} 结构 { message }，注意查看 message 的内容，已知的问题：
+     * 'Login failed: Mirai 无法完成滑块验证. 使用协议 ANDROID_PHONE 强制要求滑块验证, 
+     * 请更换协议后重试. 另请参阅: https://github.com/project-mirai/mirai-login-solver-selenium'
+     */
+    async sendCommand({ command }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('setEssence 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!command) {
+            throw new Error(`sendCommand 缺少必要的 ${getInvalidParamsString({ command })} 参数`);
+        }
+
+        const { Message } = require('./Message');
+        const { baseUrl, sessionKey } = this.config;
+        return await _sendCommand({
+            baseUrl, sessionKey,
+            command: command
+                .map((v) => v?.toString() ?? '')
+                .reduce((acc, cur) => acc.addText(cur), new Message)
+                .messageChain
+        });
+    }
+
     /**
      * @description 检测该账号是否已经在 mirai-console 登录
      * @param {string} baseUrl 必选，mirai-api-http server 的地址
@@ -990,24 +1059,6 @@ class Bot extends BotConfigGetable {
         }
     }
 
-    /**
-     * @description 向 mirai-console 发送指令
-     * @param {string}   baseUrl 必选，mirai-api-http server 的地址
-     * @param {string}   verifyKey 必选，mirai-api-http server 设置的 verifyKey
-     * @param {string}   command 必选，指令名
-     * @param {string[]} args    可选，指令的参数
-     * @returns {Object} 结构 { message }，注意查看 message 的内容，已知的问题：
-     * 'Login failed: Mirai 无法完成滑块验证. 使用协议 ANDROID_PHONE 强制要求滑块验证, 
-     * 请更换协议后重试. 另请参阅: https://github.com/project-mirai/mirai-login-solver-selenium'
-     */
-    static async sendCommand({ baseUrl, verifyKey, command, args }) {
-        // 检查参数
-        if (!baseUrl || !verifyKey || !command) {
-            throw new Error(`sendCommand 缺少必要的 ${getInvalidParamsString({ baseUrl, verifyKey, command })} 参数`);
-        }
-
-        return await _sendCommand({ baseUrl, verifyKey, command, args });
-    }
 }
 
 

package/src/FileManager.js

@@ -7,27 +7,31 @@ class FileManager {
         const baseUrl = bot.getBaseUrl();
         const sessionKey = bot.sessionKey();
         // core 柯里化，为内部类 File Directory 提供包装的接口
-        this._getGroupFileList = ({ dir }) => require('./core/getGroupFileList')({
+        this._getGroupFileList = ({ dir }) => require('./core/fs/getGroupFileList')({
             baseUrl, sessionKey, target: group, dir
         });
 
-        this._getGroupFileInfo = ({ id }) => require('./core/getGroupFileInfo')({
+        this._getGroupFileInfo = ({ id }) => require('./core/fs/getGroupFileInfo')({
             baseUrl, sessionKey, target: group, id
         });
 
-        this._uploadFileAndSend = ({ type, path, file }) => require('./core/uploadFileAndSend')({
+        this._uploadFileAndSend = ({ type, path, file }) => require('./core/fs/uploadGroupFIle')({
             baseUrl, sessionKey, type, target: group, path, file
         });
 
-        this._groupFileDelete = ({ id }) => require('./core/groupFileDelete')({
+        this._groupFileDelete = ({ id }) => require('./core/fs/deleteGroupFile')({
             baseUrl, sessionKey, target: group, id
         });
 
-        this._groupFileRename = ({ id, rename }) => require('./core/groupFileRename')({
+        this._makeGroupDir = ({ dir }) => require('./core/fs/makeGroupDir')({
+            baseUrl, sessionKey, target: group, dir
+        });
+
+        this._groupFileRename = ({ id, rename }) => require('./core/fs/renameGroupFile')({
             baseUrl, sessionKey, target: group, id, rename
         });
 
-        this._groupFileMove = ({ id, movePath }) => require('./core/groupFileMove')({
+        this._groupFileMove = ({ id, movePath }) => require('./core/fs/moveGroupFile')({
             baseUrl, sessionKey, target: group, id, movePath
         });
 

package/src/Middleware.js

@@ -19,15 +19,11 @@ class Middleware {
      * @param {string} verifyKey  mirai-api-http server 设置的 verifyKey
      * @param {string} password 欲重新登陆的 qq 密码
      */
-    autoReLogin({ baseUrl, verifyKey, password }) {
-        const { Bot } = require('./index.js');
+    autoReLogin({ password }) {
         this.middleware.push(async (data, next) => {
             try {
-                await Bot.sendCommand({
-                    baseUrl,
-                    verifyKey,
-                    command: '/login',
-                    args: [data.qq, password],
+                await data.bot.sendCommand({
+                    command: ['/login', data.qq, password],
                 });
                 await data.bot.open();
                 await next();
@@ -538,10 +534,58 @@ class Middleware {
                 if (data.type != 'GroupMessage' && data.type != 'FriendMessage') {
                     throw new Error('Middleware.syncWrapper 消息格式出错');
                 }
+                const watiForMessageChain = async (qq) => {
+                    qq = qq ?? data?.sender?.id;
+                    if (qq == undefined) {
+                        throw new Error('Middleware.syncWrapper 消息格式出错');
+                    }
+                    do {
+                        var { messageChain, id } = await data.bot?.waiter?.wait(data.type, ({ messageChain, sender: { id } }) => ({ messageChain, id })) ?? {};
+                    } while (qq != id);
+
+                    return messageChain;
+                };
+
+                const waitForText = async (qq) => {
+                    qq = qq ?? data?.sender?.id;
+                    if (qq == undefined) {
+                        throw new Error('Middleware.syncWrapper 消息格式出错');
+                    }
+                    do {
+                        var { text, id } = await data.bot?.waiter?.wait(data.type, new Middleware().textProcessor().done(({ text, sender: { id } }) => ({ text, id }))) ?? {};
+                    } while (qq != id);
+                    return text;
+                };
+
+                const waitForCustom = async (qq, processor) => {
+                    qq = qq ?? data?.sender?.id;
+                    if (qq == undefined) {
+                        throw new Error('Middleware.syncWrapper 消息格式出错');
+                    }
+                    do {
+                        var data = await data.bot?.waiter?.wait(data.type, new Middleware().textProcessor().done((data) => data));
+                    } while (qq != data?.sender?.id);
+                    return await processor(data);
+                };
+
                 data.waitFor = {
-                    messageChain: () => data.bot?.waiter?.wait(data.type, ({ messageChain }) => messageChain),
-                    text: () => data.bot?.waiter?.wait(data.type, new Middleware().textProcessor().done(({ text }) => text)),
-                    custom: (processor) => data.bot?.waiter?.wait(data.type, processor),
+                    groupMember: (qq = undefined) => {
+                        return {
+                            messageChain: () => watiForMessageChain(qq),
+                            text: () => waitForText(qq),
+                            custom: (processor) => waitForCustom(qq, processor),
+                        };
+                    },
+                    friend: (qq) => {
+                        return {
+                            messageChain: () => watiForMessageChain(qq),
+                            text: () => waitForText(qq),
+                            custom: (processor) => waitForCustom(qq, processor),
+                        };
+                    },
+                    messageChain: () => watiForMessageChain(data.sender.id),
+                    text: () => waitForText(data.sender.id),
+                    custom: (processor) => waitForCustom(data.sender.id, processor),
                 };
 
                 await next();

package/src/core/auth.js

@@ -7,6 +7,8 @@ if (!process.browser) {
     URL = window.URL;
 }
 const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
 
 /**
  *
@@ -27,7 +29,7 @@ module.exports = async ({ baseUrl, verifyKey }) => {
                 data: { msg: message, code, session: sessionKey },
             } = responseData;
         } catch (error) {
-            throw new Error('core.auth 请求返回格式出错，请检查 mirai-console');
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
         }
 
         // 抛出 mirai 的异常，到 catch 中处理后再抛出
@@ -36,6 +38,7 @@ module.exports = async ({ baseUrl, verifyKey }) => {
         }
         return sessionKey;
     } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
         errorHandler(error);
     }
 };

package/src/core/fs/deleteGroupFile.js

@@ -0,0 +1,49 @@
+const { errCodeMap } = require('../../util/errCode');
+const axios = require('axios');
+let URL;
+if (!process.browser) {
+    ({ URL } = require('url'));
+} else {
+    URL = window.URL;
+}
+const errorHandler = require('../../util/errorHandler');
+const path = require('path');
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+
+/**
+ * @description 删除群文件
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  id               文件夹id, 空串为根目录
+ * @param {string}  path             文件夹路径, 文件夹允许重名, 不保证准确, 准确定位使用 id
+ * @param {number}  group            群号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, id, path, group }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/file/delete', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, id, path, target: group, group,
+        });
+
+        try {
+            var {
+                data: { msg: message, code }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return { message, code };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};

package/src/core/fs/getGroupFileInfo.js

@@ -0,0 +1,50 @@
+const { errCodeMap } = require('../../util/errCode');
+const axios = require('axios').default;
+let URL;
+if (!process.browser) {
+    ({ URL } = require('url'));
+} else {
+    URL = window.URL;
+}
+const errorHandler = require('../../util/errorHandler');
+const path = require('path');
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+
+/**
+ * @description 获取群文件详细信息
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  id               文件夹id, 空串为根目录
+ * @param {string}  path             文件夹路径, 文件夹允许重名, 不保证准确, 准确定位使用 id
+ * @param {number}  group            群号
+ * @param {boolean} withDownloadInfo 是否携带下载信息，额外请求，无必要不要携带
+ * @returns {Object}   
+ * 结构 { id, name, path, parent, contact, isFile, isDirectory, downloadInfo }
+ */
+module.exports = async ({ baseUrl, sessionKey, id, path, group/*, qq 字段保留 */, withDownloadInfo }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/file/info', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, {
+            params: {
+                sessionKey, id, path, target: group, group, withDownloadInfo
+            }
+        });
+        try {
+            var { data: { msg: message, code, data } } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return data;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/src/core/fs/getGroupFileList.js

@@ -0,0 +1,51 @@
+const { errCodeMap } = require('../../util/errCode');
+const axios = require('axios').default;
+let URL;
+if (!process.browser) {
+    ({ URL } = require('url'));
+} else {
+    URL = window.URL;
+}
+const errorHandler = require('../../util/errorHandler');
+const path = require('path');
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+
+/**
+ * @description 获取群文件列表
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  id               文件夹id, 空串为根目录
+ * @param {string}  path             文件夹路径, 文件夹允许重名, 不保证准确, 准确定位使用 id
+ * @param {number}  group            群号
+ * @param {boolern} withDownloadInfo 是否携带下载信息，额外请求，无必要不要携带
+ * @param {number}  offset	         分页偏移
+ * @param {number}  size	         分页大小
+ * @returns {Object[]}   结构 array[...{ id, name, path, parent, contact, isFile, isDirectory, downloadInfo }]
+ */
+module.exports = async ({ baseUrl, sessionKey, id, path, group/*, qq 字段保留 */, withDownloadInfo, offset, size }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/file/list', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, {
+            params: {
+                sessionKey, id, path, target: group, group, withDownloadInfo, offset, size
+            }
+        });
+        try {
+            var { data: { msg: message, code, data } } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return data;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};