@particle-academy/fancy-flow 0.36.0 → 0.37.0

package/dist/FlowViewer-C4QAVgWv.d.ts

@@ -0,0 +1,62 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode } from 'react';
+import { F as FlowGraph, b as FlowNode } from './types-sOmpCitB.js';
+
+/** Outcome of one node in a run, for annotating the graph after the fact. */
+type FlowNodeStatus = "ok" | "running" | "failed" | "skipped" | "pending";
+interface FlowViewerClassNames {
+    root?: string;
+    list?: string;
+    row?: string;
+    rowIndex?: string;
+    rowTitle?: string;
+    rowDescription?: string;
+    rowStatus?: string;
+}
+interface FlowViewerProps {
+    /** The graph to show. */
+    graph: FlowGraph;
+    /**
+     * `canvas` draws the graph. `list` renders the nodes as rows — for a docs
+     * page, a narrow column, print, or an audit view, where a pan-zoom surface is
+     * the wrong shape and often not usable at all.
+     */
+    variant?: "canvas" | "list";
+    /** Canvas height. Ignored by `list`. Default 480. */
+    height?: number | string;
+    /** Canvas minimap. Default false. */
+    showMinimap?: boolean;
+    /** Canvas pan/zoom/fit controls. Default true. */
+    showControls?: boolean;
+    /**
+     * Per-node run outcome, keyed by node id. Lets the same component serve
+     * "here is the workflow" and "here is what happened on Tuesday".
+     */
+    statuses?: Record<string, FlowNodeStatus>;
+    /** Controlled selection. */
+    selectedNodeId?: string | null;
+    /** Omit and nothing is clickable — a viewer with no handler is inert. */
+    onSelectNode?: (node: FlowNode) => void;
+    className?: string;
+    classNames?: FlowViewerClassNames;
+    style?: CSSProperties;
+    /** Rendered when the graph has no nodes. */
+    empty?: ReactNode;
+}
+/**
+ * FlowViewer — a workflow, read-only.
+ *
+ * **Read-only by construction, not by configuration.** There is no prop that
+ * makes this editable, because a viewer that can be switched into an editor is
+ * a viewer somebody eventually switches into an editor by accident. Before this
+ * existed the only way to show a flow was `FlowEditor` (the whole editor) or
+ * `FlowCanvas` plus four React Flow flags a consumer had to know to pass —
+ * assembly, not an affordance, and nothing stopped the next person shipping a
+ * fully editable canvas where they wanted a picture.
+ *
+ * Node titles come from the registry, so `overrideNodeKind()` renames apply
+ * here too.
+ */
+declare function FlowViewer({ graph, variant, height, showMinimap, showControls, statuses, selectedNodeId, onSelectNode, className, classNames, style, empty, }: FlowViewerProps): react.JSX.Element;
+
+export { type FlowNodeStatus as F, FlowViewer as a, type FlowViewerClassNames as b, type FlowViewerProps as c };

package/dist/FlowViewer-nLqo7s2E.d.cts

@@ -0,0 +1,62 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode } from 'react';
+import { F as FlowGraph, b as FlowNode } from './types-sOmpCitB.cjs';
+
+/** Outcome of one node in a run, for annotating the graph after the fact. */
+type FlowNodeStatus = "ok" | "running" | "failed" | "skipped" | "pending";
+interface FlowViewerClassNames {
+    root?: string;
+    list?: string;
+    row?: string;
+    rowIndex?: string;
+    rowTitle?: string;
+    rowDescription?: string;
+    rowStatus?: string;
+}
+interface FlowViewerProps {
+    /** The graph to show. */
+    graph: FlowGraph;
+    /**
+     * `canvas` draws the graph. `list` renders the nodes as rows — for a docs
+     * page, a narrow column, print, or an audit view, where a pan-zoom surface is
+     * the wrong shape and often not usable at all.
+     */
+    variant?: "canvas" | "list";
+    /** Canvas height. Ignored by `list`. Default 480. */
+    height?: number | string;
+    /** Canvas minimap. Default false. */
+    showMinimap?: boolean;
+    /** Canvas pan/zoom/fit controls. Default true. */
+    showControls?: boolean;
+    /**
+     * Per-node run outcome, keyed by node id. Lets the same component serve
+     * "here is the workflow" and "here is what happened on Tuesday".
+     */
+    statuses?: Record<string, FlowNodeStatus>;
+    /** Controlled selection. */
+    selectedNodeId?: string | null;
+    /** Omit and nothing is clickable — a viewer with no handler is inert. */
+    onSelectNode?: (node: FlowNode) => void;
+    className?: string;
+    classNames?: FlowViewerClassNames;
+    style?: CSSProperties;
+    /** Rendered when the graph has no nodes. */
+    empty?: ReactNode;
+}
+/**
+ * FlowViewer — a workflow, read-only.
+ *
+ * **Read-only by construction, not by configuration.** There is no prop that
+ * makes this editable, because a viewer that can be switched into an editor is
+ * a viewer somebody eventually switches into an editor by accident. Before this
+ * existed the only way to show a flow was `FlowEditor` (the whole editor) or
+ * `FlowCanvas` plus four React Flow flags a consumer had to know to pass —
+ * assembly, not an affordance, and nothing stopped the next person shipping a
+ * fully editable canvas where they wanted a picture.
+ *
+ * Node titles come from the registry, so `overrideNodeKind()` renames apply
+ * here too.
+ */
+declare function FlowViewer({ graph, variant, height, showMinimap, showControls, statuses, selectedNodeId, onSelectNode, className, classNames, style, empty, }: FlowViewerProps): react.JSX.Element;
+
+export { type FlowNodeStatus as F, FlowViewer as a, type FlowViewerClassNames as b, type FlowViewerProps as c };