@overwolf/ow-electron 39.8.10-beta.0 → 39.8.10-beta.10

package/checksums.json

@@ -1,12 +1,12 @@
 {
   "electron-api.json": "d3c769853e7cac1098c3e33b0f5743ad3f890cf5003e738abb27aa7e9157d944",
   "electron.d.ts": "a332d5d3fafb45e224218d44c5c471d215dca76889956d5f36f59ec0f8716d10",
-  "ow-electron-v39.8.10-beta.0-darwin-arm64.zip": "469a72f74a0a52de3555391324d4fc6a4cef26d920208603c2502aedcc92a329",
-  "ow-electron-v39.8.10-beta.0-darwin-x64.zip": "f3e00cf49ca8779bab61917d78c2a5de630e58945753c89a1f1fe5c6a7cc5ad4",
-  "ow-electron-v39.8.10-beta.0-linux-arm64.zip": "aa90bc87e7f3452831aa4687e71d2bfb0d1c08ffef9533472383dc3d361ae758",
-  "ow-electron-v39.8.10-beta.0-linux-armv7l.zip": "6e4d0d96b5ed98b9973868b8ea6234a5511cae866f15e586be7003a753b7afcc",
-  "ow-electron-v39.8.10-beta.0-linux-x64.zip": "16b0450e045a634067303a27896ba38f98f663b5fbdf5e8d6cb181baff249fff",
-  "ow-electron-v39.8.10-beta.0-win32-arm64.zip": "bff199e35ef75181dd65db2386df20444e876b8adc604d0778099a2baa3dc0b7",
-  "ow-electron-v39.8.10-beta.0-win32-ia32.zip": "9d5957e472682389b732e611854fba8a189590fd36b04385c045df1085baad8f",
-  "ow-electron-v39.8.10-beta.0-win32-x64.zip": "2e3601b11bc2c696127cd5ce708b08b8e2d324a5cc9e3b74cac944e23e2784ac"
+  "ow-electron-v39.8.10-beta.10-darwin-arm64.zip": "ee6d5aaede2d638b0ff7470d366093ba7cef508b0b69132c756ced97b08753d5",
+  "ow-electron-v39.8.10-beta.10-darwin-x64.zip": "166ad42073185540efd628344e5a229e4d9cb18a4ce1cdc0e3f76618f9c6e442",
+  "ow-electron-v39.8.10-beta.10-linux-arm64.zip": "b7f255d4e3c6ac67f18aa11a59bc04194ef5ded9c48249053af96ecaf2ed33f3",
+  "ow-electron-v39.8.10-beta.10-linux-armv7l.zip": "6e4d0d96b5ed98b9973868b8ea6234a5511cae866f15e586be7003a753b7afcc",
+  "ow-electron-v39.8.10-beta.10-linux-x64.zip": "5a1a3474e6718a9629cdeb425da3936a349a484bd40b0df663aa6354c99c45fa",
+  "ow-electron-v39.8.10-beta.10-win32-arm64.zip": "bff199e35ef75181dd65db2386df20444e876b8adc604d0778099a2baa3dc0b7",
+  "ow-electron-v39.8.10-beta.10-win32-ia32.zip": "9d5957e472682389b732e611854fba8a189590fd36b04385c045df1085baad8f",
+  "ow-electron-v39.8.10-beta.10-win32-x64.zip": "bea45b586ba3cbfc4253bd7f87f18c73089918d7b98ce23af5ced4a4add324c6"
 }

package/install.js

@@ -2,14 +2,15 @@
 
 const { downloadArtifact } = require('@electron/get');
 
+const { owElectronVersion } = require('./package');
 const extract = require('extract-zip');
 
 const childProcess = require('child_process');
 const fs = require('fs');
 const os = require('os');
 const path = require('path');
