@neelegirly/baileys 2.2.16

package/lib/Utils/decode-wa-message.js

@@ -0,0 +1,288 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const boom_1 = require("@hapi/boom")
+const WAProto_1 = require("../../WAProto")
+const WABinary_1 = require("../WABinary")
+const generics_1 = require("./generics")
+const messages_1 = require("./messages") 
+
+const NO_MESSAGE_FOUND_ERROR_TEXT = 'Message absent from node'
+
+const MISSING_KEYS_ERROR_TEXT = 'Key used already or never filled'
+
+const NACK_REASONS = {
+    ParsingError: 487,
+    UnrecognizedStanza: 488,
+    UnrecognizedStanzaClass: 489,
+    UnrecognizedStanzaType: 490,
+    InvalidProtobuf: 491,
+    InvalidHostedCompanionStanza: 493,
+    MissingMessageSecret: 495,
+    SignalErrorOldCounter: 496,
+    MessageDeletedOnPeer: 499,
+    UnhandledError: 500,
+    UnsupportedAdminRevoke: 550,
+    UnsupportedLIDGroup: 551,
+    DBOperationFailed: 552
+}
+
+/**
+ * Decode the received node as a message.
+ * @note this will only parse the message, not decrypt it
+ */
+function decodeMessageNode(stanza, meId, meLid) {
+    let msgType
+    let chatId
+    let author
+    const msgId = stanza.attrs.id
+    const from = stanza.attrs.from
+    let participant = stanza.attrs.participant 
+     if (participant && participant.endsWith('@lid') && stanza.attrs.participant_pn) {
+        participant = stanza.attrs.participant_pn;
+    }
+    const recipient = stanza.attrs.recipient
+    const isMe = (jid) => WABinary_1.areJidsSameUser(jid, meId)
+    const isMeLid = (jid) => WABinary_1.areJidsSameUser(jid, meLid)
+    if (WABinary_1.isJidUser(from)) {
+        if (recipient) {
+            if (!isMe(from)) {
+                throw new boom_1.Boom('receipient present, but msg not from me', { data: stanza })
+            }
+            chatId = recipient
+        }
+        else {
+            chatId = from
+        }
+        msgType = 'chat'
+        author = from
+    }
+    else if (WABinary_1.isLidUser(from)) {
+        if (recipient) {
+            if (!isMeLid(from)) {
+                throw new boom_1.Boom('receipient present, but msg not from me', { data: stanza })
+            }
+            chatId = recipient
+        }
+        else {
+            chatId = from
+        }
+        msgType = 'chat'
+        author = from
+    }
+    else if (WABinary_1.isJidGroup(from)) {
+        if (!participant) {
+            throw new boom_1.Boom('No participant in group message')
+        }
+        msgType = 'group'
+        author = participant
+        chatId = from
+    }
+    else if (WABinary_1.isJidBroadcast(from)) {
+        if (!participant) {
+            throw new boom_1.Boom('No participant in group message')
+        }
+        const isParticipantMe = isMe(participant)
+        if (WABinary_1.isJidStatusBroadcast(from)) {
+            msgType = isParticipantMe ? 'direct_peer_status' : 'other_status'
+        }
+        else {
+            msgType = isParticipantMe ? 'peer_broadcast' : 'other_broadcast'
+        }
+        chatId = from
+        author = participant
+    }
+    else if (WABinary_1.isJidNewsletter(from)) {
+        msgType = 'newsletter'
+        chatId = from
+        author = from
+    }
+    else {
+        throw new boom_1.Boom('Unknown message type', { data: stanza })
+    }
+     const senderJid = stanza.attrs.participant || stanza.attrs.from;
+
+const fromMe = WABinary_1.isJidNewsletter(stanza.attrs.from)
+    ? !!stanza.attrs?.is_sender
+    : WABinary_1.isLidUser(senderJid)
+        ? (0, WABinary_1.areJidsSameUser)(senderJid, meLid)
+        : (0, WABinary_1.areJidsSameUser)(senderJid, meId);
+
+    const pushname = stanza?.attrs?.notify
+    const key = {
+        remoteJid: chatId,
+        fromMe,
+        id: msgId,
+        ...(participant !== undefined && { participant: fromMe ? meId : participant }),
+        ...(stanza.attrs.participant_pn !== undefined && { participant_pn: fromMe ? meId : stanza.attrs.participant_pn }),
+        ...(stanza.attrs.participant_lid !== undefined && { participant_lid: fromMe ? meLid : stanza.attrs.participant_lid }),
+    }
+    const fullMessage = {
+        key,
+        messageTimestamp: +stanza.attrs.t,
+        pushName: pushname,
+        broadcast: WABinary_1.isJidBroadcast(from), 
+        newsletter: WABinary_1.isJidNewsletter(from),
+        additionalAttributes: stanza.attrs
+    }
+    if (msgType === 'newsletter') {
+        fullMessage.newsletter_server_id  = +stanza.attrs?.server_id
+    }
+    if (key.fromMe) {
+        fullMessage.status = WAProto_1.proto.WebMessageInfo.Status.SERVER_ACK
+    }
+    if (!key.fromMe) {
+        fullMessage.platform = messages_1.getDevice(key.id) 
+    }
+    return {
+        fullMessage,
+        author,
+        sender: msgType === 'chat' ? author : chatId
+    }
+}
+
+const decryptMessageNode = (stanza, meId, meLid, repository, logger) => {
+    const { fullMessage, author, sender } = decodeMessageNode(stanza, meId, meLid)
+    return {
+        fullMessage,
+        category: stanza.attrs.category,
+        author,
+        async decrypt() {
+            const normalizeDecryptJid = (jid = '') => {
+                const value = String(jid || '').trim()
+                if (!value || !value.includes('@')) {
+                    return ''
+                }
+                return WABinary_1.jidNormalizedUser(value)
+            }
+            let decryptables = 0
+            if (Array.isArray(stanza.content)) {
+                for (const { tag, attrs, content } of stanza.content) {
+                    if (tag === 'verified_name' && content instanceof Uint8Array) {
+                        const cert = WAProto_1.proto.VerifiedNameCertificate.decode(content)
+                        const details = WAProto_1.proto.VerifiedNameCertificate.Details.decode(cert.details)
+                        fullMessage.verifiedBizName = details.verifiedName
+                    }
+                    if (tag === 'multicast' && content instanceof Uint8Array) {
+                    	fullMessage.multicast = true
+                    }
+                    if (tag === 'meta' && content instanceof Uint8Array) {
+                        fullMessage.metaInfo = {
+                            targetID: attrs.target_id
+                        }
+                        if (attrs.target_sender_jid) {
+                            fullMessage.metaInfo.targetSender = WABinary_1.jidNormalizedUser(attrs.target_sender_jid)
+                        }
+                    }
+                    if (tag === 'bot' && content instanceof Uint8Array) {
+                    	if (attrs.edit) {
+                    	    fullMessage.botInfo = {
+                    	        editType: attrs.edit, 
+                                editTargetID: attrs.edit_target_id, 
+                                editSenderTimestampMS: attrs.sender_timestamp_ms
+                            }
+                        }
+                    }
+                    if (tag !== 'enc' && tag !== 'plaintext') {
+                        continue
+                    }
+                    if (!(content instanceof Uint8Array)) {
+                        continue
+                    }
+                    decryptables += 1
+                    let msgBuffer
+                    try {
+                        const e2eType = tag === 'plaintext' ? 'plaintext' : attrs.type
+                        switch (e2eType) {
+                            case 'skmsg':
+                                msgBuffer = await repository.decryptGroupMessage({
+                                    group: sender,
+                                    authorJid: author,
+                                    msg: content
+                                })
+                                break
+                            case 'pkmsg':
+                            case 'msg':
+                                {
+                                    const primaryUser = WABinary_1.isJidUser(sender) ? sender : author
+                                    const pnCandidate = normalizeDecryptJid(
+                                        stanza.attrs.sender_pn ||
+                                        stanza.attrs.peer_recipient_pn ||
+                                        stanza.attrs.participant_pn ||
+                                        fullMessage.key?.participant_pn ||
+                                        ''
+                                    )
+                                    const decryptCandidates = Array.from(new Set([
+                                        normalizeDecryptJid(primaryUser),
+                                        pnCandidate
+                                    ].filter(Boolean)))
+                                    let lastDecryptError = null
+
+                                    for (const candidate of decryptCandidates) {
+                                        try {
+                                            msgBuffer = await repository.decryptMessage({
+                                                jid: candidate,
+                                                type: e2eType,
+                                                ciphertext: content
+                                            })
+                                            lastDecryptError = null
+                                            break
+                                        }
+                                        catch (error) {
+                                            lastDecryptError = error
+                                        }
+                                    }
+
+                                    if (lastDecryptError) {
+                                        throw lastDecryptError
+                                    }
+                                }
+                                break
+                            case 'plaintext':
+                                msgBuffer = content
+                                break
+                            default:
+                                throw new Error(`Unknown e2e type: ${e2eType}`)
+                        }
+                        let msg = WAProto_1.proto.Message.decode(e2eType !== 'plaintext' ? generics_1.unpadRandomMax16(msgBuffer) : msgBuffer)
+                        msg = msg.deviceSentMessage?.message || msg
+                        if (msg.senderKeyDistributionMessage) {
+                            //eslint-disable-next-line max-depth
+                            try {
+                                await repository.processSenderKeyDistributionMessage({
+                                    authorJid: author,
+                                    item: msg.senderKeyDistributionMessage
+                                })
+                            }
+                            catch (err) {
+                                logger.error({ key: fullMessage.key, err }, 'failed to decrypt message')
+                            }
+                        }
+                        if (fullMessage.message) {
+                            Object.assign(fullMessage.message, msg)
+                        }
+                        else {
+                            fullMessage.message = msg
+                        }
+                    }
+                    catch (err) {
+                        logger.error({ key: fullMessage.key, err }, 'failed to decrypt message')
+                        fullMessage.messageStubType = WAProto_1.proto.WebMessageInfo.StubType.CIPHERTEXT
+                        fullMessage.messageStubParameters = [err.message]
+                    }
+                }
+            }
+            // if nothing was found to decrypt
+            if (!decryptables) {
+                fullMessage.messageStubType = WAProto_1.proto.WebMessageInfo.StubType.CIPHERTEXT
+                fullMessage.messageStubParameters = [NO_MESSAGE_FOUND_ERROR_TEXT]
+            }
+        }
+    }
+}
+
+module.exports = {
+  decodeMessageNode, 
+  decryptMessageNode
+}

