floating-live 0.8.0

package/src/lib/Registerable.js

@@ -0,0 +1,67 @@
+"use strict";
+// Plugin System modified from PicGo
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCurrentPluginName = exports.setCurrentPluginName = exports.Registerable = void 0;
+/** 插件可注册对象模块 */
+class Registerable {
+    constructor(name) {
+        this.name = name;
+        this.list = new Map();
+        this.pluginIdMap = new Map();
+    }
+    /** 注册一个对象 */
+    register(id, item) {
+        // 如果组件缺少id, 或者id与已安装插件重复, 则报错
+        if (!id)
+            throw new TypeError("id is required!");
+        if (this.list.has(id))
+            throw new TypeError(`${this.name} duplicate id: ${id}!`);
+        // 将组件添加至列表中
+        this.list.set(id, item);
+        // 将插件名称与注册id关联
+        if (Registerable.currentPlugin) {
+            if (this.pluginIdMap.has(Registerable.currentPlugin)) {
+                this.pluginIdMap.get(Registerable.currentPlugin)?.push(id);
+            }
+            else {
+                this.pluginIdMap.set(Registerable.currentPlugin, [id]);
+            }
+        }
+    }
+    /** 取消某一插件在该模块中的注册 */
+    unregister(pluginName) {
+        if (this.pluginIdMap.has(pluginName)) {
+            const handlerList = this.pluginIdMap.get(pluginName);
+            handlerList?.forEach((plugin) => {
+                this.list.delete(plugin);
+            });
+        }
+    }
+    /** 获取名称 */
+    getName() {
+        return this.name;
+    }
+    /** 根据id获取注册对象 */
+    get(id) {
+        return this.list.get(id);
+    }
+    /** 获取注册对象列表 */
+    getList() {
+        return [...this.list.values()];
+    }
+    /** 获取注册id列表 */
+    getIdList() {
+        return [...this.list.keys()];
+    }
+}
+exports.Registerable = Registerable;
+/** 设置当前安装插件名称 */
+const setCurrentPluginName = (name = null) => {
+    Registerable.currentPlugin = name;
+};
+exports.setCurrentPluginName = setCurrentPluginName;
+/** 获取当前安装插件名称 */
+const getCurrentPluginName = () => {
+    return Registerable.currentPlugin;
+};
+exports.getCurrentPluginName = getCurrentPluginName;

package/src/types/message/AttributeInfo.d.ts

@@ -0,0 +1,64 @@
+/** 用户信息 */
+export interface UserInfo {
+    /** 用户名 */
+    name: string;
+    /** 用户id */
+    id: number;
+    /** 头像url */
+    avatar?: string;
+    /** 粉丝勋章 */
+    medal?: MedalInfo | null;
+    /** 房管等级(1为主播, 2为管理员) */
+    admin?: number;
+    /** 粉丝vip等级 */
+    privilege?: boolean | number;
+    /** vip等级 */
+    vip?: boolean | number;
+    /** 用户等级 */
+    level?: number;
+}
+/** 粉丝牌信息 */
+export interface MedalInfo {
+    /** 粉丝牌名称 */
+    name: string;
+    /** 粉丝牌id */
+    id: number;
+    /** 粉丝牌等级 */
+    level?: number;
+    /** 粉丝vip等级 */
+    privilege?: number;
+}
+/** 图像信息 */
+export interface ImageInfo {
+    /** 图像名称 */
+    name?: string;
+    /** 图像id */
+    id?: string | number;
+    /** 图像url */
+    url?: string;
+    /** 图像尺寸 */
+    size?: [number, number];
+}
+/** 礼物信息 */
+export interface GiftInfo {
+    /** 礼物名称 */
+    name: string;
+    /** 礼物id */
+    id: number | string;
+    /** 礼物数量 */
+    num: number;
+    /** 总价值 */
+    value: number;
+    /** 平台货币 */
+    currency: string;
+    /** 礼物连击数 */
+    combo?: string;
+    /** 礼物连击id */
+    combo_id?: string;
+    /** 人民币价值 */
+    cny?: number;
+    /** 行为 */
+    action?: string;
+    /** 随机礼物信息 */
+    blind_gift?: GiftInfo;
+}

package/src/types/message/AttributeInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/message/MessageData.d.ts

