@badzz88/baileys 8.5.4 → 8.5.5

package/lib/Store/make-in-memory-store.js

@@ -37,6 +37,44 @@ const waLabelAssociationKey = {
 
 const makeMessagesDictionary = () => Store_1.makeOrderedDictionary(waMessageID)
 
+const ENCRYPTED_STORE_MARKER = 'xazbails-store-v1'
+
+const deriveStoreKey = secret => {
+	const { createHash } = require('crypto')
+	return createHash('sha256').update(String(secret)).digest()
+}
+
+const encryptStoreJSON = (jsonStr, secret) => {
+	const { createCipheriv, randomBytes } = require('crypto')
+	const key = deriveStoreKey(secret)
+	const iv = randomBytes(12)
+	const cipher = createCipheriv('aes-256-gcm', key, iv)
+	const encrypted = Buffer.concat([cipher.update(jsonStr, 'utf-8'), cipher.final()])
+	const authTag = cipher.getAuthTag()
+	return JSON.stringify({
+		marker: ENCRYPTED_STORE_MARKER,
+		iv: iv.toString('base64'),
+		authTag: authTag.toString('base64'),
+		data: encrypted.toString('base64')
+	})
+}
+
+const decryptStoreJSON = (fileStr, secret) => {
+	const parsed = JSON.parse(fileStr)
+	if (parsed.marker !== ENCRYPTED_STORE_MARKER) {
+		// not an encrypted store file -- assume it's already plain JSON
+		return fileStr
+	}
+	const { createDecipheriv } = require('crypto')
+	const key = deriveStoreKey(secret)
+	const iv = Buffer.from(parsed.iv, 'base64')
+	const authTag = Buffer.from(parsed.authTag, 'base64')
+	const decipher = createDecipheriv('aes-256-gcm', key, iv)
+	decipher.setAuthTag(authTag)
+	const decrypted = Buffer.concat([decipher.update(Buffer.from(parsed.data, 'base64')), decipher.final()])
+	return decrypted.toString('utf-8')
+}
+
 const makeInMemoryStore = config => {
 	const socket = config.socket
 	const chatKey = config.chatKey || waChatKey(true)
@@ -55,6 +93,19 @@ const makeInMemoryStore = config => {
 	const state = { connection: 'close' }
 	const labels = new object_repository_1.ObjectRepository()
 	const labelAssociations = new KeyedDB(labelAssociationKey, labelAssociationKey.key)
+	const maxMessagesPerChat = config.maxMessagesPerChat
+	const trimMessagesIfNeeded = jid => {
+		if (!maxMessagesPerChat) return
+		const list = messages[jid]
+		if (!list || list.array.length <= maxMessagesPerChat) return
+		while (list.array.length > maxMessagesPerChat) {
+			let oldest = list.array[0]
+			for (const m of list.array) {
+				if ((m.messageTimestamp || 0) < (oldest.messageTimestamp || 0)) oldest = m
+			}
+			list.remove(oldest)
+		}
+	}
 	const assertMessageList = jid => {
 		if (!messages[jid]) {
 			messages[jid] = makeMessagesDictionary()
@@ -74,7 +125,12 @@ const makeInMemoryStore = config => {
 			labels.upsertById(label.id, label)
 		}
 	}
-	
+	/**
+	 * binds to a BaileysEventEmitter.
+	 * It listens to all events and constructs a state that you can query accurate data from.
+	 * Eg. can use the store to fetch chats, contacts, messages etc.
+	 * @param ev typically the event emitter from the socket connection
+	 */
 	const bind = ev => {
 		ev.on('connection.update', update => {
 			Object.assign(state, update)
@@ -83,8 +139,8 @@ const makeInMemoryStore = config => {
 			'messaging-history.set',
 			({ chats: newChats, contacts: newContacts, messages: newMessages, isLatest, syncType }) => {
 				if (syncType === WAProto_1.proto.HistorySync.HistorySyncType.ON_DEMAND) {
-					
-					return
+					return // FOR NOW,
+					//TODO: HANDLE
 				}
 				if (isLatest) {
 					chats.clear()
@@ -105,6 +161,7 @@ const makeInMemoryStore = config => {
 					const jid = msg.key.remoteJid
 					const list = assertMessageList(jid)
 					list.upsert(msg, 'prepend')
+					trimMessagesIfNeeded(jid)
 				}
 				logger.debug({ messages: newMessages.length }, 'synced messages')
 			}
@@ -127,7 +184,7 @@ const makeInMemoryStore = config => {
 							]
 						})
 					)
-					contact = contacts[contactHashes.find(([, b]) => b === update.id?.[0]) || ''] 
+					contact = contacts[contactHashes.find(([, b]) => b === update.id?.[0]) || ''] // find contact by attrs.hash, when user is not saved as a contact
 				}
 				if (contact) {
 					if (update.imgUrl === 'changed') {
@@ -162,7 +219,7 @@ const makeInMemoryStore = config => {
 			if (label.deleted) {
 				return labels.deleteById(label.id)
 			}
-			
+			// WhatsApp can store only up to 20 labels
 			if (labels.count() < 20) {
 				return labels.upsertById(label.id, label)
 			}
@@ -199,6 +256,7 @@ const makeInMemoryStore = config => {
 						const jid = WABinary_1.jidNormalizedUser(msg.key.remoteJid)
 						const list = assertMessageList(jid)
 						list.upsert(msg, 'append')
+						trimMessagesIfNeeded(jid)
 						if (type === 'notify' && !chats.get(jid)) {
 							ev.emit('chats.upsert', [
 								{
@@ -364,7 +422,10 @@ const makeInMemoryStore = config => {
 		contacts,
 		messages,
 		labels,
-		labelAssociations
+		labelAssociations,
+		groupMetadata,
+		presences,
+		state
 	})
 	const fromJSON = json => {
 		chats.upsert(...json.chats)
@@ -376,6 +437,16 @@ const makeInMemoryStore = config => {
 			for (const msg of json.messages[jid]) {
 				list.upsert(WAProto_1.proto.WebMessageInfo.fromObject(msg), 'append')
 			}
+			trimMessagesIfNeeded(jid)
+		}
+		if (json.groupMetadata) {
+			Object.assign(groupMetadata, json.groupMetadata)
+		}
+		if (json.presences) {
+			Object.assign(presences, json.presences)
+		}
+		if (json.state) {
+			Object.assign(state, json.state)
 		}
 	}
 	return {
@@ -388,7 +459,7 @@ const makeInMemoryStore = config => {
 		labels,
 		labelAssociations,
 		bind,
-		
+		/** loads messages from the store, if not found -- uses the legacy connection */
 		loadMessages: async (jid, count, cursor) => {
 			const list = assertMessageList(jid)
 			const mode = !cursor || 'before' in cursor ? 'before' : 'after'
@@ -404,22 +475,35 @@ const makeInMemoryStore = config => {
 				}
 				const diff = count - messages.length
 				if (diff < 0) {
-					messages = messages.slice(-count) 
+					messages = messages.slice(-count) // get the last X messages
 				}
 			} else {
 				messages = []
 			}
 			return messages
 		},
-		
+		/**
+		 * Get all available labels for profile
+		 *
+		 * Keep in mind that the list is formed from predefined tags and tags
+		 * that were "caught" during their editing.
+		 */
 		getLabels: () => {
 			return labels
 		},
-		
+		/**
+		 * Get labels for chat
+		 *
+		 * @returns Label IDs
+		 **/
 		getChatLabels: chatId => {
 			return labelAssociations.filter(la => la.chatId === chatId).all()
 		},
-		
+		/**
+		 * Get labels for message
+		 *
+		 * @returns Label IDs
+		 **/
 		getMessageLabels: messageId => {
 			const associations = labelAssociations.filter(la => la.messageId === messageId).all()
 			return associations.map(({ labelId }) => labelId)
@@ -434,7 +518,7 @@ const makeInMemoryStore = config => {
 			if (!contact) {
 				return suki?.profilePictureUrl(jid)
 			}
-			if (contact.imgUrl === undefined) {
+			if (typeof contact.imgUrl === 'undefined') {
 				contact.imgUrl = await suki?.profilePictureUrl(jid)
 			}
 			return contact.imgUrl
@@ -448,15 +532,15 @@ const makeInMemoryStore = config => {
 			}
 			return groupMetadata[jid]
 		},
-		
-		
-		
-		
-		
-		
-		
-		
-		
+		// fetchBroadcastListInfo: async(jid: string, sock: WASocket | undefined) => {
+		// 	if(!groupMetadata[jid]) {
+		// 		const metadata = await sock?.getBroadcastListInfo(jid)
+		// 		if(metadata) {
+		// 			groupMetadata[jid] = metadata
+		// 		}
+		// 	}
+		// 	return groupMetadata[jid]
+		// },
 		fetchMessageReceipts: async ({ remoteJid, id }) => {
 			const list = messages[remoteJid]
 			const msg = list?.get(id)
@@ -465,19 +549,51 @@ const makeInMemoryStore = config => {
 		toJSON,
 		fromJSON,
 		writeToFile: path => {
-			
+			// require fs here so that in case "fs" is not available -- the app does not crash
 			const { writeFileSync } = require('fs')
-			writeFileSync(path, JSON.stringify(toJSON()))
+			const jsonStr = JSON.stringify(toJSON())
+			writeFileSync(path, config.encryptionKey ? encryptStoreJSON(jsonStr, config.encryptionKey) : jsonStr)
 		},
 		readFromFile: path => {
-			
+			// require fs here so that in case "fs" is not available -- the app does not crash
 			const { readFileSync, existsSync } = require('fs')
 			if (existsSync(path)) {
 				logger.debug({ path }, 'reading from file')
-				const jsonStr = readFileSync(path, { encoding: 'utf-8' })
+				const fileStr = readFileSync(path, { encoding: 'utf-8' })
+				const jsonStr = config.encryptionKey ? decryptStoreJSON(fileStr, config.encryptionKey) : fileStr
 				const json = JSON.parse(jsonStr)
 				fromJSON(json)
 			}
+		},
+		/**
+		 * Periodically writes the store to `path` every `intervalMs` (default 30s),
+		 * and does one final write when the bound socket closes (if `registerSocketEndHandler`
+		 * is available on it). Returns a function that stops the auto-save.
+		 */
+		startAutoSave: (path, intervalMs = 30000) => {
+			const timer = setInterval(() => {
+				try {
+					const { writeFileSync } = require('fs')
+					const jsonStr = JSON.stringify(toJSON())
+					writeFileSync(path, config.encryptionKey ? encryptStoreJSON(jsonStr, config.encryptionKey) : jsonStr)
+				} catch (error) {
+					logger.warn({ error, path }, 'failed to auto-save store')
+				}
+			}, intervalMs)
+			if (timer.unref) timer.unref()
+			if (socket && typeof socket.registerSocketEndHandler === 'function') {
+				socket.registerSocketEndHandler(async () => {
+					try {
+						const { writeFileSync } = require('fs')
+						const jsonStr = JSON.stringify(toJSON())
+						writeFileSync(path, config.encryptionKey ? encryptStoreJSON(jsonStr, config.encryptionKey) : jsonStr)
+						logger.debug({ path }, 'final store flush on socket end')
+					} catch (error) {
+						logger.warn({ error, path }, 'failed to flush store on socket end')
+					}
+				})
+			}
+			return () => clearInterval(timer)
 		}
 	}
 }

package/lib/Types/Auth.js

@@ -1,7 +1,7 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
 
-
+// Factory functions for creating auth-related objects
 function createKeyPair(publicKey, privateKey) {
 	return {
 		public: publicKey,
@@ -18,7 +18,7 @@ function createSignedKeyPair(keyPair, signature, keyId, timestampS) {
 	}
 }
 
-
+// Export type definitions (for documentation purposes)
 exports.SignalDataTypeMap = {
 	'pre-key': 'KeyPair',
 	session: 'Uint8Array',
@@ -33,6 +33,6 @@ exports.SignalDataTypeMap = {
 exports.SignalDataSet = undefined
 exports.Awaitable = undefined
 
-
+// Export the factory functions
 exports.createKeyPair = createKeyPair
 exports.createSignedKeyPair = createSignedKeyPair

package/lib/Types/Label.js

@@ -1,7 +1,7 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
 exports.LabelColor = void 0
-
+/** WhatsApp has 20 predefined colors */
 var LabelColor
 ;(function (LabelColor) {
 	LabelColor[(LabelColor['Color1'] = 0)] = 'Color1'

package/lib/Types/LabelAssociation.js

@@ -1,7 +1,7 @@
 'use strict'
 Object.defineProperty(exports, '__esModule', { value: true })
 exports.LabelAssociationType = void 0
-
+/** Association type */
 var LabelAssociationType
 ;(function (LabelAssociationType) {
 	LabelAssociationType['Chat'] = 'label_jid'

package/lib/Types/Mex.js

@@ -0,0 +1,112 @@
+'use strict'
+Object.defineProperty(exports, '__esModule', { value: true })
+exports.QueryIds = exports.XWAPaths = void 0
+var XWAPaths
+;(function (XWAPaths) {
+	XWAPaths['xwa2_newsletter_create'] = 'xwa2_newsletter_create'
+	XWAPaths['xwa2_newsletter_subscribers'] = 'xwa2_newsletter_subscribers'
+	XWAPaths['xwa2_newsletter_view'] = 'xwa2_newsletter_view'
+	XWAPaths['xwa2_newsletter_metadata'] = 'xwa2_newsletter'
+	XWAPaths['xwa2_newsletter_admin_count'] = 'xwa2_newsletter_admin'
+	XWAPaths['xwa2_newsletter_mute_v2'] = 'xwa2_newsletter_mute_v2'
+	XWAPaths['xwa2_newsletter_unmute_v2'] = 'xwa2_newsletter_unmute_v2'
+	XWAPaths['xwa2_newsletter_follow'] = 'xwa2_newsletter_follow'
+	XWAPaths['xwa2_newsletter_unfollow'] = 'xwa2_newsletter_unfollow'
+	XWAPaths['xwa2_newsletter_join_v2'] = 'xwa2_newsletter_join_v2'
+	XWAPaths['xwa2_newsletter_leave_v2'] = 'xwa2_newsletter_leave_v2'
+	XWAPaths['xwa2_newsletter_change_owner'] = 'xwa2_newsletter_change_owner'
+	XWAPaths['xwa2_newsletter_demote'] = 'xwa2_newsletter_demote'
+	XWAPaths['xwa2_newsletter_delete_v2'] = 'xwa2_newsletter_delete_v2'
+	XWAPaths['xwa2_fetch_account_reachout_timelock'] = 'xwa2_fetch_account_reachout_timelock'
+	XWAPaths['xwa2_message_capping_info'] = 'xwa2_message_capping_info'
+	XWAPaths['xwa2_newsletter_subscribed'] = 'xwa2_newsletter_subscribed'
+	XWAPaths['xwa2_newsletter_update'] = 'xwa2_newsletter_update'
+	XWAPaths['xwa2_newsletter_admin'] = 'xwa2_newsletter_admin'
+	XWAPaths['xwa2_newsletter_admin_invite_create'] = 'xwa2_newsletter_admin_invite_create'
+	XWAPaths['xwa2_newsletter_admin_invite_revoke'] = 'xwa2_newsletter_admin_invite_revoke'
+	XWAPaths['xwa2_newsletter_admin_invite_accept'] = 'xwa2_newsletter_admin_invite_accept'
+	XWAPaths['xwa2_newsletter_admin_profile_update'] = 'xwa2_newsletter_admin_profile_update'
+	XWAPaths['xwa2_newsletter_admin_insights'] = 'xwa2_newsletter_admin_insights'
+	XWAPaths['xwa2_newsletter_following'] = 'xwa2_newsletter_following'
+	XWAPaths['xwa2_newsletter_create_verified'] = 'xwa2_newsletter_create_verified'
+	XWAPaths['xwa2_newsletter_enforcements'] = 'xwa2_newsletter_enforcements'
+	XWAPaths['xwa2_newsletter_user_reports'] = 'xwa2_newsletter_user_reports'
+	XWAPaths['xwa2_newsletter_create_report_appeal'] = 'xwa2_newsletter_create_report_appeal'
+	XWAPaths['xwa2_newsletter_link_preview_check'] = 'xwa2_newsletter_link_preview_check'
+	XWAPaths['xwa2_newsletter_update_verification'] = 'xwa2_newsletter_update_verification'
+	XWAPaths['xwa2_newsletter_label_paid_partnership'] = 'xwa2_newsletter_label_paid_partnership'
+	XWAPaths['xwa2_newsletter_log_exposures'] = 'xwa2_newsletter_log_exposures'
+	XWAPaths['xwa2_newsletter_update_user_setting'] = 'xwa2_newsletter_update_user_setting'
+	XWAPaths['xwa2_newsletter_ranking_features'] = 'xwa2_newsletter_ranking_features'
+	XWAPaths['xwa2_newsletter_block_user'] = 'xwa2_newsletter_block_user'
+	XWAPaths['xwa2_newsletters_directory_list'] = 'xwa2_newsletters_directory_list'
+	XWAPaths['xwa2_newsletters_directory_search'] = 'xwa2_newsletters_directory_search'
+	XWAPaths['xwa2_newsletters_directory_category_preview'] = 'xwa2_newsletters_directory_category_preview'
+	XWAPaths['xwa2_newsletters_search'] = 'xwa2_newsletters_search'
+	XWAPaths['xwa2_newsletters_recommended'] = 'xwa2_newsletters_recommended'
+	XWAPaths['xwa2_newsletters_similar'] = 'xwa2_newsletters_similar'
+	XWAPaths['xwa2_newsletters_poll_voter_list'] = 'xwa2_newsletters_poll_voter_list'
+	XWAPaths['xwa2_newsletters_reaction_sender_list'] = 'xwa2_newsletters_reaction_sender_list'
+	XWAPaths['xwa2_wamo_afs_age_collection'] = 'xwa2_wamo_afs_age_collection'
+	XWAPaths['xwa2_wamo_asset_collection'] = 'xwa2_wamo_asset_collection'
+	XWAPaths['xwa2_wamo_fetch_adhoc_notice_by_id'] = 'xwa2_wamo_fetch_adhoc_notice_by_id'
+	XWAPaths['xwa2_wamo_fetch_identity_token'] = 'xwa2_wamo_fetch_identity_token'
+	XWAPaths['xwa2_wamo_sub_get_compliance_info'] = 'xwa2_wamo_sub_get_compliance_info'
+	XWAPaths['xwa2_wamo_user_id_version'] = 'xwa2_wamo_user_id_version'
+	XWAPaths['xwa2_wamo_set_user_id_version'] = 'xwa2_wamo_set_user_id_version'
+})((XWAPaths = exports.XWAPaths || (exports.XWAPaths = {})))
+var QueryIds
+;(function (QueryIds) {
+	QueryIds['CREATE'] = '8823471724422422'
+	QueryIds['METADATA'] = '26099060629688646'
+	QueryIds['UPDATE_METADATA'] = '25976052865358570'
+	QueryIds['SUBSCRIBERS'] = '9783111038412085'
+	QueryIds['FOLLOW'] = '24404358912487870'
+	QueryIds['UNFOLLOW'] = '9767147403369991'
+	QueryIds['MUTE'] = '29766401636284406'
+	QueryIds['UNMUTE'] = '9864994326891137'
+	QueryIds['ADMIN_COUNT'] = '7130823597031706'
+	QueryIds['CHANGE_OWNER'] = '7341777602580933'
+	QueryIds['DEMOTE'] = '6551828931592903'
+	QueryIds['DELETE'] = '30062808666639665'
+	QueryIds['REACHOUT_TIMELOCK'] = '23983697327930364'
+	QueryIds['MESSAGE_CAPPING_INFO'] = '24503548349331633'
+	QueryIds['FETCH_SUBSCRIBE'] = '6388546374527196'
+	QueryIds['LEAVE'] = '9784043202933196'
+	QueryIds['ADMIN_INVITE'] = '7148599488585196'
+	QueryIds['ADMIN_INVITE_REVOKE'] = '6345824195482235'
+	QueryIds['ADMIN_INVITE_ACCEPT'] = '6345824195482236'
+	QueryIds['ADMIN_METADATA'] = '6895563180530100'
+	QueryIds['ADMIN_PROFILE_UPDATE'] = '6895563180530101'
+	QueryIds['INSIGHTS'] = '6243647912368353'
+	QueryIds['FOLLOWING_LIST'] = '6388546374527197'
+	QueryIds['CREATE_VERIFIED'] = '8823471724422423'
+	QueryIds['ENFORCEMENTS'] = '7130823597031707'
+	QueryIds['USER_REPORTS'] = '9783111038412086'
+	QueryIds['CREATE_REPORT_APPEAL'] = '6551828931592904'
+	QueryIds['LINK_PREVIEW_CHECK'] = '24404358912487871'
+	QueryIds['UPDATE_VERIFICATION'] = '25976052865358571'
+	QueryIds['LABEL_PAID_PARTNERSHIP'] = '7341777602580934'
+	QueryIds['LOG_EXPOSURES'] = '9864994326891138'
+	QueryIds['UPDATE_USER_SETTING'] = '29766401636284407'
+	QueryIds['RANKING_FEATURES'] = '7130823597031708'
+	QueryIds['BLOCK_USER'] = '6345824195482237'
+	QueryIds['DIRECTORY_LIST'] = '6388546374527198'
+	QueryIds['DIRECTORY_SEARCH'] = '6388546374527199'
+	QueryIds['DIRECTORY_CATEGORY_PREVIEW'] = '6388546374527200'
+	QueryIds['SEARCH'] = '26099060629688647'
+	QueryIds['RECOMMENDED'] = '26099060629688648'
+	QueryIds['SIMILAR'] = '26099060629688649'
+	QueryIds['POLL_VOTER_LIST'] = '9783111038412087'
+	QueryIds['REACTION_SENDERS_LIST'] = '9783111038412088'
+	QueryIds['WAMO_ENABLE_SUB'] = '7148599488585197'
+	QueryIds['WAMO_DISABLE_SUB'] = '7148599488585198'
+	QueryIds['WAMO_CHANGE_SUB'] = '7148599488585199'
+	QueryIds['WAMO_AFS_AGE_COLLECTION'] = '6895563180530102'
+	QueryIds['WAMO_ASSET_COLLECTION'] = '6895563180530103'
+	QueryIds['WAMO_FETCH_ADHOC_NOTICE'] = '6895563180530104'
+	QueryIds['WAMO_FETCH_IDENTITY_TOKEN'] = '6895563180530105'
+	QueryIds['WAMO_SUB_COMPLIANCE_INFO'] = '6895563180530106'
+	QueryIds['WAMO_USER_ID_VERSION'] = '6895563180530107'
+	QueryIds['WAMO_SET_USER_ID_VERSION'] = '6895563180530108'
+})((QueryIds = exports.QueryIds || (exports.QueryIds = {})))