@neelegirl/baileys 1.5.5 → 1.5.7

package/lib/Utils/auth-utils.js

@@ -0,0 +1,205 @@
+"use strict"
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod }
+}
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const crypto_1 = require("crypto")
+const node_cache_1 = __importDefault(require("@cacheable/node-cache"))
+const Defaults_1 = require("../Defaults")
+const crypto_2 = require("./crypto")
+const generics_1 = require("./generics")
+
+/**
+ * Adds caching capability to a SignalKeyStore
+ * @param store the store to add caching to
+ * @param logger to log trace events
+ * @param _cache cache store to use
+ */
+function makeCacheableSignalKeyStore(store, logger, _cache) {
+    const cache = _cache || new node_cache_1.default({
+        stdTTL: Defaults_1.DEFAULT_CACHE_TTLS.SIGNAL_STORE,
+        useClones: false,
+        deleteOnExpire: true,
+    })
+    function getUniqueId(type, id) {
+        return `${type}.${id}`
+    }
+    return {
+        async get(type, ids) {
+            const data = {}
+            const idsToFetch = []
+            for (const id of ids) {
+                const item = cache.get(getUniqueId(type, id))
+                if (typeof item !== 'undefined') {
+                    data[id] = item
+                }
+                else {
+                    idsToFetch.push(id)
+                }
+            }
+            if (idsToFetch.length) {
+                logger?.trace({ items: idsToFetch.length }, 'loading from store')
+                const fetched = await store.get(type, idsToFetch)
+                for (const id of idsToFetch) {
+                    const item = fetched[id]
+                    if (item) {
+                        data[id] = item
+                        cache.set(getUniqueId(type, id), item)
+                    }
+                }
+            }
+            return data
+        },
+        async set(data) {
+            let keys = 0
+            for (const type in data) {
+                for (const id in data[type]) {
+                    cache.set(getUniqueId(type, id), data[type][id])
+                    keys += 1
+                }
+            }
+            logger?.trace({ keys }, 'updated cache')
+            await store.set(data)
+        },
+        async clear() {
+            cache.flushAll()
+            await store.clear?.call(store)
+        }
+    }
+}
+
+/**
+ * Adds DB like transaction capability (https://en.wikipedia.org/wiki/Database_transaction) to the SignalKeyStore,
+ * this allows batch read & write operations & improves the performance of the lib
+ * @param state the key store to apply this capability to
+ * @param logger logger to log events
+ * @returns SignalKeyStore with transaction capability
+ */
+const addTransactionCapability = (state, logger, { maxCommitRetries, delayBetweenTriesMs }) => {
+    // number of queries made to the DB during the transaction
+    // only there for logging purposes
+    let dbQueriesInTransaction = 0
+    let transactionCache = {}
+    let mutations = {}
+    let transactionsInProgress = 0
+    return {
+        get: async (type, ids) => {
+            if (isInTransaction()) {
+                const dict = transactionCache[type]
+                const idsRequiringFetch = dict
+                    ? ids.filter(item => typeof dict[item] === 'undefined')
+                    : ids
+                // only fetch if there are any items to fetch
+                if (idsRequiringFetch.length) {
+                    dbQueriesInTransaction += 1
+                    const result = await state.get(type, idsRequiringFetch)
+                    transactionCache[type] || (transactionCache[type] = {})
+                    Object.assign(transactionCache[type], result)
+                }
+                return ids.reduce((dict, id) => {
+                    const value = transactionCache[type]?.[id]
+                    if (value) {
+                        dict[id] = value
+                    }
+                    return dict
+                }, {})
+            }
+            else {
+                return state.get(type, ids)
+            }
+        },
+        set: data => {
+            if (isInTransaction()) {
+                logger.trace({ types: Object.keys(data) }, 'caching in transaction')
+                for (const key in data) {
+                    transactionCache[key] = transactionCache[key] || {}
+                    Object.assign(transactionCache[key], data[key])
+                    mutations[key] = mutations[key] || {}
+                    Object.assign(mutations[key], data[key])
+                }
+            }
+            else {
+                return state.set(data)
+            }
+        },
+        isInTransaction,
+        async transaction(work) {
+            let result
+            transactionsInProgress += 1
+            if (transactionsInProgress === 1) {
+                logger.trace('entering transaction')
+            }
+            try {
+                result = await work()
+                // commit if this is the outermost transaction
+                if (transactionsInProgress === 1) {
+                    if (Object.keys(mutations).length) {
+                        logger.trace('committing transaction')
+                        // retry mechanism to ensure we've some recovery
+                        // in case a transaction fails in the first attempt
+                        let tries = maxCommitRetries
+                        while (tries) {
+                            tries -= 1
+                            try {
+                                await state.set(mutations)
+                                logger.trace({ dbQueriesInTransaction }, 'committed transaction')
+                                break
+                            }
+                            catch (error) {
+                                logger.warn(`failed to commit ${Object.keys(mutations).length} mutations, tries left=${tries}`)
+                                await generics_1.delay(delayBetweenTriesMs)
+                            }
+                        }
+                    }
+                    else {
+                        logger.trace('no mutations in transaction')
+                    }
+                }
+            }
+            finally {
+                transactionsInProgress -= 1
+                if (transactionsInProgress === 0) {
+                    transactionCache = {}
+                    mutations = {}
+                    dbQueriesInTransaction = 0
+                }
+            }
+            return result
+        }
+    }
+    function isInTransaction() {
+        return transactionsInProgress > 0
+    }
+}
+
+const initAuthCreds = () => {
+    const identityKey = crypto_2.Curve.generateKeyPair()
+    return {
+        noiseKey: crypto_2.Curve.generateKeyPair(),
+        pairingEphemeralKeyPair: crypto_2.Curve.generateKeyPair(),
+        signedIdentityKey: identityKey,
+        signedPreKey: crypto_2.signedKeyPair(identityKey, 1),
+        registrationId: generics_1.generateRegistrationId(),
+        advSecretKey: crypto_1.randomBytes(32).toString('base64'),
+        processedHistoryMessages: [],
+        nextPreKeyId: 1,
+        firstUnuploadedPreKeyId: 1,
+        accountSyncCounter: 0,
+        accountSettings: {
+            unarchiveChats: false
+        },
+        registered: false,
+        pairingCode: undefined,
+        lastPropHash: undefined,
+        routingInfo: undefined
+    }
+}
+
+module.exports = {
+  makeCacheableSignalKeyStore, 
+  addTransactionCapability, 
+  initAuthCreds
+}

