From 01d23e8dff7c5e8b9a1fe33aab88fe4ba1e3a536 Mon Sep 17 00:00:00 2001 From: Pedro S Lopez Date: Mon, 29 May 2023 02:46:45 -0400 Subject: [PATCH] chore: mark version v1.21.0 --- docs/Base.html | 6 +- docs/BaseAuthStrategy.html | 6 +- docs/BusinessContact.html | 6 +- docs/Buttons.html | 6 +- docs/Call.html | 6 +- docs/Chat.html | 6 +- docs/Client.html | 36 ++++- docs/Client.js.html | 39 ++++- docs/ClientInfo.html | 6 +- docs/Contact.html | 6 +- docs/GroupChat.html | 6 +- docs/GroupNotification.html | 6 +- docs/InterfaceController.html | 6 +- docs/Label.html | 6 +- docs/LegacySessionAuth.html | 6 +- docs/List.html | 6 +- docs/LocalAuth.html | 6 +- docs/LocalWebCache.html | 135 ++++++++++++++++++ docs/Location.html | 6 +- docs/Message.html | 6 +- docs/MessageMedia.html | 6 +- docs/NoAuth.html | 6 +- docs/Order.html | 6 +- docs/PrivateChat.html | 6 +- docs/PrivateContact.html | 6 +- docs/Product.html | 6 +- docs/Reaction.html | 6 +- docs/RemoteAuth.html | 6 +- docs/RemoteWebCache.html | 135 ++++++++++++++++++ docs/Util.html | 6 +- docs/WebCache.html | 65 +++++++++ docs/authStrategies_BaseAuthStrategy.js.html | 6 +- docs/authStrategies_LegacySessionAuth.js.html | 6 +- docs/authStrategies_LocalAuth.js.html | 6 +- docs/authStrategies_NoAuth.js.html | 6 +- docs/authStrategies_RemoteAuth.js.html | 6 +- docs/global.html | 6 +- docs/index.html | 91 +++++++++++- docs/scripts/jsdoc-toc.js | 2 +- docs/structures_Base.js.html | 6 +- docs/structures_BusinessContact.js.html | 6 +- docs/structures_Buttons.js.html | 6 +- docs/structures_Call.js.html | 6 +- docs/structures_Chat.js.html | 6 +- docs/structures_ClientInfo.js.html | 6 +- docs/structures_Contact.js.html | 6 +- docs/structures_GroupChat.js.html | 6 +- docs/structures_GroupNotification.js.html | 6 +- docs/structures_Label.js.html | 6 +- docs/structures_List.js.html | 6 +- docs/structures_Location.js.html | 6 +- docs/structures_Message.js.html | 6 +- docs/structures_MessageMedia.js.html | 6 +- docs/structures_Order.js.html | 6 +- docs/structures_Payment.js.html | 6 +- docs/structures_PrivateChat.js.html | 6 +- docs/structures_PrivateContact.js.html | 6 +- docs/structures_Product.js.html | 6 +- docs/structures_ProductMetadata.js.html | 6 +- docs/structures_Reaction.js.html | 6 +- docs/util_Constants.js.html | 10 +- docs/util_InterfaceController.js.html | 6 +- docs/util_Util.js.html | 6 +- docs/webCache_LocalWebCache.js.html | 96 +++++++++++++ docs/webCache_RemoteWebCache.js.html | 93 ++++++++++++ docs/webCache_WebCache.js.html | 67 +++++++++ package.json | 2 +- 67 files changed, 919 insertions(+), 182 deletions(-) create mode 100644 docs/LocalWebCache.html create mode 100644 docs/RemoteWebCache.html create mode 100644 docs/WebCache.html create mode 100644 docs/webCache_LocalWebCache.js.html create mode 100644 docs/webCache_RemoteWebCache.js.html create mode 100644 docs/webCache_WebCache.js.html diff --git a/docs/Base.html b/docs/Base.html index c8c8fdb..50d0054 100644 --- a/docs/Base.html +++ b/docs/Base.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Base + whatsapp-web.js 1.21.0 » Class: Base @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@ diff --git a/docs/BaseAuthStrategy.html b/docs/BaseAuthStrategy.html index ad240e7..f7e2e6b 100644 --- a/docs/BaseAuthStrategy.html +++ b/docs/BaseAuthStrategy.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: BaseAuthStrategy + whatsapp-web.js 1.21.0 » Class: BaseAuthStrategy @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@ diff --git a/docs/BusinessContact.html b/docs/BusinessContact.html index 9bb1f76..c743d53 100644 --- a/docs/BusinessContact.html +++ b/docs/BusinessContact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: BusinessContact + whatsapp-web.js 1.21.0 » Class: BusinessContact @@ -15,7 +15,7 @@ @@ -326,7 +326,7 @@ diff --git a/docs/Buttons.html b/docs/Buttons.html index 646c69c..71f3d22 100644 --- a/docs/Buttons.html +++ b/docs/Buttons.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Buttons + whatsapp-web.js 1.21.0 » Class: Buttons @@ -15,7 +15,7 @@ @@ -234,7 +234,7 @@ Returns: [{ buttonId:'customId',buttonText:{'displayText':&# diff --git a/docs/Call.html b/docs/Call.html index 9f6d287..e93f9d2 100644 --- a/docs/Call.html +++ b/docs/Call.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Call + whatsapp-web.js 1.21.0 » Class: Call @@ -15,7 +15,7 @@ @@ -168,7 +168,7 @@ diff --git a/docs/Chat.html b/docs/Chat.html index f8d8d21..7fff01c 100644 --- a/docs/Chat.html +++ b/docs/Chat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Chat + whatsapp-web.js 1.21.0 » Class: Chat @@ -15,7 +15,7 @@ @@ -505,7 +505,7 @@ diff --git a/docs/Client.html b/docs/Client.html index fcbbad8..7266ad5 100644 --- a/docs/Client.html +++ b/docs/Client.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Client + whatsapp-web.js 1.21.0 » Class: Client @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@
class

Client

-

Source: Client.js:52

+

Source: Client.js:55

Starting point for interacting with the WhatsApp Web API

@@ -325,6 +325,34 @@

Determines how to save and restore sessions. Will use LegacySessionAuth if options.session is set. Otherwise, NoAuth will be used.

+ + +

webVersion

+ + +

 

+ + +

 

+ + +

The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved.

+ + + + +

webVersionCache

+ + +

 

+ + +

 

+ + +

Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found.

+ +

authTimeoutMs

@@ -2769,7 +2797,7 @@
diff --git a/docs/Client.js.html b/docs/Client.js.html index 80f345b..7842891 100644 --- a/docs/Client.js.html +++ b/docs/Client.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: Client.js + whatsapp-web.js 1.21.0 » Source: Client.js @@ -15,7 +15,7 @@ @@ -41,6 +41,7 @@ const { WhatsWebURL, DefaultOptions, Events, WAState } = require('./ut const { ExposeStore, LoadUtils } = require('./util/Injected'); const ChatFactory = require('./factories/ChatFactory'); const ContactFactory = require('./factories/ContactFactory'); +const WebCacheFactory = require('./webCache/WebCacheFactory'); const { ClientInfo, Message, MessageMedia, Contact, Location, GroupNotification, Label, Call, Buttons, List, Reaction, Chat } = require('./structures'); const LegacySessionAuth = require('./authStrategies/LegacySessionAuth'); const NoAuth = require('./authStrategies/NoAuth'); @@ -50,6 +51,8 @@ const NoAuth = require('./authStrategies/NoAuth'); * @extends {EventEmitter} * @param {object} options - Client options * @param {AuthStrategy} options.authStrategy - Determines how to save and restore sessions. Will use LegacySessionAuth if options.session is set. Otherwise, NoAuth will be used. + * @param {string} options.webVersion - The version of WhatsApp Web to use. Use options.webVersionCache to configure how the version is retrieved. + * @param {object} options.webVersionCache - Determines how to retrieve the WhatsApp Web version. Defaults to a local cache (LocalWebCache) that falls back to latest if the requested version is not found. * @param {number} options.authTimeoutMs - Timeout for authentication selector in puppeteer * @param {object} options.puppeteer - Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/ * @param {number} options.qrMaxRetries - How many times should the qrcode be refreshed before giving up @@ -146,6 +149,7 @@ class Client extends EventEmitter { this.pupPage = page; await this.authStrategy.afterBrowserInitialized(); + await this.initWebVersionCache(); await page.goto(WhatsWebURL, { waitUntil: 'load', @@ -669,6 +673,35 @@ class Client extends EventEmitter { }); } + async initWebVersionCache() { + const { type: webCacheType, ...webCacheOptions } = this.options.webVersionCache; + const webCache = WebCacheFactory.createWebCache(webCacheType, webCacheOptions); + + const requestedVersion = this.options.webVersion; + const versionContent = await webCache.resolve(requestedVersion); + + if(versionContent) { + await this.pupPage.setRequestInterception(true); + this.pupPage.on('request', async (req) => { + if(req.url() === WhatsWebURL) { + req.respond({ + status: 200, + contentType: 'text/html', + body: versionContent + }); + } else { + req.continue(); + } + }); + } else { + this.pupPage.on('response', async (res) => { + if(res.ok() && res.url() === WhatsWebURL) { + await webCache.persist(await res.text()); + } + }); + } + } + /** * Closes the client */ @@ -1323,7 +1356,7 @@ module.exports = Client;
diff --git a/docs/ClientInfo.html b/docs/ClientInfo.html index 9e3ec10..556e8e1 100644 --- a/docs/ClientInfo.html +++ b/docs/ClientInfo.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: ClientInfo + whatsapp-web.js 1.21.0 » Class: ClientInfo @@ -15,7 +15,7 @@ @@ -242,7 +242,7 @@
diff --git a/docs/Contact.html b/docs/Contact.html index e6fd4f8..0b2df46 100644 --- a/docs/Contact.html +++ b/docs/Contact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Contact + whatsapp-web.js 1.21.0 » Class: Contact @@ -15,7 +15,7 @@ @@ -293,7 +293,7 @@
diff --git a/docs/GroupChat.html b/docs/GroupChat.html index 3065d2e..5378930 100644 --- a/docs/GroupChat.html +++ b/docs/GroupChat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: GroupChat + whatsapp-web.js 1.21.0 » Class: GroupChat @@ -15,7 +15,7 @@ @@ -1007,7 +1007,7 @@
diff --git a/docs/GroupNotification.html b/docs/GroupNotification.html index b26ef11..738fc87 100644 --- a/docs/GroupNotification.html +++ b/docs/GroupNotification.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: GroupNotification + whatsapp-web.js 1.21.0 » Class: GroupNotification @@ -15,7 +15,7 @@ @@ -233,7 +233,7 @@
diff --git a/docs/InterfaceController.html b/docs/InterfaceController.html index 9826824..a9d567f 100644 --- a/docs/InterfaceController.html +++ b/docs/InterfaceController.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: InterfaceController + whatsapp-web.js 1.21.0 » Class: InterfaceController @@ -15,7 +15,7 @@ @@ -382,7 +382,7 @@
diff --git a/docs/Label.html b/docs/Label.html index ddbe7fc..b03a350 100644 --- a/docs/Label.html +++ b/docs/Label.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Label + whatsapp-web.js 1.21.0 » Class: Label @@ -15,7 +15,7 @@ @@ -163,7 +163,7 @@
diff --git a/docs/LegacySessionAuth.html b/docs/LegacySessionAuth.html index 6fdde0b..b885efc 100644 --- a/docs/LegacySessionAuth.html +++ b/docs/LegacySessionAuth.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: LegacySessionAuth + whatsapp-web.js 1.21.0 » Class: LegacySessionAuth @@ -15,7 +15,7 @@ @@ -173,7 +173,7 @@
diff --git a/docs/List.html b/docs/List.html index d1190a5..c4b086b 100644 --- a/docs/List.html +++ b/docs/List.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: List + whatsapp-web.js 1.21.0 » Class: List @@ -15,7 +15,7 @@ @@ -256,7 +256,7 @@ Returns: [{'title':'sectionTitle','rows':[{'r
diff --git a/docs/LocalAuth.html b/docs/LocalAuth.html index e722be2..db80224 100644 --- a/docs/LocalAuth.html +++ b/docs/LocalAuth.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: LocalAuth + whatsapp-web.js 1.21.0 » Class: LocalAuth @@ -15,7 +15,7 @@ @@ -120,7 +120,7 @@
diff --git a/docs/LocalWebCache.html b/docs/LocalWebCache.html new file mode 100644 index 0000000..1c96aa6 --- /dev/null +++ b/docs/LocalWebCache.html @@ -0,0 +1,135 @@ + + + + + + + whatsapp-web.js 1.21.0 » Class: LocalWebCache + + + + + + + + +
+
+
+
+
+
class
+

LocalWebCache

+

Source: webCache/LocalWebCache.js:12

+
+

LocalWebCache - Fetches a WhatsApp Web version from a local file store

+
+
+
+
+
+
+
+

new LocalWebCache(options)

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

options

+ 		+

 

+ 		+

 

+ 		+

options

+

Values in options have the following properties:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

path

+ 		+

 

+ 		+

 

+ 		+

Path to the directory where cached versions are saved, default is: "./.wwebjs_cache/"

+
+

strict

+ 		+

 

+ 		+

 

+ 		+

If true, will throw an error if the requested version can't be fetched. If false, will resolve to the latest version.

+
+
+
+
+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/Location.html b/docs/Location.html index 012a74a..9850516 100644 --- a/docs/Location.html +++ b/docs/Location.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Location + whatsapp-web.js 1.21.0 » Class: Location @@ -15,7 +15,7 @@ @@ -149,7 +149,7 @@
diff --git a/docs/Message.html b/docs/Message.html index 6d47a76..7b62325 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Message + whatsapp-web.js 1.21.0 » Class: Message @@ -15,7 +15,7 @@ @@ -670,7 +670,7 @@
diff --git a/docs/MessageMedia.html b/docs/MessageMedia.html index 5d617b8..cbec5f3 100644 --- a/docs/MessageMedia.html +++ b/docs/MessageMedia.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: MessageMedia + whatsapp-web.js 1.21.0 » Class: MessageMedia @@ -15,7 +15,7 @@ @@ -364,7 +364,7 @@
diff --git a/docs/NoAuth.html b/docs/NoAuth.html index d112cbc..9f40f66 100644 --- a/docs/NoAuth.html +++ b/docs/NoAuth.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: NoAuth + whatsapp-web.js 1.21.0 » Class: NoAuth @@ -15,7 +15,7 @@ @@ -51,7 +51,7 @@
diff --git a/docs/Order.html b/docs/Order.html index f63b6d4..e5f27b7 100644 --- a/docs/Order.html +++ b/docs/Order.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Order + whatsapp-web.js 1.21.0 » Class: Order @@ -15,7 +15,7 @@ @@ -102,7 +102,7 @@
diff --git a/docs/PrivateChat.html b/docs/PrivateChat.html index 19e1e47..3d7da30 100644 --- a/docs/PrivateChat.html +++ b/docs/PrivateChat.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: PrivateChat + whatsapp-web.js 1.21.0 » Class: PrivateChat @@ -15,7 +15,7 @@ @@ -543,7 +543,7 @@
diff --git a/docs/PrivateContact.html b/docs/PrivateContact.html index 20d0e9e..062b71d 100644 --- a/docs/PrivateContact.html +++ b/docs/PrivateContact.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: PrivateContact + whatsapp-web.js 1.21.0 » Class: PrivateContact @@ -15,7 +15,7 @@ @@ -319,7 +319,7 @@
diff --git a/docs/Product.html b/docs/Product.html index 9212e02..fe19d1c 100644 --- a/docs/Product.html +++ b/docs/Product.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Product + whatsapp-web.js 1.21.0 » Class: Product @@ -15,7 +15,7 @@ @@ -127,7 +127,7 @@
diff --git a/docs/Reaction.html b/docs/Reaction.html index b56459f..6a0331a 100644 --- a/docs/Reaction.html +++ b/docs/Reaction.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Reaction + whatsapp-web.js 1.21.0 » Class: Reaction @@ -15,7 +15,7 @@ @@ -144,7 +144,7 @@
diff --git a/docs/RemoteAuth.html b/docs/RemoteAuth.html index 4003fc4..1de125a 100644 --- a/docs/RemoteAuth.html +++ b/docs/RemoteAuth.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: RemoteAuth + whatsapp-web.js 1.21.0 » Class: RemoteAuth @@ -15,7 +15,7 @@ @@ -148,7 +148,7 @@
diff --git a/docs/RemoteWebCache.html b/docs/RemoteWebCache.html new file mode 100644 index 0000000..626a904 --- /dev/null +++ b/docs/RemoteWebCache.html @@ -0,0 +1,135 @@ + + + + + + + whatsapp-web.js 1.21.0 » Class: RemoteWebCache + + + + + + + + +
+
+
+
+
+
class
+

RemoteWebCache

+

Source: webCache/RemoteWebCache.js:10

+
+

RemoteWebCache - Fetches a WhatsApp Web version index from a remote server

+
+
+
+
+
+
+
+

new RemoteWebCache(options)

+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

options

+ 		+

 

+ 		+

 

+ 		+

options

+

Values in options have the following properties:

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeOptionalDescription
+

remotePath

+ 		+

 

+ 		+

 

+ 		+

Endpoint that should be used to fetch the version index. Use {version} as a placeholder for the version number.

+
+

strict

+ 		+

 

+ 		+

 

+ 		+

If true, will throw an error if the requested version can't be fetched. If false, will resolve to the latest version. Defaults to false.

+
+
+
+
+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/Util.html b/docs/Util.html index 3c6ea6b..a2288fb 100644 --- a/docs/Util.html +++ b/docs/Util.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Class: Util + whatsapp-web.js 1.21.0 » Class: Util @@ -15,7 +15,7 @@ @@ -243,7 +243,7 @@
diff --git a/docs/WebCache.html b/docs/WebCache.html new file mode 100644 index 0000000..e8f063f --- /dev/null +++ b/docs/WebCache.html @@ -0,0 +1,65 @@ + + + + + + + whatsapp-web.js 1.21.0 » Class: WebCache + + + + + + + + +
+
+
+
+
+
class
+

WebCache

+

Source: webCache/WebCache.js:4

+
+

Default implementation of a web version cache that does nothing.

+
+
+
+
+
+
+
+

new WebCache()

+
+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/authStrategies_BaseAuthStrategy.js.html b/docs/authStrategies_BaseAuthStrategy.js.html index d8b4b2d..97c3a4f 100644 --- a/docs/authStrategies_BaseAuthStrategy.js.html +++ b/docs/authStrategies_BaseAuthStrategy.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: authStrategies/BaseAuthStrategy.js + whatsapp-web.js 1.21.0 » Source: authStrategies/BaseAuthStrategy.js @@ -15,7 +15,7 @@ @@ -65,7 +65,7 @@ module.exports = BaseAuthStrategy;
diff --git a/docs/authStrategies_LegacySessionAuth.js.html b/docs/authStrategies_LegacySessionAuth.js.html index 44642fd..78387cc 100644 --- a/docs/authStrategies_LegacySessionAuth.js.html +++ b/docs/authStrategies_LegacySessionAuth.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: authStrategies/LegacySessionAuth.js + whatsapp-web.js 1.21.0 » Source: authStrategies/LegacySessionAuth.js @@ -15,7 +15,7 @@ @@ -111,7 +111,7 @@ module.exports = LegacySessionAuth;
diff --git a/docs/authStrategies_LocalAuth.js.html b/docs/authStrategies_LocalAuth.js.html index 58688ab..a7ddd56 100644 --- a/docs/authStrategies_LocalAuth.js.html +++ b/docs/authStrategies_LocalAuth.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: authStrategies/LocalAuth.js + whatsapp-web.js 1.21.0 » Source: authStrategies/LocalAuth.js @@ -15,7 +15,7 @@ @@ -91,7 +91,7 @@ module.exports = LocalAuth;
diff --git a/docs/authStrategies_NoAuth.js.html b/docs/authStrategies_NoAuth.js.html index 97d6551..8108dd0 100644 --- a/docs/authStrategies_NoAuth.js.html +++ b/docs/authStrategies_NoAuth.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: authStrategies/NoAuth.js + whatsapp-web.js 1.21.0 » Source: authStrategies/NoAuth.js @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@ module.exports = NoAuth;
diff --git a/docs/authStrategies_RemoteAuth.js.html b/docs/authStrategies_RemoteAuth.js.html index c42fea6..92e1e24 100644 --- a/docs/authStrategies_RemoteAuth.js.html +++ b/docs/authStrategies_RemoteAuth.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: authStrategies/RemoteAuth.js + whatsapp-web.js 1.21.0 » Source: authStrategies/RemoteAuth.js @@ -15,7 +15,7 @@ @@ -243,7 +243,7 @@ module.exports = RemoteAuth;
diff --git a/docs/global.html b/docs/global.html index 206a6ff..d2a62d4 100644 --- a/docs/global.html +++ b/docs/global.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Globals + whatsapp-web.js 1.21.0 » Globals @@ -15,7 +15,7 @@ @@ -2163,7 +2163,7 @@
diff --git a/docs/index.html b/docs/index.html index 8fa8a46..fc956fb 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,7 +3,7 @@ - whatsapp-web.js 1.20.0 » Home + whatsapp-web.js 1.21.0 » Home @@ -13,7 +13,7 @@ @@ -26,11 +26,11 @@

- whatsapp-web.js 1.20.0 + whatsapp-web.js 1.21.0

-

npm Depfu WhatsApp_Web 2.2306.7 Discord Chat

+

npm Depfu WhatsApp_Web 2.2322.15 Discord Chat

whatsapp-web.js

A WhatsApp API client that connects through the WhatsApp Web browser app

It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocked.

@@ -2055,6 +2055,33 @@ limitations under the License.

+
+
+

LocalWebCache

+
+
+
+
+ LocalWebCache(options) +
+
+
+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+

Location

@@ -3303,6 +3330,33 @@ limitations under the License.

+
+
+

RemoteWebCache

+
+
+
+
+ RemoteWebCache(options) +
+
+
+
+
+ +
+
+
+
+ +
+
+
+
+ +
+
+

Status

@@ -3466,6 +3520,33 @@ limitations under the License.

+ + +
+
+
+

WebCache

+
+
+
+
+ WebCache() +
+
+
+
+
+ +
+
+
+
+ +
+
+
+
+
@@ -3479,7 +3560,7 @@ limitations under the License.

diff --git a/docs/scripts/jsdoc-toc.js b/docs/scripts/jsdoc-toc.js index f910b01..e363469 100644 --- a/docs/scripts/jsdoc-toc.js +++ b/docs/scripts/jsdoc-toc.js @@ -6,7 +6,7 @@ treeNode.tree({ autoEscape: false, closedIcon: '⇢', - data: [{"label":"Globals","id":"global","children":[]},{"label":"Base","id":"Base","children":[]},{"label":"BaseAuthStrategy","id":"BaseAuthStrategy","children":[]},{"label":"BusinessContact","id":"BusinessContact","children":[]},{"label":"Buttons","id":"Buttons","children":[]},{"label":"Call","id":"Call","children":[]},{"label":"Chat","id":"Chat","children":[]},{"label":"Client","id":"Client","children":[]},{"label":"ClientInfo","id":"ClientInfo","children":[]},{"label":"Contact","id":"Contact","children":[]},{"label":"GroupChat","id":"GroupChat","children":[]},{"label":"GroupNotification","id":"GroupNotification","children":[]},{"label":"InterfaceController","id":"InterfaceController","children":[]},{"label":"Label","id":"Label","children":[]},{"label":"LegacySessionAuth","id":"LegacySessionAuth","children":[]},{"label":"List","id":"List","children":[]},{"label":"LocalAuth","id":"LocalAuth","children":[]},{"label":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"NoAuth","id":"NoAuth","children":[]},{"label":"Order","id":"Order","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Product","id":"Product","children":[]},{"label":"Reaction","id":"Reaction","children":[]},{"label":"RemoteAuth","id":"RemoteAuth","children":[]},{"label":"Util","id":"Util","children":[]}], + data: [{"label":"Globals","id":"global","children":[]},{"label":"Base","id":"Base","children":[]},{"label":"BaseAuthStrategy","id":"BaseAuthStrategy","children":[]},{"label":"BusinessContact","id":"BusinessContact","children":[]},{"label":"Buttons","id":"Buttons","children":[]},{"label":"Call","id":"Call","children":[]},{"label":"Chat","id":"Chat","children":[]},{"label":"Client","id":"Client","children":[]},{"label":"ClientInfo","id":"ClientInfo","children":[]},{"label":"Contact","id":"Contact","children":[]},{"label":"GroupChat","id":"GroupChat","children":[]},{"label":"GroupNotification","id":"GroupNotification","children":[]},{"label":"InterfaceController","id":"InterfaceController","children":[]},{"label":"Label","id":"Label","children":[]},{"label":"LegacySessionAuth","id":"LegacySessionAuth","children":[]},{"label":"List","id":"List","children":[]},{"label":"LocalAuth","id":"LocalAuth","children":[]},{"label":"LocalWebCache","id":"LocalWebCache","children":[]},{"label":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"NoAuth","id":"NoAuth","children":[]},{"label":"Order","id":"Order","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Product","id":"Product","children":[]},{"label":"Reaction","id":"Reaction","children":[]},{"label":"RemoteAuth","id":"RemoteAuth","children":[]},{"label":"RemoteWebCache","id":"RemoteWebCache","children":[]},{"label":"Util","id":"Util","children":[]},{"label":"WebCache","id":"WebCache","children":[]}], openedIcon: ' ⇣', saveState: false, useContextMenu: false diff --git a/docs/structures_Base.js.html b/docs/structures_Base.js.html index d43cdba..fdab601 100644 --- a/docs/structures_Base.js.html +++ b/docs/structures_Base.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Base.js + whatsapp-web.js 1.21.0 » Source: structures/Base.js @@ -15,7 +15,7 @@ @@ -60,7 +60,7 @@ module.exports = Base;
diff --git a/docs/structures_BusinessContact.js.html b/docs/structures_BusinessContact.js.html index 1912469..449b79a 100644 --- a/docs/structures_BusinessContact.js.html +++ b/docs/structures_BusinessContact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/BusinessContact.js + whatsapp-web.js 1.21.0 » Source: structures/BusinessContact.js @@ -15,7 +15,7 @@ @@ -59,7 +59,7 @@ module.exports = BusinessContact;
diff --git a/docs/structures_Buttons.js.html b/docs/structures_Buttons.js.html index 96a7203..4df1480 100644 --- a/docs/structures_Buttons.js.html +++ b/docs/structures_Buttons.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Buttons.js + whatsapp-web.js 1.21.0 » Source: structures/Buttons.js @@ -15,7 +15,7 @@ @@ -120,7 +120,7 @@ module.exports = Buttons;
diff --git a/docs/structures_Call.js.html b/docs/structures_Call.js.html index 98dfdff..003433a 100644 --- a/docs/structures_Call.js.html +++ b/docs/structures_Call.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Call.js + whatsapp-web.js 1.21.0 » Source: structures/Call.js @@ -15,7 +15,7 @@ @@ -114,7 +114,7 @@ module.exports = Call;
diff --git a/docs/structures_Chat.js.html b/docs/structures_Chat.js.html index 9baaa84..f4c265b 100644 --- a/docs/structures_Chat.js.html +++ b/docs/structures_Chat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Chat.js + whatsapp-web.js 1.21.0 » Source: structures/Chat.js @@ -15,7 +15,7 @@ @@ -305,7 +305,7 @@ module.exports = Chat;
diff --git a/docs/structures_ClientInfo.js.html b/docs/structures_ClientInfo.js.html index d7878b8..1c4a02b 100644 --- a/docs/structures_ClientInfo.js.html +++ b/docs/structures_ClientInfo.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/ClientInfo.js + whatsapp-web.js 1.21.0 » Source: structures/ClientInfo.js @@ -15,7 +15,7 @@ @@ -109,7 +109,7 @@ module.exports = ClientInfo;
diff --git a/docs/structures_Contact.js.html b/docs/structures_Contact.js.html index bce1f31..9345e2e 100644 --- a/docs/structures_Contact.js.html +++ b/docs/structures_Contact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Contact.js + whatsapp-web.js 1.21.0 » Source: structures/Contact.js @@ -15,7 +15,7 @@ @@ -245,7 +245,7 @@ module.exports = Contact;
diff --git a/docs/structures_GroupChat.js.html b/docs/structures_GroupChat.js.html index 737830f..a4b7a05 100644 --- a/docs/structures_GroupChat.js.html +++ b/docs/structures_GroupChat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/GroupChat.js + whatsapp-web.js 1.21.0 » Source: structures/GroupChat.js @@ -15,7 +15,7 @@ @@ -319,7 +319,7 @@ module.exports = GroupChat;
diff --git a/docs/structures_GroupNotification.js.html b/docs/structures_GroupNotification.js.html index 4c3a80c..d6f358c 100644 --- a/docs/structures_GroupNotification.js.html +++ b/docs/structures_GroupNotification.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/GroupNotification.js + whatsapp-web.js 1.21.0 » Source: structures/GroupNotification.js @@ -15,7 +15,7 @@ @@ -143,7 +143,7 @@ module.exports = GroupNotification;
diff --git a/docs/structures_Label.js.html b/docs/structures_Label.js.html index e30b9a3..c445dda 100644 --- a/docs/structures_Label.js.html +++ b/docs/structures_Label.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Label.js + whatsapp-web.js 1.21.0 » Source: structures/Label.js @@ -15,7 +15,7 @@ @@ -88,7 +88,7 @@ module.exports = Label;
diff --git a/docs/structures_List.js.html b/docs/structures_List.js.html index a258dd4..3a0fe0f 100644 --- a/docs/structures_List.js.html +++ b/docs/structures_List.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/List.js + whatsapp-web.js 1.21.0 » Source: structures/List.js @@ -15,7 +15,7 @@ @@ -118,7 +118,7 @@ module.exports = List;
diff --git a/docs/structures_Location.js.html b/docs/structures_Location.js.html index cb490a8..f42ed8b 100644 --- a/docs/structures_Location.js.html +++ b/docs/structures_Location.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Location.js + whatsapp-web.js 1.21.0 » Source: structures/Location.js @@ -15,7 +15,7 @@ @@ -71,7 +71,7 @@ module.exports = Location;
diff --git a/docs/structures_Message.js.html b/docs/structures_Message.js.html index e86248c..1e2da20 100644 --- a/docs/structures_Message.js.html +++ b/docs/structures_Message.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Message.js + whatsapp-web.js 1.21.0 » Source: structures/Message.js @@ -15,7 +15,7 @@ @@ -620,7 +620,7 @@ module.exports = Message;
diff --git a/docs/structures_MessageMedia.js.html b/docs/structures_MessageMedia.js.html index eac0353..52eee0f 100644 --- a/docs/structures_MessageMedia.js.html +++ b/docs/structures_MessageMedia.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/MessageMedia.js + whatsapp-web.js 1.21.0 » Source: structures/MessageMedia.js @@ -15,7 +15,7 @@ @@ -150,7 +150,7 @@ module.exports = MessageMedia;
diff --git a/docs/structures_Order.js.html b/docs/structures_Order.js.html index ab36e66..f897513 100644 --- a/docs/structures_Order.js.html +++ b/docs/structures_Order.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Order.js + whatsapp-web.js 1.21.0 » Source: structures/Order.js @@ -15,7 +15,7 @@ @@ -90,7 +90,7 @@ module.exports = Order;
diff --git a/docs/structures_Payment.js.html b/docs/structures_Payment.js.html index 197016b..c587588 100644 --- a/docs/structures_Payment.js.html +++ b/docs/structures_Payment.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Payment.js + whatsapp-web.js 1.21.0 » Source: structures/Payment.js @@ -15,7 +15,7 @@ @@ -118,7 +118,7 @@ module.exports = Payment;
diff --git a/docs/structures_PrivateChat.js.html b/docs/structures_PrivateChat.js.html index a247712..8ff1bf6 100644 --- a/docs/structures_PrivateChat.js.html +++ b/docs/structures_PrivateChat.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/PrivateChat.js + whatsapp-web.js 1.21.0 » Source: structures/PrivateChat.js @@ -15,7 +15,7 @@ @@ -51,7 +51,7 @@ module.exports = PrivateChat;
diff --git a/docs/structures_PrivateContact.js.html b/docs/structures_PrivateContact.js.html index d30f3c3..c563483 100644 --- a/docs/structures_PrivateContact.js.html +++ b/docs/structures_PrivateContact.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/PrivateContact.js + whatsapp-web.js 1.21.0 » Source: structures/PrivateContact.js @@ -15,7 +15,7 @@ @@ -51,7 +51,7 @@ module.exports = PrivateContact;
diff --git a/docs/structures_Product.js.html b/docs/structures_Product.js.html index c991bc9..d262544 100644 --- a/docs/structures_Product.js.html +++ b/docs/structures_Product.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Product.js + whatsapp-web.js 1.21.0 » Source: structures/Product.js @@ -15,7 +15,7 @@ @@ -106,7 +106,7 @@ module.exports = Product;
diff --git a/docs/structures_ProductMetadata.js.html b/docs/structures_ProductMetadata.js.html index e370c26..d8237fe 100644 --- a/docs/structures_ProductMetadata.js.html +++ b/docs/structures_ProductMetadata.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/ProductMetadata.js + whatsapp-web.js 1.21.0 » Source: structures/ProductMetadata.js @@ -15,7 +15,7 @@ @@ -63,7 +63,7 @@ module.exports = ProductMetadata;
diff --git a/docs/structures_Reaction.js.html b/docs/structures_Reaction.js.html index 2af40de..57ff50e 100644 --- a/docs/structures_Reaction.js.html +++ b/docs/structures_Reaction.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: structures/Reaction.js + whatsapp-web.js 1.21.0 » Source: structures/Reaction.js @@ -15,7 +15,7 @@ @@ -107,7 +107,7 @@ module.exports = Reaction;
diff --git a/docs/util_Constants.js.html b/docs/util_Constants.js.html index 2d15580..b5635ef 100644 --- a/docs/util_Constants.js.html +++ b/docs/util_Constants.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: util/Constants.js + whatsapp-web.js 1.21.0 » Source: util/Constants.js @@ -15,7 +15,7 @@ @@ -38,6 +38,10 @@ exports.DefaultOptions = { headless: true, defaultViewport: null }, + webVersion: '2.2322.15', + webVersionCache: { + type: 'local', + }, authTimeoutMs: 0, qrMaxRetries: 0, takeoverOnConflict: false, @@ -206,7 +210,7 @@ exports.MessageAck = {
diff --git a/docs/util_InterfaceController.js.html b/docs/util_InterfaceController.js.html index eb5aea6..56eea05 100644 --- a/docs/util_InterfaceController.js.html +++ b/docs/util_InterfaceController.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: util/InterfaceController.js + whatsapp-web.js 1.21.0 » Source: util/InterfaceController.js @@ -15,7 +15,7 @@ @@ -166,7 +166,7 @@ module.exports = InterfaceController;
diff --git a/docs/util_Util.js.html b/docs/util_Util.js.html index e852f0b..417ed9e 100644 --- a/docs/util_Util.js.html +++ b/docs/util_Util.js.html @@ -4,7 +4,7 @@ - whatsapp-web.js 1.20.0 » Source: util/Util.js + whatsapp-web.js 1.21.0 » Source: util/Util.js @@ -15,7 +15,7 @@ @@ -225,7 +225,7 @@ module.exports = Util;
diff --git a/docs/webCache_LocalWebCache.js.html b/docs/webCache_LocalWebCache.js.html new file mode 100644 index 0000000..1b2df2b --- /dev/null +++ b/docs/webCache_LocalWebCache.js.html @@ -0,0 +1,96 @@ + + + + + + + whatsapp-web.js 1.21.0 » Source: webCache/LocalWebCache.js + + + + + + + + +
+
+
+ +
+
+

Source: webCache/LocalWebCache.js

+
+
+ 
const path = require('path');
+const fs = require('fs');
+
+const { WebCache, VersionResolveError } = require('./WebCache');
+
+/**
+ * LocalWebCache - Fetches a WhatsApp Web version from a local file store
+ * @param {object} options - options
+ * @param {string} options.path - Path to the directory where cached versions are saved, default is: "./.wwebjs_cache/" 
+ * @param {boolean} options.strict - If true, will throw an error if the requested version can't be fetched. If false, will resolve to the latest version.
+ */
+class LocalWebCache extends WebCache {
+    constructor(options = {}) {
+        super();
+
+        this.path = options.path || './.wwebjs_cache/';
+        this.strict = options.strict || false;
+    }
+
+    async resolve(version) {
+        const filePath = path.join(this.path, `${version}.html`);
+        
+        try {
+            return fs.readFileSync(filePath, 'utf-8');
+        }
+        catch (err) {
+            if (this.strict) throw new VersionResolveError(`Couldn't load version ${version} from the cache`);
+            return null;
+        }
+    }
+
+    async persist(indexHtml) {
+        // extract version from index (e.g. manifest-2.2206.9.json -> 2.2206.9)
+        const version = indexHtml.match(/manifest-([\d\\.]+)\.json/)[1];
+        if(!version) return;
+   
+        const filePath = path.join(this.path, `${version}.html`);
+        fs.mkdirSync(this.path, { recursive: true });
+        fs.writeFileSync(filePath, indexHtml);
+    }
+}
+
+module.exports = LocalWebCache;
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/webCache_RemoteWebCache.js.html b/docs/webCache_RemoteWebCache.js.html new file mode 100644 index 0000000..e734e2c --- /dev/null +++ b/docs/webCache_RemoteWebCache.js.html @@ -0,0 +1,93 @@ + + + + + + + whatsapp-web.js 1.21.0 » Source: webCache/RemoteWebCache.js + + + + + + + + +
+
+
+ +
+
+

Source: webCache/RemoteWebCache.js

+
+
+ 
const fetch = require('node-fetch');
+const { WebCache, VersionResolveError } = require('./WebCache');
+
+/**
+ * RemoteWebCache - Fetches a WhatsApp Web version index from a remote server
+ * @param {object} options - options
+ * @param {string} options.remotePath - Endpoint that should be used to fetch the version index. Use {version} as a placeholder for the version number.
+ * @param {boolean} options.strict - If true, will throw an error if the requested version can't be fetched. If false, will resolve to the latest version. Defaults to false.
+ */
+class RemoteWebCache extends WebCache {
+    constructor(options = {}) {
+        super();
+
+        if (!options.remotePath) throw new Error('webVersionCache.remotePath is required when using the remote cache');
+        this.remotePath = options.remotePath;
+        this.strict = options.strict || false;
+    }
+
+    async resolve(version) {
+        const remotePath = this.remotePath.replace('{version}', version);
+
+        try {
+            const cachedRes = await fetch(remotePath);
+            if (cachedRes.ok) {
+                return cachedRes.text();
+            }
+        } catch (err) {
+            console.error(`Error fetching version ${version} from remote`, err);
+        }
+
+        if (this.strict) throw new VersionResolveError(`Couldn't load version ${version} from the archive`);
+        return null;         
+    }
+
+    async persist() {
+        // Nothing to do here
+    }
+}
+
+module.exports = RemoteWebCache;
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/webCache_WebCache.js.html b/docs/webCache_WebCache.js.html new file mode 100644 index 0000000..60c5208 --- /dev/null +++ b/docs/webCache_WebCache.js.html @@ -0,0 +1,67 @@ + + + + + + + whatsapp-web.js 1.21.0 » Source: webCache/WebCache.js + + + + + + + + +
+
+
+ +
+
+

Source: webCache/WebCache.js

+
+
+ 
/**
+ * Default implementation of a web version cache that does nothing.
+ */
+class WebCache {
+    async resolve() { return null; }
+    async persist() { }
+}
+
+class VersionResolveError extends Error { }
+
+module.exports = {
+    WebCache,
+    VersionResolveError
+};
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/package.json b/package.json index e951c56..206ce6d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "whatsapp-web.js", - "version": "1.20.0", + "version": "1.21.0", "description": "Library for interacting with the WhatsApp Web API ", "main": "./index.js", "typings": "./index.d.ts",