@overwolf/ow-electron-packages-types 1.0.6 → 1.1.0-beta.4

package/gep-supported-games.d.ts

@@ -1,34 +1,60 @@
 export const enum kGepSupportedGameIds {
   ApexLegends = 21566,
+  ArcRaiders = 27168,
+  ArknightsEF = 27724,
   BaldursGateIII = 22088,
   BlackMythWukong = 24504,
+  CoDGI = 27860,
+  CallofDutyModernWarfareII = 22328,
+  CallofDutyVanguard = 21876,
   ContentWarning = 24110,
   CS2 = 22730,
+  DarkandDarker = 22584,
+  Deadlock = 24482,
   DiabloIV = 22700,
   Dota2 = 7314,
+  ELDENRINGNIGHTREIGN = 25918,
+  EscapeFromTarkov = 21634,
   FinalFantasyXIVOnline = 6350,
   Fortnite = 21216,
   GenshinImpact = 21656,
-  HadesII = 24218,
-  HaloInfinite = 21854,
+  HearthstoneHeroesofWarcraft = 9898,
   HELLDIVERS2 = 24000,
   HonkaiStarRail = 22804,
   LeagueofLegends = 5426,
   LeagueofLegendsPBE = 22848,
   LethalCompany = 23522,
-  ManorLords = 24176,
+  LostArk = 21864,
+  MagictheGatheringArena = 21308,
+  MarvelRivals = 24890,
   Minecraft = 8032,
+  MinecraftBedrock = 22176,
+  MHWilds = 25446,
+  NewWorld = 21816,
   OnceHuman = 23930,
   Overwatch = 10844,
   Palworld = 23944,
   PathofExile = 7212,
-  Stormgate = 23818,
+  PathofExile2 = 24886,
+  PEAK = 26092,
+  PUBG = 10906,
+  REPO = 25448,
+  Rainbow6Siege = 10826,
+  REMATCH = 26120,
+  Roblox = 4688,
+  RobloxMicrosoftedition = 22174,
+  RocketLeague = 10798,
+  ScheduleI = 25610,
+  SonsoftheForest = 22638,
+  Splitgate2 = 25884,
+  StreetFighter6 = 22894,
+  SUPERVIVE = 24346,
   TeamfightTactics = 21570,
   TheFinals = 23478,
-  TheFirstDescendant = 24360,
-  RocketLeague = 10798,
   VALORANT = 21640,
+  Warframe = 8954,
   Warhammer40000SpaceMarine2 = 24548,
-  WutheringWaves = 24300,
   WoW = 765,
-}
+  WutheringWaves = 24300,
+  XKO = 26840,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.0.6",
+    "version": "1.1.0-beta.4",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",
@@ -30,5 +30,8 @@
         "./gep-supported-games": {
             "types": "./gep-supported-games.d.ts"
         }
+    },
+    "dependencies": {
+        "glob": "^13.0.0"
     }
 }

package/types.d.ts

