floating-live 0.8.0

package/plugin/chatPrint/chatPrint.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class chatPrint {
+    constructor(main) {
+        this.main = main;
+        let hidden = [];
+        this.hideType = new Set(hidden); // 隐藏类型
+        this.main.on("live_message", (msg) => { this.log(msg); });
+    }
+    /** 获取用户信息 */
+    getUserInfo(message) {
+        let user = message.info.user; // 用户信息
+        let name = `${"\x1b[33m"}${user.name}`; // 用户名
+        let medal = user.medal ? `${"\x1b[32m"}[${user.medal.name}(${user.medal.level})] ` : ""; // 粉丝牌
+        let privilege = user.privilege ? `${"\x1b[36m"}[${this.getPriviliegeName(message.platform, user.privilege)}]` : ""; // 特权粉丝
+        let admin = user.admin ? `${"\x1b[95m"}[${["", "主播", "房"][user.admin]}]` : ""; // 房管
+        return `${medal}${privilege}${admin}${name}${"\x1b[0m"}`; //[粉丝牌(等级)] [特权][房管]用户名
+    }
+    /** 获取特权粉丝名称 */
+    getPriviliegeName(platform, level) {
+        switch (platform) {
+            case "bilibili":
+                return `${"\x1b[36m"}${["", "总督", "提督", "舰长"][Number(level)]}`;
+            default:
+                return level;
+        }
+    }
+    /** 记录在控制台上 */
+    log(message) {
+        if (this.hideType.has(message.type)) {
+            return;
+        }
+        switch (message.type) {
+            case "text": {
+                let user = this.getUserInfo(message);
+                let text = message.info.text;
+                console.log(`${user}: ${text}`);
+                break;
+            }
+            case "image": {
+                let user = this.getUserInfo(message);
+                let image = message.info.image.name || message.info.image.id;
+                console.log(`${user}: [img]${image}`);
+                break;
+            }
+            case "like": {
+                let user = this.getUserInfo(message);
+                console.log(`${user} 点赞了`);
+                break;
+            }
+            case "gift": {
+                let user = this.getUserInfo(message);
+                let action = message.info.gift.action || "送出";
+                let name = message.info.gift.name;
+                let num = message.info.gift.num;
+                console.log(`${user}${"\x1b[0m"} ${action} ${"\x1b[40;33m"}${name} x${num}${"\x1b[0m"}`);
+                break;
+            }
+            case "privilege": {
+                let user = this.getUserInfo(message);
+                let name = message.info.name;
+                let action = message.info.renew ? ["开通", "续费", "自动续费"][message.info.renew] : "开通";
+                console.log(`${user}${"\x1b[1;31m"} ${action}了主播的${"\x1b[33m"}${name}${"\x1b[0m"}`);
+                break;
+            }
+            case "superchat": {
+                let user = this.getUserInfo(message);
+                let second = Math.round(message.info.duration / 1000);
+                console.log(`${"\x1b[1;36m"}SC(${second}s) ${user}${"\x1b[0m"}: ${message.info.text}`);
+                break;
+            }
+            case "entry": {
+                let user = this.getUserInfo(message);
+                console.log(`${user} 进入直播间`);
+                break;
+            }
+            case "follow": {
+                let user = this.getUserInfo(message);
+                console.log(`${user} 关注了主播`);
+                break;
+            }
+            case "share": {
+                let user = this.getUserInfo(message);
+                console.log(`${user} 分享了直播间`);
+                break;
+            }
+            case "block": {
+                let user = this.getUserInfo(message);
+                let operator = message.info.operator.admin ? ["", "主播", "房管"][message.info.operator.admin] : "管理员";
+                console.log(`${user} 已被${operator}禁言`);
+                break;
+            }
+            case "live_start": {
+                let roomKey = `${message.platform}:${message.room}`;
+                console.log(`[+] 直播间${"\x1b[40;33m"} ${roomKey} ${"\x1b[0m"}已开播`);
+                break;
+            }
+            case "live_cut": {
+                let roomKey = `${message.platform}:${message.room}`;
+                let msg = message.info.message;
+                console.log(`[!] ${"\x1b[1;31m"}直播间${"\x1b[40;33m"} ${roomKey} ${"\x1b[1;31m"}被管理员切断${"\x1b[0m"}: ${msg}`);
+                break;
+            }
+            case "live_end": {
+                let roomKey = `${message.platform}:${message.room}`;
+                console.log(`[=] ${"\x1b[1;31m"}直播间${"\x1b[40;33m"} ${roomKey} ${"\x1b[1;31m"}已结束直播${"\x1b[0m"}`);
+            }
+        }
+    }
+}
+exports.default = chatPrint;

