@queenanya/baileys 7.5.11 → 8.0.0

package/lib/Types/Socket.d.ts

@@ -1,118 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { AxiosRequestConfig } from 'axios';
-import type { Agent } from 'https';
-import type { Logger } from 'pino';
-import type { URL } from 'url';
-import { proto } from '../../WAProto';
-import { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from './Auth';
-import { GroupMetadata } from './GroupMetadata';
-import { MediaConnInfo } from './Message';
-import { SignalRepository } from './Signal';
-export type WAVersion = [number, number, number];
-export type WABrowserDescription = [string, string, string];
-export type CacheStore = {
-    /** get a cached key and change the stats */
-    get<T>(key: string): T | undefined;
-    /** set a key in the cache */
-    set<T>(key: string, value: T): void;
-    /** delete a key from the cache */
-    del(key: string): void;
-    /** flush all data */
-    flushAll(): void;
-};
-export type SocketConfig = {
-    /** the WS url to connect to WA */
-    waWebSocketUrl: string | URL;
-    /** Fails the connection if the socket times out in this interval */
-    connectTimeoutMs: number;
-    /** Default timeout for queries, undefined for no timeout */
-    defaultQueryTimeoutMs: number | undefined;
-    /** ping-pong interval for WS connection */
-    keepAliveIntervalMs: number;
-    /** should baileys use the mobile api instead of the multi device api
-     * @deprecated This feature has been removed
-    */
-    mobile?: boolean;
-    /** proxy agent */
-    agent?: Agent;
-    /** pino logger */
-    logger: Logger;
-    /** version to connect with */
-    version: WAVersion;
-    /** override browser config */
-    browser: WABrowserDescription;
-    /** agent used for fetch requests -- uploading/downloading media */
-    fetchAgent?: Agent;
-    /** should the QR be printed in the terminal */
-    printQRInTerminal: boolean;
-    /** should events be emitted for actions done by this socket connection */
-    emitOwnEvents: boolean;
-    /** custom upload hosts to upload media to */
-    customUploadHosts: MediaConnInfo['hosts'];
-    /** time to wait between sending new retry requests */
-    retryRequestDelayMs: number;
-    /** max retry count */
-    maxMsgRetryCount: number;
-    /** time to wait for the generation of the next QR in ms */
-    qrTimeout?: number;
-    /** provide an auth state object to maintain the auth state */
-    auth: AuthenticationState;
-    /** manage history processing with this control; by default will sync up everything */
-    shouldSyncHistoryMessage: (msg: proto.Message.IHistorySyncNotification) => boolean;
-    /** transaction capability options for SignalKeyStore */
-    transactionOpts: TransactionCapabilityOptions;
-    /** marks the client as online whenever the socket successfully connects */
-    markOnlineOnConnect: boolean;
-    /** provide a cache to store media, so does not have to be re-uploaded */
-    mediaCache?: CacheStore;
-    /**
-     * map to store the retry counts for failed messages;
-     * used to determine whether to retry a message or not */
-    msgRetryCounterCache?: CacheStore;
-    /** provide a cache to store a user's device list */
-    userDevicesCache?: CacheStore;
-    /** cache to store call offers */
-    callOfferCache?: CacheStore;
-    /** cache to track placeholder resends */
-    placeholderResendCache?: CacheStore;
-    /** width for link preview images */
-    linkPreviewImageThumbnailWidth: number;
-    /** Should Baileys ask the phone for full history, will be received async */
-    syncFullHistory: boolean;
-    /** Ignore Message when offline, default is false */
-    ignoreMsgLoading: boolean;
-    /** Should baileys fire init queries automatically, default true */
-    fireInitQueries: boolean;
-    /**
-     * generate a high quality link preview,
-     * entails uploading the jpegThumbnail to WA
-     * */
-    generateHighQualityLinkPreview: boolean;
-    /**
-     * Returns if a jid should be ignored,
-     * no event for that jid will be triggered.
-     * Messages from that jid will also not be decrypted
-     * */
-    shouldIgnoreJid: (jid: string) => boolean | undefined;
-    /**
-     * Optionally patch the message before sending out
-     * */
-    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids: string[]) => Promise<proto.IMessage> | proto.IMessage;
-    /** verify app state MACs */
-    appStateMacVerification: {
-        patch: boolean;
-        snapshot: boolean;
-    };
-    /** options for axios */
-    options: AxiosRequestConfig<{}>;
-    /**
-     * fetch a message from your store
-     * implement this so that messages failed to send
-     * (solves the "this message can take a while" issue) can be retried
-     * */
-    getMessage: (key: proto.IMessageKey) => Promise<proto.IMessage | undefined>;
-    /** cached group metadata, use to prevent redundant requests to WA & speed up msg sending */
-    cachedGroupMetadata: (jid: string) => Promise<GroupMetadata | undefined>;
-    makeSignalRepository: (auth: SignalAuthState) => SignalRepository;
-};

