@sapui5/sap.ushell 1.125.0 → 1.126.0

package/src/main/js/sap/ushell/services/_ClientSideTargetResolution/XAppStateProcessing.js

@@ -6,31 +6,31 @@
  * Operations in this module are assumed to be executed after the target mapping has been identified (post search).
  *
  * @private
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/services/_ClientSideTargetResolution/Utils",
-    "sap/ui/thirdparty/jquery",
     "sap/base/util/ObjectPath",
     "sap/base/util/isEmptyObject",
     "sap/base/util/isPlainObject",
     "sap/fe/navigation/SelectionVariant",
-    "sap/base/Log"
+    "sap/base/Log",
+    "sap/ushell/utils"
 ], function (
-    oCSTRUtils,
-    jQuery,
+    CstrUtils,
     ObjectPath,
     isEmptyObject,
     isPlainObject,
     SelectionVariant,
-    Log
+    Log,
+    ushellUtils
 ) {
     "use strict";
 
     /**
      * This method modifies a passed Application State if extended User Defaults are to be merged with an AppState or renaming takes place.
      *
-     * It also *always* takes care of renaming parameters (generating mappedDefauledParamNames)
+     * It also *always* takes care of renaming parameters (generating mappedDefaultedParamNames)
      * Thus it must be invoked in the flow even for targets which do not deal with appstate
      *
      * If one or more extended user default values are present, they will be added to a new AppState unless already present
@@ -66,13 +66,12 @@ sap.ui.define([
      *
      * @param {object} oMatchingTarget One of the objects returned by {@link #_getMatchingInbounds}.
      * @param {object} oAppStateService the app state service instance
-     * @returns {jQuery.Promise} Resolves the mixed resolution result.
+     * @returns {Promise<object>} Resolves the mixed resolution result.
      * @private
      * @since 1.34.0
      */
-    function mixAppStateIntoResolutionResultAndRename (oMatchingTarget, oAppStateService) {
-        var oDeferred = new jQuery.Deferred(),
-            oNewAppState,
+    async function mixAppStateIntoResolutionResultAndRename (oMatchingTarget, oAppStateService) {
+        var oNewAppState,
             oResolutionResult = oMatchingTarget.resolutionResult,
             oSignature = oMatchingTarget.inbound && (oMatchingTarget.inbound.signature || {}),
             bChangeExistingAppState = hasExtendedUserDefaults(oResolutionResult)
@@ -80,60 +79,59 @@ sap.ui.define([
                 || hasRenameTo(oMatchingTarget);
 
         if (!bChangeExistingAppState) {
-            cleanupAndResolve(oDeferred, oMatchingTarget);
-            return oDeferred.promise();
+            cleanup(oMatchingTarget);
+            return oMatchingTarget;
         }
 
         var sSourceAppStateKey = oMatchingTarget.intentParamsPlusAllDefaults["sap-xapp-state"]
             && oMatchingTarget.intentParamsPlusAllDefaults["sap-xapp-state"][0];
         if (sSourceAppStateKey) {
-            getAppStateData(oAppStateService, sSourceAppStateKey)
-                .then(checkValidAppStateData)
-                .then(function (oValidAppStateData) {
-                    if (hasExtendedUserDefaults(oResolutionResult)) {
-                        var oParameterDominatorMap = oCSTRUtils.constructParameterDominatorMap(oSignature.parameters);
-                        Object.keys(oResolutionResult.oNewAppStateMembers).forEach(function (sAppStateMemberName) {
-                            var aDominatorParams = oParameterDominatorMap[sAppStateMemberName].dominatedBy;
-                            if (isParameterContainedInSelectionVariant(oValidAppStateData, aDominatorParams)) {
-                                delete oResolutionResult.oNewAppStateMembers[sAppStateMemberName];
-                            }
-                        });
-                    }
-
-                    var bIgnoreAdditionalParameters = oSignature.additionalParameters === "ignored";
-                    if (!hasExtendedUserDefaults(oResolutionResult) && !hasRenameTo(oMatchingTarget) && !bIgnoreAdditionalParameters) {
-                        // keep old AppState
-                        cleanupAndResolve(oDeferred, oMatchingTarget);
-                        return;
-                    }
-
-                    oNewAppState = oAppStateService.createEmptyAppState(undefined, true);
-                    if (oNewAppState) {
-                        oNewAppState.setData(oValidAppStateData);
-                        _mergeAppState(oNewAppState, oMatchingTarget, oDeferred);
-                    }
-                }, function () { // invalid app state data
-                    delete oResolutionResult.oNewAppStateMembers; // remove all extended user defaults
-                    cleanupAndResolve(oDeferred, oMatchingTarget); // keep old app state
-                    return;
-                });
-
-            return oDeferred.promise();
+            const oAppStateData = await getAppStateData(oAppStateService, sSourceAppStateKey);
+
+            if (isValidAppStateData(oAppStateData)) {
+                if (hasExtendedUserDefaults(oResolutionResult)) {
+                    var oParameterDominatorMap = CstrUtils.constructParameterDominatorMap(oSignature.parameters);
+                    Object.keys(oResolutionResult.oNewAppStateMembers).forEach(function (sAppStateMemberName) {
+                        var aDominatorParams = oParameterDominatorMap[sAppStateMemberName].dominatedBy;
+                        if (isParameterContainedInSelectionVariant(oAppStateData, aDominatorParams)) {
+                            delete oResolutionResult.oNewAppStateMembers[sAppStateMemberName];
+                        }
+                    });
+                }
+
+                var bIgnoreAdditionalParameters = oSignature.additionalParameters === "ignored";
+                if (!hasExtendedUserDefaults(oResolutionResult) && !hasRenameTo(oMatchingTarget) && !bIgnoreAdditionalParameters) {
+                    // keep old AppState
+                    cleanup(oMatchingTarget);
+                    return oMatchingTarget;
+                }
+
+                oNewAppState = oAppStateService.createEmptyAppState(undefined, true);
+                if (oNewAppState) {
+                    oNewAppState.setData(oAppStateData);
+                    await _mergeAppState(oNewAppState, oMatchingTarget);
+                    return oMatchingTarget;
+                }
+
+            } else { // invalid app state data
+                delete oResolutionResult.oNewAppStateMembers; // remove all extended user defaults
+                cleanup(oMatchingTarget); // keep old app state
+                return oMatchingTarget;
+            }
         }
 
         if (hasExtendedUserDefaults(oResolutionResult)) {
             var oEmptyAppState = oAppStateService.createEmptyAppState(undefined, true);
-            _mergeAppState(oEmptyAppState, oMatchingTarget, oDeferred);
-            return oDeferred.promise();
+            await _mergeAppState(oEmptyAppState, oMatchingTarget);
+            return oMatchingTarget;
         }
 
         // no need to rename in nonexisting appstate
-        cleanupAndResolve(oDeferred, oMatchingTarget);
-
-        return oDeferred.promise();
+        cleanup(oMatchingTarget);
+        return oMatchingTarget;
     }
 
-    function _mergeAppState (oNewAppState0, oMatchingTarget, oDeferred) {
+    async function _mergeAppState (oNewAppState0, oMatchingTarget) {
         // at this point, oNewAppState Members only contains members which are to be added!
         // (there should be no collisions!)
         var oNewAppStateData = oNewAppState0.getData() || {},
@@ -163,24 +161,24 @@ sap.ui.define([
 
         if (!oChangeRecorder.changed && !oChangeRecorder.deleted && !hasExtendedUserDefaults(oResolutionResult)) {
             // there was no effective change -> retain old appstate
-            cleanupAndResolve(oDeferred, oMatchingTarget);
+            cleanup(oMatchingTarget);
             return;
         }
+
         oNewAppState0.setData(oNewAppStateData);
-        oNewAppState0.save().done(function () {
-            oMatchingTarget.intentParamsPlusAllDefaults["sap-xapp-state"] = [oNewAppState0.getKey()];
-            oMatchingTarget.mappedIntentParamsPlusSimpleDefaults["sap-xapp-state"] = [oNewAppState0.getKey()];
-            cleanupAndResolve(oDeferred, oMatchingTarget);
-        });
+        await ushellUtils.promisify(oNewAppState0.save());
+
+        oMatchingTarget.intentParamsPlusAllDefaults["sap-xapp-state"] = [oNewAppState0.getKey()];
+        oMatchingTarget.mappedIntentParamsPlusSimpleDefaults["sap-xapp-state"] = [oNewAppState0.getKey()];
+        cleanup(oMatchingTarget);
     }
 
-    function cleanupAndResolve (oDeferred, oMatchingTarget) {
+    function cleanup (oMatchingTarget) {
         removeUnusedComplexParameterValuesFromDefaultList(oMatchingTarget);
         mapDefaultParameterNames(oMatchingTarget);
 
         // remove oNewAppStateMembers as it is not needed afterwards anymore
         delete oMatchingTarget.resolutionResult.oNewAppStateMembers;
-        oDeferred.resolve(oMatchingTarget);
     }
 
     function hasExtendedUserDefaults (oResolutionResult) {
@@ -287,17 +285,14 @@ sap.ui.define([
         return oSelectionVariant;
     }
 
-    function isInvalidAppStateData (oData) {
-        if (oData === undefined || isPlainObject(oData)) {
-            return false;
-        }
-        return true;
+    function isValidAppStateData (oData) {
+        return oData === undefined || isPlainObject(oData);
     }
 
     /**
      * return true iff any of the signature parameters of oMatchingTarget indicate a renaming is happening
      *
-     * @param {object} oMatchingTarget a matchign target
+     * @param {object} oMatchingTarget a matching target
      * @returns {boolean} whether a renaming is part of the signature
      */
     function hasRenameTo (oMatchingTarget) {
@@ -351,21 +346,9 @@ sap.ui.define([
         oMatchingTarget.mappedDefaultedParamNames = Object.keys(oMap).sort();
     }
 
-    function checkValidAppStateData (oAppStateData) {
-        if (isInvalidAppStateData(oAppStateData)) {
-            return Promise.reject();
-        }
-        return Promise.resolve(oAppStateData);
-    }
-
-    function getAppStateData (oAppStateService, sAppStateKey) {
-        return new Promise(function (fnResolve, fnReject) {
-            oAppStateService.getAppState(sAppStateKey).done(function (oAppState) {
-                fnResolve(oAppState.getData());
-            }).fail(function (sError) {
-                fnReject(sError);
-            });
-        });
+    async function getAppStateData (oAppStateService, sAppStateKey) {
+        const oAppState = await ushellUtils.promisify(oAppStateService.getAppState(sAppStateKey));
+        return oAppState.getData();
     }
 
     return {

package/src/main/js/sap/ushell/services/_CommonDataModel/SiteConverter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Because the personalization processor only works with a CDM 3.0 site, this converter is used to transform a dedicated
  * CDM 3.1 site object into a CDM 3.0 site and backwards.
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log"

package/src/main/js/sap/ushell/services/_CommonDataModel/vizTypeDefaults/VizTypeDefaults.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility for loading the default visualization types for the CDM runtime.
- * @version 1.125.0
+ * @version 1.126.0
  */
 
 sap.ui.define([

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.125.0
+ * @version 1.126.0
  * @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.125.0
+ * @version 1.126.0
  * @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.125.0
+ * @version 1.126.0
  * @deprecated since 1.120.0
  */
 

package/src/main/js/sap/ushell/services/_MessageBroker/MessageBrokerEngine.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module contains the implementation of the message broker
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

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.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_PluginManager/Extensions.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The extensions which plugins can use to customise the launchpad
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/services/_PluginManager/HeaderExtensions.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The extensions for the ShellHeader
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ushell/EventHub"

package/src/main/js/sap/ushell/services/_PluginManager/MenuExtensions.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The extensions for the MenuBar, an interface to let plugins request menu entry providers.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define(["sap/ushell/Container"], function (Container) {
     "use strict";

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.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/support/plugins/flpConfig/FlpConfigurationPlugin.js

@@ -9,7 +9,7 @@
  * Fiori launchpad in a tree table separated by IconTabFilters for the first level properties of the configuration object.
  * Also it provides a search for last level properties.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/core/Element",

package/src/main/js/sap/ushell/themes/sap_horizon/Tile.less

@@ -9,13 +9,9 @@
 /* Tile Footer (plus button in tile catalog) */
 @_sap_ushell_Tile_FooterBorder:						@sapUiShellBorderColor;
 @_sap_ushell_Tile_FooterIconColor:						@sapUiTileTextColor;
-@_sap_ushell_Tile_Spacing: 1rem;
 @_sap_ushell_Tile_SpacingXS: 0.475rem;
-@_sap_ushell_Tile_SpacingS: 0.475rem;
-@_sap_ushell_Tile_Spacing: 1rem;
-@_sap_ushell_Tile_WidthXS: 4.375rem;
-@_sap_ushell_Tile_WidthS: 5.25rem;
-@_sap_ushell_Tile_Width: 5rem;
+@_sap_ushell_Tile_SpacingS: 0.7rem;
+@_sap_ushell_Tile_Spacing: 0.7rem;
 
 .sapUshellTile {
 

package/src/main/js/sap/ushell/ui/cards/RecentActivitiesExtension.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Extension for recent activities card
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/integration/Extension",

package/src/main/js/sap/ushell/ui/footerbar/SendAsEmailButton.js

@@ -41,8 +41,8 @@ sap.ui.define([
         metadata: {
             library: "sap.ushell",
             properties: {
-                beforePressHandler: { type: "Function", group: "Misc", defaultValue: null },
-                afterPressHandler: { type: "Function", group: "Misc", defaultValue: null }
+                beforePressHandler: { type: "function", group: "Misc", defaultValue: null },
+                afterPressHandler: { type: "function", group: "Misc", defaultValue: null }
             }
         },
         renderer: ButtonRenderer

package/src/main/js/sap/ushell/ui/launchpad/ExtendedChangeDetection.js

@@ -7,7 +7,7 @@
  * of recreating them. Items which get removed from the aggregation get destroyed and items which get added to the
  * aggregation get created.
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/base/ManagedObject",

package/src/main/js/sap/ushell/ui/launchpad/Section.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provides control sap.ushell.ui.launchpad.Section
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -292,7 +292,6 @@ sap.ui.define([
                  * Dummy aggregation for visualizations in this section. Aggregation manipulation API should not be used.
                  * The content should be provided with the binding on the "visualisations" path of the model.
                  * There is only the following API available: bindVisualizations, getVisualizations and indexOfVisualization.
-                 * @private
                  */
                 visualizations: {
                     type: "sap.ui.core.Control",
@@ -300,8 +299,8 @@ sap.ui.define([
                     multiple: true
                 },
                 /**
-                 * Visualizations in the default area (normal tiles). This aggregation should be never accessed directly.
-                 * @private
+                 * Visualizations in the default area (normal tiles). This aggregation should be never accessed directly,
+                 * althouh this is not enforced by the framework.
                  */
                 defaultItems: {
                     type: "sap.ui.core.Control",
@@ -315,7 +314,6 @@ sap.ui.define([
                 },
                 /**
                  * Visualizations in the flat area (flat and flat wide tiles). This aggregation should be never accessed directly.
-                 * @private
                  */
                 flatItems: {
                     type: "sap.ui.core.Control",
@@ -329,7 +327,6 @@ sap.ui.define([
                 },
                 /**
                  * Visualizations in the compact area (link tiles). This aggregation should be never accessed directly.
-                 * @private
                  */
                 compactItems: {
                     type: "sap.ui.core.Control",

package/src/main/js/sap/ushell/ui/launchpad/section/CompactArea.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Provides control sap.ushell.ui.launchpad.section.CompactArea
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/ui/shell/ShellHeadItem.js

@@ -55,7 +55,6 @@ sap.ui.define([
                 /**
                  * If set to true, a divider is displayed before the item.
                  *
-                 * @private
                  * @deprecated since 1.18 Dividers are not supported anymore.
                  */
                 startsSection: {
@@ -68,7 +67,6 @@ sap.ui.define([
                  * If set to true, a separator is displayed after the item.
                  *
                  * @since 1.22.5
-                 * @private
                  * @deprecated since 1.62. Support for the showSeparator property has been discontinued in Fiori 2 and later.
                  */
                 showSeparator: {
@@ -81,7 +79,6 @@ sap.ui.define([
                  * If set to false, the button isn't clickable and displayed as disabled.
                  *
                  * @since 1.38
-                 * @private
                  */
                 enabled: {
                     type: "boolean",
@@ -91,7 +88,6 @@ sap.ui.define([
                 /**
                  * If set to true, the item gets a special design.
                  *
-                 * @private
                  */
                 selected: {
                     type: "boolean",
@@ -101,7 +97,6 @@ sap.ui.define([
                 /**
                  * If set to true, a theme dependent marker is shown on the item.
                  *
-                 * @private
                  * @deprecated since 1.18. Markers should not be used anymore.
                  */
                 showMarker: {
@@ -173,7 +168,7 @@ sap.ui.define([
                     defaultValue: null
                 },
                 /**
-                 * @private
+                 * The floating number of the item.
                  */
                 floatingNumber: {
                     type: "int",
@@ -181,7 +176,7 @@ sap.ui.define([
                     defaultValue: null
                 },
                 /**
-                 * @private
+                 * The maximum value of the floating number.
                  */
                 floatingNumberMaxValue: {
                     type: "int",
@@ -189,7 +184,7 @@ sap.ui.define([
                     defaultValue: 999
                 },
                 /**
-                 * @private
+                 * The type of the floating number.
                  */
                 floatingNumberType: {
                     type: "sap.ushell.FloatingNumberType",

package/src/main/js/sap/ushell/ui/shell/ToolAreaItem.js

@@ -18,7 +18,7 @@ sap.ui.define([
      * A control to be placed in the tool area
      * @extends sap.ui.core.Control
      *
-     * @version 1.125.0
+     * @version 1.126.0
      *
      * @public
      * @since 1.30.5
@@ -45,7 +45,6 @@ sap.ui.define([
                 /**
                  * Text  which will be read by screenreader.
                  * @since 1.30
-                 * @private
                  */
                 ariaLabel: { type: "string", group: "Appearance", defaultValue: null },
 

package/src/main/js/sap/ushell/ui/utils.js

@@ -6,7 +6,7 @@
  * This is a utility module that collects common activities implemented
  * by controllers of different ui components.
  *
- * @version 1.125.0
+ * @version 1.126.0
  * @private
  */
 

package/src/main/js/sap/ushell/ui5service/ShellUIService.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ShellUIService UI5 service
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/ui5service/UserStatus.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The UserStatus UI5 service
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
 sap.ui.define([
     "sap/ui/core/service/ServiceFactoryRegistry",

package/src/main/js/sap/ushell/utils/UrlShortening.js

@@ -5,7 +5,7 @@
  *
  * This module is for internal Shell usage only
  *
- * @version 1.125.0
+ * @version 1.126.0
  */
  sap.ui.define(["sap/base/Log", "sap/ushell/utils/UrlParsing"], function (Log, urlParsing) {
     "use strict";

package/src/main/js/sap/ushell/utils/WindowUtils.js

@@ -197,5 +197,22 @@ sap.ui.define([
         }
     };
 
+    /**
+    * Clears the `sap-usercontext` cookie set by the SAP NetWeaver ABAP front-end server
+    *
+    * - The `sap-usercontext` cookie is on path `/`.
+    * - It's used by the ICF system login on the SAP NetWeaver ABAP front-end
+    *   server to cache the current ABAP language and the current client.
+    * - When an FLP user changes their language and the FLP is restarted, then
+    *   this cache is to be invalidated. This triggers the reevaluation of the
+    *   language context with the next login as needed.
+    *
+    * @private
+    * @since 1.126.0
+    */
+    WindowUtils.clearSapUserContextCookie = function () {
+        window.document.cookie = "sap-usercontext=;Path=/;Max-Age=-1";
+    };
+
     return WindowUtils;
 });