bb-fca 2.0.10 → 2.0.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bb-fca",
-  "version": "2.0.10",
+  "version": "2.0.12",
   "description": "BB-FCA is a powerful and user-friendly Facebook Chat API wrapper for Node.js, designed to simplify the process of creating chatbots and automating interactions on Facebook Messenger. With BB-FCA, developers can easily send messages, manage conversations, and interact with the Facebook Messenger platform using a simple and intuitive API.",
   "main": "dist/core/client.js",
   "types": "dist/index.d.ts",

package/src/deltas/apis/messaging/sendPageMessage.ts

@@ -0,0 +1,246 @@
+import utils = require('../../../utils');
+// @NethWs3Dev
+
+const allowedProperties = {
+  attachment: true,
+  url: true,
+  sticker: true,
+  emoji: true,
+  emojiSize: true,
+  body: true,
+  mentions: true,
+  location: true,
+};
+
+export default function sendPageMessage(
+  defaultFuncs: any,
+  api: any,
+  ctx: any,
+): Function {
+  async function uploadAttachment(attachments: any[]): Promise<any[]> {
+    const uploads: any[] = [];
+    for (let i = 0; i < attachments.length; i++) {
+      if (!utils.isReadableStream(attachments[i])) {
+        throw new Error(
+          'Attachment should be a readable stream and not ' +
+            utils.getType(attachments[i]) +
+            '.',
+        );
+      }
+      const oksir = await defaultFuncs
+        .postFormData(
+          'https://upload.facebook.com/ajax/mercury/upload.php',
+          ctx.jar,
+          {
+            upload_1024: attachments[i],
+            voice_clip: 'true',
+          },
+          {},
+        )
+        .then(utils.parseAndCheckLogin(ctx, defaultFuncs));
+      if (oksir.error) {
+        throw new Error(oksir.error);
+      }
+      uploads.push(oksir.payload.metadata[0]);
+    }
+    return uploads;
+  }
+
+  async function getUrl(url: string): Promise<any> {
+    const resData = await defaultFuncs
+      .post(
+        'https://www.facebook.com/message_share_attachment/fromURI/',
+        ctx.jar,
+        {
+          image_height: 960,
+          image_width: 960,
+          uri: url,
+        },
+      )
+      .then(utils.parseAndCheckLogin(ctx, defaultFuncs));
+    if (!resData || resData.error || !resData.payload) {
+      throw new Error(resData);
+    }
+    return resData.payload;
+  }
+
+  async function sendContent(
+    form: Record<string, any>,
+    threadID: any,
+  ): Promise<any> {
+    const resData = await defaultFuncs
+      .post('https://www.facebook.com/messaging/send/', ctx.jar, form)
+      .then(utils.parseAndCheckLogin(ctx, defaultFuncs));
+
+    if (!resData) {
+      throw new Error('Send page message failed.');
+    }
+    if (resData.error) {
+      if (resData.error === 1545012) {
+        utils.warn(
+          'sendMessage',
+          "Got error 1545012. This might mean that you're not part of the conversation " +
+            threadID,
+        );
+      }
+      throw new Error(JSON.stringify(resData));
+    }
+
+    // Facebook frequently changes this payload response format. Try to parse actions if available
+    if (resData.payload && resData.payload.actions) {
+      const messageInfo = resData.payload.actions.reduce((p: any, v: any) => {
+        return {
+          threadID: v.thread_fbid,
+          messageID: v.message_id,
+          timestamp: v.timestamp,
+        };
+      }, null);
+      return messageInfo;
+    }
+    return resData;
+  }
+
+  return async function sendPageMessageImpl(
+    msg: any,
+    receiverID: string | number,
+    senderID: string | number,
+    replyToMessage?: string,
+  ): Promise<any> {
+    const msgType = utils.getType(msg);
+    const receiverIDType = utils.getType(receiverID);
+    const senderIDType = utils.getType(senderID);
+    const messageIDType = utils.getType(replyToMessage);
+
+    if (senderIDType !== 'String' && senderIDType !== 'Number') {
+      throw new Error('senderID (Page ID) must be of type string or number.');
+    }
+    const pageID = String(senderID);
+    const threadID = String(receiverID);
+
+    if (msgType !== 'String' && msgType !== 'Object')
+      throw new Error(
+        'Message should be of type string or object and not ' + msgType + '.',
+      );
+    // Usually Page sends message to exactly 1 user (the customer)
+    if (receiverIDType !== 'Number' && receiverIDType !== 'String')
+      throw new Error(
+        'receiverID should be of type number, string and not ' +
+          receiverIDType +
+          '.',
+      );
+    if (replyToMessage && messageIDType !== 'String')
+      throw new Error(
+        'MessageID should be of type string and not ' + messageIDType + '.',
+      );
+    if (msgType === 'String') {
+      msg = { body: msg };
+    }
+    const disallowedProperties = Object.keys(msg).filter(
+      (prop) => !(allowedProperties as any)[prop],
+    );
+    if (disallowedProperties.length > 0) {
+      throw new Error(
+        'Disallowed props: `' + disallowedProperties.join(', ') + '`',
+      );
+    }
+
+    const messageAndOTID = utils.generateOfflineThreadingID();
+
+    // Construct payload specifically based on Unified Inbox schema
+    const form: Record<string, any> = {
+      av: pageID,
+      client: 'mercury',
+      action_type: 'ma-type:user-generated-message',
+      ...(msg.body && { body: msg.body }),
+      ephemeral_ttl_mode: '0',
+      has_attachment: !!(msg.attachment || msg.url || msg.sticker),
+      message_id: messageAndOTID,
+      offline_threading_id: messageAndOTID,
+      other_user_fbid: threadID,
+      source: 'source:page_unified_inbox',
+      'specific_to_list[0]': 'fbid:' + threadID,
+      'specific_to_list[1]': 'fbid:' + pageID,
+      timestamp: Date.now(),
+      request_user_id: pageID,
+      // Default function post/method wraps _user, _a, fb_dtsg inherently if the environment config is valid.
+      ...(replyToMessage && {
+        replied_to_message_id: replyToMessage,
+      }),
+    };
+
+    if (msg.location) {
+      if (!msg.location.latitude || !msg.location.longitude)
+        throw new Error('location property needs both latitude and longitude');
+      form['location_attachment[coordinates][latitude]'] =
+        msg.location.latitude;
+      form['location_attachment[coordinates][longitude]'] =
+        msg.location.longitude;
+      form['location_attachment[is_current_location]'] = !!msg.location.current;
+    }
+    if (msg.sticker) {
+      form['sticker_id'] = msg.sticker;
+    }
+    if (msg.attachment) {
+      form.image_ids = [];
+      form.gif_ids = [];
+      form.file_ids = [];
+      form.video_ids = [];
+      form.audio_ids = [];
+      if (utils.getType(msg.attachment) !== 'Array') {
+        msg.attachment = [msg.attachment];
+      }
+      const files = await uploadAttachment(msg.attachment);
+      files.forEach((file) => {
+        const type = Object.keys(file)[0];
+        form['' + type + 's'].push(file[type]);
+      });
+    }
+    if (msg.url) {
+      form['shareable_attachment[share_type]'] = '100';
+      const params = await getUrl(msg.url);
+      form['shareable_attachment[share_params]'] = params;
+    }
+    if (msg.emoji) {
+      if (!msg.emojiSize) {
+        msg.emojiSize = 'medium';
+      }
+      if (
+        msg.emojiSize !== 'small' &&
+        msg.emojiSize !== 'medium' &&
+        msg.emojiSize !== 'large'
+      ) {
+        throw new Error('emojiSize property is invalid');
+      }
+      if (!form.body) {
+        throw new Error('body is not empty');
+      }
+      form.body = msg.emoji;
+      form['tags[0]'] = 'hot_emoji_size:' + msg.emojiSize;
+    }
+    if (msg.mentions) {
+      for (let i = 0; i < msg.mentions.length; i++) {
+        const mention = msg.mentions[i];
+        const tag = mention.tag;
+        if (typeof tag !== 'string') {
+          throw new Error('Mention tags must be strings.');
+        }
+        const offset = msg.body.indexOf(tag, mention.fromIndex || 0);
+        if (offset < 0)
+          utils.warn(
+            'handleMention',
+            'Mention for "' + tag + '" not found in message string.',
+          );
+        if (!mention.id)
+          utils.warn('handleMention', 'Mention id should be non-null.');
+        const id = mention.id || 0;
+        const emptyChar = '\u200E';
+        form['body'] = emptyChar + msg.body;
+        form['profile_xmd[' + i + '][offset]'] = offset + 1;
+        form['profile_xmd[' + i + '][length]'] = tag.length;
+        form['profile_xmd[' + i + '][id]'] = id;
+        form['profile_xmd[' + i + '][type]'] = 'p';
+      }
+    }
+    return await sendContent(form, threadID);
+  };
+}