SquidSonar.Runs (squid_sonar v0.2.0)

Read boundary for Squidie workflow runs.

LiveViews should call this module instead of calling Squidie directly. That keeps runtime access, error handling, and view shaping in one place.

Summary

Types

option()

Functions

approve_run(run_id, attrs, opts \\ [])

Approves a paused approval step and resumes through success path.

cancel_run(run_id, opts \\ [])

Cancels an eligible workflow run.

get_run(run_id, opts \\ [])

Fetches one run with runtime snapshot, graph projection, and diagnostic explanation.

list_runs(filters \\ [], opts \\ [])

Lists recent runs as UI-friendly summaries.

reject_run(run_id, attrs, opts \\ [])

Rejects a paused approval step and resumes through rejection path.

replay_run(run_id, opts \\ [])

Replays a completed or failed workflow run.

resume_run(run_id, attrs, opts \\ [])

Resumes a paused workflow run.

start_spec(spec, payload, opts \\ [])

Starts a run from a host-provided runtime workflow spec.

start_workflow(workflow, payload, opts \\ [])

Starts a run from a host-provided Squidie workflow module.

Types

option()

@type option() ::
  {:client, module()} | {:squidie, keyword()} | {:action_registry, term()}

Functions

approve_run(run_id, attrs, opts \\ [])

@spec approve_run(term(), map(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Approves a paused approval step and resumes through success path.

cancel_run(run_id, opts \\ [])

@spec cancel_run(term(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Cancels an eligible workflow run.

get_run(run_id, opts \\ [])

@spec get_run(term(), [option()]) ::
  {:ok, SquidSonar.Runs.RunDetail.t()} | {:error, term()}

Fetches one run with runtime snapshot, graph projection, and diagnostic explanation.

list_runs(filters \\ [], opts \\ [])

@spec list_runs(
  keyword(),
  [option()]
) :: {:ok, [SquidSonar.Runs.RunSummary.t()]} | {:error, term()}

Lists recent runs as UI-friendly summaries.

reject_run(run_id, attrs, opts \\ [])

@spec reject_run(term(), map(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Rejects a paused approval step and resumes through rejection path.

replay_run(run_id, opts \\ [])

@spec replay_run(term(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Replays a completed or failed workflow run.

resume_run(run_id, attrs, opts \\ [])

@spec resume_run(term(), map(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Resumes a paused workflow run.

start_spec(spec, payload, opts \\ [])

@spec start_spec(term(), map(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Starts a run from a host-provided runtime workflow spec.

start_workflow(workflow, payload, opts \\ [])

@spec start_workflow(module(), map(), [option()]) ::
  {:ok, Squidie.ReadModel.Inspection.Snapshot.t()} | {:error, term()}

Starts a run from a host-provided Squidie workflow module.