@objectstack/spec 0.3.3 → 0.4.1

package/json-schema/automation/ETLPipelineRun.json

@@ -0,0 +1,107 @@
+{
+  "$ref": "#/definitions/ETLPipelineRun",
+  "definitions": {
+    "ETLPipelineRun": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Run identifier"
+        },
+        "pipelineName": {
+          "type": "string",
+          "description": "Pipeline name"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "running",
+            "succeeded",
+            "failed",
+            "cancelled",
+            "timeout"
+          ],
+          "description": "Run status"
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Start time"
+        },
+        "completedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Completion time"
+        },
+        "durationMs": {
+          "type": "number",
+          "description": "Duration in ms"
+        },
+        "stats": {
+          "type": "object",
+          "properties": {
+            "recordsRead": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records extracted"
+            },
+            "recordsWritten": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records loaded"
+            },
+            "recordsErrored": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records with errors"
+            },
+            "bytesProcessed": {
+              "type": "integer",
+              "default": 0,
+              "description": "Bytes processed"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Run statistics"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "message": {
+              "type": "string",
+              "description": "Error message"
+            },
+            "code": {
+              "type": "string",
+              "description": "Error code"
+            },
+            "details": {
+              "description": "Error details"
+            }
+          },
+          "required": [
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error information"
+        },
+        "logs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Execution logs"
+        }
+      },
+      "required": [
+        "id",
+        "pipelineName",
+        "status",
+        "startedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ETLRunStatus.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/ETLRunStatus",
+  "definitions": {
+    "ETLRunStatus": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "running",
+        "succeeded",
+        "failed",
+        "cancelled",
+        "timeout"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ETLSource.json

@@ -0,0 +1,60 @@
+{
+  "$ref": "#/definitions/ETLSource",
+  "definitions": {
+    "ETLSource": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "database",
+            "api",
+            "file",
+            "stream",
+            "object",
+            "warehouse",
+            "storage",
+            "spreadsheet"
+          ],
+          "description": "Source type"
+        },
+        "connector": {
+          "type": "string",
+          "description": "Connector ID"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Source configuration"
+        },
+        "incremental": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "cursorField": {
+              "type": "string",
+              "description": "Field to track progress (e.g., updated_at)"
+            },
+            "cursorValue": {
+              "description": "Last processed value"
+            }
+          },
+          "required": [
+            "cursorField"
+          ],
+          "additionalProperties": false,
+          "description": "Incremental extraction config"
+        }
+      },
+      "required": [
+        "type",
+        "config"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ETLSyncMode.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/ETLSyncMode",
+  "definitions": {
+    "ETLSyncMode": {
+      "type": "string",
+      "enum": [
+        "full",
+        "incremental",
+        "cdc"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ETLTransformation.json

@@ -0,0 +1,46 @@
+{
+  "$ref": "#/definitions/ETLTransformation",
+  "definitions": {
+    "ETLTransformation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Transformation name"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "map",
+            "filter",
+            "aggregate",
+            "join",
+            "script",
+            "lookup",
+            "split",
+            "merge",
+            "normalize",
+            "deduplicate"
+          ],
+          "description": "Transformation type"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Transformation config"
+        },
+        "continueOnError": {
+          "type": "boolean",
+          "default": false,
+          "description": "Continue on error"
+        }
+      },
+      "required": [
+        "type",
+        "config"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ETLTransformationType.json

@@ -0,0 +1,21 @@
+{
+  "$ref": "#/definitions/ETLTransformationType",
+  "definitions": {
+    "ETLTransformationType": {
+      "type": "string",
+      "enum": [
+        "map",
+        "filter",
+        "aggregate",
+        "join",
+        "script",
+        "lookup",
+        "split",
+        "merge",
+        "normalize",
+        "deduplicate"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/FieldMapping.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/FieldMapping",
+  "definitions": {
+    "FieldMapping": {
+      "type": "object",
+      "properties": {
+        "sourceField": {
+          "type": "string",
+          "description": "Source field name"
+        },
+        "destinationField": {
+          "type": "string",
+          "description": "Destination field name"
+        },
+        "transform": {
+          "type": "string",
+          "description": "Transformation formula"
+        },
+        "default": {
+          "description": "Default value"
+        },
+        "syncNull": {
+          "type": "boolean",
+          "default": false,
+          "description": "Sync null values"
+        }
+      },
+      "required": [
+        "sourceField",
+        "destinationField"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/OAuth2Config.json

@@ -0,0 +1,43 @@
+{
+  "$ref": "#/definitions/OAuth2Config",
+  "definitions": {
+    "OAuth2Config": {
+      "type": "object",
+      "properties": {
+        "authorizationUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Authorization endpoint URL"
+        },
+        "tokenUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Token endpoint URL"
+        },
+        "scopes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "OAuth scopes"
+        },
+        "clientIdField": {
+          "type": "string",
+          "default": "client_id",
+          "description": "Client ID field name"
+        },
+        "clientSecretField": {
+          "type": "string",
+          "default": "client_secret",
+          "description": "Client secret field name"
+        }
+      },
+      "required": [
+        "authorizationUrl",
+        "tokenUrl"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/OperationParameter.json

@@ -0,0 +1,59 @@
+{
+  "$ref": "#/definitions/OperationParameter",
+  "definitions": {
+    "OperationParameter": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Parameter name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Parameter label"
+        },
+        "description": {
+          "type": "string",
+          "description": "Parameter description"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "string",
+            "number",
+            "boolean",
+            "array",
+            "object",
+            "date",
+            "file"
+          ],
+          "description": "Parameter type"
+        },
+        "required": {
+          "type": "boolean",
+          "default": false,
+          "description": "Required parameter"
+        },
+        "default": {
+          "description": "Default value"
+        },
+        "validation": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Validation rules"
+        },
+        "dynamicOptions": {
+          "type": "string",
+          "description": "Function to load dynamic options"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/OperationType.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/OperationType",
+  "definitions": {
+    "OperationType": {
+      "type": "string",
+      "enum": [
+        "read",
+        "write",
+        "delete",
+        "search",
+        "trigger",
+        "action"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/SyncDirection.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/SyncDirection",
+  "definitions": {
+    "SyncDirection": {
+      "type": "string",
+      "enum": [
+        "push",
+        "pull",
+        "bidirectional"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/SyncExecutionResult.json

@@ -0,0 +1,135 @@
+{
+  "$ref": "#/definitions/SyncExecutionResult",
+  "definitions": {
+    "SyncExecutionResult": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Execution ID"
+        },
+        "syncName": {
+          "type": "string",
+          "description": "Sync name"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "running",
+            "completed",
+            "partial",
+            "failed",
+            "cancelled"
+          ],
+          "description": "Execution status"
+        },
+        "startedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Start time"
+        },
+        "completedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Completion time"
+        },
+        "durationMs": {
+          "type": "number",
+          "description": "Duration in ms"
+        },
+        "stats": {
+          "type": "object",
+          "properties": {
+            "recordsProcessed": {
+              "type": "integer",
+              "default": 0,
+              "description": "Total records processed"
+            },
+            "recordsInserted": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records inserted"
+            },
+            "recordsUpdated": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records updated"
+            },
+            "recordsDeleted": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records deleted"
+            },
+            "recordsSkipped": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records skipped"
+            },
+            "recordsErrored": {
+              "type": "integer",
+              "default": 0,
+              "description": "Records with errors"
+            },
+            "conflictsDetected": {
+              "type": "integer",
+              "default": 0,
+              "description": "Conflicts detected"
+            },
+            "conflictsResolved": {
+              "type": "integer",
+              "default": 0,
+              "description": "Conflicts resolved"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Execution statistics"
+        },
+        "errors": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "recordId": {
+                "type": "string",
+                "description": "Record ID"
+              },
+              "field": {
+                "type": "string",
+                "description": "Field name"
+              },
+              "message": {
+                "type": "string",
+                "description": "Error message"
+              },
+              "code": {
+                "type": "string",
+                "description": "Error code"
+              }
+            },
+            "required": [
+              "message"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Errors"
+        },
+        "logs": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Execution logs"
+        }
+      },
+      "required": [
+        "id",
+        "syncName",
+        "status",
+        "startedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/SyncExecutionStatus.json

@@ -0,0 +1,17 @@
+{
+  "$ref": "#/definitions/SyncExecutionStatus",
+  "definitions": {
+    "SyncExecutionStatus": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "running",
+        "completed",
+        "partial",
+        "failed",
+        "cancelled"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/SyncMode.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/SyncMode",
+  "definitions": {
+    "SyncMode": {
+      "type": "string",
+      "enum": [
+        "full",
+        "incremental",
+        "realtime"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/Webhook.json

@@ -6,7 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Webhook unique name (lowercase snake_case)"
         },
         "label": {
           "type": "string"

package/json-schema/automation/WebhookReceiver.json

@@ -6,7 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Webhook receiver unique name (lowercase snake_case)"
         },
         "path": {
           "type": "string",

package/json-schema/automation/WorkflowRule.json

@@ -6,8 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$",
-          "description": "Unique workflow name"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Unique workflow name (lowercase snake_case)"
         },
         "objectName": {
           "type": "string",