@objectstack/spec 0.6.1 → 0.7.2

package/json-schema/integration/SaasObjectType.json

@@ -0,0 +1,218 @@
+{
+  "$ref": "#/definitions/SaasObjectType",
+  "definitions": {
+    "SaasObjectType": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Object type name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "apiName": {
+          "type": "string",
+          "description": "API name in external system"
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable sync for this object"
+        },
+        "supportsCreate": {
+          "type": "boolean",
+          "default": true,
+          "description": "Supports record creation"
+        },
+        "supportsUpdate": {
+          "type": "boolean",
+          "default": true,
+          "description": "Supports record updates"
+        },
+        "supportsDelete": {
+          "type": "boolean",
+          "default": true,
+          "description": "Supports record deletion"
+        },
+        "fieldMappings": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "source": {
+                "type": "string",
+                "description": "Source field name"
+              },
+              "target": {
+                "type": "string",
+                "description": "Target field name"
+              },
+              "transform": {
+                "anyOf": [
+                  {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "const": "constant"
+                      },
+                      "value": {
+                        "description": "Constant value to use"
+                      }
+                    },
+                    "required": [
+                      "type"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Set a constant value"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "const": "cast"
+                      },
+                      "targetType": {
+                        "type": "string",
+                        "enum": [
+                          "string",
+                          "number",
+                          "boolean",
+                          "date"
+                        ],
+                        "description": "Target data type"
+                      }
+                    },
+                    "required": [
+                      "type",
+                      "targetType"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Cast to a specific data type"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "const": "lookup"
+                      },
+                      "table": {
+                        "type": "string",
+                        "description": "Lookup table name"
+                      },
+                      "keyField": {
+                        "type": "string",
+                        "description": "Field to match on"
+                      },
+                      "valueField": {
+                        "type": "string",
+                        "description": "Field to retrieve"
+                      }
+                    },
+                    "required": [
+                      "type",
+                      "table",
+                      "keyField",
+                      "valueField"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Lookup value from another table"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "const": "javascript"
+                      },
+                      "expression": {
+                        "type": "string",
+                        "description": "JavaScript expression (e.g., \"value.toUpperCase()\")"
+                      }
+                    },
+                    "required": [
+                      "type",
+                      "expression"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Custom JavaScript transformation"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "const": "map"
+                      },
+                      "mappings": {
+                        "type": "object",
+                        "additionalProperties": {},
+                        "description": "Value mappings (e.g., {\"Active\": \"active\"})"
+                      }
+                    },
+                    "required": [
+                      "type",
+                      "mappings"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Map values using a dictionary"
+                  }
+                ],
+                "description": "Transformation to apply"
+              },
+              "defaultValue": {
+                "description": "Default if source is null/undefined"
+              },
+              "dataType": {
+                "type": "string",
+                "enum": [
+                  "string",
+                  "number",
+                  "boolean",
+                  "date",
+                  "datetime",
+                  "json",
+                  "array"
+                ],
+                "description": "Target data type"
+              },
+              "required": {
+                "type": "boolean",
+                "default": false,
+                "description": "Field is required"
+              },
+              "syncMode": {
+                "type": "string",
+                "enum": [
+                  "read_only",
+                  "write_only",
+                  "bidirectional"
+                ],
+                "default": "bidirectional",
+                "description": "Sync mode"
+              }
+            },
+            "required": [
+              "source",
+              "target"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Object-specific field mappings"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "apiName"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/SaasProvider.json

@@ -0,0 +1,24 @@
+{
+  "$ref": "#/definitions/SaasProvider",
+  "definitions": {
+    "SaasProvider": {
+      "type": "string",
+      "enum": [
+        "salesforce",
+        "hubspot",
+        "stripe",
+        "shopify",
+        "zendesk",
+        "intercom",
+        "mailchimp",
+        "slack",
+        "microsoft_dynamics",
+        "servicenow",
+        "netsuite",
+        "custom"
+      ],
+      "description": "SaaS provider type"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/SslConfig.json

@@ -0,0 +1,34 @@
+{
+  "$ref": "#/definitions/SslConfig",
+  "definitions": {
+    "SslConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable SSL/TLS"
+        },
+        "rejectUnauthorized": {
+          "type": "boolean",
+          "default": true,
+          "description": "Reject unauthorized certificates"
+        },
+        "ca": {
+          "type": "string",
+          "description": "Certificate Authority certificate"
+        },
+        "cert": {
+          "type": "string",
+          "description": "Client certificate"
+        },
+        "key": {
+          "type": "string",
+          "description": "Client private key"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/StorageBucket.json

@@ -0,0 +1,99 @@
+{
+  "$ref": "#/definitions/StorageBucket",
+  "definitions": {
+    "StorageBucket": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Bucket identifier in ObjectStack (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "bucketName": {
+          "type": "string",
+          "description": "Actual bucket/container name in storage system"
+        },
+        "region": {
+          "type": "string",
+          "description": "Storage region"
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable sync for this bucket"
+        },
+        "prefix": {
+          "type": "string",
+          "description": "Prefix/path within bucket"
+        },
+        "accessPattern": {
+          "type": "string",
+          "enum": [
+            "public_read",
+            "private",
+            "authenticated_read",
+            "bucket_owner_read",
+            "bucket_owner_full"
+          ],
+          "description": "Access pattern"
+        },
+        "fileFilters": {
+          "type": "object",
+          "properties": {
+            "includePatterns": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "File patterns to include (glob)"
+            },
+            "excludePatterns": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "File patterns to exclude (glob)"
+            },
+            "minFileSize": {
+              "type": "number",
+              "minimum": 0,
+              "description": "Minimum file size in bytes"
+            },
+            "maxFileSize": {
+              "type": "number",
+              "minimum": 1,
+              "description": "Maximum file size in bytes"
+            },
+            "allowedExtensions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Allowed file extensions"
+            },
+            "blockedExtensions": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Blocked file extensions"
+            }
+          },
+          "additionalProperties": false,
+          "description": "File filter configuration"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "bucketName"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/SyncStrategy.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/SyncStrategy",
+  "definitions": {
+    "SyncStrategy": {
+      "type": "string",
+      "enum": [
+        "full",
+        "incremental",
+        "upsert",
+        "append_only"
+      ],
+      "description": "Synchronization strategy"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/integration/TopicQueue.json

@@ -0,0 +1,252 @@
+{
+  "$ref": "#/definitions/TopicQueue",
+  "definitions": {
+    "TopicQueue": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Topic/queue identifier in ObjectStack (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "topicName": {
+          "type": "string",
+          "description": "Actual topic/queue name in message queue system"
+        },
+        "enabled": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable sync for this topic/queue"
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "consumer",
+            "producer",
+            "both"
+          ],
+          "default": "both",
+          "description": "Consumer, producer, or both"
+        },
+        "messageFormat": {
+          "type": "string",
+          "enum": [
+            "json",
+            "xml",
+            "protobuf",
+            "avro",
+            "text",
+            "binary"
+          ],
+          "description": "Message format/serialization",
+          "default": "json"
+        },
+        "partitions": {
+          "type": "number",
+          "minimum": 1,
+          "description": "Number of partitions (for Kafka)"
+        },
+        "replicationFactor": {
+          "type": "number",
+          "minimum": 1,
+          "description": "Replication factor (for Kafka)"
+        },
+        "consumerConfig": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true,
+              "description": "Enable consumer"
+            },
+            "consumerGroup": {
+              "type": "string",
+              "description": "Consumer group ID"
+            },
+            "concurrency": {
+              "type": "number",
+              "minimum": 1,
+              "maximum": 100,
+              "default": 1,
+              "description": "Number of concurrent consumers"
+            },
+            "prefetchCount": {
+              "type": "number",
+              "minimum": 1,
+              "maximum": 1000,
+              "default": 10,
+              "description": "Prefetch count"
+            },
+            "ackMode": {
+              "type": "string",
+              "enum": [
+                "auto",
+                "manual",
+                "client"
+              ],
+              "description": "Message acknowledgment mode",
+              "default": "manual"
+            },
+            "autoCommit": {
+              "type": "boolean",
+              "default": false,
+              "description": "Auto-commit offsets"
+            },
+            "autoCommitIntervalMs": {
+              "type": "number",
+              "minimum": 100,
+              "default": 5000,
+              "description": "Auto-commit interval in ms"
+            },
+            "sessionTimeoutMs": {
+              "type": "number",
+              "minimum": 1000,
+              "default": 30000,
+              "description": "Session timeout in ms"
+            },
+            "rebalanceTimeoutMs": {
+              "type": "number",
+              "minimum": 1000,
+              "description": "Rebalance timeout in ms"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Consumer-specific configuration"
+        },
+        "producerConfig": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": true,
+              "description": "Enable producer"
+            },
+            "acks": {
+              "type": "string",
+              "enum": [
+                "0",
+                "1",
+                "all"
+              ],
+              "default": "all",
+              "description": "Acknowledgment level"
+            },
+            "compressionType": {
+              "type": "string",
+              "enum": [
+                "none",
+                "gzip",
+                "snappy",
+                "lz4",
+                "zstd"
+              ],
+              "default": "none",
+              "description": "Compression type"
+            },
+            "batchSize": {
+              "type": "number",
+              "minimum": 1,
+              "default": 16384,
+              "description": "Batch size in bytes"
+            },
+            "lingerMs": {
+              "type": "number",
+              "minimum": 0,
+              "default": 0,
+              "description": "Linger time in ms"
+            },
+            "maxInFlightRequests": {
+              "type": "number",
+              "minimum": 1,
+              "default": 5,
+              "description": "Max in-flight requests"
+            },
+            "idempotence": {
+              "type": "boolean",
+              "default": true,
+              "description": "Enable idempotent producer"
+            },
+            "transactional": {
+              "type": "boolean",
+              "default": false,
+              "description": "Enable transactional producer"
+            },
+            "transactionTimeoutMs": {
+              "type": "number",
+              "minimum": 1000,
+              "description": "Transaction timeout in ms"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Producer-specific configuration"
+        },
+        "dlqConfig": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false,
+              "description": "Enable DLQ"
+            },
+            "queueName": {
+              "type": "string",
+              "description": "Dead letter queue/topic name"
+            },
+            "maxRetries": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 100,
+              "default": 3,
+              "description": "Max retries before DLQ"
+            },
+            "retryDelayMs": {
+              "type": "number",
+              "minimum": 0,
+              "default": 60000,
+              "description": "Retry delay in ms"
+            }
+          },
+          "required": [
+            "queueName"
+          ],
+          "additionalProperties": false,
+          "description": "Dead letter queue configuration"
+        },
+        "routingKey": {
+          "type": "string",
+          "description": "Routing key pattern"
+        },
+        "messageFilter": {
+          "type": "object",
+          "properties": {
+            "headers": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Filter by message headers"
+            },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {},
+              "description": "Filter by message attributes"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Message filter criteria"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "topicName"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}