tiktok-live-proto-full-types 0.0.1

package/README.md

@@ -0,0 +1,31 @@
+# tiktok-live-proto-full-types
+
+Types-only TypeScript declarations for the **full** TikTok Webcast Protobuf
+schema. No wire codec, no runtime, no proto field numbers — just interfaces.
+
+Use this when you want to type-check against the full schema without pulling in
+the private `@eulerstream/tiktok-live-proto-full` runtime package.
+
+## Install
+
+```sh
+npm install --save-dev tiktok-live-proto-full-types
+```
+
+## Usage
+
+```ts
+import type { WebcastResponse } from 'tiktok-live-proto-full-types/v1';
+import type { WebcastResponse as WebcastResponseV2 } from 'tiktok-live-proto-full-types/v2';
+```
+
+## Layout
+
+- Generated by `ts-proto` with `--ts_proto_opt=onlyTypes=true` from the
+  schemas in the private `src/full/` submodule
+- `dist/{v1,v2}.d.ts` — published declaration output
+
+## Pairs with
+
+- `@eulerstream/tiktok-live-proto-full` — the full runtime (private)
+- `tiktok-live-proto` — the public slim runtime

package/dist/v1.d.ts

@@ -0,0 +1,356 @@
+//#region src/generated/v1/tiktok-schema.d.ts
+declare const protobufPackage = "TikTok";
+declare enum ControlAction {
+  CONTROL_ACTION_FALLBACK_UNKNOWN = 0,
+  CONTROL_ACTION_STREAM_PAUSED = 1,
+  CONTROL_ACTION_STREAM_UNPAUSED = 2,
+  CONTROL_ACTION_STREAM_ENDED = 3,
+  CONTROL_ACTION_STREAM_SUSPENDED = 4,
+  UNRECOGNIZED = -1
+}
+/** Data structure from im/fetch/ response */
+interface WebcastResponse {
+  cursor: string;
+  fetchInterval: number;
+  /** ws (1) or polling (2) */
+  fetchType: number;
+  heartbeatDuration: number;
+  internalExt: string;
+  messages: Message[];
+  needAck: boolean;
+  serverTimestamp: string;
+  wsParams: WebsocketParam[];
+  wsUrl: string;
+}
+interface Message {
+  binary: Uint8Array;
+  type: string;
+}
+interface WebsocketParam {
+  name: string;
+  value: string;
+}
+/** Message types depending on Message.tyoe */
+interface WebcastControlMessage {
+  action: ControlAction;
+}
+/** Statistics like viewer count */
+interface WebcastRoomUserSeqMessage {
+  topViewers: TopUser[];
+  viewerCount: number;
+}
+interface TopUser {
+  coinCount: string;
+  user: User | undefined;
+}
+interface ImageModel {
+  avgColor: string;
+  content: ImageModel_Content | undefined;
+  height: number;
+  imageType: number;
+  isAnimated: boolean;
+  mUri: string;
+  mUrls: string[];
+  schema: string;
+  width: number;
+}
+interface ImageModel_Content {
+  fontColor: string;
+  level: string;
+  name: string;
+}
+interface WebcastChatMessage {
+  atUser: User | undefined;
+  background: ImageModel | undefined;
+  backgroundImageV2: ImageModel | undefined;
+  comment: string;
+  commentQualityScores: WebcastChatMessage_CommentQualityScore[];
+  commentTag: WebcastChatMessage_CommentTag[];
+  communityflaggedStatus: number;
+  contentLanguage: string;
+  ecStreamerKey: string;
+  emotes: WebcastSubEmote[];
+  event: WebcastMessageEvent | undefined;
+  fullScreenTextColor: string;
+  giftImage: ImageModel | undefined;
+  inputType: number;
+  quickChatScene: number;
+  screenTime: string;
+  signature: string;
+  signatureVersion: string;
+  user: User | undefined;
+  userIdentity: WebcastChatMessage_UserIdentity | undefined;
+  visibleToSender: boolean;
+}
+declare enum WebcastChatMessage_CommentTag {
+  COMMENT_TAG_NORMAL = 0,
+  COMMENT_TAG_CANDIDATE = 1,
+  COMMENT_TAG_OVERAGE = 2,
+  UNRECOGNIZED = -1
+}
+interface WebcastChatMessage_UserIdentity {
+  isAnchor: boolean;
+  isFollowerOfAnchor: boolean;
+  isGiftGiverOfAnchor: boolean;
+  isModeratorOfAnchor: boolean;
+  isMutualFollowingWithAnchor: boolean;
+  isSubscriberOfAnchor: boolean;
+}
+interface WebcastChatMessage_CommentQualityScore {
+  score: string;
+  version: string;
+}
+interface EmoteUploadInfo {
+  emoteUploadSource?: EmoteUploadInfo_UserEmoteUploadSource | undefined;
+  userId: string;
+  userIdStr: string;
+  userInfo: User | undefined;
+}
+declare enum EmoteUploadInfo_UserEmoteUploadSource {
+  USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_ANCHOR = 0,
+  USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_SUBSCRIBER = 1,
+  USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_MODERATOR = 2,
+  UNRECOGNIZED = -1
+}
+/** Chat Emotes (Subscriber) */
+interface WebcastEmoteChatMessage {
+  emote: EmoteDetails | undefined;
+  user: User | undefined;
+}
+interface WebcastSubEmote {
+  emote: EmoteDetails | undefined;
+  /** starting at 0, you insert the emote itself into the comment at that place */
+  placeInComment: number;
+}
+interface WebcastMemberMessage {
+  actionId: number;
+  event: WebcastMessageEvent | undefined;
+  user: User | undefined;
+}
+interface WebcastGiftMessage {
+  event: WebcastMessageEvent | undefined;
+  giftDetails: WebcastGiftMessageGiftDetails | undefined;
+  giftExtra: WebcastGiftMessageGiftExtra | undefined;
+  giftId: number;
+  groupId: string;
+  monitorExtra: string;
+  repeatCount: number;
+  repeatEnd: number;
+  user: User | undefined;
+}
+interface WebcastGiftMessageGiftDetails {
+  describe: string;
+  diamondCount: number;
+  giftImage: WebcastGiftMessageGiftImage | undefined;
+  giftName: string;
+  giftType: number;
+}
+/** Taken from https://github.com/Davincible/gotiktoklive/blob/da4630622bc586629a53faae64e8c53509af29de/proto/tiktok.proto#L57 */
+interface WebcastGiftMessageGiftExtra {
+  receiverUserId: string;
+  timestamp: string;
+}
+interface WebcastGiftMessageGiftImage {
+  giftPictureUrl: string;
+}
+/** Battle start */
+interface WebcastLinkMicBattle {
+  battleUsers: WebcastLinkMicBattleItems[];
+}
+interface WebcastLinkMicBattleItems {
+  battleGroup: WebcastLinkMicBattleGroup | undefined;
+}
+interface WebcastLinkMicBattleGroup {
+  user: LinkUser | undefined;
+}
+/** Battle status */
+interface WebcastLinkMicArmies {
+  battleItems: WebcastLinkMicArmiesItems[];
+  battleStatus: number;
+}
+interface WebcastLinkMicArmiesItems {
+  battleGroups: WebcastLinkMicArmiesGroup[];
+  hostUserId: string;
+}
+interface WebcastLinkMicArmiesGroup {
+  points: number;
+  users: User[];
+}
+/** Follow & share event */
+interface WebcastSocialMessage {
+  event: WebcastMessageEvent | undefined;
+  user: User | undefined;
+}
+/** Like event (is only sent from time to time, not with every like) */
+interface WebcastLikeMessage {
+  event: WebcastMessageEvent | undefined;
+  likeCount: number;
+  totalLikeCount: number;
+  user: User | undefined;
+}
+/** New question event */
+interface WebcastQuestionNewMessage {
+  questionDetails: QuestionDetails | undefined;
+}
+interface QuestionDetails {
+  questionText: string;
+  user: User | undefined;
+}
+interface WebcastMessageEvent {
+  createTime: string;
+  eventDetails: WebcastMessageEventDetails | undefined;
+  msgId: string;
+}
+/** Contains UI information */
+interface WebcastMessageEventDetails {
+  displayType: string;
+  label: string;
+}
+/** Source: Co-opted https://github.com/zerodytrash/TikTok-Livestream-Chat-Connector/issues/19#issuecomment-1074150342 */
+interface WebcastLiveIntroMessage {
+  description: string;
+  id: string;
+  user: User | undefined;
+}
+interface SystemMessage {
+  description: string;
+}
+interface WebcastInRoomBannerMessage {
+  data: string;
+}
+interface RankItem {
+  colour: string;
+  id: string;
+}
+interface WeeklyRanking {
+  label: string;
+  rank: RankItem | undefined;
+  type: string;
+}
+interface RankContainer {
+  rankings: WeeklyRanking | undefined;
+}
+interface WebcastHourlyRankMessage {
+  data: RankContainer | undefined;
+}
+interface EmoteDetails {
+  emoteId: string;
+  image: EmoteImage | undefined;
+}
+interface EmoteImage {
+  imageUrl: string;
+}
+/**
+ * Envelope (treasure boxes)
+ * Taken from https://github.com/ThanoFish/TikTok-Live-Connector/blob/9b215b96792adfddfb638344b152fa9efa581b4c/src/proto/tiktokSchema.proto
+ */
+interface WebcastEnvelopeMessage {
+  treasureBoxData: TreasureBoxData | undefined;
+  treasureBoxUser: TreasureBoxUser | undefined;
+}
+interface TreasureBoxUser {
+  user2: TreasureBoxUser2 | undefined;
+}
+interface TreasureBoxUser2 {
+  user3: TreasureBoxUser3[];
+}
+interface TreasureBoxUser3 {
+  user4: TreasureBoxUser4 | undefined;
+}
+interface TreasureBoxUser4 {
+  user: User | undefined;
+}
+interface TreasureBoxData {
+  canOpen: number;
+  coins: number;
+  timestamp: string;
+}
+/** New Subscriber message */
+interface WebcastSubNotifyMessage {
+  event: WebcastMessageEvent | undefined;
+  exhibitionType: number;
+  oldSubscribeStatus: number;
+  subMonth: number;
+  subscribeType: number;
+  subscribingStatus: number;
+  user: User | undefined;
+}
+interface User {
+  badges: UserBadgesAttributes[];
+  bioDescription: string;
+  createTime: string;
+  followInfo: FollowInfo | undefined;
+  nickname: string;
+  profilePicture: ProfilePicture | undefined;
+  secUid: string;
+  uniqueId: string;
+  userId: string;
+}
+interface FollowInfo {
+  followerCount: number;
+  followingCount: number;
+  followStatus: number;
+  pushStatus: number;
+}
+interface LinkUser {
+  nickname: string;
+  profilePicture: ProfilePicture | undefined;
+  uniqueId: string;
+  userId: string;
+}
+interface ProfilePicture {
+  urls: string[];
+}
+interface UserBadgesAttributes {
+  badges: UserBadge[];
+  badgeSceneType: number;
+  imageBadges: UserImageBadge[];
+  privilegeLogExtra: PrivilegeLogExtra | undefined;
+}
+interface PrivilegeLogExtra {
+  level: string;
+  privilegeId: string;
+}
+interface UserBadge {
+  name: string;
+  type: string;
+}
+interface UserImageBadge {
+  displayType: number;
+  image: UserImageBadgeImage | undefined;
+}
+interface UserImageBadgeImage {
+  url: string;
+}
+/** Websocket incoming message structure */
+interface WebcastWebsocketMessage {
+  binary: Uint8Array;
+  id: string;
+  type: string;
+}
+/** Websocket acknowledgment message */
+interface WebcastWebsocketAck {
+  id: string;
+  type: string;
+}
+interface WebcastBarrageMessage {
+  content: WebcastBarrageMessage_Text | undefined;
+  event: WebcastMessageEvent | undefined;
+  msgType: number;
+}
+interface WebcastBarrageMessage_Text {
+  defaultPattern: string;
+  key: string;
+  pieces: WebcastBarrageMessage_TextPiece[];
+}
+interface WebcastBarrageMessage_TextPiece {
+  stringValue: string;
+  type: number;
+  userValue: WebcastBarrageMessage_TextPieceUser | undefined;
+}
+interface WebcastBarrageMessage_TextPieceUser {
+  user: User | undefined;
+  withColon: boolean;
+}
+//#endregion
+export { ControlAction, EmoteDetails, EmoteImage, EmoteUploadInfo, EmoteUploadInfo_UserEmoteUploadSource, FollowInfo, ImageModel, ImageModel_Content, LinkUser, Message, PrivilegeLogExtra, ProfilePicture, QuestionDetails, RankContainer, RankItem, SystemMessage, TopUser, TreasureBoxData, TreasureBoxUser, TreasureBoxUser2, TreasureBoxUser3, TreasureBoxUser4, User, UserBadge, UserBadgesAttributes, UserImageBadge, UserImageBadgeImage, WebcastBarrageMessage, WebcastBarrageMessage_Text, WebcastBarrageMessage_TextPiece, WebcastBarrageMessage_TextPieceUser, WebcastChatMessage, WebcastChatMessage_CommentQualityScore, WebcastChatMessage_CommentTag, WebcastChatMessage_UserIdentity, WebcastControlMessage, WebcastEmoteChatMessage, WebcastEnvelopeMessage, WebcastGiftMessage, WebcastGiftMessageGiftDetails, WebcastGiftMessageGiftExtra, WebcastGiftMessageGiftImage, WebcastHourlyRankMessage, WebcastInRoomBannerMessage, WebcastLikeMessage, WebcastLinkMicArmies, WebcastLinkMicArmiesGroup, WebcastLinkMicArmiesItems, WebcastLinkMicBattle, WebcastLinkMicBattleGroup, WebcastLinkMicBattleItems, WebcastLiveIntroMessage, WebcastMemberMessage, WebcastMessageEvent, WebcastMessageEventDetails, WebcastQuestionNewMessage, WebcastResponse, WebcastRoomUserSeqMessage, WebcastSocialMessage, WebcastSubEmote, WebcastSubNotifyMessage, WebcastWebsocketAck, WebcastWebsocketMessage, WebsocketParam, WeeklyRanking, protobufPackage };

