@badzz88/baileys 8.5.4 → 8.5.5

package/lib/Utils/messages.js

@@ -1,6 +1,17 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
-exports.generateWAMessage =
+exports.assertMediaContent =
+	exports.downloadMediaMessage =
+	exports.aggregateMessageKeysNotFromMe =
+	exports.updateMessageWithEventResponse =
+	exports.updateMessageWithPollUpdate =
+	exports.updateMessageWithReaction =
+	exports.updateMessageWithReceipt =
+	exports.getDevice =
+	exports.extractMessageContent =
+	exports.normalizeMessageContent =
+	exports.getContentType =
+	exports.generateWAMessage =
 	exports.generateWAMessageFromContent =
 	exports.generateWAMessageContent =
 	exports.hasNonNullishProperty =
@@ -10,10 +21,12 @@ exports.generateWAMessage =
 	exports.generateLinkPreviewIfRequired =
 	exports.extractUrlFromText =
 		void 0
+exports.getAggregateVotesInPollMessage = getAggregateVotesInPollMessage
+exports.getAggregateResponsesInEventMessage = getAggregateResponsesInEventMessage
 const boom_1 = require('@hapi/boom')
 const crypto_1 = require('crypto')
 const fs_1 = require('fs')
-const lru_cache_1 = require('lru-cache')
+const index_js_1 = require('../../WAProto/index.js')
 const WAProto_1 = require('../../WAProto/index.js')
 const Defaults_1 = require('../Defaults')
 const Types_1 = require('../Types')
@@ -23,12 +36,6 @@ const generics_1 = require('./generics')
 const messages_media_1 = require('./messages-media')
 const reporting_utils_1 = require('./reporting-utils')
 const jid_display_normalization_1 = require('./jid-display-normalization')
