@eclipse-papyrus/papyrus-web-parent 2026.2.0

package/papyrus-web-components/src/nodes/package/PackageNodeConverter.ts

@@ -0,0 +1,243 @@
+/*****************************************************************************
+ * Copyright (c) 2023, 2026 CEA LIST, Obeo.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Obeo - Initial API and implementation
+ *****************************************************************************/
+import {
+  BorderNodePosition,
+  ConnectionHandle,
+  GQLDiagram,
+  GQLDiagramDescription,
+  GQLEdge,
+  GQLHandleLayoutData,
+  GQLNode,
+  GQLNodeDescription,
+  GQLNodeLayoutData,
+  GQLNodeStyle,
+  GQLViewModifier,
+  IConvertEngine,
+  INodeConverter,
+  NodeData,
+  convertHandles,
+  convertInsideLabel,
+  convertLineStyle,
+  convertOutsideLabels,
+  isListLayoutStrategy,
+  defaultHeight,
+  defaultWidth,
+} from '@eclipse-sirius/sirius-components-diagrams';
+import { Node, XYPosition } from '@xyflow/react';
+import { GQLPackageNodeStyle, PackageNodeData } from './PackageNode.types';
+
+const defaultPosition: XYPosition = { x: 0, y: 0 };
+
+const toPackageNode = (
+  gqlDiagram: GQLDiagram,
+  gqlNode: GQLNode<GQLPackageNodeStyle>,
+  gqlParentNode: GQLNode<GQLNodeStyle> | null,
+  nodeDescription: GQLNodeDescription,
+  isBorderNode: boolean,
+  gqlEdge: GQLEdge[]
+): Node<PackageNodeData> => {
+  const {
+    targetObjectId,
+    targetObjectLabel,
+    targetObjectKind,
+    descriptionId,
+    id,
+    insideLabel,
+    outsideLabels,
+    state,
+    pinned,
+    style,
+    labelEditable,
+    deletable,
+  } = gqlNode;
+
+  const handleLayoutData: GQLHandleLayoutData[] = gqlDiagram.layoutData.nodeLayoutData
+    .filter((nodeLayoutData) => nodeLayoutData.id === id)
+    .flatMap((nodeLayoutData) => nodeLayoutData.handleLayoutData);
+
+  const connectionHandles: ConnectionHandle[] = convertHandles(gqlNode.id, gqlEdge, handleLayoutData);
+  const gqlNodeLayoutData: GQLNodeLayoutData | undefined = gqlDiagram.layoutData.nodeLayoutData.find(
+    (nodeLayoutData) => nodeLayoutData.id === id
+  );
+  const isNew = gqlNodeLayoutData === undefined;
+  const resizedByUser = gqlNodeLayoutData?.resizedByUser ?? false;
+  const movedByUser = gqlNodeLayoutData?.movedByUser ?? false;
+
+  const data: PackageNodeData = {
+    targetObjectId,
+    targetObjectLabel,
+    targetObjectKind,
+    descriptionId,
+    style: {
+      display: 'flex',
+      background: style.background,
+      borderColor: style.borderColor,
+      borderWidth: style.borderSize,
+      borderStyle: convertLineStyle(style.borderStyle),
+    },
+    insideLabel: null,
+    outsideLabels: convertOutsideLabels(outsideLabels, gqlDiagram.layoutData.labelLayoutData),
+    faded: state === GQLViewModifier.Faded,
+    pinned,
+    isBorderNode: isBorderNode,
+    nodeDescription,
+    defaultWidth: gqlNode.defaultWidth,
+    defaultHeight: gqlNode.defaultHeight,
+    borderNodePosition: isBorderNode ? BorderNodePosition.EAST : null,
+    connectionHandles,
+    labelEditable,
+    isNew,
+    resizedByUser,
+    movedByUser,
+    isListChild: isListLayoutStrategy(gqlParentNode?.style.childrenLayoutStrategy),
+    isDraggedNode: false,
+    areChildNodesDraggable: isListLayoutStrategy(gqlNode.style.childrenLayoutStrategy)
+      ? gqlNode.style.childrenLayoutStrategy.areChildNodesDraggable
+      : true,
+    isDropNodeTarget: false,
+    isDropNodeCandidate: false,
+    isHovered: false,
+    connectionLinePositionOnNode: 'none',
+    nodeAppearanceData: {
+      gqlStyle: style,
+      customizedStyleProperties: [],
+    },
+    growableNodeIds: isListLayoutStrategy(gqlNode?.style.childrenLayoutStrategy)
+      ? gqlNode?.style.childrenLayoutStrategy.growableNodeIds
+      : [],
+    minComputedWidth: gqlNodeLayoutData?.minComputedSize.width ?? null,
+    minComputedHeight: gqlNodeLayoutData?.minComputedSize.height ?? null,
+    deletable,
+    isLastNodeSelected: false,
+  };
+
+  data.insideLabel = convertInsideLabel(
+    insideLabel,
+    data,
+    `${style.borderSize}px ${style.borderStyle} ${style.borderColor}`
+  );
+
+  if (data.insideLabel) {
+    data.insideLabel.isHeader = true;
+    data.insideLabel.headerPosition = 'TOP';
+  }
+
+  const node: Node<PackageNodeData> = {
+    id,
+    type: 'packageNode',
+    data,
+    position: defaultPosition,
+    hidden: gqlNode.state === GQLViewModifier.Hidden,
+  };
+
+  if (gqlParentNode) {
+    node.parentId = gqlParentNode.id;
+  }
+
+  const nodeLayoutData = gqlDiagram.layoutData.nodeLayoutData.filter((data) => data.id === id)[0];
+  if (nodeLayoutData) {
+    const {
+      position,
+      size: { height, width },
+    } = nodeLayoutData;
+    node.position = position;
+    node.height = height;
+    node.width = width;
+    node.style = {
+      ...node.style,
+      width: `${node.width}px`,
+      height: `${node.height}px`,
+    };
+  } else {
+    node.height = data.defaultHeight ?? defaultHeight;
+    node.width = data.defaultWidth ?? defaultWidth;
+  }
+  return node;
+};
+
+const adaptChildrenBorderNodes = (nodes: Node<NodeData>[], gqlChildrenNodes: GQLNode<GQLNodeStyle>[]): void => {
+  const visibleChildrenNodes = nodes
+    .filter(
+      (child) =>
+        gqlChildrenNodes.map((gqlChild) => gqlChild.id).find((gqlChildId) => gqlChildId === child.id) !== undefined
+    )
+    .filter((child) => !child.hidden);
+  visibleChildrenNodes.forEach((child, index) => {
+    // Hide children node borders to prevent a 'bold' aspect, except for the bottom one to mark the separation between child
+    child.data.style = {
+      ...child.data.style,
+      borderTopWidth: '1',
+      borderLeftWidth: '1',
+      borderRightWidth: '1',
+      borderBottomWidth: '1',
+    };
+
+    if (index === visibleChildrenNodes.length - 1) {
+      child.data.style = {
+        ...child.data.style,
+        borderBottomWidth: '1',
+      };
+    }
+  });
+};
+
+export class PackageNodeConverter implements INodeConverter {
+  canHandle(gqlNode: GQLNode<GQLNodeStyle>) {
+    return gqlNode.style.__typename === 'PackageNodeStyle' && gqlNode.style.childrenLayoutStrategy?.kind !== 'List';
+  }
+
+  handle(
+    convertEngine: IConvertEngine,
+    gqlDiagram: GQLDiagram,
+    gqlNode: GQLNode<GQLPackageNodeStyle>,
+    gqlEdges: GQLEdge[],
+    parentNode: GQLNode<GQLNodeStyle> | null,
+    isBorderNode: boolean,
+    nodes: Node<NodeData>[],
+    diagramDescription: GQLDiagramDescription,
+    nodeDescriptions: GQLNodeDescription[]
+  ) {
+    const nodeDescription = nodeDescriptions.find((description) => description.id === gqlNode.descriptionId);
+    if (nodeDescription) {
+      nodes.push(toPackageNode(gqlDiagram, gqlNode, parentNode, nodeDescription, isBorderNode, gqlEdges));
+    }
+
+    const borderNodeDescriptions: GQLNodeDescription[] = (nodeDescription?.borderNodeDescriptionIds ?? []).flatMap(
+      (nodeDescriptionId) =>
+        diagramDescription.nodeDescriptions.filter((nodeDescription) => nodeDescription.id === nodeDescriptionId)
+    );
+    const childNodeDescriptions: GQLNodeDescription[] = (nodeDescription?.childNodeDescriptionIds ?? []).flatMap(
+      (nodeDescriptionId) =>
+        diagramDescription.nodeDescriptions.filter((nodeDescription) => nodeDescription.id === nodeDescriptionId)
+    );
+
+    convertEngine.convertNodes(
+      gqlDiagram,
+      gqlNode.borderNodes ?? [],
+      gqlNode,
+      nodes,
+      diagramDescription,
+      borderNodeDescriptions
+    );
+    convertEngine.convertNodes(
+      gqlDiagram,
+      gqlNode.childNodes ?? [],
+      gqlNode,
+      nodes,
+      diagramDescription,
+      childNodeDescriptions
+    );
+    adaptChildrenBorderNodes(nodes, gqlNode.childNodes ?? []);
+  }
+}

