Merge pull request #2799 from ghayman/reaction-callback

Added onMessageReaction() listener and callback

src/api/helpers/exposed.enum.ts

@@ -2,6 +2,7 @@ export enum ExposedFn {
   OnMessage = 'onMessage',
   OnMessageEdit = 'onMessageEdit',
   OnMessageDelete = 'onMessageDelete',
+  OnMessageReaction = 'onMessageReaction',
   OnAnyMessage = 'onAnyMessage',
   onAck = 'onAck',
   onParticipantsChanged = 'onParticipantsChanged',

src/api/layers/listener.layer.ts

@@ -7,6 +7,7 @@ import {
   Chat,
   LiveLocation,
   Message,
+  Reaction,
   ParticipantEvent,
   PicTumb,
   ChatStatus
@@ -24,6 +25,7 @@ declare global {
     onAnyMessage: any;
     onMessageEdit: any;
     onMessageDelete: any;
+    onMessageReaction: any;
     onStateChange: any;
     onIncomingCall: any;
     onAck: any;
@@ -112,6 +114,9 @@ export class ListenerLayer extends ProfileLayer {
         window.WAPI.onMessageDelete((e: any) => {
           window.onMessageDelete(e);
         });
+        window.WAPI.onMessageReaction((e: any) => {
+          window.onMessageReaction(e);
+        });
         window.WAPI.onPoll((e: any) => {
           window.onPoll(e);
         });
@@ -123,7 +128,8 @@ export class ListenerLayer extends ProfileLayer {
     this.page
       .evaluate(() => {
         let isHeroEqual = {};
-        // try {
+
+        // Install the new message listener (add event)
         window.Store.Msg.on('add', async (newMessage) => {
           if (!Object.is(isHeroEqual, newMessage)) {
             isHeroEqual = newMessage;
@@ -138,6 +144,7 @@ export class ListenerLayer extends ProfileLayer {
           }
         });
 
+        // Install the changed message / deleted message listener (change:body change:caption events)
         window.Store.Msg.on(
           'change:body change:caption',
           async (newMessage) => {
@@ -148,6 +155,7 @@ export class ListenerLayer extends ProfileLayer {
                 false
               );
 
+              // Edit or Delete?
               if (newMessage.type == 'revoked') {
                 window.onMessageDelete(processMessageObj);
               } else {
@@ -156,7 +164,17 @@ export class ListenerLayer extends ProfileLayer {
             }
           }
         );
-        // } catch { }
+
+        // Install the message reaction listener
+        // This is a strange one - seems like the way to do it is to override the WhatsApp WAWebAddonReactionTableMode.reactionTableMode.bulkUpsert function
+        const module = window.Store.Reaction.reactionTableMode;
+        const ogMethod = module.bulkUpsert;
+        module.bulkUpsert = ((...args) => {
+          if (args[0].length > 0) {
+            window.onMessageReaction(args[0][0]);
+          }
+          return ogMethod(...args);
+        }).bind(module);
       })
       .catch(() => {});
   }
@@ -229,6 +247,24 @@ export class ListenerLayer extends ProfileLayer {
     };
   }
 
+  /**
+   * @event Listens for reactions to messages
+   * @param fn
+   */
+  public async onMessageReaction(fn: (reaction: Reaction) => void) {
+    this.listenerEmitter.on(ExposedFn.OnMessageReaction, (reaction) => {
+      fn(reaction);
+    });
+
+    return {
+      dispose: () => {
+        this.listenerEmitter.off(ExposedFn.OnMessageReaction, (reaction) => {
+          fn(reaction);
+        });
+      }
+    };
+  }
+
   /**
    * @event Listens to messages received
    * @returns Observable stream of messages

src/api/model/index.ts

@@ -3,6 +3,7 @@ export { Contact } from './contact';
 export { GroupMetadata } from './group-metadata';
 export { Id } from './id';
 export { Message } from './message';
+export { Reaction } from './reaction';
 export { ParticipantEvent } from './participant-event';
 export { PartialMessage } from './partial-message';
 export { Ack } from './ack';

src/api/model/reaction.ts

@@ -0,0 +1,25 @@
+export interface Reaction {
+  id: ReactionKey;
+  from: string;
+  to: string;
+  type: string;
+  t: number;
+  ack: number;
+  author: string;
+  notifyName: string;
+  invis: boolean;
+  count: number;
+  kind: string;
+  reactionParentKey: ReactionKey;
+  reactionText: string;
+  reactionTimestamp: number;
+  read: boolean;
+}
+
+export interface ReactionKey {
+  fromMe: boolean;
+  remote: string;
+  id: string;
+  participant: string;
+  _serialized: string;
+}

src/lib/wapi/store/store-objects.js

@@ -423,6 +423,10 @@ export const storeObjects = [
     id: 'Reactions',
     conditions: (module) => (module.sendReactionToMsg ? module : null),
   },
+  {
+    id: 'Reaction',
+    conditions: (module) => (module.reactionTableMode ? module : null),
+  },
   {
     id: 'CheckWid',
     conditions: (module) => (module.validateWid ? module : null),

src/types/WAPI.d.ts

@@ -16,6 +16,7 @@ interface WAPI {
   onAnyMessage: (callback: Function) => void;
   onMessageEdit: (callback: Function) => void;
   onMessageDelete: (callback: Function) => void;
+  onMessageReaction: (callback: Function) => void;
   archiveChat: (chatId: string, option: boolean) => boolean;
   arrayBufferToBase64: (buffer: ArrayBuffer) => string;
   blockContact: (messageId: string) => boolean;