@neelegirl/baileys 1.5.6 → 1.5.8

package/lib/Types/Socket.d.ts

@@ -1,133 +1,122 @@
-import type { Agent } from 'https';
-import type { URL } from 'url';
-import { proto } from '../../WAProto/index.js';
-import type { ILogger } from '../Utils/logger.js';
-import type { AuthenticationState, LIDMapping, SignalAuthState, TransactionCapabilityOptions } from './Auth.js';
-import type { GroupMetadata } from './GroupMetadata.js';
-import { type MediaConnInfo, type WAMessageKey } from './Message.js';
-import type { SignalRepositoryWithLIDStore } from './Signal.js';
-export type WAVersion = [number, number, number];
-export type WABrowserDescription = [string, string, string];
+import { AxiosRequestConfig } from 'axios'
+import type { Agent } from 'https'
+import { ILogger } from '../Utils/logger'
+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): Promise<T> | T | undefined;
+    get<T>(key: string): T | undefined
     /** set a key in the cache */
-    set<T>(key: string, value: T): Promise<void> | void | number | boolean;
+    set<T>(key: string, value: T): void
     /** delete a key from the cache */
-    del(key: string): void | Promise<void> | number | boolean;
+    del(key: string): void
     /** flush all data */
-    flushAll(): void | Promise<void>;
-};
-export type PossiblyExtendedCacheStore = CacheStore & {
-    mget?: <T>(keys: string[]) => Promise<Record<string, T | undefined>>;
-    mset?: <T>(entries: {
-        key: string;
-        value: T;
-    }[]) => Promise<void> | void | number | boolean;
-    mdel?: (keys: string[]) => void | Promise<void> | number | boolean;
-};
-export type PatchedMessageWithRecipientJID = proto.IMessage & {
-    recipientJid?: string;
-};
+    flushAll(): void
+}
+
 export type SocketConfig = {
     /** the WS url to connect to WA */
-    waWebSocketUrl: string | URL;
+    waWebSocketUrl: string | URL
     /** Fails the connection if the socket times out in this interval */
-    connectTimeoutMs: number;
+    connectTimeoutMs: number
     /** Default timeout for queries, undefined for no timeout */
-    defaultQueryTimeoutMs: number | undefined;
+    defaultQueryTimeoutMs: number | undefined
     /** ping-pong interval for WS connection */
-    keepAliveIntervalMs: number;
+    keepAliveIntervalMs: number
     /** should baileys use the mobile api instead of the multi device api
      * @deprecated This feature has been removed
-     */
-    mobile?: boolean;
+    */
+    mobile?: boolean
     /** proxy agent */
-    agent?: Agent;
+    agent?: Agent
     /** logger */
-    logger: ILogger;
+    logger: ILogger
     /** version to connect with */
-    version: WAVersion;
+    version: WAVersion
     /** override browser config */
-    browser: WABrowserDescription;
+    browser: WABrowserDescription
     /** agent used for fetch requests -- uploading/downloading media */
-    fetchAgent?: Agent;
-    /** should the QR be printed in the terminal
-     * @deprecated This feature has been removed
-     */
-    printQRInTerminal?: boolean;
+    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;
+    emitOwnEvents: boolean
     /** custom upload hosts to upload media to */
-    customUploadHosts: MediaConnInfo['hosts'];
+    customUploadHosts: MediaConnInfo['hosts']
     /** time to wait between sending new retry requests */
-    retryRequestDelayMs: number;
+    retryRequestDelayMs: number
     /** max retry count */
-    maxMsgRetryCount: number;
+    maxMsgRetryCount: number
     /** time to wait for the generation of the next QR in ms */
-    qrTimeout?: number;
+    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;
+    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;
+    transactionOpts: TransactionCapabilityOptions
     /** marks the client as online whenever the socket successfully connects */
-    markOnlineOnConnect: boolean;
+    markOnlineOnConnect: boolean
     /** alphanumeric country code (USA -> US) for the number used */
-    countryCode: string;
+    countryCode: string
     /** provide a cache to store media, so does not have to be re-uploaded */
-    mediaCache?: CacheStore;
+    mediaCache?: CacheStore
     /**
-     * map to store the retry counts for failed messages;
+     * map to store the retry counts for failed messages
      * used to determine whether to retry a message or not */
-    msgRetryCounterCache?: CacheStore;
+    msgRetryCounterCache?: CacheStore
     /** provide a cache to store a user's device list */
-    userDevicesCache?: PossiblyExtendedCacheStore;
+    userDevicesCache?: CacheStore
     /** cache to store call offers */
-    callOfferCache?: CacheStore;
+    callOfferCache?: CacheStore
     /** cache to track placeholder resends */
-    placeholderResendCache?: CacheStore;
+    placeholderResendCache?: CacheStore
     /** width for link preview images */
-    linkPreviewImageThumbnailWidth: number;
+    linkPreviewImageThumbnailWidth: number
     /** Should Baileys ask the phone for full history, will be received async */
-    syncFullHistory: boolean;
+    syncFullHistory: boolean
     /** Should baileys fire init queries automatically, default true */
-    fireInitQueries: boolean;
+    fireInitQueries: boolean
     /**
      * generate a high quality link preview,
      * entails uploading the jpegThumbnail to WA
      * */
-    generateHighQualityLinkPreview: boolean;
-    /** Enable automatic session recreation for failed messages */
-    enableAutoSessionRecreation: boolean;
+    generateHighQualityLinkPreview: boolean
     /** Enable recent message caching for retry handling */
-    enableRecentMessageCache: boolean;
+    enableRecentMessageCache: 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;
+    shouldIgnoreJid: (jid: string) => boolean | undefined
     /**
      * Optionally patch the message before sending out
      * */
-    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids?: string[]) => Promise<PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID> | PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID;
+    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids: string[]) => Promise<proto.IMessage> | proto.IMessage
     /** verify app state MACs */
     appStateMacVerification: {
-        patch: boolean;
-        snapshot: boolean;
-    };
-    /** options for HTTP fetch requests */
-    options: RequestInit;
+        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: WAMessageKey) => Promise<proto.IMessage | undefined>;
+    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, logger: ILogger, pnToLIDFunc?: (jids: string[]) => Promise<LIDMapping[] | undefined>) => SignalRepositoryWithLIDStore;
-};
-//# sourceMappingURL=Socket.d.ts.map
+    cachedGroupMetadata: (jid: string) => Promise<GroupMetadata | undefined>
+    makeSignalRepository: (auth: SignalAuthState) => SignalRepository
+}

