@hbmodsofc/baileys 1.7.7 → 2.0.0

package/lib/Types/Socket.d.ts

@@ -1,34 +1,24 @@
-import type { AxiosRequestConfig } from 'axios';
+/// <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/index.js';
-import type { ILogger } from '../Utils/logger';
-import type { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from './Auth';
-import type { GroupMetadata } from './GroupMetadata';
-import { type MediaConnInfo } from './Message';
-import type { SignalRepositoryWithLIDStore } from './Signal';
+import { proto } from '../../WAProto';
+import { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from './Auth';
+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 */
@@ -39,24 +29,20 @@ export type SocketConfig = {
     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
-     */
+    /** should baileys use the mobile api instead of the multi device api */
     mobile?: boolean;
     /** proxy agent */
     agent?: Agent;
-    /** logger */
-    logger: ILogger;
+    /** 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
-     * @deprecated This feature has been removed
-     */
-    printQRInTerminal?: boolean;
+    /** 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 */
@@ -75,8 +61,6 @@ export type SocketConfig = {
     transactionOpts: TransactionCapabilityOptions;
     /** marks the client as online whenever the socket successfully connects */
     markOnlineOnConnect: boolean;
-    /** alphanumeric country code (USA -> US) for the number used */
-    countryCode: string;
     /** provide a cache to store media, so does not have to be re-uploaded */
     mediaCache?: CacheStore;
     /**
@@ -84,11 +68,9 @@ export type SocketConfig = {
      * used to determine whether to retry a message or not */
     msgRetryCounterCache?: CacheStore;
     /** provide a cache to store a user's device list */
-    userDevicesCache?: PossiblyExtendedCacheStore;
+    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 */
@@ -100,10 +82,6 @@ export type SocketConfig = {
      * entails uploading the jpegThumbnail to WA
      * */
     generateHighQualityLinkPreview: boolean;
-    /** Enable automatic session recreation for failed messages */
-    enableAutoSessionRecreation: boolean;
-    /** Enable recent message caching for retry handling */
-    enableRecentMessageCache: boolean;
     /**
      * Returns if a jid should be ignored,
      * no event for that jid will be triggered.
@@ -113,7 +91,7 @@ export type SocketConfig = {
     /**
      * 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;
@@ -127,11 +105,7 @@ export type SocketConfig = {
      * (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, onWhatsAppFunc?: (...jids: string[]) => Promise<{
-        jid: string;
-        exists: boolean;
-        lid: string;
-    }[] | undefined>) => SignalRepositoryWithLIDStore;
+    makeSignalRepository: (auth: SignalAuthState) => SignalRepository;
+    /** Socket passthrough */
+    socket?: any;
 };

package/lib/Types/State.d.ts

@@ -1,22 +1,11 @@
-import { Boom } from '@hapi/boom';
-import type { Contact } from './Contact';
-export declare 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. */
-    AwaitingInitialSync = 1,
-    /** The initial app state sync (history, etc.) is in progress. Buffering continues. */
-    Syncing = 2,
-    /** Initial sync is complete, or was skipped. The socket is fully operational and events are processed in real-time. */
-    Online = 3
-}
+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: Boom | Error | undefined;
+        error: Error | undefined;
         date: Date;
     };
     /** is this a new login */

package/lib/Types/State.js

@@ -1,14 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SyncState = void 0;
-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 || (exports.SyncState = SyncState = {}));

package/lib/Types/USync.d.ts

@@ -1,4 +1,4 @@
-import type { BinaryNode } from '../WABinary';
+import { BinaryNode } from '../WABinary';
 import { USyncUser } from '../WAUSync';
 /**
  * Defines the interface for a USyncQuery protocol

package/lib/Types/index.d.ts

@@ -4,24 +4,17 @@ 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';
-export * from './Newsletter';
-import type { AuthenticationState } from './Auth';
-import type { SocketConfig } from './Socket';
+import { AuthenticationState } from './Auth';
+import { SocketConfig } from './Socket';
 export type UserFacingSocketConfig = Partial<SocketConfig> & {
     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 {
     connectionClosed = 428,
     connectionLost = 408,

package/lib/Types/index.js

@@ -21,12 +21,12 @@ __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);
-__exportStar(require("./Newsletter"), exports);
 var DisconnectReason;
 (function (DisconnectReason) {
     DisconnectReason[DisconnectReason["connectionClosed"] = 428] = "connectionClosed";
@@ -39,4 +39,4 @@ var DisconnectReason;
     DisconnectReason[DisconnectReason["multideviceMismatch"] = 411] = "multideviceMismatch";
     DisconnectReason[DisconnectReason["forbidden"] = 403] = "forbidden";
     DisconnectReason[DisconnectReason["unavailableService"] = 503] = "unavailableService";
-})(DisconnectReason || (exports.DisconnectReason = DisconnectReason = {}));
+})(DisconnectReason = exports.DisconnectReason || (exports.DisconnectReason = {}));

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

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