mirai-js 2.8.3 → 2.8.5

package/srcold/core/unmuteAll.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('/unmuteAll', 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/uploadImage.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';
+const FormData = require('form-data');
+
+
+/**
+ * @description 上传图片至服务器，返回指定 type 的 imageId，url，及 path
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  type             "friend" 或 "group" 或 "temp"
+ * @param {Buffer}  img              图片二进制数据
+ * @returns {Object} 结构 { imageId, url, path } 
+ */
+module.exports = async ({ baseUrl, sessionKey, type, img }) => {
+    try {
+        // 拼接 url
+        const targetUrl = new URL('/uploadImage', baseUrl).toString();
+
+        // 构造 fromdata
+        const form = new FormData();
+        form.append('sessionKey', sessionKey);
+        form.append('type', type);
+        // filename 指定了文件名
+        form.append('img', img, { filename: 'img.jpg' });
+
+        // 请求
+        const responseData = await axios.post(targetUrl, form, {
+            // formdata.getHeaders 将会指定 content-type，同时给定随
+            // 机生成的 boundary，即分隔符，用以分隔多个表单项而不会造成混乱
+            headers: form.getHeaders(),
+        });
+
+        try {
+            var {
+                data: { msg: message, code, imageId, url, path }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return { imageId, url, path };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/uploadVoice.js

@@ -0,0 +1,54 @@
+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';
+const FormData = require('form-data');
+
+
+/**
+ * FIXME: 目前该功能返回的 voiceId 无法正常使用，无法
+ * 发送给好友，提示 message is empty，发到群里则是 1s 的无声语音
+ * @description 上传语音至服务器，返回指定 type 的 imageId，url，及 path
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  type             TODO: 目前服务端仅支持 "group"
+ * @param {Buffer}  voice            语音二进制数据
+ * @returns {Object} 结构 { imageId, url, path } 
+ */
+module.exports = async ({ baseUrl, sessionKey, type, voice }) => {
+    try {
+        // 拼接 url
+        const targetUrl = new URL('/uploadVoice', baseUrl).toString();
+
+        // 构造 fromdata
+        const form = new FormData();
+        form.append('sessionKey', sessionKey);
+        form.append('type', type);
+        form.append('voice', voice, { filename: 'voice.slk' });
+
+        // 请求
+        const responseData = await axios.post(targetUrl, form, {
+            // formdata.getHeaders 将会指定 content-type，同时给定随
+            // 机生成的 boundary，即分隔符，用以分隔多个表单项而不会造成混乱
+            headers: form.getHeaders(),
+        });
+        try {
+            var {
+                data: { msg: message, code, voiceId, url, path }
+            } = responseData;
+        } catch (error) {
+            throw new Error(('请求返回格式出错，请检查 mirai-console'));
+        }
+        // 抛出 mirai 的异常，到 catch 中处理后再抛出
+        if (code in errCodeMap) {
+            throw new Error(message);
+        }
+        return { voiceId, url, path };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+};

package/srcold/core/verify.js

@@ -0,0 +1,41 @@
+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 校验 sessionKey，将一个 session 绑定到指定的 qq 上
+ * @param {string}  baseUrl    mirai-api-http server 的地址
+ * @param {string}  sessionKey 会话标识
+ * @param {number}  qq         qq 号
+ * @param {boolean} throwable  是否抛出已知的 mah 异常，用来在发生异常时获得返回值中的 mah 状态码
+ * @returns {Object} 结构 { message, code }
+ */
+module.exports = async ({ baseUrl, sessionKey, qq, throwable = true }) => {
+    try {
+        // 拼接 auth url
+        const url = new URL('/bind', 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) {
+            if (throwable) throw new Error(message);
+        }
+        return { message, code };
+    } catch (error) {
+        console.error(`mirai-js: error ${locationStr}`);
+        errorHandler(error);
+    }
+
+};

package/srcold/index.d.ts

@@ -0,0 +1,10 @@
+import { Bot, Bot as BotType } from './Bot';
+import { Message, Message as MessageType } from './Message';
+import { Middleware, Middleware as MiddlewareType } from './Middleware';
+
+export { Bot, Message, Middleware };
+declare module 'mirai-js' {
+    export const Bot: typeof BotType;
+    export const Message: typeof MessageType;
+    export const Middleware: typeof MiddlewareType;
+}

package/srcold/index.js

@@ -0,0 +1,21 @@
+const { Bot } = require('./Bot');
+const { Message } = require('./Message');
+const { Middleware } = require('./Middleware');
+
+(function (window, factory) {
+    if (typeof exports === 'object') {
+        module.exports = factory();
+        // eslint-disable-next-line no-undef
+    } else if (typeof define === 'function' && define.amd) {
+        // eslint-disable-next-line no-undef
+        define(factory);
+    } else {
+        window.miraiJs = factory();
+    }
+})(this, function () {
+    return {
+        Bot,
+        Message,
+        Middleware,
+    };
+});

package/srcold/interface.js

@@ -0,0 +1,20 @@
+/**
+ * @description Bot.sendMessage 方法的扩展接口
+ * 重写该接口后可将子类实例直接传入 message 参数
+ */
+class MessageChainGetable {
+    getMessageChain() { }
+}
+
+/**
+ * @description Bot 实现的接口，其他类访问 bot.config
+ * 的途径，避免其他类直接访问实现，用来解耦
+ */
+class BotConfigGetable {
+    getBaseUrl() { }
+    getQQ() { }
+    getVerifyKey() { }
+    getSessionKey() { }
+}
+
+module.exports = { MessageChainGetable, BotConfigGetable };

package/srcold/polyfill/URL.js

@@ -0,0 +1,5 @@
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+
+module.exports = {
+    URL: isBrowserEnv() ? window.URL : require('url').URL
+};

package/srcold/polyfill/wsListener.js

@@ -0,0 +1,6 @@
+const { isBrowserEnv } = require('../util/isBrowserEnv');
+
+module.exports = {
+    wsStartListening: isBrowserEnv() ? require('../core/startListeningBrowser') : require('../core/startListeningNode'),
+    wsStopListening: isBrowserEnv() ? require('../core/stopListeningBrowser') : require('../core/stopListeningNode'),
+};

package/srcold/typeHelpers.d.ts

@@ -0,0 +1,2 @@
+// 将数组转换为
+export type ArrayToValuesUnion<T extends string[]> = T extends (infer E)[] ? E : never;

package/srcold/util/errCode.js

@@ -0,0 +1,23 @@
+let errCodeMap = {
+    1: '错误的 auth key',
+    2: '指定的 Bot 不存在',
+    3: 'Session 失效或不存在',
+    4: 'Session未认证(未激活)',
+    5: '发送消息目标不存在(指定对象不存在)',
+    6: '指定文件不存在，出现于发送本地图片',
+    10: '无操作权限，指 Bot 没有对应操作的限权',
+    20: 'Bot 被禁言，指 Bot 当前无法向指定群发送消息',
+    30: '消息过长',
+    400: '错误的访问，可能是参数错误',
+};
+
+let errCodeEnum = {
+    get BOT_NOT_FOUND() {
+        return 2;
+    },
+    // 需要的时候随时加
+};
+module.exports = {
+    errCodeMap,
+    errCodeEnum
+};

package/srcold/util/errorHandler.js

@@ -0,0 +1,24 @@
+module.exports = (error) => {
+    // 拿到所有的 message
+    let message, miraiMessage, resMessage;
+
+    ({ message } = error);
+
+    const { response } = error;
+    if (response?.data) {
+        ({ msg: miraiMessage, resMessage } = response.data);
+    }
+
+    // 抛出
+    if ((message ?? miraiMessage ?? resMessage ?? response?.data)) {
+        // 拼接
+        throw new Error(
+            [message, miraiMessage, resMessage, response?.data]
+                .filter(msg => typeof msg == 'string')
+                .join('\n')
+        );
+    } else {
+        // 未知异常
+        throw error;
+    }
+};

package/srcold/util/getInvalidParamsString.js

@@ -0,0 +1,12 @@
+/**
+ * @description 检查必选参数
+ * @param {Object} parametersMap 要检查的参数 map
+ * @returns {string} 未提供参数的参数名，以空格隔开
+ */
+module.exports = parametersMap => {
+    return Object.keys(parametersMap)
+        .filter(fieldName => {
+            return parametersMap[fieldName] === undefined;
+        })
+        .join(' ');
+};

package/srcold/util/isBrowserEnv.js

@@ -0,0 +1,3 @@
+exports.isBrowserEnv = () => {
+    return typeof window !== 'undefined';
+};

package/srcold/util/random.js

@@ -0,0 +1,6 @@
+module.exports = (min, max) => {
+    return () => {
+        return Math.floor((Math.random() * (max - min + 1)) + min);
+    };
+
+};

package/webpack.config.js

@@ -2,11 +2,12 @@ const { ProvidePlugin } = require('webpack');
 
 module.exports = {
     context: __dirname,
-    entry: './src/index.js',
+    entry: './src/borwserEntry.js',
     output: {
         path: require('path').resolve(__dirname, 'dist', 'browser'),
         filename: 'mirai-js.js',
-        clean: true
+        clean: true,
+        libraryTarget: 'umd',
     },
     externals: {
         // ws v8+ 会需要配置更多 polyfill, 这里通过外部依赖直接忽略它