# Alva v0.1.0 - Table of Contents

> Ash Live Vue Adapter (Alva) connects Ash Framework resources seamlessly to Phoenix LiveView and Vue 3 with end-to-end TypeScript code generation.

## GUIDES

- [Alva](readme.md)
- [Getting Started with Alva SDK](01-getting-started.md)
- [Ash Backend Setup](02-ash-backend-setup.md)
- [Phoenix LiveView Integration](03-liveview-integration.md)
- [Queries and Actions](04-queries-and-actions.md)
- [Forms and Mutations](05-forms-and-mutations.md)
- [Frontend Composables API Reference](06-frontend-composables.md)
- [LiveView Uploads](07-uploads.md)
- [Real-Time Streams](08-streams.md)
- [Real-Time Signals (PubSub)](09-signals.md)

## Modules

- [Alva](Alva.md): 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`.
- [Alva.Codegen.DtoGenerator](Alva.Codegen.DtoGenerator.md): Generates TypeScript interfaces for Ash resources and their filter types.
- [Alva.Codegen.InputContract](Alva.Codegen.InputContract.md): Generates TypeScript input type shapes for Ash actions.
- [Alva.Codegen.TypeMapper](Alva.Codegen.TypeMapper.md): Maps Ash type specifications to TypeScript type annotations.
- [Alva.Dispatcher](Alva.Dispatcher.md): Dynamically routes events from Vue to Ash actions based on Spark DSL.
- [Alva.Error](Alva.Error.md): Normalizes Ash errors into a standard format consumed by the Vue frontend.
- [Alva.LiveView](Alva.LiveView.md): A macro to inject Alva-specific functionality into Phoenix LiveViews.
- [Alva.Registry](Alva.Registry.md): Host-app registry boundary for Alva runtime and code generation.
- [Alva.Resource](Alva.Resource.md): Spark DSL Extension for LiveVue configuration in Ash Resources.
- [Alva.Resource.Event](Alva.Resource.Event.md): Represents a single `event` definition within an `Alva.Resource` block.
- [Alva.Resource.Signal](Alva.Resource.Signal.md): Represents a single `signal` definition within an `Alva.Resource` block.
- [Alva.Resource.Verifiers.VerifyActions](Alva.Resource.Verifiers.VerifyActions.md): A Spark DSL verifier for `Alva.Resource`.
- [Alva.Result](Alva.Result.md): Applies LiveView-specific side effects to the socket based on the result
of an `Alva.Dispatcher.dispatch/3` call and a requested strategy.
- [Alva.Serializer](Alva.Serializer.md): Translates Ash records into JSON-friendly payloads, extracting explicitly exposed metadata
and stripping internal fields.
- [Alva.Test](Alva.Test.md): Provides test helpers for verifying Alva dispatch events.

## Mix Tasks

- [mix alva.check](Mix.Tasks.Alva.Check.md): Audits Ash resources and TypeScript SDK files for Alva.
- [mix alva.codegen](Mix.Tasks.Alva.Codegen.md): Generates TypeScript bindings for LiveVue events defined in Ash resources.
- [mix alva.watch](Mix.Tasks.Alva.Watch.md): Watches `lib/**/*.ex` for file modifications and automatically re-runs `mix alva.codegen`.

