meta-cloud-api 0.1.9 → 0.1.11

package/dist/types/webhook.d.ts

@@ -0,0 +1,436 @@
+/**
+ * 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: MessageType;
+    /**
+     * The phone number ID that received the message
+     */
+    phoneNumberId: 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;
+    };
+    /**
+     * Contacts object for contact messages
+     */
+    contacts?: Array<{
+        /**
+         * The contact's name
+         */
+        name: {
+            formatted_name: string;
+            first_name?: string;
+            last_name?: string;
+            middle_name?: string;
+            suffix?: string;
+            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
+         */
+        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;
+        };
+    };
+    /**
+     * 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 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;
+}
+/**
+ * Represents a non-message event received through the webhook
+ */
+interface WebhookEvent {
+    /**
+     * The field type of the event
+     */
+    field: string;
+    /**
+     * The event data
+     */
+    value: any;
+}
+/**
+ * Handler function for processing messages
+ */
+type MessageHandler = (message: WebhookMessage) => void | Promise<void>;
+/**
+ * Handler function for processing events
+ */
+type EventHandler = (event: WebhookEvent) => void | Promise<void>;
+/**
+ * Message types that can be received through the webhook
+ */
+declare enum MessageType {
+    TEXT = "text",
+    IMAGE = "image",
+    AUDIO = "audio",
+    VIDEO = "video",
+    DOCUMENT = "document",
+    STICKER = "sticker",
+    LOCATION = "location",
+    CONTACTS = "contacts",
+    BUTTON = "button",
+    INTERACTIVE = "interactive",
+    ORDER = "order",
+    SYSTEM = "system",
+    UNKNOWN = "unknown"
+}
+/**
+ * Statuses that can be received in status updates
+ */
+declare enum MessageStatus {
+    DELIVERED = "delivered",
+    READ = "read",
+    SENT = "sent"
+}
+/**
+ * Event fields that can be received through the webhook
+ */
+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"
+}
+
+export { EventField, type EventHandler, type MessageHandler, MessageStatus, MessageType, type WebhookEvent, type WebhookMessage };

package/dist/types/webhook.js

@@ -0,0 +1,2 @@
+"use strict";var a=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var u=Object.getOwnPropertyNames;var c=Object.prototype.hasOwnProperty;var p=(i,r)=>{for(var o in r)a(i,o,{get:r[o],enumerable:!0})},l=(i,r,o,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let s of u(r))!c.call(i,s)&&s!==o&&a(i,s,{get:()=>r[s],enumerable:!(n=_(r,s))||n.enumerable});return i};var y=i=>l(a({},"__esModule",{value:!0}),i);var E={};p(E,{EventField:()=>m,MessageStatus:()=>d,MessageType:()=>g});module.exports=y(E);var g=(t=>(t.TEXT="text",t.IMAGE="image",t.AUDIO="audio",t.VIDEO="video",t.DOCUMENT="document",t.STICKER="sticker",t.LOCATION="location",t.CONTACTS="contacts",t.BUTTON="button",t.INTERACTIVE="interactive",t.ORDER="order",t.SYSTEM="system",t.UNKNOWN="unknown",t))(g||{}),d=(n=>(n.DELIVERED="delivered",n.READ="read",n.SENT="sent",n))(d||{}),m=(e=>(e.MESSAGES="messages",e.STATUSES="statuses",e.MESSAGE_TEMPLATE_STATUS_UPDATE="message_template_status_update",e.PHONE_NUMBER_QUALITY_UPDATE="phone_number_quality_update",e.PHONE_NUMBER_NAME_UPDATE="phone_number_name_update",e.UNKNOWN="unknown",e))(m||{});0&&(module.exports={EventField,MessageStatus,MessageType});
+//# sourceMappingURL=webhook.js.map

