feat: 红包抽奖消息

link #22

Author: ddiu8081

README.md

@@ -450,6 +450,8 @@ export interface SuperChatMsg {
 | --- | --- |
 | onGift | 收到礼物 |
 | onGuardBuy | 舰长上舰消息 |
+| onRedPocketStart | 用户开启红包抽奖 |
+| onRedPocketEnd | 红包抽奖结果 |
 
 <details>
 <summary>Type Definitions</summary>
@@ -526,6 +528,93 @@ export interface GuardBuyMsg {
   end_time: number
 }
 ```
+
+##### handler.onRedPocketStart
+
+用户开启红包抽奖
+
+```ts
+export type Handler = {
+  /** 用户开启红包抽奖 */
+  onRedPocketStart: (msg: Message<RedPocketStartMsg>) => void
+}
+
+type msgType = 'POPULARITY_RED_POCKET_START'
+
+export interface RedPocketStartMsg {
+  /** 红包抽奖id */
+  id: number
+  /** 红包发送用户 */
+  user: User
+  /** 开始时间，秒级时间戳 */
+  start_time: number
+  /** 结束时间，秒级时间戳 */
+  end_time: number
+  /** 持续时间，秒 */
+  duration: number
+  /** 口令弹幕内容 */
+  danmu: string
+  /** 红包奖品 */
+  awards: RedPocketStartAward[]
+  /** 奖品总价值，除以1000为RMB */
+  total_price: number
+}
+
+interface RedPocketStartAward {
+  /** 奖品id */
+  gift_id: number
+  /** 奖品名称 */
+  gift_name: string
+  /** 奖品图片 */
+  gift_pic: string
+  /** 奖品数量 */
+  num: number
+}
+```
+
+##### handler.onRedPocketEnd
+
+红包抽奖结果
+
+```ts
+export type Handler = {
+  /** 红包抽奖结果 */
+  onRedPocketEnd: (msg: Message<RedPocketEndMsg>) => void
+}
+
+type msgType = 'POPULARITY_RED_POCKET_WINNER_LIST'
+
+export interface RedPocketEndMsg {
+  /** 红包抽奖id */
+  id: number
+  /** 中奖人数 */
+  total_num: number
+  /** 中奖列表 */
+  winner: ({
+    /** 中奖用户uid */
+    uid: number
+    /** 中奖用户昵称 */
+    uname: string
+    /** 奖品id */
+    award_id: number
+  } & RedPocketEndAward)[]
+  /** 红包奖品列表 */
+  awards: Record<string, RedPocketEndAward>
+}
+
+interface RedPocketEndAward {
+  /** 奖品类型，待补充 */
+  award_type: number
+  /** 奖品名称 */
+  award_name: string
+  /** 奖品图片 */
+  award_pic: string
+  /** 奖品图片大图 */
+  award_big_pic: string
+  /** 奖品价值，除以1000为RMB */
+  award_price: number
+}
+```
 </details>
 
 #### 房间管理相关

src/listener/index.ts

@@ -7,6 +7,8 @@ import {
   INTERACT_WORD, ENTRY_EFFECT, LIKE_INFO_V3_CLICK, type UserActionMsgHandler,
   LIKE_INFO_V3_UPDATE, type LikedChangeMsgHandler,
   ONLINE_RANK_COUNT, type RankCountChangeMsgHandler,
+  POPULARITY_RED_POCKET_START, type RedPocketStartMsgHandler,
+  POPULARITY_RED_POCKET_WINNER_LIST, type RedPocketEndMsgHandler,
   room_admin_entrance, ROOM_ADMIN_REVOKE, type RoomAdminSetMsgHandler,
   ROOM_CHANGE, type RoomInfoChangeHandler,
   ROOM_SILENT_ON, ROOM_SILENT_OFF, type RoomSilentMsgHandler,
@@ -37,6 +39,8 @@ export type MsgHandler = Partial<
   & UserActionMsgHandler
   & LikedChangeMsgHandler
   & RankCountChangeMsgHandler
+  & RedPocketStartMsgHandler
+  & RedPocketEndMsgHandler
   & RoomAdminSetMsgHandler
   & RoomInfoChangeHandler
   & RoomSilentMsgHandler
@@ -168,6 +172,26 @@ export const listenAll = (instance: KeepLiveTCP | KeepLiveWS, roomId: number, ha
     })
   }
 
+  // POPULARITY_RED_POCKET_START
+  if (handler[POPULARITY_RED_POCKET_START.handlerName] || rawHandlerNames.has(POPULARITY_RED_POCKET_START.eventName)) {
+    rawHandlerNames.delete(POPULARITY_RED_POCKET_START.eventName)
+    instance.on(POPULARITY_RED_POCKET_START.eventName as any, (data: WSMessage<any>) => {
+      isHandleRaw && rawHandler[POPULARITY_RED_POCKET_START.eventName]?.(data.data)
+      const parsedData = POPULARITY_RED_POCKET_START.parser(data.data, roomId)
+      handler[POPULARITY_RED_POCKET_START.handlerName]?.(normalizeDanmu(POPULARITY_RED_POCKET_START.eventName, parsedData, data.data))
+    })
+  }
+
+  // POPULARITY_RED_POCKET_WINNER_LIST
+  if (handler[POPULARITY_RED_POCKET_WINNER_LIST.handlerName] || rawHandlerNames.has(POPULARITY_RED_POCKET_WINNER_LIST.eventName)) {
+    rawHandlerNames.delete(POPULARITY_RED_POCKET_WINNER_LIST.eventName)
+    instance.on(POPULARITY_RED_POCKET_WINNER_LIST.eventName as any, (data: WSMessage<any>) => {
+      isHandleRaw && rawHandler[POPULARITY_RED_POCKET_WINNER_LIST.eventName]?.(data.data)
+      const parsedData = POPULARITY_RED_POCKET_WINNER_LIST.parser(data.data, roomId)
+      handler[POPULARITY_RED_POCKET_WINNER_LIST.handlerName]?.(normalizeDanmu(POPULARITY_RED_POCKET_WINNER_LIST.eventName, parsedData, data.data))
+    })
+  }
+
   // room_admin_entrance, ROOM_ADMIN_REVOKE
   if (handler[room_admin_entrance.handlerName] || handler[ROOM_ADMIN_REVOKE.handlerName] || rawHandlerNames.has(room_admin_entrance.eventName) || rawHandlerNames.has(ROOM_SILENT_OFF.eventName)) {
     rawHandlerNames.delete(room_admin_entrance.eventName)

src/parser/POPULARITY_RED_POCKET_START.ts

@@ -0,0 +1,61 @@
+import type { Message, User } from '../types/app'
+
+export interface RedPocketStartMsg {
+  /** 红包抽奖id */
+  id: number
+  /** 红包发送用户 */
+  user: User
+  /** 开始时间，秒级时间戳 */
+  start_time: number
+  /** 结束时间，秒级时间戳 */
+  end_time: number
+  /** 持续时间，秒 */
+  duration: number
+  /** 口令弹幕内容 */
+  danmu: string
+  /** 红包奖品 */
+  awards: RedPocketStartAward[]
+  /** 奖品总价值，除以1000为RMB */
+  total_price: number
+}
+
+interface RedPocketStartAward {
+  /** 奖品id */
+  gift_id: number
+  /** 奖品名称 */
+  gift_name: string
+  /** 奖品图片 */
+  gift_pic: string
+  /** 奖品数量 */
+  num: number
+}
+
+const parser = (data: any, roomId: number): RedPocketStartMsg => {
+  const rawData = data.data
+
+  return {
+    id: rawData.lot_id,
+    user: {
+      uid: rawData.sender_uid,
+      uname: rawData.sender_name,
+      face: rawData.sender_face,
+    },
+    start_time: rawData.start_time,
+    end_time: rawData.end_time,
+    duration: rawData.last_time,
+    danmu: rawData.danmu,
+    awards: rawData.awards,
+    total_price: rawData.total_price,
+  }
+}
+
+export const POPULARITY_RED_POCKET_START = {
+  parser,
+  eventName: 'POPULARITY_RED_POCKET_START' as const,
+  handlerName: 'onRedPocketStart' as const,
+}
+
+export type Handler = {
+  /** 用户开启红包抽奖 */
+  onRedPocketStart: (msg: Message<RedPocketStartMsg>) => void
+}

src/parser/POPULARITY_RED_POCKET_WINNER_LIST.ts

@@ -0,0 +1,59 @@
+import type { Message } from '../types/app'
+
+export interface RedPocketEndMsg {
+  /** 红包抽奖id */
+  id: number
+  /** 中奖人数 */
+  total_num: number
+  /** 中奖列表 */
+  winner: ({
+    /** 中奖用户uid */
+    uid: number
+    /** 中奖用户昵称 */
+    uname: string
+    /** 奖品id */
+    award_id: number
+  } & RedPocketEndAward)[]
+  /** 红包奖品列表 */
+  awards: Record<string, RedPocketEndAward>
+}
+
+interface RedPocketEndAward {
+  /** 奖品类型，待补充 */
+  award_type: number
+  /** 奖品名称 */
+  award_name: string
+  /** 奖品图片 */
+  award_pic: string
+  /** 奖品图片大图 */
+  award_big_pic: string
+  /** 奖品价值，除以1000为RMB */
+  award_price: number
+}
+
+const parser = (data: any, roomId: number): RedPocketEndMsg => {
+  const rawData = data.data
+
+  return {
+    id: rawData.lot_id,
+    total_num: rawData.total_num,
+    winner: rawData.winner_info.map((item: any[]) => ({
+      uid: item[0],
+      uname: item[1],
+      award_id: item[3],
+      ...rawData.awards[item[3]],
+    })),
+    awards: rawData.awards,
+  }
+}
+
+export const POPULARITY_RED_POCKET_WINNER_LIST = {
+  parser,
+  eventName: 'POPULARITY_RED_POCKET_WINNER_LIST' as const,
+  handlerName: 'onRedPocketEnd' as const,
+}
+
+export type Handler = {
+  /** 红包抽奖结果 */
+  onRedPocketEnd: (msg: Message<RedPocketEndMsg>) => void
+}

src/parser/index.ts

@@ -6,6 +6,8 @@ export { GUARD_BUY, type Handler as GuardBuyHandler, type GuardBuyMsg } from './
 export { INTERACT_WORD, ENTRY_EFFECT, LIKE_INFO_V3_CLICK, type Handler as UserActionMsgHandler, type UserActionMsg } from './INTERACT_WORD_ENTRY_EFFECT'
 export { LIKE_INFO_V3_UPDATE, type Handler as LikedChangeMsgHandler, type LikedChangeMsg } from './LIKE_INFO_V3_UPDATE'
 export { ONLINE_RANK_COUNT, type Handler as RankCountChangeMsgHandler, type RankCountChangeMsg } from './ONLINE_RANK_COUNT'
+export { POPULARITY_RED_POCKET_START, type Handler as RedPocketStartMsgHandler, type RedPocketStartMsg } from './POPULARITY_RED_POCKET_START'
+export { POPULARITY_RED_POCKET_WINNER_LIST, type Handler as RedPocketEndMsgHandler, type RedPocketEndMsg } from './POPULARITY_RED_POCKET_WINNER_LIST'
 export { room_admin_entrance, ROOM_ADMIN_REVOKE, type Handler as RoomAdminSetMsgHandler, type RoomAdminSetMsg } from './ROOM_ADMIN'
 export { ROOM_CHANGE, type Handler as RoomInfoChangeHandler, type RoomInfoChangeMsg } from './ROOM_CHANGE'
 export { ROOM_SILENT_ON, ROOM_SILENT_OFF, type Handler as RoomSilentMsgHandler, type RoomSilentMsg } from './ROOM_SILENT'