@sapui5/sap.ushell 1.132.1 → 1.134.0

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

@@ -0,0 +1,222 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/tnt/NavigationListItem",
+    "sap/tnt/NavigationListGroup",
+    "sap/ushell/Config",
+    "sap/ushell/Container",
+    "sap/ui/core/CustomData",
+    "sap/ui/model/Filter",
+    "sap/ui/model/FilterOperator",
+    "sap/ui/model/json/JSONModel"
+], function (
+    NavigationListItem,
+    NavigationListGroup,
+    Config,
+    Container,
+    CustomData,
+    Filter,
+    FilterOperator,
+    JSONModel
+) {
+    "use strict";
+
+    /**
+     * The menu entry "Favorites" with the sections and apps from the MyHome page for the SideNavigation.
+     *
+     * @since 1.134.0
+     * @private
+     */
+    class Favorites {
+        /**
+         * The side navigation API object.
+         * @type {object} Holds the side navigation API object passed to the constructor.
+         */
+        #oSideNavAPI;
+
+        /**
+         * The root navigation list item.
+         * @type {sap.tnt.NavigationListGroup} The root navigation list group item configured with sections and apps.
+         */
+        #oRootItem;
+
+        /**
+         * The promise which resolves with the root navigation list item when everything is loaded.
+         * @type {Promise<sap.tnt.NavigationListGroup>} Resolves with the root navigation list item.
+         */
+        #pItemReady;
+
+        /**
+         * 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.
+         *
+         * @since 1.134.0
+         * @private
+         */
+        constructor (oSideNavAPI) {
+            this.#oSideNavAPI = oSideNavAPI;
+            this.#oRootItem = new NavigationListGroup({
+                text: "{i18n>SideNavigation.Item.Favorites.Title}",
+                enabled: "{viewConfiguration>/enableSideNavigation}",
+                items: {
+                    path: "favorites>/",
+                    key: "{favorites>id}",
+                    factory: this.#favoritesModelItemFactory.bind(this)
+                },
+                customData: [new CustomData({
+                    key: "help-id",
+                    value: "MenuEntry-Favorites",
+                    writeToDom: true
+                })]
+            });
+            this.#pItemReady = new Promise((resolve, reject) => {
+                this.#prepareModel(resolve, reject);
+            });
+        }
+
+        /**
+         * Asynchronously retrieves the root navigation list item.
+         *
+         * @async
+         * @returns {Promise<sap.tnt.NavigationListGroup>} A promise that resolves to NavigationListGroup once the model is prepared and ready.
+         * @since 1.134.0
+         * @private
+         */
+        async getRootItem () {
+            return this.#pItemReady;
+        }
+
+        /**
+         * Triggered whenever a user selects a recent activity item.
+         *
+         * Closes the side navigation.
+         *
+         * @param {sap.ui.base.Event} oEvent The event object.
+         * @since 1.134.0
+         */
+        onItemPressed (oEvent) {
+            const sTargetUrl = oEvent.getSource().getBindingContext("favorites").getProperty("targetURL");
+            if (sTargetUrl) {
+                this.#oSideNavAPI.closeSideNavigation();
+            }
+        }
+
+        /**
+         * Prepares the model by fetching the pages service and setting the favorites model on the root item.
+         *
+         * @async
+         * @param {function} resolve The function to call if the operation is successful.
+         * @param {function} reject The function to call if the operation fails.
+         * @returns {Promise<undefined>} A promise that resolves when the model is prepared.
+         * @since 1.134.0
+         * @private
+         */
+        async #prepareModel (resolve, reject) {
+            const oPagesService = await Container.getServiceAsync("Pages");
+
+            const sMyHomePageId = Config.last("/core/spaces/myHome/myHomePageId");
+            if (!sMyHomePageId) {
+                reject("MyHome pageId is not defined");
+                return;
+            }
+
+            const sHomePagePath = await oPagesService.loadPage(sMyHomePageId);
+            if (!sHomePagePath) {
+                reject("MyHome page not loaded");
+                return;
+            }
+
+            const oPagesModel = oPagesService.getModel();
+            const oFavoritesModel = new JSONModel([]);
+            oPagesModel.attachEvent("dataChange", () => {
+                this.#updateFavoritesModel(oPagesModel, oFavoritesModel, sHomePagePath);
+            });
+
+            this.#oRootItem.setModel(oFavoritesModel, "favorites");
+            this.#updateFavoritesModel(oPagesModel, oFavoritesModel, sHomePagePath);
+
+            resolve(this.#oRootItem);
+        }
+
+        /**
+         * Updates the favorites model with the sections and apps from the MyHome page.
+         *
+         * @param {sap.ushell.utils.RestrictedJSONModel} oPagesModel The pages model.
+         * @param {sap.ui.model.json.JSONModel} oFavoritesModel The favorites model.
+         * @param {string} sHomePagePath The path to the MyHome page.
+         *
+         * @since 1.134.0
+         * @private
+         */
+        #updateFavoritesModel (oPagesModel, oFavoritesModel, sHomePagePath) {
+            const aMyHomePageSections = oPagesModel.getProperty(`${sHomePagePath}/sections`);
+            const aFavorites = [];
+            let oDefaultSection;
+
+            const oCurrentFavorites = oFavoritesModel.getProperty("/");
+
+            const oExpandedList = oCurrentFavorites.reduce((oExpanded, oSection) => {
+                oExpanded[oSection.id] = oSection.expanded;
+                return oExpanded;
+            }, {});
+
+            aMyHomePageSections.forEach((oSection) => {
+                // Remember default section to append it at the end
+                if (oSection.default) {
+                    oDefaultSection = oSection;
+                    return;
+                }
+                // Add folders in existing order
+                const aVisualizations = oSection.visualizations;
+                if (aVisualizations.length > 0) {
+                    aFavorites.push({
+                        id: oSection.id,
+                        title: oSection.title,
+                        visualizations: aVisualizations,
+                        expanded: !!oExpandedList[oSection.id]
+                    });
+                }
+            });
+            if (oDefaultSection?.visualizations?.length > 0) {
+                // Add default section at the end
+                aFavorites.push(...oDefaultSection.visualizations);
+            }
+            oFavoritesModel.setProperty("/", aFavorites);
+        }
+
+        /**
+         * Factory function for creating a navigation list item in the "Favorites" menu entry for the favorites model.
+         *
+         * @param {string} sId - The unique identifier for the navigation list item.
+         * @returns {sap.tnt.NavigationListItem} A new instance of NavigationListItem configured for the favorites model.
+         * @since 1.134.0
+         * @private
+         */
+        #favoritesModelItemFactory (sId) {
+            return new NavigationListItem(sId, {
+                key: "{favorites>id}",
+                text: "{= %{favorites>title} === '' ? %{i18n>SideNavigation.Item.Favorites.UntitledFolder} : %{favorites>title} }",
+                enabled: "{viewConfiguration>/enableSideNavigation}",
+                expanded: "{favorites>expanded}",
+                icon: "{= %{favorites>visualizations} ? 'sap-icon://folder' : '' }",
+                selectable: false,
+                items: {
+                    path: "favorites>visualizations",
+                    template: new NavigationListItem({
+                        key: "{favorites>id}",
+                        text: "{favorites>title}",
+                        enabled: "{viewConfiguration>/enableSideNavigation}",
+                        href: "{favorites>targetURL}",
+                        selectable: false,
+                        press: this.onItemPressed.bind(this)
+                    }),
+                    filters: new Filter("title", FilterOperator.NE, "")
+                },
+                press: this.onItemPressed.bind(this)
+            });
+        }
+    }
+
+    return Favorites;
+}, false);

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

