@open-wa/wa-automate 4.76.0 → 5.0.0-alpha.2

package/dist/logging/custom_transport.d.ts

@@ -1,9 +0,0 @@
-import TransportStream from 'winston-transport';
-export declare class LogToEvTransport extends TransportStream {
-    constructor(opts?: any);
-    log(info: any, callback: any): any;
-}
-export declare class NoOpTransport extends TransportStream {
-    constructor(opts?: any);
-    log(info: any, callback: any): any;
-}

package/dist/logging/custom_transport.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoOpTransport = exports.LogToEvTransport = void 0;
-const winston_transport_1 = __importDefault(require("winston-transport"));
-const events_1 = require("../controllers/events");
-class LogToEvTransport extends winston_transport_1.default {
-    constructor(opts) {
-        super(opts);
-    }
-    log(info, callback) {
-        setImmediate(() => {
-            this.emit('logged', info);
-        });
-        events_1.ev.emit(`DEBUG.${info.level}`, Object.keys(info).reduce((p, c) => (p = Object.assign(Object.assign({}, p), { [c]: info[c] })), {}));
-        if (callback)
-            return callback(null, true);
-    }
-}
-exports.LogToEvTransport = LogToEvTransport;
-class NoOpTransport extends winston_transport_1.default {
-    constructor(opts) {
-        super(opts);
-    }
-    log(info, callback) {
-        setImmediate(() => {
-            this.emit('logged', info);
-        });
-        if (callback)
-            return callback(null, true);
-    }
-}
-exports.NoOpTransport = NoOpTransport;

package/dist/logging/logging.d.ts

@@ -1,50 +0,0 @@
-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 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

