floating-live 0.17.0-alpha.1 → 0.17.0-alpha.10

package/LICENSE

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2023 Minteea
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+MIT License
+
+Copyright (c) 2023 Minteea
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,36 +1,36 @@
-# Floating Live
-
-一个用于处理和保存直播弹幕的 Web 小工具，开箱即用。
-
-本体无弹幕获取功能，需要配合[floating-live-plugins](https://github.com/Minteea/floating-live-plugins)中的插件使用。
-
-目前插件库支持 bilibili 和 AcFun 的直播弹幕，不同平台的弹幕会转换为同一种格式便于保存。
-
-项目仍在开发中，功能尚未完善，目前除了记录保存直播弹幕外暂时没有别的用处啦，敬请期待。
-
-注意：当前项目未进入正式版本阶段，程序结构及导出数据结构可能随时改动，**非常不建议用于正式项目中**。
-
-GUI 版本：[Minteea/floating-live-gui](https://github.com/Minteea/floating-live-gui)
-
-## 使用方法
-
-### npm 安装
-
-```
-npm install floating-live
-```
-
-```javascript
-// 导入FloatingLive本体
-import { FloatingLive } from "floating-live";
-// 导入bilibili房间生成插件
-import bilibili from "@floating-live/bilibili";
-
-// 创建一个FloatingLive实例
-const live = new FloatingLive();
-// 注册插件
-live.plugin.register(bilibili);
-
-// 添加房间并自动打开
-live.room.add("bilibili", 6, true);
-```
+# Floating Live
+
+一个用于处理和保存直播弹幕的 Web 小工具，开箱即用。
+
+本体无弹幕获取功能，需要配合[floating-live-plugins](https://github.com/Minteea/floating-live-plugins)中的插件使用。
+
+目前插件库支持 bilibili 和 AcFun 的直播弹幕，不同平台的弹幕会转换为同一种格式便于保存。
+
+项目仍在开发中，功能尚未完善，目前除了记录保存直播弹幕外暂时没有别的用处啦，敬请期待。
+
+注意：当前项目未进入正式版本阶段，程序结构及导出数据结构可能随时改动，**非常不建议用于正式项目中**。
+
+GUI 版本：[Minteea/floating-live-gui](https://github.com/Minteea/floating-live-gui)
+
+## 使用方法
+
+### npm 安装
+
+```
+npm install floating-live
+```
+
+```javascript
+// 导入FloatingLive本体
+import { FloatingLive } from "floating-live";
+// 导入bilibili房间生成插件
+import bilibili from "@floating-live/bilibili";
+
+// 创建一个FloatingLive实例
+const live = new FloatingLive();
+// 注册插件
+live.plugin.register(bilibili);
+
+// 添加房间并自动打开
+live.room.add("bilibili", 6, true);
+```

package/dist/FloatingLive.d.ts

@@ -1,17 +1,17 @@
 import { LiveRoom } from "./index.js";
 import { App } from "./app.js";
-import { Room } from "./plugins/room/index.js";
+import { Room, RoomCreateOptions } from "./plugins/room/index.js";
 import { Platform } from "./plugins/platform/index.js";
 export declare class FloatingLive extends App {
     room: Room;
     platform: Platform;
     constructor();
     /** 添加房间 */
-    add(platform: string, id: number, options?: boolean | Record<string, any>): Promise<void>;
+    add(platform: string, id: number, options?: boolean | RoomCreateOptions): Promise<void>;
     /** 移除房间 */
     remove(key: string): void;
     /** 获取房间 */
-    get(key: string): LiveRoom | undefined;
+    get(key: string): LiveRoom | import("./live/index.js").InvalidLiveRoom | undefined;
     has(key: string): boolean;
     /** 获取房间信息 */
     data(key: string): import("./live/index.js").LiveRoomData | undefined;
@@ -22,5 +22,5 @@ export declare class FloatingLive extends App {
     /** 关闭房间连接 */
     close(key: string): void;
     /** 获取房间列表 */
-    getList(): LiveRoom[];
+    getList(): (LiveRoom | import("./live/index.js").InvalidLiveRoom)[];
 }

package/dist/FloatingLive.js

@@ -2,6 +2,8 @@ import { App } from "./app.js";
 import { Room } from "./plugins/room/index.js";
 import { Platform } from "./plugins/platform/index.js";
 export class FloatingLive extends App {
+    room;
+    platform;
     constructor() {
         super();
         this.room = this.registerSync(Room, {}, { unremovable: true, accessApp: true, pluginType: "core" });

package/dist/app.d.ts

@@ -1,11 +1,10 @@
 import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction } from "./command/index.js";
 import { CommandManager } from "./command/manager.js";
-import { AppError } from "./error/index.js";
 import { AppEventDetailMap, AppEventEmitOptions, AppEventListener } from "./event/index.js";
 import { AppHookMap, HookCallOptions, HookContext, HookFunction, HookUseOptions } from "./hook/index.js";
 import { HookManager } from "./hook/manager.js";
-import { PluginConstructor, PluginContext, PluginInitOptions, PluginItem, PluginRegisterOptions } from "./plugin/index.js";
-import { PluginManager, WhenRegisterCallback } from "./plugin/manager.js";
+import { PluginConstructor, PluginContext, PluginInitOptions, PluginItem, PluginRegisterOptions, WhenRegisterCallback } from "./plugin/index.js";
+import { PluginManager } from "./plugin/manager.js";
 import { CustomEventEmitter } from "./utils/EventEmitter.js";
 import { AppValueMap, ValueOptions } from "./value/index.js";
 import { ValueManager } from "./value/manager.js";
@@ -20,9 +19,6 @@ export declare class App extends CustomEventEmitter implements PluginContext {
     once<K extends keyof AppEventDetailMap>(type: K, listener: AppEventListener<AppEventDetailMap[K]>, signal?: AbortSignal): void;
     off<K extends keyof AppEventDetailMap>(type: K, listener: AppEventListener<AppEventDetailMap[K]>): void;
     emit<K extends keyof AppEventDetailMap>(type: K, detail: AppEventDetailMap[K], options?: AppEventEmitOptions & EventInit): void;
-    /** 发送错误 */
-    throw(err?: Error): void;
-    error(id: string, detail?: Record<string, any>): AppError;
     /** 注册插件 */
     register<P extends PluginItem>(plugin: PluginConstructor<P>, options?: PluginInitOptions, registerOptions?: PluginRegisterOptions): Promise<P>;
     /** 同步注册插件 */

package/dist/app.js

@@ -1,13 +1,16 @@
 import { CommandManager } from "./command/manager.js";
-import { AppError } from "./error/index.js";
 import { HookManager } from "./hook/manager.js";
 import { PluginManager } from "./plugin/manager.js";
 import { CustomEventEmitter } from "./utils/EventEmitter.js";
 import { ValueManager } from "./value/manager.js";
 export class App extends CustomEventEmitter {
+    hookManager;
+    pluginManager;
+    commandManager;
+    valueManager;
+    abortController = new AbortController();
     constructor() {
         super();
-        this.abortController = new AbortController();
         this.commandManager = new CommandManager(this);
         this.hookManager = new HookManager(this);
         this.valueManager = new ValueManager(this);
@@ -31,14 +34,6 @@ export class App extends CustomEventEmitter {
         super.emit(type, { ...detail, source, remote }, options);
         super.emit("event", { name: type, detail: { ...detail, source, remote } });
     }
-    //--- 错误机制 ---//
-    /** 发送错误 */
-    throw(err) {
-        throw err;
-    }
-    error(id, detail) {
-        return new AppError(id, detail || {});
-    }
     //--- 插件机制 ---//
     /** 注册插件 */
     register(plugin, options, registerOptions) {

package/dist/command/manager.js

@@ -1,8 +1,9 @@
-import { AppError } from "../error/index.js";
+import { appError } from "../error/index.js";
 export class CommandManager {
+    /** 功能列表 */
+    list = new Map();
+    app;
     constructor(app) {
-        /** 功能列表 */
-        this.list = new Map();
         this.app = app;
     }
     /** 注册命令 */
@@ -24,7 +25,7 @@ export class CommandManager {
     callWithOptions(name, options, ...args) {
         const command = this.list.get(name);
         if (!command) {
-            throw new AppError("command:call_unexist", {
+            throw appError("command:call_unexist", {
                 message: `命令不存在: ${name}`,
                 target: `command/${name}`,
             });

package/dist/error/index.d.ts

@@ -1,13 +1,24 @@
-import { ErrorOptions } from "./types.js";
 export * from "./types.js";
-export declare class AppError extends Error {
-    /** 错误id */
-    id: string;
-    /** 错误来源 */
-    source?: string;
-    /** 错误目标 */
+export interface AppError extends Error {
+    /** 错误发生信息 */
+    cause: {
+        /** 错误id */
+        id: string;
+        /** 错误目标对象 */
+        target?: string;
+        /** 错误原因 */
+        reason?: string | Error | AppError;
+    };
+}
+export interface AppErrorOptions {
+    /** 错误消息 */
+    message: string;
+    /** 错误目标对象 */
     target?: string;
     /** 错误原因 */
-    cause?: Error | string;
-    constructor(id: string, options: ErrorOptions);
+    reason?: string | Error | AppError;
+    /** 错误构造函数 */
+    errorConstructor?: ErrorConstructor;
+    [key: string]: unknown;
 }
+export declare function appError(id: string, { message, target, reason, errorConstructor }: AppErrorOptions): Error;

package/dist/error/index.js

@@ -1,10 +1,10 @@
 export * from "./types.js";
-export class AppError extends Error {
-    constructor(id, options) {
-        super(options.message);
-        this.id = id;
-        this.source = options?.source;
-        this.cause = options?.cause;
-        this.target = options?.target;
-    }
+export function appError(id, { message, target, reason, errorConstructor = Error }) {
+    return new errorConstructor(message, {
+        cause: {
+            id,
+            target,
+            reason,
+        },
+    });
 }

package/dist/event/manager.js

@@ -1,8 +1,7 @@
 export class EventManager {
-    constructor(app) {
-        this.registerMap = new Map();
-        this.generalRegisterSet = new Set();
-    }
+    constructor(app) { }
+    registerMap = new Map();
+    generalRegisterSet = new Set();
     register(eventName, pluginName) {
         if (this.registerMap.has(eventName))
             throw new Error("事件名已注册");

package/dist/event/types.d.ts

@@ -1,3 +1,4 @@
+import { PluginInfo } from "../plugin/index.js";
 export interface AppEventEmitOptions {
     /** 事件来源 */
     source?: string;
@@ -19,11 +20,10 @@ export interface AppEventDetailMap {
     "command:unregister": {
         name: string;
     };
-    "plugin:register": {
-        pluginName: string;
-    };
+    "plugin:register": PluginInfo;
     "plugin:unregister": {
         pluginName: string;
+        role: string;
     };
     "value:register": {
         name: string;

package/dist/hook/manager.js

@@ -1,8 +1,9 @@
-import { AppError } from "../error/index.js";
+import { appError } from "../error/index.js";
 export class HookManager {
+    list = new Map();
+    pluginMap = new Map();
+    app;
     constructor(app) {
-        this.list = new Map();
-        this.pluginMap = new Map();
         this.app = app;
         app.registerCommand("hook.snapshot", () => this.toSnapshot());
     }
@@ -15,9 +16,9 @@ export class HookManager {
             this.list.set(name, hooks);
         }
         else if (hooks.includes(call)) {
-            throw new AppError("hook:use_duplicate", {
+            throw appError("hook:use_duplicate", {
                 message: `钩子函数挂载失败: ${name}`,
-                cause: "重复挂载同一函数",
+                reason: "重复挂载同一函数",
                 target: `hook/${name}`,
             });
         }
@@ -28,9 +29,9 @@ export class HookManager {
         let hooks = this.list.get(name);
         const index = hooks?.findIndex((item) => item.call == call) ?? -1;
         if (!hooks || index < 0)
-            throw new AppError("hook:unuse_unexist", {
+            throw appError("hook:unuse_unexist", {
                 message: `钩子函数卸载失败: ${name}`,
-                cause: "卸载不存在的钩子函数",
+                reason: "卸载不存在的钩子函数",
                 target: `hook/${name}`,
             });
         hooks.splice(index, 1);

package/dist/live/room.d.ts

@@ -5,9 +5,12 @@ import { UserInfo } from "./messageInfo.js";
 /** 直播间信息流监听类 */
 export declare abstract class LiveRoom extends CustomEventEmitter implements LiveRoomData {
     constructor();
-    get valid(): boolean;
+    get valid(): true;
+    get serviceId(): string;
     /** 平台 */
     abstract readonly platform: string;
+    /** api服务 */
+    readonly service: string;
     /** 房间id */
     abstract readonly id: string | number;
     /** 房间详情 */
@@ -40,10 +43,12 @@ export declare abstract class LiveRoom extends CustomEventEmitter implements Liv
     abstract fetchData?(): Promise<LiveRoomData>;
     /** 设置房间数据 */
     abstract setData?(data: LiveRoomData): LiveRoomData;
-    /** 销毁 */
+    /** 销毁钩子 */
+    protected onDestroy?(): void;
+    /** 销毁
+     * @internal 请勿在继承 LiveRoom 的子类中声明该方法，应使用 onDestroy 钩子
+     */
     destroy(): void;
-    /** 销毁事件 */
-    protected onDestroy?: () => void;
     /** 发送消息 */
     protected emitMessage(msg: LiveMessage.All): void;
     /** 发送源消息 */
@@ -52,6 +57,28 @@ export declare abstract class LiveRoom extends CustomEventEmitter implements Liv
     toData(): LiveRoomData;
     get key(): string;
 }
+/** 无效房间 */
+export declare class InvalidLiveRoom implements LiveRoomData {
+    get valid(): false;
+    get serviceId(): string;
+    constructor(serviceId: string, id: string | number);
+    readonly platform: string;
+    readonly id: string | number;
+    readonly service: string;
+    detail: LiveRoomDetailInfo;
+    stats?: LiveRoomStatsInfo;
+    anchor: UserInfo;
+    status: LiveRoomStatus;
+    timestamp: number;
+    connectionStatus: LiveConnectionStatus;
+    openStatus: LiveRoomOpenStatus;
+    liveId?: string;
+    get opened(): boolean;
+    available: boolean;
+    /** 生成房间数据 */
+    toData(): LiveRoomData;
+    get key(): string;
+}
 export interface LiveRoom {
     on<K extends keyof LiveRoomEventMap>(type: K, listener: (e: LiveRoomEventMap[K]) => void, signal?: AbortSignal): void;
     once<K extends keyof LiveRoomEventMap>(type: K, listener: (e: LiveRoomEventMap[K]) => void, signal?: AbortSignal): void;
@@ -65,8 +92,12 @@ export interface LiveRoomData {
     valid: boolean;
     /** 平台id */
     platform: string;
+    /** API服务 */
+    service: string;
     /** 房间id */
     id: number | string;
+    /** API服务id */
+    serviceId: string;
     /** 房间key */
     key: string;
     /** 基本信息 */
@@ -196,22 +227,3 @@ export interface LiveRoomEventMap {
     /** 关闭直播间连接 */
     close: {};
 }
-export declare class InvalidLiveRoom implements LiveRoomData {
-    get valid(): false;
-    constructor(platform: string, id: string | number);
-    readonly platform: string;
-    readonly id: string | number;
-    detail: LiveRoomDetailInfo;
-    stats?: LiveRoomStatsInfo;
-    anchor: UserInfo;
-    status: LiveRoomStatus;
-    timestamp: number;
-    connectionStatus: LiveConnectionStatus;
-    openStatus: LiveRoomOpenStatus;
-    liveId?: string;
-    get opened(): boolean;
-    available: boolean;
-    /** 生成房间数据 */
-    toData(): LiveRoomData;
-    get key(): string;
-}

package/dist/live/room.js

@@ -3,25 +3,38 @@ import { CustomEventEmitter } from "../utils/EventEmitter.js";
 export class LiveRoom extends CustomEventEmitter {
     constructor() {
         super();
-        /** 直播状态 */
-        this.status = LiveRoomStatus.off;
-        /** 时间戳 */
-        this.timestamp = 0;
-        /** 房间连接状态 */
-        this.connectionStatus = LiveConnectionStatus.off;
-        /** 房间开启状态 */
-        this.openStatus = 0;
-        this.available = false;
     }
     get valid() {
         return true;
     }
+    get serviceId() {
+        return this.service ? `${this.platform}.${this.service}` : this.platform;
+    }
+    /** api服务 */
+    service = "";
+    /** 统计信息 */
+    stats;
+    /** 直播状态 */
+    status = LiveRoomStatus.off;
+    /** 时间戳 */
+    timestamp = 0;
+    /** 当前直播id */
+    liveId;
+    /** 房间连接状态 */
+    connectionStatus = LiveConnectionStatus.off;
+    /** 房间开启状态 */
+    openStatus = 0;
     get opened() {
         return this.openStatus == 2;
     }
-    /** 销毁 */
+    available = false;
+    /** 销毁
+     * @internal 请勿在继承 LiveRoom 的子类中声明该方法，应使用 onDestroy 钩子
+     */
     destroy() {
+        // 关闭房间
         this.close();
+        // 调用 onDestory 钩子
         this.onDestroy?.();
     }
     /** 发送消息 */
@@ -69,6 +82,61 @@ export class LiveRoom extends CustomEventEmitter {
         return {
             valid: this.valid,
             platform: this.platform,
+            service: this.service,
+            id: this.id,
+            detail: this.detail,
+            stats: this.stats,
+            anchor: this.anchor,
+            timestamp: this.timestamp,
+            status: this.status,
+            liveId: this.liveId,
+            openStatus: this.openStatus,
+            opened: this.opened,
+            available: this.available,
+            connectionStatus: this.connectionStatus,
+            key: this.key,
+            serviceId: this.serviceId,
+        };
+    }
+    get key() {
+        return `${this.serviceId}:${this.id}`;
+    }
+}
+/** 无效房间 */
+export class InvalidLiveRoom {
+    get valid() {
+        return false;
+    }
+    get serviceId() {
+        return this.service ? `${this.platform}.${this.service}` : this.platform;
+    }
+    constructor(serviceId, id) {
+        const [platform, ...serviceIdArr] = serviceId.split(".");
+        this.platform = platform;
+        this.id = id;
+        this.service = serviceIdArr.join(".");
+    }
+    platform;
+    id;
+    service;
+    detail = {};
+    stats;
+    anchor = { name: "", id: 0 };
+    status = LiveRoomStatus.off;
+    timestamp = 0;
+    connectionStatus = LiveConnectionStatus.off;
+    openStatus = 0;
+    liveId;
+    get opened() {
+        return this.openStatus == 2;
+    }
+    available = false;
+    /** 生成房间数据 */
+    toData() {
+        return {
+            valid: this.valid,
+            platform: this.platform,
+            service: this.service,
             id: this.id,
             detail: this.detail,
             stats: this.stats,
@@ -80,11 +148,12 @@ export class LiveRoom extends CustomEventEmitter {
             opened: this.opened,
             available: this.available,
             connectionStatus: this.connectionStatus,
+            serviceId: this.serviceId,
             key: this.key,
         };
     }
     get key() {
-        return `${this.platform}:${this.id}`;
+        return `${this.serviceId}:${this.id}`;
     }
 }
 /** 直播间状态 */
@@ -122,44 +191,3 @@ export const LiveRoomOpenStatus = {
     /** 已开启 */
     opened: 2,
 };
-export class InvalidLiveRoom {
-    get valid() {
-        return false;
-    }
-    constructor(platform, id) {
-        this.detail = {};
-        this.anchor = { name: "", id: 0 };
-        this.status = LiveRoomStatus.off;
-        this.timestamp = 0;
-        this.connectionStatus = LiveConnectionStatus.off;
-        this.openStatus = 0;
-        this.available = false;
-        this.platform = platform;
-        this.id = id;
-    }
-    get opened() {
-        return this.openStatus == 2;
-    }
-    /** 生成房间数据 */
-    toData() {
-        return {
-            valid: this.valid,
-            platform: this.platform,
-            id: this.id,
-            detail: this.detail,
-            stats: this.stats,
-            anchor: this.anchor,
-            timestamp: this.timestamp,
-            status: this.status,
-            liveId: this.liveId,
-            openStatus: this.openStatus,
-            opened: this.opened,
-            available: this.available,
-            connectionStatus: this.connectionStatus,
-            key: this.key,
-        };
-    }
-    get key() {
-        return `${this.platform}:${this.id}`;
-    }
-}

package/dist/plugin/context/CommonPluginContext.d.ts

@@ -1,11 +1,9 @@
 import { App } from "../../app.js";
 import type { CommandOptions, CommandCallOptions, CommandFunction, AppCommandMap } from "../../command/index.js";
-import { AppError, ErrorOptions } from "../../error/index.js";
 import { AppEventListener, AppEventEmitOptions, AppEventDetailMap } from "../../event/index.js";
 import { HookUseOptions, HookCallOptions, AppHookMap, HookFunction, HookContext } from "../../hook/index.js";
 import { AppValueMap, ValueContext, ValueOptions } from "../../value/index.js";
-import { WhenRegisterCallback } from "../manager.js";
-import type { PluginContext, PluginConstructor, PluginInitOptions, AppPluginExposesMap, PluginItem } from "../types.js";
+import type { PluginContext, PluginConstructor, PluginInitOptions, AppPluginExposesMap, PluginItem, WhenRegisterCallback } from "../types.js";
 export declare class CommonPluginContext implements PluginContext {
     #private;
     get safe(): boolean;
@@ -16,12 +14,6 @@ export declare class CommonPluginContext implements PluginContext {
     constructor(app: App, pluginName: string, options?: {
         accessApp?: boolean;
     });
-    /** 抛出错误
-     *
-     * 一般用于自身导致的错误，若非插件本身导致的错误，使用throw语句即可
-     */
-    throw(err: AppError): void;
-    error(id: string, options: ErrorOptions): AppError;
     register<P extends PluginItem>(plugin: PluginConstructor<P>, options?: PluginInitOptions): Promise<P>;
     unregister(pluginName: string): void;
     getPluginExposes<K extends keyof AppPluginExposesMap>(pluginName: K): AppPluginExposesMap[K];