devtools-protocol 0.0.1064177 → 0.0.1064701

package/json/browser_protocol.json

@@ -19223,6 +19223,29 @@
                         }
                     ]
                 },
+                {
+                    "id": "SharedStorageAccessType",
+                    "description": "Enum of shared storage access types.",
+                    "type": "string",
+                    "enum": [
+                        "documentAddModule",
+                        "documentSelectURL",
+                        "documentRun",
+                        "documentSet",
+                        "documentAppend",
+                        "documentDelete",
+                        "documentClear",
+                        "workletSet",
+                        "workletAppend",
+                        "workletDelete",
+                        "workletClear",
+                        "workletGet",
+                        "workletKeys",
+                        "workletEntries",
+                        "workletLength",
+                        "workletRemainingBudget"
+                    ]
+                },
                 {
                     "id": "SharedStorageEntry",
                     "description": "Struct for a single key-value pair in an origin's shared storage.",
@@ -19256,6 +19279,93 @@
                             "type": "number"
                         }
                     ]
+                },
+                {
+                    "id": "SharedStorageReportingMetadata",
+                    "description": "Pair of reporting metadata details for a candidate URL for `selectURL()`.",
+                    "type": "object",
+                    "properties": [
+                        {
+                            "name": "eventType",
+                            "type": "string"
+                        },
+                        {
+                            "name": "reportingUrl",
+                            "type": "string"
+                        }
+                    ]
+                },
+                {
+                    "id": "SharedStorageUrlWithMetadata",
+                    "description": "Bundles a candidate URL with its reporting metadata.",
+                    "type": "object",
+                    "properties": [
+                        {
+                            "name": "url",
+                            "description": "Spec of candidate URL.",
+                            "type": "string"
+                        },
+                        {
+                            "name": "reportingMetadata",
+                            "description": "Any associated reporting metadata.",
+                            "type": "array",
+                            "items": {
+                                "$ref": "SharedStorageReportingMetadata"
+                            }
+                        }
+                    ]
+                },
+                {
+                    "id": "SharedStorageAccessParams",
+                    "description": "Bundles the parameters for shared storage access events whose\npresence/absence can vary according to SharedStorageAccessType.",
+                    "type": "object",
+                    "properties": [
+                        {
+                            "name": "scriptSourceUrl",
+                            "description": "Spec of the module script URL.\nPresent only for SharedStorageAccessType.documentAddModule.",
+                            "optional": true,
+                            "type": "string"
+                        },
+                        {
+                            "name": "operationName",
+                            "description": "Name of the registered operation to be run.\nPresent only for SharedStorageAccessType.documentRun and\nSharedStorageAccessType.documentSelectURL.",
+                            "optional": true,
+                            "type": "string"
+                        },
+                        {
+                            "name": "serializedData",
+                            "description": "The operation's serialized data in bytes (converted to a string).\nPresent only for SharedStorageAccessType.documentRun and\nSharedStorageAccessType.documentSelectURL.",
+                            "optional": true,
+                            "type": "string"
+                        },
+                        {
+                            "name": "urlsWithMetadata",
+                            "description": "Array of candidate URLs' specs, along with any associated metadata.\nPresent only for SharedStorageAccessType.documentSelectURL.",
+                            "optional": true,
+                            "type": "array",
+                            "items": {
+                                "$ref": "SharedStorageUrlWithMetadata"
+                            }
+                        },
+                        {
+                            "name": "key",
+                            "description": "Key for a specific entry in an origin's shared storage.\nPresent only for SharedStorageAccessType.documentSet,\nSharedStorageAccessType.documentAppend,\nSharedStorageAccessType.documentDelete,\nSharedStorageAccessType.workletSet,\nSharedStorageAccessType.workletAppend,\nSharedStorageAccessType.workletDelete, and\nSharedStorageAccessType.workletGet.",
+                            "optional": true,
+                            "type": "string"
+                        },
+                        {
+                            "name": "value",
+                            "description": "Value for a specific entry in an origin's shared storage.\nPresent only for SharedStorageAccessType.documentSet,\nSharedStorageAccessType.documentAppend,\nSharedStorageAccessType.workletSet, and\nSharedStorageAccessType.workletAppend.",
+                            "optional": true,
+                            "type": "string"
+                        },
+                        {
+                            "name": "ignoreIfPresent",
+                            "description": "Whether or not to set an entry for a key if that key is already present.\nPresent only for SharedStorageAccessType.documentSet and\nSharedStorageAccessType.workletSet.",
+                            "optional": true,
+                            "type": "boolean"
+                        }
+                    ]
                 }
             ],
             "commands": [
@@ -19581,6 +19691,17 @@
                             }
                         }
                     ]
