@kumwe/studio-protocol 0.1.0-alpha.6 → 0.1.0-rc.1

package/schemas/binding-projection-vector.schema.json

@@ -0,0 +1,127 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/binding-projection-vector.schema.json",
+  "title": "Studio field-binding projection conformance vector",
+  "description": "One complete Blueprint, exact host-projected content model, locked block definitions, and the normalized field-binding affordances and diagnostics every implementation must reproduce.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "description",
+    "profile",
+    "blueprint",
+    "model",
+    "blockDefinitions",
+    "expect"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "binding-projection-vector" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "description": { "type": "string", "minLength": 1, "maxLength": 1000 },
+    "profile": { "const": "studio.profile/binding-projection-v1" },
+    "blueprint": { "$ref": "blueprint.schema.json" },
+    "model": { "$ref": "content-model.schema.json" },
+    "blockDefinitions": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1000,
+      "items": { "$ref": "block-definition.schema.json" }
+    },
+    "expect": { "$ref": "#/$defs/projection" }
+  },
+  "$defs": {
+    "fieldPath": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 32,
+      "items": { "$ref": "common.schema.json#/$defs/localName" }
+    },
+    "candidate": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["fieldPath", "kind", "cardinality"],
+      "properties": {
+        "fieldPath": { "$ref": "#/$defs/fieldPath" },
+        "kind": {
+          "$ref": "content-model.schema.json#/$defs/field/properties/kind"
+        },
+        "itemKind": {
+          "$ref": "content-model.schema.json#/$defs/field/properties/itemKind"
+        },
+        "cardinality": { "enum": ["one", "many"] },
+        "control": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+      }
+    },
+    "port": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["port", "status", "candidates"],
+      "properties": {
+        "port": { "$ref": "common.schema.json#/$defs/localName" },
+        "status": { "enum": ["invalid", "non-field-source", "resolved", "unbound"] },
+        "bindingSourceKind": {
+          "enum": [
+            "context-value",
+            "entry-field",
+            "query-reference",
+            "resource-reference",
+            "static-value"
+          ]
+        },
+        "boundFieldPath": { "$ref": "#/$defs/fieldPath" },
+        "candidates": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": { "$ref": "#/$defs/candidate" }
+        },
+        "multiple": { "type": "boolean" },
+        "required": { "type": "boolean" },
+        "valueType": { "type": "string", "minLength": 1, "maxLength": 200 }
+      }
+    },
+    "node": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "ports"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "ports": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/port" }
+        }
+      }
+    },
+    "diagnostic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "severity"],
+      "properties": {
+        "code": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "severity": { "enum": ["information", "warning", "error", "blocking"] },
+        "location": { "$ref": "common.schema.json#/$defs/diagnosticLocation" }
+      }
+    },
+    "projection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["model", "nodes", "diagnostics"],
+      "properties": {
+        "model": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "nodes": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": { "$ref": "#/$defs/node" }
+        },
+        "diagnostics": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": { "$ref": "#/$defs/diagnostic" }
+        }
+      }
+    }
+  }
+}

package/schemas/block-definition.schema.json

@@ -140,7 +140,16 @@
             ]
           },
           "required": { "type": "boolean" },
-          "multiple": { "type": "boolean" }
+          "multiple": { "type": "boolean" },
+          "authoring": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "control": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "profile": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "readOnly": { "type": "boolean" }
+            }
+          }
         }
       }
     },

package/schemas/host-vector.schema.json