package/lib/Utils/event-buffer.d.ts

@@ -0,0 +1,39 @@
+import { BaileysEventEmitter, BaileysEventMap } from '../Types'
+import { ILogger } from './logger'
+
+/**
+ * A map that contains a list of all events that have been triggered
+ *
+ * Note, this can contain different type of events
+ * this can make processing events extremely efficient -- since everything
+ * can be done in a single transaction
+ */
+type BaileysEventData = Partial<BaileysEventMap>
+
+type BaileysBufferableEventEmitter = BaileysEventEmitter & {
+    /** Use to process events in a batch */
+    process(handler: (events: BaileysEventData) => void | Promise<void>): (() => void)
+    /**
+     * starts buffering events, call flush() to release them
+     * */
+    buffer(): void
+    /** buffers all events till the promise completes */
+    createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): ((...args: A) => Promise<T>)
+    /**
+     * flushes all buffered events
+     * @param force if true, will flush all data regardless of any pending buffers
+     * @returns returns true if the flush actually happened, otherwise false
+     */
+    flush(force?: boolean): boolean
+    /** is there an ongoing buffer */
+    isBuffering(): boolean
+}
+
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ * @param ev the baileys event emitter
+ */
+export declare const makeEventBuffer: (logger: ILogger) => BaileysBufferableEventEmitter
+
+export {}