@objectstack/spec 0.7.1 → 0.7.2

package/json-schema/system/QueueConfig.json

@@ -0,0 +1,133 @@
+{
+  "$ref": "#/definitions/QueueConfig",
+  "definitions": {
+    "QueueConfig": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Queue name (snake_case)"
+        },
+        "concurrency": {
+          "type": "integer",
+          "minimum": 1,
+          "default": 5,
+          "description": "Max concurrent task executions"
+        },
+        "rateLimit": {
+          "type": "object",
+          "properties": {
+            "max": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "description": "Maximum tasks per duration"
+            },
+            "duration": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "description": "Duration in milliseconds"
+            }
+          },
+          "required": [
+            "max",
+            "duration"
+          ],
+          "additionalProperties": false,
+          "description": "Rate limit configuration"
+        },
+        "defaultRetryPolicy": {
+          "type": "object",
+          "properties": {
+            "maxRetries": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 3,
+              "description": "Maximum retry attempts"
+            },
+            "backoffStrategy": {
+              "type": "string",
+              "enum": [
+                "fixed",
+                "linear",
+                "exponential"
+              ],
+              "default": "exponential",
+              "description": "Backoff strategy between retries"
+            },
+            "initialDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1000,
+              "description": "Initial retry delay in milliseconds"
+            },
+            "maxDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 60000,
+              "description": "Maximum retry delay in milliseconds"
+            },
+            "backoffMultiplier": {
+              "type": "number",
+              "exclusiveMinimum": 0,
+              "default": 2,
+              "description": "Multiplier for exponential backoff"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Default retry policy for tasks"
+        },
+        "deadLetterQueue": {
+          "type": "string",
+          "description": "Dead letter queue name"
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Queue priority (lower = higher priority)"
+        },
+        "autoScale": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false,
+              "description": "Enable auto-scaling"
+            },
+            "minWorkers": {
+              "type": "integer",
+              "minimum": 1,
+              "default": 1,
+              "description": "Minimum workers"
+            },
+            "maxWorkers": {
+              "type": "integer",
+              "minimum": 1,
+              "default": 10,
+              "description": "Maximum workers"
+            },
+            "scaleUpThreshold": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 100,
+              "description": "Queue size to scale up"
+            },
+            "scaleDownThreshold": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 10,
+              "description": "Queue size to scale down"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Auto-scaling configuration"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/RealTimeNotificationConfig.json

@@ -0,0 +1,85 @@
+{
+  "$ref": "#/definitions/RealTimeNotificationConfig",
+  "definitions": {
+    "RealTimeNotificationConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable real-time notifications"
+        },
+        "protocol": {
+          "type": "string",
+          "enum": [
+            "websocket",
+            "sse",
+            "long-polling"
+          ],
+          "default": "websocket",
+          "description": "Real-time protocol"
+        },
+        "eventPattern": {
+          "type": "string",
+          "default": "*",
+          "description": "Event pattern to broadcast"
+        },
+        "userFilter": {
+          "type": "boolean",
+          "default": true,
+          "description": "Filter events by user"
+        },
+        "tenantFilter": {
+          "type": "boolean",
+          "default": true,
+          "description": "Filter events by tenant"
+        },
+        "channels": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Channel name"
+              },
+              "eventPattern": {
+                "type": "string",
+                "description": "Event pattern for channel"
+              }
+            },
+            "required": [
+              "name",
+              "eventPattern"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Named channels for event broadcasting"
+        },
+        "rateLimit": {
+          "type": "object",
+          "properties": {
+            "maxEventsPerSecond": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "description": "Max events per second per client"
+            },
+            "windowMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1000,
+              "description": "Rate limit window"
+            }
+          },
+          "required": [
+            "maxEventsPerSecond"
+          ],
+          "additionalProperties": false,
+          "description": "Rate limiting configuration"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/Task.json

