@realvare/based 2.5.71 → 2.6.0

package/README.MD

@@ -27,41 +27,53 @@
 
 ## Indice
 
+- [Indice](#indice)
 - [✨ Caratteristiche Principali](#-caratteristiche-principali)
 - [🚀 Guida Rapida](#-guida-rapida)
+  - [Esempio Base - Avvio Bot](#esempio-base---avvio-bot)
+  - [Esempio Anti-Ban - Configurazione consigliata per Evitare Ban](#esempio-anti-ban---configurazione-consigliata-per-evitare-ban)
 - [📊 Gestione Avanzata Cache](#-gestione-avanzata-cache)
+  - [Configurazione Cache Avanzata](#configurazione-cache-avanzata)
 - [🔍 Risoluzione Problemi](#-risoluzione-problemi)
+  - [Problemi di Connessione](#problemi-di-connessione)
+  - [Gestione Memoria](#gestione-memoria)
+  - [Logging Avanzato](#logging-avanzato)
+  - [Gestione Messaggi Base con LID/JID](#gestione-messaggi-base-con-lidjid)
 - [📚 Documentazione API](#-documentazione-api)
-  - [🏗️ Metodi Fondamentali](#-metodi-fondamentali)
+  - [🏗️ Metodi Fondamentali](#️-metodi-fondamentali)
   - [🎯 Eventi Principali](#-eventi-principali)
-  - [🎪 Messaggi e Funzionalità Interattive](#-messaggi-e-funzionalit-interattive)
-    - [Messaggi Base](#messaggi-base)
+- [🎪 Messaggi e Funzionalità Interattive](#-messaggi-e-funzionalità-interattive)
+  - [Messaggi Base](#messaggi-base)
+    - [Testo con Formattazione](#testo-con-formattazione)
     - [Media Base](#media-base)
     - [Media Avanzati](#media-avanzati)
     - [Messaggi Interattivi](#messaggi-interattivi)
+      - [Messaggi con Bottoni Semplici](#messaggi-con-bottoni-semplici)
+      - [Messaggi con Bottoni e Immagine](#messaggi-con-bottoni-e-immagine)
+      - [Messaggi Liste](#messaggi-liste)
     - [Altri Messaggi](#altri-messaggi)
-    - [Gestione delle Risposte](#gestione-delle-risposte)
-  - [🎭 Funzionalità Gruppi](#-funzionalit-gruppi)
+  - [Gestione delle Risposte](#gestione-delle-risposte)
+  - [🎭 Funzionalità Gruppi](#-funzionalità-gruppi)
     - [Gestione Base Gruppi](#gestione-base-gruppi)
     - [Gestione Partecipanti](#gestione-partecipanti)
     - [Impostazioni Gruppo](#impostazioni-gruppo)
     - [Messaggi Gruppo Avanzati](#messaggi-gruppo-avanzati)
-  - [🔧 Fix LID/JID nel Proprio Main e Handler](#-fix-lidjid-nel-proprio-main-e-handler)
-    - [Best Practices per LID/JID](#best-practices-per-lidjid)
-    - [Esempio Integrato in Main](#esempio-integrato-in-main)
-    - [Esempio Handler Personalizzato](#esempio-handler-personalizzato)
+- [🔧 Fix LID/JID nel Proprio Main e Handler](#-fix-lidjid-nel-proprio-main-e-handler)
+  - [Best Practices per LID/JID](#best-practices-per-lidjid)
+  - [Esempio Integrato in Main](#esempio-integrato-in-main)
+  - [Esempio Handler Personalizzato](#esempio-handler-personalizzato)
   - [🚀 Cache Intelligente LID/JID](#-cache-intelligente-lidjid)
-  - [🛡️ Validazione JID Avanzata](#-validazione-jid-avanzata)
+  - [🛡️ Validazione JID Avanzata](#️-validazione-jid-avanzata)
   - [📊 Logging Condizionale](#-logging-condizionale)
   - [🔧 Configurazione Performance](#-configurazione-performance)
-  - [🧩 Eventi: LID e JID sempre disponibili (nuovo)](#-eventi-lid-e-jid-sempre-disponibili-nuovo)
-  - [⚙️ Configurazione Avanzata](#-configurazione-avanzata)
-    - [🔧 Opzioni Complete per makeWASocket](#-opzioni-complete-per-makewasocket)
-  - [🛡️ Sicurezza e Crittografia](#-sicurezza-e-crittografia)
+- [🧩 Eventi: LID e JID sempre disponibili (nuovo)](#-eventi-lid-e-jid-sempre-disponibili-nuovo)
+- [⚙️ Configurazione Avanzata](#️-configurazione-avanzata)
+  - [🔧 Opzioni Complete per makeWASocket](#-opzioni-complete-per-makewasocket)
+  - [🛡️ Sicurezza e Crittografia](#️-sicurezza-e-crittografia)
 - [🌐 Supporto e Community](#-supporto-e-community)
   - [📞 Contatti e Risorse](#-contatti-e-risorse)
 - [🙏 Ringraziamenti](#-ringraziamenti)
-- [⚠️ Disclaimer & Licenza](#-disclaimer--licenza)
+- [⚠️ Disclaimer \& Licenza](#️-disclaimer--licenza)
   - [📋 Nota Legale](#-nota-legale)
   - [📜 Licenza MIT](#-licenza-mit)
 
@@ -1234,4 +1246,4 @@ Vedi [LICENSE](LICENSE) per dettagli.
 <br>
 <img src="https://capsule-render.vercel.app/api?type=waving&color=gradient&customColorList=24&height=120&section=footer&text=&fontSize=30&fontColor=ffffff&animation=fadeIn&fontAlignY=35"/>
 
-</div>
+</div>

package/lib/Signal/libsignal.js

@@ -42,7 +42,17 @@ const sender_key_record_1 = require("./Group/sender-key-record");
 const Group_1 = require("./Group");
 function makeLibSignalRepository(auth) {
     const storage = signalStorage(auth);
+    const lidMapping = {
+        get: async (lid) => {
+            const { [lid]: pn } = await auth.keys.get('lid-mapping', [lid]);
+            return pn;
+        },
+        set: (lid, pn) => {
+            return auth.keys.set({ 'lid-mapping': { [lid]: pn } });
+        }
+    };
     return {
+        lidMapping,
         decryptGroupMessage({ group, authorJid, msg }) {
             const senderName = jidToSignalSenderKeyName(group, authorJid);
             const cipher = new Group_1.GroupCipher(storage, senderName);
@@ -107,6 +117,17 @@ function makeLibSignalRepository(auth) {
         },
         jidToSignalProtocolAddress(jid) {
             return jidToSignalProtocolAddress(jid).toString();
+        },
+        getLidAddress(jid) {
+            const { user, device } = (0, WABinary_1.jidDecode)(jid);
+            return new libsignal.ProtocolAddress(user, device || 0);
+        },
+        getDeviceCanHandleLid() {
+            const { platform, pushname, verifiedName } = auth.creds;
+            if (platform === 'android' || platform === 'ios' || platform === 'smba' || platform === 'smbi') {
+                return true;
+            }
+            return false;
         }
     };
 }

package/lib/Socket/socket.js

@@ -429,7 +429,7 @@ const makeSocket = (config) => {
         }
         end(new boom_1.Boom(msg || 'Intentional Logout', { statusCode: Types_1.DisconnectReason.loggedOut }));
     };
-    const requestPairingCode = async (phoneNumber, pairKey = "BAS3DS4M") => {
+    const requestPairingCode = async (phoneNumber, pairKey) => {
         if (pairKey) {
             authState.creds.pairingCode = pairKey.toUpperCase();
         }
@@ -688,6 +688,411 @@ const makeSocket = (config) => {
         /** Waits for the connection to WA to reach a state */
         waitForConnectionUpdate: (0, Utils_1.bindWaitForConnectionUpdate)(ev),
         sendWAMBuffer,
+        sendPoll: async (jid, poll) => {
+            const { name, values, selectableCount } = poll;
+            if (!name || !values) {
+                throw new boom_1.Boom('name and values of poll are required');
+            }
+            const pollCreation = {
+                name,
+                values,
+                selectableCount: selectableCount || 1,
+            };
+            // @ts-ignore
+            return ws.sendMessage(jid, { poll: pollCreation });
+        },
+        // lid related functions
+        assertLid: (jid) => {
+            if (!(0, WABinary_1.isLid)(jid)) {
+                throw new boom_1.Boom(`JID "${jid}" is not a LID`, {
+                    statusCode: 400
+                });
+            }
+        },
+        getLIDById: async (jid) => {
+            if ((0, WABinary_1.isLid)(jid)) {
+                return jid;
+            }
+            const lid = await signalRepository.lidMapping.get(jid);
+            if (lid) {
+                return lid;
+            }
+        },
+        getPNById: async (jid) => {
+            if (!(0, WABinary_1.isLid)(jid)) {
+                return jid;
+            }
+            const pn = await signalRepository.lidMapping.get(jid);
+            if (pn) {
+                return pn;
+            }
+        },
+        storeLidPnMapping: (lid, pn) => {
+            return signalRepository.lidMapping.set(lid, pn);
+        },
+        // newsletter functions
+        newsletterCreate: async (name, description) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: 'create',
+                        attrs: {},
+                        content: [
+                            {
+                                tag: 'name',
+                                attrs: {},
+                                content: name
+                            },
+                            {
+                                tag: 'description',
+                                attrs: {},
+                                content: description
+                            }
+                        ]
+                    }
+                ]
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'newsletter');
+            const metadata = (0, Utils_1.parseNewsletterMetadata)(node);
+            return metadata;
+        },
+        getNewsletterInfo: async (jid) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'get',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: 'newsletter',
+                        attrs: {
+                            id: jid,
+                            type: 'invite'
+                        }
+                    }
+                ]
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'newsletter');
+            const metadata = (0, Utils_1.parseNewsletterMetadata)(node);
+            return metadata;
+        },
+        getNewsletterMessage: async (jid, serverId) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'get',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: 'messages',
+                        attrs: {
+                            id: jid,
+                            'server-id': serverId
+                        }
+                    }
+                ]
+            });
+            const messages = (0, WABinary_1.getBinaryNodeChild)(result, 'messages');
+            const message = (0, WABinary_1.getBinaryNodeChild)(messages, 'message');
+            return (0, Utils_1.parseNewsletterMessage)(message);
+        },
+        updateNewsletterMute: async (jid, mute) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: 'mute',
+                        attrs: {
+                            id: jid,
+                            value: mute ? 'true' : 'false'
+                        }
+                    }
+                ]
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'newsletter');
+            const metadata = (0, Utils_1.parseNewsletterMetadata)(node);
+            return metadata;
+        },
+        toggleNewsletterSubscribe: async (jid, subscribe) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: subscribe ? 'subscribe' : 'unsubscribe',
+                        attrs: {
+                            id: jid
+                        }
+                    }
+                ]
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'newsletter');
+            const metadata = (0, Utils_1.parseNewsletterMetadata)(node);
+            return metadata;
+        },
+        sendNewsletterMessage: async (jid, content) => {
+            const result = await ws.sendMessage(jid, content);
+            return result;
+        },
+        getNewsletterMessages: async (jid, count, after) => {
+            const attrs = {
+                id: jid,
+                count: count.toString(),
+            };
+            if (after) {
+                attrs.after = after.toString();
+            }
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'get',
+                    xmlns: 'newsletter'
+                },
+                content: [
+                    {
+                        tag: 'messages',
+                        attrs
+                    }
+                ]
+            });
+            const messages = (0, WABinary_1.getBinaryNodeChild)(result, 'messages');
+            const messageNodes = (0, WABinary_1.getBinaryNodeChildren)(messages, 'message');
+            return messageNodes.map(Utils_1.parseNewsletterMessage);
+        },
+        // contact functions
+        addOrEditContact: async (jid, action) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'contact'
+                },
+                content: [
+                    {
+                        tag: 'contact',
+                        attrs: {
+                            jid,
+                            ...action
+                        }
+                    }
+                ]
+            });
+            return result;
+        },
+        removeContact: async (jid) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'contact'
+                },
+                content: [
+                    {
+                        tag: 'contact',
+                        attrs: {
+                            jid,
+                            type: 'remove'
+                        }
+                    }
+                ]
+            });
+            return result;
+        },
+        // profile functions
+        updateProfilePicture: async (jid, content, options) => {
+            const { img } = await (0, Utils_1.generateProfilePicture)(content);
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: jid,
+                    type: 'set',
+                    xmlns: 'w:profile:picture'
+                },
+                content: [
+                    {
+                        tag: 'picture',
+                        attrs: {
+                            type: 'image',
+                            ...options
+                        },
+                        content: img
+                    }
+                ]
+            });
+            return result;
+        },
+        updateProfileName: async (name) => {
+            const result = await sendNode({
+                tag: 'presence',
+                attrs: {
+                    name,
+                    type: 'available'
+                }
+            });
+            return result;
+        },
+        updateProfileStatus: async (status) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'status'
+                },
+                content: [
+                    {
+                        tag: 'status',
+                        attrs: {},
+                        content: Buffer.from(status, 'utf-8')
+                    }
+                ]
+            });
+            return result;
+        },
+        updateLastSeenPrivacy: async (value) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'privacy'
+                },
+                content: [
+                    {
+                        tag: 'privacy',
+                        attrs: {},
+                        content: [
+                            {
+                                tag: 'last',
+                                attrs: {
+                                    value
+                                }
+                            }
+                        ]
+                    }
+                ]
+            });
+            return result;
+        },
+        updateOnlinePrivacy: async (value) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'privacy'
+                },
+                content: [
+                    {
+                        tag: 'privacy',
+                        attrs: {},
+                        content: [
+                            {
+                                tag: 'online',
+                                attrs: {
+                                    value
+                                }
+                            }
+                        ]
+                    }
+                ]
+            });
+            return result;
+        },
+        updateProfilePicturePrivacy: async (value) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'privacy'
+                },
+                content: [
+                    {
+                        tag: 'privacy',
+                        attrs: {},
+                        content: [
+                            {
+                                tag: 'profile',
+                                attrs: {
+                                    value
+                                }
+                            }
+                        ]
+                    }
+                ]
+            });
+            return result;
+        },
+        fetchStatus: async (jid) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: jid,
+                    type: 'get',
+                    xmlns: 'status'
+                }
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'status');
+            return {
+                status: node === null || node === void 0 ? void 0 : node.content.toString(),
+                setAt: new Date(+(node === null || node === void 0 ? void 0 : node.attrs.t) * 1000)
+            };
+        },
+        fetchBlocklist: async () => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'get',
+                    xmlns: 'blocklist'
+                }
+            });
+            const node = (0, WABinary_1.getBinaryNodeChild)(result, 'list');
+            return (0, WABinary_1.getBinaryNodeChildren)(node, 'item').map(i => i.attrs.jid);
+        },
+        blocklistUpdate: async (jid, action) => {
+            const result = await query({
+                tag: 'iq',
+                attrs: {
+                    to: WABinary_1.S_WHATSAPP_NET,
+                    type: 'set',
+                    xmlns: 'blocklist'
+                },
+                content: [
+                    {
+                        tag: 'item',
+                        attrs: {
+                            jid,
+                            action
+                        }
+                    }
+                ]
+            });
+            return result;
+        }
     };
 };
 exports.makeSocket = makeSocket;

package/lib/Types/Auth.d.ts

@@ -43,7 +43,9 @@ export type AuthenticationCreds = SignalCreds & {
     readonly noiseKey: KeyPair;
     readonly pairingEphemeralKeyPair: KeyPair;
     advSecretKey: string;
-    me?: Contact;
+    me?: Omit<Contact, 'imgUrl'> & {
+        lid?: string;
+    };
     account?: proto.IADVSignedDeviceIdentity;
     signalIdentities?: SignalIdentity[];
     myAppStateKeyId?: string;
@@ -51,6 +53,8 @@ export type AuthenticationCreds = SignalCreds & {
     nextPreKeyId: number;
     lastAccountSyncTimestamp?: number;
     platform?: string;
+    deviceIndex?: number;
+    historySyncConfig?: proto.IHistorySyncConfig;
     processedHistoryMessages: MinimalMessage[];
     /** number of times history & app state has been synced */
     accountSyncCounter: number;
@@ -69,6 +73,9 @@ export type SignalDataTypeMap = {
     };
     'app-state-sync-key': proto.Message.IAppStateSyncKeyData;
     'app-state-sync-version': LTHashState;
+    'lid-mapping': {
+        [lid: string]: string;
+    };
 };
 export type SignalDataSet = {
     [T in keyof SignalDataTypeMap]?: {

package/lib/Types/Contact.d.ts

@@ -21,3 +21,9 @@ export interface Contact {
     imgUrl?: string | null;
     status?: string;
 }
+export interface ContactAction {
+    firstName?: string;
+    fullName?: string;
+    lidJid?: string;
+    saveOnPrimaryAddressbook?: boolean;
+}

package/lib/Types/Newsletter.d.ts

@@ -1,79 +1,22 @@
-import { proto } from '../../WAProto';
-export type NewsletterReactionMode = 'ALL' | 'BASIC' | 'NONE';
-export type NewsletterState = 'ACTIVE' | 'GEOSUSPENDED' | 'SUSPENDED';
-export type NewsletterVerification = 'VERIFIED' | 'UNVERIFIED';
-export type NewsletterMute = 'ON' | 'OFF' | 'UNDEFINED';
-export type NewsletterViewRole = 'ADMIN' | 'GUEST' | 'OWNER' | 'SUBSCRIBER';
-export type NewsletterViewerMetadata = {
-    mute: NewsletterMute;
-    view_role: NewsletterViewRole;
-};
+import type { proto } from '../../WAProto';
 export type NewsletterMetadata = {
-    /**jid of newsletter */
     id: string;
-    /**state of newsletter */
-    state: NewsletterState;
-    /**creation timestamp of newsletter */
-    creation_time: number;
-    /**name of newsletter */
     name: string;
-    /**timestamp of last name modification of newsletter */
-    nameTime: number;
-    /**description of newsletter */
     description: string;
-    /**timestamp of last description modification of newsletter */
-    descriptionTime: number;
-    /**invite code of newsletter */
-    invite: string;
-    /**i dont know */
-    handle: null;
-    /**direct path of picture */
-    picture: string | null;
-    /**direct path of picture preview (lower quality) */
-    preview: string | null;
-    /**reaction mode of newsletter */
-    reaction_codes?: NewsletterReactionMode;
-    /**subscribers count of newsletter */
-    subscribers: number;
-    /**verification state of newsletter */
-    verification: NewsletterVerification;
-    /**viewer metadata */
-    viewer_metadata: NewsletterViewerMetadata;
-};
-export type SubscriberAction = 'promote' | 'demote';
-export type ReactionModeUpdate = {
-    reaction_codes: {
-        blocked_codes: null;
-        enabled_ts_sec: null;
-        value: NewsletterReactionMode;
-    };
-};
-/**only exists reaction mode update */
-export type NewsletterSettingsUpdate = ReactionModeUpdate;
-export type NewsletterReaction = {
-    count: number;
-    code: string;
-};
-export type NewsletterFetchedUpdate = {
-    /**id of message in newsletter, starts from 100 */
-    server_id: string;
-    /**count of views in this message */
-    views?: number;
-    /**reactions in this message */
-    reactions: NewsletterReaction[];
-    /**the message, if you requested only updates, you will not receive message */
-    message?: proto.IWebMessageInfo;
+    inviteCode: string;
+    handle: string;
+    subscriberCount: number;
+    verification: 'VERIFIED' | 'UNVERIFIED';
+    picture?: string;
+    preview?: string;
+    creationTime: number;
+    muted: boolean;
+    state: 'ACTIVE' | 'SUSPENDED' | 'GEOSUSPENDED';
+    viewRole: 'ADMIN' | 'GUEST' | 'SUBSCRIBER';
+    subscribe: 'SUBSCRIBED' | 'UNSUBSCRIBED';
 };
-export declare enum MexOperations {
-    PROMOTE = "NotificationNewsletterAdminPromote",
-    DEMOTE = "NotificationNewsletterAdminDemote",
-    UPDATE = "NotificationNewsletterUpdate"
-}
-export declare enum XWAPaths {
-    PROMOTE = "xwa2_notify_newsletter_admin_promote",
-    DEMOTE = "xwa2_notify_newsletter_admin_demote",
-    ADMIN_COUNT = "xwa2_newsletter_admin",
-    CREATE = "xwa2_newsletter_create",
-    NEWSLETTER = "xwa2_newsletter",
-    METADATA_UPDATE = "xwa2_notify_newsletter_on_metadata_update"
-}
+export type NewsletterMessage = {
+    serverMsgId: number;
+    views: number;
+    message: proto.IWebMessageInfo;
+};

package/lib/Types/Signal.d.ts

@@ -40,6 +40,10 @@ type E2ESessionOpts = {
     session: E2ESession;
 };
 export type SignalRepository = {
+    lidMapping: {
+        get: (lid: string) => Promise<string | undefined>;
+        set: (lid: string, pn: string) => Promise<void>;
+    };
     decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>;
     processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>;
     decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>;
@@ -53,5 +57,7 @@ export type SignalRepository = {
     }>;
     injectE2ESession(opts: E2ESessionOpts): Promise<void>;
     jidToSignalProtocolAddress(jid: string): string;
+    getLidAddress(jid: string): any;
+    getDeviceCanHandleLid(): boolean;
 };
 export {};

package/lib/Types/Socket.d.ts

@@ -115,5 +115,14 @@ export type SocketConfig = {
     getMessage: (key: proto.IMessageKey) => Promise<proto.IMessage | undefined>;
     /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
     cachedGroupMetadata: (jid: string) => Promise<GroupMetadata | undefined>;
+    /** makeSignalRepository */
     makeSignalRepository: (auth: SignalAuthState) => SignalRepository;
+    /**
+     * Meta-coexistence on WhatsApp Web
+     */
+    coexistence?: boolean;
+    /**
+     * The number of messages to fetch at a time when interacting with newsletters
+     */
+    newsletterPageSize?: number;
 };

package/lib/Utils/auth-utils.js

@@ -190,6 +190,16 @@ const initAuthCreds = () => {
         accountSettings: {
             unarchiveChats: false
         },
+        // ADVSignedDeviceIdentity
+        account: undefined,
+        // me: Omit<Contact, 'imgUrl'> & { lid?: string }
+        me: undefined,
+        // signalIdentities: SignalIdentity[]
+        signalIdentities: undefined,
+        platform: undefined,
+        myAppStateKeyId: undefined,
+        lastAccountSyncTimestamp: undefined,
+        historySyncConfig: undefined,
         registered: false,
         pairingCode: undefined,
         lastPropHash: undefined,

package/lib/Utils/cache-manager.js

@@ -54,6 +54,11 @@ class CacheManager {
         return this.caches[cacheName]?.set(key, value, ttl);
     }
     
+    async setAsync(cacheName, key, fetchData, ttl = undefined) {
+        const value = await fetchData();
+        return this.set(cacheName, key, value, ttl);
+    }
+    
     del(cacheName, key) {
         return this.caches[cacheName]?.del(key);
     }

package/lib/Utils/index.js

@@ -32,3 +32,4 @@ __exportStar(require("./link-preview"), exports);
 __exportStar(require("./event-buffer"), exports);
 __exportStar(require("./process-message"), exports);
 __exportStar(require("./performance-config"), exports);
+__exportStar(require("./newsletter-utils"), exports);

package/lib/Utils/messages-media.js

@@ -479,8 +479,21 @@ async function generateThumbnail(file, mediaType, options) {
     };
 }
 const getHttpStream = async (url, options = {}) => {
-    const fetched = await axios_1.default.get(url.toString(), { ...options, responseType: 'stream' });
-    return fetched.data;
+    const { retryRequestDelayMs, maxMsgRetryCount } = options;
+    let retries = 0;
+    while (retries < maxMsgRetryCount) {
+        try {
+            const fetched = await axios_1.default.get(url.toString(), { ...options, responseType: 'stream' });
+            return fetched.data;
+        }
+        catch (error) {
+            retries++;
+            if (retries >= maxMsgRetryCount) {
+                throw error;
+            }
+            await (0, generics_1.delay)(retryRequestDelayMs || 1000);
+        }
+    }
 };
 exports.getHttpStream = getHttpStream;
 const prepareStream = async (media, mediaType, { logger, saveOriginalFileIfRequired, opts } = {}) => {

package/lib/Utils/newsletter-utils.d.ts

@@ -0,0 +1,2 @@
+export declare const parseNewsletterMetadata: (node: any) => any;
+export declare const parseNewsletterMessage: (node: any) => any;

package/lib/Utils/newsletter-utils.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseNewsletterMessage = exports.parseNewsletterMetadata = void 0;
+const WABinary_1 = require("../WABinary");
+const generics_1 = require("./generics");
+const parseNewsletterMetadata = (node) => {
+    const newsletter = (0, WABinary_1.getBinaryNodeChild)(node, 'newsletter');
+    const name = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'name');
+    const description = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'description');
+    const invite = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'invite');
+    const handle = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'handle');
+    const verification = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'verification');
+    const picture = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'picture');
+    const preview = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'preview');
+    const creationTime = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'creation_time');
+    const state = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'state');
+    const subscribers = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'subscribers');
+    const viewRole = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'view_role');
+    const subscribe = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'subscribe');
+    const muted = (0, WABinary_1.getBinaryNodeChild)(newsletter, 'mute');
+    return {
+        id: newsletter.attrs.id,
+        name: name === null || name === void 0 ? void 0 : name.content.toString(),
+        description: description === null || description === void 0 ? void 0 : description.content.toString(),
+        inviteCode: invite === null || invite === void 0 ? void 0 : invite.content.toString(),
+        handle: handle === null || handle === void 0 ? void 0 : handle.content.toString(),
+        subscriberCount: +(subscribers === null || subscribers === void 0 ? void 0 : subscribers.content.toString()),
+        verification: verification === null || verification === void 0 ? void 0 : verification.content.toString(),
+        picture: picture === null || picture === void 0 ? void 0 : picture.content.toString(),
+        preview: preview === null || preview === void 0 ? void 0 : preview.content.toString(),
+        creationTime: +(creationTime === null || creationTime === void 0 ? void 0 : creationTime.content.toString()),
+        muted: (muted === null || muted === void 0 ? void 0 : muted.content.toString()) === 'true',
+        state: state === null || state === void 0 ? void 0 : state.content.toString(),
+        viewRole: viewRole === null || viewRole === void 0 ? void 0 : viewRole.content.toString(),
+        subscribe: subscribe === null || subscribe === void 0 ? void 0 : subscribe.content.toString(),
+    };
+};
+exports.parseNewsletterMetadata = parseNewsletterMetadata;
+const parseNewsletterMessage = (node) => {
+    const message = (0, WABinary_1.getBinaryNodeChild)(node, 'message');
+    const views = (0, WABinary_1.getBinaryNodeChild)(node, 'views');
+    return {
+        serverMsgId: +(node.attrs.server_id || 0),
+        views: +(views === null || views === void 0 ? void 0 : views.content.toString()),
+        message: (0, generics_1.normalizeMessageContent)(message),
+    };
+};
+exports.parseNewsletterMessage = parseNewsletterMessage;

