whatsapp-web.js 1.13.2 → 1.15.1

package/.env.example

@@ -0,0 +1,2 @@
+WWEBJS_TEST_SESSION_PATH=test_session.json
+WWEBJS_TEST_REMOTE_ID=XXXXXXXXXX@c.us

package/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.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)  
+[![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.2142.12](https://img.shields.io/badge/WhatsApp_Web-2.2142.12-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
@@ -11,12 +11,13 @@ It uses Puppeteer to run a real instance of Whatsapp Web to avoid getting blocke
 
 The module is now available on npm! `npm i whatsapp-web.js`
 
-Please note that Node v14+ is required.
+Please note that Node v12+ is required.
 
 ## Example usage
 
 ```js
 const { Client } = require('whatsapp-web.js');
+
 const client = new Client();
 
 client.on('qr', (qr) => {
@@ -39,6 +40,39 @@ client.initialize();
 
 Take a look at [example.js](https://github.com/pedroslopez/whatsapp-web.js/blob/master/example.js) for another example with more use cases.
 
+## Remote Access
+
+You could also connect to any previously existing browser instance:
+
+```js
+const client = new Client({ 
+    puppeteer: {
+        browserWSEndpoint: `ws://localhost:3000`
+    }
+});
+```
+
+### Docker
+
+1) Installing a browser using browserless:
+
+```
+docker run \
+  --rm \
+  -p 3000:3000 \
+  -e "MAX_CONCURRENT_SESSIONS=1" \
+  browserless/chrome:latest
+```
+
+Reference: https://docs.browserless.io/docs/docker-quickstart.html
+
+### Remote Debugging
+
+2) Running a browser with websocket remote debugging enabled:
+> chrome.exe --remote-debugging-port=9222
+
+After that check the following webpage and check http://127.0.0.1:9220/json and get the **webSocketDebuggerUrl**
+
 ## Supported features
 
 | Feature  | Status |
@@ -46,11 +80,13 @@ Take a look at [example.js](https://github.com/pedroslopez/whatsapp-web.js/blob/
 | Send messages  | ✅  |
 | Receive messages  | ✅  |
 | Send media (images/audio/documents)  | ✅  |
-| Send media (video)  | ✅ [(requires google chrome)](https://waguide.pedroslopez.me/features/handling-attachments#caveat-for-sending-videos-and-gifs)  |
+| Send media (video)  | ✅ [(requires google chrome)](https://guide.wwebjs.dev/features/handling-attachments#caveat-for-sending-videos-and-gifs)  |
 | Send stickers | ✅ |
 | Receive media (images/audio/video/documents)  | ✅  |
 | Send contact cards | ✅ |
 | Send location | ✅ |
+| Send buttons | ✅ |
+| Send lists | ✅ (business accounts not supported) |
 | Receive location | ✅ | 
 | Message replies | ✅ |
 | Join groups by invite  | ✅ |
@@ -71,9 +107,10 @@ Something missing? Make an issue and let us know!
 
 ## Links
 
-* [Reference](https://pedroslopez.me/whatsapp-web.js)
-* [Guide](https://waguide.pedroslopez.me/) _(work in progress)_
+* [Reference](https://docs.wwebjs.dev/)
+* [Guide](https://guide.wwebjs.dev/) _(work in progress)_
 * [GitHub](https://github.com/pedroslopez/whatsapp-web.js)
+* [npm](https://npmjs.org/package/whatsapp-web.js)
 
 ## Contributing
 

package/example.js

@@ -1,5 +1,5 @@
 const fs = require('fs');
-const { Client, Location } = require('./index');
+const { Client, Location, List, Buttons } = require('./index');
 
 const SESSION_FILE_PATH = './session.json';
 let sessionCfg;
@@ -11,6 +11,13 @@ const client = new Client({ puppeteer: { headless: false }, session: sessionCfg
 // You can use an existing session and avoid scanning a QR code by adding a "session" object to the client options.
 // This object must include WABrowserId, WASecretBundle, WAToken1 and WAToken2.
 
+// You also could connect to an existing instance of a browser
+// { 
+//    puppeteer: {
+//        browserWSEndpoint: `ws://localhost:3000`
+//    }
+// }
+
 client.initialize();
 
 client.on('qr', (qr) => {
@@ -197,6 +204,13 @@ client.on('message', async msg => {
             const quotedMsg = await msg.getQuotedMessage();
             client.interface.openChatWindowAt(quotedMsg.id._serialized);
         }
+    } else if (msg.body === '!buttons') {
+        let button = new Buttons('Button body',[{body:'bt1'},{body:'bt2'},{body:'bt3'}],'title','footer');
+        client.sendMessage(msg.from, button);
+    } else if (msg.body === '!list') {
+        let sections = [{title:'sectionTitle',rows:[{title:'ListItem1', description: 'desc'},{title:'ListItem2'}]}];
+        let list = new List('List body','btnText',sections,'Title','footer');
+        client.sendMessage(msg.from, list);
     }
 });
 

package/index.d.ts

@@ -1,5 +1,6 @@
 
 import { EventEmitter } from 'events'
+import { RequestInit } from 'node-fetch'
 import puppeteer = require('puppeteer')
 
 declare namespace WAWebJS {
@@ -47,6 +48,9 @@ declare namespace WAWebJS {
         /** Logs out the client, closing the current session */
         logout(): Promise<void>
 
+        /** Get all blocked contacts by host account */
+        getBlockedContacts(): Promise<Contact[]>
+
         /** Get chat instance by ID */
         getChatById(chatId: string): Promise<Chat>
 
@@ -58,6 +62,12 @@ declare namespace WAWebJS {
 
         /** Get all current contact instances */
         getContacts(): Promise<Contact[]>
+        
+        /** Get the country code of a WhatsApp ID. (154185968@c.us) => (1) */
+        getCountryCode(number: string): Promise<string>
+
+        /** Get the formatted number of a WhatsApp ID. (12345678901@c.us) => (+1 (234) 5678-901) */
+        getFormattedNumber(number: string): Promise<string>
 
         /** Get all current Labels  */
         getLabels(): Promise<Label[]>
@@ -90,11 +100,11 @@ declare namespace WAWebJS {
         getNumberId(number: string): Promise<ContactId | null>
 
         /**
-         * Mutes the Chat until a specified date
+         * Mutes this chat forever, unless a date is specified
          * @param chatId ID of the chat that will be muted
-         * @param unmuteDate Date when the chat will be unmuted
+         * @param unmuteDate Date when the chat will be unmuted, leave as is to mute forever
          */
-        muteChat(chatId: string, unmuteDate: Date): Promise<void>
+        muteChat(chatId: string, unmuteDate?: Date): Promise<void>
 
         /** Force reset of connection state for the client */
         resetState(): Promise<void>
@@ -227,6 +237,12 @@ declare namespace WAWebJS {
             qr: string
         ) => void): this
 
+        /** Emitted when a call is received */
+        on(event: 'call', listener: (
+            /** The call that started */
+            call: Call
+        ) => void): this
+
         /** Emitted when the client has initialized and is ready to receive messages */
         on(event: 'ready', listener: () => void): this
     }
@@ -271,13 +287,16 @@ declare namespace WAWebJS {
          * @default 45000 */
         authTimeoutMs?: number,
         /** Puppeteer launch options. View docs here: https://github.com/puppeteer/puppeteer/ */
-        puppeteer?: puppeteer.LaunchOptions
+        puppeteer?: puppeteer.LaunchOptions & puppeteer.BrowserLaunchArgumentOptions & puppeteer.BrowserConnectOptions
         /** Refresh interval for qr code (how much time to wait before checking if the qr code has changed)
          * @default 20000 */
         qrRefreshIntervalMs?: number
         /** Timeout for qr code selector in puppeteer
          * @default 45000 */
         qrTimeoutMs?: number,
+		/** How many times should the qrcode be refreshed before giving up
+		 * @default 0 (disabled) */
+		qrMaxRetries?: number,
         /** Restart client with a new session (i.e. use null 'session' var) if authentication fails
          * @default false */
         restartOnAuthFail?: boolean
@@ -349,7 +368,7 @@ declare namespace WAWebJS {
         reply: (content: MessageContent, options?: MessageSendOptions) => Promise<Message>,
 
     }
-
+    
     /** whatsapp web url */
     export const WhatsWebURL: string
 
@@ -421,6 +440,7 @@ declare namespace WAWebJS {
         REVOKED = 'revoked',
         ORDER = 'order',
         PRODUCT = 'product',
+        PAYMENT = 'payment',
         UNKNOWN = 'unknown',
         GROUP_INVITE = 'groups_v4_invite',
     }
@@ -517,6 +537,11 @@ declare namespace WAWebJS {
         id: MessageId,
         /** Indicates if the message was forwarded */
         isForwarded: boolean,
+        /**
+         * Indicates how many times the message was forwarded.
+         * The maximum value is 127.
+         */
+        forwardingScore: number,
         /** Indicates if the message was starred */
         isStarred: boolean,
         /** Location information contained in the message, if the message is type "location" */
@@ -540,7 +565,10 @@ declare namespace WAWebJS {
         /** Message type */
         type: MessageTypes,
         /** Links included in the message. */
-        links: string[],
+        links: Array<{
+            link: string,
+            isSuspicious: boolean
+        }>,
         /** Order ID */
         orderId: string,
         /** title */
@@ -551,6 +579,12 @@ declare namespace WAWebJS {
         businessOwnerJid?: string,
         /** Product JID */
         productId?: string,
+        /** Message buttons */
+        dynamicReplyButtons?: object,
+        /** Selected button ID */
+        selectedButtonId?: string,
+        /** Selected list row ID */
+        selectedRowId?: string,
         /** Accept the Group V4 Invite in message */
         acceptGroupV4Invite: () => Promise<{status: number}>,
         /** Deletes the message from the chat */
@@ -585,6 +619,10 @@ declare namespace WAWebJS {
          * Gets the order associated with a given message
          */
         getOrder: () => Order,
+        /**
+         * Gets the payment details associated with a given message
+         */
+        getPayment: () => Payment,
     }
 
     /** ID that represents a message */
@@ -595,10 +633,13 @@ declare namespace WAWebJS {
         _serialized: string,
     }
 
-    export interface Location {
-        description?: string | null,
-        latitude: string,
-        longitude: string,
+    /** Location information */
+    export class Location {
+        description?: string | null
+        latitude: string
+        longitude: string
+        
+        constructor(latitude: number, longitude: number, description?: string)
     }
 
     export interface Label {
@@ -647,6 +688,12 @@ declare namespace WAWebJS {
         stickerCategories?: string[]
     }
 
+    export interface MediaFromURLOptions {
+        client?: Client
+        unsafeMime?: boolean
+        reqOptions?: RequestInit
+    }
+
     /** Media attached to a message */
     export class MessageMedia {
         /** MIME type of the attachment */
@@ -665,9 +712,12 @@ declare namespace WAWebJS {
 
         /** Creates a MessageMedia instance from a local file path */
         static fromFilePath: (filePath: string) => MessageMedia
+
+        /** Creates a MessageMedia instance from a URL */
+        static fromUrl: (url: string, options?: MediaFromURLOptions) => Promise<MessageMedia>
     }
 
-    export type MessageContent = string | MessageMedia | Location | Contact | Contact[]
+    export type MessageContent = string | MessageMedia | Location | Contact | Contact[] | List | Buttons
 
     /**
      * Represents a Contact on WhatsApp
@@ -745,9 +795,16 @@ declare namespace WAWebJS {
          * Will return null when getting chat for currently logged in user.
          */
         getChat: () => Promise<Chat>,
-
+        
+        /** Returns the contact's countrycode, (1541859685@c.us) => (1) */
+        getCountryCode(): Promise<string>,
+        
+        /** Returns the contact's formatted phone number, (12345678901@c.us) => (+1 (234) 5678-901) */
+        getFormattedNumber(): Promise<string>,
+        
         /** Blocks this contact from WhatsApp */
         block: () => Promise<boolean>,
+
         /** Unlocks this contact from WhatsApp */
         unblock: () => Promise<boolean>,
 
@@ -826,8 +883,8 @@ declare namespace WAWebJS {
         delete: () => Promise<boolean>,
         /** Loads chat messages, sorted from earliest to latest. */
         fetchMessages: (searchOptions: MessageSearchOptions) => Promise<Message[]>,
-        /** Mutes this chat until a specified date */
-        mute: (unmuteDate: Date) => Promise<void>,
+        /** Mutes this chat forever, unless a date is specified */
+        mute: (unmuteDate?: Date) => Promise<void>,
         /** Send a message to this chat */
         sendMessage: (content: MessageContent, options?: MessageSendOptions) => Promise<Message>,
         /** Set the message as seen */
@@ -1033,6 +1090,111 @@ declare namespace WAWebJS {
         /** Order Created At*/
         createdAt: number;
     }
+
+    /**
+     * Represents a Payment on WhatsApp
+     *
+     * @example
+     * {
+     * id: {
+     * fromMe: true,
+     * remote: {
+     * server: 'c.us',
+     * user: '5511999999999',
+     * _serialized: '5511999999999@c.us'
+     * },
+     *  id: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+     * _serialized: 'true_5511999999999@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA'
+     * },
+     * paymentCurrency: 'BRL',
+     * paymentAmount1000: 1000,
+     * paymentMessageReceiverJid: {
+     * server: 'c.us',
+     * user: '5511999999999',
+     * _serialized: '5511999999999@c.us'
+     * },
+     * paymentTransactionTimestamp: 1623463058,
+     * paymentStatus: 4,
+     * paymentTxnStatus: 4,
+     * paymentNote: 'note'
+     * }
+     */
+    export interface Payment {
+        /** Payment Id*/
+        id: object,
+        /** Payment currency */
+        paymentCurrency: string,
+        /** Payment ammount  */
+        paymentAmount1000 : number,
+        /** Payment receiver */
+        paymentMessageReceiverJid : object,
+        /** Payment transaction timestamp */
+        paymentTransactionTimestamp : number,
+        /** Payment paymentStatus */
+        paymentStatus : number,
+        /** Integer that represents the payment Text */
+        paymentTxnStatus  : number,
+        /** The note sent with the payment */
+        paymentNote  : string;
+    }
+    
+    /**
+     * Represents a Call on WhatsApp
+     *
+     * @example
+     * Call {
+     * id: 'AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA',
+     * from: '5511999999@c.us',
+     * timestamp: 1625003709,
+     * isVideo: false,
+     * isGroup: false,
+     * fromMe: false,
+     * canHandleLocally: false,
+     * webClientShouldHandle: false,
+     * participants: []
+     * }
+     */
+    export interface Call {
+        /** Call Id */
+        id: string,
+        /** from */
+        from?: string,
+        /** Unix timestamp for when the call was created*/
+        timestamp: number,
+        /** Is video */
+        isVideo: boolean,
+        /** Is Group */
+        isGroup: boolean,
+        /** Indicates if the call was sent by the current user */
+        fromMe: boolean,
+        /** indicates if the call can be handled in waweb */
+        canHandleLocally: boolean,
+        /** indicates if the call should be handled in waweb */
+        webClientShouldHandle: boolean,
+        /** Object with participants */
+        participants: object
+    }
+
+    /** Message type List */
+    export class List {
+        body: string
+        buttonText: string
+        sections: Array<any>
+        title?: string | null
+        footer?: string | null
+        
+        constructor(body: string, buttonText: string, sections: Array<any>, title?: string | null, footer?: string | null)
+    }
+    
+    /** Message type buttons */
+    export class Buttons {
+        body: string | MessageMedia
+        buttons: Array<Array<string>>
+        title?: string | null
+        footer?: string | null
+        
+        constructor(body: string, buttons: Array<Array<string>>, title?: string | null, footer?: string | null)
+    }
 }
 
 export = WAWebJS

package/index.js

@@ -19,5 +19,7 @@ module.exports = {
     ClientInfo: require('./src/structures/ClientInfo'),
     Location: require('./src/structures/Location'),
     ProductMetadata: require('./src/structures/ProductMetadata'),
+    List: require('./src/structures/List'),
+    Buttons: require('./src/structures/Buttons'),
     ...Constants
 };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "whatsapp-web.js",
-  "version": "1.13.2",
+  "version": "1.15.1",
   "description": "Library for interacting with the WhatsApp Web API ",
   "main": "./index.js",
   "typings": "./index.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "mocha tests",
     "shell": "node --experimental-repl-await ./shell.js",
     "generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
   },
@@ -26,19 +26,28 @@
   "bugs": {
     "url": "https://github.com/pedroslopez/whatsapp-web.js/issues"
   },
-  "homepage": "https://waguide.pedroslopez.me/",
+  "homepage": "https://guide.wwebjs.dev/",
   "dependencies": {
-    "@pedroslopez/moduleraid": "^5.0.1",
+    "@pedroslopez/moduleraid": "^5.0.2",
     "fluent-ffmpeg": "^2.1.2",
     "jsqr": "^1.3.1",
     "mime": "^2.4.5",
-    "node-webpmux": "^2.0.0",
-    "puppeteer": "^5.2.1",
-    "sharp": "^0.26.3"
+    "node-webpmux": "^3.1.0",
+    "puppeteer": "^10.1.0",
+    "sharp": "^0.28.3"
   },
   "devDependencies": {
+    "@types/node-fetch": "^2.5.11",
+    "chai": "^4.3.4",
+    "dotenv": "^10.0.0",
     "eslint": "^7.27.0",
+    "eslint-plugin-mocha": "^9.0.0",
     "jsdoc": "^3.6.4",
-    "jsdoc-baseline": "^0.1.5"
+    "jsdoc-baseline": "^0.1.5",
+    "mocha": "^9.0.2",
+    "sinon": "^11.1.1"
+  },
+  "engines": {
+    "node": ">=12.0.0"
   }
 }