@@ -0,0 +1,80 @@
+import { MessageInfo, MsgInfoBlock, MsgInfoGift, MsgInfoImage, MsgInfoInteract, MsgInfoPrivilege, MsgInfoSuperchat, MsgInfoText } from "./MessageInfo";
+import { LiveStats } from "../room/LiveInfo";
+export interface MessageData {
+    /** 平台名称 */
+    platform: string;
+    /** 房间号 */
+    room: number | string;
+    /** 信息类型 */
+    type: string;
+    /** 数据信息 */
+    info: MessageInfo;
+    /** 本地时间戳 */
+    local_timestamp?: number;
+    /** 其他属性 */
+    [attr: string]: any;
+}
+export interface MessageText extends MessageData {
+    type: "text";
+    info: MsgInfoText;
+}
+/** 图片聊天消息 */
+export interface MessageImage extends MessageData {
+    type: "image";
+    info: MsgInfoImage;
+}
+/** 礼物消息 */
+export interface MessageGift extends MessageData {
+    type: "gift";
+    info: MsgInfoGift;
+}
+/** 互动消息(进入直播间、点赞、关注、分享、加入粉丝团) */
+export interface MessageInteract extends MessageData {
+    type: "entry" | "like" | "follow" | "share" | "join";
+    info: MsgInfoInteract;
+}
+/** 粉丝vip开通消息 */
+export interface MessagePrivilege extends MessageData {
+    type: "privilege";
+    info: MsgInfoPrivilege;
+}
+/** 粉丝vip开通消息 */
+export interface MessageSuperchat extends MessageData {
+    type: "superchat";
+    info: MsgInfoSuperchat;
+}
+/** 禁言消息 */
+export interface MessageBlock extends MessageData {
+    type: "block";
+    info: MsgInfoBlock;
+}
+/** 直播开播消息 */
+export interface MessageLiveStart extends MessageData {
+    type: "live_start";
+    info: {
+        /** 开播时间 */
+        start_time: number;
+    };
+}
+/** 直播切断消息 */
+export interface MessageLiveCut extends MessageData {
+    type: "live_cut";
+    info: {
+        /** 切断消息 */
+        message: string;
+    };
+}
+/** 直播数据更新 */
+export interface MessageLiveStats extends MessageData {
+    type: "live_stats";
+    info: LiveStats;
+}
+/** 直播结束 */
+export interface MessageLiveEnd extends MessageData {
+    type: "live_end";
+    info: {
+        /** 直播状态 */
+        status: "live" | "off" | "round" | "banned";
+    };
+}
+export declare type MessageType = MessageText | MessageImage | MessageGift | MessageInteract | MessagePrivilege | MessageSuperchat | MessageBlock | MessageLiveStart | MessageLiveCut | MessageLiveStats | MessageLiveEnd;

package/src/types/message/MessageData.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/message/MessageInfo.d.ts

@@ -0,0 +1,123 @@
+import { UserInfo, ImageInfo, GiftInfo } from "./AttributeInfo";
+/** 聊天板信息 */
+export interface MessageInfo {
+    /** 消息id */
+    msg_id?: string;
+    /** id */
+    id?: string;
+    /** 用户信息 */
+    user?: UserInfo;
+    /** 日期时间戳 */
+    timestamp?: number;
+    /** 文本内容 */
+    text?: string;
+    /** 文字颜色 */
+    color?: number | string;
+    /** 弹幕模式 */
+    mode?: number | string;
+    /** 文字大小 */
+    size?: number | string;
+    /** 图片信息 */
+    image?: ImageInfo;
+    /** 礼物信息 */
+    gift?: GiftInfo;
+    /** (SC)持续时间 */
+    duration?: number;
+    /** 其他属性 */
+    [attr: string]: any;
+}
+/** 文字聊天信息 */
+export interface MsgInfoText {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 文本内容 */
+    text: string;
+    /** 文字颜色 */
+    color?: number | string;
+    /** 弹幕模式 */
+    mode?: number | string;
+    /** 文字大小 */
+    size?: number | string;
+    /** 信息标签 */
+    tag?: string | boolean;
+}
+/** 图片聊天信息 */
+export interface MsgInfoImage {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 弹幕模式 */
+    mode?: number | string;
+    /** 文字大小 */
+    size?: number | string;
+    /** 图片信息 */
+    image: ImageInfo;
+    /** 信息标签 */
+    tag?: string | boolean;
+}
+/** 礼物信息 */
+export interface MsgInfoGift {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 礼物信息 */
+    gift: GiftInfo;
+}
+/** 互动信息 */
+export interface MsgInfoInteract {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 信息标签 */
+    tag?: string | boolean;
+}
+/** 粉丝付费会员开通信息 */
+export interface MsgInfoPrivilege {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 礼物信息 */
+    gift: GiftInfo;
+    /** 开通vip名称 */
+    name: string;
+    /** 开通vip等级 */
+    level?: number;
+    /** 持续时间(天数) */
+    duration: number;
+    /** 续费类型(0为非续费开通, 1为续费, 2为自动续费) */
+    renew?: 0 | 1 | 2;
+}
+/** 付费留言信息 */
+export interface MsgInfoSuperchat {
+    /** 留言id */
+    id?: string;
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp: number;
+    /** 文本内容 */
+    text: string;
+    /** 文字颜色 */
+    color?: number | string;
+    /** 礼物信息 */
+    gift: GiftInfo;
+    /** (SC)持续时间 */
+    duration: number;
+}
+/** 禁言信息 */
+export interface MsgInfoBlock {
+    /** 用户信息 */
+    user: UserInfo;
+    /** 日期时间戳 */
+    timestamp?: number;
+    /** 操作者 */
+    operator: UserInfo | {
+        admin: number;
+    };
+}

