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

package/schemas/authoring-save.schema.json

@@ -0,0 +1,188 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/authoring-save.schema.json",
+  "title": "Studio contextual authoring save documents",
+  "description": "Host-authoritative planning, confirmation, and reconciliation documents for the three explicit contextual save outcomes.",
+  "oneOf": [
+    { "$ref": "#/$defs/saveIntent" },
+    { "$ref": "#/$defs/savePlan" },
+    { "$ref": "#/$defs/saveItemRequest" },
+    { "$ref": "#/$defs/saveNewTypeVersionRequest" },
+    { "$ref": "#/$defs/saveAsNewTypeRequest" },
+    { "$ref": "#/$defs/saveResult" }
+  ],
+  "$defs": {
+    "artifactKind": {
+      "enum": ["model", "blueprint", "entry", "reusable-content-type"]
+    },
+    "saveItemDraft": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["outcome", "entry"],
+      "properties": {
+        "outcome": { "const": "save-item" },
+        "entry": { "$ref": "entry.schema.json" },
+        "itemBlueprint": { "$ref": "blueprint.schema.json" }
+      }
+    },
+    "saveNewTypeVersionDraft": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["outcome", "model", "blueprint"],
+      "properties": {
+        "outcome": { "const": "save-new-type-version" },
+        "model": { "$ref": "content-model.schema.json" },
+        "blueprint": { "$ref": "blueprint.schema.json" }
+      }
+    },
+    "saveAsNewTypeDraft": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["outcome", "label", "authoringPolicy", "model", "blueprint"],
+      "properties": {
+        "outcome": { "const": "save-as-new-type" },
+        "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "authoringPolicy": {
+          "$ref": "reusable-content-type.schema.json#/$defs/authoringPolicy"
+        },
+        "model": { "$ref": "content-model.schema.json" },
+        "blueprint": { "$ref": "blueprint.schema.json" }
+      }
+    },
+    "saveDraft": {
+      "oneOf": [
+        { "$ref": "#/$defs/saveItemDraft" },
+        { "$ref": "#/$defs/saveNewTypeVersionDraft" },
+        { "$ref": "#/$defs/saveAsNewTypeDraft" }
+      ]
+    },
+    "saveIntent": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contractVersion", "kind", "sessionId", "expected", "draft"],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-intent" },
+        "sessionId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "expected": {
+          "$ref": "authoring-session.schema.json#/$defs/artifactCoordinates"
+        },
+        "draft": { "$ref": "#/$defs/saveDraft" }
+      }
+    },
+    "planReference": {
+      "description": "The exact reviewed plan identity and host-minted return context adopted only after that plan is accepted.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "revision", "successorContext"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "revision": { "$ref": "common.schema.json#/$defs/revision" },
+        "successorContext": {
+          "description": "The exact host return context that the accepted result session must carry.",
+          "$ref": "common.schema.json#/$defs/returnContext"
+        }
+      }
+    },
+    "savePlan": {
+      "description": "A host-reviewed save transaction whose successorContext binds post-acceptance return navigation without granting authority.",
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contractVersion",
+        "kind",
+        "id",
+        "revision",
+        "successorContext",
+        "sessionId",
+        "outcome",
+        "expected",
+        "affectedArtifacts",
+        "consequences",
+        "confirmationRequired"
+      ],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-plan" },
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "revision": { "$ref": "common.schema.json#/$defs/revision" },
+        "successorContext": {
+          "description": "The exact host return context copied into the request/result planReference and adopted after acceptance.",
+          "$ref": "common.schema.json#/$defs/returnContext"
+        },
+        "sessionId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "outcome": { "$ref": "authoring-target.schema.json#/$defs/saveOutcome" },
+        "expected": {
+          "$ref": "authoring-session.schema.json#/$defs/artifactCoordinates"
+        },
+        "affectedArtifacts": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/artifactKind" }
+        },
+        "consequences": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "$ref": "common.schema.json#/$defs/diagnostic" }
+        },
+        "confirmationRequired": { "type": "boolean" }
+      }
+    },
+    "acceptedConsequences": {
+      "type": "array",
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+    },
+    "saveItemRequest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contractVersion", "kind", "plan", "acceptedConsequences", "draft"],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-item-request" },
+        "plan": { "$ref": "#/$defs/planReference" },
+        "acceptedConsequences": { "$ref": "#/$defs/acceptedConsequences" },
+        "draft": { "$ref": "#/$defs/saveItemDraft" }
+      }
+    },
+    "saveNewTypeVersionRequest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contractVersion", "kind", "plan", "acceptedConsequences", "draft"],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-new-type-version-request" },
+        "plan": { "$ref": "#/$defs/planReference" },
+        "acceptedConsequences": { "$ref": "#/$defs/acceptedConsequences" },
+        "draft": { "$ref": "#/$defs/saveNewTypeVersionDraft" }
+      }
+    },
+    "saveAsNewTypeRequest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contractVersion", "kind", "plan", "acceptedConsequences", "draft"],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-as-new-type-request" },
+        "plan": { "$ref": "#/$defs/planReference" },
+        "acceptedConsequences": { "$ref": "#/$defs/acceptedConsequences" },
+        "draft": { "$ref": "#/$defs/saveAsNewTypeDraft" }
+      }
+    },
+    "saveResult": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["contractVersion", "kind", "outcome", "plan", "session"],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-save-result" },
+        "outcome": { "$ref": "authoring-target.schema.json#/$defs/saveOutcome" },
+        "plan": { "$ref": "#/$defs/planReference" },
+        "session": { "$ref": "authoring-session.schema.json#/$defs/snapshot" }
+      }
+    }
+  }
+}

