@overwolf/ow-electron-packages-types 1.1.2 → 1.1.5-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.1.2",
+    "version": "1.1.5-beta.1",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",
@@ -31,7 +31,10 @@
             "types": "./gep-supported-games.d.ts"
         }
     },
+    "scripts": {
+        "combine": "node combine-dts.js ./modules"
+    },
     "dependencies": {
         "glob": "^13.0.0"
     }
-}
+}

package/types.d.ts

@@ -940,6 +940,38 @@ interface VideoInformation {
   readonly defaultEncoder: kSupportedEncodersTypes;
 }
 
+/**
+ * Information about the current Xbox Game DVR state on the system.
+ *
+ * Xbox Game DVR captures game video in the background and can interfere with
+ * recording. This interface reports whether it is active and the underlying
+ * registry values that drive it.
+ *
+ * @example
+ * const dvr: XboxDVRInfo = {
+ *   enabled: true,
+ *   appCaptureEnabled: true,
+ *   gameDVREnabled: false
+ * };
+ */
+interface XboxDVRInfo {
+  /**
+   * `true` if Xbox Game DVR is active via either capture path
+   * (`appCaptureEnabled || gameDVREnabled`).
+   */
+  readonly enabled: boolean;
+
+  /**
+   * The `AppCaptureEnabled` registry value.
+   */
+  readonly appCaptureEnabled: boolean;
+
+  /**
+   * The `GameDVR_Enabled` registry value.
+   */
+  readonly gameDVREnabled: boolean;
+}
+
 /**
  * Information about the complete recording configuration for the current system.
  *
@@ -975,6 +1007,13 @@ interface RecordingInformation {
    * @see MonitorInfo
    */
   monitors: MonitorInfo[];
+
+  /**
+   * The current Xbox Game DVR state on the system.
+   *
+   * @see XboxDVRInfo
+   */
+  xboxDVR: XboxDVRInfo;
 }
 
 
