@kumwe/studio-protocol 0.1.0-alpha.10

package/schemas/block-definition.schema.json

@@ -0,0 +1,227 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/block-definition.schema.json",
+  "title": "Studio block definition",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "type",
+    "version",
+    "revision",
+    "owner",
+    "label",
+    "category",
+    "propertySchema",
+    "slots",
+    "ports",
+    "editingModes",
+    "themeControls",
+    "rendererRequirements",
+    "accessibility"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "block-definition" },
+    "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+    "revision": { "$ref": "common.schema.json#/$defs/revision" },
+    "owner": { "$ref": "common.schema.json#/$defs/ownerReference" },
+    "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "category": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "icon": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "value"],
+          "properties": {
+            "kind": { "const": "symbol" },
+            "value": {
+              "oneOf": [
+                { "$ref": "common.schema.json#/$defs/localName" },
+                { "$ref": "common.schema.json#/$defs/qualifiedName" }
+              ]
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "path", "integrity"],
+          "properties": {
+            "kind": { "const": "asset" },
+            "path": { "$ref": "common.schema.json#/$defs/packageRelativePath" },
+            "integrity": { "$ref": "common.schema.json#/$defs/integrity" }
+          }
+        }
+      ]
+    },
+    "propertySchema": {
+      "type": "object",
+      "minProperties": 1,
+      "maxProperties": 500,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" }
+    },
+    "propertyControls": {
+      "type": "array",
+      "maxItems": 500,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["property", "control"],
+        "properties": {
+          "property": { "$ref": "common.schema.json#/$defs/localName" },
+          "control": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "help": { "$ref": "common.schema.json#/$defs/messageReference" }
+        }
+      }
+    },
+    "slots": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "label", "minimum", "maximum", "ordered", "accepts"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/localName" },
+          "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "minimum": { "type": "integer", "minimum": 0, "maximum": 10000 },
+          "maximum": { "type": "integer", "minimum": 0, "maximum": 10000 },
+          "ordered": { "type": "boolean" },
+          "accepts": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["types"],
+            "properties": {
+              "types": {
+                "type": "array",
+                "minItems": 1,
+                "maxItems": 1000,
+                "uniqueItems": true,
+                "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "ports": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "label", "valueType", "required", "multiple"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/localName" },
+          "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "valueType": {
+            "oneOf": [
+              {
+                "enum": [
+                  "text",
+                  "rich-text",
+                  "boolean",
+                  "integer",
+                  "decimal",
+                  "money",
+                  "date",
+                  "date-time",
+                  "media",
+                  "resource"
+                ]
+              },
+              { "$ref": "common.schema.json#/$defs/qualifiedName" }
+            ]
+          },
+          "required": { "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" }
+            }
+          }
+        }
+      }
+    },
+    "editingModes": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 2,
+      "uniqueItems": true,
+      "items": { "enum": ["blueprint", "content"] }
+    },
+    "themeControls": {
+      "type": "array",
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/localName" }
+    },
+    "rendererRequirements": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["surface", "capability", "versions"],
+        "properties": {
+          "surface": { "enum": ["web", "email", "document", "native", "preview"] },
+          "capability": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "versions": { "$ref": "common.schema.json#/$defs/versionRange" }
+        }
+      }
+    },
+    "accessibility": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["category", "accessibleName", "keyboard", "reducedMotion", "outputChecks"],
+      "properties": {
+        "category": {
+          "enum": [
+            "structural",
+            "landmark",
+            "interactive",
+            "media",
+            "text",
+            "decorative",
+            "data-display",
+            "composite"
+          ]
+        },
+        "accessibleName": {
+          "enum": ["not-applicable", "required-property", "required-binding", "derived"]
+        },
+        "keyboard": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "reducedMotion": { "enum": ["not-applicable", "required", "disable-motion"] },
+        "outputChecks": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+        }
+      }
+    },
+    "fallback": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "versions", "lossless"],
+      "properties": {
+        "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "versions": { "$ref": "common.schema.json#/$defs/versionRange" },
+        "lossless": { "type": "boolean", "const": true }
+      }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/blueprint.schema.json