package/schemas/authoring-session.schema.json

@@ -0,0 +1,151 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/authoring-session.schema.json",
+  "title": "Studio coordinated contextual authoring session",
+  "description": "One resource-bound authoring snapshot with separately identified Model, Blueprint, and Entry documents and exact host-accepted coordinates.",
+  "$ref": "#/$defs/snapshot",
+  "$defs": {
+    "startSource": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": { "kind": { "const": "blank" } }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "type"],
+          "properties": {
+            "kind": { "const": "from-type" },
+            "type": { "$ref": "reusable-content-type.schema.json#/$defs/reference" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind"],
+          "properties": { "kind": { "const": "existing" } }
+        }
+      ]
+    },
+    "startRequest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["targetId", "resourceContext", "source"],
+      "properties": {
+        "targetId": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "resourceContext": { "$ref": "common.schema.json#/$defs/resourceContext" },
+        "source": { "$ref": "#/$defs/startSource" },
+        "presentation": {
+          "$ref": "authoring-target.schema.json#/$defs/presentationState"
+        }
+      }
+    },
+    "artifactCoordinates": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["model", "blueprint", "entry"],
+      "properties": {
+        "type": { "$ref": "reusable-content-type.schema.json#/$defs/reference" },
+        "model": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "blueprint": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "entry": { "$ref": "common.schema.json#/$defs/resolvedEntryReference" }
+      }
+    },
+    "artifactState": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["coordinates", "model", "blueprint", "entry", "dirty", "diagnostics"],
+      "properties": {
+        "coordinates": { "$ref": "#/$defs/artifactCoordinates" },
+        "model": { "$ref": "content-model.schema.json" },
+        "blueprint": { "$ref": "blueprint.schema.json" },
+        "entry": { "$ref": "entry.schema.json" },
+        "dirty": {
+          "type": "array",
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "enum": ["model", "blueprint", "entry"] }
+        },
+        "diagnostics": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": { "$ref": "common.schema.json#/$defs/diagnostic" }
+        }
+      }
+    },
+    "capabilities": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["modes", "presentationStates", "saveOutcomes"],
+      "properties": {
+        "modes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "enum": ["model", "blueprint", "content"] }
+        },
+        "presentationStates": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": {
+            "$ref": "authoring-target.schema.json#/$defs/presentationState"
+          }
+        },
+        "saveOutcomes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "$ref": "authoring-target.schema.json#/$defs/saveOutcome" }
+        }
+      }
+    },
+    "presentation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["current"],
+      "properties": {
+        "current": { "$ref": "authoring-target.schema.json#/$defs/presentationState" },
+        "returnContext": { "$ref": "common.schema.json#/$defs/returnContext" }
+      }
+    },
+    "snapshot": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contractVersion",
+        "kind",
+        "sessionId",
+        "sessionGeneration",
+        "target",
+        "resourceContext",
+        "start",
+        "state",
+        "capabilities",
+        "presentation",
+        "contributionGeneration"
+      ],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-session" },
+        "sessionId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "sessionGeneration": { "$ref": "common.schema.json#/$defs/revision" },
+        "target": { "$ref": "authoring-target.schema.json#/$defs/declaration" },
+        "resourceContext": { "$ref": "common.schema.json#/$defs/resourceContext" },
+        "start": { "$ref": "#/$defs/startSource" },
+        "type": { "$ref": "reusable-content-type.schema.json#/$defs/definition" },
+        "state": { "$ref": "#/$defs/artifactState" },
+        "capabilities": { "$ref": "#/$defs/capabilities" },
+        "presentation": { "$ref": "#/$defs/presentation" },
+        "contributionGeneration": { "$ref": "common.schema.json#/$defs/revision" },
+        "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+      }
+    }
+  }
+}

