electron-types 42.0.1 → 43.0.0-alpha.2

package/README.md

@@ -15,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@42.0.1
+npm install -D electron-types@43.0.0-alpha.2
 # or
-yarn add -D electron-types@42.0.1
+yarn add -D electron-types@43.0.0-alpha.2
 # or
-pnpm add -D electron-types@42.0.1
+pnpm add -D electron-types@43.0.0-alpha.2
 ```
 
 ## Usage

package/dist/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 42.0.1
+// Type definitions for Electron 43.0.0-alpha.2
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/typescript-definitions
@@ -1133,8 +1133,6 @@ declare namespace Electron {
      *
      * This method returns a promise that contains the application name, icon and path
      * of the default handler for the protocol (aka URI scheme) of a URL.
-     *
-     * @platform darwin,win32
      */
     getApplicationInfoForProtocol(url: string): Promise<Electron.ApplicationInfoForProtocolReturnValue>;
     /**
@@ -8034,6 +8032,11 @@ declare namespace Electron {
     /**
      * Hides the dock icon.
      *
+     * > [!IMPORTANT] **Known issue:** Calling `dock.hide()` within one second of a
+     * previous call will have no effect. As a workaround, ensure at least one second
+     * has elapsed between calls — for example, by deferring with a `setTimeout` of
+     * 1100ms or more after a previous call.
+     *
      * @platform darwin
      */
     hide(): void;
@@ -9536,6 +9539,15 @@ declare namespace Electron {
      * An `Accelerator | null` indicating the item's accelerator, if set.
      */
     accelerator: (Accelerator) | (null);
+    /**
+     * A `string` indicating the item's accessibility label (used by assistive
+     * technology), if set.
+     *
+     * This property can be dynamically changed.
+     *
+     * @platform darwin
+     */
+    accessibilityLabel: string;
     /**
      * A `boolean` indicating whether the item is checked.
      *
@@ -9825,13 +9837,20 @@ declare namespace Electron {
      *
      * @platform darwin
      */
-    static createFromNamedImage(imageName: string, hslShift?: number[]): NativeImage;
+    static createFromNamedImage(imageName: string, options?: (CreateFromNamedImageOptions) | (number[])): NativeImage;
     /**
      * Creates a new `NativeImage` instance from an image file (e.g., PNG or JPEG)
      * located at `path`. This method returns an empty image if the `path` does not
      * exist, cannot be read, or is not a valid image.
      */
     static createFromPath(path: string): NativeImage;
+    /**
+     * Creates a new `NativeImage` instance from an SF Symbol for use in a native Menu.
+     * See SF Symbols for a list of possible values.
+     *
+     * @platform darwin
+     */
+    static createMenuSymbol(imageName: string): NativeImage;
     /**
      * fulfilled with the file's thumbnail preview image, which is a NativeImage.
      *
@@ -11799,7 +11818,12 @@ declare namespace Electron {
      */
     getSelectedStorageBackend(): ('basic_text' | 'gnome_libsecret' | 'kwallet' | 'kwallet5' | 'kwallet6' | 'unknown');
     /**
-     * Whether encryption is available for asynchronous safeStorage operations.
+     * Resolves with whether encryption is available for asynchronous safeStorage
+     * operations.
+     *
+     * The asynchronous encryptor is initialized lazily the first time this method,
+     * `encryptStringAsync`, or `decryptStringAsync` is called after the app is ready.
+     * The returned promise resolves once initialization completes.
      */
     isAsyncEncryptionAvailable(): Promise<boolean>;
     /**
@@ -15626,6 +15650,31 @@ declare namespace Electron {
                                   * GetExitCodeProcess on Windows.
                                   */
                                  code: number) => void): this;
+    /**
+     * Emitted when the utility process encounters an HTTP 401 or 407 authentication
+     * challenge, if the process was created with both
+     * `respondToAuthRequestsFromMainProcess: true` and a `session` option. The
+     * `callback` should be called with credentials to respond to the challenge.
+     * Calling `callback` without arguments will cancel the request.
+     *
+     * This behaves the same as the `login` event on `app` but is scoped to the
+     * individual utility process instance.
+     */
+    on(event: 'login', listener: (authenticationResponseDetails: AuthenticationResponseDetails,
+                                  authInfo: AuthInfo,
+                                  callback: (username?: string, password?: string) => void) => void): this;
+    off(event: 'login', listener: (authenticationResponseDetails: AuthenticationResponseDetails,
+                                  authInfo: AuthInfo,
+                                  callback: (username?: string, password?: string) => void) => void): this;
+    once(event: 'login', listener: (authenticationResponseDetails: AuthenticationResponseDetails,
+                                  authInfo: AuthInfo,
+                                  callback: (username?: string, password?: string) => void) => void): this;
+    addListener(event: 'login', listener: (authenticationResponseDetails: AuthenticationResponseDetails,
+                                  authInfo: AuthInfo,
+                                  callback: (username?: string, password?: string) => void) => void): this;
+    removeListener(event: 'login', listener: (authenticationResponseDetails: AuthenticationResponseDetails,
+                                  authInfo: AuthInfo,
+                                  callback: (username?: string, password?: string) => void) => void): this;
     /**
      * Emitted when the child process sends a message using
      * `process.parentPort.postMessage()`.
@@ -15718,6 +15767,11 @@ declare namespace Electron {
      * no-op.
      */
     removeChildView(view: View): void;
+    /**
+     * > [!NOTE] You must set a background color with an alpha channel (e.g.
+     * `#80ffffff`) in order for the blur effect to be visible.
+     */
+    setBackgroundBlur(blurRadius: number): void;
     /**
      * Examples of valid `color` values:
      *
@@ -17742,6 +17796,31 @@ declare namespace Electron {
      * @deprecated
      */
     clearHistory(): void;
