@neo4j-nvl/base 1.2.2 → 2.0.0

package/dist/types/layouts/forcedirectedlayout/clustering/clustering-utils.d.ts

@@ -0,0 +1,143 @@
+import type { Node, Relationship } from '../../../types/graph-element';
+import type { CoarsenedGraph, PartialPlanet, PartialSun, SolarNode, SolarRelationship, Sun } from './types';
+/**
+ * Gets the original node ids belonging to a sun and its planets and moons.
+ * @param sun - The sun to get the original node ids for.
+ * @returns The original node ids belonging to the sun system.
+ *
+ * @note Synthetic suns are not included in the returned array.
+ */
+export declare const getSunSystemOriginalIds: (sun: Sun) => string[];
+/**
+ * How many times a node's degree must exceed the graph's average degree before it is treated as a hub, see
+ * {@link isHub}.
+ *
+ * @remarks
+ * Mi et al., "Interactive Graph Layout of a Million Nodes", Sec. 4.3, proposes capping cluster *size* to avoid
+ * the outlier clusters this multiplier targets. `HubDegreeMultiplier` targets this problem by checking a node's
+ * own degree at claim time, before moon-matching runs.
+ * @see {@link https://www.mdpi.com/2227-9709/3/4/23 Interactive Graph Layout of a Million Nodes} Sec. 4.3
+ */
+export declare const HubDegreeMultiplier = 3;
+/**
+ * @param relationships - The graph's adjacency list, indexed by node id.
+ * @returns The degree a node must exceed to be treated as a hub by {@link isHub}.
+ */
+export declare const getHubDegreeThreshold: (relationships: number[][]) => number;
+/**
+ * Whether a node's degree is enough of an outlier that it must become its own sun rather than being absorbed as
+ * a planet/moon of another sun.
+ *
+ * @param index - The node id to check.
+ * @param relationships - The graph's adjacency list, indexed by node id.
+ * @param hubDegreeThreshold - The threshold from {@link getHubDegreeThreshold}.
+ * @see {@link HubDegreeMultiplier}
+ */
+export declare const isHub: (index: number, relationships: number[][], hubDegreeThreshold: number) => boolean;
+/**
+ * Builds adjacency lists and relationship id maps from the input graph.
+ * @param inputGraph - The nodes and relationships to convert.
+ * @param nodeIdToIndex - Maps node ids to contiguous array indices.
+ * @returns Parsed adjacency data for coarsening.
+ */
+export declare const buildAdjacencyGraph: (inputGraph: {
+    nodes: Node[];
+    rels: Relationship[];
+}, nodeIdToIndex: Record<string, number>) => {
+    nodes: Node[];
+    relationships: number[][];
+    relIdMap: string[][];
+    idToRel: Record<string, SolarRelationship>;
+};
+/**
+ * Wraps input nodes as {@link SolarNode}s indexed by their original position.
+ * @param nodes - The input graph nodes.
+ * @returns {SolarNode[]} Solar nodes with positional ids and original ids preserved.
+ */
+export declare const createSolarNodesFromInput: (nodes: Node[]) => SolarNode[];
+/**
+ * Creates a Planet with an unsettled parent link (caller must attach via {@link attachPlanetsToSun}).
+ */
+export declare const createPlanet: (params: {
+    id: number;
+    sunId: number;
+    weight: number;
+    originalId: string;
+    finestIndex?: number;
+    size?: () => number;
+}) => PartialPlanet;
+/**
+ * Finalises a sun's planets list, weight/size/children closures, and back-links parent on each planet.
+ * @param partialSun - The sun under construction (planets/size/children/weight not yet set).
+ * @param planets - The planets to attach to the sun (parent not yet set).
+ * @param centreWeight - The weight of the sun itself, added to the sum of its planets' weights.
+ * @param centreSize - The size of the sun itself, added to the sum of its planets' sizes.
+ * @returns A new sun object with planets attached. `previousIndex` is a placeholder until
+ * {@link sortHierarchyForShaderLayout} assigns the real value.
+ */
+export declare const attachPlanetsToSun: (partialSun: PartialSun, planets: PartialPlanet[], centreWeight: number, centreSize: number) => Sun;
+/**
+ * Appends a synthetic sun node to the finest-level arrays for a multi-member clusterBy cluster.
+ * Uses a reserved {@link SolarNode.originalId} (`synth-sun:${clusterId}`) so it cannot collide with
+ * real node ids; {@link SolarNode.synthetic} marks it for detection.
+ * @param params.clusterId - Semantic cluster id embedded in the synth sun's stable originalId.
+ * @param params.solarNodesWithSynths - Finest solar nodes; the synth sun is appended here.
+ * @param params.relationshipsWithSynths - Finest adjacency lists; an empty row is appended for the synth sun.
+ * @param params.relIdMapWithSynths - Finest relationship id lists; an empty row is appended for the synth sun.
+ * @returns A sun under construction, ready for {@link attachPlanetsToSun} (separate from the finest SolarNode).
+ */
+export declare const createSynthClusterSun: (params: {
+    clusterId: string | number;
+    solarNodesWithSynths: SolarNode[];
+    relationshipsWithSynths: number[][];
+    relIdMapWithSynths: string[][];
+}) => PartialSun;
+/**
+ * Rolls node-level adjacency up to sun-level adjacency between clusters.
+ * When `weakLinkSunIds` is provided, edges where either endpoint is a Sun are skipped.
+ * @param relationships - Node adjacency lists indexed by node position.
+ * @param nodeIndexToSunIndex - Maps each node index to its sun index.
+ * @param sunCount - Number of suns in the coarse graph.
+ * @param weakLinkSunIds - Optional set of node indices that are Suns. When set, Sun-leaf and Sun-Sun edges are ignored.
+ * @returns {number[][]} Sun-level adjacency lists without duplicate edges.
+ */
+export declare const rollupInterSunRelationships: (relationships: number[][], nodeIndexToSunIndex: Record<number, number>, sunCount: number, weakLinkSunIds?: Set<number>) => number[][];
+/**
+ * Remaps adjacency lists to a sorted node order.
+ * @param relationships - Node adjacency lists in the pre-sort index order.
+ * @param nodeSortMap - Maps old node indices to sorted indices.
+ * @param relIdMap - Relationship ids aligned with adjacency lists.
+ * @param remapRelIds - Whether relationship ids should be remapped as well.
+ * @returns {{ relationships: number[][]; relIdMap: string[][] }} Remapped adjacency data.
+ */
+export declare const remapAdjacencyWithSortMap: (relationships: number[][], nodeSortMap: Record<number, number>, relIdMap: string[][], remapRelIds?: boolean) => {
+    relationships: number[][];
+    relIdMap: string[][];
+};
+/** Input nodes that may receive a layout `finestIndex` during sorting (plain Node on first pass). */
+type SourceNode = (Node | SolarNode) & {
+    finestIndex?: number;
+};
+export type SortHierarchyOptions = {
+    suns: Sun[];
+    solarNodes: SolarNode[];
+    sourceNodes?: SourceNode[];
+    relationships: number[][];
+    relIdMap: string[][];
+    idToRel: Record<string, SolarRelationship>;
+    firstIteration?: boolean;
+    includeMoons?: boolean;
+};
+/**
+ * Sorts suns, planets, and optionally moons into shader layout order and builds the finest subgraph.
+ * @param options - Hierarchy members and adjacency data to sort.
+ * @returns The finest subgraph, sort map, member-sun maps, and remapped relationship ids.
+ */
+export declare const sortHierarchyForShaderLayout: ({ suns, solarNodes, sourceNodes, relationships, relIdMap, idToRel, firstIteration, includeMoons }: SortHierarchyOptions) => {
+    sortedInput: CoarsenedGraph;
+    nodeSortMap: Record<number, number>;
+    sunMap: Record<string, string>;
+    memberMap: Record<string, string[]>;
+    relIdMap: string[][];
+};
+export {};

