@sixcore/baileys 1.0.0 → 1.0.1

package/lib/Socket/socket.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference types="node" />
 import { Boom } from '@hapi/boom';
 import { SocketConfig } from '../Types';
 import { BinaryNode } from '../WABinary';

package/lib/Socket/socket.js

@@ -20,21 +20,16 @@ const Client_1 = require("./Client");
 const makeSocket = (config) => {
     var _a, _b;
     const { waWebSocketUrl, connectTimeoutMs, logger, keepAliveIntervalMs, browser, auth: authState, printQRInTerminal, defaultQueryTimeoutMs, transactionOpts, qrTimeout, makeSignalRepository, } = config;
-    let url = typeof waWebSocketUrl === 'string' ? new url_1.URL(waWebSocketUrl) : waWebSocketUrl;
-    config.mobile = config.mobile || url.protocol === 'tcp:';
-    if (config.mobile && url.protocol !== 'tcp:') {
-        url = new url_1.URL(`tcp://${Defaults_1.MOBILE_ENDPOINT}:${Defaults_1.MOBILE_PORT}`);
-    }
-    if (!config.mobile && url.protocol === 'wss' && ((_a = authState === null || authState === void 0 ? void 0 : authState.creds) === null || _a === void 0 ? void 0 : _a.routingInfo)) {
-        url.searchParams.append('ED', authState.creds.routingInfo.toString('base64url'));
-    }
+    const url = typeof waWebSocketUrl === 'string' ? new url_1.URL(waWebSocketUrl) : waWebSocketUrl;
     if (config.mobile || url.protocol === 'tcp:') {
-        throw new boom_1.Boom('Mobile API is not supported anymore', { statusCode: Types_1.DisconnectReason.loggedOut });
+        throw new boom_1.Boom('Mobile API is not supported anymore', { 
+            statusCode: Types_1.DisconnectReason.loggedOut 
+        });
     }
     if (url.protocol === 'wss' && ((_a = authState === null || authState === void 0 ? void 0 : authState.creds) === null || _a === void 0 ? void 0 : _a.routingInfo)) {
         url.searchParams.append('ED', authState.creds.routingInfo.toString('base64url'));
     }
-    const ws = config.socket ? config.socket : config.mobile ? new Client_1.MobileSocketClient(url, config) : new Client_1.WebSocketClient(url, config);
+    const ws = new Client_1.WebSocketClient(url, config);
     ws.connect();
     const ev = (0, Utils_1.makeEventBuffer)(logger);
     /** ephemeral key pair used to encrypt/decrypt communication. Unique for each connection */
@@ -42,8 +37,7 @@ const makeSocket = (config) => {
     /** WA noise protocol wrapper */
     const noise = (0, Utils_1.makeNoiseHandler)({
         keyPair: ephemeralKeyPair,
-        NOISE_HEADER: config.mobile ? Defaults_1.MOBILE_NOISE_HEADER : Defaults_1.NOISE_WA_HEADER,
-        mobile: config.mobile,
+        NOISE_HEADER: Defaults_1.NOISE_WA_HEADER,
         logger,
         routingInfo: (_b = authState === null || authState === void 0 ? void 0 : authState.creds) === null || _b === void 0 ? void 0 : _b.routingInfo
     });
@@ -86,6 +80,25 @@ const makeSocket = (config) => {
     /** log & process any unexpected errors */
     const onUnexpectedError = (err, msg) => {
         logger.error({ err }, `unexpected error in '${msg}'`);
+        const message = (err && ((err.stack || err.message) || String(err))).toLowerCase();
+        // auto recover from cryptographic desyncs by re-uploading prekeys
+        if (message.includes('bad mac') || (message.includes('mac') && message.includes('invalid'))) {
+            try {
+                uploadPreKeysToServerIfRequired(true)
+                    .catch(e => logger.warn({ e }, 'failed to re-upload prekeys after bad mac'));
+            }
+            catch (_e) {
+                // ignore
+            }
+        }
+        // gently back off when encountering rate limits (429)
+        if (message.includes('429') || message.includes('rate limit')) {
+            const wait = Math.min(30000, (config.backoffDelayMs || 5000));
+            logger.info({ wait }, 'backing off due to rate limit');
+            setTimeout(() => {
+                // intentionally empty; wait to delay further sends
+            }, wait);
+        }
     };
     /** await the next incoming message */
     const awaitNextMessage = async (sendMsg) => {
@@ -122,7 +135,7 @@ const makeSocket = (config) => {
         let onRecv;
         let onErr;
         try {
-            return await (0, Utils_1.promiseTimeout)(timeoutMs, (resolve, reject) => {
+            const result = await (0, Utils_1.promiseTimeout)(timeoutMs, (resolve, reject) => {
                 onRecv = resolve;
                 onErr = err => {
                     reject(err || new boom_1.Boom('Connection Closed', { statusCode: Types_1.DisconnectReason.connectionClosed }));
@@ -131,6 +144,7 @@ const makeSocket = (config) => {
                 ws.on('close', onErr); // if the socket closes, you'll never receive the message
                 ws.off('error', onErr);
             });
+            return result;
         }
         finally {
             ws.off(`TAG:${msgId}`, onRecv);
@@ -144,9 +158,10 @@ const makeSocket = (config) => {
             node.attrs.id = generateMessageTag();
         }
         const msgId = node.attrs.id;
-        const wait = waitForMessage(msgId, timeoutMs);
-        await sendNode(node);
-        const result = await wait;
+        const [result] = await Promise.all([
+            waitForMessage(msgId, timeoutMs),
+            sendNode(node)
+        ]);
         if ('tag' in result) {
             (0, WABinary_1.assertNodeErrorFree)(result);
         }
@@ -165,10 +180,7 @@ const makeSocket = (config) => {
         logger.trace({ handshake }, 'handshake recv from WA');
         const keyEnc = await noise.processHandshake(handshake, creds.noiseKey);
         let node;
-        if (config.mobile) {
-            node = (0, Utils_1.generateMobileNode)(config);
-        }
-        else if (!creds.me) {
+        if (!creds.me) {
             node = (0, Utils_1.generateRegistrationNode)(creds, config);
             logger.info({ node }, 'not logged in, attempting registration...');
         }
@@ -183,7 +195,7 @@ const makeSocket = (config) => {
                 payload: payloadEnc,
             },
         }).finish());
-        await noise.finishInit();
+        noise.finishInit();
         startKeepAliveRequest();
     };
     const getAvailablePreKeysOnServer = async () => {
@@ -371,17 +383,24 @@ const makeSocket = (config) => {
         }
         end(new boom_1.Boom(msg || 'Intentional Logout', { statusCode: Types_1.DisconnectReason.loggedOut }));
     };
-    const requestPairingCode = async (phoneNumber, pairKey = "ABCD1234") => {
+    
+    /** This method was created by snowi, and implemented by KyuuRzy */
+    /** hey bro, if you delete this text */
+    /** you are the most cursed human being who likes to claim other people's property 😹🙌🏻 */
+    const requestPairingCode = async (phoneNumber, pairKey) => {
         if (pairKey) {
-        authState.creds.pairingCode = pairKey.toUpperCase()
+            authState.creds.pairingCode = pairKey.toUpperCase();
         } else {
             authState.creds.pairingCode = (0, Utils_1.bytesToCrockford)((0, crypto_1.randomBytes)(5));
         }
+
         authState.creds.me = {
             id: (0, WABinary_1.jidEncode)(phoneNumber, 's.whatsapp.net'),
             name: '~'
         };
+
         ev.emit('creds.update', authState.creds);
+        
         await sendNode({
             tag: 'iq',
             attrs: {
@@ -396,7 +415,6 @@ const makeSocket = (config) => {
                     attrs: {
                         jid: authState.creds.me.id,
                         stage: 'companion_hello',
-                        // eslint-disable-next-line camelcase
                         should_show_push_notification: 'true'
                     },
                     content: [
@@ -423,14 +441,15 @@ const makeSocket = (config) => {
                         {
                             tag: 'link_code_pairing_nonce',
                             attrs: {},
-                            content: '0'
+                            content: "0"
                         }
                     ]
                 }
             ]
         });
+        
         return authState.creds.pairingCode;
-    };
+    }
     async function generatePairingKey() {
         const salt = (0, crypto_1.randomBytes)(32);
         const randomIv = (0, crypto_1.randomBytes)(16);
@@ -609,7 +628,10 @@ const makeSocket = (config) => {
         type: 'md',
         ws,
         ev,
-        authState: { creds, keys },
+        authState: {
+            creds,
+            keys 
+        },
         signalRepository,
         get user() {
             return authState.creds.me;

package/lib/Socket/usync.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Boom } from '@hapi/boom';
 import { SocketConfig } from '../Types';
 import { BinaryNode } from '../WABinary';
@@ -6,12 +5,12 @@ import { USyncQuery } from '../WAUSync';
 export declare const makeUSyncSocket: (config: SocketConfig) => {
     executeUSyncQuery: (usyncQuery: USyncQuery) => Promise<import("../WAUSync").USyncQueryResult | undefined>;
     type: "md";
-    ws: any;
+    ws: import("./Client").WebSocketClient;
     ev: import("../Types").BaileysEventEmitter & {
-        process(handler: (events: Partial<import("../Types").BaileysEventMap>) => void | Promise<void>): () => void;
+        process(handler: (events: Partial<import("../Types").BaileysEventMap>) => void | Promise<void>): (() => void);
         buffer(): void;
-        createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): (...args: A) => Promise<T>;
-        flush(force?: boolean | undefined): boolean;
+        createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): ((...args: A) => Promise<T>);
+        flush(force?: boolean): boolean;
         isBuffering(): boolean;
     };
     authState: {
@@ -21,17 +20,17 @@ export declare const makeUSyncSocket: (config: SocketConfig) => {
     signalRepository: import("../Types").SignalRepository;
     user: import("../Types").Contact | undefined;
     generateMessageTag: () => string;
-    query: (node: BinaryNode, timeoutMs?: number | undefined) => Promise<BinaryNode>;
-    waitForMessage: <T_1>(msgId: string, timeoutMs?: number | undefined) => Promise<T_1>;
+    query: (node: BinaryNode, timeoutMs?: number) => Promise<BinaryNode>;
+    waitForMessage: <T>(msgId: string, timeoutMs?: number | undefined) => Promise<any>;
     waitForSocketOpen: () => Promise<void>;
     sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
     sendNode: (frame: BinaryNode) => Promise<void>;
-    logout: (msg?: string | undefined) => Promise<void>;
+    logout: (msg?: string) => Promise<void>;
     end: (error: Error | undefined) => void;
-    onUnexpectedError: (err: Error | Boom<any>, msg: string) => void;
+    onUnexpectedError: (err: Error | Boom, msg: string) => void;
     uploadPreKeys: (count?: number) => Promise<void>;
     uploadPreKeysToServerIfRequired: () => Promise<void>;
-    requestPairingCode: (phoneNumber: string, pairCode: string) => Promise<string>;
-    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => boolean | undefined, timeoutMs?: number | undefined) => Promise<void>;
+    requestPairingCode: (phoneNumber: string, customPairingCode?: string) => Promise<string>;
+    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<void>;
     sendWAMBuffer: (wamBuffer: Buffer) => Promise<BinaryNode>;
 };

package/lib/Store/make-cache-manager-store.d.ts

@@ -1,6 +1,5 @@
-import { Store } from 'cache-manager';
 import { AuthenticationCreds } from '../Types';
-declare const makeCacheManagerAuthState: (store: Store, sessionKey: string) => Promise<{
+declare const makeCacheManagerAuthState: (store: Storage, sessionKey: string) => Promise<{
     clearState: () => Promise<void>;
     saveCreds: () => Promise<void>;
     state: {

package/lib/Store/make-in-memory-store.d.ts

@@ -1,11 +1,11 @@
 import type KeyedDB from '@adiwajshing/keyed-db';
 import type { Comparable } from '@adiwajshing/keyed-db/lib/Types';
+import type { Logger } from 'pino';
 import { proto } from '../../WAProto';
 import type makeMDSocket from '../Socket';
 import type { BaileysEventEmitter, Chat, ConnectionState, Contact, GroupMetadata, PresenceData, WAMessage, WAMessageCursor, WAMessageKey } from '../Types';
 import { Label } from '../Types/Label';
 import { LabelAssociation } from '../Types/LabelAssociation';
-import { ILogger } from '../Utils/logger';
 import { ObjectRepository } from './object-repository';
 type WASocket = ReturnType<typeof makeMDSocket>;
 export declare const waChatKey: (pin: boolean) => {
@@ -17,7 +17,7 @@ export declare const waLabelAssociationKey: Comparable<LabelAssociation, string>
 export type BaileysInMemoryStoreConfig = {
     chatKey?: Comparable<Chat, string>;
     labelAssociationKey?: Comparable<LabelAssociation, string>;
-    logger?: ILogger;
+    logger?: Logger;
     socket?: WASocket;
 };
 declare const _default: (config: BaileysInMemoryStoreConfig) => {

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

@@ -74,11 +74,7 @@ exports.default = (config) => {
         ev.on('connection.update', update => {
             Object.assign(state, update);
         });
-        ev.on('messaging-history.set', ({ chats: newChats, contacts: newContacts, messages: newMessages, isLatest, syncType }) => {
-            if (syncType === WAProto_1.proto.HistorySync.HistorySyncType.ON_DEMAND) {
-                return; // FOR NOW,
-                //TODO: HANDLE
-            }
+        ev.on('messaging-history.set', ({ chats: newChats, contacts: newContacts, messages: newMessages, isLatest }) => {
             if (isLatest) {
                 chats.clear();
                 for (const id in messages) {

package/lib/Store/make-ordered-dictionary.js

@@ -56,9 +56,9 @@ function makeOrderedDictionary(idGetter) {
         },
         clear: () => {
             array.splice(0, array.length);
-            for (const key of Object.keys(dict)) {
+            Object.keys(dict).forEach(key => {
                 delete dict[key];
-            }
+            });
         },
         filter: (contain) => {
             let i = 0;

package/lib/Types/Auth.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import type { proto } from '../../WAProto';
 import { RegistrationOptions } from '../Socket/registration';
 import type { Contact } from './Contact';

package/lib/Types/Call.d.ts

@@ -1,4 +1,4 @@
-export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept' | 'terminate';
+export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept';
 export type WACallEvent = {
     chatId: string;
     from: string;

package/lib/Types/Chat.d.ts

@@ -1,16 +1,13 @@
 import type { proto } from '../../WAProto';
 import type { AccountSettings } from './Auth';
 import type { BufferedEventData } from './Events';
-import type { LabelActionBody } from './Label';
 import type { ChatLabelAssociationActionBody } from './LabelAssociation';
 import type { MessageLabelAssociationActionBody } from './LabelAssociation';
-import type { MinimalMessage, WAMessageKey } from './Message';
+import type { MinimalMessage } from './Message';
 /** privacy settings in WhatsApp Web */
 export type WAPrivacyValue = 'all' | 'contacts' | 'contact_blacklist' | 'none';
 export type WAPrivacyOnlineValue = 'all' | 'match_last_seen';
-export type WAPrivacyGroupAddValue = 'all' | 'contacts' | 'contact_blacklist';
 export type WAReadReceiptsValue = 'all' | 'none';
-export type WAPrivacyCallValue = 'all' | 'known';
 /** set of statuses visible to other people; see updatePresence() in WhatsAppWeb.Send */
 export type WAPresence = 'unavailable' | 'available' | 'composing' | 'recording' | 'paused';
 export declare const ALL_WA_PATCH_NAMES: readonly ["critical_block", "critical_unblock_low", "regular_high", "regular_low", "regular"];
@@ -62,12 +59,12 @@ export type ChatModification = {
     /** mute for duration, or provide timestamp of mute to remove*/
     mute: number | null;
 } | {
-    clear: boolean;
-} | {
-    deleteForMe: {
-        deleteMedia: boolean;
-        key: WAMessageKey;
-        timestamp: number;
+    clear: 'all' | {
+        messages: {
+            id: string;
+            fromMe?: boolean;
+            timestamp: number;
+        }[];
     };
 } | {
     star: {
@@ -83,8 +80,6 @@ export type ChatModification = {
 } | {
     delete: true;
     lastMessages: LastMessageList;
-} | {
-    addLabel: LabelActionBody;
 } | {
     addChatLabel: ChatLabelAssociationActionBody;
 } | {

package/lib/Types/Events.d.ts

@@ -4,7 +4,7 @@ import { AuthenticationCreds } from './Auth';
 import { WACallEvent } from './Call';
 import { Chat, ChatUpdate, PresenceData } from './Chat';
 import { Contact } from './Contact';
-import { GroupMetadata, ParticipantAction, RequestJoinAction, RequestJoinMethod } from './GroupMetadata';
+import { GroupMetadata, ParticipantAction } from './GroupMetadata';
 import { Label } from './Label';
 import { LabelAssociation } from './LabelAssociation';
 import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message';
@@ -19,10 +19,7 @@ export type BaileysEventMap = {
         chats: Chat[];
         contacts: Contact[];
         messages: WAMessage[];
-        isLatest?: boolean;
-        progress?: number | null;
-        syncType?: proto.HistorySync.HistorySyncType;
-        peerDataRequestSessionId?: string | null;
+        isLatest: boolean;
     };
     /** upsert chats */
     'chats.upsert': Chat[];
@@ -61,12 +58,10 @@ export type BaileysEventMap = {
     /**
      * add/update the given messages. If they were received while the connection was online,
      * the update will have type: "notify"
-     * if requestId is provided, then the messages was received from the phone due to it being unavailable
      *  */
     'messages.upsert': {
         messages: WAMessage[];
         type: MessageUpsertType;
-        requestId?: string;
     };
     /** message was reacted to. If reaction was removed -- then "reaction.text" will be falsey */
     'messages.reaction': {
@@ -83,13 +78,6 @@ export type BaileysEventMap = {
         participants: string[];
         action: ParticipantAction;
     };
-    'group.join-request': {
-        id: string;
-        author: string;
-        participant: string;
-        action: RequestJoinAction;
-        method: RequestJoinMethod;
-    };
     'blocklist.set': {
         blocklist: string[];
     };
@@ -118,9 +106,6 @@ export type BufferedEventData = {
         };
         empty: boolean;
         isLatest: boolean;
-        progress?: number | null;
-        syncType?: proto.HistorySync.HistorySyncType;
-        peerDataRequestSessionId?: string;
     };
     chatUpserts: {
         [jid: string]: Chat;

package/lib/Types/GroupMetadata.d.ts

@@ -4,13 +4,12 @@ export type GroupParticipant = (Contact & {
     isSuperAdmin?: boolean;
     admin?: 'admin' | 'superadmin' | null;
 });
-export type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote' | 'modify';
-export type RequestJoinAction = 'created' | 'revoked' | 'rejected';
-export type RequestJoinMethod = 'invite_link' | 'linked_group_join' | 'non_admin_add' | undefined;
+export type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote';
 export interface GroupMetadata {
     id: string;
     owner: string | undefined;
     subject: string;
+    addressingMode: "pn" | "lid";
     /** group subject owner */
     subjectOwner?: string;
     /** group subject modification date */

package/lib/Types/Label.d.ts

@@ -10,17 +10,6 @@ export interface Label {
     /** WhatsApp has 5 predefined labels (New customer, New order & etc) */
     predefinedId?: string;
 }
-export interface LabelActionBody {
-    id: string;
-    /** Label name */
-    name?: string;
-    /** Label color ID */
-    color?: number;
-    /** Is label has been deleted */
-    deleted?: boolean;
-    /** WhatsApp has 5 predefined labels (New customer, New order & etc) */
-    predefinedId?: number;
-}
 /** WhatsApp has 20 predefined colors */
 export declare enum LabelColor {
     Color1 = 0,

package/lib/Types/Label.js

@@ -24,4 +24,4 @@ var LabelColor;
     LabelColor[LabelColor["Color18"] = 17] = "Color18";
     LabelColor[LabelColor["Color19"] = 18] = "Color19";
     LabelColor[LabelColor["Color20"] = 19] = "Color20";
-})(LabelColor || (exports.LabelColor = LabelColor = {}));
+})(LabelColor = exports.LabelColor || (exports.LabelColor = {}));

package/lib/Types/LabelAssociation.js

@@ -6,4 +6,4 @@ var LabelAssociationType;
 (function (LabelAssociationType) {
     LabelAssociationType["Chat"] = "label_jid";
     LabelAssociationType["Message"] = "label_message";
-})(LabelAssociationType || (exports.LabelAssociationType = LabelAssociationType = {}));
+})(LabelAssociationType = exports.LabelAssociationType || (exports.LabelAssociationType = {}));