package/papyrus-web-components/src/nodes/package/PackageNodeLayoutHandler.ts

@@ -0,0 +1,229 @@
+/*****************************************************************************
+ * Copyright (c) 2023, 2025 CEA LIST, Obeo.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License 2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *  Obeo - Initial API and implementation
+ *****************************************************************************/
+import {
+  computeNodesBox,
+  Diagram,
+  DiagramNodeType,
+  findNodeIndex,
+  getBorderNodeExtent,
+  getChildNodePosition,
+  getEastBorderNodeFootprintHeight,
+  getNorthBorderNodeFootprintWidth,
+  getSouthBorderNodeFootprintWidth,
+  getWestBorderNodeFootprintHeight,
+  ILayoutEngine,
+  INodeLayoutHandler,
+  NodeData,
+  setBorderNodesPosition,
+  computePreviousSize,
+  computePreviousPosition,
+  ForcedDimensions,
+  getHeaderHeightFootprint,
+} from '@eclipse-sirius/sirius-components-diagrams';
+import { Node } from '@xyflow/react';
+import { PackageNodeData } from './PackageNode.types';
+
+const rectangularNodePadding: number = 8;
+
+export class PackageNodeLayoutHandler implements INodeLayoutHandler<PackageNodeData> {
+  public canHandle(node: Node<NodeData, DiagramNodeType>) {
+    return node.type === 'packageNode';
+  }
+
+  public handle(
+    layoutEngine: ILayoutEngine,
+    previousDiagram: Diagram | null,
+    node: Node<PackageNodeData, 'packageNode'>,
+    visibleNodes: Node<NodeData, DiagramNodeType>[],
+    directChildren: Node<NodeData, DiagramNodeType>[],
+    newlyAddedNodes: Node<NodeData, DiagramNodeType>[],
+    forceWidth?: ForcedDimensions
+  ) {
+    const nodeIndex = findNodeIndex(visibleNodes, node.id);
+    const nodeElement = document.getElementById(`${node.id}-packageNode-${nodeIndex}`)?.children[0];
+    const borderWidth = nodeElement ? parseFloat(window.getComputedStyle(nodeElement).borderWidth) : 0;
+    if (directChildren.length > 0) {
+      this.handleParentNode(
+        layoutEngine,
+        previousDiagram,
+        node,
+        visibleNodes,
+        directChildren,
+        newlyAddedNodes,
+        borderWidth,
+        forceWidth
+      );
+    } else {
+      this.handleLeafNode(previousDiagram, node, visibleNodes, borderWidth, forceWidth);
+    }
+  }
+
+  private handleParentNode(
+    layoutEngine: ILayoutEngine,
+    previousDiagram: Diagram | null,
+    node: Node<PackageNodeData, 'packageNode'>,
+    visibleNodes: Node<NodeData, DiagramNodeType>[],
+    directChildren: Node<NodeData, DiagramNodeType>[],
+    newlyAddedNodes: Node<NodeData, DiagramNodeType>[],
+    borderWidth: number,
+    _forceWidth?: ForcedDimensions
+  ) {
+    layoutEngine.layoutNodes(previousDiagram, visibleNodes, directChildren, newlyAddedNodes);
+
+    const nodeIndex = findNodeIndex(visibleNodes, node.id);
+    const labelElement = document.getElementById(`${node.id}-label-${nodeIndex}`);
+    const headerHeightFootprint = getHeaderHeightFootprint(labelElement, node.data.insideLabel, 'TOP');
+
+    const borderNodes = directChildren.filter((node) => node.data.isBorderNode);
+    const directNodesChildren = directChildren.filter((child) => !child.data.isBorderNode);
+
+    // Update children position to be under the label and at the right padding.
+    directNodesChildren.forEach((child, index) => {
+      const previousNode = (previousDiagram?.nodes ?? []).find((previouseNode) => previouseNode.id === child.id);
+      const previousPosition = computePreviousPosition(previousNode, child);
+      const createdNode = newlyAddedNodes.find((node) => node?.id === child.id);
+
+      if (!!createdNode) {
+        child.position = createdNode.position;
+        if (child.position.y < borderWidth + headerHeightFootprint + rectangularNodePadding) {
+          child.position = { ...child.position, y: borderWidth + headerHeightFootprint + rectangularNodePadding };
+        }
+        if (child.position.x < 0) {
+          child.position = { ...child.position, x: rectangularNodePadding };
+        }
+      } else if (previousPosition) {
+        child.position = previousPosition;
+        if (child.position.y < headerHeightFootprint + rectangularNodePadding) {
+          child.position = { ...child.position, y: headerHeightFootprint + rectangularNodePadding };
+        }
+        // Force the position.x to rectangularNodePadding if the child is moved outside the west border.
+        if (child.position.x < 0) {
+          child.position = { ...child.position, x: rectangularNodePadding };
+        }
+      } else {
+        child.position = getChildNodePosition(visibleNodes, child, headerHeightFootprint, borderWidth);
+        const previousSibling = directNodesChildren[index - 1];
+        if (previousSibling) {
+          child.position = getChildNodePosition(
+            visibleNodes,
+            child,
+            headerHeightFootprint,
+            borderWidth,
+            previousSibling
+          );
+        }
+        if (child.position.y < headerHeightFootprint + rectangularNodePadding) {
+          child.position = { ...child.position, y: child.position.y + headerHeightFootprint };
+        }
+        // Force the position.x to rectangularNodePadding if the child is moved outside the west border.
+        if (child.position.x < 0) {
+          child.position = { ...child.position, x: rectangularNodePadding };
+        }
+      }
+    });
+
+    // Update node to layout size
+    // WARN: We suppose label are always on top of children (that wrong)
+    const childrenContentBox = computeNodesBox(visibleNodes, directNodesChildren); // WARN: The current content box algorithm does not take the margin of direct children (it should)
+    const directChildrenAwareNodeWidth = childrenContentBox.x + childrenContentBox.width + rectangularNodePadding;
+    const northBorderNodeFootprintWidth = getNorthBorderNodeFootprintWidth(visibleNodes, borderNodes, previousDiagram);
+    const southBorderNodeFootprintWidth = getSouthBorderNodeFootprintWidth(visibleNodes, borderNodes, previousDiagram);
+
+    const nodeWidth =
+      Math.max(
+        directChildrenAwareNodeWidth,
+        northBorderNodeFootprintWidth,
+        southBorderNodeFootprintWidth,
+        node.data.defaultWidth ? node.data.defaultWidth : 0
+      ) +
+      borderWidth * 2;
+
+    // WARN: the label is not used for the height because children are already position under the label
+    const directChildrenAwareNodeHeight = childrenContentBox.y + childrenContentBox.height + rectangularNodePadding;
+    const eastBorderNodeFootprintHeight = getEastBorderNodeFootprintHeight(visibleNodes, borderNodes, previousDiagram);
+    const westBorderNodeFootprintHeight = getWestBorderNodeFootprintHeight(visibleNodes, borderNodes, previousDiagram);
+
+    const nodeHeight =
+      Math.max(
+        directChildrenAwareNodeHeight,
+        eastBorderNodeFootprintHeight,
+        westBorderNodeFootprintHeight,
+        node.data.defaultHeight ? node.data.defaultHeight : 0
+      ) +
+      borderWidth * 2;
+
+    const minNodeWith = nodeWidth;
+    const minNodeheight = nodeHeight;
+
+    const previousNode = (previousDiagram?.nodes ?? []).find((previouseNode) => previouseNode.id === node.id);
+    const previousDimensions = computePreviousSize(previousNode, node);
+    if (node.data.nodeDescription?.userResizable) {
+      if (minNodeWith > previousDimensions.width) {
+        node.width = minNodeWith;
+      } else {
+        node.width = previousDimensions.width;
+      }
+      if (minNodeheight > previousDimensions.height) {
+        node.height = minNodeheight;
+      } else {
+        node.height = previousDimensions.height;
+      }
+    } else {
+      node.width = minNodeWith;
+      node.height = minNodeheight;
+    }
+
+    // Update border nodes positions
+    borderNodes.forEach((borderNode) => {
+      borderNode.extent = getBorderNodeExtent(node, borderNode);
+    });
+    setBorderNodesPosition(borderNodes, node, previousDiagram);
+  }
+
+  private handleLeafNode(
+    previousDiagram: Diagram | null,
+    node: Node<PackageNodeData, 'packageNode'>,
+    visibleNodes: Node<NodeData, DiagramNodeType>[],
+    _borderWidth: number,
+    _forceWidth?: ForcedDimensions
+  ) {
+    const nodeIndex = findNodeIndex(visibleNodes, node.id);
+    const labelElement = document.getElementById(`${node.id}-label-${nodeIndex}`);
+
+    const labelHeight =
+      rectangularNodePadding + (labelElement?.getBoundingClientRect().height ?? 0) + rectangularNodePadding;
+
+    const minNodeWith = Math.max(node.data.defaultWidth ? node.data.defaultWidth : 0);
+    const minNodeheight = Math.max(labelHeight, node.data.defaultHeight ? node.data.defaultHeight : 0);
+
+    const previousNode = (previousDiagram?.nodes ?? []).find((previouseNode) => previouseNode.id === node.id);
+    const previousDimensions = computePreviousSize(previousNode, node);
+
+    if (node.data.resizedByUser) {
+      if (minNodeWith > previousDimensions.width) {
+        node.width = minNodeWith;
+      } else {
+        node.width = previousDimensions.width;
+      }
+      if (minNodeheight > previousDimensions.height) {
+        node.height = minNodeheight;
+      } else {
+        node.height = previousDimensions.height;
+      }
+    } else {
+      node.width = minNodeWith;
+      node.height = minNodeheight;
+    }
+  }
+}