allow prob builds with esbuild

kirjavascript · kirjavascript · commit f7bfb3224c4e · 2022-12-11T02:04:04.000Z
diff --git a/development/build.js b/development/build.js
@@ -74,9 +74,11 @@ module.exports = (mainWindow) => {
 
     buildSass();
 
-    require('chokidar')
-        .watch('./styles', { ignored: /[\/\\]\./ })
-        .on('change', buildSass);
+    if (devMode) {
+        require('chokidar')
+            .watch('./styles', { ignored: /[\/\\]\./ })
+            .on('change', buildSass);
+    }
 };
 
 const aliases = {
diff --git a/development/build.sh b/development/build.sh
@@ -1,7 +1,7 @@
 #!/bin/zsh
 # copy latest version of electron remote
 cp -r node_modules/@electron/remote ./static
-echo "TODO: prod build of js"
+node -e "require('./development/build')()"
 electron-packager ./static Flex2 --platform=win32 --arch=x64 \
     --asar --overwrite --package-manager yarn \
     --win32metadata.CompanyName="Flex 2" \
diff --git a/static/index.js b/static/index.js
@@ -28,7 +28,7 @@ function createWindow() {
     });
 
     if (devMode) {
-        require('./../development')(mainWindow);
+        require('./../development/build')(mainWindow);
     }
 }
 
diff --git a/static/remote/LICENSE b/static/remote/LICENSE
@@ -0,0 +1,20 @@
+Copyright (c) 2019-2022 Electron contributors
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/static/remote/README.md b/static/remote/README.md
@@ -52,12 +52,13 @@ configure your bundler appropriately to package the code of `@electron/remote`
 in the preload script. Of course, [using `@electron/remote` makes the sandbox
 much less effective][remote-considered-harmful].
 
-**Note:** `@electron/remote` respects the `enableRemoteModule` WebPreferences
+**Note:** In `electron >= 14.0.0`, you must use the new `enable` API to enable the remote module for each desired `WebContents` separately: `require("@electron/remote/main").enable(webContents)`.
+
+In `electron < 14.0.0`, `@electron/remote` respects the `enableRemoteModule` WebPreferences
 value. You must pass `{ webPreferences: { enableRemoteModule: true } }` to
 the constructor of `BrowserWindow`s that should be granted permission to use
 `@electron/remote`.
 
-
 # API Reference
 
 The `remote` module provides a simple way to do inter-process communication
@@ -85,7 +86,9 @@ of the remote module:
 require('@electron/remote/main').initialize()
 ```
 
-**Note:** The remote module can be disabled for security reasons in the following contexts:
+**Note:** In `electron >= 14.0.0` the remote module is disabled by default for any `WebContents` instance and is only enabled for specified `WebContents` after explicitly calling `require("@electron/remote/main").enable(webContents)`.
+
+In `electron < 14.0.0` the remote module can be disabled for security reasons in the following contexts:
 - [`BrowserWindow`](browser-window.md) - by setting the `enableRemoteModule` option to `false`.
 - [`<webview>`](webview-tag.md) - by setting the `enableremotemodule` attribute to `false`.
 
@@ -214,8 +217,8 @@ e.g.
 ```sh
 project/
 ├── main
-│   ├── foo.js
-│   └── index.js
+│   ├── foo.js
+│   └── index.js
 ├── package.json
 └── renderer
     └── index.js
@@ -339,4 +342,4 @@ Custom value can be returned by setting `event.returnValue`.
 
 [rmi]: https://en.wikipedia.org/wiki/Java_remote_method_invocation
 [enumerable-properties]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Enumerability_and_ownership_of_properties
