@open-wa/wa-automate 4.67.0 → 4.68.0

package/README.md

@@ -10,6 +10,8 @@
 >
 >
 
+[![Ceasefire Now](https://badge.techforpalestine.org/ceasefire-now)](https://techforpalestine.org/learn-more)
+
 [![npm version](https://img.shields.io/npm/v/@open-wa/wa-automate.svg?color=green)](https://www.npmjs.com/package/@open-wa/wa-automate)
 ![node](https://img.shields.io/node/v/@open-wa/wa-automate)
 [![Downloads](https://img.shields.io/npm/dm/@open-wa/wa-automate.svg)](https://www.npmjs.com/package/@open-wa/wa-automate)

package/dist/api/Client.d.ts

@@ -1883,15 +1883,7 @@ export declare class Client {
      */
     sendGiphyAsSticker(to: ChatId, giphyMediaUrl: URL | string): Promise<MessageId | string | boolean>;
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES A TEXT STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Sends a formatted text story.
      * @param text The text to be displayed in the story
@@ -1908,15 +1900,7 @@ export declare class Client {
      */
     postTextStatus(text: Content, textRgba: string, backgroundRgba: string, font: number): Promise<MessageId | string | boolean>;
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES AN IMAGE STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Posts an image story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
@@ -1925,15 +1909,7 @@ export declare class Client {
      */
     postImageStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES A VIDEO STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Posts a video story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
@@ -1951,7 +1927,6 @@ export declare class Client {
      */
     deleteStory(statusesToDelete: string | string[]): Promise<boolean>;
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     deleteStatus(statusesToDelete: string | string[]): Promise<boolean>;
@@ -1963,7 +1938,6 @@ export declare class Client {
      */
     deleteAllStories(): Promise<boolean>;
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     deleteAllStatus(): Promise<boolean>;
@@ -1976,7 +1950,6 @@ export declare class Client {
      */
     getMyStoryArray(): Promise<Message[]>;
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     getMyStatusArray(): Promise<Message[]>;

package/dist/api/Client.js

@@ -1859,12 +1859,12 @@ class Client {
             let thumb;
             try {
                 linkData = (yield axios_1.default.get(`${((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.linkParser) || "https://link.openwa.cloud/api"}?url=${url}`)).data;
-                logging_1.log.info("Got link data", linkData);
+                logging_1.log.info("Got link data");
                 if (!thumbnail)
                     thumb = yield (0, tools_1.getDUrl)(linkData.image);
             }
             catch (error) {
-                logging_1.log.error(error);
+                console.error(error);
             }
             if (linkData && (thumbnail || thumb))
                 return yield this.sendMessageWithThumb(thumbnail || thumb, url, linkData.title, linkData.description, text, to);
@@ -3823,15 +3823,7 @@ class Client {
         });
     }
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES A TEXT STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Sends a formatted text story.
      * @param text The text to be displayed in the story
@@ -3852,15 +3844,7 @@ class Client {
         });
     }
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES AN IMAGE STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Posts an image story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
@@ -3873,15 +3857,7 @@ class Client {
         });
     }
     /**
-     * @deprecated
-     *
-     * :::danger
-     *
-     * Status features are broken for now. Please join our discord community for updates.
-     *
-     * :::
-     *
-     * [REQUIRES A VIDEO STORY LICENSE-KEY](https://gum.co/open-wa)
+     * {@license:restricted@}
      *
      * Posts a video story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
@@ -3907,7 +3883,6 @@ class Client {
         });
     }
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     deleteStatus(statusesToDelete) {
@@ -3927,7 +3902,6 @@ class Client {
         });
     }
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     deleteAllStatus() {
@@ -3948,7 +3922,6 @@ class Client {
         });
     }
     /**
-     * @deprecated
      * Alias for deleteStory
      */
     getMyStatusArray() {

package/dist/cli/cli-options.js

@@ -237,7 +237,19 @@ exports.optionList = [{
     {
         name: 'tunnel',
         type: Boolean,
-        description: "Expose a tunnel to your EASY API session - this is for testing and it is unsecured."
+        description: "Expose a tunnel to your EASY API session - this is for testing and it is unsecured. By default it will use a random cloudflare tunnel URL. Make sure you have cloudflared installed and running."
+    },
+    {
+        name: 'cf-tunnel-host-domain',
+        type: String,
+        typeLabel: '{yellow {underline "mycool.site"}}',
+        description: "If you have a domain set up in a cloudflare account and have run cloudflared login on your machine, you can use this to expose the tunnel on your own domain. For example, if you set --cf-tunnel-host-domain mycool.site, the tunnel will be exposed on https://session_id_owa.mycool.site"
+    },
+    {
+        name: 'cf-tunnel-namespace',
+        type: String,
+        typeLabel: '{yellow {underline "owa"}}',
+        description: "You can set a sub-subdomain namespace on which the tunnel will be exposed. Needs to be set in conjunction with --tunnel & --cf-tunnel-host-domain. For example, if you set --cf-tunnel-namespace owa, the tunnel will be exposed on https://session_id.owa.mycool.site"
     },
     {
         name: 'pm2',

package/dist/cli/index.js

@@ -201,7 +201,7 @@ function start() {
                 });
                 if (cliConfig.tunnel) {
                     spinner.info(`\n• Setting up external tunnel`);
-                    const tunnelUrl = yield (0, server_1.setupTunnel)(cliConfig, yield client.getTunnelCode(), PORT);
+                    const tunnelUrl = yield (0, server_1.setupTunnel)(cliConfig, PORT);
                     spinner.succeed(`\n\t${(0, terminal_link_1.default)('External address', tunnelUrl)}`);
                 }
                 const apiDocsUrl = cliConfig.apiHost ? `${cliConfig.apiHost}/api-docs/ ` : `${cliConfig.host.includes('http') ? '' : 'http://'}${cliConfig.host}:${PORT}/api-docs/ `;

package/dist/cli/integrations/chatwoot.js

@@ -51,6 +51,8 @@ const chatwootMiddleware = (cliConfig, client) => {
             var _a, _b, _c, _d;
             const promises = [];
             const { body } = req;
+            if (body.source_id)
+                return;
             if (!body)
                 return;
             if (body.event == "conversation_status_changed" && body.status == "resolved") {
@@ -407,7 +409,7 @@ class ChatwootClient {
             try {
                 const { data } = yield this.cwReq('post', `contacts`, {
                     "identifier": contact.id,
-                    "name": contact.formattedName || contact.id,
+                    "name": contact.formattedName || contact.name || contact.shortName || contact.id,
                     "phone_number": `+${contact.id.replace('@c.us', '')}`,
                     "avatar_url": contact.profilePicThumbObj.eurl,
                     "custom_attributes": Object.assign({ "wa:number": `${contact.id.replace('@c.us', '')}` }, contact)
@@ -440,7 +442,9 @@ class ChatwootClient {
                     content,
                     "message_type": message.fromMe ? "outgoing" : "incoming",
                     "private": false,
-                    echo_id: message.id
+                    echo_id: message.id,
+                    source_id: message.id,
+                    "content_attributes": message
                 });
                 return data;
             }
@@ -492,8 +496,8 @@ class ChatwootClient {
                         contactReg[message.chatId] = contact.id;
                     }
                     else {
-                        //create the contact
-                        contactReg[message.chatId] = (yield this.createContact(message.sender)).id;
+                        //create the contact (have to use chat.contact because it may be triggered by an agent doing an outgoing message)
+                        contactReg[message.chatId] = (yield this.createContact(message.chat.contact)).id;
                     }
                 }
                 if (!convoReg[message.chatId]) {

package/dist/cli/integrations/cloudflare.d.ts

@@ -0,0 +1,6 @@
+export declare const createCustomDomainTunnel: (cliConfig: any, PORT: number) => Promise<{
+    url: string;
+    connections: Promise<any>[];
+    child: any;
+    stop: () => Promise<void>;
+}>;

package/dist/cli/integrations/cloudflare.js

@@ -0,0 +1,76 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createCustomDomainTunnel = void 0;
+const cloudflared_1 = require("cloudflared");
+const __1 = require("../..");
+const createCustomDomainTunnel = (cliConfig, PORT) => __awaiter(void 0, void 0, void 0, function* () {
+    const { cfTunnelHostDomain, sessionId, cfTunnelNamespace } = cliConfig;
+    const sessionName = sessionId.replace(/[^A-Z0-9]/ig, "_").toLowerCase();
+    const tunnelName = `_owa_${sessionName}`;
+    const FQDN = `${sessionName}${cfTunnelNamespace ? `.${cfTunnelNamespace}` : `_owa`}.${cfTunnelHostDomain}`;
+    const hostname = `https://${FQDN}`;
+    const target = `http://localhost:${PORT}`;
+    const logData = (data) => __1.log.info(`CLOUDFLARE TUNNEL: ${typeof data === "object" ? JSON.stringify(data, null, 2) : data}`);
+    // simlpe helper function to convert child proc to a promise and log the output
+    const cfp = (child) => {
+        return new Promise((resolve, reject) => {
+            var _a, _b;
+            (_a = child.stdout) === null || _a === void 0 ? void 0 : _a.on('data', logData);
+            (_b = child.stderr) === null || _b === void 0 ? void 0 : _b.on('data', logData);
+            child.on('error', reject);
+            child.on('exit', (code) => {
+                if (code === 0) {
+                    resolve(true);
+                }
+                else {
+                    reject(`Exit code: ${code}`);
+                }
+            });
+        });
+    };
+    __1.log.info(`Checking if tunnel ${tunnelName} exists...`);
+    const tunnelExists = yield new Promise((resolve) => {
+        const check = (data) => {
+            logData(data.toString());
+            return resolve(!data.toString().includes("error"));
+        };
+        const { child } = (0, cloudflared_1.tunnel)({ "info": tunnelName });
+        child.stdout.once('data', check);
+        child.stderr.once('data', check);
+    });
+    if (!tunnelExists) {
+        __1.log.info("Tunnel does not exist, creating...");
+        yield cfp((0, cloudflared_1.tunnel)({ "create": tunnelName }).child);
+    }
+    __1.log.info(`Routing traffic to the tunnel via URL ${FQDN}...`);
+    yield cfp((0, cloudflared_1.tunnel)({ "route": "dns", "--overwrite-dns": null, [tunnelName]: FQDN }).child);
+    const { connections, child, stop } = (0, cloudflared_1.tunnel)({
+        "--url": target,
+        "--hostname": hostname,
+        "run": tunnelName
+    });
+    child.stdout.on('data', logData);
+    // wait for the all 4 connections to be established
+    const conns = yield Promise.all(connections);
+    // show the connections
+    __1.log.info("Connections Ready!", conns);
+    return {
+        url: hostname,
+        connections,
+        child,
+        stop: () => __awaiter(void 0, void 0, void 0, function* () {
+            stop();
+            yield cfp((0, cloudflared_1.tunnel)({ "delete": tunnelName }).child);
+        })
+    };
+});
+exports.createCustomDomainTunnel = createCustomDomainTunnel;

package/dist/cli/server.d.ts

@@ -17,7 +17,7 @@ export declare const setupMetaProcessMiddleware: (client: Client, cliConfig: any
 export declare const getCommands: () => any;
 export declare const listListeners: () => string[];
 export declare const setupMediaMiddleware: () => void;
-export declare const setupTunnel: (cliConfig: any, tunnelCode: string, PORT: number) => Promise<string>;
+export declare const setupTunnel: (cliConfig: any, PORT: number) => Promise<string>;
 export declare const setupTwilioCompatibleWebhook: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupChatwoot: (cliConfig: cliFlags, client: Client) => void;
 export declare const setupBotPressHandler: (cliConfig: cliFlags, client: Client) => void;

package/dist/cli/server.js

@@ -52,11 +52,13 @@ const xmlbuilder2_1 = require("xmlbuilder2");
 const chatwoot_1 = require("./integrations/chatwoot");
 const express_ipfilter_1 = require("express-ipfilter");
 const helmet_1 = __importDefault(require("helmet"));
-const localtunnel_1 = __importDefault(require("localtunnel"));
+const cloudflared_1 = require("cloudflared");
 const child_process_1 = require("child_process");
+const cloudflare_1 = require("./integrations/cloudflare");
 exports.app = (0, express_1.default)();
 exports.server = http_1.default.createServer(exports.app);
-let tunnel;
+// will be used to clean up cloudflared tunnel
+let stop;
 const trimChatId = (chatId) => chatId.replace("@c.us", "").replace("@g.us", "");
 const socketListenerCallbacks = {};
 // const existingListeners = () => Object.keys(Object.keys(socketListenerCallbacks).flatMap(id=>Object.keys(socketListenerCallbacks[id])).reduce((acc,curr)=>{acc[curr]=true;return acc},{}))
@@ -262,8 +264,8 @@ const setupMetaProcessMiddleware = (client, cliConfig) => {
         closing = true;
         yield client.kill("API_KILL");
         __1.log.info("Waiting for maximum ");
-        if (tunnel && tunnel.close && typeof tunnel.close === 'function')
-            tunnel.close();
+        if (stop && typeof stop === 'function')
+            stop();
         yield Promise.race([
             new Promise((resolve) => exports.server.close(() => {
                 console.log('Server closed');
@@ -319,14 +321,14 @@ const setupMediaMiddleware = () => {
     exports.app.use("/media", express_1.default.static('media'));
 };
 exports.setupMediaMiddleware = setupMediaMiddleware;
-const setupTunnel = (cliConfig, tunnelCode, PORT) => __awaiter(void 0, void 0, void 0, function* () {
-    tunnel = yield (0, localtunnel_1.default)({
-        port: PORT,
-        host: process.env.WA_TUNNEL_SERVER || "https://public.openwa.cloud",
-        subdomain: tunnelCode
-    });
-    cliConfig.apiHost = cliConfig.tunnel = tunnel.url;
-    return tunnel.url;
+const setupTunnel = (cliConfig, PORT) => __awaiter(void 0, void 0, void 0, function* () {
+    const cfT = cliConfig.cfTunnelHostDomain ? yield (0, cloudflare_1.createCustomDomainTunnel)(cliConfig, PORT) : (0, cloudflared_1.tunnel)({ "--url": `localhost:${PORT}` });
+    stop = cfT.stop;
+    const url = yield cfT.url;
+    const conns = yield Promise.all(cfT.connections);
+    __1.log.info(`Connections Ready! ${conns}`);
+    cliConfig.apiHost = cliConfig.tunnel = url;
+    return url;
 });
 exports.setupTunnel = setupTunnel;
 const setupTwilioCompatibleWebhook = (cliConfig, client) => {

package/dist/controllers/initializer.js

@@ -323,6 +323,7 @@ function create(config = {}) {
             }
             if (config.logInternalEvents)
                 yield waPage.evaluate("debugEvents=true");
+            yield waPage.evaluate("window.critlis=true");
             const tI = yield (0, tools_1.timePromise)(() => (0, init_patch_1.injectInternalEventHandler)(waPage));
             logging_1.log.info(`Injected internal event handler: ${tI} ms`);
             if (attemptingReauth) {

package/dist/logging/logging.js

@@ -47,6 +47,26 @@ const sensitiveKeys = [
     /token/i,
     /api[-._]?key/i,
 ];
+const getCircularReplacer = () => {
+    const seen = new WeakSet();
+    return (_key, value) => {
+        if (typeof value === "object" && value !== null) {
+            if (seen.has(value)) {
+                return "[Circular]";
+            }
+            seen.add(value);
+        }
+        return value;
+    };
+};
+const k = (obj) => {
+    try {
+        return (0, full_1.klona)(obj);
+    }
+    catch (error) {
+        return (0, full_1.klona)(JSON.parse(JSON.stringify(obj, getCircularReplacer())));
+    }
+};
 function isSensitiveKey(keyStr) {
     if (keyStr && typeof keyStr == "string") {
         return sensitiveKeys.some(regex => regex.test(keyStr));
@@ -63,7 +83,7 @@ function redactObject(obj) {
     });
 }
 function redact(obj) {
-    const copy = (0, full_1.klona)(obj); // Making a deep copy to prevent side effects
+    const copy = k(obj); // Making a deep copy to prevent side effects
     redactObject(copy);
     const splat = copy[Symbol.for("splat")];
     redactObject(splat); // Specifically redact splat Symbol
@@ -74,7 +94,7 @@ function truncate(str, n) {
 }
 const formatRedact = winston.format(redact);
 const stringSaver = winston.format((info) => {
-    const copy = (0, full_1.klona)(info);
+    const copy = k(info);
     const splat = copy[Symbol.for("splat")];
     if (splat) {
         copy.message = `${copy.message} ${splat.filter((x) => typeof x !== 'object').join(' ')}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.67.0",
+  "version": "4.68.0",
   "licenseCheckUrl": "https://funcs.openwa.dev/license-check",
   "brokenMethodReportUrl": "https://funcs.openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",
@@ -72,7 +72,6 @@
     "@types/express": "^4.17.11",
     "@types/fs-extra": "^9.0.11",
     "@types/line-reader": "0.0.34",
-    "@types/localtunnel": "^2.0.1",
     "@types/marked": "^4.0.2",
     "@types/mime": "^3.0.1",
     "@types/node": "^18.7.6",
@@ -106,7 +105,7 @@
   "dependencies": {
     "@brillout/import": "^0.2.1",
     "@discordjs/collection": "0.8.0",
-    "@open-wa/wa-automate-socket-client": "*",
+    "@open-wa/wa-automate-socket-client": "^3.3.0",
     "@open-wa/wa-decrypt": "^4.3.1",
     "atob": "^2.1.2",
     "aws4": "^1.11.0",
@@ -116,6 +115,7 @@
     "change-case": "^4.1.2",
     "chokidar": "^3.5.3",
     "chrome-launcher": "^0.15.0",
+    "cloudflared": "^0.5.1",
     "command-exists": "^1.2.9",
     "command-line-usage": "^6.1.1",
     "cors": "^2.8.5",
@@ -138,7 +138,6 @@
     "is-url-superb": "^5.0.0",
     "json5": "^2.2.0",
     "klona": "^2.0.5",
-    "localtunnel": "^2.0.2",
     "lodash.uniq": "^4.5.0",
     "meow": "^9.0.0",
     "mime": "^3.0.0",