@builderbot/provider-venom 0.1.3-alpha.22

package/dist/index.d.ts

@@ -0,0 +1,119 @@
+import { ProviderClass } from '@builderbot/bot';
+import { BotContext, BotCtxMiddlewareOptions, SendOptions } from '@builderbot/bot/dist/types';
+import venom from 'venom-bot';
+
+import { VenomHttpServer } from './server';
+import { SaveFileOptions } from './types';
+/**
+ * ⚙️ VenomProvider: Es una clase tipo adaptor
+ * que extiende clases de ProviderClass (la cual es como interfaz para sber que funciones rqueridas)
+ * https://github.com/orkestral/venom
+ */
+declare class VenomProvider extends ProviderClass {
+    globalVendorArgs: {
+        name: string;
+        gifPlayback: boolean;
+        port: number;
+    };
+    vendor: venom.Whatsapp;
+    http: VenomHttpServer | undefined;
+    constructor(args: {
+        name: string;
+        gifPlayback: boolean;
+    });
+    /**
+     *
+     * @param port
+     * @param opts
+     * @returns
+     */
+    initHttpServer: (port: number, opts: Pick<BotCtxMiddlewareOptions, 'blacklist'>) => void;
+    /**
+     * Iniciamos el Proveedor Venom
+     */
+    init: () => Promise<void>;
+    /**
+     * Generamos QR Code pra escanear con el Whatsapp
+     */
+    generateQr: (qr: string) => Promise<void>;
+    /**
+     * Mapeamos los eventos nativos de  https://docs.orkestral.io/venom/#/?id=events
+     * para tener un standar de eventos
+     * @returns
+     */
+    busEvents: () => {
+        event: string;
+        func: (payload: venom.Message & {
+            lat?: string;
+            lng?: string;
+            name: string;
+        }) => void;
+    }[];
+    /**
+     * Iniciamos y mapeamos el BusEvent
+     * Ejemplo:
+     * this.vendor.onMessage() 👉 this.vendor["onMessage"]()
+     */
+    initBusEvents: () => void;
+    /**
+     * Enviar botones
+     * @private
+     * @param {*} number
+     * @param {*} message
+     * @param {*} buttons []
+     * @returns
+     */
+    sendButtons: (number: string, message: any, buttons?: any[]) => Promise<Object>;
+    /**
+     * Enviar audio
+     * @alpha
+     * @param {string} number
+     * @param {string} message
+     * @param {boolean} voiceNote optional
+     * @example await sendMessage('+XXXXXXXXXXX', 'audio.mp3')
+     */
+    sendAudio: (number: string, audioPath: string) => Promise<unknown>;
+    /**
+     * Enviar imagen
+     * @param {*} number
+     * @param {*} imageUrl
+     * @param {*} text
+     * @returns
+     */
+    sendImage: (number: string, filePath: string, text: string) => Promise<venom.SendFileResult>;
+    /**
+     *
+     * @param {string} number
+     * @param {string} filePath
+     * @example await sendMessage('+XXXXXXXXXXX', './document/file.pdf')
+     */
+    sendFile: (number: string, filePath: string, text: string) => Promise<unknown>;
+    /**
+     * Enviar video
+     * @param {*} number
+     * @param {*} imageUrl
+     * @param {*} text
+     * @returns
+     */
+    sendVideo: (number: string, filePath: string, text: string) => Promise<void>;
+    /**
+     * Enviar imagen o multimedia
+     * @param {*} number
+     * @param {*} mediaInput
+     * @param {*} message
+     * @returns
+     */
+    sendMedia: (number: string, mediaUrl: string, text: string) => Promise<unknown>;
+    /**
+     * Enviar mensaje al usuario
+     * @param {*} userId
+     * @param {*} message
+     * @param {*} param2
+     * @returns
+     */
+    sendMessage: (number: string, message: string, options?: SendOptions) => Promise<any>;
+    private generateFileName;
+    saveFile: (ctx: Partial<venom.Message & BotContext>, options?: SaveFileOptions) => Promise<string>;
+}
+export { VenomProvider };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAS,MAAM,iBAAiB,CAAA;AACtD,OAAO,EAAE,UAAU,EAAoB,uBAAuB,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAA;AAO/G,OAAO,KAAK,MAAM,WAAW,CAAA;AAE7B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA;AAOzC;;;;GAIG;AACH,cAAM,aAAc,SAAQ,aAAa;IACrC,gBAAgB;;;;MAAkD;IAClE,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAA;IACtB,IAAI,EAAE,eAAe,GAAG,SAAS,CAAA;gBACrB,IAAI,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,WAAW,EAAE,OAAO,CAAA;KAAE;IAOxD;;;;;OAKG;IACH,cAAc,SAAU,MAAM,QAAQ,KAAK,uBAAuB,EAAE,WAAW,CAAC,UAe/E;IAED;;OAEG;IACH,IAAI,sBAkCH;IAED;;OAEG;IACH,UAAU,OAAc,MAAM,mBAU7B;IAED;;;;OAIG;IACH,SAAS;;wBAGe,MAAM,OAAO,GAAG;YAAE,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,GAAG,CAAC,EAAE,MAAM,CAAC;YAAC,MAAM,MAAM,CAAA;SAAE;QAmCnF;IAED;;;;OAIG;IACH,aAAa,aASZ;IAED;;;;;;;OAOG;IACH,WAAW,WAAkB,MAAM,WAAW,GAAG,sCAWhD;IAED;;;;;;;OAOG;IAEH,SAAS,WAAkB,MAAM,aAAa,MAAM,sBAEnD;IAED;;;;;;OAMG;IACH,SAAS,WAAkB,MAAM,YAAY,MAAM,QAAQ,MAAM,mCAEhE;IAED;;;;;OAKG;IAEH,QAAQ,WAAkB,MAAM,YAAY,MAAM,QAAQ,MAAM,sBAG/D;IAED;;;;;;OAMG;IACH,SAAS,WAAkB,MAAM,YAAY,MAAM,QAAQ,MAAM,mBAEhE;IAED;;;;;;OAMG;IACH,SAAS,WAAkB,MAAM,YAAY,MAAM,QAAQ,MAAM,sBAWhE;IAED;;;;;;OAMG;IACH,WAAW,WAAkB,MAAM,WAAW,MAAM,YAAY,WAAW,KAAG,QAAQ,GAAG,CAAC,CAMzF;IAED,OAAO,CAAC,gBAAgB,CAAmE;IAE3F,QAAQ,QAAe,QAAQ,MAAM,OAAO,GAAG,UAAU,CAAC,YAAW,eAAe,KAAQ,QAAQ,MAAM,CAAC,CAa1G;CACJ;AAED,OAAO,EAAE,aAAa,EAAE,CAAA"}