package/dist/types/layouts/forcedirectedlayout/clustering/clustering-utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/layouts/forcedirectedlayout/{physlayout/solarmerger → clustering}/types.d.ts

@@ -1,4 +1,4 @@
-import type { Node } from '../../../../types/graph-element';
+import type { Node } from '../../../types/graph-element';
 export interface SolarNode extends Omit<Node, 'id' | 'size'> {
     id: number;
     weight?: number;
@@ -13,6 +13,7 @@ export interface SolarNode extends Omit<Node, 'id' | 'size'> {
         y: number;
     };
     size?: number | (() => number);
+    synthetic?: boolean;
 }
 export interface SolarRelationship {
     id: string;
@@ -23,6 +24,11 @@ export interface CoarsenedGraph {
     nodes: SolarNode[];
     relationships: number[][];
     idToRel: Record<string, SolarRelationship>;
+    /**
+     * Contains the "real" {@link relationships} plus any synthetic edges purely for layout purposes.
+     * Undefined when there are no synthetic edges (e.g. SolarMerger).
+     */
+    springRelationships?: number[][];
 }
 export interface Sun extends SolarNode {
     planets: Planet[];
@@ -30,6 +36,8 @@ export interface Sun extends SolarNode {
     children: () => Planet[];
     previousIndex: number;
 }
+/** Sun fields known before {@link attachPlanetsToSun} fills planets/size/children/weight. */
+export type PartialSun = Omit<Sun, 'planets' | 'size' | 'children' | 'previousIndex' | 'weight'>;
 export interface Planet extends SolarNode {
     parent: Sun;
     sunId: number;
@@ -37,6 +45,8 @@ export interface Planet extends SolarNode {
     size: () => number;
     children: () => Moon[];
 }
+/** Planet fields known before {@link attachPlanetsToSun} sets parent. */
+export type PartialPlanet = Omit<Planet, 'parent'>;
 export interface Moon extends SolarNode {
     parent: Planet;
     sunId: number;

package/dist/types/layouts/forcedirectedlayout/shaders/multilevel-fragment.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "#version 300 es\nprecision mediump float;\n\nuniform sampler2D u_physData;\nuniform sampler2D u_connections;\nuniform sampler2D u_connectionOffsets;\nuniform sampler2D u_pinnedNodes;\nuniform sampler2D u_sizeTexture;\nuniform float u_baseLength;\nuniform float u_curIteration;\nuniform float u_iterationMultiplier;\nuniform vec2 u_gravityCenter;\nuniform float u_numNodes;\nuniform float u_gravity;\n\nuniform sampler2D u_clusterData;\nuniform sampler2D u_prevForce;\nuniform float u_collisionMultiplier;\nuniform float u_maxNodeSize;\nuniform float u_crossClusterRelationshipMultiplier;\n\nout vec4 fragColor;\n\nfloat DAMP = 0.6;\nfloat COOL = 0.99998;\nfloat TIMESTEP = 1.0 / 30.0;\nfloat VELOCITYDECAY = 0.6;\nfloat accLimitLow = 500000.0;\nfloat accLimitHigh = 750000.0;\nfloat accLimitPosHigh = 10000000.0;\n\nconst float denseNodeThreshold = 1000.0;\nconst float MIN_DISTANCE = 0.00000001;\nconst float MAX_DISTANCE = 1000000000.0;\nconst float MAX_ACCELERATION = 50000.0;\n\nvec4 getTextureData(sampler2D tex, float index, float base) {\n  float x = mod(index, base);\n  float y = (index - x) / base;\n  return texture(tex, vec2(x + 0.5, y + 0.5) / base);\n}\n\nbool isNan(float val) {\n  return (val < 0.0 || 0.0 < val || val == 0.0) ? false : true;\n}\n\nconst float BIG_NUMBER = 999999999999999999.0;\nbool isInf(float val) {\n  return val > BIG_NUMBER || val < -BIG_NUMBER;\n}\n\nvec2 getDelta(vec2 v1, vec2 v2) {\n  vec2 delta = v1 - v2;\n  float dist = length(delta);\n  if (dist < MIN_DISTANCE || isNan(dist)) {\n    return vec2(MIN_DISTANCE, MIN_DISTANCE);\n  }\n  if (dist > MAX_DISTANCE) {\n    vec2 normDelta = delta / dist;\n    return normDelta * MAX_DISTANCE;\n  }\n  return delta;\n}\n\nvec4 getOtherNodePosition(float i) {\n  return getTextureData(u_physData, i, 256.0);\n}\n\nfloat getCombinedNodeSize(float i, float nodeSize) {\n  float otherNodeSize = getTextureData(u_sizeTexture, i, 256.0).r;\n  return nodeSize + otherNodeSize;\n}\n\nvec2 getSpringForce(float curConnection, float numConnections, float springFScale, vec4 myPosition, float i, float myClusterStartIndex) {\n  float curSpring = getTextureData(u_connections, curConnection + i, 4096.0).r;\n\n  vec4 otherPosition = getTextureData(u_physData, curSpring, 256.0);\n  float otherDataPosition = getTextureData(u_connectionOffsets, curSpring, 256.0).r;\n  float otherNumConnections = getTextureData(u_connections, otherDataPosition, 4096.0).r;\n  float avgDegree = max((otherNumConnections + numConnections * 3.0) / 4.0, 4.0);\n\n  vec2 delta = getDelta(myPosition.xy, otherPosition.xy);\n  float dist = length(delta);\n\n  float F = (dist * dist * springFScale) / (u_baseLength * avgDegree) * u_collisionMultiplier;\n\n  // u_crossClusterRelationshipMultiplier only damps edges that cross a cluster boundary\n  if (u_crossClusterRelationshipMultiplier < 1.0) {\n    float otherClusterStartIndex = getTextureData(u_clusterData, curSpring, 256.0).y;\n    F *= otherClusterStartIndex == myClusterStartIndex ? 1.0 : u_crossClusterRelationshipMultiplier;\n  }\n\n  return (-delta / dist) * F;\n}\n\nvec2 getCollisionForce(float combinedNodeSize, float dist, float fScale, vec2 delta) {\n  float collisionForce = (combinedNodeSize - dist) / (dist) * u_collisionMultiplier;\n  return (delta * collisionForce * fScale * combinedNodeSize) / (combinedNodeSize + 1.0);\n}\n\nvec2 getRepulsionForce(float dist, float fScale, vec2 delta) {\n  float F = (u_baseLength * u_baseLength * fScale) / (dist) * u_collisionMultiplier;\n  return (delta / dist) * F * 0.05;\n}\n\nvoid main(void) {\n  float textureSide = 256.0; //#TEXTURE_SIDE#;\n  float index = (gl_FragCoord.x - 0.5) + (gl_FragCoord.y - 0.5) * textureSide;\n\n  if (index >= u_numNodes) {\n    discard;\n  }\n\n  vec4 clusterData = getTextureData(u_clusterData, index, 256.0);\n\n  float clusterIndex = clusterData.x;\n  float clusterStartIndex = clusterData.y;\n  float clusterSize = clusterData.z;\n\n  vec4 myPosition = getTextureData(u_physData, index, 256.0);\n  vec4 previousForce = getTextureData(u_prevForce, clusterIndex, 256.0);\n\n  vec2 acceleration = previousForce.xy;\n\n  float isPinned = getTextureData(u_pinnedNodes, index, 256.0).r;\n  float nodeSize = getTextureData(u_sizeTexture, index, 256.0).r;\n\n  if (isPinned > 0.5) {\n    fragColor = vec4(myPosition.xy, 0.0, 0.0);\n    return;\n  }\n\n  // Prime the second ping-pong texture with the initial state without calculating forces\n  // that would otherwise be discarded at the end of this first iteration.\n  if (u_curIteration == 0.0) {\n    fragColor = vec4(myPosition.xy, myPosition.zw);\n    return;\n  }\n\n  float curConnection = getTextureData(u_connectionOffsets, index, 256.0).r;\n  float numConnections = getTextureData(u_connections, curConnection, 4096.0).r;\n\n  float fScale = 1.0 + sqrt(u_iterationMultiplier);\n  float springFScale = fScale;\n\n  if (numConnections > denseNodeThreshold) {\n    springFScale = sqrt(fScale);\n  }\n\n  float numOfRels = 0.0;\n\n  // Springs\n  for (float i = 1.0; i <= 256.0 * 256.0; i++) {\n    if (numOfRels >= numConnections) {\n      break;\n    }\n    acceleration += getSpringForce(curConnection, numConnections, springFScale, myPosition, i, clusterStartIndex);\n    numOfRels += 1.0;\n  }\n\n  // Repulsion && collision detection.\n  if (u_collisionMultiplier > 0.0) {\n    float number_of_collisions = 0.0;\n    for (float i = 0.0; i < 256.0 * 256.0; i++) {\n      if (i >= u_numNodes) {\n        break;\n      }\n\n      if (i == index) {\n        continue;\n      }\n\n      vec4 otherPosition = getOtherNodePosition(i);\n      vec2 delta = getDelta(myPosition.xy, otherPosition.xy);\n      float dist = length(delta);\n\n      if (number_of_collisions < 40.0 && dist < (nodeSize + u_maxNodeSize) * 2.0) {\n        float combinedNodeSize = getCombinedNodeSize(i, nodeSize) * 2.0;\n        if (dist < combinedNodeSize) {\n          number_of_collisions++;\n          acceleration += getCollisionForce(combinedNodeSize, dist, fScale, delta);\n        }\n      }\n\n      if (i >= clusterStartIndex && i < clusterStartIndex + clusterSize) {\n        acceleration += getRepulsionForce(dist, fScale, delta);\n      }\n    }\n  }\n\n  // Gravity\n  vec2 delta = getDelta(u_gravityCenter, myPosition.xy);\n  float dist = length(delta);\n\n  vec2 grav = (delta / dist) * u_gravity * fScale * (dist / 1000.0);\n  acceleration += grav;\n\n  float accMagnitude = length(acceleration);\n  acceleration *= min(MAX_ACCELERATION, accMagnitude) / accMagnitude;\n\n  float iterationFrictionThreshold = 1000.0;\n\n  if (u_curIteration > iterationFrictionThreshold) {\n    float friction = 1.0 + pow((u_curIteration - iterationFrictionThreshold), 2.0) / 100.0;\n    acceleration *= 1.0 / friction;\n  }\n\n  float TEMP = max(0.02, pow(COOL, u_curIteration));\n  vec2 prevVelocity = myPosition.zw;\n  vec2 currentPos = myPosition.xy;\n\n  vec2 newPos = currentPos + TEMP * ( DAMP * (prevVelocity) + acceleration * TIMESTEP * TIMESTEP);\n  vec2 newVelocity = newPos - currentPos;\n  fragColor = vec4(newPos, newVelocity);\n}";
+export default _default;

package/dist/types/layouts/forcedirectedlayout/shaders/multilevel-repulsive-fragment.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "#version 300 es\nprecision mediump float;\nuniform sampler2D u_physData;\nuniform sampler2D u_clusterData;\nuniform sampler2D u_finestIndexes;\nuniform sampler2D u_prevForce;\n\nuniform float u_baseLength;\nuniform float u_numNodes;\nuniform float u_iterationMultiplier;\nuniform float u_isTopLevel;\n\nout vec4 fragColor;\n\nfloat PI = 3.1415926535897932384626433832795;\nfloat TIMESTEP = 1.0 / 30.0;\nfloat VELOCITYDECAY = 1.0;\n\nvec4 getTextureData(sampler2D tex, float index, float base) {\n  float x = mod(index, base);\n  float y = (index - x) / base;\n  return texture(tex, vec2(x + 0.5, y + 0.5) / base);\n}\n\nfloat getAdjustedClusterWeight(float clusterWeight) {\n  return (clusterWeight * clusterWeight) / (clusterWeight + 1.0);\n}\n\n// Repulsion area from peer mass (weight). .z size is only for mid-level loop bounds.\nfloat getPeerFootprintArea(float peerWeight) {\n  return pow(sqrt(peerWeight) * 4.0 + u_baseLength * 2.0, 2.0);\n}\n\nvoid main(void) {\n  float index = (gl_FragCoord.x - 0.5) + (gl_FragCoord.y - 0.5) * 256.0;\n\n  if (index >= u_numNodes) {\n    discard;\n  }\n\n  vec4 clusterData = getTextureData(u_clusterData, index, 256.0);\n  bool isTopLevel = u_isTopLevel == 1.0;\n\n  float clusterIndex = clusterData.x;\n  float clusterStartIndex = clusterData.y;\n  float clusterSize = clusterData.z;\n  float singleNodeRepulsionScale = isTopLevel && clusterSize == 1.0 ? 0.5 : 1.0;\n\n  float finestIndex = getTextureData(u_finestIndexes, index, 256.0).r;\n  vec4 myPosition = getTextureData(u_physData, finestIndex, 256.0);\n  vec4 previousForce = getTextureData(u_prevForce, clusterIndex, 256.0);\n  float fScale = 1.0 + sqrt(u_iterationMultiplier);\n\n  vec2 acceleration = previousForce.xy;\n\n  float loopEnd = isTopLevel ? u_numNodes : (clusterStartIndex + clusterSize);\n\n  // Repulsion & Collision Detection\n  for (float i = 0.0; i < 256.0 * 256.0; i++) {\n    if (i >= loopEnd || i >= u_numNodes) {\n      break;\n    }\n    if ((!isTopLevel && i < clusterStartIndex) || i == index) {\n      continue;\n    }\n\n    vec4 otherClusterData = getTextureData(u_clusterData, i, 256.0);\n    float otherClusterWeight = getAdjustedClusterWeight(otherClusterData.w);\n\n    float otherFinestIndex = getTextureData(u_finestIndexes, i, 256.0).r;\n    vec4 otherPosition = getTextureData(u_physData, otherFinestIndex, 256.0);\n\n    vec2 delta = myPosition.xy - otherPosition.xy;\n    float dist = max(length(delta), 0.0000001);\n    float maxDist = 25.0;\n    float repulsionForceScale = 0.1;\n\n    float area = getPeerFootprintArea(otherClusterData.w);\n    float F = (area * fScale) / (dist * dist);\n\n    if (isTopLevel) {\n      repulsionForceScale = 0.2;\n    }\n\n    acceleration += ((delta / sqrt(dist)) * F) * repulsionForceScale * otherClusterWeight * singleNodeRepulsionScale;\n\n    if (dist < maxDist) {\n      float collide = (maxDist - dist) / (dist * dist);\n      acceleration += delta * collide * fScale * maxDist / (maxDist + 1.0);\n    }\n  }\n\n  fragColor = vec4(acceleration, vec2(finestIndex, 0));\n}";
+export default _default;

package/dist/types/layouts/forcedirectedlayout/shaders/multilevel-update-fragment.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "#version 300 es\nprecision mediump float;\n\nuniform sampler2D u_physData;\nuniform sampler2D u_updateData;\nuniform float u_numNodesNew;\n\nout vec4 fragColor;\n\nconst float INDEX_FLAG = 999999.0;\n\nvec4 getTextureData(sampler2D tex, float index, float base) {\n  float x = mod(index, base);\n  float y = (index - x) / base;\n  return texture(tex, vec2(x + 0.5, y + 0.5) / base);\n}\n\nvoid main(void) {\n  float textureSide = 256.0; //#TEXTURE_SIDE#;\n  float index = (gl_FragCoord.x - 0.5) + (gl_FragCoord.y - 0.5)*textureSide;\n\n  if (index >= u_numNodesNew) {\n    discard;\n  }\n\n  float firstValue = getTextureData(u_updateData, index * 2.0, 256.0).r;\n  float secondValue = getTextureData(u_updateData, index * 2.0 + 1.0, 256.0).r;\n\n  if (secondValue == INDEX_FLAG) {\n    vec4 myPosition = getTextureData(u_physData, firstValue, 256.0);\n    fragColor = myPosition;\n  } else {\n    fragColor = vec4(firstValue, secondValue, 0.0, 0.0);\n  }\n}\n";
+export default _default;

package/dist/types/layouts/forcedirectedlayout/shaders/sim-vertex.d.ts

@@ -0,0 +1,2 @@
+declare const _default: "#version 300 es\nuniform mat4 u_projection;\n\nin vec2 a_position;\n//in float a_index;\n\n//out highp float index;\n\nvoid main() {\n//  index = a_index;\n  gl_Position = u_projection * vec4(a_position, 0.0, 1.0);\n}";
+export default _default;

package/dist/types/layouts/freeLayout/FreeLayout.d.ts

@@ -1,5 +1,5 @@
 import type { NvlState } from '../../modules/state/types';
-import type { Node } from '../../types/graph-element';
+import type { Node, PartialNode } from '../../types/graph-element';
 import type { Point } from '../../utils/geometry';
 export declare class FreeLayout {
     private state;
@@ -10,9 +10,7 @@ export declare class FreeLayout {
         state: NvlState;
     });
     setOptions(): any;
-    updateNodes(positionList: (Point & {
-        id: string;
-    })[]): void;
+    updateNodes(positionList: PartialNode[]): void;
     update(refreshPositions?: boolean): void;
     layout(nodes: Node[], nodeIds: Record<string, Node>, idToPosition: Record<string, Node>): void;
     setNodePositions(p: Record<string, Point>): void;

package/dist/types/layouts/gridLayout/GridLayout.d.ts

@@ -1,5 +1,5 @@
 import type { NvlState } from '../../modules/state/types';
-import type { Node } from '../../types/graph-element';
+import type { Node, PartialNode } from '../../types/graph-element';
 import type { Point } from '../../utils/geometry';
 export declare class GridLayout {
     state: NvlState;
@@ -10,11 +10,7 @@ export declare class GridLayout {
         state: NvlState;
     });
     setOptions(): void;
-    updateNodes(positionList: {
-        id: string;
-        x: number;
-        y: number;
-    }[]): void;
+    updateNodes(positionList: PartialNode[]): void;
     update(refreshPositions?: boolean): void;
     layout(mobxNodes: any): void;
     setNodePositions(idToPosition: Record<string, Node & Point>): void;

package/dist/types/layouts/hierarchicallayout/HierarchicalLayout.d.ts

@@ -7,6 +7,8 @@ type HierarchicalLayoutConfig = {
 export declare class HierarchicalLayout extends AnimatedLayout {
     private direction;
     private packing;
+    private clusterBy?;
+    private lastClusterByAssignments;
     private stateDisposers;
     private oldComputing;
     private computing;
@@ -14,9 +16,12 @@ export declare class HierarchicalLayout extends AnimatedLayout {
     private worker;
     private directionChanged;
     private packingChanged;
+    private clusterByChanged;
     private workersDisabled;
     constructor(config: HierarchicalLayoutConfig);
     setOptions(options: LayoutOptions): void;
+    private applyClusterByOption;
+    private buildClusterAssignments;
     update(refreshPositions?: boolean): void;
     getShouldUpdate(): boolean;
     getComputing(): boolean;

package/dist/types/modules/ExternalCallbackHandler.d.ts

@@ -1,18 +1,12 @@
-import type { Node } from '../types/graph-element';
+import type { NodeWithClientPosition } from '../types/graph-element';
 /**
  * An object specifying the required callback functions for certain actions
  */
 export interface ExternalCallbacks {
     /** Triggered when a layout is done moving. */
     onLayoutDone?: () => void;
-    /**
-     * Triggered on each step of a layout.
-     * Node `x` and `y` are client/screen coordinates relative to the canvas.
-     *
-     * @note In the next major release, `x` and `y` become layout coordinates and
-     * screen coordinates move to a `clientPosition` field.
-     */
-    onLayoutStep?: (p: Node[]) => void;
+    /** Triggered on each step of a layout. */
+    onLayoutStep?: (p: NodeWithClientPosition[]) => void;
     /** Triggered when NVL throws an error after initialization. */
     onError?: (error: Error) => void;
     /** Triggered when NVL is initialized. */
@@ -38,7 +32,7 @@ export default class ExternalCallbackHandler {
     onInitialization(): void;
     onZoomTransitionDone(): void;
     onLayoutDone(): void;
-    onLayoutStep(p: Node[]): void;
+    onLayoutStep(p: NodeWithClientPosition[]): void;
     onLayoutComputing(isComputing: boolean): void;
     onError(error: Error): void;
     onWebGLContextLost(webGLContextEvent: WebGLContextEvent): void;

package/dist/types/modules/NvlController.d.ts

@@ -1,4 +1,4 @@
-import { type Node, type PartialNode, type PartialRelationship, type Relationship } from '../types/graph-element';
+import { type Node, type NodeWithClientPosition, type PartialNode, type PartialRelationship, type Relationship } from '../types/graph-element';
 import '../types/nvl-window-functions';
 import type { Point } from '../utils/geometry';
 import type { ExternalCallbacks } from './ExternalCallbackHandler';
@@ -31,10 +31,13 @@ export default class NvlController {
     private readonly forceLayout;
     private readonly canvasRenderer;
     private readonly svgRenderer;
+    private clusterOverlay;
     private readonly glCanvas;
     private canvasRect;
     private readonly glMinimapCanvas;
     private readonly c2dCanvas;
+    private clusterOverlayCanvas;
+    private readonly canvasParent;
     private readonly svg;
     private isInRenderSwitchAnimation;
     private previousRenderer;
@@ -46,25 +49,96 @@ export default class NvlController {
     private readonly stateDisposers;
     private readonly zoomTransitionHandler;
     private currentLayout;
+    private lastTimestamp;
+    private accumulator;
     private readonly layoutTimeLimit;
+    private readonly smoothFrameBudgetMs;
     private pixelRatio;
     private readonly removeResizeListener;
     private readonly removeMinimapResizeListener;
     private pendingZoom;
     private pendingPan;
     private pendingViewportOverride;
-    private layoutRunner;
     private animationRequestId;
     private layoutDoneCallback;
     private layoutComputingCallback;
     private currentLayoutType;
     private descriptionElement;
+    /** True when a minimap container was provided at construction. */
+    private readonly hasMinimap;
+    private lastMinimapPositions;
+    private lastMinimapCacheVersion;
     constructor(state: NvlState, frame: HTMLElement, options: NvlOptions);
     private onWebGLContextLost;
+    private fpsToFrameBudgetMs;
+    private getLayoutNeedsToUpdate;
+    private isWithinBudget;
+    /**
+     * Add elapsed frame time to the layout-step accumulator, capped at `layoutTimeLimit`.
+     * Prevents a slow frame (e.g. blocked GPU readback) from inflating catch-up debt and
+     * scheduling ever more work in a feedback loop; the layout falls behind gracefully instead.
+     */
+    private accumulateLayoutElapsedTime;
+    /**
+     * Whether the GPU force-directed layout is active.
+     * @returns `true` when PhysLayout is the current layout.
+     */
+    private usesGpuSimulation;
+    /**
+     * Whether the GPU-texture fast path can be taken this frame.
+     * Requires the WebGL renderer, GPU layout active, and no CPU-position consumers
+     * (layout-step callback, HTML overlays). A provided minimap no longer blocks this path;
+     * the minimap and cluster overlay are updated from the lagged async position cache instead.
+     * @returns `true` when rendering directly from the GPU position texture is safe.
+     */
+    private canRenderFromGpuTexture;
+    /**
+     * Uploads lagged PhysLayout cache positions to the minimap when the cache version changed.
+     * @returns `true` when positions were refreshed this call.
+     */
+    private refreshMinimapFromCacheIfStale;
+    /**
+     * Fits, renders, and caches minimap positions (and PhysLayout cache version when applicable).
+     */
+    private syncMinimap;
+    /** Whether either cluster decoration is enabled in the current layout options. */
+    private hasClusterDecorations;
+    /**
+     * Creates the decoration canvas and its overlay.
+     * @returns The overlay to draw with.
+     */
+    private createClusterOverlay;
+    /**
+     * Resolves the overlay to draw into, allocating it on first use and tearing it down again
+     * while cluster decorations are off.
+     * @returns The overlay to draw with, or null when decorations are disabled.
+     */
+    private ensureClusterOverlay;
+    /** Tears the overlay and its canvas back down once decorations are switched off. */
+    private destroyClusterOverlay;
+    /**
+     * Draws (or clears) cluster decorations on the Canvas2D overlay from explicit positions.
+     * @param positions - CPU node positions for this frame, or null to clear.
+     */
+    private renderClusterOverlay;
+    /**
+     * Draws cluster decorations from PhysLayout's lagged async PBO cache without a sync dump.
+     * @param forceLayout - The PhysLayout instance to render the cluster overlay from.
+     */
+    private renderClusterOverlayFromCache;
+    /** Syncs idToPosition from the GPU layout on demand; no-op for CPU layouts. */
+    syncPositionsFromLayout(): void;
+    /**
+     * Fitted {@link ClusteringOptions.clusterBy} hull regions for the current layout, or [].
+     * @returns Cluster hit regions for picking.
+     */
+    getClusterByHitRegions(): import("../utils/clusterHitRegions").ClusterHitRegion[];
     private updateMinimapZoom;
     private startMainLoop;
+    private renderNodeHtmlOverlays;
+    private renderRelationshipHtmlOverlays;
     updateHtmlOverlay(): void;
-    dumpNodes(): Node[];
+    dumpNodes(): NodeWithClientPosition[];
     dumpRelationships(): Relationship[];
     /**
      * Map a relative Canvas space to the DOM position
@@ -93,7 +167,7 @@ export default class NvlController {
     };
     registerDoneCallback(cb: NvlController['layoutDoneCallback']): void;
     registerComputingCallback(cb: NvlController['layoutComputingCallback']): void;
-    getPosition(nodeId: string): Node;
+    getPosition(nodeId: string): Node & Point;
     getScale(): number;
     getPan(): {
         x: number;
@@ -113,10 +187,16 @@ export default class NvlController {
     getCanvasNodesAt(point: Point, hitNodeMarginWidth?: number): import("..").HitTargetNode[];
     private getLayout;
     setLayout(layoutType: Layout): void;
-    setLayoutOptions(options: LayoutOptions): void;
+    setLayoutOptions(options?: LayoutOptions): void;
+    /**
+     * Syncs positions if needed and redraws (or clears) the cluster overlay from current state.
+     */
+    private refreshClusterOverlay;
     private getDataUrlForCanvas;
     private initiateFileDownload;
     private updateLayoutAndPositions;
+    private getAndUpdatePositions;
+    private getLayoutPositions;
     saveToFile(options: SaveToFileOptions): void;
     private createSvgString;
     saveToSvg(options?: SaveToFileOptions): Promise<void>;

package/dist/types/modules/Shader.d.ts

@@ -4,7 +4,7 @@ export default class Shader {
     private curTexture;
     private attributeInfo;
     private uniformInfo;
-    constructor(gl: WebGLRenderingContext, vsSource: string, fsSource: string, defines?: {});
+    constructor(gl: WebGL2RenderingContext, vsSource: string, fsSource: string, defines?: {});
     setUniform(name: string, value: any): void;
     setAttributePointer(name: string, size: number, start: number, stride: number): void;
     setAttributePointerFloat(name: string, size: number, start: number, stride: number): void;

package/dist/types/modules/dataset.d.ts

@@ -1,5 +1,5 @@
 import type { Node, Relationship } from '../types/graph-element';
-import type { Point } from '../utils/geometry';
+import { type Point } from '../utils/geometry';
 /** A graph stored with mobx. */
 export interface DataSet<T> {
     items: T[];
@@ -8,6 +8,7 @@ export interface DataSet<T> {
     idToPosition: Record<string, Node & Point>;
     idToHtmlOverlay?: Record<string, HTMLElement>;
     version: number;
+    maxDimension: number;
     addChannel: (this: DataSet<T>, channelName: string) => void;
     removeChannel: (this: DataSet<T>, channelName: string) => void;
     clearChannel: (this: DataSet<T>, channelName: string) => void;
@@ -29,7 +30,8 @@ export interface Channel<T> {
     updates: Record<string, T>;
     removes: Record<string, T>;
 }
-export declare const getHtmlProperty: (item: Partial<Node | Relationship>) => HTMLElement | undefined;
+export declare const getHtmlKey: (item: Node | Relationship) => "html" | "captionHtml";
+export declare const getHtmlProperty: (item: Node | Relationship) => HTMLElement | undefined;
 /**
  * Creates an empty dataset in which a graph be stored and updated using mobx actions.
  * @returns A new and empty {@link DataSet}.