@neykoor/baileys 7.0.4-rc15 → 7.0.7-rc15

package/lib/Utils/messages.js

@@ -6,11 +6,11 @@ import { join } from 'path';
 import {} from 'stream';
 import { proto } from '../../WAProto/index.js';
 import { CALL_AUDIO_PREFIX, CALL_VIDEO_PREFIX, MEDIA_KEYS, URL_REGEX, WA_DEFAULT_EPHEMERAL } from '../Defaults/index.js';
-import { WAMessageStatus, WAProto } from '../Types/index.js';
+import { ButtonHeaderType, ButtonType, CarouselCardType, ListType, WAMessageStatus, WAProto } from '../Types/index.js';
 import { isJidGroup, isJidNewsletter, isJidStatusBroadcast, jidNormalizedUser } from '../WABinary/index.js';
 import { sha256 } from './crypto.js';
 import { generateMessageIDV2, getKeyAuthor, unixTimestampSeconds } from './generics.js';
-import { downloadContentFromMessage, encryptedStream, generateThumbnail, getAudioDuration, getAudioWaveform, getMediaKeys, getRawMediaUploadData, getStream, toBuffer } from './messages-media.js';
+import { downloadContentFromMessage, encryptedStream, generateThumbnail, getAudioDuration, getAudioWaveform, getMediaKeys, getRawMediaUploadData, getStream, toBuffer, transcodeAudioToOpus } from './messages-media.js';
 import { shouldIncludeReportingToken } from './reporting-utils.js';
 const MIMETYPE_MAP = {
     image: 'image/jpeg',
@@ -27,11 +27,6 @@ const MessageTypeProto = {
     sticker: WAProto.Message.StickerMessage,
     document: WAProto.Message.DocumentMessage
 };
-/**
- * Uses a regex to test whether the string contains a URL, and returns the URL if it does.
- * @param text eg. hello https://google.com
- * @returns the URL, eg. https://google.com
- */
 export const extractUrlFromText = (text) => text.match(URL_REGEX)?.[0];
 export const generateLinkPreviewIfRequired = async (text, getUrlInfo, logger) => {
     const url = extractUrlFromText(text);
@@ -41,7 +36,6 @@ export const generateLinkPreviewIfRequired = async (text, getUrlInfo, logger) =>
             return urlInfo;
         }
         catch (error) {
-            // ignore if fails
             logger?.warn({ trace: error.stack }, 'url generation failed');
         }
     }
@@ -232,7 +226,6 @@ export const prepareWAMessageMedia = async (message, options) => {
         media: message[mediaType]
     };
     delete uploadData[mediaType];
-    // check if cacheable + generate cache key
     const cacheableKey = typeof uploadData.media === 'object' &&
         'url' in uploadData.media &&
         !!uploadData.media.url &&
