gifted-baileys 1.5.5 → 1.5.7

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/{src → lib}/Store/make-in-memory-store.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -65,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.
@@ -75,7 +74,11 @@ exports.default = (config) => {
         ev.on('connection.update', update => {
             Object.assign(state, update);
         });
-        ev.on('messaging-history.set', ({ chats: newChats, contacts: newContacts, messages: newMessages, isLatest }) => {
+        ev.on('messaging-history.set', ({ chats: newChats, contacts: newContacts, messages: newMessages, isLatest, syncType }) => {
+            if (syncType === WAProto_1.proto.HistorySync.HistorySyncType.ON_DEMAND) {
+                return; // FOR NOW,
+                //TODO: HANDLE
+            }
             if (isLatest) {
                 chats.clear();
                 for (const id in messages) {
@@ -101,7 +104,7 @@ exports.default = (config) => {
         ev.on('contacts.upsert', contacts => {
             contactsUpsert(contacts);
         });
-        ev.on('contacts.update', (updates) => __awaiter(void 0, void 0, void 0, function* () {
+        ev.on('contacts.update', async (updates) => {
             var _a;
             for (const update of updates) {
                 let contact;
@@ -109,26 +112,27 @@ exports.default = (config) => {
                     contact = contacts[update.id];
                 }
                 else {
-                    const contactHashes = yield Promise.all(Object.keys(contacts).map((contactId) => __awaiter(void 0, void 0, void 0, function* () {
+                    const validContacts = getValidContacts();
+                    const contactHashes = validContacts.map((contactId) => {
                         const { user } = (0, WABinary_1.jidDecode)(contactId);
-                        return [contactId, (yield (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) {
                     if (update.imgUrl === 'changed') {
-                        contact.imgUrl = socket ? yield (socket === null || socket === void 0 ? void 0 : socket.profilePictureUrl(contact.id)) : undefined;
+                        contact.imgUrl = socket ? await (socket === null || socket === void 0 ? void 0 : socket.profilePictureUrl(contact.id)) : undefined;
                     }
                     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 => {
             chats.upsert(...newChats);
         });
@@ -136,7 +140,7 @@ exports.default = (config) => {
             for (let update of updates) {
                 const result = chats.update(update.id, chat => {
                     if (update.unreadCount > 0) {
-                        update = Object.assign({}, update);
+                        update = { ...update };
                         update.unreadCount = (chat.unreadCount || 0) + update.unreadCount;
                     }
                     Object.assign(chat, update);
@@ -315,7 +319,7 @@ exports.default = (config) => {
         labelAssociations,
         bind,
         /** loads messages from the store, if not found -- uses the legacy connection */
-        loadMessages: (jid, count, cursor) => __awaiter(void 0, void 0, void 0, function* () {
+        loadMessages: async (jid, count, cursor) => {
             const list = assertMessageList(jid);
             const mode = !cursor || 'before' in cursor ? 'before' : 'after';
             const cursorKey = !!cursor ? ('before' in cursor ? cursor.before : cursor.after) : undefined;
@@ -338,7 +342,7 @@ exports.default = (config) => {
                 messages = [];
             }
             return messages;
-        }),
+        },
         /**
          * Get all available labels for profile
          *
@@ -367,31 +371,31 @@ exports.default = (config) => {
                 .all();
             return associations.map(({ labelId }) => labelId);
         },
-        loadMessage: (jid, id) => __awaiter(void 0, void 0, void 0, function* () { var _a; return (_a = messages[jid]) === null || _a === void 0 ? void 0 : _a.get(id); }),
-        mostRecentMessage: (jid) => __awaiter(void 0, void 0, void 0, function* () {
+        loadMessage: async (jid, id) => { var _a; return (_a = messages[jid]) === null || _a === void 0 ? void 0 : _a.get(id); },
+        mostRecentMessage: async (jid) => {
             var _a;
             const message = (_a = messages[jid]) === null || _a === void 0 ? void 0 : _a.array.slice(-1)[0];
             return message;
-        }),
-        fetchImageUrl: (jid, sock) => __awaiter(void 0, void 0, void 0, function* () {
+        },
+        fetchImageUrl: async (jid, sock) => {
             const contact = contacts[jid];
             if (!contact) {
                 return sock === null || sock === void 0 ? void 0 : sock.profilePictureUrl(jid);
             }
             if (typeof contact.imgUrl === 'undefined') {
-                contact.imgUrl = yield (sock === null || sock === void 0 ? void 0 : sock.profilePictureUrl(jid));
+                contact.imgUrl = await (sock === null || sock === void 0 ? void 0 : sock.profilePictureUrl(jid));
             }
             return contact.imgUrl;
-        }),
-        fetchGroupMetadata: (jid, sock) => __awaiter(void 0, void 0, void 0, function* () {
+        },
+        fetchGroupMetadata: async (jid, sock) => {
             if (!groupMetadata[jid]) {
-                const metadata = yield (sock === null || sock === void 0 ? void 0 : sock.groupMetadata(jid));
+                const metadata = await (sock === null || sock === void 0 ? void 0 : sock.groupMetadata(jid));
                 if (metadata) {
                     groupMetadata[jid] = metadata;
                 }
             }
             return groupMetadata[jid];
-        }),
+        },
         // fetchBroadcastListInfo: async(jid: string, sock: WASocket | undefined) => {
         // 	if(!groupMetadata[jid]) {
         // 		const metadata = await sock?.getBroadcastListInfo(jid)
@@ -401,11 +405,11 @@ exports.default = (config) => {
         // 	}
         // 	return groupMetadata[jid]
         // },
-        fetchMessageReceipts: (_a) => __awaiter(void 0, [_a], void 0, function* ({ remoteJid, id }) {
+        fetchMessageReceipts: async ({ remoteJid, id }) => {
             const list = messages[remoteJid];
             const msg = list === null || list === void 0 ? void 0 : list.get(id);
             return msg === null || msg === void 0 ? void 0 : msg.userReceipt;
-        }),
+        },
         toJSON,
         fromJSON,
         writeToFile: (path) => {

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/{src → lib}/Store/object-repository.js

@@ -12,7 +12,7 @@ class ObjectRepository {
         return Array.from(this.entityMap.values());
     }
     upsertById(id, entity) {
-        return this.entityMap.set(id, Object.assign({}, entity));
+        return this.entityMap.set(id, { ...entity });
     }
     deleteById(id) {
         return this.entityMap.delete(id);

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/{src/Types/Contact.ts → lib/Types/Contact.d.ts}

@@ -1,13 +1,12 @@
 export interface Contact {
-    id: string
-    lid?: string
+    id: string;
+    lid?: string;
     /** name of the contact, you have saved on your WA */
-    name?: string
+    name?: string;
     /** name of the contact, the contact has set on their own on WA */
-    notify?: string
+    notify?: string;
     /** I have no idea */
-    verifiedName?: string
-    // Baileys Added
+    verifiedName?: string;
     /**
      * Url of the profile picture of the contact
      *
@@ -15,6 +14,6 @@ export interface Contact {
      * 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
-}
+    imgUrl?: string | null | 'changed';
+    status?: string;
+}