@kumwe/studio-protocol 0.1.0-alpha.10

package/schemas/content-model.schema.json

@@ -0,0 +1,216 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/content-model.schema.json",
+  "title": "Studio content model",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "revision",
+    "owner",
+    "status",
+    "label",
+    "fields",
+    "relationships"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "content-model" },
+    "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" },
+    "fields": {
+      "type": "array",
+      "minItems": 0,
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/field" }
+    },
+    "relationships": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "#/$defs/relationship" }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": { "status": { "const": "published" } },
+        "required": ["status"]
+      },
+      "then": {
+        "properties": {
+          "fields": { "type": "array", "minItems": 1 }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "field": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "label", "required", "localized", "cardinality"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/localName" },
+        "kind": {
+          "oneOf": [
+            {
+              "enum": [
+                "string",
+                "rich-text",
+                "boolean",
+                "integer",
+                "decimal",
+                "money",
+                "date",
+                "date-time",
+                "enum",
+                "media",
+                "resource",
+                "object",
+                "collection"
+              ]
+            },
+            { "$ref": "common.schema.json#/$defs/qualifiedName" }
+          ]
+        },
+        "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "required": { "type": "boolean" },
+        "localized": { "type": "boolean" },
+        "cardinality": { "enum": ["one", "many"] },
+        "semanticRole": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "defaultValue": { "$ref": "common.schema.json#/$defs/jsonValue" },
+        "authoring": { "$ref": "#/$defs/authoringMetadata" },
+        "constraints": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "minimum": {
+              "type": "string",
+              "pattern": "^-?(0|[1-9][0-9]*)(?:\\.[0-9]+)?(?![\\s\\S])",
+              "maxLength": 200
+            },
+            "maximum": {
+              "type": "string",
+              "pattern": "^-?(0|[1-9][0-9]*)(?:\\.[0-9]+)?(?![\\s\\S])",
+              "maxLength": 200
+            },
+            "scale": { "type": "integer", "minimum": 0, "maximum": 100 },
+            "minLength": { "type": "integer", "minimum": 0, "maximum": 10000000 },
+            "maxLength": { "type": "integer", "minimum": 0, "maximum": 10000000 },
+            "validator": {
+              "$ref": "common.schema.json#/$defs/qualifiedName"
+            },
+            "validatorArguments": {
+              "type": "object",
+              "maxProperties": 20,
+              "propertyNames": {
+                "$ref": "common.schema.json#/$defs/safeJsonMemberName"
+              },
+              "additionalProperties": {
+                "$ref": "common.schema.json#/$defs/jsonValue"
+              }
+            },
+            "minItems": { "type": "integer", "minimum": 0, "maximum": 100000 },
+            "maxItems": { "type": "integer", "minimum": 0, "maximum": 100000 },
+            "allowedMediaKinds": {
+              "type": "array",
+              "maxItems": 50,
+              "uniqueItems": true,
+              "items": { "enum": ["image", "video", "audio", "document", "archive", "other"] }
+            }
+          }
+        },
+        "enumValues": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 1000,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["value", "label"],
+            "properties": {
+              "value": { "$ref": "common.schema.json#/$defs/localName" },
+              "label": { "$ref": "common.schema.json#/$defs/messageReference" }
+            }
+          }
+        },
+        "fields": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": { "$ref": "#/$defs/field" }
+        },
+        "itemKind": {
+          "oneOf": [
+            {
+              "enum": [
+                "string",
+                "rich-text",
+                "boolean",
+                "integer",
+                "decimal",
+                "money",
+                "date",
+                "date-time",
+                "enum",
+                "media",
+                "resource",
+                "object"
+              ]
+            },
+            { "$ref": "common.schema.json#/$defs/qualifiedName" }
+          ]
+        },
+        "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+      }
+    },
+    "authoringMetadata": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "control": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "placeholder": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "group": { "$ref": "common.schema.json#/$defs/localName" },
+        "order": { "type": "integer", "minimum": 0, "maximum": 100000 },
+        "readOnly": { "type": "boolean" },
+        "hidden": { "type": "boolean" },
+        "width": { "enum": ["full", "half", "third", "two-thirds"] }
+      }
+    },
+    "relationship": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "kind", "label", "sourceField", "targetModel", "required", "onDelete"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/localName" },
+        "kind": { "enum": ["one-to-one", "many-to-one", "one-to-many", "many-to-many"] },
+        "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "sourceField": { "$ref": "common.schema.json#/$defs/localName" },
+        "targetModel": { "$ref": "common.schema.json#/$defs/artifactReference" },
+        "targetField": { "$ref": "common.schema.json#/$defs/localName" },
+        "required": { "type": "boolean" },
+        "onDelete": { "enum": ["restrict", "nullify", "detach"] },
+        "authoring": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["control", "allowCreate"],
+          "properties": {
+            "control": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            "allowCreate": { "type": "boolean" },
+            "displayField": { "$ref": "common.schema.json#/$defs/localName" },
+            "searchProvider": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+          }
+        },
+        "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+      }
+    }
+  }
+}

package/schemas/corpus-manifest.schema.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/corpus-manifest.schema.json",
+  "title": "Studio corpus integrity manifest",
+  "description": "The digest of every file in the published conformance corpus, grouped by the directory it ships in. A host that vendors the corpus verifies its copy against this manifest, so a stale or altered fixture is detected before it silently changes what a conformance claim means. The schema manifest covers the schemas; this covers everything replayed against them.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "groups"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "corpus-manifest" },
+    "groups": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 50,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["files", "group", "path"],
+        "properties": {
+          "files": {
+            "type": "array",
+            "maxItems": 5000,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["digest", "file"],
+              "properties": {
+                "digest": { "$ref": "common.schema.json#/$defs/integrity" },
+                "file": { "type": "string", "minLength": 1, "maxLength": 200 }
+              }
+            }
+          },
+          "group": {
+            "description": "The stable name of the corpus group.",
+            "$ref": "common.schema.json#/$defs/localName"
+          },
+          "path": {
+            "description": "The package-relative directory the group ships in.",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 200
+          }
+        }
+      }
+    }
+  }
+}

