whatsapp-web-sj.js 1.26.0

package/src/structures/MessageMedia.js

@@ -0,0 +1,111 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const mime = require('mime');
+const fetch = require('node-fetch');
+const { URL } = require('url');
+
+/**
+ * Media attached to a message
+ * @param {string} mimetype MIME type of the attachment
+ * @param {string} data Base64-encoded data of the file
+ * @param {?string} filename Document file name. Value can be null
+ * @param {?number} filesize Document file size in bytes. Value can be null
+ */
+class MessageMedia {
+    constructor(mimetype, data, filename, filesize) {
+        /**
+         * MIME type of the attachment
+         * @type {string}
+         */
+        this.mimetype = mimetype;
+
+        /**
+         * Base64 encoded data that represents the file
+         * @type {string}
+         */
+        this.data = data;
+
+        /**
+         * Document file name. Value can be null
+         * @type {?string}
+         */
+        this.filename = filename;
+        
+        /**
+         * Document file size in bytes. Value can be null
+         * @type {?number}
+         */
+        this.filesize = filesize;
+    }
+
+    /**
+     * Creates a MessageMedia instance from a local file path
+     * @param {string} filePath 
+     * @returns {MessageMedia}
+     */
+    static fromFilePath(filePath) {
+        const b64data = fs.readFileSync(filePath, {encoding: 'base64'});
+        const mimetype = mime.getType(filePath); 
+        const filename = path.basename(filePath);
+
+        return new MessageMedia(mimetype, b64data, filename);
+    }
+
+    /**
+     * Creates a MessageMedia instance from a URL
+     * @param {string} url
+     * @param {Object} [options]
+     * @param {boolean} [options.unsafeMime=false]
+     * @param {string} [options.filename]
+     * @param {object} [options.client]
+     * @param {object} [options.reqOptions]
+     * @param {number} [options.reqOptions.size=0]
+     * @returns {Promise<MessageMedia>}
+     */
+    static async fromUrl(url, options = {}) {
+        const pUrl = new URL(url);
+        let mimetype = mime.getType(pUrl.pathname);
+
+        if (!mimetype && !options.unsafeMime)
+            throw new Error('Unable to determine MIME type using URL. Set unsafeMime to true to download it anyway.');
+
+        async function fetchData (url, options) {
+            const reqOptions = Object.assign({ headers: { accept: 'image/* video/* text/* audio/*' } }, options);
+            const response = await fetch(url, reqOptions);
+            const mime = response.headers.get('Content-Type');
+            const size = response.headers.get('Content-Length');
+
+            const contentDisposition = response.headers.get('Content-Disposition');
+            const name = contentDisposition ? contentDisposition.match(/((?<=filename=")(.*)(?="))/) : null;
+
+            let data = '';
+            if (response.buffer) {
+                data = (await response.buffer()).toString('base64');
+            } else {
+                const bArray = new Uint8Array(await response.arrayBuffer());
+                bArray.forEach((b) => {
+                    data += String.fromCharCode(b);
+                });
+                data = btoa(data);
+            }
+            
+            return { data, mime, name, size };
+        }
+
+        const res = options.client
+            ? (await options.client.pupPage.evaluate(fetchData, url, options.reqOptions))
+            : (await fetchData(url, options.reqOptions));
+
+        const filename = options.filename ||
+            (res.name ? res.name[0] : (pUrl.pathname.split('/').pop() || 'file'));
+        
+        if (!mimetype)
+            mimetype = res.mime;
+
+        return new MessageMedia(mimetype, res.data, filename, res.size || null);
+    }
+}
+
+module.exports = MessageMedia;

package/src/structures/Order.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const Base = require('./Base');
+const Product = require('./Product');
+
+/**
+ * Represents a Order on WhatsApp
+ * @extends {Base}
+ */
+class Order extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * List of products
+         * @type {Array<Product>}
+         */
+        if (data.products) {
+            this.products = data.products.map(product => new Product(this.client, product));
+        }
+        /**
+         * Order Subtotal
+         * @type {string}
+         */
+        this.subtotal = data.subtotal;
+        /**
+         * Order Total
+         * @type {string}
+         */
+        this.total = data.total;
+        /**
+         * Order Currency
+         * @type {string}
+         */
+        this.currency = data.currency;
+        /**
+         * Order Created At
+         * @type {number}
+         */
+        this.createdAt = data.createdAt;
+
+        return super._patch(data);
+    }
+
+
+}
+
+module.exports = Order;

package/src/structures/Payment.js

