@objectstack/spec 0.3.1 → 0.3.3

package/json-schema/data/CrossFieldValidation.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",

package/json-schema/data/CurrencyConfig.json

@@ -0,0 +1,35 @@
+{
+  "$ref": "#/definitions/CurrencyConfig",
+  "definitions": {
+    "CurrencyConfig": {
+      "type": "object",
+      "properties": {
+        "precision": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 10,
+          "default": 2,
+          "description": "Decimal precision (default: 2)"
+        },
+        "currencyMode": {
+          "type": "string",
+          "enum": [
+            "dynamic",
+            "fixed"
+          ],
+          "default": "dynamic",
+          "description": "Currency mode: dynamic (user selectable) or fixed (single currency)"
+        },
+        "defaultCurrency": {
+          "type": "string",
+          "minLength": 3,
+          "maxLength": 3,
+          "default": "CNY",
+          "description": "Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/CurrencyValue.json

@@ -0,0 +1,26 @@
+{
+  "$ref": "#/definitions/CurrencyValue",
+  "definitions": {
+    "CurrencyValue": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "type": "number",
+          "description": "Monetary amount"
+        },
+        "currency": {
+          "type": "string",
+          "minLength": 3,
+          "maxLength": 3,
+          "description": "Currency code (ISO 4217)"
+        }
+      },
+      "required": [
+        "value",
+        "currency"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/CustomValidator.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,31 +55,27 @@
         },
         "message": {
           "type": "string",
-          "description": "Error message to display"
+          "description": "Error message to display to the user"
         },
         "type": {
           "type": "string",
           "const": "custom"
         },
-        "field": {
-          "type": "string",
-          "description": "Field to validate (optional for record-level validation)"
-        },
-        "validatorFunction": {
+        "handler": {
           "type": "string",
-          "description": "Function name or reference to custom validator"
+          "description": "Name of the custom validation function registered in the system"
         },
         "params": {
           "type": "object",
           "additionalProperties": {},
-          "description": "Additional parameters for the validator"
+          "description": "Parameters passed to the custom handler"
         }
       },
       "required": [
         "name",
         "message",
         "type",
-        "validatorFunction"
+        "handler"
       ],
       "additionalProperties": false
     }

package/json-schema/data/Field.json

@@ -303,6 +303,36 @@
           "type": "boolean",
           "description": "Enable camera scanning for barcode/QR code input"
         },
+        "currencyConfig": {
+          "type": "object",
+          "properties": {
+            "precision": {
+              "type": "integer",
+              "minimum": 0,
+              "maximum": 10,
+              "default": 2,
+              "description": "Decimal precision (default: 2)"
+            },
+            "currencyMode": {
+              "type": "string",
+              "enum": [
+                "dynamic",
+                "fixed"
+              ],
+              "default": "dynamic",
+              "description": "Currency mode: dynamic (user selectable) or fixed (single currency)"
+            },
+            "defaultCurrency": {
+              "type": "string",
+              "minLength": 3,
+              "maxLength": 3,
+              "default": "CNY",
+              "description": "Default or fixed currency code (ISO 4217, e.g., USD, CNY, EUR)"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Configuration for currency field type"
+        },
         "hidden": {
           "type": "boolean",
           "default": false,

package/json-schema/data/FieldOperators.json

@@ -14,6 +14,19 @@
             {
               "type": "string",
               "format": "date-time"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$field": {
+                  "type": "string",
+                  "description": "Field Reference/Column Name"
+                }
+              },
+              "required": [
+                "$field"
+              ],
+              "additionalProperties": false
             }
           ]
         },
@@ -25,6 +38,19 @@
             {
               "type": "string",
               "format": "date-time"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$field": {
+                  "type": "string",
+                  "description": "Field Reference/Column Name"
+                }
+              },
+              "required": [
+                "$field"
+              ],
+              "additionalProperties": false
             }
           ]
         },
@@ -36,6 +62,19 @@
             {
               "type": "string",
               "format": "date-time"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$field": {
+                  "type": "string",
+                  "description": "Field Reference/Column Name"
+                }
+              },
+              "required": [
+                "$field"
+              ],
+              "additionalProperties": false
             }
           ]
         },
@@ -47,6 +86,19 @@
             {
               "type": "string",
               "format": "date-time"
+            },
+            {
+              "type": "object",
+              "properties": {
+                "$field": {
+                  "type": "string",
+                  "description": "Field Reference/Column Name"
+                }
+              },
+              "required": [
+                "$field"
+              ],
+              "additionalProperties": false
             }
           ]
         },
