@d0v3riz/baileys 6.7.12 → 6.7.17

package/lib/Types/Product.d.ts

@@ -1,78 +1,78 @@
-import { WAMediaUpload } from './Message';
-export type CatalogResult = {
-    data: {
-        paging: {
-            cursors: {
-                before: string;
-                after: string;
-            };
-        };
-        data: any[];
-    };
-};
-export type ProductCreateResult = {
-    data: {
-        product: {};
-    };
-};
-export type CatalogStatus = {
-    status: string;
-    canAppeal: boolean;
-};
-export type CatalogCollection = {
-    id: string;
-    name: string;
-    products: Product[];
-    status: CatalogStatus;
-};
-export type ProductAvailability = 'in stock';
-export type ProductBase = {
-    name: string;
-    retailerId?: string;
-    url?: string;
-    description: string;
-    price: number;
-    currency: string;
-    isHidden?: boolean;
-};
-export type ProductCreate = ProductBase & {
-    /** ISO country code for product origin. Set to undefined for no country */
-    originCountryCode: string | undefined;
-    /** images of the product */
-    images: WAMediaUpload[];
-};
-export type ProductUpdate = Omit<ProductCreate, 'originCountryCode'>;
-export type Product = ProductBase & {
-    id: string;
-    imageUrls: {
-        [_: string]: string;
-    };
-    reviewStatus: {
-        [_: string]: string;
-    };
-    availability: ProductAvailability;
-};
-export type OrderPrice = {
-    currency: string;
-    total: number;
-};
-export type OrderProduct = {
-    id: string;
-    imageUrl: string;
-    name: string;
-    quantity: number;
-    currency: string;
-    price: number;
-};
-export type OrderDetails = {
-    price: OrderPrice;
-    products: OrderProduct[];
-};
-export type CatalogCursor = string;
-export type GetCatalogOptions = {
-    /** cursor to start from */
-    cursor?: CatalogCursor;
-    /** number of products to fetch */
-    limit?: number;
-    jid?: string;
-};
+import { WAMediaUpload } from './Message';
+export type CatalogResult = {
+    data: {
+        paging: {
+            cursors: {
+                before: string;
+                after: string;
+            };
+        };
+        data: any[];
+    };
+};
+export type ProductCreateResult = {
+    data: {
+        product: {};
+    };
+};
+export type CatalogStatus = {
+    status: string;
+    canAppeal: boolean;
+};
+export type CatalogCollection = {
+    id: string;
+    name: string;
+    products: Product[];
+    status: CatalogStatus;
+};
+export type ProductAvailability = 'in stock';
+export type ProductBase = {
+    name: string;
+    retailerId?: string;
+    url?: string;
+    description: string;
+    price: number;
+    currency: string;
+    isHidden?: boolean;
+};
+export type ProductCreate = ProductBase & {
+    /** ISO country code for product origin. Set to undefined for no country */
+    originCountryCode: string | undefined;
+    /** images of the product */
+    images: WAMediaUpload[];
+};
+export type ProductUpdate = Omit<ProductCreate, 'originCountryCode'>;
+export type Product = ProductBase & {
+    id: string;
+    imageUrls: {
+        [_: string]: string;
+    };
+    reviewStatus: {
+        [_: string]: string;
+    };
+    availability: ProductAvailability;
+};
+export type OrderPrice = {
+    currency: string;
+    total: number;
+};
+export type OrderProduct = {
+    id: string;
+    imageUrl: string;
+    name: string;
+    quantity: number;
+    currency: string;
+    price: number;
+};
+export type OrderDetails = {
+    price: OrderPrice;
+    products: OrderProduct[];
+};
+export type CatalogCursor = string;
+export type GetCatalogOptions = {
+    /** cursor to start from */
+    cursor?: CatalogCursor;
+    /** number of products to fetch */
+    limit?: number;
+    jid?: string;
+};

package/lib/Types/Product.js

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

package/lib/Types/Signal.d.ts

