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

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

@@ -1,836 +0,0 @@
-import { AxiosRequestConfig } from 'axios';
-import { ConfigLogTransport } from '../../logging/logging';
-import { Base64 } from "./aliases";
-import { SimpleListener } from './events';
-/**
- * The different types of qr code output.
- */
-export declare enum QRFormat {
-    PNG = "png",
-    JPEG = "jpeg",
-    WEBM = "webm"
-}
-export declare enum CLOUD_PROVIDERS {
-    GCP = "GCP",
-    WASABI = "WASABI",
-    AWS = "AWS",
-    CONTABO = "CONTABO",
-    DO = "DO",
-    MINIO = "MINIO"
-}
-export declare enum DIRECTORY_STRATEGY {
-    /**
-     * E.g `/2021-08-16/`
-     */
-    DATE = "DATE",
-    /**
-     * E.g `/447123456789/`
-     */
-    CHAT = "CHAT",
-    /**
-     * E.g `/447123456789/2021-08-16/`
-     */
-    CHAT_DATE = "CHAT_DATE",
-    /**
-     * E.g `/2021-08-16/447123456789/`
-     */
-    DATE_CHAT = "DATE_CHAT"
-}
-type SessionId = string;
-type LicenseKey = string;
-type HostAccountNumber = `${number}`;
-type HostAccountNumberOrSessionID = HostAccountNumber | SessionId;
-type LicenseKeyConfigObject = {
-    [key: HostAccountNumberOrSessionID]: LicenseKey;
-};
-type LicenseKeyConfigFunctionReturn = LicenseKeyConfigObject | LicenseKey;
-type LicenseKeyConfigFunction = (sessionId?: SessionId, number?: HostAccountNumber) => LicenseKeyConfigFunctionReturn | Promise<LicenseKeyConfigFunctionReturn>;
-type LicenseKeyConfig = LicenseKeyConfigFunction | LicenseKeyConfigObject | LicenseKey;
-/**
- * The available languages for the host security notification
- */
-export declare enum NotificationLanguage {
-    PTBR = "pt-br",
-    ENGB = "en-gb",
-    DEDE = "de-de",
-    IDID = "id-id",
-    ITIT = "it-it",
-    NLNL = "nl-nl",
-    ES = "es"
-}
-export declare enum OnError {
-    /**
-     * Return it as a string
-     */
-    AS_STRING = "AS_STRING",
-    /**
-     * Do not log anything, just return `false`
-     */
-    RETURN_FALSE = "RETURN_FALSE",
-    /**
-     * throw the error
-     */
-    THROW = "THROW",
-    /**
-     * Log the error and return false
-     */
-    LOG_AND_FALSE = "LOG_AND_FALSE",
-    /**
-     * Log the error AND return the string
-     */
-    LOG_AND_STRING = "LOG_AND_STRING",
-    /**
-     * Return the error object
-     */
-    RETURN_ERROR = "RETURN_ERROR",
-    /**
-     * Do nothing.
-     */
-    NOTHING = "NOTHING"
-}
-/**
- * The set values of quality you can set for the quality of the qr code output. Ten being the highest quality.
- */
-export declare enum QRQuality {
-    ONE = 0.1,
-    TWO = 0.2,
-    THREE = 0.3,
-    FOUR = 0.4,
-    FIVE = 0.5,
-    SIX = 0.6,
-    SEVEN = 0.7,
-    EIGHT = 0.8,
-    NINE = 0.9,
-    TEN = 1
-}
-export declare enum LicenseType {
-    CUSTOM = "CUSTOM",
-    B2B_RESTRICTED_VOLUME_LICENSE = "B2B_RESTRICTED_VOLUME_LICENSE",
-    INSIDER = "Insiders Program",
-    TEXT_STORY = "Text Story License Key",
-    IMAGE_STORY = "Image Story License Key",
-    VIDEO_STORY = "Video Story License Key",
-    PREMIUM = "Premium License Key",
-    NONE = "NONE"
-}
-export interface SessionData {
-    WABrowserId?: string;
-    WASecretBundle?: string;
-    WAToken1?: string;
-    WAToken2?: string;
-}
-export interface DevTools {
-    /**
-     * Username for devtools
-     */
-    user: string;
-    /**
-     * Password for devtools
-     */
-    pass: string;
-}
-export interface EventPayload {
-    ts: number;
-    sessionId: string;
-    id: string;
-    event: SimpleListener;
-    data: any;
-    [k: string]: any;
-}
-export interface Webhook {
-    /**
-     * The endpoint to send (POST) the event to.
-     */
-    url: string;
-    /**
-     * The optional AxiosRequestConfig to use for firing the webhook event. This can be useful if you want to add some authentication when POSTing data to your server.
-     *
-     * For example, if your webhook requires the username `admin` and password `1234` for authentication, you can set the requestConfig to:
-     * ```
-     * {
-     *   auth: {
-     *     username: "admin",
-     *     password: "1234",
-     *   }
-     * }
-     * ```
-     *
-     * Please note, for security reasons, this is not returned when listing webhooks however it is returned when registering a webhook for verification purposes.
-     */
-    requestConfig?: AxiosRequestConfig;
-    /**
-     * The ID of the given webhook setup. Use this ID with [[removeWebhook]]
-     */
-    id: string;
-    /**
-     * An array of events that are registered to be sent to this webhook.
-     */
-    events: SimpleListener[];
-    /**
-     * Time when the webhook was registered in epoch time
-     */
-    ts: number;
-}
-export interface ProxyServerCredentials {
-    /**
-     * The protocol on which the proxy is running. E.g `http`, `https`, `socks4` or `socks5`. This is optional and can be automatically determined from the address.
-     */
-    protocol?: string;
-    /**
-    * Proxy Server address. This can include the port e.g '127.0.0.1:5005'
-    */
-    address: string;
-    /**
-    * Username for Proxy Server authentication
-    */
-    username: string;
-    /**
-    * Password for Proxy Server authentication
-    */
-    password: string;
-}
-export interface ConfigObject {
-    /**
-     * @deprecated
-     * The authentication object (as a JSON object or a base64 encoded string) that is required to migrate a session from one instance to another or to just restart an existing instance.
-     * This sessionData is provided in a generated JSON file (it's a json file but contains the JSON data as a base64 encoded string) upon QR scan or an event.
-     *
-     * You can capture the event like so:
-     * ```javascript
-     * import {create, ev} from '@open-wa/wa-automate';
-     *
-     *      ev.on('sessionData.**', async (sessionData, sessionId) =>{
-     *          console.log(sessionId, sessionData)
-     *      })
-     *
-     * //or as base64 encoded string
-     *
-     *      ev.on('sessionDataBase64.**', async (sessionDatastring, sessionId) =>{
-     *          console.log(sessionId, sessionDatastring)
-     *      })
-     * ```
-     *  NOTE: You can set sessionData as an evironmental variable also! The variable name has to be [sessionId (default = 'session) in all caps]_DATA_JSON. You have to make sure to surround your session data with single quotes to maintain the formatting.
-     *
-     * For example:
-     *
-     * sessionId = 'session'
-     *
-     * To set env var:
-     * ```bash
-     *    export SESSION_DATA_JSON=`...`
-     * ```
-     * where ... is copied from session.data.json this will be a string most likley starting in `ey...` and ending with `==`
-     *
-     * Setting the sessionData in the environmental variable will override the sessionData object in the config.
-     */
-    sessionData?: SessionData | Base64;
-    /**
-     * There is a new way to login to your host account by entering a link code after a confirmation step from the host account device. In order to use this feature you MUST set the host account number as a string or number beforehand as a property of the config object.
-     *
-     * e.g
-     * ```
-     * linkCode: '1234567890'
-     * ```
-     */
-    linkCode?: string;
-    /**
-     * ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING.
-     *
-     * Learn more:
-     *
-     * https://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions
-     *
-     * https://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0
-     */
-    browserWSEndpoint?: string;
-    /**
-     * This flag allows you to disable or enable the use of the puppeteer stealth plugin. It is a good idea to use it, however it can cause issues sometimes. Set this to false if you are experiencing `browser.setMaxListeneres` issue. For now the default for this is false.
-     * @default `false`
-     */
-    useStealth?: boolean;
-    /**
-     * The path relative to the current working directory (i.e where you run the command to start your process). This will be used to store and read your `.data.json` files. defualt to ''
-     */
-    sessionDataPath?: string;
-    /**
-     * Disable cors see: https://pptr.dev/#?product=Puppeteer&version=v3.0.4&show=api-pagesetbypasscspenabled If you are having an issue with sending media try to set this to true. Otherwise leave it set to false.
-     * @default `false`
-     */
-    bypassCSP?: boolean;
-    /**
-     * This allows you to pass any array of custom chrome/chromium argument strings to the puppeteer instance.
-     * You can find all possible arguements [here](https://peter.sh/experiments/chromium-command-line-switches/).
-     */
-    chromiumArgs?: string[];
-    /**
-     * If set to true, skipBrokenMethodsCheck will bypass the health check before startup. It is highly suggested to not set this to true.
-     * @default `false`
-     */
-    skipBrokenMethodsCheck?: boolean;
-    /**
-     * If set to true, `skipUpdateCheck` will bypass the latest version check. This saves some time on boot (around 150 ms).
-     * @default `false`
-     */
-    skipUpdateCheck?: boolean;
-    /**
-     * This is the name of the session. You have to make sure that this is unique for every session.
-     * @default `session`
-     */
-    sessionId?: string;
-    /**
-     * In order to unlock the functionality to send texts to unknown numbers, you need a License key.
-     * One License Key is valid for each number. Each License Key starts from £5 per month.
-     *
-     * Please check README for instructions on how to get a license key.
-     *
-     * Notes:
-     * 1. You can change the number assigned to that License Key at any time, just message me the new number on the private discord channel.
-     * 2. In order to cancel your License Key, simply stop your membership.
-     */
-    licenseKey?: LicenseKey;
-    /**
-     * You may set a custom user agent. However, due to recent developments, this is not really neccessary any more.
-     */
-    customUserAgent?: string;
-    /**
-     * You can enable remote devtools by setting this to trye. If you set this to true there will be security on the devtools url.
-     * If you want, you can also pass a username & password.
-     */
-    devtools?: boolean | DevTools;
-    /**
-     * Setting this to true will block any network calls to crash log servers. This should keep anything you do under the radar.
-     * @default `true`
-     */
-    blockCrashLogs?: boolean;
-    /**
-     * Setting this to false turn off the cache. This may improve memory usage.
-     * @default `false`
-     */
-    cacheEnabled?: boolean;
-    /**
-     * This is the specific browser revision to be downlaoded and used. You can find browser revision strings here: http://omahaproxy.appspot.com/
-     * Learn more about it here: https://github.com/puppeteer/puppeteer/blob/master/docs/api.md#class-browserfetcher
-     * If you're having trouble with sending images, try '737027'.
-     * If you go too far back things will start breaking !!!!!!
-     * NOTE: THIS WILL OVERRIDE useChrome and executablePath. ONLY USE THIS IF YOU KNOW WHAT YOU ARE DOING.
-     */
-    browserRevision?: string;
-    /**
-     * Setting this to true will throw an error if a session is not able to get a QR code or is unable to restart a session.
-     */
-    throwErrorOnTosBlock?: boolean;
-    /**
-     * By default, all instances of @open-wa/wa-automate are headless (i.e you don't see a chrome window open), you can set this to false to show the chrome/chromium window.
-     * @default `true`
-     */
-    headless?: boolean;
-    /**
-     * @deprecated
-     *
-     * THIS IS LOCKED TO `true` AND CANNOT BE TURNED OFF. PLEASE SEE [[authTimeout]]
-     *
-     * Setting this to true will result in new QR codes being generated if the end user takes too long to scan the QR code.
-     * @default `true`
-     */
-    autoRefresh?: boolean;
-    /**
-     * @deprecated
-     *
-     * This now has no effect
-     *
-     * This determines the interval at which to refresh the QR code. By default, WA updates the qr code every 18-19 seconds so make sure this value is set to UNDER 18 seconds!!
-     */
-    qrRefreshS?: number;
-    /**
-     * This determines how long the process should wait for a QR code to be scanned before killing the process entirely. To have the system wait continuously, set this to `0`.
-     * @default 60
-     */
-    qrTimeout?: number;
-    /**
-     * This determines how long the process should wait for a session to load fully before continuing the launch process.
-     * Set this to 0 to wait forever. Default is 5 seconds.
-     * @default 5
-     */
-    waitForRipeSessionTimeout?: number;
-    /**
-     * Some features, like video upload, do not work without a chrome instance. Set this to the path of your chrome instance or you can use `useChrome:true` to automatically detect a chrome instance for you. Please note, this overrides `useChrome`.
-     */
-    executablePath?: string;
-    /**
-     * If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath.
-     * @default `false`
-     */
-    useChrome?: boolean;
-    /**
-     * If sent, adds a call to waPage.authenticate with those credentials. Set `corsFix` to true if using a proxy results in CORS errors.
-     */
-    proxyServerCredentials?: ProxyServerCredentials;
-    /**
-     * If true, skips logging the QR Code to the console.
-     * @default `false`
-     */
-    qrLogSkip?: boolean;
-    /**
-     * If set, the program will try to recreate itself when the page crashes. You have to pass the function that you want called upon restart. Please note that when the page crashes you may miss some messages.
-     * E.g:
-     * ```javascript
-     * const start  = async (client: Client) => {...}
-     * create({
-     * ...
-     * restartOnCrash: start,
-     * ...
-     * })
-     * ```
-     */
-    restartOnCrash?: any;
-    /**
-     * Setting this to true will simplify logs for use within docker containers by disabling spins (will still print raw messages).
-     * @default `false`
-     */
-    disableSpins?: boolean;
-    /**
-     * If true, this will log any console messages from the browser.
-     * @default `false`
-     */
-    logConsole?: boolean;
-    /**
-     * If true, this will log any error messages from the browser instance
-     * @default `false`
-     */
-    logConsoleErrors?: boolean;
-    /**
-    * This determines how long the process should wait for the session authentication. If exceeded, checks if phone is out of reach (turned of or without internet connection) and throws an error. It does not relate to the amount of time spent waiting for a qr code scan (see [[qrTimeout]]). To have the system wait continuously, set this to `0`.
-    * @default `60`
-    */
-    authTimeout?: number;
-    /**
-     * phoneIsOutOfReach check timeout
-     * @default `60`
-     */
-    oorTimeout?: number;
-    /**
-     * Setting this to `true` will kill the whole process when the client is disconnected from the page or if the browser is closed.
-     * @default `false`
-     */
-    killProcessOnBrowserClose?: boolean;
-    /**
-     * If true, client will check if the page is valid before each command. If page is not valid, it will throw an error.
-     * @default `false`
-     */
-    safeMode?: boolean;
-    /**
-     * If true, the process will not save a data.json file. This means that sessions will not be saved and you will need to pass sessionData as a config param or create the session data.json file yourself
-     * @default `false`
-     */
-    skipSessionSave?: boolean;
-    /**
-     * If true, the process will open a browser window where you will see basic event logs and QR codes to authenticate the session. Usually it will open on port 3000. It can also be set to a preferred port.
-     *
-     * You can also get the QR code png at (if localhost and port 3000):
-     *
-     * `http://localhost:3000/qr`
-     *
-     * or if you have multiple session:
-     *
-     *  `http://localhost:3000/qr?sessionId=[sessionId]`
-     *
-     * @default `false | 3000`
-     */
-    popup?: boolean | number;
-    /**
-     * This needs to be used in conjuction with `popup`, if `popup` is not true or a number (representing a desired port) then this will not work.
-     *
-     * Setting this to true will make sure that only the qr code png is served via the web server. This is useful if you do not need the whole status page.
-     *
-     * As mentioned in [popup](#popup), the url for the qr code is `http://localhost:3000/qr` if the port is 3000.
-     */
-    qrPopUpOnly?: boolean;
-    /**
-     * If true, the process will try infer as many config variables as possible from the environment variables. The format of the variables are as below:
-     * ```
-     * sessionData     ==>     WA_SESSION_DATA
-     * sessionDataPath ==>     WA_SESSION_DATA_PATH
-     * sessionId       ==>     WA_SESSION_ID
-     * customUserAgent ==>     WA_CUSTOM_USER_AGENT
-     * blockCrashLogs  ==>     WA_BLOCK_CRASH_LOGS
-     * blockAssets     ==>     WA_BLOCK_ASSETS
-     * corsFix         ==>     WA_CORS_FIX
-     * cacheEnabled    ==>     WA_CACHE_ENABLED
-     * headless        ==>     WA_HEADLESS
-     * qrTimeout       ==>     WA_QR_TIMEOUT
-     * useChrome       ==>     WA_USE_CHROME
-     * qrLogSkip       ==>     WA_QR_LOG_SKIP
-     * disableSpins    ==>     WA_DISABLE_SPINS
-     * logConsole      ==>     WA_LOG_CONSOLE
-     * logConsoleErrors==>     WA_LOG_CONSOLE_ERRORS
-     * authTimeout     ==>     WA_AUTH_TIMEOUT
-     * safeMode        ==>     WA_SAFE_MODE
-     * skipSessionSave ==>     WA_SKIP_SESSION_SAVE
-     * popup           ==>     WA_POPUP
-     * licensekey      ==>     WA_LICENSE_KEY
-     * ```
-     * @default `false`
-     */
-    inDocker?: boolean;
-    /**
-     * The output quality of the qr code during authentication. This can be any increment of 0.1 from 0.1 to 1.0.
-     * @default `1.0`
-     */
-    qrQuality?: QRQuality;
-    /**
-     * The output format of the qr code. `png`, `jpeg` or `webm`.
-     *
-     * @default `png`
-     */
-    qrFormat?: QRFormat;
-    /**
-     * The language of the host notification. See: https://github.com/open-wa/wa-automate-nodejs/issues/709#issuecomment-673419088
-     */
-    hostNotificationLang?: NotificationLanguage;
-    /**
-     * Setting this to true will block all assets from loading onto the page. This may result in some load time improvements but also increases instability.
-     * @default `false`
-     */
-    blockAssets?: boolean;
-    /**
-     * [ALPHA FEATURE - ONLY IMPLEMENTED FOR TESTING - DO NOT USE IN PRODUCTION YET]
-     * Setting this to true will result in the library making sure it is always starting with the latest version of itself. This overrides `skipUpdateCheck`.
-     * @default `false`
-     */
-    keepUpdated?: boolean;
-    /**
-     * Syncs the viewport size with the window size which is how normal browsers act. Only relevant when `headless: false` and this overrides `viewport` config.
-     * @default `true`
-     */
-    resizable?: boolean;
-    /**
-     * Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g `--viewport 1920x1080`.
-     */
-    viewport?: {
-        /**
-         * Page width in pixels
-         * @default `1440`
-         */
-        width?: number;
-        /**
-         * Page height in pixels
-         * @default `900`
-         */
-        height?: number;
-    };
-    /**
-     * As the library is constantly evolving, some parts will be replaced with more efficient and improved code. In some of the infinite edge cases these new changes may not work for you. Set this to true to roll back on 'late beta' features. The reason why legacy is false by default is that in order for features to be tested they have to be released and used by everyone to find the edge cases and fix them.
-     * @default `false`
-     */
-    legacy?: boolean;
-    /**
-     * Deletes the session data file (if found) on logout event. This results in a quicker login when you restart the process.
-     * @default `false`
-     */
-    deleteSessionDataOnLogout?: boolean;
-    /**
-     * If set to true, the system will kill the whole node process when either an [[authTimeout]] or a [[qrTimeout]] has been reached. This is useful to prevent hanging processes.
-     * @default `false`
-     */
-    killProcessOnTimeout?: boolean;
-    /**
-     * If set to true, the system will kill the whole node process when a "TEMPORARY BAN" is detected. This is useful to prevent hanging processes.
-     * It is `true` by default because it is a very rare event and it is better to kill the process than to leave it hanging.
-     * @default `true`
-     */
-    killProcessOnBan?: boolean;
-    /**
-     * Setting this to true will bypass web security. DO NOT DO THIS IF YOU DO NOT HAVE TO. CORS issue may arise when using a proxy.
-     * @default `false`
-     */
-    corsFix?: boolean;
-    /**
-     * Amount of time (in ms) to wait for a client method (specifically methods that interact with the WA web session) to resolve. If a client method results takes longer than the timout value then it will result in a [[PageEvaluationTimeout]] error.
-     *
-     * If you get this error, it does not automatically mean that the method failed - it just stops your program from waiting for a client method to resolve.
-     *
-     * This is useful if you do not rely on the results of a client method (e.g the message ID).
-     *
-     * If set to `0`, the process will wait indefinitely for a client method to resolve.
-     * @default 0
-     */
-    callTimeout?: number;
-    /**
-     * When true, this option will take a screenshot of the browser when an unexpected error occurs within the browser during `create` initialization. The path will be `[working directory]/logs/[session ID]/[start timestamp]/[timestamp].jpg`
-     * @default `false`
-     */
-    screenshotOnInitializationBrowserError?: boolean;
-    /**
-     * Setting listeners may not be your cup of tea. With eventMode, all [[SimpleListener]] events will be registered automatically and be filed via the built in Events Listener.
-     *
-     * This is useful because you can register/deregister the event listener as needed whereas the legacy method of setting callbacks are only be set once
-     *
-     * @default `true`;
-     */
-    eventMode?: boolean;
-    /**
-     * If true, the system will automatically create a log of all processes relating to actions sent to the web session.
-     *
-     * The location of the file will be relative to the process directory (pd)
-     *
-     * `[pd]/[sessionId]/[start timestamp].log`
-     * @default false
-     */
-    logFile?: boolean;
-    /**
-     * When true, the system will attempt to correct chatIds and groupChatIds. This means you can ignore `@c.us` and `@g.us` distinctions in some parameters.
-     * @default false
-     */
-    idCorrection?: boolean;
-    /**
-     *
-     * Redundant until self-hostable sticker server is available.
-     *
-     * @default `https://sticker-api.openwa.dev`
-     */
-    stickerServerEndpoint?: string | boolean;
-    /**
-     * This will force the library to use the default cached raw github link for patches to shave a few hundred milliseconds from your launch time. If you use this option, you will need to wait about 5 minutes before trying out new patches.
-     * @default `false`
-     */
-    ghPatch?: boolean;
-    /**
-     * Setting this to `true` will save a local copy of the patches.json file (as patches.ignore.data.json) which will be used in subsequent instantiations of the session. While the rest of the launch procedure is running, the library will fetch and save a recent version of the patches to ensure your patches don't go stale. This will be ignored if the cached patches are more than a day old.
-     * @default `false`
-     */
-    cachedPatch?: boolean;
-    /**
-     * Setting `this` to true will replace the `console.table` with a stringified logging of the debug info object instead. This would be useful to set for smaller terminal windows. If `disableSpins` is `true` then this will also be `true`.
-     * @default `false`
-     */
-    logDebugInfoAsObject?: boolean;
-    /**
-     * This will make the library log all internal wa web events to the console. This is useful for debugging purposes. DO NOT TURN THIS ON UNLESS ASKED TO.
-     */
-    logInternalEvents?: boolean;
-    /**
-     * Kill the client when a logout is detected
-     * @default `false`
-     */
-    killClientOnLogout?: boolean;
-    /**
-     * This will make the `create` command return `false` if the detected session data is expired.
-     *
-     * This will mean, the process will not attempt to automatically get a new QR code.
-     *
-     * @default `false`
-     */
-    throwOnExpiredSessionData?: boolean;
-    /**
-     * Some sessions may experience issues with sending media when using proxies. Using the native proxy system instead of the recommended 3rd party library may fix these issues.
-     *
-     * @default `false`
-     */
-    useNativeProxy?: boolean;
-    /**
-     * Set this to `true` to make the library work on Raspberry Pi OS.
-     *
-     * Make sure to run the following command before running the library the first time:
-     *
-     * ```
-     * > sudo apt update -y && sudo apt install chromium-browser chromium-codecs-ffmpeg -y && sudo apt upgrade
-     * ```
-     *
-     * If you're using the CLI, you can set this value to `true` by adding the following flag to the CLI command
-     *
-     * ```
-     * > npx @open-wa/wa-automate ... --raspi
-     * ```
-     *
-     * @default `false`
-     */
-    raspi?: boolean;
-    /**
-     * Default pqueue options applied to all listeners that can take pqueue options as a second optional parameter. For now, this only includes `onMessage` and `onAnyMessage`.
-     *
-     * See: https://github.com/sindresorhus/p-queue#options
-     *
-     * Example: process 5 events within every 3 seconds window. Make sure to only process at most 2 at any one time. Make sure there is at least 100ms between each event processing.
-     *
-     * ```javascript
-     *     {
-     *         intervalCap: 5, //process 5 events
-     *         interval: 3000, //within every three second window
-     *         concurrency: 2, //make sure to process, at most, 2 events at any one time
-     *         timeout: 100, //make sure there is a 100ms gap between each event processing.
-     *         carryoverConcurrencyCount: true //If there are more than 5 events in that period, process them within the next 3 second period. Make sure this is always set to true!!!
-     *     }
-     * ```
-     *
-     * @default `undefined`
-     */
-    pQueueDefault?: any;
-    /**
-     * Set a preprocessor, or multiple chained preprocessors, for messages. See [MPConfigType](/) for more info.
-     *
-     * options: `SCRUB`, `BODY_ONLY`, `AUTO_DECRYPT`, `AUTO_DECRYPT_SAVE`, `UPLOAD_CLOUD`.
-     * @default `undefined`
-     */
-    messagePreprocessor?: any;
-    /**
-     * Set an array filter to be used with messagePreprocessor to limit which messages are preprocessed.
-     *
-     * E.g if you want to scrub all messages that are not from a group, you can do the following:
-     * `"m=>!m.isGroupMsg"`
-     *
-     * @default `undefined`
-     */
-    preprocFilter?: string;
-    /**
-     * REQUIRED IF `messagePreprocessor` IS SET TO `UPLOAD_CLOUD`.
-     *
-     * This can be set via the config or the corresponding environment variables.
-     */
-    cloudUploadOptions?: {
-        /**
-         * `AWS`, `GCP` or `WASABI`
-         *
-         * env: `OW_CLOUD_ACCESS_KEY_ID`
-         */
-        provider: CLOUD_PROVIDERS;
-        /**
-         * S3 compatible access key ID.
-         *
-         * e.g: `AKIAIOSFODNN7EXAMPLE` or `GOOGTS7C7FUP3AIRVJTE2BCD`
-         *
-         * env: `OW_CLOUD_ACCESS_KEY_ID`
-         */
-        accessKeyId: string;
-        /**
-         * S3 compatible secret access key.
-         *
-         * e.g `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`
-         *
-         * env: `OW_CLOUD_SECRET_ACCESS_KEY`
-         */
-        secretAccessKey: string;
-        /**
-         * Bucket name
-         *
-         * env: `OW_CLOUD_BUCKET`
-         */
-        bucket: string;
-        /**
-         * Bucket region.
-         *
-         * Not required for `GCP` provider
-         *
-         * env: `OW_CLOUD_REGION`
-         *
-         */
-        region?: string;
-        /**
-         * Ignore processing of messages that are sent by the host account itself
-         *
-         * env: `OW_CLOUD_IGNORE_HOST`
-         */
-        ignoreHostAccount?: boolean;
-        /**
-         * The directory strategy to use when uploading files. Or just set it to a custom directory string.
-         *
-         * env: `OW_DIRECTORY`
-         */
-        directory?: DIRECTORY_STRATEGY | string;
-        /**
-         * Setting this to true will make the uploaded file public
-         */
-        public?: boolean;
-        /**
-         * Extra headers to add to the upload request
-         */
-        headers?: {
-            [k: string]: string;
-        };
-    };
-    /**
-     * What to do when an error is detected on a client method.
-     *
-     * @default `OnError.NOTHING`
-     */
-    onError?: OnError;
-    /**
-     *
-     * Please note that multi-device is still in beta so a lot of things may not work. It is HIGHLY suggested to NOT use this in production!!!!
-     *
-     * Set this to true if you're using the multidevice beta.
-     *
-     * @default `true`
-     * :::danger
-     * Some features (e.g [[sendLinkWithAutoPreview]])  **do not** work with multi-device beta. Check [this `api`](#).
-     * :::
-     */
-    multiDevice?: boolean;
-    /**
-     * Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions.
-     */
-    sessionDataBucketAuth?: string;
-    /**
-     * Set the automatic emoji detection character. Set this to `false` to disable auto emoji. Default is `:`.
-     *
-     * @default `:`
-     */
-    autoEmoji?: string | false;
-    /**
-     * Set the maximum amount of chats to be present in a session.
-     */
-    maxChats?: number;
-    /**
-     * Set the maximum amount of messages to be present in a session.
-     */
-    maxMessages?: number;
-    /**
-     * Your Discord ID to get onto the sticker leaderboard!
-     */
-    discord?: string;
-    /**
-     * Don't implicitly determine if the host logged out.
-     */
-    ignoreNuke?: boolean;
-    /**
-     * Makes sure the headless session is usable even on first login.
-     * Headful sessions are ususally only usable on reauthentication.
-     */
-    ensureHeadfulIntegrity?: boolean;
-    /**
-     * wait for a valid headful session. Not required in recent versions.
-     * default: `true`
-     */
-    waitForRipeSession?: boolean;
-    /**
-     * Automatically kill the process after a set amount of qr codes
-     */
-    qrMax?: number;
-    /**
-     * Expose a URL where you can easily scan the qr code
-     */
-    ezqr?: boolean;
-    /**
-     * An array of [winston](https://github.com/winstonjs/winston/blob/master/docs/transports.md#additional-transports) logging transport configurations.
-     *
-     * [Check this discussion to see how to set up logging](https://github.com/open-wa/wa-automate-nodejs/discussions/2373)
-     */
-    logging?: ConfigLogTransport[];
-    /**
-     * The URL of your instance of [serverless meta grabber](https://github.com/RemiixInc/meta-grabber-serverless) by [RemiixInc](https://github.com/RemiixInc).
-     *
-     * default: `https://link.openwa.cloud/api`
-     */
-    linkParser?: string;
-    /**
-     * Setting this to true will run `gc()` on before every command sent to the browser.
-     *
-     * This is experimental and may not work or it may have unforeseen sideeffects.
-     */
-    aggressiveGarbageCollection?: boolean;
-    /**@internal */
-    [x: string]: any;
-}
-export type AdvancedConfig = ConfigObject & {
-    licenseKey: LicenseKeyConfig;
-};
-export {};