diff --git a/README.md b/README.md index 8562f33..fdf6ae3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[![npm](https://img.shields.io/npm/v/whatsapp-web.js.svg)](https://www.npmjs.com/package/whatsapp-web.js) [![Depfu](https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg)](https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765) ![WhatsApp_Web 2.2114.8](https://img.shields.io/badge/WhatsApp_Web-2.2114.8-brightgreen.svg) [![Discord Chat](https://img.shields.io/discord/698610475432411196.svg?logo=discord)](https://discord.gg/H7DqQs4) +[![npm](https://img.shields.io/npm/v/whatsapp-web.js.svg)](https://www.npmjs.com/package/whatsapp-web.js) [![Depfu](https://badges.depfu.com/badges/4a65a0de96ece65fdf39e294e0c8dcba/overview.svg)](https://depfu.com/github/pedroslopez/whatsapp-web.js?project_id=9765) ![WhatsApp_Web 2.2126.10](https://img.shields.io/badge/WhatsApp_Web-2.2126.10-brightgreen.svg) [![Discord Chat](https://img.shields.io/discord/698610475432411196.svg?logo=discord)](https://discord.gg/H7DqQs4) # whatsapp-web.js A WhatsApp API client that connects through the WhatsApp Web browser app diff --git a/docs/Base.html b/docs/Base.html index debfd50..29de05a 100644 --- a/docs/Base.html +++ b/docs/Base.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Base + whatsapp-web.js 1.13.0 » Class: Base @@ -15,7 +15,7 @@ @@ -50,7 +50,7 @@ diff --git a/docs/BusinessContact.html b/docs/BusinessContact.html index 201f9db..68b964a 100644 --- a/docs/BusinessContact.html +++ b/docs/BusinessContact.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: BusinessContact + whatsapp-web.js 1.13.0 » Class: BusinessContact @@ -15,7 +15,7 @@ @@ -290,7 +290,7 @@ diff --git a/docs/Chat.html b/docs/Chat.html index f2c8a72..e9b02e0 100644 --- a/docs/Chat.html +++ b/docs/Chat.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Chat + whatsapp-web.js 1.13.0 » Class: Chat @@ -15,7 +15,7 @@ @@ -477,7 +477,7 @@ diff --git a/docs/Client.html b/docs/Client.html index b4cc41e..c00ebf8 100644 --- a/docs/Client.html +++ b/docs/Client.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Client + whatsapp-web.js 1.13.0 » Class: Client @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@
class

Client

-

Source: Client.js:51

+

Source: Client.js:52

Starting point for interacting with the WhatsApp Web API

@@ -55,6 +55,9 @@
+
acceptGroupV4Invite(inviteV4)
+
+
acceptInvite(inviteCode)
@@ -125,14 +128,17 @@
muteChat(chatId, unmuteDate)
+
pinChat()
+
+
-
pinChat()
+
resetState()
-
resetState()
+
searchMessages(query[, options])
sendMessage(chatId, content[, options])
@@ -458,6 +464,20 @@

Ffmpeg path to use when formating videos to webp while sending stickers

+ + +

bypassCSP

+ + +

 

+ + +

 

+ + +

Sets bypassing of page's Content-Security-Policy.

+ + @@ -498,6 +518,44 @@

Methods

+
async
+

acceptGroupV4Invite(inviteV4) → Promise containing Object

+

Accepts a private invitation to join a group

+
+

Parameter

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

inviteV4

+ 		+

object

+ 		+

 

+ 		+

Invite V4 Info

+
+
+
+
Returns
+
+

Promise containing Object 

+
+
async

acceptInvite(inviteCode) → Promise containing string

Accepts an invitation to join a group

@@ -1103,6 +1161,108 @@
async
+

searchMessages(query[, options]) → Promise containing Array of Message

+

Searches for messages

+
+

Parameters

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

query

+ 		+

string

+ 		+

 

+ 		+
+

options

+ 		+

Object

+ 		+

Yes

+ 		+

Values in options have the following properties:

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

page

+ 		+

number

+ 		+

Yes

+ 		+
+

limit

+ 		+

number

+ 		+

Yes

+ 		+
+

chatId

+ 		+

string

+ 		+

Yes

+ 		+
+
+
+
+
Returns
+
+

Promise containing Array of Message 

+
+
+
async

sendMessage(chatId, content[, options]) → Promise containing Message

Send a message to a specific chatId

@@ -1978,7 +2138,7 @@
diff --git a/docs/Client.js.html b/docs/Client.js.html index 939e205..03ddc82 100644 --- a/docs/Client.js.html +++ b/docs/Client.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: Client.js + whatsapp-web.js 1.13.0 » Source: Client.js @@ -15,7 +15,7 @@ @@ -61,6 +61,7 @@ const { ClientInfo, Message, MessageMedia, Contact, Location, GroupNotification * @param {number} options.takeoverTimeoutMs - How much time to wait before taking over the session * @param {string} options.userAgent - User agent to use in puppeteer * @param {string} options.ffmpegPath - Ffmpeg path to use when formating videos to webp while sending stickers + * @param {boolean} options.bypassCSP - Sets bypassing of page's Content-Security-Policy. * * @fires Client#qr * @fires Client#authenticated @@ -113,6 +114,10 @@ class Client extends EventEmitter { }, this.options.session); } + if(this.options.bypassCSP) { + await page.setBypassCSP(true); + } + await page.goto(WhatsWebURL, { waitUntil: 'load', timeout: 0, @@ -461,6 +466,7 @@ class Client extends EventEmitter { * @typedef {Object} MessageSendOptions * @property {boolean} [linkPreview=true] - Show links preview * @property {boolean} [sendAudioAsVoice=false] - Send audio as voice message + * @property {boolean} [sendVideoAsGif=false] - Send video as gif * @property {boolean} [sendMediaAsSticker=false] - Send media as a sticker * @property {boolean} [sendMediaAsDocument=false] - Send media as a document * @property {boolean} [parseVCards=true] - Automatically parse vCards and send them as contacts @@ -468,6 +474,9 @@ class Client extends EventEmitter { * @property {string} [quotedMessageId] - Id of the message that is being quoted (or replied to) * @property {Contact[]} [mentions] - Contacts that are being mentioned in the message * @property {boolean} [sendSeen=true] - Mark the conversation as seen after sending the message + * @property {string} [stickerAuthor=undefined] - Sets the author of the sticker, (if sendMediaAsSticker is true). + * @property {string} [stickerName=undefined] - Sets the name of the sticker, (if sendMediaAsSticker is true). + * @property {string[]} [stickerCategories=undefined] - Sets the categories of the sticker, (if sendMediaAsSticker is true). Provide emoji char array, can be null. * @property {MessageMedia} [media] - Media to be sent */ @@ -483,12 +492,14 @@ class Client extends EventEmitter { let internalOptions = { linkPreview: options.linkPreview === false ? undefined : true, sendAudioAsVoice: options.sendAudioAsVoice, + sendVideoAsGif: options.sendVideoAsGif, sendMediaAsSticker: options.sendMediaAsSticker, sendMediaAsDocument: options.sendMediaAsDocument, caption: options.caption, quotedMessageId: options.quotedMessageId, parseVCards: options.parseVCards === false ? false : true, - mentionedJidList: Array.isArray(options.mentions) ? options.mentions.map(contact => contact.id._serialized) : [] + mentionedJidList: Array.isArray(options.mentions) ? options.mentions.map(contact => contact.id._serialized) : [], + ...options.extra }; const sendSeen = typeof options.sendSeen === 'undefined' ? true : options.sendSeen; @@ -512,7 +523,12 @@ class Client extends EventEmitter { } if (internalOptions.sendMediaAsSticker && internalOptions.attachment) { - internalOptions.attachment = await Util.formatToWebpSticker(internalOptions.attachment); + internalOptions.attachment = + await Util.formatToWebpSticker(internalOptions.attachment, { + name: options.stickerName, + author: options.stickerAuthor, + categories: options.stickerCategories + }); } const newMessage = await this.pupPage.evaluate(async (chatId, message, options, sendSeen) => { @@ -530,6 +546,24 @@ class Client extends EventEmitter { return new Message(this, newMessage); } + /** + * Searches for messages + * @param {string} query + * @param {Object} [options] + * @param {number} [options.page] + * @param {number} [options.limit] + * @param {string} [options.chatId] + * @returns {Promise<Message[]>} + */ + async searchMessages(query, options = {}) { + const messages = await this.pupPage.evaluate(async (query, page, count, remote) => { + const { messages } = await window.Store.Msg.search(query, page, count, remote); + return messages.map(msg => window.WWebJS.getMessageModel(msg)); + }, query, options.page, options.limit, options.chatId); + + return messages.map(msg => new Message(this, msg)); + } + /** * Get all current chat instances * @returns {Promise<Array<Chat>>} @@ -604,6 +638,20 @@ class Client extends EventEmitter { return chatId._serialized; } + /** + * Accepts a private invitation to join a group + * @param {object} inviteV4 Invite V4 Info + * @returns {Promise<Object>} + */ + async acceptGroupV4Invite(inviteInfo) { + if(!inviteInfo.inviteCode) throw 'Invalid invite code, try passing the message.inviteV4 object'; + if (inviteInfo.inviteCodeExp == 0) throw 'Expired invite code'; + return await this.pupPage.evaluate(async inviteInfo => { + let { groupId, fromId, inviteCode, inviteCodeExp, toId } = inviteInfo; + return await window.Store.Wap.acceptGroupV4Invite(groupId, fromId, inviteCode, String(inviteCodeExp), toId); + }, inviteInfo); + } + /** * Sets the current user's status message * @param {string} status New status message @@ -900,7 +948,7 @@ module.exports = Client;
diff --git a/docs/ClientInfo.html b/docs/ClientInfo.html index 534e4a6..e3da6e1 100644 --- a/docs/ClientInfo.html +++ b/docs/ClientInfo.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: ClientInfo + whatsapp-web.js 1.13.0 » Class: ClientInfo @@ -15,7 +15,7 @@ @@ -235,7 +235,7 @@
diff --git a/docs/Contact.html b/docs/Contact.html index fa014c3..1c654a8 100644 --- a/docs/Contact.html +++ b/docs/Contact.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Contact + whatsapp-web.js 1.13.0 » Class: Contact @@ -15,7 +15,7 @@ @@ -257,7 +257,7 @@
diff --git a/docs/GroupChat.html b/docs/GroupChat.html index c4e2312..5bfe258 100644 --- a/docs/GroupChat.html +++ b/docs/GroupChat.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: GroupChat + whatsapp-web.js 1.13.0 » Class: GroupChat @@ -15,7 +15,7 @@ @@ -916,7 +916,7 @@
diff --git a/docs/GroupNotification.html b/docs/GroupNotification.html index 8dd690b..3c365b6 100644 --- a/docs/GroupNotification.html +++ b/docs/GroupNotification.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: GroupNotification + whatsapp-web.js 1.13.0 » Class: GroupNotification @@ -15,7 +15,7 @@ @@ -233,7 +233,7 @@
diff --git a/docs/InterfaceController.html b/docs/InterfaceController.html index cdb51d5..9c60c8a 100644 --- a/docs/InterfaceController.html +++ b/docs/InterfaceController.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: InterfaceController + whatsapp-web.js 1.13.0 » Class: InterfaceController @@ -15,7 +15,7 @@ @@ -39,16 +39,28 @@
+
checkFeatureStatus(feature)
+
+
closeRightDrawer()
-
openChatDrawer(chatId)
+
disableFeatures(features)
+
+
+
enableFeatures(features)
+
getFeatures()
+
+
+
openChatDrawer(chatId)
+
+
openChatSearch(chatId)
@@ -78,12 +90,119 @@

Methods

+
async
+

checkFeatureStatus(feature)

+

Check if Feature is enabled

+
+

Parameter

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

feature

+ 		+

string

+ 		+

 

+ 		+

status to check

+
+
+
+
async

closeRightDrawer()

Closes the Right Drawer

async
+

disableFeatures(features)

+

Disable Features

+
+

Parameter

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

features

+ 		+

Array of string

+ 		+

 

+ 		+

to be disabled

+
+
+
+
+
async
+

enableFeatures(features)

+

Enable Features

+
+

Parameter

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

features

+ 		+

Array of string

+ 		+

 

+ 		+

to be enabled

+
+
+
+
+
async
+

getFeatures()

+

Get all Features

+
+
+
async

openChatDrawer(chatId)

Opens the Chat Drawer

@@ -263,7 +382,7 @@
diff --git a/docs/Label.html b/docs/Label.html index 836d3a9..913d607 100644 --- a/docs/Label.html +++ b/docs/Label.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Label + whatsapp-web.js 1.13.0 » Class: Label @@ -15,7 +15,7 @@ @@ -163,7 +163,7 @@
diff --git a/docs/Location.html b/docs/Location.html index b569081..2c60776 100644 --- a/docs/Location.html +++ b/docs/Location.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Location + whatsapp-web.js 1.13.0 » Class: Location @@ -15,7 +15,7 @@ @@ -149,7 +149,7 @@
diff --git a/docs/Message.html b/docs/Message.html index 638fa34..8a38b96 100644 --- a/docs/Message.html +++ b/docs/Message.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Message + whatsapp-web.js 1.13.0 » Class: Message @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@
class

Message

-

Source: structures/Message.js:12

+

Source: structures/Message.js:13

Represents a Message on WhatsApp

@@ -51,6 +51,9 @@
broadcast
+
deviceType
+
+
from
@@ -70,6 +73,9 @@
id
+
inviteV4
+
+
isForwarded
@@ -95,12 +101,18 @@
mentionedIds
+
orderId
+
+
timestamp
to
+
token
+
+
type
@@ -116,6 +128,9 @@
+
acceptGroupV4Invite()
+
+
delete(everyone)
@@ -141,6 +156,9 @@
getMentions()
+
getOrder()
+
+
getQuotedMessage()
@@ -192,6 +210,11 @@

Indicates if the message was a broadcast

+

deviceType +  string

+

String that represents from which device type the message was sent

+
+

from  string

ID for the Chat that this message was sent to, except if the message was sent by the current user.

@@ -217,6 +240,11 @@

ID that represents the message

+

inviteV4 +  object

+

Group Invite Data

+
+

isForwarded  boolean

Indicates if the message was forwarded

@@ -252,6 +280,11 @@

Indicates the mentions in the message body.

+

orderId +  string

+

Order ID for message type ORDER

+
+

timestamp  number

Unix timestamp for when the message was created

@@ -264,6 +297,11 @@ If the message is sent by another user, it will be the ID for the current user.

+

token +  string

+

Order Token for message type ORDER

+
+

type  MessageTypes

Message type

@@ -277,6 +315,15 @@

Methods

+
async
+

acceptGroupV4Invite() → Promise containing Object

+

Accept Group V4 Invite

+
+
Returns
+
+

Promise containing Object 

+
+
async

delete(everyone)

Deletes a message from the chat

@@ -394,6 +441,15 @@
async
+

getOrder() → Promise containing Order

+

Gets the order associated with a given message

+
+
Returns
+
+

Promise containing Order 

+
+
+
async

getQuotedMessage() → Promise containing Message

Returns the quoted message, if any

@@ -487,7 +543,7 @@
diff --git a/docs/MessageMedia.html b/docs/MessageMedia.html index 7700e59..d2b9486 100644 --- a/docs/MessageMedia.html +++ b/docs/MessageMedia.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: MessageMedia + whatsapp-web.js 1.13.0 » Class: MessageMedia @@ -15,7 +15,7 @@ @@ -208,7 +208,7 @@
diff --git a/docs/Order.html b/docs/Order.html new file mode 100644 index 0000000..8625db3 --- /dev/null +++ b/docs/Order.html @@ -0,0 +1,117 @@ + + + + + + + whatsapp-web.js 1.13.0 » Class: Order + + + + + + + + +
+
+
+
+
+
class
+

Order

+

Source: structures/Order.js:10

+
+

Represents a Order on WhatsApp

+
+
+
+
+
+
+

Properties

+
+
+
+
createdAt
+
+
+
currency
+
+
+
+
+
+
+
subtotal
+
+
+
total
+
+
+
+
+
+
+
+
+
+
+

new Order()

+
+
Extends
+
Base
+
+
+
+

Properties

+
+

createdAt +  number

+

Order Created At

+
+
+

currency +  string

+

Order Currency

+
+
+

subtotal +  string

+

Order Subtotal

+
+
+

total +  string

+

Order Total

+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/PrivateChat.html b/docs/PrivateChat.html index 46f7117..7ff72b2 100644 --- a/docs/PrivateChat.html +++ b/docs/PrivateChat.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: PrivateChat + whatsapp-web.js 1.13.0 » Class: PrivateChat @@ -15,7 +15,7 @@ @@ -519,7 +519,7 @@
diff --git a/docs/PrivateContact.html b/docs/PrivateContact.html index 1634805..c1bea7d 100644 --- a/docs/PrivateContact.html +++ b/docs/PrivateContact.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: PrivateContact + whatsapp-web.js 1.13.0 » Class: PrivateContact @@ -15,7 +15,7 @@ @@ -283,7 +283,7 @@
diff --git a/docs/Product.html b/docs/Product.html new file mode 100644 index 0000000..97ab7e5 --- /dev/null +++ b/docs/Product.html @@ -0,0 +1,142 @@ + + + + + + + whatsapp-web.js 1.13.0 » Class: Product + + + + + + + + +
+
+
+
+
+
class
+

Product

+

Source: structures/Product.js:10

+
+

Represents a Product on WhatsAppBusiness

+
+
+
+
+
+
+

Properties

+
+
+
+
currency
+
+
+
data
+
+
+
id
+
+
+
+
+
+
+
name
+
+
+
price
+
+
+
quantity
+
+
+
+
+
+
+
thumbnailUrl
+
+
+
+
+
+
+
+
+

new Product()

+
+
Extends
+
Base
+
+
+
+

Properties

+
+

currency +  string

+

Currency

+
+
+

data

+

Product metadata

+
+
+

id +  string

+

Product ID

+
+
+

name +  string

+

Product Name

+
+
+

price +  string

+

Price

+
+
+

quantity +  number

+

Product Quantity

+
+
+

thumbnailUrl +  string

+

Product Thumbnail

+
+
+
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/Util.html b/docs/Util.html index 85f3d6e..2c47de3 100644 --- a/docs/Util.html +++ b/docs/Util.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Class: Util + whatsapp-web.js 1.13.0 » Class: Util @@ -15,7 +15,7 @@ @@ -26,7 +26,7 @@
class

Util

-

Source: util/Util.js:15

+

Source: util/Util.js:16

Utility methods

@@ -42,7 +42,7 @@
formatImageToWebpSticker(media)
-
formatToWebpSticker(media)
+
formatToWebpSticker(media, metadata)
@@ -109,10 +109,10 @@
async static
-

formatToWebpSticker(media) → Promise containing MessageMedia

+

formatToWebpSticker(media, metadata) → Promise containing MessageMedia

Formats a media to webp

-

Parameter

+

Parameters

@@ -136,6 +136,19 @@ + + + + + +
+

metadata

+ 		+

StickerMetadata

+ 		+

 

+ 		+
@@ -227,7 +240,7 @@
diff --git a/docs/global.html b/docs/global.html index 2823cd0..0ec5cf0 100644 --- a/docs/global.html +++ b/docs/global.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Globals + whatsapp-web.js 1.13.0 » Globals @@ -15,7 +15,7 @@ @@ -87,6 +87,11 @@
+
+
StickerMetadata
+
+
+
@@ -766,6 +771,19 @@ + + +

ORDER

+ + +

 

+ + +

 

+ + + +

REVOKED

@@ -779,6 +797,19 @@ + + +

PRODUCT

+ + +

 

+ + +

 

+ + + +

UNKNOWN

@@ -792,6 +823,19 @@ + + +

GROUP_INVITE

+ + +

 

+ + +

 

+ + + + @@ -1304,6 +1348,21 @@

Defaults to false.

+ + +

sendVideoAsGif

+ + +

boolean

+ + +

Yes

+ + +

Send video as gif

+

Defaults to false.

+ +

sendMediaAsSticker

@@ -1406,6 +1465,48 @@

Defaults to true.

+ + +

stickerAuthor

+ + +

string

+ + +

Yes

+ + +

Sets the author of the sticker, (if sendMediaAsSticker is true).

+ + + + +

stickerName

+ + +

string

+ + +

Yes

+ + +

Sets the name of the sticker, (if sendMediaAsSticker is true).

+ + + + +

stickerCategories

+ + +

Array of string

+ + +

Yes

+ + +

Sets the categories of the sticker, (if sendMediaAsSticker is true). Provide emoji char array, can be null.

+ +

media

@@ -1425,6 +1526,65 @@
+

StickerMetadata +  Object

+

Sticker metadata.

+
+

Properties

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

name

+ 		+

string

+ 		+

Yes

+ 		+
+

author

+ 		+

string

+ 		+

Yes

+ 		+
+

categories

+ 		+

Array of string

+ 		+

Yes

+ 		+
+
+
+
@@ -1435,7 +1595,7 @@ diff --git a/docs/index.html b/docs/index.html index e561ca7..2b24426 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Home + whatsapp-web.js 1.13.0 » Home @@ -15,7 +15,7 @@ @@ -27,18 +27,18 @@

- whatsapp-web.js 1.12.6 + whatsapp-web.js 1.13.0

-

npm Depfu WhatsApp_Web 2.2106.5 Discord Chat

+

npm Depfu WhatsApp_Web 2.2126.10 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.

NOTE: I can't guarantee you will not be blocked by using this method, although it has worked for me. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.

Installation

The module is now available on npm! npm i whatsapp-web.js

-

Please note that Node v10.18.1+ is required due to Puppeteer.

+

Please note that Node v14+ is required.

Example usage

const { Client } = require('whatsapp-web.js');
 const client = new Client();
@@ -537,6 +537,11 @@ client.initialize();
                       
                       

                       

+                      

+                        Client#acceptGroupV4Invite(inviteV4)
+                      

+                      

+                      

                       

                         Client#acceptInvite(inviteCode)
                       

@@ -706,15 +711,15 @@ client.initialize();
                       
                       

                       

-                    
-
-
-
Client#info
+
+
+
+
Client#initialize()
@@ -750,6 +755,11 @@ client.initialize();
+
+ Client#searchMessages(query[, options]) +
+
+
Client#sendMessage(chatId, content[, options])
@@ -1450,13 +1460,18 @@ client.initialize();
+
+ InterfaceController#checkFeatureStatus(feature) +
+
+
InterfaceController#closeRightDrawer()
- InterfaceController#openChatDrawer(chatId) + InterfaceController#disableFeatures(features)
@@ -1464,11 +1479,30 @@ client.initialize();
+
+ InterfaceController#enableFeatures(features) +
+
+
+
+ InterfaceController#getFeatures() +
+
+
+
+ InterfaceController#openChatDrawer(chatId) +
+
+
InterfaceController#openChatSearch(chatId)
+
+
+
+
InterfaceController#openChatWindow(chatId)
@@ -1479,10 +1513,6 @@ client.initialize();
-
-
-
-
InterfaceController#openMessageDrawer(msgId)
@@ -1587,6 +1617,11 @@ client.initialize();
+
+ Message#acceptGroupV4Invite() +
+
+
Message#ack
@@ -1612,6 +1647,11 @@ client.initialize();
+
+ Message#deviceType +
+
+
Message#downloadMedia()
@@ -1656,6 +1696,11 @@ client.initialize();
+
+ Message#getOrder() +
+
+
Message#getQuotedMessage()
@@ -1676,6 +1721,11 @@ client.initialize();
+
+ Message#inviteV4 +
+
+
Message#isForwarded
@@ -1715,6 +1765,11 @@ client.initialize();
+
+ Message#orderId +
+
+
Message#reply(content[, chatId][, options])
@@ -1735,6 +1790,11 @@ client.initialize();
+
+ Message#token +
+
+
Message#type
@@ -1874,6 +1934,11 @@ client.initialize();
+
+ MessageTypes.GROUP_INVITE +
+
+
@@ -1889,12 +1954,17 @@ client.initialize();
- MessageTypes.REVOKED + MessageTypes.ORDER
- MessageTypes.STICKER + MessageTypes.PRODUCT +
+
+
+
+ MessageTypes.REVOKED
@@ -1902,6 +1972,11 @@ client.initialize();
+
+ MessageTypes.STICKER +
+
+
MessageTypes.TEXT
@@ -1927,6 +2002,50 @@ client.initialize();
+
+
+

Order

+
+
+
+
+ Order() +
+
+
+
+ Order#createdAt +
+
+
+
+
+
+
+
+ Order#currency +
+
+
+
+ Order#subtotal +
+
+
+
+
+
+
+
+ Order#total +
+
+
+
+
+
+
+

PrivateChat

@@ -2200,6 +2319,104 @@ client.initialize();
+
+
+

Product

+
+
+
+
+ Product() +
+
+
+
+ Product#currency +
+
+
+
+ Product#data +
+
+
+
+
+
+
+
+ Product#id +
+
+
+
+ Product#name +
+
+
+
+ Product#price +
+
+
+
+
+
+
+
+ Product#quantity +
+
+
+
+ Product#thumbnailUrl +
+
+
+
+
+
+
+
+
+
+

ProductMetadata

+
+
+
+
+ ProductMetadata#description +
+
+
+
+ ProductMetadata#id +
+
+
+
+
+
+
+
+ ProductMetadata#name +
+
+
+
+ ProductMetadata#retailer_id +
+
+
+
+
+
+
+
+
+
+
+

Status

@@ -2255,7 +2472,7 @@ client.initialize();
- Util.formatToWebpSticker(media) + Util.formatToWebpSticker(media, metadata)
@@ -2366,7 +2583,7 @@ client.initialize();
diff --git a/docs/scripts/jsdoc-toc.js b/docs/scripts/jsdoc-toc.js index dd8d262..ccd404e 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":"BusinessContact","id":"BusinessContact","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":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Util","id":"Util","children":[]}], + data: [{"label":"Globals","id":"global","children":[]},{"label":"Base","id":"Base","children":[]},{"label":"BusinessContact","id":"BusinessContact","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":"Location","id":"Location","children":[]},{"label":"Message","id":"Message","children":[]},{"label":"MessageMedia","id":"MessageMedia","children":[]},{"label":"Order","id":"Order","children":[]},{"label":"PrivateChat","id":"PrivateChat","children":[]},{"label":"PrivateContact","id":"PrivateContact","children":[]},{"label":"Product","id":"Product","children":[]},{"label":"Util","id":"Util","children":[]}], openedIcon: ' ⇣', saveState: false, useContextMenu: false diff --git a/docs/structures_Base.js.html b/docs/structures_Base.js.html index 6cc2606..becc19f 100644 --- a/docs/structures_Base.js.html +++ b/docs/structures_Base.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Base.js + whatsapp-web.js 1.13.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 2bce713..fdb6fc1 100644 --- a/docs/structures_BusinessContact.js.html +++ b/docs/structures_BusinessContact.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/BusinessContact.js + whatsapp-web.js 1.13.0 » Source: structures/BusinessContact.js @@ -15,7 +15,7 @@ @@ -59,7 +59,7 @@ module.exports = BusinessContact;
diff --git a/docs/structures_Chat.js.html b/docs/structures_Chat.js.html index 3712fa6..92743d2 100644 --- a/docs/structures_Chat.js.html +++ b/docs/structures_Chat.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Chat.js + whatsapp-web.js 1.13.0 » Source: structures/Chat.js @@ -15,7 +15,7 @@ @@ -288,7 +288,7 @@ module.exports = Chat;
diff --git a/docs/structures_ClientInfo.js.html b/docs/structures_ClientInfo.js.html index 9c73de3..30c490e 100644 --- a/docs/structures_ClientInfo.js.html +++ b/docs/structures_ClientInfo.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/ClientInfo.js + whatsapp-web.js 1.13.0 » Source: structures/ClientInfo.js @@ -15,7 +15,7 @@ @@ -108,7 +108,7 @@ module.exports = ClientInfo;
diff --git a/docs/structures_Contact.js.html b/docs/structures_Contact.js.html index 60a2c6d..e4bca9b 100644 --- a/docs/structures_Contact.js.html +++ b/docs/structures_Contact.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Contact.js + whatsapp-web.js 1.13.0 » Source: structures/Contact.js @@ -15,7 +15,7 @@ @@ -219,7 +219,7 @@ module.exports = Contact;
diff --git a/docs/structures_GroupChat.js.html b/docs/structures_GroupChat.js.html index 348379a..12c1784 100644 --- a/docs/structures_GroupChat.js.html +++ b/docs/structures_GroupChat.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/GroupChat.js + whatsapp-web.js 1.13.0 » Source: structures/GroupChat.js @@ -15,7 +15,7 @@ @@ -239,7 +239,7 @@ module.exports = GroupChat;
diff --git a/docs/structures_GroupNotification.js.html b/docs/structures_GroupNotification.js.html index 3b579a6..7cd27da 100644 --- a/docs/structures_GroupNotification.js.html +++ b/docs/structures_GroupNotification.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/GroupNotification.js + whatsapp-web.js 1.13.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 cebed9d..20ad42a 100644 --- a/docs/structures_Label.js.html +++ b/docs/structures_Label.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Label.js + whatsapp-web.js 1.13.0 » Source: structures/Label.js @@ -15,7 +15,7 @@ @@ -88,7 +88,7 @@ module.exports = Label;
diff --git a/docs/structures_Location.js.html b/docs/structures_Location.js.html index a02e02c..e8d387c 100644 --- a/docs/structures_Location.js.html +++ b/docs/structures_Location.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Location.js + whatsapp-web.js 1.13.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 8af39b8..3adef21 100644 --- a/docs/structures_Message.js.html +++ b/docs/structures_Message.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/Message.js + whatsapp-web.js 1.13.0 » Source: structures/Message.js @@ -15,7 +15,7 @@ @@ -34,6 +34,7 @@ const Base = require('./Base'); const MessageMedia = require('./MessageMedia'); const Location = require('./Location'); +const Order = require('./Order'); const { MessageTypes } = require('../util/Constants'); /** @@ -71,7 +72,7 @@ class Message extends Base { * Indicates if the message has media available for download * @type {boolean} */ - this.hasMedia = data.clientUrl || data.deprecatedMms3Url ? true : false; + this.hasMedia = data.clientUrl || data.deprecatedMms3Url; /** * Message content @@ -112,6 +113,12 @@ class Message extends Base { */ this.author = (typeof (data.author) === 'object' && data.author !== null) ? data.author._serialized : data.author; + /** + * String that represents from which device type the message was sent + * @type {string} + */ + this.deviceType = data.id.id.length > 21 ? 'android' : data.id.id.substring(0,2) =='3A' ? 'ios' : 'web'; + /** * Indicates if the message was forwarded * @type {boolean} @@ -160,6 +167,19 @@ class Message extends Base { */ this.vCards = data.type === MessageTypes.CONTACT_CARD_MULTI ? data.vcardList.map((c) => c.vcard) : data.type === MessageTypes.CONTACT_CARD ? [data.body] : []; + /** + * Group Invite Data + * @type {object} + */ + this.inviteV4 = data.type === MessageTypes.GROUP_INVITE ? { + inviteCode: data.inviteCode, + inviteCodeExp: data.inviteCodeExp, + groupId: data.inviteGrp, + groupName: data.inviteGrpName, + fromId: data.from._serialized, + toId: data.to._serialized + } : undefined; + /** * Indicates the mentions in the message body. * @type {Array<string>} @@ -170,6 +190,37 @@ class Message extends Base { this.mentionedIds = data.mentionedJidList; } + /** + * Order ID for message type ORDER + * @type {string} + */ + this.orderId = data.orderId ? data.orderId : undefined; + /** + * Order Token for message type ORDER + * @type {string} + */ + this.token = data.token ? data.token : undefined; + + /** Title */ + if (data.title) { + this.title = data.title; + } + + /** Description */ + if (data.description) { + this.description = data.description; + } + + /** Business Owner JID */ + if (data.businessOwnerJid) { + this.businessOwnerJid = data.businessOwnerJid; + } + + /** Product ID */ + if (data.productId) { + this.productId = data.productId; + } + /** * Links included in the message. * @type {Array<string>} @@ -245,6 +296,14 @@ class Message extends Base { return this.client.sendMessage(chatId, content, options); } + /** + * Accept Group V4 Invite + * @returns {Promise<Object>} + */ + async acceptGroupV4Invite() { + return await this.client.acceptGroupV4Invite(this.inviteV4); + } + /** * Forwards this message to another chat * @@ -373,6 +432,21 @@ class Message extends Base { return info; } + + /** + * Gets the order associated with a given message + * @return {Promise<Order>} + */ + async getOrder() { + if (this.type === MessageTypes.ORDER) { + const result = await this.client.pupPage.evaluate((orderId, token) => { + return window.WWebJS.getOrderDetail(orderId, token); + }, this.orderId, this.token); + if (!result) return undefined; + return new Order(this.client, result); + } + return undefined; + } } module.exports = Message; @@ -386,7 +460,7 @@ module.exports = Message;
diff --git a/docs/structures_MessageMedia.js.html b/docs/structures_MessageMedia.js.html index a935379..1e45235 100644 --- a/docs/structures_MessageMedia.js.html +++ b/docs/structures_MessageMedia.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/MessageMedia.js + whatsapp-web.js 1.13.0 » Source: structures/MessageMedia.js @@ -15,7 +15,7 @@ @@ -86,7 +86,7 @@ module.exports = MessageMedia;
diff --git a/docs/structures_Order.js.html b/docs/structures_Order.js.html new file mode 100644 index 0000000..cb90fcf --- /dev/null +++ b/docs/structures_Order.js.html @@ -0,0 +1,105 @@ + + + + + + + whatsapp-web.js 1.13.0 » Source: structures/Order.js + + + + + + + + +
+
+
+ +
+
+

