@japofc/baileys 2.1.0

package/lib/Utils/message-retry-manager.js

@@ -0,0 +1,264 @@
+import { LRUCache } from 'lru-cache';
+/** Number of sent messages to cache in memory for handling retry receipts */
+const RECENT_MESSAGES_SIZE = 1024;
+const MESSAGE_KEY_SEPARATOR = '\u0000';
+/** Timeout for session recreation - 1 hour */
+const RECREATE_SESSION_TIMEOUT = 60 * 60 * 1000; // 1 hour in milliseconds
+const PHONE_REQUEST_DELAY = 3000;
+// Retry reason codes matching WhatsApp Web's Signal error codes.
+export var RetryReason;
+(function (RetryReason) {
+    RetryReason[RetryReason["UnknownError"] = 0] = "UnknownError";
+    RetryReason[RetryReason["SignalErrorNoSession"] = 1] = "SignalErrorNoSession";
+    RetryReason[RetryReason["SignalErrorInvalidKey"] = 2] = "SignalErrorInvalidKey";
+    RetryReason[RetryReason["SignalErrorInvalidKeyId"] = 3] = "SignalErrorInvalidKeyId";
+    /** MAC verification failed - most common cause of decryption failures */
+    RetryReason[RetryReason["SignalErrorInvalidMessage"] = 4] = "SignalErrorInvalidMessage";
+    RetryReason[RetryReason["SignalErrorInvalidSignature"] = 5] = "SignalErrorInvalidSignature";
+    RetryReason[RetryReason["SignalErrorFutureMessage"] = 6] = "SignalErrorFutureMessage";
+    /** Explicit MAC failure - session is definitely out of sync */
+    RetryReason[RetryReason["SignalErrorBadMac"] = 7] = "SignalErrorBadMac";
+    RetryReason[RetryReason["SignalErrorInvalidSession"] = 8] = "SignalErrorInvalidSession";
+    RetryReason[RetryReason["SignalErrorInvalidMsgKey"] = 9] = "SignalErrorInvalidMsgKey";
+    RetryReason[RetryReason["BadBroadcastEphemeralSetting"] = 10] = "BadBroadcastEphemeralSetting";
+    RetryReason[RetryReason["UnknownCompanionNoPrekey"] = 11] = "UnknownCompanionNoPrekey";
+    RetryReason[RetryReason["AdvFailure"] = 12] = "AdvFailure";
+    RetryReason[RetryReason["StatusRevokeDelay"] = 13] = "StatusRevokeDelay";
+})(RetryReason || (RetryReason = {}));
+/** Error codes that indicate a MAC failure and require immediate session recreation */
+const MAC_ERROR_CODES = new Set([RetryReason.SignalErrorInvalidMessage, RetryReason.SignalErrorBadMac]);
+export class MessageRetryManager {
+    constructor(logger, maxMsgRetryCount) {
+        this.logger = logger;
+        this.recentMessagesMap = new LRUCache({
+            max: RECENT_MESSAGES_SIZE,
+            ttl: 5 * 60 * 1000,
+            ttlAutopurge: true,
+            dispose: (_value, key) => {
+                const separatorIndex = key.lastIndexOf(MESSAGE_KEY_SEPARATOR);
+                if (separatorIndex > -1) {
+                    const messageId = key.slice(separatorIndex + MESSAGE_KEY_SEPARATOR.length);
+                    this.messageKeyIndex.delete(messageId);
+                }
+            }
+        });
+        this.messageKeyIndex = new Map();
+        this.sessionRecreateHistory = new LRUCache({
+            ttl: RECREATE_SESSION_TIMEOUT * 2,
+            ttlAutopurge: true
+        });
+        this.retryCounters = new LRUCache({
+            ttl: 15 * 60 * 1000,
+            ttlAutopurge: true,
+            updateAgeOnGet: true
+        }); // 15 minutes TTL
+        this.baseKeys = new LRUCache({
+            max: 1024,
+            ttl: 15 * 60 * 1000,
+            ttlAutopurge: true
+        });
+        this.pendingPhoneRequests = {};
+        this.maxMsgRetryCount = 5;
+        this.statistics = {
+            totalRetries: 0,
+            successfulRetries: 0,
+            failedRetries: 0,
+            mediaRetries: 0,
+            sessionRecreations: 0,
+            phoneRequests: 0
+        };
+        this.maxMsgRetryCount = maxMsgRetryCount;
+    }
+    /**
+     * Add a recent message to the cache for retry handling
+     */
+    addRecentMessage(to, id, message) {
+        const key = { to, id };
+        const keyStr = this.keyToString(key);
+        // Add new message
+        this.recentMessagesMap.set(keyStr, {
+            message,
+            timestamp: Date.now()
+        });
+        this.messageKeyIndex.set(id, keyStr);
+        this.logger.debug(`Added message to retry cache: ${to}/${id}`);
+    }
+    /**
+     * Get a recent message from the cache
+     */
+    getRecentMessage(to, id) {
+        const key = { to, id };
+        const keyStr = this.keyToString(key);
+        return this.recentMessagesMap.get(keyStr);
+    }
+    /**
+     * Check if a session should be recreated based on retry count, history, and error code.
+     * MAC errors (codes 4 and 7) trigger immediate session recreation regardless of timeout.
+     */
+    shouldRecreateSession(jid, hasSession, errorCode) {
+        // If we don't have a session, always recreate
+        if (!hasSession) {
+            this.sessionRecreateHistory.set(jid, Date.now());
+            this.statistics.sessionRecreations++;
+            return {
+                reason: "we don't have a Signal session with them",
+                recreate: true
+            };
+        }
+        // IMMEDIATE recreation for MAC errors - session is definitely out of sync
+        if (errorCode !== undefined && MAC_ERROR_CODES.has(errorCode)) {
+            this.sessionRecreateHistory.set(jid, Date.now());
+            this.statistics.sessionRecreations++;
+            this.logger.warn({ jid, errorCode: RetryReason[errorCode] }, 'MAC error detected, forcing immediate session recreation');
+            return {
+                reason: `MAC error (code ${errorCode}: ${RetryReason[errorCode]}), immediate session recreation`,
+                recreate: true
+            };
+        }
+        const now = Date.now();
+        const prevTime = this.sessionRecreateHistory.get(jid);
+        // If no previous recreation or it's been more than an hour
+        if (!prevTime || now - prevTime > RECREATE_SESSION_TIMEOUT) {
+            this.sessionRecreateHistory.set(jid, now);
+            this.statistics.sessionRecreations++;
+            return {
+                reason: 'retry count > 1 and over an hour since last recreation',
+                recreate: true
+            };
+        }
+        return { reason: '', recreate: false };
+    }
+    /**
+     * Parse error code from retry receipt's retry node.
+     * Returns undefined if no error code is present.
+     */
+    parseRetryErrorCode(errorAttr) {
+        if (errorAttr === undefined || errorAttr === '') {
+            return undefined;
+        }
+        const code = parseInt(errorAttr, 10);
+        if (Number.isNaN(code)) {
+            return undefined;
+        }
+        // Validate it's a known RetryReason
+        if (code >= RetryReason.UnknownError && code <= RetryReason.StatusRevokeDelay) {
+            return code;
+        }
+        return RetryReason.UnknownError;
+    }
+    /**
+     * Check if an error code indicates a MAC failure
+     */
+    isMacError(errorCode) {
+        return errorCode !== undefined && MAC_ERROR_CODES.has(errorCode);
+    }
+    /**
+     * Increment retry counter for a message
+     */
+    incrementRetryCount(messageId) {
+        this.retryCounters.set(messageId, (this.retryCounters.get(messageId) || 0) + 1);
+        this.statistics.totalRetries++;
+        return this.retryCounters.get(messageId);
+    }
+    /**
+     * Get retry count for a message
+     */
+    getRetryCount(messageId) {
+        return this.retryCounters.get(messageId) || 0;
+    }
+    /**
+     * Check if message has exceeded maximum retry attempts
+     */
+    hasExceededMaxRetries(messageId) {
+        return this.getRetryCount(messageId) >= this.maxMsgRetryCount;
+    }
+    /**
+     * Mark retry as successful
+     */
+    markRetrySuccess(messageId) {
+        this.statistics.successfulRetries++;
+        // Clean up retry counter for successful message
+        this.retryCounters.delete(messageId);
+        this.cancelPendingPhoneRequest(messageId);
+        this.removeRecentMessage(messageId);
+    }
+    /**
+     * Mark retry as failed
+     */
+    markRetryFailed(messageId) {
+        this.statistics.failedRetries++;
+        this.retryCounters.delete(messageId);
+        this.cancelPendingPhoneRequest(messageId);
+        this.removeRecentMessage(messageId);
+    }
+    /**
+     * Schedule a phone request with delay
+     */
+    schedulePhoneRequest(messageId, callback, delay = PHONE_REQUEST_DELAY) {
+        // Cancel any existing request for this message
+        this.cancelPendingPhoneRequest(messageId);
+        this.pendingPhoneRequests[messageId] = setTimeout(() => {
+            delete this.pendingPhoneRequests[messageId];
+            this.statistics.phoneRequests++;
+            callback();
+        }, delay);
+        this.logger.debug(`Scheduled phone request for message ${messageId} with ${delay}ms delay`);
+    }
+    /**
+     * Cancel pending phone request
+     */
+    cancelPendingPhoneRequest(messageId) {
+        const timeout = this.pendingPhoneRequests[messageId];
+        if (timeout) {
+            clearTimeout(timeout);
+            delete this.pendingPhoneRequests[messageId];
+            this.logger.debug(`Cancelled pending phone request for message ${messageId}`);
+        }
+    }
+    clear() {
+        this.recentMessagesMap.clear();
+        this.messageKeyIndex.clear();
+        this.sessionRecreateHistory.clear();
+        this.retryCounters.clear();
+        this.baseKeys.clear();
+        for (const messageId of Object.keys(this.pendingPhoneRequests)) {
+            this.cancelPendingPhoneRequest(messageId);
+        }
+        this.statistics = {
+            totalRetries: 0,
+            successfulRetries: 0,
+            failedRetries: 0,
+            mediaRetries: 0,
+            sessionRecreations: 0,
+            phoneRequests: 0
+        };
+    }
+    saveBaseKey(addr, msgId, baseKey) {
+        this.baseKeys.set(`${addr}:${msgId}`, baseKey);
+    }
+    hasSameBaseKey(addr, msgId, baseKey) {
+        const stored = this.baseKeys.get(`${addr}:${msgId}`);
+        if (!stored || stored.length !== baseKey.length) {
+            return false;
+        }
+        for (let i = 0; i < stored.length; i++) {
+            if (stored[i] !== baseKey[i])
+                return false;
+        }
+        return true;
+    }
+    deleteBaseKey(addr, msgId) {
+        this.baseKeys.delete(`${addr}:${msgId}`);
+    }
+    keyToString(key) {
+        return `${key.to}${MESSAGE_KEY_SEPARATOR}${key.id}`;
+    }
+    removeRecentMessage(messageId) {
+        const keyStr = this.messageKeyIndex.get(messageId);
+        if (!keyStr) {
+            return;
+        }
+        this.recentMessagesMap.delete(keyStr);
+        this.messageKeyIndex.delete(messageId);
+    }
+}

