electron 12.0.0-beta.7 → 12.0.1

package/README.md

@@ -29,15 +29,12 @@ The preferred method is to install Electron as a development dependency in your
 app:
 
 ```sh
-npm install electron --save-dev [--save-exact]
+npm install electron --save-dev
 ```
 
-The `--save-exact` flag is recommended for Electron prior to version 2, as it does not follow semantic
-versioning. As of version 2.0.0, Electron follows semver, so you don't need `--save-exact` flag. For info on how to manage Electron versions in your apps, see
-[Electron versioning](docs/tutorial/electron-versioning.md).
-
 For more installation options and troubleshooting tips, see
-[installation](docs/tutorial/installation.md).
+[installation](docs/tutorial/installation.md). For info on how to manage Electron versions in your apps, see
+[Electron versioning](docs/tutorial/electron-versioning.md).
 
 ## Quick start & Electron Fiddle
 

package/electron.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Electron 12.0.0-beta.7
+// Type definitions for Electron 12.0.1
 // Project: http://electronjs.org/
 // Definitions by: The Electron Team <https://github.com/electron/electron>
 // Definitions: https://github.com/electron/electron-typescript-definitions
@@ -558,6 +558,16 @@ You should call `event.preventDefault()` if you want to handle this event.
     removeListener(event: 'render-process-gone', listener: (event: Event,
                                                 webContents: WebContents,
                                                 details: RenderProcessGoneDetails) => void): this;
+    /**
+     * Emitted when the renderer process of `webContents` crashes or is killed.
+     *
+     * **Deprecated:** This event is superceded by the `render-process-gone` event
+     * which contains more information about why the render process disappeared. It
+     * isn't always because it crashed.  The `killed` boolean can be replaced by
+     * checking `reason === 'killed'` when you switch to that event.
+     *
+     * @deprecated
+     */
     on(event: 'renderer-process-crashed', listener: (event: Event,
                                                      webContents: WebContents,
                                                      killed: boolean) => void): this;
@@ -1281,7 +1291,7 @@ By default this API will return `false`.
      *
      * @platform linux,darwin
      */
-    setBadgeCount(count: number): boolean;
+    setBadgeCount(count?: number): boolean;
     /**
      * Sets or removes a custom Jump List for the application, and returns one of the
      * following strings:
@@ -2211,7 +2221,7 @@ Calling `event.preventDefault()` will prevent the menu from being displayed.
      * Resolves with a NativeImage
      *
      * Captures a snapshot of the page within `rect`. Omitting `rect` will capture the
-     * whole visible page.
+     * whole visible page. If the page is not visible, `rect` may be empty.
      */
     capturePage(rect?: Rectangle): Promise<Electron.NativeImage>;
     /**
@@ -2623,7 +2633,8 @@ On Linux always returns `true`.
      * and height are within the content view--only that they exist. Sum any extra
      * width and height areas you have within the overall content view.
      *
-     * @platform darwin,linux
+     * The aspect ratio is not respected when window is resized programmingly with APIs
+     * like `win.setSize`.
      */
     setAspectRatio(aspectRatio: number, extraSize?: Size): void;
     /**
@@ -2909,6 +2920,13 @@ On macOS it does not remove the focus from the window.
      * Changes the title of native window to `title`.
      */
     setTitle(title: string): void;
+    /**
+     * Raises `browserView` above other `BrowserView`s attached to `win`. Throws an
+     * error if `browserView` is not attached to `win`.
+     *
+     * @experimental
+     */
+    setTopBrowserView(browserView: BrowserView): void;
     /**
      * Sets the touchBar layout for the current window. Specifying `null` or
      * `undefined` clears the touch bar. This method only has an effect if the machine
@@ -3527,7 +3545,7 @@ This cannot be called when `titleBarStyle` is set to `customButtonsOnHover`.
 
     // Docs: https://electronjs.org/docs/api/context-bridge
 
-    exposeInMainWorld(apiKey: string, api: Record<string, any>): void;
+    exposeInMainWorld(apiKey: string, api: any): void;
   }
 
   interface Cookie {
@@ -4869,6 +4887,10 @@ Retrieves the product descriptions.
      * A list of MessagePorts that were transferred with this message
      */
     ports: MessagePortMain[];
