@tiktool/live 1.1.0 → 1.3.0

package/dist/index.d.mts

@@ -37,6 +37,8 @@ interface GiftEvent extends BaseEvent {
     repeatCount: number;
     repeatEnd: boolean;
     combo: boolean;
+    giftType: number;
+    groupId: string;
 }
 interface SocialEvent extends BaseEvent {
     type: 'social';
@@ -48,12 +50,27 @@ interface RoomUserSeqEvent extends BaseEvent {
     viewerCount: number;
     totalViewers: number;
 }
+interface BattleTeamUser {
+    user: TikTokUser;
+    score: number;
+}
+interface BattleTeam {
+    hostUserId: string;
+    score: number;
+    users: BattleTeamUser[];
+}
 interface BattleEvent extends BaseEvent {
     type: 'battle';
+    battleId: string;
     status: number;
+    battleDuration: number;
+    teams: BattleTeam[];
 }
 interface BattleArmiesEvent extends BaseEvent {
     type: 'battleArmies';
+    battleId: string;
+    status: number;
+    teams: BattleTeam[];
 }
 interface SubscribeEvent extends BaseEvent {
     type: 'subscribe';
@@ -64,9 +81,11 @@ interface EmoteChatEvent extends BaseEvent {
     type: 'emoteChat';
     user: TikTokUser;
     emoteId: string;
+    emoteUrl: string;
 }
 interface EnvelopeEvent extends BaseEvent {
     type: 'envelope';
+    envelopeId: string;
     diamondCount: number;
 }
 interface QuestionEvent extends BaseEvent {
@@ -80,19 +99,26 @@ interface ControlEvent extends BaseEvent {
 }
 interface RoomEvent extends BaseEvent {
     type: 'room';
-    status: string;
+    status: number;
 }
 interface LiveIntroEvent extends BaseEvent {
     type: 'liveIntro';
+    roomId: string;
     title: string;
 }
 interface RankUpdateEvent extends BaseEvent {
     type: 'rankUpdate';
     rankType: string;
+    rankList: Array<{
+        user: TikTokUser;
+        rank: number;
+        score: number;
+    }>;
 }
 interface LinkMicEvent extends BaseEvent {
     type: 'linkMic';
-    action: number;
+    action: string;
+    users: TikTokUser[];
 }
 interface UnknownEvent extends BaseEvent {
     type: 'unknown';
@@ -170,4 +196,4 @@ declare class TikTokLive extends EventEmitter {
     private stopHeartbeat;
 }
 
-export { type BaseEvent, type BattleArmiesEvent, type BattleEvent, type ChatEvent, type ControlEvent, type EmoteChatEvent, type EnvelopeEvent, type GiftEvent, type LikeEvent, type LinkMicEvent, type LiveEvent, type LiveIntroEvent, type MemberEvent, type QuestionEvent, type RankUpdateEvent, type RoomEvent, type RoomInfo, type RoomUserSeqEvent, type SocialEvent, type SubscribeEvent, TikTokLive, type TikTokLiveEvents, type TikTokLiveOptions, type TikTokUser, type UnknownEvent };
+export { type BaseEvent, type BattleArmiesEvent, type BattleEvent, type BattleTeam, type BattleTeamUser, type ChatEvent, type ControlEvent, type EmoteChatEvent, type EnvelopeEvent, type GiftEvent, type LikeEvent, type LinkMicEvent, type LiveEvent, type LiveIntroEvent, type MemberEvent, type QuestionEvent, type RankUpdateEvent, type RoomEvent, type RoomInfo, type RoomUserSeqEvent, type SocialEvent, type SubscribeEvent, TikTokLive, type TikTokLiveEvents, type TikTokLiveOptions, type TikTokUser, type UnknownEvent };

package/dist/index.d.ts

@@ -37,6 +37,8 @@ interface GiftEvent extends BaseEvent {
     repeatCount: number;
     repeatEnd: boolean;
     combo: boolean;
+    giftType: number;
+    groupId: string;
 }
 interface SocialEvent extends BaseEvent {
     type: 'social';
@@ -48,12 +50,27 @@ interface RoomUserSeqEvent extends BaseEvent {
     viewerCount: number;
     totalViewers: number;
 }
+interface BattleTeamUser {
+    user: TikTokUser;
+    score: number;
+}
+interface BattleTeam {
+    hostUserId: string;
+    score: number;
+    users: BattleTeamUser[];
+}
 interface BattleEvent extends BaseEvent {
     type: 'battle';
+    battleId: string;
     status: number;
+    battleDuration: number;
+    teams: BattleTeam[];
 }
 interface BattleArmiesEvent extends BaseEvent {
     type: 'battleArmies';
+    battleId: string;
+    status: number;
+    teams: BattleTeam[];
 }
 interface SubscribeEvent extends BaseEvent {
     type: 'subscribe';
@@ -64,9 +81,11 @@ interface EmoteChatEvent extends BaseEvent {
     type: 'emoteChat';
     user: TikTokUser;
     emoteId: string;
+    emoteUrl: string;
 }
 interface EnvelopeEvent extends BaseEvent {
     type: 'envelope';
+    envelopeId: string;
     diamondCount: number;
 }
 interface QuestionEvent extends BaseEvent {
@@ -80,19 +99,26 @@ interface ControlEvent extends BaseEvent {
 }
 interface RoomEvent extends BaseEvent {
     type: 'room';
-    status: string;
+    status: number;
 }
 interface LiveIntroEvent extends BaseEvent {
     type: 'liveIntro';
+    roomId: string;
     title: string;
 }
 interface RankUpdateEvent extends BaseEvent {
     type: 'rankUpdate';
     rankType: string;
+    rankList: Array<{
+        user: TikTokUser;
+        rank: number;
+        score: number;
+    }>;
 }
 interface LinkMicEvent extends BaseEvent {
     type: 'linkMic';
-    action: number;
+    action: string;
+    users: TikTokUser[];
 }
 interface UnknownEvent extends BaseEvent {
     type: 'unknown';
@@ -170,4 +196,4 @@ declare class TikTokLive extends EventEmitter {
     private stopHeartbeat;
 }
 
-export { type BaseEvent, type BattleArmiesEvent, type BattleEvent, type ChatEvent, type ControlEvent, type EmoteChatEvent, type EnvelopeEvent, type GiftEvent, type LikeEvent, type LinkMicEvent, type LiveEvent, type LiveIntroEvent, type MemberEvent, type QuestionEvent, type RankUpdateEvent, type RoomEvent, type RoomInfo, type RoomUserSeqEvent, type SocialEvent, type SubscribeEvent, TikTokLive, type TikTokLiveEvents, type TikTokLiveOptions, type TikTokUser, type UnknownEvent };
+export { type BaseEvent, type BattleArmiesEvent, type BattleEvent, type BattleTeam, type BattleTeamUser, type ChatEvent, type ControlEvent, type EmoteChatEvent, type EnvelopeEvent, type GiftEvent, type LikeEvent, type LinkMicEvent, type LiveEvent, type LiveIntroEvent, type MemberEvent, type QuestionEvent, type RankUpdateEvent, type RoomEvent, type RoomInfo, type RoomUserSeqEvent, type SocialEvent, type SubscribeEvent, TikTokLive, type TikTokLiveEvents, type TikTokLiveOptions, type TikTokUser, type UnknownEvent };

package/dist/index.js

@@ -123,6 +123,9 @@ function getInt(fields, fn) {
   const f = fields.find((x) => x.fn === fn && x.wt === 0);
   return f ? Number(f.value) : 0;
 }
+function getAllBytes(fields, fn) {
+  return fields.filter((x) => x.fn === fn && x.wt === 2).map((x) => x.value);
+}
 function buildHeartbeat(roomId) {
   const payload = encodeField(1, 0, BigInt(roomId));
   return Buffer.concat([
@@ -156,67 +159,329 @@ function buildAck(id) {
 function parseUser(data) {
   const f = decodeProto(data);
   const id = String(getInt(f, 1) || getStr(f, 1));
-  const nickname = getStr(f, 3) || getStr(f, 5);
-  const uniqueId = getStr(f, 38) || getStr(f, 4) || getStr(f, 2);
-  return { id, nickname, uniqueId: uniqueId || nickname || id };
+  const nickname = getStr(f, 3) || getStr(f, 2);
+  const uniqueId = getStr(f, 38) || getStr(f, 4) || getStr(f, 2) || "";
+  let profilePicture;
+  const avatarBuf = getBytes(f, 9) || getBytes(f, 3);
+  if (avatarBuf) {
+    try {
+      const avatarFields = decodeProto(avatarBuf);
+      const urlBufs = getAllBytes(avatarFields, 1);
+      if (urlBufs.length > 0) profilePicture = urlBufs[0].toString("utf-8");
+    } catch {
+    }
+  }
+  const badges = [];
+  const badgeBuf = getBytes(f, 64);
+  if (badgeBuf) {
+    try {
+      const badgeFields = decodeProto(badgeBuf);
+      const badgeItems = getAllBytes(badgeFields, 21);
+      for (const bi of badgeItems) {
+        const bf = decodeProto(bi);
+        const name = getStr(bf, 3) || getStr(bf, 2);
+        if (name) badges.push(name);
+      }
+    } catch {
+    }
+  }
+  return {
+    id,
+    nickname,
+    uniqueId: uniqueId || nickname || id,
+    profilePicture,
+    badges: badges.length > 0 ? badges : void 0
+  };
+}
+function parseBattleTeamFromArmies(itemBuf) {
+  const f = decodeProto(itemBuf);
+  const hostUserId = String(getInt(f, 1));
+  let teamScore = 0;
+  const users = [];
+  const groups = getAllBytes(f, 2);
+  for (const gb of groups) {
+    try {
+      const gf = decodeProto(gb);
+      const points = getInt(gf, 2);
+      teamScore += points;
+      const userBufs = getAllBytes(gf, 1);
+      for (const ub of userBufs) {
+        try {
+          const user = parseUser(ub);
+          users.push({ user, score: points });
+        } catch {
+        }
+      }
+    } catch {
+    }
+  }
+  return { hostUserId, score: teamScore, users };
 }
 function parseWebcastMessage(method, payload) {
   const f = decodeProto(payload);
-  const userBuf = getBytes(f, 2);
-  const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
-  const base = { timestamp: Date.now(), msgId: String(getInt(f, 1) || "") };
+  const base = { timestamp: Date.now(), msgId: "" };
+  const typeBuf = getBytes(f, 1);
+  if (typeBuf) {
+    try {
+      const tf = decodeProto(typeBuf);
+      const ts = getInt(tf, 4);
+      if (ts) base.timestamp = ts;
+    } catch {
+    }
+  }
   switch (method) {
-    case "WebcastChatMessage":
+    // Proto: WebcastChatMessage { MessageType type=1, User user=2, string comment=3 }
+    case "WebcastChatMessage": {
+      const userBuf = getBytes(f, 2);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
       return { ...base, type: "chat", user, comment: getStr(f, 3) };
-    case "WebcastMemberMessage":
-      return { ...base, type: "member", user, action: getInt(f, 3) };
-    case "WebcastLikeMessage":
-      return { ...base, type: "like", user, likeCount: getInt(f, 5), totalLikes: getInt(f, 6) || getInt(f, 7) };
-    case "WebcastGiftMessage": {
-      const giftBuf = getBytes(f, 3);
-      let giftName = "", giftId = 0, diamondCount = 0;
-      if (giftBuf) {
-        const gf = decodeProto(giftBuf);
-        giftId = getInt(gf, 1);
-        giftName = getStr(gf, 2);
-        diamondCount = getInt(gf, 5);
+    }
+    // Proto: WebcastMemberMessage { User user=2, WebcastMessageEvent event=1 }
+    case "WebcastMemberMessage": {
+      const userBuf = getBytes(f, 2);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      let action = 1;
+      const eventBuf = getBytes(f, 1);
+      if (eventBuf) {
+        const ef = decodeProto(eventBuf);
+        const detailBuf = getBytes(ef, 8);
+        if (detailBuf) {
+          const df = decodeProto(detailBuf);
+          const label = getStr(df, 2);
+          if (label.includes("followed")) action = 2;
+          else if (label.includes("share")) action = 3;
+        }
       }
+      return { ...base, type: "member", user, action };
+    }
+    // Proto: WebcastLikeMessage { User user=5, WebcastMessageEvent event=1, int32 likeCount=2, int32 totalLikeCount=3 }
+    case "WebcastLikeMessage": {
+      const userBuf = getBytes(f, 5);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      return {
+        ...base,
+        type: "like",
+        user,
+        likeCount: getInt(f, 2),
+        totalLikes: getInt(f, 3)
+      };
+    }
+    // Proto: WebcastGiftMessage {
+    //   User user=7, int32 giftId=2, int32 repeatCount=5, int32 repeatEnd=9,
+    //   GiftDetails giftDetails=15, GiftExtra giftExtra=23
+    // }
+    // GiftDetails { GiftImage giftImage=1, string giftName=16, string describe=2,
+    //               int32 giftType=11, int32 diamondCount=12 }
+    // GiftExtra { uint64 timestamp=6, uint64 toUserId=8 }
+    case "WebcastGiftMessage": {
+      const userBuf = getBytes(f, 7);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      const giftId = getInt(f, 2);
       const repeatCount = getInt(f, 5);
       const repeatEnd = getInt(f, 9) === 1;
-      return { ...base, type: "gift", user, giftId, giftName, diamondCount, repeatCount, repeatEnd, combo: repeatCount > 1 && !repeatEnd };
+      let giftName = "", diamondCount = 0, giftType = 0;
+      let giftImageUrl = "";
+      const detailsBuf = getBytes(f, 15);
+      if (detailsBuf) {
+        const df = decodeProto(detailsBuf);
+        giftName = getStr(df, 16) || getStr(df, 2);
+        diamondCount = getInt(df, 12);
+        giftType = getInt(df, 11);
+        const imgBuf = getBytes(df, 1);
+        if (imgBuf) {
+          const imgf = decodeProto(imgBuf);
+          giftImageUrl = getStr(imgf, 1);
+        }
+      }
+      let toUserId = "";
+      const extraBuf = getBytes(f, 23);
+      if (extraBuf) {
+        const ef = decodeProto(extraBuf);
+        toUserId = String(getInt(ef, 8));
+      }
+      const groupId = toUserId || getStr(f, 11);
+      return {
+        ...base,
+        type: "gift",
+        user,
+        giftId,
+        giftName,
+        diamondCount,
+        repeatCount,
+        repeatEnd,
+        combo: repeatCount > 1 && !repeatEnd,
+        giftType,
+        groupId
+      };
     }
+    // Proto: WebcastSocialMessage { User user=2, WebcastMessageEvent event=1 }
     case "WebcastSocialMessage": {
-      const action = getInt(f, 3);
-      const actionMap = { 1: "follow", 2: "share", 3: "like" };
-      return { ...base, type: "social", user, action: actionMap[action] || `action_${action}` };
+      const userBuf = getBytes(f, 2);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      let action = "follow";
+      const eventBuf = getBytes(f, 1);
+      if (eventBuf) {
+        const ef = decodeProto(eventBuf);
+        const detailBuf = getBytes(ef, 8);
+        if (detailBuf) {
+          const df = decodeProto(detailBuf);
+          const label = getStr(df, 2);
+          if (label.includes("share")) action = "share";
+          else if (label.includes("follow")) action = "follow";
+          const displayType = getStr(df, 1);
+          if (displayType === "pm_mt_msg_viewer_share") action = "share";
+        }
+      }
+      return { ...base, type: "social", user, action };
+    }
+    // Proto: WebcastRoomUserSeqMessage { int32 viewerCount=3 }
+    case "WebcastRoomUserSeqMessage": {
+      const viewerCount = getInt(f, 3) || getInt(f, 2);
+      const totalViewers = getInt(f, 1) || viewerCount;
+      return { ...base, type: "roomUserSeq", totalViewers, viewerCount };
+    }
+    // Proto: WebcastLinkMicBattle { repeated WebcastLinkMicBattleItems battleUsers=10 }
+    //   battleUsers → { battleGroup=2 → { LinkUser user=1 } }
+    case "WebcastLinkMicBattle": {
+      const battleId = String(getInt(f, 1) || "");
+      const status = getInt(f, 2) || 1;
+      const battleDuration = getInt(f, 3);
+      const teams = [];
+      const battleUserBufs = getAllBytes(f, 10);
+      for (const bub of battleUserBufs) {
+        try {
+          const bf = decodeProto(bub);
+          const groupBuf = getBytes(bf, 2);
+          if (groupBuf) {
+            const gf = decodeProto(groupBuf);
+            const linkUserBuf = getBytes(gf, 1);
+            if (linkUserBuf) {
+              const user = parseUser(linkUserBuf);
+              teams.push({
+                hostUserId: user.id,
+                score: 0,
+                users: [{ user, score: 0 }]
+              });
+            }
+          }
+        } catch {
+        }
+      }
+      if (teams.length === 0) {
+        const teamBufs7 = getAllBytes(f, 7);
+        for (const tb of teamBufs7) {
+          try {
+            teams.push(parseBattleTeamFromArmies(tb));
+          } catch {
+          }
+        }
+      }
+      return { ...base, type: "battle", battleId, status, battleDuration, teams };
+    }
+    // Proto: WebcastLinkMicArmies { repeated battleItems=3, int32 battleStatus=7 }
+    //   battleItems → { hostUserId=1, repeated battleGroups=2 }
+    //     battleGroups → { repeated users=1, int32 points=2 }
+    case "WebcastLinkMicArmies": {
+      const battleId = String(getInt(f, 1) || "");
+      const battleStatus = getInt(f, 7);
+      const teams = [];
+      const itemBufs = getAllBytes(f, 3);
+      for (const ib of itemBufs) {
+        try {
+          teams.push(parseBattleTeamFromArmies(ib));
+        } catch {
+        }
+      }
+      return {
+        ...base,
+        type: "battleArmies",
+        battleId,
+        teams,
+        status: battleStatus
+      };
+    }
+    // Proto: WebcastSubNotifyMessage { User user=2, ... subMonth=3 }
+    case "WebcastSubNotifyMessage": {
+      const userBuf = getBytes(f, 2);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      return { ...base, type: "subscribe", user, subMonth: getInt(f, 3) };
+    }
+    case "WebcastEmoteChatMessage": {
+      const userBuf = getBytes(f, 2);
+      const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+      let emoteId = "", emoteUrl = "";
+      const emoteBuf = getBytes(f, 3);
+      if (emoteBuf) {
+        const ef = decodeProto(emoteBuf);
+        emoteId = getStr(ef, 1);
+        const imageBuf = getBytes(ef, 2);
+        if (imageBuf) {
+          const imgFields = decodeProto(imageBuf);
+          emoteUrl = getStr(imgFields, 1);
+        }
+      }
+      return { ...base, type: "emoteChat", user, emoteId, emoteUrl };
+    }
+    case "WebcastEnvelopeMessage": {
+      const envelopeId = String(getInt(f, 1) || getStr(f, 1));
+      return { ...base, type: "envelope", envelopeId, diamondCount: getInt(f, 3) };
+    }
+    // Proto: WebcastQuestionNewMessage { MessageType type=1, QuestionDetails questionDetails=2 }
+    //   QuestionDetails { string questionText=2, User user=5 }
+    case "WebcastQuestionNewMessage": {
+      let questionText = "", user = { id: "0", nickname: "", uniqueId: "" };
+      const detailBuf = getBytes(f, 2);
+      if (detailBuf) {
+        const df = decodeProto(detailBuf);
+        questionText = getStr(df, 2);
+        const userBuf = getBytes(df, 5);
+        if (userBuf) user = parseUser(userBuf);
+      }
+      return { ...base, type: "question", user, questionText };
     }
-    case "WebcastRoomUserSeqMessage":
-      return { ...base, type: "roomUserSeq", viewerCount: getInt(f, 3), totalViewers: getInt(f, 4) };
-    case "WebcastLinkMicBattle":
-      return { ...base, type: "battle", status: getInt(f, 3) };
-    case "WebcastLinkMicArmies":
-      return { ...base, type: "battleArmies" };
-    case "WebcastSubNotifyMessage":
-      return { ...base, type: "subscribe", user, subMonth: getInt(f, 8) };
-    case "WebcastEmoteChatMessage":
-      return { ...base, type: "emoteChat", user, emoteId: getStr(f, 3) };
-    case "WebcastEnvelopeMessage":
-      return { ...base, type: "envelope", diamondCount: getInt(f, 3) };
-    case "WebcastQuestionNewMessage":
-      return { ...base, type: "question", user, questionText: getStr(f, 3) };
     case "WebcastRankUpdateMessage":
-    case "WebcastHourlyRankMessage":
-      return { ...base, type: "rankUpdate", rankType: getStr(f, 3) };
+    case "WebcastHourlyRankMessage": {
+      const rankType = getStr(f, 1) || `rank_${getInt(f, 1)}`;
+      const rankList = [];
+      const listBufs = getAllBytes(f, 2);
+      for (const lb of listBufs) {
+        try {
+          const rf = decodeProto(lb);
+          const userBuf = getBytes(rf, 1);
+          const rank = getInt(rf, 2);
+          const score = getInt(rf, 3);
+          const user = userBuf ? parseUser(userBuf) : { id: "0", nickname: "", uniqueId: "" };
+          rankList.push({ user, rank, score });
+        } catch {
+        }
+      }
+      return { ...base, type: "rankUpdate", rankType, rankList };
+    }
+    // Proto: WebcastControlMessage { int32 action=2 }
     case "WebcastControlMessage":
-      return { ...base, type: "control", action: getInt(f, 2) };
+      return { ...base, type: "control", action: getInt(f, 2) || getInt(f, 1) };
     case "WebcastRoomMessage":
     case "RoomMessage":
-      return { ...base, type: "room", status: getStr(f, 3) };
-    case "WebcastLiveIntroMessage":
-      return { ...base, type: "liveIntro", title: getStr(f, 3) };
+      return { ...base, type: "room", status: getInt(f, 2) };
+    // Proto: WebcastLiveIntroMessage { uint64 id=2, string description=4, User user=5 }
+    case "WebcastLiveIntroMessage": {
+      const roomId = String(getInt(f, 2));
+      const title = getStr(f, 4) || getStr(f, 2);
+      return { ...base, type: "liveIntro", roomId, title };
+    }
     case "WebcastLinkMicMethod":
-    case "WebcastLinkmicBattleTaskMessage":
-      return { ...base, type: "linkMic", action: getInt(f, 3) };
+    case "WebcastLinkmicBattleTaskMessage": {
+      const action = getStr(f, 1) || `action_${getInt(f, 1)}`;
+      const users = [];
+      const userBufs = getAllBytes(f, 2);
+      for (const ub of userBufs) {
+        try {
+          users.push(parseUser(ub));
+        } catch {
+        }
+      }
+      return { ...base, type: "linkMic", action, users };
+    }
     default:
       return { ...base, type: "unknown", method };
   }