@neelegirl/baileys 1.5.3 → 1.5.4

package/lib/Store/make-cache-manager-store.js

@@ -1,90 +0,0 @@
-"use strict"
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod }
-}
-
-Object.defineProperty(exports, "__esModule", { value: true })
-
-const cache_manager_1 = require("cache-manager")
-const WAProto_1 = require("../../WAProto")
-const Utils_1 = require("../Utils")
-const logger_1 = __importDefault(require("../Utils/logger"))
-
-const makeCacheManagerAuthState = async (store, sessionKey) => {
-    const defaultKey = (file) => `${sessionKey}:${file}`
-    const databaseConn = await cache_manager_1.caching(store)
-    const writeData = async (file, data) => {
-        let ttl = undefined
-        if (file === 'creds') {
-            ttl = 63115200 // 2 years
-        }
-        await databaseConn.set(defaultKey(file), JSON.stringify(data, Utils_1.BufferJSON.replacer), ttl)
-    }
-    const readData = async (file) => {
-        try {
-            const data = await databaseConn.get(defaultKey(file))
-            if (data) {
-                return JSON.parse(data, Utils_1.BufferJSON.reviver)
-            }
-            return null
-        }
-        catch (error) {
-            logger_1.default.error(error)
-            return null
-        }
-    }
-    const removeData = async (file) => {
-        try {
-            return await databaseConn.del(defaultKey(file))
-        }
-        catch (_a) {
-            logger_1.default.error(`Error removing ${file} from session ${sessionKey}`)
-        }
-    }
-    const clearState = async () => {
-        try {
-            const result = await databaseConn.store.keys(`${sessionKey}*`)
-            await Promise.all(result.map(async (key) => await databaseConn.del(key)))
-        }
-        catch (err) {
-        }
-    }
-    const creds = (await readData('creds')) || (0, Utils_1.initAuthCreds)()
-    return {
-        clearState,
-        saveCreds: () => writeData('creds', creds),
-        state: {
-            creds,
-            keys: {
-                get: async (type, ids) => {
-                    const data = {}
-                    await Promise.all(ids.map(async (id) => {
-                        let value = await readData(`${type}-${id}`)
-                        if (type === 'app-state-sync-key' && value) {
-                            value = WAProto_1.proto.Message.AppStateSyncKeyData.fromObject(value)
-                        }
-                        data[id] = value
-                    }))
-                    return data
-                },
-                set: async (data) => {
-                    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    const tasks = []
-                    for (const category in data) {
-                        for (const id in data[category]) {
-                            const value = data[category][id]
-                            const key = `${category}-${id}`
-                            tasks.push(value ? writeData(key, value) : removeData(key))
-                        }
-                    }
-                    await Promise.all(tasks)
-                },
-            }
-        }
-    }
-}
-
-module.exports = {
-  makeCacheManagerAuthState
-}

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

@@ -1,123 +0,0 @@
-import type KeyedDB from '@adiwajshing/keyed-db'
-import type { Comparable } from '@adiwajshing/keyed-db/lib/Types'
-import type { Logger } from 'pino'
-import { proto } from '@neelegirl/baileys/WAProto'
-import type makeMDSocket from '@neelegirl/baileys/lib/Socket'
-import type { BaileysEventEmitter, Chat, ConnectionState, Contact, GroupMetadata, PresenceData, WAMessage, WAMessageCursor, WAMessageKey } from '@neelegirl/baileys/lib/Types'
-import { Label } from '@neelegirl/baileys/lib/Types/Label'
-import { LabelAssociation } from '@neelegirl/baileys/lib/Types/LabelAssociation'
-import { ObjectRepository } from '@neelegirl/baileys/lib/Store/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
-}
-
-export declare const makeInMemoryStore: (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, baron: WASocket | undefined) => Promise<string | null | undefined>
-    fetchGroupMetadata: (jid: string, baron: 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
-}

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

