floating-live 0.15.5 → 0.15.6

package/esm/core/LiveRoom.js

@@ -0,0 +1,77 @@
+import { EventEmitter } from "events";
+import { ConnectStatus, RoomStatus } from "../enums";
+export class LiveRoom extends EventEmitter {
+    constructor() {
+        super();
+        /** 直播状态 */
+        this.status = RoomStatus.off;
+        /** 时间戳 */
+        this.timestamp = 0;
+        /** 房间是否打开 */
+        this.opened = false;
+        /** 是否连接上房间 */
+        this.connection = ConnectStatus.off;
+    }
+    /** 销毁 */
+    destroy() {
+        this.close();
+        this.removeAllListeners();
+        this.onDestroy?.();
+    }
+    // 发送消息
+    emitMessage(msg) {
+        // 其他消息 => 先更改状态再发送消息
+        // 直播结束消息 => 先发送消息再更改状态
+        switch (msg.type) {
+            case "live_start":
+                this.status = RoomStatus.live;
+                this.timestamp = msg.timestamp;
+                this.emit("status", RoomStatus.live, {
+                    timestamp: msg.timestamp,
+                    id: msg.info.id,
+                });
+                break;
+            case "live_detail":
+                this.detail = Object.assign(this.detail, msg.info);
+                this.emit("detail", msg.info);
+                break;
+            case "live_stats":
+                this.stats = Object.assign(this.stats, msg.info);
+                this.emit("stats", msg.info);
+                break;
+            case "live_end":
+            case "live_cut":
+                this.status = msg.status || RoomStatus.off;
+                this.timestamp = msg.timestamp;
+                this.emit("message", msg);
+                this.emit("status", msg.status || RoomStatus.off, {
+                    timestamp: msg.timestamp,
+                });
+                return;
+        }
+        this.emit("message", msg);
+    }
+    // 发送源消息
+    emitRaw(msg) {
+        this.emit("raw", msg, { platform: this.platform, room: this.id });
+    }
+    get info() {
+        return {
+            platform: this.platform,
+            id: this.id,
+            detail: this.detail,
+            stats: this.stats,
+            anchor: this.anchor,
+            timestamp: this.timestamp,
+            status: this.status,
+            liveId: this.liveId,
+            available: this.available,
+            opened: this.opened,
+            connection: this.connection,
+            key: this.key,
+        };
+    }
+    get key() {
+        return `${this.platform}:${this.id}`;
+    }
+}

package/esm/core/index.js

@@ -0,0 +1 @@
+export * from "./LiveRoom";

package/esm/core/plugin.js

@@ -0,0 +1,24 @@
+export class BasePlugin {
+    constructor(main) {
+        this.registerList = [];
+        this.main = main;
+    }
+    /** 插件监听事件 */
+    on(eventName, listener) {
+        this.main.on(eventName, listener);
+        this.registerList.push(["event", eventName, listener]);
+    }
+    /** 插件一次性监听事件 */
+    once(eventName, listener) {
+        this.main.once(eventName, listener);
+        this.registerList.push(["event", eventName, listener]);
+    }
+    /** 插件移除监听事件 */
+    off(eventName, listener) {
+        this.main.off(eventName, listener);
+    }
+    /** 插件发送事件 */
+    emit(eventName, ...args) {
+        this.main.emit(eventName, ...args);
+    }
+}

package/esm/enums.js

