@kumwe/studio-protocol 0.1.0-alpha.2

package/schemas/media-upload-session.schema.json

@@ -0,0 +1,109 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/media-upload-session.schema.json",
+  "title": "Studio media upload session",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "id", "request", "state", "progress"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "media-upload-session" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "request": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["filename", "mediaType", "byteSize", "purpose"],
+      "properties": {
+        "filename": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "pattern": "^[^\\u0000-\\u001F\\u007F/\\\\]+(?![\\s\\S])"
+        },
+        "mediaType": {
+          "type": "string",
+          "pattern": "^[a-z0-9][a-z0-9!#$&^_.+-]*/[a-z0-9][a-z0-9!#$&^_.+-]*(?![\\s\\S])",
+          "maxLength": 120
+        },
+        "byteSize": { "type": "integer", "minimum": 1, "maximum": 1099511627776 },
+        "purpose": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "checksum": { "$ref": "common.schema.json#/$defs/integrity" }
+      }
+    },
+    "plan": { "$ref": "#/$defs/plan" },
+    "state": {
+      "enum": [
+        "requested",
+        "authorized",
+        "transferring",
+        "verifying",
+        "complete",
+        "failed",
+        "cancelled"
+      ]
+    },
+    "progress": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["transferredBytes", "totalBytes"],
+      "properties": {
+        "transferredBytes": { "type": "integer", "minimum": 0, "maximum": 1099511627776 },
+        "totalBytes": { "type": "integer", "minimum": 0, "maximum": 1099511627776 }
+      }
+    },
+    "asset": { "$ref": "#/$defs/acceptedAsset" },
+    "failure": { "$ref": "common.schema.json#/$defs/diagnostic" }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "state": { "const": "complete" } }, "required": ["state"] },
+      "then": {
+        "properties": { "asset": { "$ref": "#/$defs/acceptedAsset" } },
+        "required": ["asset"]
+      }
+    },
+    {
+      "if": { "properties": { "state": { "const": "failed" } }, "required": ["state"] },
+      "then": {
+        "properties": { "failure": { "$ref": "common.schema.json#/$defs/diagnostic" } },
+        "required": ["failure"]
+      }
+    },
+    {
+      "if": {
+        "properties": { "state": { "enum": ["authorized", "transferring", "verifying"] } },
+        "required": ["state"]
+      },
+      "then": {
+        "properties": { "plan": { "$ref": "#/$defs/plan" } },
+        "required": ["plan"]
+      }
+    },
+    {
+      "if": { "properties": { "state": { "const": "requested" } }, "required": ["state"] },
+      "then": { "not": { "required": ["asset"] } }
+    }
+  ],
+  "$defs": {
+    "acceptedAsset": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "revision", "state"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "revision": { "$ref": "common.schema.json#/$defs/revision" },
+        "state": { "enum": ["processing", "ready", "rejected", "quarantined"] }
+      }
+    },
+    "plan": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["maximumBytes", "resumable"],
+      "properties": {
+        "maximumBytes": { "type": "integer", "minimum": 1, "maximum": 1099511627776 },
+        "chunkBytes": { "type": "integer", "minimum": 1024, "maximum": 1073741824 },
+        "resumable": { "type": "boolean" }
+      }
+    }
+  }
+}

package/schemas/pattern.schema.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/pattern.schema.json",
+  "title": "Studio composition pattern",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "revision",
+    "owner",
+    "label",
+    "blockDependencies",
+    "roots"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "pattern" },
+    "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" },
+    "label": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "description": { "$ref": "common.schema.json#/$defs/messageReference" },
+    "blockDependencies": {
+      "type": "array",
+      "maxItems": 200,
+      "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" }
+        }
+      }
+    },
+    "roots": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 100,
+      "items": { "$ref": "blueprint.schema.json#/$defs/node" }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

package/schemas/plugin-manifest.schema.json