package/lib/Utils/message-search.d.ts

@@ -0,0 +1,44 @@
+import type { WAMessage } from '../Types/index.js';
+export type SearchMessageType = 'text' | 'image' | 'video' | 'document' | 'audio' | 'sticker' | 'location' | 'contact' | 'other';
+export interface SearchOptions {
+    jid?: string;
+    fromDate?: Date;
+    toDate?: Date;
+    fromSender?: string;
+    fromMe?: boolean;
+    messageTypes?: SearchMessageType[];
+    limit?: number;
+    caseSensitive?: boolean;
+}
+export interface SearchResult {
+    message: WAMessage;
+    matchedText: string;
+    matchPosition: number;
+    relevanceScore: number;
+}
+export interface RegexSearchOptions {
+    jid?: string;
+    fromSender?: string;
+    fromMe?: boolean;
+    messageTypes?: SearchMessageType[];
+    limit?: number;
+}
+export declare const extractMessageText: (message: WAMessage) => string;
+export declare const calculateRelevance: (query: string, text: string, position: number) => number;
+export declare const searchMessages: (messages: WAMessage[], query: string, options?: SearchOptions) => SearchResult[];
+export declare const searchMessagesRegex: (messages: WAMessage[], pattern: RegExp, options?: RegexSearchOptions) => SearchResult[];
+export declare class MessageSearchManager {
+    private messages;
+    private messageIndex;
+    addMessages(messages: WAMessage[]): void;
+    removeMessages(messageIds: string[]): void;
+    clear(): void;
+    get count(): number;
+    search(query: string, options?: SearchOptions): SearchResult[];
+    searchRegex(pattern: RegExp, options?: RegexSearchOptions): SearchResult[];
+    getByJid(jid: string): WAMessage[];
+    getBySender(sender: string): WAMessage[];
+    getByType(type: SearchMessageType): WAMessage[];
+    getById(id: string): WAMessage | undefined;
+}
+export declare const createMessageSearch: () => MessageSearchManager;

