@builderbot/provider-evolution-api 1.2.7 → 1.2.8-alpha.1

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Leifer Mendez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/evolution/core.d.ts

@@ -1,47 +1,38 @@
 import EventEmitter from 'node:events';
 import type polka from 'polka';
 import type Queue from 'queue-promise';
-import type { Message } from '~/types';
 /**
- * Class representing MetaCoreVendor, a vendor class for meta core functionality.
+ * Class representing EvolutionCoreVendor, a vendor class for WhatsApp Business API integration.
+ * Handles webhook validation, message reception, and processing through Meta's Cloud API.
  * @extends EventEmitter
  */
 export declare class EvolutionCoreVendor extends EventEmitter {
-    queue: Queue;
     /**
-     * Create a MetaCoreVendor.
-     * @param {Queue} _queue - The queue instance.
+     * Queue for handling asynchronous message processing
+     * @private
      */
-    constructor(_queue: Queue);
+    private readonly queue;
     /**
-     * Middleware function for indexing home.
-     * @type {polka.Middleware}
+     * Creates an instance of EvolutionCoreVendor.
+     * @param {Queue} _queue - The queue instance for managing message processing.
      */
-    indexHome: polka.Middleware;
-    /**
-     * Check if the token is valid.
-     * @param {string} mode - The mode parameter.
-     * @param {string} token - The token parameter.
-     * @param {string} originToken - The origin token parameter.
-     * @returns {boolean} Returns true if token is valid, false otherwise.
-     */
-    tokenIsValid(mode: string, token: string, originToken: string): boolean;
-    private extractStatus;
+    constructor(_queue: Queue);
     /**
-     * Middleware function for verifying token.
+     * Middleware function for health check endpoint.
+     * Returns a simple response to verify the service is running.
      * @type {polka.Middleware}
      */
-    verifyToken: polka.Middleware;
+    indexHome: polka.Middleware;
     /**
-     * Middleware function for handling incoming messages.
+     * Middleware function for handling incoming webhook messages.
+     * Processes incoming messages from WhatsApp and adds them to the processing queue.
      * @type {polka.Middleware}
      */
     incomingMsg: polka.Middleware;
     /**
-     * Process incoming message.
-     * @param {Message} message - The message object.
-     * @returns {Promise<void>} Promise that resolves when processing is complete.
+     * Procesa un mensaje entrante y lo emite al flujo del bot.
+     * @param message - Objeto de mensaje enriquecido.
      */
-    processMessage: (message: Message) => Promise<void>;
+    processMessage: (message: any) => Promise<void>;
 }
 //# sourceMappingURL=core.d.ts.map

package/dist/evolution/core.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/evolution/core.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,KAAK,KAAK,MAAM,eAAe,CAAA;AAItC,OAAO,KAAK,EAAE,OAAO,EAA2D,MAAM,SAAS,CAAA;AAE/F;;;GAGG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACjD,KAAK,EAAE,KAAK,CAAA;IAEZ;;;OAGG;gBACS,MAAM,EAAE,KAAK;IAKzB;;;OAGG;IACI,SAAS,EAAE,KAAK,CAAC,UAAU,CAEjC;IAED;;;;;;OAMG;IACI,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO;IAI9E,OAAO,CAAC,aAAa;IAwBrB;;;OAGG;IACI,WAAW,EAAE,KAAK,CAAC,UAAU,CAqBnC;IAED;;;OAGG;IACI,WAAW,EAAE,KAAK,CAAC,UAAU,CAoEnC;IAED;;;;OAIG;IACI,cAAc,GAAI,SAAS,OAAO,KAAG,OAAO,CAAC,IAAI,CAAC,CASxD;CACJ"}
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/evolution/core.ts"],"names":[],"mappings":"AACA,OAAO,YAAY,MAAM,aAAa,CAAA;AACtC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,KAAK,KAAK,MAAM,eAAe,CAAA;AA0BtC;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,YAAY;IACjD;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAE7B;;;OAGG;gBACS,MAAM,EAAE,KAAK;IAQzB;;;;OAIG;IACI,SAAS,EAAE,KAAK,CAAC,UAAU,CAQjC;IAED;;;;OAIG;IACI,WAAW,EAAE,KAAK,CAAC,UAAU,CAkHnC;IAED;;;OAGG;IACI,cAAc,GAAI,SAAS,GAAG,KAAG,OAAO,CAAC,IAAI,CAAC,CASpD;CACJ"}

