@open-wa/wa-automate 4.27.8 → 4.28.2

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/logging/logging.js

@@ -0,0 +1,172 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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"));
+const winston_syslog_1 = require("winston-syslog");
+const custom_transport_1 = require("./custom_transport");
+const { combine, timestamp } = winston.format;
+const traverse_1 = __importDefault(require("traverse"));
+const full_1 = require("klona/full");
+const truncateLength = 200;
+let _evSet = false, _consoleSet = false, d = Date.now();
+const sensitiveKeys = [
+    /cookie/i,
+    /sessionData/i,
+    /passw(or)?d/i,
+    /^pw$/,
+    /^pass$/i,
+    /secret/i,
+    /token/i,
+    /api[-._]?key/i,
+];
+function isSensitiveKey(keyStr) {
+    if (keyStr) {
+        return sensitiveKeys.some(regex => regex.test(keyStr));
+    }
+}
+function redactObject(obj) {
+    (0, traverse_1.default)(obj).forEach(function redactor() {
+        if (isSensitiveKey(this.key)) {
+            this.update("[REDACTED]");
+        }
+        else if (typeof this.node === 'string' && this.node.length > truncateLength) {
+            this.update(truncate(this.node, truncateLength));
+        }
+    });
+}
+function redact(obj) {
+    const copy = (0, full_1.klona)(obj); // Making a deep copy to prevent side effects
+    redactObject(copy);
+    const splat = copy[Symbol.for("splat")];
+    redactObject(splat); // Specifically redact splat Symbol
+    return copy;
+}
+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(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)
+    exports.log.warn = exports.log.warning;
+if (exports.log.alert && !exports.log.help)
+    exports.log.help = exports.log.alert;
+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;
+    exports.log.add(new winston.transports.Console(Object.assign({ level: 'debug', timestamp: timestamp() }, options)));
+    _consoleSet = true;
+};
+function enableLogToEv(options = {}) {
+    if (_evSet)
+        return;
+    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) => {
+        if (l.done)
+            return l;
+        if (l.type === 'console') {
+            enableConsoleLogger(Object.assign({}, (l.options || {})));
+        }
+        else if (l.type === 'ev') {
+            enableLogToEv(Object.assign({}, (l.options || {})));
+        }
+        else if (l.type === 'file') {
+            (0, exports.addRotateFileLogTransport)(Object.assign({}, (l.options || {})));
+        }
+        else if (l.type === 'syslog') {
+            (0, exports.addSysLogTransport)(Object.assign(Object.assign({}, (l.options || {})), { appName: `owa-${sessionId}-${d}` }));
+        }
+        currentlySetup.push(l);
+        return Object.assign(Object.assign({}, l), { done: true });
+    });
+    currentlySetup.map((l) => {
+        exports.log.info(`Set up logging for ${l.type}`, l.options);
+        return l;
+    });
+    return _logging;
+};
+exports.setupLogging = setupLogging;

package/dist/structures/preProcessors.js

