@objectstack/spec 0.1.0 → 0.1.2

package/json-schema/Page.json

@@ -0,0 +1,117 @@
+{
+  "$ref": "#/definitions/Page",
+  "definitions": {
+    "Page": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "pattern": "^[a-z_][a-z0-9_]*$"
+        },
+        "label": {
+          "type": "string"
+        },
+        "description": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "record",
+            "home",
+            "app",
+            "utility"
+          ],
+          "default": "record"
+        },
+        "object": {
+          "type": "string",
+          "description": "Bound object (for Record pages)"
+        },
+        "template": {
+          "type": "string",
+          "default": "default",
+          "description": "Layout template name (e.g. \"header-sidebar-main\")"
+        },
+        "regions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "name": {
+                "type": "string",
+                "description": "Region name (e.g. \"sidebar\", \"main\", \"header\")"
+              },
+              "width": {
+                "type": "string",
+                "enum": [
+                  "small",
+                  "medium",
+                  "large",
+                  "full"
+                ]
+              },
+              "components": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "description": "Component Type (e.g. \"steedos-labs.related-list\")"
+                    },
+                    "id": {
+                      "type": "string",
+                      "description": "Unique instance ID"
+                    },
+                    "label": {
+                      "type": "string"
+                    },
+                    "properties": {
+                      "type": "object",
+                      "additionalProperties": {},
+                      "description": "Component props passed to the widget"
+                    },
+                    "visibility": {
+                      "type": "string",
+                      "description": "Visibility filter/formula"
+                    }
+                  },
+                  "required": [
+                    "type",
+                    "properties"
+                  ],
+                  "additionalProperties": false
+                },
+                "description": "Components in this region"
+              }
+            },
+            "required": [
+              "name",
+              "components"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Defined regions with components"
+        },
+        "isDefault": {
+          "type": "boolean",
+          "default": false
+        },
+        "assignedProfiles": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "name",
+        "label",
+        "regions"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PageComponent.json

