floating-live 0.17.0-alpha.5 → 0.17.0-alpha.6

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,13 +1,13 @@
 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;
     /** 获取房间 */

package/dist/app.d.ts

@@ -1,6 +1,5 @@
 import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction } from "./command/index.js";
 import { CommandManager } from "./command/manager.js";
-import { AppErrorLegacy } 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";
@@ -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): never;
-    error(id: string, detail?: Record<string, any>): AppErrorLegacy;
     /** 注册插件 */
     register<P extends PluginItem>(plugin: PluginConstructor<P>, options?: PluginInitOptions, registerOptions?: PluginRegisterOptions): Promise<P>;
     /** 同步注册插件 */

package/dist/app.js

@@ -1,5 +1,4 @@
 import { CommandManager } from "./command/manager.js";
-import { AppErrorLegacy } from "./error/index.js";
 import { HookManager } from "./hook/manager.js";
 import { PluginManager } from "./plugin/manager.js";
 import { CustomEventEmitter } from "./utils/EventEmitter.js";
@@ -35,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 AppErrorLegacy(id, detail || {});
-    }
     //--- 插件机制 ---//
     /** 注册插件 */
     register(plugin, options, registerOptions) {

package/dist/command/manager.js

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

package/dist/error/index.d.ts

@@ -1,17 +1,4 @@
-import { ErrorOptions } from "./types.js";
 export * from "./types.js";
-/** @deprecated 应使用 appError 函数代替 */
-export declare class AppErrorLegacy extends Error {
-    /** 错误id */
-    id: string;
-    /** 错误来源 */
-    source?: string;
-    /** 错误目标 */
-    target?: string;
-    /** 错误原因 */
-    cause?: Error | string;
-    constructor(id: string, options: ErrorOptions);
-}
 export interface AppError extends Error {
     /** 错误发生信息 */
     cause: {
@@ -32,5 +19,6 @@ export interface AppErrorOptions {
     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,22 +1,4 @@
 export * from "./types.js";
-/** @deprecated 应使用 appError 函数代替 */
-export class AppErrorLegacy extends Error {
-    /** 错误id */
-    id;
-    /** 错误来源 */
-    source;
-    /** 错误目标 */
-    target;
-    /** 错误原因 */
-    cause;
-    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: {

package/dist/hook/manager.js

@@ -1,4 +1,4 @@
-import { AppErrorLegacy } from "../error/index.js";
+import { appError } from "../error/index.js";
 export class HookManager {
     list = new Map();
     pluginMap = new Map();
@@ -16,9 +16,9 @@ export class HookManager {
             this.list.set(name, hooks);
         }
         else if (hooks.includes(call)) {
-            throw new AppErrorLegacy("hook:use_duplicate", {
+            throw appError("hook:use_duplicate", {
                 message: `钩子函数挂载失败: ${name}`,
-                cause: "重复挂载同一函数",
+                reason: "重复挂载同一函数",
                 target: `hook/${name}`,
             });
         }
@@ -29,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 AppErrorLegacy("hook:unuse_unexist", {
+            throw appError("hook:unuse_unexist", {
                 message: `钩子函数卸载失败: ${name}`,
-                cause: "卸载不存在的钩子函数",
+                reason: "卸载不存在的钩子函数",
                 target: `hook/${name}`,
             });
         hooks.splice(index, 1);

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

@@ -1,6 +1,5 @@
 import { App } from "../../app.js";
 import type { CommandOptions, CommandCallOptions, CommandFunction, AppCommandMap } from "../../command/index.js";
-import { AppErrorLegacy, 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";
@@ -15,12 +14,6 @@ export declare class CommonPluginContext implements PluginContext {
     constructor(app: App, pluginName: string, options?: {
         accessApp?: boolean;
     });
-    /** 抛出错误
-     *
-     * 一般用于自身导致的错误，若非插件本身导致的错误，使用throw语句即可
-     */
-    throw(err: AppErrorLegacy): never;
-    error(id: string, options: ErrorOptions): AppErrorLegacy;
     register<P extends PluginItem>(plugin: PluginConstructor<P>, options?: PluginInitOptions): Promise<P>;
     unregister(pluginName: string): void;
     getPluginExposes<K extends keyof AppPluginExposesMap>(pluginName: K): AppPluginExposesMap[K];

package/dist/plugin/context/CommonPluginContext.js

@@ -1,4 +1,3 @@
-import { AppErrorLegacy } from "../../error/index.js";
 class ListMap extends Map {
     addItem(key, value) {
         const list = this.get(key);
@@ -43,17 +42,6 @@ export class CommonPluginContext {
         this.pluginName = pluginName;
         this.#accessApp = options?.accessApp ?? false;
     }
-    /** 抛出错误
-     *
-     * 一般用于自身导致的错误，若非插件本身导致的错误，使用throw语句即可
-     */
-    throw(err) {
-        err.source ??= `plugin:${this.pluginName}`;
-        throw err;
-    }
-    error(id, options) {
-        return new AppErrorLegacy(id, options);
-    }
     register(plugin, options) {
         const p = this.#app.register(plugin, options);
         this.#registered.plugins.add(plugin.name);

package/dist/plugin/context/SafePluginContext.js

@@ -1,4 +1,4 @@
-import { AppErrorLegacy } from "../../error/index.js";
+import { appError } from "../../error/index.js";
 import { CommonPluginContext } from "./CommonPluginContext.js";
 export class SafePluginContext extends CommonPluginContext {
     get safe() {
@@ -9,12 +9,12 @@ export class SafePluginContext extends CommonPluginContext {
         super(app, pluginName);
         this.#permissions = options.permissions;
     }
-    throwNotPermitted(permission, cause) {
-        this.throw(new AppErrorLegacy("plugin:no_permission", {
+    throwNotPermitted(permission, reason) {
+        throw appError("plugin:no_permission", {
             message: "插件权限不足",
-            cause,
+            reason,
             permission,
-        }));
+        });
     }
     register(plugin, options) {
         if (!this.#permissions["plugin.register"]) {

package/dist/plugin/manager.js

@@ -1,6 +1,6 @@
 import { CommonPluginContext } from "./context/CommonPluginContext.js";
-import { AppErrorLegacy } from "../error/index.js";
 import { bindCommand } from "../utils/index.js";
+import { appError } from "../error/index.js";
 export class PluginManager {
     /** 插件列表 */
     list = new Map();
@@ -13,16 +13,16 @@ export class PluginManager {
     registerSync(pluginConstructor, options = {}, { context, core, unremovable, accessApp, pluginType, } = {}) {
         const pluginName = pluginConstructor.pluginName;
         if (!pluginName) {
-            throw new AppErrorLegacy("plugin:register_id_missing", {
+            throw appError("plugin:register_id_missing", {
                 message: "插件注册失败",
-                cause: "插件缺少pluginName字段",
+                reason: "插件缺少pluginName字段",
                 target: "plugin/#unnamed",
             });
         }
         if (this.list.has(pluginName)) {
-            throw new AppErrorLegacy("plugin:register_id_duplicate", {
+            throw appError("plugin:register_id_duplicate", {
                 message: `插件注册失败: ${pluginName}`,
-                cause: "已存在相同id的插件",
+                reason: "已存在相同id的插件",
                 target: `plugin/${pluginName}`,
             });
         }
@@ -31,9 +31,9 @@ export class PluginManager {
         try {
             const ctx = this.app.callHookSync("plugin.register", registerCtx);
             if (ctx.defaultPrevented)
-                throw new AppErrorLegacy("plugin:register_hook_prevented", {
+                throw appError("plugin:register_hook_prevented", {
                     message: `插件注册失败: ${pluginName}`,
-                    cause: "插件注册被钩子函数阻止",
+                    reason: "插件注册被钩子函数阻止",
                     target: `plugin/${pluginName}`,
                 });
             // 执行插件函数
@@ -63,9 +63,9 @@ export class PluginManager {
             return plugin;
         }
         catch (err) {
-            throw new AppErrorLegacy("plugin:register_fail", {
+            throw appError("plugin:register_fail", {
                 message: `插件注册失败: ${pluginName}`,
-                cause: err,
+                reason: err,
                 target: `plugin/${pluginName}`,
             });
         }
@@ -74,16 +74,16 @@ export class PluginManager {
     async register(pluginConstructor, options = {}, { context, core, unremovable, accessApp, pluginType, } = {}) {
         const pluginName = pluginConstructor.pluginName;
         if (!pluginName) {
-            throw new AppErrorLegacy("plugin:register_id_missing", {
+            throw appError("plugin:register_id_missing", {
                 message: "插件注册失败",
-                cause: "插件缺少pluginName字段",
+                reason: "插件缺少pluginName字段",
                 target: "plugin/#unnamed",
             });
         }
         if (this.list.has(pluginName)) {
-            throw new AppErrorLegacy("plugin:register_id_duplicate", {
+            throw appError("plugin:register_id_duplicate", {
                 message: `插件注册失败: ${pluginName}`,
-                cause: "已存在相同id的插件",
+                reason: "已存在相同id的插件",
                 target: `plugin/${pluginName}`,
             });
         }
@@ -93,9 +93,9 @@ export class PluginManager {
             .callHook("plugin.register", registerCtx)
             .then(async (ctx) => {
             if (ctx.defaultPrevented)
-                throw new AppErrorLegacy("plugin:register_hook_prevented", {
+                throw appError("plugin:register_hook_prevented", {
                     message: `插件注册失败: ${pluginName}`,
-                    cause: "插件注册被钩子函数阻止",
+                    reason: "插件注册被钩子函数阻止",
                     target: `plugin/${pluginName}`,
                 });
             // 执行插件函数
@@ -124,9 +124,9 @@ export class PluginManager {
             return plugin;
         })
             .catch((err) => {
-            throw new AppErrorLegacy("plugin:register_fail", {
+            throw appError("plugin:register_fail", {
                 message: `插件注册失败: ${pluginName}`,
-                cause: err,
+                reason: err,
                 target: `plugin/${pluginName}`,
             });
         });
@@ -136,18 +136,18 @@ export class PluginManager {
         const pluginData = this.list.get(pluginName);
         // 检测插件是否存在
         if (!pluginData) {
-            throw new AppErrorLegacy("plugin:unregister_unexist", {
+            throw appError("plugin:unregister_unexist", {
                 message: `插件移除失败: ${pluginName}`,
-                cause: "插件不存在",
+                reason: "插件不存在",
                 target: `plugin/${pluginName}`,
             });
         }
         else {
             const { plugin, context, unremovable } = pluginData;
             if (unremovable) {
-                throw new AppErrorLegacy("plugin:unregister_unremovable", {
+                throw appError("plugin:unregister_unremovable", {
                     message: `插件移除失败: ${pluginName}`,
-                    cause: "不可移除的插件",
+                    reason: "不可移除的插件",
                     target: `plugin/${pluginName}`,
                 });
             }

package/dist/plugins/room/index.d.ts

@@ -8,7 +8,7 @@ export interface RoomCreateOptions {
     [option: string]: any;
 }
 interface PluginExposes {
-    add(platform: string, id: number, options?: boolean | Record<string, any>): void;
+    add(platform: string, id: number, options?: boolean | RoomCreateOptions): void;
     remove(key: string): void;
     get(key: string): LiveRoom | InvalidLiveRoom | undefined;
     has(key: string): boolean;
@@ -20,7 +20,7 @@ interface PluginExposes {
 }
 declare module "../../index.js" {
     interface AppCommandMap {
-        add: (platform: string, id: number, options?: boolean | Record<string, any>) => void;
+        add: (platform: string, id: number, options?: boolean | RoomCreateOptions) => void;
         remove: (key: string) => void;
         move: (key: string, position: number) => void;
         open: (key: string) => void;
@@ -29,7 +29,7 @@ declare module "../../index.js" {
         "room.snapshot": () => LiveRoomData[];
         "room.validate": (key: string) => void;
         "room.invalidate": (key: string) => void;
-        [name: `${string}.room.create`]: (id: string | number, options: Record<string, any>) => LiveRoom | Promise<LiveRoom>;
+        [name: `${string}.room.create`]: (id: string | number, options: RoomCreateOptions) => LiveRoom | Promise<LiveRoom>;
         [name: `${string}.room.data`]: (id: string | number) => LiveRoomData | Promise<LiveRoomData>;
     }
     interface AppEventDetailMap {
@@ -113,7 +113,7 @@ declare module "../../index.js" {
         "room.create": {
             serviceId: string;
             id: string | number;
-            options: Record<string, any>;
+            options: RoomCreateOptions;
         };
     }
     interface AppSnapshotMap {

package/dist/plugins/room/index.js

@@ -83,7 +83,12 @@ export class Room extends BasePlugin {
             const ctx = { key, platform, roomId, message };
             this.ctx.callHook("live.message", ctx).then((ctx) => {
                 !ctx.defaultPrevented &&
-                    this.ctx.emit("live:message", { key, platform, roomId, message: ctx.message });
+                    this.ctx.emit("live:message", {
+                        key,
+                        platform,
+                        roomId,
+                        message: ctx.message,
+                    });
             });
         });
         // 直播消息源数据
@@ -202,7 +207,10 @@ export class Room extends BasePlugin {
             });
         }
         const { serviceId, id } = invalidRoom;
-        const room = await this.create(serviceId, id, { ...options, allowInvalidRoom: false });
+        const room = await this.create(serviceId, id, {
+            ...options,
+            allowInvalidRoom: false,
+        });
         this.map.set(key, room);
         if (room.valid) {
             this.ctx.emit("room:validate", { key, room: room.toData() });
@@ -271,10 +279,10 @@ export class Room extends BasePlugin {
     open(key) {
         let room = this.map.get(key);
         if (!room) {
-            throw (appError("room:open_unexist", {
+            throw appError("room:open_unexist", {
                 message: "要打开的房间不存在",
                 target: `room/${key}`,
-            }));
+            });
         }
         if (!room.valid) {
             throw appError("room:open_invalid", {

package/dist/value/manager.js

@@ -1,4 +1,4 @@
-import { AppErrorLegacy } from "../error/index.js";
+import { appError } from "../error/index.js";
 import { bindCommand } from "../utils/index.js";
 export class ValueManager {
     list = new Map();
@@ -26,7 +26,7 @@ export class ValueManager {
     get(name, options) {
         const item = this.list.get(name);
         if (!item)
-            throw new AppErrorLegacy("value:get_unexist", {
+            throw appError("value:get_unexist", {
                 message: "无法获取未注册的值",
             });
         return item.get(options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "floating-live",
-  "version": "0.17.0-alpha.5",
+  "version": "0.17.0-alpha.6",
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",