@objectstack/spec 0.1.0 → 0.1.1

package/json-schema/DriverType.json

@@ -0,0 +1,27 @@
+{
+  "$ref": "#/definitions/DriverType",
+  "definitions": {
+    "DriverType": {
+      "type": "string",
+      "enum": [
+        "postgres",
+        "mysql",
+        "sqlserver",
+        "oracle",
+        "sqlite",
+        "mongo",
+        "redis",
+        "excel",
+        "csv",
+        "airtable",
+        "rest_api",
+        "graphql",
+        "odata",
+        "salesforce",
+        "sap",
+        "workday"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/EmailAlertAction.json

@@ -0,0 +1,37 @@
+{
+  "$ref": "#/definitions/EmailAlertAction",
+  "definitions": {
+    "EmailAlertAction": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Action name"
+        },
+        "type": {
+          "type": "string",
+          "const": "email_alert"
+        },
+        "template": {
+          "type": "string",
+          "description": "Email template ID/DevName"
+        },
+        "recipients": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of recipient emails or user IDs"
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "template",
+        "recipients"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Feature.json

@@ -0,0 +1,51 @@
+{
+  "$ref": "#/definitions/Feature",
+  "definitions": {
+    "Feature": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_.]*$",
+          "description": "Feature code (e.g. core.api_access)"
+        },
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "boolean",
+            "counter",
+            "gauge"
+          ],
+          "default": "boolean"
+        },
+        "unit": {
+          "type": "string",
+          "enum": [
+            "count",
+            "bytes",
+            "seconds",
+            "percent"
+          ]
+        },
+        "requires": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "code",
+        "label"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Field.json

@@ -0,0 +1,219 @@
+{
+  "$ref": "#/definitions/Field",
+  "definitions": {
+    "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",
+            "number",
+            "currency",
+            "percent",
+            "date",
+            "datetime",
+            "time",
+            "boolean",
+            "select",
+            "multiselect",
+            "lookup",
+            "master_detail",
+            "image",
+            "file",
+            "avatar",
+            "formula",
+            "summary",
+            "autonumber"
+          ],
+          "description": "Field Data Type"
+        },
+        "description": {
+          "type": "string",
+          "description": "Tooltip/Help text"
+        },
+        "required": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is required"
+        },
+        "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"
+        },
+        "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": [
+        "name",
+        "label",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldMapping.json

@@ -0,0 +1,83 @@
+{
+  "$ref": "#/definitions/FieldMapping",
+  "definitions": {
+    "FieldMapping": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Source column header(s)"
+        },
+        "target": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          ],
+          "description": "Target object field(s)"
+        },
+        "transform": {
+          "type": "string",
+          "enum": [
+            "none",
+            "constant",
+            "lookup",
+            "split",
+            "join",
+            "javascript",
+            "map"
+          ],
+          "default": "none"
+        },
+        "params": {
+          "type": "object",
+          "properties": {
+            "value": {},
+            "object": {
+              "type": "string"
+            },
+            "fromField": {
+              "type": "string"
+            },
+            "toField": {
+              "type": "string"
+            },
+            "autoCreate": {
+              "type": "boolean"
+            },
+            "valueMap": {
+              "type": "object",
+              "additionalProperties": {}
+            },
+            "separator": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "required": [
+        "source",
+        "target"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldNode.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/FieldNode",
+  "definitions": {
+    "FieldNode": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "field": {
+              "type": "string"
+            },
+            "fields": {
+              "type": "array",
+              "items": {}
+            },
+            "alias": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "field"
+          ],
+          "additionalProperties": false
+        }
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldPermission.json

@@ -0,0 +1,22 @@
+{
+  "$ref": "#/definitions/FieldPermission",
+  "definitions": {
+    "FieldPermission": {
+      "type": "object",
+      "properties": {
+        "readable": {
+          "type": "boolean",
+          "default": true,
+          "description": "Field read access"
+        },
+        "editable": {
+          "type": "boolean",
+          "default": false,
+          "description": "Field edit access"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldType.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/FieldType",
+  "definitions": {
+    "FieldType": {
+      "type": "string",
+      "enum": [
+        "text",
+        "textarea",
+        "email",
+        "url",
+        "phone",
+        "password",
+        "markdown",
+        "html",
+        "number",
+        "currency",
+        "percent",
+        "date",
+        "datetime",
+        "time",
+        "boolean",
+        "select",
+        "multiselect",
+        "lookup",
+        "master_detail",
+        "image",
+        "file",
+        "avatar",
+        "formula",
+        "summary",
+        "autonumber"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/FieldUpdateAction.json

@@ -0,0 +1,32 @@
+{
+  "$ref": "#/definitions/FieldUpdateAction",
+  "definitions": {
+    "FieldUpdateAction": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Action name"
+        },
+        "type": {
+          "type": "string",
+          "const": "field_update"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to update"
+        },
+        "value": {
+          "description": "Value or Formula to set"
+        }
+      },
+      "required": [
+        "name",
+        "type",
+        "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#"
+}