devtools-protocol 0.0.1498010 → 0.0.1501221

package/pdl/domains/SystemInfo.pdl

@@ -0,0 +1,145 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+# The SystemInfo domain defines methods and events for querying low-level system information.
+experimental domain SystemInfo
+
+  # Describes a single graphics processor (GPU).
+  type GPUDevice extends object
+    properties
+      # PCI ID of the GPU vendor, if available; 0 otherwise.
+      number vendorId
+      # PCI ID of the GPU device, if available; 0 otherwise.
+      number deviceId
+      # Sub sys ID of the GPU, only available on Windows.
+      optional number subSysId
+      # Revision of the GPU, only available on Windows.
+      optional number revision
+      # String description of the GPU vendor, if the PCI ID is not available.
+      string vendorString
+      # String description of the GPU device, if the PCI ID is not available.
+      string deviceString
+      # String description of the GPU driver vendor.
+      string driverVendor
+      # String description of the GPU driver version.
+      string driverVersion
+
+  # Describes the width and height dimensions of an entity.
+  type Size extends object
+    properties
+      # Width in pixels.
+      integer width
+      # Height in pixels.
+      integer height
+
+  # Describes a supported video decoding profile with its associated minimum and
+  # maximum resolutions.
+  type VideoDecodeAcceleratorCapability extends object
+    properties
+      # Video codec profile that is supported, e.g. VP9 Profile 2.
+      string profile
+      # Maximum video dimensions in pixels supported for this |profile|.
+      Size maxResolution
+      # Minimum video dimensions in pixels supported for this |profile|.
+      Size minResolution
+
+  # Describes a supported video encoding profile with its associated maximum
+  # resolution and maximum framerate.
+  type VideoEncodeAcceleratorCapability extends object
+    properties
+      # Video codec profile that is supported, e.g H264 Main.
+      string profile
+      # Maximum video dimensions in pixels supported for this |profile|.
+      Size maxResolution
+      # Maximum encoding framerate in frames per second supported for this
+      # |profile|, as fraction's numerator and denominator, e.g. 24/1 fps,
+      # 24000/1001 fps, etc.
+      integer maxFramerateNumerator
+      integer maxFramerateDenominator
+
+  # YUV subsampling type of the pixels of a given image.
+  type SubsamplingFormat extends string
+    enum
+      yuv420
+      yuv422
+      yuv444
+
+  # Image format of a given image.
+  type ImageType extends string
+    enum
+      jpeg
+      webp
+      unknown
+
+  # Describes a supported image decoding profile with its associated minimum and
+  # maximum resolutions and subsampling.
+  type ImageDecodeAcceleratorCapability extends object
+    properties
+      # Image coded, e.g. Jpeg.
+      ImageType imageType
+      # Maximum supported dimensions of the image in pixels.
+      Size maxDimensions
+      # Minimum supported dimensions of the image in pixels.
+      Size minDimensions
+      # Optional array of supported subsampling formats, e.g. 4:2:0, if known.
+      array of SubsamplingFormat subsamplings
+
+  # Provides information about the GPU(s) on the system.
+  type GPUInfo extends object
+    properties
+      # The graphics devices on the system. Element 0 is the primary GPU.
+      array of GPUDevice devices
+      # An optional dictionary of additional GPU related attributes.
+      optional object auxAttributes
+      # An optional dictionary of graphics features and their status.
+      optional object featureStatus
+      # An optional array of GPU driver bug workarounds.
+      array of string driverBugWorkarounds
+      # Supported accelerated video decoding capabilities.
+      array of VideoDecodeAcceleratorCapability videoDecoding
+      # Supported accelerated video encoding capabilities.
+      array of VideoEncodeAcceleratorCapability videoEncoding
+      # Supported accelerated image decoding capabilities.
+      array of ImageDecodeAcceleratorCapability imageDecoding
+
+  # Represents process info.
+  type ProcessInfo extends object
+    properties
+      # Specifies process type.
+      string type
+      # Specifies process id.
+      integer id
+      # Specifies cumulative CPU usage in seconds across all threads of the
+      # process since the process start.
+      number cpuTime
+
+  # Returns information about the system.
+  command getInfo
+    returns
+      # Information about the GPUs on the system.
+      GPUInfo gpu
+      # A platform-dependent description of the model of the machine. On Mac OS, this is, for
+      # example, 'MacBookPro'. Will be the empty string if not supported.
+      string modelName
+      # A platform-dependent description of the version of the machine. On Mac OS, this is, for
+      # example, '10.1'. Will be the empty string if not supported.
+      string modelVersion
+      # The command line string used to launch the browser. Will be the empty string if not
+      # supported.
+      string commandLine
+
+  # Returns information about the feature state.
+  command getFeatureState
+    parameters
+      string featureState
+    returns
+      boolean featureEnabled
+
+  # Returns information about all running processes.
+  command getProcessInfo
+    returns
+      # An array of process info blocks.
+      array of ProcessInfo processInfo