package/schemas/authoring-target.schema.json

@@ -0,0 +1,160 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/authoring-target.schema.json",
+  "title": "Studio contextual authoring target declaration",
+  "description": "A bounded host-core or extension declaration that makes one class of host resources eligible for contextual Studio authoring. Discovery never grants authority.",
+  "$ref": "#/$defs/declaration",
+  "$defs": {
+    "presentationState": {
+      "enum": ["inline", "minimized", "maximized", "fullscreen"]
+    },
+    "saveOutcome": {
+      "enum": ["save-item", "save-new-type-version", "save-as-new-type"]
+    },
+    "startKind": {
+      "enum": ["blank", "from-type", "existing"]
+    },
+    "eligibility": {
+      "enum": ["create", "edit"]
+    },
+    "capabilityRequirement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "versions"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "versions": { "$ref": "common.schema.json#/$defs/versionRange" }
+      }
+    },
+    "contributionDependency": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "id", "versions", "required"],
+      "properties": {
+        "kind": {
+          "enum": [
+            "block-definition",
+            "pattern",
+            "field-adapter",
+            "inspector",
+            "design-vocabulary",
+            "migration"
+          ]
+        },
+        "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "versions": { "$ref": "common.schema.json#/$defs/versionRange" },
+        "required": { "type": "boolean" }
+      }
+    },
+    "declaration": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "contractVersion",
+        "kind",
+        "id",
+        "owner",
+        "label",
+        "surface",
+        "resourceTypes",
+        "eligibility",
+        "modes",
+        "startKinds",
+        "presentationStates",
+        "saveOutcomes",
+        "requiredCapabilities",
+        "contributionDependencies"
+      ],
+      "properties": {
+        "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+        "kind": { "const": "authoring-target" },
+        "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "owner": { "$ref": "common.schema.json#/$defs/ownerReference" },
+        "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "surface": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "resourceTypes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "uniqueItems": true,
+          "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+        },
+        "eligibility": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 2,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/eligibility" }
+        },
+        "modes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "enum": ["model", "blueprint", "content"] }
+        },
+        "startKinds": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/startKind" }
+        },
+        "presentationStates": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/presentationState" }
+        },
+        "saveOutcomes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/saveOutcome" }
+        },
+        "requiredCapabilities": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/capabilityRequirement" }
+        },
+        "contributionDependencies": {
+          "type": "array",
+          "maxItems": 500,
+          "items": { "$ref": "#/$defs/contributionDependency" }
+        },
+        "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+      }
+    },
+    "resolveRequest": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["targetId", "intent", "resourceContext"],
+      "properties": {
+        "targetId": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "intent": { "$ref": "#/$defs/eligibility" },
+        "resourceContext": { "$ref": "common.schema.json#/$defs/resourceContext" },
+        "requestedPresentation": { "$ref": "#/$defs/presentationState" }
+      }
+    },
+    "resolution": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["target", "resourceContext", "availableStarts", "initialPresentation"],
+      "properties": {
+        "target": { "$ref": "#/$defs/declaration" },
+        "resourceContext": { "$ref": "common.schema.json#/$defs/resourceContext" },
+        "availableStarts": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 3,
+          "uniqueItems": true,
+          "items": { "$ref": "#/$defs/startKind" }
+        },
+        "initialPresentation": { "$ref": "#/$defs/presentationState" },
+        "returnContext": { "$ref": "common.schema.json#/$defs/returnContext" }
+      }
+    }
+  }
+}