@kumwe/studio-protocol 0.1.0-alpha.2

package/schemas/command.schema.json

@@ -0,0 +1,373 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/command.schema.json",
+  "title": "Studio command",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "contractVersion",
+    "kind",
+    "id",
+    "type",
+    "artifactId",
+    "sessionGeneration",
+    "baseStateVersion",
+    "payload"
+  ],
+  "properties": {
+    "contractVersion": { "$ref": "common.schema.json#/$defs/contractVersion" },
+    "kind": { "const": "command" },
+    "id": { "$ref": "common.schema.json#/$defs/stableId" },
+    "type": { "$ref": "common.schema.json#/$defs/qualifiedName" },
+    "artifactId": { "$ref": "common.schema.json#/$defs/stableId" },
+    "expectedRevision": { "$ref": "common.schema.json#/$defs/revision" },
+    "sessionGeneration": { "$ref": "common.schema.json#/$defs/revision" },
+    "baseStateVersion": { "type": "integer", "minimum": 0 },
+    "groupId": { "$ref": "common.schema.json#/$defs/stableId" },
+    "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.command/insert-node" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/insertNode" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/remove-node" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/removeNode" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/restore-node" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/restoreNode" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/move-node" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/moveNode" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/duplicate-node" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/duplicateNode" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/reorder-children" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/reorderChildren" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/set-property" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/setProperty" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/unset-property" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/unsetProperty" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/reset-inherited-property" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/resetInheritedProperty" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/set-binding" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/setBinding" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/remove-binding" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/removeBinding" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/set-field-value" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/setFieldValue" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/apply-pattern" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/applyPattern" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/add-model-field" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/addModelField" } } }
+    },
+    {
+      "if": { "properties": { "type": { "const": "studio.command/batch" } } },
+      "then": { "properties": { "payload": { "$ref": "#/$defs/batch" } } }
+    }
+  ],
+  "$defs": {
+    "destination": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["position"],
+      "properties": {
+        "parentNodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "slot": { "$ref": "common.schema.json#/$defs/localName" },
+        "position": { "type": "integer", "minimum": 0, "maximum": 100000 }
+      },
+      "dependentRequired": {
+        "parentNodeId": ["slot"],
+        "slot": ["parentNodeId"]
+      }
+    },
+    "insertNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["node", "destination"],
+      "properties": {
+        "node": { "$ref": "blueprint.schema.json#/$defs/node" },
+        "destination": { "$ref": "#/$defs/destination" }
+      }
+    },
+    "removeNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" }
+      }
+    },
+    "restoreNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["node", "destination"],
+      "properties": {
+        "node": { "$ref": "blueprint.schema.json#/$defs/node" },
+        "destination": { "$ref": "#/$defs/destination" }
+      }
+    },
+    "moveNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "destination"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "destination": { "$ref": "#/$defs/destination" }
+      }
+    },
+    "duplicateNode": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "idMap"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "destination": { "$ref": "#/$defs/destination" },
+        "idMap": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 5000,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/stableId" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/stableId" }
+        }
+      }
+    },
+    "reorderChildren": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["order"],
+      "properties": {
+        "parentNodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "slot": { "$ref": "common.schema.json#/$defs/localName" },
+        "order": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 10000,
+          "uniqueItems": true,
+          "items": { "$ref": "common.schema.json#/$defs/stableId" }
+        }
+      },
+      "dependentRequired": {
+        "parentNodeId": ["slot"],
+        "slot": ["parentNodeId"]
+      }
+    },
+    "setProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "property", "value"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "property": { "$ref": "common.schema.json#/$defs/localName" },
+        "viewport": { "$ref": "common.schema.json#/$defs/localName" },
+        "value": { "$ref": "common.schema.json#/$defs/jsonValue" }
+      }
+    },
+    "unsetProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "property"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "property": { "$ref": "common.schema.json#/$defs/localName" },
+        "viewport": { "$ref": "common.schema.json#/$defs/localName" }
+      }
+    },
+    "resetInheritedProperty": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "property"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "property": { "$ref": "common.schema.json#/$defs/localName" }
+      }
+    },
+    "setBinding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "port", "binding"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "port": { "$ref": "common.schema.json#/$defs/localName" },
+        "binding": { "$ref": "blueprint.schema.json#/$defs/binding" }
+      }
+    },
+    "removeBinding": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["nodeId", "port"],
+      "properties": {
+        "nodeId": { "$ref": "common.schema.json#/$defs/stableId" },
+        "port": { "$ref": "common.schema.json#/$defs/localName" }
+      }
+    },
+    "setFieldValue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["fieldPath", "value"],
+      "properties": {
+        "fieldPath": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 32,
+          "items": { "$ref": "common.schema.json#/$defs/localName" }
+        },
+        "locale": { "$ref": "common.schema.json#/$defs/locale" },
+        "value": { "$ref": "common.schema.json#/$defs/jsonValue" }
+      }
+    },
+    "addModelField": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["field"],
+      "properties": {
+        "field": { "$ref": "content-model.schema.json#/$defs/field" },
+        "position": { "type": "integer", "minimum": 0, "maximum": 1000 }
+      }
+    },
+    "applyPattern": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["pattern", "nodes", "destination", "idMap"],
+      "properties": {
+        "pattern": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["id", "version", "revision"],
+          "properties": {
+            "id": { "$ref": "common.schema.json#/$defs/stableId" },
+            "version": { "$ref": "common.schema.json#/$defs/semanticVersion" },
+            "revision": { "$ref": "common.schema.json#/$defs/revision" }
+          }
+        },
+        "nodes": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "items": { "$ref": "blueprint.schema.json#/$defs/node" }
+        },
+        "destination": { "$ref": "#/$defs/destination" },
+        "idMap": {
+          "type": "object",
+          "minProperties": 1,
+          "maxProperties": 5000,
+          "propertyNames": { "$ref": "common.schema.json#/$defs/stableId" },
+          "additionalProperties": { "$ref": "common.schema.json#/$defs/stableId" }
+        }
+      }
+    },
+    "batch": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["operations"],
+      "properties": {
+        "operations": {
+          "type": "array",
+          "minItems": 1,
+          "maxItems": 100,
+          "items": { "$ref": "#/$defs/batchOperation" }
+        }
+      }
+    },
+    "batchOperation": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["type", "payload"],
+      "properties": {
+        "type": {
+          "allOf": [
+            { "$ref": "common.schema.json#/$defs/qualifiedName" },
+            {
+              "not": {
+                "enum": [
+                  "studio.command/apply-pattern",
+                  "studio.command/batch",
+                  "studio.command/reset-inherited-property"
+                ]
+              }
+            }
+          ]
+        },
+        "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.command/insert-node" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/insertNode" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/remove-node" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/removeNode" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/restore-node" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/restoreNode" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/move-node" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/moveNode" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/duplicate-node" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/duplicateNode" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/reorder-children" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/reorderChildren" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/set-property" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/setProperty" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/unset-property" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/unsetProperty" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/set-binding" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/setBinding" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/remove-binding" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/removeBinding" } } }
+        },
+        {
+          "if": { "properties": { "type": { "const": "studio.command/set-field-value" } } },
+          "then": { "properties": { "payload": { "$ref": "#/$defs/setFieldValue" } } }
+        }
+      ]
+    }
+  }
+}

