floating-live 0.17.0-alpha.12 → 0.17.0-alpha.14

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

@@ -13,8 +13,6 @@ export declare class FloatingLive extends App {
     /** 获取房间 */
     get(key: string): LiveRoom | import("./live/index.js").InvalidLiveRoom | undefined;
     has(key: string): boolean;
-    /** 获取房间信息 */
-    data(key: string): import("./live/index.js").LiveRoomData | undefined;
     /** 更新房间信息 */
     update(key: string): void;
     /** 打开房间连接 */

package/dist/FloatingLive.js

@@ -24,10 +24,6 @@ export class FloatingLive extends App {
     has(key) {
         return this.room.has(key);
     }
-    /** 获取房间信息 */
-    data(key) {
-        return this.room.data(key);
-    }
     /** 更新房间信息 */
     update(key) {
         return this.room.update(key);

package/dist/app.d.ts

@@ -1,4 +1,4 @@
-import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction } from "./command/index.js";
+import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction, AppCommandAliasMap } from "./command/index.js";
 import { CommandManager } from "./command/manager.js";
 import { AppEventDetailMap, AppEventEmitOptions, AppEventListener } from "./event/index.js";
 import { AppHookMap, HookCallOptions, HookContext, HookFunction, HookUseOptions } from "./hook/index.js";
@@ -31,6 +31,7 @@ export declare class App extends CustomEventEmitter implements PluginContext {
     getPluginExposes(pluginName: string): any;
     hasPlugin(pluginName: string): boolean;
     registerCommand<T extends keyof AppCommandMap>(name: T, func: CommandFunction<AppCommandMap[T]>, options?: CommandOptions): void;
+    registerCommandAlias<T extends keyof AppCommandAliasMap>(name: T, targetName: AppCommandAliasMap[T], options?: CommandOptions): void;
     unregisterCommand(name: string): void;
     hasCommand(name: string): boolean;
     call<T extends keyof AppCommandMap>(name: T, ...args: Parameters<AppCommandMap[T]>): ReturnType<AppCommandMap[T]>;

package/dist/app.js

@@ -16,7 +16,7 @@ export class App extends CustomEventEmitter {
         this.valueManager = new ValueManager(this);
         this.pluginManager = new PluginManager(this);
         // 初始化命令
-        this.registerCommand("command.snapshot", () => this.commandManager.toSnapshot());
+        this.registerCommand("command.getData", () => this.commandManager.getData());
         this.registerCommand("get", (e, name) => this.getValue(name));
         this.registerCommand("set", (e, name, value) => this.setValue(name, value));
     }
@@ -66,6 +66,9 @@ export class App extends CustomEventEmitter {
     registerCommand(name, func, options) {
         this.commandManager.register(name, func, options);
     }
+    registerCommandAlias(name, targetName, options) {
+        this.commandManager.registerAlias(name, targetName, options);
+    }
     unregisterCommand(name) {
         this.commandManager.unregister(name);
     }

package/dist/command/manager.d.ts

@@ -7,16 +7,20 @@ export declare class CommandManager {
     constructor(app: App);
     /** 注册命令 */
     register(name: string, call: CommandFunction<any>, options?: CommandOptions): void;
+    /** 注册命令别名 */
+    registerAlias(name: string, targetName: string, options?: CommandOptions): void;
     /** 注销命令 */
     unregister(name: string): void;
     /** 调用命令 */
     call(name: string, ...args: any[]): any;
     /** 调用命令(可配置) */
     callWithOptions(name: string, options: CommandCallOptions, ...args: any[]): any;
+    /** 从命令别名调用命令 */
+    private _callAliasWithOptions;
     /** 检测命令是否存在 */
     has(name: string): boolean;
     /** 获取数据 */
-    toSnapshot(): {
+    getData(): {
         name: string;
         pluginName: string | undefined;
     }[];

package/dist/command/manager.js

@@ -1,4 +1,9 @@
 import { appError } from "../error/index.js";
+// 错误列表
+// command:notFound 命令不存在
+// command:alreadyExists 命令已存在
+// command:aliasNotFound 命令别名指向的命令不存在
+// command:aliasTargetUncallable 命令别名不可指向其他命令别名
 export class CommandManager {
     /** 功能列表 */
     list = new Map();
@@ -12,6 +17,12 @@ export class CommandManager {
         this.list.set(name, { call, pluginName });
         this.app.emit("command:register", { name });
     }
+    /** 注册命令别名 */
+    registerAlias(name, targetName, options) {
+        const { pluginName } = options || {};
+        this.list.set(name, { targetName, pluginName });
+        this.app.emit("command:register", { name });
+    }
     /** 注销命令 */
     unregister(name) {
         this.list.delete(name);
@@ -25,13 +36,42 @@ export class CommandManager {
     callWithOptions(name, options, ...args) {
         const command = this.list.get(name);
         if (!command) {
-            throw appError("command:call_unexist", {
-                message: `命令不存在: ${name}`,
+            throw appError("command:notFound", {
+                message: `命令不存在[${name}]`,
                 target: `command/${name}`,
+                action: "command.call",
+            });
+        }
+        else {
+            const { call } = command;
+            if (!call) {
+                return this._callAliasWithOptions(name, command.targetName, options, ...args);
+            }
+            else {
+                return call({ source: options.source, client: options.client }, ...args);
+            }
+        }
+    }
+    /** 从命令别名调用命令 */
+    _callAliasWithOptions(name, targetName, options, ...args) {
+        const tcommand = this.list.get(targetName);
+        if (!tcommand) {
+            throw appError("command:aliasNotFound", {
+                message: `命令别名[${name}]指向的命令不存在[${targetName}]`,
+                target: `command/${name}>${targetName}`,
+                action: "command.call",
             });
         }
         else {
-            return command.call({ source: options.source, client: options.client }, ...args);
+            const { call } = tcommand;
+            if (!call) {
+                throw appError("command:aliasTargetUncallable", {
+                    message: `命令别名[${name}]不可指向其他命令别名[${targetName}]`,
+                    target: `command/${name}>${targetName}>${tcommand.targetName}`,
+                    action: "command.call",
+                });
+            }
+            return call({ source: options.source, client: options.client }, ...args);
         }
     }
     /** 检测命令是否存在 */
@@ -39,7 +79,7 @@ export class CommandManager {
         return this.list.has(name);
     }
     /** 获取数据 */
-    toSnapshot() {
+    getData() {
         return [...this.list].map(([name, { pluginName }]) => ({
             name,
             pluginName,

package/dist/command/types.d.ts

@@ -19,27 +19,36 @@ export interface CommandItem {
     call: CommandFunction<any>;
     pluginName?: string;
 }
+export interface CommandAliasItem {
+    call?: undefined;
+    targetName: string;
+    pluginName?: string;
+}
+/** 命令函数类型表 */
 export interface AppCommandMap {
     get: <T extends keyof AppValueMap>(name: T) => AppValueMap[T];
     set: <T extends keyof AppValueMap>(name: T, value: AppValueMap[T]) => boolean;
-    /** 获取注册值快照 */
-    "value.snapshot": () => {
+    /** 获取注册值数据 */
+    "value.getData": () => {
         name: string;
         value: any;
     }[];
-    /** 获取命令快照 */
-    "command.snapshot": () => {
+    /** 获取命令数据 */
+    "command.getData": () => {
         name: string;
     }[];
-    /** 获取插件快照 */
-    "plugin.snapshot": () => {
+    /** 获取插件数据 */
+    "plugin.getData": () => {
         pluginName: string;
     }[];
-    /** 获取hook快照 */
-    "hook.snapshot": () => {
+    /** 获取hook数据 */
+    "hook.getData": () => {
         name: string;
         list: {
             pluginName?: string;
         }[];
     }[];
 }
+/** 命令别名映射 */
+export interface AppCommandAliasMap {
+}

package/dist/error/index.d.ts

@@ -2,12 +2,14 @@ export * from "./types.js";
 export interface AppError extends Error {
     /** 错误发生信息 */
     cause: {
-        /** 错误id */
-        id: string;
+        /** 错误代码 */
+        code: string;
         /** 错误目标对象 */
         target?: string;
         /** 错误原因 */
         reason?: string | Error | AppError;
+        /** 调用行为 */
+        action?: string;
     };
 }
 export interface AppErrorOptions {
@@ -17,8 +19,10 @@ export interface AppErrorOptions {
     target?: string;
     /** 错误原因 */
     reason?: string | Error | AppError;
+    /** 调用行为 */
+    action?: string;
     /** 错误构造函数 */
     errorConstructor?: ErrorConstructor;
     [key: string]: unknown;
 }
-export declare function appError(id: string, { message, target, reason, errorConstructor }: AppErrorOptions): Error;
+export declare function appError(code: string, { message, target, reason, action, errorConstructor, }: AppErrorOptions): AppError;

package/dist/error/index.js

@@ -1,10 +1,14 @@
 export * from "./types.js";
-export function appError(id, { message, target, reason, errorConstructor = Error }) {
+export function appError(code, { message, target, reason, action, errorConstructor = Error, }) {
     return new errorConstructor(message, {
         cause: {
-            id,
+            code,
             target,
             reason,
+            action,
         },
     });
 }
+// 错误码分类
+// http:xxx http状态码
+// node:xxx nodejs错误码

package/dist/hook/manager.d.ts

@@ -13,7 +13,7 @@ export declare class HookManager {
     call(name: string, ctx: any): Promise<any>;
     /** 同步调用钩子函数 */
     callSync(name: string, ctx: any): any;
-    toSnapshot(): {
+    getData(): {
         name: string;
         list: {
             pluginName?: string;

package/dist/hook/manager.js

@@ -1,11 +1,14 @@
 import { appError } from "../error/index.js";
+// 错误列表
+// hook:functionAlreadyExists 钩子函数已存在
+// hook:functionNotFound 钩子函数不存在
 export class HookManager {
     list = new Map();
     pluginMap = new Map();
     app;
     constructor(app) {
         this.app = app;
-        app.registerCommand("hook.snapshot", () => this.toSnapshot());
+        app.registerCommand("hook.getData", () => this.getData());
     }
     /** 挂载钩子函数 */
     use(name, call, options) {
@@ -16,10 +19,10 @@ export class HookManager {
             this.list.set(name, hooks);
         }
         else if (hooks.includes(call)) {
-            throw appError("hook:use_duplicate", {
-                message: `钩子函数挂载失败: ${name}`,
-                reason: "重复挂载同一函数",
+            throw appError("hook:functionAlreadyExists", {
+                message: `无法重复挂载同一钩子函数: ${name}`,
                 target: `hook/${name}`,
+                action: "hook.use",
             });
         }
         hooks.push({ call, pluginName });
@@ -29,10 +32,10 @@ export class HookManager {
         let hooks = this.list.get(name);
         const index = hooks?.findIndex((item) => item.call == call) ?? -1;
         if (!hooks || index < 0)
-            throw appError("hook:unuse_unexist", {
-                message: `钩子函数卸载失败: ${name}`,
-                reason: "卸载不存在的钩子函数",
+            throw appError("hook:functionNotFound", {
+                message: `无法卸载不存在的钩子函数: ${name}`,
                 target: `hook/${name}`,
+                action: "hook.unuse",
             });
         hooks.splice(index, 1);
     }
@@ -64,7 +67,7 @@ export class HookManager {
         }
         return ctx;
     }
-    toSnapshot() {
+    getData() {
         return [...this.list].map(([name, fnList]) => ({
             name,
             list: fnList.map(({ pluginName }) => ({ pluginName })),

package/dist/live/message.d.ts

@@ -1,5 +1,7 @@
 import { DanmakuMode, UserInfo, ImageInfo, GiftInfo, UserType } from "./messageInfo.js";
 import { LiveRoomStatus, LiveRoomStatsInfo, LiveRoomDetailInfo } from "./room.js";
+export interface LiveMessageExtensions {
+}
 export declare namespace LiveMessage {
     interface Base {
         /** 平台名称 */
@@ -12,10 +14,17 @@ export declare namespace LiveMessage {
         type: string;
         /** 时间戳 */
         timestamp: number;
-        /** 消息id */
+        /** 消息id
+         *
+         * 须保证不重复性，规范id格式如下：
+         *
+         * 用户相关消息：platform:roomId-type:userId-uniqueId
+         *
+         * 房间相关消息：platform:roomId-type-uniqueId
+         *  */
         id: string;
-        /** 其他属性 */
-        [attr: string]: any;
+        /** 拓展属性 */
+        extension?: LiveMessageExtensions;
     }
     /** 聊天消息 */
     interface Comment extends Base {
@@ -81,8 +90,8 @@ export declare namespace LiveMessage {
     interface Superchat extends Base {
         type: "superchat";
         info: {
-            /** 留言id */
-            id: string | number;
+            /** 留言代码，用于撤回消息 */
+            token: string | number;
             /** 用户信息 */
             user: UserInfo;
             /** 文本内容 */
@@ -129,6 +138,7 @@ export declare namespace LiveMessage {
         info: {
             /** 切断消息 */
             message: string;
+            status: LiveRoomStatus;
         };
     }
     /** 直播数据更新 */
@@ -141,57 +151,5 @@ export declare namespace LiveMessage {
         type: "live_detail";
         info: LiveRoomDetailInfo;
     }
-    /** 主播抽奖 */
-    interface Lottery extends Base {
-        type: "lottery";
-        info: {
-            title: string;
-            role: "user" | "anchor";
-            user?: UserInfo;
-            gift?: GiftInfo;
-            id: string | number;
-            award?: GiftInfo | GiftInfo[];
-            value?: number;
-            valueType?: string | number;
-            price?: number;
-            currency?: string;
-        };
-    }
-    /** 主播抽奖结果 */
-    interface LotteryResult extends Base {
-        type: "lottery_result";
-        info: {
-            title: string;
-            role: "user" | "anchor";
-            id: string | number;
-            result: {
-                user: UserInfo;
-                award: GiftInfo | GiftInfo[];
-            }[];
-        };
-    }
-    /** 发送红包 */
-    interface Redpacket extends Base {
-        type: "redpacket";
-        info: {
-            id: string | number;
-            gifts?: GiftInfo[];
-            value?: number;
-            currency?: string | number;
-        };
-    }
-    /** 红包抽奖结果 */
-    interface RedpacketResult extends Base {
-        type: "redpacket_result";
-        info: {
-            id: string | number;
-            result: {
-                user: UserInfo;
-                gift?: GiftInfo;
-                value?: number;
-                currency?: string | number;
-            }[];
-        };
-    }
-    type All = Comment | Gift | Interact | Membership | Superchat | Block | LiveStart | LiveEnd | LiveCut | LiveDetail | LiveStats | Lottery | LotteryResult;
+    type All = Comment | Gift | Interact | Membership | Superchat | Block | LiveStart | LiveEnd | LiveCut | LiveDetail | LiveStats;
 }

package/dist/live/messageInfo.d.ts

@@ -13,8 +13,8 @@ export interface UserInfo {
     type?: UserType;
     /** 粉丝vip等级 */
     membership?: boolean | number;
-    /** vip等级 */
-    vip?: boolean | number;
+    /** 平台vip等级 */
+    premium?: boolean | number;
     /** 用户等级 */
     level?: number;
 }
@@ -50,10 +50,12 @@ export interface GiftInfo {
     num: number;
     /** 礼物价值(总价，按平台货币计算) */
     value?: number;
-    /** 价值类型 */
-    valueType?: string | number;
+    /** 显示的礼物价值 */
+    displayValue?: number;
+    /** 平台货币类型 */
+    coinType?: string | number;
     /** 平台货币名称 */
-    valueName?: string;
+    coinName?: string;
     /** 礼物连击数 */
     combo?: number;
     /** 礼物连击id */

package/dist/live/platform.d.ts

@@ -2,7 +2,7 @@ export interface LivePlatformInfo {
     /** 平台名称 */
     name: string;
     /** 平台vip信息 */
-    vip?: {
+    premium?: {
         /** 平台vip对应id */
         id: string;
         /** 平台vip名称 */

package/dist/live/room.d.ts

@@ -6,11 +6,12 @@ import { UserInfo } from "./messageInfo.js";
 export declare abstract class LiveRoom extends CustomEventEmitter implements LiveRoomData {
     constructor();
     get valid(): true;
-    get serviceId(): string;
+    get pending(): false;
+    get service(): string;
     /** 平台 */
     abstract readonly platform: string;
-    /** api服务 */
-    readonly service: string;
+    /** 服务分支 */
+    readonly serviceBranch: string;
     /** 房间id */
     abstract readonly id: string | number;
     /** 房间详情 */
@@ -60,11 +61,15 @@ export declare abstract class LiveRoom extends CustomEventEmitter implements Liv
 /** 无效房间 */
 export declare class InvalidLiveRoom implements LiveRoomData {
     get valid(): false;
-    get serviceId(): string;
-    constructor(serviceId: string, id: string | number);
+    get service(): string;
+    constructor(service: string, id: string | number, { pending, error }?: {
+        pending?: boolean | undefined;
+        error?: null | undefined;
+    });
     readonly platform: string;
     readonly id: string | number;
-    readonly service: string;
+    readonly serviceBranch: string;
+    pending: boolean;
     detail: LiveRoomDetailInfo;
     stats?: LiveRoomStatsInfo;
     anchor: UserInfo;
@@ -73,6 +78,10 @@ export declare class InvalidLiveRoom implements LiveRoomData {
     connectionStatus: LiveConnectionStatus;
     openStatus: LiveRoomOpenStatus;
     liveId?: string;
+    error: {
+        code: string;
+        message: string;
+    } | null;
     get opened(): boolean;
     available: boolean;
     /** 生成房间数据 */
@@ -90,14 +99,16 @@ export interface LiveRoom {
 export interface LiveRoomData {
     /** 房间有效性 */
     valid: boolean;
+    /** 房间待定状态 */
+    pending?: boolean;
     /** 平台id */
     platform: string;
-    /** API服务 */
-    service: string;
+    /** 服务分支 */
+    serviceBranch: string;
     /** 房间id */
     id: number | string;
     /** API服务id */
-    serviceId: string;
+    service: string;
     /** 房间key */
     key: string;
     /** 基本信息 */
@@ -120,6 +131,11 @@ export interface LiveRoomData {
     opened: boolean;
     /** 房间是否可用 */
     available: boolean;
+    /** 错误信息 */
+    error?: {
+        code: string;
+        message: string;
+    } | null;
 }
 /** 房间展示信息 */
 export interface LiveRoomDetailInfo {
@@ -179,6 +195,8 @@ export declare const LiveRoomOpenStatus: {
     readonly opened: 2;
 };
 export type LiveRoomOpenStatus = EnumValue<typeof LiveRoomOpenStatus>;
+export declare const LiveRoomValidStatus: {};
+export type LiveRoomValidStatus = EnumValue<typeof LiveRoomValidStatus>;
 export interface LiveRoomEventMap {
     /**  */
     status: {