@nodius/layouting 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,253 @@
+# nodius-layouting
+
+A **zero-dependency**, high-performance graph layouting library for node-based technical diagrams.
+
+Built for real-world use cases: data pipelines, visual programming environments, workflow editors, and any system where nodes with typed handles are connected by edges.
+
+## Features
+
+- **Zero runtime dependencies** - Pure TypeScript, nothing else
+- **Optimized Sugiyama-based layout** - Produces clean, hierarchical technical diagrams
+- **Handle-aware** - Each node has multiple handles (input/output) with precise positioning on any side (top, right, bottom, left) with configurable offsets
+- **Orthogonal edge routing** - Clean right-angle edge paths that respect handle positions
+- **Incremental layout** - Add or remove nodes without recomputing the entire layout
+- **4 layout directions** - Top-to-bottom, left-to-right, bottom-to-top, right-to-left
+- **Cycle support** - Automatically handles cyclic graphs
+- **Scales to 1000+ nodes** - Optimized algorithms (merge-sort crossing count, adaptive iterations)
+
+## Performance
+
+Benchmarked on a standard development machine:
+
+| Graph Size | Time |
+|---|---|
+| 100 nodes, 737 edges (dense) | ~70ms |
+| 200 nodes | ~25ms |
+| 500 nodes | ~100ms |
+| 1000 nodes | ~150ms |
+
+## Installation
+
+```bash
+npm install nodius-layouting
+```
+
+## Quick Start
+
+```typescript
+import { layout } from 'nodius-layouting';
+
+const result = layout({
+  nodes: [
+    {
+      id: 'source',
+      width: 120,
+      height: 60,
+      handles: [
+        { id: 'out', type: 'output', position: 'bottom', offset: 0.5 },
+      ],
+    },
+    {
+      id: 'transform',
+      width: 150,
+      height: 80,
+      handles: [
+        { id: 'in', type: 'input', position: 'top', offset: 0.5 },
+        { id: 'out', type: 'output', position: 'bottom', offset: 0.5 },
+        { id: 'err', type: 'output', position: 'right', offset: 0.5 },
+      ],
+    },
+    {
+      id: 'sink',
+      width: 120,
+      height: 60,
+      handles: [
+        { id: 'in', type: 'input', position: 'top', offset: 0.5 },
+      ],
+    },
+  ],
+  edges: [
+    { id: 'e1', from: 'source', to: 'transform', fromHandle: 'out', toHandle: 'in' },
+    { id: 'e2', from: 'transform', to: 'sink', fromHandle: 'out', toHandle: 'in' },
+  ],
+});
+
+// result.nodes → positioned nodes with absolute handle coordinates
+// result.edges → routed edges with waypoint arrays
+```
+
+## API
+
+### `layout(input, options?)`
+
+Compute a complete layout for the given graph. Returns positioned nodes and routed edges.
+
+```typescript
+function layout(input: LayoutInput, options?: LayoutOptions): LayoutResult;
+```
+
+### `IncrementalLayout`
+
+Maintains layout state for incremental updates. Use this when you need to add or remove nodes without full recomputation.
+
+```typescript
+import { IncrementalLayout } from 'nodius-layouting';
+
+const inc = new IncrementalLayout({ direction: 'LR' });
+
+// Set initial graph
+const result1 = inc.setGraph({ nodes: [...], edges: [...] });
+
+// Add nodes and edges incrementally
+const result2 = inc.addNodes(
+  [{ id: 'new_node', width: 100, height: 60, handles: [...] }],
+  [{ id: 'new_edge', from: 'existing', to: 'new_node', fromHandle: 'out', toHandle: 'in' }]
+);
+
+// Remove nodes (connected edges are removed automatically)
+const result3 = inc.removeNodes(['node_to_remove']);
+
+// Add/remove edges independently
+inc.addEdges([...]);
+inc.removeEdges(['edge_id']);
+
+// Get current result
+const current = inc.getResult();
+```
+
+### Types
+
+#### Input Types
+
+```typescript
+interface NodeInput {
+  id: string;
+  width: number;
+  height: number;
+  handles: HandleInput[];
+}
+
+interface HandleInput {
+  id: string;
+  type: 'input' | 'output';
+  position: 'top' | 'right' | 'bottom' | 'left';
+  offset?: number; // 0-1 position along the side. Default: 0.5
+}
+
+interface EdgeInput {
+  id: string;
+  from: string;       // Source node ID
+  to: string;         // Target node ID
+  fromHandle: string; // Source handle ID
+  toHandle: string;   // Target handle ID
+}
+
+interface LayoutInput {
+  nodes: NodeInput[];
+  edges: EdgeInput[];
+}
+```
+
+#### Options
+
+```typescript
+interface LayoutOptions {
+  direction?: 'TB' | 'LR' | 'BT' | 'RL';       // Default: 'TB'
+  nodeSpacing?: number;                           // Default: 40
+  layerSpacing?: number;                          // Default: 60
+  crossingMinimizationIterations?: number;        // Default: 24
+  coordinateOptimizationIterations?: number;      // Default: 8
+  edgeMargin?: number;                            // Default: 20
+}
+```
+
+#### Output Types
+
+```typescript
+interface LayoutResult {
+  nodes: NodeOutput[];
+  edges: EdgeOutput[];
+}
+
+interface NodeOutput {
+  id: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  handles: HandleOutput[]; // Absolute positions
+}
+
+interface HandleOutput {
+  id: string;
+  type: 'input' | 'output';
+  position: 'top' | 'right' | 'bottom' | 'left';
+  x: number; // Absolute x position
+  y: number; // Absolute y position
+}
+
+interface EdgeOutput {
+  id: string;
+  from: string;
+  to: string;
+  fromHandle: string;
+  toHandle: string;
+  points: Point[]; // Ordered waypoints from source to target
+}
+```
+
+## Algorithm
+
+The layout engine uses a modified **Sugiyama algorithm** with five phases:
+
+1. **Cycle Breaking** - DFS-based back edge detection and reversal
+2. **Layer Assignment** - Longest-path layering with dummy node insertion for long edges
+3. **Crossing Minimization** - Barycenter heuristic with up/down sweeps and transpose improvement. Uses merge-sort based O(E log V) inversion counting
+4. **Coordinate Assignment** - Median-based iterative positioning with spacing constraints and multi-pass centering
+5. **Edge Routing** - Orthogonal path computation through dummy node waypoints with handle-aware entry/exit directions
+
+### Incremental Layout
+
+The `IncrementalLayout` class provides position stability when modifying graphs:
+
+- New nodes are inserted into appropriate layers based on their connections
+- Existing node positions are blended (70% new / 30% old) to reduce visual disruption
+- Full crossing minimization and coordinate assignment run on the updated graph
+- Only affected edges are re-routed
+
+## Playground
+
+A visual playground is included in the `playground/` directory:
+
+```bash
+cd playground
+npm install
+npm run dev
+```
+
+This opens a Vite dev server with:
+- Predefined example graphs (chain, diamond, data pipeline, hub, binary tree, cycle)
+- Editable JSON input
+- Before/after SVG visualization
+- Configurable layout direction and spacing
+- Real-time performance metrics
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Run tests in watch mode
+npm run test:watch
+
+# Build the library
+npm run build
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,176 @@
+/** Position on a node where a handle can be placed */
+type HandleSide = 'top' | 'right' | 'bottom' | 'left';
+/** Handle type - input receives connections, output sends connections */
+type HandleType = 'input' | 'output';
+/** Layout direction */
+type LayoutDirection = 'TB' | 'LR' | 'BT' | 'RL';
+/** A 2D point */
+interface Point {
+    x: number;
+    y: number;
+}
+/** Handle definition on a node */
+interface HandleInput {
+    id: string;
+    type: HandleType;
+    position: HandleSide;
+    /** Position along the side (0 = start, 1 = end). Default: 0.5 */
+    offset?: number;
+}
+/** Node input definition */
+interface NodeInput {
+    id: string;
+    width: number;
+    height: number;
+    handles: HandleInput[];
+}
+/** Edge input definition */
+interface EdgeInput {
+    id: string;
+    from: string;
+    to: string;
+    fromHandle: string;
+    toHandle: string;
+}
+/** Complete layout input */
+interface LayoutInput {
+    nodes: NodeInput[];
+    edges: EdgeInput[];
+}
+/** Layout configuration options */
+interface LayoutOptions {
+    /** Layout direction. Default: 'TB' */
+    direction?: LayoutDirection;
+    /** Minimum spacing between nodes in the same layer. Default: 40 */
+    nodeSpacing?: number;
+    /** Minimum spacing between layers. Default: 60 */
+    layerSpacing?: number;
+    /** Number of iterations for crossing minimization. Default: 24 */
+    crossingMinimizationIterations?: number;
+    /** Number of iterations for coordinate optimization. Default: 8 */
+    coordinateOptimizationIterations?: number;
+    /** Margin for edge routing (distance from node before turning). Default: 20 */
+    edgeMargin?: number;
+}
+/** Positioned handle in the output */
+interface HandleOutput {
+    id: string;
+    type: HandleType;
+    position: HandleSide;
+    x: number;
+    y: number;
+}
+/** Positioned node in the output */
+interface NodeOutput {
+    id: string;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    handles: HandleOutput[];
+}
+/** Routed edge in the output */
+interface EdgeOutput {
+    id: string;
+    from: string;
+    to: string;
+    fromHandle: string;
+    toHandle: string;
+    points: Point[];
+}
+/** Complete layout result */
+interface LayoutResult {
+    nodes: NodeOutput[];
+    edges: EdgeOutput[];
+}
+
+interface InternalNode {
+    id: string;
+    width: number;
+    height: number;
+    handles: HandleInput[];
+    isDummy: boolean;
+    layer: number;
+    order: number;
+    x: number;
+    y: number;
+}
+interface InternalEdge {
+    id: string;
+    from: string;
+    to: string;
+    fromHandle: string;
+    toHandle: string;
+    reversed: boolean;
+    originalId: string;
+}
+declare class Graph {
+    nodes: Map<string, InternalNode>;
+    edges: Map<string, InternalEdge>;
+    outEdges: Map<string, Set<string>>;
+    inEdges: Map<string, Set<string>>;
+    addNode(node: InternalNode): void;
+    addEdge(edge: InternalEdge): void;
+    removeEdge(edgeId: string): void;
+    removeNode(nodeId: string): void;
+    predecessors(nodeId: string): string[];
+    successors(nodeId: string): string[];
+}
+
+/**
+ * Compute a complete layout for the given graph.
+ * This is the main entry point for one-shot layout computation.
+ */
+declare function layout(input: LayoutInput, options?: LayoutOptions): LayoutResult;
+
+/**
+ * Incremental layout engine.
+ * Maintains layout state and supports adding/removing nodes
+ * without full recomputation.
+ */
+declare class IncrementalLayout {
+    private options;
+    private inputNodes;
+    private inputEdges;
+    private lastResult;
+    private nodePositions;
+    constructor(options?: LayoutOptions);
+    /**
+     * Set the full graph and compute a complete layout.
+     */
+    setGraph(input: LayoutInput): LayoutResult;
+    /**
+     * Add nodes and edges incrementally.
+     * Attempts to minimize layout changes for existing nodes.
+     */
+    addNodes(nodes: NodeInput[], edges?: EdgeInput[]): LayoutResult;
+    /**
+     * Remove nodes (and their connected edges) from the layout.
+     */
+    removeNodes(nodeIds: string[]): LayoutResult;
+    /**
+     * Add edges between existing nodes.
+     */
+    addEdges(edges: EdgeInput[]): LayoutResult;
+    /**
+     * Remove edges from the layout.
+     */
+    removeEdges(edgeIds: string[]): LayoutResult;
+    /**
+     * Get the current layout result.
+     */
+    getResult(): LayoutResult | null;
+    private recompute;
+    private recomputeIncremental;
+    /**
+     * Apply stability: blend new positions with old positions for existing nodes.
+     * This reduces visual disruption when adding new nodes.
+     */
+    private applyStability;
+    private cachePositions;
+    private buildResult;
+}
+
+declare function countAllCrossings(graph: Graph, layers: string[][]): number;
+
+export { type EdgeInput, type EdgeOutput, type HandleInput, type HandleOutput, type HandleSide, type HandleType, IncrementalLayout, type LayoutDirection, type LayoutInput, type LayoutOptions, type LayoutResult, type NodeInput, type NodeOutput, type Point, countAllCrossings, layout };