@d0v3riz/baileys 6.7.9 → 6.7.16

package/lib/Socket/usync.d.ts

@@ -0,0 +1,36 @@
+import { Boom } from '@hapi/boom';
+import { SocketConfig } from '../Types';
+import { BinaryNode } from '../WABinary';
+import { USyncQuery } from '../WAUSync';
+export declare const makeUSyncSocket: (config: SocketConfig) => {
+    executeUSyncQuery: (usyncQuery: USyncQuery) => Promise<import("../WAUSync").USyncQueryResult | undefined>;
+    type: "md";
+    ws: import("./Client").WebSocketClient;
+    ev: import("../Types").BaileysEventEmitter & {
+        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): boolean;
+        isBuffering(): boolean;
+    };
+    authState: {
+        creds: import("../Types").AuthenticationCreds;
+        keys: import("../Types").SignalKeyStoreWithTransaction;
+    };
+    signalRepository: import("../Types").SignalRepository;
+    user: import("../Types").Contact | undefined;
+    generateMessageTag: () => string;
+    query: (node: BinaryNode, timeoutMs?: number) => Promise<BinaryNode>;
+    waitForMessage: <T>(msgId: string, timeoutMs?: number | undefined) => Promise<T>;
+    waitForSocketOpen: () => Promise<void>;
+    sendRawMessage: (data: Uint8Array | Buffer) => Promise<void>;
+    sendNode: (frame: BinaryNode) => Promise<void>;
+    logout: (msg?: string) => Promise<void>;
+    end: (error: Error | undefined) => void;
+    onUnexpectedError: (err: Error | Boom, msg: string) => void;
+    uploadPreKeys: (count?: number) => Promise<void>;
+    uploadPreKeysToServerIfRequired: () => Promise<void>;
+    requestPairingCode: (phoneNumber: string) => Promise<string>;
+    waitForConnectionUpdate: (check: (u: Partial<import("../Types").ConnectionState>) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<void>;
+    sendWAMBuffer: (wamBuffer: Buffer) => Promise<BinaryNode>;
+};

package/lib/Socket/usync.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeUSyncSocket = void 0;
+const boom_1 = require("@hapi/boom");
+const WABinary_1 = require("../WABinary");
+const socket_1 = require("./socket");
+const makeUSyncSocket = (config) => {
+    const sock = (0, socket_1.makeSocket)(config);
+    const { generateMessageTag, query, } = sock;
+    const executeUSyncQuery = async (usyncQuery) => {
+        if (usyncQuery.protocols.length === 0) {
+            throw new boom_1.Boom('USyncQuery must have at least one protocol');
+        }
+        // todo: validate users, throw WARNING on no valid users
+        // variable below has only validated users
+        const validUsers = usyncQuery.users;
+        const userNodes = validUsers.map((user) => {
+            return {
+                tag: 'user',
+                attrs: {
+                    jid: !user.phone ? user.id : undefined,
+                },
+                content: usyncQuery.protocols
+                    .map((a) => a.getUserElement(user))
+                    .filter(a => a !== null)
+            };
+        });
+        const listNode = {
+            tag: 'list',
+            attrs: {},
+            content: userNodes
+        };
+        const queryNode = {
+            tag: 'query',
+            attrs: {},
+            content: usyncQuery.protocols.map((a) => a.getQueryElement())
+        };
+        const iq = {
+            tag: 'iq',
+            attrs: {
+                to: WABinary_1.S_WHATSAPP_NET,
+                type: 'get',
+                xmlns: 'usync',
+            },
+            content: [
+                {
+                    tag: 'usync',
+                    attrs: {
+                        context: usyncQuery.context,
+                        mode: usyncQuery.mode,
+                        sid: generateMessageTag(),
+                        last: 'true',
+                        index: '0',
+                    },
+                    content: [
+                        queryNode,
+                        listNode
+                    ]
+                }
+            ],
+        };
+        const result = await query(iq);
+        return usyncQuery.parseUSyncQueryResult(result);
+    };
+    return {
+        ...sock,
+        executeUSyncQuery,
+    };
+};
+exports.makeUSyncSocket = makeUSyncSocket;