package/plugin/chatPrint/index.d.ts

@@ -0,0 +1,4 @@
+import FloatingLive from "../../src";
+import chatPrint from "./chatPrint";
+declare const _default: (ctx: FloatingLive) => chatPrint;
+export = _default;

package/plugin/chatPrint/index.js

@@ -0,0 +1,8 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const chatPrint_1 = __importDefault(require("./chatPrint"));
+module.exports = (ctx) => {
+    return new chatPrint_1.default(ctx);
+};

package/plugin/consoleEvent/index.d.ts

@@ -0,0 +1,3 @@
+import FloatingLive from "../../src";
+declare const _default: (ctx: FloatingLive) => void;
+export = _default;

package/plugin/consoleEvent/index.js

@@ -0,0 +1,39 @@
+"use strict";
+module.exports = (ctx) => {
+    ctx.on("start", () => {
+        console.log(`[controller]记录已开始: ${ctx.controller.timestamp}`);
+    });
+    ctx.on("end", () => {
+        console.log(`[controller]记录已结束: ${ctx.controller.timestamp}`);
+    });
+    ctx.on("room_connect", (key) => {
+        console.log(`[${key}]已连接到直播服务器`);
+    });
+    ctx.on("room_disconnect", (key) => {
+        console.log(`[${key}]与直播服务器的连接已断开`);
+    });
+    ctx.on("room_info", (key) => {
+        console.log(`[${key}]已获取到房间信息`);
+    });
+    ctx.on("room_update", (key) => {
+        console.log(`[${key}]直播间信息更新`);
+    });
+    ctx.on("room_open", (key) => {
+        console.log(`[${key}]房间已打开`);
+    });
+    ctx.on("room_close", (key) => {
+        console.log(`[${key}]房间已关闭`);
+    });
+    ctx.on("room_open", (key) => {
+        console.log(`[room]已添加房间: ${key}`);
+    });
+    ctx.on("room_close", (key) => {
+        console.log(`[room]已移除房间: ${key}`);
+    });
+    ctx.on("room_exist", (key) => {
+        console.log(`[room]房间已存在: ${key}`);
+    });
+    ctx.on("room_unexist", (key) => {
+        console.log(`[room]房间不存在: ${key}`);
+    });
+};

package/plugin/msgSave/index.d.ts

@@ -0,0 +1,4 @@
+import FloatingLive from "../../src";
+import msgSave from "../msgSave/msgSave";
+export declare const messageSave: (ctx: FloatingLive) => msgSave;
+export declare const messageSaveOrigin: (ctx: FloatingLive) => msgSave;

package/plugin/msgSave/index.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.messageSaveOrigin = exports.messageSave = void 0;
+const msgSave_1 = __importDefault(require("../msgSave/msgSave"));
+const messageSave = (ctx) => {
+    let saveMessage = new msgSave_1.default(ctx, "live_message", `./save/undefined.txt`, ctx.controller.started);
+    ctx.on("start", () => {
+        let startDate = new Date(ctx.controller.timestamp);
+        let fileId = `${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')}-${String(ctx.controller.room.keyList[0]).replace(":", "-")}`;
+        saveMessage.changeFile(`./save/${fileId}.txt`);
+        saveMessage.start();
+    });
+    ctx.on("end", () => { saveMessage.pause(); });
+    return saveMessage;
+};
+exports.messageSave = messageSave;
+const messageSaveOrigin = (ctx) => {
+    let saveOrigin = new msgSave_1.default(ctx, "live_origin", `./save/undefined-origin.txt`, ctx.controller.started);
+    ctx.on("start", () => {
+        let startDate = new Date(ctx.controller.timestamp);
+        let fileId = `${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')}-${String(ctx.controller.room.keyList[0]).replace(":", "-")}`;
+        saveOrigin.changeFile(`./save/${fileId}-origin.txt`);
+        saveOrigin.start();
+    });
+    ctx.on("end", () => { saveOrigin.pause(); });
+    return saveOrigin;
+};
+exports.messageSaveOrigin = messageSaveOrigin;

package/plugin/msgSave/msgSave.d.ts

@@ -0,0 +1,22 @@
+import FloatingLiving from "../..";
+declare class msgSave {
+    /** 主模块 */
+    main: FloatingLiving;
+    file: string;
+    config: object;
+    type: string;
+    paused: boolean;
+    listener: (msg: any) => void;
+    constructor(main: FloatingLiving, type: string, file: string, open?: boolean, config?: {
+        encoding: string;
+        flag: string;
+    });
+    write(message: any): void;
+    start(): void;
+    pause(): void;
+    /** 更改路径 */
+    changeFile(file: string): void;
+    /** 销毁实例 */
+    destory(): void;
+}
+export default msgSave;

