@objectstack/spec 0.1.0 → 0.1.1

package/json-schema/Query.json

@@ -0,0 +1,128 @@
+{
+  "$ref": "#/definitions/Query",
+  "definitions": {
+    "Query": {
+      "type": "object",
+      "properties": {
+        "object": {
+          "type": "string",
+          "description": "Object name (e.g. account)"
+        },
+        "fields": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string"
+                  },
+                  "fields": {
+                    "type": "array",
+                    "items": {}
+                  },
+                  "alias": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "field"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "description": "Fields to retrieve"
+        },
+        "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"
+        },
+        "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"
+        }
+      },
+      "required": [
+        "object"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/RateLimit.json

@@ -0,0 +1,26 @@
+{
+  "$ref": "#/definitions/RateLimit",
+  "definitions": {
+    "RateLimit": {
+      "type": "object",
+      "properties": {
+        "enabled": {
+          "type": "boolean",
+          "default": false
+        },
+        "windowMs": {
+          "type": "number",
+          "default": 60000,
+          "description": "Time window in milliseconds"
+        },
+        "maxRequests": {
+          "type": "number",
+          "default": 100,
+          "description": "Max requests per window"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Report.json

@@ -0,0 +1,219 @@
+{
+  "$ref": "#/definitions/Report",
+  "definitions": {
+    "Report": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Report unique name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Report label"
+        },
+        "description": {
+          "type": "string"
+        },
+        "objectName": {
+          "type": "string",
+          "description": "Primary object"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "tabular",
+            "summary",
+            "matrix",
+            "joined"
+          ],
+          "default": "tabular",
+          "description": "Report format type"
+        },
+        "columns": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string",
+                "description": "Field name"
+              },
+              "label": {
+                "type": "string",
+                "description": "Override label"
+              },
+              "aggregate": {
+                "type": "string",
+                "enum": [
+                  "sum",
+                  "avg",
+                  "max",
+                  "min",
+                  "count",
+                  "unique"
+                ],
+                "description": "Aggregation function"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Columns to display"
+        },
+        "groupingsDown": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string",
+                "description": "Field to group by"
+              },
+              "sortOrder": {
+                "type": "string",
+                "enum": [
+                  "asc",
+                  "desc"
+                ],
+                "default": "asc"
+              },
+              "dateGranularity": {
+                "type": "string",
+                "enum": [
+                  "day",
+                  "week",
+                  "month",
+                  "quarter",
+                  "year"
+                ],
+                "description": "For date fields"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Row groupings"
+        },
+        "groupingsAcross": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "field": {
+                "type": "string",
+                "description": "Field to group by"
+              },
+              "sortOrder": {
+                "type": "string",
+                "enum": [
+                  "asc",
+                  "desc"
+                ],
+                "default": "asc"
+              },
+              "dateGranularity": {
+                "type": "string",
+                "enum": [
+                  "day",
+                  "week",
+                  "month",
+                  "quarter",
+                  "year"
+                ],
+                "description": "For date fields"
+              }
+            },
+            "required": [
+              "field"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Column groupings (Matrix only)"
+        },
+        "filter": {
+          "type": "string",
+          "description": "Filter logic (e.g. \"1 AND (2 OR 3)\")"
+        },
+        "filterItems": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "number"
+              },
+              "field": {
+                "type": "string"
+              },
+              "operator": {
+                "type": "string"
+              },
+              "value": {}
+            },
+            "required": [
+              "id",
+              "field",
+              "operator"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Filter criteria lines"
+        },
+        "chart": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "bar",
+                "column",
+                "line",
+                "pie",
+                "donut",
+                "scatter",
+                "funnel"
+              ],
+              "description": "Chart type"
+            },
+            "title": {
+              "type": "string"
+            },
+            "showLegend": {
+              "type": "boolean",
+              "default": true
+            },
+            "xAxis": {
+              "type": "string",
+              "description": "Grouping field for X-Axis"
+            },
+            "yAxis": {
+              "type": "string",
+              "description": "Summary field for Y-Axis"
+            }
+          },
+          "required": [
+            "type",
+            "xAxis",
+            "yAxis"
+          ],
+          "additionalProperties": false,
+          "description": "Embedded chart configuration"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "objectName",
+        "columns"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ReportChart.json

