@wppconnect/wa-js 1.0.16 → 1.1.3

package/dist/chat/eventEmitter.d.ts

@@ -0,0 +1,107 @@
+/*!
+ * 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 { MsgKey, Wid } from '../whatsapp';
+export declare type UnsubscribeFn = () => void;
+export interface EventTypes {
+    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[];
+    };
+    live_location_start: {
+        id: Wid;
+        msgId: MsgKey;
+        chat: Wid;
+        lat: number;
+        lng: number;
+        accuracy?: number;
+        speed?: number;
+        degrees?: number;
+        shareDuration: number;
+    };
+    live_location_update: {
+        id: Wid;
+        lastUpdated: number;
+        elapsed: number;
+        lat: number;
+        lng: number;
+        accuracy?: number;
+        speed?: number;
+        degrees?: number;
+        comment: string;
+    };
+    live_location_end: {
+        id: Wid;
+        chat: Wid;
+        seq: number;
+    };
+}
+export declare const eventEmitter: Emittery<EventTypes, EventTypes, never>;
+/**
+ * Subscribe to one event.
+ * @event
+ * @returns An unsubscribe method.
+ */
+export declare function on<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): UnsubscribeFn;
+/**
+ * Subscribe to one or more events only once. It will be unsubscribed after the first event.
+ * @event
+ */
+export declare function once<Name extends keyof EventTypes>(eventName: Name): Promise<EventTypes[Name]>;
+/**
+ * @event
+ */
+export declare function off<Name extends keyof EventTypes>(eventName: Name, listener: (eventData: EventTypes[Name]) => void | Promise<void>): void;
+/**
+ * Clear all event listeners on the instance.
+ *
+ * If `eventName` is given, only the listeners for that event are cleared.
+ *
+ * @event
+ */
+export declare function clearListeners<Name extends keyof EventTypes>(eventName?: Name | Name[]): void;
+/**
+ * The number of listeners for the `eventName` or all events if not specified.
+ * @event
+ */
+export declare function listenerCount<Name extends keyof EventTypes>(eventName?: Name | Name[]): number;

package/dist/chat/events/index.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * 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 './registerAckMessageEvent';
+import './registerRevokeMessageEvent';
+import './registerLiveLocationUpdateEvent';

package/dist/chat/events/registerAckMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerLiveLocationUpdateEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/events/registerRevokeMessageEvent.d.ts

@@ -0,0 +1,16 @@
+/*!
+ * 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.
+ */
+export {};

package/dist/chat/functions/clear.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Clear a chat message
+ *
+ * @category Chat
+ */
+export declare function clear(chatId: string | Wid, keepStarred?: boolean): Promise<{
+    wid: Wid;
+    status: number;
+    keepStarred: boolean;
+}>;

package/dist/chat/functions/delete.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Delete a chat
+ *
+ * @category Chat
+ */
+declare function _delete(chatId: string | Wid): Promise<{
+    wid: Wid;
+    status: number;
+}>;
+export { _delete as delete };