+                },
+                {
+                    "name": "setSharedStorageTracking",
+                    "description": "Enables/disables issuing of sharedStorageAccessed events.",
+                    "experimental": true,
+                    "parameters": [
+                        {
+                            "name": "enable",
+                            "type": "boolean"
+                        }
+                    ]
                 }
             ],
             "events": [
@@ -19674,6 +19795,37 @@
                             "type": "string"
                         }
                     ]
+                },
+                {
+                    "name": "sharedStorageAccessed",
+                    "description": "Shared storage was accessed by the associated page.\nThe following parameters are included in all events.",
+                    "parameters": [
+                        {
+                            "name": "accessTime",
+                            "description": "Time of the access.",
+                            "$ref": "Network.TimeSinceEpoch"
+                        },
+                        {
+                            "name": "type",
+                            "description": "Enum value indicating the Shared Storage API method invoked.",
+                            "$ref": "SharedStorageAccessType"
+                        },
+                        {
+                            "name": "mainFrameId",
+                            "description": "DevTools Frame Token for the primary frame tree's root.",
+                            "$ref": "Page.FrameId"
+                        },
+                        {
+                            "name": "ownerOrigin",
+                            "description": "Serialized origin for the context that invoked the Shared Storage API.",
+                            "type": "string"
+                        },
+                        {
+                            "name": "params",
+                            "description": "The sub-parameters warapped by `params` are all optional and their\npresence/absence depends on `type`.",
+                            "$ref": "SharedStorageAccessParams"
+                        }
+                    ]
                 }
             ]
         },

package/package.json

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

package/pdl/browser_protocol.pdl

@@ -9070,6 +9070,26 @@ experimental domain Storage
       array of InterestGroupAd ads
       array of InterestGroupAd adComponents
 
+  # Enum of shared storage access types.
+  type SharedStorageAccessType extends string
+    enum
+      documentAddModule
+      documentSelectURL
+      documentRun
+      documentSet
+      documentAppend
+      documentDelete
+      documentClear
+      workletSet
+      workletAppend
+      workletDelete
+      workletClear
+      workletGet
+      workletKeys
+      workletEntries
+      workletLength
+      workletRemainingBudget
+
   # Struct for a single key-value pair in an origin's shared storage.
   type SharedStorageEntry extends object
     properties
@@ -9083,6 +9103,58 @@ experimental domain Storage
       integer length
       number remainingBudget
 
+  # Pair of reporting metadata details for a candidate URL for `selectURL()`.
+  type SharedStorageReportingMetadata extends object
+    properties
+      string eventType
+      string reportingUrl
+
+  # Bundles a candidate URL with its reporting metadata.
+  type SharedStorageUrlWithMetadata extends object
+    properties
+      # Spec of candidate URL.
+      string url
+      # Any associated reporting metadata.
+      array of SharedStorageReportingMetadata reportingMetadata
+
+  # Bundles the parameters for shared storage access events whose
+  # presence/absence can vary according to SharedStorageAccessType.
+  type SharedStorageAccessParams extends object
+    properties
+      # Spec of the module script URL.
+      # Present only for SharedStorageAccessType.documentAddModule.
+      optional string scriptSourceUrl
+      # Name of the registered operation to be run.
+      # Present only for SharedStorageAccessType.documentRun and
+      # SharedStorageAccessType.documentSelectURL.
+      optional string operationName
+      # The operation's serialized data in bytes (converted to a string).
+      # Present only for SharedStorageAccessType.documentRun and
+      # SharedStorageAccessType.documentSelectURL.
+      optional string serializedData
+      # Array of candidate URLs' specs, along with any associated metadata.
+      # Present only for SharedStorageAccessType.documentSelectURL.
+      optional array of SharedStorageUrlWithMetadata urlsWithMetadata
+      # Key for a specific entry in an origin's shared storage.
+      # Present only for SharedStorageAccessType.documentSet,
+      # SharedStorageAccessType.documentAppend,
+      # SharedStorageAccessType.documentDelete,
+      # SharedStorageAccessType.workletSet,
+      # SharedStorageAccessType.workletAppend,
+      # SharedStorageAccessType.workletDelete, and
+      # SharedStorageAccessType.workletGet.
+      optional string key
+      # Value for a specific entry in an origin's shared storage.
+      # Present only for SharedStorageAccessType.documentSet,
+      # SharedStorageAccessType.documentAppend,
+      # SharedStorageAccessType.workletSet, and
+      # SharedStorageAccessType.workletAppend.
+      optional string value
+      # Whether or not to set an entry for a key if that key is already present.
+      # Present only for SharedStorageAccessType.documentSet and
+      # SharedStorageAccessType.workletSet.
+      optional boolean ignoreIfPresent
+
   # Returns a storage key given a frame id.
   command getStorageKeyForFrame
     parameters
