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

package/dist/structures/preProcessors.d.ts

@@ -1,58 +0,0 @@
-import { Client } from "../api/Client";
-import { Message } from "../api/model/message";
-/**
- * A function that takes a message and returns a message.
- *
- * @param message The message to be processed
- * @param client The client that received the message
- * @param alreadyProcessed Whether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)
- * @param source The source of the message. This is useful for knowing if the message is from onMessage or onAnyMessage. Only processing one source will prevent duplicate processing.
- */
-export type MessagePreProcessor = (message: Message, client?: Client, alreadyProcessed?: boolean, source?: 'onMessage' | 'onAnyMessage') => Promise<Message>;
-/**
- * An object that contains all available [[PREPROCESSORS]].
- *
- * [Check out the processor code here](https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts)
- */
-export declare const MessagePreprocessors: {
-    [processorName: string]: MessagePreProcessor;
-};
-/**
- * A set of easy to use, built-in message processors.
- *
- * [Check out the processor code here](https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts)
- *
- */
-export declare enum PREPROCESSORS {
-    /**
-     * This preprocessor scrubs `body` and `content` from media messages.
-     * This would be useful if you want to reduce the message object size because neither of these values represent the actual file, only the thumbnail.
-     */
-    SCRUB = "SCRUB",
-    /**
-     * A preprocessor that limits the amount of base64 data is present in the message object by removing duplication of `body` in `content` by replacing `content` with `""`.
-     */
-    BODY_ONLY = "BODY_ONLY",
-    /**
-     * Replaces the media thumbnail base64 in `body` with the actual file's DataURL.
-     */
-    AUTO_DECRYPT = "AUTO_DECRYPT",
-    /**
-     * Automatically saves the file in a folder named `/media` relative to the process working directory.
-     *
-     * PLEASE NOTE, YOU WILL NEED TO MANUALLY CLEAR THIS FOLDER!!!
-     */
-    AUTO_DECRYPT_SAVE = "AUTO_DECRYPT_SAVE",
-    /**
-     *
-     * Uploads file to a cloud storage provider (GCP/AWS for now).
-     *
-     * If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions) in the config.
-     *
-     */
-    UPLOAD_CLOUD = "UPLOAD_CLOUD"
-}
-/**
- * The actual type for [config.messagePreprocessor](/docs/api/interfaces/api_model_config.ConfigObject#messagepreprocessor)
- */
-export type MPConfigType = PREPROCESSORS | MessagePreProcessor | (PREPROCESSORS | MessagePreProcessor)[];

package/dist/structures/preProcessors.js