package/dist/server.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import EventEmitter from 'node:events';
+import polka, { Polka } from 'polka';
+
+import { VenomProvider } from '.';
+import { BotCtxMiddleware } from './types';
+export declare class VenomHttpServer extends EventEmitter {
+    #private;
+    server: Polka;
+    port: number;
+    constructor(botName: string, _port: number);
+    /**
+     * Contruir HTTP Server
+     */
+    protected buildHTTPServer(): Polka;
+    /**
+     * Iniciar el servidor HTTP
+     */
+    start(vendor: BotCtxMiddleware, port?: number, args?: {
+        botName: string;
+    }): void;
+    /**
+     *
+     * @param _
+     * @param res
+     */
+    protected indexHome: polka.Middleware;
+    stop(): Promise<void>;
+}
+/**
+ *
+ * @param inHandleCtx
+ * @returns
+ */
+export declare const inHandleCtx: <T extends Pick<VenomProvider, "sendMessage" | "vendor"> & {
+    provider: VenomProvider;
+}>(ctxPolka: (bot: T, req: any, res: any) => Promise<void>) => (req: any, res: any) => any;
+//# sourceMappingURL=server.d.ts.map

package/dist/server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.ts","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":";AACA,OAAO,YAAY,MAAM,aAAa,CAAA;AAGtC,OAAO,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,OAAO,CAAA;AAEpC,OAAO,EAAE,aAAa,EAAE,MAAM,GAAG,CAAA;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAA;AAK1C,qBAAa,eAAgB,SAAQ,YAAY;;IACtC,MAAM,EAAE,KAAK,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;gBAGP,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAO1C;;OAEG;IACH,SAAS,CAAC,eAAe,IAAI,KAAK;IAOlC;;OAEG;IAEH,KAAK,CAAC,MAAM,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;IAczE;;;;OAIG;IACH,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC,UAAU,CAMpC;IAED,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;CAWxB;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW;cACmD,aAAa;2BAC5C,GAAG,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,WAEjE,GAAG,OAAO,GAAG,QAoBlB,CAAA"}

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+import { ProviderClass } from '@builderbot/bot';
+export type BotCtxMiddleware = Partial<ProviderClass & {
+    provider: any;
+}>;
+export interface SaveFileOptions {
+    path?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAC,aAAa,GAAG;IAAE,QAAQ,EAAE,GAAG,CAAA;CAAE,CAAC,CAAA;AACzE,MAAM,WAAW,eAAe;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB"}

package/dist/utils.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+declare const venomCleanNumber: (number: string, full?: boolean) => string;
+declare const writeFilePromise: (pathQr: string, response: {
+    type: string;
+    data: Buffer;
+}) => Promise<boolean>;
+declare const notMatches: (matches: RegExpMatchArray | null) => boolean;
+declare const venomGenerateImage: (base: string, name?: string) => Promise<void | Error>;
+declare const venomDownloadMedia: (url: string) => Promise<string>;
+declare const venomisValidNumber: (rawNumber: string) => boolean;
+export { venomCleanNumber, venomGenerateImage, venomisValidNumber, venomDownloadMedia, writeFilePromise, notMatches };
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";AAMA,QAAA,MAAM,gBAAgB,WAAY,MAAM,SAAQ,OAAO,KAAW,MAIjE,CAAA;AAED,QAAA,MAAM,gBAAgB,WAAY,MAAM,YAAY;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,KAAG,QAAQ,OAAO,CAOnG,CAAA;AAED,QAAA,MAAM,UAAU,YAAa,gBAAgB,GAAG,IAAI,KAAG,OAEtD,CAAA;AAED,QAAA,MAAM,kBAAkB,SAAgB,MAAM,SAAQ,MAAM,KAAc,QAAQ,IAAI,GAAG,KAAK,CAe7F,CAAA;AAED,QAAA,MAAM,kBAAkB,QAAS,MAAM,KAAG,QAAQ,MAAM,CAqBvD,CAAA;AAED,QAAA,MAAM,kBAAkB,cAAe,MAAM,KAAG,OAI/C,CAAA;AAED,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,UAAU,EAAE,CAAA"}

