@objectstack/spec 0.3.3 → 0.4.1

package/json-schema/system/Manifest.json

@@ -0,0 +1,395 @@
+{
+  "$ref": "#/definitions/Manifest",
+  "definitions": {
+    "Manifest": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "description": "Unique package identifier (reverse domain style)"
+        },
+        "version": {
+          "type": "string",
+          "pattern": "^\\d+\\.\\d+\\.\\d+$",
+          "description": "Package version (semantic versioning)"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "app",
+            "plugin",
+            "driver",
+            "module"
+          ],
+          "description": "Type of package"
+        },
+        "name": {
+          "type": "string",
+          "description": "Human-readable package name"
+        },
+        "description": {
+          "type": "string",
+          "description": "Package description"
+        },
+        "permissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Array of required permission strings"
+        },
+        "objects": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Glob patterns for ObjectQL schemas files"
+        },
+        "datasources": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "description": "Glob patterns for Datasource definitions"
+        },
+        "dependencies": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Package dependencies"
+        },
+        "configuration": {
+          "type": "object",
+          "properties": {
+            "title": {
+              "type": "string"
+            },
+            "properties": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "string",
+                      "number",
+                      "boolean",
+                      "array",
+                      "object"
+                    ],
+                    "description": "Data type of the setting"
+                  },
+                  "default": {
+                    "description": "Default value"
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "Tooltip description"
+                  },
+                  "required": {
+                    "type": "boolean",
+                    "description": "Is this setting required?"
+                  },
+                  "secret": {
+                    "type": "boolean",
+                    "description": "If true, value is encrypted/masked (e.g. API Keys)"
+                  },
+                  "enum": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Allowed values for select inputs"
+                  }
+                },
+                "required": [
+                  "type"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Map of configuration keys to their definitions"
+            }
+          },
+          "required": [
+            "properties"
+          ],
+          "additionalProperties": false,
+          "description": "Plugin configuration settings"
+        },
+        "contributes": {
+          "type": "object",
+          "properties": {
+            "kinds": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "The generic identifier of the kind (e.g., \"sys.bi.report\")"
+                  },
+                  "globs": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "File patterns to watch (e.g., [\"**/*.report.ts\"])"
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "Description of what this kind represents"
+                  }
+                },
+                "required": [
+                  "id",
+                  "globs"
+                ],
+                "additionalProperties": false
+              },
+              "description": "New Metadata Types to recognize"
+            },
+            "events": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              },
+              "description": "Events this plugin listens to"
+            },
+            "menus": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "label": {
+                      "type": "string"
+                    },
+                    "command": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "label"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "description": "UI Menu contributions"
+            },
+            "themes": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "label": {
+                    "type": "string"
+                  },
+                  "path": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label",
+                  "path"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Theme contributions"
+            },
+            "translations": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "locale": {
+                    "type": "string"
+                  },
+                  "path": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "locale",
+                  "path"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Translation resources"
+            },
+            "actions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Unique action name"
+                  },
+                  "label": {
+                    "type": "string"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "input": {
+                    "description": "Input validation schema"
+                  },
+                  "output": {
+                    "description": "Output schema"
+                  }
+                },
+                "required": [
+                  "name"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Exposed server actions"
+            },
+            "drivers": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "Driver unique identifier (e.g. \"postgres\", \"mongo\")"
+                  },
+                  "label": {
+                    "type": "string",
+                    "description": "Human readable name"
+                  },
+                  "description": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "label"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Driver contributions"
+            },
+            "fieldTypes": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Unique field type name (e.g. \"vector\")"
+                  },
+                  "label": {
+                    "type": "string",
+                    "description": "Display label"
+                  },
+                  "description": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name",
+                  "label"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Field Type contributions"
+            },
+            "functions": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Function name (e.g. \"distance\")"
+                  },
+                  "description": {
+                    "type": "string"
+                  },
+                  "args": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    },
+                    "description": "Argument types"
+                  },
+                  "returnType": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Query Function contributions"
+            }
+          },
+          "additionalProperties": false,
+          "description": "Platform contributions"
+        },
+        "data": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "object": {
+                "type": "string",
+                "description": "Target Object Name"
+              },
+              "records": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "additionalProperties": {}
+                },
+                "description": "List of records to insert"
+              },
+              "mode": {
+                "type": "string",
+                "enum": [
+                  "upsert",
+                  "insert",
+                  "ignore"
+                ],
+                "default": "upsert",
+                "description": "Seeding mode"
+              }
+            },
+            "required": [
+              "object",
+              "records"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Initial seed data"
+        },
+        "extensions": {
+          "type": "object",
+          "additionalProperties": {},
+          "description": "Extension points and contributions"
+        }
+      },
+      "required": [
+        "id",
+        "version",
+        "type",
+        "name"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/ui/Action.json

@@ -6,8 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$",
-          "description": "Machine name (snake_case)"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Machine name (lowercase snake_case)"
         },
         "label": {
           "type": "string",
@@ -32,6 +33,16 @@
           },
           "description": "Locations where this action is visible"
         },
