@open-wa/wa-automate-types-only 4.33.2 → 4.33.3

package/dist/api/Client.d.ts

@@ -20,6 +20,7 @@ import { NextFunction, Request, Response } from 'express';
 import { Call } from './model/call';
 import { Button, Section } from './model/button';
 import { JsonObject } from 'type-fest';
+import { ReactionEvent } from './model/reactions';
 export declare enum namespace {
     Chat = "Chat",
     Msg = "Msg",
@@ -231,6 +232,16 @@ export declare class Client {
      * 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)
+     *
+     * Listens to reaction add and change events
+     *
+     * @event
+     * @param fn callback
+     * @fires [[ReactionEvent]]
+     */
+    onReaction(fn: (reactionEvent: ReactionEvent) => void): Promise<Listener | boolean>;
     /**
      * [REQUIRES AN INSIDERS LICENSE-KEY](https://gum.co/open-wa?tier=Insiders%20Program)
      *

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

@@ -86,5 +86,10 @@ export declare enum SimpleListener {
      * Requires licence
      * Represents [[onNewProduct]]
      */
-    NewProduct = "onNewProduct"
+    NewProduct = "onNewProduct",
+    /**
+     * Requires licence
+     * Represents [[onReaction]]
+     */
+    Reaction = "onReaction"
 }

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

@@ -0,0 +1,76 @@
+import { ContactId } from "./aliases";
+import { Message, MessageAck } from "./message";
+/**
+ * A reaction is identified the specific emoji.
+ */
+export declare type Reaction = {
+    /**
+     * The aggregate emoji used for the reaction.
+     */
+    aggregateEmoji: string;
+    /**
+     * The identifier of the reaction
+     */
+    id: string;
+    /**
+     * If the reaction is also sent by the host account
+     */
+    hasReactionByMe: boolean;
+    /**
+     * The senders of this spefcific reaction
+     */
+    senders: ReactionRecord[];
+};
+/**
+ * The specific reaction by a user
+ */
+export declare type ReactionRecord = {
+    /**
+     * The acknowledgement of the reaction
+     */
+    ack: MessageAck;
+    /**
+     * The ID of the reaction
+     */
+    id: string;
+    msgKey: string;
+    parentMsgKey: string;
+    orphan: number;
+    /**
+     * The text of the reaction
+     */
+    reactionText: string;
+    /**
+     * If the reaction has been read
+     */
+    read: boolean;
+    /**
+     * The ID of the reaction sender
+     */
+    senderUserJid: ContactId;
+    /**
+     * The timestamp of the reaction
+     */
+    timestamp: number;
+};
+/**
+ * Emitted by onReaction
+ */
+export declare type ReactionEvent = {
+    /**
+     * The message being reacted to
+     */
+    message: Message;
+    /**
+     * The reaction sent by the host account
+     */
+    reactionByMe: Reaction;
+    /**
+     * An array of all reactions
+     */
+    reactions: Reaction[];
+    /**
+     * The type of the reaction event.
+     */
+    type: 'add' | 'change';
+};

package/package.json

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