@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/Discovery.json

@@ -0,0 +1,114 @@
+{
+  "$ref": "#/definitions/Discovery",
+  "definitions": {
+    "Discovery": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        },
+        "environment": {
+          "type": "string",
+          "enum": [
+            "production",
+            "sandbox",
+            "development"
+          ]
+        },
+        "routes": {
+          "type": "object",
+          "properties": {
+            "data": {
+              "type": "string",
+              "description": "e.g. /api/v1/data"
+            },
+            "metadata": {
+              "type": "string",
+              "description": "e.g. /api/v1/meta"
+            },
+            "auth": {
+              "type": "string",
+              "description": "e.g. /api/v1/auth"
+            },
+            "actions": {
+              "type": "string",
+              "description": "e.g. /api/v1/p"
+            },
+            "storage": {
+              "type": "string",
+              "description": "e.g. /api/v1/storage"
+            },
+            "graphql": {
+              "type": "string",
+              "description": "e.g. /api/v1/graphql"
+            }
+          },
+          "required": [
+            "data",
+            "metadata",
+            "auth"
+          ],
+          "additionalProperties": false
+        },
+        "features": {
+          "type": "object",
+          "properties": {
+            "graphql": {
+              "type": "boolean",
+              "default": false
+            },
+            "search": {
+              "type": "boolean",
+              "default": false
+            },
+            "websockets": {
+              "type": "boolean",
+              "default": false
+            },
+            "files": {
+              "type": "boolean",
+              "default": true
+            }
+          },
+          "additionalProperties": false
+        },
+        "locale": {
+          "type": "object",
+          "properties": {
+            "default": {
+              "type": "string"
+            },
+            "supported": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "timezone": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "default",
+            "supported",
+            "timezone"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "name",
+        "version",
+        "environment",
+        "routes",
+        "features",
+        "locale"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DriverCapabilities.json

@@ -0,0 +1,39 @@
+{
+  "$ref": "#/definitions/DriverCapabilities",
+  "definitions": {
+    "DriverCapabilities": {
+      "type": "object",
+      "properties": {
+        "transactions": {
+          "type": "boolean",
+          "description": "Supports transactions"
+        },
+        "joins": {
+          "type": "boolean",
+          "description": "Supports SQL joins"
+        },
+        "fullTextSearch": {
+          "type": "boolean",
+          "description": "Supports full-text search"
+        },
+        "jsonFields": {
+          "type": "boolean",
+          "description": "Supports JSON field types"
+        },
+        "arrayFields": {
+          "type": "boolean",
+          "description": "Supports array field types"
+        }
+      },
+      "required": [
+        "transactions",
+        "joins",
+        "fullTextSearch",
+        "jsonFields",
+        "arrayFields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DriverDefinition.json

@@ -0,0 +1,66 @@
+{
+  "$ref": "#/definitions/DriverDefinition",
+  "definitions": {
+    "DriverDefinition": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique driver identifier (e.g. \"postgres\")"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label (e.g. \"PostgreSQL\")"
+        },
+        "description": {
+          "type": "string"
+        },
+        "icon": {
+          "type": "string"
+        },
+        "configSchema": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "JSON Schema for connection configuration"
+        },
+        "capabilities": {
+          "type": "object",
+          "properties": {
+            "joins": {
+              "type": "boolean",
+              "default": false
+            },
+            "transactions": {
+              "type": "boolean",
+              "default": false
+            },
+            "fullTextSearch": {
+              "type": "boolean",
+              "default": false
+            },
+            "aggregation": {
+              "type": "boolean",
+              "default": false
+            },
+            "dynamicSchema": {
+              "type": "boolean",
+              "default": false
+            },
+            "readOnly": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "label",
+        "configSchema"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DriverInterface.json

@@ -0,0 +1,58 @@
+{
+  "$ref": "#/definitions/DriverInterface",
+  "definitions": {
+    "DriverInterface": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Driver unique name"
+        },
+        "version": {
+          "type": "string",
+          "description": "Driver version"
+        },
+        "supports": {
+          "type": "object",
+          "properties": {
+            "transactions": {
+              "type": "boolean",
+              "description": "Supports transactions"
+            },
+            "joins": {
+              "type": "boolean",
+              "description": "Supports SQL joins"
+            },
+            "fullTextSearch": {
+              "type": "boolean",
+              "description": "Supports full-text search"
+            },
+            "jsonFields": {
+              "type": "boolean",
+              "description": "Supports JSON field types"
+            },
+            "arrayFields": {
+              "type": "boolean",
+              "description": "Supports array field types"
+            }
+          },
+          "required": [
+            "transactions",
+            "joins",
+            "fullTextSearch",
+            "jsonFields",
+            "arrayFields"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "name",
+        "version",
+        "supports"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DriverOptions.json

@@ -0,0 +1,23 @@
+{
+  "$ref": "#/definitions/DriverOptions",
+  "definitions": {
+    "DriverOptions": {
+      "type": "object",
+      "properties": {
+        "transaction": {
+          "description": "Transaction handle"
+        },
+        "timeout": {
+          "type": "number",
+          "description": "Timeout in ms"
+        },
+        "skipCache": {
+          "type": "boolean",
+          "description": "Bypass cache"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DriverType.json

@@ -0,0 +1,10 @@
+{
+  "$ref": "#/definitions/DriverType",
+  "definitions": {
+    "DriverType": {
+      "type": "string",
+      "description": "Underlying driver identifier"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/EmailAlertAction.json

@@ -0,0 +1,37 @@
+{
+  "$ref": "#/definitions/EmailAlertAction",
+  "definitions": {
+    "EmailAlertAction": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Action name"
+        },
+        "type": {
+          "type": "string",
+          "const": "email_alert"
+        },
+        "template": {
+          "type": "string",
+          "description": "Email template ID/DevName"
+        },
+        "recipients": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of recipient emails or user IDs"
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "template",
+        "recipients"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}