AshIntrospection.
Copy Markdown
View Source
Unified field selection processor using type-driven recursive dispatch.
This module mirrors the architecture of ValueFormatter, using the same
{type, constraints} pattern for type-driven dispatch. Each type is
self-describing - no separate classification step is needed.
This is a shared module used by both AshTypescript and AshKotlinMultiplatform. Language-specific behavior is configured via the config parameter.
Design Principle
The key insight is that field selection and value formatting are parallel operations - both traverse composite types recursively based on type information. By using the same dispatch pattern, we achieve consistency and simplicity.
Type Categories
| Category | Detection | Handler |
|---|---|---|
| Ash Resource | ResourceInfo.runtime_resource?(type, config) | select_resource_fields/4 |
| TypedStruct/NewType | field_names callback | select_typed_struct_fields/4 |
| Typed Map/Struct | Has fields constraints | select_typed_map_fields/5 |
| Tuple | Ash.Type.Tuple | select_tuple_fields/4 |
| Union | Ash.Type.Union | select_union_fields/5 |
| Array | {:array, inner_type} | Recurse with inner type |
| Primitive | Default | Validate no fields requested |
Summary
Functions
Converts an action to its type specification.
Processes requested fields for a given resource and action.
Main recursive dispatch function for field selection.
Selects fields from an Ash resource.
Selects fields from a tuple type using named fields.
Selects fields from a typed map (Ash.Type.Map/Keyword with field constraints).
Selects fields from a TypedStruct or NewType with field_names callback.
Selects fields from a union type.
Types
@type config() :: %{ optional(:input_field_formatter) => atom(), optional(:field_names_callback) => atom(), optional(:resource_info_module) => module(), optional(:is_interop_resource?) => (module() -> boolean()), optional(:get_original_field_name) => (module(), term() -> atom() | nil), optional(:load_restrictions) => term(), optional(:manifest) => Ash.Info.Manifest.t() | AshIntrospection.ResourceInfo.Source.t() | nil }
Functions
@spec action_to_type_spec(module(), Ash.Resource.Actions.action()) :: {atom() | tuple(), keyword()}
Converts an action to its type specification.
Returns {type, constraints} tuple representing the action's return type.
Processes requested fields for a given resource and action.
Returns {:ok, {select_fields, load_fields, extraction_template}} or {:error, error}.
Parameters
resource- The Ash resource moduleaction_name- The action name (atom)requested_fields- List of field selections (atoms, strings, or maps)config- Language-specific configuration. An optional:load_restrictionskey shapes which relationships, calculations and aggregates the caller may ask for - seeAshIntrospection.Rpc.LoadRestrictions. Omitting it permits every load.
Examples
iex> process(MyApp.Todo, :read, [:id, :title, %{user: [:id, :name]}], %{})
{:ok, {[:id, :title], [{:user, [:id, :name]}], [:id, :title, {:user, [:id, :name]}]}}Main recursive dispatch function for field selection.
Mirrors ValueFormatter.format/5 - uses the same type detection and dispatch pattern.
Each type category has its own handler that may recurse back into this function.
Selects fields from an Ash resource.
Handles attributes, calculations, relationships, and aggregates.
Selects fields from a tuple type using named fields.
Selects fields from a typed map (Ash.Type.Map/Keyword with field constraints).
Selects fields from a TypedStruct or NewType with field_names callback.
Selects fields from a union type.