Source: structures/Order.js

+
+
+ 
'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;
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/structures_PrivateChat.js.html b/docs/structures_PrivateChat.js.html index 0233830..d36a22d 100644 --- a/docs/structures_PrivateChat.js.html +++ b/docs/structures_PrivateChat.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/PrivateChat.js + whatsapp-web.js 1.13.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 bac6ec0..e11f0d0 100644 --- a/docs/structures_PrivateContact.js.html +++ b/docs/structures_PrivateContact.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: structures/PrivateContact.js + whatsapp-web.js 1.13.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 new file mode 100644 index 0000000..6dada75 --- /dev/null +++ b/docs/structures_Product.js.html @@ -0,0 +1,121 @@ + + + + + + + whatsapp-web.js 1.13.0 » Source: structures/Product.js + + + + + + + + +
+
+
+ +
+
+

Source: structures/Product.js

+
+
+ 
'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;
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/structures_ProductMetadata.js.html b/docs/structures_ProductMetadata.js.html new file mode 100644 index 0000000..353739d --- /dev/null +++ b/docs/structures_ProductMetadata.js.html @@ -0,0 +1,78 @@ + + + + + + + whatsapp-web.js 1.13.0 » Source: structures/ProductMetadata.js + + + + + + + + +
+
+
+ +
+
+

