meta-cloud-api 0.2.17 → 0.2.19

package/dist/core/webhook/index.d.ts

@@ -0,0 +1,630 @@
+import { M as MessageTypesEnum } from '../../enums-CL4CRQAe.js';
+import { WhatsAppConfig } from '../../shared/types/config.js';
+import { IncomingMessage } from 'http';
+import { f as FlowEndpointRequest, m as FlowTypeEnum } from '../../FlowApi-OEAji2dP.js';
+import { WhatsApp } from '../whatsapp/index.js';
+import '../../base-B4QLc9vb.js';
+import '../../MessageApi-BQhqbAOY.js';
+import '../../MediaApi-C2-eC3BR.js';
+import '../../BusinessProfileApi-BjOyDR-8.js';
+import '../../EncryptionApi-B3hzgZwc.js';
+import '../../PhoneNumberApi-BgfYrui-.js';
+import '../../RegistrationApi-BSDXRJlL.js';
+import '../../TemplateApi-B7dTBIlN.js';
+import '../../QrCodeApi-CimaUuYP.js';
+import '../../TwoStepVerificationApi-BY0eD8R2.js';
+import '../../WabaApi-BFbVUUlw.js';
+import 'https';
+
+interface WebhookContact {
+    /**
+     * WhatsApp ID of the contact. Business can respond to this contact using this ID.
+     */
+    wa_id: string;
+    /**
+     *  Additional unique, alphanumeric identifier for a WhatsApp user
+     */
+    user_id?: string;
+    /**
+     * Profile of Whatsapp user
+     */
+    profile: {
+        /**
+         * The display name of the contact
+         */
+        name: string;
+    };
+}
+/**
+ * Represents a message received through the webhook
+ * Based on Meta's documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object
+ */
+interface WebhookMessage {
+    /**
+     * The message ID
+     */
+    id: string;
+    /**
+     * The sender's phone number
+     */
+    from: string;
+    /**
+     * The timestamp of the message
+     */
+    timestamp: string;
+    /**
+     * The type of message (text, image, etc.)
+     */
+    type: MessageTypesEnum;
+    /**
+     * The phone number ID that received the message
+     */
+    phoneNumberId: string;
+    /**
+     * The display phone number that received the message
+     */
+    displayPhoneNumber: string;
+    /**
+     * The profile name of the sender
+     */
+    profileName: string;
+    /**
+     * Text object for text messages
+     */
+    text?: {
+        /**
+         * The text content of the message
+         */
+        body: string;
+    };
+    /**
+     * Image object for image messages
+     */
+    image?: {
+        /**
+         * The image caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The SHA256 hash of the image
+         */
+        sha256?: string;
+        /**
+         * The ID for the image
+         */
+        id: string;
+        /**
+         * The MIME type of the image
+         */
+        mime_type: string;
+    };
+    /**
+     * Video object for video messages
+     */
+    video?: {
+        /**
+         * The video caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The SHA256 hash of the video
+         */
+        sha256?: string;
+        /**
+         * The ID for the video
+         */
+        id: string;
+        /**
+         * The MIME type of the video
+         */
+        mime_type: string;
+    };
+    /**
+     * Audio object for audio messages
+     */
+    audio?: {
+        /**
+         * The ID for the audio file
+         */
+        id: string;
+        /**
+         * The MIME type of the audio file
+         */
+        mime_type: string;
+        /**
+         * Whether the audio is a voice message
+         */
+        voice?: boolean;
+    };
+    /**
+     * Document object for document messages
+     */
+    document?: {
+        /**
+         * The document caption (if provided)
+         */
+        caption?: string;
+        /**
+         * The document filename
+         */
+        filename: string;
+        /**
+         * The SHA256 hash of the document
+         */
+        sha256?: string;
+        /**
+         * The ID for the document
+         */
+        id: string;
+        /**
+         * The MIME type of the document
+         */
+        mime_type: string;
+    };
+    /**
+     * Sticker object for sticker messages
+     */
+    sticker?: {
+        /**
+         * The ID for the sticker
+         */
+        id: string;
+        /**
+         * Whether this is an animated sticker
+         */
+        animated: boolean;
+        /**
+         * The MIME type of the sticker
+         */
+        mime_type: string;
+    };
+    /**
+     * Reaction object for reaction messages
+     */
+    reaction?: {
+        /**
+         * The ID of the message being reacted to
+         */
+        message_id: string;
+        /**
+         * Emoji used for the reaction
+         */
+        emoji: string;
+    };
+    /**
+     * Contacts object for contact messages
+     */
+    contacts?: Array<{
+        /**
+         * The contact's name
+         */
+        name: {
+            /**
+             * The formatted name
+             */
+            formatted_name: string;
+            /**
+             * The first name
+             */
+            first_name?: string;
+            /**
+             * The last name
+             */
+            last_name?: string;
+            /**
+             * The middle name
+             */
+            middle_name?: string;
+            /**
+             * The suffix
+             */
+            suffix?: string;
+            /**
+             * The prefix
+             */
+            prefix?: string;
+        };
+        /**
+         * The contact's phone numbers
+         */
+        phones?: Array<{
+            phone: string;
+            type?: string;
+            wa_id?: string;
+        }>;
+        /**
+         * The contact's emails
+         */
+        emails?: Array<{
+            email: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's addresses
+         */
+        addresses?: Array<{
+            street?: string;
+            city?: string;
+            state?: string;
+            zip?: string;
+            country?: string;
+            country_code?: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's organizations
+         */
+        org?: {
+            company?: string;
+            department?: string;
+            title?: string;
+        };
+        /**
+         * The contact's URLs
+         */
+        urls?: Array<{
+            url: string;
+            type?: string;
+        }>;
+        /**
+         * The contact's birthday (YYYY-MM-DD format)
+         */
+        birthday?: string;
+    }>;
+    /**
+     * Location object for location messages
+     */
+    location?: {
+        /**
+         * Latitude of the location
+         */
+        latitude: number;
+        /**
+         * Longitude of the location
+         */
+        longitude: number;
+        /**
+         * Name of the location
+         */
+        name?: string;
+        /**
+         * Address of the location
+         */
+        address?: string;
+    };
+    /**
+     * Interactive object for interactive messages
+     */
+    interactive?: {
+        /**
+         * Type of the interactive message
+         * Can be: button_reply, list_reply, flow, nfm_reply, etc.
+         */
+        type: string;
+        /**
+         * ID for the button that was clicked
+         */
+        button_reply?: {
+            id: string;
+            title: string;
+        };
+        /**
+         * ID for the list item that was selected
+         */
+        list_reply?: {
+            id: string;
+            title: string;
+            description?: string;
+        };
+        /**
+         * NFM (No-Code Flow Message) reply data
+         */
+        nfm_reply?: {
+            /**
+             * Response data in JSON format
+             */
+            response_json: string;
+            /**
+             * Body text of the reply
+             */
+            body: string;
+            /**
+             * Name of the flow
+             */
+            name: string;
+        };
+    };
+    /**
+     * System object for system messages (like user phone number changes)
+     */
+    system?: {
+        /**
+         * The type of system update
+         */
+        type: string;
+        /**
+         * User's identity if the update is a customer identity change
+         */
+        identity?: string;
+        /**
+         * Old and new phone numbers if the update is a phone number change
+         */
+        customer?: {
+            /**
+             * The previous phone number
+             */
+            previous_wa_id: string;
+            /**
+             * The new phone number
+             */
+            wa_id: string;
+        };
+    };
+    /**
+     * Order object for order messages
+     */
+    order?: {
+        /**
+         * Catalog ID
+         */
+        catalog_id: string;
+        /**
+         * Product items in the order
+         */
+        product_items: Array<{
+            /**
+             * Product ID
+             */
+            product_retailer_id: string;
+            /**
+             * Quantity of the product
+             */
+            quantity: number;
+            /**
+             * Item price
+             */
+            item_price: number;
+            /**
+             * Currency code
+             */
+            currency: string;
+        }>;
+        /**
+         * Text message included with the order
+         */
+        text?: string;
+    };
+    /**
+     * Context object, included when a user replies or interacts
+     */
+    context?: {
+        /**
+         * ID of the message
+         */
+        id?: string;
+        /**
+         * ID of the sender
+         */
+        from?: string;
+        /**
+         * ID of the message being replied to or interacted with
+         */
+        message_id: string;
+        /**
+         * ID of the forwarded message, if applicable
+         */
+        forwarded?: boolean;
+        /**
+         * Frequently forwarded status
+         */
+        frequently_forwarded?: boolean;
+        /**
+         * Original message information if the message was referred
+         */
+        referred_product?: {
+            /**
+             * Catalog ID
+             */
+            catalog_id: string;
+            /**
+             * Product ID
+             */
+            product_retailer_id: string;
+        };
+    };
+    /**
+     * Errors array, if the message had errors
+     */
+    errors?: Array<{
+        /**
+         * Error code
+         */
+        code: number;
+        /**
+         * Error title
+         */
+        title: string;
+        /**
+         * Error message
+         */
+        message: string;
+        /**
+         * Error details object
+         */
+        error_data?: {
+            /**
+             * Describes the error details
+             */
+            details: string;
+        };
+    }>;
+    /**
+     * Button object for button messages
+     */
+    button?: {
+        /**
+         * The payload for the button
+         */
+        payload: string;
+        /**
+         * Button text
+         */
+        text: string;
+    };
+    /**
+     * The original message data as received from the webhook
+     */
+    originalData: any;
+}
+/**
+ * Webhook event received from WhatsApp
+ */
+interface WebhookEvent {
+    /**
+     * The field type of the event
+     */
+    field: string;
+    /**
+     * The event data
+     */
+    value: any;
+    /**
+     * The timestamp when the event was received
+     */
+    timestamp: number;
+}
+/**
+ * Message handler function type
+ */
+type MessageHandler = (message: WebhookMessage) => void | Promise<void>;
+/**
+ * Event handler function type
+ */
+type EventHandler = (event: WebhookEvent) => void | Promise<void>;
+/**
+ * Message status enum
+ */
+declare enum MessageStatus {
+    DELIVERED = "delivered",
+    READ = "read",
+    SENT = "sent"
+}
+/**
+ * Event field enum for webhook events
+ */
+declare enum EventField {
+    MESSAGES = "messages",
+    STATUSES = "statuses",
+    MESSAGE_TEMPLATE_STATUS_UPDATE = "message_template_status_update",
+    PHONE_NUMBER_QUALITY_UPDATE = "phone_number_quality_update",
+    PHONE_NUMBER_NAME_UPDATE = "phone_number_name_update",
+    UNKNOWN = "unknown"
+}
+
+interface IRequest extends IncomingMessage {
+    body: any;
+    query: Record<string, any>;
+    method?: string;
+}
+interface IResponse {
+    status: (code: number) => IResponse;
+    send: (body: any) => IResponse | void;
+    json: (body: any) => IResponse | void;
+    end: () => void;
+}
+/**
+ * Webhook handler for WhatsApp Cloud API
+ */
+declare class WebhookHandler {
+    private config;
+    private client;
+    private messageHandlers;
+    private eventHandlers;
+    private preProcessHandler;
+    private postProcessHandler;
+    private flowHandlers;
+    /**
+     * Create a new WebhookHandler
+     * @param config The WhatsApp configuration
+     */
+    constructor(config: WhatsAppConfig);
+    /**
+     * Handle a GET request for webhook verification
+     */
+    handleVerificationRequest<Req extends IRequest, Res extends IResponse>(req: Req, res: Res): void;
+    handleVerificationRequest<Req extends IRequest>(req: Req): string;
+    /**
+     * Handle a POST request for webhook events
+     */
+    handleWebhookRequest<Req extends IRequest, Res extends IResponse>(req: Req, res: Res): Promise<void>;
+    handleWebhookRequest<Req extends IRequest>(req: Req): Promise<{
+        success: boolean;
+        errors?: string[];
+    }>;
+    /**
+     * Handle webhook requests (both verification and events)
+     */
+    handleRequest<Req extends IRequest, Res extends IResponse>(req: Req, res: Res): void | Promise<void>;
+    handleRequest<Req extends IRequest>(req: Req): string | Promise<{
+        success: boolean;
+        errors?: string[];
+    }>;
+    /**
+     * Process incoming messages
+     */
+    private processMessages;
+    /**
+     * Process other webhook events
+     */
+    private processEvent;
+    /**
+     * Register a message handler for a specific message type
+     */
+    onMessage(type: MessageTypesEnum, handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
+    /**
+     * Register an event handler for a specific field
+     */
+    onEvent(field: string, handler: (event: WebhookEvent) => void | Promise<void>): void;
+    /**
+     * Register a pre-process handler that runs before all message handlers
+     */
+    onMessagePreProcess(handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
+    /**
+     * Register a post-process handler that runs after all message handlers
+     */
+    onMessagePostProcess(handler: (whatsapp: WhatsApp, message: WebhookMessage) => void | Promise<void>): void;
+    handleFlowRequest<Req extends IRequest & {
+        rawBody: string;
+    }, Res extends IResponse>(req: Req, res: Res): Promise<void>;
+    handleFlowRequest<Req extends IRequest & {
+        rawBody: string;
+    }>(req: Req): Promise<{
+        statusCode: number;
+        body: any;
+        headers?: Record<string, string>;
+    }>;
+    /**
+     * Validate the request signature
+     */
+    isRequestSignatureValid(req: IRequest & {
+        rawBody: string;
+    }): boolean;
+    /**
+     * Decrypt a flow request
+     */
+    decryptRequest(body: any): {
+        decryptedBody: FlowEndpointRequest;
+        aesKeyBuffer: Buffer;
+        initialVectorBuffer: Buffer;
+    };
+    /**
+     * Encrypt a flow response
+     */
+    private encryptResponse;
+    /**
+     * Register a flow handler for a specific flow type
+     */
+    onFlow(type: FlowTypeEnum, handler: (whatsapp: WhatsApp, request: FlowEndpointRequest) => any | Promise<any>): void;
+}
+
+export { EventField, type EventHandler, type IRequest, type IResponse, type MessageHandler, MessageStatus, type WebhookContact, type WebhookEvent, WebhookHandler, type WebhookMessage };

package/dist/core/webhook/index.js

@@ -0,0 +1,2 @@
+export{b as EventField,a as MessageStatus,c as WebhookHandler}from'../../chunk-34SVEEB7.js';import'../../chunk-BSNA6RYF.js';import'../../chunk-3MO3BTBC.js';import'../../chunk-R36L2XYO.js';import'../../chunk-GT3XQN7Y.js';import'../../chunk-O2OTHNWM.js';import'../../chunk-7NQLQPLH.js';import'../../chunk-UQPD6GIF.js';import'../../chunk-5JGM556C.js';import'../../chunk-2NJVBJUN.js';import'../../chunk-XPPDOFBN.js';import'../../chunk-KFPOVYEJ.js';import'../../chunk-7GL74SXM.js';import'../../chunk-A264MT4Q.js';import'../../chunk-GIQLIMOD.js';import'../../chunk-BZ5QDXNR.js';import'../../chunk-VW3LGHTJ.js';import'../../chunk-EYGUX4EA.js';import'../../chunk-4C666HHU.js';//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/core/webhook/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"index.js"}