@vanzxy/baileys 1.3.6 → 1.3.8

package/lib/Types/GroupMetadata.d.ts

@@ -1,2 +1,71 @@
-export {};
+import type { Contact } from './Contact.js';
+import type { WAMessageAddressingMode } from './Message.js';
+export type GroupParticipant = Contact & {
+    isAdmin?: boolean;
+    isSuperAdmin?: boolean;
+    admin?: 'admin' | 'superadmin' | null;
+};
+export type ParticipantAction = 'add' | 'remove' | 'promote' | 'demote' | 'modify';
+export type RequestJoinAction = 'created' | 'revoked' | 'rejected';
+export type RequestJoinMethod = 'invite_link' | 'linked_group_join' | 'non_admin_add' | undefined;
+export interface GroupMetadata {
+    id: string;
+    notify?: string;
+    /** group uses 'lid' or 'pn' to send messages */
+    addressingMode?: WAMessageAddressingMode;
+    owner: string | undefined;
+    ownerPn?: string | undefined;
+    ownerUsername?: string | undefined;
+    owner_country_code?: string | undefined;
+    subject: string;
+    /** group subject owner */
+    subjectOwner?: string;
+    subjectOwnerPn?: string;
+    subjectOwnerUsername?: string;
+    /** group subject modification date */
+    subjectTime?: number;
+    creation?: number;
+    desc?: string;
+    descOwner?: string;
+    descOwnerPn?: string;
+    descOwnerUsername?: string;
+    descId?: string;
+    descTime?: number;
+    /** if this group is part of a community, it returns the jid of the community to which it belongs */
+    linkedParent?: string;
+    /** is set when the group only allows admins to change group settings */
+    restrict?: boolean;
+    /** is set when the group only allows admins to write messages */
+    announce?: boolean;
+    /** is set when the group also allows members to add participants */
+    memberAddMode?: boolean;
+    /** Request approval to join the group */
+    joinApprovalMode?: boolean;
+    /** is this a community */
+    isCommunity?: boolean;
+    /** is this the announce of a community */
+    isCommunityAnnounce?: boolean;
+    /** number of group participants */
+    size?: number;
+    participants: GroupParticipant[];
+    ephemeralDuration?: number;
+    inviteCode?: string;
+    /** the person who added you to group or changed some setting in group */
+    author?: string;
+    authorPn?: string;
+    authorUsername?: string;
+}
+export interface WAGroupCreateResponse {
+    status: number;
+    gid?: string;
+    participants?: [{
+        [key: string]: {};
+    }];
+}
+export interface GroupModificationResponse {
+    status: number;
+    participants?: {
+        [key: string]: {};
+    };
+}
 //# sourceMappingURL=GroupMetadata.d.ts.map

package/lib/Types/Label.d.ts

@@ -1,3 +1,2 @@
 /** WhatsApp has 20 predefined colors */
 export const LabelColor: any;
-//# sourceMappingURL=Label.d.ts.map

package/lib/Types/LabelAssociation.d.ts

@@ -1,3 +1,2 @@
 /** Association type */
 export const LabelAssociationType: any;
-//# sourceMappingURL=LabelAssociation.d.ts.map

package/lib/Types/Message.d.ts

@@ -1,12 +1,11 @@
 export { proto as WAProto };
-export const AssociationType: typeof proto.MessageAssociation.AssociationType;
-export const ButtonHeaderType: typeof proto.Message.ButtonsMessage.HeaderType;
-export const ButtonType: typeof proto.Message.ButtonsMessage.Button.Type;
-export const CarouselCardType: typeof proto.Message.InteractiveMessage.CarouselMessage.CarouselCardType;
-export const ListType: typeof proto.Message.ListMessage.ListType;
-export const ProtocolType: typeof proto.Message.ProtocolMessage.Type;
-export const WAMessageStubType: typeof proto.WebMessageInfo.StubType;
-export const WAMessageStatus: typeof proto.WebMessageInfo.Status;
+export const AssociationType: any;
+export const ButtonHeaderType: any;
+export const ButtonType: any;
+export const CarouselCardType: any;
+export const ListType: any;
+export const ProtocolType: any;
+export const WAMessageStubType: any;
+export const WAMessageStatus: any;
 export const WAMessageAddressingMode: any;
 import { proto } from '../../WAProto/index.js';
-//# sourceMappingURL=Message.d.ts.map

package/lib/Types/Mex.d.ts

@@ -1,3 +1,2 @@
 export const XWAPaths: any;
 export const QueryIds: any;
-//# sourceMappingURL=Mex.d.ts.map

package/lib/Types/Product.d.ts

@@ -1,2 +1,79 @@
-export {};
+import type { WAMediaUpload } from './Message.js';
+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;
+};
 //# sourceMappingURL=Product.d.ts.map

package/lib/Types/RichType.d.ts

@@ -1,3 +1,2 @@
 export const CodeHighlightType: any;
 export const RichSubMessageType: any;
-//# sourceMappingURL=RichType.d.ts.map

package/lib/Types/Signal.d.ts