@@ -1,196 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (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,
-];
-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));
-    }
-}
-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 = k(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 = k(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/Collector.d.ts

@@ -1,202 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/**
- * This code is a copy of the Discord Collector: https://github.com/discordjs/discord.js/blob/stable/src/structures/interfaces/Collector.js
- *
- * Please see: https://discord.js.org/#/docs/main/stable/class/Collector
- */
-import { Collection as BaseCollection } from '@discordjs/collection';
-import { EventEmitter } from 'events';
-export declare class Collection<K, V> extends BaseCollection<K, V> {
-    toJSON(): any[];
-}
-/**
- * Filter to be applied to the collector.
- * @typedef {Function} CollectorFilter
- * @param {...*} args Any arguments received by the listener
- * @param {Collection} collection The items collected by this collector
- * @returns {boolean|Promise<boolean>}
- */
-export type CollectorFilter<T extends any[]> = (...args: T) => boolean | Promise<boolean>;
-/**
- * Options to be applied to the collector.
- */
-export interface CollectorOptions {
-    /**
-     *The maximum amount of items to process
-     */
-    maxProcessed?: number;
-    /**
-     *  The maximum amount of items to collect
-     */
-    max?: number;
-    /**
-     * Max time to wait for items in milliseconds
-     */
-    time?: number;
-    /**
-     * Max time allowed idle
-     */
-    idle?: number;
-    /**
-     *  Whether to dispose data when it's deleted
-     */
-    dispose?: boolean;
-}
-export interface AwaitMessagesOptions extends CollectorOptions {
-    /**
-     * An array of "reasons" that would result in the awaitMessages command to throw an error.
-     */
-    errors?: string[];
-}
-/**
- * Abstract class for defining a new Collector.
- * @abstract
- */
-export declare class Collector extends EventEmitter {
-    filter: (...args: any[]) => boolean | Promise<boolean>;
-    options: CollectorOptions;
-    collected: Collection<string, any>;
-    protected _timeout: NodeJS.Timeout;
-    protected _idletimeout: NodeJS.Timeout;
-    ended: boolean;
-    /**
-     * Timeouts set by {@link BaseClient#setTimeout} that are still active
-     * @type {Set<Timeout>}
-     * @private
-     */
-    protected _timeouts: Set<NodeJS.Timeout>;
-    /**
-     * Intervals set by {@link BaseClient#setInterval} that are still active
-     * @type {Set<Timeout>}
-     * @private
-     */
-    protected _intervals: Set<NodeJS.Timeout>;
-    /**
-     * Intervals set by {@link BaseClient#setImmediate} that are still active
-     * @type {Set<Immediate>}
-     * @private
-     */
-    protected _immediates: Set<NodeJS.Immediate>;
-    constructor(filter: CollectorFilter<any>, options?: CollectorOptions);
-    /**
-     * Call this to handle an event as a collectable element. Accepts any event data as parameters.
-     * @param {...*} args The arguments emitted by the listener
-     * @emits Collector#collect
-     */
-    handleCollect(...args: any[]): Promise<void>;
-    /**
-     * Call this to remove an element from the collection. Accepts any event data as parameters.
-     * @param {...*} args The arguments emitted by the listener
-     * @emits Collector#dispose
-     */
-    handleDispose(...args: any[]): Promise<void>;
-    /**
-     * Returns a promise that resolves with the next collected element;
-     * rejects with collected elements if the collector finishes without receiving a next element
-     * @type {Promise}
-     * @readonly
-     */
-    get next(): Promise<any>;
-    /**
-     * Stops this collector and emits the `end` event.
-     * @param {string} [reason='user'] The reason this collector is ending
-     * @emits Collector#end
-     */
-    stop(reason?: string): void;
-    /**
-     * Resets the collectors timeout and idle timer.
-     * @param {Object} [options] Options
-     * @param {number} [options.time] How long to run the collector for in milliseconds
-     * @param {number} [options.idle] How long to stop the collector after inactivity in milliseconds
-     */
-    resetTimer({ time, idle }?: {
-        time: any;
-        idle: any;
-    }): void;
-    /**
-     * Checks whether the collector should end, and if so, ends it.
-     */
-    checkEnd(): void;
-    /**
-     * Allows collectors to be consumed with for-await-of loops
-     * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of}
-     */
-    [Symbol.asyncIterator](): any;
-    /**
-     * Handles incoming events from the `handleCollect` function. Returns null if the event should not
-     * be collected, or returns an object describing the data that should be stored.
-     * @see Collector#handleCollect
-     * @param {...*} _args Any args the event listener emits
-     * @returns the id if the object should be collected, if it shouldnt be collected then it will return null or false.
-     * @abstract
-     */
-    collect(...args: any[]): string | null | false;
-    /**
-     * Handles incoming events from the `handleDispose`. Returns null if the event should not
-     * be disposed, or returns the key that should be removed.
-     * @see Collector#handleDispose
-     * @param {...*} args Any args the event listener emits
-     * @returns {?*} Key to remove from the collection, if any
-     * @abstract
-     */
-    dispose(...args: any[]): string | null;
-    /**
-     * The reason this collector has ended or will end with.
-     * @returns {?string} Reason to end the collector, if any
-     * @abstract
-     */
-    endReason(...args: any[]): string | null;
-    /**
-     * Clears a timeout.
-     * @param {Timeout} timeout Timeout to cancel
-     */
-    clearTimeout(timeout: NodeJS.Timeout): void;
-    /**
-     * Sets an interval that will be automatically cancelled if the client is destroyed.
-     * @param {Function} fn Function to execute
-     * @param {number} delay Time to wait between executions (in milliseconds)
-     * @param {...*} args Arguments for the function
-     * @returns {Timeout}
-     */
-    setInterval(fn: (...args: any[]) => any, delay: number, ...args: any[]): NodeJS.Timeout;
-    /**
-     * Clears an interval.
-     * @param {Timeout} interval Interval to cancel
-     */
-    clearInterval(interval: NodeJS.Timeout): void;
-    /**
-     * Sets an immediate that will be automatically cancelled if the client is destroyed.
-     * @param {Function} fn Function to execute
-     * @param {...*} args Arguments for the function
-     * @returns {Immediate}
-     */
-    setImmediate(fn: (...args: any[]) => any, ...args: any[]): NodeJS.Immediate;
-    /**
-     * Clears an immediate.
-     * @param {Immediate} immediate Immediate to cancel
-     */
-    clearImmediate(immediate: NodeJS.Immediate): void;
-    /**
-     * Increments max listeners by one, if they are not zero.
-     * @private
-     */
-    protected incrementMaxListeners(): void;
-    /**
-     * Decrements max listeners by one, if they are not zero.
-     * @private
-     */
-    protected decrementMaxListeners(): void;
-    /**
-     * Sets a timeout that will be automatically cancelled if the client is destroyed.
-     * @param {Function} fn Function to execute
-     * @param {number} delay Time to wait before executing (in milliseconds)
-     * @param {...*} args Arguments for the function
-     * @returns {Timeout}
-     */
-    setTimeout(fn: (...args: any[]) => any, delay: number, ...args: any[]): NodeJS.Timeout;
-    /**
-     * Destroys all assets used by the base client.
-     */
-    destroy(): void;
-}