@objectstack/spec 0.3.2 → 0.4.1

package/json-schema/automation/ConnectorInstance.json

@@ -0,0 +1,69 @@
+{
+  "$ref": "#/definitions/ConnectorInstance",
+  "definitions": {
+    "ConnectorInstance": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Instance ID"
+        },
+        "connectorId": {
+          "type": "string",
+          "description": "Connector ID"
+        },
+        "name": {
+          "type": "string",
+          "description": "Instance name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Instance description"
+        },
+        "credentials": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Encrypted credentials"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional config"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true,
+          "description": "Instance active status"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Creation time"
+        },
+        "lastTestedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Last test time"
+        },
+        "testStatus": {
+          "type": "string",
+          "enum": [
+            "unknown",
+            "success",
+            "failed"
+          ],
+          "default": "unknown",
+          "description": "Connection test status"
+        }
+      },
+      "required": [
+        "id",
+        "connectorId",
+        "name",
+        "credentials"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ConnectorOperation.json

@@ -0,0 +1,117 @@
+{
+  "$ref": "#/definitions/ConnectorOperation",
+  "definitions": {
+    "ConnectorOperation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Operation ID (snake_case)"
+        },
+        "name": {
+          "type": "string",
+          "description": "Operation name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Operation description"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "read",
+            "write",
+            "delete",
+            "search",
+            "trigger",
+            "action"
+          ],
+          "description": "Operation type"
+        },
+        "inputSchema": {
+          "type": "array",
+          "items": {
+            "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
+          },
+          "description": "Input parameters"
+        },
+        "outputSchema": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Output schema"
+        },
+        "sampleOutput": {
+          "description": "Sample output"
+        },
+        "supportsPagination": {
+          "type": "boolean",
+          "default": false,
+          "description": "Supports pagination"
+        },
+        "supportsFiltering": {
+          "type": "boolean",
+          "default": false,
+          "description": "Supports filtering"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/ConnectorTrigger.json

@@ -0,0 +1,54 @@
+{
+  "$ref": "#/definitions/ConnectorTrigger",
+  "definitions": {
+    "ConnectorTrigger": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Trigger ID (snake_case)"
+        },
+        "name": {
+          "type": "string",
+          "description": "Trigger name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Trigger description"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "webhook",
+            "polling",
+            "stream"
+          ],
+          "description": "Trigger mechanism"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Trigger configuration"
+        },
+        "outputSchema": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Event payload schema"
+        },
+        "pollingIntervalMs": {
+          "type": "integer",
+          "minimum": 1000,
+          "description": "Polling interval in ms"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/DataDestinationConfig.json

@@ -0,0 +1,89 @@
+{
+  "$ref": "#/definitions/DataDestinationConfig",
+  "definitions": {
+    "DataDestinationConfig": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "ObjectStack object name"
+        },
+        "connectorInstanceId": {
+          "type": "string",
+          "description": "Connector instance ID"
+        },
+        "operation": {
+          "type": "string",
+          "enum": [
+            "insert",
+            "update",
+            "upsert",
+            "delete",
+            "sync"
+          ],
+          "description": "Sync operation"
+        },
+        "mapping": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            {
+              "type": "array",
+              "items": {
+                "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
+              }
+            }
+          ],
+          "description": "Field mappings"
+        },
+        "externalResource": {
+          "type": "string",
+          "description": "External resource ID"
+        },
+        "matchKey": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Match key fields"
+        }
+      },
+      "required": [
+        "operation"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/automation/DataSourceConfig.json

@@ -0,0 +1,34 @@
+{
+  "$ref": "#/definitions/DataSourceConfig",
+  "definitions": {
+    "DataSourceConfig": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "ObjectStack object name"
+        },
+        "filters": {
+          "description": "Filter conditions"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to sync"
+        },
+        "connectorInstanceId": {
+          "type": "string",
+          "description": "Connector instance ID"
+        },
+        "externalResource": {
+          "type": "string",
+          "description": "External resource ID"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}