Jido.Tools.ActionPlan behaviour (Jido Action v2.3.0)

A behavior and macro for creating actions that execute Jido Plans.

Provides a standardized way to create actions that build and execute plans with configurable plan building and result transformation.

Usage

defmodule MyWorkflowAction do
  use Jido.Tools.ActionPlan,
    name: "my_workflow",
    description: "Executes a multi-step workflow"

  @impl Jido.Tools.ActionPlan
  def build(params, context) do
    Plan.new(context: context)
    |> Plan.add(:fetch, MyApp.FetchAction, params)
    |> Plan.add(:validate, MyApp.ValidateAction, depends_on: :fetch)
    |> Plan.add(:save, MyApp.SaveAction, depends_on: :validate)
  end

  @impl Jido.Tools.ActionPlan
  def transform_result(result) do
    # Optional: Transform the execution result
    {:ok, %{workflow_result: result}}
  end
end

Callbacks

build/2 (required) - Build the Plan struct from params and context
transform_result/1 (optional) - Transform the execution result

Summary

Callbacks

build(params, context)

Required callback for building a Plan struct.

transform_result(map)

Optional callback for transforming the execution result.

Functions

__using__(opts)

Macro for setting up a module as an ActionPlan with plan execution capabilities.

Callbacks

build(params, context)

@callback build(params :: map(), context :: map()) :: Jido.Plan.t()

Required callback for building a Plan struct.

Takes the action parameters and context and returns a Plan struct that will be executed.

transform_result(map)

(optional)

@callback transform_result(map()) :: {:ok, map()} | {:error, Exception.t() | term()}

Optional callback for transforming the execution result.

Takes the plan execution result and returns a transformed result.

Functions

using(opts)

(macro)

@spec __using__(keyword()) :: Macro.t()

Macro for setting up a module as an ActionPlan with plan execution capabilities.