package/lib/Utils/baileys-event-stream.d.ts

@@ -0,0 +1,18 @@
+import type { BaileysEventEmitter } from '../Types'
+
+/**
+ * Captures events from a baileys event emitter & stores them in a file
+ * @param ev The event emitter to read events from
+ * @param filename File to save to
+ */
+export declare const captureEventStream: (ev: BaileysEventEmitter, filename: string) => void
+
+/**
+ * Read event file and emit events from there
+ * @param filename filename containing event data
+ * @param delayIntervalMs delay between each event emit
+ */
+export declare const readAndEmitEventStream: (filename: string, delayIntervalMs?: number) => {
+    ev: BaileysEventEmitter
+    task: Promise<void>
+}

package/lib/Utils/baileys-event-stream.js

@@ -0,0 +1,70 @@
+"use strict"
+
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod }
+}
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const events_1 = __importDefault(require("events"))
+const fs_1 = require("fs")
+const promises_1 = require("fs/promises")
+const readline_1 = require("readline")
+const generics_1 = require("./generics")
+const make_mutex_1 = require("./make-mutex")
+
+/**
+ * Captures events from a baileys event emitter & stores them in a file
+ * @param ev The event emitter to read events from
+ * @param filename File to save to
+ */
+const captureEventStream = (ev, filename) => {
+    const oldEmit = ev.emit
+    // write mutex so data is appended in order
+    const writeMutex = make_mutex_1.makeMutex()
+    // monkey patch eventemitter to capture all events
+    ev.emit = function (...args) {
+        const content = JSON.stringify({ timestamp: Date.now(), event: args[0], data: args[1] }) + '\n'
+        const result = oldEmit.apply(ev, args)
+        writeMutex.mutex(async () => {
+            await promises_1.writeFile(filename, content, { flag: 'a' })
+        })
+        return result
+    }
+}
+
+/**
+ * Read event file and emit events from there
+ * @param filename filename containing event data
+ * @param delayIntervalMs delay between each event emit
+ */
+const readAndEmitEventStream = (filename, delayIntervalMs = 0) => {
+    const ev = new events_1.default()
+    const fireEvents = async () => {
+        // from: https://stackoverflow.com/questions/6156501/read-a-file-one-line-at-a-time-in-node-js
+        const fileStream = fs_1.createReadStream(filename)
+        const rl = readline_1.createInterface({
+            input: fileStream,
+            crlfDelay: Infinity
+        })
+        // Note: we use the crlfDelay option to recognize all instances of CR LF
+        // ('\r\n') in input.txt as a single line break.
+        for await (const line of rl) {
+            if (line) {
+                const { event, data } = JSON.parse(line)
+                ev.emit(event, data)
+                delayIntervalMs && await generics_1.delay(delayIntervalMs)
+            }
+        }
+        fileStream.close()
+    }
+    return {
+        ev,
+        task: fireEvents()
+    }
+}
+
+module.exports = {
+  captureEventStream, 
+  readAndEmitEventStream
+}

