@objectstack/spec 0.3.1 → 0.3.3

package/json-schema/data/ObjectCapabilities.json

@@ -6,15 +6,18 @@
       "properties": {
         "trackHistory": {
           "type": "boolean",
-          "default": false
+          "default": false,
+          "description": "Enable field history tracking for audit compliance"
         },
         "searchable": {
           "type": "boolean",
-          "default": true
+          "default": true,
+          "description": "Index records for global search"
         },
         "apiEnabled": {
           "type": "boolean",
-          "default": true
+          "default": true,
+          "description": "Expose object via automatic APIs"
         },
         "apiMethods": {
           "type": "array",
@@ -27,10 +30,7 @@
               "update",
               "delete",
               "upsert",
-              "bulkCreate",
-              "bulkUpdate",
-              "bulkDelete",
-              "bulkUpsert",
+              "bulk",
               "aggregate",
               "history",
               "search",
@@ -40,19 +40,37 @@
               "export"
             ]
           },
-          "description": "Allowed API operations"
+          "description": "Whitelist of allowed API operations"
         },
         "files": {
           "type": "boolean",
-          "default": false
+          "default": false,
+          "description": "Enable file attachments and document management"
         },
-        "feedEnabled": {
+        "feeds": {
           "type": "boolean",
-          "default": false
+          "default": false,
+          "description": "Enable social feed, comments, and mentions (Chatter-like)"
+        },
+        "activities": {
+          "type": "boolean",
+          "default": false,
+          "description": "Enable standard tasks and events tracking"
         },
         "trash": {
           "type": "boolean",
-          "default": true
+          "default": true,
+          "description": "Enable soft-delete with restore capability"
+        },
+        "mru": {
+          "type": "boolean",
+          "default": true,
+          "description": "Track Most Recently Used (MRU) list for users"
+        },
+        "clone": {
+          "type": "boolean",
+          "default": true,
+          "description": "Allow record deep cloning"
         }
       },
       "additionalProperties": false

package/json-schema/data/Query.json

@@ -38,6 +38,198 @@
           },
           "description": "Fields to retrieve"
         },
+        "where": {
+          "allOf": [
+            {
+              "type": "object",
+              "additionalProperties": {}
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$and": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$or": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$not": {}
+              }
+            }
+          ],
+          "description": "Filtering criteria (WHERE)"
+        },
+        "orderBy": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string"
+              },
+              "order": {
+                "type": "string",
+                "enum": [
+                  "asc",
+                  "desc"
+                ],
+                "default": "asc"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Sorting instructions (ORDER BY)"
+        },
+        "limit": {
+          "type": "number",
+          "description": "Max records to return (LIMIT)"
+        },
+        "offset": {
+          "type": "number",
+          "description": "Records to skip (OFFSET)"
+        },
+        "cursor": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Cursor for keyset pagination"
+        },
+        "joins": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "inner",
+                  "left",
+                  "right",
+                  "full"
+                ],
+                "description": "Join type"
+              },
+              "strategy": {
+                "type": "string",
+                "enum": [
+                  "auto",
+                  "database",
+                  "hash",
+                  "loop"
+                ],
+                "description": "Execution strategy hint"
+              },
+              "object": {
+                "type": "string",
+                "description": "Object/table to join"
+              },
+              "alias": {
+                "type": "string",
+                "description": "Table alias"
+              },
+              "on": {
+                "allOf": [
+                  {
+                    "type": "object",
+                    "additionalProperties": {}
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "$and": {
+                        "type": "array",
+                        "items": {
+                          "allOf": [
+                            {
+                              "type": "object",
+                              "additionalProperties": {}
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "$and": {
+                                  "type": "array",
+                                  "items": {}
+                                },
+                                "$or": {
+                                  "type": "array",
+                                  "items": {}
+                                },
+                                "$not": {}
+                              }
+                            }
+                          ]
+                        }
+                      },
+                      "$or": {
+                        "type": "array",
+                        "items": {
+                          "allOf": [
+                            {
+                              "type": "object",
+                              "additionalProperties": {}
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "$and": {
+                                  "type": "array",
+                                  "items": {}
+                                },
+                                "$or": {
+                                  "type": "array",
+                                  "items": {}
+                                },
+                                "$not": {}
+                              }
+                            }
+                          ]
+                        }
+                      },
+                      "$not": {
+                        "allOf": [
+                          {
+                            "type": "object",
+                            "additionalProperties": {}
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "$and": {
+                                "type": "array",
+                                "items": {}
+                              },
+                              "$or": {
+                                "type": "array",
+                                "items": {}
+                              },
+                              "$not": {}
+                            }
+                          }
+                        ]
+                      }
+                    }
+                  }
+                ],
+                "description": "Join condition"
+              },
+              "subquery": {
+                "description": "Subquery instead of object"
+              }
+            },
+            "required": [
+              "type",
+              "object",
+              "on"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Explicit Table Joins"
+        },
         "aggregations": {
           "type": "array",
           "items": {
@@ -68,6 +260,29 @@
               "distinct": {
                 "type": "boolean",
                 "description": "Apply DISTINCT before aggregation"
+              },
+              "filter": {
+                "allOf": [
+                  {
+                    "type": "object",
+                    "additionalProperties": {}
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "$and": {
+                        "type": "array",
+                        "items": {}
+                      },
+                      "$or": {
+                        "type": "array",
+                        "items": {}
+                      },
+                      "$not": {}
+                    }
+                  }
+                ],
+                "description": "Filter/Condition to apply to the aggregation (FILTER WHERE clause)"
               }
             },
             "required": [
@@ -76,7 +291,37 @@
             ],
             "additionalProperties": false
           },
