@sapui5/sap.ushell 1.128.1 → 1.129.1

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's UI tracing service.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/ushell/EventHub",
@@ -220,8 +220,9 @@ sap.ui.define([
         this._sSiteId = (new URLSearchParams(window.location.search)).get("siteId") || Config.last("/core/site/siteId");
         this._sDeviceType = this._getDeviceType();
 
-        if (sap.ushell.Container) {
-            this._initialized = sap.ushell.Container.getFLPPlatform().then(function (sPlatform) {
+        const oUshellContainer = sap.ui.require("sap/ushell/Container");
+        if (oUshellContainer) {
+            this._initialized = oUshellContainer.getFLPPlatform().then(function (sPlatform) {
                 if (sPlatform === "MYHOME") {
                     this._sSiteType = "sap-start" + this._sSpacesPages;
                     return;
@@ -230,7 +231,7 @@ sap.ui.define([
                 // WorkzoneHome application is the root for WZ advanced content shown in Iframe.
                 // SFHost is application navigation to SF system.
                 // in future this should be based on connected providers?
-                return sap.ushell.Container.getServiceAsync("CommonDataModel").then(function (oCDMModel) {
+                return oUshellContainer.getServiceAsync("CommonDataModel").then(function (oCDMModel) {
                     oCDMModel.getApplications().then(function (mApplications) {
                         if (mApplications.SFHost) {
                             this._sSiteType = "wz-advancedhr" + this._sSpacesPages;

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

@@ -6,7 +6,7 @@
  * Service wrapper for the sap/ushell/utils/UrlShortening module.
  * @deprecated since 1.118. Please use the UrlShortening module directly.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
  sap.ui.define(["sap/ushell/utils/UrlShortening"], function (UrlShortening) {
     "use strict";

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

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/services/Ui5ComponentLoader/utils.js

@@ -3,7 +3,7 @@
  * @fileOverview Helper functions for <code>sap.ushell.services.Ui5ComponentLoader
  *  This is a shell-internal service and no public or application facing API!
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UI5 component loader service.
  * This is a shell-internal service and no public or application facing API!
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -14,7 +14,7 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -7,7 +7,7 @@
  *               This service should be accessed by the application
  *               via the CrossApplicationNavigation service.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/Log",
@@ -56,6 +56,7 @@ sap.ui.define([
      *
      * @since 1.32.0
      * @private
+     * @ui5-restricted ssuite.smartbusiness
      */
     function UserDefaultParameters (oAdapter, oContainerInterface, sParameter, oConfig) {
         this._aPlugins = []; // list of registered plugins, in order
@@ -92,9 +93,8 @@ sap.ui.define([
          *
          * @returns {object[]} amended list of plugins
          *
-         * @private
-         *
          * @since 1.32.0
+         * @private
          */
         this._insertPluginOrdered = function (aPlugins, oPlugin) {
             const prioPlugin = getPrio(oPlugin);
@@ -115,7 +115,8 @@ sap.ui.define([
         /**
          * @param {object} oPlugin the Plugin to register with the service
          *
-         * @public
+         * @private
+         * @ui5-restricted FIN UserDefaults Plugin
          */
         this.registerPlugin = function (oPlugin) {
             this._aPlugins = this._insertPluginOrdered(this._aPlugins, oPlugin);
@@ -290,6 +291,8 @@ sap.ui.define([
          * Determine whether the value is completely empty
          * @param {object} oValue value object
          * @returns {boolean} boolean indicating whether oValue represents a Never set Value
+         *
+         * @private
          */
         this._valueIsEmpty = function (oValue) {
             return !oValue || (!oValue.value && !oValue.extendedValue);
@@ -310,6 +313,8 @@ sap.ui.define([
          *   true if each member in <code>aMembersToCheck</code> has the same
          *   value in both the objects. false in case at least one member
          *   differs.
+         *
+         * @private
          */
         this._haveSameMembersValue = function (oObject1, oObject2, aMembersToCheck) {
             return aMembersToCheck.every((sRelevantMember) => {
@@ -338,6 +343,8 @@ sap.ui.define([
          *      In case there are no user default parameter names found, an empty object will be received.
          *
          *      Note: oMetadataObject is the object representation of aAllParameterNames, which is an array.
+         *
+         * @private
          */
         this._getUserDefaultParameterNames = function (systemContext) {
             if (!this._oUserDefaultParametersNames[systemContext.id]) {
@@ -363,6 +370,13 @@ sap.ui.define([
             return this._oUserDefaultParametersNames[systemContext.id];
         };
 
+        /**
+         * @param {string} sParamName The parameter name
+         * @param {object} oSystemContext The system context object
+         * @returns {boolean} true if the parameter name is supported, false otherwise
+         *
+         * @private
+         */
         this._isSupportedParameterName = async function (sParamName, oSystemContext) {
             const oResult = await this._getUserDefaultParameterNames(oSystemContext);
 
@@ -384,6 +398,8 @@ sap.ui.define([
          *      maintainable, and <code>false</code> if not.
          *      The promise will always be resolved.
          *      Note: In case an error occurs, the promise is resolved with <code>undefined</code>.
+         *
+         * @private
          */
         this.hasRelevantMaintainableParameters = async function (systemContext) {
             try {
@@ -421,6 +437,9 @@ sap.ui.define([
          *      The promise will typically always be resolved.
          *      Note: It will always return an object, the value property may be
          *      <code>undefined</code> if no value could be retrieved.
+         *
+         * @private
+         * @ui5-restricted ssuite.smartbusiness
          */
         this.getValue = async function (sParameterName, oSystemContext) {
             // Strategy is as follows
@@ -493,6 +512,13 @@ sap.ui.define([
             return oParameters;
         };
 
+        /**
+         * Converts an array of parameter names to an object with the parameter names as keys.
+         * @param {string[]} aParameterNames
+         * @returns {Object<string, object>}
+         *
+         * @private
+         */
         this._arrayToObject = function (aParameterNames) {
             const oRes = {};
             aParameterNames.forEach((sParameterName) => {
@@ -501,6 +527,12 @@ sap.ui.define([
             return oRes;
         };
 
+        /**
+         * @param {object} oPlugin a plugin.
+         * @returns {string} The name of the plugin.
+         *
+         * @private
+         */
         this._getComponentNameOfPlugin = function (oPlugin) {
             try {
                 return oPlugin.getMetadata().getComponentName() || "";
@@ -510,7 +542,6 @@ sap.ui.define([
         };
 
         /**
-         * given
          * @param {string[]} aAllParameterNames all assigned parameter names as array of strings
          * @param {string[]} aExtendedParameterNames the parameter names as array of strings
          * @param {object} oMetadataObject a raw metadata object, not yet amended by plugin data
@@ -596,64 +627,64 @@ sap.ui.define([
          *
          * The order of parameters is suitable order for parameter display.
          *
-            <pre>{
-                CostCenter: {
-                    valueObject: {
-                        "value": "1000",
-                        "noEdit": false, // filtered out
-                        "noStore": true // not relevant for editor
-                    },
-                    "editorMetadata":{
-                        "displayText": "Company code",
-                        "description": "This is the company code",
-                        "groupId": "EXAMPLE-FIN-GRP1",
-                        "groupTitle": "FIN User Defaults (UShell examples)",
-                        "parameterIndex": 2,
-                        "editorInfo": {
-                           "odataURL": "/sap/opu/odata/sap/ZFIN_USER_DEFAULTPARAMETER_SRV",
-                           "entityName": "Defaultparameter",
-                           "propertyName": "CompanyCode",
-                           "bindingPath": "/Defaultparameters('FIN')"
-                        }
-                    }
-                },
-                Plant: {
-                    valueObject: {
-                        "value": "4711",
-                        "extendedValue": {
-                            "Ranges": [
-                                {
-                                    "Sign": "I",
-                                    "Option": "EQ",
-                                    "Low": "4800",
-                                    "High": null
-                                }, {
-                                    "Sign": "I",
-                                    "Option": "BT",
-                                    "Low": "6000",
-                                    "High": "8500"
-                              }
-                           ]
-                        },
-                        "noEdit": false, // filtered out
-                        "noStore": true // not relevant for editor
-                    },
-                    "editorMetadata":{
-                        "displayText": "Company code",
-                        "description": "This is the company code",
-                        "groupId": "EXAMPLE-FIN-GRP1",
-                        "groupTitle": "FIN User Defaults (UShell examples)",
-                        "parameterIndex": 2,
-                        "extendedUsage" : true,
-                        "editorInfo": {
-                           "odataURL": "/sap/opu/odata/sap/ZFIN_USER_DEFAULTPARAMETER_SRV",
-                           "entityName": "Defaultparameter",
-                           "propertyName": "CompanyCode",
-                           "bindingPath": "/Defaultparameters('FIN')"
-                        }
-                    }
-                }
-            }</pre>
+         *  <pre>{
+         *      CostCenter: {
+         *          valueObject: {
+         *              "value": "1000",
+         *              "noEdit": false, // filtered out
+         *              "noStore": true // not relevant for editor
+         *          },
+         *          "editorMetadata":{
+         *              "displayText": "Company code",
+         *              "description": "This is the company code",
+         *              "groupId": "EXAMPLE-FIN-GRP1",
+         *              "groupTitle": "FIN User Defaults (UShell examples)",
+         *              "parameterIndex": 2,
+         *              "editorInfo": {
+         *                 "odataURL": "/sap/opu/odata/sap/ZFIN_USER_DEFAULTPARAMETER_SRV",
+         *                 "entityName": "Defaultparameter",
+         *                 "propertyName": "CompanyCode",
+         *                 "bindingPath": "/Defaultparameters('FIN')"
+         *              }
+         *          }
+         *      },
+         *      Plant: {
+         *          valueObject: {
+         *              "value": "4711",
+         *              "extendedValue": {
+         *                  "Ranges": [
+         *                      {
+         *                          "Sign": "I",
+         *                          "Option": "EQ",
+         *                          "Low": "4800",
+         *                          "High": null
+         *                      }, {
+         *                          "Sign": "I",
+         *                          "Option": "BT",
+         *                          "Low": "6000",
+         *                          "High": "8500"
+         *                    }
+         *                 ]
+         *              },
+         *              "noEdit": false, // filtered out
+         *              "noStore": true // not relevant for editor
+         *          },
+         *          "editorMetadata":{
+         *              "displayText": "Company code",
+         *              "description": "This is the company code",
+         *              "groupId": "EXAMPLE-FIN-GRP1",
+         *              "groupTitle": "FIN User Defaults (UShell examples)",
+         *              "parameterIndex": 2,
+         *              "extendedUsage" : true,
+         *              "editorInfo": {
+         *                 "odataURL": "/sap/opu/odata/sap/ZFIN_USER_DEFAULTPARAMETER_SRV",
+         *                 "entityName": "Defaultparameter",
+         *                 "propertyName": "CompanyCode",
+         *                 "bindingPath": "/Defaultparameters('FIN')"
+         *              }
+         *          }
+         *      }
+         *  }</pre>
          * the list will not contain values which have noEdit set
          *
          * Note: whether maintenance of extended User Default values is to be enabled is
@@ -668,6 +699,8 @@ sap.ui.define([
          * <code>{ value : sValueOrUndefined }</code>
          * Note: It will always return an object, the value property may be
          * undefined if no value could be retrieved.
+         *
+         * @private
          */
         this.editorGetParameters = async function (oSystemContext) {
             const oParametersAndExtendedParameters = await this._getUserDefaultParameterNames(oSystemContext);
@@ -730,7 +763,8 @@ sap.ui.define([
          *     Event handler to be attached.
          *
          * @since 1.34.0
-         * @public
+         * @private
+         * @ui5-restricted FIN UserDefaults Plugin
          */
         this.attachValueStored = function (fnFunction) {
             oStoreValueEventProvider.attachEvent(sEventNameValueStored, fnFunction);
@@ -743,7 +777,8 @@ sap.ui.define([
          *     Event handler to be detached.
          *
          * @since 1.34.0
-         * @public
+         * @private
+         * @ui5-restricted FIN UserDefaults Plugin
          */
         this.detachValueStored = function (fnFunction) {
             oStoreValueEventProvider.detachEvent(sEventNameValueStored, fnFunction);

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's user information service. Allows retrieving information about the logged-in user.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/UserRecents/RecentActivity.js

@@ -58,7 +58,7 @@ sap.ui.define([
      *
      * @private
      */
-    const RecentActivity = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentActivity", /** @lends sap.ushell.services.UserRecents.RecentActivity */ {
+    const RecentActivity = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentActivity", /** @lends sap.ushell.services.UserRecents.RecentActivity.prototype */ {
         constructor: function (maxItems) {
             UserRecentsBase.call(this, "RecentActivity", maxItems);
         }
@@ -203,7 +203,6 @@ sap.ui.define([
     RecentActivity.prototype.newItem = async function (oItem) {
         const iTimestampNow = Date.now();
         const sIcon = this._getActivityIcon(oItem.appType, oItem.icon);
-        let bAlreadyIn;
         const currentDay = this.getDayFromDate(new Date());
 
         const oRecentActivityContainer = await this._getRecentActivitiesFromLoadedData();
@@ -214,7 +213,7 @@ sap.ui.define([
             oRecentActivityContainer.recentDay = currentDay;
         }
 
-        bAlreadyIn = this._updateIfAlreadyIn(oRecentActivityContainer, oItem, iTimestampNow);
+        const bAlreadyIn = this._updateIfAlreadyIn(oRecentActivityContainer, oItem, iTimestampNow);
         if (!bAlreadyIn) {
             this._insertNew(oRecentActivityContainer, oItem, iTimestampNow, sIcon);
         }

package/src/main/js/sap/ushell/services/UserRecents/RecentAppsUsage.js

@@ -19,7 +19,7 @@ sap.ui.define([
      *
      * @private
      */
-    const RecentAppsUsage = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentAppsUsage", /** @lends sap.ushell.services.UserRecents.RecentAppsUsage */ {
+    const RecentAppsUsage = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentAppsUsage", /** @lends sap.ushell.services.UserRecents.RecentAppsUsage.prototype */ {
         constructor: function () {
             UserRecentsBase.call(this, "AppsUsage");
         }
@@ -132,7 +132,7 @@ sap.ui.define([
             iMinUsage;
         let bFirstHashUsage = true;
 
-        for (let sHash in this.oAppsUsageData.recentAppsUsageMap) {
+        for (const sHash in this.oAppsUsageData.recentAppsUsageMap) {
             oUsageMap[sHash] = this._getHashUsageSum(sHash);
             if (bFirstHashUsage) {
                 iMaxUsage = iMinUsage = oUsageMap[sHash];
@@ -158,7 +158,7 @@ sap.ui.define([
      */
     RecentAppsUsage.prototype._addNewDay = function () {
         let aAppUsageArray;
-        for (let sHash in this.oAppsUsageData.recentAppsUsageMap) {
+        for (const sHash in this.oAppsUsageData.recentAppsUsageMap) {
             // Get the array of app/hash usage
             aAppUsageArray = this.oAppsUsageData.recentAppsUsageMap[sHash];
 
@@ -180,7 +180,7 @@ sap.ui.define([
     RecentAppsUsage.prototype._cleanUnusedHashes = function () {
         let iUsages;
 
-        for (let sHash in this.oAppsUsageData.recentAppsUsageMap) {
+        for (const sHash in this.oAppsUsageData.recentAppsUsageMap) {
             iUsages = this._getHashUsageSum(sHash);
 
             if (iUsages === 0) {

package/src/main/js/sap/ushell/services/UserRecents/RecentsList.js

@@ -25,7 +25,7 @@ sap.ui.define([
      *
      * @private
      */
-    const RecentsList = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentsList", /** @lends sap.ushell.services.UserRecents.RecentsList */ {
+    const RecentsList = UserRecentsBase.extend("sap.ushell.services.UserRecents.RecentsList", /** @lends sap.ushell.services.UserRecents.RecentsList.prototype */ {
         constructor: function (personalizationItemName, maxItems, compareItems) {
             UserRecentsBase.apply(this, arguments);
 

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's user activity service.
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

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

@@ -7,7 +7,7 @@
  *
  * Configured with the LaunchPageAdapter.
  *
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/ushell/resources",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.128.1
+ * @version 1.129.1
  */
 sap.ui.define([
     "sap/ushell/ui/launchpad/VizInstance",
@@ -64,7 +64,7 @@ sap.ui.define([
      * @since 1.77
      *
      * @private
-     * @ui5-restricted sap.esh.search.ui
+     * @ui5-restricted sap.esh.search.ui, ux.eng.s4producthomes1
      */
     VisualizationInstantiation.prototype.instantiateVisualization = function (vizData) {
         var oVizInstance;

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/ContentExtensionAdapterConfig.js

@@ -7,7 +7,7 @@
  *  config handler which is called by the factory to generate an explicit
  *  Adapter configuration
  *
- * @version 1.128.1
+ * @version 1.129.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_ContentExtensionAdapterFactory/FeaturedGroupConfig.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provide mock feature group data
  *
- * @version 1.128.1
+ * @version 1.129.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_CrossApplicationNavigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Cross Application Navigation utility functions
  *
- * @version 1.128.1
+ * @version 1.129.1
  * @deprecated since 1.120.0
  */
 

package/src/main/js/sap/ushell/services/_PageReferencing/PageReferencer.js

@@ -4,7 +4,7 @@
  * @file This module is responsible to create reference pages,
  * which are shareable JSON representations of layout and navigation targets in the specific format.
  *
- * @version 1.128.1
+ * @version 1.129.1
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/state/BindingHelper.js

@@ -0,0 +1,79 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ui/core/Element"
+], function (
+    Element
+) {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.state.BindingHelper
+     * @namespace
+     * @description Helper class for bindings on control references
+     *
+     * @since 1.129.0
+     * @private
+     */
+    class BindingHelper {
+
+        /**
+         * Overrides the original updateAggregation method of the control
+         * For updates on any aggregation, the aggregation items are removed instead of being destroyed.
+         * This allows to bind references to controls which cannot be recreated in a factory.
+         * @param {sap.ui.core.Control} oControl The control to override the updateAggregation method
+         *
+         * @since 1.129.0
+         * @private
+         */
+        overrideUpdateAggregation (oControl) {
+            oControl.updateAggregation = this.#updateAggregation;
+        }
+
+        /**
+         * Custom aggregation update handler.
+         * Removes aggregation items instead of destroying them.
+         * @param {string} sName Aggregation name.
+         *
+         * @since 1.129.0
+         * @private
+         */
+        #updateAggregation (sName) {
+            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);
+            });
+
+            oBindingInfo.binding.getContexts().forEach((v, i) => {
+                const oClone = oBindingInfo.factory(this.getId() + "-" + i, v)
+                    ? oBindingInfo.factory(this.getId() + "-" + i, v).setBindingContext(v, oBindingInfo.model)
+                    : "";
+                fnUpdate(oClone);
+            });
+        }
+
+        /**
+         * Item factory for {@link sap.ushell.state.BindingHelper#overrideUpdateAggregation}.
+         * Returns the referenced control.
+         * @param {sap.ui.core.ID} sId The Control ID.
+         * @param {sap.ui.model.Context} oContext UI5 context.
+         * @returns {sap.ui.core.Control} The control.
+         *
+         * @since 1.129.0
+         * @private
+         */
+        factory (sId, oContext) {
+            return Element.getElementById(oContext.getObject());
+        }
+    }
+
+    return new BindingHelper();
+
+});

package/src/main/js/sap/ushell/state/StateManager.js

@@ -87,6 +87,8 @@ sap.ui.define([
             },
             floatingContainer: {
                 visible: false,
+                state: "floating",
+                dragSelector: "",
                 items: []
             },
             userActions: {
@@ -668,7 +670,7 @@ sap.ui.define([
          * @alias sap.ushell.state.StateManager#isLegacyHome
          */
         isLegacyHome () {
-            if (this.#sLaunchpadState !== LaunchpadState.Home) {
+            if (this.getLaunchpadState() !== LaunchpadState.Home) {
                 return false;
             }
 
@@ -681,7 +683,7 @@ sap.ui.define([
                 Minimal
             ];
 
-            return aUnmappedHomeStates.includes(this.#sShellMode);
+            return aUnmappedHomeStates.includes(this.getShellMode());
         }
     }