@neelegirly/baileys 2.2.17 → 2.2.19

package/lib/Utils/chat-utils.js

@@ -60,7 +60,7 @@ const makeLtHashGenerator = ({ indexValueMap, hash }) => {
             const prevOp = indexValueMap[indexMacBase64]
             if (operation === WAProto_1.proto.SyncdMutation.SyncdOperation.REMOVE) {
                 if (!prevOp) {
-                    throw new boom_1.Boom('tried remove, but no previous op', { data: { indexMac, valueMac } })
+                    return
                 }
                 // remove from index value mac, since this mutation is erased
                 delete indexValueMap[indexMacBase64]
@@ -107,10 +107,23 @@ const generatePatchMac = (snapshotMac, valueMacs, version, type, key) => {
 
 const newLTHashState = () => ({ version: 0, hash: Buffer.alloc(128), indexValueMap: {} })
 
+const ensureLTHashStateVersion = (state) => {
+    if (typeof state.version !== 'number' || Number.isNaN(state.version)) {
+        state.version = 0
+    }
+    return state
+}
+
+const MAX_SYNC_ATTEMPTS = 2
+
+const isMissingKeyError = (error) => error?.data?.isMissingKey === true
+
+const isAppStateSyncIrrecoverable = (error, attempts) => attempts >= MAX_SYNC_ATTEMPTS || error?.name === 'TypeError'
+
 const encodeSyncdPatch = async ({ type, index, syncAction, apiVersion, operation }, myAppStateKeyId, state, getAppStateSyncKey) => {
     const key = !!myAppStateKeyId ? await getAppStateSyncKey(myAppStateKeyId) : undefined
     if (!key) {
-        throw new boom_1.Boom(`myAppStateKey ("${myAppStateKeyId}") not present`, { statusCode: 404 })
+        throw new boom_1.Boom(`myAppStateKey ("${myAppStateKeyId}") not present`, { data: { isMissingKey: true } })
     }
     const encKeyId = Buffer.from(myAppStateKeyId, 'base64')
     state = { ...state, indexValueMap: { ...state.indexValueMap } }
@@ -197,7 +210,7 @@ const decodeSyncdMutations = async (msgMutations, initialState, getAppStateSyncK
         const base64Key = Buffer.from(keyId).toString('base64')
         const keyEnc = await getAppStateSyncKey(base64Key)
         if (!keyEnc) {
-            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`, { statusCode: 404, data: { msgMutations } })
+            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`, { data: { isMissingKey: true, msgMutations } })
         }
         return mutationKeys(keyEnc.keyData)
     }
@@ -208,7 +221,7 @@ const decodeSyncdPatch = async (msg, name, initialState, getAppStateSyncKey, onM
         const base64Key = Buffer.from(msg.keyId.id).toString('base64')
         const mainKeyObj = await getAppStateSyncKey(base64Key)
         if (!mainKeyObj) {
-            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode patch`, { statusCode: 404, data: { msg } })
+            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode patch`, { data: { isMissingKey: true, msg } })
         }
         const mainKey = await mutationKeys(mainKeyObj.keyData)
         const mutationmacs = msg.mutations.map(mutation => mutation.record.value.blob.slice(-32))
@@ -291,7 +304,7 @@ const decodeSyncdSnapshot = async (name, snapshot, getAppStateSyncKey, minimumVe
         const base64Key = Buffer.from(snapshot.keyId.id).toString('base64')
         const keyEnc = await getAppStateSyncKey(base64Key)
         if (!keyEnc) {
-            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`)
+            throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`, { data: { isMissingKey: true } })
         }
         const result = await mutationKeys(keyEnc.keyData)
         const computedSnapshotMac = generateSnapshotMac(newState.hash, newState.version, name, result.snapshotMacKey)
@@ -335,7 +348,7 @@ const decodePatches = async (name, syncds, initial, getAppStateSyncKey, options,
             const base64Key = Buffer.from(keyId.id).toString('base64')
             const keyEnc = await getAppStateSyncKey(base64Key)
             if (!keyEnc) {
-                throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`)
+                throw new boom_1.Boom(`failed to find key "${base64Key}" to decode mutation`, { data: { isMissingKey: true } })
             }
             const result = await mutationKeys(keyEnc.keyData)
             const computedSnapshotMac = generateSnapshotMac(newState.hash, newState.version, name, result.snapshotMacKey)
@@ -690,7 +703,8 @@ const processSyncAction = (syncAction, ev, me, initialSyncOpts, logger) => {
     else if (action?.contactAction) {
             ev.emit('contacts.upsert', [{
             id, 
-            name: action.contactAction.fullName, 
+            name: action.contactAction.fullName || action.contactAction.firstName || action.contactAction.username || undefined,
+            username: action.contactAction.username || undefined,
             lid: action.contactAction.lidJid || undefined, 
             jid: WABinary_1.isJidUser(id) ? id : undefined
         }]) 
@@ -784,7 +798,12 @@ const processSyncAction = (syncAction, ev, me, initialSyncOpts, logger) => {
 
 module.exports = {
   mutationKeys, 
+  makeLtHashGenerator,
   newLTHashState, 
+  ensureLTHashStateVersion,
+  MAX_SYNC_ATTEMPTS,
+  isMissingKeyError,
+  isAppStateSyncIrrecoverable,
   encodeSyncdPatch, 
   decodeSyncdMutations, 
   decodeSyncdPatch, 
@@ -795,4 +814,4 @@ module.exports = {
   decodePatches, 
   chatModificationToAppPatch, 
   processSyncAction
-}
+}

package/lib/Utils/decode-wa-message.js

@@ -112,9 +112,13 @@ const fromMe = WABinary_1.isJidNewsletter(stanza.attrs.from)
     const pushname = stanza?.attrs?.notify
     const key = {
         remoteJid: chatId,
+        remoteJidUsername: !WABinary_1.isJidGroup(chatId)
+            ? stanza.attrs.peer_recipient_username || stanza.attrs.recipient_username
+            : undefined,
         fromMe,
         id: msgId,
         ...(participant !== undefined && { participant: fromMe ? meId : participant }),
+        ...(stanza.attrs.participant !== undefined && { participantUsername: stanza.attrs.participant_username }),
         ...(stanza.attrs.participant_pn !== undefined && { participant_pn: fromMe ? meId : stanza.attrs.participant_pn }),
         ...(stanza.attrs.participant_lid !== undefined && { participant_lid: fromMe ? meLid : stanza.attrs.participant_lid }),
     }
@@ -285,4 +289,4 @@ const decryptMessageNode = (stanza, meId, meLid, repository, logger) => {
 module.exports = {
   decodeMessageNode, 
   decryptMessageNode
-}
+}

package/lib/Utils/event-buffer.js

@@ -188,6 +188,7 @@ function append(data, historyCache, event, eventData, logger) {
             data.historySets.empty = false
             data.historySets.syncType = eventData.syncType
             data.historySets.progress = eventData.progress
+            data.historySets.chunkOrder = eventData.chunkOrder
             data.historySets.peerDataRequestSessionId = eventData.peerDataRequestSessionId
             data.historySets.isLatest = eventData.isLatest || data.historySets.isLatest
             break
@@ -483,6 +484,7 @@ function consolidateEvents(data) {
             syncType: data.historySets.syncType,
             progress: data.historySets.progress,
             isLatest: data.historySets.isLatest,
+            chunkOrder: data.historySets.chunkOrder,
             peerDataRequestSessionId: data.historySets.peerDataRequestSessionId
         }
     }
@@ -562,4 +564,4 @@ const stringifyMessageKey = (key) => `${key.remoteJid},${key.id},${key.fromMe ?
 
 module.exports = {
   makeEventBuffer
-}
+}

package/lib/Utils/generics.js

@@ -507,6 +507,15 @@ const getCallStatusFromNode = ({ tag, attrs }) => {
                 status = 'terminate'
             }
             break
+        case 'preaccept':
+            status = 'preaccept'
+            break
+        case 'transport':
+            status = 'transport'
+            break
+        case 'relaylatency':
+            status = 'relaylatency'
+            break
         case 'reject':
             status = 'reject'
             break

package/lib/Utils/history.js

@@ -2,7 +2,7 @@
 
 Object.defineProperty(exports, "__esModule", { value: true })
 
-const util_1 = require("util")
+const promises_1 = require("stream/promises")
 const zlib_1 = require("zlib")
 const WAProto_1 = require("../../WAProto")
 const Types_1 = require("../Types")
@@ -10,17 +10,14 @@ const WABinary_1 = require("../WABinary")
 const generics_1 = require("./generics")
 const messages_1 = require("./messages")
 const messages_media_1 = require("./messages-media")
-const inflatePromise = util_1.promisify(zlib_1.inflate)
 
 const downloadHistory = async (msg, options) => {
     const stream = await messages_media_1.downloadContentFromMessage(msg, 'md-msg-hist', { options })
+    const inflater = zlib_1.createInflate()
     const bufferArray = []
-    for await (const chunk of stream) {
-        bufferArray.push(chunk)
-    }
-    let buffer = Buffer.concat(bufferArray)
-    // decompress buffer
-    buffer = await inflatePromise(buffer)
+    inflater.on('data', chunk => bufferArray.push(chunk))
+    await promises_1.pipeline(stream, inflater)
+    const buffer = Buffer.concat(bufferArray)
     const syncData = WAProto_1.proto.HistorySync.decode(buffer)
     return syncData
 }
@@ -37,7 +34,8 @@ const processHistoryMessage = (item) => {
             for (const chat of item.conversations) {
                   contacts.push({
                     id: chat.id,
-                    name: chat.name || undefined,
+                    name: chat.displayName || chat.name || chat.username || undefined,
+                    username: chat.username || undefined,
                     lid: chat.lidJid || undefined,
                     jid: (0, WABinary_1.isJidUser)(chat.id) ? chat.id : undefined
                 });
@@ -68,7 +66,7 @@ const processHistoryMessage = (item) => {
                 if (WABinary_1.isJidUser(chat.id) && chat.readOnly && chat.archived) {
                     delete chat.readOnly
                 }
-                chats.push({ ...chat })
+                chats.push(chat)
             }
             break
         case WAProto_1.proto.HistorySync.HistorySyncType.PUSH_NAME:
@@ -76,6 +74,7 @@ const processHistoryMessage = (item) => {
                 contacts.push({ 
                 	id: c.id, 
                     name: c.name || undefined, 
+                    username: c.username || undefined,
                     lid: c.lidJid || undefined, 
                     jid: WABinary_1.isJidUser(c.id) ? c.id : undefined
                 }) 
@@ -107,4 +106,4 @@ module.exports = {
   processHistoryMessage, 
   downloadAndProcessHistorySyncNotification, 
   getHistoryMsg
-}
+}

package/lib/Utils/messages-media.js

@@ -572,7 +572,7 @@ const downloadEncryptedContent = async (downloadUrl, { cipherKey, iv }, { startB
     }
     const output = new stream_1.Transform({
         transform(chunk, _, callback) {
-            let data = Buffer.concat([remainingBytes, chunk])
+            let data = remainingBytes.length ? Buffer.concat([remainingBytes, chunk]) : chunk
             const decryptLength = toSmallestChunkSize(data.length)
             remainingBytes = data.slice(decryptLength)
             data = data.slice(0, decryptLength)
@@ -803,4 +803,4 @@ module.exports = {
   decryptMediaRetryData, 
   getStatusCodeForMediaRetry, 
   MEDIA_RETRY_STATUS_MAP
-}
+}

package/lib/Utils/messages.js

@@ -643,6 +643,13 @@ const generateWAMessageContent = async (message, options) => {
 		}
     } 
      
+    else if ('album' in message) {
+        m.albumMessage = {
+            expectedImageCount: message.album.expectedImageCount,
+            expectedVideoCount: message.album.expectedVideoCount
+        }
+    }
+
    else if ('payment' in message) {   	
       const requestPaymentMessage = { 
    	    amount: {
@@ -753,6 +760,16 @@ const generateWAMessageContent = async (message, options) => {
         m = mess
     }
     
+    if ('albumParentKey' in message && !!message.albumParentKey) {
+        m.messageContextInfo = {
+            ...m.messageContextInfo,
+            messageAssociation: {
+                associationType: WAProto_1.proto.MessageAssociation.AssociationType.MEDIA_ALBUM,
+                parentMessageKey: message.albumParentKey
+            }
+        }
+    }
+
     if ('sections' in message && !!message.sections) {
         const listMessage = {
             title: message.title, 
@@ -851,7 +868,7 @@ const generateWAMessageContent = async (message, options) => {
                 hydratedTemplate.hydratedContentText = message.caption
             }
             
-            Object.assign(msg, m)
+            Object.assign(hydratedTemplate, m)
         }
         
         if ('footer' in message && !!message.footer) {
@@ -1576,4 +1593,4 @@ module.exports = {
   downloadMediaMessage, 
   assertMediaContent, 
   patchMessageForMdIfRequired
-}
+}

package/lib/Utils/process-message.js

@@ -161,6 +161,7 @@ const processMessage = async (message, { shouldProcessHistoryMsg, placeholderRes
                         isLatest: histNotification.syncType !== WAProto_1.proto.HistorySync.HistorySyncType.ON_DEMAND
                             ? isLatest
                             : undefined,
+                        chunkOrder: histNotification.chunkOrder,
                         peerDataRequestSessionId: histNotification.peerDataRequestSessionId
                     })
                 }
@@ -283,15 +284,15 @@ const processMessage = async (message, { shouldProcessHistoryMsg, placeholderRes
         let participants     
 
 const jid2 = message.key.participant;   
-        const emitParticipantsUpdate = (action) => (ev.emit('group-participants.update', { id: jid, author: jid2, participants, action}))
+        const emitParticipantsUpdate = (action) => (ev.emit('group-participants.update', { id: jid, author: jid2, authorPn: message.key.participantAlt, authorUsername: message.key.participantUsername, participants, action}))
         const emitGroupUpdate = (update) => {
-            ev.emit('groups.update', [{ id: jid, ...update, author: message.participant ? message.participant : undefined }])
+            ev.emit('groups.update', [{ id: jid, ...update, author: message.participant ? message.participant : undefined, authorPn: message.key.participantAlt, authorUsername: message.key.participantUsername }])
         }
         const emitCommunityUpdate = (update) => {
-            ev.emit('communities.update', [{ id: jid, ...update, author: message.participant ? message.participant : undefined }])
+            ev.emit('communities.update', [{ id: jid, ...update, author: message.participant ? message.participant : undefined, authorPn: message.key.participantAlt, authorUsername: message.key.participantUsername }])
         }
         const emitGroupRequestJoin = (participant, action, method) => {
-            ev.emit('group.join-request', { id: jid, author: message.participant, participant, action, method: method })
+            ev.emit('group.join-request', { id: jid, author: message.participant, authorPn: message.key.participantAlt, authorUsername: message.key.participantUsername, participant, action, method: method })
         }
         const participantsIncludesMe = () => participants.find(jid => WABinary_1.areJidsSameUser(meId, jid))
         switch (message.messageStubType) {

package/lib/WAUSync/Protocols/USyncContactProtocol.d.ts

@@ -7,4 +7,4 @@ export declare class USyncContactProtocol implements USyncQueryProtocol {
     getQueryElement(): BinaryNode
     getUserElement(user: USyncUser): BinaryNode
     parser(node: BinaryNode): boolean
-}
+}

package/lib/WAUSync/Protocols/USyncContactProtocol.js

@@ -15,11 +15,34 @@ class USyncContactProtocol {
         }
     }
     getUserElement(user) {
-        //TODO: Implement type / username fields (not yet supported)
+        if (user.phone) {
+            return {
+                tag: 'contact',
+                attrs: {},
+                content: user.phone,
+            }
+        }
+        if (user.username) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    username: user.username,
+                    ...(user.usernameKey ? { pin: user.usernameKey } : {}),
+                    ...(user.lid ? { lid: user.lid } : {})
+                }
+            }
+        }
+        if (user.type) {
+            return {
+                tag: 'contact',
+                attrs: {
+                    type: user.type
+                }
+            }
+        }
         return {
             tag: 'contact',
-            attrs: {},
-            content: user.phone,
+            attrs: {}
         }
     }
     parser(node) {
@@ -33,4 +56,4 @@ class USyncContactProtocol {
 
 module.exports = {
   USyncContactProtocol
-}
+}

package/lib/WAUSync/Protocols/USyncUsernameProtocol.d.ts

@@ -0,0 +1,9 @@
+import { USyncQueryProtocol } from '../../Types/USync'
+import { BinaryNode } from '../../WABinary'
+
+export declare class USyncUsernameProtocol implements USyncQueryProtocol {
+    name: string
+    getQueryElement(): BinaryNode
+    getUserElement(): null
+    parser(node: BinaryNode): string | null
+}

package/lib/WAUSync/Protocols/USyncUsernameProtocol.js

@@ -0,0 +1,31 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const WABinary_1 = require("../../WABinary")
+
+class USyncUsernameProtocol {
+    constructor() {
+        this.name = 'username'
+    }
+    getQueryElement() {
+        return {
+            tag: 'username',
+            attrs: {}
+        }
+    }
+    getUserElement() {
+        return null
+    }
+    parser(node) {
+        if (node.tag === 'username') {
+            WABinary_1.assertNodeErrorFree(node)
+            return typeof node.content === 'string' ? node.content : null
+        }
+        return null
+    }
+}
+
+module.exports = {
+  USyncUsernameProtocol
+}

package/lib/WAUSync/Protocols/index.d.ts

@@ -3,4 +3,5 @@ export * from './USyncContactProtocol'
 export * from './USyncDeviceProtocol'
 export * from './USyncLIDProtocol'
 export * from './USyncStatusProtocol'
-export * from './USyncDisappearingModeProtocol'
+export * from './USyncDisappearingModeProtocol'
+export * from './USyncUsernameProtocol'

package/lib/WAUSync/Protocols/index.js

@@ -23,4 +23,5 @@ __exportStar(require("./USyncContactProtocol"), exports)
 __exportStar(require("./USyncDeviceProtocol"), exports)
 __exportStar(require("./USyncLIDProtocol"), exports) 
 __exportStar(require("./USyncStatusProtocol"), exports)
-__exportStar(require("./USyncDisappearingModeProtocol"), exports)
+__exportStar(require("./USyncDisappearingModeProtocol"), exports)
+__exportStar(require("./USyncUsernameProtocol"), exports)

package/lib/WAUSync/USyncQuery.d.ts

@@ -28,4 +28,5 @@ export declare class USyncQuery {
     withStatusProtocol(): this
     withBotProfileProtocol(): this
     withDisappearingModeProtocol(): this
-}
+    withUsernameProtocol(): this
+}

package/lib/WAUSync/USyncQuery.js

@@ -75,8 +75,12 @@ class USyncQuery {
         this.protocols.push(new Protocols_1.USyncDisappearingModeProtocol())
         return this
     }
+    withUsernameProtocol() {
+        this.protocols.push(new Protocols_1.USyncUsernameProtocol())
+        return this
+    }
 }
 
 module.exports = {
   USyncQuery
-}
+}

package/lib/WAUSync/USyncUser.d.ts

@@ -2,11 +2,15 @@ export declare class USyncUser {
     id: string
     lid: string
     phone: string
+    username: string
+    usernameKey: string
     type: string
     personaId: string
     withId(id: string): this
     withLid(lid: string): this
     withPhone(phone: string): this
+    withUsername(username: string): this
+    withUsernameKey(usernameKey: string): this
     withType(type: string): this
     withPersonaId(personaId: string): this
 }

package/lib/WAUSync/USyncUser.js

@@ -15,6 +15,14 @@ class USyncUser {
         this.phone = phone
         return this
     }
+    withUsername(username) {
+        this.username = username
+        return this
+    }
+    withUsernameKey(usernameKey) {
+        this.usernameKey = usernameKey
+        return this
+    }
     withType(type) {
         this.type = type
         return this
@@ -27,4 +35,4 @@ class USyncUser {
 
 module.exports = {
   USyncUser
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neelegirly/baileys",
-  "version": "2.2.17",
+  "version": "2.2.19",
   "description": "Neelegirly fork of Baileys: multi-device WhatsApp Web API for Node.js",
   "keywords": [
     "whatsapp",