supunmd-bail 2.0.1

package/lib/Socket/usync.d.ts

@@ -0,0 +1,37 @@
+import { Boom } from '@hapi/boom';
+import type { SocketConfig } from '../Types/index.js';
+import { type BinaryNode } from '../WABinary/index.js';
+import { USyncQuery } from '../WAUSync/index.js';
+export declare const makeUSyncSocket: (config: SocketConfig) => {
+    executeUSyncQuery: (usyncQuery: USyncQuery) => Promise<import("../index.js").USyncQueryResult | undefined>;
+    type: "md";
+    ws: import("./Client/index.js").WebSocketClient;
+    ev: import("../index.js").BaileysEventEmitter & {
+        process(handler: (events: Partial<import("../index.js").BaileysEventMap>) => void | Promise<void>): () => void;
+        buffer(): void;
+        createBufferedFunction<A extends any[], T>(work: (...args: A) => Promise<T>): (...args: A) => Promise<T>;
+        flush(): boolean;
+        isBuffering(): boolean;
+    };
+    authState: {
+        creds: import("../index.js").AuthenticationCreds;
+        keys: import("../index.js").SignalKeyStoreWithTransaction;
+    };
+    signalRepository: import("../index.js").SignalRepository;
+    user: import("../index.js").Contact | undefined;
+    generateMessageTag: () => string;
+    query: (node: BinaryNode, timeoutMs?: number) => Promise<any>;
+    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) => 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, customPairingCode?: string) => Promise<string>;
+    waitForConnectionUpdate: (check: (u: Partial<import("../index.js").ConnectionState>) => Promise<boolean | undefined>, timeoutMs?: number) => Promise<void>;
+    sendWAMBuffer: (wamBuffer: Buffer) => Promise<any>;
+};
+//# sourceMappingURL=usync.d.ts.map

package/lib/Socket/usync.js

@@ -0,0 +1,63 @@
+import { Boom } from '@hapi/boom';
+import { S_WHATSAPP_NET } from '../WABinary/index.js';
+import { USyncQuery } from '../WAUSync/index.js';
+import { makeSocket } from './socket.js';
+export const makeUSyncSocket = (config) => {
+    const sock = makeSocket(config);
+    const { generateMessageTag, query } = sock;
+    const executeUSyncQuery = async (usyncQuery) => {
+        if (usyncQuery.protocols.length === 0) {
+            throw new 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: 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
+    };
+};
+//# sourceMappingURL=usync.js.map

package/lib/Types/Auth.d.ts

@@ -0,0 +1,111 @@
+import type { proto } from '../../WAProto/index.js';
+import type { Contact } from './Contact.js';
+import type { MinimalMessage } from './Message.js';
+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 LIDMapping = {
+    pn: string;
+    lid: string;
+};
+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;
+    additionalData?: any | 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;
+    'lid-mapping': string;
+    'device-list': string[];
+};
+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>, key: string): 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 {};
+//# sourceMappingURL=Auth.d.ts.map

package/lib/Types/Auth.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Auth.js.map

package/lib/Types/Bussines.d.ts

@@ -0,0 +1,25 @@
+import type { proto } from '../../WAProto';
+export type DayOfWeekBussines = 'sun' | 'mon' | 'tue' | 'wed' | 'thu' | 'fri' | 'sat';
+export type HoursDay = {
+    day: DayOfWeekBussines;
+    mode: 'specific_hours';
+    openTimeInMinutes: string;
+    closeTimeInMinutes: string;
+} | {
+    day: DayOfWeekBussines;
+    mode: 'open_24h' | 'appointment_only';
+};
+export type UpdateBussinesProfileProps = {
+    address?: string;
+    websites?: string[];
+    email?: string;
+    description?: string;
+    hours?: {
+        timezone: string;
+        days: HoursDay[];
+    };
+};
+export type QuickReplyAction = proto.SyncActionValue.IQuickReplyAction & {
+    timestamp?: string;
+};
+//# sourceMappingURL=Bussines.d.ts.map

package/lib/Types/Bussines.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Bussines.js.map

package/lib/Types/Call.d.ts

@@ -0,0 +1,14 @@
+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;
+};
+//# sourceMappingURL=Call.d.ts.map

package/lib/Types/Call.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Call.js.map

package/lib/Types/Chat.d.ts

