@wppconnect/wa-js 1.0.16 → 1.1.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wppconnect/wa-js",
-  "version": "1.0.16",
+  "version": "1.1.3",
   "description": "WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web",
   "types": "dist/index.d.ts",
   "exports": {
@@ -35,33 +35,33 @@
     "watch": "webpack watch --devtool inline-source-map --mode development"
   },
   "devDependencies": {
-    "@commitlint/cli": "^15.0.0",
-    "@commitlint/config-conventional": "^15.0.0",
-    "@commitlint/cz-commitlint": "^15.0.0",
+    "@commitlint/cli": "^16.0.1",
+    "@commitlint/config-conventional": "^16.0.0",
+    "@commitlint/cz-commitlint": "^16.0.0",
     "@types/data-urls": "^2.0.1",
     "@types/debug": "^4.1.7",
-    "@types/node": "^14.18.0",
-    "@types/shelljs": "^0.8.9",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
-    "@wppconnect/wa-version": "^1.1.24",
+    "@types/node": "^14.18.5",
+    "@types/shelljs": "^0.8.10",
+    "@typescript-eslint/eslint-plugin": "^5.9.0",
+    "@typescript-eslint/parser": "^5.9.0",
+    "@wppconnect/wa-version": "^1.1.26",
     "buffer": "^6.0.3",
     "commitizen": "^4.2.4",
-    "conventional-changelog-cli": "^2.1.1",
+    "conventional-changelog-cli": "^2.2.2",
     "data-urls": "^3.0.1",
     "debug": "^4.3.3",
     "emittery": "^0.10.0",
-    "eslint": "^8.4.1",
+    "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-header": "^3.1.1",
-    "eslint-plugin-import": "^2.25.3",
+    "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-simple-import-sort": "^7.0.0",
     "file-type": "~16.5.3",
     "husky": "^7.0.4",
     "playwright-chromium": "^1.17.1",
     "prettier": "^2.5.1",
-    "pretty-quick": "^3.1.2",
+    "pretty-quick": "^3.1.3",
     "release-it": "^14.11.8",
     "shx": "^0.3.3",
     "ts-loader": "^9.2.6",
@@ -70,7 +70,7 @@
     "typedoc": "^0.22.4",
     "typedoc-plugin-mdn-links": "^1.0.4",
     "typedoc-plugin-missing-exports": "^0.22.6",
-    "typescript": "^4.5.2",
+    "typescript": "^4.5.4",
     "webpack": "^5.65.0",
     "webpack-cli": "^4.9.1"
   },

package/dist/chat/Chat.d.ts

