@sapui5/sap.ushell 1.138.1 → 1.139.0

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.138.1
+ * @version 1.139.0
  * @deprecated since 1.120. Please use {@link sap.ushell.services.PersonalizationV2} instead.
  */
 sap.ui.define([
@@ -25,7 +25,7 @@ sap.ui.define([
     "sap/ushell/services/_Personalization/Variant",
     "sap/ushell/services/_Personalization/VariantSet",
     "sap/ushell/services/PersonalizationV2/WindowAdapterContainer"
-], function (
+], (
     Log,
     ManagedObject,
     BaseObject,
@@ -43,7 +43,7 @@ sap.ui.define([
     Variant,
     VariantSet,
     WindowAdapterContainer
-) {
+) => {
     "use strict";
 
     // TODO conditional loading
@@ -105,7 +105,7 @@ sap.ui.define([
     }
 
     Personalization.prototype.SAVE_DEFERRED_DROPPED = "Deferred save dropped (OK) - Data superseded by subsequent save";
-    //constants for scope of personalization service
+    // constants for scope of personalization service
     Personalization.prototype.constants = publicConstants;
 
     /**
@@ -125,8 +125,8 @@ sap.ui.define([
      * @private
      */
     Personalization.prototype._configureAppVariantStorage = function (oAppVariantStorageConfig) {
-        var that = this;
-        var sDefaultAppVariantAdapter = "sap.ushell.adapters.AppVariantPersonalizationAdapter";
+        const that = this;
+        const sDefaultAppVariantAdapter = "sap.ushell.adapters.AppVariantPersonalizationAdapter";
 
         if (!oAppVariantStorageConfig) {
             // default
@@ -137,36 +137,34 @@ sap.ui.define([
             return;
         }
 
-        var sAdapterModuleName = (oAppVariantStorageConfig.adapter && oAppVariantStorageConfig.adapter.module) || sDefaultAppVariantAdapter;
-        var sAdapterModulePath = sAdapterModuleName.split(".").join("/");
+        const sAdapterModuleName = (oAppVariantStorageConfig.adapter && oAppVariantStorageConfig.adapter.module) || sDefaultAppVariantAdapter;
+        const sAdapterModulePath = sAdapterModuleName.split(".").join("/");
 
         // lazy load
-        var fnCreate = function () {
-            that._oAppVariantAdapterLoadPromise = that._oAppVariantAdapterLoadPromise || (function () {
-                var oDeferred = new jQuery.Deferred();
-
-                try {
-                    sap.ui.require([sAdapterModulePath], fnRequireSuccess);
-                } catch (oRequireError) {
-                    oDeferred.reject(oRequireError);
-                }
-
-                function fnRequireSuccess (AppVariantPersonalizationAdapter) {
-                    try {
-                        var oAdapter = new AppVariantPersonalizationAdapter();
-                        var oWrappedAdapter = new WindowAdapter(that, oAdapter);
-
-                        oDeferred.resolve(oWrappedAdapter);
-                    } catch (oError) {
-                        oDeferred.reject(oError);
+        function fnCreate () {
+            if (!that._oAppVariantAdapterLoadPromise) {
+                that._oAppVariantAdapterLoadPromise = new jQuery.Deferred();
+
+                sap.ui.require(
+                    [sAdapterModulePath],
+                    (AppVariantPersonalizationAdapter) => {
+                        try {
+                            const oAdapter = new AppVariantPersonalizationAdapter();
+                            const oWrappedAdapter = new WindowAdapter(that, oAdapter);
+
+                            that._oAppVariantAdapterLoadPromise.resolve(oWrappedAdapter);
+                        } catch (oError) {
+                            that._oAppVariantAdapterLoadPromise.reject(oError);
+                        }
+                    },
+                    (oRequireError) => {
+                        that._oAppVariantAdapterLoadPromise.reject(oRequireError);
                     }
-                }
-
-                return oDeferred.promise();
-            })();
+                );
+            }
 
-            return that._oAppVariantAdapterLoadPromise;
-        };
+            return that._oAppVariantAdapterLoadPromise.promise();
+        }
 
         return {
             lazy: true,
@@ -232,9 +230,9 @@ sap.ui.define([
      * @private
      */
     Personalization.prototype._getApplicationComponent = function () {
-        var sOwnerId = ManagedObject._sOwnerId;
+        const sOwnerId = ManagedObject._sOwnerId;
         if (sOwnerId) {
-            var oComponent = Core.getComponent(sOwnerId);
+            const oComponent = Core.getComponent(sOwnerId);
             if (BaseObject.isA(oComponent, "sap.ui.core.UIComponent")) {
                 return oComponent;
             }
@@ -377,52 +375,51 @@ sap.ui.define([
     };
 
     Personalization.prototype._createContainer = function (sContainerKey, oScope, bCreateEmpty, oComponent) {
-        var that = this;
-        var oDeferred = new jQuery.Deferred();
+        const oDeferred = new jQuery.Deferred();
 
         if (typeof sContainerKey !== "string") {
             throw new utils.Error("sContainerKey is not a string: sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
         }
 
-        var bUseAppVariantStorage = !!(
+        const bUseAppVariantStorage = !!(
             personalizationUtils.isAppVariant(oComponent)
             && (!oScope || !oScope.shared)
             && this._oAppVariantAdapterWithBackendAdapter
         );
 
         // -- adjust scope
-        var oAdjustedScope = personalizationUtils.adjustScope(oScope);
+        const oAdjustedScope = personalizationUtils.adjustScope(oScope);
 
         // -- add prefix
-        var sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
+        let sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
 
         if (bUseAppVariantStorage) {
-            var oManifest = oComponent.getManifestObject();
+            const oManifest = oComponent.getManifestObject();
             oAdjustedScope.component = oComponent;
             oAdjustedScope.appVarId = oManifest.getEntry("/sap.ui5/appVariantId");
             oAdjustedScope.appVersion = oManifest.getEntry("/sap.app/applicationVersion/version");
 
             // Check whether it is an app variant, then the prefixed container key gets changed by concatenating the app variant ID.
-            sPrefixedContainerKey += "#" + oManifest.getEntry("/sap.ui5/appVariantId");
+            sPrefixedContainerKey += `#${oManifest.getEntry("/sap.ui5/appVariantId")}`;
         }
 
         // -- choose adapter
-        var oPersistentAdapter = bUseAppVariantStorage
+        const oPersistentAdapter = bUseAppVariantStorage
             ? this._oAppVariantAdapterWithBackendAdapter
             : this._oAdapterWithBackendAdapter;
-        var oTransientAdapter = that._oAdapterWindowOnly;
+        const oTransientAdapter = this._oAdapterWindowOnly;
 
-        var oChosenAdapter = personalizationUtils.pickAdapter(oScope, oTransientAdapter, oPersistentAdapter);
+        const oChosenAdapter = personalizationUtils.pickAdapter(oScope, oTransientAdapter, oPersistentAdapter);
 
-        personalizationUtils.loadAdapter(oChosenAdapter).then(function (oLoadedAdapter) {
-            var oLoadPromise;
-            var oContextContainer = new ContextContainer(that, oLoadedAdapter, sPrefixedContainerKey, oAdjustedScope, oComponent);
+        personalizationUtils.loadAdapter(oChosenAdapter).then((oLoadedAdapter) => {
+            let oLoadPromise;
+            const oContextContainer = new ContextContainer(this, oLoadedAdapter, sPrefixedContainerKey, oAdjustedScope, oComponent);
 
             // Historically, a sequence getContainer / load was always called.
 
             // If an adapter supports returning an initialized container without requiring an subsequent load, it can set the flag
             // supportsGetWithoutSubsequentLoad and the load call will be omitted in case an empty container is required.
-            var bSupportsGetWithoutSubsequentLoad = (oLoadedAdapter && oLoadedAdapter.supportsGetWithoutSubsequentLoad === true);
+            const bSupportsGetWithoutSubsequentLoad = (oLoadedAdapter && oLoadedAdapter.supportsGetWithoutSubsequentLoad === true);
 
             if (bCreateEmpty && bSupportsGetWithoutSubsequentLoad) {
                 oLoadPromise = new jQuery.Deferred();
@@ -431,17 +428,15 @@ sap.ui.define([
                 oLoadPromise = oContextContainer.load();
             }
 
-            oLoadPromise.fail(function () {
+            oLoadPromise.fail(() => {
                 oDeferred.reject();
-            }).done(function () {
+            }).done(() => {
                 if (bCreateEmpty || oContextContainer._isExpired()) {
                     oContextContainer.clear();
                 }
                 oDeferred.resolve(oContextContainer);
             });
-        }, function (oError) {
-            oDeferred.reject(oError);
-        });
+        }, oDeferred.reject);
 
         return oDeferred.promise();
     };
@@ -465,40 +460,32 @@ sap.ui.define([
      */
     Personalization.prototype.delContainer = function (sContainerKey, oScope) {
         // delete the bag, the adapter container & the container
-        var oDeferred = {};
-        var sPrefixedContainerKey = "";
-        var that = this;
-        oScope = that._adjustScope(oScope);
+        let oDeferred = {};
+        let sPrefixedContainerKey = "";
+        oScope = this._adjustScope(oScope);
         sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
         oDeferred = new jQuery.Deferred();
 
-        var oPrior = that._pendingContainerOperations_cancelAddNext(sContainerKey, null);
-        oPrior.always(function () {
-            that.getContainer(sContainerKey, oScope) // delays to oPrior! registers a new op!
-                .fail(function () {
-                    that._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // reinstall oPrior (!)
+        const oPrior = this._pendingContainerOperations_cancelAddNext(sContainerKey, null);
+        oPrior.always(() => {
+            this.getContainer(sContainerKey, oScope) // delays to oPrior! registers a new op!
+                .fail(() => {
+                    this._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // reinstall oPrior (!)
                     oDeferred.reject();
                 })
-                .done(function (/*oContainer*/) {
-                    var oAdapter;
+                .done((/* oContainer */) => {
                     // install the "latest" deferred
-                    that._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // the getContainer above executed a load --> no flush required
+                    this._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // the getContainer above executed a load --> no flush required
 
-                    oAdapter = oScope.validity === 0
-                        ? that._oAdapterWindowOnly
-                        : that._oAdapterWithBackendAdapter;
+                    const oAdapter = oScope.validity === 0
+                        ? this._oAdapterWindowOnly
+                        : this._oAdapterWithBackendAdapter;
 
-                    personalizationUtils.loadAdapter(oAdapter).then(function (oLoadedAdapter) {
+                    personalizationUtils.loadAdapter(oAdapter).then((oLoadedAdapter) => {
                         oLoadedAdapter.delAdapterContainer(sPrefixedContainerKey, oScope)
-                            .fail(function () {
-                                oDeferred.reject();
-                            })
-                            .done(function () {
-                                oDeferred.resolve();
-                            });
-                    }, function () {
-                        oDeferred.reject();
-                    });
+                            .fail(oDeferred.reject)
+                            .done(oDeferred.resolve);
+                    }, oDeferred.reject);
                 });
         });
         return oDeferred.promise();
@@ -506,7 +493,7 @@ sap.ui.define([
 
     // return old promise, add oDeferred as new, if null, retain old!
     Personalization.prototype._pendingContainerOperations_flushAddNext = function (sContainerKey, oDeferred) {
-        var oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
+        let oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
         if (!oPendingOpDeferred) {
             oPendingOpDeferred = new jQuery.Deferred();
             oPendingOpDeferred.resolve();
@@ -517,10 +504,10 @@ sap.ui.define([
         if (!oPendingOpDeferred || oPendingOpDeferred.state() !== "pending") {
             return oPendingOpDeferred;
         }
-        clearTimeout(oPendingOpDeferred._sapTimeoutId); //system function!
+        clearTimeout(oPendingOpDeferred._sapTimeoutId); // system function!
         oPendingOpDeferred._sapTimeoutId = undefined;
         if (typeof oPendingOpDeferred._sapFnSave === "function") {
-            var fnSave = oPendingOpDeferred._sapFnSave;
+            const fnSave = oPendingOpDeferred._sapFnSave;
             oPendingOpDeferred._sapFnSave = undefined; // function can only be triggered at most one time
             fnSave();
         }
@@ -528,8 +515,7 @@ sap.ui.define([
     };
 
     Personalization.prototype._pendingContainerOperations_cancelAddNext = function (sContainerKey, oDeferred) {
-        var oPendingOpDeferred;
-        oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
+        let oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
         if (!oPendingOpDeferred) {
             oPendingOpDeferred = new jQuery.Deferred();
             oPendingOpDeferred.resolve();
@@ -598,26 +584,21 @@ sap.ui.define([
      * @deprecated since 1.21. Please use {@link #getContainer} instead.
      */
     Personalization.prototype.getPersonalizationContainer = function (sContainerKey) {
-        var sPrefixedContainerKey = "";
-        var oPromiseContainer = {};
-        var oDeferred = {};
-
         if (typeof sContainerKey !== "string") {
             throw new utils.Error("sContainerKey is not a string: sap.ushell.services.Personalization", " "); // Empty string for missing component information
         }
-        sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
+
+        const sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
+
         if (this._oContainerMap.containsKey(sPrefixedContainerKey)) {
             return this._oContainerMap.get(sPrefixedContainerKey).promise();
         }
-        oDeferred = new jQuery.Deferred();
-        oPromiseContainer = new PersonalizationContainer(this._oAdapterWithBackendAdapter.instance, sPrefixedContainerKey);
+
+        const oDeferred = new jQuery.Deferred();
+        const oPromiseContainer = new PersonalizationContainer(this._oAdapterWithBackendAdapter.instance, sPrefixedContainerKey);
         oPromiseContainer
-            .done(function (oContainer) {
-                oDeferred.resolve(oContainer);
-            })
-            .fail(function (oContainer) {
-                oDeferred.reject(oContainer);
-            });
+            .done(oDeferred.resolve)
+            .fail(oDeferred.reject);
         this._oContainerMap.put(sPrefixedContainerKey, oDeferred);
         return oDeferred.promise();
     };
@@ -641,23 +622,15 @@ sap.ui.define([
      */
     Personalization.prototype.delPersonalizationContainer = function (sContainerKey) {
         // delete the bag, the adapter container & the container
-        var oDeferred = {};
-        var sPrefixedContainerKey = "";
-        var that = this;
-
-        sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
-        oDeferred = new jQuery.Deferred();
+        const sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
+        const oDeferred = new jQuery.Deferred();
         this.getPersonalizationContainer(sContainerKey)
-            .fail(function () {
-                oDeferred.reject();
-            })
-            .done(function (/*oContainer*/) {
-                that._oAdapterWithBackendAdapter.instance.delAdapterContainer(sPrefixedContainerKey)
-                    .fail(function () {
-                        oDeferred.reject();
-                    })
-                    .done(function () {
-                        that._oContainerMap.remove(sPrefixedContainerKey);
+            .fail(oDeferred.reject)
+            .done((/* oContainer */) => {
+                this._oAdapterWithBackendAdapter.instance.delAdapterContainer(sPrefixedContainerKey)
+                    .fail(oDeferred.reject)
+                    .done(() => {
+                        this._oContainerMap.remove(sPrefixedContainerKey);
                         oDeferred.resolve();
                     });
             });
@@ -689,16 +662,13 @@ sap.ui.define([
      * @since 1.86.0
      * @private
      */
-    Personalization.prototype.resetEntirePersonalization = function () {
-        var oAdapter = this._getBackendAdapter();
-
-        return this.isResetEntirePersonalizationSupported()
-            .then(function (bIsSupported) {
-                if (bIsSupported) {
-                    return oAdapter.resetEntirePersonalization();
-                }
-                return Promise.reject();
-            });
+    Personalization.prototype.resetEntirePersonalization = async function () {
+        const oAdapter = this._getBackendAdapter();
+        const bIsSupported = await this.isResetEntirePersonalizationSupported();
+        if (bIsSupported) {
+            return oAdapter.resetEntirePersonalization();
+        }
+        return Promise.reject();
     };
 
     /**
@@ -712,25 +682,24 @@ sap.ui.define([
      * @since 1.86.0
      * @private
      */
-    Personalization.prototype.isResetEntirePersonalizationSupported = function () {
-        var oAdapter = this._getBackendAdapter();
+    Personalization.prototype.isResetEntirePersonalizationSupported = async function () {
+        const oAdapter = this._getBackendAdapter();
 
         if (typeof oAdapter.resetEntirePersonalization !== "function") {
-            return Promise.resolve(false);
+            return false;
         }
 
         if (typeof oAdapter.isResetEntirePersonalizationSupported === "function") {
-            return oAdapter.isResetEntirePersonalizationSupported()
-                .then(function (bIsSupported) {
-                    return bIsSupported;
-                })
-                .catch(function (oError) {
-                    Log.error("isResetEntirePersonalizationSupported failed with error: " + oError.toString());
-                    return Promise.reject(oError);
-                });
+            try {
+                const bIsSupported = await oAdapter.isResetEntirePersonalizationSupported();
+                return bIsSupported;
+            } catch (oError) {
+                Log.error(`isResetEntirePersonalizationSupported failed with error: ${oError.toString()}`);
+                return Promise.reject(oError);
+            }
         }
 
-        return Promise.resolve(true);
+        return true;
     };
 
     Personalization.prototype._adjustScope = personalizationUtils.adjustScope;

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

@@ -7,7 +7,7 @@ sap.ui.define([
     "sap/ui/core/UIComponent",
     "sap/ui/thirdparty/jquery",
     "sap/base/Log"
-], function (ushellUtils, personalizationUtils, constants, DateFormat, UIComponent, jQuery, Log) {
+], (ushellUtils, personalizationUtils, constants, DateFormat, UIComponent, jQuery, Log) => {
     "use strict";
 
     /**
@@ -81,7 +81,6 @@ sap.ui.define([
         this._oItemMap = new ushellUtils.Map();
     };
 
-
     /**
      * (Re)loads the current container data from the underlying storage asynchronously.
      * The current local data is discarded.
@@ -110,7 +109,7 @@ sap.ui.define([
         const that = this;
         oPrior.always(() => {
             that._oAdapterContainer.load()
-                .fail(function () {
+                .fail(() => {
                     // TODO
                     oDeferred.reject();
                 })
@@ -139,7 +138,6 @@ sap.ui.define([
         this._aLoadedItemKeys = this._oItemMap.keys().splice(0);
     };
 
-
     /**
      * @returns {boolean} Whether this container is expired
      *
@@ -178,7 +176,7 @@ sap.ui.define([
             const oFormatter = DateFormat.getDateInstance({ pattern: constants.S_ABAPTIMESTAMPFORMAT });
             const oNow = new Date();
             const sTimestampStorage = oFormatter.format(oNow, true); // true UTC times !
-            const sTimestampExpire = oFormatter.format(new Date(oNow.getTime() + this._getValidity() * 60000), /*UTC!*/ true);
+            const 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);
@@ -187,7 +185,7 @@ sap.ui.define([
         aItemKeys.forEach((sItemKey) => {
             this._oAdapterContainer.setItemValue(sItemKey, personalizationUtils.cloneToObject(this._oItemMap.get(sItemKey)));
         });
-        const aDiff = this._aLoadedItemKeys.filter(function (sItemKey) { return !(aItemKeys.indexOf(sItemKey) > -1); });
+        const aDiff = this._aLoadedItemKeys.filter((sItemKey) => { return !(aItemKeys.indexOf(sItemKey) > -1); });
         aDiff.forEach((sItemKey) => {
             this._oAdapterContainer.delItem(sItemKey);
         });
@@ -195,11 +193,11 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * Save the current container data at the underlying storage asynchronously at the earlies
+     * Save the current container data at the underlying storage asynchronously at the earliest
      * nDelayInMilliseconds seconds before.
      * The current state is serialized.
      *
-     * @param {int} nDelayInMilliseconds
+     * @param {int} nDelayInMilliseconds the delay.
      * @returns {Promise} Promise object
      *
      * The operation may wait for completion of another pending operation.
@@ -215,11 +213,11 @@ sap.ui.define([
 
         const that = this;
         function fnDelayedSave () {
-            oPrior.always(function () {
+            oPrior.always(() => {
                 try {
                     that._oAdapterContainer.save() // promise
-                        .fail(function () { oSaveDeferred.reject(); })
-                        .done(function () { oSaveDeferred.resolve(); });
+                        .fail(() => { oSaveDeferred.reject(); })
+                        .done(() => { oSaveDeferred.resolve(); });
                 } catch (e) {
                     oSaveDeferred.reject();
                 }
@@ -245,8 +243,8 @@ sap.ui.define([
         const oSaveDeferred = new jQuery.Deferred();
         const oPrior = this._oService._pendingContainerOperations_flushAddNext(this._sContainerKey, oSaveDeferred);
         oPrior
-            .fail(function () { oSaveDeferred.reject(); })
-            .done(function () { oSaveDeferred.resolve(); });
+            .fail(() => { oSaveDeferred.reject(); })
+            .done(() => { oSaveDeferred.resolve(); });
         return ushellUtils.promisify(oSaveDeferred.promise());
     };
 
@@ -259,10 +257,10 @@ sap.ui.define([
      */
     ContextContainer.prototype.getItemKeys = function () {
         // return a list of the (prefix stripped)  "Item" keys.
-        const aFilteredTrueItemKeys = this._oItemMap.keys().filter(function (s) {
+        const aFilteredTrueItemKeys = this._oItemMap.keys().filter((s) => {
             return s.startsWith(constants.S_ITEM_PREFIX);
         });
-        return aFilteredTrueItemKeys.map(function (sEntry) {
+        return aFilteredTrueItemKeys.map((sEntry) => {
             return sEntry.replace(constants.S_ITEM_PREFIX, "", "");
         });
     };
@@ -296,16 +294,16 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @param {*} sPrefix
-     * @param {*} sItemKey
-     * @returns {*}
+     * @param {string} sPrefix the item prefix
+     * @param {string} sItemKey the item key. The string length is restricted to 40 characters
+     * @returns {object} the value to which the specified key is mapped, or <code>undefined</code> if this map contains no mapping for the key.
      *
      * @since 1.120.0
      * @private
      */
     ContextContainer.prototype._getItemValueInternal = function (sPrefix, sItemKey) {
         if (typeof sItemKey !== "string" || typeof sPrefix !== "string") {
-            return undefined;
+            return;
         }
         return personalizationUtils.cloneToObject(this._oItemMap.get(sPrefix + sItemKey));
     };
@@ -342,9 +340,9 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @param {*} sItemPrefix
-     * @param {*} sItemKey
-     * @param {*} oItemValue
+     * @param {string} sItemPrefix the item prefix
+     * @param {string} sItemKey the item key. The string length is restricted to 40 characters
+     * @param {object} oItemValue item value (JSON object)
      *
      * @since 1.120.0
      * @private
@@ -356,11 +354,11 @@ sap.ui.define([
 
         if (sItemKey.length > 40) {
             Log.error(
-                "Personalization Service item key/variant set name (\""
-                + sItemKey
-                + "\") should be less than 40 characters [current :"
-                + sItemKey.length
-                + "]"
+                `Personalization Service item key/variant set name ("${
+                    sItemKey
+                }") should be less than 40 characters [current :${
+                    sItemKey.length
+                }]`
             );
         }
 
@@ -381,19 +379,18 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @param {*} sPrefix
-     * @param {*} sItemKey
-     * @returns {*}
+     * @param {string} sPrefix the item prefix
+     * @param {string} sItemKey the item key. The string length is restricted to 40 characters
      *
      * @since 1.120.0
      * @private
      */
     ContextContainer.prototype._delItemInternal = function (sPrefix, sItemKey) {
         if (typeof sItemKey !== "string") {
-            return undefined;
+            return;
         }
         if (typeof sPrefix !== "string") {
-            return undefined;
+            return;
         }
         this._oItemMap.remove(sPrefix + sItemKey);
     };

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

@@ -2,7 +2,7 @@
 sap.ui.define([
     "sap/ushell/utils",
     "sap/base/Log"
-], function (ushellUtils, Log) {
+], (ushellUtils, Log) => {
     "use strict";
 
     /**
@@ -15,6 +15,21 @@ sap.ui.define([
      *
      * @hideconstructor
      *
+     * @param {sap.ushell.services.PersonalizationV2} oService the personalization service.
+     * @param {object} oAdapter the service adapter for the personalization V2 service, as already provided by the container
+     * @param {sap.ushell.services.PersonalizationV2.PersId} oPersId JSON object consisting of the following parts:
+     *   container - Identifies the set of personalization data that is loaded/saved as one bundle from the front-end server.
+     *   item - The name of the object the personalization is applied to.
+     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope - scope object<br/>
+     *   currently the validity property of the scope object is relevant:
+     *   oScope.validity : validity of the container persistence in minutes<br/>
+     *   oScope.keyCategory : Type or category of key<br/>
+     *   oScope.writeFrequency : Expected frequency how often users will use this container to store data inside<br/>
+     *   oScope.clientStorageAllowed : Defines if storage on client side should be allowed or not<br/>
+     *   oScope.shared: Indicates the container is intended to be shared across multiple applications<br/>
+     *   E.g. <code> { validity : 30}</code> indicates a validity of the data for 30 minutes.
+     * @param {sap.ui.core.Component} oComponent the component.
+     *
      * @since 1.120.0
      * @public
      */
@@ -36,8 +51,8 @@ sap.ui.define([
 
     // todo: jsdoc
     /**
-     * @param {string} sPersContainer
-     * @returns {Promise<object>}
+     * @param {string} sPersContainer the personalization container key.
+     * @returns {Promise<sap.ushell.services.PersonalizationV2.ContextContainer>} resolves with the the personalization context container.
      *
      * @since 1.120.0
      * @private
@@ -63,7 +78,7 @@ sap.ui.define([
                 return oContainer.getItemValue(this._sPersItem);
             })
             .catch((oError)=> {
-                Log.error("Failed to get personalization data for Personalizer container: " + this._sPersContainer, oError);
+                Log.error(`Failed to get personalization data for Personalizer container: ${this._sPersContainer}`, oError);
                 return Promise.reject();
             });
     };
@@ -84,7 +99,7 @@ sap.ui.define([
                 return ushellUtils.promisify(oContainer.save());
             })
             .catch((oError)=> {
-                Log.error("Failed to get personalization data for Personalizer container: " + this._sPersContainer, oError);
+                Log.error(`Failed to get personalization data for Personalizer container: ${this._sPersContainer}`, oError);
                 return Promise.reject();
             });
     };
@@ -103,7 +118,7 @@ sap.ui.define([
                 return ushellUtils.promisify(oContainer.save());
             })
             .catch((oError)=> {
-                Log.error("Fail to delete Personalization data for Personalizer container: " + this._sPersContainer, oError);
+                Log.error(`Fail to delete Personalization data for Personalizer container: ${this._sPersContainer}`, oError);
                 return Promise.reject();
             });
     };