@objectstack/spec 0.6.1 → 0.7.1

package/json-schema/api/SavedView.json

@@ -0,0 +1,1074 @@
+{
+  "$ref": "#/definitions/SavedView",
+  "definitions": {
+    "SavedView": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique view identifier"
+        },
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "View machine name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "description": {
+          "type": "string",
+          "description": "View description"
+        },
+        "object": {
+          "type": "string",
+          "description": "Object/table this view is for"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "list",
+            "kanban",
+            "calendar",
+            "gantt",
+            "timeline",
+            "chart",
+            "pivot",
+            "custom"
+          ],
+          "description": "View type"
+        },
+        "visibility": {
+          "type": "string",
+          "enum": [
+            "private",
+            "shared",
+            "public",
+            "organization"
+          ],
+          "description": "Who can access this view"
+        },
+        "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"
+            },
+            "where": {
+              "allOf": [
+                {
+                  "type": "object",
+                  "additionalProperties": {}
+                },
+                {
+                  "type": "object",
+                  "properties": {
+                    "$and": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$or": {
+                      "type": "array",
+                      "items": {}
+                    },
+                    "$not": {}
+                  }
+                }
+              ],
+              "description": "Filtering criteria (WHERE)"
+            },
+            "search": {
+              "type": "object",
+              "properties": {
+                "query": {
+                  "type": "string",
+                  "description": "Search query text"
+                },
+                "fields": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "Fields to search in (if not specified, searches all text fields)"
+                },
+                "fuzzy": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "Enable fuzzy matching (tolerates typos)"
+                },
+                "operator": {
+                  "type": "string",
+                  "enum": [
+                    "and",
+                    "or"
+                  ],
+                  "default": "or",
+                  "description": "Logical operator between terms"
+                },
+                "boost": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "number"
+                  },
+                  "description": "Field-specific relevance boosting (field name -> boost factor)"
+                },
+                "minScore": {
+                  "type": "number",
+                  "description": "Minimum relevance score threshold"
+                },
+                "language": {
+                  "type": "string",
+                  "description": "Language for text analysis (e.g., \"en\", \"zh\", \"es\")"
+                },
+                "highlight": {
+                  "type": "boolean",
+                  "default": false,
+                  "description": "Enable search result highlighting"
+                }
+              },
+              "required": [
+                "query"
+              ],
+              "additionalProperties": false,
+              "description": "Full-text search configuration ($search parameter)"
+            },
+            "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": {
+                    "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"
+                      },
+                      "where": {
+                        "allOf": [
+                          {
+                            "type": "object",
+                            "additionalProperties": {}
+                          },
+                          {
+                            "type": "object",
+                            "properties": {
+                              "$and": {
+                                "type": "array",
+                                "items": {}
+                              },
+                              "$or": {
+                                "type": "array",
+                                "items": {}
+                              },
+                              "$not": {}
+                            }
+                          }
+                        ],
+                        "description": "Filtering criteria (WHERE)"
+                      },
+                      "search": {
+                        "type": "object",
+                        "properties": {
+                          "query": {
+                            "type": "string",
+                            "description": "Search query text"
+                          },
+                          "fields": {
+                            "type": "array",
+                            "items": {
+                              "type": "string"
+                            },
+                            "description": "Fields to search in (if not specified, searches all text fields)"
+                          },
+                          "fuzzy": {
+                            "type": "boolean",
+                            "default": false,
+                            "description": "Enable fuzzy matching (tolerates typos)"
+                          },
+                          "operator": {
+                            "type": "string",
+                            "enum": [
+                              "and",
+                              "or"
+                            ],
+                            "default": "or",
+                            "description": "Logical operator between terms"
+                          },
+                          "boost": {
+                            "type": "object",
+                            "additionalProperties": {
+                              "type": "number"
+                            },
+                            "description": "Field-specific relevance boosting (field name -> boost factor)"
+                          },
+                          "minScore": {
+                            "type": "number",
+                            "description": "Minimum relevance score threshold"
+                          },
+                          "language": {
+                            "type": "string",
+                            "description": "Language for text analysis (e.g., \"en\", \"zh\", \"es\")"
+                          },
+                          "highlight": {
+                            "type": "boolean",
+                            "default": false,
+                            "description": "Enable search result highlighting"
+                          }
+                        },
+                        "required": [
+                          "query"
+                        ],
+                        "additionalProperties": false,
+                        "description": "Full-text search configuration ($search parameter)"
+                      },
+                      "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": {},
+                      "aggregations": {
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "function": {
+                              "type": "string",
+                              "enum": [
+                                "count",
+                                "sum",
+                                "avg",
+                                "min",
+                                "max",
+                                "count_distinct",
+                                "array_agg",
+                                "string_agg"
+                              ],
+                              "description": "Aggregation function"
+                            },
+                            "field": {
+                              "type": "string",
+                              "description": "Field to aggregate (optional for COUNT(*))"
+                            },
+                            "alias": {
+                              "type": "string",
+                              "description": "Result column alias"
+                            },
+                            "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": [
+                            "function",
+                            "alias"
+                          ],
+                          "additionalProperties": false
+                        },
+                        "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",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "function": {
+                              "type": "string",
+                              "enum": [
+                                "row_number",
+                                "rank",
+                                "dense_rank",
+                                "percent_rank",
+                                "lag",
+                                "lead",
+                                "first_value",
+                                "last_value",
+                                "sum",
+                                "avg",
+                                "count",
+                                "min",
+                                "max"
+                              ],
+                              "description": "Window function name"
+                            },
+                            "field": {
+                              "type": "string",
+                              "description": "Field to operate on (for aggregate window functions)"
+                            },
+                            "alias": {
+                              "type": "string",
+                              "description": "Result column alias"
+                            },
+                            "over": {
+                              "type": "object",
+                              "properties": {
+                                "partitionBy": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "string"
+                                  },
+                                  "description": "PARTITION BY fields"
+                                },
+                                "orderBy": {
+                                  "type": "array",
+                                  "items": {
+                                    "type": "object",
+                                    "properties": {
+                                      "field": {
+                                        "type": "string"
+                                      },
+                                      "order": {
+                                        "type": "string",
+                                        "enum": [
+                                          "asc",
+                                          "desc"
+                                        ],
+                                        "default": "asc"
+                                      }
+                                    },
+                                    "required": [
+                                      "field"
+                                    ],
+                                    "additionalProperties": false
+                                  },
+                                  "description": "ORDER BY specification"
+                                },
+                                "frame": {
+                                  "type": "object",
+                                  "properties": {
+                                    "type": {
+                                      "type": "string",
+                                      "enum": [
+                                        "rows",
+                                        "range"
+                                      ]
+                                    },
+                                    "start": {
+                                      "type": "string",
+                                      "description": "Frame start (e.g., \"UNBOUNDED PRECEDING\", \"1 PRECEDING\")"
+                                    },
+                                    "end": {
+                                      "type": "string",
+                                      "description": "Frame end (e.g., \"CURRENT ROW\", \"1 FOLLOWING\")"
+                                    }
+                                  },
+                                  "additionalProperties": false,
+                                  "description": "Window frame specification"
+                                }
+                              },
+                              "additionalProperties": false,
+                              "description": "Window specification (OVER clause)"
+                            }
+                          },
+                          "required": [
+                            "function",
+                            "alias",
+                            "over"
+                          ],
+                          "additionalProperties": false
+                        },
+                        "description": "Window functions with OVER clause"
+                      },
+                      "distinct": {
+                        "type": "boolean",
+                        "description": "SELECT DISTINCT flag"
+                      }
+                    },
+                    "required": [
+                      "object"
+                    ],
+                    "additionalProperties": false,
+                    "description": "Subquery instead of object"
+                  }
+                },
+                "required": [
+                  "type",
+                  "object",
+                  "on"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Explicit Table Joins"
+            },
+            "aggregations": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "function": {
+                    "type": "string",
+                    "enum": [
+                      "count",
+                      "sum",
+                      "avg",
+                      "min",
+                      "max",
+                      "count_distinct",
+                      "array_agg",
+                      "string_agg"
+                    ],
+                    "description": "Aggregation function"
+                  },
+                  "field": {
+                    "type": "string",
+                    "description": "Field to aggregate (optional for COUNT(*))"
+                  },
+                  "alias": {
+                    "type": "string",
+                    "description": "Result column alias"
+                  },
+                  "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": [
+                  "function",
+                  "alias"
+                ],
+                "additionalProperties": false
+              },
+              "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",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "function": {
+                    "type": "string",
+                    "enum": [
+                      "row_number",
+                      "rank",
+                      "dense_rank",
+                      "percent_rank",
+                      "lag",
+                      "lead",
+                      "first_value",
+                      "last_value",
+                      "sum",
+                      "avg",
+                      "count",
+                      "min",
+                      "max"
+                    ],
+                    "description": "Window function name"
+                  },
+                  "field": {
+                    "type": "string",
+                    "description": "Field to operate on (for aggregate window functions)"
+                  },
+                  "alias": {
+                    "type": "string",
+                    "description": "Result column alias"
+                  },
+                  "over": {
+                    "type": "object",
+                    "properties": {
+                      "partitionBy": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "description": "PARTITION BY fields"
+                      },
+                      "orderBy": {
+                        "type": "array",
+                        "items": {
+                          "type": "object",
+                          "properties": {
+                            "field": {
+                              "type": "string"
+                            },
+                            "order": {
+                              "type": "string",
+                              "enum": [
+                                "asc",
+                                "desc"
+                              ],
+                              "default": "asc"
+                            }
+                          },
+                          "required": [
+                            "field"
+                          ],
+                          "additionalProperties": false
+                        },
+                        "description": "ORDER BY specification"
+                      },
+                      "frame": {
+                        "type": "object",
+                        "properties": {
+                          "type": {
+                            "type": "string",
+                            "enum": [
+                              "rows",
+                              "range"
+                            ]
+                          },
+                          "start": {
+                            "type": "string",
+                            "description": "Frame start (e.g., \"UNBOUNDED PRECEDING\", \"1 PRECEDING\")"
+                          },
+                          "end": {
+                            "type": "string",
+                            "description": "Frame end (e.g., \"CURRENT ROW\", \"1 FOLLOWING\")"
+                          }
+                        },
+                        "additionalProperties": false,
+                        "description": "Window frame specification"
+                      }
+                    },
+                    "additionalProperties": false,
+                    "description": "Window specification (OVER clause)"
+                  }
+                },
+                "required": [
+                  "function",
+                  "alias",
+                  "over"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Window functions with OVER clause"
+            },
+            "distinct": {
+              "type": "boolean",
+              "description": "SELECT DISTINCT flag"
+            }
+          },
+          "required": [
+            "object"
+          ],
+          "additionalProperties": false,
+          "description": "Query configuration (filters, sorting, etc.)"
+        },
+        "layout": {
+          "type": "object",
+          "properties": {
+            "columns": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "field": {
+                    "type": "string",
+                    "description": "Field name"
+                  },
+                  "label": {
+                    "type": "string",
+                    "description": "Custom column label"
+                  },
+                  "width": {
+                    "type": "number",
+                    "description": "Column width in pixels"
+                  },
+                  "sortable": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Whether column is sortable"
+                  },
+                  "filterable": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Whether column is filterable"
+                  },
+                  "visible": {
+                    "type": "boolean",
+                    "default": true,
+                    "description": "Whether column is visible"
+                  },
+                  "pinned": {
+                    "type": "string",
+                    "enum": [
+                      "left",
+                      "right"
+                    ],
+                    "description": "Pin column to left or right"
+                  },
+                  "formatter": {
+                    "type": "string",
+                    "description": "Custom formatter name"
+                  },
+                  "aggregation": {
+                    "type": "string",
+                    "description": "Aggregation function for column (sum, avg, etc.)"
+                  }
+                },
+                "required": [
+                  "field"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Column configuration for list views"
+            },
+            "rowHeight": {
+              "type": "number",
+              "description": "Row height in pixels"
+            },
+            "groupByField": {
+              "type": "string",
+              "description": "Field to group by (for kanban)"
+            },
+            "cardFields": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Fields to display on cards"
+            },
+            "dateField": {
+              "type": "string",
+              "description": "Date field for calendar view"
+            },
+            "startDateField": {
+              "type": "string",
+              "description": "Start date field for event ranges"
+            },
+            "endDateField": {
+              "type": "string",
+              "description": "End date field for event ranges"
+            },
+            "titleField": {
+              "type": "string",
+              "description": "Field to use as event title"
+            },
+            "chartType": {
+              "type": "string",
+              "enum": [
+                "bar",
+                "line",
+                "pie",
+                "scatter",
+                "area"
+              ],
+              "description": "Chart type"
+            },
+            "xAxis": {
+              "type": "string",
+              "description": "X-axis field"
+            },
+            "yAxis": {
+              "type": "string",
+              "description": "Y-axis field"
+            },
+            "series": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Series fields for multi-series charts"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Layout configuration"
+        },
+        "sharedWith": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "User/team IDs this view is shared with"
+        },
+        "isDefault": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is this the default view for this object?"
+        },
+        "isSystem": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is this a system-defined view?"
+        },
+        "createdBy": {
+          "type": "string",
+          "description": "User ID who created this view"
+        },
+        "createdAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the view was created"
+        },
+        "updatedBy": {
+          "type": "string",
+          "description": "User ID who last updated this view"
+        },
+        "updatedAt": {
+          "type": "string",
+          "format": "date-time",
+          "description": "When the view was last updated"
+        },
+        "settings": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional view-specific settings"
+        }
+      },
+      "required": [
+        "id",
+        "name",
+        "label",
+        "object",
+        "type",
+        "visibility",
+        "query",
+        "createdBy",
+        "createdAt"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}