@@ -0,0 +1,56 @@
+/** 直播间状态 */
+export 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[RoomStatus["locked"] = -2] = "locked";
+})(RoomStatus || (RoomStatus = {}));
+/** 直播间状态 */
+export var ConnectStatus;
+(function (ConnectStatus) {
+    /** 未连接 */
+    ConnectStatus[ConnectStatus["off"] = 0] = "off";
+    /** 连接中 */
+    ConnectStatus[ConnectStatus["connecting"] = 1] = "connecting";
+    /** 连接到服务器 */
+    ConnectStatus[ConnectStatus["connected"] = 2] = "connected";
+    /** 连接到房间 */
+    ConnectStatus[ConnectStatus["entered"] = 3] = "entered";
+    /** 连接失败或断开 */
+    ConnectStatus[ConnectStatus["disconnected"] = -1] = "disconnected";
+})(ConnectStatus || (ConnectStatus = {}));
+/** 图片大小 */
+export var ImageSize;
+(function (ImageSize) {
+    /** 自定义大小 */
+    ImageSize[ImageSize["custom"] = 0] = "custom";
+    /** 小表情(文字行高) */
+    ImageSize[ImageSize["small"] = 1] = "small";
+    /** 大表情 */
+    ImageSize[ImageSize["large"] = 2] = "large";
+})(ImageSize || (ImageSize = {}));
+/** 弹幕模式 */
+export 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 || (DanmakuMode = {}));
+/** 用户类型 */
+export var UserType;
+(function (UserType) {
+    /** 普通观众 */
+    UserType[UserType["normal"] = 0] = "normal";
+    /** 房管 */
+    UserType[UserType["admin"] = 1] = "admin";
+    /** 主播 */
+    UserType[UserType["anchor"] = 2] = "anchor";
+})(UserType || (UserType = {}));

package/esm/index.js

@@ -0,0 +1,5 @@
+export { FloatingLive } from "./live";
+export * from "./types";
+export * from "./enums";
+export * from "./core/LiveRoom";
+export * from "./utils";

package/esm/live.js

@@ -0,0 +1,46 @@
+import { EventEmitter } from "events";
+import { ModPlugin } from "./module/plugin";
+import { ModRoom } from "./module/room";
+import { ModManifest } from "./module/manifest";
+import { ModCommand } from "./module/command";
+import { ModValue } from "./module/value";
+import { ModHook } from "./module/hook";
+export class FloatingLive extends EventEmitter {
+    constructor() {
+        super();
+        this.command = new ModCommand(this);
+        this.manifest = new ModManifest(this);
+        this.plugin = new ModPlugin(this);
+        this.room = new ModRoom(this);
+        this.value = new ModValue(this);
+        this.hook = new ModHook(this);
+    }
+    call(name, ...args) {
+        return this.command.call(name, ...args);
+    }
+    on(eventName, listener) {
+        return super.on(eventName, listener);
+    }
+    emit(eventName, ...args) {
+        const emit = super.emit(eventName, ...args);
+        super.emit("event", eventName, ...args);
+        return emit;
+    }
+    throw(err, options) {
+        if (err instanceof Error) {
+            throw Object.assign(err, options);
+        }
+        else {
+            throw Object.assign(new Error(), err);
+        }
+    }
+    getSnapshot() {
+        return {
+            room: this.room.getSnapshot(),
+            value: this.value.getSnapshot(),
+            manifest: this.manifest.getSnapshot(),
+            command: this.command.getSnapshot(),
+            hook: this.value.getSnapshot(),
+        };
+    }
+}

package/esm/module/command.js

@@ -0,0 +1,38 @@
+export class ModCommand {
+    constructor(main) {
+        /** 功能列表 */
+        this.list = new Map();
+        this.main = main;
+    }
+    /** 注册命令 */
+    register(name, func) {
+        this.list.set(name, func);
+        this.main.emit("command:add", name);
+    }
+    /** 取消注册命令 */
+    unregister(name) {
+        this.list.delete(name);
+        this.main.emit("command:remove", name);
+    }
+    /** 调用命令 */
+    call(name, ...args) {
+        const command = this.list.get(name);
+        if (!command) {
+            this.main.throw({
+                message: "命令不存在",
+                id: "command:call_unexist",
+            });
+        }
+        else {
+            return command(...args);
+        }
+    }
+    /** 检测命令是否存在 */
+    has(name) {
+        return this.list.has(name);
+    }
+    /** 获取快照 */
+    getSnapshot() {
+        return [...this.list].map(([key]) => key);
+    }
+}

package/esm/module/hook.js

