Squidie.Inspection.DynamicWorkPreview (squidie v0.3.2)

Copy Markdown View Source

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

Preview values are intended for dashboards, CLIs, and visual editors that need to inspect the graph impact of a dynamic work payload before appending a durable journal fact.

Summary

Types

t()

Functions

new(run_id, dynamic_work, duplicate?, graph)

Builds a preview for proposed dynamic work and the resulting run graph.

to_map(preview)

Converts a dynamic work preview to a plain map for JSON encoding.

Types

t()

@type t() :: %Squidie.Inspection.DynamicWorkPreview{
  added_edge_ids: [String.t()],
  added_node_ids: [String.t()],
  duplicate?: boolean(),
  dynamic_work: map(),
  graph: Squidie.Inspection.GraphInspection.t(),
  origin_node_id: String.t() | nil,
  recordable?: boolean(),
  run_id: String.t(),
  warnings: [atom()]
}

Functions

new(run_id, dynamic_work, duplicate?, graph)

@spec new(String.t(), map(), boolean(), Squidie.Inspection.GraphInspection.t()) :: t()

Builds a preview for proposed dynamic work and the resulting run graph.

to_map(preview)

@spec to_map(t()) :: map()

Converts a dynamic work preview to a plain map for JSON encoding.