package/plugin/msgSave/msgSave.js

@@ -0,0 +1,40 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs_1 = __importDefault(require("fs"));
+class msgSave {
+    constructor(main, type, file, open = true, config = { encoding: "utf8", flag: "a" }) {
+        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_1.default.writeFile(this.file, JSON.stringify(message) + ",", this.config, (err) => {
+            if (err)
+                throw err;
+            // console.log('写入成功');
+        });
+    }
+    start() {
+        this.paused = false;
+    }
+    pause() {
+        this.paused = true;
+    }
+    /** 更改路径 */
+    changeFile(file) {
+        this.file = file;
+    }
+    /** 销毁实例 */
+    destory() {
+        this.main.removeListener(this.type, this.listener);
+    }
+}
+exports.default = msgSave;

package/src/controller/Message.d.ts

@@ -0,0 +1,9 @@
+import Controller from ".";
+import FloatingLive from "..";
+import { MessageType } from "../types/message/MessageData";
+export default class Message {
+    readonly controller: Controller;
+    readonly main: FloatingLive;
+    constructor(controller: Controller);
+    send(msg: MessageType): void;
+}

package/src/controller/Message.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Message {
+    constructor(controller) {
+        this.controller = controller;
+        this.main = controller.main;
+    }
+    send(msg) {
+        this.main.helper.messageHandler.getList().forEach((handler) => {
+            handler(msg);
+        });
+        this.main.emit("live_message", msg);
+    }
+}
+exports.default = Message;

package/src/controller/Room.d.ts

@@ -0,0 +1,32 @@
+import LiveRoom from "../types/room/LiveRoom";
+import FloatingLive from "..";
+import Controller from ".";
+/** 直播间监听实例控制器 */
+declare class Room {
+    readonly controller: Controller;
+    readonly main: FloatingLive;
+    private roomMap;
+    constructor(controller: Controller);
+    generate(r: {
+        platform: string;
+        id: string | number;
+    }, open?: boolean): {
+        key: string;
+        room: LiveRoom;
+    } | undefined;
+    /** 添加房间监听对象 */
+    add(key: string, room: LiveRoom, open?: boolean): void;
+    /** 移除房间 */
+    remove(roomKey: string): void;
+    /** 获取房间 */
+    get(roomKey: string): LiveRoom | undefined;
+    /** 获取房间信息 */
+    getInfo(roomKey: string): import("../types/room/RoomInfo").default | undefined;
+    /** 更新房间信息 */
+    update(roomKey: string): void;
+    /** 获取roomKey列表 */
+    get keyList(): Array<string>;
+    open(roomKey: string): void;
+    close(roomKey: string): void;
+}
+export default Room;

package/src/controller/Room.js