Source: structures/ProductMetadata.js

+
+
+ 
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;
+
+
+
+ +
+
+
+ +
+ + + + + + + + + \ No newline at end of file diff --git a/docs/util_Constants.js.html b/docs/util_Constants.js.html index 46b1d01..a4db26a 100644 --- a/docs/util_Constants.js.html +++ b/docs/util_Constants.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: util/Constants.js + whatsapp-web.js 1.13.0 » Source: util/Constants.js @@ -15,7 +15,7 @@ @@ -45,7 +45,8 @@ exports.DefaultOptions = { takeoverOnConflict: false, takeoverTimeoutMs: 0, userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_0) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.109 Safari/537.36', - ffmpegPath: 'ffmpeg' + ffmpegPath: 'ffmpeg', + bypassCSP: false }; /** @@ -99,8 +100,11 @@ exports.MessageTypes = { LOCATION: 'location', CONTACT_CARD: 'vcard', CONTACT_CARD_MULTI: 'multi_vcard', + ORDER: 'order', REVOKED: 'revoked', - UNKNOWN: 'unknown' + PRODUCT: 'product', + UNKNOWN: 'unknown', + GROUP_INVITE: 'groups_v4_invite' }; /** @@ -174,7 +178,7 @@ exports.MessageAck = {
diff --git a/docs/util_InterfaceController.js.html b/docs/util_InterfaceController.js.html index c6bca88..365808e 100644 --- a/docs/util_InterfaceController.js.html +++ b/docs/util_InterfaceController.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: util/InterfaceController.js + whatsapp-web.js 1.13.0 » Source: util/InterfaceController.js @@ -15,7 +15,7 @@ @@ -46,7 +46,8 @@ class InterfaceController { */ async openChatWindow(chatId) { await this.pupPage.evaluate(async chatId => { - let chat = await window.Store.Chat.get(chatId); + let chatWid = window.Store.WidFactory.createWid(chatId); + let chat = await window.Store.Chat.find(chatWid); await window.Store.Cmd.openChatAt(chat); }, chatId); } @@ -103,10 +104,53 @@ class InterfaceController { await window.Store.Cmd.closeDrawerRight(); }); } - + + /** + * Get all Features + */ + async getFeatures() { + return await this.pupPage.evaluate(() => { + return window.Store.Features.F; + }); + } + + /** + * Check if Feature is enabled + * @param {string} feature status to check + */ + async checkFeatureStatus(feature) { + return await this.pupPage.evaluate((feature) => { + return window.Store.Features.supportsFeature(feature); + }, feature); + } + + /** + * Enable Features + * @param {string[]} features to be enabled + */ + async enableFeatures(features) { + await this.pupPage.evaluate((features) => { + for (const feature in features) { + window.Store.Features.setFeature(features[feature], true); + } + }, features); + } + + /** + * Disable Features + * @param {string[]} features to be disabled + */ + async disableFeatures(features) { + await this.pupPage.evaluate((features) => { + for (const feature in features) { + window.Store.Features.setFeature(features[feature], false); + } + }, features); + } } -module.exports = InterfaceController; +module.exports = InterfaceController; +
@@ -116,7 +160,7 @@ module.exports = InterfaceController;
diff --git a/docs/util_Util.js.html b/docs/util_Util.js.html index 14290b7..baaba6a 100644 --- a/docs/util_Util.js.html +++ b/docs/util_Util.js.html @@ -2,9 +2,9 @@ - + - whatsapp-web.js 1.12.6 » Source: util/Util.js + whatsapp-web.js 1.13.0 » Source: util/Util.js @@ -15,7 +15,7 @@ @@ -36,6 +36,7 @@ const path = require('path'); const Crypto = require('crypto'); const { tmpdir } = require('os'); const ffmpeg = require('fluent-ffmpeg'); +const webp = require('node-webpmux'); const fs = require('fs').promises; const has = (o, k) => Object.prototype.hasOwnProperty.call(o, k); @@ -49,6 +50,16 @@ class Util { throw new Error(`The ${this.constructor.name} class may not be instantiated.`); } + static generateHash(length) { + var result = ''; + var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'; + var charactersLength = characters.length; + for ( var i = 0; i < length; i++ ) { + result += characters.charAt(Math.floor(Math.random() * charactersLength)); + } + return result; + } + /** * Sets default properties on an object that aren't already specified. * @param {Object} def Default properties @@ -166,16 +177,49 @@ class Util { }; } + /** + * Sticker metadata. + * @typedef {Object} StickerMetadata + * @property {string} [name] + * @property {string} [author] + * @property {string[]} [categories] + */ + /** * Formats a media to webp * @param {MessageMedia} media + * @param {StickerMetadata} metadata * * @returns {Promise<MessageMedia>} media in webp format */ - static async formatToWebpSticker(media) { - if (media.mimetype.includes('image')) return this.formatImageToWebpSticker(media); - else if (media.mimetype.includes('video')) return this.formatVideoToWebpSticker(media); - else throw new Error('Invalid media format'); + static async formatToWebpSticker(media, metadata) { + let webpMedia; + + if (media.mimetype.includes('image')) + webpMedia = await this.formatImageToWebpSticker(media); + else if (media.mimetype.includes('video')) + webpMedia = await this.formatVideoToWebpSticker(media); + else + throw new Error('Invalid media format'); + + if (metadata.name || metadata.author) { + const img = new webp.Image(); + const hash = this.generateHash(32); + const stickerPackId = hash; + const packname = metadata.name; + const author = metadata.author; + const categories = metadata.categories || ['']; + const json = { 'sticker-pack-id': stickerPackId, 'sticker-pack-name': packname, 'sticker-pack-publisher': author, 'emojis': categories }; + let exifAttr = Buffer.from([0x49, 0x49, 0x2A, 0x00, 0x08, 0x00, 0x00, 0x00, 0x01, 0x00, 0x41, 0x57, 0x07, 0x00, 0x00, 0x00, 0x00, 0x00, 0x16, 0x00, 0x00, 0x00]); + let jsonBuffer = Buffer.from(JSON.stringify(json), 'utf8'); + let exif = Buffer.concat([exifAttr, jsonBuffer]); + exif.writeUIntLE(jsonBuffer.length, 14, 4); + await img.loadBuffer(Buffer.from(webpMedia.data, 'base64')); + img.exif = exif; + webpMedia.data = (await img.saveBuffer()).toString('base64'); + } + + return webpMedia; } /** @@ -187,7 +231,8 @@ class Util { } } -module.exports = Util; +module.exports = Util; + @@ -197,7 +242,7 @@ module.exports = Util; diff --git a/package.json b/package.json index 336e9c3..be18269 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "whatsapp-web.js", - "version": "1.12.6", + "version": "1.13.0", "description": "Library for interacting with the WhatsApp Web API ", "main": "./index.js", "typings": "./index.d.ts",