[3981] Display the diagram palette tools and tool sections in a list

Bug: #3981
Signed-off-by: Florian Barbin <florian.barbin@obeo.fr>

Author: florianbarbin

CHANGELOG.adoc

@@ -81,6 +81,7 @@ never, always and if_children (to display the separator only if children exist).
 + Make possible to register view models in the loading editing context when the "test" profile is active.
 + To activate the test profile add the value _test_ to the `SPRING_PROFILES_ACTIVE` environment variable.
 - https://github.com/eclipse-sirius/sirius-web/issues/3882[#3882] [sirius-web] Add a new tree event to handle tree description which are not explorer-related
+- https://github.com/eclipse-sirius/sirius-web/issues/3981[#3981] [diagram] Update the design and capabilities of the contextual palette
 
 == v2024.9.0
 

package-lock.json

@@ -23,6 +23,7 @@
 import org.eclipse.emf.ecore.EObject;
 import org.eclipse.sirius.components.collaborative.diagrams.api.DiagramImageConstants;
 import org.eclipse.sirius.components.collaborative.diagrams.api.IPaletteProvider;
+import org.eclipse.sirius.components.collaborative.diagrams.dto.IPaletteEntry;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.ITool;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.Palette;
 import org.eclipse.sirius.components.collaborative.diagrams.dto.SingleClickOnDiagramElementTool;
