feat: handle item ordering.

https://gravitee.atlassian.net/browse/APIM-11696

Author: kovaren

gravitee-apim-rest-api/gravitee-apim-rest-api-automation/gravitee-apim-rest-api-automation-rest/src/test/java/io/gravitee/apim/rest/api/automation/spring/ResourceContextConfiguration.java

@@ -101,6 +101,7 @@
 import io.gravitee.apim.core.plugin.crud_service.PolicyPluginCrudService;
 import io.gravitee.apim.core.plugin.domain_service.EndpointConnectorPluginDomainService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
+import io.gravitee.apim.core.portal_page.use_case.CreatePortalNavigationItemUseCase;
 import io.gravitee.apim.core.portal_page.use_case.ListPortalNavigationItemsUseCase;
 import io.gravitee.apim.core.promotion.service_provider.CockpitPromotionServiceProvider;
 import io.gravitee.apim.core.promotion.use_case.CreatePromotionUseCase;
@@ -855,6 +856,11 @@ public CreatePromotionUseCase createPromotionUseCase() {
         return mock(CreatePromotionUseCase.class);
     }
 
+    @Bean
+    public CreatePortalNavigationItemUseCase createPortalNavigationItemUseCase() {
+        return mock(CreatePortalNavigationItemUseCase.class);
+    }
+
     @Bean
     public ListPortalNavigationItemsUseCase listPortalNavigationItemsUseCase() {
         return mock(ListPortalNavigationItemsUseCase.class);

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/main/java/io/gravitee/rest/api/management/v2/rest/mapper/PortalNavigationItemsMapper.java

@@ -38,25 +38,29 @@ default BasePortalNavigationItem map(io.gravitee.apim.core.portal_page.model.Por
         final var id = portalNavigationItem.getId().toString();
         final var title = portalNavigationItem.getTitle();
         final var area = BasePortalNavigationItem.AreaEnum.fromValue(portalNavigationItem.getArea().name());
+        final var order = portalNavigationItem.getOrder();
         final var parentId = mapParentId(portalNavigationItem.getParentId());
 
         return switch (portalNavigationItem) {
             case io.gravitee.apim.core.portal_page.model.PortalNavigationFolder ignored -> new PortalNavigationFolder()
                 .id(id)
                 .title(title)
                 .area(area)
+                .order(order)
                 .parentId(parentId);
             case io.gravitee.apim.core.portal_page.model.PortalNavigationPage page -> new PortalNavigationPage()
-                .contentId(page.getContentId().toString())
+                .contentId(page.getPortalPageContentId().toString())
                 .id(id)
                 .title(title)
                 .area(area)
+                .order(order)
                 .parentId(parentId);
             case io.gravitee.apim.core.portal_page.model.PortalNavigationLink link -> new PortalNavigationLink()
                 .url(link.getHref())
                 .id(id)
                 .title(title)
                 .area(area)
+                .order(order)
                 .parentId(parentId);
         };
     }
@@ -69,24 +73,24 @@ default io.gravitee.apim.core.portal_page.model.PortalNavigationItem map(
         final var id = PortalNavigationItemId.random();
         final var title = createPortalNavigationItem.getTitle();
         final var area = PortalArea.valueOf(createPortalNavigationItem.getArea().getValue());
-        final var parentId = mapParentId(createPortalNavigationItem.getParentId());
+        final var order = createPortalNavigationItem.getOrder() == null ? Integer.MAX_VALUE : createPortalNavigationItem.getOrder();
 
-        return switch (createPortalNavigationItem) {
+        final var item = switch (createPortalNavigationItem) {
             case CreatePortalNavigationFolder ignored -> new io.gravitee.apim.core.portal_page.model.PortalNavigationFolder(
                 id,
                 organizationId,
                 environmentId,
                 title,
                 area,
-                parentId
+                order
             );
             case CreatePortalNavigationPage page -> new io.gravitee.apim.core.portal_page.model.PortalNavigationPage(
                 id,
                 organizationId,
                 environmentId,
                 title,
                 area,
-                parentId,
+                order,
                 PortalPageContentId.of(page.getContentId())
             );
             case CreatePortalNavigationLink link -> new io.gravitee.apim.core.portal_page.model.PortalNavigationLink(
@@ -95,13 +99,16 @@ default io.gravitee.apim.core.portal_page.model.PortalNavigationItem map(
                 environmentId,
                 title,
                 area,
-                parentId,
+                order,
                 link.getUrl()
             );
             default -> throw new TechnicalDomainException(
                 String.format("Unknown PortalNavigationItem class %s", createPortalNavigationItem.getClass().getSimpleName())
             );
         };
+        item.setParentId(mapParentId(createPortalNavigationItem.getParentId()));
+
+        return item;
     }
 
     private PortalNavigationItemId mapParentId(String parentId) {

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/main/java/io/gravitee/rest/api/management/v2/rest/resource/ui/PortalNavigationItemsResource.java renamed to gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/main/java/io/gravitee/rest/api/management/v2/rest/resource/environment/PortalNavigationItemsResource.java

@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.gravitee.rest.api.management.v2.rest.resource.ui;
+package io.gravitee.rest.api.management.v2.rest.resource.environment;
 
 import io.gravitee.apim.core.portal_page.use_case.CreatePortalNavigationItemUseCase;
 import io.gravitee.common.http.MediaType;

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/main/java/io/gravitee/rest/api/management/v2/rest/resource/installation/EnvironmentResource.java

@@ -26,11 +26,11 @@
 import io.gravitee.rest.api.management.v2.rest.resource.environment.EnvironmentAnalyticsResource;
 import io.gravitee.rest.api.management.v2.rest.resource.environment.EnvironmentNewtAIResource;
 import io.gravitee.rest.api.management.v2.rest.resource.environment.EnvironmentScoringResource;
+import io.gravitee.rest.api.management.v2.rest.resource.environment.PortalNavigationItemsResource;
 import io.gravitee.rest.api.management.v2.rest.resource.environment.SharedPolicyGroupsResource;
 import io.gravitee.rest.api.management.v2.rest.resource.group.GroupsResource;
 import io.gravitee.rest.api.management.v2.rest.resource.kafka_console.ProxyKafkaConsoleResource;
 import io.gravitee.rest.api.management.v2.rest.resource.ui.PortalMenuLinksResource;
-import io.gravitee.rest.api.management.v2.rest.resource.ui.PortalNavigationItemsResource;
 import io.gravitee.rest.api.management.v2.rest.resource.ui.ThemesResource;
 import io.gravitee.rest.api.service.EnvironmentService;
 import io.gravitee.rest.api.service.common.GraviteeContext;

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/main/resources/openapi/openapi-environments.yaml

@@ -1670,31 +1670,32 @@ components:
             published:
               type: boolean
               description: Whether the page is published or not
+        PortalArea:
+          type: string
+          description: The portal area (used by portal navigation items)
+          enum: [HOMEPAGE, TOP_NAVBAR]
+          example: TOP_NAVBAR
         BaseCreatePortalNavigationItem:
           type: object
           properties:
             title:
               type: string
-              description: Navigation item title
+              description: Portal navigation item title
               example: APIs, Guides
             type:
               type: string
-              description: Navigation item type
+              description: Portal navigation item type
               example: FOLDER
               enum:
                 - FOLDER
                 - PAGE
                 - LINK
             area:
-              type: string
-              description: Portal area to create navigation item in
-              enum:
-                - HOMEPAGE
-                - TOP_NAVBAR
-              example: TOP_NAVBAR
+              $ref: "#/components/schemas/PortalArea"
             order:
               type: integer
-              description: Order of navigation item (zero based)
+              minimum: 0
+              description: Portal navigation item order (zero-based)
               example: 2
             parentId:
               type: string
@@ -1710,7 +1711,6 @@ components:
             - title
             - type
             - area
-            - order
         CreatePortalNavigationFolder:
           type: object
           title: "CreatePortalNavigationFolder"
@@ -1772,7 +1772,7 @@ components:
               example: TOP_NAVBAR
             order:
               type: integer
-              description: Portal navigation item order (zero based)
+              description: Portal navigation item order (zero-based)
               example: 2
             parentId:
               type: string

gravitee-apim-rest-api/gravitee-apim-rest-api-management-v2/gravitee-apim-rest-api-management-v2-rest/src/test/java/io/gravitee/rest/api/management/v2/rest/spring/ResourceContextConfiguration.java

@@ -109,6 +109,7 @@
 import io.gravitee.apim.core.plugin.crud_service.PolicyPluginCrudService;
 import io.gravitee.apim.core.plugin.domain_service.EndpointConnectorPluginDomainService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
+import io.gravitee.apim.core.portal_page.use_case.CreatePortalNavigationItemUseCase;
 import io.gravitee.apim.core.portal_page.use_case.ListPortalNavigationItemsUseCase;
 import io.gravitee.apim.core.promotion.service_provider.CockpitPromotionServiceProvider;
 import io.gravitee.apim.core.promotion.use_case.CreatePromotionUseCase;
@@ -858,6 +859,11 @@ public CreatePromotionUseCase createPromotionUseCase() {
         return mock(CreatePromotionUseCase.class);
     }
 
+    @Bean
+    public CreatePortalNavigationItemUseCase createPortalNavigationItemUseCase() {
+        return mock(CreatePortalNavigationItemUseCase.class);
+    }
+
     @Bean
     public ListPortalNavigationItemsUseCase listPortalNavigationItemsUseCase() {
         return mock(ListPortalNavigationItemsUseCase.class);

gravitee-apim-rest-api/gravitee-apim-rest-api-management/gravitee-apim-rest-api-management-rest/src/test/java/io/gravitee/rest/api/management/rest/spring/ResourceContextConfiguration.java

@@ -86,6 +86,7 @@
 import io.gravitee.apim.core.plugin.crud_service.PolicyPluginCrudService;
 import io.gravitee.apim.core.plugin.domain_service.EndpointConnectorPluginDomainService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
+import io.gravitee.apim.core.portal_page.use_case.CreatePortalNavigationItemUseCase;
 import io.gravitee.apim.core.portal_page.use_case.ListPortalNavigationItemsUseCase;
 import io.gravitee.apim.core.promotion.service_provider.CockpitPromotionServiceProvider;
 import io.gravitee.apim.core.promotion.use_case.CreatePromotionUseCase;
@@ -994,6 +995,11 @@ public CreatePromotionUseCase createPromotionUseCase() {
         return mock(CreatePromotionUseCase.class);
     }
 
+    @Bean
+    public CreatePortalNavigationItemUseCase createPortalNavigationItemUseCase() {
+        return mock(CreatePortalNavigationItemUseCase.class);
+    }
+
     @Bean
     public ListPortalNavigationItemsUseCase listPortalNavigationItemsUseCase() {
         return mock(ListPortalNavigationItemsUseCase.class);

gravitee-apim-rest-api/gravitee-apim-rest-api-portal/gravitee-apim-rest-api-portal-rest/src/test/java/io/gravitee/rest/api/portal/rest/spring/ResourceContextConfiguration.java

@@ -85,6 +85,7 @@
 import io.gravitee.apim.core.plugin.crud_service.PolicyPluginCrudService;
 import io.gravitee.apim.core.plugin.domain_service.EndpointConnectorPluginDomainService;
 import io.gravitee.apim.core.policy.domain_service.PolicyValidationDomainService;
+import io.gravitee.apim.core.portal_page.use_case.CreatePortalNavigationItemUseCase;
 import io.gravitee.apim.core.portal_page.use_case.ListPortalNavigationItemsUseCase;
 import io.gravitee.apim.core.promotion.service_provider.CockpitPromotionServiceProvider;
 import io.gravitee.apim.core.promotion.use_case.CreatePromotionUseCase;
@@ -955,6 +956,11 @@ public CreatePromotionUseCase createPromotionUseCase() {
         return mock(CreatePromotionUseCase.class);
     }
 
+    @Bean
+    public CreatePortalNavigationItemUseCase createPortalNavigationItemUseCase() {
+        return mock(CreatePortalNavigationItemUseCase.class);
+    }
+
     @Bean
     public ListPortalNavigationItemsUseCase listPortalNavigationItemsUseCase() {
         return mock(ListPortalNavigationItemsUseCase.class);

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/portal_page/exception/HomepageAlreadyExistsException.java

@@ -0,0 +1,25 @@
+/*
+ * Copyright © 2015 The Gravitee team (http://gravitee.io)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.gravitee.apim.core.portal_page.exception;
+
+import io.gravitee.apim.core.exception.ValidationDomainException;
+
+public class HomepageAlreadyExistsException extends ValidationDomainException {
+
+    public HomepageAlreadyExistsException(String message) {
+        super(message);
+    }
+}

gravitee-apim-rest-api/gravitee-apim-rest-api-service/src/main/java/io/gravitee/apim/core/portal_page/model/PortalNavigationFolder.java

@@ -16,7 +16,6 @@
 package io.gravitee.apim.core.portal_page.model;
 
 import jakarta.annotation.Nonnull;
-import jakarta.annotation.Nullable;
 
 public final class PortalNavigationFolder extends PortalNavigationItem {
 
@@ -26,8 +25,8 @@ public PortalNavigationFolder(
         @Nonnull String environmentId,
         @Nonnull String title,
         @Nonnull PortalArea area,
-        @Nullable PortalNavigationItemId parentId
+        @Nonnull Integer order
     ) {
-        super(id, organizationId, environmentId, title, area, parentId);
+        super(id, organizationId, environmentId, title, area, order);
     }
 }