API Reference crosswake v#0.2.3

Public entry point for Crosswake policy authoring and normalization.

Closed, version-bound topology compilation from validated first-adopter route rows.

Closed, sanitized route-row validation for first-adopter planning inputs.

The typed control-contract seam every future native-controls pack rides on.

Merge-blocking structural guard for the Phase 154 catalog line (CTRL-04, PROOF-04).

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.

Internal wire-decode envelope for bounded bridge deny replies (demoted, Phase 154, D-28).

Raised by Crosswake.Bridge.push/3 when called on a socket that never called Crosswake.Bridge.attach/1 (directly or via on_mount: Crosswake.Bridge). Crosswake never guesses a route id — a missing attach call is a distinct, named, install-time failure surface rather than a silent no-op.

Manifest-backed Phase 3 bridge allowlist.

Adopter-facing typed reply delivered to handle_info/2.

Raised by Crosswake.Bridge.push/3 when a route's policy never declared the requested capability family. This is an outbound preflight failure (D-04): nothing has reached the wire and no shell has been asked, so there is no shell fact for a Crosswake.Shell.Denial to honestly report (D-06). It raises unconditionally, in every environment including :prod (D-05) — the message names the route id, the missing family, what IS currently declared, the calling LiveView module, the router location (best-effort), and the literal capabilities line to add.

Raised by Crosswake.Bridge.push/3 when the requested capability family is not a member of the bridge's closed vocabulary at all — a different problem from Crosswake.Bridge.UndeclaredCapabilityError, which fires for a family the bridge DOES know about that this route's policy simply never declared.

Canonical capability-map truth for support posture, proof posture, and first adopter pressure.

Deterministic Markdown renderer for the canonical capability map guide.

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.

Behaviour for first-party Phoenix-native companion integrations.

Typed runtime state snapshot returned by report_state/0.

Merge-blocking AST guards for Phase 130 companion extraction.

Layered compatibility evaluation for manifests and route activation.

Typed restriction evidence returned by route_gated?/2 and evaluate_auth/3.

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

Evaluation context passed to companion callbacks route_gated?/2 and kill_switch_active?/1.

Merge-blocking structural guard for FALL-02 — "nothing UI-shaped ships importable from lib/" (Phase 155).

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.

Deterministic release/support readiness checks for mix crosswake.doctor --check-publish.

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.

Typed route definition passed as the first argument to route_gated?/2.

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.

The closed Phoenix-to-native transition seam for the first-adopter iOS shell.

Data structure representing an offline content pack.

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.

Closed, transport-independent observation vocabulary for scoped replay.

Stable route-local offline vocabulary for Crosswake support surfaces.

Stable telemetry metadata contract for offline transitions and outcomes.

Route-authoritative operator inspection contract.

Human-readable formatter for route-authoritative operator inspection documents.

Stable JSON formatter for operator inspection documents.

Typed operator inspection contract.

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.

Deterministic closeout checks for milestone planning artifacts.

Routes first-adopter planning context to its permitted destination and provides deterministic, browser-free privacy checks for repository-facing material.

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.

Closed, non-echoing configuration for a host-owned proof lane.

Builds the deliberately small, privacy-safe proof-lane evidence artifact.

Renders a host-owned proof lane with atomic, missing-only writes.

Closed, versioned vocabulary for a single physical-iPhone proof run.

Ordered, callback-driven, side-effect-free physical-iPhone readiness gate.

Pure release-candidate evaluation and receipt authority.

Validates candidate-local Hex tarball observations and derives normalized payload evidence.

Validates bounded clean-room observations for candidate and exact-public package proofs.

Validates the closed candidate release coordinate graph from distributable metadata.

Evaluates bounded iOS mirror observations without owning Git credentials or mutation.

Reads Crosswake's release graph and reports local package-family release readiness.

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

Applies nested Crosswake defaults directly to router AST.

Policy contract deriving OTA-safe vs. rebuild-required classification from the existing native_runtime_version compatibility axis.

Shared activation contract for native shell entrypoints.

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

Behaviour-only transport seam for the diagnostic export contract.

Typed, versioned diagnostic envelope with layer attribution (D-06).

Typed diagnostic codes for native-layer (iOS/Android) diagnostic events.

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.

Core structs for the sync event log.

Canonical public API for Crosswake telemetry events.

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

Route-local transfer runtime status helpers.

Runs deterministic closeout checks over planning artifacts and release truth.

Maintainer task: increments the integer @template_version in lib/mix/tasks/crosswake.gen.shell.ex AND recomputes and rewrites @checked_in_hash in test/crosswake/proof/phase134_template_version_drift_test.exs.

Regenerates the four non-Elixir contract surfaces that derive from Crosswake.Bridge.Contract.version()

Thin alias that shells out to bin/see-it-run.sh and streams its live output (the readiness progress dots + plain-ASCII banner) to the user's terminal.

Synchronizes the checked-in support and capability guides with their canonical executable owners.

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

Teaches you how to wire the library-owned bridge hook — and, with --eject, writes a host-owned copy you then own forever.

Generates host-owned, brand-tokenized native-controls fallback UI.

Generates host-owned offline UI components.

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.

Emits a route-authoritative Crosswake operator inspection document.

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

Runs the host-owned physical-iPhone proof only after closed preflight.

Evaluates one exact Crosswake candidate and writes its authoritative receipt.

Reports the local release graph, version drift, release-as staleness, and workflow guard posture for Crosswake's Hex/native package family. By default this task only reads checked-in files.

Read-only staleness check for generated Crosswake native shells.