@@ -1,2 +1,87 @@
+import { proto } from '../../WAProto/index.js';
+import type { LIDMappingStore } from '../Signal/lid-mapping.js';
+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 GetSenderKeyDistributionMessageOpts = {
+    group: string;
+    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;
+    }>;
+    getSenderKeyDistributionMessage(opts: GetSenderKeyDistributionMessageOpts): Promise<Uint8Array>;
+    hasSenderKey(opts: GetSenderKeyDistributionMessageOpts): Promise<boolean>;
+    getSessionInfo(jid: string): Promise<{
+        baseKey: Uint8Array;
+        registrationId: number;
+    } | null>;
+    injectE2ESession(opts: E2ESessionOpts): Promise<void>;
+    validateSession(jid: string): Promise<{
+        exists: boolean;
+        reason?: string;
+    }>;
+    jidToSignalProtocolAddress(jid: string): string;
+    migrateSession(fromJid: string, toJid: string): Promise<{
+        migrated: number;
+        skipped: number;
+        total: number;
+    }>;
+    validateSession(jid: string): Promise<{
+        exists: boolean;
+        reason?: string;
+    }>;
+    deleteSession(jids: string[]): Promise<void>;
+};
+export interface SignalRepositoryWithLIDStore extends SignalRepository {
+    lidMapping: LIDMappingStore;
+    close?: () => void;
+}
 export {};
 //# sourceMappingURL=Signal.d.ts.map

package/lib/Types/Socket.d.ts

@@ -1,2 +1,136 @@
-export {};
+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];
+export type CacheStore = {
+    /** get a cached key and change the stats */
+    get<T>(key: string): Promise<T> | T | undefined;
+    /** set a key in the cache */
+    set<T>(key: string, value: T): Promise<void> | void | number | boolean;
+    /** delete a key from the cache */
+    del(key: string): void | Promise<void> | number | boolean;
+    /** flush all data */
+    flushAll(): void | Promise<void>;
+    close?: () => 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 = {
+    /** 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;
+    /** Initial pushName carried in the registration ClientPayload (used by mock servers for deterministic phone assignment). */
+    pushName?: string;
+    /** 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?: PossiblyExtendedCacheStore;
+    /** 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;
+    /** 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.
+     * 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 HTTP fetch requests */
+    options: RequestInit;
+    /**
+     * 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>;
+    /** 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

package/lib/Types/State.d.ts

@@ -3,4 +3,3 @@ export const ReachoutTimelockEnforcementType: any;
 export const NewChatMessageCappingStatusType: any;
 export const NewChatMessageCappingMVStatusType: any;
 export const NewChatMessageCappingOTEStatusType: any;
-//# sourceMappingURL=State.d.ts.map

package/lib/Types/USync.d.ts

@@ -1,2 +1,26 @@
-export {};
+import type { BinaryNode } from '../WABinary/index.js';
+import { USyncUser } from '../WAUSync/index.js';
+/**
+ * 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;
+}
 //# sourceMappingURL=USync.d.ts.map

package/lib/Types/index.d.ts

@@ -1,14 +1,66 @@
-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 "./Mex.js";
-export const DisconnectReason: any;
+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 './Mex.js';
+import type { AuthenticationState } from './Auth.js';
+import type { SocketConfig } from './Socket.js';
+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];
+    android(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;
+};
 //# sourceMappingURL=index.d.ts.map

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

@@ -55,4 +55,3 @@ export function initAuthCreds(): {
     routingInfo: undefined;
     additionalData: undefined;
 };
-//# sourceMappingURL=auth-utils.d.ts.map

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

@@ -5,5 +5,4 @@ export namespace Browsers {
     function windows(browser: any): any[];
     function appropriate(browser: any): any[];
 }
-export function getPlatformId(browser: any): string;
-//# sourceMappingURL=browser-utils.d.ts.map
+export function getPlatformId(browser: any): any;

package/lib/Utils/business.d.ts

@@ -47,4 +47,3 @@ export function parseProductNode(productNode: any): {
     isHidden: boolean;
 };
 export function uploadingNecessaryImages(images: any, waUploadToServer: any, timeoutMs?: number): Promise<any[]>;
-//# sourceMappingURL=business.d.ts.map

package/lib/Utils/business.js

@@ -5,6 +5,7 @@ import { tmpdir } from 'os';
 import { join } from 'path';
 import { getBinaryNodeChild, getBinaryNodeChildren, getBinaryNodeChildString } from '../WABinary/index.js';
 import { generateMessageIDV2 } from './generics.js';
+import logger from './logger.js';
 import { getStream, getUrlFromDirectPath } from './messages-media.js';
 export const parseCatalogNode = (node) => {
     const catalogNode = getBinaryNodeChild(node, 'product_catalog');
@@ -209,7 +210,7 @@ export const uploadingNecessaryImages = async (images, waUploadToServer, timeout
             fileEncSha256B64: sha,
             timeoutMs
         });
-        await fs.unlink(filePath).catch(err => console.log('Error deleting temp file ', err));
+        await fs.unlink(filePath).catch(err => logger.warn({ err, filePath }, 'Vanz@Fix (bug 57): error deleting temp file')); // was console.log
         return { url: getUrlFromDirectPath(directPath) };
     }));
     return results;