@flyingrobots/bijou-tui 0.10.0 → 1.1.0

package/dist/dag-pane.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Interactive DAG pane building block.
+ *
+ * Composes `dagLayout()` with `focusArea()` to provide a scrollable,
+ * keyboard-navigable DAG viewer with arrow-key node selection,
+ * auto-scroll-to-selection, and auto-highlight-path.
+ *
+ * Follows the building block pattern: immutable state + pure transformers +
+ * pure render + convenience keymap factory.
+ *
+ * ```ts
+ * // In TEA init:
+ * const pane = createDagPaneState({ source: nodes, width: 80, height: 24, ctx });
+ *
+ * // In TEA view:
+ * const output = dagPane(pane, { focused: true, ctx });
+ *
+ * // In TEA update:
+ * case 'select-child':
+ *   return [{ ...model, pane: dagPaneSelectChild(model.pane, ctx) }, []];
+ * ```
+ */
+import type { BijouContext, TokenValue, DagNode, DagLayout, SlicedDagSource } from '@flyingrobots/bijou';
+import { type FocusAreaState, type FocusAreaRenderOptions, type OverflowX } from './focus-area.js';
+import { type KeyMap } from './keybindings.js';
+/** DAG rendering options forwarded to `dagLayout()`. */
+export interface DagPaneDagOptions {
+    /** Default color/style token for node box borders. */
+    readonly nodeToken?: TokenValue;
+    /** Color/style token for edge lines and arrowheads. */
+    readonly edgeToken?: TokenValue;
+    /** Color/style token for highlighted path nodes/edges. */
+    readonly highlightToken?: TokenValue;
+    /** Color/style token for the selected node box. */
+    readonly selectedToken?: TokenValue;
+    /** Fixed character width per node box. */
+    readonly nodeWidth?: number;
+    /** Maximum total character width. */
+    readonly maxWidth?: number;
+    /** Layout direction. */
+    readonly direction?: 'down' | 'right';
+}
+/** Immutable state for the DAG pane widget. */
+export interface DagPaneState {
+    /** Graph data source. */
+    readonly source: DagNode[] | SlicedDagSource;
+    /** Currently selected node ID, or undefined. */
+    readonly selectedId: string | undefined;
+    /** Cached `dagLayout()` result. */
+    readonly layout: DagLayout;
+    /** Ordered path from root to selected node (for highlighting). */
+    readonly highlightPath: readonly string[];
+    /** Underlying focus area (scroll/viewport) state. */
+    readonly focusArea: FocusAreaState;
+    /** DAG rendering options forwarded to `dagLayout()`. */
+    readonly dagOptions: DagPaneDagOptions;
+}
+/** Options for creating a new DAG pane state. */
+export interface DagPaneOptions {
+    /** Graph data source (array of nodes or sliced source). */
+    readonly source: DagNode[] | SlicedDagSource;
+    /** Total width in columns (including gutter). */
+    readonly width: number;
+    /** Total height in rows. */
+    readonly height: number;
+    /** Initially selected node ID. */
+    readonly selectedId?: string;
+    /** Horizontal overflow. Default: `'scroll'` (DAGs are wide). */
+    readonly overflowX?: OverflowX;
+    /** DAG rendering options. */
+    readonly dagOptions?: DagPaneDagOptions;
+    /** Bijou context for rendering. */
+    readonly ctx?: BijouContext;
+}
+/** Options for rendering the DAG pane view. */
+export type DagPaneRenderOptions = FocusAreaRenderOptions;
+/**
+ * Create initial DAG pane state for the given source and dimensions.
+ *
+ * @param options - Source, dimensions, and rendering options.
+ * @returns Fresh DAG pane state.
+ */
+export declare function createDagPaneState(options: DagPaneOptions): DagPaneState;
+/**
+ * Select a child node (arrow down).
+ * If nothing is selected, auto-selects the first root node.
+ *
+ * @param state - Current DAG pane state.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new selection.
+ */
+export declare function dagPaneSelectChild(state: DagPaneState, ctx?: BijouContext): DagPaneState;
+/**
+ * Select a parent node (arrow up).
+ * If nothing is selected, auto-selects the first root node.
+ *
+ * @param state - Current DAG pane state.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new selection.
+ */
+export declare function dagPaneSelectParent(state: DagPaneState, ctx?: BijouContext): DagPaneState;
+/**
+ * Select the sibling node to the left in the same layer.
+ * If nothing is selected, auto-selects the first root node.
+ *
+ * @param state - Current DAG pane state.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new selection.
+ */
+export declare function dagPaneSelectLeft(state: DagPaneState, ctx?: BijouContext): DagPaneState;
+/**
+ * Select the sibling node to the right in the same layer.
+ * If nothing is selected, auto-selects the first root node.
+ *
+ * @param state - Current DAG pane state.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new selection.
+ */
+export declare function dagPaneSelectRight(state: DagPaneState, ctx?: BijouContext): DagPaneState;
+/**
+ * Select a specific node by ID.
+ * If the ID is not found in the layout, returns state unchanged (no selection).
+ *
+ * @param state - Current DAG pane state.
+ * @param nodeId - ID of the node to select.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new selection.
+ */
+export declare function dagPaneSelectNode(state: DagPaneState, nodeId: string, ctx?: BijouContext): DagPaneState;
+/**
+ * Clear the current selection.
+ *
+ * @param state - Current DAG pane state.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with no selection.
+ */
+export declare function dagPaneClearSelection(state: DagPaneState, ctx?: BijouContext): DagPaneState;
+/**
+ * Scroll vertically by a relative amount.
+ *
+ * @param state - Current DAG pane state.
+ * @param dy - Relative vertical offset (positive = down).
+ * @returns Updated state.
+ */
+export declare function dagPaneScrollBy(state: DagPaneState, dy: number): DagPaneState;
+/**
+ * Scroll to the top.
+ *
+ * @param state - Current DAG pane state.
+ * @returns Updated state.
+ */
+export declare function dagPaneScrollToTop(state: DagPaneState): DagPaneState;
+/**
+ * Scroll to the bottom.
+ *
+ * @param state - Current DAG pane state.
+ * @returns Updated state.
+ */
+export declare function dagPaneScrollToBottom(state: DagPaneState): DagPaneState;
+/**
+ * Page down.
+ *
+ * @param state - Current DAG pane state.
+ * @returns Updated state.
+ */
+export declare function dagPanePageDown(state: DagPaneState): DagPaneState;
+/**
+ * Page up.
+ *
+ * @param state - Current DAG pane state.
+ * @returns Updated state.
+ */
+export declare function dagPanePageUp(state: DagPaneState): DagPaneState;
+/**
+ * Scroll horizontally by a relative amount.
+ *
+ * @param state - Current DAG pane state.
+ * @param dx - Relative horizontal offset (positive = right).
+ * @returns Updated state.
+ */
+export declare function dagPaneScrollByX(state: DagPaneState, dx: number): DagPaneState;
+/**
+ * Replace the graph source and re-render. Clears selection.
+ *
+ * @param state - Current DAG pane state.
+ * @param source - New graph data source.
+ * @param ctx - Bijou context for re-rendering.
+ * @returns Updated state with new source and cleared selection.
+ */
+export declare function dagPaneSetSource(state: DagPaneState, source: DagNode[] | SlicedDagSource, ctx?: BijouContext): DagPaneState;
+/**
+ * Render the DAG pane — focus area wrapping the DAG layout output.
+ *
+ * @param state - Current DAG pane state.
+ * @param options - Rendering options (focus, tokens, scrollbar, ctx).
+ * @returns Rendered DAG pane string.
+ */
+export declare function dagPane(state: DagPaneState, options?: DagPaneRenderOptions): string;
+/**
+ * Create a preconfigured KeyMap for DAG pane interaction.
+ *
+ * Arrow keys are bound to node selection. Vim keys (j/k/h/l) are bound
+ * to scroll. `Enter` confirms, `q`/`Ctrl+C` quits.
+ *
+ * @template Msg - Application message type dispatched by key bindings.
+ * @param actions - Map of actions to message values.
+ * @returns Preconfigured key map with DAG pane bindings.
+ */
+export declare function dagPaneKeyMap<Msg>(actions: {
+    selectParent: Msg;
+    selectChild: Msg;
+    selectLeft: Msg;
+    selectRight: Msg;
+    scrollUp: Msg;
+    scrollDown: Msg;
+    scrollLeft: Msg;
+    scrollRight: Msg;
+    pageUp: Msg;
+    pageDown: Msg;
+    top: Msg;
+    bottom: Msg;
+    confirm: Msg;
+    quit: Msg;
+}): KeyMap<Msg>;
+//# sourceMappingURL=dag-pane.d.ts.map

