@open-wa/wa-automate 4.27.9 → 4.28.3

package/dist/api/Client.d.ts

@@ -397,7 +397,7 @@ export declare class Client {
      * Shuts down the page and browser
      * @returns true
      */
-    kill(): Promise<boolean>;
+    kill(reason?: string): Promise<boolean>;
     /**
      * This is a convinient method to click the `Use Here` button in the WA web session.
      *

package/dist/api/Client.js

@@ -68,7 +68,7 @@ const MessageCollector_1 = require("../structures/MessageCollector");
 const init_patch_1 = require("../controllers/init_patch");
 const preProcessors_1 = require("../structures/preProcessors");
 const tools_1 = require("../utils/tools");
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
 /** @ignore */
 const pkg = (0, fs_extra_1.readJsonSync)(path.join(__dirname, '../../package.json'));
 var namespace;
@@ -267,7 +267,7 @@ class Client {
                     if ((_b = this._createConfig) === null || _b === void 0 ? void 0 : _b.killClientOnLogout) {
                         console.log("Session logged out. Killing client");
                         logging_1.log.warn("Session logged out. Killing client");
-                        this.kill();
+                        this.kill("LOGGED_OUT");
                     }
                 });
             }
@@ -290,7 +290,7 @@ class Client {
             if (!this._refreshing) {
                 console.log("Browser page has closed. Killing client");
                 logging_1.log.warn("Browser page has closed. Killing client");
-                this.kill();
+                this.kill("PAGE_CLOSED");
                 if ((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.killProcessOnBrowserClose)
                     process.exit();
             }
@@ -1038,7 +1038,7 @@ class Client {
      * Shuts down the page and browser
      * @returns true
      */
-    kill() {
+    kill(reason = "MANUALLY_KILLED") {
         var _a, _b, _c, _d, _e, _f, _g;
         return __awaiter(this, void 0, void 0, function* () {
             if (this._currentlyBeingKilled)
@@ -1046,6 +1046,9 @@ class Client {
             this._currentlyBeingKilled = true;
             console.log('Killing client. Shutting Down');
             logging_1.log.info('Killing client. Shutting Down');
+            (0, tools_1.processSendData)({
+                reason
+            });
             const browser = yield ((_a = this === null || this === void 0 ? void 0 : this._page) === null || _a === void 0 ? void 0 : _a.browser());
             const pid = (browser === null || browser === void 0 ? void 0 : browser.process()) ? (_b = browser === null || browser === void 0 ? void 0 : browser.process()) === null || _b === void 0 ? void 0 : _b.pid : null;
             try {

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

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import { PREPROCESSORS } from '../../structures/preProcessors';
-import { ConfigLogTransport } from '../../utils/logging';
+import { ConfigLogTransport } from '../../logging/logging';
 import { Base64 } from "./aliases";
 import { SimpleListener } from './events';
 /**

package/dist/cli/setup.js

@@ -43,7 +43,7 @@ const uuid_apikey_1 = __importDefault(require("uuid-apikey"));
 const events_1 = require("../controllers/events");
 const is_url_superb_1 = __importDefault(require("is-url-superb"));
 const path = __importStar(require("path"));
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
 let checkUrl = url => typeof url === 'string' ? (0, is_url_superb_1.default)(url) : false;
 const configWithCases = (0, fs_extra_1.readJsonSync)(path.join(__dirname, '../../bin/config-schema.json'));
 const optionList = [{
@@ -273,7 +273,7 @@ const optionList = [{
     }
 ];
 exports.optionKeys = optionList.map(({ name }) => (0, tools_1.camelize)(name));
-exports.optionKeysWithDefalts = optionList.filter(o => o.hasOwnProperty('default')).map(({ name }) => (0, tools_1.camelize)(name));
+exports.optionKeysWithDefalts = [...optionList.filter(o => o.hasOwnProperty('default')).map(({ name }) => (0, tools_1.camelize)(name)), 'popup'];
 exports.PrimitiveConverter = {
     Number: 1,
     Boolean: true,

package/dist/controllers/auth.js

@@ -39,7 +39,7 @@ const initializer_1 = require("./initializer");
 const tools_1 = require("../utils/tools");
 const browser_1 = require("./browser");
 const axios_1 = __importDefault(require("axios"));
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
 const timeout = ms => new Promise(resolve => setTimeout(resolve, ms, 'timeout'));
 /**
  * Validates if client is authenticated
@@ -131,8 +131,9 @@ function smartQr(waPage, config, spinner) {
                     qrNum++;
                     (0, tools_1.processSend)('ready');
                     if (config.qrMax && qrNum >= config.qrMax) {
-                        spinner.info('QR Code limit reached, exiting');
-                        yield (0, browser_1.kill)(waPage, null, true);
+                        spinner.info('QR Code limit reached, exiting...');
+                        yield timeout(3000);
+                        yield (0, browser_1.kill)(waPage, null, true, null, "QR_LIMIT_REACHED");
                     }
                     if (config.ezqr || config.inDocker) {
                         const host = 'https://qr.openwa.cloud/';

package/dist/controllers/browser.d.ts

@@ -9,4 +9,4 @@ export declare function injectApi(page: Page): Promise<Page>;
 /**
  * @internal
  */
-export declare const kill: (p: Page, b?: Browser, exit?: boolean, pid?: number) => Promise<void>;
+export declare const kill: (p: Page, b?: Browser, exit?: boolean, pid?: number, reason?: string) => Promise<void>;

package/dist/controllers/browser.js

@@ -42,7 +42,8 @@ const pico_s3_1 = require("pico-s3");
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const puppeteer = require('puppeteer-extra');
 const tree_kill_1 = __importDefault(require("tree-kill"));
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
+const tools_1 = require("../utils/tools");
 let browser;
 function initPage(sessionId, config, customUserAgent, spinner, _page, skipAuth) {
     var _a, _b, _c, _d, _e;
@@ -377,7 +378,11 @@ function getWAPage(browser) {
 /**
  * @internal
  */
-const kill = (p, b, exit, pid) => __awaiter(void 0, void 0, void 0, function* () {
+const kill = (p, b, exit, pid, reason = "LAUNCH_KILL") => __awaiter(void 0, void 0, void 0, function* () {
+    (0, tools_1.processSendData)({
+        type: "close",
+        reason
+    });
     const killBrowser = (browser) => __awaiter(void 0, void 0, void 0, function* () {
         if (!browser)
             return;

package/dist/controllers/events.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Spin = exports.EvEmitter = exports.ev = void 0;
 const eventemitter2_1 = require("eventemitter2");
 const spinnies_1 = __importDefault(require("spinnies"));
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
 const spinner = {
     "interval": 80,
     "frames": [

package/dist/controllers/initializer.js

@@ -61,7 +61,7 @@ const fs_extra_1 = require("fs-extra");
 const pico_s3_1 = require("pico-s3");
 const init_patch_1 = require("./init_patch");
 const patch_manager_1 = require("./patch_manager");
-const logging_1 = require("../utils/logging");
+const logging_1 = require("../logging/logging");
 const timeout = (ms) => {
     return new Promise(resolve => setTimeout(resolve, ms, 'timeout'));
 };
@@ -367,12 +367,12 @@ function create(config = {}) {
                 waPage.on('console', msg => {
                     if (config === null || config === void 0 ? void 0 : config.logConsole)
                         console.log(msg);
-                    logging_1.log.info('Page Console:', { msg });
+                    logging_1.log.info('Page Console:', msg.text());
                 });
                 waPage.on('error', error => {
                     if (config === null || config === void 0 ? void 0 : config.logConsoleErrors)
                         console.error(error);
-                    logging_1.log.error('Page Console:', { error });
+                    logging_1.log.error('Page Console Error:', error.text());
                 });
                 if (config === null || config === void 0 ? void 0 : config.restartOnCrash)
                     waPage.on('error', (error) => __awaiter(this, void 0, void 0, function* () {

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { create } from './controllers/initializer';
 export * from '@open-wa/wa-decrypt';
 export { ev, Spin } from './controllers/events';
 export * from './utils/tools';
+export * from './logging/logging';
 export * from './structures/preProcessors';
 export * from './connect';
 export * from './build/build-postman';

package/dist/index.js

@@ -20,6 +20,7 @@ var events_1 = require("./controllers/events");
 Object.defineProperty(exports, "ev", { enumerable: true, get: function () { return events_1.ev; } });
 Object.defineProperty(exports, "Spin", { enumerable: true, get: function () { return events_1.Spin; } });
 __exportStar(require("./utils/tools"), exports);
+__exportStar(require("./logging/logging"), exports);
 __exportStar(require("./structures/preProcessors"), exports);
 __exportStar(require("./connect"), exports);
 //dont need to export this

package/dist/logging/logging.d.ts

@@ -0,0 +1,50 @@
+import * as winston from 'winston';
+/**
+ * You can access the log in your code and add your own custom transports
+ * https://github.com/winstonjs/winston#transports
+ * see [Logger](https://github.com/winstonjs/winston#transports) for more details.
+ *
+ * Here is an example of adding the GCP stackdriver transport:
+ *
+ * ```
+ * import { log } from '@open-wa/wa-automate'
+ * import { LoggingWinston } from '@google-cloud/logging-winston';
+ *
+ * const gcpTransport = new LoggingWinston({
+ *     projectId: 'your-project-id',
+ *     keyFilename: '/path/to/keyfile.json'
+ *   });
+ *
+ * ...
+ * log.add(
+ *  gcpTransport
+ * )
+ *
+ * //Congrats! Now all of your session logs will also go to GCP Stackdriver
+ * ```
+ */
+export declare const log: winston.Logger;
+export declare const addRotateFileLogTransport: (options?: any) => void;
+/**
+ * @private
+ */
+export declare const addSysLogTransport: (options?: any) => void;
+export declare type ConfigLogTransport = {
+    /**
+     * The type of winston transport. At the moment only `file`, `console`, `ev` and `syslog` are supported.
+     */
+    type: 'syslog' | 'console' | 'file' | 'ev';
+    /**
+     * The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports.
+     */
+    options?: any;
+    /**
+     * If the transport has already been added to the logger. The logging set up command handles this for you.
+     * @readonly
+     */
+    done?: boolean;
+};
+/**
+ * @private
+ */
+export declare const setupLogging: (logging: ConfigLogTransport[], sessionId?: string) => ConfigLogTransport[];

package/dist/{utils → logging}/logging.js

@@ -22,7 +22,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setupLogging = exports.addRotateFileLogTransport = exports.log = void 0;
+exports.setupLogging = exports.addSysLogTransport = exports.addRotateFileLogTransport = exports.log = void 0;
 const os_1 = __importDefault(require("os"));
 const winston = __importStar(require("winston"));
 const winston_daily_rotate_file_1 = __importDefault(require("winston-daily-rotate-file"));
@@ -69,17 +69,48 @@ function truncate(str, n) {
     return str.length > n ? str.substr(0, n - 1) + '...[TRUNCATED]...' : str;
 }
 const formatRedact = winston.format(redact);
+const stringSaver = winston.format((info) => {
+    const copy = (0, full_1.klona)(info);
+    const splat = copy[Symbol.for("splat")];
+    if (splat) {
+        copy.message = `${copy.message} ${splat.filter((x) => typeof x !== 'object').join(' ')}`;
+        copy[Symbol.for("splat")] = splat.filter((x) => typeof x == 'object');
+        return copy;
+    }
+    return info;
+});
 /**
  * To prevent "Attempt to write logs with no transports" error
  */
 const placeholderTransport = new custom_transport_1.NoOpTransport();
 const makeLogger = () => winston.createLogger({
-    format: combine(timestamp(), winston.format.json(), formatRedact(), winston.format.splat(), winston.format.simple()),
+    format: combine(stringSaver(), timestamp(), winston.format.json(), formatRedact(), winston.format.splat(), winston.format.simple()),
     levels: winston.config.syslog.levels,
     transports: [placeholderTransport]
 });
 /**
  * You can access the log in your code and add your own custom transports
+ * https://github.com/winstonjs/winston#transports
+ * see [Logger](https://github.com/winstonjs/winston#transports) for more details.
+ *
+ * Here is an example of adding the GCP stackdriver transport:
+ *
+ * ```
+ * import { log } from '@open-wa/wa-automate'
+ * import { LoggingWinston } from '@google-cloud/logging-winston';
+ *
+ * const gcpTransport = new LoggingWinston({
+ *     projectId: 'your-project-id',
+ *     keyFilename: '/path/to/keyfile.json'
+ *   });
+ *
+ * ...
+ * log.add(
+ *  gcpTransport
+ * )
+ *
+ * //Congrats! Now all of your session logs will also go to GCP Stackdriver
+ * ```
  */
 exports.log = makeLogger();
 if (exports.log.warning && !exports.log.warn)
@@ -90,9 +121,13 @@ const addRotateFileLogTransport = (options = {}) => {
     exports.log.add(new winston_daily_rotate_file_1.default(Object.assign({ filename: 'application-%DATE%.log', datePattern: 'YYYY-MM-DD-HH', zippedArchive: true, maxSize: '2m', maxFiles: '14d' }, options)));
 };
 exports.addRotateFileLogTransport = addRotateFileLogTransport;
+/**
+ * @private
+ */
 const addSysLogTransport = (options = {}) => {
     exports.log.add(new winston_syslog_1.Syslog(Object.assign({ localhost: os_1.default.hostname() }, options)));
 };
+exports.addSysLogTransport = addSysLogTransport;
 const enableConsoleLogger = (options = {}) => {
     if (_consoleSet)
         return;
@@ -105,6 +140,9 @@ function enableLogToEv(options = {}) {
     exports.log.add(new custom_transport_1.LogToEvTransport(Object.assign({ format: winston.format.json() }, options)));
     _evSet = true;
 }
+/**
+ * @private
+ */
 const setupLogging = (logging, sessionId = "session") => {
     const currentlySetup = [];
     const _logging = logging.map((l) => {
@@ -120,7 +158,7 @@ const setupLogging = (logging, sessionId = "session") => {
             (0, exports.addRotateFileLogTransport)(Object.assign({}, (l.options || {})));
         }
         else if (l.type === 'syslog') {
-            addSysLogTransport(Object.assign(Object.assign({}, (l.options || {})), { appName: `owa-${sessionId}-${d}` }));
+            (0, exports.addSysLogTransport)(Object.assign(Object.assign({}, (l.options || {})), { appName: `owa-${sessionId}-${d}` }));
         }
         currentlySetup.push(l);
         return Object.assign(Object.assign({}, l), { done: true });

package/dist/utils/tools.d.ts

@@ -25,3 +25,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) => boolean;

package/dist/utils/tools.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processSend = exports.base64MimeType = exports.getDUrl = exports.isDataURL = exports.isBase64 = exports.camelize = exports.without = exports.getConfigFromProcessEnv = exports.smartUserAgent = void 0;
+exports.processSendData = exports.processSend = exports.base64MimeType = exports.getDUrl = exports.isDataURL = exports.isBase64 = exports.camelize = exports.without = exports.getConfigFromProcessEnv = exports.smartUserAgent = void 0;
 const axios_1 = __importDefault(require("axios"));
 /**
  *  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.
@@ -133,3 +133,10 @@ const processSend = (message) => {
     return;
 };
 exports.processSend = processSend;
+const processSendData = (data = {}) => {
+    return process.send({
+        type: 'process:msg',
+        data
+    });
+};
+exports.processSendData = processSendData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.27.9",
+  "version": "4.28.3",
   "licenseCheckUrl": "https://openwa.dev/license-check",
   "brokenMethodReportUrl": "https://openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",

package/dist/utils/logging.d.ts

@@ -1,18 +0,0 @@
-import * as winston from 'winston';
-/**
- * You can access the log in your code and add your own custom transports
- */
-export declare const log: winston.Logger;
-export declare const addRotateFileLogTransport: (options?: any) => void;
-export declare type ConfigLogTransport = {
-    /**
-     * The type of winston transport. At the moment only file, console, ev and syslog are supported.
-     */
-    type: 'syslog' | 'console' | 'file' | 'ev';
-    /**
-     * The options for the transport. Generally only required for syslog but you can use this to override default options for other types of transports.
-     */
-    options?: any;
-    done?: boolean;
-};
-export declare const setupLogging: (logging: ConfigLogTransport[], sessionId?: string) => ConfigLogTransport[];