@itsliaaa/baileys 0.1.33 → 0.2.1

package/lib/Socket/chats.js

@@ -1,24 +1,33 @@
 import NodeCache from '@cacheable/node-cache';
 import { Boom } from '@hapi/boom';
 import { proto } from '../../WAProto/index.js';
-import { DEFAULT_CACHE_TTLS, PROCESSABLE_HISTORY_TYPES } from '../Defaults/index.js';
+import { DEFAULT_CACHE_TTLS, HISTORY_SYNC_PAUSED_TIMEOUT_MS, PROCESSABLE_HISTORY_TYPES } from '../Defaults/index.js';
 import { ALL_WA_PATCH_NAMES } from '../Types/index.js';
 import { SyncState } from '../Types/State.js';
-import { chatModificationToAppPatch, decodePatches, decodeSyncdSnapshot, encodeSyncdPatch, extractSyncdPatches, generateProfilePicture, getHistoryMsg, newLTHashState, processSyncAction } from '../Utils/index.js';
+import { chatModificationToAppPatch, decodePatches, decodeSyncdSnapshot, encodeSyncdPatch, ensureLTHashStateVersion, extractSyncdPatches, generateProfilePicture, getHistoryMsg, isAppStateSyncIrrecoverable, isMissingKeyError, MAX_SYNC_ATTEMPTS, newLTHashState, processSyncAction } from '../Utils/index.js';
 import { makeMutex } from '../Utils/make-mutex.js';
 import processMessage from '../Utils/process-message.js';
 import { buildTcTokenFromJid } from '../Utils/tc-token-utils.js';
 import { getBinaryNodeChild, getBinaryNodeChildren, isPnUser, isLidUser, isHostedLidUser, isHostedPnUser, jidDecode, jidNormalizedUser, reduceBinaryNodeToDictionary, S_WHATSAPP_NET } from '../WABinary/index.js';
 import { USyncQuery, USyncUser } from '../WAUSync/index.js';
 import { makeSocket } from './socket.js';
