diff --git a/electron/github-electron-main-tests.ts b/electron/github-electron-main-tests.ts index f333e86ec7..ce5bbf8e2e 100644 --- a/electron/github-electron-main-tests.ts +++ b/electron/github-electron-main-tests.ts @@ -63,6 +63,7 @@ app.on('ready', () => { mainWindow.loadURL(`file://${__dirname}/index.html`); mainWindow.loadURL('file://foo/bar', {userAgent: 'cool-agent', httpReferrer: 'greateRefferer'}); mainWindow.webContents.loadURL('file://foo/bar', {userAgent: 'cool-agent', httpReferrer: 'greateRefferer'}); + mainWindow.webContents.loadURL('file://foo/bar', {userAgent: 'cool-agent', httpReferrer: 'greateRefferer', postData: [{type: 'blob', blobUUID: 'hogefuga'}]}); mainWindow.webContents.openDevTools(); mainWindow.webContents.toggleDevTools(); @@ -80,6 +81,9 @@ app.on('ready', () => { mainWindow = null; }); + mainWindow.webContents.setVisualZoomLevelLimits(50, 200); + mainWindow.webContents.setLayoutZoomLevelLimits(50, 200); + mainWindow.webContents.print({silent: true, printBackground: false}); mainWindow.webContents.print(); @@ -93,7 +97,7 @@ app.on('ready', () => { mainWindow.webContents.printToPDF({}, (err, data) => {}); - mainWindow.webContents.executeJavaScript('return true;'); + mainWindow.webContents.executeJavaScript('return true;').then((v: boolean) => console.log(v)); mainWindow.webContents.executeJavaScript('return true;', true); mainWindow.webContents.executeJavaScript('return true;', true, (result: boolean) => console.log(result)); mainWindow.webContents.insertText('blah, blah, blah'); @@ -313,6 +317,10 @@ var window = new BrowserWindow(); window.setProgressBar(0.5); window.setRepresentedFilename('/etc/passwd'); window.setDocumentEdited(true); +window.previewFile('/path/to/file'); +window.previewFile('/path/to/file', 'Displayed Name'); +window.setVibrancy('light'); +window.setVibrancy('titlebar'); // Online/Offline Event Detection // https://github.com/atom/electron/blob/master/docs/tutorial/online-offline-events.md @@ -320,7 +328,7 @@ window.setDocumentEdited(true); var onlineStatusWindow: Electron.BrowserWindow; app.on('ready', () => { - onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false }); + onlineStatusWindow = new BrowserWindow({ width: 0, height: 0, show: false, vibrancy: 'sidebar' }); onlineStatusWindow.loadURL(`file://${__dirname}/online-status.html`); }); app.on('accessibility-support-changed', (_, enabled) => console.log('accessibility: ' + enabled)); @@ -869,20 +877,25 @@ app.on('ready', () => { // clipboard // https://github.com/atom/electron/blob/master/docs/api/clipboard.md -clipboard.writeText('Example String'); -clipboard.writeText('Example String', 'selection'); -clipboard.writeBookmark('foo', 'http://example.com'); -clipboard.writeBookmark('foo', 'http://example.com', 'selection'); -console.log(clipboard.readText('selection')); -console.log(clipboard.availableFormats()); -console.log(clipboard.readBookmark().title); -clipboard.clear(); +{ + let str: string; + clipboard.writeText('Example String'); + clipboard.writeText('Example String', 'selection'); + clipboard.writeBookmark('foo', 'http://example.com'); + clipboard.writeBookmark('foo', 'http://example.com', 'selection'); + clipboard.writeFindText('foo'); + str = clipboard.readText('selection'); + str = clipboard.readFindText(); + console.log(clipboard.availableFormats()); + console.log(clipboard.readBookmark().title); + clipboard.clear(); -clipboard.write({ - html: '', - text: 'Hello World!', - image: clipboard.readImage() -}); + clipboard.write({ + html: '', + text: 'Hello World!', + image: clipboard.readImage() + }); +} // crash-reporter // https://github.com/atom/electron/blob/master/docs/api/crash-reporter.md @@ -1051,6 +1064,7 @@ session.defaultSession.enableNetworkEmulation({ session.defaultSession.setCertificateVerifyProc((hostname, cert, callback) => { callback((hostname === 'github.com') ? true : false); + console.log(cert.issuer.commonName); }); session.defaultSession.setPermissionRequestHandler(function(webContents, permission, callback) { diff --git a/electron/github-electron-renderer-tests.ts b/electron/github-electron-renderer-tests.ts index 87d9a4abf7..20dca2d07e 100644 --- a/electron/github-electron-renderer-tests.ts +++ b/electron/github-electron-renderer-tests.ts @@ -57,7 +57,8 @@ console.log(webFrame.getZoomFactor()); webFrame.setZoomLevel(200); console.log(webFrame.getZoomLevel()); -webFrame.setZoomLevelLimits(50, 200); +webFrame.setVisualZoomLevelLimits(50, 200); +webFrame.setLayoutZoomLevelLimits(50, 200); webFrame.setSpellCheckProvider('en-US', true, { spellCheck: text => { @@ -68,12 +69,16 @@ webFrame.setSpellCheckProvider('en-US', true, { webFrame.registerURLSchemeAsSecure('app'); webFrame.registerURLSchemeAsBypassingCSP('app'); webFrame.registerURLSchemeAsPrivileged('app'); +webFrame.registerURLSchemeAsPrivileged('app', { + secure: true, + supportFetchAPI: true, +}); webFrame.insertText('text'); webFrame.executeJavaScript('JSON.stringify({})', false, (result) => { console.log(result); -}); +}).then((result: string) => console.log('OK:' + result)); console.log(webFrame.getResourceUsage()); webFrame.clearCache(); diff --git a/electron/index.d.ts b/electron/index.d.ts index 864c9991eb..3ee92c80b9 100644 --- a/electron/index.d.ts +++ b/electron/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Electron v1.4.5 +// Type definitions for Electron v1.4.8 // Project: http://electron.atom.io/ // Definitions by: jedmao , rhysd , Milan Burda , aliib // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -42,6 +42,8 @@ declare namespace Electron { // https://github.com/electron/electron/blob/master/docs/api/app.md + type VibrancyType = 'appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark'; + /** * The app module is responsible for controlling the application's lifecycle. */ @@ -1023,6 +1025,14 @@ declare namespace Electron { * Note: This API is available only on macOS. */ setAspectRatio(aspectRatio: number, extraSize?: Size): void; + /** + * Uses Quick Look to preview a file at a given path. + * + * @param path The absolute path to the file to preview with QuickLook. + * @param displayName The name of the file to display on the Quick Look modal view. + * Note: This API is available only on macOS. + */ + previewFile(path: string, displayName?: string): void; /** * Resizes and moves the window to width, height, x, y. */ @@ -1383,6 +1393,13 @@ declare namespace Electron { * @returns All child windows. */ getChildWindows(): BrowserWindow[]; + /** + * Adds a vibrancy effect to the browser window. Passing null or + * an empty string will remove the vibrancy effect on the window. + * + * Note: This API is available only on macOS. + */ + setVibrancy(type: VibrancyType): void; } type WindowLevel = 'normal' | 'floating' | 'torn-off-menu' | 'modal-panel' | 'main-menu' | 'status' | 'pop-up-menu' | 'screen-saver' | 'dock'; @@ -1772,6 +1789,10 @@ declare namespace Electron { * Use WS_THICKFRAME style for frameless windows on Windows */ thickFrame?: boolean; + /** + * Add a type of vibrancy effect to the window, only on macOS + */ + vibrancy?: VibrancyType; /** * Settings of web page’s features. */ @@ -1861,6 +1882,20 @@ declare namespace Electron { * Note: This API is available on macOS and Windows. */ writeBookmark(title: string, url: string, type?: ClipboardType): void; + /** + * The text on the find pasteboard. This method uses synchronous IPC when called from the renderer process. + * The cached value is reread from the find pasteboard whenever the application is activated. + * + * Note: This API is available on macOS. + */ + readFindText(): string; + /** + * Writes the text into the find pasteboard as plain text. + * This method uses synchronous IPC when called from the renderer process. + * + * Note: This API is available on macOS. + */ + writeFindText(text: string): void; } type ClipboardType = '' | 'selection'; @@ -2455,7 +2490,7 @@ declare namespace Electron { } type MenuItemType = 'normal' | 'separator' | 'submenu' | 'checkbox' | 'radio'; - type MenuItemRole = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteandmatchstyle' | 'selectall' | 'delete' | 'minimize' | 'close' | 'quit' | 'togglefullscreen' | 'resetzoom' | 'zoomin' | 'zoomout'; + type MenuItemRole = 'undo' | 'redo' | 'cut' | 'copy' | 'paste' | 'pasteandmatchstyle' | 'selectall' | 'delete' | 'minimize' | 'close' | 'quit' | 'togglefullscreen' | 'resetzoom' | 'zoomin' | 'zoomout' | 'reload' | 'toggledevtools'; type MenuItemRoleMac = 'about' | 'hide' | 'hideothers' | 'unhide' | 'startspeaking' | 'stopspeaking' | 'front' | 'zoom' | 'window' | 'help' | 'services'; interface MenuItemOptions { @@ -3284,7 +3319,7 @@ declare namespace Electron { * * Calling setCertificateVerifyProc(null) will revert back to default certificate verify proc. */ - setCertificateVerifyProc(proc: (hostname: string, cert: Certificate, callback: (accepted: boolean) => void) => void): void; + setCertificateVerifyProc(proc: ((hostname: string, cert: Certificate, callback: (accepted: boolean) => void) => void) | null): void; /** * Sets the handler which can be used to respond to permission requests for the session. */ @@ -4395,8 +4430,10 @@ declare namespace Electron { /** * Evaluates code in page. * @param code Code to evaluate. + * + * @returns Promise */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; + executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): Promise; /** * Mute the audio on the current web page. */ @@ -4427,7 +4464,11 @@ declare namespace Electron { /** * Sets the maximum and minimum zoom level. */ - setZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; + setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; + /** + * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level. + */ + setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; /** * Executes the editing command undo in web page. */ @@ -4849,6 +4890,55 @@ declare namespace Electron { * Extra headers separated by "\n" */ extraHeaders?: string; + /** + * POST data + */ + postData?: (UploadRawData | UploadFileSystem | UploadBlob)[]; + } + + interface UploadRawData { + /** + * rawData + */ + type: 'rawData'; + /** + * Data to be uploaded. + */ + bytes: Buffer; + } + + interface UploadFileSystem { + /** + * fileSystem + */ + type: 'fileSystem'; + /** + * FileSystem url to read data for upload. + */ + fileSystemURL: string; + /** + * Defaults to 0. + */ + offset: number; + /** + * Number of bytes to read from offset. Defaults to 0. + */ + length: number; + /** + * Last Modification time in number of seconds sine the UNIX epoch. + */ + modificationTime: number; + } + + interface UploadBlob { + /** + * blob + */ + type: 'blob'; + /** + * UUID of blob data to upload. + */ + blobUUID: string; } interface PrintOptions { @@ -4900,10 +4990,22 @@ declare namespace Electron { * PEM encoded data. */ data: string; + /** + * Issuer principal + */ + issuer: CertificatePrincipal; /** * Issuer's Common Name. */ issuerName: string; + /** + * Issuer certificate (if not self-signed) + */ + issuerCert: Certificate; + /** + * Subject principal + */ + subject: CertificatePrincipal; /** * Subject's Common Name. */ @@ -4926,6 +5028,33 @@ declare namespace Electron { fingerprint: string; } + interface CertificatePrincipal { + /** + * Common Name + */ + commonName: string; + /** + * Organization names + */ + organizations: string[]; + /** + * Organization Unit names + */ + organizationUnits: string[]; + /** + * Locality + */ + locality: string; + /** + * State or province + */ + state: string; + /** + * Country or region + */ + country: string; + } + interface LoginRequest { method: string; url: string; @@ -5122,7 +5251,11 @@ declare namespace Electron { /** * Sets the maximum and minimum zoom level. */ - setZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; + setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; + /** + * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level. + */ + setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void; /** * Sets a provider for spell checking in input fields and text areas. */ @@ -5146,7 +5279,7 @@ declare namespace Electron { * Registers the scheme as secure, bypasses content security policy for resources, * allows registering ServiceWorker and supports fetch API. */ - registerURLSchemeAsPrivileged(scheme: string): void; + registerURLSchemeAsPrivileged(scheme: string, options?: RegisterURLSchemeOptions): void; /** * Inserts text to the focused element. */ @@ -5156,8 +5289,10 @@ declare namespace Electron { * In the browser window some HTML APIs like `requestFullScreen` can only be * invoked by a gesture from the user. Setting `userGesture` to `true` will remove * this limitation. + * + * @returns Promise */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; + executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): Promise; /** * @returns Object describing usage information of Blink’s internal memory caches. */ @@ -5186,6 +5321,14 @@ declare namespace Electron { size: number; } + interface RegisterURLSchemeOptions { + secure?: boolean; + bypassCSP?: boolean; + allowServiceWorkers?: boolean; + supportFetchAPI?: boolean; + corsEnabled?: boolean; + } + // https://github.com/electron/electron/blob/master/docs/api/web-view-tag.md /** @@ -5259,6 +5402,10 @@ declare namespace Electron { * If "on", the guest page will be allowed to open new windows. */ allowpopups: string; + /** + * A list of strings which specifies the web preferences to be set on the webview, separated by ,. + */ + webpreferences: string; /** * A list of strings which specifies the blink features to be enabled separated by ,. */ @@ -5367,8 +5514,10 @@ declare namespace Electron { /** * Evaluates code in page. If userGesture is set, it will create the user gesture context in the page. * HTML APIs like requestFullScreen, which require user action, can take advantage of this option for automation. + * + * @returns Promise */ - executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void; + executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): Promise; /** * Opens a DevTools window for guest page. */ @@ -5379,7 +5528,7 @@ declare namespace Electron { closeDevTools(): void; /** * @returns Whether guest page has a DevTools window attached. - */ + isDevToolsOpened(): boolean; /** * @returns Whether DevTools window of guest page is focused.