@overwolf/ow-electron 28.3.5-beta.0 → 28.3.5
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/README.md +1 -1
- package/checksums.json +7 -7
- package/ow-electron.d.ts +374 -374
- package/package.json +2 -5
package/README.md
CHANGED
|
@@ -7,7 +7,7 @@ We currently have these npm packages:
|
|
|
7
7
|
few features to it
|
|
8
8
|
- [@overwolf/ow-electron-builder](https://www.npmjs.com/package/@overwolf/ow-electron-builder) is a packaged based on electron-builder which
|
|
9
9
|
supports building ow-electron
|
|
10
|
-
- @overwolf/electron-is-overwolf - similar to
|
|
10
|
+
- [@overwolf/electron-is-overwolf](https://www.npmjs.com/package/@overwolf/electron-is-overwolf) - similar to
|
|
11
11
|
[electron-is-dev](https://www.npmjs.com/package/electron-is-dev)
|
|
12
12
|
|
|
13
13
|
There is no problem that both packages reside side-by-side with the original
|
package/checksums.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"electron-api.json": "a6e536d48e399f0961cb5de1e9cb0d3e534c4686fdf6fc79080e66516fdd5b6e",
|
|
3
|
-
"ow-electron-v28.3.5-
|
|
4
|
-
"ow-electron-v28.3.5-
|
|
5
|
-
"ow-electron-v28.3.5-
|
|
6
|
-
"ow-electron-v28.3.5-
|
|
7
|
-
"ow-electron-v28.3.5-
|
|
8
|
-
"ow-electron-v28.3.5-
|
|
9
|
-
"ow-electron-v28.3.5-
|
|
3
|
+
"ow-electron-v28.3.5-darwin-arm64.zip": "866d4e95adb5d4e67fc4a3bd8cebf0f4331c8f005dc1b1996183f21f82574803",
|
|
4
|
+
"ow-electron-v28.3.5-darwin-x64.zip": "a725791c60b6f34a5ad783940d1db0e154a2ddf12926b5afb4919e3452928bfa",
|
|
5
|
+
"ow-electron-v28.3.5-win32-x64.zip": "56ba85f295010a1cacf3ad54d085e657e83b5236dc2602584288d8c8b0fb2aba",
|
|
6
|
+
"ow-electron-v28.3.5-win32-ia32.zip": "9d016b77e7034a236776208da5329a7ff21dc8a8eaf059722fade46ec69b4d64",
|
|
7
|
+
"ow-electron-v28.3.5-linux-x64.zip": "20f6be493cbd6c9924206e744b1c490af1f97f4735451b9dc19f0d305366d546",
|
|
8
|
+
"ow-electron-v28.3.5-linux-arm64.zip": "f77107266581a6b9880757876518df1c4bf6eeff5c193bb5de0a8f6c9902bd1f",
|
|
9
|
+
"ow-electron-v28.3.5-linux-armv7l.zip": "384d8b43f52b5350a438031ad12980418fc244b4b0aecfa5f7dcc3d6f103ebed",
|
|
10
10
|
"electron.d.ts": "101ab7d71613c50d940d19664633af7b043d651fb0b82e46c3b09e5a5f5a79df"
|
|
11
11
|
}
|
package/ow-electron.d.ts
CHANGED
|
@@ -1,374 +1,374 @@
|
|
|
1
|
-
// Type definitions for ow-electron 28.3.
|
|
2
|
-
|
|
3
|
-
import { App, BrowserWindow, Event, WebviewTag } from 'electron'
|
|
4
|
-
import { errorMonitor } from 'events';
|
|
5
|
-
|
|
6
|
-
declare namespace overwolf {
|
|
7
|
-
interface OverwolfApp extends App {
|
|
8
|
-
/**
|
|
9
|
-
* Overwolf additional api's
|
|
10
|
-
*/
|
|
11
|
-
overwolf: OverwolfApi;
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
interface OverwolfApi {
|
|
15
|
-
/**
|
|
16
|
-
* Disable sending any anonymous analytics,
|
|
17
|
-
* this should be call before app.ready
|
|
18
|
-
*/
|
|
19
|
-
disableAnonymousAnalytics(): void;
|
|
20
|
-
|
|
21
|
-
/**
|
|
22
|
-
* Returns true if the current user should be able to update their cmp
|
|
23
|
-
* configurations (i.e. openCMPWindow).
|
|
24
|
-
*
|
|
25
|
-
* Note that this is an async function and should be called with await.
|
|
26
|
-
* The function will never throw an exception - the default value is true.
|
|
27
|
-
*/
|
|
28
|
-
isCMPRequired(): Promise<boolean>;
|
|
29
|
-
|
|
30
|
-
/**
|
|
31
|
-
* Opens the CMP configuration window - should only be called when
|
|
32
|
-
* isCMPRequired returns true.
|
|
33
|
-
*/
|
|
34
|
-
openCMPWindow(options?: CMPWindowOptions): Promise<void>;
|
|
35
|
-
|
|
36
|
-
/**
|
|
37
|
-
* The Overwolf Package Manager instance
|
|
38
|
-
*/
|
|
39
|
-
packages: overwolf.packages.OverwolfPackageManager;
|
|
40
|
-
|
|
41
|
-
/**
|
|
42
|
-
* Generate a hashed email, to allow for better ad performance,
|
|
43
|
-
* this should be call after app.ready
|
|
44
|
-
* NOTE: the email is not stored! only the hashed email.
|
|
45
|
-
*/
|
|
46
|
-
generateUserEmailHashes(email: string): EmailHashes;
|
|
47
|
-
|
|
48
|
-
/**
|
|
49
|
-
* Set the user email hashes (see generateUserEmailHashes),
|
|
50
|
-
* this should be call after app.ready
|
|
51
|
-
* See https://www.chromium.org/developers/design-documents/accessibility for more
|
|
52
|
-
* details how to normalize email before creating hash
|
|
53
|
-
*/
|
|
54
|
-
setUserEmailHashes(emailHashes: EmailHashes): void;
|
|
55
|
-
|
|
56
|
-
/**
|
|
57
|
-
* Client persistence phasing precent
|
|
58
|
-
*/
|
|
59
|
-
readonly phasePercent: number;
|
|
60
|
-
|
|
61
|
-
/**
|
|
62
|
-
* Overwolf installer provided UTM params
|
|
63
|
-
*/
|
|
64
|
-
readonly utmParams: any;
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
interface CMPWindowOptions {
|
|
68
|
-
/**
|
|
69
|
-
* Select open tab. The default is 'purposes'
|
|
70
|
-
*/
|
|
71
|
-
tab?: 'purposes' | 'features' | 'vendors';
|
|
72
|
-
|
|
73
|
-
/**
|
|
74
|
-
* Whether this is a modal window. This only works when the window is a child
|
|
75
|
-
* window. Default is `false`.
|
|
76
|
-
*/
|
|
77
|
-
modal?: boolean;
|
|
78
|
-
|
|
79
|
-
/**
|
|
80
|
-
* Specify parent window. Default is `null`.
|
|
81
|
-
*/
|
|
82
|
-
parent?: BrowserWindow;
|
|
83
|
-
|
|
84
|
-
/**
|
|
85
|
-
* Show window in the center of the screen. Default is `true`.
|
|
86
|
-
*/
|
|
87
|
-
center?: boolean;
|
|
88
|
-
|
|
89
|
-
/**
|
|
90
|
-
* Control the CMP preloader background window
|
|
91
|
-
*/
|
|
92
|
-
backgroundColor?: string;
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* Control the CMP Window width
|
|
96
|
-
*/
|
|
97
|
-
width?: number;
|
|
98
|
-
|
|
99
|
-
/**
|
|
100
|
-
* Control the CMP Window height
|
|
101
|
-
*/
|
|
102
|
-
height?: number;
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
interface EmailHashes {
|
|
106
|
-
readonly sha1: string;
|
|
107
|
-
readonly sha256: string;
|
|
108
|
-
readonly md5: string;
|
|
109
|
-
}
|
|
110
|
-
|
|
111
|
-
/**
|
|
112
|
-
* A utility type for registering to `error` events, that includes the `errorMonitor` type
|
|
113
|
-
*/
|
|
114
|
-
type error = 'error' | typeof errorMonitor;
|
|
115
|
-
|
|
116
|
-
/**
|
|
117
|
-
* Namespace containing everything related to Overwolf Packages
|
|
118
|
-
*/
|
|
119
|
-
namespace packages {
|
|
120
|
-
/**
|
|
121
|
-
* A fake enum for all built-in packIge names
|
|
122
|
-
*/
|
|
123
|
-
type PackageName = 'gep' | 'overlay' | 'recorder';
|
|
124
|
-
|
|
125
|
-
/**
|
|
126
|
-
* Package info
|
|
127
|
-
*/
|
|
128
|
-
interface PackageInfo {
|
|
129
|
-
name: string;
|
|
130
|
-
version: string;
|
|
131
|
-
}
|
|
132
|
-
|
|
133
|
-
/**
|
|
134
|
-
* Overwolf Package Manager interface
|
|
135
|
-
*/
|
|
136
|
-
interface OverwolfPackageManager extends NodeJS.EventEmitter {
|
|
137
|
-
/**
|
|
138
|
-
* Register listener for Overwolf Package crashes.
|
|
139
|
-
* Calling `event.preventDefault()` will prevent the package from automatically attempting to re-launch itself.
|
|
140
|
-
*
|
|
141
|
-
* @param {string | symbol} eventName Name of the node event ('crashed')
|
|
142
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
143
|
-
* @returns {this} The current instance of the Overwolf Package Manager
|
|
144
|
-
*/
|
|
145
|
-
on(
|
|
146
|
-
eventName: 'crashed',
|
|
147
|
-
listener: (event: Event, canRecover: boolean) => void
|
|
148
|
-
): this;
|
|
149
|
-
|
|
150
|
-
/**
|
|
151
|
-
* Register listener for when an Overwolf Package is ready
|
|
152
|
-
*
|
|
153
|
-
* @param {string | symbol} eventName Name of the node event ('ready')
|
|
154
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
155
|
-
* @returns {this} The current instance of the Overwolf Package Manager
|
|
156
|
-
*/
|
|
157
|
-
on(
|
|
158
|
-
eventName: 'ready',
|
|
159
|
-
listener: (event: Event, packageName: PackageName, version: string) => void
|
|
160
|
-
): this;
|
|
161
|
-
|
|
162
|
-
/**
|
|
163
|
-
* Register listener for when an Overwolf Package is ready to update
|
|
164
|
-
*
|
|
165
|
-
* @param {string | symbol} eventName Name of the node event ('package-update-pending')
|
|
166
|
-
* @param {(Event, PackageInfo[]) => void} listener The listener that will be invoked when this event is fired
|
|
167
|
-
* @returns {this} The current instance of the Overwolf Package Manager
|
|
168
|
-
*/
|
|
169
|
-
on(
|
|
170
|
-
eventName: 'package-update-pending',
|
|
171
|
-
listener: (event: Event, info: PackageInfo[]) => void
|
|
172
|
-
): this;
|
|
173
|
-
|
|
174
|
-
/**
|
|
175
|
-
* Register listener for when an Overwolf Package updated
|
|
176
|
-
*
|
|
177
|
-
* @param {string | symbol} eventName Name of the node event ('updated')
|
|
178
|
-
* @returns {this} The current instance of the Overwolf Package Manager
|
|
179
|
-
*/
|
|
180
|
-
on(
|
|
181
|
-
eventName: 'updated',
|
|
182
|
-
listener: (event: Event, packageName: string, version: string) => void
|
|
183
|
-
): this;
|
|
184
|
-
|
|
185
|
-
/**
|
|
186
|
-
* Register listener for Overwolf Package initialization failures
|
|
187
|
-
*
|
|
188
|
-
* @param {string | symbol} eventName Name of the node event ('failed-to-initialize')
|
|
189
|
-
* @param {(Event, any[]) => void} listener **The listener that will be invoked when this event is fired**
|
|
190
|
-
* @returns {this} The current instance of the Overwolf Package Manager
|
|
191
|
-
*/
|
|
192
|
-
on(
|
|
193
|
-
eventName: 'failed-to-initialize',
|
|
194
|
-
listener: (event: Event, packageName: PackageName) => void
|
|
195
|
-
): this;
|
|
196
|
-
|
|
197
|
-
/**
|
|
198
|
-
* Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates.
|
|
199
|
-
*
|
|
200
|
-
* *The Overwolf Package Manager will automatically relaunch itself if an update is available and no package is currently running.*
|
|
201
|
-
*/
|
|
202
|
-
relaunch(): void;
|
|
203
|
-
|
|
204
|
-
/**
|
|
205
|
-
* @property {packages.IOverwolfGameEventPackage} gep The Game Events Provider Package Instance
|
|
206
|
-
* note: available once 'ready' is fired.
|
|
207
|
-
*/
|
|
208
|
-
readonly gep: packages.OverwolfGameEventPackage;
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
/**
|
|
212
|
-
* Game Events game detection Event
|
|
213
|
-
*/
|
|
214
|
-
export interface GepGameLaunchEvent {
|
|
215
|
-
enable: (() => void);
|
|
216
|
-
}
|
|
217
|
-
|
|
218
|
-
/**
|
|
219
|
-
* Game Events Package interface
|
|
220
|
-
*/
|
|
221
|
-
interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
|
|
222
|
-
/**
|
|
223
|
-
* Returns an array of supported Game Event Features for a game
|
|
224
|
-
*
|
|
225
|
-
* @param {number} gameId Game ID of the targeted game
|
|
226
|
-
* @returns {Promise<string[]>} Promise resolving to an array of supported game features
|
|
227
|
-
*/
|
|
228
|
-
getFeatures(gameId: number): Promise<string[]>;
|
|
229
|
-
|
|
230
|
-
/**
|
|
231
|
-
* Sets the requires Game Event Features for a given game ID
|
|
232
|
-
*
|
|
233
|
-
* @param {number} gameId Game ID of the targeted game
|
|
234
|
-
* @param {string[] | undefined} features Array of required Game Event Features
|
|
235
|
-
* @returns {Promise<void>} Promise reporting the success of the operation
|
|
236
|
-
*/
|
|
237
|
-
setRequiredFeatures(
|
|
238
|
-
gameId: number,
|
|
239
|
-
features: string[] | undefined,
|
|
240
|
-
): Promise<void>;
|
|
241
|
-
|
|
242
|
-
/**
|
|
243
|
-
* Returns an array of Game Events supported games
|
|
244
|
-
*
|
|
245
|
-
* @returns {Promise<{
|
|
246
|
-
* name: string;
|
|
247
|
-
* id: number;
|
|
248
|
-
* }>} Promise resolving to an array of supported games
|
|
249
|
-
*/
|
|
250
|
-
getSupportedGames(): Promise<{
|
|
251
|
-
name: string;
|
|
252
|
-
id: number;
|
|
253
|
-
}>;
|
|
254
|
-
|
|
255
|
-
/**
|
|
256
|
-
* Returns the target game's current Game Info
|
|
257
|
-
*
|
|
258
|
-
* @param {number} gameId Game ID of the targeted game
|
|
259
|
-
* @returns {Promise<any>} Promise resolving to the targeted game's current Game Info
|
|
260
|
-
*/
|
|
261
|
-
getInfo(gameId: number): Promise<any>;
|
|
262
|
-
|
|
263
|
-
/**
|
|
264
|
-
* Register listener for Game Info Updates
|
|
265
|
-
*
|
|
266
|
-
* @param {string | symbol} eventName Name of the node event ('new-info-update')
|
|
267
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
268
|
-
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
269
|
-
*/
|
|
270
|
-
on(
|
|
271
|
-
eventName: 'new-info-update',
|
|
272
|
-
listener: (event: Event, gameId: number, data: gep.InfoUpdate) => void,
|
|
273
|
-
): this;
|
|
274
|
-
|
|
275
|
-
/**
|
|
276
|
-
* Register listener for New Game Events
|
|
277
|
-
*
|
|
278
|
-
* @param {string | symbol} eventName Name of the node event ('new-game-event')
|
|
279
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
280
|
-
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
281
|
-
*/
|
|
282
|
-
on(
|
|
283
|
-
eventName: 'new-game-event',
|
|
284
|
-
listener: (event: Event, gameId: number, data: gep.GameEvent) => void,
|
|
285
|
-
): this;
|
|
286
|
-
|
|
287
|
-
/**
|
|
288
|
-
* Register listener for a game being detected.
|
|
289
|
-
* Calling `event.enable()` to start gep for this game.
|
|
290
|
-
*
|
|
291
|
-
* @param {string | symbol} eventName Name of the node event ('game-detected')
|
|
292
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
293
|
-
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
294
|
-
*/
|
|
295
|
-
on(
|
|
296
|
-
eventName: 'game-detected',
|
|
297
|
-
listener: (event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void,
|
|
298
|
-
): this;
|
|
299
|
-
|
|
300
|
-
/**
|
|
301
|
-
* Register listener for when a detected game is ran as adminstrator.
|
|
302
|
-
* If this fires, it means the app must also run as adminstrator in order for Game Events to be detected.
|
|
303
|
-
*
|
|
304
|
-
* @param {string | symbol} eventName Name of the node event ('elevated-privileges-required')
|
|
305
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
306
|
-
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
307
|
-
*/
|
|
308
|
-
on(
|
|
309
|
-
eventName: 'elevated-privileges-required',
|
|
310
|
-
listener: (event: Event, gameId: number, name: string, pid: number) => void,
|
|
311
|
-
): this;
|
|
312
|
-
|
|
313
|
-
/**
|
|
314
|
-
* Register listener for errors thrown by the Game Events Provider Package
|
|
315
|
-
*
|
|
316
|
-
* @param {string | symbol} eventName Name of the node event ('error' or the `errorMonitor` symbol)
|
|
317
|
-
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
318
|
-
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
319
|
-
*/
|
|
320
|
-
on(
|
|
321
|
-
eventName: error,
|
|
322
|
-
listener: (event: Event, gameId: number, error: string, ...args: any[]) => void,
|
|
323
|
-
): this;
|
|
324
|
-
}
|
|
325
|
-
|
|
326
|
-
/**
|
|
327
|
-
* Namespace for GEP-related interfaces
|
|
328
|
-
*/
|
|
329
|
-
namespace gep {
|
|
330
|
-
/**
|
|
331
|
-
* Interface defining a Game Event's structure
|
|
332
|
-
*/
|
|
333
|
-
interface GameEvent {
|
|
334
|
-
/**
|
|
335
|
-
* @property {number} gameId The game id of the game the Event comes from
|
|
336
|
-
*/
|
|
337
|
-
gameId: number;
|
|
338
|
-
/**
|
|
339
|
-
* @property {string} feature The feature the Event belongs to
|
|
340
|
-
*/
|
|
341
|
-
feature: string;
|
|
342
|
-
/**
|
|
343
|
-
* @property {string} key The name of the Event
|
|
344
|
-
*/
|
|
345
|
-
key: string;
|
|
346
|
-
/**
|
|
347
|
-
* @property {any} value The value of the Event
|
|
348
|
-
*/
|
|
349
|
-
value: any;
|
|
350
|
-
}
|
|
351
|
-
|
|
352
|
-
/**
|
|
353
|
-
* Interface defining an Info Update's structure
|
|
354
|
-
*/
|
|
355
|
-
interface InfoUpdate extends GameEvent {
|
|
356
|
-
/**
|
|
357
|
-
* @property {string} category The category the Info Item belongs to
|
|
358
|
-
*/
|
|
359
|
-
category: string;
|
|
360
|
-
}
|
|
361
|
-
}
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
interface AdviewTag extends HTMLElement {
|
|
365
|
-
}
|
|
366
|
-
|
|
367
|
-
namespace Renderer {
|
|
368
|
-
type AdviewTag = overwolf.AdviewTag;
|
|
369
|
-
}
|
|
370
|
-
}
|
|
371
|
-
|
|
372
|
-
interface Document {
|
|
373
|
-
createElement(tagName: 'owadview'): overwolf.AdviewTag;
|
|
374
|
-
}
|
|
1
|
+
// Type definitions for ow-electron 28.3.5
|
|
2
|
+
|
|
3
|
+
import { App, BrowserWindow, Event, WebviewTag } from 'electron'
|
|
4
|
+
import { errorMonitor } from 'events';
|
|
5
|
+
|
|
6
|
+
declare namespace overwolf {
|
|
7
|
+
interface OverwolfApp extends App {
|
|
8
|
+
/**
|
|
9
|
+
* Overwolf additional api's
|
|
10
|
+
*/
|
|
11
|
+
overwolf: OverwolfApi;
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
interface OverwolfApi {
|
|
15
|
+
/**
|
|
16
|
+
* Disable sending any anonymous analytics,
|
|
17
|
+
* this should be call before app.ready
|
|
18
|
+
*/
|
|
19
|
+
disableAnonymousAnalytics(): void;
|
|
20
|
+
|
|
21
|
+
/**
|
|
22
|
+
* Returns true if the current user should be able to update their cmp
|
|
23
|
+
* configurations (i.e. openCMPWindow).
|
|
24
|
+
*
|
|
25
|
+
* Note that this is an async function and should be called with await.
|
|
26
|
+
* The function will never throw an exception - the default value is true.
|
|
27
|
+
*/
|
|
28
|
+
isCMPRequired(): Promise<boolean>;
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Opens the CMP configuration window - should only be called when
|
|
32
|
+
* isCMPRequired returns true.
|
|
33
|
+
*/
|
|
34
|
+
openCMPWindow(options?: CMPWindowOptions): Promise<void>;
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* The Overwolf Package Manager instance
|
|
38
|
+
*/
|
|
39
|
+
packages: overwolf.packages.OverwolfPackageManager;
|
|
40
|
+
|
|
41
|
+
/**
|
|
42
|
+
* Generate a hashed email, to allow for better ad performance,
|
|
43
|
+
* this should be call after app.ready
|
|
44
|
+
* NOTE: the email is not stored! only the hashed email.
|
|
45
|
+
*/
|
|
46
|
+
generateUserEmailHashes(email: string): EmailHashes;
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Set the user email hashes (see generateUserEmailHashes),
|
|
50
|
+
* this should be call after app.ready
|
|
51
|
+
* See https://www.chromium.org/developers/design-documents/accessibility for more
|
|
52
|
+
* details how to normalize email before creating hash
|
|
53
|
+
*/
|
|
54
|
+
setUserEmailHashes(emailHashes: EmailHashes): void;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Client persistence phasing precent
|
|
58
|
+
*/
|
|
59
|
+
readonly phasePercent: number;
|
|
60
|
+
|
|
61
|
+
/**
|
|
62
|
+
* Overwolf installer provided UTM params
|
|
63
|
+
*/
|
|
64
|
+
readonly utmParams: any;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
interface CMPWindowOptions {
|
|
68
|
+
/**
|
|
69
|
+
* Select open tab. The default is 'purposes'
|
|
70
|
+
*/
|
|
71
|
+
tab?: 'purposes' | 'features' | 'vendors';
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Whether this is a modal window. This only works when the window is a child
|
|
75
|
+
* window. Default is `false`.
|
|
76
|
+
*/
|
|
77
|
+
modal?: boolean;
|
|
78
|
+
|
|
79
|
+
/**
|
|
80
|
+
* Specify parent window. Default is `null`.
|
|
81
|
+
*/
|
|
82
|
+
parent?: BrowserWindow;
|
|
83
|
+
|
|
84
|
+
/**
|
|
85
|
+
* Show window in the center of the screen. Default is `true`.
|
|
86
|
+
*/
|
|
87
|
+
center?: boolean;
|
|
88
|
+
|
|
89
|
+
/**
|
|
90
|
+
* Control the CMP preloader background window
|
|
91
|
+
*/
|
|
92
|
+
backgroundColor?: string;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* Control the CMP Window width
|
|
96
|
+
*/
|
|
97
|
+
width?: number;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Control the CMP Window height
|
|
101
|
+
*/
|
|
102
|
+
height?: number;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
interface EmailHashes {
|
|
106
|
+
readonly sha1: string;
|
|
107
|
+
readonly sha256: string;
|
|
108
|
+
readonly md5: string;
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
/**
|
|
112
|
+
* A utility type for registering to `error` events, that includes the `errorMonitor` type
|
|
113
|
+
*/
|
|
114
|
+
type error = 'error' | typeof errorMonitor;
|
|
115
|
+
|
|
116
|
+
/**
|
|
117
|
+
* Namespace containing everything related to Overwolf Packages
|
|
118
|
+
*/
|
|
119
|
+
namespace packages {
|
|
120
|
+
/**
|
|
121
|
+
* A fake enum for all built-in packIge names
|
|
122
|
+
*/
|
|
123
|
+
type PackageName = 'gep' | 'overlay' | 'recorder';
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* Package info
|
|
127
|
+
*/
|
|
128
|
+
interface PackageInfo {
|
|
129
|
+
name: string;
|
|
130
|
+
version: string;
|
|
131
|
+
}
|
|
132
|
+
|
|
133
|
+
/**
|
|
134
|
+
* Overwolf Package Manager interface
|
|
135
|
+
*/
|
|
136
|
+
interface OverwolfPackageManager extends NodeJS.EventEmitter {
|
|
137
|
+
/**
|
|
138
|
+
* Register listener for Overwolf Package crashes.
|
|
139
|
+
* Calling `event.preventDefault()` will prevent the package from automatically attempting to re-launch itself.
|
|
140
|
+
*
|
|
141
|
+
* @param {string | symbol} eventName Name of the node event ('crashed')
|
|
142
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
143
|
+
* @returns {this} The current instance of the Overwolf Package Manager
|
|
144
|
+
*/
|
|
145
|
+
on(
|
|
146
|
+
eventName: 'crashed',
|
|
147
|
+
listener: (event: Event, canRecover: boolean) => void
|
|
148
|
+
): this;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* Register listener for when an Overwolf Package is ready
|
|
152
|
+
*
|
|
153
|
+
* @param {string | symbol} eventName Name of the node event ('ready')
|
|
154
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
155
|
+
* @returns {this} The current instance of the Overwolf Package Manager
|
|
156
|
+
*/
|
|
157
|
+
on(
|
|
158
|
+
eventName: 'ready',
|
|
159
|
+
listener: (event: Event, packageName: PackageName, version: string) => void
|
|
160
|
+
): this;
|
|
161
|
+
|
|
162
|
+
/**
|
|
163
|
+
* Register listener for when an Overwolf Package is ready to update
|
|
164
|
+
*
|
|
165
|
+
* @param {string | symbol} eventName Name of the node event ('package-update-pending')
|
|
166
|
+
* @param {(Event, PackageInfo[]) => void} listener The listener that will be invoked when this event is fired
|
|
167
|
+
* @returns {this} The current instance of the Overwolf Package Manager
|
|
168
|
+
*/
|
|
169
|
+
on(
|
|
170
|
+
eventName: 'package-update-pending',
|
|
171
|
+
listener: (event: Event, info: PackageInfo[]) => void
|
|
172
|
+
): this;
|
|
173
|
+
|
|
174
|
+
/**
|
|
175
|
+
* Register listener for when an Overwolf Package updated
|
|
176
|
+
*
|
|
177
|
+
* @param {string | symbol} eventName Name of the node event ('updated')
|
|
178
|
+
* @returns {this} The current instance of the Overwolf Package Manager
|
|
179
|
+
*/
|
|
180
|
+
on(
|
|
181
|
+
eventName: 'updated',
|
|
182
|
+
listener: (event: Event, packageName: string, version: string) => void
|
|
183
|
+
): this;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* Register listener for Overwolf Package initialization failures
|
|
187
|
+
*
|
|
188
|
+
* @param {string | symbol} eventName Name of the node event ('failed-to-initialize')
|
|
189
|
+
* @param {(Event, any[]) => void} listener **The listener that will be invoked when this event is fired**
|
|
190
|
+
* @returns {this} The current instance of the Overwolf Package Manager
|
|
191
|
+
*/
|
|
192
|
+
on(
|
|
193
|
+
eventName: 'failed-to-initialize',
|
|
194
|
+
listener: (event: Event, packageName: PackageName) => void
|
|
195
|
+
): this;
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates.
|
|
199
|
+
*
|
|
200
|
+
* *The Overwolf Package Manager will automatically relaunch itself if an update is available and no package is currently running.*
|
|
201
|
+
*/
|
|
202
|
+
relaunch(): void;
|
|
203
|
+
|
|
204
|
+
/**
|
|
205
|
+
* @property {packages.IOverwolfGameEventPackage} gep The Game Events Provider Package Instance
|
|
206
|
+
* note: available once 'ready' is fired.
|
|
207
|
+
*/
|
|
208
|
+
readonly gep: packages.OverwolfGameEventPackage;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Game Events game detection Event
|
|
213
|
+
*/
|
|
214
|
+
export interface GepGameLaunchEvent {
|
|
215
|
+
enable: (() => void);
|
|
216
|
+
}
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* Game Events Package interface
|
|
220
|
+
*/
|
|
221
|
+
interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
|
|
222
|
+
/**
|
|
223
|
+
* Returns an array of supported Game Event Features for a game
|
|
224
|
+
*
|
|
225
|
+
* @param {number} gameId Game ID of the targeted game
|
|
226
|
+
* @returns {Promise<string[]>} Promise resolving to an array of supported game features
|
|
227
|
+
*/
|
|
228
|
+
getFeatures(gameId: number): Promise<string[]>;
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* Sets the requires Game Event Features for a given game ID
|
|
232
|
+
*
|
|
233
|
+
* @param {number} gameId Game ID of the targeted game
|
|
234
|
+
* @param {string[] | undefined} features Array of required Game Event Features
|
|
235
|
+
* @returns {Promise<void>} Promise reporting the success of the operation
|
|
236
|
+
*/
|
|
237
|
+
setRequiredFeatures(
|
|
238
|
+
gameId: number,
|
|
239
|
+
features: string[] | undefined,
|
|
240
|
+
): Promise<void>;
|
|
241
|
+
|
|
242
|
+
/**
|
|
243
|
+
* Returns an array of Game Events supported games
|
|
244
|
+
*
|
|
245
|
+
* @returns {Promise<{
|
|
246
|
+
* name: string;
|
|
247
|
+
* id: number;
|
|
248
|
+
* }>} Promise resolving to an array of supported games
|
|
249
|
+
*/
|
|
250
|
+
getSupportedGames(): Promise<{
|
|
251
|
+
name: string;
|
|
252
|
+
id: number;
|
|
253
|
+
}>;
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Returns the target game's current Game Info
|
|
257
|
+
*
|
|
258
|
+
* @param {number} gameId Game ID of the targeted game
|
|
259
|
+
* @returns {Promise<any>} Promise resolving to the targeted game's current Game Info
|
|
260
|
+
*/
|
|
261
|
+
getInfo(gameId: number): Promise<any>;
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* Register listener for Game Info Updates
|
|
265
|
+
*
|
|
266
|
+
* @param {string | symbol} eventName Name of the node event ('new-info-update')
|
|
267
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
268
|
+
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
269
|
+
*/
|
|
270
|
+
on(
|
|
271
|
+
eventName: 'new-info-update',
|
|
272
|
+
listener: (event: Event, gameId: number, data: gep.InfoUpdate) => void,
|
|
273
|
+
): this;
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Register listener for New Game Events
|
|
277
|
+
*
|
|
278
|
+
* @param {string | symbol} eventName Name of the node event ('new-game-event')
|
|
279
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
280
|
+
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
281
|
+
*/
|
|
282
|
+
on(
|
|
283
|
+
eventName: 'new-game-event',
|
|
284
|
+
listener: (event: Event, gameId: number, data: gep.GameEvent) => void,
|
|
285
|
+
): this;
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* Register listener for a game being detected.
|
|
289
|
+
* Calling `event.enable()` to start gep for this game.
|
|
290
|
+
*
|
|
291
|
+
* @param {string | symbol} eventName Name of the node event ('game-detected')
|
|
292
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
293
|
+
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
294
|
+
*/
|
|
295
|
+
on(
|
|
296
|
+
eventName: 'game-detected',
|
|
297
|
+
listener: (event: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void,
|
|
298
|
+
): this;
|
|
299
|
+
|
|
300
|
+
/**
|
|
301
|
+
* Register listener for when a detected game is ran as adminstrator.
|
|
302
|
+
* If this fires, it means the app must also run as adminstrator in order for Game Events to be detected.
|
|
303
|
+
*
|
|
304
|
+
* @param {string | symbol} eventName Name of the node event ('elevated-privileges-required')
|
|
305
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
306
|
+
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
307
|
+
*/
|
|
308
|
+
on(
|
|
309
|
+
eventName: 'elevated-privileges-required',
|
|
310
|
+
listener: (event: Event, gameId: number, name: string, pid: number) => void,
|
|
311
|
+
): this;
|
|
312
|
+
|
|
313
|
+
/**
|
|
314
|
+
* Register listener for errors thrown by the Game Events Provider Package
|
|
315
|
+
*
|
|
316
|
+
* @param {string | symbol} eventName Name of the node event ('error' or the `errorMonitor` symbol)
|
|
317
|
+
* @param {(Event, any[]) => void} listener The listener that will be invoked when this event is fired
|
|
318
|
+
* @returns {this} The current instance of the Overwolf Game Events Package
|
|
319
|
+
*/
|
|
320
|
+
on(
|
|
321
|
+
eventName: error,
|
|
322
|
+
listener: (event: Event, gameId: number, error: string, ...args: any[]) => void,
|
|
323
|
+
): this;
|
|
324
|
+
}
|
|
325
|
+
|
|
326
|
+
/**
|
|
327
|
+
* Namespace for GEP-related interfaces
|
|
328
|
+
*/
|
|
329
|
+
namespace gep {
|
|
330
|
+
/**
|
|
331
|
+
* Interface defining a Game Event's structure
|
|
332
|
+
*/
|
|
333
|
+
interface GameEvent {
|
|
334
|
+
/**
|
|
335
|
+
* @property {number} gameId The game id of the game the Event comes from
|
|
336
|
+
*/
|
|
337
|
+
gameId: number;
|
|
338
|
+
/**
|
|
339
|
+
* @property {string} feature The feature the Event belongs to
|
|
340
|
+
*/
|
|
341
|
+
feature: string;
|
|
342
|
+
/**
|
|
343
|
+
* @property {string} key The name of the Event
|
|
344
|
+
*/
|
|
345
|
+
key: string;
|
|
346
|
+
/**
|
|
347
|
+
* @property {any} value The value of the Event
|
|
348
|
+
*/
|
|
349
|
+
value: any;
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* Interface defining an Info Update's structure
|
|
354
|
+
*/
|
|
355
|
+
interface InfoUpdate extends GameEvent {
|
|
356
|
+
/**
|
|
357
|
+
* @property {string} category The category the Info Item belongs to
|
|
358
|
+
*/
|
|
359
|
+
category: string;
|
|
360
|
+
}
|
|
361
|
+
}
|
|
362
|
+
}
|
|
363
|
+
|
|
364
|
+
interface AdviewTag extends HTMLElement {
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
namespace Renderer {
|
|
368
|
+
type AdviewTag = overwolf.AdviewTag;
|
|
369
|
+
}
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
interface Document {
|
|
373
|
+
createElement(tagName: 'owadview'): overwolf.AdviewTag;
|
|
374
|
+
}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@overwolf/ow-electron",
|
|
3
|
-
"version": "28.3.5
|
|
4
|
-
"owElectronVersion": "28.3.5
|
|
3
|
+
"version": "28.3.5",
|
|
4
|
+
"owElectronVersion": "28.3.5",
|
|
5
5
|
"electronVersion": "28.3.3",
|
|
6
6
|
"repository": "https://github.com/electron/electron",
|
|
7
7
|
"description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
|
|
@@ -26,8 +26,5 @@
|
|
|
26
26
|
},
|
|
27
27
|
"engines": {
|
|
28
28
|
"node": ">= 10.17.0"
|
|
29
|
-
},
|
|
30
|
-
"publishConfig": {
|
|
31
|
-
"tag": "beta"
|
|
32
29
|
}
|
|
33
30
|
}
|