@sapui5/sap.ushell 1.126.1 → 1.127.1

package/src/main/js/sap/ushell/renderers/fiori2/Shell.view.js

@@ -7,38 +7,51 @@
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/m/Avatar",
+    "sap/m/library",
     "sap/ui/Device",
-    "sap/ushell/components/_HeaderManager/ControlManager",
     "sap/ushell/components/_HeaderManager/ShellHeader.controller",
     "sap/ushell/ui/launchpad/AccessibilityCustomData",
     "sap/ushell/EventHub",
     "sap/ushell/resources",
     "sap/ushell/utils",
-    "sap/ushell/Config",
-    "sap/ui/model/json/JSONModel",
     "sap/ui/core/mvc/XMLView",
     "sap/ui/core/Core",
-    "sap/ushell/renderer/ShellLayout"
+    "sap/ushell/Container",
+    "sap/ushell/renderer/ShellLayout",
+    "sap/ushell/state/ShellModel",
+    "sap/ushell/state/StateManager"
 ], function (
     Log,
+    Avatar,
+    mobileLibrary,
     Device,
-    HeaderControlManager,
     ShellHeaderController,
     AccessibilityCustomData,
     EventHub,
-    resources,
+    ushellResources,
     utils,
-    Config,
-    JSONModel,
     XMLView,
     Core,
-    ShellLayout
+    Container,
+    ShellLayout,
+    ShellModel,
+    StateManager
 ) {
     "use strict";
 
-    var ShellLayoutMapping = ShellLayout.LAYOUT_MAPPING;
+    // shortcut for sap.m.AvatarSize
+    const AvatarSize = mobileLibrary.AvatarSize;
 
-    var BINDING_TYPE = {
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
+
+    // shortcut for sap.ushell.state.StateManager.ShellMode
+    const ShellMode = StateManager.ShellMode;
+
+    const ShellLayoutMapping = ShellLayout.LAYOUT_MAPPING;
+
+    const BINDING_TYPE = {
         Property: "Property",
         List: "List"
     };
@@ -62,14 +75,6 @@ sap.ui.define([
             return this._oShellLayoutPromise;
         },
 
-        getShellModel: function () {
-            return this.getViewData().shellModel;
-        },
-
-        getHelperModel: function () {
-            return this.getViewData().helperModel;
-        },
-
         getViewDataConfig: function () {
             var oViewData = this.getViewData() || {};
             var oConfig = oViewData.config || {};
@@ -85,8 +90,11 @@ sap.ui.define([
          * @deprecated since 1.99. Please use {@link sap.ushell.renderer.Shell.view} instead.
          */
         createContent: function () {
+            this._createUserActionsMenuButton(ShellModel.getConfigModel());
+
             // Change config if more then three buttons moved to the header
             this._allowUpToThreeActionInShellHeader();
+            StateManager.init(this.getViewDataConfig());
 
             // BackgroundImage
             this.initBackgroundImage();
@@ -128,31 +136,25 @@ sap.ui.define([
             var oRendererRootView = sap.ui.xmlfragment("sap.ushell.ui.RendererRootView", oController); // LEGACY API (deprecated)
             oRendererRootView.updateAggregation = this.updateShellAggregation;
 
-            sap.ui.getCore().byId("viewPortContainer");
-
             return oRendererRootView;
         },
 
         createShellHeaderSync: function () {
-            var oConfig = this.getViewDataConfig();
-            var oShellModel = this.getShellModel();
             // Create own model for the header
-            var oShellHeaderModel = Config.createModel("/core/shellHeader", JSONModel);
             var oHeaderController = new ShellHeaderController();
             oHeaderController.onInit();
 
             // eslint-disable-next-line ushell/no-deprecated
             var oShellHeader = sap.ui.xmlfragment("sap.ushell.ui.ShellHeader", oHeaderController); // LEGACY API (deprecated)
             oShellHeader.updateAggregation = this.updateShellAggregation;
-            HeaderControlManager.init(oConfig, oHeaderController, oShellModel);
 
-            if (oConfig.appState === "embedded") {
+            if (StateManager.getShellMode() === ShellMode.Embedded) {
                 oShellHeader.setNoLogo();
             }
 
             // Assign models to the Shell Header
-            oShellHeader.setModel(oShellHeaderModel);
-            oShellHeader.setModel(resources.i18nModel, "i18n");
+            oShellHeader.setModel(ShellModel.getModel(), "shellModel");
+            oShellHeader.setModel(ushellResources.i18nModel, "i18n");
             this.addDanglingControl(oShellHeader);
             // save for later use
             this._oShellHeader = oShellHeader;
@@ -188,15 +190,15 @@ sap.ui.define([
                     id: "right-floating-container",
                     top: "2",
                     hideItemsAfterPresentation: true,
-                    visible: "{/currentState/showRightFloatingContainer}",
+                    visible: "{shellModel>/rightFloatingContainer/visible}",
                     floatingContainerItems: {
-                        path: "/currentState/RightFloatingContainerItems",
+                        path: "shellModel>/rightFloatingContainer/items",
                         factory: fnShellUpdateAggItem
                     }
                 });
                 oRightFloatingContainer.updateAggregation = this.updateShellAggregation;
 
-                oRightFloatingContainer.setModel(this.getShellModel());
+                oRightFloatingContainer.setModel(ShellModel.getModel(), "shellModel");
                 this.addDanglingControl(oRightFloatingContainer);
                 // save for later use
                 this._oRightFloatingContainer = oRightFloatingContainer;
@@ -209,7 +211,7 @@ sap.ui.define([
 
         initCanvasShapesManager: function () {
             this.bindFactory({
-                model: this.getShellModel(),
+                model: ShellModel.getConfigModel(),
                 factory: this.createCanvasShapesManager.bind(this),
                 bindingPath: "/enableBackGroundShapes",
                 bindingType: BINDING_TYPE.Property,
@@ -235,13 +237,13 @@ sap.ui.define([
                 var oSubHeader = new SubHeader({
                     id: "subhdr",
                     content: {
-                        path: "/currentState/subHeader",
+                        path: "shellModel>/subHeader/items",
                         factory: fnShellUpdateAggItem
                     }
                 });
                 oSubHeader.updateAggregation = this.updateShellAggregation;
 
-                oSubHeader.setModel(this.getShellModel());
+                oSubHeader.setModel(ShellModel.getModel(), "shellModel");
                 this.addDanglingControl(oSubHeader);
 
                 this.waitForShellLayout().then(function () {
@@ -258,9 +260,9 @@ sap.ui.define([
                 ], function (FloatingContainer, Storage) {
                     var oFloatingContainer = new FloatingContainer({
                         id: "shell-floatingContainer",
-                        visible: "{helper>/shell/floatingContainerVisible}",
+                        visible: "{shellModel>/floatingContainer/visible}",
                         content: {
-                            path: "/currentState/floatingContainerContent",
+                            path: "shellModel>/floatingContainer/items",
                             factory: fnShellUpdateAggItem
                         }
                     });
@@ -275,8 +277,7 @@ sap.ui.define([
                         }));
                     }
 
-                    oFloatingContainer.setModel(this.getShellModel());
-                    oFloatingContainer.setModel(this.getHelperModel(), "helper");
+                    oFloatingContainer.setModel(ShellModel.getModel(), "shellModel");
                     this.addDanglingControl(oFloatingContainer);
 
                     this.waitForShellLayout().then(function () {
@@ -313,15 +314,15 @@ sap.ui.define([
             sap.ui.require(["sap/ushell/ui/shell/SidePane"], function (SidePane) {
                 var oSidePane = new SidePane({
                     id: "shell-sidePane",
-                    visible: "{/currentState/showPane}",
+                    visible: "{shellModel>/sidePane/visible}",
                     content: {
-                        path: "/currentState/paneContent",
+                        path: "shellModel>/sidePane/items",
                         factory: fnShellUpdateAggItem
                     }
                 });
                 oSidePane.updateAggregation = this.updateShellAggregation;
 
-                oSidePane.setModel(this.getShellModel());
+                oSidePane.setModel(ShellModel.getModel(), "shellModel");
                 this.addDanglingControl(oSidePane);
 
                 this.waitForShellLayout().then(function () {
@@ -334,15 +335,15 @@ sap.ui.define([
             sap.ui.require(["sap/ushell/ui/shell/ToolArea"], function (ToolArea) {
                 var oShellToolArea = new ToolArea({
                     id: "shell-toolArea",
-                    visible: "{/currentState/toolAreaVisible}",
+                    visible: "{shellModel>/toolArea/visible}",
                     toolAreaItems: {
-                        path: "/currentState/toolAreaItems",
+                        path: "shellModel>/toolArea/items",
                         factory: fnShellUpdateAggItem
                     }
                 });
                 oShellToolArea.updateAggregation = this.updateShellAggregation;
 
-                oShellToolArea.setModel(this.getShellModel());
+                oShellToolArea.setModel(ShellModel.getModel(), "shellModel");
                 this.addDanglingControl(oShellToolArea);
 
                 this.waitForShellLayout().then(function () {
@@ -356,13 +357,13 @@ sap.ui.define([
                 var oShellFloatingActions = new ShellFloatingActions({
                     id: "shell-floatingActions",
                     floatingActions: {
-                        path: "/currentState/floatingActions",
+                        path: "shellModel>/floatingActions/items",
                         factory: fnShellUpdateAggItem
                     }
                 });
                 oShellFloatingActions.updateAggregation = this.updateShellAggregation;
 
-                oShellFloatingActions.setModel(this.getShellModel());
+                oShellFloatingActions.setModel(ShellModel.getModel(), "shellModel");
                 this.addDanglingControl(oShellFloatingActions);
 
                 this.waitForShellLayout().then(function () {
@@ -384,11 +385,11 @@ sap.ui.define([
                 id: "allMyAppsView",
                 viewName: "sap.ushell.renderer.allMyApps.AllMyApps"
             }).then(function (allMyAppsView) {
-                allMyAppsView.setModel(this.getShellModel());
-                allMyAppsView.setModel(resources.i18nModel, "i18n");
+                allMyAppsView.setModel(ShellModel.getConfigModel(), "configModel");
+                allMyAppsView.setModel(ushellResources.i18nModel, "i18n");
                 allMyAppsView.addCustomData(new AccessibilityCustomData({
                     key: "aria-label",
-                    value: resources.i18n.getText("allMyApps_headerTitle"),
+                    value: ushellResources.i18n.getText("allMyApps_headerTitle"),
                     writeToDom: true
                 }));
                 this.addDanglingControl(allMyAppsView);
@@ -400,7 +401,7 @@ sap.ui.define([
          * Begin factory functions for lazy instantiation of Shell Layout controls
          */
         createPostCoreExtControls: function () {
-            var oShellModel = this.getShellModel();
+            var oShellModel = ShellModel.getModel();
 
             // apply the highest z-index used by the shell
             sap.ui.require(["sap/ui/core/Popup"], function (Popup) {
@@ -411,7 +412,7 @@ sap.ui.define([
             this.bindFactory({
                 model: oShellModel,
                 factory: this.createRightFloatingContainer.bind(this),
-                bindingPath: "/currentState/showRightFloatingContainer",
+                bindingPath: "/rightFloatingContainer/visible",
                 bindingType: BINDING_TYPE.Property,
                 valueCheck: function (bValue) {
                     return !!bValue;
@@ -422,7 +423,7 @@ sap.ui.define([
             this.bindFactory({
                 model: oShellModel,
                 factory: this.createSubHeader.bind(this),
-                bindingPath: "/currentState/subHeader",
+                bindingPath: "/subHeader/items",
                 bindingType: BINDING_TYPE.List,
                 valueCheck: function (aValues) {
                     return !!aValues.length;
@@ -433,7 +434,7 @@ sap.ui.define([
             this.bindFactory({
                 model: oShellModel,
                 factory: this.createToolArea.bind(this),
-                bindingPath: "/currentState/toolAreaVisible",
+                bindingPath: "/toolArea/visible",
                 bindingType: BINDING_TYPE.Property,
                 valueCheck: function (bValue) {
                     return !!bValue;
@@ -444,7 +445,7 @@ sap.ui.define([
             this.bindFactory({
                 model: oShellModel,
                 factory: this.createSidePane.bind(this),
-                bindingPath: "/currentState/showPane",
+                bindingPath: "/sidePane/visible",
                 bindingType: BINDING_TYPE.Property,
                 valueCheck: function (bValue) {
                     return !!bValue;
@@ -455,7 +456,7 @@ sap.ui.define([
             this.bindFactory({
                 model: oShellModel,
                 factory: this.createFloatingActions.bind(this),
-                bindingPath: "/currentState/floatingActions",
+                bindingPath: "/floatingActions/items",
                 bindingType: BINDING_TYPE.List,
                 valueCheck: function (aValues) {
                     return !!aValues.length;
@@ -469,29 +470,44 @@ sap.ui.define([
          * allow up to 3 actions in shell header
          */
         _allowUpToThreeActionInShellHeader: function () {
-            var oConfig = this.getViewDataConfig();
-            // in order to save performance time when these properties are not defined
-            if (Object.keys(oConfig).length > 3) {
-                var aParameter = [
-                    "moveAppFinderActionToShellHeader",
-                    "moveUserSettingsActionToShellHeader",
-                    "moveContactSupportActionToShellHeader",
-                    "moveEditHomePageActionToShellHeader"
-                ];
-                var count = 0;
-                var sParameter;
-
-                // count the number of "true" values, once get to three, force the other to be "false"
-                for (var index = 0; index < 5; index++) {
-                    sParameter = aParameter[index];
-                    if (count === 3) {
-                        // if 3 user actions have already been moved to the shell header, assign false to every other parameter
-                        oConfig[sParameter] = false;
-                    } else if (oConfig[sParameter]) {
-                        count++;
-                    }
+            const aParameter = [
+                "moveAppFinderActionToShellHeader",
+                "moveUserSettingsActionToShellHeader",
+                "moveContactSupportActionToShellHeader",
+                "moveEditHomePageActionToShellHeader"
+            ];
+            const oConfig = this.getViewDataConfig();
+
+            // only allow the first three actions to be moved to the shell header
+            aParameter.reduce((iCount, sParam) => {
+                if (oConfig[sParam]) {
+                    iCount++;
+                } else {
+                    oConfig[sParam] = false;
                 }
-            }
+                return iCount;
+            }, 0);
+        },
+
+        _createUserActionsMenuButton: function (oConfigModel) {
+            const oUser = Container.getUser();
+            const sTooltip = ushellResources.i18n.getText("UserActionsMenuToggleButtonAria", [oUser.getFullName() || oUser.getId()]);
+
+            const oUserActionsMenuAvatar = new Avatar({
+                id: "userActionsMenuHeaderButton",
+                src: "{configModel>/userImage/personPlaceHolder}",
+                initials: oUser.getInitials(),
+                ariaHasPopup: "Menu",
+                displaySize: AvatarSize.XS,
+                tooltip: sTooltip,
+                press: function () {
+                    EventHub.emit("showUserActionsMenu", Date.now());
+                }
+            });
+            oUserActionsMenuAvatar.setModel(oConfigModel, "configModel");
+            this.addDanglingControl(oUserActionsMenuAvatar);
+
+            StateManager.updateAllBaseStates("header.headEndItems", Operation.Add, "userActionsMenuHeaderButton");
         },
 
         /**
@@ -510,19 +526,24 @@ sap.ui.define([
         },
 
         updateShellAggregation: function (sName) {
-            var oBindingInfo = this.mBindingInfos[sName];
-            var oAggregationInfo = this.getMetadata().getJSONKeys()[sName];
-            var oClone;
+            const oBindingInfo = this.mBindingInfos[sName];
+            const oAggregationInfo = this.getMetadata().getJSONKeys()[sName];
+            const fnGet = this[oAggregationInfo._sGetter].bind(this);
+            const fnRemove = this[oAggregationInfo._sRemoveMutator].bind(this);
+            const fnUpdate = this[oAggregationInfo._sMutator].bind(this);
+
+            const aControls = fnGet() || [];
+            // make a shallow copy to avoid issues with iteration on the original array
+            [...aControls].forEach((oControlToRemove) => {
+                fnRemove(oControlToRemove);
+            });
 
-            this[oAggregationInfo._sGetter]().forEach(function (v) {
-                this[oAggregationInfo._sRemoveMutator](v);
-            }.bind(this));
-            oBindingInfo.binding.getContexts().forEach(function (v, i) {
-                oClone = oBindingInfo.factory(this.getId() + "-" + i, v)
+            oBindingInfo.binding.getContexts().forEach((v, i) => {
+                const oClone = oBindingInfo.factory(this.getId() + "-" + i, v)
                     ? oBindingInfo.factory(this.getId() + "-" + i, v).setBindingContext(v, oBindingInfo.model)
                     : "";
-                this[oAggregationInfo._sMutator](oClone);
-            }.bind(this));
+                fnUpdate(oClone);
+            });
         },
 
         /**

package/src/main/js/sap/ushell/renderers/fiori2/allMyApps/AllMyAppsManager.js

@@ -2,6 +2,7 @@
 
  /**
   * File was moved to sap/ushell/renderer/allMyApps/AllMyAppsManager
+  * @fileoverview AllMyAppsManager
   * @deprecated since 1.120.0
   */
  sap.ui.define([

package/src/main/js/sap/ushell/services/AppLifeCycle.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's AppLifeCycle service enables plug-ins to enquire the which
  *    application is currently displayed and listen to life cycle events.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/AppState.js

@@ -6,7 +6,7 @@
  * This is *not* an application facing service, but for Shell Internal usage.
  * This service should be accessed by the application via the CrossApplicationNavigation service.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ui/base/Object",

package/src/main/js/sap/ushell/services/Bookmark.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.126.1
+ * @version 1.127.1
  * @deprecated As of version 1.120
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/BookmarkV2.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bookmark service. Allows creating shortcuts on the user's home page.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ui/core/EventBus",

package/src/main/js/sap/ushell/services/ClientSideTargetResolution.js

@@ -29,7 +29,7 @@
  * In the future, the custom resolver mechanism should be probably moved towards modifying (or only adding to the list of Inbounds),
  * this way a single data source has to be altered to support consistently getLinks, isIntentSupported.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/CommonDataModel.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Exposes a CommonDataModel-based site document in a platform-neutral format to it's clients
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/_CommonDataModel/PersonalizationProcessor",
@@ -1239,19 +1239,6 @@ sap.ui.define([
             );
         };
 
-        // Recursively freezes an object.
-        var fnDeepFreeze = function (o) {
-            Object.keys(o)
-                .filter(function (sProperty) {
-                    return typeof o[sProperty] === "object";
-                })
-                .forEach(function (sProperty) {
-                    o[sProperty] = fnDeepFreeze(o[sProperty]);
-                });
-
-            return Object.freeze(o);
-        };
-
         var oPluginSets;
         return function (oPluginSetsCache) {
             if (oPluginSetsCache !== undefined) {
@@ -1325,7 +1312,7 @@ sap.ui.define([
                     }
                 }, oApplications);
 
-                return fnDeepFreeze(oPluginSets);
+                return ushellUtils.deepFreeze(oPluginSets);
             }, function (vError) {
                 return vError;
             });

package/src/main/js/sap/ushell/services/Configuration.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's Configuration service enables Components of any kind to consume parts of Configuration
  * provided by the shell. It allows to attach on updates and receive the current values
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/Config",

package/src/main/js/sap/ushell/services/ConfigurationDefaults.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Configuration Defaults service exposes default configurations set in the code base.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/ContentExtensionAdapterFactory.js

@@ -4,7 +4,7 @@
  * default adapter.
  * Once instantiated, returns a map of adapters to be used by the LaunchPage Service
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/Config",

package/src/main/js/sap/ushell/services/CrossApplicationNavigation.js

@@ -6,7 +6,7 @@
  * It exposes interfaces to perform a hash change and/or trigger an external navigation.
  *
  * @deprecated since 1.120 Please use {@link sap.ushell.services.Navigation} instead
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/ushell/services/AppConfiguration",

package/src/main/js/sap/ushell/services/DarkModeSupport.js

@@ -5,7 +5,7 @@
  *
  * The service provide dark mode support functionality
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",
@@ -113,17 +113,23 @@ sap.ui.define([
 
     /**
      * The method returns true if prefers-color-scheme query is supported and
-     * there is no the "sap-theme" parameter in URL.
+     * there is no the "sap-theme" or "sap-ui-theme" parameter in URL.
      *
      * @returns {boolean} true is when prefers-color-scheme query is supported and
-     * there is no the "sap-theme" parameter in URL.
+     * there is no the "sap-theme" or "sap-ui-theme" parameter in URL.
      *
      * @private
      */
     DarkModeSupport.prototype.canAutomaticallyToggleDarkMode = function () {
         //not all browser supported "(prefers-color-scheme: dark)" query
-        var isColorSchemeQuerySupported = this.darkMediaQueryList.media === PREFERS_DARK_COLOR_QUERY;
-        return isColorSchemeQuerySupported && !new URLSearchParams(window.location.search).get("sap-theme");
+        if (this.darkMediaQueryList.media !== PREFERS_DARK_COLOR_QUERY) {
+            return false;
+        }
+        const oUrlSearch = new URLSearchParams(window.location.search);
+        if (oUrlSearch.get("sap-theme") || oUrlSearch.get("sap-ui-theme")) {
+            return false;
+        }
+        return true;
     };
 
     /**

package/src/main/js/sap/ushell/services/Extension/Item.js

@@ -3,14 +3,14 @@
 /**
  * @fileOverview Defines a generic interface for extension items in ShellAreas.
  *
- * @version 1.126.1
+ * @version 1.127.1
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/ushell/Config"
+    "sap/ushell/state/StateManager"
 ], function (
     Log,
-    Config
+    StateManager
 ) {
     "use strict";
 
@@ -177,7 +177,7 @@ sap.ui.define([
          * @private
          */
         #getCurrentState () {
-            const sCurrentState = Config.last("/core/shell/model/currentState/stateName");
+            const sCurrentState = StateManager.getLaunchpadState();
             return sCurrentState;
         }
     }