#@shipplane/visualizer

Headless workflow graph visualization. Turns a @shipplane/core workflow definition into a renderable graph model and provides pure editing helpers — no rendering, no framework dependency.

For a React renderer built on this package, see @shipplane/visualizer-react.

#Install

npm install @shipplane/visualizer

#Usage

import { workflow } from "@shipplane/core";
import { addTask, createWorkflowGraph } from "@shipplane/visualizer";

const draft = addTask({ id: "deploy", version: 1, tasks: [] }, { id: "init", type: "install_bin" });

const graph = createWorkflowGraph({ workflow: draft });

console.log(graph.nodes.length, graph.edges.length);

#Public API

• createWorkflowDraft(id?) — a new empty workflow definition.
• addTask(workflow, task), updateTask(workflow, taskId, patch), deleteTask(workflow, taskId), updateWorkflow(workflow, patch) — pure editing helpers, each returns a new validated WorkflowDefinition.
• createWorkflowGraph({ workflow, snapshot? }) — builds { nodes, edges } from a workflow definition, optionally colored by run status from a WorkflowSnapshot.
• createSseTaskLogTransport(options), createLongPollingTaskLogTransport(options) — task log subscription transports for live log streaming.