@objectstack/spec 0.3.2 → 0.4.1

package/json-schema/data/VectorConfig.json

@@ -0,0 +1,51 @@
+{
+  "$ref": "#/definitions/VectorConfig",
+  "definitions": {
+    "VectorConfig": {
+      "type": "object",
+      "properties": {
+        "dimensions": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 10000,
+          "description": "Vector dimensionality (e.g., 1536 for OpenAI embeddings)"
+        },
+        "distanceMetric": {
+          "type": "string",
+          "enum": [
+            "cosine",
+            "euclidean",
+            "dotProduct",
+            "manhattan"
+          ],
+          "default": "cosine",
+          "description": "Distance/similarity metric for vector search"
+        },
+        "normalized": {
+          "type": "boolean",
+          "default": false,
+          "description": "Whether vectors are normalized (unit length)"
+        },
+        "indexed": {
+          "type": "boolean",
+          "default": true,
+          "description": "Whether to create a vector index for fast similarity search"
+        },
+        "indexType": {
+          "type": "string",
+          "enum": [
+            "hnsw",
+            "ivfflat",
+            "flat"
+          ],
+          "description": "Vector index algorithm (HNSW for high accuracy, IVFFlat for large datasets)"
+        }
+      },
+      "required": [
+        "dimensions"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/hub/BillOfMaterials.json

@@ -0,0 +1,70 @@
+{
+  "$ref": "#/definitions/BillOfMaterials",
+  "definitions": {
+    "BillOfMaterials": {
+      "type": "object",
+      "properties": {
+        "tenantId": {
+          "type": "string",
+          "description": "Target Tenant ID"
+        },
+        "dependencies": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Plugin ID (e.g. \"com.example.crm\")"
+              },
+              "version": {
+                "type": "string",
+                "default": "latest",
+                "description": "SemVer range or \"latest\""
+              },
+              "configuration": {
+                "type": "object",
+                "additionalProperties": {},
+                "description": "Configuration overrides"
+              },
+              "features": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "boolean"
+                },
+                "description": "Feature toggles"
+              }
+            },
+            "required": [
+              "id"
+            ],
+            "additionalProperties": false
+          },
+          "description": "Installed packages"
+        },
+        "environment": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "resolutionStrategy": {
+          "type": "string",
+          "enum": [
+            "strict",
+            "override",
+            "merge"
+          ],
+          "default": "override",
+          "description": "Conflict resolution strategy (strict=fail, override=last-wins, merge=deep-merge)"
+        }
+      },
+      "required": [
+        "tenantId",
+        "dependencies"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/hub/ComposerRequest.json

@@ -0,0 +1,86 @@
+{
+  "$ref": "#/definitions/ComposerRequest",
+  "definitions": {
+    "ComposerRequest": {
+      "type": "object",
+      "properties": {
+        "bom": {
+          "type": "object",
+          "properties": {
+            "tenantId": {
+              "type": "string",
+              "description": "Target Tenant ID"
+            },
+            "dependencies": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "Plugin ID (e.g. \"com.example.crm\")"
+                  },
+                  "version": {
+                    "type": "string",
+                    "default": "latest",
+                    "description": "SemVer range or \"latest\""
+                  },
+                  "configuration": {
+                    "type": "object",
+                    "additionalProperties": {},
+                    "description": "Configuration overrides"
+                  },
+                  "features": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "boolean"
+                    },
+                    "description": "Feature toggles"
+                  }
+                },
+                "required": [
+                  "id"
+                ],
+                "additionalProperties": false
+              },
+              "description": "Installed packages"
+            },
+            "environment": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
+            },
+            "resolutionStrategy": {
+              "type": "string",
+              "enum": [
+                "strict",
+                "override",
+                "merge"
+              ],
+              "default": "override",
+              "description": "Conflict resolution strategy (strict=fail, override=last-wins, merge=deep-merge)"
+            }
+          },
+          "required": [
+            "tenantId",
+            "dependencies"
+          ],
+          "additionalProperties": false
+        },
+        "runtimeVersion": {
+          "type": "string"
+        },
+        "dryRun": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "required": [
+        "bom"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}

package/json-schema/hub/ComposerResponse.json

@@ -0,0 +1,483 @@
+{
+  "$ref": "#/definitions/ComposerResponse",
+  "definitions": {
+    "ComposerResponse": {
+      "type": "object",
+      "properties": {
+        "success": {
+          "type": "boolean"
+        },
+        "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,
+          "description": "The compiled System Manifest"
+        },
+        "manifestUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "Presigned download URL"
+        },
+        "buildId": {
+          "type": "string"
+        },
+        "timestamp": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "duration": {
+          "type": "number",
+          "description": "Compilation time in ms"
+        },
+        "conflicts": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "resourceType": {
+                "type": "string",
+                "enum": [
+                  "object",
+                  "field",
+                  "api",
+                  "ui"
+                ],
+                "description": "Type of colliding resource"
+              },
+              "resourceId": {
+                "type": "string",
+                "description": "ID of the resource"
+              },
+              "sources": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                },
+                "description": "List of plugin IDs defining this resource"
+              },
+              "resolution": {
+                "type": "string",
+                "description": "How it was resolved (e.g. \"com.example.erp won\")"
+              },
+              "severity": {
+                "type": "string",
+                "enum": [
+                  "info",
+                  "warning",
+                  "error"
+                ],
+                "description": "Severity of the conflict"
+              }
+            },
+            "required": [
+              "resourceType",
+              "resourceId",
+              "sources",
+              "resolution",
+              "severity"
+            ],
+            "additionalProperties": false
+          }
+        },
+        "errors": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "required": [
+        "success",
+        "buildId",
+        "timestamp",
+        "duration"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "$schema": "http://json-schema.org/draft-07/schema#"
+}