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.
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",
