@overwolf/ow-electron-packages-types 1.0.3 → 1.1.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.0.3",
+    "version": "1.1.0-beta.2",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",
@@ -33,5 +33,8 @@
     },
     "publishConfig": {
         "tag": "beta"
+    },
+    "dependencies": {
+        "glob": "^13.0.0"
     }
-}
+}

package/types.d.ts

@@ -490,7 +490,15 @@ type CaptureSourceType =
   /**
    * Capture a specific application window.
    */
-  | 'Window';
+  | 'Window'
+  /**
+   * Capture a specific image.
+   */
+  | 'Image'
+  /**
+   * Capture a solid color screen.
+   */
+  | 'Color';
 
 
 
@@ -2011,7 +2019,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 +2682,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 +2823,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 +3473,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @returns The builder instance for chaining.
    */
   addScreenSource(
-    settings: MonitorCaptureSourceSettings
+    settings: MonitorCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3394,7 +3490,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @param settings
    */
   addWindowSource(
-    settings: WindowCaptureSourceSettings
+    settings: WindowCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3405,9 +3501,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 +3525,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addAudioCapture(
     params: AudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3431,7 +3539,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
   addAudioDefaultCapture(
     type: AudioDeviceType,
     params?: DefaultAudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3443,7 +3551,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addApplicationAudioCapture(
     param: ApplicationAudioCaptureParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -4701,6 +4809,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 +4826,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 +4852,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 +4865,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;