@sapui5/sap.ushell 1.123.1 → 1.124.1

package/src/main/js/sap/ushell/bootstrap/common/common.read.ushell.config.from.url.js

@@ -94,10 +94,18 @@ sap.ui.define([
         return sValue;
     }
 
+    /*
+     * Example usages of "sap-ushell-xx-overwrite-config":
+     *   ?sap-ushell-xx-overwrite-config=renderers/fiori2/componentData/config/enablePersonalization:false
+     *   ?sap-ushell-xx-overwrite-config=ushell/spaces/enabled:false,ushell/spaces/configurable:false
+     *   ?sap-ushell-xx-overwrite-config=startupConfig/spacesMyhome:false,ushell/homeApp/component:false
+     *   ?sap-ushell-xx-overwrite-config=
+     *   ushell/companyLogo/url:data\:image/png;base64\,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
+     */
     function getConfigFromWindowLocation (oWindowLocation) {
         var aParsedQueryParamValue;
         var oFinalConfig = {};
-        // To conform with the specification of the query string ("application/x-www-form-urlencoded")
+        // to conform with the specification of the query string ("application/x-www-form-urlencoded")
         // see: https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1
         var sQueryString = oWindowLocation.search.replaceAll("+", " ");
 
@@ -107,11 +115,19 @@ sap.ui.define([
             return {};
         }
 
-        // multiple entries can be overwritten at the same time, so split them
-        var aOverwrittenEntryCandidates = decodeURIComponent(aParsedQueryParamValue[1]).split(",");
+        // commas (",") can be used to overwrite multiple "parameter:value" pairs at the same time
+        // the negative lookbehind is to allow commas to be escaped with a backslash ("\")
+        var aOverwrittenEntryCandidates = decodeURIComponent(aParsedQueryParamValue[1])
+            .split(/(?<!\\),/)
+            .map(sOverwrittenEntryCandidate => sOverwrittenEntryCandidate.replaceAll("\\,", ","));
 
         var aOverwrittenEntries = aOverwrittenEntryCandidates.reduce(function (aEntries, sCandidate) {
-            var aParts = sCandidate.split(":");
+            // a colon (":") is used to separate each parameter from its value within each "parameter:value" pair
+            // the negative lookbehind is to allow colons to be escaped with a backslash ("\")
+            var aParts = sCandidate
+                .split(/(?<!\\):/)
+                .map(sPart => sPart.replaceAll("\\:", ":"));
+
             // namespaces may contain a leading "/" (e.g. for "sap-ui-debug")
             var aNamespaceParts = /^\/?(.*)\/([^/]*)$/.exec(aParts[0]);
             if (aNamespaceParts === null) {
@@ -146,7 +162,6 @@ sap.ui.define([
                 oNamespace = ObjectPath.get(sNamespace, oFinalConfig);
             }
 
-            //To be decided: support JSON properties?
             oNamespace[oOverwrite.propertyName] = vValue;
         });
 

package/src/main/js/sap/ushell/bootstrap/sandbox2.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's bootstrap code for development sandbox scenarios.
  * This is the version that creates spaces/pages runtime environment.
  *
- * @version 1.123.1
+ * @version 1.124.1
  */
 
 /* eslint-disable quote-props */

package/src/main/js/sap/ushell/components/CatalogsManager.js

@@ -767,17 +767,9 @@ sap.ui.define([
             oResultPromise.done(function (oTile) {
                 var aGroups = that.oModel.getProperty("/groups");
                 var sGroupPath = GroupsHelper.getModelPathOfGroup(aGroups, sGroupId);
-                var sTileTitle = that.oLaunchPageService.getTileTitle(oTile);
 
                 that.oHomepageManager.addTileToGroup(sGroupPath, oTile);
                 oResponseData = { group: oGroup, status: 1, action: "add" }; // 1 - success
-                sap.ushell.Container.getServiceAsync("UsageAnalytics").then(function (oUsageAnalytics) {
-                    oUsageAnalytics.logCustomEvent(
-                        that.analyticsConstants.PERSONALIZATION,
-                        that.analyticsConstants.ADD_TILE,
-                        [oGroup.title, sTileTitle]
-                    );
-                });
                 oDeferred.resolve(oResponseData);
             }).fail(function () {
                 MessagingHelper.showLocalizedError("fail_to_add_tile_msg");

package/src/main/js/sap/ushell/components/HeaderManager.js

@@ -4,6 +4,7 @@ sap.ui.define([
     "sap/base/util/ObjectPath",
     "sap/ui/Device",
     "sap/ui/core/Element",
+    "sap/ushell/api/NewExperience",
     "sap/ushell/components/_HeaderManager/PropertyStrategiesFactory",
     "sap/ushell/components/StateHelper",
     "sap/ushell/Config",
@@ -14,6 +15,7 @@ sap.ui.define([
     ObjectPath,
     Device,
     Element,
+    NewExperience,
     _PropertyStrategiesFactory,
     StateHelper,
     Config,
@@ -128,6 +130,8 @@ sap.ui.define([
         // Overflow must be checked each time when a button is added to the header:
         aDoables.push(Config.on("/core/shellHeader/headEndItems").do(handleEndItemsOverflow));
         aDoables.push(Config.on("/core/shell/model/currentSpaceAndPage").do(handleCurrentSpaceAndPage));
+
+        NewExperience.attachActiveChanged(_handleHeaderResize);
     }
 
     function _unSubscribeFromEvents () {
@@ -137,6 +141,7 @@ sap.ui.define([
             });
         }
         Device.media.detachHandler(_handleHeaderResize, this, Device.media.RANGESETS.SAP_STANDARD);
+        NewExperience.detachActiveChanged(_handleHeaderResize);
     }
 
     function _handleHeaderResize (oParams) {
@@ -185,6 +190,32 @@ sap.ui.define([
         }
     }
 
+    /**
+     * Moves the new experience button into the overflow area.
+     *
+     * @since 1.124.0
+     * @private
+     */
+    function moveNewExperienceToOverflow () {
+        if (NewExperience.isActive()) {
+            addHeaderEndItem([NewExperience.getOverflowItemId()], false, ["home", "app"]);
+        }
+        NewExperience.showInOverflow();
+    }
+
+    /**
+     * Moves the new experience button into the shell header.
+     *
+     * @since 1.124.0
+     * @private
+     */
+    function moveNewExperienceToShellHeader () {
+        if (NewExperience.isActive()) {
+            removeHeaderEndItem([NewExperience.getOverflowItemId()], false, ["home", "app"]);
+        }
+        NewExperience.showInShellHeader();
+    }
+
     /**
      * Logic to determine if the headEndItemsOverflow button should be visible.
      * Overflow button is shown only when oParams.name or sCurrentRangeName is "Phone".
@@ -196,17 +227,29 @@ sap.ui.define([
         var bIsOverflowVisible = aEndItems.indexOf(sOverflowID) > -1;
         var sDeviceType = oParams && oParams.name || sCurrentRangeName;
 
-        if (sDeviceType === "Phone" && !bIsOverflowVisible && aEndItems.length > 2) {
+        if (sDeviceType === "Phone" && (NewExperience.isActive() || (!bIsOverflowVisible && aEndItems.length > 2))) {
             // Show overflow if more than two buttons are in the header
+            // and show overflow always in case of New Experience
             addHeaderEndItem([sOverflowID], false, ["home", "app"]);
+
+            moveNewExperienceToOverflow();
+
         } else if (sDeviceType !== "Phone" && bIsOverflowVisible) {
             // Destroy the popover to avoid duplicate elements ids in the DOM
             // and to ensure the endItems are rendered correctly in the header
             var oPopover = Element.getElementById("headEndItemsOverflow");
             if (oPopover) {
+                if (NewExperience.isActive()) {
+                    const oItem = NewExperience.getOverflowItemControl();
+                    // try to remove the item from the parent
+                    // because we want to reuse the control in the next call
+                    oItem.getParent()?.removeItem?.(oItem);
+                }
                 oPopover.destroy();
             }
             removeHeaderEndItem([sOverflowID], false, ["home", "app"]);
+
+            moveNewExperienceToShellHeader();
         }
     }
 

package/src/main/js/sap/ushell/components/SharedComponentUtils.js

@@ -112,8 +112,8 @@ sap.ui.define([
                 .then(function (oPersonalizationService) {
                     var oOwnerComponent = Component.getOwnerComponentFor(oComponent);
                     var oScope = {
-                        keyCategory: oPersonalizationService.constants.keyCategory.FIXED_KEY,
-                        writeFrequency: oPersonalizationService.constants.writeFrequency.LOW,
+                        keyCategory: oPersonalizationService.KeyCategory.FIXED_KEY,
+                        writeFrequency: oPersonalizationService.WriteFrequency.LOW,
                         clientStorageAllowed: true
                     };
                     var oPersId = {

package/src/main/js/sap/ushell/components/_HeaderManager/AddHeadEndItemsStrategy.js

@@ -2,8 +2,13 @@
 
 sap.ui.define([
     "sap/base/Log",
-    "sap/ui/core/Element"
-], function (Log, Element) {
+    "sap/ui/core/Element",
+    "sap/ushell/api/NewExperience"
+], function (
+    Log,
+    Element,
+    NewExperience
+) {
     "use strict";
 
     function fnValidateAddingHeadEndItems (aExistingIds, aIdsToAdd) {
@@ -69,6 +74,7 @@ sap.ui.define([
             "userActionsMenuHeaderButton": 3,
             "productSwitchBtn": 4
         };
+        oScale[NewExperience.getOverflowItemId()] = -4;
 
         aNewItems.sort((a, b) => {
             var iAScale = oScale[a] || 0,

package/src/main/js/sap/ushell/components/_HeaderManager/ShellHeader.controller.js

@@ -6,6 +6,7 @@ sap.ui.define([
     "sap/ui/core/mvc/Controller",
     "sap/ui/Device",
     "sap/ui/model/json/JSONModel",
+    "sap/ushell/api/NewExperience",
     "sap/ushell/components/applicationIntegration/AppLifeCycle",
     "sap/ushell/Config",
     "sap/ushell/EventHub",
@@ -17,6 +18,7 @@ sap.ui.define([
     Controller,
     Device,
     JsonModel,
+    NewExperience,
     AppLifeCycle,
     Config,
     EventHub,
@@ -77,6 +79,10 @@ sap.ui.define([
                     oPopover = popover;
                     var oPopoverList = Element.getElementById("headEndItemsOverflowList");
                     oPopoverList.enhanceAccessibilityState = function (oOverflowListItem, mAriaProps) {
+                        if (!oOverflowListItem.isA("sap.ushell.ui.shell.OverflowListItem")) {
+                            return mAriaProps;
+                        }
+
                         if (oOverflowListItem.getFloatingNumberType() !== FloatingNumberType.None) {
                             mAriaProps.describedby = oOverflowListItem._oAriaDescribedbyText.getId();
                         }
@@ -106,11 +112,16 @@ sap.ui.define([
         },
 
         headEndItemsOverflowItemFactory: function (sId, oContext) {
+            if (NewExperience.isActive() && oContext.getObject() === NewExperience.getOverflowItemId()) {
+                return NewExperience.getOverflowItemControl();
+            }
+
             var oShellHeadItem = Element.getElementById(oContext.getObject());
+
             var sFloatingNumberBindingPath = oShellHeadItem.getBindingPath("floatingNumber");
             var sText = oShellHeadItem.getText();
             var sTooltip = oShellHeadItem.getTooltip();
-            var oOveflowListItem = new OverflowListItem({
+            var oOverflowListItem = new OverflowListItem({
                 id: sId + "-" + oShellHeadItem.getId(),
                 icon: oShellHeadItem.getIcon(),
                 iconInset: true,
@@ -140,15 +151,21 @@ sap.ui.define([
             });
             // Add aria label for the New Dsign list item
             if (oShellHeadItem._oAriaLabel) {
-                oOveflowListItem.addAriaLabelledBy(oShellHeadItem._oAriaLabel);
+                oOverflowListItem.addAriaLabelledBy(oShellHeadItem._oAriaLabel);
             }
             if (sFloatingNumberBindingPath) {
-                oOveflowListItem.setModel(oShellHeadItem.getModel());
+                oOverflowListItem.setModel(oShellHeadItem.getModel());
             }
-            return oOveflowListItem;
+            return oOverflowListItem;
         },
 
         destroyHeadEndItemsOverflow: function (oEvent) {
+            if (NewExperience.isActive()) {
+                const oItem = NewExperience.getOverflowItemControl();
+                // try to remove the item from the parent
+                // because we want to reuse the control in the next call
+                oItem.getParent()?.removeItem?.(oItem);
+            }
             oEvent.getSource().destroy();
         },
 

package/src/main/js/sap/ushell/components/_HomepageManager/PersistentPageOperationAdapter.js

@@ -36,23 +36,6 @@ sap.ui.define([
     // shortcut for sap.m.LoadState
     var LoadState = mobileLibrary.LoadState;
 
-    var analyticsConstants = {
-        PERSONALIZATION: "FLP: Personalization",
-        RENAME_GROUP: "FLP: Rename Group",
-        MOVE_GROUP: "FLP: Move Group",
-        DELETE_GROUP: "FLP: Delete Group",
-        RESET_GROUP: "FLP: Reset Group",
-        DELETE_TILE: "FLP: Delete Tile",
-        ADD_TILE: "FLP: Add Tile",
-        MOVE_TILE: "FLP: Move Tile"
-    };
-
-    function _logUsageAnalytics (sEvent, aParams) {
-        sap.ushell.Container.getServiceAsync("UsageAnalytics").then(function (oUsageAnalyticsService) {
-            oUsageAnalyticsService.logCustomEvent(analyticsConstants.PERSONALIZATION, sEvent, aParams);
-        });
-    }
-
     var PersistentPageOperationAdapter = BaseObject.extend("sap.ushell.components._HomepageManager.PersistentPageOperationAdapter", {
         constructor: function (oLaunchPageService) {
             BaseObject.call(this);
@@ -324,8 +307,6 @@ sap.ui.define([
                     if (iGroupIndex === undefined) {
                         that.oPageBuilderService.addGroup(oGroupModel.title)
                             .done(function (oNewServerGroupObject) {
-                                var sGroupId = that.oPageBuilderService.getGroupId(oNewServerGroupObject);
-                                _logUsageAnalytics(analyticsConstants.RENAME_GROUP, [null, oGroupModel.title, sGroupId]);
                                 resolve(
                                     that.getPreparedGroupModel(
                                         oNewServerGroupObject,
@@ -339,8 +320,6 @@ sap.ui.define([
                     } else {
                         that.oPageBuilderService.addGroupAt(oGroupModel.title, iGroupIndex)
                             .done(function (oNewServerGroupObject) {
-                                var sGroupId = that.oPageBuilderService.getGroupId(oNewServerGroupObject);
-                                _logUsageAnalytics(analyticsConstants.RENAME_GROUP, [null, oGroupModel.title, sGroupId]);
                                 resolve(
                                     that.getPreparedGroupModel(
                                         oNewServerGroupObject,
@@ -364,8 +343,6 @@ sap.ui.define([
                 try {
                     that.oPageBuilderService.setGroupTitle(oGroupModel.object, sNewTitle)
                         .done(function () {
-                            var sGroupOriginalId = that.oPageBuilderService.getGroupId(oGroupModel.object);
-                            _logUsageAnalytics(analyticsConstants.RENAME_GROUP, [sOldTitle, sNewTitle, sGroupOriginalId]);
                             resolve();
                         })
                         .fail(reject);
@@ -377,15 +354,12 @@ sap.ui.define([
 
         deleteGroup: function (oGroupModel) {
             var that = this,
-                oServerGroupObject = oGroupModel.object,
-                sGroupObjectId = this.oPageBuilderService.getGroupId(oServerGroupObject),
-                sGroupName = this.oPageBuilderService.getGroupTitle(oServerGroupObject);
+                oServerGroupObject = oGroupModel.object;
 
             return new Promise(function (resolve, reject) {
                 try {
                     that.oPageBuilderService.removeGroup(oServerGroupObject)
                         .done(function () {
-                            _logUsageAnalytics(analyticsConstants.DELETE_GROUP, [sGroupName, sGroupObjectId]);
                             resolve();
                         })
                         .fail(reject);
@@ -401,14 +375,6 @@ sap.ui.define([
                 try {
                     that.oPageBuilderService.moveGroup(oGroupModel.object, iToIndex)
                         .done(function () {
-                            var sGroupId = that.oPageBuilderService.getGroupId(oGroupModel.object);
-                            _logUsageAnalytics(
-                                analyticsConstants.MOVE_GROUP,
-                                [oGroupModel.title,
-                                oIndicesInModel.iFromIndex,
-                                oIndicesInModel.iToIndex,
-                                    sGroupId]
-                            );
                             resolve();
                         })
                         .fail(reject);
@@ -420,15 +386,12 @@ sap.ui.define([
 
         resetGroup: function (oGroupModel, bIsDefaultGroup) {
             var that = this,
-                oServerGroupObject = oGroupModel.object,
-                sGroupObjectId = this.oPageBuilderService.getGroupId(oServerGroupObject),
-                sGroupTitle = this.oPageBuilderService.getGroupTitle(oServerGroupObject);
+                oServerGroupObject = oGroupModel.object;
 
             return new Promise(function (resolve, reject) {
                 try {
                     that.oPageBuilderService.resetGroup(oServerGroupObject)
                         .done(function (oResetedServerObject) {
-                            _logUsageAnalytics(analyticsConstants.RESET_GROUP, [sGroupTitle, sGroupObjectId]);
                             resolve(
                                 that.getPreparedGroupModel(
                                     oResetedServerObject || oServerGroupObject,
@@ -533,13 +496,6 @@ sap.ui.define([
                             sType
                         );
                         oResultPromise.done(function (oTargetTile) {
-                            var aUsageAnalyticsCustomProps = [
-                                that.oPageBuilderService.getTileTitle(oTileModel.object),
-                                that.oPageBuilderService.getGroupTitle(oSourceGroup.object),
-                                that.oPageBuilderService.getGroupTitle(oTargetGroup.object),
-                                oTileModel.uuid
-                            ];
-                            _logUsageAnalytics(analyticsConstants.MOVE_TILE, aUsageAnalyticsCustomProps);
                             oServerTileObject = oTargetTile;
                             resolve(oTargetTile);
                         });
@@ -561,9 +517,6 @@ sap.ui.define([
             var that = this,
                 oServerTileObject = oTileModel.object,
                 sTileName = that.oPageBuilderService.getTileTitle(oServerTileObject),
-                sCatalogTileId = that.oPageBuilderService.getCatalogTileId(oServerTileObject),
-                sCatalogTileTitle = that.oPageBuilderService.getCatalogTileTitle(oServerTileObject),
-                sTileRealId = that.oPageBuilderService.getTileId(oServerTileObject),
                 oPromise;
             oPromise = new Promise(function (resolve, reject) {
                 try {
@@ -571,14 +524,6 @@ sap.ui.define([
                         .done(
                             function () {
                                 oMessagingHelper.showLocalizedMessage("tile_deleted_msg", [sTileName, oGroupModel.title]);
-                                _logUsageAnalytics(
-                                    analyticsConstants.DELETE_TILE,
-                                    [sTileName || sTileRealId,
-                                        sCatalogTileId,
-                                        sCatalogTileTitle,
-                                    oGroupModel.title
-                                    ]
-                                );
                                 resolve();
                             })
                         .fail(reject);

package/src/main/js/sap/ushell/components/appfinder/HierarchyFolders.controller.js

@@ -61,8 +61,8 @@ sap.ui.define([
                     .then(function (oPersonalizationService) {
                         var oComponent = Component.getOwnerComponentFor(this),
                         oScope = {
-                            keyCategory: oPersonalizationService.constants.keyCategory.FIXED_KEY,
-                            writeFrequency: oPersonalizationService.constants.writeFrequency.LOW,
+                            keyCategory: oPersonalizationService.KeyCategory.FIXED_KEY,
+                            writeFrequency: oPersonalizationService.WriteFrequency.LOW,
                             clientStorageAllowed: true
                         },
                         oPersId = {

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

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

package/src/main/js/sap/ushell/components/applicationIntegration/AppLifeCycle.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.123.1
+ * @version 1.124.1
  */
 sap.ui.define([
     "sap/ui/core/Element",
@@ -72,6 +72,7 @@ sap.ui.define([
             oShellUIService,
             appState,
             disableHomeAppCache = false,
+            bEnableRouterRetrigger = true,
             oCurrentApplication = {},
             oActualElementsModelStateMap = {
                 home: {
@@ -461,7 +462,7 @@ sap.ui.define([
                     keepAliveMode: oKeepAliveMode && (oKeepAliveMode.globalValue || oKeepAliveMode.paramValue),
                     appTarget: oTarget,
                     ui5ComponentName: oTarget && oTarget.ui5ComponentName,
-                    enableRouterRetrigger: true,
+                    enableRouterRetrigger: bEnableRouterRetrigger,
                     stateStored: false
                 });
                 return true;
@@ -707,6 +708,9 @@ sap.ui.define([
                     EventHub.on("disableKeepAliveRestoreRouterRetrigger").do(function (oData) {
                         var sIntent = oData.intent.semanticObject + "-" + oData.intent.action;
                         var sAppId = "application-" + sIntent;
+
+                        bEnableRouterRetrigger = oData.disable;
+
                         if (Storage.get(sAppId)) {
                             Storage.get(sAppId).enableRouterRetrigger = oData.disable;
                         }

package/src/main/js/sap/ushell/components/applicationIntegration/application/Application.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.123.1
+ * @version 1.124.1
  */
 sap.ui.define([
     "sap/ui/core/EventBus",

package/src/main/js/sap/ushell/components/applicationIntegration/application/BlueBoxHandler.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.123.1
+ * @version 1.124.1
  */
 sap.ui.define([
     "sap/ui/core/EventBus",