@overwolf/ow-electron 22.0.3 → 22.3.0

package/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for ow-electron 22.0.3
+// Type definitions for Electron 22.3.0
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -1536,7 +1536,8 @@ declare namespace Electron {
      * WOW).
      *
      * You can use this property to prompt users to download the arm64 version of your
-     * application when they are running the x64 version under Rosetta incorrectly.
+     * application when they are mistakenly running the x64 version under Rosetta or
+     * WOW.
      *
      * @platform darwin,win32
      */
@@ -1566,62 +1567,6 @@ declare namespace Electron {
      * app's initialization to ensure that your overridden value is used.
      */
     userAgentFallback: string;
-
-    /**
-     * Overwolf additional api's
-     */
-    overwolf: OverwolfApi;
-  }
-
-  interface OverwolfApi {
-    /**
-     * Disable sending any anonymous analytics,
-     * this should be call before app.ready
-    */
-    disableAnonymousAnalytics(): void;
-
-    /**
-     * Returns true if the current user should be able to update their cmp
-     * configurations (i.e. openCMPWindow).
-     *
-     * Note that this is an async function and should be called with await.
-     * The function will never throw an exception - the default value is true.
-     */
-    isCMPRequired() : Promise<boolean>;
-
-    /**
-     * Opens the CMP configuration window - should only be called when
-     * isCMPRequired returns true.
-     */
-    openCMPWindow(options?: CMPWindowOptions): Promise<void>;
-  }
-
-  interface CMPWindowOptions {
-    /**
-     * Select open tab. The default is 'purposes'
-    */
-    tab? : ['purposes' | 'features' | 'vendors']
-
-    /**
-    * Whether this is a modal window. This only works when the window is a child
-    * window. Default is `false`.
-    */
-    modal?: boolean;
-
-    /**
-     * Specify parent window. Default is `null`.
-    */
-    parent?: BrowserWindow;
-
-    /**
-    * Show window in the center of the screen. Default is `true`.
-    */
-    center?: boolean;
-
-    /**
-     * Control the CMP preloader background window
-     */
-    backgroundColor?: string;
   }
 
   interface AutoUpdater extends NodeJS.EventEmitter {
@@ -2481,11 +2426,11 @@ declare namespace Electron {
      */
     isEnabled(): boolean;
     /**
-     * Returns whether the window can be focused.
+     * Whether the window can be focused.
      *
      * @platform darwin,win32
      */
-    isFocusable(): void;
+    isFocusable(): boolean;
     /**
      * Whether the window is focused.
      */
@@ -2499,6 +2444,12 @@ declare namespace Electron {
      * window.
      */
     isFullScreenable(): boolean;
+    /**
+     * Whether the window will be hidden when the user toggles into mission control.
+     *
+     * @platform darwin
+     */
+    isHiddenInMissionControl(): boolean;
     /**
      * Whether the window is in kiosk mode.
      */
@@ -2833,6 +2784,13 @@ declare namespace Electron {
      * Sets whether the window should have a shadow.
      */
     setHasShadow(hasShadow: boolean): void;
+    /**
+     * Sets whether the window will be hidden when the user toggles into mission
+     * control.
+     *
+     * @platform darwin
+     */
+    setHiddenInMissionControl(hidden: boolean): void;
     /**
      * Changes window icon.
      *
@@ -4501,6 +4459,10 @@ declare namespace Electron {
      * `true` for an internal display and `false` for an external display
      */
     internal: boolean;
+    /**
+     * User-friendly label, determined by the platform.
+     */
+    label: string;
     /**
      * Whether or not the display is a monochrome display.
      */
@@ -8226,7 +8188,7 @@ declare namespace Electron {
      * `setPermissionCheckHandler` to get complete permission handling. Most web APIs
      * do a permission check and then make a permission request if the check is denied.
      */
-    setPermissionRequestHandler(handler: ((webContents: WebContents, permission: 'clipboard-read' | 'media' | 'display-capture' | 'mediaKeySystem' | 'geolocation' | 'notifications' | 'midi' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'window-placement' | 'unknown', callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
+    setPermissionRequestHandler(handler: ((webContents: WebContents, permission: 'clipboard-read' | 'clipboard-sanitized-write' | 'media' | 'display-capture' | 'mediaKeySystem' | 'geolocation' | 'notifications' | 'midi' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'window-placement' | 'unknown', callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
     /**
      * Adds scripts that will be executed on ALL web contents that are associated with
      * this session just before normal `preload` scripts run.
@@ -13383,6 +13345,12 @@ declare namespace Electron {
      * @platform darwin,win32
      */
     skipTaskbar?: boolean;
+    /**
+     * Whether window should be hidden when the user toggles into mission control.
+     *
+     * @platform darwin
+     */
+    hiddenInMissionControl?: boolean;
     /**
      * Whether the window is in kiosk mode. Default is `false`.
      */
@@ -13597,9 +13565,9 @@ declare namespace Electron {
      */
     origin?: string;
     /**
-     * The types of storages to clear, can contain: `appcache`, `cookies`,
-     * `filesystem`, `indexdb`, `localstorage`, `shadercache`, `websql`,
-     * `serviceworkers`, `cachestorage`. If not specified, clear all storage types.
+     * The types of storages to clear, can contain: `cookies`, `filesystem`, `indexdb`,
+     * `localstorage`, `shadercache`, `websql`, `serviceworkers`, `cachestorage`. If
+     * not specified, clear all storage types.
      */
     storages?: string[];
     /**
@@ -16310,8 +16278,9 @@ declare namespace Electron {
      */
     footer?: string;
     /**
-     * Specify page size of the printed document. Can be `A3`, `A4`, `A5`, `Legal`,
-     * `Letter`, `Tabloid` or an Object containing `height` and `width`.
+     * Specify page size of the printed document. Can be `A0`, `A1`, `A2`, `A3`, `A4`,
+     * `A5`, `A6`, `Legal`, `Letter`, `Tabloid` or an Object containing `height` and
+     * `width`.
      */
     pageSize?: (string) | (Size);
   }

package/ow-electron.d.ts

@@ -0,0 +1,309 @@
+// Type definitions for ow-electron 22.3.0
+
+import { App, BrowserWindow, Event } from 'electron'
+import { errorMonitor } from 'events';
+
+declare namespace overwolf {
+  interface OverwolfApp extends App {
+    /**
+     * Overwolf additional api's
+     */
+    overwolf: OverwolfApi;
+  }
+
+  interface OverwolfApi {
+    /**
+     * Disable sending any anonymous analytics,
+     * this should be call before app.ready
+     */
+    disableAnonymousAnalytics(): void;
+
+    /**
+     * Returns true if the current user should be able to update their cmp
+     * configurations (i.e. openCMPWindow).
+     *
+     * Note that this is an async function and should be called with await.
+     * The function will never throw an exception - the default value is true.
+     */
+    isCMPRequired(): Promise<boolean>;
+
+    /**
+     * Opens the CMP configuration window - should only be called when
+     * isCMPRequired returns true.
+     */
+    openCMPWindow(options?: CMPWindowOptions): Promise<void>;
+
+    /**
+     * The Overwolf Package Manager instance
+     */
+    packages: overwolf.packages.OverwolfPackageManager;
+
+    /**
+    * Client persistence phasing precent
+    */
+    readonly phasePercent: number
+  }
+
+  interface CMPWindowOptions {
+    /**
+     * Select open tab. The default is 'purposes'
+    */
+    tab?: 'purposes' | 'features' | 'vendors';
+
+    /**
+    * Whether this is a modal window. This only works when the window is a child
+    * window. Default is `false`.
+    */
+    modal?: boolean;
+
+    /**
+     * Specify parent window. Default is `null`.
+     */
+    parent?: BrowserWindow;
+
+    /**
+     * Show window in the center of the screen. Default is `true`.
+     */
+    center?: boolean;
+
+    /**
+     * Control the CMP preloader background window
+     */
+    backgroundColor?: string;
+  }
+
+  /**
+   * A utility type for registering to `error` events, that includes the `errorMonitor` type
+   */
+  type error = 'error' | typeof errorMonitor;
+
+  /**
+   * Namespace containing everything related to Overwolf Packages
+   */
+  namespace packages {
+    /**
+     * A fake enum for all built-in packIge names
+     */
+    type PackageName = 'gep';
+
+	  /**
+     * Package info
+     */
+	  interface PackageInfo {
+      name: string;
+      version: string;
+    }
+
+    /**
+     * Overwolf Package Manager interface
+     */
+    interface OverwolfPackageManager extends NodeJS.EventEmitter {
+      /**
+       * Register listener for Overwolf Package crashes.
+       * Calling `event.preventDefault()` will prevent the package from automatically attempting to re-launch itself.
+       * 
+       * @param {string | symbol} eventName Name of the node event ('crashed')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Package Manager
+       */
+      on(
+        eventName: 'crashed',
+        listener: (event: Event, canRecover: boolean) => void,
+      ): this;
+
+      /**
+       * Register listener for when an Overwolf Package is ready
+       *
+       * @param {string | symbol} eventName Name of the node event ('ready')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Package Manager
+       */
+      on(
+        eventName: 'ready',
+        listener: (event: Event, packageName: PackageName) => void,
+      ): this;
+
+	    /**
+       * Register listener for when an Overwolf Package is ready to update
+       *
+       * @param {string | symbol} eventName Name of the node event ('package-update-pending')
+       * @param {(Event, PackageInfo[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Package Manager
+       */
+      on(
+        eventName: 'package-update-pending',
+        listener: (event: Event, info: PackageInfo[]) => void,
+      ): this;
+
+      /**
+       * Register listener for Overwolf Package initialization failures
+       *
+       * @param {string | symbol} eventName Name of the node event ('failed-to-initialize')
+       * @param {(Event, any[]) => void} listener **The listener that will be invoked when this event is fired**
+       * @returns {this} The current instance of the Overwolf Package Manager
+       */
+      on(
+        eventName: 'failed-to-initialize',
+        listener: (event: Event, packageName: PackageName) => void,
+      ): this;
+
+	    /**
+       * Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates. 
+	     *
+       * *The Overwolf Package Manager will automatically relaunch itself if an update is available and no package is currently running.*
+	     */
+	    relaunch(): void;
+
+      /**
+       * @property {packages.IOverwolfGameEventPackage} gep The Game Events Provider Package Instance
+	     * note: available once 'ready' is fired.
+       */
+      readonly gep: packages.OverwolfGameEventPackage;
+    }
+
+    /**
+     * Game Events Package interface
+     */
+    interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
+      /**
+       * Returns an array of supported Game Event Features for a game
+       *
+       * @param {number} gameId Game ID of the targeted game
+       * @returns {Promise<string[]>} Promise resolving to an array of supported game features
+       */
+      getFeatures(gameId: number): Promise<string[]>;
+
+      /**
+       * Sets the requires Game Event Features for a given game ID
+       *
+       * @param {number} gameId Game ID of the targeted game
+       * @param {string[] | undefined} features Array of required Game Event Features
+       * @returns {Promise<void>} Promise reporting the success of the operation
+       */
+      setRequiredFeatures(
+        gameId: number,
+        features: string[] | undefined,
+      ): Promise<void>;
+
+      /**
+       * Returns an array of Game Events supported games
+       *
+       * @returns {Promise<{
+       *  name: string;
+       *  id: number;
+       * }>} Promise resolving to an array of supported games
+       */
+      getSupportedGames(): Promise<{
+        name: string;
+        id: number;
+      }>;
+
+      /**
+       * Returns the target game's current Game Info
+       *
+       * @param {number} gameId Game ID of the targeted game
+       * @returns {Promise<any>} Promise resolving to the targeted game's current Game Info
+       */
+      getInfo(gameId: number): Promise<any>;
+
+      /**
+       * Register listener for Game Info Updates
+       *
+       * @param {string | symbol} eventName Name of the node event ('new-info-update')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Game Events Package
+       */
+      on(
+        eventName: 'new-info-update',
+        listener: (event: Event, gameId: number, data: gep.InfoUpdate) => void,
+      ): this;
+
+      /**
+       * Register listener for New Game Events
+       *
+       * @param {string | symbol} eventName Name of the node event ('new-game-event')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Game Events Package
+       */
+      on(
+        eventName: 'new-game-event',
+        listener: (event: Event, gameId: number, data: gep.GameEvent) => void,
+      ): this;
+
+      /**
+       * Register listener for a game being detected.
+       * Calling `event.preventDefault()` will prevent the Game Events Provider Package from connecting to the game.
+       *
+       * @param {string | symbol} eventName Name of the node event ('game-detected')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Game Events Package
+       */
+      on(
+        eventName: 'game-detected',
+        listener: (event: Event, gameId: number, name: string, ...args: any[]) => void,
+      ): this;
+
+      /**
+       * Register listener for when a detected game is ran as adminstrator.
+       * If this fires, it means the app must also run as adminstrator in order for Game Events to be detected.
+       *
+       * @param {string | symbol} eventName Name of the node event ('elevated-privileges-required')
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Game Events Package
+       */
+      on(
+        eventName: 'elevated-privileges-required',
+        listener: (event: Event, gameId: number, name: string, pid: number) => void,
+      ): this;
+
+      /**
+       * Register listener for errors thrown by the Game Events Provider Package
+       *
+       * @param {string | symbol} eventName Name of the node event ('error' or the `errorMonitor` symbol)
+       * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
+       * @returns {this} The current instance of the Overwolf Game Events Package
+       */
+      on(
+        eventName: error,
+        listener: (event: Event, gameId: number, error: string, ...args: any[]) => void,
+      ): this;
+    }
+
+    /**
+     * Namespace for GEP-related interfaces
+     */
+    namespace gep {
+      /**
+       * Interface defining a Game Event's structure
+       */
+      interface GameEvent {
+        /**
+         * @property {number} gameId The game id of the game the Event comes from
+         */
+        gameId: number;
+        /**
+         * @property {string} feature The feature the Event belongs to
+         */
+        feature: string;
+        /**
+         * @property {string} key The name of the Event
+         */
+        key: string;
+        /**
+         * @property {any} value The value of the Event
+         */
+        value: any;
+      }
+
+      /**
+       * Interface defining an Info Update's structure
+       */
+      interface InfoUpdate extends GameEvent {
+        /**
+         * @property {string} category The category the Info Item belongs to
+         */
+        category: string;
+      }
+    }
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@overwolf/ow-electron",
-  "version": "22.0.3",
-  "owElectronVersion": "22.0.3",
+  "version": "22.3.0",
+  "owElectronVersion": "22.3.0",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "license": "MIT",
@@ -11,7 +11,7 @@
     "overwolf electron"
   ],
   "main": "index.js",
-  "types": "electron.d.ts",
+  "types": "ow-electron.d.ts",
   "bin": {
     "ow-electron": "cli.js"
   },