feat: expose electron/{process} typed modules (electron#22937)

MarshallOfSound · web-flow · commit 0d2e9679600b · 2020-04-06T17:04:09.000-07:00
* feat: expose electron/{process} typed modules

* chore: update imports for common modules

* chore: update typescript generator

* chore: remap electron/* to the internal packages
diff --git a/docs/api/process.md b/docs/api/process.md
@@ -111,7 +111,11 @@ A `Boolean` that controls whether or not process warnings printed to `stderr` in
 
 ### `process.type` _Readonly_
 
-A `String` representing the current process's type, can be `"browser"` (i.e. main process), `"renderer"`, or `"worker"` (i.e. web worker).
+A `String` representing the current process's type, can be:
+
+* `browser` - The main process
+* `renderer` - A renderer process
+* `worker` - In a web worker
 
 ### `process.versions.chrome` _Readonly_
 
diff --git a/lib/common/reset-search-paths.ts b/lib/common/reset-search-paths.ts
@@ -22,19 +22,29 @@ Module._nodeModulePaths = function (from: string) {
 };
 
 // Make a fake Electron module that we will insert into the module cache
-const electronModule = new Module('electron', null);
-electronModule.id = 'electron';
-electronModule.loaded = true;
-electronModule.filename = 'electron';
-Object.defineProperty(electronModule, 'exports', {
-  get: () => require('electron')
-});
+const makeElectronModule = (name: string) => {
+  const electronModule = new Module('electron', null);
+  electronModule.id = 'electron';
+  electronModule.loaded = true;
+  electronModule.filename = name;
+  Object.defineProperty(electronModule, 'exports', {
+    get: () => require('electron')
+  });
+  Module._cache[name] = electronModule;
+};
 
-Module._cache.electron = electronModule;
+makeElectronModule('electron');
+makeElectronModule('electron/common');
+if (process.type === 'browser') {
+  makeElectronModule('electron/main');
+}
+if (process.type === 'renderer') {
+  makeElectronModule('electron/renderer');
+}
 
 const originalResolveFilename = Module._resolveFilename;
 Module._resolveFilename = function (request: string, parent: NodeModule, isMain: boolean) {
-  if (request === 'electron') {
+  if (request === 'electron' || request.startsWith('electron/')) {
     return 'electron';
   } else {
     return originalResolveFilename(request, parent, isMain);
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "description": "Build cross platform desktop apps with JavaScript, HTML, and CSS",
   "devDependencies": {
     "@electron/docs-parser": "^0.7.2",
-    "@electron/typescript-definitions": "^8.6.4",
+    "@electron/typescript-definitions": "^8.7.2",
     "@octokit/rest": "^16.3.2",
     "@primer/octicons": "^9.1.1",
     "@types/basic-auth": "^1.1.3",
diff --git a/spec-main/ambient.d.ts b/spec-main/ambient.d.ts
@@ -29,6 +29,12 @@ declare namespace Electron {
   class WebContentsView {
     constructor(webContents: WebContents)
   }
+
+  namespace Main {
+    class TopLevelWindow extends Electron.TopLevelWindow {}
+    class View extends Electron.View {}
+    class WebContentsView extends Electron.WebContentsView {}
+  }
 }
 
 declare module 'dbus-native';
diff --git a/spec-main/api-app-spec.ts b/spec-main/api-app-spec.ts
@@ -5,7 +5,7 @@ import * as http from 'http';
 import * as net from 'net';
 import * as fs from 'fs';
 import * as path from 'path';
-import { app, BrowserWindow, Menu, session } from 'electron';
+import { app, BrowserWindow, Menu, session } from 'electron/main';
 import { emittedOnce } from './events-helpers';
 import { closeWindow, closeAllWindows } from './window-helpers';
 import { ifdescribe } from './spec-helpers';
diff --git a/spec-main/api-auto-updater-spec.ts b/spec-main/api-auto-updater-spec.ts
@@ -1,4 +1,4 @@
-import { autoUpdater } from 'electron';
+import { autoUpdater } from 'electron/main';
 import { expect } from 'chai';
 import { ifit, ifdescribe } from './spec-helpers';
 
diff --git a/spec-main/api-browser-view-spec.ts b/spec-main/api-browser-view-spec.ts
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import * as ChildProcess from 'child_process';
 import * as path from 'path';
 import { emittedOnce } from './events-helpers';
-import { BrowserView, BrowserWindow } from 'electron';
+import { BrowserView, BrowserWindow } from 'electron/main';
 import { closeWindow } from './window-helpers';
 
 describe('BrowserView module', () => {
diff --git a/spec-main/api-browser-window-affinity-spec.ts b/spec-main/api-browser-window-affinity-spec.ts
@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import * as path from 'path';
 
-import { ipcMain, BrowserWindow, WebPreferences, app } from 'electron';
+import { ipcMain, BrowserWindow, WebPreferences, app } from 'electron/main';
 import { closeWindow } from './window-helpers';
 
 describe('BrowserWindow with affinity module', () => {
diff --git a/spec-main/api-browser-window-spec.ts b/spec-main/api-browser-window-spec.ts
@@ -5,7 +5,7 @@ import * as os from 'os';
 import * as qs from 'querystring';
 import * as http from 'http';
 import { AddressInfo } from 'net';
-import { app, BrowserWindow, BrowserView, ipcMain, OnBeforeSendHeadersListenerDetails, protocol, screen, webContents, session, WebContents } from 'electron';
+import { app, BrowserWindow, BrowserView, ipcMain, OnBeforeSendHeadersListenerDetails, protocol, screen, webContents, session, WebContents } from 'electron/main';
 
 import { emittedOnce } from './events-helpers';
 import { ifit, ifdescribe } from './spec-helpers';
diff --git a/spec-main/api-content-tracing-spec.ts b/spec-main/api-content-tracing-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { app, contentTracing, TraceConfig, TraceCategoriesAndOptions } from 'electron';
+import { app, contentTracing, TraceConfig, TraceCategoriesAndOptions } from 'electron/main';
 import * as fs from 'fs';
 import * as path from 'path';
 import { ifdescribe } from './spec-helpers';
diff --git a/spec-main/api-context-bridge-spec.ts b/spec-main/api-context-bridge-spec.ts
@@ -1,4 +1,5 @@
-import { contextBridge, BrowserWindow, ipcMain } from 'electron';
+import { BrowserWindow, ipcMain } from 'electron/main';
+import { contextBridge } from 'electron/renderer';
 import { expect } from 'chai';
 import * as fs from 'fs-extra';
 import * as os from 'os';
@@ -45,10 +46,10 @@ describe('contextBridge', () => {
   const generateTests = (useSandbox: boolean) => {
     describe(`with sandbox=${useSandbox}`, () => {
       const makeBindingWindow = async (bindingCreator: Function) => {
-        const preloadContent = `const electron_1 = require('electron');
+        const preloadContent = `const renderer_1 = require('electron');
         ${useSandbox ? '' : `require('v8').setFlagsFromString('--expose_gc');
         const gc=require('vm').runInNewContext('gc');
-        electron_1.contextBridge.exposeInMainWorld('GCRunner', {
+        renderer_1.contextBridge.exposeInMainWorld('GCRunner', {
           run: () => gc()
         });`}
         (${bindingCreator.toString()})();`;
diff --git a/spec-main/api-crash-reporter-spec.ts b/spec-main/api-crash-reporter-spec.ts
@@ -7,7 +7,8 @@ import * as path from 'path';
 import { ifdescribe, ifit } from './spec-helpers';
 import * as temp from 'temp';
 import * as url from 'url';
-import { ipcMain, app, BrowserWindow, crashReporter, BrowserWindowConstructorOptions } from 'electron';
+import { ipcMain, app, BrowserWindow, BrowserWindowConstructorOptions } from 'electron/main';
+import { crashReporter } from 'electron/common';
 import { AddressInfo } from 'net';
 import { closeWindow, closeAllWindows } from './window-helpers';
 import { EventEmitter } from 'events';
diff --git a/spec-main/api-debugger-spec.ts b/spec-main/api-debugger-spec.ts
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import * as http from 'http';
 import * as path from 'path';
 import { AddressInfo } from 'net';
-import { BrowserWindow } from 'electron';
+import { BrowserWindow } from 'electron/main';
 import { closeAllWindows } from './window-helpers';
 import { emittedOnce } from './events-helpers';
 
diff --git a/spec-main/api-deprecate-spec.ts b/spec-main/api-deprecate-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { deprecate } from 'electron';
+import { deprecate } from 'electron/main';
 
 describe('deprecate', () => {
   let throwing: boolean;
diff --git a/spec-main/api-desktop-capturer-spec.ts b/spec-main/api-desktop-capturer-spec.ts
@@ -1,5 +1,6 @@
 import { expect } from 'chai';
-import { desktopCapturer, screen, BrowserWindow, SourcesOptions } from 'electron';
+import { screen, BrowserWindow, SourcesOptions } from 'electron/main';
+import { desktopCapturer } from 'electron/renderer';
 import { emittedOnce } from './events-helpers';
 import { ifdescribe, ifit } from './spec-helpers';
 import { closeAllWindows } from './window-helpers';
diff --git a/spec-main/api-dialog-spec.ts b/spec-main/api-dialog-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { dialog, BrowserWindow } from 'electron';
+import { dialog, BrowserWindow } from 'electron/main';
 import { closeAllWindows } from './window-helpers';
 import { ifit } from './spec-helpers';
 
diff --git a/spec-main/api-global-shortcut-spec.ts b/spec-main/api-global-shortcut-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { globalShortcut } from 'electron';
+import { globalShortcut } from 'electron/main';
 import { ifdescribe } from './spec-helpers';
 
 ifdescribe(process.platform !== 'win32')('globalShortcut module', () => {
diff --git a/spec-main/api-in-app-purchase-spec.ts b/spec-main/api-in-app-purchase-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { inAppPurchase } from 'electron';
+import { inAppPurchase } from 'electron/main';
 
 describe('inAppPurchase module', function () {
   if (process.platform !== 'darwin') return;
diff --git a/spec-main/api-ipc-main-spec.ts b/spec-main/api-ipc-main-spec.ts
@@ -3,7 +3,7 @@ import * as path from 'path';
 import * as cp from 'child_process';
 import { closeAllWindows } from './window-helpers';
 import { emittedOnce } from './events-helpers';
-import { ipcMain, BrowserWindow } from 'electron';
+import { ipcMain, BrowserWindow } from 'electron/main';
 
 describe('ipc main module', () => {
   const fixtures = path.join(__dirname, 'fixtures');
diff --git a/spec-main/api-ipc-renderer-spec.ts b/spec-main/api-ipc-renderer-spec.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import * as path from 'path';
-import { ipcMain, BrowserWindow, WebContents, WebPreferences, webContents } from 'electron';
+import { ipcMain, BrowserWindow, WebContents, WebPreferences, webContents } from 'electron/main';
 import { emittedOnce } from './events-helpers';
 import { closeWindow } from './window-helpers';
 
diff --git a/spec-main/api-ipc-spec.ts b/spec-main/api-ipc-spec.ts
@@ -1,6 +1,6 @@
 import { EventEmitter } from 'events';
 import { expect } from 'chai';
-import { BrowserWindow, ipcMain, IpcMainInvokeEvent, MessageChannelMain } from 'electron';
+import { BrowserWindow, ipcMain, IpcMainInvokeEvent, MessageChannelMain } from 'electron/main';
 import { closeAllWindows } from './window-helpers';
 import { emittedOnce } from './events-helpers';
 
diff --git a/spec-main/api-menu-item-spec.ts b/spec-main/api-menu-item-spec.ts
@@ -1,4 +1,4 @@
-import { BrowserWindow, app, Menu, MenuItem, MenuItemConstructorOptions } from 'electron';
+import { BrowserWindow, app, Menu, MenuItem, MenuItemConstructorOptions } from 'electron/main';
 import { expect } from 'chai';
 import { closeAllWindows } from './window-helpers';
 const { roleList, execute } = require('../lib/browser/api/menu-item-roles');
diff --git a/spec-main/api-menu-spec.ts b/spec-main/api-menu-spec.ts
@@ -1,7 +1,7 @@
 import * as cp from 'child_process';
 import * as path from 'path';
 import { expect } from 'chai';
-import { BrowserWindow, Menu, MenuItem } from 'electron';
+import { BrowserWindow, Menu, MenuItem } from 'electron/main';
 import { sortMenuItems } from '../lib/browser/api/menu-utils';
 import { emittedOnce } from './events-helpers';
 import { ifit } from './spec-helpers';
diff --git a/spec-main/api-native-theme-spec.ts b/spec-main/api-native-theme-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { nativeTheme, systemPreferences, BrowserWindow } from 'electron';
+import { nativeTheme, systemPreferences, BrowserWindow } from 'electron/main';
 import * as os from 'os';
 import * as path from 'path';
 import * as semver from 'semver';
diff --git a/spec-main/api-net-log-spec.ts b/spec-main/api-net-log-spec.ts
@@ -4,7 +4,7 @@ import * as fs from 'fs';
 import * as os from 'os';
 import * as path from 'path';
 import * as ChildProcess from 'child_process';
-import { session, net } from 'electron';
+import { session, net } from 'electron/main';
 import { Socket, AddressInfo } from 'net';
 import { ifit } from './spec-helpers';
 import { emittedOnce } from './events-helpers';
diff --git a/spec-main/api-net-spec.ts b/spec-main/api-net-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { net, session, ClientRequest, BrowserWindow } from 'electron';
+import { net, session, ClientRequest, BrowserWindow } from 'electron/main';
 import * as http from 'http';
 import * as url from 'url';
 import { AddressInfo, Socket } from 'net';
diff --git a/spec-main/api-notification-dbus-spec.ts b/spec-main/api-notification-dbus-spec.ts
@@ -8,7 +8,7 @@
 
 import { expect } from 'chai';
 import * as dbus from 'dbus-native';
-import { app } from 'electron';
+import { app } from 'electron/main';
 import { ifdescribe } from './spec-helpers';
 import { promisify } from 'util';
 
diff --git a/spec-main/api-notification-spec.ts b/spec-main/api-notification-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { Notification } from 'electron';
+import { Notification } from 'electron/main';
 import { emittedOnce } from './events-helpers';
 import { ifit } from './spec-helpers';
 
diff --git a/spec-main/api-power-save-blocker-spec.ts b/spec-main/api-power-save-blocker-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { powerSaveBlocker } from 'electron';
+import { powerSaveBlocker } from 'electron/main';
 
 describe('powerSaveBlocker module', () => {
   it('can be started and stopped', () => {
diff --git a/spec-main/api-protocol-spec.ts b/spec-main/api-protocol-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { protocol, webContents, WebContents, session, BrowserWindow, ipcMain } from 'electron';
+import { protocol, webContents, WebContents, session, BrowserWindow, ipcMain } from 'electron/main';
 import { promisify } from 'util';
 import { AddressInfo } from 'net';
 import * as ChildProcess from 'child_process';
diff --git a/spec-main/api-remote-spec.ts b/spec-main/api-remote-spec.ts
@@ -3,7 +3,7 @@ import { expect } from 'chai';
 import { closeAllWindows } from './window-helpers';
 import { ifdescribe } from './spec-helpers';
 
-import { ipcMain, BrowserWindow } from 'electron';
+import { ipcMain, BrowserWindow } from 'electron/main';
 import { emittedOnce } from './events-helpers';
 
 const features = process.electronBinding('features');
diff --git a/spec-main/api-screen-spec.ts b/spec-main/api-screen-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { screen } from 'electron';
+import { screen } from 'electron/main';
 
 describe('screen module', () => {
   describe('screen.getCursorScreenPoint()', () => {
diff --git a/spec-main/api-service-workers-spec.ts b/spec-main/api-service-workers-spec.ts
@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 import * as http from 'http';
 import * as path from 'path';
-import { session, BrowserWindow } from 'electron';
+import { session, BrowserWindow } from 'electron/main';
 import { expect } from 'chai';
 import { v4 } from 'uuid';
 import { AddressInfo } from 'net';
diff --git a/spec-main/api-session-spec.ts b/spec-main/api-session-spec.ts
@@ -4,7 +4,7 @@ import * as https from 'https';
 import * as path from 'path';
 import * as fs from 'fs';
 import * as ChildProcess from 'child_process';
-import { session, BrowserWindow, net, ipcMain, Session } from 'electron';
+import { session, BrowserWindow, net, ipcMain, Session } from 'electron/main';
 import * as send from 'send';
 import * as auth from 'basic-auth';
 import { closeAllWindows } from './window-helpers';
diff --git a/spec-main/api-shell-spec.ts b/spec-main/api-shell-spec.ts
@@ -1,4 +1,5 @@
-import { BrowserWindow, shell } from 'electron';
+import { BrowserWindow } from 'electron/main';
+import { shell } from 'electron/common';
 import { closeAllWindows } from './window-helpers';
 import { emittedOnce } from './events-helpers';
 import * as http from 'http';
diff --git a/spec-main/api-subframe-spec.ts b/spec-main/api-subframe-spec.ts
@@ -3,7 +3,7 @@ import * as path from 'path';
 import * as http from 'http';
 import { emittedNTimes, emittedOnce } from './events-helpers';
 import { closeWindow } from './window-helpers';
-import { app, BrowserWindow, ipcMain } from 'electron';
+import { app, BrowserWindow, ipcMain } from 'electron/main';
 import { AddressInfo } from 'net';
 import { ifdescribe } from './spec-helpers';
 
diff --git a/spec-main/api-system-preferences-spec.ts b/spec-main/api-system-preferences-spec.ts
@@ -1,5 +1,5 @@
 import { expect } from 'chai';
-import { systemPreferences } from 'electron';
+import { systemPreferences } from 'electron/main';
 import { ifdescribe } from './spec-helpers';
 
 describe('systemPreferences module', () => {
diff --git a/spec-main/api-touch-bar-spec.ts b/spec-main/api-touch-bar-spec.ts
@@ -1,5 +1,5 @@
 import * as path from 'path';
-import { BrowserWindow, TouchBar } from 'electron';
+import { BrowserWindow, TouchBar } from 'electron/main';
 import { closeWindow } from './window-helpers';
 import { expect } from 'chai';
 
diff --git a/spec-main/api-tray-spec.ts b/spec-main/api-tray-spec.ts
@@ -1,5 +1,6 @@
 import { expect } from 'chai';
-import { Menu, Tray, nativeImage } from 'electron';
+import { Menu, Tray } from 'electron/main';
+import { nativeImage } from 'electron/common';
 import { ifdescribe, ifit } from './spec-helpers';
 import * as path from 'path';
 
diff --git a/spec-main/api-view-spec.ts b/spec-main/api-view-spec.ts
@@ -1,5 +1,5 @@
 import { closeWindow } from './window-helpers';
-import { TopLevelWindow, View } from 'electron';
+import { TopLevelWindow, View } from 'electron/main';
 
 describe('View', () => {
   let w: TopLevelWindow;
diff --git a/spec-main/api-web-contents-spec.ts b/spec-main/api-web-contents-spec.ts
@@ -4,7 +4,8 @@ import * as path from 'path';
 import * as fs from 'fs';
 import * as http from 'http';
 import * as ChildProcess from 'child_process';
-import { BrowserWindow, ipcMain, webContents, session, WebContents, app, clipboard } from 'electron';
+import { BrowserWindow, ipcMain, webContents, session, WebContents, app } from 'electron/main';
+import { clipboard } from 'electron/common';
 import { emittedOnce } from './events-helpers';
 import { closeAllWindows } from './window-helpers';
 import { ifdescribe, ifit } from './spec-helpers';
diff --git a/spec-main/api-web-contents-view-spec.ts b/spec-main/api-web-contents-view-spec.ts
@@ -4,7 +4,7 @@ import * as path from 'path';
 import { emittedOnce } from './events-helpers';
 import { closeWindow } from './window-helpers';
 
-import { webContents, TopLevelWindow, WebContentsView } from 'electron';
+import { webContents, TopLevelWindow, WebContentsView } from 'electron/main';
 
 describe('WebContentsView', () => {
   let w: TopLevelWindow;
diff --git a/spec-main/api-web-frame-spec.ts b/spec-main/api-web-frame-spec.ts
@@ -1,6 +1,6 @@
 import { expect } from 'chai';
 import * as path from 'path';
-import { BrowserWindow, ipcMain } from 'electron';
+import { BrowserWindow, ipcMain } from 'electron/main';
 import { closeAllWindows } from './window-helpers';
 
 describe('webFrame module', () => {
diff --git a/spec-main/api-web-request-spec.ts b/spec-main/api-web-request-spec.ts
diff --git a/spec-main/asar-spec.ts b/spec-main/asar-spec.ts
diff --git a/spec-main/chromium-spec.ts b/spec-main/chromium-spec.ts
diff --git a/spec-main/extensions-spec.ts b/spec-main/extensions-spec.ts
diff --git a/spec-main/modules-spec.ts b/spec-main/modules-spec.ts
diff --git a/spec-main/node-spec.ts b/spec-main/node-spec.ts
diff --git a/spec-main/security-warnings-spec.ts b/spec-main/security-warnings-spec.ts
diff --git a/spec-main/spellchecker-spec.ts b/spec-main/spellchecker-spec.ts
diff --git a/spec-main/visibility-state-spec.ts b/spec-main/visibility-state-spec.ts
diff --git a/spec-main/webview-spec.ts b/spec-main/webview-spec.ts
diff --git a/spec-main/window-helpers.ts b/spec-main/window-helpers.ts
diff --git a/typings/internal-electron.d.ts b/typings/internal-electron.d.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -29,6 +29,12 @@ declare namespace Electron {`
`29`	`29`	`class WebContentsView {`
`30`	`30`	`constructor(webContents: WebContents)`
`31`	`31`	`}`
	`32`	`+`
	`33`	`+ namespace Main {`
	`34`	`+ class TopLevelWindow extends Electron.TopLevelWindow {}`
	`35`	`+ class View extends Electron.View {}`
	`36`	`+ class WebContentsView extends Electron.WebContentsView {}`
	`37`	`+ }`
`32`	`38`	`}`
`33`	`39`
`34`	`40`	`declare module 'dbus-native';`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { autoUpdater } from 'electron';`
	`1`	`+import { autoUpdater } from 'electron/main';`
`2`	`2`	`import { expect } from 'chai';`
`3`	`3`	`import { ifit, ifdescribe } from './spec-helpers';`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { BrowserWindow, app, Menu, MenuItem, MenuItemConstructorOptions } from 'electron';`
	`1`	`+import { BrowserWindow, app, Menu, MenuItem, MenuItemConstructorOptions } from 'electron/main';`
`2`	`2`	`import { expect } from 'chai';`
`3`	`3`	`import { closeAllWindows } from './window-helpers';`
`4`	`4`	`const { roleList, execute } = require('../lib/browser/api/menu-item-roles');`