@@ -0,0 +1,110 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getRoomInfo_1 = __importDefault(require("../utils/getRoomInfo"));
+/** 直播间监听实例控制器 */
+class Room {
+    constructor(controller) {
+        this.roomMap = new Map();
+        this.controller = controller;
+        this.main = controller.main;
+    }
+    generate(r, open) {
+        let platform;
+        let id;
+        platform = r.platform.toLowerCase();
+        id = r.id;
+        let platformGenerator = this.main.helper.roomGenerator.get(platform);
+        if (platformGenerator) {
+            return platformGenerator(id, open);
+        }
+        else {
+            this.main.emit("room_unknown_platform", platform);
+        }
+    }
+    /** 添加房间监听对象 */
+    add(key, room, open) {
+        if (this.roomMap.has(key)) {
+            this.main.emit("room_exist", key);
+            return;
+        }
+        this.roomMap.set(key, room);
+        // 添加监听事件
+        // 直播消息
+        room.on("msg", (data) => {
+            this.controller.message.send(data);
+        });
+        // 直播消息源数据
+        room.on("origin", (data) => {
+            this.main.emit("live_origin", data);
+        });
+        // 连接到直播间
+        room.on("connect", () => {
+            this.main.emit("room_connect", key);
+        });
+        // 与直播间的连接已断开
+        room.on("disconnect", () => {
+            this.main.emit("room_disconnect", key);
+        });
+        // 获取房间信息
+        room.on("info", () => {
+            this.main.emit("room_info", key, (0, getRoomInfo_1.default)(room));
+        });
+        // 更新直播间信息
+        room.on("update", (data) => {
+            this.main.emit("room_update", key, data);
+        });
+        // 房间被打开
+        room.on("open", () => {
+            this.main.emit("room_open", key, (0, getRoomInfo_1.default)(room));
+        });
+        // 房间被关闭
+        room.on("close", () => {
+            this.main.emit("room_close", key, (0, getRoomInfo_1.default)(room));
+        });
+        if (open) {
+            room.open();
+        }
+        this.main.emit("room_add", { key: key, room: (0, getRoomInfo_1.default)(room) });
+    }
+    /** 移除房间 */
+    remove(roomKey) {
+        if (!this.roomMap.has(roomKey)) {
+            this.main.emit("room", { key: "room_unexist", value: { key: roomKey } });
+            return;
+        }
+        let room = this.roomMap.get(roomKey);
+        this.roomMap.delete(roomKey); // 从表中删除房间
+        room?.removeAllListeners(); // 移除房间监听实例
+        this.main.emit("room", { key: "room_remove", value: { key: roomKey } });
+    }
+    /** 获取房间 */
+    get(roomKey) {
+        return this.roomMap.get(roomKey);
+    }
+    /** 获取房间信息 */
+    getInfo(roomKey) {
+        let room = this.roomMap.get(roomKey);
+        return room ? (0, getRoomInfo_1.default)(room) : undefined;
+    }
+    /** 更新房间信息 */
+    update(roomKey) {
+        let room = this.roomMap.get(roomKey);
+        room && room.getInfo();
+    }
+    /** 获取roomKey列表 */
+    get keyList() {
+        return [...this.roomMap.keys()];
+    }
+    open(roomKey) {
+        let room = this.roomMap.get(roomKey);
+        room?.available && !room.opening && room.open();
+    }
+    close(roomKey) {
+        let room = this.roomMap.get(roomKey);
+        room?.opening && room.close();
+    }
+}
+exports.default = Room;

package/src/controller/index.d.ts

@@ -0,0 +1,39 @@
+import FloatingLive from "..";
+import LiveRoom from "../types/room/LiveRoom";
+import Message from "./Message";
+import Room from "./Room";
+export default class Controller {
+    readonly main: FloatingLive;
+    /** room 控制模块 */
+    readonly room: Room;
+    /** message 控制模块 */
+    readonly message: Message;
+    /** 开始时间戳 */
+    timestamp: number;
+    /** 开始状态 */
+    started: boolean;
+    constructor(main: FloatingLive);
+    /** 开始 */
+    start(): void;
+    /** 结束 */
+    end(): void;
+    /** 添加房间 */
+    addRoom({ platform, id }: {
+        platform: string;
+        id: number;
+    }, open?: boolean): void;
+    /** 移除房间 */
+    removeRoom(roomKey: string): void;
+    /** 添加房间实例 */
+    addLiveRoom(key: string, room: LiveRoom): void;
+    /** 打开房间 */
+    openRoom(roomKey: string): void;
+    /** 关闭房间 */
+    closeRoom(roomKey: string): void;
+    /** 打开所有房间 */
+    openAllRooms(): void;
+    /** 关闭所有房间 */
+    closeAllRooms(): void;
+    /** 更新房间信息 */
+    updateRoomInfo(roomKey: string): void;
+}

package/src/controller/index.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Message_1 = __importDefault(require("./Message"));
+const Room_1 = __importDefault(require("./Room"));
+class Controller {
+    constructor(main) {
+        /** 开始时间戳 */
+        this.timestamp = 0;
+        /** 开始状态 */
+        this.started = false;
+        this.main = main;
+        this.room = new Room_1.default(this);
+        this.message = new Message_1.default(this);
+        this.main.on("room_open", () => {
+            this.start();
+        });
+    }
+    /** 开始 */
+    start() {
+        this.started = true;
+        this.timestamp = new Date().valueOf();
+        this.main.emit("start");
+    }
+    /** 结束 */
+    end() {
+        this.closeAllRooms();
+        this.started = false;
+        this.main.emit("end");
+        this.timestamp = 0;
+    }
+    /** 添加房间 */
+    addRoom({ platform, id }, open) {
+        let generated = this.room.generate({ platform, id }, open);
+        if (generated) {
+            this.room.add(generated.key, generated.room);
+        }
+    }
+    /** 移除房间 */
+    removeRoom(roomKey) {
+        this.room.remove(roomKey);
+    }
+    /** 添加房间实例 */
+    addLiveRoom(key, room) {
+        this.room.add(key, room);
+    }
+    /** 打开房间 */
+    openRoom(roomKey) {
+        this.room.open(roomKey);
+    }
+    /** 关闭房间 */
+    closeRoom(roomKey) {
+        this.room.open(roomKey);
+    }
+    /** 打开所有房间 */
+    openAllRooms() {
+        this.room.keyList.forEach((key) => {
+            this.room.open(key);
+        });
+    }
+    /** 关闭所有房间 */
+    closeAllRooms() {
+        this.room.keyList.forEach((key) => {
+            this.room.close(key);
+        });
+    }
+    /** 更新房间信息 */
+    updateRoomInfo(roomKey) {
+        this.room.update(roomKey);
+    }
+}
+exports.default = Controller;

