@overwolf/ow-electron-packages-types 0.2.0-beta.2 → 0.2.1-beta.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "0.2.0-beta.2",
+    "version": "0.2.1-beta.0",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",

package/types.d.ts

@@ -96,6 +96,7 @@ interface OWPackages extends overwolf.packages.OverwolfPackageManager {
   recorder: IOverwolfRecordingApi;
   overlay: IOverwolfOverlayApi;
   utility: IOverwolfUtilityApi;
+  crn: IOverwolfCRNApi;
 }
 
 /**
@@ -169,8 +170,38 @@ interface IOverlayHotkey {
   passthrough?: boolean;
 }
 
+/**
+ * options for the `GameLaunchEvent`. 
+ * ability to override some game settings in runtime.
+ *
+ * @see GameLaunchEvent
+ * @since 1.8.0
+ */
+export interface GameLaunchEventOptions {
+  /**
+   * Force OOPO mode (when oopo is false in game list).
+   * @default false
+   */
+  forceOOPO?: boolean;
+
+  /**
+   * Force OOPO mouse Mixed mode control.
+   * @default false
+   */
+  forceOOPOMixedMode?: boolean;
+}
+
 interface GameLaunchEvent {
-  inject: () => void;
+  /**
+   * Inject the overlay into the game.
+   * @param options - options for the `GameLaunchEvent` since 1.8.0.
+   */
+  inject: (options?: GameLaunchEventOptions) => void;
+
+  /**
+   * Dismiss the overlay.
+   */
+  dismiss: () => void;
 }
 
 /**
@@ -783,6 +814,13 @@ interface AudioDeviceSettingsInfo extends AudioDeviceSettings {
   readonly name: string;
 }
 
+export interface AudioDeviceSettingsUpdateInfo  extends AudioDeviceSettings {
+   /**
+   * Audio device unique name or Process name for application
+   */
+   readonly name: string;
+}
+
 interface ApplicationAudioDeviceSettingsInfo
   extends AudioDeviceSettingsInfo {
   readonly type: 'output';
@@ -1608,6 +1646,21 @@ interface IOverwolfRecordingApi {
    */
   options: RecordingAppOptions;
 
+  /**
+   * Overlay package version
+   */
+  readonly version: string;
+
+  /**
+   * Path to ffmpeg executable
+   */
+  readonly ffmpegPath: string;
+
+  /**
+   * Path to bin folder
+   */
+  readonly binFolderPath: string;
+
   /**
    * Is recording or replays active
    */
@@ -1741,6 +1794,17 @@ interface IOverwolfRecordingApi {
    */
   registerGames(filter: GamesFilter);
 
+  /**
+   * Update audio device settings while recording
+   * (for example, volume, mute, etc.) by device name.
+   *
+   * @param device
+   * @since 0.32.0
+   */
+  updateAudioDevice(
+    device: AudioDeviceSettingsUpdateInfo
+  ): Promise<void>;
+
   /**
    * Fired when registered game is detected
    */
@@ -1788,3 +1852,98 @@ interface IOverwolfRecordingApi {
    */
   on(eventName: 'stats', listener: (args: RecorderStats) => void): this;
 }
+
+// -----------------------------------------------------------------------------
+// Overwolf CRN API
+
+export interface ICRNEvent {
+  abort: () => void;
+}
+
+/**
+ * All supported notification actions.
+ */
+export type CRNActionType =
+  /**
+   * User clicked on the `X` button to dismiss the notification.
+   */
+  | 'Dismissed'
+  /**
+   * Notification closed due to launching another game while the notification is displayed.
+   */
+  | 'IgnoredByLaunchingGame'
+  /**
+   * Notification automatically closed after no user action was registered.
+   */
+  | 'Timeout'
+  /**
+   * User clicked on `Turn off notifications` from the cogwheel icon.
+   */
+  | 'TurnOffNotificationsRequested'
+  /**
+   * User clicked on a notification that opens an external URL (e.g., newsletter site).
+   */
+  | 'OpenExternalUrl'
+  /**
+   * User clicked on a notification that downloads an external app.
+   */
+  | 'DownloadExternalApp'
+  /**
+   * User clicked on the `Cancel` button while the external app was downloading.
+   */
+  | 'CancelDownloadExternalApp'
+  /**
+   * User clicked on the `X` button while the external app was downloading.
+   */
+  | 'CloseClickedWhileDownloadingExternalApp'
+  /**
+   * Developer programmatically closed the notification using the `closeNotificationWindow()` method.
+   */
+  | 'ForceClosed';
+
+export interface IOverwolfCRNApi {
+  /**
+   * returns Notification visible status.
+   * true if the notification is currently visible, false if not.
+   */
+  isNotificationVisible(): Promise<boolean>;
+
+  /**
+   * returns Notification settings status:
+   * true if notifications are allowed, false if not.
+   */
+  getNotificationStatus(): Promise<boolean>;
+
+  /**
+   * Closes the notification.
+   */
+  closeNotificationWindow(): void;
+
+  /**
+   * Enables or disables notifications.
+   * @param enable - true to enable notifications, false to disable.
+   */
+  allowNotifications(enable: boolean): void;
+
+  /**
+   * Fired before a notification is shown.
+   * @param eventName
+   * @param listener
+   */
+  on(
+    eventName: 'before-notification',
+    listener: (event: ICRNEvent, args: any) => void
+  ): this;
+
+  /**
+   * Fired when a notification action is triggered.
+   * @param eventName
+   * @param listener
+   */
+  on(
+    eventName: 'notification-action',
+    listener: (event: CRNActionType) => void
+  ): this;
+}
+
+// -----------------------------------------------------------------------------