package/lib/Utils/message-search.js

@@ -0,0 +1,188 @@
+// JAP@Add --- part of the @japofc/baileys utils (message-search.ts) (type-only
+// annotations dropped; behavior unchanged).
+// JAP@Fix (bug 58): peel off ephemeral / view-once wrappers so search still
+// indexes text from disappearing-message chats instead of always seeing '{}'.
+const unwrapMessage = (content) => {
+    let c = content;
+    while (c && (c.ephemeralMessage || c.viewOnceMessage || c.viewOnceMessageV2 || c.viewOnceMessageV2Extension || c.documentWithCaptionMessage)) {
+        c = c.ephemeralMessage?.message ||
+            c.viewOnceMessage?.message ||
+            c.viewOnceMessageV2?.message ||
+            c.viewOnceMessageV2Extension?.message ||
+            c.documentWithCaptionMessage?.message;
+    }
+    return c;
+};
+export const extractMessageText = (message) => {
+    const c = unwrapMessage(message.message);
+    if (!c)
+        return '';
+    if (c.conversation)
+        return c.conversation;
+    if (c.extendedTextMessage?.text)
+        return c.extendedTextMessage.text;
+    if (c.imageMessage?.caption)
+        return c.imageMessage.caption;
+    if (c.videoMessage?.caption)
+        return c.videoMessage.caption;
+    if (c.documentMessage?.caption)
+        return c.documentMessage.caption;
+    if (c.documentMessage?.fileName)
+        return c.documentMessage.fileName;
+    if (c.locationMessage?.name)
+        return c.locationMessage.name;
+    if (c.locationMessage?.address)
+        return c.locationMessage.address;
+    if (c.contactMessage?.displayName)
+        return c.contactMessage.displayName;
+    if (c.pollCreationMessage?.name)
+        return c.pollCreationMessage.name;
+    return '';
+};
+const getMessageType = (message) => {
+    const c = unwrapMessage(message.message);
+    if (!c)
+        return 'other';
+    if (c.conversation || c.extendedTextMessage)
+        return 'text';
+    if (c.imageMessage)
+        return 'image';
+    if (c.videoMessage)
+        return 'video';
+    if (c.documentMessage)
+        return 'document';
+    if (c.audioMessage)
+        return 'audio';
+    if (c.stickerMessage)
+        return 'sticker';
+    if (c.locationMessage || c.liveLocationMessage)
+        return 'location';
+    if (c.contactMessage || c.contactsArrayMessage)
+        return 'contact';
+    return 'other';
+};
+export const calculateRelevance = (query, text, position) => {
+    let score = 100;
+    if (text.toLowerCase() === query.toLowerCase())
+        score += 50;
+    score -= Math.min(position / 10, 20);
+    const lt = text.toLowerCase(), lq = query.toLowerCase();
+    if (position === 0 ||
+        lt[position - 1] === ' ' ||
+        lt[position + lq.length] === ' ' ||
+        position + lq.length === text.length)
+        score += 20;
+    return Math.max(score, 0);
+};
+/** Plain-text substring search with relevance-sorted results. */
+export const searchMessages = (messages, query, options = {}) => {
+    const results = [];
+    const sq = options.caseSensitive ? query : query.toLowerCase();
+    for (const message of messages) {
+        if (options.jid && message.key.remoteJid !== options.jid)
+            continue;
+        const ts = message.messageTimestamp;
+        const mt = ts ? new Date((typeof ts === 'number' ? ts : Number(ts)) * 1000) : null;
+        if (options.fromDate && mt && mt < options.fromDate)
+            continue;
+        if (options.toDate && mt && mt > options.toDate)
+            continue;
+        if (options.fromSender && message.key.participant !== options.fromSender)
+            continue;
+        if (options.fromMe !== undefined && message.key.fromMe !== options.fromMe)
+            continue;
+        if (options.messageTypes?.length) {
+            if (!options.messageTypes.includes(getMessageType(message)))
+                continue;
+        }
+        const text = extractMessageText(message);
+        if (!text)
+            continue;
+        const st = options.caseSensitive ? text : text.toLowerCase();
+        const pos = st.indexOf(sq);
+        if (pos !== -1) {
+            results.push({
+                message,
+                matchedText: text.substring(Math.max(0, pos - 20), Math.min(text.length, pos + query.length + 20)),
+                matchPosition: pos,
+                relevanceScore: calculateRelevance(query, text, pos)
+            });
+        }
+        // JAP@Fix (bug 59): limit used to break the scan loop *before* sorting,
+        // so it kept the first N matches in document order and could drop
+        // higher-relevance matches found later. Sort first, then slice.
+    }
+    results.sort((a, b) => b.relevanceScore - a.relevanceScore);
+    return options.limit ? results.slice(0, options.limit) : results;
+};
+/** Regex-based search (e.g. for commands/patterns), unordered by relevance. */
+export const searchMessagesRegex = (messages, pattern, options = {}) => {
+    const results = [];
+    for (const message of messages) {
+        if (options.jid && message.key.remoteJid !== options.jid)
+            continue;
+        if (options.fromSender && message.key.participant !== options.fromSender)
+            continue;
+        if (options.fromMe !== undefined && message.key.fromMe !== options.fromMe)
+            continue;
+        if (options.messageTypes?.length) {
+            if (!options.messageTypes.includes(getMessageType(message)))
+                continue;
+        }
+        const text = extractMessageText(message);
+        if (!text)
+            continue;
+        const match = text.match(pattern);
+        if (match)
+            results.push({ message, matchedText: match[0], matchPosition: match.index ?? 0, relevanceScore: 100 });
+        if (options.limit && results.length >= options.limit)
+            break;
+    }
+    return results;
+};
+/** Standalone searchable index — feed it messages independently of the main Store. */
+export class MessageSearchManager {
+    messages = [];
+    messageIndex = new Map();
+    addMessages(messages) {
+        for (const msg of messages) {
+            const id = msg.key.id;
+            if (id && !this.messageIndex.has(id)) {
+                this.messages.push(msg);
+                this.messageIndex.set(id, msg);
+            }
+        }
+    }
+    removeMessages(messageIds) {
+        const idSet = new Set(messageIds);
+        this.messages = this.messages.filter((m) => !idSet.has(m.key.id || ''));
+        for (const id of messageIds)
+            this.messageIndex.delete(id);
+    }
+    clear() {
+        this.messages = [];
+        this.messageIndex.clear();
+    }
+    get count() {
+        return this.messages.length;
+    }
+    search(query, options) {
+        return searchMessages(this.messages, query, options);
+    }
+    searchRegex(pattern, options) {
+        return searchMessagesRegex(this.messages, pattern, options);
+    }
+    getByJid(jid) {
+        return this.messages.filter((m) => m.key.remoteJid === jid);
+    }
+    getBySender(sender) {
+        return this.messages.filter((m) => m.key.participant === sender || m.key.remoteJid === sender);
+    }
+    getByType(type) {
+        return this.messages.filter((m) => getMessageType(m) === type);
+    }
+    getById(id) {
+        return this.messageIndex.get(id);
+    }
+}
+export const createMessageSearch = () => new MessageSearchManager();

