Merge branch 'master' of https://github.com/wppconnect-team/wppconnect

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/lint.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/nightly.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: Get npm cache directory
         id: npm-cache

.github/workflows/publish.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 18.x
           registry-url: 'https://registry.npmjs.org'
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/release.yml

@@ -25,7 +25,7 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4.0.2
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: Get npm cache directory
         id: npm-cache

package.json

@@ -64,7 +64,7 @@
     "@types/atob": "^2.1.4",
     "@types/mime-types": "^2.1.4",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^18.19.21",
+    "@types/node": "^18.19.22",
     "@types/rimraf": "^3.0.2",
     "@types/sharp": "^0.31.1",
     "@types/shelljs": "^0.8.15",
@@ -89,13 +89,13 @@
     "shx": "^0.3.4",
     "ts-node": "^10.9.2",
     "typedoc": "^0.25.10",
-    "typescript": "^5.3.3",
+    "typescript": "^5.4.2",
     "webpack": "^5.90.3",
     "webpack-cli": "^5.1.4"
   },
   "dependencies": {
     "@wppconnect/wa-js": "^2.28.1",
-    "@wppconnect/wa-version": "^1.2.263",
+    "@wppconnect/wa-version": "^1.2.267",
     "atob": "^2.1.2",
     "axios": "^1.6.7",
     "boxen": "^5.1.2",
@@ -125,6 +125,7 @@
     "ws": "^8.16.0"
   },
   "optionalDependencies": {
+    "@img/sharp-win32-x64": "^0.33.2",
     "fsevents": "^2.3.3"
   },
   "directories": {

src/api/layers/group.layer.ts

@@ -148,14 +148,12 @@ export class GroupLayer extends RetrieverLayer {
     groupId: string,
     participantId: string | string[]
   ) {
-    await evaluateAndReturn(
+    return await evaluateAndReturn(
       this.page,
       ({ groupId, participantId }) =>
         WPP.group.removeParticipants(groupId, participantId),
       { groupId, participantId }
     );
-
-    return true;
   }
 
   /**

src/api/layers/host.layer.ts

@@ -31,6 +31,7 @@ import { evaluateAndReturn, scrapeImg } from '../helpers';
 import {
   CatchQRCallback,
   HostDevice,
+  LinkByCodeCallback,
   LoadingScreenCallback,
   StatusFindCallback,
 } from '../model';
@@ -57,6 +58,7 @@ export class HostLayer {
   public catchQR?: CatchQRCallback = null;
   public statusFind?: StatusFindCallback = null;
   public onLoadingScreen?: LoadingScreenCallback = null;
+  public catchLinkCode?: LinkByCodeCallback = null;
 
   constructor(public page: Page, session?: string, options?: CreateConfig) {
     this.session = session;
@@ -143,8 +145,8 @@ export class HostLayer {
     evaluateAndReturn(this.page, () => {
       WPP.on('conn.main_ready', (window as any).checkInChat);
     }).catch(() => null);
-    this.checkQrCode();
     this.checkInChat();
+    this.checkQrCode();
   }
 
   public async start() {
@@ -163,6 +165,9 @@ export class HostLayer {
     );
 
     await this.page.exposeFunction('checkQrCode', () => this.checkQrCode());
+    await this.page.exposeFunction('loginByCode', (phone: string) =>
+      this.loginByCode(phone)
+    );
     await this.page.exposeFunction('checkInChat', () => this.checkInChat());
 
     this.checkStartInterval = setInterval(() => this.checkStart(), 5000);
@@ -188,9 +193,13 @@ export class HostLayer {
     }
 
     const result = await this.getQrCode();
+
     if (!result?.urlCode || this.urlCode === result.urlCode) {
       return;
     }
+    if (typeof this.options.phoneNumber !== undefined) {
+      return this.loginByCode(this.options.phoneNumber);
+    }
     this.urlCode = result.urlCode;
     this.attempt++;
 
@@ -213,6 +222,24 @@ export class HostLayer {
     this.catchQR?.(result.base64Image, qr, this.attempt, result.urlCode);
   }
 
+  protected async loginByCode(phone: string) {
+    const code = await evaluateAndReturn(
+      this.page,
+      async ({ phone }) => {
+        return JSON.parse(
+          JSON.stringify(await WPP.conn.genLinkDeviceCodeForPhoneNumber(phone))
+        );
+      },
+      { phone }
+    );
+    if (this.options.logQR) {
+      this.log('info', `Waiting for Login By Code (Code: ${code})\n`);
+    } else {
+      this.log('verbose', `Waiting for Login By Code`);
+    }
+    this.catchLinkCode?.(code);
+  }
+
   protected async checkInChat() {
     const inChat = await isInsideChat(this.page).catch(() => null);
 
@@ -339,11 +366,21 @@ export class HostLayer {
     this.startAutoClose();
 
     if (authenticated === false) {
-      this.log('http', 'Waiting for QRCode Scan...');
+      this.log(
+        'http',
+        typeof this.options.phoneNumber !== undefined
+          ? 'Waiting for Login by Code...'
+          : 'Waiting for QRCode Scan...'
+      );
       this.statusFind?.('notLogged', this.session);
       await this.waitForQrCodeScan();
 
-      this.log('http', 'Checking QRCode status...');
+      this.log(
+        'http',
+        typeof this.options.phoneNumber !== undefined
+          ? 'Checking Login by Code status...'
+          : 'Checking QRCode status...'
+      );
       // Wait for interface update
       await sleep(200);
       authenticated = await isAuthenticated(this.page).catch(() => null);
@@ -352,10 +389,10 @@ export class HostLayer {
         this.log('warn', 'Failed to authenticate');
         this.statusFind?.('qrReadError', this.session);
       } else if (authenticated) {
-        this.log('http', 'QRCode Success');
+        this.log('http', 'Login with success');
         this.statusFind?.('qrReadSuccess', this.session);
       } else {
-        this.log('warn', 'QRCode Fail');
+        this.log('warn', 'Login Fail');
         this.statusFind?.('qrReadFail', this.session);
         this.tryAutoClose();
         throw 'Failed to read the QRCode';

src/api/layers/status.layer.ts

@@ -24,6 +24,7 @@ import {
   fileToBase64,
   downloadFileToBase64,
 } from '../helpers';
+import { SendStatusOptions } from '@wppconnect/wa-js/dist/status';
 
 export class StatusLayer extends LabelsLayer {
   constructor(public page: Page, session?: string, options?: CreateConfig) {
@@ -37,9 +38,18 @@ export class StatusLayer extends LabelsLayer {
    * ```javascript
    * client.sendImageStatus('data:image/jpeg;base64,<a long base64 file...>');
    * ```
+   *
+   * @example
+   * ```javascript
+   * // Send with caption
+   * client.sendImageStatus('data:image/jpeg;base64,<a long base64 file...>', { caption: 'example test' } );
+   * ```
    * @param pathOrBase64 Path or base 64 image
    */
-  public async sendImageStatus(pathOrBase64: string) {
+  public async sendImageStatus(
+    pathOrBase64: string,
+    options?: SendStatusOptions & { caption?: string }
+  ) {
     let base64: string = '';
     if (pathOrBase64.startsWith('data:')) {
       base64 = pathOrBase64;
@@ -81,7 +91,7 @@ export class StatusLayer extends LabelsLayer {
     return await evaluateAndReturn(
       this.page,
       ({ base64 }) => {
-        WPP.status.sendImageStatus(base64);
+        WPP.status.sendImageStatus(base64, options);
       },
       { base64 }
     );
@@ -94,9 +104,17 @@ export class StatusLayer extends LabelsLayer {
    * ```javascript
    * client.sendVideoStatus('data:video/mp4;base64,<a long base64 file...>');
    * ```
+   * @example
+   * ```javascript
+   * // Send with caption
+   * client.sendVideoStatus('data:video/mp4;base64,<a long base64 file...>', { caption: 'example test' } );
+   * ```
    * @param pathOrBase64 Path or base 64 image
    */
-  public async sendVideoStatus(pathOrBase64: string) {
+  public async sendVideoStatus(
+    pathOrBase64: string,
+    options?: SendStatusOptions & { caption?: string }
+  ) {
     let base64: string = '';
     if (pathOrBase64.startsWith('data:')) {
       base64 = pathOrBase64;
@@ -121,7 +139,7 @@ export class StatusLayer extends LabelsLayer {
     return await evaluateAndReturn(
       this.page,
       ({ base64 }) => {
-        WPP.status.sendVideoStatus(base64);
+        WPP.status.sendVideoStatus(base64, options);
       },
       { base64 }
     );

src/api/model/initializer.ts

@@ -41,6 +41,11 @@ export type StatusFindCallback = (
  */
 export type LoadingScreenCallback = (percent: number, message: string) => void;
 
+/**
+ * A callback will be received, informing a code to you connect
+ */
+export type LinkByCodeCallback = (code: string) => void;
+
 export interface CreateOptions extends CreateConfig {
   /**
    * You must pass a string type parameter, this parameter will be the name of the client's session. If the parameter is not passed, the section name will be "session".
@@ -50,6 +55,12 @@ export interface CreateOptions extends CreateConfig {
    * A callback will be received, informing the status of the qrcode
    */
   catchQR?: CatchQRCallback;
+
+  /**
+   * A callback will be received, informing a code to you connect
+   */
+  catchLinkCode?: LinkByCodeCallback;
+
   /**
    * A callback will be received, informing the customer's status
    */

src/config/create-config.ts

@@ -25,7 +25,7 @@ export interface CreateConfig {
    * Headless chrome
    * @default true
    */
-  headless?: boolean;
+  headless?: boolean | 'shell';
   /**
    * Open devtools by default
    * @default false
@@ -168,6 +168,11 @@ export interface CreateConfig {
    * @default 'WPPConnect'
    */
   poweredBy?: string;
+
+  /**
+   * Insert the phone number for connect by link phone, qr code not wil generate
+   */
+  phoneNumber?: string;
 }
 
 export const defaultOptions: CreateConfig = {