@wppconnect/wa-js 1.0.13 → 1.1.0

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@wppconnect/wa-js",
-  "version": "1.0.13",
+  "version": "1.1.0",
   "description": "WPPConnect/WA-JS is an open-source project with the aim of exporting functions from WhatsApp Web",
-  "main": "dist/wppconnect-wa.js",
   "types": "dist/index.d.ts",
   "exports": {
     ".": "./dist/wppconnect-wa.js"
@@ -36,43 +35,43 @@
     "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.17.33",
-    "@types/shelljs": "^0.8.9",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "@wppconnect/wa-version": "^1.1.22",
+    "@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.2",
+    "debug": "^4.3.3",
     "emittery": "^0.10.0",
-    "eslint": "^7.32.0",
+    "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",
+    "file-type": "~16.5.3",
     "husky": "^7.0.4",
-    "playwright": "^1.16.3",
-    "prettier": "^2.4.1",
-    "pretty-quick": "^3.1.2",
-    "release-it": "^14.11.7",
+    "playwright-chromium": "^1.17.1",
+    "prettier": "^2.5.1",
+    "pretty-quick": "^3.1.3",
+    "release-it": "^14.11.8",
     "shx": "^0.3.3",
     "ts-loader": "^9.2.6",
-    "ts-morph": "^12.2.0",
+    "ts-morph": "^13.0.2",
     "ts-node": "^10.4.0",
     "typedoc": "^0.22.4",
     "typedoc-plugin-mdn-links": "^1.0.4",
-    "typedoc-plugin-missing-exports": "^0.22.4",
-    "typescript": "^4.4.4",
-    "webpack": "^5.64.1",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "^4.5.4",
+    "webpack": "^5.65.0",
     "webpack-cli": "^4.9.1"
   },
   "config": {

package/dist/src/chat/Chat.d.ts

@@ -1,162 +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;
-    }>;
-    /**
-     * 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>;
-    sendVCardContact(chatId: any, contacts: string | Wid | VCardContact | (string | Wid | VCardContact)[], options?: SendMessageOptions): Promise<SendMessageReturn>;
-}

package/dist/src/chat/types.d.ts

@@ -1,177 +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 { ModelPropertiesContructor, MsgKey, MsgModel, Wid } from '../whatsapp';
-import { SendMsgResult } from '../whatsapp/enums';
-export interface ChatEventTypes {
-    change: string;
-    idle: undefined;
-    msg_revoke: {
-        /**
-         * Author of message, only for groups
-         */
-        author?: Wid;
-        from: Wid;
-        /**
-         * Message id of revoke event
-         */
-        id: MsgKey;
-        /**
-         * Message id of revoked message
-         */
-        refId: MsgKey;
-        to: Wid;
-    };
-    msg_ack_change: {
-        ack: number;
-        /**
-         * Who sended the ack, only for groups, broadcast and status
-         */
-        sender?: Wid;
-        /**
-         * The chat that sended the messeage
-         */
-        chat: Wid;
-        /**
-         * Message id of revoke event
-         */
-        ids: MsgKey[];
-    };
-}
-export interface GetMessagesOptions {
-    count?: number;
-    direction?: 'after' | 'before';
-    id?: string;
-}
-export interface DeleteMessageReturn {
-    id: string;
-    sendMsgResult: Promise<SendMsgResult>;
-    isRevoked: boolean;
-    isDeleted: boolean;
-}
-export interface SendMessageOptions {
-    createChat?: boolean;
-    /**
-     * Automatic detect and add the mentioned contacts with @<number>
-     *
-     * @example
-     * ```javascript
-     * WPP.chat.sendTextMessage('<number>@c.us', 'Hello @123 and @456', {
-     *   detectMentioned: true
-     * });
-     * ```
-     */
-    detectMentioned?: boolean;
-    messageId?: string | MsgKey;
-    /**
-     * Define a mentioned list for a message
-     * This option work better with a message with mension
-     *
-     * @example
-     * ```javascript
-     * WPP.chat.sendTextMessage('<number>@c.us', 'Hello @123 and @456', {
-     *   mentionedList: ['123@c.us', '456@c.us']
-     * })
-     * ```
-     */
-    mentionedList?: (string | Wid)[];
-    /**
-     * Quote a message, like a reply message
-     *
-     * @example
-     * ```javascript
-     * WPP.chat.sendTextMessage('<number>@c.us', 'This is a reply', {
-     *   quotedMsg: 'true_<number>@c.us_3EB0F435D95D32C4C638'
-     * })
-     * ```
-     */
-    quotedMsg?: string | MsgKey | MsgModel;
-    /**
-     * Wait for send while the ACK of message is SENT(1)
-     *
-     * @example
-     * ```javascript
-     * WPP.chat.sendTextMessage('<number>@c.us', 'Wait for sent', {
-     *   waitForAck: true
-     * })
-     * ```
-     */
-    waitForAck?: boolean;
-}
-export interface SendMessageReturn {
-    id: string;
-    ack: number;
-    sendMsgResult: Promise<SendMsgResult>;
-}
-export interface MessageButtonsOptions {
-    /**
-     * List of buttons, with at least 1 option and a maximum of 3
-     */
-    buttons?: Array<{
-        id: string;
-        text: string;
-    }>;
-    /**
-     * Title for buttons, only for text message
-     */
-    title?: string;
-    /**
-     * Footer text for buttons
-     */
-    footer?: string;
-}
-export interface ListMessageOptions extends SendMessageOptions {
-    buttonText: string;
-    description: string;
-    sections: Array<{
-        title: string;
-        rows: Array<{
-            rowId: string;
-            title: string;
-            description: string;
-        }>;
-    }>;
-}
-export declare type TextMessageOptions = SendMessageOptions & MessageButtonsOptions;
-export interface FileMessageOptions extends SendMessageOptions {
-    type: string;
-    caption?: string;
-    filename?: string;
-    mimetype?: string;
-}
-export interface AutoDetectMessageOptions extends FileMessageOptions {
-    type: 'auto-detect';
-}
-export interface AudioMessageOptions extends FileMessageOptions {
-    type: 'audio';
-    isPtt?: boolean;
-}
-export interface DocumentMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'document';
-}
-export interface ImageMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'image';
-    isViewOnce?: boolean;
-}
-export interface VideoMessageOptions extends FileMessageOptions, MessageButtonsOptions {
-    type: 'video';
-    isGif?: boolean;
-}
-export interface VCardContact {
-    id: string | Wid;
-    name: string;
-}
-export declare type AllMessageOptions = SendMessageOptions & MessageButtonsOptions & Partial<ListMessageOptions>;
-export declare type RawMessage = ModelPropertiesContructor<MsgModel>;

