@open-wa/wa-automate-types-only 4.30.12 → 4.31.2

package/dist/api/Client.d.ts

@@ -74,7 +74,7 @@ export declare class Client {
      * A convinience method to download the [[DataURL]] of a file
      * @param url The url
      * @param optionsOverride You can use this to override the [axios request config](https://github.com/axios/axios#request-config)
-     * @returns Promise<DataURL>
+     * @returns `Promise<DataURL>`
      */
     download(url: string, optionsOverride?: any): Promise<DataURL>;
     /**
@@ -239,7 +239,8 @@ export declare class Client {
      *
      * Here is an example of the fired object:
      *
-     * @fires ```javascript
+     * @fires
+     * ```javascript
      * {
      * "chat": "00000000000-1111111111@g.us", //the chat in which this state is occuring
      * "user": "22222222222@c.us", //the user that is causing this state
@@ -315,9 +316,17 @@ export declare class Client {
      * @param chatId the chat from which you want to subscribes to live location updates
      * @param fn callback that takes in a LiveLocationChangedEvent
      * @returns boolean, if returns false then there were no valid live locations in the chat of chatId
-     * @emits <LiveLocationChangedEvent> LiveLocationChangedEvent
+     * @emits `<LiveLocationChangedEvent>` LiveLocationChangedEvent
      */
     onLiveLocation(chatId: ChatId, fn: (liveLocationChangedEvent: LiveLocationChangedEvent) => void): Promise<boolean>;
+    /**
+     * Use this simple command to test firing callback events.
+     *
+     * @param callbackToTest
+     * @param testData
+     * @returns `false` if the callback was not registered/does not exist
+     */
+    testCallback(callbackToTest: SimpleListener, testData: any): Promise<boolean>;
     /**
      * Set presence to available or unavailable.
      * @param available if true it will set your presence to 'online', false will set to unavailable (i.e no 'online' on recipients' phone);
@@ -428,7 +437,7 @@ export declare class Client {
      * A list of participants in the chat who have their live location on. If the chat does not exist, or the chat does not have any contacts actively sharing their live locations, it will return false. If it's a chat with a single contact, there will be only 1 value in the array if the contact has their livelocation on.
      * Please note. This should only be called once every 30 or so seconds. This forces the phone to grab the latest live location data for the number. This can be used in conjunction with onLiveLocation (this will trigger onLiveLocation).
      * @param chatId string Id of the chat you want to force the phone to get the livelocation data for.
-     * @returns Promise<LiveLocationChangedEvent []> | boolean
+     * @returns `Promise<LiveLocationChangedEvent []>` | boolean
      */
     forceUpdateLiveLocation(chatId: ChatId): Promise<LiveLocationChangedEvent[] | boolean>;
     private link;
@@ -482,6 +491,8 @@ export declare class Client {
      */
     sendBanner(to: ChatId, base64: Base64): Promise<boolean | MessageId>;
     /**
+     * {@license:insiders@}
+     * <span theme="badge contrast license">Insiders</span>
      * [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!
@@ -511,7 +522,7 @@ export declare class Client {
      * @param groupId group chat id: `xxxxx@g.us`
      * @param content text message to add under all of the tags
      * @param hideTags Removes all tags within the message
-     * @returns Promise<MessageId>
+     * @returns `Promise<MessageId>`
      */
     tagEveryone(groupId: GroupChatId, content: Content, hideTags?: boolean): Promise<boolean | MessageId>;
     /**
@@ -542,7 +553,7 @@ export declare class Client {
     /**
      * Decrypts a media message.
      * @param message This can be the serialized [[MessageId]] or the whole [[Message]] object. It is advised to just use the serialized message ID.
-     * @returns Promise<[[DataURL]]>
+     * @returns `Promise<[[DataURL]]>`
      */
     decryptMedia(message: Message | MessageId): Promise<DataURL>;
     /**
@@ -553,7 +564,7 @@ export declare class Client {
      * @param caption string xxxxx
      * @param waitForKey boolean default: false set this to true if you want to wait for the id of the message. By default this is set to false as it will take a few seconds to retrieve to the key of the message and this waiting may not be desirable for the majority of users.
      * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
-     * @returns Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
+     * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
     sendImage(to: ChatId, file: DataURL | FilePath, filename: string, caption: Content, quotedMsgId?: MessageId, waitForId?: boolean, ptt?: boolean, withoutPreview?: boolean, hideTags?: boolean, viewOnce?: boolean): Promise<MessageId | boolean>;
     /**
@@ -580,7 +591,7 @@ export declare class Client {
      * @param content string reply text
      * @param quotedMsgId string the msg id to reply to.
      * @param sendSeen boolean If set to true, the chat will 'blue tick' all messages before sending the reply
-     * @returns Promise<MessageId | false> false if didn't work, otherwise returns message id.
+     * @returns `Promise<MessageId | false>` false if didn't work, otherwise returns message id.
      */
     reply(to: ChatId, content: Content, quotedMsgId: MessageId, sendSeen?: boolean): Promise<boolean | MessageId>;
     /**
@@ -591,7 +602,7 @@ export declare class Client {
      * This will only work if you have chats sent back and forth between you and the contact 1-1.
      *
      * @param contactId The Id of the contact with which you have an existing conversation with messages already.
-     * @returns Promise<string | boolean> true or false or a string with an explaintaion of why it wasn't able to determine the read receipts.
+     * @returns `Promise<string | boolean>` true or false or a string with an explaintaion of why it wasn't able to determine the read receipts.
      *
      */
     checkReadReceipts(contactId: ContactId): Promise<string | boolean>;
@@ -612,7 +623,7 @@ export declare class Client {
      * @param ptt boolean default: false set this to true if you want to send the file as a push to talk file.
      * @param withoutPreview boolean default: false set this to true if you want to send the file without a preview (i.e as a file). This is useful for preventing auto downloads on recipient devices.
      * @param hideTags boolean default: false [INSIDERS] set this to try silent tag someone in the caption
-     * @returns Promise <boolean | MessageId> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
+     * @returns `Promise <boolean | MessageId>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
     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>;
     /**
@@ -620,7 +631,7 @@ export declare class Client {
      *
      * 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
-     * @returns Promise <boolean | string> This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string
+     * @returns `Promise <boolean | string>` This will either return a boolean indiciating whether this group chat id is considered unsafe or an error message as a string
      */
     isGroupIdUnsafe(groupChatId: GroupChatId): Promise<string | boolean>;
     /**
@@ -628,7 +639,7 @@ export declare class Client {
      * @param to chat id `xxxxx@c.us`
      * @param file base64 data:image/xxx;base64,xxx or the path of the file you want to send.
      * @param quotedMsgId string true_0000000000@c.us_JHB2HB23HJ4B234HJB to send as a reply to a message
-     * @returns Promise <boolean | string> This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
+     * @returns `Promise <boolean | string>` This will either return true or the id of the message. It will return true after 10 seconds even if waitForId is true
      */
     sendPtt(to: ChatId, file: DataURL | FilePath, quotedMsgId: MessageId): Promise<MessageId>;
     /**
@@ -674,7 +685,7 @@ export declare class Client {
     getMe(): Promise<any>;
     /**
      * Returns a PNG DataURL screenshot of the session
-     * @returns Promise<DataURL>
+     * @returns `Promise<DataURL>`
      */
     getSnapshot(): Promise<DataURL>;
     /**
@@ -793,7 +804,7 @@ export declare class Client {
      * Any potential abuse of this method will see it become paywalled.
      * @param to: Chat id to forward the message to
      * @param messageId: message id of the message to forward. Please note that if it is not loaded, this will return false - even if it exists.
-     * @returns Promise<MessageId | boolean>
+     * @returns `Promise<MessageId | boolean>`
      */
     ghostForward(to: ChatId, messageId: MessageId): Promise<MessageId | boolean>;
     /**
@@ -861,7 +872,7 @@ export declare class Client {
     getAllChatIds(): Promise<ChatId[]>;
     /**
      * retrieves an array of IDs of accounts blocked by the host account.
-     * @returns Promise<ChatId[]>
+     * @returns `Promise<ChatId[]>`
      */
     getBlockedIds(): Promise<ChatId[]>;
     /**
@@ -900,7 +911,7 @@ export declare class Client {
      * @param returnChatObj boolean When this is set to true and if the group was joined successfully, it will return a serialzed Chat object which includes group information and metadata. This is useful when you want to immediately do something with group metadata.
      *
      *
-     * @returns Promise<string | boolean | number> Either false if it didn't work, or the group id.
+     * @returns `Promise<string | boolean | number>` Either false if it didn't work, or the group id.
      */
     joinGroupViaLink(link: string, returnChatObj?: boolean): Promise<string | boolean | number | Chat>;
     /**
@@ -1165,7 +1176,7 @@ export declare class Client {
     /**
       * Retrieves an invite link for a group chat. returns false if chat is not a group.
      * @param chatId
-     * @returns Promise<string>
+     * @returns `Promise<string>`
      */
     getGroupInviteLink(chatId: ChatId): Promise<string>;
     /**
@@ -1177,7 +1188,7 @@ export declare class Client {
     /**
       * Revokes the current invite link for a group chat. Any previous links will stop working
      * @param chatId
-     * @returns Promise<boolean>
+     * @returns `Promise<boolean>`
      */
     revokeGroupInviteLink(chatId: ChatId): Promise<boolean | string>;
     /**
@@ -1200,7 +1211,9 @@ export declare class Client {
      * @param use_unread_count
      * @returns any
      */
-    getUnreadMessages(includeMe: boolean, includeNotifications: boolean, use_unread_count: boolean): Promise<Message[]>;
+    getUnreadMessages(includeMe: boolean, includeNotifications: boolean, use_unread_count: boolean): Promise<Chat & {
+        messages: Message[];
+    }>;
     /**
      * Retrieves all new Messages. where isNewMsg==true
      * @returns list of messages
@@ -1252,21 +1265,6 @@ export declare class Client {
      *
      * @param groupName group name: 'New group'
      * @param contacts: A single contact id or an array of contact ids.
-     * @returns Promise<GroupCreationResponse> :
-     * ```javascript
-     * {
-     *   status: 200,
-     *   gid: {
-     *     server: 'g.us',
-     *     user: '447777777777-1583678870',
-     *     _serialized: '447777777777-1583678870@g.us'
-     *   },
-     *   participants: [
-     *     { '447777777777@c.us': [Object] },
-     *     { '447444444444@c.us': [Object] }
-     *   ]
-     * }
-     * ```
      */
     createGroup(groupName: string, contacts: ContactId | ContactId[]): Promise<GroupChatCreationResponse>;
     /**
@@ -1416,7 +1414,7 @@ export declare class Client {
      * @param url: The url of the image
      * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
      *
-     * @returns Promise<MessageId | boolean>
+     * @returns `Promise<MessageId | boolean>`
      */
     sendStickerfromUrl(to: ChatId, url: string, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<string | MessageId | boolean>;
     /**
@@ -1428,7 +1426,7 @@ export declare class Client {
      * @param messageId The id of the message to reply to
      * @param requestConfig {} By default the request is a get request, however you can override that and many other options by sending this parameter. You can read more about this parameter here: https://github.com/axios/axios#request-config
      *
-     * @returns Promise<MessageId | boolean>
+     * @returns `Promise<MessageId | boolean>`
      */
     sendStickerfromUrlAsReply(to: ChatId, url: string, messageId: MessageId, requestConfig?: AxiosRequestConfig, stickerMetadata?: StickerMetadata): Promise<MessageId | boolean>;
     /**
@@ -1505,7 +1503,7 @@ export declare class Client {
      * Turn the ephemeral setting in a chat to on or off
      * @param chatId The ID of the chat
      * @param ephemeral `true` to turn on the ephemeral setting, `false` to turn off the ephemeral setting. Please note, if the setting is already on the requested setting, this method will return `true`.
-     * @returns Promise<boolean> true if the setting was set, `false` if the chat does not exist
+     * @returns `Promise<boolean>` true if the setting was set, `false` if the chat does not exist
      */
     setChatEphemeral(chatId: ChatId, ephemeral: boolean): Promise<boolean>;
     /**
@@ -1528,7 +1526,7 @@ export declare class Client {
      * 3: [Bryndan Write](https://www.dafontfree.net/freefonts-bryndan-write-f160189.htm)
      * 4: [Bebasneue Regular](https://www.dafont.com/bebas-neue.font)
      * 5: [Oswald Heavy](https://www.fontsquirrel.com/fonts/oswald)
-     * @returns Promise<string | boolean> returns status id if it worked, false if it didn't
+     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
      */
     postTextStatus(text: Content, textRgba: string, backgroundRgba: string, font: number): Promise<MessageId | string | boolean>;
     /**
@@ -1537,7 +1535,7 @@ export declare class Client {
      * Posts an image story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
      * @param caption The caption for the story
-     * @returns Promise<string | boolean> returns status id if it worked, false if it didn't
+     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
      */
     postImageStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
     /**
@@ -1546,7 +1544,7 @@ export declare class Client {
      * Posts a video story.
      * @param data data url string `data:[<MIME-type>][;charset=<encoding>][;base64],<data>`
      * @param caption The caption for the story
-     * @returns Promise<string | boolean> returns status id if it worked, false if it didn't
+     * @returns `Promise<string | boolean>` returns status id if it worked, false if it didn't
      */
     postVideoStatus(data: DataURL, caption: Content): Promise<MessageId | string | boolean>;
     /**
@@ -1632,7 +1630,7 @@ export declare class Client {
      *
      * Sets the profile pic of the host number.
      * @param data string data url image string.
-     * @returns Promise<boolean> success if true
+     * @returns `Promise<boolean>` success if true
      */
     setProfilePic(data: DataURL): Promise<boolean>;
     /**

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

@@ -1,3 +1,6 @@
+declare type Brand<K, T> = K & {
+    __brand?: T;
+};
 /**
  * The suffix used to identify a non-group chat id
  */
@@ -33,7 +36,7 @@ export declare type GroupChatId = `${AccountNumber}-${number}@${GroupChatServer}
  *
  * `"447123456789@c.us"`
  */
-export declare type ContactId = `${AccountNumber}@${ChatServer}`;
+export declare type ContactId = Brand<`${AccountNumber}@${ChatServer}`, "ContactId">;
 /**
  * A chat id ends with `@c.us` or `@g.us` for group chats.
  *
@@ -51,7 +54,7 @@ export declare type ChatId = ContactId | GroupChatId;
  *
  * `"false_447123456789@c.us_9C4D0965EA5C09D591334AB6BDB07FEB"`
  */
-export declare type MessageId = `${boolean}_${ChatId}_${string}`;
+export declare type MessageId = Brand<`${boolean}_${ChatId}_${string}`, "MessageId">;
 /**
  * This is a generic type alias for the content of a message
  *
@@ -59,7 +62,7 @@ export declare type MessageId = `${boolean}_${ChatId}_${string}`;
  *
  * `"hello!"`
  */
-export declare type Content = string;
+export declare type Content = Brand<string, "Content">;
 export declare type NonSerializedId = {
     server: WaServers;
     user: AccountNumber;
@@ -77,7 +80,7 @@ export declare type NonSerializedId = {
  *
  * Learn more here: https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs
  */
-export declare type DataURL = string;
+export declare type DataURL = Brand<`data:${string};base64,${Base64}`, "DataURL">;
 /**
  * Base64 is basically a file encoded as a string.
  *
@@ -85,10 +88,11 @@ export declare type DataURL = string;
  *
  * Learn more here: https://developer.mozilla.org/en-US/docs/Glossary/Base64
  */
-export declare type Base64 = string;
+export declare type Base64 = Brand<string, "Base64">;
 /**
  * The relative or absolute path of a file
  *
  * Learn more here: https://www.w3schools.com/html/html_filepaths.asp
  */
-export declare type FilePath = string;
+export declare type FilePath = Brand<string, "FilePath">;
+export {};

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

@@ -687,7 +687,7 @@ export interface ConfigObject {
     /**
      * What to do when an error is detected on a client method.
      *
-     * @default `NOTHING`
+     * @default `OnError.NOTHING`
      */
     onError?: OnError;
     /**
@@ -697,6 +697,9 @@ export interface ConfigObject {
      * Set this to true if you're using the multidevice beta.
      *
      * @default `false`
+     * :::danger
+     * Some features (e.g [[sendLinkWithAutoPreview]])  **do not** work with multi-device beta. Check [this `api`](#).
+     * :::
      */
     multiDevice?: boolean;
     /**

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

@@ -3,6 +3,7 @@ export * from './contact';
 export * from './message';
 export * from './errors';
 export * from './events';
+export * from './product';
 /**
  * Client status
  * @readonly

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

@@ -75,7 +75,7 @@ export interface Product {
     description?: string;
     /**
      * The availiable quantity of this product.
-     * @default `"unknown"``
+     * @default "unknown"`
      */
     availability?: number | "unknown";
     /**

package/dist/controllers/auth.d.ts

@@ -3,13 +3,13 @@ import { Spin } from './events';
 import { ConfigObject } from '../api/model';
 import { Page } from 'puppeteer';
 /**
+ * isAuthenticated
  * Validates if client is authenticated
  * @returns true if is authenticated, false otherwise
  * @param waPage
  */
 export declare const isAuthenticated: (waPage: Page) => Promise<unknown>;
 export declare const needsToScan: (waPage: Page) => Observable<unknown>;
-export declare const isInsideChat: (waPage: Page) => Observable<boolean>;
 export declare const waitForRipeSession: (waPage: Page) => Promise<boolean>;
 export declare const sessionDataInvalid: (waPage: Page) => Promise<string>;
 export declare const phoneIsOutOfReach: (waPage: Page) => Promise<boolean>;
@@ -27,6 +27,10 @@ export declare class QRManager {
     grabAndEmit(qrData: any, waPage: Page, config: ConfigObject, spinner: Spin): Promise<void>;
     smartQr(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<boolean | void | string>;
     emitFirst(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<void>;
+    /**
+     * Wait 10 seconds for the qr element to show.
+     * If it doesn't show up within 10 seconds then assume the session is authed already or blocked therefore ignore and return promise
+     */
     waitFirstQr(waPage: Page, config?: ConfigObject, spinner?: Spin): Promise<void>;
 }
 export declare const qrManager: QRManager;

package/dist/controllers/script_preloader.d.ts

@@ -0,0 +1,17 @@
+export declare class ScriptLoader {
+    scripts: string[];
+    contentRegistry: {
+        [key: string]: string;
+    };
+    constructor();
+    loadScripts(): Promise<{
+        [key: string]: string;
+    }>;
+    getScript(scriptName: string): Promise<string>;
+    flush(): void;
+    getScripts(): {
+        [key: string]: string;
+    };
+}
+declare const scriptLoader: ScriptLoader;
+export { scriptLoader };

package/package.json

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