@another-trial/whatsapp-web.js 1.35.0-alpha.1 → 1.35.0-alpha.2

package/README.md

@@ -1,7 +1,7 @@
 <div align="center">
     <br />
     <p>
-        <a href="https://wwebjs.dev"><img src="https://github.com/wwebjs/logos/blob/main/4_Full%20Logo%20Lockup_Small/small_banner_blue.png?raw=true" title="whatsapp-web.js" alt="WWebJS Website" width="500" /></a>
+        <a href="https://wwebjs.dev"><img src="https://github.com/wwebjs/assets/blob/main/Collection/GitHub/wwebjs.png?raw=true" title="whatsapp-web.js" alt="WWebJS Website" width="500" /></a>
     </p>
     <br />
     <p>
@@ -14,57 +14,28 @@
 </div>
 
 ## About
-**A WhatsApp API client that connects through the WhatsApp Web browser app**
+**A WhatsApp API client that operates via the WhatsApp Web browser.**
 
-The library works by launching the WhatsApp Web browser application and managing it using Puppeteer to create an instance of WhatsApp Web, thereby mitigating the risk of being blocked. The WhatsApp API client connects through the WhatsApp Web browser app, accessing its internal functions. This grants you access to nearly all the features available on WhatsApp Web, enabling dynamic handling similar to any other Node.js application.
+The library launches the WhatsApp Web browser app via Puppeteer, accessing its internal functions and creating a managed instance to reduce the risk of being blocked. This gives the API client nearly all WhatsApp Web features for dynamic use in a Node.js application.
 
 > [!IMPORTANT]
 > **It is not guaranteed you will not be blocked by using this method. WhatsApp does not allow bots or unofficial clients on their platform, so this shouldn't be considered totally safe.**
 
 ## Links
 
-* [Website][website]
-* [Guide][guide] ([source][guide-source]) _(work in progress)_
-* [Documentation][documentation] ([source][documentation-source])
-* [WWebJS Discord][discord]
 * [GitHub][gitHub]
+* [Guide][guide] ([source][guide-source])
+* [Documentation][documentation] ([source][documentation-source])
+* [Discord Server][discord]
 * [npm][npm]
 
 ## Installation
 
-The module is now available on npm! `npm i whatsapp-web.js`
+The module is available on [npm][npm] via `npm i whatsapp-web.js`!
 
 > [!NOTE]
-> **Node ``v18+`` is required.**
-
-## QUICK STEPS TO UPGRADE NODE
-
-### Windows
-
-#### Manual
-Just get the latest LTS from the [official node website][nodejs].
-
-#### npm
-```powershell
-sudo npm install -g n
-sudo n stable
-```
-
-#### Choco
-```powershell
-choco install nodejs-lts
-```
-
-#### Winget
-```powershell
-winget install OpenJS.NodeJS.LTS
-```
-
-### Ubuntu / Debian
-```bash
-curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash - &&\
-sudo apt-get install -y nodejs
-```
+> **Node ``v18`` or higher, is required.**  
+> See the [Guide][guide] for quick upgrade instructions.
 
 ## Example usage
 
@@ -165,7 +136,6 @@ See the License for the specific language governing permissions and
 limitations under the License.  
 
 
-[website]: https://wwebjs.dev
 [guide]: https://guide.wwebjs.dev/guide
 [guide-source]: https://github.com/wwebjs/wwebjs.dev/tree/main
 [documentation]: https://docs.wwebjs.dev/

package/example.js

@@ -365,7 +365,7 @@ client.on('message', async msg => {
         let list = new List('List body', 'btnText', sections, 'Title', 'footer');
         client.sendMessage(msg.from, list);
     } else if (msg.body === '!reaction') {
-        msg.react('👍');
+        await msg.react('👍');
     } else if (msg.body === '!sendpoll') {
         /** By default the poll is created as a single choice poll: */
         await msg.reply(new Poll('Winter or Summer?', ['Winter', 'Summer']));
@@ -382,11 +382,20 @@ client.on('message', async msg => {
                 ]
             })
         );
