@jkt48connect-corp/baileys 7.2.9 → 7.3.0

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

@@ -0,0 +1,118 @@
+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 { ObjectRepository } from './object-repository';
+type WASocket = ReturnType<typeof makeMDSocket>;
+export declare const waChatKey: (pin: boolean) => {
+    key: (c: Chat) => string;
+    compare: (k1: string, k2: string) => number;
+};
+export declare const waMessageID: (m: WAMessage) => string;
+export declare const waLabelAssociationKey: Comparable<LabelAssociation, string>;
+export type BaileysInMemoryStoreConfig = {
+    chatKey?: Comparable<Chat, string>;
+    labelAssociationKey?: Comparable<LabelAssociation, string>;
+    logger?: Logger;
+    socket?: WASocket;
+};
+declare const _default: (config: BaileysInMemoryStoreConfig) => {
+    chats: KeyedDB<Chat, string>;
+    contacts: {
+        [_: string]: Contact;
+    };
+    messages: {
+        [_: string]: {
+            array: proto.IWebMessageInfo[];
+            get: (id: string) => proto.IWebMessageInfo | undefined;
+            upsert: (item: proto.IWebMessageInfo, mode: "append" | "prepend") => void;
+            update: (item: proto.IWebMessageInfo) => boolean;
+            remove: (item: proto.IWebMessageInfo) => boolean;
+            updateAssign: (id: string, update: Partial<proto.IWebMessageInfo>) => boolean;
+            clear: () => void;
+            filter: (contain: (item: proto.IWebMessageInfo) => boolean) => void;
+            toJSON: () => proto.IWebMessageInfo[];
+            fromJSON: (newItems: proto.IWebMessageInfo[]) => void;
+        };
+    };
+    groupMetadata: {
+        [_: string]: GroupMetadata;
+    };
+    state: ConnectionState;
+    presences: {
+        [id: string]: {
+            [participant: string]: PresenceData;
+        };
+    };
+    labels: ObjectRepository<Label>;
+    labelAssociations: KeyedDB<LabelAssociation, string>;
+    bind: (ev: BaileysEventEmitter) => void;
+    /** loads messages from the store, if not found -- uses the legacy connection */
+    loadMessages: (jid: string, count: number, cursor: WAMessageCursor) => Promise<proto.IWebMessageInfo[]>;
+    /**
+     * Get all available labels for profile
+     *
+     * Keep in mind that the list is formed from predefined tags and tags
+     * that were "caught" during their editing.
+     */
+    getLabels: () => ObjectRepository<Label>;
+    /**
+     * Get labels for chat
+     *
+     * @returns Label IDs
+     **/
+    getChatLabels: (chatId: string) => LabelAssociation[];
+    /**
+     * Get labels for message
+     *
+     * @returns Label IDs
+     **/
+    getMessageLabels: (messageId: string) => string[];
+    loadMessage: (jid: string, id: string) => Promise<proto.IWebMessageInfo | undefined>;
+    mostRecentMessage: (jid: string) => Promise<proto.IWebMessageInfo>;
+    fetchImageUrl: (jid: string, sock: WASocket | undefined) => Promise<string | null | undefined>;
+    fetchGroupMetadata: (jid: string, sock: WASocket | undefined) => Promise<GroupMetadata>;
+    fetchMessageReceipts: ({ remoteJid, id }: WAMessageKey) => Promise<proto.IUserReceipt[] | null | undefined>;
+    toJSON: () => {
+        chats: KeyedDB<Chat, string>;
+        contacts: {
+            [_: string]: Contact;
+        };
+        messages: {
+            [_: string]: {
+                array: proto.IWebMessageInfo[];
+                get: (id: string) => proto.IWebMessageInfo | undefined;
+                upsert: (item: proto.IWebMessageInfo, mode: "append" | "prepend") => void;
+                update: (item: proto.IWebMessageInfo) => boolean;
+                remove: (item: proto.IWebMessageInfo) => boolean;
+                updateAssign: (id: string, update: Partial<proto.IWebMessageInfo>) => boolean;
+                clear: () => void;
+                filter: (contain: (item: proto.IWebMessageInfo) => boolean) => void;
+                toJSON: () => proto.IWebMessageInfo[];
+                fromJSON: (newItems: proto.IWebMessageInfo[]) => void;
+            };
+        };
+        labels: ObjectRepository<Label>;
+        labelAssociations: KeyedDB<LabelAssociation, string>;
+    };
+    fromJSON: (json: {
+        chats: Chat[];
+        contacts: {
+            [id: string]: Contact;
+        };
+        messages: {
+            [id: string]: proto.IWebMessageInfo[];
+        };
+        labels: {
+            [labelId: string]: Label;
+        };
+        labelAssociations: LabelAssociation[];
+    }) => void;
+    writeToFile: (path: string) => void;
+    readFromFile: (path: string) => void;
+};
+export default _default;

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

@@ -56,6 +56,14 @@ exports.default = (config) => {
             labels.upsertById(label.id, label);
         }
     };