@@ -1,225 +0,0 @@
-/*!
- * Copyright 2021 WPPConnect Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import Emittery from 'emittery';
-import { ChatModel, MsgKey, MsgModel, Wid } from '../whatsapp';
-import { AudioMessageOptions, DeleteMessageReturn, DocumentMessageOptions, ImageMessageOptions, SendMessageReturn, VCardContact, VideoMessageOptions } from '.';
-import { ChatEventTypes, GetMessagesOptions, ListMessageOptions, MessageButtonsOptions, RawMessage, SendMessageOptions, TextMessageOptions } from './types';
-export declare class Chat extends Emittery<ChatEventTypes> {
-    defaultSendMessageOptions: SendMessageOptions;
-    constructor();
-    initialize(): Promise<void>;
-    protected registerRevokeMessageEvent(): void;
-    protected registerAckMessageEvent(): void;
-    protected registerEvents(): void;
-    find(chatId: string | Wid): Promise<ChatModel>;
-    get(chatId: string | Wid): ChatModel | undefined;
-    delete(chatId: string | Wid): Promise<{
-        wid: Wid;
-        status: number;
-    }>;
-    clear(chatId: string | Wid, keepStarred?: boolean): Promise<{
-        wid: Wid;
-        status: number;
-        keepStarred: boolean;
-    }>;
-    /**
-     * Mark a chat as read and send SEEN event
-     *
-     * @example
-     * ```javascript
-     * // Some messages
-     * WPP.chat.markIsRead('<number>@c.us');
-     * ```
-     */
-    markIsRead(chatId: string | Wid): Promise<{
-        wid: Wid;
-        unreadCount: number;
-    }>;
-    /**
-     * Mark a chat as unread
-     *
-     * @example
-     * ```javascript
-     * // Some messages
-     * WPP.chat.markIsUnread('<number>@c.us');
-     * ```
-     */
-    markIsUnread(chatId: string | Wid): Promise<{
-        wid: Wid;
-    }>;
-    /**
-     * Mark a chat to composing state
-     * and keep sending "is writting a message"
-     *
-     * @example
-     * ```javascript
-     * // Mark is composing
-     * WPP.chat.markIsComposing('<number>@c.us');
-     *
-     * // Mark is composing for 5 seconds
-     * WPP.chat.markIsComposing('<number>@c.us', 5000);
-     * ```
-     */
-    markIsComposing(chatId: string | Wid, duration?: number): Promise<void>;
-    /**
-     * Mark a chat to recording state
-     * and keep sending "is recording"
-     *
-     * @example
-     * ```javascript
-     * // Mark is recording
-     * WPP.chat.markIsRecording('<number>@c.us');
-     *
-     * // Mark is recording for 5 seconds
-     * WPP.chat.markIsRecording('<number>@c.us', 5000);
-     * ```
-     */
-    markIsRecording(chatId: string | Wid, duration?: number): Promise<void>;
-    /**
-     * Mark a chat is paused state
-     *
-     * @example
-     * ```javascript
-     * // Mark as recording
-     * WPP.chat.markIsPaused('<number>@c.us');
-     * ```
-     */
-    markIsPaused(chatId: string | Wid): Promise<void>;
-    /**
-     * Fetch messages from a chat
-     *
-     * @example
-     * ```javascript
-     * // Some messages
-     * WPP.chat.getMessages('<number>@c.us', {
-     *   count: 20,
-     * });
-     *
-     * // All messages
-     * WPP.chat.getMessages('<number>@c.us', {
-     *   count: -1,
-     * });
-     *
-     * // 20 messages before specific message
-     * WPP.chat.getMessages('<number>@c.us', {
-     *   count: 20,
-     *   direction: 'before',
-     *   id: '<full message id>'
-     * });
-     * ```
-     *
-     * @return  {RawMessage[]} List of raw messages
-     */
-    getMessages(chatId: string | Wid, options?: GetMessagesOptions): Promise<RawMessage[]>;
-    getMessageById(chatId: string | Wid, id: string): Promise<MsgModel>;
-    getMessageById(chatId: string | Wid, ids: string[]): Promise<MsgModel[]>;
-    deleteMessage(chatId: string | Wid, id: string, deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn>;
-    deleteMessage(chatId: string | Wid, ids: string[], deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn[]>;
-    generateMessageID(chat: string | ChatModel | Wid): MsgKey;
-    prepareMessageButtons<T extends RawMessage>(message: T, options: MessageButtonsOptions): T;
-    prepareRawMessage<T extends RawMessage>(chat: ChatModel, message: T, options?: SendMessageOptions): Promise<T>;
-    sendRawMessage(chatId: any, rawMessage: RawMessage, options?: SendMessageOptions): Promise<SendMessageReturn>;
-    sendTextMessage(chatId: any, content: any, options?: TextMessageOptions): Promise<SendMessageReturn>;
-    /**
-     * Send a list message
-     *
-     * @example
-     * ```javascript
-     * WPP.chat.sendListMessage('<number>@c.us', {
-     *   buttonText: 'Click Me!',
-     *   description: "Hello it's list message",
-     *   sections: [{
-     *     title: 'Section 1',
-     *     rows: [{
-     *       rowId: 'rowid1',
-     *       title: 'Row 1',
-     *       description: "Hello it's description 1",
-     *     },{
-     *       rowId: 'rowid2',
-     *       title: 'Row 2',
-     *       description: "Hello it's description 2",
-     *     }]
-     *   }]
-     * });
-     * ```
-     */
-    sendListMessage(chatId: any, options: ListMessageOptions): Promise<SendMessageReturn>;
-    protected convertToFile(data: string, mimetype?: string, filename?: string): Promise<File>;
-    /**
-     * Send a file message, that can be an audio, document, image or video
-     *
-     * @example
-     * ```javascript
-     * // Single document
-     * WPP.chat.sendFileMessage(
-     *  '<number>@c.us', {
-     *  'data:image/jpeg;base64,<a long base64 file...>',
-     *  {
-     *    type: 'document',
-     *    caption: 'My document', // Optional
-     *    filename: 'myfile.doc', // Optional
-     *    mimetype: 'application/msword' // Optional
-     *  }
-     * });
-     *
-     * // Image with view once
-     * WPP.chat.sendFileMessage(
-     *  '<number>@c.us', {
-     *  'data:image/jpeg;base64,<a long base64 file...>',
-     *  {
-     *    type: 'image',
-     *    caption: 'My image', // Optional
-     *    isViewOnce: true
-     *  }
-     * });
-     *
-     * // PTT audio
-     * WPP.chat.sendFileMessage(
-     *  '<number>@c.us', {
-     *  'data:audio/mp3;base64,<a long base64 file...>',
-     *  {
-     *    type: 'audio',
-     *    isPtt: true // false for common audio
-     *  }
-     * });
-     *
-     * // Image with view buttons
-     * WPP.chat.sendFileMessage(
-     *  '<number>@c.us', {
-     *  'data:image/jpeg;base64,<a long base64 file...>',
-     *  {
-     *    type: 'image',
-     *    caption: 'My image'
-     *    buttons: [
-     *      {
-     *        id: 'your custom id 1',
-     *        text: 'Some text'
-     *      },
-     *      {
-     *        id: 'another id 2',
-     *        text: 'Another text'
-     *      }
-     *    ],
-     *    footer: 'Footer text' // Optional
-     *  }
-     * });
-     * ```
-     *
-     * @return  {SendMessageReturn} The result
-     */
-    sendFileMessage(chatId: any, content: any, options: AudioMessageOptions | DocumentMessageOptions | ImageMessageOptions | VideoMessageOptions): Promise<SendMessageReturn>;
-    sendVCardContactMessage(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;
-}

package/dist/group/Group.d.ts

@@ -1,45 +0,0 @@
-/*!
- * Copyright 2021 WPPConnect Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import Emittery from 'emittery';
-import { Wid } from '../whatsapp';
-import { ChatEventTypes as GroupEventTypes } from './types';
-export declare class Group extends Emittery<GroupEventTypes> {
-    constructor();
-    initialize(): Promise<void>;
-    private ensureGroup;
-    iAmAdmin(groupId: string | Wid): boolean;
-    iAmMember(groupId: string | Wid): boolean;
-    iAmRestrictedMember(groupId: string | Wid): boolean;
-    iAmSuperAdmin(groupId: string | Wid): boolean;
-    private ensureGroupAndParticipants;
-    canAdd(groupId: string | Wid): boolean;
-    canDemote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): boolean;
-    canPromote(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): boolean;
-    canRemove(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): boolean;
-    addParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;
-    removeParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;
-    promoteParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;
-    demoteParticipants(groupId: string | Wid, participantsIds: (string | Wid) | (string | Wid)[]): Promise<void>;
-    create(groupName: string, participantsIds: (string | Wid) | (string | Wid)[]): Promise<{
-        gid: Wid;
-        participants: {
-            [key: string]: {
-                code: string;
-            };
-        }[];
-        status: number;
-    }>;
-}

package/dist/labels/Labels.d.ts

@@ -1,52 +0,0 @@
-/*!
- * Copyright 2021 WPPConnect Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import { newLabelOptions } from './types';
-export declare class Labels {
-    constructor();
-    initialize(): Promise<void>;
-    /**
-     * Add a new label
-     * Use await WPP.labels.getLabelColorPalette() to get the list of available colors
-     * @example
-     * ```javascript
-     * await WPP.labels.addNewLabel(`Name of label`);
-     * //or
-     * await WPP.labels.addNewLabel(`Name of label`, { labelColor: 'dfaef0' });
-     * //or
-     * await WPP.labels.addNewLabel(`Name of label`, { labelColor: 4292849392 });
-     * ```
-     */
-    addNewLabel(labelName: string, options?: newLabelOptions): Promise<void>;
-    /**
-     * Return the color of the next label in positive decimal
-     */
-    getNewLabelColor(): Promise<number>;
-    /**
-     * Returns an array of color palette in positive decimal
-     */
-    getLabelColorPalette(): Promise<Array<number>>;
-    /**
-     * Check if color is in label palette
-     * @param color If it's decimal, send it as a number. If it's hexadecimal, send it as a string
-     * @example
-     * ```javascript
-     * await WPP.labels.colorIsInLabelPalette('ffd429');
-     * //or
-     * await WPP.labels.colorIsInLabelPalette(4284794111);
-     * ```
-     */
-    colorIsInLabelPalette(color: string | number): Promise<boolean>;
-}

package/dist/status/Status.d.ts

@@ -1,37 +0,0 @@
-/*!
- * Copyright 2021 WPPConnect Team
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-import Emittery from 'emittery';
-import { RawMessage } from '../chat';
-import { StatusV3Model, Wid } from '../whatsapp';
-import { SendStatusOptions, TextStatusOptions } from '.';
-import { StatusEventTypes } from './types';
-export declare class Status extends Emittery<StatusEventTypes> {
-    defaultSendMessageOptions: SendStatusOptions;
-    constructor();
-    initialize(): Promise<void>;
-    get(chatId: string | Wid): StatusV3Model | undefined;
-    getMyStatus(): Promise<StatusV3Model>;
-    sendRawStatus(message: RawMessage, options?: SendStatusOptions): Promise<import("../chat").SendMessageReturn>;
-    /**
-     * Send a text message to status stories
-     *
-     * @example
-     * ```javascript
-     * WPP.status.sendTextStatus(`Bootstrap primary color: #0275d8`, { backgroundColor: '#0275d8', font: 2});
-     * ```
-     */
-    sendTextStatus(content: any, options?: TextStatusOptions): Promise<any>;
-}