@objectstack/spec 0.1.1 → 0.1.2

package/json-schema/ActionParam.json

@@ -21,6 +21,7 @@
             "password",
             "markdown",
             "html",
+            "richtext",
             "number",
             "currency",
             "percent",
@@ -29,7 +30,6 @@
             "time",
             "boolean",
             "select",
-            "multiselect",
             "lookup",
             "master_detail",
             "image",
@@ -37,7 +37,13 @@
             "avatar",
             "formula",
             "summary",
-            "autonumber"
+            "autonumber",
+            "location",
+            "address",
+            "code",
+            "color",
+            "rating",
+            "signature"
           ]
         },
         "required": {

package/json-schema/Address.json

@@ -0,0 +1,40 @@
+{
+  "$ref": "#/definitions/Address",
+  "definitions": {
+    "Address": {
+      "type": "object",
+      "properties": {
+        "street": {
+          "type": "string",
+          "description": "Street address"
+        },
+        "city": {
+          "type": "string",
+          "description": "City name"
+        },
+        "state": {
+          "type": "string",
+          "description": "State/Province"
+        },
+        "postalCode": {
+          "type": "string",
+          "description": "Postal/ZIP code"
+        },
+        "country": {
+          "type": "string",
+          "description": "Country name or code"
+        },
+        "countryCode": {
+          "type": "string",
+          "description": "ISO country code (e.g., US, GB)"
+        },
+        "formatted": {
+          "type": "string",
+          "description": "Formatted address string"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AggregationFunction.json

@@ -0,0 +1,19 @@
+{
+  "$ref": "#/definitions/AggregationFunction",
+  "definitions": {
+    "AggregationFunction": {
+      "type": "string",
+      "enum": [
+        "count",
+        "sum",
+        "avg",
+        "min",
+        "max",
+        "count_distinct",
+        "array_agg",
+        "string_agg"
+      ]
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AggregationNode.json

@@ -0,0 +1,42 @@
+{
+  "$ref": "#/definitions/AggregationNode",
+  "definitions": {
+    "AggregationNode": {
+      "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"
+        }
+      },
+      "required": [
+        "function",
+        "alias"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Animation.json

@@ -0,0 +1,56 @@
+{
+  "$ref": "#/definitions/Animation",
+  "definitions": {
+    "Animation": {
+      "type": "object",
+      "properties": {
+        "duration": {
+          "type": "object",
+          "properties": {
+            "fast": {
+              "type": "string",
+              "description": "Fast animation (e.g., 150ms)"
+            },
+            "base": {
+              "type": "string",
+              "description": "Base animation (e.g., 300ms)"
+            },
+            "slow": {
+              "type": "string",
+              "description": "Slow animation (e.g., 500ms)"
+            }
+          },
+          "additionalProperties": false
+        },
+        "timing": {
+          "type": "object",
+          "properties": {
+            "linear": {
+              "type": "string",
+              "description": "Linear timing function"
+            },
+            "ease": {
+              "type": "string",
+              "description": "Ease timing function"
+            },
+            "easeIn": {
+              "type": "string",
+              "description": "Ease-in timing function"
+            },
+            "easeOut": {
+              "type": "string",
+              "description": "Ease-out timing function"
+            },
+            "easeInOut": {
+              "type": "string",
+              "description": "Ease-in-out timing function"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ApiCapabilities.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/ApiCapabilities",
+  "definitions": {
+    "ApiCapabilities": {
+      "type": "object",
+      "properties": {
+        "graphql": {
+          "type": "boolean",
+          "default": false
+        },
+        "search": {
+          "type": "boolean",
+          "default": false
+        },
+        "websockets": {
+          "type": "boolean",
+          "default": false
+        },
+        "files": {
+          "type": "boolean",
+          "default": true
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ApiError.json

@@ -0,0 +1,27 @@
+{
+  "$ref": "#/definitions/ApiError",
+  "definitions": {
+    "ApiError": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Error code (e.g. validation_error)"
+        },
+        "message": {
+          "type": "string",
+          "description": "Readable error message"
+        },
+        "details": {
+          "description": "Additional error context (e.g. field validation errors)"
+        }
+      },
+      "required": [
+        "code",
+        "message"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ApiRoutes.json

@@ -0,0 +1,41 @@
+{
+  "$ref": "#/definitions/ApiRoutes",
+  "definitions": {
+    "ApiRoutes": {
+      "type": "object",
+      "properties": {
+        "data": {
+          "type": "string",
+          "description": "e.g. /api/v1/data"
+        },
+        "metadata": {
+          "type": "string",
+          "description": "e.g. /api/v1/meta"
+        },
+        "auth": {
+          "type": "string",
+          "description": "e.g. /api/v1/auth"
+        },
+        "actions": {
+          "type": "string",
+          "description": "e.g. /api/v1/p"
+        },
+        "storage": {
+          "type": "string",
+          "description": "e.g. /api/v1/storage"
+        },
+        "graphql": {
+          "type": "string",
+          "description": "e.g. /api/v1/graphql"
+        }
+      },
+      "required": [
+        "data",
+        "metadata",
+        "auth"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/App.json

@@ -13,6 +13,10 @@
           "type": "string",
           "description": "App display label"
         },
+        "version": {
+          "type": "string",
+          "description": "App version"
+        },
         "description": {
           "type": "string",
           "description": "App description"
@@ -272,12 +276,19 @@
             "type": "string"
           },
           "description": "Permissions required to access this app"
+        },
+        "objects": {
+          "type": "array",
+          "description": "Objects belonging to this app"
+        },
+        "apis": {
+          "type": "array",
+          "description": "Custom APIs belonging to this app"
         }
       },
       "required": [
         "name",
-        "label",
-        "navigation"
+        "label"
       ],
       "additionalProperties": false
     }

package/json-schema/AsyncValidation.json

@@ -0,0 +1,70 @@
+{
+  "$ref": "#/definitions/AsyncValidation",
+  "definitions": {
+    "AsyncValidation": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique rule name"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "severity": {
+          "type": "string",
+          "enum": [
+            "error",
+            "warning",
+            "info"
+          ],
+          "default": "error"
+        },
+        "message": {
+          "type": "string",
+          "description": "Error message to display"
+        },
+        "type": {
+          "type": "string",
+          "const": "async"
+        },
+        "field": {
+          "type": "string",
+          "description": "Field to validate"
+        },
+        "validatorUrl": {
+          "type": "string",
+          "description": "External API endpoint for validation"
+        },
+        "validatorFunction": {
+          "type": "string",
+          "description": "Reference to custom validator function"
+        },
+        "timeout": {
+          "type": "number",
+          "default": 5000,
+          "description": "Timeout in milliseconds"
+        },
+        "debounce": {
+          "type": "number",
+          "description": "Debounce delay in milliseconds"
+        },
+        "params": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Additional parameters to pass to validator"
+        }
+      },
+      "required": [
+        "name",
+        "message",
+        "type",
+        "field"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BaseResponse.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/BaseResponse",
+  "definitions": {
+    "BaseResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        }
+      },
+      "required": [
+        "success"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BorderRadius.json

@@ -0,0 +1,44 @@
+{
+  "$ref": "#/definitions/BorderRadius",
+  "definitions": {
+    "BorderRadius": {
+      "type": "object",
+      "properties": {
+        "none": {
+          "type": "string",
+          "description": "No border radius (0)"
+        },
+        "sm": {
+          "type": "string",
+          "description": "Small border radius (e.g., 0.125rem)"
+        },
+        "base": {
+          "type": "string",
+          "description": "Base border radius (e.g., 0.25rem)"
+        },
+        "md": {
+          "type": "string",
+          "description": "Medium border radius (e.g., 0.375rem)"
+        },
+        "lg": {
+          "type": "string",
+          "description": "Large border radius (e.g., 0.5rem)"
+        },
+        "xl": {
+          "type": "string",
+          "description": "Extra large border radius (e.g., 0.75rem)"
+        },
+        "2xl": {
+          "type": "string",
+          "description": "2X large border radius (e.g., 1rem)"
+        },
+        "full": {
+          "type": "string",
+          "description": "Full border radius (50%)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Breakpoints.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/Breakpoints",
+  "definitions": {
+    "Breakpoints": {
+      "type": "object",
+      "properties": {
+        "xs": {
+          "type": "string",
+          "description": "Extra small breakpoint (e.g., 480px)"
+        },
+        "sm": {
+          "type": "string",
+          "description": "Small breakpoint (e.g., 640px)"
+        },
+        "md": {
+          "type": "string",
+          "description": "Medium breakpoint (e.g., 768px)"
+        },
+        "lg": {
+          "type": "string",
+          "description": "Large breakpoint (e.g., 1024px)"
+        },
+        "xl": {
+          "type": "string",
+          "description": "Extra large breakpoint (e.g., 1280px)"
+        },
+        "2xl": {
+          "type": "string",
+          "description": "2X large breakpoint (e.g., 1536px)"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BulkRequest.json

@@ -0,0 +1,29 @@
+{
+  "$ref": "#/definitions/BulkRequest",
+  "definitions": {
+    "BulkRequest": {
+      "type": "object",
+      "properties": {
+        "records": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "additionalProperties": {},
+            "description": "Key-value map of record data"
+          },
+          "description": "Array of records to process"
+        },
+        "allOrNone": {
+          "type": "boolean",
+          "default": true,
+          "description": "If true, rollback entire transaction on any failure"
+        }
+      },
+      "required": [
+        "records"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/BulkResponse.json

@@ -0,0 +1,108 @@
+{
+  "$ref": "#/definitions/BulkResponse",
+  "definitions": {
+    "BulkResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean",
+          "description": "Operation success status"
+        },
+        "error": {
+          "type": "object",
+          "properties": {
+            "code": {
+              "type": "string",
+              "description": "Error code (e.g. validation_error)"
+            },
+            "message": {
+              "type": "string",
+              "description": "Readable error message"
+            },
+            "details": {
+              "description": "Additional error context (e.g. field validation errors)"
+            }
+          },
+          "required": [
+            "code",
+            "message"
+          ],
+          "additionalProperties": false,
+          "description": "Error details if success is false"
+        },
+        "meta": {
+          "type": "object",
+          "properties": {
+            "timestamp": {
+              "type": "string"
+            },
+            "duration": {
+              "type": "number"
+            },
+            "requestId": {
+              "type": "string"
+            },
+            "traceId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "timestamp"
+          ],
+          "additionalProperties": false,
+          "description": "Response metadata"
+        },
+        "data": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Record ID if processed"
+              },
+              "success": {
+                "type": "boolean"
+              },
+              "errors": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "description": "Error code (e.g. validation_error)"
+                    },
+                    "message": {
+                      "type": "string",
+                      "description": "Readable error message"
+                    },
+                    "details": {
+                      "description": "Additional error context (e.g. field validation errors)"
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "message"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            },
+            "required": [
+              "success"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Results for each item in the batch"
+        }
+      },
+      "required": [
+        "success",
+        "data"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}