package/lib/Types/Socket.js

@@ -1,3 +1,3 @@
-import { proto } from '../../WAProto/index.js';
-import {} from './Message.js';
-//# sourceMappingURL=Socket.js.map
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/State.d.ts

@@ -1,6 +1,7 @@
-import { Boom } from '@hapi/boom';
-import type { Contact } from './Contact.js';
-export declare enum SyncState {
+import { Boom } from '@hapi/boom'
+import { Contact } from './Contact'
+
+export declare const enum SyncState {
     /** The socket is connecting, but we haven't received pending notifications yet. */
     Connecting = 0,
     /** Pending notifications received. Buffering events until we decide whether to sync or not. */
@@ -10,30 +11,31 @@ export declare enum SyncState {
     /** Initial sync is complete, or was skipped. The socket is fully operational and events are processed in real-time. */
     Online = 3
 }
-export type WAConnectionState = 'open' | 'connecting' | 'close';
+
+export type WAConnectionState = 'open' | 'connecting' | 'close'
+
 export type ConnectionState = {
     /** connection is now open, connecting or closed */
-    connection: WAConnectionState;
+    connection: WAConnectionState
     /** the error that caused the connection to close */
     lastDisconnect?: {
-        error: Boom | Error | undefined;
-        date: Date;
-    };
+        error: Boom | Error | undefined
+        date: Date
+    }
     /** is this a new login */
-    isNewLogin?: boolean;
+    isNewLogin?: boolean
     /** the current QR code */
-    qr?: string;
+    qr?: string
     /** has the device received all pending notifications while it was offline */
-    receivedPendingNotifications?: boolean;
+    receivedPendingNotifications?: boolean
     /** legacy connection options */
     legacy?: {
-        phoneConnected: boolean;
-        user?: Contact;
-    };
+        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;
-};
-//# sourceMappingURL=State.d.ts.map
+    isOnline?: boolean
+}

