Skip to content

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

feat(chromium): roll to r1190 (#37329)

microsoft-playwright-automation[bot]f94a28e469d1
diff --git a/README.md b/README.md
index 4be427c5ae..ec21ec50b5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# 🎭 Playwright
-[![npm version](https://img.shields.io/npm/v/playwright.svg)](https://www.npmjs.com/package/playwright) <!-- GEN:chromium-version-badge -->[![Chromium version](https://img.shields.io/badge/chromium-140.0.7339.41-blue.svg?logo=google-chrome)](https://www.chromium.org/Home)<!-- GEN:stop --> <!-- GEN:firefox-version-badge -->[![Firefox version](https://img.shields.io/badge/firefox-141.0-blue.svg?logo=firefoxbrowser)](https://www.mozilla.org/en-US/firefox/new/)<!-- GEN:stop --> <!-- GEN:webkit-version-badge -->[![WebKit version](https://img.shields.io/badge/webkit-26.0-blue.svg?logo=safari)](https://webkit.org/)<!-- GEN:stop --> [![Join Discord](https://img.shields.io/badge/join-discord-informational)](https://aka.ms/playwright/discord)
+[![npm version](https://img.shields.io/npm/v/playwright.svg)](https://www.npmjs.com/package/playwright) <!-- GEN:chromium-version-badge -->[![Chromium version](https://img.shields.io/badge/chromium-141.0.7390.7-blue.svg?logo=google-chrome)](https://www.chromium.org/Home)<!-- GEN:stop --> <!-- GEN:firefox-version-badge -->[![Firefox version](https://img.shields.io/badge/firefox-141.0-blue.svg?logo=firefoxbrowser)](https://www.mozilla.org/en-US/firefox/new/)<!-- GEN:stop --> <!-- GEN:webkit-version-badge -->[![WebKit version](https://img.shields.io/badge/webkit-26.0-blue.svg?logo=safari)](https://webkit.org/)<!-- GEN:stop --> [![Join Discord](https://img.shields.io/badge/join-discord-informational)](https://aka.ms/playwright/discord)
## [Documentation](https://playwright.dev) | [API reference](https://playwright.dev/docs/api/class-playwright)
@@ -8,7 +8,7 @@ Playwright is a framework for Web Testing and Automation. It allows testing [Chr
| | Linux | macOS | Windows |
| :--- | :---: | :---: | :---: |
-| Chromium <!-- GEN:chromium-version -->140.0.7339.41<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
+| Chromium <!-- GEN:chromium-version -->141.0.7390.7<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| WebKit <!-- GEN:webkit-version -->26.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| Firefox <!-- GEN:firefox-version -->141.0<!-- GEN:stop --> | :white_check_mark: | :white_check_mark: | :white_check_mark: |
diff --git a/packages/playwright-core/browsers.json b/packages/playwright-core/browsers.json
index ae5677bcf4..b34293e5e6 100644
--- a/packages/playwright-core/browsers.json
+++ b/packages/playwright-core/browsers.json
@@ -3,15 +3,15 @@
"browsers": [
{
"name": "chromium",
- "revision": "1189",
+ "revision": "1190",
"installByDefault": true,
- "browserVersion": "140.0.7339.41"
+ "browserVersion": "141.0.7390.7"
},
{
"name": "chromium-headless-shell",
- "revision": "1189",
+ "revision": "1190",
"installByDefault": true,
- "browserVersion": "140.0.7339.41"
+ "browserVersion": "141.0.7390.7"
},
{
"name": "chromium-tip-of-tree",
diff --git a/packages/playwright-core/src/server/chromium/protocol.d.ts b/packages/playwright-core/src/server/chromium/protocol.d.ts
index 1fab022bfb..5d3c9d26c1 100644
--- a/packages/playwright-core/src/server/chromium/protocol.d.ts
+++ b/packages/playwright-core/src/server/chromium/protocol.d.ts
@@ -1050,7 +1050,7 @@ registrations being ignored.
*/
propertyValue?: string;
}
- export type UserReidentificationIssueType = "BlockedFrameNavigation"|"BlockedSubresource";
+ export type UserReidentificationIssueType = "BlockedFrameNavigation"|"BlockedSubresource"|"NoisedCanvasReadback";
/**
* This issue warns about uses of APIs that may be considered misuse to
re-identify users.
@@ -1061,6 +1061,10 @@ re-identify users.
* Applies to BlockedFrameNavigation and BlockedSubresource issue types.
*/
request?: AffectedRequest;
+ /**
+ * Applies to NoisedCanvasReadback issue type.
+ */
+ sourceCodeLocation?: SourceCodeLocation;
}
/**
* A unique identifier for the type of issue. Each type may use one of the
@@ -1197,125 +1201,6 @@ using Audits.issueAdded event.
}
}
- /**
- * Defines commands and events for browser extensions.
- */
- export module Extensions {
- /**
- * Storage areas.
- */
- export type StorageArea = "session"|"local"|"sync"|"managed";
-
-
- /**
- * Installs an unpacked extension from the filesystem similar to
---load-extension CLI flags. Returns extension ID once the extension
-has been installed. Available if the client is connected using the
---remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
-flag is set.
- */
- export type loadUnpackedParameters = {
- /**
- * Absolute file path.
- */
- path: string;
- }
- export type loadUnpackedReturnValue = {
- /**
- * Extension id.
- */
- id: string;
- }
- /**
- * Uninstalls an unpacked extension (others not supported) from the profile.
-Available if the client is connected using the --remote-debugging-pipe flag
-and the --enable-unsafe-extension-debugging.
- */
- export type uninstallParameters = {
- /**
- * Extension id.
- */
- id: string;
- }
- export type uninstallReturnValue = {
- }
- /**
- * Gets data from extension storage in the given `storageArea`. If `keys` is
-specified, these are used to filter the result.
- */
- export type getStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to retrieve data from.
- */
- storageArea: StorageArea;
- /**
- * Keys to retrieve.
- */
- keys?: string[];
- }
- export type getStorageItemsReturnValue = {
- data: { [key: string]: string };
- }
- /**
- * Removes `keys` from extension storage in the given `storageArea`.
- */
- export type removeStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to remove data from.
- */
- storageArea: StorageArea;
- /**
- * Keys to remove.
- */
- keys: string[];
- }
- export type removeStorageItemsReturnValue = {
- }
- /**
- * Clears extension storage in the given `storageArea`.
- */
- export type clearStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to remove data from.
- */
- storageArea: StorageArea;
- }
- export type clearStorageItemsReturnValue = {
- }
- /**
- * Sets `values` in extension storage in the given `storageArea`. The provided `values`
-will be merged with existing values in the storage area.
- */
- export type setStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to set data in.
- */
- storageArea: StorageArea;
- /**
- * Values to set.
- */
- values: { [key: string]: string };
- }
- export type setStorageItemsReturnValue = {
- }
- }
-
/**
* Defines commands and events for Autofill.
*/
@@ -1580,4404 +1465,4669 @@ events afterwards if enabled and recording.
}
/**
- * The Browser domain defines methods and events for browser managing.
+ * This domain allows configuring virtual Bluetooth devices to test
+the web-bluetooth API.
*/
- export module Browser {
- export type BrowserContextID = string;
- export type WindowID = number;
+ export module BluetoothEmulation {
/**
- * The state of the browser window.
+ * Indicates the various states of Central.
*/
- export type WindowState = "normal"|"minimized"|"maximized"|"fullscreen";
+ export type CentralState = "absent"|"powered-off"|"powered-on";
/**
- * Browser window bounds information
+ * Indicates the various types of GATT event.
*/
- export interface Bounds {
- /**
- * The offset from the left edge of the screen to the window in pixels.
- */
- left?: number;
- /**
- * The offset from the top edge of the screen to the window in pixels.
- */
- top?: number;
- /**
- * The window width in pixels.
- */
- width?: number;
- /**
- * The window height in pixels.
- */
- height?: number;
- /**
- * The window state. Default to normal.
- */
- windowState?: WindowState;
- }
- export type PermissionType = "ar"|"audioCapture"|"automaticFullscreen"|"backgroundFetch"|"backgroundSync"|"cameraPanTiltZoom"|"capturedSurfaceControl"|"clipboardReadWrite"|"clipboardSanitizedWrite"|"displayCapture"|"durableStorage"|"geolocation"|"handTracking"|"idleDetection"|"keyboardLock"|"localFonts"|"localNetworkAccess"|"midi"|"midiSysex"|"nfc"|"notifications"|"paymentHandler"|"periodicBackgroundSync"|"pointerLock"|"protectedMediaIdentifier"|"sensors"|"smartCard"|"speakerSelection"|"storageAccess"|"topLevelStorageAccess"|"videoCapture"|"vr"|"wakeLockScreen"|"wakeLockSystem"|"webAppInstallation"|"webPrinting"|"windowManagement";
- export type PermissionSetting = "granted"|"denied"|"prompt";
+ export type GATTOperationType = "connection"|"discovery";
/**
- * Definition of PermissionDescriptor defined in the Permissions API:
-https://w3c.github.io/permissions/#dom-permissiondescriptor.
+ * Indicates the various types of characteristic write.
*/
- export interface PermissionDescriptor {
- /**
- * Name of permission.
-See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
- */
- name: string;
- /**
- * For "midi" permission, may also specify sysex control.
- */
- sysex?: boolean;
- /**
- * For "push" permission, may specify userVisibleOnly.
-Note that userVisibleOnly = true is the only currently supported type.
- */
- userVisibleOnly?: boolean;
- /**
- * For "clipboard" permission, may specify allowWithoutSanitization.
- */
- allowWithoutSanitization?: boolean;
- /**
- * For "fullscreen" permission, must specify allowWithoutGesture:true.
- */
- allowWithoutGesture?: boolean;
- /**
- * For "camera" permission, may specify panTiltZoom.
- */
- panTiltZoom?: boolean;
- }
+ export type CharacteristicWriteType = "write-default-deprecated"|"write-with-response"|"write-without-response";
/**
- * Browser command ids used by executeBrowserCommand.
+ * Indicates the various types of characteristic operation.
*/
- export type BrowserCommandId = "openTabSearch"|"closeTabSearch"|"openGlic";
+ export type CharacteristicOperationType = "read"|"write"|"subscribe-to-notifications"|"unsubscribe-from-notifications";
/**
- * Chrome histogram bucket.
+ * Indicates the various types of descriptor operation.
*/
- export interface Bucket {
- /**
- * Minimum value (inclusive).
- */
- low: number;
+ export type DescriptorOperationType = "read"|"write";
+ /**
+ * Stores the manufacturer data
+ */
+ export interface ManufacturerData {
/**
- * Maximum value (exclusive).
+ * Company identifier
+https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml
+https://usb.org/developers
*/
- high: number;
+ key: number;
/**
- * Number of samples.
+ * Manufacturer-specific data
*/
- count: number;
+ data: binary;
}
/**
- * Chrome histogram.
+ * Stores the byte data of the advertisement packet sent by a Bluetooth device.
*/
- export interface Histogram {
- /**
- * Name.
- */
- name: string;
+ export interface ScanRecord {
+ name?: string;
+ uuids?: string[];
/**
- * Sum of sample values.
+ * Stores the external appearance description of the device.
*/
- sum: number;
+ appearance?: number;
/**
- * Total number of samples.
+ * Stores the transmission power of a broadcasting device.
*/
- count: number;
+ txPower?: number;
/**
- * Buckets.
+ * Key is the company identifier and the value is an array of bytes of
+manufacturer specific data.
*/
- buckets: Bucket[];
+ manufacturerData?: ManufacturerData[];
}
- export type PrivacySandboxAPI = "BiddingAndAuctionServices"|"TrustedKeyValue";
-
/**
- * Fired when page is about to start a download.
+ * Stores the advertisement packet information that is sent by a Bluetooth device.
*/
- export type downloadWillBeginPayload = {
- /**
- * Id of the frame that caused the download to begin.
- */
- frameId: Page.FrameId;
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * URL of the resource being downloaded.
- */
- url: string;
- /**
- * Suggested file name of the resource (the actual name of the file saved on disk may differ).
- */
- suggestedFilename: string;
+ export interface ScanEntry {
+ deviceAddress: string;
+ rssi: number;
+ scanRecord: ScanRecord;
}
/**
- * Fired when download makes progress. Last call has |done| == true.
+ * Describes the properties of a characteristic. This follows Bluetooth Core
+Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.
*/
- export type downloadProgressPayload = {
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * Total expected bytes to download.
- */
- totalBytes: number;
- /**
- * Total bytes received.
- */
- receivedBytes: number;
- /**
- * Download status.
- */
- state: "inProgress"|"completed"|"canceled";
- /**
- * If download is "completed", provides the path of the downloaded file.
-Depending on the platform, it is not guaranteed to be set, nor the file
-is guaranteed to exist.
- */
- filePath?: string;
+ export interface CharacteristicProperties {
+ broadcast?: boolean;
+ read?: boolean;
+ writeWithoutResponse?: boolean;
+ write?: boolean;
+ notify?: boolean;
+ indicate?: boolean;
+ authenticatedSignedWrites?: boolean;
+ extendedProperties?: boolean;
}
/**
- * Set permission settings for given origin.
+ * Event for when a GATT operation of |type| to the peripheral with |address|
+happened.
*/
- export type setPermissionParameters = {
- /**
- * Descriptor of permission to override.
- */
- permission: PermissionDescriptor;
- /**
- * Setting of the permission.
- */
- setting: PermissionSetting;
- /**
- * Origin the permission applies to, all origins if not specified.
- */
- origin?: string;
- /**
- * Context to override. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
+ export type gattOperationReceivedPayload = {
+ address: string;
+ type: GATTOperationType;
}
- export type setPermissionReturnValue = {
+ /**
+ * Event for when a characteristic operation of |type| to the characteristic
+respresented by |characteristicId| happened. |data| and |writeType| is
+expected to exist when |type| is write.
+ */
+ export type characteristicOperationReceivedPayload = {
+ characteristicId: string;
+ type: CharacteristicOperationType;
+ data?: binary;
+ writeType?: CharacteristicWriteType;
}
/**
- * Grant specific permissions to the given origin and reject all others.
+ * Event for when a descriptor operation of |type| to the descriptor
+respresented by |descriptorId| happened. |data| is expected to exist when
+|type| is write.
*/
- export type grantPermissionsParameters = {
- permissions: PermissionType[];
+ export type descriptorOperationReceivedPayload = {
+ descriptorId: string;
+ type: DescriptorOperationType;
+ data?: binary;
+ }
+
+ /**
+ * Enable the BluetoothEmulation domain.
+ */
+ export type enableParameters = {
/**
- * Origin the permission applies to, all origins if not specified.
+ * State of the simulated central.
*/
- origin?: string;
+ state: CentralState;
/**
- * BrowserContext to override permissions. When omitted, default browser context is used.
+ * If the simulated central supports low-energy.
*/
- browserContextId?: BrowserContextID;
+ leSupported: boolean;
}
- export type grantPermissionsReturnValue = {
+ export type enableReturnValue = {
}
/**
- * Reset all permission management for all origins.
+ * Set the state of the simulated central.
*/
- export type resetPermissionsParameters = {
+ export type setSimulatedCentralStateParameters = {
/**
- * BrowserContext to reset permissions. When omitted, default browser context is used.
+ * State of the simulated central.
*/
- browserContextId?: BrowserContextID;
+ state: CentralState;
}
- export type resetPermissionsReturnValue = {
+ export type setSimulatedCentralStateReturnValue = {
}
/**
- * Set the behavior when downloading a file.
+ * Disable the BluetoothEmulation domain.
*/
- export type setDownloadBehaviorParameters = {
- /**
- * Whether to allow all or deny all download requests, or use default Chrome behavior if
-available (otherwise deny). |allowAndName| allows download and names files according to
-their download guids.
- */
- behavior: "deny"|"allow"|"allowAndName"|"default";
- /**
- * BrowserContext to set download behavior. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
- /**
- * The default path to save downloaded files to. This is required if behavior is set to 'allow'
-or 'allowAndName'.
- */
- downloadPath?: string;
- /**
- * Whether to emit download events (defaults to false).
- */
- eventsEnabled?: boolean;
+ export type disableParameters = {
}
- export type setDownloadBehaviorReturnValue = {
+ export type disableReturnValue = {
}
/**
- * Cancel a download if in progress
+ * Simulates a peripheral with |address|, |name| and |knownServiceUuids|
+that has already been connected to the system.
*/
- export type cancelDownloadParameters = {
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * BrowserContext to perform the action in. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
+ export type simulatePreconnectedPeripheralParameters = {
+ address: string;
+ name: string;
+ manufacturerData: ManufacturerData[];
+ knownServiceUuids: string[];
}
- export type cancelDownloadReturnValue = {
+ export type simulatePreconnectedPeripheralReturnValue = {
}
/**
- * Close browser gracefully.
+ * Simulates an advertisement packet described in |entry| being received by
+the central.
*/
- export type closeParameters = {
+ export type simulateAdvertisementParameters = {
+ entry: ScanEntry;
}
- export type closeReturnValue = {
+ export type simulateAdvertisementReturnValue = {
}
/**
- * Crashes browser on the main thread.
+ * Simulates the response code from the peripheral with |address| for a
+GATT operation of |type|. The |code| value follows the HCI Error Codes from
+Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes.
*/
- export type crashParameters = {
+ export type simulateGATTOperationResponseParameters = {
+ address: string;
+ type: GATTOperationType;
+ code: number;
}
- export type crashReturnValue = {
+ export type simulateGATTOperationResponseReturnValue = {
}
/**
- * Crashes GPU process.
+ * Simulates the response from the characteristic with |characteristicId| for a
+characteristic operation of |type|. The |code| value follows the Error
+Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
+The |data| is expected to exist when simulating a successful read operation
+response.
*/
- export type crashGpuProcessParameters = {
+ export type simulateCharacteristicOperationResponseParameters = {
+ characteristicId: string;
+ type: CharacteristicOperationType;
+ code: number;
+ data?: binary;
}
- export type crashGpuProcessReturnValue = {
+ export type simulateCharacteristicOperationResponseReturnValue = {
}
/**
- * Returns version information.
+ * Simulates the response from the descriptor with |descriptorId| for a
+descriptor operation of |type|. The |code| value follows the Error
+Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
+The |data| is expected to exist when simulating a successful read operation
+response.
*/
- export type getVersionParameters = {
+ export type simulateDescriptorOperationResponseParameters = {
+ descriptorId: string;
+ type: DescriptorOperationType;
+ code: number;
+ data?: binary;
}
- export type getVersionReturnValue = {
- /**
- * Protocol version.
- */
- protocolVersion: string;
- /**
- * Product name.
- */
- product: string;
- /**
- * Product revision.
- */
- revision: string;
- /**
- * User-Agent.
- */
- userAgent: string;
- /**
- * V8 version.
- */
- jsVersion: string;
+ export type simulateDescriptorOperationResponseReturnValue = {
}
/**
- * Returns the command line switches for the browser process if, and only if
---enable-automation is on the commandline.
+ * Adds a service with |serviceUuid| to the peripheral with |address|.
*/
- export type getBrowserCommandLineParameters = {
+ export type addServiceParameters = {
+ address: string;
+ serviceUuid: string;
}
- export type getBrowserCommandLineReturnValue = {
+ export type addServiceReturnValue = {
/**
- * Commandline parameters
+ * An identifier that uniquely represents this service.
*/
- arguments: string[];
+ serviceId: string;
}
/**
- * Get Chrome histograms.
+ * Removes the service respresented by |serviceId| from the simulated central.
*/
- export type getHistogramsParameters = {
- /**
- * Requested substring in name. Only histograms which have query as a
-substring in their name are extracted. An empty or absent query returns
-all histograms.
- */
- query?: string;
- /**
- * If true, retrieve delta since last delta call.
- */
- delta?: boolean;
+ export type removeServiceParameters = {
+ serviceId: string;
}
- export type getHistogramsReturnValue = {
- /**
- * Histograms.
- */
- histograms: Histogram[];
+ export type removeServiceReturnValue = {
}
/**
- * Get a Chrome histogram by name.
+ * Adds a characteristic with |characteristicUuid| and |properties| to the
+service represented by |serviceId|.
*/
- export type getHistogramParameters = {
- /**
- * Requested histogram name.
- */
- name: string;
- /**
- * If true, retrieve delta since last delta call.
- */
- delta?: boolean;
+ export type addCharacteristicParameters = {
+ serviceId: string;
+ characteristicUuid: string;
+ properties: CharacteristicProperties;
}
- export type getHistogramReturnValue = {
+ export type addCharacteristicReturnValue = {
/**
- * Histogram.
+ * An identifier that uniquely represents this characteristic.
*/
- histogram: Histogram;
+ characteristicId: string;
}
/**
- * Get position and size of the browser window.
+ * Removes the characteristic respresented by |characteristicId| from the
+simulated central.
*/
- export type getWindowBoundsParameters = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
+ export type removeCharacteristicParameters = {
+ characteristicId: string;
}
- export type getWindowBoundsReturnValue = {
- /**
- * Bounds information of the window. When window state is 'minimized', the restored window
-position and size are returned.
- */
- bounds: Bounds;
+ export type removeCharacteristicReturnValue = {
}
/**
- * Get the browser window that contains the devtools target.
+ * Adds a descriptor with |descriptorUuid| to the characteristic respresented
+by |characteristicId|.
*/
- export type getWindowForTargetParameters = {
- /**
- * Devtools agent host id. If called as a part of the session, associated targetId is used.
- */
- targetId?: Target.TargetID;
+ export type addDescriptorParameters = {
+ characteristicId: string;
+ descriptorUuid: string;
}
- export type getWindowForTargetReturnValue = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
+ export type addDescriptorReturnValue = {
/**
- * Bounds information of the window. When window state is 'minimized', the restored window
-position and size are returned.
+ * An identifier that uniquely represents this descriptor.
*/
- bounds: Bounds;
+ descriptorId: string;
}
/**
- * Set position and/or size of the browser window.
+ * Removes the descriptor with |descriptorId| from the simulated central.
*/
- export type setWindowBoundsParameters = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
- /**
- * New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
-with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
- */
- bounds: Bounds;
+ export type removeDescriptorParameters = {
+ descriptorId: string;
}
- export type setWindowBoundsReturnValue = {
+ export type removeDescriptorReturnValue = {
}
/**
- * Set size of the browser contents resizing browser window as necessary.
+ * Simulates a GATT disconnection from the peripheral with |address|.
*/
- export type setContentsSizeParameters = {
+ export type simulateGATTDisconnectionParameters = {
+ address: string;
+ }
+ export type simulateGATTDisconnectionReturnValue = {
+ }
+ }
+
+ /**
+ * The Browser domain defines methods and events for browser managing.
+ */
+ export module Browser {
+ export type BrowserContextID = string;
+ export type WindowID = number;
+ /**
+ * The state of the browser window.
+ */
+ export type WindowState = "normal"|"minimized"|"maximized"|"fullscreen";
+ /**
+ * Browser window bounds information
+ */
+ export interface Bounds {
/**
- * Browser window id.
+ * The offset from the left edge of the screen to the window in pixels.
*/
- windowId: WindowID;
+ left?: number;
/**
- * The window contents width in DIP. Assumes current width if omitted.
-Must be specified if 'height' is omitted.
+ * The offset from the top edge of the screen to the window in pixels.
+ */
+ top?: number;
+ /**
+ * The window width in pixels.
*/
width?: number;
/**
- * The window contents height in DIP. Assumes current height if omitted.
-Must be specified if 'width' is omitted.
+ * The window height in pixels.
*/
height?: number;
- }
- export type setContentsSizeReturnValue = {
- }
- /**
- * Set dock tile details, platform-specific.
- */
- export type setDockTileParameters = {
- badgeLabel?: string;
/**
- * Png encoded image.
+ * The window state. Default to normal.
*/
- image?: binary;
- }
- export type setDockTileReturnValue = {
- }
- /**
- * Invoke custom browser commands used by telemetry.
- */
- export type executeBrowserCommandParameters = {
- commandId: BrowserCommandId;
- }
- export type executeBrowserCommandReturnValue = {
- }
- /**
- * Allows a site to use privacy sandbox features that require enrollment
-without the site actually being enrolled. Only supported on page targets.
- */
- export type addPrivacySandboxEnrollmentOverrideParameters = {
- url: string;
- }
- export type addPrivacySandboxEnrollmentOverrideReturnValue = {
+ windowState?: WindowState;
}
+ export type PermissionType = "ar"|"audioCapture"|"automaticFullscreen"|"backgroundFetch"|"backgroundSync"|"cameraPanTiltZoom"|"capturedSurfaceControl"|"clipboardReadWrite"|"clipboardSanitizedWrite"|"displayCapture"|"durableStorage"|"geolocation"|"handTracking"|"idleDetection"|"keyboardLock"|"localFonts"|"localNetworkAccess"|"midi"|"midiSysex"|"nfc"|"notifications"|"paymentHandler"|"periodicBackgroundSync"|"pointerLock"|"protectedMediaIdentifier"|"sensors"|"smartCard"|"speakerSelection"|"storageAccess"|"topLevelStorageAccess"|"videoCapture"|"vr"|"wakeLockScreen"|"wakeLockSystem"|"webAppInstallation"|"webPrinting"|"windowManagement";
+ export type PermissionSetting = "granted"|"denied"|"prompt";
/**
- * Configures encryption keys used with a given privacy sandbox API to talk
-to a trusted coordinator. Since this is intended for test automation only,
-coordinatorOrigin must be a .test domain. No existing coordinator
-configuration for the origin may exist.
+ * Definition of PermissionDescriptor defined in the Permissions API:
+https://w3c.github.io/permissions/#dom-permissiondescriptor.
*/
- export type addPrivacySandboxCoordinatorKeyConfigParameters = {
- api: PrivacySandboxAPI;
- coordinatorOrigin: string;
- keyConfig: string;
+ export interface PermissionDescriptor {
/**
- * BrowserContext to perform the action in. When omitted, default browser
-context is used.
+ * Name of permission.
+See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
*/
- browserContextId?: BrowserContextID;
- }
- export type addPrivacySandboxCoordinatorKeyConfigReturnValue = {
+ name: string;
+ /**
+ * For "midi" permission, may also specify sysex control.
+ */
+ sysex?: boolean;
+ /**
+ * For "push" permission, may specify userVisibleOnly.
+Note that userVisibleOnly = true is the only currently supported type.
+ */
+ userVisibleOnly?: boolean;
+ /**
+ * For "clipboard" permission, may specify allowWithoutSanitization.
+ */
+ allowWithoutSanitization?: boolean;
+ /**
+ * For "fullscreen" permission, must specify allowWithoutGesture:true.
+ */
+ allowWithoutGesture?: boolean;
+ /**
+ * For "camera" permission, may specify panTiltZoom.
+ */
+ panTiltZoom?: boolean;
}
- }
-
- /**
- * This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
-have an associated `id` used in subsequent operations on the related object. Each object type has
-a specific `id` structure, and those are not interchangeable between objects of different kinds.
-CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
-can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
-subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
- */
- export module CSS {
- export type StyleSheetId = string;
/**
- * Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
-stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
-inspector" rules), "regular" for regular stylesheets.
+ * Browser command ids used by executeBrowserCommand.
*/
- export type StyleSheetOrigin = "injected"|"user-agent"|"inspector"|"regular";
+ export type BrowserCommandId = "openTabSearch"|"closeTabSearch"|"openGlic";
/**
- * CSS rule collection for a single pseudo style.
+ * Chrome histogram bucket.
*/
- export interface PseudoElementMatches {
+ export interface Bucket {
/**
- * Pseudo element type.
+ * Minimum value (inclusive).
*/
- pseudoType: DOM.PseudoType;
+ low: number;
/**
- * Pseudo element custom ident.
+ * Maximum value (exclusive).
*/
- pseudoIdentifier?: string;
+ high: number;
/**
- * Matches of CSS rules applicable to the pseudo style.
+ * Number of samples.
*/
- matches: RuleMatch[];
+ count: number;
}
/**
- * CSS style coming from animations with the name of the animation.
+ * Chrome histogram.
*/
- export interface CSSAnimationStyle {
+ export interface Histogram {
/**
- * The name of the animation.
+ * Name.
*/
- name?: string;
+ name: string;
/**
- * The style coming from the animation.
+ * Sum of sample values.
*/
- style: CSSStyle;
- }
- /**
- * Inherited CSS rule collection from ancestor node.
- */
- export interface InheritedStyleEntry {
+ sum: number;
/**
- * The ancestor node's inline style, if any, in the style inheritance chain.
+ * Total number of samples.
*/
- inlineStyle?: CSSStyle;
+ count: number;
/**
- * Matches of CSS rules matching the ancestor node in the style inheritance chain.
+ * Buckets.
*/
- matchedCSSRules: RuleMatch[];
+ buckets: Bucket[];
}
+ export type PrivacySandboxAPI = "BiddingAndAuctionServices"|"TrustedKeyValue";
+
/**
- * Inherited CSS style collection for animated styles from ancestor node.
+ * Fired when page is about to start a download.
*/
- export interface InheritedAnimatedStyleEntry {
+ export type downloadWillBeginPayload = {
/**
- * Styles coming from the animations of the ancestor, if any, in the style inheritance chain.
+ * Id of the frame that caused the download to begin.
*/
- animationStyles?: CSSAnimationStyle[];
+ frameId: Page.FrameId;
/**
- * The style coming from the transitions of the ancestor, if any, in the style inheritance chain.
+ * Global unique identifier of the download.
*/
- transitionsStyle?: CSSStyle;
- }
- /**
- * Inherited pseudo element matches from pseudos of an ancestor node.
- */
- export interface InheritedPseudoElementMatches {
+ guid: string;
/**
- * Matches of pseudo styles from the pseudos of an ancestor node.
+ * URL of the resource being downloaded.
*/
- pseudoElements: PseudoElementMatches[];
+ url: string;
+ /**
+ * Suggested file name of the resource (the actual name of the file saved on disk may differ).
+ */
+ suggestedFilename: string;
}
/**
- * Match data for a CSS rule.
+ * Fired when download makes progress. Last call has |done| == true.
*/
- export interface RuleMatch {
+ export type downloadProgressPayload = {
/**
- * CSS rule in the match.
+ * Global unique identifier of the download.
*/
- rule: CSSRule;
+ guid: string;
/**
- * Matching selector indices in the rule's selectorList selectors (0-based).
+ * Total expected bytes to download.
*/
- matchingSelectors: number[];
- }
- /**
- * Data for a simple selector (these are delimited by commas in a selector list).
- */
- export interface Value {
+ totalBytes: number;
/**
- * Value text.
+ * Total bytes received.
*/
- text: string;
+ receivedBytes: number;
/**
- * Value range in the underlying resource (if available).
+ * Download status.
*/
- range?: SourceRange;
+ state: "inProgress"|"completed"|"canceled";
/**
- * Specificity of the selector.
+ * If download is "completed", provides the path of the downloaded file.
+Depending on the platform, it is not guaranteed to be set, nor the file
+is guaranteed to exist.
*/
- specificity?: Specificity;
+ filePath?: string;
}
+
/**
- * Specificity:
-https://drafts.csswg.org/selectors/#specificity-rules
+ * Set permission settings for given requesting and embedding origins.
*/
- export interface Specificity {
+ export type setPermissionParameters = {
/**
- * The a component, which represents the number of ID selectors.
+ * Descriptor of permission to override.
*/
- a: number;
+ permission: PermissionDescriptor;
/**
- * The b component, which represents the number of class selectors, attributes selectors, and
-pseudo-classes.
+ * Setting of the permission.
*/
- b: number;
+ setting: PermissionSetting;
/**
- * The c component, which represents the number of type selectors and pseudo-elements.
+ * Requesting origin the permission applies to, all origins if not specified.
*/
- c: number;
- }
- /**
- * Selector list data.
- */
- export interface SelectorList {
+ origin?: string;
/**
- * Selectors in the list.
+ * Embedding origin the permission applies to. It is ignored unless the requesting origin is
+present and valid. If the requesting origin is provided but the embedding origin isn't, the
+requesting origin is used as the embedding origin.
*/
- selectors: Value[];
+ embeddingOrigin?: string;
/**
- * Rule selector text.
+ * Context to override. When omitted, default browser context is used.
*/
- text: string;
+ browserContextId?: BrowserContextID;
+ }
+ export type setPermissionReturnValue = {
}
/**
- * CSS stylesheet metainformation.
+ * Grant specific permissions to the given origin and reject all others.
*/
- export interface CSSStyleSheetHeader {
+ export type grantPermissionsParameters = {
+ permissions: PermissionType[];
/**
- * The stylesheet identifier.
+ * Origin the permission applies to, all origins if not specified.
*/
- styleSheetId: StyleSheetId;
+ origin?: string;
/**
- * Owner frame identifier.
+ * BrowserContext to override permissions. When omitted, default browser context is used.
*/
- frameId: Page.FrameId;
+ browserContextId?: BrowserContextID;
+ }
+ export type grantPermissionsReturnValue = {
+ }
+ /**
+ * Reset all permission management for all origins.
+ */
+ export type resetPermissionsParameters = {
/**
- * Stylesheet resource URL. Empty if this is a constructed stylesheet created using
-new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported
-as a CSS module script).
+ * BrowserContext to reset permissions. When omitted, default browser context is used.
*/
- sourceURL: string;
+ browserContextId?: BrowserContextID;
+ }
+ export type resetPermissionsReturnValue = {
+ }
+ /**
+ * Set the behavior when downloading a file.
+ */
+ export type setDownloadBehaviorParameters = {
/**
- * URL of source map associated with the stylesheet (if any).
+ * Whether to allow all or deny all download requests, or use default Chrome behavior if
+available (otherwise deny). |allowAndName| allows download and names files according to
+their download guids.
*/
- sourceMapURL?: string;
+ behavior: "deny"|"allow"|"allowAndName"|"default";
/**
- * Stylesheet origin.
+ * BrowserContext to set download behavior. When omitted, default browser context is used.
*/
- origin: StyleSheetOrigin;
+ browserContextId?: BrowserContextID;
/**
- * Stylesheet title.
+ * The default path to save downloaded files to. This is required if behavior is set to 'allow'
+or 'allowAndName'.
*/
- title: string;
+ downloadPath?: string;
/**
- * The backend id for the owner node of the stylesheet.
+ * Whether to emit download events (defaults to false).
*/
- ownerNode?: DOM.BackendNodeId;
+ eventsEnabled?: boolean;
+ }
+ export type setDownloadBehaviorReturnValue = {
+ }
+ /**
+ * Cancel a download if in progress
+ */
+ export type cancelDownloadParameters = {
/**
- * Denotes whether the stylesheet is disabled.
+ * Global unique identifier of the download.
*/
- disabled: boolean;
+ guid: string;
/**
- * Whether the sourceURL field value comes from the sourceURL comment.
+ * BrowserContext to perform the action in. When omitted, default browser context is used.
*/
- hasSourceURL?: boolean;
+ browserContextId?: BrowserContextID;
+ }
+ export type cancelDownloadReturnValue = {
+ }
+ /**
+ * Close browser gracefully.
+ */
+ export type closeParameters = {
+ }
+ export type closeReturnValue = {
+ }
+ /**
+ * Crashes browser on the main thread.
+ */
+ export type crashParameters = {
+ }
+ export type crashReturnValue = {
+ }
+ /**
+ * Crashes GPU process.
+ */
+ export type crashGpuProcessParameters = {
+ }
+ export type crashGpuProcessReturnValue = {
+ }
+ /**
+ * Returns version information.
+ */
+ export type getVersionParameters = {
+ }
+ export type getVersionReturnValue = {
/**
- * Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
-document.written STYLE tags.
+ * Protocol version.
*/
- isInline: boolean;
+ protocolVersion: string;
/**
- * Whether this stylesheet is mutable. Inline stylesheets become mutable
-after they have been modified via CSSOM API.
-`<link>` element's stylesheets become mutable only if DevTools modifies them.
-Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
+ * Product name.
*/
- isMutable: boolean;
+ product: string;
/**
- * True if this stylesheet is created through new CSSStyleSheet() or imported as a
-CSS module script.
+ * Product revision.
*/
- isConstructed: boolean;
+ revision: string;
/**
- * Line offset of the stylesheet within the resource (zero based).
+ * User-Agent.
*/
- startLine: number;
+ userAgent: string;
/**
- * Column offset of the stylesheet within the resource (zero based).
+ * V8 version.
*/
- startColumn: number;
+ jsVersion: string;
+ }
+ /**
+ * Returns the command line switches for the browser process if, and only if
+--enable-automation is on the commandline.
+ */
+ export type getBrowserCommandLineParameters = {
+ }
+ export type getBrowserCommandLineReturnValue = {
/**
- * Size of the content (in characters).
+ * Commandline parameters
*/
- length: number;
+ arguments: string[];
+ }
+ /**
+ * Get Chrome histograms.
+ */
+ export type getHistogramsParameters = {
/**
- * Line offset of the end of the stylesheet within the resource (zero based).
+ * Requested substring in name. Only histograms which have query as a
+substring in their name are extracted. An empty or absent query returns
+all histograms.
*/
- endLine: number;
+ query?: string;
/**
- * Column offset of the end of the stylesheet within the resource (zero based).
+ * If true, retrieve delta since last delta call.
*/
- endColumn: number;
+ delta?: boolean;
+ }
+ export type getHistogramsReturnValue = {
/**
- * If the style sheet was loaded from a network resource, this indicates when the resource failed to load
+ * Histograms.
*/
- loadingFailed?: boolean;
+ histograms: Histogram[];
}
/**
- * CSS rule representation.
+ * Get a Chrome histogram by name.
*/
- export interface CSSRule {
+ export type getHistogramParameters = {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Requested histogram name.
*/
- styleSheetId?: StyleSheetId;
+ name: string;
/**
- * Rule selector data.
+ * If true, retrieve delta since last delta call.
*/
- selectorList: SelectorList;
+ delta?: boolean;
+ }
+ export type getHistogramReturnValue = {
/**
- * Array of selectors from ancestor style rules, sorted by distance from the current rule.
+ * Histogram.
*/
- nestingSelectors?: string[];
- /**
- * Parent stylesheet's origin.
- */
- origin: StyleSheetOrigin;
- /**
- * Associated style declaration.
- */
- style: CSSStyle;
+ histogram: Histogram;
+ }
+ /**
+ * Get position and size of the browser window.
+ */
+ export type getWindowBoundsParameters = {
/**
- * Media list array (for rules involving media queries). The array enumerates media queries
-starting with the innermost one, going outwards.
+ * Browser window id.
*/
- media?: CSSMedia[];
+ windowId: WindowID;
+ }
+ export type getWindowBoundsReturnValue = {
/**
- * Container query list array (for rules involving container queries).
-The array enumerates container queries starting with the innermost one, going outwards.
+ * Bounds information of the window. When window state is 'minimized', the restored window
+position and size are returned.
*/
- containerQueries?: CSSContainerQuery[];
+ bounds: Bounds;
+ }
+ /**
+ * Get the browser window that contains the devtools target.
+ */
+ export type getWindowForTargetParameters = {
/**
- * @supports CSS at-rule array.
-The array enumerates @supports at-rules starting with the innermost one, going outwards.
+ * Devtools agent host id. If called as a part of the session, associated targetId is used.
*/
- supports?: CSSSupports[];
+ targetId?: Target.TargetID;
+ }
+ export type getWindowForTargetReturnValue = {
/**
- * Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
-with the innermost layer and going outwards.
+ * Browser window id.
*/
- layers?: CSSLayer[];
+ windowId: WindowID;
/**
- * @scope CSS at-rule array.
-The array enumerates @scope at-rules starting with the innermost one, going outwards.
+ * Bounds information of the window. When window state is 'minimized', the restored window
+position and size are returned.
*/
- scopes?: CSSScope[];
+ bounds: Bounds;
+ }
+ /**
+ * Set position and/or size of the browser window.
+ */
+ export type setWindowBoundsParameters = {
/**
- * The array keeps the types of ancestor CSSRules from the innermost going outwards.
+ * Browser window id.
*/
- ruleTypes?: CSSRuleType[];
+ windowId: WindowID;
/**
- * @starting-style CSS at-rule array.
-The array enumerates @starting-style at-rules starting with the innermost one, going outwards.
+ * New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
+with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
*/
- startingStyles?: CSSStartingStyle[];
+ bounds: Bounds;
+ }
+ export type setWindowBoundsReturnValue = {
}
/**
- * Enum indicating the type of a CSS rule, used to represent the order of a style rule's ancestors.
-This list only contains rule types that are collected during the ancestor rule collection.
- */
- export type CSSRuleType = "MediaRule"|"SupportsRule"|"ContainerRule"|"LayerRule"|"ScopeRule"|"StyleRule"|"StartingStyleRule";
- /**
- * CSS coverage information.
+ * Set size of the browser contents resizing browser window as necessary.
*/
- export interface RuleUsage {
+ export type setContentsSizeParameters = {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Browser window id.
*/
- styleSheetId: StyleSheetId;
+ windowId: WindowID;
/**
- * Offset of the start of the rule (including selector) from the beginning of the stylesheet.
+ * The window contents width in DIP. Assumes current width if omitted.
+Must be specified if 'height' is omitted.
*/
- startOffset: number;
+ width?: number;
/**
- * Offset of the end of the rule body from the beginning of the stylesheet.
+ * The window contents height in DIP. Assumes current height if omitted.
+Must be specified if 'width' is omitted.
*/
- endOffset: number;
+ height?: number;
+ }
+ export type setContentsSizeReturnValue = {
+ }
+ /**
+ * Set dock tile details, platform-specific.
+ */
+ export type setDockTileParameters = {
+ badgeLabel?: string;
/**
- * Indicates whether the rule was actually used by some element in the page.
+ * Png encoded image.
*/
- used: boolean;
+ image?: binary;
+ }
+ export type setDockTileReturnValue = {
}
/**
- * Text range within a resource. All numbers are zero-based.
+ * Invoke custom browser commands used by telemetry.
*/
- export interface SourceRange {
+ export type executeBrowserCommandParameters = {
+ commandId: BrowserCommandId;
+ }
+ export type executeBrowserCommandReturnValue = {
+ }
+ /**
+ * Allows a site to use privacy sandbox features that require enrollment
+without the site actually being enrolled. Only supported on page targets.
+ */
+ export type addPrivacySandboxEnrollmentOverrideParameters = {
+ url: string;
+ }
+ export type addPrivacySandboxEnrollmentOverrideReturnValue = {
+ }
+ /**
+ * Configures encryption keys used with a given privacy sandbox API to talk
+to a trusted coordinator. Since this is intended for test automation only,
+coordinatorOrigin must be a .test domain. No existing coordinator
+configuration for the origin may exist.
+ */
+ export type addPrivacySandboxCoordinatorKeyConfigParameters = {
+ api: PrivacySandboxAPI;
+ coordinatorOrigin: string;
+ keyConfig: string;
/**
- * Start line of range.
+ * BrowserContext to perform the action in. When omitted, default browser
+context is used.
*/
- startLine: number;
+ browserContextId?: BrowserContextID;
+ }
+ export type addPrivacySandboxCoordinatorKeyConfigReturnValue = {
+ }
+ }
+
+ /**
+ * This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
+have an associated `id` used in subsequent operations on the related object. Each object type has
+a specific `id` structure, and those are not interchangeable between objects of different kinds.
+CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
+can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
+subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
+ */
+ export module CSS {
+ export type StyleSheetId = string;
+ /**
+ * Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
+stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
+inspector" rules), "regular" for regular stylesheets.
+ */
+ export type StyleSheetOrigin = "injected"|"user-agent"|"inspector"|"regular";
+ /**
+ * CSS rule collection for a single pseudo style.
+ */
+ export interface PseudoElementMatches {
/**
- * Start column of range (inclusive).
+ * Pseudo element type.
*/
- startColumn: number;
+ pseudoType: DOM.PseudoType;
/**
- * End line of range
+ * Pseudo element custom ident.
*/
- endLine: number;
+ pseudoIdentifier?: string;
/**
- * End column of range (exclusive).
+ * Matches of CSS rules applicable to the pseudo style.
*/
- endColumn: number;
+ matches: RuleMatch[];
}
- export interface ShorthandEntry {
- /**
- * Shorthand name.
- */
- name: string;
+ /**
+ * CSS style coming from animations with the name of the animation.
+ */
+ export interface CSSAnimationStyle {
/**
- * Shorthand value.
+ * The name of the animation.
*/
- value: string;
+ name?: string;
/**
- * Whether the property has "!important" annotation (implies `false` if absent).
+ * The style coming from the animation.
*/
- important?: boolean;
+ style: CSSStyle;
}
- export interface CSSComputedStyleProperty {
+ /**
+ * Inherited CSS rule collection from ancestor node.
+ */
+ export interface InheritedStyleEntry {
/**
- * Computed style property name.
+ * The ancestor node's inline style, if any, in the style inheritance chain.
*/
- name: string;
+ inlineStyle?: CSSStyle;
/**
- * Computed style property value.
+ * Matches of CSS rules matching the ancestor node in the style inheritance chain.
*/
- value: string;
+ matchedCSSRules: RuleMatch[];
}
/**
- * CSS style representation.
+ * Inherited CSS style collection for animated styles from ancestor node.
*/
- export interface CSSStyle {
+ export interface InheritedAnimatedStyleEntry {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Styles coming from the animations of the ancestor, if any, in the style inheritance chain.
*/
- styleSheetId?: StyleSheetId;
+ animationStyles?: CSSAnimationStyle[];
/**
- * CSS properties in the style.
+ * The style coming from the transitions of the ancestor, if any, in the style inheritance chain.
*/
- cssProperties: CSSProperty[];
+ transitionsStyle?: CSSStyle;
+ }
+ /**
+ * Inherited pseudo element matches from pseudos of an ancestor node.
+ */
+ export interface InheritedPseudoElementMatches {
/**
- * Computed values for all shorthands found in the style.
+ * Matches of pseudo styles from the pseudos of an ancestor node.
*/
- shorthandEntries: ShorthandEntry[];
+ pseudoElements: PseudoElementMatches[];
+ }
+ /**
+ * Match data for a CSS rule.
+ */
+ export interface RuleMatch {
/**
- * Style declaration text (if available).
+ * CSS rule in the match.
*/
- cssText?: string;
+ rule: CSSRule;
/**
- * Style declaration range in the enclosing stylesheet (if available).
+ * Matching selector indices in the rule's selectorList selectors (0-based).
*/
- range?: SourceRange;
+ matchingSelectors: number[];
}
/**
- * CSS property declaration data.
+ * Data for a simple selector (these are delimited by commas in a selector list).
*/
- export interface CSSProperty {
- /**
- * The property name.
- */
- name: string;
+ export interface Value {
/**
- * The property value.
+ * Value text.
*/
- value: string;
+ text: string;
/**
- * Whether the property has "!important" annotation (implies `false` if absent).
+ * Value range in the underlying resource (if available).
*/
- important?: boolean;
+ range?: SourceRange;
/**
- * Whether the property is implicit (implies `false` if absent).
+ * Specificity of the selector.
*/
- implicit?: boolean;
+ specificity?: Specificity;
+ }
+ /**
+ * Specificity:
+https://drafts.csswg.org/selectors/#specificity-rules
+ */
+ export interface Specificity {
/**
- * The full property text as specified in the style.
+ * The a component, which represents the number of ID selectors.
*/
- text?: string;
+ a: number;
/**
- * Whether the property is understood by the browser (implies `true` if absent).
+ * The b component, which represents the number of class selectors, attributes selectors, and
+pseudo-classes.
*/
- parsedOk?: boolean;
+ b: number;
/**
- * Whether the property is disabled by the user (present for source-based properties only).
+ * The c component, which represents the number of type selectors and pseudo-elements.
*/
- disabled?: boolean;
+ c: number;
+ }
+ /**
+ * Selector list data.
+ */
+ export interface SelectorList {
/**
- * The entire property range in the enclosing style declaration (if available).
+ * Selectors in the list.
*/
- range?: SourceRange;
+ selectors: Value[];
/**
- * Parsed longhand components of this property if it is a shorthand.
-This field will be empty if the given property is not a shorthand.
+ * Rule selector text.
*/
- longhandProperties?: CSSProperty[];
+ text: string;
}
/**
- * CSS media rule descriptor.
+ * CSS stylesheet metainformation.
*/
- export interface CSSMedia {
+ export interface CSSStyleSheetHeader {
/**
- * Media query text.
+ * The stylesheet identifier.
*/
- text: string;
+ styleSheetId: StyleSheetId;
/**
- * Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
-specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
-stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
-stylesheet's STYLE tag.
+ * Owner frame identifier.
*/
- source: "mediaRule"|"importRule"|"linkedSheet"|"inlineSheet";
+ frameId: Page.FrameId;
/**
- * URL of the document containing the media query description.
+ * Stylesheet resource URL. Empty if this is a constructed stylesheet created using
+new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported
+as a CSS module script).
*/
- sourceURL?: string;
+ sourceURL: string;
/**
- * The associated rule (@media or @import) header range in the enclosing stylesheet (if
-available).
+ * URL of source map associated with the stylesheet (if any).
*/
- range?: SourceRange;
+ sourceMapURL?: string;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Stylesheet origin.
*/
- styleSheetId?: StyleSheetId;
+ origin: StyleSheetOrigin;
/**
- * Array of media queries.
+ * Stylesheet title.
*/
- mediaList?: MediaQuery[];
- }
- /**
- * Media query descriptor.
- */
- export interface MediaQuery {
+ title: string;
/**
- * Array of media query expressions.
+ * The backend id for the owner node of the stylesheet.
*/
- expressions: MediaQueryExpression[];
+ ownerNode?: DOM.BackendNodeId;
/**
- * Whether the media query condition is satisfied.
+ * Denotes whether the stylesheet is disabled.
*/
- active: boolean;
- }
- /**
- * Media query expression descriptor.
- */
- export interface MediaQueryExpression {
+ disabled: boolean;
/**
- * Media query expression value.
+ * Whether the sourceURL field value comes from the sourceURL comment.
*/
- value: number;
+ hasSourceURL?: boolean;
/**
- * Media query expression units.
+ * Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
+document.written STYLE tags.
*/
- unit: string;
+ isInline: boolean;
/**
- * Media query expression feature.
+ * Whether this stylesheet is mutable. Inline stylesheets become mutable
+after they have been modified via CSSOM API.
+`<link>` element's stylesheets become mutable only if DevTools modifies them.
+Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
*/
- feature: string;
+ isMutable: boolean;
/**
- * The associated range of the value text in the enclosing stylesheet (if available).
+ * True if this stylesheet is created through new CSSStyleSheet() or imported as a
+CSS module script.
*/
- valueRange?: SourceRange;
+ isConstructed: boolean;
/**
- * Computed length of media query expression (if applicable).
+ * Line offset of the stylesheet within the resource (zero based).
*/
- computedLength?: number;
+ startLine: number;
+ /**
+ * Column offset of the stylesheet within the resource (zero based).
+ */
+ startColumn: number;
+ /**
+ * Size of the content (in characters).
+ */
+ length: number;
+ /**
+ * Line offset of the end of the stylesheet within the resource (zero based).
+ */
+ endLine: number;
+ /**
+ * Column offset of the end of the stylesheet within the resource (zero based).
+ */
+ endColumn: number;
+ /**
+ * If the style sheet was loaded from a network resource, this indicates when the resource failed to load
+ */
+ loadingFailed?: boolean;
}
/**
- * CSS container query rule descriptor.
+ * CSS rule representation.
*/
- export interface CSSContainerQuery {
+ export interface CSSRule {
/**
- * Container query text.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- text: string;
+ styleSheetId?: StyleSheetId;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Rule selector data.
*/
- range?: SourceRange;
+ selectorList: SelectorList;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Array of selectors from ancestor style rules, sorted by distance from the current rule.
*/
- styleSheetId?: StyleSheetId;
+ nestingSelectors?: string[];
/**
- * Optional name for the container.
+ * Parent stylesheet's origin.
*/
- name?: string;
+ origin: StyleSheetOrigin;
/**
- * Optional physical axes queried for the container.
+ * Associated style declaration.
*/
- physicalAxes?: DOM.PhysicalAxes;
+ style: CSSStyle;
/**
- * Optional logical axes queried for the container.
+ * Media list array (for rules involving media queries). The array enumerates media queries
+starting with the innermost one, going outwards.
*/
- logicalAxes?: DOM.LogicalAxes;
+ media?: CSSMedia[];
/**
- * true if the query contains scroll-state() queries.
+ * Container query list array (for rules involving container queries).
+The array enumerates container queries starting with the innermost one, going outwards.
*/
- queriesScrollState?: boolean;
+ containerQueries?: CSSContainerQuery[];
/**
- * true if the query contains anchored() queries.
+ * @supports CSS at-rule array.
+The array enumerates @supports at-rules starting with the innermost one, going outwards.
*/
- queriesAnchored?: boolean;
- }
- /**
- * CSS Supports at-rule descriptor.
- */
- export interface CSSSupports {
+ supports?: CSSSupports[];
/**
- * Supports rule text.
+ * Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
+with the innermost layer and going outwards.
*/
- text: string;
+ layers?: CSSLayer[];
/**
- * Whether the supports condition is satisfied.
+ * @scope CSS at-rule array.
+The array enumerates @scope at-rules starting with the innermost one, going outwards.
*/
- active: boolean;
+ scopes?: CSSScope[];
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * The array keeps the types of ancestor CSSRules from the innermost going outwards.
*/
- range?: SourceRange;
+ ruleTypes?: CSSRuleType[];
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * @starting-style CSS at-rule array.
+The array enumerates @starting-style at-rules starting with the innermost one, going outwards.
*/
- styleSheetId?: StyleSheetId;
+ startingStyles?: CSSStartingStyle[];
}
/**
- * CSS Scope at-rule descriptor.
+ * Enum indicating the type of a CSS rule, used to represent the order of a style rule's ancestors.
+This list only contains rule types that are collected during the ancestor rule collection.
*/
- export interface CSSScope {
+ export type CSSRuleType = "MediaRule"|"SupportsRule"|"ContainerRule"|"LayerRule"|"ScopeRule"|"StyleRule"|"StartingStyleRule";
+ /**
+ * CSS coverage information.
+ */
+ export interface RuleUsage {
/**
- * Scope rule text.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- text: string;
+ styleSheetId: StyleSheetId;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Offset of the start of the rule (including selector) from the beginning of the stylesheet.
*/
- range?: SourceRange;
+ startOffset: number;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Offset of the end of the rule body from the beginning of the stylesheet.
*/
- styleSheetId?: StyleSheetId;
+ endOffset: number;
+ /**
+ * Indicates whether the rule was actually used by some element in the page.
+ */
+ used: boolean;
}
/**
- * CSS Layer at-rule descriptor.
+ * Text range within a resource. All numbers are zero-based.
*/
- export interface CSSLayer {
+ export interface SourceRange {
/**
- * Layer name.
+ * Start line of range.
*/
- text: string;
+ startLine: number;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Start column of range (inclusive).
*/
- range?: SourceRange;
+ startColumn: number;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * End line of range
*/
- styleSheetId?: StyleSheetId;
- }
- /**
- * CSS Starting Style at-rule descriptor.
- */
- export interface CSSStartingStyle {
+ endLine: number;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * End column of range (exclusive).
*/
- range?: SourceRange;
+ endColumn: number;
+ }
+ export interface ShorthandEntry {
/**
- * Identifier of the stylesheet containing this object (if exists).
- */
- styleSheetId?: StyleSheetId;
- }
- /**
- * CSS Layer data.
- */
- export interface CSSLayerData {
- /**
- * Layer name.
+ * Shorthand name.
*/
name: string;
/**
- * Direct sub-layers
+ * Shorthand value.
*/
- subLayers?: CSSLayerData[];
+ value: string;
/**
- * Layer order. The order determines the order of the layer in the cascade order.
-A higher number has higher priority in the cascade order.
+ * Whether the property has "!important" annotation (implies `false` if absent).
*/
- order: number;
+ important?: boolean;
}
- /**
- * Information about amount of glyphs that were rendered with given font.
- */
- export interface PlatformFontUsage {
- /**
- * Font's family name reported by platform.
- */
- familyName: string;
+ export interface CSSComputedStyleProperty {
/**
- * Font's PostScript name reported by platform.
+ * Computed style property name.
*/
- postScriptName: string;
+ name: string;
/**
- * Indicates if the font was downloaded or resolved locally.
+ * Computed style property value.
*/
- isCustomFont: boolean;
+ value: string;
+ }
+ export interface ComputedStyleExtraFields {
/**
- * Amount of glyphs that were rendered with this font.
+ * Returns whether or not this node is being rendered with base appearance,
+which happens when it has its appearance property set to base/base-select
+or it is in the subtree of an element being rendered with base appearance.
*/
- glyphCount: number;
+ isAppearanceBase: boolean;
}
/**
- * Information about font variation axes for variable fonts
+ * CSS style representation.
*/
- export interface FontVariationAxis {
+ export interface CSSStyle {
/**
- * The font-variation-setting tag (a.k.a. "axis tag").
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- tag: string;
+ styleSheetId?: StyleSheetId;
/**
- * Human-readable variation name in the default language (normally, "en").
+ * CSS properties in the style.
*/
- name: string;
+ cssProperties: CSSProperty[];
/**
- * The minimum value (inclusive) the font supports for this tag.
+ * Computed values for all shorthands found in the style.
*/
- minValue: number;
+ shorthandEntries: ShorthandEntry[];
/**
- * The maximum value (inclusive) the font supports for this tag.
+ * Style declaration text (if available).
*/
- maxValue: number;
+ cssText?: string;
/**
- * The default value.
+ * Style declaration range in the enclosing stylesheet (if available).
*/
- defaultValue: number;
+ range?: SourceRange;
}
/**
- * Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
-and additional information such as platformFontFamily and fontVariationAxes.
+ * CSS property declaration data.
*/
- export interface FontFace {
- /**
- * The font-family.
- */
- fontFamily: string;
+ export interface CSSProperty {
/**
- * The font-style.
+ * The property name.
*/
- fontStyle: string;
+ name: string;
/**
- * The font-variant.
+ * The property value.
*/
- fontVariant: string;
+ value: string;
/**
- * The font-weight.
+ * Whether the property has "!important" annotation (implies `false` if absent).
*/
- fontWeight: string;
+ important?: boolean;
/**
- * The font-stretch.
+ * Whether the property is implicit (implies `false` if absent).
*/
- fontStretch: string;
+ implicit?: boolean;
/**
- * The font-display.
+ * The full property text as specified in the style.
*/
- fontDisplay: string;
+ text?: string;
/**
- * The unicode-range.
+ * Whether the property is understood by the browser (implies `true` if absent).
*/
- unicodeRange: string;
+ parsedOk?: boolean;
/**
- * The src.
+ * Whether the property is disabled by the user (present for source-based properties only).
*/
- src: string;
+ disabled?: boolean;
/**
- * The resolved platform font family
+ * The entire property range in the enclosing style declaration (if available).
*/
- platformFontFamily: string;
+ range?: SourceRange;
/**
- * Available variation settings (a.k.a. "axes").
+ * Parsed longhand components of this property if it is a shorthand.
+This field will be empty if the given property is not a shorthand.
*/
- fontVariationAxes?: FontVariationAxis[];
+ longhandProperties?: CSSProperty[];
}
/**
- * CSS try rule representation.
+ * CSS media rule descriptor.
*/
- export interface CSSTryRule {
+ export interface CSSMedia {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Media query text.
*/
- styleSheetId?: StyleSheetId;
+ text: string;
/**
- * Parent stylesheet's origin.
+ * Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
+specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
+stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
+stylesheet's STYLE tag.
*/
- origin: StyleSheetOrigin;
+ source: "mediaRule"|"importRule"|"linkedSheet"|"inlineSheet";
/**
- * Associated style declaration.
+ * URL of the document containing the media query description.
*/
- style: CSSStyle;
- }
- /**
- * CSS @position-try rule representation.
- */
- export interface CSSPositionTryRule {
+ sourceURL?: string;
/**
- * The prelude dashed-ident name
+ * The associated rule (@media or @import) header range in the enclosing stylesheet (if
+available).
*/
- name: Value;
+ range?: SourceRange;
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
/**
- * Parent stylesheet's origin.
- */
- origin: StyleSheetOrigin;
- /**
- * Associated style declaration.
+ * Array of media queries.
*/
- style: CSSStyle;
- active: boolean;
+ mediaList?: MediaQuery[];
}
/**
- * CSS keyframes rule representation.
+ * Media query descriptor.
*/
- export interface CSSKeyframesRule {
+ export interface MediaQuery {
/**
- * Animation name.
+ * Array of media query expressions.
*/
- animationName: Value;
+ expressions: MediaQueryExpression[];
/**
- * List of keyframes.
+ * Whether the media query condition is satisfied.
*/
- keyframes: CSSKeyframeRule[];
- }
- /**
- * Representation of a custom property registration through CSS.registerProperty
- */
- export interface CSSPropertyRegistration {
- propertyName: string;
- initialValue?: Value;
- inherits: boolean;
- syntax: string;
+ active: boolean;
}
/**
- * CSS font-palette-values rule representation.
+ * Media query expression descriptor.
*/
- export interface CSSFontPaletteValuesRule {
+ export interface MediaQueryExpression {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Media query expression value.
*/
- styleSheetId?: StyleSheetId;
+ value: number;
/**
- * Parent stylesheet's origin.
+ * Media query expression units.
*/
- origin: StyleSheetOrigin;
+ unit: string;
/**
- * Associated font palette name.
+ * Media query expression feature.
*/
- fontPaletteName: Value;
+ feature: string;
/**
- * Associated style declaration.
+ * The associated range of the value text in the enclosing stylesheet (if available).
*/
- style: CSSStyle;
+ valueRange?: SourceRange;
+ /**
+ * Computed length of media query expression (if applicable).
+ */
+ computedLength?: number;
}
/**
- * CSS property at-rule representation.
+ * CSS container query rule descriptor.
*/
- export interface CSSPropertyRule {
+ export interface CSSContainerQuery {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Container query text.
+ */
+ text: string;
+ /**
+ * The associated rule header range in the enclosing stylesheet (if
+available).
+ */
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
/**
- * Parent stylesheet's origin.
+ * Optional name for the container.
*/
- origin: StyleSheetOrigin;
+ name?: string;
/**
- * Associated property name.
+ * Optional physical axes queried for the container.
*/
- propertyName: Value;
+ physicalAxes?: DOM.PhysicalAxes;
/**
- * Associated style declaration.
+ * Optional logical axes queried for the container.
*/
- style: CSSStyle;
- }
- /**
- * CSS function argument representation.
- */
- export interface CSSFunctionParameter {
+ logicalAxes?: DOM.LogicalAxes;
/**
- * The parameter name.
+ * true if the query contains scroll-state() queries.
*/
- name: string;
+ queriesScrollState?: boolean;
/**
- * The parameter type.
+ * true if the query contains anchored() queries.
*/
- type: string;
+ queriesAnchored?: boolean;
}
/**
- * CSS function conditional block representation.
+ * CSS Supports at-rule descriptor.
*/
- export interface CSSFunctionConditionNode {
+ export interface CSSSupports {
/**
- * Media query for this conditional block. Only one type of condition should be set.
+ * Supports rule text.
*/
- media?: CSSMedia;
+ text: string;
/**
- * Container query for this conditional block. Only one type of condition should be set.
+ * Whether the supports condition is satisfied.
*/
- containerQueries?: CSSContainerQuery;
+ active: boolean;
/**
- * @supports CSS at-rule condition. Only one type of condition should be set.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- supports?: CSSSupports;
+ range?: SourceRange;
/**
- * Block body.
+ * Identifier of the stylesheet containing this object (if exists).
*/
- children: CSSFunctionNode[];
+ styleSheetId?: StyleSheetId;
+ }
+ /**
+ * CSS Scope at-rule descriptor.
+ */
+ export interface CSSScope {
/**
- * The condition text.
+ * Scope rule text.
*/
- conditionText: string;
+ text: string;
+ /**
+ * The associated rule header range in the enclosing stylesheet (if
+available).
+ */
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
+ */
+ styleSheetId?: StyleSheetId;
}
/**
- * Section of the body of a CSS function rule.
+ * CSS Layer at-rule descriptor.
*/
- export interface CSSFunctionNode {
+ export interface CSSLayer {
/**
- * A conditional block. If set, style should not be set.
+ * Layer name.
*/
- condition?: CSSFunctionConditionNode;
+ text: string;
/**
- * Values set by this node. If set, condition should not be set.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- style?: CSSStyle;
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
+ */
+ styleSheetId?: StyleSheetId;
}
/**
- * CSS function at-rule representation.
+ * CSS Starting Style at-rule descriptor.
*/
- export interface CSSFunctionRule {
+ export interface CSSStartingStyle {
/**
- * Name of the function.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- name: Value;
+ range?: SourceRange;
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
+ }
+ /**
+ * CSS Layer data.
+ */
+ export interface CSSLayerData {
/**
- * Parent stylesheet's origin.
+ * Layer name.
*/
- origin: StyleSheetOrigin;
+ name: string;
/**
- * List of parameters.
+ * Direct sub-layers
*/
- parameters: CSSFunctionParameter[];
+ subLayers?: CSSLayerData[];
/**
- * Function body.
+ * Layer order. The order determines the order of the layer in the cascade order.
+A higher number has higher priority in the cascade order.
*/
- children: CSSFunctionNode[];
+ order: number;
}
/**
- * CSS keyframe rule representation.
+ * Information about amount of glyphs that were rendered with given font.
*/
- export interface CSSKeyframeRule {
+ export interface PlatformFontUsage {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Font's family name reported by platform.
*/
- styleSheetId?: StyleSheetId;
+ familyName: string;
/**
- * Parent stylesheet's origin.
+ * Font's PostScript name reported by platform.
*/
- origin: StyleSheetOrigin;
+ postScriptName: string;
/**
- * Associated key text.
+ * Indicates if the font was downloaded or resolved locally.
*/
- keyText: Value;
+ isCustomFont: boolean;
/**
- * Associated style declaration.
+ * Amount of glyphs that were rendered with this font.
*/
- style: CSSStyle;
+ glyphCount: number;
}
/**
- * A descriptor of operation to mutate style declaration text.
+ * Information about font variation axes for variable fonts
*/
- export interface StyleDeclarationEdit {
+ export interface FontVariationAxis {
/**
- * The css style sheet identifier.
+ * The font-variation-setting tag (a.k.a. "axis tag").
*/
- styleSheetId: StyleSheetId;
+ tag: string;
/**
- * The range of the style text in the enclosing stylesheet.
+ * Human-readable variation name in the default language (normally, "en").
*/
- range: SourceRange;
+ name: string;
/**
- * New style text.
+ * The minimum value (inclusive) the font supports for this tag.
*/
- text: string;
- }
-
- /**
- * Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
-web font.
- */
- export type fontsUpdatedPayload = {
+ minValue: number;
/**
- * The web font that has loaded.
+ * The maximum value (inclusive) the font supports for this tag.
*/
- font?: FontFace;
- }
- /**
- * Fires whenever a MediaQuery result changes (for example, after a browser window has been
-resized.) The current implementation considers only viewport-dependent media features.
- */
- export type mediaQueryResultChangedPayload = void;
- /**
- * Fired whenever an active document stylesheet is added.
- */
- export type styleSheetAddedPayload = {
+ maxValue: number;
/**
- * Added stylesheet metainfo.
+ * The default value.
*/
- header: CSSStyleSheetHeader;
- }
- /**
- * Fired whenever a stylesheet is changed as a result of the client operation.
- */
- export type styleSheetChangedPayload = {
- styleSheetId: StyleSheetId;
+ defaultValue: number;
}
/**
- * Fired whenever an active document stylesheet is removed.
+ * Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
+and additional information such as platformFontFamily and fontVariationAxes.
*/
- export type styleSheetRemovedPayload = {
+ export interface FontFace {
/**
- * Identifier of the removed stylesheet.
+ * The font-family.
*/
- styleSheetId: StyleSheetId;
- }
- export type computedStyleUpdatedPayload = {
+ fontFamily: string;
/**
- * The node id that has updated computed styles.
+ * The font-style.
*/
- nodeId: DOM.NodeId;
- }
-
- /**
- * Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
-position specified by `location`.
- */
- export type addRuleParameters = {
+ fontStyle: string;
/**
- * The css style sheet identifier where a new rule should be inserted.
+ * The font-variant.
*/
- styleSheetId: StyleSheetId;
+ fontVariant: string;
/**
- * The text of a new rule.
+ * The font-weight.
*/
- ruleText: string;
+ fontWeight: string;
/**
- * Text position of a new rule in the target style sheet.
+ * The font-stretch.
*/
- location: SourceRange;
+ fontStretch: string;
/**
- * NodeId for the DOM node in whose context custom property declarations for registered properties should be
-validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
-incorrect results if the declaration contains a var() for example.
+ * The font-display.
*/
- nodeForPropertySyntaxValidation?: DOM.NodeId;
- }
- export type addRuleReturnValue = {
+ fontDisplay: string;
/**
- * The newly created rule.
+ * The unicode-range.
*/
- rule: CSSRule;
+ unicodeRange: string;
+ /**
+ * The src.
+ */
+ src: string;
+ /**
+ * The resolved platform font family
+ */
+ platformFontFamily: string;
+ /**
+ * Available variation settings (a.k.a. "axes").
+ */
+ fontVariationAxes?: FontVariationAxis[];
}
/**
- * Returns all class names from specified stylesheet.
+ * CSS try rule representation.
*/
- export type collectClassNamesParameters = {
- styleSheetId: StyleSheetId;
- }
- export type collectClassNamesReturnValue = {
+ export interface CSSTryRule {
/**
- * Class name list.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- classNames: string[];
+ styleSheetId?: StyleSheetId;
+ /**
+ * Parent stylesheet's origin.
+ */
+ origin: StyleSheetOrigin;
+ /**
+ * Associated style declaration.
+ */
+ style: CSSStyle;
}
/**
- * Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
+ * CSS @position-try rule representation.
*/
- export type createStyleSheetParameters = {
+ export interface CSSPositionTryRule {
/**
- * Identifier of the frame where "via-inspector" stylesheet should be created.
+ * The prelude dashed-ident name
*/
- frameId: Page.FrameId;
+ name: Value;
/**
- * If true, creates a new stylesheet for every call. If false,
-returns a stylesheet previously created by a call with force=false
-for the frame's document if it exists or creates a new stylesheet
-(default: false).
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- force?: boolean;
- }
- export type createStyleSheetReturnValue = {
+ styleSheetId?: StyleSheetId;
/**
- * Identifier of the created "via-inspector" stylesheet.
+ * Parent stylesheet's origin.
*/
- styleSheetId: StyleSheetId;
+ origin: StyleSheetOrigin;
+ /**
+ * Associated style declaration.
+ */
+ style: CSSStyle;
+ active: boolean;
}
/**
- * Disables the CSS agent for the given page.
+ * CSS keyframes rule representation.
*/
- export type disableParameters = {
- }
- export type disableReturnValue = {
+ export interface CSSKeyframesRule {
+ /**
+ * Animation name.
+ */
+ animationName: Value;
+ /**
+ * List of keyframes.
+ */
+ keyframes: CSSKeyframeRule[];
}
/**
- * Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
-enabled until the result of this command is received.
+ * Representation of a custom property registration through CSS.registerProperty
*/
- export type enableParameters = {
- }
- export type enableReturnValue = {
+ export interface CSSPropertyRegistration {
+ propertyName: string;
+ initialValue?: Value;
+ inherits: boolean;
+ syntax: string;
}
/**
- * Ensures that the given node will have specified pseudo-classes whenever its style is computed by
-the browser.
+ * CSS font-palette-values rule representation.
*/
- export type forcePseudoStateParameters = {
+ export interface CSSFontPaletteValuesRule {
/**
- * The element id for which to force the pseudo state.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- nodeId: DOM.NodeId;
+ styleSheetId?: StyleSheetId;
/**
- * Element pseudo classes to force when computing the element's style.
+ * Parent stylesheet's origin.
*/
- forcedPseudoClasses: string[];
- }
- export type forcePseudoStateReturnValue = {
- }
- /**
- * Ensures that the given node is in its starting-style state.
- */
- export type forceStartingStyleParameters = {
+ origin: StyleSheetOrigin;
/**
- * The element id for which to force the starting-style state.
+ * Associated font palette name.
*/
- nodeId: DOM.NodeId;
+ fontPaletteName: Value;
/**
- * Boolean indicating if this is on or off.
+ * Associated style declaration.
*/
- forced: boolean;
- }
- export type forceStartingStyleReturnValue = {
+ style: CSSStyle;
}
- export type getBackgroundColorsParameters = {
+ /**
+ * CSS property at-rule representation.
+ */
+ export interface CSSPropertyRule {
/**
- * Id of the node to get background colors for.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- nodeId: DOM.NodeId;
- }
- export type getBackgroundColorsReturnValue = {
+ styleSheetId?: StyleSheetId;
/**
- * The range of background colors behind this element, if it contains any visible text. If no
-visible text is present, this will be undefined. In the case of a flat background color,
-this will consist of simply that color. In the case of a gradient, this will consist of each
-of the color stops. For anything more complicated, this will be an empty array. Images will
-be ignored (as if the image had failed to load).
+ * Parent stylesheet's origin.
*/
- backgroundColors?: string[];
+ origin: StyleSheetOrigin;
/**
- * The computed font size for this node, as a CSS computed value string (e.g. '12px').
+ * Associated property name.
*/
- computedFontSize?: string;
+ propertyName: Value;
/**
- * The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
-'100').
+ * Associated style declaration.
*/
- computedFontWeight?: string;
+ style: CSSStyle;
}
/**
- * Returns the computed style for a DOM node identified by `nodeId`.
+ * CSS function argument representation.
*/
- export type getComputedStyleForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getComputedStyleForNodeReturnValue = {
+ export interface CSSFunctionParameter {
/**
- * Computed style for the specified DOM node.
+ * The parameter name.
*/
- computedStyle: CSSComputedStyleProperty[];
+ name: string;
+ /**
+ * The parameter type.
+ */
+ type: string;
}
/**
- * Resolve the specified values in the context of the provided element.
-For example, a value of '1em' is evaluated according to the computed
-'font-size' of the element and a value 'calc(1px + 2px)' will be
-resolved to '3px'.
-If the `propertyName` was specified the `values` are resolved as if
-they were property's declaration. If a value cannot be parsed according
-to the provided property syntax, the value is parsed using combined
-syntax as if null `propertyName` was provided. If the value cannot be
-resolved even then, return the provided value without any changes.
+ * CSS function conditional block representation.
*/
- export type resolveValuesParameters = {
- /**
- * Substitution functions (var()/env()/attr()) and cascade-dependent
-keywords (revert/revert-layer) do not work.
- */
- values: string[];
- /**
- * Id of the node in whose context the expression is evaluated
- */
- nodeId: DOM.NodeId;
+ export interface CSSFunctionConditionNode {
/**
- * Only longhands and custom property names are accepted.
+ * Media query for this conditional block. Only one type of condition should be set.
*/
- propertyName?: string;
+ media?: CSSMedia;
/**
- * Pseudo element type, only works for pseudo elements that generate
-elements in the tree, such as ::before and ::after.
+ * Container query for this conditional block. Only one type of condition should be set.
*/
- pseudoType?: DOM.PseudoType;
+ containerQueries?: CSSContainerQuery;
/**
- * Pseudo element custom ident.
+ * @supports CSS at-rule condition. Only one type of condition should be set.
*/
- pseudoIdentifier?: string;
- }
- export type resolveValuesReturnValue = {
- results: string[];
- }
- export type getLonghandPropertiesParameters = {
- shorthandName: string;
- value: string;
- }
- export type getLonghandPropertiesReturnValue = {
- longhandProperties: CSSProperty[];
- }
- /**
- * Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
-attributes) for a DOM node identified by `nodeId`.
- */
- export type getInlineStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getInlineStylesForNodeReturnValue = {
+ supports?: CSSSupports;
/**
- * Inline style for the specified DOM node.
+ * Block body.
*/
- inlineStyle?: CSSStyle;
+ children: CSSFunctionNode[];
/**
- * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
+ * The condition text.
*/
- attributesStyle?: CSSStyle;
+ conditionText: string;
}
/**
- * Returns the styles coming from animations & transitions
-including the animation & transition styles coming from inheritance chain.
+ * Section of the body of a CSS function rule.
*/
- export type getAnimatedStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getAnimatedStylesForNodeReturnValue = {
- /**
- * Styles coming from animations.
- */
- animationStyles?: CSSAnimationStyle[];
+ export interface CSSFunctionNode {
/**
- * Style coming from transitions.
+ * A conditional block. If set, style should not be set.
*/
- transitionsStyle?: CSSStyle;
+ condition?: CSSFunctionConditionNode;
/**
- * Inherited style entries for animationsStyle and transitionsStyle from
-the inheritance chain of the element.
+ * Values set by this node. If set, condition should not be set.
*/
- inherited?: InheritedAnimatedStyleEntry[];
+ style?: CSSStyle;
}
/**
- * Returns requested styles for a DOM node identified by `nodeId`.
+ * CSS function at-rule representation.
*/
- export type getMatchedStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getMatchedStylesForNodeReturnValue = {
- /**
- * Inline style for the specified DOM node.
- */
- inlineStyle?: CSSStyle;
- /**
- * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
- */
- attributesStyle?: CSSStyle;
+ export interface CSSFunctionRule {
/**
- * CSS rules matching this node, from all applicable stylesheets.
+ * Name of the function.
*/
- matchedCSSRules?: RuleMatch[];
+ name: Value;
/**
- * Pseudo style matches for this node.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- pseudoElements?: PseudoElementMatches[];
+ styleSheetId?: StyleSheetId;
/**
- * A chain of inherited styles (from the immediate node parent up to the DOM tree root).
+ * Parent stylesheet's origin.
*/
- inherited?: InheritedStyleEntry[];
+ origin: StyleSheetOrigin;
/**
- * A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
+ * List of parameters.
*/
- inheritedPseudoElements?: InheritedPseudoElementMatches[];
+ parameters: CSSFunctionParameter[];
/**
- * A list of CSS keyframed animations matching this node.
+ * Function body.
*/
- cssKeyframesRules?: CSSKeyframesRule[];
+ children: CSSFunctionNode[];
+ }
+ /**
+ * CSS keyframe rule representation.
+ */
+ export interface CSSKeyframeRule {
/**
- * A list of CSS @position-try rules matching this node, based on the position-try-fallbacks property.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- cssPositionTryRules?: CSSPositionTryRule[];
+ styleSheetId?: StyleSheetId;
/**
- * Index of the active fallback in the applied position-try-fallback property,
-will not be set if there is no active position-try fallback.
+ * Parent stylesheet's origin.
*/
- activePositionFallbackIndex?: number;
+ origin: StyleSheetOrigin;
/**
- * A list of CSS at-property rules matching this node.
+ * Associated key text.
*/
- cssPropertyRules?: CSSPropertyRule[];
+ keyText: Value;
/**
- * A list of CSS property registrations matching this node.
+ * Associated style declaration.
*/
- cssPropertyRegistrations?: CSSPropertyRegistration[];
+ style: CSSStyle;
+ }
+ /**
+ * A descriptor of operation to mutate style declaration text.
+ */
+ export interface StyleDeclarationEdit {
/**
- * A font-palette-values rule matching this node.
+ * The css style sheet identifier.
*/
- cssFontPaletteValuesRule?: CSSFontPaletteValuesRule;
+ styleSheetId: StyleSheetId;
/**
- * Id of the first parent element that does not have display: contents.
+ * The range of the style text in the enclosing stylesheet.
*/
- parentLayoutNodeId?: DOM.NodeId;
+ range: SourceRange;
/**
- * A list of CSS at-function rules referenced by styles of this node.
+ * New style text.
*/
- cssFunctionRules?: CSSFunctionRule[];
+ text: string;
}
+
/**
- * Returns the values of the default UA-defined environment variables used in env()
+ * Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
+web font.
*/
- export type getEnvironmentVariablesParameters = {
- }
- export type getEnvironmentVariablesReturnValue = {
- environmentVariables: { [key: string]: string };
+ export type fontsUpdatedPayload = {
+ /**
+ * The web font that has loaded.
+ */
+ font?: FontFace;
}
/**
- * Returns all media queries parsed by the rendering engine.
- */
- export type getMediaQueriesParameters = {
- }
- export type getMediaQueriesReturnValue = {
- medias: CSSMedia[];
- }
- /**
- * Requests information about platform fonts which we used to render child TextNodes in the given
-node.
+ * Fires whenever a MediaQuery result changes (for example, after a browser window has been
+resized.) The current implementation considers only viewport-dependent media features.
*/
- export type getPlatformFontsForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getPlatformFontsForNodeReturnValue = {
- /**
- * Usage statistics for every employed platform font.
- */
- fonts: PlatformFontUsage[];
- }
+ export type mediaQueryResultChangedPayload = void;
/**
- * Returns the current textual content for a stylesheet.
+ * Fired whenever an active document stylesheet is added.
*/
- export type getStyleSheetTextParameters = {
- styleSheetId: StyleSheetId;
- }
- export type getStyleSheetTextReturnValue = {
+ export type styleSheetAddedPayload = {
/**
- * The stylesheet text.
+ * Added stylesheet metainfo.
*/
- text: string;
- }
- /**
- * Returns all layers parsed by the rendering engine for the tree scope of a node.
-Given a DOM element identified by nodeId, getLayersForNode returns the root
-layer for the nearest ancestor document or shadow root. The layer root contains
-the full layer tree for the tree scope and their ordering.
- */
- export type getLayersForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getLayersForNodeReturnValue = {
- rootLayer: CSSLayerData;
+ header: CSSStyleSheetHeader;
}
/**
- * Given a CSS selector text and a style sheet ID, getLocationForSelector
-returns an array of locations of the CSS selector in the style sheet.
+ * Fired whenever a stylesheet is changed as a result of the client operation.
*/
- export type getLocationForSelectorParameters = {
+ export type styleSheetChangedPayload = {
styleSheetId: StyleSheetId;
- selectorText: string;
- }
- export type getLocationForSelectorReturnValue = {
- ranges: SourceRange[];
- }
- /**
- * Starts tracking the given node for the computed style updates
-and whenever the computed style is updated for node, it queues
-a `computedStyleUpdated` event with throttling.
-There can only be 1 node tracked for computed style updates
-so passing a new node id removes tracking from the previous node.
-Pass `undefined` to disable tracking.
- */
- export type trackComputedStyleUpdatesForNodeParameters = {
- nodeId?: DOM.NodeId;
- }
- export type trackComputedStyleUpdatesForNodeReturnValue = {
- }
- /**
- * Starts tracking the given computed styles for updates. The specified array of properties
-replaces the one previously specified. Pass empty array to disable tracking.
-Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
-The changes to computed style properties are only tracked for nodes pushed to the front-end
-by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
-to the front-end, no updates will be issued for the node.
- */
- export type trackComputedStyleUpdatesParameters = {
- propertiesToTrack: CSSComputedStyleProperty[];
- }
- export type trackComputedStyleUpdatesReturnValue = {
}
/**
- * Polls the next batch of computed style updates.
+ * Fired whenever an active document stylesheet is removed.
*/
- export type takeComputedStyleUpdatesParameters = {
- }
- export type takeComputedStyleUpdatesReturnValue = {
+ export type styleSheetRemovedPayload = {
/**
- * The list of node Ids that have their tracked computed styles updated.
+ * Identifier of the removed stylesheet.
*/
- nodeIds: DOM.NodeId[];
+ styleSheetId: StyleSheetId;
}
- /**
- * Find a rule with the given active property for the given node and set the new value for this
-property
- */
- export type setEffectivePropertyValueForNodeParameters = {
+ export type computedStyleUpdatedPayload = {
/**
- * The element id for which to set property.
+ * The node id that has updated computed styles.
*/
nodeId: DOM.NodeId;
- propertyName: string;
- value: string;
- }
- export type setEffectivePropertyValueForNodeReturnValue = {
}
+
/**
- * Modifies the property rule property name.
+ * Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
+position specified by `location`.
*/
- export type setPropertyRulePropertyNameParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- propertyName: string;
- }
- export type setPropertyRulePropertyNameReturnValue = {
+ export type addRuleParameters = {
/**
- * The resulting key text after modification.
+ * The css style sheet identifier where a new rule should be inserted.
*/
- propertyName: Value;
- }
- /**
- * Modifies the keyframe rule key text.
- */
- export type setKeyframeKeyParameters = {
styleSheetId: StyleSheetId;
- range: SourceRange;
- keyText: string;
- }
- export type setKeyframeKeyReturnValue = {
/**
- * The resulting key text after modification.
+ * The text of a new rule.
*/
- keyText: Value;
- }
- /**
- * Modifies the rule selector.
- */
- export type setMediaTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ ruleText: string;
+ /**
+ * Text position of a new rule in the target style sheet.
+ */
+ location: SourceRange;
+ /**
+ * NodeId for the DOM node in whose context custom property declarations for registered properties should be
+validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
+incorrect results if the declaration contains a var() for example.
+ */
+ nodeForPropertySyntaxValidation?: DOM.NodeId;
}
- export type setMediaTextReturnValue = {
+ export type addRuleReturnValue = {
/**
- * The resulting CSS media rule after modification.
+ * The newly created rule.
*/
- media: CSSMedia;
+ rule: CSSRule;
}
/**
- * Modifies the expression of a container query.
+ * Returns all class names from specified stylesheet.
*/
- export type setContainerQueryTextParameters = {
+ export type collectClassNamesParameters = {
styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
}
- export type setContainerQueryTextReturnValue = {
+ export type collectClassNamesReturnValue = {
/**
- * The resulting CSS container query rule after modification.
+ * Class name list.
*/
- containerQuery: CSSContainerQuery;
+ classNames: string[];
}
/**
- * Modifies the expression of a supports at-rule.
+ * Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
*/
- export type setSupportsTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ export type createStyleSheetParameters = {
+ /**
+ * Identifier of the frame where "via-inspector" stylesheet should be created.
+ */
+ frameId: Page.FrameId;
+ /**
+ * If true, creates a new stylesheet for every call. If false,
+returns a stylesheet previously created by a call with force=false
+for the frame's document if it exists or creates a new stylesheet
+(default: false).
+ */
+ force?: boolean;
}
- export type setSupportsTextReturnValue = {
+ export type createStyleSheetReturnValue = {
/**
- * The resulting CSS Supports rule after modification.
+ * Identifier of the created "via-inspector" stylesheet.
*/
- supports: CSSSupports;
+ styleSheetId: StyleSheetId;
}
/**
- * Modifies the expression of a scope at-rule.
+ * Disables the CSS agent for the given page.
*/
- export type setScopeTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ export type disableParameters = {
}
- export type setScopeTextReturnValue = {
- /**
- * The resulting CSS Scope rule after modification.
- */
- scope: CSSScope;
+ export type disableReturnValue = {
}
/**
- * Modifies the rule selector.
+ * Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
+enabled until the result of this command is received.
*/
- export type setRuleSelectorParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- selector: string;
+ export type enableParameters = {
}
- export type setRuleSelectorReturnValue = {
- /**
- * The resulting selector list after modification.
- */
- selectorList: SelectorList;
+ export type enableReturnValue = {
}
/**
- * Sets the new stylesheet text.
+ * Ensures that the given node will have specified pseudo-classes whenever its style is computed by
+the browser.
*/
- export type setStyleSheetTextParameters = {
- styleSheetId: StyleSheetId;
- text: string;
- }
- export type setStyleSheetTextReturnValue = {
+ export type forcePseudoStateParameters = {
/**
- * URL of source map associated with script (if any).
+ * The element id for which to force the pseudo state.
*/
- sourceMapURL?: string;
+ nodeId: DOM.NodeId;
+ /**
+ * Element pseudo classes to force when computing the element's style.
+ */
+ forcedPseudoClasses: string[];
+ }
+ export type forcePseudoStateReturnValue = {
}
/**
- * Applies specified style edits one after another in the given order.
+ * Ensures that the given node is in its starting-style state.
*/
- export type setStyleTextsParameters = {
- edits: StyleDeclarationEdit[];
+ export type forceStartingStyleParameters = {
/**
- * NodeId for the DOM node in whose context custom property declarations for registered properties should be
-validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
-incorrect results if the declaration contains a var() for example.
+ * The element id for which to force the starting-style state.
*/
- nodeForPropertySyntaxValidation?: DOM.NodeId;
- }
- export type setStyleTextsReturnValue = {
+ nodeId: DOM.NodeId;
/**
- * The resulting styles after modification.
+ * Boolean indicating if this is on or off.
*/
- styles: CSSStyle[];
+ forced: boolean;
}
- /**
- * Enables the selector recording.
- */
- export type startRuleUsageTrackingParameters = {
+ export type forceStartingStyleReturnValue = {
}
- export type startRuleUsageTrackingReturnValue = {
- }
- /**
- * Stop tracking rule usage and return the list of rules that were used since last call to
-`takeCoverageDelta` (or since start of coverage instrumentation).
- */
- export type stopRuleUsageTrackingParameters = {
- }
- export type stopRuleUsageTrackingReturnValue = {
- ruleUsage: RuleUsage[];
- }
- /**
- * Obtain list of rules that became used since last call to this method (or since start of coverage
-instrumentation).
- */
- export type takeCoverageDeltaParameters = {
- }
- export type takeCoverageDeltaReturnValue = {
- coverage: RuleUsage[];
- /**
- * Monotonically increasing time, in seconds.
- */
- timestamp: number;
- }
- /**
- * Enables/disables rendering of local CSS fonts (enabled by default).
- */
- export type setLocalFontsEnabledParameters = {
+ export type getBackgroundColorsParameters = {
/**
- * Whether rendering of local fonts is enabled.
+ * Id of the node to get background colors for.
*/
- enabled: boolean;
- }
- export type setLocalFontsEnabledReturnValue = {
+ nodeId: DOM.NodeId;
}
- }
-
- export module CacheStorage {
- /**
- * Unique identifier of the Cache object.
- */
- export type CacheId = string;
- /**
- * type of HTTP response cached
- */
- export type CachedResponseType = "basic"|"cors"|"default"|"error"|"opaqueResponse"|"opaqueRedirect";
- /**
- * Data entry.
- */
- export interface DataEntry {
- /**
- * Request URL.
- */
- requestURL: string;
- /**
- * Request method.
- */
- requestMethod: string;
- /**
- * Request headers
- */
- requestHeaders: Header[];
+ export type getBackgroundColorsReturnValue = {
/**
- * Number of seconds since epoch.
+ * The range of background colors behind this element, if it contains any visible text. If no
+visible text is present, this will be undefined. In the case of a flat background color,
+this will consist of simply that color. In the case of a gradient, this will consist of each
+of the color stops. For anything more complicated, this will be an empty array. Images will
+be ignored (as if the image had failed to load).
*/
- responseTime: number;
+ backgroundColors?: string[];
/**
- * HTTP response status code.
+ * The computed font size for this node, as a CSS computed value string (e.g. '12px').
*/
- responseStatus: number;
+ computedFontSize?: string;
/**
- * HTTP response status text.
+ * The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
+'100').
*/
- responseStatusText: string;
+ computedFontWeight?: string;
+ }
+ /**
+ * Returns the computed style for a DOM node identified by `nodeId`.
+ */
+ export type getComputedStyleForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getComputedStyleForNodeReturnValue = {
/**
- * HTTP response type
+ * Computed style for the specified DOM node.
*/
- responseType: CachedResponseType;
+ computedStyle: CSSComputedStyleProperty[];
/**
- * Response headers
+ * A list of non-standard "extra fields" which blink stores alongside each
+computed style.
*/
- responseHeaders: Header[];
+ extraFields: ComputedStyleExtraFields;
}
/**
- * Cache identifier.
+ * Resolve the specified values in the context of the provided element.
+For example, a value of '1em' is evaluated according to the computed
+'font-size' of the element and a value 'calc(1px + 2px)' will be
+resolved to '3px'.
+If the `propertyName` was specified the `values` are resolved as if
+they were property's declaration. If a value cannot be parsed according
+to the provided property syntax, the value is parsed using combined
+syntax as if null `propertyName` was provided. If the value cannot be
+resolved even then, return the provided value without any changes.
*/
- export interface Cache {
+ export type resolveValuesParameters = {
/**
- * An opaque unique id of the cache.
+ * Cascade-dependent keywords (revert/revert-layer) do not work.
*/
- cacheId: CacheId;
+ values: string[];
/**
- * Security origin of the cache.
+ * Id of the node in whose context the expression is evaluated
*/
- securityOrigin: string;
+ nodeId: DOM.NodeId;
/**
- * Storage key of the cache.
+ * Only longhands and custom property names are accepted.
*/
- storageKey: string;
+ propertyName?: string;
/**
- * Storage bucket of the cache.
+ * Pseudo element type, only works for pseudo elements that generate
+elements in the tree, such as ::before and ::after.
*/
- storageBucket?: Storage.StorageBucket;
+ pseudoType?: DOM.PseudoType;
/**
- * The name of the cache.
+ * Pseudo element custom ident.
*/
- cacheName: string;
+ pseudoIdentifier?: string;
}
- export interface Header {
- name: string;
+ export type resolveValuesReturnValue = {
+ results: string[];
+ }
+ export type getLonghandPropertiesParameters = {
+ shorthandName: string;
value: string;
}
+ export type getLonghandPropertiesReturnValue = {
+ longhandProperties: CSSProperty[];
+ }
/**
- * Cached response
+ * Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
+attributes) for a DOM node identified by `nodeId`.
*/
- export interface CachedResponse {
+ export type getInlineStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getInlineStylesForNodeReturnValue = {
/**
- * Entry content, base64-encoded.
+ * Inline style for the specified DOM node.
*/
- body: binary;
- }
-
-
- /**
- * Deletes a cache.
- */
- export type deleteCacheParameters = {
+ inlineStyle?: CSSStyle;
/**
- * Id of cache for deletion.
+ * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
*/
- cacheId: CacheId;
- }
- export type deleteCacheReturnValue = {
+ attributesStyle?: CSSStyle;
}
/**
- * Deletes a cache entry.
+ * Returns the styles coming from animations & transitions
+including the animation & transition styles coming from inheritance chain.
*/
- export type deleteEntryParameters = {
+ export type getAnimatedStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getAnimatedStylesForNodeReturnValue = {
/**
- * Id of cache where the entry will be deleted.
+ * Styles coming from animations.
*/
- cacheId: CacheId;
+ animationStyles?: CSSAnimationStyle[];
/**
- * URL spec of the request.
+ * Style coming from transitions.
*/
- request: string;
- }
- export type deleteEntryReturnValue = {
+ transitionsStyle?: CSSStyle;
+ /**
+ * Inherited style entries for animationsStyle and transitionsStyle from
+the inheritance chain of the element.
+ */
+ inherited?: InheritedAnimatedStyleEntry[];
}
/**
- * Requests cache names.
+ * Returns requested styles for a DOM node identified by `nodeId`.
*/
- export type requestCacheNamesParameters = {
+ export type getMatchedStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getMatchedStylesForNodeReturnValue = {
/**
- * At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
-Security origin.
+ * Inline style for the specified DOM node.
*/
- securityOrigin?: string;
+ inlineStyle?: CSSStyle;
/**
- * Storage key.
+ * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
*/
- storageKey?: string;
+ attributesStyle?: CSSStyle;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * CSS rules matching this node, from all applicable stylesheets.
*/
- storageBucket?: Storage.StorageBucket;
- }
- export type requestCacheNamesReturnValue = {
+ matchedCSSRules?: RuleMatch[];
/**
- * Caches for the security origin.
+ * Pseudo style matches for this node.
*/
- caches: Cache[];
- }
- /**
- * Fetches cache entry.
- */
- export type requestCachedResponseParameters = {
+ pseudoElements?: PseudoElementMatches[];
/**
- * Id of cache that contains the entry.
+ * A chain of inherited styles (from the immediate node parent up to the DOM tree root).
*/
- cacheId: CacheId;
+ inherited?: InheritedStyleEntry[];
/**
- * URL spec of the request.
+ * A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
*/
- requestURL: string;
+ inheritedPseudoElements?: InheritedPseudoElementMatches[];
/**
- * headers of the request.
+ * A list of CSS keyframed animations matching this node.
*/
- requestHeaders: Header[];
- }
- export type requestCachedResponseReturnValue = {
+ cssKeyframesRules?: CSSKeyframesRule[];
/**
- * Response read from the cache.
+ * A list of CSS @position-try rules matching this node, based on the position-try-fallbacks property.
*/
- response: CachedResponse;
- }
- /**
- * Requests data from cache.
- */
- export type requestEntriesParameters = {
+ cssPositionTryRules?: CSSPositionTryRule[];
/**
- * ID of cache to get entries from.
+ * Index of the active fallback in the applied position-try-fallback property,
+will not be set if there is no active position-try fallback.
*/
- cacheId: CacheId;
+ activePositionFallbackIndex?: number;
/**
- * Number of records to skip.
+ * A list of CSS at-property rules matching this node.
*/
- skipCount?: number;
+ cssPropertyRules?: CSSPropertyRule[];
/**
- * Number of records to fetch.
+ * A list of CSS property registrations matching this node.
*/
- pageSize?: number;
+ cssPropertyRegistrations?: CSSPropertyRegistration[];
/**
- * If present, only return the entries containing this substring in the path
+ * A font-palette-values rule matching this node.
*/
- pathFilter?: string;
- }
- export type requestEntriesReturnValue = {
+ cssFontPaletteValuesRule?: CSSFontPaletteValuesRule;
/**
- * Array of object store data entries.
- */
- cacheDataEntries: DataEntry[];
- /**
- * Count of returned entries from this storage. If pathFilter is empty, it
-is the count of all entries from this storage.
+ * Id of the first parent element that does not have display: contents.
*/
- returnCount: number;
- }
- }
-
- /**
- * A domain for interacting with Cast, Presentation API, and Remote Playback API
-functionalities.
- */
- export module Cast {
- export interface Sink {
- name: string;
- id: string;
+ parentLayoutNodeId?: DOM.NodeId;
/**
- * Text describing the current session. Present only if there is an active
-session on the sink.
+ * A list of CSS at-function rules referenced by styles of this node.
*/
- session?: string;
+ cssFunctionRules?: CSSFunctionRule[];
}
-
/**
- * This is fired whenever the list of available sinks changes. A sink is a
-device or a software surface that you can cast to.
+ * Returns the values of the default UA-defined environment variables used in env()
*/
- export type sinksUpdatedPayload = {
- sinks: Sink[];
+ export type getEnvironmentVariablesParameters = {
}
- /**
- * This is fired whenever the outstanding issue/error message changes.
-|issueMessage| is empty if there is no issue.
- */
- export type issueUpdatedPayload = {
- issueMessage: string;
+ export type getEnvironmentVariablesReturnValue = {
+ environmentVariables: { [key: string]: string };
}
-
/**
- * Starts observing for sinks that can be used for tab mirroring, and if set,
-sinks compatible with |presentationUrl| as well. When sinks are found, a
-|sinksUpdated| event is fired.
-Also starts observing for issue messages. When an issue is added or removed,
-an |issueUpdated| event is fired.
+ * Returns all media queries parsed by the rendering engine.
*/
- export type enableParameters = {
- presentationUrl?: string;
+ export type getMediaQueriesParameters = {
}
- export type enableReturnValue = {
+ export type getMediaQueriesReturnValue = {
+ medias: CSSMedia[];
}
/**
- * Stops observing for sinks and issues.
+ * Requests information about platform fonts which we used to render child TextNodes in the given
+node.
*/
- export type disableParameters = {
+ export type getPlatformFontsForNodeParameters = {
+ nodeId: DOM.NodeId;
}
- export type disableReturnValue = {
+ export type getPlatformFontsForNodeReturnValue = {
+ /**
+ * Usage statistics for every employed platform font.
+ */
+ fonts: PlatformFontUsage[];
}
/**
- * Sets a sink to be used when the web page requests the browser to choose a
-sink via Presentation API, Remote Playback API, or Cast SDK.
+ * Returns the current textual content for a stylesheet.
*/
- export type setSinkToUseParameters = {
- sinkName: string;
+ export type getStyleSheetTextParameters = {
+ styleSheetId: StyleSheetId;
}
- export type setSinkToUseReturnValue = {
+ export type getStyleSheetTextReturnValue = {
+ /**
+ * The stylesheet text.
+ */
+ text: string;
}
/**
- * Starts mirroring the desktop to the sink.
+ * Returns all layers parsed by the rendering engine for the tree scope of a node.
+Given a DOM element identified by nodeId, getLayersForNode returns the root
+layer for the nearest ancestor document or shadow root. The layer root contains
+the full layer tree for the tree scope and their ordering.
*/
- export type startDesktopMirroringParameters = {
- sinkName: string;
+ export type getLayersForNodeParameters = {
+ nodeId: DOM.NodeId;
}
- export type startDesktopMirroringReturnValue = {
+ export type getLayersForNodeReturnValue = {
+ rootLayer: CSSLayerData;
}
/**
- * Starts mirroring the tab to the sink.
+ * Given a CSS selector text and a style sheet ID, getLocationForSelector
+returns an array of locations of the CSS selector in the style sheet.
*/
- export type startTabMirroringParameters = {
- sinkName: string;
+ export type getLocationForSelectorParameters = {
+ styleSheetId: StyleSheetId;
+ selectorText: string;
}
- export type startTabMirroringReturnValue = {
+ export type getLocationForSelectorReturnValue = {
+ ranges: SourceRange[];
}
/**
- * Stops the active Cast session on the sink.
+ * Starts tracking the given node for the computed style updates
+and whenever the computed style is updated for node, it queues
+a `computedStyleUpdated` event with throttling.
+There can only be 1 node tracked for computed style updates
+so passing a new node id removes tracking from the previous node.
+Pass `undefined` to disable tracking.
*/
- export type stopCastingParameters = {
- sinkName: string;
+ export type trackComputedStyleUpdatesForNodeParameters = {
+ nodeId?: DOM.NodeId;
}
- export type stopCastingReturnValue = {
+ export type trackComputedStyleUpdatesForNodeReturnValue = {
}
- }
-
- /**
- * This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
-that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
-the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
-nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
-and never sends the same node twice. It is client's responsibility to collect information about
-the nodes that were sent to the client. Note that `iframe` owner elements will return
-corresponding document elements as their child nodes.
- */
- export module DOM {
- /**
- * Unique DOM node identifier.
- */
- export type NodeId = number;
/**
- * Unique DOM node identifier used to reference a node that may not have been pushed to the
-front-end.
+ * Starts tracking the given computed styles for updates. The specified array of properties
+replaces the one previously specified. Pass empty array to disable tracking.
+Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
+The changes to computed style properties are only tracked for nodes pushed to the front-end
+by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
+to the front-end, no updates will be issued for the node.
*/
- export type BackendNodeId = number;
+ export type trackComputedStyleUpdatesParameters = {
+ propertiesToTrack: CSSComputedStyleProperty[];
+ }
+ export type trackComputedStyleUpdatesReturnValue = {
+ }
/**
- * Backend node with a friendly name.
+ * Polls the next batch of computed style updates.
*/
- export interface BackendNode {
- /**
- * `Node`'s nodeType.
- */
- nodeType: number;
+ export type takeComputedStyleUpdatesParameters = {
+ }
+ export type takeComputedStyleUpdatesReturnValue = {
/**
- * `Node`'s nodeName.
+ * The list of node Ids that have their tracked computed styles updated.
*/
- nodeName: string;
- backendNodeId: BackendNodeId;
+ nodeIds: DOM.NodeId[];
}
/**
- * Pseudo element type.
+ * Find a rule with the given active property for the given node and set the new value for this
+property
*/
- export type PseudoType = "first-line"|"first-letter"|"checkmark"|"before"|"after"|"picker-icon"|"marker"|"backdrop"|"column"|"selection"|"search-text"|"target-text"|"spelling-error"|"grammar-error"|"highlight"|"first-line-inherited"|"scroll-marker"|"scroll-marker-group"|"scroll-button"|"scrollbar"|"scrollbar-thumb"|"scrollbar-button"|"scrollbar-track"|"scrollbar-track-piece"|"scrollbar-corner"|"resizer"|"input-list-button"|"view-transition"|"view-transition-group"|"view-transition-image-pair"|"view-transition-group-children"|"view-transition-old"|"view-transition-new"|"placeholder"|"file-selector-button"|"details-content"|"picker"|"permission-icon";
+ export type setEffectivePropertyValueForNodeParameters = {
+ /**
+ * The element id for which to set property.
+ */
+ nodeId: DOM.NodeId;
+ propertyName: string;
+ value: string;
+ }
+ export type setEffectivePropertyValueForNodeReturnValue = {
+ }
/**
- * Shadow root type.
+ * Modifies the property rule property name.
*/
- export type ShadowRootType = "user-agent"|"open"|"closed";
+ export type setPropertyRulePropertyNameParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ propertyName: string;
+ }
+ export type setPropertyRulePropertyNameReturnValue = {
+ /**
+ * The resulting key text after modification.
+ */
+ propertyName: Value;
+ }
/**
- * Document compatibility mode.
+ * Modifies the keyframe rule key text.
*/
- export type CompatibilityMode = "QuirksMode"|"LimitedQuirksMode"|"NoQuirksMode";
+ export type setKeyframeKeyParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ keyText: string;
+ }
+ export type setKeyframeKeyReturnValue = {
+ /**
+ * The resulting key text after modification.
+ */
+ keyText: Value;
+ }
/**
- * ContainerSelector physical axes
+ * Modifies the rule selector.
*/
- export type PhysicalAxes = "Horizontal"|"Vertical"|"Both";
+ export type setMediaTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setMediaTextReturnValue = {
+ /**
+ * The resulting CSS media rule after modification.
+ */
+ media: CSSMedia;
+ }
/**
- * ContainerSelector logical axes
+ * Modifies the expression of a container query.
*/
- export type LogicalAxes = "Inline"|"Block"|"Both";
+ export type setContainerQueryTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setContainerQueryTextReturnValue = {
+ /**
+ * The resulting CSS container query rule after modification.
+ */
+ containerQuery: CSSContainerQuery;
+ }
/**
- * Physical scroll orientation
+ * Modifies the expression of a supports at-rule.
*/
- export type ScrollOrientation = "horizontal"|"vertical";
+ export type setSupportsTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setSupportsTextReturnValue = {
+ /**
+ * The resulting CSS Supports rule after modification.
+ */
+ supports: CSSSupports;
+ }
/**
- * DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
-DOMNode is a base node mirror type.
+ * Modifies the expression of a scope at-rule.
*/
- export interface Node {
+ export type setScopeTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setScopeTextReturnValue = {
/**
- * Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
-will only push node with given `id` once. It is aware of all requested nodes and will only
-fire DOM events for nodes known to the client.
+ * The resulting CSS Scope rule after modification.
*/
- nodeId: NodeId;
- /**
- * The id of the parent node if any.
- */
- parentId?: NodeId;
+ scope: CSSScope;
+ }
+ /**
+ * Modifies the rule selector.
+ */
+ export type setRuleSelectorParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ selector: string;
+ }
+ export type setRuleSelectorReturnValue = {
/**
- * The BackendNodeId for this node.
+ * The resulting selector list after modification.
*/
- backendNodeId: BackendNodeId;
+ selectorList: SelectorList;
+ }
+ /**
+ * Sets the new stylesheet text.
+ */
+ export type setStyleSheetTextParameters = {
+ styleSheetId: StyleSheetId;
+ text: string;
+ }
+ export type setStyleSheetTextReturnValue = {
/**
- * `Node`'s nodeType.
+ * URL of source map associated with script (if any).
*/
- nodeType: number;
+ sourceMapURL?: string;
+ }
+ /**
+ * Applies specified style edits one after another in the given order.
+ */
+ export type setStyleTextsParameters = {
+ edits: StyleDeclarationEdit[];
/**
- * `Node`'s nodeName.
+ * NodeId for the DOM node in whose context custom property declarations for registered properties should be
+validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
+incorrect results if the declaration contains a var() for example.
*/
- nodeName: string;
+ nodeForPropertySyntaxValidation?: DOM.NodeId;
+ }
+ export type setStyleTextsReturnValue = {
/**
- * `Node`'s localName.
+ * The resulting styles after modification.
*/
- localName: string;
+ styles: CSSStyle[];
+ }
+ /**
+ * Enables the selector recording.
+ */
+ export type startRuleUsageTrackingParameters = {
+ }
+ export type startRuleUsageTrackingReturnValue = {
+ }
+ /**
+ * Stop tracking rule usage and return the list of rules that were used since last call to
+`takeCoverageDelta` (or since start of coverage instrumentation).
+ */
+ export type stopRuleUsageTrackingParameters = {
+ }
+ export type stopRuleUsageTrackingReturnValue = {
+ ruleUsage: RuleUsage[];
+ }
+ /**
+ * Obtain list of rules that became used since last call to this method (or since start of coverage
+instrumentation).
+ */
+ export type takeCoverageDeltaParameters = {
+ }
+ export type takeCoverageDeltaReturnValue = {
+ coverage: RuleUsage[];
/**
- * `Node`'s nodeValue.
+ * Monotonically increasing time, in seconds.
*/
- nodeValue: string;
+ timestamp: number;
+ }
+ /**
+ * Enables/disables rendering of local CSS fonts (enabled by default).
+ */
+ export type setLocalFontsEnabledParameters = {
/**
- * Child count for `Container` nodes.
+ * Whether rendering of local fonts is enabled.
*/
- childNodeCount?: number;
+ enabled: boolean;
+ }
+ export type setLocalFontsEnabledReturnValue = {
+ }
+ }
+
+ export module CacheStorage {
+ /**
+ * Unique identifier of the Cache object.
+ */
+ export type CacheId = string;
+ /**
+ * type of HTTP response cached
+ */
+ export type CachedResponseType = "basic"|"cors"|"default"|"error"|"opaqueResponse"|"opaqueRedirect";
+ /**
+ * Data entry.
+ */
+ export interface DataEntry {
/**
- * Child nodes of this node when requested with children.
+ * Request URL.
*/
- children?: Node[];
+ requestURL: string;
/**
- * Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
+ * Request method.
*/
- attributes?: string[];
+ requestMethod: string;
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * Request headers
*/
- documentURL?: string;
+ requestHeaders: Header[];
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Number of seconds since epoch.
*/
- baseURL?: string;
+ responseTime: number;
/**
- * `DocumentType`'s publicId.
+ * HTTP response status code.
*/
- publicId?: string;
+ responseStatus: number;
/**
- * `DocumentType`'s systemId.
+ * HTTP response status text.
*/
- systemId?: string;
+ responseStatusText: string;
/**
- * `DocumentType`'s internalSubset.
+ * HTTP response type
*/
- internalSubset?: string;
+ responseType: CachedResponseType;
/**
- * `Document`'s XML version in case of XML documents.
+ * Response headers
*/
- xmlVersion?: string;
+ responseHeaders: Header[];
+ }
+ /**
+ * Cache identifier.
+ */
+ export interface Cache {
/**
- * `Attr`'s name.
+ * An opaque unique id of the cache.
*/
- name?: string;
+ cacheId: CacheId;
/**
- * `Attr`'s value.
+ * Security origin of the cache.
*/
- value?: string;
+ securityOrigin: string;
/**
- * Pseudo element type for this node.
+ * Storage key of the cache.
*/
- pseudoType?: PseudoType;
+ storageKey: string;
/**
- * Pseudo element identifier for this node. Only present if there is a
-valid pseudoType.
+ * Storage bucket of the cache.
*/
- pseudoIdentifier?: string;
+ storageBucket?: Storage.StorageBucket;
/**
- * Shadow root type.
+ * The name of the cache.
*/
- shadowRootType?: ShadowRootType;
+ cacheName: string;
+ }
+ export interface Header {
+ name: string;
+ value: string;
+ }
+ /**
+ * Cached response
+ */
+ export interface CachedResponse {
/**
- * Frame ID for frame owner elements.
+ * Entry content, base64-encoded.
*/
- frameId?: Page.FrameId;
+ body: binary;
+ }
+
+
+ /**
+ * Deletes a cache.
+ */
+ export type deleteCacheParameters = {
/**
- * Content document for frame owner elements.
+ * Id of cache for deletion.
*/
- contentDocument?: Node;
+ cacheId: CacheId;
+ }
+ export type deleteCacheReturnValue = {
+ }
+ /**
+ * Deletes a cache entry.
+ */
+ export type deleteEntryParameters = {
/**
- * Shadow root list for given element host.
+ * Id of cache where the entry will be deleted.
*/
- shadowRoots?: Node[];
+ cacheId: CacheId;
/**
- * Content document fragment for template elements.
+ * URL spec of the request.
*/
- templateContent?: Node;
+ request: string;
+ }
+ export type deleteEntryReturnValue = {
+ }
+ /**
+ * Requests cache names.
+ */
+ export type requestCacheNamesParameters = {
/**
- * Pseudo elements associated with this node.
+ * At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
+Security origin.
*/
- pseudoElements?: Node[];
+ securityOrigin?: string;
/**
- * Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
-This property used to return the imported document for the HTMLImport links.
-The property is always undefined now.
+ * Storage key.
*/
- importedDocument?: Node;
+ storageKey?: string;
/**
- * Distributed nodes for given insertion point.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- distributedNodes?: BackendNode[];
+ storageBucket?: Storage.StorageBucket;
+ }
+ export type requestCacheNamesReturnValue = {
/**
- * Whether the node is SVG.
+ * Caches for the security origin.
*/
- isSVG?: boolean;
- compatibilityMode?: CompatibilityMode;
- assignedSlot?: BackendNode;
- isScrollable?: boolean;
- }
- /**
- * A structure to hold the top-level node of a detached tree and an array of its retained descendants.
- */
- export interface DetachedElementInfo {
- treeNode: Node;
- retainedNodeIds: NodeId[];
+ caches: Cache[];
}
/**
- * A structure holding an RGBA color.
+ * Fetches cache entry.
*/
- export interface RGBA {
+ export type requestCachedResponseParameters = {
/**
- * The red component, in the [0-255] range.
+ * Id of cache that contains the entry.
*/
- r: number;
+ cacheId: CacheId;
/**
- * The green component, in the [0-255] range.
+ * URL spec of the request.
*/
- g: number;
+ requestURL: string;
/**
- * The blue component, in the [0-255] range.
+ * headers of the request.
*/
- b: number;
+ requestHeaders: Header[];
+ }
+ export type requestCachedResponseReturnValue = {
/**
- * The alpha component, in the [0-1] range (default: 1).
+ * Response read from the cache.
*/
- a?: number;
+ response: CachedResponse;
}
/**
- * An array of quad vertices, x immediately followed by y for each point, points clock-wise.
- */
- export type Quad = number[];
- /**
- * Box model.
+ * Requests data from cache.
*/
- export interface BoxModel {
+ export type requestEntriesParameters = {
/**
- * Content box
+ * ID of cache to get entries from.
*/
- content: Quad;
+ cacheId: CacheId;
/**
- * Padding box
+ * Number of records to skip.
*/
- padding: Quad;
+ skipCount?: number;
/**
- * Border box
+ * Number of records to fetch.
*/
- border: Quad;
+ pageSize?: number;
/**
- * Margin box
+ * If present, only return the entries containing this substring in the path
*/
- margin: Quad;
+ pathFilter?: string;
+ }
+ export type requestEntriesReturnValue = {
/**
- * Node width
+ * Array of object store data entries.
*/
- width: number;
+ cacheDataEntries: DataEntry[];
/**
- * Node height
+ * Count of returned entries from this storage. If pathFilter is empty, it
+is the count of all entries from this storage.
*/
- height: number;
+ returnCount: number;
+ }
+ }
+
+ /**
+ * A domain for interacting with Cast, Presentation API, and Remote Playback API
+functionalities.
+ */
+ export module Cast {
+ export interface Sink {
+ name: string;
+ id: string;
/**
- * Shape outside coordinates
+ * Text describing the current session. Present only if there is an active
+session on the sink.
*/
- shapeOutside?: ShapeOutsideInfo;
+ session?: string;
}
+
/**
- * CSS Shape Outside details.
+ * This is fired whenever the list of available sinks changes. A sink is a
+device or a software surface that you can cast to.
*/
- export interface ShapeOutsideInfo {
- /**
- * Shape bounds
- */
- bounds: Quad;
- /**
- * Shape coordinate details
- */
- shape: any[];
- /**
- * Margin shape bounds
- */
- marginShape: any[];
+ export type sinksUpdatedPayload = {
+ sinks: Sink[];
}
/**
- * Rectangle.
+ * This is fired whenever the outstanding issue/error message changes.
+|issueMessage| is empty if there is no issue.
*/
- export interface Rect {
- /**
- * X coordinate
- */
- x: number;
- /**
- * Y coordinate
- */
- y: number;
- /**
- * Rectangle width
- */
- width: number;
- /**
- * Rectangle height
- */
- height: number;
- }
- export interface CSSComputedStyleProperty {
- /**
- * Computed style property name.
- */
- name: string;
- /**
- * Computed style property value.
- */
- value: string;
+ export type issueUpdatedPayload = {
+ issueMessage: string;
}
/**
- * Fired when `Element`'s attribute is modified.
+ * Starts observing for sinks that can be used for tab mirroring, and if set,
+sinks compatible with |presentationUrl| as well. When sinks are found, a
+|sinksUpdated| event is fired.
+Also starts observing for issue messages. When an issue is added or removed,
+an |issueUpdated| event is fired.
*/
- export type attributeModifiedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * Attribute name.
- */
- name: string;
- /**
- * Attribute value.
- */
- value: string;
+ export type enableParameters = {
+ presentationUrl?: string;
+ }
+ export type enableReturnValue = {
}
/**
- * Fired when `Element`'s attribute is removed.
+ * Stops observing for sinks and issues.
*/
- export type attributeRemovedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * A ttribute name.
- */
- name: string;
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
}
/**
- * Mirrors `DOMCharacterDataModified` event.
+ * Sets a sink to be used when the web page requests the browser to choose a
+sink via Presentation API, Remote Playback API, or Cast SDK.
*/
- export type characterDataModifiedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * New text value.
- */
- characterData: string;
+ export type setSinkToUseParameters = {
+ sinkName: string;
+ }
+ export type setSinkToUseReturnValue = {
}
/**
- * Fired when `Container`'s child node count has changed.
+ * Starts mirroring the desktop to the sink.
*/
- export type childNodeCountUpdatedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * New node count.
- */
- childNodeCount: number;
+ export type startDesktopMirroringParameters = {
+ sinkName: string;
+ }
+ export type startDesktopMirroringReturnValue = {
}
/**
- * Mirrors `DOMNodeInserted` event.
+ * Starts mirroring the tab to the sink.
*/
- export type childNodeInsertedPayload = {
- /**
- * Id of the node that has changed.
- */
- parentNodeId: NodeId;
- /**
- * Id of the previous sibling.
- */
- previousNodeId: NodeId;
- /**
- * Inserted node data.
- */
- node: Node;
+ export type startTabMirroringParameters = {
+ sinkName: string;
+ }
+ export type startTabMirroringReturnValue = {
}
/**
- * Mirrors `DOMNodeRemoved` event.
+ * Stops the active Cast session on the sink.
*/
- export type childNodeRemovedPayload = {
- /**
- * Parent id.
- */
- parentNodeId: NodeId;
- /**
- * Id of the node that has been removed.
- */
- nodeId: NodeId;
+ export type stopCastingParameters = {
+ sinkName: string;
+ }
+ export type stopCastingReturnValue = {
}
+ }
+
+ /**
+ * This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
+that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
+the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
+nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
+and never sends the same node twice. It is client's responsibility to collect information about
+the nodes that were sent to the client. Note that `iframe` owner elements will return
+corresponding document elements as their child nodes.
+ */
+ export module DOM {
/**
- * Called when distribution is changed.
+ * Unique DOM node identifier.
*/
- export type distributedNodesUpdatedPayload = {
+ export type NodeId = number;
+ /**
+ * Unique DOM node identifier used to reference a node that may not have been pushed to the
+front-end.
+ */
+ export type BackendNodeId = number;
+ /**
+ * Backend node with a friendly name.
+ */
+ export interface BackendNode {
/**
- * Insertion point where distributed nodes were updated.
+ * `Node`'s nodeType.
*/
- insertionPointId: NodeId;
+ nodeType: number;
/**
- * Distributed nodes for given insertion point.
+ * `Node`'s nodeName.
*/
- distributedNodes: BackendNode[];
+ nodeName: string;
+ backendNodeId: BackendNodeId;
}
/**
- * Fired when `Document` has been totally updated. Node ids are no longer valid.
+ * Pseudo element type.
*/
- export type documentUpdatedPayload = void;
+ export type PseudoType = "first-line"|"first-letter"|"checkmark"|"before"|"after"|"picker-icon"|"interest-hint"|"marker"|"backdrop"|"column"|"selection"|"search-text"|"target-text"|"spelling-error"|"grammar-error"|"highlight"|"first-line-inherited"|"scroll-marker"|"scroll-marker-group"|"scroll-button"|"scrollbar"|"scrollbar-thumb"|"scrollbar-button"|"scrollbar-track"|"scrollbar-track-piece"|"scrollbar-corner"|"resizer"|"input-list-button"|"view-transition"|"view-transition-group"|"view-transition-image-pair"|"view-transition-group-children"|"view-transition-old"|"view-transition-new"|"placeholder"|"file-selector-button"|"details-content"|"picker"|"permission-icon";
/**
- * Fired when `Element`'s inline style is modified via a CSS property modification.
+ * Shadow root type.
*/
- export type inlineStyleInvalidatedPayload = {
- /**
- * Ids of the nodes for which the inline styles have been invalidated.
- */
- nodeIds: NodeId[];
- }
+ export type ShadowRootType = "user-agent"|"open"|"closed";
/**
- * Called when a pseudo element is added to an element.
+ * Document compatibility mode.
*/
- export type pseudoElementAddedPayload = {
- /**
- * Pseudo element's parent element id.
- */
- parentId: NodeId;
- /**
- * The added pseudo element.
- */
- pseudoElement: Node;
- }
+ export type CompatibilityMode = "QuirksMode"|"LimitedQuirksMode"|"NoQuirksMode";
/**
- * Called when top layer elements are changed.
+ * ContainerSelector physical axes
*/
- export type topLayerElementsUpdatedPayload = void;
+ export type PhysicalAxes = "Horizontal"|"Vertical"|"Both";
/**
- * Fired when a node's scrollability state changes.
+ * ContainerSelector logical axes
*/
- export type scrollableFlagUpdatedPayload = {
+ export type LogicalAxes = "Inline"|"Block"|"Both";
+ /**
+ * Physical scroll orientation
+ */
+ export type ScrollOrientation = "horizontal"|"vertical";
+ /**
+ * DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
+DOMNode is a base node mirror type.
+ */
+ export interface Node {
/**
- * The id of the node.
+ * Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
+will only push node with given `id` once. It is aware of all requested nodes and will only
+fire DOM events for nodes known to the client.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * If the node is scrollable.
+ * The id of the parent node if any.
*/
- isScrollable: boolean;
- }
- /**
- * Called when a pseudo element is removed from an element.
- */
- export type pseudoElementRemovedPayload = {
+ parentId?: NodeId;
/**
- * Pseudo element's parent element id.
+ * The BackendNodeId for this node.
*/
- parentId: NodeId;
+ backendNodeId: BackendNodeId;
/**
- * The removed pseudo element id.
+ * `Node`'s nodeType.
*/
- pseudoElementId: NodeId;
- }
- /**
- * Fired when backend wants to provide client with the missing DOM structure. This happens upon
-most of the calls requesting node ids.
- */
- export type setChildNodesPayload = {
+ nodeType: number;
/**
- * Parent node id to populate with children.
+ * `Node`'s nodeName.
*/
- parentId: NodeId;
+ nodeName: string;
/**
- * Child nodes array.
+ * `Node`'s localName.
*/
- nodes: Node[];
- }
- /**
- * Called when shadow root is popped from the element.
- */
- export type shadowRootPoppedPayload = {
+ localName: string;
/**
- * Host element id.
+ * `Node`'s nodeValue.
*/
- hostId: NodeId;
+ nodeValue: string;
/**
- * Shadow root id.
+ * Child count for `Container` nodes.
*/
- rootId: NodeId;
- }
- /**
- * Called when shadow root is pushed into the element.
- */
- export type shadowRootPushedPayload = {
+ childNodeCount?: number;
/**
- * Host element id.
+ * Child nodes of this node when requested with children.
*/
- hostId: NodeId;
+ children?: Node[];
/**
- * Shadow root.
+ * Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
*/
- root: Node;
- }
-
- /**
- * Collects class names for the node with given id and all of it's child nodes.
- */
- export type collectClassNamesFromSubtreeParameters = {
+ attributes?: string[];
/**
- * Id of the node to collect class names.
+ * Document URL that `Document` or `FrameOwner` node points to.
*/
- nodeId: NodeId;
- }
- export type collectClassNamesFromSubtreeReturnValue = {
+ documentURL?: string;
/**
- * Class name list.
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
*/
- classNames: string[];
- }
- /**
- * Creates a deep copy of the specified node and places it into the target container before the
-given anchor.
- */
- export type copyToParameters = {
+ baseURL?: string;
/**
- * Id of the node to copy.
+ * `DocumentType`'s publicId.
*/
- nodeId: NodeId;
+ publicId?: string;
/**
- * Id of the element to drop the copy into.
+ * `DocumentType`'s systemId.
*/
- targetNodeId: NodeId;
+ systemId?: string;
/**
- * Drop the copy before this node (if absent, the copy becomes the last child of
-`targetNodeId`).
+ * `DocumentType`'s internalSubset.
*/
- insertBeforeNodeId?: NodeId;
- }
- export type copyToReturnValue = {
+ internalSubset?: string;
/**
- * Id of the node clone.
+ * `Document`'s XML version in case of XML documents.
*/
- nodeId: NodeId;
- }
- /**
- * Describes node given its id, does not require domain to be enabled. Does not start tracking any
-objects, can be used for automation.
- */
- export type describeNodeParameters = {
+ xmlVersion?: string;
/**
- * Identifier of the node.
+ * `Attr`'s name.
*/
- nodeId?: NodeId;
+ name?: string;
/**
- * Identifier of the backend node.
+ * `Attr`'s value.
*/
- backendNodeId?: BackendNodeId;
+ value?: string;
/**
- * JavaScript object id of the node wrapper.
+ * Pseudo element type for this node.
*/
- objectId?: Runtime.RemoteObjectId;
+ pseudoType?: PseudoType;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Pseudo element identifier for this node. Only present if there is a
+valid pseudoType.
*/
- depth?: number;
+ pseudoIdentifier?: string;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Shadow root type.
*/
- pierce?: boolean;
- }
- export type describeNodeReturnValue = {
+ shadowRootType?: ShadowRootType;
/**
- * Node description.
+ * Frame ID for frame owner elements.
*/
- node: Node;
- }
- /**
- * Scrolls the specified rect of the given node into view if not already visible.
-Note: exactly one between nodeId, backendNodeId and objectId should be passed
-to identify the node.
- */
- export type scrollIntoViewIfNeededParameters = {
+ frameId?: Page.FrameId;
/**
- * Identifier of the node.
+ * Content document for frame owner elements.
*/
- nodeId?: NodeId;
+ contentDocument?: Node;
/**
- * Identifier of the backend node.
+ * Shadow root list for given element host.
*/
- backendNodeId?: BackendNodeId;
+ shadowRoots?: Node[];
/**
- * JavaScript object id of the node wrapper.
+ * Content document fragment for template elements.
*/
- objectId?: Runtime.RemoteObjectId;
+ templateContent?: Node;
/**
- * The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
-When omitted, center of the node will be used, similar to Element.scrollIntoView.
+ * Pseudo elements associated with this node.
*/
- rect?: Rect;
- }
- export type scrollIntoViewIfNeededReturnValue = {
- }
- /**
- * Disables DOM agent for the given page.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Discards search results from the session with the given id. `getSearchResults` should no longer
-be called for that search.
- */
- export type discardSearchResultsParameters = {
+ pseudoElements?: Node[];
/**
- * Unique search session identifier.
+ * Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
+This property used to return the imported document for the HTMLImport links.
+The property is always undefined now.
*/
- searchId: string;
- }
- export type discardSearchResultsReturnValue = {
- }
- /**
- * Enables DOM agent for the given page.
- */
- export type enableParameters = {
+ importedDocument?: Node;
/**
- * Whether to include whitespaces in the children array of returned Nodes.
+ * Distributed nodes for given insertion point.
*/
- includeWhitespace?: "none"|"all";
+ distributedNodes?: BackendNode[];
+ /**
+ * Whether the node is SVG.
+ */
+ isSVG?: boolean;
+ compatibilityMode?: CompatibilityMode;
+ assignedSlot?: BackendNode;
+ isScrollable?: boolean;
}
- export type enableReturnValue = {
+ /**
+ * A structure to hold the top-level node of a detached tree and an array of its retained descendants.
+ */
+ export interface DetachedElementInfo {
+ treeNode: Node;
+ retainedNodeIds: NodeId[];
}
/**
- * Focuses the given element.
+ * A structure holding an RGBA color.
*/
- export type focusParameters = {
+ export interface RGBA {
/**
- * Identifier of the node.
+ * The red component, in the [0-255] range.
*/
- nodeId?: NodeId;
+ r: number;
/**
- * Identifier of the backend node.
+ * The green component, in the [0-255] range.
*/
- backendNodeId?: BackendNodeId;
+ g: number;
/**
- * JavaScript object id of the node wrapper.
+ * The blue component, in the [0-255] range.
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type focusReturnValue = {
+ b: number;
+ /**
+ * The alpha component, in the [0-1] range (default: 1).
+ */
+ a?: number;
}
/**
- * Returns attributes for the specified node.
+ * An array of quad vertices, x immediately followed by y for each point, points clock-wise.
*/
- export type getAttributesParameters = {
+ export type Quad = number[];
+ /**
+ * Box model.
+ */
+ export interface BoxModel {
/**
- * Id of the node to retrieve attributes for.
+ * Content box
*/
- nodeId: NodeId;
- }
- export type getAttributesReturnValue = {
+ content: Quad;
/**
- * An interleaved array of node attribute names and values.
+ * Padding box
*/
- attributes: string[];
- }
- /**
- * Returns boxes for the given node.
- */
- export type getBoxModelParameters = {
+ padding: Quad;
/**
- * Identifier of the node.
+ * Border box
*/
- nodeId?: NodeId;
+ border: Quad;
/**
- * Identifier of the backend node.
+ * Margin box
*/
- backendNodeId?: BackendNodeId;
+ margin: Quad;
/**
- * JavaScript object id of the node wrapper.
+ * Node width
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type getBoxModelReturnValue = {
+ width: number;
/**
- * Box model for the node.
+ * Node height
*/
- model: BoxModel;
+ height: number;
+ /**
+ * Shape outside coordinates
+ */
+ shapeOutside?: ShapeOutsideInfo;
}
/**
- * Returns quads that describe node position on the page. This method
-might return multiple quads for inline nodes.
+ * CSS Shape Outside details.
*/
- export type getContentQuadsParameters = {
- /**
- * Identifier of the node.
- */
- nodeId?: NodeId;
+ export interface ShapeOutsideInfo {
/**
- * Identifier of the backend node.
+ * Shape bounds
*/
- backendNodeId?: BackendNodeId;
+ bounds: Quad;
/**
- * JavaScript object id of the node wrapper.
+ * Shape coordinate details
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type getContentQuadsReturnValue = {
+ shape: any[];
/**
- * Quads that describe node layout relative to viewport.
+ * Margin shape bounds
*/
- quads: Quad[];
+ marginShape: any[];
}
/**
- * Returns the root DOM node (and optionally the subtree) to the caller.
-Implicitly enables the DOM domain events for the current target.
+ * Rectangle.
*/
- export type getDocumentParameters = {
+ export interface Rect {
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * X coordinate
*/
- depth?: number;
+ x: number;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Y coordinate
*/
- pierce?: boolean;
- }
- export type getDocumentReturnValue = {
+ y: number;
/**
- * Resulting node.
+ * Rectangle width
*/
- root: Node;
- }
- /**
- * Returns the root DOM node (and optionally the subtree) to the caller.
-Deprecated, as it is not designed to work well with the rest of the DOM agent.
-Use DOMSnapshot.captureSnapshot instead.
- */
- export type getFlattenedDocumentParameters = {
+ width: number;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Rectangle height
*/
- depth?: number;
+ height: number;
+ }
+ export interface CSSComputedStyleProperty {
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Computed style property name.
*/
- pierce?: boolean;
- }
- export type getFlattenedDocumentReturnValue = {
+ name: string;
/**
- * Resulting node.
+ * Computed style property value.
*/
- nodes: Node[];
+ value: string;
}
+
/**
- * Finds nodes with a given computed style in a subtree.
+ * Fired when `Element`'s attribute is modified.
*/
- export type getNodesForSubtreeByStyleParameters = {
+ export type attributeModifiedPayload = {
/**
- * Node ID pointing to the root of a subtree.
+ * Id of the node that has changed.
*/
nodeId: NodeId;
/**
- * The style to filter nodes by (includes nodes if any of properties matches).
- */
- computedStyles: CSSComputedStyleProperty[];
- /**
- * Whether or not iframes and shadow roots in the same target should be traversed when returning the
-results (default is false).
+ * Attribute name.
*/
- pierce?: boolean;
- }
- export type getNodesForSubtreeByStyleReturnValue = {
+ name: string;
/**
- * Resulting nodes.
+ * Attribute value.
*/
- nodeIds: NodeId[];
+ value: string;
}
/**
- * Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
-either returned or not.
+ * Fired when `Element`'s attribute is removed.
*/
- export type getNodeForLocationParameters = {
- /**
- * X coordinate.
- */
- x: number;
- /**
- * Y coordinate.
- */
- y: number;
+ export type attributeRemovedPayload = {
/**
- * False to skip to the nearest non-UA shadow root ancestor (default: false).
+ * Id of the node that has changed.
*/
- includeUserAgentShadowDOM?: boolean;
+ nodeId: NodeId;
/**
- * Whether to ignore pointer-events: none on elements and hit test them.
+ * A ttribute name.
*/
- ignorePointerEventsNone?: boolean;
+ name: string;
}
- export type getNodeForLocationReturnValue = {
- /**
- * Resulting node.
- */
- backendNodeId: BackendNodeId;
+ /**
+ * Mirrors `DOMCharacterDataModified` event.
+ */
+ export type characterDataModifiedPayload = {
/**
- * Frame this node belongs to.
+ * Id of the node that has changed.
*/
- frameId: Page.FrameId;
+ nodeId: NodeId;
/**
- * Id of the node at given coordinates, only when enabled and requested document.
+ * New text value.
*/
- nodeId?: NodeId;
+ characterData: string;
}
/**
- * Returns node's HTML markup.
+ * Fired when `Container`'s child node count has changed.
*/
- export type getOuterHTMLParameters = {
+ export type childNodeCountUpdatedPayload = {
/**
- * Identifier of the node.
+ * Id of the node that has changed.
*/
- nodeId?: NodeId;
+ nodeId: NodeId;
/**
- * Identifier of the backend node.
+ * New node count.
*/
- backendNodeId?: BackendNodeId;
+ childNodeCount: number;
+ }
+ /**
+ * Mirrors `DOMNodeInserted` event.
+ */
+ export type childNodeInsertedPayload = {
/**
- * JavaScript object id of the node wrapper.
+ * Id of the node that has changed.
*/
- objectId?: Runtime.RemoteObjectId;
+ parentNodeId: NodeId;
/**
- * Include all shadow roots. Equals to false if not specified.
+ * Id of the previous sibling.
*/
- includeShadowDOM?: boolean;
- }
- export type getOuterHTMLReturnValue = {
+ previousNodeId: NodeId;
/**
- * Outer HTML markup.
+ * Inserted node data.
*/
- outerHTML: string;
+ node: Node;
}
/**
- * Returns the id of the nearest ancestor that is a relayout boundary.
+ * Mirrors `DOMNodeRemoved` event.
*/
- export type getRelayoutBoundaryParameters = {
+ export type childNodeRemovedPayload = {
/**
- * Id of the node.
+ * Parent id.
*/
- nodeId: NodeId;
- }
- export type getRelayoutBoundaryReturnValue = {
+ parentNodeId: NodeId;
/**
- * Relayout boundary node id for the given node.
+ * Id of the node that has been removed.
*/
nodeId: NodeId;
}
/**
- * Returns search results from given `fromIndex` to given `toIndex` from the search with the given
-identifier.
+ * Called when distribution is changed.
*/
- export type getSearchResultsParameters = {
- /**
- * Unique search session identifier.
- */
- searchId: string;
+ export type distributedNodesUpdatedPayload = {
/**
- * Start index of the search result to be returned.
+ * Insertion point where distributed nodes were updated.
*/
- fromIndex: number;
+ insertionPointId: NodeId;
/**
- * End index of the search result to be returned.
+ * Distributed nodes for given insertion point.
*/
- toIndex: number;
+ distributedNodes: BackendNode[];
}
- export type getSearchResultsReturnValue = {
+ /**
+ * Fired when `Document` has been totally updated. Node ids are no longer valid.
+ */
+ export type documentUpdatedPayload = void;
+ /**
+ * Fired when `Element`'s inline style is modified via a CSS property modification.
+ */
+ export type inlineStyleInvalidatedPayload = {
/**
- * Ids of the search result nodes.
+ * Ids of the nodes for which the inline styles have been invalidated.
*/
nodeIds: NodeId[];
}
/**
- * Hides any highlight.
+ * Called when a pseudo element is added to an element.
*/
- export type hideHighlightParameters = {
- }
- export type hideHighlightReturnValue = {
- }
- /**
- * Highlights DOM node.
- */
- export type highlightNodeParameters = {
- }
- export type highlightNodeReturnValue = {
- }
- /**
- * Highlights given rectangle.
- */
- export type highlightRectParameters = {
- }
- export type highlightRectReturnValue = {
+ export type pseudoElementAddedPayload = {
+ /**
+ * Pseudo element's parent element id.
+ */
+ parentId: NodeId;
+ /**
+ * The added pseudo element.
+ */
+ pseudoElement: Node;
}
/**
- * Marks last undoable state.
+ * Called when top layer elements are changed.
*/
- export type markUndoableStateParameters = {
- }
- export type markUndoableStateReturnValue = {
- }
+ export type topLayerElementsUpdatedPayload = void;
/**
- * Moves node into the new container, places it before the given anchor.
+ * Fired when a node's scrollability state changes.
*/
- export type moveToParameters = {
+ export type scrollableFlagUpdatedPayload = {
/**
- * Id of the node to move.
+ * The id of the node.
*/
- nodeId: NodeId;
+ nodeId: DOM.NodeId;
/**
- * Id of the element to drop the moved node into.
+ * If the node is scrollable.
*/
- targetNodeId: NodeId;
+ isScrollable: boolean;
+ }
+ /**
+ * Called when a pseudo element is removed from an element.
+ */
+ export type pseudoElementRemovedPayload = {
/**
- * Drop node before this one (if absent, the moved node becomes the last child of
-`targetNodeId`).
+ * Pseudo element's parent element id.
*/
- insertBeforeNodeId?: NodeId;
- }
- export type moveToReturnValue = {
+ parentId: NodeId;
/**
- * New id of the moved node.
+ * The removed pseudo element id.
*/
- nodeId: NodeId;
+ pseudoElementId: NodeId;
}
/**
- * Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
-`cancelSearch` to end this search session.
+ * Fired when backend wants to provide client with the missing DOM structure. This happens upon
+most of the calls requesting node ids.
*/
- export type performSearchParameters = {
+ export type setChildNodesPayload = {
/**
- * Plain text or query selector or XPath search query.
+ * Parent node id to populate with children.
*/
- query: string;
+ parentId: NodeId;
/**
- * True to search in user agent shadow DOM.
+ * Child nodes array.
*/
- includeUserAgentShadowDOM?: boolean;
+ nodes: Node[];
}
- export type performSearchReturnValue = {
+ /**
+ * Called when shadow root is popped from the element.
+ */
+ export type shadowRootPoppedPayload = {
/**
- * Unique search session identifier.
+ * Host element id.
*/
- searchId: string;
+ hostId: NodeId;
/**
- * Number of search results.
+ * Shadow root id.
*/
- resultCount: number;
+ rootId: NodeId;
}
/**
- * Requests that the node is sent to the caller given its path. // FIXME, use XPath
+ * Called when shadow root is pushed into the element.
*/
- export type pushNodeByPathToFrontendParameters = {
+ export type shadowRootPushedPayload = {
/**
- * Path to node in the proprietary format.
+ * Host element id.
*/
- path: string;
- }
- export type pushNodeByPathToFrontendReturnValue = {
+ hostId: NodeId;
/**
- * Id of the node for given path.
+ * Shadow root.
*/
- nodeId: NodeId;
+ root: Node;
}
+
/**
- * Requests that a batch of nodes is sent to the caller given their backend node ids.
+ * Collects class names for the node with given id and all of it's child nodes.
*/
- export type pushNodesByBackendIdsToFrontendParameters = {
+ export type collectClassNamesFromSubtreeParameters = {
/**
- * The array of backend node ids.
+ * Id of the node to collect class names.
*/
- backendNodeIds: BackendNodeId[];
+ nodeId: NodeId;
}
- export type pushNodesByBackendIdsToFrontendReturnValue = {
+ export type collectClassNamesFromSubtreeReturnValue = {
/**
- * The array of ids of pushed nodes that correspond to the backend ids specified in
-backendNodeIds.
+ * Class name list.
*/
- nodeIds: NodeId[];
+ classNames: string[];
}
/**
- * Executes `querySelector` on a given node.
+ * Creates a deep copy of the specified node and places it into the target container before the
+given anchor.
*/
- export type querySelectorParameters = {
+ export type copyToParameters = {
/**
- * Id of the node to query upon.
+ * Id of the node to copy.
*/
nodeId: NodeId;
/**
- * Selector string.
+ * Id of the element to drop the copy into.
*/
- selector: string;
+ targetNodeId: NodeId;
+ /**
+ * Drop the copy before this node (if absent, the copy becomes the last child of
+`targetNodeId`).
+ */
+ insertBeforeNodeId?: NodeId;
}
- export type querySelectorReturnValue = {
+ export type copyToReturnValue = {
/**
- * Query selector result.
+ * Id of the node clone.
*/
nodeId: NodeId;
}
/**
- * Executes `querySelectorAll` on a given node.
+ * Describes node given its id, does not require domain to be enabled. Does not start tracking any
+objects, can be used for automation.
*/
- export type querySelectorAllParameters = {
+ export type describeNodeParameters = {
/**
- * Id of the node to query upon.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Selector string.
+ * Identifier of the backend node.
*/
- selector: string;
- }
- export type querySelectorAllReturnValue = {
+ backendNodeId?: BackendNodeId;
/**
- * Query selector result.
+ * JavaScript object id of the node wrapper.
*/
- nodeIds: NodeId[];
- }
- /**
- * Returns NodeIds of current top layer elements.
-Top layer is rendered closest to the user within a viewport, therefore its elements always
-appear on top of all other content.
- */
- export type getTopLayerElementsParameters = {
+ objectId?: Runtime.RemoteObjectId;
+ /**
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
+ */
+ depth?: number;
+ /**
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
+ */
+ pierce?: boolean;
}
- export type getTopLayerElementsReturnValue = {
+ export type describeNodeReturnValue = {
/**
- * NodeIds of top layer elements
+ * Node description.
*/
- nodeIds: NodeId[];
+ node: Node;
}
/**
- * Returns the NodeId of the matched element according to certain relations.
+ * Scrolls the specified rect of the given node into view if not already visible.
+Note: exactly one between nodeId, backendNodeId and objectId should be passed
+to identify the node.
*/
- export type getElementByRelationParameters = {
+ export type scrollIntoViewIfNeededParameters = {
/**
- * Id of the node from which to query the relation.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Type of relation to get.
+ * Identifier of the backend node.
*/
- relation: "PopoverTarget"|"InterestTarget"|"CommandFor";
- }
- export type getElementByRelationReturnValue = {
+ backendNodeId?: BackendNodeId;
/**
- * NodeId of the element matching the queried relation.
+ * JavaScript object id of the node wrapper.
*/
- nodeId: NodeId;
+ objectId?: Runtime.RemoteObjectId;
+ /**
+ * The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
+When omitted, center of the node will be used, similar to Element.scrollIntoView.
+ */
+ rect?: Rect;
+ }
+ export type scrollIntoViewIfNeededReturnValue = {
}
/**
- * Re-does the last undone action.
+ * Disables DOM agent for the given page.
*/
- export type redoParameters = {
+ export type disableParameters = {
}
- export type redoReturnValue = {
+ export type disableReturnValue = {
}
/**
- * Removes attribute with given name from an element with given id.
+ * Discards search results from the session with the given id. `getSearchResults` should no longer
+be called for that search.
*/
- export type removeAttributeParameters = {
- /**
- * Id of the element to remove attribute from.
- */
- nodeId: NodeId;
+ export type discardSearchResultsParameters = {
/**
- * Name of the attribute to remove.
+ * Unique search session identifier.
*/
- name: string;
+ searchId: string;
}
- export type removeAttributeReturnValue = {
+ export type discardSearchResultsReturnValue = {
}
/**
- * Removes node with given id.
+ * Enables DOM agent for the given page.
*/
- export type removeNodeParameters = {
+ export type enableParameters = {
/**
- * Id of the node to remove.
+ * Whether to include whitespaces in the children array of returned Nodes.
*/
- nodeId: NodeId;
+ includeWhitespace?: "none"|"all";
}
- export type removeNodeReturnValue = {
+ export type enableReturnValue = {
}
/**
- * Requests that children of the node with given id are returned to the caller in form of
-`setChildNodes` events where not only immediate children are retrieved, but all children down to
-the specified depth.
+ * Focuses the given element.
*/
- export type requestChildNodesParameters = {
+ export type focusParameters = {
/**
- * Id of the node to get children for.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Identifier of the backend node.
*/
- depth?: number;
+ backendNodeId?: BackendNodeId;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the sub-tree
-(default is false).
+ * JavaScript object id of the node wrapper.
*/
- pierce?: boolean;
+ objectId?: Runtime.RemoteObjectId;
}
- export type requestChildNodesReturnValue = {
+ export type focusReturnValue = {
}
/**
- * Requests that the node is sent to the caller given the JavaScript node object reference. All
-nodes that form the path from the node to the root are also sent to the client as a series of
-`setChildNodes` notifications.
+ * Returns attributes for the specified node.
*/
- export type requestNodeParameters = {
+ export type getAttributesParameters = {
/**
- * JavaScript object id to convert into node.
+ * Id of the node to retrieve attributes for.
*/
- objectId: Runtime.RemoteObjectId;
+ nodeId: NodeId;
}
- export type requestNodeReturnValue = {
+ export type getAttributesReturnValue = {
/**
- * Node id for given object.
+ * An interleaved array of node attribute names and values.
*/
- nodeId: NodeId;
+ attributes: string[];
}
/**
- * Resolves the JavaScript node object for a given NodeId or BackendNodeId.
+ * Returns boxes for the given node.
*/
- export type resolveNodeParameters = {
+ export type getBoxModelParameters = {
/**
- * Id of the node to resolve.
+ * Identifier of the node.
*/
nodeId?: NodeId;
/**
- * Backend identifier of the node to resolve.
- */
- backendNodeId?: DOM.BackendNodeId;
- /**
- * Symbolic group name that can be used to release multiple objects.
+ * Identifier of the backend node.
*/
- objectGroup?: string;
+ backendNodeId?: BackendNodeId;
/**
- * Execution context in which to resolve the node.
+ * JavaScript object id of the node wrapper.
*/
- executionContextId?: Runtime.ExecutionContextId;
+ objectId?: Runtime.RemoteObjectId;
}
- export type resolveNodeReturnValue = {
+ export type getBoxModelReturnValue = {
/**
- * JavaScript object wrapper for given node.
+ * Box model for the node.
*/
- object: Runtime.RemoteObject;
+ model: BoxModel;
}
/**
- * Sets attribute for an element with given id.
+ * Returns quads that describe node position on the page. This method
+might return multiple quads for inline nodes.
*/
- export type setAttributeValueParameters = {
+ export type getContentQuadsParameters = {
/**
- * Id of the element to set attribute for.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Attribute name.
+ * Identifier of the backend node.
*/
- name: string;
+ backendNodeId?: BackendNodeId;
/**
- * Attribute value.
+ * JavaScript object id of the node wrapper.
*/
- value: string;
+ objectId?: Runtime.RemoteObjectId;
}
- export type setAttributeValueReturnValue = {
+ export type getContentQuadsReturnValue = {
+ /**
+ * Quads that describe node layout relative to viewport.
+ */
+ quads: Quad[];
}
/**
- * Sets attributes on element with given id. This method is useful when user edits some existing
-attribute value and types in several attribute name/value pairs.
+ * Returns the root DOM node (and optionally the subtree) to the caller.
+Implicitly enables the DOM domain events for the current target.
*/
- export type setAttributesAsTextParameters = {
+ export type getDocumentParameters = {
/**
- * Id of the element to set attributes for.
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- nodeId: NodeId;
+ depth?: number;
/**
- * Text with a number of attributes. Will parse this text using HTML parser.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
*/
- text: string;
+ pierce?: boolean;
+ }
+ export type getDocumentReturnValue = {
/**
- * Attribute name to replace with new attributes derived from text in case text parsed
-successfully.
+ * Resulting node.
*/
- name?: string;
- }
- export type setAttributesAsTextReturnValue = {
+ root: Node;
}
/**
- * Sets files for the given file input element.
+ * Returns the root DOM node (and optionally the subtree) to the caller.
+Deprecated, as it is not designed to work well with the rest of the DOM agent.
+Use DOMSnapshot.captureSnapshot instead.
*/
- export type setFileInputFilesParameters = {
- /**
- * Array of file paths to set.
- */
- files: string[];
+ export type getFlattenedDocumentParameters = {
/**
- * Identifier of the node.
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- nodeId?: NodeId;
+ depth?: number;
/**
- * Identifier of the backend node.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
*/
- backendNodeId?: BackendNodeId;
+ pierce?: boolean;
+ }
+ export type getFlattenedDocumentReturnValue = {
/**
- * JavaScript object id of the node wrapper.
+ * Resulting node.
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type setFileInputFilesReturnValue = {
+ nodes: Node[];
}
/**
- * Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
+ * Finds nodes with a given computed style in a subtree.
*/
- export type setNodeStackTracesEnabledParameters = {
+ export type getNodesForSubtreeByStyleParameters = {
/**
- * Enable or disable.
+ * Node ID pointing to the root of a subtree.
*/
- enable: boolean;
+ nodeId: NodeId;
+ /**
+ * The style to filter nodes by (includes nodes if any of properties matches).
+ */
+ computedStyles: CSSComputedStyleProperty[];
+ /**
+ * Whether or not iframes and shadow roots in the same target should be traversed when returning the
+results (default is false).
+ */
+ pierce?: boolean;
}
- export type setNodeStackTracesEnabledReturnValue = {
+ export type getNodesForSubtreeByStyleReturnValue = {
+ /**
+ * Resulting nodes.
+ */
+ nodeIds: NodeId[];
}
/**
- * Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
+ * Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
+either returned or not.
*/
- export type getNodeStackTracesParameters = {
+ export type getNodeForLocationParameters = {
/**
- * Id of the node to get stack traces for.
+ * X coordinate.
*/
- nodeId: NodeId;
+ x: number;
+ /**
+ * Y coordinate.
+ */
+ y: number;
+ /**
+ * False to skip to the nearest non-UA shadow root ancestor (default: false).
+ */
+ includeUserAgentShadowDOM?: boolean;
+ /**
+ * Whether to ignore pointer-events: none on elements and hit test them.
+ */
+ ignorePointerEventsNone?: boolean;
}
- export type getNodeStackTracesReturnValue = {
+ export type getNodeForLocationReturnValue = {
/**
- * Creation stack trace, if available.
+ * Resulting node.
*/
- creation?: Runtime.StackTrace;
+ backendNodeId: BackendNodeId;
+ /**
+ * Frame this node belongs to.
+ */
+ frameId: Page.FrameId;
+ /**
+ * Id of the node at given coordinates, only when enabled and requested document.
+ */
+ nodeId?: NodeId;
}
/**
- * Returns file information for the given
-File wrapper.
+ * Returns node's HTML markup.
*/
- export type getFileInfoParameters = {
+ export type getOuterHTMLParameters = {
+ /**
+ * Identifier of the node.
+ */
+ nodeId?: NodeId;
+ /**
+ * Identifier of the backend node.
+ */
+ backendNodeId?: BackendNodeId;
/**
* JavaScript object id of the node wrapper.
*/
- objectId: Runtime.RemoteObjectId;
- }
- export type getFileInfoReturnValue = {
- path: string;
- }
- /**
- * Returns list of detached nodes
- */
- export type getDetachedDomNodesParameters = {
- }
- export type getDetachedDomNodesReturnValue = {
+ objectId?: Runtime.RemoteObjectId;
/**
- * The list of detached nodes
+ * Include all shadow roots. Equals to false if not specified.
*/
- detachedNodes: DetachedElementInfo[];
+ includeShadowDOM?: boolean;
}
- /**
- * Enables console to refer to the node with given id via $x (see Command Line API for more details
-$x functions).
- */
- export type setInspectedNodeParameters = {
+ export type getOuterHTMLReturnValue = {
/**
- * DOM node id to be accessible by means of $x command line API.
+ * Outer HTML markup.
*/
- nodeId: NodeId;
- }
- export type setInspectedNodeReturnValue = {
+ outerHTML: string;
}
/**
- * Sets node name for a node with given id.
+ * Returns the id of the nearest ancestor that is a relayout boundary.
*/
- export type setNodeNameParameters = {
+ export type getRelayoutBoundaryParameters = {
/**
- * Id of the node to set name for.
+ * Id of the node.
*/
nodeId: NodeId;
- /**
- * New node's name.
- */
- name: string;
}
- export type setNodeNameReturnValue = {
+ export type getRelayoutBoundaryReturnValue = {
/**
- * New node's id.
+ * Relayout boundary node id for the given node.
*/
nodeId: NodeId;
}
/**
- * Sets node value for a node with given id.
+ * Returns search results from given `fromIndex` to given `toIndex` from the search with the given
+identifier.
*/
- export type setNodeValueParameters = {
+ export type getSearchResultsParameters = {
/**
- * Id of the node to set value for.
+ * Unique search session identifier.
*/
- nodeId: NodeId;
+ searchId: string;
/**
- * New node's value.
+ * Start index of the search result to be returned.
*/
- value: string;
+ fromIndex: number;
+ /**
+ * End index of the search result to be returned.
+ */
+ toIndex: number;
}
- export type setNodeValueReturnValue = {
+ export type getSearchResultsReturnValue = {
+ /**
+ * Ids of the search result nodes.
+ */
+ nodeIds: NodeId[];
}
/**
- * Sets node HTML markup, returns new node id.
+ * Hides any highlight.
*/
- export type setOuterHTMLParameters = {
- /**
- * Id of the node to set markup for.
- */
- nodeId: NodeId;
- /**
- * Outer HTML markup to set.
- */
- outerHTML: string;
+ export type hideHighlightParameters = {
}
- export type setOuterHTMLReturnValue = {
+ export type hideHighlightReturnValue = {
}
/**
- * Undoes the last performed action.
+ * Highlights DOM node.
*/
- export type undoParameters = {
+ export type highlightNodeParameters = {
}
- export type undoReturnValue = {
+ export type highlightNodeReturnValue = {
}
/**
- * Returns iframe node that owns iframe with the given domain.
+ * Highlights given rectangle.
*/
- export type getFrameOwnerParameters = {
- frameId: Page.FrameId;
+ export type highlightRectParameters = {
}
- export type getFrameOwnerReturnValue = {
- /**
- * Resulting node.
- */
- backendNodeId: BackendNodeId;
- /**
- * Id of the node at given coordinates, only when enabled and requested document.
- */
- nodeId?: NodeId;
+ export type highlightRectReturnValue = {
}
/**
- * Returns the query container of the given node based on container query
-conditions: containerName, physical and logical axes, and whether it queries
-scroll-state or anchored elements. If no axes are provided and
-queriesScrollState is false, the style container is returned, which is the
-direct parent or the closest element with a matching container-name.
+ * Marks last undoable state.
*/
- export type getContainerForNodeParameters = {
- nodeId: NodeId;
- containerName?: string;
- physicalAxes?: PhysicalAxes;
- logicalAxes?: LogicalAxes;
- queriesScrollState?: boolean;
- queriesAnchored?: boolean;
+ export type markUndoableStateParameters = {
}
- export type getContainerForNodeReturnValue = {
- /**
- * The container node for the given node, or null if not found.
- */
- nodeId?: NodeId;
+ export type markUndoableStateReturnValue = {
}
/**
- * Returns the descendants of a container query container that have
-container queries against this container.
+ * Moves node into the new container, places it before the given anchor.
*/
- export type getQueryingDescendantsForContainerParameters = {
+ export type moveToParameters = {
/**
- * Id of the container node to find querying descendants from.
+ * Id of the node to move.
*/
nodeId: NodeId;
- }
- export type getQueryingDescendantsForContainerReturnValue = {
- /**
- * Descendant nodes with container queries against the given container.
- */
- nodeIds: NodeId[];
- }
- /**
- * Returns the target anchor element of the given anchor query according to
-https://www.w3.org/TR/css-anchor-position-1/#target.
- */
- export type getAnchorElementParameters = {
/**
- * Id of the positioned element from which to find the anchor.
+ * Id of the element to drop the moved node into.
*/
- nodeId: NodeId;
+ targetNodeId: NodeId;
/**
- * An optional anchor specifier, as defined in
-https://www.w3.org/TR/css-anchor-position-1/#anchor-specifier.
-If not provided, it will return the implicit anchor element for
-the given positioned element.
+ * Drop node before this one (if absent, the moved node becomes the last child of
+`targetNodeId`).
*/
- anchorSpecifier?: string;
+ insertBeforeNodeId?: NodeId;
}
- export type getAnchorElementReturnValue = {
+ export type moveToReturnValue = {
/**
- * The anchor element of the given anchor query.
+ * New id of the moved node.
*/
nodeId: NodeId;
}
/**
- * When enabling, this API force-opens the popover identified by nodeId
-and keeps it open until disabled.
+ * Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
+`cancelSearch` to end this search session.
*/
- export type forceShowPopoverParameters = {
+ export type performSearchParameters = {
/**
- * Id of the popover HTMLElement
+ * Plain text or query selector or XPath search query.
*/
- nodeId: NodeId;
+ query: string;
/**
- * If true, opens the popover and keeps it open. If false, closes the
-popover if it was previously force-opened.
+ * True to search in user agent shadow DOM.
*/
- enable: boolean;
+ includeUserAgentShadowDOM?: boolean;
}
- export type forceShowPopoverReturnValue = {
+ export type performSearchReturnValue = {
/**
- * List of popovers that were closed in order to respect popover stacking order.
+ * Unique search session identifier.
*/
- nodeIds: NodeId[];
+ searchId: string;
+ /**
+ * Number of search results.
+ */
+ resultCount: number;
}
- }
-
- /**
- * DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
-execution will stop on these operations as if there was a regular breakpoint set.
- */
- export module DOMDebugger {
- /**
- * DOM breakpoint type.
- */
- export type DOMBreakpointType = "subtree-modified"|"attribute-modified"|"node-removed";
- /**
- * CSP Violation type.
- */
- export type CSPViolationType = "trustedtype-sink-violation"|"trustedtype-policy-violation";
/**
- * Object event listener.
+ * Requests that the node is sent to the caller given its path. // FIXME, use XPath
*/
- export interface EventListener {
+ export type pushNodeByPathToFrontendParameters = {
/**
- * `EventListener`'s type.
+ * Path to node in the proprietary format.
*/
- type: string;
+ path: string;
+ }
+ export type pushNodeByPathToFrontendReturnValue = {
/**
- * `EventListener`'s useCapture.
+ * Id of the node for given path.
*/
- useCapture: boolean;
+ nodeId: NodeId;
+ }
+ /**
+ * Requests that a batch of nodes is sent to the caller given their backend node ids.
+ */
+ export type pushNodesByBackendIdsToFrontendParameters = {
/**
- * `EventListener`'s passive flag.
+ * The array of backend node ids.
*/
- passive: boolean;
+ backendNodeIds: BackendNodeId[];
+ }
+ export type pushNodesByBackendIdsToFrontendReturnValue = {
/**
- * `EventListener`'s once flag.
+ * The array of ids of pushed nodes that correspond to the backend ids specified in
+backendNodeIds.
*/
- once: boolean;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Executes `querySelector` on a given node.
+ */
+ export type querySelectorParameters = {
/**
- * Script id of the handler code.
+ * Id of the node to query upon.
*/
- scriptId: Runtime.ScriptId;
+ nodeId: NodeId;
/**
- * Line number in the script (0-based).
+ * Selector string.
*/
- lineNumber: number;
+ selector: string;
+ }
+ export type querySelectorReturnValue = {
/**
- * Column number in the script (0-based).
+ * Query selector result.
*/
- columnNumber: number;
+ nodeId: NodeId;
+ }
+ /**
+ * Executes `querySelectorAll` on a given node.
+ */
+ export type querySelectorAllParameters = {
/**
- * Event handler function value.
+ * Id of the node to query upon.
*/
- handler?: Runtime.RemoteObject;
+ nodeId: NodeId;
/**
- * Event original handler function value.
+ * Selector string.
*/
- originalHandler?: Runtime.RemoteObject;
+ selector: string;
+ }
+ export type querySelectorAllReturnValue = {
/**
- * Node the listener is added to (if any).
+ * Query selector result.
*/
- backendNodeId?: DOM.BackendNodeId;
+ nodeIds: NodeId[];
}
-
-
/**
- * Returns event listeners of the given object.
+ * Returns NodeIds of current top layer elements.
+Top layer is rendered closest to the user within a viewport, therefore its elements always
+appear on top of all other content.
*/
- export type getEventListenersParameters = {
+ export type getTopLayerElementsParameters = {
+ }
+ export type getTopLayerElementsReturnValue = {
/**
- * Identifier of the object to return listeners for.
+ * NodeIds of top layer elements
*/
- objectId: Runtime.RemoteObjectId;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Returns the NodeId of the matched element according to certain relations.
+ */
+ export type getElementByRelationParameters = {
/**
- * The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Id of the node from which to query the relation.
*/
- depth?: number;
+ nodeId: NodeId;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false). Reports listeners for all contexts if pierce is enabled.
+ * Type of relation to get.
*/
- pierce?: boolean;
+ relation: "PopoverTarget"|"InterestTarget"|"CommandFor";
}
- export type getEventListenersReturnValue = {
+ export type getElementByRelationReturnValue = {
/**
- * Array of relevant listeners.
+ * NodeId of the element matching the queried relation.
*/
- listeners: EventListener[];
+ nodeId: NodeId;
}
/**
- * Removes DOM breakpoint that was set using `setDOMBreakpoint`.
+ * Re-does the last undone action.
*/
- export type removeDOMBreakpointParameters = {
+ export type redoParameters = {
+ }
+ export type redoReturnValue = {
+ }
+ /**
+ * Removes attribute with given name from an element with given id.
+ */
+ export type removeAttributeParameters = {
/**
- * Identifier of the node to remove breakpoint from.
+ * Id of the element to remove attribute from.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * Type of the breakpoint to remove.
+ * Name of the attribute to remove.
*/
- type: DOMBreakpointType;
+ name: string;
}
- export type removeDOMBreakpointReturnValue = {
+ export type removeAttributeReturnValue = {
}
/**
- * Removes breakpoint on particular DOM event.
+ * Removes node with given id.
*/
- export type removeEventListenerBreakpointParameters = {
+ export type removeNodeParameters = {
/**
- * Event name.
- */
- eventName: string;
- /**
- * EventTarget interface name.
+ * Id of the node to remove.
*/
- targetName?: string;
+ nodeId: NodeId;
}
- export type removeEventListenerBreakpointReturnValue = {
+ export type removeNodeReturnValue = {
}
/**
- * Removes breakpoint on particular native event.
+ * Requests that children of the node with given id are returned to the caller in form of
+`setChildNodes` events where not only immediate children are retrieved, but all children down to
+the specified depth.
*/
- export type removeInstrumentationBreakpointParameters = {
+ export type requestChildNodesParameters = {
/**
- * Instrumentation name to stop on.
+ * Id of the node to get children for.
*/
- eventName: string;
+ nodeId: NodeId;
+ /**
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
+ */
+ depth?: number;
+ /**
+ * Whether or not iframes and shadow roots should be traversed when returning the sub-tree
+(default is false).
+ */
+ pierce?: boolean;
}
- export type removeInstrumentationBreakpointReturnValue = {
+ export type requestChildNodesReturnValue = {
}
/**
- * Removes breakpoint from XMLHttpRequest.
+ * Requests that the node is sent to the caller given the JavaScript node object reference. All
+nodes that form the path from the node to the root are also sent to the client as a series of
+`setChildNodes` notifications.
*/
- export type removeXHRBreakpointParameters = {
+ export type requestNodeParameters = {
/**
- * Resource URL substring.
+ * JavaScript object id to convert into node.
*/
- url: string;
+ objectId: Runtime.RemoteObjectId;
}
- export type removeXHRBreakpointReturnValue = {
+ export type requestNodeReturnValue = {
+ /**
+ * Node id for given object.
+ */
+ nodeId: NodeId;
}
/**
- * Sets breakpoint on particular CSP violations.
+ * Resolves the JavaScript node object for a given NodeId or BackendNodeId.
*/
- export type setBreakOnCSPViolationParameters = {
+ export type resolveNodeParameters = {
/**
- * CSP Violations to stop upon.
+ * Id of the node to resolve.
*/
- violationTypes: CSPViolationType[];
+ nodeId?: NodeId;
+ /**
+ * Backend identifier of the node to resolve.
+ */
+ backendNodeId?: DOM.BackendNodeId;
+ /**
+ * Symbolic group name that can be used to release multiple objects.
+ */
+ objectGroup?: string;
+ /**
+ * Execution context in which to resolve the node.
+ */
+ executionContextId?: Runtime.ExecutionContextId;
}
- export type setBreakOnCSPViolationReturnValue = {
+ export type resolveNodeReturnValue = {
+ /**
+ * JavaScript object wrapper for given node.
+ */
+ object: Runtime.RemoteObject;
}
/**
- * Sets breakpoint on particular operation with DOM.
+ * Sets attribute for an element with given id.
*/
- export type setDOMBreakpointParameters = {
+ export type setAttributeValueParameters = {
/**
- * Identifier of the node to set breakpoint on.
+ * Id of the element to set attribute for.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * Type of the operation to stop upon.
+ * Attribute name.
*/
- type: DOMBreakpointType;
+ name: string;
+ /**
+ * Attribute value.
+ */
+ value: string;
}
- export type setDOMBreakpointReturnValue = {
+ export type setAttributeValueReturnValue = {
}
/**
- * Sets breakpoint on particular DOM event.
+ * Sets attributes on element with given id. This method is useful when user edits some existing
+attribute value and types in several attribute name/value pairs.
*/
- export type setEventListenerBreakpointParameters = {
+ export type setAttributesAsTextParameters = {
/**
- * DOM Event name to stop on (any DOM event will do).
+ * Id of the element to set attributes for.
*/
- eventName: string;
+ nodeId: NodeId;
/**
- * EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
-EventTarget.
+ * Text with a number of attributes. Will parse this text using HTML parser.
*/
- targetName?: string;
+ text: string;
+ /**
+ * Attribute name to replace with new attributes derived from text in case text parsed
+successfully.
+ */
+ name?: string;
}
- export type setEventListenerBreakpointReturnValue = {
+ export type setAttributesAsTextReturnValue = {
}
/**
- * Sets breakpoint on particular native event.
+ * Sets files for the given file input element.
*/
- export type setInstrumentationBreakpointParameters = {
+ export type setFileInputFilesParameters = {
/**
- * Instrumentation name to stop on.
+ * Array of file paths to set.
*/
- eventName: string;
+ files: string[];
+ /**
+ * Identifier of the node.
+ */
+ nodeId?: NodeId;
+ /**
+ * Identifier of the backend node.
+ */
+ backendNodeId?: BackendNodeId;
+ /**
+ * JavaScript object id of the node wrapper.
+ */
+ objectId?: Runtime.RemoteObjectId;
}
- export type setInstrumentationBreakpointReturnValue = {
+ export type setFileInputFilesReturnValue = {
}
/**
- * Sets breakpoint on XMLHttpRequest.
+ * Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
*/
- export type setXHRBreakpointParameters = {
+ export type setNodeStackTracesEnabledParameters = {
/**
- * Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
+ * Enable or disable.
*/
- url: string;
+ enable: boolean;
}
- export type setXHRBreakpointReturnValue = {
+ export type setNodeStackTracesEnabledReturnValue = {
}
- }
-
- /**
- * EventBreakpoints permits setting JavaScript breakpoints on operations and events
-occurring in native code invoked from JavaScript. Once breakpoint is hit, it is
-reported through Debugger domain, similarly to regular breakpoints being hit.
- */
- export module EventBreakpoints {
-
-
/**
- * Sets breakpoint on particular native event.
+ * Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
*/
- export type setInstrumentationBreakpointParameters = {
+ export type getNodeStackTracesParameters = {
/**
- * Instrumentation name to stop on.
+ * Id of the node to get stack traces for.
*/
- eventName: string;
+ nodeId: NodeId;
}
- export type setInstrumentationBreakpointReturnValue = {
+ export type getNodeStackTracesReturnValue = {
+ /**
+ * Creation stack trace, if available.
+ */
+ creation?: Runtime.StackTrace;
}
/**
- * Removes breakpoint on particular native event.
+ * Returns file information for the given
+File wrapper.
*/
- export type removeInstrumentationBreakpointParameters = {
+ export type getFileInfoParameters = {
/**
- * Instrumentation name to stop on.
+ * JavaScript object id of the node wrapper.
*/
- eventName: string;
+ objectId: Runtime.RemoteObjectId;
}
- export type removeInstrumentationBreakpointReturnValue = {
+ export type getFileInfoReturnValue = {
+ path: string;
}
/**
- * Removes all breakpoints
+ * Returns list of detached nodes
*/
- export type disableParameters = {
+ export type getDetachedDomNodesParameters = {
}
- export type disableReturnValue = {
+ export type getDetachedDomNodesReturnValue = {
+ /**
+ * The list of detached nodes
+ */
+ detachedNodes: DetachedElementInfo[];
}
- }
-
- /**
- * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
- */
- export module DOMSnapshot {
/**
- * A Node in the DOM tree.
+ * Enables console to refer to the node with given id via $x (see Command Line API for more details
+$x functions).
*/
- export interface DOMNode {
+ export type setInspectedNodeParameters = {
/**
- * `Node`'s nodeType.
+ * DOM node id to be accessible by means of $x command line API.
*/
- nodeType: number;
+ nodeId: NodeId;
+ }
+ export type setInspectedNodeReturnValue = {
+ }
+ /**
+ * Sets node name for a node with given id.
+ */
+ export type setNodeNameParameters = {
/**
- * `Node`'s nodeName.
+ * Id of the node to set name for.
*/
- nodeName: string;
+ nodeId: NodeId;
/**
- * `Node`'s nodeValue.
+ * New node's name.
*/
- nodeValue: string;
+ name: string;
+ }
+ export type setNodeNameReturnValue = {
/**
- * Only set for textarea elements, contains the text value.
+ * New node's id.
*/
- textValue?: string;
+ nodeId: NodeId;
+ }
+ /**
+ * Sets node value for a node with given id.
+ */
+ export type setNodeValueParameters = {
/**
- * Only set for input elements, contains the input's associated text value.
+ * Id of the node to set value for.
*/
- inputValue?: string;
+ nodeId: NodeId;
/**
- * Only set for radio and checkbox input elements, indicates if the element has been checked
+ * New node's value.
*/
- inputChecked?: boolean;
+ value: string;
+ }
+ export type setNodeValueReturnValue = {
+ }
+ /**
+ * Sets node HTML markup, returns new node id.
+ */
+ export type setOuterHTMLParameters = {
/**
- * Only set for option elements, indicates if the element has been selected
+ * Id of the node to set markup for.
*/
- optionSelected?: boolean;
+ nodeId: NodeId;
/**
- * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ * Outer HTML markup to set.
*/
- backendNodeId: DOM.BackendNodeId;
- /**
- * The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
-any.
- */
- childNodeIndexes?: number[];
+ outerHTML: string;
+ }
+ export type setOuterHTMLReturnValue = {
+ }
+ /**
+ * Undoes the last performed action.
+ */
+ export type undoParameters = {
+ }
+ export type undoReturnValue = {
+ }
+ /**
+ * Returns iframe node that owns iframe with the given domain.
+ */
+ export type getFrameOwnerParameters = {
+ frameId: Page.FrameId;
+ }
+ export type getFrameOwnerReturnValue = {
/**
- * Attributes of an `Element` node.
+ * Resulting node.
*/
- attributes?: NameValue[];
+ backendNodeId: BackendNodeId;
/**
- * Indexes of pseudo elements associated with this node in the `domNodes` array returned by
-`getSnapshot`, if any.
+ * Id of the node at given coordinates, only when enabled and requested document.
*/
- pseudoElementIndexes?: number[];
+ nodeId?: NodeId;
+ }
+ /**
+ * Returns the query container of the given node based on container query
+conditions: containerName, physical and logical axes, and whether it queries
+scroll-state or anchored elements. If no axes are provided and
+queriesScrollState is false, the style container is returned, which is the
+direct parent or the closest element with a matching container-name.
+ */
+ export type getContainerForNodeParameters = {
+ nodeId: NodeId;
+ containerName?: string;
+ physicalAxes?: PhysicalAxes;
+ logicalAxes?: LogicalAxes;
+ queriesScrollState?: boolean;
+ queriesAnchored?: boolean;
+ }
+ export type getContainerForNodeReturnValue = {
/**
- * The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
-`getSnapshot`, if any.
+ * The container node for the given node, or null if not found.
*/
- layoutNodeIndex?: number;
+ nodeId?: NodeId;
+ }
+ /**
+ * Returns the descendants of a container query container that have
+container queries against this container.
+ */
+ export type getQueryingDescendantsForContainerParameters = {
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * Id of the container node to find querying descendants from.
*/
- documentURL?: string;
+ nodeId: NodeId;
+ }
+ export type getQueryingDescendantsForContainerReturnValue = {
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Descendant nodes with container queries against the given container.
*/
- baseURL?: string;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Returns the target anchor element of the given anchor query according to
+https://www.w3.org/TR/css-anchor-position-1/#target.
+ */
+ export type getAnchorElementParameters = {
/**
- * Only set for documents, contains the document's content language.
+ * Id of the positioned element from which to find the anchor.
*/
- contentLanguage?: string;
+ nodeId: NodeId;
/**
- * Only set for documents, contains the document's character set encoding.
+ * An optional anchor specifier, as defined in
+https://www.w3.org/TR/css-anchor-position-1/#anchor-specifier.
+If not provided, it will return the implicit anchor element for
+the given positioned element.
*/
- documentEncoding?: string;
+ anchorSpecifier?: string;
+ }
+ export type getAnchorElementReturnValue = {
/**
- * `DocumentType` node's publicId.
+ * The anchor element of the given anchor query.
*/
- publicId?: string;
+ nodeId: NodeId;
+ }
+ /**
+ * When enabling, this API force-opens the popover identified by nodeId
+and keeps it open until disabled.
+ */
+ export type forceShowPopoverParameters = {
/**
- * `DocumentType` node's systemId.
+ * Id of the popover HTMLElement
*/
- systemId?: string;
+ nodeId: NodeId;
/**
- * Frame ID for frame owner elements and also for the document node.
+ * If true, opens the popover and keeps it open. If false, closes the
+popover if it was previously force-opened.
*/
- frameId?: Page.FrameId;
+ enable: boolean;
+ }
+ export type forceShowPopoverReturnValue = {
/**
- * The index of a frame owner element's content document in the `domNodes` array returned by
-`getSnapshot`, if any.
+ * List of popovers that were closed in order to respect popover stacking order.
*/
- contentDocumentIndex?: number;
+ nodeIds: NodeId[];
+ }
+ }
+
+ /**
+ * DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
+execution will stop on these operations as if there was a regular breakpoint set.
+ */
+ export module DOMDebugger {
+ /**
+ * DOM breakpoint type.
+ */
+ export type DOMBreakpointType = "subtree-modified"|"attribute-modified"|"node-removed";
+ /**
+ * CSP Violation type.
+ */
+ export type CSPViolationType = "trustedtype-sink-violation"|"trustedtype-policy-violation";
+ /**
+ * Object event listener.
+ */
+ export interface EventListener {
/**
- * Type of a pseudo element node.
+ * `EventListener`'s type.
*/
- pseudoType?: DOM.PseudoType;
+ type: string;
/**
- * Shadow root type.
+ * `EventListener`'s useCapture.
*/
- shadowRootType?: DOM.ShadowRootType;
+ useCapture: boolean;
/**
- * Whether this DOM node responds to mouse clicks. This includes nodes that have had click
-event listeners attached via JavaScript as well as anchor tags that naturally navigate when
-clicked.
+ * `EventListener`'s passive flag.
*/
- isClickable?: boolean;
+ passive: boolean;
/**
- * Details of the node's event listeners, if any.
+ * `EventListener`'s once flag.
*/
- eventListeners?: DOMDebugger.EventListener[];
+ once: boolean;
/**
- * The selected url for nodes with a srcset attribute.
+ * Script id of the handler code.
*/
- currentSourceURL?: string;
+ scriptId: Runtime.ScriptId;
/**
- * The url of the script (if any) that generates this node.
+ * Line number in the script (0-based).
*/
- originURL?: string;
+ lineNumber: number;
/**
- * Scroll offsets, set when this node is a Document.
+ * Column number in the script (0-based).
*/
- scrollOffsetX?: number;
- scrollOffsetY?: number;
- }
- /**
- * Details of post layout rendered text positions. The exact layout should not be regarded as
-stable and may change between versions.
- */
- export interface InlineTextBox {
+ columnNumber: number;
/**
- * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
+ * Event handler function value.
*/
- boundingBox: DOM.Rect;
+ handler?: Runtime.RemoteObject;
/**
- * The starting index in characters, for this post layout textbox substring. Characters that
-would be represented as a surrogate pair in UTF-16 have length 2.
+ * Event original handler function value.
*/
- startCharacterIndex: number;
+ originalHandler?: Runtime.RemoteObject;
/**
- * The number of characters in this post layout textbox substring. Characters that would be
-represented as a surrogate pair in UTF-16 have length 2.
+ * Node the listener is added to (if any).
*/
- numCharacters: number;
+ backendNodeId?: DOM.BackendNodeId;
}
+
+
/**
- * Details of an element in the DOM tree with a LayoutObject.
+ * Returns event listeners of the given object.
*/
- export interface LayoutTreeNode {
- /**
- * The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
- */
- domNodeIndex: number;
- /**
- * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
- */
- boundingBox: DOM.Rect;
- /**
- * Contents of the LayoutText, if any.
- */
- layoutText?: string;
+ export type getEventListenersParameters = {
/**
- * The post-layout inline text nodes, if any.
+ * Identifier of the object to return listeners for.
*/
- inlineTextNodes?: InlineTextBox[];
+ objectId: Runtime.RemoteObjectId;
/**
- * Index into the `computedStyles` array returned by `getSnapshot`.
+ * The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- styleIndex?: number;
+ depth?: number;
/**
- * Global paint order index, which is determined by the stacking order of the nodes. Nodes
-that are painted together will have the same index. Only provided if includePaintOrder in
-getSnapshot was true.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false). Reports listeners for all contexts if pierce is enabled.
*/
- paintOrder?: number;
+ pierce?: boolean;
+ }
+ export type getEventListenersReturnValue = {
/**
- * Set to true to indicate the element begins a new stacking context.
+ * Array of relevant listeners.
*/
- isStackingContext?: boolean;
+ listeners: EventListener[];
}
/**
- * A subset of the full ComputedStyle as defined by the request whitelist.
+ * Removes DOM breakpoint that was set using `setDOMBreakpoint`.
*/
- export interface ComputedStyle {
+ export type removeDOMBreakpointParameters = {
/**
- * Name/value pairs of computed style properties.
+ * Identifier of the node to remove breakpoint from.
*/
- properties: NameValue[];
+ nodeId: DOM.NodeId;
+ /**
+ * Type of the breakpoint to remove.
+ */
+ type: DOMBreakpointType;
+ }
+ export type removeDOMBreakpointReturnValue = {
}
/**
- * A name/value pair.
+ * Removes breakpoint on particular DOM event.
*/
- export interface NameValue {
+ export type removeEventListenerBreakpointParameters = {
/**
- * Attribute/property name.
+ * Event name.
*/
- name: string;
+ eventName: string;
/**
- * Attribute/property value.
+ * EventTarget interface name.
*/
- value: string;
+ targetName?: string;
+ }
+ export type removeEventListenerBreakpointReturnValue = {
}
/**
- * Index of the string in the strings table.
+ * Removes breakpoint on particular native event.
*/
- export type StringIndex = number;
- /**
- * Index of the string in the strings table.
- */
- export type ArrayOfStrings = StringIndex[];
+ export type removeInstrumentationBreakpointParameters = {
+ /**
+ * Instrumentation name to stop on.
+ */
+ eventName: string;
+ }
+ export type removeInstrumentationBreakpointReturnValue = {
+ }
/**
- * Data that is only present on rare nodes.
+ * Removes breakpoint from XMLHttpRequest.
*/
- export interface RareStringData {
- index: number[];
- value: StringIndex[];
- }
- export interface RareBooleanData {
- index: number[];
+ export type removeXHRBreakpointParameters = {
+ /**
+ * Resource URL substring.
+ */
+ url: string;
}
- export interface RareIntegerData {
- index: number[];
- value: number[];
+ export type removeXHRBreakpointReturnValue = {
}
- export type Rectangle = number[];
/**
- * Document snapshot.
+ * Sets breakpoint on particular CSP violations.
*/
- export interface DocumentSnapshot {
+ export type setBreakOnCSPViolationParameters = {
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * CSP Violations to stop upon.
*/
- documentURL: StringIndex;
+ violationTypes: CSPViolationType[];
+ }
+ export type setBreakOnCSPViolationReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular operation with DOM.
+ */
+ export type setDOMBreakpointParameters = {
/**
- * Document title.
+ * Identifier of the node to set breakpoint on.
*/
- title: StringIndex;
+ nodeId: DOM.NodeId;
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Type of the operation to stop upon.
*/
- baseURL: StringIndex;
+ type: DOMBreakpointType;
+ }
+ export type setDOMBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular DOM event.
+ */
+ export type setEventListenerBreakpointParameters = {
/**
- * Contains the document's content language.
+ * DOM Event name to stop on (any DOM event will do).
*/
- contentLanguage: StringIndex;
+ eventName: string;
/**
- * Contains the document's character set encoding.
+ * EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
+EventTarget.
*/
- encodingName: StringIndex;
+ targetName?: string;
+ }
+ export type setEventListenerBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular native event.
+ */
+ export type setInstrumentationBreakpointParameters = {
/**
- * `DocumentType` node's publicId.
+ * Instrumentation name to stop on.
*/
- publicId: StringIndex;
+ eventName: string;
+ }
+ export type setInstrumentationBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on XMLHttpRequest.
+ */
+ export type setXHRBreakpointParameters = {
/**
- * `DocumentType` node's systemId.
+ * Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
*/
- systemId: StringIndex;
+ url: string;
+ }
+ export type setXHRBreakpointReturnValue = {
+ }
+ }
+
+ /**
+ * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
+ */
+ export module DOMSnapshot {
+ /**
+ * A Node in the DOM tree.
+ */
+ export interface DOMNode {
/**
- * Frame ID for frame owner elements and also for the document node.
+ * `Node`'s nodeType.
*/
- frameId: StringIndex;
+ nodeType: number;
/**
- * A table with dom nodes.
+ * `Node`'s nodeName.
*/
- nodes: NodeTreeSnapshot;
+ nodeName: string;
/**
- * The nodes in the layout tree.
+ * `Node`'s nodeValue.
*/
- layout: LayoutTreeSnapshot;
+ nodeValue: string;
/**
- * The post-layout inline text nodes.
+ * Only set for textarea elements, contains the text value.
*/
- textBoxes: TextBoxSnapshot;
+ textValue?: string;
/**
- * Horizontal scroll offset.
+ * Only set for input elements, contains the input's associated text value.
*/
- scrollOffsetX?: number;
+ inputValue?: string;
/**
- * Vertical scroll offset.
+ * Only set for radio and checkbox input elements, indicates if the element has been checked
*/
- scrollOffsetY?: number;
+ inputChecked?: boolean;
/**
- * Document content width.
+ * Only set for option elements, indicates if the element has been selected
*/
- contentWidth?: number;
+ optionSelected?: boolean;
/**
- * Document content height.
+ * `Node`'s id, corresponds to DOM.Node.backendNodeId.
*/
- contentHeight?: number;
- }
- /**
- * Table containing nodes.
- */
- export interface NodeTreeSnapshot {
+ backendNodeId: DOM.BackendNodeId;
/**
- * Parent node index.
+ * The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
+any.
*/
- parentIndex?: number[];
+ childNodeIndexes?: number[];
/**
- * `Node`'s nodeType.
+ * Attributes of an `Element` node.
*/
- nodeType?: number[];
+ attributes?: NameValue[];
/**
- * Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
+ * Indexes of pseudo elements associated with this node in the `domNodes` array returned by
+`getSnapshot`, if any.
*/
- shadowRootType?: RareStringData;
+ pseudoElementIndexes?: number[];
/**
- * `Node`'s nodeName.
+ * The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
+`getSnapshot`, if any.
*/
- nodeName?: StringIndex[];
+ layoutNodeIndex?: number;
/**
- * `Node`'s nodeValue.
+ * Document URL that `Document` or `FrameOwner` node points to.
*/
- nodeValue?: StringIndex[];
+ documentURL?: string;
/**
- * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
*/
- backendNodeId?: DOM.BackendNodeId[];
+ baseURL?: string;
/**
- * Attributes of an `Element` node. Flatten name, value pairs.
+ * Only set for documents, contains the document's content language.
*/
- attributes?: ArrayOfStrings[];
+ contentLanguage?: string;
/**
- * Only set for textarea elements, contains the text value.
+ * Only set for documents, contains the document's character set encoding.
*/
- textValue?: RareStringData;
+ documentEncoding?: string;
/**
- * Only set for input elements, contains the input's associated text value.
+ * `DocumentType` node's publicId.
*/
- inputValue?: RareStringData;
+ publicId?: string;
/**
- * Only set for radio and checkbox input elements, indicates if the element has been checked
+ * `DocumentType` node's systemId.
*/
- inputChecked?: RareBooleanData;
+ systemId?: string;
/**
- * Only set for option elements, indicates if the element has been selected
+ * Frame ID for frame owner elements and also for the document node.
*/
- optionSelected?: RareBooleanData;
+ frameId?: Page.FrameId;
/**
- * The index of the document in the list of the snapshot documents.
+ * The index of a frame owner element's content document in the `domNodes` array returned by
+`getSnapshot`, if any.
*/
- contentDocumentIndex?: RareIntegerData;
+ contentDocumentIndex?: number;
/**
* Type of a pseudo element node.
*/
- pseudoType?: RareStringData;
+ pseudoType?: DOM.PseudoType;
/**
- * Pseudo element identifier for this node. Only present if there is a
-valid pseudoType.
+ * Shadow root type.
*/
- pseudoIdentifier?: RareStringData;
+ shadowRootType?: DOM.ShadowRootType;
/**
* Whether this DOM node responds to mouse clicks. This includes nodes that have had click
event listeners attached via JavaScript as well as anchor tags that naturally navigate when
clicked.
*/
- isClickable?: RareBooleanData;
+ isClickable?: boolean;
+ /**
+ * Details of the node's event listeners, if any.
+ */
+ eventListeners?: DOMDebugger.EventListener[];
/**
* The selected url for nodes with a srcset attribute.
*/
- currentSourceURL?: RareStringData;
+ currentSourceURL?: string;
/**
* The url of the script (if any) that generates this node.
*/
- originURL?: RareStringData;
+ originURL?: string;
+ /**
+ * Scroll offsets, set when this node is a Document.
+ */
+ scrollOffsetX?: number;
+ scrollOffsetY?: number;
}
/**
- * Table of details of an element in the DOM tree with a LayoutObject.
+ * Details of post layout rendered text positions. The exact layout should not be regarded as
+stable and may change between versions.
*/
- export interface LayoutTreeSnapshot {
+ export interface InlineTextBox {
/**
- * Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
+ * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
*/
- nodeIndex: number[];
+ boundingBox: DOM.Rect;
/**
- * Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
+ * The starting index in characters, for this post layout textbox substring. Characters that
+would be represented as a surrogate pair in UTF-16 have length 2.
*/
- styles: ArrayOfStrings[];
+ startCharacterIndex: number;
/**
- * The absolute position bounding box.
+ * The number of characters in this post layout textbox substring. Characters that would be
+represented as a surrogate pair in UTF-16 have length 2.
*/
- bounds: Rectangle[];
+ numCharacters: number;
+ }
+ /**
+ * Details of an element in the DOM tree with a LayoutObject.
+ */
+ export interface LayoutTreeNode {
/**
- * Contents of the LayoutText, if any.
+ * The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
*/
- text: StringIndex[];
+ domNodeIndex: number;
/**
- * Stacking context information.
+ * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
*/
- stackingContexts: RareBooleanData;
+ boundingBox: DOM.Rect;
/**
- * Global paint order index, which is determined by the stacking order of the nodes. Nodes
-that are painted together will have the same index. Only provided if includePaintOrder in
-captureSnapshot was true.
+ * Contents of the LayoutText, if any.
*/
- paintOrders?: number[];
+ layoutText?: string;
/**
- * The offset rect of nodes. Only available when includeDOMRects is set to true
+ * The post-layout inline text nodes, if any.
*/
- offsetRects?: Rectangle[];
+ inlineTextNodes?: InlineTextBox[];
+ /**
+ * Index into the `computedStyles` array returned by `getSnapshot`.
+ */
+ styleIndex?: number;
+ /**
+ * Global paint order index, which is determined by the stacking order of the nodes. Nodes
+that are painted together will have the same index. Only provided if includePaintOrder in
+getSnapshot was true.
+ */
+ paintOrder?: number;
+ /**
+ * Set to true to indicate the element begins a new stacking context.
+ */
+ isStackingContext?: boolean;
+ }
+ /**
+ * A subset of the full ComputedStyle as defined by the request whitelist.
+ */
+ export interface ComputedStyle {
+ /**
+ * Name/value pairs of computed style properties.
+ */
+ properties: NameValue[];
+ }
+ /**
+ * A name/value pair.
+ */
+ export interface NameValue {
+ /**
+ * Attribute/property name.
+ */
+ name: string;
+ /**
+ * Attribute/property value.
+ */
+ value: string;
+ }
+ /**
+ * Index of the string in the strings table.
+ */
+ export type StringIndex = number;
+ /**
+ * Index of the string in the strings table.
+ */
+ export type ArrayOfStrings = StringIndex[];
+ /**
+ * Data that is only present on rare nodes.
+ */
+ export interface RareStringData {
+ index: number[];
+ value: StringIndex[];
+ }
+ export interface RareBooleanData {
+ index: number[];
+ }
+ export interface RareIntegerData {
+ index: number[];
+ value: number[];
+ }
+ export type Rectangle = number[];
+ /**
+ * Document snapshot.
+ */
+ export interface DocumentSnapshot {
+ /**
+ * Document URL that `Document` or `FrameOwner` node points to.
+ */
+ documentURL: StringIndex;
+ /**
+ * Document title.
+ */
+ title: StringIndex;
+ /**
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ */
+ baseURL: StringIndex;
+ /**
+ * Contains the document's content language.
+ */
+ contentLanguage: StringIndex;
+ /**
+ * Contains the document's character set encoding.
+ */
+ encodingName: StringIndex;
+ /**
+ * `DocumentType` node's publicId.
+ */
+ publicId: StringIndex;
+ /**
+ * `DocumentType` node's systemId.
+ */
+ systemId: StringIndex;
+ /**
+ * Frame ID for frame owner elements and also for the document node.
+ */
+ frameId: StringIndex;
+ /**
+ * A table with dom nodes.
+ */
+ nodes: NodeTreeSnapshot;
+ /**
+ * The nodes in the layout tree.
+ */
+ layout: LayoutTreeSnapshot;
+ /**
+ * The post-layout inline text nodes.
+ */
+ textBoxes: TextBoxSnapshot;
+ /**
+ * Horizontal scroll offset.
+ */
+ scrollOffsetX?: number;
+ /**
+ * Vertical scroll offset.
+ */
+ scrollOffsetY?: number;
+ /**
+ * Document content width.
+ */
+ contentWidth?: number;
+ /**
+ * Document content height.
+ */
+ contentHeight?: number;
+ }
+ /**
+ * Table containing nodes.
+ */
+ export interface NodeTreeSnapshot {
+ /**
+ * Parent node index.
+ */
+ parentIndex?: number[];
+ /**
+ * `Node`'s nodeType.
+ */
+ nodeType?: number[];
+ /**
+ * Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
+ */
+ shadowRootType?: RareStringData;
+ /**
+ * `Node`'s nodeName.
+ */
+ nodeName?: StringIndex[];
+ /**
+ * `Node`'s nodeValue.
+ */
+ nodeValue?: StringIndex[];
+ /**
+ * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ */
+ backendNodeId?: DOM.BackendNodeId[];
+ /**
+ * Attributes of an `Element` node. Flatten name, value pairs.
+ */
+ attributes?: ArrayOfStrings[];
+ /**
+ * Only set for textarea elements, contains the text value.
+ */
+ textValue?: RareStringData;
+ /**
+ * Only set for input elements, contains the input's associated text value.
+ */
+ inputValue?: RareStringData;
+ /**
+ * Only set for radio and checkbox input elements, indicates if the element has been checked
+ */
+ inputChecked?: RareBooleanData;
+ /**
+ * Only set for option elements, indicates if the element has been selected
+ */
+ optionSelected?: RareBooleanData;
+ /**
+ * The index of the document in the list of the snapshot documents.
+ */
+ contentDocumentIndex?: RareIntegerData;
+ /**
+ * Type of a pseudo element node.
+ */
+ pseudoType?: RareStringData;
+ /**
+ * Pseudo element identifier for this node. Only present if there is a
+valid pseudoType.
+ */
+ pseudoIdentifier?: RareStringData;
+ /**
+ * Whether this DOM node responds to mouse clicks. This includes nodes that have had click
+event listeners attached via JavaScript as well as anchor tags that naturally navigate when
+clicked.
+ */
+ isClickable?: RareBooleanData;
+ /**
+ * The selected url for nodes with a srcset attribute.
+ */
+ currentSourceURL?: RareStringData;
+ /**
+ * The url of the script (if any) that generates this node.
+ */
+ originURL?: RareStringData;
+ }
+ /**
+ * Table of details of an element in the DOM tree with a LayoutObject.
+ */
+ export interface LayoutTreeSnapshot {
+ /**
+ * Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
+ */
+ nodeIndex: number[];
+ /**
+ * Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
+ */
+ styles: ArrayOfStrings[];
+ /**
+ * The absolute position bounding box.
+ */
+ bounds: Rectangle[];
+ /**
+ * Contents of the LayoutText, if any.
+ */
+ text: StringIndex[];
+ /**
+ * Stacking context information.
+ */
+ stackingContexts: RareBooleanData;
+ /**
+ * Global paint order index, which is determined by the stacking order of the nodes. Nodes
+that are painted together will have the same index. Only provided if includePaintOrder in
+captureSnapshot was true.
+ */
+ paintOrders?: number[];
+ /**
+ * The offset rect of nodes. Only available when includeDOMRects is set to true
+ */
+ offsetRects?: Rectangle[];
/**
* The scroll rect of nodes. Only available when includeDOMRects is set to true
*/
@@ -6203,22 +6353,84 @@ The final text color opacity is computed based on the opacity of all overlapping
}
}
- export module DeviceOrientation {
-
-
+ export module DeviceAccess {
/**
- * Clears the overridden Device Orientation.
+ * Device request id.
*/
- export type clearDeviceOrientationOverrideParameters = {
- }
- export type clearDeviceOrientationOverrideReturnValue = {
- }
+ export type RequestId = string;
/**
- * Overrides the Device Orientation.
+ * A device id.
*/
- export type setDeviceOrientationOverrideParameters = {
+ export type DeviceId = string;
+ /**
+ * Device information displayed in a user prompt to select a device.
+ */
+ export interface PromptDevice {
+ id: DeviceId;
/**
- * Mock alpha
+ * Display name as it appears in a device request user prompt.
+ */
+ name: string;
+ }
+
+ /**
+ * A device request opened a user prompt to select a device. Respond with the
+selectPrompt or cancelPrompt command.
+ */
+ export type deviceRequestPromptedPayload = {
+ id: RequestId;
+ devices: PromptDevice[];
+ }
+
+ /**
+ * Enable events in this domain.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disable events in this domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Select a device in response to a DeviceAccess.deviceRequestPrompted event.
+ */
+ export type selectPromptParameters = {
+ id: RequestId;
+ deviceId: DeviceId;
+ }
+ export type selectPromptReturnValue = {
+ }
+ /**
+ * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
+ */
+ export type cancelPromptParameters = {
+ id: RequestId;
+ }
+ export type cancelPromptReturnValue = {
+ }
+ }
+
+ export module DeviceOrientation {
+
+
+ /**
+ * Clears the overridden Device Orientation.
+ */
+ export type clearDeviceOrientationOverrideParameters = {
+ }
+ export type clearDeviceOrientationOverrideReturnValue = {
+ }
+ /**
+ * Overrides the Device Orientation.
+ */
+ export type setDeviceOrientationOverrideParameters = {
+ /**
+ * Mock alpha
*/
alpha: number;
/**
@@ -6387,6 +6599,95 @@ See https://w3c.github.io/sensors/#automation for more information.
export interface PressureMetadata {
available?: boolean;
}
+ export interface WorkAreaInsets {
+ /**
+ * Work area top inset in pixels. Default is 0;
+ */
+ top?: number;
+ /**
+ * Work area left inset in pixels. Default is 0;
+ */
+ left?: number;
+ /**
+ * Work area bottom inset in pixels. Default is 0;
+ */
+ bottom?: number;
+ /**
+ * Work area right inset in pixels. Default is 0;
+ */
+ right?: number;
+ }
+ export type ScreenId = string;
+ /**
+ * Screen information similar to the one returned by window.getScreenDetails() method,
+see https://w3c.github.io/window-management/#screendetailed.
+ */
+ export interface ScreenInfo {
+ /**
+ * Offset of the left edge of the screen.
+ */
+ left: number;
+ /**
+ * Offset of the top edge of the screen.
+ */
+ top: number;
+ /**
+ * Width of the screen.
+ */
+ width: number;
+ /**
+ * Height of the screen.
+ */
+ height: number;
+ /**
+ * Offset of the left edge of the available screen area.
+ */
+ availLeft: number;
+ /**
+ * Offset of the top edge of the available screen area.
+ */
+ availTop: number;
+ /**
+ * Width of the available screen area.
+ */
+ availWidth: number;
+ /**
+ * Height of the available screen area.
+ */
+ availHeight: number;
+ /**
+ * Specifies the screen's device pixel ratio.
+ */
+ devicePixelRatio: number;
+ /**
+ * Specifies the screen's orientation.
+ */
+ orientation: ScreenOrientation;
+ /**
+ * Specifies the screen's color depth in bits.
+ */
+ colorDepth: number;
+ /**
+ * Indicates whether the device has multiple screens.
+ */
+ isExtended: boolean;
+ /**
+ * Indicates whether the screen is internal to the device or external, attached to the device.
+ */
+ isInternal: boolean;
+ /**
+ * Indicates whether the screen is set as the the operating system primary screen.
+ */
+ isPrimary: boolean;
+ /**
+ * Specifies the descriptive label for the screen.
+ */
+ label: string;
+ /**
+ * Specifies the unique identifier of the screen.
+ */
+ id: ScreenId;
+ }
/**
* Enum of image types that can be disabled.
*/
@@ -6974,3243 +7275,3768 @@ of size 100lvh.
}
export type setSmallViewportHeightDifferenceOverrideReturnValue = {
}
- }
-
- /**
- * This domain provides experimental commands only supported in headless mode.
- */
- export module HeadlessExperimental {
/**
- * Encoding options for a screenshot.
+ * Returns device's screen configuration.
*/
- export interface ScreenshotParams {
+ export type getScreenInfosParameters = {
+ }
+ export type getScreenInfosReturnValue = {
+ screenInfos: ScreenInfo[];
+ }
+ /**
+ * Add a new screen to the device. Only supported in headless mode.
+ */
+ export type addScreenParameters = {
/**
- * Image compression format (defaults to png).
+ * Offset of the left edge of the screen in pixels.
*/
- format?: "jpeg"|"png"|"webp";
+ left: number;
/**
- * Compression quality from range [0..100] (jpeg and webp only).
+ * Offset of the top edge of the screen in pixels.
*/
- quality?: number;
+ top: number;
/**
- * Optimize image encoding for speed, not for resulting size (defaults to false)
+ * The width of the screen in pixels.
*/
- optimizeForSpeed?: boolean;
- }
-
-
- /**
- * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
-screenshot from the resulting frame. Requires that the target was created with enabled
-BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
-https://goo.gle/chrome-headless-rendering for more background.
- */
- export type beginFrameParameters = {
+ width: number;
/**
- * Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
-the current time will be used.
+ * The height of the screen in pixels.
*/
- frameTimeTicks?: number;
+ height: number;
/**
- * The interval between BeginFrames that is reported to the compositor, in milliseconds.
-Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
+ * Specifies the screen's work area. Default is entire screen.
*/
- interval?: number;
+ workAreaInsets?: WorkAreaInsets;
/**
- * Whether updates should not be committed and drawn onto the display. False by default. If
-true, only side effects of the BeginFrame will be run, such as layout and animations, but
-any visual updates may not be visible on the display or in screenshots.
+ * Specifies the screen's device pixel ratio. Default is 1.
*/
- noDisplayUpdates?: boolean;
+ devicePixelRatio?: number;
/**
- * If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
-no screenshot will be captured. Note that capturing a screenshot can fail, for example,
-during renderer initialization. In such a case, no screenshot data will be returned.
+ * Specifies the screen's rotation angle. Available values are 0, 90, 180 and 270. Default is 0.
*/
- screenshot?: ScreenshotParams;
- }
- export type beginFrameReturnValue = {
+ rotation?: number;
/**
- * Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
-display. Reported for diagnostic uses, may be removed in the future.
+ * Specifies the screen's color depth in bits. Default is 24.
*/
- hasDamage: boolean;
+ colorDepth?: number;
/**
- * Base64-encoded image data of the screenshot, if one was requested and successfully taken.
+ * Specifies the descriptive label for the screen. Default is none.
*/
- screenshotData?: binary;
- }
- /**
- * Disables headless events for the target.
- */
- export type disableParameters = {
+ label?: string;
+ /**
+ * Indicates whether the screen is internal to the device or external, attached to the device. Default is false.
+ */
+ isInternal?: boolean;
}
- export type disableReturnValue = {
+ export type addScreenReturnValue = {
+ screenInfo: ScreenInfo;
}
/**
- * Enables headless events for the target.
+ * Remove screen from the device. Only supported in headless mode.
*/
- export type enableParameters = {
+ export type removeScreenParameters = {
+ screenId: ScreenId;
}
- export type enableReturnValue = {
+ export type removeScreenReturnValue = {
}
}
/**
- * Input/Output operations for streams produced by DevTools.
+ * EventBreakpoints permits setting JavaScript breakpoints on operations and events
+occurring in native code invoked from JavaScript. Once breakpoint is hit, it is
+reported through Debugger domain, similarly to regular breakpoints being hit.
*/
- export module IO {
- /**
- * This is either obtained from another method or specified as `blob:<uuid>` where
-`<uuid>` is an UUID of a Blob.
- */
- export type StreamHandle = string;
+ export module EventBreakpoints {
/**
- * Close the stream, discard any temporary backing storage.
+ * Sets breakpoint on particular native event.
*/
- export type closeParameters = {
+ export type setInstrumentationBreakpointParameters = {
/**
- * Handle of the stream to close.
+ * Instrumentation name to stop on.
*/
- handle: StreamHandle;
+ eventName: string;
}
- export type closeReturnValue = {
+ export type setInstrumentationBreakpointReturnValue = {
}
/**
- * Read a chunk of the stream
+ * Removes breakpoint on particular native event.
*/
- export type readParameters = {
- /**
- * Handle of the stream to read.
- */
- handle: StreamHandle;
- /**
- * Seek to the specified offset before reading (if not specified, proceed with offset
-following the last read). Some types of streams may only support sequential reads.
- */
- offset?: number;
+ export type removeInstrumentationBreakpointParameters = {
/**
- * Maximum number of bytes to read (left upon the agent discretion if not specified).
+ * Instrumentation name to stop on.
*/
- size?: number;
+ eventName: string;
}
- export type readReturnValue = {
- /**
- * Set if the data is base64-encoded
- */
- base64Encoded?: boolean;
- /**
- * Data that were read.
- */
- data: string;
- /**
- * Set if the end-of-file condition occurred while reading.
- */
- eof: boolean;
+ export type removeInstrumentationBreakpointReturnValue = {
}
/**
- * Return UUID of Blob object specified by a remote object id.
+ * Removes all breakpoints
*/
- export type resolveBlobParameters = {
- /**
- * Object id of a Blob object wrapper.
- */
- objectId: Runtime.RemoteObjectId;
+ export type disableParameters = {
}
- export type resolveBlobReturnValue = {
- /**
- * UUID of the specified Blob.
- */
- uuid: string;
+ export type disableReturnValue = {
}
}
- export module FileSystem {
- export interface File {
- name: string;
- /**
- * Timestamp
- */
- lastModified: Network.TimeSinceEpoch;
- /**
- * Size in bytes
- */
- size: number;
- type: string;
- }
- export interface Directory {
- name: string;
- nestedDirectories: string[];
- /**
- * Files that are directly nested under this directory.
- */
- nestedFiles: File[];
- }
- export interface BucketFileSystemLocator {
- /**
- * Storage key
- */
- storageKey: Storage.SerializedStorageKey;
- /**
- * Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
- */
- bucketName?: string;
- /**
- * Path to the directory using each path component as an array item.
- */
- pathComponents: string[];
- }
+ /**
+ * Defines commands and events for browser extensions.
+ */
+ export module Extensions {
+ /**
+ * Storage areas.
+ */
+ export type StorageArea = "session"|"local"|"sync"|"managed";
- export type getDirectoryParameters = {
- bucketFileSystemLocator: BucketFileSystemLocator;
- }
- export type getDirectoryReturnValue = {
- /**
- * Returns the directory object at the path.
- */
- directory: Directory;
- }
- }
-
- export module IndexedDB {
/**
- * Database with an array of object stores.
+ * Installs an unpacked extension from the filesystem similar to
+--load-extension CLI flags. Returns extension ID once the extension
+has been installed. Available if the client is connected using the
+--remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
+flag is set.
*/
- export interface DatabaseWithObjectStores {
- /**
- * Database name.
- */
- name: string;
+ export type loadUnpackedParameters = {
/**
- * Database version (type is not 'integer', as the standard
-requires the version number to be 'unsigned long long')
+ * Absolute file path.
*/
- version: number;
+ path: string;
+ }
+ export type loadUnpackedReturnValue = {
/**
- * Object stores in this database.
+ * Extension id.
*/
- objectStores: ObjectStore[];
+ id: string;
}
/**
- * Object store.
+ * Uninstalls an unpacked extension (others not supported) from the profile.
+Available if the client is connected using the --remote-debugging-pipe flag
+and the --enable-unsafe-extension-debugging.
*/
- export interface ObjectStore {
- /**
- * Object store name.
- */
- name: string;
- /**
- * Object store key path.
- */
- keyPath: KeyPath;
- /**
- * If true, object store has auto increment flag set.
- */
- autoIncrement: boolean;
+ export type uninstallParameters = {
/**
- * Indexes in this object store.
+ * Extension id.
*/
- indexes: ObjectStoreIndex[];
+ id: string;
+ }
+ export type uninstallReturnValue = {
}
/**
- * Object store index.
+ * Gets data from extension storage in the given `storageArea`. If `keys` is
+specified, these are used to filter the result.
*/
- export interface ObjectStoreIndex {
- /**
- * Index name.
- */
- name: string;
+ export type getStorageItemsParameters = {
/**
- * Index key path.
+ * ID of extension.
*/
- keyPath: KeyPath;
+ id: string;
/**
- * If true, index is unique.
+ * StorageArea to retrieve data from.
*/
- unique: boolean;
+ storageArea: StorageArea;
/**
- * If true, index allows multiple entries for a key.
+ * Keys to retrieve.
*/
- multiEntry: boolean;
+ keys?: string[];
+ }
+ export type getStorageItemsReturnValue = {
+ data: { [key: string]: string };
}
/**
- * Key.
+ * Removes `keys` from extension storage in the given `storageArea`.
*/
- export interface Key {
- /**
- * Key type.
- */
- type: "number"|"string"|"date"|"array";
- /**
- * Number value.
- */
- number?: number;
+ export type removeStorageItemsParameters = {
/**
- * String value.
+ * ID of extension.
*/
- string?: string;
+ id: string;
/**
- * Date value.
+ * StorageArea to remove data from.
*/
- date?: number;
+ storageArea: StorageArea;
/**
- * Array value.
+ * Keys to remove.
*/
- array?: Key[];
+ keys: string[];
+ }
+ export type removeStorageItemsReturnValue = {
}
/**
- * Key range.
+ * Clears extension storage in the given `storageArea`.
*/
- export interface KeyRange {
- /**
- * Lower bound.
- */
- lower?: Key;
- /**
- * Upper bound.
- */
- upper?: Key;
+ export type clearStorageItemsParameters = {
/**
- * If true lower bound is open.
+ * ID of extension.
*/
- lowerOpen: boolean;
+ id: string;
/**
- * If true upper bound is open.
+ * StorageArea to remove data from.
*/
- upperOpen: boolean;
+ storageArea: StorageArea;
+ }
+ export type clearStorageItemsReturnValue = {
}
/**
- * Data entry.
+ * Sets `values` in extension storage in the given `storageArea`. The provided `values`
+will be merged with existing values in the storage area.
*/
- export interface DataEntry {
+ export type setStorageItemsParameters = {
/**
- * Key object.
+ * ID of extension.
*/
- key: Runtime.RemoteObject;
+ id: string;
/**
- * Primary key object.
+ * StorageArea to set data in.
*/
- primaryKey: Runtime.RemoteObject;
+ storageArea: StorageArea;
/**
- * Value object.
+ * Values to set.
*/
- value: Runtime.RemoteObject;
+ values: { [key: string]: string };
+ }
+ export type setStorageItemsReturnValue = {
}
+ }
+
+ /**
+ * This domain allows interacting with the FedCM dialog.
+ */
+ export module FedCm {
/**
- * Key path.
+ * Whether this is a sign-up or sign-in action for this account, i.e.
+whether this account has ever been used to sign in to this RP before.
*/
- export interface KeyPath {
- /**
- * Key path type.
- */
- type: "null"|"string"|"array";
+ export type LoginState = "SignIn"|"SignUp";
+ /**
+ * The types of FedCM dialogs.
+ */
+ export type DialogType = "AccountChooser"|"AutoReauthn"|"ConfirmIdpLogin"|"Error";
+ /**
+ * The buttons on the FedCM dialog.
+ */
+ export type DialogButton = "ConfirmIdpLoginContinue"|"ErrorGotIt"|"ErrorMoreDetails";
+ /**
+ * The URLs that each account has
+ */
+ export type AccountUrlType = "TermsOfService"|"PrivacyPolicy";
+ /**
+ * Corresponds to IdentityRequestAccount
+ */
+ export interface Account {
+ accountId: string;
+ email: string;
+ name: string;
+ givenName: string;
+ pictureUrl: string;
+ idpConfigUrl: string;
+ idpLoginUrl: string;
+ loginState: LoginState;
/**
- * String value.
+ * These two are only set if the loginState is signUp
*/
- string?: string;
+ termsOfServiceUrl?: string;
+ privacyPolicyUrl?: string;
+ }
+
+ export type dialogShownPayload = {
+ dialogId: string;
+ dialogType: DialogType;
+ accounts: Account[];
/**
- * Array value.
+ * These exist primarily so that the caller can verify the
+RP context was used appropriately.
*/
- array?: string[];
+ title: string;
+ subtitle?: string;
}
-
-
/**
- * Clears all entries from an object store.
+ * Triggered when a dialog is closed, either by user action, JS abort,
+or a command below.
*/
- export type clearObjectStoreParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type dialogClosedPayload = {
+ dialogId: string;
+ }
+
+ export type enableParameters = {
/**
- * Storage key.
+ * Allows callers to disable the promise rejection delay that would
+normally happen, if this is unimportant to what's being tested.
+(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
*/
- storageKey?: string;
+ disableRejectionDelay?: boolean;
+ }
+ export type enableReturnValue = {
+ }
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ export type selectAccountParameters = {
+ dialogId: string;
+ accountIndex: number;
+ }
+ export type selectAccountReturnValue = {
+ }
+ export type clickDialogButtonParameters = {
+ dialogId: string;
+ dialogButton: DialogButton;
+ }
+ export type clickDialogButtonReturnValue = {
+ }
+ export type openUrlParameters = {
+ dialogId: string;
+ accountIndex: number;
+ accountUrlType: AccountUrlType;
+ }
+ export type openUrlReturnValue = {
+ }
+ export type dismissDialogParameters = {
+ dialogId: string;
+ triggerCooldown?: boolean;
+ }
+ export type dismissDialogReturnValue = {
+ }
+ /**
+ * Resets the cooldown time, if any, to allow the next FedCM call to show
+a dialog even if one was recently dismissed by the user.
+ */
+ export type resetCooldownParameters = {
+ }
+ export type resetCooldownReturnValue = {
+ }
+ }
+
+ /**
+ * A domain for letting clients substitute browser's network layer with client code.
+ */
+ export module Fetch {
+ /**
+ * Unique request identifier.
+Note that this does not identify individual HTTP requests that are part of
+a network request.
+ */
+ export type RequestId = string;
+ /**
+ * Stages of the request to handle. Request will intercept before the request is
+sent. Response will intercept after the response is received (but before response
+body is received).
+ */
+ export type RequestStage = "Request"|"Response";
+ export interface RequestPattern {
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
+backslash. Omitting is equivalent to `"*"`.
*/
- storageBucket?: Storage.StorageBucket;
+ urlPattern?: string;
/**
- * Database name.
+ * If set, only requests for matching resource types will be intercepted.
*/
- databaseName: string;
+ resourceType?: Network.ResourceType;
/**
- * Object store name.
+ * Stage at which to begin intercepting requests. Default is Request.
*/
- objectStoreName: string;
+ requestStage?: RequestStage;
}
- export type clearObjectStoreReturnValue = {
+ /**
+ * Response HTTP header entry
+ */
+ export interface HeaderEntry {
+ name: string;
+ value: string;
}
/**
- * Deletes a database.
+ * Authorization challenge for HTTP status code 401 or 407.
*/
- export type deleteDatabaseParameters = {
+ export interface AuthChallenge {
/**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
+ * Source of the authentication challenge.
*/
- securityOrigin?: string;
+ source?: "Server"|"Proxy";
/**
- * Storage key.
+ * Origin of the challenger.
*/
- storageKey?: string;
+ origin: string;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The authentication scheme used, such as basic or digest
*/
- storageBucket?: Storage.StorageBucket;
+ scheme: string;
/**
- * Database name.
+ * The realm of the challenge. May be empty.
*/
- databaseName: string;
- }
- export type deleteDatabaseReturnValue = {
+ realm: string;
}
/**
- * Delete a range of entries from an object store
+ * Response to an AuthChallenge.
*/
- export type deleteObjectStoreEntriesParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export interface AuthChallengeResponse {
/**
- * Storage key.
+ * The decision on what to do in response to the authorization challenge. Default means
+deferring to the default behavior of the net stack, which will likely either the Cancel
+authentication or display a popup dialog box.
*/
- storageKey?: string;
+ response: "Default"|"CancelAuth"|"ProvideCredentials";
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The username to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- storageBucket?: Storage.StorageBucket;
- databaseName: string;
- objectStoreName: string;
+ username?: string;
/**
- * Range of entry keys to delete
+ * The password to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- keyRange: KeyRange;
- }
- export type deleteObjectStoreEntriesReturnValue = {
- }
- /**
- * Disables events from backend.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Enables events from backend.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
+ password?: string;
}
+
/**
- * Requests data from object store or index.
+ * Issued when the domain is enabled and the request URL matches the
+specified filter. The request is paused until the client responds
+with one of continueRequest, failRequest or fulfillRequest.
+The stage of the request can be determined by presence of responseErrorReason
+and responseStatusCode -- the request is at the response stage if either
+of these fields is present and in the request stage otherwise.
+Redirect responses and subsequent requests are reported similarly to regular
+responses and requests. Redirect responses may be distinguished by the value
+of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with
+presence of the `location` header. Requests resulting from a redirect will
+have `redirectedRequestId` field set.
*/
- export type requestDataParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type requestPausedPayload = {
/**
- * Storage key.
+ * Each request the page makes will have a unique id.
*/
- storageKey?: string;
+ requestId: RequestId;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The details of the request.
*/
- storageBucket?: Storage.StorageBucket;
+ request: Network.Request;
/**
- * Database name.
+ * The id of the frame that initiated the request.
*/
- databaseName: string;
+ frameId: Page.FrameId;
/**
- * Object store name.
+ * How the requested resource will be used.
*/
- objectStoreName: string;
+ resourceType: Network.ResourceType;
/**
- * Index name, empty string for object store data requests.
+ * Response error if intercepted at response stage.
*/
- indexName: string;
+ responseErrorReason?: Network.ErrorReason;
/**
- * Number of records to skip.
+ * Response code if intercepted at response stage.
*/
- skipCount: number;
+ responseStatusCode?: number;
/**
- * Number of records to fetch.
+ * Response status text if intercepted at response stage.
*/
- pageSize: number;
+ responseStatusText?: string;
/**
- * Key range.
+ * Response headers if intercepted at the response stage.
*/
- keyRange?: KeyRange;
- }
- export type requestDataReturnValue = {
+ responseHeaders?: HeaderEntry[];
/**
- * Array of object store data entries.
+ * If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
+then this networkId will be the same as the requestId present in the requestWillBeSent event.
*/
- objectStoreDataEntries: DataEntry[];
+ networkId?: Network.RequestId;
/**
- * If true, there are more entries to fetch in the given range.
+ * If the request is due to a redirect response from the server, the id of the request that
+has caused the redirect.
*/
- hasMore: boolean;
+ redirectedRequestId?: RequestId;
}
/**
- * Gets metadata of an object store.
+ * Issued when the domain is enabled with handleAuthRequests set to true.
+The request is paused until client responds with continueWithAuth.
*/
- export type getMetadataParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
- /**
- * Storage key.
- */
- storageKey?: string;
+ export type authRequiredPayload = {
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * Each request the page makes will have a unique id.
*/
- storageBucket?: Storage.StorageBucket;
+ requestId: RequestId;
/**
- * Database name.
+ * The details of the request.
*/
- databaseName: string;
+ request: Network.Request;
/**
- * Object store name.
+ * The id of the frame that initiated the request.
*/
- objectStoreName: string;
- }
- export type getMetadataReturnValue = {
+ frameId: Page.FrameId;
/**
- * the entries count
+ * How the requested resource will be used.
*/
- entriesCount: number;
+ resourceType: Network.ResourceType;
/**
- * the current value of key generator, to become the next inserted
-key into the object store. Valid if objectStore.autoIncrement
-is true.
+ * Details of the Authorization Challenge encountered.
+If this is set, client should respond with continueRequest that
+contains AuthChallengeResponse.
*/
- keyGeneratorValue: number;
+ authChallenge: AuthChallenge;
}
+
/**
- * Requests database with given name in given frame.
+ * Disables the fetch domain.
*/
- export type requestDatabaseParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
- /**
- * Storage key.
- */
- storageKey?: string;
- /**
- * Storage bucket. If not specified, it uses the default bucket.
- */
- storageBucket?: Storage.StorageBucket;
- /**
- * Database name.
- */
- databaseName: string;
+ export type disableParameters = {
}
- export type requestDatabaseReturnValue = {
- /**
- * Database with an array of object stores.
- */
- databaseWithObjectStores: DatabaseWithObjectStores;
+ export type disableReturnValue = {
}
/**
- * Requests database names for given security origin.
+ * Enables issuing of requestPaused events. A request will be paused until client
+calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
*/
- export type requestDatabaseNamesParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type enableParameters = {
/**
- * Storage key.
+ * If specified, only requests matching any of these patterns will produce
+fetchRequested event and will be paused until clients response. If not set,
+all requests will be affected.
*/
- storageKey?: string;
+ patterns?: RequestPattern[];
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * If true, authRequired events will be issued and requests will be paused
+expecting a call to continueWithAuth.
*/
- storageBucket?: Storage.StorageBucket;
+ handleAuthRequests?: boolean;
}
- export type requestDatabaseNamesReturnValue = {
- /**
- * Database names for origin.
- */
- databaseNames: string[];
+ export type enableReturnValue = {
}
- }
-
- export module Input {
- export interface TouchPoint {
- /**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
- */
- x: number;
- /**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
- */
- y: number;
- /**
- * X radius of the touch area (default: 1.0).
- */
- radiusX?: number;
+ /**
+ * Causes the request to fail with specified reason.
+ */
+ export type failRequestParameters = {
/**
- * Y radius of the touch area (default: 1.0).
+ * An id the client received in requestPaused event.
*/
- radiusY?: number;
+ requestId: RequestId;
/**
- * Rotation angle (default: 0.0).
+ * Causes the request to fail with the given reason.
*/
- rotationAngle?: number;
+ errorReason: Network.ErrorReason;
+ }
+ export type failRequestReturnValue = {
+ }
+ /**
+ * Provides response to the request.
+ */
+ export type fulfillRequestParameters = {
/**
- * Force (default: 1.0).
+ * An id the client received in requestPaused event.
*/
- force?: number;
+ requestId: RequestId;
/**
- * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ * An HTTP response code.
*/
- tangentialPressure?: number;
+ responseCode: number;
/**
- * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
+ * Response headers.
*/
- tiltX?: number;
+ responseHeaders?: HeaderEntry[];
/**
- * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ * Alternative way of specifying response headers as a \0-separated
+series of name: value pairs. Prefer the above method unless you
+need to represent some non-UTF8 values that can't be transmitted
+over the protocol as text.
*/
- tiltY?: number;
+ binaryResponseHeaders?: binary;
/**
- * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ * A response body. If absent, original response body will be used if
+the request is intercepted at the response stage and empty body
+will be used if the request is intercepted at the request stage.
*/
- twist?: number;
+ body?: binary;
/**
- * Identifier used to track touch sources between events, must be unique within an event.
+ * A textual representation of responseCode.
+If absent, a standard phrase matching responseCode is used.
*/
- id?: number;
+ responsePhrase?: string;
+ }
+ export type fulfillRequestReturnValue = {
}
- export type GestureSourceType = "default"|"touch"|"mouse";
- export type MouseButton = "none"|"left"|"middle"|"right"|"back"|"forward";
/**
- * UTC time in seconds, counted from January 1, 1970.
+ * Continues the request, optionally modifying some of its parameters.
*/
- export type TimeSinceEpoch = number;
- export interface DragDataItem {
+ export type continueRequestParameters = {
/**
- * Mime type of the dragged data.
+ * An id the client received in requestPaused event.
*/
- mimeType: string;
+ requestId: RequestId;
/**
- * Depending of the value of `mimeType`, it contains the dragged link,
-text, HTML markup or any other data.
+ * If set, the request url will be modified in a way that's not observable by page.
*/
- data: string;
+ url?: string;
/**
- * Title associated with a link. Only valid when `mimeType` == "text/uri-list".
+ * If set, the request method is overridden.
*/
- title?: string;
+ method?: string;
/**
- * Stores the base URL for the contained markup. Only valid when `mimeType`
-== "text/html".
+ * If set, overrides the post data in the request.
*/
- baseURL?: string;
- }
- export interface DragData {
- items: DragDataItem[];
+ postData?: binary;
/**
- * List of filenames that should be included when dropping
+ * If set, overrides the request headers. Note that the overrides do not
+extend to subsequent redirect hops, if a redirect happens. Another override
+may be applied to a different request produced by a redirect.
*/
- files?: string[];
+ headers?: HeaderEntry[];
/**
- * Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
+ * If set, overrides response interception behavior for this request.
*/
- dragOperationsMask: number;
+ interceptResponse?: boolean;
}
-
- /**
- * Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
-restore normal drag and drop behavior.
- */
- export type dragInterceptedPayload = {
- data: DragData;
+ export type continueRequestReturnValue = {
}
-
/**
- * Dispatches a drag event into the page.
+ * Continues a request supplying authChallengeResponse following authRequired event.
*/
- export type dispatchDragEventParameters = {
- /**
- * Type of the drag event.
- */
- type: "dragEnter"|"dragOver"|"drop"|"dragCancel";
- /**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
- */
- x: number;
+ export type continueWithAuthParameters = {
/**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ * An id the client received in authRequired event.
*/
- y: number;
- data: DragData;
+ requestId: RequestId;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Response to with an authChallenge.
*/
- modifiers?: number;
+ authChallengeResponse: AuthChallengeResponse;
}
- export type dispatchDragEventReturnValue = {
+ export type continueWithAuthReturnValue = {
}
/**
- * Dispatches a key event to the page.
+ * Continues loading of the paused response, optionally modifying the
+response headers. If either responseCode or headers are modified, all of them
+must be present.
*/
- export type dispatchKeyEventParameters = {
- /**
- * Type of the key event.
- */
- type: "keyDown"|"keyUp"|"rawKeyDown"|"char";
+ export type continueResponseParameters = {
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * An id the client received in requestPaused event.
*/
- modifiers?: number;
+ requestId: RequestId;
/**
- * Time at which the event occurred.
+ * An HTTP response code. If absent, original response code will be used.
*/
- timestamp?: TimeSinceEpoch;
+ responseCode?: number;
/**
- * Text as generated by processing a virtual key code with a keyboard layout. Not needed for
-for `keyUp` and `rawKeyDown` events (default: "")
+ * A textual representation of responseCode.
+If absent, a standard phrase matching responseCode is used.
*/
- text?: string;
+ responsePhrase?: string;
/**
- * Text that would have been generated by the keyboard if no modifiers were pressed (except for
-shift). Useful for shortcut (accelerator) key handling (default: "").
+ * Response headers. If absent, original response headers will be used.
*/
- unmodifiedText?: string;
+ responseHeaders?: HeaderEntry[];
/**
- * Unique key identifier (e.g., 'U+0041') (default: "").
+ * Alternative way of specifying response headers as a \0-separated
+series of name: value pairs. Prefer the above method unless you
+need to represent some non-UTF8 values that can't be transmitted
+over the protocol as text.
*/
- keyIdentifier?: string;
+ binaryResponseHeaders?: binary;
+ }
+ export type continueResponseReturnValue = {
+ }
+ /**
+ * Causes the body of the response to be received from the server and
+returned as a single string. May only be issued for a request that
+is paused in the Response stage and is mutually exclusive with
+takeResponseBodyForInterceptionAsStream. Calling other methods that
+affect the request or disabling fetch domain before body is received
+results in an undefined behavior.
+Note that the response body is not available for redirects. Requests
+paused in the _redirect received_ state may be differentiated by
+`responseCode` and presence of `location` response header, see
+comments to `requestPaused` for details.
+ */
+ export type getResponseBodyParameters = {
/**
- * Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
+ * Identifier for the intercepted request to get body for.
*/
- code?: string;
+ requestId: RequestId;
+ }
+ export type getResponseBodyReturnValue = {
/**
- * Unique DOM defined string value describing the meaning of the key in the context of active
-modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
+ * Response body.
*/
- key?: string;
+ body: string;
/**
- * Windows virtual key code (default: 0).
+ * True, if content was sent as base64.
*/
- windowsVirtualKeyCode?: number;
+ base64Encoded: boolean;
+ }
+ /**
+ * Returns a handle to the stream representing the response body.
+The request must be paused in the HeadersReceived stage.
+Note that after this command the request can't be continued
+as is -- client either needs to cancel it or to provide the
+response body.
+The stream only supports sequential read, IO.read will fail if the position
+is specified.
+This method is mutually exclusive with getResponseBody.
+Calling other methods that affect the request or disabling fetch
+domain before body is received results in an undefined behavior.
+ */
+ export type takeResponseBodyAsStreamParameters = {
+ requestId: RequestId;
+ }
+ export type takeResponseBodyAsStreamReturnValue = {
+ stream: IO.StreamHandle;
+ }
+ }
+
+ export module FileSystem {
+ export interface File {
+ name: string;
/**
- * Native virtual key code (default: 0).
+ * Timestamp
*/
- nativeVirtualKeyCode?: number;
+ lastModified: Network.TimeSinceEpoch;
/**
- * Whether the event was generated from auto repeat (default: false).
+ * Size in bytes
*/
- autoRepeat?: boolean;
+ size: number;
+ type: string;
+ }
+ export interface Directory {
+ name: string;
+ nestedDirectories: string[];
/**
- * Whether the event was generated from the keypad (default: false).
+ * Files that are directly nested under this directory.
*/
- isKeypad?: boolean;
+ nestedFiles: File[];
+ }
+ export interface BucketFileSystemLocator {
/**
- * Whether the event was a system key event (default: false).
+ * Storage key
*/
- isSystemKey?: boolean;
+ storageKey: Storage.SerializedStorageKey;
/**
- * Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
-0).
+ * Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
*/
- location?: number;
+ bucketName?: string;
/**
- * Editing commands to send with the key event (e.g., 'selectAll') (default: []).
-These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
-See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
+ * Path to the directory using each path component as an array item.
*/
- commands?: string[];
+ pathComponents: string[];
}
- export type dispatchKeyEventReturnValue = {
+
+
+ export type getDirectoryParameters = {
+ bucketFileSystemLocator: BucketFileSystemLocator;
}
- /**
- * This method emulates inserting text that doesn't come from a key press,
-for example an emoji keyboard or an IME.
- */
- export type insertTextParameters = {
+ export type getDirectoryReturnValue = {
/**
- * The text to insert.
+ * Returns the directory object at the path.
*/
- text: string;
- }
- export type insertTextReturnValue = {
+ directory: Directory;
}
+ }
+
+ /**
+ * This domain provides experimental commands only supported in headless mode.
+ */
+ export module HeadlessExperimental {
/**
- * This method sets the current candidate text for IME.
-Use imeCommitComposition to commit the final text.
-Use imeSetComposition with empty string as text to cancel composition.
+ * Encoding options for a screenshot.
*/
- export type imeSetCompositionParameters = {
- /**
- * The text to insert
- */
- text: string;
- /**
- * selection start
- */
- selectionStart: number;
+ export interface ScreenshotParams {
/**
- * selection end
+ * Image compression format (defaults to png).
*/
- selectionEnd: number;
+ format?: "jpeg"|"png"|"webp";
/**
- * replacement start
+ * Compression quality from range [0..100] (jpeg and webp only).
*/
- replacementStart?: number;
+ quality?: number;
/**
- * replacement end
+ * Optimize image encoding for speed, not for resulting size (defaults to false)
*/
- replacementEnd?: number;
- }
- export type imeSetCompositionReturnValue = {
+ optimizeForSpeed?: boolean;
}
+
+
/**
- * Dispatches a mouse event to the page.
+ * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
+screenshot from the resulting frame. Requires that the target was created with enabled
+BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
+https://goo.gle/chrome-headless-rendering for more background.
*/
- export type dispatchMouseEventParameters = {
- /**
- * Type of the mouse event.
- */
- type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
+ export type beginFrameParameters = {
/**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
+ * Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
+the current time will be used.
*/
- x: number;
+ frameTimeTicks?: number;
/**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ * The interval between BeginFrames that is reported to the compositor, in milliseconds.
+Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
*/
- y: number;
+ interval?: number;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Whether updates should not be committed and drawn onto the display. False by default. If
+true, only side effects of the BeginFrame will be run, such as layout and animations, but
+any visual updates may not be visible on the display or in screenshots.
*/
- modifiers?: number;
+ noDisplayUpdates?: boolean;
/**
- * Time at which the event occurred.
+ * If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
+no screenshot will be captured. Note that capturing a screenshot can fail, for example,
+during renderer initialization. In such a case, no screenshot data will be returned.
*/
- timestamp?: TimeSinceEpoch;
+ screenshot?: ScreenshotParams;
+ }
+ export type beginFrameReturnValue = {
/**
- * Mouse button (default: "none").
+ * Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
+display. Reported for diagnostic uses, may be removed in the future.
*/
- button?: MouseButton;
+ hasDamage: boolean;
/**
- * A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
-Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
+ * Base64-encoded image data of the screenshot, if one was requested and successfully taken.
*/
- buttons?: number;
+ screenshotData?: binary;
+ }
+ /**
+ * Disables headless events for the target.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Enables headless events for the target.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ }
+
+ /**
+ * Input/Output operations for streams produced by DevTools.
+ */
+ export module IO {
+ /**
+ * This is either obtained from another method or specified as `blob:<uuid>` where
+`<uuid>` is an UUID of a Blob.
+ */
+ export type StreamHandle = string;
+
+
+ /**
+ * Close the stream, discard any temporary backing storage.
+ */
+ export type closeParameters = {
/**
- * Number of times the mouse button was clicked (default: 0).
+ * Handle of the stream to close.
*/
- clickCount?: number;
+ handle: StreamHandle;
+ }
+ export type closeReturnValue = {
+ }
+ /**
+ * Read a chunk of the stream
+ */
+ export type readParameters = {
/**
- * The normalized pressure, which has a range of [0,1] (default: 0).
+ * Handle of the stream to read.
*/
- force?: number;
+ handle: StreamHandle;
/**
- * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ * Seek to the specified offset before reading (if not specified, proceed with offset
+following the last read). Some types of streams may only support sequential reads.
*/
- tangentialPressure?: number;
+ offset?: number;
/**
- * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
+ * Maximum number of bytes to read (left upon the agent discretion if not specified).
*/
- tiltX?: number;
+ size?: number;
+ }
+ export type readReturnValue = {
/**
- * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ * Set if the data is base64-encoded
*/
- tiltY?: number;
+ base64Encoded?: boolean;
/**
- * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ * Data that were read.
*/
- twist?: number;
+ data: string;
/**
- * X delta in CSS pixels for mouse wheel event (default: 0).
+ * Set if the end-of-file condition occurred while reading.
*/
- deltaX?: number;
+ eof: boolean;
+ }
+ /**
+ * Return UUID of Blob object specified by a remote object id.
+ */
+ export type resolveBlobParameters = {
/**
- * Y delta in CSS pixels for mouse wheel event (default: 0).
+ * Object id of a Blob object wrapper.
*/
- deltaY?: number;
+ objectId: Runtime.RemoteObjectId;
+ }
+ export type resolveBlobReturnValue = {
/**
- * Pointer type (default: "mouse").
+ * UUID of the specified Blob.
*/
- pointerType?: "mouse"|"pen";
- }
- export type dispatchMouseEventReturnValue = {
+ uuid: string;
}
+ }
+
+ export module IndexedDB {
/**
- * Dispatches a touch event to the page.
+ * Database with an array of object stores.
*/
- export type dispatchTouchEventParameters = {
+ export interface DatabaseWithObjectStores {
/**
- * Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
-TouchStart and TouchMove must contains at least one.
- */
- type: "touchStart"|"touchEnd"|"touchMove"|"touchCancel";
- /**
- * Active touch points on the touch device. One event per any changed point (compared to
-previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
-one by one.
+ * Database name.
*/
- touchPoints: TouchPoint[];
+ name: string;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Database version (type is not 'integer', as the standard
+requires the version number to be 'unsigned long long')
*/
- modifiers?: number;
+ version: number;
/**
- * Time at which the event occurred.
+ * Object stores in this database.
*/
- timestamp?: TimeSinceEpoch;
- }
- export type dispatchTouchEventReturnValue = {
+ objectStores: ObjectStore[];
}
/**
- * Cancels any active dragging in the page.
+ * Object store.
*/
- export type cancelDraggingParameters = {
- }
- export type cancelDraggingReturnValue = {
+ export interface ObjectStore {
+ /**
+ * Object store name.
+ */
+ name: string;
+ /**
+ * Object store key path.
+ */
+ keyPath: KeyPath;
+ /**
+ * If true, object store has auto increment flag set.
+ */
+ autoIncrement: boolean;
+ /**
+ * Indexes in this object store.
+ */
+ indexes: ObjectStoreIndex[];
}
/**
- * Emulates touch event from the mouse event parameters.
+ * Object store index.
*/
- export type emulateTouchFromMouseEventParameters = {
+ export interface ObjectStoreIndex {
/**
- * Type of the mouse event.
+ * Index name.
*/
- type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
+ name: string;
/**
- * X coordinate of the mouse pointer in DIP.
+ * Index key path.
*/
- x: number;
+ keyPath: KeyPath;
/**
- * Y coordinate of the mouse pointer in DIP.
+ * If true, index is unique.
*/
- y: number;
+ unique: boolean;
/**
- * Mouse button. Only "none", "left", "right" are supported.
+ * If true, index allows multiple entries for a key.
*/
- button: MouseButton;
+ multiEntry: boolean;
+ }
+ /**
+ * Key.
+ */
+ export interface Key {
/**
- * Time at which the event occurred (default: current time).
+ * Key type.
*/
- timestamp?: TimeSinceEpoch;
+ type: "number"|"string"|"date"|"array";
/**
- * X delta in DIP for mouse wheel event (default: 0).
+ * Number value.
*/
- deltaX?: number;
+ number?: number;
/**
- * Y delta in DIP for mouse wheel event (default: 0).
+ * String value.
*/
- deltaY?: number;
+ string?: string;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Date value.
*/
- modifiers?: number;
+ date?: number;
/**
- * Number of times the mouse button was clicked (default: 0).
+ * Array value.
*/
- clickCount?: number;
- }
- export type emulateTouchFromMouseEventReturnValue = {
+ array?: Key[];
}
/**
- * Ignores input events (useful while auditing page).
+ * Key range.
*/
- export type setIgnoreInputEventsParameters = {
+ export interface KeyRange {
/**
- * Ignores input events processing when set to true.
+ * Lower bound.
*/
- ignore: boolean;
- }
- export type setIgnoreInputEventsReturnValue = {
- }
- /**
- * Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
-Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
- */
- export type setInterceptDragsParameters = {
- enabled: boolean;
- }
- export type setInterceptDragsReturnValue = {
- }
- /**
- * Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
- */
- export type synthesizePinchGestureParameters = {
+ lower?: Key;
/**
- * X coordinate of the start of the gesture in CSS pixels.
+ * Upper bound.
*/
- x: number;
+ upper?: Key;
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * If true lower bound is open.
*/
- y: number;
+ lowerOpen: boolean;
/**
- * Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
+ * If true upper bound is open.
*/
- scaleFactor: number;
+ upperOpen: boolean;
+ }
+ /**
+ * Data entry.
+ */
+ export interface DataEntry {
/**
- * Relative pointer speed in pixels per second (default: 800).
+ * Key object.
*/
- relativeSpeed?: number;
+ key: Runtime.RemoteObject;
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * Primary key object.
*/
- gestureSourceType?: GestureSourceType;
- }
- export type synthesizePinchGestureReturnValue = {
+ primaryKey: Runtime.RemoteObject;
+ /**
+ * Value object.
+ */
+ value: Runtime.RemoteObject;
}
/**
- * Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
+ * Key path.
*/
- export type synthesizeScrollGestureParameters = {
+ export interface KeyPath {
/**
- * X coordinate of the start of the gesture in CSS pixels.
+ * Key path type.
*/
- x: number;
+ type: "null"|"string"|"array";
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * String value.
*/
- y: number;
+ string?: string;
/**
- * The distance to scroll along the X axis (positive to scroll left).
+ * Array value.
*/
- xDistance?: number;
+ array?: string[];
+ }
+
+
+ /**
+ * Clears all entries from an object store.
+ */
+ export type clearObjectStoreParameters = {
/**
- * The distance to scroll along the Y axis (positive to scroll up).
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- yDistance?: number;
+ securityOrigin?: string;
/**
- * The number of additional pixels to scroll back along the X axis, in addition to the given
-distance.
+ * Storage key.
*/
- xOverscroll?: number;
+ storageKey?: string;
/**
- * The number of additional pixels to scroll back along the Y axis, in addition to the given
-distance.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- yOverscroll?: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * Prevent fling (default: true).
+ * Database name.
*/
- preventFling?: boolean;
+ databaseName: string;
/**
- * Swipe speed in pixels per second (default: 800).
+ * Object store name.
*/
- speed?: number;
+ objectStoreName: string;
+ }
+ export type clearObjectStoreReturnValue = {
+ }
+ /**
+ * Deletes a database.
+ */
+ export type deleteDatabaseParameters = {
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- gestureSourceType?: GestureSourceType;
+ securityOrigin?: string;
/**
- * The number of times to repeat the gesture (default: 0).
+ * Storage key.
*/
- repeatCount?: number;
+ storageKey?: string;
/**
- * The number of milliseconds delay between each repeat. (default: 250).
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- repeatDelayMs?: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * The name of the interaction markers to generate, if not empty (default: "").
+ * Database name.
*/
- interactionMarkerName?: string;
+ databaseName: string;
}
- export type synthesizeScrollGestureReturnValue = {
+ export type deleteDatabaseReturnValue = {
}
/**
- * Synthesizes a tap gesture over a time period by issuing appropriate touch events.
+ * Delete a range of entries from an object store
*/
- export type synthesizeTapGestureParameters = {
- /**
- * X coordinate of the start of the gesture in CSS pixels.
- */
- x: number;
+ export type deleteObjectStoreEntriesParameters = {
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- y: number;
+ securityOrigin?: string;
/**
- * Duration between touchdown and touchup events in ms (default: 50).
+ * Storage key.
*/
- duration?: number;
+ storageKey?: string;
/**
- * Number of times to perform the tap (e.g. 2 for double tap, default: 1).
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- tapCount?: number;
+ storageBucket?: Storage.StorageBucket;
+ databaseName: string;
+ objectStoreName: string;
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * Range of entry keys to delete
*/
- gestureSourceType?: GestureSourceType;
+ keyRange: KeyRange;
}
- export type synthesizeTapGestureReturnValue = {
+ export type deleteObjectStoreEntriesReturnValue = {
}
- }
-
- export module Inspector {
-
/**
- * Fired when remote debugging connection is about to be terminated. Contains detach reason.
- */
- export type detachedPayload = {
- /**
- * The reason why connection has been terminated.
- */
- reason: string;
- }
- /**
- * Fired when debugging target has crashed
- */
- export type targetCrashedPayload = void;
- /**
- * Fired when debugging target has reloaded after crash
- */
- export type targetReloadedAfterCrashPayload = void;
-
- /**
- * Disables inspector domain notifications.
+ * Disables events from backend.
*/
export type disableParameters = {
}
export type disableReturnValue = {
}
/**
- * Enables inspector domain notifications.
+ * Enables events from backend.
*/
export type enableParameters = {
}
export type enableReturnValue = {
}
- }
-
- export module LayerTree {
- /**
- * Unique Layer identifier.
- */
- export type LayerId = string;
- /**
- * Unique snapshot identifier.
- */
- export type SnapshotId = string;
/**
- * Rectangle where scrolling happens on the main thread.
+ * Requests data from object store or index.
*/
- export interface ScrollRect {
+ export type requestDataParameters = {
/**
- * Rectangle itself.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- rect: DOM.Rect;
+ securityOrigin?: string;
/**
- * Reason for rectangle to force scrolling on the main thread
+ * Storage key.
*/
- type: "RepaintsOnScroll"|"TouchEventHandler"|"WheelEventHandler";
- }
- /**
- * Sticky position constraints.
- */
- export interface StickyPositionConstraint {
+ storageKey?: string;
/**
- * Layout rectangle of the sticky element before being shifted
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- stickyBoxRect: DOM.Rect;
+ storageBucket?: Storage.StorageBucket;
/**
- * Layout rectangle of the containing block of the sticky element
+ * Database name.
*/
- containingBlockRect: DOM.Rect;
+ databaseName: string;
/**
- * The nearest sticky layer that shifts the sticky box
+ * Object store name.
*/
- nearestLayerShiftingStickyBox?: LayerId;
+ objectStoreName: string;
/**
- * The nearest sticky layer that shifts the containing block
+ * Index name, empty string for object store data requests.
*/
- nearestLayerShiftingContainingBlock?: LayerId;
- }
- /**
- * Serialized fragment of layer picture along with its offset within the layer.
- */
- export interface PictureTile {
+ indexName: string;
/**
- * Offset from owning layer left boundary
+ * Number of records to skip.
*/
- x: number;
+ skipCount: number;
/**
- * Offset from owning layer top boundary
+ * Number of records to fetch.
*/
- y: number;
+ pageSize: number;
/**
- * Base64-encoded snapshot data.
+ * Key range.
*/
- picture: binary;
+ keyRange?: KeyRange;
}
- /**
- * Information about a compositing layer.
- */
- export interface Layer {
- /**
- * The unique id for this layer.
- */
- layerId: LayerId;
- /**
- * The id of parent (not present for root).
- */
- parentLayerId?: LayerId;
+ export type requestDataReturnValue = {
/**
- * The backend id for the node associated with this layer.
+ * Array of object store data entries.
*/
- backendNodeId?: DOM.BackendNodeId;
+ objectStoreDataEntries: DataEntry[];
/**
- * Offset from parent layer, X coordinate.
+ * If true, there are more entries to fetch in the given range.
*/
- offsetX: number;
+ hasMore: boolean;
+ }
+ /**
+ * Gets metadata of an object store.
+ */
+ export type getMetadataParameters = {
/**
- * Offset from parent layer, Y coordinate.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- offsetY: number;
+ securityOrigin?: string;
/**
- * Layer width.
+ * Storage key.
*/
- width: number;
+ storageKey?: string;
/**
- * Layer height.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- height: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * Transformation matrix for layer, default is identity matrix
+ * Database name.
*/
- transform?: number[];
+ databaseName: string;
/**
- * Transform anchor point X, absent if no transform specified
+ * Object store name.
*/
- anchorX?: number;
+ objectStoreName: string;
+ }
+ export type getMetadataReturnValue = {
/**
- * Transform anchor point Y, absent if no transform specified
+ * the entries count
*/
- anchorY?: number;
+ entriesCount: number;
/**
- * Transform anchor point Z, absent if no transform specified
+ * the current value of key generator, to become the next inserted
+key into the object store. Valid if objectStore.autoIncrement
+is true.
*/
- anchorZ?: number;
+ keyGeneratorValue: number;
+ }
+ /**
+ * Requests database with given name in given frame.
+ */
+ export type requestDatabaseParameters = {
/**
- * Indicates how many time this layer has painted.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- paintCount: number;
+ securityOrigin?: string;
/**
- * Indicates whether this layer hosts any content, rather than being used for
-transform/scrolling purposes only.
+ * Storage key.
*/
- drawsContent: boolean;
+ storageKey?: string;
/**
- * Set if layer is not visible.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- invisible?: boolean;
+ storageBucket?: Storage.StorageBucket;
/**
- * Rectangles scrolling on main thread only.
+ * Database name.
*/
- scrollRects?: ScrollRect[];
+ databaseName: string;
+ }
+ export type requestDatabaseReturnValue = {
/**
- * Sticky position constraint information
+ * Database with an array of object stores.
*/
- stickyPositionConstraint?: StickyPositionConstraint;
+ databaseWithObjectStores: DatabaseWithObjectStores;
}
/**
- * Array of timings, one per paint step.
+ * Requests database names for given security origin.
*/
- export type PaintProfile = number[];
-
- export type layerPaintedPayload = {
+ export type requestDatabaseNamesParameters = {
/**
- * The id of the painted layer.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- layerId: LayerId;
+ securityOrigin?: string;
/**
- * Clip rectangle.
+ * Storage key.
*/
- clip: DOM.Rect;
- }
- export type layerTreeDidChangePayload = {
+ storageKey?: string;
/**
- * Layer tree, absent if not in the compositing mode.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- layers?: Layer[];
+ storageBucket?: Storage.StorageBucket;
}
-
- /**
- * Provides the reasons why the given layer was composited.
- */
- export type compositingReasonsParameters = {
+ export type requestDatabaseNamesReturnValue = {
/**
- * The id of the layer for which we want to get the reasons it was composited.
+ * Database names for origin.
*/
- layerId: LayerId;
+ databaseNames: string[];
}
- export type compositingReasonsReturnValue = {
+ }
+
+ export module Input {
+ export interface TouchPoint {
/**
- * A list of strings specifying reasons for the given layer to become composited.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- compositingReasons: string[];
+ x: number;
/**
- * A list of strings specifying reason IDs for the given layer to become composited.
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
*/
- compositingReasonIds: string[];
- }
- /**
- * Disables compositing tree inspection.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Enables compositing tree inspection.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Returns the snapshot identifier.
- */
- export type loadSnapshotParameters = {
+ y: number;
/**
- * An array of tiles composing the snapshot.
+ * X radius of the touch area (default: 1.0).
*/
- tiles: PictureTile[];
- }
- export type loadSnapshotReturnValue = {
+ radiusX?: number;
/**
- * The id of the snapshot.
+ * Y radius of the touch area (default: 1.0).
*/
- snapshotId: SnapshotId;
- }
- /**
- * Returns the layer snapshot identifier.
- */
- export type makeSnapshotParameters = {
+ radiusY?: number;
/**
- * The id of the layer.
+ * Rotation angle (default: 0.0).
*/
- layerId: LayerId;
- }
- export type makeSnapshotReturnValue = {
+ rotationAngle?: number;
/**
- * The id of the layer snapshot.
+ * Force (default: 1.0).
*/
- snapshotId: SnapshotId;
- }
- export type profileSnapshotParameters = {
+ force?: number;
/**
- * The id of the layer snapshot.
+ * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
*/
- snapshotId: SnapshotId;
+ tangentialPressure?: number;
/**
- * The maximum number of times to replay the snapshot (1, if not specified).
+ * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
*/
- minRepeatCount?: number;
+ tiltX?: number;
/**
- * The minimum duration (in seconds) to replay the snapshot.
+ * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
*/
- minDuration?: number;
+ tiltY?: number;
/**
- * The clip rectangle to apply when replaying the snapshot.
+ * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
*/
- clipRect?: DOM.Rect;
- }
- export type profileSnapshotReturnValue = {
+ twist?: number;
/**
- * The array of paint profiles, one per run.
+ * Identifier used to track touch sources between events, must be unique within an event.
*/
- timings: PaintProfile[];
+ id?: number;
}
+ export type GestureSourceType = "default"|"touch"|"mouse";
+ export type MouseButton = "none"|"left"|"middle"|"right"|"back"|"forward";
/**
- * Releases layer snapshot captured by the back-end.
+ * UTC time in seconds, counted from January 1, 1970.
*/
- export type releaseSnapshotParameters = {
+ export type TimeSinceEpoch = number;
+ export interface DragDataItem {
/**
- * The id of the layer snapshot.
+ * Mime type of the dragged data.
*/
- snapshotId: SnapshotId;
- }
- export type releaseSnapshotReturnValue = {
- }
- /**
- * Replays the layer snapshot and returns the resulting bitmap.
- */
- export type replaySnapshotParameters = {
+ mimeType: string;
/**
- * The id of the layer snapshot.
+ * Depending of the value of `mimeType`, it contains the dragged link,
+text, HTML markup or any other data.
*/
- snapshotId: SnapshotId;
+ data: string;
/**
- * The first step to replay from (replay from the very start if not specified).
+ * Title associated with a link. Only valid when `mimeType` == "text/uri-list".
*/
- fromStep?: number;
+ title?: string;
/**
- * The last step to replay to (replay till the end if not specified).
+ * Stores the base URL for the contained markup. Only valid when `mimeType`
+== "text/html".
*/
- toStep?: number;
+ baseURL?: string;
+ }
+ export interface DragData {
+ items: DragDataItem[];
/**
- * The scale to apply while replaying (defaults to 1).
+ * List of filenames that should be included when dropping
*/
- scale?: number;
- }
- export type replaySnapshotReturnValue = {
+ files?: string[];
/**
- * A data: URL for resulting image.
+ * Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
*/
- dataURL: string;
+ dragOperationsMask: number;
}
+
/**
- * Replays the layer snapshot and returns canvas log.
+ * Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
+restore normal drag and drop behavior.
*/
- export type snapshotCommandLogParameters = {
+ export type dragInterceptedPayload = {
+ data: DragData;
+ }
+
+ /**
+ * Dispatches a drag event into the page.
+ */
+ export type dispatchDragEventParameters = {
/**
- * The id of the layer snapshot.
+ * Type of the drag event.
*/
- snapshotId: SnapshotId;
- }
- export type snapshotCommandLogReturnValue = {
+ type: "dragEnter"|"dragOver"|"drop"|"dragCancel";
/**
- * The array of canvas function calls.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- commandLog: { [key: string]: string }[];
+ x: number;
+ /**
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ */
+ y: number;
+ data: DragData;
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ }
+ export type dispatchDragEventReturnValue = {
}
- }
-
- /**
- * Provides access to log entries.
- */
- export module Log {
/**
- * Log entry.
+ * Dispatches a key event to the page.
*/
- export interface LogEntry {
+ export type dispatchKeyEventParameters = {
/**
- * Log entry source.
+ * Type of the key event.
*/
- source: "xml"|"javascript"|"network"|"storage"|"appcache"|"rendering"|"security"|"deprecation"|"worker"|"violation"|"intervention"|"recommendation"|"other";
+ type: "keyDown"|"keyUp"|"rawKeyDown"|"char";
/**
- * Log entry severity.
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
*/
- level: "verbose"|"info"|"warning"|"error";
+ modifiers?: number;
/**
- * Logged text.
+ * Time at which the event occurred.
*/
- text: string;
- category?: "cors";
+ timestamp?: TimeSinceEpoch;
/**
- * Timestamp when this entry was added.
+ * Text as generated by processing a virtual key code with a keyboard layout. Not needed for
+for `keyUp` and `rawKeyDown` events (default: "")
*/
- timestamp: Runtime.Timestamp;
+ text?: string;
/**
- * URL of the resource if known.
+ * Text that would have been generated by the keyboard if no modifiers were pressed (except for
+shift). Useful for shortcut (accelerator) key handling (default: "").
*/
- url?: string;
+ unmodifiedText?: string;
/**
- * Line number in the resource.
+ * Unique key identifier (e.g., 'U+0041') (default: "").
*/
- lineNumber?: number;
+ keyIdentifier?: string;
/**
- * JavaScript stack trace.
+ * Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
*/
- stackTrace?: Runtime.StackTrace;
+ code?: string;
/**
- * Identifier of the network request associated with this entry.
+ * Unique DOM defined string value describing the meaning of the key in the context of active
+modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
*/
- networkRequestId?: Network.RequestId;
+ key?: string;
/**
- * Identifier of the worker associated with this entry.
+ * Windows virtual key code (default: 0).
*/
- workerId?: string;
+ windowsVirtualKeyCode?: number;
/**
- * Call arguments.
+ * Native virtual key code (default: 0).
*/
- args?: Runtime.RemoteObject[];
- }
- /**
- * Violation configuration setting.
- */
- export interface ViolationSetting {
+ nativeVirtualKeyCode?: number;
/**
- * Violation type.
+ * Whether the event was generated from auto repeat (default: false).
*/
- name: "longTask"|"longLayout"|"blockedEvent"|"blockedParser"|"discouragedAPIUse"|"handler"|"recurringHandler";
+ autoRepeat?: boolean;
/**
- * Time threshold to trigger upon.
+ * Whether the event was generated from the keypad (default: false).
*/
- threshold: number;
- }
-
- /**
- * Issued when new message was logged.
- */
- export type entryAddedPayload = {
+ isKeypad?: boolean;
/**
- * The entry.
+ * Whether the event was a system key event (default: false).
*/
- entry: LogEntry;
- }
-
- /**
- * Clears the log.
- */
- export type clearParameters = {
- }
- export type clearReturnValue = {
- }
- /**
- * Disables log domain, prevents further log entries from being reported to the client.
- */
- export type disableParameters = {
+ isSystemKey?: boolean;
+ /**
+ * Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
+0).
+ */
+ location?: number;
+ /**
+ * Editing commands to send with the key event (e.g., 'selectAll') (default: []).
+These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
+See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
+ */
+ commands?: string[];
}
- export type disableReturnValue = {
+ export type dispatchKeyEventReturnValue = {
}
/**
- * Enables log domain, sends the entries collected so far to the client by means of the
-`entryAdded` notification.
+ * This method emulates inserting text that doesn't come from a key press,
+for example an emoji keyboard or an IME.
*/
- export type enableParameters = {
+ export type insertTextParameters = {
+ /**
+ * The text to insert.
+ */
+ text: string;
}
- export type enableReturnValue = {
+ export type insertTextReturnValue = {
}
/**
- * start violation reporting.
+ * This method sets the current candidate text for IME.
+Use imeCommitComposition to commit the final text.
+Use imeSetComposition with empty string as text to cancel composition.
*/
- export type startViolationsReportParameters = {
+ export type imeSetCompositionParameters = {
/**
- * Configuration for violations.
+ * The text to insert
*/
- config: ViolationSetting[];
+ text: string;
+ /**
+ * selection start
+ */
+ selectionStart: number;
+ /**
+ * selection end
+ */
+ selectionEnd: number;
+ /**
+ * replacement start
+ */
+ replacementStart?: number;
+ /**
+ * replacement end
+ */
+ replacementEnd?: number;
}
- export type startViolationsReportReturnValue = {
+ export type imeSetCompositionReturnValue = {
}
/**
- * Stop violation reporting.
+ * Dispatches a mouse event to the page.
*/
- export type stopViolationsReportParameters = {
- }
- export type stopViolationsReportReturnValue = {
- }
- }
-
- export module Memory {
- /**
- * Memory pressure level.
- */
- export type PressureLevel = "moderate"|"critical";
- /**
- * Heap profile sample.
- */
- export interface SamplingProfileNode {
+ export type dispatchMouseEventParameters = {
/**
- * Size of the sampled allocation.
+ * Type of the mouse event.
*/
- size: number;
+ type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
/**
- * Total bytes attributed to this sample.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- total: number;
+ x: number;
/**
- * Execution stack at the point of allocation.
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
*/
- stack: string[];
- }
- /**
- * Array of heap profile samples.
- */
- export interface SamplingProfile {
- samples: SamplingProfileNode[];
- modules: Module[];
- }
- /**
- * Executable module information
- */
- export interface Module {
+ y: number;
/**
- * Name of the module.
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
*/
- name: string;
+ modifiers?: number;
/**
- * UUID of the module.
+ * Time at which the event occurred.
*/
- uuid: string;
+ timestamp?: TimeSinceEpoch;
/**
- * Base address where the module is loaded into memory. Encoded as a decimal
-or hexadecimal (0x prefixed) string.
+ * Mouse button (default: "none").
*/
- baseAddress: string;
+ button?: MouseButton;
/**
- * Size of the module in bytes.
+ * A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
+Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
*/
- size: number;
- }
- /**
- * DOM object counter data.
- */
- export interface DOMCounter {
+ buttons?: number;
/**
- * Object name. Note: object names should be presumed volatile and clients should not expect
-the returned names to be consistent across runs.
+ * Number of times the mouse button was clicked (default: 0).
*/
- name: string;
+ clickCount?: number;
/**
- * Object count.
+ * The normalized pressure, which has a range of [0,1] (default: 0).
*/
- count: number;
- }
-
-
- /**
- * Retruns current DOM object counters.
- */
- export type getDOMCountersParameters = {
+ force?: number;
+ /**
+ * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ */
+ tangentialPressure?: number;
+ /**
+ * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
+ */
+ tiltX?: number;
+ /**
+ * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ */
+ tiltY?: number;
+ /**
+ * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ */
+ twist?: number;
+ /**
+ * X delta in CSS pixels for mouse wheel event (default: 0).
+ */
+ deltaX?: number;
+ /**
+ * Y delta in CSS pixels for mouse wheel event (default: 0).
+ */
+ deltaY?: number;
+ /**
+ * Pointer type (default: "mouse").
+ */
+ pointerType?: "mouse"|"pen";
}
- export type getDOMCountersReturnValue = {
- documents: number;
- nodes: number;
- jsEventListeners: number;
+ export type dispatchMouseEventReturnValue = {
}
/**
- * Retruns DOM object counters after preparing renderer for leak detection.
+ * Dispatches a touch event to the page.
*/
- export type getDOMCountersForLeakDetectionParameters = {
- }
- export type getDOMCountersForLeakDetectionReturnValue = {
+ export type dispatchTouchEventParameters = {
/**
- * DOM object counters.
+ * Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
+TouchStart and TouchMove must contains at least one.
*/
- counters: DOMCounter[];
- }
- /**
- * Prepares for leak detection by terminating workers, stopping spellcheckers,
-dropping non-essential internal caches, running garbage collections, etc.
- */
- export type prepareForLeakDetectionParameters = {
+ type: "touchStart"|"touchEnd"|"touchMove"|"touchCancel";
+ /**
+ * Active touch points on the touch device. One event per any changed point (compared to
+previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
+one by one.
+ */
+ touchPoints: TouchPoint[];
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ /**
+ * Time at which the event occurred.
+ */
+ timestamp?: TimeSinceEpoch;
}
- export type prepareForLeakDetectionReturnValue = {
+ export type dispatchTouchEventReturnValue = {
}
/**
- * Simulate OomIntervention by purging V8 memory.
+ * Cancels any active dragging in the page.
*/
- export type forciblyPurgeJavaScriptMemoryParameters = {
+ export type cancelDraggingParameters = {
}
- export type forciblyPurgeJavaScriptMemoryReturnValue = {
+ export type cancelDraggingReturnValue = {
}
/**
- * Enable/disable suppressing memory pressure notifications in all processes.
+ * Emulates touch event from the mouse event parameters.
*/
- export type setPressureNotificationsSuppressedParameters = {
+ export type emulateTouchFromMouseEventParameters = {
/**
- * If true, memory pressure notifications will be suppressed.
+ * Type of the mouse event.
*/
- suppressed: boolean;
- }
- export type setPressureNotificationsSuppressedReturnValue = {
- }
- /**
- * Simulate a memory pressure notification in all processes.
- */
- export type simulatePressureNotificationParameters = {
+ type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
/**
- * Memory pressure level of the notification.
+ * X coordinate of the mouse pointer in DIP.
*/
- level: PressureLevel;
+ x: number;
+ /**
+ * Y coordinate of the mouse pointer in DIP.
+ */
+ y: number;
+ /**
+ * Mouse button. Only "none", "left", "right" are supported.
+ */
+ button: MouseButton;
+ /**
+ * Time at which the event occurred (default: current time).
+ */
+ timestamp?: TimeSinceEpoch;
+ /**
+ * X delta in DIP for mouse wheel event (default: 0).
+ */
+ deltaX?: number;
+ /**
+ * Y delta in DIP for mouse wheel event (default: 0).
+ */
+ deltaY?: number;
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ /**
+ * Number of times the mouse button was clicked (default: 0).
+ */
+ clickCount?: number;
}
- export type simulatePressureNotificationReturnValue = {
+ export type emulateTouchFromMouseEventReturnValue = {
}
/**
- * Start collecting native memory profile.
+ * Ignores input events (useful while auditing page).
*/
- export type startSamplingParameters = {
- /**
- * Average number of bytes between samples.
- */
- samplingInterval?: number;
+ export type setIgnoreInputEventsParameters = {
/**
- * Do not randomize intervals between samples.
+ * Ignores input events processing when set to true.
*/
- suppressRandomness?: boolean;
+ ignore: boolean;
}
- export type startSamplingReturnValue = {
+ export type setIgnoreInputEventsReturnValue = {
}
/**
- * Stop collecting native memory profile.
+ * Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
+Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
*/
- export type stopSamplingParameters = {
+ export type setInterceptDragsParameters = {
+ enabled: boolean;
}
- export type stopSamplingReturnValue = {
+ export type setInterceptDragsReturnValue = {
}
/**
- * Retrieve native memory allocations profile
-collected since renderer process startup.
+ * Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
*/
- export type getAllTimeSamplingProfileParameters = {
+ export type synthesizePinchGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
+ */
+ scaleFactor: number;
+ /**
+ * Relative pointer speed in pixels per second (default: 800).
+ */
+ relativeSpeed?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
}
- export type getAllTimeSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizePinchGestureReturnValue = {
}
/**
- * Retrieve native memory allocations profile
-collected since browser process startup.
+ * Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
*/
- export type getBrowserSamplingProfileParameters = {
+ export type synthesizeScrollGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * The distance to scroll along the X axis (positive to scroll left).
+ */
+ xDistance?: number;
+ /**
+ * The distance to scroll along the Y axis (positive to scroll up).
+ */
+ yDistance?: number;
+ /**
+ * The number of additional pixels to scroll back along the X axis, in addition to the given
+distance.
+ */
+ xOverscroll?: number;
+ /**
+ * The number of additional pixels to scroll back along the Y axis, in addition to the given
+distance.
+ */
+ yOverscroll?: number;
+ /**
+ * Prevent fling (default: true).
+ */
+ preventFling?: boolean;
+ /**
+ * Swipe speed in pixels per second (default: 800).
+ */
+ speed?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
+ /**
+ * The number of times to repeat the gesture (default: 0).
+ */
+ repeatCount?: number;
+ /**
+ * The number of milliseconds delay between each repeat. (default: 250).
+ */
+ repeatDelayMs?: number;
+ /**
+ * The name of the interaction markers to generate, if not empty (default: "").
+ */
+ interactionMarkerName?: string;
}
- export type getBrowserSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizeScrollGestureReturnValue = {
}
/**
- * Retrieve native memory allocations profile collected since last
-`startSampling` call.
+ * Synthesizes a tap gesture over a time period by issuing appropriate touch events.
*/
- export type getSamplingProfileParameters = {
+ export type synthesizeTapGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * Duration between touchdown and touchup events in ms (default: 50).
+ */
+ duration?: number;
+ /**
+ * Number of times to perform the tap (e.g. 2 for double tap, default: 1).
+ */
+ tapCount?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
}
- export type getSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizeTapGestureReturnValue = {
}
}
- /**
- * Network domain allows tracking network activities of the page. It exposes information about http,
-file, data and other requests and responses, their headers, bodies, timing, etc.
- */
- export module Network {
- /**
- * Resource type as it was perceived by the rendering engine.
- */
- export type ResourceType = "Document"|"Stylesheet"|"Image"|"Media"|"Font"|"Script"|"TextTrack"|"XHR"|"Fetch"|"Prefetch"|"EventSource"|"WebSocket"|"Manifest"|"SignedExchange"|"Ping"|"CSPViolationReport"|"Preflight"|"FedCM"|"Other";
- /**
- * Unique loader identifier.
- */
- export type LoaderId = string;
- /**
- * Unique network request identifier.
-Note that this does not identify individual HTTP requests that are part of
-a network request.
- */
- export type RequestId = string;
- /**
- * Unique intercepted request identifier.
- */
- export type InterceptionId = string;
- /**
- * Network level fetch failure reason.
- */
- export type ErrorReason = "Failed"|"Aborted"|"TimedOut"|"AccessDenied"|"ConnectionClosed"|"ConnectionReset"|"ConnectionRefused"|"ConnectionAborted"|"ConnectionFailed"|"NameNotResolved"|"InternetDisconnected"|"AddressUnreachable"|"BlockedByClient"|"BlockedByResponse";
+ export module Inspector {
+
/**
- * UTC time in seconds, counted from January 1, 1970.
+ * Fired when remote debugging connection is about to be terminated. Contains detach reason.
*/
- export type TimeSinceEpoch = number;
+ export type detachedPayload = {
+ /**
+ * The reason why connection has been terminated.
+ */
+ reason: string;
+ }
/**
- * Monotonically increasing time in seconds since an arbitrary point in the past.
+ * Fired when debugging target has crashed
*/
- export type MonotonicTime = number;
+ export type targetCrashedPayload = void;
/**
- * Request / response headers as keys / values of JSON object.
+ * Fired when debugging target has reloaded after crash
*/
- export type Headers = { [key: string]: string };
+ export type targetReloadedAfterCrashPayload = void;
+
/**
- * The underlying connection technology that the browser is supposedly using.
+ * Disables inspector domain notifications.
*/
- export type ConnectionType = "none"|"cellular2g"|"cellular3g"|"cellular4g"|"bluetooth"|"ethernet"|"wifi"|"wimax"|"other";
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
/**
- * Represents the cookie's 'SameSite' status:
-https://tools.ietf.org/html/draft-west-first-party-cookies
+ * Enables inspector domain notifications.
*/
- export type CookieSameSite = "Strict"|"Lax"|"None";
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ }
+
+ export module LayerTree {
/**
- * Represents the cookie's 'Priority' status:
-https://tools.ietf.org/html/draft-west-cookie-priority-00
+ * Unique Layer identifier.
*/
- export type CookiePriority = "Low"|"Medium"|"High";
+ export type LayerId = string;
/**
- * Represents the source scheme of the origin that originally set the cookie.
-A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
-This is a temporary ability and it will be removed in the future.
+ * Unique snapshot identifier.
*/
- export type CookieSourceScheme = "Unset"|"NonSecure"|"Secure";
+ export type SnapshotId = string;
/**
- * Timing information for the request.
+ * Rectangle where scrolling happens on the main thread.
*/
- export interface ResourceTiming {
+ export interface ScrollRect {
/**
- * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
-milliseconds relatively to this requestTime.
+ * Rectangle itself.
*/
- requestTime: number;
+ rect: DOM.Rect;
/**
- * Started resolving proxy.
+ * Reason for rectangle to force scrolling on the main thread
*/
- proxyStart: number;
+ type: "RepaintsOnScroll"|"TouchEventHandler"|"WheelEventHandler";
+ }
+ /**
+ * Sticky position constraints.
+ */
+ export interface StickyPositionConstraint {
/**
- * Finished resolving proxy.
+ * Layout rectangle of the sticky element before being shifted
*/
- proxyEnd: number;
+ stickyBoxRect: DOM.Rect;
/**
- * Started DNS address resolve.
+ * Layout rectangle of the containing block of the sticky element
*/
- dnsStart: number;
+ containingBlockRect: DOM.Rect;
/**
- * Finished DNS address resolve.
+ * The nearest sticky layer that shifts the sticky box
*/
- dnsEnd: number;
+ nearestLayerShiftingStickyBox?: LayerId;
/**
- * Started connecting to the remote host.
+ * The nearest sticky layer that shifts the containing block
*/
- connectStart: number;
+ nearestLayerShiftingContainingBlock?: LayerId;
+ }
+ /**
+ * Serialized fragment of layer picture along with its offset within the layer.
+ */
+ export interface PictureTile {
/**
- * Connected to the remote host.
+ * Offset from owning layer left boundary
*/
- connectEnd: number;
+ x: number;
/**
- * Started SSL handshake.
+ * Offset from owning layer top boundary
*/
- sslStart: number;
+ y: number;
/**
- * Finished SSL handshake.
+ * Base64-encoded snapshot data.
*/
- sslEnd: number;
+ picture: binary;
+ }
+ /**
+ * Information about a compositing layer.
+ */
+ export interface Layer {
/**
- * Started running ServiceWorker.
+ * The unique id for this layer.
*/
- workerStart: number;
+ layerId: LayerId;
/**
- * Finished Starting ServiceWorker.
+ * The id of parent (not present for root).
*/
- workerReady: number;
+ parentLayerId?: LayerId;
/**
- * Started fetch event.
+ * The backend id for the node associated with this layer.
*/
- workerFetchStart: number;
+ backendNodeId?: DOM.BackendNodeId;
/**
- * Settled fetch event respondWith promise.
+ * Offset from parent layer, X coordinate.
*/
- workerRespondWithSettled: number;
+ offsetX: number;
/**
- * Started ServiceWorker static routing source evaluation.
+ * Offset from parent layer, Y coordinate.
*/
- workerRouterEvaluationStart?: number;
+ offsetY: number;
/**
- * Started cache lookup when the source was evaluated to `cache`.
+ * Layer width.
*/
- workerCacheLookupStart?: number;
+ width: number;
/**
- * Started sending request.
+ * Layer height.
*/
- sendStart: number;
+ height: number;
/**
- * Finished sending request.
+ * Transformation matrix for layer, default is identity matrix
*/
- sendEnd: number;
+ transform?: number[];
/**
- * Time the server started pushing request.
+ * Transform anchor point X, absent if no transform specified
*/
- pushStart: number;
+ anchorX?: number;
/**
- * Time the server finished pushing request.
+ * Transform anchor point Y, absent if no transform specified
*/
- pushEnd: number;
- /**
- * Started receiving response headers.
- */
- receiveHeadersStart: number;
+ anchorY?: number;
/**
- * Finished receiving response headers.
+ * Transform anchor point Z, absent if no transform specified
*/
- receiveHeadersEnd: number;
- }
- /**
- * Loading priority of a resource request.
- */
- export type ResourcePriority = "VeryLow"|"Low"|"Medium"|"High"|"VeryHigh";
- /**
- * Post data entry for HTTP request
- */
- export interface PostDataEntry {
- bytes?: binary;
- }
- /**
- * HTTP request data.
- */
- export interface Request {
+ anchorZ?: number;
/**
- * Request URL (without fragment).
+ * Indicates how many time this layer has painted.
*/
- url: string;
+ paintCount: number;
/**
- * Fragment of the requested URL starting with hash, if present.
+ * Indicates whether this layer hosts any content, rather than being used for
+transform/scrolling purposes only.
*/
- urlFragment?: string;
+ drawsContent: boolean;
/**
- * HTTP request method.
+ * Set if layer is not visible.
*/
- method: string;
+ invisible?: boolean;
/**
- * HTTP request headers.
+ * Rectangles scrolling on main thread only.
*/
- headers: Headers;
+ scrollRects?: ScrollRect[];
/**
- * HTTP POST request data.
-Use postDataEntries instead.
+ * Sticky position constraint information
*/
- postData?: string;
+ stickyPositionConstraint?: StickyPositionConstraint;
+ }
+ /**
+ * Array of timings, one per paint step.
+ */
+ export type PaintProfile = number[];
+
+ export type layerPaintedPayload = {
/**
- * True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.
+ * The id of the painted layer.
*/
- hasPostData?: boolean;
+ layerId: LayerId;
/**
- * Request body elements (post data broken into individual entries).
+ * Clip rectangle.
*/
- postDataEntries?: PostDataEntry[];
+ clip: DOM.Rect;
+ }
+ export type layerTreeDidChangePayload = {
/**
- * The mixed content type of the request.
+ * Layer tree, absent if not in the compositing mode.
*/
- mixedContentType?: Security.MixedContentType;
+ layers?: Layer[];
+ }
+
+ /**
+ * Provides the reasons why the given layer was composited.
+ */
+ export type compositingReasonsParameters = {
/**
- * Priority of the resource request at the time request is sent.
+ * The id of the layer for which we want to get the reasons it was composited.
*/
- initialPriority: ResourcePriority;
+ layerId: LayerId;
+ }
+ export type compositingReasonsReturnValue = {
/**
- * The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
+ * A list of strings specifying reasons for the given layer to become composited.
*/
- referrerPolicy: "unsafe-url"|"no-referrer-when-downgrade"|"no-referrer"|"origin"|"origin-when-cross-origin"|"same-origin"|"strict-origin"|"strict-origin-when-cross-origin";
+ compositingReasons: string[];
/**
- * Whether is loaded via link preload.
+ * A list of strings specifying reason IDs for the given layer to become composited.
*/
- isLinkPreload?: boolean;
+ compositingReasonIds: string[];
+ }
+ /**
+ * Disables compositing tree inspection.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Enables compositing tree inspection.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Returns the snapshot identifier.
+ */
+ export type loadSnapshotParameters = {
/**
- * Set for requests when the TrustToken API is used. Contains the parameters
-passed by the developer (e.g. via "fetch") as understood by the backend.
+ * An array of tiles composing the snapshot.
*/
- trustTokenParams?: TrustTokenParams;
+ tiles: PictureTile[];
+ }
+ export type loadSnapshotReturnValue = {
/**
- * True if this resource request is considered to be the 'same site' as the
-request corresponding to the main frame.
+ * The id of the snapshot.
*/
- isSameSite?: boolean;
+ snapshotId: SnapshotId;
}
/**
- * Details of a signed certificate timestamp (SCT).
+ * Returns the layer snapshot identifier.
*/
- export interface SignedCertificateTimestamp {
+ export type makeSnapshotParameters = {
/**
- * Validation status.
+ * The id of the layer.
*/
- status: string;
+ layerId: LayerId;
+ }
+ export type makeSnapshotReturnValue = {
/**
- * Origin.
+ * The id of the layer snapshot.
*/
- origin: string;
+ snapshotId: SnapshotId;
+ }
+ export type profileSnapshotParameters = {
/**
- * Log name / description.
+ * The id of the layer snapshot.
*/
- logDescription: string;
+ snapshotId: SnapshotId;
/**
- * Log ID.
+ * The maximum number of times to replay the snapshot (1, if not specified).
*/
- logId: string;
+ minRepeatCount?: number;
/**
- * Issuance date. Unlike TimeSinceEpoch, this contains the number of
-milliseconds since January 1, 1970, UTC, not the number of seconds.
+ * The minimum duration (in seconds) to replay the snapshot.
*/
- timestamp: number;
+ minDuration?: number;
/**
- * Hash algorithm.
+ * The clip rectangle to apply when replaying the snapshot.
*/
- hashAlgorithm: string;
+ clipRect?: DOM.Rect;
+ }
+ export type profileSnapshotReturnValue = {
/**
- * Signature algorithm.
+ * The array of paint profiles, one per run.
*/
- signatureAlgorithm: string;
+ timings: PaintProfile[];
+ }
+ /**
+ * Releases layer snapshot captured by the back-end.
+ */
+ export type releaseSnapshotParameters = {
/**
- * Signature data.
+ * The id of the layer snapshot.
*/
- signatureData: string;
+ snapshotId: SnapshotId;
+ }
+ export type releaseSnapshotReturnValue = {
}
/**
- * Security details about a request.
+ * Replays the layer snapshot and returns the resulting bitmap.
*/
- export interface SecurityDetails {
+ export type replaySnapshotParameters = {
/**
- * Protocol name (e.g. "TLS 1.2" or "QUIC").
+ * The id of the layer snapshot.
*/
- protocol: string;
+ snapshotId: SnapshotId;
/**
- * Key Exchange used by the connection, or the empty string if not applicable.
+ * The first step to replay from (replay from the very start if not specified).
*/
- keyExchange: string;
+ fromStep?: number;
/**
- * (EC)DH group used by the connection, if applicable.
+ * The last step to replay to (replay till the end if not specified).
*/
- keyExchangeGroup?: string;
+ toStep?: number;
/**
- * Cipher name.
+ * The scale to apply while replaying (defaults to 1).
*/
- cipher: string;
+ scale?: number;
+ }
+ export type replaySnapshotReturnValue = {
/**
- * TLS MAC. Note that AEAD ciphers do not have separate MACs.
+ * A data: URL for resulting image.
*/
- mac?: string;
+ dataURL: string;
+ }
+ /**
+ * Replays the layer snapshot and returns canvas log.
+ */
+ export type snapshotCommandLogParameters = {
/**
- * Certificate ID value.
+ * The id of the layer snapshot.
*/
- certificateId: Security.CertificateId;
+ snapshotId: SnapshotId;
+ }
+ export type snapshotCommandLogReturnValue = {
/**
- * Certificate subject name.
+ * The array of canvas function calls.
*/
- subjectName: string;
+ commandLog: { [key: string]: string }[];
+ }
+ }
+
+ /**
+ * Provides access to log entries.
+ */
+ export module Log {
+ /**
+ * Log entry.
+ */
+ export interface LogEntry {
/**
- * Subject Alternative Name (SAN) DNS names and IP addresses.
+ * Log entry source.
*/
- sanList: string[];
+ source: "xml"|"javascript"|"network"|"storage"|"appcache"|"rendering"|"security"|"deprecation"|"worker"|"violation"|"intervention"|"recommendation"|"other";
/**
- * Name of the issuing CA.
+ * Log entry severity.
*/
- issuer: string;
+ level: "verbose"|"info"|"warning"|"error";
/**
- * Certificate valid from date.
+ * Logged text.
*/
- validFrom: TimeSinceEpoch;
+ text: string;
+ category?: "cors";
/**
- * Certificate valid to (expiration) date
+ * Timestamp when this entry was added.
*/
- validTo: TimeSinceEpoch;
+ timestamp: Runtime.Timestamp;
/**
- * List of signed certificate timestamps (SCTs).
+ * URL of the resource if known.
*/
- signedCertificateTimestampList: SignedCertificateTimestamp[];
+ url?: string;
/**
- * Whether the request complied with Certificate Transparency policy
+ * Line number in the resource.
*/
- certificateTransparencyCompliance: CertificateTransparencyCompliance;
+ lineNumber?: number;
/**
- * The signature algorithm used by the server in the TLS server signature,
-represented as a TLS SignatureScheme code point. Omitted if not
-applicable or not known.
+ * JavaScript stack trace.
*/
- serverSignatureAlgorithm?: number;
+ stackTrace?: Runtime.StackTrace;
/**
- * Whether the connection used Encrypted ClientHello
+ * Identifier of the network request associated with this entry.
*/
- encryptedClientHello: boolean;
- }
- /**
- * Whether the request complied with Certificate Transparency policy.
+ networkRequestId?: Network.RequestId;
+ /**
+ * Identifier of the worker associated with this entry.
+ */
+ workerId?: string;
+ /**
+ * Call arguments.
+ */
+ args?: Runtime.RemoteObject[];
+ }
+ /**
+ * Violation configuration setting.
*/
- export type CertificateTransparencyCompliance = "unknown"|"not-compliant"|"compliant";
+ export interface ViolationSetting {
+ /**
+ * Violation type.
+ */
+ name: "longTask"|"longLayout"|"blockedEvent"|"blockedParser"|"discouragedAPIUse"|"handler"|"recurringHandler";
+ /**
+ * Time threshold to trigger upon.
+ */
+ threshold: number;
+ }
+
/**
- * The reason why request was blocked.
+ * Issued when new message was logged.
*/
- export type BlockedReason = "other"|"csp"|"mixed-content"|"origin"|"inspector"|"integrity"|"subresource-filter"|"content-type"|"coep-frame-resource-needs-coep-header"|"coop-sandboxed-iframe-cannot-navigate-to-coop-page"|"corp-not-same-origin"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep"|"corp-not-same-origin-after-defaulted-to-same-origin-by-dip"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep-and-dip"|"corp-not-same-site"|"sri-message-signature-mismatch";
+ export type entryAddedPayload = {
+ /**
+ * The entry.
+ */
+ entry: LogEntry;
+ }
+
/**
- * The reason why request was blocked.
+ * Clears the log.
*/
- export type CorsError = "DisallowedByMode"|"InvalidResponse"|"WildcardOriginNotAllowed"|"MissingAllowOriginHeader"|"MultipleAllowOriginValues"|"InvalidAllowOriginValue"|"AllowOriginMismatch"|"InvalidAllowCredentials"|"CorsDisabledScheme"|"PreflightInvalidStatus"|"PreflightDisallowedRedirect"|"PreflightWildcardOriginNotAllowed"|"PreflightMissingAllowOriginHeader"|"PreflightMultipleAllowOriginValues"|"PreflightInvalidAllowOriginValue"|"PreflightAllowOriginMismatch"|"PreflightInvalidAllowCredentials"|"PreflightMissingAllowExternal"|"PreflightInvalidAllowExternal"|"PreflightMissingAllowPrivateNetwork"|"PreflightInvalidAllowPrivateNetwork"|"InvalidAllowMethodsPreflightResponse"|"InvalidAllowHeadersPreflightResponse"|"MethodDisallowedByPreflightResponse"|"HeaderDisallowedByPreflightResponse"|"RedirectContainsCredentials"|"InsecurePrivateNetwork"|"InvalidPrivateNetworkAccess"|"UnexpectedPrivateNetworkAccess"|"NoCorsRedirectModeNotFollow"|"PreflightMissingPrivateNetworkAccessId"|"PreflightMissingPrivateNetworkAccessName"|"PrivateNetworkAccessPermissionUnavailable"|"PrivateNetworkAccessPermissionDenied"|"LocalNetworkAccessPermissionDenied";
- export interface CorsErrorStatus {
- corsError: CorsError;
- failedParameter: string;
+ export type clearParameters = {
+ }
+ export type clearReturnValue = {
}
/**
- * Source of serviceworker response.
+ * Disables log domain, prevents further log entries from being reported to the client.
*/
- export type ServiceWorkerResponseSource = "cache-storage"|"http-cache"|"fallback-code"|"network";
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
/**
- * Determines what type of Trust Token operation is executed and
-depending on the type, some additional parameters. The values
-are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
+ * Enables log domain, sends the entries collected so far to the client by means of the
+`entryAdded` notification.
*/
- export interface TrustTokenParams {
- operation: TrustTokenOperationType;
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * start violation reporting.
+ */
+ export type startViolationsReportParameters = {
/**
- * Only set for "token-redemption" operation and determine whether
-to request a fresh SRR or use a still valid cached SRR.
+ * Configuration for violations.
*/
- refreshPolicy: "UseCached"|"Refresh";
+ config: ViolationSetting[];
+ }
+ export type startViolationsReportReturnValue = {
+ }
+ /**
+ * Stop violation reporting.
+ */
+ export type stopViolationsReportParameters = {
+ }
+ export type stopViolationsReportReturnValue = {
+ }
+ }
+
+ /**
+ * This domain allows detailed inspection of media elements.
+ */
+ export module Media {
+ /**
+ * Players will get an ID that is unique within the agent context.
+ */
+ export type PlayerId = string;
+ export type Timestamp = number;
+ /**
+ * Have one type per entry in MediaLogRecord::Type
+Corresponds to kMessage
+ */
+ export interface PlayerMessage {
/**
- * Origins of issuers from whom to request tokens or redemption
-records.
+ * Keep in sync with MediaLogMessageLevel
+We are currently keeping the message level 'error' separate from the
+PlayerError type because right now they represent different things,
+this one being a DVLOG(ERROR) style log message that gets printed
+based on what log level is selected in the UI, and the other is a
+representation of a media::PipelineStatus object. Soon however we're
+going to be moving away from using PipelineStatus for errors and
+introducing a new error type which should hopefully let us integrate
+the error log level into the PlayerError type.
*/
- issuers?: string[];
+ level: "error"|"warning"|"info"|"debug";
+ message: string;
}
- export type TrustTokenOperationType = "Issuance"|"Redemption"|"Signing";
/**
- * The reason why Chrome uses a specific transport protocol for HTTP semantics.
+ * Corresponds to kMediaPropertyChange
*/
- export type AlternateProtocolUsage = "alternativeJobWonWithoutRace"|"alternativeJobWonRace"|"mainJobWonRace"|"mappingMissing"|"broken"|"dnsAlpnH3JobWonWithoutRace"|"dnsAlpnH3JobWonRace"|"unspecifiedReason";
+ export interface PlayerProperty {
+ name: string;
+ value: string;
+ }
/**
- * Source of service worker router.
+ * Corresponds to kMediaEventTriggered
*/
- export type ServiceWorkerRouterSource = "network"|"cache"|"fetch-event"|"race-network-and-fetch-handler"|"race-network-and-cache";
- export interface ServiceWorkerRouterInfo {
+ export interface PlayerEvent {
+ timestamp: Timestamp;
+ value: string;
+ }
+ /**
+ * Represents logged source line numbers reported in an error.
+NOTE: file and line are from chromium c++ implementation code, not js.
+ */
+ export interface PlayerErrorSourceLocation {
+ file: string;
+ line: number;
+ }
+ /**
+ * Corresponds to kMediaError
+ */
+ export interface PlayerError {
+ errorType: string;
/**
- * ID of the rule matched. If there is a matched rule, this field will
-be set, otherwiser no value will be set.
+ * Code is the numeric enum entry for a specific set of error codes, such
+as PipelineStatusCodes in media/base/pipeline_status.h
*/
- ruleIdMatched?: number;
+ code: number;
/**
- * The router source of the matched rule. If there is a matched rule, this
-field will be set, otherwise no value will be set.
+ * A trace of where this error was caused / where it passed through.
*/
- matchedSourceType?: ServiceWorkerRouterSource;
+ stack: PlayerErrorSourceLocation[];
/**
- * The actual router source used.
+ * Errors potentially have a root cause error, ie, a DecoderError might be
+caused by an WindowsError
*/
- actualSourceType?: ServiceWorkerRouterSource;
+ cause: PlayerError[];
+ /**
+ * Extra data attached to an error, such as an HRESULT, Video Codec, etc.
+ */
+ data: { [key: string]: string };
+ }
+ export interface Player {
+ playerId: PlayerId;
+ domNodeId?: DOM.BackendNodeId;
}
+
/**
- * HTTP response data.
+ * This can be called multiple times, and can be used to set / override /
+remove player properties. A null propValue indicates removal.
*/
- export interface Response {
+ export type playerPropertiesChangedPayload = {
+ playerId: PlayerId;
+ properties: PlayerProperty[];
+ }
+ /**
+ * Send events as a list, allowing them to be batched on the browser for less
+congestion. If batched, events must ALWAYS be in chronological order.
+ */
+ export type playerEventsAddedPayload = {
+ playerId: PlayerId;
+ events: PlayerEvent[];
+ }
+ /**
+ * Send a list of any messages that need to be delivered.
+ */
+ export type playerMessagesLoggedPayload = {
+ playerId: PlayerId;
+ messages: PlayerMessage[];
+ }
+ /**
+ * Send a list of any errors that need to be delivered.
+ */
+ export type playerErrorsRaisedPayload = {
+ playerId: PlayerId;
+ errors: PlayerError[];
+ }
+ /**
+ * Called whenever a player is created, or when a new agent joins and receives
+a list of active players. If an agent is restored, it will receive one
+event for each active player.
+ */
+ export type playerCreatedPayload = {
+ player: Player;
+ }
+
+ /**
+ * Enables the Media domain
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disables the Media domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ }
+
+ export module Memory {
+ /**
+ * Memory pressure level.
+ */
+ export type PressureLevel = "moderate"|"critical";
+ /**
+ * Heap profile sample.
+ */
+ export interface SamplingProfileNode {
/**
- * Response URL. This URL can be different from CachedResource.url in case of redirect.
+ * Size of the sampled allocation.
*/
- url: string;
+ size: number;
/**
- * HTTP response status code.
+ * Total bytes attributed to this sample.
*/
- status: number;
+ total: number;
/**
- * HTTP response status text.
+ * Execution stack at the point of allocation.
*/
- statusText: string;
+ stack: string[];
+ }
+ /**
+ * Array of heap profile samples.
+ */
+ export interface SamplingProfile {
+ samples: SamplingProfileNode[];
+ modules: Module[];
+ }
+ /**
+ * Executable module information
+ */
+ export interface Module {
/**
- * HTTP response headers.
+ * Name of the module.
*/
- headers: Headers;
+ name: string;
/**
- * HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
+ * UUID of the module.
*/
- headersText?: string;
+ uuid: string;
/**
- * Resource mimeType as determined by the browser.
- */
- mimeType: string;
- /**
- * Resource charset as determined by the browser (if applicable).
+ * Base address where the module is loaded into memory. Encoded as a decimal
+or hexadecimal (0x prefixed) string.
*/
- charset: string;
+ baseAddress: string;
/**
- * Refined HTTP request headers that were actually transmitted over the network.
+ * Size of the module in bytes.
*/
- requestHeaders?: Headers;
+ size: number;
+ }
+ /**
+ * DOM object counter data.
+ */
+ export interface DOMCounter {
/**
- * HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
+ * Object name. Note: object names should be presumed volatile and clients should not expect
+the returned names to be consistent across runs.
*/
- requestHeadersText?: string;
+ name: string;
/**
- * Specifies whether physical connection was actually reused for this request.
+ * Object count.
*/
- connectionReused: boolean;
+ count: number;
+ }
+
+
+ /**
+ * Retruns current DOM object counters.
+ */
+ export type getDOMCountersParameters = {
+ }
+ export type getDOMCountersReturnValue = {
+ documents: number;
+ nodes: number;
+ jsEventListeners: number;
+ }
+ /**
+ * Retruns DOM object counters after preparing renderer for leak detection.
+ */
+ export type getDOMCountersForLeakDetectionParameters = {
+ }
+ export type getDOMCountersForLeakDetectionReturnValue = {
/**
- * Physical connection id that was actually used for this request.
+ * DOM object counters.
*/
- connectionId: number;
+ counters: DOMCounter[];
+ }
+ /**
+ * Prepares for leak detection by terminating workers, stopping spellcheckers,
+dropping non-essential internal caches, running garbage collections, etc.
+ */
+ export type prepareForLeakDetectionParameters = {
+ }
+ export type prepareForLeakDetectionReturnValue = {
+ }
+ /**
+ * Simulate OomIntervention by purging V8 memory.
+ */
+ export type forciblyPurgeJavaScriptMemoryParameters = {
+ }
+ export type forciblyPurgeJavaScriptMemoryReturnValue = {
+ }
+ /**
+ * Enable/disable suppressing memory pressure notifications in all processes.
+ */
+ export type setPressureNotificationsSuppressedParameters = {
/**
- * Remote IP address.
+ * If true, memory pressure notifications will be suppressed.
*/
- remoteIPAddress?: string;
+ suppressed: boolean;
+ }
+ export type setPressureNotificationsSuppressedReturnValue = {
+ }
+ /**
+ * Simulate a memory pressure notification in all processes.
+ */
+ export type simulatePressureNotificationParameters = {
/**
- * Remote port.
+ * Memory pressure level of the notification.
*/
- remotePort?: number;
+ level: PressureLevel;
+ }
+ export type simulatePressureNotificationReturnValue = {
+ }
+ /**
+ * Start collecting native memory profile.
+ */
+ export type startSamplingParameters = {
/**
- * Specifies that the request was served from the disk cache.
+ * Average number of bytes between samples.
*/
- fromDiskCache?: boolean;
+ samplingInterval?: number;
/**
- * Specifies that the request was served from the ServiceWorker.
+ * Do not randomize intervals between samples.
*/
- fromServiceWorker?: boolean;
+ suppressRandomness?: boolean;
+ }
+ export type startSamplingReturnValue = {
+ }
+ /**
+ * Stop collecting native memory profile.
+ */
+ export type stopSamplingParameters = {
+ }
+ export type stopSamplingReturnValue = {
+ }
+ /**
+ * Retrieve native memory allocations profile
+collected since renderer process startup.
+ */
+ export type getAllTimeSamplingProfileParameters = {
+ }
+ export type getAllTimeSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ /**
+ * Retrieve native memory allocations profile
+collected since browser process startup.
+ */
+ export type getBrowserSamplingProfileParameters = {
+ }
+ export type getBrowserSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ /**
+ * Retrieve native memory allocations profile collected since last
+`startSampling` call.
+ */
+ export type getSamplingProfileParameters = {
+ }
+ export type getSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ }
+
+ /**
+ * Network domain allows tracking network activities of the page. It exposes information about http,
+file, data and other requests and responses, their headers, bodies, timing, etc.
+ */
+ export module Network {
+ /**
+ * Resource type as it was perceived by the rendering engine.
+ */
+ export type ResourceType = "Document"|"Stylesheet"|"Image"|"Media"|"Font"|"Script"|"TextTrack"|"XHR"|"Fetch"|"Prefetch"|"EventSource"|"WebSocket"|"Manifest"|"SignedExchange"|"Ping"|"CSPViolationReport"|"Preflight"|"FedCM"|"Other";
+ /**
+ * Unique loader identifier.
+ */
+ export type LoaderId = string;
+ /**
+ * Unique network request identifier.
+Note that this does not identify individual HTTP requests that are part of
+a network request.
+ */
+ export type RequestId = string;
+ /**
+ * Unique intercepted request identifier.
+ */
+ export type InterceptionId = string;
+ /**
+ * Network level fetch failure reason.
+ */
+ export type ErrorReason = "Failed"|"Aborted"|"TimedOut"|"AccessDenied"|"ConnectionClosed"|"ConnectionReset"|"ConnectionRefused"|"ConnectionAborted"|"ConnectionFailed"|"NameNotResolved"|"InternetDisconnected"|"AddressUnreachable"|"BlockedByClient"|"BlockedByResponse";
+ /**
+ * UTC time in seconds, counted from January 1, 1970.
+ */
+ export type TimeSinceEpoch = number;
+ /**
+ * Monotonically increasing time in seconds since an arbitrary point in the past.
+ */
+ export type MonotonicTime = number;
+ /**
+ * Request / response headers as keys / values of JSON object.
+ */
+ export type Headers = { [key: string]: string };
+ /**
+ * The underlying connection technology that the browser is supposedly using.
+ */
+ export type ConnectionType = "none"|"cellular2g"|"cellular3g"|"cellular4g"|"bluetooth"|"ethernet"|"wifi"|"wimax"|"other";
+ /**
+ * Represents the cookie's 'SameSite' status:
+https://tools.ietf.org/html/draft-west-first-party-cookies
+ */
+ export type CookieSameSite = "Strict"|"Lax"|"None";
+ /**
+ * Represents the cookie's 'Priority' status:
+https://tools.ietf.org/html/draft-west-cookie-priority-00
+ */
+ export type CookiePriority = "Low"|"Medium"|"High";
+ /**
+ * Represents the source scheme of the origin that originally set the cookie.
+A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
+This is a temporary ability and it will be removed in the future.
+ */
+ export type CookieSourceScheme = "Unset"|"NonSecure"|"Secure";
+ /**
+ * Timing information for the request.
+ */
+ export interface ResourceTiming {
/**
- * Specifies that the request was served from the prefetch cache.
+ * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
+milliseconds relatively to this requestTime.
*/
- fromPrefetchCache?: boolean;
+ requestTime: number;
/**
- * Specifies that the request was served from the prefetch cache.
+ * Started resolving proxy.
*/
- fromEarlyHints?: boolean;
+ proxyStart: number;
/**
- * Information about how ServiceWorker Static Router API was used. If this
-field is set with `matchedSourceType` field, a matching rule is found.
-If this field is set without `matchedSource`, no matching rule is found.
-Otherwise, the API is not used.
+ * Finished resolving proxy.
*/
- serviceWorkerRouterInfo?: ServiceWorkerRouterInfo;
+ proxyEnd: number;
/**
- * Total number of bytes received for this request so far.
+ * Started DNS address resolve.
*/
- encodedDataLength: number;
+ dnsStart: number;
/**
- * Timing information for the given request.
+ * Finished DNS address resolve.
*/
- timing?: ResourceTiming;
+ dnsEnd: number;
/**
- * Response source of response from ServiceWorker.
+ * Started connecting to the remote host.
*/
- serviceWorkerResponseSource?: ServiceWorkerResponseSource;
+ connectStart: number;
/**
- * The time at which the returned response was generated.
+ * Connected to the remote host.
*/
- responseTime?: TimeSinceEpoch;
+ connectEnd: number;
/**
- * Cache Storage Cache Name.
+ * Started SSL handshake.
*/
- cacheStorageCacheName?: string;
+ sslStart: number;
/**
- * Protocol used to fetch this request.
+ * Finished SSL handshake.
*/
- protocol?: string;
+ sslEnd: number;
/**
- * The reason why Chrome uses a specific transport protocol for HTTP semantics.
+ * Started running ServiceWorker.
*/
- alternateProtocolUsage?: AlternateProtocolUsage;
+ workerStart: number;
/**
- * Security state of the request resource.
+ * Finished Starting ServiceWorker.
*/
- securityState: Security.SecurityState;
+ workerReady: number;
/**
- * Security details for the request.
+ * Started fetch event.
*/
- securityDetails?: SecurityDetails;
+ workerFetchStart: number;
/**
- * Indicates whether the request was sent through IP Protection proxies. If
-set to true, the request used the IP Protection privacy feature.
+ * Settled fetch event respondWith promise.
*/
- isIpProtectionUsed?: boolean;
+ workerRespondWithSettled: number;
+ /**
+ * Started ServiceWorker static routing source evaluation.
+ */
+ workerRouterEvaluationStart?: number;
+ /**
+ * Started cache lookup when the source was evaluated to `cache`.
+ */
+ workerCacheLookupStart?: number;
+ /**
+ * Started sending request.
+ */
+ sendStart: number;
+ /**
+ * Finished sending request.
+ */
+ sendEnd: number;
+ /**
+ * Time the server started pushing request.
+ */
+ pushStart: number;
+ /**
+ * Time the server finished pushing request.
+ */
+ pushEnd: number;
+ /**
+ * Started receiving response headers.
+ */
+ receiveHeadersStart: number;
+ /**
+ * Finished receiving response headers.
+ */
+ receiveHeadersEnd: number;
}
/**
- * WebSocket request data.
+ * Loading priority of a resource request.
*/
- export interface WebSocketRequest {
- /**
- * HTTP request headers.
- */
- headers: Headers;
+ export type ResourcePriority = "VeryLow"|"Low"|"Medium"|"High"|"VeryHigh";
+ /**
+ * Post data entry for HTTP request
+ */
+ export interface PostDataEntry {
+ bytes?: binary;
}
/**
- * WebSocket response data.
+ * HTTP request data.
*/
- export interface WebSocketResponse {
+ export interface Request {
/**
- * HTTP response status code.
+ * Request URL (without fragment).
*/
- status: number;
+ url: string;
/**
- * HTTP response status text.
+ * Fragment of the requested URL starting with hash, if present.
*/
- statusText: string;
+ urlFragment?: string;
/**
- * HTTP response headers.
+ * HTTP request method.
*/
- headers: Headers;
+ method: string;
/**
- * HTTP response headers text.
+ * HTTP request headers.
*/
- headersText?: string;
+ headers: Headers;
/**
- * HTTP request headers.
+ * HTTP POST request data.
+Use postDataEntries instead.
*/
- requestHeaders?: Headers;
+ postData?: string;
/**
- * HTTP request headers text.
+ * True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.
*/
- requestHeadersText?: string;
- }
- /**
- * WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
- */
- export interface WebSocketFrame {
+ hasPostData?: boolean;
/**
- * WebSocket message opcode.
+ * Request body elements (post data broken into individual entries).
*/
- opcode: number;
+ postDataEntries?: PostDataEntry[];
/**
- * WebSocket message mask.
+ * The mixed content type of the request.
*/
- mask: boolean;
+ mixedContentType?: Security.MixedContentType;
/**
- * WebSocket message payload data.
-If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
-If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
+ * Priority of the resource request at the time request is sent.
*/
- payloadData: string;
- }
- /**
- * Information about the cached resource.
- */
- export interface CachedResource {
+ initialPriority: ResourcePriority;
/**
- * Resource URL. This is the url of the original network request.
+ * The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
*/
- url: string;
+ referrerPolicy: "unsafe-url"|"no-referrer-when-downgrade"|"no-referrer"|"origin"|"origin-when-cross-origin"|"same-origin"|"strict-origin"|"strict-origin-when-cross-origin";
/**
- * Type of this resource.
+ * Whether is loaded via link preload.
*/
- type: ResourceType;
+ isLinkPreload?: boolean;
/**
- * Cached response data.
+ * Set for requests when the TrustToken API is used. Contains the parameters
+passed by the developer (e.g. via "fetch") as understood by the backend.
*/
- response?: Response;
+ trustTokenParams?: TrustTokenParams;
/**
- * Cached response body size.
+ * True if this resource request is considered to be the 'same site' as the
+request corresponding to the main frame.
*/
- bodySize: number;
+ isSameSite?: boolean;
}
/**
- * Information about the request initiator.
+ * Details of a signed certificate timestamp (SCT).
*/
- export interface Initiator {
+ export interface SignedCertificateTimestamp {
/**
- * Type of this initiator.
+ * Validation status.
*/
- type: "parser"|"script"|"preload"|"SignedExchange"|"preflight"|"other";
+ status: string;
/**
- * Initiator JavaScript stack trace, set for Script only.
-Requires the Debugger domain to be enabled.
+ * Origin.
*/
- stack?: Runtime.StackTrace;
+ origin: string;
/**
- * Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
+ * Log name / description.
*/
- url?: string;
+ logDescription: string;
/**
- * Initiator line number, set for Parser type or for Script type (when script is importing
-module) (0-based).
+ * Log ID.
*/
- lineNumber?: number;
+ logId: string;
/**
- * Initiator column number, set for Parser type or for Script type (when script is importing
-module) (0-based).
+ * Issuance date. Unlike TimeSinceEpoch, this contains the number of
+milliseconds since January 1, 1970, UTC, not the number of seconds.
*/
- columnNumber?: number;
+ timestamp: number;
/**
- * Set if another request triggered this request (e.g. preflight).
+ * Hash algorithm.
*/
- requestId?: RequestId;
- }
- /**
- * cookiePartitionKey object
-The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h.
- */
- export interface CookiePartitionKey {
+ hashAlgorithm: string;
/**
- * The site of the top-level URL the browser was visiting at the start
-of the request to the endpoint that set the cookie.
+ * Signature algorithm.
*/
- topLevelSite: string;
+ signatureAlgorithm: string;
/**
- * Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.
+ * Signature data.
*/
- hasCrossSiteAncestor: boolean;
+ signatureData: string;
}
/**
- * Cookie object
+ * Security details about a request.
*/
- export interface Cookie {
- /**
- * Cookie name.
- */
- name: string;
+ export interface SecurityDetails {
/**
- * Cookie value.
+ * Protocol name (e.g. "TLS 1.2" or "QUIC").
*/
- value: string;
+ protocol: string;
/**
- * Cookie domain.
+ * Key Exchange used by the connection, or the empty string if not applicable.
*/
- domain: string;
+ keyExchange: string;
/**
- * Cookie path.
+ * (EC)DH group used by the connection, if applicable.
*/
- path: string;
+ keyExchangeGroup?: string;
/**
- * Cookie expiration date as the number of seconds since the UNIX epoch.
+ * Cipher name.
*/
- expires: number;
+ cipher: string;
/**
- * Cookie size.
+ * TLS MAC. Note that AEAD ciphers do not have separate MACs.
*/
- size: number;
+ mac?: string;
/**
- * True if cookie is http-only.
+ * Certificate ID value.
*/
- httpOnly: boolean;
+ certificateId: Security.CertificateId;
/**
- * True if cookie is secure.
+ * Certificate subject name.
*/
- secure: boolean;
+ subjectName: string;
/**
- * True in case of session cookie.
+ * Subject Alternative Name (SAN) DNS names and IP addresses.
*/
- session: boolean;
+ sanList: string[];
/**
- * Cookie SameSite type.
+ * Name of the issuing CA.
*/
- sameSite?: CookieSameSite;
+ issuer: string;
/**
- * Cookie Priority
+ * Certificate valid from date.
*/
- priority: CookiePriority;
+ validFrom: TimeSinceEpoch;
/**
- * True if cookie is SameParty.
+ * Certificate valid to (expiration) date
*/
- sameParty: boolean;
+ validTo: TimeSinceEpoch;
/**
- * Cookie source scheme type.
+ * List of signed certificate timestamps (SCTs).
*/
- sourceScheme: CookieSourceScheme;
+ signedCertificateTimestampList: SignedCertificateTimestamp[];
/**
- * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
-An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
-This is a temporary ability and it will be removed in the future.
+ * Whether the request complied with Certificate Transparency policy
*/
- sourcePort: number;
+ certificateTransparencyCompliance: CertificateTransparencyCompliance;
/**
- * Cookie partition key.
+ * The signature algorithm used by the server in the TLS server signature,
+represented as a TLS SignatureScheme code point. Omitted if not
+applicable or not known.
*/
- partitionKey?: CookiePartitionKey;
+ serverSignatureAlgorithm?: number;
/**
- * True if cookie partition key is opaque.
+ * Whether the connection used Encrypted ClientHello
*/
- partitionKeyOpaque?: boolean;
+ encryptedClientHello: boolean;
}
/**
- * Types of reasons why a cookie may not be stored from a response.
+ * Whether the request complied with Certificate Transparency policy.
*/
- export type SetCookieBlockedReason = "SecureOnly"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"SyntaxError"|"SchemeNotSupported"|"OverwriteSecure"|"InvalidDomain"|"InvalidPrefix"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"SamePartyConflictsWithOtherAttributes"|"NameValuePairExceedsMaxSize"|"DisallowedCharacter"|"NoCookieContent";
+ export type CertificateTransparencyCompliance = "unknown"|"not-compliant"|"compliant";
/**
- * Types of reasons why a cookie may not be sent with a request.
+ * The reason why request was blocked.
*/
- export type CookieBlockedReason = "SecureOnly"|"NotOnPath"|"DomainMismatch"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"NameValuePairExceedsMaxSize"|"PortMismatch"|"SchemeMismatch"|"AnonymousContext";
+ export type BlockedReason = "other"|"csp"|"mixed-content"|"origin"|"inspector"|"integrity"|"subresource-filter"|"content-type"|"coep-frame-resource-needs-coep-header"|"coop-sandboxed-iframe-cannot-navigate-to-coop-page"|"corp-not-same-origin"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep"|"corp-not-same-origin-after-defaulted-to-same-origin-by-dip"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep-and-dip"|"corp-not-same-site"|"sri-message-signature-mismatch";
/**
- * Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
+ * Sets Controls for IP Proxy of requests.
+Page reload is required before the new behavior will be observed.
*/
- export type CookieExemptionReason = "None"|"UserSetting"|"TPCDMetadata"|"TPCDDeprecationTrial"|"TopLevelTPCDDeprecationTrial"|"TPCDHeuristics"|"EnterprisePolicy"|"StorageAccess"|"TopLevelStorageAccess"|"Scheme"|"SameSiteNoneCookiesInSandbox";
+ export type IpProxyStatus = "Available"|"FeatureNotEnabled"|"MaskedDomainListNotEnabled"|"MaskedDomainListNotPopulated"|"AuthTokensUnavailable"|"Unavailable"|"BypassedByDevTools";
/**
- * A cookie which was not stored from a response with the corresponding reason.
+ * The reason why request was blocked.
*/
- export interface BlockedSetCookieWithReason {
- /**
- * The reason(s) this cookie was blocked.
- */
- blockedReasons: SetCookieBlockedReason[];
- /**
- * The string representing this individual cookie as it would appear in the header.
-This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
+ export type CorsError = "DisallowedByMode"|"InvalidResponse"|"WildcardOriginNotAllowed"|"MissingAllowOriginHeader"|"MultipleAllowOriginValues"|"InvalidAllowOriginValue"|"AllowOriginMismatch"|"InvalidAllowCredentials"|"CorsDisabledScheme"|"PreflightInvalidStatus"|"PreflightDisallowedRedirect"|"PreflightWildcardOriginNotAllowed"|"PreflightMissingAllowOriginHeader"|"PreflightMultipleAllowOriginValues"|"PreflightInvalidAllowOriginValue"|"PreflightAllowOriginMismatch"|"PreflightInvalidAllowCredentials"|"PreflightMissingAllowExternal"|"PreflightInvalidAllowExternal"|"PreflightMissingAllowPrivateNetwork"|"PreflightInvalidAllowPrivateNetwork"|"InvalidAllowMethodsPreflightResponse"|"InvalidAllowHeadersPreflightResponse"|"MethodDisallowedByPreflightResponse"|"HeaderDisallowedByPreflightResponse"|"RedirectContainsCredentials"|"InsecurePrivateNetwork"|"InvalidPrivateNetworkAccess"|"UnexpectedPrivateNetworkAccess"|"NoCorsRedirectModeNotFollow"|"PreflightMissingPrivateNetworkAccessId"|"PreflightMissingPrivateNetworkAccessName"|"PrivateNetworkAccessPermissionUnavailable"|"PrivateNetworkAccessPermissionDenied"|"LocalNetworkAccessPermissionDenied";
+ export interface CorsErrorStatus {
+ corsError: CorsError;
+ failedParameter: string;
+ }
+ /**
+ * Source of serviceworker response.
+ */
+ export type ServiceWorkerResponseSource = "cache-storage"|"http-cache"|"fallback-code"|"network";
+ /**
+ * Determines what type of Trust Token operation is executed and
+depending on the type, some additional parameters. The values
+are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
+ */
+ export interface TrustTokenParams {
+ operation: TrustTokenOperationType;
+ /**
+ * Only set for "token-redemption" operation and determine whether
+to request a fresh SRR or use a still valid cached SRR.
*/
- cookieLine: string;
+ refreshPolicy: "UseCached"|"Refresh";
/**
- * The cookie object which represents the cookie which was not stored. It is optional because
-sometimes complete cookie information is not available, such as in the case of parsing
-errors.
+ * Origins of issuers from whom to request tokens or redemption
+records.
*/
- cookie?: Cookie;
+ issuers?: string[];
}
+ export type TrustTokenOperationType = "Issuance"|"Redemption"|"Signing";
/**
- * A cookie should have been blocked by 3PCD but is exempted and stored from a response with the
-corresponding reason. A cookie could only have at most one exemption reason.
+ * The reason why Chrome uses a specific transport protocol for HTTP semantics.
*/
- export interface ExemptedSetCookieWithReason {
+ export type AlternateProtocolUsage = "alternativeJobWonWithoutRace"|"alternativeJobWonRace"|"mainJobWonRace"|"mappingMissing"|"broken"|"dnsAlpnH3JobWonWithoutRace"|"dnsAlpnH3JobWonRace"|"unspecifiedReason";
+ /**
+ * Source of service worker router.
+ */
+ export type ServiceWorkerRouterSource = "network"|"cache"|"fetch-event"|"race-network-and-fetch-handler"|"race-network-and-cache";
+ export interface ServiceWorkerRouterInfo {
/**
- * The reason the cookie was exempted.
+ * ID of the rule matched. If there is a matched rule, this field will
+be set, otherwiser no value will be set.
*/
- exemptionReason: CookieExemptionReason;
+ ruleIdMatched?: number;
/**
- * The string representing this individual cookie as it would appear in the header.
+ * The router source of the matched rule. If there is a matched rule, this
+field will be set, otherwise no value will be set.
*/
- cookieLine: string;
+ matchedSourceType?: ServiceWorkerRouterSource;
/**
- * The cookie object representing the cookie.
+ * The actual router source used.
*/
- cookie: Cookie;
+ actualSourceType?: ServiceWorkerRouterSource;
}
/**
- * A cookie associated with the request which may or may not be sent with it.
-Includes the cookies itself and reasons for blocking or exemption.
+ * HTTP response data.
*/
- export interface AssociatedCookie {
+ export interface Response {
/**
- * The cookie object representing the cookie which was not sent.
+ * Response URL. This URL can be different from CachedResource.url in case of redirect.
*/
- cookie: Cookie;
+ url: string;
/**
- * The reason(s) the cookie was blocked. If empty means the cookie is included.
+ * HTTP response status code.
*/
- blockedReasons: CookieBlockedReason[];
+ status: number;
/**
- * The reason the cookie should have been blocked by 3PCD but is exempted. A cookie could
-only have at most one exemption reason.
+ * HTTP response status text.
*/
- exemptionReason?: CookieExemptionReason;
- }
- /**
- * Cookie parameter object
- */
- export interface CookieParam {
+ statusText: string;
/**
- * Cookie name.
+ * HTTP response headers.
*/
- name: string;
+ headers: Headers;
/**
- * Cookie value.
+ * HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
*/
- value: string;
+ headersText?: string;
/**
- * The request-URI to associate with the setting of the cookie. This value can affect the
-default domain, path, source port, and source scheme values of the created cookie.
+ * Resource mimeType as determined by the browser.
*/
- url?: string;
+ mimeType: string;
/**
- * Cookie domain.
+ * Resource charset as determined by the browser (if applicable).
*/
- domain?: string;
+ charset: string;
/**
- * Cookie path.
+ * Refined HTTP request headers that were actually transmitted over the network.
*/
- path?: string;
+ requestHeaders?: Headers;
/**
- * True if cookie is secure.
+ * HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
*/
- secure?: boolean;
+ requestHeadersText?: string;
/**
- * True if cookie is http-only.
+ * Specifies whether physical connection was actually reused for this request.
*/
- httpOnly?: boolean;
+ connectionReused: boolean;
/**
- * Cookie SameSite type.
+ * Physical connection id that was actually used for this request.
*/
- sameSite?: CookieSameSite;
+ connectionId: number;
/**
- * Cookie expiration date, session cookie if not set
+ * Remote IP address.
*/
- expires?: TimeSinceEpoch;
+ remoteIPAddress?: string;
/**
- * Cookie Priority.
+ * Remote port.
*/
- priority?: CookiePriority;
+ remotePort?: number;
/**
- * True if cookie is SameParty.
+ * Specifies that the request was served from the disk cache.
*/
- sameParty?: boolean;
+ fromDiskCache?: boolean;
/**
- * Cookie source scheme type.
+ * Specifies that the request was served from the ServiceWorker.
*/
- sourceScheme?: CookieSourceScheme;
+ fromServiceWorker?: boolean;
/**
- * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
-An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
-This is a temporary ability and it will be removed in the future.
+ * Specifies that the request was served from the prefetch cache.
*/
- sourcePort?: number;
+ fromPrefetchCache?: boolean;
/**
- * Cookie partition key. If not set, the cookie will be set as not partitioned.
+ * Specifies that the request was served from the prefetch cache.
*/
- partitionKey?: CookiePartitionKey;
- }
- /**
- * Authorization challenge for HTTP status code 401 or 407.
- */
- export interface AuthChallenge {
+ fromEarlyHints?: boolean;
/**
- * Source of the authentication challenge.
+ * Information about how ServiceWorker Static Router API was used. If this
+field is set with `matchedSourceType` field, a matching rule is found.
+If this field is set without `matchedSource`, no matching rule is found.
+Otherwise, the API is not used.
*/
- source?: "Server"|"Proxy";
+ serviceWorkerRouterInfo?: ServiceWorkerRouterInfo;
/**
- * Origin of the challenger.
+ * Total number of bytes received for this request so far.
*/
- origin: string;
+ encodedDataLength: number;
/**
- * The authentication scheme used, such as basic or digest
+ * Timing information for the given request.
*/
- scheme: string;
+ timing?: ResourceTiming;
/**
- * The realm of the challenge. May be empty.
+ * Response source of response from ServiceWorker.
*/
- realm: string;
- }
- /**
- * Response to an AuthChallenge.
- */
- export interface AuthChallengeResponse {
+ serviceWorkerResponseSource?: ServiceWorkerResponseSource;
/**
- * The decision on what to do in response to the authorization challenge. Default means
-deferring to the default behavior of the net stack, which will likely either the Cancel
-authentication or display a popup dialog box.
+ * The time at which the returned response was generated.
*/
- response: "Default"|"CancelAuth"|"ProvideCredentials";
+ responseTime?: TimeSinceEpoch;
/**
- * The username to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Cache Storage Cache Name.
*/
- username?: string;
+ cacheStorageCacheName?: string;
/**
- * The password to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Protocol used to fetch this request.
*/
- password?: string;
- }
- /**
- * Stages of the interception to begin intercepting. Request will intercept before the request is
-sent. Response will intercept after the response is received.
- */
- export type InterceptionStage = "Request"|"HeadersReceived";
- /**
- * Request pattern for interception.
- */
- export interface RequestPattern {
+ protocol?: string;
/**
- * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
-backslash. Omitting is equivalent to `"*"`.
+ * The reason why Chrome uses a specific transport protocol for HTTP semantics.
*/
- urlPattern?: string;
+ alternateProtocolUsage?: AlternateProtocolUsage;
/**
- * If set, only requests for matching resource types will be intercepted.
+ * Security state of the request resource.
*/
- resourceType?: ResourceType;
+ securityState: Security.SecurityState;
/**
- * Stage at which to begin intercepting requests. Default is Request.
+ * Security details for the request.
*/
- interceptionStage?: InterceptionStage;
+ securityDetails?: SecurityDetails;
+ /**
+ * Indicates whether the request was sent through IP Protection proxies. If
+set to true, the request used the IP Protection privacy feature.
+ */
+ isIpProtectionUsed?: boolean;
}
/**
- * Information about a signed exchange signature.
-https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
+ * WebSocket request data.
*/
- export interface SignedExchangeSignature {
+ export interface WebSocketRequest {
/**
- * Signed exchange signature label.
+ * HTTP request headers.
*/
- label: string;
+ headers: Headers;
+ }
+ /**
+ * WebSocket response data.
+ */
+ export interface WebSocketResponse {
/**
- * The hex string of signed exchange signature.
+ * HTTP response status code.
*/
- signature: string;
+ status: number;
/**
- * Signed exchange signature integrity.
+ * HTTP response status text.
*/
- integrity: string;
+ statusText: string;
/**
- * Signed exchange signature cert Url.
+ * HTTP response headers.
*/
- certUrl?: string;
+ headers: Headers;
/**
- * The hex string of signed exchange signature cert sha256.
+ * HTTP response headers text.
*/
- certSha256?: string;
+ headersText?: string;
/**
- * Signed exchange signature validity Url.
+ * HTTP request headers.
*/
- validityUrl: string;
+ requestHeaders?: Headers;
/**
- * Signed exchange signature date.
+ * HTTP request headers text.
*/
- date: number;
+ requestHeadersText?: string;
+ }
+ /**
+ * WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
+ */
+ export interface WebSocketFrame {
/**
- * Signed exchange signature expires.
+ * WebSocket message opcode.
*/
- expires: number;
+ opcode: number;
/**
- * The encoded certificates.
+ * WebSocket message mask.
*/
- certificates?: string[];
+ mask: boolean;
+ /**
+ * WebSocket message payload data.
+If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
+If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
+ */
+ payloadData: string;
}
/**
- * Information about a signed exchange header.
-https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
+ * Information about the cached resource.
*/
- export interface SignedExchangeHeader {
- /**
- * Signed exchange request URL.
- */
- requestUrl: string;
+ export interface CachedResource {
/**
- * Signed exchange response code.
+ * Resource URL. This is the url of the original network request.
*/
- responseCode: number;
+ url: string;
/**
- * Signed exchange response headers.
+ * Type of this resource.
*/
- responseHeaders: Headers;
+ type: ResourceType;
/**
- * Signed exchange response signature.
+ * Cached response data.
*/
- signatures: SignedExchangeSignature[];
+ response?: Response;
/**
- * Signed exchange header integrity hash in the form of `sha256-<base64-hash-value>`.
+ * Cached response body size.
*/
- headerIntegrity: string;
+ bodySize: number;
}
/**
- * Field type for a signed exchange related error.
- */
- export type SignedExchangeErrorField = "signatureSig"|"signatureIntegrity"|"signatureCertUrl"|"signatureCertSha256"|"signatureValidityUrl"|"signatureTimestamps";
- /**
- * Information about a signed exchange response.
+ * Information about the request initiator.
*/
- export interface SignedExchangeError {
+ export interface Initiator {
/**
- * Error message.
+ * Type of this initiator.
*/
- message: string;
+ type: "parser"|"script"|"preload"|"SignedExchange"|"preflight"|"other";
/**
- * The index of the signature which caused the error.
+ * Initiator JavaScript stack trace, set for Script only.
+Requires the Debugger domain to be enabled.
*/
- signatureIndex?: number;
+ stack?: Runtime.StackTrace;
/**
- * The field which caused the error.
+ * Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
*/
- errorField?: SignedExchangeErrorField;
- }
- /**
- * Information about a signed exchange response.
- */
- export interface SignedExchangeInfo {
+ url?: string;
/**
- * The outer response of signed HTTP exchange which was received from network.
+ * Initiator line number, set for Parser type or for Script type (when script is importing
+module) (0-based).
*/
- outerResponse: Response;
+ lineNumber?: number;
/**
- * Whether network response for the signed exchange was accompanied by
-extra headers.
+ * Initiator column number, set for Parser type or for Script type (when script is importing
+module) (0-based).
*/
- hasExtraInfo: boolean;
+ columnNumber?: number;
/**
- * Information about the signed exchange header.
+ * Set if another request triggered this request (e.g. preflight).
*/
- header?: SignedExchangeHeader;
+ requestId?: RequestId;
+ }
+ /**
+ * cookiePartitionKey object
+The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h.
+ */
+ export interface CookiePartitionKey {
/**
- * Security details for the signed exchange header.
+ * The site of the top-level URL the browser was visiting at the start
+of the request to the endpoint that set the cookie.
*/
- securityDetails?: SecurityDetails;
+ topLevelSite: string;
/**
- * Errors occurred while handling the signed exchange.
+ * Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.
*/
- errors?: SignedExchangeError[];
+ hasCrossSiteAncestor: boolean;
}
/**
- * List of content encodings supported by the backend.
+ * Cookie object
*/
- export type ContentEncoding = "deflate"|"gzip"|"br"|"zstd";
- export type DirectSocketDnsQueryType = "ipv4"|"ipv6";
- export interface DirectTCPSocketOptions {
+ export interface Cookie {
/**
- * TCP_NODELAY option
+ * Cookie name.
*/
- noDelay: boolean;
+ name: string;
/**
- * Expected to be unsigned integer.
+ * Cookie value.
*/
- keepAliveDelay?: number;
+ value: string;
/**
- * Expected to be unsigned integer.
+ * Cookie domain.
*/
- sendBufferSize?: number;
+ domain: string;
/**
- * Expected to be unsigned integer.
+ * Cookie path.
*/
- receiveBufferSize?: number;
- dnsQueryType?: DirectSocketDnsQueryType;
- }
- export interface DirectUDPSocketOptions {
- remoteAddr?: string;
+ path: string;
/**
- * Unsigned int 16.
+ * Cookie expiration date as the number of seconds since the UNIX epoch.
*/
- remotePort?: number;
- localAddr?: string;
+ expires: number;
/**
- * Unsigned int 16.
+ * Cookie size.
*/
- localPort?: number;
- dnsQueryType?: DirectSocketDnsQueryType;
+ size: number;
/**
- * Expected to be unsigned integer.
+ * True if cookie is http-only.
*/
- sendBufferSize?: number;
+ httpOnly: boolean;
/**
- * Expected to be unsigned integer.
+ * True if cookie is secure.
*/
- receiveBufferSize?: number;
- }
- export interface DirectUDPMessage {
- data: binary;
+ secure: boolean;
/**
- * Null for connected mode.
+ * True in case of session cookie.
*/
- remoteAddr?: string;
+ session: boolean;
/**
- * Null for connected mode.
-Expected to be unsigned integer.
+ * Cookie SameSite type.
*/
- remotePort?: number;
- }
- export type PrivateNetworkRequestPolicy = "Allow"|"BlockFromInsecureToMorePrivate"|"WarnFromInsecureToMorePrivate"|"PreflightBlock"|"PreflightWarn"|"PermissionBlock"|"PermissionWarn";
- export type IPAddressSpace = "Loopback"|"Local"|"Public"|"Unknown";
- export interface ConnectTiming {
+ sameSite?: CookieSameSite;
/**
- * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
-milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
-the same request (but not for redirected requests).
+ * Cookie Priority
*/
- requestTime: number;
- }
- export interface ClientSecurityState {
- initiatorIsSecureContext: boolean;
- initiatorIPAddressSpace: IPAddressSpace;
- privateNetworkRequestPolicy: PrivateNetworkRequestPolicy;
- }
- export type CrossOriginOpenerPolicyValue = "SameOrigin"|"SameOriginAllowPopups"|"RestrictProperties"|"UnsafeNone"|"SameOriginPlusCoep"|"RestrictPropertiesPlusCoep"|"NoopenerAllowPopups";
- export interface CrossOriginOpenerPolicyStatus {
- value: CrossOriginOpenerPolicyValue;
- reportOnlyValue: CrossOriginOpenerPolicyValue;
- reportingEndpoint?: string;
- reportOnlyReportingEndpoint?: string;
- }
- export type CrossOriginEmbedderPolicyValue = "None"|"Credentialless"|"RequireCorp";
- export interface CrossOriginEmbedderPolicyStatus {
- value: CrossOriginEmbedderPolicyValue;
- reportOnlyValue: CrossOriginEmbedderPolicyValue;
- reportingEndpoint?: string;
- reportOnlyReportingEndpoint?: string;
- }
- export type ContentSecurityPolicySource = "HTTP"|"Meta";
- export interface ContentSecurityPolicyStatus {
- effectiveDirectives: string;
- isEnforced: boolean;
- source: ContentSecurityPolicySource;
- }
- export interface SecurityIsolationStatus {
- coop?: CrossOriginOpenerPolicyStatus;
- coep?: CrossOriginEmbedderPolicyStatus;
- csp?: ContentSecurityPolicyStatus[];
- }
- /**
- * The status of a Reporting API report.
- */
- export type ReportStatus = "Queued"|"Pending"|"MarkedForRemoval"|"Success";
- export type ReportId = string;
- /**
- * An object representing a report generated by the Reporting API.
- */
- export interface ReportingApiReport {
- id: ReportId;
+ priority: CookiePriority;
/**
- * The URL of the document that triggered the report.
+ * True if cookie is SameParty.
*/
- initiatorUrl: string;
+ sameParty: boolean;
/**
- * The name of the endpoint group that should be used to deliver the report.
+ * Cookie source scheme type.
*/
- destination: string;
+ sourceScheme: CookieSourceScheme;
/**
- * The type of the report (specifies the set of data that is contained in the report body).
+ * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
+An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
+This is a temporary ability and it will be removed in the future.
*/
- type: string;
+ sourcePort: number;
/**
- * When the report was generated.
+ * Cookie partition key.
*/
- timestamp: Network.TimeSinceEpoch;
+ partitionKey?: CookiePartitionKey;
/**
- * How many uploads deep the related request was.
+ * True if cookie partition key is opaque.
*/
- depth: number;
+ partitionKeyOpaque?: boolean;
+ }
+ /**
+ * Types of reasons why a cookie may not be stored from a response.
+ */
+ export type SetCookieBlockedReason = "SecureOnly"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"SyntaxError"|"SchemeNotSupported"|"OverwriteSecure"|"InvalidDomain"|"InvalidPrefix"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"SamePartyConflictsWithOtherAttributes"|"NameValuePairExceedsMaxSize"|"DisallowedCharacter"|"NoCookieContent";
+ /**
+ * Types of reasons why a cookie may not be sent with a request.
+ */
+ export type CookieBlockedReason = "SecureOnly"|"NotOnPath"|"DomainMismatch"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"NameValuePairExceedsMaxSize"|"PortMismatch"|"SchemeMismatch"|"AnonymousContext";
+ /**
+ * Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
+ */
+ export type CookieExemptionReason = "None"|"UserSetting"|"TPCDMetadata"|"TPCDDeprecationTrial"|"TopLevelTPCDDeprecationTrial"|"TPCDHeuristics"|"EnterprisePolicy"|"StorageAccess"|"TopLevelStorageAccess"|"Scheme"|"SameSiteNoneCookiesInSandbox";
+ /**
+ * A cookie which was not stored from a response with the corresponding reason.
+ */
+ export interface BlockedSetCookieWithReason {
/**
- * The number of delivery attempts made so far, not including an active attempt.
+ * The reason(s) this cookie was blocked.
*/
- completedAttempts: number;
- body: { [key: string]: string };
- status: ReportStatus;
- }
- export interface ReportingApiEndpoint {
+ blockedReasons: SetCookieBlockedReason[];
/**
- * The URL of the endpoint to which reports may be delivered.
+ * The string representing this individual cookie as it would appear in the header.
+This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
*/
- url: string;
+ cookieLine: string;
/**
- * Name of the endpoint group.
+ * The cookie object which represents the cookie which was not stored. It is optional because
+sometimes complete cookie information is not available, such as in the case of parsing
+errors.
*/
- groupName: string;
+ cookie?: Cookie;
}
/**
- * An object providing the result of a network resource load.
+ * A cookie should have been blocked by 3PCD but is exempted and stored from a response with the
+corresponding reason. A cookie could only have at most one exemption reason.
*/
- export interface LoadNetworkResourcePageResult {
- success: boolean;
+ export interface ExemptedSetCookieWithReason {
/**
- * Optional values used for error reporting.
+ * The reason the cookie was exempted.
*/
- netError?: number;
- netErrorName?: string;
- httpStatusCode?: number;
+ exemptionReason: CookieExemptionReason;
/**
- * If successful, one of the following two fields holds the result.
+ * The string representing this individual cookie as it would appear in the header.
*/
- stream?: IO.StreamHandle;
+ cookieLine: string;
/**
- * Response headers.
+ * The cookie object representing the cookie.
*/
- headers?: Network.Headers;
+ cookie: Cookie;
}
/**
- * An options object that may be extended later to better support CORS,
-CORB and streaming.
+ * A cookie associated with the request which may or may not be sent with it.
+Includes the cookies itself and reasons for blocking or exemption.
*/
- export interface LoadNetworkResourceOptions {
- disableCache: boolean;
- includeCredentials: boolean;
+ export interface AssociatedCookie {
+ /**
+ * The cookie object representing the cookie which was not sent.
+ */
+ cookie: Cookie;
+ /**
+ * The reason(s) the cookie was blocked. If empty means the cookie is included.
+ */
+ blockedReasons: CookieBlockedReason[];
+ /**
+ * The reason the cookie should have been blocked by 3PCD but is exempted. A cookie could
+only have at most one exemption reason.
+ */
+ exemptionReason?: CookieExemptionReason;
}
-
/**
- * Fired when data chunk was received over the network.
+ * Cookie parameter object
*/
- export type dataReceivedPayload = {
+ export interface CookieParam {
/**
- * Request identifier.
+ * Cookie name.
*/
- requestId: RequestId;
+ name: string;
/**
- * Timestamp.
+ * Cookie value.
*/
- timestamp: MonotonicTime;
+ value: string;
/**
- * Data chunk length.
+ * The request-URI to associate with the setting of the cookie. This value can affect the
+default domain, path, source port, and source scheme values of the created cookie.
*/
- dataLength: number;
+ url?: string;
/**
- * Actual bytes received (might be less than dataLength for compressed encodings).
+ * Cookie domain.
*/
- encodedDataLength: number;
+ domain?: string;
/**
- * Data that was received.
+ * Cookie path.
*/
- data?: binary;
- }
- /**
- * Fired when EventSource message is received.
- */
- export type eventSourceMessageReceivedPayload = {
+ path?: string;
/**
- * Request identifier.
+ * True if cookie is secure.
*/
- requestId: RequestId;
+ secure?: boolean;
/**
- * Timestamp.
+ * True if cookie is http-only.
*/
- timestamp: MonotonicTime;
+ httpOnly?: boolean;
/**
- * Message type.
+ * Cookie SameSite type.
*/
- eventName: string;
+ sameSite?: CookieSameSite;
/**
- * Message identifier.
+ * Cookie expiration date, session cookie if not set
*/
- eventId: string;
+ expires?: TimeSinceEpoch;
/**
- * Message content.
+ * Cookie Priority.
*/
- data: string;
- }
- /**
- * Fired when HTTP request has failed to load.
- */
- export type loadingFailedPayload = {
+ priority?: CookiePriority;
/**
- * Request identifier.
+ * True if cookie is SameParty.
*/
- requestId: RequestId;
+ sameParty?: boolean;
/**
- * Timestamp.
+ * Cookie source scheme type.
*/
- timestamp: MonotonicTime;
+ sourceScheme?: CookieSourceScheme;
/**
- * Resource type.
+ * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
+An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
+This is a temporary ability and it will be removed in the future.
*/
- type: ResourceType;
+ sourcePort?: number;
/**
- * Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h
+ * Cookie partition key. If not set, the cookie will be set as not partitioned.
*/
- errorText: string;
+ partitionKey?: CookiePartitionKey;
+ }
+ /**
+ * Authorization challenge for HTTP status code 401 or 407.
+ */
+ export interface AuthChallenge {
/**
- * True if loading was canceled.
+ * Source of the authentication challenge.
*/
- canceled?: boolean;
+ source?: "Server"|"Proxy";
/**
- * The reason why loading was blocked, if any.
+ * Origin of the challenger.
*/
- blockedReason?: BlockedReason;
+ origin: string;
/**
- * The reason why loading was blocked by CORS, if any.
+ * The authentication scheme used, such as basic or digest
*/
- corsErrorStatus?: CorsErrorStatus;
+ scheme: string;
+ /**
+ * The realm of the challenge. May be empty.
+ */
+ realm: string;
}
/**
- * Fired when HTTP request has finished loading.
+ * Response to an AuthChallenge.
*/
- export type loadingFinishedPayload = {
+ export interface AuthChallengeResponse {
/**
- * Request identifier.
+ * The decision on what to do in response to the authorization challenge. Default means
+deferring to the default behavior of the net stack, which will likely either the Cancel
+authentication or display a popup dialog box.
*/
- requestId: RequestId;
+ response: "Default"|"CancelAuth"|"ProvideCredentials";
/**
- * Timestamp.
+ * The username to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- timestamp: MonotonicTime;
+ username?: string;
/**
- * Total number of bytes received for this request.
+ * The password to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- encodedDataLength: number;
+ password?: string;
}
/**
- * Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
-mocked.
-Deprecated, use Fetch.requestPaused instead.
+ * Stages of the interception to begin intercepting. Request will intercept before the request is
+sent. Response will intercept after the response is received.
*/
- export type requestInterceptedPayload = {
+ export type InterceptionStage = "Request"|"HeadersReceived";
+ /**
+ * Request pattern for interception.
+ */
+ export interface RequestPattern {
/**
- * Each request the page makes will have a unique id, however if any redirects are encountered
-while processing that fetch, they will be reported with the same id as the original fetch.
-Likewise if HTTP authentication is needed then the same fetch id will be used.
+ * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
+backslash. Omitting is equivalent to `"*"`.
*/
- interceptionId: InterceptionId;
- request: Request;
+ urlPattern?: string;
/**
- * The id of the frame that initiated the request.
+ * If set, only requests for matching resource types will be intercepted.
*/
- frameId: Page.FrameId;
+ resourceType?: ResourceType;
/**
- * How the requested resource will be used.
+ * Stage at which to begin intercepting requests. Default is Request.
*/
- resourceType: ResourceType;
+ interceptionStage?: InterceptionStage;
+ }
+ /**
+ * Information about a signed exchange signature.
+https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
+ */
+ export interface SignedExchangeSignature {
/**
- * Whether this is a navigation request, which can abort the navigation completely.
+ * Signed exchange signature label.
*/
- isNavigationRequest: boolean;
+ label: string;
/**
- * Set if the request is a navigation that will result in a download.
-Only present after response is received from the server (i.e. HeadersReceived stage).
+ * The hex string of signed exchange signature.
*/
- isDownload?: boolean;
+ signature: string;
/**
- * Redirect location, only sent if a redirect was intercepted.
+ * Signed exchange signature integrity.
*/
- redirectUrl?: string;
+ integrity: string;
/**
- * Details of the Authorization Challenge encountered. If this is set then
-continueInterceptedRequest must contain an authChallengeResponse.
+ * Signed exchange signature cert Url.
*/
- authChallenge?: AuthChallenge;
+ certUrl?: string;
/**
- * Response error if intercepted at response stage or if redirect occurred while intercepting
-request.
+ * The hex string of signed exchange signature cert sha256.
*/
- responseErrorReason?: ErrorReason;
+ certSha256?: string;
/**
- * Response code if intercepted at response stage or if redirect occurred while intercepting
-request or auth retry occurred.
+ * Signed exchange signature validity Url.
*/
- responseStatusCode?: number;
+ validityUrl: string;
/**
- * Response headers if intercepted at the response stage or if redirect occurred while
-intercepting request or auth retry occurred.
+ * Signed exchange signature date.
*/
- responseHeaders?: Headers;
+ date: number;
/**
- * If the intercepted request had a corresponding requestWillBeSent event fired for it, then
-this requestId will be the same as the requestId present in the requestWillBeSent event.
+ * Signed exchange signature expires.
*/
- requestId?: RequestId;
- }
- /**
- * Fired if request ended up loading from cache.
- */
- export type requestServedFromCachePayload = {
+ expires: number;
/**
- * Request identifier.
+ * The encoded certificates.
*/
- requestId: RequestId;
+ certificates?: string[];
}
/**
- * Fired when page is about to send HTTP request.
+ * Information about a signed exchange header.
+https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
*/
- export type requestWillBeSentPayload = {
+ export interface SignedExchangeHeader {
/**
- * Request identifier.
+ * Signed exchange request URL.
*/
- requestId: RequestId;
+ requestUrl: string;
/**
- * Loader identifier. Empty string if the request is fetched from worker.
+ * Signed exchange response code.
*/
- loaderId: LoaderId;
+ responseCode: number;
/**
- * URL of the document this request is loaded for.
+ * Signed exchange response headers.
*/
- documentURL: string;
+ responseHeaders: Headers;
/**
- * Request data.
+ * Signed exchange response signature.
*/
- request: Request;
+ signatures: SignedExchangeSignature[];
/**
- * Timestamp.
+ * Signed exchange header integrity hash in the form of `sha256-<base64-hash-value>`.
*/
- timestamp: MonotonicTime;
+ headerIntegrity: string;
+ }
+ /**
+ * Field type for a signed exchange related error.
+ */
+ export type SignedExchangeErrorField = "signatureSig"|"signatureIntegrity"|"signatureCertUrl"|"signatureCertSha256"|"signatureValidityUrl"|"signatureTimestamps";
+ /**
+ * Information about a signed exchange response.
+ */
+ export interface SignedExchangeError {
/**
- * Timestamp.
+ * Error message.
*/
- wallTime: TimeSinceEpoch;
+ message: string;
/**
- * Request initiator.
+ * The index of the signature which caused the error.
*/
- initiator: Initiator;
+ signatureIndex?: number;
/**
- * In the case that redirectResponse is populated, this flag indicates whether
-requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
-for the request which was just redirected.
+ * The field which caused the error.
*/
- redirectHasExtraInfo: boolean;
+ errorField?: SignedExchangeErrorField;
+ }
+ /**
+ * Information about a signed exchange response.
+ */
+ export interface SignedExchangeInfo {
/**
- * Redirect response data.
+ * The outer response of signed HTTP exchange which was received from network.
*/
- redirectResponse?: Response;
+ outerResponse: Response;
/**
- * Type of this resource.
+ * Whether network response for the signed exchange was accompanied by
+extra headers.
*/
- type?: ResourceType;
+ hasExtraInfo: boolean;
/**
- * Frame identifier.
+ * Information about the signed exchange header.
*/
- frameId?: Page.FrameId;
+ header?: SignedExchangeHeader;
/**
- * Whether the request is initiated by a user gesture. Defaults to false.
+ * Security details for the signed exchange header.
*/
- hasUserGesture?: boolean;
+ securityDetails?: SecurityDetails;
+ /**
+ * Errors occurred while handling the signed exchange.
+ */
+ errors?: SignedExchangeError[];
}
/**
- * Fired when resource loading priority is changed
+ * List of content encodings supported by the backend.
*/
- export type resourceChangedPriorityPayload = {
+ export type ContentEncoding = "deflate"|"gzip"|"br"|"zstd";
+ export type DirectSocketDnsQueryType = "ipv4"|"ipv6";
+ export interface DirectTCPSocketOptions {
/**
- * Request identifier.
+ * TCP_NODELAY option
*/
- requestId: RequestId;
+ noDelay: boolean;
/**
- * New priority
+ * Expected to be unsigned integer.
*/
- newPriority: ResourcePriority;
+ keepAliveDelay?: number;
/**
- * Timestamp.
+ * Expected to be unsigned integer.
*/
- timestamp: MonotonicTime;
+ sendBufferSize?: number;
+ /**
+ * Expected to be unsigned integer.
+ */
+ receiveBufferSize?: number;
+ dnsQueryType?: DirectSocketDnsQueryType;
}
- /**
- * Fired when a signed exchange was received over the network
- */
- export type signedExchangeReceivedPayload = {
+ export interface DirectUDPSocketOptions {
+ remoteAddr?: string;
/**
- * Request identifier.
+ * Unsigned int 16.
*/
- requestId: RequestId;
+ remotePort?: number;
+ localAddr?: string;
/**
- * Information about the signed exchange response.
+ * Unsigned int 16.
*/
- info: SignedExchangeInfo;
+ localPort?: number;
+ dnsQueryType?: DirectSocketDnsQueryType;
+ /**
+ * Expected to be unsigned integer.
+ */
+ sendBufferSize?: number;
+ /**
+ * Expected to be unsigned integer.
+ */
+ receiveBufferSize?: number;
}
- /**
- * Fired when HTTP response is available.
- */
- export type responseReceivedPayload = {
+ export interface DirectUDPMessage {
+ data: binary;
/**
- * Request identifier.
+ * Null for connected mode.
*/
- requestId: RequestId;
+ remoteAddr?: string;
/**
- * Loader identifier. Empty string if the request is fetched from worker.
+ * Null for connected mode.
+Expected to be unsigned integer.
*/
- loaderId: LoaderId;
+ remotePort?: number;
+ }
+ export type PrivateNetworkRequestPolicy = "Allow"|"BlockFromInsecureToMorePrivate"|"WarnFromInsecureToMorePrivate"|"PreflightBlock"|"PreflightWarn"|"PermissionBlock"|"PermissionWarn";
+ export type IPAddressSpace = "Loopback"|"Local"|"Public"|"Unknown";
+ export interface ConnectTiming {
/**
- * Timestamp.
+ * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
+milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
+the same request (but not for redirected requests).
*/
- timestamp: MonotonicTime;
+ requestTime: number;
+ }
+ export interface ClientSecurityState {
+ initiatorIsSecureContext: boolean;
+ initiatorIPAddressSpace: IPAddressSpace;
+ privateNetworkRequestPolicy: PrivateNetworkRequestPolicy;
+ }
+ export type CrossOriginOpenerPolicyValue = "SameOrigin"|"SameOriginAllowPopups"|"RestrictProperties"|"UnsafeNone"|"SameOriginPlusCoep"|"RestrictPropertiesPlusCoep"|"NoopenerAllowPopups";
+ export interface CrossOriginOpenerPolicyStatus {
+ value: CrossOriginOpenerPolicyValue;
+ reportOnlyValue: CrossOriginOpenerPolicyValue;
+ reportingEndpoint?: string;
+ reportOnlyReportingEndpoint?: string;
+ }
+ export type CrossOriginEmbedderPolicyValue = "None"|"Credentialless"|"RequireCorp";
+ export interface CrossOriginEmbedderPolicyStatus {
+ value: CrossOriginEmbedderPolicyValue;
+ reportOnlyValue: CrossOriginEmbedderPolicyValue;
+ reportingEndpoint?: string;
+ reportOnlyReportingEndpoint?: string;
+ }
+ export type ContentSecurityPolicySource = "HTTP"|"Meta";
+ export interface ContentSecurityPolicyStatus {
+ effectiveDirectives: string;
+ isEnforced: boolean;
+ source: ContentSecurityPolicySource;
+ }
+ export interface SecurityIsolationStatus {
+ coop?: CrossOriginOpenerPolicyStatus;
+ coep?: CrossOriginEmbedderPolicyStatus;
+ csp?: ContentSecurityPolicyStatus[];
+ }
+ /**
+ * The status of a Reporting API report.
+ */
+ export type ReportStatus = "Queued"|"Pending"|"MarkedForRemoval"|"Success";
+ export type ReportId = string;
+ /**
+ * An object representing a report generated by the Reporting API.
+ */
+ export interface ReportingApiReport {
+ id: ReportId;
/**
- * Resource type.
+ * The URL of the document that triggered the report.
*/
- type: ResourceType;
+ initiatorUrl: string;
/**
- * Response data.
+ * The name of the endpoint group that should be used to deliver the report.
*/
- response: Response;
+ destination: string;
/**
- * Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
-or were emitted for this request.
+ * The type of the report (specifies the set of data that is contained in the report body).
*/
- hasExtraInfo: boolean;
+ type: string;
/**
- * Frame identifier.
+ * When the report was generated.
*/
- frameId?: Page.FrameId;
+ timestamp: Network.TimeSinceEpoch;
+ /**
+ * How many uploads deep the related request was.
+ */
+ depth: number;
+ /**
+ * The number of delivery attempts made so far, not including an active attempt.
+ */
+ completedAttempts: number;
+ body: { [key: string]: string };
+ status: ReportStatus;
}
- /**
- * Fired when WebSocket is closed.
- */
- export type webSocketClosedPayload = {
+ export interface ReportingApiEndpoint {
/**
- * Request identifier.
+ * The URL of the endpoint to which reports may be delivered.
*/
- requestId: RequestId;
+ url: string;
/**
- * Timestamp.
+ * Name of the endpoint group.
*/
- timestamp: MonotonicTime;
+ groupName: string;
}
/**
- * Fired upon WebSocket creation.
+ * An object providing the result of a network resource load.
*/
- export type webSocketCreatedPayload = {
+ export interface LoadNetworkResourcePageResult {
+ success: boolean;
/**
- * Request identifier.
+ * Optional values used for error reporting.
*/
- requestId: RequestId;
+ netError?: number;
+ netErrorName?: string;
+ httpStatusCode?: number;
/**
- * WebSocket request URL.
+ * If successful, one of the following two fields holds the result.
*/
- url: string;
+ stream?: IO.StreamHandle;
/**
- * Request initiator.
+ * Response headers.
*/
- initiator?: Initiator;
+ headers?: Network.Headers;
}
/**
- * Fired when WebSocket message error occurs.
+ * An options object that may be extended later to better support CORS,
+CORB and streaming.
*/
- export type webSocketFrameErrorPayload = {
+ export interface LoadNetworkResourceOptions {
+ disableCache: boolean;
+ includeCredentials: boolean;
+ }
+
+ /**
+ * Fired when data chunk was received over the network.
+ */
+ export type dataReceivedPayload = {
/**
* Request identifier.
*/
@@ -10220,14 +11046,22 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket error message.
+ * Data chunk length.
*/
- errorMessage: string;
+ dataLength: number;
+ /**
+ * Actual bytes received (might be less than dataLength for compressed encodings).
+ */
+ encodedDataLength: number;
+ /**
+ * Data that was received.
+ */
+ data?: binary;
}
/**
- * Fired when WebSocket message is received.
+ * Fired when EventSource message is received.
*/
- export type webSocketFrameReceivedPayload = {
+ export type eventSourceMessageReceivedPayload = {
/**
* Request identifier.
*/
@@ -10237,14 +11071,22 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Message type.
*/
- response: WebSocketFrame;
+ eventName: string;
+ /**
+ * Message identifier.
+ */
+ eventId: string;
+ /**
+ * Message content.
+ */
+ data: string;
}
/**
- * Fired when WebSocket message is sent.
+ * Fired when HTTP request has failed to load.
*/
- export type webSocketFrameSentPayload = {
+ export type loadingFailedPayload = {
/**
* Request identifier.
*/
@@ -10254,14 +11096,30 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Resource type.
*/
- response: WebSocketFrame;
+ type: ResourceType;
+ /**
+ * Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h
+ */
+ errorText: string;
+ /**
+ * True if loading was canceled.
+ */
+ canceled?: boolean;
+ /**
+ * The reason why loading was blocked, if any.
+ */
+ blockedReason?: BlockedReason;
+ /**
+ * The reason why loading was blocked by CORS, if any.
+ */
+ corsErrorStatus?: CorsErrorStatus;
}
/**
- * Fired when WebSocket handshake response becomes available.
+ * Fired when HTTP request has finished loading.
*/
- export type webSocketHandshakeResponseReceivedPayload = {
+ export type loadingFinishedPayload = {
/**
* Request identifier.
*/
@@ -10271,111 +11129,397 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Total number of bytes received for this request.
*/
- response: WebSocketResponse;
+ encodedDataLength: number;
}
/**
- * Fired when WebSocket is about to initiate handshake.
+ * Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
+mocked.
+Deprecated, use Fetch.requestPaused instead.
*/
- export type webSocketWillSendHandshakeRequestPayload = {
+ export type requestInterceptedPayload = {
+ /**
+ * Each request the page makes will have a unique id, however if any redirects are encountered
+while processing that fetch, they will be reported with the same id as the original fetch.
+Likewise if HTTP authentication is needed then the same fetch id will be used.
+ */
+ interceptionId: InterceptionId;
+ request: Request;
+ /**
+ * The id of the frame that initiated the request.
+ */
+ frameId: Page.FrameId;
+ /**
+ * How the requested resource will be used.
+ */
+ resourceType: ResourceType;
+ /**
+ * Whether this is a navigation request, which can abort the navigation completely.
+ */
+ isNavigationRequest: boolean;
+ /**
+ * Set if the request is a navigation that will result in a download.
+Only present after response is received from the server (i.e. HeadersReceived stage).
+ */
+ isDownload?: boolean;
+ /**
+ * Redirect location, only sent if a redirect was intercepted.
+ */
+ redirectUrl?: string;
+ /**
+ * Details of the Authorization Challenge encountered. If this is set then
+continueInterceptedRequest must contain an authChallengeResponse.
+ */
+ authChallenge?: AuthChallenge;
+ /**
+ * Response error if intercepted at response stage or if redirect occurred while intercepting
+request.
+ */
+ responseErrorReason?: ErrorReason;
+ /**
+ * Response code if intercepted at response stage or if redirect occurred while intercepting
+request or auth retry occurred.
+ */
+ responseStatusCode?: number;
+ /**
+ * Response headers if intercepted at the response stage or if redirect occurred while
+intercepting request or auth retry occurred.
+ */
+ responseHeaders?: Headers;
+ /**
+ * If the intercepted request had a corresponding requestWillBeSent event fired for it, then
+this requestId will be the same as the requestId present in the requestWillBeSent event.
+ */
+ requestId?: RequestId;
+ }
+ /**
+ * Fired if request ended up loading from cache.
+ */
+ export type requestServedFromCachePayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ }
+ /**
+ * Fired when page is about to send HTTP request.
+ */
+ export type requestWillBeSentPayload = {
/**
* Request identifier.
*/
requestId: RequestId;
+ /**
+ * Loader identifier. Empty string if the request is fetched from worker.
+ */
+ loaderId: LoaderId;
+ /**
+ * URL of the document this request is loaded for.
+ */
+ documentURL: string;
+ /**
+ * Request data.
+ */
+ request: Request;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
/**
- * UTC Timestamp.
+ * Timestamp.
*/
wallTime: TimeSinceEpoch;
/**
- * WebSocket request data.
+ * Request initiator.
*/
- request: WebSocketRequest;
+ initiator: Initiator;
+ /**
+ * In the case that redirectResponse is populated, this flag indicates whether
+requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
+for the request which was just redirected.
+ */
+ redirectHasExtraInfo: boolean;
+ /**
+ * Redirect response data.
+ */
+ redirectResponse?: Response;
+ /**
+ * Type of this resource.
+ */
+ type?: ResourceType;
+ /**
+ * Frame identifier.
+ */
+ frameId?: Page.FrameId;
+ /**
+ * Whether the request is initiated by a user gesture. Defaults to false.
+ */
+ hasUserGesture?: boolean;
}
/**
- * Fired upon WebTransport creation.
+ * Fired when resource loading priority is changed
*/
- export type webTransportCreatedPayload = {
+ export type resourceChangedPriorityPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
/**
- * WebTransport request URL.
+ * New priority
*/
- url: string;
+ newPriority: ResourcePriority;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
+ }
+ /**
+ * Fired when a signed exchange was received over the network
+ */
+ export type signedExchangeReceivedPayload = {
/**
- * Request initiator.
+ * Request identifier.
*/
- initiator?: Initiator;
+ requestId: RequestId;
+ /**
+ * Information about the signed exchange response.
+ */
+ info: SignedExchangeInfo;
}
/**
- * Fired when WebTransport handshake is finished.
+ * Fired when HTTP response is available.
*/
- export type webTransportConnectionEstablishedPayload = {
+ export type responseReceivedPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
+ /**
+ * Loader identifier. Empty string if the request is fetched from worker.
+ */
+ loaderId: LoaderId;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
+ /**
+ * Resource type.
+ */
+ type: ResourceType;
+ /**
+ * Response data.
+ */
+ response: Response;
+ /**
+ * Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
+or were emitted for this request.
+ */
+ hasExtraInfo: boolean;
+ /**
+ * Frame identifier.
+ */
+ frameId?: Page.FrameId;
}
/**
- * Fired when WebTransport is disposed.
+ * Fired when WebSocket is closed.
*/
- export type webTransportClosedPayload = {
+ export type webSocketClosedPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
}
/**
- * Fired upon direct_socket.TCPSocket creation.
+ * Fired upon WebSocket creation.
*/
- export type directTCPSocketCreatedPayload = {
- identifier: RequestId;
- remoteAddr: string;
+ export type webSocketCreatedPayload = {
/**
- * Unsigned int 16.
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * WebSocket request URL.
+ */
+ url: string;
+ /**
+ * Request initiator.
*/
- remotePort: number;
- options: DirectTCPSocketOptions;
- timestamp: MonotonicTime;
initiator?: Initiator;
}
/**
- * Fired when direct_socket.TCPSocket connection is opened.
+ * Fired when WebSocket message error occurs.
*/
- export type directTCPSocketOpenedPayload = {
- identifier: RequestId;
- remoteAddr: string;
+ export type webSocketFrameErrorPayload = {
/**
- * Expected to be unsigned integer.
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
*/
- remotePort: number;
timestamp: MonotonicTime;
- localAddr?: string;
/**
- * Expected to be unsigned integer.
+ * WebSocket error message.
*/
- localPort?: number;
+ errorMessage: string;
}
/**
- * Fired when direct_socket.TCPSocket is aborted.
+ * Fired when WebSocket message is received.
+ */
+ export type webSocketFrameReceivedPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketFrame;
+ }
+ /**
+ * Fired when WebSocket message is sent.
+ */
+ export type webSocketFrameSentPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketFrame;
+ }
+ /**
+ * Fired when WebSocket handshake response becomes available.
+ */
+ export type webSocketHandshakeResponseReceivedPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketResponse;
+ }
+ /**
+ * Fired when WebSocket is about to initiate handshake.
+ */
+ export type webSocketWillSendHandshakeRequestPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * UTC Timestamp.
+ */
+ wallTime: TimeSinceEpoch;
+ /**
+ * WebSocket request data.
+ */
+ request: WebSocketRequest;
+ }
+ /**
+ * Fired upon WebTransport creation.
+ */
+ export type webTransportCreatedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * WebTransport request URL.
+ */
+ url: string;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * Request initiator.
+ */
+ initiator?: Initiator;
+ }
+ /**
+ * Fired when WebTransport handshake is finished.
+ */
+ export type webTransportConnectionEstablishedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ }
+ /**
+ * Fired when WebTransport is disposed.
+ */
+ export type webTransportClosedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ }
+ /**
+ * Fired upon direct_socket.TCPSocket creation.
+ */
+ export type directTCPSocketCreatedPayload = {
+ identifier: RequestId;
+ remoteAddr: string;
+ /**
+ * Unsigned int 16.
+ */
+ remotePort: number;
+ options: DirectTCPSocketOptions;
+ timestamp: MonotonicTime;
+ initiator?: Initiator;
+ }
+ /**
+ * Fired when direct_socket.TCPSocket connection is opened.
+ */
+ export type directTCPSocketOpenedPayload = {
+ identifier: RequestId;
+ remoteAddr: string;
+ /**
+ * Expected to be unsigned integer.
+ */
+ remotePort: number;
+ timestamp: MonotonicTime;
+ localAddr?: string;
+ /**
+ * Expected to be unsigned integer.
+ */
+ localPort?: number;
+ }
+ /**
+ * Fired when direct_socket.TCPSocket is aborted.
*/
export type directTCPSocketAbortedPayload = {
identifier: RequestId;
@@ -10688,6 +11832,18 @@ And after 'enableReportingApi' for all existing reports.
endpoints: ReportingApiEndpoint[];
}
+ /**
+ * Returns enum representing if IP Proxy of requests is available
+or reason it is not active.
+ */
+ export type getIPProtectionProxyStatusParameters = {
+ }
+ export type getIPProtectionProxyStatusReturnValue = {
+ /**
+ * Whether IP proxy is available
+ */
+ status: IpProxyStatus;
+ }
/**
* Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.
*/
@@ -10894,6 +12050,12 @@ all partition key attributes match the cookie partition key attribute.
* Whether DirectSocket chunk send/receive events should be reported.
*/
reportDirectSocketTraffic?: boolean;
+ /**
+ * Enable storing response bodies outside of renderer, so that these survive
+a cross-process navigation. Requires maxTotalBufferSize to be set.
+Currently defaults to false.
+ */
+ enableDurableMessages?: boolean;
}
export type enableReturnValue = {
}
@@ -11879,6 +13041,9 @@ objectId must be specified.
}
/**
* Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
+Issue: the method does not handle device pixel ratio (DPR) correctly.
+The coordinates currently have to be adjusted by the client
+if DPR is not 1 (see crbug.com/437807128).
*/
export type highlightRectParameters = {
/**
@@ -12124,53 +13289,223 @@ Backend then generates 'inspectNodeRequested' event upon element selection.
}
/**
- * Actions and events related to the inspected page belong to the page domain.
+ * This domain allows interacting with the browser to control PWAs.
*/
- export module Page {
+ export module PWA {
/**
- * Unique frame identifier.
+ * The following types are the replica of
+https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
*/
- export type FrameId = string;
+ export interface FileHandlerAccept {
+ /**
+ * New name of the mimetype according to
+https://www.iana.org/assignments/media-types/media-types.xhtml
+ */
+ mediaType: string;
+ fileExtensions: string[];
+ }
+ export interface FileHandler {
+ action: string;
+ accepts: FileHandlerAccept[];
+ displayName: string;
+ }
/**
- * Indicates whether a frame has been identified as an ad.
+ * If user prefers opening the app in browser or an app window.
*/
- export type AdFrameType = "none"|"child"|"root";
- export type AdFrameExplanation = "ParentIsAd"|"CreatedByAdScript"|"MatchedBlockingRule";
+ export type DisplayMode = "standalone"|"browser";
+
+
/**
- * Indicates whether a frame has been identified as an ad and why.
+ * Returns the following OS state for the given manifest id.
*/
- export interface AdFrameStatus {
- adFrameType: AdFrameType;
- explanations?: AdFrameExplanation[];
+ export type getOsAppStateParameters = {
+ /**
+ * The id from the webapp's manifest file, commonly it's the url of the
+site installing the webapp. See
+https://web.dev/learn/pwa/web-app-manifest.
+ */
+ manifestId: string;
+ }
+ export type getOsAppStateReturnValue = {
+ badgeCount: number;
+ fileHandlers: FileHandler[];
}
/**
- * Identifies the script which caused a script or frame to be labelled as an
-ad.
+ * Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
+
+IWA-specific install description:
+manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
+
+File installation mode:
+The installUrlOrBundleUrl can be either file:// or http(s):// pointing
+to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to
+The .swbn file's signing key.
+
+Dev proxy installation mode:
+installUrlOrBundleUrl must be http(s):// that serves dev mode IWA.
+web_package::SignedWebBundleId must be of type dev proxy.
+
+The advantage of dev proxy mode is that all changes to IWA
+automatically will be reflected in the running app without
+reinstallation.
+
+To generate bundle id for proxy mode:
+1. Generate 32 random bytes.
+2. Add a specific suffix 0x00 at the end.
+3. Encode the entire sequence using Base32 without padding.
+
+If Chrome is not in IWA dev
+mode, the installation will fail, regardless of the state of the allowlist.
*/
- export interface AdScriptId {
- /**
- * Script Id of the script which caused a script or frame to be labelled as
-an ad.
- */
- scriptId: Runtime.ScriptId;
+ export type installParameters = {
+ manifestId: string;
/**
- * Id of scriptId's debugger.
+ * The location of the app or bundle overriding the one derived from the
+manifestId.
*/
- debuggerId: Runtime.UniqueDebuggerId;
+ installUrlOrBundleUrl?: string;
+ }
+ export type installReturnValue = {
}
/**
- * Encapsulates the script ancestry and the root script filterlist rule that
-caused the frame to be labelled as an ad. Only created when `ancestryChain`
-is not empty.
+ * Uninstalls the given manifest_id and closes any opened app windows.
*/
- export interface AdScriptAncestry {
- /**
- * A chain of `AdScriptId`s representing the ancestry of an ad script that
-led to the creation of a frame. The chain is ordered from the script
-itself (lower level) up to its root ancestor that was flagged by
-filterlist.
- */
- ancestryChain: AdScriptId[];
+ export type uninstallParameters = {
+ manifestId: string;
+ }
+ export type uninstallReturnValue = {
+ }
+ /**
+ * Launches the installed web app, or an url in the same web app instead of the
+default start url if it is provided. Returns a page Target.TargetID which
+can be used to attach to via Target.attachToTarget or similar APIs.
+ */
+ export type launchParameters = {
+ manifestId: string;
+ url?: string;
+ }
+ export type launchReturnValue = {
+ /**
+ * ID of the tab target created as a result.
+ */
+ targetId: Target.TargetID;
+ }
+ /**
+ * Opens one or more local files from an installed web app identified by its
+manifestId. The web app needs to have file handlers registered to process
+the files. The API returns one or more page Target.TargetIDs which can be
+used to attach to via Target.attachToTarget or similar APIs.
+If some files in the parameters cannot be handled by the web app, they will
+be ignored. If none of the files can be handled, this API returns an error.
+If no files are provided as the parameter, this API also returns an error.
+
+According to the definition of the file handlers in the manifest file, one
+Target.TargetID may represent a page handling one or more files. The order
+of the returned Target.TargetIDs is not guaranteed.
+
+TODO(crbug.com/339454034): Check the existences of the input files.
+ */
+ export type launchFilesInAppParameters = {
+ manifestId: string;
+ files: string[];
+ }
+ export type launchFilesInAppReturnValue = {
+ /**
+ * IDs of the tab targets created as the result.
+ */
+ targetIds: Target.TargetID[];
+ }
+ /**
+ * Opens the current page in its web app identified by the manifest id, needs
+to be called on a page target. This function returns immediately without
+waiting for the app to finish loading.
+ */
+ export type openCurrentPageInAppParameters = {
+ manifestId: string;
+ }
+ export type openCurrentPageInAppReturnValue = {
+ }
+ /**
+ * Changes user settings of the web app identified by its manifestId. If the
+app was not installed, this command returns an error. Unset parameters will
+be ignored; unrecognized values will cause an error.
+
+Unlike the ones defined in the manifest files of the web apps, these
+settings are provided by the browser and controlled by the users, they
+impact the way the browser handling the web apps.
+
+See the comment of each parameter.
+ */
+ export type changeAppUserSettingsParameters = {
+ manifestId: string;
+ /**
+ * If user allows the links clicked on by the user in the app's scope, or
+extended scope if the manifest has scope extensions and the flags
+`DesktopPWAsLinkCapturingWithScopeExtensions` and
+`WebAppEnableScopeExtensions` are enabled.
+
+Note, the API does not support resetting the linkCapturing to the
+initial value, uninstalling and installing the web app again will reset
+it.
+
+TODO(crbug.com/339453269): Setting this value on ChromeOS is not
+supported yet.
+ */
+ linkCapturing?: boolean;
+ displayMode?: DisplayMode;
+ }
+ export type changeAppUserSettingsReturnValue = {
+ }
+ }
+
+ /**
+ * Actions and events related to the inspected page belong to the page domain.
+ */
+ export module Page {
+ /**
+ * Unique frame identifier.
+ */
+ export type FrameId = string;
+ /**
+ * Indicates whether a frame has been identified as an ad.
+ */
+ export type AdFrameType = "none"|"child"|"root";
+ export type AdFrameExplanation = "ParentIsAd"|"CreatedByAdScript"|"MatchedBlockingRule";
+ /**
+ * Indicates whether a frame has been identified as an ad and why.
+ */
+ export interface AdFrameStatus {
+ adFrameType: AdFrameType;
+ explanations?: AdFrameExplanation[];
+ }
+ /**
+ * Identifies the script which caused a script or frame to be labelled as an
+ad.
+ */
+ export interface AdScriptId {
+ /**
+ * Script Id of the script which caused a script or frame to be labelled as
+an ad.
+ */
+ scriptId: Runtime.ScriptId;
+ /**
+ * Id of scriptId's debugger.
+ */
+ debuggerId: Runtime.UniqueDebuggerId;
+ }
+ /**
+ * Encapsulates the script ancestry and the root script filterlist rule that
+caused the frame to be labelled as an ad. Only created when `ancestryChain`
+is not empty.
+ */
+ export interface AdScriptAncestry {
+ /**
+ * A chain of `AdScriptId`s representing the ancestry of an ad script that
+led to the creation of a frame. The chain is ordered from the script
+itself (lower level) up to its root ancestor that was flagged by
+filterlist.
+ */
+ ancestryChain: AdScriptId[];
/**
* The filterlist rule that caused the root (last) script in
`ancestryChain` to be ad-tagged. Only populated if the rule is
@@ -12192,7 +13527,7 @@ available.
in services/network/public/cpp/permissions_policy/permissions_policy_features.json5.
LINT.IfChange(PermissionsPolicyFeature)
*/
- export type PermissionsPolicyFeature = "accelerometer"|"all-screens-capture"|"ambient-light-sensor"|"aria-notify"|"attribution-reporting"|"autoplay"|"bluetooth"|"browsing-topics"|"camera"|"captured-surface-control"|"ch-dpr"|"ch-device-memory"|"ch-downlink"|"ch-ect"|"ch-prefers-color-scheme"|"ch-prefers-reduced-motion"|"ch-prefers-reduced-transparency"|"ch-rtt"|"ch-save-data"|"ch-ua"|"ch-ua-arch"|"ch-ua-bitness"|"ch-ua-high-entropy-values"|"ch-ua-platform"|"ch-ua-model"|"ch-ua-mobile"|"ch-ua-form-factors"|"ch-ua-full-version"|"ch-ua-full-version-list"|"ch-ua-platform-version"|"ch-ua-wow64"|"ch-viewport-height"|"ch-viewport-width"|"ch-width"|"clipboard-read"|"clipboard-write"|"compute-pressure"|"controlled-frame"|"cross-origin-isolated"|"deferred-fetch"|"deferred-fetch-minimal"|"device-attributes"|"digital-credentials-get"|"direct-sockets"|"direct-sockets-private"|"display-capture"|"document-domain"|"encrypted-media"|"execution-while-out-of-viewport"|"execution-while-not-rendered"|"fenced-unpartitioned-storage-read"|"focus-without-user-activation"|"fullscreen"|"frobulate"|"gamepad"|"geolocation"|"gyroscope"|"hid"|"identity-credentials-get"|"idle-detection"|"interest-cohort"|"join-ad-interest-group"|"keyboard-map"|"language-detector"|"language-model"|"local-fonts"|"local-network-access"|"magnetometer"|"media-playback-while-not-visible"|"microphone"|"midi"|"on-device-speech-recognition"|"otp-credentials"|"payment"|"picture-in-picture"|"popins"|"private-aggregation"|"private-state-token-issuance"|"private-state-token-redemption"|"publickey-credentials-create"|"publickey-credentials-get"|"record-ad-auction-events"|"rewriter"|"run-ad-auction"|"screen-wake-lock"|"serial"|"shared-autofill"|"shared-storage"|"shared-storage-select-url"|"smart-card"|"speaker-selection"|"storage-access"|"sub-apps"|"summarizer"|"sync-xhr"|"translator"|"unload"|"usb"|"usb-unrestricted"|"vertical-scroll"|"web-app-installation"|"web-printing"|"web-share"|"window-management"|"writer"|"xr-spatial-tracking";
+ export type PermissionsPolicyFeature = "accelerometer"|"all-screens-capture"|"ambient-light-sensor"|"aria-notify"|"attribution-reporting"|"autoplay"|"bluetooth"|"browsing-topics"|"camera"|"captured-surface-control"|"ch-dpr"|"ch-device-memory"|"ch-downlink"|"ch-ect"|"ch-prefers-color-scheme"|"ch-prefers-reduced-motion"|"ch-prefers-reduced-transparency"|"ch-rtt"|"ch-save-data"|"ch-ua"|"ch-ua-arch"|"ch-ua-bitness"|"ch-ua-high-entropy-values"|"ch-ua-platform"|"ch-ua-model"|"ch-ua-mobile"|"ch-ua-form-factors"|"ch-ua-full-version"|"ch-ua-full-version-list"|"ch-ua-platform-version"|"ch-ua-wow64"|"ch-viewport-height"|"ch-viewport-width"|"ch-width"|"clipboard-read"|"clipboard-write"|"compute-pressure"|"controlled-frame"|"cross-origin-isolated"|"deferred-fetch"|"deferred-fetch-minimal"|"device-attributes"|"digital-credentials-create"|"digital-credentials-get"|"direct-sockets"|"direct-sockets-private"|"display-capture"|"document-domain"|"encrypted-media"|"execution-while-out-of-viewport"|"execution-while-not-rendered"|"fenced-unpartitioned-storage-read"|"focus-without-user-activation"|"fullscreen"|"frobulate"|"gamepad"|"geolocation"|"gyroscope"|"hid"|"identity-credentials-get"|"idle-detection"|"interest-cohort"|"join-ad-interest-group"|"keyboard-map"|"language-detector"|"language-model"|"local-fonts"|"local-network-access"|"magnetometer"|"media-playback-while-not-visible"|"microphone"|"midi"|"on-device-speech-recognition"|"otp-credentials"|"payment"|"picture-in-picture"|"popins"|"private-aggregation"|"private-state-token-issuance"|"private-state-token-redemption"|"publickey-credentials-create"|"publickey-credentials-get"|"record-ad-auction-events"|"rewriter"|"run-ad-auction"|"screen-wake-lock"|"serial"|"shared-autofill"|"shared-storage"|"shared-storage-select-url"|"smart-card"|"speaker-selection"|"storage-access"|"sub-apps"|"summarizer"|"sync-xhr"|"translator"|"unload"|"usb"|"usb-unrestricted"|"vertical-scroll"|"web-app-installation"|"web-printing"|"web-share"|"window-management"|"writer"|"xr-spatial-tracking";
/**
* Reason for a permissions policy feature to be disabled.
*/
@@ -12791,7 +14126,7 @@ https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-expl
/**
* List of not restored reasons for back-forward cache.
*/
- export type BackForwardCacheNotRestoredReason = "NotPrimaryMainFrame"|"BackForwardCacheDisabled"|"RelatedActiveContentsExist"|"HTTPStatusNotOK"|"SchemeNotHTTPOrHTTPS"|"Loading"|"WasGrantedMediaAccess"|"DisableForRenderFrameHostCalled"|"DomainNotAllowed"|"HTTPMethodNotGET"|"SubframeIsNavigating"|"Timeout"|"CacheLimit"|"JavaScriptExecution"|"RendererProcessKilled"|"RendererProcessCrashed"|"SchedulerTrackedFeatureUsed"|"ConflictingBrowsingInstance"|"CacheFlushed"|"ServiceWorkerVersionActivation"|"SessionRestored"|"ServiceWorkerPostMessage"|"EnteredBackForwardCacheBeforeServiceWorkerHostAdded"|"RenderFrameHostReused_SameSite"|"RenderFrameHostReused_CrossSite"|"ServiceWorkerClaim"|"IgnoreEventAndEvict"|"HaveInnerContents"|"TimeoutPuttingInCache"|"BackForwardCacheDisabledByLowMemory"|"BackForwardCacheDisabledByCommandLine"|"NetworkRequestDatapipeDrainedAsBytesConsumer"|"NetworkRequestRedirected"|"NetworkRequestTimeout"|"NetworkExceedsBufferLimit"|"NavigationCancelledWhileRestoring"|"NotMostRecentNavigationEntry"|"BackForwardCacheDisabledForPrerender"|"UserAgentOverrideDiffers"|"ForegroundCacheLimit"|"BrowsingInstanceNotSwapped"|"BackForwardCacheDisabledForDelegate"|"UnloadHandlerExistsInMainFrame"|"UnloadHandlerExistsInSubFrame"|"ServiceWorkerUnregistration"|"CacheControlNoStore"|"CacheControlNoStoreCookieModified"|"CacheControlNoStoreHTTPOnlyCookieModified"|"NoResponseHead"|"Unknown"|"ActivationNavigationsDisallowedForBug1234857"|"ErrorDocument"|"FencedFramesEmbedder"|"CookieDisabled"|"HTTPAuthRequired"|"CookieFlushed"|"BroadcastChannelOnMessage"|"WebViewSettingsChanged"|"WebViewJavaScriptObjectChanged"|"WebViewMessageListenerInjected"|"WebViewSafeBrowsingAllowlistChanged"|"WebViewDocumentStartJavascriptChanged"|"WebSocket"|"WebTransport"|"WebRTC"|"MainResourceHasCacheControlNoStore"|"MainResourceHasCacheControlNoCache"|"SubresourceHasCacheControlNoStore"|"SubresourceHasCacheControlNoCache"|"ContainsPlugins"|"DocumentLoaded"|"OutstandingNetworkRequestOthers"|"RequestedMIDIPermission"|"RequestedAudioCapturePermission"|"RequestedVideoCapturePermission"|"RequestedBackForwardCacheBlockedSensors"|"RequestedBackgroundWorkPermission"|"BroadcastChannel"|"WebXR"|"SharedWorker"|"SharedWorkerMessage"|"WebLocks"|"WebHID"|"WebShare"|"RequestedStorageAccessGrant"|"WebNfc"|"OutstandingNetworkRequestFetch"|"OutstandingNetworkRequestXHR"|"AppBanner"|"Printing"|"WebDatabase"|"PictureInPicture"|"SpeechRecognizer"|"IdleManager"|"PaymentManager"|"SpeechSynthesis"|"KeyboardLock"|"WebOTPService"|"OutstandingNetworkRequestDirectSocket"|"InjectedJavascript"|"InjectedStyleSheet"|"KeepaliveRequest"|"IndexedDBEvent"|"Dummy"|"JsNetworkRequestReceivedCacheControlNoStoreResource"|"WebRTCSticky"|"WebTransportSticky"|"WebSocketSticky"|"SmartCard"|"LiveMediaStreamTrack"|"UnloadHandler"|"ParserAborted"|"ContentSecurityHandler"|"ContentWebAuthenticationAPI"|"ContentFileChooser"|"ContentSerial"|"ContentFileSystemAccess"|"ContentMediaDevicesDispatcherHost"|"ContentWebBluetooth"|"ContentWebUSB"|"ContentMediaSessionService"|"ContentScreenReader"|"ContentDiscarded"|"EmbedderPopupBlockerTabHelper"|"EmbedderSafeBrowsingTriggeredPopupBlocker"|"EmbedderSafeBrowsingThreatDetails"|"EmbedderAppBannerManager"|"EmbedderDomDistillerViewerSource"|"EmbedderDomDistillerSelfDeletingRequestDelegate"|"EmbedderOomInterventionTabHelper"|"EmbedderOfflinePage"|"EmbedderChromePasswordManagerClientBindCredentialManager"|"EmbedderPermissionRequestManager"|"EmbedderModalDialog"|"EmbedderExtensions"|"EmbedderExtensionMessaging"|"EmbedderExtensionMessagingForOpenPort"|"EmbedderExtensionSentMessageToCachedFrame"|"RequestedByWebViewClient"|"PostMessageByWebViewClient"|"CacheControlNoStoreDeviceBoundSessionTerminated"|"CacheLimitPrunedOnModerateMemoryPressure"|"CacheLimitPrunedOnCriticalMemoryPressure";
+ export type BackForwardCacheNotRestoredReason = "NotPrimaryMainFrame"|"BackForwardCacheDisabled"|"RelatedActiveContentsExist"|"HTTPStatusNotOK"|"SchemeNotHTTPOrHTTPS"|"Loading"|"WasGrantedMediaAccess"|"DisableForRenderFrameHostCalled"|"DomainNotAllowed"|"HTTPMethodNotGET"|"SubframeIsNavigating"|"Timeout"|"CacheLimit"|"JavaScriptExecution"|"RendererProcessKilled"|"RendererProcessCrashed"|"SchedulerTrackedFeatureUsed"|"ConflictingBrowsingInstance"|"CacheFlushed"|"ServiceWorkerVersionActivation"|"SessionRestored"|"ServiceWorkerPostMessage"|"EnteredBackForwardCacheBeforeServiceWorkerHostAdded"|"RenderFrameHostReused_SameSite"|"RenderFrameHostReused_CrossSite"|"ServiceWorkerClaim"|"IgnoreEventAndEvict"|"HaveInnerContents"|"TimeoutPuttingInCache"|"BackForwardCacheDisabledByLowMemory"|"BackForwardCacheDisabledByCommandLine"|"NetworkRequestDatapipeDrainedAsBytesConsumer"|"NetworkRequestRedirected"|"NetworkRequestTimeout"|"NetworkExceedsBufferLimit"|"NavigationCancelledWhileRestoring"|"NotMostRecentNavigationEntry"|"BackForwardCacheDisabledForPrerender"|"UserAgentOverrideDiffers"|"ForegroundCacheLimit"|"BrowsingInstanceNotSwapped"|"BackForwardCacheDisabledForDelegate"|"UnloadHandlerExistsInMainFrame"|"UnloadHandlerExistsInSubFrame"|"ServiceWorkerUnregistration"|"CacheControlNoStore"|"CacheControlNoStoreCookieModified"|"CacheControlNoStoreHTTPOnlyCookieModified"|"NoResponseHead"|"Unknown"|"ActivationNavigationsDisallowedForBug1234857"|"ErrorDocument"|"FencedFramesEmbedder"|"CookieDisabled"|"HTTPAuthRequired"|"CookieFlushed"|"BroadcastChannelOnMessage"|"WebViewSettingsChanged"|"WebViewJavaScriptObjectChanged"|"WebViewMessageListenerInjected"|"WebViewSafeBrowsingAllowlistChanged"|"WebViewDocumentStartJavascriptChanged"|"WebSocket"|"WebTransport"|"WebRTC"|"MainResourceHasCacheControlNoStore"|"MainResourceHasCacheControlNoCache"|"SubresourceHasCacheControlNoStore"|"SubresourceHasCacheControlNoCache"|"ContainsPlugins"|"DocumentLoaded"|"OutstandingNetworkRequestOthers"|"RequestedMIDIPermission"|"RequestedAudioCapturePermission"|"RequestedVideoCapturePermission"|"RequestedBackForwardCacheBlockedSensors"|"RequestedBackgroundWorkPermission"|"BroadcastChannel"|"WebXR"|"SharedWorker"|"SharedWorkerMessage"|"WebLocks"|"WebHID"|"WebShare"|"RequestedStorageAccessGrant"|"WebNfc"|"OutstandingNetworkRequestFetch"|"OutstandingNetworkRequestXHR"|"AppBanner"|"Printing"|"WebDatabase"|"PictureInPicture"|"SpeechRecognizer"|"IdleManager"|"PaymentManager"|"SpeechSynthesis"|"KeyboardLock"|"WebOTPService"|"OutstandingNetworkRequestDirectSocket"|"InjectedJavascript"|"InjectedStyleSheet"|"KeepaliveRequest"|"IndexedDBEvent"|"Dummy"|"JsNetworkRequestReceivedCacheControlNoStoreResource"|"WebRTCUsedWithCCNS"|"WebTransportUsedWithCCNS"|"WebSocketUsedWithCCNS"|"SmartCard"|"LiveMediaStreamTrack"|"UnloadHandler"|"ParserAborted"|"ContentSecurityHandler"|"ContentWebAuthenticationAPI"|"ContentFileChooser"|"ContentSerial"|"ContentFileSystemAccess"|"ContentMediaDevicesDispatcherHost"|"ContentWebBluetooth"|"ContentWebUSB"|"ContentMediaSessionService"|"ContentScreenReader"|"ContentDiscarded"|"EmbedderPopupBlockerTabHelper"|"EmbedderSafeBrowsingTriggeredPopupBlocker"|"EmbedderSafeBrowsingThreatDetails"|"EmbedderAppBannerManager"|"EmbedderDomDistillerViewerSource"|"EmbedderDomDistillerSelfDeletingRequestDelegate"|"EmbedderOomInterventionTabHelper"|"EmbedderOfflinePage"|"EmbedderChromePasswordManagerClientBindCredentialManager"|"EmbedderPermissionRequestManager"|"EmbedderModalDialog"|"EmbedderExtensions"|"EmbedderExtensionMessaging"|"EmbedderExtensionMessagingForOpenPort"|"EmbedderExtensionSentMessageToCachedFrame"|"RequestedByWebViewClient"|"PostMessageByWebViewClient"|"CacheControlNoStoreDeviceBoundSessionTerminated"|"CacheLimitPrunedOnModerateMemoryPressure"|"CacheLimitPrunedOnCriticalMemoryPressure";
/**
* Types of not restored reasons for back-forward cache.
*/
@@ -14394,108 +15729,292 @@ Note that not all types exposed to the web platform are currently supported.
}
}
- /**
- * Security
- */
- export module Security {
- /**
- * An internal certificate ID value.
- */
- export type CertificateId = number;
- /**
- * A description of mixed content (HTTP resources on HTTPS pages), as defined by
-https://www.w3.org/TR/mixed-content/#categories
- */
- export type MixedContentType = "blockable"|"optionally-blockable"|"none";
+ export module Preload {
/**
- * The security level of a page or resource.
+ * Unique id
*/
- export type SecurityState = "unknown"|"neutral"|"insecure"|"secure"|"info"|"insecure-broken";
+ export type RuleSetId = string;
/**
- * Details about the security state of the page certificate.
+ * Corresponds to SpeculationRuleSet
*/
- export interface CertificateSecurityState {
- /**
- * Protocol name (e.g. "TLS 1.2" or "QUIC").
- */
- protocol: string;
- /**
- * Key Exchange used by the connection, or the empty string if not applicable.
- */
- keyExchange: string;
- /**
- * (EC)DH group used by the connection, if applicable.
- */
- keyExchangeGroup?: string;
- /**
- * Cipher name.
- */
- cipher: string;
- /**
- * TLS MAC. Note that AEAD ciphers do not have separate MACs.
- */
- mac?: string;
- /**
- * Page certificate.
- */
- certificate: string[];
- /**
- * Certificate subject name.
- */
- subjectName: string;
- /**
- * Name of the issuing CA.
- */
- issuer: string;
- /**
- * Certificate valid from date.
- */
- validFrom: Network.TimeSinceEpoch;
- /**
- * Certificate valid to (expiration) date
- */
- validTo: Network.TimeSinceEpoch;
- /**
- * The highest priority network error code, if the certificate has an error.
- */
- certificateNetworkError?: string;
- /**
- * True if the certificate uses a weak signature algorithm.
- */
- certificateHasWeakSignature: boolean;
- /**
- * True if the certificate has a SHA1 signature in the chain.
- */
- certificateHasSha1Signature: boolean;
+ export interface RuleSet {
+ id: RuleSetId;
/**
- * True if modern SSL
+ * Identifies a document which the rule set is associated with.
*/
- modernSSL: boolean;
+ loaderId: Network.LoaderId;
/**
- * True if the connection is using an obsolete SSL protocol.
+ * Source text of JSON representing the rule set. If it comes from
+`<script>` tag, it is the textContent of the node. Note that it is
+a JSON for valid case.
+
+See also:
+- https://wicg.github.io/nav-speculation/speculation-rules.html
+- https://github.com/WICG/nav-speculation/blob/main/triggers.md
*/
- obsoleteSslProtocol: boolean;
+ sourceText: string;
/**
- * True if the connection is using an obsolete SSL key exchange.
+ * A speculation rule set is either added through an inline
+`<script>` tag or through an external resource via the
+'Speculation-Rules' HTTP header. For the first case, we include
+the BackendNodeId of the relevant `<script>` tag. For the second
+case, we include the external URL where the rule set was loaded
+from, and also RequestId if Network domain is enabled.
+
+See also:
+- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
+- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
*/
- obsoleteSslKeyExchange: boolean;
+ backendNodeId?: DOM.BackendNodeId;
+ url?: string;
+ requestId?: Network.RequestId;
/**
- * True if the connection is using an obsolete SSL cipher.
+ * Error information
+`errorMessage` is null iff `errorType` is null.
*/
- obsoleteSslCipher: boolean;
+ errorType?: RuleSetErrorType;
/**
- * True if the connection is using an obsolete SSL signature.
+ * TODO(https://crbug.com/1425354): Replace this property with structured error.
*/
- obsoleteSslSignature: boolean;
+ errorMessage?: string;
}
- export type SafetyTipStatus = "badReputation"|"lookalike";
- export interface SafetyTipInfo {
- /**
- * Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
- */
- safetyTipStatus: SafetyTipStatus;
- /**
- * The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
+ export type RuleSetErrorType = "SourceIsNotJsonObject"|"InvalidRulesSkipped"|"InvalidRulesetLevelTag";
+ /**
+ * The type of preloading attempted. It corresponds to
+mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
+isn't being used by clients).
+ */
+ export type SpeculationAction = "Prefetch"|"Prerender";
+ /**
+ * Corresponds to mojom::SpeculationTargetHint.
+See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
+ */
+ export type SpeculationTargetHint = "Blank"|"Self";
+ /**
+ * A key that identifies a preloading attempt.
+
+The url used is the url specified by the trigger (i.e. the initial URL), and
+not the final url that is navigated to. For example, prerendering allows
+same-origin main frame navigations during the attempt, but the attempt is
+still keyed with the initial URL.
+ */
+ export interface PreloadingAttemptKey {
+ loaderId: Network.LoaderId;
+ action: SpeculationAction;
+ url: string;
+ targetHint?: SpeculationTargetHint;
+ }
+ /**
+ * Lists sources for a preloading attempt, specifically the ids of rule sets
+that had a speculation rule that triggered the attempt, and the
+BackendNodeIds of <a href> or <area href> elements that triggered the
+attempt (in the case of attempts triggered by a document rule). It is
+possible for multiple rule sets and links to trigger a single attempt.
+ */
+ export interface PreloadingAttemptSource {
+ key: PreloadingAttemptKey;
+ ruleSetIds: RuleSetId[];
+ nodeIds: DOM.BackendNodeId[];
+ }
+ /**
+ * Chrome manages different types of preloads together using a
+concept of preloading pipeline. For example, if a site uses a
+SpeculationRules for prerender, Chrome first starts a prefetch and
+then upgrades it to prerender.
+
+CDP events for them are emitted separately but they share
+`PreloadPipelineId`.
+ */
+ export type PreloadPipelineId = string;
+ /**
+ * List of FinalStatus reasons for Prerender2.
+ */
+ export type PrerenderFinalStatus = "Activated"|"Destroyed"|"LowEndDevice"|"InvalidSchemeRedirect"|"InvalidSchemeNavigation"|"NavigationRequestBlockedByCsp"|"MojoBinderPolicy"|"RendererProcessCrashed"|"RendererProcessKilled"|"Download"|"TriggerDestroyed"|"NavigationNotCommitted"|"NavigationBadHttpStatus"|"ClientCertRequested"|"NavigationRequestNetworkError"|"CancelAllHostsForTesting"|"DidFailLoad"|"Stop"|"SslCertificateError"|"LoginAuthRequested"|"UaChangeRequiresReload"|"BlockedByClient"|"AudioOutputDeviceRequested"|"MixedContent"|"TriggerBackgrounded"|"MemoryLimitExceeded"|"DataSaverEnabled"|"TriggerUrlHasEffectiveUrl"|"ActivatedBeforeStarted"|"InactivePageRestriction"|"StartFailed"|"TimeoutBackgrounded"|"CrossSiteRedirectInInitialNavigation"|"CrossSiteNavigationInInitialNavigation"|"SameSiteCrossOriginRedirectNotOptInInInitialNavigation"|"SameSiteCrossOriginNavigationNotOptInInInitialNavigation"|"ActivationNavigationParameterMismatch"|"ActivatedInBackground"|"EmbedderHostDisallowed"|"ActivationNavigationDestroyedBeforeSuccess"|"TabClosedByUserGesture"|"TabClosedWithoutUserGesture"|"PrimaryMainFrameRendererProcessCrashed"|"PrimaryMainFrameRendererProcessKilled"|"ActivationFramePolicyNotCompatible"|"PreloadingDisabled"|"BatterySaverEnabled"|"ActivatedDuringMainFrameNavigation"|"PreloadingUnsupportedByWebContents"|"CrossSiteRedirectInMainFrameNavigation"|"CrossSiteNavigationInMainFrameNavigation"|"SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation"|"SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation"|"MemoryPressureOnTrigger"|"MemoryPressureAfterTriggered"|"PrerenderingDisabledByDevTools"|"SpeculationRuleRemoved"|"ActivatedWithAuxiliaryBrowsingContexts"|"MaxNumOfRunningEagerPrerendersExceeded"|"MaxNumOfRunningNonEagerPrerendersExceeded"|"MaxNumOfRunningEmbedderPrerendersExceeded"|"PrerenderingUrlHasEffectiveUrl"|"RedirectedPrerenderingUrlHasEffectiveUrl"|"ActivationUrlHasEffectiveUrl"|"JavaScriptInterfaceAdded"|"JavaScriptInterfaceRemoved"|"AllPrerenderingCanceled"|"WindowClosed"|"SlowNetwork"|"OtherPrerenderedPageActivated"|"V8OptimizerDisabled"|"PrerenderFailedDuringPrefetch"|"BrowsingDataRemoved"|"PrerenderHostReused";
+ /**
+ * Preloading status values, see also PreloadingTriggeringOutcome. This
+status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
+ */
+ export type PreloadingStatus = "Pending"|"Running"|"Ready"|"Success"|"Failure"|"NotSupported";
+ /**
+ * TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
+filter out the ones that aren't necessary to the developers.
+ */
+ export type PrefetchStatus = "PrefetchAllowed"|"PrefetchFailedIneligibleRedirect"|"PrefetchFailedInvalidRedirect"|"PrefetchFailedMIMENotSupported"|"PrefetchFailedNetError"|"PrefetchFailedNon2XX"|"PrefetchEvictedAfterBrowsingDataRemoved"|"PrefetchEvictedAfterCandidateRemoved"|"PrefetchEvictedForNewerPrefetch"|"PrefetchHeldback"|"PrefetchIneligibleRetryAfter"|"PrefetchIsPrivacyDecoy"|"PrefetchIsStale"|"PrefetchNotEligibleBrowserContextOffTheRecord"|"PrefetchNotEligibleDataSaverEnabled"|"PrefetchNotEligibleExistingProxy"|"PrefetchNotEligibleHostIsNonUnique"|"PrefetchNotEligibleNonDefaultStoragePartition"|"PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy"|"PrefetchNotEligibleSchemeIsNotHttps"|"PrefetchNotEligibleUserHasCookies"|"PrefetchNotEligibleUserHasServiceWorker"|"PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler"|"PrefetchNotEligibleRedirectFromServiceWorker"|"PrefetchNotEligibleRedirectToServiceWorker"|"PrefetchNotEligibleBatterySaverEnabled"|"PrefetchNotEligiblePreloadingDisabled"|"PrefetchNotFinishedInTime"|"PrefetchNotStarted"|"PrefetchNotUsedCookiesChanged"|"PrefetchProxyNotAvailable"|"PrefetchResponseUsed"|"PrefetchSuccessfulButNotUsed"|"PrefetchNotUsedProbeFailed";
+ /**
+ * Information of headers to be displayed when the header mismatch occurred.
+ */
+ export interface PrerenderMismatchedHeaders {
+ headerName: string;
+ initialValue?: string;
+ activationValue?: string;
+ }
+
+ /**
+ * Upsert. Currently, it is only emitted when a rule set added.
+ */
+ export type ruleSetUpdatedPayload = {
+ ruleSet: RuleSet;
+ }
+ export type ruleSetRemovedPayload = {
+ id: RuleSetId;
+ }
+ /**
+ * Fired when a preload enabled state is updated.
+ */
+ export type preloadEnabledStateUpdatedPayload = {
+ disabledByPreference: boolean;
+ disabledByDataSaver: boolean;
+ disabledByBatterySaver: boolean;
+ disabledByHoldbackPrefetchSpeculationRules: boolean;
+ disabledByHoldbackPrerenderSpeculationRules: boolean;
+ }
+ /**
+ * Fired when a prefetch attempt is updated.
+ */
+ export type prefetchStatusUpdatedPayload = {
+ key: PreloadingAttemptKey;
+ pipelineId: PreloadPipelineId;
+ /**
+ * The frame id of the frame initiating prefetch.
+ */
+ initiatingFrameId: Page.FrameId;
+ prefetchUrl: string;
+ status: PreloadingStatus;
+ prefetchStatus: PrefetchStatus;
+ requestId: Network.RequestId;
+ }
+ /**
+ * Fired when a prerender attempt is updated.
+ */
+ export type prerenderStatusUpdatedPayload = {
+ key: PreloadingAttemptKey;
+ pipelineId: PreloadPipelineId;
+ status: PreloadingStatus;
+ prerenderStatus?: PrerenderFinalStatus;
+ /**
+ * This is used to give users more information about the name of Mojo interface
+that is incompatible with prerender and has caused the cancellation of the attempt.
+ */
+ disallowedMojoInterface?: string;
+ mismatchedHeaders?: PrerenderMismatchedHeaders[];
+ }
+ /**
+ * Send a list of sources for all preloading attempts in a document.
+ */
+ export type preloadingAttemptSourcesUpdatedPayload = {
+ loaderId: Network.LoaderId;
+ preloadingAttemptSources: PreloadingAttemptSource[];
+ }
+
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ }
+
+ export module Security {
+ /**
+ * An internal certificate ID value.
+ */
+ export type CertificateId = number;
+ /**
+ * A description of mixed content (HTTP resources on HTTPS pages), as defined by
+https://www.w3.org/TR/mixed-content/#categories
+ */
+ export type MixedContentType = "blockable"|"optionally-blockable"|"none";
+ /**
+ * The security level of a page or resource.
+ */
+ export type SecurityState = "unknown"|"neutral"|"insecure"|"secure"|"info"|"insecure-broken";
+ /**
+ * Details about the security state of the page certificate.
+ */
+ export interface CertificateSecurityState {
+ /**
+ * Protocol name (e.g. "TLS 1.2" or "QUIC").
+ */
+ protocol: string;
+ /**
+ * Key Exchange used by the connection, or the empty string if not applicable.
+ */
+ keyExchange: string;
+ /**
+ * (EC)DH group used by the connection, if applicable.
+ */
+ keyExchangeGroup?: string;
+ /**
+ * Cipher name.
+ */
+ cipher: string;
+ /**
+ * TLS MAC. Note that AEAD ciphers do not have separate MACs.
+ */
+ mac?: string;
+ /**
+ * Page certificate.
+ */
+ certificate: string[];
+ /**
+ * Certificate subject name.
+ */
+ subjectName: string;
+ /**
+ * Name of the issuing CA.
+ */
+ issuer: string;
+ /**
+ * Certificate valid from date.
+ */
+ validFrom: Network.TimeSinceEpoch;
+ /**
+ * Certificate valid to (expiration) date
+ */
+ validTo: Network.TimeSinceEpoch;
+ /**
+ * The highest priority network error code, if the certificate has an error.
+ */
+ certificateNetworkError?: string;
+ /**
+ * True if the certificate uses a weak signature algorithm.
+ */
+ certificateHasWeakSignature: boolean;
+ /**
+ * True if the certificate has a SHA1 signature in the chain.
+ */
+ certificateHasSha1Signature: boolean;
+ /**
+ * True if modern SSL
+ */
+ modernSSL: boolean;
+ /**
+ * True if the connection is using an obsolete SSL protocol.
+ */
+ obsoleteSslProtocol: boolean;
+ /**
+ * True if the connection is using an obsolete SSL key exchange.
+ */
+ obsoleteSslKeyExchange: boolean;
+ /**
+ * True if the connection is using an obsolete SSL cipher.
+ */
+ obsoleteSslCipher: boolean;
+ /**
+ * True if the connection is using an obsolete SSL signature.
+ */
+ obsoleteSslSignature: boolean;
+ }
+ export type SafetyTipStatus = "badReputation"|"lookalike";
+ export interface SafetyTipInfo {
+ /**
+ * Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
+ */
+ safetyTipStatus: SafetyTipStatus;
+ /**
+ * The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
*/
safeUrl?: string;
}
@@ -16172,6 +17691,10 @@ supported.
* Frame id of originating window (is only set if target has an opener).
*/
openerFrameId?: Page.FrameId;
+ /**
+ * Id of the parent frame, only present for the "iframe" targets.
+ */
+ parentFrameId?: Page.FrameId;
browserContextId?: Browser.BrowserContextID;
/**
* Provides additional details for specific target types. For example, for
@@ -16886,1854 +18409,537 @@ are ignored.
}
/**
- * A domain for letting clients substitute browser's network layer with client code.
+ * This domain allows inspection of Web Audio API.
+https://webaudio.github.io/web-audio-api/
*/
- export module Fetch {
+ export module WebAudio {
/**
- * Unique request identifier.
-Note that this does not identify individual HTTP requests that are part of
-a network request.
+ * An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
*/
- export type RequestId = string;
+ export type GraphObjectId = string;
/**
- * Stages of the request to handle. Request will intercept before the request is
-sent. Response will intercept after the response is received (but before response
-body is received).
+ * Enum of BaseAudioContext types
*/
- export type RequestStage = "Request"|"Response";
- export interface RequestPattern {
- /**
- * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
-backslash. Omitting is equivalent to `"*"`.
- */
- urlPattern?: string;
- /**
- * If set, only requests for matching resource types will be intercepted.
- */
- resourceType?: Network.ResourceType;
- /**
- * Stage at which to begin intercepting requests. Default is Request.
- */
- requestStage?: RequestStage;
- }
+ export type ContextType = "realtime"|"offline";
/**
- * Response HTTP header entry
+ * Enum of AudioContextState from the spec
*/
- export interface HeaderEntry {
- name: string;
- value: string;
- }
+ export type ContextState = "suspended"|"running"|"closed"|"interrupted";
/**
- * Authorization challenge for HTTP status code 401 or 407.
+ * Enum of AudioNode types
*/
- export interface AuthChallenge {
+ export type NodeType = string;
+ /**
+ * Enum of AudioNode::ChannelCountMode from the spec
+ */
+ export type ChannelCountMode = "clamped-max"|"explicit"|"max";
+ /**
+ * Enum of AudioNode::ChannelInterpretation from the spec
+ */
+ export type ChannelInterpretation = "discrete"|"speakers";
+ /**
+ * Enum of AudioParam types
+ */
+ export type ParamType = string;
+ /**
+ * Enum of AudioParam::AutomationRate from the spec
+ */
+ export type AutomationRate = "a-rate"|"k-rate";
+ /**
+ * Fields in AudioContext that change in real-time.
+ */
+ export interface ContextRealtimeData {
/**
- * Source of the authentication challenge.
+ * The current context time in second in BaseAudioContext.
*/
- source?: "Server"|"Proxy";
+ currentTime: number;
/**
- * Origin of the challenger.
+ * The time spent on rendering graph divided by render quantum duration,
+and multiplied by 100. 100 means the audio renderer reached the full
+capacity and glitch may occur.
*/
- origin: string;
+ renderCapacity: number;
/**
- * The authentication scheme used, such as basic or digest
+ * A running mean of callback interval.
*/
- scheme: string;
+ callbackIntervalMean: number;
/**
- * The realm of the challenge. May be empty.
+ * A running variance of callback interval.
*/
- realm: string;
+ callbackIntervalVariance: number;
}
/**
- * Response to an AuthChallenge.
+ * Protocol object for BaseAudioContext
*/
- export interface AuthChallengeResponse {
+ export interface BaseAudioContext {
+ contextId: GraphObjectId;
+ contextType: ContextType;
+ contextState: ContextState;
+ realtimeData?: ContextRealtimeData;
/**
- * The decision on what to do in response to the authorization challenge. Default means
-deferring to the default behavior of the net stack, which will likely either the Cancel
-authentication or display a popup dialog box.
+ * Platform-dependent callback buffer size.
*/
- response: "Default"|"CancelAuth"|"ProvideCredentials";
+ callbackBufferSize: number;
/**
- * The username to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Number of output channels supported by audio hardware in use.
*/
- username?: string;
+ maxOutputChannelCount: number;
/**
- * The password to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Context sample rate.
*/
- password?: string;
+ sampleRate: number;
}
-
/**
- * Issued when the domain is enabled and the request URL matches the
-specified filter. The request is paused until the client responds
-with one of continueRequest, failRequest or fulfillRequest.
-The stage of the request can be determined by presence of responseErrorReason
-and responseStatusCode -- the request is at the response stage if either
-of these fields is present and in the request stage otherwise.
-Redirect responses and subsequent requests are reported similarly to regular
-responses and requests. Redirect responses may be distinguished by the value
-of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with
-presence of the `location` header. Requests resulting from a redirect will
-have `redirectedRequestId` field set.
+ * Protocol object for AudioListener
*/
- export type requestPausedPayload = {
- /**
- * Each request the page makes will have a unique id.
- */
- requestId: RequestId;
- /**
- * The details of the request.
- */
- request: Network.Request;
- /**
- * The id of the frame that initiated the request.
- */
- frameId: Page.FrameId;
- /**
- * How the requested resource will be used.
- */
- resourceType: Network.ResourceType;
- /**
- * Response error if intercepted at response stage.
- */
- responseErrorReason?: Network.ErrorReason;
- /**
- * Response code if intercepted at response stage.
- */
- responseStatusCode?: number;
- /**
- * Response status text if intercepted at response stage.
- */
- responseStatusText?: string;
- /**
- * Response headers if intercepted at the response stage.
- */
- responseHeaders?: HeaderEntry[];
- /**
- * If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
-then this networkId will be the same as the requestId present in the requestWillBeSent event.
- */
- networkId?: Network.RequestId;
- /**
- * If the request is due to a redirect response from the server, the id of the request that
-has caused the redirect.
- */
- redirectedRequestId?: RequestId;
+ export interface AudioListener {
+ listenerId: GraphObjectId;
+ contextId: GraphObjectId;
}
/**
- * Issued when the domain is enabled with handleAuthRequests set to true.
-The request is paused until client responds with continueWithAuth.
+ * Protocol object for AudioNode
*/
- export type authRequiredPayload = {
- /**
- * Each request the page makes will have a unique id.
- */
- requestId: RequestId;
- /**
- * The details of the request.
- */
- request: Network.Request;
- /**
- * The id of the frame that initiated the request.
- */
- frameId: Page.FrameId;
- /**
- * How the requested resource will be used.
- */
- resourceType: Network.ResourceType;
- /**
- * Details of the Authorization Challenge encountered.
-If this is set, client should respond with continueRequest that
-contains AuthChallengeResponse.
- */
- authChallenge: AuthChallenge;
+ export interface AudioNode {
+ nodeId: GraphObjectId;
+ contextId: GraphObjectId;
+ nodeType: NodeType;
+ numberOfInputs: number;
+ numberOfOutputs: number;
+ channelCount: number;
+ channelCountMode: ChannelCountMode;
+ channelInterpretation: ChannelInterpretation;
+ }
+ /**
+ * Protocol object for AudioParam
+ */
+ export interface AudioParam {
+ paramId: GraphObjectId;
+ nodeId: GraphObjectId;
+ contextId: GraphObjectId;
+ paramType: ParamType;
+ rate: AutomationRate;
+ defaultValue: number;
+ minValue: number;
+ maxValue: number;
}
/**
- * Disables the fetch domain.
+ * Notifies that a new BaseAudioContext has been created.
*/
- export type disableParameters = {
+ export type contextCreatedPayload = {
+ context: BaseAudioContext;
}
- export type disableReturnValue = {
+ /**
+ * Notifies that an existing BaseAudioContext will be destroyed.
+ */
+ export type contextWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
}
/**
- * Enables issuing of requestPaused events. A request will be paused until client
-calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
+ * Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
*/
- export type enableParameters = {
- /**
- * If specified, only requests matching any of these patterns will produce
-fetchRequested event and will be paused until clients response. If not set,
-all requests will be affected.
- */
- patterns?: RequestPattern[];
- /**
- * If true, authRequired events will be issued and requests will be paused
-expecting a call to continueWithAuth.
- */
- handleAuthRequests?: boolean;
+ export type contextChangedPayload = {
+ context: BaseAudioContext;
}
- export type enableReturnValue = {
+ /**
+ * Notifies that the construction of an AudioListener has finished.
+ */
+ export type audioListenerCreatedPayload = {
+ listener: AudioListener;
}
/**
- * Causes the request to fail with specified reason.
+ * Notifies that a new AudioListener has been created.
*/
- export type failRequestParameters = {
- /**
- * An id the client received in requestPaused event.
- */
- requestId: RequestId;
- /**
- * Causes the request to fail with the given reason.
- */
- errorReason: Network.ErrorReason;
+ export type audioListenerWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ listenerId: GraphObjectId;
}
- export type failRequestReturnValue = {
+ /**
+ * Notifies that a new AudioNode has been created.
+ */
+ export type audioNodeCreatedPayload = {
+ node: AudioNode;
}
/**
- * Provides response to the request.
+ * Notifies that an existing AudioNode has been destroyed.
*/
- export type fulfillRequestParameters = {
- /**
- * An id the client received in requestPaused event.
- */
- requestId: RequestId;
+ export type audioNodeWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ nodeId: GraphObjectId;
+ }
+ /**
+ * Notifies that a new AudioParam has been created.
+ */
+ export type audioParamCreatedPayload = {
+ param: AudioParam;
+ }
+ /**
+ * Notifies that an existing AudioParam has been destroyed.
+ */
+ export type audioParamWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ nodeId: GraphObjectId;
+ paramId: GraphObjectId;
+ }
+ /**
+ * Notifies that two AudioNodes are connected.
+ */
+ export type nodesConnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ destinationInputIndex?: number;
+ }
+ /**
+ * Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
+ */
+ export type nodesDisconnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ destinationInputIndex?: number;
+ }
+ /**
+ * Notifies that an AudioNode is connected to an AudioParam.
+ */
+ export type nodeParamConnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ }
+ /**
+ * Notifies that an AudioNode is disconnected to an AudioParam.
+ */
+ export type nodeParamDisconnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ }
+
+ /**
+ * Enables the WebAudio domain and starts sending context lifetime events.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disables the WebAudio domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Fetch the realtime data from the registered contexts.
+ */
+ export type getRealtimeDataParameters = {
+ contextId: GraphObjectId;
+ }
+ export type getRealtimeDataReturnValue = {
+ realtimeData: ContextRealtimeData;
+ }
+ }
+
+ /**
+ * This domain allows configuring virtual authenticators to test the WebAuthn
+API.
+ */
+ export module WebAuthn {
+ export type AuthenticatorId = string;
+ export type AuthenticatorProtocol = "u2f"|"ctap2";
+ export type Ctap2Version = "ctap2_0"|"ctap2_1";
+ export type AuthenticatorTransport = "usb"|"nfc"|"ble"|"cable"|"internal";
+ export interface VirtualAuthenticatorOptions {
+ protocol: AuthenticatorProtocol;
/**
- * An HTTP response code.
+ * Defaults to ctap2_0. Ignored if |protocol| == u2f.
*/
- responseCode: number;
+ ctap2Version?: Ctap2Version;
+ transport: AuthenticatorTransport;
/**
- * Response headers.
+ * Defaults to false.
*/
- responseHeaders?: HeaderEntry[];
+ hasResidentKey?: boolean;
/**
- * Alternative way of specifying response headers as a \0-separated
-series of name: value pairs. Prefer the above method unless you
-need to represent some non-UTF8 values that can't be transmitted
-over the protocol as text.
+ * Defaults to false.
*/
- binaryResponseHeaders?: binary;
+ hasUserVerification?: boolean;
/**
- * A response body. If absent, original response body will be used if
-the request is intercepted at the response stage and empty body
-will be used if the request is intercepted at the request stage.
+ * If set to true, the authenticator will support the largeBlob extension.
+https://w3c.github.io/webauthn#largeBlob
+Defaults to false.
*/
- body?: binary;
+ hasLargeBlob?: boolean;
/**
- * A textual representation of responseCode.
-If absent, a standard phrase matching responseCode is used.
+ * If set to true, the authenticator will support the credBlob extension.
+https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
+Defaults to false.
*/
- responsePhrase?: string;
- }
- export type fulfillRequestReturnValue = {
- }
- /**
- * Continues the request, optionally modifying some of its parameters.
- */
- export type continueRequestParameters = {
+ hasCredBlob?: boolean;
/**
- * An id the client received in requestPaused event.
+ * If set to true, the authenticator will support the minPinLength extension.
+https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
+Defaults to false.
*/
- requestId: RequestId;
+ hasMinPinLength?: boolean;
/**
- * If set, the request url will be modified in a way that's not observable by page.
+ * If set to true, the authenticator will support the prf extension.
+https://w3c.github.io/webauthn/#prf-extension
+Defaults to false.
*/
- url?: string;
+ hasPrf?: boolean;
/**
- * If set, the request method is overridden.
+ * If set to true, tests of user presence will succeed immediately.
+Otherwise, they will not be resolved. Defaults to true.
*/
- method?: string;
+ automaticPresenceSimulation?: boolean;
/**
- * If set, overrides the post data in the request.
+ * Sets whether User Verification succeeds or fails for an authenticator.
+Defaults to false.
*/
- postData?: binary;
+ isUserVerified?: boolean;
/**
- * If set, overrides the request headers. Note that the overrides do not
-extend to subsequent redirect hops, if a redirect happens. Another override
-may be applied to a different request produced by a redirect.
+ * Credentials created by this authenticator will have the backup
+eligibility (BE) flag set to this value. Defaults to false.
+https://w3c.github.io/webauthn/#sctn-credential-backup
*/
- headers?: HeaderEntry[];
+ defaultBackupEligibility?: boolean;
/**
- * If set, overrides response interception behavior for this request.
+ * Credentials created by this authenticator will have the backup state
+(BS) flag set to this value. Defaults to false.
+https://w3c.github.io/webauthn/#sctn-credential-backup
*/
- interceptResponse?: boolean;
- }
- export type continueRequestReturnValue = {
+ defaultBackupState?: boolean;
}
- /**
- * Continues a request supplying authChallengeResponse following authRequired event.
- */
- export type continueWithAuthParameters = {
- /**
- * An id the client received in authRequired event.
- */
- requestId: RequestId;
+ export interface Credential {
+ credentialId: binary;
+ isResidentCredential: boolean;
/**
- * Response to with an authChallenge.
+ * Relying Party ID the credential is scoped to. Must be set when adding a
+credential.
*/
- authChallengeResponse: AuthChallengeResponse;
- }
- export type continueWithAuthReturnValue = {
- }
- /**
- * Continues loading of the paused response, optionally modifying the
-response headers. If either responseCode or headers are modified, all of them
-must be present.
- */
- export type continueResponseParameters = {
+ rpId?: string;
/**
- * An id the client received in requestPaused event.
+ * The ECDSA P-256 private key in PKCS#8 format.
*/
- requestId: RequestId;
+ privateKey: binary;
/**
- * An HTTP response code. If absent, original response code will be used.
+ * An opaque byte sequence with a maximum size of 64 bytes mapping the
+credential to a specific user.
*/
- responseCode?: number;
+ userHandle?: binary;
/**
- * A textual representation of responseCode.
-If absent, a standard phrase matching responseCode is used.
+ * Signature counter. This is incremented by one for each successful
+assertion.
+See https://w3c.github.io/webauthn/#signature-counter
*/
- responsePhrase?: string;
+ signCount: number;
/**
- * Response headers. If absent, original response headers will be used.
+ * The large blob associated with the credential.
+See https://w3c.github.io/webauthn/#sctn-large-blob-extension
*/
- responseHeaders?: HeaderEntry[];
+ largeBlob?: binary;
/**
- * Alternative way of specifying response headers as a \0-separated
-series of name: value pairs. Prefer the above method unless you
-need to represent some non-UTF8 values that can't be transmitted
-over the protocol as text.
+ * Assertions returned by this credential will have the backup eligibility
+(BE) flag set to this value. Defaults to the authenticator's
+defaultBackupEligibility value.
*/
- binaryResponseHeaders?: binary;
- }
- export type continueResponseReturnValue = {
- }
- /**
- * Causes the body of the response to be received from the server and
-returned as a single string. May only be issued for a request that
-is paused in the Response stage and is mutually exclusive with
-takeResponseBodyForInterceptionAsStream. Calling other methods that
-affect the request or disabling fetch domain before body is received
-results in an undefined behavior.
-Note that the response body is not available for redirects. Requests
-paused in the _redirect received_ state may be differentiated by
-`responseCode` and presence of `location` response header, see
-comments to `requestPaused` for details.
- */
- export type getResponseBodyParameters = {
+ backupEligibility?: boolean;
/**
- * Identifier for the intercepted request to get body for.
+ * Assertions returned by this credential will have the backup state (BS)
+flag set to this value. Defaults to the authenticator's
+defaultBackupState value.
*/
- requestId: RequestId;
- }
- export type getResponseBodyReturnValue = {
+ backupState?: boolean;
/**
- * Response body.
+ * The credential's user.name property. Equivalent to empty if not set.
+https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name
*/
- body: string;
+ userName?: string;
/**
- * True, if content was sent as base64.
- */
- base64Encoded: boolean;
- }
- /**
- * Returns a handle to the stream representing the response body.
-The request must be paused in the HeadersReceived stage.
-Note that after this command the request can't be continued
-as is -- client either needs to cancel it or to provide the
-response body.
-The stream only supports sequential read, IO.read will fail if the position
-is specified.
-This method is mutually exclusive with getResponseBody.
-Calling other methods that affect the request or disabling fetch
-domain before body is received results in an undefined behavior.
- */
- export type takeResponseBodyAsStreamParameters = {
- requestId: RequestId;
- }
- export type takeResponseBodyAsStreamReturnValue = {
- stream: IO.StreamHandle;
- }
- }
-
- /**
- * This domain allows inspection of Web Audio API.
-https://webaudio.github.io/web-audio-api/
- */
- export module WebAudio {
- /**
- * An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
- */
- export type GraphObjectId = string;
- /**
- * Enum of BaseAudioContext types
- */
- export type ContextType = "realtime"|"offline";
- /**
- * Enum of AudioContextState from the spec
- */
- export type ContextState = "suspended"|"running"|"closed"|"interrupted";
- /**
- * Enum of AudioNode types
- */
- export type NodeType = string;
- /**
- * Enum of AudioNode::ChannelCountMode from the spec
- */
- export type ChannelCountMode = "clamped-max"|"explicit"|"max";
- /**
- * Enum of AudioNode::ChannelInterpretation from the spec
- */
- export type ChannelInterpretation = "discrete"|"speakers";
- /**
- * Enum of AudioParam types
- */
- export type ParamType = string;
- /**
- * Enum of AudioParam::AutomationRate from the spec
- */
- export type AutomationRate = "a-rate"|"k-rate";
- /**
- * Fields in AudioContext that change in real-time.
- */
- export interface ContextRealtimeData {
- /**
- * The current context time in second in BaseAudioContext.
- */
- currentTime: number;
- /**
- * The time spent on rendering graph divided by render quantum duration,
-and multiplied by 100. 100 means the audio renderer reached the full
-capacity and glitch may occur.
- */
- renderCapacity: number;
- /**
- * A running mean of callback interval.
- */
- callbackIntervalMean: number;
- /**
- * A running variance of callback interval.
- */
- callbackIntervalVariance: number;
- }
- /**
- * Protocol object for BaseAudioContext
- */
- export interface BaseAudioContext {
- contextId: GraphObjectId;
- contextType: ContextType;
- contextState: ContextState;
- realtimeData?: ContextRealtimeData;
- /**
- * Platform-dependent callback buffer size.
- */
- callbackBufferSize: number;
- /**
- * Number of output channels supported by audio hardware in use.
- */
- maxOutputChannelCount: number;
- /**
- * Context sample rate.
- */
- sampleRate: number;
- }
- /**
- * Protocol object for AudioListener
- */
- export interface AudioListener {
- listenerId: GraphObjectId;
- contextId: GraphObjectId;
- }
- /**
- * Protocol object for AudioNode
- */
- export interface AudioNode {
- nodeId: GraphObjectId;
- contextId: GraphObjectId;
- nodeType: NodeType;
- numberOfInputs: number;
- numberOfOutputs: number;
- channelCount: number;
- channelCountMode: ChannelCountMode;
- channelInterpretation: ChannelInterpretation;
- }
- /**
- * Protocol object for AudioParam
- */
- export interface AudioParam {
- paramId: GraphObjectId;
- nodeId: GraphObjectId;
- contextId: GraphObjectId;
- paramType: ParamType;
- rate: AutomationRate;
- defaultValue: number;
- minValue: number;
- maxValue: number;
- }
-
- /**
- * Notifies that a new BaseAudioContext has been created.
- */
- export type contextCreatedPayload = {
- context: BaseAudioContext;
- }
- /**
- * Notifies that an existing BaseAudioContext will be destroyed.
- */
- export type contextWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- }
- /**
- * Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
- */
- export type contextChangedPayload = {
- context: BaseAudioContext;
- }
- /**
- * Notifies that the construction of an AudioListener has finished.
- */
- export type audioListenerCreatedPayload = {
- listener: AudioListener;
- }
- /**
- * Notifies that a new AudioListener has been created.
- */
- export type audioListenerWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- listenerId: GraphObjectId;
- }
- /**
- * Notifies that a new AudioNode has been created.
- */
- export type audioNodeCreatedPayload = {
- node: AudioNode;
- }
- /**
- * Notifies that an existing AudioNode has been destroyed.
- */
- export type audioNodeWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- nodeId: GraphObjectId;
- }
- /**
- * Notifies that a new AudioParam has been created.
- */
- export type audioParamCreatedPayload = {
- param: AudioParam;
- }
- /**
- * Notifies that an existing AudioParam has been destroyed.
- */
- export type audioParamWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- nodeId: GraphObjectId;
- paramId: GraphObjectId;
- }
- /**
- * Notifies that two AudioNodes are connected.
- */
- export type nodesConnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- destinationInputIndex?: number;
- }
- /**
- * Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
- */
- export type nodesDisconnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- destinationInputIndex?: number;
- }
- /**
- * Notifies that an AudioNode is connected to an AudioParam.
- */
- export type nodeParamConnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- }
- /**
- * Notifies that an AudioNode is disconnected to an AudioParam.
- */
- export type nodeParamDisconnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- }
-
- /**
- * Enables the WebAudio domain and starts sending context lifetime events.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disables the WebAudio domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Fetch the realtime data from the registered contexts.
- */
- export type getRealtimeDataParameters = {
- contextId: GraphObjectId;
- }
- export type getRealtimeDataReturnValue = {
- realtimeData: ContextRealtimeData;
- }
- }
-
- /**
- * This domain allows configuring virtual authenticators to test the WebAuthn
-API.
- */
- export module WebAuthn {
- export type AuthenticatorId = string;
- export type AuthenticatorProtocol = "u2f"|"ctap2";
- export type Ctap2Version = "ctap2_0"|"ctap2_1";
- export type AuthenticatorTransport = "usb"|"nfc"|"ble"|"cable"|"internal";
- export interface VirtualAuthenticatorOptions {
- protocol: AuthenticatorProtocol;
- /**
- * Defaults to ctap2_0. Ignored if |protocol| == u2f.
- */
- ctap2Version?: Ctap2Version;
- transport: AuthenticatorTransport;
- /**
- * Defaults to false.
- */
- hasResidentKey?: boolean;
- /**
- * Defaults to false.
- */
- hasUserVerification?: boolean;
- /**
- * If set to true, the authenticator will support the largeBlob extension.
-https://w3c.github.io/webauthn#largeBlob
-Defaults to false.
- */
- hasLargeBlob?: boolean;
- /**
- * If set to true, the authenticator will support the credBlob extension.
-https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
-Defaults to false.
- */
- hasCredBlob?: boolean;
- /**
- * If set to true, the authenticator will support the minPinLength extension.
-https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
-Defaults to false.
- */
- hasMinPinLength?: boolean;
- /**
- * If set to true, the authenticator will support the prf extension.
-https://w3c.github.io/webauthn/#prf-extension
-Defaults to false.
- */
- hasPrf?: boolean;
- /**
- * If set to true, tests of user presence will succeed immediately.
-Otherwise, they will not be resolved. Defaults to true.
- */
- automaticPresenceSimulation?: boolean;
- /**
- * Sets whether User Verification succeeds or fails for an authenticator.
-Defaults to false.
- */
- isUserVerified?: boolean;
- /**
- * Credentials created by this authenticator will have the backup
-eligibility (BE) flag set to this value. Defaults to false.
-https://w3c.github.io/webauthn/#sctn-credential-backup
- */
- defaultBackupEligibility?: boolean;
- /**
- * Credentials created by this authenticator will have the backup state
-(BS) flag set to this value. Defaults to false.
-https://w3c.github.io/webauthn/#sctn-credential-backup
- */
- defaultBackupState?: boolean;
- }
- export interface Credential {
- credentialId: binary;
- isResidentCredential: boolean;
- /**
- * Relying Party ID the credential is scoped to. Must be set when adding a
-credential.
- */
- rpId?: string;
- /**
- * The ECDSA P-256 private key in PKCS#8 format.
- */
- privateKey: binary;
- /**
- * An opaque byte sequence with a maximum size of 64 bytes mapping the
-credential to a specific user.
- */
- userHandle?: binary;
- /**
- * Signature counter. This is incremented by one for each successful
-assertion.
-See https://w3c.github.io/webauthn/#signature-counter
- */
- signCount: number;
- /**
- * The large blob associated with the credential.
-See https://w3c.github.io/webauthn/#sctn-large-blob-extension
- */
- largeBlob?: binary;
- /**
- * Assertions returned by this credential will have the backup eligibility
-(BE) flag set to this value. Defaults to the authenticator's
-defaultBackupEligibility value.
- */
- backupEligibility?: boolean;
- /**
- * Assertions returned by this credential will have the backup state (BS)
-flag set to this value. Defaults to the authenticator's
-defaultBackupState value.
- */
- backupState?: boolean;
- /**
- * The credential's user.name property. Equivalent to empty if not set.
-https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name
- */
- userName?: string;
- /**
- * The credential's user.displayName property. Equivalent to empty if
-not set.
-https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname
- */
- userDisplayName?: string;
- }
-
- /**
- * Triggered when a credential is added to an authenticator.
- */
- export type credentialAddedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- /**
- * Triggered when a credential is deleted, e.g. through
-PublicKeyCredential.signalUnknownCredential().
- */
- export type credentialDeletedPayload = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- /**
- * Triggered when a credential is updated, e.g. through
-PublicKeyCredential.signalCurrentUserDetails().
- */
- export type credentialUpdatedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- /**
- * Triggered when a credential is used in a webauthn assertion.
- */
- export type credentialAssertedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
-
- /**
- * Enable the WebAuthn domain and start intercepting credential storage and
-retrieval with a virtual authenticator.
- */
- export type enableParameters = {
- /**
- * Whether to enable the WebAuthn user interface. Enabling the UI is
-recommended for debugging and demo purposes, as it is closer to the real
-experience. Disabling the UI is recommended for automated testing.
-Supported at the embedder's discretion if UI is available.
-Defaults to false.
- */
- enableUI?: boolean;
- }
- export type enableReturnValue = {
- }
- /**
- * Disable the WebAuthn domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Creates and adds a virtual authenticator.
- */
- export type addVirtualAuthenticatorParameters = {
- options: VirtualAuthenticatorOptions;
- }
- export type addVirtualAuthenticatorReturnValue = {
- authenticatorId: AuthenticatorId;
- }
- /**
- * Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
- */
- export type setResponseOverrideBitsParameters = {
- authenticatorId: AuthenticatorId;
- /**
- * If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
-Defaults to false.
- */
- isBogusSignature?: boolean;
- /**
- * If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
-be zero. Defaults to false.
- */
- isBadUV?: boolean;
- /**
- * If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
-be zero. Defaults to false.
- */
- isBadUP?: boolean;
- }
- export type setResponseOverrideBitsReturnValue = {
- }
- /**
- * Removes the given authenticator.
- */
- export type removeVirtualAuthenticatorParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type removeVirtualAuthenticatorReturnValue = {
- }
- /**
- * Adds the credential to the specified authenticator.
- */
- export type addCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- export type addCredentialReturnValue = {
- }
- /**
- * Returns a single credential stored in the given virtual authenticator that
-matches the credential ID.
- */
- export type getCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- export type getCredentialReturnValue = {
- credential: Credential;
- }
- /**
- * Returns all the credentials stored in the given virtual authenticator.
- */
- export type getCredentialsParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type getCredentialsReturnValue = {
- credentials: Credential[];
- }
- /**
- * Removes a credential from the authenticator.
- */
- export type removeCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- export type removeCredentialReturnValue = {
- }
- /**
- * Clears all the credentials from the specified device.
- */
- export type clearCredentialsParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type clearCredentialsReturnValue = {
- }
- /**
- * Sets whether User Verification succeeds or fails for an authenticator.
-The default is true.
- */
- export type setUserVerifiedParameters = {
- authenticatorId: AuthenticatorId;
- isUserVerified: boolean;
- }
- export type setUserVerifiedReturnValue = {
- }
- /**
- * Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
-The default is true.
- */
- export type setAutomaticPresenceSimulationParameters = {
- authenticatorId: AuthenticatorId;
- enabled: boolean;
- }
- export type setAutomaticPresenceSimulationReturnValue = {
- }
- /**
- * Allows setting credential properties.
-https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties
- */
- export type setCredentialPropertiesParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- backupEligibility?: boolean;
- backupState?: boolean;
- }
- export type setCredentialPropertiesReturnValue = {
- }
- }
-
- /**
- * This domain allows detailed inspection of media elements
- */
- export module Media {
- /**
- * Players will get an ID that is unique within the agent context.
- */
- export type PlayerId = string;
- export type Timestamp = number;
- /**
- * Have one type per entry in MediaLogRecord::Type
-Corresponds to kMessage
- */
- export interface PlayerMessage {
- /**
- * Keep in sync with MediaLogMessageLevel
-We are currently keeping the message level 'error' separate from the
-PlayerError type because right now they represent different things,
-this one being a DVLOG(ERROR) style log message that gets printed
-based on what log level is selected in the UI, and the other is a
-representation of a media::PipelineStatus object. Soon however we're
-going to be moving away from using PipelineStatus for errors and
-introducing a new error type which should hopefully let us integrate
-the error log level into the PlayerError type.
- */
- level: "error"|"warning"|"info"|"debug";
- message: string;
- }
- /**
- * Corresponds to kMediaPropertyChange
- */
- export interface PlayerProperty {
- name: string;
- value: string;
- }
- /**
- * Corresponds to kMediaEventTriggered
- */
- export interface PlayerEvent {
- timestamp: Timestamp;
- value: string;
- }
- /**
- * Represents logged source line numbers reported in an error.
-NOTE: file and line are from chromium c++ implementation code, not js.
- */
- export interface PlayerErrorSourceLocation {
- file: string;
- line: number;
- }
- /**
- * Corresponds to kMediaError
- */
- export interface PlayerError {
- errorType: string;
- /**
- * Code is the numeric enum entry for a specific set of error codes, such
-as PipelineStatusCodes in media/base/pipeline_status.h
- */
- code: number;
- /**
- * A trace of where this error was caused / where it passed through.
- */
- stack: PlayerErrorSourceLocation[];
- /**
- * Errors potentially have a root cause error, ie, a DecoderError might be
-caused by an WindowsError
- */
- cause: PlayerError[];
- /**
- * Extra data attached to an error, such as an HRESULT, Video Codec, etc.
- */
- data: { [key: string]: string };
- }
-
- /**
- * This can be called multiple times, and can be used to set / override /
-remove player properties. A null propValue indicates removal.
- */
- export type playerPropertiesChangedPayload = {
- playerId: PlayerId;
- properties: PlayerProperty[];
- }
- /**
- * Send events as a list, allowing them to be batched on the browser for less
-congestion. If batched, events must ALWAYS be in chronological order.
- */
- export type playerEventsAddedPayload = {
- playerId: PlayerId;
- events: PlayerEvent[];
- }
- /**
- * Send a list of any messages that need to be delivered.
- */
- export type playerMessagesLoggedPayload = {
- playerId: PlayerId;
- messages: PlayerMessage[];
- }
- /**
- * Send a list of any errors that need to be delivered.
- */
- export type playerErrorsRaisedPayload = {
- playerId: PlayerId;
- errors: PlayerError[];
- }
- /**
- * Called whenever a player is created, or when a new agent joins and receives
-a list of active players. If an agent is restored, it will receive the full
-list of player ids and all events again.
- */
- export type playersCreatedPayload = {
- players: PlayerId[];
- }
-
- /**
- * Enables the Media domain
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disables the Media domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- }
-
- export module DeviceAccess {
- /**
- * Device request id.
- */
- export type RequestId = string;
- /**
- * A device id.
- */
- export type DeviceId = string;
- /**
- * Device information displayed in a user prompt to select a device.
- */
- export interface PromptDevice {
- id: DeviceId;
- /**
- * Display name as it appears in a device request user prompt.
- */
- name: string;
- }
-
- /**
- * A device request opened a user prompt to select a device. Respond with the
-selectPrompt or cancelPrompt command.
- */
- export type deviceRequestPromptedPayload = {
- id: RequestId;
- devices: PromptDevice[];
- }
-
- /**
- * Enable events in this domain.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disable events in this domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Select a device in response to a DeviceAccess.deviceRequestPrompted event.
- */
- export type selectPromptParameters = {
- id: RequestId;
- deviceId: DeviceId;
- }
- export type selectPromptReturnValue = {
- }
- /**
- * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
- */
- export type cancelPromptParameters = {
- id: RequestId;
- }
- export type cancelPromptReturnValue = {
- }
- }
-
- export module Preload {
- /**
- * Unique id
- */
- export type RuleSetId = string;
- /**
- * Corresponds to SpeculationRuleSet
- */
- export interface RuleSet {
- id: RuleSetId;
- /**
- * Identifies a document which the rule set is associated with.
- */
- loaderId: Network.LoaderId;
- /**
- * Source text of JSON representing the rule set. If it comes from
-`<script>` tag, it is the textContent of the node. Note that it is
-a JSON for valid case.
-
-See also:
-- https://wicg.github.io/nav-speculation/speculation-rules.html
-- https://github.com/WICG/nav-speculation/blob/main/triggers.md
- */
- sourceText: string;
- /**
- * A speculation rule set is either added through an inline
-`<script>` tag or through an external resource via the
-'Speculation-Rules' HTTP header. For the first case, we include
-the BackendNodeId of the relevant `<script>` tag. For the second
-case, we include the external URL where the rule set was loaded
-from, and also RequestId if Network domain is enabled.
-
-See also:
-- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
-- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
- */
- backendNodeId?: DOM.BackendNodeId;
- url?: string;
- requestId?: Network.RequestId;
- /**
- * Error information
-`errorMessage` is null iff `errorType` is null.
- */
- errorType?: RuleSetErrorType;
- /**
- * TODO(https://crbug.com/1425354): Replace this property with structured error.
- */
- errorMessage?: string;
- }
- export type RuleSetErrorType = "SourceIsNotJsonObject"|"InvalidRulesSkipped"|"InvalidRulesetLevelTag";
- /**
- * The type of preloading attempted. It corresponds to
-mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
-isn't being used by clients).
- */
- export type SpeculationAction = "Prefetch"|"Prerender";
- /**
- * Corresponds to mojom::SpeculationTargetHint.
-See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
- */
- export type SpeculationTargetHint = "Blank"|"Self";
- /**
- * A key that identifies a preloading attempt.
-
-The url used is the url specified by the trigger (i.e. the initial URL), and
-not the final url that is navigated to. For example, prerendering allows
-same-origin main frame navigations during the attempt, but the attempt is
-still keyed with the initial URL.
- */
- export interface PreloadingAttemptKey {
- loaderId: Network.LoaderId;
- action: SpeculationAction;
- url: string;
- targetHint?: SpeculationTargetHint;
- }
- /**
- * Lists sources for a preloading attempt, specifically the ids of rule sets
-that had a speculation rule that triggered the attempt, and the
-BackendNodeIds of <a href> or <area href> elements that triggered the
-attempt (in the case of attempts triggered by a document rule). It is
-possible for multiple rule sets and links to trigger a single attempt.
- */
- export interface PreloadingAttemptSource {
- key: PreloadingAttemptKey;
- ruleSetIds: RuleSetId[];
- nodeIds: DOM.BackendNodeId[];
- }
- /**
- * Chrome manages different types of preloads together using a
-concept of preloading pipeline. For example, if a site uses a
-SpeculationRules for prerender, Chrome first starts a prefetch and
-then upgrades it to prerender.
-
-CDP events for them are emitted separately but they share
-`PreloadPipelineId`.
- */
- export type PreloadPipelineId = string;
- /**
- * List of FinalStatus reasons for Prerender2.
- */
- export type PrerenderFinalStatus = "Activated"|"Destroyed"|"LowEndDevice"|"InvalidSchemeRedirect"|"InvalidSchemeNavigation"|"NavigationRequestBlockedByCsp"|"MojoBinderPolicy"|"RendererProcessCrashed"|"RendererProcessKilled"|"Download"|"TriggerDestroyed"|"NavigationNotCommitted"|"NavigationBadHttpStatus"|"ClientCertRequested"|"NavigationRequestNetworkError"|"CancelAllHostsForTesting"|"DidFailLoad"|"Stop"|"SslCertificateError"|"LoginAuthRequested"|"UaChangeRequiresReload"|"BlockedByClient"|"AudioOutputDeviceRequested"|"MixedContent"|"TriggerBackgrounded"|"MemoryLimitExceeded"|"DataSaverEnabled"|"TriggerUrlHasEffectiveUrl"|"ActivatedBeforeStarted"|"InactivePageRestriction"|"StartFailed"|"TimeoutBackgrounded"|"CrossSiteRedirectInInitialNavigation"|"CrossSiteNavigationInInitialNavigation"|"SameSiteCrossOriginRedirectNotOptInInInitialNavigation"|"SameSiteCrossOriginNavigationNotOptInInInitialNavigation"|"ActivationNavigationParameterMismatch"|"ActivatedInBackground"|"EmbedderHostDisallowed"|"ActivationNavigationDestroyedBeforeSuccess"|"TabClosedByUserGesture"|"TabClosedWithoutUserGesture"|"PrimaryMainFrameRendererProcessCrashed"|"PrimaryMainFrameRendererProcessKilled"|"ActivationFramePolicyNotCompatible"|"PreloadingDisabled"|"BatterySaverEnabled"|"ActivatedDuringMainFrameNavigation"|"PreloadingUnsupportedByWebContents"|"CrossSiteRedirectInMainFrameNavigation"|"CrossSiteNavigationInMainFrameNavigation"|"SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation"|"SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation"|"MemoryPressureOnTrigger"|"MemoryPressureAfterTriggered"|"PrerenderingDisabledByDevTools"|"SpeculationRuleRemoved"|"ActivatedWithAuxiliaryBrowsingContexts"|"MaxNumOfRunningEagerPrerendersExceeded"|"MaxNumOfRunningNonEagerPrerendersExceeded"|"MaxNumOfRunningEmbedderPrerendersExceeded"|"PrerenderingUrlHasEffectiveUrl"|"RedirectedPrerenderingUrlHasEffectiveUrl"|"ActivationUrlHasEffectiveUrl"|"JavaScriptInterfaceAdded"|"JavaScriptInterfaceRemoved"|"AllPrerenderingCanceled"|"WindowClosed"|"SlowNetwork"|"OtherPrerenderedPageActivated"|"V8OptimizerDisabled"|"PrerenderFailedDuringPrefetch"|"BrowsingDataRemoved"|"PrerenderHostReused";
- /**
- * Preloading status values, see also PreloadingTriggeringOutcome. This
-status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
- */
- export type PreloadingStatus = "Pending"|"Running"|"Ready"|"Success"|"Failure"|"NotSupported";
- /**
- * TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
-filter out the ones that aren't necessary to the developers.
- */
- export type PrefetchStatus = "PrefetchAllowed"|"PrefetchFailedIneligibleRedirect"|"PrefetchFailedInvalidRedirect"|"PrefetchFailedMIMENotSupported"|"PrefetchFailedNetError"|"PrefetchFailedNon2XX"|"PrefetchEvictedAfterBrowsingDataRemoved"|"PrefetchEvictedAfterCandidateRemoved"|"PrefetchEvictedForNewerPrefetch"|"PrefetchHeldback"|"PrefetchIneligibleRetryAfter"|"PrefetchIsPrivacyDecoy"|"PrefetchIsStale"|"PrefetchNotEligibleBrowserContextOffTheRecord"|"PrefetchNotEligibleDataSaverEnabled"|"PrefetchNotEligibleExistingProxy"|"PrefetchNotEligibleHostIsNonUnique"|"PrefetchNotEligibleNonDefaultStoragePartition"|"PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy"|"PrefetchNotEligibleSchemeIsNotHttps"|"PrefetchNotEligibleUserHasCookies"|"PrefetchNotEligibleUserHasServiceWorker"|"PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler"|"PrefetchNotEligibleRedirectFromServiceWorker"|"PrefetchNotEligibleRedirectToServiceWorker"|"PrefetchNotEligibleBatterySaverEnabled"|"PrefetchNotEligiblePreloadingDisabled"|"PrefetchNotFinishedInTime"|"PrefetchNotStarted"|"PrefetchNotUsedCookiesChanged"|"PrefetchProxyNotAvailable"|"PrefetchResponseUsed"|"PrefetchSuccessfulButNotUsed"|"PrefetchNotUsedProbeFailed";
- /**
- * Information of headers to be displayed when the header mismatch occurred.
- */
- export interface PrerenderMismatchedHeaders {
- headerName: string;
- initialValue?: string;
- activationValue?: string;
- }
-
- /**
- * Upsert. Currently, it is only emitted when a rule set added.
- */
- export type ruleSetUpdatedPayload = {
- ruleSet: RuleSet;
- }
- export type ruleSetRemovedPayload = {
- id: RuleSetId;
- }
- /**
- * Fired when a preload enabled state is updated.
- */
- export type preloadEnabledStateUpdatedPayload = {
- disabledByPreference: boolean;
- disabledByDataSaver: boolean;
- disabledByBatterySaver: boolean;
- disabledByHoldbackPrefetchSpeculationRules: boolean;
- disabledByHoldbackPrerenderSpeculationRules: boolean;
- }
- /**
- * Fired when a prefetch attempt is updated.
- */
- export type prefetchStatusUpdatedPayload = {
- key: PreloadingAttemptKey;
- pipelineId: PreloadPipelineId;
- /**
- * The frame id of the frame initiating prefetch.
- */
- initiatingFrameId: Page.FrameId;
- prefetchUrl: string;
- status: PreloadingStatus;
- prefetchStatus: PrefetchStatus;
- requestId: Network.RequestId;
- }
- /**
- * Fired when a prerender attempt is updated.
- */
- export type prerenderStatusUpdatedPayload = {
- key: PreloadingAttemptKey;
- pipelineId: PreloadPipelineId;
- status: PreloadingStatus;
- prerenderStatus?: PrerenderFinalStatus;
- /**
- * This is used to give users more information about the name of Mojo interface
-that is incompatible with prerender and has caused the cancellation of the attempt.
- */
- disallowedMojoInterface?: string;
- mismatchedHeaders?: PrerenderMismatchedHeaders[];
- }
- /**
- * Send a list of sources for all preloading attempts in a document.
- */
- export type preloadingAttemptSourcesUpdatedPayload = {
- loaderId: Network.LoaderId;
- preloadingAttemptSources: PreloadingAttemptSource[];
- }
-
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- }
-
- /**
- * This domain allows interacting with the FedCM dialog.
- */
- export module FedCm {
- /**
- * Whether this is a sign-up or sign-in action for this account, i.e.
-whether this account has ever been used to sign in to this RP before.
- */
- export type LoginState = "SignIn"|"SignUp";
- /**
- * The types of FedCM dialogs.
- */
- export type DialogType = "AccountChooser"|"AutoReauthn"|"ConfirmIdpLogin"|"Error";
- /**
- * The buttons on the FedCM dialog.
- */
- export type DialogButton = "ConfirmIdpLoginContinue"|"ErrorGotIt"|"ErrorMoreDetails";
- /**
- * The URLs that each account has
- */
- export type AccountUrlType = "TermsOfService"|"PrivacyPolicy";
- /**
- * Corresponds to IdentityRequestAccount
- */
- export interface Account {
- accountId: string;
- email: string;
- name: string;
- givenName: string;
- pictureUrl: string;
- idpConfigUrl: string;
- idpLoginUrl: string;
- loginState: LoginState;
- /**
- * These two are only set if the loginState is signUp
- */
- termsOfServiceUrl?: string;
- privacyPolicyUrl?: string;
- }
-
- export type dialogShownPayload = {
- dialogId: string;
- dialogType: DialogType;
- accounts: Account[];
- /**
- * These exist primarily so that the caller can verify the
-RP context was used appropriately.
- */
- title: string;
- subtitle?: string;
- }
- /**
- * Triggered when a dialog is closed, either by user action, JS abort,
-or a command below.
- */
- export type dialogClosedPayload = {
- dialogId: string;
- }
-
- export type enableParameters = {
- /**
- * Allows callers to disable the promise rejection delay that would
-normally happen, if this is unimportant to what's being tested.
-(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
- */
- disableRejectionDelay?: boolean;
- }
- export type enableReturnValue = {
- }
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- export type selectAccountParameters = {
- dialogId: string;
- accountIndex: number;
- }
- export type selectAccountReturnValue = {
- }
- export type clickDialogButtonParameters = {
- dialogId: string;
- dialogButton: DialogButton;
- }
- export type clickDialogButtonReturnValue = {
- }
- export type openUrlParameters = {
- dialogId: string;
- accountIndex: number;
- accountUrlType: AccountUrlType;
- }
- export type openUrlReturnValue = {
- }
- export type dismissDialogParameters = {
- dialogId: string;
- triggerCooldown?: boolean;
- }
- export type dismissDialogReturnValue = {
- }
- /**
- * Resets the cooldown time, if any, to allow the next FedCM call to show
-a dialog even if one was recently dismissed by the user.
- */
- export type resetCooldownParameters = {
- }
- export type resetCooldownReturnValue = {
- }
- }
-
- /**
- * This domain allows interacting with the browser to control PWAs.
- */
- export module PWA {
- /**
- * The following types are the replica of
-https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
- */
- export interface FileHandlerAccept {
- /**
- * New name of the mimetype according to
-https://www.iana.org/assignments/media-types/media-types.xhtml
- */
- mediaType: string;
- fileExtensions: string[];
- }
- export interface FileHandler {
- action: string;
- accepts: FileHandlerAccept[];
- displayName: string;
- }
- /**
- * If user prefers opening the app in browser or an app window.
- */
- export type DisplayMode = "standalone"|"browser";
-
-
- /**
- * Returns the following OS state for the given manifest id.
- */
- export type getOsAppStateParameters = {
- /**
- * The id from the webapp's manifest file, commonly it's the url of the
-site installing the webapp. See
-https://web.dev/learn/pwa/web-app-manifest.
- */
- manifestId: string;
- }
- export type getOsAppStateReturnValue = {
- badgeCount: number;
- fileHandlers: FileHandler[];
- }
- /**
- * Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
-
-IWA-specific install description:
-manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
-
-File installation mode:
-The installUrlOrBundleUrl can be either file:// or http(s):// pointing
-to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to
-The .swbn file's signing key.
-
-Dev proxy installation mode:
-installUrlOrBundleUrl must be http(s):// that serves dev mode IWA.
-web_package::SignedWebBundleId must be of type dev proxy.
-
-The advantage of dev proxy mode is that all changes to IWA
-automatically will be reflected in the running app without
-reinstallation.
-
-To generate bundle id for proxy mode:
-1. Generate 32 random bytes.
-2. Add a specific suffix 0x00 at the end.
-3. Encode the entire sequence using Base32 without padding.
-
-If Chrome is not in IWA dev
-mode, the installation will fail, regardless of the state of the allowlist.
- */
- export type installParameters = {
- manifestId: string;
- /**
- * The location of the app or bundle overriding the one derived from the
-manifestId.
- */
- installUrlOrBundleUrl?: string;
- }
- export type installReturnValue = {
- }
- /**
- * Uninstalls the given manifest_id and closes any opened app windows.
- */
- export type uninstallParameters = {
- manifestId: string;
- }
- export type uninstallReturnValue = {
- }
- /**
- * Launches the installed web app, or an url in the same web app instead of the
-default start url if it is provided. Returns a page Target.TargetID which
-can be used to attach to via Target.attachToTarget or similar APIs.
- */
- export type launchParameters = {
- manifestId: string;
- url?: string;
- }
- export type launchReturnValue = {
- /**
- * ID of the tab target created as a result.
- */
- targetId: Target.TargetID;
- }
- /**
- * Opens one or more local files from an installed web app identified by its
-manifestId. The web app needs to have file handlers registered to process
-the files. The API returns one or more page Target.TargetIDs which can be
-used to attach to via Target.attachToTarget or similar APIs.
-If some files in the parameters cannot be handled by the web app, they will
-be ignored. If none of the files can be handled, this API returns an error.
-If no files are provided as the parameter, this API also returns an error.
-
-According to the definition of the file handlers in the manifest file, one
-Target.TargetID may represent a page handling one or more files. The order
-of the returned Target.TargetIDs is not guaranteed.
-
-TODO(crbug.com/339454034): Check the existences of the input files.
- */
- export type launchFilesInAppParameters = {
- manifestId: string;
- files: string[];
- }
- export type launchFilesInAppReturnValue = {
- /**
- * IDs of the tab targets created as the result.
- */
- targetIds: Target.TargetID[];
- }
- /**
- * Opens the current page in its web app identified by the manifest id, needs
-to be called on a page target. This function returns immediately without
-waiting for the app to finish loading.
- */
- export type openCurrentPageInAppParameters = {
- manifestId: string;
- }
- export type openCurrentPageInAppReturnValue = {
- }
- /**
- * Changes user settings of the web app identified by its manifestId. If the
-app was not installed, this command returns an error. Unset parameters will
-be ignored; unrecognized values will cause an error.
-
-Unlike the ones defined in the manifest files of the web apps, these
-settings are provided by the browser and controlled by the users, they
-impact the way the browser handling the web apps.
-
-See the comment of each parameter.
- */
- export type changeAppUserSettingsParameters = {
- manifestId: string;
- /**
- * If user allows the links clicked on by the user in the app's scope, or
-extended scope if the manifest has scope extensions and the flags
-`DesktopPWAsLinkCapturingWithScopeExtensions` and
-`WebAppEnableScopeExtensions` are enabled.
-
-Note, the API does not support resetting the linkCapturing to the
-initial value, uninstalling and installing the web app again will reset
-it.
-
-TODO(crbug.com/339453269): Setting this value on ChromeOS is not
-supported yet.
- */
- linkCapturing?: boolean;
- displayMode?: DisplayMode;
- }
- export type changeAppUserSettingsReturnValue = {
- }
- }
-
- /**
- * This domain allows configuring virtual Bluetooth devices to test
-the web-bluetooth API.
- */
- export module BluetoothEmulation {
- /**
- * Indicates the various states of Central.
- */
- export type CentralState = "absent"|"powered-off"|"powered-on";
- /**
- * Indicates the various types of GATT event.
- */
- export type GATTOperationType = "connection"|"discovery";
- /**
- * Indicates the various types of characteristic write.
- */
- export type CharacteristicWriteType = "write-default-deprecated"|"write-with-response"|"write-without-response";
- /**
- * Indicates the various types of characteristic operation.
- */
- export type CharacteristicOperationType = "read"|"write"|"subscribe-to-notifications"|"unsubscribe-from-notifications";
- /**
- * Indicates the various types of descriptor operation.
- */
- export type DescriptorOperationType = "read"|"write";
- /**
- * Stores the manufacturer data
- */
- export interface ManufacturerData {
- /**
- * Company identifier
-https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml
-https://usb.org/developers
- */
- key: number;
- /**
- * Manufacturer-specific data
- */
- data: binary;
- }
- /**
- * Stores the byte data of the advertisement packet sent by a Bluetooth device.
- */
- export interface ScanRecord {
- name?: string;
- uuids?: string[];
- /**
- * Stores the external appearance description of the device.
- */
- appearance?: number;
- /**
- * Stores the transmission power of a broadcasting device.
- */
- txPower?: number;
- /**
- * Key is the company identifier and the value is an array of bytes of
-manufacturer specific data.
- */
- manufacturerData?: ManufacturerData[];
- }
- /**
- * Stores the advertisement packet information that is sent by a Bluetooth device.
- */
- export interface ScanEntry {
- deviceAddress: string;
- rssi: number;
- scanRecord: ScanRecord;
+ * The credential's user.displayName property. Equivalent to empty if
+not set.
+https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname
+ */
+ userDisplayName?: string;
}
+
/**
- * Describes the properties of a characteristic. This follows Bluetooth Core
-Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.
+ * Triggered when a credential is added to an authenticator.
*/
- export interface CharacteristicProperties {
- broadcast?: boolean;
- read?: boolean;
- writeWithoutResponse?: boolean;
- write?: boolean;
- notify?: boolean;
- indicate?: boolean;
- authenticatedSignedWrites?: boolean;
- extendedProperties?: boolean;
+ export type credentialAddedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
-
/**
- * Event for when a GATT operation of |type| to the peripheral with |address|
-happened.
+ * Triggered when a credential is deleted, e.g. through
+PublicKeyCredential.signalUnknownCredential().
*/
- export type gattOperationReceivedPayload = {
- address: string;
- type: GATTOperationType;
+ export type credentialDeletedPayload = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
/**
- * Event for when a characteristic operation of |type| to the characteristic
-respresented by |characteristicId| happened. |data| and |writeType| is
-expected to exist when |type| is write.
+ * Triggered when a credential is updated, e.g. through
+PublicKeyCredential.signalCurrentUserDetails().
*/
- export type characteristicOperationReceivedPayload = {
- characteristicId: string;
- type: CharacteristicOperationType;
- data?: binary;
- writeType?: CharacteristicWriteType;
+ export type credentialUpdatedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
/**
- * Event for when a descriptor operation of |type| to the descriptor
-respresented by |descriptorId| happened. |data| is expected to exist when
-|type| is write.
+ * Triggered when a credential is used in a webauthn assertion.
*/
- export type descriptorOperationReceivedPayload = {
- descriptorId: string;
- type: DescriptorOperationType;
- data?: binary;
+ export type credentialAssertedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
/**
- * Enable the BluetoothEmulation domain.
+ * Enable the WebAuthn domain and start intercepting credential storage and
+retrieval with a virtual authenticator.
*/
export type enableParameters = {
/**
- * State of the simulated central.
- */
- state: CentralState;
- /**
- * If the simulated central supports low-energy.
+ * Whether to enable the WebAuthn user interface. Enabling the UI is
+recommended for debugging and demo purposes, as it is closer to the real
+experience. Disabling the UI is recommended for automated testing.
+Supported at the embedder's discretion if UI is available.
+Defaults to false.
*/
- leSupported: boolean;
+ enableUI?: boolean;
}
export type enableReturnValue = {
}
/**
- * Set the state of the simulated central.
- */
- export type setSimulatedCentralStateParameters = {
- /**
- * State of the simulated central.
- */
- state: CentralState;
- }
- export type setSimulatedCentralStateReturnValue = {
- }
- /**
- * Disable the BluetoothEmulation domain.
+ * Disable the WebAuthn domain.
*/
export type disableParameters = {
}
export type disableReturnValue = {
}
/**
- * Simulates a peripheral with |address|, |name| and |knownServiceUuids|
-that has already been connected to the system.
- */
- export type simulatePreconnectedPeripheralParameters = {
- address: string;
- name: string;
- manufacturerData: ManufacturerData[];
- knownServiceUuids: string[];
- }
- export type simulatePreconnectedPeripheralReturnValue = {
- }
- /**
- * Simulates an advertisement packet described in |entry| being received by
-the central.
+ * Creates and adds a virtual authenticator.
*/
- export type simulateAdvertisementParameters = {
- entry: ScanEntry;
+ export type addVirtualAuthenticatorParameters = {
+ options: VirtualAuthenticatorOptions;
}
- export type simulateAdvertisementReturnValue = {
+ export type addVirtualAuthenticatorReturnValue = {
+ authenticatorId: AuthenticatorId;
}
/**
- * Simulates the response code from the peripheral with |address| for a
-GATT operation of |type|. The |code| value follows the HCI Error Codes from
-Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes.
+ * Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
*/
- export type simulateGATTOperationResponseParameters = {
- address: string;
- type: GATTOperationType;
- code: number;
+ export type setResponseOverrideBitsParameters = {
+ authenticatorId: AuthenticatorId;
+ /**
+ * If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
+Defaults to false.
+ */
+ isBogusSignature?: boolean;
+ /**
+ * If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
+be zero. Defaults to false.
+ */
+ isBadUV?: boolean;
+ /**
+ * If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
+be zero. Defaults to false.
+ */
+ isBadUP?: boolean;
}
- export type simulateGATTOperationResponseReturnValue = {
+ export type setResponseOverrideBitsReturnValue = {
}
/**
- * Simulates the response from the characteristic with |characteristicId| for a
-characteristic operation of |type|. The |code| value follows the Error
-Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
-The |data| is expected to exist when simulating a successful read operation
-response.
+ * Removes the given authenticator.
*/
- export type simulateCharacteristicOperationResponseParameters = {
- characteristicId: string;
- type: CharacteristicOperationType;
- code: number;
- data?: binary;
+ export type removeVirtualAuthenticatorParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type simulateCharacteristicOperationResponseReturnValue = {
+ export type removeVirtualAuthenticatorReturnValue = {
}
/**
- * Simulates the response from the descriptor with |descriptorId| for a
-descriptor operation of |type|. The |code| value follows the Error
-Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
-The |data| is expected to exist when simulating a successful read operation
-response.
+ * Adds the credential to the specified authenticator.
*/
- export type simulateDescriptorOperationResponseParameters = {
- descriptorId: string;
- type: DescriptorOperationType;
- code: number;
- data?: binary;
+ export type addCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
- export type simulateDescriptorOperationResponseReturnValue = {
+ export type addCredentialReturnValue = {
}
/**
- * Adds a service with |serviceUuid| to the peripheral with |address|.
+ * Returns a single credential stored in the given virtual authenticator that
+matches the credential ID.
*/
- export type addServiceParameters = {
- address: string;
- serviceUuid: string;
+ export type getCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
- export type addServiceReturnValue = {
- /**
- * An identifier that uniquely represents this service.
- */
- serviceId: string;
+ export type getCredentialReturnValue = {
+ credential: Credential;
}
/**
- * Removes the service respresented by |serviceId| from the simulated central.
+ * Returns all the credentials stored in the given virtual authenticator.
*/
- export type removeServiceParameters = {
- serviceId: string;
+ export type getCredentialsParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type removeServiceReturnValue = {
+ export type getCredentialsReturnValue = {
+ credentials: Credential[];
}
/**
- * Adds a characteristic with |characteristicUuid| and |properties| to the
-service represented by |serviceId|.
+ * Removes a credential from the authenticator.
*/
- export type addCharacteristicParameters = {
- serviceId: string;
- characteristicUuid: string;
- properties: CharacteristicProperties;
+ export type removeCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
- export type addCharacteristicReturnValue = {
- /**
- * An identifier that uniquely represents this characteristic.
- */
- characteristicId: string;
+ export type removeCredentialReturnValue = {
}
/**
- * Removes the characteristic respresented by |characteristicId| from the
-simulated central.
+ * Clears all the credentials from the specified device.
*/
- export type removeCharacteristicParameters = {
- characteristicId: string;
+ export type clearCredentialsParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type removeCharacteristicReturnValue = {
+ export type clearCredentialsReturnValue = {
}
/**
- * Adds a descriptor with |descriptorUuid| to the characteristic respresented
-by |characteristicId|.
+ * Sets whether User Verification succeeds or fails for an authenticator.
+The default is true.
*/
- export type addDescriptorParameters = {
- characteristicId: string;
- descriptorUuid: string;
+ export type setUserVerifiedParameters = {
+ authenticatorId: AuthenticatorId;
+ isUserVerified: boolean;
}
- export type addDescriptorReturnValue = {
- /**
- * An identifier that uniquely represents this descriptor.
- */
- descriptorId: string;
+ export type setUserVerifiedReturnValue = {
}
/**
- * Removes the descriptor with |descriptorId| from the simulated central.
+ * Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
+The default is true.
*/
- export type removeDescriptorParameters = {
- descriptorId: string;
+ export type setAutomaticPresenceSimulationParameters = {
+ authenticatorId: AuthenticatorId;
+ enabled: boolean;
}
- export type removeDescriptorReturnValue = {
+ export type setAutomaticPresenceSimulationReturnValue = {
}
/**
- * Simulates a GATT disconnection from the peripheral with |address|.
+ * Allows setting credential properties.
+https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties
*/
- export type simulateGATTDisconnectionParameters = {
- address: string;
+ export type setCredentialPropertiesParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
+ backupEligibility?: boolean;
+ backupState?: boolean;
}
- export type simulateGATTDisconnectionReturnValue = {
+ export type setCredentialPropertiesReturnValue = {
}
}
@@ -21430,6 +21636,9 @@ Error was thrown.
"Autofill.addressFormFilled": Autofill.addressFormFilledPayload;
"BackgroundService.recordingStateChanged": BackgroundService.recordingStateChangedPayload;
"BackgroundService.backgroundServiceEventReceived": BackgroundService.backgroundServiceEventReceivedPayload;
+ "BluetoothEmulation.gattOperationReceived": BluetoothEmulation.gattOperationReceivedPayload;
+ "BluetoothEmulation.characteristicOperationReceived": BluetoothEmulation.characteristicOperationReceivedPayload;
+ "BluetoothEmulation.descriptorOperationReceived": BluetoothEmulation.descriptorOperationReceivedPayload;
"Browser.downloadWillBegin": Browser.downloadWillBeginPayload;
"Browser.downloadProgress": Browser.downloadProgressPayload;
"CSS.fontsUpdated": CSS.fontsUpdatedPayload;
@@ -21460,7 +21669,12 @@ Error was thrown.
"DOMStorage.domStorageItemRemoved": DOMStorage.domStorageItemRemovedPayload;
"DOMStorage.domStorageItemUpdated": DOMStorage.domStorageItemUpdatedPayload;
"DOMStorage.domStorageItemsCleared": DOMStorage.domStorageItemsClearedPayload;
+ "DeviceAccess.deviceRequestPrompted": DeviceAccess.deviceRequestPromptedPayload;
"Emulation.virtualTimeBudgetExpired": Emulation.virtualTimeBudgetExpiredPayload;
+ "FedCm.dialogShown": FedCm.dialogShownPayload;
+ "FedCm.dialogClosed": FedCm.dialogClosedPayload;
+ "Fetch.requestPaused": Fetch.requestPausedPayload;
+ "Fetch.authRequired": Fetch.authRequiredPayload;
"Input.dragIntercepted": Input.dragInterceptedPayload;
"Inspector.detached": Inspector.detachedPayload;
"Inspector.targetCrashed": Inspector.targetCrashedPayload;
@@ -21468,6 +21682,11 @@ Error was thrown.
"LayerTree.layerPainted": LayerTree.layerPaintedPayload;
"LayerTree.layerTreeDidChange": LayerTree.layerTreeDidChangePayload;
"Log.entryAdded": Log.entryAddedPayload;
+ "Media.playerPropertiesChanged": Media.playerPropertiesChangedPayload;
+ "Media.playerEventsAdded": Media.playerEventsAddedPayload;
+ "Media.playerMessagesLogged": Media.playerMessagesLoggedPayload;
+ "Media.playerErrorsRaised": Media.playerErrorsRaisedPayload;
+ "Media.playerCreated": Media.playerCreatedPayload;
"Network.dataReceived": Network.dataReceivedPayload;
"Network.eventSourceMessageReceived": Network.eventSourceMessageReceivedPayload;
"Network.loadingFailed": Network.loadingFailedPayload;
@@ -21546,6 +21765,12 @@ Error was thrown.
"Page.compilationCacheProduced": Page.compilationCacheProducedPayload;
"Performance.metrics": Performance.metricsPayload;
"PerformanceTimeline.timelineEventAdded": PerformanceTimeline.timelineEventAddedPayload;
+ "Preload.ruleSetUpdated": Preload.ruleSetUpdatedPayload;
+ "Preload.ruleSetRemoved": Preload.ruleSetRemovedPayload;
+ "Preload.preloadEnabledStateUpdated": Preload.preloadEnabledStateUpdatedPayload;
+ "Preload.prefetchStatusUpdated": Preload.prefetchStatusUpdatedPayload;
+ "Preload.prerenderStatusUpdated": Preload.prerenderStatusUpdatedPayload;
+ "Preload.preloadingAttemptSourcesUpdated": Preload.preloadingAttemptSourcesUpdatedPayload;
"Security.certificateError": Security.certificateErrorPayload;
"Security.visibleSecurityStateChanged": Security.visibleSecurityStateChangedPayload;
"Security.securityStateChanged": Security.securityStateChangedPayload;
@@ -21578,8 +21803,6 @@ Error was thrown.
"Tracing.bufferUsage": Tracing.bufferUsagePayload;
"Tracing.dataCollected": Tracing.dataCollectedPayload;
"Tracing.tracingComplete": Tracing.tracingCompletePayload;
- "Fetch.requestPaused": Fetch.requestPausedPayload;
- "Fetch.authRequired": Fetch.authRequiredPayload;
"WebAudio.contextCreated": WebAudio.contextCreatedPayload;
"WebAudio.contextWillBeDestroyed": WebAudio.contextWillBeDestroyedPayload;
"WebAudio.contextChanged": WebAudio.contextChangedPayload;
@@ -21597,23 +21820,6 @@ Error was thrown.
"WebAuthn.credentialDeleted": WebAuthn.credentialDeletedPayload;
"WebAuthn.credentialUpdated": WebAuthn.credentialUpdatedPayload;
"WebAuthn.credentialAsserted": WebAuthn.credentialAssertedPayload;
- "Media.playerPropertiesChanged": Media.playerPropertiesChangedPayload;
- "Media.playerEventsAdded": Media.playerEventsAddedPayload;
- "Media.playerMessagesLogged": Media.playerMessagesLoggedPayload;
- "Media.playerErrorsRaised": Media.playerErrorsRaisedPayload;
- "Media.playersCreated": Media.playersCreatedPayload;
- "DeviceAccess.deviceRequestPrompted": DeviceAccess.deviceRequestPromptedPayload;
- "Preload.ruleSetUpdated": Preload.ruleSetUpdatedPayload;
- "Preload.ruleSetRemoved": Preload.ruleSetRemovedPayload;
- "Preload.preloadEnabledStateUpdated": Preload.preloadEnabledStateUpdatedPayload;
- "Preload.prefetchStatusUpdated": Preload.prefetchStatusUpdatedPayload;
- "Preload.prerenderStatusUpdated": Preload.prerenderStatusUpdatedPayload;
- "Preload.preloadingAttemptSourcesUpdated": Preload.preloadingAttemptSourcesUpdatedPayload;
- "FedCm.dialogShown": FedCm.dialogShownPayload;
- "FedCm.dialogClosed": FedCm.dialogClosedPayload;
- "BluetoothEmulation.gattOperationReceived": BluetoothEmulation.gattOperationReceivedPayload;
- "BluetoothEmulation.characteristicOperationReceived": BluetoothEmulation.characteristicOperationReceivedPayload;
- "BluetoothEmulation.descriptorOperationReceived": BluetoothEmulation.descriptorOperationReceivedPayload;
"Console.messageAdded": Console.messageAddedPayload;
"Debugger.breakpointResolved": Debugger.breakpointResolvedPayload;
"Debugger.paused": Debugger.pausedPayload;
@@ -21661,12 +21867,6 @@ Error was thrown.
"Audits.enable": Audits.enableParameters;
"Audits.checkContrast": Audits.checkContrastParameters;
"Audits.checkFormsIssues": Audits.checkFormsIssuesParameters;
- "Extensions.loadUnpacked": Extensions.loadUnpackedParameters;
- "Extensions.uninstall": Extensions.uninstallParameters;
- "Extensions.getStorageItems": Extensions.getStorageItemsParameters;
- "Extensions.removeStorageItems": Extensions.removeStorageItemsParameters;
- "Extensions.clearStorageItems": Extensions.clearStorageItemsParameters;
- "Extensions.setStorageItems": Extensions.setStorageItemsParameters;
"Autofill.trigger": Autofill.triggerParameters;
"Autofill.setAddresses": Autofill.setAddressesParameters;
"Autofill.disable": Autofill.disableParameters;
@@ -21675,6 +21875,21 @@ Error was thrown.
"BackgroundService.stopObserving": BackgroundService.stopObservingParameters;
"BackgroundService.setRecording": BackgroundService.setRecordingParameters;
"BackgroundService.clearEvents": BackgroundService.clearEventsParameters;
+ "BluetoothEmulation.enable": BluetoothEmulation.enableParameters;
+ "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateParameters;
+ "BluetoothEmulation.disable": BluetoothEmulation.disableParameters;
+ "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralParameters;
+ "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementParameters;
+ "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseParameters;
+ "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseParameters;
+ "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseParameters;
+ "BluetoothEmulation.addService": BluetoothEmulation.addServiceParameters;
+ "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceParameters;
+ "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicParameters;
+ "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicParameters;
+ "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorParameters;
+ "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorParameters;
+ "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionParameters;
"Browser.setPermission": Browser.setPermissionParameters;
"Browser.grantPermissions": Browser.grantPermissionsParameters;
"Browser.resetPermissions": Browser.resetPermissionsParameters;
@@ -21806,9 +22021,6 @@ Error was thrown.
"DOMDebugger.setEventListenerBreakpoint": DOMDebugger.setEventListenerBreakpointParameters;
"DOMDebugger.setInstrumentationBreakpoint": DOMDebugger.setInstrumentationBreakpointParameters;
"DOMDebugger.setXHRBreakpoint": DOMDebugger.setXHRBreakpointParameters;
- "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointParameters;
- "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointParameters;
- "EventBreakpoints.disable": EventBreakpoints.disableParameters;
"DOMSnapshot.disable": DOMSnapshot.disableParameters;
"DOMSnapshot.enable": DOMSnapshot.enableParameters;
"DOMSnapshot.getSnapshot": DOMSnapshot.getSnapshotParameters;
@@ -21819,6 +22031,10 @@ Error was thrown.
"DOMStorage.getDOMStorageItems": DOMStorage.getDOMStorageItemsParameters;
"DOMStorage.removeDOMStorageItem": DOMStorage.removeDOMStorageItemParameters;
"DOMStorage.setDOMStorageItem": DOMStorage.setDOMStorageItemParameters;
+ "DeviceAccess.enable": DeviceAccess.enableParameters;
+ "DeviceAccess.disable": DeviceAccess.disableParameters;
+ "DeviceAccess.selectPrompt": DeviceAccess.selectPromptParameters;
+ "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptParameters;
"DeviceOrientation.clearDeviceOrientationOverride": DeviceOrientation.clearDeviceOrientationOverrideParameters;
"DeviceOrientation.setDeviceOrientationOverride": DeviceOrientation.setDeviceOrientationOverrideParameters;
"Emulation.canEmulate": Emulation.canEmulateParameters;
@@ -21864,13 +22080,41 @@ Error was thrown.
"Emulation.setUserAgentOverride": Emulation.setUserAgentOverrideParameters;
"Emulation.setAutomationOverride": Emulation.setAutomationOverrideParameters;
"Emulation.setSmallViewportHeightDifferenceOverride": Emulation.setSmallViewportHeightDifferenceOverrideParameters;
+ "Emulation.getScreenInfos": Emulation.getScreenInfosParameters;
+ "Emulation.addScreen": Emulation.addScreenParameters;
+ "Emulation.removeScreen": Emulation.removeScreenParameters;
+ "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointParameters;
+ "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointParameters;
+ "EventBreakpoints.disable": EventBreakpoints.disableParameters;
+ "Extensions.loadUnpacked": Extensions.loadUnpackedParameters;
+ "Extensions.uninstall": Extensions.uninstallParameters;
+ "Extensions.getStorageItems": Extensions.getStorageItemsParameters;
+ "Extensions.removeStorageItems": Extensions.removeStorageItemsParameters;
+ "Extensions.clearStorageItems": Extensions.clearStorageItemsParameters;
+ "Extensions.setStorageItems": Extensions.setStorageItemsParameters;
+ "FedCm.enable": FedCm.enableParameters;
+ "FedCm.disable": FedCm.disableParameters;
+ "FedCm.selectAccount": FedCm.selectAccountParameters;
+ "FedCm.clickDialogButton": FedCm.clickDialogButtonParameters;
+ "FedCm.openUrl": FedCm.openUrlParameters;
+ "FedCm.dismissDialog": FedCm.dismissDialogParameters;
+ "FedCm.resetCooldown": FedCm.resetCooldownParameters;
+ "Fetch.disable": Fetch.disableParameters;
+ "Fetch.enable": Fetch.enableParameters;
+ "Fetch.failRequest": Fetch.failRequestParameters;
+ "Fetch.fulfillRequest": Fetch.fulfillRequestParameters;
+ "Fetch.continueRequest": Fetch.continueRequestParameters;
+ "Fetch.continueWithAuth": Fetch.continueWithAuthParameters;
+ "Fetch.continueResponse": Fetch.continueResponseParameters;
+ "Fetch.getResponseBody": Fetch.getResponseBodyParameters;
+ "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamParameters;
+ "FileSystem.getDirectory": FileSystem.getDirectoryParameters;
"HeadlessExperimental.beginFrame": HeadlessExperimental.beginFrameParameters;
"HeadlessExperimental.disable": HeadlessExperimental.disableParameters;
"HeadlessExperimental.enable": HeadlessExperimental.enableParameters;
"IO.close": IO.closeParameters;
"IO.read": IO.readParameters;
"IO.resolveBlob": IO.resolveBlobParameters;
- "FileSystem.getDirectory": FileSystem.getDirectoryParameters;
"IndexedDB.clearObjectStore": IndexedDB.clearObjectStoreParameters;
"IndexedDB.deleteDatabase": IndexedDB.deleteDatabaseParameters;
"IndexedDB.deleteObjectStoreEntries": IndexedDB.deleteObjectStoreEntriesParameters;
@@ -21909,6 +22153,8 @@ Error was thrown.
"Log.enable": Log.enableParameters;
"Log.startViolationsReport": Log.startViolationsReportParameters;
"Log.stopViolationsReport": Log.stopViolationsReportParameters;
+ "Media.enable": Media.enableParameters;
+ "Media.disable": Media.disableParameters;
"Memory.getDOMCounters": Memory.getDOMCountersParameters;
"Memory.getDOMCountersForLeakDetection": Memory.getDOMCountersForLeakDetectionParameters;
"Memory.prepareForLeakDetection": Memory.prepareForLeakDetectionParameters;
@@ -21920,6 +22166,7 @@ Error was thrown.
"Memory.getAllTimeSamplingProfile": Memory.getAllTimeSamplingProfileParameters;
"Memory.getBrowserSamplingProfile": Memory.getBrowserSamplingProfileParameters;
"Memory.getSamplingProfile": Memory.getSamplingProfileParameters;
+ "Network.getIPProtectionProxyStatus": Network.getIPProtectionProxyStatusParameters;
"Network.setAcceptedEncodings": Network.setAcceptedEncodingsParameters;
"Network.clearAcceptedEncodingsOverride": Network.clearAcceptedEncodingsOverrideParameters;
"Network.canClearBrowserCache": Network.canClearBrowserCacheParameters;
@@ -21984,6 +22231,13 @@ Error was thrown.
"Overlay.setShowHinge": Overlay.setShowHingeParameters;
"Overlay.setShowIsolatedElements": Overlay.setShowIsolatedElementsParameters;
"Overlay.setShowWindowControlsOverlay": Overlay.setShowWindowControlsOverlayParameters;
+ "PWA.getOsAppState": PWA.getOsAppStateParameters;
+ "PWA.install": PWA.installParameters;
+ "PWA.uninstall": PWA.uninstallParameters;
+ "PWA.launch": PWA.launchParameters;
+ "PWA.launchFilesInApp": PWA.launchFilesInAppParameters;
+ "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppParameters;
+ "PWA.changeAppUserSettings": PWA.changeAppUserSettingsParameters;
"Page.addScriptToEvaluateOnLoad": Page.addScriptToEvaluateOnLoadParameters;
"Page.addScriptToEvaluateOnNewDocument": Page.addScriptToEvaluateOnNewDocumentParameters;
"Page.bringToFront": Page.bringToFrontParameters;
@@ -22049,6 +22303,8 @@ Error was thrown.
"Performance.setTimeDomain": Performance.setTimeDomainParameters;
"Performance.getMetrics": Performance.getMetricsParameters;
"PerformanceTimeline.enable": PerformanceTimeline.enableParameters;
+ "Preload.enable": Preload.enableParameters;
+ "Preload.disable": Preload.disableParameters;
"Security.disable": Security.disableParameters;
"Security.enable": Security.enableParameters;
"Security.setIgnoreCertificateErrors": Security.setIgnoreCertificateErrorsParameters;
@@ -22131,15 +22387,6 @@ Error was thrown.
"Tracing.recordClockSyncMarker": Tracing.recordClockSyncMarkerParameters;
"Tracing.requestMemoryDump": Tracing.requestMemoryDumpParameters;
"Tracing.start": Tracing.startParameters;
- "Fetch.disable": Fetch.disableParameters;
- "Fetch.enable": Fetch.enableParameters;
- "Fetch.failRequest": Fetch.failRequestParameters;
- "Fetch.fulfillRequest": Fetch.fulfillRequestParameters;
- "Fetch.continueRequest": Fetch.continueRequestParameters;
- "Fetch.continueWithAuth": Fetch.continueWithAuthParameters;
- "Fetch.continueResponse": Fetch.continueResponseParameters;
- "Fetch.getResponseBody": Fetch.getResponseBodyParameters;
- "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamParameters;
"WebAudio.enable": WebAudio.enableParameters;
"WebAudio.disable": WebAudio.disableParameters;
"WebAudio.getRealtimeData": WebAudio.getRealtimeDataParameters;
@@ -22156,43 +22403,6 @@ Error was thrown.
"WebAuthn.setUserVerified": WebAuthn.setUserVerifiedParameters;
"WebAuthn.setAutomaticPresenceSimulation": WebAuthn.setAutomaticPresenceSimulationParameters;
"WebAuthn.setCredentialProperties": WebAuthn.setCredentialPropertiesParameters;
- "Media.enable": Media.enableParameters;
- "Media.disable": Media.disableParameters;
- "DeviceAccess.enable": DeviceAccess.enableParameters;
- "DeviceAccess.disable": DeviceAccess.disableParameters;
- "DeviceAccess.selectPrompt": DeviceAccess.selectPromptParameters;
- "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptParameters;
- "Preload.enable": Preload.enableParameters;
- "Preload.disable": Preload.disableParameters;
- "FedCm.enable": FedCm.enableParameters;
- "FedCm.disable": FedCm.disableParameters;
- "FedCm.selectAccount": FedCm.selectAccountParameters;
- "FedCm.clickDialogButton": FedCm.clickDialogButtonParameters;
- "FedCm.openUrl": FedCm.openUrlParameters;
- "FedCm.dismissDialog": FedCm.dismissDialogParameters;
- "FedCm.resetCooldown": FedCm.resetCooldownParameters;
- "PWA.getOsAppState": PWA.getOsAppStateParameters;
- "PWA.install": PWA.installParameters;
- "PWA.uninstall": PWA.uninstallParameters;
- "PWA.launch": PWA.launchParameters;
- "PWA.launchFilesInApp": PWA.launchFilesInAppParameters;
- "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppParameters;
- "PWA.changeAppUserSettings": PWA.changeAppUserSettingsParameters;
- "BluetoothEmulation.enable": BluetoothEmulation.enableParameters;
- "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateParameters;
- "BluetoothEmulation.disable": BluetoothEmulation.disableParameters;
- "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralParameters;
- "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementParameters;
- "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseParameters;
- "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseParameters;
- "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseParameters;
- "BluetoothEmulation.addService": BluetoothEmulation.addServiceParameters;
- "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceParameters;
- "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicParameters;
- "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicParameters;
- "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorParameters;
- "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorParameters;
- "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionParameters;
"Console.clearMessages": Console.clearMessagesParameters;
"Console.disable": Console.disableParameters;
"Console.enable": Console.enableParameters;
@@ -22299,12 +22509,6 @@ Error was thrown.
"Audits.enable": Audits.enableReturnValue;
"Audits.checkContrast": Audits.checkContrastReturnValue;
"Audits.checkFormsIssues": Audits.checkFormsIssuesReturnValue;
- "Extensions.loadUnpacked": Extensions.loadUnpackedReturnValue;
- "Extensions.uninstall": Extensions.uninstallReturnValue;
- "Extensions.getStorageItems": Extensions.getStorageItemsReturnValue;
- "Extensions.removeStorageItems": Extensions.removeStorageItemsReturnValue;
- "Extensions.clearStorageItems": Extensions.clearStorageItemsReturnValue;
- "Extensions.setStorageItems": Extensions.setStorageItemsReturnValue;
"Autofill.trigger": Autofill.triggerReturnValue;
"Autofill.setAddresses": Autofill.setAddressesReturnValue;
"Autofill.disable": Autofill.disableReturnValue;
@@ -22313,6 +22517,21 @@ Error was thrown.
"BackgroundService.stopObserving": BackgroundService.stopObservingReturnValue;
"BackgroundService.setRecording": BackgroundService.setRecordingReturnValue;
"BackgroundService.clearEvents": BackgroundService.clearEventsReturnValue;
+ "BluetoothEmulation.enable": BluetoothEmulation.enableReturnValue;
+ "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateReturnValue;
+ "BluetoothEmulation.disable": BluetoothEmulation.disableReturnValue;
+ "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralReturnValue;
+ "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementReturnValue;
+ "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseReturnValue;
+ "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseReturnValue;
+ "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseReturnValue;
+ "BluetoothEmulation.addService": BluetoothEmulation.addServiceReturnValue;
+ "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceReturnValue;
+ "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicReturnValue;
+ "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicReturnValue;
+ "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorReturnValue;
+ "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorReturnValue;
+ "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionReturnValue;
"Browser.setPermission": Browser.setPermissionReturnValue;
"Browser.grantPermissions": Browser.grantPermissionsReturnValue;
"Browser.resetPermissions": Browser.resetPermissionsReturnValue;
@@ -22444,9 +22663,6 @@ Error was thrown.
"DOMDebugger.setEventListenerBreakpoint": DOMDebugger.setEventListenerBreakpointReturnValue;
"DOMDebugger.setInstrumentationBreakpoint": DOMDebugger.setInstrumentationBreakpointReturnValue;
"DOMDebugger.setXHRBreakpoint": DOMDebugger.setXHRBreakpointReturnValue;
- "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointReturnValue;
- "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointReturnValue;
- "EventBreakpoints.disable": EventBreakpoints.disableReturnValue;
"DOMSnapshot.disable": DOMSnapshot.disableReturnValue;
"DOMSnapshot.enable": DOMSnapshot.enableReturnValue;
"DOMSnapshot.getSnapshot": DOMSnapshot.getSnapshotReturnValue;
@@ -22457,6 +22673,10 @@ Error was thrown.
"DOMStorage.getDOMStorageItems": DOMStorage.getDOMStorageItemsReturnValue;
"DOMStorage.removeDOMStorageItem": DOMStorage.removeDOMStorageItemReturnValue;
"DOMStorage.setDOMStorageItem": DOMStorage.setDOMStorageItemReturnValue;
+ "DeviceAccess.enable": DeviceAccess.enableReturnValue;
+ "DeviceAccess.disable": DeviceAccess.disableReturnValue;
+ "DeviceAccess.selectPrompt": DeviceAccess.selectPromptReturnValue;
+ "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptReturnValue;
"DeviceOrientation.clearDeviceOrientationOverride": DeviceOrientation.clearDeviceOrientationOverrideReturnValue;
"DeviceOrientation.setDeviceOrientationOverride": DeviceOrientation.setDeviceOrientationOverrideReturnValue;
"Emulation.canEmulate": Emulation.canEmulateReturnValue;
@@ -22502,13 +22722,41 @@ Error was thrown.
"Emulation.setUserAgentOverride": Emulation.setUserAgentOverrideReturnValue;
"Emulation.setAutomationOverride": Emulation.setAutomationOverrideReturnValue;
"Emulation.setSmallViewportHeightDifferenceOverride": Emulation.setSmallViewportHeightDifferenceOverrideReturnValue;
+ "Emulation.getScreenInfos": Emulation.getScreenInfosReturnValue;
+ "Emulation.addScreen": Emulation.addScreenReturnValue;
+ "Emulation.removeScreen": Emulation.removeScreenReturnValue;
+ "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointReturnValue;
+ "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointReturnValue;
+ "EventBreakpoints.disable": EventBreakpoints.disableReturnValue;
+ "Extensions.loadUnpacked": Extensions.loadUnpackedReturnValue;
+ "Extensions.uninstall": Extensions.uninstallReturnValue;
+ "Extensions.getStorageItems": Extensions.getStorageItemsReturnValue;
+ "Extensions.removeStorageItems": Extensions.removeStorageItemsReturnValue;
+ "Extensions.clearStorageItems": Extensions.clearStorageItemsReturnValue;
+ "Extensions.setStorageItems": Extensions.setStorageItemsReturnValue;
+ "FedCm.enable": FedCm.enableReturnValue;
+ "FedCm.disable": FedCm.disableReturnValue;
+ "FedCm.selectAccount": FedCm.selectAccountReturnValue;
+ "FedCm.clickDialogButton": FedCm.clickDialogButtonReturnValue;
+ "FedCm.openUrl": FedCm.openUrlReturnValue;
+ "FedCm.dismissDialog": FedCm.dismissDialogReturnValue;
+ "FedCm.resetCooldown": FedCm.resetCooldownReturnValue;
+ "Fetch.disable": Fetch.disableReturnValue;
+ "Fetch.enable": Fetch.enableReturnValue;
+ "Fetch.failRequest": Fetch.failRequestReturnValue;
+ "Fetch.fulfillRequest": Fetch.fulfillRequestReturnValue;
+ "Fetch.continueRequest": Fetch.continueRequestReturnValue;
+ "Fetch.continueWithAuth": Fetch.continueWithAuthReturnValue;
+ "Fetch.continueResponse": Fetch.continueResponseReturnValue;
+ "Fetch.getResponseBody": Fetch.getResponseBodyReturnValue;
+ "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamReturnValue;
+ "FileSystem.getDirectory": FileSystem.getDirectoryReturnValue;
"HeadlessExperimental.beginFrame": HeadlessExperimental.beginFrameReturnValue;
"HeadlessExperimental.disable": HeadlessExperimental.disableReturnValue;
"HeadlessExperimental.enable": HeadlessExperimental.enableReturnValue;
"IO.close": IO.closeReturnValue;
"IO.read": IO.readReturnValue;
"IO.resolveBlob": IO.resolveBlobReturnValue;
- "FileSystem.getDirectory": FileSystem.getDirectoryReturnValue;
"IndexedDB.clearObjectStore": IndexedDB.clearObjectStoreReturnValue;
"IndexedDB.deleteDatabase": IndexedDB.deleteDatabaseReturnValue;
"IndexedDB.deleteObjectStoreEntries": IndexedDB.deleteObjectStoreEntriesReturnValue;
@@ -22547,6 +22795,8 @@ Error was thrown.
"Log.enable": Log.enableReturnValue;
"Log.startViolationsReport": Log.startViolationsReportReturnValue;
"Log.stopViolationsReport": Log.stopViolationsReportReturnValue;
+ "Media.enable": Media.enableReturnValue;
+ "Media.disable": Media.disableReturnValue;
"Memory.getDOMCounters": Memory.getDOMCountersReturnValue;
"Memory.getDOMCountersForLeakDetection": Memory.getDOMCountersForLeakDetectionReturnValue;
"Memory.prepareForLeakDetection": Memory.prepareForLeakDetectionReturnValue;
@@ -22558,6 +22808,7 @@ Error was thrown.
"Memory.getAllTimeSamplingProfile": Memory.getAllTimeSamplingProfileReturnValue;
"Memory.getBrowserSamplingProfile": Memory.getBrowserSamplingProfileReturnValue;
"Memory.getSamplingProfile": Memory.getSamplingProfileReturnValue;
+ "Network.getIPProtectionProxyStatus": Network.getIPProtectionProxyStatusReturnValue;
"Network.setAcceptedEncodings": Network.setAcceptedEncodingsReturnValue;
"Network.clearAcceptedEncodingsOverride": Network.clearAcceptedEncodingsOverrideReturnValue;
"Network.canClearBrowserCache": Network.canClearBrowserCacheReturnValue;
@@ -22622,6 +22873,13 @@ Error was thrown.
"Overlay.setShowHinge": Overlay.setShowHingeReturnValue;
"Overlay.setShowIsolatedElements": Overlay.setShowIsolatedElementsReturnValue;
"Overlay.setShowWindowControlsOverlay": Overlay.setShowWindowControlsOverlayReturnValue;
+ "PWA.getOsAppState": PWA.getOsAppStateReturnValue;
+ "PWA.install": PWA.installReturnValue;
+ "PWA.uninstall": PWA.uninstallReturnValue;
+ "PWA.launch": PWA.launchReturnValue;
+ "PWA.launchFilesInApp": PWA.launchFilesInAppReturnValue;
+ "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppReturnValue;
+ "PWA.changeAppUserSettings": PWA.changeAppUserSettingsReturnValue;
"Page.addScriptToEvaluateOnLoad": Page.addScriptToEvaluateOnLoadReturnValue;
"Page.addScriptToEvaluateOnNewDocument": Page.addScriptToEvaluateOnNewDocumentReturnValue;
"Page.bringToFront": Page.bringToFrontReturnValue;
@@ -22687,6 +22945,8 @@ Error was thrown.
"Performance.setTimeDomain": Performance.setTimeDomainReturnValue;
"Performance.getMetrics": Performance.getMetricsReturnValue;
"PerformanceTimeline.enable": PerformanceTimeline.enableReturnValue;
+ "Preload.enable": Preload.enableReturnValue;
+ "Preload.disable": Preload.disableReturnValue;
"Security.disable": Security.disableReturnValue;
"Security.enable": Security.enableReturnValue;
"Security.setIgnoreCertificateErrors": Security.setIgnoreCertificateErrorsReturnValue;
@@ -22769,15 +23029,6 @@ Error was thrown.
"Tracing.recordClockSyncMarker": Tracing.recordClockSyncMarkerReturnValue;
"Tracing.requestMemoryDump": Tracing.requestMemoryDumpReturnValue;
"Tracing.start": Tracing.startReturnValue;
- "Fetch.disable": Fetch.disableReturnValue;
- "Fetch.enable": Fetch.enableReturnValue;
- "Fetch.failRequest": Fetch.failRequestReturnValue;
- "Fetch.fulfillRequest": Fetch.fulfillRequestReturnValue;
- "Fetch.continueRequest": Fetch.continueRequestReturnValue;
- "Fetch.continueWithAuth": Fetch.continueWithAuthReturnValue;
- "Fetch.continueResponse": Fetch.continueResponseReturnValue;
- "Fetch.getResponseBody": Fetch.getResponseBodyReturnValue;
- "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamReturnValue;
"WebAudio.enable": WebAudio.enableReturnValue;
"WebAudio.disable": WebAudio.disableReturnValue;
"WebAudio.getRealtimeData": WebAudio.getRealtimeDataReturnValue;
@@ -22794,43 +23045,6 @@ Error was thrown.
"WebAuthn.setUserVerified": WebAuthn.setUserVerifiedReturnValue;
"WebAuthn.setAutomaticPresenceSimulation": WebAuthn.setAutomaticPresenceSimulationReturnValue;
"WebAuthn.setCredentialProperties": WebAuthn.setCredentialPropertiesReturnValue;
- "Media.enable": Media.enableReturnValue;
- "Media.disable": Media.disableReturnValue;
- "DeviceAccess.enable": DeviceAccess.enableReturnValue;
- "DeviceAccess.disable": DeviceAccess.disableReturnValue;
- "DeviceAccess.selectPrompt": DeviceAccess.selectPromptReturnValue;
- "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptReturnValue;
- "Preload.enable": Preload.enableReturnValue;
- "Preload.disable": Preload.disableReturnValue;
- "FedCm.enable": FedCm.enableReturnValue;
- "FedCm.disable": FedCm.disableReturnValue;
- "FedCm.selectAccount": FedCm.selectAccountReturnValue;
- "FedCm.clickDialogButton": FedCm.clickDialogButtonReturnValue;
- "FedCm.openUrl": FedCm.openUrlReturnValue;
- "FedCm.dismissDialog": FedCm.dismissDialogReturnValue;
- "FedCm.resetCooldown": FedCm.resetCooldownReturnValue;
- "PWA.getOsAppState": PWA.getOsAppStateReturnValue;
- "PWA.install": PWA.installReturnValue;
- "PWA.uninstall": PWA.uninstallReturnValue;
- "PWA.launch": PWA.launchReturnValue;
- "PWA.launchFilesInApp": PWA.launchFilesInAppReturnValue;
- "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppReturnValue;
- "PWA.changeAppUserSettings": PWA.changeAppUserSettingsReturnValue;
- "BluetoothEmulation.enable": BluetoothEmulation.enableReturnValue;
- "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateReturnValue;
- "BluetoothEmulation.disable": BluetoothEmulation.disableReturnValue;
- "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralReturnValue;
- "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementReturnValue;
- "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseReturnValue;
- "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseReturnValue;
- "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseReturnValue;
- "BluetoothEmulation.addService": BluetoothEmulation.addServiceReturnValue;
- "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceReturnValue;
- "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicReturnValue;
- "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicReturnValue;
- "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorReturnValue;
- "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorReturnValue;
- "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionReturnValue;
"Console.clearMessages": Console.clearMessagesReturnValue;
"Console.disable": Console.disableReturnValue;
"Console.enable": Console.enableReturnValue;
diff --git a/packages/playwright-core/src/server/deviceDescriptorsSource.json b/packages/playwright-core/src/server/deviceDescriptorsSource.json
index 4adee517af..c9081c9ba3 100644
--- a/packages/playwright-core/src/server/deviceDescriptorsSource.json
+++ b/packages/playwright-core/src/server/deviceDescriptorsSource.json
@@ -110,7 +110,7 @@
"defaultBrowserType": "webkit"
},
"Galaxy S5": {
- "userAgent": "Mozilla/5.0 (Linux; Android 5.0; SM-G900P Build/LRX21T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 5.0; SM-G900P Build/LRX21T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 360,
"height": 640
@@ -121,7 +121,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S5 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 5.0; SM-G900P Build/LRX21T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 5.0; SM-G900P Build/LRX21T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 640,
"height": 360
@@ -132,7 +132,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S8": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 360,
"height": 740
@@ -143,7 +143,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S8 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.0; SM-G950U Build/NRD90M) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 740,
"height": 360
@@ -154,7 +154,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S9+": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 320,
"height": 658
@@ -165,7 +165,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S9+ landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; SM-G965U Build/R16NW) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 658,
"height": 320
@@ -176,7 +176,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S24": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-S921U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-S921U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 360,
"height": 780
@@ -187,7 +187,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy S24 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-S921U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-S921U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 780,
"height": 360
@@ -198,7 +198,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy A55": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-A556B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-A556B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 480,
"height": 1040
@@ -209,7 +209,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy A55 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-A556B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-A556B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 1040,
"height": 480
@@ -220,7 +220,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy Tab S4": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 712,
"height": 1138
@@ -231,7 +231,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy Tab S4 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.1.0; SM-T837A) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 1138,
"height": 712
@@ -242,7 +242,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy Tab S9": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-X710) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-X710) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 640,
"height": 1024
@@ -253,7 +253,7 @@
"defaultBrowserType": "chromium"
},
"Galaxy Tab S9 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-X710) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; SM-X710) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 1024,
"height": 640
@@ -1208,7 +1208,7 @@
"defaultBrowserType": "webkit"
},
"LG Optimus L70": {
- "userAgent": "Mozilla/5.0 (Linux; U; Android 4.4.2; en-us; LGMS323 Build/KOT49I.MS32310c) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; U; Android 4.4.2; en-us; LGMS323 Build/KOT49I.MS32310c) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 384,
"height": 640
@@ -1219,7 +1219,7 @@
"defaultBrowserType": "chromium"
},
"LG Optimus L70 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; U; Android 4.4.2; en-us; LGMS323 Build/KOT49I.MS32310c) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; U; Android 4.4.2; en-us; LGMS323 Build/KOT49I.MS32310c) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 640,
"height": 384
@@ -1230,7 +1230,7 @@
"defaultBrowserType": "chromium"
},
"Microsoft Lumia 550": {
- "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 550) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36 Edge/14.14263",
+ "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 550) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36 Edge/14.14263",
"viewport": {
"width": 360,
"height": 640
@@ -1241,7 +1241,7 @@
"defaultBrowserType": "chromium"
},
"Microsoft Lumia 550 landscape": {
- "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 550) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36 Edge/14.14263",
+ "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 550) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36 Edge/14.14263",
"viewport": {
"width": 640,
"height": 360
@@ -1252,7 +1252,7 @@
"defaultBrowserType": "chromium"
},
"Microsoft Lumia 950": {
- "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 950) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36 Edge/14.14263",
+ "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 950) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36 Edge/14.14263",
"viewport": {
"width": 360,
"height": 640
@@ -1263,7 +1263,7 @@
"defaultBrowserType": "chromium"
},
"Microsoft Lumia 950 landscape": {
- "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 950) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36 Edge/14.14263",
+ "userAgent": "Mozilla/5.0 (Windows Phone 10.0; Android 4.2.1; Microsoft; Lumia 950) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36 Edge/14.14263",
"viewport": {
"width": 640,
"height": 360
@@ -1274,7 +1274,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 10": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 10 Build/MOB31T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 10 Build/MOB31T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 800,
"height": 1280
@@ -1285,7 +1285,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 10 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 10 Build/MOB31T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 10 Build/MOB31T) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 1280,
"height": 800
@@ -1296,7 +1296,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 4": {
- "userAgent": "Mozilla/5.0 (Linux; Android 4.4.2; Nexus 4 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 4.4.2; Nexus 4 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 384,
"height": 640
@@ -1307,7 +1307,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 4 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 4.4.2; Nexus 4 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 4.4.2; Nexus 4 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 640,
"height": 384
@@ -1318,7 +1318,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 5": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 360,
"height": 640
@@ -1329,7 +1329,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 5 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0; Nexus 5 Build/MRA58N) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 640,
"height": 360
@@ -1340,7 +1340,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 5X": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 5X Build/OPR4.170623.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 5X Build/OPR4.170623.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 412,
"height": 732
@@ -1351,7 +1351,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 5X landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 5X Build/OPR4.170623.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 5X Build/OPR4.170623.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 732,
"height": 412
@@ -1362,7 +1362,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 6": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.1.1; Nexus 6 Build/N6F26U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.1.1; Nexus 6 Build/N6F26U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 412,
"height": 732
@@ -1373,7 +1373,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 6 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.1.1; Nexus 6 Build/N6F26U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.1.1; Nexus 6 Build/N6F26U) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 732,
"height": 412
@@ -1384,7 +1384,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 6P": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 6P Build/OPP3.170518.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 6P Build/OPP3.170518.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 412,
"height": 732
@@ -1395,7 +1395,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 6P landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 6P Build/OPP3.170518.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Nexus 6P Build/OPP3.170518.006) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 732,
"height": 412
@@ -1406,7 +1406,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 7": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 600,
"height": 960
@@ -1417,7 +1417,7 @@
"defaultBrowserType": "chromium"
},
"Nexus 7 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 6.0.1; Nexus 7 Build/MOB30X) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"viewport": {
"width": 960,
"height": 600
@@ -1472,7 +1472,7 @@
"defaultBrowserType": "webkit"
},
"Pixel 2": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 411,
"height": 731
@@ -1483,7 +1483,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 2 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0; Pixel 2 Build/OPD3.170816.012) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 731,
"height": 411
@@ -1494,7 +1494,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 2 XL": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Pixel 2 XL Build/OPD1.170816.004) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Pixel 2 XL Build/OPD1.170816.004) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 411,
"height": 823
@@ -1505,7 +1505,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 2 XL landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Pixel 2 XL Build/OPD1.170816.004) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 8.0.0; Pixel 2 XL Build/OPD1.170816.004) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 823,
"height": 411
@@ -1516,7 +1516,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 3": {
- "userAgent": "Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 393,
"height": 786
@@ -1527,7 +1527,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 3 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 9; Pixel 3 Build/PQ1A.181105.017.A1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 786,
"height": 393
@@ -1538,7 +1538,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 4": {
- "userAgent": "Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 353,
"height": 745
@@ -1549,7 +1549,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 4 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 10; Pixel 4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 745,
"height": 353
@@ -1560,7 +1560,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 4a (5G)": {
- "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 4a (5G)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 4a (5G)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"width": 412,
"height": 892
@@ -1575,7 +1575,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 4a (5G) landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 4a (5G)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 4a (5G)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"height": 892,
"width": 412
@@ -1590,7 +1590,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 5": {
- "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"width": 393,
"height": 851
@@ -1605,7 +1605,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 5 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 11; Pixel 5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"width": 851,
"height": 393
@@ -1620,7 +1620,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 7": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; Pixel 7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; Pixel 7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"width": 412,
"height": 915
@@ -1635,7 +1635,7 @@
"defaultBrowserType": "chromium"
},
"Pixel 7 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 14; Pixel 7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 14; Pixel 7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"screen": {
"width": 915,
"height": 412
@@ -1650,7 +1650,7 @@
"defaultBrowserType": "chromium"
},
"Moto G4": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.0; Moto G (4)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.0; Moto G (4)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 360,
"height": 640
@@ -1661,7 +1661,7 @@
"defaultBrowserType": "chromium"
},
"Moto G4 landscape": {
- "userAgent": "Mozilla/5.0 (Linux; Android 7.0; Moto G (4)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Mobile Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Linux; Android 7.0; Moto G (4)) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Mobile Safari/537.36",
"viewport": {
"width": 640,
"height": 360
@@ -1672,7 +1672,7 @@
"defaultBrowserType": "chromium"
},
"Desktop Chrome HiDPI": {
- "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"screen": {
"width": 1792,
"height": 1120
@@ -1687,7 +1687,7 @@
"defaultBrowserType": "chromium"
},
"Desktop Edge HiDPI": {
- "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36 Edg/140.0.7339.41",
+ "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36 Edg/141.0.7390.7",
"screen": {
"width": 1792,
"height": 1120
@@ -1732,7 +1732,7 @@
"defaultBrowserType": "webkit"
},
"Desktop Chrome": {
- "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36",
+ "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36",
"screen": {
"width": 1920,
"height": 1080
@@ -1747,7 +1747,7 @@
"defaultBrowserType": "chromium"
},
"Desktop Edge": {
- "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/140.0.7339.41 Safari/537.36 Edg/140.0.7339.41",
+ "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/141.0.7390.7 Safari/537.36 Edg/141.0.7390.7",
"screen": {
"width": 1920,
"height": 1080
diff --git a/packages/playwright-core/types/protocol.d.ts b/packages/playwright-core/types/protocol.d.ts
index 1fab022bfb..5d3c9d26c1 100644
--- a/packages/playwright-core/types/protocol.d.ts
+++ b/packages/playwright-core/types/protocol.d.ts
@@ -1050,7 +1050,7 @@ registrations being ignored.
*/
propertyValue?: string;
}
- export type UserReidentificationIssueType = "BlockedFrameNavigation"|"BlockedSubresource";
+ export type UserReidentificationIssueType = "BlockedFrameNavigation"|"BlockedSubresource"|"NoisedCanvasReadback";
/**
* This issue warns about uses of APIs that may be considered misuse to
re-identify users.
@@ -1061,6 +1061,10 @@ re-identify users.
* Applies to BlockedFrameNavigation and BlockedSubresource issue types.
*/
request?: AffectedRequest;
+ /**
+ * Applies to NoisedCanvasReadback issue type.
+ */
+ sourceCodeLocation?: SourceCodeLocation;
}
/**
* A unique identifier for the type of issue. Each type may use one of the
@@ -1197,125 +1201,6 @@ using Audits.issueAdded event.
}
}
- /**
- * Defines commands and events for browser extensions.
- */
- export module Extensions {
- /**
- * Storage areas.
- */
- export type StorageArea = "session"|"local"|"sync"|"managed";
-
-
- /**
- * Installs an unpacked extension from the filesystem similar to
---load-extension CLI flags. Returns extension ID once the extension
-has been installed. Available if the client is connected using the
---remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
-flag is set.
- */
- export type loadUnpackedParameters = {
- /**
- * Absolute file path.
- */
- path: string;
- }
- export type loadUnpackedReturnValue = {
- /**
- * Extension id.
- */
- id: string;
- }
- /**
- * Uninstalls an unpacked extension (others not supported) from the profile.
-Available if the client is connected using the --remote-debugging-pipe flag
-and the --enable-unsafe-extension-debugging.
- */
- export type uninstallParameters = {
- /**
- * Extension id.
- */
- id: string;
- }
- export type uninstallReturnValue = {
- }
- /**
- * Gets data from extension storage in the given `storageArea`. If `keys` is
-specified, these are used to filter the result.
- */
- export type getStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to retrieve data from.
- */
- storageArea: StorageArea;
- /**
- * Keys to retrieve.
- */
- keys?: string[];
- }
- export type getStorageItemsReturnValue = {
- data: { [key: string]: string };
- }
- /**
- * Removes `keys` from extension storage in the given `storageArea`.
- */
- export type removeStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to remove data from.
- */
- storageArea: StorageArea;
- /**
- * Keys to remove.
- */
- keys: string[];
- }
- export type removeStorageItemsReturnValue = {
- }
- /**
- * Clears extension storage in the given `storageArea`.
- */
- export type clearStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to remove data from.
- */
- storageArea: StorageArea;
- }
- export type clearStorageItemsReturnValue = {
- }
- /**
- * Sets `values` in extension storage in the given `storageArea`. The provided `values`
-will be merged with existing values in the storage area.
- */
- export type setStorageItemsParameters = {
- /**
- * ID of extension.
- */
- id: string;
- /**
- * StorageArea to set data in.
- */
- storageArea: StorageArea;
- /**
- * Values to set.
- */
- values: { [key: string]: string };
- }
- export type setStorageItemsReturnValue = {
- }
- }
-
/**
* Defines commands and events for Autofill.
*/
@@ -1580,4404 +1465,4669 @@ events afterwards if enabled and recording.
}
/**
- * The Browser domain defines methods and events for browser managing.
+ * This domain allows configuring virtual Bluetooth devices to test
+the web-bluetooth API.
*/
- export module Browser {
- export type BrowserContextID = string;
- export type WindowID = number;
+ export module BluetoothEmulation {
/**
- * The state of the browser window.
+ * Indicates the various states of Central.
*/
- export type WindowState = "normal"|"minimized"|"maximized"|"fullscreen";
+ export type CentralState = "absent"|"powered-off"|"powered-on";
/**
- * Browser window bounds information
+ * Indicates the various types of GATT event.
*/
- export interface Bounds {
- /**
- * The offset from the left edge of the screen to the window in pixels.
- */
- left?: number;
- /**
- * The offset from the top edge of the screen to the window in pixels.
- */
- top?: number;
- /**
- * The window width in pixels.
- */
- width?: number;
- /**
- * The window height in pixels.
- */
- height?: number;
- /**
- * The window state. Default to normal.
- */
- windowState?: WindowState;
- }
- export type PermissionType = "ar"|"audioCapture"|"automaticFullscreen"|"backgroundFetch"|"backgroundSync"|"cameraPanTiltZoom"|"capturedSurfaceControl"|"clipboardReadWrite"|"clipboardSanitizedWrite"|"displayCapture"|"durableStorage"|"geolocation"|"handTracking"|"idleDetection"|"keyboardLock"|"localFonts"|"localNetworkAccess"|"midi"|"midiSysex"|"nfc"|"notifications"|"paymentHandler"|"periodicBackgroundSync"|"pointerLock"|"protectedMediaIdentifier"|"sensors"|"smartCard"|"speakerSelection"|"storageAccess"|"topLevelStorageAccess"|"videoCapture"|"vr"|"wakeLockScreen"|"wakeLockSystem"|"webAppInstallation"|"webPrinting"|"windowManagement";
- export type PermissionSetting = "granted"|"denied"|"prompt";
+ export type GATTOperationType = "connection"|"discovery";
/**
- * Definition of PermissionDescriptor defined in the Permissions API:
-https://w3c.github.io/permissions/#dom-permissiondescriptor.
+ * Indicates the various types of characteristic write.
*/
- export interface PermissionDescriptor {
- /**
- * Name of permission.
-See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
- */
- name: string;
- /**
- * For "midi" permission, may also specify sysex control.
- */
- sysex?: boolean;
- /**
- * For "push" permission, may specify userVisibleOnly.
-Note that userVisibleOnly = true is the only currently supported type.
- */
- userVisibleOnly?: boolean;
- /**
- * For "clipboard" permission, may specify allowWithoutSanitization.
- */
- allowWithoutSanitization?: boolean;
- /**
- * For "fullscreen" permission, must specify allowWithoutGesture:true.
- */
- allowWithoutGesture?: boolean;
- /**
- * For "camera" permission, may specify panTiltZoom.
- */
- panTiltZoom?: boolean;
- }
+ export type CharacteristicWriteType = "write-default-deprecated"|"write-with-response"|"write-without-response";
/**
- * Browser command ids used by executeBrowserCommand.
+ * Indicates the various types of characteristic operation.
*/
- export type BrowserCommandId = "openTabSearch"|"closeTabSearch"|"openGlic";
+ export type CharacteristicOperationType = "read"|"write"|"subscribe-to-notifications"|"unsubscribe-from-notifications";
/**
- * Chrome histogram bucket.
+ * Indicates the various types of descriptor operation.
*/
- export interface Bucket {
- /**
- * Minimum value (inclusive).
- */
- low: number;
+ export type DescriptorOperationType = "read"|"write";
+ /**
+ * Stores the manufacturer data
+ */
+ export interface ManufacturerData {
/**
- * Maximum value (exclusive).
+ * Company identifier
+https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml
+https://usb.org/developers
*/
- high: number;
+ key: number;
/**
- * Number of samples.
+ * Manufacturer-specific data
*/
- count: number;
+ data: binary;
}
/**
- * Chrome histogram.
+ * Stores the byte data of the advertisement packet sent by a Bluetooth device.
*/
- export interface Histogram {
- /**
- * Name.
- */
- name: string;
+ export interface ScanRecord {
+ name?: string;
+ uuids?: string[];
/**
- * Sum of sample values.
+ * Stores the external appearance description of the device.
*/
- sum: number;
+ appearance?: number;
/**
- * Total number of samples.
+ * Stores the transmission power of a broadcasting device.
*/
- count: number;
+ txPower?: number;
/**
- * Buckets.
+ * Key is the company identifier and the value is an array of bytes of
+manufacturer specific data.
*/
- buckets: Bucket[];
+ manufacturerData?: ManufacturerData[];
}
- export type PrivacySandboxAPI = "BiddingAndAuctionServices"|"TrustedKeyValue";
-
/**
- * Fired when page is about to start a download.
+ * Stores the advertisement packet information that is sent by a Bluetooth device.
*/
- export type downloadWillBeginPayload = {
- /**
- * Id of the frame that caused the download to begin.
- */
- frameId: Page.FrameId;
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * URL of the resource being downloaded.
- */
- url: string;
- /**
- * Suggested file name of the resource (the actual name of the file saved on disk may differ).
- */
- suggestedFilename: string;
+ export interface ScanEntry {
+ deviceAddress: string;
+ rssi: number;
+ scanRecord: ScanRecord;
}
/**
- * Fired when download makes progress. Last call has |done| == true.
+ * Describes the properties of a characteristic. This follows Bluetooth Core
+Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.
*/
- export type downloadProgressPayload = {
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * Total expected bytes to download.
- */
- totalBytes: number;
- /**
- * Total bytes received.
- */
- receivedBytes: number;
- /**
- * Download status.
- */
- state: "inProgress"|"completed"|"canceled";
- /**
- * If download is "completed", provides the path of the downloaded file.
-Depending on the platform, it is not guaranteed to be set, nor the file
-is guaranteed to exist.
- */
- filePath?: string;
+ export interface CharacteristicProperties {
+ broadcast?: boolean;
+ read?: boolean;
+ writeWithoutResponse?: boolean;
+ write?: boolean;
+ notify?: boolean;
+ indicate?: boolean;
+ authenticatedSignedWrites?: boolean;
+ extendedProperties?: boolean;
}
/**
- * Set permission settings for given origin.
+ * Event for when a GATT operation of |type| to the peripheral with |address|
+happened.
*/
- export type setPermissionParameters = {
- /**
- * Descriptor of permission to override.
- */
- permission: PermissionDescriptor;
- /**
- * Setting of the permission.
- */
- setting: PermissionSetting;
- /**
- * Origin the permission applies to, all origins if not specified.
- */
- origin?: string;
- /**
- * Context to override. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
+ export type gattOperationReceivedPayload = {
+ address: string;
+ type: GATTOperationType;
}
- export type setPermissionReturnValue = {
+ /**
+ * Event for when a characteristic operation of |type| to the characteristic
+respresented by |characteristicId| happened. |data| and |writeType| is
+expected to exist when |type| is write.
+ */
+ export type characteristicOperationReceivedPayload = {
+ characteristicId: string;
+ type: CharacteristicOperationType;
+ data?: binary;
+ writeType?: CharacteristicWriteType;
}
/**
- * Grant specific permissions to the given origin and reject all others.
+ * Event for when a descriptor operation of |type| to the descriptor
+respresented by |descriptorId| happened. |data| is expected to exist when
+|type| is write.
*/
- export type grantPermissionsParameters = {
- permissions: PermissionType[];
+ export type descriptorOperationReceivedPayload = {
+ descriptorId: string;
+ type: DescriptorOperationType;
+ data?: binary;
+ }
+
+ /**
+ * Enable the BluetoothEmulation domain.
+ */
+ export type enableParameters = {
/**
- * Origin the permission applies to, all origins if not specified.
+ * State of the simulated central.
*/
- origin?: string;
+ state: CentralState;
/**
- * BrowserContext to override permissions. When omitted, default browser context is used.
+ * If the simulated central supports low-energy.
*/
- browserContextId?: BrowserContextID;
+ leSupported: boolean;
}
- export type grantPermissionsReturnValue = {
+ export type enableReturnValue = {
}
/**
- * Reset all permission management for all origins.
+ * Set the state of the simulated central.
*/
- export type resetPermissionsParameters = {
+ export type setSimulatedCentralStateParameters = {
/**
- * BrowserContext to reset permissions. When omitted, default browser context is used.
+ * State of the simulated central.
*/
- browserContextId?: BrowserContextID;
+ state: CentralState;
}
- export type resetPermissionsReturnValue = {
+ export type setSimulatedCentralStateReturnValue = {
}
/**
- * Set the behavior when downloading a file.
+ * Disable the BluetoothEmulation domain.
*/
- export type setDownloadBehaviorParameters = {
- /**
- * Whether to allow all or deny all download requests, or use default Chrome behavior if
-available (otherwise deny). |allowAndName| allows download and names files according to
-their download guids.
- */
- behavior: "deny"|"allow"|"allowAndName"|"default";
- /**
- * BrowserContext to set download behavior. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
- /**
- * The default path to save downloaded files to. This is required if behavior is set to 'allow'
-or 'allowAndName'.
- */
- downloadPath?: string;
- /**
- * Whether to emit download events (defaults to false).
- */
- eventsEnabled?: boolean;
+ export type disableParameters = {
}
- export type setDownloadBehaviorReturnValue = {
+ export type disableReturnValue = {
}
/**
- * Cancel a download if in progress
+ * Simulates a peripheral with |address|, |name| and |knownServiceUuids|
+that has already been connected to the system.
*/
- export type cancelDownloadParameters = {
- /**
- * Global unique identifier of the download.
- */
- guid: string;
- /**
- * BrowserContext to perform the action in. When omitted, default browser context is used.
- */
- browserContextId?: BrowserContextID;
+ export type simulatePreconnectedPeripheralParameters = {
+ address: string;
+ name: string;
+ manufacturerData: ManufacturerData[];
+ knownServiceUuids: string[];
}
- export type cancelDownloadReturnValue = {
+ export type simulatePreconnectedPeripheralReturnValue = {
}
/**
- * Close browser gracefully.
+ * Simulates an advertisement packet described in |entry| being received by
+the central.
*/
- export type closeParameters = {
+ export type simulateAdvertisementParameters = {
+ entry: ScanEntry;
}
- export type closeReturnValue = {
+ export type simulateAdvertisementReturnValue = {
}
/**
- * Crashes browser on the main thread.
+ * Simulates the response code from the peripheral with |address| for a
+GATT operation of |type|. The |code| value follows the HCI Error Codes from
+Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes.
*/
- export type crashParameters = {
+ export type simulateGATTOperationResponseParameters = {
+ address: string;
+ type: GATTOperationType;
+ code: number;
}
- export type crashReturnValue = {
+ export type simulateGATTOperationResponseReturnValue = {
}
/**
- * Crashes GPU process.
+ * Simulates the response from the characteristic with |characteristicId| for a
+characteristic operation of |type|. The |code| value follows the Error
+Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
+The |data| is expected to exist when simulating a successful read operation
+response.
*/
- export type crashGpuProcessParameters = {
+ export type simulateCharacteristicOperationResponseParameters = {
+ characteristicId: string;
+ type: CharacteristicOperationType;
+ code: number;
+ data?: binary;
}
- export type crashGpuProcessReturnValue = {
+ export type simulateCharacteristicOperationResponseReturnValue = {
}
/**
- * Returns version information.
+ * Simulates the response from the descriptor with |descriptorId| for a
+descriptor operation of |type|. The |code| value follows the Error
+Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
+The |data| is expected to exist when simulating a successful read operation
+response.
*/
- export type getVersionParameters = {
+ export type simulateDescriptorOperationResponseParameters = {
+ descriptorId: string;
+ type: DescriptorOperationType;
+ code: number;
+ data?: binary;
}
- export type getVersionReturnValue = {
- /**
- * Protocol version.
- */
- protocolVersion: string;
- /**
- * Product name.
- */
- product: string;
- /**
- * Product revision.
- */
- revision: string;
- /**
- * User-Agent.
- */
- userAgent: string;
- /**
- * V8 version.
- */
- jsVersion: string;
+ export type simulateDescriptorOperationResponseReturnValue = {
}
/**
- * Returns the command line switches for the browser process if, and only if
---enable-automation is on the commandline.
+ * Adds a service with |serviceUuid| to the peripheral with |address|.
*/
- export type getBrowserCommandLineParameters = {
+ export type addServiceParameters = {
+ address: string;
+ serviceUuid: string;
}
- export type getBrowserCommandLineReturnValue = {
+ export type addServiceReturnValue = {
/**
- * Commandline parameters
+ * An identifier that uniquely represents this service.
*/
- arguments: string[];
+ serviceId: string;
}
/**
- * Get Chrome histograms.
+ * Removes the service respresented by |serviceId| from the simulated central.
*/
- export type getHistogramsParameters = {
- /**
- * Requested substring in name. Only histograms which have query as a
-substring in their name are extracted. An empty or absent query returns
-all histograms.
- */
- query?: string;
- /**
- * If true, retrieve delta since last delta call.
- */
- delta?: boolean;
+ export type removeServiceParameters = {
+ serviceId: string;
}
- export type getHistogramsReturnValue = {
- /**
- * Histograms.
- */
- histograms: Histogram[];
+ export type removeServiceReturnValue = {
}
/**
- * Get a Chrome histogram by name.
+ * Adds a characteristic with |characteristicUuid| and |properties| to the
+service represented by |serviceId|.
*/
- export type getHistogramParameters = {
- /**
- * Requested histogram name.
- */
- name: string;
- /**
- * If true, retrieve delta since last delta call.
- */
- delta?: boolean;
+ export type addCharacteristicParameters = {
+ serviceId: string;
+ characteristicUuid: string;
+ properties: CharacteristicProperties;
}
- export type getHistogramReturnValue = {
+ export type addCharacteristicReturnValue = {
/**
- * Histogram.
+ * An identifier that uniquely represents this characteristic.
*/
- histogram: Histogram;
+ characteristicId: string;
}
/**
- * Get position and size of the browser window.
+ * Removes the characteristic respresented by |characteristicId| from the
+simulated central.
*/
- export type getWindowBoundsParameters = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
+ export type removeCharacteristicParameters = {
+ characteristicId: string;
}
- export type getWindowBoundsReturnValue = {
- /**
- * Bounds information of the window. When window state is 'minimized', the restored window
-position and size are returned.
- */
- bounds: Bounds;
+ export type removeCharacteristicReturnValue = {
}
/**
- * Get the browser window that contains the devtools target.
+ * Adds a descriptor with |descriptorUuid| to the characteristic respresented
+by |characteristicId|.
*/
- export type getWindowForTargetParameters = {
- /**
- * Devtools agent host id. If called as a part of the session, associated targetId is used.
- */
- targetId?: Target.TargetID;
+ export type addDescriptorParameters = {
+ characteristicId: string;
+ descriptorUuid: string;
}
- export type getWindowForTargetReturnValue = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
+ export type addDescriptorReturnValue = {
/**
- * Bounds information of the window. When window state is 'minimized', the restored window
-position and size are returned.
+ * An identifier that uniquely represents this descriptor.
*/
- bounds: Bounds;
+ descriptorId: string;
}
/**
- * Set position and/or size of the browser window.
+ * Removes the descriptor with |descriptorId| from the simulated central.
*/
- export type setWindowBoundsParameters = {
- /**
- * Browser window id.
- */
- windowId: WindowID;
- /**
- * New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
-with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
- */
- bounds: Bounds;
+ export type removeDescriptorParameters = {
+ descriptorId: string;
}
- export type setWindowBoundsReturnValue = {
+ export type removeDescriptorReturnValue = {
}
/**
- * Set size of the browser contents resizing browser window as necessary.
+ * Simulates a GATT disconnection from the peripheral with |address|.
*/
- export type setContentsSizeParameters = {
+ export type simulateGATTDisconnectionParameters = {
+ address: string;
+ }
+ export type simulateGATTDisconnectionReturnValue = {
+ }
+ }
+
+ /**
+ * The Browser domain defines methods and events for browser managing.
+ */
+ export module Browser {
+ export type BrowserContextID = string;
+ export type WindowID = number;
+ /**
+ * The state of the browser window.
+ */
+ export type WindowState = "normal"|"minimized"|"maximized"|"fullscreen";
+ /**
+ * Browser window bounds information
+ */
+ export interface Bounds {
/**
- * Browser window id.
+ * The offset from the left edge of the screen to the window in pixels.
*/
- windowId: WindowID;
+ left?: number;
/**
- * The window contents width in DIP. Assumes current width if omitted.
-Must be specified if 'height' is omitted.
+ * The offset from the top edge of the screen to the window in pixels.
+ */
+ top?: number;
+ /**
+ * The window width in pixels.
*/
width?: number;
/**
- * The window contents height in DIP. Assumes current height if omitted.
-Must be specified if 'width' is omitted.
+ * The window height in pixels.
*/
height?: number;
- }
- export type setContentsSizeReturnValue = {
- }
- /**
- * Set dock tile details, platform-specific.
- */
- export type setDockTileParameters = {
- badgeLabel?: string;
/**
- * Png encoded image.
+ * The window state. Default to normal.
*/
- image?: binary;
- }
- export type setDockTileReturnValue = {
- }
- /**
- * Invoke custom browser commands used by telemetry.
- */
- export type executeBrowserCommandParameters = {
- commandId: BrowserCommandId;
- }
- export type executeBrowserCommandReturnValue = {
- }
- /**
- * Allows a site to use privacy sandbox features that require enrollment
-without the site actually being enrolled. Only supported on page targets.
- */
- export type addPrivacySandboxEnrollmentOverrideParameters = {
- url: string;
- }
- export type addPrivacySandboxEnrollmentOverrideReturnValue = {
+ windowState?: WindowState;
}
+ export type PermissionType = "ar"|"audioCapture"|"automaticFullscreen"|"backgroundFetch"|"backgroundSync"|"cameraPanTiltZoom"|"capturedSurfaceControl"|"clipboardReadWrite"|"clipboardSanitizedWrite"|"displayCapture"|"durableStorage"|"geolocation"|"handTracking"|"idleDetection"|"keyboardLock"|"localFonts"|"localNetworkAccess"|"midi"|"midiSysex"|"nfc"|"notifications"|"paymentHandler"|"periodicBackgroundSync"|"pointerLock"|"protectedMediaIdentifier"|"sensors"|"smartCard"|"speakerSelection"|"storageAccess"|"topLevelStorageAccess"|"videoCapture"|"vr"|"wakeLockScreen"|"wakeLockSystem"|"webAppInstallation"|"webPrinting"|"windowManagement";
+ export type PermissionSetting = "granted"|"denied"|"prompt";
/**
- * Configures encryption keys used with a given privacy sandbox API to talk
-to a trusted coordinator. Since this is intended for test automation only,
-coordinatorOrigin must be a .test domain. No existing coordinator
-configuration for the origin may exist.
+ * Definition of PermissionDescriptor defined in the Permissions API:
+https://w3c.github.io/permissions/#dom-permissiondescriptor.
*/
- export type addPrivacySandboxCoordinatorKeyConfigParameters = {
- api: PrivacySandboxAPI;
- coordinatorOrigin: string;
- keyConfig: string;
+ export interface PermissionDescriptor {
/**
- * BrowserContext to perform the action in. When omitted, default browser
-context is used.
+ * Name of permission.
+See https://cs.chromium.org/chromium/src/third_party/blink/renderer/modules/permissions/permission_descriptor.idl for valid permission names.
*/
- browserContextId?: BrowserContextID;
- }
- export type addPrivacySandboxCoordinatorKeyConfigReturnValue = {
+ name: string;
+ /**
+ * For "midi" permission, may also specify sysex control.
+ */
+ sysex?: boolean;
+ /**
+ * For "push" permission, may specify userVisibleOnly.
+Note that userVisibleOnly = true is the only currently supported type.
+ */
+ userVisibleOnly?: boolean;
+ /**
+ * For "clipboard" permission, may specify allowWithoutSanitization.
+ */
+ allowWithoutSanitization?: boolean;
+ /**
+ * For "fullscreen" permission, must specify allowWithoutGesture:true.
+ */
+ allowWithoutGesture?: boolean;
+ /**
+ * For "camera" permission, may specify panTiltZoom.
+ */
+ panTiltZoom?: boolean;
}
- }
-
- /**
- * This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
-have an associated `id` used in subsequent operations on the related object. Each object type has
-a specific `id` structure, and those are not interchangeable between objects of different kinds.
-CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
-can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
-subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
- */
- export module CSS {
- export type StyleSheetId = string;
/**
- * Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
-stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
-inspector" rules), "regular" for regular stylesheets.
+ * Browser command ids used by executeBrowserCommand.
*/
- export type StyleSheetOrigin = "injected"|"user-agent"|"inspector"|"regular";
+ export type BrowserCommandId = "openTabSearch"|"closeTabSearch"|"openGlic";
/**
- * CSS rule collection for a single pseudo style.
+ * Chrome histogram bucket.
*/
- export interface PseudoElementMatches {
+ export interface Bucket {
/**
- * Pseudo element type.
+ * Minimum value (inclusive).
*/
- pseudoType: DOM.PseudoType;
+ low: number;
/**
- * Pseudo element custom ident.
+ * Maximum value (exclusive).
*/
- pseudoIdentifier?: string;
+ high: number;
/**
- * Matches of CSS rules applicable to the pseudo style.
+ * Number of samples.
*/
- matches: RuleMatch[];
+ count: number;
}
/**
- * CSS style coming from animations with the name of the animation.
+ * Chrome histogram.
*/
- export interface CSSAnimationStyle {
+ export interface Histogram {
/**
- * The name of the animation.
+ * Name.
*/
- name?: string;
+ name: string;
/**
- * The style coming from the animation.
+ * Sum of sample values.
*/
- style: CSSStyle;
- }
- /**
- * Inherited CSS rule collection from ancestor node.
- */
- export interface InheritedStyleEntry {
+ sum: number;
/**
- * The ancestor node's inline style, if any, in the style inheritance chain.
+ * Total number of samples.
*/
- inlineStyle?: CSSStyle;
+ count: number;
/**
- * Matches of CSS rules matching the ancestor node in the style inheritance chain.
+ * Buckets.
*/
- matchedCSSRules: RuleMatch[];
+ buckets: Bucket[];
}
+ export type PrivacySandboxAPI = "BiddingAndAuctionServices"|"TrustedKeyValue";
+
/**
- * Inherited CSS style collection for animated styles from ancestor node.
+ * Fired when page is about to start a download.
*/
- export interface InheritedAnimatedStyleEntry {
+ export type downloadWillBeginPayload = {
/**
- * Styles coming from the animations of the ancestor, if any, in the style inheritance chain.
+ * Id of the frame that caused the download to begin.
*/
- animationStyles?: CSSAnimationStyle[];
+ frameId: Page.FrameId;
/**
- * The style coming from the transitions of the ancestor, if any, in the style inheritance chain.
+ * Global unique identifier of the download.
*/
- transitionsStyle?: CSSStyle;
- }
- /**
- * Inherited pseudo element matches from pseudos of an ancestor node.
- */
- export interface InheritedPseudoElementMatches {
+ guid: string;
/**
- * Matches of pseudo styles from the pseudos of an ancestor node.
+ * URL of the resource being downloaded.
*/
- pseudoElements: PseudoElementMatches[];
+ url: string;
+ /**
+ * Suggested file name of the resource (the actual name of the file saved on disk may differ).
+ */
+ suggestedFilename: string;
}
/**
- * Match data for a CSS rule.
+ * Fired when download makes progress. Last call has |done| == true.
*/
- export interface RuleMatch {
+ export type downloadProgressPayload = {
/**
- * CSS rule in the match.
+ * Global unique identifier of the download.
*/
- rule: CSSRule;
+ guid: string;
/**
- * Matching selector indices in the rule's selectorList selectors (0-based).
+ * Total expected bytes to download.
*/
- matchingSelectors: number[];
- }
- /**
- * Data for a simple selector (these are delimited by commas in a selector list).
- */
- export interface Value {
+ totalBytes: number;
/**
- * Value text.
+ * Total bytes received.
*/
- text: string;
+ receivedBytes: number;
/**
- * Value range in the underlying resource (if available).
+ * Download status.
*/
- range?: SourceRange;
+ state: "inProgress"|"completed"|"canceled";
/**
- * Specificity of the selector.
+ * If download is "completed", provides the path of the downloaded file.
+Depending on the platform, it is not guaranteed to be set, nor the file
+is guaranteed to exist.
*/
- specificity?: Specificity;
+ filePath?: string;
}
+
/**
- * Specificity:
-https://drafts.csswg.org/selectors/#specificity-rules
+ * Set permission settings for given requesting and embedding origins.
*/
- export interface Specificity {
+ export type setPermissionParameters = {
/**
- * The a component, which represents the number of ID selectors.
+ * Descriptor of permission to override.
*/
- a: number;
+ permission: PermissionDescriptor;
/**
- * The b component, which represents the number of class selectors, attributes selectors, and
-pseudo-classes.
+ * Setting of the permission.
*/
- b: number;
+ setting: PermissionSetting;
/**
- * The c component, which represents the number of type selectors and pseudo-elements.
+ * Requesting origin the permission applies to, all origins if not specified.
*/
- c: number;
- }
- /**
- * Selector list data.
- */
- export interface SelectorList {
+ origin?: string;
/**
- * Selectors in the list.
+ * Embedding origin the permission applies to. It is ignored unless the requesting origin is
+present and valid. If the requesting origin is provided but the embedding origin isn't, the
+requesting origin is used as the embedding origin.
*/
- selectors: Value[];
+ embeddingOrigin?: string;
/**
- * Rule selector text.
+ * Context to override. When omitted, default browser context is used.
*/
- text: string;
+ browserContextId?: BrowserContextID;
+ }
+ export type setPermissionReturnValue = {
}
/**
- * CSS stylesheet metainformation.
+ * Grant specific permissions to the given origin and reject all others.
*/
- export interface CSSStyleSheetHeader {
+ export type grantPermissionsParameters = {
+ permissions: PermissionType[];
/**
- * The stylesheet identifier.
+ * Origin the permission applies to, all origins if not specified.
*/
- styleSheetId: StyleSheetId;
+ origin?: string;
/**
- * Owner frame identifier.
+ * BrowserContext to override permissions. When omitted, default browser context is used.
*/
- frameId: Page.FrameId;
+ browserContextId?: BrowserContextID;
+ }
+ export type grantPermissionsReturnValue = {
+ }
+ /**
+ * Reset all permission management for all origins.
+ */
+ export type resetPermissionsParameters = {
/**
- * Stylesheet resource URL. Empty if this is a constructed stylesheet created using
-new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported
-as a CSS module script).
+ * BrowserContext to reset permissions. When omitted, default browser context is used.
*/
- sourceURL: string;
+ browserContextId?: BrowserContextID;
+ }
+ export type resetPermissionsReturnValue = {
+ }
+ /**
+ * Set the behavior when downloading a file.
+ */
+ export type setDownloadBehaviorParameters = {
/**
- * URL of source map associated with the stylesheet (if any).
+ * Whether to allow all or deny all download requests, or use default Chrome behavior if
+available (otherwise deny). |allowAndName| allows download and names files according to
+their download guids.
*/
- sourceMapURL?: string;
+ behavior: "deny"|"allow"|"allowAndName"|"default";
/**
- * Stylesheet origin.
+ * BrowserContext to set download behavior. When omitted, default browser context is used.
*/
- origin: StyleSheetOrigin;
+ browserContextId?: BrowserContextID;
/**
- * Stylesheet title.
+ * The default path to save downloaded files to. This is required if behavior is set to 'allow'
+or 'allowAndName'.
*/
- title: string;
+ downloadPath?: string;
/**
- * The backend id for the owner node of the stylesheet.
+ * Whether to emit download events (defaults to false).
*/
- ownerNode?: DOM.BackendNodeId;
+ eventsEnabled?: boolean;
+ }
+ export type setDownloadBehaviorReturnValue = {
+ }
+ /**
+ * Cancel a download if in progress
+ */
+ export type cancelDownloadParameters = {
/**
- * Denotes whether the stylesheet is disabled.
+ * Global unique identifier of the download.
*/
- disabled: boolean;
+ guid: string;
/**
- * Whether the sourceURL field value comes from the sourceURL comment.
+ * BrowserContext to perform the action in. When omitted, default browser context is used.
*/
- hasSourceURL?: boolean;
+ browserContextId?: BrowserContextID;
+ }
+ export type cancelDownloadReturnValue = {
+ }
+ /**
+ * Close browser gracefully.
+ */
+ export type closeParameters = {
+ }
+ export type closeReturnValue = {
+ }
+ /**
+ * Crashes browser on the main thread.
+ */
+ export type crashParameters = {
+ }
+ export type crashReturnValue = {
+ }
+ /**
+ * Crashes GPU process.
+ */
+ export type crashGpuProcessParameters = {
+ }
+ export type crashGpuProcessReturnValue = {
+ }
+ /**
+ * Returns version information.
+ */
+ export type getVersionParameters = {
+ }
+ export type getVersionReturnValue = {
/**
- * Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
-document.written STYLE tags.
+ * Protocol version.
*/
- isInline: boolean;
+ protocolVersion: string;
/**
- * Whether this stylesheet is mutable. Inline stylesheets become mutable
-after they have been modified via CSSOM API.
-`<link>` element's stylesheets become mutable only if DevTools modifies them.
-Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
+ * Product name.
*/
- isMutable: boolean;
+ product: string;
/**
- * True if this stylesheet is created through new CSSStyleSheet() or imported as a
-CSS module script.
+ * Product revision.
*/
- isConstructed: boolean;
+ revision: string;
/**
- * Line offset of the stylesheet within the resource (zero based).
+ * User-Agent.
*/
- startLine: number;
+ userAgent: string;
/**
- * Column offset of the stylesheet within the resource (zero based).
+ * V8 version.
*/
- startColumn: number;
+ jsVersion: string;
+ }
+ /**
+ * Returns the command line switches for the browser process if, and only if
+--enable-automation is on the commandline.
+ */
+ export type getBrowserCommandLineParameters = {
+ }
+ export type getBrowserCommandLineReturnValue = {
/**
- * Size of the content (in characters).
+ * Commandline parameters
*/
- length: number;
+ arguments: string[];
+ }
+ /**
+ * Get Chrome histograms.
+ */
+ export type getHistogramsParameters = {
/**
- * Line offset of the end of the stylesheet within the resource (zero based).
+ * Requested substring in name. Only histograms which have query as a
+substring in their name are extracted. An empty or absent query returns
+all histograms.
*/
- endLine: number;
+ query?: string;
/**
- * Column offset of the end of the stylesheet within the resource (zero based).
+ * If true, retrieve delta since last delta call.
*/
- endColumn: number;
+ delta?: boolean;
+ }
+ export type getHistogramsReturnValue = {
/**
- * If the style sheet was loaded from a network resource, this indicates when the resource failed to load
+ * Histograms.
*/
- loadingFailed?: boolean;
+ histograms: Histogram[];
}
/**
- * CSS rule representation.
+ * Get a Chrome histogram by name.
*/
- export interface CSSRule {
+ export type getHistogramParameters = {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Requested histogram name.
*/
- styleSheetId?: StyleSheetId;
+ name: string;
/**
- * Rule selector data.
+ * If true, retrieve delta since last delta call.
*/
- selectorList: SelectorList;
+ delta?: boolean;
+ }
+ export type getHistogramReturnValue = {
/**
- * Array of selectors from ancestor style rules, sorted by distance from the current rule.
+ * Histogram.
*/
- nestingSelectors?: string[];
- /**
- * Parent stylesheet's origin.
- */
- origin: StyleSheetOrigin;
- /**
- * Associated style declaration.
- */
- style: CSSStyle;
+ histogram: Histogram;
+ }
+ /**
+ * Get position and size of the browser window.
+ */
+ export type getWindowBoundsParameters = {
/**
- * Media list array (for rules involving media queries). The array enumerates media queries
-starting with the innermost one, going outwards.
+ * Browser window id.
*/
- media?: CSSMedia[];
+ windowId: WindowID;
+ }
+ export type getWindowBoundsReturnValue = {
/**
- * Container query list array (for rules involving container queries).
-The array enumerates container queries starting with the innermost one, going outwards.
+ * Bounds information of the window. When window state is 'minimized', the restored window
+position and size are returned.
*/
- containerQueries?: CSSContainerQuery[];
+ bounds: Bounds;
+ }
+ /**
+ * Get the browser window that contains the devtools target.
+ */
+ export type getWindowForTargetParameters = {
/**
- * @supports CSS at-rule array.
-The array enumerates @supports at-rules starting with the innermost one, going outwards.
+ * Devtools agent host id. If called as a part of the session, associated targetId is used.
*/
- supports?: CSSSupports[];
+ targetId?: Target.TargetID;
+ }
+ export type getWindowForTargetReturnValue = {
/**
- * Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
-with the innermost layer and going outwards.
+ * Browser window id.
*/
- layers?: CSSLayer[];
+ windowId: WindowID;
/**
- * @scope CSS at-rule array.
-The array enumerates @scope at-rules starting with the innermost one, going outwards.
+ * Bounds information of the window. When window state is 'minimized', the restored window
+position and size are returned.
*/
- scopes?: CSSScope[];
+ bounds: Bounds;
+ }
+ /**
+ * Set position and/or size of the browser window.
+ */
+ export type setWindowBoundsParameters = {
/**
- * The array keeps the types of ancestor CSSRules from the innermost going outwards.
+ * Browser window id.
*/
- ruleTypes?: CSSRuleType[];
+ windowId: WindowID;
/**
- * @starting-style CSS at-rule array.
-The array enumerates @starting-style at-rules starting with the innermost one, going outwards.
+ * New window bounds. The 'minimized', 'maximized' and 'fullscreen' states cannot be combined
+with 'left', 'top', 'width' or 'height'. Leaves unspecified fields unchanged.
*/
- startingStyles?: CSSStartingStyle[];
+ bounds: Bounds;
+ }
+ export type setWindowBoundsReturnValue = {
}
/**
- * Enum indicating the type of a CSS rule, used to represent the order of a style rule's ancestors.
-This list only contains rule types that are collected during the ancestor rule collection.
- */
- export type CSSRuleType = "MediaRule"|"SupportsRule"|"ContainerRule"|"LayerRule"|"ScopeRule"|"StyleRule"|"StartingStyleRule";
- /**
- * CSS coverage information.
+ * Set size of the browser contents resizing browser window as necessary.
*/
- export interface RuleUsage {
+ export type setContentsSizeParameters = {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Browser window id.
*/
- styleSheetId: StyleSheetId;
+ windowId: WindowID;
/**
- * Offset of the start of the rule (including selector) from the beginning of the stylesheet.
+ * The window contents width in DIP. Assumes current width if omitted.
+Must be specified if 'height' is omitted.
*/
- startOffset: number;
+ width?: number;
/**
- * Offset of the end of the rule body from the beginning of the stylesheet.
+ * The window contents height in DIP. Assumes current height if omitted.
+Must be specified if 'width' is omitted.
*/
- endOffset: number;
+ height?: number;
+ }
+ export type setContentsSizeReturnValue = {
+ }
+ /**
+ * Set dock tile details, platform-specific.
+ */
+ export type setDockTileParameters = {
+ badgeLabel?: string;
/**
- * Indicates whether the rule was actually used by some element in the page.
+ * Png encoded image.
*/
- used: boolean;
+ image?: binary;
+ }
+ export type setDockTileReturnValue = {
}
/**
- * Text range within a resource. All numbers are zero-based.
+ * Invoke custom browser commands used by telemetry.
*/
- export interface SourceRange {
+ export type executeBrowserCommandParameters = {
+ commandId: BrowserCommandId;
+ }
+ export type executeBrowserCommandReturnValue = {
+ }
+ /**
+ * Allows a site to use privacy sandbox features that require enrollment
+without the site actually being enrolled. Only supported on page targets.
+ */
+ export type addPrivacySandboxEnrollmentOverrideParameters = {
+ url: string;
+ }
+ export type addPrivacySandboxEnrollmentOverrideReturnValue = {
+ }
+ /**
+ * Configures encryption keys used with a given privacy sandbox API to talk
+to a trusted coordinator. Since this is intended for test automation only,
+coordinatorOrigin must be a .test domain. No existing coordinator
+configuration for the origin may exist.
+ */
+ export type addPrivacySandboxCoordinatorKeyConfigParameters = {
+ api: PrivacySandboxAPI;
+ coordinatorOrigin: string;
+ keyConfig: string;
/**
- * Start line of range.
+ * BrowserContext to perform the action in. When omitted, default browser
+context is used.
*/
- startLine: number;
+ browserContextId?: BrowserContextID;
+ }
+ export type addPrivacySandboxCoordinatorKeyConfigReturnValue = {
+ }
+ }
+
+ /**
+ * This domain exposes CSS read/write operations. All CSS objects (stylesheets, rules, and styles)
+have an associated `id` used in subsequent operations on the related object. Each object type has
+a specific `id` structure, and those are not interchangeable between objects of different kinds.
+CSS objects can be loaded using the `get*ForNode()` calls (which accept a DOM node id). A client
+can also keep track of stylesheets via the `styleSheetAdded`/`styleSheetRemoved` events and
+subsequently load the required stylesheet contents using the `getStyleSheet[Text]()` methods.
+ */
+ export module CSS {
+ export type StyleSheetId = string;
+ /**
+ * Stylesheet type: "injected" for stylesheets injected via extension, "user-agent" for user-agent
+stylesheets, "inspector" for stylesheets created by the inspector (i.e. those holding the "via
+inspector" rules), "regular" for regular stylesheets.
+ */
+ export type StyleSheetOrigin = "injected"|"user-agent"|"inspector"|"regular";
+ /**
+ * CSS rule collection for a single pseudo style.
+ */
+ export interface PseudoElementMatches {
/**
- * Start column of range (inclusive).
+ * Pseudo element type.
*/
- startColumn: number;
+ pseudoType: DOM.PseudoType;
/**
- * End line of range
+ * Pseudo element custom ident.
*/
- endLine: number;
+ pseudoIdentifier?: string;
/**
- * End column of range (exclusive).
+ * Matches of CSS rules applicable to the pseudo style.
*/
- endColumn: number;
+ matches: RuleMatch[];
}
- export interface ShorthandEntry {
- /**
- * Shorthand name.
- */
- name: string;
+ /**
+ * CSS style coming from animations with the name of the animation.
+ */
+ export interface CSSAnimationStyle {
/**
- * Shorthand value.
+ * The name of the animation.
*/
- value: string;
+ name?: string;
/**
- * Whether the property has "!important" annotation (implies `false` if absent).
+ * The style coming from the animation.
*/
- important?: boolean;
+ style: CSSStyle;
}
- export interface CSSComputedStyleProperty {
+ /**
+ * Inherited CSS rule collection from ancestor node.
+ */
+ export interface InheritedStyleEntry {
/**
- * Computed style property name.
+ * The ancestor node's inline style, if any, in the style inheritance chain.
*/
- name: string;
+ inlineStyle?: CSSStyle;
/**
- * Computed style property value.
+ * Matches of CSS rules matching the ancestor node in the style inheritance chain.
*/
- value: string;
+ matchedCSSRules: RuleMatch[];
}
/**
- * CSS style representation.
+ * Inherited CSS style collection for animated styles from ancestor node.
*/
- export interface CSSStyle {
+ export interface InheritedAnimatedStyleEntry {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Styles coming from the animations of the ancestor, if any, in the style inheritance chain.
*/
- styleSheetId?: StyleSheetId;
+ animationStyles?: CSSAnimationStyle[];
/**
- * CSS properties in the style.
+ * The style coming from the transitions of the ancestor, if any, in the style inheritance chain.
*/
- cssProperties: CSSProperty[];
+ transitionsStyle?: CSSStyle;
+ }
+ /**
+ * Inherited pseudo element matches from pseudos of an ancestor node.
+ */
+ export interface InheritedPseudoElementMatches {
/**
- * Computed values for all shorthands found in the style.
+ * Matches of pseudo styles from the pseudos of an ancestor node.
*/
- shorthandEntries: ShorthandEntry[];
+ pseudoElements: PseudoElementMatches[];
+ }
+ /**
+ * Match data for a CSS rule.
+ */
+ export interface RuleMatch {
/**
- * Style declaration text (if available).
+ * CSS rule in the match.
*/
- cssText?: string;
+ rule: CSSRule;
/**
- * Style declaration range in the enclosing stylesheet (if available).
+ * Matching selector indices in the rule's selectorList selectors (0-based).
*/
- range?: SourceRange;
+ matchingSelectors: number[];
}
/**
- * CSS property declaration data.
+ * Data for a simple selector (these are delimited by commas in a selector list).
*/
- export interface CSSProperty {
- /**
- * The property name.
- */
- name: string;
+ export interface Value {
/**
- * The property value.
+ * Value text.
*/
- value: string;
+ text: string;
/**
- * Whether the property has "!important" annotation (implies `false` if absent).
+ * Value range in the underlying resource (if available).
*/
- important?: boolean;
+ range?: SourceRange;
/**
- * Whether the property is implicit (implies `false` if absent).
+ * Specificity of the selector.
*/
- implicit?: boolean;
+ specificity?: Specificity;
+ }
+ /**
+ * Specificity:
+https://drafts.csswg.org/selectors/#specificity-rules
+ */
+ export interface Specificity {
/**
- * The full property text as specified in the style.
+ * The a component, which represents the number of ID selectors.
*/
- text?: string;
+ a: number;
/**
- * Whether the property is understood by the browser (implies `true` if absent).
+ * The b component, which represents the number of class selectors, attributes selectors, and
+pseudo-classes.
*/
- parsedOk?: boolean;
+ b: number;
/**
- * Whether the property is disabled by the user (present for source-based properties only).
+ * The c component, which represents the number of type selectors and pseudo-elements.
*/
- disabled?: boolean;
+ c: number;
+ }
+ /**
+ * Selector list data.
+ */
+ export interface SelectorList {
/**
- * The entire property range in the enclosing style declaration (if available).
+ * Selectors in the list.
*/
- range?: SourceRange;
+ selectors: Value[];
/**
- * Parsed longhand components of this property if it is a shorthand.
-This field will be empty if the given property is not a shorthand.
+ * Rule selector text.
*/
- longhandProperties?: CSSProperty[];
+ text: string;
}
/**
- * CSS media rule descriptor.
+ * CSS stylesheet metainformation.
*/
- export interface CSSMedia {
+ export interface CSSStyleSheetHeader {
/**
- * Media query text.
+ * The stylesheet identifier.
*/
- text: string;
+ styleSheetId: StyleSheetId;
/**
- * Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
-specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
-stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
-stylesheet's STYLE tag.
+ * Owner frame identifier.
*/
- source: "mediaRule"|"importRule"|"linkedSheet"|"inlineSheet";
+ frameId: Page.FrameId;
/**
- * URL of the document containing the media query description.
+ * Stylesheet resource URL. Empty if this is a constructed stylesheet created using
+new CSSStyleSheet() (but non-empty if this is a constructed stylesheet imported
+as a CSS module script).
*/
- sourceURL?: string;
+ sourceURL: string;
/**
- * The associated rule (@media or @import) header range in the enclosing stylesheet (if
-available).
+ * URL of source map associated with the stylesheet (if any).
*/
- range?: SourceRange;
+ sourceMapURL?: string;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Stylesheet origin.
*/
- styleSheetId?: StyleSheetId;
+ origin: StyleSheetOrigin;
/**
- * Array of media queries.
+ * Stylesheet title.
*/
- mediaList?: MediaQuery[];
- }
- /**
- * Media query descriptor.
- */
- export interface MediaQuery {
+ title: string;
/**
- * Array of media query expressions.
+ * The backend id for the owner node of the stylesheet.
*/
- expressions: MediaQueryExpression[];
+ ownerNode?: DOM.BackendNodeId;
/**
- * Whether the media query condition is satisfied.
+ * Denotes whether the stylesheet is disabled.
*/
- active: boolean;
- }
- /**
- * Media query expression descriptor.
- */
- export interface MediaQueryExpression {
+ disabled: boolean;
/**
- * Media query expression value.
+ * Whether the sourceURL field value comes from the sourceURL comment.
*/
- value: number;
+ hasSourceURL?: boolean;
/**
- * Media query expression units.
+ * Whether this stylesheet is created for STYLE tag by parser. This flag is not set for
+document.written STYLE tags.
*/
- unit: string;
+ isInline: boolean;
/**
- * Media query expression feature.
+ * Whether this stylesheet is mutable. Inline stylesheets become mutable
+after they have been modified via CSSOM API.
+`<link>` element's stylesheets become mutable only if DevTools modifies them.
+Constructed stylesheets (new CSSStyleSheet()) are mutable immediately after creation.
*/
- feature: string;
+ isMutable: boolean;
/**
- * The associated range of the value text in the enclosing stylesheet (if available).
+ * True if this stylesheet is created through new CSSStyleSheet() or imported as a
+CSS module script.
*/
- valueRange?: SourceRange;
+ isConstructed: boolean;
/**
- * Computed length of media query expression (if applicable).
+ * Line offset of the stylesheet within the resource (zero based).
*/
- computedLength?: number;
+ startLine: number;
+ /**
+ * Column offset of the stylesheet within the resource (zero based).
+ */
+ startColumn: number;
+ /**
+ * Size of the content (in characters).
+ */
+ length: number;
+ /**
+ * Line offset of the end of the stylesheet within the resource (zero based).
+ */
+ endLine: number;
+ /**
+ * Column offset of the end of the stylesheet within the resource (zero based).
+ */
+ endColumn: number;
+ /**
+ * If the style sheet was loaded from a network resource, this indicates when the resource failed to load
+ */
+ loadingFailed?: boolean;
}
/**
- * CSS container query rule descriptor.
+ * CSS rule representation.
*/
- export interface CSSContainerQuery {
+ export interface CSSRule {
/**
- * Container query text.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- text: string;
+ styleSheetId?: StyleSheetId;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Rule selector data.
*/
- range?: SourceRange;
+ selectorList: SelectorList;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Array of selectors from ancestor style rules, sorted by distance from the current rule.
*/
- styleSheetId?: StyleSheetId;
+ nestingSelectors?: string[];
/**
- * Optional name for the container.
+ * Parent stylesheet's origin.
*/
- name?: string;
+ origin: StyleSheetOrigin;
/**
- * Optional physical axes queried for the container.
+ * Associated style declaration.
*/
- physicalAxes?: DOM.PhysicalAxes;
+ style: CSSStyle;
/**
- * Optional logical axes queried for the container.
+ * Media list array (for rules involving media queries). The array enumerates media queries
+starting with the innermost one, going outwards.
*/
- logicalAxes?: DOM.LogicalAxes;
+ media?: CSSMedia[];
/**
- * true if the query contains scroll-state() queries.
+ * Container query list array (for rules involving container queries).
+The array enumerates container queries starting with the innermost one, going outwards.
*/
- queriesScrollState?: boolean;
+ containerQueries?: CSSContainerQuery[];
/**
- * true if the query contains anchored() queries.
+ * @supports CSS at-rule array.
+The array enumerates @supports at-rules starting with the innermost one, going outwards.
*/
- queriesAnchored?: boolean;
- }
- /**
- * CSS Supports at-rule descriptor.
- */
- export interface CSSSupports {
+ supports?: CSSSupports[];
/**
- * Supports rule text.
+ * Cascade layer array. Contains the layer hierarchy that this rule belongs to starting
+with the innermost layer and going outwards.
*/
- text: string;
+ layers?: CSSLayer[];
/**
- * Whether the supports condition is satisfied.
+ * @scope CSS at-rule array.
+The array enumerates @scope at-rules starting with the innermost one, going outwards.
*/
- active: boolean;
+ scopes?: CSSScope[];
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * The array keeps the types of ancestor CSSRules from the innermost going outwards.
*/
- range?: SourceRange;
+ ruleTypes?: CSSRuleType[];
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * @starting-style CSS at-rule array.
+The array enumerates @starting-style at-rules starting with the innermost one, going outwards.
*/
- styleSheetId?: StyleSheetId;
+ startingStyles?: CSSStartingStyle[];
}
/**
- * CSS Scope at-rule descriptor.
+ * Enum indicating the type of a CSS rule, used to represent the order of a style rule's ancestors.
+This list only contains rule types that are collected during the ancestor rule collection.
*/
- export interface CSSScope {
+ export type CSSRuleType = "MediaRule"|"SupportsRule"|"ContainerRule"|"LayerRule"|"ScopeRule"|"StyleRule"|"StartingStyleRule";
+ /**
+ * CSS coverage information.
+ */
+ export interface RuleUsage {
/**
- * Scope rule text.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- text: string;
+ styleSheetId: StyleSheetId;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Offset of the start of the rule (including selector) from the beginning of the stylesheet.
*/
- range?: SourceRange;
+ startOffset: number;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * Offset of the end of the rule body from the beginning of the stylesheet.
*/
- styleSheetId?: StyleSheetId;
+ endOffset: number;
+ /**
+ * Indicates whether the rule was actually used by some element in the page.
+ */
+ used: boolean;
}
/**
- * CSS Layer at-rule descriptor.
+ * Text range within a resource. All numbers are zero-based.
*/
- export interface CSSLayer {
+ export interface SourceRange {
/**
- * Layer name.
+ * Start line of range.
*/
- text: string;
+ startLine: number;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * Start column of range (inclusive).
*/
- range?: SourceRange;
+ startColumn: number;
/**
- * Identifier of the stylesheet containing this object (if exists).
+ * End line of range
*/
- styleSheetId?: StyleSheetId;
- }
- /**
- * CSS Starting Style at-rule descriptor.
- */
- export interface CSSStartingStyle {
+ endLine: number;
/**
- * The associated rule header range in the enclosing stylesheet (if
-available).
+ * End column of range (exclusive).
*/
- range?: SourceRange;
+ endColumn: number;
+ }
+ export interface ShorthandEntry {
/**
- * Identifier of the stylesheet containing this object (if exists).
- */
- styleSheetId?: StyleSheetId;
- }
- /**
- * CSS Layer data.
- */
- export interface CSSLayerData {
- /**
- * Layer name.
+ * Shorthand name.
*/
name: string;
/**
- * Direct sub-layers
+ * Shorthand value.
*/
- subLayers?: CSSLayerData[];
+ value: string;
/**
- * Layer order. The order determines the order of the layer in the cascade order.
-A higher number has higher priority in the cascade order.
+ * Whether the property has "!important" annotation (implies `false` if absent).
*/
- order: number;
+ important?: boolean;
}
- /**
- * Information about amount of glyphs that were rendered with given font.
- */
- export interface PlatformFontUsage {
- /**
- * Font's family name reported by platform.
- */
- familyName: string;
+ export interface CSSComputedStyleProperty {
/**
- * Font's PostScript name reported by platform.
+ * Computed style property name.
*/
- postScriptName: string;
+ name: string;
/**
- * Indicates if the font was downloaded or resolved locally.
+ * Computed style property value.
*/
- isCustomFont: boolean;
+ value: string;
+ }
+ export interface ComputedStyleExtraFields {
/**
- * Amount of glyphs that were rendered with this font.
+ * Returns whether or not this node is being rendered with base appearance,
+which happens when it has its appearance property set to base/base-select
+or it is in the subtree of an element being rendered with base appearance.
*/
- glyphCount: number;
+ isAppearanceBase: boolean;
}
/**
- * Information about font variation axes for variable fonts
+ * CSS style representation.
*/
- export interface FontVariationAxis {
+ export interface CSSStyle {
/**
- * The font-variation-setting tag (a.k.a. "axis tag").
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- tag: string;
+ styleSheetId?: StyleSheetId;
/**
- * Human-readable variation name in the default language (normally, "en").
+ * CSS properties in the style.
*/
- name: string;
+ cssProperties: CSSProperty[];
/**
- * The minimum value (inclusive) the font supports for this tag.
+ * Computed values for all shorthands found in the style.
*/
- minValue: number;
+ shorthandEntries: ShorthandEntry[];
/**
- * The maximum value (inclusive) the font supports for this tag.
+ * Style declaration text (if available).
*/
- maxValue: number;
+ cssText?: string;
/**
- * The default value.
+ * Style declaration range in the enclosing stylesheet (if available).
*/
- defaultValue: number;
+ range?: SourceRange;
}
/**
- * Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
-and additional information such as platformFontFamily and fontVariationAxes.
+ * CSS property declaration data.
*/
- export interface FontFace {
- /**
- * The font-family.
- */
- fontFamily: string;
+ export interface CSSProperty {
/**
- * The font-style.
+ * The property name.
*/
- fontStyle: string;
+ name: string;
/**
- * The font-variant.
+ * The property value.
*/
- fontVariant: string;
+ value: string;
/**
- * The font-weight.
+ * Whether the property has "!important" annotation (implies `false` if absent).
*/
- fontWeight: string;
+ important?: boolean;
/**
- * The font-stretch.
+ * Whether the property is implicit (implies `false` if absent).
*/
- fontStretch: string;
+ implicit?: boolean;
/**
- * The font-display.
+ * The full property text as specified in the style.
*/
- fontDisplay: string;
+ text?: string;
/**
- * The unicode-range.
+ * Whether the property is understood by the browser (implies `true` if absent).
*/
- unicodeRange: string;
+ parsedOk?: boolean;
/**
- * The src.
+ * Whether the property is disabled by the user (present for source-based properties only).
*/
- src: string;
+ disabled?: boolean;
/**
- * The resolved platform font family
+ * The entire property range in the enclosing style declaration (if available).
*/
- platformFontFamily: string;
+ range?: SourceRange;
/**
- * Available variation settings (a.k.a. "axes").
+ * Parsed longhand components of this property if it is a shorthand.
+This field will be empty if the given property is not a shorthand.
*/
- fontVariationAxes?: FontVariationAxis[];
+ longhandProperties?: CSSProperty[];
}
/**
- * CSS try rule representation.
+ * CSS media rule descriptor.
*/
- export interface CSSTryRule {
+ export interface CSSMedia {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Media query text.
*/
- styleSheetId?: StyleSheetId;
+ text: string;
/**
- * Parent stylesheet's origin.
+ * Source of the media query: "mediaRule" if specified by a @media rule, "importRule" if
+specified by an @import rule, "linkedSheet" if specified by a "media" attribute in a linked
+stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline
+stylesheet's STYLE tag.
*/
- origin: StyleSheetOrigin;
+ source: "mediaRule"|"importRule"|"linkedSheet"|"inlineSheet";
/**
- * Associated style declaration.
+ * URL of the document containing the media query description.
*/
- style: CSSStyle;
- }
- /**
- * CSS @position-try rule representation.
- */
- export interface CSSPositionTryRule {
+ sourceURL?: string;
/**
- * The prelude dashed-ident name
+ * The associated rule (@media or @import) header range in the enclosing stylesheet (if
+available).
*/
- name: Value;
+ range?: SourceRange;
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
/**
- * Parent stylesheet's origin.
- */
- origin: StyleSheetOrigin;
- /**
- * Associated style declaration.
+ * Array of media queries.
*/
- style: CSSStyle;
- active: boolean;
+ mediaList?: MediaQuery[];
}
/**
- * CSS keyframes rule representation.
+ * Media query descriptor.
*/
- export interface CSSKeyframesRule {
+ export interface MediaQuery {
/**
- * Animation name.
+ * Array of media query expressions.
*/
- animationName: Value;
+ expressions: MediaQueryExpression[];
/**
- * List of keyframes.
+ * Whether the media query condition is satisfied.
*/
- keyframes: CSSKeyframeRule[];
- }
- /**
- * Representation of a custom property registration through CSS.registerProperty
- */
- export interface CSSPropertyRegistration {
- propertyName: string;
- initialValue?: Value;
- inherits: boolean;
- syntax: string;
+ active: boolean;
}
/**
- * CSS font-palette-values rule representation.
+ * Media query expression descriptor.
*/
- export interface CSSFontPaletteValuesRule {
+ export interface MediaQueryExpression {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Media query expression value.
*/
- styleSheetId?: StyleSheetId;
+ value: number;
/**
- * Parent stylesheet's origin.
+ * Media query expression units.
*/
- origin: StyleSheetOrigin;
+ unit: string;
/**
- * Associated font palette name.
+ * Media query expression feature.
*/
- fontPaletteName: Value;
+ feature: string;
/**
- * Associated style declaration.
+ * The associated range of the value text in the enclosing stylesheet (if available).
*/
- style: CSSStyle;
+ valueRange?: SourceRange;
+ /**
+ * Computed length of media query expression (if applicable).
+ */
+ computedLength?: number;
}
/**
- * CSS property at-rule representation.
+ * CSS container query rule descriptor.
*/
- export interface CSSPropertyRule {
+ export interface CSSContainerQuery {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Container query text.
+ */
+ text: string;
+ /**
+ * The associated rule header range in the enclosing stylesheet (if
+available).
+ */
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
/**
- * Parent stylesheet's origin.
+ * Optional name for the container.
*/
- origin: StyleSheetOrigin;
+ name?: string;
/**
- * Associated property name.
+ * Optional physical axes queried for the container.
*/
- propertyName: Value;
+ physicalAxes?: DOM.PhysicalAxes;
/**
- * Associated style declaration.
+ * Optional logical axes queried for the container.
*/
- style: CSSStyle;
- }
- /**
- * CSS function argument representation.
- */
- export interface CSSFunctionParameter {
+ logicalAxes?: DOM.LogicalAxes;
/**
- * The parameter name.
+ * true if the query contains scroll-state() queries.
*/
- name: string;
+ queriesScrollState?: boolean;
/**
- * The parameter type.
+ * true if the query contains anchored() queries.
*/
- type: string;
+ queriesAnchored?: boolean;
}
/**
- * CSS function conditional block representation.
+ * CSS Supports at-rule descriptor.
*/
- export interface CSSFunctionConditionNode {
+ export interface CSSSupports {
/**
- * Media query for this conditional block. Only one type of condition should be set.
+ * Supports rule text.
*/
- media?: CSSMedia;
+ text: string;
/**
- * Container query for this conditional block. Only one type of condition should be set.
+ * Whether the supports condition is satisfied.
*/
- containerQueries?: CSSContainerQuery;
+ active: boolean;
/**
- * @supports CSS at-rule condition. Only one type of condition should be set.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- supports?: CSSSupports;
+ range?: SourceRange;
/**
- * Block body.
+ * Identifier of the stylesheet containing this object (if exists).
*/
- children: CSSFunctionNode[];
+ styleSheetId?: StyleSheetId;
+ }
+ /**
+ * CSS Scope at-rule descriptor.
+ */
+ export interface CSSScope {
/**
- * The condition text.
+ * Scope rule text.
*/
- conditionText: string;
+ text: string;
+ /**
+ * The associated rule header range in the enclosing stylesheet (if
+available).
+ */
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
+ */
+ styleSheetId?: StyleSheetId;
}
/**
- * Section of the body of a CSS function rule.
+ * CSS Layer at-rule descriptor.
*/
- export interface CSSFunctionNode {
+ export interface CSSLayer {
/**
- * A conditional block. If set, style should not be set.
+ * Layer name.
*/
- condition?: CSSFunctionConditionNode;
+ text: string;
/**
- * Values set by this node. If set, condition should not be set.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- style?: CSSStyle;
+ range?: SourceRange;
+ /**
+ * Identifier of the stylesheet containing this object (if exists).
+ */
+ styleSheetId?: StyleSheetId;
}
/**
- * CSS function at-rule representation.
+ * CSS Starting Style at-rule descriptor.
*/
- export interface CSSFunctionRule {
+ export interface CSSStartingStyle {
/**
- * Name of the function.
+ * The associated rule header range in the enclosing stylesheet (if
+available).
*/
- name: Value;
+ range?: SourceRange;
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Identifier of the stylesheet containing this object (if exists).
*/
styleSheetId?: StyleSheetId;
+ }
+ /**
+ * CSS Layer data.
+ */
+ export interface CSSLayerData {
/**
- * Parent stylesheet's origin.
+ * Layer name.
*/
- origin: StyleSheetOrigin;
+ name: string;
/**
- * List of parameters.
+ * Direct sub-layers
*/
- parameters: CSSFunctionParameter[];
+ subLayers?: CSSLayerData[];
/**
- * Function body.
+ * Layer order. The order determines the order of the layer in the cascade order.
+A higher number has higher priority in the cascade order.
*/
- children: CSSFunctionNode[];
+ order: number;
}
/**
- * CSS keyframe rule representation.
+ * Information about amount of glyphs that were rendered with given font.
*/
- export interface CSSKeyframeRule {
+ export interface PlatformFontUsage {
/**
- * The css style sheet identifier (absent for user agent stylesheet and user-specified
-stylesheet rules) this rule came from.
+ * Font's family name reported by platform.
*/
- styleSheetId?: StyleSheetId;
+ familyName: string;
/**
- * Parent stylesheet's origin.
+ * Font's PostScript name reported by platform.
*/
- origin: StyleSheetOrigin;
+ postScriptName: string;
/**
- * Associated key text.
+ * Indicates if the font was downloaded or resolved locally.
*/
- keyText: Value;
+ isCustomFont: boolean;
/**
- * Associated style declaration.
+ * Amount of glyphs that were rendered with this font.
*/
- style: CSSStyle;
+ glyphCount: number;
}
/**
- * A descriptor of operation to mutate style declaration text.
+ * Information about font variation axes for variable fonts
*/
- export interface StyleDeclarationEdit {
+ export interface FontVariationAxis {
/**
- * The css style sheet identifier.
+ * The font-variation-setting tag (a.k.a. "axis tag").
*/
- styleSheetId: StyleSheetId;
+ tag: string;
/**
- * The range of the style text in the enclosing stylesheet.
+ * Human-readable variation name in the default language (normally, "en").
*/
- range: SourceRange;
+ name: string;
/**
- * New style text.
+ * The minimum value (inclusive) the font supports for this tag.
*/
- text: string;
- }
-
- /**
- * Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
-web font.
- */
- export type fontsUpdatedPayload = {
+ minValue: number;
/**
- * The web font that has loaded.
+ * The maximum value (inclusive) the font supports for this tag.
*/
- font?: FontFace;
- }
- /**
- * Fires whenever a MediaQuery result changes (for example, after a browser window has been
-resized.) The current implementation considers only viewport-dependent media features.
- */
- export type mediaQueryResultChangedPayload = void;
- /**
- * Fired whenever an active document stylesheet is added.
- */
- export type styleSheetAddedPayload = {
+ maxValue: number;
/**
- * Added stylesheet metainfo.
+ * The default value.
*/
- header: CSSStyleSheetHeader;
- }
- /**
- * Fired whenever a stylesheet is changed as a result of the client operation.
- */
- export type styleSheetChangedPayload = {
- styleSheetId: StyleSheetId;
+ defaultValue: number;
}
/**
- * Fired whenever an active document stylesheet is removed.
+ * Properties of a web font: https://www.w3.org/TR/2008/REC-CSS2-20080411/fonts.html#font-descriptions
+and additional information such as platformFontFamily and fontVariationAxes.
*/
- export type styleSheetRemovedPayload = {
+ export interface FontFace {
/**
- * Identifier of the removed stylesheet.
+ * The font-family.
*/
- styleSheetId: StyleSheetId;
- }
- export type computedStyleUpdatedPayload = {
+ fontFamily: string;
/**
- * The node id that has updated computed styles.
+ * The font-style.
*/
- nodeId: DOM.NodeId;
- }
-
- /**
- * Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
-position specified by `location`.
- */
- export type addRuleParameters = {
+ fontStyle: string;
/**
- * The css style sheet identifier where a new rule should be inserted.
+ * The font-variant.
*/
- styleSheetId: StyleSheetId;
+ fontVariant: string;
/**
- * The text of a new rule.
+ * The font-weight.
*/
- ruleText: string;
+ fontWeight: string;
/**
- * Text position of a new rule in the target style sheet.
+ * The font-stretch.
*/
- location: SourceRange;
+ fontStretch: string;
/**
- * NodeId for the DOM node in whose context custom property declarations for registered properties should be
-validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
-incorrect results if the declaration contains a var() for example.
+ * The font-display.
*/
- nodeForPropertySyntaxValidation?: DOM.NodeId;
- }
- export type addRuleReturnValue = {
+ fontDisplay: string;
/**
- * The newly created rule.
+ * The unicode-range.
*/
- rule: CSSRule;
+ unicodeRange: string;
+ /**
+ * The src.
+ */
+ src: string;
+ /**
+ * The resolved platform font family
+ */
+ platformFontFamily: string;
+ /**
+ * Available variation settings (a.k.a. "axes").
+ */
+ fontVariationAxes?: FontVariationAxis[];
}
/**
- * Returns all class names from specified stylesheet.
+ * CSS try rule representation.
*/
- export type collectClassNamesParameters = {
- styleSheetId: StyleSheetId;
- }
- export type collectClassNamesReturnValue = {
+ export interface CSSTryRule {
/**
- * Class name list.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- classNames: string[];
+ styleSheetId?: StyleSheetId;
+ /**
+ * Parent stylesheet's origin.
+ */
+ origin: StyleSheetOrigin;
+ /**
+ * Associated style declaration.
+ */
+ style: CSSStyle;
}
/**
- * Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
+ * CSS @position-try rule representation.
*/
- export type createStyleSheetParameters = {
+ export interface CSSPositionTryRule {
/**
- * Identifier of the frame where "via-inspector" stylesheet should be created.
+ * The prelude dashed-ident name
*/
- frameId: Page.FrameId;
+ name: Value;
/**
- * If true, creates a new stylesheet for every call. If false,
-returns a stylesheet previously created by a call with force=false
-for the frame's document if it exists or creates a new stylesheet
-(default: false).
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- force?: boolean;
- }
- export type createStyleSheetReturnValue = {
+ styleSheetId?: StyleSheetId;
/**
- * Identifier of the created "via-inspector" stylesheet.
+ * Parent stylesheet's origin.
*/
- styleSheetId: StyleSheetId;
+ origin: StyleSheetOrigin;
+ /**
+ * Associated style declaration.
+ */
+ style: CSSStyle;
+ active: boolean;
}
/**
- * Disables the CSS agent for the given page.
+ * CSS keyframes rule representation.
*/
- export type disableParameters = {
- }
- export type disableReturnValue = {
+ export interface CSSKeyframesRule {
+ /**
+ * Animation name.
+ */
+ animationName: Value;
+ /**
+ * List of keyframes.
+ */
+ keyframes: CSSKeyframeRule[];
}
/**
- * Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
-enabled until the result of this command is received.
+ * Representation of a custom property registration through CSS.registerProperty
*/
- export type enableParameters = {
- }
- export type enableReturnValue = {
+ export interface CSSPropertyRegistration {
+ propertyName: string;
+ initialValue?: Value;
+ inherits: boolean;
+ syntax: string;
}
/**
- * Ensures that the given node will have specified pseudo-classes whenever its style is computed by
-the browser.
+ * CSS font-palette-values rule representation.
*/
- export type forcePseudoStateParameters = {
+ export interface CSSFontPaletteValuesRule {
/**
- * The element id for which to force the pseudo state.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- nodeId: DOM.NodeId;
+ styleSheetId?: StyleSheetId;
/**
- * Element pseudo classes to force when computing the element's style.
+ * Parent stylesheet's origin.
*/
- forcedPseudoClasses: string[];
- }
- export type forcePseudoStateReturnValue = {
- }
- /**
- * Ensures that the given node is in its starting-style state.
- */
- export type forceStartingStyleParameters = {
+ origin: StyleSheetOrigin;
/**
- * The element id for which to force the starting-style state.
+ * Associated font palette name.
*/
- nodeId: DOM.NodeId;
+ fontPaletteName: Value;
/**
- * Boolean indicating if this is on or off.
+ * Associated style declaration.
*/
- forced: boolean;
- }
- export type forceStartingStyleReturnValue = {
+ style: CSSStyle;
}
- export type getBackgroundColorsParameters = {
+ /**
+ * CSS property at-rule representation.
+ */
+ export interface CSSPropertyRule {
/**
- * Id of the node to get background colors for.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- nodeId: DOM.NodeId;
- }
- export type getBackgroundColorsReturnValue = {
+ styleSheetId?: StyleSheetId;
/**
- * The range of background colors behind this element, if it contains any visible text. If no
-visible text is present, this will be undefined. In the case of a flat background color,
-this will consist of simply that color. In the case of a gradient, this will consist of each
-of the color stops. For anything more complicated, this will be an empty array. Images will
-be ignored (as if the image had failed to load).
+ * Parent stylesheet's origin.
*/
- backgroundColors?: string[];
+ origin: StyleSheetOrigin;
/**
- * The computed font size for this node, as a CSS computed value string (e.g. '12px').
+ * Associated property name.
*/
- computedFontSize?: string;
+ propertyName: Value;
/**
- * The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
-'100').
+ * Associated style declaration.
*/
- computedFontWeight?: string;
+ style: CSSStyle;
}
/**
- * Returns the computed style for a DOM node identified by `nodeId`.
+ * CSS function argument representation.
*/
- export type getComputedStyleForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getComputedStyleForNodeReturnValue = {
+ export interface CSSFunctionParameter {
/**
- * Computed style for the specified DOM node.
+ * The parameter name.
*/
- computedStyle: CSSComputedStyleProperty[];
+ name: string;
+ /**
+ * The parameter type.
+ */
+ type: string;
}
/**
- * Resolve the specified values in the context of the provided element.
-For example, a value of '1em' is evaluated according to the computed
-'font-size' of the element and a value 'calc(1px + 2px)' will be
-resolved to '3px'.
-If the `propertyName` was specified the `values` are resolved as if
-they were property's declaration. If a value cannot be parsed according
-to the provided property syntax, the value is parsed using combined
-syntax as if null `propertyName` was provided. If the value cannot be
-resolved even then, return the provided value without any changes.
+ * CSS function conditional block representation.
*/
- export type resolveValuesParameters = {
- /**
- * Substitution functions (var()/env()/attr()) and cascade-dependent
-keywords (revert/revert-layer) do not work.
- */
- values: string[];
- /**
- * Id of the node in whose context the expression is evaluated
- */
- nodeId: DOM.NodeId;
+ export interface CSSFunctionConditionNode {
/**
- * Only longhands and custom property names are accepted.
+ * Media query for this conditional block. Only one type of condition should be set.
*/
- propertyName?: string;
+ media?: CSSMedia;
/**
- * Pseudo element type, only works for pseudo elements that generate
-elements in the tree, such as ::before and ::after.
+ * Container query for this conditional block. Only one type of condition should be set.
*/
- pseudoType?: DOM.PseudoType;
+ containerQueries?: CSSContainerQuery;
/**
- * Pseudo element custom ident.
+ * @supports CSS at-rule condition. Only one type of condition should be set.
*/
- pseudoIdentifier?: string;
- }
- export type resolveValuesReturnValue = {
- results: string[];
- }
- export type getLonghandPropertiesParameters = {
- shorthandName: string;
- value: string;
- }
- export type getLonghandPropertiesReturnValue = {
- longhandProperties: CSSProperty[];
- }
- /**
- * Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
-attributes) for a DOM node identified by `nodeId`.
- */
- export type getInlineStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getInlineStylesForNodeReturnValue = {
+ supports?: CSSSupports;
/**
- * Inline style for the specified DOM node.
+ * Block body.
*/
- inlineStyle?: CSSStyle;
+ children: CSSFunctionNode[];
/**
- * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
+ * The condition text.
*/
- attributesStyle?: CSSStyle;
+ conditionText: string;
}
/**
- * Returns the styles coming from animations & transitions
-including the animation & transition styles coming from inheritance chain.
+ * Section of the body of a CSS function rule.
*/
- export type getAnimatedStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getAnimatedStylesForNodeReturnValue = {
- /**
- * Styles coming from animations.
- */
- animationStyles?: CSSAnimationStyle[];
+ export interface CSSFunctionNode {
/**
- * Style coming from transitions.
+ * A conditional block. If set, style should not be set.
*/
- transitionsStyle?: CSSStyle;
+ condition?: CSSFunctionConditionNode;
/**
- * Inherited style entries for animationsStyle and transitionsStyle from
-the inheritance chain of the element.
+ * Values set by this node. If set, condition should not be set.
*/
- inherited?: InheritedAnimatedStyleEntry[];
+ style?: CSSStyle;
}
/**
- * Returns requested styles for a DOM node identified by `nodeId`.
+ * CSS function at-rule representation.
*/
- export type getMatchedStylesForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getMatchedStylesForNodeReturnValue = {
- /**
- * Inline style for the specified DOM node.
- */
- inlineStyle?: CSSStyle;
- /**
- * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
- */
- attributesStyle?: CSSStyle;
+ export interface CSSFunctionRule {
/**
- * CSS rules matching this node, from all applicable stylesheets.
+ * Name of the function.
*/
- matchedCSSRules?: RuleMatch[];
+ name: Value;
/**
- * Pseudo style matches for this node.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- pseudoElements?: PseudoElementMatches[];
+ styleSheetId?: StyleSheetId;
/**
- * A chain of inherited styles (from the immediate node parent up to the DOM tree root).
+ * Parent stylesheet's origin.
*/
- inherited?: InheritedStyleEntry[];
+ origin: StyleSheetOrigin;
/**
- * A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
+ * List of parameters.
*/
- inheritedPseudoElements?: InheritedPseudoElementMatches[];
+ parameters: CSSFunctionParameter[];
/**
- * A list of CSS keyframed animations matching this node.
+ * Function body.
*/
- cssKeyframesRules?: CSSKeyframesRule[];
+ children: CSSFunctionNode[];
+ }
+ /**
+ * CSS keyframe rule representation.
+ */
+ export interface CSSKeyframeRule {
/**
- * A list of CSS @position-try rules matching this node, based on the position-try-fallbacks property.
+ * The css style sheet identifier (absent for user agent stylesheet and user-specified
+stylesheet rules) this rule came from.
*/
- cssPositionTryRules?: CSSPositionTryRule[];
+ styleSheetId?: StyleSheetId;
/**
- * Index of the active fallback in the applied position-try-fallback property,
-will not be set if there is no active position-try fallback.
+ * Parent stylesheet's origin.
*/
- activePositionFallbackIndex?: number;
+ origin: StyleSheetOrigin;
/**
- * A list of CSS at-property rules matching this node.
+ * Associated key text.
*/
- cssPropertyRules?: CSSPropertyRule[];
+ keyText: Value;
/**
- * A list of CSS property registrations matching this node.
+ * Associated style declaration.
*/
- cssPropertyRegistrations?: CSSPropertyRegistration[];
+ style: CSSStyle;
+ }
+ /**
+ * A descriptor of operation to mutate style declaration text.
+ */
+ export interface StyleDeclarationEdit {
/**
- * A font-palette-values rule matching this node.
+ * The css style sheet identifier.
*/
- cssFontPaletteValuesRule?: CSSFontPaletteValuesRule;
+ styleSheetId: StyleSheetId;
/**
- * Id of the first parent element that does not have display: contents.
+ * The range of the style text in the enclosing stylesheet.
*/
- parentLayoutNodeId?: DOM.NodeId;
+ range: SourceRange;
/**
- * A list of CSS at-function rules referenced by styles of this node.
+ * New style text.
*/
- cssFunctionRules?: CSSFunctionRule[];
+ text: string;
}
+
/**
- * Returns the values of the default UA-defined environment variables used in env()
+ * Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
+web font.
*/
- export type getEnvironmentVariablesParameters = {
- }
- export type getEnvironmentVariablesReturnValue = {
- environmentVariables: { [key: string]: string };
+ export type fontsUpdatedPayload = {
+ /**
+ * The web font that has loaded.
+ */
+ font?: FontFace;
}
/**
- * Returns all media queries parsed by the rendering engine.
- */
- export type getMediaQueriesParameters = {
- }
- export type getMediaQueriesReturnValue = {
- medias: CSSMedia[];
- }
- /**
- * Requests information about platform fonts which we used to render child TextNodes in the given
-node.
+ * Fires whenever a MediaQuery result changes (for example, after a browser window has been
+resized.) The current implementation considers only viewport-dependent media features.
*/
- export type getPlatformFontsForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getPlatformFontsForNodeReturnValue = {
- /**
- * Usage statistics for every employed platform font.
- */
- fonts: PlatformFontUsage[];
- }
+ export type mediaQueryResultChangedPayload = void;
/**
- * Returns the current textual content for a stylesheet.
+ * Fired whenever an active document stylesheet is added.
*/
- export type getStyleSheetTextParameters = {
- styleSheetId: StyleSheetId;
- }
- export type getStyleSheetTextReturnValue = {
+ export type styleSheetAddedPayload = {
/**
- * The stylesheet text.
+ * Added stylesheet metainfo.
*/
- text: string;
- }
- /**
- * Returns all layers parsed by the rendering engine for the tree scope of a node.
-Given a DOM element identified by nodeId, getLayersForNode returns the root
-layer for the nearest ancestor document or shadow root. The layer root contains
-the full layer tree for the tree scope and their ordering.
- */
- export type getLayersForNodeParameters = {
- nodeId: DOM.NodeId;
- }
- export type getLayersForNodeReturnValue = {
- rootLayer: CSSLayerData;
+ header: CSSStyleSheetHeader;
}
/**
- * Given a CSS selector text and a style sheet ID, getLocationForSelector
-returns an array of locations of the CSS selector in the style sheet.
+ * Fired whenever a stylesheet is changed as a result of the client operation.
*/
- export type getLocationForSelectorParameters = {
+ export type styleSheetChangedPayload = {
styleSheetId: StyleSheetId;
- selectorText: string;
- }
- export type getLocationForSelectorReturnValue = {
- ranges: SourceRange[];
- }
- /**
- * Starts tracking the given node for the computed style updates
-and whenever the computed style is updated for node, it queues
-a `computedStyleUpdated` event with throttling.
-There can only be 1 node tracked for computed style updates
-so passing a new node id removes tracking from the previous node.
-Pass `undefined` to disable tracking.
- */
- export type trackComputedStyleUpdatesForNodeParameters = {
- nodeId?: DOM.NodeId;
- }
- export type trackComputedStyleUpdatesForNodeReturnValue = {
- }
- /**
- * Starts tracking the given computed styles for updates. The specified array of properties
-replaces the one previously specified. Pass empty array to disable tracking.
-Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
-The changes to computed style properties are only tracked for nodes pushed to the front-end
-by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
-to the front-end, no updates will be issued for the node.
- */
- export type trackComputedStyleUpdatesParameters = {
- propertiesToTrack: CSSComputedStyleProperty[];
- }
- export type trackComputedStyleUpdatesReturnValue = {
}
/**
- * Polls the next batch of computed style updates.
+ * Fired whenever an active document stylesheet is removed.
*/
- export type takeComputedStyleUpdatesParameters = {
- }
- export type takeComputedStyleUpdatesReturnValue = {
+ export type styleSheetRemovedPayload = {
/**
- * The list of node Ids that have their tracked computed styles updated.
+ * Identifier of the removed stylesheet.
*/
- nodeIds: DOM.NodeId[];
+ styleSheetId: StyleSheetId;
}
- /**
- * Find a rule with the given active property for the given node and set the new value for this
-property
- */
- export type setEffectivePropertyValueForNodeParameters = {
+ export type computedStyleUpdatedPayload = {
/**
- * The element id for which to set property.
+ * The node id that has updated computed styles.
*/
nodeId: DOM.NodeId;
- propertyName: string;
- value: string;
- }
- export type setEffectivePropertyValueForNodeReturnValue = {
}
+
/**
- * Modifies the property rule property name.
+ * Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
+position specified by `location`.
*/
- export type setPropertyRulePropertyNameParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- propertyName: string;
- }
- export type setPropertyRulePropertyNameReturnValue = {
+ export type addRuleParameters = {
/**
- * The resulting key text after modification.
+ * The css style sheet identifier where a new rule should be inserted.
*/
- propertyName: Value;
- }
- /**
- * Modifies the keyframe rule key text.
- */
- export type setKeyframeKeyParameters = {
styleSheetId: StyleSheetId;
- range: SourceRange;
- keyText: string;
- }
- export type setKeyframeKeyReturnValue = {
/**
- * The resulting key text after modification.
+ * The text of a new rule.
*/
- keyText: Value;
- }
- /**
- * Modifies the rule selector.
- */
- export type setMediaTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ ruleText: string;
+ /**
+ * Text position of a new rule in the target style sheet.
+ */
+ location: SourceRange;
+ /**
+ * NodeId for the DOM node in whose context custom property declarations for registered properties should be
+validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
+incorrect results if the declaration contains a var() for example.
+ */
+ nodeForPropertySyntaxValidation?: DOM.NodeId;
}
- export type setMediaTextReturnValue = {
+ export type addRuleReturnValue = {
/**
- * The resulting CSS media rule after modification.
+ * The newly created rule.
*/
- media: CSSMedia;
+ rule: CSSRule;
}
/**
- * Modifies the expression of a container query.
+ * Returns all class names from specified stylesheet.
*/
- export type setContainerQueryTextParameters = {
+ export type collectClassNamesParameters = {
styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
}
- export type setContainerQueryTextReturnValue = {
+ export type collectClassNamesReturnValue = {
/**
- * The resulting CSS container query rule after modification.
+ * Class name list.
*/
- containerQuery: CSSContainerQuery;
+ classNames: string[];
}
/**
- * Modifies the expression of a supports at-rule.
+ * Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
*/
- export type setSupportsTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ export type createStyleSheetParameters = {
+ /**
+ * Identifier of the frame where "via-inspector" stylesheet should be created.
+ */
+ frameId: Page.FrameId;
+ /**
+ * If true, creates a new stylesheet for every call. If false,
+returns a stylesheet previously created by a call with force=false
+for the frame's document if it exists or creates a new stylesheet
+(default: false).
+ */
+ force?: boolean;
}
- export type setSupportsTextReturnValue = {
+ export type createStyleSheetReturnValue = {
/**
- * The resulting CSS Supports rule after modification.
+ * Identifier of the created "via-inspector" stylesheet.
*/
- supports: CSSSupports;
+ styleSheetId: StyleSheetId;
}
/**
- * Modifies the expression of a scope at-rule.
+ * Disables the CSS agent for the given page.
*/
- export type setScopeTextParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- text: string;
+ export type disableParameters = {
}
- export type setScopeTextReturnValue = {
- /**
- * The resulting CSS Scope rule after modification.
- */
- scope: CSSScope;
+ export type disableReturnValue = {
}
/**
- * Modifies the rule selector.
+ * Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been
+enabled until the result of this command is received.
*/
- export type setRuleSelectorParameters = {
- styleSheetId: StyleSheetId;
- range: SourceRange;
- selector: string;
+ export type enableParameters = {
}
- export type setRuleSelectorReturnValue = {
- /**
- * The resulting selector list after modification.
- */
- selectorList: SelectorList;
+ export type enableReturnValue = {
}
/**
- * Sets the new stylesheet text.
+ * Ensures that the given node will have specified pseudo-classes whenever its style is computed by
+the browser.
*/
- export type setStyleSheetTextParameters = {
- styleSheetId: StyleSheetId;
- text: string;
- }
- export type setStyleSheetTextReturnValue = {
+ export type forcePseudoStateParameters = {
/**
- * URL of source map associated with script (if any).
+ * The element id for which to force the pseudo state.
*/
- sourceMapURL?: string;
+ nodeId: DOM.NodeId;
+ /**
+ * Element pseudo classes to force when computing the element's style.
+ */
+ forcedPseudoClasses: string[];
+ }
+ export type forcePseudoStateReturnValue = {
}
/**
- * Applies specified style edits one after another in the given order.
+ * Ensures that the given node is in its starting-style state.
*/
- export type setStyleTextsParameters = {
- edits: StyleDeclarationEdit[];
+ export type forceStartingStyleParameters = {
/**
- * NodeId for the DOM node in whose context custom property declarations for registered properties should be
-validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
-incorrect results if the declaration contains a var() for example.
+ * The element id for which to force the starting-style state.
*/
- nodeForPropertySyntaxValidation?: DOM.NodeId;
- }
- export type setStyleTextsReturnValue = {
+ nodeId: DOM.NodeId;
/**
- * The resulting styles after modification.
+ * Boolean indicating if this is on or off.
*/
- styles: CSSStyle[];
+ forced: boolean;
}
- /**
- * Enables the selector recording.
- */
- export type startRuleUsageTrackingParameters = {
+ export type forceStartingStyleReturnValue = {
}
- export type startRuleUsageTrackingReturnValue = {
- }
- /**
- * Stop tracking rule usage and return the list of rules that were used since last call to
-`takeCoverageDelta` (or since start of coverage instrumentation).
- */
- export type stopRuleUsageTrackingParameters = {
- }
- export type stopRuleUsageTrackingReturnValue = {
- ruleUsage: RuleUsage[];
- }
- /**
- * Obtain list of rules that became used since last call to this method (or since start of coverage
-instrumentation).
- */
- export type takeCoverageDeltaParameters = {
- }
- export type takeCoverageDeltaReturnValue = {
- coverage: RuleUsage[];
- /**
- * Monotonically increasing time, in seconds.
- */
- timestamp: number;
- }
- /**
- * Enables/disables rendering of local CSS fonts (enabled by default).
- */
- export type setLocalFontsEnabledParameters = {
+ export type getBackgroundColorsParameters = {
/**
- * Whether rendering of local fonts is enabled.
+ * Id of the node to get background colors for.
*/
- enabled: boolean;
- }
- export type setLocalFontsEnabledReturnValue = {
+ nodeId: DOM.NodeId;
}
- }
-
- export module CacheStorage {
- /**
- * Unique identifier of the Cache object.
- */
- export type CacheId = string;
- /**
- * type of HTTP response cached
- */
- export type CachedResponseType = "basic"|"cors"|"default"|"error"|"opaqueResponse"|"opaqueRedirect";
- /**
- * Data entry.
- */
- export interface DataEntry {
- /**
- * Request URL.
- */
- requestURL: string;
- /**
- * Request method.
- */
- requestMethod: string;
- /**
- * Request headers
- */
- requestHeaders: Header[];
+ export type getBackgroundColorsReturnValue = {
/**
- * Number of seconds since epoch.
+ * The range of background colors behind this element, if it contains any visible text. If no
+visible text is present, this will be undefined. In the case of a flat background color,
+this will consist of simply that color. In the case of a gradient, this will consist of each
+of the color stops. For anything more complicated, this will be an empty array. Images will
+be ignored (as if the image had failed to load).
*/
- responseTime: number;
+ backgroundColors?: string[];
/**
- * HTTP response status code.
+ * The computed font size for this node, as a CSS computed value string (e.g. '12px').
*/
- responseStatus: number;
+ computedFontSize?: string;
/**
- * HTTP response status text.
+ * The computed font weight for this node, as a CSS computed value string (e.g. 'normal' or
+'100').
*/
- responseStatusText: string;
+ computedFontWeight?: string;
+ }
+ /**
+ * Returns the computed style for a DOM node identified by `nodeId`.
+ */
+ export type getComputedStyleForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getComputedStyleForNodeReturnValue = {
/**
- * HTTP response type
+ * Computed style for the specified DOM node.
*/
- responseType: CachedResponseType;
+ computedStyle: CSSComputedStyleProperty[];
/**
- * Response headers
+ * A list of non-standard "extra fields" which blink stores alongside each
+computed style.
*/
- responseHeaders: Header[];
+ extraFields: ComputedStyleExtraFields;
}
/**
- * Cache identifier.
+ * Resolve the specified values in the context of the provided element.
+For example, a value of '1em' is evaluated according to the computed
+'font-size' of the element and a value 'calc(1px + 2px)' will be
+resolved to '3px'.
+If the `propertyName` was specified the `values` are resolved as if
+they were property's declaration. If a value cannot be parsed according
+to the provided property syntax, the value is parsed using combined
+syntax as if null `propertyName` was provided. If the value cannot be
+resolved even then, return the provided value without any changes.
*/
- export interface Cache {
+ export type resolveValuesParameters = {
/**
- * An opaque unique id of the cache.
+ * Cascade-dependent keywords (revert/revert-layer) do not work.
*/
- cacheId: CacheId;
+ values: string[];
/**
- * Security origin of the cache.
+ * Id of the node in whose context the expression is evaluated
*/
- securityOrigin: string;
+ nodeId: DOM.NodeId;
/**
- * Storage key of the cache.
+ * Only longhands and custom property names are accepted.
*/
- storageKey: string;
+ propertyName?: string;
/**
- * Storage bucket of the cache.
+ * Pseudo element type, only works for pseudo elements that generate
+elements in the tree, such as ::before and ::after.
*/
- storageBucket?: Storage.StorageBucket;
+ pseudoType?: DOM.PseudoType;
/**
- * The name of the cache.
+ * Pseudo element custom ident.
*/
- cacheName: string;
+ pseudoIdentifier?: string;
}
- export interface Header {
- name: string;
+ export type resolveValuesReturnValue = {
+ results: string[];
+ }
+ export type getLonghandPropertiesParameters = {
+ shorthandName: string;
value: string;
}
+ export type getLonghandPropertiesReturnValue = {
+ longhandProperties: CSSProperty[];
+ }
/**
- * Cached response
+ * Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
+attributes) for a DOM node identified by `nodeId`.
*/
- export interface CachedResponse {
+ export type getInlineStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getInlineStylesForNodeReturnValue = {
/**
- * Entry content, base64-encoded.
+ * Inline style for the specified DOM node.
*/
- body: binary;
- }
-
-
- /**
- * Deletes a cache.
- */
- export type deleteCacheParameters = {
+ inlineStyle?: CSSStyle;
/**
- * Id of cache for deletion.
+ * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
*/
- cacheId: CacheId;
- }
- export type deleteCacheReturnValue = {
+ attributesStyle?: CSSStyle;
}
/**
- * Deletes a cache entry.
+ * Returns the styles coming from animations & transitions
+including the animation & transition styles coming from inheritance chain.
*/
- export type deleteEntryParameters = {
+ export type getAnimatedStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getAnimatedStylesForNodeReturnValue = {
/**
- * Id of cache where the entry will be deleted.
+ * Styles coming from animations.
*/
- cacheId: CacheId;
+ animationStyles?: CSSAnimationStyle[];
/**
- * URL spec of the request.
+ * Style coming from transitions.
*/
- request: string;
- }
- export type deleteEntryReturnValue = {
+ transitionsStyle?: CSSStyle;
+ /**
+ * Inherited style entries for animationsStyle and transitionsStyle from
+the inheritance chain of the element.
+ */
+ inherited?: InheritedAnimatedStyleEntry[];
}
/**
- * Requests cache names.
+ * Returns requested styles for a DOM node identified by `nodeId`.
*/
- export type requestCacheNamesParameters = {
+ export type getMatchedStylesForNodeParameters = {
+ nodeId: DOM.NodeId;
+ }
+ export type getMatchedStylesForNodeReturnValue = {
/**
- * At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
-Security origin.
+ * Inline style for the specified DOM node.
*/
- securityOrigin?: string;
+ inlineStyle?: CSSStyle;
/**
- * Storage key.
+ * Attribute-defined element style (e.g. resulting from "width=20 height=100%").
*/
- storageKey?: string;
+ attributesStyle?: CSSStyle;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * CSS rules matching this node, from all applicable stylesheets.
*/
- storageBucket?: Storage.StorageBucket;
- }
- export type requestCacheNamesReturnValue = {
+ matchedCSSRules?: RuleMatch[];
/**
- * Caches for the security origin.
+ * Pseudo style matches for this node.
*/
- caches: Cache[];
- }
- /**
- * Fetches cache entry.
- */
- export type requestCachedResponseParameters = {
+ pseudoElements?: PseudoElementMatches[];
/**
- * Id of cache that contains the entry.
+ * A chain of inherited styles (from the immediate node parent up to the DOM tree root).
*/
- cacheId: CacheId;
+ inherited?: InheritedStyleEntry[];
/**
- * URL spec of the request.
+ * A chain of inherited pseudo element styles (from the immediate node parent up to the DOM tree root).
*/
- requestURL: string;
+ inheritedPseudoElements?: InheritedPseudoElementMatches[];
/**
- * headers of the request.
+ * A list of CSS keyframed animations matching this node.
*/
- requestHeaders: Header[];
- }
- export type requestCachedResponseReturnValue = {
+ cssKeyframesRules?: CSSKeyframesRule[];
/**
- * Response read from the cache.
+ * A list of CSS @position-try rules matching this node, based on the position-try-fallbacks property.
*/
- response: CachedResponse;
- }
- /**
- * Requests data from cache.
- */
- export type requestEntriesParameters = {
+ cssPositionTryRules?: CSSPositionTryRule[];
/**
- * ID of cache to get entries from.
+ * Index of the active fallback in the applied position-try-fallback property,
+will not be set if there is no active position-try fallback.
*/
- cacheId: CacheId;
+ activePositionFallbackIndex?: number;
/**
- * Number of records to skip.
+ * A list of CSS at-property rules matching this node.
*/
- skipCount?: number;
+ cssPropertyRules?: CSSPropertyRule[];
/**
- * Number of records to fetch.
+ * A list of CSS property registrations matching this node.
*/
- pageSize?: number;
+ cssPropertyRegistrations?: CSSPropertyRegistration[];
/**
- * If present, only return the entries containing this substring in the path
+ * A font-palette-values rule matching this node.
*/
- pathFilter?: string;
- }
- export type requestEntriesReturnValue = {
+ cssFontPaletteValuesRule?: CSSFontPaletteValuesRule;
/**
- * Array of object store data entries.
- */
- cacheDataEntries: DataEntry[];
- /**
- * Count of returned entries from this storage. If pathFilter is empty, it
-is the count of all entries from this storage.
+ * Id of the first parent element that does not have display: contents.
*/
- returnCount: number;
- }
- }
-
- /**
- * A domain for interacting with Cast, Presentation API, and Remote Playback API
-functionalities.
- */
- export module Cast {
- export interface Sink {
- name: string;
- id: string;
+ parentLayoutNodeId?: DOM.NodeId;
/**
- * Text describing the current session. Present only if there is an active
-session on the sink.
+ * A list of CSS at-function rules referenced by styles of this node.
*/
- session?: string;
+ cssFunctionRules?: CSSFunctionRule[];
}
-
/**
- * This is fired whenever the list of available sinks changes. A sink is a
-device or a software surface that you can cast to.
+ * Returns the values of the default UA-defined environment variables used in env()
*/
- export type sinksUpdatedPayload = {
- sinks: Sink[];
+ export type getEnvironmentVariablesParameters = {
}
- /**
- * This is fired whenever the outstanding issue/error message changes.
-|issueMessage| is empty if there is no issue.
- */
- export type issueUpdatedPayload = {
- issueMessage: string;
+ export type getEnvironmentVariablesReturnValue = {
+ environmentVariables: { [key: string]: string };
}
-
/**
- * Starts observing for sinks that can be used for tab mirroring, and if set,
-sinks compatible with |presentationUrl| as well. When sinks are found, a
-|sinksUpdated| event is fired.
-Also starts observing for issue messages. When an issue is added or removed,
-an |issueUpdated| event is fired.
+ * Returns all media queries parsed by the rendering engine.
*/
- export type enableParameters = {
- presentationUrl?: string;
+ export type getMediaQueriesParameters = {
}
- export type enableReturnValue = {
+ export type getMediaQueriesReturnValue = {
+ medias: CSSMedia[];
}
/**
- * Stops observing for sinks and issues.
+ * Requests information about platform fonts which we used to render child TextNodes in the given
+node.
*/
- export type disableParameters = {
+ export type getPlatformFontsForNodeParameters = {
+ nodeId: DOM.NodeId;
}
- export type disableReturnValue = {
+ export type getPlatformFontsForNodeReturnValue = {
+ /**
+ * Usage statistics for every employed platform font.
+ */
+ fonts: PlatformFontUsage[];
}
/**
- * Sets a sink to be used when the web page requests the browser to choose a
-sink via Presentation API, Remote Playback API, or Cast SDK.
+ * Returns the current textual content for a stylesheet.
*/
- export type setSinkToUseParameters = {
- sinkName: string;
+ export type getStyleSheetTextParameters = {
+ styleSheetId: StyleSheetId;
}
- export type setSinkToUseReturnValue = {
+ export type getStyleSheetTextReturnValue = {
+ /**
+ * The stylesheet text.
+ */
+ text: string;
}
/**
- * Starts mirroring the desktop to the sink.
+ * Returns all layers parsed by the rendering engine for the tree scope of a node.
+Given a DOM element identified by nodeId, getLayersForNode returns the root
+layer for the nearest ancestor document or shadow root. The layer root contains
+the full layer tree for the tree scope and their ordering.
*/
- export type startDesktopMirroringParameters = {
- sinkName: string;
+ export type getLayersForNodeParameters = {
+ nodeId: DOM.NodeId;
}
- export type startDesktopMirroringReturnValue = {
+ export type getLayersForNodeReturnValue = {
+ rootLayer: CSSLayerData;
}
/**
- * Starts mirroring the tab to the sink.
+ * Given a CSS selector text and a style sheet ID, getLocationForSelector
+returns an array of locations of the CSS selector in the style sheet.
*/
- export type startTabMirroringParameters = {
- sinkName: string;
+ export type getLocationForSelectorParameters = {
+ styleSheetId: StyleSheetId;
+ selectorText: string;
}
- export type startTabMirroringReturnValue = {
+ export type getLocationForSelectorReturnValue = {
+ ranges: SourceRange[];
}
/**
- * Stops the active Cast session on the sink.
+ * Starts tracking the given node for the computed style updates
+and whenever the computed style is updated for node, it queues
+a `computedStyleUpdated` event with throttling.
+There can only be 1 node tracked for computed style updates
+so passing a new node id removes tracking from the previous node.
+Pass `undefined` to disable tracking.
*/
- export type stopCastingParameters = {
- sinkName: string;
+ export type trackComputedStyleUpdatesForNodeParameters = {
+ nodeId?: DOM.NodeId;
}
- export type stopCastingReturnValue = {
+ export type trackComputedStyleUpdatesForNodeReturnValue = {
}
- }
-
- /**
- * This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
-that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
-the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
-nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
-and never sends the same node twice. It is client's responsibility to collect information about
-the nodes that were sent to the client. Note that `iframe` owner elements will return
-corresponding document elements as their child nodes.
- */
- export module DOM {
- /**
- * Unique DOM node identifier.
- */
- export type NodeId = number;
/**
- * Unique DOM node identifier used to reference a node that may not have been pushed to the
-front-end.
+ * Starts tracking the given computed styles for updates. The specified array of properties
+replaces the one previously specified. Pass empty array to disable tracking.
+Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified.
+The changes to computed style properties are only tracked for nodes pushed to the front-end
+by the DOM agent. If no changes to the tracked properties occur after the node has been pushed
+to the front-end, no updates will be issued for the node.
*/
- export type BackendNodeId = number;
+ export type trackComputedStyleUpdatesParameters = {
+ propertiesToTrack: CSSComputedStyleProperty[];
+ }
+ export type trackComputedStyleUpdatesReturnValue = {
+ }
/**
- * Backend node with a friendly name.
+ * Polls the next batch of computed style updates.
*/
- export interface BackendNode {
- /**
- * `Node`'s nodeType.
- */
- nodeType: number;
+ export type takeComputedStyleUpdatesParameters = {
+ }
+ export type takeComputedStyleUpdatesReturnValue = {
/**
- * `Node`'s nodeName.
+ * The list of node Ids that have their tracked computed styles updated.
*/
- nodeName: string;
- backendNodeId: BackendNodeId;
+ nodeIds: DOM.NodeId[];
}
/**
- * Pseudo element type.
+ * Find a rule with the given active property for the given node and set the new value for this
+property
*/
- export type PseudoType = "first-line"|"first-letter"|"checkmark"|"before"|"after"|"picker-icon"|"marker"|"backdrop"|"column"|"selection"|"search-text"|"target-text"|"spelling-error"|"grammar-error"|"highlight"|"first-line-inherited"|"scroll-marker"|"scroll-marker-group"|"scroll-button"|"scrollbar"|"scrollbar-thumb"|"scrollbar-button"|"scrollbar-track"|"scrollbar-track-piece"|"scrollbar-corner"|"resizer"|"input-list-button"|"view-transition"|"view-transition-group"|"view-transition-image-pair"|"view-transition-group-children"|"view-transition-old"|"view-transition-new"|"placeholder"|"file-selector-button"|"details-content"|"picker"|"permission-icon";
+ export type setEffectivePropertyValueForNodeParameters = {
+ /**
+ * The element id for which to set property.
+ */
+ nodeId: DOM.NodeId;
+ propertyName: string;
+ value: string;
+ }
+ export type setEffectivePropertyValueForNodeReturnValue = {
+ }
/**
- * Shadow root type.
+ * Modifies the property rule property name.
*/
- export type ShadowRootType = "user-agent"|"open"|"closed";
+ export type setPropertyRulePropertyNameParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ propertyName: string;
+ }
+ export type setPropertyRulePropertyNameReturnValue = {
+ /**
+ * The resulting key text after modification.
+ */
+ propertyName: Value;
+ }
/**
- * Document compatibility mode.
+ * Modifies the keyframe rule key text.
*/
- export type CompatibilityMode = "QuirksMode"|"LimitedQuirksMode"|"NoQuirksMode";
+ export type setKeyframeKeyParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ keyText: string;
+ }
+ export type setKeyframeKeyReturnValue = {
+ /**
+ * The resulting key text after modification.
+ */
+ keyText: Value;
+ }
/**
- * ContainerSelector physical axes
+ * Modifies the rule selector.
*/
- export type PhysicalAxes = "Horizontal"|"Vertical"|"Both";
+ export type setMediaTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setMediaTextReturnValue = {
+ /**
+ * The resulting CSS media rule after modification.
+ */
+ media: CSSMedia;
+ }
/**
- * ContainerSelector logical axes
+ * Modifies the expression of a container query.
*/
- export type LogicalAxes = "Inline"|"Block"|"Both";
+ export type setContainerQueryTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setContainerQueryTextReturnValue = {
+ /**
+ * The resulting CSS container query rule after modification.
+ */
+ containerQuery: CSSContainerQuery;
+ }
/**
- * Physical scroll orientation
+ * Modifies the expression of a supports at-rule.
*/
- export type ScrollOrientation = "horizontal"|"vertical";
+ export type setSupportsTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setSupportsTextReturnValue = {
+ /**
+ * The resulting CSS Supports rule after modification.
+ */
+ supports: CSSSupports;
+ }
/**
- * DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
-DOMNode is a base node mirror type.
+ * Modifies the expression of a scope at-rule.
*/
- export interface Node {
+ export type setScopeTextParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ text: string;
+ }
+ export type setScopeTextReturnValue = {
/**
- * Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
-will only push node with given `id` once. It is aware of all requested nodes and will only
-fire DOM events for nodes known to the client.
+ * The resulting CSS Scope rule after modification.
*/
- nodeId: NodeId;
- /**
- * The id of the parent node if any.
- */
- parentId?: NodeId;
+ scope: CSSScope;
+ }
+ /**
+ * Modifies the rule selector.
+ */
+ export type setRuleSelectorParameters = {
+ styleSheetId: StyleSheetId;
+ range: SourceRange;
+ selector: string;
+ }
+ export type setRuleSelectorReturnValue = {
/**
- * The BackendNodeId for this node.
+ * The resulting selector list after modification.
*/
- backendNodeId: BackendNodeId;
+ selectorList: SelectorList;
+ }
+ /**
+ * Sets the new stylesheet text.
+ */
+ export type setStyleSheetTextParameters = {
+ styleSheetId: StyleSheetId;
+ text: string;
+ }
+ export type setStyleSheetTextReturnValue = {
/**
- * `Node`'s nodeType.
+ * URL of source map associated with script (if any).
*/
- nodeType: number;
+ sourceMapURL?: string;
+ }
+ /**
+ * Applies specified style edits one after another in the given order.
+ */
+ export type setStyleTextsParameters = {
+ edits: StyleDeclarationEdit[];
/**
- * `Node`'s nodeName.
+ * NodeId for the DOM node in whose context custom property declarations for registered properties should be
+validated. If omitted, declarations in the new rule text can only be validated statically, which may produce
+incorrect results if the declaration contains a var() for example.
*/
- nodeName: string;
+ nodeForPropertySyntaxValidation?: DOM.NodeId;
+ }
+ export type setStyleTextsReturnValue = {
/**
- * `Node`'s localName.
+ * The resulting styles after modification.
*/
- localName: string;
+ styles: CSSStyle[];
+ }
+ /**
+ * Enables the selector recording.
+ */
+ export type startRuleUsageTrackingParameters = {
+ }
+ export type startRuleUsageTrackingReturnValue = {
+ }
+ /**
+ * Stop tracking rule usage and return the list of rules that were used since last call to
+`takeCoverageDelta` (or since start of coverage instrumentation).
+ */
+ export type stopRuleUsageTrackingParameters = {
+ }
+ export type stopRuleUsageTrackingReturnValue = {
+ ruleUsage: RuleUsage[];
+ }
+ /**
+ * Obtain list of rules that became used since last call to this method (or since start of coverage
+instrumentation).
+ */
+ export type takeCoverageDeltaParameters = {
+ }
+ export type takeCoverageDeltaReturnValue = {
+ coverage: RuleUsage[];
/**
- * `Node`'s nodeValue.
+ * Monotonically increasing time, in seconds.
*/
- nodeValue: string;
+ timestamp: number;
+ }
+ /**
+ * Enables/disables rendering of local CSS fonts (enabled by default).
+ */
+ export type setLocalFontsEnabledParameters = {
/**
- * Child count for `Container` nodes.
+ * Whether rendering of local fonts is enabled.
*/
- childNodeCount?: number;
+ enabled: boolean;
+ }
+ export type setLocalFontsEnabledReturnValue = {
+ }
+ }
+
+ export module CacheStorage {
+ /**
+ * Unique identifier of the Cache object.
+ */
+ export type CacheId = string;
+ /**
+ * type of HTTP response cached
+ */
+ export type CachedResponseType = "basic"|"cors"|"default"|"error"|"opaqueResponse"|"opaqueRedirect";
+ /**
+ * Data entry.
+ */
+ export interface DataEntry {
/**
- * Child nodes of this node when requested with children.
+ * Request URL.
*/
- children?: Node[];
+ requestURL: string;
/**
- * Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
+ * Request method.
*/
- attributes?: string[];
+ requestMethod: string;
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * Request headers
*/
- documentURL?: string;
+ requestHeaders: Header[];
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Number of seconds since epoch.
*/
- baseURL?: string;
+ responseTime: number;
/**
- * `DocumentType`'s publicId.
+ * HTTP response status code.
*/
- publicId?: string;
+ responseStatus: number;
/**
- * `DocumentType`'s systemId.
+ * HTTP response status text.
*/
- systemId?: string;
+ responseStatusText: string;
/**
- * `DocumentType`'s internalSubset.
+ * HTTP response type
*/
- internalSubset?: string;
+ responseType: CachedResponseType;
/**
- * `Document`'s XML version in case of XML documents.
+ * Response headers
*/
- xmlVersion?: string;
+ responseHeaders: Header[];
+ }
+ /**
+ * Cache identifier.
+ */
+ export interface Cache {
/**
- * `Attr`'s name.
+ * An opaque unique id of the cache.
*/
- name?: string;
+ cacheId: CacheId;
/**
- * `Attr`'s value.
+ * Security origin of the cache.
*/
- value?: string;
+ securityOrigin: string;
/**
- * Pseudo element type for this node.
+ * Storage key of the cache.
*/
- pseudoType?: PseudoType;
+ storageKey: string;
/**
- * Pseudo element identifier for this node. Only present if there is a
-valid pseudoType.
+ * Storage bucket of the cache.
*/
- pseudoIdentifier?: string;
+ storageBucket?: Storage.StorageBucket;
/**
- * Shadow root type.
+ * The name of the cache.
*/
- shadowRootType?: ShadowRootType;
+ cacheName: string;
+ }
+ export interface Header {
+ name: string;
+ value: string;
+ }
+ /**
+ * Cached response
+ */
+ export interface CachedResponse {
/**
- * Frame ID for frame owner elements.
+ * Entry content, base64-encoded.
*/
- frameId?: Page.FrameId;
+ body: binary;
+ }
+
+
+ /**
+ * Deletes a cache.
+ */
+ export type deleteCacheParameters = {
/**
- * Content document for frame owner elements.
+ * Id of cache for deletion.
*/
- contentDocument?: Node;
+ cacheId: CacheId;
+ }
+ export type deleteCacheReturnValue = {
+ }
+ /**
+ * Deletes a cache entry.
+ */
+ export type deleteEntryParameters = {
/**
- * Shadow root list for given element host.
+ * Id of cache where the entry will be deleted.
*/
- shadowRoots?: Node[];
+ cacheId: CacheId;
/**
- * Content document fragment for template elements.
+ * URL spec of the request.
*/
- templateContent?: Node;
+ request: string;
+ }
+ export type deleteEntryReturnValue = {
+ }
+ /**
+ * Requests cache names.
+ */
+ export type requestCacheNamesParameters = {
/**
- * Pseudo elements associated with this node.
+ * At least and at most one of securityOrigin, storageKey, storageBucket must be specified.
+Security origin.
*/
- pseudoElements?: Node[];
+ securityOrigin?: string;
/**
- * Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
-This property used to return the imported document for the HTMLImport links.
-The property is always undefined now.
+ * Storage key.
*/
- importedDocument?: Node;
+ storageKey?: string;
/**
- * Distributed nodes for given insertion point.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- distributedNodes?: BackendNode[];
+ storageBucket?: Storage.StorageBucket;
+ }
+ export type requestCacheNamesReturnValue = {
/**
- * Whether the node is SVG.
+ * Caches for the security origin.
*/
- isSVG?: boolean;
- compatibilityMode?: CompatibilityMode;
- assignedSlot?: BackendNode;
- isScrollable?: boolean;
- }
- /**
- * A structure to hold the top-level node of a detached tree and an array of its retained descendants.
- */
- export interface DetachedElementInfo {
- treeNode: Node;
- retainedNodeIds: NodeId[];
+ caches: Cache[];
}
/**
- * A structure holding an RGBA color.
+ * Fetches cache entry.
*/
- export interface RGBA {
+ export type requestCachedResponseParameters = {
/**
- * The red component, in the [0-255] range.
+ * Id of cache that contains the entry.
*/
- r: number;
+ cacheId: CacheId;
/**
- * The green component, in the [0-255] range.
+ * URL spec of the request.
*/
- g: number;
+ requestURL: string;
/**
- * The blue component, in the [0-255] range.
+ * headers of the request.
*/
- b: number;
+ requestHeaders: Header[];
+ }
+ export type requestCachedResponseReturnValue = {
/**
- * The alpha component, in the [0-1] range (default: 1).
+ * Response read from the cache.
*/
- a?: number;
+ response: CachedResponse;
}
/**
- * An array of quad vertices, x immediately followed by y for each point, points clock-wise.
- */
- export type Quad = number[];
- /**
- * Box model.
+ * Requests data from cache.
*/
- export interface BoxModel {
+ export type requestEntriesParameters = {
/**
- * Content box
+ * ID of cache to get entries from.
*/
- content: Quad;
+ cacheId: CacheId;
/**
- * Padding box
+ * Number of records to skip.
*/
- padding: Quad;
+ skipCount?: number;
/**
- * Border box
+ * Number of records to fetch.
*/
- border: Quad;
+ pageSize?: number;
/**
- * Margin box
+ * If present, only return the entries containing this substring in the path
*/
- margin: Quad;
+ pathFilter?: string;
+ }
+ export type requestEntriesReturnValue = {
/**
- * Node width
+ * Array of object store data entries.
*/
- width: number;
+ cacheDataEntries: DataEntry[];
/**
- * Node height
+ * Count of returned entries from this storage. If pathFilter is empty, it
+is the count of all entries from this storage.
*/
- height: number;
+ returnCount: number;
+ }
+ }
+
+ /**
+ * A domain for interacting with Cast, Presentation API, and Remote Playback API
+functionalities.
+ */
+ export module Cast {
+ export interface Sink {
+ name: string;
+ id: string;
/**
- * Shape outside coordinates
+ * Text describing the current session. Present only if there is an active
+session on the sink.
*/
- shapeOutside?: ShapeOutsideInfo;
+ session?: string;
}
+
/**
- * CSS Shape Outside details.
+ * This is fired whenever the list of available sinks changes. A sink is a
+device or a software surface that you can cast to.
*/
- export interface ShapeOutsideInfo {
- /**
- * Shape bounds
- */
- bounds: Quad;
- /**
- * Shape coordinate details
- */
- shape: any[];
- /**
- * Margin shape bounds
- */
- marginShape: any[];
+ export type sinksUpdatedPayload = {
+ sinks: Sink[];
}
/**
- * Rectangle.
+ * This is fired whenever the outstanding issue/error message changes.
+|issueMessage| is empty if there is no issue.
*/
- export interface Rect {
- /**
- * X coordinate
- */
- x: number;
- /**
- * Y coordinate
- */
- y: number;
- /**
- * Rectangle width
- */
- width: number;
- /**
- * Rectangle height
- */
- height: number;
- }
- export interface CSSComputedStyleProperty {
- /**
- * Computed style property name.
- */
- name: string;
- /**
- * Computed style property value.
- */
- value: string;
+ export type issueUpdatedPayload = {
+ issueMessage: string;
}
/**
- * Fired when `Element`'s attribute is modified.
+ * Starts observing for sinks that can be used for tab mirroring, and if set,
+sinks compatible with |presentationUrl| as well. When sinks are found, a
+|sinksUpdated| event is fired.
+Also starts observing for issue messages. When an issue is added or removed,
+an |issueUpdated| event is fired.
*/
- export type attributeModifiedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * Attribute name.
- */
- name: string;
- /**
- * Attribute value.
- */
- value: string;
+ export type enableParameters = {
+ presentationUrl?: string;
+ }
+ export type enableReturnValue = {
}
/**
- * Fired when `Element`'s attribute is removed.
+ * Stops observing for sinks and issues.
*/
- export type attributeRemovedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * A ttribute name.
- */
- name: string;
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
}
/**
- * Mirrors `DOMCharacterDataModified` event.
+ * Sets a sink to be used when the web page requests the browser to choose a
+sink via Presentation API, Remote Playback API, or Cast SDK.
*/
- export type characterDataModifiedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * New text value.
- */
- characterData: string;
+ export type setSinkToUseParameters = {
+ sinkName: string;
+ }
+ export type setSinkToUseReturnValue = {
}
/**
- * Fired when `Container`'s child node count has changed.
+ * Starts mirroring the desktop to the sink.
*/
- export type childNodeCountUpdatedPayload = {
- /**
- * Id of the node that has changed.
- */
- nodeId: NodeId;
- /**
- * New node count.
- */
- childNodeCount: number;
+ export type startDesktopMirroringParameters = {
+ sinkName: string;
+ }
+ export type startDesktopMirroringReturnValue = {
}
/**
- * Mirrors `DOMNodeInserted` event.
+ * Starts mirroring the tab to the sink.
*/
- export type childNodeInsertedPayload = {
- /**
- * Id of the node that has changed.
- */
- parentNodeId: NodeId;
- /**
- * Id of the previous sibling.
- */
- previousNodeId: NodeId;
- /**
- * Inserted node data.
- */
- node: Node;
+ export type startTabMirroringParameters = {
+ sinkName: string;
+ }
+ export type startTabMirroringReturnValue = {
}
/**
- * Mirrors `DOMNodeRemoved` event.
+ * Stops the active Cast session on the sink.
*/
- export type childNodeRemovedPayload = {
- /**
- * Parent id.
- */
- parentNodeId: NodeId;
- /**
- * Id of the node that has been removed.
- */
- nodeId: NodeId;
+ export type stopCastingParameters = {
+ sinkName: string;
+ }
+ export type stopCastingReturnValue = {
}
+ }
+
+ /**
+ * This domain exposes DOM read/write operations. Each DOM Node is represented with its mirror object
+that has an `id`. This `id` can be used to get additional information on the Node, resolve it into
+the JavaScript object wrapper, etc. It is important that client receives DOM events only for the
+nodes that are known to the client. Backend keeps track of the nodes that were sent to the client
+and never sends the same node twice. It is client's responsibility to collect information about
+the nodes that were sent to the client. Note that `iframe` owner elements will return
+corresponding document elements as their child nodes.
+ */
+ export module DOM {
/**
- * Called when distribution is changed.
+ * Unique DOM node identifier.
*/
- export type distributedNodesUpdatedPayload = {
+ export type NodeId = number;
+ /**
+ * Unique DOM node identifier used to reference a node that may not have been pushed to the
+front-end.
+ */
+ export type BackendNodeId = number;
+ /**
+ * Backend node with a friendly name.
+ */
+ export interface BackendNode {
/**
- * Insertion point where distributed nodes were updated.
+ * `Node`'s nodeType.
*/
- insertionPointId: NodeId;
+ nodeType: number;
/**
- * Distributed nodes for given insertion point.
+ * `Node`'s nodeName.
*/
- distributedNodes: BackendNode[];
+ nodeName: string;
+ backendNodeId: BackendNodeId;
}
/**
- * Fired when `Document` has been totally updated. Node ids are no longer valid.
+ * Pseudo element type.
*/
- export type documentUpdatedPayload = void;
+ export type PseudoType = "first-line"|"first-letter"|"checkmark"|"before"|"after"|"picker-icon"|"interest-hint"|"marker"|"backdrop"|"column"|"selection"|"search-text"|"target-text"|"spelling-error"|"grammar-error"|"highlight"|"first-line-inherited"|"scroll-marker"|"scroll-marker-group"|"scroll-button"|"scrollbar"|"scrollbar-thumb"|"scrollbar-button"|"scrollbar-track"|"scrollbar-track-piece"|"scrollbar-corner"|"resizer"|"input-list-button"|"view-transition"|"view-transition-group"|"view-transition-image-pair"|"view-transition-group-children"|"view-transition-old"|"view-transition-new"|"placeholder"|"file-selector-button"|"details-content"|"picker"|"permission-icon";
/**
- * Fired when `Element`'s inline style is modified via a CSS property modification.
+ * Shadow root type.
*/
- export type inlineStyleInvalidatedPayload = {
- /**
- * Ids of the nodes for which the inline styles have been invalidated.
- */
- nodeIds: NodeId[];
- }
+ export type ShadowRootType = "user-agent"|"open"|"closed";
/**
- * Called when a pseudo element is added to an element.
+ * Document compatibility mode.
*/
- export type pseudoElementAddedPayload = {
- /**
- * Pseudo element's parent element id.
- */
- parentId: NodeId;
- /**
- * The added pseudo element.
- */
- pseudoElement: Node;
- }
+ export type CompatibilityMode = "QuirksMode"|"LimitedQuirksMode"|"NoQuirksMode";
/**
- * Called when top layer elements are changed.
+ * ContainerSelector physical axes
*/
- export type topLayerElementsUpdatedPayload = void;
+ export type PhysicalAxes = "Horizontal"|"Vertical"|"Both";
/**
- * Fired when a node's scrollability state changes.
+ * ContainerSelector logical axes
*/
- export type scrollableFlagUpdatedPayload = {
+ export type LogicalAxes = "Inline"|"Block"|"Both";
+ /**
+ * Physical scroll orientation
+ */
+ export type ScrollOrientation = "horizontal"|"vertical";
+ /**
+ * DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
+DOMNode is a base node mirror type.
+ */
+ export interface Node {
/**
- * The id of the node.
+ * Node identifier that is passed into the rest of the DOM messages as the `nodeId`. Backend
+will only push node with given `id` once. It is aware of all requested nodes and will only
+fire DOM events for nodes known to the client.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * If the node is scrollable.
+ * The id of the parent node if any.
*/
- isScrollable: boolean;
- }
- /**
- * Called when a pseudo element is removed from an element.
- */
- export type pseudoElementRemovedPayload = {
+ parentId?: NodeId;
/**
- * Pseudo element's parent element id.
+ * The BackendNodeId for this node.
*/
- parentId: NodeId;
+ backendNodeId: BackendNodeId;
/**
- * The removed pseudo element id.
+ * `Node`'s nodeType.
*/
- pseudoElementId: NodeId;
- }
- /**
- * Fired when backend wants to provide client with the missing DOM structure. This happens upon
-most of the calls requesting node ids.
- */
- export type setChildNodesPayload = {
+ nodeType: number;
/**
- * Parent node id to populate with children.
+ * `Node`'s nodeName.
*/
- parentId: NodeId;
+ nodeName: string;
/**
- * Child nodes array.
+ * `Node`'s localName.
*/
- nodes: Node[];
- }
- /**
- * Called when shadow root is popped from the element.
- */
- export type shadowRootPoppedPayload = {
+ localName: string;
/**
- * Host element id.
+ * `Node`'s nodeValue.
*/
- hostId: NodeId;
+ nodeValue: string;
/**
- * Shadow root id.
+ * Child count for `Container` nodes.
*/
- rootId: NodeId;
- }
- /**
- * Called when shadow root is pushed into the element.
- */
- export type shadowRootPushedPayload = {
+ childNodeCount?: number;
/**
- * Host element id.
+ * Child nodes of this node when requested with children.
*/
- hostId: NodeId;
+ children?: Node[];
/**
- * Shadow root.
+ * Attributes of the `Element` node in the form of flat array `[name1, value1, name2, value2]`.
*/
- root: Node;
- }
-
- /**
- * Collects class names for the node with given id and all of it's child nodes.
- */
- export type collectClassNamesFromSubtreeParameters = {
+ attributes?: string[];
/**
- * Id of the node to collect class names.
+ * Document URL that `Document` or `FrameOwner` node points to.
*/
- nodeId: NodeId;
- }
- export type collectClassNamesFromSubtreeReturnValue = {
+ documentURL?: string;
/**
- * Class name list.
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
*/
- classNames: string[];
- }
- /**
- * Creates a deep copy of the specified node and places it into the target container before the
-given anchor.
- */
- export type copyToParameters = {
+ baseURL?: string;
/**
- * Id of the node to copy.
+ * `DocumentType`'s publicId.
*/
- nodeId: NodeId;
+ publicId?: string;
/**
- * Id of the element to drop the copy into.
+ * `DocumentType`'s systemId.
*/
- targetNodeId: NodeId;
+ systemId?: string;
/**
- * Drop the copy before this node (if absent, the copy becomes the last child of
-`targetNodeId`).
+ * `DocumentType`'s internalSubset.
*/
- insertBeforeNodeId?: NodeId;
- }
- export type copyToReturnValue = {
+ internalSubset?: string;
/**
- * Id of the node clone.
+ * `Document`'s XML version in case of XML documents.
*/
- nodeId: NodeId;
- }
- /**
- * Describes node given its id, does not require domain to be enabled. Does not start tracking any
-objects, can be used for automation.
- */
- export type describeNodeParameters = {
+ xmlVersion?: string;
/**
- * Identifier of the node.
+ * `Attr`'s name.
*/
- nodeId?: NodeId;
+ name?: string;
/**
- * Identifier of the backend node.
+ * `Attr`'s value.
*/
- backendNodeId?: BackendNodeId;
+ value?: string;
/**
- * JavaScript object id of the node wrapper.
+ * Pseudo element type for this node.
*/
- objectId?: Runtime.RemoteObjectId;
+ pseudoType?: PseudoType;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Pseudo element identifier for this node. Only present if there is a
+valid pseudoType.
*/
- depth?: number;
+ pseudoIdentifier?: string;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Shadow root type.
*/
- pierce?: boolean;
- }
- export type describeNodeReturnValue = {
+ shadowRootType?: ShadowRootType;
/**
- * Node description.
+ * Frame ID for frame owner elements.
*/
- node: Node;
- }
- /**
- * Scrolls the specified rect of the given node into view if not already visible.
-Note: exactly one between nodeId, backendNodeId and objectId should be passed
-to identify the node.
- */
- export type scrollIntoViewIfNeededParameters = {
+ frameId?: Page.FrameId;
/**
- * Identifier of the node.
+ * Content document for frame owner elements.
*/
- nodeId?: NodeId;
+ contentDocument?: Node;
/**
- * Identifier of the backend node.
+ * Shadow root list for given element host.
*/
- backendNodeId?: BackendNodeId;
+ shadowRoots?: Node[];
/**
- * JavaScript object id of the node wrapper.
+ * Content document fragment for template elements.
*/
- objectId?: Runtime.RemoteObjectId;
+ templateContent?: Node;
/**
- * The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
-When omitted, center of the node will be used, similar to Element.scrollIntoView.
+ * Pseudo elements associated with this node.
*/
- rect?: Rect;
- }
- export type scrollIntoViewIfNeededReturnValue = {
- }
- /**
- * Disables DOM agent for the given page.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Discards search results from the session with the given id. `getSearchResults` should no longer
-be called for that search.
- */
- export type discardSearchResultsParameters = {
+ pseudoElements?: Node[];
/**
- * Unique search session identifier.
+ * Deprecated, as the HTML Imports API has been removed (crbug.com/937746).
+This property used to return the imported document for the HTMLImport links.
+The property is always undefined now.
*/
- searchId: string;
- }
- export type discardSearchResultsReturnValue = {
- }
- /**
- * Enables DOM agent for the given page.
- */
- export type enableParameters = {
+ importedDocument?: Node;
/**
- * Whether to include whitespaces in the children array of returned Nodes.
+ * Distributed nodes for given insertion point.
*/
- includeWhitespace?: "none"|"all";
+ distributedNodes?: BackendNode[];
+ /**
+ * Whether the node is SVG.
+ */
+ isSVG?: boolean;
+ compatibilityMode?: CompatibilityMode;
+ assignedSlot?: BackendNode;
+ isScrollable?: boolean;
}
- export type enableReturnValue = {
+ /**
+ * A structure to hold the top-level node of a detached tree and an array of its retained descendants.
+ */
+ export interface DetachedElementInfo {
+ treeNode: Node;
+ retainedNodeIds: NodeId[];
}
/**
- * Focuses the given element.
+ * A structure holding an RGBA color.
*/
- export type focusParameters = {
+ export interface RGBA {
/**
- * Identifier of the node.
+ * The red component, in the [0-255] range.
*/
- nodeId?: NodeId;
+ r: number;
/**
- * Identifier of the backend node.
+ * The green component, in the [0-255] range.
*/
- backendNodeId?: BackendNodeId;
+ g: number;
/**
- * JavaScript object id of the node wrapper.
+ * The blue component, in the [0-255] range.
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type focusReturnValue = {
+ b: number;
+ /**
+ * The alpha component, in the [0-1] range (default: 1).
+ */
+ a?: number;
}
/**
- * Returns attributes for the specified node.
+ * An array of quad vertices, x immediately followed by y for each point, points clock-wise.
*/
- export type getAttributesParameters = {
+ export type Quad = number[];
+ /**
+ * Box model.
+ */
+ export interface BoxModel {
/**
- * Id of the node to retrieve attributes for.
+ * Content box
*/
- nodeId: NodeId;
- }
- export type getAttributesReturnValue = {
+ content: Quad;
/**
- * An interleaved array of node attribute names and values.
+ * Padding box
*/
- attributes: string[];
- }
- /**
- * Returns boxes for the given node.
- */
- export type getBoxModelParameters = {
+ padding: Quad;
/**
- * Identifier of the node.
+ * Border box
*/
- nodeId?: NodeId;
+ border: Quad;
/**
- * Identifier of the backend node.
+ * Margin box
*/
- backendNodeId?: BackendNodeId;
+ margin: Quad;
/**
- * JavaScript object id of the node wrapper.
+ * Node width
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type getBoxModelReturnValue = {
+ width: number;
/**
- * Box model for the node.
+ * Node height
*/
- model: BoxModel;
+ height: number;
+ /**
+ * Shape outside coordinates
+ */
+ shapeOutside?: ShapeOutsideInfo;
}
/**
- * Returns quads that describe node position on the page. This method
-might return multiple quads for inline nodes.
+ * CSS Shape Outside details.
*/
- export type getContentQuadsParameters = {
- /**
- * Identifier of the node.
- */
- nodeId?: NodeId;
+ export interface ShapeOutsideInfo {
/**
- * Identifier of the backend node.
+ * Shape bounds
*/
- backendNodeId?: BackendNodeId;
+ bounds: Quad;
/**
- * JavaScript object id of the node wrapper.
+ * Shape coordinate details
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type getContentQuadsReturnValue = {
+ shape: any[];
/**
- * Quads that describe node layout relative to viewport.
+ * Margin shape bounds
*/
- quads: Quad[];
+ marginShape: any[];
}
/**
- * Returns the root DOM node (and optionally the subtree) to the caller.
-Implicitly enables the DOM domain events for the current target.
+ * Rectangle.
*/
- export type getDocumentParameters = {
+ export interface Rect {
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * X coordinate
*/
- depth?: number;
+ x: number;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Y coordinate
*/
- pierce?: boolean;
- }
- export type getDocumentReturnValue = {
+ y: number;
/**
- * Resulting node.
+ * Rectangle width
*/
- root: Node;
- }
- /**
- * Returns the root DOM node (and optionally the subtree) to the caller.
-Deprecated, as it is not designed to work well with the rest of the DOM agent.
-Use DOMSnapshot.captureSnapshot instead.
- */
- export type getFlattenedDocumentParameters = {
+ width: number;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Rectangle height
*/
- depth?: number;
+ height: number;
+ }
+ export interface CSSComputedStyleProperty {
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false).
+ * Computed style property name.
*/
- pierce?: boolean;
- }
- export type getFlattenedDocumentReturnValue = {
+ name: string;
/**
- * Resulting node.
+ * Computed style property value.
*/
- nodes: Node[];
+ value: string;
}
+
/**
- * Finds nodes with a given computed style in a subtree.
+ * Fired when `Element`'s attribute is modified.
*/
- export type getNodesForSubtreeByStyleParameters = {
+ export type attributeModifiedPayload = {
/**
- * Node ID pointing to the root of a subtree.
+ * Id of the node that has changed.
*/
nodeId: NodeId;
/**
- * The style to filter nodes by (includes nodes if any of properties matches).
- */
- computedStyles: CSSComputedStyleProperty[];
- /**
- * Whether or not iframes and shadow roots in the same target should be traversed when returning the
-results (default is false).
+ * Attribute name.
*/
- pierce?: boolean;
- }
- export type getNodesForSubtreeByStyleReturnValue = {
+ name: string;
/**
- * Resulting nodes.
+ * Attribute value.
*/
- nodeIds: NodeId[];
+ value: string;
}
/**
- * Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
-either returned or not.
+ * Fired when `Element`'s attribute is removed.
*/
- export type getNodeForLocationParameters = {
- /**
- * X coordinate.
- */
- x: number;
- /**
- * Y coordinate.
- */
- y: number;
+ export type attributeRemovedPayload = {
/**
- * False to skip to the nearest non-UA shadow root ancestor (default: false).
+ * Id of the node that has changed.
*/
- includeUserAgentShadowDOM?: boolean;
+ nodeId: NodeId;
/**
- * Whether to ignore pointer-events: none on elements and hit test them.
+ * A ttribute name.
*/
- ignorePointerEventsNone?: boolean;
+ name: string;
}
- export type getNodeForLocationReturnValue = {
- /**
- * Resulting node.
- */
- backendNodeId: BackendNodeId;
+ /**
+ * Mirrors `DOMCharacterDataModified` event.
+ */
+ export type characterDataModifiedPayload = {
/**
- * Frame this node belongs to.
+ * Id of the node that has changed.
*/
- frameId: Page.FrameId;
+ nodeId: NodeId;
/**
- * Id of the node at given coordinates, only when enabled and requested document.
+ * New text value.
*/
- nodeId?: NodeId;
+ characterData: string;
}
/**
- * Returns node's HTML markup.
+ * Fired when `Container`'s child node count has changed.
*/
- export type getOuterHTMLParameters = {
+ export type childNodeCountUpdatedPayload = {
/**
- * Identifier of the node.
+ * Id of the node that has changed.
*/
- nodeId?: NodeId;
+ nodeId: NodeId;
/**
- * Identifier of the backend node.
+ * New node count.
*/
- backendNodeId?: BackendNodeId;
+ childNodeCount: number;
+ }
+ /**
+ * Mirrors `DOMNodeInserted` event.
+ */
+ export type childNodeInsertedPayload = {
/**
- * JavaScript object id of the node wrapper.
+ * Id of the node that has changed.
*/
- objectId?: Runtime.RemoteObjectId;
+ parentNodeId: NodeId;
/**
- * Include all shadow roots. Equals to false if not specified.
+ * Id of the previous sibling.
*/
- includeShadowDOM?: boolean;
- }
- export type getOuterHTMLReturnValue = {
+ previousNodeId: NodeId;
/**
- * Outer HTML markup.
+ * Inserted node data.
*/
- outerHTML: string;
+ node: Node;
}
/**
- * Returns the id of the nearest ancestor that is a relayout boundary.
+ * Mirrors `DOMNodeRemoved` event.
*/
- export type getRelayoutBoundaryParameters = {
+ export type childNodeRemovedPayload = {
/**
- * Id of the node.
+ * Parent id.
*/
- nodeId: NodeId;
- }
- export type getRelayoutBoundaryReturnValue = {
+ parentNodeId: NodeId;
/**
- * Relayout boundary node id for the given node.
+ * Id of the node that has been removed.
*/
nodeId: NodeId;
}
/**
- * Returns search results from given `fromIndex` to given `toIndex` from the search with the given
-identifier.
+ * Called when distribution is changed.
*/
- export type getSearchResultsParameters = {
- /**
- * Unique search session identifier.
- */
- searchId: string;
+ export type distributedNodesUpdatedPayload = {
/**
- * Start index of the search result to be returned.
+ * Insertion point where distributed nodes were updated.
*/
- fromIndex: number;
+ insertionPointId: NodeId;
/**
- * End index of the search result to be returned.
+ * Distributed nodes for given insertion point.
*/
- toIndex: number;
+ distributedNodes: BackendNode[];
}
- export type getSearchResultsReturnValue = {
+ /**
+ * Fired when `Document` has been totally updated. Node ids are no longer valid.
+ */
+ export type documentUpdatedPayload = void;
+ /**
+ * Fired when `Element`'s inline style is modified via a CSS property modification.
+ */
+ export type inlineStyleInvalidatedPayload = {
/**
- * Ids of the search result nodes.
+ * Ids of the nodes for which the inline styles have been invalidated.
*/
nodeIds: NodeId[];
}
/**
- * Hides any highlight.
+ * Called when a pseudo element is added to an element.
*/
- export type hideHighlightParameters = {
- }
- export type hideHighlightReturnValue = {
- }
- /**
- * Highlights DOM node.
- */
- export type highlightNodeParameters = {
- }
- export type highlightNodeReturnValue = {
- }
- /**
- * Highlights given rectangle.
- */
- export type highlightRectParameters = {
- }
- export type highlightRectReturnValue = {
+ export type pseudoElementAddedPayload = {
+ /**
+ * Pseudo element's parent element id.
+ */
+ parentId: NodeId;
+ /**
+ * The added pseudo element.
+ */
+ pseudoElement: Node;
}
/**
- * Marks last undoable state.
+ * Called when top layer elements are changed.
*/
- export type markUndoableStateParameters = {
- }
- export type markUndoableStateReturnValue = {
- }
+ export type topLayerElementsUpdatedPayload = void;
/**
- * Moves node into the new container, places it before the given anchor.
+ * Fired when a node's scrollability state changes.
*/
- export type moveToParameters = {
+ export type scrollableFlagUpdatedPayload = {
/**
- * Id of the node to move.
+ * The id of the node.
*/
- nodeId: NodeId;
+ nodeId: DOM.NodeId;
/**
- * Id of the element to drop the moved node into.
+ * If the node is scrollable.
*/
- targetNodeId: NodeId;
+ isScrollable: boolean;
+ }
+ /**
+ * Called when a pseudo element is removed from an element.
+ */
+ export type pseudoElementRemovedPayload = {
/**
- * Drop node before this one (if absent, the moved node becomes the last child of
-`targetNodeId`).
+ * Pseudo element's parent element id.
*/
- insertBeforeNodeId?: NodeId;
- }
- export type moveToReturnValue = {
+ parentId: NodeId;
/**
- * New id of the moved node.
+ * The removed pseudo element id.
*/
- nodeId: NodeId;
+ pseudoElementId: NodeId;
}
/**
- * Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
-`cancelSearch` to end this search session.
+ * Fired when backend wants to provide client with the missing DOM structure. This happens upon
+most of the calls requesting node ids.
*/
- export type performSearchParameters = {
+ export type setChildNodesPayload = {
/**
- * Plain text or query selector or XPath search query.
+ * Parent node id to populate with children.
*/
- query: string;
+ parentId: NodeId;
/**
- * True to search in user agent shadow DOM.
+ * Child nodes array.
*/
- includeUserAgentShadowDOM?: boolean;
+ nodes: Node[];
}
- export type performSearchReturnValue = {
+ /**
+ * Called when shadow root is popped from the element.
+ */
+ export type shadowRootPoppedPayload = {
/**
- * Unique search session identifier.
+ * Host element id.
*/
- searchId: string;
+ hostId: NodeId;
/**
- * Number of search results.
+ * Shadow root id.
*/
- resultCount: number;
+ rootId: NodeId;
}
/**
- * Requests that the node is sent to the caller given its path. // FIXME, use XPath
+ * Called when shadow root is pushed into the element.
*/
- export type pushNodeByPathToFrontendParameters = {
+ export type shadowRootPushedPayload = {
/**
- * Path to node in the proprietary format.
+ * Host element id.
*/
- path: string;
- }
- export type pushNodeByPathToFrontendReturnValue = {
+ hostId: NodeId;
/**
- * Id of the node for given path.
+ * Shadow root.
*/
- nodeId: NodeId;
+ root: Node;
}
+
/**
- * Requests that a batch of nodes is sent to the caller given their backend node ids.
+ * Collects class names for the node with given id and all of it's child nodes.
*/
- export type pushNodesByBackendIdsToFrontendParameters = {
+ export type collectClassNamesFromSubtreeParameters = {
/**
- * The array of backend node ids.
+ * Id of the node to collect class names.
*/
- backendNodeIds: BackendNodeId[];
+ nodeId: NodeId;
}
- export type pushNodesByBackendIdsToFrontendReturnValue = {
+ export type collectClassNamesFromSubtreeReturnValue = {
/**
- * The array of ids of pushed nodes that correspond to the backend ids specified in
-backendNodeIds.
+ * Class name list.
*/
- nodeIds: NodeId[];
+ classNames: string[];
}
/**
- * Executes `querySelector` on a given node.
+ * Creates a deep copy of the specified node and places it into the target container before the
+given anchor.
*/
- export type querySelectorParameters = {
+ export type copyToParameters = {
/**
- * Id of the node to query upon.
+ * Id of the node to copy.
*/
nodeId: NodeId;
/**
- * Selector string.
+ * Id of the element to drop the copy into.
*/
- selector: string;
+ targetNodeId: NodeId;
+ /**
+ * Drop the copy before this node (if absent, the copy becomes the last child of
+`targetNodeId`).
+ */
+ insertBeforeNodeId?: NodeId;
}
- export type querySelectorReturnValue = {
+ export type copyToReturnValue = {
/**
- * Query selector result.
+ * Id of the node clone.
*/
nodeId: NodeId;
}
/**
- * Executes `querySelectorAll` on a given node.
+ * Describes node given its id, does not require domain to be enabled. Does not start tracking any
+objects, can be used for automation.
*/
- export type querySelectorAllParameters = {
+ export type describeNodeParameters = {
/**
- * Id of the node to query upon.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Selector string.
+ * Identifier of the backend node.
*/
- selector: string;
- }
- export type querySelectorAllReturnValue = {
+ backendNodeId?: BackendNodeId;
/**
- * Query selector result.
+ * JavaScript object id of the node wrapper.
*/
- nodeIds: NodeId[];
- }
- /**
- * Returns NodeIds of current top layer elements.
-Top layer is rendered closest to the user within a viewport, therefore its elements always
-appear on top of all other content.
- */
- export type getTopLayerElementsParameters = {
+ objectId?: Runtime.RemoteObjectId;
+ /**
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
+ */
+ depth?: number;
+ /**
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
+ */
+ pierce?: boolean;
}
- export type getTopLayerElementsReturnValue = {
+ export type describeNodeReturnValue = {
/**
- * NodeIds of top layer elements
+ * Node description.
*/
- nodeIds: NodeId[];
+ node: Node;
}
/**
- * Returns the NodeId of the matched element according to certain relations.
+ * Scrolls the specified rect of the given node into view if not already visible.
+Note: exactly one between nodeId, backendNodeId and objectId should be passed
+to identify the node.
*/
- export type getElementByRelationParameters = {
+ export type scrollIntoViewIfNeededParameters = {
/**
- * Id of the node from which to query the relation.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Type of relation to get.
+ * Identifier of the backend node.
*/
- relation: "PopoverTarget"|"InterestTarget"|"CommandFor";
- }
- export type getElementByRelationReturnValue = {
+ backendNodeId?: BackendNodeId;
/**
- * NodeId of the element matching the queried relation.
+ * JavaScript object id of the node wrapper.
*/
- nodeId: NodeId;
+ objectId?: Runtime.RemoteObjectId;
+ /**
+ * The rect to be scrolled into view, relative to the node's border box, in CSS pixels.
+When omitted, center of the node will be used, similar to Element.scrollIntoView.
+ */
+ rect?: Rect;
+ }
+ export type scrollIntoViewIfNeededReturnValue = {
}
/**
- * Re-does the last undone action.
+ * Disables DOM agent for the given page.
*/
- export type redoParameters = {
+ export type disableParameters = {
}
- export type redoReturnValue = {
+ export type disableReturnValue = {
}
/**
- * Removes attribute with given name from an element with given id.
+ * Discards search results from the session with the given id. `getSearchResults` should no longer
+be called for that search.
*/
- export type removeAttributeParameters = {
- /**
- * Id of the element to remove attribute from.
- */
- nodeId: NodeId;
+ export type discardSearchResultsParameters = {
/**
- * Name of the attribute to remove.
+ * Unique search session identifier.
*/
- name: string;
+ searchId: string;
}
- export type removeAttributeReturnValue = {
+ export type discardSearchResultsReturnValue = {
}
/**
- * Removes node with given id.
+ * Enables DOM agent for the given page.
*/
- export type removeNodeParameters = {
+ export type enableParameters = {
/**
- * Id of the node to remove.
+ * Whether to include whitespaces in the children array of returned Nodes.
*/
- nodeId: NodeId;
+ includeWhitespace?: "none"|"all";
}
- export type removeNodeReturnValue = {
+ export type enableReturnValue = {
}
/**
- * Requests that children of the node with given id are returned to the caller in form of
-`setChildNodes` events where not only immediate children are retrieved, but all children down to
-the specified depth.
+ * Focuses the given element.
*/
- export type requestChildNodesParameters = {
+ export type focusParameters = {
/**
- * Id of the node to get children for.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Identifier of the backend node.
*/
- depth?: number;
+ backendNodeId?: BackendNodeId;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the sub-tree
-(default is false).
+ * JavaScript object id of the node wrapper.
*/
- pierce?: boolean;
+ objectId?: Runtime.RemoteObjectId;
}
- export type requestChildNodesReturnValue = {
+ export type focusReturnValue = {
}
/**
- * Requests that the node is sent to the caller given the JavaScript node object reference. All
-nodes that form the path from the node to the root are also sent to the client as a series of
-`setChildNodes` notifications.
+ * Returns attributes for the specified node.
*/
- export type requestNodeParameters = {
+ export type getAttributesParameters = {
/**
- * JavaScript object id to convert into node.
+ * Id of the node to retrieve attributes for.
*/
- objectId: Runtime.RemoteObjectId;
+ nodeId: NodeId;
}
- export type requestNodeReturnValue = {
+ export type getAttributesReturnValue = {
/**
- * Node id for given object.
+ * An interleaved array of node attribute names and values.
*/
- nodeId: NodeId;
+ attributes: string[];
}
/**
- * Resolves the JavaScript node object for a given NodeId or BackendNodeId.
+ * Returns boxes for the given node.
*/
- export type resolveNodeParameters = {
+ export type getBoxModelParameters = {
/**
- * Id of the node to resolve.
+ * Identifier of the node.
*/
nodeId?: NodeId;
/**
- * Backend identifier of the node to resolve.
- */
- backendNodeId?: DOM.BackendNodeId;
- /**
- * Symbolic group name that can be used to release multiple objects.
+ * Identifier of the backend node.
*/
- objectGroup?: string;
+ backendNodeId?: BackendNodeId;
/**
- * Execution context in which to resolve the node.
+ * JavaScript object id of the node wrapper.
*/
- executionContextId?: Runtime.ExecutionContextId;
+ objectId?: Runtime.RemoteObjectId;
}
- export type resolveNodeReturnValue = {
+ export type getBoxModelReturnValue = {
/**
- * JavaScript object wrapper for given node.
+ * Box model for the node.
*/
- object: Runtime.RemoteObject;
+ model: BoxModel;
}
/**
- * Sets attribute for an element with given id.
+ * Returns quads that describe node position on the page. This method
+might return multiple quads for inline nodes.
*/
- export type setAttributeValueParameters = {
+ export type getContentQuadsParameters = {
/**
- * Id of the element to set attribute for.
+ * Identifier of the node.
*/
- nodeId: NodeId;
+ nodeId?: NodeId;
/**
- * Attribute name.
+ * Identifier of the backend node.
*/
- name: string;
+ backendNodeId?: BackendNodeId;
/**
- * Attribute value.
+ * JavaScript object id of the node wrapper.
*/
- value: string;
+ objectId?: Runtime.RemoteObjectId;
}
- export type setAttributeValueReturnValue = {
+ export type getContentQuadsReturnValue = {
+ /**
+ * Quads that describe node layout relative to viewport.
+ */
+ quads: Quad[];
}
/**
- * Sets attributes on element with given id. This method is useful when user edits some existing
-attribute value and types in several attribute name/value pairs.
+ * Returns the root DOM node (and optionally the subtree) to the caller.
+Implicitly enables the DOM domain events for the current target.
*/
- export type setAttributesAsTextParameters = {
+ export type getDocumentParameters = {
/**
- * Id of the element to set attributes for.
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- nodeId: NodeId;
+ depth?: number;
/**
- * Text with a number of attributes. Will parse this text using HTML parser.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
*/
- text: string;
+ pierce?: boolean;
+ }
+ export type getDocumentReturnValue = {
/**
- * Attribute name to replace with new attributes derived from text in case text parsed
-successfully.
+ * Resulting node.
*/
- name?: string;
- }
- export type setAttributesAsTextReturnValue = {
+ root: Node;
}
/**
- * Sets files for the given file input element.
+ * Returns the root DOM node (and optionally the subtree) to the caller.
+Deprecated, as it is not designed to work well with the rest of the DOM agent.
+Use DOMSnapshot.captureSnapshot instead.
*/
- export type setFileInputFilesParameters = {
- /**
- * Array of file paths to set.
- */
- files: string[];
+ export type getFlattenedDocumentParameters = {
/**
- * Identifier of the node.
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- nodeId?: NodeId;
+ depth?: number;
/**
- * Identifier of the backend node.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false).
*/
- backendNodeId?: BackendNodeId;
+ pierce?: boolean;
+ }
+ export type getFlattenedDocumentReturnValue = {
/**
- * JavaScript object id of the node wrapper.
+ * Resulting node.
*/
- objectId?: Runtime.RemoteObjectId;
- }
- export type setFileInputFilesReturnValue = {
+ nodes: Node[];
}
/**
- * Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
+ * Finds nodes with a given computed style in a subtree.
*/
- export type setNodeStackTracesEnabledParameters = {
+ export type getNodesForSubtreeByStyleParameters = {
/**
- * Enable or disable.
+ * Node ID pointing to the root of a subtree.
*/
- enable: boolean;
+ nodeId: NodeId;
+ /**
+ * The style to filter nodes by (includes nodes if any of properties matches).
+ */
+ computedStyles: CSSComputedStyleProperty[];
+ /**
+ * Whether or not iframes and shadow roots in the same target should be traversed when returning the
+results (default is false).
+ */
+ pierce?: boolean;
}
- export type setNodeStackTracesEnabledReturnValue = {
+ export type getNodesForSubtreeByStyleReturnValue = {
+ /**
+ * Resulting nodes.
+ */
+ nodeIds: NodeId[];
}
/**
- * Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
+ * Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
+either returned or not.
*/
- export type getNodeStackTracesParameters = {
+ export type getNodeForLocationParameters = {
/**
- * Id of the node to get stack traces for.
+ * X coordinate.
*/
- nodeId: NodeId;
+ x: number;
+ /**
+ * Y coordinate.
+ */
+ y: number;
+ /**
+ * False to skip to the nearest non-UA shadow root ancestor (default: false).
+ */
+ includeUserAgentShadowDOM?: boolean;
+ /**
+ * Whether to ignore pointer-events: none on elements and hit test them.
+ */
+ ignorePointerEventsNone?: boolean;
}
- export type getNodeStackTracesReturnValue = {
+ export type getNodeForLocationReturnValue = {
/**
- * Creation stack trace, if available.
+ * Resulting node.
*/
- creation?: Runtime.StackTrace;
+ backendNodeId: BackendNodeId;
+ /**
+ * Frame this node belongs to.
+ */
+ frameId: Page.FrameId;
+ /**
+ * Id of the node at given coordinates, only when enabled and requested document.
+ */
+ nodeId?: NodeId;
}
/**
- * Returns file information for the given
-File wrapper.
+ * Returns node's HTML markup.
*/
- export type getFileInfoParameters = {
+ export type getOuterHTMLParameters = {
+ /**
+ * Identifier of the node.
+ */
+ nodeId?: NodeId;
+ /**
+ * Identifier of the backend node.
+ */
+ backendNodeId?: BackendNodeId;
/**
* JavaScript object id of the node wrapper.
*/
- objectId: Runtime.RemoteObjectId;
- }
- export type getFileInfoReturnValue = {
- path: string;
- }
- /**
- * Returns list of detached nodes
- */
- export type getDetachedDomNodesParameters = {
- }
- export type getDetachedDomNodesReturnValue = {
+ objectId?: Runtime.RemoteObjectId;
/**
- * The list of detached nodes
+ * Include all shadow roots. Equals to false if not specified.
*/
- detachedNodes: DetachedElementInfo[];
+ includeShadowDOM?: boolean;
}
- /**
- * Enables console to refer to the node with given id via $x (see Command Line API for more details
-$x functions).
- */
- export type setInspectedNodeParameters = {
+ export type getOuterHTMLReturnValue = {
/**
- * DOM node id to be accessible by means of $x command line API.
+ * Outer HTML markup.
*/
- nodeId: NodeId;
- }
- export type setInspectedNodeReturnValue = {
+ outerHTML: string;
}
/**
- * Sets node name for a node with given id.
+ * Returns the id of the nearest ancestor that is a relayout boundary.
*/
- export type setNodeNameParameters = {
+ export type getRelayoutBoundaryParameters = {
/**
- * Id of the node to set name for.
+ * Id of the node.
*/
nodeId: NodeId;
- /**
- * New node's name.
- */
- name: string;
}
- export type setNodeNameReturnValue = {
+ export type getRelayoutBoundaryReturnValue = {
/**
- * New node's id.
+ * Relayout boundary node id for the given node.
*/
nodeId: NodeId;
}
/**
- * Sets node value for a node with given id.
+ * Returns search results from given `fromIndex` to given `toIndex` from the search with the given
+identifier.
*/
- export type setNodeValueParameters = {
+ export type getSearchResultsParameters = {
/**
- * Id of the node to set value for.
+ * Unique search session identifier.
*/
- nodeId: NodeId;
+ searchId: string;
/**
- * New node's value.
+ * Start index of the search result to be returned.
*/
- value: string;
+ fromIndex: number;
+ /**
+ * End index of the search result to be returned.
+ */
+ toIndex: number;
}
- export type setNodeValueReturnValue = {
+ export type getSearchResultsReturnValue = {
+ /**
+ * Ids of the search result nodes.
+ */
+ nodeIds: NodeId[];
}
/**
- * Sets node HTML markup, returns new node id.
+ * Hides any highlight.
*/
- export type setOuterHTMLParameters = {
- /**
- * Id of the node to set markup for.
- */
- nodeId: NodeId;
- /**
- * Outer HTML markup to set.
- */
- outerHTML: string;
+ export type hideHighlightParameters = {
}
- export type setOuterHTMLReturnValue = {
+ export type hideHighlightReturnValue = {
}
/**
- * Undoes the last performed action.
+ * Highlights DOM node.
*/
- export type undoParameters = {
+ export type highlightNodeParameters = {
}
- export type undoReturnValue = {
+ export type highlightNodeReturnValue = {
}
/**
- * Returns iframe node that owns iframe with the given domain.
+ * Highlights given rectangle.
*/
- export type getFrameOwnerParameters = {
- frameId: Page.FrameId;
+ export type highlightRectParameters = {
}
- export type getFrameOwnerReturnValue = {
- /**
- * Resulting node.
- */
- backendNodeId: BackendNodeId;
- /**
- * Id of the node at given coordinates, only when enabled and requested document.
- */
- nodeId?: NodeId;
+ export type highlightRectReturnValue = {
}
/**
- * Returns the query container of the given node based on container query
-conditions: containerName, physical and logical axes, and whether it queries
-scroll-state or anchored elements. If no axes are provided and
-queriesScrollState is false, the style container is returned, which is the
-direct parent or the closest element with a matching container-name.
+ * Marks last undoable state.
*/
- export type getContainerForNodeParameters = {
- nodeId: NodeId;
- containerName?: string;
- physicalAxes?: PhysicalAxes;
- logicalAxes?: LogicalAxes;
- queriesScrollState?: boolean;
- queriesAnchored?: boolean;
+ export type markUndoableStateParameters = {
}
- export type getContainerForNodeReturnValue = {
- /**
- * The container node for the given node, or null if not found.
- */
- nodeId?: NodeId;
+ export type markUndoableStateReturnValue = {
}
/**
- * Returns the descendants of a container query container that have
-container queries against this container.
+ * Moves node into the new container, places it before the given anchor.
*/
- export type getQueryingDescendantsForContainerParameters = {
+ export type moveToParameters = {
/**
- * Id of the container node to find querying descendants from.
+ * Id of the node to move.
*/
nodeId: NodeId;
- }
- export type getQueryingDescendantsForContainerReturnValue = {
- /**
- * Descendant nodes with container queries against the given container.
- */
- nodeIds: NodeId[];
- }
- /**
- * Returns the target anchor element of the given anchor query according to
-https://www.w3.org/TR/css-anchor-position-1/#target.
- */
- export type getAnchorElementParameters = {
/**
- * Id of the positioned element from which to find the anchor.
+ * Id of the element to drop the moved node into.
*/
- nodeId: NodeId;
+ targetNodeId: NodeId;
/**
- * An optional anchor specifier, as defined in
-https://www.w3.org/TR/css-anchor-position-1/#anchor-specifier.
-If not provided, it will return the implicit anchor element for
-the given positioned element.
+ * Drop node before this one (if absent, the moved node becomes the last child of
+`targetNodeId`).
*/
- anchorSpecifier?: string;
+ insertBeforeNodeId?: NodeId;
}
- export type getAnchorElementReturnValue = {
+ export type moveToReturnValue = {
/**
- * The anchor element of the given anchor query.
+ * New id of the moved node.
*/
nodeId: NodeId;
}
/**
- * When enabling, this API force-opens the popover identified by nodeId
-and keeps it open until disabled.
+ * Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
+`cancelSearch` to end this search session.
*/
- export type forceShowPopoverParameters = {
+ export type performSearchParameters = {
/**
- * Id of the popover HTMLElement
+ * Plain text or query selector or XPath search query.
*/
- nodeId: NodeId;
+ query: string;
/**
- * If true, opens the popover and keeps it open. If false, closes the
-popover if it was previously force-opened.
+ * True to search in user agent shadow DOM.
*/
- enable: boolean;
+ includeUserAgentShadowDOM?: boolean;
}
- export type forceShowPopoverReturnValue = {
+ export type performSearchReturnValue = {
/**
- * List of popovers that were closed in order to respect popover stacking order.
+ * Unique search session identifier.
*/
- nodeIds: NodeId[];
+ searchId: string;
+ /**
+ * Number of search results.
+ */
+ resultCount: number;
}
- }
-
- /**
- * DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
-execution will stop on these operations as if there was a regular breakpoint set.
- */
- export module DOMDebugger {
- /**
- * DOM breakpoint type.
- */
- export type DOMBreakpointType = "subtree-modified"|"attribute-modified"|"node-removed";
- /**
- * CSP Violation type.
- */
- export type CSPViolationType = "trustedtype-sink-violation"|"trustedtype-policy-violation";
/**
- * Object event listener.
+ * Requests that the node is sent to the caller given its path. // FIXME, use XPath
*/
- export interface EventListener {
+ export type pushNodeByPathToFrontendParameters = {
/**
- * `EventListener`'s type.
+ * Path to node in the proprietary format.
*/
- type: string;
+ path: string;
+ }
+ export type pushNodeByPathToFrontendReturnValue = {
/**
- * `EventListener`'s useCapture.
+ * Id of the node for given path.
*/
- useCapture: boolean;
+ nodeId: NodeId;
+ }
+ /**
+ * Requests that a batch of nodes is sent to the caller given their backend node ids.
+ */
+ export type pushNodesByBackendIdsToFrontendParameters = {
/**
- * `EventListener`'s passive flag.
+ * The array of backend node ids.
*/
- passive: boolean;
+ backendNodeIds: BackendNodeId[];
+ }
+ export type pushNodesByBackendIdsToFrontendReturnValue = {
/**
- * `EventListener`'s once flag.
+ * The array of ids of pushed nodes that correspond to the backend ids specified in
+backendNodeIds.
*/
- once: boolean;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Executes `querySelector` on a given node.
+ */
+ export type querySelectorParameters = {
/**
- * Script id of the handler code.
+ * Id of the node to query upon.
*/
- scriptId: Runtime.ScriptId;
+ nodeId: NodeId;
/**
- * Line number in the script (0-based).
+ * Selector string.
*/
- lineNumber: number;
+ selector: string;
+ }
+ export type querySelectorReturnValue = {
/**
- * Column number in the script (0-based).
+ * Query selector result.
*/
- columnNumber: number;
+ nodeId: NodeId;
+ }
+ /**
+ * Executes `querySelectorAll` on a given node.
+ */
+ export type querySelectorAllParameters = {
/**
- * Event handler function value.
+ * Id of the node to query upon.
*/
- handler?: Runtime.RemoteObject;
+ nodeId: NodeId;
/**
- * Event original handler function value.
+ * Selector string.
*/
- originalHandler?: Runtime.RemoteObject;
+ selector: string;
+ }
+ export type querySelectorAllReturnValue = {
/**
- * Node the listener is added to (if any).
+ * Query selector result.
*/
- backendNodeId?: DOM.BackendNodeId;
+ nodeIds: NodeId[];
}
-
-
/**
- * Returns event listeners of the given object.
+ * Returns NodeIds of current top layer elements.
+Top layer is rendered closest to the user within a viewport, therefore its elements always
+appear on top of all other content.
*/
- export type getEventListenersParameters = {
+ export type getTopLayerElementsParameters = {
+ }
+ export type getTopLayerElementsReturnValue = {
/**
- * Identifier of the object to return listeners for.
+ * NodeIds of top layer elements
*/
- objectId: Runtime.RemoteObjectId;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Returns the NodeId of the matched element according to certain relations.
+ */
+ export type getElementByRelationParameters = {
/**
- * The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
-entire subtree or provide an integer larger than 0.
+ * Id of the node from which to query the relation.
*/
- depth?: number;
+ nodeId: NodeId;
/**
- * Whether or not iframes and shadow roots should be traversed when returning the subtree
-(default is false). Reports listeners for all contexts if pierce is enabled.
+ * Type of relation to get.
*/
- pierce?: boolean;
+ relation: "PopoverTarget"|"InterestTarget"|"CommandFor";
}
- export type getEventListenersReturnValue = {
+ export type getElementByRelationReturnValue = {
/**
- * Array of relevant listeners.
+ * NodeId of the element matching the queried relation.
*/
- listeners: EventListener[];
+ nodeId: NodeId;
}
/**
- * Removes DOM breakpoint that was set using `setDOMBreakpoint`.
+ * Re-does the last undone action.
*/
- export type removeDOMBreakpointParameters = {
+ export type redoParameters = {
+ }
+ export type redoReturnValue = {
+ }
+ /**
+ * Removes attribute with given name from an element with given id.
+ */
+ export type removeAttributeParameters = {
/**
- * Identifier of the node to remove breakpoint from.
+ * Id of the element to remove attribute from.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * Type of the breakpoint to remove.
+ * Name of the attribute to remove.
*/
- type: DOMBreakpointType;
+ name: string;
}
- export type removeDOMBreakpointReturnValue = {
+ export type removeAttributeReturnValue = {
}
/**
- * Removes breakpoint on particular DOM event.
+ * Removes node with given id.
*/
- export type removeEventListenerBreakpointParameters = {
+ export type removeNodeParameters = {
/**
- * Event name.
- */
- eventName: string;
- /**
- * EventTarget interface name.
+ * Id of the node to remove.
*/
- targetName?: string;
+ nodeId: NodeId;
}
- export type removeEventListenerBreakpointReturnValue = {
+ export type removeNodeReturnValue = {
}
/**
- * Removes breakpoint on particular native event.
+ * Requests that children of the node with given id are returned to the caller in form of
+`setChildNodes` events where not only immediate children are retrieved, but all children down to
+the specified depth.
*/
- export type removeInstrumentationBreakpointParameters = {
+ export type requestChildNodesParameters = {
/**
- * Instrumentation name to stop on.
+ * Id of the node to get children for.
*/
- eventName: string;
+ nodeId: NodeId;
+ /**
+ * The maximum depth at which children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
+ */
+ depth?: number;
+ /**
+ * Whether or not iframes and shadow roots should be traversed when returning the sub-tree
+(default is false).
+ */
+ pierce?: boolean;
}
- export type removeInstrumentationBreakpointReturnValue = {
+ export type requestChildNodesReturnValue = {
}
/**
- * Removes breakpoint from XMLHttpRequest.
+ * Requests that the node is sent to the caller given the JavaScript node object reference. All
+nodes that form the path from the node to the root are also sent to the client as a series of
+`setChildNodes` notifications.
*/
- export type removeXHRBreakpointParameters = {
+ export type requestNodeParameters = {
/**
- * Resource URL substring.
+ * JavaScript object id to convert into node.
*/
- url: string;
+ objectId: Runtime.RemoteObjectId;
}
- export type removeXHRBreakpointReturnValue = {
+ export type requestNodeReturnValue = {
+ /**
+ * Node id for given object.
+ */
+ nodeId: NodeId;
}
/**
- * Sets breakpoint on particular CSP violations.
+ * Resolves the JavaScript node object for a given NodeId or BackendNodeId.
*/
- export type setBreakOnCSPViolationParameters = {
+ export type resolveNodeParameters = {
/**
- * CSP Violations to stop upon.
+ * Id of the node to resolve.
*/
- violationTypes: CSPViolationType[];
+ nodeId?: NodeId;
+ /**
+ * Backend identifier of the node to resolve.
+ */
+ backendNodeId?: DOM.BackendNodeId;
+ /**
+ * Symbolic group name that can be used to release multiple objects.
+ */
+ objectGroup?: string;
+ /**
+ * Execution context in which to resolve the node.
+ */
+ executionContextId?: Runtime.ExecutionContextId;
}
- export type setBreakOnCSPViolationReturnValue = {
+ export type resolveNodeReturnValue = {
+ /**
+ * JavaScript object wrapper for given node.
+ */
+ object: Runtime.RemoteObject;
}
/**
- * Sets breakpoint on particular operation with DOM.
+ * Sets attribute for an element with given id.
*/
- export type setDOMBreakpointParameters = {
+ export type setAttributeValueParameters = {
/**
- * Identifier of the node to set breakpoint on.
+ * Id of the element to set attribute for.
*/
- nodeId: DOM.NodeId;
+ nodeId: NodeId;
/**
- * Type of the operation to stop upon.
+ * Attribute name.
*/
- type: DOMBreakpointType;
+ name: string;
+ /**
+ * Attribute value.
+ */
+ value: string;
}
- export type setDOMBreakpointReturnValue = {
+ export type setAttributeValueReturnValue = {
}
/**
- * Sets breakpoint on particular DOM event.
+ * Sets attributes on element with given id. This method is useful when user edits some existing
+attribute value and types in several attribute name/value pairs.
*/
- export type setEventListenerBreakpointParameters = {
+ export type setAttributesAsTextParameters = {
/**
- * DOM Event name to stop on (any DOM event will do).
+ * Id of the element to set attributes for.
*/
- eventName: string;
+ nodeId: NodeId;
/**
- * EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
-EventTarget.
+ * Text with a number of attributes. Will parse this text using HTML parser.
*/
- targetName?: string;
+ text: string;
+ /**
+ * Attribute name to replace with new attributes derived from text in case text parsed
+successfully.
+ */
+ name?: string;
}
- export type setEventListenerBreakpointReturnValue = {
+ export type setAttributesAsTextReturnValue = {
}
/**
- * Sets breakpoint on particular native event.
+ * Sets files for the given file input element.
*/
- export type setInstrumentationBreakpointParameters = {
+ export type setFileInputFilesParameters = {
/**
- * Instrumentation name to stop on.
+ * Array of file paths to set.
*/
- eventName: string;
+ files: string[];
+ /**
+ * Identifier of the node.
+ */
+ nodeId?: NodeId;
+ /**
+ * Identifier of the backend node.
+ */
+ backendNodeId?: BackendNodeId;
+ /**
+ * JavaScript object id of the node wrapper.
+ */
+ objectId?: Runtime.RemoteObjectId;
}
- export type setInstrumentationBreakpointReturnValue = {
+ export type setFileInputFilesReturnValue = {
}
/**
- * Sets breakpoint on XMLHttpRequest.
+ * Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled.
*/
- export type setXHRBreakpointParameters = {
+ export type setNodeStackTracesEnabledParameters = {
/**
- * Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
+ * Enable or disable.
*/
- url: string;
+ enable: boolean;
}
- export type setXHRBreakpointReturnValue = {
+ export type setNodeStackTracesEnabledReturnValue = {
}
- }
-
- /**
- * EventBreakpoints permits setting JavaScript breakpoints on operations and events
-occurring in native code invoked from JavaScript. Once breakpoint is hit, it is
-reported through Debugger domain, similarly to regular breakpoints being hit.
- */
- export module EventBreakpoints {
-
-
/**
- * Sets breakpoint on particular native event.
+ * Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation.
*/
- export type setInstrumentationBreakpointParameters = {
+ export type getNodeStackTracesParameters = {
/**
- * Instrumentation name to stop on.
+ * Id of the node to get stack traces for.
*/
- eventName: string;
+ nodeId: NodeId;
}
- export type setInstrumentationBreakpointReturnValue = {
+ export type getNodeStackTracesReturnValue = {
+ /**
+ * Creation stack trace, if available.
+ */
+ creation?: Runtime.StackTrace;
}
/**
- * Removes breakpoint on particular native event.
+ * Returns file information for the given
+File wrapper.
*/
- export type removeInstrumentationBreakpointParameters = {
+ export type getFileInfoParameters = {
/**
- * Instrumentation name to stop on.
+ * JavaScript object id of the node wrapper.
*/
- eventName: string;
+ objectId: Runtime.RemoteObjectId;
}
- export type removeInstrumentationBreakpointReturnValue = {
+ export type getFileInfoReturnValue = {
+ path: string;
}
/**
- * Removes all breakpoints
+ * Returns list of detached nodes
*/
- export type disableParameters = {
+ export type getDetachedDomNodesParameters = {
}
- export type disableReturnValue = {
+ export type getDetachedDomNodesReturnValue = {
+ /**
+ * The list of detached nodes
+ */
+ detachedNodes: DetachedElementInfo[];
}
- }
-
- /**
- * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
- */
- export module DOMSnapshot {
/**
- * A Node in the DOM tree.
+ * Enables console to refer to the node with given id via $x (see Command Line API for more details
+$x functions).
*/
- export interface DOMNode {
+ export type setInspectedNodeParameters = {
/**
- * `Node`'s nodeType.
+ * DOM node id to be accessible by means of $x command line API.
*/
- nodeType: number;
+ nodeId: NodeId;
+ }
+ export type setInspectedNodeReturnValue = {
+ }
+ /**
+ * Sets node name for a node with given id.
+ */
+ export type setNodeNameParameters = {
/**
- * `Node`'s nodeName.
+ * Id of the node to set name for.
*/
- nodeName: string;
+ nodeId: NodeId;
/**
- * `Node`'s nodeValue.
+ * New node's name.
*/
- nodeValue: string;
+ name: string;
+ }
+ export type setNodeNameReturnValue = {
/**
- * Only set for textarea elements, contains the text value.
+ * New node's id.
*/
- textValue?: string;
+ nodeId: NodeId;
+ }
+ /**
+ * Sets node value for a node with given id.
+ */
+ export type setNodeValueParameters = {
/**
- * Only set for input elements, contains the input's associated text value.
+ * Id of the node to set value for.
*/
- inputValue?: string;
+ nodeId: NodeId;
/**
- * Only set for radio and checkbox input elements, indicates if the element has been checked
+ * New node's value.
*/
- inputChecked?: boolean;
+ value: string;
+ }
+ export type setNodeValueReturnValue = {
+ }
+ /**
+ * Sets node HTML markup, returns new node id.
+ */
+ export type setOuterHTMLParameters = {
/**
- * Only set for option elements, indicates if the element has been selected
+ * Id of the node to set markup for.
*/
- optionSelected?: boolean;
+ nodeId: NodeId;
/**
- * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ * Outer HTML markup to set.
*/
- backendNodeId: DOM.BackendNodeId;
- /**
- * The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
-any.
- */
- childNodeIndexes?: number[];
+ outerHTML: string;
+ }
+ export type setOuterHTMLReturnValue = {
+ }
+ /**
+ * Undoes the last performed action.
+ */
+ export type undoParameters = {
+ }
+ export type undoReturnValue = {
+ }
+ /**
+ * Returns iframe node that owns iframe with the given domain.
+ */
+ export type getFrameOwnerParameters = {
+ frameId: Page.FrameId;
+ }
+ export type getFrameOwnerReturnValue = {
/**
- * Attributes of an `Element` node.
+ * Resulting node.
*/
- attributes?: NameValue[];
+ backendNodeId: BackendNodeId;
/**
- * Indexes of pseudo elements associated with this node in the `domNodes` array returned by
-`getSnapshot`, if any.
+ * Id of the node at given coordinates, only when enabled and requested document.
*/
- pseudoElementIndexes?: number[];
+ nodeId?: NodeId;
+ }
+ /**
+ * Returns the query container of the given node based on container query
+conditions: containerName, physical and logical axes, and whether it queries
+scroll-state or anchored elements. If no axes are provided and
+queriesScrollState is false, the style container is returned, which is the
+direct parent or the closest element with a matching container-name.
+ */
+ export type getContainerForNodeParameters = {
+ nodeId: NodeId;
+ containerName?: string;
+ physicalAxes?: PhysicalAxes;
+ logicalAxes?: LogicalAxes;
+ queriesScrollState?: boolean;
+ queriesAnchored?: boolean;
+ }
+ export type getContainerForNodeReturnValue = {
/**
- * The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
-`getSnapshot`, if any.
+ * The container node for the given node, or null if not found.
*/
- layoutNodeIndex?: number;
+ nodeId?: NodeId;
+ }
+ /**
+ * Returns the descendants of a container query container that have
+container queries against this container.
+ */
+ export type getQueryingDescendantsForContainerParameters = {
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * Id of the container node to find querying descendants from.
*/
- documentURL?: string;
+ nodeId: NodeId;
+ }
+ export type getQueryingDescendantsForContainerReturnValue = {
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Descendant nodes with container queries against the given container.
*/
- baseURL?: string;
+ nodeIds: NodeId[];
+ }
+ /**
+ * Returns the target anchor element of the given anchor query according to
+https://www.w3.org/TR/css-anchor-position-1/#target.
+ */
+ export type getAnchorElementParameters = {
/**
- * Only set for documents, contains the document's content language.
+ * Id of the positioned element from which to find the anchor.
*/
- contentLanguage?: string;
+ nodeId: NodeId;
/**
- * Only set for documents, contains the document's character set encoding.
+ * An optional anchor specifier, as defined in
+https://www.w3.org/TR/css-anchor-position-1/#anchor-specifier.
+If not provided, it will return the implicit anchor element for
+the given positioned element.
*/
- documentEncoding?: string;
+ anchorSpecifier?: string;
+ }
+ export type getAnchorElementReturnValue = {
/**
- * `DocumentType` node's publicId.
+ * The anchor element of the given anchor query.
*/
- publicId?: string;
+ nodeId: NodeId;
+ }
+ /**
+ * When enabling, this API force-opens the popover identified by nodeId
+and keeps it open until disabled.
+ */
+ export type forceShowPopoverParameters = {
/**
- * `DocumentType` node's systemId.
+ * Id of the popover HTMLElement
*/
- systemId?: string;
+ nodeId: NodeId;
/**
- * Frame ID for frame owner elements and also for the document node.
+ * If true, opens the popover and keeps it open. If false, closes the
+popover if it was previously force-opened.
*/
- frameId?: Page.FrameId;
+ enable: boolean;
+ }
+ export type forceShowPopoverReturnValue = {
/**
- * The index of a frame owner element's content document in the `domNodes` array returned by
-`getSnapshot`, if any.
+ * List of popovers that were closed in order to respect popover stacking order.
*/
- contentDocumentIndex?: number;
+ nodeIds: NodeId[];
+ }
+ }
+
+ /**
+ * DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript
+execution will stop on these operations as if there was a regular breakpoint set.
+ */
+ export module DOMDebugger {
+ /**
+ * DOM breakpoint type.
+ */
+ export type DOMBreakpointType = "subtree-modified"|"attribute-modified"|"node-removed";
+ /**
+ * CSP Violation type.
+ */
+ export type CSPViolationType = "trustedtype-sink-violation"|"trustedtype-policy-violation";
+ /**
+ * Object event listener.
+ */
+ export interface EventListener {
/**
- * Type of a pseudo element node.
+ * `EventListener`'s type.
*/
- pseudoType?: DOM.PseudoType;
+ type: string;
/**
- * Shadow root type.
+ * `EventListener`'s useCapture.
*/
- shadowRootType?: DOM.ShadowRootType;
+ useCapture: boolean;
/**
- * Whether this DOM node responds to mouse clicks. This includes nodes that have had click
-event listeners attached via JavaScript as well as anchor tags that naturally navigate when
-clicked.
+ * `EventListener`'s passive flag.
*/
- isClickable?: boolean;
+ passive: boolean;
/**
- * Details of the node's event listeners, if any.
+ * `EventListener`'s once flag.
*/
- eventListeners?: DOMDebugger.EventListener[];
+ once: boolean;
/**
- * The selected url for nodes with a srcset attribute.
+ * Script id of the handler code.
*/
- currentSourceURL?: string;
+ scriptId: Runtime.ScriptId;
/**
- * The url of the script (if any) that generates this node.
+ * Line number in the script (0-based).
*/
- originURL?: string;
+ lineNumber: number;
/**
- * Scroll offsets, set when this node is a Document.
+ * Column number in the script (0-based).
*/
- scrollOffsetX?: number;
- scrollOffsetY?: number;
- }
- /**
- * Details of post layout rendered text positions. The exact layout should not be regarded as
-stable and may change between versions.
- */
- export interface InlineTextBox {
+ columnNumber: number;
/**
- * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
+ * Event handler function value.
*/
- boundingBox: DOM.Rect;
+ handler?: Runtime.RemoteObject;
/**
- * The starting index in characters, for this post layout textbox substring. Characters that
-would be represented as a surrogate pair in UTF-16 have length 2.
+ * Event original handler function value.
*/
- startCharacterIndex: number;
+ originalHandler?: Runtime.RemoteObject;
/**
- * The number of characters in this post layout textbox substring. Characters that would be
-represented as a surrogate pair in UTF-16 have length 2.
+ * Node the listener is added to (if any).
*/
- numCharacters: number;
+ backendNodeId?: DOM.BackendNodeId;
}
+
+
/**
- * Details of an element in the DOM tree with a LayoutObject.
+ * Returns event listeners of the given object.
*/
- export interface LayoutTreeNode {
- /**
- * The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
- */
- domNodeIndex: number;
- /**
- * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
- */
- boundingBox: DOM.Rect;
- /**
- * Contents of the LayoutText, if any.
- */
- layoutText?: string;
+ export type getEventListenersParameters = {
/**
- * The post-layout inline text nodes, if any.
+ * Identifier of the object to return listeners for.
*/
- inlineTextNodes?: InlineTextBox[];
+ objectId: Runtime.RemoteObjectId;
/**
- * Index into the `computedStyles` array returned by `getSnapshot`.
+ * The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the
+entire subtree or provide an integer larger than 0.
*/
- styleIndex?: number;
+ depth?: number;
/**
- * Global paint order index, which is determined by the stacking order of the nodes. Nodes
-that are painted together will have the same index. Only provided if includePaintOrder in
-getSnapshot was true.
+ * Whether or not iframes and shadow roots should be traversed when returning the subtree
+(default is false). Reports listeners for all contexts if pierce is enabled.
*/
- paintOrder?: number;
+ pierce?: boolean;
+ }
+ export type getEventListenersReturnValue = {
/**
- * Set to true to indicate the element begins a new stacking context.
+ * Array of relevant listeners.
*/
- isStackingContext?: boolean;
+ listeners: EventListener[];
}
/**
- * A subset of the full ComputedStyle as defined by the request whitelist.
+ * Removes DOM breakpoint that was set using `setDOMBreakpoint`.
*/
- export interface ComputedStyle {
+ export type removeDOMBreakpointParameters = {
/**
- * Name/value pairs of computed style properties.
+ * Identifier of the node to remove breakpoint from.
*/
- properties: NameValue[];
+ nodeId: DOM.NodeId;
+ /**
+ * Type of the breakpoint to remove.
+ */
+ type: DOMBreakpointType;
+ }
+ export type removeDOMBreakpointReturnValue = {
}
/**
- * A name/value pair.
+ * Removes breakpoint on particular DOM event.
*/
- export interface NameValue {
+ export type removeEventListenerBreakpointParameters = {
/**
- * Attribute/property name.
+ * Event name.
*/
- name: string;
+ eventName: string;
/**
- * Attribute/property value.
+ * EventTarget interface name.
*/
- value: string;
+ targetName?: string;
+ }
+ export type removeEventListenerBreakpointReturnValue = {
}
/**
- * Index of the string in the strings table.
+ * Removes breakpoint on particular native event.
*/
- export type StringIndex = number;
- /**
- * Index of the string in the strings table.
- */
- export type ArrayOfStrings = StringIndex[];
+ export type removeInstrumentationBreakpointParameters = {
+ /**
+ * Instrumentation name to stop on.
+ */
+ eventName: string;
+ }
+ export type removeInstrumentationBreakpointReturnValue = {
+ }
/**
- * Data that is only present on rare nodes.
+ * Removes breakpoint from XMLHttpRequest.
*/
- export interface RareStringData {
- index: number[];
- value: StringIndex[];
- }
- export interface RareBooleanData {
- index: number[];
+ export type removeXHRBreakpointParameters = {
+ /**
+ * Resource URL substring.
+ */
+ url: string;
}
- export interface RareIntegerData {
- index: number[];
- value: number[];
+ export type removeXHRBreakpointReturnValue = {
}
- export type Rectangle = number[];
/**
- * Document snapshot.
+ * Sets breakpoint on particular CSP violations.
*/
- export interface DocumentSnapshot {
+ export type setBreakOnCSPViolationParameters = {
/**
- * Document URL that `Document` or `FrameOwner` node points to.
+ * CSP Violations to stop upon.
*/
- documentURL: StringIndex;
+ violationTypes: CSPViolationType[];
+ }
+ export type setBreakOnCSPViolationReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular operation with DOM.
+ */
+ export type setDOMBreakpointParameters = {
/**
- * Document title.
+ * Identifier of the node to set breakpoint on.
*/
- title: StringIndex;
+ nodeId: DOM.NodeId;
/**
- * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ * Type of the operation to stop upon.
*/
- baseURL: StringIndex;
+ type: DOMBreakpointType;
+ }
+ export type setDOMBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular DOM event.
+ */
+ export type setEventListenerBreakpointParameters = {
/**
- * Contains the document's content language.
+ * DOM Event name to stop on (any DOM event will do).
*/
- contentLanguage: StringIndex;
+ eventName: string;
/**
- * Contains the document's character set encoding.
+ * EventTarget interface name to stop on. If equal to `"*"` or not provided, will stop on any
+EventTarget.
*/
- encodingName: StringIndex;
+ targetName?: string;
+ }
+ export type setEventListenerBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on particular native event.
+ */
+ export type setInstrumentationBreakpointParameters = {
/**
- * `DocumentType` node's publicId.
+ * Instrumentation name to stop on.
*/
- publicId: StringIndex;
+ eventName: string;
+ }
+ export type setInstrumentationBreakpointReturnValue = {
+ }
+ /**
+ * Sets breakpoint on XMLHttpRequest.
+ */
+ export type setXHRBreakpointParameters = {
/**
- * `DocumentType` node's systemId.
+ * Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
*/
- systemId: StringIndex;
+ url: string;
+ }
+ export type setXHRBreakpointReturnValue = {
+ }
+ }
+
+ /**
+ * This domain facilitates obtaining document snapshots with DOM, layout, and style information.
+ */
+ export module DOMSnapshot {
+ /**
+ * A Node in the DOM tree.
+ */
+ export interface DOMNode {
/**
- * Frame ID for frame owner elements and also for the document node.
+ * `Node`'s nodeType.
*/
- frameId: StringIndex;
+ nodeType: number;
/**
- * A table with dom nodes.
+ * `Node`'s nodeName.
*/
- nodes: NodeTreeSnapshot;
+ nodeName: string;
/**
- * The nodes in the layout tree.
+ * `Node`'s nodeValue.
*/
- layout: LayoutTreeSnapshot;
+ nodeValue: string;
/**
- * The post-layout inline text nodes.
+ * Only set for textarea elements, contains the text value.
*/
- textBoxes: TextBoxSnapshot;
+ textValue?: string;
/**
- * Horizontal scroll offset.
+ * Only set for input elements, contains the input's associated text value.
*/
- scrollOffsetX?: number;
+ inputValue?: string;
/**
- * Vertical scroll offset.
+ * Only set for radio and checkbox input elements, indicates if the element has been checked
*/
- scrollOffsetY?: number;
+ inputChecked?: boolean;
/**
- * Document content width.
+ * Only set for option elements, indicates if the element has been selected
*/
- contentWidth?: number;
+ optionSelected?: boolean;
/**
- * Document content height.
+ * `Node`'s id, corresponds to DOM.Node.backendNodeId.
*/
- contentHeight?: number;
- }
- /**
- * Table containing nodes.
- */
- export interface NodeTreeSnapshot {
+ backendNodeId: DOM.BackendNodeId;
/**
- * Parent node index.
+ * The indexes of the node's child nodes in the `domNodes` array returned by `getSnapshot`, if
+any.
*/
- parentIndex?: number[];
+ childNodeIndexes?: number[];
/**
- * `Node`'s nodeType.
+ * Attributes of an `Element` node.
*/
- nodeType?: number[];
+ attributes?: NameValue[];
/**
- * Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
+ * Indexes of pseudo elements associated with this node in the `domNodes` array returned by
+`getSnapshot`, if any.
*/
- shadowRootType?: RareStringData;
+ pseudoElementIndexes?: number[];
/**
- * `Node`'s nodeName.
+ * The index of the node's related layout tree node in the `layoutTreeNodes` array returned by
+`getSnapshot`, if any.
*/
- nodeName?: StringIndex[];
+ layoutNodeIndex?: number;
/**
- * `Node`'s nodeValue.
+ * Document URL that `Document` or `FrameOwner` node points to.
*/
- nodeValue?: StringIndex[];
+ documentURL?: string;
/**
- * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
*/
- backendNodeId?: DOM.BackendNodeId[];
+ baseURL?: string;
/**
- * Attributes of an `Element` node. Flatten name, value pairs.
+ * Only set for documents, contains the document's content language.
*/
- attributes?: ArrayOfStrings[];
+ contentLanguage?: string;
/**
- * Only set for textarea elements, contains the text value.
+ * Only set for documents, contains the document's character set encoding.
*/
- textValue?: RareStringData;
+ documentEncoding?: string;
/**
- * Only set for input elements, contains the input's associated text value.
+ * `DocumentType` node's publicId.
*/
- inputValue?: RareStringData;
+ publicId?: string;
/**
- * Only set for radio and checkbox input elements, indicates if the element has been checked
+ * `DocumentType` node's systemId.
*/
- inputChecked?: RareBooleanData;
+ systemId?: string;
/**
- * Only set for option elements, indicates if the element has been selected
+ * Frame ID for frame owner elements and also for the document node.
*/
- optionSelected?: RareBooleanData;
+ frameId?: Page.FrameId;
/**
- * The index of the document in the list of the snapshot documents.
+ * The index of a frame owner element's content document in the `domNodes` array returned by
+`getSnapshot`, if any.
*/
- contentDocumentIndex?: RareIntegerData;
+ contentDocumentIndex?: number;
/**
* Type of a pseudo element node.
*/
- pseudoType?: RareStringData;
+ pseudoType?: DOM.PseudoType;
/**
- * Pseudo element identifier for this node. Only present if there is a
-valid pseudoType.
+ * Shadow root type.
*/
- pseudoIdentifier?: RareStringData;
+ shadowRootType?: DOM.ShadowRootType;
/**
* Whether this DOM node responds to mouse clicks. This includes nodes that have had click
event listeners attached via JavaScript as well as anchor tags that naturally navigate when
clicked.
*/
- isClickable?: RareBooleanData;
+ isClickable?: boolean;
+ /**
+ * Details of the node's event listeners, if any.
+ */
+ eventListeners?: DOMDebugger.EventListener[];
/**
* The selected url for nodes with a srcset attribute.
*/
- currentSourceURL?: RareStringData;
+ currentSourceURL?: string;
/**
* The url of the script (if any) that generates this node.
*/
- originURL?: RareStringData;
+ originURL?: string;
+ /**
+ * Scroll offsets, set when this node is a Document.
+ */
+ scrollOffsetX?: number;
+ scrollOffsetY?: number;
}
/**
- * Table of details of an element in the DOM tree with a LayoutObject.
+ * Details of post layout rendered text positions. The exact layout should not be regarded as
+stable and may change between versions.
*/
- export interface LayoutTreeSnapshot {
+ export interface InlineTextBox {
/**
- * Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
+ * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
*/
- nodeIndex: number[];
+ boundingBox: DOM.Rect;
/**
- * Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
+ * The starting index in characters, for this post layout textbox substring. Characters that
+would be represented as a surrogate pair in UTF-16 have length 2.
*/
- styles: ArrayOfStrings[];
+ startCharacterIndex: number;
/**
- * The absolute position bounding box.
+ * The number of characters in this post layout textbox substring. Characters that would be
+represented as a surrogate pair in UTF-16 have length 2.
*/
- bounds: Rectangle[];
+ numCharacters: number;
+ }
+ /**
+ * Details of an element in the DOM tree with a LayoutObject.
+ */
+ export interface LayoutTreeNode {
/**
- * Contents of the LayoutText, if any.
+ * The index of the related DOM node in the `domNodes` array returned by `getSnapshot`.
*/
- text: StringIndex[];
+ domNodeIndex: number;
/**
- * Stacking context information.
+ * The bounding box in document coordinates. Note that scroll offset of the document is ignored.
*/
- stackingContexts: RareBooleanData;
+ boundingBox: DOM.Rect;
/**
- * Global paint order index, which is determined by the stacking order of the nodes. Nodes
-that are painted together will have the same index. Only provided if includePaintOrder in
-captureSnapshot was true.
+ * Contents of the LayoutText, if any.
*/
- paintOrders?: number[];
+ layoutText?: string;
/**
- * The offset rect of nodes. Only available when includeDOMRects is set to true
+ * The post-layout inline text nodes, if any.
*/
- offsetRects?: Rectangle[];
+ inlineTextNodes?: InlineTextBox[];
+ /**
+ * Index into the `computedStyles` array returned by `getSnapshot`.
+ */
+ styleIndex?: number;
+ /**
+ * Global paint order index, which is determined by the stacking order of the nodes. Nodes
+that are painted together will have the same index. Only provided if includePaintOrder in
+getSnapshot was true.
+ */
+ paintOrder?: number;
+ /**
+ * Set to true to indicate the element begins a new stacking context.
+ */
+ isStackingContext?: boolean;
+ }
+ /**
+ * A subset of the full ComputedStyle as defined by the request whitelist.
+ */
+ export interface ComputedStyle {
+ /**
+ * Name/value pairs of computed style properties.
+ */
+ properties: NameValue[];
+ }
+ /**
+ * A name/value pair.
+ */
+ export interface NameValue {
+ /**
+ * Attribute/property name.
+ */
+ name: string;
+ /**
+ * Attribute/property value.
+ */
+ value: string;
+ }
+ /**
+ * Index of the string in the strings table.
+ */
+ export type StringIndex = number;
+ /**
+ * Index of the string in the strings table.
+ */
+ export type ArrayOfStrings = StringIndex[];
+ /**
+ * Data that is only present on rare nodes.
+ */
+ export interface RareStringData {
+ index: number[];
+ value: StringIndex[];
+ }
+ export interface RareBooleanData {
+ index: number[];
+ }
+ export interface RareIntegerData {
+ index: number[];
+ value: number[];
+ }
+ export type Rectangle = number[];
+ /**
+ * Document snapshot.
+ */
+ export interface DocumentSnapshot {
+ /**
+ * Document URL that `Document` or `FrameOwner` node points to.
+ */
+ documentURL: StringIndex;
+ /**
+ * Document title.
+ */
+ title: StringIndex;
+ /**
+ * Base URL that `Document` or `FrameOwner` node uses for URL completion.
+ */
+ baseURL: StringIndex;
+ /**
+ * Contains the document's content language.
+ */
+ contentLanguage: StringIndex;
+ /**
+ * Contains the document's character set encoding.
+ */
+ encodingName: StringIndex;
+ /**
+ * `DocumentType` node's publicId.
+ */
+ publicId: StringIndex;
+ /**
+ * `DocumentType` node's systemId.
+ */
+ systemId: StringIndex;
+ /**
+ * Frame ID for frame owner elements and also for the document node.
+ */
+ frameId: StringIndex;
+ /**
+ * A table with dom nodes.
+ */
+ nodes: NodeTreeSnapshot;
+ /**
+ * The nodes in the layout tree.
+ */
+ layout: LayoutTreeSnapshot;
+ /**
+ * The post-layout inline text nodes.
+ */
+ textBoxes: TextBoxSnapshot;
+ /**
+ * Horizontal scroll offset.
+ */
+ scrollOffsetX?: number;
+ /**
+ * Vertical scroll offset.
+ */
+ scrollOffsetY?: number;
+ /**
+ * Document content width.
+ */
+ contentWidth?: number;
+ /**
+ * Document content height.
+ */
+ contentHeight?: number;
+ }
+ /**
+ * Table containing nodes.
+ */
+ export interface NodeTreeSnapshot {
+ /**
+ * Parent node index.
+ */
+ parentIndex?: number[];
+ /**
+ * `Node`'s nodeType.
+ */
+ nodeType?: number[];
+ /**
+ * Type of the shadow root the `Node` is in. String values are equal to the `ShadowRootType` enum.
+ */
+ shadowRootType?: RareStringData;
+ /**
+ * `Node`'s nodeName.
+ */
+ nodeName?: StringIndex[];
+ /**
+ * `Node`'s nodeValue.
+ */
+ nodeValue?: StringIndex[];
+ /**
+ * `Node`'s id, corresponds to DOM.Node.backendNodeId.
+ */
+ backendNodeId?: DOM.BackendNodeId[];
+ /**
+ * Attributes of an `Element` node. Flatten name, value pairs.
+ */
+ attributes?: ArrayOfStrings[];
+ /**
+ * Only set for textarea elements, contains the text value.
+ */
+ textValue?: RareStringData;
+ /**
+ * Only set for input elements, contains the input's associated text value.
+ */
+ inputValue?: RareStringData;
+ /**
+ * Only set for radio and checkbox input elements, indicates if the element has been checked
+ */
+ inputChecked?: RareBooleanData;
+ /**
+ * Only set for option elements, indicates if the element has been selected
+ */
+ optionSelected?: RareBooleanData;
+ /**
+ * The index of the document in the list of the snapshot documents.
+ */
+ contentDocumentIndex?: RareIntegerData;
+ /**
+ * Type of a pseudo element node.
+ */
+ pseudoType?: RareStringData;
+ /**
+ * Pseudo element identifier for this node. Only present if there is a
+valid pseudoType.
+ */
+ pseudoIdentifier?: RareStringData;
+ /**
+ * Whether this DOM node responds to mouse clicks. This includes nodes that have had click
+event listeners attached via JavaScript as well as anchor tags that naturally navigate when
+clicked.
+ */
+ isClickable?: RareBooleanData;
+ /**
+ * The selected url for nodes with a srcset attribute.
+ */
+ currentSourceURL?: RareStringData;
+ /**
+ * The url of the script (if any) that generates this node.
+ */
+ originURL?: RareStringData;
+ }
+ /**
+ * Table of details of an element in the DOM tree with a LayoutObject.
+ */
+ export interface LayoutTreeSnapshot {
+ /**
+ * Index of the corresponding node in the `NodeTreeSnapshot` array returned by `captureSnapshot`.
+ */
+ nodeIndex: number[];
+ /**
+ * Array of indexes specifying computed style strings, filtered according to the `computedStyles` parameter passed to `captureSnapshot`.
+ */
+ styles: ArrayOfStrings[];
+ /**
+ * The absolute position bounding box.
+ */
+ bounds: Rectangle[];
+ /**
+ * Contents of the LayoutText, if any.
+ */
+ text: StringIndex[];
+ /**
+ * Stacking context information.
+ */
+ stackingContexts: RareBooleanData;
+ /**
+ * Global paint order index, which is determined by the stacking order of the nodes. Nodes
+that are painted together will have the same index. Only provided if includePaintOrder in
+captureSnapshot was true.
+ */
+ paintOrders?: number[];
+ /**
+ * The offset rect of nodes. Only available when includeDOMRects is set to true
+ */
+ offsetRects?: Rectangle[];
/**
* The scroll rect of nodes. Only available when includeDOMRects is set to true
*/
@@ -6203,22 +6353,84 @@ The final text color opacity is computed based on the opacity of all overlapping
}
}
- export module DeviceOrientation {
-
-
+ export module DeviceAccess {
/**
- * Clears the overridden Device Orientation.
+ * Device request id.
*/
- export type clearDeviceOrientationOverrideParameters = {
- }
- export type clearDeviceOrientationOverrideReturnValue = {
- }
+ export type RequestId = string;
/**
- * Overrides the Device Orientation.
+ * A device id.
*/
- export type setDeviceOrientationOverrideParameters = {
+ export type DeviceId = string;
+ /**
+ * Device information displayed in a user prompt to select a device.
+ */
+ export interface PromptDevice {
+ id: DeviceId;
/**
- * Mock alpha
+ * Display name as it appears in a device request user prompt.
+ */
+ name: string;
+ }
+
+ /**
+ * A device request opened a user prompt to select a device. Respond with the
+selectPrompt or cancelPrompt command.
+ */
+ export type deviceRequestPromptedPayload = {
+ id: RequestId;
+ devices: PromptDevice[];
+ }
+
+ /**
+ * Enable events in this domain.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disable events in this domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Select a device in response to a DeviceAccess.deviceRequestPrompted event.
+ */
+ export type selectPromptParameters = {
+ id: RequestId;
+ deviceId: DeviceId;
+ }
+ export type selectPromptReturnValue = {
+ }
+ /**
+ * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
+ */
+ export type cancelPromptParameters = {
+ id: RequestId;
+ }
+ export type cancelPromptReturnValue = {
+ }
+ }
+
+ export module DeviceOrientation {
+
+
+ /**
+ * Clears the overridden Device Orientation.
+ */
+ export type clearDeviceOrientationOverrideParameters = {
+ }
+ export type clearDeviceOrientationOverrideReturnValue = {
+ }
+ /**
+ * Overrides the Device Orientation.
+ */
+ export type setDeviceOrientationOverrideParameters = {
+ /**
+ * Mock alpha
*/
alpha: number;
/**
@@ -6387,6 +6599,95 @@ See https://w3c.github.io/sensors/#automation for more information.
export interface PressureMetadata {
available?: boolean;
}
+ export interface WorkAreaInsets {
+ /**
+ * Work area top inset in pixels. Default is 0;
+ */
+ top?: number;
+ /**
+ * Work area left inset in pixels. Default is 0;
+ */
+ left?: number;
+ /**
+ * Work area bottom inset in pixels. Default is 0;
+ */
+ bottom?: number;
+ /**
+ * Work area right inset in pixels. Default is 0;
+ */
+ right?: number;
+ }
+ export type ScreenId = string;
+ /**
+ * Screen information similar to the one returned by window.getScreenDetails() method,
+see https://w3c.github.io/window-management/#screendetailed.
+ */
+ export interface ScreenInfo {
+ /**
+ * Offset of the left edge of the screen.
+ */
+ left: number;
+ /**
+ * Offset of the top edge of the screen.
+ */
+ top: number;
+ /**
+ * Width of the screen.
+ */
+ width: number;
+ /**
+ * Height of the screen.
+ */
+ height: number;
+ /**
+ * Offset of the left edge of the available screen area.
+ */
+ availLeft: number;
+ /**
+ * Offset of the top edge of the available screen area.
+ */
+ availTop: number;
+ /**
+ * Width of the available screen area.
+ */
+ availWidth: number;
+ /**
+ * Height of the available screen area.
+ */
+ availHeight: number;
+ /**
+ * Specifies the screen's device pixel ratio.
+ */
+ devicePixelRatio: number;
+ /**
+ * Specifies the screen's orientation.
+ */
+ orientation: ScreenOrientation;
+ /**
+ * Specifies the screen's color depth in bits.
+ */
+ colorDepth: number;
+ /**
+ * Indicates whether the device has multiple screens.
+ */
+ isExtended: boolean;
+ /**
+ * Indicates whether the screen is internal to the device or external, attached to the device.
+ */
+ isInternal: boolean;
+ /**
+ * Indicates whether the screen is set as the the operating system primary screen.
+ */
+ isPrimary: boolean;
+ /**
+ * Specifies the descriptive label for the screen.
+ */
+ label: string;
+ /**
+ * Specifies the unique identifier of the screen.
+ */
+ id: ScreenId;
+ }
/**
* Enum of image types that can be disabled.
*/
@@ -6974,3243 +7275,3768 @@ of size 100lvh.
}
export type setSmallViewportHeightDifferenceOverrideReturnValue = {
}
- }
-
- /**
- * This domain provides experimental commands only supported in headless mode.
- */
- export module HeadlessExperimental {
/**
- * Encoding options for a screenshot.
+ * Returns device's screen configuration.
*/
- export interface ScreenshotParams {
+ export type getScreenInfosParameters = {
+ }
+ export type getScreenInfosReturnValue = {
+ screenInfos: ScreenInfo[];
+ }
+ /**
+ * Add a new screen to the device. Only supported in headless mode.
+ */
+ export type addScreenParameters = {
/**
- * Image compression format (defaults to png).
+ * Offset of the left edge of the screen in pixels.
*/
- format?: "jpeg"|"png"|"webp";
+ left: number;
/**
- * Compression quality from range [0..100] (jpeg and webp only).
+ * Offset of the top edge of the screen in pixels.
*/
- quality?: number;
+ top: number;
/**
- * Optimize image encoding for speed, not for resulting size (defaults to false)
+ * The width of the screen in pixels.
*/
- optimizeForSpeed?: boolean;
- }
-
-
- /**
- * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
-screenshot from the resulting frame. Requires that the target was created with enabled
-BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
-https://goo.gle/chrome-headless-rendering for more background.
- */
- export type beginFrameParameters = {
+ width: number;
/**
- * Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
-the current time will be used.
+ * The height of the screen in pixels.
*/
- frameTimeTicks?: number;
+ height: number;
/**
- * The interval between BeginFrames that is reported to the compositor, in milliseconds.
-Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
+ * Specifies the screen's work area. Default is entire screen.
*/
- interval?: number;
+ workAreaInsets?: WorkAreaInsets;
/**
- * Whether updates should not be committed and drawn onto the display. False by default. If
-true, only side effects of the BeginFrame will be run, such as layout and animations, but
-any visual updates may not be visible on the display or in screenshots.
+ * Specifies the screen's device pixel ratio. Default is 1.
*/
- noDisplayUpdates?: boolean;
+ devicePixelRatio?: number;
/**
- * If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
-no screenshot will be captured. Note that capturing a screenshot can fail, for example,
-during renderer initialization. In such a case, no screenshot data will be returned.
+ * Specifies the screen's rotation angle. Available values are 0, 90, 180 and 270. Default is 0.
*/
- screenshot?: ScreenshotParams;
- }
- export type beginFrameReturnValue = {
+ rotation?: number;
/**
- * Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
-display. Reported for diagnostic uses, may be removed in the future.
+ * Specifies the screen's color depth in bits. Default is 24.
*/
- hasDamage: boolean;
+ colorDepth?: number;
/**
- * Base64-encoded image data of the screenshot, if one was requested and successfully taken.
+ * Specifies the descriptive label for the screen. Default is none.
*/
- screenshotData?: binary;
- }
- /**
- * Disables headless events for the target.
- */
- export type disableParameters = {
+ label?: string;
+ /**
+ * Indicates whether the screen is internal to the device or external, attached to the device. Default is false.
+ */
+ isInternal?: boolean;
}
- export type disableReturnValue = {
+ export type addScreenReturnValue = {
+ screenInfo: ScreenInfo;
}
/**
- * Enables headless events for the target.
+ * Remove screen from the device. Only supported in headless mode.
*/
- export type enableParameters = {
+ export type removeScreenParameters = {
+ screenId: ScreenId;
}
- export type enableReturnValue = {
+ export type removeScreenReturnValue = {
}
}
/**
- * Input/Output operations for streams produced by DevTools.
+ * EventBreakpoints permits setting JavaScript breakpoints on operations and events
+occurring in native code invoked from JavaScript. Once breakpoint is hit, it is
+reported through Debugger domain, similarly to regular breakpoints being hit.
*/
- export module IO {
- /**
- * This is either obtained from another method or specified as `blob:<uuid>` where
-`<uuid>` is an UUID of a Blob.
- */
- export type StreamHandle = string;
+ export module EventBreakpoints {
/**
- * Close the stream, discard any temporary backing storage.
+ * Sets breakpoint on particular native event.
*/
- export type closeParameters = {
+ export type setInstrumentationBreakpointParameters = {
/**
- * Handle of the stream to close.
+ * Instrumentation name to stop on.
*/
- handle: StreamHandle;
+ eventName: string;
}
- export type closeReturnValue = {
+ export type setInstrumentationBreakpointReturnValue = {
}
/**
- * Read a chunk of the stream
+ * Removes breakpoint on particular native event.
*/
- export type readParameters = {
- /**
- * Handle of the stream to read.
- */
- handle: StreamHandle;
- /**
- * Seek to the specified offset before reading (if not specified, proceed with offset
-following the last read). Some types of streams may only support sequential reads.
- */
- offset?: number;
+ export type removeInstrumentationBreakpointParameters = {
/**
- * Maximum number of bytes to read (left upon the agent discretion if not specified).
+ * Instrumentation name to stop on.
*/
- size?: number;
+ eventName: string;
}
- export type readReturnValue = {
- /**
- * Set if the data is base64-encoded
- */
- base64Encoded?: boolean;
- /**
- * Data that were read.
- */
- data: string;
- /**
- * Set if the end-of-file condition occurred while reading.
- */
- eof: boolean;
+ export type removeInstrumentationBreakpointReturnValue = {
}
/**
- * Return UUID of Blob object specified by a remote object id.
+ * Removes all breakpoints
*/
- export type resolveBlobParameters = {
- /**
- * Object id of a Blob object wrapper.
- */
- objectId: Runtime.RemoteObjectId;
+ export type disableParameters = {
}
- export type resolveBlobReturnValue = {
- /**
- * UUID of the specified Blob.
- */
- uuid: string;
+ export type disableReturnValue = {
}
}
- export module FileSystem {
- export interface File {
- name: string;
- /**
- * Timestamp
- */
- lastModified: Network.TimeSinceEpoch;
- /**
- * Size in bytes
- */
- size: number;
- type: string;
- }
- export interface Directory {
- name: string;
- nestedDirectories: string[];
- /**
- * Files that are directly nested under this directory.
- */
- nestedFiles: File[];
- }
- export interface BucketFileSystemLocator {
- /**
- * Storage key
- */
- storageKey: Storage.SerializedStorageKey;
- /**
- * Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
- */
- bucketName?: string;
- /**
- * Path to the directory using each path component as an array item.
- */
- pathComponents: string[];
- }
+ /**
+ * Defines commands and events for browser extensions.
+ */
+ export module Extensions {
+ /**
+ * Storage areas.
+ */
+ export type StorageArea = "session"|"local"|"sync"|"managed";
- export type getDirectoryParameters = {
- bucketFileSystemLocator: BucketFileSystemLocator;
- }
- export type getDirectoryReturnValue = {
- /**
- * Returns the directory object at the path.
- */
- directory: Directory;
- }
- }
-
- export module IndexedDB {
/**
- * Database with an array of object stores.
+ * Installs an unpacked extension from the filesystem similar to
+--load-extension CLI flags. Returns extension ID once the extension
+has been installed. Available if the client is connected using the
+--remote-debugging-pipe flag and the --enable-unsafe-extension-debugging
+flag is set.
*/
- export interface DatabaseWithObjectStores {
- /**
- * Database name.
- */
- name: string;
+ export type loadUnpackedParameters = {
/**
- * Database version (type is not 'integer', as the standard
-requires the version number to be 'unsigned long long')
+ * Absolute file path.
*/
- version: number;
+ path: string;
+ }
+ export type loadUnpackedReturnValue = {
/**
- * Object stores in this database.
+ * Extension id.
*/
- objectStores: ObjectStore[];
+ id: string;
}
/**
- * Object store.
+ * Uninstalls an unpacked extension (others not supported) from the profile.
+Available if the client is connected using the --remote-debugging-pipe flag
+and the --enable-unsafe-extension-debugging.
*/
- export interface ObjectStore {
- /**
- * Object store name.
- */
- name: string;
- /**
- * Object store key path.
- */
- keyPath: KeyPath;
- /**
- * If true, object store has auto increment flag set.
- */
- autoIncrement: boolean;
+ export type uninstallParameters = {
/**
- * Indexes in this object store.
+ * Extension id.
*/
- indexes: ObjectStoreIndex[];
+ id: string;
+ }
+ export type uninstallReturnValue = {
}
/**
- * Object store index.
+ * Gets data from extension storage in the given `storageArea`. If `keys` is
+specified, these are used to filter the result.
*/
- export interface ObjectStoreIndex {
- /**
- * Index name.
- */
- name: string;
+ export type getStorageItemsParameters = {
/**
- * Index key path.
+ * ID of extension.
*/
- keyPath: KeyPath;
+ id: string;
/**
- * If true, index is unique.
+ * StorageArea to retrieve data from.
*/
- unique: boolean;
+ storageArea: StorageArea;
/**
- * If true, index allows multiple entries for a key.
+ * Keys to retrieve.
*/
- multiEntry: boolean;
+ keys?: string[];
+ }
+ export type getStorageItemsReturnValue = {
+ data: { [key: string]: string };
}
/**
- * Key.
+ * Removes `keys` from extension storage in the given `storageArea`.
*/
- export interface Key {
- /**
- * Key type.
- */
- type: "number"|"string"|"date"|"array";
- /**
- * Number value.
- */
- number?: number;
+ export type removeStorageItemsParameters = {
/**
- * String value.
+ * ID of extension.
*/
- string?: string;
+ id: string;
/**
- * Date value.
+ * StorageArea to remove data from.
*/
- date?: number;
+ storageArea: StorageArea;
/**
- * Array value.
+ * Keys to remove.
*/
- array?: Key[];
+ keys: string[];
+ }
+ export type removeStorageItemsReturnValue = {
}
/**
- * Key range.
+ * Clears extension storage in the given `storageArea`.
*/
- export interface KeyRange {
- /**
- * Lower bound.
- */
- lower?: Key;
- /**
- * Upper bound.
- */
- upper?: Key;
+ export type clearStorageItemsParameters = {
/**
- * If true lower bound is open.
+ * ID of extension.
*/
- lowerOpen: boolean;
+ id: string;
/**
- * If true upper bound is open.
+ * StorageArea to remove data from.
*/
- upperOpen: boolean;
+ storageArea: StorageArea;
+ }
+ export type clearStorageItemsReturnValue = {
}
/**
- * Data entry.
+ * Sets `values` in extension storage in the given `storageArea`. The provided `values`
+will be merged with existing values in the storage area.
*/
- export interface DataEntry {
+ export type setStorageItemsParameters = {
/**
- * Key object.
+ * ID of extension.
*/
- key: Runtime.RemoteObject;
+ id: string;
/**
- * Primary key object.
+ * StorageArea to set data in.
*/
- primaryKey: Runtime.RemoteObject;
+ storageArea: StorageArea;
/**
- * Value object.
+ * Values to set.
*/
- value: Runtime.RemoteObject;
+ values: { [key: string]: string };
+ }
+ export type setStorageItemsReturnValue = {
}
+ }
+
+ /**
+ * This domain allows interacting with the FedCM dialog.
+ */
+ export module FedCm {
/**
- * Key path.
+ * Whether this is a sign-up or sign-in action for this account, i.e.
+whether this account has ever been used to sign in to this RP before.
*/
- export interface KeyPath {
- /**
- * Key path type.
- */
- type: "null"|"string"|"array";
+ export type LoginState = "SignIn"|"SignUp";
+ /**
+ * The types of FedCM dialogs.
+ */
+ export type DialogType = "AccountChooser"|"AutoReauthn"|"ConfirmIdpLogin"|"Error";
+ /**
+ * The buttons on the FedCM dialog.
+ */
+ export type DialogButton = "ConfirmIdpLoginContinue"|"ErrorGotIt"|"ErrorMoreDetails";
+ /**
+ * The URLs that each account has
+ */
+ export type AccountUrlType = "TermsOfService"|"PrivacyPolicy";
+ /**
+ * Corresponds to IdentityRequestAccount
+ */
+ export interface Account {
+ accountId: string;
+ email: string;
+ name: string;
+ givenName: string;
+ pictureUrl: string;
+ idpConfigUrl: string;
+ idpLoginUrl: string;
+ loginState: LoginState;
/**
- * String value.
+ * These two are only set if the loginState is signUp
*/
- string?: string;
+ termsOfServiceUrl?: string;
+ privacyPolicyUrl?: string;
+ }
+
+ export type dialogShownPayload = {
+ dialogId: string;
+ dialogType: DialogType;
+ accounts: Account[];
/**
- * Array value.
+ * These exist primarily so that the caller can verify the
+RP context was used appropriately.
*/
- array?: string[];
+ title: string;
+ subtitle?: string;
}
-
-
/**
- * Clears all entries from an object store.
+ * Triggered when a dialog is closed, either by user action, JS abort,
+or a command below.
*/
- export type clearObjectStoreParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type dialogClosedPayload = {
+ dialogId: string;
+ }
+
+ export type enableParameters = {
/**
- * Storage key.
+ * Allows callers to disable the promise rejection delay that would
+normally happen, if this is unimportant to what's being tested.
+(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
*/
- storageKey?: string;
+ disableRejectionDelay?: boolean;
+ }
+ export type enableReturnValue = {
+ }
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ export type selectAccountParameters = {
+ dialogId: string;
+ accountIndex: number;
+ }
+ export type selectAccountReturnValue = {
+ }
+ export type clickDialogButtonParameters = {
+ dialogId: string;
+ dialogButton: DialogButton;
+ }
+ export type clickDialogButtonReturnValue = {
+ }
+ export type openUrlParameters = {
+ dialogId: string;
+ accountIndex: number;
+ accountUrlType: AccountUrlType;
+ }
+ export type openUrlReturnValue = {
+ }
+ export type dismissDialogParameters = {
+ dialogId: string;
+ triggerCooldown?: boolean;
+ }
+ export type dismissDialogReturnValue = {
+ }
+ /**
+ * Resets the cooldown time, if any, to allow the next FedCM call to show
+a dialog even if one was recently dismissed by the user.
+ */
+ export type resetCooldownParameters = {
+ }
+ export type resetCooldownReturnValue = {
+ }
+ }
+
+ /**
+ * A domain for letting clients substitute browser's network layer with client code.
+ */
+ export module Fetch {
+ /**
+ * Unique request identifier.
+Note that this does not identify individual HTTP requests that are part of
+a network request.
+ */
+ export type RequestId = string;
+ /**
+ * Stages of the request to handle. Request will intercept before the request is
+sent. Response will intercept after the response is received (but before response
+body is received).
+ */
+ export type RequestStage = "Request"|"Response";
+ export interface RequestPattern {
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
+backslash. Omitting is equivalent to `"*"`.
*/
- storageBucket?: Storage.StorageBucket;
+ urlPattern?: string;
/**
- * Database name.
+ * If set, only requests for matching resource types will be intercepted.
*/
- databaseName: string;
+ resourceType?: Network.ResourceType;
/**
- * Object store name.
+ * Stage at which to begin intercepting requests. Default is Request.
*/
- objectStoreName: string;
+ requestStage?: RequestStage;
}
- export type clearObjectStoreReturnValue = {
+ /**
+ * Response HTTP header entry
+ */
+ export interface HeaderEntry {
+ name: string;
+ value: string;
}
/**
- * Deletes a database.
+ * Authorization challenge for HTTP status code 401 or 407.
*/
- export type deleteDatabaseParameters = {
+ export interface AuthChallenge {
/**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
+ * Source of the authentication challenge.
*/
- securityOrigin?: string;
+ source?: "Server"|"Proxy";
/**
- * Storage key.
+ * Origin of the challenger.
*/
- storageKey?: string;
+ origin: string;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The authentication scheme used, such as basic or digest
*/
- storageBucket?: Storage.StorageBucket;
+ scheme: string;
/**
- * Database name.
+ * The realm of the challenge. May be empty.
*/
- databaseName: string;
- }
- export type deleteDatabaseReturnValue = {
+ realm: string;
}
/**
- * Delete a range of entries from an object store
+ * Response to an AuthChallenge.
*/
- export type deleteObjectStoreEntriesParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export interface AuthChallengeResponse {
/**
- * Storage key.
+ * The decision on what to do in response to the authorization challenge. Default means
+deferring to the default behavior of the net stack, which will likely either the Cancel
+authentication or display a popup dialog box.
*/
- storageKey?: string;
+ response: "Default"|"CancelAuth"|"ProvideCredentials";
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The username to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- storageBucket?: Storage.StorageBucket;
- databaseName: string;
- objectStoreName: string;
+ username?: string;
/**
- * Range of entry keys to delete
+ * The password to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- keyRange: KeyRange;
- }
- export type deleteObjectStoreEntriesReturnValue = {
- }
- /**
- * Disables events from backend.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Enables events from backend.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
+ password?: string;
}
+
/**
- * Requests data from object store or index.
+ * Issued when the domain is enabled and the request URL matches the
+specified filter. The request is paused until the client responds
+with one of continueRequest, failRequest or fulfillRequest.
+The stage of the request can be determined by presence of responseErrorReason
+and responseStatusCode -- the request is at the response stage if either
+of these fields is present and in the request stage otherwise.
+Redirect responses and subsequent requests are reported similarly to regular
+responses and requests. Redirect responses may be distinguished by the value
+of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with
+presence of the `location` header. Requests resulting from a redirect will
+have `redirectedRequestId` field set.
*/
- export type requestDataParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type requestPausedPayload = {
/**
- * Storage key.
+ * Each request the page makes will have a unique id.
*/
- storageKey?: string;
+ requestId: RequestId;
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * The details of the request.
*/
- storageBucket?: Storage.StorageBucket;
+ request: Network.Request;
/**
- * Database name.
+ * The id of the frame that initiated the request.
*/
- databaseName: string;
+ frameId: Page.FrameId;
/**
- * Object store name.
+ * How the requested resource will be used.
*/
- objectStoreName: string;
+ resourceType: Network.ResourceType;
/**
- * Index name, empty string for object store data requests.
+ * Response error if intercepted at response stage.
*/
- indexName: string;
+ responseErrorReason?: Network.ErrorReason;
/**
- * Number of records to skip.
+ * Response code if intercepted at response stage.
*/
- skipCount: number;
+ responseStatusCode?: number;
/**
- * Number of records to fetch.
+ * Response status text if intercepted at response stage.
*/
- pageSize: number;
+ responseStatusText?: string;
/**
- * Key range.
+ * Response headers if intercepted at the response stage.
*/
- keyRange?: KeyRange;
- }
- export type requestDataReturnValue = {
+ responseHeaders?: HeaderEntry[];
/**
- * Array of object store data entries.
+ * If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
+then this networkId will be the same as the requestId present in the requestWillBeSent event.
*/
- objectStoreDataEntries: DataEntry[];
+ networkId?: Network.RequestId;
/**
- * If true, there are more entries to fetch in the given range.
+ * If the request is due to a redirect response from the server, the id of the request that
+has caused the redirect.
*/
- hasMore: boolean;
+ redirectedRequestId?: RequestId;
}
/**
- * Gets metadata of an object store.
+ * Issued when the domain is enabled with handleAuthRequests set to true.
+The request is paused until client responds with continueWithAuth.
*/
- export type getMetadataParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
- /**
- * Storage key.
- */
- storageKey?: string;
+ export type authRequiredPayload = {
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * Each request the page makes will have a unique id.
*/
- storageBucket?: Storage.StorageBucket;
+ requestId: RequestId;
/**
- * Database name.
+ * The details of the request.
*/
- databaseName: string;
+ request: Network.Request;
/**
- * Object store name.
+ * The id of the frame that initiated the request.
*/
- objectStoreName: string;
- }
- export type getMetadataReturnValue = {
+ frameId: Page.FrameId;
/**
- * the entries count
+ * How the requested resource will be used.
*/
- entriesCount: number;
+ resourceType: Network.ResourceType;
/**
- * the current value of key generator, to become the next inserted
-key into the object store. Valid if objectStore.autoIncrement
-is true.
+ * Details of the Authorization Challenge encountered.
+If this is set, client should respond with continueRequest that
+contains AuthChallengeResponse.
*/
- keyGeneratorValue: number;
+ authChallenge: AuthChallenge;
}
+
/**
- * Requests database with given name in given frame.
+ * Disables the fetch domain.
*/
- export type requestDatabaseParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
- /**
- * Storage key.
- */
- storageKey?: string;
- /**
- * Storage bucket. If not specified, it uses the default bucket.
- */
- storageBucket?: Storage.StorageBucket;
- /**
- * Database name.
- */
- databaseName: string;
+ export type disableParameters = {
}
- export type requestDatabaseReturnValue = {
- /**
- * Database with an array of object stores.
- */
- databaseWithObjectStores: DatabaseWithObjectStores;
+ export type disableReturnValue = {
}
/**
- * Requests database names for given security origin.
+ * Enables issuing of requestPaused events. A request will be paused until client
+calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
*/
- export type requestDatabaseNamesParameters = {
- /**
- * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
-Security origin.
- */
- securityOrigin?: string;
+ export type enableParameters = {
/**
- * Storage key.
+ * If specified, only requests matching any of these patterns will produce
+fetchRequested event and will be paused until clients response. If not set,
+all requests will be affected.
*/
- storageKey?: string;
+ patterns?: RequestPattern[];
/**
- * Storage bucket. If not specified, it uses the default bucket.
+ * If true, authRequired events will be issued and requests will be paused
+expecting a call to continueWithAuth.
*/
- storageBucket?: Storage.StorageBucket;
+ handleAuthRequests?: boolean;
}
- export type requestDatabaseNamesReturnValue = {
- /**
- * Database names for origin.
- */
- databaseNames: string[];
+ export type enableReturnValue = {
}
- }
-
- export module Input {
- export interface TouchPoint {
- /**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
- */
- x: number;
- /**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
- */
- y: number;
- /**
- * X radius of the touch area (default: 1.0).
- */
- radiusX?: number;
+ /**
+ * Causes the request to fail with specified reason.
+ */
+ export type failRequestParameters = {
/**
- * Y radius of the touch area (default: 1.0).
+ * An id the client received in requestPaused event.
*/
- radiusY?: number;
+ requestId: RequestId;
/**
- * Rotation angle (default: 0.0).
+ * Causes the request to fail with the given reason.
*/
- rotationAngle?: number;
+ errorReason: Network.ErrorReason;
+ }
+ export type failRequestReturnValue = {
+ }
+ /**
+ * Provides response to the request.
+ */
+ export type fulfillRequestParameters = {
/**
- * Force (default: 1.0).
+ * An id the client received in requestPaused event.
*/
- force?: number;
+ requestId: RequestId;
/**
- * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ * An HTTP response code.
*/
- tangentialPressure?: number;
+ responseCode: number;
/**
- * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
+ * Response headers.
*/
- tiltX?: number;
+ responseHeaders?: HeaderEntry[];
/**
- * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ * Alternative way of specifying response headers as a \0-separated
+series of name: value pairs. Prefer the above method unless you
+need to represent some non-UTF8 values that can't be transmitted
+over the protocol as text.
*/
- tiltY?: number;
+ binaryResponseHeaders?: binary;
/**
- * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ * A response body. If absent, original response body will be used if
+the request is intercepted at the response stage and empty body
+will be used if the request is intercepted at the request stage.
*/
- twist?: number;
+ body?: binary;
/**
- * Identifier used to track touch sources between events, must be unique within an event.
+ * A textual representation of responseCode.
+If absent, a standard phrase matching responseCode is used.
*/
- id?: number;
+ responsePhrase?: string;
+ }
+ export type fulfillRequestReturnValue = {
}
- export type GestureSourceType = "default"|"touch"|"mouse";
- export type MouseButton = "none"|"left"|"middle"|"right"|"back"|"forward";
/**
- * UTC time in seconds, counted from January 1, 1970.
+ * Continues the request, optionally modifying some of its parameters.
*/
- export type TimeSinceEpoch = number;
- export interface DragDataItem {
+ export type continueRequestParameters = {
/**
- * Mime type of the dragged data.
+ * An id the client received in requestPaused event.
*/
- mimeType: string;
+ requestId: RequestId;
/**
- * Depending of the value of `mimeType`, it contains the dragged link,
-text, HTML markup or any other data.
+ * If set, the request url will be modified in a way that's not observable by page.
*/
- data: string;
+ url?: string;
/**
- * Title associated with a link. Only valid when `mimeType` == "text/uri-list".
+ * If set, the request method is overridden.
*/
- title?: string;
+ method?: string;
/**
- * Stores the base URL for the contained markup. Only valid when `mimeType`
-== "text/html".
+ * If set, overrides the post data in the request.
*/
- baseURL?: string;
- }
- export interface DragData {
- items: DragDataItem[];
+ postData?: binary;
/**
- * List of filenames that should be included when dropping
+ * If set, overrides the request headers. Note that the overrides do not
+extend to subsequent redirect hops, if a redirect happens. Another override
+may be applied to a different request produced by a redirect.
*/
- files?: string[];
+ headers?: HeaderEntry[];
/**
- * Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
+ * If set, overrides response interception behavior for this request.
*/
- dragOperationsMask: number;
+ interceptResponse?: boolean;
}
-
- /**
- * Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
-restore normal drag and drop behavior.
- */
- export type dragInterceptedPayload = {
- data: DragData;
+ export type continueRequestReturnValue = {
}
-
/**
- * Dispatches a drag event into the page.
+ * Continues a request supplying authChallengeResponse following authRequired event.
*/
- export type dispatchDragEventParameters = {
- /**
- * Type of the drag event.
- */
- type: "dragEnter"|"dragOver"|"drop"|"dragCancel";
- /**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
- */
- x: number;
+ export type continueWithAuthParameters = {
/**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ * An id the client received in authRequired event.
*/
- y: number;
- data: DragData;
+ requestId: RequestId;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Response to with an authChallenge.
*/
- modifiers?: number;
+ authChallengeResponse: AuthChallengeResponse;
}
- export type dispatchDragEventReturnValue = {
+ export type continueWithAuthReturnValue = {
}
/**
- * Dispatches a key event to the page.
+ * Continues loading of the paused response, optionally modifying the
+response headers. If either responseCode or headers are modified, all of them
+must be present.
*/
- export type dispatchKeyEventParameters = {
- /**
- * Type of the key event.
- */
- type: "keyDown"|"keyUp"|"rawKeyDown"|"char";
+ export type continueResponseParameters = {
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * An id the client received in requestPaused event.
*/
- modifiers?: number;
+ requestId: RequestId;
/**
- * Time at which the event occurred.
+ * An HTTP response code. If absent, original response code will be used.
*/
- timestamp?: TimeSinceEpoch;
+ responseCode?: number;
/**
- * Text as generated by processing a virtual key code with a keyboard layout. Not needed for
-for `keyUp` and `rawKeyDown` events (default: "")
+ * A textual representation of responseCode.
+If absent, a standard phrase matching responseCode is used.
*/
- text?: string;
+ responsePhrase?: string;
/**
- * Text that would have been generated by the keyboard if no modifiers were pressed (except for
-shift). Useful for shortcut (accelerator) key handling (default: "").
+ * Response headers. If absent, original response headers will be used.
*/
- unmodifiedText?: string;
+ responseHeaders?: HeaderEntry[];
/**
- * Unique key identifier (e.g., 'U+0041') (default: "").
+ * Alternative way of specifying response headers as a \0-separated
+series of name: value pairs. Prefer the above method unless you
+need to represent some non-UTF8 values that can't be transmitted
+over the protocol as text.
*/
- keyIdentifier?: string;
+ binaryResponseHeaders?: binary;
+ }
+ export type continueResponseReturnValue = {
+ }
+ /**
+ * Causes the body of the response to be received from the server and
+returned as a single string. May only be issued for a request that
+is paused in the Response stage and is mutually exclusive with
+takeResponseBodyForInterceptionAsStream. Calling other methods that
+affect the request or disabling fetch domain before body is received
+results in an undefined behavior.
+Note that the response body is not available for redirects. Requests
+paused in the _redirect received_ state may be differentiated by
+`responseCode` and presence of `location` response header, see
+comments to `requestPaused` for details.
+ */
+ export type getResponseBodyParameters = {
/**
- * Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
+ * Identifier for the intercepted request to get body for.
*/
- code?: string;
+ requestId: RequestId;
+ }
+ export type getResponseBodyReturnValue = {
/**
- * Unique DOM defined string value describing the meaning of the key in the context of active
-modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
+ * Response body.
*/
- key?: string;
+ body: string;
/**
- * Windows virtual key code (default: 0).
+ * True, if content was sent as base64.
*/
- windowsVirtualKeyCode?: number;
+ base64Encoded: boolean;
+ }
+ /**
+ * Returns a handle to the stream representing the response body.
+The request must be paused in the HeadersReceived stage.
+Note that after this command the request can't be continued
+as is -- client either needs to cancel it or to provide the
+response body.
+The stream only supports sequential read, IO.read will fail if the position
+is specified.
+This method is mutually exclusive with getResponseBody.
+Calling other methods that affect the request or disabling fetch
+domain before body is received results in an undefined behavior.
+ */
+ export type takeResponseBodyAsStreamParameters = {
+ requestId: RequestId;
+ }
+ export type takeResponseBodyAsStreamReturnValue = {
+ stream: IO.StreamHandle;
+ }
+ }
+
+ export module FileSystem {
+ export interface File {
+ name: string;
/**
- * Native virtual key code (default: 0).
+ * Timestamp
*/
- nativeVirtualKeyCode?: number;
+ lastModified: Network.TimeSinceEpoch;
/**
- * Whether the event was generated from auto repeat (default: false).
+ * Size in bytes
*/
- autoRepeat?: boolean;
+ size: number;
+ type: string;
+ }
+ export interface Directory {
+ name: string;
+ nestedDirectories: string[];
/**
- * Whether the event was generated from the keypad (default: false).
+ * Files that are directly nested under this directory.
*/
- isKeypad?: boolean;
+ nestedFiles: File[];
+ }
+ export interface BucketFileSystemLocator {
/**
- * Whether the event was a system key event (default: false).
+ * Storage key
*/
- isSystemKey?: boolean;
+ storageKey: Storage.SerializedStorageKey;
/**
- * Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
-0).
+ * Bucket name. Not passing a `bucketName` will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
*/
- location?: number;
+ bucketName?: string;
/**
- * Editing commands to send with the key event (e.g., 'selectAll') (default: []).
-These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
-See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
+ * Path to the directory using each path component as an array item.
*/
- commands?: string[];
+ pathComponents: string[];
}
- export type dispatchKeyEventReturnValue = {
+
+
+ export type getDirectoryParameters = {
+ bucketFileSystemLocator: BucketFileSystemLocator;
}
- /**
- * This method emulates inserting text that doesn't come from a key press,
-for example an emoji keyboard or an IME.
- */
- export type insertTextParameters = {
+ export type getDirectoryReturnValue = {
/**
- * The text to insert.
+ * Returns the directory object at the path.
*/
- text: string;
- }
- export type insertTextReturnValue = {
+ directory: Directory;
}
+ }
+
+ /**
+ * This domain provides experimental commands only supported in headless mode.
+ */
+ export module HeadlessExperimental {
/**
- * This method sets the current candidate text for IME.
-Use imeCommitComposition to commit the final text.
-Use imeSetComposition with empty string as text to cancel composition.
+ * Encoding options for a screenshot.
*/
- export type imeSetCompositionParameters = {
- /**
- * The text to insert
- */
- text: string;
- /**
- * selection start
- */
- selectionStart: number;
+ export interface ScreenshotParams {
/**
- * selection end
+ * Image compression format (defaults to png).
*/
- selectionEnd: number;
+ format?: "jpeg"|"png"|"webp";
/**
- * replacement start
+ * Compression quality from range [0..100] (jpeg and webp only).
*/
- replacementStart?: number;
+ quality?: number;
/**
- * replacement end
+ * Optimize image encoding for speed, not for resulting size (defaults to false)
*/
- replacementEnd?: number;
- }
- export type imeSetCompositionReturnValue = {
+ optimizeForSpeed?: boolean;
}
+
+
/**
- * Dispatches a mouse event to the page.
+ * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a
+screenshot from the resulting frame. Requires that the target was created with enabled
+BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also
+https://goo.gle/chrome-headless-rendering for more background.
*/
- export type dispatchMouseEventParameters = {
- /**
- * Type of the mouse event.
- */
- type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
+ export type beginFrameParameters = {
/**
- * X coordinate of the event relative to the main frame's viewport in CSS pixels.
+ * Timestamp of this BeginFrame in Renderer TimeTicks (milliseconds of uptime). If not set,
+the current time will be used.
*/
- x: number;
+ frameTimeTicks?: number;
/**
- * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
-the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ * The interval between BeginFrames that is reported to the compositor, in milliseconds.
+Defaults to a 60 frames/second interval, i.e. about 16.666 milliseconds.
*/
- y: number;
+ interval?: number;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Whether updates should not be committed and drawn onto the display. False by default. If
+true, only side effects of the BeginFrame will be run, such as layout and animations, but
+any visual updates may not be visible on the display or in screenshots.
*/
- modifiers?: number;
+ noDisplayUpdates?: boolean;
/**
- * Time at which the event occurred.
+ * If set, a screenshot of the frame will be captured and returned in the response. Otherwise,
+no screenshot will be captured. Note that capturing a screenshot can fail, for example,
+during renderer initialization. In such a case, no screenshot data will be returned.
*/
- timestamp?: TimeSinceEpoch;
+ screenshot?: ScreenshotParams;
+ }
+ export type beginFrameReturnValue = {
/**
- * Mouse button (default: "none").
+ * Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the
+display. Reported for diagnostic uses, may be removed in the future.
*/
- button?: MouseButton;
+ hasDamage: boolean;
/**
- * A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
-Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
+ * Base64-encoded image data of the screenshot, if one was requested and successfully taken.
*/
- buttons?: number;
+ screenshotData?: binary;
+ }
+ /**
+ * Disables headless events for the target.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Enables headless events for the target.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ }
+
+ /**
+ * Input/Output operations for streams produced by DevTools.
+ */
+ export module IO {
+ /**
+ * This is either obtained from another method or specified as `blob:<uuid>` where
+`<uuid>` is an UUID of a Blob.
+ */
+ export type StreamHandle = string;
+
+
+ /**
+ * Close the stream, discard any temporary backing storage.
+ */
+ export type closeParameters = {
/**
- * Number of times the mouse button was clicked (default: 0).
+ * Handle of the stream to close.
*/
- clickCount?: number;
+ handle: StreamHandle;
+ }
+ export type closeReturnValue = {
+ }
+ /**
+ * Read a chunk of the stream
+ */
+ export type readParameters = {
/**
- * The normalized pressure, which has a range of [0,1] (default: 0).
+ * Handle of the stream to read.
*/
- force?: number;
+ handle: StreamHandle;
/**
- * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ * Seek to the specified offset before reading (if not specified, proceed with offset
+following the last read). Some types of streams may only support sequential reads.
*/
- tangentialPressure?: number;
+ offset?: number;
/**
- * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
+ * Maximum number of bytes to read (left upon the agent discretion if not specified).
*/
- tiltX?: number;
+ size?: number;
+ }
+ export type readReturnValue = {
/**
- * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ * Set if the data is base64-encoded
*/
- tiltY?: number;
+ base64Encoded?: boolean;
/**
- * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ * Data that were read.
*/
- twist?: number;
+ data: string;
/**
- * X delta in CSS pixels for mouse wheel event (default: 0).
+ * Set if the end-of-file condition occurred while reading.
*/
- deltaX?: number;
+ eof: boolean;
+ }
+ /**
+ * Return UUID of Blob object specified by a remote object id.
+ */
+ export type resolveBlobParameters = {
/**
- * Y delta in CSS pixels for mouse wheel event (default: 0).
+ * Object id of a Blob object wrapper.
*/
- deltaY?: number;
+ objectId: Runtime.RemoteObjectId;
+ }
+ export type resolveBlobReturnValue = {
/**
- * Pointer type (default: "mouse").
+ * UUID of the specified Blob.
*/
- pointerType?: "mouse"|"pen";
- }
- export type dispatchMouseEventReturnValue = {
+ uuid: string;
}
+ }
+
+ export module IndexedDB {
/**
- * Dispatches a touch event to the page.
+ * Database with an array of object stores.
*/
- export type dispatchTouchEventParameters = {
+ export interface DatabaseWithObjectStores {
/**
- * Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
-TouchStart and TouchMove must contains at least one.
- */
- type: "touchStart"|"touchEnd"|"touchMove"|"touchCancel";
- /**
- * Active touch points on the touch device. One event per any changed point (compared to
-previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
-one by one.
+ * Database name.
*/
- touchPoints: TouchPoint[];
+ name: string;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Database version (type is not 'integer', as the standard
+requires the version number to be 'unsigned long long')
*/
- modifiers?: number;
+ version: number;
/**
- * Time at which the event occurred.
+ * Object stores in this database.
*/
- timestamp?: TimeSinceEpoch;
- }
- export type dispatchTouchEventReturnValue = {
+ objectStores: ObjectStore[];
}
/**
- * Cancels any active dragging in the page.
+ * Object store.
*/
- export type cancelDraggingParameters = {
- }
- export type cancelDraggingReturnValue = {
+ export interface ObjectStore {
+ /**
+ * Object store name.
+ */
+ name: string;
+ /**
+ * Object store key path.
+ */
+ keyPath: KeyPath;
+ /**
+ * If true, object store has auto increment flag set.
+ */
+ autoIncrement: boolean;
+ /**
+ * Indexes in this object store.
+ */
+ indexes: ObjectStoreIndex[];
}
/**
- * Emulates touch event from the mouse event parameters.
+ * Object store index.
*/
- export type emulateTouchFromMouseEventParameters = {
+ export interface ObjectStoreIndex {
/**
- * Type of the mouse event.
+ * Index name.
*/
- type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
+ name: string;
/**
- * X coordinate of the mouse pointer in DIP.
+ * Index key path.
*/
- x: number;
+ keyPath: KeyPath;
/**
- * Y coordinate of the mouse pointer in DIP.
+ * If true, index is unique.
*/
- y: number;
+ unique: boolean;
/**
- * Mouse button. Only "none", "left", "right" are supported.
+ * If true, index allows multiple entries for a key.
*/
- button: MouseButton;
+ multiEntry: boolean;
+ }
+ /**
+ * Key.
+ */
+ export interface Key {
/**
- * Time at which the event occurred (default: current time).
+ * Key type.
*/
- timestamp?: TimeSinceEpoch;
+ type: "number"|"string"|"date"|"array";
/**
- * X delta in DIP for mouse wheel event (default: 0).
+ * Number value.
*/
- deltaX?: number;
+ number?: number;
/**
- * Y delta in DIP for mouse wheel event (default: 0).
+ * String value.
*/
- deltaY?: number;
+ string?: string;
/**
- * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
-(default: 0).
+ * Date value.
*/
- modifiers?: number;
+ date?: number;
/**
- * Number of times the mouse button was clicked (default: 0).
+ * Array value.
*/
- clickCount?: number;
- }
- export type emulateTouchFromMouseEventReturnValue = {
+ array?: Key[];
}
/**
- * Ignores input events (useful while auditing page).
+ * Key range.
*/
- export type setIgnoreInputEventsParameters = {
+ export interface KeyRange {
/**
- * Ignores input events processing when set to true.
+ * Lower bound.
*/
- ignore: boolean;
- }
- export type setIgnoreInputEventsReturnValue = {
- }
- /**
- * Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
-Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
- */
- export type setInterceptDragsParameters = {
- enabled: boolean;
- }
- export type setInterceptDragsReturnValue = {
- }
- /**
- * Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
- */
- export type synthesizePinchGestureParameters = {
+ lower?: Key;
/**
- * X coordinate of the start of the gesture in CSS pixels.
+ * Upper bound.
*/
- x: number;
+ upper?: Key;
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * If true lower bound is open.
*/
- y: number;
+ lowerOpen: boolean;
/**
- * Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
+ * If true upper bound is open.
*/
- scaleFactor: number;
+ upperOpen: boolean;
+ }
+ /**
+ * Data entry.
+ */
+ export interface DataEntry {
/**
- * Relative pointer speed in pixels per second (default: 800).
+ * Key object.
*/
- relativeSpeed?: number;
+ key: Runtime.RemoteObject;
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * Primary key object.
*/
- gestureSourceType?: GestureSourceType;
- }
- export type synthesizePinchGestureReturnValue = {
+ primaryKey: Runtime.RemoteObject;
+ /**
+ * Value object.
+ */
+ value: Runtime.RemoteObject;
}
/**
- * Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
+ * Key path.
*/
- export type synthesizeScrollGestureParameters = {
+ export interface KeyPath {
/**
- * X coordinate of the start of the gesture in CSS pixels.
+ * Key path type.
*/
- x: number;
+ type: "null"|"string"|"array";
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * String value.
*/
- y: number;
+ string?: string;
/**
- * The distance to scroll along the X axis (positive to scroll left).
+ * Array value.
*/
- xDistance?: number;
+ array?: string[];
+ }
+
+
+ /**
+ * Clears all entries from an object store.
+ */
+ export type clearObjectStoreParameters = {
/**
- * The distance to scroll along the Y axis (positive to scroll up).
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- yDistance?: number;
+ securityOrigin?: string;
/**
- * The number of additional pixels to scroll back along the X axis, in addition to the given
-distance.
+ * Storage key.
*/
- xOverscroll?: number;
+ storageKey?: string;
/**
- * The number of additional pixels to scroll back along the Y axis, in addition to the given
-distance.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- yOverscroll?: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * Prevent fling (default: true).
+ * Database name.
*/
- preventFling?: boolean;
+ databaseName: string;
/**
- * Swipe speed in pixels per second (default: 800).
+ * Object store name.
*/
- speed?: number;
+ objectStoreName: string;
+ }
+ export type clearObjectStoreReturnValue = {
+ }
+ /**
+ * Deletes a database.
+ */
+ export type deleteDatabaseParameters = {
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- gestureSourceType?: GestureSourceType;
+ securityOrigin?: string;
/**
- * The number of times to repeat the gesture (default: 0).
+ * Storage key.
*/
- repeatCount?: number;
+ storageKey?: string;
/**
- * The number of milliseconds delay between each repeat. (default: 250).
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- repeatDelayMs?: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * The name of the interaction markers to generate, if not empty (default: "").
+ * Database name.
*/
- interactionMarkerName?: string;
+ databaseName: string;
}
- export type synthesizeScrollGestureReturnValue = {
+ export type deleteDatabaseReturnValue = {
}
/**
- * Synthesizes a tap gesture over a time period by issuing appropriate touch events.
+ * Delete a range of entries from an object store
*/
- export type synthesizeTapGestureParameters = {
- /**
- * X coordinate of the start of the gesture in CSS pixels.
- */
- x: number;
+ export type deleteObjectStoreEntriesParameters = {
/**
- * Y coordinate of the start of the gesture in CSS pixels.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- y: number;
+ securityOrigin?: string;
/**
- * Duration between touchdown and touchup events in ms (default: 50).
+ * Storage key.
*/
- duration?: number;
+ storageKey?: string;
/**
- * Number of times to perform the tap (e.g. 2 for double tap, default: 1).
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- tapCount?: number;
+ storageBucket?: Storage.StorageBucket;
+ databaseName: string;
+ objectStoreName: string;
/**
- * Which type of input events to be generated (default: 'default', which queries the platform
-for the preferred input type).
+ * Range of entry keys to delete
*/
- gestureSourceType?: GestureSourceType;
+ keyRange: KeyRange;
}
- export type synthesizeTapGestureReturnValue = {
+ export type deleteObjectStoreEntriesReturnValue = {
}
- }
-
- export module Inspector {
-
/**
- * Fired when remote debugging connection is about to be terminated. Contains detach reason.
- */
- export type detachedPayload = {
- /**
- * The reason why connection has been terminated.
- */
- reason: string;
- }
- /**
- * Fired when debugging target has crashed
- */
- export type targetCrashedPayload = void;
- /**
- * Fired when debugging target has reloaded after crash
- */
- export type targetReloadedAfterCrashPayload = void;
-
- /**
- * Disables inspector domain notifications.
+ * Disables events from backend.
*/
export type disableParameters = {
}
export type disableReturnValue = {
}
/**
- * Enables inspector domain notifications.
+ * Enables events from backend.
*/
export type enableParameters = {
}
export type enableReturnValue = {
}
- }
-
- export module LayerTree {
- /**
- * Unique Layer identifier.
- */
- export type LayerId = string;
- /**
- * Unique snapshot identifier.
- */
- export type SnapshotId = string;
/**
- * Rectangle where scrolling happens on the main thread.
+ * Requests data from object store or index.
*/
- export interface ScrollRect {
+ export type requestDataParameters = {
/**
- * Rectangle itself.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- rect: DOM.Rect;
+ securityOrigin?: string;
/**
- * Reason for rectangle to force scrolling on the main thread
+ * Storage key.
*/
- type: "RepaintsOnScroll"|"TouchEventHandler"|"WheelEventHandler";
- }
- /**
- * Sticky position constraints.
- */
- export interface StickyPositionConstraint {
+ storageKey?: string;
/**
- * Layout rectangle of the sticky element before being shifted
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- stickyBoxRect: DOM.Rect;
+ storageBucket?: Storage.StorageBucket;
/**
- * Layout rectangle of the containing block of the sticky element
+ * Database name.
*/
- containingBlockRect: DOM.Rect;
+ databaseName: string;
/**
- * The nearest sticky layer that shifts the sticky box
+ * Object store name.
*/
- nearestLayerShiftingStickyBox?: LayerId;
+ objectStoreName: string;
/**
- * The nearest sticky layer that shifts the containing block
+ * Index name, empty string for object store data requests.
*/
- nearestLayerShiftingContainingBlock?: LayerId;
- }
- /**
- * Serialized fragment of layer picture along with its offset within the layer.
- */
- export interface PictureTile {
+ indexName: string;
/**
- * Offset from owning layer left boundary
+ * Number of records to skip.
*/
- x: number;
+ skipCount: number;
/**
- * Offset from owning layer top boundary
+ * Number of records to fetch.
*/
- y: number;
+ pageSize: number;
/**
- * Base64-encoded snapshot data.
+ * Key range.
*/
- picture: binary;
+ keyRange?: KeyRange;
}
- /**
- * Information about a compositing layer.
- */
- export interface Layer {
- /**
- * The unique id for this layer.
- */
- layerId: LayerId;
- /**
- * The id of parent (not present for root).
- */
- parentLayerId?: LayerId;
+ export type requestDataReturnValue = {
/**
- * The backend id for the node associated with this layer.
+ * Array of object store data entries.
*/
- backendNodeId?: DOM.BackendNodeId;
+ objectStoreDataEntries: DataEntry[];
/**
- * Offset from parent layer, X coordinate.
+ * If true, there are more entries to fetch in the given range.
*/
- offsetX: number;
+ hasMore: boolean;
+ }
+ /**
+ * Gets metadata of an object store.
+ */
+ export type getMetadataParameters = {
/**
- * Offset from parent layer, Y coordinate.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- offsetY: number;
+ securityOrigin?: string;
/**
- * Layer width.
+ * Storage key.
*/
- width: number;
+ storageKey?: string;
/**
- * Layer height.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- height: number;
+ storageBucket?: Storage.StorageBucket;
/**
- * Transformation matrix for layer, default is identity matrix
+ * Database name.
*/
- transform?: number[];
+ databaseName: string;
/**
- * Transform anchor point X, absent if no transform specified
+ * Object store name.
*/
- anchorX?: number;
+ objectStoreName: string;
+ }
+ export type getMetadataReturnValue = {
/**
- * Transform anchor point Y, absent if no transform specified
+ * the entries count
*/
- anchorY?: number;
+ entriesCount: number;
/**
- * Transform anchor point Z, absent if no transform specified
+ * the current value of key generator, to become the next inserted
+key into the object store. Valid if objectStore.autoIncrement
+is true.
*/
- anchorZ?: number;
+ keyGeneratorValue: number;
+ }
+ /**
+ * Requests database with given name in given frame.
+ */
+ export type requestDatabaseParameters = {
/**
- * Indicates how many time this layer has painted.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- paintCount: number;
+ securityOrigin?: string;
/**
- * Indicates whether this layer hosts any content, rather than being used for
-transform/scrolling purposes only.
+ * Storage key.
*/
- drawsContent: boolean;
+ storageKey?: string;
/**
- * Set if layer is not visible.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- invisible?: boolean;
+ storageBucket?: Storage.StorageBucket;
/**
- * Rectangles scrolling on main thread only.
+ * Database name.
*/
- scrollRects?: ScrollRect[];
+ databaseName: string;
+ }
+ export type requestDatabaseReturnValue = {
/**
- * Sticky position constraint information
+ * Database with an array of object stores.
*/
- stickyPositionConstraint?: StickyPositionConstraint;
+ databaseWithObjectStores: DatabaseWithObjectStores;
}
/**
- * Array of timings, one per paint step.
+ * Requests database names for given security origin.
*/
- export type PaintProfile = number[];
-
- export type layerPaintedPayload = {
+ export type requestDatabaseNamesParameters = {
/**
- * The id of the painted layer.
+ * At least and at most one of securityOrigin, storageKey, or storageBucket must be specified.
+Security origin.
*/
- layerId: LayerId;
+ securityOrigin?: string;
/**
- * Clip rectangle.
+ * Storage key.
*/
- clip: DOM.Rect;
- }
- export type layerTreeDidChangePayload = {
+ storageKey?: string;
/**
- * Layer tree, absent if not in the compositing mode.
+ * Storage bucket. If not specified, it uses the default bucket.
*/
- layers?: Layer[];
+ storageBucket?: Storage.StorageBucket;
}
-
- /**
- * Provides the reasons why the given layer was composited.
- */
- export type compositingReasonsParameters = {
+ export type requestDatabaseNamesReturnValue = {
/**
- * The id of the layer for which we want to get the reasons it was composited.
+ * Database names for origin.
*/
- layerId: LayerId;
+ databaseNames: string[];
}
- export type compositingReasonsReturnValue = {
+ }
+
+ export module Input {
+ export interface TouchPoint {
/**
- * A list of strings specifying reasons for the given layer to become composited.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- compositingReasons: string[];
+ x: number;
/**
- * A list of strings specifying reason IDs for the given layer to become composited.
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
*/
- compositingReasonIds: string[];
- }
- /**
- * Disables compositing tree inspection.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Enables compositing tree inspection.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Returns the snapshot identifier.
- */
- export type loadSnapshotParameters = {
+ y: number;
/**
- * An array of tiles composing the snapshot.
+ * X radius of the touch area (default: 1.0).
*/
- tiles: PictureTile[];
- }
- export type loadSnapshotReturnValue = {
+ radiusX?: number;
/**
- * The id of the snapshot.
+ * Y radius of the touch area (default: 1.0).
*/
- snapshotId: SnapshotId;
- }
- /**
- * Returns the layer snapshot identifier.
- */
- export type makeSnapshotParameters = {
+ radiusY?: number;
/**
- * The id of the layer.
+ * Rotation angle (default: 0.0).
*/
- layerId: LayerId;
- }
- export type makeSnapshotReturnValue = {
+ rotationAngle?: number;
/**
- * The id of the layer snapshot.
+ * Force (default: 1.0).
*/
- snapshotId: SnapshotId;
- }
- export type profileSnapshotParameters = {
+ force?: number;
/**
- * The id of the layer snapshot.
+ * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
*/
- snapshotId: SnapshotId;
+ tangentialPressure?: number;
/**
- * The maximum number of times to replay the snapshot (1, if not specified).
+ * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
*/
- minRepeatCount?: number;
+ tiltX?: number;
/**
- * The minimum duration (in seconds) to replay the snapshot.
+ * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
*/
- minDuration?: number;
+ tiltY?: number;
/**
- * The clip rectangle to apply when replaying the snapshot.
+ * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
*/
- clipRect?: DOM.Rect;
- }
- export type profileSnapshotReturnValue = {
+ twist?: number;
/**
- * The array of paint profiles, one per run.
+ * Identifier used to track touch sources between events, must be unique within an event.
*/
- timings: PaintProfile[];
+ id?: number;
}
+ export type GestureSourceType = "default"|"touch"|"mouse";
+ export type MouseButton = "none"|"left"|"middle"|"right"|"back"|"forward";
/**
- * Releases layer snapshot captured by the back-end.
+ * UTC time in seconds, counted from January 1, 1970.
*/
- export type releaseSnapshotParameters = {
+ export type TimeSinceEpoch = number;
+ export interface DragDataItem {
/**
- * The id of the layer snapshot.
+ * Mime type of the dragged data.
*/
- snapshotId: SnapshotId;
- }
- export type releaseSnapshotReturnValue = {
- }
- /**
- * Replays the layer snapshot and returns the resulting bitmap.
- */
- export type replaySnapshotParameters = {
+ mimeType: string;
/**
- * The id of the layer snapshot.
+ * Depending of the value of `mimeType`, it contains the dragged link,
+text, HTML markup or any other data.
*/
- snapshotId: SnapshotId;
+ data: string;
/**
- * The first step to replay from (replay from the very start if not specified).
+ * Title associated with a link. Only valid when `mimeType` == "text/uri-list".
*/
- fromStep?: number;
+ title?: string;
/**
- * The last step to replay to (replay till the end if not specified).
+ * Stores the base URL for the contained markup. Only valid when `mimeType`
+== "text/html".
*/
- toStep?: number;
+ baseURL?: string;
+ }
+ export interface DragData {
+ items: DragDataItem[];
/**
- * The scale to apply while replaying (defaults to 1).
+ * List of filenames that should be included when dropping
*/
- scale?: number;
- }
- export type replaySnapshotReturnValue = {
+ files?: string[];
/**
- * A data: URL for resulting image.
+ * Bit field representing allowed drag operations. Copy = 1, Link = 2, Move = 16
*/
- dataURL: string;
+ dragOperationsMask: number;
}
+
/**
- * Replays the layer snapshot and returns canvas log.
+ * Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to
+restore normal drag and drop behavior.
*/
- export type snapshotCommandLogParameters = {
+ export type dragInterceptedPayload = {
+ data: DragData;
+ }
+
+ /**
+ * Dispatches a drag event into the page.
+ */
+ export type dispatchDragEventParameters = {
/**
- * The id of the layer snapshot.
+ * Type of the drag event.
*/
- snapshotId: SnapshotId;
- }
- export type snapshotCommandLogReturnValue = {
+ type: "dragEnter"|"dragOver"|"drop"|"dragCancel";
/**
- * The array of canvas function calls.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- commandLog: { [key: string]: string }[];
+ x: number;
+ /**
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
+ */
+ y: number;
+ data: DragData;
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ }
+ export type dispatchDragEventReturnValue = {
}
- }
-
- /**
- * Provides access to log entries.
- */
- export module Log {
/**
- * Log entry.
+ * Dispatches a key event to the page.
*/
- export interface LogEntry {
+ export type dispatchKeyEventParameters = {
/**
- * Log entry source.
+ * Type of the key event.
*/
- source: "xml"|"javascript"|"network"|"storage"|"appcache"|"rendering"|"security"|"deprecation"|"worker"|"violation"|"intervention"|"recommendation"|"other";
+ type: "keyDown"|"keyUp"|"rawKeyDown"|"char";
/**
- * Log entry severity.
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
*/
- level: "verbose"|"info"|"warning"|"error";
+ modifiers?: number;
/**
- * Logged text.
+ * Time at which the event occurred.
*/
- text: string;
- category?: "cors";
+ timestamp?: TimeSinceEpoch;
/**
- * Timestamp when this entry was added.
+ * Text as generated by processing a virtual key code with a keyboard layout. Not needed for
+for `keyUp` and `rawKeyDown` events (default: "")
*/
- timestamp: Runtime.Timestamp;
+ text?: string;
/**
- * URL of the resource if known.
+ * Text that would have been generated by the keyboard if no modifiers were pressed (except for
+shift). Useful for shortcut (accelerator) key handling (default: "").
*/
- url?: string;
+ unmodifiedText?: string;
/**
- * Line number in the resource.
+ * Unique key identifier (e.g., 'U+0041') (default: "").
*/
- lineNumber?: number;
+ keyIdentifier?: string;
/**
- * JavaScript stack trace.
+ * Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
*/
- stackTrace?: Runtime.StackTrace;
+ code?: string;
/**
- * Identifier of the network request associated with this entry.
+ * Unique DOM defined string value describing the meaning of the key in the context of active
+modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
*/
- networkRequestId?: Network.RequestId;
+ key?: string;
/**
- * Identifier of the worker associated with this entry.
+ * Windows virtual key code (default: 0).
*/
- workerId?: string;
+ windowsVirtualKeyCode?: number;
/**
- * Call arguments.
+ * Native virtual key code (default: 0).
*/
- args?: Runtime.RemoteObject[];
- }
- /**
- * Violation configuration setting.
- */
- export interface ViolationSetting {
+ nativeVirtualKeyCode?: number;
/**
- * Violation type.
+ * Whether the event was generated from auto repeat (default: false).
*/
- name: "longTask"|"longLayout"|"blockedEvent"|"blockedParser"|"discouragedAPIUse"|"handler"|"recurringHandler";
+ autoRepeat?: boolean;
/**
- * Time threshold to trigger upon.
+ * Whether the event was generated from the keypad (default: false).
*/
- threshold: number;
- }
-
- /**
- * Issued when new message was logged.
- */
- export type entryAddedPayload = {
+ isKeypad?: boolean;
/**
- * The entry.
+ * Whether the event was a system key event (default: false).
*/
- entry: LogEntry;
- }
-
- /**
- * Clears the log.
- */
- export type clearParameters = {
- }
- export type clearReturnValue = {
- }
- /**
- * Disables log domain, prevents further log entries from being reported to the client.
- */
- export type disableParameters = {
+ isSystemKey?: boolean;
+ /**
+ * Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default:
+0).
+ */
+ location?: number;
+ /**
+ * Editing commands to send with the key event (e.g., 'selectAll') (default: []).
+These are related to but not equal the command names used in `document.execCommand` and NSStandardKeyBindingResponding.
+See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.
+ */
+ commands?: string[];
}
- export type disableReturnValue = {
+ export type dispatchKeyEventReturnValue = {
}
/**
- * Enables log domain, sends the entries collected so far to the client by means of the
-`entryAdded` notification.
+ * This method emulates inserting text that doesn't come from a key press,
+for example an emoji keyboard or an IME.
*/
- export type enableParameters = {
+ export type insertTextParameters = {
+ /**
+ * The text to insert.
+ */
+ text: string;
}
- export type enableReturnValue = {
+ export type insertTextReturnValue = {
}
/**
- * start violation reporting.
+ * This method sets the current candidate text for IME.
+Use imeCommitComposition to commit the final text.
+Use imeSetComposition with empty string as text to cancel composition.
*/
- export type startViolationsReportParameters = {
+ export type imeSetCompositionParameters = {
/**
- * Configuration for violations.
+ * The text to insert
*/
- config: ViolationSetting[];
+ text: string;
+ /**
+ * selection start
+ */
+ selectionStart: number;
+ /**
+ * selection end
+ */
+ selectionEnd: number;
+ /**
+ * replacement start
+ */
+ replacementStart?: number;
+ /**
+ * replacement end
+ */
+ replacementEnd?: number;
}
- export type startViolationsReportReturnValue = {
+ export type imeSetCompositionReturnValue = {
}
/**
- * Stop violation reporting.
+ * Dispatches a mouse event to the page.
*/
- export type stopViolationsReportParameters = {
- }
- export type stopViolationsReportReturnValue = {
- }
- }
-
- export module Memory {
- /**
- * Memory pressure level.
- */
- export type PressureLevel = "moderate"|"critical";
- /**
- * Heap profile sample.
- */
- export interface SamplingProfileNode {
+ export type dispatchMouseEventParameters = {
/**
- * Size of the sampled allocation.
+ * Type of the mouse event.
*/
- size: number;
+ type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
/**
- * Total bytes attributed to this sample.
+ * X coordinate of the event relative to the main frame's viewport in CSS pixels.
*/
- total: number;
+ x: number;
/**
- * Execution stack at the point of allocation.
+ * Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to
+the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
*/
- stack: string[];
- }
- /**
- * Array of heap profile samples.
- */
- export interface SamplingProfile {
- samples: SamplingProfileNode[];
- modules: Module[];
- }
- /**
- * Executable module information
- */
- export interface Module {
+ y: number;
/**
- * Name of the module.
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
*/
- name: string;
+ modifiers?: number;
/**
- * UUID of the module.
+ * Time at which the event occurred.
*/
- uuid: string;
+ timestamp?: TimeSinceEpoch;
/**
- * Base address where the module is loaded into memory. Encoded as a decimal
-or hexadecimal (0x prefixed) string.
+ * Mouse button (default: "none").
*/
- baseAddress: string;
+ button?: MouseButton;
/**
- * Size of the module in bytes.
+ * A number indicating which buttons are pressed on the mouse when a mouse event is triggered.
+Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
*/
- size: number;
- }
- /**
- * DOM object counter data.
- */
- export interface DOMCounter {
+ buttons?: number;
/**
- * Object name. Note: object names should be presumed volatile and clients should not expect
-the returned names to be consistent across runs.
+ * Number of times the mouse button was clicked (default: 0).
*/
- name: string;
+ clickCount?: number;
/**
- * Object count.
+ * The normalized pressure, which has a range of [0,1] (default: 0).
*/
- count: number;
- }
-
-
- /**
- * Retruns current DOM object counters.
- */
- export type getDOMCountersParameters = {
+ force?: number;
+ /**
+ * The normalized tangential pressure, which has a range of [-1,1] (default: 0).
+ */
+ tangentialPressure?: number;
+ /**
+ * The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
+ */
+ tiltX?: number;
+ /**
+ * The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
+ */
+ tiltY?: number;
+ /**
+ * The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
+ */
+ twist?: number;
+ /**
+ * X delta in CSS pixels for mouse wheel event (default: 0).
+ */
+ deltaX?: number;
+ /**
+ * Y delta in CSS pixels for mouse wheel event (default: 0).
+ */
+ deltaY?: number;
+ /**
+ * Pointer type (default: "mouse").
+ */
+ pointerType?: "mouse"|"pen";
}
- export type getDOMCountersReturnValue = {
- documents: number;
- nodes: number;
- jsEventListeners: number;
+ export type dispatchMouseEventReturnValue = {
}
/**
- * Retruns DOM object counters after preparing renderer for leak detection.
+ * Dispatches a touch event to the page.
*/
- export type getDOMCountersForLeakDetectionParameters = {
- }
- export type getDOMCountersForLeakDetectionReturnValue = {
+ export type dispatchTouchEventParameters = {
/**
- * DOM object counters.
+ * Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while
+TouchStart and TouchMove must contains at least one.
*/
- counters: DOMCounter[];
- }
- /**
- * Prepares for leak detection by terminating workers, stopping spellcheckers,
-dropping non-essential internal caches, running garbage collections, etc.
- */
- export type prepareForLeakDetectionParameters = {
+ type: "touchStart"|"touchEnd"|"touchMove"|"touchCancel";
+ /**
+ * Active touch points on the touch device. One event per any changed point (compared to
+previous touch event in a sequence) is generated, emulating pressing/moving/releasing points
+one by one.
+ */
+ touchPoints: TouchPoint[];
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ /**
+ * Time at which the event occurred.
+ */
+ timestamp?: TimeSinceEpoch;
}
- export type prepareForLeakDetectionReturnValue = {
+ export type dispatchTouchEventReturnValue = {
}
/**
- * Simulate OomIntervention by purging V8 memory.
+ * Cancels any active dragging in the page.
*/
- export type forciblyPurgeJavaScriptMemoryParameters = {
+ export type cancelDraggingParameters = {
}
- export type forciblyPurgeJavaScriptMemoryReturnValue = {
+ export type cancelDraggingReturnValue = {
}
/**
- * Enable/disable suppressing memory pressure notifications in all processes.
+ * Emulates touch event from the mouse event parameters.
*/
- export type setPressureNotificationsSuppressedParameters = {
+ export type emulateTouchFromMouseEventParameters = {
/**
- * If true, memory pressure notifications will be suppressed.
+ * Type of the mouse event.
*/
- suppressed: boolean;
- }
- export type setPressureNotificationsSuppressedReturnValue = {
- }
- /**
- * Simulate a memory pressure notification in all processes.
- */
- export type simulatePressureNotificationParameters = {
+ type: "mousePressed"|"mouseReleased"|"mouseMoved"|"mouseWheel";
/**
- * Memory pressure level of the notification.
+ * X coordinate of the mouse pointer in DIP.
*/
- level: PressureLevel;
+ x: number;
+ /**
+ * Y coordinate of the mouse pointer in DIP.
+ */
+ y: number;
+ /**
+ * Mouse button. Only "none", "left", "right" are supported.
+ */
+ button: MouseButton;
+ /**
+ * Time at which the event occurred (default: current time).
+ */
+ timestamp?: TimeSinceEpoch;
+ /**
+ * X delta in DIP for mouse wheel event (default: 0).
+ */
+ deltaX?: number;
+ /**
+ * Y delta in DIP for mouse wheel event (default: 0).
+ */
+ deltaY?: number;
+ /**
+ * Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8
+(default: 0).
+ */
+ modifiers?: number;
+ /**
+ * Number of times the mouse button was clicked (default: 0).
+ */
+ clickCount?: number;
}
- export type simulatePressureNotificationReturnValue = {
+ export type emulateTouchFromMouseEventReturnValue = {
}
/**
- * Start collecting native memory profile.
+ * Ignores input events (useful while auditing page).
*/
- export type startSamplingParameters = {
- /**
- * Average number of bytes between samples.
- */
- samplingInterval?: number;
+ export type setIgnoreInputEventsParameters = {
/**
- * Do not randomize intervals between samples.
+ * Ignores input events processing when set to true.
*/
- suppressRandomness?: boolean;
+ ignore: boolean;
}
- export type startSamplingReturnValue = {
+ export type setIgnoreInputEventsReturnValue = {
}
/**
- * Stop collecting native memory profile.
+ * Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events.
+Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`.
*/
- export type stopSamplingParameters = {
+ export type setInterceptDragsParameters = {
+ enabled: boolean;
}
- export type stopSamplingReturnValue = {
+ export type setInterceptDragsReturnValue = {
}
/**
- * Retrieve native memory allocations profile
-collected since renderer process startup.
+ * Synthesizes a pinch gesture over a time period by issuing appropriate touch events.
*/
- export type getAllTimeSamplingProfileParameters = {
+ export type synthesizePinchGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * Relative scale factor after zooming (>1.0 zooms in, <1.0 zooms out).
+ */
+ scaleFactor: number;
+ /**
+ * Relative pointer speed in pixels per second (default: 800).
+ */
+ relativeSpeed?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
}
- export type getAllTimeSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizePinchGestureReturnValue = {
}
/**
- * Retrieve native memory allocations profile
-collected since browser process startup.
+ * Synthesizes a scroll gesture over a time period by issuing appropriate touch events.
*/
- export type getBrowserSamplingProfileParameters = {
+ export type synthesizeScrollGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * The distance to scroll along the X axis (positive to scroll left).
+ */
+ xDistance?: number;
+ /**
+ * The distance to scroll along the Y axis (positive to scroll up).
+ */
+ yDistance?: number;
+ /**
+ * The number of additional pixels to scroll back along the X axis, in addition to the given
+distance.
+ */
+ xOverscroll?: number;
+ /**
+ * The number of additional pixels to scroll back along the Y axis, in addition to the given
+distance.
+ */
+ yOverscroll?: number;
+ /**
+ * Prevent fling (default: true).
+ */
+ preventFling?: boolean;
+ /**
+ * Swipe speed in pixels per second (default: 800).
+ */
+ speed?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
+ /**
+ * The number of times to repeat the gesture (default: 0).
+ */
+ repeatCount?: number;
+ /**
+ * The number of milliseconds delay between each repeat. (default: 250).
+ */
+ repeatDelayMs?: number;
+ /**
+ * The name of the interaction markers to generate, if not empty (default: "").
+ */
+ interactionMarkerName?: string;
}
- export type getBrowserSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizeScrollGestureReturnValue = {
}
/**
- * Retrieve native memory allocations profile collected since last
-`startSampling` call.
+ * Synthesizes a tap gesture over a time period by issuing appropriate touch events.
*/
- export type getSamplingProfileParameters = {
+ export type synthesizeTapGestureParameters = {
+ /**
+ * X coordinate of the start of the gesture in CSS pixels.
+ */
+ x: number;
+ /**
+ * Y coordinate of the start of the gesture in CSS pixels.
+ */
+ y: number;
+ /**
+ * Duration between touchdown and touchup events in ms (default: 50).
+ */
+ duration?: number;
+ /**
+ * Number of times to perform the tap (e.g. 2 for double tap, default: 1).
+ */
+ tapCount?: number;
+ /**
+ * Which type of input events to be generated (default: 'default', which queries the platform
+for the preferred input type).
+ */
+ gestureSourceType?: GestureSourceType;
}
- export type getSamplingProfileReturnValue = {
- profile: SamplingProfile;
+ export type synthesizeTapGestureReturnValue = {
}
}
- /**
- * Network domain allows tracking network activities of the page. It exposes information about http,
-file, data and other requests and responses, their headers, bodies, timing, etc.
- */
- export module Network {
- /**
- * Resource type as it was perceived by the rendering engine.
- */
- export type ResourceType = "Document"|"Stylesheet"|"Image"|"Media"|"Font"|"Script"|"TextTrack"|"XHR"|"Fetch"|"Prefetch"|"EventSource"|"WebSocket"|"Manifest"|"SignedExchange"|"Ping"|"CSPViolationReport"|"Preflight"|"FedCM"|"Other";
- /**
- * Unique loader identifier.
- */
- export type LoaderId = string;
- /**
- * Unique network request identifier.
-Note that this does not identify individual HTTP requests that are part of
-a network request.
- */
- export type RequestId = string;
- /**
- * Unique intercepted request identifier.
- */
- export type InterceptionId = string;
- /**
- * Network level fetch failure reason.
- */
- export type ErrorReason = "Failed"|"Aborted"|"TimedOut"|"AccessDenied"|"ConnectionClosed"|"ConnectionReset"|"ConnectionRefused"|"ConnectionAborted"|"ConnectionFailed"|"NameNotResolved"|"InternetDisconnected"|"AddressUnreachable"|"BlockedByClient"|"BlockedByResponse";
+ export module Inspector {
+
/**
- * UTC time in seconds, counted from January 1, 1970.
+ * Fired when remote debugging connection is about to be terminated. Contains detach reason.
*/
- export type TimeSinceEpoch = number;
+ export type detachedPayload = {
+ /**
+ * The reason why connection has been terminated.
+ */
+ reason: string;
+ }
/**
- * Monotonically increasing time in seconds since an arbitrary point in the past.
+ * Fired when debugging target has crashed
*/
- export type MonotonicTime = number;
+ export type targetCrashedPayload = void;
/**
- * Request / response headers as keys / values of JSON object.
+ * Fired when debugging target has reloaded after crash
*/
- export type Headers = { [key: string]: string };
+ export type targetReloadedAfterCrashPayload = void;
+
/**
- * The underlying connection technology that the browser is supposedly using.
+ * Disables inspector domain notifications.
*/
- export type ConnectionType = "none"|"cellular2g"|"cellular3g"|"cellular4g"|"bluetooth"|"ethernet"|"wifi"|"wimax"|"other";
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
/**
- * Represents the cookie's 'SameSite' status:
-https://tools.ietf.org/html/draft-west-first-party-cookies
+ * Enables inspector domain notifications.
*/
- export type CookieSameSite = "Strict"|"Lax"|"None";
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ }
+
+ export module LayerTree {
/**
- * Represents the cookie's 'Priority' status:
-https://tools.ietf.org/html/draft-west-cookie-priority-00
+ * Unique Layer identifier.
*/
- export type CookiePriority = "Low"|"Medium"|"High";
+ export type LayerId = string;
/**
- * Represents the source scheme of the origin that originally set the cookie.
-A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
-This is a temporary ability and it will be removed in the future.
+ * Unique snapshot identifier.
*/
- export type CookieSourceScheme = "Unset"|"NonSecure"|"Secure";
+ export type SnapshotId = string;
/**
- * Timing information for the request.
+ * Rectangle where scrolling happens on the main thread.
*/
- export interface ResourceTiming {
+ export interface ScrollRect {
/**
- * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
-milliseconds relatively to this requestTime.
+ * Rectangle itself.
*/
- requestTime: number;
+ rect: DOM.Rect;
/**
- * Started resolving proxy.
+ * Reason for rectangle to force scrolling on the main thread
*/
- proxyStart: number;
+ type: "RepaintsOnScroll"|"TouchEventHandler"|"WheelEventHandler";
+ }
+ /**
+ * Sticky position constraints.
+ */
+ export interface StickyPositionConstraint {
/**
- * Finished resolving proxy.
+ * Layout rectangle of the sticky element before being shifted
*/
- proxyEnd: number;
+ stickyBoxRect: DOM.Rect;
/**
- * Started DNS address resolve.
+ * Layout rectangle of the containing block of the sticky element
*/
- dnsStart: number;
+ containingBlockRect: DOM.Rect;
/**
- * Finished DNS address resolve.
+ * The nearest sticky layer that shifts the sticky box
*/
- dnsEnd: number;
+ nearestLayerShiftingStickyBox?: LayerId;
/**
- * Started connecting to the remote host.
+ * The nearest sticky layer that shifts the containing block
*/
- connectStart: number;
+ nearestLayerShiftingContainingBlock?: LayerId;
+ }
+ /**
+ * Serialized fragment of layer picture along with its offset within the layer.
+ */
+ export interface PictureTile {
/**
- * Connected to the remote host.
+ * Offset from owning layer left boundary
*/
- connectEnd: number;
+ x: number;
/**
- * Started SSL handshake.
+ * Offset from owning layer top boundary
*/
- sslStart: number;
+ y: number;
/**
- * Finished SSL handshake.
+ * Base64-encoded snapshot data.
*/
- sslEnd: number;
+ picture: binary;
+ }
+ /**
+ * Information about a compositing layer.
+ */
+ export interface Layer {
/**
- * Started running ServiceWorker.
+ * The unique id for this layer.
*/
- workerStart: number;
+ layerId: LayerId;
/**
- * Finished Starting ServiceWorker.
+ * The id of parent (not present for root).
*/
- workerReady: number;
+ parentLayerId?: LayerId;
/**
- * Started fetch event.
+ * The backend id for the node associated with this layer.
*/
- workerFetchStart: number;
+ backendNodeId?: DOM.BackendNodeId;
/**
- * Settled fetch event respondWith promise.
+ * Offset from parent layer, X coordinate.
*/
- workerRespondWithSettled: number;
+ offsetX: number;
/**
- * Started ServiceWorker static routing source evaluation.
+ * Offset from parent layer, Y coordinate.
*/
- workerRouterEvaluationStart?: number;
+ offsetY: number;
/**
- * Started cache lookup when the source was evaluated to `cache`.
+ * Layer width.
*/
- workerCacheLookupStart?: number;
+ width: number;
/**
- * Started sending request.
+ * Layer height.
*/
- sendStart: number;
+ height: number;
/**
- * Finished sending request.
+ * Transformation matrix for layer, default is identity matrix
*/
- sendEnd: number;
+ transform?: number[];
/**
- * Time the server started pushing request.
+ * Transform anchor point X, absent if no transform specified
*/
- pushStart: number;
+ anchorX?: number;
/**
- * Time the server finished pushing request.
+ * Transform anchor point Y, absent if no transform specified
*/
- pushEnd: number;
- /**
- * Started receiving response headers.
- */
- receiveHeadersStart: number;
+ anchorY?: number;
/**
- * Finished receiving response headers.
+ * Transform anchor point Z, absent if no transform specified
*/
- receiveHeadersEnd: number;
- }
- /**
- * Loading priority of a resource request.
- */
- export type ResourcePriority = "VeryLow"|"Low"|"Medium"|"High"|"VeryHigh";
- /**
- * Post data entry for HTTP request
- */
- export interface PostDataEntry {
- bytes?: binary;
- }
- /**
- * HTTP request data.
- */
- export interface Request {
+ anchorZ?: number;
/**
- * Request URL (without fragment).
+ * Indicates how many time this layer has painted.
*/
- url: string;
+ paintCount: number;
/**
- * Fragment of the requested URL starting with hash, if present.
+ * Indicates whether this layer hosts any content, rather than being used for
+transform/scrolling purposes only.
*/
- urlFragment?: string;
+ drawsContent: boolean;
/**
- * HTTP request method.
+ * Set if layer is not visible.
*/
- method: string;
+ invisible?: boolean;
/**
- * HTTP request headers.
+ * Rectangles scrolling on main thread only.
*/
- headers: Headers;
+ scrollRects?: ScrollRect[];
/**
- * HTTP POST request data.
-Use postDataEntries instead.
+ * Sticky position constraint information
*/
- postData?: string;
+ stickyPositionConstraint?: StickyPositionConstraint;
+ }
+ /**
+ * Array of timings, one per paint step.
+ */
+ export type PaintProfile = number[];
+
+ export type layerPaintedPayload = {
/**
- * True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.
+ * The id of the painted layer.
*/
- hasPostData?: boolean;
+ layerId: LayerId;
/**
- * Request body elements (post data broken into individual entries).
+ * Clip rectangle.
*/
- postDataEntries?: PostDataEntry[];
+ clip: DOM.Rect;
+ }
+ export type layerTreeDidChangePayload = {
/**
- * The mixed content type of the request.
+ * Layer tree, absent if not in the compositing mode.
*/
- mixedContentType?: Security.MixedContentType;
+ layers?: Layer[];
+ }
+
+ /**
+ * Provides the reasons why the given layer was composited.
+ */
+ export type compositingReasonsParameters = {
/**
- * Priority of the resource request at the time request is sent.
+ * The id of the layer for which we want to get the reasons it was composited.
*/
- initialPriority: ResourcePriority;
+ layerId: LayerId;
+ }
+ export type compositingReasonsReturnValue = {
/**
- * The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
+ * A list of strings specifying reasons for the given layer to become composited.
*/
- referrerPolicy: "unsafe-url"|"no-referrer-when-downgrade"|"no-referrer"|"origin"|"origin-when-cross-origin"|"same-origin"|"strict-origin"|"strict-origin-when-cross-origin";
+ compositingReasons: string[];
/**
- * Whether is loaded via link preload.
+ * A list of strings specifying reason IDs for the given layer to become composited.
*/
- isLinkPreload?: boolean;
+ compositingReasonIds: string[];
+ }
+ /**
+ * Disables compositing tree inspection.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Enables compositing tree inspection.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Returns the snapshot identifier.
+ */
+ export type loadSnapshotParameters = {
/**
- * Set for requests when the TrustToken API is used. Contains the parameters
-passed by the developer (e.g. via "fetch") as understood by the backend.
+ * An array of tiles composing the snapshot.
*/
- trustTokenParams?: TrustTokenParams;
+ tiles: PictureTile[];
+ }
+ export type loadSnapshotReturnValue = {
/**
- * True if this resource request is considered to be the 'same site' as the
-request corresponding to the main frame.
+ * The id of the snapshot.
*/
- isSameSite?: boolean;
+ snapshotId: SnapshotId;
}
/**
- * Details of a signed certificate timestamp (SCT).
+ * Returns the layer snapshot identifier.
*/
- export interface SignedCertificateTimestamp {
+ export type makeSnapshotParameters = {
/**
- * Validation status.
+ * The id of the layer.
*/
- status: string;
+ layerId: LayerId;
+ }
+ export type makeSnapshotReturnValue = {
/**
- * Origin.
+ * The id of the layer snapshot.
*/
- origin: string;
+ snapshotId: SnapshotId;
+ }
+ export type profileSnapshotParameters = {
/**
- * Log name / description.
+ * The id of the layer snapshot.
*/
- logDescription: string;
+ snapshotId: SnapshotId;
/**
- * Log ID.
+ * The maximum number of times to replay the snapshot (1, if not specified).
*/
- logId: string;
+ minRepeatCount?: number;
/**
- * Issuance date. Unlike TimeSinceEpoch, this contains the number of
-milliseconds since January 1, 1970, UTC, not the number of seconds.
+ * The minimum duration (in seconds) to replay the snapshot.
*/
- timestamp: number;
+ minDuration?: number;
/**
- * Hash algorithm.
+ * The clip rectangle to apply when replaying the snapshot.
*/
- hashAlgorithm: string;
+ clipRect?: DOM.Rect;
+ }
+ export type profileSnapshotReturnValue = {
/**
- * Signature algorithm.
+ * The array of paint profiles, one per run.
*/
- signatureAlgorithm: string;
+ timings: PaintProfile[];
+ }
+ /**
+ * Releases layer snapshot captured by the back-end.
+ */
+ export type releaseSnapshotParameters = {
/**
- * Signature data.
+ * The id of the layer snapshot.
*/
- signatureData: string;
+ snapshotId: SnapshotId;
+ }
+ export type releaseSnapshotReturnValue = {
}
/**
- * Security details about a request.
+ * Replays the layer snapshot and returns the resulting bitmap.
*/
- export interface SecurityDetails {
+ export type replaySnapshotParameters = {
/**
- * Protocol name (e.g. "TLS 1.2" or "QUIC").
+ * The id of the layer snapshot.
*/
- protocol: string;
+ snapshotId: SnapshotId;
/**
- * Key Exchange used by the connection, or the empty string if not applicable.
+ * The first step to replay from (replay from the very start if not specified).
*/
- keyExchange: string;
+ fromStep?: number;
/**
- * (EC)DH group used by the connection, if applicable.
+ * The last step to replay to (replay till the end if not specified).
*/
- keyExchangeGroup?: string;
+ toStep?: number;
/**
- * Cipher name.
+ * The scale to apply while replaying (defaults to 1).
*/
- cipher: string;
+ scale?: number;
+ }
+ export type replaySnapshotReturnValue = {
/**
- * TLS MAC. Note that AEAD ciphers do not have separate MACs.
+ * A data: URL for resulting image.
*/
- mac?: string;
+ dataURL: string;
+ }
+ /**
+ * Replays the layer snapshot and returns canvas log.
+ */
+ export type snapshotCommandLogParameters = {
/**
- * Certificate ID value.
+ * The id of the layer snapshot.
*/
- certificateId: Security.CertificateId;
+ snapshotId: SnapshotId;
+ }
+ export type snapshotCommandLogReturnValue = {
/**
- * Certificate subject name.
+ * The array of canvas function calls.
*/
- subjectName: string;
+ commandLog: { [key: string]: string }[];
+ }
+ }
+
+ /**
+ * Provides access to log entries.
+ */
+ export module Log {
+ /**
+ * Log entry.
+ */
+ export interface LogEntry {
/**
- * Subject Alternative Name (SAN) DNS names and IP addresses.
+ * Log entry source.
*/
- sanList: string[];
+ source: "xml"|"javascript"|"network"|"storage"|"appcache"|"rendering"|"security"|"deprecation"|"worker"|"violation"|"intervention"|"recommendation"|"other";
/**
- * Name of the issuing CA.
+ * Log entry severity.
*/
- issuer: string;
+ level: "verbose"|"info"|"warning"|"error";
/**
- * Certificate valid from date.
+ * Logged text.
*/
- validFrom: TimeSinceEpoch;
+ text: string;
+ category?: "cors";
/**
- * Certificate valid to (expiration) date
+ * Timestamp when this entry was added.
*/
- validTo: TimeSinceEpoch;
+ timestamp: Runtime.Timestamp;
/**
- * List of signed certificate timestamps (SCTs).
+ * URL of the resource if known.
*/
- signedCertificateTimestampList: SignedCertificateTimestamp[];
+ url?: string;
/**
- * Whether the request complied with Certificate Transparency policy
+ * Line number in the resource.
*/
- certificateTransparencyCompliance: CertificateTransparencyCompliance;
+ lineNumber?: number;
/**
- * The signature algorithm used by the server in the TLS server signature,
-represented as a TLS SignatureScheme code point. Omitted if not
-applicable or not known.
+ * JavaScript stack trace.
*/
- serverSignatureAlgorithm?: number;
+ stackTrace?: Runtime.StackTrace;
/**
- * Whether the connection used Encrypted ClientHello
+ * Identifier of the network request associated with this entry.
*/
- encryptedClientHello: boolean;
- }
- /**
- * Whether the request complied with Certificate Transparency policy.
+ networkRequestId?: Network.RequestId;
+ /**
+ * Identifier of the worker associated with this entry.
+ */
+ workerId?: string;
+ /**
+ * Call arguments.
+ */
+ args?: Runtime.RemoteObject[];
+ }
+ /**
+ * Violation configuration setting.
*/
- export type CertificateTransparencyCompliance = "unknown"|"not-compliant"|"compliant";
+ export interface ViolationSetting {
+ /**
+ * Violation type.
+ */
+ name: "longTask"|"longLayout"|"blockedEvent"|"blockedParser"|"discouragedAPIUse"|"handler"|"recurringHandler";
+ /**
+ * Time threshold to trigger upon.
+ */
+ threshold: number;
+ }
+
/**
- * The reason why request was blocked.
+ * Issued when new message was logged.
*/
- export type BlockedReason = "other"|"csp"|"mixed-content"|"origin"|"inspector"|"integrity"|"subresource-filter"|"content-type"|"coep-frame-resource-needs-coep-header"|"coop-sandboxed-iframe-cannot-navigate-to-coop-page"|"corp-not-same-origin"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep"|"corp-not-same-origin-after-defaulted-to-same-origin-by-dip"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep-and-dip"|"corp-not-same-site"|"sri-message-signature-mismatch";
+ export type entryAddedPayload = {
+ /**
+ * The entry.
+ */
+ entry: LogEntry;
+ }
+
/**
- * The reason why request was blocked.
+ * Clears the log.
*/
- export type CorsError = "DisallowedByMode"|"InvalidResponse"|"WildcardOriginNotAllowed"|"MissingAllowOriginHeader"|"MultipleAllowOriginValues"|"InvalidAllowOriginValue"|"AllowOriginMismatch"|"InvalidAllowCredentials"|"CorsDisabledScheme"|"PreflightInvalidStatus"|"PreflightDisallowedRedirect"|"PreflightWildcardOriginNotAllowed"|"PreflightMissingAllowOriginHeader"|"PreflightMultipleAllowOriginValues"|"PreflightInvalidAllowOriginValue"|"PreflightAllowOriginMismatch"|"PreflightInvalidAllowCredentials"|"PreflightMissingAllowExternal"|"PreflightInvalidAllowExternal"|"PreflightMissingAllowPrivateNetwork"|"PreflightInvalidAllowPrivateNetwork"|"InvalidAllowMethodsPreflightResponse"|"InvalidAllowHeadersPreflightResponse"|"MethodDisallowedByPreflightResponse"|"HeaderDisallowedByPreflightResponse"|"RedirectContainsCredentials"|"InsecurePrivateNetwork"|"InvalidPrivateNetworkAccess"|"UnexpectedPrivateNetworkAccess"|"NoCorsRedirectModeNotFollow"|"PreflightMissingPrivateNetworkAccessId"|"PreflightMissingPrivateNetworkAccessName"|"PrivateNetworkAccessPermissionUnavailable"|"PrivateNetworkAccessPermissionDenied"|"LocalNetworkAccessPermissionDenied";
- export interface CorsErrorStatus {
- corsError: CorsError;
- failedParameter: string;
+ export type clearParameters = {
+ }
+ export type clearReturnValue = {
}
/**
- * Source of serviceworker response.
+ * Disables log domain, prevents further log entries from being reported to the client.
*/
- export type ServiceWorkerResponseSource = "cache-storage"|"http-cache"|"fallback-code"|"network";
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
/**
- * Determines what type of Trust Token operation is executed and
-depending on the type, some additional parameters. The values
-are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
+ * Enables log domain, sends the entries collected so far to the client by means of the
+`entryAdded` notification.
*/
- export interface TrustTokenParams {
- operation: TrustTokenOperationType;
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * start violation reporting.
+ */
+ export type startViolationsReportParameters = {
/**
- * Only set for "token-redemption" operation and determine whether
-to request a fresh SRR or use a still valid cached SRR.
+ * Configuration for violations.
*/
- refreshPolicy: "UseCached"|"Refresh";
+ config: ViolationSetting[];
+ }
+ export type startViolationsReportReturnValue = {
+ }
+ /**
+ * Stop violation reporting.
+ */
+ export type stopViolationsReportParameters = {
+ }
+ export type stopViolationsReportReturnValue = {
+ }
+ }
+
+ /**
+ * This domain allows detailed inspection of media elements.
+ */
+ export module Media {
+ /**
+ * Players will get an ID that is unique within the agent context.
+ */
+ export type PlayerId = string;
+ export type Timestamp = number;
+ /**
+ * Have one type per entry in MediaLogRecord::Type
+Corresponds to kMessage
+ */
+ export interface PlayerMessage {
/**
- * Origins of issuers from whom to request tokens or redemption
-records.
+ * Keep in sync with MediaLogMessageLevel
+We are currently keeping the message level 'error' separate from the
+PlayerError type because right now they represent different things,
+this one being a DVLOG(ERROR) style log message that gets printed
+based on what log level is selected in the UI, and the other is a
+representation of a media::PipelineStatus object. Soon however we're
+going to be moving away from using PipelineStatus for errors and
+introducing a new error type which should hopefully let us integrate
+the error log level into the PlayerError type.
*/
- issuers?: string[];
+ level: "error"|"warning"|"info"|"debug";
+ message: string;
}
- export type TrustTokenOperationType = "Issuance"|"Redemption"|"Signing";
/**
- * The reason why Chrome uses a specific transport protocol for HTTP semantics.
+ * Corresponds to kMediaPropertyChange
*/
- export type AlternateProtocolUsage = "alternativeJobWonWithoutRace"|"alternativeJobWonRace"|"mainJobWonRace"|"mappingMissing"|"broken"|"dnsAlpnH3JobWonWithoutRace"|"dnsAlpnH3JobWonRace"|"unspecifiedReason";
+ export interface PlayerProperty {
+ name: string;
+ value: string;
+ }
/**
- * Source of service worker router.
+ * Corresponds to kMediaEventTriggered
*/
- export type ServiceWorkerRouterSource = "network"|"cache"|"fetch-event"|"race-network-and-fetch-handler"|"race-network-and-cache";
- export interface ServiceWorkerRouterInfo {
+ export interface PlayerEvent {
+ timestamp: Timestamp;
+ value: string;
+ }
+ /**
+ * Represents logged source line numbers reported in an error.
+NOTE: file and line are from chromium c++ implementation code, not js.
+ */
+ export interface PlayerErrorSourceLocation {
+ file: string;
+ line: number;
+ }
+ /**
+ * Corresponds to kMediaError
+ */
+ export interface PlayerError {
+ errorType: string;
/**
- * ID of the rule matched. If there is a matched rule, this field will
-be set, otherwiser no value will be set.
+ * Code is the numeric enum entry for a specific set of error codes, such
+as PipelineStatusCodes in media/base/pipeline_status.h
*/
- ruleIdMatched?: number;
+ code: number;
/**
- * The router source of the matched rule. If there is a matched rule, this
-field will be set, otherwise no value will be set.
+ * A trace of where this error was caused / where it passed through.
*/
- matchedSourceType?: ServiceWorkerRouterSource;
+ stack: PlayerErrorSourceLocation[];
/**
- * The actual router source used.
+ * Errors potentially have a root cause error, ie, a DecoderError might be
+caused by an WindowsError
*/
- actualSourceType?: ServiceWorkerRouterSource;
+ cause: PlayerError[];
+ /**
+ * Extra data attached to an error, such as an HRESULT, Video Codec, etc.
+ */
+ data: { [key: string]: string };
+ }
+ export interface Player {
+ playerId: PlayerId;
+ domNodeId?: DOM.BackendNodeId;
}
+
/**
- * HTTP response data.
+ * This can be called multiple times, and can be used to set / override /
+remove player properties. A null propValue indicates removal.
*/
- export interface Response {
+ export type playerPropertiesChangedPayload = {
+ playerId: PlayerId;
+ properties: PlayerProperty[];
+ }
+ /**
+ * Send events as a list, allowing them to be batched on the browser for less
+congestion. If batched, events must ALWAYS be in chronological order.
+ */
+ export type playerEventsAddedPayload = {
+ playerId: PlayerId;
+ events: PlayerEvent[];
+ }
+ /**
+ * Send a list of any messages that need to be delivered.
+ */
+ export type playerMessagesLoggedPayload = {
+ playerId: PlayerId;
+ messages: PlayerMessage[];
+ }
+ /**
+ * Send a list of any errors that need to be delivered.
+ */
+ export type playerErrorsRaisedPayload = {
+ playerId: PlayerId;
+ errors: PlayerError[];
+ }
+ /**
+ * Called whenever a player is created, or when a new agent joins and receives
+a list of active players. If an agent is restored, it will receive one
+event for each active player.
+ */
+ export type playerCreatedPayload = {
+ player: Player;
+ }
+
+ /**
+ * Enables the Media domain
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disables the Media domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ }
+
+ export module Memory {
+ /**
+ * Memory pressure level.
+ */
+ export type PressureLevel = "moderate"|"critical";
+ /**
+ * Heap profile sample.
+ */
+ export interface SamplingProfileNode {
/**
- * Response URL. This URL can be different from CachedResource.url in case of redirect.
+ * Size of the sampled allocation.
*/
- url: string;
+ size: number;
/**
- * HTTP response status code.
+ * Total bytes attributed to this sample.
*/
- status: number;
+ total: number;
/**
- * HTTP response status text.
+ * Execution stack at the point of allocation.
*/
- statusText: string;
+ stack: string[];
+ }
+ /**
+ * Array of heap profile samples.
+ */
+ export interface SamplingProfile {
+ samples: SamplingProfileNode[];
+ modules: Module[];
+ }
+ /**
+ * Executable module information
+ */
+ export interface Module {
/**
- * HTTP response headers.
+ * Name of the module.
*/
- headers: Headers;
+ name: string;
/**
- * HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
+ * UUID of the module.
*/
- headersText?: string;
+ uuid: string;
/**
- * Resource mimeType as determined by the browser.
- */
- mimeType: string;
- /**
- * Resource charset as determined by the browser (if applicable).
+ * Base address where the module is loaded into memory. Encoded as a decimal
+or hexadecimal (0x prefixed) string.
*/
- charset: string;
+ baseAddress: string;
/**
- * Refined HTTP request headers that were actually transmitted over the network.
+ * Size of the module in bytes.
*/
- requestHeaders?: Headers;
+ size: number;
+ }
+ /**
+ * DOM object counter data.
+ */
+ export interface DOMCounter {
/**
- * HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
+ * Object name. Note: object names should be presumed volatile and clients should not expect
+the returned names to be consistent across runs.
*/
- requestHeadersText?: string;
+ name: string;
/**
- * Specifies whether physical connection was actually reused for this request.
+ * Object count.
*/
- connectionReused: boolean;
+ count: number;
+ }
+
+
+ /**
+ * Retruns current DOM object counters.
+ */
+ export type getDOMCountersParameters = {
+ }
+ export type getDOMCountersReturnValue = {
+ documents: number;
+ nodes: number;
+ jsEventListeners: number;
+ }
+ /**
+ * Retruns DOM object counters after preparing renderer for leak detection.
+ */
+ export type getDOMCountersForLeakDetectionParameters = {
+ }
+ export type getDOMCountersForLeakDetectionReturnValue = {
/**
- * Physical connection id that was actually used for this request.
+ * DOM object counters.
*/
- connectionId: number;
+ counters: DOMCounter[];
+ }
+ /**
+ * Prepares for leak detection by terminating workers, stopping spellcheckers,
+dropping non-essential internal caches, running garbage collections, etc.
+ */
+ export type prepareForLeakDetectionParameters = {
+ }
+ export type prepareForLeakDetectionReturnValue = {
+ }
+ /**
+ * Simulate OomIntervention by purging V8 memory.
+ */
+ export type forciblyPurgeJavaScriptMemoryParameters = {
+ }
+ export type forciblyPurgeJavaScriptMemoryReturnValue = {
+ }
+ /**
+ * Enable/disable suppressing memory pressure notifications in all processes.
+ */
+ export type setPressureNotificationsSuppressedParameters = {
/**
- * Remote IP address.
+ * If true, memory pressure notifications will be suppressed.
*/
- remoteIPAddress?: string;
+ suppressed: boolean;
+ }
+ export type setPressureNotificationsSuppressedReturnValue = {
+ }
+ /**
+ * Simulate a memory pressure notification in all processes.
+ */
+ export type simulatePressureNotificationParameters = {
/**
- * Remote port.
+ * Memory pressure level of the notification.
*/
- remotePort?: number;
+ level: PressureLevel;
+ }
+ export type simulatePressureNotificationReturnValue = {
+ }
+ /**
+ * Start collecting native memory profile.
+ */
+ export type startSamplingParameters = {
/**
- * Specifies that the request was served from the disk cache.
+ * Average number of bytes between samples.
*/
- fromDiskCache?: boolean;
+ samplingInterval?: number;
/**
- * Specifies that the request was served from the ServiceWorker.
+ * Do not randomize intervals between samples.
*/
- fromServiceWorker?: boolean;
+ suppressRandomness?: boolean;
+ }
+ export type startSamplingReturnValue = {
+ }
+ /**
+ * Stop collecting native memory profile.
+ */
+ export type stopSamplingParameters = {
+ }
+ export type stopSamplingReturnValue = {
+ }
+ /**
+ * Retrieve native memory allocations profile
+collected since renderer process startup.
+ */
+ export type getAllTimeSamplingProfileParameters = {
+ }
+ export type getAllTimeSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ /**
+ * Retrieve native memory allocations profile
+collected since browser process startup.
+ */
+ export type getBrowserSamplingProfileParameters = {
+ }
+ export type getBrowserSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ /**
+ * Retrieve native memory allocations profile collected since last
+`startSampling` call.
+ */
+ export type getSamplingProfileParameters = {
+ }
+ export type getSamplingProfileReturnValue = {
+ profile: SamplingProfile;
+ }
+ }
+
+ /**
+ * Network domain allows tracking network activities of the page. It exposes information about http,
+file, data and other requests and responses, their headers, bodies, timing, etc.
+ */
+ export module Network {
+ /**
+ * Resource type as it was perceived by the rendering engine.
+ */
+ export type ResourceType = "Document"|"Stylesheet"|"Image"|"Media"|"Font"|"Script"|"TextTrack"|"XHR"|"Fetch"|"Prefetch"|"EventSource"|"WebSocket"|"Manifest"|"SignedExchange"|"Ping"|"CSPViolationReport"|"Preflight"|"FedCM"|"Other";
+ /**
+ * Unique loader identifier.
+ */
+ export type LoaderId = string;
+ /**
+ * Unique network request identifier.
+Note that this does not identify individual HTTP requests that are part of
+a network request.
+ */
+ export type RequestId = string;
+ /**
+ * Unique intercepted request identifier.
+ */
+ export type InterceptionId = string;
+ /**
+ * Network level fetch failure reason.
+ */
+ export type ErrorReason = "Failed"|"Aborted"|"TimedOut"|"AccessDenied"|"ConnectionClosed"|"ConnectionReset"|"ConnectionRefused"|"ConnectionAborted"|"ConnectionFailed"|"NameNotResolved"|"InternetDisconnected"|"AddressUnreachable"|"BlockedByClient"|"BlockedByResponse";
+ /**
+ * UTC time in seconds, counted from January 1, 1970.
+ */
+ export type TimeSinceEpoch = number;
+ /**
+ * Monotonically increasing time in seconds since an arbitrary point in the past.
+ */
+ export type MonotonicTime = number;
+ /**
+ * Request / response headers as keys / values of JSON object.
+ */
+ export type Headers = { [key: string]: string };
+ /**
+ * The underlying connection technology that the browser is supposedly using.
+ */
+ export type ConnectionType = "none"|"cellular2g"|"cellular3g"|"cellular4g"|"bluetooth"|"ethernet"|"wifi"|"wimax"|"other";
+ /**
+ * Represents the cookie's 'SameSite' status:
+https://tools.ietf.org/html/draft-west-first-party-cookies
+ */
+ export type CookieSameSite = "Strict"|"Lax"|"None";
+ /**
+ * Represents the cookie's 'Priority' status:
+https://tools.ietf.org/html/draft-west-cookie-priority-00
+ */
+ export type CookiePriority = "Low"|"Medium"|"High";
+ /**
+ * Represents the source scheme of the origin that originally set the cookie.
+A value of "Unset" allows protocol clients to emulate legacy cookie scope for the scheme.
+This is a temporary ability and it will be removed in the future.
+ */
+ export type CookieSourceScheme = "Unset"|"NonSecure"|"Secure";
+ /**
+ * Timing information for the request.
+ */
+ export interface ResourceTiming {
/**
- * Specifies that the request was served from the prefetch cache.
+ * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
+milliseconds relatively to this requestTime.
*/
- fromPrefetchCache?: boolean;
+ requestTime: number;
/**
- * Specifies that the request was served from the prefetch cache.
+ * Started resolving proxy.
*/
- fromEarlyHints?: boolean;
+ proxyStart: number;
/**
- * Information about how ServiceWorker Static Router API was used. If this
-field is set with `matchedSourceType` field, a matching rule is found.
-If this field is set without `matchedSource`, no matching rule is found.
-Otherwise, the API is not used.
+ * Finished resolving proxy.
*/
- serviceWorkerRouterInfo?: ServiceWorkerRouterInfo;
+ proxyEnd: number;
/**
- * Total number of bytes received for this request so far.
+ * Started DNS address resolve.
*/
- encodedDataLength: number;
+ dnsStart: number;
/**
- * Timing information for the given request.
+ * Finished DNS address resolve.
*/
- timing?: ResourceTiming;
+ dnsEnd: number;
/**
- * Response source of response from ServiceWorker.
+ * Started connecting to the remote host.
*/
- serviceWorkerResponseSource?: ServiceWorkerResponseSource;
+ connectStart: number;
/**
- * The time at which the returned response was generated.
+ * Connected to the remote host.
*/
- responseTime?: TimeSinceEpoch;
+ connectEnd: number;
/**
- * Cache Storage Cache Name.
+ * Started SSL handshake.
*/
- cacheStorageCacheName?: string;
+ sslStart: number;
/**
- * Protocol used to fetch this request.
+ * Finished SSL handshake.
*/
- protocol?: string;
+ sslEnd: number;
/**
- * The reason why Chrome uses a specific transport protocol for HTTP semantics.
+ * Started running ServiceWorker.
*/
- alternateProtocolUsage?: AlternateProtocolUsage;
+ workerStart: number;
/**
- * Security state of the request resource.
+ * Finished Starting ServiceWorker.
*/
- securityState: Security.SecurityState;
+ workerReady: number;
/**
- * Security details for the request.
+ * Started fetch event.
*/
- securityDetails?: SecurityDetails;
+ workerFetchStart: number;
/**
- * Indicates whether the request was sent through IP Protection proxies. If
-set to true, the request used the IP Protection privacy feature.
+ * Settled fetch event respondWith promise.
*/
- isIpProtectionUsed?: boolean;
+ workerRespondWithSettled: number;
+ /**
+ * Started ServiceWorker static routing source evaluation.
+ */
+ workerRouterEvaluationStart?: number;
+ /**
+ * Started cache lookup when the source was evaluated to `cache`.
+ */
+ workerCacheLookupStart?: number;
+ /**
+ * Started sending request.
+ */
+ sendStart: number;
+ /**
+ * Finished sending request.
+ */
+ sendEnd: number;
+ /**
+ * Time the server started pushing request.
+ */
+ pushStart: number;
+ /**
+ * Time the server finished pushing request.
+ */
+ pushEnd: number;
+ /**
+ * Started receiving response headers.
+ */
+ receiveHeadersStart: number;
+ /**
+ * Finished receiving response headers.
+ */
+ receiveHeadersEnd: number;
}
/**
- * WebSocket request data.
+ * Loading priority of a resource request.
*/
- export interface WebSocketRequest {
- /**
- * HTTP request headers.
- */
- headers: Headers;
+ export type ResourcePriority = "VeryLow"|"Low"|"Medium"|"High"|"VeryHigh";
+ /**
+ * Post data entry for HTTP request
+ */
+ export interface PostDataEntry {
+ bytes?: binary;
}
/**
- * WebSocket response data.
+ * HTTP request data.
*/
- export interface WebSocketResponse {
+ export interface Request {
/**
- * HTTP response status code.
+ * Request URL (without fragment).
*/
- status: number;
+ url: string;
/**
- * HTTP response status text.
+ * Fragment of the requested URL starting with hash, if present.
*/
- statusText: string;
+ urlFragment?: string;
/**
- * HTTP response headers.
+ * HTTP request method.
*/
- headers: Headers;
+ method: string;
/**
- * HTTP response headers text.
+ * HTTP request headers.
*/
- headersText?: string;
+ headers: Headers;
/**
- * HTTP request headers.
+ * HTTP POST request data.
+Use postDataEntries instead.
*/
- requestHeaders?: Headers;
+ postData?: string;
/**
- * HTTP request headers text.
+ * True when the request has POST data. Note that postData might still be omitted when this flag is true when the data is too long.
*/
- requestHeadersText?: string;
- }
- /**
- * WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
- */
- export interface WebSocketFrame {
+ hasPostData?: boolean;
/**
- * WebSocket message opcode.
+ * Request body elements (post data broken into individual entries).
*/
- opcode: number;
+ postDataEntries?: PostDataEntry[];
/**
- * WebSocket message mask.
+ * The mixed content type of the request.
*/
- mask: boolean;
+ mixedContentType?: Security.MixedContentType;
/**
- * WebSocket message payload data.
-If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
-If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
+ * Priority of the resource request at the time request is sent.
*/
- payloadData: string;
- }
- /**
- * Information about the cached resource.
- */
- export interface CachedResource {
+ initialPriority: ResourcePriority;
/**
- * Resource URL. This is the url of the original network request.
+ * The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
*/
- url: string;
+ referrerPolicy: "unsafe-url"|"no-referrer-when-downgrade"|"no-referrer"|"origin"|"origin-when-cross-origin"|"same-origin"|"strict-origin"|"strict-origin-when-cross-origin";
/**
- * Type of this resource.
+ * Whether is loaded via link preload.
*/
- type: ResourceType;
+ isLinkPreload?: boolean;
/**
- * Cached response data.
+ * Set for requests when the TrustToken API is used. Contains the parameters
+passed by the developer (e.g. via "fetch") as understood by the backend.
*/
- response?: Response;
+ trustTokenParams?: TrustTokenParams;
/**
- * Cached response body size.
+ * True if this resource request is considered to be the 'same site' as the
+request corresponding to the main frame.
*/
- bodySize: number;
+ isSameSite?: boolean;
}
/**
- * Information about the request initiator.
+ * Details of a signed certificate timestamp (SCT).
*/
- export interface Initiator {
+ export interface SignedCertificateTimestamp {
/**
- * Type of this initiator.
+ * Validation status.
*/
- type: "parser"|"script"|"preload"|"SignedExchange"|"preflight"|"other";
+ status: string;
/**
- * Initiator JavaScript stack trace, set for Script only.
-Requires the Debugger domain to be enabled.
+ * Origin.
*/
- stack?: Runtime.StackTrace;
+ origin: string;
/**
- * Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
+ * Log name / description.
*/
- url?: string;
+ logDescription: string;
/**
- * Initiator line number, set for Parser type or for Script type (when script is importing
-module) (0-based).
+ * Log ID.
*/
- lineNumber?: number;
+ logId: string;
/**
- * Initiator column number, set for Parser type or for Script type (when script is importing
-module) (0-based).
+ * Issuance date. Unlike TimeSinceEpoch, this contains the number of
+milliseconds since January 1, 1970, UTC, not the number of seconds.
*/
- columnNumber?: number;
+ timestamp: number;
/**
- * Set if another request triggered this request (e.g. preflight).
+ * Hash algorithm.
*/
- requestId?: RequestId;
- }
- /**
- * cookiePartitionKey object
-The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h.
- */
- export interface CookiePartitionKey {
+ hashAlgorithm: string;
/**
- * The site of the top-level URL the browser was visiting at the start
-of the request to the endpoint that set the cookie.
+ * Signature algorithm.
*/
- topLevelSite: string;
+ signatureAlgorithm: string;
/**
- * Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.
+ * Signature data.
*/
- hasCrossSiteAncestor: boolean;
+ signatureData: string;
}
/**
- * Cookie object
+ * Security details about a request.
*/
- export interface Cookie {
- /**
- * Cookie name.
- */
- name: string;
+ export interface SecurityDetails {
/**
- * Cookie value.
+ * Protocol name (e.g. "TLS 1.2" or "QUIC").
*/
- value: string;
+ protocol: string;
/**
- * Cookie domain.
+ * Key Exchange used by the connection, or the empty string if not applicable.
*/
- domain: string;
+ keyExchange: string;
/**
- * Cookie path.
+ * (EC)DH group used by the connection, if applicable.
*/
- path: string;
+ keyExchangeGroup?: string;
/**
- * Cookie expiration date as the number of seconds since the UNIX epoch.
+ * Cipher name.
*/
- expires: number;
+ cipher: string;
/**
- * Cookie size.
+ * TLS MAC. Note that AEAD ciphers do not have separate MACs.
*/
- size: number;
+ mac?: string;
/**
- * True if cookie is http-only.
+ * Certificate ID value.
*/
- httpOnly: boolean;
+ certificateId: Security.CertificateId;
/**
- * True if cookie is secure.
+ * Certificate subject name.
*/
- secure: boolean;
+ subjectName: string;
/**
- * True in case of session cookie.
+ * Subject Alternative Name (SAN) DNS names and IP addresses.
*/
- session: boolean;
+ sanList: string[];
/**
- * Cookie SameSite type.
+ * Name of the issuing CA.
*/
- sameSite?: CookieSameSite;
+ issuer: string;
/**
- * Cookie Priority
+ * Certificate valid from date.
*/
- priority: CookiePriority;
+ validFrom: TimeSinceEpoch;
/**
- * True if cookie is SameParty.
+ * Certificate valid to (expiration) date
*/
- sameParty: boolean;
+ validTo: TimeSinceEpoch;
/**
- * Cookie source scheme type.
+ * List of signed certificate timestamps (SCTs).
*/
- sourceScheme: CookieSourceScheme;
+ signedCertificateTimestampList: SignedCertificateTimestamp[];
/**
- * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
-An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
-This is a temporary ability and it will be removed in the future.
+ * Whether the request complied with Certificate Transparency policy
*/
- sourcePort: number;
+ certificateTransparencyCompliance: CertificateTransparencyCompliance;
/**
- * Cookie partition key.
+ * The signature algorithm used by the server in the TLS server signature,
+represented as a TLS SignatureScheme code point. Omitted if not
+applicable or not known.
*/
- partitionKey?: CookiePartitionKey;
+ serverSignatureAlgorithm?: number;
/**
- * True if cookie partition key is opaque.
+ * Whether the connection used Encrypted ClientHello
*/
- partitionKeyOpaque?: boolean;
+ encryptedClientHello: boolean;
}
/**
- * Types of reasons why a cookie may not be stored from a response.
+ * Whether the request complied with Certificate Transparency policy.
*/
- export type SetCookieBlockedReason = "SecureOnly"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"SyntaxError"|"SchemeNotSupported"|"OverwriteSecure"|"InvalidDomain"|"InvalidPrefix"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"SamePartyConflictsWithOtherAttributes"|"NameValuePairExceedsMaxSize"|"DisallowedCharacter"|"NoCookieContent";
+ export type CertificateTransparencyCompliance = "unknown"|"not-compliant"|"compliant";
/**
- * Types of reasons why a cookie may not be sent with a request.
+ * The reason why request was blocked.
*/
- export type CookieBlockedReason = "SecureOnly"|"NotOnPath"|"DomainMismatch"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"NameValuePairExceedsMaxSize"|"PortMismatch"|"SchemeMismatch"|"AnonymousContext";
+ export type BlockedReason = "other"|"csp"|"mixed-content"|"origin"|"inspector"|"integrity"|"subresource-filter"|"content-type"|"coep-frame-resource-needs-coep-header"|"coop-sandboxed-iframe-cannot-navigate-to-coop-page"|"corp-not-same-origin"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep"|"corp-not-same-origin-after-defaulted-to-same-origin-by-dip"|"corp-not-same-origin-after-defaulted-to-same-origin-by-coep-and-dip"|"corp-not-same-site"|"sri-message-signature-mismatch";
/**
- * Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
+ * Sets Controls for IP Proxy of requests.
+Page reload is required before the new behavior will be observed.
*/
- export type CookieExemptionReason = "None"|"UserSetting"|"TPCDMetadata"|"TPCDDeprecationTrial"|"TopLevelTPCDDeprecationTrial"|"TPCDHeuristics"|"EnterprisePolicy"|"StorageAccess"|"TopLevelStorageAccess"|"Scheme"|"SameSiteNoneCookiesInSandbox";
+ export type IpProxyStatus = "Available"|"FeatureNotEnabled"|"MaskedDomainListNotEnabled"|"MaskedDomainListNotPopulated"|"AuthTokensUnavailable"|"Unavailable"|"BypassedByDevTools";
/**
- * A cookie which was not stored from a response with the corresponding reason.
+ * The reason why request was blocked.
*/
- export interface BlockedSetCookieWithReason {
- /**
- * The reason(s) this cookie was blocked.
- */
- blockedReasons: SetCookieBlockedReason[];
- /**
- * The string representing this individual cookie as it would appear in the header.
-This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
+ export type CorsError = "DisallowedByMode"|"InvalidResponse"|"WildcardOriginNotAllowed"|"MissingAllowOriginHeader"|"MultipleAllowOriginValues"|"InvalidAllowOriginValue"|"AllowOriginMismatch"|"InvalidAllowCredentials"|"CorsDisabledScheme"|"PreflightInvalidStatus"|"PreflightDisallowedRedirect"|"PreflightWildcardOriginNotAllowed"|"PreflightMissingAllowOriginHeader"|"PreflightMultipleAllowOriginValues"|"PreflightInvalidAllowOriginValue"|"PreflightAllowOriginMismatch"|"PreflightInvalidAllowCredentials"|"PreflightMissingAllowExternal"|"PreflightInvalidAllowExternal"|"PreflightMissingAllowPrivateNetwork"|"PreflightInvalidAllowPrivateNetwork"|"InvalidAllowMethodsPreflightResponse"|"InvalidAllowHeadersPreflightResponse"|"MethodDisallowedByPreflightResponse"|"HeaderDisallowedByPreflightResponse"|"RedirectContainsCredentials"|"InsecurePrivateNetwork"|"InvalidPrivateNetworkAccess"|"UnexpectedPrivateNetworkAccess"|"NoCorsRedirectModeNotFollow"|"PreflightMissingPrivateNetworkAccessId"|"PreflightMissingPrivateNetworkAccessName"|"PrivateNetworkAccessPermissionUnavailable"|"PrivateNetworkAccessPermissionDenied"|"LocalNetworkAccessPermissionDenied";
+ export interface CorsErrorStatus {
+ corsError: CorsError;
+ failedParameter: string;
+ }
+ /**
+ * Source of serviceworker response.
+ */
+ export type ServiceWorkerResponseSource = "cache-storage"|"http-cache"|"fallback-code"|"network";
+ /**
+ * Determines what type of Trust Token operation is executed and
+depending on the type, some additional parameters. The values
+are specified in third_party/blink/renderer/core/fetch/trust_token.idl.
+ */
+ export interface TrustTokenParams {
+ operation: TrustTokenOperationType;
+ /**
+ * Only set for "token-redemption" operation and determine whether
+to request a fresh SRR or use a still valid cached SRR.
*/
- cookieLine: string;
+ refreshPolicy: "UseCached"|"Refresh";
/**
- * The cookie object which represents the cookie which was not stored. It is optional because
-sometimes complete cookie information is not available, such as in the case of parsing
-errors.
+ * Origins of issuers from whom to request tokens or redemption
+records.
*/
- cookie?: Cookie;
+ issuers?: string[];
}
+ export type TrustTokenOperationType = "Issuance"|"Redemption"|"Signing";
/**
- * A cookie should have been blocked by 3PCD but is exempted and stored from a response with the
-corresponding reason. A cookie could only have at most one exemption reason.
+ * The reason why Chrome uses a specific transport protocol for HTTP semantics.
*/
- export interface ExemptedSetCookieWithReason {
+ export type AlternateProtocolUsage = "alternativeJobWonWithoutRace"|"alternativeJobWonRace"|"mainJobWonRace"|"mappingMissing"|"broken"|"dnsAlpnH3JobWonWithoutRace"|"dnsAlpnH3JobWonRace"|"unspecifiedReason";
+ /**
+ * Source of service worker router.
+ */
+ export type ServiceWorkerRouterSource = "network"|"cache"|"fetch-event"|"race-network-and-fetch-handler"|"race-network-and-cache";
+ export interface ServiceWorkerRouterInfo {
/**
- * The reason the cookie was exempted.
+ * ID of the rule matched. If there is a matched rule, this field will
+be set, otherwiser no value will be set.
*/
- exemptionReason: CookieExemptionReason;
+ ruleIdMatched?: number;
/**
- * The string representing this individual cookie as it would appear in the header.
+ * The router source of the matched rule. If there is a matched rule, this
+field will be set, otherwise no value will be set.
*/
- cookieLine: string;
+ matchedSourceType?: ServiceWorkerRouterSource;
/**
- * The cookie object representing the cookie.
+ * The actual router source used.
*/
- cookie: Cookie;
+ actualSourceType?: ServiceWorkerRouterSource;
}
/**
- * A cookie associated with the request which may or may not be sent with it.
-Includes the cookies itself and reasons for blocking or exemption.
+ * HTTP response data.
*/
- export interface AssociatedCookie {
+ export interface Response {
/**
- * The cookie object representing the cookie which was not sent.
+ * Response URL. This URL can be different from CachedResource.url in case of redirect.
*/
- cookie: Cookie;
+ url: string;
/**
- * The reason(s) the cookie was blocked. If empty means the cookie is included.
+ * HTTP response status code.
*/
- blockedReasons: CookieBlockedReason[];
+ status: number;
/**
- * The reason the cookie should have been blocked by 3PCD but is exempted. A cookie could
-only have at most one exemption reason.
+ * HTTP response status text.
*/
- exemptionReason?: CookieExemptionReason;
- }
- /**
- * Cookie parameter object
- */
- export interface CookieParam {
+ statusText: string;
/**
- * Cookie name.
+ * HTTP response headers.
*/
- name: string;
+ headers: Headers;
/**
- * Cookie value.
+ * HTTP response headers text. This has been replaced by the headers in Network.responseReceivedExtraInfo.
*/
- value: string;
+ headersText?: string;
/**
- * The request-URI to associate with the setting of the cookie. This value can affect the
-default domain, path, source port, and source scheme values of the created cookie.
+ * Resource mimeType as determined by the browser.
*/
- url?: string;
+ mimeType: string;
/**
- * Cookie domain.
+ * Resource charset as determined by the browser (if applicable).
*/
- domain?: string;
+ charset: string;
/**
- * Cookie path.
+ * Refined HTTP request headers that were actually transmitted over the network.
*/
- path?: string;
+ requestHeaders?: Headers;
/**
- * True if cookie is secure.
+ * HTTP request headers text. This has been replaced by the headers in Network.requestWillBeSentExtraInfo.
*/
- secure?: boolean;
+ requestHeadersText?: string;
/**
- * True if cookie is http-only.
+ * Specifies whether physical connection was actually reused for this request.
*/
- httpOnly?: boolean;
+ connectionReused: boolean;
/**
- * Cookie SameSite type.
+ * Physical connection id that was actually used for this request.
*/
- sameSite?: CookieSameSite;
+ connectionId: number;
/**
- * Cookie expiration date, session cookie if not set
+ * Remote IP address.
*/
- expires?: TimeSinceEpoch;
+ remoteIPAddress?: string;
/**
- * Cookie Priority.
+ * Remote port.
*/
- priority?: CookiePriority;
+ remotePort?: number;
/**
- * True if cookie is SameParty.
+ * Specifies that the request was served from the disk cache.
*/
- sameParty?: boolean;
+ fromDiskCache?: boolean;
/**
- * Cookie source scheme type.
+ * Specifies that the request was served from the ServiceWorker.
*/
- sourceScheme?: CookieSourceScheme;
+ fromServiceWorker?: boolean;
/**
- * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
-An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
-This is a temporary ability and it will be removed in the future.
+ * Specifies that the request was served from the prefetch cache.
*/
- sourcePort?: number;
+ fromPrefetchCache?: boolean;
/**
- * Cookie partition key. If not set, the cookie will be set as not partitioned.
+ * Specifies that the request was served from the prefetch cache.
*/
- partitionKey?: CookiePartitionKey;
- }
- /**
- * Authorization challenge for HTTP status code 401 or 407.
- */
- export interface AuthChallenge {
+ fromEarlyHints?: boolean;
/**
- * Source of the authentication challenge.
+ * Information about how ServiceWorker Static Router API was used. If this
+field is set with `matchedSourceType` field, a matching rule is found.
+If this field is set without `matchedSource`, no matching rule is found.
+Otherwise, the API is not used.
*/
- source?: "Server"|"Proxy";
+ serviceWorkerRouterInfo?: ServiceWorkerRouterInfo;
/**
- * Origin of the challenger.
+ * Total number of bytes received for this request so far.
*/
- origin: string;
+ encodedDataLength: number;
/**
- * The authentication scheme used, such as basic or digest
+ * Timing information for the given request.
*/
- scheme: string;
+ timing?: ResourceTiming;
/**
- * The realm of the challenge. May be empty.
+ * Response source of response from ServiceWorker.
*/
- realm: string;
- }
- /**
- * Response to an AuthChallenge.
- */
- export interface AuthChallengeResponse {
+ serviceWorkerResponseSource?: ServiceWorkerResponseSource;
/**
- * The decision on what to do in response to the authorization challenge. Default means
-deferring to the default behavior of the net stack, which will likely either the Cancel
-authentication or display a popup dialog box.
+ * The time at which the returned response was generated.
*/
- response: "Default"|"CancelAuth"|"ProvideCredentials";
+ responseTime?: TimeSinceEpoch;
/**
- * The username to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Cache Storage Cache Name.
*/
- username?: string;
+ cacheStorageCacheName?: string;
/**
- * The password to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Protocol used to fetch this request.
*/
- password?: string;
- }
- /**
- * Stages of the interception to begin intercepting. Request will intercept before the request is
-sent. Response will intercept after the response is received.
- */
- export type InterceptionStage = "Request"|"HeadersReceived";
- /**
- * Request pattern for interception.
- */
- export interface RequestPattern {
+ protocol?: string;
/**
- * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
-backslash. Omitting is equivalent to `"*"`.
+ * The reason why Chrome uses a specific transport protocol for HTTP semantics.
*/
- urlPattern?: string;
+ alternateProtocolUsage?: AlternateProtocolUsage;
/**
- * If set, only requests for matching resource types will be intercepted.
+ * Security state of the request resource.
*/
- resourceType?: ResourceType;
+ securityState: Security.SecurityState;
/**
- * Stage at which to begin intercepting requests. Default is Request.
+ * Security details for the request.
*/
- interceptionStage?: InterceptionStage;
+ securityDetails?: SecurityDetails;
+ /**
+ * Indicates whether the request was sent through IP Protection proxies. If
+set to true, the request used the IP Protection privacy feature.
+ */
+ isIpProtectionUsed?: boolean;
}
/**
- * Information about a signed exchange signature.
-https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
+ * WebSocket request data.
*/
- export interface SignedExchangeSignature {
+ export interface WebSocketRequest {
/**
- * Signed exchange signature label.
+ * HTTP request headers.
*/
- label: string;
+ headers: Headers;
+ }
+ /**
+ * WebSocket response data.
+ */
+ export interface WebSocketResponse {
/**
- * The hex string of signed exchange signature.
+ * HTTP response status code.
*/
- signature: string;
+ status: number;
/**
- * Signed exchange signature integrity.
+ * HTTP response status text.
*/
- integrity: string;
+ statusText: string;
/**
- * Signed exchange signature cert Url.
+ * HTTP response headers.
*/
- certUrl?: string;
+ headers: Headers;
/**
- * The hex string of signed exchange signature cert sha256.
+ * HTTP response headers text.
*/
- certSha256?: string;
+ headersText?: string;
/**
- * Signed exchange signature validity Url.
+ * HTTP request headers.
*/
- validityUrl: string;
+ requestHeaders?: Headers;
/**
- * Signed exchange signature date.
+ * HTTP request headers text.
*/
- date: number;
+ requestHeadersText?: string;
+ }
+ /**
+ * WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests.
+ */
+ export interface WebSocketFrame {
/**
- * Signed exchange signature expires.
+ * WebSocket message opcode.
*/
- expires: number;
+ opcode: number;
/**
- * The encoded certificates.
+ * WebSocket message mask.
*/
- certificates?: string[];
+ mask: boolean;
+ /**
+ * WebSocket message payload data.
+If the opcode is 1, this is a text message and payloadData is a UTF-8 string.
+If the opcode isn't 1, then payloadData is a base64 encoded string representing binary data.
+ */
+ payloadData: string;
}
/**
- * Information about a signed exchange header.
-https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
+ * Information about the cached resource.
*/
- export interface SignedExchangeHeader {
- /**
- * Signed exchange request URL.
- */
- requestUrl: string;
+ export interface CachedResource {
/**
- * Signed exchange response code.
+ * Resource URL. This is the url of the original network request.
*/
- responseCode: number;
+ url: string;
/**
- * Signed exchange response headers.
+ * Type of this resource.
*/
- responseHeaders: Headers;
+ type: ResourceType;
/**
- * Signed exchange response signature.
+ * Cached response data.
*/
- signatures: SignedExchangeSignature[];
+ response?: Response;
/**
- * Signed exchange header integrity hash in the form of `sha256-<base64-hash-value>`.
+ * Cached response body size.
*/
- headerIntegrity: string;
+ bodySize: number;
}
/**
- * Field type for a signed exchange related error.
- */
- export type SignedExchangeErrorField = "signatureSig"|"signatureIntegrity"|"signatureCertUrl"|"signatureCertSha256"|"signatureValidityUrl"|"signatureTimestamps";
- /**
- * Information about a signed exchange response.
+ * Information about the request initiator.
*/
- export interface SignedExchangeError {
+ export interface Initiator {
/**
- * Error message.
+ * Type of this initiator.
*/
- message: string;
+ type: "parser"|"script"|"preload"|"SignedExchange"|"preflight"|"other";
/**
- * The index of the signature which caused the error.
+ * Initiator JavaScript stack trace, set for Script only.
+Requires the Debugger domain to be enabled.
*/
- signatureIndex?: number;
+ stack?: Runtime.StackTrace;
/**
- * The field which caused the error.
+ * Initiator URL, set for Parser type or for Script type (when script is importing module) or for SignedExchange type.
*/
- errorField?: SignedExchangeErrorField;
- }
- /**
- * Information about a signed exchange response.
- */
- export interface SignedExchangeInfo {
+ url?: string;
/**
- * The outer response of signed HTTP exchange which was received from network.
+ * Initiator line number, set for Parser type or for Script type (when script is importing
+module) (0-based).
*/
- outerResponse: Response;
+ lineNumber?: number;
/**
- * Whether network response for the signed exchange was accompanied by
-extra headers.
+ * Initiator column number, set for Parser type or for Script type (when script is importing
+module) (0-based).
*/
- hasExtraInfo: boolean;
+ columnNumber?: number;
/**
- * Information about the signed exchange header.
+ * Set if another request triggered this request (e.g. preflight).
*/
- header?: SignedExchangeHeader;
+ requestId?: RequestId;
+ }
+ /**
+ * cookiePartitionKey object
+The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h.
+ */
+ export interface CookiePartitionKey {
/**
- * Security details for the signed exchange header.
+ * The site of the top-level URL the browser was visiting at the start
+of the request to the endpoint that set the cookie.
*/
- securityDetails?: SecurityDetails;
+ topLevelSite: string;
/**
- * Errors occurred while handling the signed exchange.
+ * Indicates if the cookie has any ancestors that are cross-site to the topLevelSite.
*/
- errors?: SignedExchangeError[];
+ hasCrossSiteAncestor: boolean;
}
/**
- * List of content encodings supported by the backend.
+ * Cookie object
*/
- export type ContentEncoding = "deflate"|"gzip"|"br"|"zstd";
- export type DirectSocketDnsQueryType = "ipv4"|"ipv6";
- export interface DirectTCPSocketOptions {
+ export interface Cookie {
/**
- * TCP_NODELAY option
+ * Cookie name.
*/
- noDelay: boolean;
+ name: string;
/**
- * Expected to be unsigned integer.
+ * Cookie value.
*/
- keepAliveDelay?: number;
+ value: string;
/**
- * Expected to be unsigned integer.
+ * Cookie domain.
*/
- sendBufferSize?: number;
+ domain: string;
/**
- * Expected to be unsigned integer.
+ * Cookie path.
*/
- receiveBufferSize?: number;
- dnsQueryType?: DirectSocketDnsQueryType;
- }
- export interface DirectUDPSocketOptions {
- remoteAddr?: string;
+ path: string;
/**
- * Unsigned int 16.
+ * Cookie expiration date as the number of seconds since the UNIX epoch.
*/
- remotePort?: number;
- localAddr?: string;
+ expires: number;
/**
- * Unsigned int 16.
+ * Cookie size.
*/
- localPort?: number;
- dnsQueryType?: DirectSocketDnsQueryType;
+ size: number;
/**
- * Expected to be unsigned integer.
+ * True if cookie is http-only.
*/
- sendBufferSize?: number;
+ httpOnly: boolean;
/**
- * Expected to be unsigned integer.
+ * True if cookie is secure.
*/
- receiveBufferSize?: number;
- }
- export interface DirectUDPMessage {
- data: binary;
+ secure: boolean;
/**
- * Null for connected mode.
+ * True in case of session cookie.
*/
- remoteAddr?: string;
+ session: boolean;
/**
- * Null for connected mode.
-Expected to be unsigned integer.
+ * Cookie SameSite type.
*/
- remotePort?: number;
- }
- export type PrivateNetworkRequestPolicy = "Allow"|"BlockFromInsecureToMorePrivate"|"WarnFromInsecureToMorePrivate"|"PreflightBlock"|"PreflightWarn"|"PermissionBlock"|"PermissionWarn";
- export type IPAddressSpace = "Loopback"|"Local"|"Public"|"Unknown";
- export interface ConnectTiming {
+ sameSite?: CookieSameSite;
/**
- * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
-milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
-the same request (but not for redirected requests).
+ * Cookie Priority
*/
- requestTime: number;
- }
- export interface ClientSecurityState {
- initiatorIsSecureContext: boolean;
- initiatorIPAddressSpace: IPAddressSpace;
- privateNetworkRequestPolicy: PrivateNetworkRequestPolicy;
- }
- export type CrossOriginOpenerPolicyValue = "SameOrigin"|"SameOriginAllowPopups"|"RestrictProperties"|"UnsafeNone"|"SameOriginPlusCoep"|"RestrictPropertiesPlusCoep"|"NoopenerAllowPopups";
- export interface CrossOriginOpenerPolicyStatus {
- value: CrossOriginOpenerPolicyValue;
- reportOnlyValue: CrossOriginOpenerPolicyValue;
- reportingEndpoint?: string;
- reportOnlyReportingEndpoint?: string;
- }
- export type CrossOriginEmbedderPolicyValue = "None"|"Credentialless"|"RequireCorp";
- export interface CrossOriginEmbedderPolicyStatus {
- value: CrossOriginEmbedderPolicyValue;
- reportOnlyValue: CrossOriginEmbedderPolicyValue;
- reportingEndpoint?: string;
- reportOnlyReportingEndpoint?: string;
- }
- export type ContentSecurityPolicySource = "HTTP"|"Meta";
- export interface ContentSecurityPolicyStatus {
- effectiveDirectives: string;
- isEnforced: boolean;
- source: ContentSecurityPolicySource;
- }
- export interface SecurityIsolationStatus {
- coop?: CrossOriginOpenerPolicyStatus;
- coep?: CrossOriginEmbedderPolicyStatus;
- csp?: ContentSecurityPolicyStatus[];
- }
- /**
- * The status of a Reporting API report.
- */
- export type ReportStatus = "Queued"|"Pending"|"MarkedForRemoval"|"Success";
- export type ReportId = string;
- /**
- * An object representing a report generated by the Reporting API.
- */
- export interface ReportingApiReport {
- id: ReportId;
+ priority: CookiePriority;
/**
- * The URL of the document that triggered the report.
+ * True if cookie is SameParty.
*/
- initiatorUrl: string;
+ sameParty: boolean;
/**
- * The name of the endpoint group that should be used to deliver the report.
+ * Cookie source scheme type.
*/
- destination: string;
+ sourceScheme: CookieSourceScheme;
/**
- * The type of the report (specifies the set of data that is contained in the report body).
+ * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
+An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
+This is a temporary ability and it will be removed in the future.
*/
- type: string;
+ sourcePort: number;
/**
- * When the report was generated.
+ * Cookie partition key.
*/
- timestamp: Network.TimeSinceEpoch;
+ partitionKey?: CookiePartitionKey;
/**
- * How many uploads deep the related request was.
+ * True if cookie partition key is opaque.
*/
- depth: number;
+ partitionKeyOpaque?: boolean;
+ }
+ /**
+ * Types of reasons why a cookie may not be stored from a response.
+ */
+ export type SetCookieBlockedReason = "SecureOnly"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"SyntaxError"|"SchemeNotSupported"|"OverwriteSecure"|"InvalidDomain"|"InvalidPrefix"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"SamePartyConflictsWithOtherAttributes"|"NameValuePairExceedsMaxSize"|"DisallowedCharacter"|"NoCookieContent";
+ /**
+ * Types of reasons why a cookie may not be sent with a request.
+ */
+ export type CookieBlockedReason = "SecureOnly"|"NotOnPath"|"DomainMismatch"|"SameSiteStrict"|"SameSiteLax"|"SameSiteUnspecifiedTreatedAsLax"|"SameSiteNoneInsecure"|"UserPreferences"|"ThirdPartyPhaseout"|"ThirdPartyBlockedInFirstPartySet"|"UnknownError"|"SchemefulSameSiteStrict"|"SchemefulSameSiteLax"|"SchemefulSameSiteUnspecifiedTreatedAsLax"|"SamePartyFromCrossPartyContext"|"NameValuePairExceedsMaxSize"|"PortMismatch"|"SchemeMismatch"|"AnonymousContext";
+ /**
+ * Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
+ */
+ export type CookieExemptionReason = "None"|"UserSetting"|"TPCDMetadata"|"TPCDDeprecationTrial"|"TopLevelTPCDDeprecationTrial"|"TPCDHeuristics"|"EnterprisePolicy"|"StorageAccess"|"TopLevelStorageAccess"|"Scheme"|"SameSiteNoneCookiesInSandbox";
+ /**
+ * A cookie which was not stored from a response with the corresponding reason.
+ */
+ export interface BlockedSetCookieWithReason {
/**
- * The number of delivery attempts made so far, not including an active attempt.
+ * The reason(s) this cookie was blocked.
*/
- completedAttempts: number;
- body: { [key: string]: string };
- status: ReportStatus;
- }
- export interface ReportingApiEndpoint {
+ blockedReasons: SetCookieBlockedReason[];
/**
- * The URL of the endpoint to which reports may be delivered.
+ * The string representing this individual cookie as it would appear in the header.
+This is not the entire "cookie" or "set-cookie" header which could have multiple cookies.
*/
- url: string;
+ cookieLine: string;
/**
- * Name of the endpoint group.
+ * The cookie object which represents the cookie which was not stored. It is optional because
+sometimes complete cookie information is not available, such as in the case of parsing
+errors.
*/
- groupName: string;
+ cookie?: Cookie;
}
/**
- * An object providing the result of a network resource load.
+ * A cookie should have been blocked by 3PCD but is exempted and stored from a response with the
+corresponding reason. A cookie could only have at most one exemption reason.
*/
- export interface LoadNetworkResourcePageResult {
- success: boolean;
+ export interface ExemptedSetCookieWithReason {
/**
- * Optional values used for error reporting.
+ * The reason the cookie was exempted.
*/
- netError?: number;
- netErrorName?: string;
- httpStatusCode?: number;
+ exemptionReason: CookieExemptionReason;
/**
- * If successful, one of the following two fields holds the result.
+ * The string representing this individual cookie as it would appear in the header.
*/
- stream?: IO.StreamHandle;
+ cookieLine: string;
/**
- * Response headers.
+ * The cookie object representing the cookie.
*/
- headers?: Network.Headers;
+ cookie: Cookie;
}
/**
- * An options object that may be extended later to better support CORS,
-CORB and streaming.
+ * A cookie associated with the request which may or may not be sent with it.
+Includes the cookies itself and reasons for blocking or exemption.
*/
- export interface LoadNetworkResourceOptions {
- disableCache: boolean;
- includeCredentials: boolean;
+ export interface AssociatedCookie {
+ /**
+ * The cookie object representing the cookie which was not sent.
+ */
+ cookie: Cookie;
+ /**
+ * The reason(s) the cookie was blocked. If empty means the cookie is included.
+ */
+ blockedReasons: CookieBlockedReason[];
+ /**
+ * The reason the cookie should have been blocked by 3PCD but is exempted. A cookie could
+only have at most one exemption reason.
+ */
+ exemptionReason?: CookieExemptionReason;
}
-
/**
- * Fired when data chunk was received over the network.
+ * Cookie parameter object
*/
- export type dataReceivedPayload = {
+ export interface CookieParam {
/**
- * Request identifier.
+ * Cookie name.
*/
- requestId: RequestId;
+ name: string;
/**
- * Timestamp.
+ * Cookie value.
*/
- timestamp: MonotonicTime;
+ value: string;
/**
- * Data chunk length.
+ * The request-URI to associate with the setting of the cookie. This value can affect the
+default domain, path, source port, and source scheme values of the created cookie.
*/
- dataLength: number;
+ url?: string;
/**
- * Actual bytes received (might be less than dataLength for compressed encodings).
+ * Cookie domain.
*/
- encodedDataLength: number;
+ domain?: string;
/**
- * Data that was received.
+ * Cookie path.
*/
- data?: binary;
- }
- /**
- * Fired when EventSource message is received.
- */
- export type eventSourceMessageReceivedPayload = {
+ path?: string;
/**
- * Request identifier.
+ * True if cookie is secure.
*/
- requestId: RequestId;
+ secure?: boolean;
/**
- * Timestamp.
+ * True if cookie is http-only.
*/
- timestamp: MonotonicTime;
+ httpOnly?: boolean;
/**
- * Message type.
+ * Cookie SameSite type.
*/
- eventName: string;
+ sameSite?: CookieSameSite;
/**
- * Message identifier.
+ * Cookie expiration date, session cookie if not set
*/
- eventId: string;
+ expires?: TimeSinceEpoch;
/**
- * Message content.
+ * Cookie Priority.
*/
- data: string;
- }
- /**
- * Fired when HTTP request has failed to load.
- */
- export type loadingFailedPayload = {
+ priority?: CookiePriority;
/**
- * Request identifier.
+ * True if cookie is SameParty.
*/
- requestId: RequestId;
+ sameParty?: boolean;
/**
- * Timestamp.
+ * Cookie source scheme type.
*/
- timestamp: MonotonicTime;
+ sourceScheme?: CookieSourceScheme;
/**
- * Resource type.
+ * Cookie source port. Valid values are {-1, [1, 65535]}, -1 indicates an unspecified port.
+An unspecified port value allows protocol clients to emulate legacy cookie scope for the port.
+This is a temporary ability and it will be removed in the future.
*/
- type: ResourceType;
+ sourcePort?: number;
/**
- * Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h
+ * Cookie partition key. If not set, the cookie will be set as not partitioned.
*/
- errorText: string;
+ partitionKey?: CookiePartitionKey;
+ }
+ /**
+ * Authorization challenge for HTTP status code 401 or 407.
+ */
+ export interface AuthChallenge {
/**
- * True if loading was canceled.
+ * Source of the authentication challenge.
*/
- canceled?: boolean;
+ source?: "Server"|"Proxy";
/**
- * The reason why loading was blocked, if any.
+ * Origin of the challenger.
*/
- blockedReason?: BlockedReason;
+ origin: string;
/**
- * The reason why loading was blocked by CORS, if any.
+ * The authentication scheme used, such as basic or digest
*/
- corsErrorStatus?: CorsErrorStatus;
+ scheme: string;
+ /**
+ * The realm of the challenge. May be empty.
+ */
+ realm: string;
}
/**
- * Fired when HTTP request has finished loading.
+ * Response to an AuthChallenge.
*/
- export type loadingFinishedPayload = {
+ export interface AuthChallengeResponse {
/**
- * Request identifier.
+ * The decision on what to do in response to the authorization challenge. Default means
+deferring to the default behavior of the net stack, which will likely either the Cancel
+authentication or display a popup dialog box.
*/
- requestId: RequestId;
+ response: "Default"|"CancelAuth"|"ProvideCredentials";
/**
- * Timestamp.
+ * The username to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- timestamp: MonotonicTime;
+ username?: string;
/**
- * Total number of bytes received for this request.
+ * The password to provide, possibly empty. Should only be set if response is
+ProvideCredentials.
*/
- encodedDataLength: number;
+ password?: string;
}
/**
- * Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
-mocked.
-Deprecated, use Fetch.requestPaused instead.
+ * Stages of the interception to begin intercepting. Request will intercept before the request is
+sent. Response will intercept after the response is received.
*/
- export type requestInterceptedPayload = {
+ export type InterceptionStage = "Request"|"HeadersReceived";
+ /**
+ * Request pattern for interception.
+ */
+ export interface RequestPattern {
/**
- * Each request the page makes will have a unique id, however if any redirects are encountered
-while processing that fetch, they will be reported with the same id as the original fetch.
-Likewise if HTTP authentication is needed then the same fetch id will be used.
+ * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
+backslash. Omitting is equivalent to `"*"`.
*/
- interceptionId: InterceptionId;
- request: Request;
+ urlPattern?: string;
/**
- * The id of the frame that initiated the request.
+ * If set, only requests for matching resource types will be intercepted.
*/
- frameId: Page.FrameId;
+ resourceType?: ResourceType;
/**
- * How the requested resource will be used.
+ * Stage at which to begin intercepting requests. Default is Request.
*/
- resourceType: ResourceType;
+ interceptionStage?: InterceptionStage;
+ }
+ /**
+ * Information about a signed exchange signature.
+https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1
+ */
+ export interface SignedExchangeSignature {
/**
- * Whether this is a navigation request, which can abort the navigation completely.
+ * Signed exchange signature label.
*/
- isNavigationRequest: boolean;
+ label: string;
/**
- * Set if the request is a navigation that will result in a download.
-Only present after response is received from the server (i.e. HeadersReceived stage).
+ * The hex string of signed exchange signature.
*/
- isDownload?: boolean;
+ signature: string;
/**
- * Redirect location, only sent if a redirect was intercepted.
+ * Signed exchange signature integrity.
*/
- redirectUrl?: string;
+ integrity: string;
/**
- * Details of the Authorization Challenge encountered. If this is set then
-continueInterceptedRequest must contain an authChallengeResponse.
+ * Signed exchange signature cert Url.
*/
- authChallenge?: AuthChallenge;
+ certUrl?: string;
/**
- * Response error if intercepted at response stage or if redirect occurred while intercepting
-request.
+ * The hex string of signed exchange signature cert sha256.
*/
- responseErrorReason?: ErrorReason;
+ certSha256?: string;
/**
- * Response code if intercepted at response stage or if redirect occurred while intercepting
-request or auth retry occurred.
+ * Signed exchange signature validity Url.
*/
- responseStatusCode?: number;
+ validityUrl: string;
/**
- * Response headers if intercepted at the response stage or if redirect occurred while
-intercepting request or auth retry occurred.
+ * Signed exchange signature date.
*/
- responseHeaders?: Headers;
+ date: number;
/**
- * If the intercepted request had a corresponding requestWillBeSent event fired for it, then
-this requestId will be the same as the requestId present in the requestWillBeSent event.
+ * Signed exchange signature expires.
*/
- requestId?: RequestId;
- }
- /**
- * Fired if request ended up loading from cache.
- */
- export type requestServedFromCachePayload = {
+ expires: number;
/**
- * Request identifier.
+ * The encoded certificates.
*/
- requestId: RequestId;
+ certificates?: string[];
}
/**
- * Fired when page is about to send HTTP request.
+ * Information about a signed exchange header.
+https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation
*/
- export type requestWillBeSentPayload = {
+ export interface SignedExchangeHeader {
/**
- * Request identifier.
+ * Signed exchange request URL.
*/
- requestId: RequestId;
+ requestUrl: string;
/**
- * Loader identifier. Empty string if the request is fetched from worker.
+ * Signed exchange response code.
*/
- loaderId: LoaderId;
+ responseCode: number;
/**
- * URL of the document this request is loaded for.
+ * Signed exchange response headers.
*/
- documentURL: string;
+ responseHeaders: Headers;
/**
- * Request data.
+ * Signed exchange response signature.
*/
- request: Request;
+ signatures: SignedExchangeSignature[];
/**
- * Timestamp.
+ * Signed exchange header integrity hash in the form of `sha256-<base64-hash-value>`.
*/
- timestamp: MonotonicTime;
+ headerIntegrity: string;
+ }
+ /**
+ * Field type for a signed exchange related error.
+ */
+ export type SignedExchangeErrorField = "signatureSig"|"signatureIntegrity"|"signatureCertUrl"|"signatureCertSha256"|"signatureValidityUrl"|"signatureTimestamps";
+ /**
+ * Information about a signed exchange response.
+ */
+ export interface SignedExchangeError {
/**
- * Timestamp.
+ * Error message.
*/
- wallTime: TimeSinceEpoch;
+ message: string;
/**
- * Request initiator.
+ * The index of the signature which caused the error.
*/
- initiator: Initiator;
+ signatureIndex?: number;
/**
- * In the case that redirectResponse is populated, this flag indicates whether
-requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
-for the request which was just redirected.
+ * The field which caused the error.
*/
- redirectHasExtraInfo: boolean;
+ errorField?: SignedExchangeErrorField;
+ }
+ /**
+ * Information about a signed exchange response.
+ */
+ export interface SignedExchangeInfo {
/**
- * Redirect response data.
+ * The outer response of signed HTTP exchange which was received from network.
*/
- redirectResponse?: Response;
+ outerResponse: Response;
/**
- * Type of this resource.
+ * Whether network response for the signed exchange was accompanied by
+extra headers.
*/
- type?: ResourceType;
+ hasExtraInfo: boolean;
/**
- * Frame identifier.
+ * Information about the signed exchange header.
*/
- frameId?: Page.FrameId;
+ header?: SignedExchangeHeader;
/**
- * Whether the request is initiated by a user gesture. Defaults to false.
+ * Security details for the signed exchange header.
*/
- hasUserGesture?: boolean;
+ securityDetails?: SecurityDetails;
+ /**
+ * Errors occurred while handling the signed exchange.
+ */
+ errors?: SignedExchangeError[];
}
/**
- * Fired when resource loading priority is changed
+ * List of content encodings supported by the backend.
*/
- export type resourceChangedPriorityPayload = {
+ export type ContentEncoding = "deflate"|"gzip"|"br"|"zstd";
+ export type DirectSocketDnsQueryType = "ipv4"|"ipv6";
+ export interface DirectTCPSocketOptions {
/**
- * Request identifier.
+ * TCP_NODELAY option
*/
- requestId: RequestId;
+ noDelay: boolean;
/**
- * New priority
+ * Expected to be unsigned integer.
*/
- newPriority: ResourcePriority;
+ keepAliveDelay?: number;
/**
- * Timestamp.
+ * Expected to be unsigned integer.
*/
- timestamp: MonotonicTime;
+ sendBufferSize?: number;
+ /**
+ * Expected to be unsigned integer.
+ */
+ receiveBufferSize?: number;
+ dnsQueryType?: DirectSocketDnsQueryType;
}
- /**
- * Fired when a signed exchange was received over the network
- */
- export type signedExchangeReceivedPayload = {
+ export interface DirectUDPSocketOptions {
+ remoteAddr?: string;
/**
- * Request identifier.
+ * Unsigned int 16.
*/
- requestId: RequestId;
+ remotePort?: number;
+ localAddr?: string;
/**
- * Information about the signed exchange response.
+ * Unsigned int 16.
*/
- info: SignedExchangeInfo;
+ localPort?: number;
+ dnsQueryType?: DirectSocketDnsQueryType;
+ /**
+ * Expected to be unsigned integer.
+ */
+ sendBufferSize?: number;
+ /**
+ * Expected to be unsigned integer.
+ */
+ receiveBufferSize?: number;
}
- /**
- * Fired when HTTP response is available.
- */
- export type responseReceivedPayload = {
+ export interface DirectUDPMessage {
+ data: binary;
/**
- * Request identifier.
+ * Null for connected mode.
*/
- requestId: RequestId;
+ remoteAddr?: string;
/**
- * Loader identifier. Empty string if the request is fetched from worker.
+ * Null for connected mode.
+Expected to be unsigned integer.
*/
- loaderId: LoaderId;
+ remotePort?: number;
+ }
+ export type PrivateNetworkRequestPolicy = "Allow"|"BlockFromInsecureToMorePrivate"|"WarnFromInsecureToMorePrivate"|"PreflightBlock"|"PreflightWarn"|"PermissionBlock"|"PermissionWarn";
+ export type IPAddressSpace = "Loopback"|"Local"|"Public"|"Unknown";
+ export interface ConnectTiming {
/**
- * Timestamp.
+ * Timing's requestTime is a baseline in seconds, while the other numbers are ticks in
+milliseconds relatively to this requestTime. Matches ResourceTiming's requestTime for
+the same request (but not for redirected requests).
*/
- timestamp: MonotonicTime;
+ requestTime: number;
+ }
+ export interface ClientSecurityState {
+ initiatorIsSecureContext: boolean;
+ initiatorIPAddressSpace: IPAddressSpace;
+ privateNetworkRequestPolicy: PrivateNetworkRequestPolicy;
+ }
+ export type CrossOriginOpenerPolicyValue = "SameOrigin"|"SameOriginAllowPopups"|"RestrictProperties"|"UnsafeNone"|"SameOriginPlusCoep"|"RestrictPropertiesPlusCoep"|"NoopenerAllowPopups";
+ export interface CrossOriginOpenerPolicyStatus {
+ value: CrossOriginOpenerPolicyValue;
+ reportOnlyValue: CrossOriginOpenerPolicyValue;
+ reportingEndpoint?: string;
+ reportOnlyReportingEndpoint?: string;
+ }
+ export type CrossOriginEmbedderPolicyValue = "None"|"Credentialless"|"RequireCorp";
+ export interface CrossOriginEmbedderPolicyStatus {
+ value: CrossOriginEmbedderPolicyValue;
+ reportOnlyValue: CrossOriginEmbedderPolicyValue;
+ reportingEndpoint?: string;
+ reportOnlyReportingEndpoint?: string;
+ }
+ export type ContentSecurityPolicySource = "HTTP"|"Meta";
+ export interface ContentSecurityPolicyStatus {
+ effectiveDirectives: string;
+ isEnforced: boolean;
+ source: ContentSecurityPolicySource;
+ }
+ export interface SecurityIsolationStatus {
+ coop?: CrossOriginOpenerPolicyStatus;
+ coep?: CrossOriginEmbedderPolicyStatus;
+ csp?: ContentSecurityPolicyStatus[];
+ }
+ /**
+ * The status of a Reporting API report.
+ */
+ export type ReportStatus = "Queued"|"Pending"|"MarkedForRemoval"|"Success";
+ export type ReportId = string;
+ /**
+ * An object representing a report generated by the Reporting API.
+ */
+ export interface ReportingApiReport {
+ id: ReportId;
/**
- * Resource type.
+ * The URL of the document that triggered the report.
*/
- type: ResourceType;
+ initiatorUrl: string;
/**
- * Response data.
+ * The name of the endpoint group that should be used to deliver the report.
*/
- response: Response;
+ destination: string;
/**
- * Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
-or were emitted for this request.
+ * The type of the report (specifies the set of data that is contained in the report body).
*/
- hasExtraInfo: boolean;
+ type: string;
/**
- * Frame identifier.
+ * When the report was generated.
*/
- frameId?: Page.FrameId;
+ timestamp: Network.TimeSinceEpoch;
+ /**
+ * How many uploads deep the related request was.
+ */
+ depth: number;
+ /**
+ * The number of delivery attempts made so far, not including an active attempt.
+ */
+ completedAttempts: number;
+ body: { [key: string]: string };
+ status: ReportStatus;
}
- /**
- * Fired when WebSocket is closed.
- */
- export type webSocketClosedPayload = {
+ export interface ReportingApiEndpoint {
/**
- * Request identifier.
+ * The URL of the endpoint to which reports may be delivered.
*/
- requestId: RequestId;
+ url: string;
/**
- * Timestamp.
+ * Name of the endpoint group.
*/
- timestamp: MonotonicTime;
+ groupName: string;
}
/**
- * Fired upon WebSocket creation.
+ * An object providing the result of a network resource load.
*/
- export type webSocketCreatedPayload = {
+ export interface LoadNetworkResourcePageResult {
+ success: boolean;
/**
- * Request identifier.
+ * Optional values used for error reporting.
*/
- requestId: RequestId;
+ netError?: number;
+ netErrorName?: string;
+ httpStatusCode?: number;
/**
- * WebSocket request URL.
+ * If successful, one of the following two fields holds the result.
*/
- url: string;
+ stream?: IO.StreamHandle;
/**
- * Request initiator.
+ * Response headers.
*/
- initiator?: Initiator;
+ headers?: Network.Headers;
}
/**
- * Fired when WebSocket message error occurs.
+ * An options object that may be extended later to better support CORS,
+CORB and streaming.
*/
- export type webSocketFrameErrorPayload = {
+ export interface LoadNetworkResourceOptions {
+ disableCache: boolean;
+ includeCredentials: boolean;
+ }
+
+ /**
+ * Fired when data chunk was received over the network.
+ */
+ export type dataReceivedPayload = {
/**
* Request identifier.
*/
@@ -10220,14 +11046,22 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket error message.
+ * Data chunk length.
*/
- errorMessage: string;
+ dataLength: number;
+ /**
+ * Actual bytes received (might be less than dataLength for compressed encodings).
+ */
+ encodedDataLength: number;
+ /**
+ * Data that was received.
+ */
+ data?: binary;
}
/**
- * Fired when WebSocket message is received.
+ * Fired when EventSource message is received.
*/
- export type webSocketFrameReceivedPayload = {
+ export type eventSourceMessageReceivedPayload = {
/**
* Request identifier.
*/
@@ -10237,14 +11071,22 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Message type.
*/
- response: WebSocketFrame;
+ eventName: string;
+ /**
+ * Message identifier.
+ */
+ eventId: string;
+ /**
+ * Message content.
+ */
+ data: string;
}
/**
- * Fired when WebSocket message is sent.
+ * Fired when HTTP request has failed to load.
*/
- export type webSocketFrameSentPayload = {
+ export type loadingFailedPayload = {
/**
* Request identifier.
*/
@@ -10254,14 +11096,30 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Resource type.
*/
- response: WebSocketFrame;
+ type: ResourceType;
+ /**
+ * Error message. List of network errors: https://cs.chromium.org/chromium/src/net/base/net_error_list.h
+ */
+ errorText: string;
+ /**
+ * True if loading was canceled.
+ */
+ canceled?: boolean;
+ /**
+ * The reason why loading was blocked, if any.
+ */
+ blockedReason?: BlockedReason;
+ /**
+ * The reason why loading was blocked by CORS, if any.
+ */
+ corsErrorStatus?: CorsErrorStatus;
}
/**
- * Fired when WebSocket handshake response becomes available.
+ * Fired when HTTP request has finished loading.
*/
- export type webSocketHandshakeResponseReceivedPayload = {
+ export type loadingFinishedPayload = {
/**
* Request identifier.
*/
@@ -10271,111 +11129,397 @@ or were emitted for this request.
*/
timestamp: MonotonicTime;
/**
- * WebSocket response data.
+ * Total number of bytes received for this request.
*/
- response: WebSocketResponse;
+ encodedDataLength: number;
}
/**
- * Fired when WebSocket is about to initiate handshake.
+ * Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
+mocked.
+Deprecated, use Fetch.requestPaused instead.
*/
- export type webSocketWillSendHandshakeRequestPayload = {
+ export type requestInterceptedPayload = {
+ /**
+ * Each request the page makes will have a unique id, however if any redirects are encountered
+while processing that fetch, they will be reported with the same id as the original fetch.
+Likewise if HTTP authentication is needed then the same fetch id will be used.
+ */
+ interceptionId: InterceptionId;
+ request: Request;
+ /**
+ * The id of the frame that initiated the request.
+ */
+ frameId: Page.FrameId;
+ /**
+ * How the requested resource will be used.
+ */
+ resourceType: ResourceType;
+ /**
+ * Whether this is a navigation request, which can abort the navigation completely.
+ */
+ isNavigationRequest: boolean;
+ /**
+ * Set if the request is a navigation that will result in a download.
+Only present after response is received from the server (i.e. HeadersReceived stage).
+ */
+ isDownload?: boolean;
+ /**
+ * Redirect location, only sent if a redirect was intercepted.
+ */
+ redirectUrl?: string;
+ /**
+ * Details of the Authorization Challenge encountered. If this is set then
+continueInterceptedRequest must contain an authChallengeResponse.
+ */
+ authChallenge?: AuthChallenge;
+ /**
+ * Response error if intercepted at response stage or if redirect occurred while intercepting
+request.
+ */
+ responseErrorReason?: ErrorReason;
+ /**
+ * Response code if intercepted at response stage or if redirect occurred while intercepting
+request or auth retry occurred.
+ */
+ responseStatusCode?: number;
+ /**
+ * Response headers if intercepted at the response stage or if redirect occurred while
+intercepting request or auth retry occurred.
+ */
+ responseHeaders?: Headers;
+ /**
+ * If the intercepted request had a corresponding requestWillBeSent event fired for it, then
+this requestId will be the same as the requestId present in the requestWillBeSent event.
+ */
+ requestId?: RequestId;
+ }
+ /**
+ * Fired if request ended up loading from cache.
+ */
+ export type requestServedFromCachePayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ }
+ /**
+ * Fired when page is about to send HTTP request.
+ */
+ export type requestWillBeSentPayload = {
/**
* Request identifier.
*/
requestId: RequestId;
+ /**
+ * Loader identifier. Empty string if the request is fetched from worker.
+ */
+ loaderId: LoaderId;
+ /**
+ * URL of the document this request is loaded for.
+ */
+ documentURL: string;
+ /**
+ * Request data.
+ */
+ request: Request;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
/**
- * UTC Timestamp.
+ * Timestamp.
*/
wallTime: TimeSinceEpoch;
/**
- * WebSocket request data.
+ * Request initiator.
*/
- request: WebSocketRequest;
+ initiator: Initiator;
+ /**
+ * In the case that redirectResponse is populated, this flag indicates whether
+requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be or were emitted
+for the request which was just redirected.
+ */
+ redirectHasExtraInfo: boolean;
+ /**
+ * Redirect response data.
+ */
+ redirectResponse?: Response;
+ /**
+ * Type of this resource.
+ */
+ type?: ResourceType;
+ /**
+ * Frame identifier.
+ */
+ frameId?: Page.FrameId;
+ /**
+ * Whether the request is initiated by a user gesture. Defaults to false.
+ */
+ hasUserGesture?: boolean;
}
/**
- * Fired upon WebTransport creation.
+ * Fired when resource loading priority is changed
*/
- export type webTransportCreatedPayload = {
+ export type resourceChangedPriorityPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
/**
- * WebTransport request URL.
+ * New priority
*/
- url: string;
+ newPriority: ResourcePriority;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
+ }
+ /**
+ * Fired when a signed exchange was received over the network
+ */
+ export type signedExchangeReceivedPayload = {
/**
- * Request initiator.
+ * Request identifier.
*/
- initiator?: Initiator;
+ requestId: RequestId;
+ /**
+ * Information about the signed exchange response.
+ */
+ info: SignedExchangeInfo;
}
/**
- * Fired when WebTransport handshake is finished.
+ * Fired when HTTP response is available.
*/
- export type webTransportConnectionEstablishedPayload = {
+ export type responseReceivedPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
+ /**
+ * Loader identifier. Empty string if the request is fetched from worker.
+ */
+ loaderId: LoaderId;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
+ /**
+ * Resource type.
+ */
+ type: ResourceType;
+ /**
+ * Response data.
+ */
+ response: Response;
+ /**
+ * Indicates whether requestWillBeSentExtraInfo and responseReceivedExtraInfo events will be
+or were emitted for this request.
+ */
+ hasExtraInfo: boolean;
+ /**
+ * Frame identifier.
+ */
+ frameId?: Page.FrameId;
}
/**
- * Fired when WebTransport is disposed.
+ * Fired when WebSocket is closed.
*/
- export type webTransportClosedPayload = {
+ export type webSocketClosedPayload = {
/**
- * WebTransport identifier.
+ * Request identifier.
*/
- transportId: RequestId;
+ requestId: RequestId;
/**
* Timestamp.
*/
timestamp: MonotonicTime;
}
/**
- * Fired upon direct_socket.TCPSocket creation.
+ * Fired upon WebSocket creation.
*/
- export type directTCPSocketCreatedPayload = {
- identifier: RequestId;
- remoteAddr: string;
+ export type webSocketCreatedPayload = {
/**
- * Unsigned int 16.
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * WebSocket request URL.
+ */
+ url: string;
+ /**
+ * Request initiator.
*/
- remotePort: number;
- options: DirectTCPSocketOptions;
- timestamp: MonotonicTime;
initiator?: Initiator;
}
/**
- * Fired when direct_socket.TCPSocket connection is opened.
+ * Fired when WebSocket message error occurs.
*/
- export type directTCPSocketOpenedPayload = {
- identifier: RequestId;
- remoteAddr: string;
+ export type webSocketFrameErrorPayload = {
/**
- * Expected to be unsigned integer.
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
*/
- remotePort: number;
timestamp: MonotonicTime;
- localAddr?: string;
/**
- * Expected to be unsigned integer.
+ * WebSocket error message.
*/
- localPort?: number;
+ errorMessage: string;
}
/**
- * Fired when direct_socket.TCPSocket is aborted.
+ * Fired when WebSocket message is received.
+ */
+ export type webSocketFrameReceivedPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketFrame;
+ }
+ /**
+ * Fired when WebSocket message is sent.
+ */
+ export type webSocketFrameSentPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketFrame;
+ }
+ /**
+ * Fired when WebSocket handshake response becomes available.
+ */
+ export type webSocketHandshakeResponseReceivedPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * WebSocket response data.
+ */
+ response: WebSocketResponse;
+ }
+ /**
+ * Fired when WebSocket is about to initiate handshake.
+ */
+ export type webSocketWillSendHandshakeRequestPayload = {
+ /**
+ * Request identifier.
+ */
+ requestId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * UTC Timestamp.
+ */
+ wallTime: TimeSinceEpoch;
+ /**
+ * WebSocket request data.
+ */
+ request: WebSocketRequest;
+ }
+ /**
+ * Fired upon WebTransport creation.
+ */
+ export type webTransportCreatedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * WebTransport request URL.
+ */
+ url: string;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ /**
+ * Request initiator.
+ */
+ initiator?: Initiator;
+ }
+ /**
+ * Fired when WebTransport handshake is finished.
+ */
+ export type webTransportConnectionEstablishedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ }
+ /**
+ * Fired when WebTransport is disposed.
+ */
+ export type webTransportClosedPayload = {
+ /**
+ * WebTransport identifier.
+ */
+ transportId: RequestId;
+ /**
+ * Timestamp.
+ */
+ timestamp: MonotonicTime;
+ }
+ /**
+ * Fired upon direct_socket.TCPSocket creation.
+ */
+ export type directTCPSocketCreatedPayload = {
+ identifier: RequestId;
+ remoteAddr: string;
+ /**
+ * Unsigned int 16.
+ */
+ remotePort: number;
+ options: DirectTCPSocketOptions;
+ timestamp: MonotonicTime;
+ initiator?: Initiator;
+ }
+ /**
+ * Fired when direct_socket.TCPSocket connection is opened.
+ */
+ export type directTCPSocketOpenedPayload = {
+ identifier: RequestId;
+ remoteAddr: string;
+ /**
+ * Expected to be unsigned integer.
+ */
+ remotePort: number;
+ timestamp: MonotonicTime;
+ localAddr?: string;
+ /**
+ * Expected to be unsigned integer.
+ */
+ localPort?: number;
+ }
+ /**
+ * Fired when direct_socket.TCPSocket is aborted.
*/
export type directTCPSocketAbortedPayload = {
identifier: RequestId;
@@ -10688,6 +11832,18 @@ And after 'enableReportingApi' for all existing reports.
endpoints: ReportingApiEndpoint[];
}
+ /**
+ * Returns enum representing if IP Proxy of requests is available
+or reason it is not active.
+ */
+ export type getIPProtectionProxyStatusParameters = {
+ }
+ export type getIPProtectionProxyStatusReturnValue = {
+ /**
+ * Whether IP proxy is available
+ */
+ status: IpProxyStatus;
+ }
/**
* Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted.
*/
@@ -10894,6 +12050,12 @@ all partition key attributes match the cookie partition key attribute.
* Whether DirectSocket chunk send/receive events should be reported.
*/
reportDirectSocketTraffic?: boolean;
+ /**
+ * Enable storing response bodies outside of renderer, so that these survive
+a cross-process navigation. Requires maxTotalBufferSize to be set.
+Currently defaults to false.
+ */
+ enableDurableMessages?: boolean;
}
export type enableReturnValue = {
}
@@ -11879,6 +13041,9 @@ objectId must be specified.
}
/**
* Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport.
+Issue: the method does not handle device pixel ratio (DPR) correctly.
+The coordinates currently have to be adjusted by the client
+if DPR is not 1 (see crbug.com/437807128).
*/
export type highlightRectParameters = {
/**
@@ -12124,53 +13289,223 @@ Backend then generates 'inspectNodeRequested' event upon element selection.
}
/**
- * Actions and events related to the inspected page belong to the page domain.
+ * This domain allows interacting with the browser to control PWAs.
*/
- export module Page {
+ export module PWA {
/**
- * Unique frame identifier.
+ * The following types are the replica of
+https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
*/
- export type FrameId = string;
+ export interface FileHandlerAccept {
+ /**
+ * New name of the mimetype according to
+https://www.iana.org/assignments/media-types/media-types.xhtml
+ */
+ mediaType: string;
+ fileExtensions: string[];
+ }
+ export interface FileHandler {
+ action: string;
+ accepts: FileHandlerAccept[];
+ displayName: string;
+ }
/**
- * Indicates whether a frame has been identified as an ad.
+ * If user prefers opening the app in browser or an app window.
*/
- export type AdFrameType = "none"|"child"|"root";
- export type AdFrameExplanation = "ParentIsAd"|"CreatedByAdScript"|"MatchedBlockingRule";
+ export type DisplayMode = "standalone"|"browser";
+
+
/**
- * Indicates whether a frame has been identified as an ad and why.
+ * Returns the following OS state for the given manifest id.
*/
- export interface AdFrameStatus {
- adFrameType: AdFrameType;
- explanations?: AdFrameExplanation[];
+ export type getOsAppStateParameters = {
+ /**
+ * The id from the webapp's manifest file, commonly it's the url of the
+site installing the webapp. See
+https://web.dev/learn/pwa/web-app-manifest.
+ */
+ manifestId: string;
+ }
+ export type getOsAppStateReturnValue = {
+ badgeCount: number;
+ fileHandlers: FileHandler[];
}
/**
- * Identifies the script which caused a script or frame to be labelled as an
-ad.
+ * Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
+
+IWA-specific install description:
+manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
+
+File installation mode:
+The installUrlOrBundleUrl can be either file:// or http(s):// pointing
+to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to
+The .swbn file's signing key.
+
+Dev proxy installation mode:
+installUrlOrBundleUrl must be http(s):// that serves dev mode IWA.
+web_package::SignedWebBundleId must be of type dev proxy.
+
+The advantage of dev proxy mode is that all changes to IWA
+automatically will be reflected in the running app without
+reinstallation.
+
+To generate bundle id for proxy mode:
+1. Generate 32 random bytes.
+2. Add a specific suffix 0x00 at the end.
+3. Encode the entire sequence using Base32 without padding.
+
+If Chrome is not in IWA dev
+mode, the installation will fail, regardless of the state of the allowlist.
*/
- export interface AdScriptId {
- /**
- * Script Id of the script which caused a script or frame to be labelled as
-an ad.
- */
- scriptId: Runtime.ScriptId;
+ export type installParameters = {
+ manifestId: string;
/**
- * Id of scriptId's debugger.
+ * The location of the app or bundle overriding the one derived from the
+manifestId.
*/
- debuggerId: Runtime.UniqueDebuggerId;
+ installUrlOrBundleUrl?: string;
+ }
+ export type installReturnValue = {
}
/**
- * Encapsulates the script ancestry and the root script filterlist rule that
-caused the frame to be labelled as an ad. Only created when `ancestryChain`
-is not empty.
+ * Uninstalls the given manifest_id and closes any opened app windows.
*/
- export interface AdScriptAncestry {
- /**
- * A chain of `AdScriptId`s representing the ancestry of an ad script that
-led to the creation of a frame. The chain is ordered from the script
-itself (lower level) up to its root ancestor that was flagged by
-filterlist.
- */
- ancestryChain: AdScriptId[];
+ export type uninstallParameters = {
+ manifestId: string;
+ }
+ export type uninstallReturnValue = {
+ }
+ /**
+ * Launches the installed web app, or an url in the same web app instead of the
+default start url if it is provided. Returns a page Target.TargetID which
+can be used to attach to via Target.attachToTarget or similar APIs.
+ */
+ export type launchParameters = {
+ manifestId: string;
+ url?: string;
+ }
+ export type launchReturnValue = {
+ /**
+ * ID of the tab target created as a result.
+ */
+ targetId: Target.TargetID;
+ }
+ /**
+ * Opens one or more local files from an installed web app identified by its
+manifestId. The web app needs to have file handlers registered to process
+the files. The API returns one or more page Target.TargetIDs which can be
+used to attach to via Target.attachToTarget or similar APIs.
+If some files in the parameters cannot be handled by the web app, they will
+be ignored. If none of the files can be handled, this API returns an error.
+If no files are provided as the parameter, this API also returns an error.
+
+According to the definition of the file handlers in the manifest file, one
+Target.TargetID may represent a page handling one or more files. The order
+of the returned Target.TargetIDs is not guaranteed.
+
+TODO(crbug.com/339454034): Check the existences of the input files.
+ */
+ export type launchFilesInAppParameters = {
+ manifestId: string;
+ files: string[];
+ }
+ export type launchFilesInAppReturnValue = {
+ /**
+ * IDs of the tab targets created as the result.
+ */
+ targetIds: Target.TargetID[];
+ }
+ /**
+ * Opens the current page in its web app identified by the manifest id, needs
+to be called on a page target. This function returns immediately without
+waiting for the app to finish loading.
+ */
+ export type openCurrentPageInAppParameters = {
+ manifestId: string;
+ }
+ export type openCurrentPageInAppReturnValue = {
+ }
+ /**
+ * Changes user settings of the web app identified by its manifestId. If the
+app was not installed, this command returns an error. Unset parameters will
+be ignored; unrecognized values will cause an error.
+
+Unlike the ones defined in the manifest files of the web apps, these
+settings are provided by the browser and controlled by the users, they
+impact the way the browser handling the web apps.
+
+See the comment of each parameter.
+ */
+ export type changeAppUserSettingsParameters = {
+ manifestId: string;
+ /**
+ * If user allows the links clicked on by the user in the app's scope, or
+extended scope if the manifest has scope extensions and the flags
+`DesktopPWAsLinkCapturingWithScopeExtensions` and
+`WebAppEnableScopeExtensions` are enabled.
+
+Note, the API does not support resetting the linkCapturing to the
+initial value, uninstalling and installing the web app again will reset
+it.
+
+TODO(crbug.com/339453269): Setting this value on ChromeOS is not
+supported yet.
+ */
+ linkCapturing?: boolean;
+ displayMode?: DisplayMode;
+ }
+ export type changeAppUserSettingsReturnValue = {
+ }
+ }
+
+ /**
+ * Actions and events related to the inspected page belong to the page domain.
+ */
+ export module Page {
+ /**
+ * Unique frame identifier.
+ */
+ export type FrameId = string;
+ /**
+ * Indicates whether a frame has been identified as an ad.
+ */
+ export type AdFrameType = "none"|"child"|"root";
+ export type AdFrameExplanation = "ParentIsAd"|"CreatedByAdScript"|"MatchedBlockingRule";
+ /**
+ * Indicates whether a frame has been identified as an ad and why.
+ */
+ export interface AdFrameStatus {
+ adFrameType: AdFrameType;
+ explanations?: AdFrameExplanation[];
+ }
+ /**
+ * Identifies the script which caused a script or frame to be labelled as an
+ad.
+ */
+ export interface AdScriptId {
+ /**
+ * Script Id of the script which caused a script or frame to be labelled as
+an ad.
+ */
+ scriptId: Runtime.ScriptId;
+ /**
+ * Id of scriptId's debugger.
+ */
+ debuggerId: Runtime.UniqueDebuggerId;
+ }
+ /**
+ * Encapsulates the script ancestry and the root script filterlist rule that
+caused the frame to be labelled as an ad. Only created when `ancestryChain`
+is not empty.
+ */
+ export interface AdScriptAncestry {
+ /**
+ * A chain of `AdScriptId`s representing the ancestry of an ad script that
+led to the creation of a frame. The chain is ordered from the script
+itself (lower level) up to its root ancestor that was flagged by
+filterlist.
+ */
+ ancestryChain: AdScriptId[];
/**
* The filterlist rule that caused the root (last) script in
`ancestryChain` to be ad-tagged. Only populated if the rule is
@@ -12192,7 +13527,7 @@ available.
in services/network/public/cpp/permissions_policy/permissions_policy_features.json5.
LINT.IfChange(PermissionsPolicyFeature)
*/
- export type PermissionsPolicyFeature = "accelerometer"|"all-screens-capture"|"ambient-light-sensor"|"aria-notify"|"attribution-reporting"|"autoplay"|"bluetooth"|"browsing-topics"|"camera"|"captured-surface-control"|"ch-dpr"|"ch-device-memory"|"ch-downlink"|"ch-ect"|"ch-prefers-color-scheme"|"ch-prefers-reduced-motion"|"ch-prefers-reduced-transparency"|"ch-rtt"|"ch-save-data"|"ch-ua"|"ch-ua-arch"|"ch-ua-bitness"|"ch-ua-high-entropy-values"|"ch-ua-platform"|"ch-ua-model"|"ch-ua-mobile"|"ch-ua-form-factors"|"ch-ua-full-version"|"ch-ua-full-version-list"|"ch-ua-platform-version"|"ch-ua-wow64"|"ch-viewport-height"|"ch-viewport-width"|"ch-width"|"clipboard-read"|"clipboard-write"|"compute-pressure"|"controlled-frame"|"cross-origin-isolated"|"deferred-fetch"|"deferred-fetch-minimal"|"device-attributes"|"digital-credentials-get"|"direct-sockets"|"direct-sockets-private"|"display-capture"|"document-domain"|"encrypted-media"|"execution-while-out-of-viewport"|"execution-while-not-rendered"|"fenced-unpartitioned-storage-read"|"focus-without-user-activation"|"fullscreen"|"frobulate"|"gamepad"|"geolocation"|"gyroscope"|"hid"|"identity-credentials-get"|"idle-detection"|"interest-cohort"|"join-ad-interest-group"|"keyboard-map"|"language-detector"|"language-model"|"local-fonts"|"local-network-access"|"magnetometer"|"media-playback-while-not-visible"|"microphone"|"midi"|"on-device-speech-recognition"|"otp-credentials"|"payment"|"picture-in-picture"|"popins"|"private-aggregation"|"private-state-token-issuance"|"private-state-token-redemption"|"publickey-credentials-create"|"publickey-credentials-get"|"record-ad-auction-events"|"rewriter"|"run-ad-auction"|"screen-wake-lock"|"serial"|"shared-autofill"|"shared-storage"|"shared-storage-select-url"|"smart-card"|"speaker-selection"|"storage-access"|"sub-apps"|"summarizer"|"sync-xhr"|"translator"|"unload"|"usb"|"usb-unrestricted"|"vertical-scroll"|"web-app-installation"|"web-printing"|"web-share"|"window-management"|"writer"|"xr-spatial-tracking";
+ export type PermissionsPolicyFeature = "accelerometer"|"all-screens-capture"|"ambient-light-sensor"|"aria-notify"|"attribution-reporting"|"autoplay"|"bluetooth"|"browsing-topics"|"camera"|"captured-surface-control"|"ch-dpr"|"ch-device-memory"|"ch-downlink"|"ch-ect"|"ch-prefers-color-scheme"|"ch-prefers-reduced-motion"|"ch-prefers-reduced-transparency"|"ch-rtt"|"ch-save-data"|"ch-ua"|"ch-ua-arch"|"ch-ua-bitness"|"ch-ua-high-entropy-values"|"ch-ua-platform"|"ch-ua-model"|"ch-ua-mobile"|"ch-ua-form-factors"|"ch-ua-full-version"|"ch-ua-full-version-list"|"ch-ua-platform-version"|"ch-ua-wow64"|"ch-viewport-height"|"ch-viewport-width"|"ch-width"|"clipboard-read"|"clipboard-write"|"compute-pressure"|"controlled-frame"|"cross-origin-isolated"|"deferred-fetch"|"deferred-fetch-minimal"|"device-attributes"|"digital-credentials-create"|"digital-credentials-get"|"direct-sockets"|"direct-sockets-private"|"display-capture"|"document-domain"|"encrypted-media"|"execution-while-out-of-viewport"|"execution-while-not-rendered"|"fenced-unpartitioned-storage-read"|"focus-without-user-activation"|"fullscreen"|"frobulate"|"gamepad"|"geolocation"|"gyroscope"|"hid"|"identity-credentials-get"|"idle-detection"|"interest-cohort"|"join-ad-interest-group"|"keyboard-map"|"language-detector"|"language-model"|"local-fonts"|"local-network-access"|"magnetometer"|"media-playback-while-not-visible"|"microphone"|"midi"|"on-device-speech-recognition"|"otp-credentials"|"payment"|"picture-in-picture"|"popins"|"private-aggregation"|"private-state-token-issuance"|"private-state-token-redemption"|"publickey-credentials-create"|"publickey-credentials-get"|"record-ad-auction-events"|"rewriter"|"run-ad-auction"|"screen-wake-lock"|"serial"|"shared-autofill"|"shared-storage"|"shared-storage-select-url"|"smart-card"|"speaker-selection"|"storage-access"|"sub-apps"|"summarizer"|"sync-xhr"|"translator"|"unload"|"usb"|"usb-unrestricted"|"vertical-scroll"|"web-app-installation"|"web-printing"|"web-share"|"window-management"|"writer"|"xr-spatial-tracking";
/**
* Reason for a permissions policy feature to be disabled.
*/
@@ -12791,7 +14126,7 @@ https://github.com/WICG/manifest-incubations/blob/gh-pages/scope_extensions-expl
/**
* List of not restored reasons for back-forward cache.
*/
- export type BackForwardCacheNotRestoredReason = "NotPrimaryMainFrame"|"BackForwardCacheDisabled"|"RelatedActiveContentsExist"|"HTTPStatusNotOK"|"SchemeNotHTTPOrHTTPS"|"Loading"|"WasGrantedMediaAccess"|"DisableForRenderFrameHostCalled"|"DomainNotAllowed"|"HTTPMethodNotGET"|"SubframeIsNavigating"|"Timeout"|"CacheLimit"|"JavaScriptExecution"|"RendererProcessKilled"|"RendererProcessCrashed"|"SchedulerTrackedFeatureUsed"|"ConflictingBrowsingInstance"|"CacheFlushed"|"ServiceWorkerVersionActivation"|"SessionRestored"|"ServiceWorkerPostMessage"|"EnteredBackForwardCacheBeforeServiceWorkerHostAdded"|"RenderFrameHostReused_SameSite"|"RenderFrameHostReused_CrossSite"|"ServiceWorkerClaim"|"IgnoreEventAndEvict"|"HaveInnerContents"|"TimeoutPuttingInCache"|"BackForwardCacheDisabledByLowMemory"|"BackForwardCacheDisabledByCommandLine"|"NetworkRequestDatapipeDrainedAsBytesConsumer"|"NetworkRequestRedirected"|"NetworkRequestTimeout"|"NetworkExceedsBufferLimit"|"NavigationCancelledWhileRestoring"|"NotMostRecentNavigationEntry"|"BackForwardCacheDisabledForPrerender"|"UserAgentOverrideDiffers"|"ForegroundCacheLimit"|"BrowsingInstanceNotSwapped"|"BackForwardCacheDisabledForDelegate"|"UnloadHandlerExistsInMainFrame"|"UnloadHandlerExistsInSubFrame"|"ServiceWorkerUnregistration"|"CacheControlNoStore"|"CacheControlNoStoreCookieModified"|"CacheControlNoStoreHTTPOnlyCookieModified"|"NoResponseHead"|"Unknown"|"ActivationNavigationsDisallowedForBug1234857"|"ErrorDocument"|"FencedFramesEmbedder"|"CookieDisabled"|"HTTPAuthRequired"|"CookieFlushed"|"BroadcastChannelOnMessage"|"WebViewSettingsChanged"|"WebViewJavaScriptObjectChanged"|"WebViewMessageListenerInjected"|"WebViewSafeBrowsingAllowlistChanged"|"WebViewDocumentStartJavascriptChanged"|"WebSocket"|"WebTransport"|"WebRTC"|"MainResourceHasCacheControlNoStore"|"MainResourceHasCacheControlNoCache"|"SubresourceHasCacheControlNoStore"|"SubresourceHasCacheControlNoCache"|"ContainsPlugins"|"DocumentLoaded"|"OutstandingNetworkRequestOthers"|"RequestedMIDIPermission"|"RequestedAudioCapturePermission"|"RequestedVideoCapturePermission"|"RequestedBackForwardCacheBlockedSensors"|"RequestedBackgroundWorkPermission"|"BroadcastChannel"|"WebXR"|"SharedWorker"|"SharedWorkerMessage"|"WebLocks"|"WebHID"|"WebShare"|"RequestedStorageAccessGrant"|"WebNfc"|"OutstandingNetworkRequestFetch"|"OutstandingNetworkRequestXHR"|"AppBanner"|"Printing"|"WebDatabase"|"PictureInPicture"|"SpeechRecognizer"|"IdleManager"|"PaymentManager"|"SpeechSynthesis"|"KeyboardLock"|"WebOTPService"|"OutstandingNetworkRequestDirectSocket"|"InjectedJavascript"|"InjectedStyleSheet"|"KeepaliveRequest"|"IndexedDBEvent"|"Dummy"|"JsNetworkRequestReceivedCacheControlNoStoreResource"|"WebRTCSticky"|"WebTransportSticky"|"WebSocketSticky"|"SmartCard"|"LiveMediaStreamTrack"|"UnloadHandler"|"ParserAborted"|"ContentSecurityHandler"|"ContentWebAuthenticationAPI"|"ContentFileChooser"|"ContentSerial"|"ContentFileSystemAccess"|"ContentMediaDevicesDispatcherHost"|"ContentWebBluetooth"|"ContentWebUSB"|"ContentMediaSessionService"|"ContentScreenReader"|"ContentDiscarded"|"EmbedderPopupBlockerTabHelper"|"EmbedderSafeBrowsingTriggeredPopupBlocker"|"EmbedderSafeBrowsingThreatDetails"|"EmbedderAppBannerManager"|"EmbedderDomDistillerViewerSource"|"EmbedderDomDistillerSelfDeletingRequestDelegate"|"EmbedderOomInterventionTabHelper"|"EmbedderOfflinePage"|"EmbedderChromePasswordManagerClientBindCredentialManager"|"EmbedderPermissionRequestManager"|"EmbedderModalDialog"|"EmbedderExtensions"|"EmbedderExtensionMessaging"|"EmbedderExtensionMessagingForOpenPort"|"EmbedderExtensionSentMessageToCachedFrame"|"RequestedByWebViewClient"|"PostMessageByWebViewClient"|"CacheControlNoStoreDeviceBoundSessionTerminated"|"CacheLimitPrunedOnModerateMemoryPressure"|"CacheLimitPrunedOnCriticalMemoryPressure";
+ export type BackForwardCacheNotRestoredReason = "NotPrimaryMainFrame"|"BackForwardCacheDisabled"|"RelatedActiveContentsExist"|"HTTPStatusNotOK"|"SchemeNotHTTPOrHTTPS"|"Loading"|"WasGrantedMediaAccess"|"DisableForRenderFrameHostCalled"|"DomainNotAllowed"|"HTTPMethodNotGET"|"SubframeIsNavigating"|"Timeout"|"CacheLimit"|"JavaScriptExecution"|"RendererProcessKilled"|"RendererProcessCrashed"|"SchedulerTrackedFeatureUsed"|"ConflictingBrowsingInstance"|"CacheFlushed"|"ServiceWorkerVersionActivation"|"SessionRestored"|"ServiceWorkerPostMessage"|"EnteredBackForwardCacheBeforeServiceWorkerHostAdded"|"RenderFrameHostReused_SameSite"|"RenderFrameHostReused_CrossSite"|"ServiceWorkerClaim"|"IgnoreEventAndEvict"|"HaveInnerContents"|"TimeoutPuttingInCache"|"BackForwardCacheDisabledByLowMemory"|"BackForwardCacheDisabledByCommandLine"|"NetworkRequestDatapipeDrainedAsBytesConsumer"|"NetworkRequestRedirected"|"NetworkRequestTimeout"|"NetworkExceedsBufferLimit"|"NavigationCancelledWhileRestoring"|"NotMostRecentNavigationEntry"|"BackForwardCacheDisabledForPrerender"|"UserAgentOverrideDiffers"|"ForegroundCacheLimit"|"BrowsingInstanceNotSwapped"|"BackForwardCacheDisabledForDelegate"|"UnloadHandlerExistsInMainFrame"|"UnloadHandlerExistsInSubFrame"|"ServiceWorkerUnregistration"|"CacheControlNoStore"|"CacheControlNoStoreCookieModified"|"CacheControlNoStoreHTTPOnlyCookieModified"|"NoResponseHead"|"Unknown"|"ActivationNavigationsDisallowedForBug1234857"|"ErrorDocument"|"FencedFramesEmbedder"|"CookieDisabled"|"HTTPAuthRequired"|"CookieFlushed"|"BroadcastChannelOnMessage"|"WebViewSettingsChanged"|"WebViewJavaScriptObjectChanged"|"WebViewMessageListenerInjected"|"WebViewSafeBrowsingAllowlistChanged"|"WebViewDocumentStartJavascriptChanged"|"WebSocket"|"WebTransport"|"WebRTC"|"MainResourceHasCacheControlNoStore"|"MainResourceHasCacheControlNoCache"|"SubresourceHasCacheControlNoStore"|"SubresourceHasCacheControlNoCache"|"ContainsPlugins"|"DocumentLoaded"|"OutstandingNetworkRequestOthers"|"RequestedMIDIPermission"|"RequestedAudioCapturePermission"|"RequestedVideoCapturePermission"|"RequestedBackForwardCacheBlockedSensors"|"RequestedBackgroundWorkPermission"|"BroadcastChannel"|"WebXR"|"SharedWorker"|"SharedWorkerMessage"|"WebLocks"|"WebHID"|"WebShare"|"RequestedStorageAccessGrant"|"WebNfc"|"OutstandingNetworkRequestFetch"|"OutstandingNetworkRequestXHR"|"AppBanner"|"Printing"|"WebDatabase"|"PictureInPicture"|"SpeechRecognizer"|"IdleManager"|"PaymentManager"|"SpeechSynthesis"|"KeyboardLock"|"WebOTPService"|"OutstandingNetworkRequestDirectSocket"|"InjectedJavascript"|"InjectedStyleSheet"|"KeepaliveRequest"|"IndexedDBEvent"|"Dummy"|"JsNetworkRequestReceivedCacheControlNoStoreResource"|"WebRTCUsedWithCCNS"|"WebTransportUsedWithCCNS"|"WebSocketUsedWithCCNS"|"SmartCard"|"LiveMediaStreamTrack"|"UnloadHandler"|"ParserAborted"|"ContentSecurityHandler"|"ContentWebAuthenticationAPI"|"ContentFileChooser"|"ContentSerial"|"ContentFileSystemAccess"|"ContentMediaDevicesDispatcherHost"|"ContentWebBluetooth"|"ContentWebUSB"|"ContentMediaSessionService"|"ContentScreenReader"|"ContentDiscarded"|"EmbedderPopupBlockerTabHelper"|"EmbedderSafeBrowsingTriggeredPopupBlocker"|"EmbedderSafeBrowsingThreatDetails"|"EmbedderAppBannerManager"|"EmbedderDomDistillerViewerSource"|"EmbedderDomDistillerSelfDeletingRequestDelegate"|"EmbedderOomInterventionTabHelper"|"EmbedderOfflinePage"|"EmbedderChromePasswordManagerClientBindCredentialManager"|"EmbedderPermissionRequestManager"|"EmbedderModalDialog"|"EmbedderExtensions"|"EmbedderExtensionMessaging"|"EmbedderExtensionMessagingForOpenPort"|"EmbedderExtensionSentMessageToCachedFrame"|"RequestedByWebViewClient"|"PostMessageByWebViewClient"|"CacheControlNoStoreDeviceBoundSessionTerminated"|"CacheLimitPrunedOnModerateMemoryPressure"|"CacheLimitPrunedOnCriticalMemoryPressure";
/**
* Types of not restored reasons for back-forward cache.
*/
@@ -14394,108 +15729,292 @@ Note that not all types exposed to the web platform are currently supported.
}
}
- /**
- * Security
- */
- export module Security {
- /**
- * An internal certificate ID value.
- */
- export type CertificateId = number;
- /**
- * A description of mixed content (HTTP resources on HTTPS pages), as defined by
-https://www.w3.org/TR/mixed-content/#categories
- */
- export type MixedContentType = "blockable"|"optionally-blockable"|"none";
+ export module Preload {
/**
- * The security level of a page or resource.
+ * Unique id
*/
- export type SecurityState = "unknown"|"neutral"|"insecure"|"secure"|"info"|"insecure-broken";
+ export type RuleSetId = string;
/**
- * Details about the security state of the page certificate.
+ * Corresponds to SpeculationRuleSet
*/
- export interface CertificateSecurityState {
- /**
- * Protocol name (e.g. "TLS 1.2" or "QUIC").
- */
- protocol: string;
- /**
- * Key Exchange used by the connection, or the empty string if not applicable.
- */
- keyExchange: string;
- /**
- * (EC)DH group used by the connection, if applicable.
- */
- keyExchangeGroup?: string;
- /**
- * Cipher name.
- */
- cipher: string;
- /**
- * TLS MAC. Note that AEAD ciphers do not have separate MACs.
- */
- mac?: string;
- /**
- * Page certificate.
- */
- certificate: string[];
- /**
- * Certificate subject name.
- */
- subjectName: string;
- /**
- * Name of the issuing CA.
- */
- issuer: string;
- /**
- * Certificate valid from date.
- */
- validFrom: Network.TimeSinceEpoch;
- /**
- * Certificate valid to (expiration) date
- */
- validTo: Network.TimeSinceEpoch;
- /**
- * The highest priority network error code, if the certificate has an error.
- */
- certificateNetworkError?: string;
- /**
- * True if the certificate uses a weak signature algorithm.
- */
- certificateHasWeakSignature: boolean;
- /**
- * True if the certificate has a SHA1 signature in the chain.
- */
- certificateHasSha1Signature: boolean;
+ export interface RuleSet {
+ id: RuleSetId;
/**
- * True if modern SSL
+ * Identifies a document which the rule set is associated with.
*/
- modernSSL: boolean;
+ loaderId: Network.LoaderId;
/**
- * True if the connection is using an obsolete SSL protocol.
+ * Source text of JSON representing the rule set. If it comes from
+`<script>` tag, it is the textContent of the node. Note that it is
+a JSON for valid case.
+
+See also:
+- https://wicg.github.io/nav-speculation/speculation-rules.html
+- https://github.com/WICG/nav-speculation/blob/main/triggers.md
*/
- obsoleteSslProtocol: boolean;
+ sourceText: string;
/**
- * True if the connection is using an obsolete SSL key exchange.
+ * A speculation rule set is either added through an inline
+`<script>` tag or through an external resource via the
+'Speculation-Rules' HTTP header. For the first case, we include
+the BackendNodeId of the relevant `<script>` tag. For the second
+case, we include the external URL where the rule set was loaded
+from, and also RequestId if Network domain is enabled.
+
+See also:
+- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
+- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
*/
- obsoleteSslKeyExchange: boolean;
+ backendNodeId?: DOM.BackendNodeId;
+ url?: string;
+ requestId?: Network.RequestId;
/**
- * True if the connection is using an obsolete SSL cipher.
+ * Error information
+`errorMessage` is null iff `errorType` is null.
*/
- obsoleteSslCipher: boolean;
+ errorType?: RuleSetErrorType;
/**
- * True if the connection is using an obsolete SSL signature.
+ * TODO(https://crbug.com/1425354): Replace this property with structured error.
*/
- obsoleteSslSignature: boolean;
+ errorMessage?: string;
}
- export type SafetyTipStatus = "badReputation"|"lookalike";
- export interface SafetyTipInfo {
- /**
- * Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
- */
- safetyTipStatus: SafetyTipStatus;
- /**
- * The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
+ export type RuleSetErrorType = "SourceIsNotJsonObject"|"InvalidRulesSkipped"|"InvalidRulesetLevelTag";
+ /**
+ * The type of preloading attempted. It corresponds to
+mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
+isn't being used by clients).
+ */
+ export type SpeculationAction = "Prefetch"|"Prerender";
+ /**
+ * Corresponds to mojom::SpeculationTargetHint.
+See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
+ */
+ export type SpeculationTargetHint = "Blank"|"Self";
+ /**
+ * A key that identifies a preloading attempt.
+
+The url used is the url specified by the trigger (i.e. the initial URL), and
+not the final url that is navigated to. For example, prerendering allows
+same-origin main frame navigations during the attempt, but the attempt is
+still keyed with the initial URL.
+ */
+ export interface PreloadingAttemptKey {
+ loaderId: Network.LoaderId;
+ action: SpeculationAction;
+ url: string;
+ targetHint?: SpeculationTargetHint;
+ }
+ /**
+ * Lists sources for a preloading attempt, specifically the ids of rule sets
+that had a speculation rule that triggered the attempt, and the
+BackendNodeIds of <a href> or <area href> elements that triggered the
+attempt (in the case of attempts triggered by a document rule). It is
+possible for multiple rule sets and links to trigger a single attempt.
+ */
+ export interface PreloadingAttemptSource {
+ key: PreloadingAttemptKey;
+ ruleSetIds: RuleSetId[];
+ nodeIds: DOM.BackendNodeId[];
+ }
+ /**
+ * Chrome manages different types of preloads together using a
+concept of preloading pipeline. For example, if a site uses a
+SpeculationRules for prerender, Chrome first starts a prefetch and
+then upgrades it to prerender.
+
+CDP events for them are emitted separately but they share
+`PreloadPipelineId`.
+ */
+ export type PreloadPipelineId = string;
+ /**
+ * List of FinalStatus reasons for Prerender2.
+ */
+ export type PrerenderFinalStatus = "Activated"|"Destroyed"|"LowEndDevice"|"InvalidSchemeRedirect"|"InvalidSchemeNavigation"|"NavigationRequestBlockedByCsp"|"MojoBinderPolicy"|"RendererProcessCrashed"|"RendererProcessKilled"|"Download"|"TriggerDestroyed"|"NavigationNotCommitted"|"NavigationBadHttpStatus"|"ClientCertRequested"|"NavigationRequestNetworkError"|"CancelAllHostsForTesting"|"DidFailLoad"|"Stop"|"SslCertificateError"|"LoginAuthRequested"|"UaChangeRequiresReload"|"BlockedByClient"|"AudioOutputDeviceRequested"|"MixedContent"|"TriggerBackgrounded"|"MemoryLimitExceeded"|"DataSaverEnabled"|"TriggerUrlHasEffectiveUrl"|"ActivatedBeforeStarted"|"InactivePageRestriction"|"StartFailed"|"TimeoutBackgrounded"|"CrossSiteRedirectInInitialNavigation"|"CrossSiteNavigationInInitialNavigation"|"SameSiteCrossOriginRedirectNotOptInInInitialNavigation"|"SameSiteCrossOriginNavigationNotOptInInInitialNavigation"|"ActivationNavigationParameterMismatch"|"ActivatedInBackground"|"EmbedderHostDisallowed"|"ActivationNavigationDestroyedBeforeSuccess"|"TabClosedByUserGesture"|"TabClosedWithoutUserGesture"|"PrimaryMainFrameRendererProcessCrashed"|"PrimaryMainFrameRendererProcessKilled"|"ActivationFramePolicyNotCompatible"|"PreloadingDisabled"|"BatterySaverEnabled"|"ActivatedDuringMainFrameNavigation"|"PreloadingUnsupportedByWebContents"|"CrossSiteRedirectInMainFrameNavigation"|"CrossSiteNavigationInMainFrameNavigation"|"SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation"|"SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation"|"MemoryPressureOnTrigger"|"MemoryPressureAfterTriggered"|"PrerenderingDisabledByDevTools"|"SpeculationRuleRemoved"|"ActivatedWithAuxiliaryBrowsingContexts"|"MaxNumOfRunningEagerPrerendersExceeded"|"MaxNumOfRunningNonEagerPrerendersExceeded"|"MaxNumOfRunningEmbedderPrerendersExceeded"|"PrerenderingUrlHasEffectiveUrl"|"RedirectedPrerenderingUrlHasEffectiveUrl"|"ActivationUrlHasEffectiveUrl"|"JavaScriptInterfaceAdded"|"JavaScriptInterfaceRemoved"|"AllPrerenderingCanceled"|"WindowClosed"|"SlowNetwork"|"OtherPrerenderedPageActivated"|"V8OptimizerDisabled"|"PrerenderFailedDuringPrefetch"|"BrowsingDataRemoved"|"PrerenderHostReused";
+ /**
+ * Preloading status values, see also PreloadingTriggeringOutcome. This
+status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
+ */
+ export type PreloadingStatus = "Pending"|"Running"|"Ready"|"Success"|"Failure"|"NotSupported";
+ /**
+ * TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
+filter out the ones that aren't necessary to the developers.
+ */
+ export type PrefetchStatus = "PrefetchAllowed"|"PrefetchFailedIneligibleRedirect"|"PrefetchFailedInvalidRedirect"|"PrefetchFailedMIMENotSupported"|"PrefetchFailedNetError"|"PrefetchFailedNon2XX"|"PrefetchEvictedAfterBrowsingDataRemoved"|"PrefetchEvictedAfterCandidateRemoved"|"PrefetchEvictedForNewerPrefetch"|"PrefetchHeldback"|"PrefetchIneligibleRetryAfter"|"PrefetchIsPrivacyDecoy"|"PrefetchIsStale"|"PrefetchNotEligibleBrowserContextOffTheRecord"|"PrefetchNotEligibleDataSaverEnabled"|"PrefetchNotEligibleExistingProxy"|"PrefetchNotEligibleHostIsNonUnique"|"PrefetchNotEligibleNonDefaultStoragePartition"|"PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy"|"PrefetchNotEligibleSchemeIsNotHttps"|"PrefetchNotEligibleUserHasCookies"|"PrefetchNotEligibleUserHasServiceWorker"|"PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler"|"PrefetchNotEligibleRedirectFromServiceWorker"|"PrefetchNotEligibleRedirectToServiceWorker"|"PrefetchNotEligibleBatterySaverEnabled"|"PrefetchNotEligiblePreloadingDisabled"|"PrefetchNotFinishedInTime"|"PrefetchNotStarted"|"PrefetchNotUsedCookiesChanged"|"PrefetchProxyNotAvailable"|"PrefetchResponseUsed"|"PrefetchSuccessfulButNotUsed"|"PrefetchNotUsedProbeFailed";
+ /**
+ * Information of headers to be displayed when the header mismatch occurred.
+ */
+ export interface PrerenderMismatchedHeaders {
+ headerName: string;
+ initialValue?: string;
+ activationValue?: string;
+ }
+
+ /**
+ * Upsert. Currently, it is only emitted when a rule set added.
+ */
+ export type ruleSetUpdatedPayload = {
+ ruleSet: RuleSet;
+ }
+ export type ruleSetRemovedPayload = {
+ id: RuleSetId;
+ }
+ /**
+ * Fired when a preload enabled state is updated.
+ */
+ export type preloadEnabledStateUpdatedPayload = {
+ disabledByPreference: boolean;
+ disabledByDataSaver: boolean;
+ disabledByBatterySaver: boolean;
+ disabledByHoldbackPrefetchSpeculationRules: boolean;
+ disabledByHoldbackPrerenderSpeculationRules: boolean;
+ }
+ /**
+ * Fired when a prefetch attempt is updated.
+ */
+ export type prefetchStatusUpdatedPayload = {
+ key: PreloadingAttemptKey;
+ pipelineId: PreloadPipelineId;
+ /**
+ * The frame id of the frame initiating prefetch.
+ */
+ initiatingFrameId: Page.FrameId;
+ prefetchUrl: string;
+ status: PreloadingStatus;
+ prefetchStatus: PrefetchStatus;
+ requestId: Network.RequestId;
+ }
+ /**
+ * Fired when a prerender attempt is updated.
+ */
+ export type prerenderStatusUpdatedPayload = {
+ key: PreloadingAttemptKey;
+ pipelineId: PreloadPipelineId;
+ status: PreloadingStatus;
+ prerenderStatus?: PrerenderFinalStatus;
+ /**
+ * This is used to give users more information about the name of Mojo interface
+that is incompatible with prerender and has caused the cancellation of the attempt.
+ */
+ disallowedMojoInterface?: string;
+ mismatchedHeaders?: PrerenderMismatchedHeaders[];
+ }
+ /**
+ * Send a list of sources for all preloading attempts in a document.
+ */
+ export type preloadingAttemptSourcesUpdatedPayload = {
+ loaderId: Network.LoaderId;
+ preloadingAttemptSources: PreloadingAttemptSource[];
+ }
+
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ }
+
+ export module Security {
+ /**
+ * An internal certificate ID value.
+ */
+ export type CertificateId = number;
+ /**
+ * A description of mixed content (HTTP resources on HTTPS pages), as defined by
+https://www.w3.org/TR/mixed-content/#categories
+ */
+ export type MixedContentType = "blockable"|"optionally-blockable"|"none";
+ /**
+ * The security level of a page or resource.
+ */
+ export type SecurityState = "unknown"|"neutral"|"insecure"|"secure"|"info"|"insecure-broken";
+ /**
+ * Details about the security state of the page certificate.
+ */
+ export interface CertificateSecurityState {
+ /**
+ * Protocol name (e.g. "TLS 1.2" or "QUIC").
+ */
+ protocol: string;
+ /**
+ * Key Exchange used by the connection, or the empty string if not applicable.
+ */
+ keyExchange: string;
+ /**
+ * (EC)DH group used by the connection, if applicable.
+ */
+ keyExchangeGroup?: string;
+ /**
+ * Cipher name.
+ */
+ cipher: string;
+ /**
+ * TLS MAC. Note that AEAD ciphers do not have separate MACs.
+ */
+ mac?: string;
+ /**
+ * Page certificate.
+ */
+ certificate: string[];
+ /**
+ * Certificate subject name.
+ */
+ subjectName: string;
+ /**
+ * Name of the issuing CA.
+ */
+ issuer: string;
+ /**
+ * Certificate valid from date.
+ */
+ validFrom: Network.TimeSinceEpoch;
+ /**
+ * Certificate valid to (expiration) date
+ */
+ validTo: Network.TimeSinceEpoch;
+ /**
+ * The highest priority network error code, if the certificate has an error.
+ */
+ certificateNetworkError?: string;
+ /**
+ * True if the certificate uses a weak signature algorithm.
+ */
+ certificateHasWeakSignature: boolean;
+ /**
+ * True if the certificate has a SHA1 signature in the chain.
+ */
+ certificateHasSha1Signature: boolean;
+ /**
+ * True if modern SSL
+ */
+ modernSSL: boolean;
+ /**
+ * True if the connection is using an obsolete SSL protocol.
+ */
+ obsoleteSslProtocol: boolean;
+ /**
+ * True if the connection is using an obsolete SSL key exchange.
+ */
+ obsoleteSslKeyExchange: boolean;
+ /**
+ * True if the connection is using an obsolete SSL cipher.
+ */
+ obsoleteSslCipher: boolean;
+ /**
+ * True if the connection is using an obsolete SSL signature.
+ */
+ obsoleteSslSignature: boolean;
+ }
+ export type SafetyTipStatus = "badReputation"|"lookalike";
+ export interface SafetyTipInfo {
+ /**
+ * Describes whether the page triggers any safety tips or reputation warnings. Default is unknown.
+ */
+ safetyTipStatus: SafetyTipStatus;
+ /**
+ * The URL the safety tip suggested ("Did you mean?"). Only filled in for lookalike matches.
*/
safeUrl?: string;
}
@@ -16172,6 +17691,10 @@ supported.
* Frame id of originating window (is only set if target has an opener).
*/
openerFrameId?: Page.FrameId;
+ /**
+ * Id of the parent frame, only present for the "iframe" targets.
+ */
+ parentFrameId?: Page.FrameId;
browserContextId?: Browser.BrowserContextID;
/**
* Provides additional details for specific target types. For example, for
@@ -16886,1854 +18409,537 @@ are ignored.
}
/**
- * A domain for letting clients substitute browser's network layer with client code.
+ * This domain allows inspection of Web Audio API.
+https://webaudio.github.io/web-audio-api/
*/
- export module Fetch {
+ export module WebAudio {
/**
- * Unique request identifier.
-Note that this does not identify individual HTTP requests that are part of
-a network request.
+ * An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
*/
- export type RequestId = string;
+ export type GraphObjectId = string;
/**
- * Stages of the request to handle. Request will intercept before the request is
-sent. Response will intercept after the response is received (but before response
-body is received).
+ * Enum of BaseAudioContext types
*/
- export type RequestStage = "Request"|"Response";
- export interface RequestPattern {
- /**
- * Wildcards (`'*'` -> zero or more, `'?'` -> exactly one) are allowed. Escape character is
-backslash. Omitting is equivalent to `"*"`.
- */
- urlPattern?: string;
- /**
- * If set, only requests for matching resource types will be intercepted.
- */
- resourceType?: Network.ResourceType;
- /**
- * Stage at which to begin intercepting requests. Default is Request.
- */
- requestStage?: RequestStage;
- }
+ export type ContextType = "realtime"|"offline";
/**
- * Response HTTP header entry
+ * Enum of AudioContextState from the spec
*/
- export interface HeaderEntry {
- name: string;
- value: string;
- }
+ export type ContextState = "suspended"|"running"|"closed"|"interrupted";
/**
- * Authorization challenge for HTTP status code 401 or 407.
+ * Enum of AudioNode types
*/
- export interface AuthChallenge {
+ export type NodeType = string;
+ /**
+ * Enum of AudioNode::ChannelCountMode from the spec
+ */
+ export type ChannelCountMode = "clamped-max"|"explicit"|"max";
+ /**
+ * Enum of AudioNode::ChannelInterpretation from the spec
+ */
+ export type ChannelInterpretation = "discrete"|"speakers";
+ /**
+ * Enum of AudioParam types
+ */
+ export type ParamType = string;
+ /**
+ * Enum of AudioParam::AutomationRate from the spec
+ */
+ export type AutomationRate = "a-rate"|"k-rate";
+ /**
+ * Fields in AudioContext that change in real-time.
+ */
+ export interface ContextRealtimeData {
/**
- * Source of the authentication challenge.
+ * The current context time in second in BaseAudioContext.
*/
- source?: "Server"|"Proxy";
+ currentTime: number;
/**
- * Origin of the challenger.
+ * The time spent on rendering graph divided by render quantum duration,
+and multiplied by 100. 100 means the audio renderer reached the full
+capacity and glitch may occur.
*/
- origin: string;
+ renderCapacity: number;
/**
- * The authentication scheme used, such as basic or digest
+ * A running mean of callback interval.
*/
- scheme: string;
+ callbackIntervalMean: number;
/**
- * The realm of the challenge. May be empty.
+ * A running variance of callback interval.
*/
- realm: string;
+ callbackIntervalVariance: number;
}
/**
- * Response to an AuthChallenge.
+ * Protocol object for BaseAudioContext
*/
- export interface AuthChallengeResponse {
+ export interface BaseAudioContext {
+ contextId: GraphObjectId;
+ contextType: ContextType;
+ contextState: ContextState;
+ realtimeData?: ContextRealtimeData;
/**
- * The decision on what to do in response to the authorization challenge. Default means
-deferring to the default behavior of the net stack, which will likely either the Cancel
-authentication or display a popup dialog box.
+ * Platform-dependent callback buffer size.
*/
- response: "Default"|"CancelAuth"|"ProvideCredentials";
+ callbackBufferSize: number;
/**
- * The username to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Number of output channels supported by audio hardware in use.
*/
- username?: string;
+ maxOutputChannelCount: number;
/**
- * The password to provide, possibly empty. Should only be set if response is
-ProvideCredentials.
+ * Context sample rate.
*/
- password?: string;
+ sampleRate: number;
}
-
/**
- * Issued when the domain is enabled and the request URL matches the
-specified filter. The request is paused until the client responds
-with one of continueRequest, failRequest or fulfillRequest.
-The stage of the request can be determined by presence of responseErrorReason
-and responseStatusCode -- the request is at the response stage if either
-of these fields is present and in the request stage otherwise.
-Redirect responses and subsequent requests are reported similarly to regular
-responses and requests. Redirect responses may be distinguished by the value
-of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with
-presence of the `location` header. Requests resulting from a redirect will
-have `redirectedRequestId` field set.
+ * Protocol object for AudioListener
*/
- export type requestPausedPayload = {
- /**
- * Each request the page makes will have a unique id.
- */
- requestId: RequestId;
- /**
- * The details of the request.
- */
- request: Network.Request;
- /**
- * The id of the frame that initiated the request.
- */
- frameId: Page.FrameId;
- /**
- * How the requested resource will be used.
- */
- resourceType: Network.ResourceType;
- /**
- * Response error if intercepted at response stage.
- */
- responseErrorReason?: Network.ErrorReason;
- /**
- * Response code if intercepted at response stage.
- */
- responseStatusCode?: number;
- /**
- * Response status text if intercepted at response stage.
- */
- responseStatusText?: string;
- /**
- * Response headers if intercepted at the response stage.
- */
- responseHeaders?: HeaderEntry[];
- /**
- * If the intercepted request had a corresponding Network.requestWillBeSent event fired for it,
-then this networkId will be the same as the requestId present in the requestWillBeSent event.
- */
- networkId?: Network.RequestId;
- /**
- * If the request is due to a redirect response from the server, the id of the request that
-has caused the redirect.
- */
- redirectedRequestId?: RequestId;
+ export interface AudioListener {
+ listenerId: GraphObjectId;
+ contextId: GraphObjectId;
}
/**
- * Issued when the domain is enabled with handleAuthRequests set to true.
-The request is paused until client responds with continueWithAuth.
+ * Protocol object for AudioNode
*/
- export type authRequiredPayload = {
- /**
- * Each request the page makes will have a unique id.
- */
- requestId: RequestId;
- /**
- * The details of the request.
- */
- request: Network.Request;
- /**
- * The id of the frame that initiated the request.
- */
- frameId: Page.FrameId;
- /**
- * How the requested resource will be used.
- */
- resourceType: Network.ResourceType;
- /**
- * Details of the Authorization Challenge encountered.
-If this is set, client should respond with continueRequest that
-contains AuthChallengeResponse.
- */
- authChallenge: AuthChallenge;
+ export interface AudioNode {
+ nodeId: GraphObjectId;
+ contextId: GraphObjectId;
+ nodeType: NodeType;
+ numberOfInputs: number;
+ numberOfOutputs: number;
+ channelCount: number;
+ channelCountMode: ChannelCountMode;
+ channelInterpretation: ChannelInterpretation;
+ }
+ /**
+ * Protocol object for AudioParam
+ */
+ export interface AudioParam {
+ paramId: GraphObjectId;
+ nodeId: GraphObjectId;
+ contextId: GraphObjectId;
+ paramType: ParamType;
+ rate: AutomationRate;
+ defaultValue: number;
+ minValue: number;
+ maxValue: number;
}
/**
- * Disables the fetch domain.
+ * Notifies that a new BaseAudioContext has been created.
*/
- export type disableParameters = {
+ export type contextCreatedPayload = {
+ context: BaseAudioContext;
}
- export type disableReturnValue = {
+ /**
+ * Notifies that an existing BaseAudioContext will be destroyed.
+ */
+ export type contextWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
}
/**
- * Enables issuing of requestPaused events. A request will be paused until client
-calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.
+ * Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
*/
- export type enableParameters = {
- /**
- * If specified, only requests matching any of these patterns will produce
-fetchRequested event and will be paused until clients response. If not set,
-all requests will be affected.
- */
- patterns?: RequestPattern[];
- /**
- * If true, authRequired events will be issued and requests will be paused
-expecting a call to continueWithAuth.
- */
- handleAuthRequests?: boolean;
+ export type contextChangedPayload = {
+ context: BaseAudioContext;
}
- export type enableReturnValue = {
+ /**
+ * Notifies that the construction of an AudioListener has finished.
+ */
+ export type audioListenerCreatedPayload = {
+ listener: AudioListener;
}
/**
- * Causes the request to fail with specified reason.
+ * Notifies that a new AudioListener has been created.
*/
- export type failRequestParameters = {
- /**
- * An id the client received in requestPaused event.
- */
- requestId: RequestId;
- /**
- * Causes the request to fail with the given reason.
- */
- errorReason: Network.ErrorReason;
+ export type audioListenerWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ listenerId: GraphObjectId;
}
- export type failRequestReturnValue = {
+ /**
+ * Notifies that a new AudioNode has been created.
+ */
+ export type audioNodeCreatedPayload = {
+ node: AudioNode;
}
/**
- * Provides response to the request.
+ * Notifies that an existing AudioNode has been destroyed.
*/
- export type fulfillRequestParameters = {
- /**
- * An id the client received in requestPaused event.
- */
- requestId: RequestId;
+ export type audioNodeWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ nodeId: GraphObjectId;
+ }
+ /**
+ * Notifies that a new AudioParam has been created.
+ */
+ export type audioParamCreatedPayload = {
+ param: AudioParam;
+ }
+ /**
+ * Notifies that an existing AudioParam has been destroyed.
+ */
+ export type audioParamWillBeDestroyedPayload = {
+ contextId: GraphObjectId;
+ nodeId: GraphObjectId;
+ paramId: GraphObjectId;
+ }
+ /**
+ * Notifies that two AudioNodes are connected.
+ */
+ export type nodesConnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ destinationInputIndex?: number;
+ }
+ /**
+ * Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
+ */
+ export type nodesDisconnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ destinationInputIndex?: number;
+ }
+ /**
+ * Notifies that an AudioNode is connected to an AudioParam.
+ */
+ export type nodeParamConnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ }
+ /**
+ * Notifies that an AudioNode is disconnected to an AudioParam.
+ */
+ export type nodeParamDisconnectedPayload = {
+ contextId: GraphObjectId;
+ sourceId: GraphObjectId;
+ destinationId: GraphObjectId;
+ sourceOutputIndex?: number;
+ }
+
+ /**
+ * Enables the WebAudio domain and starts sending context lifetime events.
+ */
+ export type enableParameters = {
+ }
+ export type enableReturnValue = {
+ }
+ /**
+ * Disables the WebAudio domain.
+ */
+ export type disableParameters = {
+ }
+ export type disableReturnValue = {
+ }
+ /**
+ * Fetch the realtime data from the registered contexts.
+ */
+ export type getRealtimeDataParameters = {
+ contextId: GraphObjectId;
+ }
+ export type getRealtimeDataReturnValue = {
+ realtimeData: ContextRealtimeData;
+ }
+ }
+
+ /**
+ * This domain allows configuring virtual authenticators to test the WebAuthn
+API.
+ */
+ export module WebAuthn {
+ export type AuthenticatorId = string;
+ export type AuthenticatorProtocol = "u2f"|"ctap2";
+ export type Ctap2Version = "ctap2_0"|"ctap2_1";
+ export type AuthenticatorTransport = "usb"|"nfc"|"ble"|"cable"|"internal";
+ export interface VirtualAuthenticatorOptions {
+ protocol: AuthenticatorProtocol;
/**
- * An HTTP response code.
+ * Defaults to ctap2_0. Ignored if |protocol| == u2f.
*/
- responseCode: number;
+ ctap2Version?: Ctap2Version;
+ transport: AuthenticatorTransport;
/**
- * Response headers.
+ * Defaults to false.
*/
- responseHeaders?: HeaderEntry[];
+ hasResidentKey?: boolean;
/**
- * Alternative way of specifying response headers as a \0-separated
-series of name: value pairs. Prefer the above method unless you
-need to represent some non-UTF8 values that can't be transmitted
-over the protocol as text.
+ * Defaults to false.
*/
- binaryResponseHeaders?: binary;
+ hasUserVerification?: boolean;
/**
- * A response body. If absent, original response body will be used if
-the request is intercepted at the response stage and empty body
-will be used if the request is intercepted at the request stage.
+ * If set to true, the authenticator will support the largeBlob extension.
+https://w3c.github.io/webauthn#largeBlob
+Defaults to false.
*/
- body?: binary;
+ hasLargeBlob?: boolean;
/**
- * A textual representation of responseCode.
-If absent, a standard phrase matching responseCode is used.
+ * If set to true, the authenticator will support the credBlob extension.
+https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
+Defaults to false.
*/
- responsePhrase?: string;
- }
- export type fulfillRequestReturnValue = {
- }
- /**
- * Continues the request, optionally modifying some of its parameters.
- */
- export type continueRequestParameters = {
+ hasCredBlob?: boolean;
/**
- * An id the client received in requestPaused event.
+ * If set to true, the authenticator will support the minPinLength extension.
+https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
+Defaults to false.
*/
- requestId: RequestId;
+ hasMinPinLength?: boolean;
/**
- * If set, the request url will be modified in a way that's not observable by page.
+ * If set to true, the authenticator will support the prf extension.
+https://w3c.github.io/webauthn/#prf-extension
+Defaults to false.
*/
- url?: string;
+ hasPrf?: boolean;
/**
- * If set, the request method is overridden.
+ * If set to true, tests of user presence will succeed immediately.
+Otherwise, they will not be resolved. Defaults to true.
*/
- method?: string;
+ automaticPresenceSimulation?: boolean;
/**
- * If set, overrides the post data in the request.
+ * Sets whether User Verification succeeds or fails for an authenticator.
+Defaults to false.
*/
- postData?: binary;
+ isUserVerified?: boolean;
/**
- * If set, overrides the request headers. Note that the overrides do not
-extend to subsequent redirect hops, if a redirect happens. Another override
-may be applied to a different request produced by a redirect.
+ * Credentials created by this authenticator will have the backup
+eligibility (BE) flag set to this value. Defaults to false.
+https://w3c.github.io/webauthn/#sctn-credential-backup
*/
- headers?: HeaderEntry[];
+ defaultBackupEligibility?: boolean;
/**
- * If set, overrides response interception behavior for this request.
+ * Credentials created by this authenticator will have the backup state
+(BS) flag set to this value. Defaults to false.
+https://w3c.github.io/webauthn/#sctn-credential-backup
*/
- interceptResponse?: boolean;
- }
- export type continueRequestReturnValue = {
+ defaultBackupState?: boolean;
}
- /**
- * Continues a request supplying authChallengeResponse following authRequired event.
- */
- export type continueWithAuthParameters = {
- /**
- * An id the client received in authRequired event.
- */
- requestId: RequestId;
+ export interface Credential {
+ credentialId: binary;
+ isResidentCredential: boolean;
/**
- * Response to with an authChallenge.
+ * Relying Party ID the credential is scoped to. Must be set when adding a
+credential.
*/
- authChallengeResponse: AuthChallengeResponse;
- }
- export type continueWithAuthReturnValue = {
- }
- /**
- * Continues loading of the paused response, optionally modifying the
-response headers. If either responseCode or headers are modified, all of them
-must be present.
- */
- export type continueResponseParameters = {
+ rpId?: string;
/**
- * An id the client received in requestPaused event.
+ * The ECDSA P-256 private key in PKCS#8 format.
*/
- requestId: RequestId;
+ privateKey: binary;
/**
- * An HTTP response code. If absent, original response code will be used.
+ * An opaque byte sequence with a maximum size of 64 bytes mapping the
+credential to a specific user.
*/
- responseCode?: number;
+ userHandle?: binary;
/**
- * A textual representation of responseCode.
-If absent, a standard phrase matching responseCode is used.
+ * Signature counter. This is incremented by one for each successful
+assertion.
+See https://w3c.github.io/webauthn/#signature-counter
*/
- responsePhrase?: string;
+ signCount: number;
/**
- * Response headers. If absent, original response headers will be used.
+ * The large blob associated with the credential.
+See https://w3c.github.io/webauthn/#sctn-large-blob-extension
*/
- responseHeaders?: HeaderEntry[];
+ largeBlob?: binary;
/**
- * Alternative way of specifying response headers as a \0-separated
-series of name: value pairs. Prefer the above method unless you
-need to represent some non-UTF8 values that can't be transmitted
-over the protocol as text.
+ * Assertions returned by this credential will have the backup eligibility
+(BE) flag set to this value. Defaults to the authenticator's
+defaultBackupEligibility value.
*/
- binaryResponseHeaders?: binary;
- }
- export type continueResponseReturnValue = {
- }
- /**
- * Causes the body of the response to be received from the server and
-returned as a single string. May only be issued for a request that
-is paused in the Response stage and is mutually exclusive with
-takeResponseBodyForInterceptionAsStream. Calling other methods that
-affect the request or disabling fetch domain before body is received
-results in an undefined behavior.
-Note that the response body is not available for redirects. Requests
-paused in the _redirect received_ state may be differentiated by
-`responseCode` and presence of `location` response header, see
-comments to `requestPaused` for details.
- */
- export type getResponseBodyParameters = {
+ backupEligibility?: boolean;
/**
- * Identifier for the intercepted request to get body for.
+ * Assertions returned by this credential will have the backup state (BS)
+flag set to this value. Defaults to the authenticator's
+defaultBackupState value.
*/
- requestId: RequestId;
- }
- export type getResponseBodyReturnValue = {
+ backupState?: boolean;
/**
- * Response body.
+ * The credential's user.name property. Equivalent to empty if not set.
+https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name
*/
- body: string;
+ userName?: string;
/**
- * True, if content was sent as base64.
- */
- base64Encoded: boolean;
- }
- /**
- * Returns a handle to the stream representing the response body.
-The request must be paused in the HeadersReceived stage.
-Note that after this command the request can't be continued
-as is -- client either needs to cancel it or to provide the
-response body.
-The stream only supports sequential read, IO.read will fail if the position
-is specified.
-This method is mutually exclusive with getResponseBody.
-Calling other methods that affect the request or disabling fetch
-domain before body is received results in an undefined behavior.
- */
- export type takeResponseBodyAsStreamParameters = {
- requestId: RequestId;
- }
- export type takeResponseBodyAsStreamReturnValue = {
- stream: IO.StreamHandle;
- }
- }
-
- /**
- * This domain allows inspection of Web Audio API.
-https://webaudio.github.io/web-audio-api/
- */
- export module WebAudio {
- /**
- * An unique ID for a graph object (AudioContext, AudioNode, AudioParam) in Web Audio API
- */
- export type GraphObjectId = string;
- /**
- * Enum of BaseAudioContext types
- */
- export type ContextType = "realtime"|"offline";
- /**
- * Enum of AudioContextState from the spec
- */
- export type ContextState = "suspended"|"running"|"closed"|"interrupted";
- /**
- * Enum of AudioNode types
- */
- export type NodeType = string;
- /**
- * Enum of AudioNode::ChannelCountMode from the spec
- */
- export type ChannelCountMode = "clamped-max"|"explicit"|"max";
- /**
- * Enum of AudioNode::ChannelInterpretation from the spec
- */
- export type ChannelInterpretation = "discrete"|"speakers";
- /**
- * Enum of AudioParam types
- */
- export type ParamType = string;
- /**
- * Enum of AudioParam::AutomationRate from the spec
- */
- export type AutomationRate = "a-rate"|"k-rate";
- /**
- * Fields in AudioContext that change in real-time.
- */
- export interface ContextRealtimeData {
- /**
- * The current context time in second in BaseAudioContext.
- */
- currentTime: number;
- /**
- * The time spent on rendering graph divided by render quantum duration,
-and multiplied by 100. 100 means the audio renderer reached the full
-capacity and glitch may occur.
- */
- renderCapacity: number;
- /**
- * A running mean of callback interval.
- */
- callbackIntervalMean: number;
- /**
- * A running variance of callback interval.
- */
- callbackIntervalVariance: number;
- }
- /**
- * Protocol object for BaseAudioContext
- */
- export interface BaseAudioContext {
- contextId: GraphObjectId;
- contextType: ContextType;
- contextState: ContextState;
- realtimeData?: ContextRealtimeData;
- /**
- * Platform-dependent callback buffer size.
- */
- callbackBufferSize: number;
- /**
- * Number of output channels supported by audio hardware in use.
- */
- maxOutputChannelCount: number;
- /**
- * Context sample rate.
- */
- sampleRate: number;
- }
- /**
- * Protocol object for AudioListener
- */
- export interface AudioListener {
- listenerId: GraphObjectId;
- contextId: GraphObjectId;
- }
- /**
- * Protocol object for AudioNode
- */
- export interface AudioNode {
- nodeId: GraphObjectId;
- contextId: GraphObjectId;
- nodeType: NodeType;
- numberOfInputs: number;
- numberOfOutputs: number;
- channelCount: number;
- channelCountMode: ChannelCountMode;
- channelInterpretation: ChannelInterpretation;
- }
- /**
- * Protocol object for AudioParam
- */
- export interface AudioParam {
- paramId: GraphObjectId;
- nodeId: GraphObjectId;
- contextId: GraphObjectId;
- paramType: ParamType;
- rate: AutomationRate;
- defaultValue: number;
- minValue: number;
- maxValue: number;
- }
-
- /**
- * Notifies that a new BaseAudioContext has been created.
- */
- export type contextCreatedPayload = {
- context: BaseAudioContext;
- }
- /**
- * Notifies that an existing BaseAudioContext will be destroyed.
- */
- export type contextWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- }
- /**
- * Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
- */
- export type contextChangedPayload = {
- context: BaseAudioContext;
- }
- /**
- * Notifies that the construction of an AudioListener has finished.
- */
- export type audioListenerCreatedPayload = {
- listener: AudioListener;
- }
- /**
- * Notifies that a new AudioListener has been created.
- */
- export type audioListenerWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- listenerId: GraphObjectId;
- }
- /**
- * Notifies that a new AudioNode has been created.
- */
- export type audioNodeCreatedPayload = {
- node: AudioNode;
- }
- /**
- * Notifies that an existing AudioNode has been destroyed.
- */
- export type audioNodeWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- nodeId: GraphObjectId;
- }
- /**
- * Notifies that a new AudioParam has been created.
- */
- export type audioParamCreatedPayload = {
- param: AudioParam;
- }
- /**
- * Notifies that an existing AudioParam has been destroyed.
- */
- export type audioParamWillBeDestroyedPayload = {
- contextId: GraphObjectId;
- nodeId: GraphObjectId;
- paramId: GraphObjectId;
- }
- /**
- * Notifies that two AudioNodes are connected.
- */
- export type nodesConnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- destinationInputIndex?: number;
- }
- /**
- * Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
- */
- export type nodesDisconnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- destinationInputIndex?: number;
- }
- /**
- * Notifies that an AudioNode is connected to an AudioParam.
- */
- export type nodeParamConnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- }
- /**
- * Notifies that an AudioNode is disconnected to an AudioParam.
- */
- export type nodeParamDisconnectedPayload = {
- contextId: GraphObjectId;
- sourceId: GraphObjectId;
- destinationId: GraphObjectId;
- sourceOutputIndex?: number;
- }
-
- /**
- * Enables the WebAudio domain and starts sending context lifetime events.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disables the WebAudio domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Fetch the realtime data from the registered contexts.
- */
- export type getRealtimeDataParameters = {
- contextId: GraphObjectId;
- }
- export type getRealtimeDataReturnValue = {
- realtimeData: ContextRealtimeData;
- }
- }
-
- /**
- * This domain allows configuring virtual authenticators to test the WebAuthn
-API.
- */
- export module WebAuthn {
- export type AuthenticatorId = string;
- export type AuthenticatorProtocol = "u2f"|"ctap2";
- export type Ctap2Version = "ctap2_0"|"ctap2_1";
- export type AuthenticatorTransport = "usb"|"nfc"|"ble"|"cable"|"internal";
- export interface VirtualAuthenticatorOptions {
- protocol: AuthenticatorProtocol;
- /**
- * Defaults to ctap2_0. Ignored if |protocol| == u2f.
- */
- ctap2Version?: Ctap2Version;
- transport: AuthenticatorTransport;
- /**
- * Defaults to false.
- */
- hasResidentKey?: boolean;
- /**
- * Defaults to false.
- */
- hasUserVerification?: boolean;
- /**
- * If set to true, the authenticator will support the largeBlob extension.
-https://w3c.github.io/webauthn#largeBlob
-Defaults to false.
- */
- hasLargeBlob?: boolean;
- /**
- * If set to true, the authenticator will support the credBlob extension.
-https://fidoalliance.org/specs/fido-v2.1-rd-20201208/fido-client-to-authenticator-protocol-v2.1-rd-20201208.html#sctn-credBlob-extension
-Defaults to false.
- */
- hasCredBlob?: boolean;
- /**
- * If set to true, the authenticator will support the minPinLength extension.
-https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-20210615.html#sctn-minpinlength-extension
-Defaults to false.
- */
- hasMinPinLength?: boolean;
- /**
- * If set to true, the authenticator will support the prf extension.
-https://w3c.github.io/webauthn/#prf-extension
-Defaults to false.
- */
- hasPrf?: boolean;
- /**
- * If set to true, tests of user presence will succeed immediately.
-Otherwise, they will not be resolved. Defaults to true.
- */
- automaticPresenceSimulation?: boolean;
- /**
- * Sets whether User Verification succeeds or fails for an authenticator.
-Defaults to false.
- */
- isUserVerified?: boolean;
- /**
- * Credentials created by this authenticator will have the backup
-eligibility (BE) flag set to this value. Defaults to false.
-https://w3c.github.io/webauthn/#sctn-credential-backup
- */
- defaultBackupEligibility?: boolean;
- /**
- * Credentials created by this authenticator will have the backup state
-(BS) flag set to this value. Defaults to false.
-https://w3c.github.io/webauthn/#sctn-credential-backup
- */
- defaultBackupState?: boolean;
- }
- export interface Credential {
- credentialId: binary;
- isResidentCredential: boolean;
- /**
- * Relying Party ID the credential is scoped to. Must be set when adding a
-credential.
- */
- rpId?: string;
- /**
- * The ECDSA P-256 private key in PKCS#8 format.
- */
- privateKey: binary;
- /**
- * An opaque byte sequence with a maximum size of 64 bytes mapping the
-credential to a specific user.
- */
- userHandle?: binary;
- /**
- * Signature counter. This is incremented by one for each successful
-assertion.
-See https://w3c.github.io/webauthn/#signature-counter
- */
- signCount: number;
- /**
- * The large blob associated with the credential.
-See https://w3c.github.io/webauthn/#sctn-large-blob-extension
- */
- largeBlob?: binary;
- /**
- * Assertions returned by this credential will have the backup eligibility
-(BE) flag set to this value. Defaults to the authenticator's
-defaultBackupEligibility value.
- */
- backupEligibility?: boolean;
- /**
- * Assertions returned by this credential will have the backup state (BS)
-flag set to this value. Defaults to the authenticator's
-defaultBackupState value.
- */
- backupState?: boolean;
- /**
- * The credential's user.name property. Equivalent to empty if not set.
-https://w3c.github.io/webauthn/#dom-publickeycredentialentity-name
- */
- userName?: string;
- /**
- * The credential's user.displayName property. Equivalent to empty if
-not set.
-https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname
- */
- userDisplayName?: string;
- }
-
- /**
- * Triggered when a credential is added to an authenticator.
- */
- export type credentialAddedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- /**
- * Triggered when a credential is deleted, e.g. through
-PublicKeyCredential.signalUnknownCredential().
- */
- export type credentialDeletedPayload = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- /**
- * Triggered when a credential is updated, e.g. through
-PublicKeyCredential.signalCurrentUserDetails().
- */
- export type credentialUpdatedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- /**
- * Triggered when a credential is used in a webauthn assertion.
- */
- export type credentialAssertedPayload = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
-
- /**
- * Enable the WebAuthn domain and start intercepting credential storage and
-retrieval with a virtual authenticator.
- */
- export type enableParameters = {
- /**
- * Whether to enable the WebAuthn user interface. Enabling the UI is
-recommended for debugging and demo purposes, as it is closer to the real
-experience. Disabling the UI is recommended for automated testing.
-Supported at the embedder's discretion if UI is available.
-Defaults to false.
- */
- enableUI?: boolean;
- }
- export type enableReturnValue = {
- }
- /**
- * Disable the WebAuthn domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Creates and adds a virtual authenticator.
- */
- export type addVirtualAuthenticatorParameters = {
- options: VirtualAuthenticatorOptions;
- }
- export type addVirtualAuthenticatorReturnValue = {
- authenticatorId: AuthenticatorId;
- }
- /**
- * Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
- */
- export type setResponseOverrideBitsParameters = {
- authenticatorId: AuthenticatorId;
- /**
- * If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
-Defaults to false.
- */
- isBogusSignature?: boolean;
- /**
- * If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
-be zero. Defaults to false.
- */
- isBadUV?: boolean;
- /**
- * If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
-be zero. Defaults to false.
- */
- isBadUP?: boolean;
- }
- export type setResponseOverrideBitsReturnValue = {
- }
- /**
- * Removes the given authenticator.
- */
- export type removeVirtualAuthenticatorParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type removeVirtualAuthenticatorReturnValue = {
- }
- /**
- * Adds the credential to the specified authenticator.
- */
- export type addCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credential: Credential;
- }
- export type addCredentialReturnValue = {
- }
- /**
- * Returns a single credential stored in the given virtual authenticator that
-matches the credential ID.
- */
- export type getCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- export type getCredentialReturnValue = {
- credential: Credential;
- }
- /**
- * Returns all the credentials stored in the given virtual authenticator.
- */
- export type getCredentialsParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type getCredentialsReturnValue = {
- credentials: Credential[];
- }
- /**
- * Removes a credential from the authenticator.
- */
- export type removeCredentialParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- }
- export type removeCredentialReturnValue = {
- }
- /**
- * Clears all the credentials from the specified device.
- */
- export type clearCredentialsParameters = {
- authenticatorId: AuthenticatorId;
- }
- export type clearCredentialsReturnValue = {
- }
- /**
- * Sets whether User Verification succeeds or fails for an authenticator.
-The default is true.
- */
- export type setUserVerifiedParameters = {
- authenticatorId: AuthenticatorId;
- isUserVerified: boolean;
- }
- export type setUserVerifiedReturnValue = {
- }
- /**
- * Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
-The default is true.
- */
- export type setAutomaticPresenceSimulationParameters = {
- authenticatorId: AuthenticatorId;
- enabled: boolean;
- }
- export type setAutomaticPresenceSimulationReturnValue = {
- }
- /**
- * Allows setting credential properties.
-https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties
- */
- export type setCredentialPropertiesParameters = {
- authenticatorId: AuthenticatorId;
- credentialId: binary;
- backupEligibility?: boolean;
- backupState?: boolean;
- }
- export type setCredentialPropertiesReturnValue = {
- }
- }
-
- /**
- * This domain allows detailed inspection of media elements
- */
- export module Media {
- /**
- * Players will get an ID that is unique within the agent context.
- */
- export type PlayerId = string;
- export type Timestamp = number;
- /**
- * Have one type per entry in MediaLogRecord::Type
-Corresponds to kMessage
- */
- export interface PlayerMessage {
- /**
- * Keep in sync with MediaLogMessageLevel
-We are currently keeping the message level 'error' separate from the
-PlayerError type because right now they represent different things,
-this one being a DVLOG(ERROR) style log message that gets printed
-based on what log level is selected in the UI, and the other is a
-representation of a media::PipelineStatus object. Soon however we're
-going to be moving away from using PipelineStatus for errors and
-introducing a new error type which should hopefully let us integrate
-the error log level into the PlayerError type.
- */
- level: "error"|"warning"|"info"|"debug";
- message: string;
- }
- /**
- * Corresponds to kMediaPropertyChange
- */
- export interface PlayerProperty {
- name: string;
- value: string;
- }
- /**
- * Corresponds to kMediaEventTriggered
- */
- export interface PlayerEvent {
- timestamp: Timestamp;
- value: string;
- }
- /**
- * Represents logged source line numbers reported in an error.
-NOTE: file and line are from chromium c++ implementation code, not js.
- */
- export interface PlayerErrorSourceLocation {
- file: string;
- line: number;
- }
- /**
- * Corresponds to kMediaError
- */
- export interface PlayerError {
- errorType: string;
- /**
- * Code is the numeric enum entry for a specific set of error codes, such
-as PipelineStatusCodes in media/base/pipeline_status.h
- */
- code: number;
- /**
- * A trace of where this error was caused / where it passed through.
- */
- stack: PlayerErrorSourceLocation[];
- /**
- * Errors potentially have a root cause error, ie, a DecoderError might be
-caused by an WindowsError
- */
- cause: PlayerError[];
- /**
- * Extra data attached to an error, such as an HRESULT, Video Codec, etc.
- */
- data: { [key: string]: string };
- }
-
- /**
- * This can be called multiple times, and can be used to set / override /
-remove player properties. A null propValue indicates removal.
- */
- export type playerPropertiesChangedPayload = {
- playerId: PlayerId;
- properties: PlayerProperty[];
- }
- /**
- * Send events as a list, allowing them to be batched on the browser for less
-congestion. If batched, events must ALWAYS be in chronological order.
- */
- export type playerEventsAddedPayload = {
- playerId: PlayerId;
- events: PlayerEvent[];
- }
- /**
- * Send a list of any messages that need to be delivered.
- */
- export type playerMessagesLoggedPayload = {
- playerId: PlayerId;
- messages: PlayerMessage[];
- }
- /**
- * Send a list of any errors that need to be delivered.
- */
- export type playerErrorsRaisedPayload = {
- playerId: PlayerId;
- errors: PlayerError[];
- }
- /**
- * Called whenever a player is created, or when a new agent joins and receives
-a list of active players. If an agent is restored, it will receive the full
-list of player ids and all events again.
- */
- export type playersCreatedPayload = {
- players: PlayerId[];
- }
-
- /**
- * Enables the Media domain
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disables the Media domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- }
-
- export module DeviceAccess {
- /**
- * Device request id.
- */
- export type RequestId = string;
- /**
- * A device id.
- */
- export type DeviceId = string;
- /**
- * Device information displayed in a user prompt to select a device.
- */
- export interface PromptDevice {
- id: DeviceId;
- /**
- * Display name as it appears in a device request user prompt.
- */
- name: string;
- }
-
- /**
- * A device request opened a user prompt to select a device. Respond with the
-selectPrompt or cancelPrompt command.
- */
- export type deviceRequestPromptedPayload = {
- id: RequestId;
- devices: PromptDevice[];
- }
-
- /**
- * Enable events in this domain.
- */
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- /**
- * Disable events in this domain.
- */
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- /**
- * Select a device in response to a DeviceAccess.deviceRequestPrompted event.
- */
- export type selectPromptParameters = {
- id: RequestId;
- deviceId: DeviceId;
- }
- export type selectPromptReturnValue = {
- }
- /**
- * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event.
- */
- export type cancelPromptParameters = {
- id: RequestId;
- }
- export type cancelPromptReturnValue = {
- }
- }
-
- export module Preload {
- /**
- * Unique id
- */
- export type RuleSetId = string;
- /**
- * Corresponds to SpeculationRuleSet
- */
- export interface RuleSet {
- id: RuleSetId;
- /**
- * Identifies a document which the rule set is associated with.
- */
- loaderId: Network.LoaderId;
- /**
- * Source text of JSON representing the rule set. If it comes from
-`<script>` tag, it is the textContent of the node. Note that it is
-a JSON for valid case.
-
-See also:
-- https://wicg.github.io/nav-speculation/speculation-rules.html
-- https://github.com/WICG/nav-speculation/blob/main/triggers.md
- */
- sourceText: string;
- /**
- * A speculation rule set is either added through an inline
-`<script>` tag or through an external resource via the
-'Speculation-Rules' HTTP header. For the first case, we include
-the BackendNodeId of the relevant `<script>` tag. For the second
-case, we include the external URL where the rule set was loaded
-from, and also RequestId if Network domain is enabled.
-
-See also:
-- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script
-- https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
- */
- backendNodeId?: DOM.BackendNodeId;
- url?: string;
- requestId?: Network.RequestId;
- /**
- * Error information
-`errorMessage` is null iff `errorType` is null.
- */
- errorType?: RuleSetErrorType;
- /**
- * TODO(https://crbug.com/1425354): Replace this property with structured error.
- */
- errorMessage?: string;
- }
- export type RuleSetErrorType = "SourceIsNotJsonObject"|"InvalidRulesSkipped"|"InvalidRulesetLevelTag";
- /**
- * The type of preloading attempted. It corresponds to
-mojom::SpeculationAction (although PrefetchWithSubresources is omitted as it
-isn't being used by clients).
- */
- export type SpeculationAction = "Prefetch"|"Prerender";
- /**
- * Corresponds to mojom::SpeculationTargetHint.
-See https://github.com/WICG/nav-speculation/blob/main/triggers.md#window-name-targeting-hints
- */
- export type SpeculationTargetHint = "Blank"|"Self";
- /**
- * A key that identifies a preloading attempt.
-
-The url used is the url specified by the trigger (i.e. the initial URL), and
-not the final url that is navigated to. For example, prerendering allows
-same-origin main frame navigations during the attempt, but the attempt is
-still keyed with the initial URL.
- */
- export interface PreloadingAttemptKey {
- loaderId: Network.LoaderId;
- action: SpeculationAction;
- url: string;
- targetHint?: SpeculationTargetHint;
- }
- /**
- * Lists sources for a preloading attempt, specifically the ids of rule sets
-that had a speculation rule that triggered the attempt, and the
-BackendNodeIds of <a href> or <area href> elements that triggered the
-attempt (in the case of attempts triggered by a document rule). It is
-possible for multiple rule sets and links to trigger a single attempt.
- */
- export interface PreloadingAttemptSource {
- key: PreloadingAttemptKey;
- ruleSetIds: RuleSetId[];
- nodeIds: DOM.BackendNodeId[];
- }
- /**
- * Chrome manages different types of preloads together using a
-concept of preloading pipeline. For example, if a site uses a
-SpeculationRules for prerender, Chrome first starts a prefetch and
-then upgrades it to prerender.
-
-CDP events for them are emitted separately but they share
-`PreloadPipelineId`.
- */
- export type PreloadPipelineId = string;
- /**
- * List of FinalStatus reasons for Prerender2.
- */
- export type PrerenderFinalStatus = "Activated"|"Destroyed"|"LowEndDevice"|"InvalidSchemeRedirect"|"InvalidSchemeNavigation"|"NavigationRequestBlockedByCsp"|"MojoBinderPolicy"|"RendererProcessCrashed"|"RendererProcessKilled"|"Download"|"TriggerDestroyed"|"NavigationNotCommitted"|"NavigationBadHttpStatus"|"ClientCertRequested"|"NavigationRequestNetworkError"|"CancelAllHostsForTesting"|"DidFailLoad"|"Stop"|"SslCertificateError"|"LoginAuthRequested"|"UaChangeRequiresReload"|"BlockedByClient"|"AudioOutputDeviceRequested"|"MixedContent"|"TriggerBackgrounded"|"MemoryLimitExceeded"|"DataSaverEnabled"|"TriggerUrlHasEffectiveUrl"|"ActivatedBeforeStarted"|"InactivePageRestriction"|"StartFailed"|"TimeoutBackgrounded"|"CrossSiteRedirectInInitialNavigation"|"CrossSiteNavigationInInitialNavigation"|"SameSiteCrossOriginRedirectNotOptInInInitialNavigation"|"SameSiteCrossOriginNavigationNotOptInInInitialNavigation"|"ActivationNavigationParameterMismatch"|"ActivatedInBackground"|"EmbedderHostDisallowed"|"ActivationNavigationDestroyedBeforeSuccess"|"TabClosedByUserGesture"|"TabClosedWithoutUserGesture"|"PrimaryMainFrameRendererProcessCrashed"|"PrimaryMainFrameRendererProcessKilled"|"ActivationFramePolicyNotCompatible"|"PreloadingDisabled"|"BatterySaverEnabled"|"ActivatedDuringMainFrameNavigation"|"PreloadingUnsupportedByWebContents"|"CrossSiteRedirectInMainFrameNavigation"|"CrossSiteNavigationInMainFrameNavigation"|"SameSiteCrossOriginRedirectNotOptInInMainFrameNavigation"|"SameSiteCrossOriginNavigationNotOptInInMainFrameNavigation"|"MemoryPressureOnTrigger"|"MemoryPressureAfterTriggered"|"PrerenderingDisabledByDevTools"|"SpeculationRuleRemoved"|"ActivatedWithAuxiliaryBrowsingContexts"|"MaxNumOfRunningEagerPrerendersExceeded"|"MaxNumOfRunningNonEagerPrerendersExceeded"|"MaxNumOfRunningEmbedderPrerendersExceeded"|"PrerenderingUrlHasEffectiveUrl"|"RedirectedPrerenderingUrlHasEffectiveUrl"|"ActivationUrlHasEffectiveUrl"|"JavaScriptInterfaceAdded"|"JavaScriptInterfaceRemoved"|"AllPrerenderingCanceled"|"WindowClosed"|"SlowNetwork"|"OtherPrerenderedPageActivated"|"V8OptimizerDisabled"|"PrerenderFailedDuringPrefetch"|"BrowsingDataRemoved"|"PrerenderHostReused";
- /**
- * Preloading status values, see also PreloadingTriggeringOutcome. This
-status is shared by prefetchStatusUpdated and prerenderStatusUpdated.
- */
- export type PreloadingStatus = "Pending"|"Running"|"Ready"|"Success"|"Failure"|"NotSupported";
- /**
- * TODO(https://crbug.com/1384419): revisit the list of PrefetchStatus and
-filter out the ones that aren't necessary to the developers.
- */
- export type PrefetchStatus = "PrefetchAllowed"|"PrefetchFailedIneligibleRedirect"|"PrefetchFailedInvalidRedirect"|"PrefetchFailedMIMENotSupported"|"PrefetchFailedNetError"|"PrefetchFailedNon2XX"|"PrefetchEvictedAfterBrowsingDataRemoved"|"PrefetchEvictedAfterCandidateRemoved"|"PrefetchEvictedForNewerPrefetch"|"PrefetchHeldback"|"PrefetchIneligibleRetryAfter"|"PrefetchIsPrivacyDecoy"|"PrefetchIsStale"|"PrefetchNotEligibleBrowserContextOffTheRecord"|"PrefetchNotEligibleDataSaverEnabled"|"PrefetchNotEligibleExistingProxy"|"PrefetchNotEligibleHostIsNonUnique"|"PrefetchNotEligibleNonDefaultStoragePartition"|"PrefetchNotEligibleSameSiteCrossOriginPrefetchRequiredProxy"|"PrefetchNotEligibleSchemeIsNotHttps"|"PrefetchNotEligibleUserHasCookies"|"PrefetchNotEligibleUserHasServiceWorker"|"PrefetchNotEligibleUserHasServiceWorkerNoFetchHandler"|"PrefetchNotEligibleRedirectFromServiceWorker"|"PrefetchNotEligibleRedirectToServiceWorker"|"PrefetchNotEligibleBatterySaverEnabled"|"PrefetchNotEligiblePreloadingDisabled"|"PrefetchNotFinishedInTime"|"PrefetchNotStarted"|"PrefetchNotUsedCookiesChanged"|"PrefetchProxyNotAvailable"|"PrefetchResponseUsed"|"PrefetchSuccessfulButNotUsed"|"PrefetchNotUsedProbeFailed";
- /**
- * Information of headers to be displayed when the header mismatch occurred.
- */
- export interface PrerenderMismatchedHeaders {
- headerName: string;
- initialValue?: string;
- activationValue?: string;
- }
-
- /**
- * Upsert. Currently, it is only emitted when a rule set added.
- */
- export type ruleSetUpdatedPayload = {
- ruleSet: RuleSet;
- }
- export type ruleSetRemovedPayload = {
- id: RuleSetId;
- }
- /**
- * Fired when a preload enabled state is updated.
- */
- export type preloadEnabledStateUpdatedPayload = {
- disabledByPreference: boolean;
- disabledByDataSaver: boolean;
- disabledByBatterySaver: boolean;
- disabledByHoldbackPrefetchSpeculationRules: boolean;
- disabledByHoldbackPrerenderSpeculationRules: boolean;
- }
- /**
- * Fired when a prefetch attempt is updated.
- */
- export type prefetchStatusUpdatedPayload = {
- key: PreloadingAttemptKey;
- pipelineId: PreloadPipelineId;
- /**
- * The frame id of the frame initiating prefetch.
- */
- initiatingFrameId: Page.FrameId;
- prefetchUrl: string;
- status: PreloadingStatus;
- prefetchStatus: PrefetchStatus;
- requestId: Network.RequestId;
- }
- /**
- * Fired when a prerender attempt is updated.
- */
- export type prerenderStatusUpdatedPayload = {
- key: PreloadingAttemptKey;
- pipelineId: PreloadPipelineId;
- status: PreloadingStatus;
- prerenderStatus?: PrerenderFinalStatus;
- /**
- * This is used to give users more information about the name of Mojo interface
-that is incompatible with prerender and has caused the cancellation of the attempt.
- */
- disallowedMojoInterface?: string;
- mismatchedHeaders?: PrerenderMismatchedHeaders[];
- }
- /**
- * Send a list of sources for all preloading attempts in a document.
- */
- export type preloadingAttemptSourcesUpdatedPayload = {
- loaderId: Network.LoaderId;
- preloadingAttemptSources: PreloadingAttemptSource[];
- }
-
- export type enableParameters = {
- }
- export type enableReturnValue = {
- }
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- }
-
- /**
- * This domain allows interacting with the FedCM dialog.
- */
- export module FedCm {
- /**
- * Whether this is a sign-up or sign-in action for this account, i.e.
-whether this account has ever been used to sign in to this RP before.
- */
- export type LoginState = "SignIn"|"SignUp";
- /**
- * The types of FedCM dialogs.
- */
- export type DialogType = "AccountChooser"|"AutoReauthn"|"ConfirmIdpLogin"|"Error";
- /**
- * The buttons on the FedCM dialog.
- */
- export type DialogButton = "ConfirmIdpLoginContinue"|"ErrorGotIt"|"ErrorMoreDetails";
- /**
- * The URLs that each account has
- */
- export type AccountUrlType = "TermsOfService"|"PrivacyPolicy";
- /**
- * Corresponds to IdentityRequestAccount
- */
- export interface Account {
- accountId: string;
- email: string;
- name: string;
- givenName: string;
- pictureUrl: string;
- idpConfigUrl: string;
- idpLoginUrl: string;
- loginState: LoginState;
- /**
- * These two are only set if the loginState is signUp
- */
- termsOfServiceUrl?: string;
- privacyPolicyUrl?: string;
- }
-
- export type dialogShownPayload = {
- dialogId: string;
- dialogType: DialogType;
- accounts: Account[];
- /**
- * These exist primarily so that the caller can verify the
-RP context was used appropriately.
- */
- title: string;
- subtitle?: string;
- }
- /**
- * Triggered when a dialog is closed, either by user action, JS abort,
-or a command below.
- */
- export type dialogClosedPayload = {
- dialogId: string;
- }
-
- export type enableParameters = {
- /**
- * Allows callers to disable the promise rejection delay that would
-normally happen, if this is unimportant to what's being tested.
-(step 4 of https://fedidcg.github.io/FedCM/#browser-api-rp-sign-in)
- */
- disableRejectionDelay?: boolean;
- }
- export type enableReturnValue = {
- }
- export type disableParameters = {
- }
- export type disableReturnValue = {
- }
- export type selectAccountParameters = {
- dialogId: string;
- accountIndex: number;
- }
- export type selectAccountReturnValue = {
- }
- export type clickDialogButtonParameters = {
- dialogId: string;
- dialogButton: DialogButton;
- }
- export type clickDialogButtonReturnValue = {
- }
- export type openUrlParameters = {
- dialogId: string;
- accountIndex: number;
- accountUrlType: AccountUrlType;
- }
- export type openUrlReturnValue = {
- }
- export type dismissDialogParameters = {
- dialogId: string;
- triggerCooldown?: boolean;
- }
- export type dismissDialogReturnValue = {
- }
- /**
- * Resets the cooldown time, if any, to allow the next FedCM call to show
-a dialog even if one was recently dismissed by the user.
- */
- export type resetCooldownParameters = {
- }
- export type resetCooldownReturnValue = {
- }
- }
-
- /**
- * This domain allows interacting with the browser to control PWAs.
- */
- export module PWA {
- /**
- * The following types are the replica of
-https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67
- */
- export interface FileHandlerAccept {
- /**
- * New name of the mimetype according to
-https://www.iana.org/assignments/media-types/media-types.xhtml
- */
- mediaType: string;
- fileExtensions: string[];
- }
- export interface FileHandler {
- action: string;
- accepts: FileHandlerAccept[];
- displayName: string;
- }
- /**
- * If user prefers opening the app in browser or an app window.
- */
- export type DisplayMode = "standalone"|"browser";
-
-
- /**
- * Returns the following OS state for the given manifest id.
- */
- export type getOsAppStateParameters = {
- /**
- * The id from the webapp's manifest file, commonly it's the url of the
-site installing the webapp. See
-https://web.dev/learn/pwa/web-app-manifest.
- */
- manifestId: string;
- }
- export type getOsAppStateReturnValue = {
- badgeCount: number;
- fileHandlers: FileHandler[];
- }
- /**
- * Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
-
-IWA-specific install description:
-manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
-
-File installation mode:
-The installUrlOrBundleUrl can be either file:// or http(s):// pointing
-to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to
-The .swbn file's signing key.
-
-Dev proxy installation mode:
-installUrlOrBundleUrl must be http(s):// that serves dev mode IWA.
-web_package::SignedWebBundleId must be of type dev proxy.
-
-The advantage of dev proxy mode is that all changes to IWA
-automatically will be reflected in the running app without
-reinstallation.
-
-To generate bundle id for proxy mode:
-1. Generate 32 random bytes.
-2. Add a specific suffix 0x00 at the end.
-3. Encode the entire sequence using Base32 without padding.
-
-If Chrome is not in IWA dev
-mode, the installation will fail, regardless of the state of the allowlist.
- */
- export type installParameters = {
- manifestId: string;
- /**
- * The location of the app or bundle overriding the one derived from the
-manifestId.
- */
- installUrlOrBundleUrl?: string;
- }
- export type installReturnValue = {
- }
- /**
- * Uninstalls the given manifest_id and closes any opened app windows.
- */
- export type uninstallParameters = {
- manifestId: string;
- }
- export type uninstallReturnValue = {
- }
- /**
- * Launches the installed web app, or an url in the same web app instead of the
-default start url if it is provided. Returns a page Target.TargetID which
-can be used to attach to via Target.attachToTarget or similar APIs.
- */
- export type launchParameters = {
- manifestId: string;
- url?: string;
- }
- export type launchReturnValue = {
- /**
- * ID of the tab target created as a result.
- */
- targetId: Target.TargetID;
- }
- /**
- * Opens one or more local files from an installed web app identified by its
-manifestId. The web app needs to have file handlers registered to process
-the files. The API returns one or more page Target.TargetIDs which can be
-used to attach to via Target.attachToTarget or similar APIs.
-If some files in the parameters cannot be handled by the web app, they will
-be ignored. If none of the files can be handled, this API returns an error.
-If no files are provided as the parameter, this API also returns an error.
-
-According to the definition of the file handlers in the manifest file, one
-Target.TargetID may represent a page handling one or more files. The order
-of the returned Target.TargetIDs is not guaranteed.
-
-TODO(crbug.com/339454034): Check the existences of the input files.
- */
- export type launchFilesInAppParameters = {
- manifestId: string;
- files: string[];
- }
- export type launchFilesInAppReturnValue = {
- /**
- * IDs of the tab targets created as the result.
- */
- targetIds: Target.TargetID[];
- }
- /**
- * Opens the current page in its web app identified by the manifest id, needs
-to be called on a page target. This function returns immediately without
-waiting for the app to finish loading.
- */
- export type openCurrentPageInAppParameters = {
- manifestId: string;
- }
- export type openCurrentPageInAppReturnValue = {
- }
- /**
- * Changes user settings of the web app identified by its manifestId. If the
-app was not installed, this command returns an error. Unset parameters will
-be ignored; unrecognized values will cause an error.
-
-Unlike the ones defined in the manifest files of the web apps, these
-settings are provided by the browser and controlled by the users, they
-impact the way the browser handling the web apps.
-
-See the comment of each parameter.
- */
- export type changeAppUserSettingsParameters = {
- manifestId: string;
- /**
- * If user allows the links clicked on by the user in the app's scope, or
-extended scope if the manifest has scope extensions and the flags
-`DesktopPWAsLinkCapturingWithScopeExtensions` and
-`WebAppEnableScopeExtensions` are enabled.
-
-Note, the API does not support resetting the linkCapturing to the
-initial value, uninstalling and installing the web app again will reset
-it.
-
-TODO(crbug.com/339453269): Setting this value on ChromeOS is not
-supported yet.
- */
- linkCapturing?: boolean;
- displayMode?: DisplayMode;
- }
- export type changeAppUserSettingsReturnValue = {
- }
- }
-
- /**
- * This domain allows configuring virtual Bluetooth devices to test
-the web-bluetooth API.
- */
- export module BluetoothEmulation {
- /**
- * Indicates the various states of Central.
- */
- export type CentralState = "absent"|"powered-off"|"powered-on";
- /**
- * Indicates the various types of GATT event.
- */
- export type GATTOperationType = "connection"|"discovery";
- /**
- * Indicates the various types of characteristic write.
- */
- export type CharacteristicWriteType = "write-default-deprecated"|"write-with-response"|"write-without-response";
- /**
- * Indicates the various types of characteristic operation.
- */
- export type CharacteristicOperationType = "read"|"write"|"subscribe-to-notifications"|"unsubscribe-from-notifications";
- /**
- * Indicates the various types of descriptor operation.
- */
- export type DescriptorOperationType = "read"|"write";
- /**
- * Stores the manufacturer data
- */
- export interface ManufacturerData {
- /**
- * Company identifier
-https://bitbucket.org/bluetooth-SIG/public/src/main/assigned_numbers/company_identifiers/company_identifiers.yaml
-https://usb.org/developers
- */
- key: number;
- /**
- * Manufacturer-specific data
- */
- data: binary;
- }
- /**
- * Stores the byte data of the advertisement packet sent by a Bluetooth device.
- */
- export interface ScanRecord {
- name?: string;
- uuids?: string[];
- /**
- * Stores the external appearance description of the device.
- */
- appearance?: number;
- /**
- * Stores the transmission power of a broadcasting device.
- */
- txPower?: number;
- /**
- * Key is the company identifier and the value is an array of bytes of
-manufacturer specific data.
- */
- manufacturerData?: ManufacturerData[];
- }
- /**
- * Stores the advertisement packet information that is sent by a Bluetooth device.
- */
- export interface ScanEntry {
- deviceAddress: string;
- rssi: number;
- scanRecord: ScanRecord;
+ * The credential's user.displayName property. Equivalent to empty if
+not set.
+https://w3c.github.io/webauthn/#dom-publickeycredentialuserentity-displayname
+ */
+ userDisplayName?: string;
}
+
/**
- * Describes the properties of a characteristic. This follows Bluetooth Core
-Specification BT 4.2 Vol 3 Part G 3.3.1. Characteristic Properties.
+ * Triggered when a credential is added to an authenticator.
*/
- export interface CharacteristicProperties {
- broadcast?: boolean;
- read?: boolean;
- writeWithoutResponse?: boolean;
- write?: boolean;
- notify?: boolean;
- indicate?: boolean;
- authenticatedSignedWrites?: boolean;
- extendedProperties?: boolean;
+ export type credentialAddedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
-
/**
- * Event for when a GATT operation of |type| to the peripheral with |address|
-happened.
+ * Triggered when a credential is deleted, e.g. through
+PublicKeyCredential.signalUnknownCredential().
*/
- export type gattOperationReceivedPayload = {
- address: string;
- type: GATTOperationType;
+ export type credentialDeletedPayload = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
/**
- * Event for when a characteristic operation of |type| to the characteristic
-respresented by |characteristicId| happened. |data| and |writeType| is
-expected to exist when |type| is write.
+ * Triggered when a credential is updated, e.g. through
+PublicKeyCredential.signalCurrentUserDetails().
*/
- export type characteristicOperationReceivedPayload = {
- characteristicId: string;
- type: CharacteristicOperationType;
- data?: binary;
- writeType?: CharacteristicWriteType;
+ export type credentialUpdatedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
/**
- * Event for when a descriptor operation of |type| to the descriptor
-respresented by |descriptorId| happened. |data| is expected to exist when
-|type| is write.
+ * Triggered when a credential is used in a webauthn assertion.
*/
- export type descriptorOperationReceivedPayload = {
- descriptorId: string;
- type: DescriptorOperationType;
- data?: binary;
+ export type credentialAssertedPayload = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
/**
- * Enable the BluetoothEmulation domain.
+ * Enable the WebAuthn domain and start intercepting credential storage and
+retrieval with a virtual authenticator.
*/
export type enableParameters = {
/**
- * State of the simulated central.
- */
- state: CentralState;
- /**
- * If the simulated central supports low-energy.
+ * Whether to enable the WebAuthn user interface. Enabling the UI is
+recommended for debugging and demo purposes, as it is closer to the real
+experience. Disabling the UI is recommended for automated testing.
+Supported at the embedder's discretion if UI is available.
+Defaults to false.
*/
- leSupported: boolean;
+ enableUI?: boolean;
}
export type enableReturnValue = {
}
/**
- * Set the state of the simulated central.
- */
- export type setSimulatedCentralStateParameters = {
- /**
- * State of the simulated central.
- */
- state: CentralState;
- }
- export type setSimulatedCentralStateReturnValue = {
- }
- /**
- * Disable the BluetoothEmulation domain.
+ * Disable the WebAuthn domain.
*/
export type disableParameters = {
}
export type disableReturnValue = {
}
/**
- * Simulates a peripheral with |address|, |name| and |knownServiceUuids|
-that has already been connected to the system.
- */
- export type simulatePreconnectedPeripheralParameters = {
- address: string;
- name: string;
- manufacturerData: ManufacturerData[];
- knownServiceUuids: string[];
- }
- export type simulatePreconnectedPeripheralReturnValue = {
- }
- /**
- * Simulates an advertisement packet described in |entry| being received by
-the central.
+ * Creates and adds a virtual authenticator.
*/
- export type simulateAdvertisementParameters = {
- entry: ScanEntry;
+ export type addVirtualAuthenticatorParameters = {
+ options: VirtualAuthenticatorOptions;
}
- export type simulateAdvertisementReturnValue = {
+ export type addVirtualAuthenticatorReturnValue = {
+ authenticatorId: AuthenticatorId;
}
/**
- * Simulates the response code from the peripheral with |address| for a
-GATT operation of |type|. The |code| value follows the HCI Error Codes from
-Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes.
+ * Resets parameters isBogusSignature, isBadUV, isBadUP to false if they are not present.
*/
- export type simulateGATTOperationResponseParameters = {
- address: string;
- type: GATTOperationType;
- code: number;
+ export type setResponseOverrideBitsParameters = {
+ authenticatorId: AuthenticatorId;
+ /**
+ * If isBogusSignature is set, overrides the signature in the authenticator response to be zero.
+Defaults to false.
+ */
+ isBogusSignature?: boolean;
+ /**
+ * If isBadUV is set, overrides the UV bit in the flags in the authenticator response to
+be zero. Defaults to false.
+ */
+ isBadUV?: boolean;
+ /**
+ * If isBadUP is set, overrides the UP bit in the flags in the authenticator response to
+be zero. Defaults to false.
+ */
+ isBadUP?: boolean;
}
- export type simulateGATTOperationResponseReturnValue = {
+ export type setResponseOverrideBitsReturnValue = {
}
/**
- * Simulates the response from the characteristic with |characteristicId| for a
-characteristic operation of |type|. The |code| value follows the Error
-Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
-The |data| is expected to exist when simulating a successful read operation
-response.
+ * Removes the given authenticator.
*/
- export type simulateCharacteristicOperationResponseParameters = {
- characteristicId: string;
- type: CharacteristicOperationType;
- code: number;
- data?: binary;
+ export type removeVirtualAuthenticatorParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type simulateCharacteristicOperationResponseReturnValue = {
+ export type removeVirtualAuthenticatorReturnValue = {
}
/**
- * Simulates the response from the descriptor with |descriptorId| for a
-descriptor operation of |type|. The |code| value follows the Error
-Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response.
-The |data| is expected to exist when simulating a successful read operation
-response.
+ * Adds the credential to the specified authenticator.
*/
- export type simulateDescriptorOperationResponseParameters = {
- descriptorId: string;
- type: DescriptorOperationType;
- code: number;
- data?: binary;
+ export type addCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credential: Credential;
}
- export type simulateDescriptorOperationResponseReturnValue = {
+ export type addCredentialReturnValue = {
}
/**
- * Adds a service with |serviceUuid| to the peripheral with |address|.
+ * Returns a single credential stored in the given virtual authenticator that
+matches the credential ID.
*/
- export type addServiceParameters = {
- address: string;
- serviceUuid: string;
+ export type getCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
- export type addServiceReturnValue = {
- /**
- * An identifier that uniquely represents this service.
- */
- serviceId: string;
+ export type getCredentialReturnValue = {
+ credential: Credential;
}
/**
- * Removes the service respresented by |serviceId| from the simulated central.
+ * Returns all the credentials stored in the given virtual authenticator.
*/
- export type removeServiceParameters = {
- serviceId: string;
+ export type getCredentialsParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type removeServiceReturnValue = {
+ export type getCredentialsReturnValue = {
+ credentials: Credential[];
}
/**
- * Adds a characteristic with |characteristicUuid| and |properties| to the
-service represented by |serviceId|.
+ * Removes a credential from the authenticator.
*/
- export type addCharacteristicParameters = {
- serviceId: string;
- characteristicUuid: string;
- properties: CharacteristicProperties;
+ export type removeCredentialParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
}
- export type addCharacteristicReturnValue = {
- /**
- * An identifier that uniquely represents this characteristic.
- */
- characteristicId: string;
+ export type removeCredentialReturnValue = {
}
/**
- * Removes the characteristic respresented by |characteristicId| from the
-simulated central.
+ * Clears all the credentials from the specified device.
*/
- export type removeCharacteristicParameters = {
- characteristicId: string;
+ export type clearCredentialsParameters = {
+ authenticatorId: AuthenticatorId;
}
- export type removeCharacteristicReturnValue = {
+ export type clearCredentialsReturnValue = {
}
/**
- * Adds a descriptor with |descriptorUuid| to the characteristic respresented
-by |characteristicId|.
+ * Sets whether User Verification succeeds or fails for an authenticator.
+The default is true.
*/
- export type addDescriptorParameters = {
- characteristicId: string;
- descriptorUuid: string;
+ export type setUserVerifiedParameters = {
+ authenticatorId: AuthenticatorId;
+ isUserVerified: boolean;
}
- export type addDescriptorReturnValue = {
- /**
- * An identifier that uniquely represents this descriptor.
- */
- descriptorId: string;
+ export type setUserVerifiedReturnValue = {
}
/**
- * Removes the descriptor with |descriptorId| from the simulated central.
+ * Sets whether tests of user presence will succeed immediately (if true) or fail to resolve (if false) for an authenticator.
+The default is true.
*/
- export type removeDescriptorParameters = {
- descriptorId: string;
+ export type setAutomaticPresenceSimulationParameters = {
+ authenticatorId: AuthenticatorId;
+ enabled: boolean;
}
- export type removeDescriptorReturnValue = {
+ export type setAutomaticPresenceSimulationReturnValue = {
}
/**
- * Simulates a GATT disconnection from the peripheral with |address|.
+ * Allows setting credential properties.
+https://w3c.github.io/webauthn/#sctn-automation-set-credential-properties
*/
- export type simulateGATTDisconnectionParameters = {
- address: string;
+ export type setCredentialPropertiesParameters = {
+ authenticatorId: AuthenticatorId;
+ credentialId: binary;
+ backupEligibility?: boolean;
+ backupState?: boolean;
}
- export type simulateGATTDisconnectionReturnValue = {
+ export type setCredentialPropertiesReturnValue = {
}
}
@@ -21430,6 +21636,9 @@ Error was thrown.
"Autofill.addressFormFilled": Autofill.addressFormFilledPayload;
"BackgroundService.recordingStateChanged": BackgroundService.recordingStateChangedPayload;
"BackgroundService.backgroundServiceEventReceived": BackgroundService.backgroundServiceEventReceivedPayload;
+ "BluetoothEmulation.gattOperationReceived": BluetoothEmulation.gattOperationReceivedPayload;
+ "BluetoothEmulation.characteristicOperationReceived": BluetoothEmulation.characteristicOperationReceivedPayload;
+ "BluetoothEmulation.descriptorOperationReceived": BluetoothEmulation.descriptorOperationReceivedPayload;
"Browser.downloadWillBegin": Browser.downloadWillBeginPayload;
"Browser.downloadProgress": Browser.downloadProgressPayload;
"CSS.fontsUpdated": CSS.fontsUpdatedPayload;
@@ -21460,7 +21669,12 @@ Error was thrown.
"DOMStorage.domStorageItemRemoved": DOMStorage.domStorageItemRemovedPayload;
"DOMStorage.domStorageItemUpdated": DOMStorage.domStorageItemUpdatedPayload;
"DOMStorage.domStorageItemsCleared": DOMStorage.domStorageItemsClearedPayload;
+ "DeviceAccess.deviceRequestPrompted": DeviceAccess.deviceRequestPromptedPayload;
"Emulation.virtualTimeBudgetExpired": Emulation.virtualTimeBudgetExpiredPayload;
+ "FedCm.dialogShown": FedCm.dialogShownPayload;
+ "FedCm.dialogClosed": FedCm.dialogClosedPayload;
+ "Fetch.requestPaused": Fetch.requestPausedPayload;
+ "Fetch.authRequired": Fetch.authRequiredPayload;
"Input.dragIntercepted": Input.dragInterceptedPayload;
"Inspector.detached": Inspector.detachedPayload;
"Inspector.targetCrashed": Inspector.targetCrashedPayload;
@@ -21468,6 +21682,11 @@ Error was thrown.
"LayerTree.layerPainted": LayerTree.layerPaintedPayload;
"LayerTree.layerTreeDidChange": LayerTree.layerTreeDidChangePayload;
"Log.entryAdded": Log.entryAddedPayload;
+ "Media.playerPropertiesChanged": Media.playerPropertiesChangedPayload;
+ "Media.playerEventsAdded": Media.playerEventsAddedPayload;
+ "Media.playerMessagesLogged": Media.playerMessagesLoggedPayload;
+ "Media.playerErrorsRaised": Media.playerErrorsRaisedPayload;
+ "Media.playerCreated": Media.playerCreatedPayload;
"Network.dataReceived": Network.dataReceivedPayload;
"Network.eventSourceMessageReceived": Network.eventSourceMessageReceivedPayload;
"Network.loadingFailed": Network.loadingFailedPayload;
@@ -21546,6 +21765,12 @@ Error was thrown.
"Page.compilationCacheProduced": Page.compilationCacheProducedPayload;
"Performance.metrics": Performance.metricsPayload;
"PerformanceTimeline.timelineEventAdded": PerformanceTimeline.timelineEventAddedPayload;
+ "Preload.ruleSetUpdated": Preload.ruleSetUpdatedPayload;
+ "Preload.ruleSetRemoved": Preload.ruleSetRemovedPayload;
+ "Preload.preloadEnabledStateUpdated": Preload.preloadEnabledStateUpdatedPayload;
+ "Preload.prefetchStatusUpdated": Preload.prefetchStatusUpdatedPayload;
+ "Preload.prerenderStatusUpdated": Preload.prerenderStatusUpdatedPayload;
+ "Preload.preloadingAttemptSourcesUpdated": Preload.preloadingAttemptSourcesUpdatedPayload;
"Security.certificateError": Security.certificateErrorPayload;
"Security.visibleSecurityStateChanged": Security.visibleSecurityStateChangedPayload;
"Security.securityStateChanged": Security.securityStateChangedPayload;
@@ -21578,8 +21803,6 @@ Error was thrown.
"Tracing.bufferUsage": Tracing.bufferUsagePayload;
"Tracing.dataCollected": Tracing.dataCollectedPayload;
"Tracing.tracingComplete": Tracing.tracingCompletePayload;
- "Fetch.requestPaused": Fetch.requestPausedPayload;
- "Fetch.authRequired": Fetch.authRequiredPayload;
"WebAudio.contextCreated": WebAudio.contextCreatedPayload;
"WebAudio.contextWillBeDestroyed": WebAudio.contextWillBeDestroyedPayload;
"WebAudio.contextChanged": WebAudio.contextChangedPayload;
@@ -21597,23 +21820,6 @@ Error was thrown.
"WebAuthn.credentialDeleted": WebAuthn.credentialDeletedPayload;
"WebAuthn.credentialUpdated": WebAuthn.credentialUpdatedPayload;
"WebAuthn.credentialAsserted": WebAuthn.credentialAssertedPayload;
- "Media.playerPropertiesChanged": Media.playerPropertiesChangedPayload;
- "Media.playerEventsAdded": Media.playerEventsAddedPayload;
- "Media.playerMessagesLogged": Media.playerMessagesLoggedPayload;
- "Media.playerErrorsRaised": Media.playerErrorsRaisedPayload;
- "Media.playersCreated": Media.playersCreatedPayload;
- "DeviceAccess.deviceRequestPrompted": DeviceAccess.deviceRequestPromptedPayload;
- "Preload.ruleSetUpdated": Preload.ruleSetUpdatedPayload;
- "Preload.ruleSetRemoved": Preload.ruleSetRemovedPayload;
- "Preload.preloadEnabledStateUpdated": Preload.preloadEnabledStateUpdatedPayload;
- "Preload.prefetchStatusUpdated": Preload.prefetchStatusUpdatedPayload;
- "Preload.prerenderStatusUpdated": Preload.prerenderStatusUpdatedPayload;
- "Preload.preloadingAttemptSourcesUpdated": Preload.preloadingAttemptSourcesUpdatedPayload;
- "FedCm.dialogShown": FedCm.dialogShownPayload;
- "FedCm.dialogClosed": FedCm.dialogClosedPayload;
- "BluetoothEmulation.gattOperationReceived": BluetoothEmulation.gattOperationReceivedPayload;
- "BluetoothEmulation.characteristicOperationReceived": BluetoothEmulation.characteristicOperationReceivedPayload;
- "BluetoothEmulation.descriptorOperationReceived": BluetoothEmulation.descriptorOperationReceivedPayload;
"Console.messageAdded": Console.messageAddedPayload;
"Debugger.breakpointResolved": Debugger.breakpointResolvedPayload;
"Debugger.paused": Debugger.pausedPayload;
@@ -21661,12 +21867,6 @@ Error was thrown.
"Audits.enable": Audits.enableParameters;
"Audits.checkContrast": Audits.checkContrastParameters;
"Audits.checkFormsIssues": Audits.checkFormsIssuesParameters;
- "Extensions.loadUnpacked": Extensions.loadUnpackedParameters;
- "Extensions.uninstall": Extensions.uninstallParameters;
- "Extensions.getStorageItems": Extensions.getStorageItemsParameters;
- "Extensions.removeStorageItems": Extensions.removeStorageItemsParameters;
- "Extensions.clearStorageItems": Extensions.clearStorageItemsParameters;
- "Extensions.setStorageItems": Extensions.setStorageItemsParameters;
"Autofill.trigger": Autofill.triggerParameters;
"Autofill.setAddresses": Autofill.setAddressesParameters;
"Autofill.disable": Autofill.disableParameters;
@@ -21675,6 +21875,21 @@ Error was thrown.
"BackgroundService.stopObserving": BackgroundService.stopObservingParameters;
"BackgroundService.setRecording": BackgroundService.setRecordingParameters;
"BackgroundService.clearEvents": BackgroundService.clearEventsParameters;
+ "BluetoothEmulation.enable": BluetoothEmulation.enableParameters;
+ "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateParameters;
+ "BluetoothEmulation.disable": BluetoothEmulation.disableParameters;
+ "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralParameters;
+ "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementParameters;
+ "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseParameters;
+ "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseParameters;
+ "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseParameters;
+ "BluetoothEmulation.addService": BluetoothEmulation.addServiceParameters;
+ "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceParameters;
+ "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicParameters;
+ "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicParameters;
+ "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorParameters;
+ "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorParameters;
+ "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionParameters;
"Browser.setPermission": Browser.setPermissionParameters;
"Browser.grantPermissions": Browser.grantPermissionsParameters;
"Browser.resetPermissions": Browser.resetPermissionsParameters;
@@ -21806,9 +22021,6 @@ Error was thrown.
"DOMDebugger.setEventListenerBreakpoint": DOMDebugger.setEventListenerBreakpointParameters;
"DOMDebugger.setInstrumentationBreakpoint": DOMDebugger.setInstrumentationBreakpointParameters;
"DOMDebugger.setXHRBreakpoint": DOMDebugger.setXHRBreakpointParameters;
- "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointParameters;
- "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointParameters;
- "EventBreakpoints.disable": EventBreakpoints.disableParameters;
"DOMSnapshot.disable": DOMSnapshot.disableParameters;
"DOMSnapshot.enable": DOMSnapshot.enableParameters;
"DOMSnapshot.getSnapshot": DOMSnapshot.getSnapshotParameters;
@@ -21819,6 +22031,10 @@ Error was thrown.
"DOMStorage.getDOMStorageItems": DOMStorage.getDOMStorageItemsParameters;
"DOMStorage.removeDOMStorageItem": DOMStorage.removeDOMStorageItemParameters;
"DOMStorage.setDOMStorageItem": DOMStorage.setDOMStorageItemParameters;
+ "DeviceAccess.enable": DeviceAccess.enableParameters;
+ "DeviceAccess.disable": DeviceAccess.disableParameters;
+ "DeviceAccess.selectPrompt": DeviceAccess.selectPromptParameters;
+ "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptParameters;
"DeviceOrientation.clearDeviceOrientationOverride": DeviceOrientation.clearDeviceOrientationOverrideParameters;
"DeviceOrientation.setDeviceOrientationOverride": DeviceOrientation.setDeviceOrientationOverrideParameters;
"Emulation.canEmulate": Emulation.canEmulateParameters;
@@ -21864,13 +22080,41 @@ Error was thrown.
"Emulation.setUserAgentOverride": Emulation.setUserAgentOverrideParameters;
"Emulation.setAutomationOverride": Emulation.setAutomationOverrideParameters;
"Emulation.setSmallViewportHeightDifferenceOverride": Emulation.setSmallViewportHeightDifferenceOverrideParameters;
+ "Emulation.getScreenInfos": Emulation.getScreenInfosParameters;
+ "Emulation.addScreen": Emulation.addScreenParameters;
+ "Emulation.removeScreen": Emulation.removeScreenParameters;
+ "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointParameters;
+ "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointParameters;
+ "EventBreakpoints.disable": EventBreakpoints.disableParameters;
+ "Extensions.loadUnpacked": Extensions.loadUnpackedParameters;
+ "Extensions.uninstall": Extensions.uninstallParameters;
+ "Extensions.getStorageItems": Extensions.getStorageItemsParameters;
+ "Extensions.removeStorageItems": Extensions.removeStorageItemsParameters;
+ "Extensions.clearStorageItems": Extensions.clearStorageItemsParameters;
+ "Extensions.setStorageItems": Extensions.setStorageItemsParameters;
+ "FedCm.enable": FedCm.enableParameters;
+ "FedCm.disable": FedCm.disableParameters;
+ "FedCm.selectAccount": FedCm.selectAccountParameters;
+ "FedCm.clickDialogButton": FedCm.clickDialogButtonParameters;
+ "FedCm.openUrl": FedCm.openUrlParameters;
+ "FedCm.dismissDialog": FedCm.dismissDialogParameters;
+ "FedCm.resetCooldown": FedCm.resetCooldownParameters;
+ "Fetch.disable": Fetch.disableParameters;
+ "Fetch.enable": Fetch.enableParameters;
+ "Fetch.failRequest": Fetch.failRequestParameters;
+ "Fetch.fulfillRequest": Fetch.fulfillRequestParameters;
+ "Fetch.continueRequest": Fetch.continueRequestParameters;
+ "Fetch.continueWithAuth": Fetch.continueWithAuthParameters;
+ "Fetch.continueResponse": Fetch.continueResponseParameters;
+ "Fetch.getResponseBody": Fetch.getResponseBodyParameters;
+ "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamParameters;
+ "FileSystem.getDirectory": FileSystem.getDirectoryParameters;
"HeadlessExperimental.beginFrame": HeadlessExperimental.beginFrameParameters;
"HeadlessExperimental.disable": HeadlessExperimental.disableParameters;
"HeadlessExperimental.enable": HeadlessExperimental.enableParameters;
"IO.close": IO.closeParameters;
"IO.read": IO.readParameters;
"IO.resolveBlob": IO.resolveBlobParameters;
- "FileSystem.getDirectory": FileSystem.getDirectoryParameters;
"IndexedDB.clearObjectStore": IndexedDB.clearObjectStoreParameters;
"IndexedDB.deleteDatabase": IndexedDB.deleteDatabaseParameters;
"IndexedDB.deleteObjectStoreEntries": IndexedDB.deleteObjectStoreEntriesParameters;
@@ -21909,6 +22153,8 @@ Error was thrown.
"Log.enable": Log.enableParameters;
"Log.startViolationsReport": Log.startViolationsReportParameters;
"Log.stopViolationsReport": Log.stopViolationsReportParameters;
+ "Media.enable": Media.enableParameters;
+ "Media.disable": Media.disableParameters;
"Memory.getDOMCounters": Memory.getDOMCountersParameters;
"Memory.getDOMCountersForLeakDetection": Memory.getDOMCountersForLeakDetectionParameters;
"Memory.prepareForLeakDetection": Memory.prepareForLeakDetectionParameters;
@@ -21920,6 +22166,7 @@ Error was thrown.
"Memory.getAllTimeSamplingProfile": Memory.getAllTimeSamplingProfileParameters;
"Memory.getBrowserSamplingProfile": Memory.getBrowserSamplingProfileParameters;
"Memory.getSamplingProfile": Memory.getSamplingProfileParameters;
+ "Network.getIPProtectionProxyStatus": Network.getIPProtectionProxyStatusParameters;
"Network.setAcceptedEncodings": Network.setAcceptedEncodingsParameters;
"Network.clearAcceptedEncodingsOverride": Network.clearAcceptedEncodingsOverrideParameters;
"Network.canClearBrowserCache": Network.canClearBrowserCacheParameters;
@@ -21984,6 +22231,13 @@ Error was thrown.
"Overlay.setShowHinge": Overlay.setShowHingeParameters;
"Overlay.setShowIsolatedElements": Overlay.setShowIsolatedElementsParameters;
"Overlay.setShowWindowControlsOverlay": Overlay.setShowWindowControlsOverlayParameters;
+ "PWA.getOsAppState": PWA.getOsAppStateParameters;
+ "PWA.install": PWA.installParameters;
+ "PWA.uninstall": PWA.uninstallParameters;
+ "PWA.launch": PWA.launchParameters;
+ "PWA.launchFilesInApp": PWA.launchFilesInAppParameters;
+ "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppParameters;
+ "PWA.changeAppUserSettings": PWA.changeAppUserSettingsParameters;
"Page.addScriptToEvaluateOnLoad": Page.addScriptToEvaluateOnLoadParameters;
"Page.addScriptToEvaluateOnNewDocument": Page.addScriptToEvaluateOnNewDocumentParameters;
"Page.bringToFront": Page.bringToFrontParameters;
@@ -22049,6 +22303,8 @@ Error was thrown.
"Performance.setTimeDomain": Performance.setTimeDomainParameters;
"Performance.getMetrics": Performance.getMetricsParameters;
"PerformanceTimeline.enable": PerformanceTimeline.enableParameters;
+ "Preload.enable": Preload.enableParameters;
+ "Preload.disable": Preload.disableParameters;
"Security.disable": Security.disableParameters;
"Security.enable": Security.enableParameters;
"Security.setIgnoreCertificateErrors": Security.setIgnoreCertificateErrorsParameters;
@@ -22131,15 +22387,6 @@ Error was thrown.
"Tracing.recordClockSyncMarker": Tracing.recordClockSyncMarkerParameters;
"Tracing.requestMemoryDump": Tracing.requestMemoryDumpParameters;
"Tracing.start": Tracing.startParameters;
- "Fetch.disable": Fetch.disableParameters;
- "Fetch.enable": Fetch.enableParameters;
- "Fetch.failRequest": Fetch.failRequestParameters;
- "Fetch.fulfillRequest": Fetch.fulfillRequestParameters;
- "Fetch.continueRequest": Fetch.continueRequestParameters;
- "Fetch.continueWithAuth": Fetch.continueWithAuthParameters;
- "Fetch.continueResponse": Fetch.continueResponseParameters;
- "Fetch.getResponseBody": Fetch.getResponseBodyParameters;
- "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamParameters;
"WebAudio.enable": WebAudio.enableParameters;
"WebAudio.disable": WebAudio.disableParameters;
"WebAudio.getRealtimeData": WebAudio.getRealtimeDataParameters;
@@ -22156,43 +22403,6 @@ Error was thrown.
"WebAuthn.setUserVerified": WebAuthn.setUserVerifiedParameters;
"WebAuthn.setAutomaticPresenceSimulation": WebAuthn.setAutomaticPresenceSimulationParameters;
"WebAuthn.setCredentialProperties": WebAuthn.setCredentialPropertiesParameters;
- "Media.enable": Media.enableParameters;
- "Media.disable": Media.disableParameters;
- "DeviceAccess.enable": DeviceAccess.enableParameters;
- "DeviceAccess.disable": DeviceAccess.disableParameters;
- "DeviceAccess.selectPrompt": DeviceAccess.selectPromptParameters;
- "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptParameters;
- "Preload.enable": Preload.enableParameters;
- "Preload.disable": Preload.disableParameters;
- "FedCm.enable": FedCm.enableParameters;
- "FedCm.disable": FedCm.disableParameters;
- "FedCm.selectAccount": FedCm.selectAccountParameters;
- "FedCm.clickDialogButton": FedCm.clickDialogButtonParameters;
- "FedCm.openUrl": FedCm.openUrlParameters;
- "FedCm.dismissDialog": FedCm.dismissDialogParameters;
- "FedCm.resetCooldown": FedCm.resetCooldownParameters;
- "PWA.getOsAppState": PWA.getOsAppStateParameters;
- "PWA.install": PWA.installParameters;
- "PWA.uninstall": PWA.uninstallParameters;
- "PWA.launch": PWA.launchParameters;
- "PWA.launchFilesInApp": PWA.launchFilesInAppParameters;
- "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppParameters;
- "PWA.changeAppUserSettings": PWA.changeAppUserSettingsParameters;
- "BluetoothEmulation.enable": BluetoothEmulation.enableParameters;
- "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateParameters;
- "BluetoothEmulation.disable": BluetoothEmulation.disableParameters;
- "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralParameters;
- "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementParameters;
- "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseParameters;
- "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseParameters;
- "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseParameters;
- "BluetoothEmulation.addService": BluetoothEmulation.addServiceParameters;
- "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceParameters;
- "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicParameters;
- "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicParameters;
- "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorParameters;
- "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorParameters;
- "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionParameters;
"Console.clearMessages": Console.clearMessagesParameters;
"Console.disable": Console.disableParameters;
"Console.enable": Console.enableParameters;
@@ -22299,12 +22509,6 @@ Error was thrown.
"Audits.enable": Audits.enableReturnValue;
"Audits.checkContrast": Audits.checkContrastReturnValue;
"Audits.checkFormsIssues": Audits.checkFormsIssuesReturnValue;
- "Extensions.loadUnpacked": Extensions.loadUnpackedReturnValue;
- "Extensions.uninstall": Extensions.uninstallReturnValue;
- "Extensions.getStorageItems": Extensions.getStorageItemsReturnValue;
- "Extensions.removeStorageItems": Extensions.removeStorageItemsReturnValue;
- "Extensions.clearStorageItems": Extensions.clearStorageItemsReturnValue;
- "Extensions.setStorageItems": Extensions.setStorageItemsReturnValue;
"Autofill.trigger": Autofill.triggerReturnValue;
"Autofill.setAddresses": Autofill.setAddressesReturnValue;
"Autofill.disable": Autofill.disableReturnValue;
@@ -22313,6 +22517,21 @@ Error was thrown.
"BackgroundService.stopObserving": BackgroundService.stopObservingReturnValue;
"BackgroundService.setRecording": BackgroundService.setRecordingReturnValue;
"BackgroundService.clearEvents": BackgroundService.clearEventsReturnValue;
+ "BluetoothEmulation.enable": BluetoothEmulation.enableReturnValue;
+ "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateReturnValue;
+ "BluetoothEmulation.disable": BluetoothEmulation.disableReturnValue;
+ "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralReturnValue;
+ "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementReturnValue;
+ "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseReturnValue;
+ "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseReturnValue;
+ "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseReturnValue;
+ "BluetoothEmulation.addService": BluetoothEmulation.addServiceReturnValue;
+ "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceReturnValue;
+ "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicReturnValue;
+ "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicReturnValue;
+ "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorReturnValue;
+ "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorReturnValue;
+ "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionReturnValue;
"Browser.setPermission": Browser.setPermissionReturnValue;
"Browser.grantPermissions": Browser.grantPermissionsReturnValue;
"Browser.resetPermissions": Browser.resetPermissionsReturnValue;
@@ -22444,9 +22663,6 @@ Error was thrown.
"DOMDebugger.setEventListenerBreakpoint": DOMDebugger.setEventListenerBreakpointReturnValue;
"DOMDebugger.setInstrumentationBreakpoint": DOMDebugger.setInstrumentationBreakpointReturnValue;
"DOMDebugger.setXHRBreakpoint": DOMDebugger.setXHRBreakpointReturnValue;
- "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointReturnValue;
- "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointReturnValue;
- "EventBreakpoints.disable": EventBreakpoints.disableReturnValue;
"DOMSnapshot.disable": DOMSnapshot.disableReturnValue;
"DOMSnapshot.enable": DOMSnapshot.enableReturnValue;
"DOMSnapshot.getSnapshot": DOMSnapshot.getSnapshotReturnValue;
@@ -22457,6 +22673,10 @@ Error was thrown.
"DOMStorage.getDOMStorageItems": DOMStorage.getDOMStorageItemsReturnValue;
"DOMStorage.removeDOMStorageItem": DOMStorage.removeDOMStorageItemReturnValue;
"DOMStorage.setDOMStorageItem": DOMStorage.setDOMStorageItemReturnValue;
+ "DeviceAccess.enable": DeviceAccess.enableReturnValue;
+ "DeviceAccess.disable": DeviceAccess.disableReturnValue;
+ "DeviceAccess.selectPrompt": DeviceAccess.selectPromptReturnValue;
+ "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptReturnValue;
"DeviceOrientation.clearDeviceOrientationOverride": DeviceOrientation.clearDeviceOrientationOverrideReturnValue;
"DeviceOrientation.setDeviceOrientationOverride": DeviceOrientation.setDeviceOrientationOverrideReturnValue;
"Emulation.canEmulate": Emulation.canEmulateReturnValue;
@@ -22502,13 +22722,41 @@ Error was thrown.
"Emulation.setUserAgentOverride": Emulation.setUserAgentOverrideReturnValue;
"Emulation.setAutomationOverride": Emulation.setAutomationOverrideReturnValue;
"Emulation.setSmallViewportHeightDifferenceOverride": Emulation.setSmallViewportHeightDifferenceOverrideReturnValue;
+ "Emulation.getScreenInfos": Emulation.getScreenInfosReturnValue;
+ "Emulation.addScreen": Emulation.addScreenReturnValue;
+ "Emulation.removeScreen": Emulation.removeScreenReturnValue;
+ "EventBreakpoints.setInstrumentationBreakpoint": EventBreakpoints.setInstrumentationBreakpointReturnValue;
+ "EventBreakpoints.removeInstrumentationBreakpoint": EventBreakpoints.removeInstrumentationBreakpointReturnValue;
+ "EventBreakpoints.disable": EventBreakpoints.disableReturnValue;
+ "Extensions.loadUnpacked": Extensions.loadUnpackedReturnValue;
+ "Extensions.uninstall": Extensions.uninstallReturnValue;
+ "Extensions.getStorageItems": Extensions.getStorageItemsReturnValue;
+ "Extensions.removeStorageItems": Extensions.removeStorageItemsReturnValue;
+ "Extensions.clearStorageItems": Extensions.clearStorageItemsReturnValue;
+ "Extensions.setStorageItems": Extensions.setStorageItemsReturnValue;
+ "FedCm.enable": FedCm.enableReturnValue;
+ "FedCm.disable": FedCm.disableReturnValue;
+ "FedCm.selectAccount": FedCm.selectAccountReturnValue;
+ "FedCm.clickDialogButton": FedCm.clickDialogButtonReturnValue;
+ "FedCm.openUrl": FedCm.openUrlReturnValue;
+ "FedCm.dismissDialog": FedCm.dismissDialogReturnValue;
+ "FedCm.resetCooldown": FedCm.resetCooldownReturnValue;
+ "Fetch.disable": Fetch.disableReturnValue;
+ "Fetch.enable": Fetch.enableReturnValue;
+ "Fetch.failRequest": Fetch.failRequestReturnValue;
+ "Fetch.fulfillRequest": Fetch.fulfillRequestReturnValue;
+ "Fetch.continueRequest": Fetch.continueRequestReturnValue;
+ "Fetch.continueWithAuth": Fetch.continueWithAuthReturnValue;
+ "Fetch.continueResponse": Fetch.continueResponseReturnValue;
+ "Fetch.getResponseBody": Fetch.getResponseBodyReturnValue;
+ "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamReturnValue;
+ "FileSystem.getDirectory": FileSystem.getDirectoryReturnValue;
"HeadlessExperimental.beginFrame": HeadlessExperimental.beginFrameReturnValue;
"HeadlessExperimental.disable": HeadlessExperimental.disableReturnValue;
"HeadlessExperimental.enable": HeadlessExperimental.enableReturnValue;
"IO.close": IO.closeReturnValue;
"IO.read": IO.readReturnValue;
"IO.resolveBlob": IO.resolveBlobReturnValue;
- "FileSystem.getDirectory": FileSystem.getDirectoryReturnValue;
"IndexedDB.clearObjectStore": IndexedDB.clearObjectStoreReturnValue;
"IndexedDB.deleteDatabase": IndexedDB.deleteDatabaseReturnValue;
"IndexedDB.deleteObjectStoreEntries": IndexedDB.deleteObjectStoreEntriesReturnValue;
@@ -22547,6 +22795,8 @@ Error was thrown.
"Log.enable": Log.enableReturnValue;
"Log.startViolationsReport": Log.startViolationsReportReturnValue;
"Log.stopViolationsReport": Log.stopViolationsReportReturnValue;
+ "Media.enable": Media.enableReturnValue;
+ "Media.disable": Media.disableReturnValue;
"Memory.getDOMCounters": Memory.getDOMCountersReturnValue;
"Memory.getDOMCountersForLeakDetection": Memory.getDOMCountersForLeakDetectionReturnValue;
"Memory.prepareForLeakDetection": Memory.prepareForLeakDetectionReturnValue;
@@ -22558,6 +22808,7 @@ Error was thrown.
"Memory.getAllTimeSamplingProfile": Memory.getAllTimeSamplingProfileReturnValue;
"Memory.getBrowserSamplingProfile": Memory.getBrowserSamplingProfileReturnValue;
"Memory.getSamplingProfile": Memory.getSamplingProfileReturnValue;
+ "Network.getIPProtectionProxyStatus": Network.getIPProtectionProxyStatusReturnValue;
"Network.setAcceptedEncodings": Network.setAcceptedEncodingsReturnValue;
"Network.clearAcceptedEncodingsOverride": Network.clearAcceptedEncodingsOverrideReturnValue;
"Network.canClearBrowserCache": Network.canClearBrowserCacheReturnValue;
@@ -22622,6 +22873,13 @@ Error was thrown.
"Overlay.setShowHinge": Overlay.setShowHingeReturnValue;
"Overlay.setShowIsolatedElements": Overlay.setShowIsolatedElementsReturnValue;
"Overlay.setShowWindowControlsOverlay": Overlay.setShowWindowControlsOverlayReturnValue;
+ "PWA.getOsAppState": PWA.getOsAppStateReturnValue;
+ "PWA.install": PWA.installReturnValue;
+ "PWA.uninstall": PWA.uninstallReturnValue;
+ "PWA.launch": PWA.launchReturnValue;
+ "PWA.launchFilesInApp": PWA.launchFilesInAppReturnValue;
+ "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppReturnValue;
+ "PWA.changeAppUserSettings": PWA.changeAppUserSettingsReturnValue;
"Page.addScriptToEvaluateOnLoad": Page.addScriptToEvaluateOnLoadReturnValue;
"Page.addScriptToEvaluateOnNewDocument": Page.addScriptToEvaluateOnNewDocumentReturnValue;
"Page.bringToFront": Page.bringToFrontReturnValue;
@@ -22687,6 +22945,8 @@ Error was thrown.
"Performance.setTimeDomain": Performance.setTimeDomainReturnValue;
"Performance.getMetrics": Performance.getMetricsReturnValue;
"PerformanceTimeline.enable": PerformanceTimeline.enableReturnValue;
+ "Preload.enable": Preload.enableReturnValue;
+ "Preload.disable": Preload.disableReturnValue;
"Security.disable": Security.disableReturnValue;
"Security.enable": Security.enableReturnValue;
"Security.setIgnoreCertificateErrors": Security.setIgnoreCertificateErrorsReturnValue;
@@ -22769,15 +23029,6 @@ Error was thrown.
"Tracing.recordClockSyncMarker": Tracing.recordClockSyncMarkerReturnValue;
"Tracing.requestMemoryDump": Tracing.requestMemoryDumpReturnValue;
"Tracing.start": Tracing.startReturnValue;
- "Fetch.disable": Fetch.disableReturnValue;
- "Fetch.enable": Fetch.enableReturnValue;
- "Fetch.failRequest": Fetch.failRequestReturnValue;
- "Fetch.fulfillRequest": Fetch.fulfillRequestReturnValue;
- "Fetch.continueRequest": Fetch.continueRequestReturnValue;
- "Fetch.continueWithAuth": Fetch.continueWithAuthReturnValue;
- "Fetch.continueResponse": Fetch.continueResponseReturnValue;
- "Fetch.getResponseBody": Fetch.getResponseBodyReturnValue;
- "Fetch.takeResponseBodyAsStream": Fetch.takeResponseBodyAsStreamReturnValue;
"WebAudio.enable": WebAudio.enableReturnValue;
"WebAudio.disable": WebAudio.disableReturnValue;
"WebAudio.getRealtimeData": WebAudio.getRealtimeDataReturnValue;
@@ -22794,43 +23045,6 @@ Error was thrown.
"WebAuthn.setUserVerified": WebAuthn.setUserVerifiedReturnValue;
"WebAuthn.setAutomaticPresenceSimulation": WebAuthn.setAutomaticPresenceSimulationReturnValue;
"WebAuthn.setCredentialProperties": WebAuthn.setCredentialPropertiesReturnValue;
- "Media.enable": Media.enableReturnValue;
- "Media.disable": Media.disableReturnValue;
- "DeviceAccess.enable": DeviceAccess.enableReturnValue;
- "DeviceAccess.disable": DeviceAccess.disableReturnValue;
- "DeviceAccess.selectPrompt": DeviceAccess.selectPromptReturnValue;
- "DeviceAccess.cancelPrompt": DeviceAccess.cancelPromptReturnValue;
- "Preload.enable": Preload.enableReturnValue;
- "Preload.disable": Preload.disableReturnValue;
- "FedCm.enable": FedCm.enableReturnValue;
- "FedCm.disable": FedCm.disableReturnValue;
- "FedCm.selectAccount": FedCm.selectAccountReturnValue;
- "FedCm.clickDialogButton": FedCm.clickDialogButtonReturnValue;
- "FedCm.openUrl": FedCm.openUrlReturnValue;
- "FedCm.dismissDialog": FedCm.dismissDialogReturnValue;
- "FedCm.resetCooldown": FedCm.resetCooldownReturnValue;
- "PWA.getOsAppState": PWA.getOsAppStateReturnValue;
- "PWA.install": PWA.installReturnValue;
- "PWA.uninstall": PWA.uninstallReturnValue;
- "PWA.launch": PWA.launchReturnValue;
- "PWA.launchFilesInApp": PWA.launchFilesInAppReturnValue;
- "PWA.openCurrentPageInApp": PWA.openCurrentPageInAppReturnValue;
- "PWA.changeAppUserSettings": PWA.changeAppUserSettingsReturnValue;
- "BluetoothEmulation.enable": BluetoothEmulation.enableReturnValue;
- "BluetoothEmulation.setSimulatedCentralState": BluetoothEmulation.setSimulatedCentralStateReturnValue;
- "BluetoothEmulation.disable": BluetoothEmulation.disableReturnValue;
- "BluetoothEmulation.simulatePreconnectedPeripheral": BluetoothEmulation.simulatePreconnectedPeripheralReturnValue;
- "BluetoothEmulation.simulateAdvertisement": BluetoothEmulation.simulateAdvertisementReturnValue;
- "BluetoothEmulation.simulateGATTOperationResponse": BluetoothEmulation.simulateGATTOperationResponseReturnValue;
- "BluetoothEmulation.simulateCharacteristicOperationResponse": BluetoothEmulation.simulateCharacteristicOperationResponseReturnValue;
- "BluetoothEmulation.simulateDescriptorOperationResponse": BluetoothEmulation.simulateDescriptorOperationResponseReturnValue;
- "BluetoothEmulation.addService": BluetoothEmulation.addServiceReturnValue;
- "BluetoothEmulation.removeService": BluetoothEmulation.removeServiceReturnValue;
- "BluetoothEmulation.addCharacteristic": BluetoothEmulation.addCharacteristicReturnValue;
- "BluetoothEmulation.removeCharacteristic": BluetoothEmulation.removeCharacteristicReturnValue;
- "BluetoothEmulation.addDescriptor": BluetoothEmulation.addDescriptorReturnValue;
- "BluetoothEmulation.removeDescriptor": BluetoothEmulation.removeDescriptorReturnValue;
- "BluetoothEmulation.simulateGATTDisconnection": BluetoothEmulation.simulateGATTDisconnectionReturnValue;
"Console.clearMessages": Console.clearMessagesReturnValue;
"Console.disable": Console.disableReturnValue;
"Console.enable": Console.enableReturnValue;