integrate-sdk 0.8.30-dev.0 → 0.8.31-dev.0

package/dist/src/integrations/whatsapp-client.d.ts

@@ -0,0 +1,320 @@
+/**
+ * WhatsApp Business Integration Client Types
+ * Fully typed interface for WhatsApp Business integration methods
+ */
+import type { MCPToolCallResponse } from "../protocol/messages.js";
+/**
+ * WhatsApp Message
+ */
+export interface WhatsAppMessage {
+    id: string;
+    from: string;
+    to: string;
+    timestamp: string;
+    type: "text" | "image" | "video" | "audio" | "document" | "template";
+    text?: {
+        body: string;
+    };
+    image?: {
+        id: string;
+        mime_type: string;
+        sha256: string;
+    };
+    video?: {
+        id: string;
+        mime_type: string;
+        sha256: string;
+    };
+    audio?: {
+        id: string;
+        mime_type: string;
+        sha256: string;
+    };
+    document?: {
+        id: string;
+        mime_type: string;
+        sha256: string;
+        filename: string;
+    };
+    status?: "sent" | "delivered" | "read" | "failed";
+}
+/**
+ * WhatsApp Message Template
+ */
+export interface WhatsAppTemplate {
+    id: string;
+    name: string;
+    language: string;
+    status: "approved" | "pending" | "rejected";
+    category: "marketing" | "utility" | "authentication";
+    components: Array<{
+        type: "header" | "body" | "footer" | "button";
+        text?: string;
+        format?: string;
+        example?: {
+            header_text?: string[];
+            body_text?: string[][];
+        };
+    }>;
+}
+/**
+ * WhatsApp Phone Number
+ */
+export interface WhatsAppPhoneNumber {
+    id: string;
+    display_phone_number: string;
+    verified_name: string;
+    code_verification_status: string;
+    quality_rating: "green" | "yellow" | "red";
+    platform_type: string;
+    throughput: {
+        level: string;
+    };
+}
+/**
+ * WhatsApp Business Profile
+ */
+export interface WhatsAppBusinessProfile {
+    about?: string;
+    address?: string;
+    description?: string;
+    email?: string;
+    messaging_product: string;
+    profile_picture_url?: string;
+    websites?: string[];
+    vertical?: string;
+}
+/**
+ * WhatsApp Message Status
+ */
+export interface WhatsAppMessageStatus {
+    id: string;
+    status: "sent" | "delivered" | "read" | "failed";
+    timestamp: string;
+    recipient_id: string;
+    errors?: Array<{
+        code: number;
+        title: string;
+        message: string;
+        error_data?: {
+            details: string;
+        };
+    }>;
+}
+/**
+ * WhatsApp Integration Client Interface
+ * Provides type-safe methods for all WhatsApp Business operations
+ */
+export interface WhatsAppIntegrationClient {
+    /**
+     * Send a text message
+     *
+     * @example
+     * ```typescript
+     * const result = await client.whatsapp.sendMessage({
+     *   to: "+1234567890",
+     *   type: "text",
+     *   text: { body: "Hello, World!" }
+     * });
+     * ```
+     */
+    sendMessage(params: {
+        /** Recipient phone number (E.164 format) */
+        to: string;
+        /** Message type */
+        type: "text";
+        /** Text message content */
+        text: {
+            /** Message body text */
+            body: string;
+            /** Preview URL (optional) */
+            preview_url?: boolean;
+        };
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Send a template message
+     *
+     * @example
+     * ```typescript
+     * const result = await client.whatsapp.sendTemplate({
+     *   to: "+1234567890",
+     *   template: {
+     *     name: "welcome_message",
+     *     language: { code: "en_US" },
+     *     components: [
+     *       {
+     *         type: "body",
+     *         parameters: [{ type: "text", text: "John" }]
+     *       }
+     *     ]
+     *   }
+     * });
+     * ```
+     */
+    sendTemplate(params: {
+        /** Recipient phone number (E.164 format) */
+        to: string;
+        /** Template configuration */
+        template: {
+            /** Template name */
+            name: string;
+            /** Template language */
+            language: {
+                /** Language code */
+                code: string;
+            };
+            /** Template components with parameters */
+            components?: Array<{
+                type: "header" | "body" | "button";
+                parameters?: Array<{
+                    type: "text" | "currency" | "date_time" | "image" | "document" | "video";
+                    text?: string;
+                    currency?: {
+                        fallback_value: string;
+                        code: string;
+                        amount_1000: number;
+                    };
+                    date_time?: {
+                        fallback_value: string;
+                    };
+                    image?: {
+                        link: string;
+                    };
+                    document?: {
+                        link: string;
+                        filename?: string;
+                    };
+                    video?: {
+                        link: string;
+                    };
+                }>;
+                sub_type?: string;
+                index?: number;
+            }>;
+        };
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Send media (image/video/document/audio)
+     *
+     * @example
+     * ```typescript
+     * const result = await client.whatsapp.sendMedia({
+     *   to: "+1234567890",
+     *   type: "image",
+     *   image: {
+     *     link: "https://example.com/image.jpg",
+     *     caption: "Check this out!"
+     *   }
+     * });
+     * ```
+     */
+    sendMedia(params: {
+        /** Recipient phone number (E.164 format) */
+        to: string;
+        /** Media type */
+        type: "image" | "video" | "document" | "audio";
+        /** Image media (when type is "image") */
+        image?: {
+            /** Media URL or ID */
+            link?: string;
+            id?: string;
+            /** Image caption */
+            caption?: string;
+        };
+        /** Video media (when type is "video") */
+        video?: {
+            /** Media URL or ID */
+            link?: string;
+            id?: string;
+            /** Video caption */
+            caption?: string;
+        };
+        /** Document media (when type is "document") */
+        document?: {
+            /** Media URL or ID */
+            link?: string;
+            id?: string;
+            /** Document caption */
+            caption?: string;
+            /** Document filename */
+            filename?: string;
+        };
+        /** Audio media (when type is "audio") */
+        audio?: {
+            /** Media URL or ID */
+            link?: string;
+            id?: string;
+        };
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * List message templates
+     *
+     * @example
+     * ```typescript
+     * const templates = await client.whatsapp.listTemplates({
+     *   limit: 50
+     * });
+     * ```
+     */
+    listTemplates(params?: {
+        /** Maximum number of templates to return */
+        limit?: number;
+        /** Pagination cursor */
+        after?: string;
+        /** Pagination cursor */
+        before?: string;
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Get registered phone numbers
+     *
+     * @example
+     * ```typescript
+     * const phoneNumbers = await client.whatsapp.getPhoneNumbers();
+     * ```
+     */
+    getPhoneNumbers(params?: {
+        /** Maximum number of phone numbers to return */
+        limit?: number;
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Get message delivery status
+     *
+     * @example
+     * ```typescript
+     * const status = await client.whatsapp.getMessageStatus({
+     *   message_id: "wamid.xxxxx"
+     * });
+     * ```
+     */
+    getMessageStatus(params: {
+        /** WhatsApp message ID */
+        message_id: string;
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Mark message as read
+     *
+     * @example
+     * ```typescript
+     * await client.whatsapp.markRead({
+     *   message_id: "wamid.xxxxx"
+     * });
+     * ```
+     */
+    markRead(params: {
+        /** WhatsApp message ID to mark as read */
+        message_id: string;
+    }): Promise<MCPToolCallResponse>;
+    /**
+     * Get business profile
+     *
+     * @example
+     * ```typescript
+     * const profile = await client.whatsapp.getProfile();
+     * ```
+     */
+    getProfile(params?: {
+        /** Fields to retrieve */
+        fields?: string[];
+    }): Promise<MCPToolCallResponse>;
+}
+//# sourceMappingURL=whatsapp-client.d.ts.map

package/dist/src/integrations/whatsapp-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whatsapp-client.d.ts","sourceRoot":"","sources":["../../../src/integrations/whatsapp-client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;IACrE,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,KAAK,CAAC,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,KAAK,CAAC,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,EAAE,EAAE,MAAM,CAAC;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;CACnD;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,UAAU,GAAG,SAAS,GAAG,UAAU,CAAC;IAC5C,QAAQ,EAAE,WAAW,GAAG,SAAS,GAAG,gBAAgB,CAAC;IACrD,UAAU,EAAE,KAAK,CAAC;QAChB,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,CAAC,EAAE;YACR,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;YACvB,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;SACxB,CAAC;KACH,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,wBAAwB,EAAE,MAAM,CAAC;IACjC,cAAc,EAAE,OAAO,GAAG,QAAQ,GAAG,KAAK,CAAC;IAC3C,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE;QACV,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,GAAG,WAAW,GAAG,MAAM,GAAG,QAAQ,CAAC;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,UAAU,CAAC,EAAE;YACX,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC,CAAC;CACJ;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;;;;;;;;;OAWG;IACH,WAAW,CAAC,MAAM,EAAE;QAClB,4CAA4C;QAC5C,EAAE,EAAE,MAAM,CAAC;QACX,mBAAmB;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,2BAA2B;QAC3B,IAAI,EAAE;YACJ,wBAAwB;YACxB,IAAI,EAAE,MAAM,CAAC;YACb,6BAA6B;YAC7B,WAAW,CAAC,EAAE,OAAO,CAAC;SACvB,CAAC;KACH,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,YAAY,CAAC,MAAM,EAAE;QACnB,4CAA4C;QAC5C,EAAE,EAAE,MAAM,CAAC;QACX,6BAA6B;QAC7B,QAAQ,EAAE;YACR,oBAAoB;YACpB,IAAI,EAAE,MAAM,CAAC;YACb,wBAAwB;YACxB,QAAQ,EAAE;gBACR,oBAAoB;gBACpB,IAAI,EAAE,MAAM,CAAC;aACd,CAAC;YACF,0CAA0C;YAC1C,UAAU,CAAC,EAAE,KAAK,CAAC;gBACjB,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;gBACnC,UAAU,CAAC,EAAE,KAAK,CAAC;oBACjB,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;oBACzE,IAAI,CAAC,EAAE,MAAM,CAAC;oBACd,QAAQ,CAAC,EAAE;wBAAE,cAAc,EAAE,MAAM,CAAC;wBAAC,IAAI,EAAE,MAAM,CAAC;wBAAC,WAAW,EAAE,MAAM,CAAA;qBAAE,CAAC;oBACzE,SAAS,CAAC,EAAE;wBAAE,cAAc,EAAE,MAAM,CAAA;qBAAE,CAAC;oBACvC,KAAK,CAAC,EAAE;wBAAE,IAAI,EAAE,MAAM,CAAA;qBAAE,CAAC;oBACzB,QAAQ,CAAC,EAAE;wBAAE,IAAI,EAAE,MAAM,CAAC;wBAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;qBAAE,CAAC;oBAC/C,KAAK,CAAC,EAAE;wBAAE,IAAI,EAAE,MAAM,CAAA;qBAAE,CAAC;iBAC1B,CAAC,CAAC;gBACH,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAClB,KAAK,CAAC,EAAE,MAAM,CAAC;aAChB,CAAC,CAAC;SACJ,CAAC;KACH,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;;;;;;;;OAcG;IACH,SAAS,CAAC,MAAM,EAAE;QAChB,4CAA4C;QAC5C,EAAE,EAAE,MAAM,CAAC;QACX,iBAAiB;QACjB,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,OAAO,CAAC;QAC/C,yCAAyC;QACzC,KAAK,CAAC,EAAE;YACN,sBAAsB;YACtB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,oBAAoB;YACpB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,yCAAyC;QACzC,KAAK,CAAC,EAAE;YACN,sBAAsB;YACtB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,oBAAoB;YACpB,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,+CAA+C;QAC/C,QAAQ,CAAC,EAAE;YACT,sBAAsB;YACtB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,uBAAuB;YACvB,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,wBAAwB;YACxB,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB,CAAC;QACF,yCAAyC;QACzC,KAAK,CAAC,EAAE;YACN,sBAAsB;YACtB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;SACb,CAAC;KACH,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;;;OASG;IACH,aAAa,CAAC,MAAM,CAAC,EAAE;QACrB,4CAA4C;QAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,wBAAwB;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,wBAAwB;QACxB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,eAAe,CAAC,MAAM,CAAC,EAAE;QACvB,gDAAgD;QAChD,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;;;OASG;IACH,gBAAgB,CAAC,MAAM,EAAE;QACvB,0BAA0B;QAC1B,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;;;OASG;IACH,QAAQ,CAAC,MAAM,EAAE;QACf,0CAA0C;QAC1C,UAAU,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE;QAClB,yBAAyB;QACzB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;KACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAClC"}

package/dist/src/integrations/whatsapp.d.ts

@@ -0,0 +1,39 @@
+/**
+ * WhatsApp Business Integration
+ * Enables WhatsApp Business tools with OAuth configuration
+ */
+import type { MCPIntegration } from "./types.js";
+/**
+ * WhatsApp Business integration configuration
+ *
+ * SERVER-SIDE: Automatically reads WHATSAPP_CLIENT_ID and WHATSAPP_CLIENT_SECRET from environment.
+ * You can override by providing explicit clientId and clientSecret values.
+ * CLIENT-SIDE: Omit clientId and clientSecret when using createMCPClient()
+ */
+export interface WhatsAppIntegrationConfig {
+    /** WhatsApp OAuth client ID (defaults to WHATSAPP_CLIENT_ID env var) */
+    clientId?: string;
+    /** WhatsApp OAuth client secret (defaults to WHATSAPP_CLIENT_SECRET env var) */
+    clientSecret?: string;
+    /** Additional OAuth scopes (default: ['business_management', 'whatsapp_business_messaging', 'whatsapp_business_management']) */
+    scopes?: string[];
+    /** OAuth redirect URI */
+    redirectUri?: string;
+    /** WhatsApp Business Account ID */
+    businessAccountId?: string;
+}
+/**
+ * Default WhatsApp Business tools that this integration enables
+ * These should match the tool names exposed by your MCP server
+ */
+declare const WHATSAPP_TOOLS: readonly ["whatsapp_send_message", "whatsapp_send_template", "whatsapp_send_media", "whatsapp_list_templates", "whatsapp_get_phone_numbers", "whatsapp_get_message_status", "whatsapp_mark_read", "whatsapp_get_profile"];
+export declare function whatsappIntegration(config?: WhatsAppIntegrationConfig): MCPIntegration<"whatsapp">;
+/**
+ * Export tool names for type inference
+ */
+export type WhatsAppTools = typeof WHATSAPP_TOOLS[number];
+/**
+ * Export WhatsApp client types
+ */
+export type { WhatsAppIntegrationClient } from "./whatsapp-client.js";
+//# sourceMappingURL=whatsapp.d.ts.map

package/dist/src/integrations/whatsapp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"whatsapp.d.ts","sourceRoot":"","sources":["../../../src/integrations/whatsapp.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAe,MAAM,YAAY,CAAC;AAG9D;;;;;;GAMG;AACH,MAAM,WAAW,yBAAyB;IACxC,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gFAAgF;IAChF,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gIAAgI;IAChI,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;;GAGG;AACH,QAAA,MAAM,cAAc,2NASV,CAAC;AAGX,wBAAgB,mBAAmB,CAAC,MAAM,GAAE,yBAA8B,GAAG,cAAc,CAAC,UAAU,CAAC,CA0BtG;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAE1D;;GAEG;AACH,YAAY,EAAE,yBAAyB,EAAE,MAAM,sBAAsB,CAAC"}