@@ -0,0 +1,145 @@
+{
+  "$ref": "#/definitions/Task",
+  "definitions": {
+    "Task": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique task identifier"
+        },
+        "type": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Task type (snake_case)"
+        },
+        "payload": {
+          "description": "Task payload data"
+        },
+        "queue": {
+          "type": "string",
+          "default": "default",
+          "description": "Queue name"
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "critical",
+            "high",
+            "normal",
+            "low",
+            "background"
+          ],
+          "default": "normal",
+          "description": "Task priority level"
+        },
+        "retryPolicy": {
+          "type": "object",
+          "properties": {
+            "maxRetries": {
+              "type": "integer",
+              "minimum": 0,
+              "default": 3,
+              "description": "Maximum retry attempts"
+            },
+            "backoffStrategy": {
+              "type": "string",
+              "enum": [
+                "fixed",
+                "linear",
+                "exponential"
+              ],
+              "default": "exponential",
+              "description": "Backoff strategy between retries"
+            },
+            "initialDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 1000,
+              "description": "Initial retry delay in milliseconds"
+            },
+            "maxDelayMs": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 60000,
+              "description": "Maximum retry delay in milliseconds"
+            },
+            "backoffMultiplier": {
+              "type": "number",
+              "exclusiveMinimum": 0,
+              "default": 2,
+              "description": "Multiplier for exponential backoff"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Retry policy configuration"
+        },
+        "timeoutMs": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "description": "Task timeout in milliseconds"
+        },
+        "scheduledAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "ISO 8601 datetime to execute task"
+        },
+        "attempts": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Number of execution attempts"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "queued",
+            "processing",
+            "completed",
+            "failed",
+            "cancelled",
+            "timeout",
+            "dead"
+          ],
+          "default": "pending",
+          "description": "Current task status"
+        },
+        "metadata": {
+          "type": "object",
+          "properties": {
+            "createdAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "When task was created"
+            },
+            "updatedAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "Last update time"
+            },
+            "createdBy": {
+              "type": "string",
+              "description": "User who created task"
+            },
+            "tags": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Task tags for filtering"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Task metadata"
+        }
+      },
+      "required": [
+        "id",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/TaskExecutionResult.json

@@ -0,0 +1,85 @@
+{
+  "$ref": "#/definitions/TaskExecutionResult",
+  "definitions": {
+    "TaskExecutionResult": {
+      "type": "object",
+      "properties": {
+        "taskId": {
+          "type": "string",
+          "description": "Task identifier"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "queued",
+            "processing",
+            "completed",
+            "failed",
+            "cancelled",
+            "timeout",
+            "dead"
+          ],
+          "description": "Execution status"
+        },
+        "result": {
+          "description": "Execution result data"
+        },
+        "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": "Error details if failed"
+        },
+        "durationMs": {
+          "type": "integer",
+          "description": "Execution duration in milliseconds"
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When execution started"
+        },
+        "completedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When execution completed"
+        },
+        "attempt": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "Attempt number (1-indexed)"
+        },
+        "willRetry": {
+          "type": "boolean",
+          "description": "Whether task will be retried"
+        }
+      },
+      "required": [
+        "taskId",
+        "status",
+        "startedAt",
+        "attempt",
+        "willRetry"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/TaskPriority.json

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

package/json-schema/system/TaskRetryPolicy.json

@@ -0,0 +1,46 @@
+{
+  "$ref": "#/definitions/TaskRetryPolicy",
+  "definitions": {
+    "TaskRetryPolicy": {
+      "type": "object",
+      "properties": {
+        "maxRetries": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 3,
+          "description": "Maximum retry attempts"
+        },
+        "backoffStrategy": {
+          "type": "string",
+          "enum": [
+            "fixed",
+            "linear",
+            "exponential"
+          ],
+          "default": "exponential",
+          "description": "Backoff strategy between retries"
+        },
+        "initialDelayMs": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 1000,
+          "description": "Initial retry delay in milliseconds"
+        },
+        "maxDelayMs": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 60000,
+          "description": "Maximum retry delay in milliseconds"
+        },
+        "backoffMultiplier": {
+          "type": "number",
+          "exclusiveMinimum": 0,
+          "default": 2,
+          "description": "Multiplier for exponential backoff"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/system/TaskStatus.json

@@ -0,0 +1,19 @@
+{
+  "$ref": "#/definitions/TaskStatus",
+  "definitions": {
+    "TaskStatus": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "queued",
+        "processing",
+        "completed",
+        "failed",
+        "cancelled",
+        "timeout",
+        "dead"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}