@open-wa/wa-automate-types-only 4.43.0 → 4.43.3

package/dist/api/Client.d.ts

@@ -2,7 +2,7 @@
 import { Page } from 'puppeteer';
 import { Chat, LiveLocationChangedEvent, ChatState, ChatMuteDuration, GroupChatCreationResponse, EphemeralDuration } from './model/chat';
 import { Contact, NumberCheck } from './model/contact';
-import { Message } from './model/message';
+import { Message, MessageInfo } from './model/message';
 import { AxiosRequestConfig } from 'axios';
 import { ParticipantChangedEventModel } from './model/group-metadata';
 import { ConfigObject, STATE, LicenseType, Webhook, EventPayload } from './model';
@@ -39,6 +39,7 @@ export declare class Client {
     private _page;
     private _currentlyBeingKilled;
     private _refreshing;
+    private _loaded;
     private _prio;
     private _pageListeners;
     private _registeredPageListeners;
@@ -244,19 +245,19 @@ export declare class Client {
      */
     onLabel(fn: (label: Label) => void): Promise<Listener | boolean>;
     /**
-     *[REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     *{@license:insiders@}
      *
      * Listens to new orders. Only works on business accounts
      */
     onOrder(fn: (order: Order) => void): Promise<Listener | boolean>;
     /**
-     *[REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     *{@license:insiders@}
      *
      * Listens to new orders. Only works on business accounts
      */
     onNewProduct(fn: (product: Product) => void): Promise<Listener | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Listens to reaction add and change events
      *
@@ -266,7 +267,7 @@ export declare class Client {
      */
     onReaction(fn: (reactionEvent: ReactionEvent) => void): Promise<Listener | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Listens to chat state, including when a specific user is recording and typing within a group chat.
      *
@@ -309,7 +310,7 @@ export declare class Client {
      */
     onAddedToGroup(fn: (chat: Chat) => any): Promise<Listener | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Fires callback with Chat object every time the host phone is removed to a group.
      *
@@ -319,7 +320,7 @@ export declare class Client {
      */
     onRemovedFromGroup(fn: (chat: Chat) => any): Promise<Listener | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Fires callback with the relevant chat id every time the user clicks on a chat. This will only work in headful mode.
      *
@@ -329,7 +330,7 @@ export declare class Client {
      */
     onChatOpened(fn: (chat: Chat) => any): Promise<Listener | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Fires callback with contact id when a new contact is added on the host phone.
      *
@@ -373,7 +374,7 @@ export declare class Client {
      */
     setMyStatus(newStatus: string): Promise<boolean | void>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Adds label from chat, message or contact. Only for business accounts.
      * @param label: The desired text of the new label. id will be something simple like anhy nnumber from 1-10, name is the label of the label if that makes sense.
@@ -486,6 +487,9 @@ export declare class Client {
     testButtons(chatId: ChatId): Promise<any>;
     private link;
     /**
+     *
+     * {@license:restricted@}
+     *
      * Sends a text message to given chat
      * If you need to send a message to new numbers please see [these instructions:](https://docs.openwa.dev/pages/The%20Client/licensed-features.html#sending-messages-to-non-contact-numbers)
      * @param to chat id: `xxxxx@c.us`
@@ -551,8 +555,6 @@ export declare class Client {
     /**
      * {@license:insiders@}
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
-     *
      * Send a list message. This will not work when being sent from business accounts!
      *
      * @param  {ChatId} to
@@ -575,7 +577,7 @@ export declare class Client {
      */
     sendReplyWithMentions(to: ChatId, content: Content, replyMessageId: MessageId, hideTags?: boolean, mentions?: ContactId[]): Promise<boolean | MessageId>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Tags everyone in the group with a message
      *
@@ -660,7 +662,7 @@ export declare class Client {
      */
     reply(to: ChatId, content: Content, quotedMsgId: MessageId, sendSeen?: boolean): Promise<boolean | MessageId>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Check if a recipient has read receipts on.
      *
@@ -692,7 +694,7 @@ export declare class Client {
      */
     sendFile(to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Checks whether or not the group id provided is known to be unsafe by the contributors of the library.
      * @param groupChatId The group chat you want to deteremine is unsafe
@@ -812,7 +814,7 @@ export declare class Client {
     sendContact(to: ChatId, contactId: ContactId | ContactId[]): Promise<MessageId | boolean>;
     /**
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Sends multiple contacts as a single message
      *
@@ -848,7 +850,7 @@ export declare class Client {
     pinChat(id: ChatId, pin: boolean): Promise<boolean>;
     /**
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Mutes a conversation for a given duration. If already muted, this will update the muted duration. Mute durations are relative from when the method is called.
      * @param chatId The id of the conversation you want to mute
@@ -864,7 +866,7 @@ export declare class Client {
     isChatMuted(chatId: ChatId): Promise<boolean>;
     /**
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Unmutes a conversation.
      * @param id The id of the conversation you want to mute
@@ -1000,9 +1002,9 @@ export declare class Client {
      */
     contactBlock(id: ContactId): Promise<boolean>;
     /**
-     * Report a contact for spam, block them and attempt to clear chat.
+     * {@license:restricted@}
      *
-     * [This is a restricted feature and requires a restricted key.](https://gum.co/open-wa?tier=1%20Restricted%20License%20Key)
+     * Report a contact for spam, block them and attempt to clear chat.
      *
      * @param {string} id '000000000000@c.us'
      */
@@ -1058,7 +1060,14 @@ export declare class Client {
      */
     getMessageById(messageId: MessageId): Promise<Message>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
+     *
+     * Get the detailed message info for a group message sent out by the host account.
+     * @param messageId The message Id
+     */
+    getMessageInfo(messageId: MessageId): Promise<MessageInfo>;
+    /**
+     * {@license:insiders@}
      *
      * Retrieves an order object
      * @param messageId or OrderId
@@ -1066,7 +1075,7 @@ export declare class Client {
      */
     getOrder(id: MessageId | string): Promise<Order>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Add a product to your catalog
      *
@@ -1082,7 +1091,7 @@ export declare class Client {
      */
     createNewProduct(name: string, price: number, currency: string, images: string[], description: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Edit a product in your catalog
      *
@@ -1099,7 +1108,7 @@ export declare class Client {
      */
     editProduct(productId: string, name?: string, price?: number, currency?: string, images?: DataURL[], description?: string, url?: string, internalId?: string, isHidden?: boolean): Promise<Product>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Send a product to a chat
      *
@@ -1119,9 +1128,9 @@ export declare class Client {
     /**
      * Retrieves the last message sent by the host account in any given chat or globally.
      * @param chatId This is optional. If no chat Id is set then the last message sent by the host account will be returned.
-     * @returns message object
+     * @returns message object or `undefined` if the host account's last message could not be found.
      */
-    getMyLastMessage(chatId?: ChatId): Promise<Message>;
+    getMyLastMessage(chatId?: ChatId): Promise<Message | undefined>;
     /**
      * Retrieves the starred messages in a given chat
      * @param chatId Chat ID to filter starred messages by
@@ -1160,7 +1169,7 @@ export declare class Client {
     getStickerDecryptable(messageId: MessageId): Promise<Message | false>;
     /**
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * If a file is old enough, it will 404 if you try to decrypt it. This will allow you to force the host account to re upload the file and return a decryptable message.
      *
@@ -1177,7 +1186,7 @@ export declare class Client {
      */
     getChat(contactId: ContactId): Promise<Chat>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Retrieves the groups that you have in common with a contact
      * @param contactId
@@ -1245,7 +1254,7 @@ export declare class Client {
     }>;
     /**
      *
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Use a Baileys payload within your open-wa session
      *
@@ -1474,7 +1483,7 @@ export declare class Client {
     */
     setGroupDescription(groupId: GroupChatId, description: string): Promise<boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
     * Change the group chat title
     * @param groupId '0000000000-00000000@g.us' the group id.
@@ -1488,7 +1497,7 @@ export declare class Client {
     */
     getGroupAdmins(groupId: GroupChatId): Promise<ContactId[]>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Set the wallpaper background colour
      * @param {string} hex '#FFF123'
@@ -1525,7 +1534,7 @@ export declare class Client {
      */
     sendStickerfromUrl(to: ChatId, url: string, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<string | MessageId | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Sends a sticker from a given URL
      * @param to The recipient id.
@@ -1537,7 +1546,7 @@ export declare class Client {
      */
     sendStickerfromUrlAsReply(to: ChatId, url: string, messageId: MessageId, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<MessageId | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * This function takes an image and sends it as a sticker to the recipient as a reply to another message.
      *
@@ -1576,7 +1585,7 @@ export declare class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param file [[DataURL]], [[Base64]], URL (string GET), Relative filepath (string), or Buffer of the mp4 file
-     * @param messageId message id of the message you want this sticker to reply to. [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
      */
     sendMp4AsSticker(to: ChatId, file: DataURL | Buffer | Base64 | string, processOptions?: Mp4StickerConversionProcessOptions, stickerMetadata?: StickerMetadata, messageId?: MessageId): Promise<MessageId | string | boolean>;
     /**
@@ -1584,7 +1593,7 @@ export declare class Client {
      *
      * @param to ChatId The chat id you want to send the webp sticker to
      * @param emojiId The discord emoji id without indentifying chars. In discord you would write `:who:`, here use `who`
-     * @param messageId message id of the message you want this sticker to reply to. [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * @param messageId message id of the message you want this sticker to reply to. {@license:insiders@}
      */
     sendEmoji(to: ChatId, emojiId: string, messageId?: MessageId): Promise<MessageId | boolean | string>;
     /**
@@ -1595,7 +1604,7 @@ export declare class Client {
      */
     sendRawWebpAsSticker(to: ChatId, webpBase64: Base64, animated?: boolean): Promise<MessageId | string | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * You can use this to send a raw webp file.
      * @param to ChatId The chat id you want to send the webp sticker to
@@ -1605,7 +1614,7 @@ export declare class Client {
      */
     sendRawWebpAsStickerAsReply(to: ChatId, messageId: MessageId, webpBase64: Base64, animated?: boolean): Promise<MessageId | string | boolean>;
     /**
-     * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
+     * {@license:insiders@}
      *
      * Turn the ephemeral setting in a chat to on or off
      * @param chatId The ID of the chat

package/dist/api/model/message.d.ts

@@ -141,6 +141,10 @@ export interface Message {
      * Is the message a "view once" message
      */
     isViewOnce: boolean;
+    /**
+     * Use this to traverse the quote chain.
+     */
+    quoteMap: QuoteMap;
     /**
      * The URL of the file after being uploaded to the cloud using a cloud upload message preprocessor.
      */
@@ -163,6 +167,40 @@ export interface Message {
         "buttonText": string;
     };
 }
+export interface QuoteMap {
+    [messageId: string]: {
+        /**
+         * The body of the message
+         */
+        body: string;
+        /**
+         * The message ID of the message that was quoted. Null if no message was quoted.
+         */
+        quotes?: MessageId;
+    };
+}
+export interface MessageInfoInteraction {
+    /**
+     * The contact ID of the contact that interacted with the message.
+     */
+    id: ContactId;
+    /**
+     * The timestamp of the interaction. You have to x 1000 to use in a JS Date object.
+     */
+    t: number;
+}
+export interface MessageInfo {
+    deliveryRemaining: number;
+    playedRemaining: number;
+    readRemaining: number;
+    delivery: MessageInfoInteraction[];
+    read: MessageInfoInteraction[];
+    played: MessageInfoInteraction[];
+    /**
+     * The ID of the message
+     */
+    id: MessageId;
+}
 /**
  * Message types
  * @readonly

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@open-wa/wa-automate-types-only",
-    "version": "4.43.0",
+    "version": "4.43.3",
     "description": "Types generated from the @open-wa/wa-automate package",
     "scripts": {
         "build": "tsc",