floating-live 0.15.10 → 0.16.0-alpha.0

package/dist/value/manager.js

@@ -0,0 +1,63 @@
+import { bindCommand } from "../utils";
+export class ValueManager {
+    constructor(app) {
+        this.list = new Map();
+        this.app = app;
+        app.registerCommand("get", bindCommand(this.get, this));
+        app.registerCommand("set", bindCommand(this.set, this));
+    }
+    /** 注册值 */
+    register(name, { get, set, pluginName }) {
+        this.list.set(name, { get, set, pluginName });
+        this.app.emit("value:register", { name, value: get() }, { source: `plugin:${pluginName}` });
+    }
+    /** 取消注册 */
+    unregister(name) {
+        this.list.delete(name);
+        this.app.emit("value:unregister", { name });
+    }
+    /** 获取值 */
+    get(name, options) {
+        const item = this.list.get(name);
+        if (!item)
+            throw {};
+        return item.get(options);
+    }
+    /** 获取值(不存在则返回undefined) */
+    getNullable(name, options) {
+        return this.list.get(name)?.get(options);
+    }
+    /** 设置值 */
+    set(name, value, options) {
+        const valueItem = this.list.get(name);
+        if (valueItem?.set) {
+            valueItem?.set(value, options);
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /** 检测值是否存在 */
+    has(name) {
+        return this.list.has(name);
+    }
+    emit(name, value) {
+        this.app.emit(`change:${name}`, value);
+        this.app.emit("value:change", { name, value });
+    }
+    watch(name, listener) {
+        this.app.on(`change:${name}`, listener);
+    }
+    unwatch(name, listener) {
+        this.app.off(`change:${name}`, listener);
+    }
+    /** 获取注册的所有值 */
+    getData() {
+        const map = {};
+        this.list.forEach((config, name) => {
+            map[name] = config.get();
+        });
+        return map;
+    }
+}

package/dist/value/types.d.ts

@@ -0,0 +1,19 @@
+export interface ValueOptions<T> {
+    pluginName?: string;
+    get: () => T;
+    set?: (value: T) => void;
+}
+export interface ValueContext<T> {
+    emit: (value: T) => void;
+}
+export interface ValueItem<T> {
+    pluginName?: string;
+    get: (options?: ValueAccessOptions) => T;
+    set?: (value: T, options?: ValueAccessOptions) => void;
+}
+export interface ValueAccessOptions {
+    pluginName?: string;
+}
+export interface AppValueMap {
+    "": undefined;
+}

package/dist/value/types.js

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

package/package.json

@@ -1,53 +1,22 @@
 {
   "name": "floating-live",
-  "version": "0.15.10",
-  "type": "commonjs",
+  "version": "0.16.0-alpha.0",
+  "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "Minteea",
   "license": "MIT",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "require": "./dist/index.js",
-      "import": "./esm/index.js"
-    },
-    "./core": {
-      "types": "./dist/core/index.d.ts",
-      "require": "./dist/core/index.js",
-      "import": "./esm/core/index.js"
-    },
-    "./types": {
-      "types": "./dist/types/index.d.ts",
-      "require": "./dist/types/index.js",
-      "import": "./esm/types/index.js"
-    },
-    "./enums": {
-      "types": "./dist/enums.d.ts",
-      "require": "./dist/enums.js",
-      "import": "./esm/enums.js"
-    },
-    "./utils": {
-      "types": "./dist/utils.d.ts",
-      "require": "./dist/utils.js",
-      "import": "./esm/utils.js"
-    }
+  "devDependencies": {
+    "@types/node": "^22.8.2",
+    "typescript": "^5.6.3",
+    "rimraf": "^3.0.2",
+    "ts-node": "^10.9.1"
   },
   "scripts": {
     "tsc": "tsc -b",
-    "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 && tsc -b && tsc --project tsconfig.esm.json",
+    "clear": "rimraf dist",
+    "build": "npm run clear && tsc -b",
     "prepack": "npm run build",
     "postpack": "npm run clear"
-  },
-  "devDependencies": {
-    "rimraf": "^3.0.2",
-    "ts-node": "^10.9.1",
-    "typescript": "^4.8.4"
-  },
-  "peerDependencies": {
-    "events": "^3.3.0"
   }
 }

package/src/source.md

@@ -0,0 +1,29 @@
+##### 插件来源（source 字段）
+
+- managerName
+- "plugin:{pluginName}" (插件调用)
+- "" (app.emit())
+
+##### 客户端/服务端来源（client.name 字段）
+
+- "electron" (electron 客户端)
+- "web:{clinetId}" (网络客户端)
+- "server" (服务端)
+- "" (自身环境内)
+
+#### 机制
+
+- from server/node = source: "plugin:foo"
+  - to server/node = source: "plugin:foo" client: ""
+  - to client/browser = source: "plugin:foo" client: "server"
+  - to client/electron = source: "plugin:foo" client: "server"
+- from client/browser = source: "plugin:foo"
+  - to client/browser = source: "plugin:foo" client: ""
+  - to server/node = source: "plugin:foo" client: "browser:10000001"
+
+ctx.callWithOptions(name, options, ...args)
+ctx.emitWithOptions(name, detail, options)
+
+ctx.on()
+
+client.emit()

package/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/floatinglive.ts","./src/app.ts","./src/index.ts","./src/command/index.ts","./src/command/manager.ts","./src/command/types.ts","./src/error/index.ts","./src/error/types.ts","./src/event/index.ts","./src/event/manager.ts","./src/event/types.ts","./src/hook/index.ts","./src/hook/manager.ts","./src/hook/types.ts","./src/live/message.ts","./src/live/messageinfo.ts","./src/live/platform.ts","./src/live/room.ts","./src/plugin/index.ts","./src/plugin/manager.ts","./src/plugin/types.ts","./src/plugin/context/commonplugincontext.ts","./src/plugin/context/safeplugincontext.ts","./src/plugins/room/index.ts","./src/utils/eventemitter.ts","./src/utils/index.ts","./src/value/index.ts","./src/value/manager.ts","./src/value/types.ts"],"version":"5.6.3"}

package/dist/core/LiveRoom.d.ts

@@ -1,44 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from "events";
-import { ConnectStatus, RoomStatus } from "../enums";
-import { RoomDetail, RoomInfo, RoomStatsInfo } from "../types";
-import { Message, UserInfo } from "../types/message";
-export declare abstract class LiveRoom extends EventEmitter implements RoomInfo {
-    constructor();
-    /** 平台 */
-    abstract readonly platform: string;
-    /** 房间id */
-    abstract readonly id: string | number;
-    /** 房间详情 */
-    abstract detail: RoomDetail;
-    /** 统计信息 */
-    stats?: RoomStatsInfo;
-    /** 主播信息 */
-    abstract anchor: UserInfo;
-    /** 直播状态 */
-    status: RoomStatus;
-    /** 时间戳 */
-    timestamp: number;
-    /** 当前直播id */
-    liveId?: string;
-    /** 房间是否打开 */
-    opened: boolean;
-    /** 是否连接上房间 */
-    connection: ConnectStatus;
-    /** 房间是否可用 */
-    abstract available: boolean;
-    /** 打开连接 */
-    abstract open(): void;
-    /** 关闭连接 */
-    abstract close(): void;
-    /** 从服务器获取信息 */
-    abstract getInfo(): Promise<void>;
-    /** 销毁事件 */
-    protected onDestroy?(): void;
-    /** 销毁 */
-    destroy(): void;
-    protected emitMessage(msg: Message.All): void;
-    protected emitRaw(msg: any): void;
-    get info(): RoomInfo;
-    get key(): string;
-}

package/dist/core/LiveRoom.js

@@ -1,81 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LiveRoom = void 0;
-const events_1 = require("events");
-const enums_1 = require("../enums");
-class LiveRoom extends events_1.EventEmitter {
-    constructor() {
-        super();
-        /** 直播状态 */
-        this.status = enums_1.RoomStatus.off;
-        /** 时间戳 */
-        this.timestamp = 0;
-        /** 房间是否打开 */
-        this.opened = false;
-        /** 是否连接上房间 */
-        this.connection = enums_1.ConnectStatus.off;
-    }
-    /** 销毁 */
-    destroy() {
-        this.close();
-        this.removeAllListeners();
-        this.onDestroy?.();
-    }
-    // 发送消息
-    emitMessage(msg) {
-        // 其他消息 => 先更改状态再发送消息
-        // 直播结束消息 => 先发送消息再更改状态
-        switch (msg.type) {
-            case "live_start":
-                this.status = enums_1.RoomStatus.live;
-                this.timestamp = msg.timestamp;
-                this.emit("status", enums_1.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 || enums_1.RoomStatus.off;
-                this.timestamp = msg.timestamp;
-                this.emit("message", msg);
-                this.emit("status", msg.status || enums_1.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}`;
-    }
-}
-exports.LiveRoom = LiveRoom;

package/dist/core/index.d.ts

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

package/dist/core/index.js

@@ -1,17 +0,0 @@
-"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("./LiveRoom"), exports);

package/dist/core/plugin.d.ts

@@ -1,17 +0,0 @@
-import { FloatingLive } from "../live";
-import { FloatingEventMap } from "../types/events";
-export declare abstract class BasePlugin {
-    static pluginName: string;
-    protected main: FloatingLive;
-    private registerList;
-    constructor(main: FloatingLive);
-    /** 插件监听事件 */
-    on<T extends keyof FloatingEventMap>(eventName: T, listener: FloatingEventMap[T]): void;
-    /** 插件一次性监听事件 */
-    once<T extends keyof FloatingEventMap>(eventName: T, listener: FloatingEventMap[T]): void;
-    /** 插件移除监听事件 */
-    off<T extends keyof FloatingEventMap>(eventName: T, listener: FloatingEventMap[T]): void;
-    /** 插件发送事件 */
-    emit<T extends keyof FloatingEventMap>(eventName: T, ...args: Parameters<FloatingEventMap[T]>): void;
-    abstract destroy(): void;
-}

package/dist/core/plugin.js

@@ -1,28 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BasePlugin = void 0;
-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);
-    }
-}
-exports.BasePlugin = BasePlugin;

package/dist/enums.d.ts

@@ -1,51 +0,0 @@
-/** 直播间状态 */
-export declare enum RoomStatus {
-    /** 未开播 */
-    off = 0,
-    /** 正在直播 */
-    live = 1,
-    /** 正在轮播 */
-    round = 2,
-    /** 被封禁 */
-    banned = -1,
-    /** 已上锁 */
-    locked = -2
-}
-/** 直播间状态 */
-export declare enum ConnectStatus {
-    /** 未连接 */
-    off = 0,
-    /** 连接中 */
-    connecting = 1,
-    /** 连接到服务器 */
-    connected = 2,
-    /** 连接到房间 */
-    entered = 3,
-    /** 连接失败或断开 */
-    disconnected = -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 UserType {
-    /** 普通观众 */
-    normal = 0,
-    /** 房管 */
-    admin = 1,
-    /** 主播 */
-    anchor = 2
-}

package/dist/enums.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserType = exports.DanmakuMode = exports.ImageSize = exports.ConnectStatus = 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[RoomStatus["locked"] = -2] = "locked";
-})(RoomStatus = exports.RoomStatus || (exports.RoomStatus = {}));
-/** 直播间状态 */
-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 = exports.ConnectStatus || (exports.ConnectStatus = {}));
-/** 图片大小 */
-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 UserType;
-(function (UserType) {
-    /** 普通观众 */
-    UserType[UserType["normal"] = 0] = "normal";
-    /** 房管 */
-    UserType[UserType["admin"] = 1] = "admin";
-    /** 主播 */
-    UserType[UserType["anchor"] = 2] = "anchor";
-})(UserType = exports.UserType || (exports.UserType = {}));

package/dist/live.d.ts

@@ -1,39 +0,0 @@
-/// <reference types="node" />
-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";
-import { FloatingEventMap } from "./types/events";
-import { ErrorOptions, FloatingCommandMap } from "./types";
-export declare class FloatingLive extends EventEmitter {
-    /** 房间控制模块 */
-    room: ModRoom;
-    /** 插件处理模块 */
-    plugin: ModPlugin;
-    /** 命令模块 */
-    command: ModCommand;
-    /** Manifest模块 */
-    manifest: ModManifest;
-    /** 数值模块 */
-    value: ModValue;
-    /** 钩子模块 */
-    hook: ModHook;
-    constructor();
-    call<T extends keyof FloatingCommandMap>(name: T, ...args: Parameters<FloatingCommandMap[T]>): ReturnType<FloatingCommandMap[T]>;
-    on<T extends keyof FloatingEventMap>(eventName: T, listener: FloatingEventMap[T]): this;
-    emit<T extends keyof FloatingEventMap>(eventName: T, ...args: Parameters<FloatingEventMap[T]>): boolean;
-    /** 抛出错误 */
-    throw(err: Error, options?: ErrorOptions): void;
-    throw(options: ErrorOptions): void;
-    getSnapshot(): {
-        room: import("./types").RoomInfo[];
-        value: Record<string, any>;
-        manifest: Record<string, Record<string, any>>;
-        command: string[];
-        hook: Record<string, number>;
-        plugin: string[];
-    };
-}

package/dist/live.js

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FloatingLive = void 0;
-const events_1 = require("events");
-const plugin_1 = require("./module/plugin");
-const room_1 = require("./module/room");
-const manifest_1 = require("./module/manifest");
-const command_1 = require("./module/command");
-const value_1 = require("./module/value");
-const hook_1 = require("./module/hook");
-class FloatingLive extends events_1.EventEmitter {
-    constructor() {
-        super();
-        this.command = new command_1.ModCommand(this);
-        this.manifest = new manifest_1.ModManifest(this);
-        this.plugin = new plugin_1.ModPlugin(this);
-        this.room = new room_1.ModRoom(this);
-        this.value = new value_1.ModValue(this);
-        this.hook = new hook_1.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.hook.getSnapshot(),
-            plugin: this.plugin.getSnapshot(),
-        };
-    }
-}
-exports.FloatingLive = FloatingLive;

package/dist/module/command.d.ts

@@ -1,18 +0,0 @@
-import { FloatingLive } from "../live";
-import { FloatingCommandMap } from "../types";
-export declare class ModCommand {
-    /** 功能列表 */
-    private readonly list;
-    protected readonly main: FloatingLive;
-    constructor(main: FloatingLive);
-    /** 注册命令 */
-    register<T extends keyof FloatingCommandMap>(name: T, func: FloatingCommandMap[T]): void;
-    /** 取消注册命令 */
-    unregister(name: string): void;
-    /** 调用命令 */
-    call<T extends keyof FloatingCommandMap>(name: T, ...args: Parameters<FloatingCommandMap[T]>): any;
-    /** 检测命令是否存在 */
-    has<T extends keyof FloatingCommandMap>(name: T): boolean;
-    /** 获取快照 */
-    getSnapshot(): string[];
-}

package/dist/module/command.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModCommand = void 0;
-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);
-    }
-}
-exports.ModCommand = ModCommand;

package/dist/module/hook.d.ts

@@ -1,15 +0,0 @@
-import { FloatingLive } from "../live";
-import { FloatingHookMap } from "../types/hook";
-export type HookFunction<T> = (ctx: T) => boolean | void | Promise<boolean | void>;
-export declare class ModHook {
-    private list;
-    protected readonly main: FloatingLive;
-    constructor(main: FloatingLive);
-    /** 注册钩子函数 */
-    register<T extends keyof FloatingHookMap>(name: T, func: HookFunction<FloatingHookMap[T]>): void;
-    /** 取消注册钩子函数 */
-    unregister<T extends keyof FloatingHookMap>(name: T, func: HookFunction<FloatingHookMap[T]>): void;
-    /** 调用钩子函数 */
-    call<T extends keyof FloatingHookMap>(name: T, ctx: FloatingHookMap[T]): Promise<boolean>;
-    getSnapshot(): Record<string, number>;
-}