@kumwe/studio-protocol 0.1.0-alpha.2

package/schemas/rich-text.schema.json

@@ -0,0 +1,174 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/rich-text.schema.json",
+  "title": "Studio portable rich text",
+  "$ref": "#/$defs/doc",
+  "$defs": {
+    "doc": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "doc" },
+        "content": {
+          "type": "array",
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/block" }
+        }
+      }
+    },
+    "block": {
+      "oneOf": [
+        { "$ref": "#/$defs/paragraph" },
+        { "$ref": "#/$defs/heading" },
+        { "$ref": "#/$defs/blockquote" },
+        { "$ref": "#/$defs/bulletList" },
+        { "$ref": "#/$defs/orderedList" },
+        { "$ref": "#/$defs/horizontalRule" }
+      ]
+    },
+    "paragraph": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "paragraph" },
+        "content": {
+          "type": "array",
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/inline" }
+        }
+      }
+    },
+    "heading": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "attrs"],
+      "properties": {
+        "type": { "const": "heading" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["level"],
+          "properties": {
+            "level": { "enum": [2, 3, 4] }
+          }
+        },
+        "content": {
+          "type": "array",
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/inline" }
+        }
+      }
+    },
+    "blockquote": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "blockquote" },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/block" }
+        }
+      }
+    },
+    "bulletList": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "bulletList" },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/listItem" }
+        }
+      }
+    },
+    "orderedList": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "orderedList" },
+        "attrs": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["start"],
+          "properties": {
+            "start": { "type": "integer", "minimum": 1, "maximum": 1000000 }
+          }
+        },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/listItem" }
+        }
+      }
+    },
+    "listItem": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "content"],
+      "properties": {
+        "type": { "const": "listItem" },
+        "content": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 5000,
+          "items": { "$ref": "#/$defs/block" }
+        }
+      }
+    },
+    "horizontalRule": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "horizontalRule" }
+      }
+    },
+    "hardBreak": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "const": "hardBreak" }
+      }
+    },
+    "text": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "text"],
+      "properties": {
+        "type": { "const": "text" },
+        "text": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 250000
+        },
+        "marks": {
+          "type": "array",
+          "maxItems": 4,
+          "items": { "$ref": "#/$defs/mark" }
+        }
+      }
+    },
+    "inline": {
+      "oneOf": [{ "$ref": "#/$defs/text" }, { "$ref": "#/$defs/hardBreak" }]
+    },
+    "mark": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type"],
+      "properties": {
+        "type": { "enum": ["bold", "code", "italic", "strike"] }
+      }
+    }
+  }
+}

package/schemas/schema-profile.schema.json

