@sapui5/sap.ushell 1.126.1 → 1.127.0

package/src/main/js/sap/ushell/components/pages/controller/PageRuntime.controller.js

@@ -2,7 +2,7 @@
 
 /**
  * @file PageRuntime controller for PageRuntime view
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ui/core/Element",
@@ -286,6 +286,21 @@ sap.ui.define([
             EventHub.emit("firstSegmentCompleteLoaded", true);
         },
 
+        /**
+         * Updates the homeUri in the shell header
+         * @param {object} oCurrentSpaceAndPage The current space and page
+         *
+         * @since 1.127.0
+         * @private
+         */
+        _updateHomeUri: function (oCurrentSpaceAndPage) {
+            const sRootIntent = Config.last("/core/shellHeader/rootIntent");
+            if (Config.last("/core/spaces/homeNavigationTarget") === "origin_page") {
+                var sNewHash = oCurrentSpaceAndPage ? encodeURI(oCurrentSpaceAndPage.hash) : sRootIntent;
+                Config.emit("/core/shellHeader/homeUri", "#" + sNewHash);
+            }
+        },
+
         /**
          * Handles the route matching for the "home" and "openFLPPage" route
          *
@@ -309,7 +324,10 @@ sap.ui.define([
                 this.oPagesRuntimeNavContainer.to(this.oEmptyPage);
                 // Reset spacePage for hierarchy and home button
                 // BCP: 2270105250
-                Config.emit("/core/shell/model/currentSpaceAndPage", undefined);
+                this._updateHomeUri(undefined);
+
+                // Needed for Hierarchy Menu in Spaces mode - see sap/ushell/components/applicationIntegration/AppMeta
+                Config.emit("/core/spaces/currentSpaceAndPage", undefined);
             }
 
             // Hide "[Edit Current Page]" button of page`s runtime
@@ -558,14 +576,17 @@ sap.ui.define([
                             }
                             oFLPPageControl.setShowTitle(bShowTitle);
 
-                            // Needed for Hierarchy Menu in Spaces mode - see sap/ushell/components/applicationIntegration/AppMeta
-                            // Needed for navigation target of the header Logo in Spaces mode - see sap/ushell/components/HeaderManager
                             var oSpacePageData = {
                                 pageTitle: oTitles.pageTitle,
                                 spaceTitle: oTitles.spaceTitle,
                                 hash: hasher.getHash()
                             };
-                            Config.emit("/core/shell/model/currentSpaceAndPage", oSpacePageData);
+
+                            // Needed for navigation target of the header Logo in Spaces mode
+                            this._updateHomeUri(oSpacePageData);
+
+                            // Needed for Hierarchy Menu in Spaces mode - see sap/ushell/components/applicationIntegration/AppMeta
+                            Config.emit("/core/spaces/currentSpaceAndPage", oSpacePageData);
                         }.bind(this));
                 }.bind(this));
         },

package/src/main/js/sap/ushell/components/pages/manifest.json

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.components.pages",
         "applicationVersion": {
-            "version": "1.126.1"
+            "version": "1.127.0"
         },
         "i18n": {
             "bundleUrl": "../../renderer/resources/resources.properties",

package/src/main/js/sap/ushell/components/runtimeSwitcher/Component.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 sap.ui.define([
-   "sap/ui/core/UIComponent"
+    "sap/ui/core/UIComponent"
 
 ], function (UIComponent) {
     "use strict";
@@ -9,7 +9,8 @@ sap.ui.define([
     return UIComponent.extend("sap.ushell.components.runtimeSwitcher.Component", {
         metadata: {
             manifest: "json",
-            library: "sap.ushell"
+            library: "sap.ushell",
+            interfaces: ["sap.ui.core.IAsyncContentCreation"]
         }
 
     });

package/src/main/js/sap/ushell/components/runtimeSwitcher/controller/RuntimeSwitcher.controller.js

@@ -2,7 +2,7 @@
 
 /**
  * @file RuntimeSwitcher's controller for RuntimeSwitcher's view
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ui/core/mvc/Controller",

package/src/main/js/sap/ushell/components/runtimeSwitcher/manifest.json

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.components.runtimeSwitcher",
         "applicationVersion": {
-            "version": "1.126.1"
+            "version": "1.127.0"
         },
         "ach": "CA-FLP-FE-COR",
         "type": "component",

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

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.components.shell.MenuBar",
         "applicationVersion": {
-            "version": "1.126.1"
+            "version": "1.127.0"
         },
         "i18n": {
             "bundleUrl": "../../../renderer/resources/resources.properties",

package/src/main/js/sap/ushell/components/shell/NavigationBarMenu/controller/NavigationBarMenu.controller.js

@@ -4,7 +4,7 @@
  * @fileOverview Controller for the NavigationBarMenu Popover. It is responsible for Popover handling, model binding, persistence
  * logic to pin, unpin and rearrange pinned spaces as well as executing navigation.
  *
- * @version 1.126.1
+ * @version 1.127.0
  * @private
  */
 sap.ui.define([
@@ -17,7 +17,9 @@ sap.ui.define([
     "sap/ui/model/Sorter",
     "sap/ushell/resources",
     "sap/ushell/utils/WindowUtils",
-    "sap/ushell/Container"
+    "sap/ushell/Container",
+    "sap/ushell/EventHub",
+    "sap/ui/model/json/JSONModel"
 ], function (
     InvisibleMessage,
     coreLibrary,
@@ -28,7 +30,9 @@ sap.ui.define([
     Sorter,
     resources,
     WindowUtils,
-    Container
+    Container,
+    EventHub,
+    JSONModel
 ) {
     "use strict";
 
@@ -62,6 +66,16 @@ sap.ui.define([
         onInit: function () {
             this.pMenuServicePromise = Container.getServiceAsync("Menu");
             this._oInvisibleMessageInstance = InvisibleMessage.getInstance();
+
+            const oViewConfigurationModel = new JSONModel({
+                enableMenuBarNavigation: true
+            });
+            this.getView().setModel(oViewConfigurationModel, "viewConfiguration");
+
+            this._oEventHubListener = EventHub.on("enableMenuBarNavigation").do((bEnableMenuBarNavigation) => {
+                this.getView().getModel("viewConfiguration").setProperty("/enableMenuBarNavigation", bEnableMenuBarNavigation);
+            });
+
         },
 
         /**
@@ -74,6 +88,8 @@ sap.ui.define([
             if (this._oInvisibleMessageInstance) {
                 this._oInvisibleMessageInstance.destroy();
             }
+
+            this._oEventHubListener.off();
         },
 
         /**

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

@@ -3,7 +3,7 @@
     "sap.app": {
         "id": "sap.ushell.components.shell.NavigationBarMenu",
         "applicationVersion": {
-            "version": "1.126.1"
+            "version": "1.127.0"
         },
         "i18n": {
             "bundleUrl": "../../../renderer/resources/resources.properties",

package/src/main/js/sap/ushell/components/shell/NavigationBarMenu/view/NavigationBarMenu.view.xml

@@ -7,6 +7,7 @@
     <Button
         id="navigationBarMenuButton"
         icon="sap-icon://menu2"
+        enabled="{viewConfiguration>/enableMenuBarNavigation}"
         press=".openNavigationBarMenuPopover"
         tooltip="{i18n>NavigationBarMenu.Button.OpenPopover}"
         ariaHasPopup="Dialog">

package/src/main/js/sap/ushell/components/shell/Notifications/Component.js

@@ -15,7 +15,8 @@ sap.ui.define([
     "sap/ushell/resources",
     "sap/ushell/utils",
     "sap/ushell/ui/shell/ShellHeadItem",
-    "sap/ushell/Container"
+    "sap/ushell/Container",
+    "sap/ushell/state/ShellModel"
 ], function (
     Log,
     Element,
@@ -31,7 +32,8 @@ sap.ui.define([
     resources,
     utils,
     ShellHeadItem,
-    Container
+    Container,
+    ShellModel
 ) {
     "use strict";
 
@@ -41,14 +43,13 @@ sap.ui.define([
     // shortcut for sap.ushell.FloatingNumberType
     var FloatingNumberType = ushellLibrary.FloatingNumberType;
 
-
     function getNotificationButton () {
         return Element.getElementById("NotificationsCountButton");
     }
 
     return UIComponent.extend("sap.ushell.components.shell.Notifications.Component", {
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell.components.shell.Notifications",
             dependencies: {
                 libs: ["sap.m"]
@@ -58,33 +59,30 @@ sap.ui.define([
         createContent: function () {
             this._aTimeouts = [];
             this.oRenderer = Container.getRendererInternal("fiori2");
-            this.oShellModel = this.oRenderer.shellCtrl.getModel();
+            this.oConfigModel = ShellModel.getConfigModel();
             Container.getServiceAsync("NotificationsV2").then(function (oNotificationsService) {
 
                 this.oNotificationsService = oNotificationsService;
 
                 if (this.oNotificationsService.isEnabled() === true) {
                     EventBus.getInstance().subscribe("sap.ushell.services.Notifications", "onNewNotifications", this._handleAlerts, this);
-                    this.oShellModel.setProperty("/enableNotifications", true);
+                    this.oConfigModel.setProperty("/enableNotifications", true);
                     this.oNotificationsService.init();
                     if (this.oRenderer.getShellConfig().enableNotificationsUI === true) {
-                        this.oShellModel.setProperty("/enableNotificationsUI", true);
+                        this.oConfigModel.setProperty("/enableNotificationsUI", true);
                         this.oNotificationsService.registerNotificationsUpdateCallback(this._updateCount.bind(this), true);
                     }
-                    this._createNotificationButton(this.oShellModel);
-                    //ElementsModel, not shell model. Need only 3 state, for this reason call directly
-                    this.oRenderer.oShellModel.addHeaderEndItem(["NotificationsCountButton"], false, ["home", "app", "minimal"], true);
+                    this._createNotificationButton(this.oConfigModel);
 
                     EventHub.on("showNotifications").do(this._toggleNotifications.bind(this));
                 }
             }.bind(this));
         },
 
-        _createNotificationButton: function (oShellModel) {
+        _createNotificationButton: function (oConfigModel) {
             // The press handler is added in the Notification Component
-            var sId = "NotificationsCountButton";
             var oNotificationToggleButton = new ShellHeadItem({
-                id: sId,
+                id: "NotificationsCountButton",
                 tooltip: resources.i18n.getText("notificationsBtn_title"),
                 icon: IconPool.getIconURI("bell"),
                 text: resources.i18n.getText("notificationsBtn_title"),
@@ -92,16 +90,18 @@ sap.ui.define([
                 ariaHaspopup: "dialog",
                 enabled: true,
                 selected: false,
-                visible: "{/enableNotifications}",
-                floatingNumber: "{/notificationsCount}",
+                visible: "{configModel>/enableNotifications}",
+                floatingNumber: "{configModel>/notificationsCount}",
                 floatingNumberMaxValue: Device.system.phone ? 99 : 999, // according to the UX specification
                 floatingNumberType: FloatingNumberType.Notifications,
                 press: function () {
                     EventHub.emit("showNotifications", Date.now());
                 }
             });
-            oNotificationToggleButton.setModel(oShellModel);
+            oNotificationToggleButton.setModel(oConfigModel, "configModel");
             oNotificationToggleButton.setModel(resources.i18nModel, "i18n");
+
+            this.oRenderer.showHeaderEndItem([oNotificationToggleButton.getId()], false, ["home", "app"]);
         },
 
         _handleAlerts: function (sChannelId, sEventId, aNewNotifications) {
@@ -147,11 +147,13 @@ sap.ui.define([
         // Update the notifications count in the UI
         // The new count is also displayed when the notifications popover is already opened
         _updateCount: function () {
-            this.oNotificationsService.getUnseenNotificationsCount().then(function (iNumberOfNotifications) {
-                this.oShellModel.setProperty("/notificationsCount", parseInt(iNumberOfNotifications, 10));
-            }.bind(this)).catch(function (data) {
-                Log.error("Notifications - call to notificationsService.getCount failed: ", data);
-            });
+            this.oNotificationsService.getUnseenNotificationsCount()
+                .then(function (iNumberOfNotifications) {
+                    this.oConfigModel.setProperty("/notificationsCount", parseInt(iNumberOfNotifications, 10));
+                }.bind(this))
+                .catch(function (data) {
+                    Log.error("Notifications - call to notificationsService.getCount failed: ", data);
+                });
         },
 
         _getPopover: function () {
@@ -228,7 +230,7 @@ sap.ui.define([
         },
 
         _resetCount: function () {
-            this.oShellModel.setProperty("/notificationsCount", 0);
+            this.oConfigModel.setProperty("/notificationsCount", 0);
             this.oNotificationsService.notificationsSeen();
         },
 

package/src/main/js/sap/ushell/components/shell/Notifications/Notifications.controller.js

@@ -49,7 +49,7 @@ sap.ui.define([
         oMessageService.error(sText);
     }
 
-    Controller.extend("sap.ushell.components.shell.Notifications.Notifications", {
+    return Controller.extend("sap.ushell.components.shell.Notifications.Notifications", {
         oPagingConfiguration: {
             MAX_NOTIFICATION_ITEMS_DESKTOP: 400,
             MAX_NOTIFICATION_ITEMS_MOBILE: 100,

package/src/main/js/sap/ushell/components/shell/PostLoadingHeaderEnhancement/Component.js

@@ -12,7 +12,10 @@ sap.ui.define([
     "sap/ushell/library",
     "sap/ushell/resources",
     "sap/ushell/ui/shell/ShellHeadItem",
-    "sap/ushell/Container"
+    "sap/ushell/state/ShellModel",
+    "sap/ushell/state/StateManager",
+    "sap/ushell/Container",
+    "sap/ushell/utils/UrlParsing"
 ], function (
     Localization,
     Device,
@@ -25,7 +28,10 @@ sap.ui.define([
     ushellLibrary,
     resources,
     ShellHeadItem,
-    Container
+    ShellModel,
+    StateManager,
+    Container,
+    UrlParsing
 ) {
     "use strict";
 
@@ -35,6 +41,22 @@ sap.ui.define([
     // shortcut for sap.ushell.FloatingNumberType
     var FloatingNumberType = ushellLibrary.FloatingNumberType;
 
+    // shortcut for sap.ushell.state.StateManager.LaunchpadState
+    const LaunchpadState = StateManager.LaunchpadState;
+
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
+
+    // shortcut for sap.ushell.state.StateManager.ShellMode
+    const ShellMode = StateManager.ShellMode;
+    const {
+        Default,
+        Standalone,
+        Embedded,
+        Lean,
+        Merged
+    } = ShellMode;
+
     var aCreatedControlIds = [];
 
     return Component.extend("sap.ushell.components.shell.PostLoadingHeaderEnhancement.Component", {
@@ -57,7 +79,7 @@ sap.ui.define([
                 });
             }
 
-            this._createShellNavigationMenu(oShellConfig);
+            this._createShellNavigationMenu();
 
             var oShellHeader = Element.getElementById("shell-header");
             oShellHeader.updateAggregation("headItems");
@@ -66,6 +88,8 @@ sap.ui.define([
 
         _createBackButton: function () {
             var sBackButtonIcon = Localization.getRTL() ? "feeder-arrow" : "nav-back";
+            const sCurrentShellMode = StateManager.getShellMode();
+
             var oBackButton = new ShellHeadItem({
                 id: "backBtn",
                 tooltip: resources.i18n.getText("backBtn_tooltip"),
@@ -75,15 +99,45 @@ sap.ui.define([
                     EventHub.emit("navigateBack", Date.now());
                 }
             });
+
+            if ([Default, Standalone, Embedded, Merged].includes(sCurrentShellMode)) {
+                StateManager.updateBaseStates([LaunchpadState.App], "header.headItems", Operation.Add, oBackButton.getId());
+            } else if (sCurrentShellMode === Lean) {
+                // only show btn after a navigation happened
+                this._boundSetBackButtonVisibilityAfterHashChanged = this._setBackButtonVisibilityAfterHashChanged.bind(this);
+                window.addEventListener("hashchange", this._boundSetBackButtonVisibilityAfterHashChanged);
+            }
+            /*
+             * minimal:
+             * only show btn in case a custom back navigation was registered
+             * handled in Shell.controller@onBackNavigationChange
+             */
+
             return oBackButton.getId();
         },
 
+        _setBackButtonVisibilityAfterHashChanged: function (oHashChangeEvent) {
+            const { oldURL, newURL } = oHashChangeEvent;
+            const sOldHash = UrlParsing.getHash(oldURL);
+            const sNewHash = UrlParsing.getHash(newURL);
+            const sOldInnerAppRoute = UrlParsing.parseShellHash(sOldHash).appSpecificRoute;
+            const sNewInnerAppRoute = UrlParsing.parseShellHash(sNewHash).appSpecificRoute;
+
+            const bInnerAppNavigationOccurred = sOldInnerAppRoute !== sNewInnerAppRoute;
+
+            if (bInnerAppNavigationOccurred) {
+                StateManager.updateBaseStates([LaunchpadState.App], "header.headItems", Operation.Add, "backBtn");
+
+                window.removeEventListener("hashchange", this._boundSetBackButtonVisibilityAfterHashChanged);
+                delete this._boundSetBackButtonVisibilityAfterHashChanged;
+            }
+        },
+
         _createOverflowButton: function () {
-            var oShellModel = Container.getRendererInternal("fiori2").getShellController().getModel();
             var oEndItemsOverflowBtn = new ShellHeadItem({
                 id: "endItemsOverflowBtn",
                 tooltip: {
-                    path: "/notificationsCount",
+                    path: "configModel>/notificationsCount",
                     formatter: function (notificationsCount) {
                         return this.tooltipFormatter(notificationsCount);
                     }
@@ -91,14 +145,14 @@ sap.ui.define([
                 ariaLabel: resources.i18n.getText("shellHeaderOverflowBtn_tooltip"),
                 ariaHaspopup: "dialog",
                 icon: "sap-icon://overflow",
-                floatingNumber: "{/notificationsCount}",
+                floatingNumber: "{configModel>/notificationsCount}",
                 floatingNumberMaxValue: Device.system.phone ? 99 : 999, // according to the UX specification
                 floatingNumberType: FloatingNumberType.OverflowButton,
                 press: function (oEvent) {
                     EventHub.emit("showEndItemOverflow", oEvent.getSource().getId(), true);
                 }
             });
-            oEndItemsOverflowBtn.setModel(oShellModel);
+            oEndItemsOverflowBtn.setModel(ShellModel.getConfigModel(), "configModel");
             return oEndItemsOverflowBtn.getId();
         },
 
@@ -123,6 +177,9 @@ sap.ui.define([
             if (Config.last("/core/extension/enableHelp")) {
                 oOpenCatalogButton.addStyleClass("help-id-openCatalogActionItem"); // xRay help ID
             }
+
+            // Add to userActions. The actual move happens within the state management
+            StateManager.updateAllBaseStates("userActions.items", Operation.Add, oOpenCatalogButton.getId());
             return oOpenCatalogButton.getId();
         },
 
@@ -153,12 +210,15 @@ sap.ui.define([
                             }
                         });
                     }
+
+                    // Add to userActions. The actual move happens within the state management
+                    StateManager.updateAllBaseStates("userActions.items", Operation.Add, sButtonName);
                     fnResolve(sButtonName);
                 });
             });
         },
 
-        _createShellNavigationMenu: function (oShellConfig) {
+        _createShellNavigationMenu: function () {
             return new Promise(function (resolve) {
                 sap.ui.require([
                     "sap/m/StandardListItem",
@@ -214,30 +274,29 @@ sap.ui.define([
                     };
 
                     var oShellNavigationMenu = new ShellNavigationMenu(sMenuId, {
-                        showRelatedApps: oShellConfig.appState !== "lean",
+                        showRelatedApps: StateManager.getShellMode() !== Lean,
                         items: {
-                            path: "/application/hierarchy",
+                            path: "shellModel>/application/hierarchy",
                             factory: oHierarchyTemplateFunction.bind(this)
                         },
                         miniTiles: {
-                            path: "/application/relatedApps",
+                            path: "shellModel>/application/relatedApps",
                             factory: oRelatedAppsTemplateFunction.bind(this)
                         },
                         visible: {
-                            path: "/ShellAppTitleState",
-                            formatter: function (oCurrentState) {
-                                return oCurrentState === AppTitleState.ShellNavMenu;
+                            path: "configModel>/shellAppTitleState",
+                            formatter: function (sCurrentState) {
+                                return sCurrentState === AppTitleState.ShellNavMenu;
                             }
                         }
                     });
 
-                    var oShellHeader = Element.getElementById("shell-header");
-                    oShellNavigationMenu.setModel(oShellHeader.getModel());
+                    oShellNavigationMenu.setModel(ShellModel.getModel(), "shellModel");
+                    oShellNavigationMenu.setModel(ShellModel.getConfigModel(), "configModel");
 
                     var oShellAppTitle = Element.getElementById("shellAppTitle");
                     if (oShellAppTitle) {
                         oShellAppTitle.setNavigationMenu(oShellNavigationMenu);
-                        oShellAppTitle.setModel(oShellHeader.getModel());
                     }
                     aCreatedControlIds.push(sMenuId);
 
@@ -254,6 +313,10 @@ sap.ui.define([
                 }
             });
             aCreatedControlIds = [];
+
+            if (this._boundSetBackButtonVisibilityAfterHashChanged) {
+                window.removeEventListener("hashchange", this._boundSetBackButtonVisibilityAfterHashChanged);
+            }
         }
     });
 });

package/src/main/js/sap/ushell/components/shell/ProductSwitch/Component.js

@@ -35,7 +35,7 @@ sap.ui.define([
     return UIComponent.extend("sap.ushell.components.shell.ProductSwitch.Component", {
 
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: "sap.ushell.components.shell.ProductSwitch",
             dependencies: {
                 libs: {

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

@@ -4,7 +4,7 @@
         "id": "sap.ushell.components.shell.Search",
 
         "applicationVersion": {
-            "version": "1.126.1"
+            "version": "1.127.0"
         },
         "i18n": {
             "bundleUrl": "../../../renderer/resources/resources.properties",

package/src/main/js/sap/ushell/components/shell/SearchCEP/Component.js

@@ -31,7 +31,7 @@ sap.ui.define([
 
     return UIComponent.extend("sap.ushell.components.shell.SearchCEP.Component", {
         metadata: {
-            version: "1.126.1",
+            version: "1.127.0",
             library: ["sap.ushell", "sap.ushell.components.shell"],
             dependencies: {
                 libs: ["sap.m"]

package/src/main/js/sap/ushell/components/shell/SearchCEP/SearchProviders/FrequentActivityProvider.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/components/shell/SearchCEP/SearchProviders/RecentSearchProvider.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/components/shell/SearchCEP/SearchProviders/SearchProvider.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module is the search provider main interface
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/ushell/resources",

package/src/main/js/sap/ushell/components/shell/SearchCEP/SearchProviders/SearchServiceProvider.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module handles the navigation service search actions
- * @version 1.126.1
+ * @version 1.127.0
  */
 sap.ui.define([
     "sap/base/Log",