@@ -0,0 +1,273 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/blueprint.schema.json",
+  "title": "Studio Blueprint",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "revision",
+    "owner",
+    "status",
+    "label",
+    "model",
+    "dependencyLock",
+    "roots"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "blueprint" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+    "revision": { "$ref": "common.schema.json#/$defs/revision" },
+    "owner": { "$ref": "common.schema.json#/$defs/ownerReference" },
+    "status": { "enum": ["draft", "published", "retired"] },
+    "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "model": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+    "dependencyLock": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["theme", "blocks"],
+      "properties": {
+        "theme": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "blocks": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type", "version", "revision"],
+            "properties": {
+              "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+              "revision": { "$ref": "common.schema.json#/$defs/revision" },
+              "integrity": { "$ref": "common.schema.json#/$defs/integrity" }
+            }
+          }
+        },
+        "plugins": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" }
+        }
+      }
+    },
+    "roots": {
+      "type": "array",
+      "minItems": 0,
+      "maxItems": 10000,
+      "items": { "$ref": "#/$defs/node" }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": { "status": { "const": "published" } },
+        "required": ["status"]
+      },
+      "then": {
+        "properties": {
+          "roots": { "type": "array", "minItems": 1 }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "sizeRoleAxis": { "enum": ["inline", "block"] },
+    "node": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "type", "version", "properties", "bindings", "slots", "authoring"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+        "properties": {
+          "type": "object",
+          "maxProperties": 500,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        },
+        "bindings": {
+          "type": "object",
+          "maxProperties": 100,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+          "additionalProperties": { "$ref": "#/$defs/binding" }
+        },
+        "slots": {
+          "type": "object",
+          "maxProperties": 100,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+          "additionalProperties": {
+            "type": "array",
+            "maxItems": 10000,
+            "items": { "$ref": "#/$defs/node" }
+          }
+        },
+        "responsive": {
+          "type": "object",
+          "maxProperties": 100,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+          "additionalProperties": {
+            "type": "object",
+            "maxProperties": 20,
+            "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+            "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+          }
+        },
+        "sizeRoles": {
+          "type": "object",
+          "maxProperties": 2,
+          "propertyNames": { "$ref": "#/$defs/sizeRoleAxis" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/localName" }
+        },
+        "responsiveSizeRoles": {
+          "type": "object",
+          "maxProperties": 2,
+          "propertyNames": { "$ref": "#/$defs/sizeRoleAxis" },
+          "additionalProperties": {
+            "type": "object",
+            "maxProperties": 20,
+            "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+            "additionalProperties": { "$ref": "common.schema.json#/$defs/localName" }
+          }
+        },
+        "authoring": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["mode"],
+          "properties": {
+            "mode": { "enum": ["locked", "content", "variant", "structural", "designer"] },
+            "allowedBlocks": {
+              "type": "array",
+              "maxItems": 1000,
+              "uniqueItems": true,
+              "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+            },
+            "requiredPermission": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            "slots": {
+              "type": "object",
+              "maxProperties": 100,
+              "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+              "additionalProperties": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": ["composable"],
+                "properties": {
+                  "composable": { "const": true },
+                  "allowedBlocks": {
+                    "type": "array",
+                    "maxItems": 1000,
+                    "uniqueItems": true,
+                    "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+      }
+    },
+    "binding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["source", "transforms", "onNull", "onError"],
+      "properties": {
+        "source": { "$ref": "#/$defs/bindingSource" },
+        "transforms": {
+          "type": "array",
+          "maxItems": 20,
+          "items": { "$ref": "#/$defs/transform" }
+        },
+        "onNull": { "enum": ["empty", "hide", "fallback", "error"] },
+        "onError": { "enum": ["hide", "fallback", "error"] },
+        "fallback": { "$ref": "common.schema.json#/$defs/jsonValue" }
+      }
+    },
+    "bindingSource": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "fieldPath"],
+          "properties": {
+            "kind": { "const": "entry-field" },
+            "fieldPath": {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 32,
+              "items": { "$ref": "common.schema.json#/$defs/localName" }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "key"],
+          "properties": {
+            "kind": { "const": "context-value" },
+            "key": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "value"],
+          "properties": {
+            "kind": { "const": "static-value" },
+            "value": { "$ref": "common.schema.json#/$defs/jsonValue" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "resourceType", "id"],
+          "properties": {
+            "kind": { "const": "resource-reference" },
+            "resourceType": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            "id": { "$ref": "common.schema.json#/$defs/stableId" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "query", "version", "parameters"],
+          "properties": {
+            "kind": { "const": "query-reference" },
+            "query": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+            "parameters": {
+              "type": "object",
+              "maxProperties": 50,
+              "propertyNames": {
+                "$ref": "common.schema.json#/$defs/safeJsonMemberName"
+              },
+              "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+            }
+          }
+        }
+      ]
+    },
+    "transform": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["operator", "version", "arguments"],
+      "properties": {
+        "operator": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+        "arguments": {
+          "type": "object",
+          "maxProperties": 20,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        }
+      }
+    }
+  }
+}

package/schemas/canonical-vector.schema.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/canonical-vector.schema.json",
+  "title": "Studio canonical serialization vector",
+  "description": "One canonical serialization case: a bounded JSON value and either the exact canonical string it serializes to with the digest of its UTF-8 bytes, or the stable reason the canonical form refuses it. Checksums across the contract are computed over exactly these bytes, so an implementation that reproduces this corpus computes the same digests as every other - which is what makes a vendored-corpus check and a stored-document round-trip comparable across languages.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "id", "description", "value", "expect"],
+  "properties": {
+    "contractVersion": {
+      "$ref": "common.schema.json#/$defs/contractVersion"
+    },
+    "kind": {
+      "const": "canonical-vector"
+    },
+    "id": {
+      "$ref": "common.schema.json#/$defs/stableId"
+    },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500
+    },
+    "value": {
+      "description": "The input value. Deliberately looser than the canonical JSON value shape so a rejection vector can carry a value the canonical form refuses, such as a forbidden member name. Values the canonical form cannot represent at all - non-finite numbers, undefined - are not expressible in JSON and are proven in implementation tests rather than here."
+    },
+    "expect": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["canonical", "digest"],
+          "properties": {
+            "canonical": {
+              "description": "The exact canonical string, byte for byte.",
+              "type": "string",
+              "maxLength": 20000
+            },
+            "digest": {
+              "description": "The SRI-style sha256 digest of the canonical UTF-8 bytes.",
+              "$ref": "common.schema.json#/$defs/integrity"
+            }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["rejected"],
+          "properties": {
+            "rejected": {
+              "description": "The stable reason the canonical form refuses the value.",
+              "enum": ["depth-exceeded", "forbidden-member"]
+            }
+          }
+        }
+      ]
+    },
+    "maximumDepth": {
+      "description": "The depth bound to serialize under. Absent means the contract default of 64.",
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 64
+    }
+  }
+}

