API Reference squid_mesh v#0.1.0

Copy Markdown View Source

Modules

Public entrypoint for the Squid Mesh runtime.

Loads and validates host application configuration for Squid Mesh.

Behaviour implemented by host applications to schedule Squid Mesh cron work.

Behaviour for backends that own worker claims and lease extension.

Backend-neutral worker claim returned by a lease adapter.

Backend-neutral cron payloads that host schedulers can hand to their queue.

Persisted checkpoint value for a Jido storage key.

Append-only persisted Jido journal entry.

Persisted metadata for one Jido journal thread.

Projection-backed explanation for the journal-backed runtime.

Deterministic explanation built from a projection-backed inspection snapshot.

Projection-backed inspection for the journal-backed runtime.

Projection-backed inspection snapshot for one Jido-native workflow run.

Projection-backed run listing for the journal-backed runtime.

Redacted journal-backed run listing row.

Actor-scoped read-model redaction helpers.

Validated, read-only preview of one dynamic work record.

Graph-oriented inspection output for one workflow run.

Public graph edge for workflow run inspection.

Public graph node for workflow run inspection.

Restart recovery coordinator for Jido-native workflow and dispatch agents.

Executes declarative built-in workflow steps.

Jido-native dispatch coordination state for one durable dispatch queue.

Boundary for live dispatch wakeups emitted after durable scheduling.

Defines the durable dispatch journal contract.

Rebuildable projection of one dispatch attempt.

One durable runtime journal entry.

Rebuildable projection over durable dispatch journal entries.

Storage boundary for Squid Mesh durable runtime facts.

Journal-backed workflow cancellation.

A compact projection snapshot with the durable thread revision it covers.

Executes one visible attempt from the journal-backed runtime queue.

Journal-backed manual intervention controls.

Validates public options that reach journal-backed runtime threads.

Journal-backed workflow replay.

Journal-backed workflow start boundary for the Jido-native runtime.

Normalized storage boundary for journal-backed runtime state.

Postgres-compatible Ecto storage adapter for Squid Mesh journal runtime state.

Validation and serialization helpers for durable manual workflow actions.

Resolves workflow retry configuration into concrete runtime decisions.

Rebuildable projection over the global journal run catalog.

Rebuildable projection over a workflow's run-index journal.

Backend-neutral runtime entrypoints for host scheduler jobs.

Builds stable identities for scheduled workflow activations.

Normalizes scheduler metadata for cron-triggered workflow starts.

Squid Mesh-native runtime command signal envelope.

Converts Squid Mesh runtime command signals to and from Jido.Signal.

Step-execution input normalization for the runtime.

Jido-native workflow coordination state for one durable workflow run.

Rebuildable workflow-agent projection over one run-thread journal.

Public contract for authoring native Squid Mesh workflow steps.

Internal Jido action adapter for native Squid Mesh steps.

Durable runtime context passed to native Squid Mesh steps.

Public boundary for invoking external tools from workflow steps.

Behaviour for Squid Mesh tool adapters.

Normalized tool failure shape.

HTTP tool adapter backed by Req.

Normalized successful tool result.

Declarative workflow contract for Squid Mesh workflow modules.

Host-owned trust boundary for runtime-authored workflow actions.

Runtime-facing representation of a compiled workflow definition.

Spark DSL wrapper for Squid Mesh workflow declarations.

JSON-safe workflow spec projection for visual editors.

Read helpers for compiled Squid Mesh workflow Spark metadata.

Spark entity for one trigger payload field.

Spark entity for a trigger payload block.

Spark extension that defines the Squid Mesh workflow DSL.

Serializable, normalized workflow specification used to rebuild planner state.

Spark entity for one declared Squid Mesh workflow step.

Spark entity for one declared workflow transition.

Spark entity for one concrete trigger kind inside a workflow trigger.

Spark entity for one Squid Mesh workflow trigger declaration.

Compile-time validation and normalization for workflow modules.

Mix Tasks

Installs Squid Mesh by creating its migration in the host application.