@@ -0,0 +1,79 @@
+const Base = require('./Base');
+
+class Payment extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * The payment Id
+         * @type {object}
+         */
+        this.id = data.id;
+
+        /**
+         * The payment currency
+         * @type {string}
+         */
+        this.paymentCurrency = data.paymentCurrency;
+
+        /**
+         * The payment ammount ( R$ 1.00 = 1000 )
+         * @type {number}
+         */
+        this.paymentAmount1000 = data.paymentAmount1000;
+
+        /**
+         * The payment receiver
+         * @type {object}
+         */
+        this.paymentMessageReceiverJid = data.paymentMessageReceiverJid;
+
+        /**
+         * The payment transaction timestamp
+         * @type {number}
+         */
+        this.paymentTransactionTimestamp = data.paymentTransactionTimestamp;
+
+        /**
+         * The paymentStatus
+         *
+         * Possible Status
+         * 0:UNKNOWN_STATUS
+         * 1:PROCESSING
+         * 2:SENT
+         * 3:NEED_TO_ACCEPT
+         * 4:COMPLETE
+         * 5:COULD_NOT_COMPLETE
+         * 6:REFUNDED
+         * 7:EXPIRED
+         * 8:REJECTED
+         * 9:CANCELLED
+         * 10:WAITING_FOR_PAYER
+         * 11:WAITING
+         * 
+         * @type {number}
+         */
+        this.paymentStatus = data.paymentStatus;
+
+        /**
+         * Integer that represents the payment Text
+         * @type {number}
+         */
+        this.paymentTxnStatus = data.paymentTxnStatus;
+
+        /**
+         * The note sent with the payment
+         * @type {string}
+         */
+        this.paymentNote = !data.paymentNoteMsg ? undefined : data.paymentNoteMsg.body ?  data.paymentNoteMsg.body : undefined ;
+
+        return super._patch(data);
+    }
+
+}
+
+module.exports = Payment;

package/src/structures/Poll.js

@@ -0,0 +1,44 @@
+'use strict';
+
+/**
+ * Poll send options
+ * @typedef {Object} PollSendOptions
+ * @property {boolean} [allowMultipleAnswers=false] If false it is a single choice poll, otherwise it is a multiple choice poll (false by default)
+ * @property {?Array<number>} messageSecret The custom message secret, can be used as a poll ID. NOTE: it has to be a unique vector with a length of 32
+ */
+
+/** Represents a Poll on WhatsApp */
+class Poll {
+    /**
+     * @param {string} pollName
+     * @param {Array<string>} pollOptions
+     * @param {PollSendOptions} options
+     */
+    constructor(pollName, pollOptions, options = {}) {
+        /**
+         * The name of the poll
+         * @type {string}
+         */
+        this.pollName = pollName.trim();
+
+        /**
+         * The array of poll options
+         * @type {Array.<{name: string, localId: number}>}
+         */
+        this.pollOptions = pollOptions.map((option, index) => ({
+            name: option.trim(),
+            localId: index
+        }));
+
+        /**
+         * The send options for the poll
+         * @type {PollSendOptions}
+         */
+        this.options = {
+            allowMultipleAnswers: options.allowMultipleAnswers === true,
+            messageSecret: options.messageSecret
+        };
+    }
+}
+
+module.exports = Poll;

package/src/structures/PollVote.js

@@ -0,0 +1,61 @@
+'use strict';
+
+const Message = require('./Message');
+const Base = require('./Base');
+
+/**
+ * Selected poll option structure
+ * @typedef {Object} SelectedPollOption
+ * @property {number} id The local selected or deselected option ID
+ * @property {string} name The option name
+ */
+
+/**
+ * Represents a Poll Vote on WhatsApp
+ * @extends {Base}
+ */
+class PollVote extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * The person who voted
+         * @type {string}
+         */
+        this.voter = data.sender;
+
+        /**
+         * The selected poll option(s)
+         * If it's an empty array, the user hasn't selected any options on the poll,
+         * may occur when they deselected all poll options
+         * @type {SelectedPollOption[]}
+         */
+        this.selectedOptions =
+            data.selectedOptionLocalIds.length > 0
+                ? data.selectedOptionLocalIds.map((e) => ({
+                    name: data.parentMessage.pollOptions.find((x) => x.localId === e).name,
+                    localId: e
+                }))
+                : [];
+
+        /**
+         * Timestamp the option was selected or deselected at
+         * @type {number}
+         */
+        this.interractedAtTs = data.senderTimestampMs;
+
+        /**
+         * The poll creation message associated with the poll vote
+         * @type {Message}
+         */
+        this.parentMessage = new Message(this.client, data.parentMessage);
+
+        return super._patch(data);
+    }
+}
+
+module.exports = PollVote;

package/src/structures/PrivateChat.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const Chat = require('./Chat');
+
+/**
+ * Represents a Private Chat on WhatsApp
+ * @extends {Chat}
+ */
+class PrivateChat extends Chat {
+
+}
+
+module.exports = PrivateChat;