@@ -4340,10 +4379,15 @@ interface IOverwolfRecordingApi {
   readonly version: string;
 
   /**
-   * Path to ffmpeg file.
+   * Path to ffmpeg executable
    */
   readonly ffmpegPath: string;
 
+  /**
+   * Path to ffprobe executable
+   */
+  readonly ffprobePath: string;
+
   /**
    * Path to OBS binaries folder.
    */
@@ -4367,10 +4411,30 @@ interface IOverwolfRecordingApi {
   /**
    * Queries supported encoders, audio/video devices, and configuration options.
    *
+   * The result also includes the current Xbox Game DVR state (`xboxDVR`).
+   *
+   * @param overrideCache If `true`, bypasses cached result and queries OBS directly.
    * @returns A promise that resolves to the full recording capability information.
    * @see {@link RecordingInformation}
    */
-  queryInformation(): Promise<RecordingInformation>;
+  queryInformation(overrideCache?: boolean): Promise<RecordingInformation>;
+
+  /**
+   * Returns whether Xbox Game DVR is enabled, checking both the
+   * `GameDVR_Enabled` and `AppCaptureEnabled` registry values.
+   *
+   * @returns A promise that resolves to the current Xbox Game DVR state.
+   * @see {@link XboxDVRInfo}
+   */
+  isXboxDVREnabled(): Promise<XboxDVRInfo>;
+
+  /**
+   * Disables Xbox Game DVR by setting `AppCaptureEnabled` and
+   * `GameDVR_Enabled` to `0` in the registry.
+   *
+   * @returns A promise that resolves once the values have been written.
+   */
+  disableXboxDVR(): Promise<void>;
 
   /**
    * Creates a capture settings builder instance to configure video/audio sources.
@@ -4461,7 +4525,7 @@ interface IOverwolfRecordingApi {
    *
    * @param filter Filtering rules for which games to track.
    */
-  registerGames(filter: GamesFilter): void;
+  registerGames(filter: GamesFilter): Promise<void>;
 
   /**
    * Updates runtime settings for an audio device while recording.
@@ -4577,6 +4641,30 @@ interface OWPackages extends overwolf.packages.OverwolfPackageManager {
   gep: OverwolfGameEventPackage;
 }
 
+/**
+ * Augments the base `OverwolfPackageManager` so that `app.overwolf.packages`
+ * is fully typed without any casting or manual global.d.ts augmentation in
+ * the consuming project.
+ */
+declare global {
+  namespace overwolf {
+    namespace packages {
+      interface OverwolfPackageManager {
+        /** Access to Overwolf's video recording and replay functionality. */
+        recorder: IOverwolfRecordingApi;
+        /** Access to overlay-related APIs such as window creation, input control, and hotkeys. */
+        overlay: IOverwolfOverlayApi;
+        /** Access to utility APIs for game launch tracking and game scanning. */
+        utility: IOverwolfUtilityApi;
+        /** Access to crash reporting and notification APIs. */
+        crn: IOverwolfCRNApi;
+        /** Subscribe to real-time in-game events and info updates from supported games. */
+        gep: OverwolfGameEventPackage;
+      }
+    }
+  }
+}
+
 
 // --- modules\overlay.d.ts ---
 /**
@@ -5573,7 +5661,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   exitExclusiveMode(): void;
 
-   /**
+  /**
    * Install ow-electron helpers to
    * `%CommonProgramFiles%\<app-name>\` with UAC elevation.
    * Allows injection into high elevation games.
@@ -5619,20 +5707,20 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * }
    * ```
    * @returns Resolves when installation completes.
-   * 
-   * 
-   * 
+   *
+   *
+   *
    */
   installHighElevationHelper?(): Promise<void>;
 
   /**
    * Returns true if ow-electron helpers is already installed in
    * `%CommonProgramFiles%\<app-name>\`.
-   * 
+   *
    * @returns `true` if the helper is installed and ready.
-   * 
+   *
    * @example
-   * ```ts 
+   * ```ts
    * const installed: boolean = await api.isHighElevationHelperInstalled();
    * if (!installed) {
    *   // Prompt the user to run the one-time setup before injecting into elevated games
@@ -5641,6 +5729,64 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   isHighElevationHelperInstalled?(): Promise<boolean>;
 
+  /**
+   * Captures the current game frame and saves it to disk.
+   *
+   * Only one screenshot can be in progress at a time. Calling this method
+   * while a previous capture is still pending will reject immediately —
+   * wait for the returned promise to settle before issuing the next call.
+   *
+   * The output format is resolved by precedence: an explicit `format`
+   * argument wins; otherwise the extension already present in `filePath`
+   * (`.jpg`/`.jpeg` or `.bmp`) is used; otherwise it defaults to `'bmp'`.
+   * The file extension is then normalized to match the resolved format, so
+   * an existing extension is rewritten rather than doubled (e.g.
+   * `shot.jpg` stays `shot.jpg`, and `shot.png` with `format: 'jpg'` becomes
+   * `shot.jpg`).
+   *
+   * Internally all backends (D3D9, D3D11, D3D12, Vulkan) capture as BMP
+   * first and transcode to JPEG on demand, ensuring correct colors across
+   * all graphics APIs and formats.
+   *
+   * @param filePath - Absolute path (UTF-8) where the image will be saved.
+   * @param format - Output image format: `'jpg'` or `'bmp'`. When omitted,
+   *   the extension in `filePath` is used, falling back to `'bmp'`.
+   * @returns A promise that resolves with the absolute path the file was
+   *   actually written to, including the normalized extension (which may
+   *   differ from `filePath`).
+   *
+   * @throws `'no active game'` — the overlay is not currently injected into
+   *   any game. Wait for the `game-injected` event before calling.
+   * @throws `'screenshot already in progress'` — a previous capture has not
+   *   yet completed. Await the previous promise before calling again.
+   * @throws `'no active graphics device'` — the game has no active GPU
+   *   device at this moment (e.g. the game window is minimized or in a
+   *   device-lost state). Try again once the game is in the foreground.
+   * @throws `'capture failed: <backend>'` — the GPU-side readback failed
+   *   (e.g. staging texture creation, memory map, or WIC encode error).
+   *
+   * @example
+   * ```ts
+   * overlay.on('game-injected', () => {
+   *   overlay.hotkeys.register(
+   *     { name: 'screenshot', keyCode: 'F9', passthrough: false },
+   *     async (hotkey, state) => {
+   *       if (state !== 'pressed') return;
+   *       const ts = new Date().toISOString().replace(/[:.]/g, '-').slice(0, 19);
+   *       const filePath = path.join(app.getPath('pictures'), `screenshot_${ts}`);
+   *       try {
+   *         const savedPath = await overlay.takeScreenshot(filePath, 'jpg');
+   *         console.log('screenshot written to', savedPath); // ...filePath.jpg
+   *       } catch (err) {
+   *         console.error('Screenshot failed:', err.message);
+   *       }
+   *     }
+   *   );
+   * });
+   * ```
+   */
+  takeScreenshot(filePath: string, format?: 'jpg' | 'bmp'): Promise<void>;
+
   /**
    * Fires when an internal error occurs within the overlay system.
    */
@@ -5654,7 +5800,10 @@ interface IOverwolfOverlayApi extends EventEmitter {
    * @param listener - Callback with game launch event and game metadata.
    * @see {@link GameInfo}.
    */
-  on(eventName: 'game-launched', listener: (event: GameLaunchEvent, gameInfo: GameInfo) => void): this;
+  on(
+    eventName: 'game-launched',
+    listener: (event: GameLaunchEvent, gameInfo: GameInfo) => void,
+  ): this;
 
   /**
    * Fires when a registered game process terminates.
@@ -5674,7 +5823,10 @@ interface IOverwolfOverlayApi extends EventEmitter {
    *
    * @see {@link GameInfo}.
    */
-  on(eventName: 'game-exit', listener: (gameInfo: GameInfo, wasInjected: boolean) => void): this;
+  on(
+    eventName: 'game-exit',
+    listener: (gameInfo: GameInfo, wasInjected: boolean) => void,
+  ): this;
 
   /**
    * Fires when the overlay is ready and successfully injected into the game.
@@ -5694,7 +5846,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   on(
     eventName: 'game-injection-error',
-    listener: (gameInfo: GameInfo, error: string, ...args: any[]) => void
+    listener: (gameInfo: GameInfo, error: string, ...args: any[]) => void,
   ): this;
 
   /**
@@ -5710,8 +5862,8 @@ interface IOverwolfOverlayApi extends EventEmitter {
     listener: (
       window: GameWindowInfo,
       gameInfo: GameInfo,
-      focus: boolean
-    ) => void
+      focus: boolean,
+    ) => void,
   ): this;
 
   /**
@@ -5728,8 +5880,8 @@ interface IOverwolfOverlayApi extends EventEmitter {
     listener: (
       window: GameWindowInfo,
       gameInfo: GameInfo,
-      reason?: GameWindowUpdateReason
-    ) => void
+      reason?: GameWindowUpdateReason,
+    ) => void,
   ): this;
 
   /**
@@ -5742,7 +5894,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   on(
     eventName: 'game-input-interception-changed',
-    listener: (info: GameInputInterception) => void
+    listener: (info: GameInputInterception) => void,
   ): this;
 
   /**
@@ -5754,7 +5906,7 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   on(
     eventName: 'game-input-exclusive-mode-changed',
-    listener: (info: GameInputInterception) => void
+    listener: (info: GameInputInterception) => void,
   ): this;
 }
 
@@ -5832,7 +5984,7 @@ interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
   getSupportedGames(): Promise<{
     name: string;
     id: number;
-  }>;
+  }[]>;
 
   /**
    * Returns the target game's current Game Info.