Roll protocol to r1258865

ChromeDevTools · Feb 10, 2024 · 76bf820 · 76bf820
1 parent 726f72d
commit 76bf820
Show file tree

Hide file tree

Showing 5 changed files with 198 additions and 4 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,7 +1,73 @@
 
 
+## Roll protocol to r1258865 — _2024-02-10T04:26:45.000Z_
+######  Diff: [`726f72d...a8a6986`](https://github.com/ChromeDevTools/devtools-protocol/compare/`726f72d...a8a6986`)
+
+```diff
+@@ browser_protocol.pdl:309 @@ experimental domain Animation
+       # `Animation`'s playback rate.
+       number playbackRate
+       # `Animation`'s start time.
+-      # Milliseconds for time based animations and
+-      # percentage [0 - 100] for scroll driven animations
+-      # (i.e. when viewOrScrollTimeline exists).
+       number startTime
+       # `Animation`'s current time.
+       number currentTime
+@@ -325,26 +322,6 @@ experimental domain Animation
+       # A unique ID for `Animation` representing the sources that triggered this CSS
+       # animation/transition.
+       optional string cssId
+-      # View or scroll timeline
+-      optional ViewOrScrollTimeline viewOrScrollTimeline
+-
+-  # Timeline instance
+-  type ViewOrScrollTimeline extends object
+-    properties
+-      # Scroll container node
+-      optional DOM.BackendNodeId sourceNodeId
+-      # Represents the starting scroll position of the timeline
+-      # as a length offset in pixels from scroll origin.
+-      optional number startOffset
+-      # Represents the ending scroll position of the timeline
+-      # as a length offset in pixels from scroll origin.
+-      optional number endOffset
+-      # The element whose principal box's visibility in the
+-      # scrollport defined the progress of the timeline.
+-      # Does not exist for animations with ScrollTimeline
+-      optional DOM.BackendNodeId subjectNodeId
+-      # Orientation of the scroll
+-      DOM.ScrollOrientation axis
+
+   # AnimationEffect instance
+   type AnimationEffect extends object
+@@ -358,9 +335,6 @@ experimental domain Animation
+       # `AnimationEffect`'s iterations.
+       number iterations
+       # `AnimationEffect`'s iteration duration.
+-      # Milliseconds for time based animations and
+-      # percentage [0 - 100] for scroll driven animations
+-      # (i.e. when viewOrScrollTimeline exists).
+       number duration
+       # `AnimationEffect`'s playback direction.
+       string direction
+@@ -2585,12 +2559,6 @@ domain DOM
+       Block
+       Both
+
+-  # Physical scroll orientation
+-  type ScrollOrientation extends string
+-    enum
+-      horizontal
+-      vertical
+-
+   # DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
+   # DOMNode is a base node mirror type.
+   type Node extends object
+```
+
 ## Roll protocol to r1255431 — _2024-02-02T04:26:50.000Z_
