@shumoku/core 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,56 @@
+# @shumoku/core
+
+Core library for Shumoku network topology visualization.
+
+## Installation
+
+```bash
+npm install @shumoku/core
+```
+
+## Features
+
+- **Data models** - Type-safe network topology models (Device, Port, Link, Module)
+- **Layout engines** - Automatic positioning with ELK.js (hierarchical layout)
+- **SVG renderer** - High-quality vector output
+- **Themes** - Built-in modern and dark themes
+
+## Usage
+
+```typescript
+import { NetworkGraph, HierarchicalLayoutEngine, SvgRenderer } from '@shumoku/core'
+
+// Create a network graph
+const graph: NetworkGraph = {
+  version: '1.0.0',
+  devices: [
+    { id: 'router1', name: 'Router', type: 'router' },
+    { id: 'switch1', name: 'Switch', type: 'l2-switch' }
+  ],
+  links: [
+    { id: 'link1', source: 'router1', target: 'switch1' }
+  ]
+}
+
+// Layout the graph
+const engine = new HierarchicalLayoutEngine()
+const layout = await engine.layout(graph)
+
+// Render to SVG
+const renderer = new SvgRenderer()
+const svg = renderer.render(layout)
+```
+
+## Related Packages
+
+- [`@shumoku/parser-yaml`](https://www.npmjs.com/package/@shumoku/parser-yaml) - YAML parser for network definitions
+- [`@shumoku/icons`](https://www.npmjs.com/package/@shumoku/icons) - Vendor-specific icons (Yamaha, Aruba, AWS, Juniper)
+
+## Documentation
+
+- [Playground](https://shumoku.packof.me/) - Interactive demo
+- [GitHub](https://github.com/konoe-akitoshi/shumoku)
+
+## License
+
+MIT

package/dist/constants.d.ts

@@ -0,0 +1,23 @@
+/** Default icon size in pixels (both width and height for square icons) */
+export declare const DEFAULT_ICON_SIZE = 40;
+/** Gap between icon and label in pixels */
+export declare const ICON_LABEL_GAP = 8;
+/** Line height for node labels in pixels */
+export declare const LABEL_LINE_HEIGHT = 16;
+/** Vertical padding inside node box in pixels */
+export declare const NODE_VERTICAL_PADDING = 16;
+/** Horizontal padding inside node box in pixels */
+export declare const NODE_HORIZONTAL_PADDING = 16;
+/** Minimum spacing between ports in pixels (fallback when no labels) */
+export declare const MIN_PORT_SPACING = 48;
+/** Port label font size in pixels */
+export declare const PORT_LABEL_FONT_SIZE = 9;
+/** Character width ratio relative to font size (for proportional fonts ~0.55, monospace ~0.6) */
+export declare const CHAR_WIDTH_RATIO = 0.55;
+/** Padding around port label for spacing calculation */
+export declare const PORT_LABEL_PADDING = 16;
+/** Maximum icon width as percentage of node width (0.0 - 1.0) */
+export declare const MAX_ICON_WIDTH_RATIO = 0.6;
+/** Estimated character width for node label width calculation (larger font) */
+export declare const ESTIMATED_CHAR_WIDTH = 7;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAGA,2EAA2E;AAC3E,eAAO,MAAM,iBAAiB,KAAK,CAAA;AAEnC,2CAA2C;AAC3C,eAAO,MAAM,cAAc,IAAI,CAAA;AAE/B,4CAA4C;AAC5C,eAAO,MAAM,iBAAiB,KAAK,CAAA;AAEnC,iDAAiD;AACjD,eAAO,MAAM,qBAAqB,KAAK,CAAA;AAEvC,mDAAmD;AACnD,eAAO,MAAM,uBAAuB,KAAK,CAAA;AAEzC,wEAAwE;AACxE,eAAO,MAAM,gBAAgB,KAAK,CAAA;AAElC,qCAAqC;AACrC,eAAO,MAAM,oBAAoB,IAAI,CAAA;AAErC,iGAAiG;AACjG,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAEpC,wDAAwD;AACxD,eAAO,MAAM,kBAAkB,KAAK,CAAA;AAEpC,iEAAiE;AACjE,eAAO,MAAM,oBAAoB,MAAM,CAAA;AAEvC,+EAA+E;AAC/E,eAAO,MAAM,oBAAoB,IAAI,CAAA"}

package/dist/constants.js

@@ -0,0 +1,25 @@
+// Layout and rendering constants
+// These values are shared between layout engines and renderers to ensure consistency
+/** Default icon size in pixels (both width and height for square icons) */
+export const DEFAULT_ICON_SIZE = 40;
+/** Gap between icon and label in pixels */
+export const ICON_LABEL_GAP = 8;
+/** Line height for node labels in pixels */
+export const LABEL_LINE_HEIGHT = 16;
+/** Vertical padding inside node box in pixels */
+export const NODE_VERTICAL_PADDING = 16;
+/** Horizontal padding inside node box in pixels */
+export const NODE_HORIZONTAL_PADDING = 16;
+/** Minimum spacing between ports in pixels (fallback when no labels) */
+export const MIN_PORT_SPACING = 48;
+/** Port label font size in pixels */
+export const PORT_LABEL_FONT_SIZE = 9;
+/** Character width ratio relative to font size (for proportional fonts ~0.55, monospace ~0.6) */
+export const CHAR_WIDTH_RATIO = 0.55;
+/** Padding around port label for spacing calculation */
+export const PORT_LABEL_PADDING = 16;
+/** Maximum icon width as percentage of node width (0.0 - 1.0) */
+export const MAX_ICON_WIDTH_RATIO = 0.6;
+/** Estimated character width for node label width calculation (larger font) */
+export const ESTIMATED_CHAR_WIDTH = 7;
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,qFAAqF;AAErF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAEnC,2CAA2C;AAC3C,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAA;AAE/B,4CAA4C;AAC5C,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAEnC,iDAAiD;AACjD,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAA;AAEvC,mDAAmD;AACnD,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAA;AAEzC,wEAAwE;AACxE,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,CAAA;AAElC,qCAAqC;AACrC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA;AAErC,iGAAiG;AACjG,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAEpC,wDAAwD;AACxD,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAA;AAEpC,iEAAiE;AACjE,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,CAAA;AAEvC,+EAA+E;AAC/E,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAA"}

package/dist/index.d.ts

@@ -6,5 +6,6 @@ export * from './layout/index.js';
 export * from './themes/index.js';
 export * from './icons/index.js';
 export * from './renderer/index.js';
+export * from './constants.js';
 export declare const version = "0.0.0";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,cAAc,mBAAmB,CAAA;AAGjC,cAAc,mBAAmB,CAAA;AAGjC,cAAc,mBAAmB,CAAA;AAGjC,cAAc,kBAAkB,CAAA;AAGhC,cAAc,qBAAqB,CAAA;AAGnC,eAAO,MAAM,OAAO,UAAU,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,cAAc,mBAAmB,CAAA;AAGjC,cAAc,mBAAmB,CAAA;AAGjC,cAAc,mBAAmB,CAAA;AAGjC,cAAc,kBAAkB,CAAA;AAGhC,cAAc,qBAAqB,CAAA;AAGnC,cAAc,gBAAgB,CAAA;AAG9B,eAAO,MAAM,OAAO,UAAU,CAAA"}

package/dist/index.js

@@ -11,6 +11,8 @@ export * from './themes/index.js';
 export * from './icons/index.js';
 // Renderer
 export * from './renderer/index.js';
+// Constants
+export * from './constants.js';
 // Version
 export const version = '0.0.0';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,QAAQ;AACR,cAAc,kBAAkB,CAAA;AAEhC,WAAW;AACX,cAAc,qBAAqB,CAAA;AAEnC,UAAU;AACV,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,SAAS;AACT,cAAc,mBAAmB,CAAA;AAEjC,QAAQ;AACR,cAAc,kBAAkB,CAAA;AAEhC,WAAW;AACX,cAAc,qBAAqB,CAAA;AAEnC,YAAY;AACZ,cAAc,gBAAgB,CAAA;AAE9B,UAAU;AACV,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAA"}

package/dist/layout/hierarchical.d.ts

@@ -17,57 +17,30 @@ export declare class HierarchicalLayout {
     private elk;
     constructor(options?: HierarchicalLayoutOptions);
     /**
-     * Get effective options by merging graph settings with defaults
+     * Calculate dynamic spacing based on graph complexity
      */
+    private calculateDynamicSpacing;
     private getEffectiveOptions;
     layoutAsync(graph: NetworkGraph): Promise<LayoutResult>;
     /**
-     * Build ELK graph with HA pairs merged into single virtual nodes
+     * Build ELK graph - uses container nodes for HA pairs
      */
-    private buildElkGraphWithHAMerge;
+    private buildElkGraph;
     /**
-     * Extract layout result and expand HA virtual nodes back to original pairs
+     * Extract layout result from ELK output - uses ELK's edge routing directly
      */
-    private extractLayoutResultWithHAExpand;
-    /**
-     * Reorder ports on each node based on connected node positions to minimize edge crossings
-     */
-    private reorderPortsByConnectedNodePositions;
+    private extractLayoutResult;
     layout(graph: NetworkGraph): LayoutResult;
     private toElkDirection;
     private calculateNodeHeight;
-    /**
-     * Calculate edge path using port positions when available
-     * Port positions are from ELK - lines connect FROM the ports
-     */
-    private calculateEdgePathWithPorts;
-    /**
-     * Get control point position based on port side
-     */
-    private getControlPointForSide;
-    private calculateFallbackLayout;
+    private calculatePortSpacing;
+    private calculateNodeWidth;
     private calculateTotalBounds;
-    /**
-     * Detect redundancy pairs based on link.redundancy property
-     * Returns array of [nodeA, nodeB] pairs that should be placed on the same layer
-     */
+    private calculateFallbackLayout;
+    /** Detect HA pairs from redundancy links */
     private detectHAPairs;
-    /**
-     * Adjust node distances based on link minLength property
-     */
-    private adjustLinkDistances;
-    /**
-     * Calculate edge path with offset for multiple connections
-     */
-    private calculateEdgePathWithOffset;
-    /**
-     * Recalculate all edge paths with port offset distribution
-     */
-    private recalculateAllEdges;
-    /**
-     * Recalculate subgraph bounds to contain all child nodes after adjustments
-     */
-    private recalculateSubgraphBounds;
+    /** Generate orthogonal path between two points */
+    private generateOrthogonalPath;
 }
 export declare const hierarchicalLayout: HierarchicalLayout;
 //# sourceMappingURL=hierarchical.d.ts.map

package/dist/layout/hierarchical.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hierarchical.d.ts","sourceRoot":"","sources":["../../src/layout/hierarchical.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACL,KAAK,YAAY,EAGjB,KAAK,YAAY,EAMjB,KAAK,eAAe,EAGrB,MAAM,oBAAoB,CAAA;AA+D3B,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAgBD,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAqC;IACpD,OAAO,CAAC,GAAG,CAA0B;gBAEzB,OAAO,CAAC,EAAE,yBAAyB;IAK/C;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAYrB,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAqC7D;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA8UhC;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAoTvC;;OAEG;IACH,OAAO,CAAC,oCAAoC;IA4F5C,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY;IA+BzC,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,mBAAmB;IA0D3B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IAmFlC;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAe9B,OAAO,CAAC,uBAAuB;IA+D/B,OAAO,CAAC,oBAAoB;IAmC5B;;;OAGG;IACH,OAAO,CAAC,aAAa;IAwBrB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAoD3B;;OAEG;IACH,OAAO,CAAC,2BAA2B;IAsEnC;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAiF3B;;OAEG;IACH,OAAO,CAAC,yBAAyB;CAoFlC;AAGD,eAAO,MAAM,kBAAkB,oBAA2B,CAAA"}
+{"version":3,"file":"hierarchical.d.ts","sourceRoot":"","sources":["../../src/layout/hierarchical.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACL,KAAK,YAAY,EAGjB,KAAK,YAAY,EAMjB,KAAK,eAAe,EAGrB,MAAM,oBAAoB,CAAA;AAmH3B,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC7B;AAgBD,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAqC;IACpD,OAAO,CAAC,GAAG,CAA0B;gBAEzB,OAAO,CAAC,EAAE,yBAAyB;IAK/C;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAoC/B,OAAO,CAAC,mBAAmB;IAarB,WAAW,CAAC,KAAK,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IA8B7D;;OAEG;IACH,OAAO,CAAC,aAAa;IAuXrB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAqR3B,MAAM,CAAC,KAAK,EAAE,YAAY,GAAG,YAAY;IAYzC,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,mBAAmB;IA6D3B,OAAO,CAAC,oBAAoB;IAc5B,OAAO,CAAC,kBAAkB;IAiD1B,OAAO,CAAC,oBAAoB;IAmD5B,OAAO,CAAC,uBAAuB;IAsE/B,4CAA4C;IAC5C,OAAO,CAAC,aAAa;IAmBrB,kDAAkD;IAClD,OAAO,CAAC,sBAAsB;CAsB/B;AAGD,eAAO,MAAM,kBAAkB,oBAA2B,CAAA"}