@objectstack/spec 0.7.1 → 0.7.2

package/json-schema/system/EventLogEntry.json

@@ -0,0 +1,153 @@
+{
+  "$ref": "#/definitions/EventLogEntry",
+  "definitions": {
+    "EventLogEntry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique log entry identifier"
+        },
+        "event": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "Unique event identifier"
+            },
+            "name": {
+              "type": "string",
+              "minLength": 3,
+              "pattern": "^[a-z][a-z0-9_.]*$",
+              "description": "Event name (lowercase with dots, e.g., user.created, order.paid)"
+            },
+            "payload": {
+              "description": "Event payload schema"
+            },
+            "metadata": {
+              "type": "object",
+              "properties": {
+                "source": {
+                  "type": "string",
+                  "description": "Event source (e.g., plugin name, system component)"
+                },
+                "timestamp": {
+                  "type": "string",
+                  "format": "date-time",
+                  "description": "ISO 8601 datetime when event was created"
+                },
+                "userId": {
+                  "type": "string",
+                  "description": "User who triggered the event"
+                },
+                "tenantId": {
+                  "type": "string",
+                  "description": "Tenant identifier for multi-tenant systems"
+                },
+                "correlationId": {
+                  "type": "string",
+                  "description": "Correlation ID for event tracing"
+                },
+                "causationId": {
+                  "type": "string",
+                  "description": "ID of the event that caused this event"
+                },
+                "priority": {
+                  "type": "string",
+                  "enum": [
+                    "critical",
+                    "high",
+                    "normal",
+                    "low",
+                    "background"
+                  ],
+                  "default": "normal",
+                  "description": "Event priority"
+                }
+              },
+              "required": [
+                "source",
+                "timestamp"
+              ],
+              "additionalProperties": false,
+              "description": "Event metadata"
+            }
+          },
+          "required": [
+            "name",
+            "metadata"
+          ],
+          "additionalProperties": false,
+          "description": "The event"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "processing",
+            "completed",
+            "failed"
+          ],
+          "description": "Processing status"
+        },
+        "handlersExecuted": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "handlerId": {
+                "type": "string",
+                "description": "Handler identifier"
+              },
+              "status": {
+                "type": "string",
+                "enum": [
+                  "success",
+                  "failed",
+                  "timeout"
+                ],
+                "description": "Handler execution status"
+              },
+              "durationMs": {
+                "type": "integer",
+                "description": "Execution duration"
+              },
+              "error": {
+                "type": "string",
+                "description": "Error message if failed"
+              }
+            },
+            "required": [
+              "handlerId",
+              "status"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Handlers that processed this event"
+        },
+        "receivedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When event was received"
+        },
+        "processedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When event was processed"
+        },
+        "totalDurationMs": {
+          "type": "integer",
+          "description": "Total processing time"
+        }
+      },
+      "required": [
+        "id",
+        "event",
+        "status",
+        "receivedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventMessageQueueConfig.json

@@ -0,0 +1,79 @@
+{
+  "$ref": "#/definitions/EventMessageQueueConfig",
+  "definitions": {
+    "EventMessageQueueConfig": {
+      "type": "object",
+      "properties": {
+        "provider": {
+          "type": "string",
+          "enum": [
+            "kafka",
+            "rabbitmq",
+            "aws-sqs",
+            "redis-pubsub",
+            "google-pubsub",
+            "azure-service-bus"
+          ],
+          "description": "Message queue provider"
+        },
+        "topic": {
+          "type": "string",
+          "description": "Topic or queue name"
+        },
+        "eventPattern": {
+          "type": "string",
+          "default": "*",
+          "description": "Event name pattern to publish (supports wildcards)"
+        },
+        "partitionKey": {
+          "type": "string",
+          "description": "JSON path for partition key (e.g., \"metadata.tenantId\")"
+        },
+        "format": {
+          "type": "string",
+          "enum": [
+            "json",
+            "avro",
+            "protobuf"
+          ],
+          "default": "json",
+          "description": "Message serialization format"
+        },
+        "includeMetadata": {
+          "type": "boolean",
+          "default": true,
+          "description": "Include event metadata in message"
+        },
+        "compression": {
+          "type": "string",
+          "enum": [
+            "none",
+            "gzip",
+            "snappy",
+            "lz4"
+          ],
+          "default": "none",
+          "description": "Message compression"
+        },
+        "batchSize": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 1,
+          "description": "Batch size for publishing"
+        },
+        "flushIntervalMs": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 1000,
+          "description": "Flush interval for batching"
+        }
+      },
+      "required": [
+        "provider",
+        "topic"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventMetadata.json

@@ -20,6 +20,26 @@
         "tenantId": {
           "type": "string",
           "description": "Tenant identifier for multi-tenant systems"
+        },
+        "correlationId": {
+          "type": "string",
+          "description": "Correlation ID for event tracing"
+        },
+        "causationId": {
+          "type": "string",
+          "description": "ID of the event that caused this event"
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "critical",
+            "high",
+            "normal",
+            "low",
+            "background"
+          ],
+          "default": "normal",
+          "description": "Event priority"
         }
       },
       "required": [

package/json-schema/system/EventPersistence.json

@@ -13,6 +13,17 @@
           "type": "integer",
           "exclusiveMinimum": 0,
           "description": "Days to retain persisted events"
+        },
+        "storage": {
+          "type": "string",
+          "enum": [
+            "database",
+            "file",
+            "s3",
+            "custom"
+          ],
+          "default": "database",
+          "description": "Storage backend for persisted events"
         }
       },
       "required": [

package/json-schema/system/EventPriority.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/EventPriority",
+  "definitions": {
+    "EventPriority": {
+      "type": "string",
+      "enum": [
+        "critical",
+        "high",
+        "normal",
+        "low",
+        "background"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventQueueConfig.json

@@ -0,0 +1,67 @@
+{
+  "$ref": "#/definitions/EventQueueConfig",
+  "definitions": {
+    "EventQueueConfig": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "default": "events",
+          "description": "Event queue name"
+        },
+        "concurrency": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 10,
+          "description": "Max concurrent event handlers"
+        },
+        "retryPolicy": {
+          "type": "object",
+          "properties": {
+            "maxRetries": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 3,
+              "description": "Max retries for failed events"
+            },
+            "backoffStrategy": {
+              "type": "string",
+              "enum": [
+                "fixed",
+                "linear",
+                "exponential"
+              ],
+              "default": "exponential",
+              "description": "Backoff strategy"
+            },
+            "initialDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1000,
+              "description": "Initial retry delay"
+            },
+            "maxDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 60000,
+              "description": "Maximum retry delay"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Default retry policy for events"
+        },
+        "deadLetterQueue": {
+          "type": "string",
+          "description": "Dead letter queue name for failed events"
+        },
+        "priorityEnabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Process events based on priority"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventReplayConfig.json

@@ -0,0 +1,50 @@
+{
+  "$ref": "#/definitions/EventReplayConfig",
+  "definitions": {
+    "EventReplayConfig": {
+      "type": "object",
+      "properties": {
+        "fromTimestamp": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Start timestamp for replay (ISO 8601)"
+        },
+        "toTimestamp": {
+          "type": "string",
+          "format": "date-time",
+          "description": "End timestamp for replay (ISO 8601)"
+        },
+        "eventTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Event types to replay (empty = all)"
+        },
+        "filters": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional filters for event selection"
+        },
+        "speed": {
+          "type": "number",
+          "exclusiveMinimum": 0,
+          "default": 1,
+          "description": "Replay speed multiplier (1 = real-time)"
+        },
+        "targetHandlers": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Handler IDs to execute (empty = all)"
+        }
+      },
+      "required": [
+        "fromTimestamp"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventSourcingConfig.json

@@ -0,0 +1,65 @@
+{
+  "$ref": "#/definitions/EventSourcingConfig",
+  "definitions": {
+    "EventSourcingConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable event sourcing"
+        },
+        "snapshotInterval": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 100,
+          "description": "Create snapshot every N events"
+        },
+        "snapshotRetention": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 10,
+          "description": "Number of snapshots to retain"
+        },
+        "retention": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 365,
+          "description": "Days to retain events"
+        },
+        "aggregateTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Aggregate types to enable event sourcing for"
+        },
+        "storage": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "database",
+                "file",
+                "s3",
+                "eventstore"
+              ],
+              "default": "database",
+              "description": "Storage backend"
+            },
+            "options": {
+              "type": "object",
+              "additionalProperties": {},
+              "description": "Storage-specific options"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Event store configuration"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventTypeDefinition.json

@@ -0,0 +1,45 @@
+{
+  "$ref": "#/definitions/EventTypeDefinition",
+  "definitions": {
+    "EventTypeDefinition": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "minLength": 3,
+          "pattern": "^[a-z][a-z0-9_.]*$",
+          "description": "Event type name (lowercase with dots)"
+        },
+        "version": {
+          "type": "string",
+          "default": "1.0.0",
+          "description": "Event schema version"
+        },
+        "schema": {
+          "description": "JSON Schema for event payload validation"
+        },
+        "description": {
+          "type": "string",
+          "description": "Event type description"
+        },
+        "deprecated": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether this event type is deprecated"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Event type tags"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/EventWebhookConfig.json

@@ -0,0 +1,119 @@
+{
+  "$ref": "#/definitions/EventWebhookConfig",
+  "definitions": {
+    "EventWebhookConfig": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique webhook identifier"
+        },
+        "eventPattern": {
+          "type": "string",
+          "description": "Event name pattern (supports wildcards)"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "Webhook endpoint URL"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH"
+          ],
+          "default": "POST",
+          "description": "HTTP method"
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "HTTP headers"
+        },
+        "authentication": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "none",
+                "bearer",
+                "basic",
+                "api-key"
+              ],
+              "description": "Auth type"
+            },
+            "credentials": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Auth credentials"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "description": "Authentication configuration"
+        },
+        "retryPolicy": {
+          "type": "object",
+          "properties": {
+            "maxRetries": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 3,
+              "description": "Max retry attempts"
+            },
+            "backoffStrategy": {
+              "type": "string",
+              "enum": [
+                "fixed",
+                "linear",
+                "exponential"
+              ],
+              "default": "exponential"
+            },
+            "initialDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1000,
+              "description": "Initial retry delay"
+            },
+            "maxDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 60000,
+              "description": "Max retry delay"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Retry policy"
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 30000,
+          "description": "Request timeout in milliseconds"
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether webhook is enabled"
+        }
+      },
+      "required": [
+        "eventPattern",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}