@overwolf/ow-electron-packages-types 1.1.0-beta.2 → 1.1.0-beta.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.
@@ -1,34 +1,60 @@
1
1
  export const enum kGepSupportedGameIds {
2
2
  ApexLegends = 21566,
3
+ ArcRaiders = 27168,
4
+ ArknightsEF = 27724,
3
5
  BaldursGateIII = 22088,
4
6
  BlackMythWukong = 24504,
7
+ CoDGI = 27860,
8
+ CallofDutyModernWarfareII = 22328,
9
+ CallofDutyVanguard = 21876,
5
10
  ContentWarning = 24110,
6
11
  CS2 = 22730,
12
+ DarkandDarker = 22584,
13
+ Deadlock = 24482,
7
14
  DiabloIV = 22700,
8
15
  Dota2 = 7314,
16
+ ELDENRINGNIGHTREIGN = 25918,
17
+ EscapeFromTarkov = 21634,
9
18
  FinalFantasyXIVOnline = 6350,
10
19
  Fortnite = 21216,
11
20
  GenshinImpact = 21656,
12
- HadesII = 24218,
13
- HaloInfinite = 21854,
21
+ HearthstoneHeroesofWarcraft = 9898,
14
22
  HELLDIVERS2 = 24000,
15
23
  HonkaiStarRail = 22804,
16
24
  LeagueofLegends = 5426,
17
25
  LeagueofLegendsPBE = 22848,
18
26
  LethalCompany = 23522,
19
- ManorLords = 24176,
27
+ LostArk = 21864,
28
+ MagictheGatheringArena = 21308,
29
+ MarvelRivals = 24890,
20
30
  Minecraft = 8032,
31
+ MinecraftBedrock = 22176,
32
+ MHWilds = 25446,
33
+ NewWorld = 21816,
21
34
  OnceHuman = 23930,
22
35
  Overwatch = 10844,
23
36
  Palworld = 23944,
24
37
  PathofExile = 7212,
25
- Stormgate = 23818,
38
+ PathofExile2 = 24886,
39
+ PEAK = 26092,
40
+ PUBG = 10906,
41
+ REPO = 25448,
42
+ Rainbow6Siege = 10826,
43
+ REMATCH = 26120,
44
+ Roblox = 4688,
45
+ RobloxMicrosoftedition = 22174,
46
+ RocketLeague = 10798,
47
+ ScheduleI = 25610,
48
+ SonsoftheForest = 22638,
49
+ Splitgate2 = 25884,
50
+ StreetFighter6 = 22894,
51
+ SUPERVIVE = 24346,
26
52
  TeamfightTactics = 21570,
27
53
  TheFinals = 23478,
28
- TheFirstDescendant = 24360,
29
- RocketLeague = 10798,
30
54
  VALORANT = 21640,
55
+ Warframe = 8954,
31
56
  Warhammer40000SpaceMarine2 = 24548,
32
- WutheringWaves = 24300,
33
57
  WoW = 765,
34
- }
58
+ WutheringWaves = 24300,
59
+ XKO = 26840,
60
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@overwolf/ow-electron-packages-types",
3
- "version": "1.1.0-beta.2",
3
+ "version": "1.1.0-beta.5",
4
4
  "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
5
5
  "license": "MIT",
6
6
  "types": "types.d.ts",
@@ -31,10 +31,7 @@
31
31
  "types": "./gep-supported-games.d.ts"
32
32
  }
33
33
  },
34
- "publishConfig": {
35
- "tag": "beta"
36
- },
37
34
  "dependencies": {
38
35
  "glob": "^13.0.0"
39
36
  }