@@ -0,0 +1,40 @@
+export class ModHook {
+    constructor(main) {
+        this.list = new Map();
+        this.main = main;
+    }
+    /** 注册钩子函数 */
+    register(name, func) {
+        let hooks = this.list.get(name);
+        if (!hooks) {
+            hooks = [];
+            this.list.set(name, hooks);
+        }
+        hooks.push(func);
+    }
+    /** 取消注册钩子函数 */
+    unregister(name, func) {
+        let hooks = this.list.get(name);
+        if (hooks) {
+            const index = hooks.indexOf(func);
+            index > -1 && hooks.splice(index, 1);
+        }
+    }
+    /** 调用钩子函数 */
+    async call(name, ctx) {
+        const hooks = this.list.get(name);
+        if (!hooks) {
+            return true;
+        }
+        for (const func of hooks) {
+            const result = await func(ctx);
+            if (result == true) {
+                return true;
+            }
+            else if (result == false) {
+                return false;
+            }
+        }
+        return true;
+    }
+}

package/esm/module/manifest.js

@@ -0,0 +1,40 @@
+export class ModManifest {
+    constructor(main) {
+        this.list = new Map();
+        this.main = main;
+    }
+    /** 注册manifest */
+    register(name, id, value) {
+        let store = this.list.get(name);
+        if (!store) {
+            store = new Map();
+            this.list.set(name, store);
+        }
+        store.set(id, value);
+        this.main.emit("manifest:add", name, id, value);
+    }
+    /** 取消注册manifest */
+    unregister(name, id) {
+        let store = this.list.get(name);
+        if (store) {
+            store.delete(id);
+            this.main.emit("manifest:remove", name, id);
+        }
+    }
+    /** 获取值 */
+    get(name) {
+        return this.list.get(name);
+    }
+    /** 获取快照 */
+    getSnapshot() {
+        const map = {};
+        this.list.forEach((store, name) => {
+            const part = {};
+            map[name] = part;
+            store.forEach((value, id) => {
+                part[id] = value;
+            });
+        });
+        return map;
+    }
+}

package/esm/module/plugin.js

@@ -0,0 +1,59 @@
+export class ModPlugin {
+    constructor(main) {
+        /** 插件列表 */
+        this.list = new Map();
+        this.main = main;
+    }
+    /** 注册插件 */
+    async register(pluginFunc, options = {}) {
+        const name = pluginFunc.pluginName;
+        if (!name) {
+            this.main.throw({
+                message: "缺少插件id",
+                id: "plugin:register_id_missing",
+            });
+        }
+        if (this.list.has(name)) {
+            this.main.throw({
+                message: "已存在相同id的插件",
+                id: "plugin:register_id_duplicate",
+            });
+        }
+        return await this.main.hook
+            .call("plugin.register", { name, options })
+            .then(async (res) => {
+            if (!res)
+                return;
+            // 执行插件函数
+            const plugin = new pluginFunc(this.main, options);
+            this.list.set(name, plugin);
+            // 调用插件的register钩子
+            await plugin.register?.(this.main, options);
+            this.main.emit("plugin:add", name);
+            return plugin;
+        });
+    }
+    /** 移除插件 */
+    async unregister(name) {
+        const plugin = this.list.get(name);
+        // 检测插件是否存在
+        if (!plugin) {
+            this.main.throw({
+                message: "插件不存在",
+                id: "plugin:unregister_unexist",
+            });
+        }
+        else {
+            // 调用该插件的destroy钩子
+            await plugin.destroy?.();
+            // 从列表中移除插件
+            this.list.delete(name);
+            // 移除插件注册
+            this.main.emit("plugin:remove", name);
+        }
+    }
+    /** 获取插件实例 */
+    get(name) {
+        return this.list.get(name);
+    }
+}

package/esm/module/room.js

