@sapui5/sap.ushell 1.139.0 → 1.141.0

package/src/main/js/sap/ushell/components/shell/SideNavigation/interface/ListProviderAPI.js

@@ -0,0 +1,144 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is the concrete ListProviderAPI implementation for this SideNavigation Component
+ */
+sap.ui.define([
+    "sap/base/util/ObjectPath",
+    "sap/ushell/components/shell/SideNavigation/interface/NavContainer",
+    "sap/ushell/modules/NavigationMenu/ListProviderAPI"
+], (
+    ObjectPath,
+    NavContainer,
+    AbstractListProviderAPI
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.components.shell.SideNavigation.interface.ListProviderAPI
+     * @class
+     * @description The API for an navigation menu list provider
+     *
+     * @augments sap.ushell.modules.NavigationMenu.ListProviderAPI
+     *
+     * @since 1.141.0
+     * @private
+     */
+    class ListProviderAPI extends AbstractListProviderAPI {
+        /**
+         * @type {object} The configuration object for the list provider
+         */
+        #oProviderConfig;
+
+        /**
+         * @type {sap.ushell.components.shell.SideNavigation.interface.NavContainer} The navigation container API to interact with the surrounding NavContainer
+         */
+        #oNavContainerAPI;
+
+        /**
+         * @type {sap.ushell.components.shell.SideNavigation.Component} The SideNavigation component
+         */
+        #oComponent;
+
+        /**
+         * @type {sap.ushell.components.shell.SideNavigation.controller.SideNavigation} The SideNavigation controller
+         */
+        #oController;
+
+        /**
+         * @param {object} oConfig The config of the NavigationList Provider
+         * @param {sap.m.NavContainer} oNavContainer The navigation container
+         * @param {sap.tnt.SideNavigation} oSideNavigation The SideNavigation control
+         * @param {sap.ushell.components.shell.SideNavigation.Component} oComponent The SideNavigation component
+         * @param {sap.ushell.components.shell.SideNavigation.controller.SideNavigation} oController The SideNavigation controller
+         *
+         * @since 1.141.0
+         * @private
+         */
+        constructor (oConfig, oNavContainer, oSideNavigation, oComponent, oController) {
+            super();
+            this.#oProviderConfig = oConfig;
+            this.#oNavContainerAPI = new NavContainer(oNavContainer, oSideNavigation);
+            this.#oComponent = oComponent;
+            this.#oController = oController;
+        }
+
+        /**
+         * Returns the configuration value for the provided path.
+         * The configuration path has to be provided in dot notation.
+         * The contents of the configuration have to be set with the setter methods in {@link sap.ushell.modules.NavigationMenu}.
+         * @param {string} sPath The configuration path to get the value for.
+         * @returns {any} The configuration value for the provided path.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        getConfigValue (sPath) {
+            return ObjectPath.get(sPath, this.#oProviderConfig);
+        }
+
+        /**
+         * Returns the navigation container facade. With this a list provider can make updates in the surrounding NavContainer.
+         * @returns {sap.ushell.modules.NavigationMenu.NavContainer} The navigation container facade.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        getNavContainerFacade () {
+            return this.#oNavContainerAPI;
+        }
+
+        /**
+         * Updates the selected key in the navigation container based on {@link sap.ushell.modules.NavigationMenu.ListProvider#findSelectedKey}.
+         * @returns {Promise} Resolves once selected key was updated
+         *
+         * @since 1.141.0
+         * @private
+         */
+        async updateSelectedKey () {
+            await this.#oController.selectIndexAfterRouteChange();
+        }
+
+        /**
+         * Opens the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        openSideNavigation () {
+            this.#oComponent.popoverOpen();
+        }
+
+        /**
+         * Closes the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        closeSideNavigation () {
+            this.#oComponent.popoverClose();
+        }
+
+        /**
+         * Expands the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        expandSideNavigation () {
+            this.#oComponent.toggleSideNavigationExpansion(true);
+        }
+
+        /**
+         * Collapses the side navigation.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        collapseSideNavigation () {
+            this.#oComponent.toggleSideNavigationExpansion(false);
+        }
+    }
+
+    return ListProviderAPI;
+});

package/src/main/js/sap/ushell/components/shell/SideNavigation/interface/NavContainer.js

@@ -0,0 +1,82 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is the concrete NavContainer API implementation for this SideNavigation Component.
+ */
+sap.ui.define([
+    "sap/ushell/modules/NavigationMenu/NavContainer"
+], (
+    AbstractNavContainer
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.components.shell.SideNavigation.interface.NavContainer
+     * @class
+     * @classdesc The API to interact with the navigation menu container.
+     * Cannot be required. has to be fetched via the respective APIs e.g. {@link sap.ushell.modules.NavigationMenu.ListProviderAPI#getNavContainerFacade}.
+     *
+     * @augments sap.ushell.modules.NavigationMenu.NavContainer
+     *
+     * @since 1.141.0
+     * @private
+     */
+    class NavContainer extends AbstractNavContainer {
+        /**
+         * @type {sap.m.NavContainer} The navigation container of the SideNavigation
+         */
+        #oNavContainer;
+
+        /**
+         * @type {sap.tnt.SideNavigation} The SideNavigation control with the navContainer
+         */
+        #oRootControl;
+
+        /**
+         * @param {sap.m.NavContainer} oNavContainer The navigation container of the SideNavigation
+         * @param {sap.tnt.SideNavigation} oRootControl The SideNavigation control with the navContainer
+         *
+         * @since 1.141.0
+         * @private
+         */
+        constructor (oNavContainer, oRootControl) {
+            super();
+            this.#oNavContainer = oNavContainer;
+            this.#oRootControl = oRootControl;
+        }
+
+        /**
+         * Adds a control to the navigation container.
+         * @param {sap.ui.core.Control} oControl The control to add.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        add (oControl) {
+            this.#oNavContainer.addPage(oControl);
+        }
+
+        /**
+         * Navigates to the specified control.
+         * @param {string|sap.ui.core.Control} vControl The control to navigate to.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        to (vControl) {
+            this.#oNavContainer.to(vControl);
+        }
+
+        /**
+         * Navigates to the root control.
+         *
+         * @since 1.141.0
+         * @private
+         */
+        toRoot () {
+            this.#oNavContainer.to(this.#oRootControl);
+        }
+    }
+
+    return NavContainer;
+});

package/src/main/js/sap/ushell/components/shell/SideNavigation/manifest.json

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.components.shell.SideNavigation",
         "applicationVersion": {
-            "version": "1.139.0"
+            "version": "1.141.0"
         },
         "i18n": {
             "bundleUrl": "./resources/resources.properties",

package/src/main/js/sap/ushell/components/shell/SideNavigation/modules/AllSpaces.js

@@ -18,7 +18,7 @@ sap.ui.define([
     /**
      * The menu entry "All Spaces" for the SideNavigation
      *
-     * @property {object} oSideNavAPI Holds the side navigation API object passed to the constructor.
+     * @property {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI Holds the side navigation API object passed to the constructor.
      * @property {sap.tnt.NavigationListItem} oRootItem The root navigation list item configured with the AllSpaces entry.
      * @since 1.134.0
      * @private
@@ -26,14 +26,14 @@ sap.ui.define([
     class AllSpaces {
         /**
          * The promise that resolves once the fragment is loaded.
-         * @type {Promise<[sap.ui.core.Fragment, sap.ui.core.Component]>}
+         * @type {Promise<Array<sap.ui.core.Fragment|sap.ui.core.Component>>}
          */
         #pFragmentLoaded;
 
         /**
          * Creates a new menu entry "AllSpaces".
          *
-         * @param {object} oSideNavAPI The side navigation API object.
+         * @param {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI The side navigation API object.
          *
          * @since 1.134.0
          * @private
@@ -48,7 +48,7 @@ sap.ui.define([
                     controller: this
                 });
                 const pComponentLoaded = Component.create({
-                    name: "sap.ushell.components.shell.NavigationBarMenu", componentData: {renderType: "Menu"}
+                    name: "sap.ushell.components.shell.NavigationBarMenu", componentData: { renderType: "Menu" }
                 });
 
                 this.#pFragmentLoaded = Promise.all([pFragmentLoaded, pComponentLoaded]).then(async (aResults) => {

package/src/main/js/sap/ushell/components/shell/SideNavigation/modules/Favorites.js

@@ -2,7 +2,6 @@
 
 sap.ui.define([
     "sap/m/GenericTile",
-    "sap/m/library",
     "sap/tnt/NavigationListGroup",
     "sap/tnt/NavigationListItem",
     "sap/ui/core/ComponentContainer",
@@ -12,10 +11,11 @@ sap.ui.define([
     "sap/ui/model/json/JSONModel",
     "sap/ushell/Config",
     "sap/ushell/Container",
-    "sap/ushell/components/shell/SideNavigation/modules/NavigationHelper"
+    "sap/ushell/components/shell/SideNavigation/modules/NavigationHelper",
+    "sap/ui/model/resource/ResourceModel",
+    "sap/base/i18n/Localization"
 ], (
     GenericTile,
-    mobileLibrary,
     NavigationListGroup,
     NavigationListItem,
     ComponentContainer,
@@ -25,7 +25,9 @@ sap.ui.define([
     JSONModel,
     Config,
     Container,
-    NavigationHelper
+    NavigationHelper,
+    ResourceModel,
+    Localization
 ) => {
     "use strict";
 
@@ -38,7 +40,7 @@ sap.ui.define([
     class Favorites {
         /**
          * The side navigation API object passed to the constructor.
-         * @type {object}
+         * @type {sap.ushell.modules.NavigationMenu.ListProviderAPI}
          */
         #oSideNavAPI;
 
@@ -67,15 +69,26 @@ sap.ui.define([
          */
         #oSmartBusinessVizInstances = {};
 
+        /**
+         * The promise that resolves with the resource bundle for the i18n texts.
+         * @type {sap.ui.model.resource.ResourceModel}
+         */
+        #oI18nModel;
+
         /**
          * Creates a new menu entry "Favorites" with the sections and apps from the MyHome page for the SideNavigation.
          *
-         * @param {object} oSideNavAPI The side navigation API object.
+         * @param {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI The side navigation API object.
          *
          * @since 1.134.0
          * @private
          */
         constructor (oSideNavAPI) {
+            this.#oI18nModel = new ResourceModel({
+                bundleUrl: sap.ui.require.toUrl("sap/ushell/components/shell/SideNavigation/resources/resources.properties"),
+                bundleLocale: Localization.getLanguage(),
+                async: true
+            });
             this.#oSideNavAPI = oSideNavAPI;
             this.#oRootItem = new NavigationListGroup({
                 text: "{i18n>SideNavigation.Item.Favorites.Title}",
@@ -131,7 +144,12 @@ sap.ui.define([
                 // Is smart business visualization
                 await oVizInstance.loaded();
                 this.#getGenericTileInstance(oVizInstance.getContent())?.firePress();
-            } else if (oVisualization.targetURL) {
+            } else if (oVisualization.targetURL && oVisualization.target?.type === "URL") {
+                this.#NavigationHelper.navigate({
+                    target: { url: oVisualization.targetURL },
+                    type: "URL"
+                });
+            } else if (oVisualization.targetURL && oVisualization.target?.semanticObject && oVisualization.target?.action) {
                 this.#NavigationHelper.navigate({
                     target: { shellHash: oVisualization.targetURL },
                     type: "IBN"
@@ -155,13 +173,13 @@ sap.ui.define([
 
             const sMyHomePageId = Config.last("/core/spaces/myHome/myHomePageId");
             if (!sMyHomePageId) {
-                reject("MyHome pageId is not defined");
+                reject(new Error("MyHome pageId is not defined"));
                 return;
             }
 
             const sHomePagePath = await oPagesService.loadPage(sMyHomePageId);
             if (!sHomePagePath) {
-                reject("MyHome page not loaded");
+                reject(new Error("MyHome page not loaded"));
                 return;
             }
 
@@ -221,6 +239,15 @@ sap.ui.define([
                 }
             });
 
+            // Add a button at the bottom of the "Favorites" menu entry to add new favorite apps using the App Finder
+            const sAddAppsText = (await this.#oI18nModel.getResourceBundle()).getText("SideNavigation.Item.Favorites.AddApps");
+            aFavorites.push({
+                id: "addAppsToFavoritesFolder",
+                title: sAddAppsText,
+                vizType: "sap.ushell.StaticAppLauncher",
+                targetURL: "#Shell-appfinder"
+            });
+
             if (oDefaultSection?.visualizations?.length > 0) {
                 // Add default section visualizations to the beginning
                 this.#processSmartBusinessVisualizations(oDefaultSection.visualizations);

package/src/main/js/sap/ushell/components/shell/SideNavigation/modules/GenericFixedNavigationListProvider.js

@@ -1,13 +1,19 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
+    "sap/base/Log",
+    "sap/tnt/NavigationList",
     "sap/ui/model/json/JSONModel",
     "sap/ui/model/Sorter",
-    "sap/tnt/NavigationList"
+    "sap/ushell/modules/NavigationMenu/ListProvider",
+    "sap/ushell/utils"
 ], (
+    Log,
+    NavigationList,
     JSONModel,
     Sorter,
-    NavigationList
+    ListProvider,
+    ushellUtils
 ) => {
     "use strict";
 
@@ -29,22 +35,26 @@ sap.ui.define([
      * }
      * </code>
      *
-     * @property {object} oSideNavAPI Holds the side navigation API object passed to the constructor.
+     * @property {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI Holds the side navigation API object passed to the constructor.
      * @property {sap.tnt.NavigationList} oRootItem The root navigation list item configured with fixed menu entries e.g AppFinder.
      *
+     * @augments sap.ushell.modules.NavigationMenu.ListProvider
+     *
      * @since 1.134.0
      * @private
      */
-    class GenericFixedNavigationListProvider {
+    class GenericFixedNavigationListProvider extends ListProvider {
         /**
          * Creates a new menu entry "My Spaces" with spaces and pages for the SideNavigation.
          *
-         * @param {object} oSideNavAPI The side navigation API object.
+         * @param {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI The side navigation API object.
          *
          * @since 1.134.0
          * @private
          */
         constructor (oSideNavAPI) {
+            super(oSideNavAPI);
+
             this.oSideNavAPI = oSideNavAPI;
             this.oRootItem = new NavigationList({
                 items: {
@@ -76,42 +86,53 @@ sap.ui.define([
         * @since 1.134.0
         * @private
         */
-        #buildSideNavigation () {
+        async #buildSideNavigation () {
             this.oChildItems = {};
             const oSideNavigationFixedItemsModel = new JSONModel({
                 fixedItems: []
             });
-
-            const fnAddItemToModel = (oItem) => {
-                const sPath = "/fixedItems";
-                const oModel = this.oRootItem.getModel();
-                const aItems = oModel.getObject(sPath);
-                aItems.push(oItem);
-                oModel.setProperty(sPath, aItems);
-            };
+            this.oRootItem.setModel(oSideNavigationFixedItemsModel);
 
             if (this.oSideNavAPI.getConfigValue("spaces.personalization.enabled")) {
-                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/AllSpaces"], (AllSpaces) => {
+                try {
+                    const [AllSpaces] = await ushellUtils.requireAsync(["sap/ushell/components/shell/SideNavigation/modules/AllSpaces"]);
+
                     const oAllSpaces = new AllSpaces(this.oSideNavAPI);
-                    oAllSpaces.getRootItem().then((oItem) => {
-                        this.oChildItems.allSpaces = oItem;
-                        fnAddItemToModel({ key: "allSpaces", scale: 1 });
-                    });
-                });
+                    const oRootItem = await oAllSpaces.getRootItem();
+                    this.oChildItems.allSpaces = oRootItem;
+                    this.#addItemToModel({ key: "allSpaces", scale: 1 });
+                } catch (oError) {
+                    Log.error("Error loading AllSpaces module:", oError, "SideNavigation");
+                }
             }
 
             if (this.oSideNavAPI.getConfigValue("allApps.enabled")) {
-                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/AppFinder"], (AppFinder) => {
+                try {
+                    const [AppFinder] = await ushellUtils.requireAsync(["sap/ushell/components/shell/SideNavigation/modules/AppFinder"]);
+
                     const oAppFinder = new AppFinder(this.oSideNavAPI);
-                    oAppFinder.getRootItem().then((oItem) => {
-                        this.oChildItems.appFinder = oItem;
-                        fnAddItemToModel({ key: "appFinder", scale: 2 });
-                    });
-                });
+                    const oRootItem = await oAppFinder.getRootItem();
+                    this.oChildItems.appFinder = oRootItem;
+                    this.#addItemToModel({ key: "appFinder", scale: 2 });
+                } catch (oError) {
+                    Log.error("Error loading AppFinder module:", oError, "SideNavigation");
+                }
             }
+        }
 
-            this.oRootItem.setModel(oSideNavigationFixedItemsModel);
+        /**
+         * Adds a fixed item to the model.
+         * @param {sap.tnt.NavigationListItem} oItem the fixed item to add
+         * @private
+         */
+        #addItemToModel (oItem) {
+            const sPath = "/fixedItems";
+            const oModel = this.oRootItem.getModel();
+            const aItems = oModel.getObject(sPath);
+            aItems.push(oItem);
+            oModel.setProperty(sPath, aItems);
         }
+
         /**
         * Retrieves and clones a child navigation item by its identifier.
         *
@@ -139,4 +160,4 @@ sap.ui.define([
     }
 
     return GenericFixedNavigationListProvider;
-}, false);
+});