package/dist/dag-pane.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dag-pane.d.ts","sourceRoot":"","sources":["../src/dag-pane.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,OAAO,EAAmB,SAAS,EAAc,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtI,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,sBAAsB,EAC3B,KAAK,SAAS,EAUf,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAAgB,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAM7D,wDAAwD;AACxD,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;IAChC,uDAAuD;IACvD,QAAQ,CAAC,SAAS,CAAC,EAAE,UAAU,CAAC;IAChC,0DAA0D;IAC1D,QAAQ,CAAC,cAAc,CAAC,EAAE,UAAU,CAAC;IACrC,mDAAmD;IACnD,QAAQ,CAAC,aAAa,CAAC,EAAE,UAAU,CAAC;IACpC,0CAA0C;IAC1C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,qCAAqC;IACrC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,wBAAwB;IACxB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACvC;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,yBAAyB;IACzB,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAC7C,gDAAgD;IAChD,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IACxC,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,kEAAkE;IAClE,QAAQ,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,qDAAqD;IACrD,QAAQ,CAAC,SAAS,EAAE,cAAc,CAAC;IACnC,wDAAwD;IACxD,QAAQ,CAAC,UAAU,EAAE,iBAAiB,CAAC;CACxC;AAED,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,2DAA2D;IAC3D,QAAQ,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,CAAC;IAC7C,iDAAiD;IACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,4BAA4B;IAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,kCAAkC;IAClC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,gEAAgE;IAChE,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,6BAA6B;IAC7B,QAAQ,CAAC,UAAU,CAAC,EAAE,iBAAiB,CAAC;IACxC,mCAAmC;IACnC,QAAQ,CAAC,GAAG,CAAC,EAAE,YAAY,CAAC;CAC7B;AAED,+CAA+C;AAC/C,MAAM,MAAM,oBAAoB,GAAG,sBAAsB,CAAC;AAkQ1D;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,cAAc,GAAG,YAAY,CA2CxE;AAMD;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAexF;AAED;;;;;;;GAOG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAezF;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAgBvF;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAgBxF;AAED;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAMvG;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,YAAY,CAG3F;AAMD;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,GAAG,YAAY,CAE7E;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAEpE;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAEvE;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAEjE;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY,CAE/D;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,GAAG,YAAY,CAE9E;AAED;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,YAAY,EACnB,MAAM,EAAE,OAAO,EAAE,GAAG,eAAe,EACnC,GAAG,CAAC,EAAE,YAAY,GACjB,YAAY,CAad;AAMD;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,oBAAoB,GAAG,MAAM,CAEnF;AAMD;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,EAAE;IAC1C,YAAY,EAAE,GAAG,CAAC;IAClB,WAAW,EAAE,GAAG,CAAC;IACjB,UAAU,EAAE,GAAG,CAAC;IAChB,WAAW,EAAE,GAAG,CAAC;IACjB,QAAQ,EAAE,GAAG,CAAC;IACd,UAAU,EAAE,GAAG,CAAC;IAChB,UAAU,EAAE,GAAG,CAAC;IAChB,WAAW,EAAE,GAAG,CAAC;IACjB,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,GAAG,CAAC;IACd,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,GAAG,CAAC;IACZ,OAAO,EAAE,GAAG,CAAC;IACb,IAAI,EAAE,GAAG,CAAC;CACX,GAAG,MAAM,CAAC,GAAG,CAAC,CAqBd"}