@open-wa/wa-automate 4.28.9 → 4.28.13

package/dist/api/Client.d.ts

@@ -40,6 +40,7 @@ export declare class Client {
     private _prio;
     private _pageListeners;
     private _registeredPageListeners;
+    private _onLogoutCallbacks;
     private _queues;
     /**
      * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
@@ -111,13 +112,18 @@ export declare class Client {
      *
      * @event
      * @param fn callback
+     * @param priority A priority of -1 will mean the callback will be triggered after all the non -1 callbacks
      * @fires `true`
      */
     onLogout(fn: (loggedOut?: boolean) => any, priority?: number): Promise<boolean>;
     /**
      * Wait for the webhook queue to become idle. This is useful for ensuring webhooks are cleared before ending a process.
      */
-    waitWhQIdle(): Promise<any>;
+    waitWhQIdle(): Promise<true | void>;
+    /**
+     * Wait for all queues to be empty
+     */
+    waitAllQEmpty(): Promise<true | void[]>;
     /**
      * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
      */
@@ -794,6 +800,10 @@ export declare class Client {
      */
     getAllContacts(): Promise<Contact[]>;
     getWAVersion(): Promise<string>;
+    /**
+     * Generate a pre-filled github issue link to easily report a bug
+     */
+    getIssueLink(): Promise<string>;
     /**
      * Retrieves if the phone is online. Please note that this may not be real time.
      * @returns Boolean

package/dist/api/Client.js

@@ -90,6 +90,7 @@ class Client {
         this._prio = Number.MAX_SAFE_INTEGER;
         this._pageListeners = [];
         this._registeredPageListeners = [];
+        this._onLogoutCallbacks = [];
         this._queues = {};
         /**
          * This is used to track if a listener is already used via webhook. Before, webhooks used to be set once per listener. Now a listener can be set via multiple webhooks, or revoked from a specific webhook.
@@ -260,16 +261,17 @@ class Client {
                 }));
             }
             if (((_h = this._createConfig) === null || _h === void 0 ? void 0 : _h.deleteSessionDataOnLogout) || ((_j = this._createConfig) === null || _j === void 0 ? void 0 : _j.killClientOnLogout)) {
-                this.onLogout(() => {
-                    var _a, _b;
-                    if ((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.deleteSessionDataOnLogout)
+                this.onLogout(() => __awaiter(this, void 0, void 0, function* () {
+                    var _k, _l;
+                    yield this.waitAllQEmpty();
+                    if ((_k = this._createConfig) === null || _k === void 0 ? void 0 : _k.deleteSessionDataOnLogout)
                         (0, browser_1.deleteSessionData)(this._createConfig);
-                    if ((_b = this._createConfig) === null || _b === void 0 ? void 0 : _b.killClientOnLogout) {
+                    if ((_l = this._createConfig) === null || _l === void 0 ? void 0 : _l.killClientOnLogout) {
                         console.log("Session logged out. Killing client");
                         logging_1.log.warn("Session logged out. Killing client");
                         this.kill("LOGGED_OUT");
                     }
-                });
+                }), -1);
             }
         });
     }
@@ -567,27 +569,47 @@ class Client {
         });
         if (this._registeredPageListeners.includes(event))
             return true;
+        this._registeredPageListeners.push(event);
+        logging_1.log.info(`setting page listener: ${event}`, this._registeredPageListeners);
         this._page.on(event, (...args) => __awaiter(this, void 0, void 0, function* () {
-            return yield Promise.all(this._pageListeners.filter(l => l.event === event).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            yield Promise.all(this._pageListeners.filter(l => l.event === event).filter(({ priority }) => priority !== -1).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            yield Promise.all(this._pageListeners.filter(l => l.event === event).filter(({ priority }) => priority == -1).sort((a, b) => (b.priority || 0) - (a.priority || 0)).map(l => l.callback(...args)));
+            return;
         }));
-        this._registeredPageListeners.push(event);
     }
     /**
      * Listens to a log out event
      *
      * @event
      * @param fn callback
+     * @param priority A priority of -1 will mean the callback will be triggered after all the non -1 callbacks
      * @fires `true`
      */
     onLogout(fn, priority) {
         return __awaiter(this, void 0, void 0, function* () {
-            this.registerPageEventListener('framenavigated', (frame) => __awaiter(this, void 0, void 0, function* () {
+            const event = 'framenavigated';
+            this._onLogoutCallbacks.push({
+                callback: fn,
+                priority
+            });
+            if (!this._queues[event])
+                this._queues[event] = new p_queue_1.default({
+                    concurrency: 1,
+                    intervalCap: 1,
+                    carryoverConcurrencyCount: true
+                });
+            if (this._registeredPageListeners.includes(event))
+                return true;
+            this.registerPageEventListener(event, (frame) => __awaiter(this, void 0, void 0, function* () {
                 if (frame.url().includes('post_logout=1')) {
                     console.log("LOGGED OUT");
                     logging_1.log.warn("LOGGED OUT");
-                    yield fn(true);
+                    yield Promise.all(this._onLogoutCallbacks.filter(c => c.priority !== -1).map(({ callback }) => this._queues[event].add(() => callback(true))));
+                    yield this._queues[event].onEmpty();
+                    yield Promise.all(this._onLogoutCallbacks.filter(c => c.priority == -1).map(({ callback }) => this._queues[event].add(() => callback(true))));
+                    yield this._queues[event].onEmpty();
                 }
-            }), priority);
+            }), priority || 1);
             return true;
         });
     }
@@ -602,6 +624,18 @@ class Client {
             return true;
         });
     }