@@ -133,6 +133,8 @@
               "enum": [
                 "artifact",
                 "artifact-references",
+                "content-model",
+                "content-models",
                 "media-asset",
                 "media-page",
                 "message-bundle",

package/schemas/manifest.json

@@ -1,10 +1,29 @@
 {
   "contractVersion": "0.1-draft",
   "epoch": "https://schemas.kumwe.org/studio/v1/",
+  "generator": {
+    "name": "@kumwe/studio/schema-manifest",
+    "version": "1.0.0"
+  },
   "kind": "schema-manifest",
   "schemas": [
     {
-      "digest": "sha256-sx4nxAo1fq7Mjp2J3gfsIWRq9vD6nkDDrc1PtWLzfNE=",
+      "digest": "sha256-WvSNMOQ3OZWs7ZKBCCRRwLtw5byZBtn6Rwvxz74vfAY=",
+      "file": "authoring-message-catalog.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/authoring-message-catalog.schema.json"
+    },
+    {
+      "digest": "sha256-hZBNrpwHkLuUu/mPeU2UWtuOXfvZgrd8MO7vB9fJWog=",
+      "file": "authoring-web-vector.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/authoring-web-vector.schema.json"
+    },
+    {
+      "digest": "sha256-GCk2z8XalwUUKM6R146c7WeCj3CY00kTMRKtPjaeehs=",
+      "file": "binding-projection-vector.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/binding-projection-vector.schema.json"
+    },
+    {
+      "digest": "sha256-S3sx0m9PQs2vMFNvYIapBXc8W184cEng5MFF54C6RwQ=",
       "file": "block-definition.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/block-definition.schema.json"
     },
@@ -89,7 +108,7 @@
       "id": "https://schemas.kumwe.org/studio/v1/host-sequence-vector.schema.json"
     },
     {
-      "digest": "sha256-KETVqPMNQCSN8faoNW7fHuSWc6rT/Jkp4+Lh31gQuQM=",
+      "digest": "sha256-v2LFWwqpa0hS9XnYaVP9xC7Ohyw+Dl7ZG4e038+LqtI=",
       "file": "host-vector.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/host-vector.schema.json"
     },
@@ -154,12 +173,17 @@
       "id": "https://schemas.kumwe.org/studio/v1/provenance.schema.json"
     },
     {
-      "digest": "sha256-PKyCGI95WZ6Uojq9u5HvS2wwWU97+V+nmsY4l/Vc040=",
+      "digest": "sha256-oi//2JX617h+s50otcRWB4/ZTnv4iVo+gngpr73i+EA=",
+      "file": "renderer-web-vector.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/renderer-web-vector.schema.json"
+    },
+    {
+      "digest": "sha256-74OcoS9iGzRnDOjo/opHhlXZdxMLcCUkw0Ol4ipzkws=",
       "file": "rich-text-projection.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/rich-text-projection.schema.json"
     },
     {
-      "digest": "sha256-PgFfnylfsJzq7B0wQq1gAxYA0r6gMx+xiKeT3NiDVqc=",
+      "digest": "sha256-r+wYEvy3tvMdQhmU0272K1cklAiYcEiD7nICWDdFFPs=",
       "file": "rich-text.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/rich-text.schema.json"
     },
@@ -173,11 +197,41 @@
       "file": "schema-profile.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/schema-profile.schema.json"
     },
+    {
+      "digest": "sha256-3jvAa7VGd6F7uAOR82AcTOSMGXWvgaMVmGsG1UzSXiI=",
+      "file": "studio-chart.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-chart.schema.json"
+    },
     {
       "digest": "sha256-FC0lGnAqTIdHLvlwbGyYGdXEK5mwtyhdyrCwt7WzVhY=",
       "file": "studio-config.schema.json",
       "id": "https://schemas.kumwe.org/studio/v1/studio-config.schema.json"
     },
