API Reference crosswake v#0.1.0

View Source

Modules

Public entry point for Crosswake policy authoring and normalization.

Payload structs for app.info.get bridge command.

Typed payload structs for the transfer-bound files.pick bridge command.

Payload structs for haptics.impact bridge command.

Typed payload structs for the prompt-free notifications.token.get bridge command.

Typed payload structs for the read-only permissions.status bridge command.

Payload structs for share.invoke bridge command.

Typed, versioned, request/reply-only contract for the bounded Phase 3 bridge.

Typed denial reply payload for bounded bridge requests.

Manifest-backed Phase 3 bridge allowlist.

Thin behaviour/orchestration seam for Phoenix-owned commerce intent and snapshot hooks.

Typed commerce contract surfaces shared by core, route policy, and manifest truth.

Typed backend-owned reconciliation vocabulary for commerce.

A typed record of a backend-owned reconciliation attempt.

Represents an evidence-only result state for device purchase, restore, or native callback success. These states do not directly mutate entitlement authority.

Provider-aware and backend-owned idempotency fields. Transient device correlation ids are not part of this key.

Layered compatibility evaluation for manifests and route activation.

Fail-closed route activation decisions derived from layered compatibility findings.

Host-truth-first diagnostics over install state, policy compilation, manifest truth, shell posture, bounded bridge posture, and support verification.

Structured doctor finding.

Central Phase 18 finding taxonomy for proof posture and support-claim severity.

Human-readable formatter for Crosswake doctor reports.

Stable JSON formatter for Crosswake doctor reports.

Persists machine-readable scaffold state for later diagnostics and upgrade tooling.

Applies explicit, idempotent Crosswake install patches to host-owned files.

Canonical Phase 2 manifest compiler.

Builds the route-first manifest root from compiled Crosswake route policy.

Deterministic JSON renderer and idempotent writer for the canonical manifest artifact.

Typed manifest contract shared by manifest generation, compatibility checks, doctor diagnostics, and support-matrix rendering.

Validates manifest contract truth before serialization or release artifact output.

Typed contract for Crosswake's single public native escape hatch: route-owned media capture with explicit local staging and explicit transfer handoff.

Runtime helpers for the single native media-capture escape hatch.

Typed Phase 4 offline contract surfaces for the cached-route and study-session exemplar.

Immutable journal contract for committed offline study-session actions.

Typed replay request and outcome contract for the study-session exemplar.

Executable runtime contract for cached hydration and the study-session island.

Stable route-local offline vocabulary for Crosswake support surfaces.

Stable telemetry metadata contract for offline transitions and outcomes.

Typed pack lifecycle vocabulary shared across activation, shell UI, and proof lanes.

Installed-pack inventory truth consumed by activation, compatibility, and shell UI.

Derives fail-closed lifecycle state from manifest pack references and installed inventory.

Namespace for Crosswake route policy contracts.

Compiles Crosswake-managed router metadata into normalized route policy.

Canonical provider-neutral commerce corridor declarations used by manifest assembly.

Canonical defaults for Phase 1 route policy declarations.

Aggregated compile-time diagnostics for Crosswake route policy.

Structured compile-time route policy error with route-local context.

Merge helpers for router-authored Crosswake policy.

Normalized Phase 1 route policy contract.

Attaches and extracts compiled Crosswake route policy from Phoenix route metadata.

NimbleOptions schema for Phase 1 Crosswake route policy declarations.

Semantic invariant checks for normalized Crosswake route policy.

Non-blocking adoption warning for unmanaged routes.

Phoenix-native router DSL for authoring Crosswake policy next to routes.

Applies nested Crosswake defaults directly to router AST.

Shared activation contract for native shell entrypoints.

Stable denial envelope shared by shell activation and bounded bridge replies.

Canonical bundled shell fixtures derived from manifest truth, shared activation contracts, and stable denial vocabulary.

Canonical support-matrix truth shared across manifest generation, doctor, and docs.

Deterministic Markdown renderer for the canonical support matrix guide.

Typed, versioned route-local transfer declarations for upload, download, import, and export seams.

Route-local transfer runtime status helpers.

Mix Tasks

Runs host-truth-first diagnostics over installer state, route-policy compilation, manifest validity, and support-matrix consistency.

Generates reviewable iOS or Android shell baselines, bundled manifest-backed activation fixtures, and explicit ownership guidance without claiming runtime behavior Crosswake has not proven yet.

Bootstraps a Phoenix host for Crosswake with explicit markers, a host-owned policy module, and a machine-readable install manifest.