devtools-protocol 0.0.1410712 → 0.0.1413303

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -20260,6 +20260,42 @@
20260
20260
  "name": "frameResized",
20261
20261
  "experimental": true
20262
20262
  },
20263
+ {
20264
+ "name": "frameStartedNavigating",
20265
+ "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).",
20266
+ "experimental": true,
20267
+ "parameters": [
20268
+ {
20269
+ "name": "frameId",
20270
+ "description": "ID of the frame that is being navigated.",
20271
+ "$ref": "FrameId"
20272
+ },
20273
+ {
20274
+ "name": "url",
20275
+ "description": "The URL the navigation started with. The final URL can be different.",
20276
+ "type": "string"
20277
+ },
20278
+ {
20279
+ "name": "loaderId",
20280
+ "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.",
20281
+ "$ref": "Network.LoaderId"
20282
+ },
20283
+ {
20284
+ "name": "navigationType",
20285
+ "type": "string",
20286
+ "enum": [
20287
+ "reload",
20288
+ "reloadBypassingCache",
20289
+ "restore",
20290
+ "restoreWithPost",
20291
+ "historySameDocument",
20292
+ "historyDifferentDocument",
20293
+ "sameDocument",
20294
+ "differentDocument"
20295
+ ]
20296
+ }
20297
+ ]
20298
+ },
20263
20299
  {
20264
20300
  "name": "frameRequestedNavigation",
20265
20301
  "description": "Fired when a renderer-initiated navigation is requested.\nNavigation may still be cancelled after the event is issued.",
@@ -386,6 +386,22 @@
386
386
  "type": "string"
387
387
  }
388
388
  ]
389
+ },
390
+ {
391
+ "id": "ResolvedBreakpoint",
392
+ "type": "object",
393
+ "properties": [
394
+ {
395
+ "name": "breakpointId",
396
+ "description": "Breakpoint unique identifier.",
397
+ "$ref": "BreakpointId"
398
+ },
399
+ {
400
+ "name": "location",
401
+ "description": "Actual breakpoint location.",
402
+ "$ref": "Location"
403
+ }
404
+ ]
389
405
  }
390
406
  ],