+    const getValidContacts = () => {
+        for (const contact of Object.keys(contacts)) {
+            if (contact.indexOf('@') < 0) {
+                delete contacts[contact];
+            }
+        }
+        return Object.keys(contacts);
+    };
     /**
      * binds to a BaileysEventEmitter.
      * It listens to all events and constructs a state that you can query accurate data from.
@@ -104,10 +112,11 @@ exports.default = (config) => {
                     contact = contacts[update.id];
                 }
                 else {
-                    const contactHashes = await Promise.all(Object.keys(contacts).map(async (contactId) => {
+                    const validContacts = getValidContacts();
+                    const contactHashes = validContacts.map((contactId) => {
                         const { user } = (0, WABinary_1.jidDecode)(contactId);
-                        return [contactId, (await (0, Utils_1.md5)(Buffer.from(user + 'WA_ADD_NOTIF', 'utf8'))).toString('base64').slice(0, 3)];
-                    }));
+                        return [contactId, ((0, Utils_1.md5)(Buffer.from(user + 'WA_ADD_NOTIF', 'utf8'))).toString('base64').slice(0, 3)];
+                    });
                     contact = contacts[((_a = contactHashes.find(([, b]) => b === update.id)) === null || _a === void 0 ? void 0 : _a[0]) || '']; // find contact by attrs.hash, when user is not saved as a contact
                 }
                 if (contact) {
@@ -117,11 +126,11 @@ exports.default = (config) => {
                     else if (update.imgUrl === 'removed') {
                         delete contact.imgUrl;
                     }
+                    Object.assign(contacts[contact.id], contact);
                 }
                 else {
-                    return logger.debug({ update }, 'got update for non-existant contact');
+                    logger.debug({ update }, 'got update for non-existant contact');
                 }
-                Object.assign(contacts[contact.id], contact);
             }
         });
         ev.on('chats.upsert', newChats => {
@@ -182,14 +191,16 @@ exports.default = (config) => {
                         const jid = (0, WABinary_1.jidNormalizedUser)(msg.key.remoteJid);
                         const list = assertMessageList(jid);
                         list.upsert(msg, 'append');
-                        if (type === 'notify' && !chats.get(jid)) {
-                            ev.emit('chats.upsert', [
-                                {
-                                    id: jid,
-                                    conversationTimestamp: (0, Utils_1.toNumber)(msg.messageTimestamp),
-                                    unreadCount: 1
-                                }
-                            ]);
+                        if (type === 'notify') {
+                            if (!chats.get(jid)) {
+                                ev.emit('chats.upsert', [
+                                    {
+                                        id: jid,
+                                        conversationTimestamp: (0, Utils_1.toNumber)(msg.messageTimestamp),
+                                        unreadCount: 1
+                                    }
+                                ]);
+                            }
                         }
                     }
                     break;

package/lib/Store/make-ordered-dictionary.d.ts

@@ -0,0 +1,13 @@
+declare function makeOrderedDictionary<T>(idGetter: (item: T) => string): {
+    array: T[];
+    get: (id: string) => T | undefined;
+    upsert: (item: T, mode: "append" | "prepend") => void;
+    update: (item: T) => boolean;
+    remove: (item: T) => boolean;
+    updateAssign: (id: string, update: Partial<T>) => boolean;
+    clear: () => void;
+    filter: (contain: (item: T) => boolean) => void;
+    toJSON: () => T[];
+    fromJSON: (newItems: T[]) => void;
+};
+export default makeOrderedDictionary;

package/lib/Store/object-repository.d.ts

@@ -0,0 +1,10 @@
+export declare class ObjectRepository<T extends object> {
+    readonly entityMap: Map<string, T>;
+    constructor(entities?: Record<string, T>);
+    findById(id: string): T | undefined;
+    findAll(): T[];
+    upsertById(id: string, entity: T): Map<string, T>;
+    deleteById(id: string): boolean;
+    count(): number;
+    toJSON(): T[];
+}

package/lib/Types/Auth.d.ts

@@ -0,0 +1,109 @@
+import type { proto } from '../../WAProto';
+import { RegistrationOptions } from '../Socket/registration';
+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;
+    deviceId: string;
+    phoneId: string;
+    identityId: Buffer;
+    registered: boolean;
+    backupToken: Buffer;
+    registration: RegistrationOptions;
+    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/Call.d.ts

@@ -0,0 +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;
+};

package/lib/Types/Chat.d.ts

@@ -0,0 +1,107 @@
+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;
+};

package/lib/Types/Contact.d.ts

@@ -0,0 +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 | 'changed';
+    status?: string;
+}

package/lib/Types/Events.d.ts

@@ -0,0 +1,172 @@
+import type { Boom } from '@hapi/boom';
+import { proto } from '../../WAProto';
+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 { Label } from './Label';
+import { LabelAssociation } from './LabelAssociation';
+import { MessageUpsertType, MessageUserReceiptUpdate, WAMessage, WAMessageKey, WAMessageUpdate } from './Message';
+import { ConnectionState } from './State';
+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;
+        peerDataRequestSessionId?: string | null;
+    };
+    /** upsert chats */
+    'chats.upsert': Chat[];
+    /** update the given chats */
+    'chats.update': ChatUpdate[];
+    'chats.phoneNumberShare': {
+        lid: string;
+        jid: 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;
+        participants: string[];
+        action: ParticipantAction;
+    };
+    'group.join-request': {
+        id: string;
+        author: string;
+        participant: 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';
+    };
+};
+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;
+}