-          "description": "Aggregation functions (GROUP BY)"
+          "description": "Aggregation functions"
+        },
+        "groupBy": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "GROUP BY fields"
+        },
+        "having": {
+          "allOf": [
+            {
+              "type": "object",
+              "additionalProperties": {}
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$and": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$or": {
+                  "type": "array",
+                  "items": {}
+                },
+                "$not": {}
+              }
+            }
+          ],
+          "description": "HAVING clause for aggregation filtering"
         },
         "windowFunctions": {
           "type": "array",
@@ -180,267 +425,6 @@
           },
           "description": "Window functions with OVER clause"
         },
-        "filters": {
-          "anyOf": [
-            {
-              "type": "array",
-              "minItems": 3,
-              "maxItems": 3,
-              "items": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "string",
-                  "enum": [
-                    "=",
-                    "!=",
-                    "<>",
-                    ">",
-                    ">=",
-                    "<",
-                    "<=",
-                    "startswith",
-                    "contains",
-                    "notcontains",
-                    "between",
-                    "in",
-                    "notin",
-                    "is_null",
-                    "is_not_null"
-                  ]
-                },
-                {}
-              ]
-            },
-            {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {}
-                ]
-              }
-            }
-          ],
-          "description": "Filtering criteria"
-        },
-        "joins": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "type": {
-                "type": "string",
-                "enum": [
-                  "inner",
-                  "left",
-                  "right",
-                  "full"
-                ],
-                "description": "Join type"
-              },
-              "object": {
-                "type": "string",
-                "description": "Object/table to join"
-              },
-              "alias": {
-                "type": "string",
-                "description": "Table alias"
-              },
-              "on": {
-                "anyOf": [
-                  {
-                    "type": "array",
-                    "minItems": 3,
-                    "maxItems": 3,
-                    "items": [
-                      {
-                        "type": "string"
-                      },
-                      {
-                        "type": "string",
-                        "enum": [
-                          "=",
-                          "!=",
-                          "<>",
-                          ">",
-                          ">=",
-                          "<",
-                          "<=",
-                          "startswith",
-                          "contains",
-                          "notcontains",
-                          "between",
-                          "in",
-                          "notin",
-                          "is_null",
-                          "is_not_null"
-                        ]
-                      },
-                      {}
-                    ]
-                  },
-                  {
-                    "type": "array",
-                    "items": {
-                      "anyOf": [
-                        {
-                          "type": "string"
-                        },
-                        {
-                          "anyOf": [
-                            {
-                              "type": "array",
-                              "minItems": 3,
-                              "maxItems": 3,
-                              "items": [
-                                {
-                                  "type": "string"
-                                },
-                                {
-                                  "type": "string",
-                                  "enum": [
-                                    "=",
-                                    "!=",
-                                    "<>",
-                                    ">",
-                                    ">=",
-                                    "<",
-                                    "<=",
-                                    "startswith",
-                                    "contains",
-                                    "notcontains",
-                                    "between",
-                                    "in",
-                                    "notin",
-                                    "is_null",
-                                    "is_not_null"
-                                  ]
-                                },
-                                {}
-                              ]
-                            },
-                            {
-                              "type": "array",
-                              "items": {
-                                "anyOf": [
-                                  {
-                                    "type": "string"
-                                  },
-                                  {}
-                                ]
-                              }
-                            }
-                          ]
-                        }
-                      ]
-                    }
-                  }
-                ],
-                "description": "Join condition"
-              },
-              "subquery": {
-                "description": "Subquery instead of object"
-              }
-            },
-            "required": [
-              "type",
-              "object",
-              "on"
-            ],
-            "additionalProperties": false
-          },
-          "description": "Table joins"
-        },
-        "groupBy": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "GROUP BY fields"
-        },
-        "having": {
-          "anyOf": [
-            {
-              "type": "array",
-              "minItems": 3,
-              "maxItems": 3,
-              "items": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "string",
-                  "enum": [
-                    "=",
-                    "!=",
-                    "<>",
-                    ">",
-                    ">=",
-                    "<",
-                    "<=",
-                    "startswith",
-                    "contains",
-                    "notcontains",
-                    "between",
-                    "in",
-                    "notin",
-                    "is_null",
-                    "is_not_null"
-                  ]
-                },
-                {}
-              ]
-            },
-            {
-              "type": "array",
-              "items": {
-                "anyOf": [
-                  {
-                    "type": "string"
-                  },
-                  {}
-                ]
-              }
-            }
-          ],
-          "description": "HAVING clause for aggregation filtering"
-        },
-        "sort": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "field": {
-                "type": "string"
-              },
-              "order": {
-                "type": "string",
-                "enum": [
-                  "asc",
-                  "desc"
-                ],
-                "default": "asc"
-              }
-            },
-            "required": [
-              "field"
-            ],
-            "additionalProperties": false
-          },
-          "description": "Sorting instructions"
-        },
-        "top": {
-          "type": "number",
-          "description": "Limit results"
-        },
-        "skip": {
-          "type": "number",
-          "description": "Offset results"
-        },
         "distinct": {
           "type": "boolean",
           "description": "SELECT DISTINCT flag"

package/json-schema/data/RangeOperator.json

@@ -17,6 +17,19 @@
                 {
                   "type": "string",
                   "format": "date-time"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$field": {
+                      "type": "string",
+                      "description": "Field Reference/Column Name"
+                    }
+                  },
+                  "required": [
+                    "$field"
+                  ],
+                  "additionalProperties": false
                 }
               ]
             },
