Stage 1 PR 7 (ADR 0063). A module becomes a first-class part of the Dashboard. - Manifest v9 = v8 plus optional `navigation`: a Lucide icon from the curated MODULE_NAVIGATION_ICONS set, and up to 12 primary pages (stable id, safe label, kebab-case path relative to the module root; no traversal, schemes, queries, duplicates, or nesting). Validated before activation. - Version 8 stays accepted beside version 9, each read strictly as itself (discriminated union); no released manifest is rewritten. The template moves to v9; the released Signage 0.1.5 manifest is a test fixture. - Real module routes: /<id> is the landing view, /<id>/<page> a declared page, anything beneath a page a module-owned detail route; anything else is not-found and mounts nothing. api/assets/display are never pages. - Sidebar: declared icons, pages nested under an open module, one aria-current, collapsed and drawer behaviour; v8 modules unchanged. - module-ui-sdk: ModuleUiHostContext.navigation (location, subscribe, navigate, link, settings), refusing anything outside the module's routes; undefined on the display host. Mount ABI unchanged. - Return-to-origin: one `?return=` carrier on Settings URLs, validated by parseReturnTarget and against running modules' declared routes; Settings Back returns to exactly the originating module page, across refreshes. Co-Authored-By: Claude Opus 5.5 <[email protected]>
77 lines
1.8 KiB
JSON
77 lines
1.8 KiB
JSON
{
|
|
"manifestVersion": 9,
|
|
"id": "example",
|
|
"name": "Example Module",
|
|
"description": "A minimal Ekklesia module template with backend behavior and optional primary and display UI.",
|
|
"version": "0.1.0",
|
|
"compatibility": {
|
|
"platform": "^0.2.0",
|
|
"moduleSdk": "^0.2.0"
|
|
},
|
|
"database": {
|
|
"abi": 1
|
|
},
|
|
"capabilities": [
|
|
{
|
|
"id": "example.records",
|
|
"version": "1.0.0"
|
|
}
|
|
],
|
|
"permissions": [
|
|
{
|
|
"id": "example.records.read",
|
|
"baseline": "restricted",
|
|
"description": "Read example records."
|
|
},
|
|
{
|
|
"id": "example.display.view",
|
|
"baseline": "restricted",
|
|
"description": "View the example full-screen display."
|
|
}
|
|
],
|
|
"configuration": [
|
|
{
|
|
"key": "greeting",
|
|
"type": "string",
|
|
"default": "Hello",
|
|
"maxLength": 120,
|
|
"description": "Prefix this module puts in front of a record value."
|
|
}
|
|
],
|
|
"contributions": [
|
|
{
|
|
"id": "example.summary-card",
|
|
"version": "1.0.0",
|
|
"capability": "example-host.summary-card",
|
|
"capabilityRange": "^1.0.0",
|
|
"artifact": "./dist/contributions/summary-card/index.js",
|
|
"description": "Renders this module's record summary inside a host module's own screen."
|
|
}
|
|
],
|
|
"navigation": {
|
|
"icon": "clipboard-list",
|
|
"pages": [
|
|
{
|
|
"id": "records",
|
|
"label": "Records",
|
|
"path": "records"
|
|
},
|
|
{
|
|
"id": "about",
|
|
"label": "About",
|
|
"path": "about"
|
|
}
|
|
]
|
|
},
|
|
"entrypoints": {
|
|
"server": "./dist/server/index.js",
|
|
"schema": "./dist/schema/index.js",
|
|
"migrations": "./drizzle",
|
|
"ui": "./dist/ui/index.js",
|
|
"display": {
|
|
"artifact": "./dist/display/index.js",
|
|
"permission": "example.display.view"
|
|
}
|
|
}
|
|
}
|