@shumoku/core 0.2.4 → 0.2.13

package/src/hierarchical.ts

@@ -0,0 +1,240 @@
+/**
+ * Hierarchical sheet generation utilities
+ * Shared logic for building child sheets with export connectors
+ */
+
+import type { LayoutResult, Link, NetworkGraph, Node, Subgraph } from './models/types.js'
+
+// ============================================
+// Constants
+// ============================================
+
+const EXPORT_NODE_PREFIX = '__export_'
+const EXPORT_LINK_PREFIX = '__export_link_'
+
+// ============================================
+// Types
+// ============================================
+
+export interface SheetData {
+  graph: NetworkGraph
+  layout: LayoutResult
+}
+
+export interface LayoutEngine {
+  layoutAsync(graph: NetworkGraph): Promise<LayoutResult>
+}
+
+interface ExportPoint {
+  subgraphId: string
+  device: string
+  port?: string
+  destSubgraphLabel: string
+  destDevice: string
+  destPort?: string
+  isSource: boolean
+}
+
+// ============================================
+// Type Guards
+// ============================================
+
+/**
+ * Check if a node is a virtual export connector
+ */
+export function isExportNode(nodeId: string): boolean {
+  return nodeId.startsWith(EXPORT_NODE_PREFIX)
+}
+
+/**
+ * Check if a link is a virtual export connector link
+ */
+export function isExportLink(linkId: string): boolean {
+  return linkId.startsWith(EXPORT_LINK_PREFIX)
+}
+
+// ============================================
+// Main Function
+// ============================================
+
+/**
+ * Build hierarchical sheets from a root graph
+ *
+ * Creates child sheets for each subgraph with:
+ * - Filtered nodes (only those belonging to the subgraph)
+ * - Internal links (both endpoints in subgraph)
+ * - Export connector nodes/links for boundary connections
+ *
+ * @param graph - Root network graph with subgraphs
+ * @param rootLayout - Layout result for the root graph
+ * @param layoutEngine - Engine to layout child sheets
+ * @returns Map of sheet ID to SheetData (includes 'root')
+ */
+export async function buildHierarchicalSheets(
+  graph: NetworkGraph,
+  rootLayout: LayoutResult,
+  layoutEngine: LayoutEngine,
+): Promise<Map<string, SheetData>> {
+  const sheets = new Map<string, SheetData>()
+
+  // Add root sheet
+  sheets.set('root', { graph, layout: rootLayout })
+
+  if (!graph.subgraphs || graph.subgraphs.length === 0) {
+    return sheets
+  }
+
+  // Mark subgraphs as clickable
+  for (const sg of graph.subgraphs) {
+    sg.file = sg.id
+  }
+
+  // Build child sheets
+  for (const sg of graph.subgraphs) {
+    const childSheet = await buildChildSheet(graph, sg, layoutEngine)
+    sheets.set(sg.id, childSheet)
+  }
+
+  return sheets
+}
+
+// ============================================
+// Internal Functions
+// ============================================
+
+async function buildChildSheet(
+  rootGraph: NetworkGraph,
+  subgraph: Subgraph,
+  layoutEngine: LayoutEngine,
+): Promise<SheetData> {
+  // Get nodes belonging to this subgraph
+  const childNodes = rootGraph.nodes.filter((n) => n.parent === subgraph.id)
+  const childNodeIds = new Set(childNodes.map((n) => n.id))
+
+  // Get internal links (both endpoints in subgraph)
+  const childLinks = rootGraph.links.filter((l) => {
+    const fromNode = typeof l.from === 'string' ? l.from : l.from.node
+    const toNode = typeof l.to === 'string' ? l.to : l.to.node
+    return childNodeIds.has(fromNode) && childNodeIds.has(toNode)
+  })
+
+  // Generate export connectors for boundary connections
+  const { exportNodes, exportLinks } = generateExportConnectors(
+    rootGraph,
+    subgraph.id,
+    childNodeIds,
+  )
+
+  // Build child graph
+  const childGraph: NetworkGraph = {
+    ...rootGraph,
+    name: subgraph.label,
+    nodes: [...childNodes.map((n) => ({ ...n, parent: undefined })), ...exportNodes],
+    links: [...childLinks, ...exportLinks],
+    subgraphs: undefined,
+  }
+
+  // Layout child sheet
+  const childLayout = await layoutEngine.layoutAsync(childGraph)
+
+  return { graph: childGraph, layout: childLayout }
+}
+
+function generateExportConnectors(
+  rootGraph: NetworkGraph,
+  subgraphId: string,
+  childNodeIds: Set<string>,
+): { exportNodes: Node[]; exportLinks: Link[] } {
+  const exportNodes: Node[] = []
+  const exportLinks: Link[] = []
+  const exportPoints = new Map<string, ExportPoint>()
+
+  // Find boundary links
+  for (const link of rootGraph.links) {
+    const fromNode = typeof link.from === 'string' ? link.from : link.from.node
+    const toNode = typeof link.to === 'string' ? link.to : link.to.node
+    const fromPort = typeof link.from === 'object' ? link.from.port : undefined
+    const toPort = typeof link.to === 'object' ? link.to.port : undefined
+
+    const fromInside = childNodeIds.has(fromNode)
+    const toInside = childNodeIds.has(toNode)
+
+    if (fromInside && !toInside) {
+      // Outgoing connection
+      const key = `${subgraphId}:${fromNode}:${fromPort || ''}`
+      if (!exportPoints.has(key)) {
+        const destSubgraph = findNodeSubgraph(rootGraph, toNode)
+        exportPoints.set(key, {
+          subgraphId,
+          device: fromNode,
+          port: fromPort,
+          destSubgraphLabel: destSubgraph?.label || toNode,
+          destDevice: toNode,
+          destPort: toPort,
+          isSource: true,
+        })
+      }
+    } else if (!fromInside && toInside) {
+      // Incoming connection
+      const key = `${subgraphId}:${toNode}:${toPort || ''}`
+      if (!exportPoints.has(key)) {
+        const destSubgraph = findNodeSubgraph(rootGraph, fromNode)
+        exportPoints.set(key, {
+          subgraphId,
+          device: toNode,
+          port: toPort,
+          destSubgraphLabel: destSubgraph?.label || fromNode,
+          destDevice: fromNode,
+          destPort: fromPort,
+          isSource: false,
+        })
+      }
+    }
+  }
+
+  // Create export nodes and links
+  for (const [key, exportPoint] of exportPoints) {
+    const exportId = key.replace(/:/g, '_')
+
+    // Export node
+    exportNodes.push({
+      id: `${EXPORT_NODE_PREFIX}${exportId}`,
+      label: exportPoint.destSubgraphLabel,
+      shape: 'stadium',
+      metadata: {
+        _isExport: true,
+        _destSubgraph: exportPoint.destSubgraphLabel,
+        _destDevice: exportPoint.destDevice,
+        _destPort: exportPoint.destPort,
+        _isSource: exportPoint.isSource,
+      },
+    })
+
+    // Export link
+    const exportNodeId = `${EXPORT_NODE_PREFIX}${exportId}`
+    const deviceEndpoint = exportPoint.port
+      ? { node: exportPoint.device, port: exportPoint.port }
+      : exportPoint.device
+
+    exportLinks.push({
+      id: `${EXPORT_LINK_PREFIX}${exportId}`,
+      from: exportPoint.isSource ? deviceEndpoint : exportNodeId,
+      to: exportPoint.isSource ? exportNodeId : deviceEndpoint,
+      type: 'dashed',
+      arrow: 'forward',
+      metadata: {
+        _destSubgraphLabel: exportPoint.destSubgraphLabel,
+        _destDevice: exportPoint.destDevice,
+        _destPort: exportPoint.destPort,
+      },
+    })
+  }
+
+  return { exportNodes, exportLinks }
+}
+
+function findNodeSubgraph(graph: NetworkGraph, nodeId: string): Subgraph | undefined {
+  const node = graph.nodes.find((n) => n.id === nodeId)
+  if (!node?.parent) return undefined
+  return graph.subgraphs?.find((s) => s.id === node.parent)
+}

