floating-live 0.10.2 → 0.11.0

package/src/lib/LiveRoom.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
-import { UserInfo } from "../types/message/AttributeInfo";
-import { MessageData } from "../types/message/MessageData";
+import { RoomStatus } from "../enum";
+import { MessageData, UserInfo } from "../../src/types";
 export interface RoomInfo {
     /** 平台id */
     platform: string;
@@ -10,13 +10,15 @@ export interface RoomInfo {
     /** 房间key */
     key: string;
     /** 基本信息 */
-    base: RoomBaseInfo;
+    view: RoomViewInfo;
     /** 统计信息 */
     stats?: RoomStatsInfo;
     /** 主播信息 */
     anchor: UserInfo;
     /** 时间戳 */
     timestamp: number;
+    /** 当前直播id */
+    liveId?: string;
     /** 直播状态 */
     status: RoomStatus;
     /** 直播间是否可用 */
@@ -26,8 +28,8 @@ export interface RoomInfo {
     /** 是否连接到房间 */
     connected: boolean;
 }
-/** 房间基本信息 */
-export declare type RoomBaseInfo = {
+/** 房间展示信息 */
+export declare type RoomViewInfo = {
     /** 直播标题 */
     title?: string;
     /** 分区 */
@@ -46,8 +48,6 @@ export declare type RoomStatsInfo = {
     /** 人气值 */
     popularity?: number;
 };
-/** 房间状态 */
-export declare type RoomStatus = "live" | "off" | "round" | "banned";
 export declare abstract class LiveRoom extends EventEmitter implements RoomInfo {
     constructor();
     /** 平台 */
@@ -55,7 +55,7 @@ export declare abstract class LiveRoom extends EventEmitter implements RoomInfo
     /** 房间id */
     abstract readonly id: string | number;
     /** 基本信息 */
-    abstract base: RoomBaseInfo;
+    abstract view: RoomViewInfo;
     /** 统计信息 */
     stats?: RoomStatsInfo;
     /** 主播信息 */
@@ -64,6 +64,8 @@ export declare abstract class LiveRoom extends EventEmitter implements RoomInfo
     status: RoomStatus;
     /** 时间戳 */
     timestamp: number;
+    /** 当前直播id */
+    liveId?: string;
     /** 房间是否打开 */
     opening: boolean;
     /** 房间是否可用 */
@@ -84,5 +86,4 @@ export declare abstract class LiveRoom extends EventEmitter implements RoomInfo
     protected emitOrigin(msg: any): void;
     get info(): RoomInfo;
     get key(): string;
-    private msgCheck;
 }

package/src/lib/LiveRoom.js

@@ -2,11 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LiveRoom = void 0;
 const events_1 = require("events");
+const enum_1 = require("../enum");
 class LiveRoom extends events_1.EventEmitter {
     constructor() {
         super();
         /** 直播状态 */
-        this.status = "off";
+        this.status = enum_1.RoomStatus.off;
         /** 时间戳 */
         this.timestamp = 0;
         /** 房间是否打开 */
@@ -20,22 +21,45 @@ class LiveRoom extends events_1.EventEmitter {
     }
     // 发送消息
     emitMsg(msg) {
-        this.msgCheck(msg);
+        // 其他消息 => 先更改状态再发送消息
+        // 直播结束消息 => 先发送消息再更改状态
+        switch (msg.type) {
+            case "live_start":
+                this.status = enum_1.RoomStatus.live;
+                this.timestamp = msg.timestamp;
+                this.emit("status", enum_1.RoomStatus.live, { timestamp: msg.timestamp, id: msg.info.id });
+                break;
+            case "live_view":
+                this.view = Object.assign(this.view, msg.info);
+                this.emit("view", msg.info);
+                break;
+            case "live_stats":
+                this.stats = Object.assign(this.stats, msg.info);
+                break;
+            case "live_end":
+            case "live_cut":
+                this.emit("msg", msg);
+                this.status = msg.status || enum_1.RoomStatus.off;
+                this.timestamp = msg.timestamp;
+                this.emit("status", msg.status || enum_1.RoomStatus.off, { timestamp: msg.timestamp });
+                return;
+        }
         this.emit("msg", msg);
     }
     // 发送源消息
     emitOrigin(msg) {
-        this.emit("origin", msg);
+        this.emit("origin", msg, { platform: this.platform, room: this.id });
     }
     get info() {
         return {
             platform: this.platform,
             id: this.id,
-            base: this.base,
+            view: this.view,
             stats: this.stats,
             anchor: this.anchor,
             timestamp: this.timestamp,
             status: this.status,
+            liveId: this.liveId,
             available: this.available,
             opening: this.opening,
             connected: this.connected,
@@ -45,28 +69,5 @@ class LiveRoom extends events_1.EventEmitter {
     get key() {
         return `${this.platform}:${this.id}`;
     }
-    // 检测特定消息
-    msgCheck(msg) {
-        switch (msg.type) {
-            case "live_start":
-                this.status = "live";
-                this.timestamp = msg.info.timestamp || msg.record_time;
-                this.emit("status", "live", msg.info.timestamp);
-                break;
-            case "live_end":
-            case "live_cut":
-                this.status = msg.status || "off";
-                this.timestamp = msg.timestamp || msg.record_time;
-                this.emit("status", msg.status || "off", msg.timestamp || msg.record_time);
-                break;
-            case "live_change":
-                this.base = Object.assign(this.base, msg.info);
-                this.emit("change", msg.info);
-                break;
-            case "live_stats":
-                this.stats = Object.assign(this.stats, msg.info);
-                break;
-        }
-    }
 }
 exports.LiveRoom = LiveRoom;

package/src/module/Command.d.ts

@@ -1,2 +1,3 @@
-export declare class Command {
+import { Reglist } from "../lib/Reglist";
+export default class Command extends Reglist<(e: any, ...args: any) => void> {
 }

package/src/module/Command.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Command = void 0;
-class Command {
+const Reglist_1 = require("../lib/Reglist");
+class Command extends Reglist_1.Reglist {
 }
-exports.Command = Command;
+exports.default = Command;

package/src/module/Plugin.d.ts

@@ -1,6 +1,8 @@
 import { FloatingLive } from "..";
+import { FloatingLivePlugin } from "../types/plugin";
 export declare class PluginHandler<T extends FloatingLive> {
     private current;
+    /** 插件列表 */
     private list;
     private pluginEvent;
     private main;
@@ -14,9 +16,9 @@ export declare class PluginHandler<T extends FloatingLive> {
         [key: string]: any;
     } | undefined;
     /** 注册插件 */
-    register(name: string, pluginFunc: (main: T) => {
+    register(name: string, plugin: FloatingLivePlugin<T>, config?: {
         [key: string]: any;
-    } | void): void | {
+    }): void | {
         [key: string]: any;
     };
     /** 移除插件 */

package/src/module/Plugin.js

@@ -4,6 +4,7 @@ exports.PluginHandler = void 0;
 class PluginHandler {
     constructor(main) {
         this.current = null;
+        /** 插件列表 */
         this.list = new Map();
         this.pluginEvent = new Map();
         this.main = main;
@@ -26,22 +27,29 @@ class PluginHandler {
         return this.list.get(name);
     }
     /** 注册插件 */
-    register(name, pluginFunc) {
+    register(name, plugin, config) {
         if (this.list.has(name)) {
             this.main.emit("plugin_duplicate", name);
             return;
         }
         this.current = name;
         // 执行插件函数并获取插件操作对象
-        let pluginObject = pluginFunc(this.main);
-        this.list.set(name, pluginObject || {});
+        let pluginObject = plugin();
+        // 如果插件register函数无法调用，则无法注册插件
+        if (typeof pluginObject.register != 'function') {
+            this.main.emit("plugin_invalid", name);
+            this.current = null;
+            return;
+        }
+        let pluginExpose = pluginObject.register(this.main, config);
+        this.list.set(name, pluginExpose || {});
         // 执行钩子函数
         this.helper.pluginAddHandler.getList().forEach(handler => {
             handler(name);
         });
         this.main.emit("plugin_add", name);
         this.current = null;
-        return pluginObject;
+        return pluginExpose;
     }
     /** 移除插件 */
     unregister(name) {

package/src/module/Room.js

@@ -37,8 +37,8 @@ class RoomController {
             this.main.emit("live_message", data);
         });
         // 直播消息源数据
-        room.on("origin", (data) => {
-            this.main.emit("live_origin", data);
+        room.on("origin", (data, { platform, room }) => {
+            this.main.emit("live_origin", data, { platform, room });
         });
         // 连接到直播间
         room.on("connect", () => {
@@ -52,13 +52,13 @@ class RoomController {
         room.on("info", () => {
             this.main.emit("room_info", key, room.info);
         });
-        // 直播信息更改
-        room.on("change", (data) => {
-            this.main.emit("room_change", key, data);
+        // 直播展示信息更改
+        room.on("view", (data) => {
+            this.main.emit("room_view", key, data);
         });
         // 直播状态更改
-        room.on("status", (status, timestamp) => {
-            this.main.emit("room_status", key, status, timestamp);
+        room.on("status", (status, { id, timestamp }) => {
+            this.main.emit("room_status", key, status, { id, timestamp });
         });
         // 统计数据更新
         room.on("stats", (data) => {

package/src/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./message/AttributeInfo";
+export * from "./message/MessageData";
+export * from "./plugin";
+export * from "./room";

package/src/types/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./message/AttributeInfo"), exports);
+__exportStar(require("./message/MessageData"), exports);
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./room"), exports);

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

@@ -1,3 +1,4 @@
+import { ImageSize, UserAdmin } from "../../enum";
 /** 用户信息 */
 export interface UserInfo {
     /** 用户名 */
@@ -8,8 +9,8 @@ export interface UserInfo {
     avatar?: string;
     /** 粉丝勋章 */
     medal?: MedalInfo | null;
-    /** 身份 */
-    identity?: "anchor" | "admin" | null;
+    /** 管理等级 */
+    admin?: UserAdmin | null;
     /** 粉丝vip等级 */
     membership?: boolean | number;
     /** vip等级 */
@@ -36,8 +37,8 @@ export interface ImageInfo {
     id?: string | number;
     /** 图像url */
     url?: string;
-    /** 图像高度 */
-    height?: number;
+    /** 图像尺寸 */
+    size?: ImageSize;
 }
 /** 礼物信息 */
 export interface GiftInfo {

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

@@ -1,4 +1,6 @@
-import { RoomBaseInfo, RoomStatsInfo, RoomStatus } from "../../lib/LiveRoom";
+import { RoomInfo } from './../../lib/LiveRoom';
+import { DanmakuMode, RoomStatus, UserAdmin } from '../../enum';
+import { RoomViewInfo, RoomStatsInfo } from "../../lib/LiveRoom";
 import { UserInfo, GiftInfo, ImageInfo } from "./AttributeInfo";
 declare type MessageBase = {
     /** 平台名称 */
@@ -7,8 +9,8 @@ declare type MessageBase = {
     room: number | string;
     /** 信息类型 */
     type: string;
-    /** 记录时间 */
-    record_time: number;
+    /** 时间戳 */
+    timestamp: number;
     /** 其他属性 */
     [attr: string]: any;
 };
@@ -31,14 +33,12 @@ export declare type MessageChat = MessageBase & {
     info: {
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp: number;
         /** 文本内容 */
         content: string;
         /** 文字颜色 */
         color?: number | string;
         /** 弹幕模式 */
-        mode?: number | string;
+        mode?: DanmakuMode;
         /** 文字大小 */
         size?: number | string;
         /** 图片信息 */
@@ -57,8 +57,6 @@ export declare type MessageGift = MessageBase & {
     info: {
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp: number;
         /** 礼物信息 */
         gift: GiftInfo;
     };
@@ -69,8 +67,6 @@ export declare type MessageInteract = MessageBase & {
     info: {
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp: number;
         /** 信息标签 */
         tag?: string | boolean;
     };
@@ -81,8 +77,6 @@ export declare type MessageMembership = MessageBase & {
     info: {
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp: number;
         /** 礼物信息 */
         gift: GiftInfo;
         /** 开通vip名称 */
@@ -101,8 +95,6 @@ export declare type MessageSuperchat = MessageBase & {
         id?: string;
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp: number;
         /** 文本内容 */
         content: string;
         /** 文字颜色 */
@@ -119,11 +111,9 @@ export declare type MessageBlock = MessageBase & {
     info: {
         /** 用户信息 */
         user: UserInfo;
-        /** 日期时间戳 */
-        timestamp?: number;
         /** 操作者 */
         operator: UserInfo | {
-            identity: null | "admin" | "anchor";
+            admin: null | UserAdmin;
         };
     };
 };
@@ -131,8 +121,8 @@ export declare type MessageBlock = MessageBase & {
 export declare type MessageLiveStart = MessageBase & {
     type: "live_start";
     info: {
-        /** 开播时间 */
-        timestamp: number;
+        /** 直播id */
+        id: string;
     };
 };
 /** 直播切断消息 */
@@ -143,15 +133,21 @@ export declare type MessageLiveCut = MessageBase & {
         message: string;
     };
 };
+/** 获取房间信息 */
+export interface MessageRoomInfo extends MessageBase {
+    type: "room_info";
+    /** 数据信息 */
+    info: RoomInfo;
+}
 /** 直播数据更新 */
 export declare type MessageLiveStats = MessageBase & {
     type: "live_stats";
     info: RoomStatsInfo;
 };
-/** 直播信息更新 */
-export declare type MessageLiveChange = MessageBase & {
-    type: "live_change";
-    info: RoomBaseInfo;
+/** 直播展示信息更新 */
+export declare type MessageLiveView = MessageBase & {
+    type: "live_view";
+    info: RoomViewInfo;
 };
 /** 直播结束 */
 export declare type MessageLiveEnd = MessageBase & {
@@ -161,7 +157,7 @@ export declare type MessageLiveEnd = MessageBase & {
         status: RoomStatus;
     };
 };
-declare type AllMessageType = MessageChat | MessageGift | MessageInteract | MessageMembership | MessageSuperchat | MessageBlock | MessageLiveStart | MessageLiveEnd | MessageLiveCut | MessageLiveChange | MessageLiveStats;
+declare type AllMessageType = MessageChat | MessageGift | MessageInteract | MessageMembership | MessageSuperchat | MessageBlock | MessageLiveStart | MessageLiveEnd | MessageLiveCut | MessageLiveView | MessageLiveStats;
 export declare type MessageData<T extends AllMessageType["type"] = AllMessageType["type"]> = AllMessageType & {
     type: T;
 };

package/src/types/plugin.d.ts

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

package/src/types/{room/PlatformInfo.d.ts → room.d.ts}

@@ -36,3 +36,5 @@ export interface PlatformInfo {
         }>;
     };
 }
+export interface RoomConfig {
+}

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

@@ -1,5 +0,0 @@
-import { FloatingLive } from "../..";
-/** 插件模块, 加载时调用 */
-export declare type FloatingLivePlugin<T extends FloatingLive = FloatingLive> = (ctx: T) => {
-    [key: string]: any;
-} | void;