391
407
  "commands": [
@@ -1180,7 +1196,8 @@
1180
1196
  "events": [
1181
1197
  {
1182
1198
  "name": "breakpointResolved",
1183
- "description": "Fired when breakpoint is resolved to an actual script and location.",
1199
+ "description": "Fired when breakpoint is resolved to an actual script and location.\nDeprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.",
1200
+ "deprecated": true,
1184
1201
  "parameters": [
1185
1202
  {
1186
1203
  "name": "breakpointId",
@@ -1500,6 +1517,16 @@
1500
1517
  "experimental": true,
1501
1518
  "optional": true,
1502
1519
  "type": "string"
1520
+ },
1521
+ {
1522
+ "name": "resolvedBreakpoints",
1523
+ "description": "The list of set breakpoints in this script if calls to `setBreakpointByUrl`\nmatches this script's URL or hash. Clients that use this list can ignore the\n`breakpointResolved` event. They are equivalent.",
1524
+ "experimental": true,
1525
+ "optional": true,
1526
+ "type": "array",
1527
+ "items": {
1528
+ "$ref": "ResolvedBreakpoint"
1529
+ }
1503
1530
  }
1504
1531
  ]
1505
1532
  }
@@ -3240,12 +3267,22 @@
3240
3267
  "returns": [
3241
3268
  {
3242
3269
  "name": "usedSize",
3243
- "description": "Used heap size in bytes.",
3270
+ "description": "Used JavaScript heap size in bytes.",
3244
3271
  "type": "number"
3245
3272
  },
3246
3273
  {
3247
3274
  "name": "totalSize",
3248
- "description": "Allocated heap size in bytes.",
3275
+ "description": "Allocated JavaScript heap size in bytes.",
3276
+ "type": "number"
3277
+ },
3278
+ {
3279
+ "name": "embedderHeapUsedSize",
3280
+ "description": "Used size in bytes in the embedder's garbage-collected heap.",
3281
+ "type": "number"
3282
+ },
3283
+ {
3284
+ "name": "backingStorageSize",
3285
+ "description": "Size in bytes of backing storage for array buffers and external strings.",
3249
3286
  "type": "number"
3250
3287
  }
3251
3288
  ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "devtools-protocol",
3
- "version": "0.0.1410712",
3
+ "version": "0.0.1413303",
4
4
  "description": "The Chrome DevTools Protocol JSON",
5
5
  "repository": "https://github.com/ChromeDevTools/devtools-protocol",
6
6
  "author": "The Chromium Authors",
@@ -9396,6 +9396,34 @@ domain Page
9396
9396
 
9397
9397
  experimental event frameResized
9398
9398
 
9399
+ # Fired when a navigation starts. This event is fired for both
9400
+ # renderer-initiated and browser-initiated navigations. For renderer-initiated
9401
+ # navigations, the event is fired after `frameRequestedNavigation`.
9402
+ # Navigation may still be cancelled after the event is issued. Multiple events
9403
+ # can be fired for a single navigation, for example, when a same-document
9404
+ # navigation becomes a cross-document navigation (such as in the case of a
9405
+ # frameset).
9406
+ experimental event frameStartedNavigating
9407
+ parameters
9408
+ # ID of the frame that is being navigated.
9409
+ FrameId frameId
9410
+ # The URL the navigation started with. The final URL can be different.
9411
+ string url
9412
+ # Loader identifier. Even though it is present in case of same-document
9413
+ # navigation, the previously committed loaderId would not change unless
9414
+ # the navigation changes from a same-document to a cross-document
9415
+ # navigation.
9416
+ Network.LoaderId loaderId
9417
+ enum navigationType
9418
+ reload
9419
+ reloadBypassingCache
9420
+ restore
9421
+ restoreWithPost
9422
+ historySameDocument
9423
+ historyDifferentDocument
9424
+ sameDocument
9425
+ differentDocument
9426
+
9399
9427
  # Fired when a renderer-initiated navigation is requested.
9400
9428
  # Navigation may still be cancelled after the event is issued.
9401
9429
  experimental event frameRequestedNavigation
@@ -564,7 +564,8 @@ domain Debugger
564
564
  experimental optional array of LocationRange skipList
565
565
 
566
566
  # Fired when breakpoint is resolved to an actual script and location.
567
- event breakpointResolved
567
+ # Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
568
+ deprecated event breakpointResolved
568
569
  parameters
569
570
  # Breakpoint unique identifier.
570
571
  BreakpointId breakpointId
@@ -622,6 +623,13 @@ domain Debugger
622
623
  # URL of the external symbol source.
623
624
  optional string externalURL
624
625
 
626
+ type ResolvedBreakpoint extends object
627
+ properties
628
+ # Breakpoint unique identifier.
629
+ BreakpointId breakpointId
630
+ # Actual breakpoint location.
631
+ Location location
632
+
625
633
  # Fired when virtual machine fails to parse the script.
626
634
  event scriptFailedToParse
627
635
  parameters
@@ -706,6 +714,10 @@ domain Debugger
706
714
  experimental optional array of Debugger.DebugSymbols debugSymbols
707
715
  # The name the embedder supplied for this script.
708
716
  experimental optional string embedderName
717
+ # The list of set breakpoints in this script if calls to `setBreakpointByUrl`
718
+ # matches this script's URL or hash. Clients that use this list can ignore the
719
+ # `breakpointResolved` event. They are equivalent.
720
+ experimental optional array of ResolvedBreakpoint resolvedBreakpoints
709
721
 
710
722
  experimental domain HeapProfiler
711
723
  depends on Runtime
@@ -1560,10 +1572,14 @@ domain Runtime
1560
1572
  # It is the total usage of the corresponding isolate not scoped to a particular Runtime.
1561
1573
  experimental command getHeapUsage
1562
1574
  returns
1563
- # Used heap size in bytes.
1575
+ # Used JavaScript heap size in bytes.
1564
1576
  number usedSize
1565
- # Allocated heap size in bytes.
1577
+ # Allocated JavaScript heap size in bytes.
1566
1578
  number totalSize
1579
+ # Used size in bytes in the embedder's garbage-collected heap.
1580
+ number embedderHeapUsedSize
1581
+ # Size in bytes of backing storage for array buffers and external strings.
1582
+ number backingStorageSize
1567
1583
 
1568
1584
  # Returns properties of a given object. Object group of the result is inherited from the target
1569
1585
  # object.
@@ -15,6 +15,7 @@ export namespace ProtocolMapping {
15
15
  'Console.messageAdded': [Protocol.Console.MessageAddedEvent];
16
16
  /**
17
17
  * Fired when breakpoint is resolved to an actual script and location.
18
+ * Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
18
19
  */
19
20
  'Debugger.breakpointResolved': [Protocol.Debugger.BreakpointResolvedEvent];
20
21
  /**
@@ -453,6 +454,16 @@ export namespace ProtocolMapping {
453
454
  */
454
455
  'Page.documentOpened': [Protocol.Page.DocumentOpenedEvent];
455
456
  'Page.frameResized': [];
457
+ /**
458
+ * Fired when a navigation starts. This event is fired for both
459
+ * renderer-initiated and browser-initiated navigations. For renderer-initiated
460
+ * navigations, the event is fired after `frameRequestedNavigation`.
461
+ * Navigation may still be cancelled after the event is issued. Multiple events
462
+ * can be fired for a single navigation, for example, when a same-document
463
+ * navigation becomes a cross-document navigation (such as in the case of a
464
+ * frameset).
465
+ */
466
+ 'Page.frameStartedNavigating': [Protocol.Page.FrameStartedNavigatingEvent];
456
467
  /**
457
468
  * Fired when a renderer-initiated navigation is requested.
458
469
  * Navigation may still be cancelled after the event is issued.
@@ -342,6 +342,7 @@ export namespace ProtocolProxyApi {
342
342
 
343
343
  /**
344
344
  * Fired when breakpoint is resolved to an actual script and location.
345
+ * Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
345
346
  */
346
347
  on(event: 'breakpointResolved', listener: (params: Protocol.Debugger.BreakpointResolvedEvent) => void): void;
347
348
 
@@ -3264,6 +3265,17 @@ export namespace ProtocolProxyApi {
3264
3265
 
3265
3266
  on(event: 'frameResized', listener: () => void): void;
3266
3267
 
3268
+ /**
3269
+ * Fired when a navigation starts. This event is fired for both
3270
+ * renderer-initiated and browser-initiated navigations. For renderer-initiated
3271
+ * navigations, the event is fired after `frameRequestedNavigation`.
3272
+ * Navigation may still be cancelled after the event is issued. Multiple events
3273
+ * can be fired for a single navigation, for example, when a same-document
3274
+ * navigation becomes a cross-document navigation (such as in the case of a
3275
+ * frameset).
3276
+ */
3277
+ on(event: 'frameStartedNavigating', listener: (params: Protocol.Page.FrameStartedNavigatingEvent) => void): void;
3278
+
3267
3279
  /**
3268
3280
  * Fired when a renderer-initiated navigation is requested.
3269
3281
  * Navigation may still be cancelled after the event is issued.
@@ -344,6 +344,7 @@ export namespace ProtocolTestsProxyApi {
344
344
 
345
345
  /**
346
346
  * Fired when breakpoint is resolved to an actual script and location.
347
+ * Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
347
348
  */
348
349
  onBreakpointResolved(listener: (event: { params: Protocol.Debugger.BreakpointResolvedEvent }) => void): void;
349
350
  offBreakpointResolved(listener: (event: { params: Protocol.Debugger.BreakpointResolvedEvent }) => void): void;
@@ -3494,6 +3495,19 @@ export namespace ProtocolTestsProxyApi {
3494
3495
  offFrameResized(listener: (event: ) => void): void;
3495
3496
  onceFrameResized(eventMatcher?: (event: ) => boolean): Promise<>;
3496
3497
 
3498
+ /**
3499
+ * Fired when a navigation starts. This event is fired for both
3500
+ * renderer-initiated and browser-initiated navigations. For renderer-initiated
3501
+ * navigations, the event is fired after `frameRequestedNavigation`.
3502
+ * Navigation may still be cancelled after the event is issued. Multiple events
3503
+ * can be fired for a single navigation, for example, when a same-document
3504
+ * navigation becomes a cross-document navigation (such as in the case of a
3505
+ * frameset).
3506
+ */
3507
+ onFrameStartedNavigating(listener: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => void): void;
3508
+ offFrameStartedNavigating(listener: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => void): void;
3509
+ onceFrameStartedNavigating(eventMatcher?: (event: { params: Protocol.Page.FrameStartedNavigatingEvent }) => boolean): Promise<{ params: Protocol.Page.FrameStartedNavigatingEvent }>;
3510
+
3497
3511
  /**
3498
3512
  * Fired when a renderer-initiated navigation is requested.
3499
3513
  * Navigation may still be cancelled after the event is issued.
@@ -289,6 +289,17 @@ export namespace Protocol {
289
289
  externalURL?: string;
290
290
  }
291
291
 
292
+ export interface ResolvedBreakpoint {
293
+ /**
294
+ * Breakpoint unique identifier.
295
+ */
296
+ breakpointId: BreakpointId;
297
+ /**
298
+ * Actual breakpoint location.
299
+ */
300
+ location: Location;
301
+ }
302
+
292
303
  export const enum ContinueToLocationRequestTargetCallFrames {
293
304
  Any = 'any',
294
305
  Current = 'current',
@@ -823,6 +834,7 @@ export namespace Protocol {
823
834
 
824
835
  /**
825
836
  * Fired when breakpoint is resolved to an actual script and location.
837
+ * Deprecated in favor of `resolvedBreakpoints` in the `scriptParsed` event.
826
838
  */
827
839
  export interface BreakpointResolvedEvent {
828
840
  /**
@@ -1048,6 +1060,12 @@ export namespace Protocol {
1048
1060
  * The name the embedder supplied for this script.
1049
1061
  */
1050
1062
  embedderName?: string;
1063
+ /**
1064
+ * The list of set breakpoints in this script if calls to `setBreakpointByUrl`
1065
+ * matches this script's URL or hash. Clients that use this list can ignore the
1066
+ * `breakpointResolved` event. They are equivalent.
1067
+ */
1068
+ resolvedBreakpoints?: ResolvedBreakpoint[];
1051
1069
  }
1052
1070
  }
1053
1071
 
@@ -2318,13 +2336,21 @@ export namespace Protocol {
2318
2336
 
2319
2337
  export interface GetHeapUsageResponse {
2320
2338
  /**
2321
- * Used heap size in bytes.
2339
+ * Used JavaScript heap size in bytes.
2322
2340
  */
2323
2341
  usedSize: number;
2324
2342
  /**
2325
- * Allocated heap size in bytes.
2343
+ * Allocated JavaScript heap size in bytes.
2326
2344
  */
2327
2345
  totalSize: number;
2346
+ /**
2347
+ * Used size in bytes in the embedder's garbage-collected heap.
2348
+ */
2349
+ embedderHeapUsedSize: number;
2350
+ /**
2351
+ * Size in bytes of backing storage for array buffers and external strings.
2352
+ */
2353
+ backingStorageSize: number;
2328
2354
  }
2329
2355
 
2330
2356
  export interface GetPropertiesRequest {
@@ -15105,6 +15131,48 @@ export namespace Protocol {
15105
15131
  frame: Frame;
15106
15132
  }
15107
15133
 
15134
+ export const enum FrameStartedNavigatingEventNavigationType {
15135
+ Reload = 'reload',
15136
+ ReloadBypassingCache = 'reloadBypassingCache',
15137
+ Restore = 'restore',
15138
+ RestoreWithPost = 'restoreWithPost',
15139
+ HistorySameDocument = 'historySameDocument',
15140
+ HistoryDifferentDocument = 'historyDifferentDocument',
15141
+ SameDocument = 'sameDocument',
15142
+ DifferentDocument = 'differentDocument',
15143
+ }
15144
+
15145
+ /**
15146
+ * Fired when a navigation starts. This event is fired for both
15147
+ * renderer-initiated and browser-initiated navigations. For renderer-initiated
15148
+ * navigations, the event is fired after `frameRequestedNavigation`.
15149
+ * Navigation may still be cancelled after the event is issued. Multiple events
15150
+ * can be fired for a single navigation, for example, when a same-document
15151
+ * navigation becomes a cross-document navigation (such as in the case of a
15152
+ * frameset).
15153
+ */
15154
+ export interface FrameStartedNavigatingEvent {
15155
+ /**
15156
+ * ID of the frame that is being navigated.
15157
+ */
15158
+ frameId: FrameId;
15159
+ /**
15160
+ * The URL the navigation started with. The final URL can be different.
15161
+ */
15162
+ url: string;
15163
+ /**
15164
+ * Loader identifier. Even though it is present in case of same-document
15165
+ * navigation, the previously committed loaderId would not change unless
15166
+ * the navigation changes from a same-document to a cross-document
15167
+ * navigation.
15168
+ */
15169
+ loaderId: Network.LoaderId;
15170
+ /**
15171
+ * (FrameStartedNavigatingEventNavigationType enum)
15172
+ */
15173
+ navigationType: ('reload' | 'reloadBypassingCache' | 'restore' | 'restoreWithPost' | 'historySameDocument' | 'historyDifferentDocument' | 'sameDocument' | 'differentDocument');
15174
+ }
15175
+
15108
15176
  /**
15109
15177
  * Fired when a renderer-initiated navigation is requested.
15110
15178
  * Navigation may still be cancelled after the event is issued.