mirai-js 2.1.0 → 2.4.0

package/package.json

@@ -1,52 +1,52 @@
-{
-    "name": "mirai-js",
-    "version": "2.1.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",
-        "prepare": "husky install"
-    },
-    "lint-staged": {
-        "*.js": "eslint --fix",
-        "*.ts": "eslint --fix"
-    },
-    "keywords": [
-        "mirai",
-        "api",
-        "http",
-        "robot"
-    ],
-    "author": {
-        "email": "devgaolihai@foxmail.com",
-        "name": "gaolihai",
-        "url": "https://gaolihai.cool/note/"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Drincann/Mirai-js"
-    },
-    "homepage": "https://drincann.github.io/Mirai-js/",
-    "license": "AGPL-3.0",
-    "dependencies": {
-        "axios": "^0.21.1",
-        "form-data": "^3.0.0",
-        "ws": "^7.4.2"
-    },
-    "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",
-        "husky": "^6.0.0",
-        "lint-staged": "^10.5.4",
-        "path-browserify": "^1.0.1",
-        "process": "^0.11.10",
-        "typescript": "^4.2.2",
-        "webpack": "^5.30.0",
-        "webpack-cli": "^4.6.0"
-    }
+{
+    "name": "mirai-js",
+    "version": "2.4.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",
+        "prepare": "husky install"
+    },
+    "lint-staged": {
+        "*.js": "eslint --fix",
+        "*.ts": "eslint --fix"
+    },
+    "keywords": [
+        "mirai",
+        "api",
+        "http",
+        "robot"
+    ],
+    "author": {
+        "email": "devgaolihai@foxmail.com",
+        "name": "gaolihai",
+        "url": "https://gaolihai.cool/note/"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/Drincann/Mirai-js"
+    },
+    "homepage": "https://drincann.github.io/Mirai-js/",
+    "license": "AGPL-3.0",
+    "dependencies": {
+        "axios": "^0.24.0",
+        "form-data": "^3.0.0",
+        "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": "^5.4.0",
+        "@typescript-eslint/parser": "^5.5.0",
+        "eslint": "^8.2.0",
+        "husky": "^6.0.0",
+        "lint-staged": "^12.0.2",
+        "path-browserify": "^1.0.1",
+        "process": "^0.11.10",
+        "typescript": "^4.2.2",
+        "webpack": "^5.30.0",
+        "webpack-cli": "^4.6.0"
+    }
 }

package/src/BaseType.d.ts

@@ -98,6 +98,9 @@ type GroupPermission =
     | 'ADMINISTRATOR'
     | 'MEMBER';
 
+// 性别
+type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE'
+
 // 消息处理器
 type Processor = (data: any) => Promise<any> | any;
 

package/src/Bot.d.ts