@@ -244,6 +237,18 @@ export const prepareWAMessageMedia = async (message, options) => {
     if (!uploadData.mimetype) {
         uploadData.mimetype = MIMETYPE_MAP[mediaType];
     }
+    let pttTranscodedPath;
+    if (mediaType === 'audio' && uploadData.ptt === true) {
+        const media = uploadData.media;
+        const mediaUrl = typeof media === 'string' ? media : media?.url?.toString?.() || '';
+        const sourceLooksLikeOpus = /\.(opus|ogg)(\?|$)/i.test(mediaUrl);
+        if (!sourceLooksLikeOpus) {
+            const sourceForTranscode = Buffer.isBuffer(media) ? media : typeof media === 'string' ? media : mediaUrl;
+            pttTranscodedPath = await transcodeAudioToOpus(sourceForTranscode);
+            uploadData.media = { url: pttTranscodedPath };
+        }
+        uploadData.mimetype = 'audio/ogg; codecs=opus';
+    }
     if (cacheableKey) {
         const mediaBuff = await options.mediaCache.get(cacheableKey);
         if (mediaBuff) {
@@ -266,7 +271,6 @@ export const prepareWAMessageMedia = async (message, options) => {
         });
         await fs.unlink(filePath);
         const obj = WAProto.Message.fromObject({
-            // todo: add more support here
             [`${mediaType}Message`]: MessageTypeProto[mediaType].fromObject({
                 url: mediaUrl,
                 directPath,
@@ -345,6 +349,9 @@ export const prepareWAMessageMedia = async (message, options) => {
             if (originalFilePath) {
                 await fs.unlink(originalFilePath);
             }
+            if (pttTranscodedPath) {
+                await fs.unlink(pttTranscodedPath);
+            }
             logger?.debug('removed tmp files');
         }
         catch (error) {
@@ -388,17 +395,11 @@ export const prepareDisappearingMessageSettingContent = (ephemeralExpiration) =>
     };
     return WAProto.Message.fromObject(content);
 };
-/**
- * Generate forwarded message content like WA does
- * @param message the message to forward
- * @param options.forceForward will show the message as forwarded even if it is from you
- */
 export const generateForwardMessageContent = (message, forceForward) => {
     let content = message.message;
     if (!content) {
         throw new Boom('no content in message', { statusCode: 400 });
     }
-    // hacky copy
     content = normalizeMessageContent(content);
     content = proto.Message.decode(proto.Message.encode(content).finish());
     let key = Object.keys(content)[0];
@@ -428,10 +429,253 @@ export const hasNonNullishProperty = (message, key) => {
 function hasOptionalProperty(obj, key) {
     return typeof obj === 'object' && obj !== null && key in obj && obj[key] !== null;
 }
+const prepareNativeFlowButtons = (message) => {
+    const buttons = message.nativeFlow;
+    const correctedField = Array.isArray(buttons) ? buttons : buttons.buttons;
+    return {
+        buttons: correctedField.map((button) => {
+            const buttonText = button.text || button.buttonText;
+            const icon = button.icon?.toUpperCase();
+            if (button.id) {
+                return {
+                    name: 'quick_reply',
+                    buttonParamsJson: JSON.stringify({ display_text: buttonText || 'Click', id: button.id, icon })
+                };
+            }
+            else if (button.copy) {
+                return {
+                    name: 'cta_copy',
+                    buttonParamsJson: JSON.stringify({ display_text: buttonText || 'Copy', copy_code: button.copy, icon })
+                };
+            }
+            else if (button.url) {
+                return {
+                    name: 'cta_url',
+                    buttonParamsJson: JSON.stringify({
+                        display_text: buttonText || 'Visit',
+                        url: button.url,
+                        merchant_url: button.url,
+                        webview_interaction: button.useWebview,
+                        icon
+                    })
+                };
+            }
+            else if (button.call) {
+                return {
+                    name: 'cta_call',
+                    buttonParamsJson: JSON.stringify({ display_text: buttonText || 'Call', phone_number: button.call, icon })
+                };
+            }
+            else if (button.sections) {
+                return {
+                    name: 'single_select',
+                    buttonParamsJson: JSON.stringify({ title: buttonText || 'Select', sections: button.sections, icon })
+                };
+            }
+            return { name: button.name, buttonParamsJson: button.paramsJson };
+        })
+    };
+};
+export const hasValidInteractiveHeader = (message) => {
+    return !!(message.imageMessage ||
+        message.videoMessage ||
+        message.documentMessage ||
+        message.productMessage ||
+        message.locationMessage);
+};
+export const hasValidCarouselHeader = (message) => {
+    return !!(message.imageMessage || message.videoMessage || message.productMessage);
+};
 export const generateWAMessageContent = async (message, options) => {
     var _a, _b;
     let m = {};
-    if (hasNonNullishProperty(message, 'text')) {
+    if (hasNonNullishProperty(message, 'raw')) {
+        delete message.raw;
+        return message;
+    }
+    else if (hasNonNullishProperty(message, 'buttons')) {
+        const buttonsMessage = {
+            buttons: message.buttons.map((button) => {
+                const buttonText = button.text || button.buttonText;
+                if (button.nativeFlowInfo) {
+                    return {
+                        buttonId: button.id || button.buttonId,
+                        buttonText: typeof buttonText === 'string' ? { displayText: buttonText } : buttonText,
+                        nativeFlowInfo: button.nativeFlowInfo,
+                        type: ButtonType.NATIVE_FLOW
+                    };
+                }
+                else if (button.sections) {
+                    return {
+                        nativeFlowInfo: {
+                            name: 'single_select',
+                            paramsJson: JSON.stringify({ title: buttonText, sections: button.sections })
+                        },
+                        type: ButtonType.NATIVE_FLOW
+                    };
+                }
+                else if (button.name) {
+                    return {
+                        nativeFlowInfo: { name: button.name, paramsJson: button.paramsJson },
+                        type: ButtonType.NATIVE_FLOW
+                    };
+                }
+                return {
+                    buttonId: button.id || button.buttonId,
+                    buttonText: typeof buttonText === 'string' ? { displayText: buttonText } : buttonText,
+                    type: button.type || ButtonType.RESPONSE
+                };
+            })
+        };
+        if (message.text) {
+            buttonsMessage.contentText = message.text;
+            buttonsMessage.headerType = ButtonHeaderType.EMPTY;
+        }
+        else {
+            const media = await prepareWAMessageMedia(message, options);
+            if (message.caption) {
+                buttonsMessage.contentText = message.caption;
+            }
+            const mediaKey = Object.keys(media)[0];
+            if (!mediaKey) {
+                throw new Boom('buttons message needs either "text" or a media field (image/video/document) as header', {
+                    statusCode: 400
+                });
+            }
+            const type = mediaKey.replace('Message', '').toUpperCase();
+            buttonsMessage.headerType = ButtonHeaderType[type];
+            Object.assign(buttonsMessage, media);
+        }
+        if (message.footer) {
+            buttonsMessage.footerText = message.footer;
+        }
+        m.buttonsMessage = buttonsMessage;
+    }
+    else if (hasNonNullishProperty(message, 'sections')) {
+        m.listMessage = {
+            sections: message.sections,
+            buttonText: message.buttonText,
+            title: message.title,
+            footerText: message.footer,
+            description: message.description,
+            listType: ListType.SINGLE_SELECT
+        };
+    }
+    else if (hasNonNullishProperty(message, 'templateButtons')) {
+        const hydratedTemplate = {
+            hydratedButtons: message.templateButtons.map((button, i) => {
+                const buttonText = button.text || button.buttonText;
+                if (button.id) {
+                    return { index: i, quickReplyButton: { displayText: buttonText || 'Click', id: button.id } };
+                }
+                else if (button.url) {
+                    return { index: i, urlButton: { displayText: buttonText || 'Visit', url: button.url } };
+                }
+                else if (button.call) {
+                    return { index: i, callButton: { displayText: buttonText || 'Call', phoneNumber: button.call } };
+                }
+                button.index = button.index || i;
+                return button;
+            })
+        };
+        if (message.text) {
+            hydratedTemplate.hydratedContentText = message.text;
+        }
+        else {
+            const media = await prepareWAMessageMedia(message, options);
+            if (message.caption) {
+                hydratedTemplate.hydratedTitleText = message.title;
+                hydratedTemplate.hydratedContentText = message.caption;
+            }
+            Object.assign(hydratedTemplate, media);
+        }
+        if (message.footer) {
+            hydratedTemplate.hydratedFooterText = message.footer;
+        }
+        hydratedTemplate.templateId = message.id || `template-${Date.now()}`;
+        m.templateMessage = {
+            hydratedFourRowTemplate: hydratedTemplate,
+            hydratedTemplate
+        };
+    }
+    else if (hasNonNullishProperty(message, 'nativeFlow')) {
+        const interactiveMessage = {
+            nativeFlowMessage: prepareNativeFlowButtons(message)
+        };
+        if (message.text) {
+            interactiveMessage.body = { text: message.text };
+        }
+        else {
+            const media = await prepareWAMessageMedia(message, options);
+            if (message.caption) {
+                const isValidHeader = hasValidInteractiveHeader(media);
+                if (!isValidHeader) {
+                    throw new Boom('Invalid media type for interactive message header', { statusCode: 400 });
+                }
+                interactiveMessage.header = {
+                    title: message.title || '',
+                    subtitle: message.subtitle || '',
+                    hasMediaAttachment: isValidHeader
+                };
+                interactiveMessage.body = { text: message.caption };
+            }
+            Object.assign(interactiveMessage.header || (interactiveMessage.header = {}), media);
+        }
+        if (message.audioFooter) {
+            const { audioMessage } = await prepareWAMessageMedia({ audio: message.audioFooter }, options);
+            interactiveMessage.footer = { audioMessage, hasMediaAttachment: true };
+        }
+        else if (message.footer) {
+            interactiveMessage.footer = { text: message.footer };
+        }
+        m.interactiveMessage = interactiveMessage;
+    }
+    else if (hasNonNullishProperty(message, 'cards')) {
+        const interactiveMessage = {
+            carouselMessage: {
+                cards: await Promise.all(message.cards.map(async (card) => {
+                    const carouselHeader = await prepareWAMessageMedia(card, options).catch(() => ({}));
+                    const isValidHeader = hasValidCarouselHeader(carouselHeader);
+                    if (!isValidHeader) {
+                        throw new Boom('Invalid media type for carousel card', { statusCode: 400 });
+                    }
+                    const carouselCard = {
+                        nativeFlowMessage: prepareNativeFlowButtons({ nativeFlow: card.nativeFlow || [] })
+                    };
+                    if (card.text) {
+                        carouselCard.body = { text: card.text };
+                    }
+                    else if (card.caption) {
+                        carouselCard.header = {
+                            title: card.title || '',
+                            subtitle: card.subtitle || '',
+                            hasMediaAttachment: isValidHeader,
+                            ...carouselHeader
+                        };
+                        carouselCard.body = { text: card.caption };
+                    }
+                    if (card.audioFooter) {
+                        const { audioMessage } = await prepareWAMessageMedia({ audio: card.audioFooter }, options);
+                        carouselCard.footer = { audioMessage, hasMediaAttachment: true };
+                    }
+                    else if (card.footer) {
+                        carouselCard.footer = { text: card.footer };
+                    }
+                    if (card.contextInfo) {
+                        carouselCard.contextInfo = card.contextInfo;
+                    }
+                    return carouselCard;
+                })),
+                carouselCardType: CarouselCardType.UNKNOWN,
+                messageVersion: 1
+            }
+        };
+        if (message.footer) {
+            interactiveMessage.footer = { text: message.footer };
+        }
+        m.interactiveMessage = interactiveMessage;
+    }
+    else if (hasNonNullishProperty(message, 'text')) {
         const extContent = { text: message.text };
         let urlInfo = message.linkPreview;
         if (typeof urlInfo === 'undefined') {
@@ -507,8 +751,6 @@ export const generateWAMessageContent = async (message, options) => {
         m.groupInviteMessage.caption = message.groupInvite.text;
         m.groupInviteMessage.groupJid = message.groupInvite.jid;
         m.groupInviteMessage.groupName = message.groupInvite.subject;
-        //TODO: use built-in interface and get disappearing mode info etc.
-        //TODO: cache / use store!?
         if (options.getProfilePicUrl) {
             const pfpUrl = await options.getProfilePicUrl(message.groupInvite.jid, 'preview');
             if (pfpUrl) {
@@ -553,7 +795,6 @@ export const generateWAMessageContent = async (message, options) => {
             m.eventMessage.joinLink = (message.event.call === 'audio' ? CALL_AUDIO_PREFIX : CALL_VIDEO_PREFIX) + token;
         }
         m.messageContextInfo = {
-            // encKey
             messageSecret: message.event.messageSecret || randomBytes(32)
         };
         m.eventMessage.name = message.event.name;
@@ -565,6 +806,24 @@ export const generateWAMessageContent = async (message, options) => {
         m.eventMessage.isScheduleCall = message.event.isScheduleCall ?? false;
         m.eventMessage.location = message.event.location;
     }
+    else if (hasNonNullishProperty(message, 'buttonReply')) {
+        switch (message.type) {
+            case 'template':
+                m.templateButtonReplyMessage = {
+                    selectedDisplayText: message.buttonReply.displayText,
+                    selectedId: message.buttonReply.id,
+                    selectedIndex: message.buttonReply.index
+                };
+                break;
+            case 'plain':
+                m.buttonsResponseMessage = {
+                    selectedButtonId: message.buttonReply.id,
+                    selectedDisplayText: message.buttonReply.displayText,
+                    type: proto.Message.ButtonsResponseMessage.Type.DISPLAY_TEXT
+                };
+                break;
+        }
+    }
     else if (hasNonNullishProperty(message, 'poll')) {
         (_a = message.poll).selectableCount || (_a.selectableCount = 0);
         (_b = message.poll).toAnnouncementGroup || (_b.toAnnouncementGroup = false);
@@ -577,7 +836,6 @@ export const generateWAMessageContent = async (message, options) => {
             });
         }
         m.messageContextInfo = {
-            // encKey
             messageSecret: message.poll.messageSecret || randomBytes(32)
         };
         const pollCreationMessage = {
@@ -586,16 +844,13 @@ export const generateWAMessageContent = async (message, options) => {
             options: message.poll.values.map(optionName => ({ optionName }))
         };
         if (message.poll.toAnnouncementGroup) {
-            // poll v2 is for community announcement groups (single select and multiple)
             m.pollCreationMessageV2 = pollCreationMessage;
         }
         else {
             if (message.poll.selectableCount === 1) {
-                //poll v3 is for single select polls
                 m.pollCreationMessageV3 = pollCreationMessage;
             }
             else {
-                // poll for multiple choice polls
                 m.pollCreationMessage = pollCreationMessage;
             }
         }
@@ -705,8 +960,6 @@ export const generateWAMessageContent = async (message, options) => {
     return WAProto.Message.create(m);
 };
 export const generateWAMessageFromContent = (jid, message, options) => {
-    // set timestamp to now
-    // if not specified
     if (!options.timestamp) {
         options.timestamp = new Date();
     }
@@ -716,11 +969,10 @@ export const generateWAMessageFromContent = (jid, message, options) => {
     const { quoted, userJid } = options;
     if (quoted && !isJidNewsletter(jid)) {
         const participant = quoted.key.fromMe
-            ? userJid // TODO: Add support for LIDs
+            ? userJid
             : quoted.participant || quoted.key.participant || quoted.key.remoteJid;
         let quotedMsg = normalizeMessageContent(quoted.message);
         const msgType = getContentType(quotedMsg);
-        // strip any redundant properties
         quotedMsg = proto.Message.create({ [msgType]: quotedMsg[msgType] });
         const quotedContent = quotedMsg[msgType];
         if (typeof quotedContent === 'object' && quotedContent && 'contextInfo' in quotedContent) {
@@ -730,30 +982,23 @@ export const generateWAMessageFromContent = (jid, message, options) => {
         contextInfo.participant = jidNormalizedUser(participant);
         contextInfo.stanzaId = quoted.key.id;
         contextInfo.quotedMessage = quotedMsg;
-        // if a participant is quoted, then it must be a group
-        // hence, remoteJid of group must also be entered
         if (jid !== quoted.key.remoteJid) {
             contextInfo.remoteJid = quoted.key.remoteJid;
         }
         if (contextInfo && innerMessage[key]) {
-            /* @ts-ignore */
+            ;
             innerMessage[key].contextInfo = contextInfo;
         }
     }
-    if (
-    // if we want to send a disappearing message
-    !!options?.ephemeralExpiration &&
-        // and it's not a protocol message -- delete, toggle disappear message
+    if (!!options?.ephemeralExpiration &&
         key !== 'protocolMessage' &&
-        // already not converted to disappearing message
         key !== 'ephemeralMessage' &&
-        // newsletters don't support ephemeral messages
-        !isJidNewsletter(jid)) {
-        /* @ts-ignore */
-        innerMessage[key].contextInfo = {
-            ...(innerMessage[key].contextInfo || {}),
-            expiration: options.ephemeralExpiration || WA_DEFAULT_EPHEMERAL
-            //ephemeralSettingTimestamp: options.ephemeralOptions.eph_setting_ts?.toString()
+        !isJidNewsletter(jid) &&
+        innerMessage[key]) {
+        const target = innerMessage[key];
+        target.contextInfo = {
+            ...(target.contextInfo || {}),
+            expiration: Number(options.ephemeralExpiration) || WA_DEFAULT_EPHEMERAL
         };
     }
     message = WAProto.Message.create(message);
@@ -766,18 +1011,15 @@ export const generateWAMessageFromContent = (jid, message, options) => {
         message: message,
         messageTimestamp: timestamp,
         messageStubParameters: [],
-        participant: isJidGroup(jid) || isJidStatusBroadcast(jid) ? userJid : undefined, // TODO: Add support for LIDs
+        participant: isJidGroup(jid) || isJidStatusBroadcast(jid) ? userJid : undefined,
         status: WAMessageStatus.PENDING
     };
     return WAProto.WebMessageInfo.fromObject(messageJSON);
 };
 export const generateWAMessage = async (jid, content, options) => {
-    // ensure msg ID is with every log
     options.logger = options?.logger?.child({ msgId: options.messageId });
-    // Pass jid in the options to generateWAMessageContent
     return generateWAMessageFromContent(jid, await generateWAMessageContent(content, { ...options, jid }), options);
 };
-/** Get the key to access the true type of content */
 export const getContentType = (content) => {
     if (content) {
         const keys = Object.keys(content);
@@ -785,17 +1027,10 @@ export const getContentType = (content) => {
         return key;
     }
 };
-/**
- * Normalizes ephemeral, view once messages to regular message content
- * Eg. image messages in ephemeral messages, in view once messages etc.
- * @param content
- * @returns
- */
 export const normalizeMessageContent = (content) => {
     if (!content) {
         return undefined;
     }
-    // set max iterations to prevent an infinite loop
     for (let i = 0; i < 5; i++) {
         const inner = getFutureProofMessage(content);
         if (!inner) {
@@ -817,10 +1052,6 @@ export const normalizeMessageContent = (content) => {
             message?.lottieStickerMessage);
     }
 };
-/**
- * Extract the true message content from a message
- * Eg. extracts the inner message from a disappearing message/view once message
- */
 export const extractMessageContent = (content) => {
     const extractFromTemplateMessage = (msg) => {
         if (msg.imageMessage) {
@@ -856,9 +1087,6 @@ export const extractMessageContent = (content) => {
     }
     return content;
 };
-/**
- * Returns the device predicted by message ID
- */
 export const getDevice = (id) => /^3A.{18}$/.test(id)
     ? 'ios'
     : /^3E.{20}$/.test(id)
@@ -868,7 +1096,6 @@ export const getDevice = (id) => /^3A.{18}$/.test(id)
             : /^(3F|.{18}$)/.test(id)
                 ? 'desktop'
                 : 'unknown';
-/** Upserts a receipt in the message */
 export const updateMessageWithReceipt = (msg, receipt) => {
     msg.userReceipt = msg.userReceipt || [];
     const recp = msg.userReceipt.find(m => m.userJid === receipt.userJid);
@@ -879,7 +1106,6 @@ export const updateMessageWithReceipt = (msg, receipt) => {
         msg.userReceipt.push(receipt);
     }
 };
-/** Update the message with a new reaction */
 export const updateMessageWithReaction = (msg, reaction) => {
     const authorID = getKeyAuthor(reaction.key);
     const reactions = (msg.reactions || []).filter(r => getKeyAuthor(r.key) !== authorID);
@@ -887,7 +1113,6 @@ export const updateMessageWithReaction = (msg, reaction) => {
     reactions.push(reaction);
     msg.reactions = reactions;
 };
-/** Update the message with a new poll update */
 export const updateMessageWithPollUpdate = (msg, update) => {
     const authorID = getKeyAuthor(update.pollUpdateMessageKey);
     const reactions = (msg.pollUpdates || []).filter(r => getKeyAuthor(r.pollUpdateMessageKey) !== authorID);
@@ -896,19 +1121,12 @@ export const updateMessageWithPollUpdate = (msg, update) => {
     }
     msg.pollUpdates = reactions;
 };
-/** Update the message with a new event response */
 export const updateMessageWithEventResponse = (msg, update) => {
     const authorID = getKeyAuthor(update.eventResponseMessageKey);
     const responses = (msg.eventResponses || []).filter(r => getKeyAuthor(r.eventResponseMessageKey) !== authorID);
     responses.push(update);
     msg.eventResponses = responses;
 };
-/**
- * Aggregates all poll updates in a poll.
- * @param msg the poll creation message
- * @param meId your jid
- * @returns A list of options & their voters
- */
 export function getAggregateVotesInPollMessage({ message, pollUpdates }, meId) {
     const opts = message?.pollCreationMessage?.options ||
         message?.pollCreationMessageV2?.options ||
@@ -942,12 +1160,6 @@ export function getAggregateVotesInPollMessage({ message, pollUpdates }, meId) {
     }
     return Object.values(voteHashMap);
 }
-/**
- * Aggregates all event responses in an event message.
- * @param msg the event creation message
- * @param meId your jid
- * @returns A list of response types & their responders
- */
 export function getAggregateResponsesInEventMessage({ eventResponses }, meId) {
     const responseTypes = ['GOING', 'NOT_GOING', 'MAYBE'];
     const responseMap = {};
@@ -965,7 +1177,6 @@ export function getAggregateResponsesInEventMessage({ eventResponses }, meId) {
     }
     return Object.values(responseMap);
 }
-/** Given a list of message keys, aggregates them by chat & sender. Useful for sending read receipts in bulk */
 export const aggregateMessageKeysNotFromMe = (keys) => {
     const keyMap = {};
     for (const { remoteJid, id, participant, fromMe } of keys) {
@@ -984,16 +1195,12 @@ export const aggregateMessageKeysNotFromMe = (keys) => {
     return Object.values(keyMap);
 };
 const REUPLOAD_REQUIRED_STATUS = [410, 404];
-/**
- * Downloads the given message. Throws an error if it's not a media message
- */
 export const downloadMediaMessage = async (message, type, options, ctx) => {
     const result = await downloadMsg().catch(async (error) => {
         if (ctx &&
-            typeof error?.status === 'number' && // treat errors with status as HTTP failures requiring reupload
+            typeof error?.status === 'number' &&
             REUPLOAD_REQUIRED_STATUS.includes(error.status)) {
             ctx.logger.info({ key: message.key }, 'sending reupload media request...');
-            // request reupload
             message = await ctx.reuploadRequest(message);
             const result = await downloadMsg();
             return result;
@@ -1034,7 +1241,6 @@ export const downloadMediaMessage = async (message, type, options, ctx) => {
         return stream;
     }
 };
-/** Checks whether the given message is a media message; if it is returns the inner content */
 export const assertMediaContent = (content) => {
     content = extractMessageContent(content);
     const mediaContent = content?.documentMessage ||