@kumwe/studio-protocol 0.1.0-alpha.6 → 0.1.0-beta.2

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

@@ -0,0 +1,236 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/authoring-web-vector.schema.json",
+  "title": "Studio portable web-authoring conformance vector",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "description",
+    "requirements",
+    "given",
+    "lanes",
+    "expect"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "authoring-web-vector" },
+    "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "description": { "type": "string", "minLength": 1, "maxLength": 1000 },
+    "requirements": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "type": "string", "pattern": "^SR-[0-9]{3}$" }
+    },
+    "given": { "$ref": "#/$defs/given" },
+    "lanes": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 20,
+      "items": { "$ref": "#/$defs/lane" }
+    },
+    "expect": { "$ref": "#/$defs/observation" }
+  },
+  "$defs": {
+    "region": {
+      "enum": [
+        "canvas",
+        "command-palette",
+        "inspector",
+        "outline",
+        "palette",
+        "preview",
+        "viewport"
+      ]
+    },
+    "given": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "document",
+        "direction",
+        "locale",
+        "readOnly",
+        "reducedMotion",
+        "selection",
+        "viewport"
+      ],
+      "properties": {
+        "document": { "$ref": "blueprint.schema.json" },
+        "direction": { "enum": ["ltr", "rtl"] },
+        "locale": { "$ref": "common.schema.json#/$defs/locale" },
+        "readOnly": { "type": "boolean" },
+        "reducedMotion": { "type": "boolean" },
+        "selection": {
+          "oneOf": [{ "$ref": "common.schema.json#/$defs/stableId" }, { "type": "null" }]
+        },
+        "viewport": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["height", "width", "zoomPercent"],
+          "properties": {
+            "height": { "type": "integer", "minimum": 256, "maximum": 10000 },
+            "width": { "type": "integer", "minimum": 320, "maximum": 10000 },
+            "zoomPercent": { "type": "integer", "minimum": 100, "maximum": 400 }
+          }
+        }
+      }
+    },
+    "lane": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["name", "surface", "steps"],
+      "properties": {
+        "name": { "$ref": "common.schema.json#/$defs/localName" },
+        "surface": { "enum": ["keyboard", "pointer", "structural-control"] },
+        "steps": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/action" }
+        }
+      }
+    },
+    "action": {
+      "oneOf": [
+        { "$ref": "#/$defs/focusNode" },
+        { "$ref": "#/$defs/keyAction" },
+        { "$ref": "#/$defs/dragNode" },
+        { "$ref": "#/$defs/activateCommand" },
+        { "$ref": "#/$defs/editProperty" }
+      ]
+    },
+    "focusNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "nodeId", "region"],
+      "properties": {
+        "kind": { "const": "focus-node" },
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "region": { "$ref": "#/$defs/region" }
+      }
+    },
+    "keyAction": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "key", "modifiers", "region"],
+      "properties": {
+        "kind": { "const": "key" },
+        "key": {
+          "enum": [
+            "ArrowDown",
+            "ArrowLeft",
+            "ArrowRight",
+            "ArrowUp",
+            "Delete",
+            "End",
+            "Enter",
+            "Escape",
+            "Home",
+            "Tab",
+            "d",
+            "y",
+            "z"
+          ]
+        },
+        "modifiers": {
+          "type": "array",
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": { "enum": ["Alt", "Control", "Meta", "Shift"] }
+        },
+        "region": { "$ref": "#/$defs/region" }
+      }
+    },
+    "dragNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "nodeId", "destination"],
+      "properties": {
+        "kind": { "const": "drag-node" },
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "destination": { "$ref": "command.schema.json#/$defs/destination" }
+      }
+    },
+    "activateCommand": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "region", "type", "payload"],
+      "properties": {
+        "kind": { "const": "activate-command" },
+        "region": { "$ref": "#/$defs/region" },
+        "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "payload": { "$ref": "#/$defs/jsonObject" }
+      }
+    },
+    "editProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "nodeId", "property", "value"],
+      "properties": {
+        "kind": { "const": "edit-property" },
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "property": { "$ref": "common.schema.json#/$defs/localName" },
+        "viewport": { "$ref": "common.schema.json#/$defs/localName" },
+        "value": { "$ref": "common.schema.json#/$defs/jsonValue" }
+      }
+    },
+    "jsonObject": {
+      "type": "object",
+      "maxProperties": 1000,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+      "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+    },
+    "observation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["announcements", "commands", "dirty", "document", "focus", "selection"],
+      "properties": {
+        "announcements": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["key", "politeness"],
+            "properties": {
+              "key": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "politeness": { "enum": ["assertive", "polite"] }
+            }
+          }
+        },
+        "commands": {
+          "type": "array",
+          "maxItems": 100,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type", "payload"],
+            "properties": {
+              "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "payload": { "$ref": "#/$defs/jsonObject" }
+            }
+          }
+        },
+        "dirty": { "type": "boolean" },
+        "document": { "$ref": "blueprint.schema.json" },
+        "focus": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["region"],
+          "properties": {
+            "region": { "$ref": "#/$defs/region" },
+            "nodeId": { "$ref": "common.schema.json#/$defs/stableId" }
+          }
+        },
+        "selection": {
+          "oneOf": [{ "$ref": "common.schema.json#/$defs/stableId" }, { "type": "null" }]
+        }
+      }
+    }
+  }
+}

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/common.schema.json

