@overwolf/ow-electron 22.3.2 → 22.3.13-beta.3

package/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 22.3.0
+// Type definitions for Electron 22.3.13
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -408,8 +408,6 @@ declare namespace Electron {
      * application's `Info.plist` file must define the URL scheme within the
      * `CFBundleURLTypes` key, and set `NSPrincipalClass` to `AtomApplication`.
      *
-     * You should call `event.preventDefault()` if you want to handle this event.
-     *
      * As with the `open-file` event, be sure to register a listener for the `open-url`
      * event early in your application startup to detect if the the application being
      * is being opened to handle a URL. If you register the listener in response to a
@@ -976,21 +974,14 @@ declare namespace Electron {
      * Here are some examples of return values of the various language and locale APIs
      * with different configurations:
      *
-     * * For Windows, where the application locale is German, the regional format is
-     * Finnish (Finland), and the preferred system languages from most to least
-     * preferred are French (Canada), English (US), Simplified Chinese (China),
-     * Finnish, and Spanish (Latin America):
-     *   * `app.getLocale()` returns `'de'`
-     *   * `app.getSystemLocale()` returns `'fi-FI'`
-     *   * `app.getPreferredSystemLanguages()` returns `['fr-CA', 'en-US',
-     * 'zh-Hans-CN', 'fi', 'es-419']`
-     * * On macOS, where the application locale is German, the region is Finland, and
-     * the preferred system languages from most to least preferred are French (Canada),
+     * On Windows, given application locale is German, the regional format is Finnish
+     * (Finland), and the preferred system languages from most to least preferred are
+     * French (Canada), English (US), Simplified Chinese (China), Finnish, and Spanish
+     * (Latin America):
+     *
+     * On macOS, given the application locale is German, the region is Finland, and the
+     * preferred system languages from most to least preferred are French (Canada),
      * English (US), Simplified Chinese, and Spanish (Latin America):
-     *   * `app.getLocale()` returns `'de'`
-     *   * `app.getSystemLocale()` returns `'fr-FI'`
-     *   * `app.getPreferredSystemLanguages()` returns `['fr-CA', 'en-US',
-     * 'zh-Hans-FI', 'es-419']`
      *
      * Both the available languages and regions and the possible return values differ
      * between the two operating systems.
@@ -1003,7 +994,7 @@ declare namespace Electron {
      * country code `FI` is used as the country code for preferred system languages
      * that do not have associated countries in the language name.
      */
-    getPreferredSystemLanguages(): Array<'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()' | 'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()'>;
+    getPreferredSystemLanguages(): string[];
     /**
      * The current system locale. On Windows and Linux, it is fetched using Chromium's
      * `i18n` library. On macOS, `[NSLocale currentLocale]` is used instead. To get the
@@ -3011,7 +3002,7 @@ declare namespace Electron {
     /**
      * Sets the touchBar layout for the current window. Specifying `null` or
      * `undefined` clears the touch bar. This method only has an effect if the machine
-     * has a touch bar and is running on macOS 10.12.1+.
+     * has a touch bar.
      *
      * **Note:** The TouchBar API is currently experimental and may change or be
      * removed in future Electron releases.
@@ -8608,7 +8599,7 @@ declare namespace Electron {
      * information about how to set these in the context of Electron.
      *
      * This user consent was not required until macOS 10.14 Mojave, so this method will
-     * always return `true` if your system is running 10.13 High Sierra or lower.
+     * always return `true` if your system is running 10.13 High Sierra.
      *
      * @platform darwin
      */
@@ -8616,9 +8607,6 @@ declare namespace Electron {
     /**
      * whether or not this device has the ability to use Touch ID.
      *
-     * **NOTE:** This API will return `false` on macOS systems older than Sierra
-     * 10.12.2.
-     *
      * @platform darwin
      */
     canPromptTouchID(): boolean;
@@ -8677,10 +8665,10 @@ declare namespace Electron {
     /**
      * Can be `not-determined`, `granted`, `denied`, `restricted` or `unknown`.
      *
-     * This user consent was not required on macOS 10.13 High Sierra or lower so this
-     * method will always return `granted`. macOS 10.14 Mojave or higher requires
-     * consent for `microphone` and `camera` access. macOS 10.15 Catalina or higher
-     * requires consent for `screen` access.
+     * This user consent was not required on macOS 10.13 High Sierra so this method
+     * will always return `granted`. macOS 10.14 Mojave or higher requires consent for
+     * `microphone` and `camera` access. macOS 10.15 Catalina or higher requires
+     * consent for `screen` access.
      *
      * Windows 10 has a global setting controlling `microphone` and `camera` access for
      * all win32 applications. It will always return `granted` for `screen` and for all
@@ -8798,9 +8786,6 @@ declare namespace Electron {
      * `node-keytar`, such that one would store an encryption key with `node-keytar`
      * and only fetch it if `promptTouchID()` resolves.
      *
-     * **NOTE:** This API will return a rejected Promise on macOS systems older than
-     * Sierra 10.12.2.
-     *
      * @platform darwin
      */
     promptTouchID(reason: string): Promise<void>;
@@ -11001,14 +10986,19 @@ declare namespace Electron {
     addListener(event: 'responsive', listener: Function): this;
     removeListener(event: 'responsive', listener: Function): this;
     /**
-     * Emitted when bluetooth device needs to be selected on call to
-     * `navigator.bluetooth.requestDevice`. To use `navigator.bluetooth` api
-     * `webBluetooth` should be enabled. If `event.preventDefault` is not called, first
-     * available device will be selected. `callback` should be called with `deviceId`
-     * to be selected, passing empty string to `callback` will cancel the request.
+     * Emitted when a bluetooth device needs to be selected when a call to
+     * `navigator.bluetooth.requestDevice` is made. `callback` should be called with
+     * the `deviceId` of the device to be selected.  Passing an empty string to
+     * `callback` will cancel the request.
+     *
+     * If an event listener is not added for this event, or if `event.preventDefault`
+     * is not called when handling this event, the first available device will be
+     * automatically selected.
      *
-     * If no event listener is added for this event, all bluetooth requests will be
-     * cancelled.
+     * Due to the nature of bluetooth, scanning for devices when
+     * `navigator.bluetooth.requestDevice` is called may take time and will cause
+     * `select-bluetooth-device` to fire multiple times until `callback` is called with
+     * either a device id or an empty string to cancel the request.
      */
     on(event: 'select-bluetooth-device', listener: (event: Event,
                                                     devices: BluetoothDevice[],
@@ -13507,10 +13497,10 @@ declare namespace Electron {
      */
     zoomToPageWidth?: boolean;
     /**
-     * Tab group name, allows opening the window as a native tab on macOS 10.12+.
-     * Windows with the same tabbing identifier will be grouped together. This also
-     * adds a native new tab button to your window's tab bar and allows your `app` and
-     * window to receive the `new-window-for-tab` event.
+     * Tab group name, allows opening the window as a native tab. Windows with the same
+     * tabbing identifier will be grouped together. This also adds a native new tab
+     * button to your window's tab bar and allows your `app` and window to receive the
+     * `new-window-for-tab` event.
      *
      * @platform darwin
      */
@@ -15958,8 +15948,8 @@ declare namespace Electron {
   interface TitleOptions {
     /**
      * The font family variant to display, can be `monospaced` or `monospacedDigit`.
-     * `monospaced` is available in macOS 10.15+ and `monospacedDigit` is available in
-     * macOS 10.11+.  When left blank, the title uses the default system font.
+     * `monospaced` is available in macOS 10.15+ When left blank, the title uses the
+     * default system font.
      */
     fontType?: ('monospaced' | 'monospacedDigit');
   }

package/ow-electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for ow-electron 22.3.2
+// Type definitions for ow-electron 22.3.13-beta.3
 
 import { App, BrowserWindow, Event } from 'electron'
 import { errorMonitor } from 'events';
@@ -42,6 +42,11 @@ declare namespace overwolf {
     * Client persistence phasing precent
     */
     readonly phasePercent: number
+
+    /**
+     * Overwolf installer provided UTM params
+     */
+    readonly utmParams: any;
   }
 
   interface CMPWindowOptions {
@@ -84,7 +89,7 @@ declare namespace overwolf {
     /**
      * A fake enum for all built-in packIge names
      */
-    type PackageName = 'gep';
+    type PackageName = 'gep' | 'overlay';
 
 	  /**
      * Package info
@@ -101,14 +106,14 @@ declare namespace overwolf {
       /**
        * 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,
+        listener: (event: Event, canRecover: boolean) => void
       ): this;
 
       /**
@@ -120,10 +125,10 @@ declare namespace overwolf {
        */
       on(
         eventName: 'ready',
-        listener: (event: Event, packageName: PackageName) => void,
+        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')
@@ -132,7 +137,18 @@ declare namespace overwolf {
        */
       on(
         eventName: 'package-update-pending',
-        listener: (event: Event, info: PackageInfo[]) => void,
+        listener: (event: Event, info: PackageInfo[]) => void
+      ): this;
+
+      /**
+       * Register listener for when an Overwolf Package updated
+       *
+       * @param {string | symbol} eventName Name of the node event ('updated')
+       * @returns {this} The current instance of the Overwolf Package Manager
+       */
+      on(
+        eventName: 'updated',
+        listener: (event: Event, packageName: string, version: string) => void
       ): this;
 
       /**
@@ -144,23 +160,30 @@ declare namespace overwolf {
        */
       on(
         eventName: 'failed-to-initialize',
-        listener: (event: Event, packageName: PackageName) => void,
+        listener: (event: Event, packageName: PackageName) => void
       ): this;
 
-	    /**
-       * Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates. 
-	     *
+      /**
+       * 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;
+       */
+      relaunch(): void;
 
       /**
        * @property {packages.IOverwolfGameEventPackage} gep The Game Events Provider Package Instance
-	     * note: available once 'ready' is fired.
+       * note: available once 'ready' is fired.
        */
       readonly gep: packages.OverwolfGameEventPackage;
     }
 
+    /**
+     * Game Events game detection Event
+     */
+     export interface GepGameLaunchEvent {
+      enable: (() => void);
+    }
+
     /**
      * Game Events Package interface
      */
@@ -232,7 +255,7 @@ declare namespace overwolf {
 
       /**
        * Register listener for a game being detected.
-       * Calling `event.preventDefault()` will prevent the Game Events Provider Package from connecting to the game.
+       * Calling `event.enable()` to start gep for this 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
@@ -240,7 +263,7 @@ declare namespace overwolf {
        */
       on(
         eventName: 'game-detected',
-        listener: (event: Event, gameId: number, name: string, ...args: any[]) => void,
+        listener: (event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void,
       ): this;
 
       /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@overwolf/ow-electron",
-  "version": "22.3.2",
-  "owElectronVersion": "22.3.2",
+  "version": "22.3.13-beta.3",
+  "owElectronVersion": "22.3.13-beta.3",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "license": "MIT",
@@ -25,5 +25,8 @@
   },
   "engines": {
     "node": ">= 10.17.0"
+  },
+  "publishConfig": {
+    "tag": "beta"
   }
 }