chore: tsify more of lib (#23721)

* chore: tsify more of lib

* Update lib/browser/api/session.ts

Co-authored-by: Jeremy Apthorp <jeremya@chromium.org>

Co-authored-by: Jeremy Apthorp <jeremya@chromium.org>
This commit is contained in:
Samuel Attard 2020-05-22 12:46:22 -07:00 committed by GitHub
parent 762f7bcca2
commit 9bc5e98238
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
25 changed files with 66 additions and 94 deletions

View file

@ -66,7 +66,7 @@ if (defines['ENABLE_VIEWS_API'] === 'false') {
const alias = {} const alias = {}
for (const ignoredModule of ignoredModules) { for (const ignoredModule of ignoredModules) {
alias[ignoredModule] = path.resolve(electronRoot, 'lib/common/dummy.js') alias[ignoredModule] = path.resolve(electronRoot, 'lib/common/dummy.ts')
} }
module.exports = ({ module.exports = ({

View file

@ -136,11 +136,11 @@ auto_filenames = {
sandbox_bundle_deps = [ sandbox_bundle_deps = [
"lib/browser/api/module-names.ts", "lib/browser/api/module-names.ts",
"lib/common/api/clipboard.js", "lib/common/api/clipboard.ts",
"lib/common/api/deprecate.ts", "lib/common/api/deprecate.ts",
"lib/common/api/module-list.ts", "lib/common/api/module-list.ts",
"lib/common/api/native-image.js", "lib/common/api/native-image.ts",
"lib/common/api/shell.js", "lib/common/api/shell.ts",
"lib/common/define-properties.ts", "lib/common/define-properties.ts",
"lib/common/electron-binding-setup.ts", "lib/common/electron-binding-setup.ts",
"lib/common/type-utils.ts", "lib/common/type-utils.ts",
@ -189,15 +189,15 @@ auto_filenames = {
"lib/browser/api/auto-updater/auto-updater-native.js", "lib/browser/api/auto-updater/auto-updater-native.js",
"lib/browser/api/auto-updater/auto-updater-win.js", "lib/browser/api/auto-updater/auto-updater-win.js",
"lib/browser/api/auto-updater/squirrel-update-win.js", "lib/browser/api/auto-updater/squirrel-update-win.js",
"lib/browser/api/browser-view.js", "lib/browser/api/browser-view.ts",
"lib/browser/api/browser-window.js", "lib/browser/api/browser-window.js",
"lib/browser/api/content-tracing.js", "lib/browser/api/content-tracing.ts",
"lib/browser/api/crash-reporter.ts", "lib/browser/api/crash-reporter.ts",
"lib/browser/api/desktop-capturer.ts", "lib/browser/api/desktop-capturer.ts",
"lib/browser/api/dialog.js", "lib/browser/api/dialog.js",
"lib/browser/api/exports/electron.ts", "lib/browser/api/exports/electron.ts",
"lib/browser/api/global-shortcut.js", "lib/browser/api/global-shortcut.ts",
"lib/browser/api/in-app-purchase.js", "lib/browser/api/in-app-purchase.ts",
"lib/browser/api/ipc-main.ts", "lib/browser/api/ipc-main.ts",
"lib/browser/api/menu-item-roles.js", "lib/browser/api/menu-item-roles.js",
"lib/browser/api/menu-item.js", "lib/browser/api/menu-item.js",
@ -208,19 +208,19 @@ auto_filenames = {
"lib/browser/api/native-theme.ts", "lib/browser/api/native-theme.ts",
"lib/browser/api/net-log.js", "lib/browser/api/net-log.js",
"lib/browser/api/net.ts", "lib/browser/api/net.ts",
"lib/browser/api/notification.js", "lib/browser/api/notification.ts",
"lib/browser/api/power-monitor.ts", "lib/browser/api/power-monitor.ts",
"lib/browser/api/power-save-blocker.js", "lib/browser/api/power-save-blocker.ts",
"lib/browser/api/protocol.ts", "lib/browser/api/protocol.ts",
"lib/browser/api/screen.ts", "lib/browser/api/screen.ts",
"lib/browser/api/session.js", "lib/browser/api/session.ts",
"lib/browser/api/system-preferences.ts", "lib/browser/api/system-preferences.ts",
"lib/browser/api/top-level-window.js", "lib/browser/api/top-level-window.js",
"lib/browser/api/touch-bar.js", "lib/browser/api/touch-bar.js",
"lib/browser/api/tray.js", "lib/browser/api/tray.ts",
"lib/browser/api/view.js", "lib/browser/api/view.ts",
"lib/browser/api/views/image-view.js", "lib/browser/api/views/image-view.ts",
"lib/browser/api/web-contents-view.js", "lib/browser/api/web-contents-view.ts",
"lib/browser/api/web-contents.js", "lib/browser/api/web-contents.js",
"lib/browser/chrome-extension-shim.js", "lib/browser/chrome-extension-shim.js",
"lib/browser/default-menu.ts", "lib/browser/default-menu.ts",
@ -238,11 +238,11 @@ auto_filenames = {
"lib/browser/remote/server.ts", "lib/browser/remote/server.ts",
"lib/browser/rpc-server.js", "lib/browser/rpc-server.js",
"lib/browser/utils.ts", "lib/browser/utils.ts",
"lib/common/api/clipboard.js", "lib/common/api/clipboard.ts",
"lib/common/api/deprecate.ts", "lib/common/api/deprecate.ts",
"lib/common/api/module-list.ts", "lib/common/api/module-list.ts",
"lib/common/api/native-image.js", "lib/common/api/native-image.ts",
"lib/common/api/shell.js", "lib/common/api/shell.ts",
"lib/common/define-properties.ts", "lib/common/define-properties.ts",
"lib/common/electron-binding-setup.ts", "lib/common/electron-binding-setup.ts",
"lib/common/init.ts", "lib/common/init.ts",
@ -260,11 +260,11 @@ auto_filenames = {
renderer_bundle_deps = [ renderer_bundle_deps = [
"lib/browser/api/module-names.ts", "lib/browser/api/module-names.ts",
"lib/common/api/clipboard.js", "lib/common/api/clipboard.ts",
"lib/common/api/deprecate.ts", "lib/common/api/deprecate.ts",
"lib/common/api/module-list.ts", "lib/common/api/module-list.ts",
"lib/common/api/native-image.js", "lib/common/api/native-image.ts",
"lib/common/api/shell.js", "lib/common/api/shell.ts",
"lib/common/define-properties.ts", "lib/common/define-properties.ts",
"lib/common/electron-binding-setup.ts", "lib/common/electron-binding-setup.ts",
"lib/common/init.ts", "lib/common/init.ts",
@ -302,11 +302,11 @@ auto_filenames = {
worker_bundle_deps = [ worker_bundle_deps = [
"lib/browser/api/module-names.ts", "lib/browser/api/module-names.ts",
"lib/common/api/clipboard.js", "lib/common/api/clipboard.ts",
"lib/common/api/deprecate.ts", "lib/common/api/deprecate.ts",
"lib/common/api/module-list.ts", "lib/common/api/module-list.ts",
"lib/common/api/native-image.js", "lib/common/api/native-image.ts",
"lib/common/api/shell.js", "lib/common/api/shell.ts",
"lib/common/define-properties.ts", "lib/common/define-properties.ts",
"lib/common/electron-binding-setup.ts", "lib/common/electron-binding-setup.ts",
"lib/common/init.ts", "lib/common/init.ts",

View file

@ -1,11 +1,10 @@
'use strict'; import { EventEmitter } from 'events';
const { EventEmitter } = require('events');
const { BrowserView } = process.electronBinding('browser_view'); const { BrowserView } = process.electronBinding('browser_view');
Object.setPrototypeOf(BrowserView.prototype, EventEmitter.prototype); Object.setPrototypeOf(BrowserView.prototype, EventEmitter.prototype);
BrowserView.fromWebContents = (webContents) => { BrowserView.fromWebContents = (webContents: Electron.WebContents) => {
for (const view of BrowserView.getAllViews()) { for (const view of BrowserView.getAllViews()) {
if (view.webContents.equal(webContents)) return view; if (view.webContents.equal(webContents)) return view;
} }
@ -13,4 +12,4 @@ BrowserView.fromWebContents = (webContents) => {
return null; return null;
}; };
module.exports = BrowserView; export default BrowserView;

View file

@ -1,2 +0,0 @@
'use strict';
module.exports = process.electronBinding('content_tracing');

View file

@ -0,0 +1 @@
export default process.electronBinding('content_tracing');

View file

@ -1,3 +0,0 @@
'use strict';
module.exports = process.electronBinding('global_shortcut').globalShortcut;

View file

@ -0,0 +1 @@
export default process.electronBinding('global_shortcut').globalShortcut;

View file

@ -1,22 +1,24 @@
'use strict'; import { EventEmitter } from 'events';
const { deprecate } = require('electron'); let _inAppPurchase;
if (process.platform === 'darwin') { if (process.platform === 'darwin') {
const { EventEmitter } = require('events');
const { inAppPurchase, InAppPurchase } = process.electronBinding('in_app_purchase'); const { inAppPurchase, InAppPurchase } = process.electronBinding('in_app_purchase');
// inAppPurchase is an EventEmitter. // inAppPurchase is an EventEmitter.
Object.setPrototypeOf(InAppPurchase.prototype, EventEmitter.prototype); Object.setPrototypeOf(InAppPurchase.prototype, EventEmitter.prototype);
EventEmitter.call(inAppPurchase); EventEmitter.call(inAppPurchase);
module.exports = inAppPurchase; _inAppPurchase = inAppPurchase;
} else { } else {
module.exports = { _inAppPurchase = new EventEmitter();
purchaseProduct: (productID, quantity, callback) => { Object.assign(_inAppPurchase, {
purchaseProduct: () => {
throw new Error('The inAppPurchase module can only be used on macOS'); throw new Error('The inAppPurchase module can only be used on macOS');
}, },
canMakePayments: () => false, canMakePayments: () => false,
getReceiptURL: () => '' getReceiptURL: () => ''
}; });
} }
export default _inAppPurchase;

View file

@ -1,7 +0,0 @@
'use strict';
const { Notification, isSupported } = process.electronBinding('notification');
Notification.isSupported = isSupported;
module.exports = Notification;

View file

@ -0,0 +1,5 @@
const { Notification: ElectronNotification, isSupported } = process.electronBinding('notification');
ElectronNotification.isSupported = isSupported;
export default ElectronNotification;

View file

@ -1,3 +0,0 @@
'use strict';
module.exports = process.electronBinding('power_save_blocker').powerSaveBlocker;

View file

@ -0,0 +1 @@
export default process.electronBinding('power_save_blocker').powerSaveBlocker;

View file

@ -1,17 +0,0 @@
'use strict';
const { EventEmitter } = require('events');
const { app, deprecate } = require('electron');
const { fromPartition } = process.electronBinding('session');
// Public API.
Object.defineProperties(exports, {
defaultSession: {
enumerable: true,
get () { return fromPartition(''); }
},
fromPartition: {
enumerable: true,
value: fromPartition
}
});

View file

@ -0,0 +1,8 @@
const { fromPartition } = process.electronBinding('session');
export default {
fromPartition,
get defaultSession () {
return fromPartition('');
}
};

View file

@ -1,5 +1,3 @@
'use strict';
const { Tray } = process.electronBinding('tray'); const { Tray } = process.electronBinding('tray');
module.exports = Tray; export default Tray;

View file

@ -1,5 +1,3 @@
'use strict';
const { View } = process.electronBinding('view'); const { View } = process.electronBinding('view');
module.exports = View; export default View;

View file

@ -1,8 +1,7 @@
const electron = require('electron'); import { View } from 'electron';
const { View } = electron;
const { ImageView } = process.electronBinding('image_view'); const { ImageView } = process.electronBinding('image_view');
Object.setPrototypeOf(ImageView.prototype, View.prototype); Object.setPrototypeOf(ImageView.prototype, View.prototype);
module.exports = ImageView; export default ImageView;

View file

@ -1,10 +1,7 @@
'use strict'; import { View } from 'electron';
const electron = require('electron');
const { View } = electron;
const { WebContentsView } = process.electronBinding('web_contents_view'); const { WebContentsView } = process.electronBinding('web_contents_view');
Object.setPrototypeOf(WebContentsView.prototype, View.prototype); Object.setPrototypeOf(WebContentsView.prototype, View.prototype);
module.exports = WebContentsView; export default WebContentsView;

View file

@ -1,13 +1,11 @@
'use strict';
const clipboard = process.electronBinding('clipboard'); const clipboard = process.electronBinding('clipboard');
if (process.type === 'renderer') { if (process.type === 'renderer') {
const ipcRendererUtils = require('@electron/internal/renderer/ipc-renderer-internal-utils'); const ipcRendererUtils = require('@electron/internal/renderer/ipc-renderer-internal-utils');
const typeUtils = require('@electron/internal/common/type-utils'); const typeUtils = require('@electron/internal/common/type-utils');
const makeRemoteMethod = function (method) { const makeRemoteMethod = function (method: keyof Electron.Clipboard) {
return (...args) => { return (...args: any[]) => {
args = typeUtils.serialize(args); args = typeUtils.serialize(args);
const result = ipcRendererUtils.invokeSync('ELECTRON_BROWSER_CLIPBOARD_SYNC', method, ...args); const result = ipcRendererUtils.invokeSync('ELECTRON_BROWSER_CLIPBOARD_SYNC', method, ...args);
return typeUtils.deserialize(result); return typeUtils.deserialize(result);
@ -16,7 +14,7 @@ if (process.type === 'renderer') {
if (process.platform === 'linux') { if (process.platform === 'linux') {
// On Linux we could not access clipboard in renderer process. // On Linux we could not access clipboard in renderer process.
for (const method of Object.keys(clipboard)) { for (const method of Object.keys(clipboard) as (keyof Electron.Clipboard)[]) {
clipboard[method] = makeRemoteMethod(method); clipboard[method] = makeRemoteMethod(method);
} }
} else if (process.platform === 'darwin') { } else if (process.platform === 'darwin') {
@ -26,4 +24,4 @@ if (process.type === 'renderer') {
} }
} }
module.exports = clipboard; export default clipboard;

View file

@ -1,5 +1,3 @@
'use strict';
const { nativeImage } = process.electronBinding('native_image'); const { nativeImage } = process.electronBinding('native_image');
module.exports = nativeImage; export default nativeImage;

View file

@ -1,3 +0,0 @@
'use strict';
module.exports = process.electronBinding('shell');

1
lib/common/api/shell.ts Normal file
View file

@ -0,0 +1 @@
export default process.electronBinding('shell');

View file

@ -25,7 +25,6 @@ declare namespace Electron {
constructor(args: {show: boolean}) constructor(args: {show: boolean})
setContentView(view: View): void setContentView(view: View): void
} }
class View {}
class WebContentsView { class WebContentsView {
constructor(options: BrowserWindowConstructorOptions) constructor(options: BrowserWindowConstructorOptions)
} }

View file

@ -87,6 +87,8 @@ declare namespace Electron {
namespace Main { namespace Main {
const deprecate: ElectronInternal.DeprecationUtil; const deprecate: ElectronInternal.DeprecationUtil;
} }
class View {}
} }
declare namespace ElectronInternal { declare namespace ElectronInternal {