devtools-protocol 0.0.1412693 → 0.0.1413303

package/json/browser_protocol.json

@@ -20260,6 +20260,42 @@
                     "name": "frameResized",
                     "experimental": true
                 },
+                {
+                    "name": "frameStartedNavigating",
+                    "description": "Fired when a navigation starts. This event is fired for both\nrenderer-initiated and browser-initiated navigations. For renderer-initiated\nnavigations, the event is fired after `frameRequestedNavigation`.\nNavigation may still be cancelled after the event is issued. Multiple events\ncan be fired for a single navigation, for example, when a same-document\nnavigation becomes a cross-document navigation (such as in the case of a\nframeset).",
+                    "experimental": true,
+                    "parameters": [
+                        {
+                            "name": "frameId",
+                            "description": "ID of the frame that is being navigated.",
+                            "$ref": "FrameId"
+                        },
+                        {
+                            "name": "url",
+                            "description": "The URL the navigation started with. The final URL can be different.",
+                            "type": "string"
+                        },
+                        {
+                            "name": "loaderId",
+                            "description": "Loader identifier. Even though it is present in case of same-document\nnavigation, the previously committed loaderId would not change unless\nthe navigation changes from a same-document to a cross-document\nnavigation.",
+                            "$ref": "Network.LoaderId"
+                        },
+                        {
+                            "name": "navigationType",
+                            "type": "string",
+                            "enum": [
+                                "reload",
+                                "reloadBypassingCache",
+                                "restore",
+                                "restoreWithPost",
+                                "historySameDocument",
+                                "historyDifferentDocument",
+                                "sameDocument",
+                                "differentDocument"
+                            ]
+                        }
+                    ]
+                },
                 {
                     "name": "frameRequestedNavigation",
                     "description": "Fired when a renderer-initiated navigation is requested.\nNavigation may still be cancelled after the event is issued.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devtools-protocol",
-  "version": "0.0.1412693",
+  "version": "0.0.1413303",
   "description": "The Chrome DevTools Protocol JSON",
   "repository": "https://github.com/ChromeDevTools/devtools-protocol",
   "author": "The Chromium Authors",

package/pdl/browser_protocol.pdl

@@ -9396,6 +9396,34 @@ domain Page
 
   experimental event frameResized
 
+  # Fired when a navigation starts. This event is fired for both
+  # renderer-initiated and browser-initiated navigations. For renderer-initiated
+  # navigations, the event is fired after `frameRequestedNavigation`.
+  # Navigation may still be cancelled after the event is issued. Multiple events
+  # can be fired for a single navigation, for example, when a same-document
+  # navigation becomes a cross-document navigation (such as in the case of a
+  # frameset).
+  experimental event frameStartedNavigating
+    parameters
+      # ID of the frame that is being navigated.
+      FrameId frameId
+      # The URL the navigation started with. The final URL can be different.
+      string url
+      # Loader identifier. Even though it is present in case of same-document
+      # navigation, the previously committed loaderId would not change unless
+      # the navigation changes from a same-document to a cross-document
+      # navigation.
+      Network.LoaderId loaderId
+      enum navigationType
+        reload
+        reloadBypassingCache
+        restore
+        restoreWithPost
+        historySameDocument
+        historyDifferentDocument
+        sameDocument
+        differentDocument
+
   # Fired when a renderer-initiated navigation is requested.
   # Navigation may still be cancelled after the event is issued.
   experimental event frameRequestedNavigation

package/types/protocol-mapping.d.ts

@@ -454,6 +454,16 @@ export namespace ProtocolMapping {
          */
         'Page.documentOpened': [Protocol.Page.DocumentOpenedEvent];
         'Page.frameResized': [];
+        /**
+         * Fired when a navigation starts. This event is fired for both
+         * renderer-initiated and browser-initiated navigations. For renderer-initiated
+         * navigations, the event is fired after `frameRequestedNavigation`.
+         * Navigation may still be cancelled after the event is issued. Multiple events
+         * can be fired for a single navigation, for example, when a same-document
+         * navigation becomes a cross-document navigation (such as in the case of a
+         * frameset).
+         */
+        'Page.frameStartedNavigating': [Protocol.Page.FrameStartedNavigatingEvent];
         /**
          * Fired when a renderer-initiated navigation is requested.
          * Navigation may still be cancelled after the event is issued.

package/types/protocol-proxy-api.d.ts

@@ -3265,6 +3265,17 @@ export namespace ProtocolProxyApi {
 
         on(event: 'frameResized', listener: () => void): void;
 
+        /**
+         * Fired when a navigation starts. This event is fired for both
+         * renderer-initiated and browser-initiated navigations. For renderer-initiated
+         * navigations, the event is fired after `frameRequestedNavigation`.
+         * Navigation may still be cancelled after the event is issued. Multiple events
+         * can be fired for a single navigation, for example, when a same-document
+         * navigation becomes a cross-document navigation (such as in the case of a
+         * frameset).
+         */
+        on(event: 'frameStartedNavigating', listener: (params: Protocol.Page.FrameStartedNavigatingEvent) => void): void;
+
         /**
          * Fired when a renderer-initiated navigation is requested.
          * Navigation may still be cancelled after the event is issued.

package/types/protocol-tests-proxy-api.d.ts

@@ -3495,6 +3495,19 @@ export namespace ProtocolTestsProxyApi {
         offFrameResized(listener: (event: ) => void): void;
         onceFrameResized(eventMatcher?: (event: ) => boolean): Promise<>;
 
+        /**
+         * Fired when a navigation starts. This event is fired for both
+         * renderer-initiated and browser-initiated navigations. For renderer-initiated
+         * navigations, the event is fired after `frameRequestedNavigation`.
+         * Navigation may still be cancelled after the event is issued. Multiple events
+         * can be fired for a single navigation, for example, when a same-document
+         * navigation becomes a cross-document navigation (such as in the case of a
+         * frameset).
+         */
+        onFrameStartedNavigating(listener: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => void): void;
+        offFrameStartedNavigating(listener: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => void): void;
+        onceFrameStartedNavigating(eventMatcher?: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => boolean): Promise<{ params: Protocol.Page.FrameStartedNavigatingEvent }>;
+
         /**
          * Fired when a renderer-initiated navigation is requested.
          * Navigation may still be cancelled after the event is issued.

package/types/protocol.d.ts

@@ -15131,6 +15131,48 @@ export namespace Protocol {
             frame: Frame;
         }
 
+        export const enum FrameStartedNavigatingEventNavigationType {
+            Reload = 'reload',
+            ReloadBypassingCache = 'reloadBypassingCache',
+            Restore = 'restore',
+            RestoreWithPost = 'restoreWithPost',
+            HistorySameDocument = 'historySameDocument',
+            HistoryDifferentDocument = 'historyDifferentDocument',
+            SameDocument = 'sameDocument',
+            DifferentDocument = 'differentDocument',
+        }
+
+        /**
+         * Fired when a navigation starts. This event is fired for both
+         * renderer-initiated and browser-initiated navigations. For renderer-initiated
+         * navigations, the event is fired after `frameRequestedNavigation`.
+         * Navigation may still be cancelled after the event is issued. Multiple events
+         * can be fired for a single navigation, for example, when a same-document
+         * navigation becomes a cross-document navigation (such as in the case of a
+         * frameset).
+         */
+        export interface FrameStartedNavigatingEvent {
+            /**
+             * ID of the frame that is being navigated.
+             */
+            frameId: FrameId;
+            /**
+             * The URL the navigation started with. The final URL can be different.
+             */
+            url: string;
+            /**
+             * Loader identifier. Even though it is present in case of same-document
+             * navigation, the previously committed loaderId would not change unless
+             * the navigation changes from a same-document to a cross-document
+             * navigation.
+             */
+            loaderId: Network.LoaderId;
+            /**
+             *  (FrameStartedNavigatingEventNavigationType enum)
+             */
+            navigationType: ('reload' | 'reloadBypassingCache' | 'restore' | 'restoreWithPost' | 'historySameDocument' | 'historyDifferentDocument' | 'sameDocument' | 'differentDocument');
+        }
+
         /**
          * Fired when a renderer-initiated navigation is requested.
          * Navigation may still be cancelled after the event is issued.