@@ -28,6 +41,19 @@
                 {
                   "type": "string",
                   "format": "date-time"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$field": {
+                      "type": "string",
+                      "description": "Field Reference/Column Name"
+                    }
+                  },
+                  "required": [
+                    "$field"
+                  ],
+                  "additionalProperties": false
                 }
               ]
             }

package/json-schema/data/ScriptValidation.json

@@ -7,12 +7,43 @@
         "name": {
           "type": "string",
           "pattern": "^[a-z_][a-z0-9_]*$",
-          "description": "Unique rule name"
+          "description": "Unique rule name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Human-readable label for the rule listing"
+        },
+        "description": {
+          "type": "string",
+          "description": "Administrative notes explaining the business reason"
         },
         "active": {
           "type": "boolean",
           "default": true
         },
+        "events": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "insert",
+              "update",
+              "delete"
+            ]
+          },
+          "default": [
+            "insert",
+            "update"
+          ],
+          "description": "Validation contexts"
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Categorization tags (e.g., \"compliance\", \"billing\")"
+        },
         "severity": {
           "type": "string",
           "enum": [
@@ -24,7 +55,7 @@
         },
         "message": {
           "type": "string",
-          "description": "Error message to display"
+          "description": "Error message to display to the user"
         },
         "type": {
           "type": "string",