@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/ApiEndpoint.json

@@ -0,0 +1,162 @@
+{
+  "$ref": "#/definitions/ApiEndpoint",
+  "definitions": {
+    "ApiEndpoint": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "Unique endpoint ID"
+        },
+        "path": {
+          "type": "string",
+          "pattern": "^\\/",
+          "description": "URL Path (e.g. /api/v1/customers)"
+        },
+        "method": {
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "DELETE",
+            "PATCH"
+          ],
+          "description": "HTTP Method"
+        },
+        "summary": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "flow",
+            "script",
+            "object_operation",
+            "proxy"
+          ],
+          "description": "Implementation type"
+        },
+        "target": {
+          "type": "string",
+          "description": "Target Flow ID, Script Name, or Proxy URL"
+        },
+        "objectParams": {
+          "type": "object",
+          "properties": {
+            "object": {
+              "type": "string"
+            },
+            "operation": {
+              "type": "string",
+              "enum": [
+                "find",
+                "get",
+                "create",
+                "update",
+                "delete"
+              ]
+            }
+          },
+          "additionalProperties": false,
+          "description": "For object_operation type"
+        },
+        "inputMapping": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "source": {
+                "type": "string",
+                "description": "Source field/path"
+              },
+              "target": {
+                "type": "string",
+                "description": "Target field/path"
+              },
+              "transform": {
+                "type": "string",
+                "description": "Transformation function name"
+              }
+            },
+            "required": [
+              "source",
+              "target"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Map Request Body to Internal Params"
+        },
+        "outputMapping": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "source": {
+                "type": "string",
+                "description": "Source field/path"
+              },
+              "target": {
+                "type": "string",
+                "description": "Target field/path"
+              },
+              "transform": {
+                "type": "string",
+                "description": "Transformation function name"
+              }
+            },
+            "required": [
+              "source",
+              "target"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Map Internal Result to Response Body"
+        },
+        "authRequired": {
+          "type": "boolean",
+          "default": true,
+          "description": "Require authentication"
+        },
+        "rateLimit": {
+          "type": "object",
+          "properties": {
+            "enabled": {
+              "type": "boolean",
+              "default": false
+            },
+            "windowMs": {
+              "type": "number",
+              "default": 60000,
+              "description": "Time window in milliseconds"
+            },
+            "maxRequests": {
+              "type": "number",
+              "default": 100,
+              "description": "Max requests per window"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Rate limiting policy"
+        },
+        "cacheTtl": {
+          "type": "number",
+          "description": "Response cache TTL in seconds"
+        }
+      },
+      "required": [
+        "name",
+        "path",
+        "method",
+        "type",
+        "target"
+      ],
+      "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/ApiMapping.json

@@ -0,0 +1,28 @@
+{
+  "$ref": "#/definitions/ApiMapping",
+  "definitions": {
+    "ApiMapping": {
+      "type": "object",
+      "properties": {
+        "source": {
+          "type": "string",
+          "description": "Source field/path"
+        },
+        "target": {
+          "type": "string",
+          "description": "Target field/path"
+        },
+        "transform": {
+          "type": "string",
+          "description": "Transformation function name"
+        }
+      },
+      "required": [
+        "source",
+        "target"
+      ],
+      "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

@@ -0,0 +1,297 @@
+{
+  "$ref": "#/definitions/App",
+  "definitions": {
+    "App": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$",
+          "description": "App unique machine name"
+        },
+        "label": {
+          "type": "string",
+          "description": "App display label"
+        },
+        "version": {
+          "type": "string",
+          "description": "App version"
+        },
+        "description": {
+          "type": "string",
+          "description": "App description"
+        },
+        "icon": {
+          "type": "string",
+          "description": "App icon used in the App Launcher"
+        },
+        "branding": {
+          "type": "object",
+          "properties": {
+            "primaryColor": {
+              "type": "string",
+              "description": "Primary theme color hex code"
+            },
+            "logo": {
+              "type": "string",
+              "description": "Custom logo URL for this app"
+            },
+            "favicon": {
+              "type": "string",
+              "description": "Custom favicon URL for this app"
+            }
+          },
+          "additionalProperties": false,
+          "description": "App-specific branding"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether the app is enabled"
+        },
+        "isDefault": {
+          "type": "boolean",
+          "default": false,
+          "description": "Is default app"
+        },
+        "navigation": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "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
+              },
+              {
+                "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": "dashboard"
+                  },
+                  "dashboardName": {
+                    "type": "string",
+                    "description": "Target dashboard name"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label",
+                  "type",
+                  "dashboardName"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "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": "page"
+                  },
+                  "pageName": {
+                    "type": "string",
+                    "description": "Target custom page component name"
+                  },
+                  "params": {
+                    "type": "object",
+                    "additionalProperties": {},
+                    "description": "Parameters passed to the page context"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label",
+                  "type",
+                  "pageName"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "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": "url"
+                  },
+                  "url": {
+                    "type": "string",
+                    "description": "Target external URL"
+                  },
+                  "target": {
+                    "type": "string",
+                    "enum": [
+                      "_self",
+                      "_blank"
+                    ],
+                    "default": "_self",
+                    "description": "Link target window"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label",
+                  "type",
+                  "url"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "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": "group"
+                  },
+                  "expanded": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "Default expansion state in sidebar"
+                  },
+                  "children": {
+                    "type": "array",
+                    "items": {},
+                    "description": "Child navigation items"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label",
+                  "type",
+                  "children"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          },
+          "description": "Structured navigation menu tree"
+        },
+        "homePageId": {
+          "type": "string",
+          "description": "ID of the navigation item to serve as landing page"
+        },
+        "requiredPermissions": {
+          "type": "array",
+          "items": {
+            "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"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/AppBranding.json

@@ -0,0 +1,24 @@
+{
+  "$ref": "#/definitions/AppBranding",
+  "definitions": {
+    "AppBranding": {
+      "type": "object",
+      "properties": {
+        "primaryColor": {
+          "type": "string",
+          "description": "Primary theme color hex code"
+        },
+        "logo": {
+          "type": "string",
+          "description": "Custom logo URL for this app"
+        },
+        "favicon": {
+          "type": "string",
+          "description": "Custom favicon URL for this app"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

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/AuditPolicy.json

@@ -0,0 +1,31 @@
+{
+  "$ref": "#/definitions/AuditPolicy",
+  "definitions": {
+    "AuditPolicy": {
+      "type": "object",
+      "properties": {
+        "logRetentionDays": {
+          "type": "number",
+          "default": 180
+        },
+        "sensitiveFields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Fields to redact in logs (e.g. password, ssn)"
+        },
+        "captureRead": {
+          "type": "boolean",
+          "default": false,
+          "description": "Log read access (High volume!)"
+        }
+      },
+      "required": [
+        "sensitiveFields"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}