@@ -1,181 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PREPROCESSORS = exports.MessagePreprocessors = void 0;
-const mime_1 = __importDefault(require("mime"));
-const fs_extra_1 = require("fs-extra");
-const config_1 = require("../api/model/config");
-const p_queue_1 = __importDefault(require("p-queue"));
-const pico_s3_1 = require("pico-s3");
-const processedFiles = {};
-let uploadQueue;
-const SCRUB = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    if (message.deprecatedMms3Url && message.mimetype)
-        return Object.assign(Object.assign({}, message), { content: "", body: "" });
-    return message;
-});
-const BODY_ONLY = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    if (message.deprecatedMms3Url && message.mimetype)
-        return Object.assign(Object.assign({}, message), { content: "" });
-    return message;
-});
-const AUTO_DECRYPT = (message, client) => __awaiter(void 0, void 0, void 0, function* () {
-    if (message.deprecatedMms3Url && message.mimetype)
-        return Object.assign(Object.assign({}, message), { body: yield client.decryptMedia(message) });
-    return message;
-});
-const AUTO_DECRYPT_SAVE = (message, client, alreadyBeingProcessed) => __awaiter(void 0, void 0, void 0, function* () {
-    if (message.deprecatedMms3Url && message.mimetype) {
-        const filename = `${message.mId}.${mime_1.default.getExtension(message.mimetype)}`;
-        const filePath = `media/${filename}`;
-        if (alreadyBeingProcessed) {
-            return Object.assign(Object.assign({}, message), { body: filename, content: "", filePath });
-        }
-        try {
-            const mediaData = yield client.decryptMedia(message);
-            (0, fs_extra_1.outputFileSync)(filePath, Buffer.from(mediaData.split(",")[1], "base64"));
-        }
-        catch (error) {
-            console.error(error);
-            return message;
-        }
-        return Object.assign(Object.assign({}, message), { body: filename, content: "", filePath });
-    }
-    return message;
-});
-const UPLOAD_CLOUD = (message, client, alreadyBeingProcessed) => __awaiter(void 0, void 0, void 0, function* () {
-    if ((message === null || message === void 0 ? void 0 : message.deprecatedMms3Url) && message.mimetype) {
-        const { cloudUploadOptions } = client.getConfig();
-        if (message.fromMe && (cloudUploadOptions.ignoreHostAccount || process.env.OW_CLOUD_IGNORE_HOST))
-            return message;
-        if (!uploadQueue) {
-            uploadQueue = new p_queue_1.default({ concurrency: 2, interval: 1000, carryoverConcurrencyCount: true, intervalCap: 2 });
-        }
-        const filename = `${message.mId || `${Date.now()}`}.${mime_1.default.getExtension(message.mimetype)}`;
-        const mediaData = yield client.decryptMedia(message);
-        if (!cloudUploadOptions)
-            return message;
-        const provider = (process.env.OW_CLOUD_PROVIDER || cloudUploadOptions.provider);
-        const opts = {
-            file: mediaData,
-            filename,
-            provider,
-            accessKeyId: process.env.OW_CLOUD_ACCESS_KEY_ID || cloudUploadOptions.accessKeyId,
-            secretAccessKey: process.env.OW_CLOUD_SECRET_ACCESS_KEY || cloudUploadOptions.secretAccessKey,
-            bucket: process.env.OW_CLOUD_BUCKET || cloudUploadOptions.bucket,
-            region: process.env.OW_CLOUD_REGION || cloudUploadOptions.region,
-            public: process.env.OW_CLOUD_PUBLIC && true || cloudUploadOptions.public,
-            headers: cloudUploadOptions.headers,
-        };
-        const dirStrat = process.env.OW_DIRECTORY || cloudUploadOptions.directory;
-        if (dirStrat) {
-            let directory = '';
-            switch (dirStrat) {
-                case config_1.DIRECTORY_STRATEGY.DATE:
-                    directory = `${new Date().toISOString().slice(0, 10)}`;
-                    break;
-                case config_1.DIRECTORY_STRATEGY.CHAT:
-                    directory = `${message.from.replace("@c.us", "").replace("@g.us", "")}`;
-                    break;
-                case config_1.DIRECTORY_STRATEGY.DATE_CHAT:
-                    directory = `${new Date().toISOString().slice(0, 10)}/${message.from.replace("@c.us", "").replace("@g.us", "")}`;
-                    break;
-                case config_1.DIRECTORY_STRATEGY.CHAT_DATE:
-                    directory = `${message.from.replace("@c.us", "").replace("@g.us", "")}/${new Date().toISOString().slice(0, 10)}`;
-                    break;
-                default:
-                    directory = dirStrat;
-                    break;
-            }
-            opts.directory = directory;
-        }
-        if (!opts.accessKeyId) {
-            console.error("UPLOAD ERROR: No accessKeyId provided. If you're using the CLI, set env var OW_CLOUD_ACCESS_KEY_ID");
-            return message;
-        }
-        if (!opts.secretAccessKey) {
-            console.error("UPLOAD ERROR: No secretAccessKey provided. If you're using the CLI, set env var OW_CLOUD_SECRET_ACCESS_KEY");
-            return message;
-        }
-        if (!opts.bucket) {
-            console.error("UPLOAD ERROR: No bucket provided. If you're using the CLI, set env var OW_CLOUD_BUCKET");
-            return message;
-        }
-        if (!opts.provider) {
-            console.error("UPLOAD ERROR: No provider provided. If you're using the CLI, set env var OW_CLOUD_PROVIDER");
-            return message;
-        }
-        const url = (0, pico_s3_1.getCloudUrl)(opts);
-        if (!processedFiles[filename] && !alreadyBeingProcessed) {
-            processedFiles[filename] = true;
-            try {
-                yield uploadQueue.add(() => (0, pico_s3_1.upload)(opts).catch(() => { }));
-            }
-            catch (error) {
-                console.error(error);
-                return message;
-            }
-        }
-        return Object.assign(Object.assign({}, message), { cloudUrl: url });
-    }
-    return message;
-});
-/**
- * An object that contains all available [[PREPROCESSORS]].
- *
- * [Check out the processor code here](https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts)
- */
-exports.MessagePreprocessors = {
-    AUTO_DECRYPT_SAVE,
-    AUTO_DECRYPT,
-    BODY_ONLY,
-    SCRUB,
-    UPLOAD_CLOUD
-};
-/**
- * A set of easy to use, built-in message processors.
- *
- * [Check out the processor code here](https://github.com/open-wa/wa-automate-nodejs/blob/master/src/structures/preProcessors.ts)
- *
- */
-var PREPROCESSORS;
-(function (PREPROCESSORS) {
-    /**
-     * This preprocessor scrubs `body` and `content` from media messages.
-     * This would be useful if you want to reduce the message object size because neither of these values represent the actual file, only the thumbnail.
-     */
-    PREPROCESSORS["SCRUB"] = "SCRUB";
-    /**
-     * A preprocessor that limits the amount of base64 data is present in the message object by removing duplication of `body` in `content` by replacing `content` with `""`.
-     */
-    PREPROCESSORS["BODY_ONLY"] = "BODY_ONLY";
-    /**
-     * Replaces the media thumbnail base64 in `body` with the actual file's DataURL.
-     */
-    PREPROCESSORS["AUTO_DECRYPT"] = "AUTO_DECRYPT";
-    /**
-     * Automatically saves the file in a folder named `/media` relative to the process working directory.
-     *
-     * PLEASE NOTE, YOU WILL NEED TO MANUALLY CLEAR THIS FOLDER!!!
-     */
-    PREPROCESSORS["AUTO_DECRYPT_SAVE"] = "AUTO_DECRYPT_SAVE";
-    /**
-     *
-     * Uploads file to a cloud storage provider (GCP/AWS for now).
-     *
-     * If this preprocessor is set then you have to also set [`cloudUploadOptions`](https://docs.openwa.dev/docs/reference/api/model/config/interfaces/ConfigObject#clouduploadoptions) in the config.
-     *
-     */
-    PREPROCESSORS["UPLOAD_CLOUD"] = "UPLOAD_CLOUD";
-})(PREPROCESSORS = exports.PREPROCESSORS || (exports.PREPROCESSORS = {}));