-const message_inspect_1 = require('./message-inspect')
-Object.assign(exports, message_inspect_1)
-
-
-
-const groupInviteThumbnailCache = new lru_cache_1.LRUCache({ max: 100, ttl: 5 * 60 * 1000 })
 const MIMETYPE_MAP = {
 	image: 'image/jpeg',
 	video: 'video/mp4',
@@ -45,14 +52,14 @@ const MessageTypeProto = {
 	document: WAProto_1.proto.Message.DocumentMessage
 }
 
-
+// Input payloads can carry protobuf media message keys (e.g. imageMessage).
 const MEDIA_MESSAGE_TYPE_ALIASES = {
 	imageMessage: 'image',
 	videoMessage: 'video',
 	audioMessage: 'audio',
 	documentMessage: 'document',
 	stickerMessage: 'sticker',
-	
+	// PTV = push-to-video (video note) payload.
 	ptvMessage: 'video'
 }
 const MEDIA_MESSAGE_TYPE_ALIAS_KEYS = Object.keys(MEDIA_MESSAGE_TYPE_ALIASES)
@@ -189,7 +196,11 @@ const tokenizeCode = code => {
 	return merged
 }
 
-
+/**
+ * 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
+ */
 const extractUrlFromText = text => text.match(Defaults_1.URL_REGEX)?.[0]
 exports.extractUrlFromText = extractUrlFromText
 const generateLinkPreviewIfRequired = async (text, getUrlInfo, logger) => {
@@ -199,7 +210,7 @@ const generateLinkPreviewIfRequired = async (text, getUrlInfo, logger) => {
 			const urlInfo = await getUrlInfo(url)
 			return urlInfo
 		} catch (error) {
-			
+			// ignore if fails
 			logger?.warn({ trace: error.stack }, 'url generation failed')
 		}
 	}
@@ -220,9 +231,6 @@ const assertColor = async color => {
 }
 const prepareWAMessageMedia = async (message, options) => {
 	const logger = options.logger
-	
-	const mediaAbProps = options.mediaAbProps || null
-	const getMediaProp = propName => (0, messages_media_1.getMediaProp)(mediaAbProps, propName)
 	let mediaType
 	for (const key of Defaults_1.MEDIA_KEYS) {
 		if (key in message) {
@@ -237,20 +245,7 @@ const prepareWAMessageMedia = async (message, options) => {
 		media: message[mediaType]
 	}
 	delete uploadData[mediaType]
-
-	
-	
-	
-	if (mediaType === 'video' && uploadData.mimetype) {
-		const isHevc = uploadData.mimetype.includes('hevc') || uploadData.mimetype.includes('x-matroska')
-		if (isHevc && !getMediaProp('hevc_video_dual_upload')) {
-			
-			uploadData.mimetype = MIMETYPE_MAP['video']
-		}
-		
-	}
-
-	
+	// check if cacheable + generate cache key
 	const cacheableKey =
 		typeof uploadData.media === 'object' &&
 		'url' in uploadData.media &&
@@ -267,7 +262,7 @@ const prepareWAMessageMedia = async (message, options) => {
 		const mediaBuff = await options.mediaCache.get(cacheableKey)
 		if (mediaBuff) {
 			logger?.debug({ cacheableKey }, 'got media cache hit')
-			const obj = WAProto_1.proto.Message.decode(mediaBuff)
+			const obj = index_js_1.proto.Message.decode(mediaBuff)
 			const key = `${mediaType}Message`
 			Object.assign(obj[key], { ...uploadData, media: undefined })
 			return obj
@@ -289,7 +284,7 @@ const prepareWAMessageMedia = async (message, options) => {
 		})
 		await fs_1.promises.unlink(filePath)
 		const obj = WAProto_1.proto.Message.fromObject({
-			
+			// todo: add more support here
 			[`${mediaType}Message`]: MessageTypeProto[mediaType].fromObject({
 				url: mediaUrl,
 				directPath,
@@ -380,27 +375,6 @@ const prepareWAMessageMedia = async (message, options) => {
 			logger?.warn('failed to remove tmp file')
 		}
 	})
-
-	
-	
-	const hdImageEnabled = mediaType === 'image' && getMediaProp('hd_image_dual_upload') && !!uploadData.hd
-	const hdVideoEnabled = mediaType === 'video' && getMediaProp('hd_video_dual_upload') && !!uploadData.hd
-	if (hdImageEnabled || hdVideoEnabled) {
-		uploadData.mediaHd = true
-		logger?.debug({ mediaType }, 'HD dual upload enabled, setting mediaHd flag')
-	}
-
-	
-	
-	if (mediaType === 'image' && uploadData.motionPhoto != null) {
-		
-		
-		if (typeof uploadData.motionPhoto === 'boolean') {
-			uploadData.motionPhoto = uploadData.motionPhoto ? 1 : 0
-		}
-		logger?.debug('motion photo field set on image message')
-	}
-
 	const obj = WAProto_1.proto.Message.fromObject({
 		[`${mediaType}Message`]: MessageTypeProto[mediaType].fromObject({
 			url: mediaUrl,
@@ -440,15 +414,19 @@ const prepareDisappearingMessageSettingContent = ephemeralExpiration => {
 	return WAProto_1.proto.Message.fromObject(content)
 }
 exports.prepareDisappearingMessageSettingContent = prepareDisappearingMessageSettingContent
-
+/**
+ * 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
+ */
 const generateForwardMessageContent = (message, forceForward) => {
 	let content = message.message
 	if (!content) {
 		throw new boom_1.Boom('no content in message', { statusCode: 400 })
 	}
-	
+	// hacky copy
 	content = (0, exports.normalizeMessageContent)(content)
-	content = WAProto_1.proto.Message.decode(WAProto_1.proto.Message.encode(content).finish())
+	content = index_js_1.proto.Message.decode(index_js_1.proto.Message.encode(content).finish())
 	let key = Object.keys(content)[0]
 	let score = content?.[key]?.contextInfo?.forwardingScore || 0
 	score += message.key.fromMe && !forceForward ? 0 : 1
@@ -676,19 +654,15 @@ 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 cached = groupInviteThumbnailCache.get(message.groupInvite.jid)
-			if (cached) {
-				m.groupInviteMessage.jpegThumbnail = cached
-			} else {
-				const pfpUrl = await options.getProfilePicUrl(message.groupInvite.jid, 'preview')
-				if (pfpUrl) {
-					const resp = await fetch(pfpUrl, { method: 'GET', dispatcher: options?.options?.dispatcher })
-					if (resp.ok) {
-						const buf = Buffer.from(await resp.arrayBuffer())
-						m.groupInviteMessage.jpegThumbnail = buf
-						groupInviteThumbnailCache.set(message.groupInvite.jid, buf)
-					}
+			const pfpUrl = await options.getProfilePicUrl(message.groupInvite.jid, 'preview')
+			if (pfpUrl) {
+				const resp = await fetch(pfpUrl, { method: 'GET', dispatcher: options?.options?.dispatcher })
+				if (resp.ok) {
+					const buf = Buffer.from(await resp.arrayBuffer())
+					m.groupInviteMessage.jpegThumbnail = buf
 				}
 			}
 		}
@@ -712,7 +686,7 @@ const generateWAMessageContent = async (message, options) => {
 				m.buttonsResponseMessage = {
 					selectedButtonId: message.buttonReply.id,
 					selectedDisplayText: message.buttonReply.displayText,
-					type: WAProto_1.proto.Message.ButtonsResponseMessage.Type.DISPLAY_TEXT
+					type: index_js_1.proto.Message.ButtonsResponseMessage.Type.DISPLAY_TEXT
 				}
 				break
 			case 'interactive':
@@ -762,7 +736,7 @@ const generateWAMessageContent = async (message, options) => {
 				(message.event.call === 'audio' ? Defaults_1.CALL_AUDIO_PREFIX : Defaults_1.CALL_VIDEO_PREFIX) + token
 		}
 		m.messageContextInfo = {
-			
+			// encKey
 			messageSecret: message.event.messageSecret || (0, crypto_1.randomBytes)(32)
 		}
 		m.eventMessage.name = message.event.name
@@ -806,26 +780,21 @@ const generateWAMessageContent = async (message, options) => {
 			...(message.poll.hideParticipantName !== undefined
 				? { hideParticipantName: !!message.poll.hideParticipantName }
 				: {}),
-			...(message.poll.allowAddOption !== undefined ? { allowAddOption: !!message.poll.allowAddOption } : {}),
-			
-			
-			...((0, messages_media_1.getMediaProp)(options.mediaAbProps, 'media_poll') && message.poll.mediaPoll != null
-				? { mediaPoll: !!message.poll.mediaPoll }
-				: {})
+			...(message.poll.allowAddOption !== undefined ? { allowAddOption: !!message.poll.allowAddOption } : {})
 		}
 		if (message.poll.version === 6 || message.poll.v6) {
 			m.pollCreationMessageV6 = pollCreationMessage
 		} else if (message.poll.version === 5 || message.poll.v5) {
 			m.pollCreationMessageV5 = pollCreationMessage
 		} else 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
 			}
 		}
@@ -954,13 +923,13 @@ const generateWAMessageContent = async (message, options) => {
 		}
 	} else if ((0, exports.hasNonNullishProperty)(message, 'sharePhoneNumber')) {
 		m.protocolMessage = {
-			type: WAProto_1.proto.Message.ProtocolMessage.Type.SHARE_PHONE_NUMBER
+			type: index_js_1.proto.Message.ProtocolMessage.Type.SHARE_PHONE_NUMBER
 		}
 	} else if ((0, exports.hasNonNullishProperty)(message, 'requestPhoneNumber')) {
 		m.requestPhoneNumberMessage = {}
 	} else if ((0, exports.hasNonNullishProperty)(message, 'limitSharing')) {
 		m.protocolMessage = {
-			type: WAProto_1.proto.Message.ProtocolMessage.Type.LIMIT_SHARING,
+			type: index_js_1.proto.Message.ProtocolMessage.Type.LIMIT_SHARING,
 			limitSharing: {
 				sharingLimited: message.limitSharing === true,
 				trigger: 1,
@@ -1017,7 +986,7 @@ const generateWAMessageContent = async (message, options) => {
 	} else if ('interactiveMessage' in message) {
 		m = { interactiveMessage: message.interactiveMessage }
 	} else if ('richResponse' in message) {
-		
+		// handled in richResponse block below
 	} else if ('groupStatusMessage' in message) {
 		m = { groupStatusMessage: WAProto_1.proto.Message.GroupStatusMessage.fromObject(message.groupStatusMessage) }
 	} else if (hasCaptionWithoutMedia && !hasCaptionContainer) {
@@ -1063,7 +1032,7 @@ const generateWAMessageContent = async (message, options) => {
 		m = { interactiveMessage }
 	} else if ('templateButtons' in message && !!message.templateButtons) {
 		const msg = {
-			hydratedButtons: message.templateButtons
+			hydratedButtons: message.hasOwnProperty('templateButtons') ? message.templateButtons : message.templateButtons
 		}
 		if ('text' in message) {
 			msg.hydratedContentText = message.text
@@ -1120,42 +1089,73 @@ const generateWAMessageContent = async (message, options) => {
 		}
 	}
 	if ('interactiveButtons' in message && !!message.interactiveButtons) {
-		const interactiveMessage = {
-			nativeFlowMessage: WAProto_1.proto.Message.InteractiveMessage.NativeFlowMessage.fromObject({
-				buttons: message.interactiveButtons
-			})
-		}
-		if ('text' in message) {
-			interactiveMessage.body = {
-				text: message.text
-			}
-		} else if ('caption' in message) {
-			interactiveMessage.body = {
-				text: message.caption
-			}
-			interactiveMessage.header = {
-				title: message.title,
-				subtitle: message.subtitle,
-				hasMediaAttachment: Boolean(message.hasMediaAttachment)
-			}
-			Object.assign(interactiveMessage.header, m)
-		}
-		if ('footer' in message && !!message.footer) {
-			interactiveMessage.footer = {
-				text: message.footer
-			}
-		}
-		if ('title' in message && !!message.title) {
-			interactiveMessage.header = {
-				title: message.title,
-				subtitle: message.subtitle,
-				hasMediaAttachment: Boolean(message.hasMediaAttachment)
-			}
-			Object.assign(interactiveMessage.header, m)
-		}
-		applyContextInfoAndMentions(interactiveMessage, message)
-		m = { interactiveMessage }
-	}
+        const nativeFlow = WAProto_1.proto.Message.InteractiveMessage.NativeFlowMessage.fromObject({
+            buttons: message.interactiveButtons,
+            messageParamsJson: message.messageParams ?? "{}"
+        });
+        let interactiveMessage = { nativeFlowMessage: nativeFlow };
+        if ('text' in message) {
+            interactiveMessage.body = { text: message.text };
+        } else if ('caption' in message) {
+            interactiveMessage.body = { text: message.caption };
+        }
+        if ('title' in message && !!message.title) {
+            interactiveMessage.header = {
+                title: message.title,
+                subtitle: message.subtitle || "",
+                hasMediaAttachment: false
+            };
+            let media = null;
+            if ('image' in message && !!message.image) {
+                media = await prepareWAMessageMedia({ image: message.image }, options);
+                interactiveMessage.header.imageMessage = media.imageMessage;
+                if (message.image.caption) {
+                    interactiveMessage.header.imageMessage.caption = message.image.caption;
+                }
+            } else if ('video' in message && !!message.video) {
+                media = await prepareWAMessageMedia({ video: message.video }, options);
+                interactiveMessage.header.videoMessage = media.videoMessage;
+                if (message.video.caption) {
+                    interactiveMessage.header.videoMessage.caption = message.video.caption;
+                }
+            } else if ('gif' in message && !!message.gif) {
+                media = await prepareWAMessageMedia({ video: message.gif }, options);
+                interactiveMessage.header.videoMessage = media.videoMessage;
+                interactiveMessage.header.videoMessage.gifPlayback = true;
+                if (message.gif.caption) {
+                    interactiveMessage.header.videoMessage.caption = message.gif.caption;
+                }
+            } else if ('document' in message && !!message.document) {
+                media = await prepareWAMessageMedia({ document: message.document }, options);
+                interactiveMessage.header.documentMessage = media.documentMessage;
+                let docuR = interactiveMessage.header.documentMessage;
+                docuR.fileName = message.document.fileName || "Document";
+                docuR.mimetype = message.document.mimetype || docuR.mimetype;
+                if (message.document.caption) docuR.caption = message.document.caption;
+                if (message.document.jpegThumbnail) docuR.jpegThumbnail = message.document.jpegThumbnail;
+            } else if ('location' in message && !!message.location) {
+                let mLoc = message.location;
+                interactiveMessage.header.locationMessage = {
+                    degreesLongitude: mLoc.longitude || 0,
+                    degreesLatitude: mLoc.latitude || 0,
+                    name: mLoc.name || null,
+                    address: mLoc.address || null,
+                    url: mLoc.url || null
+                };
+                media = true;
+            } else if ('thumbnail' in message && !!message.thumbnail) {
+                interactiveMessage.header.jpegThumbnail = message.thumbnail;
+            }
+            if (media || ('thumbnail' in message && !!message.thumbnail)) {
+                interactiveMessage.header.hasMediaAttachment = true;
+            }
+        }
+        if ('footer' in message && !!message.footer) {
+            interactiveMessage.footer = { text: message.footer };
+        }
+        applyContextInfoAndMentions(interactiveMessage, message);
+        m = { interactiveMessage };
+    }
 	if ('shop' in message && !!message.shop) {
 		const interactiveMessage = {
 			shopStorefrontMessage: WAProto_1.proto.Message.InteractiveMessage.ShopMessage.fromObject({
@@ -1232,12 +1232,22 @@ const generateWAMessageContent = async (message, options) => {
 				}
 			})
 		}
-		if (table && Array.isArray(table.rows)) {
+		if (table) {
+			const isPlainArrayTable = Array.isArray(table)
+			const rows = isPlainArrayTable ? table : table.rows
+			if (!Array.isArray(rows)) {
+				throw new boom_1.Boom(
+					'richResponse.table must be an array of rows (e.g. [["h1","h2"],["a","b"]]) or { rows: [...] }',
+					{ statusCode: 400 }
+				)
+			}
 			sections.push({
 				view_model: {
 					primitive: {
-						rows: table.rows.map(row => ({
-							cells: Array.isArray(row) ? row.map(c => ({ text: String(c) })) : row.cells
+						rows: rows.map((row, idx) => ({
+							cells: Array.isArray(row) ? row.map(c => ({ text: String(c) })) : row.cells,
+							// when a plain 2D array is passed, the first row is treated as the table header
+							isHeading: Array.isArray(row) ? isPlainArrayTable && idx === 0 : row.isHeading
 						})),
 						__typename: 'GenAITableUXPrimitive'
 					},
@@ -1868,10 +1878,9 @@ const generateWAMessageContent = async (message, options) => {
 			...existing,
 			botThreadInfo: {
 				clientInfo: {
-					type:
-						typeof bt.type === 'string'
-							? (threadTypeMap[bt.type.toLowerCase()] ?? threadTypeEnum.UNKNOWN)
-							: (bt.type ?? threadTypeEnum.UNKNOWN),
+					type: typeof bt.type === 'string'
+						? (threadTypeMap[bt.type.toLowerCase()] ?? threadTypeEnum.UNKNOWN)
+						: (bt.type ?? threadTypeEnum.UNKNOWN),
 					sourceChatJid: bt.sourceChatJid || ''
 				}
 			}
@@ -2272,7 +2281,7 @@ const generateWAMessageContent = async (message, options) => {
 		m.messageContextInfo = {
 			...(m.messageContextInfo || {}),
 			messageAddOnDurationInSecs: message.afterReadDuration,
-			messageAddOnExpiryType: WAProto_1.proto.MessageContextInfo.MessageAddonExpiryType.DEPENDENT_ON_PARENT
+			messageAddOnExpiryType: index_js_1.proto.MessageContextInfo.MessageAddonExpiryType.DEPENDENT_ON_PARENT
 		}
 	}
 	if ('raw' in message && !!message.raw) {
@@ -2401,8 +2410,8 @@ const generateWAMessageContent = async (message, options) => {
 }
 exports.generateWAMessageContent = generateWAMessageContent
 const generateWAMessageFromContent = (jid, message, options) => {
-	
-	
+	// set timestamp to now
+	// if not specified
 	if (!options.timestamp) {
 		options.timestamp = new Date()
 	}
@@ -2412,12 +2421,12 @@ const generateWAMessageFromContent = (jid, message, options) => {
 	const { quoted, userJid } = options
 	if (quoted && !(0, WABinary_1.isJidNewsletter)(jid)) {
 		const participant = quoted.key.fromMe
-			? userJid 
+			? userJid // TODO: Add support for LIDs
 			: quoted.participant || quoted.key.participant || quoted.key.remoteJid
 		let quotedMsg = (0, exports.normalizeMessageContent)(quoted.message)
 		const msgType = (0, exports.getContentType)(quotedMsg)
-		
-		quotedMsg = WAProto_1.proto.Message.create({ [msgType]: quotedMsg[msgType] })
+		// strip any redundant properties
+		quotedMsg = index_js_1.proto.Message.create({ [msgType]: quotedMsg[msgType] })
 		const quotedContent = quotedMsg[msgType]
 		if (typeof quotedContent === 'object' && quotedContent && 'contextInfo' in quotedContent) {
 			delete quotedContent.contextInfo
@@ -2426,53 +2435,62 @@ const generateWAMessageFromContent = (jid, message, options) => {
 		contextInfo.participant = (0, WABinary_1.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
 		key !== 'protocolMessage' &&
-		
+		// already not converted to disappearing message
 		key !== 'ephemeralMessage' &&
-		
+		// newsletters don't support ephemeral messages
 		!(0, WABinary_1.isJidNewsletter)(jid)
 	) {
-		
+		/* @ts-ignore */
 		innerMessage[key].contextInfo = {
 			...(innerMessage[key].contextInfo || {}),
 			expiration: options.ephemeralExpiration || Defaults_1.WA_DEFAULT_EPHEMERAL
-			
+			//ephemeralSettingTimestamp: options.ephemeralOptions.eph_setting_ts?.toString()
 		}
 	}
 	message = WAProto_1.proto.Message.create(message)
+	const iosBros = options?.browser?.[0] === 'iOS' || options?.browser?.[1] === 'Safari'
+	const androidBros = options?.browser?.[0] === 'Android'
+	const pickedMessageId =
+		options?.messageId ||
+		(iosBros
+			? (0, generics_1.generateIOSMessageID)()
+			: androidBros
+				? (0, generics_1.generateAndroMessageID)()
+				: (0, generics_1.generateMessageIDV2)(userJid))
 	const messageJSON = {
 		key: {
 			remoteJid: jid,
 			fromMe: true,
-			id: options?.messageId || (0, generics_1.generateMessageIDV2)()
+			id: pickedMessageId
 		},
 		message: message,
 		messageTimestamp: timestamp,
 		messageStubParameters: [],
-		participant: (0, WABinary_1.isJidGroup)(jid) || (0, WABinary_1.isJidStatusBroadcast)(jid) ? userJid : undefined, 
+		participant: (0, WABinary_1.isJidGroup)(jid) || (0, WABinary_1.isJidStatusBroadcast)(jid) ? userJid : undefined, // TODO: Add support for LIDs
 		status: Types_1.WAMessageStatus.PENDING
 	}
 	return WAProto_1.proto.WebMessageInfo.fromObject(messageJSON)
 }
 exports.generateWAMessageFromContent = generateWAMessageFromContent
 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 (0, exports.generateWAMessageFromContent)(
 		jid,
 		await (0, exports.generateWAMessageContent)(content, { ...options, jid }),
@@ -2480,3 +2498,407 @@ const generateWAMessage = async (jid, content, options) => {
 	)
 }
 exports.generateWAMessage = generateWAMessage
+/** Get the key to access the true type of content */
+const getContentType = content => {
+	if (content) {
+		const keys = Object.keys(content)
+		const key = keys.find(k => (k === 'conversation' || k.includes('Message')) && k !== 'senderKeyDistributionMessage')
+		return key
+	}
+}
+exports.getContentType = getContentType
+/**
+ * Normalizes ephemeral, view once messages to regular message content
+ * Eg. image messages in ephemeral messages, in view once messages etc.
+ * @param content
+ * @returns
+ */
+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) {
+			break
+		}
+		content = inner.message
+	}
+	return content
+	function getFutureProofMessage(message) {
+		return (
+			message.ephemeralMessage ||
+			message.viewOnceMessage ||
+			message.documentWithCaptionMessage ||
+			message.viewOnceMessageV2 ||
+			message.viewOnceMessageV2Extension ||
+			message.editedMessage ||
+			message.groupMentionedMessage ||
+			message.botInvokeMessage ||
+			message.lottieStickerMessage ||
+			message.eventCoverImage ||
+			message.statusMentionMessage ||
+			message.pollCreationOptionImageMessage ||
+			message.associatedChildMessage ||
+			message.groupStatusMentionMessage ||
+			message.pollCreationMessageV4 ||
+			message.pollCreationMessageV5 ||
+			message.statusAddYours ||
+			message.groupStatusMessage ||
+			message.limitSharingMessage ||
+			message.botTaskMessage ||
+			message.questionMessage ||
+			message.groupStatusMessageV2 ||
+			message.botForwardedMessage ||
+			message.questionReplyMessage ||
+			message.newsletterAdminProfileMessage ||
+			message.newsletterAdminProfileMessageV2 ||
+			message.newsletterAdminProfileStatusMessage ||
+			message.spoilerMessage ||
+			message.groupStatusV3Message ||
+			message.pollCreationMessageV6
+		)
+	}
+}
+exports.normalizeMessageContent = normalizeMessageContent
+/**
+ * Extract the true message content from a message
+ * Eg. extracts the inner message from a disappearing message/view once message
+ */
+const extractMessageContent = content => {
+	const extractFromTemplateMessage = msg => {
+		if (msg.imageMessage) {
+			return { imageMessage: msg.imageMessage }
+		} else if (msg.documentMessage) {
+			return { documentMessage: msg.documentMessage }
+		} else if (msg.videoMessage) {
+			return { videoMessage: msg.videoMessage }
+		} else if (msg.locationMessage) {
+			return { locationMessage: msg.locationMessage }
+		} else {
+			return {
+				conversation:
+					'contentText' in msg ? msg.contentText : 'hydratedContentText' in msg ? msg.hydratedContentText : ''
+			}
+		}
+	}
+	content = (0, exports.normalizeMessageContent)(content)
+	if (content?.buttonsMessage) {
+		return extractFromTemplateMessage(content.buttonsMessage)
+	}
+	if (content?.templateMessage?.hydratedFourRowTemplate) {
+		return extractFromTemplateMessage(content?.templateMessage?.hydratedFourRowTemplate)
+	}
+	if (content?.templateMessage?.hydratedTemplate) {
+		return extractFromTemplateMessage(content?.templateMessage?.hydratedTemplate)
+	}
+	if (content?.templateMessage?.fourRowTemplate) {
+		return extractFromTemplateMessage(content?.templateMessage?.fourRowTemplate)
+	}
+	return content
+}
+exports.extractMessageContent = extractMessageContent
+/**
+ * Returns the device predicted by message ID
+ */
+const getDevice = id =>
+	/^3A.{18}$/.test(id)
+		? 'ios'
+		: /^3E.{20}$/.test(id)
+			? 'web'
+			: /^(.{21}|.{32})$/.test(id)
+				? 'android'
+				: /^(3F|.{18}$)/.test(id)
+					? 'desktop'
+					: 'api/baileys'
+exports.getDevice = getDevice
+/** Upserts a receipt in the message */
+const updateMessageWithReceipt = (msg, receipt) => {
+	msg.userReceipt = msg.userReceipt || []
+	const recp = msg.userReceipt.find(m => m.userJid === receipt.userJid)
+	if (recp) {
+		Object.assign(recp, receipt)
+	} else {
+		msg.userReceipt.push(receipt)
+	}
+}
+exports.updateMessageWithReceipt = updateMessageWithReceipt
+/** Update the message with a new reaction */
+const updateMessageWithReaction = (msg, reaction) => {
+	const authorID = (0, generics_1.getKeyAuthor)(reaction.key)
+	const reactions = (msg.reactions || []).filter(r => (0, generics_1.getKeyAuthor)(r.key) !== authorID)
+	reaction.text = reaction.text || ''
+	reactions.push(reaction)
+	msg.reactions = reactions
+}
+exports.updateMessageWithReaction = updateMessageWithReaction
+/** Update the message with a new poll update */
+const updateMessageWithPollUpdate = (msg, update) => {
+	const authorID = (0, generics_1.getKeyAuthor)(update.pollUpdateMessageKey)
+	const reactions = (msg.pollUpdates || []).filter(
+		r => (0, generics_1.getKeyAuthor)(r.pollUpdateMessageKey) !== authorID
+	)
+	if (update.vote?.selectedOptions?.length) {
+		reactions.push(update)
+	}
+	msg.pollUpdates = reactions
+}
+exports.updateMessageWithPollUpdate = updateMessageWithPollUpdate
+/** Update the message with a new event response */
+const updateMessageWithEventResponse = (msg, update) => {
+	const authorID = (0, generics_1.getKeyAuthor)(update.eventResponseMessageKey)
+	const responses = (msg.eventResponses || []).filter(
+		r => (0, generics_1.getKeyAuthor)(r.eventResponseMessageKey) !== authorID
+	)
+	responses.push(update)
+	msg.eventResponses = responses
+}
+exports.updateMessageWithEventResponse = updateMessageWithEventResponse
+/**
+ * Aggregates all poll updates in a poll.
+ * @param msg the poll creation message
+ * @param meId your jid
+ * @returns A list of options & their voters
+ */
+function getAggregateVotesInPollMessage({ message, pollUpdates }, meId) {
+	const opts =
+		message?.pollCreationMessage?.options ||
+		message?.pollCreationMessageV2?.options ||
+		message?.pollCreationMessageV3?.options ||
+		message?.pollCreationMessageV5?.options ||
+		message?.pollCreationMessageV6?.options ||
+		message?.pollCreationMessageV4?.message?.pollCreationMessage?.options ||
+		message?.pollCreationMessageV4?.message?.pollCreationMessageV3?.options ||
+		[]
+	const voteHashMap = opts.reduce((acc, opt) => {
+		const hash = (0, crypto_2.sha256)(Buffer.from(opt.optionName || '')).toString()
+		acc[hash] = {
+			name: opt.optionName || '',
+			voters: []
+		}
+		return acc
+	}, {})
+	for (const update of pollUpdates || []) {
+		const { vote } = update
+		if (!vote) {
+			continue
+		}
+		for (const option of vote.selectedOptions || []) {
+			const hash = option.toString()
+			let data = voteHashMap[hash]
+			if (!data) {
+				voteHashMap[hash] = {
+					name: 'Unknown',
+					voters: []
+				}
+				data = voteHashMap[hash]
+			}
+			voteHashMap[hash].voters.push((0, generics_1.getKeyAuthor)(update.pollUpdateMessageKey, meId))
+		}
+	}
+	return Object.values(voteHashMap)
+}
+/** Given a list of message keys, aggregates them by chat & sender. Useful for sending read receipts in bulk */
+const aggregateMessageKeysNotFromMe = keys => {
+	const keyMap = {}
+	for (const { remoteJid, id, participant, fromMe, sts } of keys) {
+		if (!fromMe) {
+			const uqKey = `${remoteJid}:${participant || ''}`
+			if (!keyMap[uqKey]) {
+				keyMap[uqKey] = {
+					jid: remoteJid,
+					participant: participant,
+					messageIds: [],
+					// sts is per-message; kept only for single-message interop receipts
+					sts: sts
+				}
+			} else if (keyMap[uqKey].sts !== sts) {
+				// Multiple messages with different sts — can't aggregate a single sts
+				keyMap[uqKey].sts = undefined
+			}
+			keyMap[uqKey].messageIds.push(id)
+		}
+	}
+	return Object.values(keyMap)
+}
+exports.aggregateMessageKeysNotFromMe = aggregateMessageKeysNotFromMe
+
+/**
+ * Check if a WebMessageInfo has a scheduled reveal time (ConditionalRevealMessage)
+ */
+const isScheduledMessage = msg => !!msg?.scheduledMessageMetadata?.scheduledTime
+exports.isScheduledMessage = isScheduledMessage
+
+/**
+ * Get scheduled reveal time of a message as a Date, or null
+ */
+const getScheduledMessageTime = msg => {
+	const t = msg?.scheduledMessageMetadata?.scheduledTime
+	if (!t) return null
+	return new Date(Number(t) * 1000)
+}
+exports.getScheduledMessageTime = getScheduledMessageTime
+
+/**
+ * Extract PaymentInfo from a WebMessageInfo (the payment status field, not the message content)
+ */
+const getMessagePaymentInfo = msg => msg?.paymentInfo || msg?.quotedPaymentInfo || null
+exports.getMessagePaymentInfo = getMessagePaymentInfo
+
+/**
+ * Get all comment metadata from a WebMessageInfo
+ */
+const getMessageCommentMetadata = msg => msg?.commentMetadata || null
+exports.getMessageCommentMetadata = getMessageCommentMetadata
+
+/**
+ * Get all message add-ons (reactions, poll updates, pins) from a WebMessageInfo
+ */
+const getMessageAddOns = msg => msg?.messageAddOns || []
+exports.getMessageAddOns = getMessageAddOns
+
+/**
+ * Get the quiz correct answer from a poll creation message, if it's a quiz
+ */
+const getPollCorrectAnswer = pollMsg => {
+	const poll =
+		pollMsg?.pollCreationMessage ||
+		pollMsg?.pollCreationMessageV2 ||
+		pollMsg?.pollCreationMessageV3 ||
+		pollMsg?.pollCreationMessageV5 ||
+		pollMsg?.pollCreationMessageV6
+	if (!poll) return null
+	const isQuiz = poll.pollType === WAProto_1.proto.Message.PollType?.QUIZ || poll.pollType === 1
+	return isQuiz ? poll.correctAnswer?.optionName || null : null
+}
+exports.getPollCorrectAnswer = getPollCorrectAnswer
+
+/**
+ * Aggregates all event responses in an event message.
+ * @param msg the event creation message
+ * @param meLid your lid
+ * @returns A list of response types & their responders
+ */
+function getAggregateResponsesInEventMessage({ eventResponses }, meLid) {
+	const responseTypes = ['GOING', 'NOT_GOING', 'MAYBE']
+	const responseMap = {}
+
+	for (const type of responseTypes) {
+		responseMap[type] = {
+			response: type,
+			responders: []
+		}
+	}
+	for (const update of eventResponses) {
+		const { response } = update.response || {}
+		const responseType = index_js_1.proto.Message.EventResponseMessage.EventResponseType[response]
+		if (responseType !== 'UNKNOWN' && responseMap[responseType]) {
+			responseMap[responseType].responders.push(generics_1.getKeyAuthor(update.eventResponseMessageKey, meLid))
+		}
+	}
+
+	return Object.values(responseMap)
+}
+
+exports.getAggregateResponsesInEventMessage = getAggregateResponsesInEventMessage
+
+const REUPLOAD_REQUIRED_STATUS = [410, 404]
+/**
+ * Downloads the given message. Throws an error if it's not a media message
+ */
+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
+			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
+		}
+		throw error
+	})
+	return result
+	async function downloadMsg() {
+		const mContent = (0, exports.extractMessageContent)(message.message)
+		if (!mContent) {
+			throw new boom_1.Boom('No message present', { statusCode: 400, data: message })
+		}
+		const contentType = (0, exports.getContentType)(mContent)
+		let mediaType = contentType?.replace('Message', '')
+		const media = mContent[contentType]
+		if (!media || typeof media !== 'object' || (!('url' in media) && !('thumbnailDirectPath' in media))) {
+			throw new boom_1.Boom(`"${contentType}" message is not a media message`)
+		}
+		let download
+		if ('thumbnailDirectPath' in media && !('url' in media)) {
+			download = {
+				directPath: media.thumbnailDirectPath,
+				mediaKey: media.mediaKey
+			}
+			mediaType = 'thumbnail-link'
+		} else {
+			download = media
+		}
+		const stream = await (0, messages_media_1.downloadContentFromMessage)(download, mediaType, options)
+		if (type === 'buffer') {
+			const bufferArray = []
+			for await (const chunk of stream) {
+				bufferArray.push(chunk)
+			}
+			return Buffer.concat(bufferArray)
+		}
+		return stream
+	}
+}
+exports.downloadMediaMessage = downloadMediaMessage
+/** Checks whether the given message is a media message; if it is returns the inner content */
+const assertMediaContent = content => {
+	content = (0, exports.extractMessageContent)(content)
+	const mediaContent =
+		content?.documentMessage ||
+		content?.imageMessage ||
+		content?.videoMessage ||
+		content?.audioMessage ||
+		content?.stickerMessage
+	if (!mediaContent) {
+		throw new boom_1.Boom('given message is not a media message', { statusCode: 400, data: content })
+	}
+	return mediaContent
+}
+exports.assertMediaContent = assertMediaContent
+/**
+ * Normalizes a bare user id to @s.whatsapp.net. Does not convert LID↔PN; use lidMapping / PN in key.remoteJidAlt when needed.
+ */
+const toJid = id => {
+	if (!id) return ''
+	if (id.includes('@')) return id
+	return `${id}@s.whatsapp.net`
+}
+exports.toJid = toJid
+/**
+ * Returns the peer LID JID when the key is LID-primary (decode sets remoteJid/participant to @lid when WA sends LID).
+ */
+const getSenderLid = message => {
+	const k = message.key
+	if (!k) {
+		return { jid: '', lid: '' }
+	}
+	const jid = k.participant || k.remoteJid || ''
+	if (jid.endsWith('@lid') || jid.endsWith('@hosted.lid')) {
+		return { jid, lid: jid }
+	}
+	if (k.lid && typeof k.lid === 'string') {
+		const lid = k.lid.includes('@') ? k.lid : (0, WABinary_1.jidEncode)(k.lid, 'lid')
+		return { jid, lid }
+	}
+	if (k.participantLid && (0, WABinary_1.isLidUser)(k.participantLid)) {
+		return { jid, lid: k.participantLid }
+	}
+	return { jid, lid: '' }
+}
+exports.getSenderLid = getSenderLid