Definitively.Run.Coordinator (definitively v0.3.1)

Application facade for starting and controlling ephemeral workflow runs.

Summary

Functions

approve(run_id, label)

Approves an approval gate (label must exist on the current state's on map).

cancel(run_id)

Cancels a run when the program defines a :failed final state.

resume(run_id, opts \\ [])

Continues an in-flight run until final, approval, or error.

run_until_final(program_path, opts \\ [])

Starts a run from a YAML program path; drives active nodes until a final state.

start(program_path, opts \\ [])

Loads a program and starts an engine process registered by run_id.

status(run_id)

Returns a snapshot of the run's current FSM state.

step(run_id, opts \\ [])

Executes the active node, classifies the result, and transitions the engine.

Functions

approve(run_id, label)

@spec approve(String.t(), atom()) :: :ok | {:error, term()}

Approves an approval gate (label must exist on the current state's on map).

cancel(run_id)

@spec cancel(String.t()) :: :ok | {:error, term()}

Cancels a run when the program defines a :failed final state.

resume(run_id, opts \\ [])

@spec resume(
  String.t(),
  keyword()
) :: :ok | {:error, term()}

Continues an in-flight run until final, approval, or error.

run_until_final(program_path, opts \\ [])

@spec run_until_final(
  Path.t(),
  keyword()
) :: :ok | {:error, term()}

Starts a run from a YAML program path; drives active nodes until a final state.

start(program_path, opts \\ [])

@spec start(
  Path.t(),
  keyword()
) :: {:ok, String.t()} | {:error, term()}

Loads a program and starts an engine process registered by run_id.

status(run_id)

@spec status(String.t()) :: {:ok, Definitively.Run.Snapshot.t()} | {:error, term()}

Returns a snapshot of the run's current FSM state.

step(run_id, opts \\ [])

@spec step(
  String.t(),
  keyword()
) :: :ok | {:error, term()} | :retry

Executes the active node, classifies the result, and transitions the engine.