electron-types 41.3.0 → 41.5.0

package/README.md

@@ -11,11 +11,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.3.0
+npm install -D electron-types@41.5.0
 # or
-yarn add -D electron-types@41.3.0
+yarn add -D electron-types@41.5.0
 # or
-pnpm add -D electron-types@41.3.0
+pnpm add -D electron-types@41.5.0
 ```
 
 ## Usage

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 41.3.0
+// Type definitions for Electron 41.5.0
 // 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
@@ -7013,6 +7033,34 @@ declare namespace Electron {
 
     // Docs: https://electronjs.org/docs/api/content-tracing
 
+    /**
+     * Resolves once heap profiling has been enabled.
+     *
+     * Enable heap profiling for MemoryInfra traces. Equivalent to the `--memlog`
+     * switch in Chrome.
+     *
+     * Only takes effect if the `disabled-by-default-memory-infra` category is
+     * included.
+     *
+     * Needs to be called before `contentTracing.startRecording()`.
+     *
+     * Usage:
+     *
+     * To view the recorded heap dumps:
+     *
+     * * Download the breakpad symbols for your Electron version from the Electron
+     * GitHub releases
+     * * Clone the Electron source code
+     * * In your Chromium checkout for Electron, run this command to symbolicate the
+     * heap dump:
+     * * Open the symbolicated trace in `chrome://tracing` (the Perfetto UI does not
+     * support memory dumps yet)
+     * * Click on one of the `M` symbols
+     * * Click on a `☰` triple bar icon (e.g., in the `malloc` column)
+     *
+     * @experimental
+     */
+    enableHeapProfiling(options?: EnableHeapProfilingOptions): Promise<void>;
     /**
      * resolves with an array of category groups once all child processes have
      * acknowledged the `getCategories` request
@@ -8193,6 +8241,32 @@ declare namespace Electron {
     savePath: string;
   }
 
+  interface EnableHeapProfilingOptions {
+
+    // Docs: https://electronjs.org/docs/api/structures/enable-heap-profiling-options
+
+    /**
+     * Controls which processes are profiled. Equivalent to `--memlog` in Chrome.
+     * Default is `all`.
+     */
+    mode?: ('all' | 'browser' | 'gpu' | 'minimal' | 'renderer-sampling' | 'all-renderers' | 'utility-sampling' | 'all-utilities' | 'utility-and-browser');
+    /**
+     * Controls the sampling interval in bytes. The lower the interval, the more
+     * precise the profile is. However it comes at the cost of performance. Default is
+     * `100000` (100KB). That is enough to observe allocation sites that make
+     * allocations >500KB total, where total equals to a single allocation size times
+     * the number of such allocations at the same call site. Equivalent to
+     * `--memlog-sampling-rate` in Chrome. Must be an integer between `1000` and
+     * `10000000`.
+     */
+    samplingRate?: number;
+    /**
+     * Controls the type of metadata recorded for each allocation. Equivalent to
+     * `--memlog-stack-mode` in Chrome. Default is `native`.
+     */
+    stackMode?: ('native' | 'native-with-thread-names');
+  }
+
   interface Extension {
 
     // Docs: https://electronjs.org/docs/api/structures/extension
@@ -12265,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
@@ -15508,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
@@ -20291,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
@@ -20765,6 +20904,8 @@ declare namespace Electron {
     postBody?: PostBody;
     /**
      * Can be `default`, `foreground-tab`, `background-tab`, `new-window` or `other`.
+     * Corresponds to the manner an associated link was clicked. See Chromium's
+     * WindowOpenDisposition.
      */
     disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'other');
   }
@@ -21096,6 +21237,8 @@ declare namespace Electron {
     features: string;
     /**
      * Can be `default`, `foreground-tab`, `background-tab`, `new-window` or `other`.
+     * Corresponds to the manner an associated link was clicked. See Chromium's
+     * WindowOpenDisposition.
      */
     disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'other');
     /**
@@ -21895,6 +22038,13 @@ declare namespace Electron {
      * @experimental
      */
     sharedTexturePixelFormat?: ('argb' | 'rgbaf16');
+    /**
+     * The device scale factor of the offscreen rendering output. If not set, will use
+     * primary display's scale factor as default.
+     *
+     * @experimental
+     */
+    deviceScaleFactor?: number;
   }
 
   interface OnBeforeRedirectListenerDetails {
@@ -22794,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
@@ -24124,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
@@ -24231,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;
@@ -24353,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;
@@ -24418,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;
@@ -24434,6 +24610,7 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
+    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -24510,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;
@@ -24628,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;
@@ -24750,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;
@@ -24815,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;
@@ -24831,6 +25012,7 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
+    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -24907,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;
@@ -24953,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;
@@ -25075,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;
@@ -25140,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;
@@ -25156,6 +25342,7 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
+    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -25232,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;
@@ -25277,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;
@@ -25399,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;
@@ -25464,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;
@@ -25480,6 +25671,7 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
+    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -25556,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;
@@ -25695,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;
@@ -25817,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;
@@ -25882,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;
@@ -25898,6 +26094,7 @@ declare namespace Electron {
     type CustomScheme = Electron.CustomScheme;
     type DesktopCapturerSource = Electron.DesktopCapturerSource;
     type Display = Electron.Display;
+    type EnableHeapProfilingOptions = Electron.EnableHeapProfilingOptions;
     type Extension = Electron.Extension;
     type ExtensionInfo = Electron.ExtensionInfo;
     type FileFilter = Electron.FileFilter;
@@ -25974,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.3.0",
-  "extractedAt": "2026-04-23T00:59:39.759Z"
+  "electronVersion": "41.5.0",
+  "extractedAt": "2026-05-02T06:51:08.364Z"
 }

package/package.json

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