Squidie.Workflow.Info (squidie v0.1.2)

Copy Markdown View Source

Read helpers for compiled Squidie workflow Spark metadata.

The runtime still exposes workflow_definition/0 for durable execution, while this module gives tests, tooling, and planner adapters direct access to the normalized workflow specification produced by the workflow DSL.

Summary

Functions

Returns the optional workflow definition version.

Fetches the normalized workflow spec.

Returns the merged workflow payload contract.

Returns normalized retry policies.

Returns the normalized, serializable workflow spec.

Returns Spark step entities with runtime-resolved native step metadata.

Returns normalized workflow transitions.

Returns normalized workflow triggers.

Functions

definition_version(workflow)

@spec definition_version(module()) :: String.t() | nil

Returns the optional workflow definition version.

fetch_spec(workflow)

@spec fetch_spec(module()) ::
  {:ok, Squidie.Workflow.Spec.t()}
  | {:error, Squidie.Workflow.Definition.load_error()}

Fetches the normalized workflow spec.

payload(workflow)

Returns the merged workflow payload contract.

retries(workflow)

@spec retries(module()) :: [Squidie.Workflow.Definition.retry()]

Returns normalized retry policies.

spec(workflow)

@spec spec(module()) :: Squidie.Workflow.Spec.t()

Returns the normalized, serializable workflow spec.

steps(workflow)

@spec steps(module()) :: [Squidie.Workflow.StepSpec.t()]

Returns Spark step entities with runtime-resolved native step metadata.

transitions(workflow)

@spec transitions(module()) :: [Squidie.Workflow.Definition.transition()]

Returns normalized workflow transitions.

triggers(workflow)

@spec triggers(module()) :: [Squidie.Workflow.Definition.trigger()]

Returns normalized workflow triggers.