+    /**
+     * A cloned WebContents instance. This method creates a copy of the WebContents
+     * with the following attributes:
+     *
+     * * **WebPreferences** - All preferences from the original WebContents are copied
+     * * **SiteInstance** - Uses the same SiteInstance as the original. This means the
+     * cloned WebContents will reuse the same render process as the original when
+     * loading same-origin pages, and only spawn a new render process for cross-origin
+     * navigations. This process allocation behavior is consistent with window.open and
+     * tab duplication in Chromium. For more details, see Chromium's Site Isolation
+     * design document.
+     * * **Opener relationship** - Inherits the opener (window.opener) relationship
+     * * **Navigation state** - Copies the navigation history and controller state
+     *
+     * The cloned WebContents is an independent instance with its own lifecycle that
+     * can be destroyed separately and will not contain any open web pages.
+     *
+     * This API is useful for use cases where you want to create a new WebContents that
+     * shares the same render process with the original for same-origin content, while
+     * maintaining full lifecycle independence. Additionally, reusing the existing
+     * render process can help optimize memory usage and page load speed to a certain
+     * extent, as it eliminates the overhead of spawning and initializing a new render
+     * process from scratch.
+     */
+    clone(): WebContents;
     /**
      * Closes the page, as if the web content had called `window.close()`.
      *
@@ -17762,6 +17841,11 @@ declare namespace Electron {
      * Copy the image at the given position to the clipboard.
      */
     copyImageAt(x: number, y: number): void;
+    /**
+     * When executed on a video media element, copies the frame at (x, y) to the
+     * clipboard.
+     */
+    copyVideoFrameAt(x: number, y: number): void;
     /**
      * Executes the editing command `cut` in web page.
      */