@@ -0,0 +1,142 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ui/model/json/JSONModel",
+    "sap/ui/model/Sorter",
+    "sap/tnt/NavigationList"
+], function (
+    JSONModel,
+    Sorter,
+    NavigationList
+) {
+    "use strict";
+
+    /**
+     * The NavigationList for the fixedItem aggregation of the SideNavigation.
+     *
+     * Module specific configuration can contain the following properties as a stringified JSON object:
+     * <code>
+     * /core/sideNavigation/fixedNavigationListProvider/configuration
+     * {
+     *     spaces: {
+     *         personalization: {
+     *             enabled: true
+     *         }
+     *     },
+     *     allApps: {
+     *         enabled: true
+     *     }
+     * }
+     * </code>
+     *
+     * @property {object} 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.
+     *
+     * @since 1.134.0
+     * @private
+     */
+    class GenericFixedNavigationListProvider {
+        /**
+         * Creates a new menu entry "My Spaces" with spaces and pages for the SideNavigation.
+         *
+         * @param {object} oSideNavAPI The side navigation API object.
+         *
+         * @since 1.134.0
+         * @private
+         */
+        constructor (oSideNavAPI) {
+            this.oSideNavAPI = oSideNavAPI;
+            this.oRootItem = new NavigationList({
+                items: {
+                    path: "/fixedItems",
+                    sorter: new Sorter({ path: "scale" }),
+                    factory: this.#sideNavigationFactory.bind(this)
+                }
+            });
+            this.#buildSideNavigation();
+        }
+        /**
+        * Asynchronously retrieves the root navigation list item.
+        *
+        * @async
+        * @returns {Promise<sap.tnt.NavigationList>} A promise that resolves to NavigationList with fixed menu entries if such are enabled.
+        * @since 1.134.0
+        * @private
+        */
+        async getRootItem () {
+            if (this.oSideNavAPI.getConfigValue("spaces.personalization.enabled") || this.oSideNavAPI.getConfigValue("allApps.enabled")) {
+                return this.oRootItem;
+            }
+            return null;
+        }
+
+        /**
+        * Constructs the side navigation by adding fixed items to the model if such are enabled in the config.
+        * Possible menu entries for the fixed items - AppFinder, AllSpaces
+        * @since 1.134.0
+        * @private
+        */
+        #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);
+            };
+
+            if (this.oSideNavAPI.getConfigValue("spaces.personalization.enabled")) {
+                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/AllSpaces"], (AllSpaces) => {
+                    const oAllSpaces = new AllSpaces(this.oSideNavAPI);
+                    oAllSpaces.getRootItem().then((oItem) => {
+                        this.oChildItems.allSpaces = oItem;
+                        fnAddItemToModel({ key: "allSpaces", scale: 1 });
+                    });
+                });
+            }
+
+            if (this.oSideNavAPI.getConfigValue("allApps.enabled")) {
+                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/AppFinder"], (AppFinder) => {
+                    const oAppFinder = new AppFinder(this.oSideNavAPI);
+                    oAppFinder.getRootItem().then((oItem) => {
+                        this.oChildItems.appFinder = oItem;
+                        fnAddItemToModel({ key: "appFinder", scale: 2 });
+                    });
+                });
+            }
+
+            this.oRootItem.setModel(oSideNavigationFixedItemsModel);
+        }
+        /**
+        * Retrieves and clones a child navigation item by its identifier.
+        *
+        * @param {string} sId - The identifier of the child navigation item to retrieve.
+        * @returns {sap.tnt.NavigationListItem} - A clone of the requested child navigation item.
+        * @private
+        * @since 1.134.0
+        */
+        #getChildItemById (sId) {
+            return this.oChildItems[sId].clone();
+        }
+
+        /**
+        * Factory function for creating side navigation list items.
+        *
+        * @param {string} _sId - The unique identifier for the side navigation list item.
+        * @param {object} oContext - The context object providing access to model data for item creation.
+        * @returns {sap.tnt.NavigationListItem} - A cloned navigation list item based on the key from the context.
+        * @private
+        * @since 1.134.0
+        */
+        #sideNavigationFactory (_sId, oContext) {
+            return this.#getChildItemById(oContext.getProperty("key"));
+        }
+    }
+
+    return GenericFixedNavigationListProvider;
+}, false);

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

