refactor & fix: refactor msg entity & adjust some wrong definition

src/core/apis/file.ts

@@ -238,7 +238,7 @@ export class NTQQFileApi {
                 fileName: fileName,
                 filePath: path,
                 md5HexStr: md5,
-                fileSize: fileSize,
+                fileSize: fileSize.toString(),
                 duration: duration ?? 1,
                 formatType: 1,
                 voiceType: 1,

src/core/entities/msg.ts

@@ -27,94 +27,70 @@ export interface GetFileListParam {
 
 export enum ElementType {
     UNKNOWN = 0,
-
     TEXT = 1,
-
     PIC = 2,
-
     FILE = 3,
-
     PTT = 4,
-
     VIDEO = 5,
-
     FACE = 6,
-
     REPLY = 7,
-
+    GreyTip = 8, // “小灰条”，包括拍一拍 (Poke)、撤回提示等
     WALLET = 9,
-
-    /**
-     * “小灰条”，包括拍一拍 (Poke)、撤回提示等
-     */
-    GreyTip = 8,
-
     ARK = 10,
-
     MFACE = 11,
-
     LIVEGIFT = 12,
-
     STRUCTLONGMSG = 13,
-
     MARKDOWN = 14,
-
     GIPHY = 15,
-
     MULTIFORWARD = 16,
-
     INLINEKEYBOARD = 17,
-
     INTEXTGIFT = 18,
-
     CALENDAR = 19,
-
     YOLOGAMERESULT = 20,
-
     AVRECORD = 21,
-
     FEED = 22,
-
     TOFURECORD = 23,
-
     ACEBUBBLE = 24,
-
     ACTIVITY = 25,
-
     TOFU = 26,
-
     FACEBUBBLE = 27,
-
     SHARELOCATION = 28,
-
     TASKTOPMSG = 29,
-
     RECOMMENDEDMSG = 43,
-
     ACTIONBAR = 44
 }
 
+type ElementFullBase = Omit<MessageElement, 'elementType' | 'elementId' | 'extBufForUI'>;
+
+type ElementBase<
+    K extends keyof ElementFullBase,
+    S extends Partial<{ [P in K]: keyof NonNullable<ElementFullBase[P]> | Array<keyof NonNullable<ElementFullBase[P]>> }> = {}
+> = {
+    [P in K]:
+    S[P] extends Array<infer U>
+        ? Pick<NonNullable<ElementFullBase[P]>, U & keyof NonNullable<ElementFullBase[P]>>
+        : S[P] extends keyof NonNullable<ElementFullBase[P]>
+            ? Pick<NonNullable<ElementFullBase[P]>, S[P]>
+            : NonNullable<ElementFullBase[P]>;
+};
+
+export interface SendElementBase<ET extends ElementType> {
+    elementType: ET;
+    elementId: string;
+    extBufForUI?: string;
+}
+
 export interface ActionBarElement {
     rows: InlineKeyboardRow[];
     botAppid: string;
 }
 
-export interface SendActionBarElement {
-    elementType: ElementType.ACTIONBAR;
-    elementId: string;
-    actionBarElement: ActionBarElement;
-}
-
 export interface RecommendedMsgElement {
     rows: InlineKeyboardRow[];
     botAppid: string;
 }
 
-export interface SendRecommendedMsgElement {
+export type SendRecommendedMsgElement = SendElementBase<ElementType.RECOMMENDEDMSG> & ElementBase<'recommendedMsgElement'>;
-    elementType: ElementType.RECOMMENDEDMSG;
-    elementId: string;
-    recommendedMsgElement: RecommendedMsgElement;
-}
 
 export interface InlineKeyboardButton {
     id: string;
@@ -171,11 +147,7 @@ export enum NTMsgType {
     KMSGTYPEWALLET = 10
 }
 
-export interface SendTaskTopMsgElement {
+export type SendTaskTopMsgElement = SendElementBase<ElementType.TASKTOPMSG> & ElementBase<'taskTopMsgElement'>;
-    elementType: ElementType.TASKTOPMSG;
-    elementId: string;
-    taskTopMsgElement: TaskTopMsgElement;
-}
 
 export interface TofuRecordElement {
     type: number;
@@ -194,11 +166,7 @@ export interface TofuRecordElement {
     onscreennotify: boolean;
 }
 
-export interface SendTofuRecordElement {
+export type SendTofuRecordElement = SendElementBase<ElementType.TOFURECORD> & ElementBase<'tofuRecordElement'>;
-    elementType: ElementType.TOFURECORD;
-    elementId: string;
-    tofuRecordElement: TofuRecordElement;
-}
 
 export interface FaceBubbleElement {
     faceCount: number;
@@ -216,12 +184,7 @@ export interface FaceBubbleElement {
     };
 }
 
-export interface SendFaceBubbleElement {
+export type SendFaceBubbleElement = SendElementBase<ElementType.FACEBUBBLE> & ElementBase<'faceBubbleElement'>;
-    elementType: ElementType.FACEBUBBLE;
-    elementId: string;
-    faceBubbleElement: FaceBubbleElement;
-
-}
 
 export interface AvRecordElement {
     type: number;
@@ -232,11 +195,7 @@ export interface AvRecordElement {
     extraType: number;
 }
 
-export interface SendavRecordElement {
+export type SendAvRecordElement = SendElementBase<ElementType.AVRECORD> & ElementBase<'avRecordElement'>;
-    elementType: ElementType.AVRECORD;
-    elementId: string;
-    avRecordElement: AvRecordElement;
-}
 
 export interface YoloUserInfo {
     uid: string;
@@ -245,24 +204,13 @@ export interface YoloUserInfo {
     bizId: string;
 }
 
-export interface SendInlineKeyboardElement {
+export type SendInlineKeyboardElement = SendElementBase<ElementType.INLINEKEYBOARD> & ElementBase<'inlineKeyboardElement'>;
-    elementType: ElementType.INLINEKEYBOARD;
-    elementId: string;
-    inlineKeyboardElement: {
-        rows: number;
-        botAppid: string;
-    };
-
-}
 
 export interface YoloGameResultElement {
     UserInfo: YoloUserInfo[];
 }
 
-export interface SendYoloGameResultElement {
+export type SendYoloGameResultElement = SendElementBase<ElementType.YOLOGAMERESULT> & ElementBase<'yoloGameResultElement'>;
-    elementType: ElementType.YOLOGAMERESULT;
-    yoloGameResultElement: YoloGameResultElement;
-}
 
 export interface GiphyElement {
     id: string;
@@ -271,17 +219,9 @@ export interface GiphyElement {
     height: number;
 }
 
-export interface SendGiphyElement {
+export type SendGiphyElement = SendElementBase<ElementType.GIPHY> & ElementBase<'giphyElement'>;
-    elementType: ElementType.GIPHY;
-    elementId: string;
-    giphyElement: GiphyElement;
-}
 
-export interface SendWalletElement {
+export type SendWalletElement = SendElementBase<ElementType.UNKNOWN> & ElementBase<'walletElement'>;
-    elementType: ElementType.UNKNOWN;//不做 设置位置
-    elementId: string;
-    walletElement: Record<string, never>;
-}
 
 export interface CalendarElement {
     summary: string;
@@ -291,49 +231,16 @@ export interface CalendarElement {
     schema: string;
 }
 
-export interface SendCalendarElement {
+export type SendCalendarElement = SendElementBase<ElementType.CALENDAR> & ElementBase<'calendarElement'>;
-    elementType: ElementType.CALENDAR;
-    elementId: string;
-    calendarElement: CalendarElement;
-}
 
-export interface SendliveGiftElement {
+export type SendLiveGiftElement = SendElementBase<ElementType.LIVEGIFT> & ElementBase<'liveGiftElement'>;
-    elementType: ElementType.LIVEGIFT;
-    elementId: string;
-    liveGiftElement: Record<string, never>;
-}
 
-export interface SendTextElement {
+export type SendTextElement = SendElementBase<ElementType.TEXT> & ElementBase<'textElement'>;
-    elementType: ElementType.TEXT;
-    elementId: string;
-    textElement: {
-        content: string;
-        atType: number;
-        atUid: string;
-        atTinyId: string;
-        atNtUid: string;
-    };
-}
 
-export interface SendPttElement {
+export type SendPttElement = SendElementBase<ElementType.PTT> & ElementBase<'pttElement', {
-    elementType: ElementType.PTT;
+    pttElement: ['fileName', 'filePath', 'md5HexStr', 'fileSize', 'duration', 'formatType', 'voiceType',
-    elementId: string;
+        'voiceChangeType', 'canConvert2Text', 'waveAmplitudes', 'fileSubId', 'playState', 'autoConvertText']
-    pttElement: {
+}>;
-        fileName: string;
-        filePath: string;
-        md5HexStr: string;
-        fileSize: number;
-        duration: number;  // 单位是秒
-        formatType: number;
-        voiceType: number;
-        voiceChangeType: number;
-        canConvert2Text: boolean;
-        waveAmplitudes: number[];
-        fileSubId: string;
-        playState: number;
-        autoConvertText: number;
-    };
-}
 
 export enum PicType {
     gif = 2000,
@@ -359,11 +266,7 @@ export enum NTMsgAtType {
     ATTYPEUNKNOWN = 0
 }
 
-export interface SendPicElement {
+export type SendPicElement = SendElementBase<ElementType.PIC> & ElementBase<'picElement'>;
-    elementType: ElementType.PIC;
-    elementId: string;
-    picElement: PicElement;
-}
 
 export interface ReplyElement {
     sourceMsgIdInRecords?: string;
@@ -375,53 +278,27 @@ export interface ReplyElement {
     replyMsgClientSeq?: string;
 }
 
-export interface SendReplyElement {
+export type SendReplyElement = SendElementBase<ElementType.REPLY> & ElementBase<'replyElement'>;
-    elementType: ElementType.REPLY;
-    elementId: string;
-    replyElement: ReplyElement;
-}
 
-export interface SendFaceElement {
+export type SendFaceElement = SendElementBase<ElementType.FACE> & ElementBase<'faceElement'>;
-    elementType: ElementType.FACE;
-    elementId: string;
-    faceElement: FaceElement;
-}
 
-export interface SendMarketFaceElement {
+export type SendMarketFaceElement = SendElementBase<ElementType.MFACE> & ElementBase<'marketFaceElement'>;
-    elementType: ElementType.MFACE;
-    marketFaceElement: MarketFaceElement;
-}
 
-export interface SendStructLongMsgElement {
+export type SendStructLongMsgElement = SendElementBase<ElementType.STRUCTLONGMSG> & ElementBase<'structLongMsgElement'>;
-    elementType: ElementType.STRUCTLONGMSG;
-    elementId: string;
-    structLongMsgElement: StructLongMsgElement;
-}
 
 export interface StructLongMsgElement {
     xmlContent: string;
     resId: string;
 }
 
-export interface SendactionBarElement {
+export type SendActionBarElement = SendElementBase<ElementType.ACTIONBAR> & ElementBase<'actionBarElement'>;
-    elementType: ElementType.ACTIONBAR;
-    elementId: string;
-    actionBarElement: {
-        rows: number;
-        botAppid: string;
-    };
-}
 
 export interface ShareLocationElement {
     text: string;
     ext: string;
 }
 
-export interface SendShareLocationElement {
+export type SendShareLocationElement = SendElementBase<ElementType.SHARELOCATION> & ElementBase<'shareLocationElement'>;
-    elementType: ElementType.SHARELOCATION;
-    elementId: string;
-    shareLocationElement?: ShareLocationElement;
-}
 
 export interface FileElement {
     fileMd5?: string;
@@ -441,29 +318,13 @@ export interface FileElement {
     fileBizId?: number;
 }
 
-export interface SendFileElement {
+export type SendFileElement = SendElementBase<ElementType.FILE> & ElementBase<'fileElement'>;
-    elementType: ElementType.FILE;
-    elementId: string;
-    fileElement: FileElement;
-}
 
-export interface SendVideoElement {
+export type SendVideoElement = SendElementBase<ElementType.VIDEO> & ElementBase<'videoElement'>;
-    elementType: ElementType.VIDEO;
-    elementId: string;
-    videoElement: VideoElement;
-}
 
-export interface SendArkElement {
+export type SendArkElement = SendElementBase<ElementType.ARK> & ElementBase<'arkElement'>;
-    elementType: ElementType.ARK;
-    elementId: string;
-    arkElement: ArkElement;
-}
 
-export interface SendMarkdownElement {
+export type SendMarkdownElement = SendElementBase<ElementType.MARKDOWN> & ElementBase<'markdownElement'>;
-    elementType: ElementType.MARKDOWN;
-    elementId: string;
-    markdownElement: MarkdownElement;
-}
 
 export type SendMessageElement = SendTextElement | SendPttElement |
     SendPicElement | SendReplyElement | SendFaceElement | SendMarketFaceElement | SendFileElement |
@@ -480,7 +341,7 @@ export interface TextElement {
 export interface MessageElement {
     elementType: ElementType,
     elementId: string,
-    extBufForUI: string,//"0x",
+    extBufForUI?: string, //"0x",
     textElement?: TextElement;
     faceElement?: FaceElement,
     marketFaceElement?: MarketFaceElement,
@@ -509,7 +370,6 @@ export interface MessageElement {
     taskTopMsgElement?: TaskTopMsgElement,
     recommendedMsgElement?: RecommendedMsgElement,
     actionBarElement?: ActionBarElement
-
 }
 
 export enum AtType {
@@ -578,7 +438,7 @@ export interface PttElement {
     fileSize: string; // "4261"
     fileSubId: string; // "0"
     fileUuid: string; // "90j3z7rmRphDPrdVgP9udFBaYar#oK0TWZIV"
-    formatType: string; // 1
+    formatType: number; // 1
     invalidState: number; // 0
     md5HexStr: string; // "e4d09c784d5a2abcb2f9980bdc7acfe6"
     playState: number; // 0
@@ -589,6 +449,7 @@ export interface PttElement {
     voiceChangeType: number; // 0
     voiceType: number; // 0
     waveAmplitudes: number[];
+    autoConvertText: number;
 }
 
 export interface ArkElement {
@@ -794,7 +655,8 @@ export interface InlineKeyboardElementRowButton {
 export interface InlineKeyboardElement {
     rows: [{
         buttons: InlineKeyboardElementRowButton[]
-    }];
+    }],
+    botAppid: string;
 }
 
 export interface TipAioOpGrayTipElement {  // 这是什么提示来着？

src/core/packet/msg/converter.ts

@@ -1,4 +1,6 @@
 import {
+    ChatType,
+    ElementType,
     MessageElement,
     RawMessage,
     SendArkElement,
@@ -28,30 +30,42 @@ import {
     PacketMsgVideoElement,
     PacketMultiMsgElement
 } from "@/core/packet/msg/element";
-import { PacketMsg, PacketSendMsgElement } from "@/core/packet/msg/message";
+import {PacketMsg, PacketSendMsgElement} from "@/core/packet/msg/message";
-import { LogWrapper } from "@/common/log";
+import {LogWrapper} from "@/common/log";
 
-type SendMessageElementMap = {
+const SupportedElementTypes = [
-    textElement: SendTextElement,
+    ElementType.TEXT,
-    picElement: SendPicElement,
+    ElementType.PIC,
-    replyElement: SendReplyElement,
+    ElementType.REPLY,
-    faceElement: SendFaceElement,
+    ElementType.FACE,
-    marketFaceElement: SendMarketFaceElement,
+    ElementType.MFACE,
-    videoElement: SendVideoElement,
+    ElementType.VIDEO,
-    fileElement: SendFileElement,
+    ElementType.FILE,
-    pttElement: SendPttElement,
+    ElementType.PTT,
-    arkElement: SendArkElement,
+    ElementType.ARK,
-    markdownElement: SendMarkdownElement,
+    ElementType.MARKDOWN,
-    structLongMsgElement: SendStructLongMsgElement
+    ElementType.STRUCTLONGMSG
+];
+
+type SendMessageTypeElementMap = {
+    [ElementType.TEXT]: SendTextElement,
+    [ElementType.PIC]: SendPicElement,
+    [ElementType.FILE]: SendFileElement,
+    [ElementType.PTT]: SendPttElement,
+    [ElementType.VIDEO]: SendVideoElement,
+    [ElementType.FACE]: SendFaceElement,
+    [ElementType.REPLY]: SendReplyElement,
+    [ElementType.ARK]: SendArkElement,
+    [ElementType.MFACE]: SendMarketFaceElement,
+    [ElementType.STRUCTLONGMSG]: SendStructLongMsgElement,
+    [ElementType.MARKDOWN]: SendMarkdownElement,
 };
 
-type RawToPacketMsgConverters = {
+type ElementToPacketMsgConverters = {
-    [K in keyof SendMessageElementMap]: (
+    [K in keyof SendMessageTypeElementMap]: (
-        element: SendMessageElementMap[K],
+        sendElement: MessageElement
-        msg?: RawMessage,
+    ) => IPacketMsgElement<SendMessageTypeElementMap[K]>;
-        elementWrapper?: MessageElement,
+}
-    ) => IPacketMsgElement<SendMessageElementMap[K]> | null;
-};
 
 export type rawMsgWithSendMsg = {
     senderUin: number;
@@ -69,6 +83,10 @@ export class PacketMsgConverter {
         this.logger = logger;
     }
 
+    private isValidElementType(type: ElementType): type is keyof ElementToPacketMsgConverters {
+        return SupportedElementTypes.includes(type);
+    }
+
     rawMsgWithSendMsgToPacketMsg(msg: rawMsgWithSendMsg): PacketMsg {
         return {
             senderUid: msg.senderUid ?? '',
@@ -77,55 +95,64 @@ export class PacketMsgConverter {
             groupId: msg.groupId,
             time: msg.time,
             msg: msg.msg.map((element) => {
-                const key = (Object.keys(this.rawToPacketMsgConverters) as Array<keyof SendMessageElementMap>).find(
+                if (!this.isValidElementType(element.elementType)) return null;
-                    (k) => (element as any)[k] !== undefined  // TODO:
+                return this.rawToPacketMsgConverters[element.elementType](element as MessageElement);
-                );
-                if (key) {
-                    const elementData = (element as any)[key];  // TODO:
-                    if (elementData) return this.rawToPacketMsgConverters[key](element as any);
-                }
-                return null;
             }).filter((e) => e !== null)
         };
     }
 
-    private rawToPacketMsgConverters: RawToPacketMsgConverters = {
+    rawMsgToPacketMsg(msg: RawMessage): PacketMsg {
-        textElement: (element: SendTextElement) => {
+        return {
-            if (element.textElement.atType) {
+            seq: +msg.msgSeq,
-                return new PacketMsgAtElement(element);
+            groupId: msg.chatType === ChatType.KCHATTYPEGROUP ? +msg.parentMsgPeer.peerUid : undefined,
+            senderUid: msg.senderUid,
+            senderUin: +msg.senderUin,
+            senderName: msg.sendMemberName ?? msg.sendRemarkName ?? msg.sendNickName ?? 'QQ用户',
+            time: +msg.msgTime,
+            msg: msg.elements.map((element) => {
+                if (!this.isValidElementType(element.elementType)) return null;
+                return this.rawToPacketMsgConverters[element.elementType](element);
+            }).filter((e) => e !== null)
+        }
+    }
+
+    private rawToPacketMsgConverters: ElementToPacketMsgConverters = {
+        [ElementType.TEXT]: (element) => {
+            if (element.textElement?.atType) {
+                return new PacketMsgAtElement(element as SendTextElement);
             }
-            return new PacketMsgTextElement(element);
+            return new PacketMsgTextElement(element as SendTextElement);
         },
-        picElement: (element: SendPicElement) => {
+        [ElementType.PIC]: (element) => {
-            return new PacketMsgPicElement(element);
+            return new PacketMsgPicElement(element as SendPicElement);
         },
-        replyElement: (element: SendReplyElement) => {
+        [ElementType.REPLY]: (element) => {
-            return new PacketMsgReplyElement(element);
+            return new PacketMsgReplyElement(element as SendReplyElement);
         },
-        faceElement: (element: SendFaceElement) => {
+        [ElementType.FACE]: (element) => {
-            return new PacketMsgFaceElement(element);
+            return new PacketMsgFaceElement(element as SendFaceElement);
         },
-        marketFaceElement: (element: SendMarketFaceElement) => {
+        [ElementType.MFACE]: (element) => {
-            return new PacketMsgMarkFaceElement(element);
+            return new PacketMsgMarkFaceElement(element as SendMarketFaceElement);
         },
-        videoElement: (element: SendVideoElement) => {
+        [ElementType.VIDEO]: (element) => {
-            return new PacketMsgVideoElement(element);
+            return new PacketMsgVideoElement(element as SendVideoElement);
         },
-        fileElement: (element: SendFileElement) => {
+        [ElementType.FILE]: (element) => {
-            return new PacketMsgFileElement(element);
+            return new PacketMsgFileElement(element as SendFileElement);
         },
-        pttElement: (element: SendPttElement) => {
+        [ElementType.PTT]: (element) => {
-            return new PacketMsgPttElement(element);
+            return new PacketMsgPttElement(element as SendPttElement);
         },
-        arkElement: (element: SendArkElement) => {
+        [ElementType.ARK]: (element) => {
-            return new PacketMsgLightAppElement(element);
+            return new PacketMsgLightAppElement(element as SendArkElement);
         },
-        markdownElement: (element: SendMarkdownElement) => {
+        [ElementType.MARKDOWN]: (element) => {
-            return new PacketMsgMarkDownElement(element);
+            return new PacketMsgMarkDownElement(element as SendMarkdownElement);
         },
         // TODO: check this logic, move it in arkElement?
-        structLongMsgElement: (element: SendStructLongMsgElement) => {
+        [ElementType.STRUCTLONGMSG]: (element) => {
-            return new PacketMultiMsgElement(element);
+            return new PacketMultiMsgElement(element as SendStructLongMsgElement);
         }
     };
 }

src/onebot/api/msg.ts

@@ -466,6 +466,7 @@ export class OneBotMsgApi {
             },
         }) => ({
             elementType: ElementType.MFACE,
+            elementId: '',
             marketFaceElement: {
                 emojiPackageId: emoji_package_id,
                 emojiId: emoji_id,