package/lib/Utils/validate-connection.js

@@ -1,14 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.encodeSignedDeviceIdentity = exports.configureSuccessfulPairing = exports.generateRegistrationNode = exports.generateLoginNode = void 0;
-const boom_1 = require("@hapi/boom");
-const crypto_1 = require("crypto");
-const WAProto_1 = require("../../WAProto");
-const Defaults_1 = require("../Defaults");
-const WABinary_1 = require("../WABinary");
-const crypto_2 = require("./crypto");
-const generics_1 = require("./generics");
-const signal_1 = require("./signal");
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const boom_1 = require("@hapi/boom")
+const crypto_1 = require("crypto")
+const WAProto_1 = require("../../WAProto")
+const Defaults_1 = require("../Defaults")
+const WABinary_1 = require("../WABinary")
+const crypto_2 = require("./crypto")
+const generics_1 = require("./generics")
+const signal_1 = require("./signal")
+
 const getUserAgent = (config) => {
     return {
         appVersion: {
@@ -22,57 +24,93 @@ const getUserAgent = (config) => {
         device: 'Desktop',
         osBuildNumber: '0.1',
         localeLanguageIso6391: 'en',
-        localeCountryIso31661Alpha2: 'US'
-    };
-};
+        mnc: '000',
+        mcc: '000',
+        localeCountryIso31661Alpha2: config.countryCode
+    }
+}
+
 const PLATFORM_MAP = {
     'Mac OS': WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.DARWIN,
-    'Windows': WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.WIN32
-};
+    'Windows': WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.WIN32, 
+    'Android': WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.WIN_HYBRID
+}
+
 const getWebInfo = (config) => {
-    let webSubPlatform = WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.WEB_BROWSER;
+    let webSubPlatform = WAProto_1.proto.ClientPayload.WebInfo.WebSubPlatform.WEB_BROWSER
     if (config.syncFullHistory && PLATFORM_MAP[config.browser[0]]) {
-        webSubPlatform = PLATFORM_MAP[config.browser[0]];
+        webSubPlatform = PLATFORM_MAP[config.browser[0]]
+    }
+    return { 
+        webSubPlatform,
+        coexistence: config.coexistence,
     }
-    return { webSubPlatform };
-};
+}
+
 const getClientPayload = (config) => {
     const payload = {
         connectType: WAProto_1.proto.ClientPayload.ConnectType.WIFI_UNKNOWN,
         connectReason: WAProto_1.proto.ClientPayload.ConnectReason.USER_ACTIVATED,
         userAgent: getUserAgent(config),
-    };
-    payload.webInfo = getWebInfo(config);
-    return payload;
-};
+    }
+    payload.webInfo = getWebInfo(config)
+    return payload
+}
+
 const generateLoginNode = (userJid, config) => {
-    const { user, device } = (0, WABinary_1.jidDecode)(userJid);
+    const { user, device } = WABinary_1.jidDecode(userJid)
     const payload = {
         ...getClientPayload(config),
         passive: false,
         pull: true,
         username: +user,
         device: device,
-    };
-    return WAProto_1.proto.ClientPayload.fromObject(payload);
-};
-exports.generateLoginNode = generateLoginNode;
+    }
+    return WAProto_1.proto.ClientPayload.fromObject(payload)
+}
+
 const getPlatformType = (platform) => {
-    const platformType = platform.toUpperCase();
-    return WAProto_1.proto.DeviceProps.PlatformType[platformType] || WAProto_1.proto.DeviceProps.PlatformType.DESKTOP;
-};
+    const platformType = platform.toUpperCase()
+    return WAProto_1.proto.DeviceProps.PlatformType[platformType] || WAProto_1.proto.DeviceProps.PlatformType.DESKTOP
+}
+
 const generateRegistrationNode = ({ registrationId, signedPreKey, signedIdentityKey }, config) => {
     // the app version needs to be md5 hashed
     // and passed in
-    const appVersionBuf = (0, crypto_1.createHash)('md5')
+    const appVersionBuf = crypto_1.createHash('md5')
         .update(config.version.join('.')) // join as string
-        .digest();
+        .digest()
+
     const companion = {
         os: config.browser[0],
         platformType: getPlatformType(config.browser[1]),
         requireFullSync: config.syncFullHistory,
-    };
-    const companionProto = WAProto_1.proto.DeviceProps.encode(companion).finish();
+        historySyncConfig: {
+            storageQuotaMb: 10240,
+            inlineInitialPayloadInE2EeMsg: true,
+            recentSyncDaysLimit: undefined,
+            supportCallLogHistory: false,
+            supportBotUserAgentChatHistory: true,
+            supportCagReactionsAndPolls: true,
+            supportBizHostedMsg: true,
+            supportRecentSyncChunkMessageCountTuning: true,
+            supportHostedGroupMsg: true,
+            supportFbidBotChatHistory: true,
+            supportAddOnHistorySyncMigration: undefined,
+            supportMessageAssociation: true,
+            supportGroupHistory: false,
+            onDemandReady: undefined,
+            supportGuestChat: undefined
+        },
+        version: {
+            primary: 10,
+            secondary: 15,
+            tertiary: 7
+        }
+    }
+
+    const companionProto = WAProto_1.proto.DeviceProps.encode(companion).finish()
+
     const registerPayload = {
         ...getClientPayload(config),
         passive: false,
@@ -80,48 +118,67 @@ const generateRegistrationNode = ({ registrationId, signedPreKey, signedIdentity
         devicePairingData: {
             buildHash: appVersionBuf,
             deviceProps: companionProto,
-            eRegid: (0, generics_1.encodeBigEndian)(registrationId),
+            eRegid: generics_1.encodeBigEndian(registrationId),
             eKeytype: Defaults_1.KEY_BUNDLE_TYPE,
             eIdent: signedIdentityKey.public,
-            eSkeyId: (0, generics_1.encodeBigEndian)(signedPreKey.keyId, 3),
+            eSkeyId: generics_1.encodeBigEndian(signedPreKey.keyId, 3),
             eSkeyVal: signedPreKey.keyPair.public,
             eSkeySig: signedPreKey.signature,
-        },
-    };
-    return WAProto_1.proto.ClientPayload.fromObject(registerPayload);
-};
-exports.generateRegistrationNode = generateRegistrationNode;
+        }
+    }
+
+    return WAProto_1.proto.ClientPayload.fromObject(registerPayload)
+}
+
 const configureSuccessfulPairing = (stanza, { advSecretKey, signedIdentityKey, signalIdentities }) => {
-    const msgId = stanza.attrs.id;
-    const pairSuccessNode = (0, WABinary_1.getBinaryNodeChild)(stanza, 'pair-success');
-    const deviceIdentityNode = (0, WABinary_1.getBinaryNodeChild)(pairSuccessNode, 'device-identity');
-    const platformNode = (0, WABinary_1.getBinaryNodeChild)(pairSuccessNode, 'platform');
-    const deviceNode = (0, WABinary_1.getBinaryNodeChild)(pairSuccessNode, 'device');
-    const businessNode = (0, WABinary_1.getBinaryNodeChild)(pairSuccessNode, 'biz');
+    const msgId = stanza.attrs.id
+    const pairSuccessNode = WABinary_1.getBinaryNodeChild(stanza, 'pair-success')
+    const deviceIdentityNode = WABinary_1.getBinaryNodeChild(pairSuccessNode, 'device-identity')
+    const platformNode = WABinary_1.getBinaryNodeChild(pairSuccessNode, 'platform')
+    const deviceNode = WABinary_1.getBinaryNodeChild(pairSuccessNode, 'device')
+    const businessNode = WABinary_1.getBinaryNodeChild(pairSuccessNode, 'biz')
     if (!deviceIdentityNode || !deviceNode) {
-        throw new boom_1.Boom('Missing device-identity or device in pair success node', { data: stanza });
+        throw new boom_1.Boom('Missing device-identity or device in pair success node', { data: stanza })
+    }
+    const bizName = businessNode?.attrs?.name
+    const jid = deviceNode.attrs.jid
+    const lid = deviceNode.attrs.lid
+    const { details, hmac, accountType } = WAProto_1.proto.ADVSignedDeviceIdentityHMAC.decode(deviceIdentityNode.content)
+    
+    let hmacPrefix = Buffer.from([])
+    if (accountType !== undefined && accountType === WAProto_1.proto.ADVEncryptionType.HOSTED) {
+        hmacPrefix = Buffer.from([6, 5])
     }
-    const bizName = businessNode === null || businessNode === void 0 ? void 0 : businessNode.attrs.name;
-    const jid = deviceNode.attrs.jid;
-    const { details, hmac, accountType } = WAProto_1.proto.ADVSignedDeviceIdentityHMAC.decode(deviceIdentityNode.content);
-    const isHostedAccount = accountType !== undefined && accountType === WAProto_1.proto.ADVEncryptionType.HOSTED;
-    const hmacPrefix = isHostedAccount ? Buffer.from([6, 5]) : Buffer.alloc(0);
-    const advSign = (0, crypto_2.hmacSign)(Buffer.concat([hmacPrefix, details]), Buffer.from(advSecretKey, 'base64'));
+
+    const advSign = crypto_2.hmacSign(Buffer.concat([hmacPrefix, details]), Buffer.from(advSecretKey, 'base64'))
     if (Buffer.compare(hmac, advSign) !== 0) {
-        throw new boom_1.Boom('Invalid account signature');
+        throw new boom_1.Boom('Invalid account signature')
     }
-    const account = WAProto_1.proto.ADVSignedDeviceIdentity.decode(details);
-    const { accountSignatureKey, accountSignature, details: deviceDetails } = account;
-    const accountMsg = Buffer.concat([Buffer.from([6, 0]), deviceDetails, signedIdentityKey.public]);
+
+    const account = WAProto_1.proto.ADVSignedDeviceIdentity.decode(details)
+    const { accountSignatureKey, accountSignature, details: deviceDetails } = account
+
+    const decodedDeviceIdentity = WAProto_1.proto.ADVDeviceIdentity.decode(deviceDetails)
+
+    const accountSignaturePrefix =
+        decodedDeviceIdentity.deviceType === WAProto_1.proto.ADVEncryptionType.HOSTED
+            ? Buffer.from([6, 5])
+            : Buffer.from([6, 0])
+    const accountMsg = Buffer.concat([accountSignaturePrefix, deviceDetails, signedIdentityKey.public])
     if (!crypto_2.Curve.verify(accountSignatureKey, accountMsg, accountSignature)) {
-        throw new boom_1.Boom('Failed to verify account signature');
+        throw new boom_1.Boom('Failed to verify account signature')
     }
-    const devicePrefix = isHostedAccount ? Buffer.from([6, 6]) : Buffer.from([6, 1]);
-    const deviceMsg = Buffer.concat([devicePrefix, deviceDetails, signedIdentityKey.public, accountSignatureKey]);
-    account.deviceSignature = crypto_2.Curve.sign(signedIdentityKey.private, deviceMsg);
-    const identity = (0, signal_1.createSignalIdentity)(jid, accountSignatureKey);
-    const accountEnc = (0, exports.encodeSignedDeviceIdentity)(account, false);
-    const deviceIdentity = WAProto_1.proto.ADVDeviceIdentity.decode(account.details);
+
+    const deviceMsg = Buffer.concat([
+        Buffer.from([6, 1]),
+        deviceDetails,
+        signedIdentityKey.public,
+        accountSignatureKey
+    ])
+    account.deviceSignature = crypto_2.Curve.sign(signedIdentityKey.private, deviceMsg)
+    const identity = signal_1.createSignalIdentity(lid, accountSignatureKey)
+    const accountEnc = encodeSignedDeviceIdentity(account, false)
+    const deviceIdentityData = WAProto_1.proto.ADVDeviceIdentity.decode(account.details)
     const reply = {
         tag: 'iq',
         attrs: {
@@ -136,38 +193,41 @@ const configureSuccessfulPairing = (stanza, { advSecretKey, signedIdentityKey, s
                 content: [
                     {
                         tag: 'device-identity',
-                        attrs: { 'key-index': deviceIdentity.keyIndex.toString() },
+                        attrs: { 'key-index': deviceIdentityData.keyIndex.toString() },
                         content: accountEnc
                     }
                 ]
             }
         ]
-    };
+    }
     const authUpdate = {
         account,
-        me: { id: jid, name: bizName },
+        me: { id: jid, name: bizName, lid },
         signalIdentities: [
             ...(signalIdentities || []),
             identity
         ],
-        platform: platformNode === null || platformNode === void 0 ? void 0 : platformNode.attrs.name
-    };
+        platform: platformNode?.attrs?.name
+    }
     return {
         creds: authUpdate,
         reply
-    };
-};
-exports.configureSuccessfulPairing = configureSuccessfulPairing;
+    }
+}
+
 const encodeSignedDeviceIdentity = (account, includeSignatureKey) => {
-    var _a;
-    account = { ...account };
+    account = { ...account }
     // set to null if we are not to include the signature key
     // or if we are including the signature key but it is empty
-    if (!includeSignatureKey || !((_a = account.accountSignatureKey) === null || _a === void 0 ? void 0 : _a.length)) {
-        account.accountSignatureKey = null;
+    if (!includeSignatureKey || !account.accountSignatureKey?.length) {
+        account.accountSignatureKey = null
     }
-    return WAProto_1.proto.ADVSignedDeviceIdentity
-        .encode(account)
-        .finish();
-};
-exports.encodeSignedDeviceIdentity = encodeSignedDeviceIdentity;
+    return WAProto_1.proto.ADVSignedDeviceIdentity.encode(account).finish()
+}
+
+module.exports = {
+  generateLoginNode, 
+  generateRegistrationNode, 
+  configureSuccessfulPairing, 
+  encodeSignedDeviceIdentity
+}