+        "component": {
+          "type": "string",
+          "enum": [
+            "action:button",
+            "action:icon",
+            "action:menu",
+            "action:group"
+          ],
+          "description": "Visual component override"
+        },
         "location": {},
         "type": {
           "type": "string",
@@ -83,24 +94,34 @@
                   "datetime",
                   "time",
                   "boolean",
+                  "toggle",
                   "select",
+                  "multiselect",
+                  "radio",
+                  "checkboxes",
                   "lookup",
                   "master_detail",
+                  "tree",
                   "image",
                   "file",
                   "avatar",
+                  "video",
+                  "audio",
                   "formula",
                   "summary",
                   "autonumber",
                   "location",
-                  "geolocation",
                   "address",
                   "code",
+                  "json",
                   "color",
                   "rating",
                   "slider",
                   "signature",
-                  "qrcode"
+                  "qrcode",
+                  "progress",
+                  "tags",
+                  "vector"
                 ]
               },
               "required": {

package/json-schema/ui/ActionParam.json

@@ -29,24 +29,34 @@
             "datetime",
             "time",
             "boolean",
+            "toggle",
             "select",
+            "multiselect",
+            "radio",
+            "checkboxes",
             "lookup",
             "master_detail",
+            "tree",
             "image",
             "file",
             "avatar",
+            "video",
+            "audio",
             "formula",
             "summary",
             "autonumber",
             "location",
-            "geolocation",
             "address",
             "code",
+            "json",
             "color",
             "rating",
             "slider",
             "signature",
-            "qrcode"
+            "qrcode",
+            "progress",
+            "tags",
+            "vector"
           ]
         },
         "required": {

package/json-schema/ui/App.json

@@ -6,8 +6,9 @@
       "properties": {
         "name": {
           "type": "string",
-          "pattern": "^[a-z_][a-z0-9_]*$",
-          "description": "App unique machine name"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "App unique machine name (lowercase snake_case)"
         },
         "label": {
           "type": "string",
@@ -63,7 +64,9 @@
                 "properties": {
                   "id": {
                     "type": "string",
-                    "description": "Unique identifier for this navigation item"
+                    "minLength": 2,
+                    "pattern": "^[a-z][a-z0-9_]*$",
+                    "description": "Unique identifier for this navigation item (lowercase snake_case)"
                   },
                   "label": {
                     "type": "string",
@@ -103,7 +106,9 @@
                 "properties": {
                   "id": {
                     "type": "string",
-                    "description": "Unique identifier for this navigation item"
+                    "minLength": 2,
+                    "pattern": "^[a-z][a-z0-9_]*$",
+                    "description": "Unique identifier for this navigation item (lowercase snake_case)"
                   },
                   "label": {
                     "type": "string",
@@ -139,7 +144,9 @@
                 "properties": {
                   "id": {
                     "type": "string",
-                    "description": "Unique identifier for this navigation item"
+                    "minLength": 2,
+                    "pattern": "^[a-z][a-z0-9_]*$",
+                    "description": "Unique identifier for this navigation item (lowercase snake_case)"
                   },
                   "label": {
                     "type": "string",
@@ -180,7 +187,9 @@
                 "properties": {
                   "id": {
                     "type": "string",
-                    "description": "Unique identifier for this navigation item"
+                    "minLength": 2,
+                    "pattern": "^[a-z][a-z0-9_]*$",
+                    "description": "Unique identifier for this navigation item (lowercase snake_case)"
                   },
                   "label": {
                     "type": "string",
@@ -225,7 +234,9 @@
                 "properties": {
                   "id": {
                     "type": "string",
-                    "description": "Unique identifier for this navigation item"
+                    "minLength": 2,
+                    "pattern": "^[a-z][a-z0-9_]*$",
+                    "description": "Unique identifier for this navigation item (lowercase snake_case)"
                   },
                   "label": {
                     "type": "string",

package/json-schema/ui/ChartType.json

@@ -9,9 +9,17 @@
         "line",
         "pie",
         "donut",
+        "gauge",
         "funnel",
+        "radar",
+        "scatter",
+        "heatmap",
+        "pivot",
         "table",
-        "text"
+        "list",
+        "text",
+        "image",
+        "frame"
       ]
     }
   },

package/json-schema/ui/Dashboard.json

@@ -34,9 +34,17 @@
                   "line",
                   "pie",
                   "donut",
+                  "gauge",
                   "funnel",
+                  "radar",
+                  "scatter",
+                  "heatmap",
+                  "pivot",
                   "table",
-                  "text"
+                  "list",
+                  "text",
+                  "image",
+                  "frame"
                 ],
                 "default": "metric",
                 "description": "Visualization type"

package/json-schema/ui/DashboardNavItem.json

@@ -6,7 +6,9 @@
       "properties": {
         "id": {
           "type": "string",
-          "description": "Unique identifier for this navigation item"
+          "minLength": 2,
+          "pattern": "^[a-z][a-z0-9_]*$",
+          "description": "Unique identifier for this navigation item (lowercase snake_case)"
         },
         "label": {
           "type": "string",

package/json-schema/ui/DashboardWidget.json

@@ -16,9 +16,17 @@
             "line",
             "pie",
             "donut",
+            "gauge",
             "funnel",
+            "radar",
+            "scatter",
+            "heatmap",
+            "pivot",
             "table",
-            "text"
+            "list",
+            "text",
+            "image",
+            "frame"
           ],
           "default": "metric",
           "description": "Visualization type"