API Reference PhoenixAssets v#0.1.0

Runtime and generated contracts for Phoenix applications built with Vite.

Canonical, byte-stable JSON encoding for the artifacts the library writes.

Integration plugin that generates a typed mutation client from declarations.

DSL for declaring the server mutations that drive generated TypeScript clients.

Phoenix function components for emitting Vite assets and mounting Svelte pages.

Validated, normalized configuration for phoenix_assets.

The read-only snapshot threaded through every plugin callback.

Runtime introspection helpers for the asset pipeline, reachable from Tidewave.

A declaration of an external development process to supervise (Vite, Storybook).

Tracks supervised dev processes and buffers their output.

Supervises the development asset processes for a host application.

Runs configuration and production-readiness diagnostics.

A single diagnostic the doctor can run against a context.

An opt-in plug that sends HTTP 103 Early Hints for a Vite entry's assets.

Integration plugin that generates a typed ElectricSQL client from declarations.

DSL for declaring ElectricSQL shapes that drive generated TypeScript clients.

Initialises plugins and collects their declarations.

Integration plugin that emits every Ash.Type.Enum as localized options.

Writes plugin-contributed TypeScript contracts to disk.

Regenerates frontend contracts when backend source changes, in development.

A single generated frontend-contract file contributed by a plugin.

Generates a typed, allow-listed environment module for the frontend.

Generates typed Phoenix endpoint helpers from the router.

Shared helpers for rendering generated TypeScript.

Renders named Elixir typespecs as TypeScript declarations.

The Phoenix Asset Graph: one artifact linking Phoenix concepts to build output.

Assembles the Phoenix Asset Graph map from plugins and the Vite manifest.

Embeds the asset graph in a module for in-memory runtime lookups.

One node in the Phoenix Asset Graph.

Integration plugin that generates the locale contract for the frontend.

Parses and queries a Vite build manifest.

Holds the parsed Vite manifest for fast, lock-free reads.

Shared helpers for the phoenix_assets.* Mix tasks.

A development plug exposing asset-runtime status at GET /__assets/status.

The behaviour every phoenix_assets integration implements.

Resolves a list of plugins into a deterministic execution order.

A deterministic composition of PhoenixAssets.Plugin integrations.

The built-in default preset: the full Svelte stack.

Integration plugin that generates typed PubSub topic builders and an event union.

DSL for declaring Phoenix PubSub topics and their event payloads.

Integration plugin that generates the authenticated-context contract.

DSL for declaring the authenticated context both sides of the app must agree on.

Integration plugin that supervises Storybook alongside the app.

Integration plugin for SvelteKit (with Vite) under phoenix_assets.

Integration plugin for Tailwind CSS (via @tailwindcss/vite).

Telemetry instrumentation for phoenix_assets.

Integration plugin that generates TypeScript row types from Ash resources.

DSL for declaring which Ash resources become generated TypeScript row types.

Walks Ash resources and renders TypeScript row types.

Integration plugin that generates TypeScript from Elixir typespecs.

Removes the files this library generates.

Runs phoenix_assets diagnostics and prints a grouped report.

Generates the typed frontend contracts declared by the configured preset.

Generates only the command (mutation) contract. See mix help phoenix_assets.gen.

Generates only the ElectricSQL shapes contract. See mix help phoenix_assets.gen.

Generates only the env contract. See mix help phoenix_assets.gen.

Generates only the locales contract. See mix help phoenix_assets.gen.

Generates only the PubSub topics contract. See mix help phoenix_assets.gen.

Generates only the routes contract. See mix help phoenix_assets.gen.

Generates only the session (context) contract. See mix help phoenix_assets.gen.

Generates only the TypeScript types contract. See mix help phoenix_assets.gen.

Builds the Phoenix Asset Graph and writes it to graph.json.

Installs and configures phoenix_assets in a Phoenix application.