package/src/types/message/MessageInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/plugin/Plugin.d.ts

@@ -0,0 +1,3 @@
+import FloatingLive from "../..";
+/** 插件模块, 加载时调用 */
+export declare type FLivePlugin<T = void> = (ctx: FloatingLive) => T;

package/src/types/plugin/Plugin.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/room/LiveInfo.d.ts

@@ -0,0 +1,24 @@
+/** 直播信息 */
+export interface LiveInfo {
+    /** 直播标题 */
+    title: string;
+    /** 分区 */
+    area?: string[];
+    /** 封面url */
+    cover?: string;
+    /** 直播状态(直播/关播/轮播/封禁) */
+    status: "live" | "off" | "round" | "banned";
+    /** 开始直播时间 */
+    start_time: number;
+}
+/** 直播统计信息 */
+export interface LiveStats {
+    /** 在线人数 */
+    online?: number;
+    /** 已观看人数 */
+    watched?: number;
+    /** 点赞数 */
+    like?: number;
+    /** 人气值 */
+    popularity?: number;
+}

package/src/types/room/LiveInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/room/LiveRoom.d.ts

@@ -0,0 +1,20 @@
+import RoomInfo from "./RoomInfo";
+interface LiveRoom extends RoomInfo {
+    /** 直播平台 */
+    readonly platform: string;
+    /** 房间id */
+    readonly id: number;
+    /** 打开连接 */
+    open: () => void;
+    /** 关闭连接 */
+    close: () => void;
+    /** 销毁 */
+    destory: () => void;
+    /** 从服务器获取信息 */
+    getInfo: () => void;
+    /** 事件监听 */
+    on: (eventName: string | symbol, listener: (...args: any[]) => void) => this;
+    /** 移除事件监听 */
+    removeAllListeners: () => void;
+}
+export default LiveRoom;

package/src/types/room/LiveRoom.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/room/PlatformInfo.d.ts

@@ -0,0 +1,38 @@
+export interface PlatformInfo {
+    /** 平台名称 */
+    name: string;
+    /** 平台id */
+    id: string;
+    /** 平台vip信息 */
+    vip: {
+        /** 平台vip对应id */
+        id: string;
+        /** 平台vip名称 */
+        name: string;
+        /** 平台vip等级名称 */
+        level?: string[];
+    };
+    /** 粉丝vip信息 */
+    privilege: {
+        /** 粉丝vip对应id */
+        id: string;
+        /** 粉丝vip名称 */
+        name: string;
+        /** 粉丝vip等级名称 */
+        level?: string;
+    };
+    /** 礼物信息 */
+    gift: {
+        /** 货币 */
+        currency: Array<{
+            /** 货币id */
+            id: string;
+            /** 货币名称 */
+            name: string;
+            /** 1货币面值等值value (1面值/1数值) */
+            face: number;
+            /** 1人民币等值value (1.00CNY/1数值) (若为0则为免费货币) */
+            cny?: number;
+        }>;
+    };
+}

package/src/types/room/PlatformInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/types/room/RoomInfo.d.ts

@@ -0,0 +1,16 @@
+import { LiveInfo } from "./LiveInfo";
+import { UserInfo } from "../message/AttributeInfo";
+export default interface RoomInfo {
+    /** 平台id */
+    platform: string;
+    /** 房间id */
+    id: number;
+    /** 直播信息 */
+    live: LiveInfo;
+    /** 主播信息 */
+    anchor: UserInfo;
+    /** 直播间是否可用 */
+    available: boolean;
+    /** 房间是否打开 */
+    opening: boolean;
+}

package/src/types/room/RoomInfo.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/utils/getRoomInfo.d.ts

@@ -0,0 +1,4 @@
+import LiveRoom from "../types/room/LiveRoom";
+import RoomInfo from "../types/room/RoomInfo";
+/** 从房间中获取房间信息 */
+export default function getRoomInfo(liveroom: LiveRoom): RoomInfo;

package/src/utils/getRoomInfo.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/** 从房间中获取房间信息 */
+function getRoomInfo(liveroom) {
+    let { platform, id, live: { title, cover, area, status, start_time, }, anchor, available, opening, } = liveroom;
+    return {
+        platform,
+        id,
+        live: {
+            title,
+            cover,
+            area: area ? [...area] : undefined,
+            status,
+            start_time,
+        },
+        anchor: {
+            name: anchor.name,
+            id: anchor.id,
+            avatar: anchor.avatar
+        },
+        available,
+        opening,
+    };
+}
+exports.default = getRoomInfo;