@@ -0,0 +1,124 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/plugin-manifest.schema.json",
+  "title": "Studio plugin manifest",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "version",
+    "owner",
+    "label",
+    "activation",
+    "entryModules",
+    "contributions",
+    "requiredCapabilities",
+    "optionalCapabilities",
+    "dependencies",
+    "permissions"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "plugin-manifest" },
+    "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" },
+    "activation": { "enum": ["declarative", "executable"] },
+    "entryModules": {
+      "type": "array",
+      "maxItems": 10,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["realm", "path", "integrity"],
+        "properties": {
+          "realm": { "enum": ["application", "worker", "sandboxed-frame"] },
+          "path": { "$ref": "common.schema.json#/$defs/packageRelativePath" },
+          "integrity": { "$ref": "common.schema.json#/$defs/integrity" }
+        }
+      }
+    },
+    "contributions": {
+      "type": "array",
+      "maxItems": 5000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["kind", "id", "version", "resource", "integrity"],
+        "properties": {
+          "kind": {
+            "enum": [
+              "block",
+              "pattern",
+              "panel",
+              "inspector",
+              "command",
+              "field-adapter",
+              "transform",
+              "locale",
+              "renderer-capability",
+              "test-fixture"
+            ]
+          },
+          "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+          "resource": { "$ref": "common.schema.json#/$defs/packageRelativePath" },
+          "integrity": { "$ref": "common.schema.json#/$defs/integrity" },
+          "executable": { "type": "boolean", "default": false }
+        }
+      }
+    },
+    "requiredCapabilities": {
+      "type": "array",
+      "maxItems": 100,
+      "items": { "$ref": "#/$defs/capabilityRequirement" }
+    },
+    "optionalCapabilities": {
+      "type": "array",
+      "maxItems": 100,
+      "items": { "$ref": "#/$defs/capabilityRequirement" }
+    },
+    "dependencies": {
+      "type": "array",
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["id", "versions", "optional"],
+        "properties": {
+          "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+          "versions": { "$ref": "common.schema.json#/$defs/versionRange" },
+          "optional": { "type": "boolean" }
+        }
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+    },
+    "locales": {
+      "type": "array",
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/locale" }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  },
+  "$defs": {
+    "capabilityRequirement": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "versions"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "versions": { "$ref": "common.schema.json#/$defs/versionRange" }
+      }
+    }
+  }
+}

package/schemas/preview-message.schema.json

@@ -0,0 +1,226 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/preview-message.schema.json",
+  "title": "Studio preview channel message",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "channelId",
+    "sessionGeneration",
+    "sequence",
+    "type",
+    "payload"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "preview-message" },
+    "channelId": { "$ref": "common.schema.json#/$defs/stableId" },
+    "sessionGeneration": { "$ref": "common.schema.json#/$defs/revision" },
+    "sequence": { "type": "integer", "minimum": 0 },
+    "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "payload": {
+      "type": "object",
+      "maxProperties": 1000,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+      "additionalProperties": { "$ref": "common.schema.json#/$defs/jsonValue" }
+    }
+  },
+  "allOf": [
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/ready" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/ready" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/render" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/render" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/rendered" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/rendered" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/select" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/select" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/measure" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/measure" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/measurements" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/measurements" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/error" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/error" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/reload" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/reload" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.preview/teardown" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/teardown" } } }
+    }
+  ],
+  "$defs": {
+    "ready": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["protocolVersion", "renderer", "viewports"],
+      "properties": {
+        "protocolVersion": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+        "renderer": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "viewports": {
+          "type": "array",
+          "maxItems": 20,
+          "items": { "$ref": "common.schema.json#/$defs/localName" }
+        }
+      }
+    },
+    "render": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["artifactId", "draftDigest", "viewport"],
+      "properties": {
+        "artifactId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "draftDigest": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
+        },
+        "draftRevision": { "$ref": "common.schema.json#/$defs/revision" },
+        "viewport": { "$ref": "common.schema.json#/$defs/localName" }
+      }
+    },
+    "rendered": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["draftDigest", "markers", "diagnostics"],
+      "properties": {
+        "draftDigest": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
+        },
+        "markers": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": { "$ref": "common.schema.json#/$defs/stableId" }
+        },
+        "markerMap": {
+          "type": "object",
+          "maxProperties": 100000,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/stableId" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/stableId" }
+        },
+        "diagnostics": {
+          "type": "array",
+          "maxItems": 10000,
+          "items": { "$ref": "common.schema.json#/$defs/diagnostic" }
+        }
+      }
+    },
+    "select": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "reveal": { "type": "boolean", "default": true }
+      }
+    },
+    "measure": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["requestId", "markers"],
+      "properties": {
+        "requestId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "markers": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": { "$ref": "common.schema.json#/$defs/stableId" }
+        }
+      }
+    },
+    "measurements": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["requestId", "draftDigest", "measurements", "unknown", "viewport"],
+      "properties": {
+        "requestId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "draftDigest": {
+          "type": "string",
+          "pattern": "^[a-f0-9]{64}(?![\\s\\S])"
+        },
+        "measurements": {
+          "type": "object",
+          "maxProperties": 1000,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/stableId" },
+          "additionalProperties": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 1000,
+            "items": { "$ref": "#/$defs/markerRect" }
+          }
+        },
+        "unknown": {
+          "type": "array",
+          "maxItems": 1000,
+          "items": { "$ref": "common.schema.json#/$defs/stableId" }
+        },
+        "viewport": { "$ref": "#/$defs/viewportMetrics" }
+      }
+    },
+    "markerRect": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["x", "y", "width", "height"],
+      "properties": {
+        "x": { "type": "number", "minimum": -100000000, "maximum": 100000000 },
+        "y": { "type": "number", "minimum": -100000000, "maximum": 100000000 },
+        "width": { "type": "number", "minimum": 0, "maximum": 100000000 },
+        "height": { "type": "number", "minimum": 0, "maximum": 100000000 }
+      }
+    },
+    "viewportMetrics": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["width", "height", "scrollX", "scrollY", "devicePixelRatio"],
+      "properties": {
+        "width": { "type": "number", "minimum": 0, "maximum": 100000000 },
+        "height": { "type": "number", "minimum": 0, "maximum": 100000000 },
+        "scrollX": { "type": "number", "minimum": -100000000, "maximum": 100000000 },
+        "scrollY": { "type": "number", "minimum": -100000000, "maximum": 100000000 },
+        "devicePixelRatio": { "type": "number", "exclusiveMinimum": 0, "maximum": 100 }
+      }
+    },
+    "error": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "message", "retryable"],
+      "properties": {
+        "code": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "message": { "$ref": "common.schema.json#/$defs/messageReference" },
+        "retryable": { "type": "boolean" },
+        "correlationId": { "$ref": "common.schema.json#/$defs/stableId" }
+      }
+    },
+    "reload": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["reason"],
+      "properties": {
+        "reason": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+      }
+    },
+    "teardown": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["reason"],
+      "properties": {
+        "reason": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+      }
+    }
+  }
+}

