@simeonradivoev/gameflow-sdk 1.4.0 → 1.5.1

package/README.md

@@ -0,0 +1,15 @@
+# Gameflow Deck SDK
+
+This is the type definitions for Gameflow Deck plugins.
+
+## Developing a plugin
+
+The plugin must have a default export class of type `PluginType`. It exposes the context and all the hooks to be tapped.
+Gameflow uses the [Tapable Hooks](https://github.com/webpack/tapable).
+
+The package must expose a main script gameflow will import and validate. It must implement the type fields on `PluginDescriptionType`.
+
+## Publishing
+
+For the plugin to show up in the UI for download. It must be published to NPM with the `gameflow-plugin` keyword. Gameflow uses bun to install plugins as packages from npmjs.
+Follow publishing instruction check the [NPM Docs](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry)

package/index.d.ts

@@ -2,7 +2,8 @@
 
 import Conf from 'conf';
 import EventEmitter from 'node:events';
-import { AsyncSeriesBailHook, AsyncSeriesHook, SyncBailHook } from 'tapable';
+import { EventEmitter } from 'node:events';
+import { AsyncSeriesBailHook, AsyncSeriesHook, AsyncSeriesWaterfallHook, SyncBailHook } from 'tapable';
 import z from 'zod';
 
 declare class AuthHooks {
@@ -177,14 +178,14 @@ declare class GameHooks {
 		name?: string;
 		family_name?: string;
 	} | undefined, import("tapable").UnsetAdditionalOptions>;
-	gameLookup: AsyncSeriesHook<[
+	gameLookup: AsyncSeriesWaterfallHook<[
+		matches: Map<string, GameLookup[]>,
 		ctx: {
 			source?: string;
 			id?: string;
 			search?: string;
-			matches: GameLookup[];
 		}
-	], import("tapable").UnsetAdditionalOptions>;
+	], Map<string, GameLookup[]>, import("tapable").UnsetAdditionalOptions>;
 	fetchPlatforms: AsyncSeriesHook<[
 		ctx: {
 			platforms: FrontEndPlatformType[];
@@ -399,7 +400,7 @@ export declare const EmulatorPackageSchema: z.ZodObject<{
 		}, z.core.$strip>
 	], "type">>>>;
 	systems: z.ZodArray<z.ZodString>;
-	bios: z.ZodOptional<z.ZodLiteral<"optional" | "required">>;
+	bios: z.ZodOptional<z.ZodLiteral<"required" | "optional">>;
 }, z.core.$strip>;
 export declare const GameListFilterSchema: z.ZodObject<{
 	platform_source: z.ZodOptional<z.ZodString>;
@@ -477,20 +478,72 @@ export declare const OAUTH_REDIRECT_PORT = 5194;
 export declare const PlatformSchema: z.ZodObject<{
 	slug: z.ZodString;
 }, z.core.$strip>;
+export declare const PluginBunDetailsSchema: z.ZodObject<{
+	name: z.ZodString;
+	keywords: z.ZodArray<z.ZodString>;
+	version: z.ZodString;
+	author: z.ZodOptional<z.ZodObject<{
+		name: z.ZodOptional<z.ZodString>;
+	}, z.core.$strip>>;
+	license: z.ZodOptional<z.ZodString>;
+	devDependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+	dependencies: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+	maintainers: z.ZodOptional<z.ZodArray<z.ZodObject<{
+		name: z.ZodString;
+	}, z.core.$strip>>>;
+	dist: z.ZodObject<{
+		unpackedSize: z.ZodNumber;
+	}, z.core.$strip>;
+	description: z.ZodOptional<z.ZodString>;
+	_npmUser: z.ZodOptional<z.ZodObject<{
+		name: z.ZodString;
+	}, z.core.$strip>>;
+}, z.core.$strip>;
 export declare const PluginContextSchema: z.ZodObject<{
 	hooks: z.ZodCustom<GameflowHooks, GameflowHooks>;
 }, z.core.$strip>;
 export declare const PluginDescriptionSchema: z.ZodObject<{
 	name: z.ZodString;
-	displayName: z.ZodString;
+	displayName: z.ZodOptional<z.ZodString>;
 	version: z.ZodString;
-	description: z.ZodString;
+	description: z.ZodOptional<z.ZodString>;
 	icon: z.ZodOptional<z.ZodURL>;
 	keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
 	category: z.ZodDefault<z.ZodString>;
 	main: z.ZodString;
 	canDisable: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
 }, z.core.$strip>;
+export declare const PluginEntrySchema: z.ZodObject<{
+	downloads: z.ZodObject<{
+		monthly: z.ZodNumber;
+		weekly: z.ZodNumber;
+	}, z.core.$strip>;
+	searchScore: z.ZodNumber;
+	installed: z.ZodBoolean;
+	package: z.ZodObject<{
+		name: z.ZodString;
+		keywords: z.ZodArray<z.ZodString>;
+		version: z.ZodString;
+		description: z.ZodOptional<z.ZodString>;
+		sanitized_name: z.ZodString;
+		license: z.ZodOptional<z.ZodString>;
+		publisher: z.ZodObject<{
+			email: z.ZodString;
+			username: z.ZodString;
+			trustedPublisher: z.ZodOptional<z.ZodObject<{
+				id: z.ZodString;
+				oidcConfigId: z.ZodString;
+			}, z.core.$strip>>;
+		}, z.core.$strip>;
+		date: z.ZodCoercedDate<unknown>;
+		links: z.ZodObject<{
+			homepage: z.ZodOptional<z.ZodString>;
+			repository: z.ZodOptional<z.ZodString>;
+			bugs: z.ZodOptional<z.ZodString>;
+			npm: z.ZodURL;
+		}, z.core.$strip>;
+	}, z.core.$strip>;
+}, z.core.$strip>;
 export declare const PluginLoadingContextSchema: z.ZodObject<{
 	setProgress: z.ZodFunction<z.core.$ZodTuple<readonly [
 		z.ZodNumber,
@@ -498,8 +551,46 @@ export declare const PluginLoadingContextSchema: z.ZodObject<{
 	], z.core.$ZodFunctionOut>, z.ZodVoid>;
 	config: z.ZodCustom<Conf<Record<string, any>>, Conf<Record<string, any>>>;
 	zodRegistry: z.ZodCustom<z.core.$ZodRegistry<object | undefined, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>, z.core.$ZodRegistry<object | undefined, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+	app: z.ZodObject<{
+		config: z.ZodCustom<Conf<{
+			downloadPath: string;
+			launchInFullscreen: boolean;
+			disabledPlugins: string[];
+			emulatorResolution: "720p" | "1080p" | "1440p" | "4k";
+			emulatorWidescreen: boolean;
+			rommAddress?: string | undefined;
+			rommUser?: string | undefined;
+			windowSize?: {
+				width: number;
+				height: number;
+			} | undefined;
+			windowPosition?: {
+				x: number;
+				y: number;
+			} | undefined;
+		}>, Conf<{
+			downloadPath: string;
+			launchInFullscreen: boolean;
+			disabledPlugins: string[];
+			emulatorResolution: "720p" | "1080p" | "1440p" | "4k";
+			emulatorWidescreen: boolean;
+			rommAddress?: string | undefined;
+			rommUser?: string | undefined;
+			windowSize?: {
+				width: number;
+				height: number;
+			} | undefined;
+			windowPosition?: {
+				x: number;
+				y: number;
+			} | undefined;
+		}>>;
+		events: z.ZodCustom<EventEmitter<AppEventMap>, EventEmitter<AppEventMap>>;
+		taskQueue: z.ZodCustom<TaskQueue, TaskQueue>;
+	}, z.core.$strip>;
 	hooks: z.ZodCustom<GameflowHooks, GameflowHooks>;
 }, z.core.$strip>;
+export declare const PluginRegistry: string;
 export declare const PluginSchema: z.ZodObject<{
 	load: z.ZodFunction<z.core.$ZodTuple<readonly [
 		z.ZodObject<{
@@ -509,6 +600,43 @@ export declare const PluginSchema: z.ZodObject<{
 			], z.core.$ZodFunctionOut>, z.ZodVoid>;
 			config: z.ZodCustom<Conf<Record<string, any>>, Conf<Record<string, any>>>;
 			zodRegistry: z.ZodCustom<z.core.$ZodRegistry<object | undefined, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>, z.core.$ZodRegistry<object | undefined, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>>;
+			app: z.ZodObject<{
+				config: z.ZodCustom<Conf<{
+					downloadPath: string;
+					launchInFullscreen: boolean;
+					disabledPlugins: string[];
+					emulatorResolution: "720p" | "1080p" | "1440p" | "4k";
+					emulatorWidescreen: boolean;
+					rommAddress?: string | undefined;
+					rommUser?: string | undefined;
+					windowSize?: {
+						width: number;
+						height: number;
+					} | undefined;
+					windowPosition?: {
+						x: number;
+						y: number;
+					} | undefined;
+				}>, Conf<{
+					downloadPath: string;
+					launchInFullscreen: boolean;
+					disabledPlugins: string[];
+					emulatorResolution: "720p" | "1080p" | "1440p" | "4k";
+					emulatorWidescreen: boolean;
+					rommAddress?: string | undefined;
+					rommUser?: string | undefined;
+					windowSize?: {
+						width: number;
+						height: number;
+					} | undefined;
+					windowPosition?: {
+						x: number;
+						y: number;
+					} | undefined;
+				}>>;
+				events: z.ZodCustom<EventEmitter<AppEventMap>, EventEmitter<AppEventMap>>;
+				taskQueue: z.ZodCustom<TaskQueue, TaskQueue>;
+			}, z.core.$strip>;
 			hooks: z.ZodCustom<GameflowHooks, GameflowHooks>;
 		}, z.core.$strip>
 	], z.core.$ZodFunctionOut>, z.ZodPromise<z.ZodVoid>>;
@@ -664,13 +792,10 @@ export declare const SystemInfoSchema: z.ZodObject<{
 	}, z.core.$strip>>;
 }, z.core.$strip>;
 export declare const WINDOW_PORT = 4656;
-export declare const config: Conf<SettingsType>;
 export declare const settingRegistry: z.core.$ZodRegistry<{
 	dev?: boolean;
 }, z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
 export declare function delay(delay: number | Date, signal?: AbortSignal): Promise<unknown>;
-export declare let events: EventEmitter<AppEventMap>;
-export declare let taskQueue: TaskQueue;
 export interface AbortEvent extends BaseEvent {
 	reason?: any;
 }
@@ -976,11 +1101,12 @@ export interface FrontendNotification {
 }
 export interface FrontendPlugin {
 	name: string;
-	displayName: string;
-	description: string;
+	displayName?: string;
+	description?: string;
 	category: string;
 	enabled: boolean;
 	canDisable: boolean;
+	canUninstall: boolean;
 	source: PluginSourceType;
 	hasSettings: boolean;
 	version: string;
@@ -1055,130 +1181,29 @@ export interface SaveFileChange {
 	shared: boolean;
 	fixedSize?: boolean;
 }
-export type ActiveGameType = {
-    process?: any | undefined;
-    gameId: {
-        id: string;
-        source: string;
-    };
-    source?: string | undefined;
-    sourceId?: string | undefined;
-    name: string;
-    command: {
-        command: string | string[];
-        startDir?: string | undefined;
-    };
-};
-export type DirType = {
-    name: string;
-    parentPath: string;
-    isDirectory: boolean;
-};
-export type DownloadSourceType = {
-    id: string;
-    name: string;
-};
+export type ActiveGameType = z.infer<typeof ActiveGameSchema>;
+export type DirType = z.infer<typeof DirSchema>;
+export type DownloadSourceType = z.infer<typeof DownloadSourceSchema>;
 export type EmulatorCapabilities = "saves" | "fullscreen" | "resolution" | "batch" | "states" | "config";
-export type EmulatorDownloadInfoType = {
-    id: string;
-    version?: string | undefined;
-    url?: string | undefined;
-    description?: string | undefined;
-    downloadDate: Date;
-    type: string;
-};
-export type EmulatorPackageType = {
-    name: string;
-    description: string;
-    homepage: string;
-    logo: string;
-    type: "emulator";
-    os: ("darwin" | "linux" | "win32" | "android")[];
-    keywords?: string[] | undefined;
-    downloads?: {
-        [key: string]: ({
-            type: "github" | "gitlab";
-            pattern: string;
-            path: string;
-            bin?: string | undefined;
-        } | {
-            type: "direct";
-            url: string;
-            bin?: string | undefined;
-        } | {
-            type: "scoop";
-            url: string;
-            bin?: string | undefined;
-        })[];
-    } | undefined;
-    systems: string[];
-    bios?: ("required" | "optional") | undefined;
-};
+export type EmulatorDownloadInfoType = z.infer<typeof EmulatorDownloadInfoSchema>;
+export type EmulatorPackageType = z.infer<typeof EmulatorPackageSchema>;
 export type EmulatorSourceType = "custom" | "store" | "registry" | "system" | "static" | "embedded";
 export type GameInstallProgressEvent = "refresh";
-export type GameListFilterType = {
-    platform_source?: string | undefined;
-    platform_slug?: string | undefined;
-    platform_id?: number | undefined;
-    collection_id?: number | undefined;
-    collection_source?: string | undefined;
-    limit?: number | undefined;
-    search?: string | undefined;
-    offset?: number | undefined;
-    source?: string | undefined;
-    localOnly?: boolean | undefined;
-    orderBy?: ("added" | "activity" | "name" | "release") | undefined;
-    age_ratings?: (string[] | any) | undefined;
-    genres?: (string[] | any) | undefined;
-    keywords?: (string[] | any) | undefined;
-};
+export type GameListFilterType = z.infer<typeof GameListFilterSchema>;
 export type GameStatusType = "installed" | "missing-emulator" | "error" | "install" | "download" | "extract" | "playing" | "queued";
 export type JobStatus = "completed" | "error" | "running" | "queued" | "aborted";
 export type KeysWithValueAssignableTo<T, Value> = {
 	[K in keyof T]: Exclude<T[K], undefined> extends Value ? K : never;
 }[keyof T];
-export type LocalSettingsType = {
-    backgroundBlur: boolean;
-    backgroundAnimation: boolean;
-    theme: "dark" | "light" | "auto";
-    soundEffects: boolean;
-    soundEffectsVolume: number;
-    hapticsEffects: boolean;
-    showRouterDevOptions: boolean;
-    showQueryDevOptions: boolean;
-    /** Show the gameflow on screen keyboard when using a controller */
-    useGameflowKeyboard: boolean;
-    /** Open on screen keybaord automatically */
-    autoKeybaord: boolean;
-};
-export type PluginContextType = {
-    hooks: any;
-};
-export type PluginDescriptionType = {
-    name: string;
-    displayName: string;
-    version: string;
-    description: string;
-    /** Can be an external URL to an image or a data url */
-    icon?: string | undefined;
-    keywords?: string[] | undefined;
-    category: string;
-    /** The main entry. It must export a default class implementing PluginType */
-    main: string;
-    /** Can the plugin be disabled or enabled by the user */
-    canDisable?: boolean | undefined;
-};
-export type PluginLoadingContextType<TSettings extends Record<string, any> = Record<string, any>> = {
-    setProgress: (args_0: number, args_1: string) => void | undefined;
-    /** Per plugin config. It will use the settings schema defined in the plugin class */
-    config: any;
-    /** Used by the settings to register metadata for the UI */
-    zodRegistry: any;
-    hooks: any;
-} & {
+export type LocalSettingsType = z.infer<typeof LocalSettingsSchema>;
+export type PluginBunDetailsType = z.infer<typeof PluginBunDetailsSchema>;
+export type PluginContextType = z.infer<typeof PluginContextSchema>;
+export type PluginDescriptionType = z.infer<typeof PluginDescriptionSchema>;
+export type PluginEntryType = z.infer<typeof PluginEntrySchema>;
+export type PluginLoadingContextType<TSettings extends Record<string, any> = Record<string, any>> = z.infer<typeof PluginLoadingContextSchema> & {
 	config: Conf<TSettings>;
 };
-export type PluginSourceType = "builtin";
+export type PluginSourceType = "builtin" | "store";
 export type PluginType<T extends Record<string, any> = Record<string, any>> = Omit<z.infer<typeof PluginSchema>, "load" | "settingsMigrations"> & {
 	load: (ctx: PluginLoadingContextType<T>) => Promise<void>;
 	settingsMigrations?: Record<string, (conf: Conf<T>) => void>;
@@ -1186,110 +1211,9 @@ export type PluginType<T extends Record<string, any> = Record<string, any>> = Om
 export type SaveSlots = Record<string, {
 	cwd: string;
 }>;
-export type SettingsType = {
-    rommAddress?: string | undefined;
-    rommUser?: string | undefined;
-    windowSize?: {
-        width: number;
-        height: number;
-    } | undefined;
-    windowPosition?: {
-        x: number;
-        y: number;
-    } | undefined;
-    downloadPath: string;
-    launchInFullscreen: boolean;
-    disabledPlugins: string[];
-    emulatorResolution: "720p" | "1080p" | "1440p" | "4k";
-    emulatorWidescreen: boolean;
-};
-export type StoreDownloadType = {
-    type: "direct";
-    url: string;
-    name?: string | undefined;
-    system: string;
-    main?: string | undefined;
-    saves?: {
-        [key: string]: {
-            cwd: string;
-            globs: string[];
-        };
-    } | undefined;
-} | {
-    type: "itch";
-    path: string;
-    name?: string | undefined;
-    system: string;
-    saves?: {
-        [key: string]: {
-            cwd: string;
-            globs: string[];
-        };
-    } | undefined;
-};
-export type StoreGameType = {
-    name: string;
-    description: string;
-    version: string;
-    homepage?: string | undefined;
-    keywords?: string[] | undefined;
-    genres?: string[] | undefined;
-    companies?: string[] | undefined;
-    screenshots?: string[] | undefined;
-    covers?: string[] | undefined;
-    igdb_id?: number | undefined;
-    ra_id?: number | undefined;
-    sgdb_id?: number | undefined;
-    first_release_date?: (number | Date) | undefined;
-    player_count?: string | undefined;
-    saves?: {
-        [key: string]: {
-            [key: string]: {
-                cwd: string;
-                globs: string[];
-            };
-        };
-    } | undefined;
-    downloads: {
-        [key: string]: {
-            type: "direct";
-            url: string;
-            name?: string | undefined;
-            system: string;
-            main?: string | undefined;
-            saves?: {
-                [key: string]: {
-                    cwd: string;
-                    globs: string[];
-                };
-            } | undefined;
-        } | {
-            type: "itch";
-            path: string;
-            name?: string | undefined;
-            system: string;
-            saves?: {
-                [key: string]: {
-                    cwd: string;
-                    globs: string[];
-                };
-            } | undefined;
-        };
-    };
-};
-export type SystemInfoType = {
-    battery: {
-        percent: number;
-        isCharging: boolean;
-        acConnected: boolean;
-        hasBattery: boolean;
-    };
-    wifiConnections: {
-        signalLevel: number;
-    }[];
-    bluetoothDevices: {
-        connected: boolean;
-    }[];
-};
+export type SettingsType = z.infer<typeof SettingsSchema>;
+export type StoreDownloadType = z.infer<typeof StoreDownloadSchema>;
+export type StoreGameType = z.infer<typeof StoreGameSchema>;
+export type SystemInfoType = z.infer<typeof SystemInfoSchema>;
 
 export {};

package/package.json

@@ -1,5 +1,6 @@
 {
    "name": "@simeonradivoev/gameflow-sdk",
+   "version": "1.5.1",
    "types": "index.d.ts",
    "description": "plugin SDK for the Gameflow Deck Launcher",
    "keywords": [
@@ -7,7 +8,6 @@
       "sdk"
    ],
    "license": "AGPL-3.0",
-   "version": "1.4.0",
    "repository": {
       "type": "git",
       "url": "https://github.com/simeonradivoev/gameflow-deck"
@@ -20,35 +20,35 @@
    "peerDependencies": {
       "7zip-bin": "^5.2.0",
       "@auth/core": "^0.34.3",
-      "@elysiajs/cors": "^1.4.1",
-      "@elysiajs/eden": "^1.4.6",
-      "@jimp/wasm-webp": "^1.6.0",
+      "@elysiajs/cors": "^1.4.2",
+      "@elysiajs/eden": "^1.4.9",
+      "@jimp/wasm-webp": "^1.6.1",
       "@phalcode/ts-igdb-client": "^1.0.26",
       "cheerio": "^1.2.0",
-      "conf": "^15.0.2",
-      "drizzle-orm": "^0.45.1",
-      "elysia": "^1.4.22",
-      "fs-extra": "^11.3.3",
+      "conf": "^15.1.0",
+      "drizzle-orm": "^0.45.2",
+      "elysia": "^1.4.28",
+      "fs-extra": "^11.3.5",
       "get-folder-size": "^5.0.0",
       "ini": "^6.0.0",
-      "jimp": "^1.6.0",
+      "jimp": "^1.6.1",
       "mustache": "^4.2.0",
       "node-7z": "^3.0.0",
       "node-disk-info": "^1.3.0",
-      "node-downloader-helper": "^2.1.10",
+      "node-downloader-helper": "^2.1.11",
       "node-stream-zip": "^1.15.0",
       "node-unrar-js": "^2.0.2",
       "open": "^11.0.0",
-      "p-queue": "^9.1.2",
+      "p-queue": "^9.2.0",
       "pathe": "^2.0.3",
       "slugify": "^1.6.9",
       "smol-toml": "^1.6.1",
       "systeminformation": "^5.31.5",
-      "tapable": "^2.3.0",
-      "tough-cookie": "^6.0.0",
+      "tapable": "^2.3.3",
+      "tough-cookie": "^6.0.1",
       "tough-cookie-file-store": "^3.3.0",
       "unzip-stream": "^0.3.4",
       "webview-bun": "^2.4.0",
-      "zod": "^4.3.6"
+      "zod": "^4.4.3"
    }
 }