+    } else if (msg.body === '!vote') {
+        if (msg.hasQuotedMsg) {
+            const quotedMsg = await msg.getQuotedMessage();
+            if (quotedMsg.type === 'poll_creation') {
+                await quotedMsg.vote(msg.body.replace('!vote', ''));
+            } else {
+                msg.reply('Can only be used on poll messages');
+            }
+        }
     } else if (msg.body === '!edit') {
         if (msg.hasQuotedMsg) {
             const quotedMsg = await msg.getQuotedMessage();
             if (quotedMsg.fromMe) {
-                quotedMsg.edit(msg.body.replace('!edit', ''));
+                await quotedMsg.edit(msg.body.replace('!edit', ''));
             } else {
                 msg.reply('I can only edit my own messages');
             }

package/index.d.ts

@@ -242,7 +242,7 @@ declare namespace WAWebJS {
         syncHistory(chatId: string): Promise<boolean>
 
         /** Save new contact to user's addressbook or edit the existing one */
-        saveOrEditAddressbookContact(phoneNumber: string, firstName: string, lastName: string, syncToAddressbook?: boolean): Promise<ChatId>
+        saveOrEditAddressbookContact(phoneNumber: string, firstName: string, lastName: string, syncToAddressbook?: boolean): Promise<void>
 
         /**
          * Add or edit a customer note
@@ -882,12 +882,14 @@ declare namespace WAWebJS {
         GROUP_MEMBERSHIP_REQUEST = 'group_membership_request',
         GROUP_UPDATE = 'group_update',
         QR_RECEIVED = 'qr',
+        CODE_RECEIVED = 'code',
         LOADING_SCREEN = 'loading_screen',
         DISCONNECTED = 'disconnected',
         STATE_CHANGED = 'change_state',
         BATTERY_CHANGED = 'change_battery',
         REMOTE_SESSION_SAVED = 'remote_session_saved',
-        CALL = 'call'
+        INCOMING_CALL = 'call',
+        VOTE_UPDATE = 'vote_update',
     }
 
     /** Group notification types */
@@ -896,6 +898,8 @@ declare namespace WAWebJS {
         INVITE = 'invite',
         REMOVE = 'remove',
         LEAVE = 'leave',
+        PROMOTE = 'promote',
+        DEMOTE = 'demote',
         SUBJECT = 'subject',
         DESCRIPTION = 'description',
         PICTURE = 'picture',
@@ -919,6 +923,7 @@ declare namespace WAWebJS {
         AUDIO = 'audio',
         VOICE = 'ptt',
         IMAGE = 'image',
+        ALBUM = 'album',
         VIDEO = 'video',
         DOCUMENT = 'document',
         STICKER = 'sticker',
@@ -1210,6 +1215,10 @@ declare namespace WAWebJS {
          * Once the event is canceled, it can not be edited.
          */
         editScheduledEvent: (editedEventObject: Event) => Promise<Message | null>,
+        /**
+         * Send votes to the poll message
+         */
+        vote: (selectedOptions: Array<string>) => Promise<void>,
     }
 
     /** ID that represents a message */
@@ -1273,7 +1282,7 @@ declare namespace WAWebJS {
         endTime?: Date,
         /** The location of the event */
         location?: string,
-        /** The type of a WhatsApp call link to generate, valid values are: `video` | `voice` */
+        /** The type of a WhatsApp call link to generate, valid values are: `video` | `voice` | `none` */
         callType?: string,
         /**
          * Indicates if a scheduled event should be sent as an already canceled
@@ -1300,7 +1309,7 @@ declare namespace WAWebJS {
             messageSecret?: string;
         };
 
-        constructor(name: string, startTime: Date, options?: EventSendOptions)
+        constructor(name: string, startTime: Date, options?: ScheduledEventSendOptions)
     }
 
     /** Represents a Poll Vote on WhatsApp */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@another-trial/whatsapp-web.js",
-  "version": "1.35.0-alpha.01",
+  "version": "1.35.0-alpha.2",
   "description": "Library for interacting with the WhatsApp Web API ",
   "main": "./index.js",
   "typings": "./index.d.ts",

package/src/Client.js

@@ -6,7 +6,7 @@ const moduleRaid = require('@pedroslopez/moduleraid/moduleraid');
 
 const Util = require('./util/Util');
 const InterfaceController = require('./util/InterfaceController');
-const { WhatsWebURL, DefaultOptions, Events, WAState } = require('./util/Constants');
+const { WhatsWebURL, DefaultOptions, Events, WAState, MessageTypes } = require('./util/Constants');
 const { ExposeAuthStore } = require('./util/Injected/AuthStore/AuthStore');
 const { ExposeStore } = require('./util/Injected/Store');
 const { ExposeLegacyAuthStore } = require('./util/Injected/AuthStore/LegacyAuthStore');
@@ -1531,7 +1531,7 @@ class Client extends EventEmitter {
         const commonGroups = await this.pupPage.evaluate(async (contactId) => {
             let contact = window.Store.Contact.get(contactId);
             if (!contact) {
-                const wid = window.Store.WidFactory.createUserWid(contactId);
+                const wid = window.Store.WidFactory.createWid(contactId);
                 const chatConstructor = window.Store.Contact.getModelsArray().find(c=>!c.isGroup).constructor;
                 contact = new chatConstructor({id: wid});
             }
@@ -2317,13 +2317,15 @@ class Client extends EventEmitter {
      * @param {string} firstName 
      * @param {string} lastName 
      * @param {boolean} [syncToAddressbook = false] If set to true, the contact will also be saved to the user's address book on their phone. False by default
-     * @returns {Promise<import('..').ChatId>} Object in a wid format
+     * @returns {Promise<void>}
      */
     async saveOrEditAddressbookContact(phoneNumber, firstName, lastName, syncToAddressbook = false)
     {
         return await this.pupPage.evaluate(async (phoneNumber, firstName, lastName, syncToAddressbook) => {
             return await window.Store.AddressbookContactUtils.saveContactAction(
                 phoneNumber,
+                phoneNumber,
+                null,
                 null,
                 firstName,
                 lastName,
@@ -2423,7 +2425,7 @@ class Client extends EventEmitter {
     async getPollVotes(messageId) {
         const msg = await this.getMessageById(messageId);
         if (!msg) return [];
-        if (msg.type != 'poll_creation') throw 'Invalid usage! Can only be used with a pollCreation message';
+        if (msg.type != MessageTypes.POLL_CREATION) throw 'Invalid usage! Can only be used with a pollCreation message';
 
         const pollVotes = await this.pupPage.evaluate( async (msg) => {
             const msgKey = window.Store.MsgKey.fromString(msg.id._serialized);

package/src/structures/GroupChat.js

@@ -297,12 +297,12 @@ class GroupChat extends Chat {
      */
     async setAddMembersAdminsOnly(adminsOnly=true) {
         const success = await this.client.pupPage.evaluate(async (groupId, adminsOnly) => {
-            const chatWid = window.Store.WidFactory.createWid(groupId);
+            const chat = await window.WWebJS.getChat(groupId, { getAsModel: false });
             try {
-                const response = await window.Store.GroupUtils.setGroupMemberAddMode(chatWid, 'member_add_mode', adminsOnly ? 0 : 1);
-                return response.name === 'SetMemberAddModeResponseSuccess';
+                await window.Store.GroupUtils.setGroupProperty(chat, 'member_add_mode', adminsOnly ? 0 : 1);
+                return true;
             } catch (err) {
-                if(err.name === 'SmaxParsingFailure') return false;
+                if(err.name === 'ServerStatusCodeError') return false;
                 throw err;
             }
         }, this.id._serialized, adminsOnly);
@@ -318,9 +318,9 @@ class GroupChat extends Chat {
      */
     async setMessagesAdminsOnly(adminsOnly=true) {
         const success = await this.client.pupPage.evaluate(async (chatId, adminsOnly) => {
-            const chatWid = window.Store.WidFactory.createWid(chatId);
+            const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
             try {
-                await window.Store.GroupUtils.setGroupProperty(chatWid, 'announcement', adminsOnly ? 1 : 0);
+                await window.Store.GroupUtils.setGroupProperty(chat, 'announcement', adminsOnly ? 1 : 0);
                 return true;
             } catch (err) {
                 if(err.name === 'ServerStatusCodeError') return false;
@@ -341,9 +341,9 @@ class GroupChat extends Chat {
      */
     async setInfoAdminsOnly(adminsOnly=true) {
         const success = await this.client.pupPage.evaluate(async (chatId, adminsOnly) => {
-            const chatWid = window.Store.WidFactory.createWid(chatId);
+            const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
             try {
-                await window.Store.GroupUtils.setGroupProperty(chatWid, 'restrict', adminsOnly ? 1 : 0);
+                await window.Store.GroupUtils.setGroupProperty(chat, 'restrict', adminsOnly ? 1 : 0);
                 return true;
             } catch (err) {
                 if(err.name === 'ServerStatusCodeError') return false;
@@ -356,7 +356,7 @@ class GroupChat extends Chat {
         this.groupMetadata.restrict = adminsOnly;
         return true;
     }
-
+    
     /**
      * Deletes the group's picture.
      * @returns {Promise<boolean>} Returns true if the picture was properly deleted. This can return false if the user does not have the necessary permissions.

package/src/structures/Message.js

@@ -562,7 +562,7 @@ class Message extends Base {
      */
     async unpin() {
         return await this.client.pupPage.evaluate(async (msgId) => {
-            return await window.WWebJS.pinUnpinMsgAction(msgId, 2);
+            return await window.WWebJS.pinUnpinMsgAction(msgId, 2, 0);
         }, this.id._serialized);
     }
 
@@ -749,6 +749,32 @@ class Message extends Base {
     async getPollVotes() {
         return await this.client.getPollVotes(this.id._serialized);
     }
+
+    /**
+     * Send votes to the poll message
+     * @param {Array<string>} selectedOptions Array of options selected.
+     * @returns {Promise}
+     */
+    async vote(selectedOptions) {
+        if (this.type != MessageTypes.POLL_CREATION) throw 'Invalid usage! Can only be used with a pollCreation message';
+
+        await this.client.pupPage.evaluate(async (messageId, votes) => {
+            if (!messageId) return null;
+            if (!Array.isArray(votes)) votes = [votes];
+            let localIdSet = new Set();
+            const msg =
+                window.Store.Msg.get(messageId) || (await window.Store.Msg.getMessagesById([messageId]))?.messages?.[0];
+            if (!msg) return null;
+
+            msg.pollOptions.forEach(a => {
+                for (const option of votes) {
+                    if (a.name === option) localIdSet.add(a.localId);
+                }
+            });
+
+            await window.Store.PollsSendVote.sendVote(msg, localIdSet);
+        }, this.id._serialized, selectedOptions);
+    }
 }
 
 module.exports = Message;

package/src/structures/ScheduledEvent.js

@@ -6,7 +6,7 @@
  * @property {?string} description The scheduled event description
  * @property {?Date} endTime The end time of the event
  * @property {?string} location The location of the event
- * @property {?string} callType The type of a WhatsApp call link to generate, valid values are: `video` | `voice`
+ * @property {?string} callType The type of a WhatsApp call link to generate, valid values are: `video` | `voice` | `none`
  * @property {boolean} [isEventCanceled = false] Indicates if a scheduled event should be sent as an already canceled
  * @property {?Array<number>} messageSecret The custom message secret, can be used as an event ID. NOTE: it has to be a unique vector with a length of 32
  */
@@ -58,10 +58,10 @@ class ScheduledEvent {
             }(`Empty '${propName}' parameter value is provided.`);
         }
 
-        if (propName === 'callType' && propValue && !['video', 'voice'].includes(propValue)) {
+        if (propName === 'callType' && propValue && !['video', 'voice', 'none'].includes(propValue)) {
             throw new class CreateScheduledEventError extends Error {
                 constructor(m) { super(m); }
-            }(`Invalid '${propName}' parameter value is provided. Valid values are: 'voice' | 'video'.`);
+            }(`Invalid '${propName}' parameter value is provided. Valid values are: 'voice' | 'video' | 'none'.`);
         }
         
         return propValue;

package/src/util/Constants.js

@@ -85,6 +85,7 @@ exports.MessageTypes = {
     AUDIO: 'audio',
     VOICE: 'ptt',
     IMAGE: 'image',
+    ALBUM: 'album',
     VIDEO: 'video',
     DOCUMENT: 'document',
     STICKER: 'sticker',
@@ -130,6 +131,8 @@ exports.GroupNotificationTypes = {
     INVITE: 'invite',
     REMOVE: 'remove',
     LEAVE: 'leave',
+    PROMOTE: 'promote',
+    DEMOTE: 'demote',
     SUBJECT: 'subject',
     DESCRIPTION: 'description',
     PICTURE: 'picture',

package/src/util/Injected/Store.js

@@ -62,9 +62,14 @@ exports.ExposeStore = () => {
     window.Store.SendDelete = window.require('WAWebDeleteChatAction');
     window.Store.SendMessage = window.require('WAWebSendMsgChatAction');
     window.Store.EditMessage = window.require('WAWebSendMessageEditAction');
+    window.Store.MediaDataUtils = window.require('WAWebMediaDataUtils');
+    window.Store.BlobCache = window.require('WAWebMediaInMemoryBlobCache');
     window.Store.SendSeen = window.require('WAWebUpdateUnreadChatAction');
     window.Store.User = window.require('WAWebUserPrefsMeUser');
-    window.Store.ContactMethods = window.require('WAWebContactGetters');
+    window.Store.ContactMethods = {
+        ...window.require('WAWebContactGetters'),
+        ...window.require('WAWebFrontendContactGetters')
+    };
     window.Store.UserConstructor = window.require('WAWebWid');
     window.Store.Validators = window.require('WALinkify');
     window.Store.WidFactory = window.require('WAWebWidFactory');
@@ -103,7 +108,8 @@ exports.ExposeStore = () => {
     window.Store.FindOrCreateChat = window.require('WAWebFindChatAction');
     window.Store.CustomerNoteUtils = window.require('WAWebNoteAction');
     window.Store.BusinessGatingUtils = window.require('WAWebBizGatingUtils');
-    window.Store.PollsVotesSchema = require('WAWebPollsVotesSchema');
+    window.Store.PollsVotesSchema = window.require('WAWebPollsVotesSchema');
+    window.Store.PollsSendVote = window.require('WAWebPollsSendVoteMsgAction');
     
     window.Store.Settings = {
         ...window.require('WAWebUserPrefsGeneral'),
@@ -139,7 +145,8 @@ exports.ExposeStore = () => {
         ...window.require('WAWebGroupCreateJob'),
         ...window.require('WAWebGroupModifyInfoJob'),
         ...window.require('WAWebExitGroupAction'),
-        ...window.require('WAWebContactProfilePicThumbBridge')
+        ...window.require('WAWebContactProfilePicThumbBridge'),
+        ...window.require('WAWebSetPropertyGroupAction')
     };
     window.Store.GroupParticipants = {
         ...window.require('WAWebModifyParticipantsGroupAction'),

package/src/util/Injected/Utils.js

@@ -6,7 +6,7 @@ exports.LoadUtils = () => {
     window.WWebJS.forwardMessage = async (chatId, msgId) => {
         const msg = window.Store.Msg.get(msgId) || (await window.Store.Msg.getMessagesById([msgId]))?.messages?.[0];
         const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
-        return window.Store.ForwardUtils.forwardMessages(chat, [msg], true, true);
+        return await window.Store.ForwardUtils.forwardMessages({'chat': chat, 'msgs' : [msg], 'multicast': true, 'includeCaption': true, 'appendedText' : undefined});
     };
 
     window.WWebJS.sendSeen = async (chatId) => {
@@ -92,15 +92,15 @@ exports.LoadUtils = () => {
             delete options.location;
         }
 
-        let _pollOptions = {};
+        let pollOptions = {};
         if (options.poll) {
-            const { pollName, pollOptions } = options.poll;
+            const { pollName, pollOptions: _pollOptions } = options.poll;
             const { allowMultipleAnswers, messageSecret } = options.poll.options;
-            _pollOptions = {
+            pollOptions = {
                 kind: 'pollCreation',
                 type: 'poll_creation',
                 pollName: pollName,
-                pollOptions: pollOptions,
+                pollOptions: _pollOptions,
                 pollSelectableOptionsCount: allowMultipleAnswers ? 0 : 1,
                 messageSecret:
                     Array.isArray(messageSecret) && messageSecret.length === 32
@@ -125,7 +125,7 @@ exports.LoadUtils = () => {
                     degreesLongitude: 0,
                     name: eventSendOptions.location
                 },
-                eventJoinLink: await window.Store.ScheduledEventMsgUtils.createEventCallLink(
+                eventJoinLink: eventSendOptions.callType === 'none' ? null : await window.Store.ScheduledEventMsgUtils.createEventCallLink(
                     startTimeTs,
                     eventSendOptions.callType
                 ),
@@ -264,7 +264,7 @@ exports.LoadUtils = () => {
             id: newMsgKey,
             ack: 0,
             body: content,
-            from: meUser,
+            from: from,
             to: chat.id,
             local: true,
             self: 'out',
@@ -276,7 +276,7 @@ exports.LoadUtils = () => {
             ...(mediaOptions.toJSON ? mediaOptions.toJSON() : {}),
             ...quotedMsgOptions,
             ...locationOptions,
-            ..._pollOptions,
+            ...pollOptions,
             ...eventOptions,
             ...vcardOptions,
             ...buttonOptions,
@@ -430,6 +430,10 @@ exports.LoadUtils = () => {
             isNewsletter: sendToChannel,
         });
 
+        if (!mediaData.filehash) {
+            throw new Error('media-fault: sendToChat filehash undefined');
+        }
+
         if (forceVoice && mediaData.type === 'ptt') {
             const waveform = mediaObject.contentInfo.waveform;
             mediaData.waveform =
@@ -445,7 +449,15 @@ exports.LoadUtils = () => {
 
         mediaData.renderableUrl = mediaData.mediaBlob.url();
         mediaObject.consolidate(mediaData.toJSON());
+        
         mediaData.mediaBlob.autorelease();
+        const shouldUseMediaCache = window.Store.MediaDataUtils.shouldUseMediaCache(
+            window.Store.MediaTypes.castToV4(mediaObject.type)
+        );
+        if (shouldUseMediaCache && mediaData.mediaBlob instanceof window.Store.OpaqueData) {
+            const formData = mediaData.mediaBlob.formData();
+            window.Store.BlobCache.InMemoryMediaBlobCache.put(mediaObject.filehash, formData);
+        }
 
         const dataToUpload = {
             mimetype: mediaData.mimetype,
@@ -825,22 +837,22 @@ exports.LoadUtils = () => {
     };
 
     window.WWebJS.rejectCall = async (peerJid, id) => {
-        peerJid = peerJid.split('@')[0] + '@s.whatsapp.net';
-        let userId = window.Store.User.getMaybeMePnUser().user + '@s.whatsapp.net';
+        let userId = window.Store.User.getMaybeMePnUser()._serialized;
+
         const stanza = window.Store.SocketWap.wap('call', {
             id: window.Store.SocketWap.generateId(),
-            from: window.Store.SocketWap.USER_JID(userId),
-            to: window.Store.SocketWap.USER_JID(peerJid),
+            from: userId,
+            to: peerJid,
         }, [
             window.Store.SocketWap.wap('reject', {
                 'call-id': id,
-                'call-creator': window.Store.SocketWap.USER_JID(peerJid),
+                'call-creator': peerJid,
                 count: '0',
             })
         ]);
         await window.Store.Socket.deprecatedCastStanza(stanza);
     };
-
+    
     window.WWebJS.cropAndResizeImage = async (media, options = {}) => {
         if (!media.mimetype.includes('image'))
             throw new Error('Media is not an image');

package/src/util/InterfaceController.js

@@ -14,9 +14,9 @@ class InterfaceController {
      * @param {string} chatId ID of the chat window that will be opened
      */
     async openChatWindow(chatId) {
-        await this.pupPage.evaluate(async (chatId) => {
+        return await this.pupPage.evaluate(async (chatId) => {
             const chat = await window.WWebJS.getChat(chatId, { getAsModel: false });
-            await window.Store.Cmd.openChatBottom(chat);
+            return await window.Store.Cmd.openChatBottom({'chat':chat});
         }, chatId);
     }