Implementing addReaction function

DOCS.md

@@ -31,6 +31,7 @@
 * [`api.sendMessage`](#sendMessage)
 * [`api.sendTypingIndicator`](#sendTypingIndicator)
 * [`api.setOptions`](#setOptions)
+* [`api.setMessageReaction`](#setMessageReaction)
 * [`api.setTitle`](#setTitle)
 
 ---------------------------------------
@@ -607,6 +608,7 @@ If `type` is `message`, the object will contain the following fields:
   + `messageID`: A string representing the message ID.
   + `attachments`: An array of attachments to the message.
   + `isGroup`: boolean, true if this thread is a group thread (more than 2 participants).
+  + `reactions`: An array of reactions with key as userID and value as emoji
 
 If `attachments` contains an object with type `"sticker"`, the object will contain the following fields: `url`, `stickerID`, `packID`, `frameCount`, `frameRate`, `framesPerRow`, `framesPerCol`, `spriteURI`, `spriteURI2x`, `height`, `width`, `caption`, `description`.
 
@@ -651,6 +653,14 @@ Difference between `"read_receipt"` and `"read"`:
 - `"read_receipt"` event triggers when other people read the user's messages.
 - `"read"` event triggers when the user read other people's messages.
 
+If `type` is `"message_reaction"`, then the object will have following fields (enabled `listenEvents` required):
+- `"reaction"`: Contains reaction emoji
+- `"userId"`: The reaction senders ID
+- `"senderId"`: ID of author the message, where has been reaction added
+- `"messageId"`: The ID of message
+- `"threadId"`: ID of thread where has been message sent
+- `"offlineThreadingId"`: The offline message ID
+
 <a name="presence"></a>
 If enabled through [setOptions](#setOptions), `message` could also be a presence object, (`type` will be `"presence"`), which is the online status of the user's friends. That object given to the callback will have the following fields:
 - `type`: The string `"presence"`.
@@ -925,6 +935,30 @@ login({appState: JSON.parse(fs.readFileSync('appstate.json', 'utf8'))}, (err, ap
 });
 ```
 
+---------------------------------------
+
+<a name="setMessageReaction"></a>
+### api.setMessageReaction(reaction, messageID[, callback])
+
+Sets reaction on message
+
+__Arguments__
+
+* `reaction`: A string contains `emoji`, `emoji shortcut`, `emoji in unicode` or left `empty string` for delete reaction (look down for list of supported emojis)
+* `messageID`: A string or number representing a thread. It happens to be someone's userId in the case of a one to one conversation.
+* `callback(err)` - A callback called when sending the reaction is done.
+
+__Supported Emojis__
+
+* 😍 - Unicode: `\uD83D\uDE0D`, Shortcut: `:heart_eyes:`
+* 😆 - Unicode: `\uD83D\uDE06`, Shortcut: `:laughing:`
+* 😮 - Unicode: `\uD83D\uDE2E`, Shortcut: `:open_mouth:`
+* 😢 - Unicode: `\uD83D\uDE22`, Shortcut: `:cry:`
+* 😠 - Unicode: `\uD83D\uDE20`, Shortcut: `:angry:`
+* 👍 - Unicode: `\uD83D\uDC4D`, Shortcut: `:thumbsup:`
+* 👎 - Unicode: `\uD83D\uDC4E`, Shortcut: `:thumbsdown:`
+
+
 ---------------------------------------
 
 <a name="setTitle"></a>

README.md

@@ -71,6 +71,7 @@ Result:
 * [`api.sendMessage`](DOCS.md#sendMessage)
 * [`api.sendTypingIndicator`](DOCS.md#sendTypingIndicator)
 * [`api.setOptions`](DOCS.md#setOptions)
+* [`api.setMessageReaction`](DOCS.md#setMessageReaction)
 * [`api.setTitle`](DOCS.md#setTitle)
 
 ## Main Functionality

index.js

@@ -61,7 +61,8 @@ function buildAPI(globalOptions, html, jar) {
     clientID: clientID,
     globalOptions: globalOptions,
     loggedIn: true,
-    access_token: 'NONE'
+    access_token: 'NONE',
+    clientMutationId: 0
   };
 
   var api = {
@@ -100,6 +101,7 @@ function buildAPI(globalOptions, html, jar) {
     'searchForThread',
     'sendMessage',
     'sendTypingIndicator',
+    'setMessageReaction',
     'setTitle',
   ];
 

src/listen.js

@@ -152,6 +152,23 @@ module.exports = function(defaultFuncs, api, ctx) {
                 })(0)
                 break;
               }
+
+              if (v.delta.class == "ClientPayload") {
+                var clientPayload = utils.decodeClientPayload(v.delta.payload);
+                if (clientPayload && clientPayload.deltas) {
+                  for (var i in clientPayload.deltas) {
+                    var delta = clientPayload.deltas[i];
+                    if (delta.deltaMessageReaction) {
+                      delta.deltaMessageReaction.type = "message_reaction";
+                      delta.threadId = delta.threadKey.threadFbId;
+                      delete delta.threadKey;
+                      delete delta.action;
+                      globalCallback(null, delta.deltaMessageReaction);
+                    }
+                  }
+                  return;
+                }
+              }
 
               switch (v.delta.class) {
                 case 'ReadReceipt':

src/setMessageReaction.js

@@ -0,0 +1,75 @@
+"use strict";
+
+var utils = require("../utils");
+var log = require("npmlog");
+
+module.exports = function(defaultFuncs, api, ctx) {
+  return function setMessageReaction(reaction, messageID, callback) {
+    if(!callback) {
+      callback = function() {};
+    }
+
+    switch (reaction) {
+      case "\uD83D\uDE0D": //:heart_eyes:
+      case "\uD83D\uDE06": //:laughing:
+      case "\uD83D\uDE2E": //:open_mouth:
+      case "\uD83D\uDE22": //:cry:
+      case "\uD83D\uDE20": //:angry:
+      case "\uD83D\uDC4D": //:thumbsup:
+      case "\uD83D\uDC4E": //:thumbsdown:
+      case "":
+        //valid
+        break;
+      case ":heart_eyes:":
+        reaction = "\uD83D\uDE0D";
+      case ":laughing:":
+        reaction = "\uD83D\uDE06";
+      case ":open_mouth:":
+        reaction = "\uD83D\uDE2E";
+      case ":cry:":
+        reaction = "\uD83D\uDE22";
+      case ":angry:":
+        reaction = "\uD83D\uDE20";
+      case ":thumbsup:":
+        reaction = "\uD83D\uDC4D";
+      case ":thumbsdown:":
+        reaction = "\uD83D\uDC4E";
+      default:
+        return callback({error: "reaction is not valid emoji"});
+        break;
+    }
+
+    var variables = {
+      data: {
+        client_mutation_id: ctx.clientMutationId++,
+        actor_id: ctx.userID,
+        action: reaction == "" ? "REMOVE_REACTION" : "ADD_REACTION",
+        message_id: messageID,
+        reaction: reaction        
+      }
+    };
+
+    var qs = {
+      doc_id: "1491398900900362",
+      variables: JSON.stringify(variables),
+      dpr: 1
+    };
+
+    defaultFuncs
+      .postFormData("https://www.messenger.com/webgraphql/mutation/", ctx.jar, {}, qs)
+      .then(utils.parseAndCheckLogin(ctx.jar, defaultFuncs))
+      .then(function(resData) {
+        if (!resData) {
+          throw {error: "addReaction returned empty object."};
+        }
+        if(resData.error) {
+          throw resData;
+        }
+        callback(null);
+      })
+      .catch(function(err) {
+        log.error("addReaction", err);
+        return callback(err);
+      });
+  };
+};

utils.js

@@ -375,7 +375,8 @@ function formatDeltaMessage(m){
     messageID: md.messageId,
     attachments: (m.delta.attachments || []).map(v => _formatAttachment(v)),
     timestamp: md.timestamp,
-    isGroup: !!md.threadKey.threadFbId
+    isGroup: !!md.threadKey.threadFbId,
+    reactions: originalMessage.reactions ? originalMessage.reactions : []
   }
 }
 
@@ -397,7 +398,8 @@ function formatMessage(m) {
     timestampAbsolute: originalMessage.timestamp_absolute,
     timestampRelative: originalMessage.timestamp_relative,
     timestampDatetime: originalMessage.timestamp_datetime,
-    tags: originalMessage.tags
+    tags: originalMessage.tags,
+    reactions: originalMessage.reactions ? originalMessage.reactions : []
   };
 
   if(m.type === "pages_messaging") obj.pageID = m.realtime_viewer_fbid.toString();
@@ -718,6 +720,13 @@ function formatPresence(presence, userID) {
   };
 }
 
+function decodeClientPayload(payload) {
+  /*
+  Special function which Client using to "encode" clients JSON payload
+  */
+  return JSON.parse(String.fromCharCode.apply(null, payload));
+}
+
 function getAppState(jar){
   return jar
     .getCookies("https://www.facebook.com")
@@ -756,5 +765,6 @@ module.exports = {
   generatePresence: generatePresence,
   generateAccessiblityCookie: generateAccessiblityCookie,
   formatDate: formatDate,
+  decodeClientPayload: decodeClientPayload,
   getAppState: getAppState,
 };