+    {
+      "digest": "sha256-SAP1i3VfZS51FRsqnN2frFxE/UmI9xEUsSREUp/cA+E=",
+      "file": "studio-drawing.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-drawing.schema.json"
+    },
+    {
+      "digest": "sha256-6jp6QkIqqUrNSVAQJHOlK8BCb8vdAZF5QRZmyRUqfgM=",
+      "file": "studio-money.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-money.schema.json"
+    },
+    {
+      "digest": "sha256-+dyYyHfQcUz4n5BUNMmGODJ6J7n2ysm9/+rWpSrbODA=",
+      "file": "studio-presentation.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-presentation.schema.json"
+    },
+    {
+      "digest": "sha256-8U3Im000ka2Zdfeo9J/ixmPLnMaLj3JE8vo8DrA6HMI=",
+      "file": "studio-release.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-release.schema.json"
+    },
+    {
+      "digest": "sha256-txf6OXjSyFvOcoepU01qNY2WWlTyDA3iquMVXrFC2tQ=",
+      "file": "studio-table.schema.json",
+      "id": "https://schemas.kumwe.org/studio/v1/studio-table.schema.json"
+    },
     {
       "digest": "sha256-xzhCb8J2nx+K6kBMciFj1glB4Q6jT8+KUdbUBsNM4h8=",
       "file": "theme.schema.json",

package/schemas/renderer-web-vector.schema.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/renderer-web-vector.schema.json",
+  "title": "Studio renderer-web conformance vector",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "coverage", "roots", "bindings", "media", "expect"],
+  "properties": {
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "coverage": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["blockTypes", "behaviors", "presentation", "security"],
+      "properties": {
+        "blockTypes": {
+          "type": "array",
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+        },
+        "behaviors": {
+          "type": "array",
+          "maxItems": 50,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "accordion-native",
+              "countdown",
+              "dialog",
+              "lightbox",
+              "navigation-disclosure",
+              "notice-dismiss",
+              "popover",
+              "slideshow",
+              "tabs"
+            ]
+          }
+        },
+        "presentation": {
+          "type": "array",
+          "maxItems": 50,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "alignment",
+              "inverse",
+              "markers",
+              "motion",
+              "position",
+              "print",
+              "responsive-visibility",
+              "scrolling",
+              "sizing",
+              "spacing"
+            ]
+          }
+        },
+        "security": {
+          "type": "array",
+          "maxItems": 50,
+          "uniqueItems": true,
+          "items": {
+            "enum": [
+              "active-media-deny",
+              "blob-default-deny",
+              "escaped-text",
+              "safe-url-deny",
+              "typed-data-fallback"
+            ]
+          }
+        }
+      }
+    },
+    "context": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": { "allowBlobMedia": { "type": "boolean" } }
+    },
+    "roots": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 100,
+      "items": { "$ref": "blueprint.schema.json#/$defs/node" }
+    },
+    "bindings": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["nodeId", "port", "value"],
+        "properties": {
+          "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+          "port": { "$ref": "common.schema.json#/$defs/localName" },
+          "value": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        }
+      }
+    },
+    "media": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["assetId", "src", "altText"],
+        "properties": {
+          "assetId": { "$ref": "common.schema.json#/$defs/stableId" },
+          "src": { "type": "string", "minLength": 1, "maxLength": 2048 },
+          "altText": { "type": "string", "maxLength": 5000 },
+          "mediaType": { "type": "string", "maxLength": 255 },
+          "caption": { "type": "string", "maxLength": 20000 },
+          "width": { "type": "integer", "minimum": 1, "maximum": 100000 },
+          "height": { "type": "integer", "minimum": 1, "maximum": 100000 }
+        }
+      }
+    },
+    "expect": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["htmlContains", "htmlExcludes", "cssContains", "enhancements"],
+      "properties": {
+        "htmlContains": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "type": "string", "maxLength": 10000 }
+        },
+        "htmlExcludes": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "type": "string", "maxLength": 10000 }
+        },
+        "cssContains": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "type": "string", "maxLength": 10000 }
+        },
+        "enhancements": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "enum": [
+              "chart",
+              "countdown",
+              "diagram",
+              "dialog",
+              "lightbox",
+              "math",
+              "motion",
+              "navigation",
+              "notice",
+              "popover",
+              "slideshow",
+              "tabs"
+            ]
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/rich-text-projection.schema.json

@@ -24,7 +24,16 @@
       "additionalProperties": false,
       "required": ["type", "text", "spans", "embeds"],
       "properties": {
-        "type": { "enum": ["heading", "horizontalRule", "paragraph"] },
+        "type": {
+          "enum": [
+            "checklistItem",
+            "codeBlock",
+            "heading",
+            "horizontalRule",
+            "paragraph",
+            "tableCell"
+          ]
+        },
         "text": {
           "type": "string",
           "maxLength": 250000
@@ -51,9 +60,9 @@
         "marks": {
           "type": "array",
           "minItems": 1,
-          "maxItems": 4,
+          "maxItems": 5,
           "uniqueItems": true,
-          "items": { "enum": ["bold", "code", "italic", "strike"] }
+          "items": { "enum": ["bold", "code", "highlight", "italic", "strike"] }
         }
       }
     },