-const MAX_SYNC_ATTEMPTS = 2;
 // Lia@Note 08-02-26 --- I know it's not efficient for RSS ಥ⁠‿⁠ಥ
 const USER_ID_CACHE = new Map();
 export const makeChatsSocket = (config) => {
     const { logger, markOnlineOnConnect, fireInitQueries, appStateMacVerification, shouldIgnoreJid, shouldSyncHistoryMessage, getMessage } = config;
     const sock = makeSocket(config);
     const { ev, ws, authState, generateMessageTag, sendNode, query, signalRepository, onUnexpectedError, sendUnifiedSession, registerSocketEndHandler } = sock;
+    const getLIDForPN = signalRepository.lidMapping.getLIDForPN.bind(signalRepository.lidMapping);
     let privacySettings;
+    /** Server-assigned AB props for protocol behavior. */
+    const serverProps = {
+        /** AB prop 10518: gate tctoken on 1:1 messages. Default true (safe: avoids 463). */
+        privacyTokenOn1to1: true,
+        /** AB prop 9666: gate tctoken on profile picture IQs. WA Web default: true. */
+        profilePicPrivacyToken: true,
+        /** AB prop 14303: issue tctokens to LID instead of PN. WA Web default: false. */
+        lidTrustedTokenIssueToLid: false
+    };
     let syncState = SyncState.Connecting;
     /** this mutex ensures that messages are processed in order */
     const messageMutex = makeMutex();
@@ -30,6 +39,15 @@ export const makeChatsSocket = (config) => {
     const notificationMutex = makeMutex();
     // Timeout for AwaitingInitialSync state
     let awaitingSyncTimeout;
+    // In-memory history sync completion tracking (resets on reconnection)
+    const historySyncStatus = {
+        initialBootstrapComplete: false,
+        recentSyncComplete: false
+    };
+    let historySyncPausedTimeout;
+    // Collections blocked on missing app state sync keys (mirrors WA Web's "Blocked" state).
+    // When a key arrives via APP_STATE_SYNC_KEY_SHARE, these are re-synced.
+    const blockedCollections = new Set();
     const placeholderResendCache = config.placeholderResendCache ||
         new NodeCache({
             stdTTL: DEFAULT_CACHE_TTLS.MSG_RETRY, // 1 hour
@@ -438,6 +456,9 @@ export const makeChatsSocket = (config) => {
             const collectionsToHandle = new Set(collections);
             // in case something goes wrong -- ensure we don't enter a loop that cannot be exited from
             const attemptsMap = {};
+            // collections that failed and need a full snapshot on retry
+            // mirrors WA Web's ErrorFatal -> force snapshot behavior
+            const forceSnapshotCollections = new Set();
             // keep executing till all collections are done
             // sometimes a single patch request will not return all the patches (God knows why)
             // so we fetch till they're all done (this is determined by the "has_more_patches" flag)
@@ -448,6 +469,7 @@ export const makeChatsSocket = (config) => {
                     const result = await authState.keys.get('app-state-sync-version', [name]);
                     let state = result[name];
                     if (state) {
+                        state = ensureLTHashStateVersion(state);
                         if (typeof initialVersionMap[name] === 'undefined') {
                             initialVersionMap[name] = state.version;
                         }
@@ -456,14 +478,18 @@ export const makeChatsSocket = (config) => {
                         state = newLTHashState();
                     }
                     states[name] = state;
-                    logger.info(`resyncing ${name} from v${state.version}`);
+                    const shouldForceSnapshot = forceSnapshotCollections.has(name);
+                    if (shouldForceSnapshot) {
+                        forceSnapshotCollections.delete(name);
+                    }
+                    logger.info(`resyncing ${name} from v${state.version}${shouldForceSnapshot ? ' (forcing snapshot)' : ''}`);
                     nodes.push({
                         tag: 'collection',
                         attrs: {
                             name,
                             version: state.version.toString(),
-                            // return snapshot if being synced from scratch
-                            return_snapshot: (!state.version).toString()
+                            // return snapshot if syncing from scratch or forcing after a failed attempt
+                            return_snapshot: (shouldForceSnapshot || !state.version).toString()
                         }
                     });
                 }
@@ -512,19 +538,37 @@ export const makeChatsSocket = (config) => {
                         }
                     }
                     catch (error) {
-                        // if retry attempts overshoot
-                        // or key not found
-                        const isIrrecoverableError = attemptsMap[name] >= MAX_SYNC_ATTEMPTS ||
-                            error.output?.statusCode === 404 ||
-                            error.name === 'TypeError';
-                        logger.info({ name, error: error.stack }, `failed to sync state from version${isIrrecoverableError ? '' : ', removing and trying from scratch'}`);
-                        await authState.keys.set({ 'app-state-sync-version': { [name]: null } });
-                        // increment number of retries
                         attemptsMap[name] = (attemptsMap[name] || 0) + 1;
-                        if (isIrrecoverableError) {
-                            // stop retrying
+                        const logData = {
+                            name,
+                            attempt: attemptsMap[name],
+                            version: states[name].version,
+                            statusCode: error.output?.statusCode,
+                            errorType: error.name,
+                            error: error.stack
+                        };
+                        if (isMissingKeyError(error) && attemptsMap[name] >= MAX_SYNC_ATTEMPTS) {
+                            // WA Web treats missing keys as "Blocked" — park the collection
+                            // until the key arrives via APP_STATE_SYNC_KEY_SHARE.
+                            logger.warn(logData, `${name} blocked on missing key from v${states[name].version}, parking after ${attemptsMap[name]} attempts`);
+                            blockedCollections.add(name);
+                            collectionsToHandle.delete(name);
+                        }
+                        else if (isMissingKeyError(error)) {
+                            // Retry with a snapshot which may use a different key.
+                            logger.info(logData, `${name} blocked on missing key from v${states[name].version}, retrying with snapshot`);
+                            forceSnapshotCollections.add(name);
+                        }
+                        else if (isAppStateSyncIrrecoverable(error, attemptsMap[name])) {
+                            logger.warn(logData, `failed to sync ${name} from v${states[name].version}, giving up`);
                             collectionsToHandle.delete(name);
                         }
+                        else {
+                            logger.info(logData, `failed to sync ${name} from v${states[name].version}, forcing snapshot retry`);
+                            // force a full snapshot on retry to recover from
+                            // corrupted local state (e.g. LTHash MAC mismatch)
+                            forceSnapshotCollections.add(name);
+                        }
                     }
                 }
             }
@@ -540,42 +584,34 @@ export const makeChatsSocket = (config) => {
      * type = "image for the high res picture"
      */
     const profilePictureUrl = async (jid, type = 'image', timeoutMs) => {
-        // Lia@Changes 06-02-26 --- Refactor profilePictureUrl() to use tctoken and adjust error handling
-        jid = jidNormalizedUser(jid);
-        const baseContent = {
-            tag: 'picture',
-            attrs: {
-                type,
-                query: 'url'
-            }
-        };
-        const tcTokenData = await authState.keys.get('tctoken', [jid]);
-        const tcTokenBuffer = tcTokenData?.[jid]?.token
-        if (tcTokenBuffer) {
-            baseContent.content = [{
-                tag: 'tctoken',
-                attrs: {},
-                content: tcTokenBuffer
-            }];
+        const baseContent = [{ tag: 'picture', attrs: { type, query: 'url' } }];
+        // WA Web only includes tctoken for user JIDs (not groups/newsletters)
+        // and never for own profile pic (Chat model for self has no tcToken).
+        // Including tctoken for own JID causes the server to never respond.
+        const normalizedJid = jidNormalizedUser(jid);
+        const isUserJid = isPnUser(normalizedJid) || isLidUser(normalizedJid);
+        const me = authState.creds.me;
+        const isSelf = me && (normalizedJid === jidNormalizedUser(me.id) || (me.lid && normalizedJid === jidNormalizedUser(me.lid)));
+        let content = baseContent;
+        if (serverProps.profilePicPrivacyToken && isUserJid && !isSelf) {
+            content = await buildTcTokenFromJid({
+                authState,
+                jid: normalizedJid,
+                baseContent,
+                getLIDForPN
+            });
         }
         const result = await query({
             tag: 'iq',
             attrs: {
-                target: jid,
+                target: normalizedJid,
                 to: S_WHATSAPP_NET,
                 type: 'get',
                 xmlns: 'w:profile:picture'
             },
-            content: [baseContent]
+            content
         }, timeoutMs);
         const child = getBinaryNodeChild(result, 'picture');
-        if (!child) {
-            throw new Boom('Picture node missing', { statusCode: 404 });
-        }
-        const status = child.attrs?.status;
-        if (status === '404' || status === '204') {
-            throw new Boom('Profile picture not set', { statusCode: 404 });
-        }
         return child?.attrs?.url;
     };
     const createCallLink = async (type, event, timeoutMs) => {
@@ -639,7 +675,12 @@ export const makeChatsSocket = (config) => {
      * @param tcToken token for subscription, use if present
      */
     const presenceSubscribe = async (toJid) => {
-        const tcTokenContent = await buildTcTokenFromJid({ authState, jid: toJid });
+        // Only include tctoken for user JIDs — groups/newsletters don't use tctokens
+        const normalizedToJid = jidNormalizedUser(toJid);
+        const isUserJid = isPnUser(normalizedToJid) || isLidUser(normalizedToJid);
+        const tcTokenContent = isUserJid
+            ? await buildTcTokenFromJid({ authState, jid: normalizedToJid, getLIDForPN })
+            : undefined;
         return sendNode({
             tag: 'presence',
             attrs: {
@@ -694,7 +735,7 @@ export const makeChatsSocket = (config) => {
                 logger.debug({ patch: patchCreate }, 'applying app patch');
                 await resyncAppState([name], false);
                 const { [name]: currentSyncVersion } = await authState.keys.get('app-state-sync-version', [name]);
-                initial = currentSyncVersion || newLTHashState();
+                initial = currentSyncVersion ? ensureLTHashStateVersion(currentSyncVersion) : newLTHashState();
                 encodeResult = await encodeSyncdPatch(patchCreate, myAppStateKeyId, initial, getAppStateSyncKey);
                 const { patch, state } = encodeResult;
                 const node = {
@@ -740,22 +781,21 @@ export const makeChatsSocket = (config) => {
             }
         }
     };
-    /** sending non-abt props may fix QR scan fail if server expects */
+    /** fetch AB props */
     const fetchProps = async () => {
-        //TODO: implement both protocol 1 and protocol 2 prop fetching, specially for abKey for WM
         const resultNode = await query({
             tag: 'iq',
             attrs: {
                 to: S_WHATSAPP_NET,
-                xmlns: 'w',
+                xmlns: 'abt',
                 type: 'get'
             },
             content: [
                 {
                     tag: 'props',
                     attrs: {
-                        protocol: '2',
-                        hash: authState?.creds?.lastPropHash || ''
+                        protocol: '1',
+                        ...(authState?.creds?.lastPropHash ? { hash: authState.creds.lastPropHash } : {})
                     }
                 }
             ]
@@ -770,7 +810,20 @@ export const makeChatsSocket = (config) => {
             }
             props = reduceBinaryNodeToDictionary(propsNode, 'prop');
         }
-        logger.debug('fetched props');
+        // Extract protocol-relevant AB props (only the ones we need)
+        const privacyTokenProp = props['10518'] ?? props['privacy_token_sending_on_all_1_on_1_messages'];
+        if (privacyTokenProp !== undefined) {
+            serverProps.privacyTokenOn1to1 = privacyTokenProp === 'true' || privacyTokenProp === '1';
+        }
+        const profilePicProp = props['9666'] ?? props['profile_scraping_privacy_token_in_photo_iq'];
+        if (profilePicProp !== undefined) {
+            serverProps.profilePicPrivacyToken = profilePicProp === 'true' || profilePicProp === '1';
+        }
+        const lidIssueProp = props['14303'] ?? props['lid_trusted_token_issue_to_lid'];
+        if (lidIssueProp !== undefined) {
+            serverProps.lidTrustedTokenIssueToLid = lidIssueProp === 'true' || lidIssueProp === '1';
+        }
+        logger.debug({ serverProps }, 'fetched props');
         return props;
     };
     /**
@@ -910,6 +963,44 @@ export const makeChatsSocket = (config) => {
             ? shouldSyncHistoryMessage(historyMsg) &&
                 PROCESSABLE_HISTORY_TYPES.includes(historyMsg.syncType)
             : false;
+        if (historyMsg && shouldProcessHistoryMsg) {
+            const syncType = historyMsg.syncType;
+            // INITIAL_BOOTSTRAP — fire immediately, no progress check (same as WA Web K function)
+            if (syncType === proto.HistorySync.HistorySyncType.INITIAL_BOOTSTRAP && !historySyncStatus.initialBootstrapComplete) {
+                historySyncStatus.initialBootstrapComplete = true;
+                ev.emit('messaging-history.status', {
+                    syncType,
+                    status: 'complete',
+                    explicit: true
+                });
+            }
+            // RECENT with progress === 100 — explicit completion
+            if (syncType === proto.HistorySync.HistorySyncType.RECENT && historyMsg.progress === 100 && !historySyncStatus.recentSyncComplete) {
+                historySyncStatus.recentSyncComplete = true;
+                clearTimeout(historySyncPausedTimeout);
+                historySyncPausedTimeout = undefined;
+                ev.emit('messaging-history.status', {
+                    syncType,
+                    status: 'complete',
+                    explicit: true
+                });
+            }
+            // Reset 120s paused timeout on any RECENT chunk (like WA Web's handleChunkProgress)
+            if (syncType === proto.HistorySync.HistorySyncType.RECENT && !historySyncStatus.recentSyncComplete) {
+                clearTimeout(historySyncPausedTimeout);
+                historySyncPausedTimeout = setTimeout(() => {
+                    if (!historySyncStatus.recentSyncComplete) {
+                        historySyncStatus.recentSyncComplete = true;
+                        ev.emit('messaging-history.status', {
+                            syncType: proto.HistorySync.HistorySyncType.RECENT,
+                            status: 'paused',
+                            explicit: false
+                        });
+                    }
+                    historySyncPausedTimeout = undefined;
+                }, HISTORY_SYNC_PAUSED_TIMEOUT_MS);
+            }
+        }
         // State machine: decide on sync and flush
         if (historyMsg && syncState === SyncState.AwaitingInitialSync) {
             if (awaitingSyncTimeout) {
@@ -929,6 +1020,8 @@ export const makeChatsSocket = (config) => {
         }
         const doAppStateSync = async () => {
             if (syncState === SyncState.Syncing) {
+                // All collections will be synced, so clear any blocked ones
+                blockedCollections.clear();
                 logger.info('Doing app state sync');
                 await resyncAppState(ALL_WA_PATCH_NAMES, true);
                 // Sync is complete, go online and flush everything
@@ -988,6 +1081,11 @@ export const makeChatsSocket = (config) => {
         }
     });
     ev.on('connection.update', ({ connection, receivedPendingNotifications }) => {
+        if (connection === 'close') {
+            blockedCollections.clear();
+            clearTimeout(historySyncPausedTimeout);
+            historySyncPausedTimeout = undefined;
+        }
         if (connection === 'open') {
             if (fireInitQueries) {
                 executeInitQueries().catch(error => onUnexpectedError(error, 'init queries'));
@@ -997,6 +1095,10 @@ export const makeChatsSocket = (config) => {
         if (!receivedPendingNotifications || syncState !== SyncState.Connecting) {
             return;
         }
+        historySyncStatus.initialBootstrapComplete = false;
+        historySyncStatus.recentSyncComplete = false;
+        clearTimeout(historySyncPausedTimeout);
+        historySyncPausedTimeout = undefined;
         syncState = SyncState.AwaitingInitialSync;
         logger.info('Connection is now AwaitingInitialSync, buffering events');
         ev.buffer();
@@ -1009,19 +1111,49 @@ export const makeChatsSocket = (config) => {
             setTimeout(() => ev.flush(), 0);
             return;
         }
-        logger.info('History sync is enabled, awaiting notification with a 20s timeout.');
+        // On reconnection (accountSyncCounter > 0), the server does not push
+        // history sync notifications — the device already has its data.
+        // Skip the 20s wait and go online immediately.
+        if (authState.creds.accountSyncCounter > 0) {
+            logger.info('Reconnection with existing sync data, skipping history sync wait. Transitioning to Online.');
+            syncState = SyncState.Online;
+            setTimeout(() => ev.flush(), 0);
+            return;
+        }
+        logger.info('First connection, awaiting history sync notification with a 20s timeout.');
         if (awaitingSyncTimeout) {
             clearTimeout(awaitingSyncTimeout);
         }
         awaitingSyncTimeout = setTimeout(() => {
             if (syncState === SyncState.AwaitingInitialSync) {
-                // TODO: investigate
                 logger.warn('Timeout in AwaitingInitialSync, forcing state to Online and flushing buffer');
                 syncState = SyncState.Online;
                 ev.flush();
+                // Increment so subsequent reconnections skip the 20s wait.
+                // Late-arriving history is still processed via processMessage
+                // regardless of the state machine phase.
+                const accountSyncCounter = (authState.creds.accountSyncCounter || 0) + 1;
+                ev.emit('creds.update', { accountSyncCounter });
             }
         }, 20000);
     });
+    // When an app state sync key arrives (myAppStateKeyId is set) and there are
+    // collections blocked on a missing key, trigger a re-sync for just those collections.
+    // This mirrors WA Web's Blocked → retry-on-key-arrival behavior.
+    ev.on('creds.update', ({ myAppStateKeyId }) => {
+        if (!myAppStateKeyId || blockedCollections.size === 0) {
+            return;
+        }
+        // If we're in the middle of a full sync, doAppStateSync handles all collections
+        if (syncState === SyncState.Syncing) {
+            blockedCollections.clear();
+            return;
+        }
+        const collections = [...blockedCollections];
+        blockedCollections.clear();
+        logger.info({ collections }, 'app state sync key arrived, re-syncing blocked collections');
+        resyncAppState(collections, false).catch(error => onUnexpectedError(error, 'blocked collections resync'));
+    });
     ev.on('lid-mapping.update', async ({ lid, pn }) => {
         try {
             await signalRepository.lidMapping.storeLIDPNMappings([{ lid, pn }]);
@@ -1043,6 +1175,7 @@ export const makeChatsSocket = (config) => {
     });
     return {
         ...sock,
+        serverProps,
         createCallLink,
         getBotListV2,
         messageMutex,

package/lib/Socket/groups.js

@@ -277,11 +277,13 @@ export const extractGroupMetadata = (result) => {
     let descId;
     let descOwner;
     let descOwnerPn;
+    let descOwnerUsername;
     let descTime;
     if (descChild) {
         desc = getBinaryNodeChildString(descChild, 'body');
         descOwner = descChild.attrs.participant ? jidNormalizedUser(descChild.attrs.participant) : undefined;
         descOwnerPn = descChild.attrs.participant_pn ? jidNormalizedUser(descChild.attrs.participant_pn) : undefined;
+        descOwnerUsername = descChild.attrs.participant_username || undefined;
         descTime = +descChild.attrs.t;
         descId = descChild.attrs.id;
     }
@@ -295,16 +297,19 @@ export const extractGroupMetadata = (result) => {
         subject: group.attrs.subject,
         subjectOwner: group.attrs.s_o,
         subjectOwnerPn: group.attrs.s_o_pn,
+        subjectOwnerUsername: group.attrs.s_o_username,
         subjectTime: +group.attrs.s_t,
         size: group.attrs.size ? +group.attrs.size : getBinaryNodeChildren(group, 'participant').length,
         creation: +group.attrs.creation,
         owner: group.attrs.creator ? jidNormalizedUser(group.attrs.creator) : undefined,
         ownerPn: group.attrs.creator_pn ? jidNormalizedUser(group.attrs.creator_pn) : undefined,
+        ownerUsername: group.attrs.creator_username || undefined,
         owner_country_code: group.attrs.creator_country_code,
         desc,
         descId,
         descOwner,
         descOwnerPn,
+        descOwnerUsername,
         descTime,
         linkedParent: getBinaryNodeChild(group, 'linked_parent')?.attrs.jid || undefined,
         restrict: !!getBinaryNodeChild(group, 'locked'),
@@ -319,6 +324,7 @@ export const extractGroupMetadata = (result) => {
                 id: attrs.jid,
                 phoneNumber: isLidUser(attrs.jid) && isPnUser(attrs.phone_number) ? attrs.phone_number : undefined,
                 lid: isPnUser(attrs.jid) && isLidUser(attrs.lid) ? attrs.lid : undefined,
+                username: attrs.participant_username || attrs.username || undefined,
                 admin: (attrs.type || null)
             };
         }),