package/src/index.test.ts

@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest'
+import { sampleNetwork } from './fixtures/index.js'
 import { darkTheme, HierarchicalLayout, modernTheme, version } from './index.js'
 import type { NetworkGraph } from './models/index.js'
 
@@ -63,4 +64,26 @@ describe('@shumoku/core', () => {
       expect(darkTheme.colors.background).toBeDefined()
     })
   })
+
+  describe('fixtures', () => {
+    it('should export sampleNetwork', () => {
+      expect(sampleNetwork).toBeDefined()
+      expect(Array.isArray(sampleNetwork)).toBe(true)
+      expect(sampleNetwork.length).toBeGreaterThan(0)
+    })
+
+    it('should have main.yaml as first file', () => {
+      expect(sampleNetwork[0].name).toBe('main.yaml')
+      expect(sampleNetwork[0].content).toContain('Sample Network')
+    })
+
+    it('should have all required files', () => {
+      const fileNames = sampleNetwork.map((f) => f.name)
+      expect(fileNames).toContain('main.yaml')
+      expect(fileNames).toContain('cloud.yaml')
+      expect(fileNames).toContain('perimeter.yaml')
+      expect(fileNames).toContain('dmz.yaml')
+      expect(fileNames).toContain('campus.yaml')
+    })
+  })
 })

package/src/index.ts

@@ -4,6 +4,10 @@
 
 // Constants
 export * from './constants.js'
+// Fixtures
+export * from './fixtures/index.js'
+// Hierarchical
+export * from './hierarchical.js'
 // Icons
 export * from './icons/index.js'
 // Layout