mirai-js 2.8.4 → 2.8.5

package/srcold/core/sendFriendMessage.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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 向 qq 好友发送消息
+ * @param {string}             baseUrl      mirai-api-http server 的地址
+ * @param {string}             sessionKey   会话标识
+ * @param {number}             target       目标好友 qq 号
+ * @param {number}             quote        消息引用，使用发送时返回的 messageId
+ * @param {MessageType[]} messageChain 消息链，MessageType 数组
+ * @returns {Object} 结构 { message, code, messageId }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, quote, messageChain }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/sendFriendMessage', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, quote, messageChain
+        });
+        try {
+            var {
+                data: { msg: message, code, messageId }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return messageId;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/sendGroupMessage.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 { isBrowserEnv } = require('../util/isBrowserEnv');
+const locationStr = !isBrowserEnv() ? `core.${path.basename(__filename, path.extname(__filename))}` : 'borwser';
+
+/**
+ * @description 向 qq 群发送消息
+ * @param {string}             baseUrl      mirai-api-http server 的地址
+ * @param {string}             sessionKey   会话标识
+ * @param {number}             target       目标群号
+ * @param {number}             quote        消息引用，使用发送时返回的 messageId
+ * @param {MessageType[]} messageChain 消息链，MessageType 数组
+ * @returns {Object} 结构 { message, code, messageId }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, quote, messageChain }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/sendGroupMessage', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, quote, messageChain
+        });
+        try {
+            var {
+                data: { msg: message, code, messageId }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return messageId;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/sendImageMessage.js

@@ -0,0 +1,4 @@
+/**
+ * 使用此方法向指定对象（群或好友）发送图片消息 除非需要通过此手段获取imageId，否则不推荐使用该接口
+ * 暂不提供该接口的实现
+ */

package/srcold/core/sendNudge.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 { 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} subject    戳一戳的上下文，群或好友
+ * @param {string} kind       上下文类型, 可选值 Friend, Group
+ * @returns {Object} 结构 { message, code, messageId }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, subject, kind }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/sendNudge', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, subject, kind
+        });
+        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/sendTempMessage.js

