@objectstack/spec 0.6.1 → 0.7.2

package/json-schema/data/DataEngineSort.json

@@ -0,0 +1,54 @@
+{
+  "$ref": "#/definitions/DataEngineSort",
+  "definitions": {
+    "DataEngineSort": {
+      "anyOf": [
+        {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string",
+            "enum": [
+              "asc",
+              "desc"
+            ]
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": {
+            "type": "number",
+            "enum": [
+              1,
+              -1
+            ]
+          }
+        },
+        {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string"
+              },
+              "order": {
+                "type": "string",
+                "enum": [
+                  "asc",
+                  "desc"
+                ],
+                "default": "asc"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          }
+        }
+      ],
+      "description": "Sort order definition"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/DataEngineUpdateOptions.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/DataEngineUpdateOptions",
+  "definitions": {
+    "DataEngineUpdateOptions": {
+      "type": "object",
+      "properties": {
+        "filter": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {}
+            },
+            {
+              "allOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {}
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$and": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$or": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$not": {}
+                  }
+                }
+              ]
+            }
+          ],
+          "description": "Data Engine query filter conditions"
+        },
+        "upsert": {
+          "type": "boolean",
+          "default": false
+        },
+        "multi": {
+          "type": "boolean",
+          "default": false
+        },
+        "returning": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "additionalProperties": false,
+      "description": "Options for DataEngine.update operations"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/DataEngineUpdateRequest.json

@@ -0,0 +1,81 @@
+{
+  "$ref": "#/definitions/DataEngineUpdateRequest",
+  "definitions": {
+    "DataEngineUpdateRequest": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "type": "string",
+          "const": "update"
+        },
+        "object": {
+          "type": "string"
+        },
+        "data": {
+          "type": "object",
+          "additionalProperties": {}
+        },
+        "id": {
+          "description": "ID for single update, or use filter in options"
+        },
+        "options": {
+          "type": "object",
+          "properties": {
+            "filter": {
+              "anyOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {}
+                },
+                {
+                  "allOf": [
+                    {
+                      "type": "object",
+                      "additionalProperties": {}
+                    },
+                    {
+                      "type": "object",
+                      "properties": {
+                        "$and": {
+                          "type": "array",
+                          "items": {}
+                        },
+                        "$or": {
+                          "type": "array",
+                          "items": {}
+                        },
+                        "$not": {}
+                      }
+                    }
+                  ]
+                }
+              ],
+              "description": "Data Engine query filter conditions"
+            },
+            "upsert": {
+              "type": "boolean",
+              "default": false
+            },
+            "multi": {
+              "type": "boolean",
+              "default": false
+            },
+            "returning": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "additionalProperties": false,
+          "description": "Options for DataEngine.update operations"
+        }
+      },
+      "required": [
+        "method",
+        "object",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/DataEngineVectorFindRequest.json

@@ -0,0 +1,74 @@
+{
+  "$ref": "#/definitions/DataEngineVectorFindRequest",
+  "definitions": {
+    "DataEngineVectorFindRequest": {
+      "type": "object",
+      "properties": {
+        "method": {
+          "type": "string",
+          "const": "vectorFind"
+        },
+        "object": {
+          "type": "string"
+        },
+        "vector": {
+          "type": "array",
+          "items": {
+            "type": "number"
+          }
+        },
+        "filter": {
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {}
+            },
+            {
+              "allOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {}
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$and": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$or": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$not": {}
+                  }
+                }
+              ]
+            }
+          ],
+          "description": "Data Engine query filter conditions"
+        },
+        "select": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "limit": {
+          "type": "integer",
+          "default": 5
+        },
+        "threshold": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "method",
+        "object",
+        "vector"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/DataQualityRules.json