package/schemas/common.schema.json

@@ -0,0 +1,222 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schemas.kumwe.org/studio/v1/common.schema.json",
+  "title": "Studio common contract types",
+  "type": "object",
+  "additionalProperties": false,
+  "$defs": {
+    "contractVersion": {
+      "type": "string",
+      "const": "0.1-draft"
+    },
+    "semanticVersion": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-((?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*)(?:\\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*))?(?:\\+([0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*))?(?![\\s\\S])",
+      "maxLength": 100
+    },
+    "versionRange": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 120,
+      "pattern": "^[0-9A-Za-z.*+<>=~^| -]+(?![\\s\\S])"
+    },
+    "qualifiedName": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*/[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*(?![\\s\\S])",
+      "maxLength": 160
+    },
+    "localName": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:[._-][a-z0-9]+)*(?![\\s\\S])",
+      "not": { "enum": ["__proto__", "prototype", "constructor"] },
+      "maxLength": 100
+    },
+    "safeJsonMemberName": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "pattern": "^[^\\u0000-\\u001F\\u007F]+(?![\\s\\S])",
+      "not": { "enum": ["__proto__", "prototype", "constructor"] }
+    },
+    "packageRelativePath": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9@][A-Za-z0-9._@-]*(?:/[A-Za-z0-9@][A-Za-z0-9._@-]*)*(?![\\s\\S])",
+      "maxLength": 240
+    },
+    "stableId": {
+      "type": "string",
+      "pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]*(?![\\s\\S])",
+      "not": { "enum": ["__proto__", "prototype", "constructor"] },
+      "maxLength": 240
+    },
+    "revision": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "integrity": {
+      "type": "string",
+      "pattern": "^(?:sha256-[A-Za-z0-9+/]{42}[AEIMQUYcgkosw048]=|sha384-[A-Za-z0-9+/]{64}|sha512-[A-Za-z0-9+/]{85}[AQgw]==)(?![\\s\\S])",
+      "maxLength": 200
+    },
+    "locale": {
+      "type": "string",
+      "pattern": "^[A-Za-z]{2,8}(?:-[A-Za-z0-9]{1,8})*(?![\\s\\S])",
+      "maxLength": 50
+    },
+    "canonicalDecimal": {
+      "type": "string",
+      "pattern": "^(?:-?(?:0|[1-9][0-9]*)\\.[0-9]+|0|-?[1-9][0-9]*)(?![\\s\\S])",
+      "maxLength": 40
+    },
+    "currencyCode": {
+      "type": "string",
+      "pattern": "^[A-Z]{3}(?![\\s\\S])"
+    },
+    "moneyValue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["amount", "currency"],
+      "properties": {
+        "amount": { "$ref": "#/$defs/canonicalDecimal" },
+        "currency": { "$ref": "#/$defs/currencyCode" }
+      }
+    },
+    "rfc3339Date": {
+      "type": "string",
+      "pattern": "^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])(?![\\s\\S])"
+    },
+    "rfc3339Instant": {
+      "type": "string",
+      "pattern": "^[0-9]{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12][0-9]|3[01])T(?:[01][0-9]|2[0-3]):[0-5][0-9]:(?:[0-5][0-9]|60)(?:\\.[0-9]{1,9})?(?:Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(?![\\s\\S])",
+      "maxLength": 40
+    },
+    "messageReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key"],
+      "properties": {
+        "key": { "$ref": "#/$defs/qualifiedName" },
+        "defaultMessage": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 500
+        }
+      }
+    },
+    "ownerReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version"],
+      "properties": {
+        "id": { "$ref": "#/$defs/qualifiedName" },
+        "version": { "$ref": "#/$defs/semanticVersion" }
+      }
+    },
+    "artifactReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version"],
+      "properties": {
+        "id": { "$ref": "#/$defs/stableId" },
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "revision": { "$ref": "#/$defs/revision" },
+        "integrity": { "$ref": "#/$defs/integrity" }
+      }
+    },
+    "lockedArtifactReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "version", "revision"],
+      "properties": {
+        "id": { "$ref": "#/$defs/stableId" },
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "revision": { "$ref": "#/$defs/revision" },
+        "integrity": { "$ref": "#/$defs/integrity" }
+      }
+    },
+    "resolvedEntryReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "revision"],
+      "properties": {
+        "id": { "$ref": "#/$defs/stableId" },
+        "revision": { "$ref": "#/$defs/revision" },
+        "integrity": { "$ref": "#/$defs/integrity" }
+      }
+    },
+    "jsonValue": {
+      "oneOf": [
+        { "type": "null" },
+        { "type": "boolean" },
+        { "type": "number" },
+        { "type": "string" },
+        {
+          "type": "array",
+          "maxItems": 10000,
+          "items": { "$ref": "#/$defs/jsonValue" }
+        },
+        {
+          "type": "object",
+          "maxProperties": 10000,
+          "propertyNames": { "$ref": "#/$defs/safeJsonMemberName" },
+          "additionalProperties": { "$ref": "#/$defs/jsonValue" }
+        }
+      ]
+    },
+    "extensions": {
+      "type": "object",
+      "maxProperties": 100,
+      "propertyNames": { "$ref": "#/$defs/qualifiedName" },
+      "additionalProperties": { "$ref": "#/$defs/jsonValue" }
+    },
+    "diagnosticLocation": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "artifactId": { "$ref": "#/$defs/stableId" },
+        "nodeId": { "$ref": "#/$defs/stableId" },
+        "fieldPath": {
+          "type": "array",
+          "maxItems": 32,
+          "items": { "$ref": "#/$defs/localName" }
+        },
+        "jsonPointer": {
+          "type": "string",
+          "maxLength": 1000
+        }
+      }
+    },
+    "diagnostic": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["code", "severity", "message"],
+      "properties": {
+        "code": { "$ref": "#/$defs/qualifiedName" },
+        "severity": {
+          "enum": ["information", "warning", "error", "blocking"]
+        },
+        "message": { "$ref": "#/$defs/messageReference" },
+        "location": { "$ref": "#/$defs/diagnosticLocation" },
+        "parameters": {
+          "type": "object",
+          "maxProperties": 20,
+          "propertyNames": { "$ref": "#/$defs/safeJsonMemberName" },
+          "additionalProperties": {
+            "oneOf": [
+              { "type": "string" },
+              { "type": "number" },
+              { "type": "boolean" },
+              { "type": "null" }
+            ]
+          }
+        },
+        "remediations": {
+          "type": "array",
+          "maxItems": 10,
+          "items": { "$ref": "#/$defs/qualifiedName" }
+        }
+      }
+    }
+  }
+}