package/schemas/rich-text.schema.json

@@ -24,7 +24,11 @@
         { "$ref": "#/$defs/blockquote" },
         { "$ref": "#/$defs/bulletList" },
         { "$ref": "#/$defs/orderedList" },
-        { "$ref": "#/$defs/horizontalRule" }
+        { "$ref": "#/$defs/horizontalRule" },
+        { "$ref": "#/$defs/checklist" },
+        { "$ref": "#/$defs/table" },
+        { "$ref": "#/$defs/callout" },
+        { "$ref": "#/$defs/codeBlock" }
       ]
     },
     "paragraph": {
@@ -133,6 +137,131 @@
         "type": { "const": "horizontalRule" }
       }
     },
+    "checklist": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "checklist" },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 500,
+          "items": { "$ref": "#/$defs/checklistItem" }
+        }
+      }
+    },
+    "checklistItem": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "attrs"],
+      "properties": {
+        "type": { "const": "checklistItem" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["checked", "level"],
+          "properties": {
+            "checked": { "type": "boolean" },
+            "level": { "type": "integer", "minimum": 0, "maximum": 4 }
+          }
+        },
+        "content": {
+          "type": "array",
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/inline" }
+        }
+      }
+    },
+    "table": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "attrs", "content"],
+      "properties": {
+        "type": { "const": "table" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["header"],
+          "properties": { "header": { "type": "boolean" } }
+        },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 200,
+          "items": { "$ref": "#/$defs/tableRow" }
+        }
+      }
+    },
+    "tableRow": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "tableRow" },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 50,
+          "items": { "$ref": "#/$defs/tableCell" }
+        }
+      }
+    },
+    "tableCell": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "tableCell" },
+        "content": {
+          "type": "array",
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/inline" }
+        }
+      }
+    },
+    "callout": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "attrs", "content"],
+      "properties": {
+        "type": { "const": "callout" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["tone"],
+          "properties": {
+            "tone": { "enum": ["danger", "info", "success", "warning"] }
+          }
+        },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/block" }
+        }
+      }
+    },
+    "codeBlock": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "attrs", "text"],
+      "properties": {
+        "type": { "const": "codeBlock" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["language"],
+          "properties": {
+            "language": {
+              "type": "string",
+              "pattern": "^[A-Za-z0-9][A-Za-z0-9+_.#-]{0,63}$"
+            }
+          }
+        },
+        "text": { "type": "string", "maxLength": 250000 }
+      }
+    },
     "hardBreak": {
       "type": "object",
       "additionalProperties": false,
@@ -163,12 +292,32 @@
       "oneOf": [{ "$ref": "#/$defs/text" }, { "$ref": "#/$defs/hardBreak" }]
     },
     "mark": {
-      "type": "object",
-      "additionalProperties": false,
-      "required": ["type"],
-      "properties": {
-        "type": { "enum": ["bold", "code", "italic", "strike"] }
-      }
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type"],
+          "properties": {
+            "type": { "enum": ["bold", "code", "italic", "strike"] }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "attrs"],
+          "properties": {
+            "type": { "const": "highlight" },
+            "attrs": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["tone"],
+              "properties": {
+                "tone": { "enum": ["accent", "danger", "info", "success", "warning"] }
+              }
+            }
+          }
+        }
+      ]
     }
   }
 }

package/schemas/studio-chart.schema.json

@@ -0,0 +1,35 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/studio-chart.schema.json",
+  "title": "Studio canonical chart",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["type", "labels", "datasets"],
+  "properties": {
+    "type": { "enum": ["bar", "doughnut", "line", "pie"] },
+    "title": { "type": "string", "maxLength": 500 },
+    "labels": {
+      "type": "array",
+      "maxItems": 200,
+      "items": { "type": "string", "maxLength": 500 }
+    },
+    "datasets": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 20,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["label", "values"],
+        "properties": {
+          "label": { "type": "string", "maxLength": 500 },
+          "values": {
+            "type": "array",
+            "maxItems": 200,
+            "items": { "type": "number", "minimum": -1000000000000000, "maximum": 1000000000000000 }
+          }
+        }
+      }
+    }
+  }
+}