@objectstack/spec 0.1.1 → 0.1.2

package/json-schema/CreateRequest.json

@@ -0,0 +1,20 @@
+{
+  "$ref": "#/definitions/CreateRequest",
+  "definitions": {
+    "CreateRequest": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Record data to insert"
+        }
+      },
+      "required": [
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/CrossFieldValidation.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/CrossFieldValidation",
+  "definitions": {
+    "CrossFieldValidation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "cross_field"
+        },
+        "condition": {
+          "type": "string",
+          "description": "Formula expression comparing fields (e.g. \"end_date > start_date\")"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields involved in the validation"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "condition",
+        "fields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/CustomValidator.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/CustomValidator",
+  "definitions": {
+    "CustomValidator": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "custom"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to validate (optional for record-level validation)"
+        },
+        "validatorFunction": {
+          "type": "string",
+          "description": "Function name or reference to custom validator"
+        },
+        "params": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional parameters for the validator"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "validatorFunction"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Datasource.json

@@ -15,24 +15,6 @@
         },
         "driver": {
           "type": "string",
-          "enum": [
-            "postgres",
-            "mysql",
-            "sqlserver",
-            "oracle",
-            "sqlite",
-            "mongo",
-            "redis",
-            "excel",
-            "csv",
-            "airtable",
-            "rest_api",
-            "graphql",
-            "odata",
-            "salesforce",
-            "sap",
-            "workday"
-          ],
           "description": "Underlying driver type"
         },
         "config": {

package/json-schema/DeleteResponse.json

@@ -0,0 +1,68 @@
+{
+  "$ref": "#/definitions/DeleteResponse",
+  "definitions": {
+    "DeleteResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        },
+        "id": {
+          "type": "string",
+          "description": "ID of the deleted record"
+        }
+      },
+      "required": [
+        "success",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

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

@@ -3,24 +3,7 @@
   "definitions": {
     "DriverType": {
       "type": "string",
-      "enum": [
-        "postgres",
-        "mysql",
-        "sqlserver",
-        "oracle",
-        "sqlite",
-        "mongo",
-        "redis",
-        "excel",
-        "csv",
-        "airtable",
-        "rest_api",
-        "graphql",
-        "odata",
-        "salesforce",
-        "sap",
-        "workday"
-      ]
+      "description": "Underlying driver identifier"
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"