package/lib/Types/State.js

@@ -1,13 +1,14 @@
-import { Boom } from '@hapi/boom';
-export var SyncState;
-(function (SyncState) {
-    /** The socket is connecting, but we haven't received pending notifications yet. */
-    SyncState[SyncState["Connecting"] = 0] = "Connecting";
-    /** Pending notifications received. Buffering events until we decide whether to sync or not. */
-    SyncState[SyncState["AwaitingInitialSync"] = 1] = "AwaitingInitialSync";
-    /** The initial app state sync (history, etc.) is in progress. Buffering continues. */
-    SyncState[SyncState["Syncing"] = 2] = "Syncing";
-    /** Initial sync is complete, or was skipped. The socket is fully operational and events are processed in real-time. */
-    SyncState[SyncState["Online"] = 3] = "Online";
-})(SyncState || (SyncState = {}));
-//# sourceMappingURL=State.js.map
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })
+
+const SyncState = {
+	Connecting: 0,
+	AwaitingInitialSync: 1, 
+	Syncing: 2,
+	Online: 3
+}
+
+module.exports = {
+  SyncState
+}

package/lib/Types/USync.d.ts

@@ -1,5 +1,6 @@
-import type { BinaryNode } from '../WABinary/index.js';
-import { USyncUser } from '../WAUSync/index.js';
+import { BinaryNode } from '../WABinary'
+import { USyncUser } from '../WAUSync'
+
 /**
  * Defines the interface for a USyncQuery protocol
  */
@@ -7,20 +8,19 @@ export interface USyncQueryProtocol {
     /**
      * The name of the protocol
      */
-    name: string;
+    name: string
     /**
      * Defines what goes inside the query part of a USyncQuery
      */
-    getQueryElement: () => BinaryNode;
+    getQueryElement: () => BinaryNode
     /**
      * Defines what goes inside the user part of a USyncQuery
      */
-    getUserElement: (user: USyncUser) => BinaryNode | null;
+    getUserElement: (user: USyncUser) => BinaryNode | null
     /**
      * Parse the result of the query
      * @param data Data from the result
      * @returns Whatever the protocol is supposed to return
      */
-    parser: (data: BinaryNode) => unknown;
-}
-//# sourceMappingURL=USync.d.ts.map
+    parser: (data: BinaryNode) => unknown
+}

package/lib/Types/USync.js

@@ -1,2 +1,3 @@
-import { USyncUser } from '../WAUSync/index.js';
-//# sourceMappingURL=USync.js.map
+"use strict"
+
+Object.defineProperty(exports, "__esModule", { value: true })

package/lib/Types/index.d.ts

