@sapui5/sap.ushell 1.117.2 → 1.119.0

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

@@ -22,7 +22,6 @@ sap.ui.define([
      * The PersonalizationProcessor, mixing in and out the personalization to and from site objects.
      *
      * @class
-     * @constructor
      * @see {@link sap.ushell.services.CommonDataModel}
      * @since 1.38.0
      */
@@ -39,7 +38,7 @@ sap.ui.define([
      * @param {string} sItemId
      *   ID of the item, which position should be returned.
      *
-     * @returns {integer}
+     * @returns {int}
      *   Array-index of given item as described before - or "-1", if not found.
      *   Note: The index counts from zero, as usual.
      *

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

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.117.2
+ * @version 1.119.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.117.2
+ * @version 1.119.0
  * @private
  */
 sap.ui.define([
@@ -15,7 +15,7 @@ sap.ui.define([
         sGroupTitle = resources.i18n.getText("featuredGroup.title"),
         sRecentActivity = resources.i18n.getText("recentActivities"),
         sFrequentlyUsed = resources.i18n.getText("frequentActivities"),
-        sTop = resources.i18n.getText("top", 4),
+        sTop = resources.i18n.getText("top", [4]),
         oFeaturedGroupSite = {
             _version: "3.0.0",
             site: {

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

@@ -2,15 +2,16 @@
 /**
  * @fileOverview Cross Application Navigation utility functions
  *
- * @version 1.117.2
+ * @version 1.119.0
  */
 
 
 sap.ui.define([
+    "sap/base/util/isPlainObject",
     "sap/base/util/ObjectPath",
     "sap/base/Log",
     "sap/ushell/utils/UrlParsing"
-], function (ObjectPath, Log, UrlParsing) {
+], function (isPlainObject, ObjectPath, Log, UrlParsing) {
     "use strict";
 
     var Utils = {};
@@ -195,8 +196,7 @@ sap.ui.define([
         } catch (e) {
             Log.error(
                 "Cannot parse the given string to object",
-                sObject,
-                "sap.ushell.services.CrossApplicationNavigation"
+                sObject
             );
         }
 
@@ -314,7 +314,7 @@ sap.ui.define([
             };
         }
 
-        if (Object.prototype.toString.apply(vIntent) === "[object Object]") {
+        if (isPlainObject(vIntent)) {
             var sShellHash = ObjectPath.get("target.shellHash", vIntent);
             if (typeof sShellHash === "string") {
                 var oResult = Utils.extractParameter(sShellHash, sParameterName);
@@ -330,9 +330,8 @@ sap.ui.define([
 
             var oParameters = vIntent.params;
             if (oParameters && oParameters[sParameterName]) {
-                aParameterValue = typeof oParameters[sParameterName] === "string"
-                    ? [ oParameters[sParameterName] ]
-                    : oParameters[sParameterName];
+                const vParameterValue = oParameters[sParameterName];
+                aParameterValue = typeof vParameterValue === "string" ? [ vParameterValue ] : vParameterValue;
 
                 delete oParameters[sParameterName];
             }
@@ -343,11 +342,7 @@ sap.ui.define([
             };
         }
 
-        Log.error(
-            "Invalid input parameter",
-            "expected string or object",
-            "sap.ushell.services.CrossApplicationNavigation"
-        );
+        Log.error("Invalid input parameter", "expected string or object");
 
         return { intent: vIntent };
     };
@@ -387,7 +382,7 @@ sap.ui.define([
      *
      * @param {string} sSourceParameter
      *   The name of the parameter that contains the sap-xapp-state data.
-     * @returns {Promise<void>}
+     * @returns {Promise<undefined>}
      *   A Promise which resolves once the AppState was created
      *
      * @private

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

package/src/main/js/sap/ushell/services/_Personalization/ContextContainer.js

@@ -67,6 +67,19 @@ sap.ui.define([
         return this._oScope.validity;
     };
 
+    /**
+     * return the validity of this container
+     * only for testing!
+     * @name sap.ushell.services.Personalization.ContextContainer#_getValidity
+     * @private
+     * @function
+     * @since 1.119.0
+     * @returns {int} The validity of the container.
+     */
+    ContextContainer.prototype._getValidity = function () {
+        return this._oScope.validity;
+    };
+
     /**
      * clears the local copy data of this container
      *
@@ -147,11 +160,11 @@ sap.ui.define([
         var oFormatter,
             sTimestampExpire,
             sTimestampNow;
-        if (this.getValidity() === Infinity || this.getValidity() === 0) {
+        if (this._getValidity() === Infinity || this._getValidity() === 0) {
             return false;
         }
         sTimestampExpire = this._getItemValueInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_EXPIRE);
-        oFormatter = DateFormat.getDateInstance({ pattern: constants.S_ABAPTIMESTAMPFORMAT});
+        oFormatter = DateFormat.getDateInstance({ pattern: constants.S_ABAPTIMESTAMPFORMAT });
         sTimestampNow = oFormatter.format(this._getNow(), true);
         return sTimestampExpire && sTimestampNow > sTimestampExpire;
     };
@@ -175,15 +188,15 @@ sap.ui.define([
             });
             this._clear = false;
         }
-        if (this.getValidity() === Infinity || this.getValidity() === 0) {
+        if (this._getValidity() === Infinity || this._getValidity() === 0) {
             this._delItemInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_SCOPE);
             this._delItemInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_EXPIRE);
             this._delItemInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_STORAGE);
         } else {
-            oFormatter = DateFormat.getDateInstance({ pattern: constants.S_ABAPTIMESTAMPFORMAT});
+            oFormatter = DateFormat.getDateInstance({ pattern: constants.S_ABAPTIMESTAMPFORMAT });
             oNow = this._getNow();
             sTimestampStorage = oFormatter.format(oNow, true); // true UTC times !
-            sTimestampExpire = oFormatter.format(new Date(oNow.getTime() + this.getValidity() * 60000), /*UTC!*/ true);
+            sTimestampExpire = oFormatter.format(new Date(oNow.getTime() + this._getValidity() * 60000), /*UTC!*/ true);
             this._setItemValueInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_SCOPE, this._oScope);
             this._setItemValueInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_EXPIRE, sTimestampExpire);
             this._setItemValueInternal(constants.S_ADMIN_PREFIX, constants.S_ITEMKEY_STORAGE, sTimestampStorage);
@@ -298,7 +311,7 @@ sap.ui.define([
         oSaveDeferred = new jQuery.Deferred();
         oPrior = this._oService._pendingContainerOperations_flushAddNext(this._sContainerKey, oSaveDeferred);
         oPrior.fail(function () { oSaveDeferred.reject(); })
-              .done(function () { oSaveDeferred.resolve(); });
+            .done(function () { oSaveDeferred.resolve(); });
         return oSaveDeferred.promise();
     };
 
@@ -316,11 +329,11 @@ sap.ui.define([
     ContextContainer.prototype.getItemKeys = function () {
         // return a list of the (prefix stripped)  "Item" keys.
         var aFilteredTrueItemKeys = this._oItemMap.keys().filter(function (s) {
-                return s.indexOf(constants.S_ITEM_PREFIX) === 0;
-                // match at first character -> index = 0 -> true -> keep
-                // match inside the string -> index > 0 -> false -> filter out
-                // no match -> index = -1 -> false -> filter out
-            });
+            return s.indexOf(constants.S_ITEM_PREFIX) === 0;
+            // match at first character -> index = 0 -> true -> keep
+            // match inside the string -> index > 0 -> false -> filter out
+            // no match -> index = -1 -> false -> filter out
+        });
         return aFilteredTrueItemKeys.map(function (sEntry) {
             return sEntry.replace(constants.S_ITEM_PREFIX, "", "");
         });
@@ -484,25 +497,25 @@ sap.ui.define([
                 var oUnmodifiableContainer = {};
 
                 // blocked functions
-                [ "clear",
+                ["clear",
                     "delItem",
                     "flush",
                     "load",
                     "save",
                     "saveDeferred",
-                    "setItemValue" ].forEach(function (sFunctionName) {
-                    oUnmodifiableContainer[sFunctionName] = function (sName) {
-                        throw new utils.Error("Function " + sName + " can't be called on unmodifiable container",
-                            "ContextContainer", " " /* Empty string for missing component information */);
-                    }.bind(undefined, sFunctionName);
-                });
+                    "setItemValue"].forEach(function (sFunctionName) {
+                        oUnmodifiableContainer[sFunctionName] = function (sName) {
+                            throw new utils.Error("Function " + sName + " can't be called on unmodifiable container",
+                                "ContextContainer", " " /* Empty string for missing component information */);
+                        }.bind(undefined, sFunctionName);
+                    });
 
                 // permitted functions
-                [ "containsItem",
+                ["containsItem",
                     "getItemKeys",
                     "getItemValue",
-                    "getUnmodifiableContainer",
-                    "getValidity" ].forEach(function (sFunctionName) {
+                    "getUnmodifiableContainer"
+                ].forEach(function (sFunctionName) {
                     if (that[sFunctionName]) {
                         oUnmodifiableContainer[sFunctionName] = that[sFunctionName].bind(that);
                     }

package/src/main/js/sap/ushell/services/_Personalization/Variant.js

@@ -111,7 +111,10 @@ sap.ui.define([
             return undefined;
         }
         var vd = this._oVariantSet._getVariantSet().variants[this._sVariantKey].variantData;
-        return Object.prototype.hasOwnProperty.call(vd, sItemKey) && personalizationUtils.clone(vd[sItemKey]);
+        if (!Object.prototype.hasOwnProperty.call(vd, sItemKey)) {
+            return undefined;
+        }
+        return personalizationUtils.clone(vd[sItemKey]);
     };
 
     /**
@@ -159,7 +162,7 @@ sap.ui.define([
         if (typeof sItemKey !== "string") {
             return undefined;
         }
-        var vd = this.oAccess.variantSet._getVariantSet().variants[this._sVariantKey].variantData;
+        var vd = this._oVariantSet._getVariantSet().variants[this._sVariantKey].variantData;
         return Object.prototype.hasOwnProperty.call(vd, sItemKey);
     };
 

package/src/main/js/sap/ushell/services/_Personalization/VariantSet.js

@@ -1,5 +1,10 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
-sap.ui.define(["sap/ushell/utils", "sap/ushell/services/_Personalization/constants.private", "sap/ushell/services/_Personalization/PersonalizationContainerVariant", "sap/ushell/services/_Personalization/Variant"], function (utils, constants, PersonalizationContainerVariant, Variant) {
+sap.ui.define([
+    "sap/ushell/utils",
+    "sap/ushell/services/_Personalization/constants.private",
+    "sap/ushell/services/_Personalization/PersonalizationContainerVariant",
+    "sap/ushell/services/_Personalization/Variant"
+], function (utils, constants, PersonalizationContainerVariant, Variant) {
     "use strict";
 
     /**
@@ -19,6 +24,7 @@ sap.ui.define(["sap/ushell/utils", "sap/ushell/services/_Personalization/constan
      * @name sap.ushell.services.Personalization.VariantSet
      * @since 1.22.0
      */
+
     function VariantSet (sVariantSetKey, oContextContainer) {
         var sVariantKey,
             sVariantName,
@@ -45,7 +51,7 @@ sap.ui.define(["sap/ushell/utils", "sap/ushell/services/_Personalization/constan
                     } else {
                         oVariantNameMap.put(sVariantName, sVariantKey);
                         oVariant = new PersonalizationContainerVariant(sVariantKey,
-                                sVariantName, oVariantData);
+                            sVariantName, oVariantData);
                         oVariantMap.put(sVariantKey, oVariant);
                     }
                 }
@@ -255,23 +261,23 @@ sap.ui.define(["sap/ushell/utils", "sap/ushell/services/_Personalization/constan
         iMaxKey = parseInt(aKeys.sort(function (a, b) {
             return a - b;
         }).reverse()[0], 10); // get the highest key; in case of an empty
-                              // variant set -> NaN
+        // variant set -> NaN
         sVariantKey = isNaN(iMaxKey) ? "0" : (iMaxKey + 1).toString();
-            // tested for up to 1 mio variants
+        // tested for up to 1 mio variants
         if (aKeys.indexOf(sVariantKey) >= 0) {
             throw new utils.Error("Variant key '" + sVariantKey
-                    + "' already exists in variant set" + this._sVariantSetKey
-                    + "': sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
+                + "' already exists in variant set" + this._sVariantSetKey
+                + "': sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
         }
         if (typeof sVariantName !== "string") {
             throw new utils.Error("Parameter value of sVariantName is not a string: sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
         }
         if (this.getVariantKeyByName(sVariantName) !== undefined) {
             throw new utils.Error("Variant name '" + sVariantName
-                    + "' already exists in variant set '"
-                    + this._sVariantSetKey + "' (Old key: '"
-                    + this.getVariantKeyByName(sVariantName) + "' New key: '"
-                    + sVariantKey + "') ': sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
+                + "' already exists in variant set '"
+                + this._sVariantSetKey + "' (Old key: '"
+                + this.getVariantKeyByName(sVariantName) + "' New key: '"
+                + sVariantKey + "') ': sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
         }
         oVariant = new Variant(
             this,
@@ -279,8 +285,8 @@ sap.ui.define(["sap/ushell/utils", "sap/ushell/services/_Personalization/constan
             sVariantName
         );
         this._getVariantSet(this._sVariantSetKey).variants[sVariantKey] = {
-            name : sVariantName,
-            variantData : {}
+            name: sVariantName,
+            variantData: {}
         };
         this._serialize();
         return oVariant;

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

@@ -46,7 +46,7 @@ sap.ui.define([
      * @param {object} oPersistentAdapter
      *   An adapter that persists data.
      *
-     * @return {variant}
+     * @returns {variant}
      *   A loaded or not-yet-loaded adapter. If the adapter is not loaded, the
      *   return value is a function that when called returns a promise - that
      *   resolves to the adapter.
@@ -69,7 +69,7 @@ sap.ui.define([
      * @param {object} oScope
      *    The original scope
      *
-     * @return {object}
+     * @returns {object}
      *    The adjusted scope
      *
      * @private

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.117.2
+ * @version 1.119.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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/ushell/EventHub"
@@ -13,8 +13,8 @@ sap.ui.define([
      * Use only in Fiori3
      *
      * Set the control in the central area of header.
-     * @param {String} id The id of the control which should be shown in the central area of the header
-     * @param {Boolean} currentState Flag, to set the control only for the current state.
+     * @param {string} id The id of the control which should be shown in the central area of the header
+     * @param {boolean} currentState Flag, to set the control only for the current state.
      * @param {List} [states] The list of the states where control should be shown. This parameter is ignored when currentState is true.
      *  If this parameter is not set and current state is false, then all states will be updated.
      *

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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([], function () {
     "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.117.2
+ * @version 1.119.0
  */
 sap.ui.define([
     "sap/base/Log",