@@ -69,6 +121,19 @@
                 {
                   "type": "string",
                   "format": "date-time"
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$field": {
+                      "type": "string",
+                      "description": "Field Reference/Column Name"
+                    }
+                  },
+                  "required": [
+                    "$field"
+                  ],
+                  "additionalProperties": false
                 }
               ]
             },
@@ -80,6 +145,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/FieldReference.json

@@ -0,0 +1,19 @@
+{
+  "$ref": "#/definitions/FieldReference",
+  "definitions": {
+    "FieldReference": {
+      "type": "object",
+      "properties": {
+        "$field": {
+          "type": "string",
+          "description": "Field Reference/Column Name"
+        }
+      },
+      "required": [
+        "$field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/FormatValidation.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",

package/json-schema/data/Hook.json

@@ -0,0 +1,95 @@
+{
+  "$ref": "#/definitions/Hook",
+  "definitions": {
+    "Hook": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Hook unique name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Description of what this hook does"
+        },
+        "object": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Target object(s)"
+        },
+        "events": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "beforeFind",
+              "afterFind",
+              "beforeFindOne",
+              "afterFindOne",
+              "beforeCount",
+              "afterCount",
+              "beforeAggregate",
+              "afterAggregate",
+              "beforeInsert",
+              "afterInsert",
+              "beforeUpdate",
+              "afterUpdate",
+              "beforeDelete",
+              "afterDelete",
+              "beforeUpdateMany",
+              "afterUpdateMany",
+              "beforeDeleteMany",
+              "afterDeleteMany"
+            ]
+          },
+          "description": "Lifecycle events"
+        },
+        "handler": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {}
+          ],
+          "description": "Function handler name or direct function"
+        },
+        "priority": {
+          "type": "number",
+          "default": 100,
+          "description": "Execution priority"
+        },
+        "async": {
+          "type": "boolean",
+          "default": false,
+          "description": "Run specifically as fire-and-forget"
+        },
+        "onError": {
+          "type": "string",
+          "enum": [
+            "abort",
+            "log"
+          ],
+          "default": "abort",
+          "description": "Error handling strategy"
+        }
+      },
+      "required": [
+        "name",
+        "object",
+        "events"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/HookContext.json

@@ -0,0 +1,88 @@
+{
+  "$ref": "#/definitions/HookContext",
+  "definitions": {
+    "HookContext": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique execution ID for tracing"
+        },
+        "object": {
+          "type": "string"
+        },
+        "event": {
+          "type": "string",
+          "enum": [
+            "beforeFind",
+            "afterFind",
+            "beforeFindOne",
+            "afterFindOne",
+            "beforeCount",
+            "afterCount",
+            "beforeAggregate",
+            "afterAggregate",
+            "beforeInsert",
+            "afterInsert",
+            "beforeUpdate",
+            "afterUpdate",
+            "beforeDelete",
+            "afterDelete",
+            "beforeUpdateMany",
+            "afterUpdateMany",
+            "beforeDeleteMany",
+            "afterDeleteMany"
+          ]
+        },
+        "input": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Mutable input parameters"
+        },
+        "result": {
+          "description": "Operation result (After hooks only)"
+        },
+        "previous": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Record state before operation"
+        },
+        "session": {
+          "type": "object",
+          "properties": {
+            "userId": {
+              "type": "string"
+            },
+            "tenantId": {
+              "type": "string"
+            },
+            "roles": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "accessToken": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Current session context"
+        },
+        "transaction": {
+          "description": "Database transaction handle"
+        },
+        "ql": {
+          "description": "ObjectQL Engine Reference"
+        }
+      },
+      "required": [
+        "object",
+        "event",
+        "input"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/HookEvent.json

@@ -0,0 +1,29 @@
+{
+  "$ref": "#/definitions/HookEvent",
+  "definitions": {
+    "HookEvent": {
+      "type": "string",
+      "enum": [
+        "beforeFind",
+        "afterFind",
+        "beforeFindOne",
+        "afterFindOne",
+        "beforeCount",
+        "afterCount",
+        "beforeAggregate",
+        "afterAggregate",
+        "beforeInsert",
+        "afterInsert",
+        "beforeUpdate",
+        "afterUpdate",
+        "beforeDelete",
+        "afterDelete",
+        "beforeUpdateMany",
+        "afterUpdateMany",
+        "beforeDeleteMany",
+        "afterDeleteMany"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/data/Index.json

@@ -18,6 +18,16 @@
         "unique": {
           "type": "boolean",
           "description": "Whether the index is unique"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "btree",
+            "hash",
+            "gin",
+            "gist"
+          ],
+          "description": "Index type (default: btree)"
         }
       },
       "required": [