@@ -0,0 +1,123 @@
+import type { proto } from '../../WAProto/index.js';
+import type { AccountSettings } from './Auth.js';
+import type { QuickReplyAction } from './Bussines.js';
+import type { BufferedEventData } from './Events.js';
+import type { LabelActionBody } from './Label.js';
+import type { ChatLabelAssociationActionBody } from './LabelAssociation.js';
+import type { MessageLabelAssociationActionBody } from './LabelAssociation.js';
+import type { MinimalMessage, WAMessageKey } from './Message.js';
+/** 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;
+    /** last update time */
+    timestamp?: number;
+}>;
+/**
+ * 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;
+    lastMessages: LastMessageList;
+} | {
+    deleteForMe: {
+        deleteMedia: boolean;
+        key: WAMessageKey;
+        timestamp: number;
+    };
+} | {
+    star: {
+        messages: {
+            id: string;
+            fromMe?: boolean;
+        }[];
+        star: boolean;
+    };
+} | {
+    markRead: boolean;
+    lastMessages: LastMessageList;
+} | {
+    delete: true;
+    lastMessages: LastMessageList;
+} | {
+    contact: proto.SyncActionValue.IContactAction | null;
+} | {
+    disableLinkPreviews: proto.SyncActionValue.IPrivacySettingDisableLinkPreviewsAction;
+} | {
+    addLabel: LabelActionBody;
+} | {
+    addChatLabel: ChatLabelAssociationActionBody;
+} | {
+    removeChatLabel: ChatLabelAssociationActionBody;
+} | {
+    addMessageLabel: MessageLabelAssociationActionBody;
+} | {
+    removeMessageLabel: MessageLabelAssociationActionBody;
+} | {
+    quickReply: QuickReplyAction;
+};
+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;
+};
+//# sourceMappingURL=Chat.d.ts.map

package/lib/Types/Chat.js

@@ -0,0 +1,8 @@
+export const ALL_WA_PATCH_NAMES = [
+    'critical_block',
+    'critical_unblock_low',
+    'regular_high',
+    'regular_low',
+    'regular'
+];
+//# sourceMappingURL=Chat.js.map

package/lib/Types/Contact.d.ts

@@ -0,0 +1,24 @@
+export interface Contact {
+    /** ID either in lid or jid format (preferred) **/
+    id: string;
+    /** ID in LID format (@lid) **/
+    lid?: string;
+    /** ID in PN format (@s.whatsapp.net)  **/
+    phoneNumber?: 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;
+}
+//# sourceMappingURL=Contact.d.ts.map

package/lib/Types/Contact.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Contact.js.map

package/lib/Types/Events.d.ts

