Schemas And Validation
View SourceJido uses Zoi schemas for Action input and output, Flow input and output, and Iterate State. Schemas are static module data.
Action Schemas
defmodule MyApp.Actions.Price do
use Jido.Action,
name: "price",
schema:
Zoi.object(%{
quantity: Zoi.integer() |> Zoi.min(1),
unit_price: Zoi.number()
}),
output_schema: Zoi.object(%{total: Zoi.number()})
@impl true
def run(params, _context) do
{:ok, %{total: params.quantity * params.unit_price}}
end
endAn Action schema must accept map-shaped data. [] means that no field schema
is applied, but the Action boundary still requires a map.
Direct object and struct schemas are open at the Jido boundary. Declared root
fields are validated. Unknown root fields stay in the returned map. Jido treats
Zoi unrecognized_keys: :strip as :preserve at this root. Zoi :error and
typed preservation policies stay unchanged.
{:ok, validated} =
MyApp.Actions.Price.validate_params(%{
quantity: 2,
unit_price: 3.5,
request_tag: "keep"
})
validated.request_tagNested and wrapped schemas use normal Zoi unknown-key behavior. Set the policy on each nested object that must preserve unknown fields.
Zoi.object(%{
customer:
Zoi.object(%{name: Zoi.string()}, unrecognized_keys: :preserve)
})Flow Schemas
A Flow module uses the same options.
defmodule MyApp.Flows.PriceOrder do
use Jido.Flow,
name: "price_order",
schema: Zoi.object(%{quantity: Zoi.integer(), unit_price: Zoi.number()}),
output_schema: Zoi.object(%{total: Zoi.number()})
flow do
step "price",
action: MyApp.Actions.Price,
params: %{
quantity: input(:quantity),
unit_price: input(:unit_price)
}
output result("price")
end
endFlow input validation occurs before compilation work starts. Output validation occurs after Jido evaluates the explicit output expression.
Static Schema Rule
Action and Flow module schemas must be safe to store in compiled module data. Anonymous functions, lazy schemas, PIDs, ports, and references are not accepted. Use a named MFA for effects in a refinement or transform.
Zoi.string()
|> Zoi.refine({MyApp.Validation, :not_blank, []})The same static-data rule applies to Iterate State schemas and schemas placed in a trusted Flow Registry.
Iterate State
An Iterate State schema validates each state replacement.
state(
Zoi.object(%{count: Zoi.integer()}),
initial: %{count: 0}
)A rejected state stops the Iterate node. Jido does not add the rejected state value to the error details.
Test Both Boundaries
Test constructors and generated validation functions for data rules. Then use
Jido.Exec.run/4 to test the complete execution boundary. Constructor
validation is inert. It never calls an Action.