@overlayed/app 1.8.0 → 2.0.0

package/dist/index.d.mts

@@ -322,7 +322,9 @@ interface FeatureFlagModel {
 interface GameModel {
   name: string;
   identifier: Brand<string, GameModel>;
+  /** @deprecated Use `game_module`. Holds the same value as a 0-or-1 element list */
   modules: string[];
+  game_module?: string;
   executables: string[];
   allow_dll_injections: boolean;
   has_render_support: boolean;
@@ -400,6 +402,14 @@ declare function module(): {
   readonly key: "universal";
   readonly events: import("arktype").Module<{
     event: {
+      game: "sand" | "siege" | "tft";
+      type: "module_loaded";
+      creationTime: number;
+      content: {
+        gameVersion: string;
+        processHash: string;
+      };
+    } | {
       game: "sand";
       type: "logged_in";
       creationTime: number;
@@ -416,14 +426,6 @@ declare function module(): {
       content: {
         accountId: string;
       };
-    } | {
-      game: "sand" | "siege" | "tft";
-      type: "module_loaded";
-      creationTime: number;
-      content: {
-        gameVersion: string;
-        processHash: string;
-      };
     } | {
       game: "sand" | "siege" | "tft";
       type: "module_unloaded";
@@ -1106,6 +1108,53 @@ type OverlayedApp<TModule extends GameModule, TKeybind extends string, TFeatureF
    */
   initialized: boolean;
 };
+/**
+ * What the navigation guard should do with a `window.open` / `target="_blank"`
+ * request:
+ *
+ * - `"allow"` — open the window in-app, like a regular Electron child window.
+ * - `"external"` — deny the in-app window and open the URL in the system
+ *   browser instead, without requiring user activation. Only honored for
+ *   `http`/`https` URLs.
+ * - `"deny"` — deny the window without opening anything.
+ */
+type WindowOpenAction = "allow" | "external" | "deny";
+interface OverlayedNavigationGuardOptions {
+  /**
+   * Hosts the main frame is allowed to navigate to, in addition to the
+   * application's own origin and the origin currently loaded in the window.
+   * Useful for legitimate top-frame cross-origin flows such as OAuth
+   * redirects.
+   *
+   * Matched against `URL.host` (hostname + port), e.g. `"auth.ubisoft.com"`.
+   *
+   * @default []
+   */
+  allowedHosts?: string[];
+  /**
+   * Overrides the default `window.open` policy for a specific URL. Return a
+   * {@link WindowOpenAction} to decide what happens, or `undefined` to fall
+   * back to the default policy (allowed origins open in-app, other web URLs
+   * open in the system browser if the user just clicked or pressed a key,
+   * everything else is denied).
+   *
+   * ```ts
+   * overlayed({
+   *   navigationGuard: {
+   *     windowOpenHandler: ({ url }) => {
+   *       if (new URL(url).host === "checkout.stripe.com") {
+   *         return "allow";
+   *       }
+   *       return undefined;
+   *     },
+   *   },
+   * });
+   * ```
+   */
+  windowOpenHandler?: (details: {
+    url: string;
+  }) => WindowOpenAction | undefined;
+}
 interface OverlayedOptions<TModule extends GameModule, TKeybind extends string, TFeatureFlag extends string = string> {
   /**
    * The electron instance.
@@ -1170,6 +1219,11 @@ interface OverlayedOptions<TModule extends GameModule, TKeybind extends string,
    * ```
    */
   featureFlags?: Record<TFeatureFlag, boolean>;
+  /**
+   * Configuration for the navigation guard applied to every window created via
+   * `overlay.windows`. See {@link OverlayedNavigationGuardOptions}.
+   */
+  navigationGuard?: OverlayedNavigationGuardOptions;
   /**
    * Site module configuration.
    */
@@ -1189,4 +1243,4 @@ interface OverlayedOptions<TModule extends GameModule, TKeybind extends string,
 //#region src/utilities/overlayed.d.ts
 declare function overlayed<TModule extends GameModule, TShortcut extends string, TFeatureFlag extends string = string>(optionsRaw: OverlayedOptions<TModule, TShortcut, TFeatureFlag>): OverlayedApp<TModule, TShortcut, TFeatureFlag>;
 //#endregion
-export { type ActiveGameInfo, type BundleAppConfig, type BundleSiteConfig, type ErrorEvents, type FatalEvents, type FeatureFlagLayers, type FeatureFlagModel, type FeedbackId, type FeedbackType, type GameCloseEvent, type GameLaunchEvent, type GameReadyEvent, type KeybindSchemaEntry as KeybindConfig, type KeyboardKeyEvent, type LoggerScope, type MouseButtonEvent, type NoticeId, type NoticeModel, type NoticeType, type OverlayedApp, type OverlayedConfig, type OverridesManagerScope, type ProgressInfo, RenderInterface, type RenderWindow, type RenderWindowConstructorOptions, type UpdateCheckResult, VirtualKey, type WarningEvents, type WindowEvent, defineConfig, overlayed };
+export { type ActiveGameInfo, type BundleAppConfig, type BundleSiteConfig, type ErrorEvents, type FatalEvents, type FeatureFlagLayers, type FeatureFlagModel, type FeedbackId, type FeedbackType, type GameCloseEvent, type GameLaunchEvent, type GameReadyEvent, type KeybindSchemaEntry as KeybindConfig, type KeyboardKeyEvent, type LoggerScope, type MouseButtonEvent, type NoticeId, type NoticeModel, type NoticeType, type OverlayedApp, type OverlayedConfig, type OverlayedNavigationGuardOptions, type OverridesManagerScope, type ProgressInfo, RenderInterface, type RenderWindow, type RenderWindowConstructorOptions, type UpdateCheckResult, VirtualKey, type WarningEvents, type WindowEvent, type WindowOpenAction, defineConfig, overlayed };