Zayin/Ekklesia
3
0
Fork 0
Code Issues 6 Pull Requests 1 Actions Packages Projects Releases 9 Wiki Activity

Make the module navigation capability an optional context member
CI / verify (pull_request) Successful in 1m11s
Details
CI / infrastructure-smoke (pull_request) Successful in 42s
Details
CI / package-release (pull_request) Successful in 48s
Details
CI / migration-smoke (pull_request) Successful in 2m27s
Details
CI / image-build (pull_request) Successful in 1m8s
Details
CI / deploy-smoke (same-origin) (pull_request) Successful in 52s
Details
CI / package-publication (pull_request) Successful in 57s
Details
CI / deploy-smoke (split) (pull_request) Successful in 3m35s
Details

Browse Source 
ModuleUiHostContext.navigation is now `navigation?: ModuleUiNavigation |
undefined`, so the public context change is source-compatible: a context built
before navigation existed (without the member) still compiles unchanged, as
0.x patch releases require. The Dashboard supplies navigation; hosts without
addressable pages, including the display host, omit the member; modules
feature-detect it. Existing hosts' tests are restored to their pre-PR shape,
and a module-ui-sdk test proves a pre-navigation context still satisfies
ModuleUiHostContext (and fails if the member is ever made required).
Runtime behaviour, manifest v8/v9 compatibility, and security rules are
unchanged. ADR 0063 and the module development guide say so.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
This commit is contained in:
ekklesia
2026-10-15 09:13:03 -05:00
co-authored by Claude Opus 5.5
parent ae360ef318
commit c78f1318b4
13 changed files with 60 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture/decisions/0063-module-navigation-contract-manifest-v9.md
+11 -5
View File
@@ -176,8 +176,14 @@ The shell parses both strictly.
### The module's navigation capability
`ModuleUiHostContext.navigation` (`@ekklesia/module-ui-sdk`) is a narrow host capability, not a
router. It is `undefined` where a host has no addressable pages: the display host, and a standalone
host without routes.
router, and an **optional** member (`navigation?: ModuleUiNavigation`). A host with addressable
module pages (Ekklesia's Dashboard) supplies it. A host without them (the display host, and a
standalone host without routes) omits it, and may also set it to `undefined`.
The member is optional so that adding it breaks no one. Ekklesia's 0.x versioning makes patch
releases compatible, and a context built before navigation existed must stay a complete, valid
context that compiles unchanged. A `@ekklesia/module-ui-sdk` test holds exactly that, and fails if
the member is ever made required.
```ts
interface ModuleUiNavigation {
@@ -208,7 +214,7 @@ interface ModuleUiNavigation {
rebuilt against the new SDK can already link to its Settings page.
Adding a context member changes nothing about how an artifact is mounted, so the mount ABI stays at
version 2. A module that uses `navigation` checks for it, exactly as it checks `display`.
version 2. A module that uses `navigation` feature-detects it (`context.navigation?.navigate(…)`).
### Return-to-origin: one carrier, the `return` query parameter
@@ -262,8 +268,8 @@ parameter from it.
- **Packages.** `@ekklesia/contracts` gains `module-navigation.ts`, the v8/v9 manifest union, and
`moduleManifestNavigation`. `@ekklesia/module-ui-sdk` gains `navigation.ts` and
`ModuleUiHostContext.navigation`. `@ekklesia/module-sdk` re-exports the navigation helpers and
types. All changes are additive for module code. A host that builds a context itself must now say
`navigation: undefined`.
types. Every change is additive at the source level as well as at run time: existing module code,
and an existing host that builds a context itself, compile and run unchanged.
- **Core** publishes each module's navigation beside its name. The navigation response gains a
`navigation` member per module.
- **The shell** reads module routes at any depth, draws icons and pages, and supplies the