mirai-js 2.8.0 → 2.8.3

package/src/Middleware.d.ts

@@ -1,7 +1,8 @@
-import { Processor, EventType } from './BaseType';
+import { Processor, EventType, MessageChainElementTypes, MessageType } from './BaseType';
 import { Bot } from './Bot';
+import { ArrayToValuesUnion } from './typeHelpers';
 
-export class Middleware {
+export class Middleware<CTX = { [key: string]: any }> {
     private middleware: ((data: any, next: Middleware.NextMiddlewareCaller) => any)[];
     private catcher: (error: any) => any;
 
@@ -12,44 +13,44 @@ export class Middleware {
      * @param verifyKey  mirai-api-http server 设置的 verifyKey
      * @param password 欲重新登陆的 qq 密码
      */
-    autoReLogin({ bot, baseUrl, verifyKey, password }: Middleware.AutoReLoginOptions): Middleware;
+    autoReLogin({ bot, baseUrl, verifyKey, password }: Middleware.AutoReLoginOptions): Middleware<CTX>;
 
     /**
      * @description 自动重建 ws 连接
      * @param bot 欲重连的 Bot 实例
      */
-    autoReconnection(bot: Bot): Middleware;
+    autoReconnection(bot: Bot): Middleware<CTX>;
 
     /**
      * @description 过滤出指定类型的消息，消息类型为 key，对应类型的
      *              message 数组为 value，置于 data.classified
      * @param typeArr message 的类型，例如 Plain Image Voice
      */
-    messageProcessor(typeArr: string[]): Middleware;
+    messageProcessor<U extends MessageChainElementTypes[]>(typeArr: U): Middleware<CTX & { classified: { [type in ArrayToValuesUnion<U>]: any[] } }>;
 
     /**
      * @description 过滤出字符串类型的 message，并拼接在一起，置于 data.text
      */
-    textProcessor(): Middleware;
+    textProcessor(): Middleware<CTX & { text: string }>;
 
     /**
      * @description 过滤出消息 id，置于 data.messageId
      */
-    messageIdProcessor(): Middleware;
+    messageIdProcessor(): Middleware<CTX & { messageId: string }>;
 
     /**
      * @description 过滤指定的群消息
      * @param groupArr 允许通过的群号数组
      * @param allow    允许通过还是禁止通过
      */
-    groupFilter(groupArr: number[], allow?: boolean): Middleware;
+    groupFilter(groupArr: number[], allow?: boolean): Middleware<CTX>;
 
     /**
      * @description 过滤指定的好友消息
      * @param friendArr 好友 qq 号数组
      * @param allow     允许通过还是禁止通过
      */
-    friendFilter(friendArr: number[], allow?: boolean): Middleware;
+    friendFilter(friendArr: number[], allow?: boolean): Middleware<CTX>;
 
     /**
      * @description 过滤指定群的群成员的消息
@@ -57,32 +58,32 @@ export class Middleware {
      * @param allow          允许通过还是禁止通过
      * 结构 { number => number[], } key 为允许通过的群号，value 为该群允许通过的成员 qq
      */
-    groupMemberFilter(groupMemberMap: Middleware.GroupMemberMap, allow?: boolean): Middleware;
+    groupMemberFilter(groupMemberMap: Middleware.GroupMemberMap, allow?: boolean): Middleware<CTX>;
 
     /**
      * @description 这是一个对话锁，保证群中同一成员不能在中途触发处理器
      * @use 在你需要保护的过程结束后调用 data.unlock 即可
      */
-    memberLock({ autoUnlock }?: Middleware.LockOptions): Middleware;
+    memberLock({ autoUnlock }?: Middleware.LockOptions): Middleware<CTX & { unlock: () => void }>;
 
     /**
      * @description 这是一个对话锁，保证同一好友不能在中途触发处理器
      * @use 在你需要保护的过程结束后调用 data.unlock 即可
      */
-    friendLock({ autoUnlock }?: Middleware.LockOptions): Middleware;
+    friendLock({ autoUnlock }?: Middleware.LockOptions): Middleware<CTX & { unlock: () => void }>;
 
     /**
      * @description 过滤包含指定 @ 信息的消息
      * @param atArr 必选，qq 号数组
      * @param allow 可选，允许通过还是禁止通过
      */
-    atFilter(friendArr: number[], allow?: boolean): Middleware;
+    atFilter(friendArr: number[], allow?: boolean): Middleware<CTX>;
 
     /**
      * @description 用于 NewFriendRequestEvent 的中间件，经过该中间件后，将在 data 下放置三个方法
      * agree、refuse、refuseAndAddBlacklist，调用后将分别进行好友请求的 同意、拒绝和拒绝并加入黑名单
      */
-    friendRequestProcessor(): Middleware;
+    friendRequestProcessor(): Middleware<CTX & { agree: () => void, refuse: () => void, refuseAndAddBlacklist: () => void }>;
 
     /**
      * ! mirai-core 的问题，有时候收不到 MemberJoinRequestEvent 事件
@@ -93,9 +94,11 @@ export class Middleware {
      * ignore                忽略
      * refuseAndAddBlacklist 拒绝并移入黑名单
      * ignoreAndAddBlacklist 忽略并移入黑名单
-     * @param bot 必选，Bot 实例
      */
-    memberJoinRequestProcessor(): Middleware;
+    memberJoinRequestProcessor(): Middleware<CTX & {
+        agree: () => void, refuse: () => void, ignore: () => void,
+        refuseAndAddBlacklist: () => void, ignoreAndAddBlacklist: () => void,
+    }>;
 
     /**
      * ! 目前被邀请入群不会触发 BotInvitedJoinGroupRequestEvent 事件
@@ -103,32 +106,47 @@ export class Middleware {
      * @description 用于 BotInvitedJoinGroupRequestEvent 的中间件，经过该中间件后，将在 data 下放置两个方法
      * agree                 同意
      * refuse                拒绝
-     * @param bot 必选，Bot 实例
      */
-    invitedJoinGroupRequestProcessor(): Middleware;
+    invitedJoinGroupRequestProcessor(): Middleware<CTX & { agree: () => void, refuse: () => void }>;
 
     /**
      * @description Waiter 的包装器，提供方便的同步 IO 方式
      */
-    syncWrapper(): Middleware;
+    syncWrapper(): Middleware<CTX & {
+        waitFor: {
+            groupMember: (qq: number) => {
+                messageChain: () => Promise<MessageType[]>,
+                text: () => Promise<string>,
+                custom: <R>(processor: () => R) => Promise<R>,
+            },
+            friend: (qq) => {
+                messageChain: () => Promise<MessageType[]>,
+                text: () => Promise<string>,
+                custom: <R>(processor: () => R) => Promise<R>,
+            },
+            messageChain: () => Promise<MessageType[]>,
+            text: Promise<string>,
+            custom: <R>(processor: () => R) => Promise<R>,
+        }
+    }>;
 
     /**
      * @description 添加一个自定义中间件
      * @param callback (data, next) => void
      */
-    use(callback: (data: any, next: Middleware.NextMiddlewareCaller) => any): Middleware;
+    use(callback: (data: CTX, next: Middleware.NextMiddlewareCaller) => any): Middleware<CTX>;
 
     /**
      * @description 使用错误处理器
      * @param catcher 错误处理器 (err) => void
      */
-    catch(catcher: (error: any) => any): Middleware;
+    catch(catcher: (error: any) => any): Middleware<CTX>;
 
     /**
      * @description 生成一个带有中间件的事件处理器
      * @param callback 事件处理器
      */
-    done<E extends EventType[] | EventType>(callback: Processor<E extends EventType ? [E] : E>): Processor<E extends EventType ? [E] : E>;
+    done<E extends EventType[]>(callback: Processor<E, CTX>): Processor<E, CTX>;
 
 }
 

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