@@ -61,6 +61,22 @@ interface IOverwolfUtilityApi {
    */
   scan(filter?: GamesFilter): Promise<InstalledGameInfo[]>;
 
+   /**
+   * install ow-electron helpers to
+   * %CommonProgramFiles%\<app-name>\ with UAC elevation.
+   * will allow us to inject into high elevation games
+   * No-ops if files are already present.
+   * @throws {HelperInstallError} exitCode 1223 — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws {HelperInstallError} any other non-zero exitCode — installation failed
+   */
+  installHighElevationHelper(): Promise<void>;
+
+  /**
+   * Returns true if ow-electron helpers is already installed in
+   * %CommonProgramFiles%\<app-name>\.
+   */
+  isHighElevationHelperInstalled(): Promise<boolean>;
+
   /**
    * Fires when a tracked game is launched.
    *
@@ -490,7 +506,15 @@ type CaptureSourceType =
   /**
    * Capture a specific application window.
    */
-  | 'Window';
+  | 'Window'
+  /**
+   * Capture a specific image.
+   */
+  | 'Image'
+  /**
+   * Capture a solid color screen.
+   */
+  | 'Color';
 
 
 
@@ -2011,7 +2035,9 @@ export interface AudioNoiseSuppressFilterV2 extends AudioFilterBase {
  * This type uses the `id` property as a type discriminator. When used in a switch 
  * statement or conditional, TypeScript will narrow the `parameters` to the 
  * specific interface associated with that ID.
- * * @example
+ * 
+ * For more information about the filter types, see [OBS Audio Filters](https://obsproject.com/kb/filters-guide#:~:text=the%20Source%20image-,Audio/Video%20Filters,-Compressor).
+ *  @example
  * ```typescript
  * function applyFilter(filter: AudioFilter) {
  * if (filter.id === 'gain_filter') {
@@ -2672,6 +2698,44 @@ interface WindowCaptureSourceSettings extends CaptureSourceSettings {
   compatibility?: boolean;
 }
 
+/**
+ * Settings for capturing a static image as a source.
+ * 
+ * Extends {@link CaptureSourceSettings} with image-specific options such as file path.
+ * 
+ * @see CaptureSourceSettings
+ */
+export interface ImageCaptureSourceSettings extends CaptureSourceSettings {
+  /**
+   * Image file path.
+   */
+  path: string;
+}
+
+/**
+ * Settings for capturing a solid color as a source.
+ * 
+ * Extends {@link CaptureSourceSettings} with color-specific options such as color value, width, and height.
+ * 
+ * @see CaptureSourceSettings
+ */
+export interface ColorCaptureSourceSettings extends CaptureSourceSettings {
+  /**
+   * Color in #RRGGBBAA format. (red green blue alpha)
+   */
+  color: string;
+
+  /**
+   * Width in pixels
+   */
+  width: number;
+
+  /**
+   * Height in pixels
+   */
+  height: number;
+}
+
 /**
  * Information about a generic capture source configuration, used for identifying and configuring
  * a video capture input such as a display, game, or application window.
@@ -2775,6 +2839,54 @@ interface WindowCaptureSource extends CaptureSource {
   readonly properties: WindowCaptureSourceSettings;
 }
 
+/**
+ * Image-based capture source configuration.
+ * 
+ * Extends {@link CaptureSource} with the `'Image'` type and
+ * configuration options for capturing a static image file.
+ */
+export interface ImageCaptureSource extends CaptureSource {
+  /**
+   * The capture source type.
+   * 
+   * Always set to `'Image'` for this interface.
+   */
+  readonly type: 'Image';
+
+  /**
+   * Configuration settings for image capture.
+   * 
+   * Includes file path.
+   * 
+   * @see ImageCaptureSourceSettings
+   */
+  readonly properties: ImageCaptureSourceSettings;
+}
+
+/**
+ * Color-based capture source configuration.
+ * 
+ * Extends {@link CaptureSource} with the `'Color'` type and
+ * configuration options for capturing a solid color.
+ */
+export interface ColorCaptureSource extends CaptureSource {
+  /**
+   * The capture source type.
+   * 
+   * Always set to `'Color'` for this interface.
+   */
+  readonly type: 'Color';
+
+  /**
+   * Configuration settings for color capture.
+   * 
+   * Includes color value, width, and height.
+   * 
+   * @see ColorCaptureSourceSettings
+   */
+  readonly properties: ColorCaptureSourceSettings;
+}
+
 
 /**
  * Configuration for all audio-related settings.
@@ -3377,7 +3489,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @returns The builder instance for chaining.
    */
   addScreenSource(
-    settings: MonitorCaptureSourceSettings
+    settings: MonitorCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3394,7 +3506,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @param settings
    */
   addWindowSource(
-    settings: WindowCaptureSourceSettings
+    settings: WindowCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3405,9 +3517,21 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addBrowserWindowSource(
     browserWindow: BrowserWindow,
-    setting: WindowCaptureSourceSettings
+    setting: WindowCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
+  /**
+   * Add Image capture source
+   * @param settings
+   */
+  addImageSource(settings: ImageCaptureSourceSettings): CaptureSettingsBuilder;
+
+  /**
+   * Add Color capture source
+   * @param settings
+   */
+  addColorSource(settings: ColorCaptureSourceSettings): CaptureSettingsBuilder;
+
   /**
    * Adds an audio device for capturing input or output audio.
    *
@@ -3417,7 +3541,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addAudioCapture(
     params: AudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3431,7 +3555,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
   addAudioDefaultCapture(
     type: AudioDeviceType,
     params?: DefaultAudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3443,7 +3567,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addApplicationAudioCapture(
     param: ApplicationAudioCaptureParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -4701,6 +4825,14 @@ interface OverlayWindowOptions
  *   modifiers: { ctrl: true, alt: true },
  *   passthrough: false
  * };
+ *
+ * // Since 1.13.3: use W3C KeyboardEvent.code strings (preferred, layout-independent)
+ * const toggleHotkey: IOverlayHotkey = {
+ *   name: 'toggle',
+ *   keyCode: 'KeyF',
+ *   modifiers: { ctrl: true, custom: 'Tab' },
+ *   passthrough: true
+ * };
  * ```
  */
 interface IOverlayHotkey {
@@ -4710,16 +4842,21 @@ interface IOverlayHotkey {
   name: string;
 
   /**
-   * Primary key code for the hotkey. Use standard keyboard codes.
+   * Primary key code for the hotkey.
+   *
+   * Accepts a numeric Windows Virtual-Key code or, since 1.13.3, a W3C
+   * `KeyboardEvent.code` string (e.g. `'KeyA'`, `'F10'`, `'ArrowUp'`).
+   * String values are resolved to VK codes at registration time; an unknown
+   * string throws an error.
    */
-  keyCode: number;
+  keyCode: number | string;
 
   /**
    * Modifier keys that must be pressed along with the main key.
    */
   modifiers?: {
     /**
-     * Used for `alt` ket.
+     * Used for `alt` key.
      */
     alt?: boolean;
     /**
@@ -4731,9 +4868,11 @@ interface IOverlayHotkey {
      */
     shift?: boolean;
     /**
-     * Custom key binding. Use key code.
+     * Custom key binding. Accepts a numeric Windows Virtual-Key code or,
+     * since 1.13.3, a W3C `KeyboardEvent.code` string (same format as
+     * `keyCode`).
      */
-    custom?: number;
+    custom?: number | string;
     /**
      * Use for the `windows` or `command` key.
      */
@@ -4742,10 +4881,10 @@ interface IOverlayHotkey {
 
   /**
    * Controls whether the hotkey will be passed through to the underlying game.
-   * 
+   *
    * - If `true`, the hotkey will be captured by the overlay and pass to the game.
    * - If `false`, the hotkey will be captured exclusively by the overlay.
-   * 
+   *
    * @default false
    */
   passthrough?: boolean;
@@ -5302,6 +5441,22 @@ interface IOverwolfOverlayApi extends EventEmitter {
    */
   exitExclusiveMode(): void;
 
+   /**
+   * install ow-electron helpers to
+   * %CommonProgramFiles%\<app-name>\ with UAC elevation.
+   * will allow us to inject into high elevation games
+   * No-ops if files are already present.
+   * @throws {HelperInstallError} exitCode 1223 — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws {HelperInstallError} any other non-zero exitCode — installation failed
+   */
+  installHighElevationHelper(): Promise<void>;
+
+  /**
+   * Returns true if ow-electron helpers is already installed in
+   * %CommonProgramFiles%\<app-name>\.
+   */
+  isHighElevationHelperInstalled(): Promise<boolean>;
+
   /**
    * Fires when an internal error occurs within the overlay system.
    */