shadowx-fca 1.2.0 → 2.0.0

package/utils.js

@@ -1,6 +1,6 @@
-
 // @ts-nocheck
 /* eslint-disable no-undef */
+
 /* eslint-disable no-prototype-builtins */
 
 "use strict";
@@ -14,6 +14,7 @@ var request = bluebird.promisify(require("request").defaults({ jar: true }));
 /**
  * @param {any} url
  */
+
 function setProxy(url) {
     if (typeof url == "undefined") return request = bluebird.promisify(require("request").defaults({ jar: true }));
     return request = bluebird.promisify(require("request").defaults({ jar: true, proxy: url }));
@@ -25,6 +26,7 @@ function setProxy(url) {
  * @param {{ region: any; }} [ctx]
  * @param {undefined} [customHeader]
  */
+
 function getHeaders(url, options, ctx, customHeader) {
     var headers = {
         "Content-Type": "application/x-www-form-urlencoded",
@@ -45,6 +47,7 @@ function getHeaders(url, options, ctx, customHeader) {
 /**
  * @param {{ _read: any; _readableState: any; }} obj
  */
+
 function isReadableStream(obj) {
     return (
         obj instanceof stream.Stream &&
@@ -61,7 +64,9 @@ function isReadableStream(obj) {
  * @param {any} options
  * @param {any} ctx
  */
+
 function get(url, jar, qs, options, ctx) {
+    // I'm still confused about this
     if (getType(qs) === "Object")
         for (var prop in qs)
             if (qs.hasOwnProperty(prop) && getType(qs[prop]) === "Object") qs[prop] = JSON.stringify(qs[prop]);
@@ -98,11 +103,16 @@ function post(url, jar, form, options, ctx, customHeader) {
 /**
  * @param {any} url
  * @param {any} jar
- * @param {{ __user: any; __req: string; __rev: any; __a: number; fb_dtsg: any; jazoest: any; }} form
- * @param {{ __user: any; __req: string; __rev: any; __a: number; fb_dtsg: any; jazoest: any; }} qs
+ * @param {{ __user: any; __req: string; __rev: any; __a: number; 
+// __af: siteData.features,
+fb_dtsg: any; jazoest: any; }} form
+ * @param {{ __user: any; __req: string; __rev: any; __a: number; 
+// __af: siteData.features,
+fb_dtsg: any; jazoest: any; }} qs
  * @param {any} options
  * @param {any} ctx
  */
+
 function postFormData(url, jar, form, qs, options, ctx) {
     var headers = getHeaders(url, options, ctx);
     headers["Content-Type"] = "multipart/form-data";
@@ -126,6 +136,7 @@ function postFormData(url, jar, form, qs, options, ctx) {
  * @param {string | number | any[]} val
  * @param {number} [len]
  */
+
 function padZeros(val, len) {
     val = String(val);
     len = len || 2;
@@ -136,6 +147,7 @@ function padZeros(val, len) {
 /**
  * @param {any} clientID
  */
+
 function generateThreadingID(clientID) {
     var k = Date.now();
     var l = Math.floor(Math.random() * 4294967295);
@@ -146,6 +158,7 @@ function generateThreadingID(clientID) {
 /**
  * @param {string | any[]} data
  */
+
 function binaryToDecimal(data) {
     var ret = "";
     while (data !== "0") {
@@ -217,6 +230,7 @@ var j = {
 /**
  * @param {string | number | boolean} str
  */
+
 function presenceEncode(str) {
     return encodeURIComponent(str)
         .replace(/([_A-Z])|%../g, function (m, n) {
@@ -228,9 +242,11 @@ function presenceEncode(str) {
         });
 }
 
+// eslint-disable-next-line no-unused-vars
 /**
  * @param {string} str
  */
+
 function presenceDecode(str) {
     return decodeURIComponent(
         str.replace(/[_A-Z]/g, function (/** @type {string | number} */m) {
@@ -242,6 +258,7 @@ function presenceDecode(str) {
 /**
  * @param {string} userID
  */
+
 function generatePresence(userID) {
     var time = Date.now();
     return (
@@ -285,10 +302,20 @@ function generateAccessiblityCookie() {
 }
 
 function getGUID() {
+    /** @type {number} */
+
     var sectionLength = Date.now();
+    /** @type {string} */
+
     var id = "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function (c) {
+        /** @type {number} */
+
         var r = Math.floor((sectionLength + Math.random() * 16) % 16);
+        /** @type {number} */
+
         sectionLength = Math.floor(sectionLength / 16);
+        /** @type {string} */
+
         var _guid = (c == "x" ? r : (r & 7) | 8).toString(16);
         return _guid;
     });
@@ -299,7 +326,15 @@ function getGUID() {
  * @param {{ mercury: any; blob_attachment: any; attach_type: any; sticker_attachment: any; extensible_attachment: { story_attachment: { target: { __typename: string; }; }; }; metadata: { stickerID: { toString: () => any; }; packID: { toString: () => any; }; spriteURI: any; spriteURI2x: any; width: any; height: any; frameCount: any; frameRate: any; framesPerRow: any; framesPerCol: any; fbid: { toString: () => any; }; url: any; dimensions: { split: (arg0: string) => any[]; width: any; height: any; }; duration: any; }; url: any; name: any; fileName: any; thumbnail_url: any; preview_url: any; preview_width: any; preview_height: any; large_preview_url: any; large_preview_width: any; large_preview_height: any; share: { share_id: { toString: () => any; }; title: any; description: any; source: any; media: { image: any; image_size: { width: any; height: any; }; playable: any; duration: any; animated_image_size: any; }; subattachments: any; uri: any; target: any; style_list: any; }; }} attachment1
  * @param {{ caption?: any; description?: any; id: any; is_malicious?: any; mime_type?: any; file_size?: any; filename?: any; image_data: any; href?: any; }} [attachment2]
  */
+
 function _formatAttachment(attachment1, attachment2) {
+    // TODO: THIS IS REALLY BAD
+    // This is an attempt at fixing Facebook's inconsistencies. Sometimes they give us
+    // two attachment objects, but sometimes only one. They each contain part of the
+    // data that you'd want so we merge them for convenience.
+    // Instead of having a bunch of if statements guarding every access to image_data,
+    // we set it to empty object and use the fact that it'll return undefined.
+
     attachment2 = attachment2 || { id: "", image_data: {} };
     attachment1 = attachment1.mercury ? attachment1.mercury : attachment1;
     var blob = attachment1.blob_attachment;
@@ -319,27 +354,32 @@ function _formatAttachment(attachment1, attachment2) {
 
         blob = attachment1.extensible_attachment;
     }
-    
+    // TODO: Determine whether "sticker", "photo", "file" etc are still used
+    // KEEP IN SYNC WITH getThreadHistory
     switch (type) {
         case "sticker":
             return {
                 type: "sticker",
                 ID: attachment1.metadata.stickerID.toString(),
                 url: attachment1.url,
+
                 packID: attachment1.metadata.packID.toString(),
                 spriteUrl: attachment1.metadata.spriteURI,
                 spriteUrl2x: attachment1.metadata.spriteURI2x,
                 width: attachment1.metadata.width,
                 height: attachment1.metadata.height,
+
                 caption: attachment2.caption,
                 description: attachment2.description,
+
                 frameCount: attachment1.metadata.frameCount,
                 frameRate: attachment1.metadata.frameRate,
                 framesPerRow: attachment1.metadata.framesPerRow,
                 framesPerCol: attachment1.metadata.framesPerCol,
-                stickerID: attachment1.metadata.stickerID.toString(),
-                spriteURI: attachment1.metadata.spriteURI,
-                spriteURI2x: attachment1.metadata.spriteURI2x
+
+                stickerID: attachment1.metadata.stickerID.toString(), // @Legacy
+                spriteURI: attachment1.metadata.spriteURI, // @Legacy
+                spriteURI2x: attachment1.metadata.spriteURI2x // @Legacy
             };
         case "file":
             return {
@@ -347,11 +387,13 @@ function _formatAttachment(attachment1, attachment2) {
                 filename: attachment1.name,
                 ID: attachment2.id.toString(),
                 url: attachment1.url,
+
                 isMalicious: attachment2.is_malicious,
                 contentType: attachment2.mime_type,
-                name: attachment1.name,
-                mimeType: attachment2.mime_type,
-                fileSize: attachment2.file_size
+
+                name: attachment1.name, // @Legacy
+                mimeType: attachment2.mime_type, // @Legacy
+                fileSize: attachment2.file_size // @Legacy
             };
         case "photo":
             return {
@@ -359,77 +401,94 @@ function _formatAttachment(attachment1, attachment2) {
                 ID: attachment1.metadata.fbid.toString(),
                 filename: attachment1.fileName,
                 thumbnailUrl: attachment1.thumbnail_url,
+
                 previewUrl: attachment1.preview_url,
                 previewWidth: attachment1.preview_width,
                 previewHeight: attachment1.preview_height,
+
                 largePreviewUrl: attachment1.large_preview_url,
                 largePreviewWidth: attachment1.large_preview_width,
                 largePreviewHeight: attachment1.large_preview_height,
-                url: attachment1.metadata.url,
-                width: attachment1.metadata.dimensions.split(",")[0],
-                height: attachment1.metadata.dimensions.split(",")[1],
-                name: attachment1.fileName
+
+                url: attachment1.metadata.url, // @Legacy
+                width: attachment1.metadata.dimensions.split(",")[0], // @Legacy
+                height: attachment1.metadata.dimensions.split(",")[1], // @Legacy
+                name: attachment1.fileName // @Legacy
             };
         case "animated_image":
             return {
                 type: "animated_image",
                 ID: attachment2.id.toString(),
                 filename: attachment2.filename,
+
                 previewUrl: attachment1.preview_url,
                 previewWidth: attachment1.preview_width,
                 previewHeight: attachment1.preview_height,
+
                 url: attachment2.image_data.url,
                 width: attachment2.image_data.width,
                 height: attachment2.image_data.height,
-                name: attachment1.name,
-                facebookUrl: attachment1.url,
-                thumbnailUrl: attachment1.thumbnail_url,
-                mimeType: attachment2.mime_type,
-                rawGifImage: attachment2.image_data.raw_gif_image,
-                rawWebpImage: attachment2.image_data.raw_webp_image,
-                animatedGifUrl: attachment2.image_data.animated_gif_url,
-                animatedGifPreviewUrl: attachment2.image_data.animated_gif_preview_url,
-                animatedWebpUrl: attachment2.image_data.animated_webp_url,
-                animatedWebpPreviewUrl: attachment2.image_data.animated_webp_preview_url
+
+                name: attachment1.name, // @Legacy
+                facebookUrl: attachment1.url, // @Legacy
+                thumbnailUrl: attachment1.thumbnail_url, // @Legacy
+                mimeType: attachment2.mime_type, // @Legacy
+                rawGifImage: attachment2.image_data.raw_gif_image, // @Legacy
+                rawWebpImage: attachment2.image_data.raw_webp_image, // @Legacy
+                animatedGifUrl: attachment2.image_data.animated_gif_url, // @Legacy
+                animatedGifPreviewUrl: attachment2.image_data.animated_gif_preview_url, // @Legacy
+                animatedWebpUrl: attachment2.image_data.animated_webp_url, // @Legacy
+                animatedWebpPreviewUrl: attachment2.image_data.animated_webp_preview_url // @Legacy
             };
         case "share":
             return {
                 type: "share",
                 ID: attachment1.share.share_id.toString(),
                 url: attachment2.href,
+
                 title: attachment1.share.title,
                 description: attachment1.share.description,
                 source: attachment1.share.source,
+
                 image: attachment1.share.media.image,
                 width: attachment1.share.media.image_size.width,
                 height: attachment1.share.media.image_size.height,
                 playable: attachment1.share.media.playable,
                 duration: attachment1.share.media.duration,
+
                 subattachments: attachment1.share.subattachments,
                 properties: {},
-                animatedImageSize: attachment1.share.media.animated_image_size,
-                facebookUrl: attachment1.share.uri,
-                target: attachment1.share.target,
-                styleList: attachment1.share.style_list
+
+                animatedImageSize: attachment1.share.media.animated_image_size, // @Legacy
+                facebookUrl: attachment1.share.uri, // @Legacy
+                target: attachment1.share.target, // @Legacy
+                styleList: attachment1.share.style_list // @Legacy
             };
         case "video":
             return {
                 type: "video",
                 ID: attachment1.metadata.fbid.toString(),
                 filename: attachment1.name,
+
                 previewUrl: attachment1.preview_url,
                 previewWidth: attachment1.preview_width,
                 previewHeight: attachment1.preview_height,
+
                 url: attachment1.url,
                 width: attachment1.metadata.dimensions.width,
                 height: attachment1.metadata.dimensions.height,
+
                 duration: attachment1.metadata.duration,
                 videoType: "unknown",
-                thumbnailUrl: attachment1.thumbnail_url
+
+                thumbnailUrl: attachment1.thumbnail_url // @Legacy
             };
         case "error":
             return {
                 type: "error",
+
+                // Save error attachments because we're unsure of their format,
+                // and whether there are cases they contain something useful for debugging.
                 attachment1: attachment1,
                 attachment2: attachment2
             };
@@ -439,60 +498,72 @@ function _formatAttachment(attachment1, attachment2) {
                 ID: blob.legacy_attachment_id,
                 filename: blob.filename,
                 thumbnailUrl: blob.thumbnail.uri,
+
                 previewUrl: blob.preview.uri,
                 previewWidth: blob.preview.width,
                 previewHeight: blob.preview.height,
+
                 largePreviewUrl: blob.large_preview.uri,
                 largePreviewWidth: blob.large_preview.width,
                 largePreviewHeight: blob.large_preview.height,
-                url: blob.large_preview.uri,
-                width: blob.original_dimensions.x,
-                height: blob.original_dimensions.y,
-                name: blob.filename
+
+                url: blob.large_preview.uri, // @Legacy
+                width: blob.original_dimensions.x, // @Legacy
+                height: blob.original_dimensions.y, // @Legacy
+                name: blob.filename // @Legacy
             };
         case "MessageAnimatedImage":
             return {
                 type: "animated_image",
                 ID: blob.legacy_attachment_id,
                 filename: blob.filename,
+
                 previewUrl: blob.preview_image.uri,
                 previewWidth: blob.preview_image.width,
                 previewHeight: blob.preview_image.height,
+
                 url: blob.animated_image.uri,
                 width: blob.animated_image.width,
                 height: blob.animated_image.height,
-                thumbnailUrl: blob.preview_image.uri,
-                name: blob.filename,
-                facebookUrl: blob.animated_image.uri,
-                rawGifImage: blob.animated_image.uri,
-                animatedGifUrl: blob.animated_image.uri,
-                animatedGifPreviewUrl: blob.preview_image.uri,
-                animatedWebpUrl: blob.animated_image.uri,
-                animatedWebpPreviewUrl: blob.preview_image.uri
+
+                thumbnailUrl: blob.preview_image.uri, // @Legacy
+                name: blob.filename, // @Legacy
+                facebookUrl: blob.animated_image.uri, // @Legacy
+                rawGifImage: blob.animated_image.uri, // @Legacy
+                animatedGifUrl: blob.animated_image.uri, // @Legacy
+                animatedGifPreviewUrl: blob.preview_image.uri, // @Legacy
+                animatedWebpUrl: blob.animated_image.uri, // @Legacy
+                animatedWebpPreviewUrl: blob.preview_image.uri // @Legacy
             };
         case "MessageVideo":
             return {
                 type: "video",
                 filename: blob.filename,
                 ID: blob.legacy_attachment_id,
+
                 previewUrl: blob.large_image.uri,
                 previewWidth: blob.large_image.width,
                 previewHeight: blob.large_image.height,
+
                 url: blob.playable_url,
                 width: blob.original_dimensions.x,
                 height: blob.original_dimensions.y,
+
                 duration: blob.playable_duration_in_ms,
                 videoType: blob.video_type.toLowerCase(),
-                thumbnailUrl: blob.large_image.uri
+
+                thumbnailUrl: blob.large_image.uri // @Legacy
             };
         case "MessageAudio":
             return {
                 type: "audio",
                 filename: blob.filename,
                 ID: blob.url_shimhash,
+
                 audioType: blob.audio_type,
                 duration: blob.playable_duration_in_ms,
                 url: blob.playable_url,
+
                 isVoiceMail: blob.is_voicemail
             };
         case "StickerAttachment":
@@ -500,43 +571,54 @@ function _formatAttachment(attachment1, attachment2) {
                 type: "sticker",
                 ID: blob.id,
                 url: blob.url,
+
                 packID: blob.pack ? blob.pack.id : null,
                 spriteUrl: blob.sprite_image,
                 spriteUrl2x: blob.sprite_image_2x,
                 width: blob.width,
                 height: blob.height,
+
                 caption: blob.label,
                 description: blob.label,
+
                 frameCount: blob.frame_count,
                 frameRate: blob.frame_rate,
                 framesPerRow: blob.frames_per_row,
                 framesPerCol: blob.frames_per_column,
-                stickerID: blob.id,
-                spriteURI: blob.sprite_image,
-                spriteURI2x: blob.sprite_image_2x
+
+                stickerID: blob.id, // @Legacy
+                spriteURI: blob.sprite_image, // @Legacy
+                spriteURI2x: blob.sprite_image_2x // @Legacy
             };
         case "MessageLocation":
             var urlAttach = blob.story_attachment.url;
             var mediaAttach = blob.story_attachment.media;
+
             var u = querystring.parse(url.parse(urlAttach).query).u;
             var where1 = querystring.parse(url.parse(u).query).where1;
             var address = where1.split(", ");
+
             var latitude;
             var longitude;
+
             try {
                 latitude = Number.parseFloat(address[0]);
                 longitude = Number.parseFloat(address[1]);
             } catch (err) {
                 /* empty */
+
             }
+
             var imageUrl;
             var width;
             var height;
+
             if (mediaAttach && mediaAttach.image) {
                 imageUrl = mediaAttach.image.uri;
                 width = mediaAttach.image.width;
                 height = mediaAttach.image.height;
             }
+
             return {
                 type: "location",
                 ID: blob.legacy_attachment_id,
@@ -547,19 +629,22 @@ function _formatAttachment(attachment1, attachment2) {
                 height: height,
                 url: u || urlAttach,
                 address: where1,
-                facebookUrl: blob.story_attachment.url,
-                target: blob.story_attachment.target,
-                styleList: blob.story_attachment.style_list
+
+                facebookUrl: blob.story_attachment.url, // @Legacy
+                target: blob.story_attachment.target, // @Legacy
+                styleList: blob.story_attachment.style_list // @Legacy
             };
         case "ExtensibleAttachment":
             return {
                 type: "share",
                 ID: blob.legacy_attachment_id,
                 url: blob.story_attachment.url,
+
                 title: blob.story_attachment.title_with_entities.text,
                 description: blob.story_attachment.description &&
                     blob.story_attachment.description.text,
                 source: blob.story_attachment.source ? blob.story_attachment.source.text : null,
+
                 image: blob.story_attachment.media &&
                     blob.story_attachment.media.image &&
                     blob.story_attachment.media.image.uri,
@@ -574,23 +659,27 @@ function _formatAttachment(attachment1, attachment2) {
                 duration: blob.story_attachment.media &&
                     blob.story_attachment.media.playable_duration_in_ms,
                 playableUrl: blob.story_attachment.media == null ? null : blob.story_attachment.media.playable_url,
+
                 subattachments: blob.story_attachment.subattachments,
                 properties: blob.story_attachment.properties.reduce(function (/** @type {{ [x: string]: any; }} */obj, /** @type {{ key: string | number; value: { text: any; }; }} */cur) {
                     obj[cur.key] = cur.value.text;
                     return obj;
                 }, {}),
-                facebookUrl: blob.story_attachment.url,
-                target: blob.story_attachment.target,
-                styleList: blob.story_attachment.style_list
+
+                facebookUrl: blob.story_attachment.url, // @Legacy
+                target: blob.story_attachment.target, // @Legacy
+                styleList: blob.story_attachment.style_list // @Legacy
             };
         case "MessageFile":
             return {
                 type: "file",
                 filename: blob.filename,
                 ID: blob.message_file_fbid,
+
                 url: blob.url,
                 isMalicious: blob.is_malicious,
                 contentType: blob.content_type,
+
                 name: blob.filename,
                 mimeType: "",
                 fileSize: -1
@@ -614,6 +703,7 @@ function _formatAttachment(attachment1, attachment2) {
  * @param {{ [x: string]: any; }} attachmentMap
  * @param {any} shareMap
  */
+
 function formatAttachment(attachments, attachmentIds, attachmentMap, shareMap) {
     attachmentMap = shareMap || attachmentMap;
     return attachments ?
@@ -628,61 +718,20 @@ function formatAttachment(attachments, attachmentIds, attachmentMap, shareMap) {
         }) : [];
 }
 
-/**
- * Extract mentions from message - supports legacy (data.prng) and new format (messageMetadata.data.data.Gb.asMap.data).
- * @param {Object} m - Raw message object (NewMessage delta)
- * @returns {Object} mentions - Map of userID -> mention text
- */
-function getMentionsFromDeltaMessage(m) {
-    var body = m.body || "";
-    var mentions = {};
-    var mdata = [];
-    if (m.data && m.data.prng) {
-        try {
-            mdata = JSON.parse(m.data.prng);
-        } catch (e) {
-            mdata = [];
-        }
-    }
-    if (mdata.length > 0) {
-        for (var i = 0; i < mdata.length; i++) {
-            var id = mdata[i].i;
-            var o = parseInt(mdata[i].o, 10) || 0;
-            var l = parseInt(mdata[i].l, 10) || 0;
-            mentions[String(id)] = body.substring(o, o + l);
-        }
-        return mentions;
-    }
-    var md = m.messageMetadata;
-    if (md && md.data && md.data.data && md.data.data.Gb && md.data.data.Gb.asMap && md.data.data.Gb.asMap.data) {
-        var gbData = md.data.data.Gb.asMap.data;
-        for (var key in gbData) {
-            if (!Object.prototype.hasOwnProperty.call(gbData, key)) continue;
-            var entry = gbData[key];
-            if (entry && entry.asMap && entry.asMap.data) {
-                var d = entry.asMap.data;
-                var id = d.id && d.id.asLong ? String(d.id.asLong) : null;
-                var offset = parseInt((d.offset && d.offset.asLong) ? d.offset.asLong : 0, 10);
-                var len = parseInt((d.length && d.length.asLong) ? d.length.asLong : 0, 10);
-                if (id != null) {
-                    mentions[id] = body.substring(offset, offset + len);
-                }
-            }
-        }
-    }
-    return mentions;
-}
-
 /**
  * @param {{ delta: { messageMetadata: any; data: { prng: string; }; body: string; attachments: any; participants: any; }; }} m
  */
+
 function formatDeltaMessage(m) {
     var md = m.delta.messageMetadata;
+    var mdata = m.delta.data === undefined ? [] : m.delta.data.prng === undefined ? [] : JSON.parse(m.delta.data.prng);
+    var m_id = mdata.map(u => u.i);
+    var m_offset = mdata.map(u => u.o);
+    var m_length = mdata.map(u => u.l);
+    var mentions = {};
     var body = m.delta.body || "";
-    
-    // Use the new improved mention extraction function
-    var mentions = getMentionsFromDeltaMessage(m.delta);
     var args = body == "" ? [] : body.trim().split(/\s+/);
+    for (var i = 0; i < m_id.length; i++) mentions[m_id[i]] = m.delta.body.substring(m_offset[i], m_offset[i] + m_length[i]);
 
     // Determine if this is a DM or group
     const otherUserFbId = md.threadKey.otherUserFbId;
@@ -701,8 +750,7 @@ function formatDeltaMessage(m) {
         timestamp: md.timestamp,
         isGroup: !!threadFbId,
         isSingleUser: isSingleUser,
-        participantIDs: m.delta.participants || (md.cid ? md.cid.canonicalParticipantFbids : []) || [],
-        isUnread: md.isUnread !== undefined ? md.isUnread : false
+        participantIDs: m.delta.participants || (md.cid ? md.cid.canonicalParticipantFbids : []) || []
     };
 }
 
@@ -712,6 +760,7 @@ function formatID(id) {
 }
 
 function isDMThread(threadID) {
+    // DM threads don't have 't_' prefix and are typically numeric user IDs
     return typeof threadID === 'string' && !threadID.includes('t_');
 }
 
@@ -779,6 +828,7 @@ function formatHistoryMessage(m) {
 /**
  * @param {{ type: any; }} m
  */
+
 function getAdminTextMessageType(m) {
     switch (m.type) {
         case "joinable_group_link_mode_change":
@@ -788,7 +838,6 @@ function getAdminTextMessageType(m) {
         case "change_thread_theme":
             return "log:thread-color";
         case "change_thread_icon":
-        case "change_thread_quick_reaction":
             return "log:thread-icon";
         case "change_thread_nickname":
             return "log:user-nickname";
@@ -803,16 +852,13 @@ function getAdminTextMessageType(m) {
             return "log:thread-call";
         case "pin_messages_v2":
             return "log:thread-pinned";
-        case "unpin_messages_v2":
-            return "log:unpin-message";
-        default:
-            return m.type;
     }
 }
 
 /**
  * @param {string} name
  */
+
 function getGenderByPhysicalMethod(name) {
     const female_name = [
         "Phương Chi",
@@ -2151,64 +2197,21 @@ function getGenderByPhysicalMethod(name) {
     return Name || "UNKNOWN";
 }
 
-/**
- * Extract mentions from message - supports legacy (data.prng) and new format (messageMetadata.data.data.Gb.asMap.data).
- * @param {Object} m - Raw message object (NewMessage delta)
- * @returns {Object} mentions - Map of userID -> mention text
- */
-function getMentionsFromDeltaMessage(m) {
-    var body = m.body || "";
-    var mentions = {};
-    var mdata = [];
-    
-    // Try legacy format (data.prng)
-    if (m.data && m.data.prng) {
-        try {
-            mdata = JSON.parse(m.data.prng);
-        } catch (e) {
-            mdata = [];
-        }
-    }
-    
-    if (mdata.length > 0) {
-        for (var i = 0; i < mdata.length; i++) {
-            var id = mdata[i].i;
-            var o = parseInt(mdata[i].o, 10) || 0;
-            var l = parseInt(mdata[i].l, 10) || 0;
-            mentions[String(id)] = body.substring(o, o + l);
-        }
-        return mentions;
-    }
-    
-    // Try new format (messageMetadata.data.data.Gb.asMap.data)
-    var md = m.messageMetadata;
-    if (md && md.data && md.data.data && md.data.data.Gb && 
-        md.data.data.Gb.asMap && md.data.data.Gb.asMap.data) {
-        var gbData = md.data.data.Gb.asMap.data;
-        for (var key in gbData) {
-            if (!Object.prototype.hasOwnProperty.call(gbData, key)) continue;
-            var entry = gbData[key];
-            if (entry && entry.asMap && entry.asMap.data) {
-                var d = entry.asMap.data;
-                var id = d.id && d.id.asLong ? String(d.id.asLong) : null;
-                var offset = parseInt((d.offset && d.offset.asLong) ? d.offset.asLong : 0, 10);
-                var len = parseInt((d.length && d.length.asLong) ? d.length.asLong : 0, 10);
-                if (id != null) {
-                    mentions[id] = body.substring(offset, offset + len);
-                }
-            }
-        }
-    }
-    return mentions;
-}
-
 /**
  * @param {{ [x: string]: { [x: string]: { [x: string]: any; }; }; class: any; untypedData: any; name: any; addedParticipants: any; leftParticipantFbId: any; messageMetadata: { threadKey: { threadFbId: any; otherUserFbId: any; }; adminText: any; actorFbId: any; }; participants: any; }} m
  */
+
 function formatDeltaEvent(m) {
     var logMessageType;
     var logMessageData;
 
+    // log:thread-color => {theme_color}
+    // log:user-nickname => {participant_id, nickname}
+    // log:thread-icon => {thread_icon}
+    // log:thread-name => {name}
+    // log:subscribe => {addedParticipants - [Array]}
+    // log:unsubscribe => {leftParticipantFbId}
+    // console.log(m)
     switch (m.class) {
         case "JoinableMode":
             if (m.mode) return;
@@ -2244,47 +2247,17 @@ function formatDeltaEvent(m) {
     };
 }
 
-/**
- * @param {{ delta: { messageMetadata: any; data: { prng: string; }; body: string; attachments: any; participants: any; }; }} m
- */
-function formatDeltaMessage(m) {
-    var md = m.delta.messageMetadata;
-    var body = m.delta.body || "";
-    
-    // Use the new mention extraction function
-    var mentions = getMentionsFromDeltaMessage(m.delta);
-    var args = body == "" ? [] : body.trim().split(/\s+/);
-
-    // Determine if this is a DM or group
-    const otherUserFbId = md.threadKey.otherUserFbId;
-    const threadFbId = md.threadKey.threadFbId;
-    const isSingleUser = !!otherUserFbId && !threadFbId;
-
-    return {
-        type: "message",
-        senderID: formatID(md.actorFbId.toString()),
-        threadID: formatID((threadFbId || otherUserFbId).toString()),
-        messageID: md.messageId,
-        args: args,
-        body: body,
-        attachments: (m.delta.attachments || []).map(v => _formatAttachment(v)),
-        mentions: mentions,
-        timestamp: md.timestamp,
-        isGroup: !!threadFbId,
-        isSingleUser: isSingleUser,
-        participantIDs: m.delta.participants || (md.cid ? md.cid.canonicalParticipantFbids : []) || [],
-        isUnread: md.isUnread !== undefined ? md.isUnread : false
-    };
-}
-
 /**
  * @param {{ st: any; from: { toString: () => any; }; to: any; thread_fbid: any; hasOwnProperty: (arg0: string) => any; from_mobile: any; realtime_viewer_fbid: any; }} event
  */
+
 function formatTyp(event) {
     return {
         isTyping: !!event.st,
         from: event.from.toString(),
         threadID: formatID((event.to || event.thread_fbid || event.from).toString()),
+        // When receiving typ indication from mobile, `from_mobile` isn't set.
+        // If it is, we just use that value.
         fromMobile: event.hasOwnProperty("from_mobile") ? event.from_mobile : true,
         userID: (event.realtime_viewer_fbid || event.from).toString(),
         type: "typ"
@@ -2294,18 +2267,22 @@ function formatTyp(event) {
 /**
  * @param {{ threadKey: { otherUserFbId: any; threadFbId: any; }; actorFbId: any; actionTimestampMs: any; }} delta
  */
-function formatDeltaReadReceipt(delta) {
-    return {
-        reader: (delta.threadKey.otherUserFbId || delta.actorFbId).toString(),
-        time: delta.actionTimestampMs,
-        threadID: formatID((delta.threadKey.otherUserFbId || delta.threadKey.threadFbId).toString()),
-        type: "read_receipt"
-    };
-}
+
+// function formatDeltaReadReceipt(delta) {
+//     // otherUserFbId seems to be used as both the readerID and the threadID in a 1-1 chat.
+//     // In a group chat actorFbId is used for the reader and threadFbId for the thread.
+//     return {
+//         reader: (delta.threadKey.otherUserFbId || delta.actorFbId).toString(),
+//         time: delta.actionTimestampMs,
+//         threadID: formatID((delta.threadKey.otherUserFbId || delta.threadKey.threadFbId).toString()),
+//         type: "read_receipt"
+//     };
+// }
 
 /**
  * @param {{ reader: { toString: () => any; }; time: any; thread_fbid: any; }} event
  */
+
 function formatReadReceipt(event) {
     return {
         reader: event.reader.toString(),
@@ -2318,6 +2295,7 @@ function formatReadReceipt(event) {
 /**
  * @param {{ chat_ids: any[]; thread_fbids: any[]; timestamp: any; }} event
  */
+
 function formatRead(event) {
     return {
         threadID: formatID(((event.chat_ids && event.chat_ids[0]) || (event.thread_fbids && event.thread_fbids[0])).toString()),
@@ -2331,6 +2309,7 @@ function formatRead(event) {
  * @param {string | any[]} startToken
  * @param {string} endToken
  */
+
 function getFrom(str, startToken, endToken) {
     var start = str.indexOf(startToken) + startToken.length;
     if (start < startToken.length) return "";
@@ -2344,9 +2323,20 @@ function getFrom(str, startToken, endToken) {
 /**
  * @param {string} html
  */
-function makeParsable(html) {
-    let withoutForLoop = html.replace(/for\s*\(\s*;\s*;\s*\)\s*;\s*/ , "");
 
+function makeParsable(html) {
+    let withoutForLoop = html.replace(/for\s*\(\s*;\s*;\s*\)\s*;\s*/
+        , "");
+
+    // (What the fuck FB, why windows style newlines?)
+    // So sometimes FB will send us base multiple objects in the same response.
+    // They're all valid JSON, one after the other, at the top level. We detect
+    // that and make it parse-able by JSON.parse.
+    //       Ben - July 15th 2017
+    //
+    // It turns out that Facebook may insert random number of spaces before
+    // next object begins (issue #616)
+    //       rav_kr - 2018-03-19
     let maybeMultipleObjects = withoutForLoop.split(/\}\r\n *\{/);
     if (maybeMultipleObjects.length === 1) return maybeMultipleObjects;
 
@@ -2356,6 +2346,7 @@ function makeParsable(html) {
 /**
  * @param {any} form
  */
+
 function arrToForm(form) {
     return arrayToObject(form,
         function (/** @type {{ name: any; }} */v) {
@@ -2372,6 +2363,7 @@ function arrToForm(form) {
  * @param {{ (v: any): any; (arg0: any): string | number; }} getKey
  * @param {{ (v: any): any; (arg0: any): any; }} getValue
  */
+
 function arrayToObject(arr, getKey, getValue) {
     return arr.reduce(function (/** @type {{ [x: string]: any; }} */
         acc, /** @type {any} */val) {
@@ -2394,10 +2386,26 @@ function generateTimestampRelative() {
  * @param {any} userID
  * @param {{ fb_dtsg: any; ttstamp: any; globalOptions: any; }} ctx
  */
+
 function makeDefaults(html, userID, ctx) {
     var reqCounter = 1;
     var fb_dtsg = getFrom(html, 'name="fb_dtsg" value="', '"');
 
+    // @Hack Ok we've done hacky things, this is definitely on top 5.
+    // We totally assume the object is flat and try parsing until a }.
+    // If it works though it's cool because we get a bunch of extra data things.
+    //
+    // Update: we don't need this. Leaving it in in case we ever do.
+    //       Ben - July 15th 2017
+
+    // var siteData = getFrom(html, "[\"SiteData\",[],", "},");
+    // try {
+    //   siteData = JSON.parse(siteData + "}");
+    // } catch(e) {
+    //   log.warn("makeDefaults", "Couldn't parse SiteData. Won't have access to some variables.");
+    //   siteData = {};
+    // }
+
     var ttstamp = "2";
     for (var i = 0; i < fb_dtsg.length; i++) ttstamp += fb_dtsg.charCodeAt(i);
     var revision = getFrom(html, 'revision":', ",");
@@ -2405,16 +2413,40 @@ function makeDefaults(html, userID, ctx) {
     /**
      * @param {{ [x: string]: any; hasOwnProperty: (arg0: string) => any; }} obj
      */
+
     function mergeWithDefaults(obj) {
+        // @TODO This is missing a key called __dyn.
+        // After some investigation it seems like __dyn is some sort of set that FB
+        // calls BitMap. It seems like certain responses have a "define" key in the
+        // res.jsmods arrays. I think the code iterates over those and calls `set`
+        // on the bitmap for each of those keys. Then it calls
+        // bitmap.toCompressedString() which returns what __dyn is.
+        //
+        // So far the API has been working without this.
+        //
+        //              Ben - July 15th 2017
         var newObj = {
             __user: userID,
             __req: (reqCounter++).toString(36),
             __rev: revision,
             __a: 1,
+            // __af: siteData.features,
             fb_dtsg: ctx.fb_dtsg ? ctx.fb_dtsg : fb_dtsg,
             jazoest: ctx.ttstamp ? ctx.ttstamp : ttstamp
+            // __spin_r: siteData.__spin_r,
+            // __spin_b: siteData.__spin_b,
+            // __spin_t: siteData.__spin_t,
         };
 
+        // @TODO this is probably not needed.
+        //         Ben - July 15th 2017
+        // if (siteData.be_key) {
+        //   newObj[siteData.be_key] = siteData.be_mode;
+        // }
+        // if (siteData.pkg_cohort_key) {
+        //   newObj[siteData.pkg_cohort_key] = siteData.pkg_cohort;
+        // }
+
         if (!obj) return newObj;
         for (var prop in obj)
             if (obj.hasOwnProperty(prop))
@@ -2428,6 +2460,7 @@ function makeDefaults(html, userID, ctx) {
      * @param {any} form
      * @param {any} ctxx
      */
+
     function postWithDefaults(url, jar, form, ctxx) {
         return post(url, jar, mergeWithDefaults(form), ctx.globalOptions, ctxx || ctx);
     }
@@ -2438,6 +2471,7 @@ function makeDefaults(html, userID, ctx) {
      * @param {any} qs
      * @param {any} ctxx
      */
+
     function getWithDefaults(url, jar, qs, ctxx) {
         return get(url, jar, mergeWithDefaults(qs), ctx.globalOptions, ctxx || ctx);
     }
@@ -2449,6 +2483,7 @@ function makeDefaults(html, userID, ctx) {
      * @param {any} qs
      * @param {any} ctxx
      */
+
     function postFormDataWithDefault(url, jar, form, qs, ctxx) {
         return postFormData(url, jar, mergeWithDefaults(form), mergeWithDefaults(qs), ctx.globalOptions, ctxx || ctx);
     }
@@ -2465,6 +2500,7 @@ function makeDefaults(html, userID, ctx) {
  * @param {{ postFormData: (arg0: string, arg1: any, arg2: any, arg3: {}) => any; post: (arg0: string, arg1: any, arg2: any) => any; get: (arg0: any, arg1: any) => Promise<any>; }} defaultFuncs
  * @param {string | number} [retryCount]
  */
+
 function parseAndCheckLogin(ctx, defaultFuncs, retryCount) {
     if (retryCount == undefined) retryCount = 0;
     return function (data) {
@@ -2499,8 +2535,10 @@ function parseAndCheckLogin(ctx, defaultFuncs, retryCount) {
                 };
             }
 
+            // In some cases the response contains only a redirect URL which should be followed
             if (res.redirect && data.request.method === "GET") return defaultFuncs.get(res.redirect, ctx.jar).then(parseAndCheckLogin(ctx, defaultFuncs));
 
+            // TODO: handle multiple cookies?
             if (res.jsmods && res.jsmods.require && Array.isArray(res.jsmods.require[0]) && res.jsmods.require[0][0] === "Cookie") {
                 res.jsmods.require[0][3][0] = res.jsmods.require[0][3][0].replace("_js_", "");
                 var cookie = formatCookie(res.jsmods.require[0][3], "facebook");
@@ -2509,11 +2547,15 @@ function parseAndCheckLogin(ctx, defaultFuncs, retryCount) {
                 ctx.jar.setCookie(cookie2, "https://www.messenger.com");
             }
 
+            // On every request we check if we got a DTSG and we mutate the context so that we use the latest
+            // one for the next requests.
             if (res.jsmods && Array.isArray(res.jsmods.require)) {
                 var arr = res.jsmods.require;
                 for (var i in arr) {
                     if (arr[i][0] === "DTSG" && arr[i][1] === "setToken") {
                         ctx.fb_dtsg = arr[i][3][0];
+
+                        // Update ttstamp since that depends on fb_dtsg
                         ctx.ttstamp = "2";
                         for (var j = 0; j < ctx.fb_dtsg.length; j++) ctx.ttstamp += ctx.fb_dtsg.charCodeAt(j);
                     }
@@ -2529,11 +2571,12 @@ function parseAndCheckLogin(ctx, defaultFuncs, retryCount) {
 /**
  * @param {{ setCookie: (arg0: any, arg1: string) => void; }} jar
  */
+
 function saveCookies(jar) {
     return function (/** @type {{ headers: { [x: string]: any[]; }; }} */res) {
         var cookies = res.headers["set-cookie"] || [];
         cookies.forEach(function (/** @type {string} */c) {
-            if (c.indexOf(".facebook.com") > -1) {
+            if (c.indexOf(".facebook.com") > -1) { // yo wtf is this?
                 jar.setCookie(c, "https://www.facebook.com");
                 jar.setCookie(c.replace(/domain=\.facebook\.com/, "domain=.messenger.com"), "https://www.messenger.com");
             }
@@ -2543,14 +2586,25 @@ function saveCookies(jar) {
 }
 
 var NUM_TO_MONTH = [
-    "Jan", "Feb", "Mar", "Apr", "May", "Jun",
-    "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"
+    "Jan",
+    "Feb",
+    "Mar",
+    "Apr",
+    "May",
+    "Jun",
+    "Jul",
+    "Aug",
+    "Sep",
+    "Oct",
+    "Nov",
+    "Dec"
 ];
 var NUM_TO_DAY = ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
 
 /**
  * @param {{ getUTCDate: () => any; getUTCHours: () => any; getUTCMinutes: () => any; getUTCSeconds: () => any; getUTCDay: () => string | number; getUTCMonth: () => string | number; getUTCFullYear: () => string; }} date
  */
+
 function formatDate(date) {
     var d = date.getUTCDate();
     d = d >= 10 ? d : "0" + d;
@@ -2567,6 +2621,7 @@ function formatDate(date) {
  * @param {string[]} arr
  * @param {string} url
  */
+
 function formatCookie(arr, url) {
     return arr[0] + "=" + arr[1] + "; Path=" + arr[3] + "; Domain=" + url + ".com";
 }
@@ -2574,6 +2629,7 @@ function formatCookie(arr, url) {
 /**
  * @param {{ thread_fbid: { toString: () => any; }; participants: any[]; name: any; custom_nickname: any; snippet: any; snippet_attachments: any; snippet_sender: any; unread_count: any; message_count: any; image_src: any; timestamp: any; mute_until: any; is_canonical_user: any; is_canonical: any; is_subscribed: any; folder: any; is_archived: any; recipients_loadable: any; has_email_participant: any; read_only: any; can_reply: any; cannot_reply_reason: any; last_message_timestamp: any; last_read_timestamp: any; last_message_type: any; custom_like_icon: any; custom_color: any; admin_ids: any; thread_type: any; }} data
  */
+
 function formatThread(data) {
     return {
         threadID: formatID(data.thread_fbid.toString()),
@@ -2612,6 +2668,7 @@ function formatThread(data) {
 /**
  * @param {any} obj
  */
+
 function getType(obj) {
     return Object.prototype.toString.call(obj).slice(8, -1);
 }
@@ -2620,6 +2677,7 @@ function getType(obj) {
  * @param {{ lat: number; p: any; }} presence
  * @param {any} userID
  */
+
 function formatProxyPresence(presence, userID) {
     if (presence.lat === undefined || presence.p === undefined) return null;
     return {
@@ -2634,6 +2692,7 @@ function formatProxyPresence(presence, userID) {
  * @param {{ la: number; a: any; }} presence
  * @param {any} userID
  */
+
 function formatPresence(presence, userID) {
     return {
         type: "presence",
@@ -2646,7 +2705,16 @@ function formatPresence(presence, userID) {
 /**
  * @param {any} payload
  */
+
 function decodeClientPayload(payload) {
+    /*
+    Special function which Client using to "encode" clients JSON payload
+    */
+
+    /**
+     * @param {string | any[]} array
+     */
+
     function Utf8ArrayToStr(array) {
         var out, i, len, c;
         var char2, char3;
@@ -2686,13 +2754,15 @@ function decodeClientPayload(payload) {
 /**
  * @param {{ getCookies: (arg0: string) => string | any[]; }} jar
  */
+
 function getAppState(jar) {
     return jar.getCookies("https://www.facebook.com").concat(jar.getCookies("https://facebook.com")).concat(jar.getCookies("https://www.messenger.com"));
 }
 
 function getData_Path(Obj, Arr, Stt) {
+    //default stt = 0
     if (Arr.length === 0 && Obj != undefined) {
-        return Obj;
+        return Obj; //object
     }
     else if (Obj == undefined) {
         return Stt;
@@ -2705,6 +2775,7 @@ function getData_Path(Obj, Arr, Stt) {
     return getData_Path(Obj[head], tail, Stt++);
 }
 
+
 function setData_Path(obj, path, value) {
     if (!path.length) {
         return obj;
@@ -2747,10 +2818,8 @@ function getJazoest() {
     return result;
 }
 
-function getCurrentTimestamp() {
-    const date = new Date();
-    const unixTime = date.getTime();
-    return unixTime;
+function getEventTime() {
+    return Date.now();
 }
 
 function getSessionID() {
@@ -2809,23 +2878,27 @@ function cleanHTML(text) {
     return text;
 }
 
+function delay(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+
 module.exports = {
     cleanHTML,
-    isReadableStream,
-    get,
-    post,
-    postFormData,
-    generateThreadingID,
-    generateOfflineThreadingID,
-    getGUID,
-    getFrom,
-    makeParsable,
-    arrToForm,
-    getSignatureID,
+    isReadableStream: isReadableStream,
+    get: get,
+    post: post,
+    postFormData: postFormData,
+    generateThreadingID: generateThreadingID,
+    generateOfflineThreadingID: generateOfflineThreadingID,
+    getGUID: getGUID,
+    getFrom: getFrom,
+    makeParsable: makeParsable,
+    arrToForm: arrToForm,
+    getSignatureID: getSignatureID,
     getJar: request.jar,
-    generateTimestampRelative,
-    makeDefaults,
-    parseAndCheckLogin,
+    generateTimestampRelative: generateTimestampRelative,
+    makeDefaults: makeDefaults,
+    parseAndCheckLogin: parseAndCheckLogin,
     getGender: getGenderByPhysicalMethod,
     getData_Path,
     setData_Path,
@@ -2838,11 +2911,10 @@ module.exports = {
     formatMessage,
     formatDeltaEvent,
     formatDeltaMessage,
-    getMentionsFromDeltaMessage,
-    formatDeltaReadReceipt,
     formatProxyPresence,
     formatPresence,
     formatTyp,
+    // formatDeltaReadReceipt,
     formatCookie,
     formatThread,
     formatReadReceipt,
@@ -2856,12 +2928,8 @@ module.exports = {
     setProxy,
     isDMThread,
     getJazoest,
-    getCurrentTimestamp,
+    getEventTime,
     getSessionID,
     getFormData,
-    presenceEncode,
-    presenceDecode,
-    padZeros,
-    binaryToDecimal,
-    arrayToObject
+    delay
 };