@hbmodsofc/baileys 1.5.2 → 1.7.7

package/lib/Utils/event-buffer.js

@@ -21,19 +21,22 @@ const BUFFERABLE_EVENT = [
     'messages.delete',
     'messages.reaction',
     'message-receipt.update',
-    'groups.update',
+    'groups.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;
+    let isBuffering = false;
+    let bufferTimeout = null;
+    let bufferCount = 0;
+    const MAX_HISTORY_CACHE_SIZE = 10000; // Limit the history cache size to prevent memory bloat
+    const BUFFER_TIMEOUT_MS = 30000; // 30 seconds
     // take the generic event and fire it as a baileys event
     ev.on('event', (map) => {
         for (const event in map) {
@@ -41,25 +44,44 @@ const makeEventBuffer = (logger) => {
         }
     });
     function buffer() {
-        buffersInProgress += 1;
+        if (!isBuffering) {
+            logger.debug('Event buffer activated');
+            isBuffering = true;
+            bufferCount++;
+            // Auto-flush after a timeout to prevent infinite buffering
+            if (bufferTimeout) {
+                clearTimeout(bufferTimeout);
+            }
+            bufferTimeout = setTimeout(() => {
+                if (isBuffering) {
+                    logger.warn('Buffer timeout reached, auto-flushing');
+                    flush();
+                }
+            }, BUFFER_TIMEOUT_MS);
+        }
+        else {
+            bufferCount++;
+        }
     }
-    function flush(force = false) {
-        // no buffer going on
-        if (!buffersInProgress) {
+    function flush() {
+        if (!isBuffering) {
             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;
-            }
+        logger.debug({ bufferCount }, 'Flushing event buffer');
+        isBuffering = false;
+        bufferCount = 0;
+        // Clear timeout
+        if (bufferTimeout) {
+            clearTimeout(bufferTimeout);
+            bufferTimeout = null;
+        }
+        // Clear history cache if it exceeds the max size
+        if (historyCache.size > MAX_HISTORY_CACHE_SIZE) {
+            logger.debug({ cacheSize: historyCache.size }, 'Clearing history cache');
+            historyCache.clear();
         }
         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) {
@@ -87,14 +109,14 @@ const makeEventBuffer = (logger) => {
             };
         },
         emit(event, evData) {
-            if (buffersInProgress && BUFFERABLE_EVENT_SET.has(event)) {
+            if (isBuffering && BUFFERABLE_EVENT_SET.has(event)) {
                 append(data, historyCache, event, evData, logger);
                 return true;
             }
             return ev.emit('event', { [event]: evData });
         },
         isBuffering() {
-            return buffersInProgress > 0;
+            return isBuffering;
         },
         buffer,
         flush,
@@ -103,16 +125,31 @@ const makeEventBuffer = (logger) => {
                 buffer();
                 try {
                     const result = await work(...args);
+                    // If this is the only buffer, flush after a small delay
+                    if (bufferCount === 1) {
+                        setTimeout(() => {
+                            if (isBuffering && bufferCount === 1) {
+                                flush();
+                            }
+                        }, 100); // Small delay to allow nested buffers
+                    }
                     return result;
                 }
+                catch (error) {
+                    throw error;
+                }
                 finally {
-                    flush();
+                    bufferCount = Math.max(0, bufferCount - 1);
+                    if (bufferCount === 0) {
+                        // Auto-flush when no other buffers are active
+                        setTimeout(flush, 100);
+                    }
                 }
             };
         },
         on: (...args) => ev.on(...args),
         off: (...args) => ev.off(...args),
-        removeAllListeners: (...args) => ev.removeAllListeners(...args),
+        removeAllListeners: (...args) => ev.removeAllListeners(...args)
     };
 };
 exports.makeEventBuffer = makeEventBuffer;
@@ -138,8 +175,9 @@ const makeBufferData = () => {
         groupUpdates: {}
     };
 };
-function append(data, historyCache, event, eventData, logger) {
-    var _a, _b, _c;
+function append(data, historyCache, event, 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+eventData, logger) {
     switch (event) {
         case 'messaging-history.set':
             for (const chat of eventData.chats) {
@@ -176,13 +214,16 @@ function append(data, historyCache, event, eventData, logger) {
                 }
             }
             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];
+                    upsert = data.historySets.chats[chat.id];
                     if (upsert) {
                         logger.debug({ chatId: chat.id }, 'absorbed chat upsert in chat set');
                     }
@@ -288,7 +329,7 @@ function append(data, historyCache, event, eventData, logger) {
             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;
+                let existing = data.messageUpserts[key]?.message;
                 if (!existing) {
                     existing = data.historySets.messages[key];
                     if (existing) {
@@ -309,9 +350,7 @@ function append(data, historyCache, event, eventData, logger) {
                 else {
                     data.messageUpserts[key] = {
                         message,
-                        type: type === 'notify' || ((_b = data.messageUpserts[key]) === null || _b === void 0 ? void 0 : _b.type) === 'notify'
-                            ? 'notify'
-                            : type
+                        type: type === 'notify' || data.messageUpserts[key]?.type === 'notify' ? 'notify' : type
                     };
                 }
             }
@@ -320,7 +359,7 @@ function append(data, historyCache, event, eventData, logger) {
             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);
+                const existing = data.historySets.messages[keyStr] || data.messageUpserts[keyStr]?.message;
                 if (existing) {
                     Object.assign(existing, update);
                     // if the message was received & read by us
@@ -367,8 +406,7 @@ function append(data, historyCache, event, eventData, logger) {
                     (0, messages_1.updateMessageWithReaction)(existing.message, reaction);
                 }
                 else {
-                    data.messageReactions[keyStr] = data.messageReactions[keyStr]
-                        || { key, reactions: [] };
+                    data.messageReactions[keyStr] = data.messageReactions[keyStr] || { key, reactions: [] };
                     (0, messages_1.updateMessageWithReaction)(data.messageReactions[keyStr], reaction);
                 }
             }
@@ -382,8 +420,7 @@ function append(data, historyCache, event, eventData, logger) {
                     (0, messages_1.updateMessageWithReceipt)(existing.message, receipt);
                 }
                 else {
-                    data.messageReceipts[keyStr] = data.messageReceipts[keyStr]
-                        || { key, userReceipt: [] };
+                    data.messageReceipts[keyStr] = data.messageReceipts[keyStr] || { key, userReceipt: [] };
                     (0, messages_1.updateMessageWithReceipt)(data.messageReceipts[keyStr], receipt);
                 }
             }
@@ -423,10 +460,10 @@ function append(data, historyCache, event, eventData, logger) {
         // if the message has already been marked read by us
         const chatId = message.key.remoteJid;
         const chat = data.chatUpdates[chatId] || data.chatUpserts[chatId];
-        if ((0, process_message_1.isRealMessage)(message, '')
-            && (0, process_message_1.shouldIncrementChatUnread)(message)
-            && typeof (chat === null || chat === void 0 ? void 0 : chat.unreadCount) === 'number'
-            && chat.unreadCount > 0) {
+        if ((0, process_message_1.isRealMessage)(message, '') &&
+            (0, 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) {
@@ -442,7 +479,10 @@ function consolidateEvents(data) {
             chats: Object.values(data.historySets.chats),
             messages: Object.values(data.historySets.messages),
             contacts: Object.values(data.historySets.contacts),
-            isLatest: data.historySets.isLatest
+            syncType: data.historySets.syncType,
+            progress: data.historySets.progress,
+            isLatest: data.historySets.isLatest,
+            peerDataRequestSessionId: data.historySets.peerDataRequestSessionId
         };
     }
     const chatUpsertList = Object.values(data.chatUpserts);
@@ -496,12 +536,10 @@ function consolidateEvents(data) {
     return map;
 }
 function concatChats(a, b) {
-    if (b.unreadCount === null) {
-        // neutralize unread counter
-        if (a.unreadCount < 0) {
-            a.unreadCount = undefined;
-            b.unreadCount = undefined;
-        }
+    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 };

package/lib/Utils/generics.d.ts

@@ -1,24 +1,20 @@
-/// <reference types="node" />
-import { AxiosRequestConfig } from 'axios';
-import { Logger } from 'pino';
-import { proto } from '../../WAProto';
-import { BaileysEventEmitter, BaileysEventMap, WACallUpdateType, WAVersion } from '../Types';
-import { BinaryNode } from '../WABinary';
-export declare const Browsers: {
-    ubuntu: (browser: any) => [string, string, string];
-    macOS: (browser: any) => [string, string, string];
-    baileys: (browser: any) => [string, string, string];
-    windows: (browser: any) => [string, string, string];
-    /** The appropriate browser based on your OS & release */
-    appropriate: (browser: any) => [string, string, string];
+import { type AxiosRequestConfig } from 'axios';
+import { proto } from '../../WAProto/index.js';
+import type { BaileysEventEmitter, BaileysEventMap, BrowsersMap, ConnectionState, WACallUpdateType, WAVersion } from '../Types';
+import { type BinaryNode } from '../WABinary';
+export declare const Browsers: BrowsersMap;
+export declare const getPlatformId: (browser: string) => string;
+export declare const BufferJSON: {
+    replacer: (k: any, value: any) => any;
+    reviver: (_: any, value: any) => any;
 };
-export declare const getPlatformId: (browser: string) => 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 writeRandomPadMax16: (msg: Uint8Array) => Buffer<ArrayBuffer>;
+export declare const unpadRandomMax16: (e: Uint8Array | Buffer) => Uint8Array<ArrayBuffer>;
+export declare const generateParticipantHashV2: (participants: string[]) => string;
+export declare const encodeWAMessage: (message: proto.IMessage) => Buffer<ArrayBuffer>;
 export declare const generateRegistrationId: () => number;
-export declare const encodeBigEndian: (e: number, t?: number) => Uint8Array;
+export declare const encodeBigEndian: (e: number, t?: number) => Uint8Array<ArrayBuffer>;
 export declare const toNumber: (t: Long | number | null | undefined) => number;
 /** unix timestamp of a date in seconds */
 export declare const unixTimestampSeconds: (date?: Date) => number;
@@ -37,34 +33,33 @@ export declare const delayCancellable: (ms: number) => {
 export declare function promiseTimeout<T>(ms: number | undefined, promise: (resolve: (v: T) => void, reject: (error: any) => void) => void): Promise<T>;
 export declare const generateMessageIDV2: (userId?: string) => string;
 export declare const generateMessageID: () => 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<import("../Types").ConnectionState>) => boolean | undefined, timeoutMs?: number) => Promise<void>;
-export declare const printQRIfNecessaryListener: (ev: BaileysEventEmitter, logger: Logger) => void;
+export declare function bindWaitForEvent<T extends keyof BaileysEventMap>(ev: BaileysEventEmitter, event: T): (check: (u: BaileysEventMap[T]) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<void>;
+export declare const bindWaitForConnectionUpdate: (ev: BaileysEventEmitter) => (check: (u: Partial<ConnectionState>) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<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<any>) => Promise<{
+export declare const fetchLatestBaileysVersion: (options?: AxiosRequestConfig<{}>) => Promise<{
     version: WAVersion;
     isLatest: boolean;
     error?: undefined;
 } | {
     version: WAVersion;
     isLatest: boolean;
-    error: any;
+    error: unknown;
 }>;
 /**
  * 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<any>) => Promise<{
+export declare const fetchLatestWaWebVersion: (options: AxiosRequestConfig<{}>) => Promise<{
     version: WAVersion;
     isLatest: boolean;
     error?: undefined;
 } | {
     version: WAVersion;
     isLatest: boolean;
-    error: any;
+    error: unknown;
 }>;
 /** unique message tag prefix for MD clients */
 export declare const generateMdTagPrefix: () => string;
@@ -87,6 +82,11 @@ 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: any): any;
+export declare const isWABusinessPlatform: (platform: string) => platform is "smba" | "smbi";
+export declare function trimUndefined(obj: {
+    [_: string]: any;
+}): {
+    [_: string]: any;
+};
 export declare function bytesToCrockford(buffer: Buffer): string;
+export declare function encodeNewsletterMessage(message: proto.IMessage): Uint8Array;