package/schemas/provenance.schema.json

@@ -0,0 +1,57 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/provenance.schema.json",
+  "title": "Studio artifact provenance record",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["contractVersion", "kind", "artifact", "chain"],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "provenance" },
+    "artifact": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "revision"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "revision": { "$ref": "common.schema.json#/$defs/revision" }
+      }
+    },
+    "chain": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 10000,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["origin", "toRevision", "recordedAt", "actor"],
+        "properties": {
+          "origin": {
+            "enum": ["authoring", "import", "migration", "pattern", "plugin", "system"]
+          },
+          "fromRevision": { "$ref": "common.schema.json#/$defs/revision" },
+          "toRevision": { "$ref": "common.schema.json#/$defs/revision" },
+          "recordedAt": { "$ref": "common.schema.json#/$defs/rfc3339Instant" },
+          "actor": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["id"],
+            "properties": {
+              "id": { "$ref": "common.schema.json#/$defs/stableId" },
+              "displayName": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 200
+              }
+            }
+          },
+          "sessionId": { "$ref": "common.schema.json#/$defs/stableId" },
+          "commandCount": { "type": "integer", "minimum": 0, "maximum": 100000 },
+          "source": { "$ref": "common.schema.json#/$defs/artifactReference" },
+          "migrationId": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+        }
+      }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  }
+}

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

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/rich-text-projection.schema.json",
+  "title": "Studio rich-text renderer-conformance fixture",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["description", "document", "projection"],
+  "properties": {
+    "description": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 500
+    },
+    "document": { "$ref": "rich-text.schema.json" },
+    "projection": {
+      "type": "array",
+      "maxItems": 100000,
+      "items": { "$ref": "#/$defs/blockProjection" }
+    }
+  },
+  "$defs": {
+    "blockProjection": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "text", "spans", "embeds"],
+      "properties": {
+        "type": { "enum": ["heading", "horizontalRule", "paragraph"] },
+        "text": {
+          "type": "string",
+          "maxLength": 250000
+        },
+        "spans": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": { "$ref": "#/$defs/span" }
+        },
+        "embeds": {
+          "type": "array",
+          "maxItems": 100000,
+          "items": { "$ref": "#/$defs/embed" }
+        }
+      }
+    },
+    "span": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["start", "end", "marks"],
+      "properties": {
+        "start": { "type": "integer", "minimum": 0, "maximum": 250000 },
+        "end": { "type": "integer", "minimum": 1, "maximum": 250000 },
+        "marks": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 4,
+          "uniqueItems": true,
+          "items": { "enum": ["bold", "code", "italic", "strike"] }
+        }
+      }
+    },
+    "embed": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["index", "kind"],
+      "properties": {
+        "index": { "type": "integer", "minimum": 0, "maximum": 250000 },
+        "kind": { "enum": ["hardBreak"] }
+      }
+    }
+  }
+}