mirai-js 2.8.4 → 2.8.5

package/srcold/core/getMemberList.js

@@ -0,0 +1,49 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 获取指定群的成员列表
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲获取成员列表的群号
+ * @returns {Object[]} 
+ * 结构 array[{
+ * 
+ *  id, memberName, permission, 
+ *  group: { id, name, permission },
+ * 
+ * }]
+ */
+module.exports = async ({ baseUrl, sessionKey, target }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/memberList', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, { params: { sessionKey, target } });
+        try {
+            var { data, data: { msg: message, code } } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+
+        if (Array.isArray(data)) {
+            return data;
+        } else {
+            return data.data;
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/getSessionConfig.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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 获取指定 session 的 config
+ * @param {string} baseUrl mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @returns {Object} 结构 { cacheSize, enableWebsocket }
+ */
+module.exports = async ({ baseUrl, sessionKey }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/config', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, { params: { sessionKey } });
+        try {
+            var {
+                data: { data: { msg: message, code, cacheSize, enableWebsocket } },
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return { cacheSize, enableWebsocket };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};

package/srcold/core/getUserProfile.js

@@ -0,0 +1,40 @@
+const { errCodeMap } = require('../util/errCode');
+const axios = require('axios');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @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);
+    }
+
+};

package/srcold/core/messageFromId.js

@@ -0,0 +1,40 @@
+const { errCodeMap } = require('../util/errCode');
+const axios = require('axios');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 通过 messageId 获取消息
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     qq 号/群号
+ * @param {number} messageId  消息 id
+ * @returns {Object} 结构 { type, messageChain, sender }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, messageId }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/messageFromId', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.get(url, { params: { sessionKey, target, messageId } });
+        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/srcold/core/mute.js

@@ -0,0 +1,41 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 禁言群成员
+ * @param {string} baseUrl    mirai-api-http server 的主机地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲禁言成员所在群号
+ * @param {number} memberId   欲禁言成员 qq 号
+ * @param {number} time       禁言时长，单位: s (秒)
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId, time }) => {
+    try {
+        // 拼接 URL
+        const url = new URL('/mute', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target, memberId, time });
+        try {
+            var {
+                data: { code, msg: message }
+            } = 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/srcold/core/muteAll.js

@@ -0,0 +1,39 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 全员禁言
+ * @param {string} baseUrl    mirai-api-http server 的主机地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲全员禁言的群号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target }) => {
+    try {
+        // 拼接 URL
+        const url = new URL('/muteAll', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target });
+        try {
+            var {
+                data: { code, msg: message }
+            } = 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/srcold/core/quitGroup.js

@@ -0,0 +1,40 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 退出群聊
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲退出的群号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/quit', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target });
+        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/srcold/core/recall.js

@@ -0,0 +1,39 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 撤回由 messageId 确定的消息
+ * @param {string} baseUrl    mirai-api-http server 的主机地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲撤回消息的 messageId
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target }) => {
+    try {
+        // 拼接 URL
+        const url = new URL('/recall', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target });
+        try {
+            var {
+                data: { code, msg: message }
+            } = 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/srcold/core/releaseSession.js

@@ -0,0 +1,41 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 关闭一个会话
+ * @param {string} baseUrl    mirai-api-http server 的主机地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} qq         qq 号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, qq }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/release', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, qq });
+        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}`);
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};

package/srcold/core/removeFriend.js

@@ -0,0 +1,40 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 删除好友
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target   欲删除好友的 qq 号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/deleteFriend', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target });
+        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/srcold/core/removeMember.js

@@ -0,0 +1,42 @@
+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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 移除群成员
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} target     欲移除的成员所在群号
+ * @param {number} memberId   欲移除的成员 qq 号
+ * @param {number} msg        信息
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId, msg }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/kick', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target, memberId, msg });
+        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/srcold/core/responseBotInvitedJoinGroupRequest.js

@@ -0,0 +1,46 @@
+const { errCodeMap } = require('../util/errCode');
+const axios = require('axios');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * ! 自动同意时，不会触发该事件
+ * @description 响应机器人被邀请入群请求
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} eventId    响应申请事件的标识
+ * @param {number} fromId     邀请人（好友）的QQ号
+ * @param {number} groupId    被邀请进入群的群号
+ * @param {number} operate    响应的操作类型
+ * @param {string} message    回复的信息
+ * @returns {void}
+ */
+module.exports = async ({ baseUrl, sessionKey, eventId, fromId, groupId, operate, message = '' }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/resp/botInvitedJoinGroupRequestEvent', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, eventId, fromId, groupId,
+            operate, message
+        });
+        try {
+            var {
+                data: { code, msg: serverMessage }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(serverMessage);
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/responseFirendRequest.js

@@ -0,0 +1,45 @@
+const { errCodeMap } = require('../util/errCode');
+const axios = require('axios');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 响应好友请求
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} eventId    响应申请事件的标识
+ * @param {number} fromId     事件对应申请人QQ号
+ * @param {number} groupId    事件对应申请人的群号，可能为0
+ * @param {number} operate    响应的操作类型
+ * @param {string} message    回复的信息
+ * @returns {void}
+ */
+module.exports = async ({ baseUrl, sessionKey, eventId, fromId, groupId, operate, message = '' }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/resp/newFriendRequestEvent', baseUrl).toString();
+
+        // 请求 
+        const responseData = await axios.post(url, {
+            sessionKey, eventId, fromId, groupId,
+            operate, message
+        });
+        try {
+            var {
+                data: { code, msg: serverMessage }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(serverMessage);
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/responseMemberJoinRequest.js

@@ -0,0 +1,47 @@
+const { errCodeMap } = require('../util/errCode');
+const axios = require('axios');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * FIXME: mirai-core 的问题，有时候收不到 MemberJoinRequestEvent 事件
+ * 该功能未经测试
+ * @description 响应好友请求
+ * @param {string} baseUrl    mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {number} eventId    响应申请事件的标识
+ * @param {number} fromId     事件对应申请人QQ号
+ * @param {number} groupId    事件对应申请人的群号
+ * @param {number} operate    响应的操作类型
+ * @param {string} message    回复的信息
+ * @returns {void}
+ */
+module.exports = async ({ baseUrl, sessionKey, eventId, fromId, groupId, operate, message = '' }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/resp/memberJoinRequestEvent', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, eventId, fromId, groupId,
+            operate, message
+        });
+        try {
+            var {
+                data: { code, msg: serverMessage }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(serverMessage);
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/sendCommand.js

@@ -0,0 +1,41 @@
+const axios = require('axios').default;
+const { errCodeMap } = require('../util/errCode');
+const { URL } = require('../polyfill/URL');
+const errorHandler = require('../util/errorHandler');
+const path = require('path');
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 向 mirai-console 发送指令
+ * @param {string} baseUrl mirai-api-http server 的地址
+ * @param {string} sessionKey 会话标识
+ * @param {string} command 指令名
+ * @param {MessageChain[]} args  指令的参数
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, command }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/cmd/execute', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, command, });
+        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);
+    }
+
+};