@@ -0,0 +1,161 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/schema-profile.schema.json",
+  "title": "Studio Schema Profile meta-schema",
+  "$ref": "#/$defs/schema",
+  "$defs": {
+    "schema": {
+      "type": "object",
+      "propertyNames": {
+        "enum": [
+          "$defs",
+          "$ref",
+          "$schema",
+          "additionalProperties",
+          "allOf",
+          "anyOf",
+          "const",
+          "default",
+          "dependentRequired",
+          "description",
+          "else",
+          "enum",
+          "examples",
+          "exclusiveMaximum",
+          "exclusiveMinimum",
+          "if",
+          "items",
+          "maxItems",
+          "maxLength",
+          "maxProperties",
+          "maximum",
+          "minItems",
+          "minLength",
+          "minProperties",
+          "minimum",
+          "multipleOf",
+          "not",
+          "oneOf",
+          "prefixItems",
+          "properties",
+          "propertyNames",
+          "readOnly",
+          "required",
+          "then",
+          "title",
+          "type",
+          "uniqueItems",
+          "writeOnly"
+        ]
+      },
+      "properties": {
+        "$defs": { "$ref": "#/$defs/schemaMap" },
+        "$ref": {
+          "type": "string",
+          "maxLength": 500,
+          "pattern": "^#(?:/[^\\u0000-\\u001F\\u007F]*)?(?![\\s\\S])"
+        },
+        "$schema": { "const": "https://json-schema.org/draft/2020-12/schema" },
+        "additionalProperties": { "$ref": "#/$defs/subschema" },
+        "allOf": { "$ref": "#/$defs/schemaArray" },
+        "anyOf": { "$ref": "#/$defs/schemaArray" },
+        "const": { "$ref": "common.schema.json#/$defs/jsonValue" },
+        "default": { "$ref": "common.schema.json#/$defs/jsonValue" },
+        "dependentRequired": {
+          "type": "object",
+          "maxProperties": 512,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+          "additionalProperties": {
+            "type": "array",
+            "maxItems": 512,
+            "items": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" }
+          }
+        },
+        "description": { "type": "string", "maxLength": 10000 },
+        "else": { "$ref": "#/$defs/subschema" },
+        "enum": {
+          "type": "array",
+          "maxItems": 1024,
+          "items": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        },
+        "examples": {
+          "type": "array",
+          "maxItems": 100,
+          "items": { "$ref": "common.schema.json#/$defs/jsonValue" }
+        },
+        "exclusiveMaximum": { "type": "number" },
+        "exclusiveMinimum": { "type": "number" },
+        "if": { "$ref": "#/$defs/subschema" },
+        "items": { "$ref": "#/$defs/subschema" },
+        "maxItems": { "type": "integer", "minimum": 0 },
+        "maxLength": { "type": "integer", "minimum": 0 },
+        "maxProperties": { "type": "integer", "minimum": 0 },
+        "maximum": { "type": "number" },
+        "minItems": { "type": "integer", "minimum": 0 },
+        "minLength": { "type": "integer", "minimum": 0 },
+        "minProperties": { "type": "integer", "minimum": 0 },
+        "minimum": { "type": "number" },
+        "multipleOf": { "type": "number", "exclusiveMinimum": 0 },
+        "not": { "$ref": "#/$defs/subschema" },
+        "oneOf": { "$ref": "#/$defs/schemaArray" },
+        "prefixItems": { "$ref": "#/$defs/schemaArray" },
+        "properties": { "$ref": "#/$defs/schemaMap" },
+        "propertyNames": { "$ref": "#/$defs/subschema" },
+        "readOnly": { "type": "boolean" },
+        "required": {
+          "type": "array",
+          "maxItems": 512,
+          "items": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" }
+        },
+        "then": { "$ref": "#/$defs/subschema" },
+        "title": { "type": "string", "maxLength": 1000 },
+        "type": {
+          "oneOf": [
+            { "$ref": "#/$defs/typeName" },
+            {
+              "type": "array",
+              "minItems": 1,
+              "maxItems": 7,
+              "uniqueItems": true,
+              "items": { "$ref": "#/$defs/typeName" }
+            }
+          ]
+        },
+        "uniqueItems": { "type": "boolean" },
+        "writeOnly": { "type": "boolean" }
+      }
+    },
+    "schemaArray": {
+      "type": "array",
+      "maxItems": 64,
+      "items": { "$ref": "#/$defs/subschema" }
+    },
+    "schemaMap": {
+      "type": "object",
+      "maxProperties": 512,
+      "propertyNames": { "$ref": "common.schema.json#/$defs/safeJsonMemberName" },
+      "additionalProperties": { "$ref": "#/$defs/schema" }
+    },
+    "subschema": {
+      "oneOf": [{ "type": "boolean" }, { "$ref": "#/$defs/schema" }]
+    },
+    "typeName": {
+      "enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
+    },
+    "limits": {
+      "const": {
+        "maxAlternatives": 64,
+        "maxEnumMembers": 1024,
+        "maxJsonDepth": 64,
+        "maxJsonItems": 10000,
+        "maxJsonProperties": 1000,
+        "maxObjectKeyLength": 200,
+        "maxReferences": 128,
+        "maxSchemaBytes": 262144,
+        "maxSchemaDepth": 32,
+        "maxSchemaMapProperties": 512,
+        "maxSchemaNodes": 1024
+      }
+    }
+  }
+}

package/schemas/studio-config.schema.json

