@objectstack/spec 0.7.1 → 0.7.2

package/json-schema/api/RealtimeConfig.json

@@ -0,0 +1,90 @@
+{
+  "$ref": "#/definitions/RealtimeConfig",
+  "definitions": {
+    "RealtimeConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable realtime synchronization"
+        },
+        "transport": {
+          "type": "string",
+          "enum": [
+            "websocket",
+            "sse",
+            "polling"
+          ],
+          "default": "websocket",
+          "description": "Transport protocol"
+        },
+        "subscriptions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "format": "uuid",
+                "description": "Unique subscription identifier"
+              },
+              "events": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "enum": [
+                        "record.created",
+                        "record.updated",
+                        "record.deleted",
+                        "field.changed"
+                      ],
+                      "description": "Type of event to subscribe to"
+                    },
+                    "object": {
+                      "type": "string",
+                      "description": "Object name to subscribe to"
+                    },
+                    "filters": {
+                      "description": "Filter conditions"
+                    }
+                  },
+                  "required": [
+                    "type"
+                  ],
+                  "additionalProperties": false
+                },
+                "description": "Array of events to subscribe to"
+              },
+              "transport": {
+                "type": "string",
+                "enum": [
+                  "websocket",
+                  "sse",
+                  "polling"
+                ],
+                "description": "Transport protocol to use"
+              },
+              "channel": {
+                "type": "string",
+                "description": "Optional channel name for grouping subscriptions"
+              }
+            },
+            "required": [
+              "id",
+              "events",
+              "transport"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Default subscriptions"
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/Object.json

@@ -913,7 +913,10 @@
             ],
             "additionalProperties": false
           },
-          "description": "Field definitions map"
+          "propertyNames": {
+            "pattern": "^[a-z_][a-z0-9_]*$"
+          },
+          "description": "Field definitions map. Keys must be snake_case identifiers."
         },
         "indexes": {
           "type": "array",

package/json-schema/system/BatchProgress.json

@@ -0,0 +1,72 @@
+{
+  "$ref": "#/definitions/BatchProgress",
+  "definitions": {
+    "BatchProgress": {
+      "type": "object",
+      "properties": {
+        "batchId": {
+          "type": "string",
+          "description": "Batch job identifier"
+        },
+        "total": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Total number of items"
+        },
+        "processed": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Items processed"
+        },
+        "succeeded": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Items succeeded"
+        },
+        "failed": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Items failed"
+        },
+        "percentage": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 100,
+          "description": "Progress percentage"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "running",
+            "completed",
+            "failed",
+            "cancelled"
+          ],
+          "description": "Batch status"
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When batch started"
+        },
+        "completedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When batch completed"
+        }
+      },
+      "required": [
+        "batchId",
+        "total",
+        "percentage",
+        "status"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/BatchTask.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/BatchTask",
+  "definitions": {
+    "BatchTask": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique batch job identifier"
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Task type (snake_case)"
+        },
+        "items": {
+          "type": "array",
+          "description": "Array of items to process"
+        },
+        "batchSize": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 100,
+          "description": "Number of items per batch"
+        },
+        "queue": {
+          "type": "string",
+          "default": "batch",
+          "description": "Queue for batch tasks"
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "critical",
+            "high",
+            "normal",
+            "low",
+            "background"
+          ],
+          "default": "normal",
+          "description": "Batch task priority"
+        },
+        "parallel": {
+          "type": "boolean",
+          "default": true,
+          "description": "Process batches in parallel"
+        },
+        "stopOnError": {
+          "type": "boolean",
+          "default": false,
+          "description": "Stop batch if any item fails"
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "items"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/DeadLetterQueueEntry.json

@@ -0,0 +1,137 @@
+{
+  "$ref": "#/definitions/DeadLetterQueueEntry",
+  "definitions": {
+    "DeadLetterQueueEntry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique 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": "Original event"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string",
+              "description": "Error message"
+            },
+            "stack": {
+              "type": "string",
+              "description": "Error stack trace"
+            },
+            "code": {
+              "type": "string",
+              "description": "Error code"
+            }
+          },
+          "required": [
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Failure details"
+        },
+        "retries": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Number of retry attempts"
+        },
+        "firstFailedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When event first failed"
+        },
+        "lastFailedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When event last failed"
+        },
+        "failedHandler": {
+          "type": "string",
+          "description": "Handler ID that failed"
+        }
+      },
+      "required": [
+        "id",
+        "event",
+        "error",
+        "retries",
+        "firstFailedAt",
+        "lastFailedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/Event.json

@@ -4,6 +4,10 @@
     "Event": {
       "type": "object",
       "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique event identifier"
+        },
         "name": {
           "type": "string",
           "minLength": 3,
@@ -32,6 +36,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": [