mirai-js 2.7.2 → 2.8.0-1

package/src/BaseType.d.ts

@@ -1,17 +1,20 @@
+import { Bot } from './Bot';
+import { ArrayToValuesUnion } from './typeHelpers';
+
 /**
  * 消息链的元素，是 mirai-api-http 接口需要的原始类型
  * 有多种消息类型实现了该接口，已经全部列出
- * 
+ *
  * @see https://github.com/project-mirai/mirai-api-http/blob/master/docs/MessageType.md
  */
 interface MessageType {
-    type: string;
+    type: MessageChainElementTypes;
 
     // Quote
-    id?: number,
-    groupId?: number,
-    senderId?: number,
-    targetId?: number,
+    id?: number;
+    groupId?: number;
+    senderId?: number;
+    targetId?: number;
     origin?: MessageType[];
 
     // At
@@ -71,7 +74,6 @@ interface BotConfigGetable {
     getSessionKey(): string;
 }
 
-
 // 图片 id
 type ImageId = string;
 // 语音 id
@@ -81,41 +83,291 @@ type MessageId = number;
 
 /**
  * 消息类型
- * 
+ *
  * @see https://github.com/project-mirai/mirai-api-http/blob/master/docs/EventType.md
- */
-type EventType =
-    // WebSocket 事件
-    | 'error' | 'close' | 'unexpected-response'
-    // mirai 事件
-    | 'GroupMessage' | 'FriendMessage'
-    | 'BotOnlineEvent' | 'BotOfflineEventActive'
-    | 'BotOfflineEventForce' | 'BotOfflineEventDropped'
-    | 'BotReloginEvent' | 'BotGroupPermissionChangeEvent'
-    | 'BotMuteEvent' | 'BotUnmuteEvent'
-    | 'BotJoinGroupEvent' | 'BotLeaveEventActive'
-    | 'BotLeaveEventKick' | 'GroupRecallEvent'
-    | 'FriendRecallEvent' | 'GroupNameChangeEvent'
-    | 'GroupEntranceAnnouncementChangeEvent' | 'GroupMuteAllEvent'
-    | 'GroupAllowAnonymousChatEvent' | 'GroupAllowConfessTalkEvent'
-    | 'GroupAllowMemberInviteEvent' | 'MemberJoinEvent'
-    | 'MemberLeaveEventKick' | 'MemberLeaveEventQuit'
-    | 'MemberCardChangeEvent' | 'MemberSpecialTitleChangeEvent'
-    | 'MemberPermissionChangeEvent' | 'MemberMuteEvent'
-    | 'MemberUnmuteEvent' | 'NewFriendRequestEvent'
-    | 'MemberJoinRequestEvent' | 'BotInvitedJoinGroupRequestEvent';
+*/
+
+type MessageChainElementTypes =
+    | 'Source'
+    | 'Quote'
+    | 'At'
+    | 'AtAll'
+    | 'Face'
+    | 'Plain'
+    | 'Image'
+    | 'FlashImage'
+    | 'Voice'
+    | 'Xml'
+    | 'Json'
+    | 'App'
+    | 'Poke'
+    | 'Dice'
+    | 'MarketFace'
+    | 'MusicShare'
+    | 'ForwardMessage'
+    | 'File'
+    | 'MiraiCode';
+
+interface EventBaseType {
+    bot: Bot;
+}
+
+// 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;
+    specialTitle: string;
+    permission: GroupPermission;
+    joinTimestamp: number;
+    lastSpeakTimestamp: number;
+    muteTimeRemaining: number;
+}
+
+interface GroupSenderType {
+    id: number;
+    name: string;
+    permission: GroupPermission;
+}
+
+interface Friend {
+    id: number,
+    nickname: string,
+    remark: string;
+}
+
+interface EventEntityMap {
+    error: {
+        code: number;
+    } & EventBaseType,
+    close: {
+        reason: string;
+    } & EventBaseType,
+    'unexpected-response': {
+        reason: string;
+    } & EventBaseType,
+    GroupMessage: {
+        type: 'GroupMessage';
+        sender: Member & { group: GroupSenderType },
+        messageChain: MessageType[];
+    } & EventBaseType &
+    MessageExtendType,
+    FriendMessage: {
+        type: 'FriendMessage';
+        messageChain: MessageType[];
+        sender: Friend
+    } & EventBaseType &
+    MessageExtendType,
+    BotOnlineEvent: {
+        type: 'BotOnlineEvent',
+        qq: number
+    } & EventBaseType,
+    BotOfflineEventActive: {
+        type: 'BotOfflineEventActive',
+        qq: number
+    } & EventBaseType,
+    BotOfflineEventForce: {
+        type: 'BotOfflineEventForce',
+        qq: number
+    } & EventBaseType,
+    BotOfflineEventDropped: {
+        type: 'BotOfflineEventDropped',
+        qq: number
+    } & EventBaseType,
+    BotReloginEvent: {
+        type: 'BotReloginEvent',
+        qq: number
+    } & EventBaseType,
+    BotGroupPermissionChangeEvent: {
+        type: 'BotGroupPermissionChangeEvent';
+        origin: Exclude<GroupPermission, 'OWNER'>;
+        current: GroupPermission;
+        group: GroupSenderType;
+    } & EventBaseType,
+    BotMuteEvent: {
+        type: 'BotMuteEvent',
+        durationSeconds: number,
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType,
+    BotUnmuteEvent: {
+        type: 'BotUnmuteEvent',
+        durationSeconds: number,
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType,
+    BotJoinGroupEvent: {
+        type: 'BotJoinGroupEvent',
+        group: GroupSenderType
+        operator?: null | Member & { group: GroupSenderType };
+    };
+    BotLeaveEventActive: {
+        type: 'BotLeaveEventActive',
+        group: GroupSenderType
+    };
+    BotLeaveEventKick: {
+        type: 'BotLeaveEventKick',
+        group: GroupSenderType
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    GroupRecallEvent: {
+        type: 'GroupRecallEvent'
+        authorId: number,
+        messageId: number,
+        time: number,
+        group: GroupSenderType
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    FriendRecallEvent: {
+        type: 'GroupRecallEvent'
+        authorId: number,
+        messageId: number,
+        time: number,
+        operator: number
+    } & EventBaseType;
+    GroupNameChangeEvent: {
+        type: 'GroupNameChangeEvent',
+        origin: string,
+        current: string,
+        group: GroupSenderType;
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    GroupEntranceAnnouncementChangeEvent: {
+        type: 'GroupEntranceAnnouncementChangeEvent',
+        origin: string,
+        current: string,
+        group: GroupSenderType;
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    GroupMuteAllEvent: {
+        type: 'GroupMuteAllEvent',
+        origin: boolean,
+        current: boolean,
+        group: GroupSenderType;
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    GroupAllowAnonymousChatEvent: {
+        type: 'GroupAllowAnonymousChatEvent',
+        origin: boolean,
+        current: boolean,
+        group: GroupSenderType,
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    GroupAllowConfessTalkEvent: {
+        type: 'GroupAllowAnonymousChatEvent',
+        origin: boolean,
+        current: boolean,
+        group: GroupSenderType,
+        isByBot: boolean
+    } & EventBaseType;
+    GroupAllowMemberInviteEvent: EventBaseType;
+    MemberJoinEvent: {
+        type: 'MemberJoinEvent',
+        member: Member & { group: GroupSenderType },
+        invitor: Member;
+    } & EventBaseType;
+    MemberLeaveEventKick: {
+        type: 'MemberLeaveEventKick',
+        member: Member & { group: GroupSenderType },
+        operator: Member & { group: GroupSenderType },
+    } & EventBaseType;
+    MemberLeaveEventQuit: {
+        type: 'MemberLeaveEventQuit',
+        member: Member & { group: GroupSenderType },
+    } & EventBaseType;
+    MemberCardChangeEvent: {
+        type: 'MemberCardChangeEvent',
+        origin: string,
+        current: string,
+        member: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    MemberSpecialTitleChangeEvent: {
+        type: 'MemberSpecialTitleChangeEvent',
+        origin: string,
+        current: string,
+        member: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    MemberPermissionChangeEvent: {
+        type: 'MemberPermissionChangeEvent',
+        origin: string,
+        current: string,
+        member: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    MemberMuteEvent: {
+        type: 'MemberMuteEvent',
+        durationSeconds: number,
+        member: Member & { group: GroupSenderType };
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    MemberUnmuteEvent: {
+        type: 'MemberUnmuteEvent',
+        member: Member & { group: GroupSenderType };
+        operator: Member & { group: GroupSenderType };
+    } & EventBaseType;
+    MemberHonorChangeEvent: {
+        type: 'MemberHonorChangeEvent',
+        member: Member & { group: GroupSenderType }
+        action: 'achieve' | 'lose',
+        honor: string;
+    }
+    NewFriendRequestEvent: {
+        type: 'NewFriendRequestEvent',
+        eventId: number,
+        fromId: number,
+        groupId: number,
+        nick: string,
+        message: string
+    } & RequestEventExtendType & EventBaseType;
+    MemberJoinRequestEvent: {
+        type: 'MemberJoinRequestEvent',
+        eventId: number,
+        fromId: number,
+        groupId: number,
+        groupName: string,
+        nick: string,
+        message: string
+    } & RequestEventExtendType & EventBaseType;
+    BotInvitedJoinGroupRequestEvent: {
+        type: 'MemberJoinRequestEvent',
+        eventId: number,
+        fromId: number,
+        groupId: number,
+        groupName: string,
+        nick: string,
+        message: string
+    } & RequestEventExtendType & EventBaseType;
+}
+
+type EventType = keyof EventEntityMap;
+
+type Awaitable<T> = T | PromiseLike<T>;
 
 // 群成员权限
-type GroupPermission =
-    | 'OWNER'
-    | 'ADMINISTRATOR'
-    | 'MEMBER';
+type GroupPermission = 'OWNER' | 'ADMINISTRATOR' | 'MEMBER';
 
 // 性别
-type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE'
+type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE';
 
 // 消息处理器
-type Processor = (data: any) => Promise<any> | any;
+type Processor<U extends EventType[] | 'UnknownEventType' = 'UnknownEventType'> =
+    (data: U extends 'UnknownEventType' ? EventBaseType : EventEntityMap[ArrayToValuesUnion<U extends 'UnknownEventType' ? never : U>]) => Awaitable<void | any>;
 
 // QQ 自带表情
 type FaceType =
@@ -175,22 +427,16 @@ type FaceType =
 export {
     // 接口
     MessageChainGetable, BotConfigGetable,
-
     // 消息类型
     MessageType,
-
     // MessageType.nodeList 的元素类型
     ForwardNode,
-
     // 图片 id  语音 id  消息 id
     ImageId, VoiceId, MessageId,
-
-    // 事件类型    群成员权限      性别
-    EventType, GroupPermission, SEX,
-
-    // 消息处理器
-    Processor,
-
+    // 事件类型            群成员权限        性别
+    EventType, EventEntityMap, GroupPermission, SEX,
     // QQ 自带表情
-    FaceType
-};
+    FaceType,
+    Processor,
+    Awaitable,
+};

package/src/Bot.d.ts

@@ -3,10 +3,14 @@ import {
     ImageId, VoiceId, MessageId,
 
     // 事件类型    群成员权限      性别
-    EventType, GroupPermission, SEX,
+    EventType, EventEntityMap, GroupPermission, SEX,
 
     // 接口               原始消息类型  事件处理器类型
-    MessageChainGetable, BotConfigGetable, MessageType, Processor
+    MessageChainGetable, BotConfigGetable, MessageType,
+
+    Awaitable,
+    Processor,
+
 } from './BaseType';
 
 // 等待器
@@ -19,9 +23,7 @@ export class Bot implements BotConfigGetable {
 
     // 类属性
     public static groupPermission: {
-        OWNER: GroupPermission;
-        ADMINISTRATOR: GroupPermission;
-        MEMBER: GroupPermission;
+        [k in GroupPermission]: k
     };
 
     // 一些私有的实例属性
@@ -91,7 +93,8 @@ export class Bot implements BotConfigGetable {
      * @param callback  必选，回调函数
      * @returns handle 事件处理器的标识，用于移除该处理器
      */
-    on(eventType: EventType | EventType[], processor: Processor): number | number[];
+    on<U extends EventType>(eventType: U, callback: Processor<[U]>): number;
+    on<U extends EventType[]>(eventType: U, callback: Processor<U>): number[];
 
     /**
      * @description 添加一个一次性事件处理器，回调一次后自动移除
@@ -101,7 +104,8 @@ export class Bot implements BotConfigGetable {
      *                  当为 true 时，只有开发者的处理器结束后才会移除该处理器
      *                  当为 false 时，即使消息被拦截，也会移除该处理器
      */
-    one(eventType: EventType | EventType[], processor: Processor, strict: boolean,): void;
+    one<U extends EventType>(eventType: U, callback: Processor<[U]>, strict: boolean): void;
+    one<U extends EventType[]>(eventType: U, callback: Processor<U>, strict: boolean): void;
 
     /**
      * @description 移除一个事件处理器
@@ -314,11 +318,12 @@ declare namespace Bot {
         verifyKey: string;
         sessionKey: string;
     }
+
     // An index signature parameter type cannot be a union type. Consider using a mapped object type instead.
-    interface EventProcessorMap {
+    type EventProcessorMap = {
         // 索引不能使用联合类型
-        [eventType: string /* EventType */]: {
-            [handle: number]: Processor;
+        [eventType in EventType]: {
+            [handler: number]: (data: EventEntityMap[eventType]) => Awaitable<void | any>;
         };
     }
 

package/src/Message.d.ts

@@ -58,9 +58,9 @@ export class ForwardMessage implements MessageChainGetable {
         time,
         senderName,
         messageChain
-    }: ForwardNode): Message;
-    addForwardNode(messageId: MessageId): ForwardMessage;
+    }: ForwardNode): this;
+    addForwardNode(messageId: MessageId): this;
 
     // implements MessageChainGetable
     getMessageChain(): MessageType[];
-}
+}

package/src/index.d.ts

@@ -1,6 +1,8 @@
-import { Bot as BotType } from './Bot';
-import { Message as MessageType } from './Message';
-import { Middleware as MiddlewareType } from './Middleware';
+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;

package/src/typeHelpers.d.ts

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

package/src/util/isBrowserEnv.js

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

package/dist/node/ForwardNode.d.ts

@@ -1,15 +0,0 @@
-import { ForwardNodeGetable, ForwardNodeType, MessageId } from './BaseType';
-
-// Bot.sendForward 的 nodeList 参数是一个 ForwardNode 类型的实例
-// 方法内部通过 ForwardNodeType 接口的 getForwardNode 方法拿到消息链
-export class ForwardNode implements ForwardNodeGetable {
-    private nodeList: ForwardNodeType[];
-
-    // 自行添加一个消息节点
-    addForwardNode(nodeList: ForwardNodeType): ForwardNode;
-    // 使用 MessageId 添加一个消息节点
-    addForwardNodeById(ID: MessageId): ForwardNode;
-
-    // implements ForwardNodeGetable
-    getForwardNode(): ForwardNodeType[];
-}

package/dist/node/ForwardNode.js

@@ -1,70 +0,0 @@
-"use strict";
-
-// 用于与 Bot.sendForward 耦合的接口
-const {
-  ForwardNodeGetable,
-  MessageChainGetable
-} = require('./interface');
-
-class ForwardNode_Data {
-  constructor({
-    senderId,
-    time,
-    senderName,
-    messageChain
-  }) {
-    this.senderId = senderId;
-    this.time = time;
-    this.senderName = senderName;
-    this.messageChain = messageChain;
-  }
-
-}
-
-class ForwardNode_Id {
-  constructor({
-    messageId
-  }) {
-    this.messageId = messageId;
-  }
-
-}
-/**
- * @description 本框架抽象的消息节点
- */
-
-
-class ForwardNode extends ForwardNodeGetable {
-  constructor() {
-    super();
-    this.nodeList = [];
-  } // 手动添加节点
-
-
-  addForwardNode(nodeList) {
-    if (nodeList.messageChain instanceof MessageChainGetable) {
-      nodeList.messageChain = nodeList.messageChain.getMessageChain();
-    }
-
-    this.nodeList.push(new ForwardNode_Data(nodeList));
-    return this;
-  } // 使用 messageId 添加节点
-
-
-  addForwardNodeById(messageId) {
-    this.nodeList.push(new ForwardNode_Id({
-      messageId
-    }));
-    return this;
-  } // get 原接口格式的信息链
-
-
-  getForwardNode() {
-    return this.nodeList;
-  }
-
-}
-
-module.exports = {
-  ForwardNode
-};

package/dist/node/core/getGroupFileInfo.js

@@ -1,77 +0,0 @@
-"use strict";
-
-const {
-  errCodeMap
-} = require('../util/errCode');
-
-const axios = require('axios').default;
-
-let URL;
-
-if (!process.browser) {
-  ({
-    URL
-  } = require('url'));
-} else {
-  URL = window.URL;
-}
-
-const errorHandler = require('../util/errorHandler');
-
-const path = require('path');
-
-const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
-/**
- * @description 获取群文件详细信息
- * @param {string} baseUrl    mirai-api-http server 的地址
- * @param {string} sessionKey 会话标识
- * @param {number} target     群号
- * @param {string} id         文件 id
- * @returns {Object}   
- * 结构 { 
- *     id, name, path, length, downloadTimes, uploaderId, 
- *     uploadTime, lastModifyTime, downloadUrl, sha1, md5
- * }
- */
-
-module.exports = async ({
-  baseUrl,
-  sessionKey,
-  target,
-  id
-}) => {
-  try {
-    // 拼接 url
-    const url = new URL('/groupFileInfo', baseUrl).toString(); // 请求
-
-    const responseData = await axios.get(url, {
-      params: {
-        sessionKey,
-        target,
-        id
-      }
-    });
-
-    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);
-    }
-
-    return data;
-  } catch (error) {
-    console.error(`mirai-js: error ${locationStr}`);
-    errorHandler(error);
-  }
-};