package/dist/utils/pid_utils.d.ts

@@ -1 +0,0 @@
-export declare const pidTreeUsage: (pid: any) => Promise<any>;

package/dist/utils/pid_utils.js

@@ -1,26 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pidTreeUsage = void 0;
-const pidtree_1 = __importDefault(require("pidtree"));
-const pidusage_1 = __importDefault(require("pidusage"));
-const pidTreeUsage = (pid) => __awaiter(void 0, void 0, void 0, function* () {
-    if (!Array.isArray(pid)) {
-        pid = [pid];
-    }
-    const pids = (yield Promise.all(pid.map(pidtree_1.default))).flat();
-    const stats = yield (0, pidusage_1.default)(pids);
-    return stats;
-});
-exports.pidTreeUsage = pidTreeUsage;

package/dist/utils/tools.d.ts

@@ -1,152 +0,0 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
-import { AdvancedFile, ConfigObject, DataURL } from '../api/model';
-import { AxiosRequestConfig } from 'axios';
-import { SessionInfo } from '../api/model/sessionInfo';
-import { Readable } from "stream";
-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.
- * @param useragent Your custom user agent
- * @param v The WA version from the debug info. This is optional. default is 2.2117.5
- */
-export declare const smartUserAgent: (ua: string, version?: string) => string;
-export declare const getConfigFromProcessEnv: any;
-/**
- * Remove the key from the object and return the rest of the object.
- * @param {JsonObject} obj - The object to be filtered.
- * @param {string} key - The key to discard.
- * @returns The object without the key.
- */
-export declare const without: any;
-export declare const camelize: (str: string) => string;
-/**
- * Check if a string is Base64
- * @param str string
- * @returns
- */
-export declare const isBase64: (str: string) => boolean;
-/**
- * Check if a string is a DataURL
- * @param s string
- * @returns
- */
-export declare const isDataURL: (s: string) => boolean;
-/**
- * @internal
- * A convinience method to download the buffer of a downloaded file
- * @param url The url
- * @param optionsOverride You can use this to override the [axios request config](https://github.com/axios/axios#request-config)
- */
-export declare const getBufferFromUrl: (url: string, optionsOverride?: any) => Promise<[Buffer, any]>;
-/**
- * @internal
- * A convinience method to download the [[DataURL]] of a file
- * @param url The url
- * @param optionsOverride You can use this to override the [axios request config](https://github.com/axios/axios#request-config)
- */
-export declare const getDUrl: (url: string, optionsOverride?: AxiosRequestConfig) => Promise<DataURL>;
-/**
- * @internal
- * Use this to extract the mime type from a [[DataURL]]
- */
-export declare const base64MimeType: (dUrl: DataURL) => string;
-/**
- * If process.send is defined, send the message three times
- * @param {string} message - The message to send to the parent process.
- * @returns Nothing.
- */
-export declare const processSend: (message: string) => void;
-/**
- * Return the performance object if it is available, otherwise return the Date object
- */
-export declare const perf: () => DateConstructor | import("perf_hooks").Performance;
-/**
- * Return the current time in milliseconds
- */
-export declare const now: () => number;
-/**
- * `timePromise` returns a promise that resolves to the time it took to run the function passed to it
- * @param fn - the function to be timed.
- * @returns A string.
- */
-export declare function timePromise(fn: () => Promise<any>): Promise<string>;
-/**
- * It sends a message to the parent process.
- * @param {any} data - The data to be sent to the parent process.
- * @returns Nothing.
- */
-export declare const processSendData: (data?: any) => boolean;
-/**
- * It generates a link to the GitHub issue template for the current session
- * @param {ConfigObject} config - the config object
- * @param {SessionInfo} sessionInfo - The sessionInfo object from the CLI
- * @param {any} extras - any
- * @returns A link to the issue tracker for the current session.
- */
-export declare const generateGHIssueLink: (config: ConfigObject, sessionInfo: SessionInfo, extras?: any) => string;
-/**
- * If the file is a DataURL, return it. If it's a file, convert it to a DataURL. If it's a URL,
- * download it and convert it to a DataURL. If Base64, returns it.
- * @param {string} file - The file to be converted to a DataURL.
- * @param {AxiosRequestConfig} requestConfig - AxiosRequestConfig = {}
- * @param {string} filename - Filename with an extension so a datauri mimetype can be inferred.
- * @returns A DataURL
- */
-export declare const ensureDUrl: (file: string | Buffer, requestConfig?: AxiosRequestConfig, filename?: string) => Promise<string>;
-export declare const FileInputTypes: {
-    VALIDATED_FILE_PATH: string;
-    URL: string;
-    DATA_URL: string;
-    BASE_64: string;
-    BUFFER: string;
-    READ_STREAM: string;
-};
-export declare const FileOutputTypes: {
-    TEMP_FILE_PATH: string;
-    VALIDATED_FILE_PATH: string;
-    URL: string;
-    DATA_URL: string;
-    BASE_64: string;
-    BUFFER: string;
-    READ_STREAM: string;
-};
-/**
- * Remove file asynchronously
- * @param file Filepath
- * @returns
- */
-export declare function rmFileAsync(file: string): Promise<unknown>;
-/**
- * Takes a file parameter and consistently returns the desired type of file.
- * @param file The file path, URL, base64 or DataURL string of the file
- * @param outfileName The ouput filename of the file
- * @param desiredOutputType The type of file output required from this function
- * @param requestConfig optional axios config if file parameter is a url
- */
-export declare const assertFile: (file: AdvancedFile | Buffer, outfileName: string, desiredOutputType: keyof typeof FileOutputTypes, requestConfig?: any) => Promise<string | Buffer | Readable>;
-/**
- * Checks if a given path exists.
- *
- * If exists, returns the resolved absolute path. Otherwise returns false.
- *
- * @param _path a relative, absolute or homedir path to a folder or a file
- * @param failSilent If you're expecting for the file to not exist and just want the `false` response then set this to true to prevent false-positive error messages in the logs.
- * @returns string | false
- */
-export declare const pathExists: (_path: string, failSilent?: boolean) => Promise<string | false>;
-/**
- * Returns an absolute file path reference
- * @param _path a relative, absolute or homedir path to a folder or a file
- * @returns string
- */
-export declare const fixPath: (_path: string) => string;
-/**
- *
- * Accented filenames break file sending in docker containers. This is used to replace accented chars in strings to prevent file sending failures.
- *
- * @param input The raw string
- * @returns A sanitized string with all accented chars removed
- */
-export declare const sanitizeAccentedChars: (input: string) => string;