@neelegirl/baileys 1.5.5 → 1.5.7

package/lib/Utils/event-buffer.js

@@ -0,0 +1,565 @@
+"use strict"
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod }
+}
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const events_1 = __importDefault(require("events"))
+const Types_1 = require("../Types")
+const generics_1 = require("./generics")
+const messages_1 = require("./messages")
+const process_message_1 = require("./process-message")
+
+const BUFFERABLE_EVENT = [
+    'messaging-history.set',
+    'chats.upsert',
+    'chats.update',
+    'chats.delete',
+    'contacts.upsert',
+    'contacts.update',
+    'messages.upsert',
+    'messages.update',
+    'messages.delete',
+    //'messages.poll', 
+    'messages.reaction',
+    'message-receipt.update',
+    'groups.update',
+    'communities.update',
+]
+
+const BUFFERABLE_EVENT_SET = new Set(BUFFERABLE_EVENT)
+
+/**
+ * The event buffer logically consolidates different events into a single event
+ * making the data processing more efficient.
+ * @param ev the baileys event emitter
+ */
+const makeEventBuffer = (logger) => {
+    const ev = new events_1.default()
+    const historyCache = new Set()
+    let data = makeBufferData()
+    let buffersInProgress = 0
+    // take the generic event and fire it as a baileys event
+    ev.on('event', (map) => {
+        for (const event in map) {
+            ev.emit(event, map[event])
+        }
+    })
+    function buffer() {
+        buffersInProgress += 1
+    }
+    function flush(force = false) {
+        // no buffer going on
+        if (!buffersInProgress) {
+            return false
+        }
+        if (!force) {
+            // reduce the number of buffers in progress
+            buffersInProgress -= 1
+            // if there are still some buffers going on
+            // then we don't flush now
+            if (buffersInProgress) {
+                return false
+            }
+        }
+        const newData = makeBufferData()
+        const chatUpdates = Object.values(data.chatUpdates)
+        // gather the remaining conditional events so we re-queue them
+        let conditionalChatUpdatesLeft = 0
+        for (const update of chatUpdates) {
+            if (update.conditional) {
+                conditionalChatUpdatesLeft += 1
+                newData.chatUpdates[update.id] = update
+                delete data.chatUpdates[update.id]
+            }
+        }
+        const consolidatedData = consolidateEvents(data)
+        if (Object.keys(consolidatedData).length) {
+            ev.emit('event', consolidatedData)
+        }
+        data = newData
+        logger.trace({ conditionalChatUpdatesLeft }, 'released buffered events')
+        return true
+    }
+    return {
+        process(handler) {
+            const listener = (map) => {
+                handler(map)
+            }
+            ev.on('event', listener)
+            return () => {
+                ev.off('event', listener)
+            }
+        },
+        emit(event, evData) {
+            if (buffersInProgress && BUFFERABLE_EVENT_SET.has(event)) {
+                append(data, historyCache, event, evData, logger)
+                return true
+            }
+            return ev.emit('event', { [event]: evData })
+        },
+        isBuffering() {
+            return buffersInProgress > 0
+        },
+        buffer,
+        flush,
+        createBufferedFunction(work) {
+            return async (...args) => {
+                buffer()
+                try {
+                    const result = await work(...args)
+                    return result
+                }
+                finally {
+                    flush()
+                }
+            }
+        },
+        on: (...args) => ev.on(...args),
+        off: (...args) => ev.off(...args),
+        removeAllListeners: (...args) => ev.removeAllListeners(...args),
+    }
+}
+
+const makeBufferData = () => {
+    return {
+        historySets: {
+            chats: {},
+            messages: {},
+            contacts: {},
+            isLatest: false,
+            empty: true
+        },
+        chatUpserts: {},
+        chatUpdates: {},
+        chatDeletes: new Set(),
+        contactUpserts: {},
+        contactUpdates: {},
+        messageUpserts: {},
+        messageUpdates: {},
+        //messagePollings: {}, 
+        messageReactions: {},
+        messageDeletes: {},
+        messageReceipts: {},
+        groupUpdates: {},
+        communityUpdates: {}
+    }
+}
+
+function append(data, historyCache, event, eventData, logger) {
+    var _a, _b, _c
+    switch (event) {
+        case 'messaging-history.set':
+            for (const chat of eventData.chats) {
+                const existingChat = data.historySets.chats[chat.id]
+                if (existingChat) {
+                    existingChat.endOfHistoryTransferType = chat.endOfHistoryTransferType
+                }
+                if (!existingChat && !historyCache.has(chat.id)) {
+                    data.historySets.chats[chat.id] = chat
+                    historyCache.add(chat.id)
+                    absorbingChatUpdate(chat)
+                }
+            }
+            for (const contact of eventData.contacts) {
+                const existingContact = data.historySets.contacts[contact.id]
+                if (existingContact) {
+                    Object.assign(existingContact, generics_1.trimUndefined(contact))
+                }
+                else {
+                    const historyContactId = `c:${contact.id}`
+                    const hasAnyName = contact.notify || contact.name || contact.verifiedName
+                    if (!historyCache.has(historyContactId) || hasAnyName) {
+                        data.historySets.contacts[contact.id] = contact
+                        historyCache.add(historyContactId)
+                    }
+                }
+            }
+            for (const message of eventData.messages) {
+                const key = stringifyMessageKey(message.key)
+                const existingMsg = data.historySets.messages[key]
+                if (!existingMsg && !historyCache.has(key)) {
+                    data.historySets.messages[key] = message
+                    historyCache.add(key)
+                }
+            }
+            data.historySets.empty = false
+            data.historySets.syncType = eventData.syncType
+            data.historySets.progress = eventData.progress
+            data.historySets.peerDataRequestSessionId = eventData.peerDataRequestSessionId
+            data.historySets.isLatest = eventData.isLatest || data.historySets.isLatest
+            break
+        case 'chats.upsert':
+            for (const chat of eventData) {
+                let upsert = data.chatUpserts[chat.id]
+                if (!upsert) {
+                    upsert = data.historySets[chat.id]
+                    if (upsert) {
+                        logger.debug({ chatId: chat.id }, 'absorbed chat upsert in chat set')
+                    }
+                }
+                if (upsert) {
+                    upsert = concatChats(upsert, chat)
+                }
+                else {
+                    upsert = chat
+                    data.chatUpserts[chat.id] = upsert
+                }
+                absorbingChatUpdate(upsert)
+                if (data.chatDeletes.has(chat.id)) {
+                    data.chatDeletes.delete(chat.id)
+                }
+            }
+            break
+        case 'chats.update':
+            for (const update of eventData) {
+                const chatId = update.id
+                const conditionMatches = update.conditional ? update.conditional(data) : true
+                if (conditionMatches) {
+                    delete update.conditional
+                    // if there is an existing upsert, merge the update into it
+                    const upsert = data.historySets.chats[chatId] || data.chatUpserts[chatId]
+                    if (upsert) {
+                        concatChats(upsert, update)
+                    }
+                    else {
+                        // merge the update into the existing update
+                        const chatUpdate = data.chatUpdates[chatId] || {}
+                        data.chatUpdates[chatId] = concatChats(chatUpdate, update)
+                    }
+                }
+                else if (conditionMatches === undefined) {
+                    // condition yet to be fulfilled
+                    data.chatUpdates[chatId] = update
+                }
+                // otherwise -- condition not met, update is invalid
+                // if the chat has been updated
+                // ignore any existing chat delete
+                if (data.chatDeletes.has(chatId)) {
+                    data.chatDeletes.delete(chatId)
+                }
+            }
+            break
+        case 'chats.delete':
+            for (const chatId of eventData) {
+                if (!data.chatDeletes.has(chatId)) {
+                    data.chatDeletes.add(chatId)
+                }
+                // remove any prior updates & upserts
+                if (data.chatUpdates[chatId]) {
+                    delete data.chatUpdates[chatId]
+                }
+                if (data.chatUpserts[chatId]) {
+                    delete data.chatUpserts[chatId]
+                }
+                if (data.historySets.chats[chatId]) {
+                    delete data.historySets.chats[chatId]
+                }
+            }
+            break
+        case 'contacts.upsert':
+            for (const contact of eventData) {
+                let upsert = data.contactUpserts[contact.id]
+                if (!upsert) {
+                    upsert = data.historySets.contacts[contact.id]
+                    if (upsert) {
+                        logger.debug({ contactId: contact.id }, 'absorbed contact upsert in contact set')
+                    }
+                }
+                if (upsert) {
+                    upsert = Object.assign(upsert, generics_1.trimUndefined(contact))
+                }
+                else {
+                    upsert = contact
+                    data.contactUpserts[contact.id] = upsert
+                }
+                if (data.contactUpdates[contact.id]) {
+                    upsert = Object.assign(data.contactUpdates[contact.id], generics_1.trimUndefined(contact))
+                    delete data.contactUpdates[contact.id]
+                }
+            }
+            break
+        case 'contacts.update':
+            const contactUpdates = eventData
+            for (const update of contactUpdates) {
+                const id = update.id
+                // merge into prior upsert
+                const upsert = data.historySets.contacts[id] || data.contactUpserts[id]
+                if (upsert) {
+                    Object.assign(upsert, update)
+                }
+                else {
+                    // merge into prior update
+                    const contactUpdate = data.contactUpdates[id] || {}
+                    data.contactUpdates[id] = Object.assign(contactUpdate, update)
+                }
+            }
+            break
+        case 'messages.upsert':
+            const { messages, type } = eventData
+            for (const message of messages) {
+                const key = stringifyMessageKey(message.key)
+                let existing = (_a = data.messageUpserts[key]) === null || _a === void 0 ? void 0 : _a.message
+                if (!existing) {
+                    existing = data.historySets.messages[key]
+                    if (existing) {
+                        logger.debug({ messageId: key }, 'absorbed message upsert in message set')
+                    }
+                }
+                if (existing) {
+                    message.messageTimestamp = existing.messageTimestamp
+                }
+                if (data.messageUpdates[key]) {
+                    logger.debug('absorbed prior message update in message upsert')
+                    Object.assign(message, data.messageUpdates[key].update)
+                    delete data.messageUpdates[key]
+                }
+                if (data.historySets.messages[key]) {
+                    data.historySets.messages[key] = message
+                }
+                else {
+                    data.messageUpserts[key] = {
+                        message,
+                        type: type === 'notify' || ((_b = data.messageUpserts[key]) === null || _b === void 0 ? void 0 : _b.type) === 'notify'
+                            ? 'notify'
+                            : type
+                    }
+                }
+            }
+            break
+        case 'messages.update':
+            const msgUpdates = eventData
+            for (const { key, update } of msgUpdates) {
+                const keyStr = stringifyMessageKey(key)
+                const existing = data.historySets.messages[keyStr] || ((_c = data.messageUpserts[keyStr]) === null || _c === void 0 ? void 0 : _c.message)
+                if (existing) {
+                    Object.assign(existing, update)
+                    // if the message was received & read by us
+                    // the chat counter must have been incremented
+                    // so we need to decrement it
+                    if (update.status === Types_1.WAMessageStatus.READ && !key.fromMe) {
+                        decrementChatReadCounterIfMsgDidUnread(existing)
+                    }
+                }
+                else {
+                    const msgUpdate = data.messageUpdates[keyStr] || { key, update: {} }
+                    Object.assign(msgUpdate.update, update)
+                    data.messageUpdates[keyStr] = msgUpdate
+                }
+            }
+            break
+        case 'messages.delete':
+            const deleteData = eventData
+            if ('keys' in deleteData) {
+                const { keys } = deleteData
+                for (const key of keys) {
+                    const keyStr = stringifyMessageKey(key)
+                    if (!data.messageDeletes[keyStr]) {
+                        data.messageDeletes[keyStr] = key
+                    }
+                    if (data.messageUpserts[keyStr]) {
+                        delete data.messageUpserts[keyStr]
+                    }
+                    if (data.messageUpdates[keyStr]) {
+                        delete data.messageUpdates[keyStr]
+                    }
+                }
+            }
+            else {
+                // TODO: add support
+            }
+            break         
+        // case 'messages.poll':
+        //   const pollUpdates = eventData
+    	//   for(const { vote, pollUpdateMessageKey } of pollUpdates) {
+	    //      const keyStr = stringifyMessageKey(pollUpdateMessageKey) 
+		//      const existing = data.messagePollings[keyStr]
+		//      if(existing) {
+		//          messages_1.updateMessageWithPollUpdate(existing.message, pollUpdates) 
+	    //	  } else {
+		//          data.messagePollings[keyStr] = data.messagePollings[keyStr]
+		//	    	  || { pollUpdateMessageKey, pollUpdates: [] }
+		//    	  messages_1.updateMessageWithPollUpdate(data.messagePollings[keyStr], vote) 
+	    // 	  }
+	    //  }		
+		//  break
+        case 'messages.reaction':
+            const reactions = eventData
+            for (const { key, reaction } of reactions) {
+                const keyStr = stringifyMessageKey(key)
+                const existing = data.messageUpserts[keyStr]
+                if (existing) {
+                    messages_1.updateMessageWithReaction(existing.message, reaction)
+                }
+                else {
+                    data.messageReactions[keyStr] = data.messageReactions[keyStr]
+                        || { key, reactions: [] }
+                    messages_1.updateMessageWithReaction(data.messageReactions[keyStr], reaction)
+                }
+            }
+            break
+        case 'message-receipt.update':
+            const receipts = eventData
+            for (const { key, receipt } of receipts) {
+                const keyStr = stringifyMessageKey(key)
+                const existing = data.messageUpserts[keyStr]
+                if (existing) {
+                    messages_1.updateMessageWithReceipt(existing.message, receipt)
+                }
+                else {
+                    data.messageReceipts[keyStr] = data.messageReceipts[keyStr]
+                        || { key, userReceipt: [] }
+                    messages_1.updateMessageWithReceipt(data.messageReceipts[keyStr], receipt)
+                }
+            }
+            break
+        case 'groups.update':
+            const groupUpdates = eventData
+            for (const update of groupUpdates) {
+                const id = update.id
+                const groupUpdate = data.groupUpdates[id] || {}
+                if (!data.groupUpdates[id]) {
+                    data.groupUpdates[id] = Object.assign(groupUpdate, update)
+                }
+            }
+            break
+        case 'communities.update':
+            const communityUpdates = eventData
+            console.log('community updates', communityUpdates )
+            for (const update of communityUpdates) {
+                const id = update.id
+                const communityUpdate = data.communityUpdates[id] || {}
+                if (!data.communityUpdates[id]) {
+                    data.communityUpdates[id] = Object.assign(communityUpdate, update)
+                }
+            }
+            break
+        default:
+            throw new Error(`"${event}" cannot be buffered`)
+    }
+    function absorbingChatUpdate(existing) {
+        const chatId = existing.id
+        const update = data.chatUpdates[chatId]
+        if (update) {
+            const conditionMatches = update.conditional ? update.conditional(data) : true
+            if (conditionMatches) {
+                delete update.conditional
+                logger.debug({ chatId }, 'absorbed chat update in existing chat')
+                Object.assign(existing, concatChats(update, existing))
+                delete data.chatUpdates[chatId]
+            }
+            else if (conditionMatches === false) {
+                logger.debug({ chatId }, 'chat update condition fail, removing')
+                delete data.chatUpdates[chatId]
+            }
+        }
+    }
+    function decrementChatReadCounterIfMsgDidUnread(message) {
+        // decrement chat unread counter
+        // if the message has already been marked read by us
+        const chatId = message.key.remoteJid
+        const chat = data.chatUpdates[chatId] || data.chatUpserts[chatId]
+        if (process_message_1.isRealMessage(message, '')
+            && process_message_1.shouldIncrementChatUnread(message)
+            && typeof (chat?.unreadCount) === 'number'
+            && chat.unreadCount > 0) {
+            logger.debug({ chatId: chat.id }, 'decrementing chat counter')
+            chat.unreadCount -= 1
+            if (chat.unreadCount === 0) {
+                delete chat.unreadCount
+            }
+        }
+    }
+}
+function consolidateEvents(data) {
+    const map = {}
+    if (!data.historySets.empty) {
+        map['messaging-history.set'] = {
+            chats: Object.values(data.historySets.chats),
+            messages: Object.values(data.historySets.messages),
+            contacts: Object.values(data.historySets.contacts),
+            syncType: data.historySets.syncType,
+            progress: data.historySets.progress,
+            isLatest: data.historySets.isLatest,
+            peerDataRequestSessionId: data.historySets.peerDataRequestSessionId
+        }
+    }
+    const chatUpsertList = Object.values(data.chatUpserts)
+    if (chatUpsertList.length) {
+        map['chats.upsert'] = chatUpsertList
+    }
+    const chatUpdateList = Object.values(data.chatUpdates)
+    if (chatUpdateList.length) {
+        map['chats.update'] = chatUpdateList
+    }
+    const chatDeleteList = Array.from(data.chatDeletes)
+    if (chatDeleteList.length) {
+        map['chats.delete'] = chatDeleteList
+    }
+    const messageUpsertList = Object.values(data.messageUpserts)
+    if (messageUpsertList.length) {
+        const type = messageUpsertList[0].type
+        map['messages.upsert'] = {
+            messages: messageUpsertList.map(m => m.message),
+            type
+        }
+    }
+    const messageUpdateList = Object.values(data.messageUpdates)
+    if (messageUpdateList.length) {
+        map['messages.update'] = messageUpdateList
+    }
+    const messageDeleteList = Object.values(data.messageDeletes)
+    if (messageDeleteList.length) {
+        map['messages.delete'] = { keys: messageDeleteList }
+    }
+    //  const messagePollingList = Object.values(data.messagePollings).flatMap(({ vote, pollUpdateMessageKey }) => vote.flatMap(polling => ({ polling, pollUpdateMessageKey })))
+	//  if(messagePollingList.length) {
+	//	map['messages.poll'] = messagePollingList
+	//  }
+    const messageReactionList = Object.values(data.messageReactions).flatMap(({ key, reactions }) => reactions.flatMap(reaction => ({ key, reaction })))
+    if (messageReactionList.length) {
+        map['messages.reaction'] = messageReactionList
+    }
+    const messageReceiptList = Object.values(data.messageReceipts).flatMap(({ key, userReceipt }) => userReceipt.flatMap(receipt => ({ key, receipt })))
+    if (messageReceiptList.length) {
+        map['message-receipt.update'] = messageReceiptList
+    }
+    const contactUpsertList = Object.values(data.contactUpserts)
+    if (contactUpsertList.length) {
+        map['contacts.upsert'] = contactUpsertList
+    }
+    const contactUpdateList = Object.values(data.contactUpdates)
+    if (contactUpdateList.length) {
+        map['contacts.update'] = contactUpdateList
+    }
+    const groupUpdateList = Object.values(data.groupUpdates)
+    if (groupUpdateList.length) {
+        map['groups.update'] = groupUpdateList
+    }
+    const communityUpdateList = Object.values(data.communityUpdates)
+    if (communityUpdateList.length) {
+        map['communities.update'] = communityUpdateList
+    }
+    return map
+}
+function concatChats(a, b) {
+    if (b.unreadCount === null && // neutralize unread counter
+        a.unreadCount < 0) {
+        a.unreadCount = undefined
+        b.unreadCount = undefined
+    }
+    if (typeof a.unreadCount === 'number' && typeof b.unreadCount === 'number') {
+        b = { ...b }
+        if (b.unreadCount >= 0) {
+            b.unreadCount = Math.max(b.unreadCount, 0) + Math.max(a.unreadCount, 0)
+        }
+    }
+    return Object.assign(a, b)
+}
+const stringifyMessageKey = (key) => `${key.remoteJid},${key.id},${key.fromMe ? '1' : '0'}`
+
+module.exports = {
+  makeEventBuffer
+}

