mirai-js 2.8.0-3 → 2.8.2

package/demo.ts

@@ -0,0 +1,53 @@
+import { Bot, Message, Middleware } from './src';
+
+(async () => {
+    try {
+        const baseUrl = 'http://localhost:8080';
+        const verifyKey = '123456789';
+        const qq = 3070539027;
+        const bot = new Bot();
+
+
+
+
+
+
+
+
+
+
+        bot.on('FriendMessage', new Middleware()
+            .messageProcessor(['AtAll', 'App'])
+            .textProcessor()
+            .done(ctx => {
+                ctx.
+
+            }));
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+        bot.on('NewFriendRequestEvent', new Middleware()
+            .friendRequestProcessor()
+            .done(ctx => {
+                d
+            }))
+        // 在 mirai-console 登录你的 bot
+
+    } catch (err) {
+        console.log(err);
+    }
+})();

package/dist/node/BaseType.d.ts

@@ -87,7 +87,7 @@ type MessageId = number;
  * @see https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md
 */
 
-type MessageChainElementTypes =
+export type MessageChainElementTypes =
     | 'Source'
     | 'Quote'
     | 'At'
@@ -113,26 +113,6 @@ interface EventBaseType {
 }
 
 // Middleware
-interface MessageExtendType {
-    text?: string;
-    classified?: {
-        [key in MessageChainElementTypes]?: any[];
-    };
-    messageId?: number;
-    waitFor?: any
-    unlock?: () => void;
-}
-type RequestEventMethods =
-    | 'agree'
-    | 'refuse'
-    | 'ignore'
-    | 'refuseAndAddBlacklist'
-    | 'ignoreAndAddBlacklist';
-
-type RequestEventExtendType = {
-    [key in RequestEventMethods]?: () => void;
-};
-
 interface Member {
     id: number;
     memberName: string;
@@ -169,14 +149,12 @@ interface EventEntityMap {
         type: 'GroupMessage';
         sender: Member & { group: GroupSenderType },
         messageChain: MessageType[];
-    } & EventBaseType &
-    MessageExtendType,
+    } & EventBaseType,
     FriendMessage: {
         type: 'FriendMessage';
         messageChain: MessageType[];
         sender: Friend
-    } & EventBaseType &
-    MessageExtendType,
+    } & EventBaseType,
     BotOnlineEvent: {
         type: 'BotOnlineEvent',
         qq: number
@@ -334,7 +312,7 @@ interface EventEntityMap {
         groupId: number,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
     MemberJoinRequestEvent: {
         type: 'MemberJoinRequestEvent',
         eventId: number,
@@ -343,7 +321,7 @@ interface EventEntityMap {
         groupName: string,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
     BotInvitedJoinGroupRequestEvent: {
         type: 'MemberJoinRequestEvent',
         eventId: number,
@@ -352,7 +330,7 @@ interface EventEntityMap {
         groupName: string,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
 }
 
 type EventType = keyof EventEntityMap;
@@ -366,8 +344,7 @@ type GroupPermission = 'OWNER' | 'ADMINISTRATOR' | 'MEMBER';
 type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE';
 
 // 消息处理器
-type Processor<U extends EventType[] | 'UnknownEventType' = 'UnknownEventType'> =
-    (data: U extends 'UnknownEventType' ? EventBaseType : EventEntityMap[ArrayToValuesUnion<U extends 'UnknownEventType' ? never : U>]) => Awaitable<void | any>;
+type Processor<U extends EventType[] = [], Extend = { [key: string]: any }> = (data: EventEntityMap[ArrayToValuesUnion<U>] & Extend) => Awaitable<void | any>;
 
 // QQ 自带表情
 type FaceType =

package/dist/node/Bot.d.ts

@@ -93,8 +93,8 @@ export class Bot implements BotConfigGetable {
      * @param callback  必选，回调函数
      * @returns handle 事件处理器的标识，用于移除该处理器
      */
-    on<U extends EventType>(eventType: U, callback: Processor<[U]>): number;
-    on<U extends EventType[]>(eventType: U, callback: Processor<U>): number[];
+    on<U extends EventType, E>(eventType: U, callback: Processor<[U], E>): number;
+    on<U extends EventType[], E>(eventType: U, callback: Processor<U, E>): number[];
 
     /**
      * @description 添加一个一次性事件处理器，回调一次后自动移除

package/dist/node/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/index.ts

@@ -0,0 +1,3 @@
+const a = ['a', 'b', 'c'];
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mirai-js",
-    "version": "2.8.0-3",
+    "version": "2.8.2",
     "description": "QQ robot development framework based on Mirai-api-http.",
     "main": "dist/node/index.js",
     "scripts": {

package/src/BaseType.d.ts

@@ -87,7 +87,7 @@ type MessageId = number;
  * @see https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md
 */
 
-type MessageChainElementTypes =
+export type MessageChainElementTypes =
     | 'Source'
     | 'Quote'
     | 'At'
@@ -113,26 +113,6 @@ interface EventBaseType {
 }
 
 // Middleware
-interface MessageExtendType {
-    text?: string;
-    classified?: {
-        [key in MessageChainElementTypes]?: any[];
-    };
-    messageId?: number;
-    waitFor?: any
-    unlock?: () => void;
-}
-type RequestEventMethods =
-    | 'agree'
-    | 'refuse'
-    | 'ignore'
-    | 'refuseAndAddBlacklist'
-    | 'ignoreAndAddBlacklist';
-
-type RequestEventExtendType = {
-    [key in RequestEventMethods]?: () => void;
-};
-
 interface Member {
     id: number;
     memberName: string;
@@ -169,14 +149,12 @@ interface EventEntityMap {
         type: 'GroupMessage';
         sender: Member & { group: GroupSenderType },
         messageChain: MessageType[];
-    } & EventBaseType &
-    MessageExtendType,
+    } & EventBaseType,
     FriendMessage: {
         type: 'FriendMessage';
         messageChain: MessageType[];
         sender: Friend
-    } & EventBaseType &
-    MessageExtendType,
+    } & EventBaseType,
     BotOnlineEvent: {
         type: 'BotOnlineEvent',
         qq: number
@@ -334,7 +312,7 @@ interface EventEntityMap {
         groupId: number,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
     MemberJoinRequestEvent: {
         type: 'MemberJoinRequestEvent',
         eventId: number,
@@ -343,7 +321,7 @@ interface EventEntityMap {
         groupName: string,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
     BotInvitedJoinGroupRequestEvent: {
         type: 'MemberJoinRequestEvent',
         eventId: number,
@@ -352,7 +330,7 @@ interface EventEntityMap {
         groupName: string,
         nick: string,
         message: string
-    } & RequestEventExtendType & EventBaseType;
+    } & EventBaseType;
 }
 
 type EventType = keyof EventEntityMap;
@@ -366,8 +344,7 @@ type GroupPermission = 'OWNER' | 'ADMINISTRATOR' | 'MEMBER';
 type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE';
 
 // 消息处理器
-type Processor<U extends EventType[] | 'UnknownEventType' = 'UnknownEventType'> =
-    (data: U extends 'UnknownEventType' ? EventBaseType : EventEntityMap[ArrayToValuesUnion<U extends 'UnknownEventType' ? never : U>]) => Awaitable<void | any>;
+type Processor<U extends EventType[] = [], Extend = { [key: string]: any }> = (data: EventEntityMap[ArrayToValuesUnion<U>] & Extend) => Awaitable<void | any>;
 
 // QQ 自带表情
 type FaceType =

package/src/Bot.d.ts

@@ -93,8 +93,8 @@ export class Bot implements BotConfigGetable {
      * @param callback  必选，回调函数
      * @returns handle 事件处理器的标识，用于移除该处理器
      */
-    on<U extends EventType>(eventType: U, callback: Processor<[U]>): number;
-    on<U extends EventType[]>(eventType: U, callback: Processor<U>): number[];
+    on<U extends EventType, E>(eventType: U, callback: Processor<[U], E>): number;
+    on<U extends EventType[], E>(eventType: U, callback: Processor<U, E>): number[];
 
     /**
      * @description 添加一个一次性事件处理器，回调一次后自动移除

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