@sapui5/sap.ushell 1.138.1 → 1.139.0

package/src/main/js/sap/ushell/services/PersonalizationV2.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
  */
 sap.ui.define([
     "sap/base/Log",
@@ -24,7 +24,7 @@ sap.ui.define([
     "sap/ushell/services/PersonalizationV2/Variant",
     "sap/ushell/services/PersonalizationV2/VariantSet",
     "sap/ushell/services/PersonalizationV2/WindowAdapterContainer"
-], function (
+], (
     Log,
     Deferred,
     ManagedObject,
@@ -42,7 +42,7 @@ sap.ui.define([
     Variant,
     VariantSet,
     WindowAdapterContainer
-) {
+) => {
     "use strict";
 
     // TODO conditional loading
@@ -134,7 +134,7 @@ sap.ui.define([
 
     PersonalizationV2.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
     // legacy access to constants
     PersonalizationV2.prototype.constants = publicConstants;
 
@@ -153,8 +153,8 @@ sap.ui.define([
      * @private
      */
     PersonalizationV2.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
@@ -165,36 +165,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 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,
@@ -252,9 +250,9 @@ sap.ui.define([
      * @private
      */
     PersonalizationV2.prototype._getApplicationComponent = function () {
-        var sOwnerId = ManagedObject._sOwnerId;
+        const sOwnerId = ManagedObject._sOwnerId;
         if (sOwnerId) {
-            var oComponent = Component.getComponentById(sOwnerId);
+            const oComponent = Component.getComponentById(sOwnerId);
             if (BaseObject.isObjectA(oComponent, "sap.ui.core.Component")) {
                 return oComponent;
             }
@@ -388,13 +386,12 @@ sap.ui.define([
     };
 
     /**
-     * todo
-     * @param {string} sContainerKey
-     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope
-     * @param {boolean} bCreateEmpty
-     * @param {sap.ui.core.Component} oComponent
+     * @param {string} sContainerKey the personalization container key.
+     * @param {sap.ushell.services.PersonalizationV2.Scope} oScope the personalization scope.
+     * @param {boolean} bCreateEmpty whether the container should be created empty.
+     * @param {sap.ui.core.Component} oComponent the component
      *
-     * @returns {Promise}
+     * @returns {Promise<sap.ushell.services.PersonalizationV2.ContextContainer>} Resolves a new ContextContainer.
      *
      * @since 1.120.0
      * @private
@@ -404,39 +401,39 @@ sap.ui.define([
             throw new ushellUtils.Error("sContainerKey is not a string: sap.ushell.services.Personalization", " " /* Empty string for missing component information */);
         }
 
-        var bUseAppVariantStorage = !!(personalizationUtils.isAppVariant(oComponent) && (!oScope || !oScope.shared) && this._oAppVariantAdapterWithBackendAdapter);
+        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 ? this._oAppVariantAdapterWithBackendAdapter : this._oAdapterWithBackendAdapter;
-        var oTransientAdapter = this._oAdapterWindowOnly;
+        const oPersistentAdapter = bUseAppVariantStorage ? this._oAppVariantAdapterWithBackendAdapter : this._oAdapterWithBackendAdapter;
+        const oTransientAdapter = this._oAdapterWindowOnly;
 
-        var oChosenAdapter = personalizationUtils.pickAdapter(oScope, oTransientAdapter, oPersistentAdapter);
+        const oChosenAdapter = personalizationUtils.pickAdapter(oScope, oTransientAdapter, oPersistentAdapter);
 
         const oLoadedAdapter = await personalizationUtils.loadAdapter(oChosenAdapter);
 
-        var oContextContainer = new ContextContainer(this, oLoadedAdapter, sPrefixedContainerKey, oAdjustedScope, oComponent);
+        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 a 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)) {
             await oContextContainer.load();
@@ -467,41 +464,37 @@ sap.ui.define([
      */
     PersonalizationV2.prototype.deleteContainer = function (sContainerKey, oScope) {
         // delete the bag, the adapter container & the container
-        var sPrefixedContainerKey = "";
-        var that = this;
-        oScope = that._adjustScope(oScope);
+        let sPrefixedContainerKey = "";
+        oScope = this._adjustScope(oScope);
         sPrefixedContainerKey = personalizationUtils.addContainerPrefix(sContainerKey);
         const 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!
-                .then(function (/*oContainer*/) {
-                    var oAdapter;
+        const oPrior = this._pendingContainerOperations_cancelAddNext(sContainerKey, null);
+        oPrior.always(() => {
+            this.getContainer(sContainerKey, oScope) // delays to oPrior! registers a new op!
+                .then((/* 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 (oError) {
+                            .fail((oError) => {
                                 Log.error("Delete failed", oError);
                                 oDeferred.reject();
                             })
-                            .done(function () {
-                                oDeferred.resolve();
-                            });
-                    }, function (oError) {
+                            .done(oDeferred.resolve);
+                    }, (oError) => {
                         Log.error("Delete failed", oError);
                         oDeferred.reject();
                     });
                 })
-                .catch(function (oError) {
+                .catch((oError) => {
                     Log.error("Delete failed", oError);
-                    that._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // reinstall oPrior (!)
+                    this._pendingContainerOperations_cancelAddNext(sContainerKey, oDeferred); // reinstall oPrior (!)
                     oDeferred.reject();
                 });
         });
@@ -509,18 +502,17 @@ sap.ui.define([
     };
 
     /**
-     * todo
-     * @param {string} sContainerKey
-     * @param {jQuery.Deferred} oDeferred
+     * @param {string} sContainerKey the personalization container key.
+     * @param {jQuery.Deferred} [oDeferred] pending deferred.
      *
-     * @returns {jQuery.Deferred}
+     * @returns {jQuery.Deferred} that resolves after this operation is done.
      *
      * @since 1.120.0
      * @private
      */
     PersonalizationV2.prototype._pendingContainerOperations_flushAddNext = function (sContainerKey, oDeferred) {
         // return old promise, add oDeferred as new, if null, retain old!
-        var oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
+        let oPendingOpDeferred = this._oPendingOperationsMap.get(sContainerKey);
         if (!oPendingOpDeferred) {
             oPendingOpDeferred = new jQuery.Deferred();
             oPendingOpDeferred.resolve();
@@ -531,10 +523,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();
         }
@@ -542,18 +534,16 @@ sap.ui.define([
     };
 
     /**
-     * todo
-     * @param {string} sContainerKey
-     * @param {jQuery.Deferred} oDeferred
+     * @param {string} sContainerKey the personalization container key.
+     * @param {jQuery.Deferred} [oDeferred] pending deferred.
      *
-     * @returns {jQuery.Deferred}
+     * @returns {jQuery.Deferred} that resolves after this operation is done.
      *
      * @since 1.120.0
      * @private
      */
     PersonalizationV2.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,16 +588,14 @@ sap.ui.define([
      * @since 1.120.0
      * @private
      */
-    PersonalizationV2.prototype.resetEntirePersonalization = function () {
-        var oAdapter = this._getBackendAdapter();
-
-        return this.isResetEntirePersonalizationSupported()
-            .then(function (bIsSupported) {
-                if (bIsSupported) {
-                    return oAdapter.resetEntirePersonalization();
-                }
-                return Promise.reject();
-            });
+    PersonalizationV2.prototype.resetEntirePersonalization = async function () {
+        const oAdapter = this._getBackendAdapter();
+
+        const bIsSupported = await this.isResetEntirePersonalizationSupported();
+        if (bIsSupported) {
+            return oAdapter.resetEntirePersonalization();
+        }
+        return Promise.reject();
     };
 
     /**
@@ -622,25 +610,24 @@ sap.ui.define([
      * @since 1.120.0
      * @private
      */
-    PersonalizationV2.prototype.isResetEntirePersonalizationSupported = function () {
-        var oAdapter = this._getBackendAdapter();
+    PersonalizationV2.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);
-                    return Promise.reject(oError);
-                });
+            try {
+                const bIsSupported = await oAdapter.isResetEntirePersonalizationSupported();
+                return bIsSupported;
+            } catch (oError) {
+                Log.error("isResetEntirePersonalizationSupported failed with error:", oError);
+                return Promise.reject(oError);
+            }
         }
 
-        return Promise.resolve(true);
+        return true;
     };
 
     PersonalizationV2.prototype._adjustScope = personalizationUtils.adjustScope;

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

@@ -2,21 +2,16 @@
 /**
  * @fileOverview The extensions which plugins can use to customise the launchpad
  *
- * @version 1.138.1
+ * @version 1.139.0
  * @private
  */
 sap.ui.define([
     "sap/ushell/services/PluginManager/HeaderExtensions",
     "sap/ushell/services/PluginManager/MenuExtensions"
 
-], function (HeaderExtensions, fnMenuExtensions) {
+], (HeaderExtensions, fnMenuExtensions) => {
     "use strict";
 
-    var O_AVAILABLE_EXTENSIONS = {
-        Header: getHeaderExtensions,
-        Menu: getMenuExtensions
-    };
-
     /**
      * Resolves to the MenuExtensions, which allow modifying menu entries at runtime.
      *
@@ -46,10 +41,15 @@ sap.ui.define([
         return Promise.resolve(HeaderExtensions);
     }
 
+    const O_AVAILABLE_EXTENSIONS = {
+        Header: getHeaderExtensions,
+        Menu: getMenuExtensions
+    };
+
     function getExtensions (sPluginName, sExtensionName) {
-        var fnExtensionFactory = O_AVAILABLE_EXTENSIONS[sExtensionName];
+        const fnExtensionFactory = O_AVAILABLE_EXTENSIONS[sExtensionName];
         if (!fnExtensionFactory) {
-            return Promise.reject("Unsupported extension: '" + sExtensionName + "'");
+            return Promise.reject(`Unsupported extension: '${sExtensionName}'`);
         }
         return fnExtensionFactory(sPluginName);
     }

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

@@ -2,11 +2,11 @@
 
 /**
  * @fileOverview The extensions for the ShellHeader
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/ushell/EventHub"
-], function (EventHub) {
+], (EventHub) => {
     "use strict";
 
     /**

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

@@ -3,9 +3,9 @@
 /**
  * @fileOverview The extensions for the MenuBar, an interface to let plugins request menu entry providers.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
-sap.ui.define(["sap/ushell/Container"], function (Container) {
+sap.ui.define(["sap/ushell/Container"], (Container) => {
     "use strict";
 
     /**
@@ -45,13 +45,13 @@ sap.ui.define(["sap/ushell/Container"], function (Container) {
          * Such modifications lead to re-rendering of the menu with a visual flicker.
          *
          * @param {string[]} nodeIds A list of the nodeIds to modify.
-         * @returns {Promise<Object.<string, function>>} A map with the nodeId as keys and the update functions as values.
+         * @returns {Promise<object.<string, function>>} A map with the nodeId as keys and the update functions as values.
          *
          * @private
          * @since 1.85
          */
         return function getMenuEntryProvider (nodeIds) {
-            return Container.getServiceAsync("Menu").then(function (menuService) {
+            return Container.getServiceAsync("Menu").then((menuService) => {
                 return menuService.getEntryProvider(pluginName, nodeIds);
             });
         };

package/src/main/js/sap/ushell/services/PluginManager/SimpleExpression.js

@@ -4,13 +4,12 @@
  * This allows to enter simple postfix expressions and to test if an id complies with the expression.
  * It can replace unsafe regular expressions that are vulnerable to ReDoS attacks.
  *
- * @version 1.138.1
+ * @version 1.139.0
  */
 
-
-sap.ui.define([], function () {
+sap.ui.define([], () => {
     "use strict";
-    var SimpleExpression = {};
+    const SimpleExpression = {};
 
     /**
      * Parses and evaluates a postfix expression for a given id
@@ -31,7 +30,6 @@ sap.ui.define([], function () {
     SimpleExpression.parseAndEvaluate = function (sId, sExpression) {
         const aExpression = sExpression.split(" ");
         return SimpleExpression.evaluate(sId, aExpression);
-
     };
 
     /**
@@ -43,10 +41,9 @@ sap.ui.define([], function () {
      * @since 1.133.0
      */
     SimpleExpression.evaluate = function (sId, aPostfix) {
-
         // Help and result stack
-        var oStack = [];
-        var oElement;
+        const oStack = [];
+        let oElement;
 
         // main loop, which is executed as long as there are oElements in the Postfix Array
         while (aPostfix.length) {

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's PluginManager service. Allows handling the loading of Fiori Launchpad plugins.
- * @version 1.138.1
+ * @version 1.139.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -51,6 +51,10 @@ sap.ui.define([
      *
      * @hideconstructor
      *
+     * @param {object} oContainerInterface the container interface, not used.
+     * @param {string} sParameter the parameter string, not used.
+     * @param {object} oServiceProperties the service configuration.
+     *
      * @since 1.38
      * @private
      */
@@ -80,7 +84,7 @@ sap.ui.define([
          * @param {object} sPluginName Plugin itself.
          * @param {jQuery.Deferred} oPluginDeferred A deferred object that gets resolved when the respective component has been
          *   instantiated successfully, and rejected when the instantiation has been failing.
-         * @param {Promise<object>} oPostMessageInterfacePromise The application postMessage interface.
+         * @param {object} oPostMessageInterface The application postMessage interface.
          * @since 1.38
          * @private
          */
@@ -243,7 +247,7 @@ sap.ui.define([
             // disable loading of default dependencies for plugins (only used for old apps w/o manifest)
             oApplicationProperties.loadDefaultDependencies = false;
 
-            //set injected interface if needed
+            // set injected interface if needed
             if (oPostMessageInterface !== undefined) {
                 oApplicationProperties.oPostMessageInterface = oPostMessageInterface;
             }
@@ -351,7 +355,7 @@ sap.ui.define([
             // insert plugins from plugin configuration into plugin collection which is sorted by category
             const aPluginCategoriesToLoad = await this._addPluginsIntoCollection(oPlugins, sSapAgentsIds);
 
-            //build the list of names of plugins that has agents (for cFLP)
+            // build the list of names of plugins that has agents (for cFLP)
             try {
                 if (this._oConfig.isBlueBox !== true) {
                     this._buildNamesOfPluginsWithAgents();
@@ -505,8 +509,8 @@ sap.ui.define([
             // evaluate discard mode
             switch (sFilterMode) {
                 case "allowFilterPluginsAccordingToSimpleExpression":
-                // remove prefix 'allow-filter-' from the plugin mode
-                    var sPluginIdToAllow = sPluginMode.replace("allow-filter-", "");
+                    // remove prefix 'allow-filter-' from the plugin mode
+                    const sPluginIdToAllow = sPluginMode.replace("allow-filter-", "");
                     return SimpleExpression.filterByExpression(aPluginIds, sPluginIdToAllow);
                 case "discardAlmostAllPlugins":
                     return aPluginIds.filter((sId) => {
@@ -540,8 +544,8 @@ sap.ui.define([
 
             ushellUtils.setPerformanceMark(`FLP -- PluginManager.startLoadPlugins[${sPluginCategory}]`);
 
-            //plugins are now getting interface to define custom post
-            //message api
+            // plugins are now getting interface to define custom post
+            // message api
             if (sPluginCategory === S_DEFAULT_PLUGIN_CATEGORY) {
                 oPostMessageInterface = PostMessagePluginInterface.getInterface();
             }