@@ -0,0 +1,151 @@
+/** 直播间监听实例控制器 */
+export class ModRoom {
+    constructor(main) {
+        this.list = new Map();
+        this.main = main;
+        const { command } = main;
+        command.register("add", this.add.bind(this));
+        command.register("remove", this.remove.bind(this));
+        command.register("open", this.open.bind(this));
+        command.register("close", this.close.bind(this));
+        command.register("update", this.update.bind(this));
+    }
+    /** 添加房间监听实例 */
+    addRoom(room, open) {
+        let key = room.key;
+        if (this.list.has(key)) {
+            this.main.throw({
+                message: "房间已存在",
+                id: "room:add_exist",
+            });
+            return;
+        }
+        this.list.set(key, room);
+        // 添加监听事件
+        // 直播消息
+        room.on("message", (data) => {
+            this.main.hook.call("message", { message: data }).then((res) => {
+                res && this.main.emit("live:message", data);
+            });
+        });
+        // 直播消息源数据
+        room.on("raw", (data, { platform, room }) => {
+            this.main.emit("live:raw", data, { platform, room });
+        });
+        // 正在连接服务器
+        room.on("connecting", () => {
+            this.main.emit("room:connecting", key);
+        });
+        // 连接到服务器
+        room.on("connected", () => {
+            this.main.emit("room:connected", key);
+        });
+        // 与服务器的连接已断开
+        room.on("disconnect", () => {
+            this.main.emit("room:disconnect", key);
+        });
+        // 连接到直播间
+        room.on("enter", () => {
+            this.main.emit("room:enter", key);
+        });
+        // 获取房间信息
+        room.on("info", () => {
+            this.main.emit("room:info", key, room.info);
+        });
+        // 直播展示信息更改
+        room.on("detail", (data) => {
+            this.main.emit("room:detail", key, data);
+        });
+        // 直播状态更改
+        room.on("status", (status, { id, timestamp }) => {
+            this.main.emit("room:status", key, { status, id, timestamp });
+        });
+        // 统计数据更新
+        room.on("stats", (data) => {
+            this.main.emit("room:stats", key, data);
+        });
+        // 房间被打开
+        room.on("open", () => {
+            this.main.emit("room:open", key, room.info);
+        });
+        // 房间被关闭
+        room.on("close", () => {
+            this.main.emit("room:close", key, room.info);
+        });
+        if (open) {
+            room.open();
+        }
+        this.main.emit("room:add", key, room.info);
+    }
+    /** 添加房间 */
+    async add(platform, id, options) {
+        const opt = typeof options == "boolean" ? { open: options } : options || {};
+        const ctx = { platform, id, options: opt };
+        const res = await this.main.hook.call("room.add", ctx);
+        if (!res) {
+            this.main.throw({ message: "无法添加房间", id: "room:add_fail" });
+        }
+        const room = await this.main.call(`${platform}.room.create`, id, opt);
+        if (!room) {
+            this.main.throw({ message: "无法创建房间", id: "room:create_fail" });
+        }
+        else {
+            this.addRoom(room);
+        }
+    }
+    /** 移除房间 */
+    remove(roomKey) {
+        let room = this.list.get(roomKey);
+        if (!room) {
+            this.main.throw({
+                message: "房间不存在",
+                id: "room:remove_unexist",
+            });
+        }
+        this.list.delete(roomKey); // 从表中删除房间
+        room?.removeAllListeners(); // 移除房间监听实例
+        this.main.emit("room:remove", roomKey);
+    }
+    /** 获取房间 */
+    get(roomKey) {
+        return this.list.get(roomKey);
+    }
+    /** 获取房间信息 */
+    info(roomKey) {
+        let room = this.list.get(roomKey);
+        return room ? room.info : undefined;
+    }
+    /** 更新房间信息 */
+    update(roomKey) {
+        let room = this.list.get(roomKey);
+        room && room.getInfo();
+    }
+    /** 获取roomKey列表 */
+    get keys() {
+        return [...this.list.keys()];
+    }
+    /** 打开房间连接 */
+    open(roomKey) {
+        let room = this.list.get(roomKey);
+        room?.available && !room.opened && room.open();
+    }
+    /** 关闭房间连接 */
+    close(roomKey) {
+        let room = this.list.get(roomKey);
+        room?.opened && room.close();
+    }
+    /** 更改某个房间的顺序 */
+    move(roomKey, position) {
+        const arr = [...this.list];
+        const index = arr.findIndex(([key]) => key == roomKey);
+        if (index == -1)
+            return;
+        const [item] = arr.splice(index, 1);
+        arr.splice(position, 0, item);
+        this.list = new Map(arr);
+    }
+    /** 获取快照 */
+    getSnapshot() {
+        return [...this.list].map(([key, room]) => room.info);
+    }
+}

package/esm/module/value.js

