@objectstack/spec 0.1.2 → 0.3.0

package/json-schema/DriverCapabilities.json

@@ -8,6 +8,30 @@
           "type": "boolean",
           "description": "Supports transactions"
         },
+        "queryFilters": {
+          "type": "boolean",
+          "description": "Supports WHERE clause filtering"
+        },
+        "queryAggregations": {
+          "type": "boolean",
+          "description": "Supports GROUP BY and aggregation functions"
+        },
+        "querySorting": {
+          "type": "boolean",
+          "description": "Supports ORDER BY sorting"
+        },
+        "queryPagination": {
+          "type": "boolean",
+          "description": "Supports LIMIT/OFFSET pagination"
+        },
+        "queryWindowFunctions": {
+          "type": "boolean",
+          "description": "Supports window functions with OVER clause"
+        },
+        "querySubqueries": {
+          "type": "boolean",
+          "description": "Supports subqueries"
+        },
         "joins": {
           "type": "boolean",
           "description": "Supports SQL joins"
@@ -27,6 +51,12 @@
       },
       "required": [
         "transactions",
+        "queryFilters",
+        "queryAggregations",
+        "querySorting",
+        "queryPagination",
+        "queryWindowFunctions",
+        "querySubqueries",
         "joins",
         "fullTextSearch",
         "jsonFields",

package/json-schema/DriverDefinition.json

@@ -26,29 +26,49 @@
         "capabilities": {
           "type": "object",
           "properties": {
-            "joins": {
+            "transactions": {
               "type": "boolean",
               "default": false
             },
-            "transactions": {
+            "queryFilters": {
               "type": "boolean",
               "default": false
             },
-            "fullTextSearch": {
+            "queryAggregations": {
               "type": "boolean",
               "default": false
             },
-            "aggregation": {
+            "querySorting": {
               "type": "boolean",
               "default": false
             },
-            "dynamicSchema": {
+            "queryPagination": {
+              "type": "boolean",
+              "default": false
+            },
+            "queryWindowFunctions": {
+              "type": "boolean",
+              "default": false
+            },
+            "querySubqueries": {
+              "type": "boolean",
+              "default": false
+            },
+            "joins": {
+              "type": "boolean",
+              "default": false
+            },
+            "fullTextSearch": {
               "type": "boolean",
               "default": false
             },
             "readOnly": {
               "type": "boolean",
               "default": false
+            },
+            "dynamicSchema": {
+              "type": "boolean",
+              "default": false
             }
           },
           "additionalProperties": false

package/json-schema/DriverInterface.json

@@ -19,6 +19,30 @@
               "type": "boolean",
               "description": "Supports transactions"
             },
+            "queryFilters": {
+              "type": "boolean",
+              "description": "Supports WHERE clause filtering"
+            },
+            "queryAggregations": {
+              "type": "boolean",
+              "description": "Supports GROUP BY and aggregation functions"
+            },
+            "querySorting": {
+              "type": "boolean",
+              "description": "Supports ORDER BY sorting"
+            },
+            "queryPagination": {
+              "type": "boolean",
+              "description": "Supports LIMIT/OFFSET pagination"
+            },
+            "queryWindowFunctions": {
+              "type": "boolean",
+              "description": "Supports window functions with OVER clause"
+            },
+            "querySubqueries": {
+              "type": "boolean",
+              "description": "Supports subqueries"
+            },
             "joins": {
               "type": "boolean",
               "description": "Supports SQL joins"
@@ -38,6 +62,12 @@
           },
           "required": [
             "transactions",
+            "queryFilters",
+            "queryAggregations",
+            "querySorting",
+            "queryPagination",
+            "queryWindowFunctions",
+            "querySubqueries",
             "joins",
             "fullTextSearch",
             "jsonFields",

package/json-schema/EmailPasswordConfig.json

@@ -0,0 +1,43 @@
+{
+  "$ref": "#/definitions/EmailPasswordConfig",
+  "definitions": {
+    "EmailPasswordConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true
+        },
+        "requireEmailVerification": {
+          "type": "boolean",
+          "default": true,
+          "description": "Require email verification before login"
+        },
+        "minPasswordLength": {
+          "type": "number",
+          "minimum": 6,
+          "maximum": 128,
+          "default": 8,
+          "description": "Minimum password length"
+        },
+        "requirePasswordComplexity": {
+          "type": "boolean",
+          "default": true,
+          "description": "Require uppercase, lowercase, numbers, symbols"
+        },
+        "allowPasswordReset": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable password reset functionality"
+        },
+        "passwordResetExpiry": {
+          "type": "number",
+          "default": 3600,
+          "description": "Password reset token expiry in seconds"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/EmbeddingModel.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/EmbeddingModel",
+  "definitions": {
+    "EmbeddingModel": {
+      "type": "object",
+      "properties": {
+        "provider": {
+          "type": "string",
+          "enum": [
+            "openai",
+            "cohere",
+            "huggingface",
+            "azure_openai",
+            "local",
+            "custom"
+          ]
+        },
+        "model": {
+          "type": "string",
+          "description": "Model name (e.g., \"text-embedding-3-large\")"
+        },
+        "dimensions": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "description": "Embedding vector dimensions"
+        },
+        "maxTokens": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "description": "Maximum tokens per embedding"
+        },
+        "batchSize": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 100,
+          "description": "Batch size for embedding"
+        },
+        "endpoint": {
+          "type": "string",
+          "format": "uri",
+          "description": "Custom endpoint URL"
+        },
+        "apiKey": {
+          "type": "string",
+          "description": "API key or reference to secret"
+        }
+      },
+      "required": [
+        "provider",
+        "model",
+        "dimensions"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/EnterpriseAuthConfig.json

@@ -0,0 +1,172 @@
+{
+  "$ref": "#/definitions/EnterpriseAuthConfig",
+  "definitions": {
+    "EnterpriseAuthConfig": {
+      "type": "object",
+      "properties": {
+        "oidc": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "issuer": {
+              "type": "string",
+              "format": "uri",
+              "description": "OIDC Issuer URL (.well-known/openid-configuration)"
+            },
+            "clientId": {
+              "type": "string",
+              "description": "OIDC client ID"
+            },
+            "clientSecret": {
+              "type": "string",
+              "description": "OIDC client secret"
+            },
+            "scopes": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "default": [
+                "openid",
+                "profile",
+                "email"
+              ],
+              "description": "OIDC scopes"
+            },
+            "attributeMapping": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Map IdP claims to User fields"
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Display name for the provider button"
+            },
+            "icon": {
+              "type": "string",
+              "description": "Icon URL or identifier"
+            }
+          },
+          "required": [
+            "issuer",
+            "clientId",
+            "clientSecret"
+          ],
+          "additionalProperties": false,
+          "description": "OpenID Connect configuration"
+        },
+        "saml": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "entryPoint": {
+              "type": "string",
+              "format": "uri",
+              "description": "IdP SSO URL"
+            },
+            "cert": {
+              "type": "string",
+              "description": "IdP Public Certificate (PEM format)"
+            },
+            "issuer": {
+              "type": "string",
+              "description": "Entity ID of the IdP"
+            },
+            "signatureAlgorithm": {
+              "type": "string",
+              "enum": [
+                "sha256",
+                "sha512"
+              ],
+              "default": "sha256",
+              "description": "Signature algorithm"
+            },
+            "attributeMapping": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              },
+              "description": "Map SAML attributes to User fields"
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Display name for the provider button"
+            },
+            "icon": {
+              "type": "string",
+              "description": "Icon URL or identifier"
+            }
+          },
+          "required": [
+            "entryPoint",
+            "cert",
+            "issuer"
+          ],
+          "additionalProperties": false,
+          "description": "SAML 2.0 configuration"
+        },
+        "ldap": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "url": {
+              "type": "string",
+              "format": "uri",
+              "description": "LDAP Server URL (ldap:// or ldaps://)"
+            },
+            "bindDn": {
+              "type": "string",
+              "description": "Bind DN for LDAP authentication"
+            },
+            "bindCredentials": {
+              "type": "string",
+              "description": "Bind credentials"
+            },
+            "searchBase": {
+              "type": "string",
+              "description": "Search base DN"
+            },
+            "searchFilter": {
+              "type": "string",
+              "description": "Search filter"
+            },
+            "groupSearchBase": {
+              "type": "string",
+              "description": "Group search base DN"
+            },
+            "displayName": {
+              "type": "string",
+              "description": "Display name for the provider button"
+            },
+            "icon": {
+              "type": "string",
+              "description": "Icon URL or identifier"
+            }
+          },
+          "required": [
+            "url",
+            "bindDn",
+            "bindCredentials",
+            "searchBase",
+            "searchFilter"
+          ],
+          "additionalProperties": false,
+          "description": "LDAP/Active Directory configuration"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Entity.json

@@ -0,0 +1,55 @@
+{
+  "$ref": "#/definitions/Entity",
+  "definitions": {
+    "Entity": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "object",
+            "field",
+            "value",
+            "operator",
+            "function",
+            "timeframe"
+          ]
+        },
+        "text": {
+          "type": "string",
+          "description": "Original text from query"
+        },
+        "value": {
+          "description": "Normalized value"
+        },
+        "confidence": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1,
+          "description": "Confidence score"
+        },
+        "span": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "number"
+            }
+          ],
+          "description": "Character span in query"
+        }
+      },
+      "required": [
+        "type",
+        "text",
+        "confidence"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/EqualityOperator.json

@@ -0,0 +1,14 @@
+{
+  "$ref": "#/definitions/EqualityOperator",
+  "definitions": {
+    "EqualityOperator": {
+      "type": "object",
+      "properties": {
+        "$eq": {},
+        "$ne": {}
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldOperators.json

@@ -0,0 +1,108 @@
+{
+  "$ref": "#/definitions/FieldOperators",
+  "definitions": {
+    "FieldOperators": {
+      "type": "object",
+      "properties": {
+        "$eq": {},
+        "$ne": {},
+        "$gt": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string",
+              "format": "date-time"
+            }
+          ]
+        },
+        "$gte": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string",
+              "format": "date-time"
+            }
+          ]
+        },
+        "$lt": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string",
+              "format": "date-time"
+            }
+          ]
+        },
+        "$lte": {
+          "anyOf": [
+            {
+              "type": "number"
+            },
+            {
+              "type": "string",
+              "format": "date-time"
+            }
+          ]
+        },
+        "$in": {
+          "type": "array"
+        },
+        "$nin": {
+          "type": "array"
+        },
+        "$between": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              ]
+            },
+            {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              ]
+            }
+          ]
+        },
+        "$contains": {
+          "type": "string"
+        },
+        "$startsWith": {
+          "type": "string"
+        },
+        "$endsWith": {
+          "type": "string"
+        },
+        "$null": {
+          "type": "boolean"
+        },
+        "$exist": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldSynonymConfig.json

@@ -0,0 +1,39 @@
+{
+  "$ref": "#/definitions/FieldSynonymConfig",
+  "definitions": {
+    "FieldSynonymConfig": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field name"
+        },
+        "synonyms": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Natural language synonyms"
+        },
+        "examples": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Example queries using synonyms"
+        }
+      },
+      "required": [
+        "object",
+        "field",
+        "synonyms"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FilterCondition.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/FilterCondition",
+  "definitions": {
+    "FilterCondition": {
+      "allOf": [
+        {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        {
+          "type": "object",
+          "properties": {
+            "$and": {
+              "type": "array",
+              "items": {}
+            },
+            "$or": {
+              "type": "array",
+              "items": {}
+            },
+            "$not": {}
+          }
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}