Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore: split protocol.yml (#40645)

Pavel Feldman85f76b8ccfa6
diff --git a/.github/workflows/pr_check_client_side_changes.yml b/.github/workflows/pr_check_client_side_changes.yml
index 982e9c9a6b..c8e8749c30 100644
--- a/.github/workflows/pr_check_client_side_changes.yml
+++ b/.github/workflows/pr_check_client_side_changes.yml
@@ -8,7 +8,7 @@ on:
- 'packages/playwright-core/src/client/**/*'
- 'packages/isomorphic/**/*'
- 'packages/playwright/src/matchers/matchers.ts'
- - 'packages/protocol/src/protocol.yml'
+ - 'packages/protocol/spec/**/*.yml'
jobs:
check:
name: Check
diff --git a/packages/isomorphic/protocolMetainfo.ts b/packages/isomorphic/protocolMetainfo.ts
index 34ad4a6d70..6fac0420d9 100644
--- a/packages/isomorphic/protocolMetainfo.ts
+++ b/packages/isomorphic/protocolMetainfo.ts
@@ -19,40 +19,50 @@
export type MethodMetainfo = { internal?: boolean, title?: string, slowMo?: boolean, snapshot?: boolean, pause?: boolean, isAutoWaiting?: boolean, input?: boolean, group?: string };
export const methodMetainfo = new Map<string, MethodMetainfo>([
+ ['Android.devices', { internal: true, }],
+ ['AndroidSocket.write', { internal: true, }],
+ ['AndroidSocket.close', { internal: true, }],
+ ['AndroidDevice.wait', { title: 'Wait', }],
+ ['AndroidDevice.fill', { title: 'Fill "{text}"', }],
+ ['AndroidDevice.tap', { title: 'Tap', }],
+ ['AndroidDevice.drag', { title: 'Drag', }],
+ ['AndroidDevice.fling', { title: 'Fling', }],
+ ['AndroidDevice.longTap', { title: 'Long tap', }],
+ ['AndroidDevice.pinchClose', { title: 'Pinch close', }],
+ ['AndroidDevice.pinchOpen', { title: 'Pinch open', }],
+ ['AndroidDevice.scroll', { title: 'Scroll', }],
+ ['AndroidDevice.swipe', { title: 'Swipe', }],
+ ['AndroidDevice.info', { internal: true, }],
+ ['AndroidDevice.screenshot', { title: 'Screenshot', }],
+ ['AndroidDevice.inputType', { title: 'Type', }],
+ ['AndroidDevice.inputPress', { title: 'Press', }],
+ ['AndroidDevice.inputTap', { title: 'Tap', }],
+ ['AndroidDevice.inputSwipe', { title: 'Swipe', }],
+ ['AndroidDevice.inputDrag', { title: 'Drag', }],
+ ['AndroidDevice.launchBrowser', { title: 'Launch browser', }],
+ ['AndroidDevice.open', { title: 'Open app', }],
+ ['AndroidDevice.shell', { title: 'Execute shell command', group: 'configuration', }],
+ ['AndroidDevice.installApk', { title: 'Install apk', }],
+ ['AndroidDevice.push', { title: 'Push', }],
+ ['AndroidDevice.connectToWebView', { title: 'Connect to Web View', }],
+ ['AndroidDevice.close', { internal: true, }],
['APIRequestContext.fetch', { title: '{method} "{url}"', }],
['APIRequestContext.fetchResponseBody', { title: 'Get response body', group: 'getter', }],
['APIRequestContext.fetchLog', { internal: true, }],
['APIRequestContext.storageState', { title: 'Get storage state', group: 'configuration', }],
['APIRequestContext.disposeAPIResponse', { internal: true, }],
['APIRequestContext.dispose', { internal: true, }],
- ['LocalUtils.zip', { internal: true, }],
- ['LocalUtils.harOpen', { internal: true, }],
- ['LocalUtils.harLookup', { internal: true, }],
- ['LocalUtils.harClose', { internal: true, }],
- ['LocalUtils.harUnzip', { internal: true, }],
- ['LocalUtils.connect', { internal: true, }],
- ['LocalUtils.tracingStarted', { internal: true, }],
- ['LocalUtils.addStackToTracingNoReply', { internal: true, }],
- ['LocalUtils.traceDiscarded', { internal: true, }],
- ['LocalUtils.globToRegex', { internal: true, }],
- ['Root.initialize', { internal: true, }],
- ['Playwright.newRequest', { title: 'Create request context', }],
- ['DebugController.initialize', { internal: true, }],
- ['DebugController.setReportStateChanged', { internal: true, }],
- ['DebugController.setRecorderMode', { internal: true, }],
- ['DebugController.highlight', { internal: true, }],
- ['DebugController.hideHighlight', { internal: true, }],
- ['DebugController.resume', { internal: true, }],
- ['DebugController.kill', { internal: true, }],
- ['SocksSupport.socksConnected', { internal: true, }],
- ['SocksSupport.socksFailed', { internal: true, }],
- ['SocksSupport.socksData', { internal: true, }],
- ['SocksSupport.socksError', { internal: true, }],
- ['SocksSupport.socksEnd', { internal: true, }],
- ['BrowserType.launch', { title: 'Launch browser', }],
- ['BrowserType.launchPersistentContext', { title: 'Launch persistent context', }],
- ['BrowserType.connectOverCDP', { title: 'Connect over CDP', }],
- ['BrowserType.connectToWorker', { title: 'Connect to worker', }],
+ ['Artifact.pathAfterFinished', { internal: true, }],
+ ['Artifact.saveAs', { internal: true, }],
+ ['Artifact.saveAsStream', { internal: true, }],
+ ['Artifact.failure', { internal: true, }],
+ ['Artifact.stream', { internal: true, }],
+ ['Artifact.cancel', { internal: true, }],
+ ['Artifact.delete', { internal: true, }],
+ ['Stream.read', { internal: true, }],
+ ['Stream.close', { internal: true, }],
+ ['WritableStream.write', { internal: true, }],
+ ['WritableStream.close', { internal: true, }],
['Browser.startServer', { title: 'Start server', }],
['Browser.stopServer', { title: 'Stop server', }],
['Browser.close', { title: 'Close browser', pause: true, }],
@@ -64,13 +74,6 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['Browser.newBrowserCDPSession', { title: 'Create CDP session', group: 'configuration', }],
['Browser.startTracing', { title: 'Start browser tracing', group: 'configuration', }],
['Browser.stopTracing', { title: 'Stop browser tracing', group: 'configuration', }],
- ['EventTarget.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['BrowserContext.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Page.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Worker.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['WebSocket.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['Debugger.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
- ['AndroidDevice.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['BrowserContext.addCookies', { title: 'Add cookies', group: 'configuration', }],
['BrowserContext.addInitScript', { title: 'Add init script', group: 'configuration', }],
['BrowserContext.clearCookies', { title: 'Clear cookies', group: 'configuration', }],
@@ -104,58 +107,18 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['BrowserContext.clockRunFor', { title: 'Run clock "{ticksNumber|ticksString}"', }],
['BrowserContext.clockSetFixedTime', { title: 'Set fixed time "{timeNumber|timeString}"', }],
['BrowserContext.clockSetSystemTime', { title: 'Set system time "{timeNumber|timeString}"', }],
- ['Page.addInitScript', { title: 'Add init script', group: 'configuration', }],
- ['Page.close', { title: 'Close page', pause: true, }],
- ['Page.clearConsoleMessages', { title: 'Clear console messages', }],
- ['Page.consoleMessages', { title: 'Get console messages', group: 'getter', }],
- ['Page.emulateMedia', { title: 'Emulate media', snapshot: true, pause: true, }],
- ['Page.exposeBinding', { title: 'Expose binding', group: 'configuration', }],
- ['Page.goBack', { title: 'Go back', slowMo: true, snapshot: true, pause: true, }],
- ['Page.goForward', { title: 'Go forward', slowMo: true, snapshot: true, pause: true, }],
- ['Page.requestGC', { title: 'Request garbage collection', group: 'configuration', }],
- ['Page.registerLocatorHandler', { title: 'Register locator handler', }],
- ['Page.resolveLocatorHandlerNoReply', { internal: true, }],
- ['Page.unregisterLocatorHandler', { title: 'Unregister locator handler', }],
- ['Page.reload', { title: 'Reload', slowMo: true, snapshot: true, pause: true, }],
- ['Page.expectScreenshot', { title: 'Expect screenshot', snapshot: true, pause: true, }],
- ['Page.screenshot', { title: 'Screenshot', snapshot: true, pause: true, }],
- ['Page.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', group: 'configuration', }],
- ['Page.setNetworkInterceptionPatterns', { title: 'Route requests', group: 'route', }],
- ['Page.setWebSocketInterceptionPatterns', { title: 'Route WebSockets', group: 'route', }],
- ['Page.setViewportSize', { title: 'Set viewport size', snapshot: true, pause: true, }],
- ['Page.keyboardDown', { title: 'Key down "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.keyboardUp', { title: 'Key up "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.keyboardInsertText', { title: 'Insert "{text}"', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.keyboardType', { title: 'Type "{text}"', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.keyboardPress', { title: 'Press "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.mouseMove', { title: 'Mouse move', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.mouseDown', { title: 'Mouse down', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.mouseUp', { title: 'Mouse up', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.mouseClick', { title: 'Click', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.mouseWheel', { title: 'Mouse wheel', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.touchscreenTap', { title: 'Tap', slowMo: true, snapshot: true, pause: true, input: true, }],
- ['Page.clearPageErrors', { title: 'Clear page errors', }],
- ['Page.pageErrors', { title: 'Get page errors', group: 'getter', }],
- ['Page.pdf', { title: 'PDF', }],
- ['Page.requests', { title: 'Get network requests', group: 'getter', }],
- ['Page.startJSCoverage', { title: 'Start JS coverage', group: 'configuration', }],
- ['Page.stopJSCoverage', { title: 'Stop JS coverage', group: 'configuration', }],
- ['Page.startCSSCoverage', { title: 'Start CSS coverage', group: 'configuration', }],
- ['Page.stopCSSCoverage', { title: 'Stop CSS coverage', group: 'configuration', }],
- ['Page.bringToFront', { title: 'Bring to front', }],
- ['Page.pickLocator', { title: 'Pick locator', group: 'configuration', }],
- ['Page.cancelPickLocator', { title: 'Cancel pick locator', group: 'configuration', }],
- ['Page.hideHighlight', { title: 'Hide all element highlights', group: 'configuration', }],
- ['Page.screencastShowOverlay', { title: 'Show overlay', group: 'configuration', }],
- ['Page.screencastRemoveOverlay', { title: 'Remove overlay', group: 'configuration', }],
- ['Page.screencastChapter', { title: 'Show chapter overlay', group: 'configuration', }],
- ['Page.screencastSetOverlayVisible', { title: 'Set overlay visibility', group: 'configuration', }],
- ['Page.screencastShowActions', { title: 'Show actions', group: 'configuration', }],
- ['Page.screencastHideActions', { title: 'Remove actions', group: 'configuration', }],
- ['Page.screencastStart', { title: 'Start screencast', group: 'configuration', }],
- ['Page.screencastStop', { title: 'Stop screencast', group: 'configuration', }],
- ['Page.updateSubscription', { internal: true, }],
- ['Page.setDockTile', { internal: true, }],
+ ['BrowserType.launch', { title: 'Launch browser', }],
+ ['BrowserType.launchPersistentContext', { title: 'Launch persistent context', }],
+ ['BrowserType.connectOverCDP', { title: 'Connect over CDP', }],
+ ['BrowserType.connectToWorker', { title: 'Connect to worker', }],
+ ['Disposable.dispose', { internal: true, }],
+ ['EventTarget.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['AndroidDevice.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['BrowserContext.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['WebSocket.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['Page.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['Debugger.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
+ ['Worker.waitForEventInfo', { title: 'Wait for event "{info.event}"', snapshot: true, }],
['Frame.evalOnSelector', { title: 'Evaluate', snapshot: true, pause: true, }],
['Frame.evalOnSelectorAll', { title: 'Evaluate', snapshot: true, pause: true, }],
['Frame.addScriptTag', { title: 'Add script tag', snapshot: true, pause: true, }],
@@ -205,11 +168,6 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['Frame.waitForFunction', { title: 'Wait for function', snapshot: true, pause: true, }],
['Frame.waitForSelector', { title: 'Wait for selector', snapshot: true, }],
['Frame.expect', { title: 'Expect "{expression}"', snapshot: true, pause: true, }],
- ['Worker.disconnect', { title: 'Disconnect from worker', }],
- ['Worker.evaluateExpression', { title: 'Evaluate', }],
- ['Worker.evaluateExpressionHandle', { title: 'Evaluate', }],
- ['Worker.updateSubscription', { internal: true, }],
- ['Disposable.dispose', { internal: true, }],
['JSHandle.dispose', { internal: true, }],
['ElementHandle.dispose', { internal: true, }],
['JSHandle.evaluateExpression', { title: 'Evaluate', snapshot: true, pause: true, }],
@@ -258,6 +216,16 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['ElementHandle.uncheck', { title: 'Uncheck', slowMo: true, snapshot: true, pause: true, input: true, isAutoWaiting: true, }],
['ElementHandle.waitForElementState', { title: 'Wait for state', snapshot: true, pause: true, }],
['ElementHandle.waitForSelector', { title: 'Wait for selector', snapshot: true, }],
+ ['LocalUtils.zip', { internal: true, }],
+ ['LocalUtils.harOpen', { internal: true, }],
+ ['LocalUtils.harLookup', { internal: true, }],
+ ['LocalUtils.harClose', { internal: true, }],
+ ['LocalUtils.harUnzip', { internal: true, }],
+ ['LocalUtils.connect', { internal: true, }],
+ ['LocalUtils.tracingStarted', { internal: true, }],
+ ['LocalUtils.addStackToTracingNoReply', { internal: true, }],
+ ['LocalUtils.traceDiscarded', { internal: true, }],
+ ['LocalUtils.globToRegex', { internal: true, }],
['Request.response', { internal: true, }],
['Request.rawRequestHeaders', { internal: true, }],
['Route.redirectNavigationRequest', { internal: true, }],
@@ -276,6 +244,76 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['Response.rawResponseHeaders', { internal: true, }],
['Response.httpVersion', { internal: true, }],
['Response.sizes', { internal: true, }],
+ ['Page.addInitScript', { title: 'Add init script', group: 'configuration', }],
+ ['Page.close', { title: 'Close page', pause: true, }],
+ ['Page.clearConsoleMessages', { title: 'Clear console messages', }],
+ ['Page.consoleMessages', { title: 'Get console messages', group: 'getter', }],
+ ['Page.emulateMedia', { title: 'Emulate media', snapshot: true, pause: true, }],
+ ['Page.exposeBinding', { title: 'Expose binding', group: 'configuration', }],
+ ['Page.goBack', { title: 'Go back', slowMo: true, snapshot: true, pause: true, }],
+ ['Page.goForward', { title: 'Go forward', slowMo: true, snapshot: true, pause: true, }],
+ ['Page.requestGC', { title: 'Request garbage collection', group: 'configuration', }],
+ ['Page.registerLocatorHandler', { title: 'Register locator handler', }],
+ ['Page.resolveLocatorHandlerNoReply', { internal: true, }],
+ ['Page.unregisterLocatorHandler', { title: 'Unregister locator handler', }],
+ ['Page.reload', { title: 'Reload', slowMo: true, snapshot: true, pause: true, }],
+ ['Page.expectScreenshot', { title: 'Expect screenshot', snapshot: true, pause: true, }],
+ ['Page.screenshot', { title: 'Screenshot', snapshot: true, pause: true, }],
+ ['Page.setExtraHTTPHeaders', { title: 'Set extra HTTP headers', group: 'configuration', }],
+ ['Page.setNetworkInterceptionPatterns', { title: 'Route requests', group: 'route', }],
+ ['Page.setWebSocketInterceptionPatterns', { title: 'Route WebSockets', group: 'route', }],
+ ['Page.setViewportSize', { title: 'Set viewport size', snapshot: true, pause: true, }],
+ ['Page.keyboardDown', { title: 'Key down "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.keyboardUp', { title: 'Key up "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.keyboardInsertText', { title: 'Insert "{text}"', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.keyboardType', { title: 'Type "{text}"', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.keyboardPress', { title: 'Press "{key}"', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.mouseMove', { title: 'Mouse move', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.mouseDown', { title: 'Mouse down', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.mouseUp', { title: 'Mouse up', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.mouseClick', { title: 'Click', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.mouseWheel', { title: 'Mouse wheel', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.touchscreenTap', { title: 'Tap', slowMo: true, snapshot: true, pause: true, input: true, }],
+ ['Page.clearPageErrors', { title: 'Clear page errors', }],
+ ['Page.pageErrors', { title: 'Get page errors', group: 'getter', }],
+ ['Page.pdf', { title: 'PDF', }],
+ ['Page.requests', { title: 'Get network requests', group: 'getter', }],
+ ['Page.startJSCoverage', { title: 'Start JS coverage', group: 'configuration', }],
+ ['Page.stopJSCoverage', { title: 'Stop JS coverage', group: 'configuration', }],
+ ['Page.startCSSCoverage', { title: 'Start CSS coverage', group: 'configuration', }],
+ ['Page.stopCSSCoverage', { title: 'Stop CSS coverage', group: 'configuration', }],
+ ['Page.bringToFront', { title: 'Bring to front', }],
+ ['Page.pickLocator', { title: 'Pick locator', group: 'configuration', }],
+ ['Page.cancelPickLocator', { title: 'Cancel pick locator', group: 'configuration', }],
+ ['Page.hideHighlight', { title: 'Hide all element highlights', group: 'configuration', }],
+ ['Page.screencastShowOverlay', { title: 'Show overlay', group: 'configuration', }],
+ ['Page.screencastRemoveOverlay', { title: 'Remove overlay', group: 'configuration', }],
+ ['Page.screencastChapter', { title: 'Show chapter overlay', group: 'configuration', }],
+ ['Page.screencastSetOverlayVisible', { title: 'Set overlay visibility', group: 'configuration', }],
+ ['Page.screencastShowActions', { title: 'Show actions', group: 'configuration', }],
+ ['Page.screencastHideActions', { title: 'Remove actions', group: 'configuration', }],
+ ['Page.screencastStart', { title: 'Start screencast', group: 'configuration', }],
+ ['Page.screencastStop', { title: 'Stop screencast', group: 'configuration', }],
+ ['Page.updateSubscription', { internal: true, }],
+ ['Page.setDockTile', { internal: true, }],
+ ['Root.initialize', { internal: true, }],
+ ['Playwright.newRequest', { title: 'Create request context', }],
+ ['DebugController.initialize', { internal: true, }],
+ ['DebugController.setReportStateChanged', { internal: true, }],
+ ['DebugController.setRecorderMode', { internal: true, }],
+ ['DebugController.highlight', { internal: true, }],
+ ['DebugController.hideHighlight', { internal: true, }],
+ ['DebugController.resume', { internal: true, }],
+ ['DebugController.kill', { internal: true, }],
+ ['SocksSupport.socksConnected', { internal: true, }],
+ ['SocksSupport.socksFailed', { internal: true, }],
+ ['SocksSupport.socksData', { internal: true, }],
+ ['SocksSupport.socksError', { internal: true, }],
+ ['SocksSupport.socksEnd', { internal: true, }],
+ ['JsonPipe.send', { internal: true, }],
+ ['JsonPipe.close', { internal: true, }],
+ ['CDPSession.send', { title: 'Send CDP command', group: 'configuration', }],
+ ['CDPSession.detach', { title: 'Detach CDP session', group: 'configuration', }],
['BindingCall.reject', { internal: true, }],
['BindingCall.resolve', { internal: true, }],
['Debugger.requestPause', { title: 'Pause on next call', group: 'configuration', }],
@@ -292,48 +330,10 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([
['Tracing.tracingStop', { title: 'Stop tracing', group: 'configuration', }],
['Tracing.harStart', { internal: true, }],
['Tracing.harExport', { internal: true, }],
- ['Artifact.pathAfterFinished', { internal: true, }],
- ['Artifact.saveAs', { internal: true, }],
- ['Artifact.saveAsStream', { internal: true, }],
- ['Artifact.failure', { internal: true, }],
- ['Artifact.stream', { internal: true, }],
- ['Artifact.cancel', { internal: true, }],
- ['Artifact.delete', { internal: true, }],
- ['Stream.read', { internal: true, }],
- ['Stream.close', { internal: true, }],
- ['WritableStream.write', { internal: true, }],
- ['WritableStream.close', { internal: true, }],
- ['CDPSession.send', { title: 'Send CDP command', group: 'configuration', }],
- ['CDPSession.detach', { title: 'Detach CDP session', group: 'configuration', }],
- ['Android.devices', { internal: true, }],
- ['AndroidSocket.write', { internal: true, }],
- ['AndroidSocket.close', { internal: true, }],
- ['AndroidDevice.wait', { title: 'Wait', }],
- ['AndroidDevice.fill', { title: 'Fill "{text}"', }],
- ['AndroidDevice.tap', { title: 'Tap', }],
- ['AndroidDevice.drag', { title: 'Drag', }],
- ['AndroidDevice.fling', { title: 'Fling', }],
- ['AndroidDevice.longTap', { title: 'Long tap', }],
- ['AndroidDevice.pinchClose', { title: 'Pinch close', }],
- ['AndroidDevice.pinchOpen', { title: 'Pinch open', }],
- ['AndroidDevice.scroll', { title: 'Scroll', }],
- ['AndroidDevice.swipe', { title: 'Swipe', }],
- ['AndroidDevice.info', { internal: true, }],
- ['AndroidDevice.screenshot', { title: 'Screenshot', }],
- ['AndroidDevice.inputType', { title: 'Type', }],
- ['AndroidDevice.inputPress', { title: 'Press', }],
- ['AndroidDevice.inputTap', { title: 'Tap', }],
- ['AndroidDevice.inputSwipe', { title: 'Swipe', }],
- ['AndroidDevice.inputDrag', { title: 'Drag', }],
- ['AndroidDevice.launchBrowser', { title: 'Launch browser', }],
- ['AndroidDevice.open', { title: 'Open app', }],
- ['AndroidDevice.shell', { title: 'Execute shell command', group: 'configuration', }],
- ['AndroidDevice.installApk', { title: 'Install apk', }],
- ['AndroidDevice.push', { title: 'Push', }],
- ['AndroidDevice.connectToWebView', { title: 'Connect to Web View', }],
- ['AndroidDevice.close', { internal: true, }],
- ['JsonPipe.send', { internal: true, }],
- ['JsonPipe.close', { internal: true, }]
+ ['Worker.disconnect', { title: 'Disconnect from worker', }],
+ ['Worker.evaluateExpression', { title: 'Evaluate', }],
+ ['Worker.evaluateExpressionHandle', { title: 'Evaluate', }],
+ ['Worker.updateSubscription', { internal: true, }]
]);
export function getMetainfo(metadata: { type: string, method: string }): MethodMetainfo | undefined {
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 891326d306..831dfc6f19 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -20,545 +20,138 @@ import { scheme, tOptional, tObject, tBoolean, tInt, tFloat, tString, tAny, tEnu
export type { Validator, ValidatorContext } from './validatorPrimitives';
export { ValidationError, findValidator, maybeFindValidator, createMetadataValidator } from './validatorPrimitives';
-scheme.StackFrame = tObject({
- file: tString,
- line: tInt,
- column: tInt,
- function: tOptional(tString),
-});
-scheme.Metadata = tObject({
- location: tOptional(tObject({
- file: tString,
- line: tOptional(tInt),
- column: tOptional(tInt),
- })),
- title: tOptional(tString),
- internal: tOptional(tBoolean),
- stepId: tOptional(tString),
-});
-scheme.ClientSideCallMetadata = tObject({
- id: tInt,
- stack: tOptional(tArray(tType('StackFrame'))),
-});
-scheme.Point = tObject({
- x: tFloat,
- y: tFloat,
-});
-scheme.Rect = tObject({
- x: tFloat,
- y: tFloat,
- width: tFloat,
- height: tFloat,
-});
-scheme.SerializedValue = tObject({
- n: tOptional(tFloat),
- b: tOptional(tBoolean),
- s: tOptional(tString),
- v: tOptional(tEnum(['null', 'undefined', 'NaN', 'Infinity', '-Infinity', '-0'])),
- d: tOptional(tString),
- u: tOptional(tString),
- bi: tOptional(tString),
- ta: tOptional(tObject({
- b: tBinary,
- k: tEnum(['i8', 'ui8', 'ui8c', 'i16', 'ui16', 'i32', 'ui32', 'f32', 'f64', 'bi64', 'bui64']),
- })),
- e: tOptional(tObject({
- m: tString,
- n: tString,
- s: tString,
- })),
- r: tOptional(tObject({
- p: tString,
- f: tString,
- })),
- a: tOptional(tArray(tType('SerializedValue'))),
- o: tOptional(tArray(tObject({
- k: tString,
- v: tType('SerializedValue'),
- }))),
- h: tOptional(tInt),
- id: tOptional(tInt),
- ref: tOptional(tInt),
-});
-scheme.SerializedArgument = tObject({
- value: tType('SerializedValue'),
- handles: tArray(tChannel('*')),
-});
-scheme.ExpectedTextValue = tObject({
- string: tOptional(tString),
- regexSource: tOptional(tString),
- regexFlags: tOptional(tString),
- matchSubstring: tOptional(tBoolean),
- ignoreCase: tOptional(tBoolean),
- normalizeWhiteSpace: tOptional(tBoolean),
-});
-scheme.SelectorEngine = tObject({
- name: tString,
- source: tString,
- contentScript: tOptional(tBoolean),
-});
-scheme.URLPattern = tObject({
- hash: tString,
- hostname: tString,
- password: tString,
- pathname: tString,
- port: tString,
- protocol: tString,
- search: tString,
- username: tString,
-});
-scheme.SetNetworkCookie = tObject({
- name: tString,
- value: tString,
- url: tOptional(tString),
- domain: tOptional(tString),
- path: tOptional(tString),
- expires: tOptional(tFloat),
- httpOnly: tOptional(tBoolean),
- secure: tOptional(tBoolean),
- sameSite: tOptional(tEnum(['Strict', 'Lax', 'None'])),
- partitionKey: tOptional(tString),
- _crHasCrossSiteAncestor: tOptional(tBoolean),
-});
-scheme.NetworkCookie = tObject({
- name: tString,
- value: tString,
- domain: tString,
- path: tString,
- expires: tFloat,
- httpOnly: tBoolean,
- secure: tBoolean,
- sameSite: tEnum(['Strict', 'Lax', 'None']),
- partitionKey: tOptional(tString),
- _crHasCrossSiteAncestor: tOptional(tBoolean),
-});
-scheme.NameValue = tObject({
- name: tString,
- value: tString,
-});
-scheme.IndexedDBDatabase = tObject({
- name: tString,
- version: tInt,
- stores: tArray(tObject({
- name: tString,
- autoIncrement: tBoolean,
- keyPath: tOptional(tString),
- keyPathArray: tOptional(tArray(tString)),
- records: tArray(tObject({
- key: tOptional(tAny),
- keyEncoded: tOptional(tAny),
- value: tOptional(tAny),
- valueEncoded: tOptional(tAny),
- })),
- indexes: tArray(tObject({
- name: tString,
- keyPath: tOptional(tString),
- keyPathArray: tOptional(tArray(tString)),
- multiEntry: tBoolean,
- unique: tBoolean,
- })),
- })),
-});
-scheme.SetOriginStorage = tObject({
- origin: tString,
- localStorage: tArray(tType('NameValue')),
- indexedDB: tOptional(tArray(tType('IndexedDBDatabase'))),
-});
-scheme.OriginStorage = tObject({
- origin: tString,
- localStorage: tArray(tType('NameValue')),
- indexedDB: tOptional(tArray(tType('IndexedDBDatabase'))),
-});
-scheme.SerializedError = tObject({
- error: tOptional(tObject({
- message: tString,
- name: tString,
- stack: tOptional(tString),
- })),
- value: tOptional(tType('SerializedValue')),
-});
-scheme.RecordHarOptions = tObject({
- content: tOptional(tEnum(['embed', 'attach', 'omit'])),
- mode: tOptional(tEnum(['full', 'minimal'])),
- urlGlob: tOptional(tString),
- urlRegexSource: tOptional(tString),
- urlRegexFlags: tOptional(tString),
- harPath: tOptional(tString),
- resourcesDir: tOptional(tString),
-});
-scheme.FormField = tObject({
- name: tString,
- value: tOptional(tString),
- file: tOptional(tObject({
- name: tString,
- mimeType: tOptional(tString),
- buffer: tBinary,
- })),
-});
-scheme.SDKLanguage = tEnum(['javascript', 'python', 'java', 'csharp']);
-scheme.APIRequestContextInitializer = tObject({
- tracing: tChannel(['Tracing']),
-});
-scheme.APIRequestContextFetchParams = tObject({
- url: tString,
- encodedParams: tOptional(tString),
- params: tOptional(tArray(tType('NameValue'))),
- method: tOptional(tString),
- headers: tOptional(tArray(tType('NameValue'))),
- postData: tOptional(tBinary),
- jsonData: tOptional(tString),
- formData: tOptional(tArray(tType('NameValue'))),
- multipartData: tOptional(tArray(tType('FormField'))),
- timeout: tFloat,
- failOnStatusCode: tOptional(tBoolean),
- ignoreHTTPSErrors: tOptional(tBoolean),
- maxRedirects: tOptional(tInt),
- maxRetries: tOptional(tInt),
-});
-scheme.APIRequestContextFetchResult = tObject({
- response: tType('APIResponse'),
-});
-scheme.APIRequestContextFetchResponseBodyParams = tObject({
- fetchUid: tString,
-});
-scheme.APIRequestContextFetchResponseBodyResult = tObject({
- binary: tOptional(tBinary),
-});
-scheme.APIRequestContextFetchLogParams = tObject({
- fetchUid: tString,
-});
-scheme.APIRequestContextFetchLogResult = tObject({
- log: tArray(tString),
-});
-scheme.APIRequestContextStorageStateParams = tObject({
- indexedDB: tOptional(tBoolean),
-});
-scheme.APIRequestContextStorageStateResult = tObject({
- cookies: tArray(tType('NetworkCookie')),
- origins: tArray(tType('OriginStorage')),
-});
-scheme.APIRequestContextDisposeAPIResponseParams = tObject({
- fetchUid: tString,
-});
-scheme.APIRequestContextDisposeAPIResponseResult = tOptional(tObject({}));
-scheme.APIRequestContextDisposeParams = tObject({
- reason: tOptional(tString),
-});
-scheme.APIRequestContextDisposeResult = tOptional(tObject({}));
-scheme.APIResponse = tObject({
- fetchUid: tString,
- url: tString,
- status: tInt,
- statusText: tString,
- headers: tArray(tType('NameValue')),
-});
-scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
-scheme.ConsoleMessagesFilter = tEnum(['all', 'since-navigation']);
-scheme.LocalUtilsInitializer = tObject({
- deviceDescriptors: tArray(tObject({
- name: tString,
- descriptor: tObject({
- userAgent: tString,
- viewport: tObject({
- width: tInt,
- height: tInt,
- }),
- screen: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- deviceScaleFactor: tFloat,
- isMobile: tBoolean,
- hasTouch: tBoolean,
- defaultBrowserType: tEnum(['chromium', 'firefox', 'webkit']),
- }),
- })),
-});
-scheme.LocalUtilsZipParams = tObject({
- zipFile: tString,
- entries: tArray(tType('NameValue')),
- stacksId: tOptional(tString),
- mode: tEnum(['write', 'append']),
- includeSources: tBoolean,
- additionalSources: tOptional(tArray(tString)),
-});
-scheme.LocalUtilsZipResult = tOptional(tObject({}));
-scheme.LocalUtilsHarOpenParams = tObject({
- file: tString,
-});
-scheme.LocalUtilsHarOpenResult = tObject({
- harId: tOptional(tString),
- error: tOptional(tString),
-});
-scheme.LocalUtilsHarLookupParams = tObject({
- harId: tString,
- url: tString,
- method: tString,
- headers: tArray(tType('NameValue')),
- postData: tOptional(tBinary),
- isNavigationRequest: tBoolean,
-});
-scheme.LocalUtilsHarLookupResult = tObject({
- action: tEnum(['error', 'redirect', 'fulfill', 'noentry']),
- message: tOptional(tString),
- redirectURL: tOptional(tString),
- status: tOptional(tInt),
- headers: tOptional(tArray(tType('NameValue'))),
- body: tOptional(tBinary),
-});
-scheme.LocalUtilsHarCloseParams = tObject({
- harId: tString,
-});
-scheme.LocalUtilsHarCloseResult = tOptional(tObject({}));
-scheme.LocalUtilsHarUnzipParams = tObject({
- zipFile: tString,
- harFile: tString,
- resourcesDir: tOptional(tString),
-});
-scheme.LocalUtilsHarUnzipResult = tOptional(tObject({}));
-scheme.LocalUtilsConnectParams = tObject({
- endpoint: tString,
- headers: tOptional(tAny),
- exposeNetwork: tOptional(tString),
- slowMo: tOptional(tFloat),
- timeout: tFloat,
- socksProxyRedirectPortForTest: tOptional(tInt),
-});
-scheme.LocalUtilsConnectResult = tObject({
- pipe: tChannel(['JsonPipe']),
- headers: tArray(tType('NameValue')),
-});
-scheme.LocalUtilsTracingStartedParams = tObject({
- tracesDir: tOptional(tString),
- traceName: tString,
- live: tOptional(tBoolean),
-});
-scheme.LocalUtilsTracingStartedResult = tObject({
- stacksId: tString,
-});
-scheme.LocalUtilsAddStackToTracingNoReplyParams = tObject({
- callData: tType('ClientSideCallMetadata'),
-});
-scheme.LocalUtilsAddStackToTracingNoReplyResult = tOptional(tObject({}));
-scheme.LocalUtilsTraceDiscardedParams = tObject({
- stacksId: tString,
-});
-scheme.LocalUtilsTraceDiscardedResult = tOptional(tObject({}));
-scheme.LocalUtilsGlobToRegexParams = tObject({
- glob: tString,
- baseURL: tOptional(tString),
- webSocketUrl: tOptional(tBoolean),
-});
-scheme.LocalUtilsGlobToRegexResult = tObject({
- regex: tString,
-});
-scheme.RootInitializer = tOptional(tObject({}));
-scheme.RootInitializeParams = tObject({
- sdkLanguage: tType('SDKLanguage'),
-});
-scheme.RootInitializeResult = tObject({
- playwright: tChannel(['Playwright']),
+scheme.AndroidInitializer = tOptional(tObject({}));
+scheme.AndroidDevicesParams = tObject({
+ host: tOptional(tString),
+ port: tOptional(tInt),
+ omitDriverInstall: tOptional(tBoolean),
});
-scheme.PlaywrightInitializer = tObject({
- chromium: tChannel(['BrowserType']),
- firefox: tChannel(['BrowserType']),
- webkit: tChannel(['BrowserType']),
- android: tChannel(['Android']),
- utils: tOptional(tChannel(['LocalUtils'])),
- preLaunchedBrowser: tOptional(tChannel(['Browser'])),
- preConnectedAndroidDevice: tOptional(tChannel(['AndroidDevice'])),
- socksSupport: tOptional(tChannel(['SocksSupport'])),
+scheme.AndroidDevicesResult = tObject({
+ devices: tArray(tChannel(['AndroidDevice'])),
});
-scheme.PlaywrightNewRequestParams = tObject({
- baseURL: tOptional(tString),
- userAgent: tOptional(tString),
- ignoreHTTPSErrors: tOptional(tBoolean),
- extraHTTPHeaders: tOptional(tArray(tType('NameValue'))),
- failOnStatusCode: tOptional(tBoolean),
- clientCertificates: tOptional(tArray(tObject({
- origin: tString,
- cert: tOptional(tBinary),
- key: tOptional(tBinary),
- passphrase: tOptional(tString),
- pfx: tOptional(tBinary),
- }))),
- maxRedirects: tOptional(tInt),
- httpCredentials: tOptional(tObject({
- username: tString,
- password: tString,
- origin: tOptional(tString),
- send: tOptional(tEnum(['always', 'unauthorized'])),
- })),
- proxy: tOptional(tObject({
- server: tString,
- bypass: tOptional(tString),
- username: tOptional(tString),
- password: tOptional(tString),
- })),
- storageState: tOptional(tObject({
- cookies: tOptional(tArray(tType('NetworkCookie'))),
- origins: tOptional(tArray(tType('SetOriginStorage'))),
- })),
- tracesDir: tOptional(tString),
+scheme.AndroidSocketInitializer = tOptional(tObject({}));
+scheme.AndroidSocketDataEvent = tObject({
+ data: tBinary,
});
-scheme.PlaywrightNewRequestResult = tObject({
- request: tChannel(['APIRequestContext']),
+scheme.AndroidSocketCloseEvent = tOptional(tObject({}));
+scheme.AndroidSocketWriteParams = tObject({
+ data: tBinary,
});
-scheme.RecorderSource = tObject({
- isRecorded: tBoolean,
- id: tString,
- label: tString,
- text: tString,
- language: tString,
- highlight: tArray(tObject({
- line: tInt,
- type: tString,
- })),
- revealLine: tOptional(tInt),
- group: tOptional(tString),
+scheme.AndroidSocketWriteResult = tOptional(tObject({}));
+scheme.AndroidSocketCloseParams = tOptional(tObject({}));
+scheme.AndroidSocketCloseResult = tOptional(tObject({}));
+scheme.AndroidDeviceInitializer = tObject({
+ model: tString,
+ serial: tString,
});
-scheme.DebugControllerInitializer = tOptional(tObject({}));
-scheme.DebugControllerInspectRequestedEvent = tObject({
- selector: tString,
- locator: tString,
- ariaSnapshot: tString,
+scheme.AndroidDeviceCloseEvent = tOptional(tObject({}));
+scheme.AndroidDeviceWebViewAddedEvent = tObject({
+ webView: tType('AndroidWebView'),
});
-scheme.DebugControllerSetModeRequestedEvent = tObject({
- mode: tString,
+scheme.AndroidDeviceWebViewRemovedEvent = tObject({
+ socketName: tString,
});
-scheme.DebugControllerStateChangedEvent = tObject({
- pageCount: tInt,
+scheme.AndroidDeviceWaitParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ state: tOptional(tEnum(['gone'])),
+ timeout: tFloat,
});
-scheme.DebugControllerSourceChangedEvent = tObject({
+scheme.AndroidDeviceWaitResult = tOptional(tObject({}));
+scheme.AndroidDeviceFillParams = tObject({
+ androidSelector: tType('AndroidSelector'),
text: tString,
- header: tOptional(tString),
- footer: tOptional(tString),
- actions: tOptional(tArray(tString)),
+ timeout: tFloat,
});
-scheme.DebugControllerPausedEvent = tObject({
- paused: tBoolean,
+scheme.AndroidDeviceFillResult = tOptional(tObject({}));
+scheme.AndroidDeviceTapParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ duration: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.DebugControllerInitializeParams = tObject({
- codegenId: tString,
- sdkLanguage: tType('SDKLanguage'),
+scheme.AndroidDeviceTapResult = tOptional(tObject({}));
+scheme.AndroidDeviceDragParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ dest: tType('Point'),
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.DebugControllerInitializeResult = tOptional(tObject({}));
-scheme.DebugControllerSetReportStateChangedParams = tObject({
- enabled: tBoolean,
+scheme.AndroidDeviceDragResult = tOptional(tObject({}));
+scheme.AndroidDeviceFlingParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ direction: tEnum(['up', 'down', 'left', 'right']),
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.DebugControllerSetReportStateChangedResult = tOptional(tObject({}));
-scheme.DebugControllerSetRecorderModeParams = tObject({
- mode: tEnum(['inspecting', 'recording', 'none']),
- testIdAttributeName: tOptional(tString),
- generateAutoExpect: tOptional(tBoolean),
+scheme.AndroidDeviceFlingResult = tOptional(tObject({}));
+scheme.AndroidDeviceLongTapParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ timeout: tFloat,
});
-scheme.DebugControllerSetRecorderModeResult = tOptional(tObject({}));
-scheme.DebugControllerHighlightParams = tObject({
- selector: tOptional(tString),
- ariaTemplate: tOptional(tString),
+scheme.AndroidDeviceLongTapResult = tOptional(tObject({}));
+scheme.AndroidDevicePinchCloseParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ percent: tFloat,
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.DebugControllerHighlightResult = tOptional(tObject({}));
-scheme.DebugControllerHideHighlightParams = tOptional(tObject({}));
-scheme.DebugControllerHideHighlightResult = tOptional(tObject({}));
-scheme.DebugControllerResumeParams = tOptional(tObject({}));
-scheme.DebugControllerResumeResult = tOptional(tObject({}));
-scheme.DebugControllerKillParams = tOptional(tObject({}));
-scheme.DebugControllerKillResult = tOptional(tObject({}));
-scheme.SocksSupportInitializer = tOptional(tObject({}));
-scheme.SocksSupportSocksRequestedEvent = tObject({
- uid: tString,
- host: tString,
- port: tInt,
+scheme.AndroidDevicePinchCloseResult = tOptional(tObject({}));
+scheme.AndroidDevicePinchOpenParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ percent: tFloat,
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.SocksSupportSocksDataEvent = tObject({
- uid: tString,
- data: tBinary,
+scheme.AndroidDevicePinchOpenResult = tOptional(tObject({}));
+scheme.AndroidDeviceScrollParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ direction: tEnum(['up', 'down', 'left', 'right']),
+ percent: tFloat,
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.SocksSupportSocksClosedEvent = tObject({
- uid: tString,
+scheme.AndroidDeviceScrollResult = tOptional(tObject({}));
+scheme.AndroidDeviceSwipeParams = tObject({
+ androidSelector: tType('AndroidSelector'),
+ direction: tEnum(['up', 'down', 'left', 'right']),
+ percent: tFloat,
+ speed: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.SocksSupportSocksConnectedParams = tObject({
- uid: tString,
- host: tString,
- port: tInt,
+scheme.AndroidDeviceSwipeResult = tOptional(tObject({}));
+scheme.AndroidDeviceInfoParams = tObject({
+ androidSelector: tType('AndroidSelector'),
});
-scheme.SocksSupportSocksConnectedResult = tOptional(tObject({}));
-scheme.SocksSupportSocksFailedParams = tObject({
- uid: tString,
- errorCode: tString,
+scheme.AndroidDeviceInfoResult = tObject({
+ info: tType('AndroidElementInfo'),
});
-scheme.SocksSupportSocksFailedResult = tOptional(tObject({}));
-scheme.SocksSupportSocksDataParams = tObject({
- uid: tString,
- data: tBinary,
+scheme.AndroidDeviceScreenshotParams = tOptional(tObject({}));
+scheme.AndroidDeviceScreenshotResult = tObject({
+ binary: tBinary,
});
-scheme.SocksSupportSocksDataResult = tOptional(tObject({}));
-scheme.SocksSupportSocksErrorParams = tObject({
- uid: tString,
- error: tString,
+scheme.AndroidDeviceInputTypeParams = tObject({
+ text: tString,
});
-scheme.SocksSupportSocksErrorResult = tOptional(tObject({}));
-scheme.SocksSupportSocksEndParams = tObject({
- uid: tString,
+scheme.AndroidDeviceInputTypeResult = tOptional(tObject({}));
+scheme.AndroidDeviceInputPressParams = tObject({
+ key: tString,
});
-scheme.SocksSupportSocksEndResult = tOptional(tObject({}));
-scheme.BrowserTypeInitializer = tObject({
- executablePath: tString,
- name: tString,
+scheme.AndroidDeviceInputPressResult = tOptional(tObject({}));
+scheme.AndroidDeviceInputTapParams = tObject({
+ point: tType('Point'),
});
-scheme.BrowserTypeLaunchParams = tObject({
- channel: tOptional(tString),
- executablePath: tOptional(tString),
- args: tOptional(tArray(tString)),
- ignoreAllDefaultArgs: tOptional(tBoolean),
- ignoreDefaultArgs: tOptional(tArray(tString)),
- handleSIGINT: tOptional(tBoolean),
- handleSIGTERM: tOptional(tBoolean),
- handleSIGHUP: tOptional(tBoolean),
- timeout: tFloat,
- env: tOptional(tArray(tType('NameValue'))),
- headless: tOptional(tBoolean),
- proxy: tOptional(tObject({
- server: tString,
- bypass: tOptional(tString),
- username: tOptional(tString),
- password: tOptional(tString),
- })),
- downloadsPath: tOptional(tString),
- tracesDir: tOptional(tString),
- artifactsDir: tOptional(tString),
- chromiumSandbox: tOptional(tBoolean),
- firefoxUserPrefs: tOptional(tAny),
- cdpPort: tOptional(tInt),
- slowMo: tOptional(tFloat),
+scheme.AndroidDeviceInputTapResult = tOptional(tObject({}));
+scheme.AndroidDeviceInputSwipeParams = tObject({
+ segments: tArray(tType('Point')),
+ steps: tInt,
});
-scheme.BrowserTypeLaunchResult = tObject({
- browser: tChannel(['Browser']),
+scheme.AndroidDeviceInputSwipeResult = tOptional(tObject({}));
+scheme.AndroidDeviceInputDragParams = tObject({
+ from: tType('Point'),
+ to: tType('Point'),
+ steps: tInt,
});
-scheme.BrowserTypeLaunchPersistentContextParams = tObject({
- channel: tOptional(tString),
- executablePath: tOptional(tString),
- args: tOptional(tArray(tString)),
- ignoreAllDefaultArgs: tOptional(tBoolean),
- ignoreDefaultArgs: tOptional(tArray(tString)),
- handleSIGINT: tOptional(tBoolean),
- handleSIGTERM: tOptional(tBoolean),
- handleSIGHUP: tOptional(tBoolean),
- timeout: tFloat,
- env: tOptional(tArray(tType('NameValue'))),
- headless: tOptional(tBoolean),
- proxy: tOptional(tObject({
- server: tString,
- bypass: tOptional(tString),
- username: tOptional(tString),
- password: tOptional(tString),
- })),
- downloadsPath: tOptional(tString),
- tracesDir: tOptional(tString),
- artifactsDir: tOptional(tString),
- chromiumSandbox: tOptional(tBoolean),
- firefoxUserPrefs: tOptional(tAny),
- cdpPort: tOptional(tInt),
+scheme.AndroidDeviceInputDragResult = tOptional(tObject({}));
+scheme.AndroidDeviceLaunchBrowserParams = tObject({
noDefaultViewport: tOptional(tBoolean),
viewport: tOptional(tObject({
width: tInt,
@@ -620,32 +213,195 @@ scheme.BrowserTypeLaunchPersistentContextParams = tObject({
serviceWorkers: tOptional(tEnum(['allow', 'block'])),
selectorEngines: tOptional(tArray(tType('SelectorEngine'))),
testIdAttributeName: tOptional(tString),
- userDataDir: tString,
- slowMo: tOptional(tFloat),
+ pkg: tOptional(tString),
+ args: tOptional(tArray(tString)),
+ proxy: tOptional(tObject({
+ server: tString,
+ bypass: tOptional(tString),
+ username: tOptional(tString),
+ password: tOptional(tString),
+ })),
});
-scheme.BrowserTypeLaunchPersistentContextResult = tObject({
- browser: tChannel(['Browser']),
+scheme.AndroidDeviceLaunchBrowserResult = tObject({
context: tChannel(['BrowserContext']),
});
-scheme.BrowserTypeConnectOverCDPParams = tObject({
- endpointURL: tString,
+scheme.AndroidDeviceOpenParams = tObject({
+ command: tString,
+});
+scheme.AndroidDeviceOpenResult = tObject({
+ socket: tChannel(['AndroidSocket']),
+});
+scheme.AndroidDeviceShellParams = tObject({
+ command: tString,
+});
+scheme.AndroidDeviceShellResult = tObject({
+ result: tBinary,
+});
+scheme.AndroidDeviceInstallApkParams = tObject({
+ file: tBinary,
+ args: tOptional(tArray(tString)),
+});
+scheme.AndroidDeviceInstallApkResult = tOptional(tObject({}));
+scheme.AndroidDevicePushParams = tObject({
+ file: tBinary,
+ path: tString,
+ mode: tOptional(tInt),
+});
+scheme.AndroidDevicePushResult = tOptional(tObject({}));
+scheme.AndroidDeviceConnectToWebViewParams = tObject({
+ socketName: tString,
+});
+scheme.AndroidDeviceConnectToWebViewResult = tObject({
+ context: tChannel(['BrowserContext']),
+});
+scheme.AndroidDeviceCloseParams = tOptional(tObject({}));
+scheme.AndroidDeviceCloseResult = tOptional(tObject({}));
+scheme.AndroidWebView = tObject({
+ pid: tInt,
+ pkg: tString,
+ socketName: tString,
+});
+scheme.AndroidSelector = tObject({
+ checkable: tOptional(tBoolean),
+ checked: tOptional(tBoolean),
+ clazz: tOptional(tString),
+ clickable: tOptional(tBoolean),
+ depth: tOptional(tInt),
+ desc: tOptional(tString),
+ enabled: tOptional(tBoolean),
+ focusable: tOptional(tBoolean),
+ focused: tOptional(tBoolean),
+ hasChild: tOptional(tObject({
+ androidSelector: tType('AndroidSelector'),
+ })),
+ hasDescendant: tOptional(tObject({
+ androidSelector: tType('AndroidSelector'),
+ maxDepth: tOptional(tInt),
+ })),
+ longClickable: tOptional(tBoolean),
+ pkg: tOptional(tString),
+ res: tOptional(tString),
+ scrollable: tOptional(tBoolean),
+ selected: tOptional(tBoolean),
+ text: tOptional(tString),
+});
+scheme.AndroidElementInfo = tObject({
+ children: tOptional(tArray(tType('AndroidElementInfo'))),
+ clazz: tString,
+ desc: tString,
+ res: tString,
+ pkg: tString,
+ text: tString,
+ bounds: tType('Rect'),
+ checkable: tBoolean,
+ checked: tBoolean,
+ clickable: tBoolean,
+ enabled: tBoolean,
+ focusable: tBoolean,
+ focused: tBoolean,
+ longClickable: tBoolean,
+ scrollable: tBoolean,
+ selected: tBoolean,
+});
+scheme.APIRequestContextInitializer = tObject({
+ tracing: tChannel(['Tracing']),
+});
+scheme.APIRequestContextFetchParams = tObject({
+ url: tString,
+ encodedParams: tOptional(tString),
+ params: tOptional(tArray(tType('NameValue'))),
+ method: tOptional(tString),
headers: tOptional(tArray(tType('NameValue'))),
- slowMo: tOptional(tFloat),
+ postData: tOptional(tBinary),
+ jsonData: tOptional(tString),
+ formData: tOptional(tArray(tType('NameValue'))),
+ multipartData: tOptional(tArray(tType('FormField'))),
timeout: tFloat,
- isLocal: tOptional(tBoolean),
- noDefaults: tOptional(tBoolean),
+ failOnStatusCode: tOptional(tBoolean),
+ ignoreHTTPSErrors: tOptional(tBoolean),
+ maxRedirects: tOptional(tInt),
+ maxRetries: tOptional(tInt),
});
-scheme.BrowserTypeConnectOverCDPResult = tObject({
- browser: tChannel(['Browser']),
- defaultContext: tOptional(tChannel(['BrowserContext'])),
+scheme.APIRequestContextFetchResult = tObject({
+ response: tType('APIResponse'),
});
-scheme.BrowserTypeConnectToWorkerParams = tObject({
- endpoint: tString,
- timeout: tFloat,
+scheme.APIRequestContextFetchResponseBodyParams = tObject({
+ fetchUid: tString,
+});
+scheme.APIRequestContextFetchResponseBodyResult = tObject({
+ binary: tOptional(tBinary),
+});
+scheme.APIRequestContextFetchLogParams = tObject({
+ fetchUid: tString,
+});
+scheme.APIRequestContextFetchLogResult = tObject({
+ log: tArray(tString),
+});
+scheme.APIRequestContextStorageStateParams = tObject({
+ indexedDB: tOptional(tBoolean),
+});
+scheme.APIRequestContextStorageStateResult = tObject({
+ cookies: tArray(tType('NetworkCookie')),
+ origins: tArray(tType('OriginStorage')),
+});
+scheme.APIRequestContextDisposeAPIResponseParams = tObject({
+ fetchUid: tString,
+});
+scheme.APIRequestContextDisposeAPIResponseResult = tOptional(tObject({}));
+scheme.APIRequestContextDisposeParams = tObject({
+ reason: tOptional(tString),
+});
+scheme.APIRequestContextDisposeResult = tOptional(tObject({}));
+scheme.APIResponse = tObject({
+ fetchUid: tString,
+ url: tString,
+ status: tInt,
+ statusText: tString,
+ headers: tArray(tType('NameValue')),
+});
+scheme.ArtifactInitializer = tObject({
+ absolutePath: tString,
+});
+scheme.ArtifactPathAfterFinishedParams = tOptional(tObject({}));
+scheme.ArtifactPathAfterFinishedResult = tObject({
+ value: tString,
+});
+scheme.ArtifactSaveAsParams = tObject({
+ path: tString,
+});
+scheme.ArtifactSaveAsResult = tOptional(tObject({}));
+scheme.ArtifactSaveAsStreamParams = tOptional(tObject({}));
+scheme.ArtifactSaveAsStreamResult = tObject({
+ stream: tChannel(['Stream']),
+});
+scheme.ArtifactFailureParams = tOptional(tObject({}));
+scheme.ArtifactFailureResult = tObject({
+ error: tOptional(tString),
+});
+scheme.ArtifactStreamParams = tOptional(tObject({}));
+scheme.ArtifactStreamResult = tObject({
+ stream: tChannel(['Stream']),
+});
+scheme.ArtifactCancelParams = tOptional(tObject({}));
+scheme.ArtifactCancelResult = tOptional(tObject({}));
+scheme.ArtifactDeleteParams = tOptional(tObject({}));
+scheme.ArtifactDeleteResult = tOptional(tObject({}));
+scheme.StreamInitializer = tOptional(tObject({}));
+scheme.StreamReadParams = tObject({
+ size: tOptional(tInt),
+});
+scheme.StreamReadResult = tObject({
+ binary: tBinary,
});
-scheme.BrowserTypeConnectToWorkerResult = tObject({
- worker: tChannel(['Worker']),
+scheme.StreamCloseParams = tOptional(tObject({}));
+scheme.StreamCloseResult = tOptional(tObject({}));
+scheme.WritableStreamInitializer = tOptional(tObject({}));
+scheme.WritableStreamWriteParams = tObject({
+ binary: tBinary,
});
+scheme.WritableStreamWriteResult = tOptional(tObject({}));
+scheme.WritableStreamCloseParams = tOptional(tObject({}));
+scheme.WritableStreamCloseResult = tOptional(tObject({}));
scheme.BrowserInitializer = tObject({
version: tString,
name: tString,
@@ -847,29 +603,6 @@ scheme.BrowserStopTracingParams = tOptional(tObject({}));
scheme.BrowserStopTracingResult = tObject({
artifact: tChannel(['Artifact']),
});
-scheme.EventTargetInitializer = tOptional(tObject({}));
-scheme.EventTargetWaitForEventInfoParams = tObject({
- info: tObject({
- waitId: tString,
- phase: tEnum(['before', 'after', 'log']),
- event: tOptional(tString),
- message: tOptional(tString),
- error: tOptional(tString),
- }),
-});
-scheme.BrowserContextWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.PageWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.WorkerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.WebSocketWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.DebuggerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.AndroidDeviceWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
-scheme.EventTargetWaitForEventInfoResult = tOptional(tObject({}));
-scheme.BrowserContextWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.PageWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.WorkerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.WebSocketWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.DebuggerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
-scheme.AndroidDeviceWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
scheme.BrowserContextInitializer = tObject({
debugger: tChannel(['Debugger']),
requestContext: tChannel(['APIRequestContext']),
@@ -1111,1451 +844,1960 @@ scheme.BrowserContextStorageStateResult = tObject({
cookies: tArray(tType('NetworkCookie')),
origins: tArray(tType('OriginStorage')),
});
-scheme.BrowserContextSetStorageStateParams = tObject({
- storageState: tOptional(tObject({
- cookies: tOptional(tArray(tType('SetNetworkCookie'))),
- origins: tOptional(tArray(tType('SetOriginStorage'))),
+scheme.BrowserContextSetStorageStateParams = tObject({
+ storageState: tOptional(tObject({
+ cookies: tOptional(tArray(tType('SetNetworkCookie'))),
+ origins: tOptional(tArray(tType('SetOriginStorage'))),
+ })),
+});
+scheme.BrowserContextSetStorageStateResult = tOptional(tObject({}));
+scheme.BrowserContextPauseParams = tOptional(tObject({}));
+scheme.BrowserContextPauseResult = tOptional(tObject({}));
+scheme.BrowserContextEnableRecorderParams = tObject({
+ language: tOptional(tString),
+ mode: tOptional(tEnum(['inspecting', 'recording'])),
+ recorderMode: tOptional(tEnum(['default', 'api'])),
+ pauseOnNextStatement: tOptional(tBoolean),
+ testIdAttributeName: tOptional(tString),
+ launchOptions: tOptional(tAny),
+ contextOptions: tOptional(tAny),
+ device: tOptional(tString),
+ saveStorage: tOptional(tString),
+ outputFile: tOptional(tString),
+ handleSIGINT: tOptional(tBoolean),
+ omitCallTracking: tOptional(tBoolean),
+});
+scheme.BrowserContextEnableRecorderResult = tOptional(tObject({}));
+scheme.BrowserContextDisableRecorderParams = tOptional(tObject({}));
+scheme.BrowserContextDisableRecorderResult = tOptional(tObject({}));
+scheme.BrowserContextExposeConsoleApiParams = tOptional(tObject({}));
+scheme.BrowserContextExposeConsoleApiResult = tOptional(tObject({}));
+scheme.BrowserContextNewCDPSessionParams = tObject({
+ page: tOptional(tChannel(['Page'])),
+ frame: tOptional(tChannel(['Frame'])),
+});
+scheme.BrowserContextNewCDPSessionResult = tObject({
+ session: tChannel(['CDPSession']),
+});
+scheme.BrowserContextCreateTempFilesParams = tObject({
+ rootDirName: tOptional(tString),
+ items: tArray(tObject({
+ name: tString,
+ lastModifiedMs: tOptional(tFloat),
+ })),
+});
+scheme.BrowserContextCreateTempFilesResult = tObject({
+ rootDir: tOptional(tChannel(['WritableStream'])),
+ writableStreams: tArray(tChannel(['WritableStream'])),
+});
+scheme.BrowserContextUpdateSubscriptionParams = tObject({
+ event: tEnum(['console', 'dialog', 'request', 'response', 'requestFinished', 'requestFailed']),
+ enabled: tBoolean,
+});
+scheme.BrowserContextUpdateSubscriptionResult = tOptional(tObject({}));
+scheme.BrowserContextClockFastForwardParams = tObject({
+ ticksNumber: tOptional(tFloat),
+ ticksString: tOptional(tString),
+});
+scheme.BrowserContextClockFastForwardResult = tOptional(tObject({}));
+scheme.BrowserContextClockInstallParams = tObject({
+ timeNumber: tOptional(tFloat),
+ timeString: tOptional(tString),
+});
+scheme.BrowserContextClockInstallResult = tOptional(tObject({}));
+scheme.BrowserContextClockPauseAtParams = tObject({
+ timeNumber: tOptional(tFloat),
+ timeString: tOptional(tString),
+});
+scheme.BrowserContextClockPauseAtResult = tOptional(tObject({}));
+scheme.BrowserContextClockResumeParams = tOptional(tObject({}));
+scheme.BrowserContextClockResumeResult = tOptional(tObject({}));
+scheme.BrowserContextClockRunForParams = tObject({
+ ticksNumber: tOptional(tFloat),
+ ticksString: tOptional(tString),
+});
+scheme.BrowserContextClockRunForResult = tOptional(tObject({}));
+scheme.BrowserContextClockSetFixedTimeParams = tObject({
+ timeNumber: tOptional(tFloat),
+ timeString: tOptional(tString),
+});
+scheme.BrowserContextClockSetFixedTimeResult = tOptional(tObject({}));
+scheme.BrowserContextClockSetSystemTimeParams = tObject({
+ timeNumber: tOptional(tFloat),
+ timeString: tOptional(tString),
+});
+scheme.BrowserContextClockSetSystemTimeResult = tOptional(tObject({}));
+scheme.BrowserTypeInitializer = tObject({
+ executablePath: tString,
+ name: tString,
+});
+scheme.BrowserTypeLaunchParams = tObject({
+ channel: tOptional(tString),
+ executablePath: tOptional(tString),
+ args: tOptional(tArray(tString)),
+ ignoreAllDefaultArgs: tOptional(tBoolean),
+ ignoreDefaultArgs: tOptional(tArray(tString)),
+ handleSIGINT: tOptional(tBoolean),
+ handleSIGTERM: tOptional(tBoolean),
+ handleSIGHUP: tOptional(tBoolean),
+ timeout: tFloat,
+ env: tOptional(tArray(tType('NameValue'))),
+ headless: tOptional(tBoolean),
+ proxy: tOptional(tObject({
+ server: tString,
+ bypass: tOptional(tString),
+ username: tOptional(tString),
+ password: tOptional(tString),
+ })),
+ downloadsPath: tOptional(tString),
+ tracesDir: tOptional(tString),
+ artifactsDir: tOptional(tString),
+ chromiumSandbox: tOptional(tBoolean),
+ firefoxUserPrefs: tOptional(tAny),
+ cdpPort: tOptional(tInt),
+ slowMo: tOptional(tFloat),
+});
+scheme.BrowserTypeLaunchResult = tObject({
+ browser: tChannel(['Browser']),
+});
+scheme.BrowserTypeLaunchPersistentContextParams = tObject({
+ channel: tOptional(tString),
+ executablePath: tOptional(tString),
+ args: tOptional(tArray(tString)),
+ ignoreAllDefaultArgs: tOptional(tBoolean),
+ ignoreDefaultArgs: tOptional(tArray(tString)),
+ handleSIGINT: tOptional(tBoolean),
+ handleSIGTERM: tOptional(tBoolean),
+ handleSIGHUP: tOptional(tBoolean),
+ timeout: tFloat,
+ env: tOptional(tArray(tType('NameValue'))),
+ headless: tOptional(tBoolean),
+ proxy: tOptional(tObject({
+ server: tString,
+ bypass: tOptional(tString),
+ username: tOptional(tString),
+ password: tOptional(tString),
+ })),
+ downloadsPath: tOptional(tString),
+ tracesDir: tOptional(tString),
+ artifactsDir: tOptional(tString),
+ chromiumSandbox: tOptional(tBoolean),
+ firefoxUserPrefs: tOptional(tAny),
+ cdpPort: tOptional(tInt),
+ noDefaultViewport: tOptional(tBoolean),
+ viewport: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ screen: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ ignoreHTTPSErrors: tOptional(tBoolean),
+ clientCertificates: tOptional(tArray(tObject({
+ origin: tString,
+ cert: tOptional(tBinary),
+ key: tOptional(tBinary),
+ passphrase: tOptional(tString),
+ pfx: tOptional(tBinary),
+ }))),
+ javaScriptEnabled: tOptional(tBoolean),
+ bypassCSP: tOptional(tBoolean),
+ userAgent: tOptional(tString),
+ locale: tOptional(tString),
+ timezoneId: tOptional(tString),
+ geolocation: tOptional(tObject({
+ longitude: tFloat,
+ latitude: tFloat,
+ accuracy: tOptional(tFloat),
+ })),
+ permissions: tOptional(tArray(tString)),
+ extraHTTPHeaders: tOptional(tArray(tType('NameValue'))),
+ offline: tOptional(tBoolean),
+ httpCredentials: tOptional(tObject({
+ username: tString,
+ password: tString,
+ origin: tOptional(tString),
+ send: tOptional(tEnum(['always', 'unauthorized'])),
+ })),
+ deviceScaleFactor: tOptional(tFloat),
+ isMobile: tOptional(tBoolean),
+ hasTouch: tOptional(tBoolean),
+ colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
+ reducedMotion: tOptional(tEnum(['reduce', 'no-preference', 'no-override'])),
+ forcedColors: tOptional(tEnum(['active', 'none', 'no-override'])),
+ acceptDownloads: tOptional(tEnum(['accept', 'deny', 'internal-browser-default'])),
+ contrast: tOptional(tEnum(['no-preference', 'more', 'no-override'])),
+ baseURL: tOptional(tString),
+ recordVideo: tOptional(tObject({
+ dir: tOptional(tString),
+ size: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ showActions: tOptional(tObject({
+ duration: tOptional(tFloat),
+ position: tOptional(tEnum(['top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right'])),
+ fontSize: tOptional(tInt),
+ })),
+ })),
+ strictSelectors: tOptional(tBoolean),
+ serviceWorkers: tOptional(tEnum(['allow', 'block'])),
+ selectorEngines: tOptional(tArray(tType('SelectorEngine'))),
+ testIdAttributeName: tOptional(tString),
+ userDataDir: tString,
+ slowMo: tOptional(tFloat),
+});
+scheme.BrowserTypeLaunchPersistentContextResult = tObject({
+ browser: tChannel(['Browser']),
+ context: tChannel(['BrowserContext']),
+});
+scheme.BrowserTypeConnectOverCDPParams = tObject({
+ endpointURL: tString,
+ headers: tOptional(tArray(tType('NameValue'))),
+ slowMo: tOptional(tFloat),
+ timeout: tFloat,
+ isLocal: tOptional(tBoolean),
+ noDefaults: tOptional(tBoolean),
+});
+scheme.BrowserTypeConnectOverCDPResult = tObject({
+ browser: tChannel(['Browser']),
+ defaultContext: tOptional(tChannel(['BrowserContext'])),
+});
+scheme.BrowserTypeConnectToWorkerParams = tObject({
+ endpoint: tString,
+ timeout: tFloat,
+});
+scheme.BrowserTypeConnectToWorkerResult = tObject({
+ worker: tChannel(['Worker']),
+});
+scheme.Metadata = tObject({
+ location: tOptional(tObject({
+ file: tString,
+ line: tOptional(tInt),
+ column: tOptional(tInt),
})),
+ title: tOptional(tString),
+ internal: tOptional(tBoolean),
+ stepId: tOptional(tString),
});
-scheme.BrowserContextSetStorageStateResult = tOptional(tObject({}));
-scheme.BrowserContextPauseParams = tOptional(tObject({}));
-scheme.BrowserContextPauseResult = tOptional(tObject({}));
-scheme.BrowserContextEnableRecorderParams = tObject({
- language: tOptional(tString),
- mode: tOptional(tEnum(['inspecting', 'recording'])),
- recorderMode: tOptional(tEnum(['default', 'api'])),
- pauseOnNextStatement: tOptional(tBoolean),
- testIdAttributeName: tOptional(tString),
- launchOptions: tOptional(tAny),
- contextOptions: tOptional(tAny),
- device: tOptional(tString),
- saveStorage: tOptional(tString),
- outputFile: tOptional(tString),
- handleSIGINT: tOptional(tBoolean),
- omitCallTracking: tOptional(tBoolean),
+scheme.ClientSideCallMetadata = tObject({
+ id: tInt,
+ stack: tOptional(tArray(tType('StackFrame'))),
});
-scheme.BrowserContextEnableRecorderResult = tOptional(tObject({}));
-scheme.BrowserContextDisableRecorderParams = tOptional(tObject({}));
-scheme.BrowserContextDisableRecorderResult = tOptional(tObject({}));
-scheme.BrowserContextExposeConsoleApiParams = tOptional(tObject({}));
-scheme.BrowserContextExposeConsoleApiResult = tOptional(tObject({}));
-scheme.BrowserContextNewCDPSessionParams = tObject({
- page: tOptional(tChannel(['Page'])),
- frame: tOptional(tChannel(['Frame'])),
+scheme.SDKLanguage = tEnum(['javascript', 'python', 'java', 'csharp']);
+scheme.DisposableInitializer = tOptional(tObject({}));
+scheme.DisposableDisposeParams = tOptional(tObject({}));
+scheme.DisposableDisposeResult = tOptional(tObject({}));
+scheme.EventTargetInitializer = tOptional(tObject({}));
+scheme.EventTargetWaitForEventInfoParams = tObject({
+ info: tObject({
+ waitId: tString,
+ phase: tEnum(['before', 'after', 'log']),
+ event: tOptional(tString),
+ message: tOptional(tString),
+ error: tOptional(tString),
+ }),
});
-scheme.BrowserContextNewCDPSessionResult = tObject({
- session: tChannel(['CDPSession']),
+scheme.AndroidDeviceWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.BrowserContextWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.WebSocketWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.PageWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.DebuggerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.WorkerWaitForEventInfoParams = tType('EventTargetWaitForEventInfoParams');
+scheme.EventTargetWaitForEventInfoResult = tOptional(tObject({}));
+scheme.AndroidDeviceWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.BrowserContextWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.WebSocketWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.PageWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.DebuggerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.WorkerWaitForEventInfoResult = tType('EventTargetWaitForEventInfoResult');
+scheme.FrameInitializer = tObject({
+ url: tString,
+ name: tString,
+ parentFrame: tOptional(tChannel(['Frame'])),
+ loadStates: tArray(tType('LifecycleEvent')),
});
-scheme.BrowserContextCreateTempFilesParams = tObject({
- rootDirName: tOptional(tString),
- items: tArray(tObject({
- name: tString,
- lastModifiedMs: tOptional(tFloat),
+scheme.FrameLoadstateEvent = tObject({
+ add: tOptional(tType('LifecycleEvent')),
+ remove: tOptional(tType('LifecycleEvent')),
+});
+scheme.FrameNavigatedEvent = tObject({
+ url: tString,
+ name: tString,
+ newDocument: tOptional(tObject({
+ request: tOptional(tChannel(['Request'])),
})),
+ error: tOptional(tString),
});
-scheme.BrowserContextCreateTempFilesResult = tObject({
- rootDir: tOptional(tChannel(['WritableStream'])),
- writableStreams: tArray(tChannel(['WritableStream'])),
+scheme.FrameEvalOnSelectorParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.BrowserContextUpdateSubscriptionParams = tObject({
- event: tEnum(['console', 'dialog', 'request', 'response', 'requestFinished', 'requestFailed']),
- enabled: tBoolean,
+scheme.FrameEvalOnSelectorResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.BrowserContextUpdateSubscriptionResult = tOptional(tObject({}));
-scheme.BrowserContextClockFastForwardParams = tObject({
- ticksNumber: tOptional(tFloat),
- ticksString: tOptional(tString),
+scheme.FrameEvalOnSelectorAllParams = tObject({
+ selector: tString,
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.BrowserContextClockFastForwardResult = tOptional(tObject({}));
-scheme.BrowserContextClockInstallParams = tObject({
- timeNumber: tOptional(tFloat),
- timeString: tOptional(tString),
+scheme.FrameEvalOnSelectorAllResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.BrowserContextClockInstallResult = tOptional(tObject({}));
-scheme.BrowserContextClockPauseAtParams = tObject({
- timeNumber: tOptional(tFloat),
- timeString: tOptional(tString),
+scheme.FrameAddScriptTagParams = tObject({
+ url: tOptional(tString),
+ content: tOptional(tString),
+ type: tOptional(tString),
});
-scheme.BrowserContextClockPauseAtResult = tOptional(tObject({}));
-scheme.BrowserContextClockResumeParams = tOptional(tObject({}));
-scheme.BrowserContextClockResumeResult = tOptional(tObject({}));
-scheme.BrowserContextClockRunForParams = tObject({
- ticksNumber: tOptional(tFloat),
- ticksString: tOptional(tString),
+scheme.FrameAddScriptTagResult = tObject({
+ element: tChannel(['ElementHandle']),
});
-scheme.BrowserContextClockRunForResult = tOptional(tObject({}));
-scheme.BrowserContextClockSetFixedTimeParams = tObject({
- timeNumber: tOptional(tFloat),
- timeString: tOptional(tString),
+scheme.FrameAddStyleTagParams = tObject({
+ url: tOptional(tString),
+ content: tOptional(tString),
});
-scheme.BrowserContextClockSetFixedTimeResult = tOptional(tObject({}));
-scheme.BrowserContextClockSetSystemTimeParams = tObject({
- timeNumber: tOptional(tFloat),
- timeString: tOptional(tString),
+scheme.FrameAddStyleTagResult = tObject({
+ element: tChannel(['ElementHandle']),
});
-scheme.BrowserContextClockSetSystemTimeResult = tOptional(tObject({}));
-scheme.PageInitializer = tObject({
- mainFrame: tChannel(['Frame']),
- viewportSize: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- isClosed: tBoolean,
- opener: tOptional(tChannel(['Page'])),
- video: tOptional(tChannel(['Artifact'])),
+scheme.FrameAriaSnapshotParams = tObject({
+ mode: tOptional(tEnum(['ai', 'default'])),
+ track: tOptional(tString),
+ selector: tOptional(tString),
+ depth: tOptional(tInt),
+ boxes: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageBindingCallEvent = tObject({
- binding: tChannel(['BindingCall']),
+scheme.FrameAriaSnapshotResult = tObject({
+ snapshot: tString,
});
-scheme.PageCloseEvent = tOptional(tObject({}));
-scheme.PageCrashEvent = tOptional(tObject({}));
-scheme.PageDownloadEvent = tObject({
- url: tString,
- suggestedFilename: tString,
- artifact: tChannel(['Artifact']),
+scheme.FrameBlurParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageViewportSizeChangedEvent = tObject({
- viewportSize: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
+scheme.FrameBlurResult = tOptional(tObject({}));
+scheme.FrameCheckParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ position: tOptional(tType('Point')),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
});
-scheme.PageFileChooserEvent = tObject({
- element: tChannel(['ElementHandle']),
- isMultiple: tBoolean,
+scheme.FrameCheckResult = tOptional(tObject({}));
+scheme.FrameClickParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ noWaitAfter: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
+ delay: tOptional(tFloat),
+ button: tOptional(tEnum(['left', 'right', 'middle'])),
+ clickCount: tOptional(tInt),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
+ steps: tOptional(tInt),
});
-scheme.PageFrameAttachedEvent = tObject({
- frame: tChannel(['Frame']),
+scheme.FrameClickResult = tOptional(tObject({}));
+scheme.FrameContentParams = tOptional(tObject({}));
+scheme.FrameContentResult = tObject({
+ value: tString,
});
-scheme.PageFrameDetachedEvent = tObject({
- frame: tChannel(['Frame']),
+scheme.FrameDragAndDropParams = tObject({
+ source: tString,
+ target: tString,
+ force: tOptional(tBoolean),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
+ sourcePosition: tOptional(tType('Point')),
+ targetPosition: tOptional(tType('Point')),
+ strict: tOptional(tBoolean),
+ steps: tOptional(tInt),
+});
+scheme.FrameDragAndDropResult = tOptional(tObject({}));
+scheme.FrameDropParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ position: tOptional(tType('Point')),
+ payloads: tOptional(tArray(tObject({
+ name: tString,
+ mimeType: tOptional(tString),
+ buffer: tBinary,
+ }))),
+ localPaths: tOptional(tArray(tString)),
+ streams: tOptional(tArray(tChannel(['WritableStream']))),
+ data: tOptional(tArray(tObject({
+ mimeType: tString,
+ value: tString,
+ }))),
+ timeout: tFloat,
+});
+scheme.FrameDropResult = tOptional(tObject({}));
+scheme.FrameDblclickParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
+ delay: tOptional(tFloat),
+ button: tOptional(tEnum(['left', 'right', 'middle'])),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
+ steps: tOptional(tInt),
});
-scheme.PageLocatorHandlerTriggeredEvent = tObject({
- uid: tInt,
+scheme.FrameDblclickResult = tOptional(tObject({}));
+scheme.FrameDispatchEventParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ type: tString,
+ eventInit: tType('SerializedArgument'),
+ timeout: tFloat,
});
-scheme.PageRouteEvent = tObject({
- route: tChannel(['Route']),
+scheme.FrameDispatchEventResult = tOptional(tObject({}));
+scheme.FrameEvaluateExpressionParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.PageScreencastFrameEvent = tObject({
- data: tBinary,
+scheme.FrameEvaluateExpressionResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.PageWebSocketRouteEvent = tObject({
- webSocketRoute: tChannel(['WebSocketRoute']),
+scheme.FrameEvaluateExpressionHandleParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.PageWebSocketEvent = tObject({
- webSocket: tChannel(['WebSocket']),
+scheme.FrameEvaluateExpressionHandleResult = tObject({
+ handle: tChannel(['ElementHandle', 'JSHandle']),
});
-scheme.PageWorkerEvent = tObject({
- worker: tChannel(['Worker']),
+scheme.FrameFillParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ value: tString,
+ force: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageAddInitScriptParams = tObject({
- source: tString,
+scheme.FrameFillResult = tOptional(tObject({}));
+scheme.FrameFocusParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageAddInitScriptResult = tObject({
- disposable: tChannel(['Disposable']),
+scheme.FrameFocusResult = tOptional(tObject({}));
+scheme.FrameFrameElementParams = tOptional(tObject({}));
+scheme.FrameFrameElementResult = tObject({
+ element: tChannel(['ElementHandle']),
});
-scheme.PageCloseParams = tObject({
- runBeforeUnload: tOptional(tBoolean),
- reason: tOptional(tString),
+scheme.FrameResolveSelectorParams = tObject({
+ selector: tString,
});
-scheme.PageCloseResult = tOptional(tObject({}));
-scheme.PageClearConsoleMessagesParams = tOptional(tObject({}));
-scheme.PageClearConsoleMessagesResult = tOptional(tObject({}));
-scheme.PageConsoleMessagesParams = tObject({
- filter: tOptional(tType('ConsoleMessagesFilter')),
+scheme.FrameResolveSelectorResult = tObject({
+ resolvedSelector: tString,
});
-scheme.PageConsoleMessagesResult = tObject({
- messages: tArray(tObject({
- type: tString,
- text: tString,
- args: tArray(tChannel(['ElementHandle', 'JSHandle'])),
- location: tObject({
- url: tString,
- lineNumber: tInt,
- columnNumber: tInt,
- }),
- timestamp: tFloat,
- })),
+scheme.FrameHighlightParams = tObject({
+ selector: tString,
+ style: tOptional(tString),
});
-scheme.PageEmulateMediaParams = tObject({
- media: tOptional(tEnum(['screen', 'print', 'no-override'])),
- colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
- reducedMotion: tOptional(tEnum(['reduce', 'no-preference', 'no-override'])),
- forcedColors: tOptional(tEnum(['active', 'none', 'no-override'])),
- contrast: tOptional(tEnum(['no-preference', 'more', 'no-override'])),
+scheme.FrameHighlightResult = tOptional(tObject({}));
+scheme.FrameHideHighlightParams = tObject({
+ selector: tString,
});
-scheme.PageEmulateMediaResult = tOptional(tObject({}));
-scheme.PageExposeBindingParams = tObject({
+scheme.FrameHideHighlightResult = tOptional(tObject({}));
+scheme.FrameGetAttributeParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
name: tString,
+ timeout: tFloat,
});
-scheme.PageExposeBindingResult = tObject({
- disposable: tChannel(['Disposable']),
+scheme.FrameGetAttributeResult = tObject({
+ value: tOptional(tString),
});
-scheme.PageGoBackParams = tObject({
+scheme.FrameGotoParams = tObject({
+ url: tString,
timeout: tFloat,
waitUntil: tOptional(tType('LifecycleEvent')),
+ referer: tOptional(tString),
});
-scheme.PageGoBackResult = tObject({
+scheme.FrameGotoResult = tObject({
response: tOptional(tChannel(['Response'])),
});
-scheme.PageGoForwardParams = tObject({
+scheme.FrameHoverParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
timeout: tFloat,
- waitUntil: tOptional(tType('LifecycleEvent')),
+ trial: tOptional(tBoolean),
});
-scheme.PageGoForwardResult = tObject({
- response: tOptional(tChannel(['Response'])),
+scheme.FrameHoverResult = tOptional(tObject({}));
+scheme.FrameInnerHTMLParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageRequestGCParams = tOptional(tObject({}));
-scheme.PageRequestGCResult = tOptional(tObject({}));
-scheme.PageRegisterLocatorHandlerParams = tObject({
+scheme.FrameInnerHTMLResult = tObject({
+ value: tString,
+});
+scheme.FrameInnerTextParams = tObject({
selector: tString,
- noWaitAfter: tOptional(tBoolean),
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageRegisterLocatorHandlerResult = tObject({
- uid: tInt,
+scheme.FrameInnerTextResult = tObject({
+ value: tString,
});
-scheme.PageResolveLocatorHandlerNoReplyParams = tObject({
- uid: tInt,
- remove: tOptional(tBoolean),
+scheme.FrameInputValueParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageResolveLocatorHandlerNoReplyResult = tOptional(tObject({}));
-scheme.PageUnregisterLocatorHandlerParams = tObject({
- uid: tInt,
+scheme.FrameInputValueResult = tObject({
+ value: tString,
});
-scheme.PageUnregisterLocatorHandlerResult = tOptional(tObject({}));
-scheme.PageReloadParams = tObject({
+scheme.FrameIsCheckedParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
timeout: tFloat,
- waitUntil: tOptional(tType('LifecycleEvent')),
});
-scheme.PageReloadResult = tObject({
- response: tOptional(tChannel(['Response'])),
+scheme.FrameIsCheckedResult = tObject({
+ value: tBoolean,
});
-scheme.PageExpectScreenshotParams = tObject({
- expected: tOptional(tBinary),
+scheme.FrameIsDisabledParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
timeout: tFloat,
- isNot: tBoolean,
- locator: tOptional(tObject({
- frame: tChannel(['Frame']),
- selector: tString,
- })),
- comparator: tOptional(tString),
- maxDiffPixels: tOptional(tInt),
- maxDiffPixelRatio: tOptional(tFloat),
- threshold: tOptional(tFloat),
- fullPage: tOptional(tBoolean),
- clip: tOptional(tType('Rect')),
- omitBackground: tOptional(tBoolean),
- caret: tOptional(tEnum(['hide', 'initial'])),
- animations: tOptional(tEnum(['disabled', 'allow'])),
- scale: tOptional(tEnum(['css', 'device'])),
- mask: tOptional(tArray(tObject({
- frame: tChannel(['Frame']),
- selector: tString,
- }))),
- maskColor: tOptional(tString),
- style: tOptional(tString),
});
-scheme.PageExpectScreenshotResult = tObject({
- diff: tOptional(tBinary),
- errorMessage: tOptional(tString),
- actual: tOptional(tBinary),
- previous: tOptional(tBinary),
- timedOut: tOptional(tBoolean),
- log: tOptional(tArray(tString)),
+scheme.FrameIsDisabledResult = tObject({
+ value: tBoolean,
});
-scheme.PageScreenshotParams = tObject({
+scheme.FrameIsEnabledParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
timeout: tFloat,
- type: tOptional(tEnum(['png', 'jpeg'])),
- quality: tOptional(tInt),
- fullPage: tOptional(tBoolean),
- clip: tOptional(tType('Rect')),
- omitBackground: tOptional(tBoolean),
- caret: tOptional(tEnum(['hide', 'initial'])),
- animations: tOptional(tEnum(['disabled', 'allow'])),
- scale: tOptional(tEnum(['css', 'device'])),
- mask: tOptional(tArray(tObject({
- frame: tChannel(['Frame']),
- selector: tString,
- }))),
- maskColor: tOptional(tString),
- style: tOptional(tString),
});
-scheme.PageScreenshotResult = tObject({
- binary: tBinary,
+scheme.FrameIsEnabledResult = tObject({
+ value: tBoolean,
});
-scheme.PageSetExtraHTTPHeadersParams = tObject({
- headers: tArray(tType('NameValue')),
+scheme.FrameIsHiddenParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
});
-scheme.PageSetExtraHTTPHeadersResult = tOptional(tObject({}));
-scheme.PageSetNetworkInterceptionPatternsParams = tObject({
- patterns: tArray(tObject({
- glob: tOptional(tString),
- regexSource: tOptional(tString),
- regexFlags: tOptional(tString),
- urlPattern: tOptional(tType('URLPattern')),
- })),
+scheme.FrameIsHiddenResult = tObject({
+ value: tBoolean,
});
-scheme.PageSetNetworkInterceptionPatternsResult = tOptional(tObject({}));
-scheme.PageSetWebSocketInterceptionPatternsParams = tObject({
- patterns: tArray(tObject({
- glob: tOptional(tString),
- regexSource: tOptional(tString),
- regexFlags: tOptional(tString),
- urlPattern: tOptional(tType('URLPattern')),
- })),
+scheme.FrameIsVisibleParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
});
-scheme.PageSetWebSocketInterceptionPatternsResult = tOptional(tObject({}));
-scheme.PageSetViewportSizeParams = tObject({
- viewportSize: tObject({
- width: tInt,
- height: tInt,
- }),
+scheme.FrameIsVisibleResult = tObject({
+ value: tBoolean,
+});
+scheme.FrameIsEditableParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
+});
+scheme.FrameIsEditableResult = tObject({
+ value: tBoolean,
});
-scheme.PageSetViewportSizeResult = tOptional(tObject({}));
-scheme.PageKeyboardDownParams = tObject({
+scheme.FramePressParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
key: tString,
+ delay: tOptional(tFloat),
+ noWaitAfter: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageKeyboardDownResult = tOptional(tObject({}));
-scheme.PageKeyboardUpParams = tObject({
- key: tString,
+scheme.FramePressResult = tOptional(tObject({}));
+scheme.FrameQuerySelectorParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
});
-scheme.PageKeyboardUpResult = tOptional(tObject({}));
-scheme.PageKeyboardInsertTextParams = tObject({
- text: tString,
+scheme.FrameQuerySelectorResult = tObject({
+ element: tOptional(tChannel(['ElementHandle'])),
});
-scheme.PageKeyboardInsertTextResult = tOptional(tObject({}));
-scheme.PageKeyboardTypeParams = tObject({
- text: tString,
- delay: tOptional(tFloat),
+scheme.FrameQuerySelectorAllParams = tObject({
+ selector: tString,
});
-scheme.PageKeyboardTypeResult = tOptional(tObject({}));
-scheme.PageKeyboardPressParams = tObject({
- key: tString,
- delay: tOptional(tFloat),
+scheme.FrameQuerySelectorAllResult = tObject({
+ elements: tArray(tChannel(['ElementHandle'])),
});
-scheme.PageKeyboardPressResult = tOptional(tObject({}));
-scheme.PageMouseMoveParams = tObject({
- x: tFloat,
- y: tFloat,
- steps: tOptional(tInt),
+scheme.FrameQueryCountParams = tObject({
+ selector: tString,
});
-scheme.PageMouseMoveResult = tOptional(tObject({}));
-scheme.PageMouseDownParams = tObject({
- button: tOptional(tEnum(['left', 'right', 'middle'])),
- clickCount: tOptional(tInt),
+scheme.FrameQueryCountResult = tObject({
+ value: tInt,
});
-scheme.PageMouseDownResult = tOptional(tObject({}));
-scheme.PageMouseUpParams = tObject({
- button: tOptional(tEnum(['left', 'right', 'middle'])),
- clickCount: tOptional(tInt),
+scheme.FrameSelectOptionParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ elements: tOptional(tArray(tChannel(['ElementHandle']))),
+ options: tOptional(tArray(tObject({
+ valueOrLabel: tOptional(tString),
+ value: tOptional(tString),
+ label: tOptional(tString),
+ index: tOptional(tInt),
+ }))),
+ force: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PageMouseUpResult = tOptional(tObject({}));
-scheme.PageMouseClickParams = tObject({
- x: tFloat,
- y: tFloat,
- delay: tOptional(tFloat),
- button: tOptional(tEnum(['left', 'right', 'middle'])),
- clickCount: tOptional(tInt),
+scheme.FrameSelectOptionResult = tObject({
+ values: tArray(tString),
});
-scheme.PageMouseClickResult = tOptional(tObject({}));
-scheme.PageMouseWheelParams = tObject({
- deltaX: tFloat,
- deltaY: tFloat,
+scheme.FrameSetContentParams = tObject({
+ html: tString,
+ timeout: tFloat,
+ waitUntil: tOptional(tType('LifecycleEvent')),
});
-scheme.PageMouseWheelResult = tOptional(tObject({}));
-scheme.PageTouchscreenTapParams = tObject({
- x: tFloat,
- y: tFloat,
+scheme.FrameSetContentResult = tOptional(tObject({}));
+scheme.FrameSetInputFilesParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ payloads: tOptional(tArray(tObject({
+ name: tString,
+ mimeType: tOptional(tString),
+ buffer: tBinary,
+ }))),
+ localDirectory: tOptional(tString),
+ directoryStream: tOptional(tChannel(['WritableStream'])),
+ localPaths: tOptional(tArray(tString)),
+ streams: tOptional(tArray(tChannel(['WritableStream']))),
+ timeout: tFloat,
});
-scheme.PageTouchscreenTapResult = tOptional(tObject({}));
-scheme.PageClearPageErrorsParams = tOptional(tObject({}));
-scheme.PageClearPageErrorsResult = tOptional(tObject({}));
-scheme.PagePageErrorsParams = tObject({
- filter: tOptional(tType('ConsoleMessagesFilter')),
+scheme.FrameSetInputFilesResult = tOptional(tObject({}));
+scheme.FrameTapParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
});
-scheme.PagePageErrorsResult = tObject({
- errors: tArray(tType('SerializedError')),
+scheme.FrameTapResult = tOptional(tObject({}));
+scheme.FrameTextContentParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
});
-scheme.PagePdfParams = tObject({
- scale: tOptional(tFloat),
- displayHeaderFooter: tOptional(tBoolean),
- headerTemplate: tOptional(tString),
- footerTemplate: tOptional(tString),
- printBackground: tOptional(tBoolean),
- landscape: tOptional(tBoolean),
- pageRanges: tOptional(tString),
- format: tOptional(tString),
- width: tOptional(tString),
- height: tOptional(tString),
- preferCSSPageSize: tOptional(tBoolean),
- margin: tOptional(tObject({
- top: tOptional(tString),
- bottom: tOptional(tString),
- left: tOptional(tString),
- right: tOptional(tString),
- })),
- tagged: tOptional(tBoolean),
- outline: tOptional(tBoolean),
+scheme.FrameTextContentResult = tObject({
+ value: tOptional(tString),
});
-scheme.PagePdfResult = tObject({
- pdf: tBinary,
+scheme.FrameTitleParams = tOptional(tObject({}));
+scheme.FrameTitleResult = tObject({
+ value: tString,
});
-scheme.PageRequestsParams = tOptional(tObject({}));
-scheme.PageRequestsResult = tObject({
- requests: tArray(tChannel(['Request'])),
+scheme.FrameTypeParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ text: tString,
+ delay: tOptional(tFloat),
+ timeout: tFloat,
});
-scheme.PageStartJSCoverageParams = tObject({
- resetOnNavigation: tOptional(tBoolean),
- reportAnonymousScripts: tOptional(tBoolean),
+scheme.FrameTypeResult = tOptional(tObject({}));
+scheme.FrameUncheckParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+ force: tOptional(tBoolean),
+ position: tOptional(tType('Point')),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
});
-scheme.PageStartJSCoverageResult = tOptional(tObject({}));
-scheme.PageStopJSCoverageParams = tOptional(tObject({}));
-scheme.PageStopJSCoverageResult = tObject({
- entries: tArray(tObject({
- url: tString,
- scriptId: tString,
- source: tOptional(tString),
- functions: tArray(tObject({
- functionName: tString,
- isBlockCoverage: tBoolean,
- ranges: tArray(tObject({
- startOffset: tInt,
- endOffset: tInt,
- count: tInt,
- })),
- })),
- })),
+scheme.FrameUncheckResult = tOptional(tObject({}));
+scheme.FrameWaitForTimeoutParams = tObject({
+ waitTimeout: tFloat,
});
-scheme.PageStartCSSCoverageParams = tObject({
- resetOnNavigation: tOptional(tBoolean),
+scheme.FrameWaitForTimeoutResult = tOptional(tObject({}));
+scheme.FrameWaitForFunctionParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
+ timeout: tFloat,
+ pollingInterval: tOptional(tFloat),
});
-scheme.PageStartCSSCoverageResult = tOptional(tObject({}));
-scheme.PageStopCSSCoverageParams = tOptional(tObject({}));
-scheme.PageStopCSSCoverageResult = tObject({
- entries: tArray(tObject({
- url: tString,
- text: tOptional(tString),
- ranges: tArray(tObject({
- start: tInt,
- end: tInt,
- })),
- })),
+scheme.FrameWaitForFunctionResult = tObject({
+ handle: tChannel(['ElementHandle', 'JSHandle']),
});
-scheme.PageBringToFrontParams = tOptional(tObject({}));
-scheme.PageBringToFrontResult = tOptional(tObject({}));
-scheme.PagePickLocatorParams = tOptional(tObject({}));
-scheme.PagePickLocatorResult = tObject({
+scheme.FrameWaitForSelectorParams = tObject({
selector: tString,
+ strict: tOptional(tBoolean),
+ timeout: tFloat,
+ state: tOptional(tEnum(['attached', 'detached', 'visible', 'hidden'])),
+ omitReturnValue: tOptional(tBoolean),
});
-scheme.PageCancelPickLocatorParams = tOptional(tObject({}));
-scheme.PageCancelPickLocatorResult = tOptional(tObject({}));
-scheme.PageHideHighlightParams = tOptional(tObject({}));
-scheme.PageHideHighlightResult = tOptional(tObject({}));
-scheme.PageScreencastShowOverlayParams = tObject({
- html: tString,
- duration: tOptional(tFloat),
+scheme.FrameWaitForSelectorResult = tObject({
+ element: tOptional(tChannel(['ElementHandle'])),
});
-scheme.PageScreencastShowOverlayResult = tObject({
- id: tString,
+scheme.FrameExpectParams = tObject({
+ selector: tOptional(tString),
+ expression: tString,
+ expressionArg: tOptional(tAny),
+ pseudo: tOptional(tEnum(['before', 'after'])),
+ expectedText: tOptional(tArray(tType('ExpectedTextValue'))),
+ expectedNumber: tOptional(tFloat),
+ expectedValue: tOptional(tType('SerializedArgument')),
+ useInnerText: tOptional(tBoolean),
+ isNot: tBoolean,
+ timeout: tFloat,
});
-scheme.PageScreencastRemoveOverlayParams = tObject({
- id: tString,
+scheme.FrameExpectResult = tObject({
+ matches: tBoolean,
+ received: tOptional(tObject({
+ value: tOptional(tType('SerializedValue')),
+ ariaSnapshot: tOptional(tString),
+ })),
+ timedOut: tOptional(tBoolean),
+ errorMessage: tOptional(tString),
+ log: tOptional(tArray(tString)),
});
-scheme.PageScreencastRemoveOverlayResult = tOptional(tObject({}));
-scheme.PageScreencastChapterParams = tObject({
- title: tString,
- description: tOptional(tString),
- duration: tOptional(tFloat),
+scheme.JSHandleInitializer = tObject({
+ preview: tString,
});
-scheme.PageScreencastChapterResult = tOptional(tObject({}));
-scheme.PageScreencastSetOverlayVisibleParams = tObject({
- visible: tBoolean,
+scheme.JSHandlePreviewUpdatedEvent = tObject({
+ preview: tString,
});
-scheme.PageScreencastSetOverlayVisibleResult = tOptional(tObject({}));
-scheme.PageScreencastShowActionsParams = tObject({
- duration: tOptional(tFloat),
- position: tOptional(tEnum(['top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right'])),
- fontSize: tOptional(tInt),
+scheme.ElementHandlePreviewUpdatedEvent = tType('JSHandlePreviewUpdatedEvent');
+scheme.JSHandleDisposeParams = tOptional(tObject({}));
+scheme.ElementHandleDisposeParams = tType('JSHandleDisposeParams');
+scheme.JSHandleDisposeResult = tOptional(tObject({}));
+scheme.ElementHandleDisposeResult = tType('JSHandleDisposeResult');
+scheme.JSHandleEvaluateExpressionParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.PageScreencastShowActionsResult = tOptional(tObject({}));
-scheme.PageScreencastHideActionsParams = tOptional(tObject({}));
-scheme.PageScreencastHideActionsResult = tOptional(tObject({}));
-scheme.PageScreencastStartParams = tObject({
- size: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- quality: tOptional(tInt),
- sendFrames: tOptional(tBoolean),
- record: tOptional(tBoolean),
+scheme.ElementHandleEvaluateExpressionParams = tType('JSHandleEvaluateExpressionParams');
+scheme.JSHandleEvaluateExpressionResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.PageScreencastStartResult = tObject({
- artifact: tOptional(tChannel(['Artifact'])),
+scheme.ElementHandleEvaluateExpressionResult = tType('JSHandleEvaluateExpressionResult');
+scheme.JSHandleEvaluateExpressionHandleParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.PageScreencastStopParams = tOptional(tObject({}));
-scheme.PageScreencastStopResult = tOptional(tObject({}));
-scheme.PageUpdateSubscriptionParams = tObject({
- event: tEnum(['console', 'dialog', 'fileChooser', 'request', 'response', 'requestFinished', 'requestFailed']),
- enabled: tBoolean,
+scheme.ElementHandleEvaluateExpressionHandleParams = tType('JSHandleEvaluateExpressionHandleParams');
+scheme.JSHandleEvaluateExpressionHandleResult = tObject({
+ handle: tChannel(['ElementHandle', 'JSHandle']),
});
-scheme.PageUpdateSubscriptionResult = tOptional(tObject({}));
-scheme.PageSetDockTileParams = tObject({
- image: tBinary,
+scheme.ElementHandleEvaluateExpressionHandleResult = tType('JSHandleEvaluateExpressionHandleResult');
+scheme.JSHandleGetPropertyListParams = tOptional(tObject({}));
+scheme.ElementHandleGetPropertyListParams = tType('JSHandleGetPropertyListParams');
+scheme.JSHandleGetPropertyListResult = tObject({
+ properties: tArray(tObject({
+ name: tString,
+ value: tChannel(['ElementHandle', 'JSHandle']),
+ })),
});
-scheme.PageSetDockTileResult = tOptional(tObject({}));
-scheme.FrameInitializer = tObject({
- url: tString,
+scheme.ElementHandleGetPropertyListResult = tType('JSHandleGetPropertyListResult');
+scheme.JSHandleGetPropertyParams = tObject({
name: tString,
- parentFrame: tOptional(tChannel(['Frame'])),
- loadStates: tArray(tType('LifecycleEvent')),
});
-scheme.FrameLoadstateEvent = tObject({
- add: tOptional(tType('LifecycleEvent')),
- remove: tOptional(tType('LifecycleEvent')),
+scheme.ElementHandleGetPropertyParams = tType('JSHandleGetPropertyParams');
+scheme.JSHandleGetPropertyResult = tObject({
+ handle: tChannel(['ElementHandle', 'JSHandle']),
});
-scheme.FrameNavigatedEvent = tObject({
- url: tString,
- name: tString,
- newDocument: tOptional(tObject({
- request: tOptional(tChannel(['Request'])),
- })),
- error: tOptional(tString),
+scheme.ElementHandleGetPropertyResult = tType('JSHandleGetPropertyResult');
+scheme.JSHandleJsonValueParams = tOptional(tObject({}));
+scheme.ElementHandleJsonValueParams = tType('JSHandleJsonValueParams');
+scheme.JSHandleJsonValueResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.FrameEvalOnSelectorParams = tObject({
+scheme.ElementHandleJsonValueResult = tType('JSHandleJsonValueResult');
+scheme.ElementHandleInitializer = tObject({
+ preview: tString,
+});
+scheme.ElementHandleEvalOnSelectorParams = tObject({
selector: tString,
strict: tOptional(tBoolean),
expression: tString,
isFunction: tOptional(tBoolean),
arg: tType('SerializedArgument'),
});
-scheme.FrameEvalOnSelectorResult = tObject({
+scheme.ElementHandleEvalOnSelectorResult = tObject({
value: tType('SerializedValue'),
});
-scheme.FrameEvalOnSelectorAllParams = tObject({
+scheme.ElementHandleEvalOnSelectorAllParams = tObject({
selector: tString,
expression: tString,
isFunction: tOptional(tBoolean),
arg: tType('SerializedArgument'),
});
-scheme.FrameEvalOnSelectorAllResult = tObject({
+scheme.ElementHandleEvalOnSelectorAllResult = tObject({
value: tType('SerializedValue'),
});
-scheme.FrameAddScriptTagParams = tObject({
- url: tOptional(tString),
- content: tOptional(tString),
- type: tOptional(tString),
+scheme.ElementHandleBoundingBoxParams = tOptional(tObject({}));
+scheme.ElementHandleBoundingBoxResult = tObject({
+ value: tOptional(tType('Rect')),
});
-scheme.FrameAddScriptTagResult = tObject({
- element: tChannel(['ElementHandle']),
+scheme.ElementHandleCheckParams = tObject({
+ force: tOptional(tBoolean),
+ position: tOptional(tType('Point')),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
});
-scheme.FrameAddStyleTagParams = tObject({
- url: tOptional(tString),
- content: tOptional(tString),
+scheme.ElementHandleCheckResult = tOptional(tObject({}));
+scheme.ElementHandleClickParams = tObject({
+ force: tOptional(tBoolean),
+ noWaitAfter: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
+ delay: tOptional(tFloat),
+ button: tOptional(tEnum(['left', 'right', 'middle'])),
+ clickCount: tOptional(tInt),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
+ steps: tOptional(tInt),
});
-scheme.FrameAddStyleTagResult = tObject({
- element: tChannel(['ElementHandle']),
+scheme.ElementHandleClickResult = tOptional(tObject({}));
+scheme.ElementHandleContentFrameParams = tOptional(tObject({}));
+scheme.ElementHandleContentFrameResult = tObject({
+ frame: tOptional(tChannel(['Frame'])),
});
-scheme.FrameAriaSnapshotParams = tObject({
- mode: tOptional(tEnum(['ai', 'default'])),
- track: tOptional(tString),
- selector: tOptional(tString),
- depth: tOptional(tInt),
- boxes: tOptional(tBoolean),
+scheme.ElementHandleDblclickParams = tObject({
+ force: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
+ position: tOptional(tType('Point')),
+ delay: tOptional(tFloat),
+ button: tOptional(tEnum(['left', 'right', 'middle'])),
timeout: tFloat,
+ trial: tOptional(tBoolean),
+ steps: tOptional(tInt),
});
-scheme.FrameAriaSnapshotResult = tObject({
- snapshot: tString,
+scheme.ElementHandleDblclickResult = tOptional(tObject({}));
+scheme.ElementHandleDispatchEventParams = tObject({
+ type: tString,
+ eventInit: tType('SerializedArgument'),
});
-scheme.FrameBlurParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ElementHandleDispatchEventResult = tOptional(tObject({}));
+scheme.ElementHandleFillParams = tObject({
+ value: tString,
+ force: tOptional(tBoolean),
timeout: tFloat,
});
-scheme.FrameBlurResult = tOptional(tObject({}));
-scheme.FrameCheckParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ElementHandleFillResult = tOptional(tObject({}));
+scheme.ElementHandleFocusParams = tOptional(tObject({}));
+scheme.ElementHandleFocusResult = tOptional(tObject({}));
+scheme.ElementHandleGetAttributeParams = tObject({
+ name: tString,
+});
+scheme.ElementHandleGetAttributeResult = tObject({
+ value: tOptional(tString),
+});
+scheme.ElementHandleHoverParams = tObject({
force: tOptional(tBoolean),
+ modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
position: tOptional(tType('Point')),
timeout: tFloat,
- trial: tOptional(tBoolean),
+ trial: tOptional(tBoolean),
+});
+scheme.ElementHandleHoverResult = tOptional(tObject({}));
+scheme.ElementHandleInnerHTMLParams = tOptional(tObject({}));
+scheme.ElementHandleInnerHTMLResult = tObject({
+ value: tString,
+});
+scheme.ElementHandleInnerTextParams = tOptional(tObject({}));
+scheme.ElementHandleInnerTextResult = tObject({
+ value: tString,
+});
+scheme.ElementHandleInputValueParams = tOptional(tObject({}));
+scheme.ElementHandleInputValueResult = tObject({
+ value: tString,
+});
+scheme.ElementHandleIsCheckedParams = tOptional(tObject({}));
+scheme.ElementHandleIsCheckedResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleIsDisabledParams = tOptional(tObject({}));
+scheme.ElementHandleIsDisabledResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleIsEditableParams = tOptional(tObject({}));
+scheme.ElementHandleIsEditableResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleIsEnabledParams = tOptional(tObject({}));
+scheme.ElementHandleIsEnabledResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleIsHiddenParams = tOptional(tObject({}));
+scheme.ElementHandleIsHiddenResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleIsVisibleParams = tOptional(tObject({}));
+scheme.ElementHandleIsVisibleResult = tObject({
+ value: tBoolean,
+});
+scheme.ElementHandleOwnerFrameParams = tOptional(tObject({}));
+scheme.ElementHandleOwnerFrameResult = tObject({
+ frame: tOptional(tChannel(['Frame'])),
+});
+scheme.ElementHandlePressParams = tObject({
+ key: tString,
+ delay: tOptional(tFloat),
+ timeout: tFloat,
+ noWaitAfter: tOptional(tBoolean),
+});
+scheme.ElementHandlePressResult = tOptional(tObject({}));
+scheme.ElementHandleQuerySelectorParams = tObject({
+ selector: tString,
+ strict: tOptional(tBoolean),
+});
+scheme.ElementHandleQuerySelectorResult = tObject({
+ element: tOptional(tChannel(['ElementHandle'])),
+});
+scheme.ElementHandleQuerySelectorAllParams = tObject({
+ selector: tString,
+});
+scheme.ElementHandleQuerySelectorAllResult = tObject({
+ elements: tArray(tChannel(['ElementHandle'])),
+});
+scheme.ElementHandleScreenshotParams = tObject({
+ timeout: tFloat,
+ type: tOptional(tEnum(['png', 'jpeg'])),
+ quality: tOptional(tInt),
+ omitBackground: tOptional(tBoolean),
+ caret: tOptional(tEnum(['hide', 'initial'])),
+ animations: tOptional(tEnum(['disabled', 'allow'])),
+ scale: tOptional(tEnum(['css', 'device'])),
+ mask: tOptional(tArray(tObject({
+ frame: tChannel(['Frame']),
+ selector: tString,
+ }))),
+ maskColor: tOptional(tString),
+ style: tOptional(tString),
+});
+scheme.ElementHandleScreenshotResult = tObject({
+ binary: tBinary,
+});
+scheme.ElementHandleScrollIntoViewIfNeededParams = tObject({
+ timeout: tFloat,
});
-scheme.FrameCheckResult = tOptional(tObject({}));
-scheme.FrameClickParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ElementHandleScrollIntoViewIfNeededResult = tOptional(tObject({}));
+scheme.ElementHandleSelectOptionParams = tObject({
+ elements: tOptional(tArray(tChannel(['ElementHandle']))),
+ options: tOptional(tArray(tObject({
+ valueOrLabel: tOptional(tString),
+ value: tOptional(tString),
+ label: tOptional(tString),
+ index: tOptional(tInt),
+ }))),
force: tOptional(tBoolean),
- noWaitAfter: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- delay: tOptional(tFloat),
- button: tOptional(tEnum(['left', 'right', 'middle'])),
- clickCount: tOptional(tInt),
timeout: tFloat,
- trial: tOptional(tBoolean),
- steps: tOptional(tInt),
});
-scheme.FrameClickResult = tOptional(tObject({}));
-scheme.FrameContentParams = tOptional(tObject({}));
-scheme.FrameContentResult = tObject({
- value: tString,
+scheme.ElementHandleSelectOptionResult = tObject({
+ values: tArray(tString),
});
-scheme.FrameDragAndDropParams = tObject({
- source: tString,
- target: tString,
+scheme.ElementHandleSelectTextParams = tObject({
force: tOptional(tBoolean),
timeout: tFloat,
- trial: tOptional(tBoolean),
- sourcePosition: tOptional(tType('Point')),
- targetPosition: tOptional(tType('Point')),
- strict: tOptional(tBoolean),
- steps: tOptional(tInt),
});
-scheme.FrameDragAndDropResult = tOptional(tObject({}));
-scheme.FrameDropParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- position: tOptional(tType('Point')),
+scheme.ElementHandleSelectTextResult = tOptional(tObject({}));
+scheme.ElementHandleSetInputFilesParams = tObject({
payloads: tOptional(tArray(tObject({
name: tString,
mimeType: tOptional(tString),
buffer: tBinary,
}))),
+ localDirectory: tOptional(tString),
+ directoryStream: tOptional(tChannel(['WritableStream'])),
localPaths: tOptional(tArray(tString)),
streams: tOptional(tArray(tChannel(['WritableStream']))),
- data: tOptional(tArray(tObject({
- mimeType: tString,
- value: tString,
- }))),
timeout: tFloat,
});
-scheme.FrameDropResult = tOptional(tObject({}));
-scheme.FrameDblclickParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ElementHandleSetInputFilesResult = tOptional(tObject({}));
+scheme.ElementHandleTapParams = tObject({
force: tOptional(tBoolean),
modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
position: tOptional(tType('Point')),
+ timeout: tFloat,
+ trial: tOptional(tBoolean),
+});
+scheme.ElementHandleTapResult = tOptional(tObject({}));
+scheme.ElementHandleTextContentParams = tOptional(tObject({}));
+scheme.ElementHandleTextContentResult = tObject({
+ value: tOptional(tString),
+});
+scheme.ElementHandleTypeParams = tObject({
+ text: tString,
delay: tOptional(tFloat),
- button: tOptional(tEnum(['left', 'right', 'middle'])),
+ timeout: tFloat,
+});
+scheme.ElementHandleTypeResult = tOptional(tObject({}));
+scheme.ElementHandleUncheckParams = tObject({
+ force: tOptional(tBoolean),
+ position: tOptional(tType('Point')),
timeout: tFloat,
trial: tOptional(tBoolean),
- steps: tOptional(tInt),
});
-scheme.FrameDblclickResult = tOptional(tObject({}));
-scheme.FrameDispatchEventParams = tObject({
+scheme.ElementHandleUncheckResult = tOptional(tObject({}));
+scheme.ElementHandleWaitForElementStateParams = tObject({
+ state: tEnum(['visible', 'hidden', 'stable', 'enabled', 'disabled', 'editable']),
+ timeout: tFloat,
+});
+scheme.ElementHandleWaitForElementStateResult = tOptional(tObject({}));
+scheme.ElementHandleWaitForSelectorParams = tObject({
selector: tString,
strict: tOptional(tBoolean),
- type: tString,
- eventInit: tType('SerializedArgument'),
timeout: tFloat,
+ state: tOptional(tEnum(['attached', 'detached', 'visible', 'hidden'])),
});
-scheme.FrameDispatchEventResult = tOptional(tObject({}));
-scheme.FrameEvaluateExpressionParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.ElementHandleWaitForSelectorResult = tObject({
+ element: tOptional(tChannel(['ElementHandle'])),
});
-scheme.FrameEvaluateExpressionResult = tObject({
- value: tType('SerializedValue'),
+scheme.LocalUtilsInitializer = tObject({
+ deviceDescriptors: tArray(tObject({
+ name: tString,
+ descriptor: tObject({
+ userAgent: tString,
+ viewport: tObject({
+ width: tInt,
+ height: tInt,
+ }),
+ screen: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ deviceScaleFactor: tFloat,
+ isMobile: tBoolean,
+ hasTouch: tBoolean,
+ defaultBrowserType: tEnum(['chromium', 'firefox', 'webkit']),
+ }),
+ })),
});
-scheme.FrameEvaluateExpressionHandleParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.LocalUtilsZipParams = tObject({
+ zipFile: tString,
+ entries: tArray(tType('NameValue')),
+ stacksId: tOptional(tString),
+ mode: tEnum(['write', 'append']),
+ includeSources: tBoolean,
+ additionalSources: tOptional(tArray(tString)),
});
-scheme.FrameEvaluateExpressionHandleResult = tObject({
- handle: tChannel(['ElementHandle', 'JSHandle']),
+scheme.LocalUtilsZipResult = tOptional(tObject({}));
+scheme.LocalUtilsHarOpenParams = tObject({
+ file: tString,
});
-scheme.FrameFillParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- value: tString,
- force: tOptional(tBoolean),
- timeout: tFloat,
+scheme.LocalUtilsHarOpenResult = tObject({
+ harId: tOptional(tString),
+ error: tOptional(tString),
});
-scheme.FrameFillResult = tOptional(tObject({}));
-scheme.FrameFocusParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.LocalUtilsHarLookupParams = tObject({
+ harId: tString,
+ url: tString,
+ method: tString,
+ headers: tArray(tType('NameValue')),
+ postData: tOptional(tBinary),
+ isNavigationRequest: tBoolean,
+});
+scheme.LocalUtilsHarLookupResult = tObject({
+ action: tEnum(['error', 'redirect', 'fulfill', 'noentry']),
+ message: tOptional(tString),
+ redirectURL: tOptional(tString),
+ status: tOptional(tInt),
+ headers: tOptional(tArray(tType('NameValue'))),
+ body: tOptional(tBinary),
+});
+scheme.LocalUtilsHarCloseParams = tObject({
+ harId: tString,
+});
+scheme.LocalUtilsHarCloseResult = tOptional(tObject({}));
+scheme.LocalUtilsHarUnzipParams = tObject({
+ zipFile: tString,
+ harFile: tString,
+ resourcesDir: tOptional(tString),
+});
+scheme.LocalUtilsHarUnzipResult = tOptional(tObject({}));
+scheme.LocalUtilsConnectParams = tObject({
+ endpoint: tString,
+ headers: tOptional(tAny),
+ exposeNetwork: tOptional(tString),
+ slowMo: tOptional(tFloat),
timeout: tFloat,
+ socksProxyRedirectPortForTest: tOptional(tInt),
});
-scheme.FrameFocusResult = tOptional(tObject({}));
-scheme.FrameFrameElementParams = tOptional(tObject({}));
-scheme.FrameFrameElementResult = tObject({
- element: tChannel(['ElementHandle']),
+scheme.LocalUtilsConnectResult = tObject({
+ pipe: tChannel(['JsonPipe']),
+ headers: tArray(tType('NameValue')),
});
-scheme.FrameResolveSelectorParams = tObject({
- selector: tString,
+scheme.LocalUtilsTracingStartedParams = tObject({
+ tracesDir: tOptional(tString),
+ traceName: tString,
+ live: tOptional(tBoolean),
});
-scheme.FrameResolveSelectorResult = tObject({
- resolvedSelector: tString,
+scheme.LocalUtilsTracingStartedResult = tObject({
+ stacksId: tString,
});
-scheme.FrameHighlightParams = tObject({
- selector: tString,
- style: tOptional(tString),
+scheme.LocalUtilsAddStackToTracingNoReplyParams = tObject({
+ callData: tType('ClientSideCallMetadata'),
});
-scheme.FrameHighlightResult = tOptional(tObject({}));
-scheme.FrameHideHighlightParams = tObject({
- selector: tString,
+scheme.LocalUtilsAddStackToTracingNoReplyResult = tOptional(tObject({}));
+scheme.LocalUtilsTraceDiscardedParams = tObject({
+ stacksId: tString,
});
-scheme.FrameHideHighlightResult = tOptional(tObject({}));
-scheme.FrameGetAttributeParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.LocalUtilsTraceDiscardedResult = tOptional(tObject({}));
+scheme.LocalUtilsGlobToRegexParams = tObject({
+ glob: tString,
+ baseURL: tOptional(tString),
+ webSocketUrl: tOptional(tBoolean),
+});
+scheme.LocalUtilsGlobToRegexResult = tObject({
+ regex: tString,
+});
+scheme.SetNetworkCookie = tObject({
name: tString,
- timeout: tFloat,
+ value: tString,
+ url: tOptional(tString),
+ domain: tOptional(tString),
+ path: tOptional(tString),
+ expires: tOptional(tFloat),
+ httpOnly: tOptional(tBoolean),
+ secure: tOptional(tBoolean),
+ sameSite: tOptional(tEnum(['Strict', 'Lax', 'None'])),
+ partitionKey: tOptional(tString),
+ _crHasCrossSiteAncestor: tOptional(tBoolean),
+});
+scheme.NetworkCookie = tObject({
+ name: tString,
+ value: tString,
+ domain: tString,
+ path: tString,
+ expires: tFloat,
+ httpOnly: tBoolean,
+ secure: tBoolean,
+ sameSite: tEnum(['Strict', 'Lax', 'None']),
+ partitionKey: tOptional(tString),
+ _crHasCrossSiteAncestor: tOptional(tBoolean),
+});
+scheme.RequestInitializer = tObject({
+ frame: tOptional(tChannel(['Frame'])),
+ serviceWorker: tOptional(tChannel(['Worker'])),
+ url: tString,
+ resourceType: tString,
+ method: tString,
+ postData: tOptional(tBinary),
+ headers: tArray(tType('NameValue')),
+ isNavigationRequest: tBoolean,
+ redirectedFrom: tOptional(tChannel(['Request'])),
+});
+scheme.RequestResponseParams = tOptional(tObject({}));
+scheme.RequestResponseResult = tObject({
+ response: tOptional(tChannel(['Response'])),
});
-scheme.FrameGetAttributeResult = tObject({
- value: tOptional(tString),
+scheme.RequestRawRequestHeadersParams = tOptional(tObject({}));
+scheme.RequestRawRequestHeadersResult = tObject({
+ headers: tArray(tType('NameValue')),
});
-scheme.FrameGotoParams = tObject({
+scheme.RouteInitializer = tObject({
+ request: tChannel(['Request']),
+});
+scheme.RouteRedirectNavigationRequestParams = tObject({
url: tString,
- timeout: tFloat,
- waitUntil: tOptional(tType('LifecycleEvent')),
- referer: tOptional(tString),
});
-scheme.FrameGotoResult = tObject({
- response: tOptional(tChannel(['Response'])),
+scheme.RouteRedirectNavigationRequestResult = tOptional(tObject({}));
+scheme.RouteAbortParams = tObject({
+ errorCode: tOptional(tString),
});
-scheme.FrameHoverParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- force: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.RouteAbortResult = tOptional(tObject({}));
+scheme.RouteContinueParams = tObject({
+ url: tOptional(tString),
+ method: tOptional(tString),
+ headers: tOptional(tArray(tType('NameValue'))),
+ postData: tOptional(tBinary),
+ isFallback: tBoolean,
});
-scheme.FrameHoverResult = tOptional(tObject({}));
-scheme.FrameInnerHTMLParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.RouteContinueResult = tOptional(tObject({}));
+scheme.RouteFulfillParams = tObject({
+ status: tOptional(tInt),
+ headers: tOptional(tArray(tType('NameValue'))),
+ body: tOptional(tString),
+ isBase64: tOptional(tBoolean),
+ fetchResponseUid: tOptional(tString),
});
-scheme.FrameInnerHTMLResult = tObject({
- value: tString,
+scheme.RouteFulfillResult = tOptional(tObject({}));
+scheme.WebSocketRouteInitializer = tObject({
+ url: tString,
+ protocols: tArray(tString),
});
-scheme.FrameInnerTextParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketRouteMessageFromPageEvent = tObject({
+ message: tString,
+ isBase64: tBoolean,
});
-scheme.FrameInnerTextResult = tObject({
- value: tString,
+scheme.WebSocketRouteMessageFromServerEvent = tObject({
+ message: tString,
+ isBase64: tBoolean,
});
-scheme.FrameInputValueParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketRouteClosePageEvent = tObject({
+ code: tOptional(tInt),
+ reason: tOptional(tString),
+ wasClean: tBoolean,
});
-scheme.FrameInputValueResult = tObject({
- value: tString,
+scheme.WebSocketRouteCloseServerEvent = tObject({
+ code: tOptional(tInt),
+ reason: tOptional(tString),
+ wasClean: tBoolean,
});
-scheme.FrameIsCheckedParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketRouteConnectParams = tOptional(tObject({}));
+scheme.WebSocketRouteConnectResult = tOptional(tObject({}));
+scheme.WebSocketRouteEnsureOpenedParams = tOptional(tObject({}));
+scheme.WebSocketRouteEnsureOpenedResult = tOptional(tObject({}));
+scheme.WebSocketRouteSendToPageParams = tObject({
+ message: tString,
+ isBase64: tBoolean,
});
-scheme.FrameIsCheckedResult = tObject({
- value: tBoolean,
+scheme.WebSocketRouteSendToPageResult = tOptional(tObject({}));
+scheme.WebSocketRouteSendToServerParams = tObject({
+ message: tString,
+ isBase64: tBoolean,
});
-scheme.FrameIsDisabledParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketRouteSendToServerResult = tOptional(tObject({}));
+scheme.WebSocketRouteClosePageParams = tObject({
+ code: tOptional(tInt),
+ reason: tOptional(tString),
+ wasClean: tBoolean,
});
-scheme.FrameIsDisabledResult = tObject({
- value: tBoolean,
+scheme.WebSocketRouteClosePageResult = tOptional(tObject({}));
+scheme.WebSocketRouteCloseServerParams = tObject({
+ code: tOptional(tInt),
+ reason: tOptional(tString),
+ wasClean: tBoolean,
});
-scheme.FrameIsEnabledParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketRouteCloseServerResult = tOptional(tObject({}));
+scheme.ResourceTiming = tObject({
+ startTime: tFloat,
+ domainLookupStart: tFloat,
+ domainLookupEnd: tFloat,
+ connectStart: tFloat,
+ secureConnectionStart: tFloat,
+ connectEnd: tFloat,
+ requestStart: tFloat,
+ responseStart: tFloat,
});
-scheme.FrameIsEnabledResult = tObject({
- value: tBoolean,
+scheme.ResponseInitializer = tObject({
+ request: tChannel(['Request']),
+ url: tString,
+ status: tInt,
+ statusText: tString,
+ headers: tArray(tType('NameValue')),
+ timing: tType('ResourceTiming'),
+ fromServiceWorker: tBoolean,
});
-scheme.FrameIsHiddenParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ResponseBodyParams = tOptional(tObject({}));
+scheme.ResponseBodyResult = tObject({
+ binary: tBinary,
});
-scheme.FrameIsHiddenResult = tObject({
- value: tBoolean,
+scheme.ResponseSecurityDetailsParams = tOptional(tObject({}));
+scheme.ResponseSecurityDetailsResult = tObject({
+ value: tOptional(tType('SecurityDetails')),
});
-scheme.FrameIsVisibleParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.ResponseServerAddrParams = tOptional(tObject({}));
+scheme.ResponseServerAddrResult = tObject({
+ value: tOptional(tType('RemoteAddr')),
});
-scheme.FrameIsVisibleResult = tObject({
- value: tBoolean,
+scheme.ResponseRawResponseHeadersParams = tOptional(tObject({}));
+scheme.ResponseRawResponseHeadersResult = tObject({
+ headers: tArray(tType('NameValue')),
});
-scheme.FrameIsEditableParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.ResponseHttpVersionParams = tOptional(tObject({}));
+scheme.ResponseHttpVersionResult = tObject({
+ value: tString,
});
-scheme.FrameIsEditableResult = tObject({
- value: tBoolean,
+scheme.ResponseSizesParams = tOptional(tObject({}));
+scheme.ResponseSizesResult = tObject({
+ sizes: tType('RequestSizes'),
});
-scheme.FramePressParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- key: tString,
- delay: tOptional(tFloat),
- noWaitAfter: tOptional(tBoolean),
- timeout: tFloat,
+scheme.SecurityDetails = tObject({
+ issuer: tOptional(tString),
+ protocol: tOptional(tString),
+ subjectName: tOptional(tString),
+ validFrom: tOptional(tFloat),
+ validTo: tOptional(tFloat),
});
-scheme.FramePressResult = tOptional(tObject({}));
-scheme.FrameQuerySelectorParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
+scheme.RequestSizes = tObject({
+ requestBodySize: tInt,
+ requestHeadersSize: tInt,
+ responseBodySize: tInt,
+ responseHeadersSize: tInt,
});
-scheme.FrameQuerySelectorResult = tObject({
- element: tOptional(tChannel(['ElementHandle'])),
+scheme.RemoteAddr = tObject({
+ ipAddress: tString,
+ port: tInt,
});
-scheme.FrameQuerySelectorAllParams = tObject({
- selector: tString,
+scheme.WebSocketInitializer = tObject({
+ url: tString,
});
-scheme.FrameQuerySelectorAllResult = tObject({
- elements: tArray(tChannel(['ElementHandle'])),
+scheme.WebSocketOpenEvent = tOptional(tObject({}));
+scheme.WebSocketFrameSentEvent = tObject({
+ opcode: tInt,
+ data: tString,
});
-scheme.FrameQueryCountParams = tObject({
- selector: tString,
+scheme.WebSocketFrameReceivedEvent = tObject({
+ opcode: tInt,
+ data: tString,
});
-scheme.FrameQueryCountResult = tObject({
- value: tInt,
+scheme.WebSocketSocketErrorEvent = tObject({
+ error: tString,
});
-scheme.FrameSelectOptionParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- elements: tOptional(tArray(tChannel(['ElementHandle']))),
- options: tOptional(tArray(tObject({
- valueOrLabel: tOptional(tString),
- value: tOptional(tString),
- label: tOptional(tString),
- index: tOptional(tInt),
- }))),
- force: tOptional(tBoolean),
- timeout: tFloat,
+scheme.WebSocketCloseEvent = tOptional(tObject({}));
+scheme.PageInitializer = tObject({
+ mainFrame: tChannel(['Frame']),
+ viewportSize: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ isClosed: tBoolean,
+ opener: tOptional(tChannel(['Page'])),
+ video: tOptional(tChannel(['Artifact'])),
});
-scheme.FrameSelectOptionResult = tObject({
- values: tArray(tString),
+scheme.PageBindingCallEvent = tObject({
+ binding: tChannel(['BindingCall']),
});
-scheme.FrameSetContentParams = tObject({
- html: tString,
- timeout: tFloat,
- waitUntil: tOptional(tType('LifecycleEvent')),
+scheme.PageCloseEvent = tOptional(tObject({}));
+scheme.PageCrashEvent = tOptional(tObject({}));
+scheme.PageDownloadEvent = tObject({
+ url: tString,
+ suggestedFilename: tString,
+ artifact: tChannel(['Artifact']),
+});
+scheme.PageViewportSizeChangedEvent = tObject({
+ viewportSize: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
});
-scheme.FrameSetContentResult = tOptional(tObject({}));
-scheme.FrameSetInputFilesParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- payloads: tOptional(tArray(tObject({
- name: tString,
- mimeType: tOptional(tString),
- buffer: tBinary,
- }))),
- localDirectory: tOptional(tString),
- directoryStream: tOptional(tChannel(['WritableStream'])),
- localPaths: tOptional(tArray(tString)),
- streams: tOptional(tArray(tChannel(['WritableStream']))),
- timeout: tFloat,
+scheme.PageFileChooserEvent = tObject({
+ element: tChannel(['ElementHandle']),
+ isMultiple: tBoolean,
});
-scheme.FrameSetInputFilesResult = tOptional(tObject({}));
-scheme.FrameTapParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- force: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.PageFrameAttachedEvent = tObject({
+ frame: tChannel(['Frame']),
});
-scheme.FrameTapResult = tOptional(tObject({}));
-scheme.FrameTextContentParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
+scheme.PageFrameDetachedEvent = tObject({
+ frame: tChannel(['Frame']),
});
-scheme.FrameTextContentResult = tObject({
- value: tOptional(tString),
+scheme.PageLocatorHandlerTriggeredEvent = tObject({
+ uid: tInt,
});
-scheme.FrameTitleParams = tOptional(tObject({}));
-scheme.FrameTitleResult = tObject({
- value: tString,
+scheme.PageRouteEvent = tObject({
+ route: tChannel(['Route']),
});
-scheme.FrameTypeParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- text: tString,
- delay: tOptional(tFloat),
- timeout: tFloat,
+scheme.PageScreencastFrameEvent = tObject({
+ data: tBinary,
});
-scheme.FrameTypeResult = tOptional(tObject({}));
-scheme.FrameUncheckParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- force: tOptional(tBoolean),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.PageWebSocketRouteEvent = tObject({
+ webSocketRoute: tChannel(['WebSocketRoute']),
});
-scheme.FrameUncheckResult = tOptional(tObject({}));
-scheme.FrameWaitForTimeoutParams = tObject({
- waitTimeout: tFloat,
+scheme.PageWebSocketEvent = tObject({
+ webSocket: tChannel(['WebSocket']),
});
-scheme.FrameWaitForTimeoutResult = tOptional(tObject({}));
-scheme.FrameWaitForFunctionParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
- timeout: tFloat,
- pollingInterval: tOptional(tFloat),
+scheme.PageWorkerEvent = tObject({
+ worker: tChannel(['Worker']),
});
-scheme.FrameWaitForFunctionResult = tObject({
- handle: tChannel(['ElementHandle', 'JSHandle']),
+scheme.PageAddInitScriptParams = tObject({
+ source: tString,
});
-scheme.FrameWaitForSelectorParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
- state: tOptional(tEnum(['attached', 'detached', 'visible', 'hidden'])),
- omitReturnValue: tOptional(tBoolean),
+scheme.PageAddInitScriptResult = tObject({
+ disposable: tChannel(['Disposable']),
});
-scheme.FrameWaitForSelectorResult = tObject({
- element: tOptional(tChannel(['ElementHandle'])),
+scheme.PageCloseParams = tObject({
+ runBeforeUnload: tOptional(tBoolean),
+ reason: tOptional(tString),
});
-scheme.FrameExpectParams = tObject({
- selector: tOptional(tString),
- expression: tString,
- expressionArg: tOptional(tAny),
- pseudo: tOptional(tEnum(['before', 'after'])),
- expectedText: tOptional(tArray(tType('ExpectedTextValue'))),
- expectedNumber: tOptional(tFloat),
- expectedValue: tOptional(tType('SerializedArgument')),
- useInnerText: tOptional(tBoolean),
- isNot: tBoolean,
- timeout: tFloat,
+scheme.PageCloseResult = tOptional(tObject({}));
+scheme.PageClearConsoleMessagesParams = tOptional(tObject({}));
+scheme.PageClearConsoleMessagesResult = tOptional(tObject({}));
+scheme.PageConsoleMessagesParams = tObject({
+ filter: tOptional(tType('ConsoleMessagesFilter')),
});
-scheme.FrameExpectResult = tObject({
- matches: tBoolean,
- received: tOptional(tObject({
- value: tOptional(tType('SerializedValue')),
- ariaSnapshot: tOptional(tString),
+scheme.PageConsoleMessagesResult = tObject({
+ messages: tArray(tObject({
+ type: tString,
+ text: tString,
+ args: tArray(tChannel(['ElementHandle', 'JSHandle'])),
+ location: tObject({
+ url: tString,
+ lineNumber: tInt,
+ columnNumber: tInt,
+ }),
+ timestamp: tFloat,
})),
- timedOut: tOptional(tBoolean),
- errorMessage: tOptional(tString),
- log: tOptional(tArray(tString)),
});
-scheme.WorkerInitializer = tObject({
- url: tString,
+scheme.PageEmulateMediaParams = tObject({
+ media: tOptional(tEnum(['screen', 'print', 'no-override'])),
+ colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
+ reducedMotion: tOptional(tEnum(['reduce', 'no-preference', 'no-override'])),
+ forcedColors: tOptional(tEnum(['active', 'none', 'no-override'])),
+ contrast: tOptional(tEnum(['no-preference', 'more', 'no-override'])),
});
-scheme.WorkerConsoleEvent = tObject({
- type: tString,
- text: tString,
- args: tArray(tChannel(['ElementHandle', 'JSHandle'])),
- location: tObject({
- url: tString,
- lineNumber: tInt,
- columnNumber: tInt,
- }),
- timestamp: tFloat,
+scheme.PageEmulateMediaResult = tOptional(tObject({}));
+scheme.PageExposeBindingParams = tObject({
+ name: tString,
});
-scheme.WorkerCloseEvent = tOptional(tObject({}));
-scheme.WorkerDisconnectParams = tObject({
- reason: tOptional(tString),
+scheme.PageExposeBindingResult = tObject({
+ disposable: tChannel(['Disposable']),
});
-scheme.WorkerDisconnectResult = tOptional(tObject({}));
-scheme.WorkerEvaluateExpressionParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageGoBackParams = tObject({
+ timeout: tFloat,
+ waitUntil: tOptional(tType('LifecycleEvent')),
});
-scheme.WorkerEvaluateExpressionResult = tObject({
- value: tType('SerializedValue'),
+scheme.PageGoBackResult = tObject({
+ response: tOptional(tChannel(['Response'])),
});
-scheme.WorkerEvaluateExpressionHandleParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageGoForwardParams = tObject({
+ timeout: tFloat,
+ waitUntil: tOptional(tType('LifecycleEvent')),
});
-scheme.WorkerEvaluateExpressionHandleResult = tObject({
- handle: tChannel(['ElementHandle', 'JSHandle']),
+scheme.PageGoForwardResult = tObject({
+ response: tOptional(tChannel(['Response'])),
});
-scheme.WorkerUpdateSubscriptionParams = tObject({
- event: tEnum(['console']),
- enabled: tBoolean,
+scheme.PageRequestGCParams = tOptional(tObject({}));
+scheme.PageRequestGCResult = tOptional(tObject({}));
+scheme.PageRegisterLocatorHandlerParams = tObject({
+ selector: tString,
+ noWaitAfter: tOptional(tBoolean),
});
-scheme.WorkerUpdateSubscriptionResult = tOptional(tObject({}));
-scheme.DisposableInitializer = tOptional(tObject({}));
-scheme.DisposableDisposeParams = tOptional(tObject({}));
-scheme.DisposableDisposeResult = tOptional(tObject({}));
-scheme.JSHandleInitializer = tObject({
- preview: tString,
+scheme.PageRegisterLocatorHandlerResult = tObject({
+ uid: tInt,
});
-scheme.JSHandlePreviewUpdatedEvent = tObject({
- preview: tString,
+scheme.PageResolveLocatorHandlerNoReplyParams = tObject({
+ uid: tInt,
+ remove: tOptional(tBoolean),
});
-scheme.ElementHandlePreviewUpdatedEvent = tType('JSHandlePreviewUpdatedEvent');
-scheme.JSHandleDisposeParams = tOptional(tObject({}));
-scheme.ElementHandleDisposeParams = tType('JSHandleDisposeParams');
-scheme.JSHandleDisposeResult = tOptional(tObject({}));
-scheme.ElementHandleDisposeResult = tType('JSHandleDisposeResult');
-scheme.JSHandleEvaluateExpressionParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageResolveLocatorHandlerNoReplyResult = tOptional(tObject({}));
+scheme.PageUnregisterLocatorHandlerParams = tObject({
+ uid: tInt,
});
-scheme.ElementHandleEvaluateExpressionParams = tType('JSHandleEvaluateExpressionParams');
-scheme.JSHandleEvaluateExpressionResult = tObject({
- value: tType('SerializedValue'),
+scheme.PageUnregisterLocatorHandlerResult = tOptional(tObject({}));
+scheme.PageReloadParams = tObject({
+ timeout: tFloat,
+ waitUntil: tOptional(tType('LifecycleEvent')),
});
-scheme.ElementHandleEvaluateExpressionResult = tType('JSHandleEvaluateExpressionResult');
-scheme.JSHandleEvaluateExpressionHandleParams = tObject({
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageReloadResult = tObject({
+ response: tOptional(tChannel(['Response'])),
+});
+scheme.PageExpectScreenshotParams = tObject({
+ expected: tOptional(tBinary),
+ timeout: tFloat,
+ isNot: tBoolean,
+ locator: tOptional(tObject({
+ frame: tChannel(['Frame']),
+ selector: tString,
+ })),
+ comparator: tOptional(tString),
+ maxDiffPixels: tOptional(tInt),
+ maxDiffPixelRatio: tOptional(tFloat),
+ threshold: tOptional(tFloat),
+ fullPage: tOptional(tBoolean),
+ clip: tOptional(tType('Rect')),
+ omitBackground: tOptional(tBoolean),
+ caret: tOptional(tEnum(['hide', 'initial'])),
+ animations: tOptional(tEnum(['disabled', 'allow'])),
+ scale: tOptional(tEnum(['css', 'device'])),
+ mask: tOptional(tArray(tObject({
+ frame: tChannel(['Frame']),
+ selector: tString,
+ }))),
+ maskColor: tOptional(tString),
+ style: tOptional(tString),
+});
+scheme.PageExpectScreenshotResult = tObject({
+ diff: tOptional(tBinary),
+ errorMessage: tOptional(tString),
+ actual: tOptional(tBinary),
+ previous: tOptional(tBinary),
+ timedOut: tOptional(tBoolean),
+ log: tOptional(tArray(tString)),
});
-scheme.ElementHandleEvaluateExpressionHandleParams = tType('JSHandleEvaluateExpressionHandleParams');
-scheme.JSHandleEvaluateExpressionHandleResult = tObject({
- handle: tChannel(['ElementHandle', 'JSHandle']),
+scheme.PageScreenshotParams = tObject({
+ timeout: tFloat,
+ type: tOptional(tEnum(['png', 'jpeg'])),
+ quality: tOptional(tInt),
+ fullPage: tOptional(tBoolean),
+ clip: tOptional(tType('Rect')),
+ omitBackground: tOptional(tBoolean),
+ caret: tOptional(tEnum(['hide', 'initial'])),
+ animations: tOptional(tEnum(['disabled', 'allow'])),
+ scale: tOptional(tEnum(['css', 'device'])),
+ mask: tOptional(tArray(tObject({
+ frame: tChannel(['Frame']),
+ selector: tString,
+ }))),
+ maskColor: tOptional(tString),
+ style: tOptional(tString),
});
-scheme.ElementHandleEvaluateExpressionHandleResult = tType('JSHandleEvaluateExpressionHandleResult');
-scheme.JSHandleGetPropertyListParams = tOptional(tObject({}));
-scheme.ElementHandleGetPropertyListParams = tType('JSHandleGetPropertyListParams');
-scheme.JSHandleGetPropertyListResult = tObject({
- properties: tArray(tObject({
- name: tString,
- value: tChannel(['ElementHandle', 'JSHandle']),
- })),
+scheme.PageScreenshotResult = tObject({
+ binary: tBinary,
});
-scheme.ElementHandleGetPropertyListResult = tType('JSHandleGetPropertyListResult');
-scheme.JSHandleGetPropertyParams = tObject({
- name: tString,
+scheme.PageSetExtraHTTPHeadersParams = tObject({
+ headers: tArray(tType('NameValue')),
});
-scheme.ElementHandleGetPropertyParams = tType('JSHandleGetPropertyParams');
-scheme.JSHandleGetPropertyResult = tObject({
- handle: tChannel(['ElementHandle', 'JSHandle']),
+scheme.PageSetExtraHTTPHeadersResult = tOptional(tObject({}));
+scheme.PageSetNetworkInterceptionPatternsParams = tObject({
+ patterns: tArray(tObject({
+ glob: tOptional(tString),
+ regexSource: tOptional(tString),
+ regexFlags: tOptional(tString),
+ urlPattern: tOptional(tType('URLPattern')),
+ })),
});
-scheme.ElementHandleGetPropertyResult = tType('JSHandleGetPropertyResult');
-scheme.JSHandleJsonValueParams = tOptional(tObject({}));
-scheme.ElementHandleJsonValueParams = tType('JSHandleJsonValueParams');
-scheme.JSHandleJsonValueResult = tObject({
- value: tType('SerializedValue'),
+scheme.PageSetNetworkInterceptionPatternsResult = tOptional(tObject({}));
+scheme.PageSetWebSocketInterceptionPatternsParams = tObject({
+ patterns: tArray(tObject({
+ glob: tOptional(tString),
+ regexSource: tOptional(tString),
+ regexFlags: tOptional(tString),
+ urlPattern: tOptional(tType('URLPattern')),
+ })),
});
-scheme.ElementHandleJsonValueResult = tType('JSHandleJsonValueResult');
-scheme.ElementHandleInitializer = tObject({
- preview: tString,
+scheme.PageSetWebSocketInterceptionPatternsResult = tOptional(tObject({}));
+scheme.PageSetViewportSizeParams = tObject({
+ viewportSize: tObject({
+ width: tInt,
+ height: tInt,
+ }),
});
-scheme.ElementHandleEvalOnSelectorParams = tObject({
- selector: tString,
- strict: tOptional(tBoolean),
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageSetViewportSizeResult = tOptional(tObject({}));
+scheme.PageKeyboardDownParams = tObject({
+ key: tString,
});
-scheme.ElementHandleEvalOnSelectorResult = tObject({
- value: tType('SerializedValue'),
+scheme.PageKeyboardDownResult = tOptional(tObject({}));
+scheme.PageKeyboardUpParams = tObject({
+ key: tString,
});
-scheme.ElementHandleEvalOnSelectorAllParams = tObject({
- selector: tString,
- expression: tString,
- isFunction: tOptional(tBoolean),
- arg: tType('SerializedArgument'),
+scheme.PageKeyboardUpResult = tOptional(tObject({}));
+scheme.PageKeyboardInsertTextParams = tObject({
+ text: tString,
});
-scheme.ElementHandleEvalOnSelectorAllResult = tObject({
- value: tType('SerializedValue'),
+scheme.PageKeyboardInsertTextResult = tOptional(tObject({}));
+scheme.PageKeyboardTypeParams = tObject({
+ text: tString,
+ delay: tOptional(tFloat),
});
-scheme.ElementHandleBoundingBoxParams = tOptional(tObject({}));
-scheme.ElementHandleBoundingBoxResult = tObject({
- value: tOptional(tType('Rect')),
+scheme.PageKeyboardTypeResult = tOptional(tObject({}));
+scheme.PageKeyboardPressParams = tObject({
+ key: tString,
+ delay: tOptional(tFloat),
});
-scheme.ElementHandleCheckParams = tObject({
- force: tOptional(tBoolean),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.PageKeyboardPressResult = tOptional(tObject({}));
+scheme.PageMouseMoveParams = tObject({
+ x: tFloat,
+ y: tFloat,
+ steps: tOptional(tInt),
});
-scheme.ElementHandleCheckResult = tOptional(tObject({}));
-scheme.ElementHandleClickParams = tObject({
- force: tOptional(tBoolean),
- noWaitAfter: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- delay: tOptional(tFloat),
+scheme.PageMouseMoveResult = tOptional(tObject({}));
+scheme.PageMouseDownParams = tObject({
button: tOptional(tEnum(['left', 'right', 'middle'])),
clickCount: tOptional(tInt),
- timeout: tFloat,
- trial: tOptional(tBoolean),
- steps: tOptional(tInt),
});
-scheme.ElementHandleClickResult = tOptional(tObject({}));
-scheme.ElementHandleContentFrameParams = tOptional(tObject({}));
-scheme.ElementHandleContentFrameResult = tObject({
- frame: tOptional(tChannel(['Frame'])),
+scheme.PageMouseDownResult = tOptional(tObject({}));
+scheme.PageMouseUpParams = tObject({
+ button: tOptional(tEnum(['left', 'right', 'middle'])),
+ clickCount: tOptional(tInt),
});
-scheme.ElementHandleDblclickParams = tObject({
- force: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
+scheme.PageMouseUpResult = tOptional(tObject({}));
+scheme.PageMouseClickParams = tObject({
+ x: tFloat,
+ y: tFloat,
delay: tOptional(tFloat),
button: tOptional(tEnum(['left', 'right', 'middle'])),
- timeout: tFloat,
- trial: tOptional(tBoolean),
- steps: tOptional(tInt),
-});
-scheme.ElementHandleDblclickResult = tOptional(tObject({}));
-scheme.ElementHandleDispatchEventParams = tObject({
- type: tString,
- eventInit: tType('SerializedArgument'),
-});
-scheme.ElementHandleDispatchEventResult = tOptional(tObject({}));
-scheme.ElementHandleFillParams = tObject({
- value: tString,
- force: tOptional(tBoolean),
- timeout: tFloat,
-});
-scheme.ElementHandleFillResult = tOptional(tObject({}));
-scheme.ElementHandleFocusParams = tOptional(tObject({}));
-scheme.ElementHandleFocusResult = tOptional(tObject({}));
-scheme.ElementHandleGetAttributeParams = tObject({
- name: tString,
-});
-scheme.ElementHandleGetAttributeResult = tObject({
- value: tOptional(tString),
-});
-scheme.ElementHandleHoverParams = tObject({
- force: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+ clickCount: tOptional(tInt),
});
-scheme.ElementHandleHoverResult = tOptional(tObject({}));
-scheme.ElementHandleInnerHTMLParams = tOptional(tObject({}));
-scheme.ElementHandleInnerHTMLResult = tObject({
- value: tString,
+scheme.PageMouseClickResult = tOptional(tObject({}));
+scheme.PageMouseWheelParams = tObject({
+ deltaX: tFloat,
+ deltaY: tFloat,
});
-scheme.ElementHandleInnerTextParams = tOptional(tObject({}));
-scheme.ElementHandleInnerTextResult = tObject({
- value: tString,
+scheme.PageMouseWheelResult = tOptional(tObject({}));
+scheme.PageTouchscreenTapParams = tObject({
+ x: tFloat,
+ y: tFloat,
});
-scheme.ElementHandleInputValueParams = tOptional(tObject({}));
-scheme.ElementHandleInputValueResult = tObject({
- value: tString,
+scheme.PageTouchscreenTapResult = tOptional(tObject({}));
+scheme.PageClearPageErrorsParams = tOptional(tObject({}));
+scheme.PageClearPageErrorsResult = tOptional(tObject({}));
+scheme.PagePageErrorsParams = tObject({
+ filter: tOptional(tType('ConsoleMessagesFilter')),
});
-scheme.ElementHandleIsCheckedParams = tOptional(tObject({}));
-scheme.ElementHandleIsCheckedResult = tObject({
- value: tBoolean,
+scheme.PagePageErrorsResult = tObject({
+ errors: tArray(tType('SerializedError')),
});
-scheme.ElementHandleIsDisabledParams = tOptional(tObject({}));
-scheme.ElementHandleIsDisabledResult = tObject({
- value: tBoolean,
+scheme.PagePdfParams = tObject({
+ scale: tOptional(tFloat),
+ displayHeaderFooter: tOptional(tBoolean),
+ headerTemplate: tOptional(tString),
+ footerTemplate: tOptional(tString),
+ printBackground: tOptional(tBoolean),
+ landscape: tOptional(tBoolean),
+ pageRanges: tOptional(tString),
+ format: tOptional(tString),
+ width: tOptional(tString),
+ height: tOptional(tString),
+ preferCSSPageSize: tOptional(tBoolean),
+ margin: tOptional(tObject({
+ top: tOptional(tString),
+ bottom: tOptional(tString),
+ left: tOptional(tString),
+ right: tOptional(tString),
+ })),
+ tagged: tOptional(tBoolean),
+ outline: tOptional(tBoolean),
});
-scheme.ElementHandleIsEditableParams = tOptional(tObject({}));
-scheme.ElementHandleIsEditableResult = tObject({
- value: tBoolean,
+scheme.PagePdfResult = tObject({
+ pdf: tBinary,
});
-scheme.ElementHandleIsEnabledParams = tOptional(tObject({}));
-scheme.ElementHandleIsEnabledResult = tObject({
- value: tBoolean,
+scheme.PageRequestsParams = tOptional(tObject({}));
+scheme.PageRequestsResult = tObject({
+ requests: tArray(tChannel(['Request'])),
});
-scheme.ElementHandleIsHiddenParams = tOptional(tObject({}));
-scheme.ElementHandleIsHiddenResult = tObject({
- value: tBoolean,
+scheme.PageStartJSCoverageParams = tObject({
+ resetOnNavigation: tOptional(tBoolean),
+ reportAnonymousScripts: tOptional(tBoolean),
});
-scheme.ElementHandleIsVisibleParams = tOptional(tObject({}));
-scheme.ElementHandleIsVisibleResult = tObject({
- value: tBoolean,
+scheme.PageStartJSCoverageResult = tOptional(tObject({}));
+scheme.PageStopJSCoverageParams = tOptional(tObject({}));
+scheme.PageStopJSCoverageResult = tObject({
+ entries: tArray(tObject({
+ url: tString,
+ scriptId: tString,
+ source: tOptional(tString),
+ functions: tArray(tObject({
+ functionName: tString,
+ isBlockCoverage: tBoolean,
+ ranges: tArray(tObject({
+ startOffset: tInt,
+ endOffset: tInt,
+ count: tInt,
+ })),
+ })),
+ })),
});
-scheme.ElementHandleOwnerFrameParams = tOptional(tObject({}));
-scheme.ElementHandleOwnerFrameResult = tObject({
- frame: tOptional(tChannel(['Frame'])),
+scheme.PageStartCSSCoverageParams = tObject({
+ resetOnNavigation: tOptional(tBoolean),
});
-scheme.ElementHandlePressParams = tObject({
- key: tString,
- delay: tOptional(tFloat),
- timeout: tFloat,
- noWaitAfter: tOptional(tBoolean),
+scheme.PageStartCSSCoverageResult = tOptional(tObject({}));
+scheme.PageStopCSSCoverageParams = tOptional(tObject({}));
+scheme.PageStopCSSCoverageResult = tObject({
+ entries: tArray(tObject({
+ url: tString,
+ text: tOptional(tString),
+ ranges: tArray(tObject({
+ start: tInt,
+ end: tInt,
+ })),
+ })),
});
-scheme.ElementHandlePressResult = tOptional(tObject({}));
-scheme.ElementHandleQuerySelectorParams = tObject({
+scheme.PageBringToFrontParams = tOptional(tObject({}));
+scheme.PageBringToFrontResult = tOptional(tObject({}));
+scheme.PagePickLocatorParams = tOptional(tObject({}));
+scheme.PagePickLocatorResult = tObject({
selector: tString,
- strict: tOptional(tBoolean),
});
-scheme.ElementHandleQuerySelectorResult = tObject({
- element: tOptional(tChannel(['ElementHandle'])),
+scheme.PageCancelPickLocatorParams = tOptional(tObject({}));
+scheme.PageCancelPickLocatorResult = tOptional(tObject({}));
+scheme.PageHideHighlightParams = tOptional(tObject({}));
+scheme.PageHideHighlightResult = tOptional(tObject({}));
+scheme.PageScreencastShowOverlayParams = tObject({
+ html: tString,
+ duration: tOptional(tFloat),
});
-scheme.ElementHandleQuerySelectorAllParams = tObject({
- selector: tString,
+scheme.PageScreencastShowOverlayResult = tObject({
+ id: tString,
});
-scheme.ElementHandleQuerySelectorAllResult = tObject({
- elements: tArray(tChannel(['ElementHandle'])),
+scheme.PageScreencastRemoveOverlayParams = tObject({
+ id: tString,
});
-scheme.ElementHandleScreenshotParams = tObject({
- timeout: tFloat,
- type: tOptional(tEnum(['png', 'jpeg'])),
- quality: tOptional(tInt),
- omitBackground: tOptional(tBoolean),
- caret: tOptional(tEnum(['hide', 'initial'])),
- animations: tOptional(tEnum(['disabled', 'allow'])),
- scale: tOptional(tEnum(['css', 'device'])),
- mask: tOptional(tArray(tObject({
- frame: tChannel(['Frame']),
- selector: tString,
- }))),
- maskColor: tOptional(tString),
- style: tOptional(tString),
+scheme.PageScreencastRemoveOverlayResult = tOptional(tObject({}));
+scheme.PageScreencastChapterParams = tObject({
+ title: tString,
+ description: tOptional(tString),
+ duration: tOptional(tFloat),
});
-scheme.ElementHandleScreenshotResult = tObject({
- binary: tBinary,
+scheme.PageScreencastChapterResult = tOptional(tObject({}));
+scheme.PageScreencastSetOverlayVisibleParams = tObject({
+ visible: tBoolean,
});
-scheme.ElementHandleScrollIntoViewIfNeededParams = tObject({
- timeout: tFloat,
+scheme.PageScreencastSetOverlayVisibleResult = tOptional(tObject({}));
+scheme.PageScreencastShowActionsParams = tObject({
+ duration: tOptional(tFloat),
+ position: tOptional(tEnum(['top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right'])),
+ fontSize: tOptional(tInt),
});
-scheme.ElementHandleScrollIntoViewIfNeededResult = tOptional(tObject({}));
-scheme.ElementHandleSelectOptionParams = tObject({
- elements: tOptional(tArray(tChannel(['ElementHandle']))),
- options: tOptional(tArray(tObject({
- valueOrLabel: tOptional(tString),
- value: tOptional(tString),
- label: tOptional(tString),
- index: tOptional(tInt),
- }))),
- force: tOptional(tBoolean),
- timeout: tFloat,
+scheme.PageScreencastShowActionsResult = tOptional(tObject({}));
+scheme.PageScreencastHideActionsParams = tOptional(tObject({}));
+scheme.PageScreencastHideActionsResult = tOptional(tObject({}));
+scheme.PageScreencastStartParams = tObject({
+ size: tOptional(tObject({
+ width: tInt,
+ height: tInt,
+ })),
+ quality: tOptional(tInt),
+ sendFrames: tOptional(tBoolean),
+ record: tOptional(tBoolean),
});
-scheme.ElementHandleSelectOptionResult = tObject({
- values: tArray(tString),
+scheme.PageScreencastStartResult = tObject({
+ artifact: tOptional(tChannel(['Artifact'])),
});
-scheme.ElementHandleSelectTextParams = tObject({
- force: tOptional(tBoolean),
- timeout: tFloat,
+scheme.PageScreencastStopParams = tOptional(tObject({}));
+scheme.PageScreencastStopResult = tOptional(tObject({}));
+scheme.PageUpdateSubscriptionParams = tObject({
+ event: tEnum(['console', 'dialog', 'fileChooser', 'request', 'response', 'requestFinished', 'requestFailed']),
+ enabled: tBoolean,
});
-scheme.ElementHandleSelectTextResult = tOptional(tObject({}));
-scheme.ElementHandleSetInputFilesParams = tObject({
- payloads: tOptional(tArray(tObject({
- name: tString,
- mimeType: tOptional(tString),
- buffer: tBinary,
- }))),
- localDirectory: tOptional(tString),
- directoryStream: tOptional(tChannel(['WritableStream'])),
- localPaths: tOptional(tArray(tString)),
- streams: tOptional(tArray(tChannel(['WritableStream']))),
- timeout: tFloat,
+scheme.PageUpdateSubscriptionResult = tOptional(tObject({}));
+scheme.PageSetDockTileParams = tObject({
+ image: tBinary,
});
-scheme.ElementHandleSetInputFilesResult = tOptional(tObject({}));
-scheme.ElementHandleTapParams = tObject({
- force: tOptional(tBoolean),
- modifiers: tOptional(tArray(tEnum(['Alt', 'Control', 'ControlOrMeta', 'Meta', 'Shift']))),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.PageSetDockTileResult = tOptional(tObject({}));
+scheme.RootInitializer = tOptional(tObject({}));
+scheme.RootInitializeParams = tObject({
+ sdkLanguage: tType('SDKLanguage'),
});
-scheme.ElementHandleTapResult = tOptional(tObject({}));
-scheme.ElementHandleTextContentParams = tOptional(tObject({}));
-scheme.ElementHandleTextContentResult = tObject({
- value: tOptional(tString),
+scheme.RootInitializeResult = tObject({
+ playwright: tChannel(['Playwright']),
});
-scheme.ElementHandleTypeParams = tObject({
- text: tString,
- delay: tOptional(tFloat),
- timeout: tFloat,
+scheme.PlaywrightInitializer = tObject({
+ chromium: tChannel(['BrowserType']),
+ firefox: tChannel(['BrowserType']),
+ webkit: tChannel(['BrowserType']),
+ android: tChannel(['Android']),
+ utils: tOptional(tChannel(['LocalUtils'])),
+ preLaunchedBrowser: tOptional(tChannel(['Browser'])),
+ preConnectedAndroidDevice: tOptional(tChannel(['AndroidDevice'])),
+ socksSupport: tOptional(tChannel(['SocksSupport'])),
});
-scheme.ElementHandleTypeResult = tOptional(tObject({}));
-scheme.ElementHandleUncheckParams = tObject({
- force: tOptional(tBoolean),
- position: tOptional(tType('Point')),
- timeout: tFloat,
- trial: tOptional(tBoolean),
+scheme.PlaywrightNewRequestParams = tObject({
+ baseURL: tOptional(tString),
+ userAgent: tOptional(tString),
+ ignoreHTTPSErrors: tOptional(tBoolean),
+ extraHTTPHeaders: tOptional(tArray(tType('NameValue'))),
+ failOnStatusCode: tOptional(tBoolean),
+ clientCertificates: tOptional(tArray(tObject({
+ origin: tString,
+ cert: tOptional(tBinary),
+ key: tOptional(tBinary),
+ passphrase: tOptional(tString),
+ pfx: tOptional(tBinary),
+ }))),
+ maxRedirects: tOptional(tInt),
+ httpCredentials: tOptional(tObject({
+ username: tString,
+ password: tString,
+ origin: tOptional(tString),
+ send: tOptional(tEnum(['always', 'unauthorized'])),
+ })),
+ proxy: tOptional(tObject({
+ server: tString,
+ bypass: tOptional(tString),
+ username: tOptional(tString),
+ password: tOptional(tString),
+ })),
+ storageState: tOptional(tObject({
+ cookies: tOptional(tArray(tType('NetworkCookie'))),
+ origins: tOptional(tArray(tType('SetOriginStorage'))),
+ })),
+ tracesDir: tOptional(tString),
});
-scheme.ElementHandleUncheckResult = tOptional(tObject({}));
-scheme.ElementHandleWaitForElementStateParams = tObject({
- state: tEnum(['visible', 'hidden', 'stable', 'enabled', 'disabled', 'editable']),
- timeout: tFloat,
+scheme.PlaywrightNewRequestResult = tObject({
+ request: tChannel(['APIRequestContext']),
});
-scheme.ElementHandleWaitForElementStateResult = tOptional(tObject({}));
-scheme.ElementHandleWaitForSelectorParams = tObject({
+scheme.DebugControllerInitializer = tOptional(tObject({}));
+scheme.DebugControllerInspectRequestedEvent = tObject({
selector: tString,
- strict: tOptional(tBoolean),
- timeout: tFloat,
- state: tOptional(tEnum(['attached', 'detached', 'visible', 'hidden'])),
-});
-scheme.ElementHandleWaitForSelectorResult = tObject({
- element: tOptional(tChannel(['ElementHandle'])),
-});
-scheme.RequestInitializer = tObject({
- frame: tOptional(tChannel(['Frame'])),
- serviceWorker: tOptional(tChannel(['Worker'])),
- url: tString,
- resourceType: tString,
- method: tString,
- postData: tOptional(tBinary),
- headers: tArray(tType('NameValue')),
- isNavigationRequest: tBoolean,
- redirectedFrom: tOptional(tChannel(['Request'])),
-});
-scheme.RequestResponseParams = tOptional(tObject({}));
-scheme.RequestResponseResult = tObject({
- response: tOptional(tChannel(['Response'])),
-});
-scheme.RequestRawRequestHeadersParams = tOptional(tObject({}));
-scheme.RequestRawRequestHeadersResult = tObject({
- headers: tArray(tType('NameValue')),
+ locator: tString,
+ ariaSnapshot: tString,
});
-scheme.RouteInitializer = tObject({
- request: tChannel(['Request']),
+scheme.DebugControllerSetModeRequestedEvent = tObject({
+ mode: tString,
});
-scheme.RouteRedirectNavigationRequestParams = tObject({
- url: tString,
+scheme.DebugControllerStateChangedEvent = tObject({
+ pageCount: tInt,
});
-scheme.RouteRedirectNavigationRequestResult = tOptional(tObject({}));
-scheme.RouteAbortParams = tObject({
- errorCode: tOptional(tString),
+scheme.DebugControllerSourceChangedEvent = tObject({
+ text: tString,
+ header: tOptional(tString),
+ footer: tOptional(tString),
+ actions: tOptional(tArray(tString)),
});
-scheme.RouteAbortResult = tOptional(tObject({}));
-scheme.RouteContinueParams = tObject({
- url: tOptional(tString),
- method: tOptional(tString),
- headers: tOptional(tArray(tType('NameValue'))),
- postData: tOptional(tBinary),
- isFallback: tBoolean,
+scheme.DebugControllerPausedEvent = tObject({
+ paused: tBoolean,
});
-scheme.RouteContinueResult = tOptional(tObject({}));
-scheme.RouteFulfillParams = tObject({
- status: tOptional(tInt),
- headers: tOptional(tArray(tType('NameValue'))),
- body: tOptional(tString),
- isBase64: tOptional(tBoolean),
- fetchResponseUid: tOptional(tString),
+scheme.DebugControllerInitializeParams = tObject({
+ codegenId: tString,
+ sdkLanguage: tType('SDKLanguage'),
});
-scheme.RouteFulfillResult = tOptional(tObject({}));
-scheme.WebSocketRouteInitializer = tObject({
- url: tString,
- protocols: tArray(tString),
+scheme.DebugControllerInitializeResult = tOptional(tObject({}));
+scheme.DebugControllerSetReportStateChangedParams = tObject({
+ enabled: tBoolean,
});
-scheme.WebSocketRouteMessageFromPageEvent = tObject({
- message: tString,
- isBase64: tBoolean,
+scheme.DebugControllerSetReportStateChangedResult = tOptional(tObject({}));
+scheme.DebugControllerSetRecorderModeParams = tObject({
+ mode: tEnum(['inspecting', 'recording', 'none']),
+ testIdAttributeName: tOptional(tString),
+ generateAutoExpect: tOptional(tBoolean),
});
-scheme.WebSocketRouteMessageFromServerEvent = tObject({
- message: tString,
- isBase64: tBoolean,
+scheme.DebugControllerSetRecorderModeResult = tOptional(tObject({}));
+scheme.DebugControllerHighlightParams = tObject({
+ selector: tOptional(tString),
+ ariaTemplate: tOptional(tString),
});
-scheme.WebSocketRouteClosePageEvent = tObject({
- code: tOptional(tInt),
- reason: tOptional(tString),
- wasClean: tBoolean,
+scheme.DebugControllerHighlightResult = tOptional(tObject({}));
+scheme.DebugControllerHideHighlightParams = tOptional(tObject({}));
+scheme.DebugControllerHideHighlightResult = tOptional(tObject({}));
+scheme.DebugControllerResumeParams = tOptional(tObject({}));
+scheme.DebugControllerResumeResult = tOptional(tObject({}));
+scheme.DebugControllerKillParams = tOptional(tObject({}));
+scheme.DebugControllerKillResult = tOptional(tObject({}));
+scheme.SocksSupportInitializer = tOptional(tObject({}));
+scheme.SocksSupportSocksRequestedEvent = tObject({
+ uid: tString,
+ host: tString,
+ port: tInt,
});
-scheme.WebSocketRouteCloseServerEvent = tObject({
- code: tOptional(tInt),
- reason: tOptional(tString),
- wasClean: tBoolean,
+scheme.SocksSupportSocksDataEvent = tObject({
+ uid: tString,
+ data: tBinary,
});
-scheme.WebSocketRouteConnectParams = tOptional(tObject({}));
-scheme.WebSocketRouteConnectResult = tOptional(tObject({}));
-scheme.WebSocketRouteEnsureOpenedParams = tOptional(tObject({}));
-scheme.WebSocketRouteEnsureOpenedResult = tOptional(tObject({}));
-scheme.WebSocketRouteSendToPageParams = tObject({
- message: tString,
- isBase64: tBoolean,
+scheme.SocksSupportSocksClosedEvent = tObject({
+ uid: tString,
});
-scheme.WebSocketRouteSendToPageResult = tOptional(tObject({}));
-scheme.WebSocketRouteSendToServerParams = tObject({
- message: tString,
- isBase64: tBoolean,
+scheme.SocksSupportSocksConnectedParams = tObject({
+ uid: tString,
+ host: tString,
+ port: tInt,
});
-scheme.WebSocketRouteSendToServerResult = tOptional(tObject({}));
-scheme.WebSocketRouteClosePageParams = tObject({
- code: tOptional(tInt),
- reason: tOptional(tString),
- wasClean: tBoolean,
+scheme.SocksSupportSocksConnectedResult = tOptional(tObject({}));
+scheme.SocksSupportSocksFailedParams = tObject({
+ uid: tString,
+ errorCode: tString,
});
-scheme.WebSocketRouteClosePageResult = tOptional(tObject({}));
-scheme.WebSocketRouteCloseServerParams = tObject({
- code: tOptional(tInt),
- reason: tOptional(tString),
- wasClean: tBoolean,
+scheme.SocksSupportSocksFailedResult = tOptional(tObject({}));
+scheme.SocksSupportSocksDataParams = tObject({
+ uid: tString,
+ data: tBinary,
});
-scheme.WebSocketRouteCloseServerResult = tOptional(tObject({}));
-scheme.ResourceTiming = tObject({
- startTime: tFloat,
- domainLookupStart: tFloat,
- domainLookupEnd: tFloat,
- connectStart: tFloat,
- secureConnectionStart: tFloat,
- connectEnd: tFloat,
- requestStart: tFloat,
- responseStart: tFloat,
+scheme.SocksSupportSocksDataResult = tOptional(tObject({}));
+scheme.SocksSupportSocksErrorParams = tObject({
+ uid: tString,
+ error: tString,
});
-scheme.ResponseInitializer = tObject({
- request: tChannel(['Request']),
- url: tString,
- status: tInt,
- statusText: tString,
- headers: tArray(tType('NameValue')),
- timing: tType('ResourceTiming'),
- fromServiceWorker: tBoolean,
+scheme.SocksSupportSocksErrorResult = tOptional(tObject({}));
+scheme.SocksSupportSocksEndParams = tObject({
+ uid: tString,
});
-scheme.ResponseBodyParams = tOptional(tObject({}));
-scheme.ResponseBodyResult = tObject({
- binary: tBinary,
+scheme.SocksSupportSocksEndResult = tOptional(tObject({}));
+scheme.JsonPipeInitializer = tOptional(tObject({}));
+scheme.JsonPipeMessageEvent = tObject({
+ message: tAny,
});
-scheme.ResponseSecurityDetailsParams = tOptional(tObject({}));
-scheme.ResponseSecurityDetailsResult = tObject({
- value: tOptional(tType('SecurityDetails')),
+scheme.JsonPipeClosedEvent = tObject({
+ reason: tOptional(tString),
});
-scheme.ResponseServerAddrParams = tOptional(tObject({}));
-scheme.ResponseServerAddrResult = tObject({
- value: tOptional(tType('RemoteAddr')),
+scheme.JsonPipeSendParams = tObject({
+ message: tAny,
});
-scheme.ResponseRawResponseHeadersParams = tOptional(tObject({}));
-scheme.ResponseRawResponseHeadersResult = tObject({
- headers: tArray(tType('NameValue')),
+scheme.JsonPipeSendResult = tOptional(tObject({}));
+scheme.JsonPipeCloseParams = tOptional(tObject({}));
+scheme.JsonPipeCloseResult = tOptional(tObject({}));
+scheme.ExpectedTextValue = tObject({
+ string: tOptional(tString),
+ regexSource: tOptional(tString),
+ regexFlags: tOptional(tString),
+ matchSubstring: tOptional(tBoolean),
+ ignoreCase: tOptional(tBoolean),
+ normalizeWhiteSpace: tOptional(tBoolean),
});
-scheme.ResponseHttpVersionParams = tOptional(tObject({}));
-scheme.ResponseHttpVersionResult = tObject({
- value: tString,
+scheme.SelectorEngine = tObject({
+ name: tString,
+ source: tString,
+ contentScript: tOptional(tBoolean),
});
-scheme.ResponseSizesParams = tOptional(tObject({}));
-scheme.ResponseSizesResult = tObject({
- sizes: tType('RequestSizes'),
+scheme.FormField = tObject({
+ name: tString,
+ value: tOptional(tString),
+ file: tOptional(tObject({
+ name: tString,
+ mimeType: tOptional(tString),
+ buffer: tBinary,
+ })),
});
-scheme.SecurityDetails = tObject({
- issuer: tOptional(tString),
- protocol: tOptional(tString),
- subjectName: tOptional(tString),
- validFrom: tOptional(tFloat),
- validTo: tOptional(tFloat),
+scheme.LifecycleEvent = tEnum(['load', 'domcontentloaded', 'networkidle', 'commit']);
+scheme.ConsoleMessagesFilter = tEnum(['all', 'since-navigation']);
+scheme.RecorderSource = tObject({
+ isRecorded: tBoolean,
+ id: tString,
+ label: tString,
+ text: tString,
+ language: tString,
+ highlight: tArray(tObject({
+ line: tInt,
+ type: tString,
+ })),
+ revealLine: tOptional(tInt),
+ group: tOptional(tString),
});
-scheme.RequestSizes = tObject({
- requestBodySize: tInt,
- requestHeadersSize: tInt,
- responseBodySize: tInt,
- responseHeadersSize: tInt,
+scheme.IndexedDBDatabase = tObject({
+ name: tString,
+ version: tInt,
+ stores: tArray(tObject({
+ name: tString,
+ autoIncrement: tBoolean,
+ keyPath: tOptional(tString),
+ keyPathArray: tOptional(tArray(tString)),
+ records: tArray(tObject({
+ key: tOptional(tAny),
+ keyEncoded: tOptional(tAny),
+ value: tOptional(tAny),
+ valueEncoded: tOptional(tAny),
+ })),
+ indexes: tArray(tObject({
+ name: tString,
+ keyPath: tOptional(tString),
+ keyPathArray: tOptional(tArray(tString)),
+ multiEntry: tBoolean,
+ unique: tBoolean,
+ })),
+ })),
});
-scheme.RemoteAddr = tObject({
- ipAddress: tString,
- port: tInt,
+scheme.SetOriginStorage = tObject({
+ origin: tString,
+ localStorage: tArray(tType('NameValue')),
+ indexedDB: tOptional(tArray(tType('IndexedDBDatabase'))),
});
-scheme.WebSocketInitializer = tObject({
- url: tString,
+scheme.OriginStorage = tObject({
+ origin: tString,
+ localStorage: tArray(tType('NameValue')),
+ indexedDB: tOptional(tArray(tType('IndexedDBDatabase'))),
});
-scheme.WebSocketOpenEvent = tOptional(tObject({}));
-scheme.WebSocketFrameSentEvent = tObject({
- opcode: tInt,
- data: tString,
+scheme.RecordHarOptions = tObject({
+ content: tOptional(tEnum(['embed', 'attach', 'omit'])),
+ mode: tOptional(tEnum(['full', 'minimal'])),
+ urlGlob: tOptional(tString),
+ urlRegexSource: tOptional(tString),
+ urlRegexFlags: tOptional(tString),
+ harPath: tOptional(tString),
+ resourcesDir: tOptional(tString),
});
-scheme.WebSocketFrameReceivedEvent = tObject({
- opcode: tInt,
- data: tString,
+scheme.CDPSessionInitializer = tOptional(tObject({}));
+scheme.CDPSessionEventEvent = tObject({
+ method: tString,
+ params: tOptional(tAny),
});
-scheme.WebSocketSocketErrorEvent = tObject({
- error: tString,
+scheme.CDPSessionCloseEvent = tOptional(tObject({}));
+scheme.CDPSessionSendParams = tObject({
+ method: tString,
+ params: tOptional(tAny),
});
-scheme.WebSocketCloseEvent = tOptional(tObject({}));
+scheme.CDPSessionSendResult = tObject({
+ result: tAny,
+});
+scheme.CDPSessionDetachParams = tOptional(tObject({}));
+scheme.CDPSessionDetachResult = tOptional(tObject({}));
scheme.BindingCallInitializer = tObject({
frame: tChannel(['Frame']),
name: tString,
@@ -2607,407 +2849,165 @@ scheme.DialogAcceptParams = tObject({
scheme.DialogAcceptResult = tOptional(tObject({}));
scheme.DialogDismissParams = tOptional(tObject({}));
scheme.DialogDismissResult = tOptional(tObject({}));
-scheme.TracingInitializer = tOptional(tObject({}));
-scheme.TracingTracingStartParams = tObject({
- name: tOptional(tString),
- snapshots: tOptional(tBoolean),
- screenshots: tOptional(tBoolean),
- live: tOptional(tBoolean),
-});
-scheme.TracingTracingStartResult = tOptional(tObject({}));
-scheme.TracingTracingStartChunkParams = tObject({
- name: tOptional(tString),
- title: tOptional(tString),
-});
-scheme.TracingTracingStartChunkResult = tObject({
- traceName: tString,
-});
-scheme.TracingTracingGroupParams = tObject({
- name: tString,
- location: tOptional(tObject({
- file: tString,
- line: tOptional(tInt),
- column: tOptional(tInt),
+scheme.SerializedValue = tObject({
+ n: tOptional(tFloat),
+ b: tOptional(tBoolean),
+ s: tOptional(tString),
+ v: tOptional(tEnum(['null', 'undefined', 'NaN', 'Infinity', '-Infinity', '-0'])),
+ d: tOptional(tString),
+ u: tOptional(tString),
+ bi: tOptional(tString),
+ ta: tOptional(tObject({
+ b: tBinary,
+ k: tEnum(['i8', 'ui8', 'ui8c', 'i16', 'ui16', 'i32', 'ui32', 'f32', 'f64', 'bi64', 'bui64']),
})),
+ e: tOptional(tObject({
+ m: tString,
+ n: tString,
+ s: tString,
+ })),
+ r: tOptional(tObject({
+ p: tString,
+ f: tString,
+ })),
+ a: tOptional(tArray(tType('SerializedValue'))),
+ o: tOptional(tArray(tObject({
+ k: tString,
+ v: tType('SerializedValue'),
+ }))),
+ h: tOptional(tInt),
+ id: tOptional(tInt),
+ ref: tOptional(tInt),
});
-scheme.TracingTracingGroupResult = tOptional(tObject({}));
-scheme.TracingTracingGroupEndParams = tOptional(tObject({}));
-scheme.TracingTracingGroupEndResult = tOptional(tObject({}));
-scheme.TracingTracingStopChunkParams = tObject({
- mode: tEnum(['archive', 'discard', 'entries']),
-});
-scheme.TracingTracingStopChunkResult = tObject({
- artifact: tOptional(tChannel(['Artifact'])),
- entries: tOptional(tArray(tType('NameValue'))),
-});
-scheme.TracingTracingStopParams = tOptional(tObject({}));
-scheme.TracingTracingStopResult = tOptional(tObject({}));
-scheme.TracingHarStartParams = tObject({
- page: tOptional(tChannel(['Page'])),
- options: tType('RecordHarOptions'),
-});
-scheme.TracingHarStartResult = tObject({
- harId: tString,
-});
-scheme.TracingHarExportParams = tObject({
- harId: tOptional(tString),
- mode: tEnum(['archive', 'entries']),
-});
-scheme.TracingHarExportResult = tObject({
- artifact: tOptional(tChannel(['Artifact'])),
- entries: tOptional(tArray(tType('NameValue'))),
-});
-scheme.ArtifactInitializer = tObject({
- absolutePath: tString,
-});
-scheme.ArtifactPathAfterFinishedParams = tOptional(tObject({}));
-scheme.ArtifactPathAfterFinishedResult = tObject({
- value: tString,
-});
-scheme.ArtifactSaveAsParams = tObject({
- path: tString,
-});
-scheme.ArtifactSaveAsResult = tOptional(tObject({}));
-scheme.ArtifactSaveAsStreamParams = tOptional(tObject({}));
-scheme.ArtifactSaveAsStreamResult = tObject({
- stream: tChannel(['Stream']),
-});
-scheme.ArtifactFailureParams = tOptional(tObject({}));
-scheme.ArtifactFailureResult = tObject({
- error: tOptional(tString),
-});
-scheme.ArtifactStreamParams = tOptional(tObject({}));
-scheme.ArtifactStreamResult = tObject({
- stream: tChannel(['Stream']),
-});
-scheme.ArtifactCancelParams = tOptional(tObject({}));
-scheme.ArtifactCancelResult = tOptional(tObject({}));
-scheme.ArtifactDeleteParams = tOptional(tObject({}));
-scheme.ArtifactDeleteResult = tOptional(tObject({}));
-scheme.StreamInitializer = tOptional(tObject({}));
-scheme.StreamReadParams = tObject({
- size: tOptional(tInt),
-});
-scheme.StreamReadResult = tObject({
- binary: tBinary,
-});
-scheme.StreamCloseParams = tOptional(tObject({}));
-scheme.StreamCloseResult = tOptional(tObject({}));
-scheme.WritableStreamInitializer = tOptional(tObject({}));
-scheme.WritableStreamWriteParams = tObject({
- binary: tBinary,
-});
-scheme.WritableStreamWriteResult = tOptional(tObject({}));
-scheme.WritableStreamCloseParams = tOptional(tObject({}));
-scheme.WritableStreamCloseResult = tOptional(tObject({}));
-scheme.CDPSessionInitializer = tOptional(tObject({}));
-scheme.CDPSessionEventEvent = tObject({
- method: tString,
- params: tOptional(tAny),
-});
-scheme.CDPSessionCloseEvent = tOptional(tObject({}));
-scheme.CDPSessionSendParams = tObject({
- method: tString,
- params: tOptional(tAny),
-});
-scheme.CDPSessionSendResult = tObject({
- result: tAny,
-});
-scheme.CDPSessionDetachParams = tOptional(tObject({}));
-scheme.CDPSessionDetachResult = tOptional(tObject({}));
-scheme.AndroidInitializer = tOptional(tObject({}));
-scheme.AndroidDevicesParams = tObject({
- host: tOptional(tString),
- port: tOptional(tInt),
- omitDriverInstall: tOptional(tBoolean),
-});
-scheme.AndroidDevicesResult = tObject({
- devices: tArray(tChannel(['AndroidDevice'])),
-});
-scheme.AndroidSocketInitializer = tOptional(tObject({}));
-scheme.AndroidSocketDataEvent = tObject({
- data: tBinary,
-});
-scheme.AndroidSocketCloseEvent = tOptional(tObject({}));
-scheme.AndroidSocketWriteParams = tObject({
- data: tBinary,
-});
-scheme.AndroidSocketWriteResult = tOptional(tObject({}));
-scheme.AndroidSocketCloseParams = tOptional(tObject({}));
-scheme.AndroidSocketCloseResult = tOptional(tObject({}));
-scheme.AndroidDeviceInitializer = tObject({
- model: tString,
- serial: tString,
-});
-scheme.AndroidDeviceCloseEvent = tOptional(tObject({}));
-scheme.AndroidDeviceWebViewAddedEvent = tObject({
- webView: tType('AndroidWebView'),
-});
-scheme.AndroidDeviceWebViewRemovedEvent = tObject({
- socketName: tString,
-});
-scheme.AndroidDeviceWaitParams = tObject({
- androidSelector: tType('AndroidSelector'),
- state: tOptional(tEnum(['gone'])),
- timeout: tFloat,
-});
-scheme.AndroidDeviceWaitResult = tOptional(tObject({}));
-scheme.AndroidDeviceFillParams = tObject({
- androidSelector: tType('AndroidSelector'),
- text: tString,
- timeout: tFloat,
-});
-scheme.AndroidDeviceFillResult = tOptional(tObject({}));
-scheme.AndroidDeviceTapParams = tObject({
- androidSelector: tType('AndroidSelector'),
- duration: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDeviceTapResult = tOptional(tObject({}));
-scheme.AndroidDeviceDragParams = tObject({
- androidSelector: tType('AndroidSelector'),
- dest: tType('Point'),
- speed: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDeviceDragResult = tOptional(tObject({}));
-scheme.AndroidDeviceFlingParams = tObject({
- androidSelector: tType('AndroidSelector'),
- direction: tEnum(['up', 'down', 'left', 'right']),
- speed: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDeviceFlingResult = tOptional(tObject({}));
-scheme.AndroidDeviceLongTapParams = tObject({
- androidSelector: tType('AndroidSelector'),
- timeout: tFloat,
-});
-scheme.AndroidDeviceLongTapResult = tOptional(tObject({}));
-scheme.AndroidDevicePinchCloseParams = tObject({
- androidSelector: tType('AndroidSelector'),
- percent: tFloat,
- speed: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDevicePinchCloseResult = tOptional(tObject({}));
-scheme.AndroidDevicePinchOpenParams = tObject({
- androidSelector: tType('AndroidSelector'),
- percent: tFloat,
- speed: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDevicePinchOpenResult = tOptional(tObject({}));
-scheme.AndroidDeviceScrollParams = tObject({
- androidSelector: tType('AndroidSelector'),
- direction: tEnum(['up', 'down', 'left', 'right']),
- percent: tFloat,
- speed: tOptional(tFloat),
- timeout: tFloat,
-});
-scheme.AndroidDeviceScrollResult = tOptional(tObject({}));
-scheme.AndroidDeviceSwipeParams = tObject({
- androidSelector: tType('AndroidSelector'),
- direction: tEnum(['up', 'down', 'left', 'right']),
- percent: tFloat,
- speed: tOptional(tFloat),
- timeout: tFloat,
+scheme.SerializedArgument = tObject({
+ value: tType('SerializedValue'),
+ handles: tArray(tChannel('*')),
});
-scheme.AndroidDeviceSwipeResult = tOptional(tObject({}));
-scheme.AndroidDeviceInfoParams = tObject({
- androidSelector: tType('AndroidSelector'),
+scheme.SerializedError = tObject({
+ error: tOptional(tObject({
+ message: tString,
+ name: tString,
+ stack: tOptional(tString),
+ })),
+ value: tOptional(tType('SerializedValue')),
});
-scheme.AndroidDeviceInfoResult = tObject({
- info: tType('AndroidElementInfo'),
+scheme.StackFrame = tObject({
+ file: tString,
+ line: tInt,
+ column: tInt,
+ function: tOptional(tString),
});
-scheme.AndroidDeviceScreenshotParams = tOptional(tObject({}));
-scheme.AndroidDeviceScreenshotResult = tObject({
- binary: tBinary,
+scheme.Point = tObject({
+ x: tFloat,
+ y: tFloat,
});
-scheme.AndroidDeviceInputTypeParams = tObject({
- text: tString,
+scheme.Rect = tObject({
+ x: tFloat,
+ y: tFloat,
+ width: tFloat,
+ height: tFloat,
});
-scheme.AndroidDeviceInputTypeResult = tOptional(tObject({}));
-scheme.AndroidDeviceInputPressParams = tObject({
- key: tString,
+scheme.URLPattern = tObject({
+ hash: tString,
+ hostname: tString,
+ password: tString,
+ pathname: tString,
+ port: tString,
+ protocol: tString,
+ search: tString,
+ username: tString,
});
-scheme.AndroidDeviceInputPressResult = tOptional(tObject({}));
-scheme.AndroidDeviceInputTapParams = tObject({
- point: tType('Point'),
+scheme.NameValue = tObject({
+ name: tString,
+ value: tString,
});
-scheme.AndroidDeviceInputTapResult = tOptional(tObject({}));
-scheme.AndroidDeviceInputSwipeParams = tObject({
- segments: tArray(tType('Point')),
- steps: tInt,
+scheme.TracingInitializer = tOptional(tObject({}));
+scheme.TracingTracingStartParams = tObject({
+ name: tOptional(tString),
+ snapshots: tOptional(tBoolean),
+ screenshots: tOptional(tBoolean),
+ live: tOptional(tBoolean),
});
-scheme.AndroidDeviceInputSwipeResult = tOptional(tObject({}));
-scheme.AndroidDeviceInputDragParams = tObject({
- from: tType('Point'),
- to: tType('Point'),
- steps: tInt,
+scheme.TracingTracingStartResult = tOptional(tObject({}));
+scheme.TracingTracingStartChunkParams = tObject({
+ name: tOptional(tString),
+ title: tOptional(tString),
});
-scheme.AndroidDeviceInputDragResult = tOptional(tObject({}));
-scheme.AndroidDeviceLaunchBrowserParams = tObject({
- noDefaultViewport: tOptional(tBoolean),
- viewport: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- screen: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- ignoreHTTPSErrors: tOptional(tBoolean),
- clientCertificates: tOptional(tArray(tObject({
- origin: tString,
- cert: tOptional(tBinary),
- key: tOptional(tBinary),
- passphrase: tOptional(tString),
- pfx: tOptional(tBinary),
- }))),
- javaScriptEnabled: tOptional(tBoolean),
- bypassCSP: tOptional(tBoolean),
- userAgent: tOptional(tString),
- locale: tOptional(tString),
- timezoneId: tOptional(tString),
- geolocation: tOptional(tObject({
- longitude: tFloat,
- latitude: tFloat,
- accuracy: tOptional(tFloat),
- })),
- permissions: tOptional(tArray(tString)),
- extraHTTPHeaders: tOptional(tArray(tType('NameValue'))),
- offline: tOptional(tBoolean),
- httpCredentials: tOptional(tObject({
- username: tString,
- password: tString,
- origin: tOptional(tString),
- send: tOptional(tEnum(['always', 'unauthorized'])),
- })),
- deviceScaleFactor: tOptional(tFloat),
- isMobile: tOptional(tBoolean),
- hasTouch: tOptional(tBoolean),
- colorScheme: tOptional(tEnum(['dark', 'light', 'no-preference', 'no-override'])),
- reducedMotion: tOptional(tEnum(['reduce', 'no-preference', 'no-override'])),
- forcedColors: tOptional(tEnum(['active', 'none', 'no-override'])),
- acceptDownloads: tOptional(tEnum(['accept', 'deny', 'internal-browser-default'])),
- contrast: tOptional(tEnum(['no-preference', 'more', 'no-override'])),
- baseURL: tOptional(tString),
- recordVideo: tOptional(tObject({
- dir: tOptional(tString),
- size: tOptional(tObject({
- width: tInt,
- height: tInt,
- })),
- showActions: tOptional(tObject({
- duration: tOptional(tFloat),
- position: tOptional(tEnum(['top-left', 'top', 'top-right', 'bottom-left', 'bottom', 'bottom-right'])),
- fontSize: tOptional(tInt),
- })),
- })),
- strictSelectors: tOptional(tBoolean),
- serviceWorkers: tOptional(tEnum(['allow', 'block'])),
- selectorEngines: tOptional(tArray(tType('SelectorEngine'))),
- testIdAttributeName: tOptional(tString),
- pkg: tOptional(tString),
- args: tOptional(tArray(tString)),
- proxy: tOptional(tObject({
- server: tString,
- bypass: tOptional(tString),
- username: tOptional(tString),
- password: tOptional(tString),
- })),
+scheme.TracingTracingStartChunkResult = tObject({
+ traceName: tString,
});
-scheme.AndroidDeviceLaunchBrowserResult = tObject({
- context: tChannel(['BrowserContext']),
+scheme.TracingTracingGroupParams = tObject({
+ name: tString,
+ location: tOptional(tObject({
+ file: tString,
+ line: tOptional(tInt),
+ column: tOptional(tInt),
+ })),
});
-scheme.AndroidDeviceOpenParams = tObject({
- command: tString,
+scheme.TracingTracingGroupResult = tOptional(tObject({}));
+scheme.TracingTracingGroupEndParams = tOptional(tObject({}));
+scheme.TracingTracingGroupEndResult = tOptional(tObject({}));
+scheme.TracingTracingStopChunkParams = tObject({
+ mode: tEnum(['archive', 'discard', 'entries']),
});
-scheme.AndroidDeviceOpenResult = tObject({
- socket: tChannel(['AndroidSocket']),
+scheme.TracingTracingStopChunkResult = tObject({
+ artifact: tOptional(tChannel(['Artifact'])),
+ entries: tOptional(tArray(tType('NameValue'))),
});
-scheme.AndroidDeviceShellParams = tObject({
- command: tString,
+scheme.TracingTracingStopParams = tOptional(tObject({}));
+scheme.TracingTracingStopResult = tOptional(tObject({}));
+scheme.TracingHarStartParams = tObject({
+ page: tOptional(tChannel(['Page'])),
+ options: tType('RecordHarOptions'),
});
-scheme.AndroidDeviceShellResult = tObject({
- result: tBinary,
+scheme.TracingHarStartResult = tObject({
+ harId: tString,
});
-scheme.AndroidDeviceInstallApkParams = tObject({
- file: tBinary,
- args: tOptional(tArray(tString)),
+scheme.TracingHarExportParams = tObject({
+ harId: tOptional(tString),
+ mode: tEnum(['archive', 'entries']),
});
-scheme.AndroidDeviceInstallApkResult = tOptional(tObject({}));
-scheme.AndroidDevicePushParams = tObject({
- file: tBinary,
- path: tString,
- mode: tOptional(tInt),
+scheme.TracingHarExportResult = tObject({
+ artifact: tOptional(tChannel(['Artifact'])),
+ entries: tOptional(tArray(tType('NameValue'))),
});
-scheme.AndroidDevicePushResult = tOptional(tObject({}));
-scheme.AndroidDeviceConnectToWebViewParams = tObject({
- socketName: tString,
+scheme.WorkerInitializer = tObject({
+ url: tString,
});
-scheme.AndroidDeviceConnectToWebViewResult = tObject({
- context: tChannel(['BrowserContext']),
+scheme.WorkerConsoleEvent = tObject({
+ type: tString,
+ text: tString,
+ args: tArray(tChannel(['ElementHandle', 'JSHandle'])),
+ location: tObject({
+ url: tString,
+ lineNumber: tInt,
+ columnNumber: tInt,
+ }),
+ timestamp: tFloat,
});
-scheme.AndroidDeviceCloseParams = tOptional(tObject({}));
-scheme.AndroidDeviceCloseResult = tOptional(tObject({}));
-scheme.AndroidWebView = tObject({
- pid: tInt,
- pkg: tString,
- socketName: tString,
+scheme.WorkerCloseEvent = tOptional(tObject({}));
+scheme.WorkerDisconnectParams = tObject({
+ reason: tOptional(tString),
});
-scheme.AndroidSelector = tObject({
- checkable: tOptional(tBoolean),
- checked: tOptional(tBoolean),
- clazz: tOptional(tString),
- clickable: tOptional(tBoolean),
- depth: tOptional(tInt),
- desc: tOptional(tString),
- enabled: tOptional(tBoolean),
- focusable: tOptional(tBoolean),
- focused: tOptional(tBoolean),
- hasChild: tOptional(tObject({
- androidSelector: tType('AndroidSelector'),
- })),
- hasDescendant: tOptional(tObject({
- androidSelector: tType('AndroidSelector'),
- maxDepth: tOptional(tInt),
- })),
- longClickable: tOptional(tBoolean),
- pkg: tOptional(tString),
- res: tOptional(tString),
- scrollable: tOptional(tBoolean),
- selected: tOptional(tBoolean),
- text: tOptional(tString),
+scheme.WorkerDisconnectResult = tOptional(tObject({}));
+scheme.WorkerEvaluateExpressionParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.AndroidElementInfo = tObject({
- children: tOptional(tArray(tType('AndroidElementInfo'))),
- clazz: tString,
- desc: tString,
- res: tString,
- pkg: tString,
- text: tString,
- bounds: tType('Rect'),
- checkable: tBoolean,
- checked: tBoolean,
- clickable: tBoolean,
- enabled: tBoolean,
- focusable: tBoolean,
- focused: tBoolean,
- longClickable: tBoolean,
- scrollable: tBoolean,
- selected: tBoolean,
+scheme.WorkerEvaluateExpressionResult = tObject({
+ value: tType('SerializedValue'),
});
-scheme.JsonPipeInitializer = tOptional(tObject({}));
-scheme.JsonPipeMessageEvent = tObject({
- message: tAny,
+scheme.WorkerEvaluateExpressionHandleParams = tObject({
+ expression: tString,
+ isFunction: tOptional(tBoolean),
+ arg: tType('SerializedArgument'),
});
-scheme.JsonPipeClosedEvent = tObject({
- reason: tOptional(tString),
+scheme.WorkerEvaluateExpressionHandleResult = tObject({
+ handle: tChannel(['ElementHandle', 'JSHandle']),
});
-scheme.JsonPipeSendParams = tObject({
- message: tAny,
+scheme.WorkerUpdateSubscriptionParams = tObject({
+ event: tEnum(['console']),
+ enabled: tBoolean,
});
-scheme.JsonPipeSendResult = tOptional(tObject({}));
-scheme.JsonPipeCloseParams = tOptional(tObject({}));
-scheme.JsonPipeCloseResult = tOptional(tObject({}));
+scheme.WorkerUpdateSubscriptionResult = tOptional(tObject({}));
diff --git a/packages/protocol/spec/android.yml b/packages/protocol/spec/android.yml
new file mode 100644
index 0000000000..9846f184b6
--- /dev/null
+++ b/packages/protocol/spec/android.yml
@@ -0,0 +1,324 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Android:
+ type: interface
+
+ commands:
+
+ devices:
+ internal: true
+ parameters:
+ host: string?
+ port: int?
+ omitDriverInstall: boolean?
+ returns:
+ devices:
+ type: array
+ items: AndroidDevice
+
+AndroidSocket:
+ type: interface
+
+ commands:
+ write:
+ internal: true
+ parameters:
+ data: binary
+
+ close:
+ internal: true
+
+ events:
+ data:
+ parameters:
+ data: binary
+ close:
+
+AndroidDevice:
+ type: interface
+
+ extends: EventTarget
+
+ initializer:
+ model: string
+ serial: string
+
+ commands:
+ wait:
+ title: Wait
+ parameters:
+ androidSelector: AndroidSelector
+ state:
+ type: enum?
+ literals:
+ - gone
+ timeout: float
+
+ fill:
+ title: Fill "{text}"
+ parameters:
+ androidSelector: AndroidSelector
+ text: string
+ timeout: float
+
+ tap:
+ title: Tap
+ parameters:
+ androidSelector: AndroidSelector
+ duration: float?
+ timeout: float
+
+ drag:
+ title: Drag
+ parameters:
+ androidSelector: AndroidSelector
+ dest: Point
+ speed: float?
+ timeout: float
+
+ fling:
+ title: Fling
+ parameters:
+ androidSelector: AndroidSelector
+ direction:
+ type: enum
+ literals:
+ - up
+ - down
+ - left
+ - right
+ speed: float?
+ timeout: float
+
+ longTap:
+ title: Long tap
+ parameters:
+ androidSelector: AndroidSelector
+ timeout: float
+
+ pinchClose:
+ title: Pinch close
+ parameters:
+ androidSelector: AndroidSelector
+ percent: float
+ speed: float?
+ timeout: float
+
+ pinchOpen:
+ title: Pinch open
+ parameters:
+ androidSelector: AndroidSelector
+ percent: float
+ speed: float?
+ timeout: float
+
+ scroll:
+ title: Scroll
+ parameters:
+ androidSelector: AndroidSelector
+ direction:
+ type: enum
+ literals:
+ - up
+ - down
+ - left
+ - right
+ percent: float
+ speed: float?
+ timeout: float
+
+ swipe:
+ title: Swipe
+ parameters:
+ androidSelector: AndroidSelector
+ direction:
+ type: enum
+ literals:
+ - up
+ - down
+ - left
+ - right
+ percent: float
+ speed: float?
+ timeout: float
+
+ info:
+ internal: true
+ parameters:
+ androidSelector: AndroidSelector
+ returns:
+ info: AndroidElementInfo
+
+ screenshot:
+ title: Screenshot
+ returns:
+ binary: binary
+
+ inputType:
+ title: Type
+ parameters:
+ text: string
+
+ inputPress:
+ title: Press
+ parameters:
+ key: string
+
+ inputTap:
+ title: Tap
+ parameters:
+ point: Point
+
+ inputSwipe:
+ title: Swipe
+ parameters:
+ segments:
+ type: array
+ items: Point
+ steps: int
+
+ inputDrag:
+ title: Drag
+ parameters:
+ from: Point
+ to: Point
+ steps: int
+
+ launchBrowser:
+ title: Launch browser
+ parameters:
+ $mixin: ContextOptions
+ pkg: string?
+ args:
+ type: array?
+ items: string
+ proxy:
+ type: object?
+ properties:
+ server: string
+ bypass: string?
+ username: string?
+ password: string?
+
+ returns:
+ context: BrowserContext
+
+ open:
+ title: Open app
+ parameters:
+ command: string
+ returns:
+ socket: AndroidSocket
+
+ shell:
+ title: Execute shell command
+ group: configuration
+ parameters:
+ command: string
+ returns:
+ result: binary
+
+ installApk:
+ title: Install apk
+ parameters:
+ file: binary
+ args:
+ type: array?
+ items: string
+
+ push:
+ title: Push
+ parameters:
+ file: binary
+ path: string
+ mode: int?
+
+ connectToWebView:
+ title: Connect to Web View
+ parameters:
+ socketName: string
+ returns:
+ context: BrowserContext
+
+ close:
+ internal: true
+
+ events:
+ close:
+
+ webViewAdded:
+ parameters:
+ webView: AndroidWebView
+
+ webViewRemoved:
+ parameters:
+ socketName: string
+
+AndroidWebView:
+ type: object
+ properties:
+ pid: int
+ pkg: string
+ socketName: string
+
+AndroidSelector:
+ type: object
+ properties:
+ checkable: boolean?
+ checked: boolean?
+ clazz: string?
+ clickable: boolean?
+ depth: int?
+ desc: string?
+ enabled: boolean?
+ focusable: boolean?
+ focused: boolean?
+ hasChild:
+ type: object?
+ properties:
+ androidSelector: AndroidSelector
+ hasDescendant:
+ type: object?
+ properties:
+ androidSelector: AndroidSelector
+ maxDepth: int?
+ longClickable: boolean?
+ pkg: string?
+ res: string?
+ scrollable: boolean?
+ selected: boolean?
+ text: string?
+
+AndroidElementInfo:
+ type: object
+ properties:
+ children:
+ type: array?
+ items: AndroidElementInfo
+ clazz: string
+ desc: string
+ res: string
+ pkg: string
+ text: string
+ bounds: Rect
+ checkable: boolean
+ checked: boolean
+ clickable: boolean
+ enabled: boolean
+ focusable: boolean
+ focused: boolean
+ longClickable: boolean
+ scrollable: boolean
+ selected: boolean
diff --git a/packages/protocol/spec/api.yml b/packages/protocol/spec/api.yml
new file mode 100644
index 0000000000..2f3c24dd1e
--- /dev/null
+++ b/packages/protocol/spec/api.yml
@@ -0,0 +1,100 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+APIRequestContext:
+ type: interface
+
+ initializer:
+ tracing: Tracing
+
+ commands:
+
+ fetch:
+ title: '{method} "{url}"'
+ parameters:
+ url: string
+ encodedParams: string?
+ params:
+ type: array?
+ items: NameValue
+ method: string?
+ headers:
+ type: array?
+ items: NameValue
+ postData: binary?
+ jsonData: string?
+ formData:
+ type: array?
+ items: NameValue
+ multipartData:
+ type: array?
+ items: FormField
+ timeout: float
+ failOnStatusCode: boolean?
+ ignoreHTTPSErrors: boolean?
+ maxRedirects: int?
+ maxRetries: int?
+ returns:
+ response: APIResponse
+
+ fetchResponseBody:
+ title: Get response body
+ group: getter
+ parameters:
+ fetchUid: string
+ returns:
+ binary: binary?
+
+ fetchLog:
+ internal: true
+ parameters:
+ fetchUid: string
+ returns:
+ log:
+ type: array
+ items: string
+
+ storageState:
+ title: Get storage state
+ group: configuration
+ parameters:
+ indexedDB: boolean?
+ returns:
+ cookies:
+ type: array
+ items: NetworkCookie
+ origins:
+ type: array
+ items: OriginStorage
+
+ disposeAPIResponse:
+ internal: true
+ parameters:
+ fetchUid: string
+
+ dispose:
+ internal: true
+ parameters:
+ reason: string?
+
+APIResponse:
+ type: object
+ properties:
+ fetchUid: string
+ url: string
+ status: int
+ statusText: string
+ headers:
+ type: array
+ items: NameValue
diff --git a/packages/protocol/spec/artifact.yml b/packages/protocol/spec/artifact.yml
new file mode 100644
index 0000000000..a7bafe4874
--- /dev/null
+++ b/packages/protocol/spec/artifact.yml
@@ -0,0 +1,82 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Artifact:
+ type: interface
+
+ initializer:
+ absolutePath: string
+
+ commands:
+
+ pathAfterFinished:
+ internal: true
+ returns:
+ value: string
+
+ # Blocks path/failure/delete/context.close until saved to the local |path|.
+ saveAs:
+ internal: true
+ parameters:
+ path: string
+
+ # Blocks path/failure/delete/context.close until the stream is closed.
+ saveAsStream:
+ internal: true
+ returns:
+ stream: Stream
+
+ failure:
+ internal: true
+ returns:
+ error: string?
+
+ stream:
+ internal: true
+ returns:
+ stream: Stream
+
+ cancel:
+ internal: true
+
+ delete:
+ internal: true
+
+Stream:
+ type: interface
+
+ commands:
+
+ read:
+ internal: true
+ parameters:
+ size: int?
+ returns:
+ binary: binary
+
+ close:
+ internal: true
+
+WritableStream:
+ type: interface
+
+ commands:
+
+ write:
+ internal: true
+ parameters:
+ binary: binary
+
+ close:
+ internal: true
diff --git a/packages/protocol/spec/browser.yml b/packages/protocol/spec/browser.yml
new file mode 100644
index 0000000000..bc0b862165
--- /dev/null
+++ b/packages/protocol/spec/browser.yml
@@ -0,0 +1,138 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Browser:
+ type: interface
+
+ initializer:
+ version: string
+ name: string
+ browserName:
+ type: enum
+ literals:
+ - chromium
+ - firefox
+ - webkit
+
+ commands:
+
+ startServer:
+ title: Start server
+ parameters:
+ title: string
+ workspaceDir: string?
+ metadata: json?
+ host: string?
+ port: int?
+ returns:
+ endpoint: string
+
+ stopServer:
+ title: Stop server
+
+ close:
+ title: Close browser
+ parameters:
+ reason: string?
+ flags:
+ pause: true
+
+ killForTests:
+ internal: true
+
+ defaultUserAgentForTest:
+ internal: true
+ returns:
+ userAgent: string
+
+ newContext:
+ title: Create context
+ parameters:
+ $mixin: ContextOptions
+ proxy:
+ type: object?
+ properties:
+ server: string
+ bypass: string?
+ username: string?
+ password: string?
+ storageState:
+ type: object?
+ properties:
+ cookies:
+ type: array?
+ items: SetNetworkCookie
+ origins:
+ type: array?
+ items: SetOriginStorage
+ returns:
+ context: BrowserContext
+
+ newContextForReuse:
+ internal: true
+ parameters:
+ $mixin: ContextOptions
+ proxy:
+ type: object?
+ properties:
+ server: string
+ bypass: string?
+ username: string?
+ password: string?
+ storageState:
+ type: object?
+ properties:
+ cookies:
+ type: array?
+ items: SetNetworkCookie
+ origins:
+ type: array?
+ items: SetOriginStorage
+ returns:
+ context: BrowserContext
+
+ disconnectFromReusedContext:
+ internal: true
+ parameters:
+ reason: string
+
+ newBrowserCDPSession:
+ title: Create CDP session
+ group: configuration
+ returns:
+ session: CDPSession
+
+ startTracing:
+ title: Start browser tracing
+ group: configuration
+ parameters:
+ page: Page?
+ screenshots: boolean?
+ categories:
+ type: array?
+ items: string
+
+ stopTracing:
+ title: Stop browser tracing
+ group: configuration
+ returns:
+ artifact: Artifact
+
+ events:
+
+ context:
+ parameters:
+ context: BrowserContext
+
+ close:
diff --git a/packages/protocol/spec/browserContext.yml b/packages/protocol/spec/browserContext.yml
new file mode 100644
index 0000000000..dc3679ebe5
--- /dev/null
+++ b/packages/protocol/spec/browserContext.yml
@@ -0,0 +1,397 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+BrowserContext:
+ type: interface
+
+ extends: EventTarget
+
+ initializer:
+ debugger: Debugger
+ requestContext: APIRequestContext
+ tracing: Tracing
+ options:
+ type: object
+ properties:
+ $mixin: ContextOptions
+
+ commands:
+
+ addCookies:
+ title: Add cookies
+ group: configuration
+ parameters:
+ cookies:
+ type: array
+ items: SetNetworkCookie
+
+ addInitScript:
+ title: Add init script
+ group: configuration
+ parameters:
+ source: string
+ returns:
+ disposable: Disposable
+
+ clearCookies:
+ title: Clear cookies
+ group: configuration
+ parameters:
+ name: string?
+ nameRegexSource: string?
+ nameRegexFlags: string?
+ domain: string?
+ domainRegexSource: string?
+ domainRegexFlags: string?
+ path: string?
+ pathRegexSource: string?
+ pathRegexFlags: string?
+
+ clearPermissions:
+ title: Clear permissions
+ group: configuration
+
+ close:
+ title: Close context
+ parameters:
+ reason: string?
+ flags:
+ pause: true
+
+ cookies:
+ title: Get cookies
+ group: getter
+ parameters:
+ urls:
+ type: array
+ items: string
+ returns:
+ cookies:
+ type: array
+ items: NetworkCookie
+
+ exposeBinding:
+ title: Expose binding
+ group: configuration
+ parameters:
+ name: string
+ returns:
+ disposable: Disposable
+
+ grantPermissions:
+ title: Grant permissions
+ group: configuration
+ parameters:
+ permissions:
+ type: array
+ items: string
+ origin: string?
+
+ newPage:
+ title: Create page
+ returns:
+ page: Page
+
+ registerSelectorEngine:
+ internal: true
+ parameters:
+ selectorEngine: SelectorEngine
+
+ setTestIdAttributeName:
+ internal: true
+ parameters:
+ testIdAttributeName: string
+
+ setExtraHTTPHeaders:
+ title: Set extra HTTP headers
+ group: configuration
+ parameters:
+ headers:
+ type: array
+ items: NameValue
+
+ setGeolocation:
+ title: Set geolocation
+ group: configuration
+ parameters:
+ geolocation:
+ type: object?
+ properties:
+ longitude: float
+ latitude: float
+ accuracy: float?
+
+ setHTTPCredentials:
+ title: Set HTTP credentials
+ group: configuration
+ parameters:
+ httpCredentials:
+ type: object?
+ properties:
+ username: string
+ password: string
+ origin: string?
+
+ setNetworkInterceptionPatterns:
+ title: Route requests
+ group: route
+ parameters:
+ patterns:
+ type: array
+ items:
+ type: object
+ properties:
+ glob: string?
+ regexSource: string?
+ regexFlags: string?
+ urlPattern: URLPattern?
+
+ setWebSocketInterceptionPatterns:
+ title: Route WebSockets
+ group: route
+ parameters:
+ patterns:
+ type: array
+ items:
+ type: object
+ properties:
+ glob: string?
+ regexSource: string?
+ regexFlags: string?
+ urlPattern: URLPattern?
+
+ setOffline:
+ title: Set offline mode
+ parameters:
+ offline: boolean
+
+ storageState:
+ title: Get storage state
+ group: configuration
+ parameters:
+ indexedDB: boolean?
+ returns:
+ cookies:
+ type: array
+ items: NetworkCookie
+ origins:
+ type: array
+ items: OriginStorage
+
+ setStorageState:
+ title: Set storage state
+ group: configuration
+ parameters:
+ storageState:
+ type: object?
+ properties:
+ cookies:
+ type: array?
+ items: SetNetworkCookie
+ origins:
+ type: array?
+ items: SetOriginStorage
+
+ pause:
+ title: Pause
+
+ enableRecorder:
+ internal: true
+ parameters:
+ language: string?
+ mode:
+ type: enum?
+ literals:
+ - inspecting
+ - recording
+ recorderMode:
+ type: enum?
+ literals:
+ - default
+ - api
+ pauseOnNextStatement: boolean?
+ testIdAttributeName: string?
+ launchOptions: json?
+ contextOptions: json?
+ device: string?
+ saveStorage: string?
+ outputFile: string?
+ handleSIGINT: boolean?
+ omitCallTracking: boolean?
+
+ disableRecorder:
+ internal: true
+
+ exposeConsoleApi:
+ internal: true
+
+ newCDPSession:
+ title: Create CDP session
+ group: configuration
+ parameters:
+ page: Page?
+ frame: Frame?
+ returns:
+ session: CDPSession
+
+ createTempFiles:
+ internal: true
+ parameters:
+ rootDirName: string?
+ items:
+ type: array
+ items:
+ type: object
+ properties:
+ name: string
+ lastModifiedMs: float?
+ returns:
+ rootDir: WritableStream?
+ writableStreams:
+ type: array
+ items: WritableStream
+
+ updateSubscription:
+ internal: true
+ parameters:
+ event:
+ type: enum
+ literals:
+ - console
+ - dialog
+ - request
+ - response
+ - requestFinished
+ - requestFailed
+ enabled: boolean
+
+ clockFastForward:
+ title: Fast forward clock "{ticksNumber|ticksString}"
+ parameters:
+ ticksNumber: float?
+ ticksString: string?
+
+ clockInstall:
+ title: Install clock "{timeNumber|timeString}"
+ parameters:
+ timeNumber: float?
+ timeString: string?
+
+ clockPauseAt:
+ title: Pause clock "{timeNumber|timeString}"
+ parameters:
+ timeNumber: float?
+ timeString: string?
+
+ clockResume:
+ title: Resume clock
+
+ clockRunFor:
+ title: Run clock "{ticksNumber|ticksString}"
+ parameters:
+ ticksNumber: float?
+ ticksString: string?
+
+ clockSetFixedTime:
+ title: Set fixed time "{timeNumber|timeString}"
+ parameters:
+ timeNumber: float?
+ timeString: string?
+
+ clockSetSystemTime:
+ title: Set system time "{timeNumber|timeString}"
+ parameters:
+ timeNumber: float?
+ timeString: string?
+
+ events:
+
+ bindingCall:
+ parameters:
+ binding: BindingCall
+
+ console:
+ parameters:
+ $mixin: ConsoleMessage
+ page: Page?
+ worker: Worker?
+
+ close:
+
+ dialog:
+ parameters:
+ dialog: Dialog
+
+ page:
+ parameters:
+ page: Page
+
+ pageError:
+ parameters:
+ error: SerializedError
+ page: Page
+ location:
+ type: object
+ properties:
+ url: string
+ line: int
+ column: int
+
+ route:
+ parameters:
+ route: Route
+
+ webSocketRoute:
+ parameters:
+ webSocketRoute: WebSocketRoute
+
+ serviceWorker:
+ parameters:
+ worker: Worker
+
+ request:
+ parameters:
+ request: Request
+ page: Page?
+
+ requestFailed:
+ parameters:
+ request: Request
+ failureText: string?
+ responseEndTiming: float
+ page: Page?
+
+ requestFinished:
+ parameters:
+ request: Request
+ response: Response?
+ responseEndTiming: float
+ page: Page?
+
+ response:
+ parameters:
+ response: Response
+ page: Page?
+
+ recorderEvent:
+ parameters:
+ event:
+ type: enum
+ literals:
+ - actionAdded
+ - actionUpdated
+ - signalAdded
+ data: json
+ page: Page
+ code: string
diff --git a/packages/protocol/spec/browserType.yml b/packages/protocol/spec/browserType.yml
new file mode 100644
index 0000000000..0ff5f4dc85
--- /dev/null
+++ b/packages/protocol/spec/browserType.yml
@@ -0,0 +1,64 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+BrowserType:
+ type: interface
+
+ initializer:
+ executablePath: string
+ name: string
+
+ commands:
+
+ launch:
+ title: Launch browser
+ parameters:
+ $mixin: LaunchOptions
+ slowMo: float?
+ returns:
+ browser: Browser
+
+ launchPersistentContext:
+ title: Launch persistent context
+ parameters:
+ $mixin1: LaunchOptions
+ $mixin2: ContextOptions
+ userDataDir: string
+ slowMo: float?
+ returns:
+ browser: Browser
+ context: BrowserContext
+
+ connectOverCDP:
+ title: Connect over CDP
+ parameters:
+ endpointURL: string
+ headers:
+ type: array?
+ items: NameValue
+ slowMo: float?
+ timeout: float
+ isLocal: boolean?
+ noDefaults: boolean?
+ returns:
+ browser: Browser
+ defaultContext: BrowserContext?
+
+ connectToWorker:
+ title: Connect to worker
+ parameters:
+ endpoint: string
+ timeout: float
+ returns:
+ worker: Worker
diff --git a/packages/protocol/spec/core.yml b/packages/protocol/spec/core.yml
new file mode 100644
index 0000000000..f320692acb
--- /dev/null
+++ b/packages/protocol/spec/core.yml
@@ -0,0 +1,74 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Metadata:
+ type: object
+ properties:
+ location:
+ type: object?
+ properties:
+ file: string
+ line: int?
+ column: int?
+ title: string?
+ internal: boolean?
+ # Test runner step id.
+ stepId: string?
+
+ClientSideCallMetadata:
+ type: object
+ properties:
+ id: int
+ stack:
+ type: array?
+ items: StackFrame
+
+SDKLanguage:
+ type: enum
+ literals:
+ - javascript
+ - python
+ - java
+ - csharp
+
+Disposable:
+ type: interface
+
+ commands:
+
+ dispose:
+ internal: true
+
+EventTarget:
+ type: interface
+
+ commands:
+ waitForEventInfo:
+ title: Wait for event "{info.event}"
+ parameters:
+ info:
+ type: object
+ properties:
+ waitId: string
+ phase:
+ type: enum
+ literals:
+ - before
+ - after
+ - log
+ event: string?
+ message: string?
+ error: string?
+ flags:
+ snapshot: true
diff --git a/packages/protocol/spec/frame.yml b/packages/protocol/spec/frame.yml
new file mode 100644
index 0000000000..b3f0f8426c
--- /dev/null
+++ b/packages/protocol/spec/frame.yml
@@ -0,0 +1,798 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Frame:
+ type: interface
+
+ initializer:
+ url: string
+ name: string
+ parentFrame: Frame?
+ loadStates:
+ type: array
+ items: LifecycleEvent
+
+ commands:
+
+ evalOnSelector:
+ title: Evaluate
+ parameters:
+ selector: string
+ strict: boolean?
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ evalOnSelectorAll:
+ title: Evaluate
+ parameters:
+ selector: string
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ addScriptTag:
+ title: Add script tag
+ parameters:
+ url: string?
+ content: string?
+ type: string?
+ returns:
+ element: ElementHandle
+ flags:
+ snapshot: true
+ pause: true
+
+ addStyleTag:
+ title: Add style tag
+ parameters:
+ url: string?
+ content: string?
+ returns:
+ element: ElementHandle
+ flags:
+ snapshot: true
+ pause: true
+
+ ariaSnapshot:
+ title: Aria snapshot
+ group: getter
+ parameters:
+ mode:
+ type: enum?
+ literals:
+ - ai
+ - default
+ # When track is present, an incremental snapshot is returned when possible.
+ track: string?
+ selector: string?
+ depth: int?
+ boxes: boolean?
+ timeout: float
+ returns:
+ snapshot: string
+
+ blur:
+ title: Blur
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ check:
+ title: Check
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ click:
+ title: Click
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ noWaitAfter: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ delay: float?
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ clickCount: int?
+ timeout: float
+ trial: boolean?
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ content:
+ title: Get content
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ dragAndDrop:
+ title: Drag and drop
+ parameters:
+ source: string
+ target: string
+ force: boolean?
+ timeout: float
+ trial: boolean?
+ sourcePosition: Point?
+ targetPosition: Point?
+ strict: boolean?
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ drop:
+ title: Drop files or data onto an element
+ parameters:
+ selector: string
+ strict: boolean?
+ position: Point?
+ # Only one of payloads, localPaths and streams may be present.
+ payloads:
+ type: array?
+ items:
+ type: object
+ properties:
+ name: string
+ mimeType: string?
+ buffer: binary
+ localPaths:
+ type: array?
+ items: string
+ streams:
+ type: array?
+ items: WritableStream
+ data:
+ type: array?
+ items:
+ type: object
+ properties:
+ mimeType: string
+ value: string
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ dblclick:
+ title: Double click
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ delay: float?
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ timeout: float
+ trial: boolean?
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ dispatchEvent:
+ title: Dispatch "{type}"
+ parameters:
+ selector: string
+ strict: boolean?
+ type: string
+ eventInit: SerializedArgument
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ evaluateExpression:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ evaluateExpressionHandle:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ handle: JSHandle
+ flags:
+ snapshot: true
+ pause: true
+
+ fill:
+ title: Fill "{value}"
+ parameters:
+ selector: string
+ strict: boolean?
+ value: string
+ force: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ focus:
+ title: Focus
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ frameElement:
+ title: Get frame element
+ group: getter
+ returns:
+ element: ElementHandle
+
+ resolveSelector:
+ internal: true
+ parameters:
+ selector: string
+ returns:
+ resolvedSelector: string
+
+ highlight:
+ internal: true
+ parameters:
+ selector: string
+ style: string?
+
+ hideHighlight:
+ internal: true
+ parameters:
+ selector: string
+
+ getAttribute:
+ title: Get attribute "{name}"
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ name: string
+ timeout: float
+ returns:
+ value: string?
+ flags:
+ snapshot: true
+ pause: true
+
+ goto:
+ title: Navigate to "{url}"
+ parameters:
+ url: string
+ timeout: float
+ waitUntil: LifecycleEvent?
+ referer: string?
+ returns:
+ response: Response?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ hover:
+ title: Hover
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ innerHTML:
+ title: Get HTML
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ innerText:
+ title: Get inner text
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ inputValue:
+ title: Get input value
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ isChecked:
+ title: Is checked
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isDisabled:
+ title: Is disabled
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isEnabled:
+ title: Is enabled
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isHidden:
+ title: Is hidden
+ group: getter
+ parameters:
+ # Note: compared to other isFoo methods, isHidden is a one-shot operation without a timeout.
+ selector: string
+ strict: boolean?
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isVisible:
+ title: Is visible
+ group: getter
+ parameters:
+ # Note: compared to other isFoo methods, isVisible is a one-shot operation without a timeout.
+ selector: string
+ strict: boolean?
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isEditable:
+ title: Is editable
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ press:
+ title: Press "{key}"
+ parameters:
+ selector: string
+ strict: boolean?
+ key: string
+ delay: float?
+ noWaitAfter: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ querySelector:
+ title: Query selector
+ parameters:
+ selector: string
+ strict: boolean?
+ returns:
+ element: ElementHandle?
+ flags:
+ snapshot: true
+
+ querySelectorAll:
+ title: Query selector all
+ parameters:
+ selector: string
+ returns:
+ elements:
+ type: array
+ items: ElementHandle
+ flags:
+ snapshot: true
+
+ queryCount:
+ title: Query count
+ parameters:
+ selector: string
+ returns:
+ value: int
+ flags:
+ snapshot: true
+ pause: true
+
+ selectOption:
+ title: Select option
+ parameters:
+ selector: string
+ strict: boolean?
+ elements:
+ type: array?
+ items: ElementHandle
+ options:
+ type: array?
+ items:
+ type: object
+ properties:
+ valueOrLabel: string?
+ value: string?
+ label: string?
+ index: int?
+ force: boolean?
+ timeout: float
+ returns:
+ values:
+ type: array
+ items: string
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ setContent:
+ title: Set content
+ parameters:
+ html: string
+ timeout: float
+ waitUntil: LifecycleEvent?
+ flags:
+ snapshot: true
+ pause: true
+
+ setInputFiles:
+ title: Set input files
+ parameters:
+ selector: string
+ strict: boolean?
+ # Only one of payloads, localPaths and streams should be present.
+ payloads:
+ type: array?
+ items:
+ type: object
+ properties:
+ name: string
+ mimeType: string?
+ buffer: binary
+ localDirectory: string?
+ directoryStream: WritableStream?
+ localPaths:
+ type: array?
+ items: string
+ streams:
+ type: array?
+ items: WritableStream
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ tap:
+ title: Tap
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ textContent:
+ title: Get text content
+ group: getter
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ returns:
+ value: string?
+ flags:
+ snapshot: true
+ pause: true
+
+ title:
+ title: Get page title
+ group: getter
+ returns:
+ value: string
+
+ type:
+ title: Type "{text}"
+ parameters:
+ selector: string
+ strict: boolean?
+ text: string
+ delay: float?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ uncheck:
+ title: Uncheck
+ parameters:
+ selector: string
+ strict: boolean?
+ force: boolean?
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ waitForTimeout:
+ title: Wait for timeout
+ parameters:
+ waitTimeout: float
+ flags:
+ snapshot: true
+
+ waitForFunction:
+ title: Wait for function
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ timeout: float
+ # When present, polls on interval. Otherwise, polls on raf.
+ pollingInterval: float?
+ returns:
+ handle: JSHandle
+ flags:
+ snapshot: true
+ pause: true
+
+ waitForSelector:
+ title: Wait for selector
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ state:
+ type: enum?
+ literals:
+ - attached
+ - detached
+ - visible
+ - hidden
+ omitReturnValue: boolean?
+ returns:
+ element: ElementHandle?
+ flags:
+ snapshot: true
+
+ expect:
+ title: Expect "{expression}"
+ parameters:
+ selector: string?
+ expression: string
+ expressionArg: json?
+ pseudo:
+ type: enum?
+ literals:
+ - before
+ - after
+ expectedText:
+ type: array?
+ items: ExpectedTextValue
+ expectedNumber: float?
+ expectedValue: SerializedArgument?
+ useInnerText: boolean?
+ isNot: boolean
+ timeout: float
+ returns:
+ matches: boolean
+ received:
+ type: object?
+ properties:
+ value: SerializedValue?
+ ariaSnapshot: string?
+ timedOut: boolean?
+ errorMessage: string?
+ log:
+ type: array?
+ items: string
+ flags:
+ snapshot: true
+ pause: true
+
+ events:
+
+ loadstate:
+ parameters:
+ add: LifecycleEvent?
+ remove: LifecycleEvent?
+
+ navigated:
+ parameters:
+ url: string
+ name: string
+ newDocument:
+ type: object?
+ properties:
+ request: Request?
+ error: string?
diff --git a/packages/protocol/spec/handles.yml b/packages/protocol/spec/handles.yml
new file mode 100644
index 0000000000..edab0387c6
--- /dev/null
+++ b/packages/protocol/spec/handles.yml
@@ -0,0 +1,582 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+JSHandle:
+ type: interface
+
+ initializer:
+ preview: string
+
+ commands:
+
+ dispose:
+ internal: true
+
+ evaluateExpression:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ evaluateExpressionHandle:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ handle: JSHandle
+ flags:
+ snapshot: true
+ pause: true
+
+ getPropertyList:
+ title: Get property list
+ group: getter
+ returns:
+ properties:
+ type: array
+ items:
+ type: object
+ properties:
+ name: string
+ value: JSHandle
+
+ getProperty:
+ title: Get JS property
+ group: getter
+ parameters:
+ name: string
+ returns:
+ handle: JSHandle
+
+ jsonValue:
+ title: Get JSON value
+ group: getter
+ returns:
+ value: SerializedValue
+
+ events:
+
+ previewUpdated:
+ parameters:
+ preview: string
+
+ElementHandle:
+ type: interface
+
+ extends: JSHandle
+
+ commands:
+
+ evalOnSelector:
+ title: Evaluate
+ parameters:
+ selector: string
+ strict: boolean?
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ evalOnSelectorAll:
+ title: Evaluate
+ parameters:
+ selector: string
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+ flags:
+ snapshot: true
+ pause: true
+
+ boundingBox:
+ title: Get bounding box
+ returns:
+ value: Rect?
+ flags:
+ snapshot: true
+ pause: true
+
+ check:
+ title: Check
+ parameters:
+ force: boolean?
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ click:
+ title: Click
+ parameters:
+ force: boolean?
+ noWaitAfter: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ delay: float?
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ clickCount: int?
+ timeout: float
+ trial: boolean?
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ contentFrame:
+ title: Get content frame
+ group: getter
+ returns:
+ frame: Frame?
+
+ dblclick:
+ title: Double click
+ parameters:
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ delay: float?
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ timeout: float
+ trial: boolean?
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ dispatchEvent:
+ title: Dispatch event
+ parameters:
+ type: string
+ eventInit: SerializedArgument
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ fill:
+ title: Fill "{value}"
+ parameters:
+ value: string
+ force: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ focus:
+ title: Focus
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ getAttribute:
+ title: Get attribute
+ group: getter
+ parameters:
+ name: string
+ returns:
+ value: string?
+ flags:
+ snapshot: true
+ pause: true
+
+ hover:
+ title: Hover
+ parameters:
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ innerHTML:
+ title: Get HTML
+ group: getter
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ innerText:
+ title: Get inner text
+ group: getter
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ inputValue:
+ title: Get input value
+ group: getter
+ returns:
+ value: string
+ flags:
+ snapshot: true
+ pause: true
+
+ isChecked:
+ title: Is checked
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isDisabled:
+ title: Is disabled
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isEditable:
+ title: Is editable
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isEnabled:
+ title: Is enabled
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isHidden:
+ title: Is hidden
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ isVisible:
+ title: Is visible
+ group: getter
+ returns:
+ value: boolean
+ flags:
+ snapshot: true
+ pause: true
+
+ ownerFrame:
+ title: Get owner frame
+ group: getter
+ returns:
+ frame: Frame?
+
+ press:
+ title: Press "{key}"
+ parameters:
+ key: string
+ delay: float?
+ timeout: float
+ noWaitAfter: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ querySelector:
+ title: Query selector
+ parameters:
+ selector: string
+ strict: boolean?
+ returns:
+ element: ElementHandle?
+ flags:
+ snapshot: true
+
+ querySelectorAll:
+ title: Query selector all
+ parameters:
+ selector: string
+ returns:
+ elements:
+ type: array
+ items: ElementHandle
+ flags:
+ snapshot: true
+
+ screenshot:
+ title: Screenshot
+ parameters:
+ timeout: float
+ type:
+ type: enum?
+ literals:
+ - png
+ - jpeg
+ quality: int?
+ $mixin: CommonScreenshotOptions
+ returns:
+ binary: binary
+ flags:
+ snapshot: true
+ pause: true
+
+ scrollIntoViewIfNeeded:
+ title: Scroll into view
+ parameters:
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ selectOption:
+ title: Select option
+ parameters:
+ elements:
+ type: array?
+ items: ElementHandle
+ options:
+ type: array?
+ items:
+ type: object
+ properties:
+ valueOrLabel: string?
+ value: string?
+ label: string?
+ index: int?
+ force: boolean?
+ timeout: float
+ returns:
+ values:
+ type: array
+ items: string
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ selectText:
+ title: Select text
+ parameters:
+ force: boolean?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ setInputFiles:
+ title: Set input files
+ parameters:
+ # Only one of payloads, localPaths and streams should be present.
+ payloads:
+ type: array?
+ items:
+ type: object
+ properties:
+ name: string
+ mimeType: string?
+ buffer: binary
+ localDirectory: string?
+ directoryStream: WritableStream?
+ localPaths:
+ type: array?
+ items: string
+ streams:
+ type: array?
+ items: WritableStream
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ tap:
+ title: Tap
+ parameters:
+ force: boolean?
+ modifiers:
+ type: array?
+ items:
+ type: enum
+ literals:
+ - Alt
+ - Control
+ - ControlOrMeta
+ - Meta
+ - Shift
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ textContent:
+ title: Get text content
+ group: getter
+ returns:
+ value: string?
+ flags:
+ snapshot: true
+ pause: true
+
+ type:
+ title: Type
+ parameters:
+ text: string
+ delay: float?
+ timeout: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ uncheck:
+ title: Uncheck
+ parameters:
+ force: boolean?
+ position: Point?
+ timeout: float
+ trial: boolean?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+ isAutoWaiting: true
+
+ waitForElementState:
+ title: Wait for state
+ parameters:
+ state:
+ type: enum
+ literals:
+ - visible
+ - hidden
+ - stable
+ - enabled
+ - disabled
+ - editable
+ timeout: float
+ flags:
+ snapshot: true
+ pause: true
+
+ waitForSelector:
+ title: Wait for selector
+ parameters:
+ selector: string
+ strict: boolean?
+ timeout: float
+ state:
+ type: enum?
+ literals:
+ - attached
+ - detached
+ - visible
+ - hidden
+ returns:
+ element: ElementHandle?
+ flags:
+ snapshot: true
diff --git a/packages/protocol/spec/localUtils.yml b/packages/protocol/spec/localUtils.yml
new file mode 100644
index 0000000000..4381f8319d
--- /dev/null
+++ b/packages/protocol/spec/localUtils.yml
@@ -0,0 +1,157 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+LocalUtils:
+ type: interface
+
+ initializer:
+ deviceDescriptors:
+ type: array
+ items:
+ type: object
+ properties:
+ name: string
+ descriptor:
+ type: object
+ properties:
+ userAgent: string
+ viewport:
+ type: object
+ properties:
+ width: int
+ height: int
+ screen:
+ type: object?
+ properties:
+ width: int
+ height: int
+ deviceScaleFactor: float
+ isMobile: boolean
+ hasTouch: boolean
+ defaultBrowserType:
+ type: enum
+ literals:
+ - chromium
+ - firefox
+ - webkit
+
+ commands:
+
+ zip:
+ internal: true
+ parameters:
+ zipFile: string
+ entries:
+ type: array
+ items: NameValue
+ stacksId: string?
+ mode:
+ type: enum
+ literals:
+ - write
+ - append
+ includeSources: boolean
+ additionalSources:
+ type: array?
+ items: string
+
+ harOpen:
+ internal: true
+ parameters:
+ file: string
+ returns:
+ harId: string?
+ error: string?
+
+ harLookup:
+ internal: true
+ parameters:
+ harId: string
+ url: string
+ method: string
+ headers:
+ type: array
+ items: NameValue
+ postData: binary?
+ isNavigationRequest: boolean
+ returns:
+ action:
+ type: enum
+ literals:
+ - error
+ - redirect
+ - fulfill
+ - noentry
+ message: string?
+ redirectURL: string?
+ status: int?
+ headers:
+ type: array?
+ items: NameValue
+ body: binary?
+
+ harClose:
+ internal: true
+ parameters:
+ harId: string
+
+ harUnzip:
+ internal: true
+ parameters:
+ zipFile: string
+ harFile: string
+ resourcesDir: string?
+
+ connect:
+ internal: true
+ parameters:
+ endpoint: string
+ headers: json?
+ exposeNetwork: string?
+ slowMo: float?
+ timeout: float
+ socksProxyRedirectPortForTest: int?
+ returns:
+ pipe: JsonPipe
+ headers:
+ type: array
+ items: NameValue
+
+ tracingStarted:
+ internal: true
+ parameters:
+ tracesDir: string?
+ traceName: string
+ live: boolean?
+ returns:
+ stacksId: string
+
+ addStackToTracingNoReply:
+ internal: true
+ parameters:
+ callData: ClientSideCallMetadata
+
+ traceDiscarded:
+ internal: true
+ parameters:
+ stacksId: string
+
+ globToRegex:
+ internal: true
+ parameters:
+ glob: string
+ baseURL: string?
+ webSocketUrl: boolean?
+ returns:
+ regex: string
diff --git a/packages/protocol/spec/mixins.yml b/packages/protocol/spec/mixins.yml
new file mode 100644
index 0000000000..9d7cd06678
--- /dev/null
+++ b/packages/protocol/spec/mixins.yml
@@ -0,0 +1,220 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+ShowActionsOptions:
+ type: mixin
+ properties:
+ duration: float?
+ position:
+ type: enum?
+ literals:
+ - top-left
+ - top
+ - top-right
+ - bottom-left
+ - bottom
+ - bottom-right
+ fontSize: int?
+
+CommonScreenshotOptions:
+ type: mixin
+ properties:
+ omitBackground: boolean?
+ caret:
+ type: enum?
+ literals:
+ - hide
+ - initial
+ animations:
+ type: enum?
+ literals:
+ - disabled
+ - allow
+ scale:
+ type: enum?
+ literals:
+ - css
+ - device
+ mask:
+ type: array?
+ items:
+ type: object
+ properties:
+ frame: Frame
+ selector: string
+ maskColor: string?
+ style: string?
+
+LaunchOptions:
+ type: mixin
+ properties:
+ channel: string?
+ executablePath: string?
+ args:
+ type: array?
+ items: string
+ ignoreAllDefaultArgs: boolean?
+ ignoreDefaultArgs:
+ type: array?
+ items: string
+ handleSIGINT: boolean?
+ handleSIGTERM: boolean?
+ handleSIGHUP: boolean?
+ timeout: float
+ env:
+ type: array?
+ items: NameValue
+ headless: boolean?
+ proxy:
+ type: object?
+ properties:
+ server: string
+ bypass: string?
+ username: string?
+ password: string?
+ downloadsPath: string?
+ tracesDir: string?
+ artifactsDir: string?
+ chromiumSandbox: boolean?
+ firefoxUserPrefs: json?
+ cdpPort: int?
+
+ContextOptions:
+ type: mixin
+ properties:
+ noDefaultViewport: boolean?
+ viewport:
+ type: object?
+ properties:
+ width: int
+ height: int
+ screen:
+ type: object?
+ properties:
+ width: int
+ height: int
+ ignoreHTTPSErrors: boolean?
+ clientCertificates:
+ type: array?
+ items:
+ type: object
+ properties:
+ origin: string
+ cert: binary?
+ key: binary?
+ passphrase: string?
+ pfx: binary?
+ javaScriptEnabled: boolean?
+ bypassCSP: boolean?
+ userAgent: string?
+ locale: string?
+ timezoneId: string?
+ geolocation:
+ type: object?
+ properties:
+ longitude: float
+ latitude: float
+ accuracy: float?
+ permissions:
+ type: array?
+ items: string
+ extraHTTPHeaders:
+ type: array?
+ items: NameValue
+ offline: boolean?
+ httpCredentials:
+ type: object?
+ properties:
+ username: string
+ password: string
+ origin: string?
+ send:
+ type: enum?
+ literals:
+ - always
+ - unauthorized
+ deviceScaleFactor: float?
+ isMobile: boolean?
+ hasTouch: boolean?
+ colorScheme:
+ type: enum?
+ literals:
+ - dark
+ - light
+ - no-preference
+ - no-override
+ reducedMotion:
+ type: enum?
+ literals:
+ - reduce
+ - no-preference
+ - no-override
+ forcedColors:
+ type: enum?
+ literals:
+ - active
+ - none
+ - no-override
+ acceptDownloads:
+ type: enum?
+ literals:
+ - accept
+ - deny
+ - internal-browser-default
+ contrast:
+ type: enum?
+ literals:
+ - no-preference
+ - more
+ - no-override
+ baseURL: string?
+ recordVideo:
+ type: object?
+ properties:
+ dir: string?
+ size:
+ type: object?
+ properties:
+ width: int
+ height: int
+ showActions:
+ type: object?
+ properties:
+ $mixin: ShowActionsOptions
+ strictSelectors: boolean?
+ serviceWorkers:
+ type: enum?
+ literals:
+ - allow
+ - block
+ selectorEngines:
+ type: array?
+ items: SelectorEngine
+ testIdAttributeName: string?
+
+ConsoleMessage:
+ type: mixin
+ properties:
+ type: string
+ text: string
+ args:
+ type: array
+ items: JSHandle
+ location:
+ type: object
+ properties:
+ url: string
+ lineNumber: int
+ columnNumber: int
+ timestamp: float
diff --git a/packages/protocol/spec/network.yml b/packages/protocol/spec/network.yml
new file mode 100644
index 0000000000..ade023e50f
--- /dev/null
+++ b/packages/protocol/spec/network.yml
@@ -0,0 +1,308 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SetNetworkCookie:
+ type: object
+ properties:
+ name: string
+ value: string
+ url: string?
+ domain: string?
+ path: string?
+ expires: float?
+ httpOnly: boolean?
+ secure: boolean?
+ sameSite:
+ type: enum?
+ literals:
+ - Strict
+ - Lax
+ - None
+ partitionKey: string?
+ _crHasCrossSiteAncestor: boolean?
+
+NetworkCookie:
+ type: object
+ properties:
+ name: string
+ value: string
+ domain: string
+ path: string
+ expires: float
+ httpOnly: boolean
+ secure: boolean
+ sameSite:
+ type: enum
+ literals:
+ - Strict
+ - Lax
+ - None
+ partitionKey: string?
+ _crHasCrossSiteAncestor: boolean?
+
+Request:
+ type: interface
+
+ initializer:
+ frame: Frame?
+ serviceWorker: Worker?
+ url: string
+ resourceType: string
+ method: string
+ postData: binary?
+ headers:
+ type: array
+ items: NameValue
+ isNavigationRequest: boolean
+ redirectedFrom: Request?
+
+ commands:
+
+ response:
+ internal: true
+ returns:
+ response: Response?
+
+ rawRequestHeaders:
+ internal: true
+ returns:
+ headers:
+ type: array
+ items: NameValue
+
+Route:
+ type: interface
+
+ initializer:
+ request: Request
+
+ commands:
+
+ redirectNavigationRequest:
+ internal: true
+ parameters:
+ url: string
+
+ abort:
+ title: Abort request
+ group: route
+ parameters:
+ errorCode: string?
+
+ continue:
+ title: Continue request
+ group: route
+ parameters:
+ url: string?
+ method: string?
+ headers:
+ type: array?
+ items: NameValue
+ postData: binary?
+ isFallback: boolean
+
+ fulfill:
+ title: Fulfill request
+ group: route
+ parameters:
+ # default is 200
+ status: int?
+ headers:
+ type: array?
+ items: NameValue
+ body: string?
+ isBase64: boolean?
+ fetchResponseUid: string?
+
+WebSocketRoute:
+ type: interface
+
+ initializer:
+ url: string
+ protocols:
+ type: array
+ items: string
+
+ commands:
+
+ connect:
+ title: Connect WebSocket to server
+ group: route
+
+ ensureOpened:
+ internal: true
+
+ sendToPage:
+ title: Send WebSocket message
+ group: route
+ parameters:
+ message: string
+ isBase64: boolean
+
+ sendToServer:
+ title: Send WebSocket message
+ group: route
+ parameters:
+ message: string
+ isBase64: boolean
+
+ closePage:
+ internal: true
+ parameters:
+ code: int?
+ reason: string?
+ wasClean: boolean
+
+ closeServer:
+ internal: true
+ parameters:
+ code: int?
+ reason: string?
+ wasClean: boolean
+
+ events:
+
+ messageFromPage:
+ parameters:
+ message: string
+ isBase64: boolean
+
+ messageFromServer:
+ parameters:
+ message: string
+ isBase64: boolean
+
+ closePage:
+ parameters:
+ code: int?
+ reason: string?
+ wasClean: boolean
+
+ closeServer:
+ parameters:
+ code: int?
+ reason: string?
+ wasClean: boolean
+
+ResourceTiming:
+ type: object
+ properties:
+ startTime: float
+ domainLookupStart: float
+ domainLookupEnd: float
+ connectStart: float
+ secureConnectionStart: float
+ connectEnd: float
+ requestStart: float
+ responseStart: float
+
+Response:
+ type: interface
+
+ initializer:
+ request: Request
+ url: string
+ status: int
+ statusText: string
+ headers:
+ type: array
+ items: NameValue
+ timing: ResourceTiming
+ fromServiceWorker: boolean
+
+
+ commands:
+
+ body:
+ title: Get response body
+ group: getter
+ returns:
+ binary: binary
+
+ securityDetails:
+ internal: true
+ returns:
+ value: SecurityDetails?
+
+ serverAddr:
+ internal: true
+ returns:
+ value: RemoteAddr?
+
+ rawResponseHeaders:
+ internal: true
+ returns:
+ headers:
+ type: array
+ items: NameValue
+
+ httpVersion:
+ internal: true
+ returns:
+ value: string
+
+ sizes:
+ internal: true
+ returns:
+ sizes: RequestSizes
+
+SecurityDetails:
+ type: object
+ properties:
+ issuer: string?
+ protocol: string?
+ subjectName: string?
+ validFrom: float?
+ validTo: float?
+
+RequestSizes:
+ type: object
+ properties:
+ requestBodySize: int
+ requestHeadersSize: int
+ responseBodySize: int
+ responseHeadersSize: int
+
+RemoteAddr:
+ type: object
+ properties:
+ ipAddress: string
+ port: int
+
+WebSocket:
+ type: interface
+
+ extends: EventTarget
+
+ initializer:
+ url: string
+
+ events:
+ open:
+
+ frameSent:
+ parameters:
+ opcode: int
+ data: string
+
+ frameReceived:
+ parameters:
+ opcode: int
+ data: string
+
+ socketError:
+ parameters:
+ error: string
+
+ close:
diff --git a/packages/protocol/spec/page.yml b/packages/protocol/spec/page.yml
new file mode 100644
index 0000000000..4d9b1793b9
--- /dev/null
+++ b/packages/protocol/spec/page.yml
@@ -0,0 +1,666 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Page:
+ type: interface
+
+ extends: EventTarget
+
+ initializer:
+ mainFrame: Frame
+ viewportSize:
+ type: object?
+ properties:
+ width: int
+ height: int
+ isClosed: boolean
+ opener: Page?
+ video: Artifact?
+
+ commands:
+
+ addInitScript:
+ title: Add init script
+ group: configuration
+ parameters:
+ source: string
+ returns:
+ disposable: Disposable
+
+ close:
+ title: Close page
+ parameters:
+ runBeforeUnload: boolean?
+ reason: string?
+ flags:
+ pause: true
+
+ clearConsoleMessages:
+ title: Clear console messages
+
+ consoleMessages:
+ title: Get console messages
+ group: getter
+ parameters:
+ filter: ConsoleMessagesFilter?
+ returns:
+ messages:
+ type: array
+ items:
+ type: object
+ properties:
+ $mixin: ConsoleMessage
+
+ emulateMedia:
+ title: Emulate media
+ parameters:
+ media:
+ type: enum?
+ literals:
+ - screen
+ - print
+ - no-override
+ colorScheme:
+ type: enum?
+ literals:
+ - dark
+ - light
+ - no-preference
+ - no-override
+ reducedMotion:
+ type: enum?
+ literals:
+ - reduce
+ - no-preference
+ - no-override
+ forcedColors:
+ type: enum?
+ literals:
+ - active
+ - none
+ - no-override
+ contrast:
+ type: enum?
+ literals:
+ - no-preference
+ - more
+ - no-override
+ flags:
+ snapshot: true
+ pause: true
+
+ exposeBinding:
+ title: Expose binding
+ group: configuration
+ parameters:
+ name: string
+ returns:
+ disposable: Disposable
+
+ goBack:
+ title: Go back
+ parameters:
+ timeout: float
+ waitUntil: LifecycleEvent?
+ returns:
+ response: Response?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ goForward:
+ title: Go forward
+ parameters:
+ timeout: float
+ waitUntil: LifecycleEvent?
+ returns:
+ response: Response?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ requestGC:
+ title: Request garbage collection
+ group: configuration
+
+ registerLocatorHandler:
+ title: Register locator handler
+ parameters:
+ selector: string
+ noWaitAfter: boolean?
+ returns:
+ uid: int
+
+ resolveLocatorHandlerNoReply:
+ internal: true
+ parameters:
+ uid: int
+ remove: boolean?
+
+ unregisterLocatorHandler:
+ title: Unregister locator handler
+ parameters:
+ uid: int
+
+ reload:
+ title: Reload
+ parameters:
+ timeout: float
+ waitUntil: LifecycleEvent?
+ returns:
+ response: Response?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+
+ expectScreenshot:
+ title: Expect screenshot
+ parameters:
+ expected: binary?
+ timeout: float
+ isNot: boolean
+ locator:
+ type: object?
+ properties:
+ frame: Frame
+ selector: string
+ comparator: string?
+ maxDiffPixels: int?
+ maxDiffPixelRatio: float?
+ threshold: float?
+ fullPage: boolean?
+ clip: Rect?
+ $mixin: CommonScreenshotOptions
+ returns:
+ diff: binary?
+ errorMessage: string?
+ actual: binary?
+ previous: binary?
+ timedOut: boolean?
+ log:
+ type: array?
+ items: string
+ flags:
+ snapshot: true
+ pause: true
+
+ screenshot:
+ title: Screenshot
+ parameters:
+ timeout: float
+ type:
+ type: enum?
+ literals:
+ - png
+ - jpeg
+ quality: int?
+ fullPage: boolean?
+ clip: Rect?
+ $mixin: CommonScreenshotOptions
+ returns:
+ binary: binary
+ flags:
+ snapshot: true
+ pause: true
+
+ setExtraHTTPHeaders:
+ title: Set extra HTTP headers
+ group: configuration
+ parameters:
+ headers:
+ type: array
+ items: NameValue
+
+ setNetworkInterceptionPatterns:
+ title: Route requests
+ group: route
+ parameters:
+ patterns:
+ type: array
+ items:
+ type: object
+ properties:
+ glob: string?
+ regexSource: string?
+ regexFlags: string?
+ urlPattern: URLPattern?
+
+ setWebSocketInterceptionPatterns:
+ title: Route WebSockets
+ group: route
+ parameters:
+ patterns:
+ type: array
+ items:
+ type: object
+ properties:
+ glob: string?
+ regexSource: string?
+ regexFlags: string?
+ urlPattern: URLPattern?
+
+ setViewportSize:
+ title: Set viewport size
+ parameters:
+ viewportSize:
+ type: object
+ properties:
+ width: int
+ height: int
+ flags:
+ snapshot: true
+ pause: true
+
+ keyboardDown:
+ title: Key down "{key}"
+ parameters:
+ key: string
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ keyboardUp:
+ title: Key up "{key}"
+ parameters:
+ key: string
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ keyboardInsertText:
+ title: Insert "{text}"
+ parameters:
+ text: string
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ keyboardType:
+ title: Type "{text}"
+ parameters:
+ text: string
+ delay: float?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ keyboardPress:
+ title: Press "{key}"
+ parameters:
+ key: string
+ delay: float?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ mouseMove:
+ title: Mouse move
+ parameters:
+ x: float
+ y: float
+ steps: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ mouseDown:
+ title: Mouse down
+ parameters:
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ clickCount: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ mouseUp:
+ title: Mouse up
+ parameters:
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ clickCount: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ mouseClick:
+ title: Click
+ parameters:
+ x: float
+ y: float
+ delay: float?
+ button:
+ type: enum?
+ literals:
+ - left
+ - right
+ - middle
+ clickCount: int?
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ mouseWheel:
+ title: Mouse wheel
+ parameters:
+ deltaX: float
+ deltaY: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ touchscreenTap:
+ title: Tap
+ parameters:
+ x: float
+ y: float
+ flags:
+ slowMo: true
+ snapshot: true
+ pause: true
+ input: true
+
+ clearPageErrors:
+ title: Clear page errors
+
+ pageErrors:
+ title: Get page errors
+ group: getter
+ parameters:
+ filter: ConsoleMessagesFilter?
+ returns:
+ errors:
+ type: array
+ items: SerializedError
+
+ pdf:
+ title: PDF
+ parameters:
+ scale: float?
+ displayHeaderFooter: boolean?
+ headerTemplate: string?
+ footerTemplate: string?
+ printBackground: boolean?
+ landscape: boolean?
+ pageRanges: string?
+ format: string?
+ width: string?
+ height: string?
+ preferCSSPageSize: boolean?
+ margin:
+ type: object?
+ properties:
+ top: string?
+ bottom: string?
+ left: string?
+ right: string?
+ tagged: boolean?
+ outline: boolean?
+ returns:
+ pdf: binary
+
+ requests:
+ title: Get network requests
+ group: getter
+ returns:
+ requests:
+ type: array
+ items: Request
+
+ startJSCoverage:
+ title: Start JS coverage
+ group: configuration
+ parameters:
+ resetOnNavigation: boolean?
+ reportAnonymousScripts: boolean?
+
+ stopJSCoverage:
+ title: Stop JS coverage
+ group: configuration
+ returns:
+ entries:
+ type: array
+ items:
+ type: object
+ properties:
+ url: string
+ scriptId: string
+ source: string?
+ functions:
+ type: array
+ items:
+ type: object
+ properties:
+ functionName: string
+ isBlockCoverage: boolean
+ ranges:
+ type: array
+ items:
+ type: object
+ properties:
+ startOffset: int
+ endOffset: int
+ count: int
+
+ startCSSCoverage:
+ title: Start CSS coverage
+ group: configuration
+ parameters:
+ resetOnNavigation: boolean?
+
+ stopCSSCoverage:
+ title: Stop CSS coverage
+ group: configuration
+ returns:
+ entries:
+ type: array
+ items:
+ type: object
+ properties:
+ url: string
+ text: string?
+ ranges:
+ type: array
+ items:
+ type: object
+ properties:
+ start: int
+ end: int
+
+ bringToFront:
+ title: Bring to front
+
+ pickLocator:
+ title: Pick locator
+ group: configuration
+ returns:
+ selector: string
+
+ cancelPickLocator:
+ title: Cancel pick locator
+ group: configuration
+
+ hideHighlight:
+ title: Hide all element highlights
+ group: configuration
+
+ screencastShowOverlay:
+ title: Show overlay
+ group: configuration
+ parameters:
+ html: string
+ duration: float?
+ returns:
+ id: string
+
+ screencastRemoveOverlay:
+ title: Remove overlay
+ group: configuration
+ parameters:
+ id: string
+
+ screencastChapter:
+ title: Show chapter overlay
+ group: configuration
+ parameters:
+ title: string
+ description: string?
+ duration: float?
+
+ screencastSetOverlayVisible:
+ title: Set overlay visibility
+ group: configuration
+ parameters:
+ visible: boolean
+
+ screencastShowActions:
+ title: Show actions
+ group: configuration
+ parameters:
+ $mixin: ShowActionsOptions
+
+ screencastHideActions:
+ title: Remove actions
+ group: configuration
+
+ screencastStart:
+ title: Start screencast
+ group: configuration
+ parameters:
+ size:
+ type: object?
+ properties:
+ width: int
+ height: int
+ quality: int?
+ sendFrames: boolean?
+ record: boolean?
+ returns:
+ artifact: Artifact?
+
+ screencastStop:
+ title: Stop screencast
+ group: configuration
+
+ updateSubscription:
+ internal: true
+ parameters:
+ event:
+ type: enum
+ literals:
+ - console
+ - dialog
+ - fileChooser
+ - request
+ - response
+ - requestFinished
+ - requestFailed
+ enabled: boolean
+
+ setDockTile:
+ internal: true
+ parameters:
+ image: binary
+
+ events:
+
+ bindingCall:
+ parameters:
+ binding: BindingCall
+
+ close:
+
+ crash:
+
+ download:
+ parameters:
+ url: string
+ suggestedFilename: string
+ artifact: Artifact
+
+ viewportSizeChanged:
+ parameters:
+ viewportSize:
+ type: object?
+ properties:
+ width: int
+ height: int
+
+ fileChooser:
+ parameters:
+ element: ElementHandle
+ isMultiple: boolean
+
+ frameAttached:
+ parameters:
+ frame: Frame
+
+ frameDetached:
+ parameters:
+ frame: Frame
+
+ locatorHandlerTriggered:
+ parameters:
+ uid: int
+
+ route:
+ parameters:
+ route: Route
+
+ screencastFrame:
+ parameters:
+ data: binary
+
+ webSocketRoute:
+ parameters:
+ webSocketRoute: WebSocketRoute
+
+ webSocket:
+ parameters:
+ webSocket: WebSocket
+
+ worker:
+ parameters:
+ worker: Worker
diff --git a/packages/protocol/spec/playwright.yml b/packages/protocol/spec/playwright.yml
new file mode 100644
index 0000000000..e585848d37
--- /dev/null
+++ b/packages/protocol/spec/playwright.yml
@@ -0,0 +1,493 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Root:
+ type: interface
+
+ commands:
+
+ initialize:
+ internal: true
+ parameters:
+ sdkLanguage: SDKLanguage
+ returns:
+ playwright: Playwright
+
+Playwright:
+ type: interface
+
+ initializer:
+ chromium: BrowserType
+ firefox: BrowserType
+ webkit: BrowserType
+ android: Android
+ utils: LocalUtils?
+ # Only present when connecting remotely via BrowserType.connect() method.
+ preLaunchedBrowser: Browser?
+ # Only present when connecting remotely via Android.connect() method.
+ preConnectedAndroidDevice: AndroidDevice?
+ # Only present when socks proxy is supported.
+ socksSupport: SocksSupport?
+
+ commands:
+ newRequest:
+ title: Create request context
+ parameters:
+ baseURL: string?
+ userAgent: string?
+ ignoreHTTPSErrors: boolean?
+ extraHTTPHeaders:
+ type: array?
+ items: NameValue
+ failOnStatusCode: boolean?
+ clientCertificates:
+ type: array?
+ items:
+ type: object
+ properties:
+ origin: string
+ cert: binary?
+ key: binary?
+ passphrase: string?
+ pfx: binary?
+ maxRedirects: int?
+ httpCredentials:
+ type: object?
+ properties:
+ username: string
+ password: string
+ origin: string?
+ send:
+ type: enum?
+ literals:
+ - always
+ - unauthorized
+ proxy:
+ type: object?
+ properties:
+ server: string
+ bypass: string?
+ username: string?
+ password: string?
+ storageState:
+ type: object?
+ properties:
+ cookies:
+ type: array?
+ items: NetworkCookie
+ origins:
+ type: array?
+ items: SetOriginStorage
+ tracesDir: string?
+
+ returns:
+ request: APIRequestContext
+
+DebugController:
+ type: interface
+
+ commands:
+ initialize:
+ internal: true
+ parameters:
+ codegenId: string
+ sdkLanguage: SDKLanguage
+
+ setReportStateChanged:
+ internal: true
+ parameters:
+ enabled: boolean
+
+ setRecorderMode:
+ internal: true
+ parameters:
+ mode:
+ type: enum
+ literals:
+ - inspecting
+ - recording
+ - none
+ testIdAttributeName: string?
+ generateAutoExpect: boolean?
+
+ highlight:
+ internal: true
+ parameters:
+ selector: string?
+ ariaTemplate: string?
+
+ hideHighlight:
+ internal: true
+
+ resume:
+ internal: true
+
+ kill:
+ internal: true
+
+ events:
+ inspectRequested:
+ parameters:
+ selector: string
+ locator: string
+ ariaSnapshot: string
+
+ setModeRequested:
+ parameters:
+ mode: string
+
+ stateChanged:
+ parameters:
+ pageCount: int
+
+ sourceChanged:
+ parameters:
+ text: string
+ header: string?
+ footer: string?
+ actions:
+ type: array?
+ items: string
+
+ paused:
+ parameters:
+ paused: boolean
+
+SocksSupport:
+ type: interface
+
+ commands:
+ socksConnected:
+ internal: true
+ parameters:
+ uid: string
+ host: string
+ port: int
+
+ socksFailed:
+ internal: true
+ parameters:
+ uid: string
+ errorCode: string
+
+ socksData:
+ internal: true
+ parameters:
+ uid: string
+ data: binary
+
+ socksError:
+ internal: true
+ parameters:
+ uid: string
+ error: string
+
+ socksEnd:
+ internal: true
+ parameters:
+ uid: string
+
+ events:
+ socksRequested:
+ parameters:
+ uid: string
+ host: string
+ port: int
+
+ socksData:
+ parameters:
+ uid: string
+ data: binary
+
+ socksClosed:
+ parameters:
+ uid: string
+
+JsonPipe:
+ type: interface
+
+ commands:
+ send:
+ internal: true
+ parameters:
+ message: json
+
+ close:
+ internal: true
+
+ events:
+
+ message:
+ parameters:
+ message: json
+
+ closed:
+ parameters:
+ reason: string?
+
+ExpectedTextValue:
+ type: object
+ properties:
+ string: string?
+ regexSource: string?
+ regexFlags: string?
+ matchSubstring: boolean?
+ ignoreCase: boolean?
+ normalizeWhiteSpace: boolean?
+
+SelectorEngine:
+ type: object
+ properties:
+ name: string
+ source: string
+ contentScript: boolean?
+
+
+FormField:
+ type: object
+ properties:
+ name: string
+ value: string?
+ file:
+ type: object?
+ properties:
+ name: string
+ mimeType: string?
+ buffer: binary
+
+LifecycleEvent:
+ type: enum
+ literals:
+ - load
+ - domcontentloaded
+ - networkidle
+ - commit
+
+ConsoleMessagesFilter:
+ type: enum
+ literals:
+ - all
+ - since-navigation
+
+RecorderSource:
+ type: object
+ properties:
+ isRecorded: boolean
+ id: string
+ label: string
+ text: string
+ language: string
+ highlight:
+ type: array
+ items:
+ type: object
+ properties:
+ line: int
+ type: string
+ revealLine: int?
+ group: string?
+
+IndexedDBDatabase:
+ type: object
+ properties:
+ name: string
+ version: int
+ stores:
+ type: array
+ items:
+ type: object
+ properties:
+ name: string
+ autoIncrement: boolean
+ keyPath: string?
+ keyPathArray:
+ type: array?
+ items: string
+ records:
+ type: array
+ items:
+ type: object
+ properties:
+ key: json?
+ keyEncoded: json?
+ value: json?
+ valueEncoded: json?
+ indexes:
+ type: array
+ items:
+ type: object
+ properties:
+ name: string
+ keyPath: string?
+ keyPathArray:
+ type: array?
+ items: string
+ multiEntry: boolean
+ unique: boolean
+
+SetOriginStorage:
+ type: object
+ properties:
+ origin: string
+ localStorage:
+ type: array
+ items: NameValue
+ indexedDB:
+ type: array?
+ items: IndexedDBDatabase
+
+OriginStorage:
+ type: object
+ properties:
+ origin: string
+ localStorage:
+ type: array
+ items: NameValue
+ indexedDB:
+ type: array?
+ items: IndexedDBDatabase
+
+RecordHarOptions:
+ type: object
+ properties:
+ content:
+ type: enum?
+ literals:
+ - embed
+ - attach
+ - omit
+ mode:
+ type: enum?
+ literals:
+ - full
+ - minimal
+ urlGlob: string?
+ urlRegexSource: string?
+ urlRegexFlags: string?
+ harPath: string?
+ resourcesDir: string?
+
+CDPSession:
+ type: interface
+
+ commands:
+
+ send:
+ title: Send CDP command
+ group: configuration
+ parameters:
+ method: string
+ params: json?
+ returns:
+ result: json
+
+ detach:
+ title: Detach CDP session
+ group: configuration
+
+ events:
+
+ event:
+ parameters:
+ method: string
+ params: json?
+
+ close:
+
+BindingCall:
+ type: interface
+
+ initializer:
+ frame: Frame
+ name: string
+ args:
+ type: array
+ items: SerializedValue
+
+ commands:
+
+ reject:
+ internal: true
+ parameters:
+ error: SerializedError
+
+ resolve:
+ internal: true
+ parameters:
+ result: SerializedArgument
+
+Debugger:
+ type: interface
+
+ extends: EventTarget
+
+ commands:
+
+ requestPause:
+ title: Pause on next call
+ group: configuration
+
+ resume:
+ title: Resume
+ group: configuration
+
+ next:
+ title: Step to next call
+ group: configuration
+
+ runTo:
+ title: Run to location
+ group: configuration
+ parameters:
+ location:
+ type: object
+ properties:
+ file: string
+ line: int?
+ column: int?
+
+ events:
+
+ pausedStateChanged:
+ parameters:
+ pausedDetails:
+ type: object?
+ properties:
+ location:
+ type: object
+ properties:
+ file: string
+ line: int?
+ column: int?
+ title: string
+ stack: string?
+
+Dialog:
+ type: interface
+
+ initializer:
+ page: Page?
+ type: string
+ message: string
+ defaultValue: string
+
+ commands:
+
+ accept:
+ title: Accept dialog
+ parameters:
+ promptText: string?
+
+ dismiss:
+ title: Dismiss dialog
diff --git a/packages/protocol/spec/serialized.yml b/packages/protocol/spec/serialized.yml
new file mode 100644
index 0000000000..1457d5f891
--- /dev/null
+++ b/packages/protocol/spec/serialized.yml
@@ -0,0 +1,104 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SerializedValue:
+ type: object
+ # Exactly one of the properties must be present.
+ properties:
+ n: float?
+ b: boolean?
+ s: string?
+ v:
+ type: enum?
+ literals:
+ - null
+ - undefined
+ - NaN
+ - Infinity
+ - -Infinity
+ - "-0"
+ # String representation of the Date.
+ d: string?
+ # String representation of the URL.
+ u: string?
+ # String representation of BigInt.
+ bi: string?
+ # Typed array.
+ ta:
+ type: object?
+ properties:
+ b: binary
+ k:
+ type: enum
+ literals:
+ - i8
+ - ui8
+ - ui8c
+ - i16
+ - ui16
+ - i32
+ - ui32
+ - f32
+ - f64
+ - bi64
+ - bui64
+ # Serialized Error object.
+ e:
+ type: object?
+ properties:
+ m: string
+ n: string
+ s: string
+ # Regular expression pattern and flags.
+ r:
+ type: object?
+ properties:
+ p: string
+ f: string
+ a:
+ type: array?
+ items: SerializedValue
+ # Object with keys and values.
+ o:
+ type: array?
+ items:
+ type: object
+ properties:
+ k: string
+ v: SerializedValue
+ # An index in the handles array from SerializedArgument.
+ h: int?
+ # Index of the object in value-type for circular reference resolution.
+ id: int?
+ # Ref to the object in value-type for circular reference resolution.
+ ref: int?
+
+SerializedArgument:
+ type: object
+ properties:
+ value: SerializedValue
+ handles:
+ type: array
+ items: Channel
+
+SerializedError:
+ type: object
+ properties:
+ error:
+ type: object?
+ properties:
+ message: string
+ name: string
+ stack: string?
+ value: SerializedValue?
diff --git a/packages/protocol/spec/structs.yml b/packages/protocol/spec/structs.yml
new file mode 100644
index 0000000000..2f8bcb44b5
--- /dev/null
+++ b/packages/protocol/spec/structs.yml
@@ -0,0 +1,53 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+StackFrame:
+ type: object
+ properties:
+ file: string
+ line: int
+ column: int
+ function: string?
+
+Point:
+ type: object
+ properties:
+ x: float
+ y: float
+
+Rect:
+ type: object
+ properties:
+ x: float
+ y: float
+ width: float
+ height: float
+
+URLPattern:
+ type: object
+ properties:
+ hash: string
+ hostname: string
+ password: string
+ pathname: string
+ port: string
+ protocol: string
+ search: string
+ username: string
+
+NameValue:
+ type: object
+ properties:
+ name: string
+ value: string
diff --git a/packages/protocol/spec/tracing.yml b/packages/protocol/spec/tracing.yml
new file mode 100644
index 0000000000..499fa9019e
--- /dev/null
+++ b/packages/protocol/spec/tracing.yml
@@ -0,0 +1,98 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Tracing:
+ type: interface
+
+ commands:
+
+ tracingStart:
+ title: Start tracing
+ group: configuration
+ parameters:
+ name: string?
+ snapshots: boolean?
+ screenshots: boolean?
+ live: boolean?
+
+ tracingStartChunk:
+ title: Start tracing
+ group: configuration
+ parameters:
+ name: string?
+ title: string?
+ returns:
+ traceName: string
+
+ tracingGroup:
+ title: Trace "{name}"
+ parameters:
+ name: string
+ location:
+ type: object?
+ properties:
+ file: string
+ line: int?
+ column: int?
+
+ tracingGroupEnd:
+ title: Group end
+
+ tracingStopChunk:
+ title: Stop tracing
+ group: configuration
+ parameters:
+ mode:
+ type: enum
+ literals:
+ - archive
+ - discard
+ - entries
+ returns:
+ # The artifact may be missing if the browser closes while tracing is being stopped.
+ # Or it can be missing if client-side compression is taking place.
+ artifact: Artifact?
+ # For local mode, these are all entries.
+ entries:
+ type: array?
+ items: NameValue
+
+ tracingStop:
+ title: Stop tracing
+ group: configuration
+
+ harStart:
+ internal: true
+ parameters:
+ page: Page?
+ options: RecordHarOptions
+ returns:
+ harId: string
+
+ harExport:
+ internal: true
+ parameters:
+ harId: string?
+ mode:
+ type: enum
+ literals:
+ - archive
+ - entries
+ returns:
+ # Present when mode is 'archive'.
+ artifact: Artifact?
+ # Present when mode is 'entries'.
+ entries:
+ type: array?
+ items: NameValue
diff --git a/packages/protocol/spec/worker.yml b/packages/protocol/spec/worker.yml
new file mode 100644
index 0000000000..3588726308
--- /dev/null
+++ b/packages/protocol/spec/worker.yml
@@ -0,0 +1,65 @@
+# Copyright (c) Microsoft Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Worker:
+ type: interface
+
+ extends: EventTarget
+
+ initializer:
+ url: string
+
+ commands:
+
+ disconnect:
+ title: Disconnect from worker
+ parameters:
+ reason: string?
+ flags:
+ pausesBeforeAction: true
+
+ evaluateExpression:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ value: SerializedValue
+
+ evaluateExpressionHandle:
+ title: Evaluate
+ parameters:
+ expression: string
+ isFunction: boolean?
+ arg: SerializedArgument
+ returns:
+ handle: JSHandle
+
+ updateSubscription:
+ internal: true
+ parameters:
+ event:
+ type: enum
+ literals:
+ - console
+ enabled: boolean
+
+ events:
+
+ console:
+ parameters:
+ $mixin: ConsoleMessage
+
+ close:
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index e43bf63f90..edb828825b 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -26,612 +26,375 @@ export interface Channel {
// ----------- Initializer Traits -----------
export type InitializerTraits<T> =
- T extends JsonPipeChannel ? JsonPipeInitializer :
T extends AndroidDeviceChannel ? AndroidDeviceInitializer :
- T extends AndroidSocketChannel ? AndroidSocketInitializer :
- T extends AndroidChannel ? AndroidInitializer :
- T extends CDPSessionChannel ? CDPSessionInitializer :
- T extends WritableStreamChannel ? WritableStreamInitializer :
- T extends StreamChannel ? StreamInitializer :
- T extends ArtifactChannel ? ArtifactInitializer :
- T extends TracingChannel ? TracingInitializer :
- T extends DialogChannel ? DialogInitializer :
- T extends DebuggerChannel ? DebuggerInitializer :
- T extends BindingCallChannel ? BindingCallInitializer :
- T extends WebSocketChannel ? WebSocketInitializer :
- T extends ResponseChannel ? ResponseInitializer :
- T extends WebSocketRouteChannel ? WebSocketRouteInitializer :
- T extends RouteChannel ? RouteInitializer :
- T extends RequestChannel ? RequestInitializer :
+ T extends BrowserContextChannel ? BrowserContextInitializer :
T extends ElementHandleChannel ? ElementHandleInitializer :
- T extends JSHandleChannel ? JSHandleInitializer :
- T extends DisposableChannel ? DisposableInitializer :
- T extends WorkerChannel ? WorkerInitializer :
- T extends FrameChannel ? FrameInitializer :
+ T extends WebSocketChannel ? WebSocketInitializer :
T extends PageChannel ? PageInitializer :
- T extends BrowserContextChannel ? BrowserContextInitializer :
- T extends EventTargetChannel ? EventTargetInitializer :
+ T extends DebuggerChannel ? DebuggerInitializer :
+ T extends WorkerChannel ? WorkerInitializer :
+ T extends AndroidChannel ? AndroidInitializer :
+ T extends AndroidSocketChannel ? AndroidSocketInitializer :
+ T extends APIRequestContextChannel ? APIRequestContextInitializer :
+ T extends ArtifactChannel ? ArtifactInitializer :
+ T extends StreamChannel ? StreamInitializer :
+ T extends WritableStreamChannel ? WritableStreamInitializer :
T extends BrowserChannel ? BrowserInitializer :
T extends BrowserTypeChannel ? BrowserTypeInitializer :
- T extends SocksSupportChannel ? SocksSupportInitializer :
- T extends DebugControllerChannel ? DebugControllerInitializer :
- T extends PlaywrightChannel ? PlaywrightInitializer :
- T extends RootChannel ? RootInitializer :
+ T extends DisposableChannel ? DisposableInitializer :
+ T extends EventTargetChannel ? EventTargetInitializer :
+ T extends FrameChannel ? FrameInitializer :
+ T extends JSHandleChannel ? JSHandleInitializer :
T extends LocalUtilsChannel ? LocalUtilsInitializer :
- T extends APIRequestContextChannel ? APIRequestContextInitializer :
+ T extends RequestChannel ? RequestInitializer :
+ T extends RouteChannel ? RouteInitializer :
+ T extends WebSocketRouteChannel ? WebSocketRouteInitializer :
+ T extends ResponseChannel ? ResponseInitializer :
+ T extends RootChannel ? RootInitializer :
+ T extends PlaywrightChannel ? PlaywrightInitializer :
+ T extends DebugControllerChannel ? DebugControllerInitializer :
+ T extends SocksSupportChannel ? SocksSupportInitializer :
+ T extends JsonPipeChannel ? JsonPipeInitializer :
+ T extends CDPSessionChannel ? CDPSessionInitializer :
+ T extends BindingCallChannel ? BindingCallInitializer :
+ T extends DialogChannel ? DialogInitializer :
+ T extends TracingChannel ? TracingInitializer :
object;
// ----------- Event Traits -----------
export type EventsTraits<T> =
- T extends JsonPipeChannel ? JsonPipeEvents :
T extends AndroidDeviceChannel ? AndroidDeviceEvents :
- T extends AndroidSocketChannel ? AndroidSocketEvents :
- T extends AndroidChannel ? AndroidEvents :
- T extends CDPSessionChannel ? CDPSessionEvents :
- T extends WritableStreamChannel ? WritableStreamEvents :
- T extends StreamChannel ? StreamEvents :
- T extends ArtifactChannel ? ArtifactEvents :
- T extends TracingChannel ? TracingEvents :
- T extends DialogChannel ? DialogEvents :
- T extends DebuggerChannel ? DebuggerEvents :
- T extends BindingCallChannel ? BindingCallEvents :
- T extends WebSocketChannel ? WebSocketEvents :
- T extends ResponseChannel ? ResponseEvents :
- T extends WebSocketRouteChannel ? WebSocketRouteEvents :
- T extends RouteChannel ? RouteEvents :
- T extends RequestChannel ? RequestEvents :
+ T extends BrowserContextChannel ? BrowserContextEvents :
T extends ElementHandleChannel ? ElementHandleEvents :
- T extends JSHandleChannel ? JSHandleEvents :
- T extends DisposableChannel ? DisposableEvents :
- T extends WorkerChannel ? WorkerEvents :
- T extends FrameChannel ? FrameEvents :
+ T extends WebSocketChannel ? WebSocketEvents :
T extends PageChannel ? PageEvents :
- T extends BrowserContextChannel ? BrowserContextEvents :
- T extends EventTargetChannel ? EventTargetEvents :
+ T extends DebuggerChannel ? DebuggerEvents :
+ T extends WorkerChannel ? WorkerEvents :
+ T extends AndroidChannel ? AndroidEvents :
+ T extends AndroidSocketChannel ? AndroidSocketEvents :
+ T extends APIRequestContextChannel ? APIRequestContextEvents :
+ T extends ArtifactChannel ? ArtifactEvents :
+ T extends StreamChannel ? StreamEvents :
+ T extends WritableStreamChannel ? WritableStreamEvents :
T extends BrowserChannel ? BrowserEvents :
T extends BrowserTypeChannel ? BrowserTypeEvents :
- T extends SocksSupportChannel ? SocksSupportEvents :
- T extends DebugControllerChannel ? DebugControllerEvents :
- T extends PlaywrightChannel ? PlaywrightEvents :
- T extends RootChannel ? RootEvents :
+ T extends DisposableChannel ? DisposableEvents :
+ T extends EventTargetChannel ? EventTargetEvents :
+ T extends FrameChannel ? FrameEvents :
+ T extends JSHandleChannel ? JSHandleEvents :
T extends LocalUtilsChannel ? LocalUtilsEvents :
- T extends APIRequestContextChannel ? APIRequestContextEvents :
+ T extends RequestChannel ? RequestEvents :
+ T extends RouteChannel ? RouteEvents :
+ T extends WebSocketRouteChannel ? WebSocketRouteEvents :
+ T extends ResponseChannel ? ResponseEvents :
+ T extends RootChannel ? RootEvents :
+ T extends PlaywrightChannel ? PlaywrightEvents :
+ T extends DebugControllerChannel ? DebugControllerEvents :
+ T extends SocksSupportChannel ? SocksSupportEvents :
+ T extends JsonPipeChannel ? JsonPipeEvents :
+ T extends CDPSessionChannel ? CDPSessionEvents :
+ T extends BindingCallChannel ? BindingCallEvents :
+ T extends DialogChannel ? DialogEvents :
+ T extends TracingChannel ? TracingEvents :
undefined;
// ----------- EventTarget Traits -----------
export type EventTargetTraits<T> =
- T extends JsonPipeChannel ? JsonPipeEventTarget :
T extends AndroidDeviceChannel ? AndroidDeviceEventTarget :
- T extends AndroidSocketChannel ? AndroidSocketEventTarget :
- T extends AndroidChannel ? AndroidEventTarget :
- T extends CDPSessionChannel ? CDPSessionEventTarget :
- T extends WritableStreamChannel ? WritableStreamEventTarget :
- T extends StreamChannel ? StreamEventTarget :
- T extends ArtifactChannel ? ArtifactEventTarget :
- T extends TracingChannel ? TracingEventTarget :
- T extends DialogChannel ? DialogEventTarget :
- T extends DebuggerChannel ? DebuggerEventTarget :
- T extends BindingCallChannel ? BindingCallEventTarget :
- T extends WebSocketChannel ? WebSocketEventTarget :
- T extends ResponseChannel ? ResponseEventTarget :
- T extends WebSocketRouteChannel ? WebSocketRouteEventTarget :
- T extends RouteChannel ? RouteEventTarget :
- T extends RequestChannel ? RequestEventTarget :
+ T extends BrowserContextChannel ? BrowserContextEventTarget :
T extends ElementHandleChannel ? ElementHandleEventTarget :
- T extends JSHandleChannel ? JSHandleEventTarget :
- T extends DisposableChannel ? DisposableEventTarget :
- T extends WorkerChannel ? WorkerEventTarget :
- T extends FrameChannel ? FrameEventTarget :
+ T extends WebSocketChannel ? WebSocketEventTarget :
T extends PageChannel ? PageEventTarget :
- T extends BrowserContextChannel ? BrowserContextEventTarget :
- T extends EventTargetChannel ? EventTargetEventTarget :
+ T extends DebuggerChannel ? DebuggerEventTarget :
+ T extends WorkerChannel ? WorkerEventTarget :
+ T extends AndroidChannel ? AndroidEventTarget :
+ T extends AndroidSocketChannel ? AndroidSocketEventTarget :
+ T extends APIRequestContextChannel ? APIRequestContextEventTarget :
+ T extends ArtifactChannel ? ArtifactEventTarget :
+ T extends StreamChannel ? StreamEventTarget :
+ T extends WritableStreamChannel ? WritableStreamEventTarget :
T extends BrowserChannel ? BrowserEventTarget :
T extends BrowserTypeChannel ? BrowserTypeEventTarget :
- T extends SocksSupportChannel ? SocksSupportEventTarget :
- T extends DebugControllerChannel ? DebugControllerEventTarget :
- T extends PlaywrightChannel ? PlaywrightEventTarget :
- T extends RootChannel ? RootEventTarget :
+ T extends DisposableChannel ? DisposableEventTarget :
+ T extends EventTargetChannel ? EventTargetEventTarget :
+ T extends FrameChannel ? FrameEventTarget :
+ T extends JSHandleChannel ? JSHandleEventTarget :
T extends LocalUtilsChannel ? LocalUtilsEventTarget :
- T extends APIRequestContextChannel ? APIRequestContextEventTarget :
+ T extends RequestChannel ? RequestEventTarget :
+ T extends RouteChannel ? RouteEventTarget :
+ T extends WebSocketRouteChannel ? WebSocketRouteEventTarget :
+ T extends ResponseChannel ? ResponseEventTarget :
+ T extends RootChannel ? RootEventTarget :
+ T extends PlaywrightChannel ? PlaywrightEventTarget :
+ T extends DebugControllerChannel ? DebugControllerEventTarget :
+ T extends SocksSupportChannel ? SocksSupportEventTarget :
+ T extends JsonPipeChannel ? JsonPipeEventTarget :
+ T extends CDPSessionChannel ? CDPSessionEventTarget :
+ T extends BindingCallChannel ? BindingCallEventTarget :
+ T extends DialogChannel ? DialogEventTarget :
+ T extends TracingChannel ? TracingEventTarget :
undefined;
-export type StackFrame = {
- file: string,
- line: number,
- column: number,
- function?: string,
+// ----------- Android -----------
+export type AndroidInitializer = {};
+export interface AndroidEventTarget {
+}
+export interface AndroidChannel extends AndroidEventTarget, Channel {
+ _type_Android: boolean;
+ devices(params: AndroidDevicesParams, progress?: Progress): Promise<AndroidDevicesResult>;
+}
+export type AndroidDevicesParams = {
+ host?: string,
+ port?: number,
+ omitDriverInstall?: boolean,
};
-
-export type Metadata = {
- location?: {
- file: string,
- line?: number,
- column?: number,
- },
- title?: string,
- internal?: boolean,
- stepId?: string,
+export type AndroidDevicesOptions = {
+ host?: string,
+ port?: number,
+ omitDriverInstall?: boolean,
};
-
-export type ClientSideCallMetadata = {
- id: number,
- stack?: StackFrame[],
+export type AndroidDevicesResult = {
+ devices: AndroidDeviceChannel[],
};
-export type Point = {
- x: number,
- y: number,
+export interface AndroidEvents {
+}
+
+// ----------- AndroidSocket -----------
+export type AndroidSocketInitializer = {};
+export interface AndroidSocketEventTarget {
+ on(event: 'data', callback: (params: AndroidSocketDataEvent) => void): this;
+ on(event: 'close', callback: (params: AndroidSocketCloseEvent) => void): this;
+}
+export interface AndroidSocketChannel extends AndroidSocketEventTarget, Channel {
+ _type_AndroidSocket: boolean;
+ write(params: AndroidSocketWriteParams, progress?: Progress): Promise<AndroidSocketWriteResult>;
+ close(params?: AndroidSocketCloseParams, progress?: Progress): Promise<AndroidSocketCloseResult>;
+}
+export type AndroidSocketDataEvent = {
+ data: Binary,
+};
+export type AndroidSocketCloseEvent = {};
+export type AndroidSocketWriteParams = {
+ data: Binary,
};
+export type AndroidSocketWriteOptions = {
-export type Rect = {
- x: number,
- y: number,
- width: number,
- height: number,
};
+export type AndroidSocketWriteResult = void;
+export type AndroidSocketCloseParams = {};
+export type AndroidSocketCloseOptions = {};
+export type AndroidSocketCloseResult = void;
-export type SerializedValue = {
- n?: number,
- b?: boolean,
- s?: string,
- v?: 'null' | 'undefined' | 'NaN' | 'Infinity' | '-Infinity' | '-0',
- d?: string,
- u?: string,
- bi?: string,
- ta?: {
- b: Binary,
- k: 'i8' | 'ui8' | 'ui8c' | 'i16' | 'ui16' | 'i32' | 'ui32' | 'f32' | 'f64' | 'bi64' | 'bui64',
- },
- e?: {
- m: string,
- n: string,
- s: string,
- },
- r?: {
- p: string,
- f: string,
- },
- a?: SerializedValue[],
- o?: {
- k: string,
- v: SerializedValue,
- }[],
- h?: number,
- id?: number,
- ref?: number,
-};
+export interface AndroidSocketEvents {
+ 'data': AndroidSocketDataEvent;
+ 'close': AndroidSocketCloseEvent;
+}
-export type SerializedArgument = {
- value: SerializedValue,
- handles: Channel[],
+// ----------- AndroidDevice -----------
+export type AndroidDeviceInitializer = {
+ model: string,
+ serial: string,
};
-
-export type ExpectedTextValue = {
- string?: string,
- regexSource?: string,
- regexFlags?: string,
- matchSubstring?: boolean,
- ignoreCase?: boolean,
- normalizeWhiteSpace?: boolean,
+export interface AndroidDeviceEventTarget {
+ on(event: 'close', callback: (params: AndroidDeviceCloseEvent) => void): this;
+ on(event: 'webViewAdded', callback: (params: AndroidDeviceWebViewAddedEvent) => void): this;
+ on(event: 'webViewRemoved', callback: (params: AndroidDeviceWebViewRemovedEvent) => void): this;
+}
+export interface AndroidDeviceChannel extends AndroidDeviceEventTarget, EventTargetChannel {
+ _type_AndroidDevice: boolean;
+ wait(params: AndroidDeviceWaitParams, progress?: Progress): Promise<AndroidDeviceWaitResult>;
+ fill(params: AndroidDeviceFillParams, progress?: Progress): Promise<AndroidDeviceFillResult>;
+ tap(params: AndroidDeviceTapParams, progress?: Progress): Promise<AndroidDeviceTapResult>;
+ drag(params: AndroidDeviceDragParams, progress?: Progress): Promise<AndroidDeviceDragResult>;
+ fling(params: AndroidDeviceFlingParams, progress?: Progress): Promise<AndroidDeviceFlingResult>;
+ longTap(params: AndroidDeviceLongTapParams, progress?: Progress): Promise<AndroidDeviceLongTapResult>;
+ pinchClose(params: AndroidDevicePinchCloseParams, progress?: Progress): Promise<AndroidDevicePinchCloseResult>;
+ pinchOpen(params: AndroidDevicePinchOpenParams, progress?: Progress): Promise<AndroidDevicePinchOpenResult>;
+ scroll(params: AndroidDeviceScrollParams, progress?: Progress): Promise<AndroidDeviceScrollResult>;
+ swipe(params: AndroidDeviceSwipeParams, progress?: Progress): Promise<AndroidDeviceSwipeResult>;
+ info(params: AndroidDeviceInfoParams, progress?: Progress): Promise<AndroidDeviceInfoResult>;
+ screenshot(params?: AndroidDeviceScreenshotParams, progress?: Progress): Promise<AndroidDeviceScreenshotResult>;
+ inputType(params: AndroidDeviceInputTypeParams, progress?: Progress): Promise<AndroidDeviceInputTypeResult>;
+ inputPress(params: AndroidDeviceInputPressParams, progress?: Progress): Promise<AndroidDeviceInputPressResult>;
+ inputTap(params: AndroidDeviceInputTapParams, progress?: Progress): Promise<AndroidDeviceInputTapResult>;
+ inputSwipe(params: AndroidDeviceInputSwipeParams, progress?: Progress): Promise<AndroidDeviceInputSwipeResult>;
+ inputDrag(params: AndroidDeviceInputDragParams, progress?: Progress): Promise<AndroidDeviceInputDragResult>;
+ launchBrowser(params: AndroidDeviceLaunchBrowserParams, progress?: Progress): Promise<AndroidDeviceLaunchBrowserResult>;
+ open(params: AndroidDeviceOpenParams, progress?: Progress): Promise<AndroidDeviceOpenResult>;
+ shell(params: AndroidDeviceShellParams, progress?: Progress): Promise<AndroidDeviceShellResult>;
+ installApk(params: AndroidDeviceInstallApkParams, progress?: Progress): Promise<AndroidDeviceInstallApkResult>;
+ push(params: AndroidDevicePushParams, progress?: Progress): Promise<AndroidDevicePushResult>;
+ connectToWebView(params: AndroidDeviceConnectToWebViewParams, progress?: Progress): Promise<AndroidDeviceConnectToWebViewResult>;
+ close(params?: AndroidDeviceCloseParams, progress?: Progress): Promise<AndroidDeviceCloseResult>;
+}
+export type AndroidDeviceCloseEvent = {};
+export type AndroidDeviceWebViewAddedEvent = {
+ webView: AndroidWebView,
};
-
-export type SelectorEngine = {
- name: string,
- source: string,
- contentScript?: boolean,
+export type AndroidDeviceWebViewRemovedEvent = {
+ socketName: string,
};
-
-export type URLPattern = {
- hash: string,
- hostname: string,
- password: string,
- pathname: string,
- port: string,
- protocol: string,
- search: string,
- username: string,
+export type AndroidDeviceWaitParams = {
+ androidSelector: AndroidSelector,
+ state?: 'gone',
+ timeout: number,
};
-
-export type SetNetworkCookie = {
- name: string,
- value: string,
- url?: string,
- domain?: string,
- path?: string,
- expires?: number,
- httpOnly?: boolean,
- secure?: boolean,
- sameSite?: 'Strict' | 'Lax' | 'None',
- partitionKey?: string,
- _crHasCrossSiteAncestor?: boolean,
+export type AndroidDeviceWaitOptions = {
+ state?: 'gone',
};
-
-export type NetworkCookie = {
- name: string,
- value: string,
- domain: string,
- path: string,
- expires: number,
- httpOnly: boolean,
- secure: boolean,
- sameSite: 'Strict' | 'Lax' | 'None',
- partitionKey?: string,
- _crHasCrossSiteAncestor?: boolean,
+export type AndroidDeviceWaitResult = void;
+export type AndroidDeviceFillParams = {
+ androidSelector: AndroidSelector,
+ text: string,
+ timeout: number,
};
+export type AndroidDeviceFillOptions = {
-export type NameValue = {
- name: string,
- value: string,
};
-
-export type IndexedDBDatabase = {
- name: string,
- version: number,
- stores: {
- name: string,
- autoIncrement: boolean,
- keyPath?: string,
- keyPathArray?: string[],
- records: {
- key?: any,
- keyEncoded?: any,
- value?: any,
- valueEncoded?: any,
- }[],
- indexes: {
- name: string,
- keyPath?: string,
- keyPathArray?: string[],
- multiEntry: boolean,
- unique: boolean,
- }[],
- }[],
+export type AndroidDeviceFillResult = void;
+export type AndroidDeviceTapParams = {
+ androidSelector: AndroidSelector,
+ duration?: number,
+ timeout: number,
};
-
-export type SetOriginStorage = {
- origin: string,
- localStorage: NameValue[],
- indexedDB?: IndexedDBDatabase[],
+export type AndroidDeviceTapOptions = {
+ duration?: number,
};
-
-export type OriginStorage = {
- origin: string,
- localStorage: NameValue[],
- indexedDB?: IndexedDBDatabase[],
+export type AndroidDeviceTapResult = void;
+export type AndroidDeviceDragParams = {
+ androidSelector: AndroidSelector,
+ dest: Point,
+ speed?: number,
+ timeout: number,
};
-
-export type SerializedError = {
- error?: {
- message: string,
- name: string,
- stack?: string,
- },
- value?: SerializedValue,
+export type AndroidDeviceDragOptions = {
+ speed?: number,
};
-
-export type RecordHarOptions = {
- content?: 'embed' | 'attach' | 'omit',
- mode?: 'full' | 'minimal',
- urlGlob?: string,
- urlRegexSource?: string,
- urlRegexFlags?: string,
- harPath?: string,
- resourcesDir?: string,
+export type AndroidDeviceDragResult = void;
+export type AndroidDeviceFlingParams = {
+ androidSelector: AndroidSelector,
+ direction: 'up' | 'down' | 'left' | 'right',
+ speed?: number,
+ timeout: number,
};
-
-export type FormField = {
- name: string,
- value?: string,
- file?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- },
+export type AndroidDeviceFlingOptions = {
+ speed?: number,
+};
+export type AndroidDeviceFlingResult = void;
+export type AndroidDeviceLongTapParams = {
+ androidSelector: AndroidSelector,
+ timeout: number,
};
+export type AndroidDeviceLongTapOptions = {
-export type SDKLanguage = 'javascript' | 'python' | 'java' | 'csharp';
-// ----------- APIRequestContext -----------
-export type APIRequestContextInitializer = {
- tracing: TracingChannel,
};
-export interface APIRequestContextEventTarget {
-}
-export interface APIRequestContextChannel extends APIRequestContextEventTarget, Channel {
- _type_APIRequestContext: boolean;
- fetch(params: APIRequestContextFetchParams, progress?: Progress): Promise<APIRequestContextFetchResult>;
- fetchResponseBody(params: APIRequestContextFetchResponseBodyParams, progress?: Progress): Promise<APIRequestContextFetchResponseBodyResult>;
- fetchLog(params: APIRequestContextFetchLogParams, progress?: Progress): Promise<APIRequestContextFetchLogResult>;
- storageState(params: APIRequestContextStorageStateParams, progress?: Progress): Promise<APIRequestContextStorageStateResult>;
- disposeAPIResponse(params: APIRequestContextDisposeAPIResponseParams, progress?: Progress): Promise<APIRequestContextDisposeAPIResponseResult>;
- dispose(params: APIRequestContextDisposeParams, progress?: Progress): Promise<APIRequestContextDisposeResult>;
-}
-export type APIRequestContextFetchParams = {
- url: string,
- encodedParams?: string,
- params?: NameValue[],
- method?: string,
- headers?: NameValue[],
- postData?: Binary,
- jsonData?: string,
- formData?: NameValue[],
- multipartData?: FormField[],
+export type AndroidDeviceLongTapResult = void;
+export type AndroidDevicePinchCloseParams = {
+ androidSelector: AndroidSelector,
+ percent: number,
+ speed?: number,
timeout: number,
- failOnStatusCode?: boolean,
- ignoreHTTPSErrors?: boolean,
- maxRedirects?: number,
- maxRetries?: number,
};
-export type APIRequestContextFetchOptions = {
- encodedParams?: string,
- params?: NameValue[],
- method?: string,
- headers?: NameValue[],
- postData?: Binary,
- jsonData?: string,
- formData?: NameValue[],
- multipartData?: FormField[],
- failOnStatusCode?: boolean,
- ignoreHTTPSErrors?: boolean,
- maxRedirects?: number,
- maxRetries?: number,
+export type AndroidDevicePinchCloseOptions = {
+ speed?: number,
};
-export type APIRequestContextFetchResult = {
- response: APIResponse,
-};
-export type APIRequestContextFetchResponseBodyParams = {
- fetchUid: string,
-};
-export type APIRequestContextFetchResponseBodyOptions = {
-
-};
-export type APIRequestContextFetchResponseBodyResult = {
- binary?: Binary,
-};
-export type APIRequestContextFetchLogParams = {
- fetchUid: string,
-};
-export type APIRequestContextFetchLogOptions = {
-
-};
-export type APIRequestContextFetchLogResult = {
- log: string[],
-};
-export type APIRequestContextStorageStateParams = {
- indexedDB?: boolean,
-};
-export type APIRequestContextStorageStateOptions = {
- indexedDB?: boolean,
+export type AndroidDevicePinchCloseResult = void;
+export type AndroidDevicePinchOpenParams = {
+ androidSelector: AndroidSelector,
+ percent: number,
+ speed?: number,
+ timeout: number,
};
-export type APIRequestContextStorageStateResult = {
- cookies: NetworkCookie[],
- origins: OriginStorage[],
+export type AndroidDevicePinchOpenOptions = {
+ speed?: number,
};
-export type APIRequestContextDisposeAPIResponseParams = {
- fetchUid: string,
+export type AndroidDevicePinchOpenResult = void;
+export type AndroidDeviceScrollParams = {
+ androidSelector: AndroidSelector,
+ direction: 'up' | 'down' | 'left' | 'right',
+ percent: number,
+ speed?: number,
+ timeout: number,
};
-export type APIRequestContextDisposeAPIResponseOptions = {
-
+export type AndroidDeviceScrollOptions = {
+ speed?: number,
};
-export type APIRequestContextDisposeAPIResponseResult = void;
-export type APIRequestContextDisposeParams = {
- reason?: string,
+export type AndroidDeviceScrollResult = void;
+export type AndroidDeviceSwipeParams = {
+ androidSelector: AndroidSelector,
+ direction: 'up' | 'down' | 'left' | 'right',
+ percent: number,
+ speed?: number,
+ timeout: number,
};
-export type APIRequestContextDisposeOptions = {
- reason?: string,
+export type AndroidDeviceSwipeOptions = {
+ speed?: number,
};
-export type APIRequestContextDisposeResult = void;
-
-export interface APIRequestContextEvents {
-}
-
-export type APIResponse = {
- fetchUid: string,
- url: string,
- status: number,
- statusText: string,
- headers: NameValue[],
+export type AndroidDeviceSwipeResult = void;
+export type AndroidDeviceInfoParams = {
+ androidSelector: AndroidSelector,
};
+export type AndroidDeviceInfoOptions = {
-export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
-export type ConsoleMessagesFilter = 'all' | 'since-navigation';
-// ----------- LocalUtils -----------
-export type LocalUtilsInitializer = {
- deviceDescriptors: {
- name: string,
- descriptor: {
- userAgent: string,
- viewport: {
- width: number,
- height: number,
- },
- screen?: {
- width: number,
- height: number,
- },
- deviceScaleFactor: number,
- isMobile: boolean,
- hasTouch: boolean,
- defaultBrowserType: 'chromium' | 'firefox' | 'webkit',
- },
- }[],
};
-export interface LocalUtilsEventTarget {
-}
-export interface LocalUtilsChannel extends LocalUtilsEventTarget, Channel {
- _type_LocalUtils: boolean;
- zip(params: LocalUtilsZipParams, progress?: Progress): Promise<LocalUtilsZipResult>;
- harOpen(params: LocalUtilsHarOpenParams, progress?: Progress): Promise<LocalUtilsHarOpenResult>;
- harLookup(params: LocalUtilsHarLookupParams, progress?: Progress): Promise<LocalUtilsHarLookupResult>;
- harClose(params: LocalUtilsHarCloseParams, progress?: Progress): Promise<LocalUtilsHarCloseResult>;
- harUnzip(params: LocalUtilsHarUnzipParams, progress?: Progress): Promise<LocalUtilsHarUnzipResult>;
- connect(params: LocalUtilsConnectParams, progress?: Progress): Promise<LocalUtilsConnectResult>;
- tracingStarted(params: LocalUtilsTracingStartedParams, progress?: Progress): Promise<LocalUtilsTracingStartedResult>;
- addStackToTracingNoReply(params: LocalUtilsAddStackToTracingNoReplyParams, progress?: Progress): Promise<LocalUtilsAddStackToTracingNoReplyResult>;
- traceDiscarded(params: LocalUtilsTraceDiscardedParams, progress?: Progress): Promise<LocalUtilsTraceDiscardedResult>;
- globToRegex(params: LocalUtilsGlobToRegexParams, progress?: Progress): Promise<LocalUtilsGlobToRegexResult>;
-}
-export type LocalUtilsZipParams = {
- zipFile: string,
- entries: NameValue[],
- stacksId?: string,
- mode: 'write' | 'append',
- includeSources: boolean,
- additionalSources?: string[],
+export type AndroidDeviceInfoResult = {
+ info: AndroidElementInfo,
};
-export type LocalUtilsZipOptions = {
- stacksId?: string,
- additionalSources?: string[],
+export type AndroidDeviceScreenshotParams = {};
+export type AndroidDeviceScreenshotOptions = {};
+export type AndroidDeviceScreenshotResult = {
+ binary: Binary,
};
-export type LocalUtilsZipResult = void;
-export type LocalUtilsHarOpenParams = {
- file: string,
+export type AndroidDeviceInputTypeParams = {
+ text: string,
};
-export type LocalUtilsHarOpenOptions = {
+export type AndroidDeviceInputTypeOptions = {
};
-export type LocalUtilsHarOpenResult = {
- harId?: string,
- error?: string,
-};
-export type LocalUtilsHarLookupParams = {
- harId: string,
- url: string,
- method: string,
- headers: NameValue[],
- postData?: Binary,
- isNavigationRequest: boolean,
-};
-export type LocalUtilsHarLookupOptions = {
- postData?: Binary,
-};
-export type LocalUtilsHarLookupResult = {
- action: 'error' | 'redirect' | 'fulfill' | 'noentry',
- message?: string,
- redirectURL?: string,
- status?: number,
- headers?: NameValue[],
- body?: Binary,
-};
-export type LocalUtilsHarCloseParams = {
- harId: string,
+export type AndroidDeviceInputTypeResult = void;
+export type AndroidDeviceInputPressParams = {
+ key: string,
};
-export type LocalUtilsHarCloseOptions = {
+export type AndroidDeviceInputPressOptions = {
};
-export type LocalUtilsHarCloseResult = void;
-export type LocalUtilsHarUnzipParams = {
- zipFile: string,
- harFile: string,
- resourcesDir?: string,
-};
-export type LocalUtilsHarUnzipOptions = {
- resourcesDir?: string,
-};
-export type LocalUtilsHarUnzipResult = void;
-export type LocalUtilsConnectParams = {
- endpoint: string,
- headers?: any,
- exposeNetwork?: string,
- slowMo?: number,
- timeout: number,
- socksProxyRedirectPortForTest?: number,
-};
-export type LocalUtilsConnectOptions = {
- headers?: any,
- exposeNetwork?: string,
- slowMo?: number,
- socksProxyRedirectPortForTest?: number,
-};
-export type LocalUtilsConnectResult = {
- pipe: JsonPipeChannel,
- headers: NameValue[],
-};
-export type LocalUtilsTracingStartedParams = {
- tracesDir?: string,
- traceName: string,
- live?: boolean,
-};
-export type LocalUtilsTracingStartedOptions = {
- tracesDir?: string,
- live?: boolean,
-};
-export type LocalUtilsTracingStartedResult = {
- stacksId: string,
-};
-export type LocalUtilsAddStackToTracingNoReplyParams = {
- callData: ClientSideCallMetadata,
+export type AndroidDeviceInputPressResult = void;
+export type AndroidDeviceInputTapParams = {
+ point: Point,
};
-export type LocalUtilsAddStackToTracingNoReplyOptions = {
+export type AndroidDeviceInputTapOptions = {
};
-export type LocalUtilsAddStackToTracingNoReplyResult = void;
-export type LocalUtilsTraceDiscardedParams = {
- stacksId: string,
+export type AndroidDeviceInputTapResult = void;
+export type AndroidDeviceInputSwipeParams = {
+ segments: Point[],
+ steps: number,
};
-export type LocalUtilsTraceDiscardedOptions = {
+export type AndroidDeviceInputSwipeOptions = {
};
-export type LocalUtilsTraceDiscardedResult = void;
-export type LocalUtilsGlobToRegexParams = {
- glob: string,
- baseURL?: string,
- webSocketUrl?: boolean,
-};
-export type LocalUtilsGlobToRegexOptions = {
- baseURL?: string,
- webSocketUrl?: boolean,
-};
-export type LocalUtilsGlobToRegexResult = {
- regex: string,
+export type AndroidDeviceInputSwipeResult = void;
+export type AndroidDeviceInputDragParams = {
+ from: Point,
+ to: Point,
+ steps: number,
};
+export type AndroidDeviceInputDragOptions = {
-export interface LocalUtilsEvents {
-}
-
-// ----------- Root -----------
-export type RootInitializer = {};
-export interface RootEventTarget {
-}
-export interface RootChannel extends RootEventTarget, Channel {
- _type_Root: boolean;
- initialize(params: RootInitializeParams, progress?: Progress): Promise<RootInitializeResult>;
-}
-export type RootInitializeParams = {
- sdkLanguage: SDKLanguage,
};
-export type RootInitializeOptions = {
-
-};
-export type RootInitializeResult = {
- playwright: PlaywrightChannel,
-};
-
-export interface RootEvents {
-}
-
-// ----------- Playwright -----------
-export type PlaywrightInitializer = {
- chromium: BrowserTypeChannel,
- firefox: BrowserTypeChannel,
- webkit: BrowserTypeChannel,
- android: AndroidChannel,
- utils?: LocalUtilsChannel,
- preLaunchedBrowser?: BrowserChannel,
- preConnectedAndroidDevice?: AndroidDeviceChannel,
- socksSupport?: SocksSupportChannel,
-};
-export interface PlaywrightEventTarget {
-}
-export interface PlaywrightChannel extends PlaywrightEventTarget, Channel {
- _type_Playwright: boolean;
- newRequest(params: PlaywrightNewRequestParams, progress?: Progress): Promise<PlaywrightNewRequestResult>;
-}
-export type PlaywrightNewRequestParams = {
- baseURL?: string,
- userAgent?: string,
+export type AndroidDeviceInputDragResult = void;
+export type AndroidDeviceLaunchBrowserParams = {
+ noDefaultViewport?: boolean,
+ viewport?: {
+ width: number,
+ height: number,
+ },
+ screen?: {
+ width: number,
+ height: number,
+ },
ignoreHTTPSErrors?: boolean,
- extraHTTPHeaders?: NameValue[],
- failOnStatusCode?: boolean,
clientCertificates?: {
origin: string,
cert?: Binary,
@@ -639,31 +402,70 @@ export type PlaywrightNewRequestParams = {
passphrase?: string,
pfx?: Binary,
}[],
- maxRedirects?: number,
+ javaScriptEnabled?: boolean,
+ bypassCSP?: boolean,
+ userAgent?: string,
+ locale?: string,
+ timezoneId?: string,
+ geolocation?: {
+ longitude: number,
+ latitude: number,
+ accuracy?: number,
+ },
+ permissions?: string[],
+ extraHTTPHeaders?: NameValue[],
+ offline?: boolean,
httpCredentials?: {
username: string,
password: string,
origin?: string,
send?: 'always' | 'unauthorized',
},
+ deviceScaleFactor?: number,
+ isMobile?: boolean,
+ hasTouch?: boolean,
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+ baseURL?: string,
+ recordVideo?: {
+ dir?: string,
+ size?: {
+ width: number,
+ height: number,
+ },
+ showActions?: {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
+ },
+ },
+ strictSelectors?: boolean,
+ serviceWorkers?: 'allow' | 'block',
+ selectorEngines?: SelectorEngine[],
+ testIdAttributeName?: string,
+ pkg?: string,
+ args?: string[],
proxy?: {
server: string,
bypass?: string,
username?: string,
password?: string,
},
- storageState?: {
- cookies?: NetworkCookie[],
- origins?: SetOriginStorage[],
- },
- tracesDir?: string,
};
-export type PlaywrightNewRequestOptions = {
- baseURL?: string,
- userAgent?: string,
+export type AndroidDeviceLaunchBrowserOptions = {
+ noDefaultViewport?: boolean,
+ viewport?: {
+ width: number,
+ height: number,
+ },
+ screen?: {
+ width: number,
+ height: number,
+ },
ignoreHTTPSErrors?: boolean,
- extraHTTPHeaders?: NameValue[],
- failOnStatusCode?: boolean,
clientCertificates?: {
origin: string,
cert?: Binary,
@@ -671,303 +473,432 @@ export type PlaywrightNewRequestOptions = {
passphrase?: string,
pfx?: Binary,
}[],
- maxRedirects?: number,
+ javaScriptEnabled?: boolean,
+ bypassCSP?: boolean,
+ userAgent?: string,
+ locale?: string,
+ timezoneId?: string,
+ geolocation?: {
+ longitude: number,
+ latitude: number,
+ accuracy?: number,
+ },
+ permissions?: string[],
+ extraHTTPHeaders?: NameValue[],
+ offline?: boolean,
httpCredentials?: {
username: string,
password: string,
origin?: string,
send?: 'always' | 'unauthorized',
},
+ deviceScaleFactor?: number,
+ isMobile?: boolean,
+ hasTouch?: boolean,
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+ baseURL?: string,
+ recordVideo?: {
+ dir?: string,
+ size?: {
+ width: number,
+ height: number,
+ },
+ showActions?: {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
+ },
+ },
+ strictSelectors?: boolean,
+ serviceWorkers?: 'allow' | 'block',
+ selectorEngines?: SelectorEngine[],
+ testIdAttributeName?: string,
+ pkg?: string,
+ args?: string[],
proxy?: {
server: string,
bypass?: string,
username?: string,
password?: string,
},
- storageState?: {
- cookies?: NetworkCookie[],
- origins?: SetOriginStorage[],
- },
- tracesDir?: string,
};
-export type PlaywrightNewRequestResult = {
- request: APIRequestContextChannel,
+export type AndroidDeviceLaunchBrowserResult = {
+ context: BrowserContextChannel,
};
-
-export interface PlaywrightEvents {
-}
-
-export type RecorderSource = {
- isRecorded: boolean,
- id: string,
- label: string,
- text: string,
- language: string,
- highlight: {
- line: number,
- type: string,
- }[],
- revealLine?: number,
- group?: string,
+export type AndroidDeviceOpenParams = {
+ command: string,
};
+export type AndroidDeviceOpenOptions = {
-// ----------- DebugController -----------
-export type DebugControllerInitializer = {};
-export interface DebugControllerEventTarget {
- on(event: 'inspectRequested', callback: (params: DebugControllerInspectRequestedEvent) => void): this;
- on(event: 'setModeRequested', callback: (params: DebugControllerSetModeRequestedEvent) => void): this;
- on(event: 'stateChanged', callback: (params: DebugControllerStateChangedEvent) => void): this;
- on(event: 'sourceChanged', callback: (params: DebugControllerSourceChangedEvent) => void): this;
- on(event: 'paused', callback: (params: DebugControllerPausedEvent) => void): this;
-}
-export interface DebugControllerChannel extends DebugControllerEventTarget, Channel {
- _type_DebugController: boolean;
- initialize(params: DebugControllerInitializeParams, progress?: Progress): Promise<DebugControllerInitializeResult>;
- setReportStateChanged(params: DebugControllerSetReportStateChangedParams, progress?: Progress): Promise<DebugControllerSetReportStateChangedResult>;
- setRecorderMode(params: DebugControllerSetRecorderModeParams, progress?: Progress): Promise<DebugControllerSetRecorderModeResult>;
- highlight(params: DebugControllerHighlightParams, progress?: Progress): Promise<DebugControllerHighlightResult>;
- hideHighlight(params?: DebugControllerHideHighlightParams, progress?: Progress): Promise<DebugControllerHideHighlightResult>;
- resume(params?: DebugControllerResumeParams, progress?: Progress): Promise<DebugControllerResumeResult>;
- kill(params?: DebugControllerKillParams, progress?: Progress): Promise<DebugControllerKillResult>;
-}
-export type DebugControllerInspectRequestedEvent = {
- selector: string,
- locator: string,
- ariaSnapshot: string,
};
-export type DebugControllerSetModeRequestedEvent = {
- mode: string,
+export type AndroidDeviceOpenResult = {
+ socket: AndroidSocketChannel,
};
-export type DebugControllerStateChangedEvent = {
- pageCount: number,
+export type AndroidDeviceShellParams = {
+ command: string,
};
-export type DebugControllerSourceChangedEvent = {
- text: string,
- header?: string,
- footer?: string,
- actions?: string[],
+export type AndroidDeviceShellOptions = {
+
};
-export type DebugControllerPausedEvent = {
- paused: boolean,
+export type AndroidDeviceShellResult = {
+ result: Binary,
};
-export type DebugControllerInitializeParams = {
- codegenId: string,
- sdkLanguage: SDKLanguage,
+export type AndroidDeviceInstallApkParams = {
+ file: Binary,
+ args?: string[],
};
-export type DebugControllerInitializeOptions = {
-
+export type AndroidDeviceInstallApkOptions = {
+ args?: string[],
};
-export type DebugControllerInitializeResult = void;
-export type DebugControllerSetReportStateChangedParams = {
- enabled: boolean,
+export type AndroidDeviceInstallApkResult = void;
+export type AndroidDevicePushParams = {
+ file: Binary,
+ path: string,
+ mode?: number,
};
-export type DebugControllerSetReportStateChangedOptions = {
-
+export type AndroidDevicePushOptions = {
+ mode?: number,
};
-export type DebugControllerSetReportStateChangedResult = void;
-export type DebugControllerSetRecorderModeParams = {
- mode: 'inspecting' | 'recording' | 'none',
- testIdAttributeName?: string,
- generateAutoExpect?: boolean,
+export type AndroidDevicePushResult = void;
+export type AndroidDeviceConnectToWebViewParams = {
+ socketName: string,
};
-export type DebugControllerSetRecorderModeOptions = {
- testIdAttributeName?: string,
- generateAutoExpect?: boolean,
+export type AndroidDeviceConnectToWebViewOptions = {
+
};
-export type DebugControllerSetRecorderModeResult = void;
-export type DebugControllerHighlightParams = {
- selector?: string,
- ariaTemplate?: string,
+export type AndroidDeviceConnectToWebViewResult = {
+ context: BrowserContextChannel,
};
-export type DebugControllerHighlightOptions = {
- selector?: string,
- ariaTemplate?: string,
-};
-export type DebugControllerHighlightResult = void;
-export type DebugControllerHideHighlightParams = {};
-export type DebugControllerHideHighlightOptions = {};
-export type DebugControllerHideHighlightResult = void;
-export type DebugControllerResumeParams = {};
-export type DebugControllerResumeOptions = {};
-export type DebugControllerResumeResult = void;
-export type DebugControllerKillParams = {};
-export type DebugControllerKillOptions = {};
-export type DebugControllerKillResult = void;
+export type AndroidDeviceCloseParams = {};
+export type AndroidDeviceCloseOptions = {};
+export type AndroidDeviceCloseResult = void;
-export interface DebugControllerEvents {
- 'inspectRequested': DebugControllerInspectRequestedEvent;
- 'setModeRequested': DebugControllerSetModeRequestedEvent;
- 'stateChanged': DebugControllerStateChangedEvent;
- 'sourceChanged': DebugControllerSourceChangedEvent;
- 'paused': DebugControllerPausedEvent;
+export interface AndroidDeviceEvents {
+ 'close': AndroidDeviceCloseEvent;
+ 'webViewAdded': AndroidDeviceWebViewAddedEvent;
+ 'webViewRemoved': AndroidDeviceWebViewRemovedEvent;
}
-// ----------- SocksSupport -----------
-export type SocksSupportInitializer = {};
-export interface SocksSupportEventTarget {
- on(event: 'socksRequested', callback: (params: SocksSupportSocksRequestedEvent) => void): this;
- on(event: 'socksData', callback: (params: SocksSupportSocksDataEvent) => void): this;
- on(event: 'socksClosed', callback: (params: SocksSupportSocksClosedEvent) => void): this;
+export type AndroidWebView = {
+ pid: number,
+ pkg: string,
+ socketName: string,
+};
+
+export type AndroidSelector = {
+ checkable?: boolean,
+ checked?: boolean,
+ clazz?: string,
+ clickable?: boolean,
+ depth?: number,
+ desc?: string,
+ enabled?: boolean,
+ focusable?: boolean,
+ focused?: boolean,
+ hasChild?: {
+ androidSelector: AndroidSelector,
+ },
+ hasDescendant?: {
+ androidSelector: AndroidSelector,
+ maxDepth?: number,
+ },
+ longClickable?: boolean,
+ pkg?: string,
+ res?: string,
+ scrollable?: boolean,
+ selected?: boolean,
+ text?: string,
+};
+
+export type AndroidElementInfo = {
+ children?: AndroidElementInfo[],
+ clazz: string,
+ desc: string,
+ res: string,
+ pkg: string,
+ text: string,
+ bounds: Rect,
+ checkable: boolean,
+ checked: boolean,
+ clickable: boolean,
+ enabled: boolean,
+ focusable: boolean,
+ focused: boolean,
+ longClickable: boolean,
+ scrollable: boolean,
+ selected: boolean,
+};
+
+// ----------- APIRequestContext -----------
+export type APIRequestContextInitializer = {
+ tracing: TracingChannel,
+};
+export interface APIRequestContextEventTarget {
}
-export interface SocksSupportChannel extends SocksSupportEventTarget, Channel {
- _type_SocksSupport: boolean;
- socksConnected(params: SocksSupportSocksConnectedParams, progress?: Progress): Promise<SocksSupportSocksConnectedResult>;
- socksFailed(params: SocksSupportSocksFailedParams, progress?: Progress): Promise<SocksSupportSocksFailedResult>;
- socksData(params: SocksSupportSocksDataParams, progress?: Progress): Promise<SocksSupportSocksDataResult>;
- socksError(params: SocksSupportSocksErrorParams, progress?: Progress): Promise<SocksSupportSocksErrorResult>;
- socksEnd(params: SocksSupportSocksEndParams, progress?: Progress): Promise<SocksSupportSocksEndResult>;
+export interface APIRequestContextChannel extends APIRequestContextEventTarget, Channel {
+ _type_APIRequestContext: boolean;
+ fetch(params: APIRequestContextFetchParams, progress?: Progress): Promise<APIRequestContextFetchResult>;
+ fetchResponseBody(params: APIRequestContextFetchResponseBodyParams, progress?: Progress): Promise<APIRequestContextFetchResponseBodyResult>;
+ fetchLog(params: APIRequestContextFetchLogParams, progress?: Progress): Promise<APIRequestContextFetchLogResult>;
+ storageState(params: APIRequestContextStorageStateParams, progress?: Progress): Promise<APIRequestContextStorageStateResult>;
+ disposeAPIResponse(params: APIRequestContextDisposeAPIResponseParams, progress?: Progress): Promise<APIRequestContextDisposeAPIResponseResult>;
+ dispose(params: APIRequestContextDisposeParams, progress?: Progress): Promise<APIRequestContextDisposeResult>;
}
-export type SocksSupportSocksRequestedEvent = {
- uid: string,
- host: string,
- port: number,
+export type APIRequestContextFetchParams = {
+ url: string,
+ encodedParams?: string,
+ params?: NameValue[],
+ method?: string,
+ headers?: NameValue[],
+ postData?: Binary,
+ jsonData?: string,
+ formData?: NameValue[],
+ multipartData?: FormField[],
+ timeout: number,
+ failOnStatusCode?: boolean,
+ ignoreHTTPSErrors?: boolean,
+ maxRedirects?: number,
+ maxRetries?: number,
};
-export type SocksSupportSocksDataEvent = {
- uid: string,
- data: Binary,
+export type APIRequestContextFetchOptions = {
+ encodedParams?: string,
+ params?: NameValue[],
+ method?: string,
+ headers?: NameValue[],
+ postData?: Binary,
+ jsonData?: string,
+ formData?: NameValue[],
+ multipartData?: FormField[],
+ failOnStatusCode?: boolean,
+ ignoreHTTPSErrors?: boolean,
+ maxRedirects?: number,
+ maxRetries?: number,
};
-export type SocksSupportSocksClosedEvent = {
- uid: string,
+export type APIRequestContextFetchResult = {
+ response: APIResponse,
};
-export type SocksSupportSocksConnectedParams = {
- uid: string,
- host: string,
- port: number,
+export type APIRequestContextFetchResponseBodyParams = {
+ fetchUid: string,
};
-export type SocksSupportSocksConnectedOptions = {
+export type APIRequestContextFetchResponseBodyOptions = {
};
-export type SocksSupportSocksConnectedResult = void;
-export type SocksSupportSocksFailedParams = {
- uid: string,
- errorCode: string,
+export type APIRequestContextFetchResponseBodyResult = {
+ binary?: Binary,
};
-export type SocksSupportSocksFailedOptions = {
+export type APIRequestContextFetchLogParams = {
+ fetchUid: string,
+};
+export type APIRequestContextFetchLogOptions = {
};
-export type SocksSupportSocksFailedResult = void;
-export type SocksSupportSocksDataParams = {
- uid: string,
- data: Binary,
+export type APIRequestContextFetchLogResult = {
+ log: string[],
};
-export type SocksSupportSocksDataOptions = {
-
+export type APIRequestContextStorageStateParams = {
+ indexedDB?: boolean,
};
-export type SocksSupportSocksDataResult = void;
-export type SocksSupportSocksErrorParams = {
- uid: string,
- error: string,
+export type APIRequestContextStorageStateOptions = {
+ indexedDB?: boolean,
};
-export type SocksSupportSocksErrorOptions = {
-
+export type APIRequestContextStorageStateResult = {
+ cookies: NetworkCookie[],
+ origins: OriginStorage[],
};
-export type SocksSupportSocksErrorResult = void;
-export type SocksSupportSocksEndParams = {
- uid: string,
+export type APIRequestContextDisposeAPIResponseParams = {
+ fetchUid: string,
};
-export type SocksSupportSocksEndOptions = {
+export type APIRequestContextDisposeAPIResponseOptions = {
};
-export type SocksSupportSocksEndResult = void;
+export type APIRequestContextDisposeAPIResponseResult = void;
+export type APIRequestContextDisposeParams = {
+ reason?: string,
+};
+export type APIRequestContextDisposeOptions = {
+ reason?: string,
+};
+export type APIRequestContextDisposeResult = void;
-export interface SocksSupportEvents {
- 'socksRequested': SocksSupportSocksRequestedEvent;
- 'socksData': SocksSupportSocksDataEvent;
- 'socksClosed': SocksSupportSocksClosedEvent;
+export interface APIRequestContextEvents {
}
-// ----------- BrowserType -----------
-export type BrowserTypeInitializer = {
- executablePath: string,
- name: string,
+export type APIResponse = {
+ fetchUid: string,
+ url: string,
+ status: number,
+ statusText: string,
+ headers: NameValue[],
};
-export interface BrowserTypeEventTarget {
+
+// ----------- Artifact -----------
+export type ArtifactInitializer = {
+ absolutePath: string,
+};
+export interface ArtifactEventTarget {
}
-export interface BrowserTypeChannel extends BrowserTypeEventTarget, Channel {
- _type_BrowserType: boolean;
- launch(params: BrowserTypeLaunchParams, progress?: Progress): Promise<BrowserTypeLaunchResult>;
- launchPersistentContext(params: BrowserTypeLaunchPersistentContextParams, progress?: Progress): Promise<BrowserTypeLaunchPersistentContextResult>;
- connectOverCDP(params: BrowserTypeConnectOverCDPParams, progress?: Progress): Promise<BrowserTypeConnectOverCDPResult>;
- connectToWorker(params: BrowserTypeConnectToWorkerParams, progress?: Progress): Promise<BrowserTypeConnectToWorkerResult>;
+export interface ArtifactChannel extends ArtifactEventTarget, Channel {
+ _type_Artifact: boolean;
+ pathAfterFinished(params?: ArtifactPathAfterFinishedParams, progress?: Progress): Promise<ArtifactPathAfterFinishedResult>;
+ saveAs(params: ArtifactSaveAsParams, progress?: Progress): Promise<ArtifactSaveAsResult>;
+ saveAsStream(params?: ArtifactSaveAsStreamParams, progress?: Progress): Promise<ArtifactSaveAsStreamResult>;
+ failure(params?: ArtifactFailureParams, progress?: Progress): Promise<ArtifactFailureResult>;
+ stream(params?: ArtifactStreamParams, progress?: Progress): Promise<ArtifactStreamResult>;
+ cancel(params?: ArtifactCancelParams, progress?: Progress): Promise<ArtifactCancelResult>;
+ delete(params?: ArtifactDeleteParams, progress?: Progress): Promise<ArtifactDeleteResult>;
}
-export type BrowserTypeLaunchParams = {
- channel?: string,
- executablePath?: string,
- args?: string[],
- ignoreAllDefaultArgs?: boolean,
- ignoreDefaultArgs?: string[],
- handleSIGINT?: boolean,
- handleSIGTERM?: boolean,
- handleSIGHUP?: boolean,
- timeout: number,
- env?: NameValue[],
- headless?: boolean,
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
- },
- downloadsPath?: string,
- tracesDir?: string,
- artifactsDir?: string,
- chromiumSandbox?: boolean,
- firefoxUserPrefs?: any,
- cdpPort?: number,
- slowMo?: number,
+export type ArtifactPathAfterFinishedParams = {};
+export type ArtifactPathAfterFinishedOptions = {};
+export type ArtifactPathAfterFinishedResult = {
+ value: string,
};
-export type BrowserTypeLaunchOptions = {
- channel?: string,
- executablePath?: string,
- args?: string[],
- ignoreAllDefaultArgs?: boolean,
- ignoreDefaultArgs?: string[],
- handleSIGINT?: boolean,
- handleSIGTERM?: boolean,
- handleSIGHUP?: boolean,
- env?: NameValue[],
- headless?: boolean,
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
- },
- downloadsPath?: string,
- tracesDir?: string,
- artifactsDir?: string,
- chromiumSandbox?: boolean,
- firefoxUserPrefs?: any,
- cdpPort?: number,
- slowMo?: number,
+export type ArtifactSaveAsParams = {
+ path: string,
};
-export type BrowserTypeLaunchResult = {
- browser: BrowserChannel,
+export type ArtifactSaveAsOptions = {
+
};
-export type BrowserTypeLaunchPersistentContextParams = {
- channel?: string,
- executablePath?: string,
- args?: string[],
- ignoreAllDefaultArgs?: boolean,
- ignoreDefaultArgs?: string[],
- handleSIGINT?: boolean,
- handleSIGTERM?: boolean,
- handleSIGHUP?: boolean,
- timeout: number,
- env?: NameValue[],
- headless?: boolean,
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
- },
- downloadsPath?: string,
- tracesDir?: string,
- artifactsDir?: string,
- chromiumSandbox?: boolean,
- firefoxUserPrefs?: any,
- cdpPort?: number,
+export type ArtifactSaveAsResult = void;
+export type ArtifactSaveAsStreamParams = {};
+export type ArtifactSaveAsStreamOptions = {};
+export type ArtifactSaveAsStreamResult = {
+ stream: StreamChannel,
+};
+export type ArtifactFailureParams = {};
+export type ArtifactFailureOptions = {};
+export type ArtifactFailureResult = {
+ error?: string,
+};
+export type ArtifactStreamParams = {};
+export type ArtifactStreamOptions = {};
+export type ArtifactStreamResult = {
+ stream: StreamChannel,
+};
+export type ArtifactCancelParams = {};
+export type ArtifactCancelOptions = {};
+export type ArtifactCancelResult = void;
+export type ArtifactDeleteParams = {};
+export type ArtifactDeleteOptions = {};
+export type ArtifactDeleteResult = void;
+
+export interface ArtifactEvents {
+}
+
+// ----------- Stream -----------
+export type StreamInitializer = {};
+export interface StreamEventTarget {
+}
+export interface StreamChannel extends StreamEventTarget, Channel {
+ _type_Stream: boolean;
+ read(params: StreamReadParams, progress?: Progress): Promise<StreamReadResult>;
+ close(params?: StreamCloseParams, progress?: Progress): Promise<StreamCloseResult>;
+}
+export type StreamReadParams = {
+ size?: number,
+};
+export type StreamReadOptions = {
+ size?: number,
+};
+export type StreamReadResult = {
+ binary: Binary,
+};
+export type StreamCloseParams = {};
+export type StreamCloseOptions = {};
+export type StreamCloseResult = void;
+
+export interface StreamEvents {
+}
+
+// ----------- WritableStream -----------
+export type WritableStreamInitializer = {};
+export interface WritableStreamEventTarget {
+}
+export interface WritableStreamChannel extends WritableStreamEventTarget, Channel {
+ _type_WritableStream: boolean;
+ write(params: WritableStreamWriteParams, progress?: Progress): Promise<WritableStreamWriteResult>;
+ close(params?: WritableStreamCloseParams, progress?: Progress): Promise<WritableStreamCloseResult>;
+}
+export type WritableStreamWriteParams = {
+ binary: Binary,
+};
+export type WritableStreamWriteOptions = {
+
+};
+export type WritableStreamWriteResult = void;
+export type WritableStreamCloseParams = {};
+export type WritableStreamCloseOptions = {};
+export type WritableStreamCloseResult = void;
+
+export interface WritableStreamEvents {
+}
+
+// ----------- Browser -----------
+export type BrowserInitializer = {
+ version: string,
+ name: string,
+ browserName: 'chromium' | 'firefox' | 'webkit',
+};
+export interface BrowserEventTarget {
+ on(event: 'context', callback: (params: BrowserContextEvent) => void): this;
+ on(event: 'close', callback: (params: BrowserCloseEvent) => void): this;
+}
+export interface BrowserChannel extends BrowserEventTarget, Channel {
+ _type_Browser: boolean;
+ startServer(params: BrowserStartServerParams, progress?: Progress): Promise<BrowserStartServerResult>;
+ stopServer(params?: BrowserStopServerParams, progress?: Progress): Promise<BrowserStopServerResult>;
+ close(params: BrowserCloseParams, progress?: Progress): Promise<BrowserCloseResult>;
+ killForTests(params?: BrowserKillForTestsParams, progress?: Progress): Promise<BrowserKillForTestsResult>;
+ defaultUserAgentForTest(params?: BrowserDefaultUserAgentForTestParams, progress?: Progress): Promise<BrowserDefaultUserAgentForTestResult>;
+ newContext(params: BrowserNewContextParams, progress?: Progress): Promise<BrowserNewContextResult>;
+ newContextForReuse(params: BrowserNewContextForReuseParams, progress?: Progress): Promise<BrowserNewContextForReuseResult>;
+ disconnectFromReusedContext(params: BrowserDisconnectFromReusedContextParams, progress?: Progress): Promise<BrowserDisconnectFromReusedContextResult>;
+ newBrowserCDPSession(params?: BrowserNewBrowserCDPSessionParams, progress?: Progress): Promise<BrowserNewBrowserCDPSessionResult>;
+ startTracing(params: BrowserStartTracingParams, progress?: Progress): Promise<BrowserStartTracingResult>;
+ stopTracing(params?: BrowserStopTracingParams, progress?: Progress): Promise<BrowserStopTracingResult>;
+}
+export type BrowserContextEvent = {
+ context: BrowserContextChannel,
+};
+export type BrowserCloseEvent = {};
+export type BrowserStartServerParams = {
+ title: string,
+ workspaceDir?: string,
+ metadata?: any,
+ host?: string,
+ port?: number,
+};
+export type BrowserStartServerOptions = {
+ workspaceDir?: string,
+ metadata?: any,
+ host?: string,
+ port?: number,
+};
+export type BrowserStartServerResult = {
+ endpoint: string,
+};
+export type BrowserStopServerParams = {};
+export type BrowserStopServerOptions = {};
+export type BrowserStopServerResult = void;
+export type BrowserCloseParams = {
+ reason?: string,
+};
+export type BrowserCloseOptions = {
+ reason?: string,
+};
+export type BrowserCloseResult = void;
+export type BrowserKillForTestsParams = {};
+export type BrowserKillForTestsOptions = {};
+export type BrowserKillForTestsResult = void;
+export type BrowserDefaultUserAgentForTestParams = {};
+export type BrowserDefaultUserAgentForTestOptions = {};
+export type BrowserDefaultUserAgentForTestResult = {
+ userAgent: string,
+};
+export type BrowserNewContextParams = {
noDefaultViewport?: boolean,
viewport?: {
width: number,
@@ -1029,32 +960,18 @@ export type BrowserTypeLaunchPersistentContextParams = {
serviceWorkers?: 'allow' | 'block',
selectorEngines?: SelectorEngine[],
testIdAttributeName?: string,
- userDataDir: string,
- slowMo?: number,
-};
-export type BrowserTypeLaunchPersistentContextOptions = {
- channel?: string,
- executablePath?: string,
- args?: string[],
- ignoreAllDefaultArgs?: boolean,
- ignoreDefaultArgs?: string[],
- handleSIGINT?: boolean,
- handleSIGTERM?: boolean,
- handleSIGHUP?: boolean,
- env?: NameValue[],
- headless?: boolean,
proxy?: {
server: string,
bypass?: string,
username?: string,
password?: string,
},
- downloadsPath?: string,
- tracesDir?: string,
- artifactsDir?: string,
- chromiumSandbox?: boolean,
- firefoxUserPrefs?: any,
- cdpPort?: number,
+ storageState?: {
+ cookies?: SetNetworkCookie[],
+ origins?: SetOriginStorage[],
+ },
+};
+export type BrowserNewContextOptions = {
noDefaultViewport?: boolean,
viewport?: {
width: number,
@@ -1116,253 +1033,18 @@ export type BrowserTypeLaunchPersistentContextOptions = {
serviceWorkers?: 'allow' | 'block',
selectorEngines?: SelectorEngine[],
testIdAttributeName?: string,
- slowMo?: number,
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ storageState?: {
+ cookies?: SetNetworkCookie[],
+ origins?: SetOriginStorage[],
+ },
};
-export type BrowserTypeLaunchPersistentContextResult = {
- browser: BrowserChannel,
- context: BrowserContextChannel,
-};
-export type BrowserTypeConnectOverCDPParams = {
- endpointURL: string,
- headers?: NameValue[],
- slowMo?: number,
- timeout: number,
- isLocal?: boolean,
- noDefaults?: boolean,
-};
-export type BrowserTypeConnectOverCDPOptions = {
- headers?: NameValue[],
- slowMo?: number,
- isLocal?: boolean,
- noDefaults?: boolean,
-};
-export type BrowserTypeConnectOverCDPResult = {
- browser: BrowserChannel,
- defaultContext?: BrowserContextChannel,
-};
-export type BrowserTypeConnectToWorkerParams = {
- endpoint: string,
- timeout: number,
-};
-export type BrowserTypeConnectToWorkerOptions = {
-
-};
-export type BrowserTypeConnectToWorkerResult = {
- worker: WorkerChannel,
-};
-
-export interface BrowserTypeEvents {
-}
-
-// ----------- Browser -----------
-export type BrowserInitializer = {
- version: string,
- name: string,
- browserName: 'chromium' | 'firefox' | 'webkit',
-};
-export interface BrowserEventTarget {
- on(event: 'context', callback: (params: BrowserContextEvent) => void): this;
- on(event: 'close', callback: (params: BrowserCloseEvent) => void): this;
-}
-export interface BrowserChannel extends BrowserEventTarget, Channel {
- _type_Browser: boolean;
- startServer(params: BrowserStartServerParams, progress?: Progress): Promise<BrowserStartServerResult>;
- stopServer(params?: BrowserStopServerParams, progress?: Progress): Promise<BrowserStopServerResult>;
- close(params: BrowserCloseParams, progress?: Progress): Promise<BrowserCloseResult>;
- killForTests(params?: BrowserKillForTestsParams, progress?: Progress): Promise<BrowserKillForTestsResult>;
- defaultUserAgentForTest(params?: BrowserDefaultUserAgentForTestParams, progress?: Progress): Promise<BrowserDefaultUserAgentForTestResult>;
- newContext(params: BrowserNewContextParams, progress?: Progress): Promise<BrowserNewContextResult>;
- newContextForReuse(params: BrowserNewContextForReuseParams, progress?: Progress): Promise<BrowserNewContextForReuseResult>;
- disconnectFromReusedContext(params: BrowserDisconnectFromReusedContextParams, progress?: Progress): Promise<BrowserDisconnectFromReusedContextResult>;
- newBrowserCDPSession(params?: BrowserNewBrowserCDPSessionParams, progress?: Progress): Promise<BrowserNewBrowserCDPSessionResult>;
- startTracing(params: BrowserStartTracingParams, progress?: Progress): Promise<BrowserStartTracingResult>;
- stopTracing(params?: BrowserStopTracingParams, progress?: Progress): Promise<BrowserStopTracingResult>;
-}
-export type BrowserContextEvent = {
- context: BrowserContextChannel,
-};
-export type BrowserCloseEvent = {};
-export type BrowserStartServerParams = {
- title: string,
- workspaceDir?: string,
- metadata?: any,
- host?: string,
- port?: number,
-};
-export type BrowserStartServerOptions = {
- workspaceDir?: string,
- metadata?: any,
- host?: string,
- port?: number,
-};
-export type BrowserStartServerResult = {
- endpoint: string,
-};
-export type BrowserStopServerParams = {};
-export type BrowserStopServerOptions = {};
-export type BrowserStopServerResult = void;
-export type BrowserCloseParams = {
- reason?: string,
-};
-export type BrowserCloseOptions = {
- reason?: string,
-};
-export type BrowserCloseResult = void;
-export type BrowserKillForTestsParams = {};
-export type BrowserKillForTestsOptions = {};
-export type BrowserKillForTestsResult = void;
-export type BrowserDefaultUserAgentForTestParams = {};
-export type BrowserDefaultUserAgentForTestOptions = {};
-export type BrowserDefaultUserAgentForTestResult = {
- userAgent: string,
-};
-export type BrowserNewContextParams = {
- noDefaultViewport?: boolean,
- viewport?: {
- width: number,
- height: number,
- },
- screen?: {
- width: number,
- height: number,
- },
- ignoreHTTPSErrors?: boolean,
- clientCertificates?: {
- origin: string,
- cert?: Binary,
- key?: Binary,
- passphrase?: string,
- pfx?: Binary,
- }[],
- javaScriptEnabled?: boolean,
- bypassCSP?: boolean,
- userAgent?: string,
- locale?: string,
- timezoneId?: string,
- geolocation?: {
- longitude: number,
- latitude: number,
- accuracy?: number,
- },
- permissions?: string[],
- extraHTTPHeaders?: NameValue[],
- offline?: boolean,
- httpCredentials?: {
- username: string,
- password: string,
- origin?: string,
- send?: 'always' | 'unauthorized',
- },
- deviceScaleFactor?: number,
- isMobile?: boolean,
- hasTouch?: boolean,
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
- contrast?: 'no-preference' | 'more' | 'no-override',
- baseURL?: string,
- recordVideo?: {
- dir?: string,
- size?: {
- width: number,
- height: number,
- },
- showActions?: {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
- },
- },
- strictSelectors?: boolean,
- serviceWorkers?: 'allow' | 'block',
- selectorEngines?: SelectorEngine[],
- testIdAttributeName?: string,
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
- },
- storageState?: {
- cookies?: SetNetworkCookie[],
- origins?: SetOriginStorage[],
- },
-};
-export type BrowserNewContextOptions = {
- noDefaultViewport?: boolean,
- viewport?: {
- width: number,
- height: number,
- },
- screen?: {
- width: number,
- height: number,
- },
- ignoreHTTPSErrors?: boolean,
- clientCertificates?: {
- origin: string,
- cert?: Binary,
- key?: Binary,
- passphrase?: string,
- pfx?: Binary,
- }[],
- javaScriptEnabled?: boolean,
- bypassCSP?: boolean,
- userAgent?: string,
- locale?: string,
- timezoneId?: string,
- geolocation?: {
- longitude: number,
- latitude: number,
- accuracy?: number,
- },
- permissions?: string[],
- extraHTTPHeaders?: NameValue[],
- offline?: boolean,
- httpCredentials?: {
- username: string,
- password: string,
- origin?: string,
- send?: 'always' | 'unauthorized',
- },
- deviceScaleFactor?: number,
- isMobile?: boolean,
- hasTouch?: boolean,
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
- contrast?: 'no-preference' | 'more' | 'no-override',
- baseURL?: string,
- recordVideo?: {
- dir?: string,
- size?: {
- width: number,
- height: number,
- },
- showActions?: {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
- },
- },
- strictSelectors?: boolean,
- serviceWorkers?: 'allow' | 'block',
- selectorEngines?: SelectorEngine[],
- testIdAttributeName?: string,
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
- },
- storageState?: {
- cookies?: SetNetworkCookie[],
- origins?: SetOriginStorage[],
- },
-};
-export type BrowserNewContextResult = {
+export type BrowserNewContextResult = {
context: BrowserContextChannel,
};
export type BrowserNewContextForReuseParams = {
@@ -1548,31 +1230,6 @@ export interface BrowserEvents {
'close': BrowserCloseEvent;
}
-// ----------- EventTarget -----------
-export type EventTargetInitializer = {};
-export interface EventTargetEventTarget {
-}
-export interface EventTargetChannel extends EventTargetEventTarget, Channel {
- _type_EventTarget: boolean;
- waitForEventInfo(params: EventTargetWaitForEventInfoParams, progress?: Progress): Promise<EventTargetWaitForEventInfoResult>;
-}
-export type EventTargetWaitForEventInfoParams = {
- info: {
- waitId: string,
- phase: 'before' | 'after' | 'log',
- event?: string,
- message?: string,
- error?: string,
- },
-};
-export type EventTargetWaitForEventInfoOptions = {
-
-};
-export type EventTargetWaitForEventInfoResult = void;
-
-export interface EventTargetEvents {
-}
-
// ----------- BrowserContext -----------
export type BrowserContextInitializer = {
debugger: DebuggerChannel,
@@ -2092,877 +1749,1234 @@ export interface BrowserContextEvents {
'recorderEvent': BrowserContextRecorderEventEvent;
}
-// ----------- Page -----------
-export type PageInitializer = {
- mainFrame: FrameChannel,
- viewportSize?: {
- width: number,
- height: number,
- },
- isClosed: boolean,
- opener?: PageChannel,
- video?: ArtifactChannel,
+// ----------- BrowserType -----------
+export type BrowserTypeInitializer = {
+ executablePath: string,
+ name: string,
};
-export interface PageEventTarget {
- on(event: 'bindingCall', callback: (params: PageBindingCallEvent) => void): this;
- on(event: 'close', callback: (params: PageCloseEvent) => void): this;
- on(event: 'crash', callback: (params: PageCrashEvent) => void): this;
- on(event: 'download', callback: (params: PageDownloadEvent) => void): this;
- on(event: 'viewportSizeChanged', callback: (params: PageViewportSizeChangedEvent) => void): this;
- on(event: 'fileChooser', callback: (params: PageFileChooserEvent) => void): this;
- on(event: 'frameAttached', callback: (params: PageFrameAttachedEvent) => void): this;
- on(event: 'frameDetached', callback: (params: PageFrameDetachedEvent) => void): this;
- on(event: 'locatorHandlerTriggered', callback: (params: PageLocatorHandlerTriggeredEvent) => void): this;
- on(event: 'route', callback: (params: PageRouteEvent) => void): this;
- on(event: 'screencastFrame', callback: (params: PageScreencastFrameEvent) => void): this;
- on(event: 'webSocketRoute', callback: (params: PageWebSocketRouteEvent) => void): this;
- on(event: 'webSocket', callback: (params: PageWebSocketEvent) => void): this;
- on(event: 'worker', callback: (params: PageWorkerEvent) => void): this;
+export interface BrowserTypeEventTarget {
}
-export interface PageChannel extends PageEventTarget, EventTargetChannel {
- _type_Page: boolean;
- addInitScript(params: PageAddInitScriptParams, progress?: Progress): Promise<PageAddInitScriptResult>;
- close(params: PageCloseParams, progress?: Progress): Promise<PageCloseResult>;
- clearConsoleMessages(params?: PageClearConsoleMessagesParams, progress?: Progress): Promise<PageClearConsoleMessagesResult>;
- consoleMessages(params: PageConsoleMessagesParams, progress?: Progress): Promise<PageConsoleMessagesResult>;
- emulateMedia(params: PageEmulateMediaParams, progress?: Progress): Promise<PageEmulateMediaResult>;
- exposeBinding(params: PageExposeBindingParams, progress?: Progress): Promise<PageExposeBindingResult>;
- goBack(params: PageGoBackParams, progress?: Progress): Promise<PageGoBackResult>;
- goForward(params: PageGoForwardParams, progress?: Progress): Promise<PageGoForwardResult>;
- requestGC(params?: PageRequestGCParams, progress?: Progress): Promise<PageRequestGCResult>;
- registerLocatorHandler(params: PageRegisterLocatorHandlerParams, progress?: Progress): Promise<PageRegisterLocatorHandlerResult>;
- resolveLocatorHandlerNoReply(params: PageResolveLocatorHandlerNoReplyParams, progress?: Progress): Promise<PageResolveLocatorHandlerNoReplyResult>;
- unregisterLocatorHandler(params: PageUnregisterLocatorHandlerParams, progress?: Progress): Promise<PageUnregisterLocatorHandlerResult>;
- reload(params: PageReloadParams, progress?: Progress): Promise<PageReloadResult>;
- expectScreenshot(params: PageExpectScreenshotParams, progress?: Progress): Promise<PageExpectScreenshotResult>;
- screenshot(params: PageScreenshotParams, progress?: Progress): Promise<PageScreenshotResult>;
- setExtraHTTPHeaders(params: PageSetExtraHTTPHeadersParams, progress?: Progress): Promise<PageSetExtraHTTPHeadersResult>;
- setNetworkInterceptionPatterns(params: PageSetNetworkInterceptionPatternsParams, progress?: Progress): Promise<PageSetNetworkInterceptionPatternsResult>;
- setWebSocketInterceptionPatterns(params: PageSetWebSocketInterceptionPatternsParams, progress?: Progress): Promise<PageSetWebSocketInterceptionPatternsResult>;
- setViewportSize(params: PageSetViewportSizeParams, progress?: Progress): Promise<PageSetViewportSizeResult>;
- keyboardDown(params: PageKeyboardDownParams, progress?: Progress): Promise<PageKeyboardDownResult>;
- keyboardUp(params: PageKeyboardUpParams, progress?: Progress): Promise<PageKeyboardUpResult>;
- keyboardInsertText(params: PageKeyboardInsertTextParams, progress?: Progress): Promise<PageKeyboardInsertTextResult>;
- keyboardType(params: PageKeyboardTypeParams, progress?: Progress): Promise<PageKeyboardTypeResult>;
- keyboardPress(params: PageKeyboardPressParams, progress?: Progress): Promise<PageKeyboardPressResult>;
- mouseMove(params: PageMouseMoveParams, progress?: Progress): Promise<PageMouseMoveResult>;
- mouseDown(params: PageMouseDownParams, progress?: Progress): Promise<PageMouseDownResult>;
- mouseUp(params: PageMouseUpParams, progress?: Progress): Promise<PageMouseUpResult>;
- mouseClick(params: PageMouseClickParams, progress?: Progress): Promise<PageMouseClickResult>;
- mouseWheel(params: PageMouseWheelParams, progress?: Progress): Promise<PageMouseWheelResult>;
- touchscreenTap(params: PageTouchscreenTapParams, progress?: Progress): Promise<PageTouchscreenTapResult>;
- clearPageErrors(params?: PageClearPageErrorsParams, progress?: Progress): Promise<PageClearPageErrorsResult>;
- pageErrors(params: PagePageErrorsParams, progress?: Progress): Promise<PagePageErrorsResult>;
- pdf(params: PagePdfParams, progress?: Progress): Promise<PagePdfResult>;
- requests(params?: PageRequestsParams, progress?: Progress): Promise<PageRequestsResult>;
- startJSCoverage(params: PageStartJSCoverageParams, progress?: Progress): Promise<PageStartJSCoverageResult>;
- stopJSCoverage(params?: PageStopJSCoverageParams, progress?: Progress): Promise<PageStopJSCoverageResult>;
- startCSSCoverage(params: PageStartCSSCoverageParams, progress?: Progress): Promise<PageStartCSSCoverageResult>;
- stopCSSCoverage(params?: PageStopCSSCoverageParams, progress?: Progress): Promise<PageStopCSSCoverageResult>;
- bringToFront(params?: PageBringToFrontParams, progress?: Progress): Promise<PageBringToFrontResult>;
- pickLocator(params?: PagePickLocatorParams, progress?: Progress): Promise<PagePickLocatorResult>;
- cancelPickLocator(params?: PageCancelPickLocatorParams, progress?: Progress): Promise<PageCancelPickLocatorResult>;
- hideHighlight(params?: PageHideHighlightParams, progress?: Progress): Promise<PageHideHighlightResult>;
- screencastShowOverlay(params: PageScreencastShowOverlayParams, progress?: Progress): Promise<PageScreencastShowOverlayResult>;
- screencastRemoveOverlay(params: PageScreencastRemoveOverlayParams, progress?: Progress): Promise<PageScreencastRemoveOverlayResult>;
- screencastChapter(params: PageScreencastChapterParams, progress?: Progress): Promise<PageScreencastChapterResult>;
- screencastSetOverlayVisible(params: PageScreencastSetOverlayVisibleParams, progress?: Progress): Promise<PageScreencastSetOverlayVisibleResult>;
- screencastShowActions(params: PageScreencastShowActionsParams, progress?: Progress): Promise<PageScreencastShowActionsResult>;
- screencastHideActions(params?: PageScreencastHideActionsParams, progress?: Progress): Promise<PageScreencastHideActionsResult>;
- screencastStart(params: PageScreencastStartParams, progress?: Progress): Promise<PageScreencastStartResult>;
- screencastStop(params?: PageScreencastStopParams, progress?: Progress): Promise<PageScreencastStopResult>;
- updateSubscription(params: PageUpdateSubscriptionParams, progress?: Progress): Promise<PageUpdateSubscriptionResult>;
- setDockTile(params: PageSetDockTileParams, progress?: Progress): Promise<PageSetDockTileResult>;
+export interface BrowserTypeChannel extends BrowserTypeEventTarget, Channel {
+ _type_BrowserType: boolean;
+ launch(params: BrowserTypeLaunchParams, progress?: Progress): Promise<BrowserTypeLaunchResult>;
+ launchPersistentContext(params: BrowserTypeLaunchPersistentContextParams, progress?: Progress): Promise<BrowserTypeLaunchPersistentContextResult>;
+ connectOverCDP(params: BrowserTypeConnectOverCDPParams, progress?: Progress): Promise<BrowserTypeConnectOverCDPResult>;
+ connectToWorker(params: BrowserTypeConnectToWorkerParams, progress?: Progress): Promise<BrowserTypeConnectToWorkerResult>;
}
-export type PageBindingCallEvent = {
- binding: BindingCallChannel,
+export type BrowserTypeLaunchParams = {
+ channel?: string,
+ executablePath?: string,
+ args?: string[],
+ ignoreAllDefaultArgs?: boolean,
+ ignoreDefaultArgs?: string[],
+ handleSIGINT?: boolean,
+ handleSIGTERM?: boolean,
+ handleSIGHUP?: boolean,
+ timeout: number,
+ env?: NameValue[],
+ headless?: boolean,
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ downloadsPath?: string,
+ tracesDir?: string,
+ artifactsDir?: string,
+ chromiumSandbox?: boolean,
+ firefoxUserPrefs?: any,
+ cdpPort?: number,
+ slowMo?: number,
};
-export type PageCloseEvent = {};
-export type PageCrashEvent = {};
-export type PageDownloadEvent = {
- url: string,
- suggestedFilename: string,
- artifact: ArtifactChannel,
+export type BrowserTypeLaunchOptions = {
+ channel?: string,
+ executablePath?: string,
+ args?: string[],
+ ignoreAllDefaultArgs?: boolean,
+ ignoreDefaultArgs?: string[],
+ handleSIGINT?: boolean,
+ handleSIGTERM?: boolean,
+ handleSIGHUP?: boolean,
+ env?: NameValue[],
+ headless?: boolean,
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ downloadsPath?: string,
+ tracesDir?: string,
+ artifactsDir?: string,
+ chromiumSandbox?: boolean,
+ firefoxUserPrefs?: any,
+ cdpPort?: number,
+ slowMo?: number,
};
-export type PageViewportSizeChangedEvent = {
- viewportSize?: {
+export type BrowserTypeLaunchResult = {
+ browser: BrowserChannel,
+};
+export type BrowserTypeLaunchPersistentContextParams = {
+ channel?: string,
+ executablePath?: string,
+ args?: string[],
+ ignoreAllDefaultArgs?: boolean,
+ ignoreDefaultArgs?: string[],
+ handleSIGINT?: boolean,
+ handleSIGTERM?: boolean,
+ handleSIGHUP?: boolean,
+ timeout: number,
+ env?: NameValue[],
+ headless?: boolean,
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ downloadsPath?: string,
+ tracesDir?: string,
+ artifactsDir?: string,
+ chromiumSandbox?: boolean,
+ firefoxUserPrefs?: any,
+ cdpPort?: number,
+ noDefaultViewport?: boolean,
+ viewport?: {
+ width: number,
+ height: number,
+ },
+ screen?: {
width: number,
height: number,
},
+ ignoreHTTPSErrors?: boolean,
+ clientCertificates?: {
+ origin: string,
+ cert?: Binary,
+ key?: Binary,
+ passphrase?: string,
+ pfx?: Binary,
+ }[],
+ javaScriptEnabled?: boolean,
+ bypassCSP?: boolean,
+ userAgent?: string,
+ locale?: string,
+ timezoneId?: string,
+ geolocation?: {
+ longitude: number,
+ latitude: number,
+ accuracy?: number,
+ },
+ permissions?: string[],
+ extraHTTPHeaders?: NameValue[],
+ offline?: boolean,
+ httpCredentials?: {
+ username: string,
+ password: string,
+ origin?: string,
+ send?: 'always' | 'unauthorized',
+ },
+ deviceScaleFactor?: number,
+ isMobile?: boolean,
+ hasTouch?: boolean,
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+ baseURL?: string,
+ recordVideo?: {
+ dir?: string,
+ size?: {
+ width: number,
+ height: number,
+ },
+ showActions?: {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
+ },
+ },
+ strictSelectors?: boolean,
+ serviceWorkers?: 'allow' | 'block',
+ selectorEngines?: SelectorEngine[],
+ testIdAttributeName?: string,
+ userDataDir: string,
+ slowMo?: number,
+};
+export type BrowserTypeLaunchPersistentContextOptions = {
+ channel?: string,
+ executablePath?: string,
+ args?: string[],
+ ignoreAllDefaultArgs?: boolean,
+ ignoreDefaultArgs?: string[],
+ handleSIGINT?: boolean,
+ handleSIGTERM?: boolean,
+ handleSIGHUP?: boolean,
+ env?: NameValue[],
+ headless?: boolean,
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ downloadsPath?: string,
+ tracesDir?: string,
+ artifactsDir?: string,
+ chromiumSandbox?: boolean,
+ firefoxUserPrefs?: any,
+ cdpPort?: number,
+ noDefaultViewport?: boolean,
+ viewport?: {
+ width: number,
+ height: number,
+ },
+ screen?: {
+ width: number,
+ height: number,
+ },
+ ignoreHTTPSErrors?: boolean,
+ clientCertificates?: {
+ origin: string,
+ cert?: Binary,
+ key?: Binary,
+ passphrase?: string,
+ pfx?: Binary,
+ }[],
+ javaScriptEnabled?: boolean,
+ bypassCSP?: boolean,
+ userAgent?: string,
+ locale?: string,
+ timezoneId?: string,
+ geolocation?: {
+ longitude: number,
+ latitude: number,
+ accuracy?: number,
+ },
+ permissions?: string[],
+ extraHTTPHeaders?: NameValue[],
+ offline?: boolean,
+ httpCredentials?: {
+ username: string,
+ password: string,
+ origin?: string,
+ send?: 'always' | 'unauthorized',
+ },
+ deviceScaleFactor?: number,
+ isMobile?: boolean,
+ hasTouch?: boolean,
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+ baseURL?: string,
+ recordVideo?: {
+ dir?: string,
+ size?: {
+ width: number,
+ height: number,
+ },
+ showActions?: {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
+ },
+ },
+ strictSelectors?: boolean,
+ serviceWorkers?: 'allow' | 'block',
+ selectorEngines?: SelectorEngine[],
+ testIdAttributeName?: string,
+ slowMo?: number,
+};
+export type BrowserTypeLaunchPersistentContextResult = {
+ browser: BrowserChannel,
+ context: BrowserContextChannel,
+};
+export type BrowserTypeConnectOverCDPParams = {
+ endpointURL: string,
+ headers?: NameValue[],
+ slowMo?: number,
+ timeout: number,
+ isLocal?: boolean,
+ noDefaults?: boolean,
+};
+export type BrowserTypeConnectOverCDPOptions = {
+ headers?: NameValue[],
+ slowMo?: number,
+ isLocal?: boolean,
+ noDefaults?: boolean,
+};
+export type BrowserTypeConnectOverCDPResult = {
+ browser: BrowserChannel,
+ defaultContext?: BrowserContextChannel,
+};
+export type BrowserTypeConnectToWorkerParams = {
+ endpoint: string,
+ timeout: number,
+};
+export type BrowserTypeConnectToWorkerOptions = {
+
+};
+export type BrowserTypeConnectToWorkerResult = {
+ worker: WorkerChannel,
+};
+
+export interface BrowserTypeEvents {
+}
+
+export type Metadata = {
+ location?: {
+ file: string,
+ line?: number,
+ column?: number,
+ },
+ title?: string,
+ internal?: boolean,
+ stepId?: string,
+};
+
+export type ClientSideCallMetadata = {
+ id: number,
+ stack?: StackFrame[],
+};
+
+export type SDKLanguage = 'javascript' | 'python' | 'java' | 'csharp';
+// ----------- Disposable -----------
+export type DisposableInitializer = {};
+export interface DisposableEventTarget {
+}
+export interface DisposableChannel extends DisposableEventTarget, Channel {
+ _type_Disposable: boolean;
+ dispose(params?: DisposableDisposeParams, progress?: Progress): Promise<DisposableDisposeResult>;
+}
+export type DisposableDisposeParams = {};
+export type DisposableDisposeOptions = {};
+export type DisposableDisposeResult = void;
+
+export interface DisposableEvents {
+}
+
+// ----------- EventTarget -----------
+export type EventTargetInitializer = {};
+export interface EventTargetEventTarget {
+}
+export interface EventTargetChannel extends EventTargetEventTarget, Channel {
+ _type_EventTarget: boolean;
+ waitForEventInfo(params: EventTargetWaitForEventInfoParams, progress?: Progress): Promise<EventTargetWaitForEventInfoResult>;
+}
+export type EventTargetWaitForEventInfoParams = {
+ info: {
+ waitId: string,
+ phase: 'before' | 'after' | 'log',
+ event?: string,
+ message?: string,
+ error?: string,
+ },
+};
+export type EventTargetWaitForEventInfoOptions = {
+
+};
+export type EventTargetWaitForEventInfoResult = void;
+
+export interface EventTargetEvents {
+}
+
+// ----------- Frame -----------
+export type FrameInitializer = {
+ url: string,
+ name: string,
+ parentFrame?: FrameChannel,
+ loadStates: LifecycleEvent[],
+};
+export interface FrameEventTarget {
+ on(event: 'loadstate', callback: (params: FrameLoadstateEvent) => void): this;
+ on(event: 'navigated', callback: (params: FrameNavigatedEvent) => void): this;
+}
+export interface FrameChannel extends FrameEventTarget, Channel {
+ _type_Frame: boolean;
+ evalOnSelector(params: FrameEvalOnSelectorParams, progress?: Progress): Promise<FrameEvalOnSelectorResult>;
+ evalOnSelectorAll(params: FrameEvalOnSelectorAllParams, progress?: Progress): Promise<FrameEvalOnSelectorAllResult>;
+ addScriptTag(params: FrameAddScriptTagParams, progress?: Progress): Promise<FrameAddScriptTagResult>;
+ addStyleTag(params: FrameAddStyleTagParams, progress?: Progress): Promise<FrameAddStyleTagResult>;
+ ariaSnapshot(params: FrameAriaSnapshotParams, progress?: Progress): Promise<FrameAriaSnapshotResult>;
+ blur(params: FrameBlurParams, progress?: Progress): Promise<FrameBlurResult>;
+ check(params: FrameCheckParams, progress?: Progress): Promise<FrameCheckResult>;
+ click(params: FrameClickParams, progress?: Progress): Promise<FrameClickResult>;
+ content(params?: FrameContentParams, progress?: Progress): Promise<FrameContentResult>;
+ dragAndDrop(params: FrameDragAndDropParams, progress?: Progress): Promise<FrameDragAndDropResult>;
+ drop(params: FrameDropParams, progress?: Progress): Promise<FrameDropResult>;
+ dblclick(params: FrameDblclickParams, progress?: Progress): Promise<FrameDblclickResult>;
+ dispatchEvent(params: FrameDispatchEventParams, progress?: Progress): Promise<FrameDispatchEventResult>;
+ evaluateExpression(params: FrameEvaluateExpressionParams, progress?: Progress): Promise<FrameEvaluateExpressionResult>;
+ evaluateExpressionHandle(params: FrameEvaluateExpressionHandleParams, progress?: Progress): Promise<FrameEvaluateExpressionHandleResult>;
+ fill(params: FrameFillParams, progress?: Progress): Promise<FrameFillResult>;
+ focus(params: FrameFocusParams, progress?: Progress): Promise<FrameFocusResult>;
+ frameElement(params?: FrameFrameElementParams, progress?: Progress): Promise<FrameFrameElementResult>;
+ resolveSelector(params: FrameResolveSelectorParams, progress?: Progress): Promise<FrameResolveSelectorResult>;
+ highlight(params: FrameHighlightParams, progress?: Progress): Promise<FrameHighlightResult>;
+ hideHighlight(params: FrameHideHighlightParams, progress?: Progress): Promise<FrameHideHighlightResult>;
+ getAttribute(params: FrameGetAttributeParams, progress?: Progress): Promise<FrameGetAttributeResult>;
+ goto(params: FrameGotoParams, progress?: Progress): Promise<FrameGotoResult>;
+ hover(params: FrameHoverParams, progress?: Progress): Promise<FrameHoverResult>;
+ innerHTML(params: FrameInnerHTMLParams, progress?: Progress): Promise<FrameInnerHTMLResult>;
+ innerText(params: FrameInnerTextParams, progress?: Progress): Promise<FrameInnerTextResult>;
+ inputValue(params: FrameInputValueParams, progress?: Progress): Promise<FrameInputValueResult>;
+ isChecked(params: FrameIsCheckedParams, progress?: Progress): Promise<FrameIsCheckedResult>;
+ isDisabled(params: FrameIsDisabledParams, progress?: Progress): Promise<FrameIsDisabledResult>;
+ isEnabled(params: FrameIsEnabledParams, progress?: Progress): Promise<FrameIsEnabledResult>;
+ isHidden(params: FrameIsHiddenParams, progress?: Progress): Promise<FrameIsHiddenResult>;
+ isVisible(params: FrameIsVisibleParams, progress?: Progress): Promise<FrameIsVisibleResult>;
+ isEditable(params: FrameIsEditableParams, progress?: Progress): Promise<FrameIsEditableResult>;
+ press(params: FramePressParams, progress?: Progress): Promise<FramePressResult>;
+ querySelector(params: FrameQuerySelectorParams, progress?: Progress): Promise<FrameQuerySelectorResult>;
+ querySelectorAll(params: FrameQuerySelectorAllParams, progress?: Progress): Promise<FrameQuerySelectorAllResult>;
+ queryCount(params: FrameQueryCountParams, progress?: Progress): Promise<FrameQueryCountResult>;
+ selectOption(params: FrameSelectOptionParams, progress?: Progress): Promise<FrameSelectOptionResult>;
+ setContent(params: FrameSetContentParams, progress?: Progress): Promise<FrameSetContentResult>;
+ setInputFiles(params: FrameSetInputFilesParams, progress?: Progress): Promise<FrameSetInputFilesResult>;
+ tap(params: FrameTapParams, progress?: Progress): Promise<FrameTapResult>;
+ textContent(params: FrameTextContentParams, progress?: Progress): Promise<FrameTextContentResult>;
+ title(params?: FrameTitleParams, progress?: Progress): Promise<FrameTitleResult>;
+ type(params: FrameTypeParams, progress?: Progress): Promise<FrameTypeResult>;
+ uncheck(params: FrameUncheckParams, progress?: Progress): Promise<FrameUncheckResult>;
+ waitForTimeout(params: FrameWaitForTimeoutParams, progress?: Progress): Promise<FrameWaitForTimeoutResult>;
+ waitForFunction(params: FrameWaitForFunctionParams, progress?: Progress): Promise<FrameWaitForFunctionResult>;
+ waitForSelector(params: FrameWaitForSelectorParams, progress?: Progress): Promise<FrameWaitForSelectorResult>;
+ expect(params: FrameExpectParams, progress?: Progress): Promise<FrameExpectResult>;
+}
+export type FrameLoadstateEvent = {
+ add?: LifecycleEvent,
+ remove?: LifecycleEvent,
+};
+export type FrameNavigatedEvent = {
+ url: string,
+ name: string,
+ newDocument?: {
+ request?: RequestChannel,
+ },
+ error?: string,
+};
+export type FrameEvalOnSelectorParams = {
+ selector: string,
+ strict?: boolean,
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+};
+export type FrameEvalOnSelectorOptions = {
+ strict?: boolean,
+ isFunction?: boolean,
+};
+export type FrameEvalOnSelectorResult = {
+ value: SerializedValue,
+};
+export type FrameEvalOnSelectorAllParams = {
+ selector: string,
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+};
+export type FrameEvalOnSelectorAllOptions = {
+ isFunction?: boolean,
+};
+export type FrameEvalOnSelectorAllResult = {
+ value: SerializedValue,
+};
+export type FrameAddScriptTagParams = {
+ url?: string,
+ content?: string,
+ type?: string,
+};
+export type FrameAddScriptTagOptions = {
+ url?: string,
+ content?: string,
+ type?: string,
+};
+export type FrameAddScriptTagResult = {
+ element: ElementHandleChannel,
+};
+export type FrameAddStyleTagParams = {
+ url?: string,
+ content?: string,
};
-export type PageFileChooserEvent = {
+export type FrameAddStyleTagOptions = {
+ url?: string,
+ content?: string,
+};
+export type FrameAddStyleTagResult = {
element: ElementHandleChannel,
- isMultiple: boolean,
};
-export type PageFrameAttachedEvent = {
- frame: FrameChannel,
+export type FrameAriaSnapshotParams = {
+ mode?: 'ai' | 'default',
+ track?: string,
+ selector?: string,
+ depth?: number,
+ boxes?: boolean,
+ timeout: number,
};
-export type PageFrameDetachedEvent = {
- frame: FrameChannel,
+export type FrameAriaSnapshotOptions = {
+ mode?: 'ai' | 'default',
+ track?: string,
+ selector?: string,
+ depth?: number,
+ boxes?: boolean,
};
-export type PageLocatorHandlerTriggeredEvent = {
- uid: number,
+export type FrameAriaSnapshotResult = {
+ snapshot: string,
};
-export type PageRouteEvent = {
- route: RouteChannel,
+export type FrameBlurParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageScreencastFrameEvent = {
- data: Binary,
+export type FrameBlurOptions = {
+ strict?: boolean,
};
-export type PageWebSocketRouteEvent = {
- webSocketRoute: WebSocketRouteChannel,
+export type FrameBlurResult = void;
+export type FrameCheckParams = {
+ selector: string,
+ strict?: boolean,
+ force?: boolean,
+ position?: Point,
+ timeout: number,
+ trial?: boolean,
};
-export type PageWebSocketEvent = {
- webSocket: WebSocketChannel,
+export type FrameCheckOptions = {
+ strict?: boolean,
+ force?: boolean,
+ position?: Point,
+ trial?: boolean,
};
-export type PageWorkerEvent = {
- worker: WorkerChannel,
+export type FrameCheckResult = void;
+export type FrameClickParams = {
+ selector: string,
+ strict?: boolean,
+ force?: boolean,
+ noWaitAfter?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
+ timeout: number,
+ trial?: boolean,
+ steps?: number,
};
-export type PageAddInitScriptParams = {
+export type FrameClickOptions = {
+ strict?: boolean,
+ force?: boolean,
+ noWaitAfter?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
+ trial?: boolean,
+ steps?: number,
+};
+export type FrameClickResult = void;
+export type FrameContentParams = {};
+export type FrameContentOptions = {};
+export type FrameContentResult = {
+ value: string,
+};
+export type FrameDragAndDropParams = {
source: string,
+ target: string,
+ force?: boolean,
+ timeout: number,
+ trial?: boolean,
+ sourcePosition?: Point,
+ targetPosition?: Point,
+ strict?: boolean,
+ steps?: number,
};
-export type PageAddInitScriptOptions = {
-
+export type FrameDragAndDropOptions = {
+ force?: boolean,
+ trial?: boolean,
+ sourcePosition?: Point,
+ targetPosition?: Point,
+ strict?: boolean,
+ steps?: number,
};
-export type PageAddInitScriptResult = {
- disposable: DisposableChannel,
+export type FrameDragAndDropResult = void;
+export type FrameDropParams = {
+ selector: string,
+ strict?: boolean,
+ position?: Point,
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
+ }[],
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
+ data?: {
+ mimeType: string,
+ value: string,
+ }[],
+ timeout: number,
};
-export type PageCloseParams = {
- runBeforeUnload?: boolean,
- reason?: string,
+export type FrameDropOptions = {
+ strict?: boolean,
+ position?: Point,
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
+ }[],
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
+ data?: {
+ mimeType: string,
+ value: string,
+ }[],
};
-export type PageCloseOptions = {
- runBeforeUnload?: boolean,
- reason?: string,
+export type FrameDropResult = void;
+export type FrameDblclickParams = {
+ selector: string,
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ timeout: number,
+ trial?: boolean,
+ steps?: number,
};
-export type PageCloseResult = void;
-export type PageClearConsoleMessagesParams = {};
-export type PageClearConsoleMessagesOptions = {};
-export type PageClearConsoleMessagesResult = void;
-export type PageConsoleMessagesParams = {
- filter?: ConsoleMessagesFilter,
+export type FrameDblclickOptions = {
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ trial?: boolean,
+ steps?: number,
};
-export type PageConsoleMessagesOptions = {
- filter?: ConsoleMessagesFilter,
+export type FrameDblclickResult = void;
+export type FrameDispatchEventParams = {
+ selector: string,
+ strict?: boolean,
+ type: string,
+ eventInit: SerializedArgument,
+ timeout: number,
};
-export type PageConsoleMessagesResult = {
- messages: {
- type: string,
- text: string,
- args: JSHandleChannel[],
- location: {
- url: string,
- lineNumber: number,
- columnNumber: number,
- },
- timestamp: number,
- }[],
+export type FrameDispatchEventOptions = {
+ strict?: boolean,
};
-export type PageEmulateMediaParams = {
- media?: 'screen' | 'print' | 'no-override',
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- contrast?: 'no-preference' | 'more' | 'no-override',
+export type FrameDispatchEventResult = void;
+export type FrameEvaluateExpressionParams = {
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
};
-export type PageEmulateMediaOptions = {
- media?: 'screen' | 'print' | 'no-override',
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- contrast?: 'no-preference' | 'more' | 'no-override',
+export type FrameEvaluateExpressionOptions = {
+ isFunction?: boolean,
};
-export type PageEmulateMediaResult = void;
-export type PageExposeBindingParams = {
- name: string,
+export type FrameEvaluateExpressionResult = {
+ value: SerializedValue,
};
-export type PageExposeBindingOptions = {
-
+export type FrameEvaluateExpressionHandleParams = {
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
};
-export type PageExposeBindingResult = {
- disposable: DisposableChannel,
+export type FrameEvaluateExpressionHandleOptions = {
+ isFunction?: boolean,
};
-export type PageGoBackParams = {
- timeout: number,
- waitUntil?: LifecycleEvent,
+export type FrameEvaluateExpressionHandleResult = {
+ handle: JSHandleChannel,
};
-export type PageGoBackOptions = {
- waitUntil?: LifecycleEvent,
+export type FrameFillParams = {
+ selector: string,
+ strict?: boolean,
+ value: string,
+ force?: boolean,
+ timeout: number,
};
-export type PageGoBackResult = {
- response?: ResponseChannel,
+export type FrameFillOptions = {
+ strict?: boolean,
+ force?: boolean,
};
-export type PageGoForwardParams = {
+export type FrameFillResult = void;
+export type FrameFocusParams = {
+ selector: string,
+ strict?: boolean,
timeout: number,
- waitUntil?: LifecycleEvent,
};
-export type PageGoForwardOptions = {
- waitUntil?: LifecycleEvent,
+export type FrameFocusOptions = {
+ strict?: boolean,
};
-export type PageGoForwardResult = {
- response?: ResponseChannel,
+export type FrameFocusResult = void;
+export type FrameFrameElementParams = {};
+export type FrameFrameElementOptions = {};
+export type FrameFrameElementResult = {
+ element: ElementHandleChannel,
};
-export type PageRequestGCParams = {};
-export type PageRequestGCOptions = {};
-export type PageRequestGCResult = void;
-export type PageRegisterLocatorHandlerParams = {
+export type FrameResolveSelectorParams = {
selector: string,
- noWaitAfter?: boolean,
};
-export type PageRegisterLocatorHandlerOptions = {
- noWaitAfter?: boolean,
+export type FrameResolveSelectorOptions = {
+
};
-export type PageRegisterLocatorHandlerResult = {
- uid: number,
+export type FrameResolveSelectorResult = {
+ resolvedSelector: string,
};
-export type PageResolveLocatorHandlerNoReplyParams = {
- uid: number,
- remove?: boolean,
+export type FrameHighlightParams = {
+ selector: string,
+ style?: string,
};
-export type PageResolveLocatorHandlerNoReplyOptions = {
- remove?: boolean,
+export type FrameHighlightOptions = {
+ style?: string,
};
-export type PageResolveLocatorHandlerNoReplyResult = void;
-export type PageUnregisterLocatorHandlerParams = {
- uid: number,
+export type FrameHighlightResult = void;
+export type FrameHideHighlightParams = {
+ selector: string,
};
-export type PageUnregisterLocatorHandlerOptions = {
+export type FrameHideHighlightOptions = {
};
-export type PageUnregisterLocatorHandlerResult = void;
-export type PageReloadParams = {
+export type FrameHideHighlightResult = void;
+export type FrameGetAttributeParams = {
+ selector: string,
+ strict?: boolean,
+ name: string,
+ timeout: number,
+};
+export type FrameGetAttributeOptions = {
+ strict?: boolean,
+};
+export type FrameGetAttributeResult = {
+ value?: string,
+};
+export type FrameGotoParams = {
+ url: string,
timeout: number,
waitUntil?: LifecycleEvent,
+ referer?: string,
};
-export type PageReloadOptions = {
+export type FrameGotoOptions = {
waitUntil?: LifecycleEvent,
+ referer?: string,
};
-export type PageReloadResult = {
+export type FrameGotoResult = {
response?: ResponseChannel,
};
-export type PageExpectScreenshotParams = {
- expected?: Binary,
+export type FrameHoverParams = {
+ selector: string,
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
timeout: number,
- isNot: boolean,
- locator?: {
- frame: FrameChannel,
- selector: string,
- },
- comparator?: string,
- maxDiffPixels?: number,
- maxDiffPixelRatio?: number,
- threshold?: number,
- fullPage?: boolean,
- clip?: Rect,
- omitBackground?: boolean,
- caret?: 'hide' | 'initial',
- animations?: 'disabled' | 'allow',
- scale?: 'css' | 'device',
- mask?: {
- frame: FrameChannel,
- selector: string,
- }[],
- maskColor?: string,
- style?: string,
-};
-export type PageExpectScreenshotOptions = {
- expected?: Binary,
- locator?: {
- frame: FrameChannel,
- selector: string,
- },
- comparator?: string,
- maxDiffPixels?: number,
- maxDiffPixelRatio?: number,
- threshold?: number,
- fullPage?: boolean,
- clip?: Rect,
- omitBackground?: boolean,
- caret?: 'hide' | 'initial',
- animations?: 'disabled' | 'allow',
- scale?: 'css' | 'device',
- mask?: {
- frame: FrameChannel,
- selector: string,
- }[],
- maskColor?: string,
- style?: string,
+ trial?: boolean,
};
-export type PageExpectScreenshotResult = {
- diff?: Binary,
- errorMessage?: string,
- actual?: Binary,
- previous?: Binary,
- timedOut?: boolean,
- log?: string[],
+export type FrameHoverOptions = {
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ trial?: boolean,
};
-export type PageScreenshotParams = {
+export type FrameHoverResult = void;
+export type FrameInnerHTMLParams = {
+ selector: string,
+ strict?: boolean,
timeout: number,
- type?: 'png' | 'jpeg',
- quality?: number,
- fullPage?: boolean,
- clip?: Rect,
- omitBackground?: boolean,
- caret?: 'hide' | 'initial',
- animations?: 'disabled' | 'allow',
- scale?: 'css' | 'device',
- mask?: {
- frame: FrameChannel,
- selector: string,
- }[],
- maskColor?: string,
- style?: string,
};
-export type PageScreenshotOptions = {
- type?: 'png' | 'jpeg',
- quality?: number,
- fullPage?: boolean,
- clip?: Rect,
- omitBackground?: boolean,
- caret?: 'hide' | 'initial',
- animations?: 'disabled' | 'allow',
- scale?: 'css' | 'device',
- mask?: {
- frame: FrameChannel,
- selector: string,
- }[],
- maskColor?: string,
- style?: string,
+export type FrameInnerHTMLOptions = {
+ strict?: boolean,
};
-export type PageScreenshotResult = {
- binary: Binary,
+export type FrameInnerHTMLResult = {
+ value: string,
};
-export type PageSetExtraHTTPHeadersParams = {
- headers: NameValue[],
+export type FrameInnerTextParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageSetExtraHTTPHeadersOptions = {
-
+export type FrameInnerTextOptions = {
+ strict?: boolean,
};
-export type PageSetExtraHTTPHeadersResult = void;
-export type PageSetNetworkInterceptionPatternsParams = {
- patterns: {
- glob?: string,
- regexSource?: string,
- regexFlags?: string,
- urlPattern?: URLPattern,
- }[],
+export type FrameInnerTextResult = {
+ value: string,
};
-export type PageSetNetworkInterceptionPatternsOptions = {
-
+export type FrameInputValueParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageSetNetworkInterceptionPatternsResult = void;
-export type PageSetWebSocketInterceptionPatternsParams = {
- patterns: {
- glob?: string,
- regexSource?: string,
- regexFlags?: string,
- urlPattern?: URLPattern,
- }[],
+export type FrameInputValueOptions = {
+ strict?: boolean,
};
-export type PageSetWebSocketInterceptionPatternsOptions = {
-
+export type FrameInputValueResult = {
+ value: string,
};
-export type PageSetWebSocketInterceptionPatternsResult = void;
-export type PageSetViewportSizeParams = {
- viewportSize: {
- width: number,
- height: number,
- },
+export type FrameIsCheckedParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageSetViewportSizeOptions = {
-
+export type FrameIsCheckedOptions = {
+ strict?: boolean,
};
-export type PageSetViewportSizeResult = void;
-export type PageKeyboardDownParams = {
- key: string,
+export type FrameIsCheckedResult = {
+ value: boolean,
};
-export type PageKeyboardDownOptions = {
-
+export type FrameIsDisabledParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageKeyboardDownResult = void;
-export type PageKeyboardUpParams = {
- key: string,
+export type FrameIsDisabledOptions = {
+ strict?: boolean,
};
-export type PageKeyboardUpOptions = {
-
+export type FrameIsDisabledResult = {
+ value: boolean,
};
-export type PageKeyboardUpResult = void;
-export type PageKeyboardInsertTextParams = {
- text: string,
+export type FrameIsEnabledParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageKeyboardInsertTextOptions = {
-
+export type FrameIsEnabledOptions = {
+ strict?: boolean,
};
-export type PageKeyboardInsertTextResult = void;
-export type PageKeyboardTypeParams = {
- text: string,
- delay?: number,
+export type FrameIsEnabledResult = {
+ value: boolean,
};
-export type PageKeyboardTypeOptions = {
- delay?: number,
+export type FrameIsHiddenParams = {
+ selector: string,
+ strict?: boolean,
};
-export type PageKeyboardTypeResult = void;
-export type PageKeyboardPressParams = {
- key: string,
- delay?: number,
+export type FrameIsHiddenOptions = {
+ strict?: boolean,
};
-export type PageKeyboardPressOptions = {
- delay?: number,
+export type FrameIsHiddenResult = {
+ value: boolean,
};
-export type PageKeyboardPressResult = void;
-export type PageMouseMoveParams = {
- x: number,
- y: number,
- steps?: number,
+export type FrameIsVisibleParams = {
+ selector: string,
+ strict?: boolean,
};
-export type PageMouseMoveOptions = {
- steps?: number,
+export type FrameIsVisibleOptions = {
+ strict?: boolean,
};
-export type PageMouseMoveResult = void;
-export type PageMouseDownParams = {
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+export type FrameIsVisibleResult = {
+ value: boolean,
};
-export type PageMouseDownOptions = {
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+export type FrameIsEditableParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageMouseDownResult = void;
-export type PageMouseUpParams = {
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+export type FrameIsEditableOptions = {
+ strict?: boolean,
};
-export type PageMouseUpOptions = {
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+export type FrameIsEditableResult = {
+ value: boolean,
};
-export type PageMouseUpResult = void;
-export type PageMouseClickParams = {
- x: number,
- y: number,
+export type FramePressParams = {
+ selector: string,
+ strict?: boolean,
+ key: string,
delay?: number,
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+ noWaitAfter?: boolean,
+ timeout: number,
};
-export type PageMouseClickOptions = {
+export type FramePressOptions = {
+ strict?: boolean,
delay?: number,
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
+ noWaitAfter?: boolean,
};
-export type PageMouseClickResult = void;
-export type PageMouseWheelParams = {
- deltaX: number,
- deltaY: number,
+export type FramePressResult = void;
+export type FrameQuerySelectorParams = {
+ selector: string,
+ strict?: boolean,
};
-export type PageMouseWheelOptions = {
-
+export type FrameQuerySelectorOptions = {
+ strict?: boolean,
};
-export type PageMouseWheelResult = void;
-export type PageTouchscreenTapParams = {
- x: number,
- y: number,
+export type FrameQuerySelectorResult = {
+ element?: ElementHandleChannel,
};
-export type PageTouchscreenTapOptions = {
+export type FrameQuerySelectorAllParams = {
+ selector: string,
+};
+export type FrameQuerySelectorAllOptions = {
};
-export type PageTouchscreenTapResult = void;
-export type PageClearPageErrorsParams = {};
-export type PageClearPageErrorsOptions = {};
-export type PageClearPageErrorsResult = void;
-export type PagePageErrorsParams = {
- filter?: ConsoleMessagesFilter,
+export type FrameQuerySelectorAllResult = {
+ elements: ElementHandleChannel[],
};
-export type PagePageErrorsOptions = {
- filter?: ConsoleMessagesFilter,
+export type FrameQueryCountParams = {
+ selector: string,
};
-export type PagePageErrorsResult = {
- errors: SerializedError[],
+export type FrameQueryCountOptions = {
+
};
-export type PagePdfParams = {
- scale?: number,
- displayHeaderFooter?: boolean,
- headerTemplate?: string,
- footerTemplate?: string,
- printBackground?: boolean,
- landscape?: boolean,
- pageRanges?: string,
- format?: string,
- width?: string,
- height?: string,
- preferCSSPageSize?: boolean,
- margin?: {
- top?: string,
- bottom?: string,
- left?: string,
- right?: string,
- },
- tagged?: boolean,
- outline?: boolean,
+export type FrameQueryCountResult = {
+ value: number,
};
-export type PagePdfOptions = {
- scale?: number,
- displayHeaderFooter?: boolean,
- headerTemplate?: string,
- footerTemplate?: string,
- printBackground?: boolean,
- landscape?: boolean,
- pageRanges?: string,
- format?: string,
- width?: string,
- height?: string,
- preferCSSPageSize?: boolean,
- margin?: {
- top?: string,
- bottom?: string,
- left?: string,
- right?: string,
- },
- tagged?: boolean,
- outline?: boolean,
+export type FrameSelectOptionParams = {
+ selector: string,
+ strict?: boolean,
+ elements?: ElementHandleChannel[],
+ options?: {
+ valueOrLabel?: string,
+ value?: string,
+ label?: string,
+ index?: number,
+ }[],
+ force?: boolean,
+ timeout: number,
};
-export type PagePdfResult = {
- pdf: Binary,
+export type FrameSelectOptionOptions = {
+ strict?: boolean,
+ elements?: ElementHandleChannel[],
+ options?: {
+ valueOrLabel?: string,
+ value?: string,
+ label?: string,
+ index?: number,
+ }[],
+ force?: boolean,
};
-export type PageRequestsParams = {};
-export type PageRequestsOptions = {};
-export type PageRequestsResult = {
- requests: RequestChannel[],
+export type FrameSelectOptionResult = {
+ values: string[],
};
-export type PageStartJSCoverageParams = {
- resetOnNavigation?: boolean,
- reportAnonymousScripts?: boolean,
+export type FrameSetContentParams = {
+ html: string,
+ timeout: number,
+ waitUntil?: LifecycleEvent,
};
-export type PageStartJSCoverageOptions = {
- resetOnNavigation?: boolean,
- reportAnonymousScripts?: boolean,
+export type FrameSetContentOptions = {
+ waitUntil?: LifecycleEvent,
};
-export type PageStartJSCoverageResult = void;
-export type PageStopJSCoverageParams = {};
-export type PageStopJSCoverageOptions = {};
-export type PageStopJSCoverageResult = {
- entries: {
- url: string,
- scriptId: string,
- source?: string,
- functions: {
- functionName: string,
- isBlockCoverage: boolean,
- ranges: {
- startOffset: number,
- endOffset: number,
- count: number,
- }[],
- }[],
+export type FrameSetContentResult = void;
+export type FrameSetInputFilesParams = {
+ selector: string,
+ strict?: boolean,
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
}[],
+ localDirectory?: string,
+ directoryStream?: WritableStreamChannel,
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
+ timeout: number,
};
-export type PageStartCSSCoverageParams = {
- resetOnNavigation?: boolean,
-};
-export type PageStartCSSCoverageOptions = {
- resetOnNavigation?: boolean,
-};
-export type PageStartCSSCoverageResult = void;
-export type PageStopCSSCoverageParams = {};
-export type PageStopCSSCoverageOptions = {};
-export type PageStopCSSCoverageResult = {
- entries: {
- url: string,
- text?: string,
- ranges: {
- start: number,
- end: number,
- }[],
+export type FrameSetInputFilesOptions = {
+ strict?: boolean,
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
}[],
+ localDirectory?: string,
+ directoryStream?: WritableStreamChannel,
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
};
-export type PageBringToFrontParams = {};
-export type PageBringToFrontOptions = {};
-export type PageBringToFrontResult = void;
-export type PagePickLocatorParams = {};
-export type PagePickLocatorOptions = {};
-export type PagePickLocatorResult = {
+export type FrameSetInputFilesResult = void;
+export type FrameTapParams = {
selector: string,
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ timeout: number,
+ trial?: boolean,
};
-export type PageCancelPickLocatorParams = {};
-export type PageCancelPickLocatorOptions = {};
-export type PageCancelPickLocatorResult = void;
-export type PageHideHighlightParams = {};
-export type PageHideHighlightOptions = {};
-export type PageHideHighlightResult = void;
-export type PageScreencastShowOverlayParams = {
- html: string,
- duration?: number,
-};
-export type PageScreencastShowOverlayOptions = {
- duration?: number,
+export type FrameTapOptions = {
+ strict?: boolean,
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ trial?: boolean,
};
-export type PageScreencastShowOverlayResult = {
- id: string,
+export type FrameTapResult = void;
+export type FrameTextContentParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
};
-export type PageScreencastRemoveOverlayParams = {
- id: string,
+export type FrameTextContentOptions = {
+ strict?: boolean,
};
-export type PageScreencastRemoveOverlayOptions = {
-
+export type FrameTextContentResult = {
+ value?: string,
};
-export type PageScreencastRemoveOverlayResult = void;
-export type PageScreencastChapterParams = {
- title: string,
- description?: string,
- duration?: number,
+export type FrameTitleParams = {};
+export type FrameTitleOptions = {};
+export type FrameTitleResult = {
+ value: string,
};
-export type PageScreencastChapterOptions = {
- description?: string,
- duration?: number,
+export type FrameTypeParams = {
+ selector: string,
+ strict?: boolean,
+ text: string,
+ delay?: number,
+ timeout: number,
};
-export type PageScreencastChapterResult = void;
-export type PageScreencastSetOverlayVisibleParams = {
- visible: boolean,
+export type FrameTypeOptions = {
+ strict?: boolean,
+ delay?: number,
};
-export type PageScreencastSetOverlayVisibleOptions = {
-
+export type FrameTypeResult = void;
+export type FrameUncheckParams = {
+ selector: string,
+ strict?: boolean,
+ force?: boolean,
+ position?: Point,
+ timeout: number,
+ trial?: boolean,
};
-export type PageScreencastSetOverlayVisibleResult = void;
-export type PageScreencastShowActionsParams = {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
+export type FrameUncheckOptions = {
+ strict?: boolean,
+ force?: boolean,
+ position?: Point,
+ trial?: boolean,
};
-export type PageScreencastShowActionsOptions = {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
+export type FrameUncheckResult = void;
+export type FrameWaitForTimeoutParams = {
+ waitTimeout: number,
};
-export type PageScreencastShowActionsResult = void;
-export type PageScreencastHideActionsParams = {};
-export type PageScreencastHideActionsOptions = {};
-export type PageScreencastHideActionsResult = void;
-export type PageScreencastStartParams = {
- size?: {
- width: number,
- height: number,
- },
- quality?: number,
- sendFrames?: boolean,
- record?: boolean,
+export type FrameWaitForTimeoutOptions = {
+
};
-export type PageScreencastStartOptions = {
- size?: {
- width: number,
- height: number,
- },
- quality?: number,
- sendFrames?: boolean,
- record?: boolean,
+export type FrameWaitForTimeoutResult = void;
+export type FrameWaitForFunctionParams = {
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+ timeout: number,
+ pollingInterval?: number,
};
-export type PageScreencastStartResult = {
- artifact?: ArtifactChannel,
+export type FrameWaitForFunctionOptions = {
+ isFunction?: boolean,
+ pollingInterval?: number,
};
-export type PageScreencastStopParams = {};
-export type PageScreencastStopOptions = {};
-export type PageScreencastStopResult = void;
-export type PageUpdateSubscriptionParams = {
- event: 'console' | 'dialog' | 'fileChooser' | 'request' | 'response' | 'requestFinished' | 'requestFailed',
- enabled: boolean,
+export type FrameWaitForFunctionResult = {
+ handle: JSHandleChannel,
};
-export type PageUpdateSubscriptionOptions = {
-
+export type FrameWaitForSelectorParams = {
+ selector: string,
+ strict?: boolean,
+ timeout: number,
+ state?: 'attached' | 'detached' | 'visible' | 'hidden',
+ omitReturnValue?: boolean,
};
-export type PageUpdateSubscriptionResult = void;
-export type PageSetDockTileParams = {
- image: Binary,
+export type FrameWaitForSelectorOptions = {
+ strict?: boolean,
+ state?: 'attached' | 'detached' | 'visible' | 'hidden',
+ omitReturnValue?: boolean,
};
-export type PageSetDockTileOptions = {
-
+export type FrameWaitForSelectorResult = {
+ element?: ElementHandleChannel,
};
-export type PageSetDockTileResult = void;
-
-export interface PageEvents {
- 'bindingCall': PageBindingCallEvent;
- 'close': PageCloseEvent;
- 'crash': PageCrashEvent;
- 'download': PageDownloadEvent;
- 'viewportSizeChanged': PageViewportSizeChangedEvent;
- 'fileChooser': PageFileChooserEvent;
- 'frameAttached': PageFrameAttachedEvent;
- 'frameDetached': PageFrameDetachedEvent;
- 'locatorHandlerTriggered': PageLocatorHandlerTriggeredEvent;
- 'route': PageRouteEvent;
- 'screencastFrame': PageScreencastFrameEvent;
- 'webSocketRoute': PageWebSocketRouteEvent;
- 'webSocket': PageWebSocketEvent;
- 'worker': PageWorkerEvent;
-}
-
-// ----------- Frame -----------
-export type FrameInitializer = {
- url: string,
- name: string,
- parentFrame?: FrameChannel,
- loadStates: LifecycleEvent[],
+export type FrameExpectParams = {
+ selector?: string,
+ expression: string,
+ expressionArg?: any,
+ pseudo?: 'before' | 'after',
+ expectedText?: ExpectedTextValue[],
+ expectedNumber?: number,
+ expectedValue?: SerializedArgument,
+ useInnerText?: boolean,
+ isNot: boolean,
+ timeout: number,
};
-export interface FrameEventTarget {
- on(event: 'loadstate', callback: (params: FrameLoadstateEvent) => void): this;
- on(event: 'navigated', callback: (params: FrameNavigatedEvent) => void): this;
-}
-export interface FrameChannel extends FrameEventTarget, Channel {
- _type_Frame: boolean;
- evalOnSelector(params: FrameEvalOnSelectorParams, progress?: Progress): Promise<FrameEvalOnSelectorResult>;
- evalOnSelectorAll(params: FrameEvalOnSelectorAllParams, progress?: Progress): Promise<FrameEvalOnSelectorAllResult>;
- addScriptTag(params: FrameAddScriptTagParams, progress?: Progress): Promise<FrameAddScriptTagResult>;
- addStyleTag(params: FrameAddStyleTagParams, progress?: Progress): Promise<FrameAddStyleTagResult>;
- ariaSnapshot(params: FrameAriaSnapshotParams, progress?: Progress): Promise<FrameAriaSnapshotResult>;
- blur(params: FrameBlurParams, progress?: Progress): Promise<FrameBlurResult>;
- check(params: FrameCheckParams, progress?: Progress): Promise<FrameCheckResult>;
- click(params: FrameClickParams, progress?: Progress): Promise<FrameClickResult>;
- content(params?: FrameContentParams, progress?: Progress): Promise<FrameContentResult>;
- dragAndDrop(params: FrameDragAndDropParams, progress?: Progress): Promise<FrameDragAndDropResult>;
- drop(params: FrameDropParams, progress?: Progress): Promise<FrameDropResult>;
- dblclick(params: FrameDblclickParams, progress?: Progress): Promise<FrameDblclickResult>;
- dispatchEvent(params: FrameDispatchEventParams, progress?: Progress): Promise<FrameDispatchEventResult>;
- evaluateExpression(params: FrameEvaluateExpressionParams, progress?: Progress): Promise<FrameEvaluateExpressionResult>;
- evaluateExpressionHandle(params: FrameEvaluateExpressionHandleParams, progress?: Progress): Promise<FrameEvaluateExpressionHandleResult>;
- fill(params: FrameFillParams, progress?: Progress): Promise<FrameFillResult>;
- focus(params: FrameFocusParams, progress?: Progress): Promise<FrameFocusResult>;
- frameElement(params?: FrameFrameElementParams, progress?: Progress): Promise<FrameFrameElementResult>;
- resolveSelector(params: FrameResolveSelectorParams, progress?: Progress): Promise<FrameResolveSelectorResult>;
- highlight(params: FrameHighlightParams, progress?: Progress): Promise<FrameHighlightResult>;
- hideHighlight(params: FrameHideHighlightParams, progress?: Progress): Promise<FrameHideHighlightResult>;
- getAttribute(params: FrameGetAttributeParams, progress?: Progress): Promise<FrameGetAttributeResult>;
- goto(params: FrameGotoParams, progress?: Progress): Promise<FrameGotoResult>;
- hover(params: FrameHoverParams, progress?: Progress): Promise<FrameHoverResult>;
- innerHTML(params: FrameInnerHTMLParams, progress?: Progress): Promise<FrameInnerHTMLResult>;
- innerText(params: FrameInnerTextParams, progress?: Progress): Promise<FrameInnerTextResult>;
- inputValue(params: FrameInputValueParams, progress?: Progress): Promise<FrameInputValueResult>;
- isChecked(params: FrameIsCheckedParams, progress?: Progress): Promise<FrameIsCheckedResult>;
- isDisabled(params: FrameIsDisabledParams, progress?: Progress): Promise<FrameIsDisabledResult>;
- isEnabled(params: FrameIsEnabledParams, progress?: Progress): Promise<FrameIsEnabledResult>;
- isHidden(params: FrameIsHiddenParams, progress?: Progress): Promise<FrameIsHiddenResult>;
- isVisible(params: FrameIsVisibleParams, progress?: Progress): Promise<FrameIsVisibleResult>;
- isEditable(params: FrameIsEditableParams, progress?: Progress): Promise<FrameIsEditableResult>;
- press(params: FramePressParams, progress?: Progress): Promise<FramePressResult>;
- querySelector(params: FrameQuerySelectorParams, progress?: Progress): Promise<FrameQuerySelectorResult>;
- querySelectorAll(params: FrameQuerySelectorAllParams, progress?: Progress): Promise<FrameQuerySelectorAllResult>;
- queryCount(params: FrameQueryCountParams, progress?: Progress): Promise<FrameQueryCountResult>;
- selectOption(params: FrameSelectOptionParams, progress?: Progress): Promise<FrameSelectOptionResult>;
- setContent(params: FrameSetContentParams, progress?: Progress): Promise<FrameSetContentResult>;
- setInputFiles(params: FrameSetInputFilesParams, progress?: Progress): Promise<FrameSetInputFilesResult>;
- tap(params: FrameTapParams, progress?: Progress): Promise<FrameTapResult>;
- textContent(params: FrameTextContentParams, progress?: Progress): Promise<FrameTextContentResult>;
- title(params?: FrameTitleParams, progress?: Progress): Promise<FrameTitleResult>;
- type(params: FrameTypeParams, progress?: Progress): Promise<FrameTypeResult>;
- uncheck(params: FrameUncheckParams, progress?: Progress): Promise<FrameUncheckResult>;
- waitForTimeout(params: FrameWaitForTimeoutParams, progress?: Progress): Promise<FrameWaitForTimeoutResult>;
- waitForFunction(params: FrameWaitForFunctionParams, progress?: Progress): Promise<FrameWaitForFunctionResult>;
- waitForSelector(params: FrameWaitForSelectorParams, progress?: Progress): Promise<FrameWaitForSelectorResult>;
- expect(params: FrameExpectParams, progress?: Progress): Promise<FrameExpectResult>;
-}
-export type FrameLoadstateEvent = {
- add?: LifecycleEvent,
- remove?: LifecycleEvent,
+export type FrameExpectOptions = {
+ selector?: string,
+ expressionArg?: any,
+ pseudo?: 'before' | 'after',
+ expectedText?: ExpectedTextValue[],
+ expectedNumber?: number,
+ expectedValue?: SerializedArgument,
+ useInnerText?: boolean,
};
-export type FrameNavigatedEvent = {
- url: string,
- name: string,
- newDocument?: {
- request?: RequestChannel,
+export type FrameExpectResult = {
+ matches: boolean,
+ received?: {
+ value?: SerializedValue,
+ ariaSnapshot?: string,
},
- error?: string,
+ timedOut?: boolean,
+ errorMessage?: string,
+ log?: string[],
};
-export type FrameEvalOnSelectorParams = {
- selector: string,
- strict?: boolean,
+
+export interface FrameEvents {
+ 'loadstate': FrameLoadstateEvent;
+ 'navigated': FrameNavigatedEvent;
+}
+
+// ----------- JSHandle -----------
+export type JSHandleInitializer = {
+ preview: string,
+};
+export interface JSHandleEventTarget {
+ on(event: 'previewUpdated', callback: (params: JSHandlePreviewUpdatedEvent) => void): this;
+}
+export interface JSHandleChannel extends JSHandleEventTarget, Channel {
+ _type_JSHandle: boolean;
+ dispose(params?: JSHandleDisposeParams, progress?: Progress): Promise<JSHandleDisposeResult>;
+ evaluateExpression(params: JSHandleEvaluateExpressionParams, progress?: Progress): Promise<JSHandleEvaluateExpressionResult>;
+ evaluateExpressionHandle(params: JSHandleEvaluateExpressionHandleParams, progress?: Progress): Promise<JSHandleEvaluateExpressionHandleResult>;
+ getPropertyList(params?: JSHandleGetPropertyListParams, progress?: Progress): Promise<JSHandleGetPropertyListResult>;
+ getProperty(params: JSHandleGetPropertyParams, progress?: Progress): Promise<JSHandleGetPropertyResult>;
+ jsonValue(params?: JSHandleJsonValueParams, progress?: Progress): Promise<JSHandleJsonValueResult>;
+}
+export type JSHandlePreviewUpdatedEvent = {
+ preview: string,
+};
+export type JSHandleDisposeParams = {};
+export type JSHandleDisposeOptions = {};
+export type JSHandleDisposeResult = void;
+export type JSHandleEvaluateExpressionParams = {
expression: string,
isFunction?: boolean,
arg: SerializedArgument,
};
-export type FrameEvalOnSelectorOptions = {
- strict?: boolean,
+export type JSHandleEvaluateExpressionOptions = {
isFunction?: boolean,
};
-export type FrameEvalOnSelectorResult = {
+export type JSHandleEvaluateExpressionResult = {
value: SerializedValue,
};
-export type FrameEvalOnSelectorAllParams = {
- selector: string,
+export type JSHandleEvaluateExpressionHandleParams = {
expression: string,
isFunction?: boolean,
arg: SerializedArgument,
};
-export type FrameEvalOnSelectorAllOptions = {
+export type JSHandleEvaluateExpressionHandleOptions = {
isFunction?: boolean,
};
-export type FrameEvalOnSelectorAllResult = {
- value: SerializedValue,
-};
-export type FrameAddScriptTagParams = {
- url?: string,
- content?: string,
- type?: string,
-};
-export type FrameAddScriptTagOptions = {
- url?: string,
- content?: string,
- type?: string,
-};
-export type FrameAddScriptTagResult = {
- element: ElementHandleChannel,
-};
-export type FrameAddStyleTagParams = {
- url?: string,
- content?: string,
+export type JSHandleEvaluateExpressionHandleResult = {
+ handle: JSHandleChannel,
};
-export type FrameAddStyleTagOptions = {
- url?: string,
- content?: string,
+export type JSHandleGetPropertyListParams = {};
+export type JSHandleGetPropertyListOptions = {};
+export type JSHandleGetPropertyListResult = {
+ properties: {
+ name: string,
+ value: JSHandleChannel,
+ }[],
};
-export type FrameAddStyleTagResult = {
- element: ElementHandleChannel,
+export type JSHandleGetPropertyParams = {
+ name: string,
};
-export type FrameAriaSnapshotParams = {
- mode?: 'ai' | 'default',
- track?: string,
- selector?: string,
- depth?: number,
- boxes?: boolean,
- timeout: number,
+export type JSHandleGetPropertyOptions = {
+
};
-export type FrameAriaSnapshotOptions = {
- mode?: 'ai' | 'default',
- track?: string,
- selector?: string,
- depth?: number,
- boxes?: boolean,
+export type JSHandleGetPropertyResult = {
+ handle: JSHandleChannel,
};
-export type FrameAriaSnapshotResult = {
- snapshot: string,
+export type JSHandleJsonValueParams = {};
+export type JSHandleJsonValueOptions = {};
+export type JSHandleJsonValueResult = {
+ value: SerializedValue,
};
-export type FrameBlurParams = {
+
+export interface JSHandleEvents {
+ 'previewUpdated': JSHandlePreviewUpdatedEvent;
+}
+
+// ----------- ElementHandle -----------
+export type ElementHandleInitializer = {};
+export interface ElementHandleEventTarget {
+}
+export interface ElementHandleChannel extends ElementHandleEventTarget, JSHandleChannel {
+ _type_ElementHandle: boolean;
+ evalOnSelector(params: ElementHandleEvalOnSelectorParams, progress?: Progress): Promise<ElementHandleEvalOnSelectorResult>;
+ evalOnSelectorAll(params: ElementHandleEvalOnSelectorAllParams, progress?: Progress): Promise<ElementHandleEvalOnSelectorAllResult>;
+ boundingBox(params?: ElementHandleBoundingBoxParams, progress?: Progress): Promise<ElementHandleBoundingBoxResult>;
+ check(params: ElementHandleCheckParams, progress?: Progress): Promise<ElementHandleCheckResult>;
+ click(params: ElementHandleClickParams, progress?: Progress): Promise<ElementHandleClickResult>;
+ contentFrame(params?: ElementHandleContentFrameParams, progress?: Progress): Promise<ElementHandleContentFrameResult>;
+ dblclick(params: ElementHandleDblclickParams, progress?: Progress): Promise<ElementHandleDblclickResult>;
+ dispatchEvent(params: ElementHandleDispatchEventParams, progress?: Progress): Promise<ElementHandleDispatchEventResult>;
+ fill(params: ElementHandleFillParams, progress?: Progress): Promise<ElementHandleFillResult>;
+ focus(params?: ElementHandleFocusParams, progress?: Progress): Promise<ElementHandleFocusResult>;
+ getAttribute(params: ElementHandleGetAttributeParams, progress?: Progress): Promise<ElementHandleGetAttributeResult>;
+ hover(params: ElementHandleHoverParams, progress?: Progress): Promise<ElementHandleHoverResult>;
+ innerHTML(params?: ElementHandleInnerHTMLParams, progress?: Progress): Promise<ElementHandleInnerHTMLResult>;
+ innerText(params?: ElementHandleInnerTextParams, progress?: Progress): Promise<ElementHandleInnerTextResult>;
+ inputValue(params?: ElementHandleInputValueParams, progress?: Progress): Promise<ElementHandleInputValueResult>;
+ isChecked(params?: ElementHandleIsCheckedParams, progress?: Progress): Promise<ElementHandleIsCheckedResult>;
+ isDisabled(params?: ElementHandleIsDisabledParams, progress?: Progress): Promise<ElementHandleIsDisabledResult>;
+ isEditable(params?: ElementHandleIsEditableParams, progress?: Progress): Promise<ElementHandleIsEditableResult>;
+ isEnabled(params?: ElementHandleIsEnabledParams, progress?: Progress): Promise<ElementHandleIsEnabledResult>;
+ isHidden(params?: ElementHandleIsHiddenParams, progress?: Progress): Promise<ElementHandleIsHiddenResult>;
+ isVisible(params?: ElementHandleIsVisibleParams, progress?: Progress): Promise<ElementHandleIsVisibleResult>;
+ ownerFrame(params?: ElementHandleOwnerFrameParams, progress?: Progress): Promise<ElementHandleOwnerFrameResult>;
+ press(params: ElementHandlePressParams, progress?: Progress): Promise<ElementHandlePressResult>;
+ querySelector(params: ElementHandleQuerySelectorParams, progress?: Progress): Promise<ElementHandleQuerySelectorResult>;
+ querySelectorAll(params: ElementHandleQuerySelectorAllParams, progress?: Progress): Promise<ElementHandleQuerySelectorAllResult>;
+ screenshot(params: ElementHandleScreenshotParams, progress?: Progress): Promise<ElementHandleScreenshotResult>;
+ scrollIntoViewIfNeeded(params: ElementHandleScrollIntoViewIfNeededParams, progress?: Progress): Promise<ElementHandleScrollIntoViewIfNeededResult>;
+ selectOption(params: ElementHandleSelectOptionParams, progress?: Progress): Promise<ElementHandleSelectOptionResult>;
+ selectText(params: ElementHandleSelectTextParams, progress?: Progress): Promise<ElementHandleSelectTextResult>;
+ setInputFiles(params: ElementHandleSetInputFilesParams, progress?: Progress): Promise<ElementHandleSetInputFilesResult>;
+ tap(params: ElementHandleTapParams, progress?: Progress): Promise<ElementHandleTapResult>;
+ textContent(params?: ElementHandleTextContentParams, progress?: Progress): Promise<ElementHandleTextContentResult>;
+ type(params: ElementHandleTypeParams, progress?: Progress): Promise<ElementHandleTypeResult>;
+ uncheck(params: ElementHandleUncheckParams, progress?: Progress): Promise<ElementHandleUncheckResult>;
+ waitForElementState(params: ElementHandleWaitForElementStateParams, progress?: Progress): Promise<ElementHandleWaitForElementStateResult>;
+ waitForSelector(params: ElementHandleWaitForSelectorParams, progress?: Progress): Promise<ElementHandleWaitForSelectorResult>;
+}
+export type ElementHandleEvalOnSelectorParams = {
selector: string,
strict?: boolean,
- timeout: number,
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
};
-export type FrameBlurOptions = {
+export type ElementHandleEvalOnSelectorOptions = {
strict?: boolean,
+ isFunction?: boolean,
};
-export type FrameBlurResult = void;
-export type FrameCheckParams = {
+export type ElementHandleEvalOnSelectorResult = {
+ value: SerializedValue,
+};
+export type ElementHandleEvalOnSelectorAllParams = {
selector: string,
- strict?: boolean,
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+};
+export type ElementHandleEvalOnSelectorAllOptions = {
+ isFunction?: boolean,
+};
+export type ElementHandleEvalOnSelectorAllResult = {
+ value: SerializedValue,
+};
+export type ElementHandleBoundingBoxParams = {};
+export type ElementHandleBoundingBoxOptions = {};
+export type ElementHandleBoundingBoxResult = {
+ value?: Rect,
+};
+export type ElementHandleCheckParams = {
force?: boolean,
position?: Point,
timeout: number,
trial?: boolean,
};
-export type FrameCheckOptions = {
- strict?: boolean,
+export type ElementHandleCheckOptions = {
force?: boolean,
position?: Point,
trial?: boolean,
};
-export type FrameCheckResult = void;
-export type FrameClickParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleCheckResult = void;
+export type ElementHandleClickParams = {
force?: boolean,
noWaitAfter?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
@@ -2974,8 +2988,7 @@ export type FrameClickParams = {
trial?: boolean,
steps?: number,
};
-export type FrameClickOptions = {
- strict?: boolean,
+export type ElementHandleClickOptions = {
force?: boolean,
noWaitAfter?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
@@ -2986,68 +2999,13 @@ export type FrameClickOptions = {
trial?: boolean,
steps?: number,
};
-export type FrameClickResult = void;
-export type FrameContentParams = {};
-export type FrameContentOptions = {};
-export type FrameContentResult = {
- value: string,
-};
-export type FrameDragAndDropParams = {
- source: string,
- target: string,
- force?: boolean,
- timeout: number,
- trial?: boolean,
- sourcePosition?: Point,
- targetPosition?: Point,
- strict?: boolean,
- steps?: number,
-};
-export type FrameDragAndDropOptions = {
- force?: boolean,
- trial?: boolean,
- sourcePosition?: Point,
- targetPosition?: Point,
- strict?: boolean,
- steps?: number,
-};
-export type FrameDragAndDropResult = void;
-export type FrameDropParams = {
- selector: string,
- strict?: boolean,
- position?: Point,
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localPaths?: string[],
- streams?: WritableStreamChannel[],
- data?: {
- mimeType: string,
- value: string,
- }[],
- timeout: number,
-};
-export type FrameDropOptions = {
- strict?: boolean,
- position?: Point,
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localPaths?: string[],
- streams?: WritableStreamChannel[],
- data?: {
- mimeType: string,
- value: string,
- }[],
+export type ElementHandleClickResult = void;
+export type ElementHandleContentFrameParams = {};
+export type ElementHandleContentFrameOptions = {};
+export type ElementHandleContentFrameResult = {
+ frame?: FrameChannel,
};
-export type FrameDropResult = void;
-export type FrameDblclickParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleDblclickParams = {
force?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
position?: Point,
@@ -3057,8 +3015,7 @@ export type FrameDblclickParams = {
trial?: boolean,
steps?: number,
};
-export type FrameDblclickOptions = {
- strict?: boolean,
+export type ElementHandleDblclickOptions = {
force?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
position?: Point,
@@ -3067,885 +3024,1084 @@ export type FrameDblclickOptions = {
trial?: boolean,
steps?: number,
};
-export type FrameDblclickResult = void;
-export type FrameDispatchEventParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleDblclickResult = void;
+export type ElementHandleDispatchEventParams = {
type: string,
eventInit: SerializedArgument,
+};
+export type ElementHandleDispatchEventOptions = {
+
+};
+export type ElementHandleDispatchEventResult = void;
+export type ElementHandleFillParams = {
+ value: string,
+ force?: boolean,
timeout: number,
};
-export type FrameDispatchEventOptions = {
- strict?: boolean,
+export type ElementHandleFillOptions = {
+ force?: boolean,
};
-export type FrameDispatchEventResult = void;
-export type FrameEvaluateExpressionParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type ElementHandleFillResult = void;
+export type ElementHandleFocusParams = {};
+export type ElementHandleFocusOptions = {};
+export type ElementHandleFocusResult = void;
+export type ElementHandleGetAttributeParams = {
+ name: string,
};
-export type FrameEvaluateExpressionOptions = {
- isFunction?: boolean,
+export type ElementHandleGetAttributeOptions = {
+
};
-export type FrameEvaluateExpressionResult = {
- value: SerializedValue,
+export type ElementHandleGetAttributeResult = {
+ value?: string,
};
-export type FrameEvaluateExpressionHandleParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type ElementHandleHoverParams = {
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ timeout: number,
+ trial?: boolean,
};
-export type FrameEvaluateExpressionHandleOptions = {
- isFunction?: boolean,
+export type ElementHandleHoverOptions = {
+ force?: boolean,
+ modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
+ position?: Point,
+ trial?: boolean,
};
-export type FrameEvaluateExpressionHandleResult = {
- handle: JSHandleChannel,
+export type ElementHandleHoverResult = void;
+export type ElementHandleInnerHTMLParams = {};
+export type ElementHandleInnerHTMLOptions = {};
+export type ElementHandleInnerHTMLResult = {
+ value: string,
};
-export type FrameFillParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleInnerTextParams = {};
+export type ElementHandleInnerTextOptions = {};
+export type ElementHandleInnerTextResult = {
value: string,
- force?: boolean,
+};
+export type ElementHandleInputValueParams = {};
+export type ElementHandleInputValueOptions = {};
+export type ElementHandleInputValueResult = {
+ value: string,
+};
+export type ElementHandleIsCheckedParams = {};
+export type ElementHandleIsCheckedOptions = {};
+export type ElementHandleIsCheckedResult = {
+ value: boolean,
+};
+export type ElementHandleIsDisabledParams = {};
+export type ElementHandleIsDisabledOptions = {};
+export type ElementHandleIsDisabledResult = {
+ value: boolean,
+};
+export type ElementHandleIsEditableParams = {};
+export type ElementHandleIsEditableOptions = {};
+export type ElementHandleIsEditableResult = {
+ value: boolean,
+};
+export type ElementHandleIsEnabledParams = {};
+export type ElementHandleIsEnabledOptions = {};
+export type ElementHandleIsEnabledResult = {
+ value: boolean,
+};
+export type ElementHandleIsHiddenParams = {};
+export type ElementHandleIsHiddenOptions = {};
+export type ElementHandleIsHiddenResult = {
+ value: boolean,
+};
+export type ElementHandleIsVisibleParams = {};
+export type ElementHandleIsVisibleOptions = {};
+export type ElementHandleIsVisibleResult = {
+ value: boolean,
+};
+export type ElementHandleOwnerFrameParams = {};
+export type ElementHandleOwnerFrameOptions = {};
+export type ElementHandleOwnerFrameResult = {
+ frame?: FrameChannel,
+};
+export type ElementHandlePressParams = {
+ key: string,
+ delay?: number,
timeout: number,
+ noWaitAfter?: boolean,
};
-export type FrameFillOptions = {
- strict?: boolean,
- force?: boolean,
+export type ElementHandlePressOptions = {
+ delay?: number,
+ noWaitAfter?: boolean,
};
-export type FrameFillResult = void;
-export type FrameFocusParams = {
+export type ElementHandlePressResult = void;
+export type ElementHandleQuerySelectorParams = {
selector: string,
strict?: boolean,
- timeout: number,
};
-export type FrameFocusOptions = {
+export type ElementHandleQuerySelectorOptions = {
strict?: boolean,
};
-export type FrameFocusResult = void;
-export type FrameFrameElementParams = {};
-export type FrameFrameElementOptions = {};
-export type FrameFrameElementResult = {
- element: ElementHandleChannel,
+export type ElementHandleQuerySelectorResult = {
+ element?: ElementHandleChannel,
};
-export type FrameResolveSelectorParams = {
+export type ElementHandleQuerySelectorAllParams = {
selector: string,
};
-export type FrameResolveSelectorOptions = {
+export type ElementHandleQuerySelectorAllOptions = {
};
-export type FrameResolveSelectorResult = {
- resolvedSelector: string,
+export type ElementHandleQuerySelectorAllResult = {
+ elements: ElementHandleChannel[],
};
-export type FrameHighlightParams = {
- selector: string,
+export type ElementHandleScreenshotParams = {
+ timeout: number,
+ type?: 'png' | 'jpeg',
+ quality?: number,
+ omitBackground?: boolean,
+ caret?: 'hide' | 'initial',
+ animations?: 'disabled' | 'allow',
+ scale?: 'css' | 'device',
+ mask?: {
+ frame: FrameChannel,
+ selector: string,
+ }[],
+ maskColor?: string,
style?: string,
};
-export type FrameHighlightOptions = {
+export type ElementHandleScreenshotOptions = {
+ type?: 'png' | 'jpeg',
+ quality?: number,
+ omitBackground?: boolean,
+ caret?: 'hide' | 'initial',
+ animations?: 'disabled' | 'allow',
+ scale?: 'css' | 'device',
+ mask?: {
+ frame: FrameChannel,
+ selector: string,
+ }[],
+ maskColor?: string,
style?: string,
};
-export type FrameHighlightResult = void;
-export type FrameHideHighlightParams = {
- selector: string,
+export type ElementHandleScreenshotResult = {
+ binary: Binary,
};
-export type FrameHideHighlightOptions = {
+export type ElementHandleScrollIntoViewIfNeededParams = {
+ timeout: number,
+};
+export type ElementHandleScrollIntoViewIfNeededOptions = {
};
-export type FrameHideHighlightResult = void;
-export type FrameGetAttributeParams = {
- selector: string,
- strict?: boolean,
- name: string,
+export type ElementHandleScrollIntoViewIfNeededResult = void;
+export type ElementHandleSelectOptionParams = {
+ elements?: ElementHandleChannel[],
+ options?: {
+ valueOrLabel?: string,
+ value?: string,
+ label?: string,
+ index?: number,
+ }[],
+ force?: boolean,
timeout: number,
};
-export type FrameGetAttributeOptions = {
- strict?: boolean,
+export type ElementHandleSelectOptionOptions = {
+ elements?: ElementHandleChannel[],
+ options?: {
+ valueOrLabel?: string,
+ value?: string,
+ label?: string,
+ index?: number,
+ }[],
+ force?: boolean,
};
-export type FrameGetAttributeResult = {
- value?: string,
+export type ElementHandleSelectOptionResult = {
+ values: string[],
};
-export type FrameGotoParams = {
- url: string,
+export type ElementHandleSelectTextParams = {
+ force?: boolean,
+ timeout: number,
+};
+export type ElementHandleSelectTextOptions = {
+ force?: boolean,
+};
+export type ElementHandleSelectTextResult = void;
+export type ElementHandleSetInputFilesParams = {
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
+ }[],
+ localDirectory?: string,
+ directoryStream?: WritableStreamChannel,
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
timeout: number,
- waitUntil?: LifecycleEvent,
- referer?: string,
-};
-export type FrameGotoOptions = {
- waitUntil?: LifecycleEvent,
- referer?: string,
};
-export type FrameGotoResult = {
- response?: ResponseChannel,
+export type ElementHandleSetInputFilesOptions = {
+ payloads?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
+ }[],
+ localDirectory?: string,
+ directoryStream?: WritableStreamChannel,
+ localPaths?: string[],
+ streams?: WritableStreamChannel[],
};
-export type FrameHoverParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleSetInputFilesResult = void;
+export type ElementHandleTapParams = {
force?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
position?: Point,
timeout: number,
trial?: boolean,
};
-export type FrameHoverOptions = {
- strict?: boolean,
+export type ElementHandleTapOptions = {
force?: boolean,
modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
position?: Point,
trial?: boolean,
};
-export type FrameHoverResult = void;
-export type FrameInnerHTMLParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
-};
-export type FrameInnerHTMLOptions = {
- strict?: boolean,
-};
-export type FrameInnerHTMLResult = {
- value: string,
-};
-export type FrameInnerTextParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
-};
-export type FrameInnerTextOptions = {
- strict?: boolean,
-};
-export type FrameInnerTextResult = {
- value: string,
-};
-export type FrameInputValueParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
-};
-export type FrameInputValueOptions = {
- strict?: boolean,
-};
-export type FrameInputValueResult = {
- value: string,
+export type ElementHandleTapResult = void;
+export type ElementHandleTextContentParams = {};
+export type ElementHandleTextContentOptions = {};
+export type ElementHandleTextContentResult = {
+ value?: string,
};
-export type FrameIsCheckedParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleTypeParams = {
+ text: string,
+ delay?: number,
timeout: number,
};
-export type FrameIsCheckedOptions = {
- strict?: boolean,
-};
-export type FrameIsCheckedResult = {
- value: boolean,
+export type ElementHandleTypeOptions = {
+ delay?: number,
};
-export type FrameIsDisabledParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleTypeResult = void;
+export type ElementHandleUncheckParams = {
+ force?: boolean,
+ position?: Point,
timeout: number,
+ trial?: boolean,
};
-export type FrameIsDisabledOptions = {
- strict?: boolean,
-};
-export type FrameIsDisabledResult = {
- value: boolean,
+export type ElementHandleUncheckOptions = {
+ force?: boolean,
+ position?: Point,
+ trial?: boolean,
};
-export type FrameIsEnabledParams = {
- selector: string,
- strict?: boolean,
+export type ElementHandleUncheckResult = void;
+export type ElementHandleWaitForElementStateParams = {
+ state: 'visible' | 'hidden' | 'stable' | 'enabled' | 'disabled' | 'editable',
timeout: number,
};
-export type FrameIsEnabledOptions = {
- strict?: boolean,
-};
-export type FrameIsEnabledResult = {
- value: boolean,
-};
-export type FrameIsHiddenParams = {
- selector: string,
- strict?: boolean,
-};
-export type FrameIsHiddenOptions = {
- strict?: boolean,
-};
-export type FrameIsHiddenResult = {
- value: boolean,
-};
-export type FrameIsVisibleParams = {
- selector: string,
- strict?: boolean,
-};
-export type FrameIsVisibleOptions = {
- strict?: boolean,
-};
-export type FrameIsVisibleResult = {
- value: boolean,
+export type ElementHandleWaitForElementStateOptions = {
+
};
-export type FrameIsEditableParams = {
+export type ElementHandleWaitForElementStateResult = void;
+export type ElementHandleWaitForSelectorParams = {
selector: string,
strict?: boolean,
timeout: number,
+ state?: 'attached' | 'detached' | 'visible' | 'hidden',
};
-export type FrameIsEditableOptions = {
- strict?: boolean,
-};
-export type FrameIsEditableResult = {
- value: boolean,
-};
-export type FramePressParams = {
- selector: string,
+export type ElementHandleWaitForSelectorOptions = {
strict?: boolean,
- key: string,
- delay?: number,
- noWaitAfter?: boolean,
- timeout: number,
+ state?: 'attached' | 'detached' | 'visible' | 'hidden',
};
-export type FramePressOptions = {
- strict?: boolean,
- delay?: number,
- noWaitAfter?: boolean,
+export type ElementHandleWaitForSelectorResult = {
+ element?: ElementHandleChannel,
};
-export type FramePressResult = void;
-export type FrameQuerySelectorParams = {
- selector: string,
- strict?: boolean,
+
+export interface ElementHandleEvents {
+}
+
+// ----------- LocalUtils -----------
+export type LocalUtilsInitializer = {
+ deviceDescriptors: {
+ name: string,
+ descriptor: {
+ userAgent: string,
+ viewport: {
+ width: number,
+ height: number,
+ },
+ screen?: {
+ width: number,
+ height: number,
+ },
+ deviceScaleFactor: number,
+ isMobile: boolean,
+ hasTouch: boolean,
+ defaultBrowserType: 'chromium' | 'firefox' | 'webkit',
+ },
+ }[],
};
-export type FrameQuerySelectorOptions = {
- strict?: boolean,
+export interface LocalUtilsEventTarget {
+}
+export interface LocalUtilsChannel extends LocalUtilsEventTarget, Channel {
+ _type_LocalUtils: boolean;
+ zip(params: LocalUtilsZipParams, progress?: Progress): Promise<LocalUtilsZipResult>;
+ harOpen(params: LocalUtilsHarOpenParams, progress?: Progress): Promise<LocalUtilsHarOpenResult>;
+ harLookup(params: LocalUtilsHarLookupParams, progress?: Progress): Promise<LocalUtilsHarLookupResult>;
+ harClose(params: LocalUtilsHarCloseParams, progress?: Progress): Promise<LocalUtilsHarCloseResult>;
+ harUnzip(params: LocalUtilsHarUnzipParams, progress?: Progress): Promise<LocalUtilsHarUnzipResult>;
+ connect(params: LocalUtilsConnectParams, progress?: Progress): Promise<LocalUtilsConnectResult>;
+ tracingStarted(params: LocalUtilsTracingStartedParams, progress?: Progress): Promise<LocalUtilsTracingStartedResult>;
+ addStackToTracingNoReply(params: LocalUtilsAddStackToTracingNoReplyParams, progress?: Progress): Promise<LocalUtilsAddStackToTracingNoReplyResult>;
+ traceDiscarded(params: LocalUtilsTraceDiscardedParams, progress?: Progress): Promise<LocalUtilsTraceDiscardedResult>;
+ globToRegex(params: LocalUtilsGlobToRegexParams, progress?: Progress): Promise<LocalUtilsGlobToRegexResult>;
+}
+export type LocalUtilsZipParams = {
+ zipFile: string,
+ entries: NameValue[],
+ stacksId?: string,
+ mode: 'write' | 'append',
+ includeSources: boolean,
+ additionalSources?: string[],
};
-export type FrameQuerySelectorResult = {
- element?: ElementHandleChannel,
+export type LocalUtilsZipOptions = {
+ stacksId?: string,
+ additionalSources?: string[],
};
-export type FrameQuerySelectorAllParams = {
- selector: string,
+export type LocalUtilsZipResult = void;
+export type LocalUtilsHarOpenParams = {
+ file: string,
};
-export type FrameQuerySelectorAllOptions = {
+export type LocalUtilsHarOpenOptions = {
};
-export type FrameQuerySelectorAllResult = {
- elements: ElementHandleChannel[],
+export type LocalUtilsHarOpenResult = {
+ harId?: string,
+ error?: string,
};
-export type FrameQueryCountParams = {
- selector: string,
+export type LocalUtilsHarLookupParams = {
+ harId: string,
+ url: string,
+ method: string,
+ headers: NameValue[],
+ postData?: Binary,
+ isNavigationRequest: boolean,
};
-export type FrameQueryCountOptions = {
-
+export type LocalUtilsHarLookupOptions = {
+ postData?: Binary,
};
-export type FrameQueryCountResult = {
- value: number,
+export type LocalUtilsHarLookupResult = {
+ action: 'error' | 'redirect' | 'fulfill' | 'noentry',
+ message?: string,
+ redirectURL?: string,
+ status?: number,
+ headers?: NameValue[],
+ body?: Binary,
};
-export type FrameSelectOptionParams = {
- selector: string,
- strict?: boolean,
- elements?: ElementHandleChannel[],
- options?: {
- valueOrLabel?: string,
- value?: string,
- label?: string,
- index?: number,
- }[],
- force?: boolean,
- timeout: number,
+export type LocalUtilsHarCloseParams = {
+ harId: string,
};
-export type FrameSelectOptionOptions = {
- strict?: boolean,
- elements?: ElementHandleChannel[],
- options?: {
- valueOrLabel?: string,
- value?: string,
- label?: string,
- index?: number,
- }[],
- force?: boolean,
+export type LocalUtilsHarCloseOptions = {
+
};
-export type FrameSelectOptionResult = {
- values: string[],
+export type LocalUtilsHarCloseResult = void;
+export type LocalUtilsHarUnzipParams = {
+ zipFile: string,
+ harFile: string,
+ resourcesDir?: string,
};
-export type FrameSetContentParams = {
- html: string,
+export type LocalUtilsHarUnzipOptions = {
+ resourcesDir?: string,
+};
+export type LocalUtilsHarUnzipResult = void;
+export type LocalUtilsConnectParams = {
+ endpoint: string,
+ headers?: any,
+ exposeNetwork?: string,
+ slowMo?: number,
timeout: number,
- waitUntil?: LifecycleEvent,
+ socksProxyRedirectPortForTest?: number,
};
-export type FrameSetContentOptions = {
- waitUntil?: LifecycleEvent,
+export type LocalUtilsConnectOptions = {
+ headers?: any,
+ exposeNetwork?: string,
+ slowMo?: number,
+ socksProxyRedirectPortForTest?: number,
};
-export type FrameSetContentResult = void;
-export type FrameSetInputFilesParams = {
- selector: string,
- strict?: boolean,
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localDirectory?: string,
- directoryStream?: WritableStreamChannel,
- localPaths?: string[],
- streams?: WritableStreamChannel[],
- timeout: number,
+export type LocalUtilsConnectResult = {
+ pipe: JsonPipeChannel,
+ headers: NameValue[],
};
-export type FrameSetInputFilesOptions = {
- strict?: boolean,
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localDirectory?: string,
- directoryStream?: WritableStreamChannel,
- localPaths?: string[],
- streams?: WritableStreamChannel[],
+export type LocalUtilsTracingStartedParams = {
+ tracesDir?: string,
+ traceName: string,
+ live?: boolean,
};
-export type FrameSetInputFilesResult = void;
-export type FrameTapParams = {
- selector: string,
- strict?: boolean,
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- timeout: number,
- trial?: boolean,
+export type LocalUtilsTracingStartedOptions = {
+ tracesDir?: string,
+ live?: boolean,
};
-export type FrameTapOptions = {
- strict?: boolean,
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- trial?: boolean,
+export type LocalUtilsTracingStartedResult = {
+ stacksId: string,
};
-export type FrameTapResult = void;
-export type FrameTextContentParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
+export type LocalUtilsAddStackToTracingNoReplyParams = {
+ callData: ClientSideCallMetadata,
};
-export type FrameTextContentOptions = {
- strict?: boolean,
+export type LocalUtilsAddStackToTracingNoReplyOptions = {
+
};
-export type FrameTextContentResult = {
- value?: string,
+export type LocalUtilsAddStackToTracingNoReplyResult = void;
+export type LocalUtilsTraceDiscardedParams = {
+ stacksId: string,
};
-export type FrameTitleParams = {};
-export type FrameTitleOptions = {};
-export type FrameTitleResult = {
- value: string,
+export type LocalUtilsTraceDiscardedOptions = {
+
};
-export type FrameTypeParams = {
- selector: string,
- strict?: boolean,
- text: string,
- delay?: number,
- timeout: number,
+export type LocalUtilsTraceDiscardedResult = void;
+export type LocalUtilsGlobToRegexParams = {
+ glob: string,
+ baseURL?: string,
+ webSocketUrl?: boolean,
};
-export type FrameTypeOptions = {
- strict?: boolean,
- delay?: number,
+export type LocalUtilsGlobToRegexOptions = {
+ baseURL?: string,
+ webSocketUrl?: boolean,
};
-export type FrameTypeResult = void;
-export type FrameUncheckParams = {
- selector: string,
- strict?: boolean,
- force?: boolean,
- position?: Point,
- timeout: number,
- trial?: boolean,
+export type LocalUtilsGlobToRegexResult = {
+ regex: string,
};
-export type FrameUncheckOptions = {
- strict?: boolean,
- force?: boolean,
- position?: Point,
- trial?: boolean,
+
+export interface LocalUtilsEvents {
+}
+
+export type SetNetworkCookie = {
+ name: string,
+ value: string,
+ url?: string,
+ domain?: string,
+ path?: string,
+ expires?: number,
+ httpOnly?: boolean,
+ secure?: boolean,
+ sameSite?: 'Strict' | 'Lax' | 'None',
+ partitionKey?: string,
+ _crHasCrossSiteAncestor?: boolean,
};
-export type FrameUncheckResult = void;
-export type FrameWaitForTimeoutParams = {
- waitTimeout: number,
+
+export type NetworkCookie = {
+ name: string,
+ value: string,
+ domain: string,
+ path: string,
+ expires: number,
+ httpOnly: boolean,
+ secure: boolean,
+ sameSite: 'Strict' | 'Lax' | 'None',
+ partitionKey?: string,
+ _crHasCrossSiteAncestor?: boolean,
};
-export type FrameWaitForTimeoutOptions = {
+// ----------- Request -----------
+export type RequestInitializer = {
+ frame?: FrameChannel,
+ serviceWorker?: WorkerChannel,
+ url: string,
+ resourceType: string,
+ method: string,
+ postData?: Binary,
+ headers: NameValue[],
+ isNavigationRequest: boolean,
+ redirectedFrom?: RequestChannel,
};
-export type FrameWaitForTimeoutResult = void;
-export type FrameWaitForFunctionParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
- timeout: number,
- pollingInterval?: number,
+export interface RequestEventTarget {
+}
+export interface RequestChannel extends RequestEventTarget, Channel {
+ _type_Request: boolean;
+ response(params?: RequestResponseParams, progress?: Progress): Promise<RequestResponseResult>;
+ rawRequestHeaders(params?: RequestRawRequestHeadersParams, progress?: Progress): Promise<RequestRawRequestHeadersResult>;
+}
+export type RequestResponseParams = {};
+export type RequestResponseOptions = {};
+export type RequestResponseResult = {
+ response?: ResponseChannel,
};
-export type FrameWaitForFunctionOptions = {
- isFunction?: boolean,
- pollingInterval?: number,
+export type RequestRawRequestHeadersParams = {};
+export type RequestRawRequestHeadersOptions = {};
+export type RequestRawRequestHeadersResult = {
+ headers: NameValue[],
};
-export type FrameWaitForFunctionResult = {
- handle: JSHandleChannel,
+
+export interface RequestEvents {
+}
+
+// ----------- Route -----------
+export type RouteInitializer = {
+ request: RequestChannel,
};
-export type FrameWaitForSelectorParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
- state?: 'attached' | 'detached' | 'visible' | 'hidden',
- omitReturnValue?: boolean,
+export interface RouteEventTarget {
+}
+export interface RouteChannel extends RouteEventTarget, Channel {
+ _type_Route: boolean;
+ redirectNavigationRequest(params: RouteRedirectNavigationRequestParams, progress?: Progress): Promise<RouteRedirectNavigationRequestResult>;
+ abort(params: RouteAbortParams, progress?: Progress): Promise<RouteAbortResult>;
+ continue(params: RouteContinueParams, progress?: Progress): Promise<RouteContinueResult>;
+ fulfill(params: RouteFulfillParams, progress?: Progress): Promise<RouteFulfillResult>;
+}
+export type RouteRedirectNavigationRequestParams = {
+ url: string,
};
-export type FrameWaitForSelectorOptions = {
- strict?: boolean,
- state?: 'attached' | 'detached' | 'visible' | 'hidden',
- omitReturnValue?: boolean,
+export type RouteRedirectNavigationRequestOptions = {
+
};
-export type FrameWaitForSelectorResult = {
- element?: ElementHandleChannel,
+export type RouteRedirectNavigationRequestResult = void;
+export type RouteAbortParams = {
+ errorCode?: string,
+};
+export type RouteAbortOptions = {
+ errorCode?: string,
+};
+export type RouteAbortResult = void;
+export type RouteContinueParams = {
+ url?: string,
+ method?: string,
+ headers?: NameValue[],
+ postData?: Binary,
+ isFallback: boolean,
};
-export type FrameExpectParams = {
- selector?: string,
- expression: string,
- expressionArg?: any,
- pseudo?: 'before' | 'after',
- expectedText?: ExpectedTextValue[],
- expectedNumber?: number,
- expectedValue?: SerializedArgument,
- useInnerText?: boolean,
- isNot: boolean,
- timeout: number,
+export type RouteContinueOptions = {
+ url?: string,
+ method?: string,
+ headers?: NameValue[],
+ postData?: Binary,
};
-export type FrameExpectOptions = {
- selector?: string,
- expressionArg?: any,
- pseudo?: 'before' | 'after',
- expectedText?: ExpectedTextValue[],
- expectedNumber?: number,
- expectedValue?: SerializedArgument,
- useInnerText?: boolean,
+export type RouteContinueResult = void;
+export type RouteFulfillParams = {
+ status?: number,
+ headers?: NameValue[],
+ body?: string,
+ isBase64?: boolean,
+ fetchResponseUid?: string,
};
-export type FrameExpectResult = {
- matches: boolean,
- received?: {
- value?: SerializedValue,
- ariaSnapshot?: string,
- },
- timedOut?: boolean,
- errorMessage?: string,
- log?: string[],
+export type RouteFulfillOptions = {
+ status?: number,
+ headers?: NameValue[],
+ body?: string,
+ isBase64?: boolean,
+ fetchResponseUid?: string,
};
+export type RouteFulfillResult = void;
-export interface FrameEvents {
- 'loadstate': FrameLoadstateEvent;
- 'navigated': FrameNavigatedEvent;
+export interface RouteEvents {
}
-// ----------- Worker -----------
-export type WorkerInitializer = {
+// ----------- WebSocketRoute -----------
+export type WebSocketRouteInitializer = {
url: string,
+ protocols: string[],
};
-export interface WorkerEventTarget {
- on(event: 'console', callback: (params: WorkerConsoleEvent) => void): this;
- on(event: 'close', callback: (params: WorkerCloseEvent) => void): this;
+export interface WebSocketRouteEventTarget {
+ on(event: 'messageFromPage', callback: (params: WebSocketRouteMessageFromPageEvent) => void): this;
+ on(event: 'messageFromServer', callback: (params: WebSocketRouteMessageFromServerEvent) => void): this;
+ on(event: 'closePage', callback: (params: WebSocketRouteClosePageEvent) => void): this;
+ on(event: 'closeServer', callback: (params: WebSocketRouteCloseServerEvent) => void): this;
}
-export interface WorkerChannel extends WorkerEventTarget, EventTargetChannel {
- _type_Worker: boolean;
- disconnect(params: WorkerDisconnectParams, progress?: Progress): Promise<WorkerDisconnectResult>;
- evaluateExpression(params: WorkerEvaluateExpressionParams, progress?: Progress): Promise<WorkerEvaluateExpressionResult>;
- evaluateExpressionHandle(params: WorkerEvaluateExpressionHandleParams, progress?: Progress): Promise<WorkerEvaluateExpressionHandleResult>;
- updateSubscription(params: WorkerUpdateSubscriptionParams, progress?: Progress): Promise<WorkerUpdateSubscriptionResult>;
+export interface WebSocketRouteChannel extends WebSocketRouteEventTarget, Channel {
+ _type_WebSocketRoute: boolean;
+ connect(params?: WebSocketRouteConnectParams, progress?: Progress): Promise<WebSocketRouteConnectResult>;
+ ensureOpened(params?: WebSocketRouteEnsureOpenedParams, progress?: Progress): Promise<WebSocketRouteEnsureOpenedResult>;
+ sendToPage(params: WebSocketRouteSendToPageParams, progress?: Progress): Promise<WebSocketRouteSendToPageResult>;
+ sendToServer(params: WebSocketRouteSendToServerParams, progress?: Progress): Promise<WebSocketRouteSendToServerResult>;
+ closePage(params: WebSocketRouteClosePageParams, progress?: Progress): Promise<WebSocketRouteClosePageResult>;
+ closeServer(params: WebSocketRouteCloseServerParams, progress?: Progress): Promise<WebSocketRouteCloseServerResult>;
}
-export type WorkerConsoleEvent = {
- type: string,
- text: string,
- args: JSHandleChannel[],
- location: {
- url: string,
- lineNumber: number,
- columnNumber: number,
- },
- timestamp: number,
+export type WebSocketRouteMessageFromPageEvent = {
+ message: string,
+ isBase64: boolean,
};
-export type WorkerCloseEvent = {};
-export type WorkerDisconnectParams = {
+export type WebSocketRouteMessageFromServerEvent = {
+ message: string,
+ isBase64: boolean,
+};
+export type WebSocketRouteClosePageEvent = {
+ code?: number,
reason?: string,
+ wasClean: boolean,
};
-export type WorkerDisconnectOptions = {
+export type WebSocketRouteCloseServerEvent = {
+ code?: number,
reason?: string,
+ wasClean: boolean,
};
-export type WorkerDisconnectResult = void;
-export type WorkerEvaluateExpressionParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type WebSocketRouteConnectParams = {};
+export type WebSocketRouteConnectOptions = {};
+export type WebSocketRouteConnectResult = void;
+export type WebSocketRouteEnsureOpenedParams = {};
+export type WebSocketRouteEnsureOpenedOptions = {};
+export type WebSocketRouteEnsureOpenedResult = void;
+export type WebSocketRouteSendToPageParams = {
+ message: string,
+ isBase64: boolean,
};
-export type WorkerEvaluateExpressionOptions = {
- isFunction?: boolean,
+export type WebSocketRouteSendToPageOptions = {
+
};
-export type WorkerEvaluateExpressionResult = {
- value: SerializedValue,
+export type WebSocketRouteSendToPageResult = void;
+export type WebSocketRouteSendToServerParams = {
+ message: string,
+ isBase64: boolean,
};
-export type WorkerEvaluateExpressionHandleParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type WebSocketRouteSendToServerOptions = {
+
};
-export type WorkerEvaluateExpressionHandleOptions = {
- isFunction?: boolean,
+export type WebSocketRouteSendToServerResult = void;
+export type WebSocketRouteClosePageParams = {
+ code?: number,
+ reason?: string,
+ wasClean: boolean,
};
-export type WorkerEvaluateExpressionHandleResult = {
- handle: JSHandleChannel,
+export type WebSocketRouteClosePageOptions = {
+ code?: number,
+ reason?: string,
};
-export type WorkerUpdateSubscriptionParams = {
- event: 'console',
- enabled: boolean,
+export type WebSocketRouteClosePageResult = void;
+export type WebSocketRouteCloseServerParams = {
+ code?: number,
+ reason?: string,
+ wasClean: boolean,
};
-export type WorkerUpdateSubscriptionOptions = {
-
+export type WebSocketRouteCloseServerOptions = {
+ code?: number,
+ reason?: string,
};
-export type WorkerUpdateSubscriptionResult = void;
-
-export interface WorkerEvents {
- 'console': WorkerConsoleEvent;
- 'close': WorkerCloseEvent;
-}
+export type WebSocketRouteCloseServerResult = void;
-// ----------- Disposable -----------
-export type DisposableInitializer = {};
-export interface DisposableEventTarget {
-}
-export interface DisposableChannel extends DisposableEventTarget, Channel {
- _type_Disposable: boolean;
- dispose(params?: DisposableDisposeParams, progress?: Progress): Promise<DisposableDisposeResult>;
+export interface WebSocketRouteEvents {
+ 'messageFromPage': WebSocketRouteMessageFromPageEvent;
+ 'messageFromServer': WebSocketRouteMessageFromServerEvent;
+ 'closePage': WebSocketRouteClosePageEvent;
+ 'closeServer': WebSocketRouteCloseServerEvent;
}
-export type DisposableDisposeParams = {};
-export type DisposableDisposeOptions = {};
-export type DisposableDisposeResult = void;
-export interface DisposableEvents {
-}
+export type ResourceTiming = {
+ startTime: number,
+ domainLookupStart: number,
+ domainLookupEnd: number,
+ connectStart: number,
+ secureConnectionStart: number,
+ connectEnd: number,
+ requestStart: number,
+ responseStart: number,
+};
-// ----------- JSHandle -----------
-export type JSHandleInitializer = {
- preview: string,
+// ----------- Response -----------
+export type ResponseInitializer = {
+ request: RequestChannel,
+ url: string,
+ status: number,
+ statusText: string,
+ headers: NameValue[],
+ timing: ResourceTiming,
+ fromServiceWorker: boolean,
};
-export interface JSHandleEventTarget {
- on(event: 'previewUpdated', callback: (params: JSHandlePreviewUpdatedEvent) => void): this;
+export interface ResponseEventTarget {
}
-export interface JSHandleChannel extends JSHandleEventTarget, Channel {
- _type_JSHandle: boolean;
- dispose(params?: JSHandleDisposeParams, progress?: Progress): Promise<JSHandleDisposeResult>;
- evaluateExpression(params: JSHandleEvaluateExpressionParams, progress?: Progress): Promise<JSHandleEvaluateExpressionResult>;
- evaluateExpressionHandle(params: JSHandleEvaluateExpressionHandleParams, progress?: Progress): Promise<JSHandleEvaluateExpressionHandleResult>;
- getPropertyList(params?: JSHandleGetPropertyListParams, progress?: Progress): Promise<JSHandleGetPropertyListResult>;
- getProperty(params: JSHandleGetPropertyParams, progress?: Progress): Promise<JSHandleGetPropertyResult>;
- jsonValue(params?: JSHandleJsonValueParams, progress?: Progress): Promise<JSHandleJsonValueResult>;
+export interface ResponseChannel extends ResponseEventTarget, Channel {
+ _type_Response: boolean;
+ body(params?: ResponseBodyParams, progress?: Progress): Promise<ResponseBodyResult>;
+ securityDetails(params?: ResponseSecurityDetailsParams, progress?: Progress): Promise<ResponseSecurityDetailsResult>;
+ serverAddr(params?: ResponseServerAddrParams, progress?: Progress): Promise<ResponseServerAddrResult>;
+ rawResponseHeaders(params?: ResponseRawResponseHeadersParams, progress?: Progress): Promise<ResponseRawResponseHeadersResult>;
+ httpVersion(params?: ResponseHttpVersionParams, progress?: Progress): Promise<ResponseHttpVersionResult>;
+ sizes(params?: ResponseSizesParams, progress?: Progress): Promise<ResponseSizesResult>;
}
-export type JSHandlePreviewUpdatedEvent = {
- preview: string,
+export type ResponseBodyParams = {};
+export type ResponseBodyOptions = {};
+export type ResponseBodyResult = {
+ binary: Binary,
};
-export type JSHandleDisposeParams = {};
-export type JSHandleDisposeOptions = {};
-export type JSHandleDisposeResult = void;
-export type JSHandleEvaluateExpressionParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type ResponseSecurityDetailsParams = {};
+export type ResponseSecurityDetailsOptions = {};
+export type ResponseSecurityDetailsResult = {
+ value?: SecurityDetails,
};
-export type JSHandleEvaluateExpressionOptions = {
- isFunction?: boolean,
+export type ResponseServerAddrParams = {};
+export type ResponseServerAddrOptions = {};
+export type ResponseServerAddrResult = {
+ value?: RemoteAddr,
};
-export type JSHandleEvaluateExpressionResult = {
- value: SerializedValue,
+export type ResponseRawResponseHeadersParams = {};
+export type ResponseRawResponseHeadersOptions = {};
+export type ResponseRawResponseHeadersResult = {
+ headers: NameValue[],
};
-export type JSHandleEvaluateExpressionHandleParams = {
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type ResponseHttpVersionParams = {};
+export type ResponseHttpVersionOptions = {};
+export type ResponseHttpVersionResult = {
+ value: string,
};
-export type JSHandleEvaluateExpressionHandleOptions = {
- isFunction?: boolean,
+export type ResponseSizesParams = {};
+export type ResponseSizesOptions = {};
+export type ResponseSizesResult = {
+ sizes: RequestSizes,
};
-export type JSHandleEvaluateExpressionHandleResult = {
- handle: JSHandleChannel,
+
+export interface ResponseEvents {
+}
+
+export type SecurityDetails = {
+ issuer?: string,
+ protocol?: string,
+ subjectName?: string,
+ validFrom?: number,
+ validTo?: number,
};
-export type JSHandleGetPropertyListParams = {};
-export type JSHandleGetPropertyListOptions = {};
-export type JSHandleGetPropertyListResult = {
- properties: {
- name: string,
- value: JSHandleChannel,
- }[],
+
+export type RequestSizes = {
+ requestBodySize: number,
+ requestHeadersSize: number,
+ responseBodySize: number,
+ responseHeadersSize: number,
};
-export type JSHandleGetPropertyParams = {
- name: string,
+
+export type RemoteAddr = {
+ ipAddress: string,
+ port: number,
};
-export type JSHandleGetPropertyOptions = {
+// ----------- WebSocket -----------
+export type WebSocketInitializer = {
+ url: string,
};
-export type JSHandleGetPropertyResult = {
- handle: JSHandleChannel,
+export interface WebSocketEventTarget {
+ on(event: 'open', callback: (params: WebSocketOpenEvent) => void): this;
+ on(event: 'frameSent', callback: (params: WebSocketFrameSentEvent) => void): this;
+ on(event: 'frameReceived', callback: (params: WebSocketFrameReceivedEvent) => void): this;
+ on(event: 'socketError', callback: (params: WebSocketSocketErrorEvent) => void): this;
+ on(event: 'close', callback: (params: WebSocketCloseEvent) => void): this;
+}
+export interface WebSocketChannel extends WebSocketEventTarget, EventTargetChannel {
+ _type_WebSocket: boolean;
+}
+export type WebSocketOpenEvent = {};
+export type WebSocketFrameSentEvent = {
+ opcode: number,
+ data: string,
};
-export type JSHandleJsonValueParams = {};
-export type JSHandleJsonValueOptions = {};
-export type JSHandleJsonValueResult = {
- value: SerializedValue,
+export type WebSocketFrameReceivedEvent = {
+ opcode: number,
+ data: string,
+};
+export type WebSocketSocketErrorEvent = {
+ error: string,
};
+export type WebSocketCloseEvent = {};
-export interface JSHandleEvents {
- 'previewUpdated': JSHandlePreviewUpdatedEvent;
+export interface WebSocketEvents {
+ 'open': WebSocketOpenEvent;
+ 'frameSent': WebSocketFrameSentEvent;
+ 'frameReceived': WebSocketFrameReceivedEvent;
+ 'socketError': WebSocketSocketErrorEvent;
+ 'close': WebSocketCloseEvent;
}
-// ----------- ElementHandle -----------
-export type ElementHandleInitializer = {};
-export interface ElementHandleEventTarget {
+// ----------- Page -----------
+export type PageInitializer = {
+ mainFrame: FrameChannel,
+ viewportSize?: {
+ width: number,
+ height: number,
+ },
+ isClosed: boolean,
+ opener?: PageChannel,
+ video?: ArtifactChannel,
+};
+export interface PageEventTarget {
+ on(event: 'bindingCall', callback: (params: PageBindingCallEvent) => void): this;
+ on(event: 'close', callback: (params: PageCloseEvent) => void): this;
+ on(event: 'crash', callback: (params: PageCrashEvent) => void): this;
+ on(event: 'download', callback: (params: PageDownloadEvent) => void): this;
+ on(event: 'viewportSizeChanged', callback: (params: PageViewportSizeChangedEvent) => void): this;
+ on(event: 'fileChooser', callback: (params: PageFileChooserEvent) => void): this;
+ on(event: 'frameAttached', callback: (params: PageFrameAttachedEvent) => void): this;
+ on(event: 'frameDetached', callback: (params: PageFrameDetachedEvent) => void): this;
+ on(event: 'locatorHandlerTriggered', callback: (params: PageLocatorHandlerTriggeredEvent) => void): this;
+ on(event: 'route', callback: (params: PageRouteEvent) => void): this;
+ on(event: 'screencastFrame', callback: (params: PageScreencastFrameEvent) => void): this;
+ on(event: 'webSocketRoute', callback: (params: PageWebSocketRouteEvent) => void): this;
+ on(event: 'webSocket', callback: (params: PageWebSocketEvent) => void): this;
+ on(event: 'worker', callback: (params: PageWorkerEvent) => void): this;
}
-export interface ElementHandleChannel extends ElementHandleEventTarget, JSHandleChannel {
- _type_ElementHandle: boolean;
- evalOnSelector(params: ElementHandleEvalOnSelectorParams, progress?: Progress): Promise<ElementHandleEvalOnSelectorResult>;
- evalOnSelectorAll(params: ElementHandleEvalOnSelectorAllParams, progress?: Progress): Promise<ElementHandleEvalOnSelectorAllResult>;
- boundingBox(params?: ElementHandleBoundingBoxParams, progress?: Progress): Promise<ElementHandleBoundingBoxResult>;
- check(params: ElementHandleCheckParams, progress?: Progress): Promise<ElementHandleCheckResult>;
- click(params: ElementHandleClickParams, progress?: Progress): Promise<ElementHandleClickResult>;
- contentFrame(params?: ElementHandleContentFrameParams, progress?: Progress): Promise<ElementHandleContentFrameResult>;
- dblclick(params: ElementHandleDblclickParams, progress?: Progress): Promise<ElementHandleDblclickResult>;
- dispatchEvent(params: ElementHandleDispatchEventParams, progress?: Progress): Promise<ElementHandleDispatchEventResult>;
- fill(params: ElementHandleFillParams, progress?: Progress): Promise<ElementHandleFillResult>;
- focus(params?: ElementHandleFocusParams, progress?: Progress): Promise<ElementHandleFocusResult>;
- getAttribute(params: ElementHandleGetAttributeParams, progress?: Progress): Promise<ElementHandleGetAttributeResult>;
- hover(params: ElementHandleHoverParams, progress?: Progress): Promise<ElementHandleHoverResult>;
- innerHTML(params?: ElementHandleInnerHTMLParams, progress?: Progress): Promise<ElementHandleInnerHTMLResult>;
- innerText(params?: ElementHandleInnerTextParams, progress?: Progress): Promise<ElementHandleInnerTextResult>;
- inputValue(params?: ElementHandleInputValueParams, progress?: Progress): Promise<ElementHandleInputValueResult>;
- isChecked(params?: ElementHandleIsCheckedParams, progress?: Progress): Promise<ElementHandleIsCheckedResult>;
- isDisabled(params?: ElementHandleIsDisabledParams, progress?: Progress): Promise<ElementHandleIsDisabledResult>;
- isEditable(params?: ElementHandleIsEditableParams, progress?: Progress): Promise<ElementHandleIsEditableResult>;
- isEnabled(params?: ElementHandleIsEnabledParams, progress?: Progress): Promise<ElementHandleIsEnabledResult>;
- isHidden(params?: ElementHandleIsHiddenParams, progress?: Progress): Promise<ElementHandleIsHiddenResult>;
- isVisible(params?: ElementHandleIsVisibleParams, progress?: Progress): Promise<ElementHandleIsVisibleResult>;
- ownerFrame(params?: ElementHandleOwnerFrameParams, progress?: Progress): Promise<ElementHandleOwnerFrameResult>;
- press(params: ElementHandlePressParams, progress?: Progress): Promise<ElementHandlePressResult>;
- querySelector(params: ElementHandleQuerySelectorParams, progress?: Progress): Promise<ElementHandleQuerySelectorResult>;
- querySelectorAll(params: ElementHandleQuerySelectorAllParams, progress?: Progress): Promise<ElementHandleQuerySelectorAllResult>;
- screenshot(params: ElementHandleScreenshotParams, progress?: Progress): Promise<ElementHandleScreenshotResult>;
- scrollIntoViewIfNeeded(params: ElementHandleScrollIntoViewIfNeededParams, progress?: Progress): Promise<ElementHandleScrollIntoViewIfNeededResult>;
- selectOption(params: ElementHandleSelectOptionParams, progress?: Progress): Promise<ElementHandleSelectOptionResult>;
- selectText(params: ElementHandleSelectTextParams, progress?: Progress): Promise<ElementHandleSelectTextResult>;
- setInputFiles(params: ElementHandleSetInputFilesParams, progress?: Progress): Promise<ElementHandleSetInputFilesResult>;
- tap(params: ElementHandleTapParams, progress?: Progress): Promise<ElementHandleTapResult>;
- textContent(params?: ElementHandleTextContentParams, progress?: Progress): Promise<ElementHandleTextContentResult>;
- type(params: ElementHandleTypeParams, progress?: Progress): Promise<ElementHandleTypeResult>;
- uncheck(params: ElementHandleUncheckParams, progress?: Progress): Promise<ElementHandleUncheckResult>;
- waitForElementState(params: ElementHandleWaitForElementStateParams, progress?: Progress): Promise<ElementHandleWaitForElementStateResult>;
- waitForSelector(params: ElementHandleWaitForSelectorParams, progress?: Progress): Promise<ElementHandleWaitForSelectorResult>;
+export interface PageChannel extends PageEventTarget, EventTargetChannel {
+ _type_Page: boolean;
+ addInitScript(params: PageAddInitScriptParams, progress?: Progress): Promise<PageAddInitScriptResult>;
+ close(params: PageCloseParams, progress?: Progress): Promise<PageCloseResult>;
+ clearConsoleMessages(params?: PageClearConsoleMessagesParams, progress?: Progress): Promise<PageClearConsoleMessagesResult>;
+ consoleMessages(params: PageConsoleMessagesParams, progress?: Progress): Promise<PageConsoleMessagesResult>;
+ emulateMedia(params: PageEmulateMediaParams, progress?: Progress): Promise<PageEmulateMediaResult>;
+ exposeBinding(params: PageExposeBindingParams, progress?: Progress): Promise<PageExposeBindingResult>;
+ goBack(params: PageGoBackParams, progress?: Progress): Promise<PageGoBackResult>;
+ goForward(params: PageGoForwardParams, progress?: Progress): Promise<PageGoForwardResult>;
+ requestGC(params?: PageRequestGCParams, progress?: Progress): Promise<PageRequestGCResult>;
+ registerLocatorHandler(params: PageRegisterLocatorHandlerParams, progress?: Progress): Promise<PageRegisterLocatorHandlerResult>;
+ resolveLocatorHandlerNoReply(params: PageResolveLocatorHandlerNoReplyParams, progress?: Progress): Promise<PageResolveLocatorHandlerNoReplyResult>;
+ unregisterLocatorHandler(params: PageUnregisterLocatorHandlerParams, progress?: Progress): Promise<PageUnregisterLocatorHandlerResult>;
+ reload(params: PageReloadParams, progress?: Progress): Promise<PageReloadResult>;
+ expectScreenshot(params: PageExpectScreenshotParams, progress?: Progress): Promise<PageExpectScreenshotResult>;
+ screenshot(params: PageScreenshotParams, progress?: Progress): Promise<PageScreenshotResult>;
+ setExtraHTTPHeaders(params: PageSetExtraHTTPHeadersParams, progress?: Progress): Promise<PageSetExtraHTTPHeadersResult>;
+ setNetworkInterceptionPatterns(params: PageSetNetworkInterceptionPatternsParams, progress?: Progress): Promise<PageSetNetworkInterceptionPatternsResult>;
+ setWebSocketInterceptionPatterns(params: PageSetWebSocketInterceptionPatternsParams, progress?: Progress): Promise<PageSetWebSocketInterceptionPatternsResult>;
+ setViewportSize(params: PageSetViewportSizeParams, progress?: Progress): Promise<PageSetViewportSizeResult>;
+ keyboardDown(params: PageKeyboardDownParams, progress?: Progress): Promise<PageKeyboardDownResult>;
+ keyboardUp(params: PageKeyboardUpParams, progress?: Progress): Promise<PageKeyboardUpResult>;
+ keyboardInsertText(params: PageKeyboardInsertTextParams, progress?: Progress): Promise<PageKeyboardInsertTextResult>;
+ keyboardType(params: PageKeyboardTypeParams, progress?: Progress): Promise<PageKeyboardTypeResult>;
+ keyboardPress(params: PageKeyboardPressParams, progress?: Progress): Promise<PageKeyboardPressResult>;
+ mouseMove(params: PageMouseMoveParams, progress?: Progress): Promise<PageMouseMoveResult>;
+ mouseDown(params: PageMouseDownParams, progress?: Progress): Promise<PageMouseDownResult>;
+ mouseUp(params: PageMouseUpParams, progress?: Progress): Promise<PageMouseUpResult>;
+ mouseClick(params: PageMouseClickParams, progress?: Progress): Promise<PageMouseClickResult>;
+ mouseWheel(params: PageMouseWheelParams, progress?: Progress): Promise<PageMouseWheelResult>;
+ touchscreenTap(params: PageTouchscreenTapParams, progress?: Progress): Promise<PageTouchscreenTapResult>;
+ clearPageErrors(params?: PageClearPageErrorsParams, progress?: Progress): Promise<PageClearPageErrorsResult>;
+ pageErrors(params: PagePageErrorsParams, progress?: Progress): Promise<PagePageErrorsResult>;
+ pdf(params: PagePdfParams, progress?: Progress): Promise<PagePdfResult>;
+ requests(params?: PageRequestsParams, progress?: Progress): Promise<PageRequestsResult>;
+ startJSCoverage(params: PageStartJSCoverageParams, progress?: Progress): Promise<PageStartJSCoverageResult>;
+ stopJSCoverage(params?: PageStopJSCoverageParams, progress?: Progress): Promise<PageStopJSCoverageResult>;
+ startCSSCoverage(params: PageStartCSSCoverageParams, progress?: Progress): Promise<PageStartCSSCoverageResult>;
+ stopCSSCoverage(params?: PageStopCSSCoverageParams, progress?: Progress): Promise<PageStopCSSCoverageResult>;
+ bringToFront(params?: PageBringToFrontParams, progress?: Progress): Promise<PageBringToFrontResult>;
+ pickLocator(params?: PagePickLocatorParams, progress?: Progress): Promise<PagePickLocatorResult>;
+ cancelPickLocator(params?: PageCancelPickLocatorParams, progress?: Progress): Promise<PageCancelPickLocatorResult>;
+ hideHighlight(params?: PageHideHighlightParams, progress?: Progress): Promise<PageHideHighlightResult>;
+ screencastShowOverlay(params: PageScreencastShowOverlayParams, progress?: Progress): Promise<PageScreencastShowOverlayResult>;
+ screencastRemoveOverlay(params: PageScreencastRemoveOverlayParams, progress?: Progress): Promise<PageScreencastRemoveOverlayResult>;
+ screencastChapter(params: PageScreencastChapterParams, progress?: Progress): Promise<PageScreencastChapterResult>;
+ screencastSetOverlayVisible(params: PageScreencastSetOverlayVisibleParams, progress?: Progress): Promise<PageScreencastSetOverlayVisibleResult>;
+ screencastShowActions(params: PageScreencastShowActionsParams, progress?: Progress): Promise<PageScreencastShowActionsResult>;
+ screencastHideActions(params?: PageScreencastHideActionsParams, progress?: Progress): Promise<PageScreencastHideActionsResult>;
+ screencastStart(params: PageScreencastStartParams, progress?: Progress): Promise<PageScreencastStartResult>;
+ screencastStop(params?: PageScreencastStopParams, progress?: Progress): Promise<PageScreencastStopResult>;
+ updateSubscription(params: PageUpdateSubscriptionParams, progress?: Progress): Promise<PageUpdateSubscriptionResult>;
+ setDockTile(params: PageSetDockTileParams, progress?: Progress): Promise<PageSetDockTileResult>;
}
-export type ElementHandleEvalOnSelectorParams = {
- selector: string,
- strict?: boolean,
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type PageBindingCallEvent = {
+ binding: BindingCallChannel,
};
-export type ElementHandleEvalOnSelectorOptions = {
- strict?: boolean,
- isFunction?: boolean,
+export type PageCloseEvent = {};
+export type PageCrashEvent = {};
+export type PageDownloadEvent = {
+ url: string,
+ suggestedFilename: string,
+ artifact: ArtifactChannel,
};
-export type ElementHandleEvalOnSelectorResult = {
- value: SerializedValue,
+export type PageViewportSizeChangedEvent = {
+ viewportSize?: {
+ width: number,
+ height: number,
+ },
};
-export type ElementHandleEvalOnSelectorAllParams = {
- selector: string,
- expression: string,
- isFunction?: boolean,
- arg: SerializedArgument,
+export type PageFileChooserEvent = {
+ element: ElementHandleChannel,
+ isMultiple: boolean,
};
-export type ElementHandleEvalOnSelectorAllOptions = {
- isFunction?: boolean,
+export type PageFrameAttachedEvent = {
+ frame: FrameChannel,
};
-export type ElementHandleEvalOnSelectorAllResult = {
- value: SerializedValue,
+export type PageFrameDetachedEvent = {
+ frame: FrameChannel,
+};
+export type PageLocatorHandlerTriggeredEvent = {
+ uid: number,
+};
+export type PageRouteEvent = {
+ route: RouteChannel,
+};
+export type PageScreencastFrameEvent = {
+ data: Binary,
};
-export type ElementHandleBoundingBoxParams = {};
-export type ElementHandleBoundingBoxOptions = {};
-export type ElementHandleBoundingBoxResult = {
- value?: Rect,
+export type PageWebSocketRouteEvent = {
+ webSocketRoute: WebSocketRouteChannel,
};
-export type ElementHandleCheckParams = {
- force?: boolean,
- position?: Point,
- timeout: number,
- trial?: boolean,
+export type PageWebSocketEvent = {
+ webSocket: WebSocketChannel,
};
-export type ElementHandleCheckOptions = {
- force?: boolean,
- position?: Point,
- trial?: boolean,
+export type PageWorkerEvent = {
+ worker: WorkerChannel,
};
-export type ElementHandleCheckResult = void;
-export type ElementHandleClickParams = {
- force?: boolean,
- noWaitAfter?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- delay?: number,
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
- timeout: number,
- trial?: boolean,
- steps?: number,
+export type PageAddInitScriptParams = {
+ source: string,
};
-export type ElementHandleClickOptions = {
- force?: boolean,
- noWaitAfter?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- delay?: number,
- button?: 'left' | 'right' | 'middle',
- clickCount?: number,
- trial?: boolean,
- steps?: number,
+export type PageAddInitScriptOptions = {
+
};
-export type ElementHandleClickResult = void;
-export type ElementHandleContentFrameParams = {};
-export type ElementHandleContentFrameOptions = {};
-export type ElementHandleContentFrameResult = {
- frame?: FrameChannel,
+export type PageAddInitScriptResult = {
+ disposable: DisposableChannel,
};
-export type ElementHandleDblclickParams = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- delay?: number,
- button?: 'left' | 'right' | 'middle',
- timeout: number,
- trial?: boolean,
- steps?: number,
+export type PageCloseParams = {
+ runBeforeUnload?: boolean,
+ reason?: string,
};
-export type ElementHandleDblclickOptions = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- delay?: number,
- button?: 'left' | 'right' | 'middle',
- trial?: boolean,
- steps?: number,
+export type PageCloseOptions = {
+ runBeforeUnload?: boolean,
+ reason?: string,
};
-export type ElementHandleDblclickResult = void;
-export type ElementHandleDispatchEventParams = {
- type: string,
- eventInit: SerializedArgument,
+export type PageCloseResult = void;
+export type PageClearConsoleMessagesParams = {};
+export type PageClearConsoleMessagesOptions = {};
+export type PageClearConsoleMessagesResult = void;
+export type PageConsoleMessagesParams = {
+ filter?: ConsoleMessagesFilter,
};
-export type ElementHandleDispatchEventOptions = {
-
+export type PageConsoleMessagesOptions = {
+ filter?: ConsoleMessagesFilter,
};
-export type ElementHandleDispatchEventResult = void;
-export type ElementHandleFillParams = {
- value: string,
- force?: boolean,
- timeout: number,
+export type PageConsoleMessagesResult = {
+ messages: {
+ type: string,
+ text: string,
+ args: JSHandleChannel[],
+ location: {
+ url: string,
+ lineNumber: number,
+ columnNumber: number,
+ },
+ timestamp: number,
+ }[],
};
-export type ElementHandleFillOptions = {
- force?: boolean,
+export type PageEmulateMediaParams = {
+ media?: 'screen' | 'print' | 'no-override',
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ contrast?: 'no-preference' | 'more' | 'no-override',
};
-export type ElementHandleFillResult = void;
-export type ElementHandleFocusParams = {};
-export type ElementHandleFocusOptions = {};
-export type ElementHandleFocusResult = void;
-export type ElementHandleGetAttributeParams = {
+export type PageEmulateMediaOptions = {
+ media?: 'screen' | 'print' | 'no-override',
+ colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
+ reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
+ forcedColors?: 'active' | 'none' | 'no-override',
+ contrast?: 'no-preference' | 'more' | 'no-override',
+};
+export type PageEmulateMediaResult = void;
+export type PageExposeBindingParams = {
name: string,
};
-export type ElementHandleGetAttributeOptions = {
+export type PageExposeBindingOptions = {
};
-export type ElementHandleGetAttributeResult = {
- value?: string,
+export type PageExposeBindingResult = {
+ disposable: DisposableChannel,
};
-export type ElementHandleHoverParams = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
+export type PageGoBackParams = {
timeout: number,
- trial?: boolean,
-};
-export type ElementHandleHoverOptions = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- trial?: boolean,
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleHoverResult = void;
-export type ElementHandleInnerHTMLParams = {};
-export type ElementHandleInnerHTMLOptions = {};
-export type ElementHandleInnerHTMLResult = {
- value: string,
+export type PageGoBackOptions = {
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleInnerTextParams = {};
-export type ElementHandleInnerTextOptions = {};
-export type ElementHandleInnerTextResult = {
- value: string,
+export type PageGoBackResult = {
+ response?: ResponseChannel,
};
-export type ElementHandleInputValueParams = {};
-export type ElementHandleInputValueOptions = {};
-export type ElementHandleInputValueResult = {
- value: string,
+export type PageGoForwardParams = {
+ timeout: number,
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleIsCheckedParams = {};
-export type ElementHandleIsCheckedOptions = {};
-export type ElementHandleIsCheckedResult = {
- value: boolean,
+export type PageGoForwardOptions = {
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleIsDisabledParams = {};
-export type ElementHandleIsDisabledOptions = {};
-export type ElementHandleIsDisabledResult = {
- value: boolean,
+export type PageGoForwardResult = {
+ response?: ResponseChannel,
};
-export type ElementHandleIsEditableParams = {};
-export type ElementHandleIsEditableOptions = {};
-export type ElementHandleIsEditableResult = {
- value: boolean,
+export type PageRequestGCParams = {};
+export type PageRequestGCOptions = {};
+export type PageRequestGCResult = void;
+export type PageRegisterLocatorHandlerParams = {
+ selector: string,
+ noWaitAfter?: boolean,
};
-export type ElementHandleIsEnabledParams = {};
-export type ElementHandleIsEnabledOptions = {};
-export type ElementHandleIsEnabledResult = {
- value: boolean,
+export type PageRegisterLocatorHandlerOptions = {
+ noWaitAfter?: boolean,
};
-export type ElementHandleIsHiddenParams = {};
-export type ElementHandleIsHiddenOptions = {};
-export type ElementHandleIsHiddenResult = {
- value: boolean,
+export type PageRegisterLocatorHandlerResult = {
+ uid: number,
};
-export type ElementHandleIsVisibleParams = {};
-export type ElementHandleIsVisibleOptions = {};
-export type ElementHandleIsVisibleResult = {
- value: boolean,
+export type PageResolveLocatorHandlerNoReplyParams = {
+ uid: number,
+ remove?: boolean,
};
-export type ElementHandleOwnerFrameParams = {};
-export type ElementHandleOwnerFrameOptions = {};
-export type ElementHandleOwnerFrameResult = {
- frame?: FrameChannel,
+export type PageResolveLocatorHandlerNoReplyOptions = {
+ remove?: boolean,
};
-export type ElementHandlePressParams = {
- key: string,
- delay?: number,
- timeout: number,
- noWaitAfter?: boolean,
+export type PageResolveLocatorHandlerNoReplyResult = void;
+export type PageUnregisterLocatorHandlerParams = {
+ uid: number,
};
-export type ElementHandlePressOptions = {
- delay?: number,
- noWaitAfter?: boolean,
+export type PageUnregisterLocatorHandlerOptions = {
+
};
-export type ElementHandlePressResult = void;
-export type ElementHandleQuerySelectorParams = {
- selector: string,
- strict?: boolean,
+export type PageUnregisterLocatorHandlerResult = void;
+export type PageReloadParams = {
+ timeout: number,
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleQuerySelectorOptions = {
- strict?: boolean,
+export type PageReloadOptions = {
+ waitUntil?: LifecycleEvent,
};
-export type ElementHandleQuerySelectorResult = {
- element?: ElementHandleChannel,
+export type PageReloadResult = {
+ response?: ResponseChannel,
};
-export type ElementHandleQuerySelectorAllParams = {
- selector: string,
+export type PageExpectScreenshotParams = {
+ expected?: Binary,
+ timeout: number,
+ isNot: boolean,
+ locator?: {
+ frame: FrameChannel,
+ selector: string,
+ },
+ comparator?: string,
+ maxDiffPixels?: number,
+ maxDiffPixelRatio?: number,
+ threshold?: number,
+ fullPage?: boolean,
+ clip?: Rect,
+ omitBackground?: boolean,
+ caret?: 'hide' | 'initial',
+ animations?: 'disabled' | 'allow',
+ scale?: 'css' | 'device',
+ mask?: {
+ frame: FrameChannel,
+ selector: string,
+ }[],
+ maskColor?: string,
+ style?: string,
};
-export type ElementHandleQuerySelectorAllOptions = {
-
+export type PageExpectScreenshotOptions = {
+ expected?: Binary,
+ locator?: {
+ frame: FrameChannel,
+ selector: string,
+ },
+ comparator?: string,
+ maxDiffPixels?: number,
+ maxDiffPixelRatio?: number,
+ threshold?: number,
+ fullPage?: boolean,
+ clip?: Rect,
+ omitBackground?: boolean,
+ caret?: 'hide' | 'initial',
+ animations?: 'disabled' | 'allow',
+ scale?: 'css' | 'device',
+ mask?: {
+ frame: FrameChannel,
+ selector: string,
+ }[],
+ maskColor?: string,
+ style?: string,
};
-export type ElementHandleQuerySelectorAllResult = {
- elements: ElementHandleChannel[],
+export type PageExpectScreenshotResult = {
+ diff?: Binary,
+ errorMessage?: string,
+ actual?: Binary,
+ previous?: Binary,
+ timedOut?: boolean,
+ log?: string[],
};
-export type ElementHandleScreenshotParams = {
+export type PageScreenshotParams = {
timeout: number,
type?: 'png' | 'jpeg',
quality?: number,
+ fullPage?: boolean,
+ clip?: Rect,
omitBackground?: boolean,
caret?: 'hide' | 'initial',
animations?: 'disabled' | 'allow',
@@ -3957,9 +4113,11 @@ export type ElementHandleScreenshotParams = {
maskColor?: string,
style?: string,
};
-export type ElementHandleScreenshotOptions = {
+export type PageScreenshotOptions = {
type?: 'png' | 'jpeg',
quality?: number,
+ fullPage?: boolean,
+ clip?: Rect,
omitBackground?: boolean,
caret?: 'hide' | 'initial',
animations?: 'disabled' | 'allow',
@@ -3971,743 +4129,763 @@ export type ElementHandleScreenshotOptions = {
maskColor?: string,
style?: string,
};
-export type ElementHandleScreenshotResult = {
+export type PageScreenshotResult = {
binary: Binary,
};
-export type ElementHandleScrollIntoViewIfNeededParams = {
- timeout: number,
+export type PageSetExtraHTTPHeadersParams = {
+ headers: NameValue[],
};
-export type ElementHandleScrollIntoViewIfNeededOptions = {
+export type PageSetExtraHTTPHeadersOptions = {
};
-export type ElementHandleScrollIntoViewIfNeededResult = void;
-export type ElementHandleSelectOptionParams = {
- elements?: ElementHandleChannel[],
- options?: {
- valueOrLabel?: string,
- value?: string,
- label?: string,
- index?: number,
+export type PageSetExtraHTTPHeadersResult = void;
+export type PageSetNetworkInterceptionPatternsParams = {
+ patterns: {
+ glob?: string,
+ regexSource?: string,
+ regexFlags?: string,
+ urlPattern?: URLPattern,
}[],
- force?: boolean,
- timeout: number,
};
-export type ElementHandleSelectOptionOptions = {
- elements?: ElementHandleChannel[],
- options?: {
- valueOrLabel?: string,
- value?: string,
- label?: string,
- index?: number,
+export type PageSetNetworkInterceptionPatternsOptions = {
+
+};
+export type PageSetNetworkInterceptionPatternsResult = void;
+export type PageSetWebSocketInterceptionPatternsParams = {
+ patterns: {
+ glob?: string,
+ regexSource?: string,
+ regexFlags?: string,
+ urlPattern?: URLPattern,
}[],
- force?: boolean,
};
-export type ElementHandleSelectOptionResult = {
- values: string[],
+export type PageSetWebSocketInterceptionPatternsOptions = {
+
};
-export type ElementHandleSelectTextParams = {
- force?: boolean,
- timeout: number,
+export type PageSetWebSocketInterceptionPatternsResult = void;
+export type PageSetViewportSizeParams = {
+ viewportSize: {
+ width: number,
+ height: number,
+ },
};
-export type ElementHandleSelectTextOptions = {
- force?: boolean,
+export type PageSetViewportSizeOptions = {
+
};
-export type ElementHandleSelectTextResult = void;
-export type ElementHandleSetInputFilesParams = {
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localDirectory?: string,
- directoryStream?: WritableStreamChannel,
- localPaths?: string[],
- streams?: WritableStreamChannel[],
- timeout: number,
+export type PageSetViewportSizeResult = void;
+export type PageKeyboardDownParams = {
+ key: string,
};
-export type ElementHandleSetInputFilesOptions = {
- payloads?: {
- name: string,
- mimeType?: string,
- buffer: Binary,
- }[],
- localDirectory?: string,
- directoryStream?: WritableStreamChannel,
- localPaths?: string[],
- streams?: WritableStreamChannel[],
+export type PageKeyboardDownOptions = {
+
};
-export type ElementHandleSetInputFilesResult = void;
-export type ElementHandleTapParams = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- timeout: number,
- trial?: boolean,
+export type PageKeyboardDownResult = void;
+export type PageKeyboardUpParams = {
+ key: string,
};
-export type ElementHandleTapOptions = {
- force?: boolean,
- modifiers?: ('Alt' | 'Control' | 'ControlOrMeta' | 'Meta' | 'Shift')[],
- position?: Point,
- trial?: boolean,
+export type PageKeyboardUpOptions = {
+
};
-export type ElementHandleTapResult = void;
-export type ElementHandleTextContentParams = {};
-export type ElementHandleTextContentOptions = {};
-export type ElementHandleTextContentResult = {
- value?: string,
+export type PageKeyboardUpResult = void;
+export type PageKeyboardInsertTextParams = {
+ text: string,
};
-export type ElementHandleTypeParams = {
+export type PageKeyboardInsertTextOptions = {
+
+};
+export type PageKeyboardInsertTextResult = void;
+export type PageKeyboardTypeParams = {
text: string,
delay?: number,
- timeout: number,
};
-export type ElementHandleTypeOptions = {
+export type PageKeyboardTypeOptions = {
delay?: number,
};
-export type ElementHandleTypeResult = void;
-export type ElementHandleUncheckParams = {
- force?: boolean,
- position?: Point,
- timeout: number,
- trial?: boolean,
-};
-export type ElementHandleUncheckOptions = {
- force?: boolean,
- position?: Point,
- trial?: boolean,
+export type PageKeyboardTypeResult = void;
+export type PageKeyboardPressParams = {
+ key: string,
+ delay?: number,
};
-export type ElementHandleUncheckResult = void;
-export type ElementHandleWaitForElementStateParams = {
- state: 'visible' | 'hidden' | 'stable' | 'enabled' | 'disabled' | 'editable',
- timeout: number,
+export type PageKeyboardPressOptions = {
+ delay?: number,
};
-export type ElementHandleWaitForElementStateOptions = {
-
+export type PageKeyboardPressResult = void;
+export type PageMouseMoveParams = {
+ x: number,
+ y: number,
+ steps?: number,
};
-export type ElementHandleWaitForElementStateResult = void;
-export type ElementHandleWaitForSelectorParams = {
- selector: string,
- strict?: boolean,
- timeout: number,
- state?: 'attached' | 'detached' | 'visible' | 'hidden',
+export type PageMouseMoveOptions = {
+ steps?: number,
};
-export type ElementHandleWaitForSelectorOptions = {
- strict?: boolean,
- state?: 'attached' | 'detached' | 'visible' | 'hidden',
+export type PageMouseMoveResult = void;
+export type PageMouseDownParams = {
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
};
-export type ElementHandleWaitForSelectorResult = {
- element?: ElementHandleChannel,
+export type PageMouseDownOptions = {
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
};
-
-export interface ElementHandleEvents {
-}
-
-// ----------- Request -----------
-export type RequestInitializer = {
- frame?: FrameChannel,
- serviceWorker?: WorkerChannel,
- url: string,
- resourceType: string,
- method: string,
- postData?: Binary,
- headers: NameValue[],
- isNavigationRequest: boolean,
- redirectedFrom?: RequestChannel,
+export type PageMouseDownResult = void;
+export type PageMouseUpParams = {
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
};
-export interface RequestEventTarget {
-}
-export interface RequestChannel extends RequestEventTarget, Channel {
- _type_Request: boolean;
- response(params?: RequestResponseParams, progress?: Progress): Promise<RequestResponseResult>;
- rawRequestHeaders(params?: RequestRawRequestHeadersParams, progress?: Progress): Promise<RequestRawRequestHeadersResult>;
-}
-export type RequestResponseParams = {};
-export type RequestResponseOptions = {};
-export type RequestResponseResult = {
- response?: ResponseChannel,
+export type PageMouseUpOptions = {
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
};
-export type RequestRawRequestHeadersParams = {};
-export type RequestRawRequestHeadersOptions = {};
-export type RequestRawRequestHeadersResult = {
- headers: NameValue[],
+export type PageMouseUpResult = void;
+export type PageMouseClickParams = {
+ x: number,
+ y: number,
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
};
+export type PageMouseClickOptions = {
+ delay?: number,
+ button?: 'left' | 'right' | 'middle',
+ clickCount?: number,
+};
+export type PageMouseClickResult = void;
+export type PageMouseWheelParams = {
+ deltaX: number,
+ deltaY: number,
+};
+export type PageMouseWheelOptions = {
-export interface RequestEvents {
-}
-
-// ----------- Route -----------
-export type RouteInitializer = {
- request: RequestChannel,
};
-export interface RouteEventTarget {
-}
-export interface RouteChannel extends RouteEventTarget, Channel {
- _type_Route: boolean;
- redirectNavigationRequest(params: RouteRedirectNavigationRequestParams, progress?: Progress): Promise<RouteRedirectNavigationRequestResult>;
- abort(params: RouteAbortParams, progress?: Progress): Promise<RouteAbortResult>;
- continue(params: RouteContinueParams, progress?: Progress): Promise<RouteContinueResult>;
- fulfill(params: RouteFulfillParams, progress?: Progress): Promise<RouteFulfillResult>;
-}
-export type RouteRedirectNavigationRequestParams = {
- url: string,
+export type PageMouseWheelResult = void;
+export type PageTouchscreenTapParams = {
+ x: number,
+ y: number,
};
-export type RouteRedirectNavigationRequestOptions = {
+export type PageTouchscreenTapOptions = {
};
-export type RouteRedirectNavigationRequestResult = void;
-export type RouteAbortParams = {
- errorCode?: string,
+export type PageTouchscreenTapResult = void;
+export type PageClearPageErrorsParams = {};
+export type PageClearPageErrorsOptions = {};
+export type PageClearPageErrorsResult = void;
+export type PagePageErrorsParams = {
+ filter?: ConsoleMessagesFilter,
};
-export type RouteAbortOptions = {
- errorCode?: string,
+export type PagePageErrorsOptions = {
+ filter?: ConsoleMessagesFilter,
};
-export type RouteAbortResult = void;
-export type RouteContinueParams = {
- url?: string,
- method?: string,
- headers?: NameValue[],
- postData?: Binary,
- isFallback: boolean,
+export type PagePageErrorsResult = {
+ errors: SerializedError[],
};
-export type RouteContinueOptions = {
- url?: string,
- method?: string,
- headers?: NameValue[],
- postData?: Binary,
+export type PagePdfParams = {
+ scale?: number,
+ displayHeaderFooter?: boolean,
+ headerTemplate?: string,
+ footerTemplate?: string,
+ printBackground?: boolean,
+ landscape?: boolean,
+ pageRanges?: string,
+ format?: string,
+ width?: string,
+ height?: string,
+ preferCSSPageSize?: boolean,
+ margin?: {
+ top?: string,
+ bottom?: string,
+ left?: string,
+ right?: string,
+ },
+ tagged?: boolean,
+ outline?: boolean,
};
-export type RouteContinueResult = void;
-export type RouteFulfillParams = {
- status?: number,
- headers?: NameValue[],
- body?: string,
- isBase64?: boolean,
- fetchResponseUid?: string,
+export type PagePdfOptions = {
+ scale?: number,
+ displayHeaderFooter?: boolean,
+ headerTemplate?: string,
+ footerTemplate?: string,
+ printBackground?: boolean,
+ landscape?: boolean,
+ pageRanges?: string,
+ format?: string,
+ width?: string,
+ height?: string,
+ preferCSSPageSize?: boolean,
+ margin?: {
+ top?: string,
+ bottom?: string,
+ left?: string,
+ right?: string,
+ },
+ tagged?: boolean,
+ outline?: boolean,
};
-export type RouteFulfillOptions = {
- status?: number,
- headers?: NameValue[],
- body?: string,
- isBase64?: boolean,
- fetchResponseUid?: string,
+export type PagePdfResult = {
+ pdf: Binary,
};
-export type RouteFulfillResult = void;
-
-export interface RouteEvents {
-}
-
-// ----------- WebSocketRoute -----------
-export type WebSocketRouteInitializer = {
- url: string,
- protocols: string[],
+export type PageRequestsParams = {};
+export type PageRequestsOptions = {};
+export type PageRequestsResult = {
+ requests: RequestChannel[],
};
-export interface WebSocketRouteEventTarget {
- on(event: 'messageFromPage', callback: (params: WebSocketRouteMessageFromPageEvent) => void): this;
- on(event: 'messageFromServer', callback: (params: WebSocketRouteMessageFromServerEvent) => void): this;
- on(event: 'closePage', callback: (params: WebSocketRouteClosePageEvent) => void): this;
- on(event: 'closeServer', callback: (params: WebSocketRouteCloseServerEvent) => void): this;
-}
-export interface WebSocketRouteChannel extends WebSocketRouteEventTarget, Channel {
- _type_WebSocketRoute: boolean;
- connect(params?: WebSocketRouteConnectParams, progress?: Progress): Promise<WebSocketRouteConnectResult>;
- ensureOpened(params?: WebSocketRouteEnsureOpenedParams, progress?: Progress): Promise<WebSocketRouteEnsureOpenedResult>;
- sendToPage(params: WebSocketRouteSendToPageParams, progress?: Progress): Promise<WebSocketRouteSendToPageResult>;
- sendToServer(params: WebSocketRouteSendToServerParams, progress?: Progress): Promise<WebSocketRouteSendToServerResult>;
- closePage(params: WebSocketRouteClosePageParams, progress?: Progress): Promise<WebSocketRouteClosePageResult>;
- closeServer(params: WebSocketRouteCloseServerParams, progress?: Progress): Promise<WebSocketRouteCloseServerResult>;
-}
-export type WebSocketRouteMessageFromPageEvent = {
- message: string,
- isBase64: boolean,
+export type PageStartJSCoverageParams = {
+ resetOnNavigation?: boolean,
+ reportAnonymousScripts?: boolean,
};
-export type WebSocketRouteMessageFromServerEvent = {
- message: string,
- isBase64: boolean,
+export type PageStartJSCoverageOptions = {
+ resetOnNavigation?: boolean,
+ reportAnonymousScripts?: boolean,
};
-export type WebSocketRouteClosePageEvent = {
- code?: number,
- reason?: string,
- wasClean: boolean,
+export type PageStartJSCoverageResult = void;
+export type PageStopJSCoverageParams = {};
+export type PageStopJSCoverageOptions = {};
+export type PageStopJSCoverageResult = {
+ entries: {
+ url: string,
+ scriptId: string,
+ source?: string,
+ functions: {
+ functionName: string,
+ isBlockCoverage: boolean,
+ ranges: {
+ startOffset: number,
+ endOffset: number,
+ count: number,
+ }[],
+ }[],
+ }[],
};
-export type WebSocketRouteCloseServerEvent = {
- code?: number,
- reason?: string,
- wasClean: boolean,
+export type PageStartCSSCoverageParams = {
+ resetOnNavigation?: boolean,
};
-export type WebSocketRouteConnectParams = {};
-export type WebSocketRouteConnectOptions = {};
-export type WebSocketRouteConnectResult = void;
-export type WebSocketRouteEnsureOpenedParams = {};
-export type WebSocketRouteEnsureOpenedOptions = {};
-export type WebSocketRouteEnsureOpenedResult = void;
-export type WebSocketRouteSendToPageParams = {
- message: string,
- isBase64: boolean,
+export type PageStartCSSCoverageOptions = {
+ resetOnNavigation?: boolean,
};
-export type WebSocketRouteSendToPageOptions = {
-
+export type PageStartCSSCoverageResult = void;
+export type PageStopCSSCoverageParams = {};
+export type PageStopCSSCoverageOptions = {};
+export type PageStopCSSCoverageResult = {
+ entries: {
+ url: string,
+ text?: string,
+ ranges: {
+ start: number,
+ end: number,
+ }[],
+ }[],
};
-export type WebSocketRouteSendToPageResult = void;
-export type WebSocketRouteSendToServerParams = {
- message: string,
- isBase64: boolean,
+export type PageBringToFrontParams = {};
+export type PageBringToFrontOptions = {};
+export type PageBringToFrontResult = void;
+export type PagePickLocatorParams = {};
+export type PagePickLocatorOptions = {};
+export type PagePickLocatorResult = {
+ selector: string,
};
-export type WebSocketRouteSendToServerOptions = {
-
+export type PageCancelPickLocatorParams = {};
+export type PageCancelPickLocatorOptions = {};
+export type PageCancelPickLocatorResult = void;
+export type PageHideHighlightParams = {};
+export type PageHideHighlightOptions = {};
+export type PageHideHighlightResult = void;
+export type PageScreencastShowOverlayParams = {
+ html: string,
+ duration?: number,
};
-export type WebSocketRouteSendToServerResult = void;
-export type WebSocketRouteClosePageParams = {
- code?: number,
- reason?: string,
- wasClean: boolean,
+export type PageScreencastShowOverlayOptions = {
+ duration?: number,
+};
+export type PageScreencastShowOverlayResult = {
+ id: string,
+};
+export type PageScreencastRemoveOverlayParams = {
+ id: string,
+};
+export type PageScreencastRemoveOverlayOptions = {
+
};
-export type WebSocketRouteClosePageOptions = {
- code?: number,
- reason?: string,
+export type PageScreencastRemoveOverlayResult = void;
+export type PageScreencastChapterParams = {
+ title: string,
+ description?: string,
+ duration?: number,
};
-export type WebSocketRouteClosePageResult = void;
-export type WebSocketRouteCloseServerParams = {
- code?: number,
- reason?: string,
- wasClean: boolean,
+export type PageScreencastChapterOptions = {
+ description?: string,
+ duration?: number,
};
-export type WebSocketRouteCloseServerOptions = {
- code?: number,
- reason?: string,
+export type PageScreencastChapterResult = void;
+export type PageScreencastSetOverlayVisibleParams = {
+ visible: boolean,
};
-export type WebSocketRouteCloseServerResult = void;
-
-export interface WebSocketRouteEvents {
- 'messageFromPage': WebSocketRouteMessageFromPageEvent;
- 'messageFromServer': WebSocketRouteMessageFromServerEvent;
- 'closePage': WebSocketRouteClosePageEvent;
- 'closeServer': WebSocketRouteCloseServerEvent;
-}
+export type PageScreencastSetOverlayVisibleOptions = {
-export type ResourceTiming = {
- startTime: number,
- domainLookupStart: number,
- domainLookupEnd: number,
- connectStart: number,
- secureConnectionStart: number,
- connectEnd: number,
- requestStart: number,
- responseStart: number,
};
-
-// ----------- Response -----------
-export type ResponseInitializer = {
- request: RequestChannel,
- url: string,
- status: number,
- statusText: string,
- headers: NameValue[],
- timing: ResourceTiming,
- fromServiceWorker: boolean,
+export type PageScreencastSetOverlayVisibleResult = void;
+export type PageScreencastShowActionsParams = {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
};
-export interface ResponseEventTarget {
-}
-export interface ResponseChannel extends ResponseEventTarget, Channel {
- _type_Response: boolean;
- body(params?: ResponseBodyParams, progress?: Progress): Promise<ResponseBodyResult>;
- securityDetails(params?: ResponseSecurityDetailsParams, progress?: Progress): Promise<ResponseSecurityDetailsResult>;
- serverAddr(params?: ResponseServerAddrParams, progress?: Progress): Promise<ResponseServerAddrResult>;
- rawResponseHeaders(params?: ResponseRawResponseHeadersParams, progress?: Progress): Promise<ResponseRawResponseHeadersResult>;
- httpVersion(params?: ResponseHttpVersionParams, progress?: Progress): Promise<ResponseHttpVersionResult>;
- sizes(params?: ResponseSizesParams, progress?: Progress): Promise<ResponseSizesResult>;
-}
-export type ResponseBodyParams = {};
-export type ResponseBodyOptions = {};
-export type ResponseBodyResult = {
- binary: Binary,
+export type PageScreencastShowActionsOptions = {
+ duration?: number,
+ position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
+ fontSize?: number,
};
-export type ResponseSecurityDetailsParams = {};
-export type ResponseSecurityDetailsOptions = {};
-export type ResponseSecurityDetailsResult = {
- value?: SecurityDetails,
+export type PageScreencastShowActionsResult = void;
+export type PageScreencastHideActionsParams = {};
+export type PageScreencastHideActionsOptions = {};
+export type PageScreencastHideActionsResult = void;
+export type PageScreencastStartParams = {
+ size?: {
+ width: number,
+ height: number,
+ },
+ quality?: number,
+ sendFrames?: boolean,
+ record?: boolean,
};
-export type ResponseServerAddrParams = {};
-export type ResponseServerAddrOptions = {};
-export type ResponseServerAddrResult = {
- value?: RemoteAddr,
+export type PageScreencastStartOptions = {
+ size?: {
+ width: number,
+ height: number,
+ },
+ quality?: number,
+ sendFrames?: boolean,
+ record?: boolean,
};
-export type ResponseRawResponseHeadersParams = {};
-export type ResponseRawResponseHeadersOptions = {};
-export type ResponseRawResponseHeadersResult = {
- headers: NameValue[],
+export type PageScreencastStartResult = {
+ artifact?: ArtifactChannel,
};
-export type ResponseHttpVersionParams = {};
-export type ResponseHttpVersionOptions = {};
-export type ResponseHttpVersionResult = {
- value: string,
+export type PageScreencastStopParams = {};
+export type PageScreencastStopOptions = {};
+export type PageScreencastStopResult = void;
+export type PageUpdateSubscriptionParams = {
+ event: 'console' | 'dialog' | 'fileChooser' | 'request' | 'response' | 'requestFinished' | 'requestFailed',
+ enabled: boolean,
};
-export type ResponseSizesParams = {};
-export type ResponseSizesOptions = {};
-export type ResponseSizesResult = {
- sizes: RequestSizes,
+export type PageUpdateSubscriptionOptions = {
+
+};
+export type PageUpdateSubscriptionResult = void;
+export type PageSetDockTileParams = {
+ image: Binary,
};
+export type PageSetDockTileOptions = {
-export interface ResponseEvents {
+};
+export type PageSetDockTileResult = void;
+
+export interface PageEvents {
+ 'bindingCall': PageBindingCallEvent;
+ 'close': PageCloseEvent;
+ 'crash': PageCrashEvent;
+ 'download': PageDownloadEvent;
+ 'viewportSizeChanged': PageViewportSizeChangedEvent;
+ 'fileChooser': PageFileChooserEvent;
+ 'frameAttached': PageFrameAttachedEvent;
+ 'frameDetached': PageFrameDetachedEvent;
+ 'locatorHandlerTriggered': PageLocatorHandlerTriggeredEvent;
+ 'route': PageRouteEvent;
+ 'screencastFrame': PageScreencastFrameEvent;
+ 'webSocketRoute': PageWebSocketRouteEvent;
+ 'webSocket': PageWebSocketEvent;
+ 'worker': PageWorkerEvent;
}
-export type SecurityDetails = {
- issuer?: string,
- protocol?: string,
- subjectName?: string,
- validFrom?: number,
- validTo?: number,
+// ----------- Root -----------
+export type RootInitializer = {};
+export interface RootEventTarget {
+}
+export interface RootChannel extends RootEventTarget, Channel {
+ _type_Root: boolean;
+ initialize(params: RootInitializeParams, progress?: Progress): Promise<RootInitializeResult>;
+}
+export type RootInitializeParams = {
+ sdkLanguage: SDKLanguage,
};
+export type RootInitializeOptions = {
-export type RequestSizes = {
- requestBodySize: number,
- requestHeadersSize: number,
- responseBodySize: number,
- responseHeadersSize: number,
};
-
-export type RemoteAddr = {
- ipAddress: string,
- port: number,
+export type RootInitializeResult = {
+ playwright: PlaywrightChannel,
};
-// ----------- WebSocket -----------
-export type WebSocketInitializer = {
- url: string,
+export interface RootEvents {
+}
+
+// ----------- Playwright -----------
+export type PlaywrightInitializer = {
+ chromium: BrowserTypeChannel,
+ firefox: BrowserTypeChannel,
+ webkit: BrowserTypeChannel,
+ android: AndroidChannel,
+ utils?: LocalUtilsChannel,
+ preLaunchedBrowser?: BrowserChannel,
+ preConnectedAndroidDevice?: AndroidDeviceChannel,
+ socksSupport?: SocksSupportChannel,
};
-export interface WebSocketEventTarget {
- on(event: 'open', callback: (params: WebSocketOpenEvent) => void): this;
- on(event: 'frameSent', callback: (params: WebSocketFrameSentEvent) => void): this;
- on(event: 'frameReceived', callback: (params: WebSocketFrameReceivedEvent) => void): this;
- on(event: 'socketError', callback: (params: WebSocketSocketErrorEvent) => void): this;
- on(event: 'close', callback: (params: WebSocketCloseEvent) => void): this;
+export interface PlaywrightEventTarget {
}
-export interface WebSocketChannel extends WebSocketEventTarget, EventTargetChannel {
- _type_WebSocket: boolean;
+export interface PlaywrightChannel extends PlaywrightEventTarget, Channel {
+ _type_Playwright: boolean;
+ newRequest(params: PlaywrightNewRequestParams, progress?: Progress): Promise<PlaywrightNewRequestResult>;
}
-export type WebSocketOpenEvent = {};
-export type WebSocketFrameSentEvent = {
- opcode: number,
- data: string,
+export type PlaywrightNewRequestParams = {
+ baseURL?: string,
+ userAgent?: string,
+ ignoreHTTPSErrors?: boolean,
+ extraHTTPHeaders?: NameValue[],
+ failOnStatusCode?: boolean,
+ clientCertificates?: {
+ origin: string,
+ cert?: Binary,
+ key?: Binary,
+ passphrase?: string,
+ pfx?: Binary,
+ }[],
+ maxRedirects?: number,
+ httpCredentials?: {
+ username: string,
+ password: string,
+ origin?: string,
+ send?: 'always' | 'unauthorized',
+ },
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ storageState?: {
+ cookies?: NetworkCookie[],
+ origins?: SetOriginStorage[],
+ },
+ tracesDir?: string,
};
-export type WebSocketFrameReceivedEvent = {
- opcode: number,
- data: string,
+export type PlaywrightNewRequestOptions = {
+ baseURL?: string,
+ userAgent?: string,
+ ignoreHTTPSErrors?: boolean,
+ extraHTTPHeaders?: NameValue[],
+ failOnStatusCode?: boolean,
+ clientCertificates?: {
+ origin: string,
+ cert?: Binary,
+ key?: Binary,
+ passphrase?: string,
+ pfx?: Binary,
+ }[],
+ maxRedirects?: number,
+ httpCredentials?: {
+ username: string,
+ password: string,
+ origin?: string,
+ send?: 'always' | 'unauthorized',
+ },
+ proxy?: {
+ server: string,
+ bypass?: string,
+ username?: string,
+ password?: string,
+ },
+ storageState?: {
+ cookies?: NetworkCookie[],
+ origins?: SetOriginStorage[],
+ },
+ tracesDir?: string,
};
-export type WebSocketSocketErrorEvent = {
- error: string,
+export type PlaywrightNewRequestResult = {
+ request: APIRequestContextChannel,
};
-export type WebSocketCloseEvent = {};
-export interface WebSocketEvents {
- 'open': WebSocketOpenEvent;
- 'frameSent': WebSocketFrameSentEvent;
- 'frameReceived': WebSocketFrameReceivedEvent;
- 'socketError': WebSocketSocketErrorEvent;
- 'close': WebSocketCloseEvent;
+export interface PlaywrightEvents {
}
-// ----------- BindingCall -----------
-export type BindingCallInitializer = {
- frame: FrameChannel,
- name: string,
- args: SerializedValue[],
-};
-export interface BindingCallEventTarget {
+// ----------- DebugController -----------
+export type DebugControllerInitializer = {};
+export interface DebugControllerEventTarget {
+ on(event: 'inspectRequested', callback: (params: DebugControllerInspectRequestedEvent) => void): this;
+ on(event: 'setModeRequested', callback: (params: DebugControllerSetModeRequestedEvent) => void): this;
+ on(event: 'stateChanged', callback: (params: DebugControllerStateChangedEvent) => void): this;
+ on(event: 'sourceChanged', callback: (params: DebugControllerSourceChangedEvent) => void): this;
+ on(event: 'paused', callback: (params: DebugControllerPausedEvent) => void): this;
}
-export interface BindingCallChannel extends BindingCallEventTarget, Channel {
- _type_BindingCall: boolean;
- reject(params: BindingCallRejectParams, progress?: Progress): Promise<BindingCallRejectResult>;
- resolve(params: BindingCallResolveParams, progress?: Progress): Promise<BindingCallResolveResult>;
+export interface DebugControllerChannel extends DebugControllerEventTarget, Channel {
+ _type_DebugController: boolean;
+ initialize(params: DebugControllerInitializeParams, progress?: Progress): Promise<DebugControllerInitializeResult>;
+ setReportStateChanged(params: DebugControllerSetReportStateChangedParams, progress?: Progress): Promise<DebugControllerSetReportStateChangedResult>;
+ setRecorderMode(params: DebugControllerSetRecorderModeParams, progress?: Progress): Promise<DebugControllerSetRecorderModeResult>;
+ highlight(params: DebugControllerHighlightParams, progress?: Progress): Promise<DebugControllerHighlightResult>;
+ hideHighlight(params?: DebugControllerHideHighlightParams, progress?: Progress): Promise<DebugControllerHideHighlightResult>;
+ resume(params?: DebugControllerResumeParams, progress?: Progress): Promise<DebugControllerResumeResult>;
+ kill(params?: DebugControllerKillParams, progress?: Progress): Promise<DebugControllerKillResult>;
}
-export type BindingCallRejectParams = {
- error: SerializedError,
+export type DebugControllerInspectRequestedEvent = {
+ selector: string,
+ locator: string,
+ ariaSnapshot: string,
};
-export type BindingCallRejectOptions = {
-
+export type DebugControllerSetModeRequestedEvent = {
+ mode: string,
};
-export type BindingCallRejectResult = void;
-export type BindingCallResolveParams = {
- result: SerializedArgument,
+export type DebugControllerStateChangedEvent = {
+ pageCount: number,
};
-export type BindingCallResolveOptions = {
-
+export type DebugControllerSourceChangedEvent = {
+ text: string,
+ header?: string,
+ footer?: string,
+ actions?: string[],
};
-export type BindingCallResolveResult = void;
-
-export interface BindingCallEvents {
-}
-
-// ----------- Debugger -----------
-export type DebuggerInitializer = {};
-export interface DebuggerEventTarget {
- on(event: 'pausedStateChanged', callback: (params: DebuggerPausedStateChangedEvent) => void): this;
-}
-export interface DebuggerChannel extends DebuggerEventTarget, EventTargetChannel {
- _type_Debugger: boolean;
- requestPause(params?: DebuggerRequestPauseParams, progress?: Progress): Promise<DebuggerRequestPauseResult>;
- resume(params?: DebuggerResumeParams, progress?: Progress): Promise<DebuggerResumeResult>;
- next(params?: DebuggerNextParams, progress?: Progress): Promise<DebuggerNextResult>;
- runTo(params: DebuggerRunToParams, progress?: Progress): Promise<DebuggerRunToResult>;
-}
-export type DebuggerPausedStateChangedEvent = {
- pausedDetails?: {
- location: {
- file: string,
- line?: number,
- column?: number,
- },
- title: string,
- stack?: string,
- },
+export type DebugControllerPausedEvent = {
+ paused: boolean,
};
-export type DebuggerRequestPauseParams = {};
-export type DebuggerRequestPauseOptions = {};
-export type DebuggerRequestPauseResult = void;
-export type DebuggerResumeParams = {};
-export type DebuggerResumeOptions = {};
-export type DebuggerResumeResult = void;
-export type DebuggerNextParams = {};
-export type DebuggerNextOptions = {};
-export type DebuggerNextResult = void;
-export type DebuggerRunToParams = {
- location: {
- file: string,
- line?: number,
- column?: number,
- },
+export type DebugControllerInitializeParams = {
+ codegenId: string,
+ sdkLanguage: SDKLanguage,
};
-export type DebuggerRunToOptions = {
+export type DebugControllerInitializeOptions = {
};
-export type DebuggerRunToResult = void;
-
-export interface DebuggerEvents {
- 'pausedStateChanged': DebuggerPausedStateChangedEvent;
-}
+export type DebugControllerInitializeResult = void;
+export type DebugControllerSetReportStateChangedParams = {
+ enabled: boolean,
+};
+export type DebugControllerSetReportStateChangedOptions = {
-// ----------- Dialog -----------
-export type DialogInitializer = {
- page?: PageChannel,
- type: string,
- message: string,
- defaultValue: string,
};
-export interface DialogEventTarget {
-}
-export interface DialogChannel extends DialogEventTarget, Channel {
- _type_Dialog: boolean;
- accept(params: DialogAcceptParams, progress?: Progress): Promise<DialogAcceptResult>;
- dismiss(params?: DialogDismissParams, progress?: Progress): Promise<DialogDismissResult>;
-}
-export type DialogAcceptParams = {
- promptText?: string,
+export type DebugControllerSetReportStateChangedResult = void;
+export type DebugControllerSetRecorderModeParams = {
+ mode: 'inspecting' | 'recording' | 'none',
+ testIdAttributeName?: string,
+ generateAutoExpect?: boolean,
};
-export type DialogAcceptOptions = {
- promptText?: string,
+export type DebugControllerSetRecorderModeOptions = {
+ testIdAttributeName?: string,
+ generateAutoExpect?: boolean,
};
-export type DialogAcceptResult = void;
-export type DialogDismissParams = {};
-export type DialogDismissOptions = {};
-export type DialogDismissResult = void;
+export type DebugControllerSetRecorderModeResult = void;
+export type DebugControllerHighlightParams = {
+ selector?: string,
+ ariaTemplate?: string,
+};
+export type DebugControllerHighlightOptions = {
+ selector?: string,
+ ariaTemplate?: string,
+};
+export type DebugControllerHighlightResult = void;
+export type DebugControllerHideHighlightParams = {};
+export type DebugControllerHideHighlightOptions = {};
+export type DebugControllerHideHighlightResult = void;
+export type DebugControllerResumeParams = {};
+export type DebugControllerResumeOptions = {};
+export type DebugControllerResumeResult = void;
+export type DebugControllerKillParams = {};
+export type DebugControllerKillOptions = {};
+export type DebugControllerKillResult = void;
-export interface DialogEvents {
+export interface DebugControllerEvents {
+ 'inspectRequested': DebugControllerInspectRequestedEvent;
+ 'setModeRequested': DebugControllerSetModeRequestedEvent;
+ 'stateChanged': DebugControllerStateChangedEvent;
+ 'sourceChanged': DebugControllerSourceChangedEvent;
+ 'paused': DebugControllerPausedEvent;
}
-// ----------- Tracing -----------
-export type TracingInitializer = {};
-export interface TracingEventTarget {
+// ----------- SocksSupport -----------
+export type SocksSupportInitializer = {};
+export interface SocksSupportEventTarget {
+ on(event: 'socksRequested', callback: (params: SocksSupportSocksRequestedEvent) => void): this;
+ on(event: 'socksData', callback: (params: SocksSupportSocksDataEvent) => void): this;
+ on(event: 'socksClosed', callback: (params: SocksSupportSocksClosedEvent) => void): this;
}
-export interface TracingChannel extends TracingEventTarget, Channel {
- _type_Tracing: boolean;
- tracingStart(params: TracingTracingStartParams, progress?: Progress): Promise<TracingTracingStartResult>;
- tracingStartChunk(params: TracingTracingStartChunkParams, progress?: Progress): Promise<TracingTracingStartChunkResult>;
- tracingGroup(params: TracingTracingGroupParams, progress?: Progress): Promise<TracingTracingGroupResult>;
- tracingGroupEnd(params?: TracingTracingGroupEndParams, progress?: Progress): Promise<TracingTracingGroupEndResult>;
- tracingStopChunk(params: TracingTracingStopChunkParams, progress?: Progress): Promise<TracingTracingStopChunkResult>;
- tracingStop(params?: TracingTracingStopParams, progress?: Progress): Promise<TracingTracingStopResult>;
- harStart(params: TracingHarStartParams, progress?: Progress): Promise<TracingHarStartResult>;
- harExport(params: TracingHarExportParams, progress?: Progress): Promise<TracingHarExportResult>;
+export interface SocksSupportChannel extends SocksSupportEventTarget, Channel {
+ _type_SocksSupport: boolean;
+ socksConnected(params: SocksSupportSocksConnectedParams, progress?: Progress): Promise<SocksSupportSocksConnectedResult>;
+ socksFailed(params: SocksSupportSocksFailedParams, progress?: Progress): Promise<SocksSupportSocksFailedResult>;
+ socksData(params: SocksSupportSocksDataParams, progress?: Progress): Promise<SocksSupportSocksDataResult>;
+ socksError(params: SocksSupportSocksErrorParams, progress?: Progress): Promise<SocksSupportSocksErrorResult>;
+ socksEnd(params: SocksSupportSocksEndParams, progress?: Progress): Promise<SocksSupportSocksEndResult>;
}
-export type TracingTracingStartParams = {
- name?: string,
- snapshots?: boolean,
- screenshots?: boolean,
- live?: boolean,
-};
-export type TracingTracingStartOptions = {
- name?: string,
- snapshots?: boolean,
- screenshots?: boolean,
- live?: boolean,
-};
-export type TracingTracingStartResult = void;
-export type TracingTracingStartChunkParams = {
- name?: string,
- title?: string,
-};
-export type TracingTracingStartChunkOptions = {
- name?: string,
- title?: string,
-};
-export type TracingTracingStartChunkResult = {
- traceName: string,
-};
-export type TracingTracingGroupParams = {
- name: string,
- location?: {
- file: string,
- line?: number,
- column?: number,
- },
+export type SocksSupportSocksRequestedEvent = {
+ uid: string,
+ host: string,
+ port: number,
};
-export type TracingTracingGroupOptions = {
- location?: {
- file: string,
- line?: number,
- column?: number,
- },
+export type SocksSupportSocksDataEvent = {
+ uid: string,
+ data: Binary,
};
-export type TracingTracingGroupResult = void;
-export type TracingTracingGroupEndParams = {};
-export type TracingTracingGroupEndOptions = {};
-export type TracingTracingGroupEndResult = void;
-export type TracingTracingStopChunkParams = {
- mode: 'archive' | 'discard' | 'entries',
+export type SocksSupportSocksClosedEvent = {
+ uid: string,
};
-export type TracingTracingStopChunkOptions = {
+export type SocksSupportSocksConnectedParams = {
+ uid: string,
+ host: string,
+ port: number,
+};
+export type SocksSupportSocksConnectedOptions = {
};
-export type TracingTracingStopChunkResult = {
- artifact?: ArtifactChannel,
- entries?: NameValue[],
+export type SocksSupportSocksConnectedResult = void;
+export type SocksSupportSocksFailedParams = {
+ uid: string,
+ errorCode: string,
};
-export type TracingTracingStopParams = {};
-export type TracingTracingStopOptions = {};
-export type TracingTracingStopResult = void;
-export type TracingHarStartParams = {
- page?: PageChannel,
- options: RecordHarOptions,
+export type SocksSupportSocksFailedOptions = {
+
};
-export type TracingHarStartOptions = {
- page?: PageChannel,
+export type SocksSupportSocksFailedResult = void;
+export type SocksSupportSocksDataParams = {
+ uid: string,
+ data: Binary,
};
-export type TracingHarStartResult = {
- harId: string,
+export type SocksSupportSocksDataOptions = {
+
};
-export type TracingHarExportParams = {
- harId?: string,
- mode: 'archive' | 'entries',
+export type SocksSupportSocksDataResult = void;
+export type SocksSupportSocksErrorParams = {
+ uid: string,
+ error: string,
};
-export type TracingHarExportOptions = {
- harId?: string,
+export type SocksSupportSocksErrorOptions = {
+
};
-export type TracingHarExportResult = {
- artifact?: ArtifactChannel,
- entries?: NameValue[],
+export type SocksSupportSocksErrorResult = void;
+export type SocksSupportSocksEndParams = {
+ uid: string,
};
+export type SocksSupportSocksEndOptions = {
-export interface TracingEvents {
+};
+export type SocksSupportSocksEndResult = void;
+
+export interface SocksSupportEvents {
+ 'socksRequested': SocksSupportSocksRequestedEvent;
+ 'socksData': SocksSupportSocksDataEvent;
+ 'socksClosed': SocksSupportSocksClosedEvent;
}
-// ----------- Artifact -----------
-export type ArtifactInitializer = {
- absolutePath: string,
-};
-export interface ArtifactEventTarget {
+// ----------- JsonPipe -----------
+export type JsonPipeInitializer = {};
+export interface JsonPipeEventTarget {
+ on(event: 'message', callback: (params: JsonPipeMessageEvent) => void): this;
+ on(event: 'closed', callback: (params: JsonPipeClosedEvent) => void): this;
}
-export interface ArtifactChannel extends ArtifactEventTarget, Channel {
- _type_Artifact: boolean;
- pathAfterFinished(params?: ArtifactPathAfterFinishedParams, progress?: Progress): Promise<ArtifactPathAfterFinishedResult>;
- saveAs(params: ArtifactSaveAsParams, progress?: Progress): Promise<ArtifactSaveAsResult>;
- saveAsStream(params?: ArtifactSaveAsStreamParams, progress?: Progress): Promise<ArtifactSaveAsStreamResult>;
- failure(params?: ArtifactFailureParams, progress?: Progress): Promise<ArtifactFailureResult>;
- stream(params?: ArtifactStreamParams, progress?: Progress): Promise<ArtifactStreamResult>;
- cancel(params?: ArtifactCancelParams, progress?: Progress): Promise<ArtifactCancelResult>;
- delete(params?: ArtifactDeleteParams, progress?: Progress): Promise<ArtifactDeleteResult>;
+export interface JsonPipeChannel extends JsonPipeEventTarget, Channel {
+ _type_JsonPipe: boolean;
+ send(params: JsonPipeSendParams, progress?: Progress): Promise<JsonPipeSendResult>;
+ close(params?: JsonPipeCloseParams, progress?: Progress): Promise<JsonPipeCloseResult>;
}
-export type ArtifactPathAfterFinishedParams = {};
-export type ArtifactPathAfterFinishedOptions = {};
-export type ArtifactPathAfterFinishedResult = {
- value: string,
-};
-export type ArtifactSaveAsParams = {
- path: string,
-};
-export type ArtifactSaveAsOptions = {
-
+export type JsonPipeMessageEvent = {
+ message: any,
};
-export type ArtifactSaveAsResult = void;
-export type ArtifactSaveAsStreamParams = {};
-export type ArtifactSaveAsStreamOptions = {};
-export type ArtifactSaveAsStreamResult = {
- stream: StreamChannel,
+export type JsonPipeClosedEvent = {
+ reason?: string,
};
-export type ArtifactFailureParams = {};
-export type ArtifactFailureOptions = {};
-export type ArtifactFailureResult = {
- error?: string,
+export type JsonPipeSendParams = {
+ message: any,
};
-export type ArtifactStreamParams = {};
-export type ArtifactStreamOptions = {};
-export type ArtifactStreamResult = {
- stream: StreamChannel,
+export type JsonPipeSendOptions = {
+
};
-export type ArtifactCancelParams = {};
-export type ArtifactCancelOptions = {};
-export type ArtifactCancelResult = void;
-export type ArtifactDeleteParams = {};
-export type ArtifactDeleteOptions = {};
-export type ArtifactDeleteResult = void;
+export type JsonPipeSendResult = void;
+export type JsonPipeCloseParams = {};
+export type JsonPipeCloseOptions = {};
+export type JsonPipeCloseResult = void;
-export interface ArtifactEvents {
+export interface JsonPipeEvents {
+ 'message': JsonPipeMessageEvent;
+ 'closed': JsonPipeClosedEvent;
}
-// ----------- Stream -----------
-export type StreamInitializer = {};
-export interface StreamEventTarget {
-}
-export interface StreamChannel extends StreamEventTarget, Channel {
- _type_Stream: boolean;
- read(params: StreamReadParams, progress?: Progress): Promise<StreamReadResult>;
- close(params?: StreamCloseParams, progress?: Progress): Promise<StreamCloseResult>;
-}
-export type StreamReadParams = {
- size?: number,
+export type ExpectedTextValue = {
+ string?: string,
+ regexSource?: string,
+ regexFlags?: string,
+ matchSubstring?: boolean,
+ ignoreCase?: boolean,
+ normalizeWhiteSpace?: boolean,
};
-export type StreamReadOptions = {
- size?: number,
+
+export type SelectorEngine = {
+ name: string,
+ source: string,
+ contentScript?: boolean,
};
-export type StreamReadResult = {
- binary: Binary,
+
+export type FormField = {
+ name: string,
+ value?: string,
+ file?: {
+ name: string,
+ mimeType?: string,
+ buffer: Binary,
+ },
};
-export type StreamCloseParams = {};
-export type StreamCloseOptions = {};
-export type StreamCloseResult = void;
-export interface StreamEvents {
-}
+export type LifecycleEvent = 'load' | 'domcontentloaded' | 'networkidle' | 'commit';
+export type ConsoleMessagesFilter = 'all' | 'since-navigation';
+export type RecorderSource = {
+ isRecorded: boolean,
+ id: string,
+ label: string,
+ text: string,
+ language: string,
+ highlight: {
+ line: number,
+ type: string,
+ }[],
+ revealLine?: number,
+ group?: string,
+};
-// ----------- WritableStream -----------
-export type WritableStreamInitializer = {};
-export interface WritableStreamEventTarget {
-}
-export interface WritableStreamChannel extends WritableStreamEventTarget, Channel {
- _type_WritableStream: boolean;
- write(params: WritableStreamWriteParams, progress?: Progress): Promise<WritableStreamWriteResult>;
- close(params?: WritableStreamCloseParams, progress?: Progress): Promise<WritableStreamCloseResult>;
-}
-export type WritableStreamWriteParams = {
- binary: Binary,
+export type IndexedDBDatabase = {
+ name: string,
+ version: number,
+ stores: {
+ name: string,
+ autoIncrement: boolean,
+ keyPath?: string,
+ keyPathArray?: string[],
+ records: {
+ key?: any,
+ keyEncoded?: any,
+ value?: any,
+ valueEncoded?: any,
+ }[],
+ indexes: {
+ name: string,
+ keyPath?: string,
+ keyPathArray?: string[],
+ multiEntry: boolean,
+ unique: boolean,
+ }[],
+ }[],
};
-export type WritableStreamWriteOptions = {
+export type SetOriginStorage = {
+ origin: string,
+ localStorage: NameValue[],
+ indexedDB?: IndexedDBDatabase[],
};
-export type WritableStreamWriteResult = void;
-export type WritableStreamCloseParams = {};
-export type WritableStreamCloseOptions = {};
-export type WritableStreamCloseResult = void;
-export interface WritableStreamEvents {
-}
+export type OriginStorage = {
+ origin: string,
+ localStorage: NameValue[],
+ indexedDB?: IndexedDBDatabase[],
+};
+
+export type RecordHarOptions = {
+ content?: 'embed' | 'attach' | 'omit',
+ mode?: 'full' | 'minimal',
+ urlGlob?: string,
+ urlRegexSource?: string,
+ urlRegexFlags?: string,
+ harPath?: string,
+ resourcesDir?: string,
+};
// ----------- CDPSession -----------
export type CDPSessionInitializer = {};
@@ -4744,534 +4922,356 @@ export interface CDPSessionEvents {
'close': CDPSessionCloseEvent;
}
-// ----------- Android -----------
-export type AndroidInitializer = {};
-export interface AndroidEventTarget {
+// ----------- BindingCall -----------
+export type BindingCallInitializer = {
+ frame: FrameChannel,
+ name: string,
+ args: SerializedValue[],
+};
+export interface BindingCallEventTarget {
}
-export interface AndroidChannel extends AndroidEventTarget, Channel {
- _type_Android: boolean;
- devices(params: AndroidDevicesParams, progress?: Progress): Promise<AndroidDevicesResult>;
+export interface BindingCallChannel extends BindingCallEventTarget, Channel {
+ _type_BindingCall: boolean;
+ reject(params: BindingCallRejectParams, progress?: Progress): Promise<BindingCallRejectResult>;
+ resolve(params: BindingCallResolveParams, progress?: Progress): Promise<BindingCallResolveResult>;
}
-export type AndroidDevicesParams = {
- host?: string,
- port?: number,
- omitDriverInstall?: boolean,
-};
-export type AndroidDevicesOptions = {
- host?: string,
- port?: number,
- omitDriverInstall?: boolean,
-};
-export type AndroidDevicesResult = {
- devices: AndroidDeviceChannel[],
+export type BindingCallRejectParams = {
+ error: SerializedError,
};
+export type BindingCallRejectOptions = {
-export interface AndroidEvents {
-}
-
-// ----------- AndroidSocket -----------
-export type AndroidSocketInitializer = {};
-export interface AndroidSocketEventTarget {
- on(event: 'data', callback: (params: AndroidSocketDataEvent) => void): this;
- on(event: 'close', callback: (params: AndroidSocketCloseEvent) => void): this;
-}
-export interface AndroidSocketChannel extends AndroidSocketEventTarget, Channel {
- _type_AndroidSocket: boolean;
- write(params: AndroidSocketWriteParams, progress?: Progress): Promise<AndroidSocketWriteResult>;
- close(params?: AndroidSocketCloseParams, progress?: Progress): Promise<AndroidSocketCloseResult>;
-}
-export type AndroidSocketDataEvent = {
- data: Binary,
};
-export type AndroidSocketCloseEvent = {};
-export type AndroidSocketWriteParams = {
- data: Binary,
+export type BindingCallRejectResult = void;
+export type BindingCallResolveParams = {
+ result: SerializedArgument,
};
-export type AndroidSocketWriteOptions = {
+export type BindingCallResolveOptions = {
};
-export type AndroidSocketWriteResult = void;
-export type AndroidSocketCloseParams = {};
-export type AndroidSocketCloseOptions = {};
-export type AndroidSocketCloseResult = void;
+export type BindingCallResolveResult = void;
-export interface AndroidSocketEvents {
- 'data': AndroidSocketDataEvent;
- 'close': AndroidSocketCloseEvent;
+export interface BindingCallEvents {
}
-// ----------- AndroidDevice -----------
-export type AndroidDeviceInitializer = {
- model: string,
- serial: string,
-};
-export interface AndroidDeviceEventTarget {
- on(event: 'close', callback: (params: AndroidDeviceCloseEvent) => void): this;
- on(event: 'webViewAdded', callback: (params: AndroidDeviceWebViewAddedEvent) => void): this;
- on(event: 'webViewRemoved', callback: (params: AndroidDeviceWebViewRemovedEvent) => void): this;
+// ----------- Debugger -----------
+export type DebuggerInitializer = {};
+export interface DebuggerEventTarget {
+ on(event: 'pausedStateChanged', callback: (params: DebuggerPausedStateChangedEvent) => void): this;
}
-export interface AndroidDeviceChannel extends AndroidDeviceEventTarget, EventTargetChannel {
- _type_AndroidDevice: boolean;
- wait(params: AndroidDeviceWaitParams, progress?: Progress): Promise<AndroidDeviceWaitResult>;
- fill(params: AndroidDeviceFillParams, progress?: Progress): Promise<AndroidDeviceFillResult>;
- tap(params: AndroidDeviceTapParams, progress?: Progress): Promise<AndroidDeviceTapResult>;
- drag(params: AndroidDeviceDragParams, progress?: Progress): Promise<AndroidDeviceDragResult>;
- fling(params: AndroidDeviceFlingParams, progress?: Progress): Promise<AndroidDeviceFlingResult>;
- longTap(params: AndroidDeviceLongTapParams, progress?: Progress): Promise<AndroidDeviceLongTapResult>;
- pinchClose(params: AndroidDevicePinchCloseParams, progress?: Progress): Promise<AndroidDevicePinchCloseResult>;
- pinchOpen(params: AndroidDevicePinchOpenParams, progress?: Progress): Promise<AndroidDevicePinchOpenResult>;
- scroll(params: AndroidDeviceScrollParams, progress?: Progress): Promise<AndroidDeviceScrollResult>;
- swipe(params: AndroidDeviceSwipeParams, progress?: Progress): Promise<AndroidDeviceSwipeResult>;
- info(params: AndroidDeviceInfoParams, progress?: Progress): Promise<AndroidDeviceInfoResult>;
- screenshot(params?: AndroidDeviceScreenshotParams, progress?: Progress): Promise<AndroidDeviceScreenshotResult>;
- inputType(params: AndroidDeviceInputTypeParams, progress?: Progress): Promise<AndroidDeviceInputTypeResult>;
- inputPress(params: AndroidDeviceInputPressParams, progress?: Progress): Promise<AndroidDeviceInputPressResult>;
- inputTap(params: AndroidDeviceInputTapParams, progress?: Progress): Promise<AndroidDeviceInputTapResult>;
- inputSwipe(params: AndroidDeviceInputSwipeParams, progress?: Progress): Promise<AndroidDeviceInputSwipeResult>;
- inputDrag(params: AndroidDeviceInputDragParams, progress?: Progress): Promise<AndroidDeviceInputDragResult>;
- launchBrowser(params: AndroidDeviceLaunchBrowserParams, progress?: Progress): Promise<AndroidDeviceLaunchBrowserResult>;
- open(params: AndroidDeviceOpenParams, progress?: Progress): Promise<AndroidDeviceOpenResult>;
- shell(params: AndroidDeviceShellParams, progress?: Progress): Promise<AndroidDeviceShellResult>;
- installApk(params: AndroidDeviceInstallApkParams, progress?: Progress): Promise<AndroidDeviceInstallApkResult>;
- push(params: AndroidDevicePushParams, progress?: Progress): Promise<AndroidDevicePushResult>;
- connectToWebView(params: AndroidDeviceConnectToWebViewParams, progress?: Progress): Promise<AndroidDeviceConnectToWebViewResult>;
- close(params?: AndroidDeviceCloseParams, progress?: Progress): Promise<AndroidDeviceCloseResult>;
+export interface DebuggerChannel extends DebuggerEventTarget, EventTargetChannel {
+ _type_Debugger: boolean;
+ requestPause(params?: DebuggerRequestPauseParams, progress?: Progress): Promise<DebuggerRequestPauseResult>;
+ resume(params?: DebuggerResumeParams, progress?: Progress): Promise<DebuggerResumeResult>;
+ next(params?: DebuggerNextParams, progress?: Progress): Promise<DebuggerNextResult>;
+ runTo(params: DebuggerRunToParams, progress?: Progress): Promise<DebuggerRunToResult>;
}
-export type AndroidDeviceCloseEvent = {};
-export type AndroidDeviceWebViewAddedEvent = {
- webView: AndroidWebView,
-};
-export type AndroidDeviceWebViewRemovedEvent = {
- socketName: string,
-};
-export type AndroidDeviceWaitParams = {
- androidSelector: AndroidSelector,
- state?: 'gone',
- timeout: number,
-};
-export type AndroidDeviceWaitOptions = {
- state?: 'gone',
-};
-export type AndroidDeviceWaitResult = void;
-export type AndroidDeviceFillParams = {
- androidSelector: AndroidSelector,
- text: string,
- timeout: number,
-};
-export type AndroidDeviceFillOptions = {
-
-};
-export type AndroidDeviceFillResult = void;
-export type AndroidDeviceTapParams = {
- androidSelector: AndroidSelector,
- duration?: number,
- timeout: number,
-};
-export type AndroidDeviceTapOptions = {
- duration?: number,
-};
-export type AndroidDeviceTapResult = void;
-export type AndroidDeviceDragParams = {
- androidSelector: AndroidSelector,
- dest: Point,
- speed?: number,
- timeout: number,
-};
-export type AndroidDeviceDragOptions = {
- speed?: number,
-};
-export type AndroidDeviceDragResult = void;
-export type AndroidDeviceFlingParams = {
- androidSelector: AndroidSelector,
- direction: 'up' | 'down' | 'left' | 'right',
- speed?: number,
- timeout: number,
-};
-export type AndroidDeviceFlingOptions = {
- speed?: number,
-};
-export type AndroidDeviceFlingResult = void;
-export type AndroidDeviceLongTapParams = {
- androidSelector: AndroidSelector,
- timeout: number,
-};
-export type AndroidDeviceLongTapOptions = {
-
-};
-export type AndroidDeviceLongTapResult = void;
-export type AndroidDevicePinchCloseParams = {
- androidSelector: AndroidSelector,
- percent: number,
- speed?: number,
- timeout: number,
-};
-export type AndroidDevicePinchCloseOptions = {
- speed?: number,
-};
-export type AndroidDevicePinchCloseResult = void;
-export type AndroidDevicePinchOpenParams = {
- androidSelector: AndroidSelector,
- percent: number,
- speed?: number,
- timeout: number,
-};
-export type AndroidDevicePinchOpenOptions = {
- speed?: number,
-};
-export type AndroidDevicePinchOpenResult = void;
-export type AndroidDeviceScrollParams = {
- androidSelector: AndroidSelector,
- direction: 'up' | 'down' | 'left' | 'right',
- percent: number,
- speed?: number,
- timeout: number,
-};
-export type AndroidDeviceScrollOptions = {
- speed?: number,
-};
-export type AndroidDeviceScrollResult = void;
-export type AndroidDeviceSwipeParams = {
- androidSelector: AndroidSelector,
- direction: 'up' | 'down' | 'left' | 'right',
- percent: number,
- speed?: number,
- timeout: number,
-};
-export type AndroidDeviceSwipeOptions = {
- speed?: number,
-};
-export type AndroidDeviceSwipeResult = void;
-export type AndroidDeviceInfoParams = {
- androidSelector: AndroidSelector,
-};
-export type AndroidDeviceInfoOptions = {
-
-};
-export type AndroidDeviceInfoResult = {
- info: AndroidElementInfo,
-};
-export type AndroidDeviceScreenshotParams = {};
-export type AndroidDeviceScreenshotOptions = {};
-export type AndroidDeviceScreenshotResult = {
- binary: Binary,
+export type DebuggerPausedStateChangedEvent = {
+ pausedDetails?: {
+ location: {
+ file: string,
+ line?: number,
+ column?: number,
+ },
+ title: string,
+ stack?: string,
+ },
};
-export type AndroidDeviceInputTypeParams = {
- text: string,
+export type DebuggerRequestPauseParams = {};
+export type DebuggerRequestPauseOptions = {};
+export type DebuggerRequestPauseResult = void;
+export type DebuggerResumeParams = {};
+export type DebuggerResumeOptions = {};
+export type DebuggerResumeResult = void;
+export type DebuggerNextParams = {};
+export type DebuggerNextOptions = {};
+export type DebuggerNextResult = void;
+export type DebuggerRunToParams = {
+ location: {
+ file: string,
+ line?: number,
+ column?: number,
+ },
};
-export type AndroidDeviceInputTypeOptions = {
+export type DebuggerRunToOptions = {
};
-export type AndroidDeviceInputTypeResult = void;
-export type AndroidDeviceInputPressParams = {
- key: string,
-};
-export type AndroidDeviceInputPressOptions = {
+export type DebuggerRunToResult = void;
-};
-export type AndroidDeviceInputPressResult = void;
-export type AndroidDeviceInputTapParams = {
- point: Point,
-};
-export type AndroidDeviceInputTapOptions = {
+export interface DebuggerEvents {
+ 'pausedStateChanged': DebuggerPausedStateChangedEvent;
+}
+// ----------- Dialog -----------
+export type DialogInitializer = {
+ page?: PageChannel,
+ type: string,
+ message: string,
+ defaultValue: string,
};
-export type AndroidDeviceInputTapResult = void;
-export type AndroidDeviceInputSwipeParams = {
- segments: Point[],
- steps: number,
-};
-export type AndroidDeviceInputSwipeOptions = {
-
+export interface DialogEventTarget {
+}
+export interface DialogChannel extends DialogEventTarget, Channel {
+ _type_Dialog: boolean;
+ accept(params: DialogAcceptParams, progress?: Progress): Promise<DialogAcceptResult>;
+ dismiss(params?: DialogDismissParams, progress?: Progress): Promise<DialogDismissResult>;
+}
+export type DialogAcceptParams = {
+ promptText?: string,
};
-export type AndroidDeviceInputSwipeResult = void;
-export type AndroidDeviceInputDragParams = {
- from: Point,
- to: Point,
- steps: number,
+export type DialogAcceptOptions = {
+ promptText?: string,
};
-export type AndroidDeviceInputDragOptions = {
+export type DialogAcceptResult = void;
+export type DialogDismissParams = {};
+export type DialogDismissOptions = {};
+export type DialogDismissResult = void;
-};
-export type AndroidDeviceInputDragResult = void;
-export type AndroidDeviceLaunchBrowserParams = {
- noDefaultViewport?: boolean,
- viewport?: {
- width: number,
- height: number,
- },
- screen?: {
- width: number,
- height: number,
- },
- ignoreHTTPSErrors?: boolean,
- clientCertificates?: {
- origin: string,
- cert?: Binary,
- key?: Binary,
- passphrase?: string,
- pfx?: Binary,
- }[],
- javaScriptEnabled?: boolean,
- bypassCSP?: boolean,
- userAgent?: string,
- locale?: string,
- timezoneId?: string,
- geolocation?: {
- longitude: number,
- latitude: number,
- accuracy?: number,
- },
- permissions?: string[],
- extraHTTPHeaders?: NameValue[],
- offline?: boolean,
- httpCredentials?: {
- username: string,
- password: string,
- origin?: string,
- send?: 'always' | 'unauthorized',
- },
- deviceScaleFactor?: number,
- isMobile?: boolean,
- hasTouch?: boolean,
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
- contrast?: 'no-preference' | 'more' | 'no-override',
- baseURL?: string,
- recordVideo?: {
- dir?: string,
- size?: {
- width: number,
- height: number,
- },
- showActions?: {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
- },
- },
- strictSelectors?: boolean,
- serviceWorkers?: 'allow' | 'block',
- selectorEngines?: SelectorEngine[],
- testIdAttributeName?: string,
- pkg?: string,
- args?: string[],
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
+export interface DialogEvents {
+}
+
+export type SerializedValue = {
+ n?: number,
+ b?: boolean,
+ s?: string,
+ v?: 'null' | 'undefined' | 'NaN' | 'Infinity' | '-Infinity' | '-0',
+ d?: string,
+ u?: string,
+ bi?: string,
+ ta?: {
+ b: Binary,
+ k: 'i8' | 'ui8' | 'ui8c' | 'i16' | 'ui16' | 'i32' | 'ui32' | 'f32' | 'f64' | 'bi64' | 'bui64',
},
-};
-export type AndroidDeviceLaunchBrowserOptions = {
- noDefaultViewport?: boolean,
- viewport?: {
- width: number,
- height: number,
+ e?: {
+ m: string,
+ n: string,
+ s: string,
},
- screen?: {
- width: number,
- height: number,
+ r?: {
+ p: string,
+ f: string,
},
- ignoreHTTPSErrors?: boolean,
- clientCertificates?: {
- origin: string,
- cert?: Binary,
- key?: Binary,
- passphrase?: string,
- pfx?: Binary,
+ a?: SerializedValue[],
+ o?: {
+ k: string,
+ v: SerializedValue,
}[],
- javaScriptEnabled?: boolean,
- bypassCSP?: boolean,
- userAgent?: string,
- locale?: string,
- timezoneId?: string,
- geolocation?: {
- longitude: number,
- latitude: number,
- accuracy?: number,
- },
- permissions?: string[],
- extraHTTPHeaders?: NameValue[],
- offline?: boolean,
- httpCredentials?: {
- username: string,
- password: string,
- origin?: string,
- send?: 'always' | 'unauthorized',
- },
- deviceScaleFactor?: number,
- isMobile?: boolean,
- hasTouch?: boolean,
- colorScheme?: 'dark' | 'light' | 'no-preference' | 'no-override',
- reducedMotion?: 'reduce' | 'no-preference' | 'no-override',
- forcedColors?: 'active' | 'none' | 'no-override',
- acceptDownloads?: 'accept' | 'deny' | 'internal-browser-default',
- contrast?: 'no-preference' | 'more' | 'no-override',
- baseURL?: string,
- recordVideo?: {
- dir?: string,
- size?: {
- width: number,
- height: number,
- },
- showActions?: {
- duration?: number,
- position?: 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right',
- fontSize?: number,
- },
- },
- strictSelectors?: boolean,
- serviceWorkers?: 'allow' | 'block',
- selectorEngines?: SelectorEngine[],
- testIdAttributeName?: string,
- pkg?: string,
- args?: string[],
- proxy?: {
- server: string,
- bypass?: string,
- username?: string,
- password?: string,
+ h?: number,
+ id?: number,
+ ref?: number,
+};
+
+export type SerializedArgument = {
+ value: SerializedValue,
+ handles: Channel[],
+};
+
+export type SerializedError = {
+ error?: {
+ message: string,
+ name: string,
+ stack?: string,
},
+ value?: SerializedValue,
};
-export type AndroidDeviceLaunchBrowserResult = {
- context: BrowserContextChannel,
+
+export type StackFrame = {
+ file: string,
+ line: number,
+ column: number,
+ function?: string,
+};
+
+export type Point = {
+ x: number,
+ y: number,
+};
+
+export type Rect = {
+ x: number,
+ y: number,
+ width: number,
+ height: number,
+};
+
+export type URLPattern = {
+ hash: string,
+ hostname: string,
+ password: string,
+ pathname: string,
+ port: string,
+ protocol: string,
+ search: string,
+ username: string,
};
-export type AndroidDeviceOpenParams = {
- command: string,
+
+export type NameValue = {
+ name: string,
+ value: string,
};
-export type AndroidDeviceOpenOptions = {
+// ----------- Tracing -----------
+export type TracingInitializer = {};
+export interface TracingEventTarget {
+}
+export interface TracingChannel extends TracingEventTarget, Channel {
+ _type_Tracing: boolean;
+ tracingStart(params: TracingTracingStartParams, progress?: Progress): Promise<TracingTracingStartResult>;
+ tracingStartChunk(params: TracingTracingStartChunkParams, progress?: Progress): Promise<TracingTracingStartChunkResult>;
+ tracingGroup(params: TracingTracingGroupParams, progress?: Progress): Promise<TracingTracingGroupResult>;
+ tracingGroupEnd(params?: TracingTracingGroupEndParams, progress?: Progress): Promise<TracingTracingGroupEndResult>;
+ tracingStopChunk(params: TracingTracingStopChunkParams, progress?: Progress): Promise<TracingTracingStopChunkResult>;
+ tracingStop(params?: TracingTracingStopParams, progress?: Progress): Promise<TracingTracingStopResult>;
+ harStart(params: TracingHarStartParams, progress?: Progress): Promise<TracingHarStartResult>;
+ harExport(params: TracingHarExportParams, progress?: Progress): Promise<TracingHarExportResult>;
+}
+export type TracingTracingStartParams = {
+ name?: string,
+ snapshots?: boolean,
+ screenshots?: boolean,
+ live?: boolean,
};
-export type AndroidDeviceOpenResult = {
- socket: AndroidSocketChannel,
+export type TracingTracingStartOptions = {
+ name?: string,
+ snapshots?: boolean,
+ screenshots?: boolean,
+ live?: boolean,
};
-export type AndroidDeviceShellParams = {
- command: string,
+export type TracingTracingStartResult = void;
+export type TracingTracingStartChunkParams = {
+ name?: string,
+ title?: string,
};
-export type AndroidDeviceShellOptions = {
-
+export type TracingTracingStartChunkOptions = {
+ name?: string,
+ title?: string,
};
-export type AndroidDeviceShellResult = {
- result: Binary,
+export type TracingTracingStartChunkResult = {
+ traceName: string,
};
-export type AndroidDeviceInstallApkParams = {
- file: Binary,
- args?: string[],
+export type TracingTracingGroupParams = {
+ name: string,
+ location?: {
+ file: string,
+ line?: number,
+ column?: number,
+ },
};
-export type AndroidDeviceInstallApkOptions = {
- args?: string[],
+export type TracingTracingGroupOptions = {
+ location?: {
+ file: string,
+ line?: number,
+ column?: number,
+ },
};
-export type AndroidDeviceInstallApkResult = void;
-export type AndroidDevicePushParams = {
- file: Binary,
- path: string,
- mode?: number,
+export type TracingTracingGroupResult = void;
+export type TracingTracingGroupEndParams = {};
+export type TracingTracingGroupEndOptions = {};
+export type TracingTracingGroupEndResult = void;
+export type TracingTracingStopChunkParams = {
+ mode: 'archive' | 'discard' | 'entries',
};
-export type AndroidDevicePushOptions = {
- mode?: number,
+export type TracingTracingStopChunkOptions = {
+
};
-export type AndroidDevicePushResult = void;
-export type AndroidDeviceConnectToWebViewParams = {
- socketName: string,
+export type TracingTracingStopChunkResult = {
+ artifact?: ArtifactChannel,
+ entries?: NameValue[],
};
-export type AndroidDeviceConnectToWebViewOptions = {
-
+export type TracingTracingStopParams = {};
+export type TracingTracingStopOptions = {};
+export type TracingTracingStopResult = void;
+export type TracingHarStartParams = {
+ page?: PageChannel,
+ options: RecordHarOptions,
};
-export type AndroidDeviceConnectToWebViewResult = {
- context: BrowserContextChannel,
+export type TracingHarStartOptions = {
+ page?: PageChannel,
};
-export type AndroidDeviceCloseParams = {};
-export type AndroidDeviceCloseOptions = {};
-export type AndroidDeviceCloseResult = void;
-
-export interface AndroidDeviceEvents {
- 'close': AndroidDeviceCloseEvent;
- 'webViewAdded': AndroidDeviceWebViewAddedEvent;
- 'webViewRemoved': AndroidDeviceWebViewRemovedEvent;
-}
-
-export type AndroidWebView = {
- pid: number,
- pkg: string,
- socketName: string,
+export type TracingHarStartResult = {
+ harId: string,
};
-
-export type AndroidSelector = {
- checkable?: boolean,
- checked?: boolean,
- clazz?: string,
- clickable?: boolean,
- depth?: number,
- desc?: string,
- enabled?: boolean,
- focusable?: boolean,
- focused?: boolean,
- hasChild?: {
- androidSelector: AndroidSelector,
- },
- hasDescendant?: {
- androidSelector: AndroidSelector,
- maxDepth?: number,
- },
- longClickable?: boolean,
- pkg?: string,
- res?: string,
- scrollable?: boolean,
- selected?: boolean,
- text?: string,
+export type TracingHarExportParams = {
+ harId?: string,
+ mode: 'archive' | 'entries',
};
-
-export type AndroidElementInfo = {
- children?: AndroidElementInfo[],
- clazz: string,
- desc: string,
- res: string,
- pkg: string,
- text: string,
- bounds: Rect,
- checkable: boolean,
- checked: boolean,
- clickable: boolean,
- enabled: boolean,
- focusable: boolean,
- focused: boolean,
- longClickable: boolean,
- scrollable: boolean,
- selected: boolean,
+export type TracingHarExportOptions = {
+ harId?: string,
+};
+export type TracingHarExportResult = {
+ artifact?: ArtifactChannel,
+ entries?: NameValue[],
};
-// ----------- JsonPipe -----------
-export type JsonPipeInitializer = {};
-export interface JsonPipeEventTarget {
- on(event: 'message', callback: (params: JsonPipeMessageEvent) => void): this;
- on(event: 'closed', callback: (params: JsonPipeClosedEvent) => void): this;
+export interface TracingEvents {
}
-export interface JsonPipeChannel extends JsonPipeEventTarget, Channel {
- _type_JsonPipe: boolean;
- send(params: JsonPipeSendParams, progress?: Progress): Promise<JsonPipeSendResult>;
- close(params?: JsonPipeCloseParams, progress?: Progress): Promise<JsonPipeCloseResult>;
+
+// ----------- Worker -----------
+export type WorkerInitializer = {
+ url: string,
+};
+export interface WorkerEventTarget {
+ on(event: 'console', callback: (params: WorkerConsoleEvent) => void): this;
+ on(event: 'close', callback: (params: WorkerCloseEvent) => void): this;
}
-export type JsonPipeMessageEvent = {
- message: any,
+export interface WorkerChannel extends WorkerEventTarget, EventTargetChannel {
+ _type_Worker: boolean;
+ disconnect(params: WorkerDisconnectParams, progress?: Progress): Promise<WorkerDisconnectResult>;
+ evaluateExpression(params: WorkerEvaluateExpressionParams, progress?: Progress): Promise<WorkerEvaluateExpressionResult>;
+ evaluateExpressionHandle(params: WorkerEvaluateExpressionHandleParams, progress?: Progress): Promise<WorkerEvaluateExpressionHandleResult>;
+ updateSubscription(params: WorkerUpdateSubscriptionParams, progress?: Progress): Promise<WorkerUpdateSubscriptionResult>;
+}
+export type WorkerConsoleEvent = {
+ type: string,
+ text: string,
+ args: JSHandleChannel[],
+ location: {
+ url: string,
+ lineNumber: number,
+ columnNumber: number,
+ },
+ timestamp: number,
};
-export type JsonPipeClosedEvent = {
+export type WorkerCloseEvent = {};
+export type WorkerDisconnectParams = {
reason?: string,
};
-export type JsonPipeSendParams = {
- message: any,
+export type WorkerDisconnectOptions = {
+ reason?: string,
};
-export type JsonPipeSendOptions = {
+export type WorkerDisconnectResult = void;
+export type WorkerEvaluateExpressionParams = {
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+};
+export type WorkerEvaluateExpressionOptions = {
+ isFunction?: boolean,
+};
+export type WorkerEvaluateExpressionResult = {
+ value: SerializedValue,
+};
+export type WorkerEvaluateExpressionHandleParams = {
+ expression: string,
+ isFunction?: boolean,
+ arg: SerializedArgument,
+};
+export type WorkerEvaluateExpressionHandleOptions = {
+ isFunction?: boolean,
+};
+export type WorkerEvaluateExpressionHandleResult = {
+ handle: JSHandleChannel,
+};
+export type WorkerUpdateSubscriptionParams = {
+ event: 'console',
+ enabled: boolean,
+};
+export type WorkerUpdateSubscriptionOptions = {
};
-export type JsonPipeSendResult = void;
-export type JsonPipeCloseParams = {};
-export type JsonPipeCloseOptions = {};
-export type JsonPipeCloseResult = void;
+export type WorkerUpdateSubscriptionResult = void;
-export interface JsonPipeEvents {
- 'message': JsonPipeMessageEvent;
- 'closed': JsonPipeClosedEvent;
+export interface WorkerEvents {
+ 'console': WorkerConsoleEvent;
+ 'close': WorkerCloseEvent;
}
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
deleted file mode 100644
index fe16fe1e55..0000000000
--- a/packages/protocol/src/protocol.yml
+++ /dev/null
@@ -1,4545 +0,0 @@
-# Copyright (c) Microsoft Corporation.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-StackFrame:
- type: object
- properties:
- file: string
- line: int
- column: int
- function: string?
-
-# This object can be send with any rpc call in the "metadata" field.
-
-Metadata:
- type: object
- properties:
- location:
- type: object?
- properties:
- file: string
- line: int?
- column: int?
- title: string?
- internal: boolean?
- # Test runner step id.
- stepId: string?
-
-ClientSideCallMetadata:
- type: object
- properties:
- id: int
- stack:
- type: array?
- items: StackFrame
-
-Point:
- type: object
- properties:
- x: float
- y: float
-
-
-Rect:
- type: object
- properties:
- x: float
- y: float
- width: float
- height: float
-
-ShowActionsOptions:
- type: mixin
- properties:
- duration: float?
- position:
- type: enum?
- literals:
- - top-left
- - top
- - top-right
- - bottom-left
- - bottom
- - bottom-right
- fontSize: int?
-
-
-SerializedValue:
- type: object
- # Exactly one of the properties must be present.
- properties:
- n: float?
- b: boolean?
- s: string?
- v:
- type: enum?
- literals:
- - null
- - undefined
- - NaN
- - Infinity
- - -Infinity
- - "-0"
- # String representation of the Date.
- d: string?
- # String representation of the URL.
- u: string?
- # String representation of BigInt.
- bi: string?
- # Typed array.
- ta:
- type: object?
- properties:
- b: binary
- k:
- type: enum
- literals:
- - i8
- - ui8
- - ui8c
- - i16
- - ui16
- - i32
- - ui32
- - f32
- - f64
- - bi64
- - bui64
- # Serialized Error object.
- e:
- type: object?
- properties:
- m: string
- n: string
- s: string
- # Regular expression pattern and flags.
- r:
- type: object?
- properties:
- p: string
- f: string
- a:
- type: array?
- items: SerializedValue
- # Object with keys and values.
- o:
- type: array?
- items:
- type: object
- properties:
- k: string
- v: SerializedValue
- # An index in the handles array from SerializedArgument.
- h: int?
- # Index of the object in value-type for circular reference resolution.
- id: int?
- # Ref to the object in value-type for circular reference resolution.
- ref: int?
-
-
-# Represents a value with handle references.
-SerializedArgument:
- type: object
- properties:
- value: SerializedValue
- handles:
- type: array
- items: Channel
-
-
-ExpectedTextValue:
- type: object
- properties:
- string: string?
- regexSource: string?
- regexFlags: string?
- matchSubstring: boolean?
- ignoreCase: boolean?
- normalizeWhiteSpace: boolean?
-
-
-SelectorEngine:
- type: object
- properties:
- name: string
- source: string
- contentScript: boolean?
-
-URLPattern:
- type: object
- properties:
- hash: string
- hostname: string
- password: string
- pathname: string
- port: string
- protocol: string
- search: string
- username: string
-
-SetNetworkCookie:
- type: object
- properties:
- name: string
- value: string
- url: string?
- domain: string?
- path: string?
- expires: float?
- httpOnly: boolean?
- secure: boolean?
- sameSite:
- type: enum?
- literals:
- - Strict
- - Lax
- - None
- partitionKey: string?
- _crHasCrossSiteAncestor: boolean?
-
-
-NetworkCookie:
- type: object
- properties:
- name: string
- value: string
- domain: string
- path: string
- expires: float
- httpOnly: boolean
- secure: boolean
- sameSite:
- type: enum
- literals:
- - Strict
- - Lax
- - None
- partitionKey: string?
- _crHasCrossSiteAncestor: boolean?
-
-
-NameValue:
- type: object
- properties:
- name: string
- value: string
-
-IndexedDBDatabase:
- type: object
- properties:
- name: string
- version: int
- stores:
- type: array
- items:
- type: object
- properties:
- name: string
- autoIncrement: boolean
- keyPath: string?
- keyPathArray:
- type: array?
- items: string
- records:
- type: array
- items:
- type: object
- properties:
- key: json?
- keyEncoded: json?
- value: json?
- valueEncoded: json?
- indexes:
- type: array
- items:
- type: object
- properties:
- name: string
- keyPath: string?
- keyPathArray:
- type: array?
- items: string
- multiEntry: boolean
- unique: boolean
-
-SetOriginStorage:
- type: object
- properties:
- origin: string
- localStorage:
- type: array
- items: NameValue
- indexedDB:
- type: array?
- items: IndexedDBDatabase
-
-OriginStorage:
- type: object
- properties:
- origin: string
- localStorage:
- type: array
- items: NameValue
- indexedDB:
- type: array?
- items: IndexedDBDatabase
-
-SerializedError:
- type: object
- properties:
- error:
- type: object?
- properties:
- message: string
- name: string
- stack: string?
- value: SerializedValue?
-
-
-RecordHarOptions:
- type: object
- properties:
- content:
- type: enum?
- literals:
- - embed
- - attach
- - omit
- mode:
- type: enum?
- literals:
- - full
- - minimal
- urlGlob: string?
- urlRegexSource: string?
- urlRegexFlags: string?
- harPath: string?
- resourcesDir: string?
-
-
-FormField:
- type: object
- properties:
- name: string
- value: string?
- file:
- type: object?
- properties:
- name: string
- mimeType: string?
- buffer: binary
-
-SDKLanguage:
- type: enum
- literals:
- - javascript
- - python
- - java
- - csharp
-
-APIRequestContext:
- type: interface
-
- initializer:
- tracing: Tracing
-
- commands:
-
- fetch:
- title: '{method} "{url}"'
- parameters:
- url: string
- encodedParams: string?
- params:
- type: array?
- items: NameValue
- method: string?
- headers:
- type: array?
- items: NameValue
- postData: binary?
- jsonData: string?
- formData:
- type: array?
- items: NameValue
- multipartData:
- type: array?
- items: FormField
- timeout: float
- failOnStatusCode: boolean?
- ignoreHTTPSErrors: boolean?
- maxRedirects: int?
- maxRetries: int?
- returns:
- response: APIResponse
-
- fetchResponseBody:
- title: Get response body
- group: getter
- parameters:
- fetchUid: string
- returns:
- binary: binary?
-
- fetchLog:
- internal: true
- parameters:
- fetchUid: string
- returns:
- log:
- type: array
- items: string
-
- storageState:
- title: Get storage state
- group: configuration
- parameters:
- indexedDB: boolean?
- returns:
- cookies:
- type: array
- items: NetworkCookie
- origins:
- type: array
- items: OriginStorage
-
- disposeAPIResponse:
- internal: true
- parameters:
- fetchUid: string
-
- dispose:
- internal: true
- parameters:
- reason: string?
-
-
-APIResponse:
- type: object
- properties:
- fetchUid: string
- url: string
- status: int
- statusText: string
- headers:
- type: array
- items: NameValue
-
-
-LifecycleEvent:
- type: enum
- literals:
- - load
- - domcontentloaded
- - networkidle
- - commit
-
-ConsoleMessagesFilter:
- type: enum
- literals:
- - all
- - since-navigation
-
-CommonScreenshotOptions:
- type: mixin
- properties:
- omitBackground: boolean?
- caret:
- type: enum?
- literals:
- - hide
- - initial
- animations:
- type: enum?
- literals:
- - disabled
- - allow
- scale:
- type: enum?
- literals:
- - css
- - device
- mask:
- type: array?
- items:
- type: object
- properties:
- frame: Frame
- selector: string
- maskColor: string?
- style: string?
-
-LaunchOptions:
- type: mixin
- properties:
- channel: string?
- executablePath: string?
- args:
- type: array?
- items: string
- ignoreAllDefaultArgs: boolean?
- ignoreDefaultArgs:
- type: array?
- items: string
- handleSIGINT: boolean?
- handleSIGTERM: boolean?
- handleSIGHUP: boolean?
- timeout: float
- env:
- type: array?
- items: NameValue
- headless: boolean?
- proxy:
- type: object?
- properties:
- server: string
- bypass: string?
- username: string?
- password: string?
- downloadsPath: string?
- tracesDir: string?
- artifactsDir: string?
- chromiumSandbox: boolean?
- firefoxUserPrefs: json?
- cdpPort: int?
-
-
-ContextOptions:
- type: mixin
- properties:
- noDefaultViewport: boolean?
- viewport:
- type: object?
- properties:
- width: int
- height: int
- screen:
- type: object?
- properties:
- width: int
- height: int
- ignoreHTTPSErrors: boolean?
- clientCertificates:
- type: array?
- items:
- type: object
- properties:
- origin: string
- cert: binary?
- key: binary?
- passphrase: string?
- pfx: binary?
- javaScriptEnabled: boolean?
- bypassCSP: boolean?
- userAgent: string?
- locale: string?
- timezoneId: string?
- geolocation:
- type: object?
- properties:
- longitude: float
- latitude: float
- accuracy: float?
- permissions:
- type: array?
- items: string
- extraHTTPHeaders:
- type: array?
- items: NameValue
- offline: boolean?
- httpCredentials:
- type: object?
- properties:
- username: string
- password: string
- origin: string?
- send:
- type: enum?
- literals:
- - always
- - unauthorized
- deviceScaleFactor: float?
- isMobile: boolean?
- hasTouch: boolean?
- colorScheme:
- type: enum?
- literals:
- - dark
- - light
- - no-preference
- - no-override
- reducedMotion:
- type: enum?
- literals:
- - reduce
- - no-preference
- - no-override
- forcedColors:
- type: enum?
- literals:
- - active
- - none
- - no-override
- acceptDownloads:
- type: enum?
- literals:
- - accept
- - deny
- - internal-browser-default
- contrast:
- type: enum?
- literals:
- - no-preference
- - more
- - no-override
- baseURL: string?
- recordVideo:
- type: object?
- properties:
- dir: string?
- size:
- type: object?
- properties:
- width: int
- height: int
- showActions:
- type: object?
- properties:
- $mixin: ShowActionsOptions
- strictSelectors: boolean?
- serviceWorkers:
- type: enum?
- literals:
- - allow
- - block
- selectorEngines:
- type: array?
- items: SelectorEngine
- testIdAttributeName: string?
-
-LocalUtils:
- type: interface
-
- initializer:
- deviceDescriptors:
- type: array
- items:
- type: object
- properties:
- name: string
- descriptor:
- type: object
- properties:
- userAgent: string
- viewport:
- type: object
- properties:
- width: int
- height: int
- screen:
- type: object?
- properties:
- width: int
- height: int
- deviceScaleFactor: float
- isMobile: boolean
- hasTouch: boolean
- defaultBrowserType:
- type: enum
- literals:
- - chromium
- - firefox
- - webkit
-
- commands:
-
- zip:
- internal: true
- parameters:
- zipFile: string
- entries:
- type: array
- items: NameValue
- stacksId: string?
- mode:
- type: enum
- literals:
- - write
- - append
- includeSources: boolean
- additionalSources:
- type: array?
- items: string
-
- harOpen:
- internal: true
- parameters:
- file: string
- returns:
- harId: string?
- error: string?
-
- harLookup:
- internal: true
- parameters:
- harId: string
- url: string
- method: string
- headers:
- type: array
- items: NameValue
- postData: binary?
- isNavigationRequest: boolean
- returns:
- action:
- type: enum
- literals:
- - error
- - redirect
- - fulfill
- - noentry
- message: string?
- redirectURL: string?
- status: int?
- headers:
- type: array?
- items: NameValue
- body: binary?
-
- harClose:
- internal: true
- parameters:
- harId: string
-
- harUnzip:
- internal: true
- parameters:
- zipFile: string
- harFile: string
- resourcesDir: string?
-
- connect:
- internal: true
- parameters:
- endpoint: string
- headers: json?
- exposeNetwork: string?
- slowMo: float?
- timeout: float
- socksProxyRedirectPortForTest: int?
- returns:
- pipe: JsonPipe
- headers:
- type: array
- items: NameValue
-
- tracingStarted:
- internal: true
- parameters:
- tracesDir: string?
- traceName: string
- live: boolean?
- returns:
- stacksId: string
-
- addStackToTracingNoReply:
- internal: true
- parameters:
- callData: ClientSideCallMetadata
-
- traceDiscarded:
- internal: true
- parameters:
- stacksId: string
-
- globToRegex:
- internal: true
- parameters:
- glob: string
- baseURL: string?
- webSocketUrl: boolean?
- returns:
- regex: string
-
-Root:
- type: interface
-
- commands:
-
- initialize:
- internal: true
- parameters:
- sdkLanguage: SDKLanguage
- returns:
- playwright: Playwright
-
-Playwright:
- type: interface
-
- initializer:
- chromium: BrowserType
- firefox: BrowserType
- webkit: BrowserType
- android: Android
- utils: LocalUtils?
- # Only present when connecting remotely via BrowserType.connect() method.
- preLaunchedBrowser: Browser?
- # Only present when connecting remotely via Android.connect() method.
- preConnectedAndroidDevice: AndroidDevice?
- # Only present when socks proxy is supported.
- socksSupport: SocksSupport?
-
- commands:
- newRequest:
- title: Create request context
- parameters:
- baseURL: string?
- userAgent: string?
- ignoreHTTPSErrors: boolean?
- extraHTTPHeaders:
- type: array?
- items: NameValue
- failOnStatusCode: boolean?
- clientCertificates:
- type: array?
- items:
- type: object
- properties:
- origin: string
- cert: binary?
- key: binary?
- passphrase: string?
- pfx: binary?
- maxRedirects: int?
- httpCredentials:
- type: object?
- properties:
- username: string
- password: string
- origin: string?
- send:
- type: enum?
- literals:
- - always
- - unauthorized
- proxy:
- type: object?
- properties:
- server: string
- bypass: string?
- username: string?
- password: string?
- storageState:
- type: object?
- properties:
- cookies:
- type: array?
- items: NetworkCookie
- origins:
- type: array?
- items: SetOriginStorage
- tracesDir: string?
-
- returns:
- request: APIRequestContext
-
-RecorderSource:
- type: object
- properties:
- isRecorded: boolean
- id: string
- label: string
- text: string
- language: string
- highlight:
- type: array
- items:
- type: object
- properties:
- line: int
- type: string
- revealLine: int?
- group: string?
-
-DebugController:
- type: interface
-
- commands:
- initialize:
- internal: true
- parameters:
- codegenId: string
- sdkLanguage: SDKLanguage
-
- setReportStateChanged:
- internal: true
- parameters:
- enabled: boolean
-
- setRecorderMode:
- internal: true
- parameters:
- mode:
- type: enum
- literals:
- - inspecting
- - recording
- - none
- testIdAttributeName: string?
- generateAutoExpect: boolean?
-
- highlight:
- internal: true
- parameters:
- selector: string?
- ariaTemplate: string?
-
- hideHighlight:
- internal: true
-
- resume:
- internal: true
-
- kill:
- internal: true
-
- events:
- inspectRequested:
- parameters:
- selector: string
- locator: string
- ariaSnapshot: string
-
- setModeRequested:
- parameters:
- mode: string
-
- stateChanged:
- parameters:
- pageCount: int
-
- sourceChanged:
- parameters:
- text: string
- header: string?
- footer: string?
- actions:
- type: array?
- items: string
-
- paused:
- parameters:
- paused: boolean
-
-SocksSupport:
- type: interface
-
- commands:
- socksConnected:
- internal: true
- parameters:
- uid: string
- host: string
- port: int
-
- socksFailed:
- internal: true
- parameters:
- uid: string
- errorCode: string
-
- socksData:
- internal: true
- parameters:
- uid: string
- data: binary
-
- socksError:
- internal: true
- parameters:
- uid: string
- error: string
-
- socksEnd:
- internal: true
- parameters:
- uid: string
-
- events:
- socksRequested:
- parameters:
- uid: string
- host: string
- port: int
-
- socksData:
- parameters:
- uid: string
- data: binary
-
- socksClosed:
- parameters:
- uid: string
-
-
-BrowserType:
- type: interface
-
- initializer:
- executablePath: string
- name: string
-
- commands:
-
- launch:
- title: Launch browser
- parameters:
- $mixin: LaunchOptions
- slowMo: float?
- returns:
- browser: Browser
-
- launchPersistentContext:
- title: Launch persistent context
- parameters:
- $mixin1: LaunchOptions
- $mixin2: ContextOptions
- userDataDir: string
- slowMo: float?
- returns:
- browser: Browser
- context: BrowserContext
-
- connectOverCDP:
- title: Connect over CDP
- parameters:
- endpointURL: string
- headers:
- type: array?
- items: NameValue
- slowMo: float?
- timeout: float
- isLocal: boolean?
- noDefaults: boolean?
- returns:
- browser: Browser
- defaultContext: BrowserContext?
-
- connectToWorker:
- title: Connect to worker
- parameters:
- endpoint: string
- timeout: float
- returns:
- worker: Worker
-
-Browser:
- type: interface
-
- initializer:
- version: string
- name: string
- browserName:
- type: enum
- literals:
- - chromium
- - firefox
- - webkit
-
- commands:
-
- startServer:
- title: Start server
- parameters:
- title: string
- workspaceDir: string?
- metadata: json?
- host: string?
- port: int?
- returns:
- endpoint: string
-
- stopServer:
- title: Stop server
-
- close:
- title: Close browser
- parameters:
- reason: string?
- flags:
- pause: true
-
- killForTests:
- internal: true
-
- defaultUserAgentForTest:
- internal: true
- returns:
- userAgent: string
-
- newContext:
- title: Create context
- parameters:
- $mixin: ContextOptions
- proxy:
- type: object?
- properties:
- server: string
- bypass: string?
- username: string?
- password: string?
- storageState:
- type: object?
- properties:
- cookies:
- type: array?
- items: SetNetworkCookie
- origins:
- type: array?
- items: SetOriginStorage
- returns:
- context: BrowserContext
-
- newContextForReuse:
- internal: true
- parameters:
- $mixin: ContextOptions
- proxy:
- type: object?
- properties:
- server: string
- bypass: string?
- username: string?
- password: string?
- storageState:
- type: object?
- properties:
- cookies:
- type: array?
- items: SetNetworkCookie
- origins:
- type: array?
- items: SetOriginStorage
- returns:
- context: BrowserContext
-
- disconnectFromReusedContext:
- internal: true
- parameters:
- reason: string
-
- newBrowserCDPSession:
- title: Create CDP session
- group: configuration
- returns:
- session: CDPSession
-
- startTracing:
- title: Start browser tracing
- group: configuration
- parameters:
- page: Page?
- screenshots: boolean?
- categories:
- type: array?
- items: string
-
- stopTracing:
- title: Stop browser tracing
- group: configuration
- returns:
- artifact: Artifact
-
- events:
-
- context:
- parameters:
- context: BrowserContext
-
- close:
-
-ConsoleMessage:
- type: mixin
- properties:
- type: string
- text: string
- args:
- type: array
- items: JSHandle
- location:
- type: object
- properties:
- url: string
- lineNumber: int
- columnNumber: int
- timestamp: float
-
-
-EventTarget:
- type: interface
-
- commands:
- waitForEventInfo:
- title: Wait for event "{info.event}"
- parameters:
- info:
- type: object
- properties:
- waitId: string
- phase:
- type: enum
- literals:
- - before
- - after
- - log
- event: string?
- message: string?
- error: string?
- flags:
- snapshot: true
-
-BrowserContext:
- type: interface
-
- extends: EventTarget
-
- initializer:
- debugger: Debugger
- requestContext: APIRequestContext
- tracing: Tracing
- options:
- type: object
- properties:
- $mixin: ContextOptions
-
- commands:
-
- addCookies:
- title: Add cookies
- group: configuration
- parameters:
- cookies:
- type: array
- items: SetNetworkCookie
-
- addInitScript:
- title: Add init script
- group: configuration
- parameters:
- source: string
- returns:
- disposable: Disposable
-
- clearCookies:
- title: Clear cookies
- group: configuration
- parameters:
- name: string?
- nameRegexSource: string?
- nameRegexFlags: string?
- domain: string?
- domainRegexSource: string?
- domainRegexFlags: string?
- path: string?
- pathRegexSource: string?
- pathRegexFlags: string?
-
- clearPermissions:
- title: Clear permissions
- group: configuration
-
- close:
- title: Close context
- parameters:
- reason: string?
- flags:
- pause: true
-
- cookies:
- title: Get cookies
- group: getter
- parameters:
- urls:
- type: array
- items: string
- returns:
- cookies:
- type: array
- items: NetworkCookie
-
- exposeBinding:
- title: Expose binding
- group: configuration
- parameters:
- name: string
- returns:
- disposable: Disposable
-
- grantPermissions:
- title: Grant permissions
- group: configuration
- parameters:
- permissions:
- type: array
- items: string
- origin: string?
-
- newPage:
- title: Create page
- returns:
- page: Page
-
- registerSelectorEngine:
- internal: true
- parameters:
- selectorEngine: SelectorEngine
-
- setTestIdAttributeName:
- internal: true
- parameters:
- testIdAttributeName: string
-
- setExtraHTTPHeaders:
- title: Set extra HTTP headers
- group: configuration
- parameters:
- headers:
- type: array
- items: NameValue
-
- setGeolocation:
- title: Set geolocation
- group: configuration
- parameters:
- geolocation:
- type: object?
- properties:
- longitude: float
- latitude: float
- accuracy: float?
-
- setHTTPCredentials:
- title: Set HTTP credentials
- group: configuration
- parameters:
- httpCredentials:
- type: object?
- properties:
- username: string
- password: string
- origin: string?
-
- setNetworkInterceptionPatterns:
- title: Route requests
- group: route
- parameters:
- patterns:
- type: array
- items:
- type: object
- properties:
- glob: string?
- regexSource: string?
- regexFlags: string?
- urlPattern: URLPattern?
-
- setWebSocketInterceptionPatterns:
- title: Route WebSockets
- group: route
- parameters:
- patterns:
- type: array
- items:
- type: object
- properties:
- glob: string?
- regexSource: string?
- regexFlags: string?
- urlPattern: URLPattern?
-
- setOffline:
- title: Set offline mode
- parameters:
- offline: boolean
-
- storageState:
- title: Get storage state
- group: configuration
- parameters:
- indexedDB: boolean?
- returns:
- cookies:
- type: array
- items: NetworkCookie
- origins:
- type: array
- items: OriginStorage
-
- setStorageState:
- title: Set storage state
- group: configuration
- parameters:
- storageState:
- type: object?
- properties:
- cookies:
- type: array?
- items: SetNetworkCookie
- origins:
- type: array?
- items: SetOriginStorage
-
- pause:
- title: Pause
-
- enableRecorder:
- internal: true
- parameters:
- language: string?
- mode:
- type: enum?
- literals:
- - inspecting
- - recording
- recorderMode:
- type: enum?
- literals:
- - default
- - api
- pauseOnNextStatement: boolean?
- testIdAttributeName: string?
- launchOptions: json?
- contextOptions: json?
- device: string?
- saveStorage: string?
- outputFile: string?
- handleSIGINT: boolean?
- omitCallTracking: boolean?
-
- disableRecorder:
- internal: true
-
- exposeConsoleApi:
- internal: true
-
- newCDPSession:
- title: Create CDP session
- group: configuration
- parameters:
- page: Page?
- frame: Frame?
- returns:
- session: CDPSession
-
- createTempFiles:
- internal: true
- parameters:
- rootDirName: string?
- items:
- type: array
- items:
- type: object
- properties:
- name: string
- lastModifiedMs: float?
- returns:
- rootDir: WritableStream?
- writableStreams:
- type: array
- items: WritableStream
-
- updateSubscription:
- internal: true
- parameters:
- event:
- type: enum
- literals:
- - console
- - dialog
- - request
- - response
- - requestFinished
- - requestFailed
- enabled: boolean
-
- clockFastForward:
- title: Fast forward clock "{ticksNumber|ticksString}"
- parameters:
- ticksNumber: float?
- ticksString: string?
-
- clockInstall:
- title: Install clock "{timeNumber|timeString}"
- parameters:
- timeNumber: float?
- timeString: string?
-
- clockPauseAt:
- title: Pause clock "{timeNumber|timeString}"
- parameters:
- timeNumber: float?
- timeString: string?
-
- clockResume:
- title: Resume clock
-
- clockRunFor:
- title: Run clock "{ticksNumber|ticksString}"
- parameters:
- ticksNumber: float?
- ticksString: string?
-
- clockSetFixedTime:
- title: Set fixed time "{timeNumber|timeString}"
- parameters:
- timeNumber: float?
- timeString: string?
-
- clockSetSystemTime:
- title: Set system time "{timeNumber|timeString}"
- parameters:
- timeNumber: float?
- timeString: string?
-
- events:
-
- bindingCall:
- parameters:
- binding: BindingCall
-
- console:
- parameters:
- $mixin: ConsoleMessage
- page: Page?
- worker: Worker?
-
- close:
-
- dialog:
- parameters:
- dialog: Dialog
-
- page:
- parameters:
- page: Page
-
- pageError:
- parameters:
- error: SerializedError
- page: Page
- location:
- type: object
- properties:
- url: string
- line: int
- column: int
-
- route:
- parameters:
- route: Route
-
- webSocketRoute:
- parameters:
- webSocketRoute: WebSocketRoute
-
- serviceWorker:
- parameters:
- worker: Worker
-
- request:
- parameters:
- request: Request
- page: Page?
-
- requestFailed:
- parameters:
- request: Request
- failureText: string?
- responseEndTiming: float
- page: Page?
-
- requestFinished:
- parameters:
- request: Request
- response: Response?
- responseEndTiming: float
- page: Page?
-
- response:
- parameters:
- response: Response
- page: Page?
-
- recorderEvent:
- parameters:
- event:
- type: enum
- literals:
- - actionAdded
- - actionUpdated
- - signalAdded
- data: json
- page: Page
- code: string
-
-Page:
- type: interface
-
- extends: EventTarget
-
- initializer:
- mainFrame: Frame
- viewportSize:
- type: object?
- properties:
- width: int
- height: int
- isClosed: boolean
- opener: Page?
- video: Artifact?
-
- commands:
-
- addInitScript:
- title: Add init script
- group: configuration
- parameters:
- source: string
- returns:
- disposable: Disposable
-
- close:
- title: Close page
- parameters:
- runBeforeUnload: boolean?
- reason: string?
- flags:
- pause: true
-
- clearConsoleMessages:
- title: Clear console messages
-
- consoleMessages:
- title: Get console messages
- group: getter
- parameters:
- filter: ConsoleMessagesFilter?
- returns:
- messages:
- type: array
- items:
- type: object
- properties:
- $mixin: ConsoleMessage
-
- emulateMedia:
- title: Emulate media
- parameters:
- media:
- type: enum?
- literals:
- - screen
- - print
- - no-override
- colorScheme:
- type: enum?
- literals:
- - dark
- - light
- - no-preference
- - no-override
- reducedMotion:
- type: enum?
- literals:
- - reduce
- - no-preference
- - no-override
- forcedColors:
- type: enum?
- literals:
- - active
- - none
- - no-override
- contrast:
- type: enum?
- literals:
- - no-preference
- - more
- - no-override
- flags:
- snapshot: true
- pause: true
-
- exposeBinding:
- title: Expose binding
- group: configuration
- parameters:
- name: string
- returns:
- disposable: Disposable
-
- goBack:
- title: Go back
- parameters:
- timeout: float
- waitUntil: LifecycleEvent?
- returns:
- response: Response?
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- goForward:
- title: Go forward
- parameters:
- timeout: float
- waitUntil: LifecycleEvent?
- returns:
- response: Response?
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- requestGC:
- title: Request garbage collection
- group: configuration
-
- registerLocatorHandler:
- title: Register locator handler
- parameters:
- selector: string
- noWaitAfter: boolean?
- returns:
- uid: int
-
- resolveLocatorHandlerNoReply:
- internal: true
- parameters:
- uid: int
- remove: boolean?
-
- unregisterLocatorHandler:
- title: Unregister locator handler
- parameters:
- uid: int
-
- reload:
- title: Reload
- parameters:
- timeout: float
- waitUntil: LifecycleEvent?
- returns:
- response: Response?
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- expectScreenshot:
- title: Expect screenshot
- parameters:
- expected: binary?
- timeout: float
- isNot: boolean
- locator:
- type: object?
- properties:
- frame: Frame
- selector: string
- comparator: string?
- maxDiffPixels: int?
- maxDiffPixelRatio: float?
- threshold: float?
- fullPage: boolean?
- clip: Rect?
- $mixin: CommonScreenshotOptions
- returns:
- diff: binary?
- errorMessage: string?
- actual: binary?
- previous: binary?
- timedOut: boolean?
- log:
- type: array?
- items: string
- flags:
- snapshot: true
- pause: true
-
- screenshot:
- title: Screenshot
- parameters:
- timeout: float
- type:
- type: enum?
- literals:
- - png
- - jpeg
- quality: int?
- fullPage: boolean?
- clip: Rect?
- $mixin: CommonScreenshotOptions
- returns:
- binary: binary
- flags:
- snapshot: true
- pause: true
-
- setExtraHTTPHeaders:
- title: Set extra HTTP headers
- group: configuration
- parameters:
- headers:
- type: array
- items: NameValue
-
- setNetworkInterceptionPatterns:
- title: Route requests
- group: route
- parameters:
- patterns:
- type: array
- items:
- type: object
- properties:
- glob: string?
- regexSource: string?
- regexFlags: string?
- urlPattern: URLPattern?
-
- setWebSocketInterceptionPatterns:
- title: Route WebSockets
- group: route
- parameters:
- patterns:
- type: array
- items:
- type: object
- properties:
- glob: string?
- regexSource: string?
- regexFlags: string?
- urlPattern: URLPattern?
-
- setViewportSize:
- title: Set viewport size
- parameters:
- viewportSize:
- type: object
- properties:
- width: int
- height: int
- flags:
- snapshot: true
- pause: true
-
- keyboardDown:
- title: Key down "{key}"
- parameters:
- key: string
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- keyboardUp:
- title: Key up "{key}"
- parameters:
- key: string
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- keyboardInsertText:
- title: Insert "{text}"
- parameters:
- text: string
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- keyboardType:
- title: Type "{text}"
- parameters:
- text: string
- delay: float?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- keyboardPress:
- title: Press "{key}"
- parameters:
- key: string
- delay: float?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- mouseMove:
- title: Mouse move
- parameters:
- x: float
- y: float
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- mouseDown:
- title: Mouse down
- parameters:
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- clickCount: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- mouseUp:
- title: Mouse up
- parameters:
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- clickCount: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- mouseClick:
- title: Click
- parameters:
- x: float
- y: float
- delay: float?
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- clickCount: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- mouseWheel:
- title: Mouse wheel
- parameters:
- deltaX: float
- deltaY: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- touchscreenTap:
- title: Tap
- parameters:
- x: float
- y: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
-
- clearPageErrors:
- title: Clear page errors
-
- pageErrors:
- title: Get page errors
- group: getter
- parameters:
- filter: ConsoleMessagesFilter?
- returns:
- errors:
- type: array
- items: SerializedError
-
- pdf:
- title: PDF
- parameters:
- scale: float?
- displayHeaderFooter: boolean?
- headerTemplate: string?
- footerTemplate: string?
- printBackground: boolean?
- landscape: boolean?
- pageRanges: string?
- format: string?
- width: string?
- height: string?
- preferCSSPageSize: boolean?
- margin:
- type: object?
- properties:
- top: string?
- bottom: string?
- left: string?
- right: string?
- tagged: boolean?
- outline: boolean?
- returns:
- pdf: binary
-
- requests:
- title: Get network requests
- group: getter
- returns:
- requests:
- type: array
- items: Request
-
- startJSCoverage:
- title: Start JS coverage
- group: configuration
- parameters:
- resetOnNavigation: boolean?
- reportAnonymousScripts: boolean?
-
- stopJSCoverage:
- title: Stop JS coverage
- group: configuration
- returns:
- entries:
- type: array
- items:
- type: object
- properties:
- url: string
- scriptId: string
- source: string?
- functions:
- type: array
- items:
- type: object
- properties:
- functionName: string
- isBlockCoverage: boolean
- ranges:
- type: array
- items:
- type: object
- properties:
- startOffset: int
- endOffset: int
- count: int
-
- startCSSCoverage:
- title: Start CSS coverage
- group: configuration
- parameters:
- resetOnNavigation: boolean?
-
- stopCSSCoverage:
- title: Stop CSS coverage
- group: configuration
- returns:
- entries:
- type: array
- items:
- type: object
- properties:
- url: string
- text: string?
- ranges:
- type: array
- items:
- type: object
- properties:
- start: int
- end: int
-
- bringToFront:
- title: Bring to front
-
- pickLocator:
- title: Pick locator
- group: configuration
- returns:
- selector: string
-
- cancelPickLocator:
- title: Cancel pick locator
- group: configuration
-
- hideHighlight:
- title: Hide all element highlights
- group: configuration
-
- screencastShowOverlay:
- title: Show overlay
- group: configuration
- parameters:
- html: string
- duration: float?
- returns:
- id: string
-
- screencastRemoveOverlay:
- title: Remove overlay
- group: configuration
- parameters:
- id: string
-
- screencastChapter:
- title: Show chapter overlay
- group: configuration
- parameters:
- title: string
- description: string?
- duration: float?
-
- screencastSetOverlayVisible:
- title: Set overlay visibility
- group: configuration
- parameters:
- visible: boolean
-
- screencastShowActions:
- title: Show actions
- group: configuration
- parameters:
- $mixin: ShowActionsOptions
-
- screencastHideActions:
- title: Remove actions
- group: configuration
-
- screencastStart:
- title: Start screencast
- group: configuration
- parameters:
- size:
- type: object?
- properties:
- width: int
- height: int
- quality: int?
- sendFrames: boolean?
- record: boolean?
- returns:
- artifact: Artifact?
-
- screencastStop:
- title: Stop screencast
- group: configuration
-
- updateSubscription:
- internal: true
- parameters:
- event:
- type: enum
- literals:
- - console
- - dialog
- - fileChooser
- - request
- - response
- - requestFinished
- - requestFailed
- enabled: boolean
-
- setDockTile:
- internal: true
- parameters:
- image: binary
-
- events:
-
- bindingCall:
- parameters:
- binding: BindingCall
-
- close:
-
- crash:
-
- download:
- parameters:
- url: string
- suggestedFilename: string
- artifact: Artifact
-
- viewportSizeChanged:
- parameters:
- viewportSize:
- type: object?
- properties:
- width: int
- height: int
-
- fileChooser:
- parameters:
- element: ElementHandle
- isMultiple: boolean
-
- frameAttached:
- parameters:
- frame: Frame
-
- frameDetached:
- parameters:
- frame: Frame
-
- locatorHandlerTriggered:
- parameters:
- uid: int
-
- route:
- parameters:
- route: Route
-
- screencastFrame:
- parameters:
- data: binary
-
- webSocketRoute:
- parameters:
- webSocketRoute: WebSocketRoute
-
- webSocket:
- parameters:
- webSocket: WebSocket
-
- worker:
- parameters:
- worker: Worker
-
-
-
-Frame:
- type: interface
-
- initializer:
- url: string
- name: string
- parentFrame: Frame?
- loadStates:
- type: array
- items: LifecycleEvent
-
- commands:
-
- evalOnSelector:
- title: Evaluate
- parameters:
- selector: string
- strict: boolean?
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- evalOnSelectorAll:
- title: Evaluate
- parameters:
- selector: string
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- addScriptTag:
- title: Add script tag
- parameters:
- url: string?
- content: string?
- type: string?
- returns:
- element: ElementHandle
- flags:
- snapshot: true
- pause: true
-
- addStyleTag:
- title: Add style tag
- parameters:
- url: string?
- content: string?
- returns:
- element: ElementHandle
- flags:
- snapshot: true
- pause: true
-
- ariaSnapshot:
- title: Aria snapshot
- group: getter
- parameters:
- mode:
- type: enum?
- literals:
- - ai
- - default
- # When track is present, an incremental snapshot is returned when possible.
- track: string?
- selector: string?
- depth: int?
- boxes: boolean?
- timeout: float
- returns:
- snapshot: string
-
- blur:
- title: Blur
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- check:
- title: Check
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- click:
- title: Click
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- noWaitAfter: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- delay: float?
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- clickCount: int?
- timeout: float
- trial: boolean?
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- content:
- title: Get content
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- dragAndDrop:
- title: Drag and drop
- parameters:
- source: string
- target: string
- force: boolean?
- timeout: float
- trial: boolean?
- sourcePosition: Point?
- targetPosition: Point?
- strict: boolean?
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- drop:
- title: Drop files or data onto an element
- parameters:
- selector: string
- strict: boolean?
- position: Point?
- # Only one of payloads, localPaths and streams may be present.
- payloads:
- type: array?
- items:
- type: object
- properties:
- name: string
- mimeType: string?
- buffer: binary
- localPaths:
- type: array?
- items: string
- streams:
- type: array?
- items: WritableStream
- data:
- type: array?
- items:
- type: object
- properties:
- mimeType: string
- value: string
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- dblclick:
- title: Double click
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- delay: float?
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- timeout: float
- trial: boolean?
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- dispatchEvent:
- title: Dispatch "{type}"
- parameters:
- selector: string
- strict: boolean?
- type: string
- eventInit: SerializedArgument
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- evaluateExpression:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- evaluateExpressionHandle:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- handle: JSHandle
- flags:
- snapshot: true
- pause: true
-
- fill:
- title: Fill "{value}"
- parameters:
- selector: string
- strict: boolean?
- value: string
- force: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- focus:
- title: Focus
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- frameElement:
- title: Get frame element
- group: getter
- returns:
- element: ElementHandle
-
- resolveSelector:
- internal: true
- parameters:
- selector: string
- returns:
- resolvedSelector: string
-
- highlight:
- internal: true
- parameters:
- selector: string
- style: string?
-
- hideHighlight:
- internal: true
- parameters:
- selector: string
-
- getAttribute:
- title: Get attribute "{name}"
- group: getter
- parameters:
- selector: string
- strict: boolean?
- name: string
- timeout: float
- returns:
- value: string?
- flags:
- snapshot: true
- pause: true
-
- goto:
- title: Navigate to "{url}"
- parameters:
- url: string
- timeout: float
- waitUntil: LifecycleEvent?
- referer: string?
- returns:
- response: Response?
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- hover:
- title: Hover
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- innerHTML:
- title: Get HTML
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- innerText:
- title: Get inner text
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- inputValue:
- title: Get input value
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- isChecked:
- title: Is checked
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isDisabled:
- title: Is disabled
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isEnabled:
- title: Is enabled
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isHidden:
- title: Is hidden
- group: getter
- parameters:
- # Note: compared to other isFoo methods, isHidden is a one-shot operation without a timeout.
- selector: string
- strict: boolean?
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isVisible:
- title: Is visible
- group: getter
- parameters:
- # Note: compared to other isFoo methods, isVisible is a one-shot operation without a timeout.
- selector: string
- strict: boolean?
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isEditable:
- title: Is editable
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- press:
- title: Press "{key}"
- parameters:
- selector: string
- strict: boolean?
- key: string
- delay: float?
- noWaitAfter: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- querySelector:
- title: Query selector
- parameters:
- selector: string
- strict: boolean?
- returns:
- element: ElementHandle?
- flags:
- snapshot: true
-
- querySelectorAll:
- title: Query selector all
- parameters:
- selector: string
- returns:
- elements:
- type: array
- items: ElementHandle
- flags:
- snapshot: true
-
- queryCount:
- title: Query count
- parameters:
- selector: string
- returns:
- value: int
- flags:
- snapshot: true
- pause: true
-
- selectOption:
- title: Select option
- parameters:
- selector: string
- strict: boolean?
- elements:
- type: array?
- items: ElementHandle
- options:
- type: array?
- items:
- type: object
- properties:
- valueOrLabel: string?
- value: string?
- label: string?
- index: int?
- force: boolean?
- timeout: float
- returns:
- values:
- type: array
- items: string
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- setContent:
- title: Set content
- parameters:
- html: string
- timeout: float
- waitUntil: LifecycleEvent?
- flags:
- snapshot: true
- pause: true
-
- setInputFiles:
- title: Set input files
- parameters:
- selector: string
- strict: boolean?
- # Only one of payloads, localPaths and streams should be present.
- payloads:
- type: array?
- items:
- type: object
- properties:
- name: string
- mimeType: string?
- buffer: binary
- localDirectory: string?
- directoryStream: WritableStream?
- localPaths:
- type: array?
- items: string
- streams:
- type: array?
- items: WritableStream
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- tap:
- title: Tap
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- textContent:
- title: Get text content
- group: getter
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- returns:
- value: string?
- flags:
- snapshot: true
- pause: true
-
- title:
- title: Get page title
- group: getter
- returns:
- value: string
-
- type:
- title: Type "{text}"
- parameters:
- selector: string
- strict: boolean?
- text: string
- delay: float?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- uncheck:
- title: Uncheck
- parameters:
- selector: string
- strict: boolean?
- force: boolean?
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- waitForTimeout:
- title: Wait for timeout
- parameters:
- waitTimeout: float
- flags:
- snapshot: true
-
- waitForFunction:
- title: Wait for function
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- timeout: float
- # When present, polls on interval. Otherwise, polls on raf.
- pollingInterval: float?
- returns:
- handle: JSHandle
- flags:
- snapshot: true
- pause: true
-
- waitForSelector:
- title: Wait for selector
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- state:
- type: enum?
- literals:
- - attached
- - detached
- - visible
- - hidden
- omitReturnValue: boolean?
- returns:
- element: ElementHandle?
- flags:
- snapshot: true
-
- expect:
- title: Expect "{expression}"
- parameters:
- selector: string?
- expression: string
- expressionArg: json?
- pseudo:
- type: enum?
- literals:
- - before
- - after
- expectedText:
- type: array?
- items: ExpectedTextValue
- expectedNumber: float?
- expectedValue: SerializedArgument?
- useInnerText: boolean?
- isNot: boolean
- timeout: float
- returns:
- matches: boolean
- received:
- type: object?
- properties:
- value: SerializedValue?
- ariaSnapshot: string?
- timedOut: boolean?
- errorMessage: string?
- log:
- type: array?
- items: string
- flags:
- snapshot: true
- pause: true
-
- events:
-
- loadstate:
- parameters:
- add: LifecycleEvent?
- remove: LifecycleEvent?
-
- navigated:
- parameters:
- url: string
- name: string
- newDocument:
- type: object?
- properties:
- request: Request?
- error: string?
-
-
-
-Worker:
- type: interface
-
- extends: EventTarget
-
- initializer:
- url: string
-
- commands:
-
- disconnect:
- title: Disconnect from worker
- parameters:
- reason: string?
- flags:
- pausesBeforeAction: true
-
- evaluateExpression:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
-
- evaluateExpressionHandle:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- handle: JSHandle
-
- updateSubscription:
- internal: true
- parameters:
- event:
- type: enum
- literals:
- - console
- enabled: boolean
-
- events:
-
- console:
- parameters:
- $mixin: ConsoleMessage
-
- close:
-
-
-Disposable:
- type: interface
-
- commands:
-
- dispose:
- internal: true
-
-
-JSHandle:
- type: interface
-
- initializer:
- preview: string
-
- commands:
-
- dispose:
- internal: true
-
- evaluateExpression:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- evaluateExpressionHandle:
- title: Evaluate
- parameters:
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- handle: JSHandle
- flags:
- snapshot: true
- pause: true
-
- getPropertyList:
- title: Get property list
- group: getter
- returns:
- properties:
- type: array
- items:
- type: object
- properties:
- name: string
- value: JSHandle
-
- getProperty:
- title: Get JS property
- group: getter
- parameters:
- name: string
- returns:
- handle: JSHandle
-
- jsonValue:
- title: Get JSON value
- group: getter
- returns:
- value: SerializedValue
-
- events:
-
- previewUpdated:
- parameters:
- preview: string
-
-
-
-ElementHandle:
- type: interface
-
- extends: JSHandle
-
- commands:
-
- evalOnSelector:
- title: Evaluate
- parameters:
- selector: string
- strict: boolean?
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- evalOnSelectorAll:
- title: Evaluate
- parameters:
- selector: string
- expression: string
- isFunction: boolean?
- arg: SerializedArgument
- returns:
- value: SerializedValue
- flags:
- snapshot: true
- pause: true
-
- boundingBox:
- title: Get bounding box
- returns:
- value: Rect?
- flags:
- snapshot: true
- pause: true
-
- check:
- title: Check
- parameters:
- force: boolean?
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- click:
- title: Click
- parameters:
- force: boolean?
- noWaitAfter: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- delay: float?
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- clickCount: int?
- timeout: float
- trial: boolean?
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- contentFrame:
- title: Get content frame
- group: getter
- returns:
- frame: Frame?
-
- dblclick:
- title: Double click
- parameters:
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- delay: float?
- button:
- type: enum?
- literals:
- - left
- - right
- - middle
- timeout: float
- trial: boolean?
- steps: int?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- dispatchEvent:
- title: Dispatch event
- parameters:
- type: string
- eventInit: SerializedArgument
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- fill:
- title: Fill "{value}"
- parameters:
- value: string
- force: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- focus:
- title: Focus
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- getAttribute:
- title: Get attribute
- group: getter
- parameters:
- name: string
- returns:
- value: string?
- flags:
- snapshot: true
- pause: true
-
- hover:
- title: Hover
- parameters:
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- innerHTML:
- title: Get HTML
- group: getter
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- innerText:
- title: Get inner text
- group: getter
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- inputValue:
- title: Get input value
- group: getter
- returns:
- value: string
- flags:
- snapshot: true
- pause: true
-
- isChecked:
- title: Is checked
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isDisabled:
- title: Is disabled
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isEditable:
- title: Is editable
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isEnabled:
- title: Is enabled
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isHidden:
- title: Is hidden
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- isVisible:
- title: Is visible
- group: getter
- returns:
- value: boolean
- flags:
- snapshot: true
- pause: true
-
- ownerFrame:
- title: Get owner frame
- group: getter
- returns:
- frame: Frame?
-
- press:
- title: Press "{key}"
- parameters:
- key: string
- delay: float?
- timeout: float
- noWaitAfter: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- querySelector:
- title: Query selector
- parameters:
- selector: string
- strict: boolean?
- returns:
- element: ElementHandle?
- flags:
- snapshot: true
-
- querySelectorAll:
- title: Query selector all
- parameters:
- selector: string
- returns:
- elements:
- type: array
- items: ElementHandle
- flags:
- snapshot: true
-
- screenshot:
- title: Screenshot
- parameters:
- timeout: float
- type:
- type: enum?
- literals:
- - png
- - jpeg
- quality: int?
- $mixin: CommonScreenshotOptions
- returns:
- binary: binary
- flags:
- snapshot: true
- pause: true
-
- scrollIntoViewIfNeeded:
- title: Scroll into view
- parameters:
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- selectOption:
- title: Select option
- parameters:
- elements:
- type: array?
- items: ElementHandle
- options:
- type: array?
- items:
- type: object
- properties:
- valueOrLabel: string?
- value: string?
- label: string?
- index: int?
- force: boolean?
- timeout: float
- returns:
- values:
- type: array
- items: string
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- selectText:
- title: Select text
- parameters:
- force: boolean?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
-
- setInputFiles:
- title: Set input files
- parameters:
- # Only one of payloads, localPaths and streams should be present.
- payloads:
- type: array?
- items:
- type: object
- properties:
- name: string
- mimeType: string?
- buffer: binary
- localDirectory: string?
- directoryStream: WritableStream?
- localPaths:
- type: array?
- items: string
- streams:
- type: array?
- items: WritableStream
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- tap:
- title: Tap
- parameters:
- force: boolean?
- modifiers:
- type: array?
- items:
- type: enum
- literals:
- - Alt
- - Control
- - ControlOrMeta
- - Meta
- - Shift
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- textContent:
- title: Get text content
- group: getter
- returns:
- value: string?
- flags:
- snapshot: true
- pause: true
-
- type:
- title: Type
- parameters:
- text: string
- delay: float?
- timeout: float
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- uncheck:
- title: Uncheck
- parameters:
- force: boolean?
- position: Point?
- timeout: float
- trial: boolean?
- flags:
- slowMo: true
- snapshot: true
- pause: true
- input: true
- isAutoWaiting: true
-
- waitForElementState:
- title: Wait for state
- parameters:
- state:
- type: enum
- literals:
- - visible
- - hidden
- - stable
- - enabled
- - disabled
- - editable
- timeout: float
- flags:
- snapshot: true
- pause: true
-
- waitForSelector:
- title: Wait for selector
- parameters:
- selector: string
- strict: boolean?
- timeout: float
- state:
- type: enum?
- literals:
- - attached
- - detached
- - visible
- - hidden
- returns:
- element: ElementHandle?
- flags:
- snapshot: true
-
-
-Request:
- type: interface
-
- initializer:
- frame: Frame?
- serviceWorker: Worker?
- url: string
- resourceType: string
- method: string
- postData: binary?
- headers:
- type: array
- items: NameValue
- isNavigationRequest: boolean
- redirectedFrom: Request?
-
- commands:
-
- response:
- internal: true
- returns:
- response: Response?
-
- rawRequestHeaders:
- internal: true
- returns:
- headers:
- type: array
- items: NameValue
-
-Route:
- type: interface
-
- initializer:
- request: Request
-
- commands:
-
- redirectNavigationRequest:
- internal: true
- parameters:
- url: string
-
- abort:
- title: Abort request
- group: route
- parameters:
- errorCode: string?
-
- continue:
- title: Continue request
- group: route
- parameters:
- url: string?
- method: string?
- headers:
- type: array?
- items: NameValue
- postData: binary?
- isFallback: boolean
-
- fulfill:
- title: Fulfill request
- group: route
- parameters:
- # default is 200
- status: int?
- headers:
- type: array?
- items: NameValue
- body: string?
- isBase64: boolean?
- fetchResponseUid: string?
-
-
-WebSocketRoute:
- type: interface
-
- initializer:
- url: string
- protocols:
- type: array
- items: string
-
- commands:
-
- connect:
- title: Connect WebSocket to server
- group: route
-
- ensureOpened:
- internal: true
-
- sendToPage:
- title: Send WebSocket message
- group: route
- parameters:
- message: string
- isBase64: boolean
-
- sendToServer:
- title: Send WebSocket message
- group: route
- parameters:
- message: string
- isBase64: boolean
-
- closePage:
- internal: true
- parameters:
- code: int?
- reason: string?
- wasClean: boolean
-
- closeServer:
- internal: true
- parameters:
- code: int?
- reason: string?
- wasClean: boolean
-
- events:
-
- messageFromPage:
- parameters:
- message: string
- isBase64: boolean
-
- messageFromServer:
- parameters:
- message: string
- isBase64: boolean
-
- closePage:
- parameters:
- code: int?
- reason: string?
- wasClean: boolean
-
- closeServer:
- parameters:
- code: int?
- reason: string?
- wasClean: boolean
-
-
-ResourceTiming:
- type: object
- properties:
- startTime: float
- domainLookupStart: float
- domainLookupEnd: float
- connectStart: float
- secureConnectionStart: float
- connectEnd: float
- requestStart: float
- responseStart: float
-
-Response:
- type: interface
-
- initializer:
- request: Request
- url: string
- status: int
- statusText: string
- headers:
- type: array
- items: NameValue
- timing: ResourceTiming
- fromServiceWorker: boolean
-
-
- commands:
-
- body:
- title: Get response body
- group: getter
- returns:
- binary: binary
-
- securityDetails:
- internal: true
- returns:
- value: SecurityDetails?
-
- serverAddr:
- internal: true
- returns:
- value: RemoteAddr?
-
- rawResponseHeaders:
- internal: true
- returns:
- headers:
- type: array
- items: NameValue
-
- httpVersion:
- internal: true
- returns:
- value: string
-
- sizes:
- internal: true
- returns:
- sizes: RequestSizes
-
-
-SecurityDetails:
- type: object
- properties:
- issuer: string?
- protocol: string?
- subjectName: string?
- validFrom: float?
- validTo: float?
-
-RequestSizes:
- type: object
- properties:
- requestBodySize: int
- requestHeadersSize: int
- responseBodySize: int
- responseHeadersSize: int
-
-
-RemoteAddr:
- type: object
- properties:
- ipAddress: string
- port: int
-
-
-WebSocket:
- type: interface
-
- extends: EventTarget
-
- initializer:
- url: string
-
- events:
- open:
-
- frameSent:
- parameters:
- opcode: int
- data: string
-
- frameReceived:
- parameters:
- opcode: int
- data: string
-
- socketError:
- parameters:
- error: string
-
- close:
-
-
-BindingCall:
- type: interface
-
- initializer:
- frame: Frame
- name: string
- args:
- type: array
- items: SerializedValue
-
- commands:
-
- reject:
- internal: true
- parameters:
- error: SerializedError
-
- resolve:
- internal: true
- parameters:
- result: SerializedArgument
-
-
-
-Debugger:
- type: interface
-
- extends: EventTarget
-
- commands:
-
- requestPause:
- title: Pause on next call
- group: configuration
-
- resume:
- title: Resume
- group: configuration
-
- next:
- title: Step to next call
- group: configuration
-
- runTo:
- title: Run to location
- group: configuration
- parameters:
- location:
- type: object
- properties:
- file: string
- line: int?
- column: int?
-
- events:
-
- pausedStateChanged:
- parameters:
- pausedDetails:
- type: object?
- properties:
- location:
- type: object
- properties:
- file: string
- line: int?
- column: int?
- title: string
- stack: string?
-
-
-Dialog:
- type: interface
-
- initializer:
- page: Page?
- type: string
- message: string
- defaultValue: string
-
- commands:
-
- accept:
- title: Accept dialog
- parameters:
- promptText: string?
-
- dismiss:
- title: Dismiss dialog
-
-Tracing:
- type: interface
-
- commands:
-
- tracingStart:
- title: Start tracing
- group: configuration
- parameters:
- name: string?
- snapshots: boolean?
- screenshots: boolean?
- live: boolean?
-
- tracingStartChunk:
- title: Start tracing
- group: configuration
- parameters:
- name: string?
- title: string?
- returns:
- traceName: string
-
- tracingGroup:
- title: Trace "{name}"
- parameters:
- name: string
- location:
- type: object?
- properties:
- file: string
- line: int?
- column: int?
-
- tracingGroupEnd:
- title: Group end
-
- tracingStopChunk:
- title: Stop tracing
- group: configuration
- parameters:
- mode:
- type: enum
- literals:
- - archive
- - discard
- - entries
- returns:
- # The artifact may be missing if the browser closes while tracing is being stopped.
- # Or it can be missing if client-side compression is taking place.
- artifact: Artifact?
- # For local mode, these are all entries.
- entries:
- type: array?
- items: NameValue
-
- tracingStop:
- title: Stop tracing
- group: configuration
-
- harStart:
- internal: true
- parameters:
- page: Page?
- options: RecordHarOptions
- returns:
- harId: string
-
- harExport:
- internal: true
- parameters:
- harId: string?
- mode:
- type: enum
- literals:
- - archive
- - entries
- returns:
- # Present when mode is 'archive'.
- artifact: Artifact?
- # Present when mode is 'entries'.
- entries:
- type: array?
- items: NameValue
-
-
-Artifact:
- type: interface
-
- initializer:
- absolutePath: string
-
- commands:
-
- pathAfterFinished:
- internal: true
- returns:
- value: string
-
- # Blocks path/failure/delete/context.close until saved to the local |path|.
- saveAs:
- internal: true
- parameters:
- path: string
-
- # Blocks path/failure/delete/context.close until the stream is closed.
- saveAsStream:
- internal: true
- returns:
- stream: Stream
-
- failure:
- internal: true
- returns:
- error: string?
-
- stream:
- internal: true
- returns:
- stream: Stream
-
- cancel:
- internal: true
-
- delete:
- internal: true
-
-
-Stream:
- type: interface
-
- commands:
-
- read:
- internal: true
- parameters:
- size: int?
- returns:
- binary: binary
-
- close:
- internal: true
-
-
-WritableStream:
- type: interface
-
- commands:
-
- write:
- internal: true
- parameters:
- binary: binary
-
- close:
- internal: true
-
-
-CDPSession:
- type: interface
-
- commands:
-
- send:
- title: Send CDP command
- group: configuration
- parameters:
- method: string
- params: json?
- returns:
- result: json
-
- detach:
- title: Detach CDP session
- group: configuration
-
- events:
-
- event:
- parameters:
- method: string
- params: json?
-
- close:
-
-
-Android:
- type: interface
-
- commands:
-
- devices:
- internal: true
- parameters:
- host: string?
- port: int?
- omitDriverInstall: boolean?
- returns:
- devices:
- type: array
- items: AndroidDevice
-
-AndroidSocket:
- type: interface
-
- commands:
- write:
- internal: true
- parameters:
- data: binary
-
- close:
- internal: true
-
- events:
- data:
- parameters:
- data: binary
- close:
-
-AndroidDevice:
- type: interface
-
- extends: EventTarget
-
- initializer:
- model: string
- serial: string
-
- commands:
- wait:
- title: Wait
- parameters:
- androidSelector: AndroidSelector
- state:
- type: enum?
- literals:
- - gone
- timeout: float
-
- fill:
- title: Fill "{text}"
- parameters:
- androidSelector: AndroidSelector
- text: string
- timeout: float
-
- tap:
- title: Tap
- parameters:
- androidSelector: AndroidSelector
- duration: float?
- timeout: float
-
- drag:
- title: Drag
- parameters:
- androidSelector: AndroidSelector
- dest: Point
- speed: float?
- timeout: float
-
- fling:
- title: Fling
- parameters:
- androidSelector: AndroidSelector
- direction:
- type: enum
- literals:
- - up
- - down
- - left
- - right
- speed: float?
- timeout: float
-
- longTap:
- title: Long tap
- parameters:
- androidSelector: AndroidSelector
- timeout: float
-
- pinchClose:
- title: Pinch close
- parameters:
- androidSelector: AndroidSelector
- percent: float
- speed: float?
- timeout: float
-
- pinchOpen:
- title: Pinch open
- parameters:
- androidSelector: AndroidSelector
- percent: float
- speed: float?
- timeout: float
-
- scroll:
- title: Scroll
- parameters:
- androidSelector: AndroidSelector
- direction:
- type: enum
- literals:
- - up
- - down
- - left
- - right
- percent: float
- speed: float?
- timeout: float
-
- swipe:
- title: Swipe
- parameters:
- androidSelector: AndroidSelector
- direction:
- type: enum
- literals:
- - up
- - down
- - left
- - right
- percent: float
- speed: float?
- timeout: float
-
- info:
- internal: true
- parameters:
- androidSelector: AndroidSelector
- returns:
- info: AndroidElementInfo
-
- screenshot:
- title: Screenshot
- returns:
- binary: binary
-
- inputType:
- title: Type
- parameters:
- text: string
-
- inputPress:
- title: Press
- parameters:
- key: string
-
- inputTap:
- title: Tap
- parameters:
- point: Point
-
- inputSwipe:
- title: Swipe
- parameters:
- segments:
- type: array
- items: Point
- steps: int
-
- inputDrag:
- title: Drag
- parameters:
- from: Point
- to: Point
- steps: int
-
- launchBrowser:
- title: Launch browser
- parameters:
- $mixin: ContextOptions
- pkg: string?
- args:
- type: array?
- items: string
- proxy:
- type: object?
- properties:
- server: string
- bypass: string?
- username: string?
- password: string?
-
- returns:
- context: BrowserContext
-
- open:
- title: Open app
- parameters:
- command: string
- returns:
- socket: AndroidSocket
-
- shell:
- title: Execute shell command
- group: configuration
- parameters:
- command: string
- returns:
- result: binary
-
- installApk:
- title: Install apk
- parameters:
- file: binary
- args:
- type: array?
- items: string
-
- push:
- title: Push
- parameters:
- file: binary
- path: string
- mode: int?
-
- connectToWebView:
- title: Connect to Web View
- parameters:
- socketName: string
- returns:
- context: BrowserContext
-
- close:
- internal: true
-
- events:
- close:
-
- webViewAdded:
- parameters:
- webView: AndroidWebView
-
- webViewRemoved:
- parameters:
- socketName: string
-
-
-AndroidWebView:
- type: object
- properties:
- pid: int
- pkg: string
- socketName: string
-
-
-AndroidSelector:
- type: object
- properties:
- checkable: boolean?
- checked: boolean?
- clazz: string?
- clickable: boolean?
- depth: int?
- desc: string?
- enabled: boolean?
- focusable: boolean?
- focused: boolean?
- hasChild:
- type: object?
- properties:
- androidSelector: AndroidSelector
- hasDescendant:
- type: object?
- properties:
- androidSelector: AndroidSelector
- maxDepth: int?
- longClickable: boolean?
- pkg: string?
- res: string?
- scrollable: boolean?
- selected: boolean?
- text: string?
-
-
-AndroidElementInfo:
- type: object
- properties:
- children:
- type: array?
- items: AndroidElementInfo
- clazz: string
- desc: string
- res: string
- pkg: string
- text: string
- bounds: Rect
- checkable: boolean
- checked: boolean
- clickable: boolean
- enabled: boolean
- focusable: boolean
- focused: boolean
- longClickable: boolean
- scrollable: boolean
- selected: boolean
-
-
-JsonPipe:
- type: interface
-
- commands:
- send:
- internal: true
- parameters:
- message: json
-
- close:
- internal: true
-
- events:
-
- message:
- parameters:
- message: json
-
- closed:
- parameters:
- reason: string?
diff --git a/utils/build/build-playwright-driver.sh b/utils/build/build-playwright-driver.sh
index 2e24988ca9..10acdd5af5 100755
--- a/utils/build/build-playwright-driver.sh
+++ b/utils/build/build-playwright-driver.sh
@@ -16,7 +16,7 @@ node ../../utils/pack_package.js playwright-core ./output/playwright-core.tgz
echo "Building api.json and protocol.yml"
API_JSON_MODE=1 node ../../utils/doclint/generateApiJson.js > ./output/api.json
-cp ../../packages/protocol/src/protocol.yml ./output/
+node ../../utils/protocol_spec.js > ./output/protocol.yml
function build {
NODE_DIR=$1
diff --git a/utils/build/build.js b/utils/build/build.js
index a47606df42..347d617638 100644
--- a/utils/build/build.js
+++ b/utils/build/build.js
@@ -952,7 +952,7 @@ onChanges.push({
// Generate channels.
onChanges.push({
inputs: [
- 'packages/protocol/src/protocol.yml'
+ 'packages/protocol/spec/'
],
script: 'utils/generate_channels.js',
});
diff --git a/utils/generate_channels.js b/utils/generate_channels.js
index 627ca3a953..2ce95efb6f 100755
--- a/utils/generate_channels.js
+++ b/utils/generate_channels.js
@@ -19,7 +19,6 @@
const fs = require('fs');
const path = require('path');
-const yaml = require('yaml');
const channels = new Map();
const mixins = new Map();
@@ -184,8 +183,7 @@ const metainfo_ts = [
const methodMetainfo = [];
-const yml = fs.readFileSync(path.join(__dirname, '..', 'packages', 'protocol', 'src', 'protocol.yml'), 'utf-8');
-const protocol = yaml.parse(yml);
+const protocol = require('./protocol_spec').loadProtocol();
function addScheme(name, s) {
validator_ts.push(`scheme.${name} = ${s};`);
@@ -210,9 +208,28 @@ for (const [name, item] of Object.entries(protocol)) {
}
}
+// Trait-cascade order: each `T extends FooChannel ?` must be tested before any
+// of its ancestors via `extends`. Sort interfaces children-first so the cascade
+// is correct regardless of how the spec files are ordered on disk.
+const interfaceEntries = Object.entries(protocol).filter(([, v]) => v.type === 'interface');
+const interfaceDepth = new Map();
+function depthOf(name) {
+ if (interfaceDepth.has(name)) return interfaceDepth.get(name);
+ const ancestor = protocol[name] && protocol[name].extends;
+ const d = ancestor && protocol[ancestor] && protocol[ancestor].type === 'interface'
+ ? depthOf(ancestor) + 1 : 0;
+ interfaceDepth.set(name, d);
+ return d;
+}
+for (const [name] of interfaceEntries) depthOf(name);
+// Stable sort by descending depth — children before ancestors.
+const entriesInReverse = interfaceEntries
+ .map((e, i) => ({ e, i }))
+ .sort((a, b) => depthOf(b.e[0]) - depthOf(a.e[0]) || a.i - b.i)
+ .map(x => x.e);
+
channels_ts.push(`// ----------- Initializer Traits -----------`);
channels_ts.push(`export type InitializerTraits<T> =`);
-const entriesInReverse = Object.entries(protocol).reverse();
for (const [name, item] of entriesInReverse) {
if (item.type !== 'interface')
continue;
diff --git a/utils/generate_dotnet_channels.js b/utils/generate_dotnet_channels.js
index 00b6ea972e..76b9b916a9 100644
--- a/utils/generate_dotnet_channels.js
+++ b/utils/generate_dotnet_channels.js
@@ -19,7 +19,6 @@
const fs = require('fs');
const path = require('path');
-const yaml = require('yaml');
const channels = new Set();
const inherits = new Map();
@@ -163,8 +162,7 @@ function objectType(props, indent, onlyOptional = false, parentName = '') {
return { ts: `${indent}{${inner.ts}\n${indent}}`, scheme: `tObject({\n${inner.scheme}\n${indent}})` };
}
-const yml = fs.readFileSync(path.join(__dirname, '..', 'packages', 'protocol', 'src', 'protocol.yml'), 'utf-8');
-const protocol = yaml.parse(yml);
+const protocol = require('./protocol_spec').loadProtocol();
for (const [name, value] of Object.entries(protocol)) {
if (value.type === 'interface') {
diff --git a/utils/protocol_spec.js b/utils/protocol_spec.js
new file mode 100644
index 0000000000..4453144052
--- /dev/null
+++ b/utils/protocol_spec.js
@@ -0,0 +1,62 @@
+/**
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @ts-check
+
+const fs = require('fs');
+const path = require('path');
+const yaml = require('yaml');
+
+const specDir = path.join(__dirname, '..', 'packages', 'protocol', 'spec');
+
+function loadSpecFiles() {
+ return fs.readdirSync(specDir).filter(f => f.endsWith('.yml')).sort();
+}
+
+function loadProtocol() {
+ const files = loadSpecFiles();
+ const protocol = {};
+ for (const file of files) {
+ const text = fs.readFileSync(path.join(specDir, file), 'utf-8');
+ const doc = yaml.parse(text);
+ if (!doc || typeof doc !== 'object')
+ throw new Error(`packages/protocol/spec/${file} is empty or not a YAML map`);
+ for (const [name, value] of Object.entries(doc)) {
+ if (name in protocol)
+ throw new Error(`Duplicate top-level definition "${name}" in packages/protocol/spec/${file}`);
+ protocol[name] = value;
+ }
+ }
+ return protocol;
+}
+
+function loadProtocolYaml() {
+ const files = loadSpecFiles();
+ const parts = [];
+ for (const file of files) {
+ let text = fs.readFileSync(path.join(specDir, file), 'utf-8');
+ if (!text.endsWith('\n'))
+ text += '\n';
+ parts.push(text);
+ }
+ return parts.join('\n');
+}
+
+module.exports = { loadProtocol, loadProtocolYaml };
+
+if (require.main === module) {
+ process.stdout.write(loadProtocolYaml());
+}