package/dist/chat/functions/deleteMessage.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { SendMsgResult } from '../../whatsapp/enums';
+export interface DeleteMessageReturn {
+    id: string;
+    sendMsgResult: Promise<SendMsgResult>;
+    isRevoked: boolean;
+    isDeleted: boolean;
+}
+/**
+ * Delete a message
+ *
+ * @category Message
+ */
+export declare function deleteMessage(chatId: string | Wid, id: string, deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn>;
+/**
+ * Delete a list of messages
+ *
+ * @category Message
+ */
+export declare function deleteMessage(chatId: string | Wid, ids: string[], deleteMediaInDevice: boolean, revoke: boolean): Promise<DeleteMessageReturn[]>;

package/dist/chat/functions/downloadMedia.d.ts

@@ -0,0 +1,21 @@
+/*!
+ * 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.
+ */
+/**
+ * Download the blob of a media message
+ *
+ * @category Message
+ */
+export declare function downloadMedia(id: string): Promise<Blob>;

package/dist/chat/functions/find.d.ts

@@ -0,0 +1,24 @@
+/*!
+ * 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 { ChatModel, Wid } from '../../whatsapp';
+/**
+ * Find a chat by id
+ *
+ * This create a new chat if no one was found
+ *
+ * @category Chat
+ */
+export declare function find(chatId: string | Wid): Promise<ChatModel>;

package/dist/chat/functions/generateMessageID.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * 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 { ChatModel, MsgKey, Wid } from '../../whatsapp';
+/**
+ * Generate a new message ID
+ *
+ * @category Message
+ */
+export declare function generateMessageID(chat: string | ChatModel | Wid): MsgKey;

package/dist/chat/functions/get.d.ts

@@ -0,0 +1,22 @@
+/*!
+ * 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 { ChatModel, Wid } from '../../whatsapp';
+/**
+ * Find a chat by id
+ *
+ * @category Chat
+ */
+export declare function get(chatId: string | Wid): ChatModel | undefined;

package/dist/chat/functions/getMessageById.d.ts

@@ -0,0 +1,35 @@
+/*!
+ * 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 { MsgKey, MsgModel } from '../../whatsapp';
+/**
+ * Get message by a single ID or array of IDs
+ *
+ * @example
+ * ```javascript
+ * // Single message
+ * WPP.chat.getMessageById('true_<number>@c.us_ABCDEF');
+ *
+ * // List of messages
+ * WPP.chat.getMessageById(['true_<number>@c.us_ABCDEF', 'false_<number>@c.us_789456']);
+ * ```
+ *
+ * @category Message
+ * @return  {Promise<MsgModel> | Promise<MsgModel[]>} List of raw messages
+ */
+export declare function getMessageById(id: string | MsgKey): Promise<MsgModel>;
+export declare function getMessageById(ids: (string | MsgKey)[]): Promise<MsgModel[]>;
+export declare function getMessageById(notUsed: any, id: string): Promise<MsgModel>;
+export declare function getMessageById(notUsed: any, ids: string[]): Promise<MsgModel[]>;

package/dist/chat/functions/getMessages.d.ts

@@ -0,0 +1,48 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+import { RawMessage } from '..';
+export interface GetMessagesOptions {
+    count?: number;
+    direction?: 'after' | 'before';
+    id?: string;
+}
+/**
+ * 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>'
+ * });
+ * ```
+ * @category Message
+ * @return  {RawMessage[]} List of raw messages
+ */
+export declare function getMessages(chatId: string | Wid, options?: GetMessagesOptions): Promise<RawMessage[]>;

package/dist/chat/functions/index.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * 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.
+ */
+export { clear } from './clear';
+export { delete } from './delete';
+export { deleteMessage, DeleteMessageReturn } from './deleteMessage';
+export { downloadMedia } from './downloadMedia';
+export { find } from './find';
+export { generateMessageID } from './generateMessageID';
+export { get } from './get';
+export { getMessageById } from './getMessageById';
+export { getMessages, GetMessagesOptions } from './getMessages';
+export { markIsComposing } from './markIsComposing';
+export { markIsPaused } from './markIsPaused';
+export { markIsRead } from './markIsRead';
+export { markIsRecording } from './markIsRecording';
+export { markIsUnread } from './markIsUnread';
+export { LinkPreviewOptions, prepareLinkPreview } from './prepareLinkPreview';
+export { MessageButtonsOptions, prepareMessageButtons, } from './prepareMessageButtons';
+export { prepareRawMessage } from './prepareRawMessage';
+export { AudioMessageOptions, AutoDetectMessageOptions, DocumentMessageOptions, FileMessageOptions, ImageMessageOptions, sendFileMessage, StickerMessageOptions, VideoMessageOptions, } from './sendFileMessage';
+export { ListMessageOptions, sendListMessage } from './sendListMessage';
+export { sendRawMessage } from './sendRawMessage';
+export { sendTextMessage, TextMessageOptions } from './sendTextMessage';
+export { sendVCardContactMessage, VCardContact, } from './sendVCardContactMessage';

package/dist/chat/functions/markIsComposing.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * 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);
+ * ```
+ * @category Chat
+ */
+export declare function markIsComposing(chatId: string | Wid, duration?: number): Promise<void>;

package/dist/chat/functions/markIsPaused.d.ts

@@ -0,0 +1,27 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Mark a chat is paused state
+ *
+ * @example
+ * ```javascript
+ * // Mark as recording
+ * WPP.chat.markIsPaused('<number>@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsPaused(chatId: string | Wid): Promise<void>;

package/dist/chat/functions/markIsRead.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Mark a chat as read and send SEEN event
+ *
+ * @example
+ * ```javascript
+ * // Some messages
+ * WPP.chat.markIsRead('<number>@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsRead(chatId: string | Wid): Promise<{
+    wid: Wid;
+    unreadCount: number;
+}>;

package/dist/chat/functions/markIsRecording.d.ts

@@ -0,0 +1,31 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * 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);
+ * ```
+ * @category Chat
+ */
+export declare function markIsRecording(chatId: string | Wid, duration?: number): Promise<void>;

package/dist/chat/functions/markIsUnread.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * 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 { Wid } from '../../whatsapp';
+/**
+ * Mark a chat as unread
+ *
+ * @example
+ * ```javascript
+ * // Some messages
+ * WPP.chat.markIsUnread('<number>@c.us');
+ * ```
+ * @category Chat
+ */
+export declare function markIsUnread(chatId: string | Wid): Promise<{
+    wid: Wid;
+}>;