smueller/youtube-music
1
0
Fork 0
mirror of https://github.com/th-ch/youtube-music.git synced 2026-01-11 18:41:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

WIP

Browse Source 
Co-authored-by: Su-Yong <simssy2205@gmail.com>
This commit is contained in:
JellyBrick
2023-11-27 00:18:34 +09:00
parent 3a1b77ebd8
commit 563d431c00
17 changed files with 563 additions and 679 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/types/contexts.ts
View File

@ -1,12 +1,12 @@
import type { BrowserWindow } from 'electron';
import type { PluginConfig } from '@/types/plugins';
export interface BaseContext {
getConfig(): PluginConfig;
setConfig(conf: Omit<PluginConfig, 'enabled'>): void;
export interface BaseContext<Config extends PluginConfig> {
getConfig(): Promise<Config>;
setConfig(conf: Partial<Omit<Config, 'enabled'>>): void;
}
export interface BackendContext extends BaseContext {
export interface BackendContext<Config extends PluginConfig> extends BaseContext<Config> {
ipc: {
send: (event: string, ...args: unknown[]) => void;
handle: (event: string, listener: CallableFunction) => void;
@ -16,14 +16,14 @@ export interface BackendContext extends BaseContext {
window: BrowserWindow;
}
export interface MenuContext extends BaseContext {
export interface MenuContext<Config extends PluginConfig> extends BaseContext<Config> {
window: BrowserWindow;
refresh: () => Promise<void> | void;
}
export interface PreloadContext extends BaseContext {}
export interface PreloadContext<Config extends PluginConfig> extends BaseContext<Config> {}
export interface RendererContext extends BaseContext {
export interface RendererContext<Config extends PluginConfig> extends BaseContext<Config> {
ipc: {
send: (event: string, ...args: unknown[]) => void;
invoke: (event: string, ...args: unknown[]) => Promise<unknown>;

43
src/types/plugins.ts
View File

@ -11,31 +11,40 @@ type Author = string;
export type PluginConfig = {
enabled: boolean;
} & Record<string, unknown>;
};
type PluginExtra = Record<string, unknown>;
export type PluginLifecycleSimple<Context, This> = (this: This, ctx: Context) => void | Promise<void>;
export type PluginLifecycleExtra<Config, Context, This> = This & {
start?: PluginLifecycleSimple<Context, This>;
stop?: PluginLifecycleSimple<Context, This>;
onConfigChange?: (this: This, newConfig: Config) => void | Promise<void>;
onPlayerApiReady?: (this: This, playerApi: YoutubePlayer) => void | Promise<void>;
};
export type PluginLifecycleSimple<T> = (ctx: T) => void | Promise<void>;
export type PluginLifecycleExtra<T> = {
start?: PluginLifecycleSimple<T>;
stop?: PluginLifecycleSimple<T>;
onConfigChange?: (newConfig: PluginConfig) => void | Promise<void>;
onPlayerApiReady?: (playerApi: YoutubePlayer) => void | Promise<void>;
} & PluginExtra;
export type PluginLifecycle<Config, Context, This> = PluginLifecycleSimple<Context, This> | PluginLifecycleExtra<Config, Context, This>;
export type PluginLifecycle<T> = PluginLifecycleSimple<T> | PluginLifecycleExtra<T>;
export interface PluginDef {
export interface PluginDef<
BackendProperties,
PreloadProperties,
RendererProperties,
Config extends PluginConfig = PluginConfig,
> {
name: string;
authors?: Author[];
description?: string;
config: PluginConfig;
config?: Config;
menu?: (ctx: MenuContext) => Electron.MenuItemConstructorOptions[];
menu?: (ctx: MenuContext<Config>) => Promise<Electron.MenuItemConstructorOptions[]>;
stylesheets?: string[];
restartNeeded?: boolean;
backend?: PluginLifecycle<BackendContext>;
preload?: PluginLifecycle<PreloadContext>;
renderer?: PluginLifecycle<RendererContext>;
backend?: {
[Key in keyof BackendProperties]: BackendProperties[Key]
} & PluginLifecycle<Config, BackendContext<Config>, BackendProperties>;
preload?: {
[Key in keyof PreloadProperties]: PreloadProperties[Key]
} & PluginLifecycle<Config, PreloadContext<Config>, PreloadProperties>;
renderer?: {
[Key in keyof RendererProperties]: RendererProperties[Key]
} & PluginLifecycle<Config, RendererContext<Config>, RendererProperties>;
}