package/dist/evolution/provider.d.ts

@@ -1,35 +1,124 @@
 import { ProviderClass } from '@builderbot/bot';
 import type { Vendor } from '@builderbot/bot/dist/provider/interface/provider';
-import type { BotContext } from '@builderbot/bot/dist/types';
+import type { BotContext, SendOptions } from '@builderbot/bot/dist/types';
+import { Middleware } from 'polka';
+import type polka from 'polka';
 import Queue from 'queue-promise';
+
 import type { EvolutionInterface } from '../interface/evolution';
-import type { EvolutionGlobalVendorArgs, Message, SaveFileOptions } from '~/types';
+import type { EvolutionGlobalVendorArgs, SaveFileOptions } from '../types';
+/**
+ * Evolution API Provider implementation
+ * Handles all communication with Evolution API for sending messages, media, etc.
+ */
 declare class EvolutionProvider extends ProviderClass<EvolutionInterface> implements EvolutionInterface {
-    vendor: Vendor<any>;
+    vendor: Vendor<EvolutionInterface & {
+        indexHome: polka.Middleware;
+        incomingMsg: polka.Middleware;
+    }>;
     queue: Queue;
+    incomingMsg: any;
     globalVendorArgs: EvolutionGlobalVendorArgs;
+    /**
+     * Creates an instance of Evolution Provider
+     * @param args Provider configuration
+     */
     constructor(args: EvolutionGlobalVendorArgs);
+    sendMessageMeta: (body: any) => Promise<any>;
+    sendImageUrl: (to: string, url: string, mediaName?: string, caption?: string) => Promise<any>;
+    sendVideoUrl: (to: string, url: string, mediaName?: string, caption?: string) => Promise<any>;
+    sendAudioUrl: (to: string, url: string, mediaName?: string, caption?: string) => Promise<any>;
+    sendList: (to: string, list: any) => Promise<any>;
+    sendListComplete: (to: string, list: any) => Promise<any>;
+    indexHome?: Middleware<any, any, any, any>;
+    /**
+     * Initialize HTTP server middleware
+     */
     protected beforeHttpServerInit(): void;
+    /**
+     * Initialize vendor core
+     */
     protected initVendor(): Promise<any>;
-    protected afterHttpServerInit(): Promise<void>;
-    busEvents: () => {
+    /**
+     * Build standard headers for API requests
+     * @param additionalHeaders Optional additional headers to include
+     * @returns Headers object with apiKey
+     */
+    private builderHeader;
+    /**
+     * Verify connection with Evolution API after HTTP server initialization
+     */ protected afterHttpServerInit(): Promise<void>;
+    /**
+     * Event bus configuration
+     */
+    protected busEvents(): {
         event: string;
         func: (payload: any) => void;
     }[];
-    sendText(to: string, message: string): Promise<any>;
-    sendMessage(to: string, message: string): Promise<any>;
-    sendImage(to: string, mediaUrl: string, mediaName?: string, caption?: string): Promise<any>;
-    sendImageUrl(to: string, url: string, mediaName?: string, caption?: string): Promise<any>;
-    sendVideo(to: string, mediaUrl: string, mediaName?: string, caption?: string): Promise<any>;
-    sendVideoUrl(to: string, url: string, mediaName?: string, caption?: string): Promise<any>;
-    sendAudio(to: string, mediaUrl: string, mediaName?: string, caption?: string): Promise<any>;
-    sendAudioUrl(to: string, url: string, mediaName?: string, caption?: string): Promise<any>;
-    sendMedia(to: string, file: string, type: string): Promise<any>;
-    sendList(to: string, list: any): Promise<any>;
-    sendListComplete(to: string, list: any): Promise<any>;
-    saveFile(ctx: Partial<Message & BotContext>, options?: SaveFileOptions): Promise<string>;
-    sendMessageMeta: (body: any) => Promise<any>;
-    sendMessageToApi: (body: any) => Promise<any>;
+    /**
+     * Punto de entrada para envío de archivos multimedia.
+     * Detecta el tipo de archivo y redirige a la función correspondiente.
+     *
+     * @param number Número de destino
+     * @param mediaUrl URL o path del archivo
+     * @param caption Texto opcional
+     */
+    sendMedia: (number: string, mediaUrl: string, caption: string) => Promise<any>;
+    /**
+     * Envía una imagen al número dado.
+     * @param number Número destino
+     * @param filePath Ruta local de la imagen
+     * @param caption Texto opcional
+     */
+    sendImage: (number: string, filePath: string, caption: string) => Promise<any>;
+    /**
+     * Envía un video al número dado.
+     * @param number Número destino
+     * @param filePath Ruta local del video
+     * @param caption Texto opcional
+     */
+    sendVideo: (number: string, filePath: string, caption: string) => Promise<any>;
+    /**
+     * Envía un archivo de audio en formato compatible (OPUS).
+     * @param number Número destino
+     * @param filePath Ruta local del archivo de audio
+     */
+    sendAudio: (number: string, filePath: string) => Promise<any>;
+    /**
+     * Envía un documento genérico al número dado.
+     * @param number Número destino
+     * @param filePath Ruta local del archivo
+     * @param caption Texto opcional
+     */
+    sendFile: (number: string, filePath: string, caption: string) => Promise<any>;
+    /**
+     * Envía un mensaje de texto plano.
+     * @param number Número destino
+     * @param message Contenido del mensaje
+     */
+    sendText: (number: string, message: string) => Promise<any>;
+    /**
+     * Función general para hacer peticiones POST a la API externa.
+     * @param body Cuerpo de la petición
+     * @param ruta Ruta relativa del endpoint (optional)
+     */
+    sendMessageToApi: (body: any, ruta?: string) => Promise<any>;
+    /**
+     * Encola el envío de un mensaje para asegurar orden y evitar conflictos.
+     * @param body Cuerpo del mensaje
+     * @param ruta Ruta del endpoint
+     */
+    sendMessageEvoApi: (body: any, ruta: string) => Promise<any>;
+    /**
+     * Enrutador general para envío de mensajes.
+     * Si incluye media, se envía como archivo. Si no, como texto plano.
+     *
+     * @param number Número destino
+     * @param message Mensaje de texto
+     * @param options Opciones adicionales (media, etc.)
+     */
+    sendMessage(number: string, message: string, options?: SendOptions): Promise<any>;
+    saveFile: (ctx: Partial<BotContext>, options?: SaveFileOptions) => Promise<string>;
 }
 export { EvolutionProvider };
 //# sourceMappingURL=provider.d.ts.map

package/dist/evolution/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/evolution/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAS,MAAM,iBAAiB,CAAA;AACtD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kDAAkD,CAAA;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAuB,MAAM,4BAA4B,CAAA;AAQjF,OAAO,KAAK,MAAM,eAAe,CAAA;AAGjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAIhE,OAAO,KAAK,EACR,yBAAyB,EAEzB,OAAO,EAIP,eAAe,EAElB,MAAM,SAAS,CAAA;AAEhB,cAAM,iBAAkB,SAAQ,aAAa,CAAC,kBAAkB,CAAE,YAAW,kBAAkB;IACpF,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,CAAA;IACnB,KAAK,EAAE,KAAK,CAAc;IAE1B,gBAAgB,EAAE,yBAAyB,CAKjD;gBAEW,IAAI,EAAE,yBAAyB;IAU3C,SAAS,CAAC,oBAAoB,IAAI,IAAI;cAStB,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;cAM1B,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2BpD,SAAS;;wBAGe,GAAG;QAgB1B;IAEK,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAInD,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAsBtD,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA0B3F,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzF,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA0B3F,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzF,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IA0B3F,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAIzF,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAgD/D,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAsB7C,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAIrD,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,OAAO,GAAG,UAAU,CAAC,EAAE,OAAO,GAAE,eAAoB,GAAG,OAAO,CAAC,MAAM,CAAC;IA4FlG,eAAe,GAAI,MAAM,GAAG,KAAG,OAAO,CAAC,GAAG,CAAC,CAO1C;IAED,gBAAgB,GAAU,MAAM,GAAG,KAAG,OAAO,CAAC,GAAG,CAAC,CAcjD;CACJ;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAA"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/evolution/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,kDAAkD,CAAA;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AASzE,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAClC,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAC9B,OAAO,KAAK,MAAM,eAAe,CAAA;AAEjC,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAA;AAChE,OAAO,KAAK,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAG1E;;;GAGG;AACH,cAAM,iBAAkB,SAAQ,aAAa,CAAC,kBAAkB,CAAE,YAAW,kBAAkB;IACpF,MAAM,EAAE,MAAM,CAAC,kBAAkB,GAAG;QAAE,SAAS,EAAE,KAAK,CAAC,UAAU,CAAC;QAAC,WAAW,EAAE,KAAK,CAAC,UAAU,CAAA;KAAE,CAAC,CAAA;IACnG,KAAK,EAAE,KAAK,CAAc;IAC1B,WAAW,EAAE,GAAG,CAAA;IAEhB,gBAAgB,EAAE,yBAAyB,CAMjD;IAED;;;OAGG;gBACS,IAAI,EAAE,yBAAyB;IAS3C,eAAe,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC5C,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC7F,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC7F,YAAY,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IAC7F,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IACjD,gBAAgB,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAA;IACzD,SAAS,CAAC,EAAE,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAE1C;;OAEG;IACH,SAAS,CAAC,oBAAoB,IAAI,IAAI;IAWtC;;OAEG;IACH,SAAS,CAAC,UAAU,IAAI,OAAO,CAAC,GAAG,CAAC;IAQpC;;;;OAIG;IACH,OAAO,CAAC,aAAa;IAQrB;;OAEG,WAAiB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BxD;;OAEG;IACH,SAAS,CAAC,SAAS;;wBAIS,GAAG;;IAoB/B;;;;;;;OAOG;IACH,SAAS,GAAU,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,SAAS,MAAM,kBAmBnE;IAED;;;;;OAKG;IACH,SAAS,GAAU,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,SAAS,MAAM,kBAcnE;IAED;;;;;OAKG;IACH,SAAS,GAAU,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,SAAS,MAAM,kBAcnE;IAED;;;;OAIG;IACH,SAAS,GAAU,QAAQ,MAAM,EAAE,UAAU,MAAM,kBAYlD;IAED;;;;;OAKG;IACH,QAAQ,GAAU,QAAQ,MAAM,EAAE,UAAU,MAAM,EAAE,SAAS,MAAM,kBAgBlE;IAED;;;;OAIG;IACH,QAAQ,GAAU,QAAQ,MAAM,EAAE,SAAS,MAAM,kBAUhD;IAED;;;;OAIG;IACH,gBAAgB,GAAU,MAAM,GAAG,EAAE,OAAM,MAAoB,KAAG,OAAO,CAAC,GAAG,CAAC,CAkB7E;IAED;;;;OAIG;IACH,iBAAiB,GAAI,MAAM,GAAG,EAAE,MAAM,MAAM,KAAG,OAAO,CAAC,GAAG,CAAC,CAO1D;IAED;;;;;;;OAOG;IACG,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC;IAOvF,QAAQ,GAAU,KAAK,OAAO,CAAC,UAAU,CAAC,EAAE,UAAS,eAAoB,KAAG,OAAO,CAAC,MAAM,CAAC,CAW1F;CACJ;AAED,OAAO,EAAE,iBAAiB,EAAE,CAAA"}