electron-types 41.4.0 → 41.5.1

package/README.md

@@ -1,5 +1,9 @@
 # electron-types
 
+[![CI](https://badgen.net/github/checks/biw/electron-types)](https://github.com/biw/electron-types/actions)
+[![npm version](https://badgen.net/npm/v/electron-types)](https://www.npmjs.com/package/electron-types)
+[![npm downloads](https://badgen.net/npm/dt/electron-types)](https://www.npmjs.com/package/electron-types)
+
 TypeScript type definitions extracted from the [electron](https://www.electronjs.org/) package.
 
 ## Why?
@@ -11,11 +15,11 @@ The official `electron` package is ~200MB because it includes the Electron binar
 Since this package only provides TypeScript types, install it as a dev dependency. **Install the version that matches your Electron version** (see [Version Matching](#version-matching)):
 
 ```bash
-npm install -D electron-types@41.4.0
+npm install -D electron-types@41.5.1
 # or
-yarn add -D electron-types@41.4.0
+yarn add -D electron-types@41.5.1
 # or
-pnpm add -D electron-types@41.4.0
+pnpm add -D electron-types@41.5.1
 ```
 
 ## Usage

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 41.4.0
+// Type definitions for Electron 41.5.1
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/typescript-definitions
@@ -1015,6 +1015,26 @@ declare namespace Electron {
      * This API must be called after the `ready` event is emitted.
      */
     configureHostResolver(options: ConfigureHostResolverOptions): void;
+    /**
+     * Configures platform authenticators for the Web Authentication API
+     * (`navigator.credentials.create()` / `navigator.credentials.get()`). Until this
+     * is called, `PublicKeyCredential.isUserVerifyingPlatformAuthenticatorAvailable()`
+     * resolves to `false` and platform-authenticator requests are not serviced.
+     *
+     * When `touchID` is provided, WebAuthn credentials are stored in the macOS
+     * keychain and bound to this device's Secure Enclave. Electron automatically
+     * generates and persists a per-`session` metadata secret so that credentials
+     * created in one partition are not visible to another.
+     *
+     * With the matching entitlement in your app's `entitlements.plist`:
+     *
+     * > [!NOTE] Touch ID WebAuthn credentials are device-bound and are not synced via
+     * iCloud Keychain. They are only available on Macs with a Secure Enclave (Apple
+     * silicon, or Intel Macs with a T2 chip).
+     *
+     * @platform darwin
+     */
+    configureWebAuthn(options: ConfigureWebAuthnOptions): void;
     /**
      * By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per domain
      * basis if the GPU process crashes too frequently. This function disables that
@@ -12319,6 +12339,37 @@ declare namespace Electron {
     removeListener(event: 'select-usb-device', listener: (event: Event,
                                               details: SelectUsbDeviceDetails,
                                               callback: (deviceId?: string) => void) => void): this;
+    /**
+     * Emitted when a call to `navigator.credentials.get()` resolves multiple
+     * discoverable WebAuthn credentials and the user must choose one. `callback`
+     * should be called with the `credentialId` of the selected account; passing no
+     * arguments — or a `credentialId` that does not match one of the provided accounts
+     * — will cancel the request and the page will receive a `NotAllowedError`. If no
+     * listener is registered for this event, the request is cancelled with the same
+     * error. The credential request remains pending until the listener invokes the
+     * callback, so always invoke it exactly once — typically from a `try { … } finally
+     * { callback(…) }` block.
+     *
+     * On macOS, the Touch ID platform authenticator surfaces accounts via this event
+     * once it has been configured with `app.configureWebAuthn`. The event may also
+     * fire on other platforms when a roaming FIDO2 authenticator returns multiple
+     * discoverable credentials.
+     */
+    on(event: 'select-webauthn-account', listener: (event: Event,
+                                                    details: SelectWebauthnAccountDetails,
+                                                    callback: (credentialId?: (string) | (null)) => void) => void): this;
+    off(event: 'select-webauthn-account', listener: (event: Event,
+                                                    details: SelectWebauthnAccountDetails,
+                                                    callback: (credentialId?: (string) | (null)) => void) => void): this;
+    once(event: 'select-webauthn-account', listener: (event: Event,
+                                                    details: SelectWebauthnAccountDetails,
+                                                    callback: (credentialId?: (string) | (null)) => void) => void): this;
+    addListener(event: 'select-webauthn-account', listener: (event: Event,
+                                                    details: SelectWebauthnAccountDetails,
+                                                    callback: (credentialId?: (string) | (null)) => void) => void): this;
+    removeListener(event: 'select-webauthn-account', listener: (event: Event,
+                                                    details: SelectWebauthnAccountDetails,
+                                                    callback: (credentialId?: (string) | (null)) => void) => void): this;
     /**
      * Emitted after `navigator.serial.requestPort` has been called and
      * `select-serial-port` has fired if a new serial port becomes available before the
@@ -15562,6 +15613,32 @@ declare namespace Electron {
     readonly children: View[];
   }
 
+  interface WebAuthnAccount {
+
+    // Docs: https://electronjs.org/docs/api/structures/webauthn-account
+
+    /**
+     * URL-safe base64-encoded (no padding) credential ID of the discoverable
+     * credential. Matches `PublicKeyCredential.id` returned by
+     * `navigator.credentials.get()` in the renderer.
+     */
+    credentialId: string;
+    /**
+     * Human-palatable name for the account, intended for display.
+     */
+    displayName?: string;
+    /**
+     * Human-palatable identifier for the account (for example, an email address or
+     * username).
+     */
+    name?: string;
+    /**
+     * URL-safe base64-encoded (no padding) user handle (`user.id`) that was provided
+     * when the credential was created.
+     */
+    userHandle?: string;
+  }
+
   class WebContents extends NodeEventEmitter {
 
     // Docs: https://electronjs.org/docs/api/web-contents
@@ -20345,6 +20422,14 @@ declare namespace Electron {
     enableAdditionalDnsQueryTypes?: boolean;
   }
 
+  interface ConfigureWebAuthnOptions {
+    /**
+     * Enables the Touch ID / Secure Enclave platform authenticator for Web
+     * Authentication requests.
+     */
+    touchID?: TouchId;
+  }
+
   interface ConsoleMessageEvent extends DOMEvent {
     /**
      * The log level, from 0 to 3. In order it matches `verbose`, `info`, `warning` and
@@ -22859,6 +22944,19 @@ declare namespace Electron {
     frame: (WebFrameMain) | (null);
   }
 
+  interface SelectWebauthnAccountDetails {
+    /**
+     * The relying party identifier from the WebAuthn request.
+     */
+    relyingPartyId: string;
+    accounts: WebAuthnAccount[];
+    /**
+     * The frame initiating this event. May be `null` if accessed after the frame has
+     * either navigated or been destroyed.
+     */
+    frame: (WebFrameMain) | (null);
+  }
+
   interface SendSharedTextureOptions {
     /**
      * The target frame to transfer the shared texture to. For `WebContents`, you can
@@ -24189,6 +24287,16 @@ declare namespace Electron {
     fd: number;
   }
 
+  interface TouchId {
+    /**
+     * The keychain access group that WebAuthn credentials will be stored under. This
+     * value **must** also be present in your app's `keychain-access-groups`
+     * code-signing entitlement, and is typically of the form
+     * `<TEAM_ID>.<BUNDLE_ID>.webauthn`.
+     */
+    keychainAccessGroup: string;
+  }
+
   interface Video {
     /**
      * The id of the stream being granted. This will usually come from a
@@ -24296,6 +24404,7 @@ declare namespace Electron {
     type Configuration = Electron.Configuration;
     type Configurations = Electron.Configurations;
     type ConfigureHostResolverOptions = Electron.ConfigureHostResolverOptions;
+    type ConfigureWebAuthnOptions = Electron.ConfigureWebAuthnOptions;
     type ConsoleMessageEvent = Electron.ConsoleMessageEvent;
     type ContextMenuEvent = Electron.ContextMenuEvent;
     type ContextMenuParams = Electron.ContextMenuParams;
@@ -24418,6 +24527,7 @@ declare namespace Electron {
     type SaveDialogSyncOptions = Electron.SaveDialogSyncOptions;
     type SelectHidDeviceDetails = Electron.SelectHidDeviceDetails;
     type SelectUsbDeviceDetails = Electron.SelectUsbDeviceDetails;
+    type SelectWebauthnAccountDetails = Electron.SelectWebauthnAccountDetails;
     type SendSharedTextureOptions = Electron.SendSharedTextureOptions;
     type SerialPortRevokedDetails = Electron.SerialPortRevokedDetails;
     type ServiceWorkersRunningStatusChangedEventParams = Electron.ServiceWorkersRunningStatusChangedEventParams;
@@ -24483,6 +24593,7 @@ declare namespace Electron {
     type PageRanges = Electron.PageRanges;
     type Params = Electron.Params;
     type Planes = Electron.Planes;
+    type TouchId = Electron.TouchId;
     type Video = Electron.Video;
     type Alternate = Electron.Alternate;
     type Alternates = Electron.Alternates;
@@ -24576,6 +24687,7 @@ declare namespace Electron {
     type UploadRawData = Electron.UploadRawData;
     type USBDevice = Electron.USBDevice;
     type UserDefaultTypes = Electron.UserDefaultTypes;
+    type WebAuthnAccount = Electron.WebAuthnAccount;
     type WebPreferences = Electron.WebPreferences;
     type WebRequestFilter = Electron.WebRequestFilter;
     type WebSource = Electron.WebSource;
@@ -24694,6 +24806,7 @@ declare namespace Electron {
     type Configuration = Electron.Configuration;
     type Configurations = Electron.Configurations;
     type ConfigureHostResolverOptions = Electron.ConfigureHostResolverOptions;
+    type ConfigureWebAuthnOptions = Electron.ConfigureWebAuthnOptions;
     type ConsoleMessageEvent = Electron.ConsoleMessageEvent;
     type ContextMenuEvent = Electron.ContextMenuEvent;
     type ContextMenuParams = Electron.ContextMenuParams;
@@ -24816,6 +24929,7 @@ declare namespace Electron {
     type SaveDialogSyncOptions = Electron.SaveDialogSyncOptions;
     type SelectHidDeviceDetails = Electron.SelectHidDeviceDetails;
     type SelectUsbDeviceDetails = Electron.SelectUsbDeviceDetails;
+    type SelectWebauthnAccountDetails = Electron.SelectWebauthnAccountDetails;
     type SendSharedTextureOptions = Electron.SendSharedTextureOptions;
     type SerialPortRevokedDetails = Electron.SerialPortRevokedDetails;
     type ServiceWorkersRunningStatusChangedEventParams = Electron.ServiceWorkersRunningStatusChangedEventParams;
@@ -24881,6 +24995,7 @@ declare namespace Electron {
     type PageRanges = Electron.PageRanges;
     type Params = Electron.Params;
     type Planes = Electron.Planes;
+    type TouchId = Electron.TouchId;
     type Video = Electron.Video;
     type Alternate = Electron.Alternate;
     type Alternates = Electron.Alternates;
@@ -24974,6 +25089,7 @@ declare namespace Electron {
     type UploadRawData = Electron.UploadRawData;
     type USBDevice = Electron.USBDevice;
     type UserDefaultTypes = Electron.UserDefaultTypes;
+    type WebAuthnAccount = Electron.WebAuthnAccount;
     type WebPreferences = Electron.WebPreferences;
     type WebRequestFilter = Electron.WebRequestFilter;
     type WebSource = Electron.WebSource;
@@ -25020,6 +25136,7 @@ declare namespace Electron {
     type Configuration = Electron.Configuration;
     type Configurations = Electron.Configurations;
     type ConfigureHostResolverOptions = Electron.ConfigureHostResolverOptions;
+    type ConfigureWebAuthnOptions = Electron.ConfigureWebAuthnOptions;
     type ConsoleMessageEvent = Electron.ConsoleMessageEvent;
     type ContextMenuEvent = Electron.ContextMenuEvent;
     type ContextMenuParams = Electron.ContextMenuParams;
@@ -25142,6 +25259,7 @@ declare namespace Electron {
     type SaveDialogSyncOptions = Electron.SaveDialogSyncOptions;
     type SelectHidDeviceDetails = Electron.SelectHidDeviceDetails;
     type SelectUsbDeviceDetails = Electron.SelectUsbDeviceDetails;
+    type SelectWebauthnAccountDetails = Electron.SelectWebauthnAccountDetails;
     type SendSharedTextureOptions = Electron.SendSharedTextureOptions;
     type SerialPortRevokedDetails = Electron.SerialPortRevokedDetails;
     type ServiceWorkersRunningStatusChangedEventParams = Electron.ServiceWorkersRunningStatusChangedEventParams;
@@ -25207,6 +25325,7 @@ declare namespace Electron {
     type PageRanges = Electron.PageRanges;
     type Params = Electron.Params;
     type Planes = Electron.Planes;
+    type TouchId = Electron.TouchId;
     type Video = Electron.Video;
     type Alternate = Electron.Alternate;
     type Alternates = Electron.Alternates;
@@ -25300,6 +25419,7 @@ declare namespace Electron {
     type UploadRawData = Electron.UploadRawData;
     type USBDevice = Electron.USBDevice;
     type UserDefaultTypes = Electron.UserDefaultTypes;
+    type WebAuthnAccount = Electron.WebAuthnAccount;
     type WebPreferences = Electron.WebPreferences;
     type WebRequestFilter = Electron.WebRequestFilter;
     type WebSource = Electron.WebSource;
@@ -25345,6 +25465,7 @@ declare namespace Electron {
     type Configuration = Electron.Configuration;
     type Configurations = Electron.Configurations;
     type ConfigureHostResolverOptions = Electron.ConfigureHostResolverOptions;
+    type ConfigureWebAuthnOptions = Electron.ConfigureWebAuthnOptions;
     type ConsoleMessageEvent = Electron.ConsoleMessageEvent;
     type ContextMenuEvent = Electron.ContextMenuEvent;
     type ContextMenuParams = Electron.ContextMenuParams;
@@ -25467,6 +25588,7 @@ declare namespace Electron {
     type SaveDialogSyncOptions = Electron.SaveDialogSyncOptions;
     type SelectHidDeviceDetails = Electron.SelectHidDeviceDetails;
     type SelectUsbDeviceDetails = Electron.SelectUsbDeviceDetails;
+    type SelectWebauthnAccountDetails = Electron.SelectWebauthnAccountDetails;
     type SendSharedTextureOptions = Electron.SendSharedTextureOptions;
     type SerialPortRevokedDetails = Electron.SerialPortRevokedDetails;
     type ServiceWorkersRunningStatusChangedEventParams = Electron.ServiceWorkersRunningStatusChangedEventParams;
@@ -25532,6 +25654,7 @@ declare namespace Electron {
     type PageRanges = Electron.PageRanges;
     type Params = Electron.Params;
     type Planes = Electron.Planes;
+    type TouchId = Electron.TouchId;
     type Video = Electron.Video;
     type Alternate = Electron.Alternate;
     type Alternates = Electron.Alternates;
@@ -25625,6 +25748,7 @@ declare namespace Electron {
     type UploadRawData = Electron.UploadRawData;
     type USBDevice = Electron.USBDevice;
     type UserDefaultTypes = Electron.UserDefaultTypes;
+    type WebAuthnAccount = Electron.WebAuthnAccount;
     type WebPreferences = Electron.WebPreferences;
     type WebRequestFilter = Electron.WebRequestFilter;
     type WebSource = Electron.WebSource;
@@ -25764,6 +25888,7 @@ declare namespace Electron {
     type Configuration = Electron.Configuration;
     type Configurations = Electron.Configurations;
     type ConfigureHostResolverOptions = Electron.ConfigureHostResolverOptions;
+    type ConfigureWebAuthnOptions = Electron.ConfigureWebAuthnOptions;
     type ConsoleMessageEvent = Electron.ConsoleMessageEvent;
     type ContextMenuEvent = Electron.ContextMenuEvent;
     type ContextMenuParams = Electron.ContextMenuParams;
@@ -25886,6 +26011,7 @@ declare namespace Electron {
     type SaveDialogSyncOptions = Electron.SaveDialogSyncOptions;
     type SelectHidDeviceDetails = Electron.SelectHidDeviceDetails;
     type SelectUsbDeviceDetails = Electron.SelectUsbDeviceDetails;
+    type SelectWebauthnAccountDetails = Electron.SelectWebauthnAccountDetails;
     type SendSharedTextureOptions = Electron.SendSharedTextureOptions;
     type SerialPortRevokedDetails = Electron.SerialPortRevokedDetails;
     type ServiceWorkersRunningStatusChangedEventParams = Electron.ServiceWorkersRunningStatusChangedEventParams;
@@ -25951,6 +26077,7 @@ declare namespace Electron {
     type PageRanges = Electron.PageRanges;
     type Params = Electron.Params;
     type Planes = Electron.Planes;
+    type TouchId = Electron.TouchId;
     type Video = Electron.Video;
     type Alternate = Electron.Alternate;
     type Alternates = Electron.Alternates;
@@ -26044,6 +26171,7 @@ declare namespace Electron {
     type UploadRawData = Electron.UploadRawData;
     type USBDevice = Electron.USBDevice;
     type UserDefaultTypes = Electron.UserDefaultTypes;
+    type WebAuthnAccount = Electron.WebAuthnAccount;
     type WebPreferences = Electron.WebPreferences;
     type WebRequestFilter = Electron.WebRequestFilter;
     type WebSource = Electron.WebSource;

package/dist/version.json

@@ -1,4 +1,4 @@
 {
-  "electronVersion": "41.4.0",
-  "extractedAt": "2026-05-01T01:09:34.954Z"
+  "electronVersion": "41.5.1",
+  "extractedAt": "2026-05-09T01:03:49.834Z"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-types",
-  "version": "41.4.0",
+  "version": "41.5.1",
   "type": "module",
   "description": "TypeScript type definitions extracted from the electron package",
   "types": "./dist/electron.d.ts",