package/lib/Types/Auth.d.ts

@@ -1,105 +1,103 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import type { proto } from '../../WAProto';
-import type { Contact } from './Contact';
-import type { MinimalMessage } from './Message';
-export type KeyPair = {
-    public: Uint8Array;
-    private: Uint8Array;
-};
-export type SignedKeyPair = {
-    keyPair: KeyPair;
-    signature: Uint8Array;
-    keyId: number;
-    timestampS?: number;
-};
-export type ProtocolAddress = {
-    name: string;
-    deviceId: number;
-};
-export type SignalIdentity = {
-    identifier: ProtocolAddress;
-    identifierKey: Uint8Array;
-};
-export type LTHashState = {
-    version: number;
-    hash: Buffer;
-    indexValueMap: {
-        [indexMacBase64: string]: {
-            valueMac: Uint8Array | Buffer;
-        };
-    };
-};
-export type SignalCreds = {
-    readonly signedIdentityKey: KeyPair;
-    readonly signedPreKey: SignedKeyPair;
-    readonly registrationId: number;
-};
-export type AccountSettings = {
-    /** unarchive chats when a new message is received */
-    unarchiveChats: boolean;
-    /** the default mode to start new conversations with */
-    defaultDisappearingMode?: Pick<proto.IConversation, 'ephemeralExpiration' | 'ephemeralSettingTimestamp'>;
-};
-export type AuthenticationCreds = SignalCreds & {
-    readonly noiseKey: KeyPair;
-    readonly pairingEphemeralKeyPair: KeyPair;
-    advSecretKey: string;
-    me?: Contact;
-    account?: proto.IADVSignedDeviceIdentity;
-    signalIdentities?: SignalIdentity[];
-    myAppStateKeyId?: string;
-    firstUnuploadedPreKeyId: number;
-    nextPreKeyId: number;
-    lastAccountSyncTimestamp?: number;
-    platform?: string;
-    processedHistoryMessages: MinimalMessage[];
-    /** number of times history & app state has been synced */
-    accountSyncCounter: number;
-    accountSettings: AccountSettings;
-    registered: boolean;
-    pairingCode: string | undefined;
-    lastPropHash: string | undefined;
-    routingInfo: Buffer | undefined;
-};
-export type SignalDataTypeMap = {
-    'pre-key': KeyPair;
-    'session': Uint8Array;
-    'sender-key': Uint8Array;
-    'sender-key-memory': {
-        [jid: string]: boolean;
-    };
-    'app-state-sync-key': proto.Message.IAppStateSyncKeyData;
-    'app-state-sync-version': LTHashState;
-};
-export type SignalDataSet = {
-    [T in keyof SignalDataTypeMap]?: {
-        [id: string]: SignalDataTypeMap[T] | null;
-    };
-};
-type Awaitable<T> = T | Promise<T>;
-export type SignalKeyStore = {
-    get<T extends keyof SignalDataTypeMap>(type: T, ids: string[]): Awaitable<{
-        [id: string]: SignalDataTypeMap[T];
-    }>;
-    set(data: SignalDataSet): Awaitable<void>;
-    /** clear all the data in the store */
-    clear?(): Awaitable<void>;
-};
-export type SignalKeyStoreWithTransaction = SignalKeyStore & {
-    isInTransaction: () => boolean;
-    transaction<T>(exec: () => Promise<T>): Promise<T>;
-};
-export type TransactionCapabilityOptions = {
-    maxCommitRetries: number;
-    delayBetweenTriesMs: number;
-};
-export type SignalAuthState = {
-    creds: SignalCreds;
-    keys: SignalKeyStore | SignalKeyStoreWithTransaction;
-};
-export type AuthenticationState = {
-    creds: AuthenticationCreds;
-    keys: SignalKeyStore;
-};
-export {};
+import type { proto } from '../../WAProto';
+import type { Contact } from './Contact';
+import type { MinimalMessage } from './Message';
+export type KeyPair = {
+    public: Uint8Array;
+    private: Uint8Array;
+};
+export type SignedKeyPair = {
+    keyPair: KeyPair;
+    signature: Uint8Array;
+    keyId: number;
+    timestampS?: number;
+};
+export type ProtocolAddress = {
+    name: string;
+    deviceId: number;
+};
+export type SignalIdentity = {
+    identifier: ProtocolAddress;
+    identifierKey: Uint8Array;
+};
+export type LTHashState = {
+    version: number;
+    hash: Buffer;
+    indexValueMap: {
+        [indexMacBase64: string]: {
+            valueMac: Uint8Array | Buffer;
+        };
+    };
+};
+export type SignalCreds = {
+    readonly signedIdentityKey: KeyPair;
+    readonly signedPreKey: SignedKeyPair;
+    readonly registrationId: number;
+};
+export type AccountSettings = {
+    /** unarchive chats when a new message is received */
+    unarchiveChats: boolean;
+    /** the default mode to start new conversations with */
+    defaultDisappearingMode?: Pick<proto.IConversation, 'ephemeralExpiration' | 'ephemeralSettingTimestamp'>;
+};
+export type AuthenticationCreds = SignalCreds & {
+    readonly noiseKey: KeyPair;
+    readonly pairingEphemeralKeyPair: KeyPair;
+    advSecretKey: string;
+    me?: Contact;
+    account?: proto.IADVSignedDeviceIdentity;
+    signalIdentities?: SignalIdentity[];
+    myAppStateKeyId?: string;
+    firstUnuploadedPreKeyId: number;
+    nextPreKeyId: number;
+    lastAccountSyncTimestamp?: number;
+    platform?: string;
+    processedHistoryMessages: MinimalMessage[];
+    /** number of times history & app state has been synced */
+    accountSyncCounter: number;
+    accountSettings: AccountSettings;
+    registered: boolean;
+    pairingCode: string | undefined;
+    lastPropHash: string | undefined;
+    routingInfo: Buffer | undefined;
+};
+export type SignalDataTypeMap = {
+    'pre-key': KeyPair;
+    'session': Uint8Array;
+    'sender-key': Uint8Array;
+    'sender-key-memory': {
+        [jid: string]: boolean;
+    };
+    'app-state-sync-key': proto.Message.IAppStateSyncKeyData;
+    'app-state-sync-version': LTHashState;
+};
+export type SignalDataSet = {
+    [T in keyof SignalDataTypeMap]?: {
+        [id: string]: SignalDataTypeMap[T] | null;
+    };
+};
+type Awaitable<T> = T | Promise<T>;
+export type SignalKeyStore = {
+    get<T extends keyof SignalDataTypeMap>(type: T, ids: string[]): Awaitable<{
+        [id: string]: SignalDataTypeMap[T];
+    }>;
+    set(data: SignalDataSet): Awaitable<void>;
+    /** clear all the data in the store */
+    clear?(): Awaitable<void>;
+};
+export type SignalKeyStoreWithTransaction = SignalKeyStore & {
+    isInTransaction: () => boolean;
+    transaction<T>(exec: () => Promise<T>): Promise<T>;
+};
+export type TransactionCapabilityOptions = {
+    maxCommitRetries: number;
+    delayBetweenTriesMs: number;
+};
+export type SignalAuthState = {
+    creds: SignalCreds;
+    keys: SignalKeyStore | SignalKeyStoreWithTransaction;
+};
+export type AuthenticationState = {
+    creds: AuthenticationCreds;
+    keys: SignalKeyStore;
+};
+export {};