@@ -0,0 +1,186 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ui/model/json/JSONModel",
+    "sap/ui/model/Sorter",
+    "sap/ushell/Config",
+    "sap/tnt/NavigationList"
+], function (
+    JSONModel,
+    Sorter,
+    Config,
+    NavigationList
+) {
+    "use strict";
+    /**
+     * The NavigationList for the item aggregation of the SideNavigation.
+     *
+     * This module depends on the following ushell configuration:
+     *
+     * <code>
+     * /core/menu/personalization/enabled
+     * /core/spaces/myHome/enabled
+     * /core/spaces/myHome/myHomeSpaceId
+     * /core/spaces/myHome/myHomeSpaceId
+     * </code>
+     *
+     * Module specific configuration can contain the following properties as a stringified JSON object:
+     * <code>
+     * /core/sideNavigation/navigationListProvider/configuration
+     * {
+     *     recentActivity: {
+     *         enabled: true,
+     *         maxItems: 10
+     *     },
+     *     favorites: {
+     *         enabled: true
+     *     },
+     *     spaces: {
+     *         enabled: true,
+     *         defaultIcon: ""
+     *     }
+     * }
+     * </code>
+     *
+     * @property {object} 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.
+     *
+     * @since 1.134.0
+     * @private
+     */
+    class GenericNavigationListProvider {
+        /**
+         * Creates a NavigationList for the item aggregation of the SideNavigation.
+         *
+         * @param {object} oSideNavAPI The side navigation API object.
+         *
+         * @since 1.134.0
+         * @private
+         */
+        constructor (oSideNavAPI) {
+            this.oSideNavAPI = oSideNavAPI;
+            this.oRootItem = new NavigationList({
+                items: {
+                    path: "/items",
+                    sorter: new Sorter({ path: "scale" }),
+                    factory: this.#sideNavigationFactory.bind(this)
+                }
+            });
+            this.#buildSideNavigation();
+        }
+
+        /**
+        * Asynchronously retrieves the root navigation item.
+        *
+        * @async
+        * @returns {Promise<sap.tnt.NavigationList>} A promise that resolves to NavigationList with all truned on in configuration menu items.
+        * @since 1.134.0
+        */
+        async getRootItem () {
+            return this.oRootItem;
+        }
+
+        /**
+        * Asynchronously retrieves the selected item key from the spaces.
+        * @returns {Promise<string>} - A promise that resolves to the selected item key.
+        * @since 1.134.0
+        */
+        async findSelectedKey () {
+            return (await this.pSpaces).findSelectedKey();
+        }
+
+        /**
+        * Builds the side navigation structure by dynamically loading and configuring navigation modules.
+        * This method initializes child navigation items based on the configuration settings provided.
+        *
+        * @private
+        * @since 1.134.0
+        */
+        #buildSideNavigation () {
+            this.oChildItems = {};
+            const oSideNavigationItemModel = new JSONModel({
+                items: []
+            });
+
+            const fnAddItemToModel = (oItem) => {
+                const sPath = "/items";
+                const oModel = this.oRootItem.getModel();
+                const aItems = oModel.getObject(sPath);
+                aItems.push(oItem);
+                oModel.setProperty(sPath, aItems);
+            };
+
+            if (Config.last("/core/spaces/myHome/enabled")) {
+                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/MyHome"], (MyHome) => {
+                    const oMyHome = new MyHome(this.oSideNavAPI);
+                    oMyHome.getRootItem().then((oItem) => {
+                        this.oChildItems.myHome = oItem;
+                        fnAddItemToModel({ key: "myHome", scale: 1 });
+                    });
+                });
+            }
+
+            if (this.oSideNavAPI.getConfigValue("recentActivity.enabled")) {
+                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/RecentActivity"], (RecentActivity) => {
+                    const oRecentActivity = new RecentActivity(this.oSideNavAPI);
+                    oRecentActivity.getRootItem().then((oItem) => {
+                        this.oChildItems.recentActivity = oItem;
+                        fnAddItemToModel({ key: "recentActivity", scale: 2 });
+                    });
+                });
+            }
+
+            if (this.oSideNavAPI.getConfigValue("favorites.enabled")) {
+                sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/Favorites"], (Favorites) => {
+                    const oFavorites = new Favorites(this.oSideNavAPI);
+                    oFavorites.getRootItem().then((oItem) => {
+                        this.oChildItems.favorites = oItem;
+                        fnAddItemToModel({ key: "favorites", scale: 3 });
+                    });
+                });
+            }
+
+            this.pSpaces = new Promise((resolve) => {
+                if (this.oSideNavAPI.getConfigValue("spaces.enabled")) {
+                    sap.ui.require(["sap/ushell/components/shell/SideNavigation/modules/Spaces"], (Spaces) => {
+                        const oSpaces = new Spaces(this.oSideNavAPI);
+                        oSpaces.getRootItem().then((oItem) => {
+                            this.oChildItems.spaces = oItem;
+                            fnAddItemToModel({key: "spaces", scale: 4});
+                        });
+                        resolve(oSpaces);
+                    });
+                }
+            });
+
+            this.oRootItem.setModel(oSideNavigationItemModel);
+        }
+
+        /**
+        * Retrieves and clones a child navigation item by its identifier.
+        *
+        * @param {string} sId - The identifier of the child navigation item to retrieve.
+        * @returns {sap.tnt.NavigationListItem | sap.tnt.NavigationListGroup} A clone of the requested child navigation item.
+        * @private
+        * @since 1.134.0
+        */
+        #getChildItemById (sId) {
+            return this.oChildItems[sId].clone();
+        }
+
+        /**
+        * Factory function for creating side navigation list items.
+        *
+        * @param {string} _sId - The unique identifier for the side navigation list item.
+        * @param {object} oContext - The context object providing access to model data for item creation.
+        * @returns {sap.tnt.NavigationListItem | sap.tnt.NavigationListGroup} A cloned navigation list item based on the key from the context.
+        * @private
+        * @since 1.134.0
+        */
+        #sideNavigationFactory (_sId, oContext) {
+            return this.#getChildItemById(oContext.getProperty("key"));
+        }
+    }
+
+    return GenericNavigationListProvider;
+}, false);

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

