@open-wa/wa-automate-types-only 4.71.14 → 4.71.15

package/dist/api/Client.d.ts

@@ -701,7 +701,7 @@ export declare class Client {
      * @param text The text you want to inslude in the message section. THIS HAS TO INCLUDE THE URL otherwise the url will be prepended to the text automatically.
      * @param chatId The chat you want to send this message to.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendMessageWithThumb(thumb: string, url: string, title: string, description: string, text: Content, chatId: ChatId, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -748,7 +748,7 @@ export declare class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail string Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendYoutubeLink(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -761,7 +761,7 @@ export declare class Client {
      * @param text string Custom text as body of the message, this needs to include the link or it will be appended after the link.
      * @param thumbnail Base64 of the jpeg/png which will be used to override the automatically generated thumbnail.
      * @param quotedMsgId [INSIDERS] Send this link preview message in response to a given quoted message
-     * @param customSize [INSIDERS] Anchor the size of the thumbnail (e.g {height: 100, width: 100})
+     * @param customSize [INSIDERS] Anchor the size of the thumbnail
      */
     sendLinkWithAutoPreview(to: ChatId, url: string, text?: Content, thumbnail?: Base64, quotedMsgId?: MessageId, customSize?: {
         height: number;
@@ -1400,10 +1400,6 @@ export declare class Client {
      *
      * Retrieves the groups that you have in common with a contact
      * @param contactId
-     * @returns Promise returning an array of common groups {
-     * id:string,
-     * title:string
-     * }
      */
     getCommonGroups(contactId: ContactId): Promise<{
         id: string;
@@ -1455,8 +1451,7 @@ export declare class Client {
     loadEarlierMessages(contactId: ContactId): Promise<Message[]>;
     /**
      * Get the status of a contact
-     * @param contactId {string} to '000000000000@c.us'
-     * returns: {id: string,status: string}
+     * @param contactId to '000000000000@c.us'
      */
     getStatus(contactId: ContactId): Promise<{
         id: string;
@@ -1474,8 +1469,18 @@ export declare class Client {
      *
      * Use a raw payload within your open-wa session
      *
+     * @example
+     * If there is a code block, then both TypeDoc and VSCode will treat
+     * text outside of the code block as regular text.
+     *
+     * ```ts
+     * await B('44123456789@c.us', {
+     *  test: 1
+     * })
+     * ```
+     * {@link loadAllEarlierMessages}
      * @param chatId
-     * @param payload {any}
+     * @param payload
      * returns: MessageId
      */
     B(chatId: ChatId, payload: {
@@ -1853,7 +1858,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. {@license:insiders@}
+     * @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>;
     /**
@@ -1861,7 +1866,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. {@license:insiders@}
+     * @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>;
     /**

package/dist/structures/preProcessors.d.ts

@@ -6,8 +6,9 @@ import { Message } from "../api/model/message";
  * @param message The message to be processed
  * @param client The client that received the message
  * @param alreadyProcessed Whether the message has already been processed by another preprocessor. (This is useful in cases where you want to mutate the message for both onMessage and onAnyMessage events but only want to do the actual process, like uploading to s3, once.)
+ * @param source The source of the message. This is useful for knowing if the message is from onMessage or onAnyMessage. Only processing one source will prevent duplicate processing.
  */
-export type MessagePreProcessor = (message: Message, client?: Client, alreadyProcessed?: boolean) => Promise<Message>;
+export type MessagePreProcessor = (message: Message, client?: Client, alreadyProcessed?: boolean, source?: 'onMessage' | 'onAnyMessage') => Promise<Message>;
 /**
  * An object that contains all available [[PREPROCESSORS]].
  *

package/package.json

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