@@ -1,429 +0,0 @@
-"use strict"
-
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod }
-}
-
-Object.defineProperty(exports, "__esModule", { value: true })
-
-const WAProto_1 = require("../../WAProto")
-const Defaults_1 = require("../Defaults")
-const LabelAssociation_1 = require("../Types/LabelAssociation")
-const Utils_1 = require("../Utils")
-const WABinary_1 = require("../WABinary")
-const Store_1 = require("./make-ordered-dictionary")
-const object_repository_1 = require("./object-repository")
-
-const waChatKey = (pin) => ({
-    key: (c) => (pin ? (c.pinned ? '1' : '0') : '') + (c.archived ? '0' : '1') + (c.conversationTimestamp ? c.conversationTimestamp.toString(16).padStart(8, '0') : '') + c.id,
-    compare: (k1, k2) => k2.localeCompare(k1)
-})
-
-const waMessageID = (m) => m.key.id || ''
-
-const waLabelAssociationKey = {
-    key: (la) => (la.type === LabelAssociation_1.LabelAssociationType.Chat ? la.chatId + la.labelId : la.chatId + la.messageId + la.labelId),
-    compare: (k1, k2) => k2.localeCompare(k1)
-}
-
-const makeMessagesDictionary = () => Store_1.makeOrderedDictionary(waMessageID)
-
-const makeInMemoryStore = (config) => {
-    const socket = config.socket
-    const chatKey = config.chatKey || waChatKey(true)
-    const labelAssociationKey = config.labelAssociationKey || waLabelAssociationKey
-    const logger = config.logger || Defaults_1.DEFAULT_CONNECTION_CONFIG.logger.child({ stream: 'in-mem-store' })
-    const KeyedDB = require('@adiwajshing/keyed-db').default
-    const chats = new KeyedDB(chatKey, c => c.id)
-    const messages = {}
-    const contacts = {}
-    const groupMetadata = {}
-    const presences = {}
-    const state = { connection: 'close' }
-    const labels = new object_repository_1.ObjectRepository()
-    const labelAssociations = new KeyedDB(labelAssociationKey, labelAssociationKey.key)
-    const assertMessageList = (jid) => {
-        if (!messages[jid]) {
-            messages[jid] = makeMessagesDictionary()
-        }
-        return messages[jid]
-    }
-    const contactsUpsert = (newContacts) => {
-        const oldContacts = new Set(Object.keys(contacts))
-        for (const contact of newContacts) {
-            oldContacts.delete(contact.id)
-            contacts[contact.id] = Object.assign(contacts[contact.id] || {}, contact)
-        }
-        return oldContacts
-    }
-    const labelsUpsert = (newLabels) => {
-        for (const label of newLabels) {
-            labels.upsertById(label.id, label)
-        }
-    }
-    /**
-     * binds to a BaileysEventEmitter.
-     * It listens to all events and constructs a state that you can query accurate data from.
-     * Eg. can use the store to fetch chats, contacts, messages etc.
-     * @param ev typically the event emitter from the socket connection
-     */
-    const bind = (ev) => {
-        ev.on('connection.update', update => {
-            Object.assign(state, update)
-        })
-        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) {
-                    delete messages[id]
-                }
-            }
-            const chatsAdded = chats.insertIfAbsent(...newChats).length
-            logger.debug({ chatsAdded }, 'synced chats')
-            const oldContacts = contactsUpsert(newContacts)
-            if (isLatest) {
-                for (const jid of oldContacts) {
-                    delete contacts[jid]
-                }
-            }
-            logger.debug({ deletedContacts: isLatest ? oldContacts.size : 0, newContacts }, 'synced contacts')
-            for (const msg of newMessages) {
-                const jid = msg.key.remoteJid
-                const list = assertMessageList(jid)
-                list.upsert(msg, 'prepend')
-            }
-            logger.debug({ messages: newMessages.length }, 'synced messages')
-        })
-        ev.on('contacts.upsert', contacts => {
-            contactsUpsert(contacts)
-        })
-        ev.on('contacts.update', async (updates) => {
-            for (const update of updates) {
-                let contact
-                if (contacts[update.id]) {
-                    contact = contacts[update.id]
-                }
-                else {
-                    const contactHashes = await Promise.all(Object.keys(contacts).map(async (contactId) => {
-                        const { user } = WABinary_1.jidDecode(contactId)
-                        return [contactId, (await Utils_1.md5(Buffer.from(user + 'WA_ADD_NOTIF', 'utf8'))).toString('base64').slice(0, 3)]
-                    }))
-                    contact = contacts[contactHashes.find(([, b]) => b === update.id?.[0]) || ''] // find contact by attrs.hash, when user is not saved as a contact
-                }
-                if (contact) {
-                    if (update.imgUrl === 'changed') {
-                        contact.imgUrl = socket ? await socket.profilePictureUrl(contact.id) : undefined
-                    }
-                    else if (update.imgUrl === 'removed') {
-                        delete contact.imgUrl
-                    }
-                }
-                else {
-                    return logger.debug({ update }, 'got update for non-existant contact')
-                }
-                Object.assign(contacts[contact.id], contact)
-            }
-        })
-        ev.on('chats.upsert', newChats => {
-            chats.upsert(...newChats)
-        })
-        ev.on('chats.update', updates => {
-            for (let update of updates) {
-                const result = chats.update(update.id, chat => {
-                    if (update.unreadCount > 0) {
-                        update = { ...update }
-                        update.unreadCount = (chat.unreadCount || 0) + update.unreadCount
-                    }
-                    Object.assign(chat, update)
-                })
-                if (!result) {
-                    logger.debug({ update }, 'got update for non-existant chat')
-                }
-            }
-        })
-        ev.on('labels.edit', (label) => {
-            if (label.deleted) {
-                return labels.deleteById(label.id)
-            }
-            // WhatsApp can store only up to 20 labels
-            if (labels.count() < 20) {
-                return labels.upsertById(label.id, label)
-            }
-            logger.error('Labels count exceed')
-        })
-        ev.on('labels.association', ({ type, association }) => {
-            switch (type) {
-                case 'add':
-                    labelAssociations.upsert(association)
-                    break
-                case 'remove':
-                    labelAssociations.delete(association)
-                    break
-                default:
-                    console.error(`unknown operation type [${type}]`)
-            }
-        })
-        ev.on('presence.update', ({ id, presences: update }) => {
-            presences[id] = presences[id] || {}
-            Object.assign(presences[id], update)
-        })
-        ev.on('chats.delete', deletions => {
-            for (const item of deletions) {
-                if (chats.get(item)) {
-                    chats.deleteById(item)
-                }
-            }
-        })
-        ev.on('messages.upsert', ({ messages: newMessages, type }) => {
-            switch (type) {
-                case 'append':
-                case 'notify':
-                    for (const msg of newMessages) {
-                        const jid = 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: Utils_1.toNumber(msg.messageTimestamp),
-                                    unreadCount: 1
-                                }
-                            ])
-                        }
-                    }
-                    break
-            }
-        })
-        ev.on('messages.update', updates => {
-            for (const { update, key } of updates) {
-                const list = assertMessageList(WABinary_1.jidNormalizedUser(key.remoteJid))
-                if (update?.status) {
-                    const listStatus = list.get(key.id)?.status
-                    if (listStatus && update?.status <= listStatus) {
-                        logger.debug({ update, storedStatus: listStatus }, 'status stored newer then update')
-                        delete update.status
-                        logger.debug({ update }, 'new update object')
-                    }
-                }
-                const result = list.updateAssign(key.id, update)
-                if (!result) {
-                    logger.debug({ update }, 'got update for non-existent message')
-                }
-            }
-        })
-        ev.on('messages.delete', item => {
-            if ('all' in item) {
-                const list = messages[item.jid]
-                list?.clear()
-            }
-            else {
-                const jid = item.keys[0].remoteJid
-                const list = messages[jid]
-                if (list) {
-                    const idSet = new Set(item.keys.map(k => k.id))
-                    list.filter(m => !idSet.has(m.key.id))
-                }
-            }
-        })
-        ev.on('groups.update', updates => {
-            for (const update of updates) {
-                const id = update.id
-                if (groupMetadata[id]) {
-                    Object.assign(groupMetadata[id], update)
-                }
-                else {
-                    logger.debug({ update }, 'got update for non-existant group metadata')
-                }
-            }
-        })
-        ev.on('group-participants.update', ({ id, participants, action }) => {
-            const metadata = groupMetadata[id]
-            if (metadata) {
-                switch (action) {
-                    case 'add':
-                        metadata.participants.push(...participants.map(id => ({ id, isAdmin: false, isSuperAdmin: false })))
-                        break
-                    case 'demote':
-                    case 'promote':
-                        for (const participant of metadata.participants) {
-                            if (participants.includes(participant.id)) {
-                                participant.isAdmin = action === 'promote'
-                            }
-                        }
-                        break
-                    case 'remove':
-                        metadata.participants = metadata.participants.filter(p => !participants.includes(p.id))
-                        break
-                }
-            }
-        })
-        ev.on('message-receipt.update', updates => {
-            for (const { key, receipt } of updates) {
-                const obj = messages[key.remoteJid]
-                const msg = obj?.get(key.id)
-                if (msg) {
-                    Utils_1.updateMessageWithReceipt(msg, receipt)
-                }
-            }
-        })
-        ev.on('messages.reaction', (reactions) => {
-            for (const { key, reaction } of reactions) {
-                const obj = messages[key.remoteJid]
-                const msg = obj?.get(key.id)
-                if (msg) {
-                    Utils_1.updateMessageWithReaction(msg, reaction)
-                }
-            }
-        })
-    }
-    const toJSON = () => ({
-        chats,
-        contacts,
-        messages,
-        labels,
-        labelAssociations
-    })
-    const fromJSON = (json) => {
-        chats.upsert(...json.chats)
-        labelAssociations.upsert(...json.labelAssociations || [])
-        contactsUpsert(Object.values(json.contacts))
-        labelsUpsert(Object.values(json.labels || {}))
-        for (const jid in json.messages) {
-            const list = assertMessageList(jid)
-            for (const msg of json.messages[jid]) {
-                list.upsert(WAProto_1.proto.WebMessageInfo.fromObject(msg), 'append')
-            }
-        }
-    }
-    return {
-        chats,
-        contacts,
-        messages,
-        groupMetadata,
-        state,
-        presences,
-        labels,
-        labelAssociations,
-        bind,
-        /** loads messages from the store, if not found -- uses the legacy connection */
-        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
-            const cursorValue = cursorKey ? list.get(cursorKey.id) : undefined
-            let messages
-            if (list && mode === 'before' && (!cursorKey || cursorValue)) {
-                if (cursorValue) {
-                    const msgIdx = list.array.findIndex(m => m.key.id === cursorKey?.id)
-                    messages = list.array.slice(0, msgIdx)
-                }
-                else {
-                    messages = list.array
-                }
-                const diff = count - messages.length
-                if (diff < 0) {
-                    messages = messages.slice(-count) // get the last X messages
-                }
-            }
-            else {
-                messages = []
-            }
-            return messages
-        },
-        /**
-         * 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: () => {
-            return labels
-        },
-        /**
-         * Get labels for chat
-         *
-         * @returns Label IDs
-         **/
-        getChatLabels: (chatId) => {
-            return labelAssociations.filter((la) => la.chatId === chatId).all()
-        },
-        /**
-         * Get labels for message
-         *
-         * @returns Label IDs
-         **/
-        getMessageLabels: (messageId) => {
-            const associations = labelAssociations
-                .filter((la) => la.messageId === messageId)
-                .all()
-            return associations.map(({ labelId }) => labelId)
-        },
-        loadMessage: async (jid, id) => messages[jid]?.get(id), 
-        mostRecentMessage: async (jid) => {
-            const message = messages[jid]?.array.slice(-1)[0]
-            return message
-        },
-        fetchImageUrl: async (jid, baron) => {
-            const contact = contacts[jid]
-            if (!contact) {
-                return baron?.profilePictureUrl(jid)
-            }
-            if (typeof contact.imgUrl === 'undefined') {
-                contact.imgUrl = await baron?.profilePictureUrl(jid)
-            }
-            return contact.imgUrl
-        },
-        fetchGroupMetadata: async (jid, baron) => {
-            if (!groupMetadata[jid]) {
-                const metadata = await baron?.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)
-        // 		if(metadata) {
-        // 			groupMetadata[jid] = metadata
-        // 		}
-        // 	}
-        // 	return groupMetadata[jid]
-        // },
-        fetchMessageReceipts: async ({ remoteJid, id }) => {
-            const list = messages[remoteJid]
-            const msg = list?.get(id)
-            return msg?.userReceipt
-        },
-        toJSON,
-        fromJSON,
-        writeToFile: (path) => {
-            // require fs here so that in case "fs" is not available -- the app does not crash
-            const { writeFileSync } = require('fs')
-            writeFileSync(path, JSON.stringify(toJSON()))
-        },
-        readFromFile: (path) => {
-            // require fs here so that in case "fs" is not available -- the app does not crash
-            const { readFileSync, existsSync } = require('fs')
-            if (existsSync(path)) {
-                logger.debug({ path }, 'reading from file')
-                const jsonStr = readFileSync(path, { encoding: 'utf-8' })
-                const json = JSON.parse(jsonStr)
-                fromJSON(json)
-            }
-        }
-    }
-}
-
-module.exports = {
-  waChatKey, 
-  waMessageID, 
-  waLabelAssociationKey, 
-  makeInMemoryStore
-}

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

@@ -1,12 +0,0 @@
-export 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
-}