|
|
@@ -1,17 +1,21 @@
|
|
|
import * as UserUtils from "@sv443-network/userutils";
|
|
|
import { mode, branch, host, buildNumber, compressionFormat, scriptInfo } from "./constants";
|
|
|
-import { getResourceUrl, getSessionId, getVideoTime, log, setLocale, getLocale, hasKey, hasKeyFor, NanoEmitter, t, tp, type TrLocale } from "./utils";
|
|
|
+import { getResourceUrl, getSessionId, getVideoTime, log, setLocale, getLocale, hasKey, hasKeyFor, NanoEmitter, t, tp, type TrLocale, info, error } from "./utils";
|
|
|
import { addSelectorListener } from "./observers";
|
|
|
import { getFeatures, saveFeatures } from "./config";
|
|
|
import { featInfo, fetchLyricsUrlTop, getLyricsCacheEntry, sanitizeArtists, sanitizeSong, type LyricsCache } from "./features";
|
|
|
import type { SiteEventsMap } from "./siteEvents";
|
|
|
-import type { FeatureConfig, FeatureInfo, LyricsCacheEntry } from "./types";
|
|
|
+import { LogLevel, type FeatureConfig, type FeatureInfo, type LyricsCacheEntry, type PluginDef, type PluginInfo, type PluginRegisterResult, type PluginDefResolvable } from "./types";
|
|
|
import { BytmDialog, createHotkeyInput, createToggleInput } from "./components";
|
|
|
|
|
|
const { getUnsafeWindow } = UserUtils;
|
|
|
|
|
|
/** All events that can be emitted on the BYTM interface and the data they provide */
|
|
|
export type InterfaceEvents = {
|
|
|
+ /** Emitted whenever the plugins should be registered using `unsafeWindow.BYTM.registerPlugin()` */
|
|
|
+ "bytm:initPlugins": undefined;
|
|
|
+ /** Emitted whenever all plugins have been loaded */
|
|
|
+ "bytm:pluginsLoaded": undefined;
|
|
|
/** Emitted when BYTM has finished initializing all features */
|
|
|
"bytm:ready": undefined;
|
|
|
/**
|
|
|
@@ -44,6 +48,11 @@ export type InterfaceEvents = {
|
|
|
};
|
|
|
|
|
|
const globalFuncs = {
|
|
|
+ // meta
|
|
|
+ registerPlugin,
|
|
|
+ getPluginInfo,
|
|
|
+
|
|
|
+ // utils
|
|
|
addSelectorListener,
|
|
|
getResourceUrl,
|
|
|
getSessionId,
|
|
|
@@ -62,6 +71,8 @@ const globalFuncs = {
|
|
|
sanitizeSong,
|
|
|
};
|
|
|
|
|
|
+const plugins = new Map<string, PluginDef>();
|
|
|
+
|
|
|
/** Initializes the BYTM interface */
|
|
|
export function initInterface() {
|
|
|
const props = {
|
|
|
@@ -113,6 +124,74 @@ export function emitInterface<
|
|
|
getUnsafeWindow().dispatchEvent(new CustomEvent(type, { detail: data[0] }));
|
|
|
}
|
|
|
|
|
|
+//#MARKER register plugins
|
|
|
+
|
|
|
+export function loadPlugins() {
|
|
|
+ // TODO:
|
|
|
+ // load plugins between bytm:initPlugins and bytm:ready
|
|
|
+ // emit bytm:pluginsLoaded after all plugins loaded
|
|
|
+}
|
|
|
+
|
|
|
+/** Returns the key for a given plugin definition */
|
|
|
+function getPluginKey(plugin: PluginDef | PluginDefResolvable) {
|
|
|
+ return `${plugin.plugin.namespace}/${plugin.plugin.name}`;
|
|
|
+}
|
|
|
+
|
|
|
+/** Converts a PluginDef object (full definition) into a PluginInfo object (restricted definition) */
|
|
|
+function pluginDefToInfo(plugin?: PluginDef): PluginInfo | undefined {
|
|
|
+ return plugin && {
|
|
|
+ name: plugin.plugin.name,
|
|
|
+ namespace: plugin.plugin.namespace,
|
|
|
+ version: plugin.plugin.version,
|
|
|
+ };
|
|
|
+}
|
|
|
+
|
|
|
+/** Returns info about a registered plugin on the BYTM interface by its name and namespace properties, or undefined if the plugin isn't registered */
|
|
|
+export function getPluginInfo(name: string, namespace: string): PluginInfo | undefined
|
|
|
+/** Returns info about a registered plugin on the BYTM interface, or undefined if the plugin isn't registered */
|
|
|
+export function getPluginInfo(plugin: PluginDefResolvable): PluginInfo | undefined
|
|
|
+/** Returns info about a registered plugin on the BYTM interface, or undefined if the plugin isn't registered */
|
|
|
+export function getPluginInfo(...args: [pluginDefOrName: PluginDefResolvable | string, namespace?: string]): PluginInfo | undefined {
|
|
|
+ return args.length === 2
|
|
|
+ ? pluginDefToInfo(plugins.get(`${args[1]}/${args[0]}`))
|
|
|
+ : pluginDefToInfo(plugins.get(getPluginKey(args[0] as PluginDefResolvable)));
|
|
|
+}
|
|
|
+
|
|
|
+/** Validates the passed PluginDef object and returns an array of errors */
|
|
|
+function validatePluginDef(pluginDef: Partial<PluginDef>) {
|
|
|
+ const errors = [] as string[];
|
|
|
+
|
|
|
+ const addNoPropErr = (prop: string, type: string) =>
|
|
|
+ errors.push(t("plugin_validation_error_no_property", prop, type));
|
|
|
+
|
|
|
+ // def.plugin and its properties:
|
|
|
+ typeof pluginDef.plugin !== "object" && addNoPropErr("plugin", "object");
|
|
|
+ const { plugin } = pluginDef;
|
|
|
+ !plugin?.name && addNoPropErr("plugin.name", "string");
|
|
|
+ !plugin?.namespace && addNoPropErr("plugin.namespace", "string");
|
|
|
+ !plugin?.version && addNoPropErr("plugin.version", "[major: number, minor: number, patch: number]");
|
|
|
+
|
|
|
+ return errors.length > 0 ? errors : undefined;
|
|
|
+}
|
|
|
+
|
|
|
+/** Registers a plugin on the BYTM interface */
|
|
|
+export function registerPlugin(pluginDef: PluginDef): PluginRegisterResult {
|
|
|
+ const validationErrors = validatePluginDef(pluginDef);
|
|
|
+ if(validationErrors) {
|
|
|
+ error(`Failed to register plugin${pluginDef?.plugin?.name ? ` '${pluginDef?.plugin?.name}'` : ""} with invalid definition:\n- ${validationErrors.join("\n- ")}`, LogLevel.Info);
|
|
|
+ throw new Error(`Invalid plugin definition:\n- ${validationErrors.join("\n- ")}`);
|
|
|
+ }
|
|
|
+
|
|
|
+ const { plugin: { name } } = pluginDef;
|
|
|
+ plugins.set(getPluginKey(pluginDef), pluginDef);
|
|
|
+
|
|
|
+ info(`Registered plugin: ${name}`, LogLevel.Info);
|
|
|
+
|
|
|
+ return {
|
|
|
+ info: getPluginInfo(pluginDef)!,
|
|
|
+ };
|
|
|
+}
|
|
|
+
|
|
|
//#MARKER proxy functions
|
|
|
|
|
|
/** Returns the current feature config, with sensitive values replaced by `undefined` */
|
Sv443