floating-live 0.12.1 → 0.13.0

package/src/types/message.d.ts

@@ -0,0 +1,210 @@
+import { ImageSize, UserType } from "../enum";
+import { DanmakuMode, RoomStatus } from "../enum";
+import { RoomDetail, RoomStatsInfo } from "./room";
+export declare namespace Message {
+    interface Base {
+        /** 平台名称 */
+        platform: string;
+        /** 房间号 */
+        room: number | string;
+        /** 信息类型 */
+        type: string;
+        /** 时间戳 */
+        timestamp: number;
+        /** 消息id */
+        id: string;
+        /** 其他属性 */
+        [attr: string]: any;
+    }
+    /** 文本聊天消息 */
+    interface Chat extends Base {
+        type: "chat";
+        info: {
+            /** 用户信息 */
+            user: UserInfo;
+            /** 文本内容 */
+            content: string;
+            /** 文字颜色 */
+            color?: number | string;
+            /** 弹幕模式 */
+            mode?: DanmakuMode;
+            /** 文字大小 */
+            size?: number | string;
+            /** 图片信息 */
+            image?: ImageInfo;
+            /** 表情信息 */
+            emoticon?: {
+                [keyword: string]: ImageInfo;
+            };
+            /** 标签信息 */
+            tag?: string;
+        };
+    }
+    /** 礼物消息 */
+    interface Gift extends Base {
+        type: "gift";
+        info: {
+            /** 用户信息 */
+            user: UserInfo;
+            /** 礼物信息 */
+            gift: GiftInfo;
+        };
+    }
+    /** 互动消息(进入直播间、点赞、关注、分享、加入粉丝团) */
+    interface Interact extends Base {
+        type: "entry" | "like" | "follow" | "share" | "join";
+        info: {
+            /** 用户信息 */
+            user: UserInfo;
+            /** 信息标签 */
+            tag?: string | boolean;
+        };
+    }
+    /** 粉丝vip开通消息 */
+    interface Membership extends Base {
+        type: "membership";
+        info: {
+            /** 用户信息 */
+            user: UserInfo;
+            /** 礼物信息 */
+            gift: GiftInfo;
+            /** 开通vip名称 */
+            name: string;
+            /** 开通vip等级 */
+            level?: number;
+            /** 持续时间(天数) */
+            duration: number;
+        };
+    }
+    /** 粉丝vip开通消息 */
+    interface Superchat extends Base {
+        type: "superchat";
+        info: {
+            /** 留言id */
+            id: string;
+            /** 用户信息 */
+            user: UserInfo;
+            /** 文本内容 */
+            content: string;
+            /** 文字颜色 */
+            color?: number | string;
+            /** 礼物信息 */
+            gift: GiftInfo;
+            /** (SC)持续时间 */
+            duration: number;
+        };
+    }
+    /** 禁言消息 */
+    interface Block extends Base {
+        type: "block";
+        info: {
+            /** 用户信息 */
+            user: UserInfo;
+            /** 操作者 */
+            operator: UserInfo | {
+                type: null | UserType;
+            };
+        };
+    }
+    /** 直播开播消息 */
+    interface LiveStart extends Base {
+        type: "live_start";
+        info: {
+            /** 直播id */
+            id: string;
+        };
+    }
+    /** 直播结束 */
+    interface LiveEnd extends Base {
+        type: "live_end";
+        info: {
+            /** 直播状态 */
+            status: RoomStatus;
+        };
+    }
+    /** 直播切断消息 */
+    interface LiveCut extends Base {
+        type: "live_cut";
+        info: {
+            /** 切断消息 */
+            message: string;
+        };
+    }
+    /** 直播数据更新 */
+    interface LiveStats extends Base {
+        type: "live_stats";
+        info: RoomStatsInfo;
+    }
+    /** 直播展示信息更新 */
+    interface LiveDetail extends Base {
+        type: "live_detail";
+        info: RoomDetail;
+    }
+    type All = Chat | Gift | Interact | Membership | Superchat | Block | LiveStart | LiveEnd | LiveCut | LiveDetail | LiveStats;
+}
+/** 用户信息 */
+export interface UserInfo {
+    /** 用户名 */
+    name: string;
+    /** 用户id */
+    id: number;
+    /** 头像url */
+    avatar?: string;
+    /** 粉丝勋章 */
+    medal?: MedalInfo | null;
+    /** 用户类型 */
+    type?: UserType | null;
+    /** 粉丝vip等级 */
+    membership?: boolean | number;
+    /** vip等级 */
+    vip?: boolean | number;
+    /** 用户等级 */
+    level?: number;
+}
+/** 粉丝牌信息 */
+export interface MedalInfo {
+    /** 粉丝牌名称 */
+    name: string;
+    /** 粉丝牌id */
+    id: number;
+    /** 粉丝牌等级 */
+    level?: number;
+    /** 粉丝vip等级 */
+    membership?: number;
+}
+/** 图像信息 */
+export interface ImageInfo {
+    /** 图像名称 */
+    name?: string;
+    /** 图像id */
+    id?: string | number;
+    /** 图像url */
+    url?: string;
+    /** 图像尺寸 */
+    size?: ImageSize;
+}
+/** 礼物信息 */
+export interface GiftInfo {
+    /** 礼物名称 */
+    name: string;
+    /** 礼物id */
+    id: number | string;
+    /** 礼物数量 */
+    num: number;
+    /** 总价值 */
+    value: number;
+    /** 平台货币 */
+    currency: string;
+    /** 礼物连击数 */
+    combo?: string;
+    /** 礼物连击id */
+    comboId?: string;
+    /** 人民币价值 */
+    cny?: number;
+    /** 行为 */
+    action?: string;
+    /** 随机礼物信息 */
+    blindGift?: GiftInfo;
+    /** 图片信息 */
+    image?: string;
+}