@@ -18159,6 +18243,11 @@ declare namespace Electron {
      * resolves if the page is saved.
      */
     savePage(fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML'): Promise<void>;
+    /**
+     * When executed on a video media element, shows a save dialog and saves the frame
+     * at (x, y) to disk.
+     */
+    saveVideoFrameAs(x: number, y: number): void;
     /**
      * Scrolls to the bottom of the current `webContents`.
      */
@@ -18753,6 +18842,11 @@ declare namespace Electron {
      * @experimental
      */
     collectJavaScriptCallStack(): (Promise<string>) | (Promise<void>);
+    /**
+     * When executed on a video media element, copies the frame at (x, y) to the
+     * clipboard.
+     */
+    copyVideoFrameAt(x: number, y: number): void;
     /**
      * A promise that resolves with the result of the executed code or is rejected if
      * execution throws or results in a rejected promise.
@@ -18784,6 +18878,11 @@ declare namespace Electron {
      * frame has no history.
      */
     reload(): boolean;
+    /**
+     * When executed on a video media element, shows a save dialog and saves the frame
+     * at (x, y) to disk.
+     */
+    saveVideoFrameAs(x: number, y: number): void;
     /**
      * Send an asynchronous message to the renderer process via `channel`, along with
      * arguments. Arguments will be serialized with the Structured Clone Algorithm,
@@ -20196,6 +20295,12 @@ declare namespace Electron {
      * Defaults to 1.0.
      */
     scaleFactor?: number;
+    /**
+     * The target color space for the output pixel data. Defaults to sRGB. Pass the
+     * image's original color space to preserve the previous behavior, or another color
+     * space to get pixel values in that space.
+     */
+    colorSpace?: ColorSpace;
   }
 
   interface BlinkMemoryInfo {
@@ -20318,10 +20423,10 @@ declare namespace Electron {
     origin?: string;
     /**
      * The types of storages to clear, can be `cookies`, `filesystem`, `indexdb`,
-     * `localstorage`, `shadercache`, `websql`, `serviceworkers`, `cachestorage`. If
-     * not specified, clear all storage types.
+     * `localstorage`, `shadercache`, `serviceworkers`, `cachestorage`. If not
+     * specified, clear all storage types.
      */
-    storages?: Array<'cookies' | 'filesystem' | 'indexdb' | 'localstorage' | 'shadercache' | 'websql' | 'serviceworkers' | 'cachestorage'>;
+    storages?: Array<'cookies' | 'filesystem' | 'indexdb' | 'localstorage' | 'shadercache' | 'serviceworkers' | 'cachestorage'>;
   }
 
   interface ClientCertRequestParams {
@@ -20890,6 +20995,22 @@ declare namespace Electron {
     scaleFactor?: number;
   }
 
+  interface CreateFromNamedImageOptions {
+    hslShift?: number[];
+    /**
+     * Defaults to `30.0`.
+     */
+    pointSize?: number;
+    /**
+     * Defaults to `regular`.
+     */
+    weight?: ('ultralight') | ('thin') | ('light') | ('regular') | ('medium') | ('semibold') | ('bold') | ('heavy') | ('black');
+    /**
+     * Defaults to `medium`.
+     */
+    scale?: ('small') | ('medium') | ('large');
+  }
+
   interface CreateInterruptedDownloadOptions {
     /**
      * Absolute path of the download.
@@ -21308,6 +21429,22 @@ declare namespace Electron {
      * Current working directory of the child process.
      */
     cwd?: string;
+    /**
+     * Sets the session used by the process for network requests. By default, network
+     * requests from the utility process will use the system network context which does
+     * not have HTTP cache support. Setting a session enables HTTP caching and other
+     * session-specific network features. See session for more information.
+     */
+    session?: Session;
+    /**
+     * Sets the session used by the process according to the session's partition
+     * string. If `partition` starts with `persist:`, the process will use a persistent
+     * session available to all pages in the app with the same `partition`. If there is
+     * no `persist:` prefix, the process will use an in-memory session. By assigning
+     * the same `partition`, multiple processes can share the same session. If the
+     * `session` option is set, this option is ignored.
+     */
+    partition?: string;
     /**
      * Allows configuring the mode for `stdout` and `stderr` of the child process.
      * Default is `inherit`. String value can be one of `pipe`, `ignore`, `inherit`,
@@ -21349,9 +21486,11 @@ declare namespace Electron {
     disclaim?: boolean;
     /**
      * With this flag, all HTTP 401 and 407 network requests created via the net module
-     * will allow responding to them via the `app#login` event in the main process
-     * instead of the default `login` event on the `ClientRequest` object. Default is
-     * `false`.
+     * will allow responding to them via the `login` event on the `UtilityProcess`
+     * instance when a `session` is provided, or via the `app#login` event in the main
+     * process when using the default system network context. Without this flag, auth
+     * challenges are handled by the default `login` event on the `ClientRequest`
+     * object. Default is `false`.
      */
     respondToAuthRequestsFromMainProcess?: boolean;
   }
@@ -21777,6 +21916,7 @@ declare namespace Electron {
     role?: ('undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteAndMatchStyle' | 'delete' | 'selectAll' | 'reload' | 'forceReload' | 'toggleDevTools' | 'resetZoom' | 'zoomIn' | 'zoomOut' | 'toggleSpellChecker' | 'togglefullscreen' | 'window' | 'minimize' | 'close' | 'help' | 'about' | 'services' | 'hide' | 'hideOthers' | 'unhide' | 'quit' | 'showSubstitutions' | 'toggleSmartQuotes' | 'toggleSmartDashes' | 'toggleTextReplacement' | 'startSpeaking' | 'stopSpeaking' | 'zoom' | 'front' | 'appMenu' | 'fileMenu' | 'editMenu' | 'viewMenu' | 'shareMenu' | 'recentDocuments' | 'toggleTabBar' | 'selectNextTab' | 'selectPreviousTab' | 'showAllTabs' | 'mergeAllWindows' | 'clearRecentDocuments' | 'moveTabToNewWindow' | 'windowMenu');
     type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio' | 'header' | 'palette');
     label?: string;
+    accessibilityLabel?: string;
     /**
      * Available in macOS >= 14.4
      *
@@ -22229,7 +22369,7 @@ declare namespace Electron {
      *
      * @experimental
      */
-    sharedTexturePixelFormat?: ('argb' | 'rgbaf16');
+    sharedTexturePixelFormat?: ('argb' | 'rgbaf16' | 'nv12');
     /**
      * The device scale factor of the offscreen rendering output. If not set, will use
      * `1` as default.
@@ -22452,6 +22592,11 @@ declare namespace Electron {
 
   interface OpenDialogOptions {
     title?: string;
+    /**
+     * Absolute directory path, absolute file path, or file name to use by default. If
+     * not provided, the dialog will default to the user's Downloads folder, or their
+     * home directory if Downloads doesn't exist.
+     */
     defaultPath?: string;
     /**
      * Custom label for the confirmation button, when left empty the default label will
@@ -22500,6 +22645,11 @@ declare namespace Electron {
 
   interface OpenDialogSyncOptions {
     title?: string;
+    /**
+     * Absolute directory path, absolute file path, or file name to use by default. If
+     * not provided, the dialog will default to the user's Downloads folder, or their
+     * home directory if Downloads doesn't exist.
+     */
     defaultPath?: string;
     /**
      * Custom label for the confirmation button, when left empty the default label will
@@ -23017,7 +23167,9 @@ declare namespace Electron {
      */
     title?: string;
     /**
-     * Absolute directory path, absolute file path, or file name to use by default.
+     * Absolute directory path, absolute file path, or file name to use by default. If
+     * not provided, the dialog will default to the user's Downloads folder, or their
+     * home directory if Downloads doesn't exist.
      */
     defaultPath?: string;
     /**
@@ -23080,7 +23232,9 @@ declare namespace Electron {
      */
     title?: string;
     /**
-     * Absolute directory path, absolute file path, or file name to use by default.
+     * Absolute directory path, absolute file path, or file name to use by default. If
+     * not provided, the dialog will default to the user's Downloads folder, or their
+     * home directory if Downloads doesn't exist.
      */
     defaultPath?: string;
     /**
@@ -23453,6 +23607,12 @@ declare namespace Electron {
      * Defaults to 1.0.
      */
     scaleFactor?: number;
+    /**
+     * The target color space for the output pixel data. Defaults to sRGB. Pass the
+     * image's original color space to preserve the previous behavior, or another color
+     * space to get pixel values in that space.
+     */
+    colorSpace?: ColorSpace;
   }
 
   interface ToDataURLOptions {
@@ -24498,6 +24658,14 @@ declare namespace Electron {
      * `<TEAM_ID>.<BUNDLE_ID>.webauthn`.
      */
     keychainAccessGroup: string;
+    /**
+     * Customizes the reason text shown in the macOS Touch ID prompt. macOS renders the
+     * prompt as `"<App Name>" is trying to <promptReason>`, so the value should be a
+     * lowercase sentence fragment. An optional `$1` placeholder is replaced with the
+     * relying party ID (e.g. `example.com`) of the request being authenticated.
+     * Defaults to `verify your identity on $1`.
+     */
+    promptReason?: string;
   }
 
   interface Video {
@@ -24618,6 +24786,7 @@ declare namespace Electron {
     type CrashReporterStartOptions = Electron.CrashReporterStartOptions;
     type CreateFromBitmapOptions = Electron.CreateFromBitmapOptions;
     type CreateFromBufferOptions = Electron.CreateFromBufferOptions;
+    type CreateFromNamedImageOptions = Electron.CreateFromNamedImageOptions;
     type CreateInterruptedDownloadOptions = Electron.CreateInterruptedDownloadOptions;
     type Data = Electron.Data;
     type DecryptStringAsyncReturnValue = Electron.DecryptStringAsyncReturnValue;
@@ -25024,6 +25193,7 @@ declare namespace Electron {
     type CrashReporterStartOptions = Electron.CrashReporterStartOptions;
     type CreateFromBitmapOptions = Electron.CreateFromBitmapOptions;
     type CreateFromBufferOptions = Electron.CreateFromBufferOptions;
+    type CreateFromNamedImageOptions = Electron.CreateFromNamedImageOptions;
     type CreateInterruptedDownloadOptions = Electron.CreateInterruptedDownloadOptions;
     type Data = Electron.Data;
     type DecryptStringAsyncReturnValue = Electron.DecryptStringAsyncReturnValue;
@@ -25358,6 +25528,7 @@ declare namespace Electron {
     type CrashReporterStartOptions = Electron.CrashReporterStartOptions;
     type CreateFromBitmapOptions = Electron.CreateFromBitmapOptions;
     type CreateFromBufferOptions = Electron.CreateFromBufferOptions;
+    type CreateFromNamedImageOptions = Electron.CreateFromNamedImageOptions;
     type CreateInterruptedDownloadOptions = Electron.CreateInterruptedDownloadOptions;
     type Data = Electron.Data;
     type DecryptStringAsyncReturnValue = Electron.DecryptStringAsyncReturnValue;
@@ -25691,6 +25862,7 @@ declare namespace Electron {
     type CrashReporterStartOptions = Electron.CrashReporterStartOptions;
     type CreateFromBitmapOptions = Electron.CreateFromBitmapOptions;
     type CreateFromBufferOptions = Electron.CreateFromBufferOptions;
+    type CreateFromNamedImageOptions = Electron.CreateFromNamedImageOptions;
     type CreateInterruptedDownloadOptions = Electron.CreateInterruptedDownloadOptions;
     type Data = Electron.Data;
     type DecryptStringAsyncReturnValue = Electron.DecryptStringAsyncReturnValue;
@@ -26118,6 +26290,7 @@ declare namespace Electron {
     type CrashReporterStartOptions = Electron.CrashReporterStartOptions;
     type CreateFromBitmapOptions = Electron.CreateFromBitmapOptions;
     type CreateFromBufferOptions = Electron.CreateFromBufferOptions;
+    type CreateFromNamedImageOptions = Electron.CreateFromNamedImageOptions;
     type CreateInterruptedDownloadOptions = Electron.CreateInterruptedDownloadOptions;
     type Data = Electron.Data;
     type DecryptStringAsyncReturnValue = Electron.DecryptStringAsyncReturnValue;

package/dist/version.json

@@ -1,4 +1,4 @@
 {
-  "electronVersion": "42.0.1",
-  "extractedAt": "2026-05-09T01:03:50.343Z"
+  "electronVersion": "43.0.0-alpha.2",
+  "extractedAt": "2026-05-14T01:09:15.209Z"
 }

package/package.json

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