40
- }
37
+ }
package/types.d.ts CHANGED
@@ -56,11 +56,30 @@ interface IOverwolfUtilityApi {
56
56
  /**
57
57
  * Scans the system for installed games that match the provided filter.
58
58
  *
59
+ * If a game is installed on multiple platforms (e.g. both Steam and Epic Games),
60
+ * each installation is returned as a separate `InstalledGameInfo` entry.
61
+ *
59
62
  * @param filter - Optional. Configuration specifying which games to include in the scan.
60
63
  * @returns A promise that resolves to an array of `InstalledGameInfo` objects representing the installed games.
61
64
  */
62
65
  scan(filter?: GamesFilter): Promise<InstalledGameInfo[]>;
63
66
 
67
+ /**
68
+ * install ow-electron helpers to
69
+ * %CommonProgramFiles%\<app-name>\ with UAC elevation.
70
+ * will allow us to inject into high elevation games
71
+ * No-ops if files are already present.
72
+ * @throws {HelperInstallError} exitCode 1223 — user cancelled the UAC prompt (ERROR_CANCELLED)
73
+ * @throws {HelperInstallError} any other non-zero exitCode — installation failed
74
+ */
75
+ installHighElevationHelper?(): Promise<void>;
76
+
77
+ /**
78
+ * Returns true if ow-electron helpers is already installed in
79
+ * %CommonProgramFiles%\<app-name>\.
80
+ */
81
+ isHighElevationHelperInstalled?(): Promise<boolean>;
82
+
64
83
  /**
65
84
  * Fires when a tracked game is launched.
66
85
  *
@@ -4606,14 +4625,16 @@ type GameInfoType = 'Game' | 'Launcher' | undefined;
4606
4625
 
4607
4626
  /**
4608
4627
  * Information about a game installed on the user's system.
4609
- *
4628
+ *
4610
4629
  * Includes:
4611
4630
  * - The Game's ID.
4612
- * - Installation path.
4631
+ * - Installation path and install folder.
4632
+ * - Steam store ID (if installed via Steam).
4633
+ * - Epic Games store ID (if installed via Epic Games Launcher).
4613
4634
  * - Name of the game.
4614
4635
  * - Type (`game` or `launcher`).
4615
4636
  * - Overlay support status.
4616
- *
4637
+ *
4617
4638
  */
4618
4639
  type InstalledGameInfo = {
4619
4640
  /**
@@ -4626,6 +4647,22 @@ type InstalledGameInfo = {
4626
4647
  */
4627
4648
  path?: string;
4628
4649
 
4650
+ /**
4651
+ * The root folder where the game is installed.
4652
+ * (when detected from steam or epic)
4653
+ */
4654
+ installFolder?: string;
4655
+
4656
+ /**
4657
+ * The game's Steam store ID.
4658
+ */
4659
+ steamId?: number;
4660
+
4661
+ /**
4662
+ * The game's Epic Games store ID.
4663
+ */
4664
+ epicId?: string;
4665
+
4629
4666
  /**
4630
4667
  * Name of the game.
4631
4668
  */
@@ -5425,6 +5462,22 @@ interface IOverwolfOverlayApi extends EventEmitter {
5425
5462
  */
5426
5463
  exitExclusiveMode(): void;
5427
5464
 
5465
+ /**
5466
+ * install ow-electron helpers to
5467
+ * %CommonProgramFiles%\<app-name>\ with UAC elevation.
5468
+ * will allow us to inject into high elevation games
5469
+ * No-ops if files are already present.
5470
+ * @throws {HelperInstallError} exitCode 1223 — user cancelled the UAC prompt (ERROR_CANCELLED)
5471
+ * @throws {HelperInstallError} any other non-zero exitCode — installation failed
5472
+ */
5473
+ installHighElevationHelper?(): Promise<void>;
5474
+
5475
+ /**
5476
+ * Returns true if ow-electron helpers is already installed in
5477
+ * %CommonProgramFiles%\<app-name>\.
5478
+ */
5479
+ isHighElevationHelperInstalled?(): Promise<boolean>;
5480
+
5428
5481
  /**
5429
5482
  * Fires when an internal error occurs within the overlay system.
5430
5483
  */