package/lib/Types/Socket.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/State.d.ts

@@ -1,27 +0,0 @@
-import { Contact } from './Contact';
-export type WAConnectionState = 'open' | 'connecting' | 'close';
-export type ConnectionState = {
-    /** connection is now open, connecting or closed */
-    connection: WAConnectionState;
-    /** the error that caused the connection to close */
-    lastDisconnect?: {
-        error: Error | undefined;
-        date: Date;
-    };
-    /** is this a new login */
-    isNewLogin?: boolean;
-    /** the current QR code */
-    qr?: string;
-    /** has the device received all pending notifications while it was offline */
-    receivedPendingNotifications?: boolean;
-    /** legacy connection options */
-    legacy?: {
-        phoneConnected: boolean;
-        user?: Contact;
-    };
-    /**
-     * if the client is shown as an active, online client.
-     * If this is false, the primary phone and other devices will receive notifs
-     * */
-    isOnline?: boolean;
-};

package/lib/Types/State.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/index.d.ts

@@ -1,65 +0,0 @@
-export * from './Auth';
-export * from './GroupMetadata';
-export * from './Chat';
-export * from './Contact';
-export * from './State';
-export * from './Message';
-export * from './Newsletter';
-export * from './Socket';
-export * from './Events';
-export * from './Product';
-export * from './Call';
-export * from './Signal';
-import { AuthenticationState } from './Auth';
-import { SocketConfig } from './Socket';
-export type UserFacingSocketConfig = Partial<SocketConfig> & {
-    auth: AuthenticationState;
-};
-/** Other Browser Support for Paircode */
-export type BrowsersMap = {
-    ubuntu(browser: string): [string, string, string];
-    macOS(browser: string): [string, string, string];
-    baileys(browser: string): [string, string, string];
-    windows(browser: string): [string, string, string];
-    appropriate(browser: string): [string, string, string];
-};
-export declare enum DisconnectReason {
-    connectionClosed = 428,
-    connectionLost = 408,
-    connectionReplaced = 440,
-    timedOut = 408,
-    loggedOut = 401,
-    badSession = 500,
-    restartRequired = 515,
-    multideviceMismatch = 411,
-    forbidden = 403,
-    unavailableService = 503
-}
-export type WAInitResponse = {
-    ref: string;
-    ttl: number;
-    status: 200;
-};
-export type WABusinessHoursConfig = {
-    day_of_week: string;
-    mode: string;
-    open_time?: number;
-    close_time?: number;
-};
-export type WABusinessProfile = {
-    description: string;
-    email: string | undefined;
-    business_hours: {
-        timezone?: string;
-        config?: WABusinessHoursConfig[];
-        business_config?: WABusinessHoursConfig[];
-    };
-    website: string[];
-    category?: string;
-    wid?: string;
-    address?: string;
-};
-export type CurveKeyPair = {
-    private: Uint8Array;
-    public: Uint8Array;
-};

package/lib/Types/index.js