+    /**
+     * The internal ID of the renderer process that sent this message
+     */
+    processId: number;
     /**
      * A function that will send an IPC message to the renderer frame that sent the
      * original message that you are currently handling.  You should use this method to
@@ -4884,6 +4906,11 @@ Retrieves the product descriptions.
      * Returns the `webContents` that sent the message
      */
     sender: WebContents;
+    /**
+     * The frame that sent this message
+     *
+     */
+    readonly senderFrame: WebFrameMain;
   }
 
   interface IpcMainInvokeEvent extends Event {
@@ -4894,10 +4921,19 @@ Retrieves the product descriptions.
      * The ID of the renderer frame that sent this message
      */
     frameId: number;
+    /**
+     * The internal ID of the renderer process that sent this message
+     */
+    processId: number;
     /**
      * Returns the `webContents` that sent the message
      */
     sender: WebContents;
+    /**
+     * The frame that sent this message
+     *
+     */
+    readonly senderFrame: WebFrameMain;
   }
 
   interface IpcRenderer extends NodeJS.EventEmitter {
@@ -4913,11 +4949,10 @@ Retrieves the product descriptions.
      * included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw
      * an exception.
      *
-     * > **NOTE**: Sending non-standard JavaScript types such as DOM objects or special
-     * Electron objects is deprecated, and will begin throwing an exception starting
-     * with Electron 9.
+     * > **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
+     * Electron objects will throw an exception.
      *
-     * > **NOTE:** Since the main process does not have support for DOM objects such as
+     * Since the main process does not have support for DOM objects such as
      * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
      * Electron's IPC to the main process, as the main process would have no way to
      * decode them. Attempting to send such objects over IPC will result in an error.
@@ -4973,10 +5008,9 @@ Retrieves the product descriptions.
      * exception.
      *
      * > **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
-     * Electron objects is deprecated, and will begin throwing an exception starting
-     * with Electron 9.
+     * Electron objects will throw an exception.
      *
-     * > **NOTE:** Since the main process does not have support for DOM objects such as
+     * Since the main process does not have support for DOM objects such as
      * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
      * Electron's IPC to the main process, as the main process would have no way to
      * decode them. Attempting to send such objects over IPC will result in an error.
@@ -5000,11 +5034,10 @@ Retrieves the product descriptions.
      * Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw an
      * exception.
      *
-     * > **NOTE**: Sending non-standard JavaScript types such as DOM objects or special
-     * Electron objects is deprecated, and will begin throwing an exception starting
-     * with Electron 9.
+     * > **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
+     * Electron objects will throw an exception.
      *
-     * > **NOTE:** Since the main process does not have support for DOM objects such as
+     * Since the main process does not have support for DOM objects such as
      * `ImageBitmap`, `File`, `DOMMatrix` and so on, such objects cannot be sent over
      * Electron's IPC to the main process, as the main process would have no way to
      * decode them. Attempting to send such objects over IPC will result in an error.
@@ -7229,7 +7262,7 @@ Clears the host resolver cache.
      * **Note:** Loading extensions into in-memory (non-persistent) sessions is not
      * supported and will throw an error.
      */
-    loadExtension(path: string): Promise<Electron.Extension>;
+    loadExtension(path: string, options?: LoadExtensionOptions): Promise<Electron.Extension>;
     /**
      * Preconnects the given number of sockets to an origin.
      */
@@ -7282,7 +7315,7 @@ Clears the host resolver cache.
      * `callback(false)` will reject it. To clear the handler, call
      * `setPermissionRequestHandler(null)`.
      */
-    setPermissionRequestHandler(handler: ((webContents: WebContents, permission: 'clipboard-read' | 'media' | 'mediaKeySystem' | 'geolocation' | 'notifications' | 'midi' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal', callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
+    setPermissionRequestHandler(handler: ((webContents: WebContents, permission: 'clipboard-read' | 'media' | 'display-capture' | 'mediaKeySystem' | 'geolocation' | 'notifications' | 'midi' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal', callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerHandlerDetails) => void) | (null)): void;
     /**
      * Adds scripts that will be executed on ALL web contents that are associated with
      * this session just before normal `preload` scripts run.
@@ -10537,8 +10570,7 @@ An example of `webContents.printToPDF`:
      * Functions, Promises, Symbols, WeakMaps, or WeakSets will throw an exception.
      *
      * > **NOTE**: Sending non-standard JavaScript types such as DOM objects or special
-     * Electron objects is deprecated, and will begin throwing an exception starting
-     * with Electron 9.
+     * Electron objects will throw an exception.
      *
      * The renderer process can handle the message by listening to `channel` with the
      * `ipcRenderer` module.
@@ -10558,9 +10590,8 @@ An example of sending messages from the main process to the renderer process:
      * not be included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets
      * will throw an exception.
      *
-     * > **NOTE**: Sending non-standard JavaScript types such as DOM objects or special
-     * Electron objects is deprecated, and will begin throwing an exception starting
-     * with Electron 9.
+     * > **NOTE:** Sending non-standard JavaScript types such as DOM objects or special
+     * Electron objects will throw an exception.
      *
      * The renderer process can handle the message by listening to `channel` with the
      * `ipcRenderer` module.
@@ -10570,7 +10601,7 @@ An example of sending messages from the main process to the renderer process:
      * 
 You can also read `frameId` from all incoming IPC messages in the main process.
      */
-    sendToFrame(frameId: number, channel: string, ...args: any[]): void;
+    sendToFrame(frameId: (number) | ([number, number]), channel: string, ...args: any[]): void;
     /**
      * Mute the audio on the current web page.
      */
@@ -10602,7 +10633,7 @@ An example of showing devtools in a `BrowserWindow`:
     setDevToolsWebContents(devToolsWebContents: WebContents): void;
     /**
      * If *offscreen rendering* is enabled sets the frame rate to the specified number.
-     * Only values between 1 and 60 are accepted.
+     * Only values between 1 and 240 are accepted.
      */
     setFrameRate(fps: number): void;
     /**
@@ -10904,9 +10935,10 @@ The factor must be greater than 0.0.
     // Docs: https://electronjs.org/docs/api/web-frame-main
 
     /**
-     * A frame with the given process and routing IDs.
+     * A frame with the given process and routing IDs, or `undefined` if there is no
+     * WebFrameMain associated with the given IDs.
      */
-    static fromId(processId: number, routingId: number): WebFrameMain;
+    static fromId(processId: number, routingId: number): (WebFrameMain) | (undefined);
     /**
      * A promise that resolves with the result of the executed code or is rejected if
      * execution throws or results in a rejected promise.
@@ -10918,11 +10950,33 @@ The factor must be greater than 0.0.
      * this limitation.
      */
     executeJavaScript(code: string, userGesture?: boolean): Promise<unknown>;
+    /**
+     * Send a message to the renderer process, optionally transferring ownership of
+     * zero or more [`MessagePortMain`][] objects.
+     *
+     * The transferred `MessagePortMain` objects will be available in the renderer
+     * process by accessing the `ports` property of the emitted event. When they arrive
+     * in the renderer, they will be native DOM `MessagePort` objects.
+
+For example:
+     */
+    postMessage(channel: string, message: any, transfer?: MessagePortMain[]): void;
     /**
      * Whether the reload was initiated successfully. Only results in `false` when the
      * frame has no history.
      */
     reload(): boolean;
+    /**
+     * Send an asynchronous message to the renderer process via `channel`, along with
+     * arguments. Arguments will be serialized with the [Structured Clone
+     * Algorithm][SCA], just like [`postMessage`][], so prototype chains will not be
+     * included. Sending Functions, Promises, Symbols, WeakMaps, or WeakSets will throw
+     * an exception.
+     *
+     * The renderer process can handle the message by listening to `channel` with the
+     * `ipcRenderer` module.
+     */
+    send(channel: string, ...args: any[]): void;
     readonly frames: WebFrameMain[];
     readonly framesInSubtree: WebFrameMain[];
     readonly frameTreeNodeId: number;
@@ -12860,6 +12914,15 @@ See webContents.sendInputEvent for detailed description of `event` object.
     isMainFrame: boolean;
   }
 
+  interface LoadExtensionOptions {
+    /**
+     * Whether to allow the extension to read local files over `file://` protocol and
+     * inject content scripts into `file://` pages. This is required e.g. for loading
+     * devtools extensions on `file://` URLs. Defaults to false.
+     */
+    allowFileAccess: boolean;
+  }
+
   interface LoadFileOptions {
     /**
      * Passed to `url.format()`.
@@ -13341,6 +13404,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13360,6 +13425,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13371,6 +13438,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13382,6 +13451,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13397,6 +13468,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13412,6 +13485,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13426,6 +13501,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13443,6 +13520,8 @@ See webContents.sendInputEvent for detailed description of `event` object.
     url: string;
     method: string;
     webContentsId?: number;
+    webContents?: WebContents;
+    frame?: WebFrameMain;
     resourceType: string;
     referrer: string;
     timestamp: number;
@@ -13789,6 +13868,11 @@ See webContents.sendInputEvent for detailed description of `event` object.
      * The reason the render process is gone.  Possible values:
      */
     reason: ('clean-exit' | 'abnormal-exit' | 'killed' | 'crashed' | 'oom' | 'launch-failed' | 'integrity-failure');
+    /**
+     * The exit code of the process, unless `reason` is `launch-failed`, in which case
+     * `exitCode` will be a platform-specific launch failure error code.
+     */
+    exitCode: number;
   }
 
   interface Request {
@@ -14778,7 +14862,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     offscreen?: boolean;
     /**
      * Whether to run Electron APIs and the specified `preload` script in a separate
-     * JavaScript context. Defaults to `false`. The context that the `preload` script
+     * JavaScript context. Defaults to `true`. The context that the `preload` script
      * runs in will only have access to its own dedicated `document` and `window`
      * globals, as well as its own set of JavaScript builtins (`Array`, `Object`,
      * `JSON`, etc.), which are all invisible to the loaded content. The Electron API
@@ -14794,8 +14878,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     /**
      * If true, values returned from `webFrame.executeJavaScript` will be sanitized to
      * ensure JS values can't unsafely cross between worlds when using
-     * `contextIsolation`.  The default is `false`. In Electron 12, the default will be
-     * changed to `true`. _Deprecated_
+     * `contextIsolation`. Defaults to `true`. _Deprecated_
      */
     worldSafeExecuteJavaScript?: boolean;
     /**
@@ -15023,6 +15106,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     type Item = Electron.Item;
     type JumpListSettings = Electron.JumpListSettings;
     type LoadCommitEvent = Electron.LoadCommitEvent;
+    type LoadExtensionOptions = Electron.LoadExtensionOptions;
     type LoadFileOptions = Electron.LoadFileOptions;
     type LoadURLOptions = Electron.LoadURLOptions;
     type LoginItemSettings = Electron.LoginItemSettings;
@@ -15279,6 +15363,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     type Item = Electron.Item;
     type JumpListSettings = Electron.JumpListSettings;
     type LoadCommitEvent = Electron.LoadCommitEvent;
+    type LoadExtensionOptions = Electron.LoadExtensionOptions;
     type LoadFileOptions = Electron.LoadFileOptions;
     type LoadURLOptions = Electron.LoadURLOptions;
     type LoginItemSettings = Electron.LoginItemSettings;
@@ -15488,6 +15573,7 @@ See webContents.sendInputEvent for detailed description of `event` object.
     type Item = Electron.Item;
     type JumpListSettings = Electron.JumpListSettings;
     type LoadCommitEvent = Electron.LoadCommitEvent;
+    type LoadExtensionOptions = Electron.LoadExtensionOptions;
     type LoadFileOptions = Electron.LoadFileOptions;
     type LoadURLOptions = Electron.LoadURLOptions;
     type LoginItemSettings = Electron.LoginItemSettings;

package/package.json

@@ -16,7 +16,7 @@
     "node": ">= 8.6"
   },
   "name": "electron",
-  "version": "12.0.0-beta.7",
+  "version": "12.0.1",
   "repository": "https://github.com/electron/electron",
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "license": "MIT",