From 844d574c4ffabe353bd6271d6195955e884decde Mon Sep 17 00:00:00 2001 From: moklick Date: Wed, 27 Mar 2024 11:22:43 +0100 Subject: [PATCH] refactor(react): separate user nodes and indernal nodes --- .../examples/FloatingEdges/FloatingEdge.tsx | 4 +- .../react/src/examples/FloatingEdges/utils.ts | 4 +- .../additional-components/MiniMap/MiniMap.tsx | 6 +- .../NodeToolbar/NodeToolbar.tsx | 24 ++-- .../src/components/ConnectionLine/index.tsx | 11 +- .../EdgeWrapper/EdgeUpdateAnchors.tsx | 4 +- .../react/src/components/Handle/index.tsx | 2 +- .../src/components/NodeWrapper/index.tsx | 15 ++- .../src/components/NodeWrapper/utils.tsx | 6 +- .../src/components/NodesSelection/index.tsx | 10 +- .../components/SelectionListener/index.tsx | 2 +- packages/react/src/container/Pane/index.tsx | 12 +- .../react/src/hooks/useMoveSelectedNodes.ts | 69 ++++++------ .../react/src/hooks/useNodesInitialized.ts | 8 +- packages/react/src/hooks/useReactFlow.ts | 8 +- packages/react/src/index.ts | 1 - packages/react/src/store/index.ts | 34 +++--- packages/react/src/store/initialState.ts | 6 +- packages/react/src/types/nodes.ts | 11 +- packages/react/src/types/store.ts | 5 +- packages/react/src/utils/changes.ts | 21 ++-- packages/system/src/constants.ts | 2 - packages/system/src/types/general.ts | 4 +- packages/system/src/types/nodes.ts | 24 ++-- packages/system/src/utils/edges/general.ts | 13 +-- packages/system/src/utils/edges/positions.ts | 25 +++-- packages/system/src/utils/general.ts | 5 +- packages/system/src/utils/graph.ts | 100 ++++++++++++----- packages/system/src/utils/store.ts | 106 ++++++++---------- packages/system/src/xydrag/XYDrag.ts | 26 +++-- packages/system/src/xydrag/utils.ts | 71 ++++++------ packages/system/src/xyhandle/XYHandle.ts | 8 +- packages/system/src/xyhandle/utils.ts | 42 +++---- 33 files changed, 374 insertions(+), 315 deletions(-) diff --git a/examples/react/src/examples/FloatingEdges/FloatingEdge.tsx b/examples/react/src/examples/FloatingEdges/FloatingEdge.tsx index 6ee9e1e2..0856d012 100644 --- a/examples/react/src/examples/FloatingEdges/FloatingEdge.tsx +++ b/examples/react/src/examples/FloatingEdges/FloatingEdge.tsx @@ -5,8 +5,8 @@ import { getEdgeParams } from './utils'; const FloatingEdge: FC = ({ id, source, target, style }) => { const { sourceNode, targetNode } = useStore((s) => { - const sourceNode = s.nodes.find((n) => n.id === source); - const targetNode = s.nodes.find((n) => n.id === target); + const sourceNode = s.nodeLookup.get(source); + const targetNode = s.nodeLookup.get(target); return { sourceNode, targetNode }; }); diff --git a/examples/react/src/examples/FloatingEdges/utils.ts b/examples/react/src/examples/FloatingEdges/utils.ts index c8a6e1c1..a022207c 100644 --- a/examples/react/src/examples/FloatingEdges/utils.ts +++ b/examples/react/src/examples/FloatingEdges/utils.ts @@ -1,4 +1,4 @@ -import { Position, XYPosition, Node, Edge } from '@xyflow/react'; +import { Position, XYPosition, Node, Edge, InternalNode } from '@xyflow/react'; // this helper function returns the intersection point // of the line between the center of the intersectionNode and the target node @@ -56,7 +56,7 @@ function getEdgePosition(node: Node, intersectionPoint: XYPosition) { } // returns the parameters (sx, sy, tx, ty, sourcePos, targetPos) you need to create an edge -export function getEdgeParams(source: Node, target: Node) { +export function getEdgeParams(source: InternalNode, target: InternalNode) { const sourceIntersectionPoint = getNodeIntersection(source, target); const targetIntersectionPoint = getNodeIntersection(target, source); diff --git a/packages/react/src/additional-components/MiniMap/MiniMap.tsx b/packages/react/src/additional-components/MiniMap/MiniMap.tsx index 17a3f7f2..0a05890d 100644 --- a/packages/react/src/additional-components/MiniMap/MiniMap.tsx +++ b/packages/react/src/additional-components/MiniMap/MiniMap.tsx @@ -3,7 +3,7 @@ import { memo, useEffect, useRef, type MouseEvent, useCallback, CSSProperties } from 'react'; import cc from 'classcat'; import { shallow } from 'zustand/shallow'; -import { getNodesBounds, getBoundsOfRects, XYMinimap, type Rect, type XYMinimapInstance } from '@xyflow/system'; +import { getInternalNodesBounds, getBoundsOfRects, XYMinimap, type Rect, type XYMinimapInstance } from '@xyflow/system'; import { useStore, useStoreApi } from '../../hooks/useStore'; import { Panel } from '../../components/Panel'; @@ -26,7 +26,9 @@ const selector = (s: ReactFlowState) => { return { viewBB, boundingRect: - s.nodes.length > 0 ? getBoundsOfRects(getNodesBounds(s.nodes, { nodeOrigin: s.nodeOrigin }), viewBB) : viewBB, + s.nodeLookup.size > 0 + ? getBoundsOfRects(getInternalNodesBounds(s.nodeLookup, { nodeOrigin: s.nodeOrigin }), viewBB) + : viewBB, rfId: s.rfId, nodeOrigin: s.nodeOrigin, panZoom: s.panZoom, diff --git a/packages/react/src/additional-components/NodeToolbar/NodeToolbar.tsx b/packages/react/src/additional-components/NodeToolbar/NodeToolbar.tsx index 0ecc8185..6c0236d8 100644 --- a/packages/react/src/additional-components/NodeToolbar/NodeToolbar.tsx +++ b/packages/react/src/additional-components/NodeToolbar/NodeToolbar.tsx @@ -1,23 +1,23 @@ import { useCallback, CSSProperties } from 'react'; import cc from 'classcat'; import { shallow } from 'zustand/shallow'; -import { getNodesBounds, Rect, Position, internalsSymbol, getNodeToolbarTransform } from '@xyflow/system'; +import { Rect, Position, getNodeToolbarTransform, getNodesBounds } from '@xyflow/system'; -import { Node, ReactFlowState } from '../../types'; +import { InternalNode, ReactFlowState } from '../../types'; import { useStore } from '../../hooks/useStore'; import { useNodeId } from '../../contexts/NodeIdContext'; import { NodeToolbarPortal } from './NodeToolbarPortal'; import type { NodeToolbarProps } from './types'; -const nodeEqualityFn = (a?: Node, b?: Node) => - a?.computed?.positionAbsolute?.x !== b?.computed?.positionAbsolute?.x || - a?.computed?.positionAbsolute?.y !== b?.computed?.positionAbsolute?.y || - a?.computed?.width !== b?.computed?.width || - a?.computed?.height !== b?.computed?.height || +const nodeEqualityFn = (a?: InternalNode, b?: InternalNode) => + a?.internals.positionAbsolute.x !== b?.internals.positionAbsolute.x || + a?.internals.positionAbsolute.y !== b?.internals.positionAbsolute.y || + a?.computed.width !== b?.computed.width || + a?.computed.height !== b?.computed.height || a?.selected !== b?.selected || - a?.[internalsSymbol]?.z !== b?.[internalsSymbol]?.z; + a?.internals.z !== b?.internals.z; -const nodesEqualityFn = (a: Node[], b: Node[]) => { +const nodesEqualityFn = (a: InternalNode[], b: InternalNode[]) => { if (a.length !== b.length) { return false; } @@ -49,10 +49,10 @@ export function NodeToolbar({ const contextNodeId = useNodeId(); const nodesSelector = useCallback( - (state: ReactFlowState): Node[] => { + (state: ReactFlowState): InternalNode[] => { const nodeIds = Array.isArray(nodeId) ? nodeId : [nodeId || contextNodeId || '']; - return nodeIds.reduce((acc, id) => { + return nodeIds.reduce((acc, id) => { const node = state.nodeLookup.get(id); if (node) { acc.push(node); @@ -74,7 +74,7 @@ export function NodeToolbar({ } const nodeRect: Rect = getNodesBounds(nodes, { nodeOrigin }); - const zIndex: number = Math.max(...nodes.map((node) => (node[internalsSymbol]?.z || 1) + 1)); + const zIndex: number = Math.max(...nodes.map((node) => (node.internals?.z || 1) + 1)); const wrapperStyle: CSSProperties = { position: 'absolute', diff --git a/packages/react/src/components/ConnectionLine/index.tsx b/packages/react/src/components/ConnectionLine/index.tsx index 4fe2ca76..86655232 100644 --- a/packages/react/src/components/ConnectionLine/index.tsx +++ b/packages/react/src/components/ConnectionLine/index.tsx @@ -2,7 +2,6 @@ import { CSSProperties, useCallback } from 'react'; import { shallow } from 'zustand/shallow'; import cc from 'classcat'; import { - internalsSymbol, Position, ConnectionLineType, ConnectionMode, @@ -53,7 +52,7 @@ const ConnectionLine = ({ ), shallow ); - const fromHandleBounds = fromNode?.[internalsSymbol]?.handleBounds; + const fromHandleBounds = fromNode?.internals?.handleBounds; let handleBounds = fromHandleBounds?.[handleType]; if (connectionMode === ConnectionMode.Loose) { @@ -65,10 +64,10 @@ const ConnectionLine = ({ } const fromHandle = handleId ? handleBounds.find((d) => d.id === handleId) : handleBounds[0]; - const fromHandleX = fromHandle ? fromHandle.x + fromHandle.width / 2 : (fromNode.computed?.width ?? 0) / 2; - const fromHandleY = fromHandle ? fromHandle.y + fromHandle.height / 2 : fromNode.computed?.height ?? 0; - const fromX = (fromNode.computed?.positionAbsolute?.x ?? 0) + fromHandleX; - const fromY = (fromNode.computed?.positionAbsolute?.y ?? 0) + fromHandleY; + const fromHandleX = fromHandle ? fromHandle.x + fromHandle.width / 2 : (fromNode.computed.width ?? 0) / 2; + const fromHandleY = fromHandle ? fromHandle.y + fromHandle.height / 2 : fromNode.computed.height ?? 0; + const fromX = (fromNode.internals.positionAbsolute.x ?? 0) + fromHandleX; + const fromY = (fromNode.internals.positionAbsolute.y ?? 0) + fromHandleY; const fromPosition = fromHandle?.position; const toPosition = fromPosition ? oppositePosition[fromPosition] : null; diff --git a/packages/react/src/components/EdgeWrapper/EdgeUpdateAnchors.tsx b/packages/react/src/components/EdgeWrapper/EdgeUpdateAnchors.tsx index 6061d8a7..e4810f11 100644 --- a/packages/react/src/components/EdgeWrapper/EdgeUpdateAnchors.tsx +++ b/packages/react/src/components/EdgeWrapper/EdgeUpdateAnchors.tsx @@ -54,7 +54,7 @@ export function EdgeUpdateAnchors({ onConnectStart, onConnectEnd, cancelConnection, - nodes, + nodeLookup, rfId: flowId, panBy, updateConnection, @@ -82,7 +82,7 @@ export function EdgeUpdateAnchors({ domNode, handleId, nodeId, - nodes, + nodeLookup, isTarget, edgeUpdaterType: handleType, lib, diff --git a/packages/react/src/components/Handle/index.tsx b/packages/react/src/components/Handle/index.tsx index ee36d066..977a5c5b 100644 --- a/packages/react/src/components/Handle/index.tsx +++ b/packages/react/src/components/Handle/index.tsx @@ -126,7 +126,7 @@ function HandleComponent( connectionMode: currentStore.connectionMode, connectionRadius: currentStore.connectionRadius, domNode: currentStore.domNode, - nodes: currentStore.nodes, + nodeLookup: currentStore.nodeLookup, lib: currentStore.lib, isTarget, handleId, diff --git a/packages/react/src/components/NodeWrapper/index.tsx b/packages/react/src/components/NodeWrapper/index.tsx index 8c207cd9..5e2b91e2 100644 --- a/packages/react/src/components/NodeWrapper/index.tsx +++ b/packages/react/src/components/NodeWrapper/index.tsx @@ -7,7 +7,6 @@ import { errorMessages, getNodeDimensions, getPositionWithOrigin, - internalsSymbol, isInputDOMNode, nodeHasDimensions, } from '@xyflow/system'; @@ -19,7 +18,7 @@ import { useDrag } from '../../hooks/useDrag'; import { useMoveSelectedNodes } from '../../hooks/useMoveSelectedNodes'; import { handleNodeClick } from '../Nodes/utils'; import { arrowKeyDiffs, builtinNodeTypes, getNodeInlineStyleDimensions } from './utils'; -import type { Node, NodeWrapperProps } from '../../types'; +import type { InternalNode, Node, NodeWrapperProps } from '../../types'; export function NodeWrapper({ id, @@ -44,11 +43,11 @@ export function NodeWrapper({ onError, }: NodeWrapperProps) { const { node, positionAbsoluteX, positionAbsoluteY, zIndex, isParent } = useStore((s) => { - const node = s.nodeLookup.get(id)! as NodeType; + const node = s.nodeLookup.get(id)! as InternalNode; const positionAbsolute = nodeExtent - ? clampPosition(node.computed?.positionAbsolute, nodeExtent) - : node.computed?.positionAbsolute || { x: 0, y: 0 }; + ? clampPosition(node.internals.positionAbsolute, nodeExtent) + : node.internals.positionAbsolute || { x: 0, y: 0 }; return { node, @@ -56,8 +55,8 @@ export function NodeWrapper({ // so we we need to force a re-render when some change positionAbsoluteX: positionAbsolute.x, positionAbsoluteY: positionAbsolute.y, - zIndex: node[internalsSymbol]?.z ?? 0, - isParent: !!node[internalsSymbol]?.isParent, + zIndex: node.internals.z, + isParent: node.internals.isParent, }; }, shallow); @@ -84,7 +83,7 @@ export function NodeWrapper({ const nodeDimensions = getNodeDimensions(node); const inlineDimensions = getNodeInlineStyleDimensions(node); const initialized = nodeHasDimensions(node); - const hasHandleBounds = !!node[internalsSymbol]?.handleBounds; + const hasHandleBounds = !!node.internals.handleBounds; const moveSelectedNodes = useMoveSelectedNodes(); diff --git a/packages/react/src/components/NodeWrapper/utils.tsx b/packages/react/src/components/NodeWrapper/utils.tsx index d6f7cc1a..c8c7d5c7 100644 --- a/packages/react/src/components/NodeWrapper/utils.tsx +++ b/packages/react/src/components/NodeWrapper/utils.tsx @@ -4,7 +4,7 @@ import { InputNode } from '../Nodes/InputNode'; import { DefaultNode } from '../Nodes/DefaultNode'; import { GroupNode } from '../Nodes/GroupNode'; import { OutputNode } from '../Nodes/OutputNode'; -import type { Node, NodeTypes } from '../../types'; +import type { InternalNode, Node, NodeTypes } from '../../types'; export const arrowKeyDiffs: Record = { ArrowUp: { x: 0, y: -1 }, @@ -21,12 +21,12 @@ export const builtinNodeTypes: NodeTypes = { }; export function getNodeInlineStyleDimensions( - node: NodeType + node: InternalNode ): { width: number | string | undefined; height: number | string | undefined; } { - if (!node.computed) { + if (node.internals.handleBounds === undefined) { return { width: node.width ?? node.initialWidth ?? node.style?.width, height: node.height ?? node.initialHeight ?? node.style?.height, diff --git a/packages/react/src/components/NodesSelection/index.tsx b/packages/react/src/components/NodesSelection/index.tsx index 6c037ba5..e87f23af 100644 --- a/packages/react/src/components/NodesSelection/index.tsx +++ b/packages/react/src/components/NodesSelection/index.tsx @@ -11,7 +11,7 @@ import { useStore, useStoreApi } from '../../hooks/useStore'; import { useDrag } from '../../hooks/useDrag'; import { useMoveSelectedNodes } from '../../hooks/useMoveSelectedNodes'; import { arrowKeyDiffs } from '../NodeWrapper/utils'; -import type { Node, ReactFlowState } from '../../types'; +import type { InternalNode, Node, ReactFlowState } from '../../types'; export type NodesSelectionProps = { onSelectionContextMenu?: (event: MouseEvent, nodes: NodeType[]) => void; @@ -20,7 +20,13 @@ export type NodesSelectionProps = { }; const selector = (s: ReactFlowState) => { - const selectedNodes = s.nodes.filter((n) => n.selected); + const selectedNodes: InternalNode[] = []; + for (const [, node] of s.nodeLookup) { + if (node.selected) { + selectedNodes.push(node); + } + } + const { width, height, x, y } = getNodesBounds(selectedNodes, { nodeOrigin: s.nodeOrigin }); return { diff --git a/packages/react/src/components/SelectionListener/index.tsx b/packages/react/src/components/SelectionListener/index.tsx index 0a3fa5a9..381a60cb 100644 --- a/packages/react/src/components/SelectionListener/index.tsx +++ b/packages/react/src/components/SelectionListener/index.tsx @@ -15,7 +15,7 @@ type SelectionListenerProps = { }; const selector = (s: ReactFlowState) => ({ - selectedNodes: s.nodes.filter((n) => n.selected), + selectedNodes: Array.from(s.nodeLookup.values()).filter((n) => n.selected), selectedEdges: s.edges.filter((e) => e.selected), }); diff --git a/packages/react/src/container/Pane/index.tsx b/packages/react/src/container/Pane/index.tsx index dfb240d0..ad2b01ed 100644 --- a/packages/react/src/container/Pane/index.tsx +++ b/packages/react/src/container/Pane/index.tsx @@ -128,7 +128,7 @@ export function Pane({ }; const onMouseMove = (event: ReactMouseEvent): void => { - const { userSelectionRect, edges, transform, nodeOrigin, nodes, triggerNodeChanges, triggerEdgeChanges } = + const { userSelectionRect, edgeLookup, transform, nodeOrigin, nodeLookup, triggerNodeChanges, triggerEdgeChanges } = store.getState(); if (!isSelecting || !containerBounds.current || !userSelectionRect) { return; @@ -149,7 +149,7 @@ export function Pane({ }; const selectedNodes = getNodesInside( - nodes, + nodeLookup, nextUserSelectRect, transform, selectionMode === SelectionMode.Partial, @@ -163,22 +163,22 @@ export function Pane({ for (const selectedNode of selectedNodes) { selectedNodeIds.add(selectedNode.id); - for (const edge of edges) { + for (const [edgeId, edge] of edgeLookup) { if (edge.source === selectedNode.id || edge.target === selectedNode.id) { - selectedEdgeIds.add(edge.id); + selectedEdgeIds.add(edgeId); } } } if (prevSelectedNodesCount.current !== selectedNodeIds.size) { prevSelectedNodesCount.current = selectedNodeIds.size; - const changes = getSelectionChanges(nodes, selectedNodeIds, true) as NodeChange[]; + const changes = getSelectionChanges(nodeLookup, selectedNodeIds, true) as NodeChange[]; triggerNodeChanges(changes); } if (prevSelectedEdgesCount.current !== selectedEdgeIds.size) { prevSelectedEdgesCount.current = selectedEdgeIds.size; - const changes = getSelectionChanges(edges, selectedEdgeIds) as EdgeChange[]; + const changes = getSelectionChanges(edgeLookup, selectedEdgeIds) as EdgeChange[]; triggerEdgeChanges(changes); } diff --git a/packages/react/src/hooks/useMoveSelectedNodes.ts b/packages/react/src/hooks/useMoveSelectedNodes.ts index c627628a..d189642b 100644 --- a/packages/react/src/hooks/useMoveSelectedNodes.ts +++ b/packages/react/src/hooks/useMoveSelectedNodes.ts @@ -1,7 +1,7 @@ import { useCallback } from 'react'; import { calculateNodePosition, snapPosition, type XYPosition } from '@xyflow/system'; -import { Node } from '../types'; +import { type Node } from '../types'; import { useStoreApi } from './useStore'; const selectedAndDraggable = (nodesDraggable: boolean) => (n: Node) => @@ -17,18 +17,11 @@ export function useMoveSelectedNodes() { const store = useStoreApi(); const moveSelectedNodes = useCallback((params: { direction: XYPosition; factor: number }) => { - const { - nodeExtent, - nodes, - snapToGrid, - snapGrid, - nodesDraggable, - onError, - updateNodePositions, - nodeLookup, - nodeOrigin, - } = store.getState(); - const selectedNodes = nodes.filter(selectedAndDraggable(nodesDraggable)); + const { nodeExtent, snapToGrid, snapGrid, nodesDraggable, onError, updateNodePositions, nodeLookup, nodeOrigin } = + store.getState(); + const nodeUpdates = []; + const isSelected = selectedAndDraggable(nodesDraggable); + // by default a node moves 5px on each key press // if snap grid is enabled, we use that for the velocity const xVelo = snapToGrid ? snapGrid[0] : 5; @@ -37,32 +30,34 @@ export function useMoveSelectedNodes() { const xDiff = params.direction.x * xVelo * params.factor; const yDiff = params.direction.y * yVelo * params.factor; - const nodeUpdates = selectedNodes.map((node) => { - if (node.computed?.positionAbsolute) { - let nextPosition = { - x: node.computed.positionAbsolute.x + xDiff, - y: node.computed.positionAbsolute.y + yDiff, - }; - - if (snapToGrid) { - nextPosition = snapPosition(nextPosition, snapGrid); - } - - const { position, positionAbsolute } = calculateNodePosition({ - nodeId: node.id, - nextPosition, - nodeLookup, - nodeExtent, - nodeOrigin, - onError, - }); - - node.position = position; - node.computed.positionAbsolute = positionAbsolute; + for (const [, node] of nodeLookup) { + if (!isSelected(node)) { + continue; } - return node; - }); + let nextPosition = { + x: node.internals.positionAbsolute.x + xDiff, + y: node.internals.positionAbsolute.y + yDiff, + }; + + if (snapToGrid) { + nextPosition = snapPosition(nextPosition, snapGrid); + } + + const { position, positionAbsolute } = calculateNodePosition({ + nodeId: node.id, + nextPosition, + nodeLookup, + nodeExtent, + nodeOrigin, + onError, + }); + + node.position = position; + node.internals.positionAbsolute = positionAbsolute; + + nodeUpdates.push(node); + } updateNodePositions(nodeUpdates); }, []); diff --git a/packages/react/src/hooks/useNodesInitialized.ts b/packages/react/src/hooks/useNodesInitialized.ts index 3a278f6c..346e56d9 100644 --- a/packages/react/src/hooks/useNodesInitialized.ts +++ b/packages/react/src/hooks/useNodesInitialized.ts @@ -1,5 +1,3 @@ -import { internalsSymbol } from '@xyflow/system'; - import { useStore } from './useStore'; import type { ReactFlowState } from '../types'; @@ -8,13 +6,13 @@ export type UseNodesInitializedOptions = { }; const selector = (options: UseNodesInitializedOptions) => (s: ReactFlowState) => { - if (s.nodes.length === 0) { + if (s.nodeLookup.size === 0) { return false; } - for (const node of s.nodes) { + for (const [, node] of s.nodeLookup) { if (options.includeHiddenNodes || !node.hidden) { - if (node[internalsSymbol]?.handleBounds === undefined) { + if (node.internals.handleBounds === undefined) { return false; } } diff --git a/packages/react/src/hooks/useReactFlow.ts b/packages/react/src/hooks/useReactFlow.ts index 5c10ad6a..4e83448a 100644 --- a/packages/react/src/hooks/useReactFlow.ts +++ b/packages/react/src/hooks/useReactFlow.ts @@ -32,7 +32,7 @@ export function useReactFlow>((id) => { - return store.getState().nodeLookup.get(id) as NodeType; + return store.getState().nodeLookup.get(id)?.internals.userProvidedNode as NodeType; }, []); const getEdges = useCallback>(() => { @@ -227,7 +227,7 @@ export function useReactFlow { - if (!isRect && (n.id === nodeOrRect!.id || !n.computed?.positionAbsolute)) { + const internalNode = store.getState().nodeLookup.get(n.id); + + if (internalNode && !isRect && (n.id === nodeOrRect!.id || !internalNode.internals.positionAbsolute)) { return false; } diff --git a/packages/react/src/index.ts b/packages/react/src/index.ts index 022f2626..800ebd94 100644 --- a/packages/react/src/index.ts +++ b/packages/react/src/index.ts @@ -103,5 +103,4 @@ export { addEdge, updateEdge, getConnectedEdges, - internalsSymbol, } from '@xyflow/system'; diff --git a/packages/react/src/store/index.ts b/packages/react/src/store/index.ts index a2b98c1a..3eddf5bc 100644 --- a/packages/react/src/store/index.ts +++ b/packages/react/src/store/index.ts @@ -52,9 +52,9 @@ const createRFStore = ({ // // When this happens, we take the note objects passed by the user and extend them with fields // relevant for internal React Flow operations. - const nodesWithInternalData = adoptUserProvidedNodes(nodes, nodeLookup, { nodeOrigin, elevateNodesOnSelect }); + adoptUserProvidedNodes(nodes, nodeLookup, { nodeOrigin, elevateNodesOnSelect }); - set({ nodes: nodesWithInternalData }); + set({ nodes }); }, setEdges: (edges: Edge[]) => { const { connectionLookup, edgeLookup } = get(); @@ -80,9 +80,9 @@ const createRFStore = ({ // new dimensions and update the nodes. updateNodeDimensions: (updates) => { const { + nodes, onNodesChange, fitView, - nodes, nodeLookup, fitViewOnInit, fitViewDone, @@ -95,7 +95,6 @@ const createRFStore = ({ const updatedNodes = updateNodeDimensionsSystem( updates, - nodes, nodeLookup, domNode, nodeOrigin, @@ -112,14 +111,14 @@ const createRFStore = ({ return; } - const nextNodes = updateAbsolutePositions(updatedNodes, nodeLookup, nodeOrigin); + updateAbsolutePositions(nodeLookup, nodeOrigin); // we call fitView once initially after all dimensions are set let nextFitViewDone = fitViewDone; if (!fitViewDone && fitViewOnInit) { - nextFitViewDone = fitView(nextNodes, { + nextFitViewDone = fitView({ ...fitViewOnInitOptions, - nodes: fitViewOnInitOptions?.nodes || nextNodes, + nodes: fitViewOnInitOptions?.nodes || nodes, }); } @@ -128,7 +127,7 @@ const createRFStore = ({ // has not provided an onNodesChange handler. // Nodes are only rendered if they have a width and height // attribute which they get from this handler. - set({ nodes: nextNodes, fitViewDone: nextFitViewDone }); + set({ nodes, fitViewDone: nextFitViewDone }); if (changes?.length > 0) { if (debug) { @@ -143,7 +142,6 @@ const createRFStore = ({ id: node.id, type: 'position', position: node.position, - positionAbsolute: node.computed?.positionAbsolute, dragging, }; @@ -185,7 +183,7 @@ const createRFStore = ({ } }, addSelectedNodes: (selectedNodeIds) => { - const { multiSelectionActive, edges, nodes, triggerNodeChanges, triggerEdgeChanges } = get(); + const { multiSelectionActive, edgeLookup, nodeLookup, triggerNodeChanges, triggerEdgeChanges } = get(); if (multiSelectionActive) { const nodeChanges = selectedNodeIds.map((nodeId) => createSelectionChange(nodeId, true)); @@ -193,11 +191,11 @@ const createRFStore = ({ return; } - triggerNodeChanges(getSelectionChanges(nodes, new Set([...selectedNodeIds]), true)); - triggerEdgeChanges(getSelectionChanges(edges)); + triggerNodeChanges(getSelectionChanges(nodeLookup, new Set([...selectedNodeIds]), true)); + triggerEdgeChanges(getSelectionChanges(edgeLookup)); }, addSelectedEdges: (selectedEdgeIds) => { - const { multiSelectionActive, edges, nodes, triggerNodeChanges, triggerEdgeChanges } = get(); + const { multiSelectionActive, edgeLookup, nodeLookup, triggerNodeChanges, triggerEdgeChanges } = get(); if (multiSelectionActive) { const changedEdges = selectedEdgeIds.map((edgeId) => createSelectionChange(edgeId, true)); @@ -205,8 +203,8 @@ const createRFStore = ({ return; } - triggerEdgeChanges(getSelectionChanges(edges, new Set([...selectedEdgeIds]))); - triggerNodeChanges(getSelectionChanges(nodes, new Set(), true)); + triggerEdgeChanges(getSelectionChanges(edgeLookup, new Set([...selectedEdgeIds]))); + triggerNodeChanges(getSelectionChanges(nodeLookup, new Set(), true)); }, unselectNodesAndEdges: ({ nodes, edges }: UnselectNodesAndEdgesParams = {}) => { const { edges: storeEdges, nodes: storeNodes, triggerNodeChanges, triggerEdgeChanges } = get(); @@ -276,8 +274,8 @@ const createRFStore = ({ const { transform, width, height, panZoom, translateExtent } = get(); return panBySystem({ delta, panZoom, transform, translateExtent, width, height }); }, - fitView: (nodes: Node[], options?: FitViewOptions): boolean => { - const { panZoom, width, height, minZoom, maxZoom, nodeOrigin } = get(); + fitView: (options?: FitViewOptions): boolean => { + const { panZoom, width, height, minZoom, maxZoom, nodeOrigin, nodeLookup } = get(); if (!panZoom) { return false; @@ -285,7 +283,7 @@ const createRFStore = ({ return fitViewSystem( { - nodes, + nodeLookup, width, height, panZoom, diff --git a/packages/react/src/store/initialState.ts b/packages/react/src/store/initialState.ts index 0cf3c7f0..9f373719 100644 --- a/packages/react/src/store/initialState.ts +++ b/packages/react/src/store/initialState.ts @@ -35,7 +35,7 @@ const getInitialState = ({ const storeNodes = defaultNodes ?? nodes ?? []; updateConnectionLookup(connectionLookup, edgeLookup, storeEdges); - const nextNodes = adoptUserProvidedNodes(storeNodes, nodeLookup, { + adoptUserProvidedNodes(storeNodes, nodeLookup, { nodeOrigin: [0, 0], elevateNodesOnSelect: false, }); @@ -43,7 +43,7 @@ const getInitialState = ({ let transform: Transform = [0, 0, 1]; if (fitView && width && height) { - const nodesWithDimensions = nextNodes.filter( + const nodesWithDimensions = storeNodes.filter( (node) => (node.width || node.initialWidth) && (node.height || node.initialHeight) ); // @todo users nodeOrigin should be used here @@ -57,7 +57,7 @@ const getInitialState = ({ width: 0, height: 0, transform, - nodes: nextNodes, + nodes: storeNodes, nodeLookup, edges: storeEdges, edgeLookup, diff --git a/packages/react/src/types/nodes.ts b/packages/react/src/types/nodes.ts index 52f5a321..89fec455 100644 --- a/packages/react/src/types/nodes.ts +++ b/packages/react/src/types/nodes.ts @@ -1,5 +1,12 @@ import type { CSSProperties, MouseEvent as ReactMouseEvent } from 'react'; -import type { CoordinateExtent, NodeBase, NodeOrigin, OnError, NodeProps as NodePropsBase } from '@xyflow/system'; +import type { + CoordinateExtent, + NodeBase, + NodeOrigin, + OnError, + NodeProps as NodePropsBase, + InternalNodeBase, +} from '@xyflow/system'; import { NodeTypes } from './general'; @@ -17,6 +24,8 @@ export type Node< focusable?: boolean; }; +export type InternalNode = InternalNodeBase; + export type NodeMouseHandler = (event: ReactMouseEvent, node: NodeType) => void; export type SelectionDragHandler = (event: ReactMouseEvent, nodes: NodeType[]) => void; export type OnNodeDrag = ( diff --git a/packages/react/src/types/store.ts b/packages/react/src/types/store.ts index 6c1cf9b0..eed7b9a3 100644 --- a/packages/react/src/types/store.ts +++ b/packages/react/src/types/store.ts @@ -44,6 +44,7 @@ import type { OnBeforeDelete, IsValidConnection, EdgeChange, + InternalNode, } from '.'; export type ReactFlowStore = { @@ -52,7 +53,7 @@ export type ReactFlowStore; + nodeLookup: NodeLookup>; edges: Edge[]; edgeLookup: EdgeLookup; connectionLookup: ConnectionLookup; @@ -169,7 +170,7 @@ export type ReactFlowActions = { triggerNodeChanges: (changes: NodeChange[]) => void; triggerEdgeChanges: (changes: EdgeChange[]) => void; panBy: PanBy; - fitView: (nodes: NodeType[], options?: FitViewOptions) => boolean; + fitView: (options?: FitViewOptions) => boolean; }; export type ReactFlowState = ReactFlowStore< diff --git a/packages/react/src/utils/changes.ts b/packages/react/src/utils/changes.ts index fa6f6f30..437c80dc 100644 --- a/packages/react/src/utils/changes.ts +++ b/packages/react/src/utils/changes.ts @@ -1,6 +1,14 @@ /* eslint-disable @typescript-eslint/no-explicit-any */ import { EdgeLookup, NodeLookup } from '@xyflow/system'; -import type { Node, Edge, EdgeChange, NodeChange, NodeSelectionChange, EdgeSelectionChange } from '../types'; +import type { + Node, + Edge, + EdgeChange, + NodeChange, + NodeSelectionChange, + EdgeSelectionChange, + InternalNode, +} from '../types'; export function handleParentExpand(updatedElements: any[], updateItem: any) { for (const [index, item] of updatedElements.entries()) { @@ -125,11 +133,6 @@ function applyChange(change: any, element: any, elements: any[] = []): any { element.position = change.position; } - if (typeof change.positionAbsolute !== 'undefined') { - element.computed ??= {}; - element.computed.positionAbsolute = change.positionAbsolute; - } - if (typeof change.dragging !== 'undefined') { element.dragging = change.dragging; } @@ -228,13 +231,13 @@ export function createSelectionChange(id: string, selected: boolean): NodeSelect } export function getSelectionChanges( - items: any[], + items: Map, selectedIds: Set = new Set(), mutateItem = false ): NodeSelectionChange[] | EdgeSelectionChange[] { const changes: NodeSelectionChange[] | EdgeSelectionChange[] = []; - for (const item of items) { + for (const [, item] of items) { const willBeSelected = selectedIds.has(item.id); // we don't want to set all items to selected=false on the first selection @@ -266,7 +269,7 @@ export function getElementsDiffChanges({ lookup, }: { items: Node[] | undefined; - lookup: NodeLookup; + lookup: NodeLookup>; }): NodeChange[]; export function getElementsDiffChanges({ items, diff --git a/packages/system/src/constants.ts b/packages/system/src/constants.ts index 21d21234..67b913a0 100644 --- a/packages/system/src/constants.ts +++ b/packages/system/src/constants.ts @@ -25,8 +25,6 @@ export const errorMessages = { `Node with id "${id}" does not exist, it may have been removed. This can happen when a node is deleted before the "onNodeClick" handler is called.`, }; -export const internalsSymbol = Symbol.for('internals'); - export const infiniteExtent: CoordinateExtent = [ [Number.NEGATIVE_INFINITY, Number.NEGATIVE_INFINITY], [Number.POSITIVE_INFINITY, Number.POSITIVE_INFINITY], diff --git a/packages/system/src/types/general.ts b/packages/system/src/types/general.ts index b7aa248e..a7c6665b 100644 --- a/packages/system/src/types/general.ts +++ b/packages/system/src/types/general.ts @@ -2,7 +2,7 @@ import type { D3DragEvent, Selection as D3Selection, SubjectPosition, ZoomBehavior } from 'd3'; import type { XYPosition, Rect } from './utils'; -import type { NodeBase, NodeDragItem, NodeOrigin } from './nodes'; +import type { InternalNodeBase, NodeBase, NodeDragItem, NodeOrigin } from './nodes'; import type { ConnectingHandle, HandleType } from './handles'; import { PanZoomInstance } from './panzoom'; import { EdgeBase } from '..'; @@ -52,7 +52,7 @@ export type OnConnectEnd = (event: MouseEvent | TouchEvent) => void; export type IsValidConnection = (edge: EdgeBase | Connection) => boolean; export type FitViewParamsBase = { - nodes: NodeType[]; + nodeLookup: Map>; width: number; height: number; panZoom: PanZoomInstance; diff --git a/packages/system/src/types/nodes.ts b/packages/system/src/types/nodes.ts index c888d8a4..6929321b 100644 --- a/packages/system/src/types/nodes.ts +++ b/packages/system/src/types/nodes.ts @@ -1,4 +1,3 @@ -import { internalsSymbol } from '../constants'; import type { XYPosition, Position, CoordinateExtent, HandleElement } from '.'; import { Optional } from '../utils/types'; @@ -63,18 +62,25 @@ export type NodeBase< computed?: { width?: number; height?: number; - positionAbsolute?: XYPosition; }; +}; +export type InternalNodeBase = NodeType & { + computed: { + width?: number; + height?: number; + }; // Only used internally - [internalsSymbol]?: { - z?: number; - handleBounds?: NodeHandleBounds; - isParent?: boolean; + internals: { + positionAbsolute: XYPosition; + z: number; + // @todo should we rename this to "handles" and use same type as node.handles? + isParent: boolean; /** Holds a reference to the original node object provided by the user * (which may lack some fields, like `computed` or `[internalSymbol]`. Used * as an optimization to avoid certain operations. */ - userProvidedNode: NodeBase; + userProvidedNode: NodeType; + handleBounds?: NodeHandleBounds; }; }; @@ -120,6 +126,8 @@ export type NodeDragItem = { computed: { width: number | null; height: number | null; + }; + internals: { positionAbsolute: XYPosition; }; extent?: 'parent' | CoordinateExtent; @@ -137,4 +145,4 @@ export type NodeHandle = Optional; export type Align = 'center' | 'start' | 'end'; -export type NodeLookup = Map; +export type NodeLookup = Map; diff --git a/packages/system/src/utils/edges/general.ts b/packages/system/src/utils/edges/general.ts index f53db23a..9e54e035 100644 --- a/packages/system/src/utils/edges/general.ts +++ b/packages/system/src/utils/edges/general.ts @@ -1,5 +1,4 @@ -import { Connection, Transform, errorMessages, internalsSymbol, isEdgeBase } from '../..'; -import { EdgeBase, NodeBase } from '../../types'; +import { Connection, InternalNodeBase, Transform, errorMessages, isEdgeBase, EdgeBase } from '../..'; import { getOverlappingArea, boxToRect, nodeToBox, getBoundsOfBoxes, devWarn } from '../general'; // this is used for straight edges and simple smoothstep edges (LTR, RTL, BTT, TTB) @@ -24,8 +23,8 @@ export function getEdgeCenter({ } export type GetEdgeZIndexParams = { - sourceNode: NodeBase; - targetNode: NodeBase; + sourceNode: InternalNodeBase; + targetNode: InternalNodeBase; selected?: boolean; zIndex?: number; elevateOnSelect?: boolean; @@ -43,14 +42,14 @@ export function getElevatedEdgeZIndex({ } const edgeOrConnectedNodeSelected = selected || targetNode.selected || sourceNode.selected; - const selectedZIndex = Math.max(sourceNode[internalsSymbol]?.z || 0, targetNode[internalsSymbol]?.z || 0, 1000); + const selectedZIndex = Math.max(sourceNode.internals.z || 0, targetNode.internals.z || 0, 1000); return zIndex + (edgeOrConnectedNodeSelected ? selectedZIndex : 0); } type IsEdgeVisibleParams = { - sourceNode: NodeBase; - targetNode: NodeBase; + sourceNode: InternalNodeBase; + targetNode: InternalNodeBase; width: number; height: number; transform: Transform; diff --git a/packages/system/src/utils/edges/positions.ts b/packages/system/src/utils/edges/positions.ts index 55a157ea..33fa59ee 100644 --- a/packages/system/src/utils/edges/positions.ts +++ b/packages/system/src/utils/edges/positions.ts @@ -1,25 +1,26 @@ import { EdgePosition } from '../../types/edges'; import { ConnectionMode, OnError } from '../../types/general'; -import { NodeBase, NodeHandle } from '../../types/nodes'; +import { InternalNodeBase, NodeHandle } from '../../types/nodes'; import { Position } from '../../types/utils'; -import { errorMessages, internalsSymbol } from '../../constants'; +import { errorMessages } from '../../constants'; import { HandleElement } from '../../types'; import { getNodeDimensions } from '../general'; export type GetEdgePositionParams = { id: string; - sourceNode: NodeBase; + sourceNode: InternalNodeBase; sourceHandle: string | null; - targetNode: NodeBase; + targetNode: InternalNodeBase; targetHandle: string | null; connectionMode: ConnectionMode; onError?: OnError; }; -function isNodeInitialized(node: NodeBase): boolean { +function isNodeInitialized(node: InternalNodeBase): boolean { return ( - !!(node?.[internalsSymbol]?.handleBounds || node?.handles?.length) && - !!(node?.computed?.width || node?.width || node?.initialWidth) + node && + !!(node.internals.handleBounds || node.handles?.length) && + !!(node.computed.width || node.width || node.initialWidth) ); } @@ -30,8 +31,8 @@ export function getEdgePosition(params: GetEdgePositionParams): EdgePosition | n return null; } - const sourceHandleBounds = sourceNode[internalsSymbol]?.handleBounds || toHandleBounds(sourceNode.handles); - const targetHandleBounds = targetNode[internalsSymbol]?.handleBounds || toHandleBounds(targetNode.handles); + const sourceHandleBounds = sourceNode.internals.handleBounds || toHandleBounds(sourceNode.handles); + const targetHandleBounds = targetNode.internals.handleBounds || toHandleBounds(targetNode.handles); const sourceHandle = getHandle(sourceHandleBounds?.source ?? [], params.sourceHandle); const targetHandle = getHandle( @@ -95,9 +96,9 @@ function toHandleBounds(handles?: NodeHandle[]) { }; } -function getHandlePosition(position: Position, node: NodeBase, handle: HandleElement | null = null): number[] { - const x = (handle?.x ?? 0) + (node.computed?.positionAbsolute?.x ?? 0); - const y = (handle?.y ?? 0) + (node.computed?.positionAbsolute?.y ?? 0); +function getHandlePosition(position: Position, node: InternalNodeBase, handle: HandleElement | null = null): number[] { + const x = (handle?.x ?? 0) + (node.internals.positionAbsolute?.x ?? 0); + const y = (handle?.y ?? 0) + (node.internals.positionAbsolute?.y ?? 0); const { width, height } = handle ?? getNodeDimensions(node); switch (position) { diff --git a/packages/system/src/utils/general.ts b/packages/system/src/utils/general.ts index 3a07e927..5fab4f49 100644 --- a/packages/system/src/utils/general.ts +++ b/packages/system/src/utils/general.ts @@ -8,6 +8,7 @@ import type { NodeOrigin, SnapGrid, Transform, + InternalNodeBase, } from '../types'; import { type Viewport } from '../types'; import { getNodePositionWithOrigin } from './graph'; @@ -65,7 +66,7 @@ export const boxToRect = ({ x, y, x2, y2 }: Box): Rect => ({ height: y2 - y, }); -export const nodeToRect = (node: NodeBase, nodeOrigin: NodeOrigin = [0, 0]): Rect => { +export const nodeToRect = (node: InternalNodeBase, nodeOrigin: NodeOrigin = [0, 0]): Rect => { const { positionAbsolute } = getNodePositionWithOrigin(node, node.origin || nodeOrigin); return { @@ -75,7 +76,7 @@ export const nodeToRect = (node: NodeBase, nodeOrigin: NodeOrigin = [0, 0]): Rec }; }; -export const nodeToBox = (node: NodeBase, nodeOrigin: NodeOrigin = [0, 0]): Box => { +export const nodeToBox = (node: InternalNodeBase, nodeOrigin: NodeOrigin = [0, 0]): Box => { const { positionAbsolute } = getNodePositionWithOrigin(node, node.origin || nodeOrigin); return { diff --git a/packages/system/src/utils/graph.ts b/packages/system/src/utils/graph.ts index 06bf7f62..9df39893 100644 --- a/packages/system/src/utils/graph.ts +++ b/packages/system/src/utils/graph.ts @@ -24,6 +24,7 @@ import { OnError, OnBeforeDeleteBase, NodeLookup, + InternalNodeBase, } from '../types'; import { errorMessages } from '../constants'; @@ -47,6 +48,10 @@ export const isEdgeBase = (element: any): export const isNodeBase = (element: any): element is NodeType => 'id' in element && 'position' in element && !('source' in element) && !('target' in element); +export const isInternalNodeBase = ( + element: any +): element is NodeType => 'id' in element && 'computed' in element && !('source' in element) && !('target' in element); + /** * Pass in a node, and get connected nodes where edge.source === node.id * @public @@ -101,7 +106,7 @@ export const getIncomers = { if (!node) { @@ -128,12 +133,10 @@ export const getNodePositionWithOrigin = ( return { position, - positionAbsolute: node.computed?.positionAbsolute - ? { - x: node.computed.positionAbsolute.x - offsetX, - y: node.computed.positionAbsolute.y - offsetY, - } - : position, + positionAbsolute: { + x: node.internals.positionAbsolute.x - offsetX, + y: node.internals.positionAbsolute.y - offsetY, + }, }; }; @@ -151,6 +154,7 @@ export type GetNodesBoundsParams = { * @param params.useRelativePosition - Whether to use the relative or absolute node positions * @returns Bounding box enclosing all nodes */ +// @todo how to handle this if users do not have absolute positions? export const getNodesBounds = ( nodes: NodeBase[], params: GetNodesBoundsParams = { nodeOrigin: [0, 0], useRelativePosition: false } @@ -161,6 +165,7 @@ export const getNodesBounds = ( const box = nodes.reduce( (currBox, node) => { + // @ts-expect-error const nodePos = getNodePositionWithOrigin(node, node.origin || params.nodeOrigin); return getBoundsOfBoxes( currBox, @@ -176,8 +181,47 @@ export const getNodesBounds = ( return boxToRect(box); }; -export const getNodesInside = ( - nodes: NodeType[], +export type GetInternalNodesBoundsParams = { + nodeOrigin?: NodeOrigin; + useRelativePosition?: boolean; + filter?: (node: NodeBase) => boolean; +}; + +/** + * Determines a bounding box that contains all given nodes in an array + * @internal + */ +export const getInternalNodesBounds = ( + nodeLookup: NodeLookup, + params: GetInternalNodesBoundsParams = { + nodeOrigin: [0, 0], + useRelativePosition: false, + } +): Rect => { + if (nodeLookup.size === 0) { + return { x: 0, y: 0, width: 0, height: 0 }; + } + + let box = { x: Infinity, y: Infinity, x2: -Infinity, y2: -Infinity }; + + nodeLookup.forEach((node) => { + if (params.filter == undefined || params.filter(node)) { + const nodePos = getNodePositionWithOrigin(node, node.origin || params.nodeOrigin); + box = getBoundsOfBoxes( + box, + rectToBox({ + ...nodePos[params.useRelativePosition ? 'position' : 'positionAbsolute'], + ...getNodeDimensions(node), + }) + ); + } + }); + + return boxToRect(box); +}; + +export const getNodesInside = ( + nodeLookup: Map>, rect: Rect, [tx, ty, tScale]: Transform = [0, 0, 1], partially = false, @@ -191,13 +235,15 @@ export const getNodesInside = ( height: rect.height / tScale, }; - const visibleNodes = nodes.reduce((res, node) => { + const visibleNodes: NodeType[] = []; + + for (const [, node] of nodeLookup) { const { computed, selectable = true, hidden = false } = node; const width = computed?.width ?? node.width ?? node.initialWidth ?? null; const height = computed?.height ?? node.height ?? node.initialHeight ?? null; if ((excludeNonSelectableNodes && !selectable) || hidden) { - return res; + continue; } const overlappingArea = getOverlappingArea(paneRect, nodeToRect(node, nodeOrigin)); @@ -208,11 +254,9 @@ export const getNodesInside = ( const isVisible = notInitialized || partiallyVisible || overlappingArea >= area; if (isVisible || node.dragging) { - res.push(node); + visibleNodes.push(node); } - - return res; - }, []); + } return visibleNodes; }; @@ -236,17 +280,20 @@ export const getConnectedEdges = , Options extends FitViewOptionsBase>( - { nodes, width, height, panZoom, minZoom, maxZoom, nodeOrigin = [0, 0] }: Params, + { nodeLookup, width, height, panZoom, minZoom, maxZoom, nodeOrigin = [0, 0] }: Params, options?: Options ) { - const filteredNodes = nodes.filter((n) => { + const filteredNodes: InternalNodeBase[] = []; + + nodeLookup.forEach((n) => { const isVisible = n.computed?.width && n.computed?.height && (options?.includeHiddenNodes || !n.hidden); - if (options?.nodes?.length) { - return isVisible && options?.nodes.some((optionNode) => optionNode.id === n.id); + if ( + isVisible && + (!options?.nodes || (options?.nodes.length && options?.nodes.some((optionNode) => optionNode.id === n.id))) + ) { + filteredNodes.push(n); } - - return isVisible; }); if (filteredNodes.length > 0) { @@ -303,7 +350,7 @@ export function calculateNodePosition({ }: { nodeId: string; nextPosition: XYPosition; - nodeLookup: NodeLookup; + nodeLookup: NodeLookup>; nodeOrigin?: NodeOrigin; nodeExtent?: CoordinateExtent; onError?: OnError; @@ -313,16 +360,17 @@ export function calculateNodePosition({ const { x: parentX, y: parentY } = parentNode ? getNodePositionWithOrigin(parentNode, parentNode.origin || nodeOrigin).positionAbsolute : { x: 0, y: 0 }; + let currentExtent = clampNodeExtent(node, node.extent || nodeExtent); if (node.extent === 'parent' && !node.expandParent) { if (!parentNode) { onError?.('005', errorMessages['error005']()); } else { - const nodeWidth = node.computed?.width; - const nodeHeight = node.computed?.height; - const parentWidth = parentNode?.computed?.width; - const parentHeight = parentNode?.computed?.height; + const nodeWidth = node.computed.width; + const nodeHeight = node.computed.height; + const parentWidth = parentNode.computed.width; + const parentHeight = parentNode.computed.height; if (nodeWidth && nodeHeight && parentWidth && parentHeight) { const currNodeOrigin = node.origin || nodeOrigin; diff --git a/packages/system/src/utils/store.ts b/packages/system/src/utils/store.ts index c04c7e51..21d5f9cf 100644 --- a/packages/system/src/utils/store.ts +++ b/packages/system/src/utils/store.ts @@ -1,4 +1,3 @@ -import { internalsSymbol } from '../constants'; import { NodeBase, CoordinateExtent, @@ -12,54 +11,53 @@ import { ConnectionLookup, EdgeBase, EdgeLookup, + InternalNodeBase, } from '../types'; import { getDimensions, getHandleBounds } from './dom'; import { isNumeric } from './general'; import { getNodePositionWithOrigin } from './graph'; -type ParentNodes = Record; +type ParentNodes = Set; export function updateAbsolutePositions( - nodes: NodeType[], - nodeLookup: Map, + nodeLookup: Map>, nodeOrigin: NodeOrigin = [0, 0], parentNodes?: ParentNodes ) { - return nodes.map((node) => { + for (const [, node] of nodeLookup) { if (node.parentNode && !nodeLookup.has(node.parentNode)) { throw new Error(`Parent node ${node.parentNode} not found`); } - if (node.parentNode || parentNodes?.[node.id]) { + if (node.parentNode || parentNodes?.has(node.id)) { const parentNode = node.parentNode ? nodeLookup.get(node.parentNode) : null; const { x, y, z } = calculateXYZPosition( node, - nodes, nodeLookup, { ...node.position, - z: node[internalsSymbol]?.z ?? 0, + z: node.internals.z ?? 0, }, parentNode?.origin || nodeOrigin ); - const positionChanged = x !== node.computed?.positionAbsolute?.x || y !== node.computed?.positionAbsolute?.y; - node.computed!.positionAbsolute = positionChanged + const positionChanged = x !== node.internals.positionAbsolute?.x || y !== node.internals.positionAbsolute?.y; + node.internals.positionAbsolute = positionChanged ? { x, y, } - : node.computed?.positionAbsolute; + : node.internals.positionAbsolute; - node[internalsSymbol]!.z = z; + node.internals.z = z; - if (parentNodes?.[node.id]) { - node[internalsSymbol]!.isParent = true; + if (parentNodes?.has(node.id)) { + node.internals.isParent = true; } } - return node; - }); + nodeLookup.set(node.id, node); + } } type UpdateNodesOptions = { @@ -70,64 +68,55 @@ type UpdateNodesOptions = { export function adoptUserProvidedNodes( nodes: NodeType[], - nodeLookup: Map, + nodeLookup: Map>, options: UpdateNodesOptions = { nodeOrigin: [0, 0] as NodeOrigin, elevateNodesOnSelect: true, defaults: {}, } -): NodeType[] { +) { const tmpLookup = new Map(nodeLookup); nodeLookup.clear(); - const parentNodes: ParentNodes = {}; + const parentNodes: ParentNodes = new Set(); const selectedNodeZ: number = options?.elevateNodesOnSelect ? 1000 : 0; - const nextNodes = nodes.map((n) => { + nodes.forEach((n) => { const currentStoreNode = tmpLookup.get(n.id); - if (n === currentStoreNode?.[internalsSymbol]?.userProvidedNode) { + if (n.parentNode) { + parentNodes.add(n.parentNode); + } + if (n === currentStoreNode?.internals?.userProvidedNode) { nodeLookup.set(n.id, currentStoreNode); return currentStoreNode; } - const node: NodeType = { + const node: InternalNodeBase = { ...options.defaults, ...n, computed: { - positionAbsolute: n.position, width: n.computed?.width, height: n.computed?.height, }, - }; - const z = (isNumeric(n.zIndex) ? n.zIndex : 0) + (n.selected ? selectedNodeZ : 0); - const currInternals = n?.[internalsSymbol] || currentStoreNode?.[internalsSymbol]; - - if (node.parentNode) { - parentNodes[node.parentNode] = true; - } - - Object.defineProperty(node, internalsSymbol, { - enumerable: false, - value: { - handleBounds: currInternals?.handleBounds, - z, + internals: { + positionAbsolute: n.position, + handleBounds: currentStoreNode?.internals?.handleBounds, + z: (isNumeric(n.zIndex) ? n.zIndex : 0) + (n.selected ? selectedNodeZ : 0), userProvidedNode: n, + isParent: false, }, - }); + }; nodeLookup.set(node.id, node); - - return node; }); - const nodesWithPositions = updateAbsolutePositions(nextNodes, nodeLookup, options.nodeOrigin, parentNodes); - - return nodesWithPositions; + if (parentNodes.size > 0) { + updateAbsolutePositions(nodeLookup, options.nodeOrigin, parentNodes); + } } function calculateXYZPosition( node: NodeType, - nodes: NodeType[], - nodeLookup: Map, + nodeLookup: Map>, result: XYZPosition, nodeOrigin: NodeOrigin ): XYZPosition { @@ -140,12 +129,11 @@ function calculateXYZPosition( return calculateXYZPosition( parentNode, - nodes, nodeLookup, { x: (result.x ?? 0) + parentNodePosition.x, y: (result.y ?? 0) + parentNodePosition.y, - z: (parentNode[internalsSymbol]?.z ?? 0) > (result.z ?? 0) ? parentNode[internalsSymbol]?.z ?? 0 : result.z ?? 0, + z: (parentNode.internals.z ?? 0) > (result.z ?? 0) ? parentNode.internals.z ?? 0 : result.z ?? 0, }, parentNode.origin || nodeOrigin ); @@ -153,25 +141,25 @@ function calculateXYZPosition( export function updateNodeDimensions( updates: Map, - nodes: NodeType[], - nodeLookup: Map, + nodeLookup: Map>, domNode: HTMLElement | null, nodeOrigin?: NodeOrigin, onUpdate?: (id: string, dimensions: Dimensions) => void -): NodeType[] | null { +): { hasUpdate: boolean } { const viewportNode = domNode?.querySelector('.xyflow__viewport'); + let hasUpdate = false; if (!viewportNode) { - return null; + return { hasUpdate }; } const style = window.getComputedStyle(viewportNode); const { m22: zoom } = new window.DOMMatrixReadOnly(style.transform); - const nextNodes = nodes.map((node) => { - const update = updates.get(node.id); + updates.forEach((update) => { + const node = nodeLookup.get(update.id); - if (update) { + if (node) { const dimensions = getDimensions(update.nodeElement); const doUpdate = !!( dimensions.width && @@ -180,6 +168,7 @@ export function updateNodeDimensions( ); if (doUpdate) { + hasUpdate = true; onUpdate?.(node.id, dimensions); const newNode = { @@ -188,25 +177,20 @@ export function updateNodeDimensions( ...node.computed, ...dimensions, }, - [internalsSymbol]: { - ...node[internalsSymbol], + internals: { + ...node.internals, handleBounds: { source: getHandleBounds('.source', update.nodeElement, zoom, node.origin || nodeOrigin), target: getHandleBounds('.target', update.nodeElement, zoom, node.origin || nodeOrigin), }, }, }; - nodeLookup.set(node.id, newNode); - - return newNode; } } - - return node; }); - return nextNodes; + return { hasUpdate }; } export function panBy({ diff --git a/packages/system/src/xydrag/XYDrag.ts b/packages/system/src/xydrag/XYDrag.ts index cfed09f9..7d2fbaef 100644 --- a/packages/system/src/xydrag/XYDrag.ts +++ b/packages/system/src/xydrag/XYDrag.ts @@ -26,13 +26,14 @@ import type { OnSelectionDrag, UpdateNodePositions, Box, + InternalNodeBase, } from '../types'; export type OnDrag = (event: MouseEvent, dragItems: NodeDragItem[], node: NodeBase, nodes: NodeBase[]) => void; type StoreItems = { nodes: NodeBase[]; - nodeLookup: Map; + nodeLookup: Map; edges: EdgeBase[]; nodeExtent: CoordinateExtent; snapGrid: SnapGrid; @@ -130,19 +131,23 @@ export function XYDrag voi // if there is selection with multiple nodes and a node extent is set, we need to adjust the node extent for each node // based on its position so that the node stays at it's position relative to the selection. - const adjustedNodeExtent: CoordinateExtent = [ + let adjustedNodeExtent: CoordinateExtent = [ [nodeExtent[0][0], nodeExtent[0][1]], [nodeExtent[1][0], nodeExtent[1][1]], ]; if (dragItems.length > 1 && nodeExtent && !n.extent) { - adjustedNodeExtent[0][0] = n.computed.positionAbsolute.x - nodesBox.x + nodeExtent[0][0]; - adjustedNodeExtent[1][0] = - n.computed.positionAbsolute.x + (n.computed?.width ?? 0) - nodesBox.x2 + nodeExtent[1][0]; + const { positionAbsolute } = n.internals; + const x1 = positionAbsolute.x - nodesBox.x + nodeExtent[0][0]; + const x2 = positionAbsolute.x + (n.computed?.width ?? 0) - nodesBox.x2 + nodeExtent[1][0]; - adjustedNodeExtent[0][1] = n.computed.positionAbsolute.y - nodesBox.y + nodeExtent[0][1]; - adjustedNodeExtent[1][1] = - n.computed.positionAbsolute.y + (n.computed?.height ?? 0) - nodesBox.y2 + nodeExtent[1][1]; + const y1 = positionAbsolute.y - nodesBox.y + nodeExtent[0][1]; + const y2 = positionAbsolute.y + (n.computed?.height ?? 0) - nodesBox.y2 + nodeExtent[1][1]; + + adjustedNodeExtent = [ + [x1, y1], + [x2, y2], + ]; } const { position, positionAbsolute } = calculateNodePosition({ @@ -158,7 +163,7 @@ export function XYDrag voi hasChange = hasChange || n.position.x !== position.x || n.position.y !== position.y; n.position = position; - n.computed.positionAbsolute = positionAbsolute; + n.internals.positionAbsolute = positionAbsolute; return n; }); @@ -208,7 +213,6 @@ export function XYDrag voi function startDrag(event: UseDragEvent) { const { - nodes, nodeLookup, multiSelectionActive, nodesDraggable, @@ -236,7 +240,7 @@ export function XYDrag voi const pointerPos = getPointerPosition(event.sourceEvent, { transform, snapGrid, snapToGrid }); lastPos = pointerPos; - dragItems = getDragItems(nodes, nodesDraggable, pointerPos, nodeId); + dragItems = getDragItems(nodeLookup, nodesDraggable, pointerPos, nodeId); if (dragItems.length > 0 && (onDragStart || onNodeDragStart || (!nodeId && onSelectionDragStart))) { const [currentNode, currentNodes] = getEventHandlerParams({ diff --git a/packages/system/src/xydrag/utils.ts b/packages/system/src/xydrag/utils.ts index 15c9af68..e958cf64 100644 --- a/packages/system/src/xydrag/utils.ts +++ b/packages/system/src/xydrag/utils.ts @@ -1,15 +1,15 @@ -import { type NodeDragItem, type XYPosition, NodeBase } from '../types'; +import { type NodeDragItem, type XYPosition, InternalNodeBase, NodeBase, NodeLookup } from '../types'; export function wrapSelectionDragFunc(selectionFunc?: (event: MouseEvent, nodes: NodeBase[]) => void) { return (event: MouseEvent, _: NodeBase, nodes: NodeBase[]) => selectionFunc?.(event, nodes); } -export function isParentSelected(node: NodeType, nodes: NodeType[]): boolean { +export function isParentSelected(node: NodeType, nodeLookup: NodeLookup): boolean { if (!node.parentNode) { return false; } - const parentNode = nodes.find((node) => node.id === node.parentNode); + const parentNode = nodeLookup.get(node.parentNode); if (!parentNode) { return false; @@ -19,7 +19,7 @@ export function isParentSelected(node: NodeType, node return true; } - return isParentSelected(parentNode, nodes); + return isParentSelected(parentNode, nodeLookup); } export function hasSelector(target: Element, selector: string, domNode: Element): boolean { @@ -36,39 +36,43 @@ export function hasSelector(target: Element, selector: string, domNode: Element) // looks for all selected nodes and created a NodeDragItem for each of them export function getDragItems( - nodes: NodeType[], + nodeLookup: Map>, nodesDraggable: boolean, mousePos: XYPosition, nodeId?: string ): NodeDragItem[] { - return nodes - .filter( - (n) => - (n.selected || n.id === nodeId) && - (!n.parentNode || !isParentSelected(n, nodes)) && - (n.draggable || (nodesDraggable && typeof n.draggable === 'undefined')) - ) - .map((n) => ({ - id: n.id, - position: n.position || { x: 0, y: 0 }, - distance: { - x: mousePos.x - (n.computed?.positionAbsolute?.x ?? 0), - y: mousePos.y - (n.computed?.positionAbsolute?.y ?? 0), - }, - delta: { - x: 0, - y: 0, - }, - extent: n.extent, - parentNode: n.parentNode, - origin: n.origin, - expandParent: n.expandParent, - computed: { - positionAbsolute: n.computed?.positionAbsolute || { x: 0, y: 0 }, - width: n.computed?.width || 0, - height: n.computed?.height || 0, - }, - })); + const dragItems: NodeDragItem[] = []; + + for (const [id, node] of nodeLookup) { + if ( + (node.selected || node.id === nodeId) && + (!node.parentNode || !isParentSelected(node, nodeLookup)) && + (node.draggable || (nodesDraggable && typeof node.draggable === 'undefined')) + ) { + const internalNode = nodeLookup.get(id)!; + + dragItems.push({ + id: internalNode.id, + position: internalNode.position || { x: 0, y: 0 }, + distance: { + x: mousePos.x - (internalNode.internals.positionAbsolute?.x ?? 0), + y: mousePos.y - (internalNode.internals.positionAbsolute?.y ?? 0), + }, + extent: internalNode.extent, + parentNode: internalNode.parentNode, + origin: internalNode.origin, + expandParent: internalNode.expandParent, + internals: { + positionAbsolute: internalNode.internals.positionAbsolute || { x: 0, y: 0 }, + }, + computed: { + width: internalNode.computed.width || 0, + height: internalNode.computed.height || 0, + }, + }); + } + } + return dragItems; } // returns two params: @@ -91,7 +95,6 @@ export function getEventHandlerParams({ position: n.position, computed: { ...n.computed, - positionAbsolute: n.computed.positionAbsolute, }, }; }); diff --git a/packages/system/src/xyhandle/XYHandle.ts b/packages/system/src/xyhandle/XYHandle.ts index 638ec966..80b09e61 100644 --- a/packages/system/src/xyhandle/XYHandle.ts +++ b/packages/system/src/xyhandle/XYHandle.ts @@ -6,13 +6,13 @@ import { type HandleType, type Connection, type PanBy, - type NodeBase, type Transform, type ConnectingHandle, type OnConnectEnd, type UpdateConnection, type IsValidConnection, type ConnectionHandle, + NodeLookup, } from '../types'; import { getClosestHandle, getConnectionStatus, getHandleLookup, getHandleType } from './utils'; @@ -25,7 +25,7 @@ export type OnPointerDownParams = { handleId: string | null; nodeId: string; isTarget: boolean; - nodes: NodeBase[]; + nodeLookup: NodeLookup; lib: string; flowId: string | null; edgeUpdaterType?: HandleType; @@ -79,7 +79,7 @@ function onPointerDown( edgeUpdaterType, isTarget, domNode, - nodes, + nodeLookup, lib, autoPanOnConnect, flowId, @@ -116,7 +116,7 @@ function onPointerDown( let handleDomNode: Element | null = null; const handleLookup = getHandleLookup({ - nodes, + nodeLookup, nodeId, handleId, handleType, diff --git a/packages/system/src/xyhandle/utils.ts b/packages/system/src/xyhandle/utils.ts index 8c82f6e3..346ebe45 100644 --- a/packages/system/src/xyhandle/utils.ts +++ b/packages/system/src/xyhandle/utils.ts @@ -3,15 +3,15 @@ import { type HandleType, type NodeHandleBounds, type XYPosition, - type NodeBase, type ConnectionHandle, + InternalNodeBase, + NodeLookup, } from '../types'; -import { internalsSymbol } from '../constants'; // this functions collects all handles and adds an absolute position // so that we can later find the closest handle to the mouse position export function getHandles( - node: NodeBase, + node: InternalNodeBase, handleBounds: NodeHandleBounds, type: HandleType, currentHandle: string @@ -22,8 +22,8 @@ export function getHandles( id: h.id || null, type, nodeId: node.id, - x: (node.computed?.positionAbsolute?.x ?? 0) + h.x + h.width / 2, - y: (node.computed?.positionAbsolute?.y ?? 0) + h.y + h.height / 2, + x: (node.internals.positionAbsolute.x ?? 0) + h.x + h.width / 2, + y: (node.internals.positionAbsolute.y ?? 0) + h.y + h.height / 2, }); } return res; @@ -62,28 +62,30 @@ export function getClosestHandle( } type GetHandleLookupParams = { - nodes: NodeBase[]; + nodeLookup: NodeLookup; nodeId: string; handleId: string | null; handleType: string; }; -export function getHandleLookup({ nodes, nodeId, handleId, handleType }: GetHandleLookupParams) { - return nodes.reduce((res, node) => { - if (node[internalsSymbol]) { - const { handleBounds } = node[internalsSymbol]; - let sourceHandles: ConnectionHandle[] = []; - let targetHandles: ConnectionHandle[] = []; +export function getHandleLookup({ + nodeLookup, + nodeId, + handleId, + handleType, +}: GetHandleLookupParams): ConnectionHandle[] { + const connectionHandles: ConnectionHandle[] = []; - if (handleBounds) { - sourceHandles = getHandles(node, handleBounds, 'source', `${nodeId}-${handleId}-${handleType}`); - targetHandles = getHandles(node, handleBounds, 'target', `${nodeId}-${handleId}-${handleType}`); - } - - res.push(...sourceHandles, ...targetHandles); + for (const [, node] of nodeLookup) { + if (node.internals.handleBounds) { + const id = `${nodeId}-${handleId}-${handleType}`; + const sourceHandles = getHandles(node, node.internals.handleBounds, 'source', id); + const targetHandles = getHandles(node, node.internals.handleBounds, 'target', id); + connectionHandles.push(...sourceHandles, ...targetHandles); } - return res; - }, []); + } + + return connectionHandles; } export function getHandleType(