@overwolf/ow-electron 22.3.3 → 22.3.13-beta.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/electron.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for Electron 22.3.3
1
+ // Type definitions for Electron 22.3.13
2
2
  // Project: http://electronjs.org/
3
3
  // Definitions by: The Electron Team <https://github.com/electron/electron>
4
4
  // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -974,21 +974,14 @@ declare namespace Electron {
974
974
  * Here are some examples of return values of the various language and locale APIs
975
975
  * with different configurations:
976
976
  *
977
- * * For Windows, where the application locale is German, the regional format is
978
- * Finnish (Finland), and the preferred system languages from most to least
979
- * preferred are French (Canada), English (US), Simplified Chinese (China),
980
- * Finnish, and Spanish (Latin America):
981
- * * `app.getLocale()` returns `'de'`
982
- * * `app.getSystemLocale()` returns `'fi-FI'`
983
- * * `app.getPreferredSystemLanguages()` returns `['fr-CA', 'en-US',
984
- * 'zh-Hans-CN', 'fi', 'es-419']`
985
- * * On macOS, where the application locale is German, the region is Finland, and
986
- * the preferred system languages from most to least preferred are French (Canada),
977
+ * On Windows, given application locale is German, the regional format is Finnish
978
+ * (Finland), and the preferred system languages from most to least preferred are
979
+ * French (Canada), English (US), Simplified Chinese (China), Finnish, and Spanish
980
+ * (Latin America):
981
+ *
982
+ * On macOS, given the application locale is German, the region is Finland, and the
983
+ * preferred system languages from most to least preferred are French (Canada),
987
984
  * English (US), Simplified Chinese, and Spanish (Latin America):
988
- * * `app.getLocale()` returns `'de'`
989
- * * `app.getSystemLocale()` returns `'fr-FI'`
990
- * * `app.getPreferredSystemLanguages()` returns `['fr-CA', 'en-US',
991
- * 'zh-Hans-FI', 'es-419']`
992
985
  *
993
986
  * Both the available languages and regions and the possible return values differ
994
987
  * between the two operating systems.