package/schemas/design-vocabulary.schema.json

@@ -0,0 +1,91 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/design-vocabulary.schema.json",
+  "title": "Studio design vocabulary contribution",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "owner",
+    "label",
+    "designControls",
+    "recipes"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "design-vocabulary" },
+    "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+    "owner": { "$ref": "common.schema.json#/$defs/ownerReference" },
+    "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "designControls": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "kind", "label", "choices"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/localName" },
+          "kind": {
+            "enum": [
+              "color-role",
+              "typography-role",
+              "spacing-role",
+              "size-role",
+              "radius-role",
+              "shadow-role",
+              "motion-role",
+              "layer-role",
+              "enum",
+              "boolean",
+              "integer"
+            ]
+          },
+          "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "choices": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 500,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": ["id", "label"],
+              "properties": {
+                "id": { "$ref": "common.schema.json#/$defs/localName" },
+                "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+                "deprecated": { "type": "boolean" }
+              }
+            }
+          }
+        }
+      }
+    },
+    "recipes": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "blockType", "label", "designValues"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/localName" },
+          "blockType": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+          "designValues": {
+            "type": "object",
+            "maxProperties": 100,
+            "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+            "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+          }
+        }
+      }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/entry.schema.json

@@ -0,0 +1,32 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/entry.schema.json",
+  "title": "Studio content entry",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "id", "revision", "model", "status", "values"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "entry" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "revision": { "$ref": "common.schema.json#/$defs/revision" },
+    "model": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+    "status": { "enum": ["draft", "in-review", "published", "archived"] },
+    "locale": { "$ref": "common.schema.json#/$defs/locale" },
+    "translationOf": { "$ref": "common.schema.json#/$defs/stableId" },
+    "workflowState": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "values": {
+      "type": "object",
+      "maxProperties": 10000,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/localName" },
+      "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+    },
+    "compositionOverrides": {
+      "type": "object",
+      "maxProperties": 1000,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/stableId" },
+      "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/field-adapter.schema.json

@@ -0,0 +1,51 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/field-adapter.schema.json",
+  "title": "Studio field adapter contribution",
+  "description": "The declarative payload behind a `field-adapter` plugin contribution: a control an extension offers for editing a declared field kind. The declaration is inert data - it names the control, the field kinds it accepts, the capability its executable half requires, and the bounded option schema an author configures it through. It never carries markup, styles or code.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "owner",
+    "label",
+    "control",
+    "fieldKinds"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "field-adapter" },
+    "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+    "owner": { "$ref": "common.schema.json#/$defs/ownerReference" },
+    "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "control": {
+      "description": "The control identifier a field's authoring metadata names to select this adapter.",
+      "$ref": "common.schema.json#/$defs/qualifiedName"
+    },
+    "fieldKinds": {
+      "description": "The field kinds this control accepts. A field of any other kind never resolves to it.",
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 50,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+    },
+    "optionSchema": {
+      "description": "The bounded schema an author's control options validate against, inside the Studio Schema Profile exactly like a contributed block's property schema.",
+      "type": "object",
+      "maxProperties": 100,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+      "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+    },
+    "requiredCapability": {
+      "description": "The capability the executable half requires. A declaration without one is inspectable but never executed.",
+      "$ref": "common.schema.json#/$defs/qualifiedName"
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/host-capabilities.schema.json

@@ -0,0 +1,65 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/host-capabilities.schema.json",
+  "title": "Studio host capabilities",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "host", "protocolVersions", "ports", "capabilities"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "host-capabilities" },
+    "host": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version", "generation"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+        "generation": { "$ref": "common.schema.json#/$defs/revision" }
+      }
+    },
+    "protocolVersions": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 20,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/semanticVersion" }
+    },
+    "ports": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "version", "operations"],
+        "properties": {
+          "id": { "$ref": "host-operations.schema.json#/$defs/portCapability" },
+          "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+          "operations": {
+            "description": "The operations this host actually implements, closed by the operation registry so a capability document cannot advertise an operation that is not on the wire.",
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 100,
+            "uniqueItems": true,
+            "items": { "$ref": "host-operations.schema.json#/$defs/operationCapability" }
+          }
+        }
+      }
+    },
+    "capabilities": {
+      "type": "array",
+      "maxItems": 500,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "version"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+          "configuration": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        }
+      }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/host-error.schema.json

@@ -0,0 +1,42 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/host-error.schema.json",
+  "title": "Studio host port error",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "category", "message", "retryable"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "host-error" },
+    "category": {
+      "enum": [
+        "invalid-request",
+        "unauthenticated",
+        "forbidden",
+        "not-found",
+        "conflict",
+        "validation-failed",
+        "incompatible",
+        "limit-exceeded",
+        "rate-limited",
+        "unavailable",
+        "cancelled",
+        "internal"
+      ]
+    },
+    "correlationId": { "$ref": "common.schema.json#/$defs/stableId" },
+    "message": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "retryable": { "type": "boolean" },
+    "retryAfterMilliseconds": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 86400000
+    },
+    "revision": { "$ref": "common.schema.json#/$defs/revision" },
+    "diagnostics": {
+      "type": "array",
+      "maxItems": 1000,
+      "items": { "$ref": "common.schema.json#/$defs/diagnostic" }
+    }
+  }
+}