@@ -0,0 +1,73 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/tnt/NavigationListItem",
+    "sap/ui/core/CustomData",
+    "sap/ushell/Config",
+    "sap/ushell/components/shell/SideNavigation/modules/NavigationHelper"
+], function (
+    NavigationListItem,
+    CustomData,
+    Config,
+    NavigationHelper
+) {
+    "use strict";
+
+    /**
+     * The menu entry "My Home" for the SideNavigation.
+     *
+     * @property {object} oSideNavAPI Holds the side navigation API object passed to the constructor.
+     * @property {sap.tnt.NavigationListItem} oRootItem The root navigation list item configured with the MyHome.
+     * @since 1.134.0
+     * @private
+     */
+    class MyHome {
+        /**
+         * Creates a new menu entry "My Home" for the SideNavigation.
+         *
+         * @param {object} oSideNavAPI The side navigation API object.
+         *
+         * @since 1.134.0
+         * @private
+         */
+        constructor (oSideNavAPI) {
+            this.oSideNavAPI = oSideNavAPI;
+            this.oNavigationHelper = new NavigationHelper();
+            this.oRootItem = new NavigationListItem({
+                text: "{i18n>SideNavigation.Item.MyHome.Title}",
+                enabled: "{viewConfiguration>/enableSideNavigation}",
+                customData: [new CustomData({
+                    key: "help-id",
+                    value: "MenuEntry-My-Home",
+                    writeToDom: true
+                })],
+                href: Config.last("/core/shellHeader/homeUri"),
+                icon: "sap-icon://home",
+                press: this.onMyHomeMenuSelected.bind(this)
+            });
+        }
+
+        /**
+        * Asynchronously retrieves the root navigation item.
+        *
+        * @async
+        * @returns {Promise<sap.tnt.NavigationListItem>} A promise that resolves to NavigationListItem.
+        * @since 1.134.0
+        * @private
+        */
+        async getRootItem () {
+            return this.oRootItem;
+        }
+
+        /**
+        * Triggered whenever a user selects the MyHome menu entry
+        *
+        * @since 1.134.0
+        */
+        onMyHomeMenuSelected () {
+            this.oSideNavAPI.closeSideNavigation();
+        }
+    }
+
+    return MyHome;
+}, false);