package/dist/types/webhook.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/webhook.ts"],"sourcesContent":["/**\n * Represents a message received through the webhook\n * Based on Meta's documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object\n */\nexport interface WebhookMessage {\n    /**\n     * The message ID\n     */\n    id: string;\n\n    /**\n     * The sender's phone number\n     */\n    from: string;\n\n    /**\n     * The timestamp of the message\n     */\n    timestamp: string;\n\n    /**\n     * The type of message (text, image, etc.)\n     */\n    type: MessageType;\n\n    /**\n     * The phone number ID that received the message\n     */\n    phoneNumberId: string;\n\n    /**\n     * Text object for text messages\n     */\n    text?: {\n        /**\n         * The text content of the message\n         */\n        body: string;\n    };\n\n    /**\n     * Image object for image messages\n     */\n    image?: {\n        /**\n         * The image caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The SHA256 hash of the image\n         */\n        sha256?: string;\n        /**\n         * The ID for the image\n         */\n        id: string;\n        /**\n         * The MIME type of the image\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Video object for video messages\n     */\n    video?: {\n        /**\n         * The video caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The SHA256 hash of the video\n         */\n        sha256?: string;\n        /**\n         * The ID for the video\n         */\n        id: string;\n        /**\n         * The MIME type of the video\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Audio object for audio messages\n     */\n    audio?: {\n        /**\n         * The ID for the audio file\n         */\n        id: string;\n        /**\n         * The MIME type of the audio file\n         */\n        mime_type: string;\n        /**\n         * Whether the audio is a voice message\n         */\n        voice?: boolean;\n    };\n\n    /**\n     * Document object for document messages\n     */\n    document?: {\n        /**\n         * The document caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The document filename\n         */\n        filename: string;\n        /**\n         * The SHA256 hash of the document\n         */\n        sha256?: string;\n        /**\n         * The ID for the document\n         */\n        id: string;\n        /**\n         * The MIME type of the document\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Sticker object for sticker messages\n     */\n    sticker?: {\n        /**\n         * The ID for the sticker\n         */\n        id: string;\n        /**\n         * Whether this is an animated sticker\n         */\n        animated: boolean;\n        /**\n         * The MIME type of the sticker\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Contacts object for contact messages\n     */\n    contacts?: Array<{\n        /**\n         * The contact's name\n         */\n        name: {\n            formatted_name: string;\n            first_name?: string;\n            last_name?: string;\n            middle_name?: string;\n            suffix?: string;\n            prefix?: string;\n        };\n        /**\n         * The contact's phone numbers\n         */\n        phones?: Array<{\n            phone: string;\n            type?: string;\n            wa_id?: string;\n        }>;\n        /**\n         * The contact's emails\n         */\n        emails?: Array<{\n            email: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's addresses\n         */\n        addresses?: Array<{\n            street?: string;\n            city?: string;\n            state?: string;\n            zip?: string;\n            country?: string;\n            country_code?: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's organizations\n         */\n        org?: {\n            company?: string;\n            department?: string;\n            title?: string;\n        };\n        /**\n         * The contact's URLs\n         */\n        urls?: Array<{\n            url: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's birthday (YYYY-MM-DD format)\n         */\n        birthday?: string;\n    }>;\n\n    /**\n     * Location object for location messages\n     */\n    location?: {\n        /**\n         * Latitude of the location\n         */\n        latitude: number;\n        /**\n         * Longitude of the location\n         */\n        longitude: number;\n        /**\n         * Name of the location\n         */\n        name?: string;\n        /**\n         * Address of the location\n         */\n        address?: string;\n    };\n\n    /**\n     * Interactive object for interactive messages\n     */\n    interactive?: {\n        /**\n         * Type of the interactive message\n         */\n        type: string;\n        /**\n         * ID for the button that was clicked\n         */\n        button_reply?: {\n            id: string;\n            title: string;\n        };\n        /**\n         * ID for the list item that was selected\n         */\n        list_reply?: {\n            id: string;\n            title: string;\n            description?: string;\n        };\n    };\n\n    /**\n     * System object for system messages (like user phone number changes)\n     */\n    system?: {\n        /**\n         * The type of system update\n         */\n        type: string;\n        /**\n         * User's identity if the update is a customer identity change\n         */\n        identity?: string;\n        /**\n         * Old and new phone numbers if the update is a phone number change\n         */\n        customer?: {\n            /**\n             * The previous phone number\n             */\n            previous_wa_id: string;\n            /**\n             * The new phone number\n             */\n            wa_id: string;\n        };\n    };\n\n    /**\n     * Order object for order messages\n     */\n    order?: {\n        /**\n         * Catalog ID\n         */\n        catalog_id: string;\n        /**\n         * Product items in the order\n         */\n        product_items: Array<{\n            /**\n             * Product ID\n             */\n            product_retailer_id: string;\n            /**\n             * Quantity of the product\n             */\n            quantity: number;\n            /**\n             * Item price\n             */\n            item_price: number;\n            /**\n             * Currency code\n             */\n            currency: string;\n        }>;\n        /**\n         * Text message included with the order\n         */\n        text?: string;\n    };\n\n    /**\n     * Context object, included when a user replies or interacts\n     */\n    context?: {\n        /**\n         * ID of the message being replied to or interacted with\n         */\n        message_id: string;\n        /**\n         * ID of the forwarded message, if applicable\n         */\n        forwarded?: boolean;\n        /**\n         * Frequently forwarded status\n         */\n        frequently_forwarded?: boolean;\n        /**\n         * Original message information if the message was referred\n         */\n        referred_product?: {\n            /**\n             * Catalog ID\n             */\n            catalog_id: string;\n            /**\n             * Product ID\n             */\n            product_retailer_id: string;\n        };\n    };\n\n    /**\n     * Errors array, if the message had errors\n     */\n    errors?: Array<{\n        /**\n         * Error code\n         */\n        code: number;\n        /**\n         * Error title\n         */\n        title: string;\n        /**\n         * Error message\n         */\n        message: string;\n        /**\n         * Error details object\n         */\n        error_data?: {\n            /**\n             * Describes the error details\n             */\n            details: string;\n        };\n    }>;\n\n    /**\n     * Button object for button messages\n     */\n    button?: {\n        /**\n         * The payload for the button\n         */\n        payload: string;\n        /**\n         * Button text\n         */\n        text: string;\n    };\n\n    /**\n     * The original message data as received from the webhook\n     */\n    originalData: any;\n}\n\n/**\n * Represents a non-message event received through the webhook\n */\nexport interface WebhookEvent {\n    /**\n     * The field type of the event\n     */\n    field: string;\n\n    /**\n     * The event data\n     */\n    value: any;\n}\n\n/**\n * Handler function for processing messages\n */\nexport type MessageHandler = (message: WebhookMessage) => void | Promise<void>;\n\n/**\n * Handler function for processing events\n */\nexport type EventHandler = (event: WebhookEvent) => void | Promise<void>;\n\n/**\n * Message types that can be received through the webhook\n */\nexport enum MessageType {\n    TEXT = 'text',\n    IMAGE = 'image',\n    AUDIO = 'audio',\n    VIDEO = 'video',\n    DOCUMENT = 'document',\n    STICKER = 'sticker',\n    LOCATION = 'location',\n    CONTACTS = 'contacts',\n    BUTTON = 'button',\n    INTERACTIVE = 'interactive',\n    ORDER = 'order',\n    SYSTEM = 'system',\n    UNKNOWN = 'unknown',\n}\n\n/**\n * Statuses that can be received in status updates\n */\nexport enum MessageStatus {\n    DELIVERED = 'delivered',\n    READ = 'read',\n    SENT = 'sent',\n}\n\n/**\n * Event fields that can be received through the webhook\n */\nexport enum EventField {\n    MESSAGES = 'messages',\n    STATUSES = 'statuses',\n    MESSAGE_TEMPLATE_STATUS_UPDATE = 'message_template_status_update',\n    PHONE_NUMBER_QUALITY_UPDATE = 'phone_number_quality_update',\n    PHONE_NUMBER_NAME_UPDATE = 'phone_number_name_update',\n    UNKNOWN = 'unknown',\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,gBAAAE,EAAA,kBAAAC,EAAA,gBAAAC,IAAA,eAAAC,EAAAL,GAwaO,IAAKI,OACRA,EAAA,KAAO,OACPA,EAAA,MAAQ,QACRA,EAAA,MAAQ,QACRA,EAAA,MAAQ,QACRA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,SAAW,WACXA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,YAAc,cACdA,EAAA,MAAQ,QACRA,EAAA,OAAS,SACTA,EAAA,QAAU,UAbFA,OAAA,IAmBAD,OACRA,EAAA,UAAY,YACZA,EAAA,KAAO,OACPA,EAAA,KAAO,OAHCA,OAAA,IASAD,OACRA,EAAA,SAAW,WACXA,EAAA,SAAW,WACXA,EAAA,+BAAiC,iCACjCA,EAAA,4BAA8B,8BAC9BA,EAAA,yBAA2B,2BAC3BA,EAAA,QAAU,UANFA,OAAA","names":["webhook_exports","__export","EventField","MessageStatus","MessageType","__toCommonJS"]}

package/dist/types/webhook.mjs

@@ -0,0 +1,2 @@
+var n=(t=>(t.TEXT="text",t.IMAGE="image",t.AUDIO="audio",t.VIDEO="video",t.DOCUMENT="document",t.STICKER="sticker",t.LOCATION="location",t.CONTACTS="contacts",t.BUTTON="button",t.INTERACTIVE="interactive",t.ORDER="order",t.SYSTEM="system",t.UNKNOWN="unknown",t))(n||{}),e=(i=>(i.DELIVERED="delivered",i.READ="read",i.SENT="sent",i))(e||{}),s=(r=>(r.MESSAGES="messages",r.STATUSES="statuses",r.MESSAGE_TEMPLATE_STATUS_UPDATE="message_template_status_update",r.PHONE_NUMBER_QUALITY_UPDATE="phone_number_quality_update",r.PHONE_NUMBER_NAME_UPDATE="phone_number_name_update",r.UNKNOWN="unknown",r))(s||{});export{s as EventField,e as MessageStatus,n as MessageType};
+//# sourceMappingURL=webhook.mjs.map

package/dist/types/webhook.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/types/webhook.ts"],"sourcesContent":["/**\n * Represents a message received through the webhook\n * Based on Meta's documentation: https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components#messages-object\n */\nexport interface WebhookMessage {\n    /**\n     * The message ID\n     */\n    id: string;\n\n    /**\n     * The sender's phone number\n     */\n    from: string;\n\n    /**\n     * The timestamp of the message\n     */\n    timestamp: string;\n\n    /**\n     * The type of message (text, image, etc.)\n     */\n    type: MessageType;\n\n    /**\n     * The phone number ID that received the message\n     */\n    phoneNumberId: string;\n\n    /**\n     * Text object for text messages\n     */\n    text?: {\n        /**\n         * The text content of the message\n         */\n        body: string;\n    };\n\n    /**\n     * Image object for image messages\n     */\n    image?: {\n        /**\n         * The image caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The SHA256 hash of the image\n         */\n        sha256?: string;\n        /**\n         * The ID for the image\n         */\n        id: string;\n        /**\n         * The MIME type of the image\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Video object for video messages\n     */\n    video?: {\n        /**\n         * The video caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The SHA256 hash of the video\n         */\n        sha256?: string;\n        /**\n         * The ID for the video\n         */\n        id: string;\n        /**\n         * The MIME type of the video\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Audio object for audio messages\n     */\n    audio?: {\n        /**\n         * The ID for the audio file\n         */\n        id: string;\n        /**\n         * The MIME type of the audio file\n         */\n        mime_type: string;\n        /**\n         * Whether the audio is a voice message\n         */\n        voice?: boolean;\n    };\n\n    /**\n     * Document object for document messages\n     */\n    document?: {\n        /**\n         * The document caption (if provided)\n         */\n        caption?: string;\n        /**\n         * The document filename\n         */\n        filename: string;\n        /**\n         * The SHA256 hash of the document\n         */\n        sha256?: string;\n        /**\n         * The ID for the document\n         */\n        id: string;\n        /**\n         * The MIME type of the document\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Sticker object for sticker messages\n     */\n    sticker?: {\n        /**\n         * The ID for the sticker\n         */\n        id: string;\n        /**\n         * Whether this is an animated sticker\n         */\n        animated: boolean;\n        /**\n         * The MIME type of the sticker\n         */\n        mime_type: string;\n    };\n\n    /**\n     * Contacts object for contact messages\n     */\n    contacts?: Array<{\n        /**\n         * The contact's name\n         */\n        name: {\n            formatted_name: string;\n            first_name?: string;\n            last_name?: string;\n            middle_name?: string;\n            suffix?: string;\n            prefix?: string;\n        };\n        /**\n         * The contact's phone numbers\n         */\n        phones?: Array<{\n            phone: string;\n            type?: string;\n            wa_id?: string;\n        }>;\n        /**\n         * The contact's emails\n         */\n        emails?: Array<{\n            email: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's addresses\n         */\n        addresses?: Array<{\n            street?: string;\n            city?: string;\n            state?: string;\n            zip?: string;\n            country?: string;\n            country_code?: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's organizations\n         */\n        org?: {\n            company?: string;\n            department?: string;\n            title?: string;\n        };\n        /**\n         * The contact's URLs\n         */\n        urls?: Array<{\n            url: string;\n            type?: string;\n        }>;\n        /**\n         * The contact's birthday (YYYY-MM-DD format)\n         */\n        birthday?: string;\n    }>;\n\n    /**\n     * Location object for location messages\n     */\n    location?: {\n        /**\n         * Latitude of the location\n         */\n        latitude: number;\n        /**\n         * Longitude of the location\n         */\n        longitude: number;\n        /**\n         * Name of the location\n         */\n        name?: string;\n        /**\n         * Address of the location\n         */\n        address?: string;\n    };\n\n    /**\n     * Interactive object for interactive messages\n     */\n    interactive?: {\n        /**\n         * Type of the interactive message\n         */\n        type: string;\n        /**\n         * ID for the button that was clicked\n         */\n        button_reply?: {\n            id: string;\n            title: string;\n        };\n        /**\n         * ID for the list item that was selected\n         */\n        list_reply?: {\n            id: string;\n            title: string;\n            description?: string;\n        };\n    };\n\n    /**\n     * System object for system messages (like user phone number changes)\n     */\n    system?: {\n        /**\n         * The type of system update\n         */\n        type: string;\n        /**\n         * User's identity if the update is a customer identity change\n         */\n        identity?: string;\n        /**\n         * Old and new phone numbers if the update is a phone number change\n         */\n        customer?: {\n            /**\n             * The previous phone number\n             */\n            previous_wa_id: string;\n            /**\n             * The new phone number\n             */\n            wa_id: string;\n        };\n    };\n\n    /**\n     * Order object for order messages\n     */\n    order?: {\n        /**\n         * Catalog ID\n         */\n        catalog_id: string;\n        /**\n         * Product items in the order\n         */\n        product_items: Array<{\n            /**\n             * Product ID\n             */\n            product_retailer_id: string;\n            /**\n             * Quantity of the product\n             */\n            quantity: number;\n            /**\n             * Item price\n             */\n            item_price: number;\n            /**\n             * Currency code\n             */\n            currency: string;\n        }>;\n        /**\n         * Text message included with the order\n         */\n        text?: string;\n    };\n\n    /**\n     * Context object, included when a user replies or interacts\n     */\n    context?: {\n        /**\n         * ID of the message being replied to or interacted with\n         */\n        message_id: string;\n        /**\n         * ID of the forwarded message, if applicable\n         */\n        forwarded?: boolean;\n        /**\n         * Frequently forwarded status\n         */\n        frequently_forwarded?: boolean;\n        /**\n         * Original message information if the message was referred\n         */\n        referred_product?: {\n            /**\n             * Catalog ID\n             */\n            catalog_id: string;\n            /**\n             * Product ID\n             */\n            product_retailer_id: string;\n        };\n    };\n\n    /**\n     * Errors array, if the message had errors\n     */\n    errors?: Array<{\n        /**\n         * Error code\n         */\n        code: number;\n        /**\n         * Error title\n         */\n        title: string;\n        /**\n         * Error message\n         */\n        message: string;\n        /**\n         * Error details object\n         */\n        error_data?: {\n            /**\n             * Describes the error details\n             */\n            details: string;\n        };\n    }>;\n\n    /**\n     * Button object for button messages\n     */\n    button?: {\n        /**\n         * The payload for the button\n         */\n        payload: string;\n        /**\n         * Button text\n         */\n        text: string;\n    };\n\n    /**\n     * The original message data as received from the webhook\n     */\n    originalData: any;\n}\n\n/**\n * Represents a non-message event received through the webhook\n */\nexport interface WebhookEvent {\n    /**\n     * The field type of the event\n     */\n    field: string;\n\n    /**\n     * The event data\n     */\n    value: any;\n}\n\n/**\n * Handler function for processing messages\n */\nexport type MessageHandler = (message: WebhookMessage) => void | Promise<void>;\n\n/**\n * Handler function for processing events\n */\nexport type EventHandler = (event: WebhookEvent) => void | Promise<void>;\n\n/**\n * Message types that can be received through the webhook\n */\nexport enum MessageType {\n    TEXT = 'text',\n    IMAGE = 'image',\n    AUDIO = 'audio',\n    VIDEO = 'video',\n    DOCUMENT = 'document',\n    STICKER = 'sticker',\n    LOCATION = 'location',\n    CONTACTS = 'contacts',\n    BUTTON = 'button',\n    INTERACTIVE = 'interactive',\n    ORDER = 'order',\n    SYSTEM = 'system',\n    UNKNOWN = 'unknown',\n}\n\n/**\n * Statuses that can be received in status updates\n */\nexport enum MessageStatus {\n    DELIVERED = 'delivered',\n    READ = 'read',\n    SENT = 'sent',\n}\n\n/**\n * Event fields that can be received through the webhook\n */\nexport enum EventField {\n    MESSAGES = 'messages',\n    STATUSES = 'statuses',\n    MESSAGE_TEMPLATE_STATUS_UPDATE = 'message_template_status_update',\n    PHONE_NUMBER_QUALITY_UPDATE = 'phone_number_quality_update',\n    PHONE_NUMBER_NAME_UPDATE = 'phone_number_name_update',\n    UNKNOWN = 'unknown',\n}\n"],"mappings":"AAwaO,IAAKA,OACRA,EAAA,KAAO,OACPA,EAAA,MAAQ,QACRA,EAAA,MAAQ,QACRA,EAAA,MAAQ,QACRA,EAAA,SAAW,WACXA,EAAA,QAAU,UACVA,EAAA,SAAW,WACXA,EAAA,SAAW,WACXA,EAAA,OAAS,SACTA,EAAA,YAAc,cACdA,EAAA,MAAQ,QACRA,EAAA,OAAS,SACTA,EAAA,QAAU,UAbFA,OAAA,IAmBAC,OACRA,EAAA,UAAY,YACZA,EAAA,KAAO,OACPA,EAAA,KAAO,OAHCA,OAAA,IASAC,OACRA,EAAA,SAAW,WACXA,EAAA,SAAW,WACXA,EAAA,+BAAiC,iCACjCA,EAAA,4BAA8B,8BAC9BA,EAAA,yBAA2B,2BAC3BA,EAAA,QAAU,UANFA,OAAA","names":["MessageType","MessageStatus","EventField"]}

package/dist/utils/filters.d.mts

@@ -0,0 +1,143 @@
+import { MessageType, WebhookMessage } from '../types/webhook.mjs';
+
+/**
+ * Filters for message handling, inspired by PyWa
+ */
+declare const filters: {
+    /**
+     * Filters messages by type
+     * @param type Message type to filter for
+     * @returns A filter function
+     */
+    type: (type: MessageType | string) => ((message: WebhookMessage) => boolean);
+    /**
+     * Filters text messages
+     * @param message Message to check
+     * @returns True if the message is a text message
+     */
+    text: (message: WebhookMessage) => boolean;
+    /**
+     * Filters image messages
+     * @param message Message to check
+     * @returns True if the message is an image message
+     */
+    image: (message: WebhookMessage) => boolean;
+    /**
+     * Filters audio messages
+     * @param message Message to check
+     * @returns True if the message is an audio message
+     */
+    audio: (message: WebhookMessage) => boolean;
+    /**
+     * Filters video messages
+     * @param message Message to check
+     * @returns True if the message is a video message
+     */
+    video: (message: WebhookMessage) => boolean;
+    /**
+     * Filters document messages
+     * @param message Message to check
+     * @returns True if the message is a document message
+     */
+    document: (message: WebhookMessage) => boolean;
+    /**
+     * Filters sticker messages
+     * @param message Message to check
+     * @returns True if the message is a sticker message
+     */
+    sticker: (message: WebhookMessage) => boolean;
+    /**
+     * Filters location messages
+     * @param message Message to check
+     * @returns True if the message is a location message
+     */
+    location: (message: WebhookMessage) => boolean;
+    /**
+     * Filters contact messages
+     * @param message Message to check
+     * @returns True if the message is a contacts message
+     */
+    contacts: (message: WebhookMessage) => boolean;
+    /**
+     * Filters button messages
+     * @param message Message to check
+     * @returns True if the message is a button message
+     */
+    button: (message: WebhookMessage) => boolean;
+    /**
+     * Filters interactive messages
+     * @param message Message to check
+     * @returns True if the message is an interactive message
+     */
+    interactive: (message: WebhookMessage) => boolean;
+    /**
+     * Filters system messages
+     * @param message Message to check
+     * @returns True if the message is a system message
+     */
+    system: (message: WebhookMessage) => boolean;
+    /**
+     * Filters order messages
+     * @param message Message to check
+     * @returns True if the message is an order message
+     */
+    order: (message: WebhookMessage) => boolean;
+    /**
+     * Matches text content against a pattern
+     * @param patterns String or regular expression or array of patterns to match against
+     * @returns A filter function
+     */
+    matches: (patterns: string | RegExp | (string | RegExp)[]) => ((message: WebhookMessage) => boolean);
+    /**
+     * Checks if a message is a reply to another message
+     * @returns A filter function that returns true if the message is a reply
+     */
+    isReply: (message: WebhookMessage) => boolean;
+    /**
+     * Checks if a message is a reply to a specific message
+     * @param messageId The ID of the original message to check for
+     * @returns A filter function that returns true if the message is a reply to the specified message
+     */
+    isReplyTo: (messageId: string) => ((message: WebhookMessage) => boolean);
+    /**
+     * Checks if a message is forwarded
+     * @returns A filter function that returns true if the message is forwarded
+     */
+    isForwarded: (message: WebhookMessage) => boolean;
+    /**
+     * Checks if a message is frequently forwarded
+     * @returns A filter function that returns true if the message is frequently forwarded
+     */
+    isFrequentlyForwarded: (message: WebhookMessage) => boolean;
+    /**
+     * Combines multiple filters with AND logic
+     * @param filterFunctions Array of filter functions to combine
+     * @returns A filter function that returns true only if all filters return true
+     */
+    and: (...filterFunctions: ((message: WebhookMessage) => boolean)[]) => ((message: WebhookMessage) => boolean);
+    /**
+     * Combines multiple filters with OR logic
+     * @param filterFunctions Array of filter functions to combine
+     * @returns A filter function that returns true if any filter returns true
+     */
+    or: (...filterFunctions: ((message: WebhookMessage) => boolean)[]) => ((message: WebhookMessage) => boolean);
+    /**
+     * Negates a filter
+     * @param filterFunction Filter function to negate
+     * @returns A filter function that returns the opposite of the input filter
+     */
+    not: (filterFunction: (message: WebhookMessage) => boolean) => ((message: WebhookMessage) => boolean);
+    /**
+     * Filters messages from a specific sender
+     * @param from Sender phone number to filter for
+     * @returns A filter function
+     */
+    from: (from: string) => ((message: WebhookMessage) => boolean);
+    /**
+     * Filter function that accepts all messages
+     * @returns Always returns true
+     */
+    all: () => ((message: WebhookMessage) => boolean);
+};
+
+export { filters };