@open-wa/wa-automate 4.27.9 → 4.28.0

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;

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 = [{

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

package/dist/controllers/browser.js

@@ -42,7 +42,7 @@ 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");
 let browser;
 function initPage(sessionId, config, customUserAgent, spinner, _page, skipAuth) {
     var _a, _b, _c, _d, _e;

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'));
 };

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"));
@@ -80,6 +80,27 @@ const makeLogger = () => winston.createLogger({
 });
 /**
  * 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 +111,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 +130,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 +148,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.27.9",
+  "version": "4.28.0",
   "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[];