-######  Diff: [`0abedd4...454b8fc`](https://github.com/ChromeDevTools/devtools-protocol/compare/`0abedd4...454b8fc`)
+######  Diff: [`0abedd4...726f72d`](https://github.com/ChromeDevTools/devtools-protocol/compare/`0abedd4...726f72d`)
 
 ```diff
 @@ browser_protocol.pdl:6010 @@ domain Network

diff --git a/json/browser_protocol.json b/json/browser_protocol.json
@@ -619,7 +619,7 @@
                         },
                         {
                             "name": "startTime",
-                            "description": "`Animation`'s start time.",
+                            "description": "`Animation`'s start time.\nMilliseconds for time based animations and\npercentage [0 - 100] for scroll driven animations\n(i.e. when viewOrScrollTimeline exists).",
                             "type": "number"
                         },
                         {
@@ -648,6 +648,48 @@
                             "description": "A unique ID for `Animation` representing the sources that triggered this CSS\nanimation/transition.",
                             "optional": true,
                             "type": "string"
+                        },
+                        {
+                            "name": "viewOrScrollTimeline",
+                            "description": "View or scroll timeline",
+                            "optional": true,
+                            "$ref": "ViewOrScrollTimeline"
+                        }
+                    ]
+                },
+                {
+                    "id": "ViewOrScrollTimeline",
+                    "description": "Timeline instance",
+                    "type": "object",
+                    "properties": [
+                        {
+                            "name": "sourceNodeId",
+                            "description": "Scroll container node",
+                            "optional": true,
+                            "$ref": "DOM.BackendNodeId"
+                        },
+                        {
+                            "name": "startOffset",
+                            "description": "Represents the starting scroll position of the timeline\nas a length offset in pixels from scroll origin.",
+                            "optional": true,
+                            "type": "number"
+                        },
+                        {
+                            "name": "endOffset",
+                            "description": "Represents the ending scroll position of the timeline\nas a length offset in pixels from scroll origin.",
+                            "optional": true,
+                            "type": "number"
+                        },
+                        {
+                            "name": "subjectNodeId",
+                            "description": "The element whose principal box's visibility in the\nscrollport defined the progress of the timeline.\nDoes not exist for animations with ScrollTimeline",
+                            "optional": true,
+                            "$ref": "DOM.BackendNodeId"
+                        },
+                        {
+                            "name": "axis",
+                            "description": "Orientation of the scroll",
+                            "$ref": "DOM.ScrollOrientation"
                         }
                     ]
                 },
@@ -678,7 +720,7 @@
                         },
                         {
                             "name": "duration",
-                            "description": "`AnimationEffect`'s iteration duration.",
+                            "description": "`AnimationEffect`'s iteration duration.\nMilliseconds for time based animations and\npercentage [0 - 100] for scroll driven animations\n(i.e. when viewOrScrollTimeline exists).",
                             "type": "number"
                         },
                         {
@@ -5403,6 +5445,15 @@
                         "Both"
                     ]
                 },
+                {
+                    "id": "ScrollOrientation",
+                    "description": "Physical scroll orientation",
+                    "type": "string",
+                    "enum": [
+                        "horizontal",
+                        "vertical"
+                    ]
+                },
                 {
                     "id": "Node",
                     "description": "DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.\nDOMNode is a base node mirror type.",

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "devtools-protocol",
-  "version": "0.0.1255431",
+  "version": "0.0.1258865",
   "description": "The Chrome DevTools Protocol JSON",
   "repository": "https://github.com/ChromeDevTools/devtools-protocol",
   "author": "The Chromium Authors",

diff --git a/pdl/browser_protocol.pdl b/pdl/browser_protocol.pdl
@@ -309,6 +309,9 @@ experimental domain Animation
       # `Animation`'s playback rate.
       number playbackRate
       # `Animation`'s start time.
+      # Milliseconds for time based animations and
+      # percentage [0 - 100] for scroll driven animations
+      # (i.e. when viewOrScrollTimeline exists).
       number startTime
       # `Animation`'s current time.
       number currentTime
@@ -322,6 +325,26 @@ experimental domain Animation
       # A unique ID for `Animation` representing the sources that triggered this CSS
       # animation/transition.
       optional string cssId
+      # View or scroll timeline
+      optional ViewOrScrollTimeline viewOrScrollTimeline
+
+  # Timeline instance
+  type ViewOrScrollTimeline extends object
+    properties
+      # Scroll container node
+      optional DOM.BackendNodeId sourceNodeId
+      # Represents the starting scroll position of the timeline
+      # as a length offset in pixels from scroll origin.
+      optional number startOffset
+      # Represents the ending scroll position of the timeline
+      # as a length offset in pixels from scroll origin.
+      optional number endOffset
+      # The element whose principal box's visibility in the
+      # scrollport defined the progress of the timeline.
+      # Does not exist for animations with ScrollTimeline
+      optional DOM.BackendNodeId subjectNodeId
+      # Orientation of the scroll
+      DOM.ScrollOrientation axis
 
   # AnimationEffect instance
   type AnimationEffect extends object
@@ -335,6 +358,9 @@ experimental domain Animation
       # `AnimationEffect`'s iterations.
       number iterations
       # `AnimationEffect`'s iteration duration.
+      # Milliseconds for time based animations and
+      # percentage [0 - 100] for scroll driven animations
+      # (i.e. when viewOrScrollTimeline exists).
       number duration
       # `AnimationEffect`'s playback direction.
       string direction
@@ -2559,6 +2585,12 @@ domain DOM
       Block
       Both
 
+  # Physical scroll orientation
+  type ScrollOrientation extends string
+    enum
+      horizontal
+      vertical
+
   # DOM interaction is implemented in terms of mirror objects that represent the actual DOM nodes.
   # DOMNode is a base node mirror type.
   type Node extends object

diff --git a/types/protocol.d.ts b/types/protocol.d.ts
@@ -3010,6 +3010,9 @@ export namespace Protocol {
             playbackRate: number;
             /**
              * `Animation`'s start time.
+             * Milliseconds for time based animations and
+             * percentage [0 - 100] for scroll driven animations
+             * (i.e. when viewOrScrollTimeline exists).
              */
             startTime: number;
             /**
@@ -3029,6 +3032,40 @@ export namespace Protocol {
              * animation/transition.
              */
             cssId?: string;
+            /**
+             * View or scroll timeline
+             */
+            viewOrScrollTimeline?: ViewOrScrollTimeline;
+        }
+
+        /**
+         * Timeline instance
+         */
+        export interface ViewOrScrollTimeline {
+            /**
+             * Scroll container node
+             */
+            sourceNodeId?: DOM.BackendNodeId;
+            /**
+             * Represents the starting scroll position of the timeline
+             * as a length offset in pixels from scroll origin.
+             */
+            startOffset?: number;
+            /**
+             * Represents the ending scroll position of the timeline
+             * as a length offset in pixels from scroll origin.
+             */
+            endOffset?: number;
+            /**
+             * The element whose principal box's visibility in the
+             * scrollport defined the progress of the timeline.
+             * Does not exist for animations with ScrollTimeline
+             */
+            subjectNodeId?: DOM.BackendNodeId;
+            /**
+             * Orientation of the scroll
+             */
+            axis: DOM.ScrollOrientation;
         }
 
         /**
@@ -3053,6 +3090,9 @@ export namespace Protocol {
             iterations: number;
             /**
              * `AnimationEffect`'s iteration duration.
+             * Milliseconds for time based animations and
+             * percentage [0 - 100] for scroll driven animations
+             * (i.e. when viewOrScrollTimeline exists).
              */
             duration: number;
             /**
@@ -5858,6 +5898,11 @@ export namespace Protocol {
          */
         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.