package/lib/Utils/messages-media.d.ts

@@ -0,0 +1,135 @@
+/** generates all the keys required to encrypt/decrypt & sign a media message */
+export function getMediaKeys(buffer: any, mediaType: any): Promise<{
+    iv: any;
+    cipherKey: any;
+    macKey: any;
+}>;
+export function getAudioDuration(buffer: any): Promise<any>;
+/**
+  referenced from and modifying https://github.com/wppconnect-team/wa-js/blob/main/src/chat/functions/prepareAudioWaveform.ts
+ */
+export function getAudioWaveform(buffer: any, logger: any): Promise<Uint8Array<ArrayBuffer> | undefined>;
+/** generates a thumbnail for a given media, if required */
+export function generateThumbnail(file: any, mediaType: any, options: any): Promise<{
+    thumbnail: any;
+    originalImageDimensions: {
+        width: any;
+        height: any;
+    } | undefined;
+}>;
+export function extensionForMediaMessage(message: any): any;
+export function getImageProcessingLibrary(): Promise<any>;
+export function hkdfInfoKey(type: any): string;
+export function getRawMediaUploadData(media: any, mediaType: any, logger: any): Promise<{
+    filePath: any;
+    fileSha256: any;
+    fileLength: number;
+}>;
+export function extractVideoThumb(path: any, time: any, size: any): Promise<any>;
+export function extractImageThumb(bufferOrFilePath: any, width?: number): Promise<{
+    buffer: any;
+    original: {
+        width: any;
+        height: any;
+    };
+}>;
+export function encodeBase64EncodedStringForUpload(b64: any): string;
+export function generateProfilePicture(mediaUpload: any, dimensions: any): Promise<{
+    img: any;
+}>;
+export function mediaMessageSHA256B64(message: any): any;
+export function toReadable(buffer: any): any;
+export function toBuffer(stream: any): Promise<any>;
+export function getStream(item: any, opts: any): Promise<{
+    stream: any;
+    type: string;
+}>;
+export function getHttpStream(url: any, options?: any): Promise<any>;
+export function encryptedStream(media: any, mediaType: any, { logger, saveOriginalFileIfRequired, opts }?: any): Promise<{
+    mediaKey: any;
+    originalFilePath: any;
+    encFilePath: any;
+    mac: any;
+    fileEncSha256: any;
+    fileSha256: any;
+    fileLength: number;
+}>;
+export const DEF_MEDIA_HOST: "mmg.whatsapp.net";
+export function getUrlFromDirectPath(directPath: any, host?: string): string;
+export function downloadContentFromMessage({ mediaKey, directPath, url }: {
+    mediaKey: any;
+    directPath: any;
+    url: any;
+}, type: any, opts?: any): Promise<any>;
+export function downloadEncryptedContent(downloadUrl: any, { cipherKey, iv }: {
+    cipherKey: any;
+    iv: any;
+}, { startByte, endByte, options }?: any): Promise<any>;
+export function uploadWithNodeHttp({ url, filePath, headers, timeoutMs, agent }: {
+    url: any;
+    filePath: any;
+    headers: any;
+    timeoutMs: any;
+    agent: any;
+}, redirectCount?: number): Promise<any>;
+export function getWAUploadToServer({ customUploadHosts, fetchAgent, logger, options }: {
+    customUploadHosts: any;
+    fetchAgent: any;
+    logger: any;
+    options: any;
+}, refreshMediaConn: any): (filePath: any, { mediaType, fileEncSha256B64, timeoutMs, newsletter }: {
+    mediaType: any;
+    fileEncSha256B64: any;
+    timeoutMs: any;
+    newsletter: any;
+}) => Promise<{
+    mediaUrl: any;
+    directPath: any;
+    meta_hmac: any;
+    fbid: any;
+    ts: any;
+    thumbnailDirectPath: any;
+    thumbnailSha256: any;
+}>;
+export function encryptMediaRetryRequest(key: any, mediaKey: any, meId: any): {
+    tag: string;
+    attrs: {
+        id: any;
+        to: string;
+        type: string;
+    };
+    content: ({
+        tag: string;
+        attrs: {
+            jid?: undefined;
+            from_me?: undefined;
+            participant?: undefined;
+        };
+        content: {
+            tag: string;
+            attrs: {};
+            content: any;
+        }[];
+    } | {
+        tag: string;
+        attrs: {
+            jid: any;
+            from_me: string;
+            participant: any;
+        };
+        content?: undefined;
+    })[];
+};
+export function decodeMediaRetryNode(node: any): {
+    key: {
+        id: any;
+        remoteJid: any;
+        fromMe: boolean;
+        participant: any;
+    };
+};
+export function decryptMediaRetryData({ ciphertext, iv }: {
+    ciphertext: any;
+    iv: any;
+}, mediaKey: any, msgId: any): any;
+export function getStatusCodeForMediaRetry(code: any): number;