package/pdl/domains/Target.pdl

@@ -0,0 +1,325 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+# Supports additional targets discovery and allows to attach to them.
+domain Target
+
+  type TargetID extends string
+
+  # Unique identifier of attached debugging session.
+  type SessionID extends string
+
+  type TargetInfo extends object
+    properties
+      TargetID targetId
+      # List of types: https://source.chromium.org/chromium/chromium/src/+/main:content/browser/devtools/devtools_agent_host_impl.cc?ss=chromium&q=f:devtools%20-f:out%20%22::kTypeTab%5B%5D%22
+      string type
+      string title
+      string url
+      # Whether the target has an attached client.
+      boolean attached
+      # Opener target Id
+      optional TargetID openerId
+      # Whether the target has access to the originating window.
+      experimental boolean canAccessOpener
+      # Frame id of originating window (is only set if target has an opener).
+      experimental optional Page.FrameId openerFrameId
+      experimental optional Browser.BrowserContextID browserContextId
+      # Provides additional details for specific target types. For example, for
+      # the type of "page", this may be set to "prerender".
+      experimental optional string subtype
+
+  # A filter used by target query/discovery/auto-attach operations.
+  experimental type FilterEntry extends object
+    properties
+      # If set, causes exclusion of matching targets from the list.
+      optional boolean exclude
+      # If not present, matches any type.
+      optional string type
+
+  # The entries in TargetFilter are matched sequentially against targets and
+  # the first entry that matches determines if the target is included or not,
+  # depending on the value of `exclude` field in the entry.
+  # If filter is not specified, the one assumed is
+  # [{type: "browser", exclude: true}, {type: "tab", exclude: true}, {}]
+  # (i.e. include everything but `browser` and `tab`).
+  experimental type TargetFilter extends array of FilterEntry
+
+  experimental type RemoteLocation extends object
+    properties
+      string host
+      integer port
+
+  # The state of the target window.
+  experimental type WindowState extends string
+    enum
+      normal
+      minimized
+      maximized
+      fullscreen
+
+  # Activates (focuses) the target.
+  command activateTarget
+    parameters
+      TargetID targetId
+
+  # Attaches to the target with given id.
+  command attachToTarget
+    parameters
+      TargetID targetId
+      # Enables "flat" access to the session via specifying sessionId attribute in the commands.
+      # We plan to make this the default, deprecate non-flattened mode,
+      # and eventually retire it. See crbug.com/991325.
+      optional boolean flatten
+    returns
+      # Id assigned to the session.
+      SessionID sessionId
+
+  # Attaches to the browser target, only uses flat sessionId mode.
+  experimental command attachToBrowserTarget
+    returns
+      # Id assigned to the session.
+      SessionID sessionId
+
+  # Closes the target. If the target is a page that gets closed too.
+  command closeTarget
+    parameters
+      TargetID targetId
+    returns
+      # Always set to true. If an error occurs, the response indicates protocol error.
+      deprecated boolean success
+
+  # Inject object to the target's main frame that provides a communication
+  # channel with browser target.
+  #
+  # Injected object will be available as `window[bindingName]`.
+  #
+  # The object has the following API:
+  # - `binding.send(json)` - a method to send messages over the remote debugging protocol
+  # - `binding.onmessage = json => handleMessage(json)` - a callback that will be called for the protocol notifications and command responses.
+  experimental command exposeDevToolsProtocol
+    parameters
+      TargetID targetId
+      # Binding name, 'cdp' if not specified.
+      optional string bindingName
+      # If true, inherits the current root session's permissions (default: false).
+      optional boolean inheritPermissions
+
+  # Creates a new empty BrowserContext. Similar to an incognito profile but you can have more than
+  # one.
+  command createBrowserContext
+    parameters
+      # If specified, disposes this context when debugging session disconnects.
+      experimental optional boolean disposeOnDetach
+      # Proxy server, similar to the one passed to --proxy-server
+      experimental optional string proxyServer
+      # Proxy bypass list, similar to the one passed to --proxy-bypass-list
+      experimental optional string proxyBypassList
+      # An optional list of origins to grant unlimited cross-origin access to.
+      # Parts of the URL other than those constituting origin are ignored.
+      experimental optional array of string originsWithUniversalNetworkAccess
+    returns
+      # The id of the context created.
+      Browser.BrowserContextID browserContextId
+
+  # Returns all browser contexts created with `Target.createBrowserContext` method.
+  command getBrowserContexts
+    returns
+      # An array of browser context ids.
+      array of Browser.BrowserContextID browserContextIds
+
+  # Creates a new page.
+  command createTarget
+    parameters
+      # The initial URL the page will be navigated to. An empty string indicates about:blank.
+      string url
+      # Frame left origin in DIP (requires newWindow to be true or headless shell).
+      experimental optional integer left
+      # Frame top origin in DIP (requires newWindow to be true or headless shell).
+      experimental optional integer top
+      # Frame width in DIP (requires newWindow to be true or headless shell).
+      optional integer width
+      # Frame height in DIP (requires newWindow to be true or headless shell).
+      optional integer height
+      # Frame window state (requires newWindow to be true or headless shell).
+      # Default is normal.
+      optional WindowState windowState
+      # The browser context to create the page in.
+      experimental optional Browser.BrowserContextID browserContextId
+      # Whether BeginFrames for this target will be controlled via DevTools (headless shell only,
+      # not supported on MacOS yet, false by default).
+      experimental optional boolean enableBeginFrameControl
+      # Whether to create a new Window or Tab (false by default, not supported by headless shell).
+      optional boolean newWindow
+      # Whether to create the target in background or foreground (false by default, not supported
+      # by headless shell).
+      optional boolean background
+      # Whether to create the target of type "tab".
+      experimental optional boolean forTab
+      # Whether to create a hidden target. The hidden target is observable via protocol, but not
+      # present in the tab UI strip. Cannot be created with `forTab: true`, `newWindow: true` or
+      # `background: false`. The life-time of the tab is limited to the life-time of the session.
+      experimental optional boolean hidden
+    returns
+      # The id of the page opened.
+      TargetID targetId
+
+  # Detaches session with given id.
+  command detachFromTarget
+    parameters
+      # Session to detach.
+      optional SessionID sessionId
+      # Deprecated.
+      deprecated optional TargetID targetId
+
+  # Deletes a BrowserContext. All the belonging pages will be closed without calling their
+  # beforeunload hooks.
+  command disposeBrowserContext
+    parameters
+      Browser.BrowserContextID browserContextId
+
+  # Returns information about a target.
+  experimental command getTargetInfo
+    parameters
+      optional TargetID targetId
+    returns
+      TargetInfo targetInfo
+
+  # Retrieves a list of available targets.
+  command getTargets
+    parameters
+      # Only targets matching filter will be reported. If filter is not specified
+      # and target discovery is currently enabled, a filter used for target discovery
+      # is used for consistency.
+      experimental optional TargetFilter filter
+    returns
+      # The list of targets.
+      array of TargetInfo targetInfos
+
+  # Sends protocol message over session with given id.
+  # Consider using flat mode instead; see commands attachToTarget, setAutoAttach,
+  # and crbug.com/991325.
+  deprecated command sendMessageToTarget
+    parameters
+      string message
+      # Identifier of the session.
+      optional SessionID sessionId
+      # Deprecated.
+      deprecated optional TargetID targetId
+
+  # Controls whether to automatically attach to new targets which are considered
+  # to be directly related to this one (for example, iframes or workers).
+  # When turned on, attaches to all existing related targets as well. When turned off,
+  # automatically detaches from all currently attached targets.
+  # This also clears all targets added by `autoAttachRelated` from the list of targets to watch
+  # for creation of related targets.
+  # You might want to call this recursively for auto-attached targets to attach
+  # to all available targets.
+  command setAutoAttach
+    parameters
+      # Whether to auto-attach to related targets.
+      boolean autoAttach
+      # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
+      # to run paused targets.
+      boolean waitForDebuggerOnStart
+      # Enables "flat" access to the session via specifying sessionId attribute in the commands.
+      # We plan to make this the default, deprecate non-flattened mode,
+      # and eventually retire it. See crbug.com/991325.
+      experimental optional boolean flatten
+      # Only targets matching filter will be attached.
+      experimental optional TargetFilter filter
+
+  # Adds the specified target to the list of targets that will be monitored for any related target
+  # creation (such as child frames, child workers and new versions of service worker) and reported
+  # through `attachedToTarget`. The specified target is also auto-attached.
+  # This cancels the effect of any previous `setAutoAttach` and is also cancelled by subsequent
+  # `setAutoAttach`. Only available at the Browser target.
+  experimental command autoAttachRelated
+    parameters
+      TargetID targetId
+      # Whether to pause new targets when attaching to them. Use `Runtime.runIfWaitingForDebugger`
+      # to run paused targets.
+      boolean waitForDebuggerOnStart
+      # Only targets matching filter will be attached.
+      experimental optional TargetFilter filter
+
+  # Controls whether to discover available targets and notify via
+  # `targetCreated/targetInfoChanged/targetDestroyed` events.
+  command setDiscoverTargets
+    parameters
+      # Whether to discover available targets.
+      boolean discover
+      # Only targets matching filter will be attached. If `discover` is false,
+      # `filter` must be omitted or empty.
+      experimental optional TargetFilter filter
+
+  # Enables target discovery for the specified locations, when `setDiscoverTargets` was set to
+  # `true`.
+  experimental command setRemoteLocations
+    parameters
+      # List of remote locations.
+      array of RemoteLocation locations
+
+  # Issued when attached to target because of auto-attach or `attachToTarget` command.
+  experimental event attachedToTarget
+    parameters
+      # Identifier assigned to the session used to send/receive messages.
+      SessionID sessionId
+      TargetInfo targetInfo
+      boolean waitingForDebugger
+
+  # Issued when detached from target for any reason (including `detachFromTarget` command). Can be
+  # issued multiple times per target if multiple sessions have been attached to it.
+  experimental event detachedFromTarget
+    parameters
+      # Detached session identifier.
+      SessionID sessionId
+      # Deprecated.
+      deprecated optional TargetID targetId
+
+  # Notifies about a new protocol message received from the session (as reported in
+  # `attachedToTarget` event).
+  event receivedMessageFromTarget
+    parameters
+      # Identifier of a session which sends a message.
+      SessionID sessionId
+      string message
+      # Deprecated.
+      deprecated optional TargetID targetId
+
+  # Issued when a possible inspection target is created.
+  event targetCreated
+    parameters
+      TargetInfo targetInfo
+
+  # Issued when a target is destroyed.
+  event targetDestroyed
+    parameters
+      TargetID targetId
+
+  # Issued when a target has crashed.
+  event targetCrashed
+    parameters
+      TargetID targetId
+      # Termination status type.
+      string status
+      # Termination error code.
+      integer errorCode
+
+  # Issued when some information about a target has changed. This only happens between
+  # `targetCreated` and `targetDestroyed`.
+  event targetInfoChanged
+    parameters
+      TargetInfo targetInfo
+
+  # Opens a DevTools window for the target.
+  experimental command openDevTools
+    parameters
+      # This can be the page or tab target ID.
+      TargetID targetId
+    returns
+      # The targetId of DevTools page target.
+      TargetID targetId

