whatsapp-web-sj.js 1.26.0

package/src/authStrategies/BaseAuthStrategy.js

@@ -0,0 +1,27 @@
+'use strict';
+
+/**
+ * Base class which all authentication strategies extend
+ */
+class BaseAuthStrategy {
+    constructor() {}
+    setup(client) {
+        this.client = client;
+    }
+    async beforeBrowserInitialized() {}
+    async afterBrowserInitialized() {}
+    async onAuthenticationNeeded() {
+        return {
+            failed: false,
+            restart: false,
+            failureEventPayload: undefined
+        };
+    }
+    async getAuthEventPayload() {}
+    async afterAuthReady() {}
+    async disconnect() {}
+    async destroy() {}
+    async logout() {}
+}
+
+module.exports = BaseAuthStrategy;

package/src/authStrategies/LocalAuth.js

@@ -0,0 +1,56 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const BaseAuthStrategy = require('./BaseAuthStrategy');
+
+/**
+ * Local directory-based authentication
+ * @param {object} options - options
+ * @param {string} options.clientId - Client id to distinguish instances if you are using multiple, otherwise keep null if you are using only one instance
+ * @param {string} options.dataPath - Change the default path for saving session files, default is: "./.wwebjs_auth/" 
+*/
+class LocalAuth extends BaseAuthStrategy {
+    constructor({ clientId, dataPath }={}) {
+        super();
+
+        const idRegex = /^[-_\w]+$/i;
+        if(clientId && !idRegex.test(clientId)) {
+            throw new Error('Invalid clientId. Only alphanumeric characters, underscores and hyphens are allowed.');
+        }
+
+        this.dataPath = path.resolve(dataPath || './.wwebjs_auth/');
+        this.clientId = clientId;
+    }
+
+    async beforeBrowserInitialized() {
+        const puppeteerOpts = this.client.options.puppeteer;
+        const sessionDirName = this.clientId ? `session-${this.clientId}` : 'session';
+        const dirPath = path.join(this.dataPath, sessionDirName);
+
+        if(puppeteerOpts.userDataDir && puppeteerOpts.userDataDir !== dirPath) {
+            throw new Error('LocalAuth is not compatible with a user-supplied userDataDir.');
+        }
+
+        fs.mkdirSync(dirPath, { recursive: true });
+        
+        this.client.options.puppeteer = {
+            ...puppeteerOpts,
+            userDataDir: dirPath
+        };
+
+        this.userDataDir = dirPath;
+    }
+
+    async logout() {
+        if (this.userDataDir) {
+            await fs.promises.rm(this.userDataDir, { recursive: true, force: true })
+                .catch((e) => {
+                    throw new Error(e);
+                });
+        }
+    }
+
+}
+
+module.exports = LocalAuth;

package/src/authStrategies/NoAuth.js

@@ -0,0 +1,12 @@
+'use strict';
+
+const BaseAuthStrategy = require('./BaseAuthStrategy');
+
+/**
+ * No session restoring functionality
+ * Will need to authenticate via QR code every time
+*/
+class NoAuth extends BaseAuthStrategy { }
+
+
+module.exports = NoAuth;

package/src/authStrategies/RemoteAuth.js