@@ -145,6 +145,51 @@
         "integrity": { "$ref": "#/$defs/integrity" }
       }
     },
+    "resourceIdentity": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "id"],
+      "properties": {
+        "type": { "$ref": "#/$defs/qualifiedName" },
+        "id": { "$ref": "#/$defs/stableId" }
+      }
+    },
+    "resourceScope": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "id"],
+      "properties": {
+        "kind": { "$ref": "#/$defs/qualifiedName" },
+        "id": { "$ref": "#/$defs/stableId" }
+      }
+    },
+    "resourceContext": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "surface", "scopes"],
+      "properties": {
+        "key": { "$ref": "#/$defs/stableId" },
+        "surface": { "$ref": "#/$defs/qualifiedName" },
+        "revision": { "$ref": "#/$defs/revision" },
+        "scopes": {
+          "type": "array",
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/resourceScope" }
+        },
+        "resource": { "$ref": "#/$defs/resourceIdentity" }
+      }
+    },
+    "returnContext": {
+      "description": "A non-secret host-minted pointer for deterministic return navigation. It is not a URL, credential, or permission.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key"],
+      "properties": {
+        "key": { "$ref": "#/$defs/stableId" },
+        "label": { "$ref": "#/$defs/messageReference" }
+      }
+    },
     "jsonValue": {
       "oneOf": [
         { "type": "null" },

package/schemas/host-error.schema.json

@@ -38,5 +38,26 @@
       "maxItems": 1000,
       "items": { "$ref": "common.schema.json#/$defs/diagnostic" }
     }
-  }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": { "revision": {} },
+        "required": ["revision"]
+      },
+      "then": { "properties": { "category": { "const": "conflict" } } }
+    },
+    {
+      "if": {
+        "properties": { "retryAfterMilliseconds": {} },
+        "required": ["retryAfterMilliseconds"]
+      },
+      "then": {
+        "properties": {
+          "category": { "enum": ["rate-limited", "unavailable"] },
+          "retryable": { "const": true }
+        }
+      }
+    }
+  ]
 }

package/schemas/host-operations.schema.json

@@ -81,6 +81,13 @@
         "studio.operation/artifact.publish",
         "studio.operation/artifact.save",
         "studio.operation/artifact.unpublish",
+        "studio.operation/authoring.list-types",
+        "studio.operation/authoring.plan-save",
+        "studio.operation/authoring.resolve-target",
+        "studio.operation/authoring.save-as-new-type",
+        "studio.operation/authoring.save-item",
+        "studio.operation/authoring.save-new-type-version",
+        "studio.operation/authoring.start",
         "studio.operation/localization.messages",
         "studio.operation/media.abort-upload",
         "studio.operation/media.authorize-upload",
@@ -110,6 +117,13 @@
         "artifact/publish",
         "artifact/save",
         "artifact/unpublish",
+        "authoring/list-types",
+        "authoring/plan-save",
+        "authoring/resolve-target",
+        "authoring/save-as-new-type",
+        "authoring/save-item",
+        "authoring/save-new-type-version",
+        "authoring/start",
         "localization/messages",
         "media/abort-upload",
         "media/authorize-upload",
@@ -135,6 +149,7 @@
       "description": "The capability identifier a host advertises for a whole port.",
       "enum": [
         "studio.port/artifact",
+        "studio.port/authoring",
         "studio.port/localization",
         "studio.port/media",
         "studio.port/model",
@@ -148,6 +163,7 @@
     "portName": {
       "enum": [
         "artifact",
+        "authoring",
         "localization",
         "media",
         "model",

package/schemas/host-vector.schema.json

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