@@ -0,0 +1,45 @@
+{
+  "$ref": "#/definitions/ReportChart",
+  "definitions": {
+    "ReportChart": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": [
+            "bar",
+            "column",
+            "line",
+            "pie",
+            "donut",
+            "scatter",
+            "funnel"
+          ],
+          "description": "Chart type"
+        },
+        "title": {
+          "type": "string"
+        },
+        "showLegend": {
+          "type": "boolean",
+          "default": true
+        },
+        "xAxis": {
+          "type": "string",
+          "description": "Grouping field for X-Axis"
+        },
+        "yAxis": {
+          "type": "string",
+          "description": "Summary field for Y-Axis"
+        }
+      },
+      "required": [
+        "type",
+        "xAxis",
+        "yAxis"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ReportColumn.json

@@ -0,0 +1,35 @@
+{
+  "$ref": "#/definitions/ReportColumn",
+  "definitions": {
+    "ReportColumn": {
+      "type": "object",
+      "properties": {
+        "field": {
+          "type": "string",
+          "description": "Field name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Override label"
+        },
+        "aggregate": {
+          "type": "string",
+          "enum": [
+            "sum",
+            "avg",
+            "max",
+            "min",
+            "count",
+            "unique"
+          ],
+          "description": "Aggregation function"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ReportGrouping.json

@@ -0,0 +1,38 @@
+{
+  "$ref": "#/definitions/ReportGrouping",
+  "definitions": {
+    "ReportGrouping": {
+      "type": "object",
+      "properties": {
+        "field": {
+          "type": "string",
+          "description": "Field to group by"
+        },
+        "sortOrder": {
+          "type": "string",
+          "enum": [
+            "asc",
+            "desc"
+          ],
+          "default": "asc"
+        },
+        "dateGranularity": {
+          "type": "string",
+          "enum": [
+            "day",
+            "week",
+            "month",
+            "quarter",
+            "year"
+          ],
+          "description": "For date fields"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ReportType.json

@@ -0,0 +1,15 @@
+{
+  "$ref": "#/definitions/ReportType",
+  "definitions": {
+    "ReportType": {
+      "type": "string",
+      "enum": [
+        "tabular",
+        "summary",
+        "matrix",
+        "joined"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Role.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/Role",
+  "definitions": {
+    "Role": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique role name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label (e.g. VP of Sales)"
+        },
+        "parent": {
+          "type": "string",
+          "description": "Parent Role ID (Reports To)"
+        },
+        "description": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SAMLConfig.json

@@ -0,0 +1,44 @@
+{
+  "$ref": "#/definitions/SAMLConfig",
+  "definitions": {
+    "SAMLConfig": {
+      "type": "object",
+      "properties": {
+        "entryPoint": {
+          "type": "string",
+          "format": "uri",
+          "description": "IdP SSO URL"
+        },
+        "cert": {
+          "type": "string",
+          "description": "IdP Public Certificate"
+        },
+        "issuer": {
+          "type": "string",
+          "description": "Entity ID of the IdP"
+        },
+        "signatureAlgorithm": {
+          "type": "string",
+          "enum": [
+            "sha256",
+            "sha512"
+          ],
+          "default": "sha256"
+        },
+        "attributeMapping": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "entryPoint",
+        "cert",
+        "issuer"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ScriptValidation.json

@@ -0,0 +1,48 @@
+{
+  "$ref": "#/definitions/ScriptValidation",
+  "definitions": {
+    "ScriptValidation": {
+      "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": "script"
+        },
+        "condition": {
+          "type": "string",
+          "description": "Formula expression. If TRUE, validation fails. (e.g. amount < 0)"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "condition"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SelectOption.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/SelectOption",
+  "definitions": {
+    "SelectOption": {
+      "type": "object",
+      "properties": {
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "value": {
+          "type": "string",
+          "description": "Stored value"
+        },
+        "color": {
+          "type": "string",
+          "description": "Color code for badges/charts"
+        },
+        "default": {
+          "type": "boolean",
+          "description": "Is default option"
+        }
+      },
+      "required": [
+        "label",
+        "value"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/SessionPolicy.json

@@ -0,0 +1,27 @@
+{
+  "$ref": "#/definitions/SessionPolicy",
+  "definitions": {
+    "SessionPolicy": {
+      "type": "object",
+      "properties": {
+        "idleTimeout": {
+          "type": "number",
+          "default": 30,
+          "description": "Minutes before idle session logout"
+        },
+        "absoluteTimeout": {
+          "type": "number",
+          "default": 480,
+          "description": "Max session duration (minutes)"
+        },
+        "forceMfa": {
+          "type": "boolean",
+          "default": false,
+          "description": "Require 2FA for all users"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}