mirai-js 2.3.0 → 2.4.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
@@ -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 设置群成员信息
@@ -185,6 +191,28 @@ export class Bot implements BotConfigGetable {
      */
     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 禁言群成员
      * @param group 必选，欲禁言成员所在群号
@@ -370,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;
     }
 
@@ -379,6 +417,19 @@ 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;
@@ -387,6 +438,30 @@ declare namespace Bot {
         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 {
         group: number;
         qq: number;

package/src/Bot.js

@@ -15,8 +15,12 @@ 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');
@@ -28,8 +32,7 @@ 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);
@@ -693,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 }) {
         // 检查对象状态
@@ -721,6 +724,26 @@ 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 必选，群成员所在群号
@@ -767,6 +790,87 @@ class Bot extends BotConfigGetable {
         }
     }
 
+    /**
+     * @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;
+        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 });
+    }
+
     /**
      * @description 禁言群成员
      * @param {number} group 必选，欲禁言成员所在群号

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);
+    }
+
+};

package/src/core/anno/getAnno.js

@@ -0,0 +1,43 @@
+const { errCodeMap } = require('../../util/errCode');
+const axios = require('axios').default;
+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 {number}  offset     分页
+ * @param {number}  size       分页, 默认 10
+ * @returns {Object[]}
+ */
+module.exports = async ({ baseUrl, sessionKey, id, offset, size = 10 }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/anno/list', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, {
+            params: {
+                sessionKey, id, 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);
+    }
+};

package/src/core/anno/publishAnno.js

@@ -0,0 +1,43 @@
+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}  target     群号
+ * @param {string}  content    公告内容
+ * @param {boolean} pinned     是否置顶
+ * @returns {Object} { code, msg }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, content, pinned }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/anno/publish', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, content, pinned
+        });
+        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/auth.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/deleteGroupFile.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/getGroupFileInfo.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/getGroupFileList.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/makeGroupDir.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/moveGroupFile.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/renameGroupFile.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/fs/uploadGroupFIle.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../../polyfill/URL');
 const errorHandler = require('../../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getFriendList.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getGroupConfig.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getGroupList.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getMemberInfo.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
@@ -16,7 +11,7 @@ const locationStr = `core.${path.basename(__filename, path.extname(__filename))}
  * @param {string} sessionKey 会话标识
  * @param {number} target     群成员所在群号
  * @param {number} memberId   群成员的 qq 号
- * @returns {Object} 结构 { name, specialTitle } 群名片和群头衔
+ * @returns {Object}
  */
 module.exports = async ({ baseUrl, sessionKey, target, memberId }) => {
     try {
@@ -27,7 +22,7 @@ module.exports = async ({ baseUrl, sessionKey, target, memberId }) => {
         const responseData = await axios.get(url, { params: { sessionKey, target, memberId } });
         try {
             var {
-                data: { msg: message, code, name, specialTitle }
+                data, data: { msg: message, code }
             } = responseData;
         } catch (error) {
             throw new Error(('请求返回格式出错，请检查 mirai-console'));
@@ -36,7 +31,7 @@ module.exports = async ({ baseUrl, sessionKey, target, memberId }) => {
         if (code in errCodeMap) {
             throw new Error(message);
         }
-        return { name, specialTitle };
+        return data;
     } catch (error) {
         console.error(`mirai-js: error ${locationStr}`);
         errorHandler(error);

package/src/core/getMemberList.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios').default;
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getSessionConfig.js

@@ -1,11 +1,6 @@
 const { errCodeMap } = require('../util/errCode');
 const axios = require('axios');
-let URL;
-if (!process.browser) {
-    ({ URL } = require('url'));
-} else {
-    URL = window.URL;
-}
+const { URL } = require('../polyfill/URL');
 const errorHandler = require('../util/errorHandler');
 const path = require('path');
 const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;

package/src/core/getUserProfile.js

@@ -0,0 +1,39 @@
+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} target     qq 号
+ * @returns {Object} 结构 { nickname, email, age, level, sign, sex }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/userProfile', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, { params: { sessionKey, target, memberId } });
+        try {
+            var {
+                data: { msg: message, code, nickname, email, age, level, sign, sex }
+            } = responseData;
+        } catch (error) {
+            throw new Error('请求返回格式出错，请检查 mirai-console');
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return { nickname, email, age, level, sign, sex };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};