SquidMesh (squid_mesh v0.1.0-alpha.3)

Public entrypoint for the Squid Mesh runtime.

The API exposed here stays focused on declarative workflow operations. Host applications start, inspect, and later control runs through this surface without needing to work directly with persistence internals.

Summary

Functions

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

Approves a paused approval step and resumes the run through its success path.

cancel_run(run_id, overrides \\ [])

Requests cancellation for an eligible workflow run.

config(overrides \\ [])

Loads Squid Mesh configuration from the application environment with optional runtime overrides.

config!(overrides \\ [])

Loads Squid Mesh configuration and raises if required keys are missing.

inspect_run(run_id, overrides \\ [])

Fetches one workflow run by id.

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

Lists workflow runs with optional filters.

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

Rejects a paused approval step and resumes the run through its rejection path.

replay_run(run_id, overrides \\ [])

Creates a new run from a prior run and links it to the original run.

start_run(workflow, payload)

Starts a new workflow run with the given payload through the workflow's default trigger.

start_run(workflow, payload, overrides)

Starts a new workflow run through a named trigger with the given payload.

start_run(workflow, trigger_name, payload, overrides)

unblock_run(run_id)

Resumes a run that is intentionally paused for manual intervention.

unblock_run(run_id, overrides)

unblock_run(run_id, attrs, overrides)

Functions

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

@spec approve_run(Ecto.UUID.t(), map(), keyword()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}

Approves a paused approval step and resumes the run through its success path.

cancel_run(run_id, overrides \\ [])

@spec cancel_run(
  Ecto.UUID.t(),
  keyword()
) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()}

Requests cancellation for an eligible workflow run.

config(overrides \\ [])

@spec config(keyword()) ::
  {:ok, SquidMesh.Config.t()} | {:error, {:missing_config, [atom()]}}

Loads Squid Mesh configuration from the application environment with optional runtime overrides.

config!(overrides \\ [])

@spec config!(keyword()) :: SquidMesh.Config.t()

Loads Squid Mesh configuration and raises if required keys are missing.

inspect_run(run_id, overrides \\ [])

@spec inspect_run(
  Ecto.UUID.t(),
  keyword()
) ::
  {:ok, SquidMesh.Run.t()} | {:error, :not_found | {:missing_config, [atom()]}}

Fetches one workflow run by id.

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

@spec list_runs(
  SquidMesh.RunStore.list_filters(),
  keyword()
) :: {:ok, [SquidMesh.Run.t()]} | {:error, {:missing_config, [atom()]}}

Lists workflow runs with optional filters.

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

@spec reject_run(Ecto.UUID.t(), map(), keyword()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}

Rejects a paused approval step and resumes the run through its rejection path.

replay_run(run_id, overrides \\ [])

@spec replay_run(
  Ecto.UUID.t(),
  keyword()
) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.replay_error()}
  | {:error, {:dispatch_failed, term()}}

Creates a new run from a prior run and links it to the original run.

start_run(workflow, payload)

@spec start_run(module(), map()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error, {:missing_config, [atom()]}}
  | {:error, SquidMesh.RunStore.create_error()}
  | {:error, {:dispatch_failed, term()}}

Starts a new workflow run with the given payload through the workflow's default trigger.

start_run(workflow, payload, overrides)

@spec start_run(module(), map(), keyword()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error, {:missing_config, [atom()]}}
  | {:error, SquidMesh.RunStore.create_error()}
  | {:error, {:dispatch_failed, term()}}

@spec start_run(module(), atom(), map()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error, {:missing_config, [atom()]}}
  | {:error, SquidMesh.RunStore.create_error()}
  | {:error, {:dispatch_failed, term()}}

Starts a new workflow run through a named trigger with the given payload.

start_run(workflow, trigger_name, payload, overrides)

@spec start_run(module(), atom(), map(), keyword()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error, {:missing_config, [atom()]}}
  | {:error, SquidMesh.RunStore.create_error()}
  | {:error, {:dispatch_failed, term()}}

unblock_run(run_id)

@spec unblock_run(Ecto.UUID.t()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}

Resumes a run that is intentionally paused for manual intervention.

unblock_run(run_id, overrides)

@spec unblock_run(
  Ecto.UUID.t(),
  keyword()
) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}

@spec unblock_run(Ecto.UUID.t(), map()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}

unblock_run(run_id, attrs, overrides)

@spec unblock_run(Ecto.UUID.t(), map(), keyword()) ::
  {:ok, SquidMesh.Run.t()}
  | {:error,
     :not_found
     | {:missing_config, [atom()]}
     | SquidMesh.RunStore.transition_error()
     | term()}