@neelegirl/baileys 1.5.2 → 1.5.3

package/lib/Types/Socket.d.ts

@@ -1,12 +1,12 @@
 import { AxiosRequestConfig } from 'axios'
 import type { Agent } from 'https'
-import { ILogger } from '../Utils/logger'
+import { ILogger } from '@neelegirl/baileys/lib/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'
+import { proto } from '@neelegirl/baileys/WAProto'
+import { AuthenticationState, SignalAuthState, TransactionCapabilityOptions } from '@neelegirl/baileys/lib/Types/Auth'
+import { GroupMetadata } from '@neelegirl/baileys/lib/Types/GroupMetadata'
+import { MediaConnInfo } from '@neelegirl/baileys/lib/Types/Message'
+import { SignalRepositoryWithLIDStore } from '@neelegirl/baileys/lib/Types/Signal'
 
 export type WAVersion = [number, number, number]
 
@@ -14,13 +14,26 @@ export type WABrowserDescription = [string, string, string]
 
 export type CacheStore = {
     /** get a cached key and change the stats */
-    get<T>(key: string): T | undefined
+    get<T>(key: string): Promise<T> | T | undefined
     /** set a key in the cache */
-    set<T>(key: string, value: T): void
+    set<T>(key: string, value: T): Promise<void> | void | number | boolean
     /** delete a key from the cache */
-    del(key: string): void
+    del(key: string): void | Promise<void> | number | boolean
     /** flush all data */
-    flushAll(): void
+    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
 }
 
 export type SocketConfig = {
@@ -75,7 +88,7 @@ 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?: CacheStore
+    userDevicesCache?: PossiblyExtendedCacheStore
     /** cache to store call offers */
     callOfferCache?: CacheStore
     /** cache to track placeholder resends */
@@ -91,6 +104,10 @@ 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.
@@ -100,7 +117,7 @@ export type SocketConfig = {
     /**
      * Optionally patch the message before sending out
      * */
-    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids: string[]) => Promise<proto.IMessage> | proto.IMessage
+    patchMessageBeforeSending: (msg: proto.IMessage, recipientJids?: string[]) => Promise<PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID> | PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID
     /** verify app state MACs */
     appStateMacVerification: {
         patch: boolean
@@ -116,5 +133,9 @@ export type SocketConfig = {
     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
+    makeSignalRepository: (auth: SignalAuthState, onWhatsAppFunc?: (...jids: string[]) => Promise<{
+        jid: string
+        exists: boolean
+        lid: string
+    }[] | undefined>) => SignalRepositoryWithLIDStore
 }

package/lib/Types/State.d.ts

@@ -1,5 +1,5 @@
 import { Boom } from '@hapi/boom'
-import { Contact } from './Contact'
+import { Contact } from '@neelegirl/baileys/lib/Types/Contact'
 
 export declare const enum SyncState {
     /** The socket is connecting, but we haven't received pending notifications yet. */

package/lib/Types/USync.d.ts

@@ -1,5 +1,5 @@
-import { BinaryNode } from '../WABinary'
-import { USyncUser } from '../WAUSync'
+import { BinaryNode } from '@neelegirl/baileys/lib/WABinary'
+import { USyncUser } from '@neelegirl/baileys/lib/WAUSync'
 
 /**
  * Defines the interface for a USyncQuery protocol

package/lib/Types/index.d.ts

@@ -1,19 +1,20 @@
-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'
+export * from '@neelegirl/baileys/lib/Types/Auth'
+export * from '@neelegirl/baileys/lib/Types/Bussines'
+export * from '@neelegirl/baileys/lib/Types/Chat'
+export * from '@neelegirl/baileys/lib/Types/Contact'
+export * from '@neelegirl/baileys/lib/Types/GroupMetadata'
+export * from '@neelegirl/baileys/lib/Types/State'
+export * from '@neelegirl/baileys/lib/Types/MexUpdates'
+export * from '@neelegirl/baileys/lib/Types/Message'
+export * from '@neelegirl/baileys/lib/Types/Newsletter'
+export * from '@neelegirl/baileys/lib/Types/Socket'
+export * from '@neelegirl/baileys/lib/Types/Events'
+export * from '@neelegirl/baileys/lib/Types/Product'
+export * from '@neelegirl/baileys/lib/Types/Call'
+export * from '@neelegirl/baileys/lib/Types/Signal'
 
-import { AuthenticationState } from './Auth'
-import { SocketConfig } from './Socket'
+import { AuthenticationState } from '@neelegirl/baileys/lib/Types/Auth'
+import { SocketConfig } from '@neelegirl/baileys/lib/Types/Socket'
 
 export type UserFacingSocketConfig = Partial<SocketConfig> & {
     auth: AuthenticationState

package/lib/Types/index.js

@@ -18,11 +18,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 
 Object.defineProperty(exports, "__esModule", { value: true })
 
-exports.DisconnectReason = void 0;
+exports.DisconnectReason = void 0
 __exportStar(require("./Auth"), exports)
-__exportStar(require("./GroupMetadata"), exports)
+__exportStar(require("./Bussines"), exports)
 __exportStar(require("./Chat"), exports)
 __exportStar(require("./Contact"), exports)
+__exportStar(require("./GroupMetadata"), exports)
 __exportStar(require("./State"), exports)
 __exportStar(require("./MexUpdates"), exports) 
 __exportStar(require("./Message"), exports)
@@ -45,4 +46,5 @@ const DisconnectReason = {
     forbidden: 403,
     unavailableService: 503
 }
+
 exports.DisconnectReason = DisconnectReason

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

@@ -1,21 +1,21 @@
-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
-
-/**
- * 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
-
+import type { AuthenticationCreds, CacheStore, SignalKeyStore, SignalKeyStoreWithTransaction, TransactionCapabilityOptions } from '@neelegirl/baileys/lib/Types'
+import { ILogger } from '@neelegirl/baileys/lib/Utils/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
+
+/**
+ * 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