package/pdl/domains/Tethering.pdl

@@ -0,0 +1,28 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+# The Tethering domain defines methods and events for browser port binding.
+experimental domain Tethering
+
+  # Request browser port binding.
+  command bind
+    parameters
+      # Port number to bind.
+      integer port
+
+  # Request browser port unbinding.
+  command unbind
+    parameters
+      # Port number to unbind.
+      integer port
+
+  # Informs that port was successfully bound and got a specified connection id.
+  event accepted
+    parameters
+      # Port number that was successfully bound.
+      integer port
+      # Connection id to be used.
+      string connectionId

package/pdl/domains/Tracing.pdl

@@ -0,0 +1,157 @@
+# Copyright 2017 The Chromium Authors
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+#
+# Contributing to Chrome DevTools Protocol: https://goo.gle/devtools-contribution-guide-cdp
+
+domain Tracing
+  depends on IO
+
+  # Configuration for memory dump. Used only when "memory-infra" category is enabled.
+  experimental type MemoryDumpConfig extends object
+
+  type TraceConfig extends object
+    properties
+      # Controls how the trace buffer stores data. The default is `recordUntilFull`.
+      experimental optional enum recordMode
+        recordUntilFull
+        recordContinuously
+        recordAsMuchAsPossible
+        echoToConsole
+      # Size of the trace buffer in kilobytes. If not specified or zero is passed, a default value
+      # of 200 MB would be used.
+      experimental optional number traceBufferSizeInKb
+      # Turns on JavaScript stack sampling.
+      experimental optional boolean enableSampling
+      # Turns on system tracing.
+      experimental optional boolean enableSystrace
+      # Turns on argument filter.
+      experimental optional boolean enableArgumentFilter
+      # Included category filters.
+      optional array of string includedCategories
+      # Excluded category filters.
+      optional array of string excludedCategories
+      # Configuration to synthesize the delays in tracing.
+      experimental optional array of string syntheticDelays
+      # Configuration for memory dump triggers. Used only when "memory-infra" category is enabled.
+      experimental optional MemoryDumpConfig memoryDumpConfig
+
+  # Data format of a trace. Can be either the legacy JSON format or the
+  # protocol buffer format. Note that the JSON format will be deprecated soon.
+  experimental type StreamFormat extends string
+    enum
+      json
+      proto
+
+  # Compression type to use for traces returned via streams.
+  experimental type StreamCompression extends string
+    enum
+      none
+      gzip
+
+  # Details exposed when memory request explicitly declared.
+  # Keep consistent with memory_dump_request_args.h and
+  # memory_instrumentation.mojom
+  experimental type MemoryDumpLevelOfDetail extends string
+    enum
+      background
+      light
+      detailed
+
+  # Backend type to use for tracing. `chrome` uses the Chrome-integrated
+  # tracing service and is supported on all platforms. `system` is only
+  # supported on Chrome OS and uses the Perfetto system tracing service.
+  # `auto` chooses `system` when the perfettoConfig provided to Tracing.start
+  # specifies at least one non-Chrome data source; otherwise uses `chrome`.
+  experimental type TracingBackend extends string
+    enum
+      auto
+      chrome
+      system
+
+  # Stop trace events collection.
+  command end
+
+  # Gets supported tracing categories.
+  experimental command getCategories
+    returns
+      # A list of supported tracing categories.
+      array of string categories
+
+  # Record a clock sync marker in the trace.
+  experimental command recordClockSyncMarker
+    parameters
+      # The ID of this clock sync marker
+      string syncId
+
+  # Request a global memory dump.
+  experimental command requestMemoryDump
+    parameters
+      # Enables more deterministic results by forcing garbage collection
+      optional boolean deterministic
+      # Specifies level of details in memory dump. Defaults to "detailed".
+      optional MemoryDumpLevelOfDetail levelOfDetail
+    returns
+      # GUID of the resulting global memory dump.
+      string dumpGuid
+      # True iff the global memory dump succeeded.
+      boolean success
+
+  # Start trace events collection.
+  command start
+    parameters
+      # Category/tag filter
+      experimental deprecated optional string categories
+      # Tracing options
+      experimental deprecated optional string options
+      # If set, the agent will issue bufferUsage events at this interval, specified in milliseconds
+      experimental optional number bufferUsageReportingInterval
+      # Whether to report trace events as series of dataCollected events or to save trace to a
+      # stream (defaults to `ReportEvents`).
+      optional enum transferMode
+        ReportEvents
+        ReturnAsStream
+      # Trace data format to use. This only applies when using `ReturnAsStream`
+      # transfer mode (defaults to `json`).
+      optional StreamFormat streamFormat
+      # Compression format to use. This only applies when using `ReturnAsStream`
+      # transfer mode (defaults to `none`)
+      experimental optional StreamCompression streamCompression
+      optional TraceConfig traceConfig
+      # Base64-encoded serialized perfetto.protos.TraceConfig protobuf message
+      # When specified, the parameters `categories`, `options`, `traceConfig`
+      # are ignored.
+      experimental optional binary perfettoConfig
+      # Backend type (defaults to `auto`)
+      experimental optional TracingBackend tracingBackend
+
+  experimental event bufferUsage
+    parameters
+      # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
+      # total size.
+      optional number percentFull
+      # An approximate number of events in the trace log.
+      optional number eventCount
+      # A number in range [0..1] that indicates the used size of event buffer as a fraction of its
+      # total size.
+      optional number value
+
+  # Contains a bucket of collected trace events. When tracing is stopped collected events will be
+  # sent as a sequence of dataCollected events followed by tracingComplete event.
+  experimental event dataCollected
+    parameters
+      array of object value
+
+  # Signals that tracing is stopped and there is no trace buffers pending flush, all data were
+  # delivered via dataCollected events.
+  event tracingComplete
+    parameters
+      # Indicates whether some trace data is known to have been lost, e.g. because the trace ring
+      # buffer wrapped around.
+      boolean dataLossOccurred
+      # A handle of the stream that holds resulting trace data.
+      optional IO.StreamHandle stream
+      # Trace data format of returned stream.
+      optional StreamFormat traceFormat
+      # Compression format of returned stream.
+      optional StreamCompression streamCompression