package/src/index.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { Registerable } from "./lib/Registerable";
+import LiveRoom from "./types/room/LiveRoom";
+import { MessageType } from "./types/message/MessageData";
+import Controller from "./controller";
+declare class FloatingLive extends EventEmitter {
+    /** 控制器 */
+    controller: Controller;
+    /** 拓展插件 */
+    plugin: Map<string, {
+        [key: string]: any;
+    }>;
+    helper: {
+        /** 房间生成器 */
+        roomGenerator: Registerable<(id: string | number, open?: boolean) => {
+            key: string;
+            room: LiveRoom;
+        }>;
+        /** 消息处理 */
+        messageHandler: Registerable<(msg: MessageType) => void>;
+    };
+    constructor();
+    /** 添加插件 */
+    registerPlugin(name: string, pluginFunc: (main: FloatingLive) => any): any;
+    /** 根据名称获取插件操作对象 */
+    getPlugin(name: string): {
+        [key: string]: any;
+    } | undefined;
+    /** 移除插件 */
+    removePlugin(name: string): void;
+}
+export default FloatingLive;

package/src/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const events_1 = require("events");
+const Registerable_1 = require("./lib/Registerable");
+const controller_1 = __importDefault(require("./controller"));
+class FloatingLive extends events_1.EventEmitter {
+    constructor() {
+        super();
+        /** 拓展插件 */
+        this.plugin = new Map();
+        this.helper = {
+            /** 房间生成器 */
+            roomGenerator: new Registerable_1.Registerable("roomGenerator"),
+            /** 消息处理 */
+            messageHandler: new Registerable_1.Registerable("messageHandler"),
+        };
+        this.controller = new controller_1.default(this);
+    }
+    /** 添加插件 */
+    registerPlugin(name, pluginFunc) {
+        Registerable_1.Registerable.currentPlugin = name;
+        let pluginObject = pluginFunc(this); // 获取插件操作对象
+        this.plugin.set(name, pluginObject);
+        this.emit("addPlugin", name);
+        console.log(`已添加插件: ${name}`);
+        Registerable_1.Registerable.currentPlugin = null;
+        return pluginObject;
+    }
+    /** 根据名称获取插件操作对象 */
+    getPlugin(name) {
+        return this.plugin.get(name);
+    }
+    /** 移除插件 */
+    removePlugin(name) {
+        if (!this.plugin.has(name)) {
+            this.emit("pluginUnexist", name);
+            return;
+        }
+        let pluginObject = this.plugin.get(name);
+        this.plugin.delete(name);
+        this.helper.roomGenerator.unregister(name);
+        this.helper.messageHandler.unregister(name);
+        pluginObject?.destory && pluginObject.destory();
+        this.emit("removePlugin", name);
+    }
+}
+exports.default = FloatingLive;

package/src/lib/Registerable.d.ts

@@ -0,0 +1,27 @@
+/** 插件可注册对象模块 */
+export declare class Registerable<T> {
+    /** 当前安装插件 */
+    static currentPlugin: string | null;
+    /** 功能列表 */
+    private readonly list;
+    /** 插件与功能名称绑定表 */
+    private readonly pluginIdMap;
+    private readonly name;
+    constructor(name: string);
+    /** 注册一个对象 */
+    register(id: string, item: T): void;
+    /** 取消某一插件在该模块中的注册 */
+    unregister(pluginName: string): void;
+    /** 获取名称 */
+    getName(): string;
+    /** 根据id获取注册对象 */
+    get(id: string): T | undefined;
+    /** 获取注册对象列表 */
+    getList(): T[];
+    /** 获取注册id列表 */
+    getIdList(): string[];
+}
+/** 设置当前安装插件名称 */
+export declare const setCurrentPluginName: (name?: string | null) => void;
+/** 获取当前安装插件名称 */
+export declare const getCurrentPluginName: () => string | null;