@objectstack/spec 0.2.0 → 0.3.0

package/json-schema/DocumentChunk.json

@@ -0,0 +1,97 @@
+{
+  "$ref": "#/definitions/DocumentChunk",
+  "definitions": {
+    "DocumentChunk": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique chunk identifier"
+        },
+        "content": {
+          "type": "string",
+          "description": "Chunk text content"
+        },
+        "embedding": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          },
+          "description": "Embedding vector"
+        },
+        "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
+        },
+        "chunkIndex": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "Chunk position in document"
+        },
+        "tokens": {
+          "type": "integer",
+          "description": "Token count"
+        }
+      },
+      "required": [
+        "id",
+        "content",
+        "metadata",
+        "chunkIndex"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DocumentLoaderConfig.json

@@ -0,0 +1,69 @@
+{
+  "$ref": "#/definitions/DocumentLoaderConfig",
+  "definitions": {
+    "DocumentLoaderConfig": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "file",
+            "directory",
+            "url",
+            "api",
+            "database",
+            "custom"
+          ]
+        },
+        "source": {
+          "type": "string",
+          "description": "Source path, URL, or identifier"
+        },
+        "fileTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Accepted file extensions (e.g., [\".pdf\", \".md\"])"
+        },
+        "recursive": {
+          "type": "boolean",
+          "default": false,
+          "description": "Process directories recursively"
+        },
+        "maxFileSize": {
+          "type": "integer",
+          "description": "Maximum file size in bytes"
+        },
+        "excludePatterns": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Patterns to exclude"
+        },
+        "extractImages": {
+          "type": "boolean",
+          "default": false,
+          "description": "Extract text from images (OCR)"
+        },
+        "extractTables": {
+          "type": "boolean",
+          "default": false,
+          "description": "Extract and format tables"
+        },
+        "loaderConfig": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Custom loader-specific config"
+        }
+      },
+      "required": [
+        "type",
+        "source"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DocumentMetadata.json

@@ -0,0 +1,61 @@
+{
+  "$ref": "#/definitions/DocumentMetadata",
+  "definitions": {
+    "DocumentMetadata": {
+      "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
+    }
+  },
+  "$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/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/Invitation.json

@@ -0,0 +1,69 @@
+{
+  "$ref": "#/definitions/Invitation",
+  "definitions": {
+    "Invitation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique invitation identifier"
+        },
+        "organizationId": {
+          "type": "string",
+          "description": "Organization ID"
+        },
+        "email": {
+          "type": "string",
+          "format": "email",
+          "description": "Invitee email address"
+        },
+        "role": {
+          "type": "string",
+          "description": "Role to assign upon acceptance"
+        },
+        "status": {
+          "type": "string",
+          "enum": [
+            "pending",
+            "accepted",
+            "rejected",
+            "expired"
+          ],
+          "default": "pending",
+          "description": "Invitation status"
+        },
+        "expiresAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Invitation expiry timestamp"
+        },
+        "inviterId": {
+          "type": "string",
+          "description": "User ID of the inviter"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Invitation creation timestamp"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Last update timestamp"
+        }
+      },
+      "required": [
+        "id",
+        "organizationId",
+        "email",
+        "role",
+        "expiresAt",
+        "inviterId",
+        "createdAt",
+        "updatedAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/InvitationStatus.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/InvitationStatus",
+  "definitions": {
+    "InvitationStatus": {
+      "type": "string",
+      "enum": [
+        "pending",
+        "accepted",
+        "rejected",
+        "expired"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/LDAPConfig.json

@@ -4,25 +4,42 @@
     "LDAPConfig": {
       "type": "object",
       "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false
+        },
         "url": {
           "type": "string",
           "format": "uri",
           "description": "LDAP Server URL (ldap:// or ldaps://)"
         },
         "bindDn": {
-          "type": "string"
+          "type": "string",
+          "description": "Bind DN for LDAP authentication"
         },
         "bindCredentials": {
-          "type": "string"
+          "type": "string",
+          "description": "Bind credentials"
         },
         "searchBase": {
-          "type": "string"
+          "type": "string",
+          "description": "Search base DN"
         },
         "searchFilter": {
-          "type": "string"
+          "type": "string",
+          "description": "Search filter"
         },
         "groupSearchBase": {
-          "type": "string"
+          "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": [