package/lib/Types/Auth.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/Call.d.ts

@@ -1,13 +1,13 @@
-export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept' | 'terminate';
-export type WACallEvent = {
-    chatId: string;
-    from: string;
-    isGroup?: boolean;
-    groupJid?: string;
-    id: string;
-    date: Date;
-    isVideo?: boolean;
-    status: WACallUpdateType;
-    offline: boolean;
-    latencyMs?: number;
-};
+export type WACallUpdateType = 'offer' | 'ringing' | 'timeout' | 'reject' | 'accept' | 'terminate';
+export type WACallEvent = {
+    chatId: string;
+    from: string;
+    isGroup?: boolean;
+    groupJid?: string;
+    id: string;
+    date: Date;
+    isVideo?: boolean;
+    status: WACallUpdateType;
+    offline: boolean;
+    latencyMs?: number;
+};

package/lib/Types/Call.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/Chat.d.ts

@@ -1,107 +1,112 @@
-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';
-/** 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"];
-export type WAPatchName = typeof ALL_WA_PATCH_NAMES[number];
-export interface PresenceData {
-    lastKnownPresence: WAPresence;
-    lastSeen?: number;
-}
-export type ChatMutation = {
-    syncAction: proto.ISyncActionData;
-    index: string[];
-};
-export type WAPatchCreate = {
-    syncAction: proto.ISyncActionValue;
-    index: string[];
-    type: WAPatchName;
-    apiVersion: number;
-    operation: proto.SyncdMutation.SyncdOperation;
-};
-export type Chat = proto.IConversation & {
-    /** unix timestamp of when the last message was received in the chat */
-    lastMessageRecvTimestamp?: number;
-};
-export type ChatUpdate = Partial<Chat & {
-    /**
-     * if specified in the update,
-     * the EV buffer will check if the condition gets fulfilled before applying the update
-     * Right now, used to determine when to release an app state sync event
-     *
-     * @returns true, if the update should be applied;
-     * false if it can be discarded;
-     * undefined if the condition is not yet fulfilled
-     * */
-    conditional: (bufferedData: BufferedEventData) => boolean | undefined;
-}>;
-/**
- * the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat
- * for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat
- * */
-export type LastMessageList = MinimalMessage[] | proto.SyncActionValue.ISyncActionMessageRange;
-export type ChatModification = {
-    archive: boolean;
-    lastMessages: LastMessageList;
-} | {
-    pushNameSetting: string;
-} | {
-    pin: boolean;
-} | {
-    /** mute for duration, or provide timestamp of mute to remove*/
-    mute: number | null;
-} | {
-    clear: boolean;
-} | {
-    deleteForMe: {
-        deleteMedia: boolean;
-        key: WAMessageKey;
-        timestamp: number;
-    };
-} | {
-    star: {
-        messages: {
-            id: string;
-            fromMe?: boolean;
-        }[];
-        star: boolean;
-    };
-} | {
-    markRead: boolean;
-    lastMessages: LastMessageList;
-} | {
-    delete: true;
-    lastMessages: LastMessageList;
-} | {
-    addLabel: LabelActionBody;
-} | {
-    addChatLabel: ChatLabelAssociationActionBody;
-} | {
-    removeChatLabel: ChatLabelAssociationActionBody;
-} | {
-    addMessageLabel: MessageLabelAssociationActionBody;
-} | {
-    removeMessageLabel: MessageLabelAssociationActionBody;
-};
-export type InitialReceivedChatsState = {
-    [jid: string]: {
-        /** the last message received from the other party */
-        lastMsgRecvTimestamp?: number;
-        /** the absolute last message in the chat */
-        lastMsgTimestamp: number;
-    };
-};
-export type InitialAppStateSyncOptions = {
-    accountSettings: AccountSettings;
-};
+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';
+/** 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';
+export type WAPrivacyMessagesValue = 'all' | 'contacts';
+/** 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"];
+export type WAPatchName = typeof ALL_WA_PATCH_NAMES[number];
+export interface PresenceData {
+    lastKnownPresence: WAPresence;
+    lastSeen?: number;
+}
+export type BotListInfo = {
+    jid: string;
+    personaId: string;
+};
+export type ChatMutation = {
+    syncAction: proto.ISyncActionData;
+    index: string[];
+};
+export type WAPatchCreate = {
+    syncAction: proto.ISyncActionValue;
+    index: string[];
+    type: WAPatchName;
+    apiVersion: number;
+    operation: proto.SyncdMutation.SyncdOperation;
+};
+export type Chat = proto.IConversation & {
+    /** unix timestamp of when the last message was received in the chat */
+    lastMessageRecvTimestamp?: number;
+};
+export type ChatUpdate = Partial<Chat & {
+    /**
+     * if specified in the update,
+     * the EV buffer will check if the condition gets fulfilled before applying the update
+     * Right now, used to determine when to release an app state sync event
+     *
+     * @returns true, if the update should be applied;
+     * false if it can be discarded;
+     * undefined if the condition is not yet fulfilled
+     * */
+    conditional: (bufferedData: BufferedEventData) => boolean | undefined;
+}>;
+/**
+ * the last messages in a chat, sorted reverse-chronologically. That is, the latest message should be first in the chat
+ * for MD modifications, the last message in the array (i.e. the earlist message) must be the last message recv in the chat
+ * */
+export type LastMessageList = MinimalMessage[] | proto.SyncActionValue.ISyncActionMessageRange;
+export type ChatModification = {
+    archive: boolean;
+    lastMessages: LastMessageList;
+} | {
+    pushNameSetting: string;
+} | {
+    pin: boolean;
+} | {
+    /** mute for duration, or provide timestamp of mute to remove*/
+    mute: number | null;
+} | {
+    clear: boolean;
+} | {
+    deleteForMe: {
+        deleteMedia: boolean;
+        key: WAMessageKey;
+        timestamp: number;
+    };
+} | {
+    star: {
+        messages: {
+            id: string;
+            fromMe?: boolean;
+        }[];
+        star: boolean;
+    };
+} | {
+    markRead: boolean;
+    lastMessages: LastMessageList;
+} | {
+    delete: true;
+    lastMessages: LastMessageList;
+} | {
+    addLabel: LabelActionBody;
+} | {
+    addChatLabel: ChatLabelAssociationActionBody;
+} | {
+    removeChatLabel: ChatLabelAssociationActionBody;
+} | {
+    addMessageLabel: MessageLabelAssociationActionBody;
+} | {
+    removeMessageLabel: MessageLabelAssociationActionBody;
+};
+export type InitialReceivedChatsState = {
+    [jid: string]: {
+        /** the last message received from the other party */
+        lastMsgRecvTimestamp?: number;
+        /** the absolute last message in the chat */
+        lastMsgTimestamp: number;
+    };
+};
+export type InitialAppStateSyncOptions = {
+    accountSettings: AccountSettings;
+};