@@ -9236,6 +9308,11 @@ experimental domain Storage
     returns
       array of SharedStorageEntry entries
 
+  # Enables/disables issuing of sharedStorageAccessed events.
+  experimental command setSharedStorageTracking
+    parameters
+      boolean enable
+
   # A cache's contents have been modified.
   event cacheStorageContentUpdated
     parameters
@@ -9278,6 +9355,22 @@ experimental domain Storage
       string ownerOrigin
       string name
 
+  # Shared storage was accessed by the associated page.
+  # The following parameters are included in all events.
+  event sharedStorageAccessed
+    parameters
+      # Time of the access.
+      Network.TimeSinceEpoch accessTime
+      # Enum value indicating the Shared Storage API method invoked.
+      SharedStorageAccessType type
+      # DevTools Frame Token for the primary frame tree's root.
+      Page.FrameId mainFrameId
+      # Serialized origin for the context that invoked the Shared Storage API.
+      string ownerOrigin
+      # The sub-parameters warapped by `params` are all optional and their
+      # presence/absence depends on `type`.
+      SharedStorageAccessParams params
+
 # The SystemInfo domain defines methods and events for querying low-level system information.
 experimental domain SystemInfo
 

package/types/protocol-mapping.d.ts

@@ -561,6 +561,11 @@ export namespace ProtocolMapping {
          * One of the interest groups was accessed by the associated page.
          */
         'Storage.interestGroupAccessed': [Protocol.Storage.InterestGroupAccessedEvent];
+        /**
+         * Shared storage was accessed by the associated page.
+         * The following parameters are included in all events.
+         */
+        'Storage.sharedStorageAccessed': [Protocol.Storage.SharedStorageAccessedEvent];
         /**
          * Issued when attached to target because of auto-attach or `attachToTarget` command.
          */
@@ -4108,6 +4113,13 @@ export namespace ProtocolMapping {
             paramsType: [Protocol.Storage.GetSharedStorageEntriesRequest];
             returnType: Protocol.Storage.GetSharedStorageEntriesResponse;
         };
+        /**
+         * Enables/disables issuing of sharedStorageAccessed events.
+         */
+        'Storage.setSharedStorageTracking': {
+            paramsType: [Protocol.Storage.SetSharedStorageTrackingRequest];
+            returnType: void;
+        };
         /**
          * Returns information about the system.
          */

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

@@ -3324,6 +3324,11 @@ export namespace ProtocolProxyApi {
          */
         getSharedStorageEntries(params: Protocol.Storage.GetSharedStorageEntriesRequest): Promise<Protocol.Storage.GetSharedStorageEntriesResponse>;
 
+        /**
+         * Enables/disables issuing of sharedStorageAccessed events.
+         */
+        setSharedStorageTracking(params: Protocol.Storage.SetSharedStorageTrackingRequest): Promise<void>;
+
         /**
          * A cache's contents have been modified.
          */
@@ -3349,6 +3354,12 @@ export namespace ProtocolProxyApi {
          */
         on(event: 'interestGroupAccessed', listener: (params: Protocol.Storage.InterestGroupAccessedEvent) => void): void;
 
+        /**
+         * Shared storage was accessed by the associated page.
+         * The following parameters are included in all events.
+         */
+        on(event: 'sharedStorageAccessed', listener: (params: Protocol.Storage.SharedStorageAccessedEvent) => void): void;
+
     }
 
     export interface SystemInfoApi {

package/types/protocol.d.ts

@@ -14582,6 +14582,11 @@ export namespace Protocol {
             adComponents: InterestGroupAd[];
         }
 
+        /**
+         * Enum of shared storage access types.
+         */
+        export type SharedStorageAccessType = ('documentAddModule' | 'documentSelectURL' | 'documentRun' | 'documentSet' | 'documentAppend' | 'documentDelete' | 'documentClear' | 'workletSet' | 'workletAppend' | 'workletDelete' | 'workletClear' | 'workletGet' | 'workletKeys' | 'workletEntries' | 'workletLength' | 'workletRemainingBudget');
+
         /**
          * Struct for a single key-value pair in an origin's shared storage.
          */
@@ -14599,6 +14604,82 @@ export namespace Protocol {
             remainingBudget: number;
         }
 
+        /**
+         * Pair of reporting metadata details for a candidate URL for `selectURL()`.
+         */
+        export interface SharedStorageReportingMetadata {
+            eventType: string;
+            reportingUrl: string;
+        }
+
+        /**
+         * Bundles a candidate URL with its reporting metadata.
+         */
+        export interface SharedStorageUrlWithMetadata {
+            /**
+             * Spec of candidate URL.
+             */
+            url: string;
+            /**
+             * Any associated reporting metadata.
+             */
+            reportingMetadata: SharedStorageReportingMetadata[];
+        }
+
+        /**
+         * Bundles the parameters for shared storage access events whose
+         * presence/absence can vary according to SharedStorageAccessType.
+         */
+        export interface SharedStorageAccessParams {
+            /**
+             * Spec of the module script URL.
+             * Present only for SharedStorageAccessType.documentAddModule.
+             */
+            scriptSourceUrl?: string;
+            /**
+             * Name of the registered operation to be run.
+             * Present only for SharedStorageAccessType.documentRun and
+             * SharedStorageAccessType.documentSelectURL.
+             */
+            operationName?: string;
+            /**
+             * The operation's serialized data in bytes (converted to a string).
+             * Present only for SharedStorageAccessType.documentRun and
+             * SharedStorageAccessType.documentSelectURL.
+             */
+            serializedData?: string;
+            /**
+             * Array of candidate URLs' specs, along with any associated metadata.
+             * Present only for SharedStorageAccessType.documentSelectURL.
+             */
+            urlsWithMetadata?: SharedStorageUrlWithMetadata[];
+            /**
+             * Key for a specific entry in an origin's shared storage.
+             * Present only for SharedStorageAccessType.documentSet,
+             * SharedStorageAccessType.documentAppend,
+             * SharedStorageAccessType.documentDelete,
+             * SharedStorageAccessType.workletSet,
+             * SharedStorageAccessType.workletAppend,
+             * SharedStorageAccessType.workletDelete, and
+             * SharedStorageAccessType.workletGet.
+             */
+            key?: string;
+            /**
+             * Value for a specific entry in an origin's shared storage.
+             * Present only for SharedStorageAccessType.documentSet,
+             * SharedStorageAccessType.documentAppend,
+             * SharedStorageAccessType.workletSet, and
+             * SharedStorageAccessType.workletAppend.
+             */
+            value?: string;
+            /**
+             * Whether or not to set an entry for a key if that key is already present.
+             * Present only for SharedStorageAccessType.documentSet and
+             * SharedStorageAccessType.workletSet.
+             */
+            ignoreIfPresent?: boolean;
+        }
+
         export interface GetStorageKeyForFrameRequest {
             frameId: Page.FrameId;
         }
@@ -14790,6 +14871,10 @@ export namespace Protocol {
             entries: SharedStorageEntry[];
         }
 
+        export interface SetSharedStorageTrackingRequest {
+            enable: boolean;
+        }
+
         /**
          * A cache's contents have been modified.
          */
@@ -14859,6 +14944,34 @@ export namespace Protocol {
             ownerOrigin: string;
             name: string;
         }
+
+        /**
+         * Shared storage was accessed by the associated page.
+         * The following parameters are included in all events.
+         */
+        export interface SharedStorageAccessedEvent {
+            /**
+             * Time of the access.
+             */
+            accessTime: Network.TimeSinceEpoch;
+            /**
+             * Enum value indicating the Shared Storage API method invoked.
+             */
+            type: SharedStorageAccessType;
+            /**
+             * DevTools Frame Token for the primary frame tree's root.
+             */
+            mainFrameId: Page.FrameId;
+            /**
+             * Serialized origin for the context that invoked the Shared Storage API.
+             */
+            ownerOrigin: string;
+            /**
+             * The sub-parameters warapped by `params` are all optional and their
+             * presence/absence depends on `type`.
+             */
+            params: SharedStorageAccessParams;
+        }
     }
 
     /**