package/src/structures/PrivateContact.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const Contact = require('./Contact');
+
+/**
+ * Represents a Private Contact on WhatsApp
+ * @extends {Contact}
+ */
+class PrivateContact extends Contact {
+
+}
+
+module.exports = PrivateContact;

package/src/structures/Product.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const Base = require('./Base');
+const ProductMetadata = require('./ProductMetadata');
+
+/**
+ * Represents a Product on WhatsAppBusiness
+ * @extends {Base}
+ */
+class Product extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * Product ID
+         * @type {string}
+         */
+        this.id = data.id;
+        /**
+         * Price
+         * @type {string}
+         */
+        this.price = data.price ? data.price : '';
+        /**
+         * Product Thumbnail
+         * @type {string}
+         */
+        this.thumbnailUrl = data.thumbnailUrl;
+        /**
+         * Currency
+         * @type {string}
+         */
+        this.currency = data.currency;
+        /**
+         * Product Name
+         * @type {string}
+         */
+        this.name = data.name;
+        /**
+         * Product Quantity
+         * @type {number}
+         */
+        this.quantity = data.quantity;
+        /** Product metadata */
+        this.data = null;
+        return super._patch(data);
+    }
+
+    async getData() {
+        if (this.data === null) {
+            let result = await this.client.pupPage.evaluate((productId) => {
+                return window.WWebJS.getProductMetadata(productId);
+            }, this.id);
+            if (!result) {
+                this.data = undefined;
+            } else {
+                this.data = new ProductMetadata(this.client, result);
+            }
+        }
+        return this.data;
+    }
+}
+
+module.exports = Product;

package/src/structures/ProductMetadata.js

@@ -0,0 +1,25 @@
+const Base = require('./Base');
+
+class ProductMetadata extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /** Product ID */
+        this.id = data.id;
+        /** Retailer ID */
+        this.retailer_id = data.retailer_id;
+        /** Product Name  */
+        this.name = data.name;
+        /** Product Description */
+        this.description = data.description;
+
+        return super._patch(data);
+    }
+
+}
+
+module.exports = ProductMetadata;

package/src/structures/Reaction.js

@@ -0,0 +1,69 @@
+'use strict';
+
+const Base = require('./Base');
+
+/**
+ * Represents a Reaction on WhatsApp
+ * @extends {Base}
+ */
+class Reaction extends Base {
+    constructor(client, data) {
+        super(client);
+
+        if (data) this._patch(data);
+    }
+
+    _patch(data) {
+        /**
+         * Reaction ID
+         * @type {object}
+         */
+        this.id = data.msgKey;
+        /**
+         * Orphan
+         * @type {number}
+         */
+        this.orphan = data.orphan;
+        /**
+         * Orphan reason
+         * @type {?string}
+         */
+        this.orphanReason = data.orphanReason;
+        /**
+         * Unix timestamp for when the reaction was created
+         * @type {number}
+         */
+        this.timestamp = data.timestamp;
+        /**
+         * Reaction
+         * @type {string}
+         */
+        this.reaction = data.reactionText;
+        /**
+         * Read
+         * @type {boolean}
+         */
+        this.read = data.read;
+        /**
+         * Message ID
+         * @type {object}
+         */
+        this.msgId = data.parentMsgKey;
+        /**
+         * Sender ID
+         * @type {string}
+         */
+        this.senderId = data.senderUserJid;
+        /**
+         * ACK
+         * @type {?number}
+         */
+        this.ack = data.ack;
+        
+        
+        return super._patch(data);
+    }
+    
+}
+
+module.exports = Reaction;

package/src/structures/index.js

@@ -0,0 +1,24 @@
+module.exports = {
+    Base: require('./Base'),
+    BusinessContact: require('./BusinessContact'),
+    Chat: require('./Chat'),
+    ClientInfo: require('./ClientInfo'),
+    Contact: require('./Contact'),
+    GroupChat: require('./GroupChat'),
+    Location: require('./Location'),
+    Message: require('./Message'),
+    MessageMedia: require('./MessageMedia'),
+    PrivateChat: require('./PrivateChat'),
+    PrivateContact: require('./PrivateContact'),
+    GroupNotification: require('./GroupNotification'),
+    Label: require('./Label.js'),
+    Order: require('./Order'),
+    Product: require('./Product'),
+    Call: require('./Call'),
+    Buttons: require('./Buttons'),
+    List: require('./List'),
+    Payment: require('./Payment'),
+    Reaction: require('./Reaction'),
+    Poll: require('./Poll'),
+    PollVote: require('./PollVote')
+};