cuki-bailx 1.2.6 → 2.0.8

package/lib/Socket/chats.js

@@ -15,31 +15,24 @@ const process_message_1 = __importDefault(require("../Utils/process-message"));
 const WABinary_1 = require("../WABinary");
 const WAUSync_1 = require("../WAUSync");
 const usync_1 = require("./usync");
-const chalk = require('chalk');
 const MAX_SYNC_ATTEMPTS = 2;
-const SyncState = {
-    Connecting: 'connecting',
-    AwaitingInitialSync: 'awaiting_initial_sync',
-    Syncing: 'syncing',
-    Online: 'online'
-};
 const makeChatsSocket = (config) => {
     const { logger, markOnlineOnConnect, fireInitQueries, appStateMacVerification, shouldIgnoreJid, shouldSyncHistoryMessage, } = config;
     const sock = (0, usync_1.makeUSyncSocket)(config);
-    const { ev, ws, authState, generateMessageTag, sendNode, query, signalRepository, onUnexpectedError, } = sock;
+    const { ev, ws, authState, generateMessageTag, sendNode, query, onUnexpectedError, } = sock;
     let privacySettings;
-    let syncState = SyncState.Connecting;
     let needToFlushWithAppStateSync = false;
     let pendingAppStateSync = false;
-    let awaitingSyncTimeout;
+    /** this mutex ensures that the notifications (receipts, messages etc.) are processed in order */
     const processingMutex = (0, make_mutex_1.makeMutex)();
     const placeholderResendCache = config.placeholderResendCache || new node_cache_1.default({
-        stdTTL: Defaults_1.DEFAULT_CACHE_TTLS.MSG_RETRY,
+        stdTTL: Defaults_1.DEFAULT_CACHE_TTLS.MSG_RETRY, // 1 hour
         useClones: false
     });
     if (!config.placeholderResendCache) {
         config.placeholderResendCache = placeholderResendCache;
     }
+    /** helper function to fetch the given app state sync key */
     const getAppStateSyncKey = async (keyId) => {
         const { [keyId]: key } = await authState.keys.get('app-state-sync-key', [keyId]);
         return key;
@@ -61,6 +54,7 @@ const makeChatsSocket = (config) => {
         }
         return privacySettings;
     };
+    /** helper function to run a privacy IQ query */
     const privacyQuery = async (name, value) => {
         await query({
             tag: 'iq',
@@ -105,9 +99,6 @@ const makeChatsSocket = (config) => {
     const updateGroupsAddPrivacy = async (value) => {
         await privacyQuery('groupadd', value);
     };
-    const updateDisableLinkPreviewsPrivacy = async (isPreviewsDisabled) => {
-        return chatModify({ disableLinkPreviews: { isPreviewsDisabled } }, '');
-    };
     const updateDefaultDisappearingMode = async (duration) => {
         await query({
             tag: 'iq',
@@ -188,15 +179,16 @@ const makeChatsSocket = (config) => {
             return result.list;
         }
     };
-    const updateProfilePicture = async (jid, content, dimensions) => {
+    /** update the profile picture for yourself or a group */
+    const updateProfilePicture = async (jid, content) => {
         let targetJid;
         if (!jid) {
             throw new boom_1.Boom('Illegal no-jid profile update. Please specify either your ID or the ID of the chat you wish to update');
         }
         if ((0, WABinary_1.jidNormalizedUser)(jid) !== (0, WABinary_1.jidNormalizedUser)(authState.creds.me.id)) {
-            targetJid = (0, WABinary_1.jidNormalizedUser)(jid);
+            targetJid = (0, WABinary_1.jidNormalizedUser)(jid); // in case it is someone other than us
         }
-        const { img } = await (0, Utils_1.generateProfilePicture)(content, dimensions);
+        const { img } = await (0, Utils_1.generateProfilePicture)(content);
         await query({
             tag: 'iq',
             attrs: {
@@ -214,13 +206,14 @@ const makeChatsSocket = (config) => {
             ]
         });
     };
+    /** remove the profile picture for yourself or a group */
     const removeProfilePicture = async (jid) => {
         let targetJid;
         if (!jid) {
             throw new boom_1.Boom('Illegal no-jid profile update. Please specify either your ID or the ID of the chat you wish to update');
         }
         if ((0, WABinary_1.jidNormalizedUser)(jid) !== (0, WABinary_1.jidNormalizedUser)(authState.creds.me.id)) {
-            targetJid = (0, WABinary_1.jidNormalizedUser)(jid);
+            targetJid = (0, WABinary_1.jidNormalizedUser)(jid); // in case it is someone other than us
         }
         await query({
             tag: 'iq',
@@ -232,6 +225,7 @@ const makeChatsSocket = (config) => {
             }
         });
     };
+    /** update the profile status for yourself */
     const updateProfileStatus = async (status) => {
         await query({
             tag: 'iq',
@@ -358,12 +352,18 @@ const makeChatsSocket = (config) => {
         };
     };
     const resyncAppState = ev.createBufferedFunction(async (collections, isInitialSync) => {
+        // we use this to determine which events to fire
+        // otherwise when we resync from scratch -- all notifications will fire
         const initialVersionMap = {};
         const globalMutationMap = {};
         await authState.keys.transaction(async () => {
             var _a;
             const collectionsToHandle = new Set(collections);
+            // in case something goes wrong -- ensure we don't enter a loop that cannot be exited from
             const attemptsMap = {};
+            // 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)
             while (collectionsToHandle.size) {
                 const states = {};
                 const nodes = [];
@@ -385,6 +385,7 @@ const makeChatsSocket = (config) => {
                         attrs: {
                             name,
                             version: state.version.toString(),
+                            // return snapshot if being synced from scratch
                             'return_snapshot': (!state.version).toString()
                         }
                     });
@@ -404,6 +405,7 @@ const makeChatsSocket = (config) => {
                         }
                     ]
                 });
+                // extract from binary node
                 const decoded = await (0, Utils_1.extractSyncdPatches)(result, config === null || config === void 0 ? void 0 : config.options);
                 for (const key in decoded) {
                     const name = key;
@@ -416,6 +418,7 @@ const makeChatsSocket = (config) => {
                             logger.info(`restored state of ${name} from snapshot to v${newState.version} with mutations`);
                             await authState.keys.set({ 'app-state-sync-version': { [name]: newState } });
                         }
+                        // only process if there are syncd patches
                         if (patches.length) {
                             const { state: newState, mutationMap } = await (0, Utils_1.decodePatches)(name, patches, states[name], getAppStateSyncKey, config.options, initialVersionMap[name], logger, appStateMacVerification.patch);
                             await authState.keys.set({ 'app-state-sync-version': { [name]: newState } });
@@ -426,18 +429,22 @@ const makeChatsSocket = (config) => {
                         if (hasMorePatches) {
                             logger.info(`${name} has more patches...`);
                         }
-                        else {
+                        else { // collection is done with sync
                             collectionsToHandle.delete(name);
                         }
                     }
                     catch (error) {
+                        // if retry attempts overshoot
+                        // or key not found
                         const isIrrecoverableError = attemptsMap[name] >= MAX_SYNC_ATTEMPTS
                             || ((_a = error.output) === null || _a === void 0 ? void 0 : _a.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
                             collectionsToHandle.delete(name);
                         }
                     }
@@ -449,56 +456,28 @@ const makeChatsSocket = (config) => {
             onMutation(globalMutationMap[key]);
         }
     });
+    /**
+     * fetch the profile picture of a user/group
+     * type = "preview" for a low res picture
+     * type = "image for the high res picture"
+     */
     const profilePictureUrl = async (jid, type = 'preview', timeoutMs) => {
         var _a;
         jid = (0, WABinary_1.jidNormalizedUser)(jid);
-        try {
-            const result = await query({
-                tag: 'iq',
-                attrs: {
-                    target: jid,
-                    to: WABinary_1.S_WHATSAPP_NET,
-                    type: 'get',
-                    xmlns: 'w:profile:picture'
-                },
-                content: [
-                    { tag: 'picture', attrs: { type, query: 'url' } }
-                ]
-            }, timeoutMs);
-            const child = (0, WABinary_1.getBinaryNodeChild)(result, 'picture');
-            return (_a = child === null || child === void 0 ? void 0 : child.attrs) === null || _a === void 0 ? void 0 : _a.url;
-        } catch (error) {
-            if (error.message?.includes('item-not-found') || 
-                error.output?.payload?.statusCode === 404 || 
-                error.statusCode === 404) {
-                logger.info(chalk.gray(`[INFO] Profile pic not found for ${jid}, using fallback`));
-                return {
-                    eurl: undefined,
-                    id: jid.split('@')[0],
-                    status: null,
-                    img: null
-                };
-            }
-            throw error;
-        }
-    };
-    const createCallLink = async (type, event, timeoutMs) => {
         const result = await query({
-            tag: 'call',
+            tag: 'iq',
             attrs: {
-                id: generateMessageTag(),
-                to: '@call'
+                target: jid,
+                to: WABinary_1.S_WHATSAPP_NET,
+                type: 'get',
+                xmlns: 'w:profile:picture'
             },
             content: [
-                {
-                    tag: 'link_create',
-                    attrs: { media: type },
-                    content: event ? [{ tag: 'event', attrs: { start_time: String(event.startTime) } }] : undefined
-                }
+                { tag: 'picture', attrs: { type, query: 'url' } }
             ]
         }, timeoutMs);
-        const child = (0, WABinary_1.getBinaryNodeChild)(result, 'link_create');
-        return child?.attrs?.token;
+        const child = (0, WABinary_1.getBinaryNodeChild)(result, 'picture');
+        return (_a = child === null || child === void 0 ? void 0 : child.attrs) === null || _a === void 0 ? void 0 : _a.url;
     };
     const sendPresenceUpdate = async (type, toJid) => {
         const me = authState.creds.me;
@@ -534,6 +513,10 @@ const makeChatsSocket = (config) => {
             });
         }
     };
+    /**
+     * @param toJid the jid to subscribe to
+     * @param tcToken token for subscription, use if present
+     */
     const presenceSubscribe = (toJid, tcToken) => (sendNode({
         tag: 'presence',
         attrs: {
@@ -642,6 +625,7 @@ const makeChatsSocket = (config) => {
             }
         }
     };
+    /** sending non-abt props may fix QR scan fail if server expects */
     const fetchProps = async () => {
         var _a, _b, _c;
         const resultNode = await query({
@@ -661,7 +645,7 @@ const makeChatsSocket = (config) => {
         const propsNode = (0, WABinary_1.getBinaryNodeChild)(resultNode, 'props');
         let props = {};
         if (propsNode) {
-            if ((_b = propsNode.attrs) === null || _b === void 0 ? void 0 : _b.hash) {
+            if ((_b = propsNode.attrs) === null || _b === void 0 ? void 0 : _b.hash) { // on some clients, the hash is returning as undefined
                 authState.creds.lastPropHash = (_c = propsNode === null || propsNode === void 0 ? void 0 : propsNode.attrs) === null || _c === void 0 ? void 0 : _c.hash;
                 ev.emit('creds.update', authState.creds);
             }
@@ -670,10 +654,18 @@ const makeChatsSocket = (config) => {
         logger.debug('fetched props');
         return props;
     };
+    /**
+     * modify a chat -- mark unread, read etc.
+     * lastMessages must be sorted in reverse chronologically
+     * requires the last messages till the last message received; required for archive & unread
+    */
     const chatModify = (mod, jid) => {
         const patch = (0, Utils_1.chatModificationToAppPatch)(mod, jid);
         return appPatch(patch);
     };
+    /**
+     * Star or Unstar a message
+     */
     const star = (jid, messages, star) => {
         return chatModify({
             star: {
@@ -682,15 +674,9 @@ const makeChatsSocket = (config) => {
             }
         }, jid);
     };
-    const addOrEditContact = (jid, contact) => {
-        return chatModify({ contact }, jid);
-    };
-    const removeContact = (jid) => {
-        return chatModify({ contact: null }, jid);
-    };
-    const addLabel = (jid, labels) => {
-        return chatModify({ addLabel: { ...labels } }, jid);
-    };
+    /**
+     * Adds label for the chats
+     */
     const addChatLabel = (jid, labelId) => {
         return chatModify({
             addChatLabel: {
@@ -698,6 +684,9 @@ const makeChatsSocket = (config) => {
             }
         }, jid);
     };
+    /**
+     * Removes label for the chat
+     */
     const removeChatLabel = (jid, labelId) => {
         return chatModify({
             removeChatLabel: {
@@ -705,6 +694,9 @@ const makeChatsSocket = (config) => {
             }
         }, jid);
     };
+    /**
+     * Adds label for the message
+     */
     const addMessageLabel = (jid, messageId, labelId) => {
         return chatModify({
             addMessageLabel: {
@@ -713,6 +705,9 @@ const makeChatsSocket = (config) => {
             }
         }, jid);
     };
+    /**
+     * Removes label for the message
+     */
     const removeMessageLabel = (jid, messageId, labelId) => {
         return chatModify({
             removeMessageLabel: {
@@ -721,6 +716,10 @@ const makeChatsSocket = (config) => {
             }
         }, jid);
     };
+    /**
+     * queries need to be fired on connection open
+     * help ensure parity with WA Web
+     * */
     const executeInitQueries = async () => {
         await Promise.all([
             fetchProps(),
@@ -737,6 +736,7 @@ const makeChatsSocket = (config) => {
             if (!msg.key.fromMe) {
                 ev.emit('contacts.update', [{ id: jid, notify: msg.pushName, verifiedName: msg.verifiedBizName }]);
             }
+            // update our pushname too
             if (msg.key.fromMe && msg.pushName && ((_a = authState.creds.me) === null || _a === void 0 ? void 0 : _a.name) !== msg.pushName) {
                 ev.emit('creds.update', { me: { ...authState.creds.me, name: msg.pushName } });
             }
@@ -746,31 +746,6 @@ const makeChatsSocket = (config) => {
             ? (shouldSyncHistoryMessage(historyMsg)
                 && Defaults_1.PROCESSABLE_HISTORY_TYPES.includes(historyMsg.syncType))
             : false;
-        if (historyMsg && syncState === SyncState.AwaitingInitialSync) {
-            if (awaitingSyncTimeout) {
-                clearTimeout(awaitingSyncTimeout);
-                awaitingSyncTimeout = undefined;
-            }
-            if (shouldProcessHistoryMsg) {
-                syncState = SyncState.Syncing;
-                logger.info('Transitioned to Syncing state');
-            } else {
-                syncState = SyncState.Online;
-                logger.info('History sync skipped, transitioning to Online state and flushing buffer');
-                ev.flush();
-            }
-        }
-        const doAppStateSync = async () => {
-            if (syncState === SyncState.Syncing) {
-                logger.info('Doing app state sync');
-                await resyncAppState(Types_1.ALL_WA_PATCH_NAMES, true);
-                syncState = SyncState.Online;
-                logger.info('App state sync complete, transitioning to Online state and flushing buffer');
-                ev.flush();
-                const accountSyncCounter = (authState.creds.accountSyncCounter || 0) + 1;
-                ev.emit('creds.update', { accountSyncCounter });
-            }
-        };
         if (historyMsg && !authState.creds.myAppStateKeyId) {
             logger.warn('skipping app state sync, as myAppStateKeyId is not set');
             pendingAppStateSync = true;
@@ -784,7 +759,6 @@ const makeChatsSocket = (config) => {
                 }
             })(),
             (0, process_message_1.default)(msg, {
-                signalRepository,
                 shouldProcessHistoryMsg,
                 placeholderResendCache,
                 ev,
@@ -800,6 +774,18 @@ const makeChatsSocket = (config) => {
             await doAppStateSync();
             pendingAppStateSync = false;
         }
+        async function doAppStateSync() {
+            if (!authState.creds.accountSyncCounter) {
+                logger.info('doing initial app state sync');
+                await resyncAppState(Types_1.ALL_WA_PATCH_NAMES, true);
+                const accountSyncCounter = (authState.creds.accountSyncCounter || 0) + 1;
+                ev.emit('creds.update', { accountSyncCounter });
+                if (needToFlushWithAppStateSync) {
+                    logger.debug('flushing with app state sync');
+                    ev.flush();
+                }
+            }
+        }
     });
     ws.on('CB:presence', handlePresenceUpdate);
     ws.on('CB:chatstate', handlePresenceUpdate);
@@ -818,6 +804,7 @@ const makeChatsSocket = (config) => {
                 }
                 break;
             case 'groups':
+                // handled in groups.ts
                 break;
             default:
                 logger.info({ node }, 'received unknown sync');
@@ -834,43 +821,16 @@ const makeChatsSocket = (config) => {
             sendPresenceUpdate(markOnlineOnConnect ? 'available' : 'unavailable')
                 .catch(error => onUnexpectedError(error, 'presence update requests'));
         }
-        if (receivedPendingNotifications &&
+        if (receivedPendingNotifications && // if we don't have the app state key
+            // we keep buffering events until we finally have
+            // the key and can sync the messages
             !((_a = authState.creds) === null || _a === void 0 ? void 0 : _a.myAppStateKeyId)) {
             ev.buffer();
             needToFlushWithAppStateSync = true;
         }
-        if (!receivedPendingNotifications || syncState !== SyncState.Connecting) {
-            return;
-        }
-        syncState = SyncState.AwaitingInitialSync;
-        logger.info('Connection is now AwaitingInitialSync, buffering events');
-        ev.buffer();
-        const willSyncHistory = shouldSyncHistoryMessage(
-            WAProto_1.proto.Message.HistorySyncNotification.create({
-                syncType: WAProto_1.proto.HistorySync.HistorySyncType.RECENT
-            })
-        );
-        if (!willSyncHistory) {
-            logger.info('History sync is disabled by config, not waiting for notification. Transitioning to Online.');
-            syncState = SyncState.Online;
-            setTimeout(() => ev.flush(), 0);
-            return;
-        }
-        logger.info('History sync is enabled, awaiting notification with a 20s timeout.');
-        if (awaitingSyncTimeout) {
-            clearTimeout(awaitingSyncTimeout);
-        }
-        awaitingSyncTimeout = setTimeout(() => {
-            if (syncState === SyncState.AwaitingInitialSync) {
-                logger.warn('Timeout in AwaitingInitialSync, forcing state to Online and flushing buffer');
-                syncState = SyncState.Online;
-                ev.flush();
-            }
-        }, 20000);
     });
     return {
         ...sock,
-        createCallLink,
         getBotListV2,
         processingMutex,
         fetchPrivacySettings,
@@ -888,7 +848,6 @@ const makeChatsSocket = (config) => {
         updateProfileStatus,
         updateProfileName,
         updateBlockStatus,
-        updateDisableLinkPreviewsPrivacy,
         updateCallPrivacy,
         updateMessagesPrivacy,
         updateLastSeenPrivacy,
@@ -902,9 +861,6 @@ const makeChatsSocket = (config) => {
         resyncAppState,
         chatModify,
         cleanDirtyBits,
-        addOrEditContact,
-        removeContact,
-        addLabel,
         addChatLabel,
         removeChatLabel,
         addMessageLabel,
@@ -912,4 +868,4 @@ const makeChatsSocket = (config) => {
         star
     };
 };
-exports.makeChatsSocket = makeChatsSocket;
+exports.makeChatsSocket = makeChatsSocket;

package/lib/Socket/messages-recv.js

@@ -332,7 +332,7 @@ const makeMessagesRecvSocket = (config) => {
                 break;
                 break;
             default:
-            // console.log("VYZENBAIL-DEBUG:", JSON.stringify({ ...child, content: Buffer.isBuffer(child.content) ? child.content.toString() : child.content, participant }, null, 2))
+            // console.log("BAILEYS-DEBUG:", JSON.stringify({ ...child, content: Buffer.isBuffer(child.content) ? child.content.toString() : child.content, participant }, null, 2))
         }
     };
     const handleNewsletterNotification = (id, node) => {