@@ -1,28 +1,39 @@
-export * from './Auth.js';
-export * from './GroupMetadata.js';
-export * from './Chat.js';
-export * from './Contact.js';
-export * from './State.js';
-export * from './Message.js';
-export * from './Socket.js';
-export * from './Events.js';
-export * from './Product.js';
-export * from './Call.js';
-export * from './Signal.js';
-export * from './Newsletter.js';
-import type { AuthenticationState } from './Auth.js';
-import type { SocketConfig } from './Socket.js';
+export * from './Auth'
+export * from './GroupMetadata'
+export * from './Chat'
+export * from './Contact'
+export * from './State'
+export * from './MexUpdates'
+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;
-};
+    auth: AuthenticationState
+}
+
 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 {
+    ubuntu(browser: string): [string, string, string]
+    macOS(browser: string): [string, string, string]
+    windows(browser: string): [string, string, string]
+    linux(browser: string): [string, string, string]
+    android(browser: string): [string, string, string]
+    iOS(browser: string): [string, string, string]
+    baileys(browser: string): [string, string, string]
+    kaiOS(browser: string): [string, string, string]
+    chromeOS(browser: string): [string, string, string]
+    appropriate(browser: string): [string, string, string]
+    custom(platform: string, browser: string, version: string): [string, string, string]
+}
+
+export declare const enum DisconnectReason {
     connectionClosed = 428,
     connectionLost = 408,
     connectionReplaced = 440,
@@ -34,32 +45,35 @@ export declare enum DisconnectReason {
     forbidden = 403,
     unavailableService = 503
 }
+
 export type WAInitResponse = {
-    ref: string;
-    ttl: number;
-    status: 200;
-};
+    ref: string
+    ttl: number
+    status: 200
+}
+
 export type WABusinessHoursConfig = {
-    day_of_week: string;
-    mode: string;
-    open_time?: number;
-    close_time?: number;
-};
+    day_of_week: string
+    mode: string
+    open_time?: number
+    close_time?: number
+}
+
 export type WABusinessProfile = {
-    description: string;
-    email: string | undefined;
+    description: string
+    email: string | undefined
     business_hours: {
-        timezone?: string;
-        config?: WABusinessHoursConfig[];
-        business_config?: WABusinessHoursConfig[];
-    };
-    website: string[];
-    category?: string;
-    wid?: string;
-    address?: string;
-};
+        timezone?: string
+        config?: WABusinessHoursConfig[]
+        business_config?: WABusinessHoursConfig[]
+    }
+    website: string[]
+    category?: string
+    wid?: string
+    address?: string
+}
+
 export type CurveKeyPair = {
-    private: Uint8Array;
-    public: Uint8Array;
-};
-//# sourceMappingURL=index.d.ts.map
+    private: Uint8Array
+    public: Uint8Array
+}

package/lib/Types/index.js

@@ -1,26 +1,48 @@
-export * from './Auth.js';
-export * from './GroupMetadata.js';
-export * from './Chat.js';
-export * from './Contact.js';
-export * from './State.js';
-export * from './Message.js';
-export * from './Socket.js';
-export * from './Events.js';
-export * from './Product.js';
-export * from './Call.js';
-export * from './Signal.js';
-export * from './Newsletter.js';
-export 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 || (DisconnectReason = {}));
-//# sourceMappingURL=index.js.map
+"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("./MexUpdates"), 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)
+
+const DisconnectReason = {
+    connectionClosed: 428,
+    connectionLost: 408,
+    connectionReplaced: 440,
+    timedOut: 408,
+    loggedOut: 401,
+    badSession: 500,
+    restartRequired: 515,
+    multideviceMismatch: 411,
+    forbidden: 403,
+    unavailableService: 503
+}
+exports.DisconnectReason = DisconnectReason

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

@@ -1,19 +1,21 @@
-import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '../Types/index.js';
-import type { ILogger } from './logger.js';
+import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '../Types'
+import { ILogger } from './logger'
+
 /**
  * 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?: ILogger, _cache?: CacheStore): SignalKeyStore;
+export declare function makeCacheableSignalKeyStore(store: SignalKeyStore, logger?: ILogger, _cache?: CacheStore): SignalKeyStore
+
 /**
- * Adds DB-like transaction capability to the SignalKeyStore
- * Uses AsyncLocalStorage for automatic context management
+ * 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: ILogger, { maxCommitRetries, delayBetweenTriesMs }: TransactionCapabilityOptions) => SignalKeyStoreWithTransaction;
-export declare const initAuthCreds: () => AuthenticationCreds;
-//# sourceMappingURL=auth-utils.d.ts.map
+export declare const addTransactionCapability: (state: SignalKeyStore, logger?: ILogger, { maxCommitRetries, delayBetweenTriesMs }: TransactionCapabilityOptions) => SignalKeyStoreWithTransaction
+
+export declare const initAuthCreds: () => AuthenticationCreds