@@ -0,0 +1,244 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/studio-config.schema.json",
+  "title": "Studio resolved session configuration",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "protocolVersion",
+    "sessionId",
+    "sessionGeneration",
+    "mode",
+    "composite",
+    "sessionState",
+    "actor",
+    "locale",
+    "displayPreferences",
+    "resourceContext",
+    "permissions",
+    "artifacts",
+    "blocks",
+    "plugins",
+    "hostCapabilities",
+    "limits",
+    "features",
+    "preview"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "protocolVersion": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+    "sessionId": { "$ref": "common.schema.json#/$defs/stableId" },
+    "sessionGeneration": { "$ref": "common.schema.json#/$defs/revision" },
+    "mode": {
+      "enum": ["model", "blueprint", "content"]
+    },
+    "composite": { "enum": ["single", "hybrid"] },
+    "sessionState": { "enum": ["editable", "read-only"] },
+    "actor": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "displayName"],
+      "properties": {
+        "id": { "$ref": "common.schema.json#/$defs/stableId" },
+        "displayName": { "type": "string", "minLength": 1, "maxLength": 200 }
+      }
+    },
+    "locale": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["requested", "resolved", "fallbacks", "direction", "timeZone"],
+      "properties": {
+        "requested": { "$ref": "common.schema.json#/$defs/locale" },
+        "resolved": { "$ref": "common.schema.json#/$defs/locale" },
+        "fallbacks": {
+          "type": "array",
+          "maxItems": 10,
+          "uniqueItems": true,
+          "items": { "$ref": "common.schema.json#/$defs/locale" }
+        },
+        "direction": { "enum": ["ltr", "rtl"] },
+        "timeZone": { "type": "string", "minLength": 1, "maxLength": 100 }
+      }
+    },
+    "displayPreferences": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["calendar", "numberingSystem", "hourCycle"],
+      "properties": {
+        "calendar": { "$ref": "common.schema.json#/$defs/localName" },
+        "numberingSystem": { "$ref": "common.schema.json#/$defs/localName" },
+        "hourCycle": { "enum": ["h11", "h12", "h23", "h24"] },
+        "measurementSystem": { "enum": ["metric", "us", "uk"] }
+      }
+    },
+    "resourceContext": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "surface", "scopes"],
+      "properties": {
+        "key": { "$ref": "common.schema.json#/$defs/stableId" },
+        "surface": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+        "revision": { "$ref": "common.schema.json#/$defs/revision" },
+        "scopes": {
+          "type": "array",
+          "maxItems": 20,
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["kind", "id"],
+            "properties": {
+              "kind": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+              "id": { "$ref": "common.schema.json#/$defs/stableId" }
+            }
+          }
+        },
+        "resource": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["type", "id"],
+          "properties": {
+            "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            "id": { "$ref": "common.schema.json#/$defs/stableId" }
+          }
+        }
+      }
+    },
+    "permissions": {
+      "type": "array",
+      "maxItems": 500,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/qualifiedName" }
+    },
+    "artifacts": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "model": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "blueprint": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" },
+        "entry": { "$ref": "common.schema.json#/$defs/resolvedEntryReference" },
+        "theme": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" }
+      }
+    },
+    "plugins": {
+      "type": "array",
+      "maxItems": 100,
+      "uniqueItems": true,
+      "items": { "$ref": "common.schema.json#/$defs/lockedArtifactReference" }
+    },
+    "blocks": {
+      "type": "array",
+      "maxItems": 5000,
+      "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" }
+        }
+      }
+    },
+    "hostCapabilities": {
+      "$ref": "host-capabilities.schema.json"
+    },
+    "limits": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "maxNodes",
+        "maxDepth",
+        "maxSlotsPerNode",
+        "maxChildrenPerSlot",
+        "maxPropertyBytes",
+        "maxExtensionBytes",
+        "maxCommandBatch",
+        "maxHistoryEntries",
+        "maxRichTextBytes",
+        "maxRichTextDepth",
+        "maxPreviewRequestsPerMinute",
+        "maxPreviewBytes",
+        "maxMediaUploadBytes",
+        "maxMediaBatch",
+        "maxPluginCount",
+        "maxContributionsPerPlugin",
+        "maxLocaleBytes"
+      ],
+      "properties": {
+        "maxNodes": { "type": "integer", "minimum": 1, "maximum": 100000 },
+        "maxDepth": { "type": "integer", "minimum": 1, "maximum": 128 },
+        "maxSlotsPerNode": { "type": "integer", "minimum": 0, "maximum": 100 },
+        "maxChildrenPerSlot": { "type": "integer", "minimum": 0, "maximum": 10000 },
+        "maxPropertyBytes": { "type": "integer", "minimum": 0, "maximum": 10485760 },
+        "maxExtensionBytes": { "type": "integer", "minimum": 0, "maximum": 10485760 },
+        "maxCommandBatch": { "type": "integer", "minimum": 1, "maximum": 10000 },
+        "maxHistoryEntries": { "type": "integer", "minimum": 1, "maximum": 100000 },
+        "maxRichTextBytes": { "type": "integer", "minimum": 1, "maximum": 10485760 },
+        "maxRichTextDepth": { "type": "integer", "minimum": 1, "maximum": 128 },
+        "maxPreviewRequestsPerMinute": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 60000
+        },
+        "maxPreviewBytes": { "type": "integer", "minimum": 1, "maximum": 52428800 },
+        "maxMediaUploadBytes": { "type": "integer", "minimum": 1, "maximum": 1099511627776 },
+        "maxMediaBatch": { "type": "integer", "minimum": 1, "maximum": 1000 },
+        "maxPluginCount": { "type": "integer", "minimum": 0, "maximum": 100 },
+        "maxContributionsPerPlugin": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 5000
+        },
+        "maxLocaleBytes": { "type": "integer", "minimum": 1, "maximum": 104857600 }
+      }
+    },
+    "features": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "executablePlugins",
+        "customInspectors",
+        "externalMediaImport",
+        "clipboardMediaUpload",
+        "collaboration",
+        "offlineRecovery"
+      ],
+      "properties": {
+        "executablePlugins": { "type": "boolean" },
+        "customInspectors": { "type": "boolean" },
+        "externalMediaImport": { "type": "boolean" },
+        "clipboardMediaUpload": { "type": "boolean" },
+        "collaboration": { "type": "boolean" },
+        "offlineRecovery": { "type": "boolean" }
+      }
+    },
+    "preview": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["enabled", "sameOriginRequired", "allowApproximateRenderer"],
+      "properties": {
+        "enabled": { "type": "boolean" },
+        "sameOriginRequired": { "type": "boolean" },
+        "allowApproximateRenderer": { "type": "boolean" },
+        "initialViewport": { "$ref": "common.schema.json#/$defs/localName" }
+      }
+    },
+    "extensions": { "$ref": "common.schema.json#/$defs/extensions" }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": { "composite": { "const": "hybrid" } },
+        "required": ["composite"]
+      },
+      "then": {
+        "properties": {
+          "mode": { "enum": ["blueprint", "content"] }
+        }
+      }
+    }
+  ]
+}