@overwolf/ow-electron-packages-types 1.1.12-beta.3 → 1.1.12-beta.5

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@overwolf/ow-electron-packages-types",
-    "version": "1.1.12-beta.3",
+    "version": "1.1.12-beta.5",
     "description": "Type definition file for autocompletion and documentation purposes for ow-electron packages",
     "license": "MIT",
     "types": "types.d.ts",
@@ -34,7 +34,8 @@
     "scripts": {
         "combine": "node combine-dts.js ./modules",
         "beta": "node beta.js",
-        "release": "node release.js"
+        "release": "node release.js",
+        "prepare": "git config core.hooksPath .githooks || true"
     },
     "dependencies": {
         "glob": "^13.0.0"

package/types.d.ts

@@ -101,6 +101,46 @@ interface ElevatedInjectionCapability {
   readonly brokerInstalled: boolean;
 }
 
+/**
+ * The value a failed elevation call rejects with: `installHighElevationHelper()`,
+ * `isHighElevationHelperInstalled()`, `canInjectElevated()`,
+ * `installElevationBroker()` and `uninstallElevationBroker()`.
+ *
+ * It is a plain object, not an `Error` instance: `err instanceof Error` is
+ * `false`, and there is no stack trace.
+ *
+ * @example
+ * ```ts
+ * try {
+ *   await api.installElevationBroker();
+ * } catch (err) {
+ *   const { message, exitCode } = err as UtilityApiError;
+ *   if (exitCode === 1223) {
+ *     console.warn('User cancelled UAC prompt');
+ *   } else {
+ *     console.error('Broker install failed:', message, exitCode);
+ *   }
+ * }
+ * ```
+ */
+interface UtilityApiError {
+  /**
+   * Describes the failure.
+   */
+  readonly message: string;
+
+  /**
+   * Exit code of the elevated installer process. Only set by the calls that
+   * prompt for UAC (`installHighElevationHelper()`,
+   * `installElevationBroker()` and `uninstallElevationBroker()`), and only
+   * when the installer actually ran - it is absent when the call failed
+   * before that, e.g. a missing helper binary.
+   *
+   * `1223` (ERROR_CANCELLED) means the user cancelled the UAC prompt.
+   */
+  readonly exitCode?: number;
+}
+
 /**
  * Defines the API for managing game launch and utility operations.
  */
@@ -132,9 +172,9 @@ interface IOverwolfUtilityApi {
    * Allows injection into high elevation games.
    * No-ops if files are already present.
    *
-   * @throws `HelperInstallError` `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
-   * @throws `HelperInstallError` `err.exitCode !== 1223` — the installer process failed. Log `err.exitCode` and investigate.
-   * @throws `HelperInstallError` any other non-zero exitCode — installation failed.
+   * @throws {@link UtilityApiError} `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws {@link UtilityApiError} any other `exitCode` — the installer process failed. Log `err.exitCode` and investigate.
+   * @throws {@link UtilityApiError} no `exitCode` — the call failed before the installer ran. Log `err.message`.
    *
    * @remarks
    * The helper binaries are installed to:
@@ -150,12 +190,13 @@ interface IOverwolfUtilityApi {
    * try {
    *   await api.installHighElevationHelper();
    *   console.log('Helper installed successfully');
-   * } catch (err: any) {
-   *   if (err.exitCode === 1223) {
+   * } catch (err) {
+   *   const { message, exitCode } = err as UtilityApiError;
+   *   if (exitCode === 1223) {
    *     // User cancelled the UAC prompt — not an error, just inform the user
    *     console.warn('User cancelled UAC prompt');
    *   } else {
-   *     console.error('Installation failed, exitCode:', err.exitCode);
+   *     console.error('Installation failed:', message, exitCode);
    *   }
    * }
    * ```
@@ -179,6 +220,7 @@ interface IOverwolfUtilityApi {
    * `%CommonProgramFiles%\<app-name>\`.
    *
    * @returns `true` if the helper is installed and ready.
+   * @throws {@link UtilityApiError}
    *
    * @remarks
    * This only reports whether the binaries are present. On a standard
@@ -202,6 +244,7 @@ interface IOverwolfUtilityApi {
    *
    * @returns An {@link ElevatedInjectionCapability} describing what's
    * missing when elevated injection isn't currently possible.
+   * @throws {@link UtilityApiError}
    *
    * @remarks
    * `supported` is `false` with reason `'account-cannot-elevate'` on a
@@ -227,8 +270,9 @@ interface IOverwolfUtilityApi {
    * integrity, which is the only way an app running under a standard user
    * account can overlay an elevated game. Prompts for UAC once.
    *
-   * @throws `HelperInstallError` `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
-   * @throws `HelperInstallError` any other non-zero exitCode — installation failed
+   * @throws {@link UtilityApiError} `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws {@link UtilityApiError} any other `exitCode` — installation failed
+   * @throws {@link UtilityApiError} no `exitCode` — the call failed before the installer ran
    *
    * @remarks
    * The service stays registered until `uninstallElevationBroker()` removes
@@ -242,6 +286,10 @@ interface IOverwolfUtilityApi {
    * Stops and removes the elevation broker service. Prompts for UAC once.
    * Succeeds when the service is already absent.
    *
+   * @throws {@link UtilityApiError} `exitCode 1223` — user cancelled the UAC prompt (ERROR_CANCELLED)
+   * @throws {@link UtilityApiError} any other `exitCode` — removal failed
+   * @throws {@link UtilityApiError} no `exitCode` — the call failed before the uninstaller ran
+   *
    * @returns Resolves when removal completes.
    */
   uninstallElevationBroker?(): Promise<void>;
@@ -3689,7 +3737,11 @@ interface EncoderSettingsAMF extends VideoEncoderSettingsBase {
    *
    * B-frames improve compression efficiency but may add encoding latency.
    *
-   * @default 3
+   * Applies to H.264 and AV1; ignored for HEVC. AV1 B-frames need a GPU that
+   * supports them, such as the Radeon RX 9000 series; on other GPUs the
+   * encoder logs a warning and encodes without B-frames.
+   *
+   * @default 3 (`2` for AV1)
    */
   bf?: number;
 }