-const { owElectronVersion } = require('./package');
-// const { version } = require('./package');
+
+const { version } = require('./package');
 
 if (process.env.ELECTRON_SKIP_BINARY_DOWNLOAD) {
   process.exit(0);
@@ -76,16 +77,29 @@ function isInstalled () {
 
 // unzips and makes path.txt point at the correct executable
 function extractFile (zipPath) {
-  return new Promise((resolve, reject) => {
-    extract(zipPath, { dir: path.join(__dirname, 'dist') }, err => {
-      if (err) return reject(err);
+  const distPath = process.env.ELECTRON_OVERRIDE_DIST_PATH || path.join(__dirname, 'dist');
+
+  return extract(zipPath, { dir: path.join(__dirname, 'dist') }).then(() => {
+    // If the zip contains an "electron.d.ts" file,
+    // move that up
+    const srcTypeDefPath = path.join(distPath, 'electron.d.ts');
+    const targetTypeDefPath = path.join(__dirname, 'electron.d.ts');
+    const hasTypeDefinitions = fs.existsSync(srcTypeDefPath);
 
-      fs.writeFile(path.join(__dirname, 'path.txt'), platformPath, err => {
-        if (err) return reject(err);
+    if (hasTypeDefinitions) {
+      fs.renameSync(srcTypeDefPath, targetTypeDefPath);
+    }
+
+    const owsrcTypeDefPath = path.join(distPath, 'ow-electron.d.ts');
+    const owtargetTypeDefPath = path.join(__dirname, 'ow-electron.d.ts'); 
+    const hasOwTypeDefinitions = fs.existsSync(owsrcTypeDefPath);
+
+    if (hasOwTypeDefinitions) {
+      fs.renameSync(owsrcTypeDefPath, owtargetTypeDefPath);
+    }
 
-        resolve();
-      });
-    });
+    // Write a "path.txt" file.
+    return fs.promises.writeFile(path.join(__dirname, 'path.txt'), platformPath);
   });
 }
 

package/ow-electron.d.ts

@@ -1,4 +1,7 @@
 // Type definitions for ow-electron 39.8.10
+// Note: if your project also has the `electron` package installed as a devDependency,
+// add `"skipLibCheck": true` to your tsconfig.json to avoid duplicate module declaration conflicts.
+/// <reference path="./electron.d.ts" />
 import { App, BrowserWindow, Event } from 'electron';
 import { errorMonitor } from 'events';
 
@@ -76,6 +79,16 @@ declare namespace overwolf {
      * Overwolf installer provided UTM params
      */
     readonly utmParams: any;
+
+    /**
+     * @property returns  a unique identifier for the user machine
+     */
+    readonly muid: string;
+
+    /**
+     * @property returns the ow-electron uid (Overwolf App Id)
+     */
+    readonly uid: string;
   }
 
   interface CMPWindowOptions {
@@ -159,7 +172,7 @@ declare namespace overwolf {
     /**
      * A fake enum for all built-in packIge names
      */
-    type PackageName = 'gep' | 'overlay' | 'recorder' | 'utility' | string;
+    type PackageName = 'gep' | 'overlay' | 'recorder' | 'utility' | 'crn' | string;
 
     /**
      * Package info
@@ -175,7 +188,42 @@ declare namespace overwolf {
     };
 
     /**
-     * Overwolf Package Manager interface
+     * Result returned by `setChannel()`.
+     * `error` is `'invalid-package'` when the package is not found on the server,
+     * or `'invalid-channel'` when the channel does not exist for that package.
+     */
+    type SetChannelResult = {
+      success: boolean;
+      error?: 'invalid-package' | 'invalid-channel';
+    };
+
+    /**
+     * Passed to the `ready` callback of `setChannel()`.
+     * Identifies the downloaded package that is pending a restart.
+     */
+    interface ChannelPackageInfo {
+      name: string;
+      version: string;
+    }
+
+    /**
+     * Returned by `getAvailableChannels()`.
+     * Maps each package name to the list of channel names available on the server.
+     * Packages with no channels defined return an empty array.
+     */
+    type AvailableChannelsResult = Record<string, string[]>;
+
+    /**
+     * Returned by `getChannel()`.
+     * Maps each package name to its currently active channel.
+     * `'public'` means the package is on the default public release.
+     */
+    type CurrentChannelsResult = Record<string, string>;
+
+    /**
+     * Overwolf Package Manager interface.
+     *
+     * For package-specific API types, see `@overwolf/ow-electron-packages-types`.
      */
     interface OverwolfPackageManager extends NodeJS.EventEmitter {
       /**
@@ -238,6 +286,19 @@ declare namespace overwolf {
         listener: (event: Event, packageName: PackageName) => void
       ): this;
 
+      /**
+       * Register listener for when an Overwolf Package begins its load sequence.
+       * Fires before 'ready'.
+       *
+       * @param {string} eventName Name of the node event ('loading')
+       * @param {(Event, PackageName) => 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: 'loading',
+        listener: (event: Event, packageName: PackageName) => void
+      ): this;
+
       /**
        * Relaunch the Overwolf Package Manager. Call it to force all pending Overwolf Package updates.
        *
@@ -253,180 +314,104 @@ declare namespace overwolf {
       hasPendingUpdates(): PendingUpdatesResult;
 
       /**
-       * @property returns the path to the application's logs folder.
+       * Switches a package to a named release channel and immediately triggers a
+       * download of that channel's version.
        *
-       * */
-      readonly logsFolderPath: string;
-
-      /**
-       * @property {packages.OverwolfGameEventPackage} gep The Game Events Provider Package Instance
-       * note: available once 'ready' is fired.
-       */
-      readonly gep: packages.OverwolfGameEventPackage;
-    }
-
-    /**
-     * Game Events game detection Event
-     */
-    export interface GepGameLaunchEvent {
-      enable: () => void;
-    }
-
-    /**
-     * Game Events Package interface
-     */
-    interface OverwolfGameEventPackage extends NodeJS.EventEmitter {
-      /**
-       * Returns an array of supported Game Event Features for a game
+       * - Channel preferences are persisted in storage and applied on every subsequent
+       *   update check, including the next app launch.
+       * - Pass `undefined`, `null`, an empty string, or `'public'` to restore the
+       *   default public release.
+       * - The optional `ready` callback is invoked with `{ name, version }` once the
+       *   download completes and the app must restart to apply the new version.
+       * - If the package is already at the requested channel version, `ready` never fires.
+       * - Throws if `packageName` is not listed in the app's `package.json`
+       *   `overwolf.packages` array.
        *
-       * @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 {PackageName} packageName  The package to switch.
+       * @param {string}      [channel]    Target channel name. Omit or pass `'public'` /
+       *                                   empty string to restore the public release.
+       * @param {Function}    [ready]      Invoked when the download completes and a
+       *                                   restart is required.
+       * @returns {Promise<SetChannelResult>}
        *
-       * @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
+       * @example
+       * ```typescript
+       * const result = await api.setChannel('overlay', 'pre-release', (pkg) => {
+       *   console.log(`overlay v${pkg.version} ready - restart required`);
+       *   api.relaunch();
+       * });
+       * if (!result.success) console.error('setChannel failed:', result.error);
+       * ```
        *
-       * @returns {Promise<{
-       *  name: string;
-       *  id: number;
-       * }[]>} Promise resolving to an array of supported games
+       * @example
+       * ```typescript
+       * // Restore the public release - all four are equivalent
+       * await api.setChannel('overlay');
+       * await api.setChannel('overlay', undefined);
+       * await api.setChannel('overlay', '');
+       * await api.setChannel('overlay', 'public');
+       * ```
        */
-      getSupportedGames(): Promise<{
-        name: string;
-        id: number;
-      }[]>;
+      setChannel(
+        packageName: PackageName,
+        channel?: string | 'public',
+        ready?: (packageInfo: ChannelPackageInfo) => void
+      ): Promise<SetChannelResult>;
 
       /**
-       * Returns the target game's current Game Info
+       * Returns the list of release channels available on the server for one or more packages.
        *
-       * @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
+       * - Pass no arguments to query all packages registered in the app's `overwolf.packages` list.
+       * - Pass one or more package names to query a specific subset.
+       * - Packages with no channels defined return an empty array `[]`.
+       * - Throws if any supplied name is not in the registered packages list.
        *
-       * @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 {...PackageName} packageNames  Optional package names to query.
+       * @returns {Promise<AvailableChannelsResult>}
        *
-       * @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
+       * @example
+       * ```typescript
+       * const channels = await api.getAvailableChannels();
+       * // { overlay: ['pre-release', 'beta'], gep: ['pre-release'], utility: [] }
+       *
+       * const { overlay } = await api.getAvailableChannels('overlay');
+       * // overlay: ['pre-release', 'beta']
+       * ```
        */
-      on(
-        eventName: 'new-game-event',
-        listener: (event: Event, gameId: number, data: gep.GameEvent) => void,
-      ): this;
+      getAvailableChannels(...packageNames: PackageName[]): Promise<AvailableChannelsResult>;
 
       /**
-       * Register listener for a game being detected.
-       * Calling `event.enable()` to start gep for this game.
+       * Returns the currently active release channel for one or more packages.
        *
-       * @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: GepGameLaunchEvent, gameId: number, name: string, ...args: any[]) => void,
-      ): this;
-	  	  
-      /**
-       * Register listener for a game exit event.
+       * - `'public'` means the package is on the default public release.
+       * - Pass no arguments to query all registered packages (plus any package with a
+       *   non-public channel stored, even if not in `package.json`).
+       * - Unknown package names are silently omitted from the result (no error thrown).
        *
-       * @param {string | symbol} eventName Name of the node event ('game-exit')
-       * @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-exit',
-        listener: (event: Event, gameId: number, name: string, pid: number) => 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 {...PackageName} packageNames  Optional package names to query.
+       * @returns {Promise<CurrentChannelsResult>}
        *
-       * @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
+       * @example
+       * ```typescript
+       * const current = await api.getChannel();
+       * // { overlay: 'pre-release', gep: 'public', utility: 'public' }
        *
-       * @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
+       * const { overlay } = await api.getChannel('overlay');
+       * // 'pre-release'
+       * ```
        */
-      on(
-        eventName: error,
-        listener: (event: Event, gameId: number, error: string, ...args: any[]) => void,
-      ): this;
-    }
+      getChannel(...packageNames: PackageName[]): Promise<CurrentChannelsResult>;
 
-    /**
-     * 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;
-      }
+       * @property returns the path to the application's logs folder.
+       *
+       * */
+      readonly logsFolderPath: string;
 
       /**
-       * Interface defining an Info Update's structure
+       * @property returns the ow-electron phase percentage (used by package manager).
        */
-      interface InfoUpdate extends GameEvent {
-        /**
-         * @property {string} category The category the Info Item belongs to
-         */
-        category: string;
-      }
+      readonly phasePercent: number;
     }
   }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@overwolf/ow-electron",
-  "version": "39.8.10-beta.0",
-  "owElectronVersion": "39.8.10-beta.0",
+  "version": "39.8.10-beta.10",
+  "owElectronVersion": "39.8.10-beta.10",
   "electronVersion": "39.8.10",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",