@cratis/event-models 0.0.0-stage → 0.106.0

package/dist/event-model-document.schema.json

@@ -0,0 +1,827 @@
+{
+    "$schema": "https://json-schema.org/draft/2020-12/schema",
+    "$id": "https://cratis.io/schemas/event-models/0.1/event-model-document.json",
+    "title": "Cratis event model document",
+    "description": "The document @cratis/event-models draws. Unknown properties are ignored by readers, so producers may add properties without breaking older consumers; missing optional sections are absent.",
+    "$ref": "#/$defs/EventModel",
+    "$defs": {
+        "Guid": {
+            "type": "string",
+            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+        },
+        "JsonSchema": {
+            "description": "A JSON Schema object, or the same object serialized to a string. Anything else reads as an empty object schema.",
+            "type": [
+                "object",
+                "string"
+            ]
+        },
+        "Position": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "x": {
+                    "type": "number"
+                },
+                "y": {
+                    "type": "number"
+                }
+            }
+        },
+        "EventModel": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "collections": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ModuleCollection"
+                    }
+                },
+                "stickyNotes": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/StickyNote"
+                    }
+                },
+                "links": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ModuleCollectionLink"
+                    }
+                }
+            }
+        },
+        "ModuleCollection": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "position": {
+                    "$ref": "#/$defs/Position"
+                },
+                "modules": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Module"
+                    }
+                },
+                "actors": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Actor"
+                    }
+                }
+            }
+        },
+        "ModuleCollectionLink": {
+            "type": "object",
+            "required": [
+                "id",
+                "sourceCollectionId",
+                "targetCollectionId"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "sourceCollectionId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "targetCollectionId": {
+                    "$ref": "#/$defs/Guid"
+                }
+            }
+        },
+        "Module": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "features": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Feature"
+                    }
+                },
+                "collapsed": {
+                    "type": "boolean"
+                },
+                "sortOrder": {
+                    "type": "number"
+                },
+                "screenTemplate": {
+                    "$ref": "#/$defs/ScreenTemplate"
+                },
+                "commentCount": {
+                    "type": "number"
+                }
+            }
+        },
+        "Feature": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "subFeatures": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Feature"
+                    }
+                },
+                "slices": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/Slice"
+                    }
+                },
+                "collapsed": {
+                    "type": "boolean"
+                },
+                "rowCollapsed": {
+                    "type": "boolean"
+                },
+                "enabled": {
+                    "type": "boolean",
+                    "description": "Absent reads as enabled."
+                },
+                "screenTemplate": {
+                    "$ref": "#/$defs/ScreenTemplate"
+                },
+                "commentCount": {
+                    "type": "number"
+                }
+            }
+        },
+        "ScreenTemplate": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                }
+            }
+        },
+        "Slice": {
+            "type": "object",
+            "required": [
+                "id",
+                "sliceType",
+                "status"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "sliceType": {
+                    "type": "integer",
+                    "description": "The kind of slice. Known values: 0 = stateChange, 1 = stateView, 2 = automation, 3 = translator. Any other integer is drawn as an explicit unknown."
+                },
+                "description": {
+                    "type": "string"
+                },
+                "status": {
+                    "type": "integer",
+                    "description": "Where the slice is in its workflow. Known values: 0 = notStarted, 1 = draft, 2 = readyForImplementation, 3 = inProgress, 4 = readyForReview, 5 = done, 6 = analysis. Any other integer is drawn as an explicit unknown."
+                },
+                "collapsed": {
+                    "type": "boolean"
+                },
+                "sortOrder": {
+                    "type": "number"
+                },
+                "command": {
+                    "$ref": "#/$defs/CommandItem"
+                },
+                "readModel": {
+                    "$ref": "#/$defs/ReadModelItem"
+                },
+                "externalEvents": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/ExternalEventItem"
+                    }
+                },
+                "events": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/EventItem"
+                    }
+                },
+                "queries": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/QueryItem"
+                    }
+                },
+                "actors": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/UserExperienceActor"
+                    }
+                },
+                "automationTrigger": {
+                    "$ref": "#/$defs/AutomationTrigger"
+                },
+                "specifications": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SliceSpecification"
+                    }
+                },
+                "commentCount": {
+                    "type": "number"
+                },
+                "assignee": {
+                    "$ref": "#/$defs/Assignee"
+                }
+            }
+        },
+        "Assignee": {
+            "type": "object",
+            "required": [
+                "id",
+                "kind"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "kind": {
+                    "type": "string",
+                    "enum": [
+                        "system",
+                        "agent",
+                        "user"
+                    ]
+                },
+                "avatar": {
+                    "type": "string",
+                    "description": "A URL the host can load the avatar image from."
+                }
+            }
+        },
+        "AutomationTrigger": {
+            "type": "object",
+            "required": [
+                "type"
+            ],
+            "properties": {
+                "type": {
+                    "type": "integer",
+                    "description": "What starts the automation. Known values: 0 = timer, 1 = event, 2 = custom, 3 = none. Any other integer is drawn as an explicit unknown."
+                },
+                "description": {
+                    "type": "string"
+                },
+                "schedule": {
+                    "$ref": "#/$defs/AutomationTriggerSchedule"
+                },
+                "eventId": {
+                    "$ref": "#/$defs/Guid"
+                }
+            }
+        },
+        "AutomationTriggerSchedule": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "intervalMinutes": {
+                    "type": "number"
+                },
+                "intervalHours": {
+                    "type": "number"
+                },
+                "timeOfDay": {
+                    "type": "string"
+                },
+                "dayOfWeek": {
+                    "type": "number"
+                },
+                "dayOfMonth": {
+                    "type": "number"
+                },
+                "description": {
+                    "type": "string"
+                }
+            }
+        },
+        "CommandItem": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "schema": {
+                    "$ref": "#/$defs/JsonSchema"
+                },
+                "stateSchema": {
+                    "$ref": "#/$defs/JsonSchema"
+                },
+                "logicDescription": {
+                    "type": "string"
+                },
+                "rules": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/CommandPropertyRules"
+                    }
+                },
+                "concurrency": {
+                    "$ref": "#/$defs/CommandConcurrency"
+                }
+            }
+        },
+        "CommandPropertyRules": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "propertyName": {
+                    "type": "string"
+                },
+                "rules": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/CommandRule"
+                    }
+                }
+            }
+        },
+        "CommandRule": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "errorMessage": {
+                    "type": "string"
+                },
+                "ruleType": {
+                    "type": "string"
+                }
+            }
+        },
+        "CommandConcurrency": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "scopeId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "includeEventSource": {
+                    "type": "boolean"
+                },
+                "eventSourceType": {
+                    "$ref": "#/$defs/ConcurrencyBinding"
+                },
+                "eventStreamType": {
+                    "$ref": "#/$defs/ConcurrencyBinding"
+                },
+                "eventStreamId": {
+                    "$ref": "#/$defs/ConcurrencyBinding"
+                }
+            }
+        },
+        "ConcurrencyBinding": {
+            "type": "object",
+            "required": [
+                "source"
+            ],
+            "properties": {
+                "source": {
+                    "type": "integer",
+                    "description": "Where the dimension takes its value from. Known values: 0 = notSet, 1 = value, 2 = commandProperty. Any other integer is drawn as an explicit unknown."
+                },
+                "value": {
+                    "type": "string"
+                }
+            }
+        },
+        "EventItem": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "schema": {
+                    "$ref": "#/$defs/JsonSchema"
+                },
+                "sourceEventId": {
+                    "type": "string"
+                },
+                "tags": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "constraints": {
+                    "$ref": "#/$defs/EventConstraints"
+                }
+            }
+        },
+        "EventConstraints": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "unique": {
+                    "$ref": "#/$defs/EventConstraint"
+                },
+                "uniqueEventType": {
+                    "$ref": "#/$defs/EventConstraint"
+                }
+            }
+        },
+        "EventConstraint": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "message": {
+                    "type": "string"
+                }
+            }
+        },
+        "ExternalEventItem": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "sourceEventId": {
+                    "type": "string"
+                }
+            }
+        },
+        "ReadModelItem": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "schema": {
+                    "$ref": "#/$defs/JsonSchema"
+                },
+                "materializes": {
+                    "type": "boolean"
+                }
+            }
+        },
+        "QueryItem": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "parameters": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/QueryParameter"
+                    }
+                }
+            }
+        },
+        "QueryParameter": {
+            "type": "object",
+            "required": [
+                "type"
+            ],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "type": {
+                    "type": "integer",
+                    "description": "The type of the parameter. Known values: 0 = text, 1 = number, 2 = boolean, 3 = date, 4 = time, 5 = uniqueId. Any other integer is drawn as an explicit unknown."
+                }
+            }
+        },
+        "Actor": {
+            "type": "object",
+            "required": [
+                "actorType"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "actorType": {
+                    "type": "integer",
+                    "description": "The kind of actor row. Known values: 0 = UIRole, 1 = systemRole, 2 = chatRole. Any other integer is drawn as an explicit unknown."
+                },
+                "description": {
+                    "type": "string"
+                },
+                "persona": {
+                    "$ref": "#/$defs/PersonaReference"
+                }
+            }
+        },
+        "PersonaReference": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                }
+            }
+        },
+        "UserExperienceActor": {
+            "type": "object",
+            "required": [
+                "type"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "type": {
+                    "type": "integer",
+                    "description": "The kind of actor row. Known values: 0 = UIRole, 1 = systemRole, 2 = chatRole. Any other integer is drawn as an explicit unknown."
+                },
+                "elements": {
+                    "type": "array",
+                    "items": {
+                        "type": "object"
+                    },
+                    "description": "Cratis Scene UI elements, drawn by @cratis/scene."
+                },
+                "layout": {
+                    "type": "integer",
+                    "description": "The prototype layout. Known values: 0 = absolute, 1 = flexRow, 2 = flexColumn, 3 = grid. Any other integer is drawn as an explicit unknown."
+                },
+                "windowWidth": {
+                    "type": "number"
+                },
+                "windowHeight": {
+                    "type": "number"
+                }
+            }
+        },
+        "StickyNote": {
+            "type": "object",
+            "required": [],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "position": {
+                    "$ref": "#/$defs/Position"
+                },
+                "width": {
+                    "type": "number"
+                },
+                "height": {
+                    "type": "number"
+                },
+                "text": {
+                    "type": "string"
+                }
+            }
+        },
+        "SliceSpecification": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "given": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SpecificationGivenEvent"
+                    }
+                },
+                "when": {
+                    "$ref": "#/$defs/SpecificationCommand"
+                },
+                "givenReadModel": {
+                    "$ref": "#/$defs/SpecificationReadModel"
+                },
+                "thenEvents": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SpecificationThenEvent"
+                    }
+                },
+                "thenErrors": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/$defs/SpecificationError"
+                    }
+                },
+                "collapsed": {
+                    "type": "boolean"
+                },
+                "lastRunOutcome": {
+                    "type": "integer",
+                    "description": "The outcome of the last run. Known values: 0 = passed, 1 = failed, 2 = inconclusive. Any other integer is drawn as an explicit unknown."
+                },
+                "lastRunMessage": {
+                    "type": "string"
+                }
+            }
+        },
+        "SpecificationGivenEvent": {
+            "type": "object",
+            "required": [
+                "id",
+                "eventId"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "eventId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "values": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            }
+        },
+        "SpecificationThenEvent": {
+            "type": "object",
+            "required": [
+                "id",
+                "eventId"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "eventId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "values": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            }
+        },
+        "SpecificationCommand": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "commandId": {
+                    "$ref": "#/$defs/Guid",
+                    "description": "Absent until a command has been chosen for the specification."
+                },
+                "name": {
+                    "type": "string"
+                },
+                "values": {
+                    "type": "object",
+                    "additionalProperties": true
+                }
+            }
+        },
+        "SpecificationReadModel": {
+            "type": "object",
+            "required": [
+                "id",
+                "readModelItemId"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "readModelItemId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                }
+            }
+        },
+        "SpecificationError": {
+            "type": "object",
+            "required": [
+                "id"
+            ],
+            "properties": {
+                "id": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "reference": {
+                    "$ref": "#/$defs/SpecificationErrorRuleReference"
+                }
+            }
+        },
+        "SpecificationErrorRuleReference": {
+            "type": "object",
+            "required": [
+                "kind",
+                "itemId"
+            ],
+            "properties": {
+                "kind": {
+                    "type": "integer",
+                    "description": "Which kind of rule the error comes from. Known values: 0 = commandValidationRule, 1 = eventUniqueConstraint, 2 = eventUniqueEventTypeConstraint. Any other integer is drawn as an explicit unknown."
+                },
+                "itemId": {
+                    "$ref": "#/$defs/Guid"
+                },
+                "propertyName": {
+                    "type": "string"
+                },
+                "ruleType": {
+                    "type": "string"
+                }
+            }
+        }
+    }
+}