package/dist/v1.js

@@ -0,0 +1,27 @@
+//#region src/generated/v1/tiktok-schema.ts
+const protobufPackage = "TikTok";
+let ControlAction = /* @__PURE__ */ function(ControlAction) {
+	ControlAction[ControlAction["CONTROL_ACTION_FALLBACK_UNKNOWN"] = 0] = "CONTROL_ACTION_FALLBACK_UNKNOWN";
+	ControlAction[ControlAction["CONTROL_ACTION_STREAM_PAUSED"] = 1] = "CONTROL_ACTION_STREAM_PAUSED";
+	ControlAction[ControlAction["CONTROL_ACTION_STREAM_UNPAUSED"] = 2] = "CONTROL_ACTION_STREAM_UNPAUSED";
+	ControlAction[ControlAction["CONTROL_ACTION_STREAM_ENDED"] = 3] = "CONTROL_ACTION_STREAM_ENDED";
+	ControlAction[ControlAction["CONTROL_ACTION_STREAM_SUSPENDED"] = 4] = "CONTROL_ACTION_STREAM_SUSPENDED";
+	ControlAction[ControlAction["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+	return ControlAction;
+}({});
+let WebcastChatMessage_CommentTag = /* @__PURE__ */ function(WebcastChatMessage_CommentTag) {
+	WebcastChatMessage_CommentTag[WebcastChatMessage_CommentTag["COMMENT_TAG_NORMAL"] = 0] = "COMMENT_TAG_NORMAL";
+	WebcastChatMessage_CommentTag[WebcastChatMessage_CommentTag["COMMENT_TAG_CANDIDATE"] = 1] = "COMMENT_TAG_CANDIDATE";
+	WebcastChatMessage_CommentTag[WebcastChatMessage_CommentTag["COMMENT_TAG_OVERAGE"] = 2] = "COMMENT_TAG_OVERAGE";
+	WebcastChatMessage_CommentTag[WebcastChatMessage_CommentTag["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+	return WebcastChatMessage_CommentTag;
+}({});
+let EmoteUploadInfo_UserEmoteUploadSource = /* @__PURE__ */ function(EmoteUploadInfo_UserEmoteUploadSource) {
+	EmoteUploadInfo_UserEmoteUploadSource[EmoteUploadInfo_UserEmoteUploadSource["USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_ANCHOR"] = 0] = "USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_ANCHOR";
+	EmoteUploadInfo_UserEmoteUploadSource[EmoteUploadInfo_UserEmoteUploadSource["USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_SUBSCRIBER"] = 1] = "USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_SUBSCRIBER";
+	EmoteUploadInfo_UserEmoteUploadSource[EmoteUploadInfo_UserEmoteUploadSource["USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_MODERATOR"] = 2] = "USER_EMOTE_UPLOAD_SOURCE_EMOTE_UPLOAD_SOURCE_MODERATOR";
+	EmoteUploadInfo_UserEmoteUploadSource[EmoteUploadInfo_UserEmoteUploadSource["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+	return EmoteUploadInfo_UserEmoteUploadSource;
+}({});
+//#endregion
+export { ControlAction, EmoteUploadInfo_UserEmoteUploadSource, WebcastChatMessage_CommentTag, protobufPackage };