floating-live 0.17.0-alpha.9 → 0.17.0-beta.0

package/dist/live/room.d.ts

@@ -6,11 +6,11 @@ import { UserInfo } from "./messageInfo.js";
 export declare abstract class LiveRoom extends CustomEventEmitter implements LiveRoomData {
     constructor();
     get valid(): true;
-    get serviceId(): string;
+    get pending(): false;
     /** 平台 */
     abstract readonly platform: string;
-    /** api服务 */
-    readonly service: string;
+    /** 服务id */
+    abstract readonly service: string;
     /** 房间id */
     abstract readonly id: string | number;
     /** 房间详情 */
@@ -60,11 +60,14 @@ 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);
+    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 id: string | number;
+    pending: boolean;
     detail: LiveRoomDetailInfo;
     stats?: LiveRoomStatsInfo;
     anchor: UserInfo;
@@ -73,6 +76,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 +97,14 @@ export interface LiveRoom {
 export interface LiveRoomData {
     /** 房间有效性 */
     valid: boolean;
+    /** 房间待定状态 */
+    pending?: boolean;
     /** 平台id */
     platform: string;
-    /** API服务 */
+    /** 服务id */
     service: string;
     /** 房间id */
     id: number | string;
-    /** API服务id */
-    serviceId: string;
     /** 房间key */
     key: string;
     /** 基本信息 */
@@ -120,6 +127,11 @@ export interface LiveRoomData {
     opened: boolean;
     /** 房间是否可用 */
     available: boolean;
+    /** 错误信息 */
+    error?: {
+        code: string;
+        message: string;
+    } | null;
 }
 /** 房间展示信息 */
 export interface LiveRoomDetailInfo {
@@ -140,6 +152,10 @@ export interface LiveRoomStatsInfo {
     online?: number;
     /** 人气值 */
     popularity?: number;
+    /** 粉丝数 */
+    fans?: number;
+    /** 粉丝团人数 */
+    clubFans?: number;
 }
 /** 直播间状态 */
 export declare const LiveRoomStatus: {
@@ -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: {

package/dist/live/room.js

@@ -7,11 +7,9 @@ export class LiveRoom extends CustomEventEmitter {
     get valid() {
         return true;
     }
-    get serviceId() {
-        return this.service ? `${this.platform}.${this.service}` : this.platform;
+    get pending() {
+        return false;
     }
-    /** api服务 */
-    service = "";
     /** 统计信息 */
     stats;
     /** 直播状态 */
@@ -48,24 +46,24 @@ export class LiveRoom extends CustomEventEmitter {
                 this.emit("status", {
                     status: LiveRoomStatus.live,
                     timestamp: msg.timestamp,
-                    liveId: msg.info.id,
+                    liveId: msg.data.id,
                 });
                 break;
             case "live_detail":
-                this.detail = Object.assign(this.detail, msg.info);
-                this.emit("detail", { detail: msg.info });
+                this.detail = Object.assign(this.detail, msg.data);
+                this.emit("detail", { detail: msg.data });
                 break;
             case "live_stats":
-                this.stats = Object.assign(this.stats, msg.info);
-                this.emit("stats", { stats: msg.info });
+                this.stats = Object.assign(this.stats, msg.data);
+                this.emit("stats", { stats: msg.data });
                 break;
             case "live_end":
             case "live_cut":
-                this.status = msg.status || LiveRoomStatus.off;
+                this.status = msg.data.status || LiveRoomStatus.off;
                 this.timestamp = msg.timestamp;
                 this.emit("message", { message: msg });
                 this.emit("status", {
-                    status: msg.status || LiveRoomStatus.off,
+                    status: msg.data.status || LiveRoomStatus.off,
                     timestamp: msg.timestamp,
                     liveId: this.liveId,
                 });
@@ -81,8 +79,8 @@ export class LiveRoom extends CustomEventEmitter {
     toData() {
         return {
             valid: this.valid,
+            pending: this.pending,
             platform: this.platform,
-            service: this.service,
             id: this.id,
             detail: this.detail,
             stats: this.stats,
@@ -95,11 +93,11 @@ export class LiveRoom extends CustomEventEmitter {
             available: this.available,
             connectionStatus: this.connectionStatus,
             key: this.key,
-            serviceId: this.serviceId,
+            service: this.service,
         };
     }
     get key() {
-        return `${this.serviceId}:${this.id}`;
+        return `${this.service}:${this.id}`;
     }
 }
 /** 无效房间 */
@@ -107,18 +105,18 @@ 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(".");
+    constructor(service, id, { pending = false, error = null } = {}) {
+        const [platform] = service.split(".");
         this.platform = platform;
         this.id = id;
-        this.service = serviceIdArr.join(".");
+        this.service = service;
+        this.pending = pending;
+        this.error = error;
     }
     platform;
-    id;
     service;
+    id;
+    pending;
     detail = {};
     stats;
     anchor = { name: "", id: 0 };
@@ -127,6 +125,7 @@ export class InvalidLiveRoom {
     connectionStatus = LiveConnectionStatus.off;
     openStatus = 0;
     liveId;
+    error;
     get opened() {
         return this.openStatus == 2;
     }
@@ -135,6 +134,7 @@ export class InvalidLiveRoom {
     toData() {
         return {
             valid: this.valid,
+            pending: this.pending,
             platform: this.platform,
             service: this.service,
             id: this.id,
@@ -148,12 +148,11 @@ export class InvalidLiveRoom {
             opened: this.opened,
             available: this.available,
             connectionStatus: this.connectionStatus,
-            serviceId: this.serviceId,
             key: this.key,
         };
     }
     get key() {
-        return `${this.serviceId}:${this.id}`;
+        return `${this.service}:${this.id}`;
     }
 }
 /** 直播间状态 */
@@ -191,3 +190,4 @@ export const LiveRoomOpenStatus = {
     /** 已开启 */
     opened: 2,
 };
+export const LiveRoomValidStatus = {};

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

@@ -1,5 +1,5 @@
 import { App } from "../../app.js";
-import type { CommandOptions, CommandCallOptions, CommandFunction, AppCommandMap } from "../../command/index.js";
+import type { CommandOptions, CommandCallOptions, CommandFunction, AppCommandMap, AppCommandAliasMap } from "../../command/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";
@@ -23,6 +23,7 @@ export declare class CommonPluginContext implements PluginContext {
     registerValue<K extends keyof AppValueMap>(name: K, options: ValueOptions<AppValueMap[K]>): ValueContext<AppValueMap[K]>;
     unregisterValue(name: string): void;
     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;
     on<K extends keyof AppEventDetailMap>(type: K, listener: AppEventListener<AppEventDetailMap[K]>): void;

package/dist/plugin/context/CommonPluginContext.js

@@ -78,6 +78,10 @@ export class CommonPluginContext {
         this.#app.registerCommand(name, func, options);
         this.#registered.commands.add(name);
     }
+    registerCommandAlias(name, targetName, options) {
+        this.#app.registerCommandAlias(name, targetName, options);
+        this.#registered.commands.add(name);
+    }
     unregisterCommand(name) {
         this.#app.unregisterCommand(name);
         this.#registered.commands.delete(name);

package/dist/plugin/context/SafePluginContext.js

@@ -1,5 +1,7 @@
 import { appError } from "../../error/index.js";
 import { CommonPluginContext } from "./CommonPluginContext.js";
+// 错误列表
+// plugin:noPermission 插件权限不足 
 export class SafePluginContext extends CommonPluginContext {
     get safe() {
         return true;
@@ -10,7 +12,7 @@ export class SafePluginContext extends CommonPluginContext {
         this.#permissions = options.permissions;
     }
     throwNotPermitted(permission, reason) {
-        throw appError("plugin:no_permission", {
+        throw appError("plugin:noPermission", {
             message: "插件权限不足",
             reason,
             permission,

package/dist/plugin/manager.d.ts

@@ -22,7 +22,7 @@ export declare class PluginManager {
     whenRegister(pluginName: string, callback: WhenRegisterCallback): void;
     /** 取消插件已注册时的执行回调 */
     cancelWhenRegister(pluginName: string, callback: WhenRegisterCallback): void;
-    toSnapshot(): {
+    getData(): {
         pluginName: string;
     }[];
 }

package/dist/plugin/manager.js

@@ -1,6 +1,13 @@
 import { CommonPluginContext } from "./context/CommonPluginContext.js";
 import { bindCommand } from "../utils/index.js";
 import { appError } from "../error/index.js";
+// 错误列表
+// plugin:missingName 插件pluginName字段缺失
+// plugin:duplicateName 已存在相同名称的插件
+// plugin:unremovable 插件不可移除
+// plugin:registerFailed 插件注册失败
+// plugin:notFound 插件不存在
+// app:hookPrevented 被钩子函数阻止
 export class PluginManager {
     /** 插件列表 */
     list = new Map();
@@ -8,23 +15,23 @@ export class PluginManager {
     app;
     constructor(app) {
         this.app = app;
-        app.registerCommand("plugin.snapshot", bindCommand(this.toSnapshot, this));
+        app.registerCommand("plugin.getData", bindCommand(this.getData, this));
     }
     registerSync(pluginConstructor, options = {}, { context, unremovable = false, accessApp = false, pluginType = "", } = {}) {
         const pluginName = pluginConstructor.pluginName;
         const role = pluginConstructor.role || "";
         if (!pluginName) {
-            throw appError("plugin:register_id_missing", {
-                message: "插件注册失败",
-                reason: "插件缺少pluginName字段",
+            throw appError("plugin:missingName", {
+                message: "插件注册失败: 插件缺少pluginName字段",
                 target: "plugin/#unnamed",
+                action: "plugin.registerSync",
             });
         }
         if (this.list.has(pluginName)) {
-            throw appError("plugin:register_id_duplicate", {
-                message: `插件注册失败: ${pluginName}`,
-                reason: "已存在相同id的插件",
+            throw appError("plugin:duplicateName", {
+                message: `插件注册失败[${pluginName}]: 已存在相同名称的插件`,
                 target: `plugin/${pluginName}`,
+                action: "plugin.registerSync",
             });
         }
         const registerCtx = { pluginName, options };
@@ -32,10 +39,10 @@ export class PluginManager {
         try {
             const ctx = this.app.callHookSync("plugin.register", registerCtx);
             if (ctx.defaultPrevented)
-                throw appError("plugin:register_hook_prevented", {
-                    message: `插件注册失败: ${pluginName}`,
-                    reason: "插件注册被钩子函数阻止",
+                throw appError("app:hookPrevented", {
+                    message: `插件注册失败${pluginName}: 插件注册被钩子函数阻止`,
                     target: `plugin/${pluginName}`,
+                    action: "plugin.registerSync",
                 });
             // 执行插件函数
             const plugin = new pluginConstructor(pluginCtx, registerCtx.options || {});
@@ -71,10 +78,11 @@ export class PluginManager {
             return plugin;
         }
         catch (err) {
-            throw appError("plugin:register_fail", {
+            throw appError("plugin:registerFailed", {
                 message: `插件注册失败: ${pluginName}`,
                 reason: err,
                 target: `plugin/${pluginName}`,
+                action: "plugin.registerSync",
             });
         }
     }
@@ -83,17 +91,17 @@ export class PluginManager {
         const pluginName = pluginConstructor.pluginName;
         const role = pluginConstructor.role || "";
         if (!pluginName) {
-            throw appError("plugin:register_id_missing", {
-                message: "插件注册失败",
-                reason: "插件缺少pluginName字段",
+            throw appError("plugin:missingName", {
+                message: "插件注册失败: 插件缺少pluginName字段",
                 target: "plugin/#unnamed",
+                action: "plugin.register",
             });
         }
         if (this.list.has(pluginName)) {
-            throw appError("plugin:register_id_duplicate", {
-                message: `插件注册失败: ${pluginName}`,
-                reason: "已存在相同id的插件",
+            throw appError("plugin:duplicateName", {
+                message: `插件注册失败[${pluginName}]: 已存在相同名称的插件`,
                 target: `plugin/${pluginName}`,
+                action: "plugin.register",
             });
         }
         const registerCtx = { pluginName, options };
@@ -102,10 +110,10 @@ export class PluginManager {
             .callHook("plugin.register", registerCtx)
             .then(async (ctx) => {
             if (ctx.defaultPrevented)
-                throw appError("plugin:register_hook_prevented", {
-                    message: `插件注册失败: ${pluginName}`,
-                    reason: "插件注册被钩子函数阻止",
+                throw appError("app:hookPrevented", {
+                    message: `插件注册失败${pluginName}: 插件注册被钩子函数阻止`,
                     target: `plugin/${pluginName}`,
+                    action: "plugin.register",
                 });
             // 执行插件函数
             const plugin = new pluginConstructor(pluginCtx, registerCtx.options || {});
@@ -140,10 +148,11 @@ export class PluginManager {
             return plugin;
         })
             .catch((err) => {
-            throw appError("plugin:register_fail", {
+            throw appError("plugin:registerFailed", {
                 message: `插件注册失败: ${pluginName}`,
                 reason: err,
                 target: `plugin/${pluginName}`,
+                action: "plugin.register",
             });
         });
     }
@@ -152,19 +161,19 @@ export class PluginManager {
         const pluginData = this.list.get(pluginName);
         // 检测插件是否存在
         if (!pluginData) {
-            throw appError("plugin:unregister_unexist", {
-                message: `插件移除失败: ${pluginName}`,
-                reason: "插件不存在",
+            throw appError("plugin:notFound", {
+                message: `插件移除失败[${pluginName}]: 插件不存在`,
                 target: `plugin/${pluginName}`,
+                action: "plugin.unregister",
             });
         }
         else {
-            const { plugin, context, unremovable } = pluginData;
+            const { plugin, context, unremovable, role } = pluginData;
             if (unremovable) {
-                throw appError("plugin:unregister_unremovable", {
-                    message: `插件移除失败: ${pluginName}`,
-                    reason: "不可移除的插件",
+                throw appError("plugin:unremovable", {
+                    message: `插件移除失败[${pluginName}]: 该插件已配置为不可移除`,
                     target: `plugin/${pluginName}`,
+                    action: "plugin.unregister",
                 });
             }
             // 调用插件和上下文的destroy钩子
@@ -173,7 +182,7 @@ export class PluginManager {
             // 从列表中移除插件
             this.list.delete(pluginName);
             // 移除插件注册事件
-            this.app.emit("plugin:unregister", { pluginName, role: pluginData.role });
+            this.app.emit("plugin:unregister", { pluginName, role });
             // 如果有whenRegister的回调，调用whenUnregistered函数并将回调函数从列表中移除
             const callbackMap = this.whenRegisterMap.get(pluginName);
             if (callbackMap) {
@@ -231,7 +240,7 @@ export class PluginManager {
             callbackMap.delete(callback);
         }
     }
-    toSnapshot() {
+    getData() {
         return [...this.list.keys()].map((n) => ({ pluginName: n }));
     }
 }

package/dist/plugin/types.d.ts

@@ -1,5 +1,5 @@
 import { App } from "../app.js";
-import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction } from "../command/index.js";
+import { CommandOptions, CommandCallOptions, AppCommandMap, CommandFunction, AppCommandAliasMap } from "../command/index.js";
 import { AppEventListener, AppEventEmitOptions, AppEventDetailMap } from "../event/index.js";
 import { AppHookMap, HookCallOptions, HookContext, HookFunction, HookUseOptions } from "../hook/index.js";
 import { AppValueMap, ValueContext, ValueOptions } from "../value/index.js";
@@ -88,9 +88,11 @@ export interface PluginContext {
     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]>;
@@ -124,7 +126,7 @@ export interface PluginContext {
 export interface AppPluginExposesMap {
     "": {};
 }
-export interface AppSnapshotMap {
+export interface AppExchangeDataMap {
     plugin: {
         pluginName: string;
     }[];

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

@@ -1,8 +1,9 @@
-import { BasePlugin, LivePlatformInfo } from "../../index.js";
+import { BasePlugin, LivePlatformInfo, PluginContext } from "../../index.js";
 interface PluginExposes {
     register(name: string, info: LivePlatformInfo, signal: AbortSignal): void;
     get(name: string): LivePlatformInfo | undefined;
-    toSnapshot(): {
+    info(name: string): LivePlatformInfo | undefined;
+    getData(): {
         name: string;
     }[];
 }
@@ -19,13 +20,17 @@ declare module "../../index.js" {
             name: string;
         };
     }
+    interface AppCommandAliasMap {
+        platform: "platform.info";
+    }
     interface AppCommandMap {
-        "platform.snapshot": () => {
+        "platform.info": (name: string) => LivePlatformInfo | undefined;
+        "platform.getData": () => {
             name: string;
             info: LivePlatformInfo;
         }[];
     }
-    interface AppSnapshotMap {
+    interface AppExchangeDataMap {
         platform: {
             name: string;
             info: LivePlatformInfo;
@@ -35,14 +40,17 @@ declare module "../../index.js" {
 export declare class Platform extends BasePlugin {
     static pluginName: string;
     private list;
+    init(ctx: PluginContext): void;
     /** 注册直播平台信息 */
     register(name: string, info: LivePlatformInfo, signal?: AbortSignal): void;
     /** 解除注册直播平台信息 */
     unregister(name: string): void;
-    /** 获取直播平台信息 */
+    /** 直接获取直播平台信息 */
     get(name: string): LivePlatformInfo | undefined;
+    /** 获取直播平台信息 */
+    info(name: string): LivePlatformInfo | undefined;
     expose(): PluginExposes;
-    toSnapshot(): {
+    getData(): {
         name: string;
         info: LivePlatformInfo;
     }[];

package/dist/plugins/platform/index.js

@@ -1,44 +1,59 @@
+import { bindCommand } from "../../utils/index.js";
 import { appError, BasePlugin } from "../../index.js";
 export class Platform extends BasePlugin {
     static pluginName = "platform";
     list = new Map();
+    init(ctx) {
+        ctx.registerCommand("platform.getData", this.getData.bind(this));
+        ctx.registerCommand("platform.info", bindCommand(this.info, this));
+        ctx.registerCommandAlias("platform", "platform.info");
+    }
     /** 注册直播平台信息 */
     register(name, info, signal) {
         if (this.list.has(name)) {
-            throw appError("platform:register_duplicated", {
-                message: "平台信息重复注册",
+            throw appError("platform:alreadyExists", {
+                message: "平台信息已存在",
+                target: `platform/${name}`,
+                action: "platform.register",
             });
         }
         this.list.set(name, info);
         if (signal) {
             signal.addEventListener("abort", () => {
                 this.unregister(name);
-            }, { once: true });
+            }, { once: true, signal: this.ctx.signal });
         }
     }
     /** 解除注册直播平台信息 */
     unregister(name) {
         if (!this.list.has(name)) {
-            throw appError("platform:unregister_unexisted", {
+            throw appError("platform:notFound", {
                 message: "无法解除不存在的平台信息注册",
+                target: `platform/${name}`,
+                action: "platform.unregister",
             });
         }
         this.list.delete(name);
     }
-    /** 获取直播平台信息 */
+    /** 直接获取直播平台信息 */
     get(name) {
         return this.list.get(name);
     }
+    /** 获取直播平台信息 */
+    info(name) {
+        return structuredClone(this.list.get(name));
+    }
     expose() {
         return {
             register: (name, info, signal) => {
                 this.register(name, info, signal);
             },
             get: (name) => this.get(name),
-            toSnapshot: () => this.toSnapshot(),
+            info: (name) => this.info(name),
+            getData: () => this.getData(),
         };
     }
-    toSnapshot() {
+    getData() {
         return [...this.list].map(([name, info]) => ({ name, info }));
     }
 }