package/src/types/plugin.d.ts

@@ -1,9 +1,8 @@
 import { FloatingLive } from "..";
 /** 插件模块, 加载时调用 */
 export declare type FloatingLivePlugin<T extends FloatingLive> = () => {
-    register: (ctx: T, config?: {
-        [key: string]: any;
-    }) => {
-        [key: string]: any;
-    } | void;
+    /** 插件名称 */
+    name: string;
+    register: (ctx: T) => object | void;
+    destroy?: (ctx: T) => void;
 };

package/src/types/room.d.ts

@@ -1,3 +1,51 @@
+import { RoomStatus } from "../enum";
+import { UserInfo } from "./message";
+export interface RoomInfo {
+    /** 平台id */
+    platform: string;
+    /** 房间id */
+    id: number | string;
+    /** 房间key */
+    key: string;
+    /** 基本信息 */
+    detail: RoomDetail;
+    /** 统计信息 */
+    stats?: RoomStatsInfo;
+    /** 主播信息 */
+    anchor: UserInfo;
+    /** 时间戳 */
+    timestamp: number;
+    /** 当前直播id */
+    liveId?: string;
+    /** 直播状态 */
+    status: RoomStatus;
+    /** 直播间是否可用 */
+    available: boolean;
+    /** 房间监听是否打开 */
+    opened: boolean;
+    /** 是否连接到房间 */
+    connected: boolean;
+}
+/** 房间展示信息 */
+export declare type RoomDetail = {
+    /** 直播标题 */
+    title?: string;
+    /** 分区 */
+    area?: string[];
+    /** 封面 */
+    cover?: string;
+};
+/** 房间统计数据信息 */
+export declare type RoomStatsInfo = {
+    /** 点赞数 */
+    like?: number;
+    /** 观看数 */
+    watch?: number;
+    /** 在线人数 */
+    online?: number;
+    /** 人气值 */
+    popularity?: number;
+};
 export interface PlatformInfo {
     /** 平台名称 */
     name: string;
@@ -36,5 +84,3 @@ export interface PlatformInfo {
         }>;
     };
 }
-export interface RoomConfig {
-}

package/src/utils.d.ts

@@ -1,2 +1,2 @@
-import { MessageData } from './types/message/MessageData';
-export declare function generateId(msg: MessageData): string;
+import { Message } from "./types/message";
+export declare function generateId(msg: Message.All): string;