package/lib/Utils/business.d.ts

@@ -0,0 +1,29 @@
+import { CatalogCollection, OrderDetails, Product, ProductCreate, ProductUpdate, WAMediaUpload, WAMediaUploadFunction } from '../Types'
+import { BinaryNode } from '../WABinary'
+
+export declare const parseCatalogNode: (node: BinaryNode) => {
+    products: Product[]
+    nextPageCursor: string | undefined
+}
+
+export declare const parseCollectionsNode: (node: BinaryNode) => {
+    collections: CatalogCollection[]
+}
+
+export declare const parseOrderDetailsNode: (node: BinaryNode) => OrderDetails
+
+export declare const toProductNode: (productId: string | undefined, product: ProductCreate | ProductUpdate) => BinaryNode
+
+export declare const parseProductNode: (productNode: BinaryNode) => Product
+
+/**
+ * Uploads images not already uploaded to WA's servers
+ */
+export declare function uploadingNecessaryImagesOfProduct<T extends ProductUpdate | ProductCreate>(product: T, waUploadToServer: WAMediaUploadFunction, timeoutMs?: number): Promise<T>
+
+/**
+ * Uploads images not already uploaded to WA's servers
+ */
+export declare const uploadingNecessaryImages: (images: WAMediaUpload[], waUploadToServer: WAMediaUploadFunction, timeoutMs?: number) => Promise<{
+    url: string
+}[]>

package/lib/Utils/business.js

