@overwolf/ow-electron-packages-types 1.0.1-beta.1 → 1.0.1-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.0.1-beta.1",
+    "version": "1.0.1-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';
 
 
 
@@ -2672,6 +2680,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 #AARRGGBB format. (alpha red green blue)
+   */
+  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 +2821,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 +3471,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @returns The builder instance for chaining.
    */
   addScreenSource(
-    settings: MonitorCaptureSourceSettings
+    settings: MonitorCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3394,7 +3488,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    * @param settings
    */
   addWindowSource(
-    settings: WindowCaptureSourceSettings
+    settings: WindowCaptureSourceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3405,9 +3499,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 +3523,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addAudioCapture(
     params: AudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3431,7 +3537,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
   addAudioDefaultCapture(
     type: AudioDeviceType,
     params?: DefaultAudioDeviceParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**
@@ -3443,7 +3549,7 @@ interface CaptureSettingsBuilder extends CaptureSettings {
    */
   addApplicationAudioCapture(
     param: ApplicationAudioCaptureParams,
-    settings?: AudioDeviceSettings
+    settings?: AudioDeviceSettings,
   ): CaptureSettingsBuilder;
 
   /**