@@ -0,0 +1,49 @@
+export class ModValue {
+    constructor(main) {
+        this.list = new Map();
+        this.main = main;
+    }
+    /** 注册值 */
+    register(name, config) {
+        this.list.set(name, config);
+        this.main.emit("value:add", name);
+    }
+    /** 取消注册 */
+    unregister(name) {
+        this.list.delete(name);
+        this.main.emit("value:remove", name);
+    }
+    /** 获取值 */
+    get(name) {
+        return this.list.get(name)?.get();
+    }
+    /** 设置值 */
+    set(name, value) {
+        const valueConfig = this.list.get(name);
+        if (valueConfig?.set) {
+            valueConfig?.set(value);
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /** 获取注册的所有值 */
+    getSnapshot() {
+        const map = {};
+        this.list.forEach((config, name) => {
+            map[name] = config.get();
+        });
+        return map;
+    }
+    emit(name, value) {
+        this.main.emit(`change:${name}`, value);
+        this.main.emit("value:change", name, value);
+    }
+    watch(name, listener) {
+        this.main.on(`change:${name}`, listener);
+    }
+    unwatch(name, listener) {
+        this.main.off(`change:${name}`, listener);
+    }
+}

package/esm/types/command.js

@@ -0,0 +1 @@
+export {};

package/esm/types/error.js

@@ -0,0 +1 @@
+export {};

package/esm/types/events.js

@@ -0,0 +1 @@
+export {};

package/esm/types/hook.js

@@ -0,0 +1 @@
+export {};

package/esm/types/index.js

@@ -0,0 +1,9 @@
+export * from "./message";
+export * from "./plugin";
+export * from "./room";
+export * from "./command";
+export * from "./events";
+export * from "./manifest";
+export * from "./hook";
+export * from "./value";
+export * from "./error";

package/esm/types/manifest.js

@@ -0,0 +1 @@
+export {};

package/esm/types/message.js

@@ -0,0 +1 @@
+export {};

package/esm/types/plugin.js

@@ -0,0 +1 @@
+export {};

package/esm/types/room.js

@@ -0,0 +1 @@
+export {};

package/esm/types/value.js

@@ -0,0 +1 @@
+export {};

package/esm/utils.js

@@ -0,0 +1,17 @@
+export function generateId(msg) {
+    switch (msg.type) {
+        case "gift":
+            return `gift:${msg.info.user.id}-${msg.timestamp}`;
+        case "superchat":
+            return `superchat:${msg.info.id}`;
+        case "membership":
+            return `membership:${msg.info.user.id}-${msg.info.level || 0}-${msg.timestamp}`;
+        default:
+            if (/^live_/.test(msg.type)) {
+                return `${msg.type}:${msg.platform}:${msg.room}-${msg.timestamp}`;
+            }
+            else {
+                return `${msg.type}:${msg.info.user?.id || 0}-${msg.timestamp}`;
+            }
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floating-live",
-  "version": "0.15.5",
+  "version": "0.15.6",
   "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,31 +9,36 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "require": "./dist/index.js"
+      "require": "./dist/index.js",
+      "import": "./esm/index.js"
     },
     "./core": {
       "types": "./dist/core/index.d.ts",
-      "require": "./dist/core/index.js"
+      "require": "./dist/core/index.js",
+      "import": "./esm/core/index.js"
     },
     "./types": {
       "types": "./dist/types/index.d.ts",
-      "require": "./dist/types/index.js"
+      "require": "./dist/types/index.js",
+      "import": "./esm/types/index.js"
     },
     "./enums": {
       "types": "./dist/enums.d.ts",
-      "require": "./dist/enums.js"
+      "require": "./dist/enums.js",
+      "import": "./esm/enums.js"
     },
     "./utils": {
       "types": "./dist/utils.d.ts",
-      "require": "./dist/utils.js"
+      "require": "./dist/utils.js",
+      "import": "./esm/utils.js"
     }
   },
   "scripts": {
     "tsc": "tsc -b",
-    "clear": "rimraf dist",
+    "clear": "rimraf dist esm",
     "test": "npm run clear && ts-node demo/demo.ts",
     "build-test": "npm run build && node demo/demo.js",
-    "build": "npm run clear && npm run tsc",
+    "build": "npm run clear && tsc -b && tsc --project tsconfig.esm.json",
     "prepack": "npm run build",
     "postpack": "npm run clear"
   },