@@ -95,7 +96,7 @@ public Palette handle(Object targetElement, Object diagramElement, Object diagra
                 .map(org.eclipse.sirius.diagram.description.DiagramDescription.class::cast)
                 .findFirst();
 
-        List<ToolSection> toolSections = new ArrayList<>();
+        List<IPaletteEntry> toolSections = new ArrayList<>();
         if (optionalSiriusDiagramDescription.isPresent()) {
             org.eclipse.sirius.diagram.description.DiagramDescription siriusDiagramDescription = optionalSiriusDiagramDescription.get();
             List<ToolSection> filteredToolSections = this.getToolSectionFromDiagramDescriptionToolSection(diagramDescription).stream()
@@ -107,7 +108,7 @@ public Palette handle(Object targetElement, Object diagramElement, Object diagra
             toolSections.addAll(this.createExtraToolSections(diagramElementDescription));
         }
         String paletteId = "siriusComponents://palette?diagramId=" + optionalVsmElementId.get();
-        return Palette.newPalette(paletteId).tools(List.of()).toolSections(toolSections).build();
+        return Palette.newPalette(paletteId).quickAccessTools(List.of()).paletteEntries(toolSections).build();
     }
 
     private List<ToolSection> getToolSectionFromDiagramDescriptionToolSection(DiagramDescription diagramDescription) {

packages/compatibility/backend/sirius-components-compatibility/src/main/java/org/eclipse/sirius/components/compatibility/services/diagrams/CompatibilityPaletteProvider.java

@@ -0,0 +1,22 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.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
+ *******************************************************************************/
+package org.eclipse.sirius.components.collaborative.diagrams.dto;
+
+/**
+ * The common interface for elements displayed in the palette.
+ * @author fbarbin
+ */
+public interface IPaletteEntry {
+
+    String id();
+}

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/IPaletteEntry.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023 Obeo.
+ * Copyright (c) 2023, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -19,9 +19,7 @@
  *
  * @author mcharfadi
  */
-public interface ITool {
-
-    String id();
+public interface ITool extends IPaletteEntry {
 
     String label();
 

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/ITool.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023 Obeo.
+ * Copyright (c) 2023, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -20,12 +20,12 @@
  *
  * @author frouene
  */
-public record Palette(String id, List<ITool> tools, List<ToolSection> toolSections) {
+public record Palette(String id, List<ITool> quickAccessTools, List<IPaletteEntry> paletteEntries) {
 
     public Palette {
         Objects.requireNonNull(id);
-        Objects.requireNonNull(tools);
-        Objects.requireNonNull(toolSections);
+        Objects.requireNonNull(quickAccessTools);
+        Objects.requireNonNull(paletteEntries);
     }
 
     public static Builder newPalette(String id) {
@@ -43,26 +43,26 @@ public static final class Builder {
 
         private final String id;
 
-        private List<ITool> tools;
+        private List<ITool> quickAccessTools;
 
-        private List<ToolSection> toolSections;
+        private List<IPaletteEntry> paletteEntries;
 
         private Builder(String id) {
             this.id = Objects.requireNonNull(id);
         }
 
-        public Builder tools(List<ITool> tools) {
-            this.tools = Objects.requireNonNull(tools);
+        public Builder quickAccessTools(List<ITool> quickAccessTools) {
+            this.quickAccessTools = Objects.requireNonNull(quickAccessTools);
             return this;
         }
 
-        public Builder toolSections(List<ToolSection> toolSections) {
-            this.toolSections = Objects.requireNonNull(toolSections);
+        public Builder paletteEntries(List<IPaletteEntry> paletteEntries) {
+            this.paletteEntries = Objects.requireNonNull(paletteEntries);
             return this;
         }
 
         public Palette build() {
-            return new Palette(this.id, this.tools, this.toolSections);
+            return new Palette(this.id, this.quickAccessTools, this.paletteEntries);
         }
     }
 

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/Palette.java

@@ -0,0 +1,26 @@
+/*******************************************************************************
+ * Copyright (c) 2024 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.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
+ *******************************************************************************/
+package org.eclipse.sirius.components.collaborative.diagrams.dto;
+
+import java.util.Objects;
+
+/**
+ * Represents a divider between tools or tool sections in the palette.
+ * @author fbarbin
+ */
+public record PaletteDivider(String id) implements IPaletteEntry {
+
+    public PaletteDivider {
+        Objects.requireNonNull(id);
+    }
+}

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/PaletteDivider.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2023 Obeo.
+ * Copyright (c) 2023, 2024 Obeo.
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v2.0
  * which accompanies this distribution, and is available at
@@ -20,7 +20,7 @@
  *
  * @author mcharfadi
  */
-public record ToolSection(String id, String label, List<String> iconURL, List<ITool> tools) {
+public record ToolSection(String id, String label, List<String> iconURL, List<ITool> tools) implements IPaletteEntry {
 
     public ToolSection {
         Objects.requireNonNull(id);

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/java/org/eclipse/sirius/components/collaborative/diagrams/dto/ToolSection.java

@@ -260,8 +260,18 @@ type Size {
 
 type Palette {
   id: ID!
-  tools: [Tool]!
-  toolSections: [ToolSection]!
+  quickAccessTools: [Tool]!
+  paletteEntries: [PaletteEntry]!
+}
+
+union PaletteEntry =
+    ToolSection
+  | SingleClickOnDiagramElementTool
+  | SingleClickOnTwoDiagramElementsTool
+  | PaletteDivider
+
+type PaletteDivider {
+  id: ID!
 }
 
 type ToolSection {

packages/diagrams/backend/sirius-components-collaborative-diagrams/src/main/resources/schema/diagram.graphqls

@@ -36,15 +36,18 @@ query getPalette($editingContextId: ID!, $representationId: ID!, $diagramElement
                       ... on DiagramDescription {
                         palette(diagramElementId: $diagramElementId) {
                           id
-                          tools {
+                          quickAccessTools {
                             ...ToolFields
                           }
-                          toolSections {
-                            id
-                            label
-                            iconURL
-                            tools {
-                              ...ToolFields
+                          paletteEntries {
+                            ...ToolFields
+                            ... on ToolSection {
+                              id
+                              label
+                              iconURL
+                              tools {
+                                ...ToolFields
+                              }
                             }
                           }
                         }

packages/diagrams/backend/sirius-components-diagrams-tests/src/main/java/org/eclipse/sirius/components/diagrams/tests/graphql/PaletteQueryRunner.java

@@ -57,7 +57,10 @@ export type { NodeContextValue } from './renderer/node/NodeContext.types';
 export { NodeTypeContribution } from './renderer/node/NodeTypeContribution';
 export type { DiagramNodeType } from './renderer/node/NodeTypes.types';
 export { DiagramElementPalette } from './renderer/palette/DiagramElementPalette';
-export type { DiagramPaletteToolContributionComponentProps } from './renderer/palette/DiagramPaletteToolContribution.types';
+export type {
+  DiagramPaletteToolContributionComponentProps,
+  DiagramPaletteToolContributionProps,
+} from './renderer/palette/DiagramPaletteToolContribution.types';
 export type { GQLToolVariable, GQLToolVariableType } from './renderer/palette/Palette.types';
 export type { DiagramPaletteToolComponentProps } from './renderer/palette/tool/DiagramPaletteTool.types';
 export { diagramPaletteToolExtensionPoint } from './renderer/palette/tool/DiagramPaletteToolExtensionPoints';

packages/diagrams/frontend/sirius-components-diagrams/src/index.ts

@@ -59,14 +59,24 @@ export interface GQLDiagramDescription extends GQLRepresentationDescription {
 
 export interface GQLPalette {
   id: string;
+  paletteEntries: GQLPaletteEntry[];
+}
+
+export interface GQLPaletteEntry {
+  id: string;
+  __typename: string;
+}
+export interface GQLPaletteDivider extends GQLPaletteEntry {}
+
+export interface GQLToolSection extends GQLPaletteEntry {
+  label: string;
+  iconURL: string[];
   tools: GQLTool[];
-  toolSections: GQLToolSection[];
 }
 
 export interface GQLToolSection {
   id: string;
   label: string;
-  imageURL: string;
   tools: GQLTool[];
   __typename: string;
 }