@overlayed/app 0.6.1 → 0.7.0

package/dist/index.d.ts

@@ -78,20 +78,24 @@ declare interface FatalElevationMismatch extends ErrorManagerEvent {
 declare type FatalEvents = FatalElevationMismatch;
 
 export declare type GameLaunchManagerEvents = {
-    gameLaunchInternal: {
+    gameCloseInternal: (args: {
         ravenGame: RavenGame;
         process: Process;
-    };
-    gameCloseInternal: {
-        ravenGame: RavenGame;
-        process: Process;
-    };
-    gameLaunch: {
+    }) => MaybePromise<void>;
+    gameLaunch: (args: {
         game: string;
-    };
-    gameClose: {
+        reject: () => void;
+    }) => MaybePromise<boolean>;
+    gameClose: (args: {
         game: string;
-    };
+    }) => MaybePromise<void>;
+    gameReady: (args: {
+        game: string;
+    }) => MaybePromise<void>;
+    gameReadyInternal: (args: {
+        ravenGame: RavenGame;
+        process: Process;
+    }) => MaybePromise<void>;
 };
 
 declare interface GameModule<TEvents extends Record<string, BaseEvent> = Record<string, BaseEvent>, TKey extends string = string> {
@@ -141,6 +145,8 @@ declare class Manager {
     destroy(): void;
 }
 
+declare type MaybePromise<T> = T | Promise<T>;
+
 export interface MouseButtonEvent extends WindowEvent {
     		x: number;
     		y: number;
@@ -151,7 +157,7 @@ export interface MouseButtonEvent extends WindowEvent {
     		key: VirtualKey;
     	}
 
-export declare function overlayed<TModule extends GameModule, TShortcut extends string>(data: OverlayedData<TModule, TShortcut>): OverlayedApp<TModule, TShortcut>;
+export declare function overlayed<TModule extends GameModule, TShortcut extends string>(options: OverlayedOptions<TModule, TShortcut>): OverlayedApp<TModule, TShortcut>;
 
 export declare type OverlayedApp<TModule extends GameModule, TKeybind extends string> = OverlayedAppGameModules<TModule> & OverlayedAppHandlers & {
     keybinds: OverlayedAppKeybindModule<TKeybind>;
@@ -206,8 +212,9 @@ declare type OverlayedAppHandlersMapping = {
     error: (data: ErrorManagerEvents["error"]) => void;
     warning: (data: ErrorManagerEvents["warning"]) => void;
     fatal: (data: ErrorManagerEvents["fatal"]) => void;
-    gameLaunch: (data: GameLaunchManagerEvents["gameLaunch"]) => void;
-    gameClose: (data: GameLaunchManagerEvents["gameClose"]) => void;
+    gameLaunch: GameLaunchManagerEvents["gameLaunch"];
+    gameClose: GameLaunchManagerEvents["gameClose"];
+    gameReady: GameLaunchManagerEvents["gameReady"];
 };
 
 declare interface OverlayedAppInputModule {
@@ -296,7 +303,7 @@ declare type OverlayedAppKeybindsConfig<TKeybind extends string> = Record<TKeybi
      * - Whatever you configure will be the default value
      * - [Here](https://www.toptal.com/developers/keycode) is a good tool to easily find the codes for a given hotkey
      */
-    keys: Array<OverlayedAppKeybindsConfigKey>;
+    keys: OverlayedAppKeybindsConfigKey[];
     /**
      * - `toggle` will trigger the callback when the key is toggled on and off
      * - `hold` will trigger the callback when the key is held down
@@ -305,7 +312,7 @@ declare type OverlayedAppKeybindsConfig<TKeybind extends string> = Record<TKeybi
     mode: OverlayedAppKeybindsConfigMode;
 }>;
 
-declare type OverlayedAppKeybindsConfigKey = "ctrl" | "shift" | "alt" | (string & {});
+declare type OverlayedAppKeybindsConfigKey = "ControlLeft" | "AltLeft" | "ShiftLeft" | "AltRight" | "ControlRight" | "ShiftRight" | (string & {});
 
 declare type OverlayedAppKeybindsConfigMode = "toggle" | "hold";
 
@@ -314,7 +321,7 @@ declare interface OverlayedAppWindowsModule extends Pick<RenderInterface, "on" |
     getActiveGameInfo: () => ActiveGameInfo;
 }
 
-declare interface OverlayedData<TModule extends GameModule, TKeybind extends string> {
+declare interface OverlayedOptions<TModule extends GameModule, TKeybind extends string> {
     /**
      * The app name.
      *
@@ -334,6 +341,13 @@ declare interface OverlayedData<TModule extends GameModule, TKeybind extends str
      * @default true;
      */
     init?: boolean;
+    /**
+     * When true, the overlay will be loaded for all supported games.
+     * When false, only games registered under the `modules` array will be loaded.
+     *
+     * @default false
+     */
+    universal?: boolean;
 }
 
 declare class OverridesManager extends Manager {