@objectstack/spec 0.1.2 → 0.3.0

package/json-schema/RAGQueryResponse.json

@@ -0,0 +1,108 @@
+{
+  "$ref": "#/definitions/RAGQueryResponse",
+  "definitions": {
+    "RAGQueryResponse": {
+      "type": "object",
+      "properties": {
+        "query": {
+          "type": "string"
+        },
+        "results": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "content": {
+                "type": "string"
+              },
+              "score": {
+                "type": "number"
+              },
+              "metadata": {
+                "type": "object",
+                "properties": {
+                  "source": {
+                    "type": "string",
+                    "description": "Document source (file path, URL, etc.)"
+                  },
+                  "sourceType": {
+                    "type": "string",
+                    "enum": [
+                      "file",
+                      "url",
+                      "api",
+                      "database",
+                      "custom"
+                    ]
+                  },
+                  "title": {
+                    "type": "string"
+                  },
+                  "author": {
+                    "type": "string"
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "description": "ISO timestamp"
+                  },
+                  "updatedAt": {
+                    "type": "string",
+                    "description": "ISO timestamp"
+                  },
+                  "tags": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "category": {
+                    "type": "string"
+                  },
+                  "language": {
+                    "type": "string",
+                    "description": "Document language (ISO 639-1 code)"
+                  },
+                  "custom": {
+                    "type": "object",
+                    "additionalProperties": {},
+                    "description": "Custom metadata fields"
+                  }
+                },
+                "required": [
+                  "source"
+                ],
+                "additionalProperties": false
+              },
+              "chunkId": {
+                "type": "string"
+              }
+            },
+            "required": [
+              "content",
+              "score"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "context": {
+          "type": "string",
+          "description": "Assembled context for LLM"
+        },
+        "tokensUsed": {
+          "type": "integer"
+        },
+        "retrievalTime": {
+          "type": "number",
+          "description": "Retrieval time in milliseconds"
+        }
+      },
+      "required": [
+        "query",
+        "results",
+        "context"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/RangeOperator.json

@@ -0,0 +1,41 @@
+{
+  "$ref": "#/definitions/RangeOperator",
+  "definitions": {
+    "RangeOperator": {
+      "type": "object",
+      "properties": {
+        "$between": {
+          "type": "array",
+          "minItems": 2,
+          "maxItems": 2,
+          "items": [
+            {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              ]
+            },
+            {
+              "anyOf": [
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              ]
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/RateLimitConfig.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/RateLimitConfig",
+  "definitions": {
+    "RateLimitConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": true
+        },
+        "maxAttempts": {
+          "type": "number",
+          "default": 5,
+          "description": "Maximum login attempts"
+        },
+        "windowMs": {
+          "type": "number",
+          "default": 900000,
+          "description": "Time window in milliseconds (default 15 min)"
+        },
+        "blockDuration": {
+          "type": "number",
+          "default": 900000,
+          "description": "Block duration after max attempts in ms"
+        },
+        "skipSuccessfulRequests": {
+          "type": "boolean",
+          "default": false,
+          "description": "Only count failed requests"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Report.json

@@ -137,33 +137,27 @@
           "description": "Column groupings (Matrix only)"
         },
         "filter": {
-          "type": "string",
-          "description": "Filter logic (e.g. \"1 AND (2 OR 3)\")"
-        },
-        "filterItems": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "id": {
-                "type": "number"
-              },
-              "field": {
-                "type": "string"
-              },
-              "operator": {
-                "type": "string"
-              },
-              "value": {}
+          "allOf": [
+            {
+              "type": "object",
+              "additionalProperties": {}
             },
-            "required": [
-              "id",
-              "field",
-              "operator"
-            ],
-            "additionalProperties": false
-          },
-          "description": "Filter criteria lines"
+            {
+              "type": "object",
+              "properties": {
+                "$and": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$or": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$not": {}
+              }
+            }
+          ],
+          "description": "Filter criteria"
         },
         "chart": {
           "type": "object",

package/json-schema/RerankingConfig.json

@@ -0,0 +1,34 @@
+{
+  "$ref": "#/definitions/RerankingConfig",
+  "definitions": {
+    "RerankingConfig": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false
+        },
+        "model": {
+          "type": "string",
+          "description": "Reranking model name"
+        },
+        "provider": {
+          "type": "string",
+          "enum": [
+            "cohere",
+            "huggingface",
+            "custom"
+          ]
+        },
+        "topK": {
+          "type": "integer",
+          "exclusiveMinimum": 0,
+          "default": 3,
+          "description": "Final number of results after reranking"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/RetrievalStrategy.json

@@ -0,0 +1,121 @@
+{
+  "$ref": "#/definitions/RetrievalStrategy",
+  "definitions": {
+    "RetrievalStrategy": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "similarity"
+            },
+            "topK": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 5,
+              "description": "Number of results to retrieve"
+            },
+            "scoreThreshold": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "description": "Minimum similarity score"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "mmr"
+            },
+            "topK": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 5
+            },
+            "fetchK": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 20,
+              "description": "Initial fetch size"
+            },
+            "lambda": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "default": 0.5,
+              "description": "Diversity vs relevance (0=diverse, 1=relevant)"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "hybrid"
+            },
+            "topK": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 5
+            },
+            "vectorWeight": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "default": 0.7,
+              "description": "Weight for vector search"
+            },
+            "keywordWeight": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "default": 0.3,
+              "description": "Weight for keyword search"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "const": "parent_document"
+            },
+            "topK": {
+              "type": "integer",
+              "exclusiveMinimum": 0,
+              "default": 5
+            },
+            "retrieveParent": {
+              "type": "boolean",
+              "default": true,
+              "description": "Retrieve full parent document"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SAMLConfig.json

@@ -4,6 +4,10 @@
     "SAMLConfig": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false
+        },
         "entryPoint": {
           "type": "string",
           "format": "uri",
@@ -11,7 +15,7 @@
         },
         "cert": {
           "type": "string",
-          "description": "IdP Public Certificate"
+          "description": "IdP Public Certificate (PEM format)"
         },
         "issuer": {
           "type": "string",
@@ -23,13 +27,23 @@
             "sha256",
             "sha512"
           ],
-          "default": "sha256"
+          "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": [

package/json-schema/Session.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/Session",
+  "definitions": {
+    "Session": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique session identifier"
+        },
+        "sessionToken": {
+          "type": "string",
+          "description": "Session token"
+        },
+        "userId": {
+          "type": "string",
+          "description": "Associated user ID"
+        },
+        "activeOrganizationId": {
+          "type": "string",
+          "description": "Active organization ID for context switching"
+        },
+        "expires": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Session expiry timestamp"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Session creation timestamp"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Last update timestamp"
+        },
+        "ipAddress": {
+          "type": "string",
+          "description": "IP address"
+        },
+        "userAgent": {
+          "type": "string",
+          "description": "User agent string"
+        },
+        "fingerprint": {
+          "type": "string",
+          "description": "Device fingerprint"
+        }
+      },
+      "required": [
+        "id",
+        "sessionToken",
+        "userId",
+        "expires",
+        "createdAt",
+        "updatedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SessionConfig.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/SessionConfig",
+  "definitions": {
+    "SessionConfig": {
+      "type": "object",
+      "properties": {
+        "expiresIn": {
+          "type": "number",
+          "default": 604800,
+          "description": "Session expiry in seconds (default 7 days)"
+        },
+        "updateAge": {
+          "type": "number",
+          "default": 86400,
+          "description": "Session update interval in seconds (default 1 day)"
+        },
+        "cookieName": {
+          "type": "string",
+          "default": "session_token",
+          "description": "Session cookie name"
+        },
+        "cookieSecure": {
+          "type": "boolean",
+          "default": true,
+          "description": "Use secure cookies (HTTPS only)"
+        },
+        "cookieSameSite": {
+          "type": "string",
+          "enum": [
+            "strict",
+            "lax",
+            "none"
+          ],
+          "default": "lax",
+          "description": "SameSite cookie attribute"
+        },
+        "cookieDomain": {
+          "type": "string",
+          "description": "Cookie domain"
+        },
+        "cookiePath": {
+          "type": "string",
+          "default": "/",
+          "description": "Cookie path"
+        },
+        "cookieHttpOnly": {
+          "type": "boolean",
+          "default": true,
+          "description": "HttpOnly cookie attribute"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SetOperator.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/SetOperator",
+  "definitions": {
+    "SetOperator": {
+      "type": "object",
+      "properties": {
+        "$in": {
+          "type": "array"
+        },
+        "$nin": {
+          "type": "array"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SpecialOperator.json

@@ -0,0 +1,18 @@
+{
+  "$ref": "#/definitions/SpecialOperator",
+  "definitions": {
+    "SpecialOperator": {
+      "type": "object",
+      "properties": {
+        "$null": {
+          "type": "boolean"
+        },
+        "$exist": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}