@open-wa/wa-automate 4.27.7 → 4.28.1

package/README.md

@@ -13,7 +13,7 @@
 [![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/open-wa/wa-automate-nodejs.svg)](http://isitmaintained.com/project/open-wa/wa-automate-nodejs "Average time to resolve an issue")
 [![Percentage of issues still open](http://isitmaintained.com/badge/open/open-wa/wa-automate-nodejs.svg)](http://isitmaintained.com/project/open-wa/wa-automate-nodejs "Percentage of issues still open")
 
-<a href="https://discord.gg/dnpp72a"><img src="https://img.shields.io/discord/661438166758195211?color=blueviolet&label=discord&style=flat" /></a> ![WhatsApp_Web 2.2108.8](https://img.shields.io/badge/WhatsApp_Web-2.2108.8-brightgreen.svg)<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/openwadev?label=Follow%20%40openwadev%20for%20updates&logo=twitter&style=social">
+<a href="https://discord.gg/dnpp72a"><img src="https://img.shields.io/discord/661438166758195211?color=blueviolet&label=discord&style=flat" /></a> ![WhatsApp_Web 2.2147.16](https://img.shields.io/badge/WhatsApp_Web-2.2147.16-brightgreen.svg)<img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/openwadev?label=Follow%20%40openwadev%20for%20updates&logo=twitter&style=social">
 
 <a href="https://cloud.digitalocean.com/apps/new?repo=https://github.com/open-wa/wa-automate-nodejs/tree/deploy&refcode=4b093f6ecd3a&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
  <img style="max-height:200px" src="https://raw.githubusercontent.com/open-wa/wa-automate-deploy-heroku/main/assets/do_deploy.png" alt="Deploy to DO">

package/bin/config-schema.json

@@ -1 +1 @@
-[{"env":"WA_SESSION_DATA","p":"session-data","description":"The base64 encoded sessionData used to restore a session.","type":"string","key":"sessionData"},{"env":"WA_BROWSER_WS_ENDPOINT","p":"browser-ws-endpoint","type":"string","description":"ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING.\n\nLearn more:\n\nhttps://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions\n\nhttps://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0","key":"browserWSEndpoint"},{"env":"WA_SESSION_DATA_PATH","p":"session-data-path","type":"string","description":"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 ''","key":"sessionDataPath"},{"env":"WA_SKIP_UPDATE_CHECK","p":"skip-update-check","type":"boolean","description":"If set to true, `skipUpdateCheck` will bypass the latest version check. This saves some time on boot (around 150 ms).","key":"skipUpdateCheck"},{"env":"WA_SESSION_ID","p":"session-id","type":"string","description":"This is the name of the session. You have to make sure that this is unique for every session.","key":"sessionId"},{"env":"WA_LICENSE_KEY","p":"license-key","description":"The license key to use with the session.","type":"string","key":"licenseKey"},{"env":"WA_CUSTOM_USER_AGENT","p":"custom-user-agent","type":"string","description":"You may set a custom user agent. However, due to recent developments, this is not really neccessary any more.","key":"customUserAgent"},{"env":"WA_BLOCK_CRASH_LOGS","p":"block-crash-logs","type":"boolean","description":"Setting this to true will block any network calls to crash log servers. This should keep anything you do under the radar.","key":"blockCrashLogs"},{"env":"WA_CACHE_ENABLED","p":"cache-enabled","type":"boolean","description":"Setting this to false turn off the cache. This may improve memory usage.","key":"cacheEnabled"},{"env":"WA_BROWSER_REVISION","p":"browser-revision","type":"string","description":"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.","key":"browserRevision"},{"env":"WA_HEADLESS","p":"headless","type":"boolean","description":"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.","key":"headless"},{"env":"WA_QR_TIMEOUT","p":"qr-timeout","type":"number","description":"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,"key":"qrTimeout"},{"env":"WA_USE_CHROME","p":"use-chrome","type":"boolean","description":"If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath.","key":"useChrome"},{"env":"WA_QR_LOG_SKIP","p":"qr-log-skip","type":"boolean","description":"If true, skips logging the QR Code to the console.","key":"qrLogSkip"},{"env":"WA_DISABLE_SPINS","p":"disable-spins","type":"boolean","description":"Setting this to true will simplify logs for use within docker containers by disabling spins (will still print raw messages).","key":"disableSpins"},{"env":"WA_LOG_CONSOLE","p":"log-console","type":"boolean","description":"If true, this will log any console messages from the browser.","key":"logConsole"},{"env":"WA_LOG_CONSOLE_ERRORS","p":"log-console-errors","type":"boolean","description":"If true, this will log any error messages from the browser instance","key":"logConsoleErrors"},{"env":"WA_AUTH_TIMEOUT","p":"auth-timeout","type":"number","description":"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`.","key":"authTimeout"},{"env":"WA_SAFE_MODE","p":"safe-mode","type":"boolean","description":"If true, client will check if the page is valid before each command. If page is not valid, it will throw an error.","key":"safeMode"},{"env":"WA_SKIP_SESSION_SAVE","p":"skip-session-save","type":"boolean","description":"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","key":"skipSessionSave"},{"env":"WA_POPUP","p":"popup","type":["boolean","number"],"description":"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.\n\nYou can also get the QR code png at (if localhost and port 3000):\n\n`http://localhost:3000/qr`\n\nor if you have multiple session:\n\n `http://localhost:3000/qr?sessionId=[sessionId]`","key":"popup"},{"env":"WA_QR_POP_UP_ONLY","p":"qr-pop-up-only","type":"boolean","description":"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.\n\nSetting 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.\n\nAs mentioned in [popup](#popup), the url for the qr code is `http://localhost:3000/qr` if the port is 3000.","key":"qrPopUpOnly"},{"env":"WA_BLOCK_ASSETS","p":"block-assets","type":"boolean","description":"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.","key":"blockAssets"},{"env":"WA_KEEP_UPDATED","p":"keep-updated","type":"boolean","description":"[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`.","key":"keepUpdated"},{"env":"WA_RESIZABLE","p":"resizable","type":"boolean","description":"Syncs the viewport size with the window size which is how normal browsers act. Only relevant when `headless: false` and this overrides `viewport` config.","key":"resizable"},{"env":"WA_VIEWPORT","p":"viewport","type":"object","properties":{"width":{"type":"number","description":"Page width in pixels"},"height":{"type":"number","description":"Page height in pixels"}},"additionalProperties":false,"description":"Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g `--viewport 1920x1080`.","key":"viewport"},{"env":"WA_LEGACY","p":"legacy","type":"boolean","description":"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.","key":"legacy"},{"env":"WA_DELETE_SESSION_DATA_ON_LOGOUT","p":"delete-session-data-on-logout","type":"boolean","description":"Deletes the session data file (if found) on logout event. This results in a quicker login when you restart the process.","key":"deleteSessionDataOnLogout"},{"env":"WA_KILL_PROCESS_ON_TIMEOUT","p":"kill-process-on-timeout","type":"boolean","description":"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.","key":"killProcessOnTimeout"},{"env":"WA_CORS_FIX","p":"cors-fix","type":"boolean","description":"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.","key":"corsFix"},{"env":"WA_CALL_TIMEOUT","p":"call-timeout","type":"number","description":"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.\n\nIf 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.\n\nThis is useful if you do not rely on the results of a client method (e.g the message ID).\n\nIf set to `0`, the process will wait indefinitely for a client method to resolve.","default":0,"key":"callTimeout"},{"env":"WA_SCREENSHOT_ON_INITIALIZATION_BROWSER_ERROR","p":"screenshot-on-initialization-browser-error","type":"boolean","description":"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`","key":"screenshotOnInitializationBrowserError"},{"env":"WA_EVENT_MODE","p":"event-mode","type":"boolean","description":"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.\n\nThis is useful because you can register/deregister the event listener as needed whereas the legacy method of setting callbacks are only be set once","key":"eventMode"},{"env":"WA_LOG_FILE","p":"log-file","type":"boolean","description":"If true, the system will automatically create a log of all processes relating to actions sent to the web session.\n\nThe location of the file will be relative to the process directory (pd)\n\n`[pd]/[sessionId]/[start timestamp].log`","default":false,"key":"logFile"},{"env":"WA_ID_CORRECTION","p":"id-correction","type":"boolean","description":"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,"key":"idCorrection"},{"env":"WA_STICKER_SERVER_ENDPOINT","p":"sticker-server-endpoint","type":["string","boolean"],"description":"Redundant until self-hostable sticker server is available.","key":"stickerServerEndpoint"},{"env":"WA_GH_PATCH","p":"gh-patch","type":"boolean","description":"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.","key":"ghPatch"},{"env":"WA_CACHED_PATCH","p":"cached-patch","type":"boolean","description":"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.","key":"cachedPatch"},{"env":"WA_LOG_DEBUG_INFO_AS_OBJECT","p":"log-debug-info-as-object","type":"boolean","description":"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`.","key":"logDebugInfoAsObject"},{"env":"WA_KILL_CLIENT_ON_LOGOUT","p":"kill-client-on-logout","type":"boolean","description":"Kill the client when a logout is detected","key":"killClientOnLogout"},{"env":"WA_THROW_ON_EXPIRED_SESSION_DATA","p":"throw-on-expired-session-data","type":"boolean","description":"This will make the `create` command return `false` if the detected session data is expired.\n\nThis will mean, the process will not attempt to automatically get a new QR code.","key":"throwOnExpiredSessionData"},{"env":"WA_USE_NATIVE_PROXY","p":"use-native-proxy","type":"boolean","description":"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.","key":"useNativeProxy"},{"env":"WA_RASPI","p":"raspi","type":"boolean","description":"Set this to `true` to make the library work on Raspberry Pi OS.\n\nMake sure to run the following command before running the library the first time:\n\n``` > sudo apt update -y && sudo apt install chromium-browser chromium-codecs-ffmpeg -y && sudo apt upgrade ```\n\nIf you're using the CLI, you can set this value to `true` by adding the following flag to the CLI command\n\n``` > npx @open-wa/wa-automate ... --raspi ```","key":"raspi"},{"env":"WA_MULTI_DEVICE","p":"multi-device","type":"boolean","description":"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!!!!\n\nSet this to true if you're using the multidevice beta.","key":"multiDevice"},{"env":"WA_SESSION_DATA_BUCKET_AUTH","p":"session-data-bucket-auth","type":"string","description":"Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions.","key":"sessionDataBucketAuth"},{"env":"WA_AUTO_EMOJI","p":"auto-emoji","type":"string","description":"Set the automatic emoji detection character. Set this to false to disable auto emoji. Default is `:`.","key":"autoEmoji"},{"env":"WA_MAX_CHATS","p":"max-chats","type":"number","description":"Set the maximum amount of chats to be present in a session.","key":"maxChats"},{"env":"WA_MAX_MESSAGES","p":"max-messages","type":"number","description":"Set the maximum amount of messages to be present in a session.","key":"maxMessages"},{"env":"WA_DISCORD","p":"discord","type":"string","description":"Your Discord ID to get onto the sticker leaderboard!","key":"discord"},{"env":"WA_IGNORE_NUKE","p":"ignore-nuke","type":"boolean","description":"Don't implicitly determine if the host logged out.","key":"ignoreNuke"},{"env":"WA_ENSURE_HEADFUL_INTEGRITY","p":"ensure-headful-integrity","type":"boolean","description":"Makes sure the headless session is usable even on first login. Headful sessions are ususally only usable on reauthentication.","key":"ensureHeadfulIntegrity"},{"env":"WA_WAIT_FOR_RIPE_SESSION","p":"wait-for-ripe-session","type":"boolean","description":"wait for a valid headful session. Not required in recent versions.","key":"waitForRipeSession"},{"env":"WA_QR_MAX","p":"qr-max","type":"number","description":"Automatically kill the process after a set amount of qr codes","key":"qrMax"},{"env":"WA_EZQR","p":"ezqr","type":"boolean","description":"Expose a URL where you can easily scan the qr code","key":"ezqr"}]
+[{"env":"WA_SESSION_DATA","p":"session-data","description":"The base64 encoded sessionData used to restore a session.","type":"string","key":"sessionData"},{"env":"WA_BROWSER_WS_ENDPOINT","p":"browser-ws-endpoint","type":"string","description":"ALPHA EXPERIMENTAL FEATURE! DO NOT USE IN PRODUCTION, REQUIRES TESTING.\n\nLearn more:\n\nhttps://pptr.dev/#?product=Puppeteer&version=v3.1.0&show=api-puppeteerconnectoptions\n\nhttps://medium.com/@jaredpotter1/connecting-puppeteer-to-existing-chrome-window-8a10828149e0","key":"browserWSEndpoint"},{"env":"WA_SESSION_DATA_PATH","p":"session-data-path","type":"string","description":"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 ''","key":"sessionDataPath"},{"env":"WA_SKIP_UPDATE_CHECK","p":"skip-update-check","type":"boolean","description":"If set to true, `skipUpdateCheck` will bypass the latest version check. This saves some time on boot (around 150 ms).","key":"skipUpdateCheck"},{"env":"WA_SESSION_ID","p":"session-id","type":"string","description":"This is the name of the session. You have to make sure that this is unique for every session.","key":"sessionId"},{"env":"WA_LICENSE_KEY","p":"license-key","description":"The license key to use with the session.","type":"string","key":"licenseKey"},{"env":"WA_CUSTOM_USER_AGENT","p":"custom-user-agent","type":"string","description":"You may set a custom user agent. However, due to recent developments, this is not really neccessary any more.","key":"customUserAgent"},{"env":"WA_BLOCK_CRASH_LOGS","p":"block-crash-logs","type":"boolean","description":"Setting this to true will block any network calls to crash log servers. This should keep anything you do under the radar.","key":"blockCrashLogs"},{"env":"WA_CACHE_ENABLED","p":"cache-enabled","type":"boolean","description":"Setting this to false turn off the cache. This may improve memory usage.","key":"cacheEnabled"},{"env":"WA_BROWSER_REVISION","p":"browser-revision","type":"string","description":"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.","key":"browserRevision"},{"env":"WA_HEADLESS","p":"headless","type":"boolean","description":"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.","key":"headless"},{"env":"WA_QR_TIMEOUT","p":"qr-timeout","type":"number","description":"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,"key":"qrTimeout"},{"env":"WA_USE_CHROME","p":"use-chrome","type":"boolean","description":"If true, the program will automatically try to detect the instance of chorme on the machine. Please note this DOES NOT override executablePath.","key":"useChrome"},{"env":"WA_QR_LOG_SKIP","p":"qr-log-skip","type":"boolean","description":"If true, skips logging the QR Code to the console.","key":"qrLogSkip"},{"env":"WA_DISABLE_SPINS","p":"disable-spins","type":"boolean","description":"Setting this to true will simplify logs for use within docker containers by disabling spins (will still print raw messages).","key":"disableSpins"},{"env":"WA_LOG_CONSOLE","p":"log-console","type":"boolean","description":"If true, this will log any console messages from the browser.","key":"logConsole"},{"env":"WA_LOG_CONSOLE_ERRORS","p":"log-console-errors","type":"boolean","description":"If true, this will log any error messages from the browser instance","key":"logConsoleErrors"},{"env":"WA_AUTH_TIMEOUT","p":"auth-timeout","type":"number","description":"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`.","key":"authTimeout"},{"env":"WA_SAFE_MODE","p":"safe-mode","type":"boolean","description":"If true, client will check if the page is valid before each command. If page is not valid, it will throw an error.","key":"safeMode"},{"env":"WA_SKIP_SESSION_SAVE","p":"skip-session-save","type":"boolean","description":"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","key":"skipSessionSave"},{"env":"WA_POPUP","p":"popup","type":["boolean","number"],"description":"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.\n\nYou can also get the QR code png at (if localhost and port 3000):\n\n`http://localhost:3000/qr`\n\nor if you have multiple session:\n\n `http://localhost:3000/qr?sessionId=[sessionId]`","key":"popup"},{"env":"WA_QR_POP_UP_ONLY","p":"qr-pop-up-only","type":"boolean","description":"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.\n\nSetting 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.\n\nAs mentioned in [popup](#popup), the url for the qr code is `http://localhost:3000/qr` if the port is 3000.","key":"qrPopUpOnly"},{"env":"WA_BLOCK_ASSETS","p":"block-assets","type":"boolean","description":"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.","key":"blockAssets"},{"env":"WA_KEEP_UPDATED","p":"keep-updated","type":"boolean","description":"[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`.","key":"keepUpdated"},{"env":"WA_RESIZABLE","p":"resizable","type":"boolean","description":"Syncs the viewport size with the window size which is how normal browsers act. Only relevant when `headless: false` and this overrides `viewport` config.","key":"resizable"},{"env":"WA_VIEWPORT","p":"viewport","type":"object","properties":{"width":{"type":"number","description":"Page width in pixels"},"height":{"type":"number","description":"Page height in pixels"}},"additionalProperties":false,"description":"Set the desired viewport height and width. For CLI, use [width]x[height] format. E.g `--viewport 1920x1080`.","key":"viewport"},{"env":"WA_LEGACY","p":"legacy","type":"boolean","description":"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.","key":"legacy"},{"env":"WA_DELETE_SESSION_DATA_ON_LOGOUT","p":"delete-session-data-on-logout","type":"boolean","description":"Deletes the session data file (if found) on logout event. This results in a quicker login when you restart the process.","key":"deleteSessionDataOnLogout"},{"env":"WA_KILL_PROCESS_ON_TIMEOUT","p":"kill-process-on-timeout","type":"boolean","description":"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.","key":"killProcessOnTimeout"},{"env":"WA_CORS_FIX","p":"cors-fix","type":"boolean","description":"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.","key":"corsFix"},{"env":"WA_CALL_TIMEOUT","p":"call-timeout","type":"number","description":"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.\n\nIf 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.\n\nThis is useful if you do not rely on the results of a client method (e.g the message ID).\n\nIf set to `0`, the process will wait indefinitely for a client method to resolve.","default":0,"key":"callTimeout"},{"env":"WA_SCREENSHOT_ON_INITIALIZATION_BROWSER_ERROR","p":"screenshot-on-initialization-browser-error","type":"boolean","description":"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`","key":"screenshotOnInitializationBrowserError"},{"env":"WA_EVENT_MODE","p":"event-mode","type":"boolean","description":"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.\n\nThis is useful because you can register/deregister the event listener as needed whereas the legacy method of setting callbacks are only be set once","key":"eventMode"},{"env":"WA_LOG_FILE","p":"log-file","type":"boolean","description":"If true, the system will automatically create a log of all processes relating to actions sent to the web session.\n\nThe location of the file will be relative to the process directory (pd)\n\n`[pd]/[sessionId]/[start timestamp].log`","default":false,"key":"logFile"},{"env":"WA_ID_CORRECTION","p":"id-correction","type":"boolean","description":"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,"key":"idCorrection"},{"env":"WA_STICKER_SERVER_ENDPOINT","p":"sticker-server-endpoint","type":["string","boolean"],"description":"Redundant until self-hostable sticker server is available.","key":"stickerServerEndpoint"},{"env":"WA_GH_PATCH","p":"gh-patch","type":"boolean","description":"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.","key":"ghPatch"},{"env":"WA_CACHED_PATCH","p":"cached-patch","type":"boolean","description":"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.","key":"cachedPatch"},{"env":"WA_LOG_DEBUG_INFO_AS_OBJECT","p":"log-debug-info-as-object","type":"boolean","description":"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`.","key":"logDebugInfoAsObject"},{"env":"WA_KILL_CLIENT_ON_LOGOUT","p":"kill-client-on-logout","type":"boolean","description":"Kill the client when a logout is detected","key":"killClientOnLogout"},{"env":"WA_THROW_ON_EXPIRED_SESSION_DATA","p":"throw-on-expired-session-data","type":"boolean","description":"This will make the `create` command return `false` if the detected session data is expired.\n\nThis will mean, the process will not attempt to automatically get a new QR code.","key":"throwOnExpiredSessionData"},{"env":"WA_USE_NATIVE_PROXY","p":"use-native-proxy","type":"boolean","description":"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.","key":"useNativeProxy"},{"env":"WA_RASPI","p":"raspi","type":"boolean","description":"Set this to `true` to make the library work on Raspberry Pi OS.\n\nMake sure to run the following command before running the library the first time:\n\n``` > sudo apt update -y && sudo apt install chromium-browser chromium-codecs-ffmpeg -y && sudo apt upgrade ```\n\nIf you're using the CLI, you can set this value to `true` by adding the following flag to the CLI command\n\n``` > npx @open-wa/wa-automate ... --raspi ```","key":"raspi"},{"env":"WA_MULTI_DEVICE","p":"multi-device","type":"boolean","description":"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!!!!\n\nSet this to true if you're using the multidevice beta.","key":"multiDevice"},{"env":"WA_SESSION_DATA_BUCKET_AUTH","p":"session-data-bucket-auth","type":"string","description":"Base64 encoded S3 Bucket & Authentication object for session data files. The object should be in the same format as cloudUploadOptions.","key":"sessionDataBucketAuth"},{"env":"WA_AUTO_EMOJI","p":"auto-emoji","type":"string","description":"Set the automatic emoji detection character. Set this to false to disable auto emoji. Default is `:`.","key":"autoEmoji"},{"env":"WA_MAX_CHATS","p":"max-chats","type":"number","description":"Set the maximum amount of chats to be present in a session.","key":"maxChats"},{"env":"WA_MAX_MESSAGES","p":"max-messages","type":"number","description":"Set the maximum amount of messages to be present in a session.","key":"maxMessages"},{"env":"WA_DISCORD","p":"discord","type":"string","description":"Your Discord ID to get onto the sticker leaderboard!","key":"discord"},{"env":"WA_IGNORE_NUKE","p":"ignore-nuke","type":"boolean","description":"Don't implicitly determine if the host logged out.","key":"ignoreNuke"},{"env":"WA_ENSURE_HEADFUL_INTEGRITY","p":"ensure-headful-integrity","type":"boolean","description":"Makes sure the headless session is usable even on first login. Headful sessions are ususally only usable on reauthentication.","key":"ensureHeadfulIntegrity"},{"env":"WA_WAIT_FOR_RIPE_SESSION","p":"wait-for-ripe-session","type":"boolean","description":"wait for a valid headful session. Not required in recent versions.","key":"waitForRipeSession"},{"env":"WA_QR_MAX","p":"qr-max","type":"number","description":"Automatically kill the process after a set amount of qr codes","key":"qrMax"},{"env":"WA_EZQR","p":"ezqr","type":"boolean","description":"Expose a URL where you can easily scan the qr code","key":"ezqr"},{"env":"WA_LOGGING","p":"logging","type":"array","items":{"$ref":"#/definitions/ConfigLogTransport"},"description":"An array of [winston](https://github.com/winstonjs/winston/blob/master/docs/transports.md#additional-transports) logging transport configurations.\n\n[Check this discussion to see how to set up logging](https://github.com/open-wa/wa-automate-nodejs/discussions/2373)","key":"logging"}]

package/dist/api/Client.d.ts

@@ -37,7 +37,6 @@ export declare class Client {
     private _page;
     private _currentlyBeingKilled;
     private _refreshing;
-    private _l;
     private _prio;
     private _pageListeners;
     private _registeredPageListeners;

package/dist/api/Client.js

@@ -54,7 +54,6 @@ const uuid_1 = require("uuid");
 const parse_function_1 = __importDefault(require("parse-function"));
 const fs = __importStar(require("fs"));
 const datauri_1 = __importDefault(require("datauri"));
-const pino_1 = __importDefault(require("pino"));
 const is_url_superb_1 = __importDefault(require("is-url-superb"));
 const fs_extra_1 = require("fs-extra");
 const tree_kill_1 = __importDefault(require("tree-kill"));
@@ -69,24 +68,9 @@ 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("../logging/logging");
 /** @ignore */
-const pkg = fs_extra_1.readJsonSync(path.join(__dirname, '../../package.json')), createLogger = (sessionId, sessionInfo, config) => {
-    const p = path.join(path.resolve(process.cwd()), `/logs/${sessionId || 'session'}/${sessionInfo.START_TS}.log`);
-    if (!fs.existsSync(p)) {
-        fs.mkdirSync(path.join(path.resolve(process.cwd()), `/logs/${sessionId || 'session'}`), {
-            recursive: true
-        });
-    }
-    const logger = pino_1.default({
-        redact: ['file', 'base64', 'image', 'webpBase64', 'base64', 'durl', 'thumbnail'],
-    }, pino_1.default.destination(p));
-    logger.child({
-        "STAGE": "LAUNCH",
-        sessionInfo,
-        config
-    }).info("");
-    return logger;
-};
+const pkg = (0, fs_extra_1.readJsonSync)(path.join(__dirname, '../../package.json'));
 var namespace;
 (function (namespace) {
     namespace["Chat"] = "Chat";
@@ -201,7 +185,7 @@ class Client {
                 const m = (rb === null || rb === void 0 ? void 0 : rb.method) || this._createConfig.sessionId && this._createConfig.sessionId !== 'session' && req.path.includes(this._createConfig.sessionId) ? req.path.replace(`/${this._createConfig.sessionId}/`, '') : req.path.replace('/', '');
                 let methodRequiresArgs = false;
                 if (args && !Array.isArray(args)) {
-                    const methodArgs = parse_function_1.default().parse(this[m]).args;
+                    const methodArgs = (0, parse_function_1.default)().parse(this[m]).args;
                     if ((methodArgs === null || methodArgs === void 0 ? void 0 : methodArgs.length) > 0)
                         methodRequiresArgs = true;
                     args = methodArgs.map(argName => args[argName]);
@@ -241,7 +225,7 @@ class Client {
         this._createConfig = createConfig || {};
         this._loadedModules = [];
         this._sessionInfo = sessionInfo;
-        this._sessionInfo.INSTANCE_ID = uuid_1.v4();
+        this._sessionInfo.INSTANCE_ID = (0, uuid_1.v4)();
         this._listeners = {};
         if (this._createConfig.stickerServerEndpoint !== false)
             this._createConfig.stickerServerEndpoint = true;
@@ -261,9 +245,9 @@ class Client {
                 yield this.registerAllSimpleListenersOnEv();
             }
             this._sessionInfo.PHONE_VERSION = (_c = (_b = (yield this.getMe())) === null || _b === void 0 ? void 0 : _b.phone) === null || _c === void 0 ? void 0 : _c.wa_version;
-            this.logger().child({
+            logging_1.log.info('LOADED', {
                 PHONE_VERSION: this._sessionInfo.PHONE_VERSION
-            }).info();
+            });
             if (((_d = this._createConfig) === null || _d === void 0 ? void 0 : _d.autoEmoji) === undefined || ((_e = this._createConfig) === null || _e === void 0 ? void 0 : _e.autoEmoji)) {
                 const ident = typeof ((_f = this._createConfig) === null || _f === void 0 ? void 0 : _f.autoEmoji) === "string" ? (_g = this._createConfig) === null || _g === void 0 ? void 0 : _g.autoEmoji : ":";
                 this.onMessage((message) => __awaiter(this, void 0, void 0, function* () {
@@ -279,9 +263,10 @@ class Client {
                 this.onLogout(() => {
                     var _a, _b;
                     if ((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.deleteSessionDataOnLogout)
-                        browser_1.deleteSessionData(this._createConfig);
+                        (0, browser_1.deleteSessionData)(this._createConfig);
                     if ((_b = this._createConfig) === null || _b === void 0 ? void 0 : _b.killClientOnLogout) {
                         console.log("Session logged out. Killing client");
+                        logging_1.log.warn("Session logged out. Killing client");
                         this.kill();
                     }
                 });
@@ -304,6 +289,7 @@ class Client {
             var _a;
             if (!this._refreshing) {
                 console.log("Browser page has closed. Killing client");
+                logging_1.log.warn("Browser page has closed. Killing client");
                 this.kill();
                 if ((_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.killProcessOnBrowserClose)
                     process.exit();
@@ -312,7 +298,7 @@ class Client {
     }
     _reInjectWapi(newTab) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield browser_1.injectApi(newTab || this._page);
+            yield (0, browser_1.injectApi)(newTab || this._page);
         });
     }
     _reRegisterListeners() {
@@ -328,16 +314,14 @@ class Client {
      */
     download(url, optionsOverride = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield tools_1.getDUrl(url, optionsOverride);
+            return yield (0, tools_1.getDUrl)(url, optionsOverride);
         });
     }
     /**
      * Grab the logger for this session/process
      */
     logger() {
-        if (!this._l)
-            this._l = createLogger(this.getSessionId(), this.getSessionInfo(), this.getConfig());
-        return this._l;
+        return logging_1.log;
     }
     /**
      * Refreshes the page and reinjects all necessary files. This may be useful for when trying to save memory
@@ -352,12 +336,12 @@ class Client {
             /**
              * preload license
              */
-            const preloadlicense = ((_c = this._createConfig) === null || _c === void 0 ? void 0 : _c.licenseKey) ? yield patch_manager_1.getLicense(this._createConfig, me, this._sessionInfo, spinner) : false;
+            const preloadlicense = ((_c = this._createConfig) === null || _c === void 0 ? void 0 : _c.licenseKey) ? yield (0, patch_manager_1.getLicense)(this._createConfig, me, this._sessionInfo, spinner) : false;
             spinner.info('Refreshing session');
             const START_TIME = Date.now();
             spinner.info("Opening session in new tab");
             const newTab = yield this._page.browser().newPage();
-            yield browser_1.initPage(this.getSessionId(), this._createConfig, this._createConfig.customUserAgent, spinner, newTab, true);
+            yield (0, browser_1.initPage)(this.getSessionId(), this._createConfig, this._createConfig.customUserAgent, spinner, newTab, true);
             //  await newTab.goto(puppeteerConfig.WAUrl);
             //Two promises. One that closes the previous page, one that sets up the new page
             const closePageOnConflict = () => __awaiter(this, void 0, void 0, function* () {
@@ -375,9 +359,9 @@ class Client {
                 /**
                  * Wait for the new page to be loaded up before closing existing page
                  */
-                yield patch_manager_1.earlyInjectionCheck(newTab);
+                yield (0, patch_manager_1.earlyInjectionCheck)(newTab);
                 spinner.info("Checking if fresh session is authenticated...");
-                if (yield auth_1.isAuthenticated(newTab)) {
+                if (yield (0, auth_1.isAuthenticated)(newTab)) {
                     /**
                      * Reset all listeners
                      */
@@ -386,7 +370,7 @@ class Client {
                     if ((_e = this._createConfig) === null || _e === void 0 ? void 0 : _e.waitForRipeSession) {
                         yield this._reInjectWapi(newTab);
                         spinner.start("Waiting for ripe session...");
-                        if (yield auth_1.waitForRipeSession(newTab))
+                        if (yield (0, auth_1.waitForRipeSession)(newTab))
                             spinner.succeed("Session ready for injection");
                         else
                             spinner.fail("You may experience issues in headless mode. Continuing...");
@@ -396,13 +380,13 @@ class Client {
                     /**
                      * patch
                      */
-                    yield patch_manager_1.getAndInjectLivePatch(newTab, spinner, null, this._createConfig, this._sessionInfo);
+                    yield (0, patch_manager_1.getAndInjectLivePatch)(newTab, spinner, null, this._createConfig, this._sessionInfo);
                     if ((_f = this._createConfig) === null || _f === void 0 ? void 0 : _f.licenseKey)
-                        yield patch_manager_1.getAndInjectLicense(newTab, this._createConfig, me, this._sessionInfo, spinner, preloadlicense);
+                        yield (0, patch_manager_1.getAndInjectLicense)(newTab, this._createConfig, me, this._sessionInfo, spinner, preloadlicense);
                     /**
                      * init patch
                      */
-                    yield init_patch_1.injectInitPatch(newTab);
+                    yield (0, init_patch_1.injectInitPatch)(newTab);
                 }
                 else
                     throw new Error("Session Logged Out. Cannot refresh. Please restart the process and scan the qr code.");
@@ -445,7 +429,8 @@ class Client {
     pup(pageFunction, ...args) {
         var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
-            const { safeMode, callTimeout, idChecking, logFile } = this._createConfig;
+            const { safeMode, callTimeout, idChecking, logFile, logging } = this._createConfig;
+            let _t;
             if (safeMode) {
                 if (!this._page || this._page.isClosed())
                     throw new errors_1.CustomError(errors_1.ERROR_NAME.PAGE_CLOSED, 'page closed');
@@ -464,13 +449,17 @@ class Client {
                     }
                 });
             }
-            if (logFile) {
+            if (logging) {
                 const wapis = (_b = (((_a = pageFunction === null || pageFunction === void 0 ? void 0 : pageFunction.toString()) === null || _a === void 0 ? void 0 : _a.match(/WAPI\.(\w*)\(/g)) || [])) === null || _b === void 0 ? void 0 : _b.map(s => s.replace(/WAPI|\.|\(/g, ''));
-                this.logger().child(Object.assign({ _method: (wapis === null || wapis === void 0 ? void 0 : wapis.length) === 1 ? wapis[0] : wapis }, args[0])).info();
+                _t = Date.now();
+                logging_1.log.info(`Request ${_t}`, Object.assign({ _method: (wapis === null || wapis === void 0 ? void 0 : wapis.length) === 1 ? wapis[0] : wapis }, args[0]));
             }
             if (callTimeout)
                 return yield Promise.race([this._page.evaluate(pageFunction, ...args), new Promise((resolve, reject) => { var _a; return setTimeout(reject, (_a = this._createConfig) === null || _a === void 0 ? void 0 : _a.callTimeout, new errors_1.PageEvaluationTimeout()); })]);
             const res = yield this._page.evaluate(pageFunction, ...args);
+            if (_t && logging) {
+                logging_1.log.info(`Response ${_t}: ${Date.now() - _t}ms`, { res });
+            }
             if (this._createConfig.onError && typeof res == "string" && (res.startsWith("Error") || res.startsWith("ERROR"))) {
                 const e = this._createConfig.onError;
                 /**
@@ -543,7 +532,6 @@ class Client {
                 return window[funcName] ? WAPI[`${funcName}`](obj => window[funcName](obj)) : false;
             }, { funcName });
             if (this._listeners[funcName] && !this._refreshing) {
-                // console.log('listener already set');
                 return true;
             }
             this._listeners[funcName] = fn;
@@ -581,6 +569,7 @@ class Client {
             this.registerPageEventListener('framenavigated', (frame) => __awaiter(this, void 0, void 0, function* () {
                 if (frame.url().includes('post_logout=1')) {
                     console.log("LOGGED OUT");
+                    logging_1.log.warn("LOGGED OUT");
                     yield fn(true);
                 }
             }), priority);
@@ -1055,7 +1044,8 @@ class Client {
             if (this._currentlyBeingKilled)
                 return;
             this._currentlyBeingKilled = true;
-            console.log('Shutting Down');
+            console.log('Killing client. Shutting Down');
+            logging_1.log.info('Killing client. Shutting Down');
             const browser = yield ((_a = this === null || this === void 0 ? void 0 : this._page) === null || _a === void 0 ? void 0 : _a.browser());
             const pid = (browser === null || browser === void 0 ? void 0 : browser.process()) ? (_b = browser === null || browser === void 0 ? void 0 : browser.process()) === null || _b === void 0 ? void 0 : _b.pid : null;
             try {
@@ -1064,7 +1054,7 @@ class Client {
                 if (this._page && ((_e = this._page) === null || _e === void 0 ? void 0 : _e.browser))
                     yield ((_g = (_f = this._page) === null || _f === void 0 ? void 0 : _f.browser()) === null || _g === void 0 ? void 0 : _g.close());
                 if (pid)
-                    tree_kill_1.default(pid, 'SIGKILL');
+                    (0, tree_kill_1.default)(pid, 'SIGKILL');
             }
             catch (error) {
                 //ignore error
@@ -1348,7 +1338,7 @@ class Client {
                 console.error(`\nUnable to decrypt sticker. Unlock this feature and support open-wa by getting a license: ${yield this.link("v=i")}\n`);
                 throw new errors_1.CustomError(errors_1.ERROR_NAME.STICKER_NOT_DECRYPTED, 'Sticker not decrypted');
             }
-            const mediaData = yield wa_decrypt_1.decryptMedia(m);
+            const mediaData = yield (0, wa_decrypt_1.decryptMedia)(m);
             return `data:${m.mimetype};base64,${mediaData.toString('base64')}`;
         });
     }
@@ -1365,13 +1355,13 @@ class Client {
     sendImage(to, file, filename, caption, quotedMsgId, waitForId, ptt, withoutPreview, hideTags, viewOnce) {
         return __awaiter(this, void 0, void 0, function* () {
             //check if the 'base64' file exists
-            if (!tools_1.isDataURL(file) && !tools_1.isBase64(file) && !file.includes("data:")) {
+            if (!(0, tools_1.isDataURL)(file) && !(0, tools_1.isBase64)(file) && !file.includes("data:")) {
                 //must be a file then
                 const relativePath = path.join(path.resolve(process.cwd(), file || ''));
                 if (fs.existsSync(file) || fs.existsSync(relativePath)) {
-                    file = yield datauri_1.default(fs.existsSync(file) ? file : relativePath);
+                    file = yield (0, datauri_1.default)(fs.existsSync(file) ? file : relativePath);
                 }
-                else if (is_url_superb_1.default(file)) {
+                else if ((0, is_url_superb_1.default)(file)) {
                     return yield this.sendFileFromUrl(to, file, filename, caption, quotedMsgId, {}, waitForId, ptt, withoutPreview, hideTags, viewOnce);
                 }
                 else
@@ -1527,14 +1517,14 @@ class Client {
     sendVideoAsGif(to, file, filename, caption, quotedMsgId, requestConfig = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             //check if the 'base64' file exists
-            if (!tools_1.isDataURL(file)) {
+            if (!(0, tools_1.isDataURL)(file)) {
                 //must be a file then
                 const relativePath = path.join(path.resolve(process.cwd(), file || ''));
                 if (fs.existsSync(file) || fs.existsSync(relativePath)) {
-                    file = yield datauri_1.default(fs.existsSync(file) ? file : relativePath);
+                    file = yield (0, datauri_1.default)(fs.existsSync(file) ? file : relativePath);
                 }
-                else if (is_url_superb_1.default(file)) {
-                    file = yield tools_1.getDUrl(file, requestConfig);
+                else if ((0, is_url_superb_1.default)(file)) {
+                    file = yield (0, tools_1.getDUrl)(file, requestConfig);
                 }
                 else
                     throw new errors_1.CustomError(errors_1.ERROR_NAME.FILE_NOT_FOUND, 'Cannot find file. Make sure the file reference is relative, a valid URL or a valid DataURL');
@@ -1557,13 +1547,14 @@ class Client {
             if (n) {
                 const r = `https://i.giphy.com/${n[1]}.mp4`;
                 const filename = `${n[1]}.mp4`;
-                const dUrl = yield tools_1.getDUrl(r);
+                const dUrl = yield (0, tools_1.getDUrl)(r);
                 return yield this.pup(({ to, dUrl, filename, caption }) => {
                     WAPI.sendVideoAsGif(dUrl, to, filename, caption);
                 }, { to, dUrl, filename, caption });
             }
             else {
                 console.log('something is wrong with this giphy link');
+                logging_1.log.error('something is wrong with this giphy link', giphyMediaUrl);
                 return;
             }
         });
@@ -1582,7 +1573,7 @@ class Client {
      */
     sendFileFromUrl(to, url, filename, caption, quotedMsgId, requestConfig = {}, waitForId, ptt, withoutPreview, hideTags, viewOnce) {
         return __awaiter(this, void 0, void 0, function* () {
-            const base64 = yield tools_1.getDUrl(url, requestConfig);
+            const base64 = yield (0, tools_1.getDUrl)(url, requestConfig);
             return yield this.sendFile(to, base64, filename, caption, quotedMsgId, waitForId, ptt, withoutPreview, hideTags, viewOnce);
         });
     }
@@ -2170,7 +2161,7 @@ class Client {
             const m = yield this.pup(messageId => WAPI.getStickerDecryptable(messageId), messageId);
             if (!m)
                 return false;
-            return Object.assign({ t: m.t, id: m.id }, wa_decrypt_1.bleachMessage(m));
+            return Object.assign({ t: m.t, id: m.id }, (0, wa_decrypt_1.bleachMessage)(m));
         });
     }
     /**
@@ -2189,7 +2180,7 @@ class Client {
             const m = yield this.pup(messageId => WAPI.forceStaleMediaUpdate(messageId), messageId);
             if (!m)
                 return false;
-            return Object.assign({}, wa_decrypt_1.bleachMessage(m));
+            return Object.assign({}, (0, wa_decrypt_1.bleachMessage)(m));
         });
     }
     /**
@@ -2532,8 +2523,7 @@ class Client {
      */
     setGroupIcon(groupId, image) {
         return __awaiter(this, void 0, void 0, function* () {
-            const mimeInfo = tools_1.base64MimeType(image);
-            console.log("setGroupIcon -> mimeInfo", mimeInfo);
+            const mimeInfo = (0, tools_1.base64MimeType)(image);
             if (!mimeInfo || mimeInfo.includes("image")) {
                 let imgData;
                 if (this._createConfig.stickerServerEndpoint) {
@@ -2555,7 +2545,7 @@ class Client {
         return __awaiter(this, void 0, void 0, function* () {
             // eslint-disable-next-line no-useless-catch
             try {
-                const base64 = yield tools_1.getDUrl(url, requestConfig);
+                const base64 = yield (0, tools_1.getDUrl)(url, requestConfig);
                 return yield this.setGroupIcon(groupId, base64);
             }
             catch (error) {
@@ -2739,7 +2729,7 @@ class Client {
      */
     sendStickerfromUrl(to, url, requestConfig = {}, stickerMetadata) {
         return __awaiter(this, void 0, void 0, function* () {
-            const base64 = yield tools_1.getDUrl(url, requestConfig);
+            const base64 = yield (0, tools_1.getDUrl)(url, requestConfig);
             return yield this.sendImageAsSticker(to, base64, stickerMetadata);
         });
     }
@@ -2756,7 +2746,7 @@ class Client {
      */
     sendStickerfromUrlAsReply(to, url, messageId, requestConfig = {}, stickerMetadata) {
         return __awaiter(this, void 0, void 0, function* () {
-            const dUrl = yield tools_1.getDUrl(url, requestConfig);
+            const dUrl = yield (0, tools_1.getDUrl)(url, requestConfig);
             const processingResponse = yield this.prepareWebp(dUrl, stickerMetadata);
             if (!processingResponse)
                 return false;
@@ -2782,15 +2772,15 @@ class Client {
                 image = image.toString('base64');
             }
             else if (typeof image === 'string') {
-                if (!tools_1.isDataURL(image) && !tools_1.isBase64(image)) {
+                if (!(0, tools_1.isDataURL)(image) && !(0, tools_1.isBase64)(image)) {
                     //must be a file then
-                    if (is_url_superb_1.default(image)) {
-                        image = yield tools_1.getDUrl(image);
+                    if ((0, is_url_superb_1.default)(image)) {
+                        image = yield (0, tools_1.getDUrl)(image);
                     }
                     else {
                         const relativePath = path.join(path.resolve(process.cwd(), image || ''));
                         if (fs.existsSync(image) || fs.existsSync(relativePath)) {
-                            image = yield datauri_1.default(fs.existsSync(image) ? image : relativePath);
+                            image = yield (0, datauri_1.default)(fs.existsSync(image) ? image : relativePath);
                         }
                         else
                             return 'FILE_NOT_FOUND';
@@ -2835,10 +2825,10 @@ class Client {
                 if (!a.emojiId) {
                     //check if its a local file:
                     const key = a.file ? 'file' : 'image';
-                    if (!tools_1.isDataURL(a[key]) && !is_url_superb_1.default(a[key]) && !tools_1.isBase64(a[key])) {
+                    if (!(0, tools_1.isDataURL)(a[key]) && !(0, is_url_superb_1.default)(a[key]) && !(0, tools_1.isBase64)(a[key])) {
                         const relativePath = path.join(path.resolve(process.cwd(), a[key] || ''));
                         if (fs.existsSync(a[key]) || fs.existsSync(relativePath)) {
-                            a[key] = yield datauri_1.default(fs.existsSync(a[key]) ? a[key] : relativePath);
+                            a[key] = yield (0, datauri_1.default)(fs.existsSync(a[key]) ? a[key] : relativePath);
                         }
                         else {
                             console.error('FILE_NOT_FOUND');
@@ -2878,8 +2868,7 @@ class Client {
     }
     prepareWebp(image, stickerMetadata) {
         return __awaiter(this, void 0, void 0, function* () {
-            // console.log("prepareWebp", image.slice(0,25))
-            if (tools_1.isDataURL(image) && !image.includes("image")) {
+            if ((0, tools_1.isDataURL)(image) && !image.includes("image")) {
                 console.error("Not an image. Please use convertMp4BufferToWebpDataUrl to process video stickers");
                 return false;
             }
@@ -2904,15 +2893,15 @@ class Client {
                 image = image.toString('base64');
             }
             else if (typeof image === 'string') {
-                if (!tools_1.isDataURL(image) && !tools_1.isBase64(image)) {
+                if (!(0, tools_1.isDataURL)(image) && !(0, tools_1.isBase64)(image)) {
                     //must be a file then
-                    if (is_url_superb_1.default(image)) {
-                        image = yield tools_1.getDUrl(image);
+                    if ((0, is_url_superb_1.default)(image)) {
+                        image = yield (0, tools_1.getDUrl)(image);
                     }
                     else {
                         const relativePath = path.join(path.resolve(process.cwd(), image || ''));
                         if (fs.existsSync(image) || fs.existsSync(relativePath)) {
-                            image = yield datauri_1.default(fs.existsSync(image) ? image : relativePath);
+                            image = yield (0, datauri_1.default)(fs.existsSync(image) ? image : relativePath);
                         }
                         else
                             return 'FILE_NOT_FOUND';
@@ -2940,15 +2929,15 @@ class Client {
                 file = file.toString('base64');
             }
             if (typeof file === 'string') {
-                if (!tools_1.isDataURL(file) && !tools_1.isBase64(file)) {
+                if (!(0, tools_1.isDataURL)(file) && !(0, tools_1.isBase64)(file)) {
                     //must be a file then
-                    if (is_url_superb_1.default(file)) {
-                        file = yield tools_1.getDUrl(file);
+                    if ((0, is_url_superb_1.default)(file)) {
+                        file = yield (0, tools_1.getDUrl)(file);
                     }
                     else {
                         const relativePath = path.join(path.resolve(process.cwd(), file || ''));
                         if (fs.existsSync(file) || fs.existsSync(relativePath)) {
-                            file = yield datauri_1.default(fs.existsSync(file) ? file : relativePath);
+                            file = yield (0, datauri_1.default)(fs.existsSync(file) ? file : relativePath);
                         }
                         else
                             return 'FILE_NOT_FOUND';
@@ -2971,6 +2960,7 @@ class Client {
             catch (error) {
                 const msg = 'Stickers have to be less than 1MB. Please lower the fps or shorten the duration using the processOptions parameter: https://open-wa.github.io/wa-automate-nodejs/classes/client.html#sendmp4assticker';
                 console.log(msg);
+                logging_1.log.warn(msg);
                 throw new errors_1.CustomError(errors_1.ERROR_NAME.STICKER_TOO_LARGE, msg);
             }
         });
@@ -3331,7 +3321,7 @@ class Client {
                             return yield this._webhookQueue.add(() => __awaiter(this, void 0, void 0, function* () {
                                 return yield Promise.all([
                                     ...Object.keys(this._registeredWebhooks).map(webhookId => this._registeredWebhooks[webhookId]).filter(webhookEntry => webhookEntry.events.includes(event))
-                                ].map(({ id, url, requestConfig }) => axios_1.default(Object.assign({ method: 'post', url, data: this.prepEventData(_data, event, { webhook_id: id }) }, requestConfig)).catch(err => console.error(`WEBHOOK ERROR: `, url, err.message))));
+                                ].map(({ id, url, requestConfig }) => (0, axios_1.default)(Object.assign({ method: 'post', url, data: this.prepEventData(_data, event, { webhook_id: id }) }, requestConfig)).catch(err => console.error(`WEBHOOK ERROR: `, url, err.message))));
                             }));
                         }), 10000);
                     }
@@ -3354,7 +3344,7 @@ class Client {
             if (!this._webhookQueue)
                 this._webhookQueue = new p_queue_1.default({ concurrency });
             const validListeners = yield this._setupWebhooksOnListeners(events);
-            const id = uuid_1.v4();
+            const id = (0, uuid_1.v4)();
             if (validListeners.length) {
                 this._registeredWebhooks[id] = {
                     id,
@@ -3366,12 +3356,13 @@ class Client {
                 return this._registeredWebhooks[id];
             }
             console.log('Invalid listener(s)', events);
+            logging_1.log.warn('Invalid listener(s)', events);
             return false;
         });
     }
     prepEventData(data, event, extras) {
         const sessionId = this.getSessionId();
-        return Object.assign({ ts: Date.now(), sessionId, id: uuid_1.v4(), event,
+        return Object.assign({ ts: Date.now(), sessionId, id: (0, uuid_1.v4)(), event,
             data }, extras);
     }
     getEventSignature(simpleListener) {
@@ -3384,12 +3375,14 @@ class Client {
                     this._registeredEvListeners = {};
                 if (this._registeredEvListeners[simpleListener]) {
                     console.log('Listener already registered');
+                    logging_1.log.warn('Listener already registered');
                     return false;
                 }
                 this._registeredEvListeners[simpleListener] = yield this[simpleListener](data => events_1.ev.emit(this.getEventSignature(simpleListener), this.prepEventData(data, simpleListener)));
                 return true;
             }
             console.log('Invalid lisetner', simpleListener);
+            logging_1.log.warn('Invalid lisetner', simpleListener);
             return false;
         });
     }

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

@@ -1,5 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 import { PREPROCESSORS } from '../../structures/preProcessors';
+import { ConfigLogTransport } from '../../logging/logging';
 import { Base64 } from "./aliases";
 import { SimpleListener } from './events';
 /**
@@ -741,6 +742,12 @@ export interface ConfigObject {
      * 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[];
     /**@internal */
     [x: string]: any;
 }