revise 3.0.0 → 3.1.0

package/cli-output.schema.json

@@ -20,6 +20,7 @@
         "read",
         "grep",
         "search",
+        "replace-all",
         "replace-text",
         "call",
         "tools",
@@ -148,10 +149,10 @@
     },
     {
       "if": {
-        "$ref": "#/$defs/is-replace-text"
+        "$ref": "#/$defs/is-replace-all"
       },
       "then": {
-        "$ref": "#/$defs/dataOf-replace-text"
+        "$ref": "#/$defs/dataOf-replace-all"
       }
     },
     {
@@ -572,10 +573,11 @@
       },
       "required": ["data"]
     },
-    "is-replace-text": {
+    "is-replace-all": {
       "properties": {
         "command": {
-          "const": "replace-text"
+          "enum": ["replace-all", "replace-text"],
+          "description": "replace-text is the 3.0 name, reported when a command is run under it."
         },
         "data": {
           "type": "object"
@@ -966,6 +968,25 @@
         }
       }
     },
+    "view": {
+      "enum": ["tracked", "accepted", "original"],
+      "description": "How pending tracked changes read: tracked shows them, accepted and original as if every one were accepted or rejected."
+    },
+    "grepMatch": {
+      "type": "object",
+      "required": ["text", "change", "changeId"],
+      "properties": {
+        "text": {
+          "type": "string"
+        },
+        "change": {
+          "enum": ["inserted", "deleted", null]
+        },
+        "changeId": {
+          "type": ["string", "null"]
+        }
+      }
+    },
     "dataOf-grep": {
       "properties": {
         "data": {
@@ -975,6 +996,7 @@
             "pattern",
             "regex",
             "ignoreCase",
+            "view",
             "matchCount",
             "blocks"
           ],
@@ -991,6 +1013,9 @@
             "ignoreCase": {
               "type": "boolean"
             },
+            "view": {
+              "$ref": "#/$defs/view"
+            },
             "matchCount": {
               "$ref": "#/$defs/count"
             },
@@ -998,7 +1023,13 @@
               "type": "array",
               "items": {
                 "type": "object",
-                "required": ["blockId", "blockIndex", "matchCount", "text"],
+                "required": [
+                  "blockId",
+                  "blockIndex",
+                  "matchCount",
+                  "text",
+                  "matches"
+                ],
                 "properties": {
                   "blockId": {
                     "type": "string"
@@ -1011,6 +1042,12 @@
                   },
                   "text": {
                     "type": "string"
+                  },
+                  "matches": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/$defs/grepMatch"
+                    }
                   }
                 }
               }
@@ -1057,12 +1094,47 @@
             },
             "result": {
               "description": "The tool's own result; see revise tools <name>."
+            },
+            "view": {
+              "$ref": "#/$defs/view",
+              "description": "read and search: the view html and matches show. Absent for other tools."
+            },
+            "viewMatches": {
+              "description": "search: blocks the search tool can't see in this view. Tracked: matches inside deleted text. Original: every match in the original text (no search_result_id).",
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": [
+                  "query",
+                  "blockId",
+                  "blockIndex",
+                  "text",
+                  "changeIds"
+                ],
+                "properties": {
+                  "query": {
+                    "type": "string"
+                  },
+                  "blockId": {
+                    "type": "string"
+                  },
+                  "blockIndex": {
+                    "$ref": "#/$defs/count"
+                  },
+                  "text": {
+                    "type": "string"
+                  },
+                  "changeIds": {
+                    "$ref": "#/$defs/strings"
+                  }
+                }
+              }
             }
           }
         }
       }
     },
-    "dataOf-replace-text": {
+    "dataOf-replace-all": {
       "properties": {
         "data": {
           "type": "object",
@@ -1072,6 +1144,8 @@
             "replace",
             "matchedBlockIds",
             "replacedOccurrences",
+            "regions",
+            "nearMisses",
             "changeIds",
             "failures",
             "saved",
@@ -1094,6 +1168,31 @@
             "replacedOccurrences": {
               "$ref": "#/$defs/count"
             },
+            "regions": {
+              "type": "object",
+              "description": "Occurrences replaced per part of the document; parts with none are left out.",
+              "properties": {
+                "body": { "$ref": "#/$defs/count" },
+                "header": { "$ref": "#/$defs/count" },
+                "footer": { "$ref": "#/$defs/count" },
+                "footnote": { "$ref": "#/$defs/count" },
+                "endnote": { "$ref": "#/$defs/count" }
+              },
+              "additionalProperties": false
+            },
+            "nearMisses": {
+              "type": "array",
+              "description": "Text that looser matching would have replaced: other capitalization (--ignore-case) or other quotes and spaces (without --exact).",
+              "items": {
+                "type": "object",
+                "required": ["text", "count", "reason"],
+                "properties": {
+                  "text": { "type": "string" },
+                  "count": { "$ref": "#/$defs/count" },
+                  "reason": { "enum": ["case", "characters"] }
+                }
+              }
+            },
             "changeIds": {
               "$ref": "#/$defs/strings"
             },
@@ -1204,6 +1303,9 @@
             "section": {
               "type": ["string", "null"]
             },
+            "blocks": {
+              "type": ["string", "null"]
+            },
             "trackedChangeCount": {
               "$ref": "#/$defs/count"
             },
@@ -1505,6 +1607,9 @@
             "final": {
               "type": "boolean"
             },
+            "view": {
+              "$ref": "#/$defs/view"
+            },
             "trackedChangeCount": {
               "type": ["integer", "null"],
               "minimum": 0,
@@ -1719,6 +1824,9 @@
             },
             "final": {
               "type": "boolean"
+            },
+            "view": {
+              "$ref": "#/$defs/view"
             }
           }
         }