package/dist/src/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/src/group/index.d.ts

@@ -1,20 +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 { Group } from './Group';
-export * from './Group';
-export * from './types';
-declare const _default: Group;
-export default _default;

package/dist/src/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>;
-}

package/dist/src/status/index.d.ts

@@ -1,20 +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 { Status } from './Status';
-export * from './Status';
-export * from './types';
-declare const _default: Status;
-export default _default;

package/dist/src/whatsapp/misc/ClockSkew.d.ts

@@ -1,43 +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.
- */
-/** @whatsapp 2.2144.11:25142 */
-export declare namespace ClockSkew {
-    const is24h: boolean;
-    const skew: number;
-    const skewMS: number;
-    const timeZoneHardCode: string;
-    function getIs24Hour(): boolean;
-    function setIs24Hour(is24h: boolean): void;
-    function setSkew(skew: number): void;
-    function getSkew(): number;
-    function localUnixTime(timestamp?: number): number;
-    function globalUnixTime(timestamp?: number): number;
-    function relativeStr(timestamp: number): string;
-    function relativeDateStr(timestamp: number): string;
-    function relativeDateAndTimeStr(timestamp: number): string;
-    function timeStr(timestamp: number): string;
-    function timestampStr(timestamp: number): string;
-    function timestampStrFormat(): string;
-    function timestampHour(timestamp: number): number;
-    function createdStr(timestamp: number): string;
-    function untilStr(timestamp: number): string;
-    function lastSeenStr(timestamp: number): string;
-    function daysDelta(a: number, b: number): number;
-    function durationStr(seconds: number | string): string;
-    function paymentTimestampStr(timestamp: number): string;
-    function liveLocationLastUpdatedStr(timestamp: number): string;
-    function shouldUseIntlDateTimeFormat(): boolean;
-}