@@ -1,42 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DisconnectReason = void 0;
-__exportStar(require("./Auth"), exports);
-__exportStar(require("./GroupMetadata"), exports);
-__exportStar(require("./Chat"), exports);
-__exportStar(require("./Contact"), exports);
-__exportStar(require("./State"), exports);
-__exportStar(require("./Message"), exports);
-__exportStar(require("./Newsletter"), exports);
-__exportStar(require("./Socket"), exports);
-__exportStar(require("./Events"), exports);
-__exportStar(require("./Product"), exports);
-__exportStar(require("./Call"), exports);
-__exportStar(require("./Signal"), exports);
-var DisconnectReason;
-(function (DisconnectReason) {
-    DisconnectReason[DisconnectReason["connectionClosed"] = 428] = "connectionClosed";
-    DisconnectReason[DisconnectReason["connectionLost"] = 408] = "connectionLost";
-    DisconnectReason[DisconnectReason["connectionReplaced"] = 440] = "connectionReplaced";
-    DisconnectReason[DisconnectReason["timedOut"] = 408] = "timedOut";
-    DisconnectReason[DisconnectReason["loggedOut"] = 401] = "loggedOut";
-    DisconnectReason[DisconnectReason["badSession"] = 500] = "badSession";
-    DisconnectReason[DisconnectReason["restartRequired"] = 515] = "restartRequired";
-    DisconnectReason[DisconnectReason["multideviceMismatch"] = 411] = "multideviceMismatch";
-    DisconnectReason[DisconnectReason["forbidden"] = 403] = "forbidden";
-    DisconnectReason[DisconnectReason["unavailableService"] = 503] = "unavailableService";
-})(DisconnectReason = exports.DisconnectReason || (exports.DisconnectReason = {}));

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

@@ -1,18 +0,0 @@
-import type { Logger } from 'pino';
-import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '../Types';
-/**
- * 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
- */
-export declare function makeCacheableSignalKeyStore(store: SignalKeyStore, logger: Logger, _cache?: CacheStore): SignalKeyStore;
-/**
- * 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
- */
-export declare const addTransactionCapability: (state: SignalKeyStore, logger: Logger, { maxCommitRetries, delayBetweenTriesMs }: TransactionCapabilityOptions) => SignalKeyStoreWithTransaction;
-export declare const initAuthCreds: () => AuthenticationCreds;

package/lib/Utils/auth-utils.js

@@ -1,200 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.initAuthCreds = exports.addTransactionCapability = exports.makeCacheableSignalKeyStore = void 0;
-const crypto_1 = require("crypto");
-const node_cache_1 = __importDefault(require("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() {
-            var _a;
-            cache.flushAll();
-            await ((_a = store.clear) === null || _a === void 0 ? void 0 : _a.call(store));
-        }
-    };
-}
-exports.makeCacheableSignalKeyStore = makeCacheableSignalKeyStore;
-/**
- * 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) => {
-                    var _a;
-                    const value = (_a = transactionCache[type]) === null || _a === void 0 ? void 0 : _a[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;
-                            //eslint-disable-next-line max-depth
-                            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 (0, 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;
-    }
-};
-exports.addTransactionCapability = addTransactionCapability;
-const initAuthCreds = () => {
-    const identityKey = crypto_2.Curve.generateKeyPair();
-    return {
-        noiseKey: crypto_2.Curve.generateKeyPair(),
-        pairingEphemeralKeyPair: crypto_2.Curve.generateKeyPair(),
-        signedIdentityKey: identityKey,
-        signedPreKey: (0, crypto_2.signedKeyPair)(identityKey, 1),
-        registrationId: (0, generics_1.generateRegistrationId)(),
-        advSecretKey: (0, crypto_1.randomBytes)(32).toString('base64'),
-        processedHistoryMessages: [],
-        nextPreKeyId: 1,
-        firstUnuploadedPreKeyId: 1,
-        accountSyncCounter: 0,
-        accountSettings: {
-            unarchiveChats: false
-        },
-        registered: false,
-        pairingCode: undefined,
-        lastPropHash: undefined,
-        routingInfo: undefined,
-    };
-};
-exports.initAuthCreds = initAuthCreds;

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

@@ -1,16 +0,0 @@
-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

@@ -1,63 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.readAndEmitEventStream = exports.captureEventStream = void 0;
-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 = (0, 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 (0, promises_1.writeFile)(filename, content, { flag: 'a' });
-        });
-        return result;
-    };
-};
-exports.captureEventStream = captureEventStream;
-/**
- * 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 = (0, fs_1.createReadStream)(filename);
-        const rl = (0, 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 (0, generics_1.delay)(delayIntervalMs);
-            }
-        }
-        fileStream.close();
-    };
-    return {
-        ev,
-        task: fireEvents()
-    };
-};
-exports.readAndEmitEventStream = readAndEmitEventStream;

package/lib/Utils/business.d.ts

@@ -1,22 +0,0 @@
-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;
-}[]>;