renderFrame

Use renderFrame to preview the task graph (CI validation, graph-inspection UIs, dry-run checks) without executing or persisting anything. It parses ctx.input through the workflow input schema first, applying defaults and transforms to a derived context without mutating the supplied context. runId and iteration are arbitrary strings used only for snapshot identity.

import { renderFrame } from "smthrs";
import { SmithersCtx } from "@smthrs/driver";
import { Effect } from "effect";

const ctx = new SmithersCtx({ runId: "preview", iteration: 0, input: { task: "preview" }, outputs: {} });
const snap = await Effect.runPromise(renderFrame(workflow, ctx));

snap.frameNo;       // 0
snap.tasks;         // TaskDescriptor[]
snap.xml;           // XmlNode | null (see Types)

TaskDescriptor and GraphSnapshot are defined in Types: the runtime extracts this same shape on every render frame. outputs lets you simulate completed upstream tasks:

const ctx = new SmithersCtx({
  runId: "sim", iteration: 0, input: { x: 1 },
  outputs: {
    analyze: [{ runId: "sim", nodeId: "analyze", iteration: 0, summary: "..." }],
  },
});
const snap = await Effect.runPromise(renderFrame(workflow, ctx));

CLI equivalent:

bunx smthrs graph workflow.tsx --input '{"task":"preview"}'

Overview

Core API

Runtime

Types & errors

Gateway RPC