-[remote-considered-harmful]: https://medium.com/@nornagon/electrons-remote-module-considered-harmful-70d69500f31
+[remote-considered-harmful]: https://medium.com/@nornagon/electrons-remote-module-considered-harmful-70d69500f31
diff --git a/static/remote/dist/src/common/module-names.js b/static/remote/dist/src/common/module-names.js
@@ -29,13 +29,16 @@ exports.browserModuleNames = [
     'powerMonitor',
     'powerSaveBlocker',
     'protocol',
+    'pushNotifications',
+    'safeStorage',
     'screen',
     'session',
     'ShareMenu',
     'systemPreferences',
     'TopLevelWindow',
     'TouchBar',
     'Tray',
+    'utilityProcess',
     'View',
     'webContents',
     'WebContentsView',
diff --git a/static/remote/dist/src/main/index.d.ts b/static/remote/dist/src/main/index.d.ts
@@ -1 +1 @@
-export { initialize } from './server';
+export { initialize, enable } from "./server";
diff --git a/static/remote/dist/src/main/index.js b/static/remote/dist/src/main/index.js
@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = void 0;
+exports.enable = exports.initialize = void 0;
 var server_1 = require("./server");
 Object.defineProperty(exports, "initialize", { enumerable: true, get: function () { return server_1.initialize; } });
+Object.defineProperty(exports, "enable", { enumerable: true, get: function () { return server_1.enable; } });
diff --git a/static/remote/dist/src/main/server.d.ts b/static/remote/dist/src/main/server.d.ts
@@ -1,3 +1,4 @@
 import { WebContents } from 'electron';
-export declare const isRemoteModuleEnabled: (contents: WebContents) => any;
+export declare const isRemoteModuleEnabled: (contents: WebContents) => boolean | undefined;
+export declare function enable(contents: WebContents): void;
 export declare function initialize(): void;
diff --git a/static/remote/dist/src/main/server.js b/static/remote/dist/src/main/server.js
@@ -3,13 +3,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialize = exports.isRemoteModuleEnabled = void 0;
+exports.initialize = exports.enable = exports.isRemoteModuleEnabled = void 0;
 const events_1 = require("events");
 const objects_registry_1 = __importDefault(require("./objects-registry"));
 const type_utils_1 = require("../common/type-utils");
 const electron_1 = require("electron");
 const get_electron_binding_1 = require("../common/get-electron-binding");
+const { Promise } = global;
 const v8Util = get_electron_binding_1.getElectronBinding('v8_util');
+const hasWebPrefsRemoteModuleAPI = (() => {
+    var _a, _b;
+    const electronVersion = Number((_b = (_a = process.versions.electron) === null || _a === void 0 ? void 0 : _a.split(".")) === null || _b === void 0 ? void 0 : _b[0]);
+    return Number.isNaN(electronVersion) || electronVersion < 14;
+})();
 // The internal properties of Function.
 const FUNCTION_PROPERTIES = [
     'length', 'name', 'arguments', 'caller', 'prototype'
@@ -293,19 +299,23 @@ const isRemoteModuleEnabledImpl = function (contents) {
 };
 const isRemoteModuleEnabledCache = new WeakMap();
 const isRemoteModuleEnabled = function (contents) {
-    if (!isRemoteModuleEnabledCache.has(contents)) {
+    if (hasWebPrefsRemoteModuleAPI && !isRemoteModuleEnabledCache.has(contents)) {
         isRemoteModuleEnabledCache.set(contents, isRemoteModuleEnabledImpl(contents));
     }
     return isRemoteModuleEnabledCache.get(contents);
 };
 exports.isRemoteModuleEnabled = isRemoteModuleEnabled;
+function enable(contents) {
+    isRemoteModuleEnabledCache.set(contents, true);
+}
+exports.enable = enable;
 const handleRemoteCommand = function (channel, handler) {
     electron_1.ipcMain.on(channel, (event, contextId, ...args) => {
         let returnValue;
         if (!exports.isRemoteModuleEnabled(event.sender)) {
             event.returnValue = {
                 type: 'exception',
-                value: valueToMeta(event.sender, contextId, new Error('@electron/remote is disabled for this WebContents. Set {enableRemoteModule: true} in WebPreferences to enable it.'))
+                value: valueToMeta(event.sender, contextId, new Error('@electron/remote is disabled for this WebContents. Call require("@electron/remote/main").enable(webContents) to enable it.'))
             };
             return;
         }
@@ -337,7 +347,7 @@ const logStack = function (contents, code, stack) {
 let initialized = false;
 function initialize() {
     if (initialized)
-        throw new Error('electron-remote has already been initialized');
+        throw new Error('@electron/remote has already been initialized');
     initialized = true;
     handleRemoteCommand("REMOTE_BROWSER_WRONG_CONTEXT_ERROR" /* BROWSER_WRONG_CONTEXT_ERROR */, function (event, contextId, passedContextId, id) {
         const objectId = [passedContextId, id];
@@ -431,7 +441,8 @@ function initialize() {
             return valueToMeta(event.sender, contextId, func(...args), true);
         }
         catch (error) {
-            const err = new Error(`Could not call remote function '${func.name || 'anonymous'}'. Check that the function signature is correct. Underlying error: ${error.message}\nUnderlying stack: ${error.stack}\n`);
+            const err = new Error(`Could not call remote function '${func.name || "anonymous"}'. Check that the function signature is correct. Underlying error: ${error}\n` +
+                (error instanceof Error ? `Underlying stack: ${error.stack}\n` : ""));
             err.cause = error;
             throw err;
         }
@@ -454,7 +465,8 @@ function initialize() {
             return valueToMeta(event.sender, contextId, object[method](...args), true);
         }
         catch (error) {
-            const err = new Error(`Could not call remote method '${method}'. Check that the method signature is correct. Underlying error: ${error.message}\nUnderlying stack: ${error.stack}\n`);
+            const err = new Error(`Could not call remote method '${method}'. Check that the method signature is correct. Underlying error: ${error}` +
+                (error instanceof Error ? `Underlying stack: ${error.stack}\n` : ""));
             err.cause = error;
             throw err;
         }
diff --git a/static/remote/dist/src/renderer/remote.js b/static/remote/dist/src/renderer/remote.js
@@ -6,6 +6,7 @@ const type_utils_1 = require("../common/type-utils");
 const electron_1 = require("electron");
 const module_names_1 = require("../common/module-names");
 const get_electron_binding_1 = require("../common/get-electron-binding");
+const { Promise } = global;
 const callbacksRegistry = new callbacks_registry_1.CallbacksRegistry();
 const remoteObjectCache = new Map();
 const finalizationRegistry = new FinalizationRegistry((id) => {
diff --git a/static/remote/index.d.ts b/static/remote/index.d.ts
@@ -1,20 +1,65 @@
-interface NodeRequireFunction {
-  (moduleName: 'electron'): typeof Electron;
-}
+import * as Electron from 'electron';
 
-interface NodeRequire extends NodeRequireFunction {
-  resolve: RequireResolve;
-  cache: NodeRequireCache;
-  /**
-   * @deprecated
-   */
-  extensions: NodeExtensions;
-  main: NodeModule | undefined;
-}
-
-export declare var require: NodeRequire;
+export {
+  ClientRequest,
+  CommandLine,
+  Cookies,
+  Debugger,
+  Dock,
+  DownloadItem,
+  IncomingMessage,
+  MessagePortMain,
+  ServiceWorkers,
+  TouchBarButton,
+  TouchBarColorPicker,
+  TouchBarGroup,
+  TouchBarLabel,
+  TouchBarOtherItemsProxy,
+  TouchBarPopover,
+  TouchBarScrubber,
+  TouchBarSegmentedControl,
+  TouchBarSlider,
+  TouchBarSpacer,
+  WebRequest,
+} from 'electron/main';
 
 // Taken from `RemoteMainInterface`
-export {app, autoUpdater, BrowserView, BrowserWindow, ClientRequest, clipboard, CommandLine, contentTracing, Cookies, crashReporter, Debugger, desktopCapturer, dialog, Dock, DownloadItem, globalShortcut, inAppPurchase, IncomingMessage, ipcMain, Menu, MenuItem, MessageChannelMain, MessagePortMain, nativeImage, nativeTheme, net, netLog, Notification, powerMonitor, powerSaveBlocker, protocol, screen, ServiceWorkers, session, shell, systemPreferences, TouchBar, TouchBarButton, TouchBarColorPicker, TouchBarGroup, TouchBarLabel, TouchBarOtherItemsProxy, TouchBarPopover, TouchBarScrubber, TouchBarSegmentedControl, TouchBarSlider, TouchBarSpacer, Tray, webContents, WebRequest} from 'electron';
-export * from './dist/src/main'
-export * from './dist/src/renderer';
+export var app: Electron.App;
+export var autoUpdater: Electron.AutoUpdater;
+export var BrowserView: typeof Electron.BrowserView;
+export var BrowserWindow: typeof Electron.BrowserWindow;
+export var clipboard: Electron.Clipboard;
+export var contentTracing: Electron.ContentTracing;
+export var crashReporter: Electron.CrashReporter;
+export var desktopCapturer: Electron.DesktopCapturer;
+export var dialog: Electron.Dialog;
+export var globalShortcut: Electron.GlobalShortcut;
+export var inAppPurchase: Electron.InAppPurchase;
+export var ipcMain: Electron.IpcMain;
+export var Menu: typeof Electron.Menu;
+export var MenuItem: typeof Electron.MenuItem;
+export var MessageChannelMain: typeof Electron.MessageChannelMain;
+export var nativeImage: typeof Electron.nativeImage;
+export var nativeTheme: Electron.NativeTheme;
+export var net: Electron.Net;
+export var netLog: Electron.NetLog;
+export var Notification: typeof Electron.Notification;
+export var powerMonitor: Electron.PowerMonitor;
+export var powerSaveBlocker: Electron.PowerSaveBlocker;
+export var protocol: Electron.Protocol;
+export var screen: Electron.Screen;
+export var session: typeof Electron.session;
+export var ShareMenu: typeof Electron.ShareMenu;
+export var shell: Electron.Shell;
+export var systemPreferences: Electron.SystemPreferences;
+export var TouchBar: typeof Electron.TouchBar;
+export var Tray: typeof Electron.Tray;
+export var webContents: typeof Electron.webContents;
+export var webFrameMain: typeof Electron.webFrameMain;
+
+// Taken from `Remote`
+export function getCurrentWebContents(): Electron.WebContents;
+export function getCurrentWindow(): Electron.BrowserWindow;
+export function getGlobal(name: string): any;
+export var process: NodeJS.Process;
+export var require: NodeJS.Require;
diff --git a/static/remote/main/index.d.ts b/static/remote/main/index.d.ts
@@ -0,0 +1 @@
+export * from '../dist/src/main';
diff --git a/static/remote/package.json b/static/remote/package.json
@@ -1,45 +1,44 @@
 {
   "name": "@electron/remote",
-  "version": "1.1.0",
+  "version": "2.0.9",
   "main": "renderer/index.js",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/electron/remote"
   },
   "peerDependencies": {
-    "electron": ">= 10.0.0-beta.1"
+    "electron": ">= 13.0.0"
   },
   "devDependencies": {
-    "@continuous-auth/semantic-release-npm": "^2.0.0",
+    "@continuous-auth/semantic-release-npm": "^3.0.0",
     "@types/chai": "^4.2.11",
     "@types/chai-as-promised": "^7.1.2",
     "@types/dirty-chai": "^2.0.2",
     "@types/mocha": "^7.0.2",
-    "@types/node": "^12.0.12",
+    "@types/node": "^14.17.0",
     "chai": "^4.2.0",
     "chai-as-promised": "^7.1.1",
     "dirty-chai": "^2.0.1",
-    "electron": "10.x",
-    "mocha": "^7.0.2",
+    "electron": "22.x",
+    "mocha": "^10.1.0",
     "mocha-junit-reporter": "^1.23.3",
     "mocha-multi-reporters": "^1.1.7",
-    "semantic-release": "^17.2.3",
     "ts-node": "^8.10.2",
     "typescript": "^4.1.3",
     "walkdir": "^0.4.1",
     "yargs": "^15.3.1"
   },
   "scripts": {
-    "prepublishOnly": "tsc",
+    "prepare": "tsc",
     "test": "electron test --extension=ts --require=ts-node/register --exit --js-flags=--expose_gc",
     "test:ci": "yarn test --reporter=mocha-multi-reporters --reporter-options=configFile=.circleci/mocha-reporter-config.json"
   },
   "files": [
     "README.md",
     "package.json",
-    "main/index.js",
-    "renderer/index.js",
+    "main",
+    "renderer",
     "dist/src",
     "index.d.ts"
   ],
diff --git a/static/remote/renderer/index.d.ts b/static/remote/renderer/index.d.ts
@@ -0,0 +1 @@
+export * from '../dist/src/renderer';

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ function createWindow() {`
`28`	`28`	`});`
`29`	`29`
`30`	`30`	`if (devMode) {`
`31`		`- require('./../development')(mainWindow);`
	`31`	`+ require('./../development/build')(mainWindow);`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-export { initialize } from './server';`
	`1`	`+export { initialize, enable } from "./server";`