@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/View.json

@@ -0,0 +1,500 @@
+{
+  "$ref": "#/definitions/View",
+  "definitions": {
+    "View": {
+      "type": "object",
+      "properties": {
+        "list": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string"
+            },
+            "label": {
+              "type": "string"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "grid",
+                "kanban",
+                "calendar",
+                "gantt",
+                "map"
+              ],
+              "default": "grid"
+            },
+            "columns": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Fields to display as columns"
+            },
+            "filter": {
+              "type": "array",
+              "description": "Filter criteria (JSON Rules)"
+            },
+            "sort": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "field": {
+                        "type": "string"
+                      },
+                      "order": {
+                        "type": "string",
+                        "enum": [
+                          "asc",
+                          "desc"
+                        ]
+                      }
+                    },
+                    "required": [
+                      "field",
+                      "order"
+                    ],
+                    "additionalProperties": false
+                  }
+                }
+              ]
+            },
+            "searchableFields": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Fields enabled for search"
+            },
+            "kanban": {
+              "type": "object",
+              "properties": {
+                "groupByField": {
+                  "type": "string",
+                  "description": "Field to group columns by (usually status/select)"
+                },
+                "summarizeField": {
+                  "type": "string",
+                  "description": "Field to sum at top of column (e.g. amount)"
+                },
+                "columns": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "Fields to show on cards"
+                }
+              },
+              "required": [
+                "groupByField",
+                "columns"
+              ],
+              "additionalProperties": false
+            },
+            "calendar": {
+              "type": "object",
+              "properties": {
+                "startDateField": {
+                  "type": "string"
+                },
+                "endDateField": {
+                  "type": "string"
+                },
+                "titleField": {
+                  "type": "string"
+                },
+                "colorField": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "startDateField",
+                "titleField"
+              ],
+              "additionalProperties": false
+            },
+            "gantt": {
+              "type": "object",
+              "properties": {
+                "startDateField": {
+                  "type": "string"
+                },
+                "endDateField": {
+                  "type": "string"
+                },
+                "titleField": {
+                  "type": "string"
+                },
+                "progressField": {
+                  "type": "string"
+                },
+                "dependenciesField": {
+                  "type": "string"
+                }
+              },
+              "required": [
+                "startDateField",
+                "endDateField",
+                "titleField"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "columns"
+          ],
+          "additionalProperties": false
+        },
+        "form": {
+          "type": "object",
+          "properties": {
+            "type": {
+              "type": "string",
+              "enum": [
+                "simple",
+                "tabbed",
+                "wizard"
+              ],
+              "default": "simple"
+            },
+            "sections": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "type": "string"
+                  },
+                  "collapsible": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "collapsed": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "columns": {
+                    "type": "string",
+                    "enum": [
+                      "1",
+                      "2",
+                      "3",
+                      "4"
+                    ],
+                    "default": "2"
+                  },
+                  "fields": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": [
+                  "fields"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "groups": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "label": {
+                    "type": "string"
+                  },
+                  "collapsible": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "collapsed": {
+                    "type": "boolean",
+                    "default": false
+                  },
+                  "columns": {
+                    "type": "string",
+                    "enum": [
+                      "1",
+                      "2",
+                      "3",
+                      "4"
+                    ],
+                    "default": "2"
+                  },
+                  "fields": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": [
+                  "fields"
+                ],
+                "additionalProperties": false
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "listViews": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string"
+              },
+              "label": {
+                "type": "string"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "grid",
+                  "kanban",
+                  "calendar",
+                  "gantt",
+                  "map"
+                ],
+                "default": "grid"
+              },
+              "columns": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Fields to display as columns"
+              },
+              "filter": {
+                "type": "array",
+                "description": "Filter criteria (JSON Rules)"
+              },
+              "sort": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "array",
+                    "items": {
+                      "type": "object",
+                      "properties": {
+                        "field": {
+                          "type": "string"
+                        },
+                        "order": {
+                          "type": "string",
+                          "enum": [
+                            "asc",
+                            "desc"
+                          ]
+                        }
+                      },
+                      "required": [
+                        "field",
+                        "order"
+                      ],
+                      "additionalProperties": false
+                    }
+                  }
+                ]
+              },
+              "searchableFields": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Fields enabled for search"
+              },
+              "kanban": {
+                "type": "object",
+                "properties": {
+                  "groupByField": {
+                    "type": "string",
+                    "description": "Field to group columns by (usually status/select)"
+                  },
+                  "summarizeField": {
+                    "type": "string",
+                    "description": "Field to sum at top of column (e.g. amount)"
+                  },
+                  "columns": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Fields to show on cards"
+                  }
+                },
+                "required": [
+                  "groupByField",
+                  "columns"
+                ],
+                "additionalProperties": false
+              },
+              "calendar": {
+                "type": "object",
+                "properties": {
+                  "startDateField": {
+                    "type": "string"
+                  },
+                  "endDateField": {
+                    "type": "string"
+                  },
+                  "titleField": {
+                    "type": "string"
+                  },
+                  "colorField": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "startDateField",
+                  "titleField"
+                ],
+                "additionalProperties": false
+              },
+              "gantt": {
+                "type": "object",
+                "properties": {
+                  "startDateField": {
+                    "type": "string"
+                  },
+                  "endDateField": {
+                    "type": "string"
+                  },
+                  "titleField": {
+                    "type": "string"
+                  },
+                  "progressField": {
+                    "type": "string"
+                  },
+                  "dependenciesField": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "startDateField",
+                  "endDateField",
+                  "titleField"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "columns"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Additional named list views"
+        },
+        "formViews": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "enum": [
+                  "simple",
+                  "tabbed",
+                  "wizard"
+                ],
+                "default": "simple"
+              },
+              "sections": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "type": "string"
+                    },
+                    "collapsible": {
+                      "type": "boolean",
+                      "default": false
+                    },
+                    "collapsed": {
+                      "type": "boolean",
+                      "default": false
+                    },
+                    "columns": {
+                      "type": "string",
+                      "enum": [
+                        "1",
+                        "2",
+                        "3",
+                        "4"
+                      ],
+                      "default": "2"
+                    },
+                    "fields": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "required": [
+                    "fields"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "groups": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "label": {
+                      "type": "string"
+                    },
+                    "collapsible": {
+                      "type": "boolean",
+                      "default": false
+                    },
+                    "collapsed": {
+                      "type": "boolean",
+                      "default": false
+                    },
+                    "columns": {
+                      "type": "string",
+                      "enum": [
+                        "1",
+                        "2",
+                        "3",
+                        "4"
+                      ],
+                      "default": "2"
+                    },
+                    "fields": {
+                      "type": "array",
+                      "items": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "required": [
+                    "fields"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "additionalProperties": false
+          },
+          "description": "Additional named form views"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Webhook.json

@@ -0,0 +1,88 @@
+{
+  "$ref": "#/definitions/Webhook",
+  "definitions": {
+    "Webhook": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "label": {
+          "type": "string"
+        },
+        "object": {
+          "type": "string",
+          "description": "Object to listen to"
+        },
+        "triggers": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "create",
+              "update",
+              "delete",
+              "undelete",
+              "api"
+            ]
+          },
+          "description": "Events that trigger execution"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "External URL payload"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "POST",
+            "PUT",
+            "GET"
+          ],
+          "default": "POST"
+        },
+        "secret": {
+          "type": "string",
+          "description": "Signing secret (HMAC)"
+        },
+        "headers": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Custom headers (Auth)"
+        },
+        "payloadFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to include. Empty = All"
+        },
+        "includeSession": {
+          "type": "boolean",
+          "default": false,
+          "description": "Include user session info"
+        },
+        "retryCount": {
+          "type": "number",
+          "default": 3
+        },
+        "isActive": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "required": [
+        "name",
+        "object",
+        "triggers",
+        "url"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WebhookReceiver.json

@@ -0,0 +1,66 @@
+{
+  "$ref": "#/definitions/WebhookReceiver",
+  "definitions": {
+    "WebhookReceiver": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "path": {
+          "type": "string",
+          "description": "URL Path (e.g. /webhooks/stripe)"
+        },
+        "verificationType": {
+          "type": "string",
+          "enum": [
+            "none",
+            "header_token",
+            "hmac",
+            "ip_whitelist"
+          ],
+          "default": "none"
+        },
+        "verificationParams": {
+          "type": "object",
+          "properties": {
+            "header": {
+              "type": "string"
+            },
+            "secret": {
+              "type": "string"
+            },
+            "ips": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        "action": {
+          "type": "string",
+          "enum": [
+            "trigger_flow",
+            "script",
+            "upsert_record"
+          ],
+          "default": "trigger_flow"
+        },
+        "target": {
+          "type": "string",
+          "description": "Flow ID or Script name"
+        }
+      },
+      "required": [
+        "name",
+        "path",
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WebhookTriggerType.json

@@ -0,0 +1,16 @@
+{
+  "$ref": "#/definitions/WebhookTriggerType",
+  "definitions": {
+    "WebhookTriggerType": {
+      "type": "string",
+      "enum": [
+        "create",
+        "update",
+        "delete",
+        "undelete",
+        "api"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/WindowFunction.json

@@ -0,0 +1,24 @@
+{
+  "$ref": "#/definitions/WindowFunction",
+  "definitions": {
+    "WindowFunction": {
+      "type": "string",
+      "enum": [
+        "row_number",
+        "rank",
+        "dense_rank",
+        "percent_rank",
+        "lag",
+        "lead",
+        "first_value",
+        "last_value",
+        "sum",
+        "avg",
+        "count",
+        "min",
+        "max"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}