package/schemas/command-vector.schema.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/command-vector.schema.json",
+  "title": "Studio canonical command vector",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "id", "description", "initial", "command", "expect"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "command-vector" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500
+    },
+    "mode": {
+      "enum": ["blueprint", "content", "hybrid", "model", "read-only"]
+    },
+    "initial": { "$ref": "blueprint.schema.json" },
+    "command": { "$ref": "command.schema.json" },
+    "expect": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["document"],
+          "properties": {
+            "document": { "$ref": "blueprint.schema.json" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["errorCode"],
+          "properties": {
+            "errorCode": { "$ref": "#/$defs/commandErrorCode" }
+          }
+        }
+      ]
+    },
+    "inverse": { "$ref": "command.schema.json" }
+  },
+  "$defs": {
+    "commandErrorCode": {
+      "enum": [
+        "artifact-not-draft",
+        "binding-not-found",
+        "duplicate-field",
+        "duplicate-node",
+        "illegal-move",
+        "invalid-batch",
+        "invalid-id-map",
+        "invalid-index",
+        "invalid-order",
+        "locale-mismatch",
+        "mode-forbidden",
+        "node-not-found",
+        "parent-not-found",
+        "property-not-found",
+        "read-only-session",
+        "stale-generation",
+        "stale-state",
+        "unsupported-command"
+      ]
+    }
+  }
+}