@@ -0,0 +1,204 @@
+'use strict';
+
+/* Require Optional Dependencies */
+try {
+    var fs = require('fs-extra');
+    var unzipper = require('unzipper');
+    var archiver = require('archiver');
+} catch {
+    fs = undefined;
+    unzipper = undefined;
+    archiver = undefined;
+}
+
+const path = require('path');
+const { Events } = require('./../util/Constants');
+const BaseAuthStrategy = require('./BaseAuthStrategy');
+
+/**
+ * Remote-based authentication
+ * @param {object} options - options
+ * @param {object} options.store - Remote database store instance
+ * @param {string} options.clientId - Client id to distinguish instances if you are using multiple, otherwise keep null if you are using only one instance
+ * @param {string} options.dataPath - Change the default path for saving session files, default is: "./.wwebjs_auth/" 
+ * @param {number} options.backupSyncIntervalMs - Sets the time interval for periodic session backups. Accepts values starting from 60000ms {1 minute}
+ */
+class RemoteAuth extends BaseAuthStrategy {
+    constructor({ clientId, dataPath, store, backupSyncIntervalMs } = {}) {
+        if (!fs && !unzipper && !archiver) throw new Error('Optional Dependencies [fs-extra, unzipper, archiver] are required to use RemoteAuth. Make sure to run npm install correctly and remove the --no-optional flag');
+        super();
+
+        const idRegex = /^[-_\w]+$/i;
+        if (clientId && !idRegex.test(clientId)) {
+            throw new Error('Invalid clientId. Only alphanumeric characters, underscores and hyphens are allowed.');
+        }
+        if (!backupSyncIntervalMs || backupSyncIntervalMs < 60000) {
+            throw new Error('Invalid backupSyncIntervalMs. Accepts values starting from 60000ms {1 minute}.');
+        }
+        if(!store) throw new Error('Remote database store is required.');
+
+        this.store = store;
+        this.clientId = clientId;
+        this.backupSyncIntervalMs = backupSyncIntervalMs;
+        this.dataPath = path.resolve(dataPath || './.wwebjs_auth/');
+        this.tempDir = `${this.dataPath}/wwebjs_temp_session_${this.clientId}`;
+        this.requiredDirs = ['Default', 'IndexedDB', 'Local Storage']; /* => Required Files & Dirs in WWebJS to restore session */
+    }
+
+    async beforeBrowserInitialized() {
+        const puppeteerOpts = this.client.options.puppeteer;
+        const sessionDirName = this.clientId ? `RemoteAuth-${this.clientId}` : 'RemoteAuth';
+        const dirPath = path.join(this.dataPath, sessionDirName);
+
+        if (puppeteerOpts.userDataDir && puppeteerOpts.userDataDir !== dirPath) {
+            throw new Error('RemoteAuth is not compatible with a user-supplied userDataDir.');
+        }
+
+        this.userDataDir = dirPath;
+        this.sessionName = sessionDirName;
+
+        await this.extractRemoteSession();
+
+        this.client.options.puppeteer = {
+            ...puppeteerOpts,
+            userDataDir: dirPath
+        };
+    }
+
+    async logout() {
+        await this.disconnect();
+    }
+
+    async destroy() {
+        clearInterval(this.backupSync);
+    }
+
+    async disconnect() {
+        await this.deleteRemoteSession();
+
+        let pathExists = await this.isValidPath(this.userDataDir);
+        if (pathExists) {
+            await fs.promises.rm(this.userDataDir, {
+                recursive: true,
+                force: true
+            }).catch(() => {});
+        }
+        clearInterval(this.backupSync);
+    }
+
+    async afterAuthReady() {
+        const sessionExists = await this.store.sessionExists({session: this.sessionName});
+        if(!sessionExists) {
+            await this.delay(60000); /* Initial delay sync required for session to be stable enough to recover */
+            await this.storeRemoteSession({emit: true});
+        }
+        var self = this;
+        this.backupSync = setInterval(async function () {
+            await self.storeRemoteSession();
+        }, this.backupSyncIntervalMs);
+    }
+
+    async storeRemoteSession(options) {
+        /* Compress & Store Session */
+        const pathExists = await this.isValidPath(this.userDataDir);
+        if (pathExists) {
+            await this.compressSession();
+            await this.store.save({session: this.sessionName});
+            await fs.promises.unlink(`${this.sessionName}.zip`);
+            await fs.promises.rm(`${this.tempDir}`, {
+                recursive: true,
+                force: true
+            }).catch(() => {});
+            if(options && options.emit) this.client.emit(Events.REMOTE_SESSION_SAVED);
+        }
+    }
+
+    async extractRemoteSession() {
+        const pathExists = await this.isValidPath(this.userDataDir);
+        const compressedSessionPath = `${this.sessionName}.zip`;
+        const sessionExists = await this.store.sessionExists({session: this.sessionName});
+        if (pathExists) {
+            await fs.promises.rm(this.userDataDir, {
+                recursive: true,
+                force: true
+            }).catch(() => {});
+        }
+        if (sessionExists) {
+            await this.store.extract({session: this.sessionName, path: compressedSessionPath});
+            await this.unCompressSession(compressedSessionPath);
+        } else {
+            fs.mkdirSync(this.userDataDir, { recursive: true });
+        }
+    }
+
+    async deleteRemoteSession() {
+        const sessionExists = await this.store.sessionExists({session: this.sessionName});
+        if (sessionExists) await this.store.delete({session: this.sessionName});
+    }
+
+    async compressSession() {
+        const archive = archiver('zip');
+        const stream = fs.createWriteStream(`${this.sessionName}.zip`);
+
+        await fs.copy(this.userDataDir, this.tempDir).catch(() => {});
+        await this.deleteMetadata();
+        return new Promise((resolve, reject) => {
+            archive
+                .directory(this.tempDir, false)
+                .on('error', err => reject(err))
+                .pipe(stream);
+
+            stream.on('close', () => resolve());
+            archive.finalize();
+        });
+    }
+
+    async unCompressSession(compressedSessionPath) {
+        var stream = fs.createReadStream(compressedSessionPath);
+        await new Promise((resolve, reject) => {
+            stream.pipe(unzipper.Extract({
+                path: this.userDataDir
+            }))
+                .on('error', err => reject(err))
+                .on('finish', () => resolve());
+        });
+        await fs.promises.unlink(compressedSessionPath);
+    }
+
+    async deleteMetadata() {
+        const sessionDirs = [this.tempDir, path.join(this.tempDir, 'Default')];
+        for (const dir of sessionDirs) {
+            const sessionFiles = await fs.promises.readdir(dir);
+            for (const element of sessionFiles) {
+                if (!this.requiredDirs.includes(element)) {
+                    const dirElement = path.join(dir, element);
+                    const stats = await fs.promises.lstat(dirElement);
+    
+                    if (stats.isDirectory()) {
+                        await fs.promises.rm(dirElement, {
+                            recursive: true,
+                            force: true
+                        }).catch(() => {});
+                    } else {
+                        await fs.promises.unlink(dirElement).catch(() => {});
+                    }
+                }
+            }
+        }
+    }
+
+    async isValidPath(path) {
+        try {
+            await fs.promises.access(path);
+            return true;
+        } catch {
+            return false;
+        }
+    }
+
+    async delay(ms) {
+        return new Promise(resolve => setTimeout(resolve, ms));
+    }
+}
+
+module.exports = RemoteAuth;

