@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/Object.json

@@ -0,0 +1,428 @@
+{
+  "$ref": "#/definitions/Object",
+  "definitions": {
+    "Object": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Machine name (snake_case)"
+        },
+        "label": {
+          "type": "string",
+          "description": "Singular Label (e.g. \"Account\")"
+        },
+        "pluralLabel": {
+          "type": "string",
+          "description": "Plural Label (e.g. \"Accounts\")"
+        },
+        "description": {
+          "type": "string",
+          "description": "Internal description"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Lucide icon name"
+        },
+        "datasource": {
+          "type": "string",
+          "default": "default",
+          "description": "Target Datasource ID (e.g. \"postgres\", \"salesforce\"). references sys_datasource."
+        },
+        "tableName": {
+          "type": "string",
+          "description": "Physical table/collection name in the target datasource"
+        },
+        "isSystem": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is system object (protected)"
+        },
+        "fields": {
+          "type": "object",
+          "additionalProperties": {
+            "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": "Map of field definitions"
+        },
+        "indexes": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Index name"
+              },
+              "fields": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "Fields included in the index"
+              },
+              "unique": {
+                "type": "boolean",
+                "description": "Whether the index is unique"
+              }
+            },
+            "required": [
+              "fields"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Database indexes definition"
+        },
+        "nameField": {
+          "type": "string",
+          "description": "Which field represents the record name/title (usually \"name\")"
+        },
+        "enable": {
+          "type": "object",
+          "properties": {
+            "trackHistory": {
+              "type": "boolean",
+              "default": false
+            },
+            "searchable": {
+              "type": "boolean",
+              "default": true
+            },
+            "apiEnabled": {
+              "type": "boolean",
+              "default": true
+            },
+            "apiMethods": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "get",
+                  "list",
+                  "create",
+                  "update",
+                  "delete",
+                  "upsert",
+                  "bulkCreate",
+                  "bulkUpdate",
+                  "bulkDelete",
+                  "bulkUpsert",
+                  "aggregate",
+                  "history",
+                  "search",
+                  "restore",
+                  "purge",
+                  "import",
+                  "export"
+                ]
+              },
+              "description": "Allowed API operations"
+            },
+            "files": {
+              "type": "boolean",
+              "default": false
+            },
+            "feedEnabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "trash": {
+              "type": "boolean",
+              "default": true
+            }
+          },
+          "additionalProperties": false,
+          "description": "Enabled system capabilities"
+        }
+      },
+      "required": [
+        "name",
+        "fields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ObjectCapabilities.json

@@ -0,0 +1,62 @@
+{
+  "$ref": "#/definitions/ObjectCapabilities",
+  "definitions": {
+    "ObjectCapabilities": {
+      "type": "object",
+      "properties": {
+        "trackHistory": {
+          "type": "boolean",
+          "default": false
+        },
+        "searchable": {
+          "type": "boolean",
+          "default": true
+        },
+        "apiEnabled": {
+          "type": "boolean",
+          "default": true
+        },
+        "apiMethods": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "get",
+              "list",
+              "create",
+              "update",
+              "delete",
+              "upsert",
+              "bulkCreate",
+              "bulkUpdate",
+              "bulkDelete",
+              "bulkUpsert",
+              "aggregate",
+              "history",
+              "search",
+              "restore",
+              "purge",
+              "import",
+              "export"
+            ]
+          },
+          "description": "Allowed API operations"
+        },
+        "files": {
+          "type": "boolean",
+          "default": false
+        },
+        "feedEnabled": {
+          "type": "boolean",
+          "default": false
+        },
+        "trash": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ObjectNavItem.json

@@ -0,0 +1,46 @@
+{
+  "$ref": "#/definitions/ObjectNavItem",
+  "definitions": {
+    "ObjectNavItem": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique identifier for this navigation item"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display proper label"
+        },
+        "icon": {
+          "type": "string",
+          "description": "Icon name"
+        },
+        "visible": {
+          "type": "string",
+          "description": "Visibility formula condition"
+        },
+        "type": {
+          "type": "string",
+          "const": "object"
+        },
+        "objectName": {
+          "type": "string",
+          "description": "Target object name"
+        },
+        "viewName": {
+          "type": "string",
+          "description": "Default list view to open. Defaults to \"all\""
+        }
+      },
+      "required": [
+        "id",
+        "label",
+        "type",
+        "objectName"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ObjectPermission.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/ObjectPermission",
+  "definitions": {
+    "ObjectPermission": {
+      "type": "object",
+      "properties": {
+        "allowCreate": {
+          "type": "boolean",
+          "default": false,
+          "description": "Create permission"
+        },
+        "allowRead": {
+          "type": "boolean",
+          "default": false,
+          "description": "Read permission"
+        },
+        "allowEdit": {
+          "type": "boolean",
+          "default": false,
+          "description": "Edit permission"
+        },
+        "allowDelete": {
+          "type": "boolean",
+          "default": false,
+          "description": "Delete permission"
+        },
+        "viewAllRecords": {
+          "type": "boolean",
+          "default": false,
+          "description": "View All Data (Bypass Sharing)"
+        },
+        "modifyAllRecords": {
+          "type": "boolean",
+          "default": false,
+          "description": "Modify All Data (Bypass Sharing)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ObjectQLClient.json

@@ -0,0 +1,12 @@
+{
+  "$ref": "#/definitions/ObjectQLClient",
+  "definitions": {
+    "ObjectQLClient": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false,
+      "description": "ObjectQL Data Access Client"
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}