@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/FieldWidgetProps.json

@@ -0,0 +1,327 @@
+{
+  "$ref": "#/definitions/FieldWidgetProps",
+  "definitions": {
+    "FieldWidgetProps": {
+      "type": "object",
+      "properties": {
+        "value": {
+          "description": "Current field value"
+        },
+        "readonly": {
+          "type": "boolean",
+          "default": false,
+          "description": "Read-only mode flag"
+        },
+        "required": {
+          "type": "boolean",
+          "default": false,
+          "description": "Required field flag"
+        },
+        "error": {
+          "type": "string",
+          "description": "Validation error message"
+        },
+        "field": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "pattern": "^[a-z_][a-z0-9_]*$",
+              "description": "Machine name (snake_case)"
+            },
+            "label": {
+              "type": "string",
+              "description": "Human readable label"
+            },
+            "type": {
+              "type": "string",
+              "enum": [
+                "text",
+                "textarea",
+                "email",
+                "url",
+                "phone",
+                "password",
+                "markdown",
+                "html",
+                "richtext",
+                "number",
+                "currency",
+                "percent",
+                "date",
+                "datetime",
+                "time",
+                "boolean",
+                "select",
+                "lookup",
+                "master_detail",
+                "image",
+                "file",
+                "avatar",
+                "formula",
+                "summary",
+                "autonumber",
+                "location",
+                "address",
+                "code",
+                "color",
+                "rating",
+                "signature"
+              ],
+              "description": "Field Data Type"
+            },
+            "description": {
+              "type": "string",
+              "description": "Tooltip/Help text"
+            },
+            "format": {
+              "type": "string",
+              "description": "Format string (e.g. email, phone)"
+            },
+            "required": {
+              "type": "boolean",
+              "default": false,
+              "description": "Is required"
+            },
+            "searchable": {
+              "type": "boolean",
+              "default": false,
+              "description": "Is searchable"
+            },
+            "multiple": {
+              "type": "boolean",
+              "default": false,
+              "description": "Allow multiple values (Stores as Array/JSON). Applicable for select, lookup, file, image."
+            },
+            "unique": {
+              "type": "boolean",
+              "default": false,
+              "description": "Is unique constraint"
+            },
+            "defaultValue": {
+              "description": "Default value"
+            },
+            "maxLength": {
+              "type": "number",
+              "description": "Max character length"
+            },
+            "minLength": {
+              "type": "number",
+              "description": "Min character length"
+            },
+            "precision": {
+              "type": "number",
+              "description": "Total digits"
+            },
+            "scale": {
+              "type": "number",
+              "description": "Decimal places"
+            },
+            "min": {
+              "type": "number",
+              "description": "Minimum value"
+            },
+            "max": {
+              "type": "number",
+              "description": "Maximum value"
+            },
+            "options": {
+              "type": "array",
+              "items": {
+                "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
+              },
+              "description": "Static options for select/multiselect"
+            },
+            "reference": {
+              "type": "string",
+              "description": "Target Object Name"
+            },
+            "referenceFilters": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Filters applied to lookup dialogs (e.g. \"active = true\")"
+            },
+            "writeRequiresMasterRead": {
+              "type": "boolean",
+              "description": "If true, user needs read access to master record to edit this field"
+            },
+            "deleteBehavior": {
+              "type": "string",
+              "enum": [
+                "set_null",
+                "cascade",
+                "restrict"
+              ],
+              "default": "set_null",
+              "description": "What happens if referenced record is deleted"
+            },
+            "expression": {
+              "type": "string",
+              "description": "Formula expression"
+            },
+            "formula": {
+              "type": "string",
+              "description": "Deprecated: Use expression"
+            },
+            "summaryOperations": {
+              "type": "object",
+              "properties": {
+                "object": {
+                  "type": "string"
+                },
+                "field": {
+                  "type": "string"
+                },
+                "function": {
+                  "type": "string",
+                  "enum": [
+                    "count",
+                    "sum",
+                    "min",
+                    "max",
+                    "avg"
+                  ]
+                }
+              },
+              "required": [
+                "object",
+                "field",
+                "function"
+              ],
+              "additionalProperties": false,
+              "description": "Roll-up summary definition"
+            },
+            "language": {
+              "type": "string",
+              "description": "Programming language for syntax highlighting (e.g., javascript, python, sql)"
+            },
+            "theme": {
+              "type": "string",
+              "description": "Code editor theme (e.g., dark, light, monokai)"
+            },
+            "lineNumbers": {
+              "type": "boolean",
+              "description": "Show line numbers in code editor"
+            },
+            "maxRating": {
+              "type": "number",
+              "description": "Maximum rating value (default: 5)"
+            },
+            "allowHalf": {
+              "type": "boolean",
+              "description": "Allow half-star ratings"
+            },
+            "displayMap": {
+              "type": "boolean",
+              "description": "Display map widget for location field"
+            },
+            "allowGeocoding": {
+              "type": "boolean",
+              "description": "Allow address-to-coordinate conversion"
+            },
+            "addressFormat": {
+              "type": "string",
+              "enum": [
+                "us",
+                "uk",
+                "international"
+              ],
+              "description": "Address format template"
+            },
+            "colorFormat": {
+              "type": "string",
+              "enum": [
+                "hex",
+                "rgb",
+                "rgba",
+                "hsl"
+              ],
+              "description": "Color value format"
+            },
+            "allowAlpha": {
+              "type": "boolean",
+              "description": "Allow transparency/alpha channel"
+            },
+            "presetColors": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Preset color options"
+            },
+            "hidden": {
+              "type": "boolean",
+              "default": false,
+              "description": "Hidden from default UI"
+            },
+            "readonly": {
+              "type": "boolean",
+              "default": false,
+              "description": "Read-only in UI"
+            },
+            "encryption": {
+              "type": "boolean",
+              "default": false,
+              "description": "Encrypt at rest"
+            },
+            "index": {
+              "type": "boolean",
+              "default": false,
+              "description": "Create standard database index"
+            },
+            "externalId": {
+              "type": "boolean",
+              "default": false,
+              "description": "Is external ID for upsert operations"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "additionalProperties": false,
+          "description": "Field schema definition"
+        },
+        "record": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Complete record data"
+        },
+        "options": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Custom widget options"
+        }
+      },
+      "required": [
+        "field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FilterNode.json

@@ -0,0 +1,52 @@
+{
+  "$ref": "#/definitions/FilterNode",
+  "definitions": {
+    "FilterNode": {
+      "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"
+              },
+              {}
+            ]
+          }
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FilterOperator.json

@@ -0,0 +1,26 @@
+{
+  "$ref": "#/definitions/FilterOperator",
+  "definitions": {
+    "FilterOperator": {
+      "type": "string",
+      "enum": [
+        "=",
+        "!=",
+        "<>",
+        ">",
+        ">=",
+        "<",
+        "<=",
+        "startswith",
+        "contains",
+        "notcontains",
+        "between",
+        "in",
+        "notin",
+        "is_null",
+        "is_not_null"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Flow.json

@@ -0,0 +1,186 @@
+{
+  "$ref": "#/definitions/Flow",
+  "definitions": {
+    "Flow": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Machine name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Flow label"
+        },
+        "description": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "autolaunched",
+            "record_change",
+            "schedule",
+            "screen",
+            "api"
+          ],
+          "description": "Flow type"
+        },
+        "variables": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Variable name"
+              },
+              "type": {
+                "type": "string",
+                "description": "Data type (text, number, boolean, object, list)"
+              },
+              "isInput": {
+                "type": "boolean",
+                "default": false,
+                "description": "Is input parameter"
+              },
+              "isOutput": {
+                "type": "boolean",
+                "default": false,
+                "description": "Is output parameter"
+              }
+            },
+            "required": [
+              "name",
+              "type"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Flow variables"
+        },
+        "nodes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Node unique ID"
+              },
+              "type": {
+                "type": "string",
+                "enum": [
+                  "start",
+                  "end",
+                  "decision",
+                  "assignment",
+                  "loop",
+                  "create_record",
+                  "update_record",
+                  "delete_record",
+                  "get_record",
+                  "http_request",
+                  "script",
+                  "wait",
+                  "subflow"
+                ],
+                "description": "Action type"
+              },
+              "label": {
+                "type": "string",
+                "description": "Node label"
+              },
+              "config": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Node configuration"
+              },
+              "position": {
+                "type": "object",
+                "properties": {
+                  "x": {
+                    "type": "number"
+                  },
+                  "y": {
+                    "type": "number"
+                  }
+                },
+                "required": [
+                  "x",
+                  "y"
+                ],
+                "additionalProperties": false
+              }
+            },
+            "required": [
+              "id",
+              "type",
+              "label"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Flow nodes"
+        },
+        "edges": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Edge unique ID"
+              },
+              "source": {
+                "type": "string",
+                "description": "Source Node ID"
+              },
+              "target": {
+                "type": "string",
+                "description": "Target Node ID"
+              },
+              "condition": {
+                "type": "string",
+                "description": "Expression returning boolean used for branching"
+              },
+              "label": {
+                "type": "string",
+                "description": "Label on the connector"
+              }
+            },
+            "required": [
+              "id",
+              "source",
+              "target"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Flow connections"
+        },
+        "active": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is active"
+        },
+        "runAs": {
+          "type": "string",
+          "enum": [
+            "system",
+            "user"
+          ],
+          "default": "user",
+          "description": "Execution context"
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "type",
+        "nodes",
+        "edges"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FlowEdge.json

@@ -0,0 +1,37 @@
+{
+  "$ref": "#/definitions/FlowEdge",
+  "definitions": {
+    "FlowEdge": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Edge unique ID"
+        },
+        "source": {
+          "type": "string",
+          "description": "Source Node ID"
+        },
+        "target": {
+          "type": "string",
+          "description": "Target Node ID"
+        },
+        "condition": {
+          "type": "string",
+          "description": "Expression returning boolean used for branching"
+        },
+        "label": {
+          "type": "string",
+          "description": "Label on the connector"
+        }
+      },
+      "required": [
+        "id",
+        "source",
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FlowNode.json

@@ -0,0 +1,65 @@
+{
+  "$ref": "#/definitions/FlowNode",
+  "definitions": {
+    "FlowNode": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Node unique ID"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "start",
+            "end",
+            "decision",
+            "assignment",
+            "loop",
+            "create_record",
+            "update_record",
+            "delete_record",
+            "get_record",
+            "http_request",
+            "script",
+            "wait",
+            "subflow"
+          ],
+          "description": "Action type"
+        },
+        "label": {
+          "type": "string",
+          "description": "Node label"
+        },
+        "config": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Node configuration"
+        },
+        "position": {
+          "type": "object",
+          "properties": {
+            "x": {
+              "type": "number"
+            },
+            "y": {
+              "type": "number"
+            }
+          },
+          "required": [
+            "x",
+            "y"
+          ],
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "id",
+        "type",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}