@gamastudio/sendwave-provider 1.0.0 → 1.0.2

package/README.md

@@ -1,4 +1,4 @@
-# 📖 Sendwave Provider
+# 📖 Sendwaves Provider
 
 **A dynamic library for integrating and managing Sendwave instances for WhatsApp bot development.**
 
@@ -23,80 +23,90 @@ const provider = createSendWaveProvider({
 
 // Initialize the provider
 await provider.initAll(provider.globalVendorArgs.port);
-await provider.initVendor();
 ```
 
-### Complete Configuration Options
+## 📤 Sending Messages
+
+### Text Messages
 
 ```typescript
-import { createSendWaveProvider, type GlobalVendorArgs } from "@gamastudio/sendwave-provider";
-
-const config: Partial<GlobalVendorArgs> = {
-  name: "MyBot",              // Instance identifier
-  apiKey: "your-api-key",     // Sendwave API key
-  port: 3000,                 // HTTP server port
-  delay: 1000,                // Default delay between messages (ms)
-  linkPreview: true,          // Enable/disable link previews
-  message: {
-    mergeMessage: false,      // Enable message buffering
-    timeMergeMessage: 3,      // Buffer timeout in seconds
-  },
-  queueFlow: {
-    enabled: true,            // Enable queue flow system
-    warningTimeout: 30 * 60 * 1000,  // 30 minutes before warning
-    endTimeout: 2 * 60 * 1000,       // 2 minutes after warning to end session
-    warningMessage: "⏳ You seem to be inactive. Are you still there?",
-  },
-};
+await provider.sendText({
+  from: "573123456789",
+  text: "Hello! Welcome to our service.",
+});
+```
+
+### Interactive Polls (New! 📊)
 
-const provider = createSendWaveProvider(config);
+```typescript
+await provider.sendPoll({
+  from: "573123456789",
+  poll: {
+    name: "¿Qué te parece el nuevo proveedor?",
+    values: ["Excelente", "Bueno", "Mejorable"],
+    selectableCount: 1 // Optional, default: 1
+  }
+});
 ```
 
-## 📤 Sending Messages
+### Intelligent Buttons (Easier! 🔘)
 
-### Text Messages
+The provider is now "intelligent" and accepts multiple formats for buttons.
 
 ```typescript
-await provider.sendText({
+// 1. Super Simple (Quick Replies)
+await provider.sendButton({
   from: "573123456789",
-  text: "Hello! Welcome to our service.",
+  title: "Main Menu",
+  buttons: ["🛒 Catalog", "🎁 Promotions", "📞 Support"]
+});
+
+// 2. Mixed Format (Text & Functional buttons)
+await provider.sendButton({
+  from: "573123456789",
+  title: "Payment Options",
+  body: "Select your preferred method",
+  buttons: [
+    { type: "reply", displayText: "Cash" },
+    { type: "url", displayText: "Visit Web", url: "https://example.com" },
+    { type: "copy", displayText: "Copy Coupon", copyText: "SAVE20" },
+    { type: "pix", displayText: "Pay with Pix", keyType: "email", key: "pix@bot.com" }
+  ]
 });
 ```
 
-### Interactive Lists
+**Supported Button Types:**
+- `reply`: Standard quick reply button.
+- `url`: Opens a website.
+- `call`: Triggers a phone call.
+- `copy`: Copies text or code to clipboard.
+- `pix`: Brazilian payment system integration.
+
+### Intelligent Lists (Simple & Advanced 📜)
 
 ```typescript
+// Simple List (Array of strings)
 await provider.sendList({
   from: "573123456789",
   list: {
     title: "Select an option",
-    description: "Choose from the following options:",
-    button: "View Menu",
-    content: ["🛒 Catalog", "🎁 Promotions", "📞 Support"],
-    footerText: "Powered by Sendwave", // Optional
+    button: "View Options",
+    content: ["Option 1", "Option 2", "Option 3"],
   },
 });
 
-// Advanced list with sections
+// Advanced List with sections
 await provider.sendList({
   from: "573123456789",
   list: {
     title: "Product Categories",
-    description: "Browse our products by category",
     button: "Select Category",
     content: [
       {
         title: "Electronics",
         rows: [
-          { title: "Smartphones", description: "Latest models available" },
-          { title: "Laptops", description: "Gaming and office laptops" },
-        ],
-      },
-      {
-        title: "Clothing",
-        rows: [
-          { title: "Men's Fashion" },
-          { title: "Women's Fashion" },
+          { title: "Smartphones", description: "Latest models" },
+          { title: "Laptops", description: "Gaming and office" },
         ],
       },
     ],
@@ -107,268 +117,43 @@ await provider.sendList({
 ### Media Messages
 
 ```typescript
-// Images
-await provider.sendImage({
-  from: "573123456789",
-  url: "https://example.com/image.jpg",
-  text: "Check out this product!",
-});
-
-// Videos
-await provider.sendVideo({
-  from: "573123456789",
-  url: "https://example.com/video.mp4",
-  text: "Product demonstration",
-});
-
-// Documents
-await provider.sendFile({
-  from: "573123456789",
-  url: "https://example.com/catalog.pdf",
-  fileName: "Product Catalog 2024.pdf",
-  text: "Here's our complete catalog",
-});
-
-// Voice Messages
-await provider.sendVoice({
-  from: "573123456789",
-  url: "https://example.com/audio.mp3",
-});
-```
-
-### Button Messages
-
-```typescript
-await provider.sendButton({
-  from: "573123456789",
-  title: "Customer Support",
-  body: "How can we help you today?",
-  description: "Choose one of the options below",
-  footer: "We're here to help!",
-  buttons: [
-    { type: "reply", text: "Technical Support" },
-    { type: "reply", text: "Billing Questions" },
-    { type: "url", text: "Visit Website" },
-  ],
-});
+// Images, Videos, Documents, and Voice
+await provider.sendImage({ from: "573123456789", url: "https://...", text: "Caption" });
+await provider.sendVideo({ from: "573123456789", url: "https://...", text: "Caption" });
+await provider.sendFile({ from: "573123456789", url: "https://...", fileName: "file.pdf" });
+await provider.sendVoice({ from: "573123456789", url: "https://..." });
 ```
 
-## 🔄 Queue Flow System
-
-The Queue Flow system **automatically** manages user sessions, handling timeouts and inactive users to optimize bot performance. Just enable it in the configuration and everything works automatically.
+## 🔄 Queue Flow System (100% Automatic)
 
-### Enable Queue Flow (100% Automatic)
+The Queue Flow system manages user sessions, handling timeouts and inactive users automatically.
 
 ```typescript
 const provider = createSendWaveProvider({
   name: "MyBot",
   apiKey: "your-key",
   queueFlow: {
-    enabled: true,  // 🚀 That's it! Everything else is automatic
-    warningTimeout: 30 * 60 * 1000, // 30 minutes (optional)
-    endTimeout: 2 * 60 * 1000,      // 2 minutes (optional)
-    warningMessage: "⏳ You seem inactive. Still there?", // (optional)
+    enabled: true,
+    warningTimeout: 30 * 60 * 1000, // 30 mins
+    endTimeout: 2 * 60 * 1000,      // 2 mins after warning
+    warningMessage: "⏳ You seem inactive. Still there?",
   },
 });
 ```
 
-**✨ What happens automatically when enabled:**
-- User timeouts are reset on every message (no code needed)
-- Warning messages are sent after inactivity period
-- Users are automatically removed from queue after timeout
-- `END_FLOW` event is triggered for BuilderBot integration
-- No additional code required in your flows!
-
-### Queue Flow Methods
-
-```typescript
-// Reset user timeout (called automatically on user messages)
-provider.resetUserTimeout("573123456789", "John Doe");
-
-// Clear user timeout manually
-provider.clearUserTimeout("573123456789");
-
-// Force remove user from system
-provider.forceClearUser("573123456789");
-
-// Check if user is ignored
-const isIgnored = provider.isUserIgnored("573123456789");
-
-// Get system statistics
-const stats = provider.getQueueFlowStats();
-console.log(stats); // { activeTimeouts: 5, ignoredUsers: 2, config: {...} }
-```
-
-### Queue Flow Events
-
-```typescript
-// Listen to user inactivity events
-provider.onQueueFlowEvent('userInactive-573123456789', (data) => {
-  if (data.isActive) {
-    console.log(`Warning sent to ${data.from}`);
-  } else {
-    console.log(`User ${data.from} removed due to inactivity`);
-  }
-});
-
-// Remove event listeners
-provider.offQueueFlowEvent('userInactive-573123456789');
-```
-
-## 🤖 BuilderBot Integration
-
-### Flow Implementation Examples
-
-```typescript
-import { addKeyword, EVENTS, utils } from "@builderbot/bot";
-import { SendWaveProvider as Provider } from "@gamastudio/sendwave-provider";
-
-// Welcome Flow
-export const flowWelcome = addKeyword<Provider>(EVENTS.WELCOME)
-  .addAnswer([
-    "¡Hello! I'm *Max*, your virtual assistant. 😊",
-    "Welcome to our service.",
-  ])
-  .addAction(async (_, { gotoFlow }) => await gotoFlow(flowMainMenu));
-
-// End Flow (integrates with Queue Flow system)
-export const flowEnd = addKeyword<Provider>(utils.setEvent("END_FLOW"))
-  .addAction(async (ctx, { endFlow, provider }) => {
-    // Clean up user from queue flow system
-    provider.forceClearUser(ctx.from);
-    endFlow("Chat closed due to inactivity. Write again if you need help!");
-  });
-
-// Customer Support Flow
-export const flowSupport = addKeyword<Provider>("SUPPORT")
-  .addAction(async (ctx, { blacklist, endFlow, provider }) => {
-    // Add to blacklist and clean queue
-    blacklist.add(ctx.from);
-    provider.forceClearUser(ctx.from);
-    
-    return endFlow(
-      "An agent will contact you shortly. Thanks for your patience! 👨‍💻"
-    );
-  });
-
-// Interactive Menu Flow
-export const flowMainMenu = addKeyword<Provider>("MAIN_MENU")
-  .addAction(async (ctx, { provider }) => {
-    await provider.sendList({
-      from: ctx.from,
-      list: {
-        button: "View Menu",
-        title: "",
-        description: "Select an option from the menu. Let's get started! 👇",
-        content: ["🛒 Catalog", "🎁 Promotions", "📞 Support"],
-      },
-    });
-  })
-  .addAction({ capture: true }, async (ctx, { gotoFlow, fallBack }) => {
-    const option = ctx.body.trim();
-    
-    switch (option) {
-      case "🛒 Catalog":
-        await gotoFlow(flowCatalog);
-        break;
-      case "🎁 Promotions":
-        await gotoFlow(flowPromotions);
-        break;
-      case "📞 Support":
-        await gotoFlow(flowSupport);
-        break;
-      default:
-        fallBack("I didn't understand that option. Please select from the list.");
-        break;
-    }
-  });
-```
-
-### Delayed Response Handling (100% Automatic)
-
-The Queue Flow system automatically handles users who take time to respond with **zero configuration needed**:
-
-```typescript
-// ✅ AUTOMATIC PROCESS:
-// 1. User sends message -> timeout resets automatically
-// 2. After 30 minutes of inactivity -> warning message sent automatically  
-// 3. After 2 more minutes -> user session ends with END_FLOW event automatically
-// 4. User is cleaned from queue automatically
-
-// 🎯 ONLY THING YOU NEED: Handle the END_FLOW event in your flows
-export const flowEnd = addKeyword<Provider>(utils.setEvent("END_FLOW"))
-  .addAction(async (ctx, { endFlow }) => {
-    // This runs automatically when user is inactive for too long
-    endFlow("Session ended due to inactivity. Contact us again anytime!");
-    // ✨ Queue cleanup happens automatically, no code needed!
-  });
-```
-
 ## 🎯 Event System
 
 ```typescript
-// Connection events
-provider.on('ready', (isReady: boolean) => {
-  console.log('Connection status:', isReady ? 'Connected' : 'Disconnected');
-});
-
-provider.on('auth_failure', (error) => {
-  console.error('Authentication failed:', error);
-});
-
-// Message events
-provider.on('message', (ctx) => {
-  console.log(`Message from ${ctx.from}: ${ctx.body}`);
-});
-
-provider.on('user-message', (data) => {
-  console.log(`User message: ${data.body}`);
-  // Timeout automatically resets here if queue flow is enabled
-});
+provider.on('ready', (isReady) => console.log('Connected:', isReady));
+provider.on('message', (ctx) => console.log(`From ${ctx.from}: ${ctx.body}`));
 ```
 
-## 🛠️ Development Scripts
-
-| Script          | Description                                      |
-| --------------- | ------------------------------------------------ |
-| `npm run dev`   | Run library in development mode with auto-reload |
-| `npm run build` | Compile TypeScript and resolve path aliases      |
-| `npm run test`  | Run basic test file                              |
-
-## 📦 Package Structure
-
-When you install `@gamastudio/sendwave-provider`:
-
-- Compiled code in `/build` directory
-- TypeScript declarations (`.d.ts`) included
-- Main entry point: `build/index.js`
-- Full TypeScript support with path aliases resolved
-
-## 📋 Requirements
-
-- **Node.js** 18+
-- **npm** or **pnpm**
-- **TypeScript** 5+
-- Valid Sendwave API credentials
-
-## 🔥 Important Notes
-
-This library is in **beta** state and subject to internal changes.
-
-**Recommendations:**
-- Use in testing or controlled environments initially
-- Update beta versions as new releases become available
-- Monitor the queue flow system performance with your user base
-
 ## 🏗️ Architecture
 
-- **Provider Layer**: Main SendWaveProvider class extending BuilderBot
-- **Core Layer**: Message processing and webhook handling
-- **Sender Layer**: Message sending functionality with media support
-- **Queue Flow**: Advanced user session management with timeout handling
-- **Utils**: Media detection, message parsing, and flow utilities
+- **Provider Layer**: Main SendWaveProvider class.
+- **Sender Layer**: Intelligent message transformation.
+- **Queue Flow**: Automatic session management.
 
 ## 📜 License
 
-ISC License © 2025 - Ameth Galarcio
-
+ISC License © 2026 - Ameth Galarcio

package/build/core/interface/provider.interface.d.ts

@@ -1,5 +1,5 @@
 import { SendOptions } from "@builderbot/bot/dist/types";
-import { ReadMessage, SendButton, SendList, SendLocation, SendMedia, SendMessage, SendPresence, SendReaction } from "../interface/types";
+import { ReadMessage, SendButton, SendList, SendLocation, SendMedia, SendMessage, SendPoll, SendPresence, SendReaction } from "../interface/types";
 export interface ProviderInterface {
     sendMessage?: (number: string, message: string, options?: SendOptions) => Promise<any>;
     sendText: (data: SendMessage) => Promise<any>;
@@ -13,6 +13,7 @@ export interface ProviderInterface {
     sendList: (data: SendList) => Promise<any>;
     sendPresence: (data: SendPresence) => Promise<any>;
     sendButton: (data: SendButton) => Promise<any>;
+    sendPoll: (data: SendPoll) => Promise<any>;
     sendLocation: (data: SendLocation) => Promise<any>;
     sendReaction: (data: SendReaction) => Promise<any>;
     readMessages: (data: ReadMessage) => Promise<any>;

package/build/core/interface/types.d.ts

@@ -80,6 +80,9 @@ export interface SendMessage {
     from: string;
     delay?: number;
     text?: string;
+    quoted?: any;
+    everyOne?: boolean;
+    mentioned?: string[];
 }
 export interface SendMedia extends SendMessage {
     mediaType?: "image" | "video" | "document" | "audio";
@@ -90,15 +93,50 @@ export interface SendPresence extends SendMessage {
     delay?: number;
     presence?: "composing" | "recording";
 }
+export type TypeButton = 'reply' | 'copy' | 'url' | 'call' | 'pix';
+export type BaseButton<T> = T & {
+    type: TypeButton;
+    id?: string;
+    displayText: string;
+};
+export type Button = BaseButton<{
+    type: 'reply';
+    displayText: string;
+}> | BaseButton<{
+    type: 'url';
+    displayText: string;
+    url: string;
+}> | BaseButton<{
+    type: 'call';
+    displayText: string;
+    phoneNumber: string;
+}> | BaseButton<{
+    type: 'copy';
+    displayText: string;
+    copyText: string;
+    copyCode?: string;
+}> | BaseButton<{
+    type: 'pix';
+    displayText: string;
+    keyType: KeyType;
+    key: string;
+    currency?: string;
+    name?: string;
+}>;
 export interface SendButton extends SendMessage {
     title: string;
-    body: string;
-    description: string;
-    footer: string;
-    buttons: {
-        type: "reply" | "url" | "call";
-        text: string;
-    }[];
+    thumbnailUrl?: string;
+    body?: string;
+    description?: string;
+    footer?: string;
+    buttons: Button[] | string[];
+}
+export interface SendPoll extends SendMessage {
+    poll: {
+        name: string;
+        values: string[];
+        selectableCount?: number;
+    };
 }
 export interface SendLocation extends SendMessage {
     name: string;

package/build/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gamastudio/sendwave-provider",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Librería para interactuar con Sendwave usando configuración dinámica.",
   "main": "build/index.js",
   "types": "build/index.d.ts",

package/build/provider/provider.d.ts

@@ -2,7 +2,7 @@ import { ProviderClass } from "@builderbot/bot";
 import Queue from "queue-promise";
 import { SendWaveCore } from "./core";
 import { BotContext, BotCtxMiddlewareOptions } from "@builderbot/bot/dist/types";
-import { GlobalVendorArgs, ReadMessage, SendButton, SendList, SendLocation, SendMedia, SendMessage, SendPresence, SendReaction } from "../core/interface/types";
+import { GlobalVendorArgs, ReadMessage, SendButton, SendList, SendLocation, SendMedia, SendMessage, SendPoll, SendPresence, SendReaction } from "../core/interface/types";
 import { SenderMessage } from "./sender";
 import { ParsedMessage } from "../core/interface";
 export declare class SendWaveProvider extends ProviderClass<SendWaveCore> {
@@ -55,6 +55,7 @@ export declare class SendWaveProvider extends ProviderClass<SendWaveCore> {
     sendPresence(data: SendPresence): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendVoice(data: SendMedia): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendButton(data: SendButton): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
+    sendPoll(data: SendPoll): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendReaction(data: SendReaction): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendLocation(data: SendLocation): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendMedia(data: SendMedia): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;

package/build/provider/provider.js

@@ -195,6 +195,7 @@ class SendWaveProvider extends bot_1.ProviderClass {
                 sendVoice: this.sendVoice,
                 sendPresence: this.sendPresence,
                 sendButton: this.sendButton,
+                sendPoll: this.sendPoll,
                 readMessages: this.readMessages,
                 provider: this,
                 blacklist: opts === null || opts === void 0 ? void 0 : opts.blacklist,
@@ -495,6 +496,9 @@ class SendWaveProvider extends bot_1.ProviderClass {
     sendButton(data) {
         return this.sender.sendButton(data);
     }
+    sendPoll(data) {
+        return this.sender.sendPoll(data);
+    }
     sendReaction(data) {
         return this.sender.sendReaction(data);
     }

package/build/provider/sender.d.ts

@@ -1,4 +1,4 @@
-import { GlobalVendorArgs, ProviderInterface, SendButton, SendList, SendMedia, SendMessage, SendPresence, SendLocation, SendReaction, ReadMessage } from "../core/interface";
+import { GlobalVendorArgs, ProviderInterface, SendButton, SendList, SendMedia, SendMessage, SendPresence, SendPoll, SendLocation, SendReaction, ReadMessage } from "../core/interface";
 export declare class SenderMessage implements ProviderInterface {
     private sendwaveApi?;
     private globalVendorArgs?;
@@ -15,6 +15,7 @@ export declare class SenderMessage implements ProviderInterface {
     sendVideo(data: SendMedia): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendVoice(data: SendMedia): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendButton(data: SendButton): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
+    sendPoll(data: SendPoll): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendLocation(data: SendLocation): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     sendReaction(data: SendReaction): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;
     readMessages(data: ReadMessage): Promise<import("axios").AxiosResponse<any, any, {}> | undefined>;