2.2.0: Added MessageRemoveEvent

Author: Bjornskjald

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "libfb",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Facebook MQTT library for Node.js",
   "repository": "https://github.com/ChatPlug/libfb-js",
   "main": "dist/index.js",

package.json

@@ -16,12 +16,14 @@ import { AttachmentNotFoundError, AttachmentURLMissingError } from './types/Erro
 import StrictEventEmitter from 'strict-event-emitter-types'
 import ClientEvents from './ClientEvents'
 import * as Payloads from './mqtt/payloads'
+import DeviceId from './types/DeviceId'
 
 const debugLog = debug('fblib')
 
 export interface ClientOptions {
   selfListen?: boolean
   session?: Session
+  deviceId?: DeviceId
 }
 
 type ClientEmitter = StrictEventEmitter<EventEmitter, ClientEvents>
@@ -51,6 +53,10 @@ export default class Client extends (EventEmitter as { new(): ClientEmitter }) {
       session = { tokens: null, deviceId: null }
     }
 
+    if (options.deviceId) {
+      session.deviceId = options.deviceId
+    }
+
     if (!session.deviceId) {
       const deviceId = makeDeviceId()
       session.deviceId = deviceId
@@ -215,29 +221,62 @@ export default class Client extends (EventEmitter as { new(): ClientEmitter }) {
   }
 
   private async createQueue (seqId: number) {
-    const obj = {
-      delta_batch_size: 125,
-      max_deltas_able_to_process: 1250,
-      sync_api_version: 3,
-      encoding: 'JSON',
 
+    // sync_api_version 3: You receive /t_ms payloads as json
+    // sync_api_version 10: You receiove /t_ms payloads as thrift,
+    // and connectQueue() does not have to be called.
+    // Note that connectQueue() should always use 10 instead.
+
+    const obj = (
+    {
       initial_titan_sequence_id: seqId,
-      device_id: this.session.deviceId.deviceId,
+      delta_batch_size: 125,
+      device_params: {
+        image_sizes: {
+          0: '4096x4096',
+          4: '312x312',
+          1: '768x768',
+          2: '420x420',
+          3: '312x312'
+        },
+        animated_image_format: 'WEBP,GIF',
+        animated_image_sizes: {
+          0: '4096x4096',
+          4: '312x312',
+          1: '768x768',
+          2: '420x420',
+          3: '312x312'
+        }
+      },
       entity_fbid: this.session.tokens.uid,
-
+      sync_api_version: 3,   // Must be 3 instead of 10 to receive json payloads
+      encoding: 'JSON',      // Must be removed if using sync_api_version 10
       queue_params: {
-        buzz_on_deltas_enabled: 'false',
+        // Array of numbers -> Some bitwise encoding scheme -> base64. Numbers range from 0 to 67
+        // Decides what type of /t_ms delta messages you get. Flags unknown, copy-pasted from app.
+        client_delta_sync_bitmask: 'Amvr2dBlf7PNgA',
         graphql_query_hashes: {
-          xma_query_id: '10153919431161729'
+          xma_query_id: '306810703252313'
         },
-
         graphql_query_params: {
-          '10153919431161729': {
-            xma_id: '<ID>'
+          306810703252313: {
+            xma_id: '<ID>',
+            small_preview_width: 624,
+            small_preview_height: 312,
+            large_preview_width: 1536,
+            large_preview_height: 768,
+            full_screen_width: 4096,
+            full_screen_height: 4096,
+            blur: 0.0,
+            nt_context: {
+              styles_id: 'fe1fd5357bb40c81777dc915dfbd6aa4',
+              pixel_ratio: 3.0
+            }
           }
         }
       }
     }
+  )
 
     await this.mqttApi.sendPublish(
       '/messenger_sync_create_queue',
@@ -246,10 +285,15 @@ export default class Client extends (EventEmitter as { new(): ClientEmitter }) {
   }
 
   private async connectQueue (seqId) {
+
+    // If createQueue() uses sync_api_version 10, this does not need to be called, and you will not receive json payloads.
+    // If this does not use sync_api_version 10, you will not receive all messages (e.g. reactions )
+    // Send the thrift-equivalent payload to /t_ms_gd and you will receive mostly thrift-encoded payloads instead.
+
     const obj = {
       delta_batch_size: 125,
       max_deltas_able_to_process: 1250,
-      sync_api_version: 3,
+      sync_api_version: 10, // Must be 10 to receive some messages
       encoding: 'JSON',
 
       last_seq_id: seqId,

src/Client.ts

@@ -18,7 +18,8 @@ import {
   ChangeThreadThemeEvent,
   DeliveryReceiptEvent,
   ReadReceiptEvent,
-  EventType
+  EventType,
+  MessageRemoveEvent
 } from './types/Events'
 
 export default interface ClientEvents {
@@ -46,4 +47,6 @@ export default interface ClientEvents {
 
   deliveryReceiptEvent: (deliveryReceiptEvent: DeliveryReceiptEvent) => void,
   readReceiptEvent: (readReceiptEvent: ReadReceiptEvent) => void
+
+  messageRemoveEvent: (messageRemoveEvent: MessageRemoveEvent) => void
 }

src/ClientEvents.ts

@@ -19,7 +19,8 @@ export type EventType = (
   'changeThreadThemeEvent' |
 
   'deliveryReceiptEvent' |
-  'readReceiptEvent'
+  'readReceiptEvent' |
+  'messageRemoveEvent'
 )
 
 export interface Event {
@@ -70,3 +71,5 @@ export interface DeliveryReceiptEvent extends Event {
 export interface ReadReceiptEvent extends Event {
   receiverId: string
 }
+
+export interface MessageRemoveEvent extends MessageEvent {}

src/types/Events.ts

@@ -4,17 +4,28 @@ import {
     ThreadNameEvent
 } from './ThreadEvents'
 import {
-    Event,
-    DeliveryReceiptEvent,
-    ReadReceiptEvent,
-    EventType
+  Event,
+  DeliveryReceiptEvent,
+  ReadReceiptEvent,
+  EventType,
+  MessageRemoveEvent
 } from '../Events'
 import parseAdminMessage from './parseAdminMessage'
 import { getThreadId } from '../Message'
 
 export default function parseDeltaEvent (event: any): { type: EventType, event: Event } {
   if (event.deltaAdminTextMessage) return parseAdminMessage(event.deltaAdminTextMessage)
 
+  if (event.deltaReplaceMessage) {
+    const delta = event.deltaReplaceMessage
+    if (delta.newMessage.messageMetadata.unsendType) {
+      return {
+        type: 'messageRemoveEvent',
+        event: getEventMetadata(delta.newMessage) as MessageRemoveEvent
+      }
+    }
+  }
+
   if (event.deltaThreadName) {
     const delta = event.deltaThreadName
     return {
@@ -32,7 +43,7 @@ export default function parseDeltaEvent (event: any): { type: EventType, event:
       type: 'deliveryReceiptEvent',
       event: {
         threadId: getThreadId(delta),
-        receiverId: delta.actorFbId || getThreadId(delta)
+        receiverId: delta.actorFbId.toString() || getThreadId(delta)
       } as DeliveryReceiptEvent
     }
   }
@@ -43,7 +54,7 @@ export default function parseDeltaEvent (event: any): { type: EventType, event:
       type: 'readReceiptEvent',
       event: {
         threadId: getThreadId(delta),
-        receiverId: delta.actorFbId || getThreadId(delta)
+        receiverId: delta.actorFbId.toString() || getThreadId(delta)
       } as ReadReceiptEvent
     }
   }