@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/CreateRequest.json

@@ -0,0 +1,20 @@
+{
+  "$ref": "#/definitions/CreateRequest",
+  "definitions": {
+    "CreateRequest": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Record data to insert"
+        }
+      },
+      "required": [
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/CrossFieldValidation.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/CrossFieldValidation",
+  "definitions": {
+    "CrossFieldValidation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "cross_field"
+        },
+        "condition": {
+          "type": "string",
+          "description": "Formula expression comparing fields (e.g. \"end_date > start_date\")"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields involved in the validation"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "condition",
+        "fields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/CustomValidator.json

@@ -0,0 +1,57 @@
+{
+  "$ref": "#/definitions/CustomValidator",
+  "definitions": {
+    "CustomValidator": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "custom"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to validate (optional for record-level validation)"
+        },
+        "validatorFunction": {
+          "type": "string",
+          "description": "Function name or reference to custom validator"
+        },
+        "params": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional parameters for the validator"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "validatorFunction"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Dashboard.json

@@ -0,0 +1,117 @@
+{
+  "$ref": "#/definitions/Dashboard",
+  "definitions": {
+    "Dashboard": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Dashboard unique name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Dashboard label"
+        },
+        "description": {
+          "type": "string",
+          "description": "Dashboard description"
+        },
+        "widgets": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "title": {
+                "type": "string",
+                "description": "Widget title"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "metric",
+                  "bar",
+                  "line",
+                  "pie",
+                  "donut",
+                  "funnel",
+                  "table",
+                  "text"
+                ],
+                "default": "metric",
+                "description": "Visualization type"
+              },
+              "object": {
+                "type": "string",
+                "description": "Data source object name"
+              },
+              "filter": {
+                "description": "Data filter criteria"
+              },
+              "categoryField": {
+                "type": "string",
+                "description": "Field for grouping (X-Axis)"
+              },
+              "valueField": {
+                "type": "string",
+                "description": "Field for values (Y-Axis)"
+              },
+              "aggregate": {
+                "type": "string",
+                "enum": [
+                  "count",
+                  "sum",
+                  "avg",
+                  "min",
+                  "max"
+                ],
+                "default": "count",
+                "description": "Aggregate function"
+              },
+              "layout": {
+                "type": "object",
+                "properties": {
+                  "x": {
+                    "type": "number"
+                  },
+                  "y": {
+                    "type": "number"
+                  },
+                  "w": {
+                    "type": "number"
+                  },
+                  "h": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "x",
+                  "y",
+                  "w",
+                  "h"
+                ],
+                "additionalProperties": false,
+                "description": "Grid layout position"
+              },
+              "options": {
+                "description": "Widget specific configuration"
+              }
+            },
+            "required": [
+              "layout"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Widgets to display"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "widgets"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DashboardNavItem.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/DashboardNavItem",
+  "definitions": {
+    "DashboardNavItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for this navigation item"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display proper label"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon name"
+        },
+        "visible": {
+          "type": "string",
+          "description": "Visibility formula condition"
+        },
+        "type": {
+          "type": "string",
+          "const": "dashboard"
+        },
+        "dashboardName": {
+          "type": "string",
+          "description": "Target dashboard name"
+        }
+      },
+      "required": [
+        "id",
+        "label",
+        "type",
+        "dashboardName"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DashboardWidget.json

@@ -0,0 +1,89 @@
+{
+  "$ref": "#/definitions/DashboardWidget",
+  "definitions": {
+    "DashboardWidget": {
+      "type": "object",
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "Widget title"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "metric",
+            "bar",
+            "line",
+            "pie",
+            "donut",
+            "funnel",
+            "table",
+            "text"
+          ],
+          "default": "metric",
+          "description": "Visualization type"
+        },
+        "object": {
+          "type": "string",
+          "description": "Data source object name"
+        },
+        "filter": {
+          "description": "Data filter criteria"
+        },
+        "categoryField": {
+          "type": "string",
+          "description": "Field for grouping (X-Axis)"
+        },
+        "valueField": {
+          "type": "string",
+          "description": "Field for values (Y-Axis)"
+        },
+        "aggregate": {
+          "type": "string",
+          "enum": [
+            "count",
+            "sum",
+            "avg",
+            "min",
+            "max"
+          ],
+          "default": "count",
+          "description": "Aggregate function"
+        },
+        "layout": {
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number"
+            },
+            "y": {
+              "type": "number"
+            },
+            "w": {
+              "type": "number"
+            },
+            "h": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "x",
+            "y",
+            "w",
+            "h"
+          ],
+          "additionalProperties": false,
+          "description": "Grid layout position"
+        },
+        "options": {
+          "description": "Widget specific configuration"
+        }
+      },
+      "required": [
+        "layout"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Dataset.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/Dataset",
+  "definitions": {
+    "Dataset": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Target Object Name"
+        },
+        "externalId": {
+          "type": "string",
+          "default": "name",
+          "description": "Field match for uniqueness check"
+        },
+        "mode": {
+          "type": "string",
+          "enum": [
+            "insert",
+            "update",
+            "upsert",
+            "replace",
+            "ignore"
+          ],
+          "default": "upsert",
+          "description": "Conflict resolution strategy"
+        },
+        "env": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "prod",
+              "dev",
+              "test"
+            ]
+          },
+          "default": [
+            "prod",
+            "dev",
+            "test"
+          ],
+          "description": "Applicable environments"
+        },
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {}
+          },
+          "description": "Data records"
+        }
+      },
+      "required": [
+        "object",
+        "records"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DatasetMode.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/DatasetMode",
+  "definitions": {
+    "DatasetMode": {
+      "type": "string",
+      "enum": [
+        "insert",
+        "update",
+        "upsert",
+        "replace",
+        "ignore"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Datasource.json

@@ -0,0 +1,75 @@
+{
+  "$ref": "#/definitions/Datasource",
+  "definitions": {
+    "Datasource": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique datasource identifier"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "driver": {
+          "type": "string",
+          "description": "Underlying driver type"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Driver specific configuration"
+        },
+        "capabilities": {
+          "type": "object",
+          "properties": {
+            "joins": {
+              "type": "boolean",
+              "default": false
+            },
+            "transactions": {
+              "type": "boolean",
+              "default": false
+            },
+            "fullTextSearch": {
+              "type": "boolean",
+              "default": false
+            },
+            "aggregation": {
+              "type": "boolean",
+              "default": false
+            },
+            "dynamicSchema": {
+              "type": "boolean",
+              "default": false
+            },
+            "readOnly": {
+              "type": "boolean",
+              "default": false
+            }
+          },
+          "additionalProperties": false,
+          "description": "Capability overrides"
+        },
+        "description": {
+          "type": "string",
+          "description": "Internal description"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true,
+          "description": "Is datasource enabled"
+        }
+      },
+      "required": [
+        "name",
+        "driver",
+        "config"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DatasourceCapabilities.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/DatasourceCapabilities",
+  "definitions": {
+    "DatasourceCapabilities": {
+      "type": "object",
+      "properties": {
+        "joins": {
+          "type": "boolean",
+          "default": false
+        },
+        "transactions": {
+          "type": "boolean",
+          "default": false
+        },
+        "fullTextSearch": {
+          "type": "boolean",
+          "default": false
+        },
+        "aggregation": {
+          "type": "boolean",
+          "default": false
+        },
+        "dynamicSchema": {
+          "type": "boolean",
+          "default": false
+        },
+        "readOnly": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/DeleteResponse.json

@@ -0,0 +1,68 @@
+{
+  "$ref": "#/definitions/DeleteResponse",
+  "definitions": {
+    "DeleteResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        },
+        "id": {
+          "type": "string",
+          "description": "ID of the deleted record"
+        }
+      },
+      "required": [
+        "success",
+        "id"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}