@@ -0,0 +1,202 @@
+import type { Boom } from '@hapi/boom';
+import { proto } from '../../WAProto/index.js';
+import type { AuthenticationCreds } from './Auth.js';
+import type { WACallEvent } from './Call.js';
+import type { Chat, ChatUpdate, PresenceData } from './Chat.js';
+import type { Contact } from './Contact.js';
+import type { GroupMetadata, GroupParticipant, ParticipantAction, RequestJoinAction, RequestJoinMethod } from './GroupMetadata.js';
+import type { Label } from './Label.js';
+import type { LabelAssociation } from './LabelAssociation.js';
+import type { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message.js';
+import type { ConnectionState } from './State.js';
+export type BaileysEventMap = {
+    /** connection state has been updated -- WS closed, opened, connecting etc. */
+    'connection.update': Partial<ConnectionState>;
+    /** credentials updated -- some metadata, keys or something */
+    'creds.update': Partial<AuthenticationCreds>;
+    /** set chats (history sync), everything is reverse chronologically sorted */
+    'messaging-history.set': {
+        chats: Chat[];
+        contacts: Contact[];
+        messages: WAMessage[];
+        isLatest?: boolean;
+        progress?: number | null;
+        syncType?: proto.HistorySync.HistorySyncType | null;
+        peerDataRequestSessionId?: string | null;
+    };
+    /** upsert chats */
+    'chats.upsert': Chat[];
+    /** update the given chats */
+    'chats.update': ChatUpdate[];
+    'lid-mapping.update': {
+        lid: string;
+        pn: string;
+    };
+    /** delete chats with given ID */
+    'chats.delete': string[];
+    /** presence of contact in a chat updated */
+    'presence.update': {
+        id: string;
+        presences: {
+            [participant: string]: PresenceData;
+        };
+    };
+    'contacts.upsert': Contact[];
+    'contacts.update': Partial<Contact>[];
+    'messages.delete': {
+        keys: WAMessageKey[];
+    } | {
+        jid: string;
+        all: true;
+    };
+    'messages.update': WAMessageUpdate[];
+    'messages.media-update': {
+        key: WAMessageKey;
+        media?: {
+            ciphertext: Uint8Array;
+            iv: Uint8Array;
+        };
+        error?: Boom;
+    }[];
+    /**
+     * 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': {
+        key: WAMessageKey;
+        reaction: proto.IReaction;
+    }[];
+    'message-receipt.update': MessageUserReceiptUpdate[];
+    'groups.upsert': GroupMetadata[];
+    'groups.update': Partial<GroupMetadata>[];
+    /** apply an action to participants in a group */
+    'group-participants.update': {
+        id: string;
+        author: string;
+        authorPn?: string;
+        participants: GroupParticipant[];
+        action: ParticipantAction;
+    };
+    'group.join-request': {
+        id: string;
+        author: string;
+        authorPn?: string;
+        participant: string;
+        participantPn?: string;
+        action: RequestJoinAction;
+        method: RequestJoinMethod;
+    };
+    'blocklist.set': {
+        blocklist: string[];
+    };
+    'blocklist.update': {
+        blocklist: string[];
+        type: 'add' | 'remove';
+    };
+    /** Receive an update on a call, including when the call was received, rejected, accepted */
+    call: WACallEvent[];
+    'labels.edit': Label;
+    'labels.association': {
+        association: LabelAssociation;
+        type: 'add' | 'remove';
+    };
+    /** Newsletter-related events */
+    'newsletter.reaction': {
+        id: string;
+        server_id: string;
+        reaction: {
+            code?: string;
+            count?: number;
+            removed?: boolean;
+        };
+    };
+    'newsletter.view': {
+        id: string;
+        server_id: string;
+        count: number;
+    };
+    'newsletter-participants.update': {
+        id: string;
+        author: string;
+        user: string;
+        new_role: string;
+        action: string;
+    };
+    'newsletter-settings.update': {
+        id: string;
+        update: any;
+    };
+};
+export type BufferedEventData = {
+    historySets: {
+        chats: {
+            [jid: string]: Chat;
+        };
+        contacts: {
+            [jid: string]: Contact;
+        };
+        messages: {
+            [uqId: string]: WAMessage;
+        };
+        empty: boolean;
+        isLatest: boolean;
+        progress?: number | null;
+        syncType?: proto.HistorySync.HistorySyncType;
+        peerDataRequestSessionId?: string;
+    };
+    chatUpserts: {
+        [jid: string]: Chat;
+    };
+    chatUpdates: {
+        [jid: string]: ChatUpdate;
+    };
+    chatDeletes: Set<string>;
+    contactUpserts: {
+        [jid: string]: Contact;
+    };
+    contactUpdates: {
+        [jid: string]: Partial<Contact>;
+    };
+    messageUpserts: {
+        [key: string]: {
+            type: MessageUpsertType;
+            message: WAMessage;
+        };
+    };
+    messageUpdates: {
+        [key: string]: WAMessageUpdate;
+    };
+    messageDeletes: {
+        [key: string]: WAMessageKey;
+    };
+    messageReactions: {
+        [key: string]: {
+            key: WAMessageKey;
+            reactions: proto.IReaction[];
+        };
+    };
+    messageReceipts: {
+        [key: string]: {
+            key: WAMessageKey;
+            userReceipt: proto.IUserReceipt[];
+        };
+    };
+    groupUpdates: {
+        [jid: string]: Partial<GroupMetadata>;
+    };
+};
+export type BaileysEvent = keyof BaileysEventMap;
+export interface BaileysEventEmitter {
+    on<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void;
+    off<T extends keyof BaileysEventMap>(event: T, listener: (arg: BaileysEventMap[T]) => void): void;
+    removeAllListeners<T extends keyof BaileysEventMap>(event: T): void;
+    emit<T extends keyof BaileysEventMap>(event: T, arg: BaileysEventMap[T]): boolean;
+}
+//# sourceMappingURL=Events.d.ts.map

package/lib/Types/Events.js

@@ -0,0 +1,2 @@
+import { proto } from '../../WAProto/index.js';
+//# sourceMappingURL=Events.js.map