package/package.json

@@ -0,0 +1,58 @@
+{
+    "name": "@builderbot/provider-venom",
+    "version": "0.1.3-alpha.22",
+    "description": "Now I’m the model of a modern major general / The venerated Virginian veteran whose men are all / Lining up, to put me up on a pedestal / Writin’ letters to relatives / Embellishin’ my elegance and eloquence / But the elephant is in the room / The truth is in ya face when ya hear the British cannons go / BOOM",
+    "keywords": [],
+    "author": "Leifer Mendez <leifer33@gmail.com>",
+    "license": "ISC",
+    "main": "dist/index.cjs",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "files": [
+        "./dist/"
+    ],
+    "scripts": {
+        "build": "rimraf dist && rollup --config",
+        "test": "npx uvu -r tsm ./__tests__",
+        "test:coverage": "npx c8 npm run test"
+    },
+    "directories": {
+        "lib": "dist",
+        "test": "__tests__"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/codigoencasa/bot-whatsapp.git"
+    },
+    "bugs": {
+        "url": "https://github.com/codigoencasa/bot-whatsapp/issues"
+    },
+    "homepage": "https://github.com/codigoencasa/bot-whatsapp#readme",
+    "devDependencies": {
+        "@builderbot/bot": "^0.1.3-alpha.22",
+        "@rollup/plugin-commonjs": "^25.0.7",
+        "@rollup/plugin-json": "^6.1.0",
+        "@rollup/plugin-node-resolve": "^15.2.3",
+        "@types/body-parser": "^1.19.5",
+        "@types/mime-types": "^2.1.4",
+        "@types/node": "^20.11.5",
+        "@types/polka": "^0.5.7",
+        "@types/proxyquire": "^1.3.31",
+        "@types/qr-image": "^3.2.9",
+        "@types/sinon": "^17.0.3",
+        "mime-types": "^2.1.35",
+        "pino": "^8.17.2",
+        "proxyquire": "^2.1.3",
+        "qr-image": "^3.2.0",
+        "rimraf": "^5.0.5",
+        "rollup-plugin-typescript2": "^0.36.0",
+        "sino": "^0.0.3",
+        "sinon": "^17.0.1"
+    },
+    "dependencies": {
+        "body-parser": "^1.20.2",
+        "polka": "^0.5.2",
+        "venom-bot": "^5.0.21"
+    },
+    "gitHead": "e52a9fe13d30d65b650a54b6e116953c949b1158"
+}