@hdriel/whatsapp-socket 1.2.7 → 1.2.9

package/dist/index.d.ts

@@ -1,7 +1,32 @@
-import { WAMessage, MessageUpsertType, WASocket, UserFacingSocketConfig, GroupMetadata } from '@fadzzzslebew/baileys';
+import Stream from 'node:stream';
+import { WASocket, UserFacingSocketConfig, WAMessage, Contact, GroupMetadata } from '@fadzzzslebew/baileys';
 import { StringValue } from 'ms';
 import { Logger } from 'stack-trace-logger';
-import Stream from 'node:stream';
+
+type ButtonURL = {
+    label: string;
+    url: string;
+};
+type ButtonCopy = {
+    label: string;
+    copy: string;
+};
+type ButtonPhone = {
+    label: string;
+    tel: string;
+};
+type CallToActionButtons = Array<ButtonURL | ButtonCopy | ButtonPhone>;
+type MessageOptions = {
+    mentions?: string[];
+    replyToMessageId?: string;
+};
+type CreateGroupOptions = {
+    name: string;
+    participants?: string[];
+    description?: string;
+};
+type GroupSettingsType = 'announcement' | 'not_announcement' | 'locked' | 'unlocked';
+type MessageReceivedCB = (remoteJid: string, messageId: string, options: any) => void | Promise<void>;
 
 type WhatsappSocketBaseProps = ({
     mongoURL: string;
@@ -16,7 +41,6 @@ type WhatsappSocketBaseProps = ({
     onOpen?: () => Promise<void> | void;
     onClose?: () => Promise<void> | void;
     onConnectionStatusChange?: (connectionStatus: 'connecting' | 'close' | 'open') => Promise<void> | void;
-    onReceiveMessages?: (messages: WAMessage[], type: MessageUpsertType) => Promise<void> | void;
     onPreConnectionSendMessageFailed?: (error: Error | string) => Promise<void> | void;
     onQR?: (qr: string, code?: string | null) => Promise<void> | void;
     debug?: boolean;
@@ -31,6 +55,7 @@ declare class WhatsappSocketBase {
     protected readonly logger?: Logger;
     protected readonly debug?: boolean;
     protected readonly printQRInTerminal?: boolean;
+    protected readonly messageReceivedCBs: Record<string, MessageReceivedCB[]>;
     protected readonly pairingPhone?: string;
     protected readonly customPairingCode?: string;
     protected readonly appName?: string;
@@ -39,7 +64,6 @@ declare class WhatsappSocketBase {
     private onClose?;
     private onQR?;
     private onConnectionStatusChange?;
-    private readonly onReceiveMessages?;
     static DEFAULT_COUNTRY_CODE: string;
     static CONNECTION_TIMEOUT: StringValue;
     static formatPhoneNumber(phone: string, countryCode?: string): string;
@@ -89,7 +113,7 @@ declare class WhatsappSocketBase {
         autoConnect?: boolean;
     }): Promise<void>;
     isConnected(): boolean;
-    protected getMimetypeFromFilename(filename: string): string;
+    myJID(): string | null;
     /**
      * Delete a message for everyone (if within time limit) or just for yourself
      * @param messageId - The message ID to delete
@@ -109,34 +133,197 @@ declare class WhatsappSocketBase {
         chatJid: string;
     }>, deleteForEveryone?: true): Promise<any[]>;
     loadRecentMessages(chatJid: string, messageId: string): Promise<WAMessage | null>;
+    getContactByJid(remoteJid: string): Promise<Contact | undefined>;
+    getContacts(username?: string, byWords?: boolean): Promise<Contact[]>;
+    areRegisteredOnWhatsApp(phone: string | string[]): Promise<Array<{
+        phone: string;
+        exists: boolean;
+        jid?: string;
+        contact: Contact | undefined;
+    }>>;
 }
 
-type ButtonURL = {
-    label: string;
-    url: string;
+type MenuMessageProps = {
+    title: string;
+    subtitle?: string;
+    buttonText: string;
+    sections: Array<{
+        title: string;
+        rows: Array<{
+            id: string;
+            title: string;
+            description?: string;
+        }>;
+    }>;
 };
-type ButtonCopy = {
-    label: string;
-    copy: string;
+type AudioMessageProps = {
+    filename?: string;
+    replyToMessageId?: string;
+    mimetype?: string;
+    seconds?: number;
+    ptt?: boolean;
+    mentions?: string[];
 };
-type ButtonPhone = {
-    label: string;
-    tel: string;
+type ButtonsMessageProps = {
+    title: string;
+    subtitle?: string;
+    buttons: CallToActionButtons;
 };
-type CallToActionButtons = Array<ButtonURL | ButtonCopy | ButtonPhone>;
-type GroupMessageOptions = {
+type DocumentMessageProps = {
+    filename?: string;
+    caption?: string;
+    mimetype?: string;
     mentions?: string[];
-    replyToMessageId?: string;
+    jpegThumbnail?: Buffer | string;
 };
-type CreateGroupOptions = {
-    name: string;
-    participants?: string[];
+type ImageMessageProps = {
+    caption?: string;
+    filename?: string;
+    mentions?: string[];
+};
+type ReplyMessageProps = {
+    title: string;
+    subtitle?: string;
+    buttons: Array<string | {
+        id: number | string;
+        label: string;
+    }>;
+};
+type SurveyMessageProps = {
+    question: string;
+    options: string[];
+    allowMultipleAnswers?: boolean;
+};
+type TextMessageProps = {
+    text: string;
+};
+type VideoMessageProps = {
+    caption?: string;
+    sendAsGifPlayback?: boolean;
+    filename?: string;
+    mentions?: string[];
+};
+type LocationMessageProps = {
+    latitude: number;
+    longitude: number;
+    name?: string;
+    address?: string;
+};
+type StickerMessageProps = {
+    mentions?: string[];
+};
+
+type ReplyMessage = Omit<ReplyMessageProps, 'buttons'> & {
+    buttons: Array<{
+        id: number | string;
+        label: string;
+    }>;
+};
+type Message = {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    text: TextMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    menu: MenuMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    reply: ReplyMessage;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    buttons: ButtonsMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    survey: SurveyMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    image: ImageMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    video: VideoMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    sticker: StickerMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    audio: AudioMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    document: DocumentMessageProps;
+} | {
+    timeout?: StringValue | number;
+    forceExit?: boolean;
+    location: LocationMessageProps;
+};
+type ScenarioResponse = {
+    field?: string;
+    onSubmit?: (values: {
+        messageId: string;
+        options?: any;
+        data?: any;
+        remoteJid: string;
+    }) => void | Promise<void>;
+    next?: Scenario;
+};
+type MessageCB = (remoteJid: string, dataFlow: any) => Message | Promise<Message>;
+type MessageItem = MessageCB | Message;
+type Scenario = {
+    field?: string;
+    messages: MessageItem[];
+    response?: Record<string, // input or buttonId
+    // input or buttonId
+    ScenarioResponse | undefined>;
+};
+type FieldSchema = {
+    parseFieldData?: (input: string) => any;
+    validate?: (input: string) => boolean;
+    validationError?: string | ((input?: string) => string);
+};
+type BotSchema = {
+    name?: string;
     description?: string;
+    exitCode?: string;
+    exitMsg?: Message;
+    unknownInputMsg?: Message;
+    idleTimeout?: StringValue | number;
+    timeoutMsg?: Message;
+    backCode?: string;
+    matches?: (string | RegExp | ((remoteJid: string, textMsg: string, fromMe?: boolean) => boolean | Promise<boolean>))[];
+    flow?: Scenario;
+    fields?: Record<string, FieldSchema>;
 };
-type GroupSettingsType = 'announcement' | 'not_announcement' | 'locked' | 'unlocked';
 
+type MessageType = 'text' | 'reply' | 'menu' | 'buttons' | 'image' | 'video' | 'audio' | 'location';
 declare class WhatsappSocketPrivateMessages extends WhatsappSocketBase {
+    protected timers: Record<string, Record<number, {
+        timeoutId: number;
+        date: Date;
+        data: Message;
+        messageType: MessageType;
+    }>>;
     constructor(props: WhatsappSocketBaseProps);
+    protected sendMessageByType(remoteJid: string | null, messageType: MessageType, message: any): Promise<void>;
+    setTimer(remoteJid: string, messageType: MessageType, message: any, timeout: number, autoSelfNotificationFormat?: string | null): Promise<NodeJS.Timeout>;
+    getTimers(remoteJid: string): {
+        code: string;
+        message: {
+            timeoutId: number;
+            date: Date;
+            data: Message;
+            messageType: MessageType;
+        };
+    }[];
+    removeTimerId(remoteJid: string, timerId: number): void;
+    resetTimers(remoteJid?: string): void;
     /**
      * Delete a sent message
      * @param messageId - The message ID to delete
@@ -144,13 +331,13 @@ declare class WhatsappSocketPrivateMessages extends WhatsappSocketBase {
      * @returns Promise with the result
      */
     deleteMessageById(messageId: string, chatJid: string): Promise<any>;
-    sendTextMessage(to: string, text: string): Promise<any>;
-    sendButtonsMessage(to: string, { subtitle, title, buttons }: {
+    sendTextMessage(to: string | null, text: string): Promise<any>;
+    sendButtonsMessage(to: string | null, { subtitle, title, buttons }: {
         title: string;
         subtitle?: string;
         buttons: CallToActionButtons;
     }): Promise<any>;
-    sendListMessage(to: string, { title, subtitle, buttonText, sections, }: {
+    sendMenuMessage(to: string | null, { title, subtitle, buttonText, sections, }: {
         title: string;
         subtitle?: string;
         buttonText: string;
@@ -163,7 +350,7 @@ declare class WhatsappSocketPrivateMessages extends WhatsappSocketBase {
             }>;
         }>;
     }): Promise<any>;
-    sendReplyButtonsMessage(to: string, { title, subtitle, buttons, }: {
+    sendReplyButtonsMessage(to: string | null, { title, subtitle, buttons, }: {
         title: string;
         subtitle?: string;
         buttons: Array<string | {
@@ -171,79 +358,28 @@ declare class WhatsappSocketPrivateMessages extends WhatsappSocketBase {
             label: string;
         }>;
     }): Promise<any>;
-    sendLocation(to: string, { latitude, longitude, name, address, }: {
+    sendLocationMessage(to: string | null, { latitude, longitude, name, address, }: {
         latitude: number;
         longitude: number;
         name?: string;
         address?: string;
     }): Promise<any>;
-    sendLocationMessage(to: string, position: {
-        latitude: number;
-        longitude: number;
-    }, name?: string, address?: string): Promise<any>;
-    sendSurveyMessage(to: string, question: string, options: string[], allowMultipleAnswers?: boolean): Promise<any>;
-}
-
-declare class WhatsappSocketPrivateStream extends WhatsappSocketPrivateMessages {
-    constructor(props: WhatsappSocketBaseProps);
-    protected sendFileFromStream(to: string, stream: Stream | Buffer, options: {
-        filename: string;
-        mimetype?: string;
-        caption?: string;
-        replyToMessageId?: string;
-        ptt?: boolean;
-        seconds?: number;
-        gifPlayback?: boolean;
-        jpegThumbnail?: Buffer | string;
-    }): Promise<any>;
-    private streamToBuffer;
-    private createFileMessage;
-    protected sendImage(to: string, imageBuffer: Buffer | Stream, options?: {
-        caption?: string;
-        filename?: string;
-        replyToMessageId?: string;
-    }): Promise<any>;
-    protected sendVideo(to: string, videoBuffer: Buffer | Stream, options?: {
-        caption?: string;
-        filename?: string;
-        gifPlayback?: boolean;
-        replyToMessageId?: string;
-        jpegThumbnail?: Buffer;
-    }): Promise<any>;
-    protected sendAudio(to: string, audioBuffer: Buffer | Stream, options?: {
-        filename?: string;
-        ptt?: boolean;
-        seconds?: number;
-        replyToMessageId?: string;
-    }): Promise<any>;
-    protected sendDocument(to: string, documentBuffer: Buffer | Stream, options: {
-        filename: string;
-        caption?: string;
-        mimetype?: string;
-        replyToMessageId?: string;
-        jpegThumbnail?: Buffer;
-    }): Promise<any>;
-    protected sendVoiceNote(to: string, audioBuffer: Buffer | Stream, options?: {
-        seconds?: number;
-        replyToMessageId?: string;
-    }): Promise<any>;
-    protected sendSticker(to: string, stickerBuffer: Buffer | Stream, options?: {
-        replyToMessageId?: string;
+    sendSurveyMessage(to: string | null, { question, options, allowMultipleAnswers, }: {
+        question: string;
+        options: string[];
+        allowMultipleAnswers?: boolean;
     }): Promise<any>;
-}
-
-declare class WhatsappSocketPrivateFiles extends WhatsappSocketPrivateStream {
-    constructor(props: WhatsappSocketBaseProps);
-    sendImageMessage(to: string, imageSrc: string | Buffer<any> | Stream, { caption, filename }?: {
+    sendReactionMessage(to: string | null, messageId: string, emoji: string): Promise<any>;
+    sendImageMessage(to: string | null, imageSrc: string | Buffer<any> | Stream, { caption, filename }?: {
         caption?: string;
         filename?: string;
     }): Promise<any>;
-    sendVideoMessage(to: string, videoSrc: string | Buffer<any> | Stream, { caption, filename, sendAsGifPlayback: gifPlayback, }?: {
+    sendVideoMessage(to: string | null, videoSrc: string | Buffer<any> | Stream, { caption, filename, sendAsGifPlayback, }?: {
         caption?: string;
         sendAsGifPlayback?: boolean;
         filename?: string;
     }): Promise<any>;
-    sendAudioMessage(to: string, audioSrc: string | Buffer<any> | Stream, { filename, replyToMessageId, mimetype, seconds, }?: {
+    sendAudioMessage(to: string | null, audioSrc: string | Buffer<any> | Stream, { filename, replyToMessageId, mimetype, seconds, }?: {
         filename?: string;
         replyToMessageId?: string;
         mimetype?: string;
@@ -258,17 +394,25 @@ declare class WhatsappSocketPrivateFiles extends WhatsappSocketPrivateStream {
      * @param to
      * @param imageSrc
      */
-    sendStickerMessage(to: string, imageSrc: string | Buffer<any> | Stream): Promise<any>;
-    sendFileMessage(to: string, fileSrc: string | Buffer<any> | Stream, { caption, mimetype, replyToMessageId, jpegThumbnailSrc, autoMessageClassification, filename, }: {
+    sendStickerMessage(to: string | null, imageSrc: string | Buffer<any> | Stream): Promise<any>;
+    sendFileMessage(to: string | null, fileSrc: string | Buffer<any> | Stream, { caption, mimetype, jpegThumbnailSrc, autoMessageClassification, filename, }: {
         caption?: string;
         mimetype?: string;
         filename: string;
         autoMessageClassification?: boolean;
-        replyToMessageId?: string;
         jpegThumbnailSrc?: string | Buffer<any> | Stream;
     }): Promise<any>;
 }
 
+type WhatsappSocketProps = WhatsappSocketBaseProps;
+declare class WhatsappSocket extends WhatsappSocketPrivateMessages {
+    constructor(props: WhatsappSocketProps);
+    onAnyMessageReceived(cb: MessageReceivedCB): void;
+    offAnyMessageReceived(cb: MessageReceivedCB): void;
+    onPhoneMessageReceived(phone: string, cb: MessageReceivedCB): void;
+    offPhoneMessageReceived(phone: string, cb?: MessageReceivedCB): void;
+}
+
 declare class WhatsappSocketGroups extends WhatsappSocketBase {
     /**
      * פורמט Group ID לתבנית WhatsApp
@@ -360,10 +504,22 @@ declare class WhatsappSocketGroups extends WhatsappSocketBase {
 
 declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
     constructor(props: WhatsappSocketBaseProps);
+    /**
+     * Send message mentioning all group participants
+     */
+    sendMentionAll(groupId: string, text: string): Promise<any>;
+    /**
+     * Send reaction to a message in group
+     */
+    sendReactionMessage(groupId: string, messageId: string, emoji: string): Promise<any>;
+    /**
+     * Delete a message in group (only works for own messages)
+     */
+    deleteGroupMessage(groupId: string, messageId: string): Promise<any>;
     /**
      * Send text message to group
      */
-    sendTextMessage(groupId: string, text: string, options?: GroupMessageOptions): Promise<any>;
+    sendTextMessage(groupId: string, text: string): Promise<any>;
     /**
      * Send buttons message to group
      */
@@ -384,7 +540,7 @@ declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
         }>;
         mentions?: string[];
     }): Promise<any>;
-    sendListMessage(groupId: string, { title, subtitle, buttonText, sections, }: {
+    sendMenuMessage(groupId: string, { title, subtitle, buttonText, sections, }: {
         title: string;
         subtitle?: string;
         buttonText: string;
@@ -397,17 +553,31 @@ declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
             }>;
         }>;
     }): Promise<any>;
+    /**
+     * Send location to group
+     */
+    sendLocationMessage(groupId: string, { latitude, longitude, name, address, }: {
+        latitude: number;
+        longitude: number;
+        name?: string;
+        address?: string;
+    }): Promise<any>;
+    sendSurveyMessage(groupId: string, { question, options, allowMultipleAnswers, }: {
+        question: string;
+        options: string[];
+        allowMultipleAnswers?: boolean;
+    }): Promise<any>;
     /**
      * Send image to group
      */
-    sendImageMessage(groupId: string, imageSrc: string | Buffer | Stream, { caption, filename, mentions }?: GroupMessageOptions & {
+    sendImageMessage(groupId: string, imageSrc: string | Buffer | Stream, { caption, filename, mentions }?: MessageOptions & {
         caption?: string;
         filename?: string;
     }): Promise<any>;
     /**
      * Send video to group
      */
-    sendVideoMessage(groupId: string, videoSrc: string | Buffer | Stream, { caption, filename, sendAsGifPlayback: gifPlayback, mentions, }?: GroupMessageOptions & {
+    sendVideoMessage(groupId: string, videoSrc: string | Buffer | Stream, { caption, filename, sendAsGifPlayback, mentions, }?: MessageOptions & {
         caption?: string;
         filename?: string;
         sendAsGifPlayback?: boolean;
@@ -415,7 +585,7 @@ declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
     /**
      * Send audio to group
      */
-    sendAudioMessage(groupId: string, audioSrc: string | Buffer | Stream, { filename, replyToMessageId, mimetype, seconds, ptt, mentions, }?: {
+    sendAudioMessage(groupId: string, audioSrc: string | Buffer | Stream, { filename, mimetype, seconds, ptt, mentions, }?: {
         filename?: string;
         replyToMessageId?: string;
         mimetype?: string;
@@ -426,34 +596,13 @@ declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
     /**
      * Send document to group
      */
-    sendDocumentMessage(groupId: string, documentSrc: string | Buffer | Stream, { fileName, caption, mimetype, replyToMessageId, jpegThumbnail, mentions, }: {
+    sendDocumentMessage(groupId: string, documentSrc: string | Buffer | Stream, { fileName, caption, mimetype, jpegThumbnail, mentions, }: {
         fileName: string;
         caption?: string;
         mimetype?: string;
-        replyToMessageId?: string;
         jpegThumbnail?: Buffer;
         mentions?: string[];
     }): Promise<any>;
-    /**
-     * Send location to group
-     */
-    sendLocationMessage(groupId: string, position: {
-        latitude: number;
-        longitude: number;
-    }, name?: string, address?: string): Promise<any>;
-    /**
-     * Send message mentioning all group participants
-     */
-    sendMentionAll(groupId: string, text: string): Promise<any>;
-    /**
-     * Send reaction to a message in group
-     */
-    sendReactionMessage(groupId: string, messageId: string, emoji: string): Promise<any>;
-    /**
-     * Delete a message in group (only works for own messages)
-     */
-    deleteGroupMessage(groupId: string, messageId: string): Promise<any>;
-    sendSurveyMessage(groupId: string, question: string, options: string[], allowMultipleAnswers?: boolean): Promise<any>;
     /**
      * Send sticker to group
      * Requirements:
@@ -462,25 +611,54 @@ declare class WhatsappSocketGroupMessages extends WhatsappSocketGroups {
      * * maxSize: 100kb
      * * transparent background
      */
-    sendStickerMessage(groupId: string, imageSrc: string | Buffer | Stream): Promise<any>;
-    sendFileMessage(groupId: string, fileSrc: string | Buffer | Stream, { caption, mimetype, replyToMessageId, jpegThumbnailSrc, autoMessageClassification, filename, }: {
+    sendStickerMessage(groupId: string, imageSrc: string | Buffer | Stream, { mentions }?: {
+        mentions?: string[];
+    }): Promise<any>;
+    sendFileMessage(groupId: string, fileSrc: string | Buffer | Stream, { caption, mimetype, jpegThumbnailSrc, autoMessageClassification, filename, mentions, }: {
         caption?: string;
         mimetype?: string;
         filename: string;
         autoMessageClassification?: boolean;
-        replyToMessageId?: string;
         jpegThumbnailSrc?: string | Buffer | Stream;
+        mentions?: string[];
     }): Promise<any>;
 }
 
-type WhatsappSocketProps = WhatsappSocketBaseProps;
-declare class WhatsappSocket extends WhatsappSocketPrivateFiles {
-    constructor(props: WhatsappSocketProps);
-}
-
 type WhatsappSocketGroupProps = WhatsappSocketBaseProps;
 declare class WhatsappSocketGroup extends WhatsappSocketGroupMessages {
     constructor(props: WhatsappSocketGroupProps);
+    onAnyGroupMessageReceived(cb: MessageReceivedCB): void;
+    offAnyGroupMessageReceived(cb: MessageReceivedCB): void;
+    onGroupMessageReceived(groupId: string, cb: MessageReceivedCB): void;
+    offGroupMessageReceived(groupId: string, cb: MessageReceivedCB): void;
+}
+
+declare class WhatsappSocketBot {
+    protected schema: BotSchema;
+    protected phone?: string;
+    protected client?: WhatsappSocket;
+    private schemaRefs;
+    private remoteFlow;
+    private dataFlow;
+    private timeoutFlow;
+    private lastMessages;
+    constructor(schema: BotSchema, phone?: string);
+    updateSchemaRefs(flow: undefined | Scenario): void;
+    set socket(socket: WhatsappSocket);
+    get socket(): WhatsappSocket;
+    private sendMessageList;
+    private getFlow;
+    private setFlow;
+    private resetFlow;
+    private getDataFlow;
+    private getLastMessages;
+    private setDataFlow;
+    private resetDataFlow;
+    private setTimeoutFlow;
+    private resetTimeoutFlow;
+    private getResponseId;
+    private onMessageReceivedCB;
+    onMessageReceived(): void;
 }
 
-export { WhatsappSocket, WhatsappSocketGroup, type WhatsappSocketGroupProps, type WhatsappSocketProps };
+export { type BotSchema, WhatsappSocket, WhatsappSocketBot, WhatsappSocketGroup, type WhatsappSocketGroupProps, type WhatsappSocketProps };