@clowder-ai/plugin-contract 0.1.0-beta.9 → 0.3.0

package/src/schemas/docx-materialization.schema.json

@@ -0,0 +1,302 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://clowder-ai.dev/schemas/docx-materialization/v1",
+  "title": "Independent DOCX materialization protocol",
+  "description": "Host-internal, content-editor-provider worker protocol. No capability token, content binding, Host path or owner effect API crosses this boundary. Inspect is read-only; generated bytes remain uncommitted until the Host rechecks authority and owner CAS.",
+  "$defs": {
+    "DocxMaterializationText": {
+      "type": "string",
+      "pattern": "^[\\u0009\\u000A\\u0020-\\uD7FF\\uE000-\\uFFFD\\u{10000}-\\u{10FFFF}]*(?![\\s\\S])",
+      "description": "Lossless XML 1.0 text: valid Unicode scalars only; CR is rejected because the frozen engine emits it literally and XML end-of-line normalization changes it. TAB and LF are supported. No sanitization is permitted."
+    },
+    "DocxMaterializationAuthor": {
+      "type": "string",
+      "pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\u{10000}-\\u{10FFFF}]*(?![\\s\\S])",
+      "description": "Lossless XML 1.0 attribute text. TAB, LF and CR are excluded because XML attribute normalization would change the author identity."
+    },
+    "DocxMaterializationBytes": {
+      "type": "string",
+      "minLength": 4,
+      "maxLength": 11184812,
+      "pattern": "^[A-Za-z0-9+/]*={0,2}$",
+      "description": "Canonical base64, at most 8 MiB decoded. Hosts enforce decoded size and canonical encoding before launch and after return."
+    },
+    "DocxMaterializationAnchor": {
+      "type": "object",
+      "properties": {
+        "paragraphId": {
+          "type": "string",
+          "minLength": 68,
+          "maxLength": 88,
+          "pattern": "^p:[0-9]{1,10}:[a-f0-9]{64}$"
+        },
+        "textQuote": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 8192
+        }
+      },
+      "required": [
+        "paragraphId",
+        "textQuote"
+      ],
+      "additionalProperties": false
+    },
+    "DocxMaterializationAttribution": {
+      "type": "object",
+      "properties": {
+        "author": {
+          "$ref": "#/$defs/DocxMaterializationAuthor",
+          "minLength": 1,
+          "maxLength": 64
+        },
+        "operationId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "timestamp": {
+          "type": "string",
+          "minLength": 20,
+          "maxLength": 24,
+          "format": "date-time"
+        }
+      },
+      "required": [
+        "author",
+        "operationId",
+        "timestamp"
+      ],
+      "additionalProperties": false
+    },
+    "DocxMaterializationOperation": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "inspect"
+            },
+            "cursor": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 65535
+            },
+            "limit": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 32
+            }
+          },
+          "required": [
+            "kind",
+            "cursor",
+            "limit"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "tracked-change"
+            },
+            "target": {
+              "$ref": "#/$defs/DocxMaterializationAnchor"
+            },
+            "replacement": {
+              "$ref": "#/$defs/DocxMaterializationText",
+              "minLength": 0,
+              "maxLength": 8192
+            },
+            "attribution": {
+              "$ref": "#/$defs/DocxMaterializationAttribution"
+            }
+          },
+          "required": [
+            "kind",
+            "target",
+            "replacement",
+            "attribution"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "comment"
+            },
+            "target": {
+              "$ref": "#/$defs/DocxMaterializationAnchor"
+            },
+            "body": {
+              "$ref": "#/$defs/DocxMaterializationText",
+              "minLength": 1,
+              "maxLength": 8192
+            },
+            "attribution": {
+              "$ref": "#/$defs/DocxMaterializationAttribution"
+            }
+          },
+          "required": [
+            "kind",
+            "target",
+            "body",
+            "attribution"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "DocxMaterializationRequest": {
+      "type": "object",
+      "properties": {
+        "protocolVersion": {
+          "const": "1.0.0"
+        },
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "mediaType": {
+          "const": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+        },
+        "bytesBase64": {
+          "$ref": "#/$defs/DocxMaterializationBytes"
+        },
+        "operation": {
+          "$ref": "#/$defs/DocxMaterializationOperation"
+        }
+      },
+      "required": [
+        "protocolVersion",
+        "requestId",
+        "mediaType",
+        "bytesBase64",
+        "operation"
+      ],
+      "additionalProperties": false
+    },
+    "DocxMaterializationResult": {
+      "oneOf": [
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "inspection"
+            },
+            "paragraphs": {
+              "type": "array",
+              "maxItems": 32,
+              "items": {
+                "type": "object",
+                "properties": {
+                  "target": {
+                    "$ref": "#/$defs/DocxMaterializationAnchor"
+                  },
+                  "editable": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "target",
+                  "editable"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "nextCursor": {
+              "anyOf": [
+                {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 65535
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            }
+          },
+          "required": [
+            "kind",
+            "paragraphs",
+            "nextCursor"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "document"
+            },
+            "bytesBase64": {
+              "$ref": "#/$defs/DocxMaterializationBytes"
+            }
+          },
+          "required": [
+            "kind",
+            "bytesBase64"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "kind": {
+              "const": "rejected"
+            },
+            "code": {
+              "type": "string",
+              "enum": [
+                "INVALID_DOCX",
+                "TARGET_MISMATCH",
+                "UNSUPPORTED_TARGET",
+                "LIMIT_EXCEEDED",
+                "INVALID_REQUEST"
+              ]
+            }
+          },
+          "required": [
+            "kind",
+            "code"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    },
+    "DocxMaterializationResponse": {
+      "type": "object",
+      "properties": {
+        "protocolVersion": {
+          "const": "1.0.0"
+        },
+        "requestId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 128
+        },
+        "result": {
+          "$ref": "#/$defs/DocxMaterializationResult"
+        }
+      },
+      "required": [
+        "protocolVersion",
+        "requestId",
+        "result"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "oneOf": [
+    {
+      "$ref": "#/$defs/DocxMaterializationRequest"
+    },
+    {
+      "$ref": "#/$defs/DocxMaterializationResponse"
+    }
+  ]
+}