Skip to main content

API contracts (planned)

Frozen naming targets for v0.1 MVP and forward. Nothing here is published until implementation lands.

Maven coordinates (Gradle apps)​

Group: dev.decoupled.cabin (illustrative; finalize at first publish).

ArtifactCoordinateMVP
Tokensdev.decoupled.cabin:cabin-tokensYes
Compliancedev.decoupled.cabin:cabin-complianceYes
Foundationdev.decoupled.cabin:cabin-foundationPost-MVP (Experimental shared State/Action + size classes)
Viewsdev.decoupled.cabin:cabin-viewsYes (Theme Kit + System/Status bars Alpha)
Composedev.decoupled.cabin:cabin-composePost-MVP (Experimental Theme + bars + kit scaffold)
Gaugesdev.decoupled.cabin:cabin-gaugesPost-MVP (Experimental cluster stubs; never SystemUI)

Soong module names (build-tree)​

ModuleMVP SystemUIIn-repo scaffolding
CabinTokensRequiredcabin-tokens/Android.bp
CabinComplianceRequiredcabin-compliance/Android.bp
CabinFoundationTransitive via Viewscabin-foundation/Android.bp
CabinViewsRequiredcabin-views/Android.bp
CabinComposeDo not depend from SystemUIcabin-compose/Android.bp (opt-in)
CabinGaugesDo not depend from SystemUIcabin-gauges/Android.bp (opt-in)

Shared defaults: root Android.bp → CabinAndroidLibraryDefaults (not an umbrella library). SystemUI wiring sketch: sketches/systemui-cabin.

See build-tree.

Kotlin / Java package roots (planned)​

ModulePackage root
cabin-tokensdev.decoupled.cabin.tokens
cabin-compliancedev.decoupled.cabin.compliance
cabin-foundationdev.decoupled.cabin.foundation
cabin-viewsdev.decoupled.cabin.views
cabin-composedev.decoupled.cabin.compose
cabin-gaugesdev.decoupled.cabin.gauges

Views Theme Kit types: dev.decoupled.cabin.views.theme.CabinThemes, …CabinThemeResolver. Views chrome: …CabinSystemBarView, …CabinStatusBarView (Alpha). Domain: …CabinClimateTileView, …CabinMediaNowPlayingView (Alpha).

Compose Theme + bars (Experimental): dev.decoupled.cabin.compose.theme.CabinTheme, …CabinSystemBar, …CabinStatusBar. Domain (Experimental): …CabinClimateTile, …CabinMediaNowPlaying.

Stability​

LabelMeaning
ExperimentalMay change without notice; Compose bar parity starts here
Alpha / BetaTracking to stable; migration notes required
StableSemVer; tests green; pillars satisfied

v0.1 library drop may ship Tokens + Compliance + Views bars as Alpha.

SemVer policy (sketch)​

  • MAJOR — breaking token renames, removed public types, Soong name changes
  • MINOR — additive components/APIs, new optional interactions
  • PATCH — bugfixes, doc-equivalent behavior fixes

Token renames are high-cost; prefer additive aliases then deprecate. Platform pins Cabin by manifest tag/revision, not floating main (soong).

Dependency rules (contract)​

cabin-tokens
▲
cabin-compliance
▲
cabin-foundation (Experimental size classes + shared State/Action)
▲
cabin-views cabin-compose cabin-gauges (opt-in; never SystemUI)
(Views Alpha bars + ClimateTile/MediaNowPlaying + build-tree subset;
Compose Experimental kit scaffold)

Theme Kit Alpha in cabin-views depends on tokens only; bars and domain tiles also wire cabin-compliance. Compose Theme + components depend on tokens

  • compliance and must not depend on cabin-views.
  • Tokens & compliance: no UI toolkit deps
  • Foundation: no Compose or Views widgets
  • Views ⊀ Compose and Compose ⊀ Views
  • Gauges must not be linked from SystemUI
  • SystemUI static_libs: tokens + compliance + views only (never CabinCompose / CabinGauges)