API Reference Alva v#0.1.0

Copy Markdown View Source

Modules

Alva provides a fully typed, auto-generated TypeScript SDK for Vue 3 that seamlessly bridges your Vue frontend with your Elixir/Ash backend via Phoenix.LiveView.

Generates TypeScript interfaces for Ash resources and their filter types.

Generates TypeScript input type shapes for Ash actions.

Maps Ash type specifications to TypeScript type annotations.

Dynamically routes events from Vue to Ash actions based on Spark DSL.

Normalizes Ash errors into a standard format consumed by the Vue frontend.

A macro to inject Alva-specific functionality into Phoenix LiveViews.

Host-app registry boundary for Alva runtime and code generation.

Spark DSL Extension for LiveVue configuration in Ash Resources.

Represents a single event definition within an Alva.Resource block.

Represents a single signal definition within an Alva.Resource block.

Applies LiveView-specific side effects to the socket based on the result of an Alva.Dispatcher.dispatch/3 call and a requested strategy.

Translates Ash records into JSON-friendly payloads, extracting explicitly exposed metadata and stripping internal fields.

Provides test helpers for verifying Alva dispatch events.

Mix Tasks

Audits Ash resources and TypeScript SDK files for Alva.

Generates TypeScript bindings for LiveVue events defined in Ash resources.

Watches lib/**/*.ex for file modifications and automatically re-runs mix alva.codegen.