@overwolf/ow-electron 39.8.10-beta.3 → 39.8.10-beta.4

package/checksums.json

@@ -1,12 +1,12 @@
 {
   "electron-api.json": "d3c769853e7cac1098c3e33b0f5743ad3f890cf5003e738abb27aa7e9157d944",
   "electron.d.ts": "a332d5d3fafb45e224218d44c5c471d215dca76889956d5f36f59ec0f8716d10",
-  "ow-electron-v39.8.10-beta.3-darwin-arm64.zip": "ee6d5aaede2d638b0ff7470d366093ba7cef508b0b69132c756ced97b08753d5",
-  "ow-electron-v39.8.10-beta.3-darwin-x64.zip": "166ad42073185540efd628344e5a229e4d9cb18a4ce1cdc0e3f76618f9c6e442",
-  "ow-electron-v39.8.10-beta.3-linux-arm64.zip": "b7f255d4e3c6ac67f18aa11a59bc04194ef5ded9c48249053af96ecaf2ed33f3",
-  "ow-electron-v39.8.10-beta.3-linux-armv7l.zip": "6e4d0d96b5ed98b9973868b8ea6234a5511cae866f15e586be7003a753b7afcc",
-  "ow-electron-v39.8.10-beta.3-linux-x64.zip": "5a1a3474e6718a9629cdeb425da3936a349a484bd40b0df663aa6354c99c45fa",
-  "ow-electron-v39.8.10-beta.3-win32-arm64.zip": "bff199e35ef75181dd65db2386df20444e876b8adc604d0778099a2baa3dc0b7",
-  "ow-electron-v39.8.10-beta.3-win32-ia32.zip": "9d5957e472682389b732e611854fba8a189590fd36b04385c045df1085baad8f",
-  "ow-electron-v39.8.10-beta.3-win32-x64.zip": "9461bc79eb3eaff8ffdb71d0217d8fecf1e0934442976ec4da898e30d4bb98ef"
+  "ow-electron-v39.8.10-beta.4-darwin-arm64.zip": "ee6d5aaede2d638b0ff7470d366093ba7cef508b0b69132c756ced97b08753d5",
+  "ow-electron-v39.8.10-beta.4-darwin-x64.zip": "166ad42073185540efd628344e5a229e4d9cb18a4ce1cdc0e3f76618f9c6e442",
+  "ow-electron-v39.8.10-beta.4-linux-arm64.zip": "b7f255d4e3c6ac67f18aa11a59bc04194ef5ded9c48249053af96ecaf2ed33f3",
+  "ow-electron-v39.8.10-beta.4-linux-armv7l.zip": "6e4d0d96b5ed98b9973868b8ea6234a5511cae866f15e586be7003a753b7afcc",
+  "ow-electron-v39.8.10-beta.4-linux-x64.zip": "5a1a3474e6718a9629cdeb425da3936a349a484bd40b0df663aa6354c99c45fa",
+  "ow-electron-v39.8.10-beta.4-win32-arm64.zip": "bff199e35ef75181dd65db2386df20444e876b8adc604d0778099a2baa3dc0b7",
+  "ow-electron-v39.8.10-beta.4-win32-ia32.zip": "9d5957e472682389b732e611854fba8a189590fd36b04385c045df1085baad8f",
+  "ow-electron-v39.8.10-beta.4-win32-x64.zip": "38a914e748ffac10dd2c8a021502c1ac673e2266c85cd2736b23367fd83cbbca"
 }

package/ow-electron.d.ts

@@ -187,6 +187,39 @@ declare namespace overwolf {
       details: PackageInfo[];
     };
 
+    /**
+     * 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.
      *
@@ -253,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.
        *
@@ -267,6 +313,95 @@ declare namespace overwolf {
        */
       hasPendingUpdates(): PendingUpdatesResult;
 
+      /**
+       * Switches a package to a named release channel and immediately triggers a
+       * download of that channel's version.
+       *
+       * - 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 {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>}
+       *
+       * @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);
+       * ```
+       *
+       * @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');
+       * ```
+       */
+      setChannel(
+        packageName: PackageName,
+        channel?: string | 'public',
+        ready?: (packageInfo: ChannelPackageInfo) => void
+      ): Promise<SetChannelResult>;
+
+      /**
+       * Returns the list of release channels available on the server for one or more packages.
+       *
+       * - 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 {...PackageName} packageNames  Optional package names to query.
+       * @returns {Promise<AvailableChannelsResult>}
+       *
+       * @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']
+       * ```
+       */
+      getAvailableChannels(...packageNames: PackageName[]): Promise<AvailableChannelsResult>;
+
+      /**
+       * Returns the currently active release channel for one or more packages.
+       *
+       * - `'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 {...PackageName} packageNames  Optional package names to query.
+       * @returns {Promise<CurrentChannelsResult>}
+       *
+       * @example
+       * ```typescript
+       * const current = await api.getChannel();
+       * // { overlay: 'pre-release', gep: 'public', utility: 'public' }
+       *
+       * const { overlay } = await api.getChannel('overlay');
+       * // 'pre-release'
+       * ```
+       */
+      getChannel(...packageNames: PackageName[]): Promise<CurrentChannelsResult>;
+
       /**
        * @property returns the path to the application's logs folder.
        *

package/package.json

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