package/src/factories/ChatFactory.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const PrivateChat = require('../structures/PrivateChat');
+const GroupChat = require('../structures/GroupChat');
+
+class ChatFactory {
+    static create(client, data) {
+        if(data.isGroup) {
+            return new GroupChat(client, data);
+        }
+
+        return new PrivateChat(client, data);
+    }
+}
+
+module.exports = ChatFactory;

package/src/factories/ContactFactory.js

@@ -0,0 +1,16 @@
+'use strict';
+
+const PrivateContact = require('../structures/PrivateContact');
+const BusinessContact = require('../structures/BusinessContact');
+
+class ContactFactory {
+    static create(client, data) {
+        if(data.isBusiness) {
+            return new BusinessContact(client, data);
+        }
+
+        return new PrivateContact(client, data);
+    }
+}
+
+module.exports = ContactFactory;

package/src/structures/Base.js

@@ -0,0 +1,22 @@
+'use strict';
+
+/**
+ * Represents a WhatsApp data structure
+ */
+class Base {
+    constructor(client) {
+        /**
+         * The client that instantiated this
+         * @readonly
+         */
+        Object.defineProperty(this, 'client', { value: client });
+    }
+
+    _clone() {
+        return Object.assign(Object.create(this), this);
+    }
+    
+    _patch(data) { return data; }
+}
+
+module.exports = Base;

package/src/structures/BusinessContact.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const Contact = require('./Contact');
+
+/**
+ * Represents a Business Contact on WhatsApp
+ * @extends {Contact}
+ */
+class BusinessContact extends Contact {
+    _patch(data) {
+        /**
+         * The contact's business profile
+         */
+        this.businessProfile = data.businessProfile;
+
+        return super._patch(data);
+    }
+
+}
+
+module.exports = BusinessContact;

