@sapui5/sap.ushell 1.138.1 → 1.139.0

package/src/main/js/sap/ushell/services/PersonalizationV2/TransientPersonalizer.js

@@ -1,6 +1,6 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
-], function () {
+], () => {
     "use strict";
 
     /**
@@ -55,5 +55,4 @@ sap.ui.define([
     };
 
     return TransientPersonalizer;
-
 });

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

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/services/PersonalizationV2/utils"
-], function (personalizationUtils) {
+], (personalizationUtils) => {
     "use strict";
 
     /**
@@ -14,6 +14,10 @@ sap.ui.define([
      *
      * @hideconstructor
      *
+     * @param {object} oVariantSet the variant set.
+     * @param {string} sVariantKey the variant key.
+     * @param {string} sVariantName the variant name.
+     *
      * @since 1.120.0
      * @public
      */

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

@@ -3,7 +3,7 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/services/PersonalizationV2/constants.private",
     "sap/ushell/services/PersonalizationV2/Variant"
-], function (ushellUtils, constants, Variant) {
+], (ushellUtils, constants, Variant) => {
     "use strict";
 
     /**
@@ -52,7 +52,6 @@ sap.ui.define([
                             throw new Error("Parameter value of sVariantName is not a string: sap.ushell.services.Personalization");
                         }
                         if (oVariantData && typeof oVariantData !== "object") {
-
                             throw Error("Parameter value of sVariantName is not a string: sap.ushell.services.Personalization");
                         }
                         oVariantNameMap.put(sVariantName, sVariantKey);
@@ -67,7 +66,7 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @returns {*}
+     * @returns {object} the variant set data.
      *
      * @since 1.120.0
      * @private
@@ -133,7 +132,7 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @returns {*}
+     * @returns {object} the variant map.
      *
      * @since 1.120.0
      * @private
@@ -237,7 +236,7 @@ sap.ui.define([
      * Creates a new variant in the variant set.
      * In case a variant with this name is already existing an exception is thrown.
      * @param {string} sVariantName variant set name
-     * @returns {sap.ushell.services.PersonalizationV2.Variant}
+     * @returns {sap.ushell.services.PersonalizationV2.Variant} the variant.
      *
      * @since 1.120.0
      * @public
@@ -245,7 +244,7 @@ sap.ui.define([
     VariantSet.prototype.addVariant = function (sVariantName) {
         const aKeys = this.getVariantKeys();
         // generate a new "unique" key not yet present in aKeys
-        const iMaxKey = parseInt(aKeys.sort(function (a, b) {
+        const iMaxKey = parseInt(aKeys.sort((a, b) => {
             return a - b;
         }).reverse()[0], 10); // get the highest key; in case of an empty
         // variant set -> NaN
@@ -270,8 +269,6 @@ sap.ui.define([
         return oVariant;
     };
 
-
-
     /**
      * Deletes a variant from the variant set.
      * In case the variant does not exist nothing happens.

package/src/main/js/sap/ushell/services/PersonalizationV2/VariantSetAdapter.js

@@ -2,7 +2,7 @@
 sap.ui.define([
     "sap/ushell/services/PersonalizationV2/constants.private",
     "sap/ushell/services/PersonalizationV2/VariantSet"
-], function (constants, VariantSet) {
+], (constants, VariantSet) => {
     "use strict";
     /**
      * @alias sap.ushell.services.PersonalizationV2.VariantSetAdapter
@@ -51,7 +51,7 @@ sap.ui.define([
      */
     VariantSetAdapter.prototype.getVariantSetKeys = function () {
         const aPrefixVariantSetKeys = this._oContextContainer._getInternalKeys();
-        const aVariantSetKeys = aPrefixVariantSetKeys.map(function (sEntry) {
+        const aVariantSetKeys = aPrefixVariantSetKeys.map((sEntry) => {
             return sEntry.replace(constants.S_VARIANT_PREFIX, "", "");
         });
         return aVariantSetKeys;

package/src/main/js/sap/ushell/services/PersonalizationV2/WindowAdapter.js

@@ -2,7 +2,7 @@
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
     "sap/ushell/services/PersonalizationV2/WindowAdapterContainer"
-], function (jQuery, WindowAdapterContainer) {
+], (jQuery, WindowAdapterContainer) => {
     "use strict";
 
     /**
@@ -27,10 +27,10 @@ sap.ui.define([
     WindowAdapter.prototype.data = {};
 
     /**
-     * @param {string} sContainerKey
-     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope
-     * @param {string} sAppName
-     * @returns {sap.ushell.services.PersonalizationV2.WindowAdapterContainer}
+     * @param {string} sContainerKey the personalization container key.
+     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope the scope object.
+     * @param {string} sAppName the application name.
+     * @returns {sap.ushell.services.PersonalizationV2.WindowAdapterContainer} the window container adapter.
      *
      * @since 1.120.0
      * @private
@@ -41,9 +41,9 @@ sap.ui.define([
     };
 
     /**
-     * @param {string} sContainerKey
-     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope
-     * @returns {Promise}
+     * @param {string} sContainerKey the personalization container key.
+     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope the scope object.
+     * @returns {jQuery.Deferred} that resolves after the backend adapter was removed.
      *
      * @since 1.120.0
      * @private
@@ -54,10 +54,10 @@ sap.ui.define([
         delete WindowAdapter.prototype.data[sContainerKey];
         if (this._oBackendAdapter) {
             this._oBackendAdapter.delAdapterContainer(sContainerKey, oScope)
-                .done(function () {
+                .done(() => {
                     oDeferred.resolve();
                 })
-                .fail(function (sMsg) {
+                .fail((sMsg) => {
                     oDeferred.reject(sMsg);
                 });
         } else {
@@ -67,5 +67,4 @@ sap.ui.define([
     };
 
     return WindowAdapter;
-
 });

package/src/main/js/sap/ushell/services/PersonalizationV2/WindowAdapterContainer.js

@@ -3,7 +3,7 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/services/PersonalizationV2/utils",
     "sap/ui/thirdparty/jquery"
-], function (ushellUtils, personalizationUtils, jQuery) {
+], (ushellUtils, personalizationUtils, jQuery) => {
     "use strict";
 
     /**
@@ -11,6 +11,11 @@ sap.ui.define([
      * @class
      * @classdesc Container for storage with window validity, data is stored in sap.ushell.services.Personalization.WindowValidityPersistence
      *
+     * @param {string} sContainerKey the personalization container key.
+     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope the scope object, not in use.
+     * @param {object} oBackendContainer the backend container.
+     * @param {sap.ushell.services.PersonalizationV2.WindowAdapter} WindowAdapter the window adapter.
+     *
      * @since 1.120.0
      * @private
      */
@@ -22,8 +27,7 @@ sap.ui.define([
     }
 
     /**
-     *
-     * @param {*} oContainer
+     * @param {sap.ushell.services.PersonalizationV2.ContextContainer} oContainer the personalization container.
      *
      * @since 1.120.0
      * @private
@@ -45,17 +49,17 @@ sap.ui.define([
      */
     WindowAdapterContainer.prototype.load = function () {
         const oDeferred = new jQuery.Deferred();
-        let i,
-            keys;
-        //Check if found in window object
+        let i;
+        let keys;
+        // Check if found in window object
         if (this.WindowAdapter.prototype.data[this._sContainerKey]) {
-            //load data from window
+            // load data from window
             this._oItemMap.entries = personalizationUtils.clone(this.WindowAdapter.prototype.data[this._sContainerKey]);
 
             if (this._oBackendContainer) {
                 clear(this._oBackendContainer);
 
-                //Copy all items to the backend container
+                // Copy all items to the backend container
                 keys = this.getItemKeys();
                 for (i = 0; i < keys.length; i = i + 1) {
                     this._oBackendContainer.setItemValue(keys[i], this._oItemMap.get(keys[i]));
@@ -64,16 +68,16 @@ sap.ui.define([
             oDeferred.resolve();
         } else if (this._oBackendContainer) { // attempt load data from front-end server
             const that = this;
-            this._oBackendContainer.load().done(function () {
-                //copy received data from oAdapter into this._oItemMap.entries
+            this._oBackendContainer.load().done(() => {
+                // copy received data from oAdapter into this._oItemMap.entries
                 keys = that._oBackendContainer.getItemKeys();
                 for (i = 0; i < keys.length; i = i + 1) {
                     that.setItemValue(keys[i], that._oBackendContainer.getItemValue(keys[i]));
                 }
-                //store immediately in the window variable so that the second load is satisfied from the window
+                // store immediately in the window variable so that the second load is satisfied from the window
                 this.WindowAdapter.prototype.data[that._sContainerKey] = personalizationUtils.clone(that._oItemMap.entries);
                 oDeferred.resolve();
-            }.bind(this)).fail(function (sMsg) {
+            }).fail((sMsg) => {
                 oDeferred.reject(sMsg);
             });
         } else {
@@ -94,9 +98,9 @@ sap.ui.define([
         const oDeferred = new jQuery.Deferred();
         this.WindowAdapter.prototype.data[this._sContainerKey] = personalizationUtils.clone(this._oItemMap.entries);
         if (this._oBackendContainer) {
-            this._oBackendContainer.save().done(function () {
+            this._oBackendContainer.save().done(() => {
                 oDeferred.resolve();
-            }).fail(function (sMsg) {
+            }).fail((sMsg) => {
                 oDeferred.reject(sMsg);
             });
         } else {
@@ -106,8 +110,7 @@ sap.ui.define([
     };
 
     /**
-     *
-     * @returns {string[]}
+     * @returns {string[]} the keys of the items map.
      *
      * @since 1.120.0
      * @private
@@ -117,20 +120,19 @@ sap.ui.define([
     };
 
     /**
-     *
-     * @param {*} sItemKey
+     * @param {string} sItemKey Key whose presence in this map is to be tested
+     * @returns {boolean} true if this map contains a mapping for the specified key.
      *
      * @since 1.120.0
      * @private
      */
     WindowAdapterContainer.prototype.containsItem = function (sItemKey) {
-        this._oItemMap.containsKey(sItemKey);
+        return this._oItemMap.containsKey(sItemKey);
     };
 
     /**
-     *
-     * @param {*} sItemKey
-     * @returns {*}
+     * @param {string} sItemKey the item key.
+     * @returns {any} the item value.
      *
      * @since 1.120.0
      * @private
@@ -140,9 +142,8 @@ sap.ui.define([
     };
 
     /**
-     *
-     * @param {*} sItemKey
-     * @param {*} oItemValue
+     * @param {string} sItemKey the item key.
+     * @param {any} oItemValue the item value.
      *
      * @since 1.120.0
      * @private
@@ -155,8 +156,7 @@ sap.ui.define([
     };
 
     /**
-     *
-     * @param {*} sItemKey
+     * @param {string} sItemKey the item key.
      *
      * @since 1.120.0
      * @private

package/src/main/js/sap/ushell/services/PersonalizationV2/constants.js

@@ -1,6 +1,6 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
-], function () {
+], () => {
     "use strict";
 
     // these constants are exposed through the Personalization prototype
@@ -44,7 +44,6 @@ sap.ui.define([
         LOW: "LOW"
     };
 
-
     return {
         keyCategory: oKeyCategory,
         writeFrequency: oWriteFrequency

package/src/main/js/sap/ushell/services/PersonalizationV2/constants.private.js

@@ -1,6 +1,6 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
-], function () {
+], () => {
     "use strict";
 
     // these constants are never exposed outside the Personalization module

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

@@ -5,7 +5,7 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ui/thirdparty/jquery",
     "sap/base/Log"
-], function (oConstants, oPrivateConstants, ushellUtils, jQuery, Log) {
+], (oConstants, oPrivateConstants, ushellUtils, jQuery, Log) => {
     "use strict";
 
     /**
@@ -41,7 +41,7 @@ sap.ui.define([
      */
     function addContainerPrefix (sContainerKey) {
         if (sContainerKey.length > 40) {
-            Log.error("Personalization Service container key (\"" + sContainerKey + "\") should be less than 40 characters [current :" + sContainerKey.length + "]");
+            Log.error(`Personalization Service container key ("${sContainerKey}") should be less than 40 characters [current :${sContainerKey.length}]`);
         }
 
         return oPrivateConstants.S_CONTAINER_PREFIX + sContainerKey;
@@ -110,9 +110,9 @@ sap.ui.define([
             }
 
             // todo: check comment below
-            //Combination of FixKey & CrossUserRead is an illegal combination because the user who was creating the container is no longer available
-            //The other users have no chance to write on that container
-            //if (oAdjustedScope.keyCategory === oConstants.keyCategory.FIXED_KEY && oAdjustedScope.access === oConstants.access.CROSS_USER_READ) {
+            // Combination of FixKey & CrossUserRead is an illegal combination because the user who was creating the container is no longer available
+            // The other users have no chance to write on that container
+            // if (oAdjustedScope.keyCategory === oConstants.keyCategory.FIXED_KEY && oAdjustedScope.access === oConstants.access.CROSS_USER_READ) {
             //    throw new utils.Error("Wrong defined scope. FixKey and CrossUserRead is an illegal combination: sap.ushell.services.Personalization", " ");
             // }
         }