@@ -1001,7 +994,7 @@ declare namespace Electron {
1001
994
  * country code `FI` is used as the country code for preferred system languages
1002
995
  * that do not have associated countries in the language name.
1003
996
  */
1004
- getPreferredSystemLanguages(): Array<'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()' | 'app.getLocale()' | 'app.getSystemLocale()' | 'app.getPreferredSystemLanguages()'>;
997
+ getPreferredSystemLanguages(): string[];
1005
998
  /**
1006
999
  * The current system locale. On Windows and Linux, it is fetched using Chromium's
1007
1000
  * `i18n` library. On macOS, `[NSLocale currentLocale]` is used instead. To get the
@@ -10993,14 +10986,19 @@ declare namespace Electron {
10993
10986
  addListener(event: 'responsive', listener: Function): this;
10994
10987
  removeListener(event: 'responsive', listener: Function): this;
10995
10988
  /**
10996
- * Emitted when bluetooth device needs to be selected on call to
10997
- * `navigator.bluetooth.requestDevice`. To use `navigator.bluetooth` api
10998
- * `webBluetooth` should be enabled. If `event.preventDefault` is not called, first
10999
- * available device will be selected. `callback` should be called with `deviceId`
11000
- * to be selected, passing empty string to `callback` will cancel the request.
10989
+ * Emitted when a bluetooth device needs to be selected when a call to
10990
+ * `navigator.bluetooth.requestDevice` is made. `callback` should be called with
10991
+ * the `deviceId` of the device to be selected. Passing an empty string to
10992
+ * `callback` will cancel the request.
10993
+ *
10994
+ * If an event listener is not added for this event, or if `event.preventDefault`
10995
+ * is not called when handling this event, the first available device will be
10996
+ * automatically selected.
11001
10997
  *
11002
- * If no event listener is added for this event, all bluetooth requests will be
11003
- * cancelled.
10998
+ * Due to the nature of bluetooth, scanning for devices when
10999
+ * `navigator.bluetooth.requestDevice` is called may take time and will cause
11000
+ * `select-bluetooth-device` to fire multiple times until `callback` is called with
11001
+ * either a device id or an empty string to cancel the request.
11004
11002
  */
11005
11003
  on(event: 'select-bluetooth-device', listener: (event: Event,
11006
11004
  devices: BluetoothDevice[],
package/ow-electron.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // Type definitions for ow-electron 22.3.3
1
+ // Type definitions for ow-electron 22.3.13-beta.4
2
2
 
3
3
  import { App, BrowserWindow, Event } from 'electron'
4
4
  import { errorMonitor } from 'events';
@@ -89,7 +89,7 @@ declare namespace overwolf {
89
89
  /**
90
90
  * A fake enum for all built-in packIge names
91
91
  */
92
- type PackageName = 'gep';
92
+ type PackageName = 'gep' | 'overlay';
93
93
 
94
94
  /**
95
95
  * Package info
@@ -106,14 +106,14 @@ declare namespace overwolf {
106
106
  /**
107
107
  * Register listener for Overwolf Package crashes.
108
108
  * Calling `event.preventDefault()` will prevent the package from automatically attempting to re-launch itself.
109
- *
109
+ *
110
110
  * @param {string | symbol} eventName Name of the node event ('crashed')
111
111
  * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
112
112
  * @returns {this} The current instance of the Overwolf Package Manager
113
113
  */
114
114
  on(
115
115
  eventName: 'crashed',
116
- listener: (event: Event, canRecover: boolean) => void,
116
+ listener: (event: Event, canRecover: boolean) => void
117
117
  ): this;
118
118
 
119
119
  /**
@@ -125,10 +125,10 @@ declare namespace overwolf {
125
125
  */
126
126
  on(
127
127
  eventName: 'ready',
128
- listener: (event: Event, packageName: PackageName) => void,
128
+ listener: (event: Event, packageName: PackageName) => void
129
129
  ): this;
130
130
 
131
- /**
131
+ /**
132
132
  * Register listener for when an Overwolf Package is ready to update
133
133
  *
134
134
  * @param {string | symbol} eventName Name of the node event ('package-update-pending')
@@ -137,7 +137,18 @@ declare namespace overwolf {
137
137
  */
138
138
  on(
139
139
  eventName: 'package-update-pending',
140
- listener: (event: Event, info: PackageInfo[]) => void,
140
+ listener: (event: Event, info: PackageInfo[]) => void
141
+ ): this;
142
+
143
+ /**
144
+ * Register listener for when an Overwolf Package updated
145
+ *
146
+ * @param {string | symbol} eventName Name of the node event ('updated')
147
+ * @returns {this} The current instance of the Overwolf Package Manager
148
+ */
149
+ on(
150
+ eventName: 'updated',
151
+ listener: (event: Event, packageName: string, version: string) => void
141
152
  ): this;
142
153
 
143
154
  /**
@@ -149,23 +160,30 @@ declare namespace overwolf {
149
160
  */
150
161
  on(
151
162
  eventName: 'failed-to-initialize',
152
- listener: (event: Event, packageName: PackageName) => void,
163
+ listener: (event: Event, packageName: PackageName) => void
153
164
  ): this;
154
165
 
155
- /**
156
- * Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates.
157
- *
166
+ /**
167
+ * Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates.
168
+ *
158
169
  * *The Overwolf Package Manager will automatically relaunch itself if an update is available and no package is currently running.*
159
- */
160
- relaunch(): void;
170
+ */
171
+ relaunch(): void;
161
172
 
162
173
  /**
163
174
  * @property {packages.IOverwolfGameEventPackage} gep The Game Events Provider Package Instance
164
- * note: available once 'ready' is fired.
175
+ * note: available once 'ready' is fired.
165
176
  */
166
177
  readonly gep: packages.OverwolfGameEventPackage;
167
178
  }
168
179
 
180
+ /**
181
+ * Game Events game detection Event
182
+ */
183
+ export interface GepGameLaunchEvent {
184
+ enable: (() => void);
185
+ }
186
+
169
187
  /**
170
188
  * Game Events Package interface
171
189
  */
@@ -237,7 +255,7 @@ declare namespace overwolf {
237
255
 
238
256
  /**
239
257
  * Register listener for a game being detected.
240
- * Calling `event.preventDefault()` will prevent the Game Events Provider Package from connecting to the game.
258
+ * Calling `event.enable()` to start gep for this game.
241
259
  *
242
260
  * @param {string | symbol} eventName Name of the node event ('game-detected')
243
261
  * @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
@@ -245,7 +263,7 @@ declare namespace overwolf {
245
263
  */
246
264
  on(
247
265
  eventName: 'game-detected',
248
- listener: (event: Event, gameId: number, name: string, ...args: any[]) => void,
266
+ listener: (event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void,
249
267
  ): this;
250
268
 
251
269
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@overwolf/ow-electron",
3
- "version": "22.3.3",
4
- "owElectronVersion": "22.3.3",
3
+ "version": "22.3.13-beta.4",
4
+ "owElectronVersion": "22.3.13-beta.4",
5
5
  "repository": "https://github.com/electron/electron",
6
6
  "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
7
7
  "license": "MIT",
@@ -25,5 +25,8 @@
25
25
  },
26
26
  "engines": {
27
27
  "node": ">= 10.17.0"
28
+ },
29
+ "publishConfig": {
30
+ "tag": "beta"
28
31
  }
29
32
  }