@@ -0,0 +1,36 @@
+{
+  "$ref": "#/definitions/PageComponent",
+  "definitions": {
+    "PageComponent": {
+      "type": "object",
+      "properties": {
+        "type": {
+          "type": "string",
+          "description": "Component Type (e.g. \"steedos-labs.related-list\")"
+        },
+        "id": {
+          "type": "string",
+          "description": "Unique instance ID"
+        },
+        "label": {
+          "type": "string"
+        },
+        "properties": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Component props passed to the widget"
+        },
+        "visibility": {
+          "type": "string",
+          "description": "Visibility filter/formula"
+        }
+      },
+      "required": [
+        "type",
+        "properties"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PageNavItem.json

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

package/json-schema/PageRegion.json

@@ -0,0 +1,63 @@
+{
+  "$ref": "#/definitions/PageRegion",
+  "definitions": {
+    "PageRegion": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Region name (e.g. \"sidebar\", \"main\", \"header\")"
+        },
+        "width": {
+          "type": "string",
+          "enum": [
+            "small",
+            "medium",
+            "large",
+            "full"
+          ]
+        },
+        "components": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "type": {
+                "type": "string",
+                "description": "Component Type (e.g. \"steedos-labs.related-list\")"
+              },
+              "id": {
+                "type": "string",
+                "description": "Unique instance ID"
+              },
+              "label": {
+                "type": "string"
+              },
+              "properties": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Component props passed to the widget"
+              },
+              "visibility": {
+                "type": "string",
+                "description": "Visibility filter/formula"
+              }
+            },
+            "required": [
+              "type",
+              "properties"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Components in this region"
+        }
+      },
+      "required": [
+        "name",
+        "components"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PasswordPolicy.json

@@ -0,0 +1,41 @@
+{
+  "$ref": "#/definitions/PasswordPolicy",
+  "definitions": {
+    "PasswordPolicy": {
+      "type": "object",
+      "properties": {
+        "minLength": {
+          "type": "number",
+          "default": 8
+        },
+        "requireUppercase": {
+          "type": "boolean",
+          "default": true
+        },
+        "requireLowercase": {
+          "type": "boolean",
+          "default": true
+        },
+        "requireNumbers": {
+          "type": "boolean",
+          "default": true
+        },
+        "requireSymbols": {
+          "type": "boolean",
+          "default": false
+        },
+        "expirationDays": {
+          "type": "number",
+          "description": "Force password change every X days"
+        },
+        "historyCount": {
+          "type": "number",
+          "default": 3,
+          "description": "Prevent reusing last X passwords"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PermissionSet.json

@@ -0,0 +1,96 @@
+{
+  "$ref": "#/definitions/PermissionSet",
+  "definitions": {
+    "PermissionSet": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Permission set unique name"
+        },
+        "label": {
+          "type": "string",
+          "description": "Display label"
+        },
+        "isProfile": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether this is a user profile"
+        },
+        "objects": {
+          "type": "object",
+          "additionalProperties": {
+            "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
+          },
+          "description": "Entity permissions"
+        },
+        "fields": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "object",
+            "properties": {
+              "readable": {
+                "type": "boolean",
+                "default": true,
+                "description": "Field read access"
+              },
+              "editable": {
+                "type": "boolean",
+                "default": false,
+                "description": "Field edit access"
+              }
+            },
+            "additionalProperties": false
+          },
+          "description": "Field level security"
+        },
+        "systemPermissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "System level capabilities"
+        }
+      },
+      "required": [
+        "name",
+        "objects"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Plan.json

@@ -0,0 +1,53 @@
+{
+  "$ref": "#/definitions/Plan",
+  "definitions": {
+    "Plan": {
+      "type": "object",
+      "properties": {
+        "code": {
+          "type": "string",
+          "description": "Plan code (e.g. pro_v1)"
+        },
+        "label": {
+          "type": "string"
+        },
+        "active": {
+          "type": "boolean",
+          "default": true
+        },
+        "features": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "List of enabled boolean features"
+        },
+        "limits": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "number"
+          },
+          "description": "Map of metric codes to limit values (e.g. { storage_gb: 10 })"
+        },
+        "currency": {
+          "type": "string",
+          "default": "USD"
+        },
+        "priceMonthly": {
+          "type": "number"
+        },
+        "priceYearly": {
+          "type": "number"
+        }
+      },
+      "required": [
+        "code",
+        "label",
+        "features",
+        "limits"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/Plugin.json

@@ -0,0 +1,20 @@
+{
+  "$ref": "#/definitions/Plugin",
+  "definitions": {
+    "Plugin": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Plugin identifier"
+        },
+        "version": {
+          "type": "string",
+          "description": "Plugin version"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PluginContext.json

@@ -0,0 +1,91 @@
+{
+  "$ref": "#/definitions/PluginContext",
+  "definitions": {
+    "PluginContext": {
+      "type": "object",
+      "properties": {
+        "ql": {
+          "type": "object",
+          "properties": {},
+          "additionalProperties": false,
+          "description": "ObjectQL Data Access Client"
+        },
+        "os": {
+          "type": "object",
+          "properties": {},
+          "additionalProperties": false,
+          "description": "Access to System Core"
+        },
+        "logger": {
+          "type": "object",
+          "properties": {
+            "debug": {
+              "description": "(message: string, ...meta: any[]) => void"
+            },
+            "info": {
+              "description": "(message: string, ...meta: any[]) => void"
+            },
+            "warn": {
+              "description": "(message: string, ...meta: any[]) => void"
+            },
+            "error": {
+              "description": "(message: string, ...meta: any[]) => void"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Structured Logger"
+        },
+        "storage": {
+          "type": "object",
+          "properties": {},
+          "additionalProperties": false,
+          "description": "Plugin Scoped Data Storage (KV)"
+        },
+        "i18n": {
+          "type": "object",
+          "properties": {},
+          "additionalProperties": false,
+          "description": "Internationalization Helper"
+        },
+        "metadata": {
+          "description": "Metadata registry"
+        },
+        "events": {
+          "description": "Event bus"
+        },
+        "app": {
+          "type": "object",
+          "properties": {
+            "router": {
+              "type": "object",
+              "properties": {},
+              "additionalProperties": false,
+              "description": "HTTP Router Interface"
+            },
+            "scheduler": {
+              "type": "object",
+              "properties": {},
+              "additionalProperties": false,
+              "description": "Job Scheduler Interface"
+            }
+          },
+          "required": [
+            "router"
+          ],
+          "additionalProperties": false,
+          "description": "App Runtime Capabilities"
+        }
+      },
+      "required": [
+        "ql",
+        "os",
+        "logger",
+        "storage",
+        "i18n",
+        "app"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/PluginLifecycle.json

@@ -0,0 +1,11 @@
+{
+  "$ref": "#/definitions/PluginLifecycle",
+  "definitions": {
+    "PluginLifecycle": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}