@@ -41,7 +41,7 @@ const AUTO_DECRYPT_SAVE = (message, client) => __awaiter(void 0, void 0, void 0,
         const mediaData = yield client.decryptMedia(message);
         const filePath = `media/${filename}`;
         try {
-            fs_extra_1.outputFileSync(filePath, Buffer.from(mediaData.split(",")[1], "base64"));
+            (0, fs_extra_1.outputFileSync)(filePath, Buffer.from(mediaData.split(",")[1], "base64"));
         }
         catch (error) {
             console.error(error);
@@ -111,11 +111,11 @@ const UPLOAD_CLOUD = (message, client) => __awaiter(void 0, void 0, void 0, func
             console.error("UPLOAD ERROR: No provider provided. If you're using the CLI, set env var OW_CLOUD_PROVIDER");
             return message;
         }
-        const url = pico_s3_1.getCloudUrl(opts);
+        const url = (0, pico_s3_1.getCloudUrl)(opts);
         if (!processedFiles[filename]) {
             processedFiles[filename] = true;
             try {
-                yield uploadQueue.add(() => pico_s3_1.upload(opts).catch(() => { }));
+                yield uploadQueue.add(() => (0, pico_s3_1.upload)(opts).catch(() => { }));
             }
             catch (error) {
                 console.error(error);

package/dist/utils/configSchema.js

@@ -11,7 +11,7 @@ const defaultConfig = {
 const getConfigWithCase = (config) => {
     if (!config)
         config = defaultConfig;
-    const schema = ts_json_schema_generator_1.createGenerator(config).createSchema(config.type);
+    const schema = (0, ts_json_schema_generator_1.createGenerator)(config).createSchema(config.type);
     const ignoredConfigs = [
         'useStealth',
         'chromiumArgs',
@@ -40,7 +40,7 @@ const getConfigWithCase = (config) => {
         }
         return Object.assign(Object.assign({}, entry), { key });
     }).filter(({ type, key }) => type && !ignoredConfigs.includes(key));
-    const configWithCases = configs.map(o => (Object.assign({ env: `WA_${change_case_1.constantCase(o.key)}`, p: change_case_1.paramCase(o.key) }, o)));
+    const configWithCases = configs.map(o => (Object.assign({ env: `WA_${(0, change_case_1.constantCase)(o.key)}`, p: (0, change_case_1.paramCase)(o.key) }, o)));
     return configWithCases;
 };
 exports.getConfigWithCase = getConfigWithCase;

package/dist/utils/tools.js

@@ -96,7 +96,7 @@ exports.isDataURL = isDataURL;
 const getDUrl = (url, optionsOverride = {}) => __awaiter(void 0, void 0, void 0, function* () {
     // eslint-disable-next-line no-useless-catch
     try {
-        const res = yield axios_1.default(Object.assign(Object.assign({ method: 'get', url, headers: {
+        const res = yield (0, axios_1.default)(Object.assign(Object.assign({ method: 'get', url, headers: {
                 DNT: 1,
                 'Upgrade-Insecure-Requests': 1,
             } }, optionsOverride), { responseType: 'arraybuffer' }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-wa/wa-automate",
-  "version": "4.27.8",
+  "version": "4.28.2",
   "licenseCheckUrl": "https://openwa.dev/license-check",
   "brokenMethodReportUrl": "https://openwa.dev/report-bm",
   "patches": "https://cdn.openwa.dev/patches.json",
@@ -67,17 +67,16 @@
     "@types/cross-spawn": "^6.0.2",
     "@types/death": "^1.1.1",
     "@types/express": "^4.17.11",
-    "@types/form-data": "^2.5.0",
     "@types/fs-extra": "^9.0.11",
     "@types/line-reader": "0.0.34",
     "@types/localtunnel": "^2.0.1",
     "@types/marked": "^3.0.0",
     "@types/mime-types": "^2.1.0",
     "@types/node": "^16.0.0",
-    "@types/pino": "^6.3.8",
     "@types/puppeteer": "^5.4.0",
     "@types/shelljs": "^0.8.5",
-    "@typescript-eslint/eslint-plugin": "^4.15.2",
+    "@types/winston-syslog": "^2.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.8.0",
     "@typescript-eslint/parser": "^4.15.2",
     "auto-changelog": "^2.0.0",
     "ava": "^3.13.0",
@@ -95,7 +94,7 @@
     "shelljs": "^0.8.3",
     "ts-node": "^10.0.0",
     "tsc-watch": "^4.0.0",
-    "typedoc": "^0.21.0",
+    "typedoc": "^0.21.6",
     "typedoc-plugin-pages": "^1.0.1",
     "typescript": "^4.2.4"
   },
@@ -116,7 +115,7 @@
     "cross-spawn": "^7.0.3",
     "datauri": "^4.0.1",
     "death": "^1.1.0",
-    "eventemitter2": "^6.0.0",
+    "eventemitter2": "^6.4.4",
     "express": "^4.17.1",
     "express-robots-txt": "^1.0.0",
     "find-up": "^5.0.0",
@@ -127,6 +126,7 @@
     "image-type": "^4.1.0",
     "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",
@@ -138,7 +138,6 @@
     "parse-url": "^5.0.2",
     "patch-package": "^6.2.2",
     "pico-s3": "^1.0.1",
-    "pino": "^6.11.1",
     "postman-2-swagger": "^0.5.0",
     "puppeteer": "^13.0.0",
     "puppeteer-extra": "^3.2.3",
@@ -153,11 +152,12 @@
     "socket.io-client": "^4.1.1",
     "spinnies": "^0.5.1",
     "swagger-stats": "^0.99.1",
-    "swagger-ui-dist": "^3.36.1",
+    "swagger-ui-dist": "^4.1.3",
     "swagger-ui-express": "^4.1.4",
     "tcp-port-used": "^1.0.1",
     "terminal-link": "^2.1.1",
     "tiny-glob": "^0.2.9",
+    "traverse": "^0.6.6",
     "tree-kill": "^1.2.2",
     "ts-json-schema-generator": "^0.95.0",
     "ts-morph": "^12.0.0",
@@ -165,7 +165,10 @@
     "typeconv": "^1.7.0",
     "update-notifier": "^5.0.0",
     "uuid": "^8.3.2",
-    "uuid-apikey": "^1.4.6",
+    "uuid-apikey": "^1.5.3",
+    "winston": "^3.3.3",
+    "winston-daily-rotate-file": "^4.5.5",
+    "winston-syslog": "^2.4.4",
     "xmlbuilder2": "^3.0.2"
   }
 }