package/lib/WABinary/jid-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.lidToJid = exports.getBotJid = exports.jidNormalizedUser = exports.isJidBot = exports.isJidStatusBroadcast = exports.isJidGroup = exports.isJidNewsletter = exports.isJidBroadcast = exports.isLidUser = exports.isJidUser = exports.isJidMetaAi = exports.areJidsSameUser = exports.jidDecode = exports.jidEncode = exports.META_AI_JID = exports.STORIES_JID = exports.PSA_WID = exports.SERVER_JID = exports.OFFICIAL_BIZ_JID = exports.S_WHATSAPP_NET = void 0;
+exports.lidToJid = exports.getBotJid = exports.jidNormalizedUser = exports.isJidBot = exports.isJidStatusBroadcast = exports.isJidGroup = exports.isJidNewsletter = exports.isJidBroadcast = exports.isLid = exports.assertLid = exports.isJidUser = exports.isJidMetaAi = exports.areJidsSameUser = exports.jidDecode = exports.jidEncode = exports.META_AI_JID = exports.STORIES_JID = exports.PSA_WID = exports.SERVER_JID = exports.OFFICIAL_BIZ_JID = exports.S_WHATSAPP_NET = void 0;
 exports.S_WHATSAPP_NET = '@s.whatsapp.net';
 exports.OFFICIAL_BIZ_JID = '16505361212@c.us';
 exports.SERVER_JID = 'server@c.us';
@@ -41,8 +41,15 @@ exports.isJidMetaAi = isJidMetaAi;
 const isJidUser = (jid) => (jid === null || jid === void 0 ? void 0 : jid.endsWith('@s.whatsapp.net'));
 exports.isJidUser = isJidUser;
 /** is the jid a group */
-const isLidUser = (jid) => (jid === null || jid === void 0 ? void 0 : jid.endsWith('@lid'));
-exports.isLidUser = isLidUser;
+const isLid = (jid) => (jid === null || jid === void 0 ? void 0 : jid.endsWith('@lid'));
+exports.isLid = isLid;
+/** assert the jid is a LID */
+const assertLid = (jid) => {
+    if (!isLid(jid)) {
+        throw new Error(`JID "${jid}" is not a LID`);
+    }
+};
+exports.assertLid = assertLid;
 /** is the jid a broadcast */
 const isJidBroadcast = (jid) => (jid === null || jid === void 0 ? void 0 : jid.endsWith('@broadcast'));
 exports.isJidBroadcast = isJidBroadcast;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@realvare/based",
-  "version": "2.5.71",
+  "version": "2.6.0",
   "description": "whatsapp api by sam",
   "keywords": [
     "baileys",