@@ -0,0 +1,55 @@
+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 号
+ * @param {number}             group        目标群号
+ * @param {number}             quote        消息引用，使用发送时返回的 messageId
+ * @param {MessageType[]} messageChain 消息链，MessageType 数组
+ * @returns {Object} 结构 { message, code, messageId }
+ */
+module.exports = async ({ baseUrl, sessionKey, qq, group, quote, messageChain }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/sendTempMessage', baseUrl).toString();
+
+        if (!qq || !group) {
+            throw new Error('sendTempMessage 缺少必要的 qq 和 group 参数');
+        }
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey,
+            qq,
+            group,
+            quote,
+            messageChain
+        });
+
+        try {
+            var {
+                data: { msg: message, code, messageId }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return messageId;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};

package/srcold/core/setEssence.js

@@ -0,0 +1,44 @@
+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 {string}  target	   消息 id
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({
+    baseUrl, sessionKey, target
+}) => {
+    try {
+        // 拼接 url
+        const url = new URL('/setEssence', 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/setGroupConfig.js

@@ -0,0 +1,58 @@
+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 {string}  name	          群名
+ * @param {string}  announcement	  群公告
+ * @param {boolean} confessTalk	      是否开启坦白说
+ * @param {boolean} allowMemberInvite 是否允许群员邀请
+ * @param {boolean} autoApprove	      是否开启自动审批入群
+ * @param {boolean} anonymousChat     是否允许匿名聊天
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({
+    baseUrl, sessionKey, target,
+    name, announcement, confessTalk, allowMemberInvite, autoApprove, anonymousChat
+}) => {
+    try {
+        // 拼接 url
+        const url = new URL('/groupConfig', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target,
+            config: {
+                name,
+                announcement,
+                confessTalk,
+                allowMemberInvite,
+                autoApprove,
+                anonymousChat,
+            }
+        });
+        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/setMemberAdmin.js

@@ -0,0 +1,44 @@
+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       群成员所在群号
+ * @param {number} memberId     群成员的 qq 号
+ * @param {string} assign       是否设置为管理员
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId, assign }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/memberAdmin', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, memberId, assign
+        });
+        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/setMemberInfo.js

@@ -0,0 +1,48 @@
+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       群成员所在群号
+ * @param {number} memberId     群成员的 qq 号
+ * @param {string} name         要设置的群名片
+ * @param {string} specialTitle 要设置的群头衔
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId, name, specialTitle }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/memberInfo', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, {
+            sessionKey, target, memberId,
+            info: {
+                name, specialTitle,
+            }
+        });
+        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/setSessionConfig.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 设置指定 session 的 config
+ * @param {string}  baseUrl         mirai-api-http server 的地址
+ * @param {string}  sessionKey      会话标识
+ * @param {number}  cacheSize       插件缓存大小
+ * @param {boolean} enableWebsocket websocket 状态
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, cacheSize, enableWebsocket }) => {
+    try {
+        // 拼接 url
+        const url = new URL('/config', baseUrl).toString();
+
+        // 请求 
+        const responseData = await axios.post(url, { sessionKey, cacheSize, enableWebsocket });
+        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/startListeningBrowser.js

@@ -0,0 +1,62 @@
+const WebSocket = window.WebSocket;
+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 {function} message            回调函数
+ * @param {function} error              回调函数
+ * @param {function} close              回调函数
+ * @returns {WebSocket} 建立连接的 WebSocket 实例
+ */
+module.exports = async ({ baseUrl, sessionKey, verifyKey, message, error, close }) => {
+    try {
+        // 拼接 url
+        let url = new URL(`/all?sessionKey=${sessionKey}&verifyKey=${verifyKey}`, baseUrl);
+        // 更改协议为 ws
+        url.protocol = 'ws';
+        url = url.toString();
+
+        const ws = new WebSocket(url);
+
+        // 监听 ws 事件，分发消息
+        ws.onopen = () => {
+            // 10s 发个心跳，浏览器会过早关闭没有发生交互的连接
+            const interval = setInterval(() => {
+                ws.send(1);
+            }, 10000);
+
+            ws.onmessage = ({ data }) => {
+                try {
+                    message(JSON.parse(data)?.data);
+                } catch (error) { }// eslint-disable-line no-empty
+            };
+
+            ws.onerror = err => {
+                /* 
+                interface Error {
+                    name: string;
+                    message: string;
+                    stack?: string;
+                } 
+                */
+                error(err);
+            };
+
+            ws.onclose = ({ code, reason }) => {
+                // 关闭心跳
+                clearInterval(interval);
+                close({ code, reason });
+            };
+        };
+        return ws;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/startListeningNode.js

@@ -0,0 +1,74 @@
+const WebSocket = require('ws');
+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 {function} message            回调函数
+ * @param {function} error              回调函数
+ * @param {function} close              回调函数
+ * @param {function} unexpectedResponse 回调函数
+ * @returns {WebSocket} 建立连接的 WebSocket 实例
+ */
+module.exports = async ({ baseUrl, sessionKey, verifyKey, message, error, close, unexpectedResponse }) => {
+    try {
+        // 拼接 url
+        let url = new URL(`/all?sessionKey=${sessionKey}&verifyKey=${verifyKey}`, baseUrl);
+        // 更改协议为 ws
+        url.protocol = 'ws';
+        url = url.toString();
+
+        const ws = new WebSocket(url);
+
+
+        // 监听 ws 事件，分发消息
+        ws.on('open', () => {
+            // 60s 发个心跳
+            const interval = setInterval(() => {
+                ws.ping((err) => {
+                    if (err) {
+                        try {
+                            console.log(`ws ping error\n${JSON.stringify(err)}`);
+                        } catch (error) { }// eslint-disable-line no-empty
+                    }
+                });
+            }, 60000);
+
+            ws.on('message', data => {
+                try {
+                    message(JSON.parse(data)?.data);
+                } catch (error) { }// eslint-disable-line no-empty
+            });
+
+            ws.on('error', err => {
+                /* 
+                    interface Error {
+                        name: string;
+                        message: string;
+                        stack?: string;
+                    } 
+                    */
+                error(err);
+            });
+
+            ws.on('close', (code, reason) => {
+                // 关闭心跳
+                clearInterval(interval);
+                close({ code, reason });
+            });
+
+            ws.on('unexpectedResponse', ({ req, res }) => {
+                unexpectedResponse({ req, res });
+            });
+        });
+        return ws;
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/stopListeningBrowser.js

@@ -0,0 +1,34 @@
+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 {WebSocket} 建立连接的 WebSocket 实例
+ */
+module.exports = async (wsConnection) => {
+    try {
+        // 由于在 ws open 之前关闭连接会抛异常，故应先判断此时是否正在连接中
+        if (wsConnection.readyState == wsConnection.CONNECTING) {
+            // 正在连接中，注册一个 open，等待回调时关闭
+            // 由于是一个异步过程，使用 Promise 包装以配合开发者可能存在的同步调用
+            await new Promise(resolve => {
+                wsConnection.onopen = () => {
+                    // 关闭 websocket 的连接
+                    wsConnection.close(1000);
+                    resolve(undefined);
+                };
+            });
+        } else if (wsConnection.readyState == wsConnection.OPEN) {
+            // 关闭 websocket 的连接
+            wsConnection.close(1000);
+        } else {
+            // CLOSING or CLOSED
+            // do nothing
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/stopListeningNode.js

@@ -0,0 +1,34 @@
+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 {WebSocket} 建立连接的 WebSocket 实例
+ */
+module.exports = async (wsConnection) => {
+    try {
+        // 由于在 ws open 之前关闭连接会抛异常，故应先判断此时是否正在连接中
+        if (wsConnection.readyState == wsConnection.CONNECTING) {
+            // 正在连接中，注册一个 open，等待回调时关闭
+            // 由于是一个异步过程，使用 Promise 包装以配合开发者可能存在的同步调用
+            await new Promise(resolve => {
+                wsConnection.on('open', () => {
+                    // 关闭 websocket 的连接
+                    wsConnection.close(1000);
+                    resolve(undefined);
+                });
+            });
+        } else if (wsConnection.readyState == wsConnection.OPEN) {
+            // 关闭 websocket 的连接
+            wsConnection.close(1000);
+        } else {
+            // CLOSING or CLOSED
+            // do nothing
+        }
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/unmute.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     欲解除禁言的成员所在群号
+ * @param {number} memberId   欲解除禁言的成员 qq 号
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, target, memberId }) => {
+    try {
+        // 拼接 URL
+        const url = new URL('/unmute', baseUrl).toString();
+
+        // 请求
+        const responseData = await axios.post(url, { sessionKey, target, memberId });
+        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);
+    }
+};