devtools-protocol 0.0.1696802 → 0.0.1697629

package/json/browser_protocol.json

@@ -9044,6 +9044,55 @@
                             "type": "boolean"
                         }
                     ]
+                },
+                {
+                    "name": "setTextMarker",
+                    "description": "Sets a spelling or grammar error marker on the given range of text.\nSee https://github.com/Igalia/explainers/blob/main/force-spelling-grammar-markers/README.md\nNote: exactly one between nodeId, backendNodeId and objectId should be passed\nto identify the node.",
+                    "experimental": true,
+                    "parameters": [
+                        {
+                            "name": "nodeId",
+                            "description": "Identifier of the node.",
+                            "optional": true,
+                            "$ref": "NodeId"
+                        },
+                        {
+                            "name": "backendNodeId",
+                            "description": "Identifier of the backend node.",
+                            "optional": true,
+                            "$ref": "BackendNodeId"
+                        },
+                        {
+                            "name": "objectId",
+                            "description": "JavaScript object id of the node wrapper.",
+                            "optional": true,
+                            "$ref": "Runtime.RemoteObjectId"
+                        },
+                        {
+                            "name": "type",
+                            "description": "The type of marker to set on the given range of text.",
+                            "type": "string",
+                            "enum": [
+                                "spelling",
+                                "grammar"
+                            ]
+                        },
+                        {
+                            "name": "start",
+                            "description": "Start offset into the element's rendered text in UTF-16 code units.\nFor a text control, an offset into the control's value.\nOffsets count text in DOM order and do not enter shadow trees.\nTo mark text inside a shadow tree, pass the element inside the shadow tree.",
+                            "type": "integer"
+                        },
+                        {
+                            "name": "end",
+                            "description": "End offset (exclusive) in the same units and space as start.",
+                            "type": "integer"
+                        }
+                    ]
+                },
+                {
+                    "name": "clearTextMarkers",
+                    "description": "Clears the spelling and grammar error text markers overlapping the ranges\nset by setTextMarker in this session. These markers are also removed when\nthe DOM domain is disabled or the session ends.",
+                    "experimental": true
                 }
             ],
             "events": [

package/package.json

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

package/pdl/domains/DOM.pdl

@@ -845,6 +845,37 @@ domain DOM
       # If true, opens and holds interest. If false, releases forced interest.
       boolean enable
 
+  # Sets a spelling or grammar error marker on the given range of text.
+  # See https://github.com/Igalia/explainers/blob/main/force-spelling-grammar-markers/README.md
+  # Note: exactly one between nodeId, backendNodeId and objectId should be passed
+  # to identify the node.
+  experimental command setTextMarker
+    parameters
+      # Identifier of the node.
+      optional NodeId nodeId
+      # Identifier of the backend node.
+      optional BackendNodeId backendNodeId
+      # JavaScript object id of the node wrapper.
+      optional Runtime.RemoteObjectId objectId
+      # The type of marker to set on the given range of text.
+      enum type
+        # A spelling error marker, rendered as ::spelling-error
+        spelling
+        # A grammar error marker, rendered as ::grammar-error
+        grammar
+      # Start offset into the element's rendered text in UTF-16 code units.
+      # For a text control, an offset into the control's value.
+      # Offsets count text in DOM order and do not enter shadow trees.
+      # To mark text inside a shadow tree, pass the element inside the shadow tree.
+      integer start
+      # End offset (exclusive) in the same units and space as start.
+      integer end
+
+  # Clears the spelling and grammar error text markers overlapping the ranges
+  # set by setTextMarker in this session. These markers are also removed when
+  # the DOM domain is disabled or the session ends.
+  experimental command clearTextMarkers
+
   # Fired when `Element`'s attribute is modified.
   event attributeModified
     parameters

package/types/protocol-mapping.d.ts

@@ -3062,6 +3062,27 @@ export namespace ProtocolMapping {
             paramsType: [Protocol.DOM.ForceShowInterestRequest];
             returnType: void;
         };
+        /**
+         * Sets a spelling or grammar error marker on the given range of text.
+         * See https://github.com/Igalia/explainers/blob/main/force-spelling-grammar-markers/README.md
+         * Note: exactly one between nodeId, backendNodeId and objectId should be passed
+         * to identify the node.
+         * @experimental
+         */
+        'DOM.setTextMarker': {
+            paramsType: [Protocol.DOM.SetTextMarkerRequest];
+            returnType: void;
+        };
+        /**
+         * Clears the spelling and grammar error text markers overlapping the ranges
+         * set by setTextMarker in this session. These markers are also removed when
+         * the DOM domain is disabled or the session ends.
+         * @experimental
+         */
+        'DOM.clearTextMarkers': {
+            paramsType: [];
+            returnType: void;
+        };
         /**
          * Returns event listeners of the given object.
          */

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

@@ -1892,6 +1892,23 @@ export namespace ProtocolProxyApi {
          */
         forceShowInterest(params: Protocol.DOM.ForceShowInterestRequest): Promise<void>;
 
+        /**
+         * Sets a spelling or grammar error marker on the given range of text.
+         * See https://github.com/Igalia/explainers/blob/main/force-spelling-grammar-markers/README.md
+         * Note: exactly one between nodeId, backendNodeId and objectId should be passed
+         * to identify the node.
+         * @experimental
+         */
+        setTextMarker(params: Protocol.DOM.SetTextMarkerRequest): Promise<void>;
+
+        /**
+         * Clears the spelling and grammar error text markers overlapping the ranges
+         * set by setTextMarker in this session. These markers are also removed when
+         * the DOM domain is disabled or the session ends.
+         * @experimental
+         */
+        clearTextMarkers(): Promise<void>;
+
         /**
          * Fired when `Element`'s attribute is modified.
          */

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

@@ -1982,6 +1982,23 @@ export namespace ProtocolTestsProxyApi {
          */
         forceShowInterest(params: Protocol.DOM.ForceShowInterestRequest): Promise<{id: number, result: void, sessionId: string}>;
 
+        /**
+         * Sets a spelling or grammar error marker on the given range of text.
+         * See https://github.com/Igalia/explainers/blob/main/force-spelling-grammar-markers/README.md
+         * Note: exactly one between nodeId, backendNodeId and objectId should be passed
+         * to identify the node.
+         * @experimental
+         */
+        setTextMarker(params: Protocol.DOM.SetTextMarkerRequest): Promise<{id: number, result: void, sessionId: string}>;
+
+        /**
+         * Clears the spelling and grammar error text markers overlapping the ranges
+         * set by setTextMarker in this session. These markers are also removed when
+         * the DOM domain is disabled or the session ends.
+         * @experimental
+         */
+        clearTextMarkers(): Promise<{id: number, result: void, sessionId: string}>;
+
         /**
          * Fired when `Element`'s attribute is modified.
          */

package/types/protocol.d.ts

@@ -8218,6 +8218,41 @@ export namespace Protocol {
             enable: boolean;
         }
 
+        export const enum SetTextMarkerRequestType {
+            Spelling = 'spelling',
+            Grammar = 'grammar',
+        }
+
+        export interface SetTextMarkerRequest {
+            /**
+             * Identifier of the node.
+             */
+            nodeId?: NodeId;
+            /**
+             * Identifier of the backend node.
+             */
+            backendNodeId?: BackendNodeId;
+            /**
+             * JavaScript object id of the node wrapper.
+             */
+            objectId?: Runtime.RemoteObjectId;
+            /**
+             * The type of marker to set on the given range of text.
+             */
+            type: ('spelling' | 'grammar');
+            /**
+             * Start offset into the element's rendered text in UTF-16 code units.
+             * For a text control, an offset into the control's value.
+             * Offsets count text in DOM order and do not enter shadow trees.
+             * To mark text inside a shadow tree, pass the element inside the shadow tree.
+             */
+            start: integer;
+            /**
+             * End offset (exclusive) in the same units and space as start.
+             */
+            end: integer;
+        }
+
         /**
          * Fired when `Element`'s attribute is modified.
          */