+    /**
+     * Wait for all queues to be empty
+     */
+    waitAllQEmpty() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.all([
+                this._webhookQueue,
+                ...Object.values(this._queues)
+            ].filter(q => q).map(q => q === null || q === void 0 ? void 0 : q.onEmpty()));
+            return true;
+        });
+    }
     /**
      * If you have set `onAnyMessage` or `onMessage` with the second parameter (PQueue options) then you may want to inspect their respective PQueue's.
      */
@@ -1816,6 +1850,14 @@ class Client {
             return yield this.pup(() => WAPI.getWAVersion());
         });
     }
+    /**
+     * Generate a pre-filled github issue link to easily report a bug
+     */
+    getIssueLink() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (0, tools_1.generateGHIssueLink)(this.getConfig(), this.getSessionInfo());
+        });
+    }
     /**
      * Retrieves if the phone is online. Please note that this may not be real time.
      * @returns Boolean

package/dist/api/model/sessionInfo.d.ts

@@ -12,6 +12,9 @@ export interface SessionInfo {
     NUM_HASH?: string;
     OW_KEY?: string;
     INSTANCE_ID?: string;
+    LATEST_VERSION?: boolean;
+    CLI?: boolean;
+    ACC_TYPE?: 'PERSONAL' | 'BUSINESS';
 }
 export interface HealthCheck {
     /**

package/dist/cli/index.js

@@ -39,6 +39,7 @@ const ready = (config) => __awaiter(void 0, void 0, void 0, function* () {
 function start() {
     return __awaiter(this, void 0, void 0, function* () {
         const { cliConfig, createConfig, PORT, spinner } = (0, setup_1.cli)();
+        process.env.OWA_CLI = "true";
         spinner.start("Launching EASY API");
         (0, server_1.setUpExpressApp)();
         if (cliConfig.cors)
@@ -108,11 +109,11 @@ function start() {
             client.onLogout(() => __awaiter(this, void 0, void 0, function* () {
                 console.error('!!!! CLIENT LOGGED OUT !!!!');
                 if (cliConfig && !cliConfig.noKillOnLogout) {
-                    yield client.waitWhQIdle();
+                    yield client.waitAllQEmpty();
                     console.error("Shutting down.");
                     process.exit();
                 }
-            }));
+            }), -1);
             if (cliConfig === null || cliConfig === void 0 ? void 0 : cliConfig.botPressUrl) {
                 spinner.info('Setting Up Botpress handler');
                 (0, server_1.setupBotPressHandler)(cliConfig, client);

package/dist/controllers/initializer.js

@@ -27,17 +27,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __rest = (this && this.__rest) || function (s, e) {
-    var t = {};
-    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
-        t[p] = s[p];
-    if (s != null && typeof Object.getOwnPropertySymbols === "function")
-        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
-            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
-                t[p[i]] = s[p[i]];
-        }
-    return t;
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -218,11 +207,10 @@ function create(config = {}) {
                 console.table(debugInfo);
                 logging_1.log.info('Debug info:', debugInfo);
             }
+            debugInfo.LATEST_VERSION = !((notifier === null || notifier === void 0 ? void 0 : notifier.update) && ((notifier === null || notifier === void 0 ? void 0 : notifier.update.latest) !== exports.pkg.version));
+            debugInfo.CLI = process.env.OWA_CLI && true || false;
             // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            spinner.succeed('Use this easy pre-filled link to report an issue: ' + `https://github.com/open-wa/wa-automate-nodejs/issues/new?template=bug_report.yaml&debug_info=${encodeURI(JSON.stringify(((_a) => {
-                var { OS, PAGE_UA } = _a, o = __rest(_a, ["OS", "PAGE_UA"]);
-                return o;
-            })(debugInfo), null, 2))}&environment=${`-%20OS:%20${encodeURI(debugInfo.OS)}%0A-%20Node:%20${encodeURI(process.versions.node)}%0A-%20npm:%20%0A`}`);
+            spinner.succeed('Use this easy pre-filled link to report an issue: ' + (0, tools_1.generateGHIssueLink)(config, debugInfo));
             if (canInjectEarly) {
                 if (attemptingReauth)
                     yield waPage.evaluate(`window.Store = {"Msg": true}`);

package/dist/utils/tools.d.ts

@@ -1,5 +1,6 @@
-import { DataURL } from '../api/model';
+import { ConfigObject, DataURL } from '../api/model';
 import { AxiosRequestConfig } from 'axios';
+import { SessionInfo } from '../api/model/sessionInfo';
 export declare const timeout: (ms: any) => Promise<unknown>;
 /**
  *  Use this to generate a more likely valid user agent. It makes sure it has the WA part and replaces any windows or linux os info with mac.
@@ -27,3 +28,4 @@ export declare const getDUrl: (url: string, optionsOverride?: AxiosRequestConfig
 export declare const base64MimeType: (dUrl: DataURL) => string;
 export declare const processSend: (message: string) => void;
 export declare const processSendData: (data?: any) => void;
+export declare const generateGHIssueLink: (config: ConfigObject, sessionInfo: SessionInfo, extras?: any) => string;

package/dist/utils/tools.js

@@ -23,8 +23,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processSendData = exports.processSend = exports.base64MimeType = exports.getDUrl = exports.isDataURL = exports.isBase64 = exports.camelize = exports.without = exports.getConfigFromProcessEnv = exports.smartUserAgent = exports.timeout = void 0;
+exports.generateGHIssueLink = exports.processSendData = exports.processSend = exports.base64MimeType = exports.getDUrl = exports.isDataURL = exports.isBase64 = exports.camelize = exports.without = exports.getConfigFromProcessEnv = exports.smartUserAgent = exports.timeout = void 0;
 const axios_1 = __importDefault(require("axios"));
+const child_process_1 = require("child_process");
 //@ts-ignore
 process.send = process.send || function () { };
 const timeout = ms => new Promise(resolve => setTimeout(resolve, ms, 'timeout'));
@@ -145,3 +146,24 @@ const processSendData = (data = {}) => {
     return;
 };
 exports.processSendData = processSendData;
+const generateGHIssueLink = (config, sessionInfo, extras = {}) => {
+    const npm_ver = (0, child_process_1.execSync)('npm -v');
+    const labels = [];
+    if (sessionInfo.CLI)
+        labels.push('CLI');
+    if (!sessionInfo.LATEST_VERSION)
+        labels.push('NCV');
+    labels.push(config.multiDevice ? 'MD' : 'Legacy');
+    if (sessionInfo.ACC_TYPE === 'BUSINESS')
+        labels.push('BHA');
+    if (sessionInfo.ACC_TYPE === 'PERSONAL')
+        labels.push('PHA');
+    const qp = Object.assign({ "template": "bug_report.yaml", 
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        "d_info": `${encodeURI(JSON.stringify(((_a) => {
+            var { OS, PAGE_UA } = _a, o = __rest(_a, ["OS", "PAGE_UA"]);
+            return o;
+        })(sessionInfo), null, 2))}`, "enviro": `${`-%20OS:%20${encodeURI(sessionInfo.OS)}%0A-%20Node:%20${encodeURI(process.versions.node)}%0A-%20npm:%20${(String(npm_ver)).replace(/\s/g, '')}`}`, "labels": labels.join(',') }, extras);
+    return `https://github.com/open-wa/wa-automate-nodejs/issues/new?${Object.keys(qp).map(k => `${k}=${qp[k]}`).join('&')}`;
+};
+exports.generateGHIssueLink = generateGHIssueLink;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.28.9",
+  "version": "4.28.13",
   "licenseCheckUrl": "https://openwa.dev/license-check",
   "brokenMethodReportUrl": "https://openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",
@@ -60,6 +60,9 @@
     "node": ">=12.18.3",
     "npm": ">=7.9.0"
   },
+  "resolutions": {
+    "colors": "1.4.0"
+  },
   "devDependencies": {
     "@types/changelog-parser": "^2.7.1",
     "@types/command-line-args": "^5.0.0",