package/lib/Types/Chat.js

@@ -1,4 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ALL_WA_PATCH_NAMES = void 0;
-exports.ALL_WA_PATCH_NAMES = ['critical_block', 'critical_unblock_low', 'regular_high', 'regular_low', 'regular'];
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ALL_WA_PATCH_NAMES = void 0;
+exports.ALL_WA_PATCH_NAMES = ['critical_block', 'critical_unblock_low', 'regular_high', 'regular_low', 'regular'];

package/lib/Types/Contact.d.ts

@@ -1,19 +1,19 @@
-export interface Contact {
-    id: string;
-    lid?: string;
-    /** name of the contact, you have saved on your WA */
-    name?: string;
-    /** name of the contact, the contact has set on their own on WA */
-    notify?: string;
-    /** I have no idea */
-    verifiedName?: string;
-    /**
-     * Url of the profile picture of the contact
-     *
-     * 'changed' => if the profile picture has changed
-     * null => if the profile picture has not been set (default profile picture)
-     * any other string => url of the profile picture
-     */
-    imgUrl?: string | null;
-    status?: string;
-}
+export interface Contact {
+    id: string;
+    lid?: string;
+    /** name of the contact, you have saved on your WA */
+    name?: string;
+    /** name of the contact, the contact has set on their own on WA */
+    notify?: string;
+    /** I have no idea */
+    verifiedName?: string;
+    /**
+     * Url of the profile picture of the contact
+     *
+     * 'changed' => if the profile picture has changed
+     * null => if the profile picture has not been set (default profile picture)
+     * any other string => url of the profile picture
+     */
+    imgUrl?: string | null;
+    status?: string;
+}

package/lib/Types/Contact.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });