floating-live 0.10.2 → 0.11.1

package/plugin/msgSave/msgSave.d.ts

@@ -1,22 +1,83 @@
+import { RoomStatus } from '../..';
 import { FloatingLive } from "../..";
-declare class msgSave {
+interface SaveInfoConfig {
+    platform: string;
+    room: string | number;
+    status: RoomStatus;
+    timestamp: number;
+    statusChanged: boolean;
+}
+declare class SaveInfo implements SaveInfoConfig {
+    /** 文件id */
+    get fileId(): string;
+    /** 平台 */
+    platform: string;
+    /** 房间号 */
+    room: string | number;
+    /** 时间戳 */
+    timestamp: number;
+    /** 状态 */
+    status: RoomStatus;
+    /** 文件是否存在 */
+    exist: boolean;
+    /** 记录状态是否已更改 */
+    statusChanged: boolean;
+    /** 按状态分文件 */
+    sliceByStatus: boolean;
+    /** 消息记录数 */
+    count: number;
+    /** 总消息记录数 */
+    totalCount: number;
+    /** 按消息记录数分文件 */
+    sliceByCount: number;
+    /** 分块id */
+    part: number;
+    constructor({ platform, room, status, timestamp, statusChanged, sliceByStatus, sliceByCount }: SaveInfoConfig & {
+        sliceByStatus?: boolean;
+        sliceByCount?: number;
+    });
+    /** 分块 */
+    slice(): void;
+}
+declare class MsgSave {
     /** 主模块 */
     main: FloatingLive;
-    file: string;
-    config: object;
-    type: string;
+    /** 文件路径 */
+    path: string;
+    /** 前缀 */
+    prefix: string;
+    /** 后缀 */
+    suffix: string;
+    /** 按状态分文件 */
+    sliceByStatus: boolean;
+    sliceByCount: number;
     paused: boolean;
-    listener: (msg: any) => void;
-    constructor(main: FloatingLive, type: string, file: string, open?: boolean, config?: {
-        encoding: string;
-        flag: string;
+    /** 列表 */
+    list: Map<string, SaveInfo>;
+    constructor(main: FloatingLive, { filePath, prefix, suffix, open, sliceByStatus, sliceByCount }: {
+        filePath: string;
+        prefix?: string;
+        suffix?: string;
+        open?: boolean;
+        sliceByStatus?: boolean;
+        sliceByCount?: number;
     });
-    write(message: any): void;
+    write(message: any, { platform, room }: {
+        platform: string;
+        room: string | number;
+    }): void;
     start(): void;
     pause(): void;
-    /** 更改路径 */
-    changeFile(file: string): void;
-    /** 销毁实例 */
-    destory(): void;
+    /** 设置保存信息 */
+    setSaveInfo({ platform, room, status, timestamp, statusChanged }: SaveInfoConfig): void;
+    /** 创建保存信息，用于记录信息可能不存在的情况 */
+    createSaveInfo({ platform, room }: {
+        platform: string;
+        room: string | number;
+    }): SaveInfo;
+    /** 创建记录文件 */
+    createFile(roomKey: string): void;
+    /** 移除记录信息 */
+    removeSaveInfo(roomKey: string): void;
 }
-export default msgSave;
+export default MsgSave;

package/plugin/msgSave/msgSave.js

@@ -3,25 +3,88 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const __1 = require("../..");
 const fs_extra_1 = __importDefault(require("fs-extra"));
-class msgSave {
-    constructor(main, type, file, open = true, config = { encoding: "utf8", flag: "a" }) {
+const path_1 = __importDefault(require("path"));
+function getTimeStr(timestamp) {
+    let startDate = new Date(timestamp);
+    return `${startDate.getFullYear()}${(startDate.getMonth() + 1).toString().padStart(2, '0')}${startDate.getDate().toString().padStart(2, '0')}_${startDate.getHours().toString().padStart(2, '0')}${startDate.getMinutes().toString().padStart(2, '0')}${startDate.getSeconds().toString().padStart(2, '0')}`;
+}
+/** 获取当次记录状态
+ * S=直播开始 L=直播中 E=直播结束 O=未开播
+ */
+function getRecordStatus(status, statusChanged) {
+    if (status == __1.RoomStatus.live) {
+        /** 已开播 */
+        return statusChanged ? "S" : "L";
+    }
+    else {
+        /** 未开播 */
+        return statusChanged ? "E" : "O";
+    }
+}
+class SaveInfo {
+    constructor({ platform, room, status, timestamp, statusChanged, sliceByStatus = false, sliceByCount = 0 }) {
+        /** 文件是否存在 */
+        this.exist = false;
+        /** 记录状态是否已更改 */
+        this.statusChanged = false;
+        /** 消息记录数 */
+        this.count = 0;
+        /** 总消息记录数 */
+        this.totalCount = 0;
+        this.platform = platform;
+        this.room = room;
+        this.status = status;
+        this.timestamp = timestamp;
+        this.statusChanged = statusChanged;
+        this.sliceByStatus = sliceByStatus;
+        this.sliceByCount = sliceByCount;
+        this.part = sliceByCount && 1;
+    }
+    /** 文件id */
+    get fileId() {
+        return `${this.platform}_${this.room}-${getTimeStr(this.timestamp || 0)}${this.sliceByStatus ? getRecordStatus(this.status, this.statusChanged) : ""}${this.part ? `.${this.part}` : ""}`;
+    }
+    /** 分块 */
+    slice() {
+        this.exist = false;
+        this.count = 0;
+        this.part += 1;
+    }
+}
+class MsgSave {
+    constructor(main, { filePath, prefix = "", suffix = "", open = true, sliceByStatus = false, sliceByCount = 0 }) {
+        /** 列表 */
+        this.list = new Map();
         this.paused = !open;
         this.main = main;
-        this.file = file;
-        this.config = config;
-        this.type = type;
-        this.listener = (msg) => { if (!this.paused)
-            this.write(msg); };
-        this.main.on(this.type, this.listener);
-    }
-    write(message) {
-        fs_extra_1.default.ensureFileSync(this.file);
-        fs_extra_1.default.writeFile(this.file, JSON.stringify(message) + ",", this.config, (err) => {
+        this.path = filePath;
+        this.prefix = prefix;
+        this.suffix = suffix;
+        this.sliceByStatus = sliceByStatus;
+        this.sliceByCount = sliceByCount;
+    }
+    write(message, { platform, room }) {
+        if (this.paused)
+            return;
+        const roomKey = `${platform}:${room}`;
+        // 获取保存信息，若信息不存在，则设置一个信息
+        const saveInfo = this.list.get(roomKey) || this.createSaveInfo({ platform, room });
+        // 若文件不存在，则创建一个有record_info信息的.floatrec文件
+        if (!saveInfo.exist)
+            this.createFile(roomKey);
+        const file = path_1.default.join(this.path, `${this.prefix}${saveInfo.fileId}${this.suffix}.floatrec`);
+        fs_extra_1.default.writeFile(file, JSON.stringify(message) + ",", { encoding: "utf8", flag: "a" }, (err) => {
             if (err)
                 throw err;
             // console.log('写入成功');
         });
+        // 保存信息递增
+        saveInfo.count += 1;
+        // 若单文件保存信息已达最大值，则切分到下一个文件
+        if (saveInfo.sliceByCount && saveInfo.sliceByCount <= saveInfo.count)
+            saveInfo.slice();
     }
     start() {
         this.paused = false;
@@ -29,13 +92,61 @@ class msgSave {
     pause() {
         this.paused = true;
     }
-    /** 更改路径 */
-    changeFile(file) {
-        this.file = file;
+    /** 设置保存信息 */
+    setSaveInfo({ platform, room, status, timestamp, statusChanged }) {
+        const saveInfo = new SaveInfo({
+            platform,
+            room,
+            status,
+            timestamp,
+            statusChanged,
+            sliceByStatus: this.sliceByStatus,
+            sliceByCount: this.sliceByCount,
+        });
+        const roomKey = `${platform}:${room}`;
+        if (this.list.get(roomKey)?.fileId == saveInfo.fileId)
+            return;
+        this.list.set(roomKey, saveInfo);
+    }
+    /** 创建保存信息，用于记录信息可能不存在的情况 */
+    createSaveInfo({ platform, room }) {
+        const { status, timestamp } = this.main.room.get(`${platform}:${room}`)?.info || { status: __1.RoomStatus.off, timestamp: 0 };
+        const saveInfoConfig = {
+            platform,
+            room, status,
+            timestamp,
+            statusChanged: false,
+            sliceByStatus: this.sliceByStatus,
+            sliceByCount: this.sliceByCount,
+        };
+        this.setSaveInfo(saveInfoConfig);
+        return this.list.get(`${platform}:${room}`);
+    }
+    /** 创建记录文件 */
+    createFile(roomKey) {
+        const saveInfo = this.list.get(roomKey);
+        const file = path_1.default.join(this.path, `${this.prefix}${saveInfo.fileId}${this.suffix}.floatrec`);
+        // 如果文件已存在，则将文件标记为已存在，否则创建一个文件并写入record_info信息
+        if (fs_extra_1.default.existsSync(file)) {
+            saveInfo.exist = true;
+            return;
+        }
+        fs_extra_1.default.ensureFileSync(file);
+        const message = {
+            type: "record_info",
+            platform: saveInfo.platform,
+            room: saveInfo.room,
+            timestamp: saveInfo.timestamp,
+            statusChanged: saveInfo.statusChanged,
+            index: saveInfo.totalCount,
+            part: saveInfo.part,
+            roomInfo: this.main.room.get(roomKey)?.info,
+        };
+        fs_extra_1.default.writeFileSync(file, JSON.stringify(message) + ",", { encoding: "utf8", flag: "a" });
     }
-    /** 销毁实例 */
-    destory() {
-        this.main.removeListener(this.type, this.listener);
+    /** 移除记录信息 */
+    removeSaveInfo(roomKey) {
+        this.list.delete(roomKey);
     }
 }
-exports.default = msgSave;
+exports.default = MsgSave;

package/src/enum.d.ts

@@ -0,0 +1,34 @@
+/** 直播间状态 */
+export declare enum RoomStatus {
+    /** 未开播 */
+    off = 0,
+    /** 正在直播 */
+    live = 1,
+    /** 正在轮播 */
+    round = 2,
+    /** 被封禁 */
+    banned = -1
+}
+/** 图片大小 */
+export declare enum ImageSize {
+    /** 自定义大小 */
+    custom = 0,
+    /** 小表情(文字行高) */
+    small = 1,
+    /** 大表情 */
+    large = 2
+}
+/** 弹幕模式 */
+export declare enum DanmakuMode {
+    left = 1,
+    bottom = 4,
+    top = 5,
+    right = 6
+}
+/** 管理等级 */
+export declare enum UserAdmin {
+    /** 房管 */
+    admin = 1,
+    /** 主播 */
+    anchor = 2
+}

package/src/enum.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserAdmin = exports.DanmakuMode = exports.ImageSize = exports.RoomStatus = void 0;
+/** 直播间状态 */
+var RoomStatus;
+(function (RoomStatus) {
+    /** 未开播 */
+    RoomStatus[RoomStatus["off"] = 0] = "off";
+    /** 正在直播 */
+    RoomStatus[RoomStatus["live"] = 1] = "live";
+    /** 正在轮播 */
+    RoomStatus[RoomStatus["round"] = 2] = "round";
+    /** 被封禁 */
+    RoomStatus[RoomStatus["banned"] = -1] = "banned";
+})(RoomStatus = exports.RoomStatus || (exports.RoomStatus = {}));
+/** 图片大小 */
+var ImageSize;
+(function (ImageSize) {
+    /** 自定义大小 */
+    ImageSize[ImageSize["custom"] = 0] = "custom";
+    /** 小表情(文字行高) */
+    ImageSize[ImageSize["small"] = 1] = "small";
+    /** 大表情 */
+    ImageSize[ImageSize["large"] = 2] = "large";
+})(ImageSize = exports.ImageSize || (exports.ImageSize = {}));
+/** 弹幕模式 */
+var DanmakuMode;
+(function (DanmakuMode) {
+    DanmakuMode[DanmakuMode["left"] = 1] = "left";
+    DanmakuMode[DanmakuMode["bottom"] = 4] = "bottom";
+    DanmakuMode[DanmakuMode["top"] = 5] = "top";
+    DanmakuMode[DanmakuMode["right"] = 6] = "right";
+})(DanmakuMode = exports.DanmakuMode || (exports.DanmakuMode = {}));
+/** 管理等级 */
+var UserAdmin;
+(function (UserAdmin) {
+    /** 房管 */
+    UserAdmin[UserAdmin["admin"] = 1] = "admin";
+    /** 主播 */
+    UserAdmin[UserAdmin["anchor"] = 2] = "anchor";
+})(UserAdmin = exports.UserAdmin || (exports.UserAdmin = {}));

package/src/index.d.ts

@@ -2,7 +2,7 @@
 import { EventEmitter } from "events";
 import { Reglist } from "./lib/Reglist";
 import { LiveRoom } from "./lib/LiveRoom";
-import { MessageData } from "./types/message/MessageData";
+import { MessageData } from "./types";
 import { PluginHandler } from "./module/Plugin";
 import { RoomController } from "./module/Room";
 export declare class FloatingLive extends EventEmitter {
@@ -23,7 +23,7 @@ export declare class FloatingLive extends EventEmitter {
         pluginRemoveHandler: Reglist<(name: string) => void>;
     };
     /** 插件事件注册表 */
-    private pluginEventMap;
+    private regEventMap;
     /** 状态 */
     private status;
     get started(): boolean;
@@ -39,7 +39,7 @@ export declare class FloatingLive extends EventEmitter {
     addRoom({ platform, id }: {
         platform: string;
         id: string | number;
-    }, open?: boolean): void;
+    }, open?: boolean, config?: {}): void;
     /** 移除房间 */
     removeRoom(roomKey: string): void;
     /** 添加房间实例 */

package/src/index.js

@@ -9,7 +9,7 @@ class FloatingLive extends events_1.EventEmitter {
     constructor() {
         super();
         /** 插件事件注册表 */
-        this.pluginEventMap = new Map();
+        this.regEventMap = new Map();
         /** 状态 */
         this.status = {
             started: false,
@@ -34,11 +34,13 @@ class FloatingLive extends events_1.EventEmitter {
     }
     /** 初始化 */
     init() {
+        // 监听到有房间打开，则开始记录
         this.on("room_open", () => {
             this.started || this.start();
         });
+        // 设置在插件卸载时移除由插件注册的事件
         this.helper.pluginRemoveHandler.register("removePluginEvent", (name) => {
-            this.pluginEventMap.get(name)?.forEach(([eventName, listener]) => {
+            this.regEventMap.get(name)?.forEach(([eventName, listener]) => {
                 this.removeListener(eventName, listener);
             });
         });
@@ -46,7 +48,7 @@ class FloatingLive extends events_1.EventEmitter {
     /** 开始 */
     start() {
         this.status.started = true;
-        this.status.timestamp = new Date().valueOf();
+        this.status.timestamp = Date.now();
         this.emit("start", this.timestamp);
     }
     /** 结束 */
@@ -57,7 +59,7 @@ class FloatingLive extends events_1.EventEmitter {
         this.status.timestamp = 0;
     }
     /** 添加房间 */
-    addRoom({ platform, id }, open) {
+    addRoom({ platform, id }, open, config) {
         let generated = this.room.generate({ platform, id }, open);
         if (generated) {
             this.room.add(generated);
@@ -100,10 +102,10 @@ class FloatingLive extends events_1.EventEmitter {
         super.on(eventName, listener);
         // 检测是否为插件添加事件，并添加进事件列表
         if (this.plugin.currentPlugin) {
-            if (!this.pluginEventMap.has(this.plugin.currentPlugin)) {
-                this.pluginEventMap.set(this.plugin.currentPlugin, []);
+            if (!this.regEventMap.has(this.plugin.currentPlugin)) {
+                this.regEventMap.set(this.plugin.currentPlugin, []);
             }
-            this.pluginEventMap.get(this.plugin.currentPlugin)?.push([eventName, listener]);
+            this.regEventMap.get(this.plugin.currentPlugin)?.push([eventName, listener]);
         }
         return this;
     }

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) {