@qixils/tiktok-live-connector/dist/lib/webcastProtobuf.js

Node.js module to receive live stream chat events like comments and gifts from TikTok LIVE

"use strict";

const protobufjs = require('protobufjs');

const util = require('node:util');

const zlib = require('node:zlib');

const unzip = util.promisify(zlib.unzip);

const {
  tiktokSchemaData
} = require('./tiktokSchema.js');

let tiktokSchema = null;
let config = {
  skipMessageTypes: []
}; // Load & cache schema

function loadTikTokSchema() {
  if (!tiktokSchema) {
    tiktokSchema = protobufjs.parse(tiktokSchemaData).root;
  }
}

function serializeMessage(protoName, obj) {
  loadTikTokSchema();
  return tiktokSchema.lookupType(`TikTok.${protoName}`).encode(obj).finish();
}

function deserializeMessage(protoName, binaryMessage) {
  loadTikTokSchema();
  var webcastData = tiktokSchema.lookupType(`TikTok.${protoName}`).decode(binaryMessage);

  if (protoName === 'WebcastResponse' && Array.isArray(webcastData.messages)) {
    // Contains different object structures depending on the type field
    webcastData.messages.forEach(message => {
      if (config.skipMessageTypes.includes(message.type)) {
        return;
      }

      switch (message.type) {
        case 'WebcastControlMessage':
        case 'WebcastRoomUserSeqMessage':
        case 'WebcastChatMessage':
        case 'WebcastMemberMessage':
        case 'WebcastGiftMessage':
        case 'WebcastSocialMessage':
        case 'WebcastLikeMessage':
        case 'WebcastQuestionNewMessage':
        case 'WebcastLinkMicBattle':
        case 'WebcastLinkMicArmies':
        case 'WebcastLiveIntroMessage':
        case 'WebcastEmoteChatMessage':
        case 'WebcastEnvelopeMessage':
        case 'WebcastSubNotifyMessage':
          message.decodedData = tiktokSchema.lookupType(`TikTok.${message.type}`).decode(message.binary);
          break;
      }
    });
  }

  return webcastData;
}

async function deserializeWebsocketMessage(binaryMessage) {
  // Websocket messages are in an container which contains additional data
  // Message type 'msg' represents a normal WebcastResponse
  let decodedWebsocketMessage = deserializeMessage('WebcastWebsocketMessage', binaryMessage);

  if (decodedWebsocketMessage.type === 'msg') {
    let binary = decodedWebsocketMessage.binary; // Decompress binary (if gzip compressed)
    // https://www.rfc-editor.org/rfc/rfc1950.html

    if (binary && binary.length > 2 && binary[0] === 0x1f && binary[1] === 0x8b && binary[2] === 0x08) {
      decodedWebsocketMessage.binary = await unzip(binary);
    }

    decodedWebsocketMessage.webcastResponse = deserializeMessage('WebcastResponse', decodedWebsocketMessage.binary);
  }

  return decodedWebsocketMessage;
}

module.exports = {
  serializeMessage,
  deserializeMessage,
  deserializeWebsocketMessage,
  config
};