@@ -1,57 +1,57 @@
-import { proto } from '../../WAProto';
-type DecryptGroupSignalOpts = {
-    group: string;
-    authorJid: string;
-    msg: Uint8Array;
-};
-type ProcessSenderKeyDistributionMessageOpts = {
-    item: proto.Message.ISenderKeyDistributionMessage;
-    authorJid: string;
-};
-type DecryptSignalProtoOpts = {
-    jid: string;
-    type: 'pkmsg' | 'msg';
-    ciphertext: Uint8Array;
-};
-type EncryptMessageOpts = {
-    jid: string;
-    data: Uint8Array;
-};
-type EncryptGroupMessageOpts = {
-    group: string;
-    data: Uint8Array;
-    meId: string;
-};
-type PreKey = {
-    keyId: number;
-    publicKey: Uint8Array;
-};
-type SignedPreKey = PreKey & {
-    signature: Uint8Array;
-};
-type E2ESession = {
-    registrationId: number;
-    identityKey: Uint8Array;
-    signedPreKey: SignedPreKey;
-    preKey: PreKey;
-};
-type E2ESessionOpts = {
-    jid: string;
-    session: E2ESession;
-};
-export type SignalRepository = {
-    decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>;
-    processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>;
-    decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>;
-    encryptMessage(opts: EncryptMessageOpts): Promise<{
-        type: 'pkmsg' | 'msg';
-        ciphertext: Uint8Array;
-    }>;
-    encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
-        senderKeyDistributionMessage: Uint8Array;
-        ciphertext: Uint8Array;
-    }>;
-    injectE2ESession(opts: E2ESessionOpts): Promise<void>;
-    jidToSignalProtocolAddress(jid: string): string;
-};
-export {};
+import { proto } from '../../WAProto';
+type DecryptGroupSignalOpts = {
+    group: string;
+    authorJid: string;
+    msg: Uint8Array;
+};
+type ProcessSenderKeyDistributionMessageOpts = {
+    item: proto.Message.ISenderKeyDistributionMessage;
+    authorJid: string;
+};
+type DecryptSignalProtoOpts = {
+    jid: string;
+    type: 'pkmsg' | 'msg';
+    ciphertext: Uint8Array;
+};
+type EncryptMessageOpts = {
+    jid: string;
+    data: Uint8Array;
+};
+type EncryptGroupMessageOpts = {
+    group: string;
+    data: Uint8Array;
+    meId: string;
+};
+type PreKey = {
+    keyId: number;
+    publicKey: Uint8Array;
+};
+type SignedPreKey = PreKey & {
+    signature: Uint8Array;
+};
+type E2ESession = {
+    registrationId: number;
+    identityKey: Uint8Array;
+    signedPreKey: SignedPreKey;
+    preKey: PreKey;
+};
+type E2ESessionOpts = {
+    jid: string;
+    session: E2ESession;
+};
+export type SignalRepository = {
+    decryptGroupMessage(opts: DecryptGroupSignalOpts): Promise<Uint8Array>;
+    processSenderKeyDistributionMessage(opts: ProcessSenderKeyDistributionMessageOpts): Promise<void>;
+    decryptMessage(opts: DecryptSignalProtoOpts): Promise<Uint8Array>;
+    encryptMessage(opts: EncryptMessageOpts): Promise<{
+        type: 'pkmsg' | 'msg';
+        ciphertext: Uint8Array;
+    }>;
+    encryptGroupMessage(opts: EncryptGroupMessageOpts): Promise<{
+        senderKeyDistributionMessage: Uint8Array;
+        ciphertext: Uint8Array;
+    }>;
+    injectE2ESession(opts: E2ESessionOpts): Promise<void>;
+    jidToSignalProtocolAddress(jid: string): string;
+};
+export {};

package/lib/Types/Signal.js

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

package/lib/Types/Socket.d.ts

@@ -1,118 +1,121 @@
-/// <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;
-    /** 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;
-    /**
-     * 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;
-    /** 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;
-};
+import { AxiosRequestConfig } from 'axios';
+import type { Agent } from 'https';
+import type { URL } from 'url';
+import { proto } from '../../WAProto';
+import { ILogger } from '../Utils/logger';
+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 PatchedMessageWithRecipientJID = proto.IMessage & {
+    recipientJid?: string;
+};
+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;
+    /** logger */
+    logger: ILogger;
+    /** 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 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;
+    /** 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;
+    /**
+     * 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;
+    /** 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<PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID> | PatchedMessageWithRecipientJID[] | PatchedMessageWithRecipientJID;
+    /** 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 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/Types/State.d.ts

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

package/lib/Types/USync.d.ts

@@ -1,25 +1,25 @@
-import { BinaryNode } from '../WABinary';
-import { USyncUser } from '../WAUSync';
-/**
- * Defines the interface for a USyncQuery protocol
- */
-export interface USyncQueryProtocol {
-    /**
-     * The name of the protocol
-     */
-    name: string;
-    /**
-     * Defines what goes inside the query part of a USyncQuery
-     */
-    getQueryElement: () => BinaryNode;
-    /**
-     * Defines what goes inside the user part of a USyncQuery
-     */
-    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;
-}
+import { BinaryNode } from '../WABinary';
+import { USyncUser } from '../WAUSync';
+/**
+ * Defines the interface for a USyncQuery protocol
+ */
+export interface USyncQueryProtocol {
+    /**
+     * The name of the protocol
+     */
+    name: string;
+    /**
+     * Defines what goes inside the query part of a USyncQuery
+     */
+    getQueryElement: () => BinaryNode;
+    /**
+     * Defines what goes inside the user part of a USyncQuery
+     */
+    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;
+}

package/lib/Types/USync.js

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