package/lib/Utils/generics.d.ts

@@ -0,0 +1,129 @@
+import { AxiosRequestConfig } from 'axios'
+import { ILogger } from './logger'
+import { proto } from '../../WAProto'
+import { BaileysEventEmitter, BaileysEventMap, BrowsersMap, ConnectionState, WACallUpdateType, WAVersion } from '../Types'
+import { BinaryNode } from '../WABinary'
+
+export declare const Browsers: BrowsersMap
+
+export declare const getPlatformId: (browser: string) => any
+
+export declare const BufferJSON: {
+    replacer: (k: any, value: any) => any
+    reviver: (_: any, value: any) => any
+}
+
+export declare const getKeyAuthor: (key: proto.IMessageKey | undefined | null, meId?: string) => string
+
+export declare const writeRandomPadMax16: (msg: Uint8Array) => Buffer
+
+export declare const unpadRandomMax16: (e: Uint8Array | Buffer) => Uint8Array
+
+export declare const encodeWAMessage: (message: proto.IMessage) => Buffer
+
+export declare const encodeNewsletterMessage: (message: proto.IMessage) => Uint8Array
+
+export declare const generateRegistrationId: () => number
+
+export declare const encodeBigEndian: (e: number, t?: number) => Uint8Array
+
+export declare const toNumber: (t: Long | number | null | undefined) => number
+
+/** unix timestamp of a date in seconds */
+export declare const unixTimestampSeconds: (date?: Date) => number
+
+export type DebouncedTimeout = ReturnType<typeof debouncedTimeout>
+
+export declare const debouncedTimeout: (intervalMs?: number, task?: () => void) => {
+    start: (newIntervalMs?: number, newTask?: () => void) => void
+    cancel: () => void
+    setTask: (newTask: () => void) => () => void
+    setInterval: (newInterval: number) => number
+}
+
+export declare const delay: (ms: number) => Promise<void>
+
+export declare const delayCancellable: (ms: number) => {
+    delay: Promise<void>
+    cancel: () => void
+}
+
+export declare function promiseTimeout<T>(ms: number | undefined, promise: (resolve: (v: T) => void, reject: (error: any) => void) => void): Promise<T>
+
+export declare const generateMessageID: (userId?: string) => string
+
+export declare function bindWaitForEvent<T extends keyof BaileysEventMap>(ev: BaileysEventEmitter, event: T): (check: (u: BaileysEventMap[T]) => boolean | undefined, timeoutMs?: number) => Promise<void>
+
+export declare const bindWaitForConnectionUpdate: (ev: BaileysEventEmitter) => (check: (u: Partial<ConnectionState>) => boolean | undefined, timeoutMs?: number) => Promise<void>
+
+export declare const printQRIfNecessaryListener: (ev: BaileysEventEmitter, logger: ILogger) => void
+/**
+ * utility that fetches latest baileys version from the master branch.
+ * Use to ensure your WA connection is always on the latest version
+ */
+ 
+export declare const fetchLatestBaileysVersion: (options?: AxiosRequestConfig<{}>) => Promise<{
+    version: WAVersion
+    isLatest: boolean
+    error?: undefined
+} | {
+    version: WAVersion
+    isLatest: boolean
+    error: any
+}>
+
+/**
+ * A utility that fetches the latest web version of whatsapp.
+ * Use to ensure your WA connection is always on the latest version
+ */
+export declare const fetchLatestWaWebVersion: (options: AxiosRequestConfig<{}>) => Promise<{
+    version: WAVersion
+    isLatest: boolean
+    error?: undefined
+} | {
+    version: WAVersion
+    isLatest: boolean
+    error: any
+}>
+
+/** unique message tag prefix for MD clients */
+export declare const generateMdTagPrefix: () => string
+/**
+ * Given a type of receipt, returns what the new status of the message should be
+ * @param type type from receipt
+ */
+ 
+export declare const getStatusFromReceiptType: (type: string | undefined) => proto.WebMessageInfo.Status
+/**
+ * Stream errors generally provide a reason, map that to a baileys DisconnectReason
+ * @param reason the string reason given, eg. "conflict"
+ */
+export declare const getErrorCodeFromStreamError: (node: BinaryNode) => {
+    reason: string
+    statusCode: number
+}
+
+export declare const getCallStatusFromNode: ({ tag, attrs }: BinaryNode) => WACallUpdateType
+
+export declare const getCodeFromWSError: (error: Error) => number
+/**
+ * Is the given platform WA business
+ * @param platform AuthenticationCreds.platform
+ */
+export declare const isWABusinessPlatform: (platform: string) => boolean
+
+export declare function trimUndefined(obj: {
+    [_: string]: any
+}): {
+    [_: string]: any
+}
+
+export declare function bytesToCrockford(buffer: Buffer): string
+
+export declare function toUnicodeEscape(text: string): string
+
+export declare function fromUnicodeEscape(escapedText: string): string
+
+export declare function asciiEncode(text: string): string
+
+export declare function asciiDecode(...codes: string[]): string[]