@@ -0,0 +1,45 @@
+{
+  "$ref": "#/definitions/DataQualityRules",
+  "definitions": {
+    "DataQualityRules": {
+      "type": "object",
+      "properties": {
+        "uniqueness": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enforce unique values across all records"
+        },
+        "completeness": {
+          "type": "number",
+          "minimum": 0,
+          "maximum": 1,
+          "default": 0,
+          "description": "Minimum ratio of non-null values (0-1, default: 0 = no requirement)"
+        },
+        "accuracy": {
+          "type": "object",
+          "properties": {
+            "source": {
+              "type": "string",
+              "description": "Reference data source for validation (e.g., \"api.verify.com\", \"master_data\")"
+            },
+            "threshold": {
+              "type": "number",
+              "minimum": 0,
+              "maximum": 1,
+              "description": "Minimum accuracy threshold (0-1, e.g., 0.95 = 95% match required)"
+            }
+          },
+          "required": [
+            "source",
+            "threshold"
+          ],
+          "additionalProperties": false,
+          "description": "Accuracy validation configuration"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/DataTypeMapping.json

@@ -0,0 +1,51 @@
+{
+  "$ref": "#/definitions/DataTypeMapping",
+  "definitions": {
+    "DataTypeMapping": {
+      "type": "object",
+      "properties": {
+        "text": {
+          "type": "string",
+          "description": "SQL type for text fields (e.g., VARCHAR, TEXT)"
+        },
+        "number": {
+          "type": "string",
+          "description": "SQL type for number fields (e.g., NUMERIC, DECIMAL, INT)"
+        },
+        "boolean": {
+          "type": "string",
+          "description": "SQL type for boolean fields (e.g., BOOLEAN, BIT)"
+        },
+        "date": {
+          "type": "string",
+          "description": "SQL type for date fields (e.g., DATE)"
+        },
+        "datetime": {
+          "type": "string",
+          "description": "SQL type for datetime fields (e.g., TIMESTAMP, DATETIME)"
+        },
+        "json": {
+          "type": "string",
+          "description": "SQL type for JSON fields (e.g., JSON, JSONB)"
+        },
+        "uuid": {
+          "type": "string",
+          "description": "SQL type for UUID fields (e.g., UUID, CHAR(36))"
+        },
+        "binary": {
+          "type": "string",
+          "description": "SQL type for binary fields (e.g., BLOB, BYTEA)"
+        }
+      },
+      "required": [
+        "text",
+        "number",
+        "boolean",
+        "date",
+        "datetime"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/Document.json

@@ -0,0 +1,292 @@
+{
+  "$ref": "#/definitions/Document",
+  "definitions": {
+    "Document": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Document ID"
+        },
+        "name": {
+          "type": "string",
+          "description": "Document name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Document description"
+        },
+        "fileType": {
+          "type": "string",
+          "description": "File MIME type"
+        },
+        "fileSize": {
+          "type": "number",
+          "description": "File size in bytes"
+        },
+        "category": {
+          "type": "string",
+          "description": "Document category"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Document tags"
+        },
+        "versioning": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "description": "Versioning enabled"
+            },
+            "versions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "versionNumber": {
+                    "type": "number",
+                    "description": "Version number"
+                  },
+                  "createdAt": {
+                    "type": "number",
+                    "description": "Creation timestamp"
+                  },
+                  "createdBy": {
+                    "type": "string",
+                    "description": "Creator user ID"
+                  },
+                  "size": {
+                    "type": "number",
+                    "description": "File size in bytes"
+                  },
+                  "checksum": {
+                    "type": "string",
+                    "description": "File checksum"
+                  },
+                  "downloadUrl": {
+                    "type": "string",
+                    "format": "uri",
+                    "description": "Download URL"
+                  },
+                  "isLatest": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Is latest version"
+                  }
+                },
+                "required": [
+                  "versionNumber",
+                  "createdAt",
+                  "createdBy",
+                  "size",
+                  "checksum",
+                  "downloadUrl"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Version history"
+            },
+            "majorVersion": {
+              "type": "number",
+              "description": "Major version"
+            },
+            "minorVersion": {
+              "type": "number",
+              "description": "Minor version"
+            }
+          },
+          "required": [
+            "enabled",
+            "versions",
+            "majorVersion",
+            "minorVersion"
+          ],
+          "additionalProperties": false,
+          "description": "Version control"
+        },
+        "template": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "Template ID"
+            },
+            "name": {
+              "type": "string",
+              "description": "Template name"
+            },
+            "description": {
+              "type": "string",
+              "description": "Template description"
+            },
+            "fileUrl": {
+              "type": "string",
+              "format": "uri",
+              "description": "Template file URL"
+            },
+            "fileType": {
+              "type": "string",
+              "description": "File MIME type"
+            },
+            "placeholders": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "key": {
+                    "type": "string",
+                    "description": "Placeholder key"
+                  },
+                  "label": {
+                    "type": "string",
+                    "description": "Placeholder label"
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "text",
+                      "number",
+                      "date",
+                      "image"
+                    ],
+                    "description": "Placeholder type"
+                  },
+                  "required": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Is required"
+                  }
+                },
+                "required": [
+                  "key",
+                  "label",
+                  "type"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Template placeholders"
+            }
+          },
+          "required": [
+            "id",
+            "name",
+            "fileUrl",
+            "fileType",
+            "placeholders"
+          ],
+          "additionalProperties": false,
+          "description": "Document template"
+        },
+        "eSignature": {
+          "type": "object",
+          "properties": {
+            "provider": {
+              "type": "string",
+              "enum": [
+                "docusign",
+                "adobe-sign",
+                "hellosign",
+                "custom"
+              ],
+              "description": "E-signature provider"
+            },
+            "enabled": {
+              "type": "boolean",
+              "default": false,
+              "description": "E-signature enabled"
+            },
+            "signers": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "email": {
+                    "type": "string",
+                    "format": "email",
+                    "description": "Signer email"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Signer name"
+                  },
+                  "role": {
+                    "type": "string",
+                    "description": "Signer role"
+                  },
+                  "order": {
+                    "type": "number",
+                    "description": "Signing order"
+                  }
+                },
+                "required": [
+                  "email",
+                  "name",
+                  "role",
+                  "order"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Document signers"
+            },
+            "expirationDays": {
+              "type": "number",
+              "default": 30,
+              "description": "Expiration days"
+            },
+            "reminderDays": {
+              "type": "number",
+              "default": 7,
+              "description": "Reminder interval days"
+            }
+          },
+          "required": [
+            "provider",
+            "signers"
+          ],
+          "additionalProperties": false,
+          "description": "E-signature config"
+        },
+        "access": {
+          "type": "object",
+          "properties": {
+            "isPublic": {
+              "type": "boolean",
+              "default": false,
+              "description": "Public access"
+            },
+            "sharedWith": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Shared with"
+            },
+            "expiresAt": {
+              "type": "number",
+              "description": "Access expiration"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Access control"
+        },
+        "metadata": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Custom metadata"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "fileType",
+        "fileSize"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}