@objectstack/spec 0.3.0 → 0.3.2

package/json-schema/ai/AIWorkflowAutomation.json

@@ -0,0 +1,379 @@
+{
+  "$ref": "#/definitions/AIWorkflowAutomation",
+  "definitions": {
+    "AIWorkflowAutomation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Workflow unique identifier (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Workflow display name"
+        },
+        "description": {
+          "type": "string"
+        },
+        "objectName": {
+          "type": "string",
+          "description": "Target object for this workflow"
+        },
+        "trigger": {
+          "type": "string",
+          "enum": [
+            "record_created",
+            "record_updated",
+            "field_changed",
+            "scheduled",
+            "manual",
+            "webhook",
+            "batch"
+          ]
+        },
+        "fieldConditions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string",
+                "description": "Field name to monitor"
+              },
+              "operator": {
+                "type": "string",
+                "enum": [
+                  "changed",
+                  "changed_to",
+                  "changed_from",
+                  "is",
+                  "is_not"
+                ],
+                "default": "changed"
+              },
+              "value": {
+                "description": "Value to compare against (for changed_to/changed_from/is/is_not)"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Fields to monitor (for field_changed trigger)"
+        },
+        "schedule": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "cron",
+                "interval",
+                "daily",
+                "weekly",
+                "monthly"
+              ],
+              "default": "cron"
+            },
+            "cron": {
+              "type": "string",
+              "description": "Cron expression (required if type is \"cron\")"
+            },
+            "interval": {
+              "type": "number",
+              "description": "Interval in minutes (required if type is \"interval\")"
+            },
+            "time": {
+              "type": "string",
+              "description": "Time of day for daily schedules (HH:MM format)"
+            },
+            "dayOfWeek": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 6,
+              "description": "Day of week for weekly (0=Sunday)"
+            },
+            "dayOfMonth": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 31,
+              "description": "Day of month for monthly"
+            },
+            "timezone": {
+              "type": "string",
+              "default": "UTC"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Schedule configuration (for scheduled trigger)"
+        },
+        "webhookConfig": {
+          "type": "object",
+          "properties": {
+            "secret": {
+              "type": "string",
+              "description": "Webhook verification secret"
+            },
+            "headers": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Expected headers"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Webhook configuration (for webhook trigger)"
+        },
+        "entryCriteria": {
+          "type": "string",
+          "description": "Formula condition - workflow only runs if TRUE"
+        },
+        "aiTasks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Optional task ID for referencing"
+              },
+              "name": {
+                "type": "string",
+                "description": "Human-readable task name"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "classify",
+                  "extract",
+                  "summarize",
+                  "generate",
+                  "predict",
+                  "translate",
+                  "sentiment",
+                  "entity_recognition",
+                  "anomaly_detection",
+                  "recommendation"
+                ]
+              },
+              "model": {
+                "type": "string",
+                "description": "Model ID from registry (uses default if not specified)"
+              },
+              "promptTemplate": {
+                "type": "string",
+                "description": "Prompt template ID for this task"
+              },
+              "inputFields": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Source fields to process (e.g., [\"description\", \"comments\"])"
+              },
+              "inputContext": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Additional context for the AI model"
+              },
+              "outputField": {
+                "type": "string",
+                "description": "Target field to store the result"
+              },
+              "outputFormat": {
+                "type": "string",
+                "enum": [
+                  "text",
+                  "json",
+                  "number",
+                  "boolean",
+                  "array"
+                ],
+                "default": "text"
+              },
+              "classes": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Valid classes for classification tasks"
+              },
+              "multiClass": {
+                "type": "boolean",
+                "default": false,
+                "description": "Allow multiple classes to be selected"
+              },
+              "extractionSchema": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "JSON schema for structured extraction"
+              },
+              "maxLength": {
+                "type": "number",
+                "description": "Maximum length for generated content"
+              },
+              "temperature": {
+                "type": "number",
+                "minimum": 0,
+                "maximum": 2,
+                "description": "Model temperature override"
+              },
+              "fallbackValue": {
+                "description": "Fallback value if AI task fails"
+              },
+              "retryAttempts": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 5,
+                "default": 1
+              },
+              "condition": {
+                "type": "string",
+                "description": "Formula condition - task only runs if TRUE"
+              },
+              "description": {
+                "type": "string"
+              },
+              "active": {
+                "type": "boolean",
+                "default": true
+              }
+            },
+            "required": [
+              "name",
+              "type",
+              "inputFields",
+              "outputField"
+            ],
+            "additionalProperties": false
+          },
+          "description": "AI tasks to execute in sequence"
+        },
+        "postActions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "field_update",
+                  "send_email",
+                  "create_record",
+                  "update_related",
+                  "trigger_flow",
+                  "webhook"
+                ]
+              },
+              "name": {
+                "type": "string",
+                "description": "Action name"
+              },
+              "config": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Action-specific configuration"
+              },
+              "condition": {
+                "type": "string",
+                "description": "Execute only if condition is TRUE"
+              }
+            },
+            "required": [
+              "type",
+              "name",
+              "config"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Actions after AI tasks complete"
+        },
+        "executionMode": {
+          "type": "string",
+          "enum": [
+            "sequential",
+            "parallel"
+          ],
+          "default": "sequential",
+          "description": "How to execute multiple AI tasks"
+        },
+        "stopOnError": {
+          "type": "boolean",
+          "default": false,
+          "description": "Stop workflow if any task fails"
+        },
+        "timeout": {
+          "type": "number",
+          "description": "Maximum execution time in seconds"
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "low",
+            "normal",
+            "high",
+            "critical"
+          ],
+          "default": "normal"
+        },
+        "enableLogging": {
+          "type": "boolean",
+          "default": true
+        },
+        "enableMetrics": {
+          "type": "boolean",
+          "default": true
+        },
+        "notifyOnFailure": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "User IDs to notify on failure"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "version": {
+          "type": "string",
+          "default": "1.0.0"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "category": {
+          "type": "string",
+          "description": "Workflow category (e.g., \"support\", \"sales\", \"hr\")"
+        },
+        "owner": {
+          "type": "string",
+          "description": "User ID of workflow owner"
+        },
+        "createdAt": {
+          "type": "string",
+          "description": "ISO timestamp"
+        },
+        "updatedAt": {
+          "type": "string",
+          "description": "ISO timestamp"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "objectName",
+        "trigger",
+        "aiTasks"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/AIWorkflowExecutionResult.json

@@ -0,0 +1,105 @@
+{
+  "$ref": "#/definitions/AIWorkflowExecutionResult",
+  "definitions": {
+    "AIWorkflowExecutionResult": {
+      "type": "object",
+      "properties": {
+        "workflowName": {
+          "type": "string"
+        },
+        "recordId": {
+          "type": "string"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "success",
+            "partial_success",
+            "failed",
+            "skipped"
+          ]
+        },
+        "executionTime": {
+          "type": "number",
+          "description": "Execution time in milliseconds"
+        },
+        "tasksExecuted": {
+          "type": "integer",
+          "description": "Number of tasks executed"
+        },
+        "tasksSucceeded": {
+          "type": "integer",
+          "description": "Number of tasks succeeded"
+        },
+        "tasksFailed": {
+          "type": "integer",
+          "description": "Number of tasks failed"
+        },
+        "taskResults": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "taskId": {
+                "type": "string"
+              },
+              "taskName": {
+                "type": "string"
+              },
+              "status": {
+                "type": "string",
+                "enum": [
+                  "success",
+                  "failed",
+                  "skipped"
+                ]
+              },
+              "output": {},
+              "error": {
+                "type": "string"
+              },
+              "executionTime": {
+                "type": "number",
+                "description": "Task execution time in milliseconds"
+              },
+              "modelUsed": {
+                "type": "string"
+              },
+              "tokensUsed": {
+                "type": "number"
+              }
+            },
+            "required": [
+              "taskName",
+              "status"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "error": {
+          "type": "string"
+        },
+        "startedAt": {
+          "type": "string",
+          "description": "ISO timestamp"
+        },
+        "completedAt": {
+          "type": "string",
+          "description": "ISO timestamp"
+        }
+      },
+      "required": [
+        "workflowName",
+        "recordId",
+        "status",
+        "executionTime",
+        "tasksExecuted",
+        "tasksSucceeded",
+        "tasksFailed",
+        "startedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/AIWorkflowTrigger.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/AIWorkflowTrigger",
+  "definitions": {
+    "AIWorkflowTrigger": {
+      "type": "string",
+      "enum": [
+        "record_created",
+        "record_updated",
+        "field_changed",
+        "scheduled",
+        "manual",
+        "webhook",
+        "batch"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/BatchAIWorkflowExecution.json

@@ -0,0 +1,48 @@
+{
+  "$ref": "#/definitions/BatchAIWorkflowExecution",
+  "definitions": {
+    "BatchAIWorkflowExecution": {
+      "type": "object",
+      "properties": {
+        "workflowName": {
+          "type": "string",
+          "description": "Workflow to execute"
+        },
+        "recordIds": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Records to process"
+        },
+        "batchSize": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 1000,
+          "default": 10
+        },
+        "parallelism": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10,
+          "default": 3
+        },
+        "priority": {
+          "type": "string",
+          "enum": [
+            "low",
+            "normal",
+            "high"
+          ],
+          "default": "normal"
+        }
+      },
+      "required": [
+        "workflowName",
+        "recordIds"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/BillingPeriod.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/BillingPeriod",
+  "definitions": {
+    "BillingPeriod": {
+      "type": "string",
+      "enum": [
+        "hourly",
+        "daily",
+        "weekly",
+        "monthly",
+        "quarterly",
+        "yearly",
+        "custom"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ai/BudgetLimit.json

@@ -0,0 +1,111 @@
+{
+  "$ref": "#/definitions/BudgetLimit",
+  "definitions": {
+    "BudgetLimit": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "global",
+            "user",
+            "agent",
+            "object",
+            "project",
+            "department"
+          ]
+        },
+        "scope": {
+          "type": "string",
+          "description": "Scope identifier (userId, agentId, etc.)"
+        },
+        "maxCost": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Maximum cost limit"
+        },
+        "currency": {
+          "type": "string",
+          "default": "USD"
+        },
+        "period": {
+          "type": "string",
+          "enum": [
+            "hourly",
+            "daily",
+            "weekly",
+            "monthly",
+            "quarterly",
+            "yearly",
+            "custom"
+          ]
+        },
+        "customPeriodDays": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "description": "Custom period in days"
+        },
+        "softLimit": {
+          "type": "number",
+          "minimum": 0,
+          "description": "Soft limit for warnings"
+        },
+        "warnThresholds": {
+          "type": "array",
+          "items": {
+            "type": "number",
+            "minimum": 0,
+            "maximum": 1
+          },
+          "description": "Warning thresholds (e.g., [0.5, 0.8, 0.95])"
+        },
+        "enforced": {
+          "type": "boolean",
+          "default": true,
+          "description": "Block requests when exceeded"
+        },
+        "gracePeriodSeconds": {
+          "type": "integer",
+          "minimum": 0,
+          "default": 0,
+          "description": "Grace period after limit exceeded"
+        },
+        "allowRollover": {
+          "type": "boolean",
+          "default": false,
+          "description": "Allow unused budget to rollover"
+        },
+        "maxRolloverPercentage": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1,
+          "description": "Max rollover as % of limit"
+        },
+        "name": {
+          "type": "string",
+          "description": "Budget name"
+        },
+        "description": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "type",
+        "maxCost",
+        "period"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}