package/src/structures/Buttons.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const MessageMedia = require('./MessageMedia');
+const Util = require('../util/Util');
+
+/**
+ * Button spec used in Buttons constructor
+ * @typedef {Object} ButtonSpec
+ * @property {string=} id - Custom ID to set on the button. A random one will be generated if one is not passed.
+ * @property {string} body - The text to show on the button.
+ */
+
+/**
+ * @typedef {Object} FormattedButtonSpec
+ * @property {string} buttonId
+ * @property {number} type
+ * @property {Object} buttonText
+ */
+
+/**
+ * Message type buttons
+ */
+class Buttons {
+    /**
+     * @param {string|MessageMedia} body
+     * @param {ButtonSpec[]} buttons - See {@link ButtonSpec}
+     * @param {string?} title
+     * @param {string?} footer
+     */
+    constructor(body, buttons, title, footer) {
+        /**
+         * Message body
+         * @type {string|MessageMedia}
+         */
+        this.body = body;
+
+        /**
+         * title of message
+         * @type {string}
+         */
+        this.title = title;
+        
+        /**
+         * footer of message
+         * @type {string}
+         */
+        this.footer = footer;
+
+        if (body instanceof MessageMedia) {
+            this.type = 'media';
+            this.title = '';
+        }else{
+            this.type = 'chat';
+        }
+
+        /**
+         * buttons of message
+         * @type {FormattedButtonSpec[]}
+         */
+        this.buttons = this._format(buttons);
+        if(!this.buttons.length){ throw '[BT01] No buttons';}
+                
+    }
+
+    /**
+     * Creates button array from simple array
+     * @param {ButtonSpec[]} buttons
+     * @returns {FormattedButtonSpec[]}
+     * @example 
+     * Input: [{id:'customId',body:'button1'},{body:'button2'},{body:'button3'},{body:'button4'}]
+     * Returns: [{ buttonId:'customId',buttonText:{'displayText':'button1'},type: 1 },{buttonId:'n3XKsL',buttonText:{'displayText':'button2'},type:1},{buttonId:'NDJk0a',buttonText:{'displayText':'button3'},type:1}]
+     */
+    _format(buttons){
+        buttons = buttons.slice(0,3); // phone users can only see 3 buttons, so lets limit this
+        return buttons.map((btn) => {
+            return {'buttonId':btn.id ? String(btn.id) : Util.generateHash(6),'buttonText':{'displayText':btn.body},'type':1};
+        });
+    }
+    
+}
+
+module.exports = Buttons;

package/src/structures/Call.js

@@ -0,0 +1,76 @@
+'use strict';
+
+const Base = require('./Base');
+
+/**
+ * Represents a Call on WhatsApp
+ * @extends {Base}
+ */
+class Call extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * Call ID
+         * @type {string}
+         */
+        this.id = data.id;
+        /**
+         * From
+         * @type {string}
+         */
+        this.from = data.peerJid;
+        /**
+         * Unix timestamp for when the call was created
+         * @type {number}
+         */
+        this.timestamp = data.offerTime;
+        /**
+         * Is video
+         * @type {boolean}
+         */
+        this.isVideo = data.isVideo;
+        /**
+         * Is Group
+         * @type {boolean}
+         */
+        this.isGroup = data.isGroup;
+        /**
+         * Indicates if the call was sent by the current user
+         * @type {boolean}
+         */
+        this.fromMe = data.outgoing;
+        /**
+         * Indicates if the call can be handled in waweb
+         * @type {boolean}
+         */
+        this.canHandleLocally = data.canHandleLocally;
+        /**
+         * Indicates if the call Should be handled in waweb
+         * @type {boolean}
+         */
+        this.webClientShouldHandle = data.webClientShouldHandle;
+        /**
+         * Object with participants
+         * @type {object}
+         */
+        this.participants = data.participants;
+        
+        return super._patch(data);
+    }
+
+    /**
+     * Reject the call
+    */
+    async reject() {
+        return this.client.pupPage.evaluate((peerJid, id) => {
+            return window.WWebJS.rejectCall(peerJid, id);
+        }, this.from, this.id);
+    }
+}
+
+module.exports = Call;