@@ -2,8 +2,8 @@ import {
     // 图片 id  语音 id  消息 id
     ImageId, VoiceId, MessageId,
 
-    // 事件类型    群成员权限
-    EventType, GroupPermission,
+    // 事件类型    群成员权限      性别
+    EventType, GroupPermission, SEX,
 
     // 接口               原始消息类型  事件处理器类型
     MessageChainGetable, BotConfigGetable, MessageType, Processor
@@ -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>;
 
@@ -173,7 +173,13 @@ export class Bot implements BotConfigGetable {
      * @param group 必选，群成员所在群号
      * @param qq    必选，群成员的 qq 号
      */
-    getMemberInfo(): Promise<Bot.MemberDetails>;
+    getMemberInfo({ group, qq }: Bot.GetMemberInfoOptions): Promise<Bot.MemberDetails>;
+
+    /**
+     * @description 获取群成员信息
+     * @param qq    必选，用户的 qq 号
+     */
+    getUserProfile({ qq }: Bot.GetUserProfileOptions): Promise<Bot.UserProfile>;
 
     /**
      * @description 设置群成员信息
@@ -181,8 +187,31 @@ 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 获取群公告列表迭代器
+     * @param group 必选，群号
+     * @returns 迭代器
+     */
+    getAnnoIter({ group }: Bot.GetAnnoIterOptions): AsyncGenerator<Bot.AnnoInfo>;
+
+    /**
+     * @description 发布群公告
+     * @param group 必选，群号
+     * @param content 必选，公告内容
+     */
+    async publishAnno({ group, content, pinned }: Bot.PublishAnnoOptions): Promise<void>;
+
+    /**
+     * @description 删除群公告
+     * @param {number} group 必选，群号
+     * @param {string} fid 必选，公告 id
+     * @reaturns {void}
+     */
+    async deleteAnno({ group, fid }: Bot.DeleteAnnoOptions): Promise<void>;
 
     /**
      * @description 禁言群成员
@@ -219,6 +248,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   必选，欲移除的成员所在群号
@@ -363,8 +398,18 @@ declare namespace Bot {
         permission: GroupPermission;
     }
 
+    interface GetMemberInfoOptions {
+        group: number;
+        qq: number;
+    }
+
     interface MemberDetails {
-        name: string;
+        id: number;
+        joinTimestamp: number;
+        lastSpeakTimestamp: number;
+        memberName: string;
+        nuteTimeRemaining: number;
+        permission: GroupPermission;
         title: string;
     }
 
@@ -372,11 +417,49 @@ declare namespace Bot {
         group: number;
     }
 
+    interface GetUserProfileOptions {
+        qq: number;
+    }
+
+    interface UserProfile {
+        nickname: string;
+        email: string;
+        age: number;
+        level: number;
+        sign: string;
+        sex: SEX;
+    }
+
     interface SetMemberInfoOptions {
         group: number;
         qq: number;
         name?: string;
         title?: string;
+        permission?: GroupPermission
+    }
+
+    interface GetAnnoIterOptions {
+        gourp: number;
+    }
+
+    interface PublishAnnoOptions {
+        group: number;
+        content: string;
+        pinned: boolean;
+    }
+
+    interface DeleteAnnoOptions {
+        group: number;
+        fid: string;
+    }
+    interface AnnoInfo {
+        group: { id: number; name: string; permission: GroupPermission; };
+        content: string;
+        senderId: number;
+        fid: string;
+        allConfirmed: boolean;
+        confirmedMembersCount: number;
+        publicationTime: number;
     }
 
     interface MuteOptions {
@@ -404,6 +487,10 @@ declare namespace Bot {
         message?: string;
     }
 
+    interface RemoveFriendOptions {
+        qq: number;
+    }
+
     interface QuitGroupOptions {
         group: number;
     }

package/src/Bot.js

@@ -15,19 +15,24 @@ const _getFriendList = require('./core/getFriendList');
 const _getGroupList = require('./core/getGroupList');
 const _getMemberList = require('./core/getMemberList');
 const _getMemberInfo = require('./core/getMemberInfo');
+const _getUserProfile = require('./core/getUserProfile');
 const _setMemberInfo = require('./core/setMemberInfo');
+const _setMemberAdmin = require('./core/setMemberAdmin');
+const _getAnnoList = require('./core/anno/getAnno');
+const _publishAnno = require('./core/anno/publishAnno');
+const _deleteAnno = require('./core/anno/deleteAnno');
 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');
 const _setEssence = require('./core/setEssence');
-const _startListening = process.browser ? require('./core/startListeningBrowser') : require('./core/startListeningNode');
-const _stopListening = process.browser ? require('./core/stopListeningBrowser') : require('./core/stopListeningNode');
+const { wsStartListening: _startListening, wsStopListening: _stopListening } = require('./polyfill/wsListener');
 
 // 其他
 const random = require('./util/random')(0, 2E16);
@@ -691,7 +696,7 @@ class Bot extends BotConfigGetable {
      * @description 获取群成员信息
      * @param {number} group 必选，群成员所在群号
      * @param {number} qq    必选，群成员的 qq 号
-     * @returns {Object[]} 结构 { name, title } 群名片和群头衔
+     * @returns {Object}
      */
     async getMemberInfo({ group, qq }) {
         // 检查对象状态
@@ -719,15 +724,37 @@ class Bot extends BotConfigGetable {
         return memberInfo;
     }
 
+    /**
+     * @description 获取群成员信息
+     * @param {number} qq    必选，用户的 qq 号
+     * @returns {Object} 结构 { nickname, email, age, level, sign, sex }
+     */
+    async getUserProfile({ qq }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('getUserProfile 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!qq) {
+            throw new Error('getUserProfile 缺少必要的 qq 参数');
+        }
+
+        const { baseUrl, sessionKey } = this.config;
+        return await _getUserProfile({ baseUrl, sessionKey, target: qq });
+    }
+
     /**
      * @description 设置群成员信息
      * @param {number} group 必选，群成员所在群号
      * @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，建立一个会话');
@@ -739,13 +766,109 @@ 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;
+        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,
+            });
+        }
+    }
+
+    /**
+     * @description 获取群公告列表迭代器
+     * @param {number} group 必选，群号
+     * @returns 迭代器
+     */
+    async *getAnnoIter({ group }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('getAnno 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!group) {
+            throw new Error('getAnno 缺少必要的 group 参数');
+        }
 
         // 获取列表
         const { baseUrl, sessionKey } = this.config;
-        await _setMemberInfo({
-            baseUrl, sessionKey, target: group, memberId: qq,
-            name, specialTitle: title,
-        });
+        let offset = 0;
+        let annoList = await _getAnnoList({ baseUrl, sessionKey, id: group, offset, size: 10 });
+        while (annoList.length > 0) {
+            for (const anno of annoList) {
+                yield anno;
+            }
+
+            // 获取下一页
+            offset += 10;
+            annoList = await _getAnnoList({ baseUrl, sessionKey, id: group, offset, size: 10 });
+        }
+
+        return;
+    }
+
+    /**
+     * @description 发布群公告
+     * @param {number} group 必选，群号
+     * @param {string} content 必选，公告内容
+     * @returns {void}
+     */
+    async publishAnno({ group, content, pinned }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('publishAllo 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!group || !content) {
+            throw new Error(`publishAllo 缺少必要的 ${getInvalidParamsString({
+                group, content
+            })} 参数`);
+        }
+
+        // 发布公告
+        const { baseUrl, sessionKey } = this.config;
+        await _publishAnno({ baseUrl, sessionKey, target: group, content, pinned });
+    }
+
+    /**
+     * @description 删除群公告
+     * @param {number} group 必选，群号
+     * @param {string} fid 必选，公告 id
+     * @reaturns {void}
+     */
+    async deleteAnno({ group, fid }) {
+        // 检查对象状态
+        if (!this.config) {
+            throw new Error('deleteAnno 请先调用 open，建立一个会话');
+        }
+
+        // 检查参数
+        if (!group || !fid) {
+            throw new Error(`deleteAnno 缺少必要的 ${getInvalidParamsString({
+                group, fid
+            })} 参数`);
+        }
+
+        // 发布公告
+        const { baseUrl, sessionKey } = this.config;
+        await _deleteAnno({ baseUrl, sessionKey, id: group, fid });
     }
 
     /**
@@ -858,13 +981,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，建立一个会话');
         }

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

@@ -534,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/anno/deleteAnno.js

@@ -0,0 +1,42 @@
+const { errCodeMap } = require('../../util/errCode');
+const axios = require('axios');
+const { URL } = require('../../polyfill/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 {number}  id     群号
+ * @param {string}  fid    公告 id
+ * @returns {Object} { code, msg }
+ */
+module.exports = async ({ baseUrl, sessionKey, id, fid }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/anno/delete', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, id, fid,
+        });
+        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);
+    }
+
+};