@@ -0,0 +1,255 @@
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const boom_1 = require("@hapi/boom")
+const crypto_1 = require("crypto")
+const path_1 = require("path")
+const os_1 = require("os")
+const fs_1 = require("fs")
+const WABinary_1 = require("../WABinary")
+const generics_1 = require("./generics")
+const messages_media_1 = require("./messages-media")
+
+const parseCatalogNode = (node) => {
+    const catalogNode = WABinary_1.getBinaryNodeChild(node, 'product_catalog')
+    const products = WABinary_1.getBinaryNodeChildren(catalogNode, 'product').map(parseProductNode)
+    const paging = WABinary_1.getBinaryNodeChild(catalogNode, 'paging')
+    return {
+        products,
+        nextPageCursor: paging
+            ? WABinary_1.getBinaryNodeChildString(paging, 'after')
+            : undefined
+    }
+}
+
+const parseCollectionsNode = (node) => {
+    const collectionsNode = WABinary_1.getBinaryNodeChild(node, 'collections')
+    const collections = WABinary_1.getBinaryNodeChildren(collectionsNode, 'collection').map(collectionNode => {
+        const id = WABinary_1.getBinaryNodeChildString(collectionNode, 'id')
+        const name = WABinary_1.getBinaryNodeChildString(collectionNode, 'name')
+        const products = WABinary_1.getBinaryNodeChildren(collectionNode, 'product').map(parseProductNode)
+        return {
+            id,
+            name,
+            products,
+            status: parseStatusInfo(collectionNode)
+        }
+    })
+    return {
+        collections
+    }
+}
+
+const parseOrderDetailsNode = (node) => {
+    const orderNode = WABinary_1.getBinaryNodeChild(node, 'order')
+    const products = WABinary_1.getBinaryNodeChildren(orderNode, 'product').map(productNode => {
+        const imageNode = WABinary_1.getBinaryNodeChild(productNode, 'image')
+        return {
+            id: WABinary_1.getBinaryNodeChildString(productNode, 'id'),
+            name: WABinary_1.getBinaryNodeChildString(productNode, 'name'),
+            imageUrl: WABinary_1.getBinaryNodeChildString(imageNode, 'url'),
+            price: +WABinary_1.getBinaryNodeChildString(productNode, 'price'),
+            currency: WABinary_1.getBinaryNodeChildString(productNode, 'currency'),
+            quantity: +WABinary_1.getBinaryNodeChildString(productNode, 'quantity')
+        }
+    })
+    const priceNode = WABinary_1.getBinaryNodeChild(orderNode, 'price')
+    const orderDetails = {
+        price: {
+            total: +WABinary_1.getBinaryNodeChildString(priceNode, 'total'),
+            currency: WABinary_1.getBinaryNodeChildString(priceNode, 'currency'),
+        },
+        products
+    }
+    return orderDetails
+}
+
+const toProductNode = (productId, product) => {
+    const attrs = {}
+    const content = []
+    if (typeof productId !== 'undefined') {
+        content.push({
+            tag: 'id',
+            attrs: {},
+            content: Buffer.from(productId)
+        })
+    }
+    if (typeof product.name !== 'undefined') {
+        content.push({
+            tag: 'name',
+            attrs: {},
+            content: Buffer.from(product.name)
+        })
+    }
+    if (typeof product.description !== 'undefined') {
+        content.push({
+            tag: 'description',
+            attrs: {},
+            content: Buffer.from(product.description)
+        })
+    }
+    if (typeof product.retailerId !== 'undefined') {
+        content.push({
+            tag: 'retailer_id',
+            attrs: {},
+            content: Buffer.from(product.retailerId)
+        })
+    }
+    if (product.images.length) {
+        content.push({
+            tag: 'media',
+            attrs: {},
+            content: product.images.map(img => {
+                if (!('url' in img)) {
+                    throw new boom_1.Boom('Expected img for product to already be uploaded', { statusCode: 400 })
+                }
+                return {
+                    tag: 'image',
+                    attrs: {},
+                    content: [
+                        {
+                            tag: 'url',
+                            attrs: {},
+                            content: Buffer.from(img.url.toString())
+                        }
+                    ]
+                }
+            })
+        })
+    }
+    if (typeof product.price !== 'undefined') {
+        content.push({
+            tag: 'price',
+            attrs: {},
+            content: Buffer.from(product.price.toString())
+        })
+    }
+    if (typeof product.currency !== 'undefined') {
+        content.push({
+            tag: 'currency',
+            attrs: {},
+            content: Buffer.from(product.currency)
+        })
+    }
+    if ('originCountryCode' in product) {
+        if (typeof product.originCountryCode === 'undefined') {
+            attrs['compliance_category'] = 'COUNTRY_ORIGIN_EXEMPT'
+        }
+        else {
+            content.push({
+                tag: 'compliance_info',
+                attrs: {},
+                content: [
+                    {
+                        tag: 'country_code_origin',
+                        attrs: {},
+                        content: Buffer.from(product.originCountryCode)
+                    }
+                ]
+            })
+        }
+    }
+    if (typeof product.isHidden !== 'undefined') {
+        attrs['is_hidden'] = product.isHidden.toString()
+    }
+    const node = {
+        tag: 'product',
+        attrs,
+        content
+    }
+    return node
+}
+
+const parseProductNode = (productNode) => {
+    const isHidden = productNode.attrs.is_hidden === 'true'
+    const id = WABinary_1.getBinaryNodeChildString(productNode, 'id')
+    const mediaNode = WABinary_1.getBinaryNodeChild(productNode, 'media')
+    const statusInfoNode = WABinary_1.getBinaryNodeChild(productNode, 'status_info')
+    const product = {
+        id,
+        imageUrls: parseImageUrls(mediaNode),
+        reviewStatus: {
+            whatsapp: WABinary_1.getBinaryNodeChildString(statusInfoNode, 'status'),
+        },
+        availability: 'in stock',
+        name: WABinary_1.getBinaryNodeChildString(productNode, 'name'),
+        retailerId: WABinary_1.getBinaryNodeChildString(productNode, 'retailer_id'),
+        url: WABinary_1.getBinaryNodeChildString(productNode, 'url'),
+        description: WABinary_1.getBinaryNodeChildString(productNode, 'description'),
+        price: +WABinary_1.getBinaryNodeChildString(productNode, 'price'),
+        currency: WABinary_1.getBinaryNodeChildString(productNode, 'currency'),
+        isHidden,
+    }
+    return product
+}
+
+/**
+ * Uploads images not already uploaded to WA's servers
+ */
+async function uploadingNecessaryImagesOfProduct(product, waUploadToServer, timeoutMs = 30000) {
+    product = {
+        ...product,
+        images: product.images ? await uploadingNecessaryImages(product.images, waUploadToServer, timeoutMs) : product.images
+    }
+    return product
+}
+
+/**
+ * Uploads images not already uploaded to WA's servers
+ */
+const uploadingNecessaryImages = async (images, waUploadToServer, timeoutMs = 30000) => {
+    const results = await Promise.all(images.map(async (img) => {
+        if ('url' in img) {
+            const url = img.url.toString()
+            if (url.includes('.whatsapp.net')) {
+                return { url }
+            }
+        }
+        const { stream } = await messages_media_1.getStream(img)
+        const hasher = crypto_1.createHash('sha256')
+        const filePath = path_1.join(os_1.tmpdir(), 'img' + generics_1.generateMessageID())
+        const encFileWriteStream = fs_1.createWriteStream(filePath)
+        for await (const block of stream) {
+            hasher.update(block)
+            encFileWriteStream.write(block)
+        }
+        const sha = hasher.digest('base64')
+        const { directPath } = await waUploadToServer(filePath, {
+            mediaType: 'product-catalog-image',
+            fileEncSha256B64: sha,
+            timeoutMs
+        })
+        await fs_1.promises
+            .unlink(filePath)
+            .catch(err => console.log('Error deleting temp file ', err))
+        return { url: messages_media_1.getUrlFromDirectPath(directPath) }
+    }))
+    return results
+}
+
+const parseImageUrls = (mediaNode) => {
+    const imgNode = WABinary_1.getBinaryNodeChild(mediaNode, 'image')
+    return {
+        requested: WABinary_1.getBinaryNodeChildString(imgNode, 'request_image_url'),
+        original: WABinary_1.getBinaryNodeChildString(imgNode, 'original_image_url')
+    }
+}
+
+const parseStatusInfo = (mediaNode) => {
+    const node = WABinary_1.getBinaryNodeChild(mediaNode, 'status_info')
+    return {
+        status: WABinary_1.getBinaryNodeChildString(node, 'status'),
+        canAppeal: WABinary_1.getBinaryNodeChildString(node, 'can_appeal') === 'true',
+    }
+}
+
+module.exports = {
+  parseCatalogNode, 
+  parseCollectionsNode, 
+  parseOrderDetailsNode, 
+  toProductNode, 
+  parseProductNode, 
+  uploadingNecessaryImagesOfProduct, 
+  uploadingNecessaryImages
+}

package/lib/Utils/chat-utils.d.ts

@@ -0,0 +1,82 @@
+import { AxiosRequestConfig } from 'axios'
+import { proto } from '../../WAProto'
+import { BaileysEventEmitter, ChatModification, ChatMutation, Contact, InitialAppStateSyncOptions, LTHashState, WAPatchCreate, WAPatchName } from '../Types'
+import { BinaryNode } from '../WABinary'
+import { ILogger } from './logger'
+
+type FetchAppStateSyncKey = (keyId: string) => Promise<proto.Message.IAppStateSyncKeyData | null | undefined>
+
+export type ChatMutationMap = {
+    [index: string]: ChatMutation
+}
+
+export declare const newLTHashState: () => LTHashState
+
+export declare const encodeSyncdPatch: ({ type, index, syncAction, apiVersion, operation }: WAPatchCreate, myAppStateKeyId: string, state: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey) => Promise<{
+    patch: proto.ISyncdPatch
+    state: LTHashState
+}>
+
+export declare const decodeSyncdMutations: (msgMutations: (proto.ISyncdMutation | proto.ISyncdRecord)[], initialState: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, onMutation: (mutation: ChatMutation) => void, validateMacs: boolean) => Promise<{
+    hash: Buffer
+    indexValueMap: {
+        [indexMacBase64: string]: {
+            valueMac: Uint8Array | Buffer
+        }
+    }
+}>
+
+export declare const decodeSyncdPatch: (msg: proto.ISyncdPatch, name: WAPatchName, initialState: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, onMutation: (mutation: ChatMutation) => void, validateMacs: boolean) => Promise<{
+    hash: Buffer
+    indexValueMap: {
+        [indexMacBase64: string]: {
+            valueMac: Uint8Array | Buffer
+        }
+    }
+}>
+
+export declare const extractSyncdPatches: (result: BinaryNode, options: AxiosRequestConfig<{}>) => Promise<{
+    critical_block: {
+        patches: proto.ISyncdPatch[]
+        hasMorePatches: boolean
+        snapshot?: proto.ISyncdSnapshot | undefined
+    }
+    critical_unblock_low: {
+        patches: proto.ISyncdPatch[]
+        hasMorePatches: boolean
+        snapshot?: proto.ISyncdSnapshot | undefined
+    }
+    regular_high: {
+        patches: proto.ISyncdPatch[]
+        hasMorePatches: boolean
+        snapshot?: proto.ISyncdSnapshot | undefined
+    }
+    regular_low: {
+        patches: proto.ISyncdPatch[]
+        hasMorePatches: boolean
+        snapshot?: proto.ISyncdSnapshot | undefined
+    }
+    regular: {
+        patches: proto.ISyncdPatch[]
+        hasMorePatches: boolean
+        snapshot?: proto.ISyncdSnapshot | undefined
+    }
+}>
+
+export declare const downloadExternalBlob: (blob: proto.IExternalBlobReference, options: AxiosRequestConfig<{}>) => Promise<Buffer>
+export declare const downloadExternalPatch: (blob: proto.IExternalBlobReference, options: AxiosRequestConfig<{}>) => Promise<proto.SyncdMutations>
+export declare const decodeSyncdSnapshot: (name: WAPatchName, snapshot: proto.ISyncdSnapshot, getAppStateSyncKey: FetchAppStateSyncKey, minimumVersionNumber: number | undefined, validateMacs?: boolean) => Promise<{
+    state: LTHashState
+    mutationMap: ChatMutationMap
+}>
+
+export declare const decodePatches: (name: WAPatchName, syncds: proto.ISyncdPatch[], initial: LTHashState, getAppStateSyncKey: FetchAppStateSyncKey, options: AxiosRequestConfig<{}>, minimumVersionNumber?: number, logger?: ILogger, validateMacs?: boolean) => Promise<{
+    state: LTHashState
+    mutationMap: ChatMutationMap
+}>
+
+export declare const chatModificationToAppPatch: (mod: ChatModification, jid: string) => WAPatchCreate
+
+export declare const processSyncAction: (syncAction: ChatMutation, ev: BaileysEventEmitter, me: Contact, initialSyncOpts?: InitialAppStateSyncOptions, logger?: ILogger) => void
+
+export {}