@sapui5/sap.ushell 1.134.1 → 1.135.0

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.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -13,7 +13,7 @@ sap.ui.define([
     "sap/ushell/Config",
     "sap/ushell/Container",
     "sap/ushell/services/PluginManager/SimpleExpression"
-], function (
+], (
     Log,
     jQuery,
     fnGetExtensions,
@@ -22,14 +22,14 @@ sap.ui.define([
     Config,
     Container,
     SimpleExpression
-) {
+) => {
     "use strict";
 
-    var S_COMPONENT_NAME = "sap.ushell.services.PluginManager";
-    var S_PLUGIN_TYPE_PARAMETER = "sap-ushell-plugin-type";
-    var S_DEFAULT_PLUGIN_CATEGORY = "RendererExtensions";
-    var S_FLP_AREAS_PLUGIN_COMPONENT = "sap.ushell.components.shell.defaults"; // contains Me Area and Notifications Area
-    var aSupportedPluginCategories = [
+    const S_COMPONENT_NAME = "sap.ushell.services.PluginManager";
+    const S_PLUGIN_TYPE_PARAMETER = "sap-ushell-plugin-type";
+    const S_DEFAULT_PLUGIN_CATEGORY = "RendererExtensions";
+    const S_FLP_AREAS_PLUGIN_COMPONENT = "sap.ushell.components.shell.defaults"; // contains Me Area and Notifications Area
+    const aSupportedPluginCategories = [
         S_DEFAULT_PLUGIN_CATEGORY,
         "UserDefaults",
         "UserImage",
@@ -55,7 +55,7 @@ sap.ui.define([
      * @private
      */
     function PluginManager (oContainerInterface, sParameter, oServiceProperties) {
-        var that = this;
+        const that = this;
 
         this._oPluginCollection = {};
         this._oCategoryLoadingProgress = {};
@@ -68,7 +68,7 @@ sap.ui.define([
         }
 
         // initialize plugin collection
-        aSupportedPluginCategories.forEach(function (sPluginCategory) {
+        aSupportedPluginCategories.forEach((sPluginCategory) => {
             that._oPluginCollection[sPluginCategory] = {};
             that._oCategoryLoadingProgress[sPluginCategory] = new jQuery.Deferred();
         });
@@ -86,17 +86,17 @@ sap.ui.define([
          */
         this._handlePluginCreation = async function (sCategory, sPluginName, oPluginDeferred, oPostMessageInterfacePromise) {
             const oPostMessageInterface = await oPostMessageInterfacePromise;
-            var oPlugin = (that._oPluginCollection[sCategory])[sPluginName];
-            ushellUtils.setPerformanceMark("FLP -- PluginManager.loadPlugin[" + sCategory + "][" + sPluginName + "]");
+            const oPlugin = (that._oPluginCollection[sCategory])[sPluginName];
+            ushellUtils.setPerformanceMark(`FLP -- PluginManager.loadPlugin[${sCategory}][${sPluginName}]`);
             try {
                 if (oPlugin.hasOwnProperty("component")) {
                     // only add handler to promise in case that the component has already been loaded
                     if (that._mInitializedComponentPromise.hasOwnProperty(oPlugin.component)) {
                         that._mInitializedComponentPromise[oPlugin.component].then(
-                            function () {
+                            () => {
                                 that._instantiateComponent(oPlugin, oPluginDeferred, oPostMessageInterface);
                             },
-                            function () { // note, no error logging here
+                            () => { // note, no error logging here
                                 that._instantiateComponent(oPlugin, oPluginDeferred, oPostMessageInterface);
                             }
                         );
@@ -104,11 +104,11 @@ sap.ui.define([
                         that._mInitializedComponentPromise[oPlugin.component] = that._instantiateComponent(oPlugin, oPluginDeferred, oPostMessageInterface);
                     }
                 } else {
-                    Log.error("Invalid plugin configuration. The plugin " + sPluginName
-                        + " must contain a <component> key", S_COMPONENT_NAME);
+                    Log.error(`Invalid plugin configuration. The plugin ${sPluginName
+                    } must contain a <component> key`, S_COMPONENT_NAME);
                 }
             } catch (oError) {
-                Log.error("Error while loading bootstrap plugin: " + oPlugin.component || "", S_COMPONENT_NAME);
+                Log.error(`Error while loading bootstrap plugin: ${oPlugin.component}` || "", S_COMPONENT_NAME);
 
                 // make sure to reject promise in case of user default plug-in
                 if (oPluginDeferred) {
@@ -146,7 +146,7 @@ sap.ui.define([
          * @private
          */
         this._handleXhrAuthentication = function (oApplicationConfiguration, sComponentUrl) {
-            var iXhrLogonTimeout;
+            let iXhrLogonTimeout;
 
             if (oApplicationConfiguration &&
                 ["true", true, "X"].indexOf(oApplicationConfiguration["sap-ushell-xhr-authentication"]) > -1) {
@@ -183,7 +183,7 @@ sap.ui.define([
                         Container.setXhrLogonTimeout(sComponentUrl, iXhrLogonTimeout);
                     }
                 }
-                return jQuery.ajax(sComponentUrl + "/" + this._getFileNameForXhrAuth(), { dataType: "text" });
+                return jQuery.ajax(`${sComponentUrl}/${this._getFileNameForXhrAuth()}`, { dataType: "text" });
             }
             // just resolve the promise directly if no xhr-authentication required
             return jQuery.when();
@@ -200,9 +200,9 @@ sap.ui.define([
          * @private
          */
         this._instantiateComponent = function (oPlugin, oPluginDeferred, oPostMessageInterface) {
-            var oDeferred = new jQuery.Deferred();
-            var oComponentOptions = JSON.parse(JSON.stringify(oPlugin));
-            var oApplicationProperties = {
+            const oDeferred = new jQuery.Deferred();
+            const oComponentOptions = JSON.parse(JSON.stringify(oPlugin));
+            const oApplicationProperties = {
                 ui5ComponentName: oComponentOptions.component,
                 url: oComponentOptions.url,
                 getExtensions: fnGetExtensions.bind(null, oPlugin.component)
@@ -211,9 +211,9 @@ sap.ui.define([
             function makeRejectHandler (sErrorLogMessage) {
                 return function (oError) {
                     sErrorLogMessage = sErrorLogMessage ||
-                        "Cannot create UI5 plugin component: (componentId/appdescrId :" + oApplicationProperties.ui5ComponentName + ")\n"
-                        + oError + " properties " + JSON.stringify(oApplicationProperties)
-                        + "\n This indicates a plugin misconfiguration, see e.g. Note 2316443.";
+                        `Cannot create UI5 plugin component: (componentId/appdescrId :${oApplicationProperties.ui5ComponentName})\n${
+                            oError} properties ${JSON.stringify(oApplicationProperties)
+                        }\n This indicates a plugin misconfiguration, see e.g. Note 2316443.`;
 
                     // errors always logged per component
                     oError = oError || "";
@@ -250,9 +250,9 @@ sap.ui.define([
             }
 
             Container.getServiceAsync("Ui5ComponentLoader")
-                .then(function (UI5ComponentLoaderService) {
+                .then((UI5ComponentLoaderService) => {
                     this._handleXhrAuthentication(oApplicationProperties.applicationConfiguration, oComponentOptions.url)
-                        .done(function () {
+                        .done(() => {
                             UI5ComponentLoaderService
                                 .createComponent(
                                     oApplicationProperties,
@@ -260,16 +260,16 @@ sap.ui.define([
                                     [],
                                     UI5ComponentType.Plugin
                                 )
-                                .done(function (oLoadedComponent) {
+                                .then(function (oLoadedComponent) {
                                     if (oPluginDeferred) {
                                         oPluginDeferred.resolve(oLoadedComponent);
                                     }
                                     oDeferred.resolve.apply(this, arguments);
                                 })
-                                .fail(makeRejectHandler());
+                                .catch(makeRejectHandler());
                         })
                         .fail(makeRejectHandler("XHR logon for FLP plugin failed"));
-                }.bind(this))
+                })
                 .catch(makeRejectHandler());
 
             return oDeferred.promise();
@@ -305,6 +305,24 @@ sap.ui.define([
             return JSON.parse(JSON.stringify(this._oPluginCollection));
         };
 
+        /**
+         * Checks if a plugin is configured in a given category.
+         *
+         * @param {string} sPluginName The name of the plugin.
+         * @param {string} [sCategory=RendererExtension] The category of the plugin. If omitted the default category "RendererExtension" is used.
+         * @returns {boolean} Returns true if the plugin is configured in the specified category, otherwise false. It also respects the sap-ushell-xx-pluginmode URL parameter.
+         * @since 1.135.0
+         * @private
+         */
+        this.isPluginConfigured = function (sPluginName, sCategory = S_DEFAULT_PLUGIN_CATEGORY) {
+            if (!this._oPluginCollection[sCategory]) {
+                return false;
+            }
+            const sPluginMode = new URLSearchParams(window.location.search).get("sap-ushell-xx-pluginmode") || "";
+            const aPluginIds = this.filterPluginIds(Object.keys(this._oPluginCollection[sCategory]), sPluginMode, sCategory);
+            return aPluginIds.includes(sPluginName);
+        };
+
         /**
          * Initializes the PluginManager with a certain set of plugins.
          * It's task is to insert those plugins systematically into a plugin collection handled by
@@ -325,7 +343,7 @@ sap.ui.define([
             if (this._oConfig.isBlueBox === true) {
                 sSapAgentsIds = new URLSearchParams(window.location.search).get("sap-plugins");
                 if (sSapAgentsIds && sSapAgentsIds.length > 0) {
-                    sSapAgentsIds = "," + sSapAgentsIds + ",";
+                    sSapAgentsIds = `,${sSapAgentsIds},`;
                 } else {
                     sSapAgentsIds = undefined;
                 }
@@ -356,7 +374,7 @@ sap.ui.define([
                 return PostMessageAPIInterface;
             }
 
-            const [PostMessagePluginInterface] = await ushellUtils.requireAsync(["sap/ushell/components/applicationIntegration/PostMessagePluginInterface"]);
+            const [PostMessagePluginInterface] = await ushellUtils.requireAsync(["sap/ushell/appIntegration/PostMessagePluginInterface"]);
             return PostMessagePluginInterface;
         };
 
@@ -370,7 +388,7 @@ sap.ui.define([
          * @private
          */
         this._addPluginsIntoCollection = async function (oPlugins, sSapAgentsIds = "") {
-            var aPluginCategoriesToLoad = [];
+            const aPluginCategoriesToLoad = [];
             for (const sPluginName of Object.keys(oPlugins).sort()) {
                 const oCurrentPlugin = oPlugins[sPluginName] || {};
                 const oPluginConfig = oCurrentPlugin.config || {};
@@ -447,8 +465,8 @@ sap.ui.define([
          * @private
          */
         this._isFormFactorSupported = function (oPlugin) {
-            var oDeviceTypesSupport = oPlugin.deviceTypes;
-            var sCurrentFormFactor = ushellUtils.getFormFactor();
+            const oDeviceTypesSupport = oPlugin.deviceTypes;
+            const sCurrentFormFactor = ushellUtils.getFormFactor();
 
             if (oDeviceTypesSupport && oDeviceTypesSupport[sCurrentFormFactor] === false) {
                 return false;
@@ -483,7 +501,7 @@ sap.ui.define([
          */
         this.filterPluginIds = function (aPluginIds, sPluginMode, sPluginCategory) {
             // determine discard mode
-            var sDiscardMode;
+            let sDiscardMode;
 
             if (sPluginMode.startsWith("discard-filter-")) {
                 sDiscardMode = "discardFilterPluginsAccordingToSimpleExpression";
@@ -495,18 +513,18 @@ sap.ui.define([
             // evaluate discard mode
             switch (sDiscardMode) {
                 case "discardFilterPluginsAccordingToSimpleExpression":
-                    // remove prefix 'discard-' from the plugin mode
+                // remove prefix 'discard-' from the plugin mode
                     var sPluginIdToDiscard = sPluginMode.replace("discard-filter-", "");
                     return SimpleExpression.filterByExpression(aPluginIds, sPluginIdToDiscard);
                 case "discardAlmostAllPlugins":
-                    return aPluginIds.filter(function (sId) {
-                        // skip all plugins apart from the one containing Me Area and Notifications Area
+                    return aPluginIds.filter((sId) => {
+                    // skip all plugins apart from the one containing Me Area and Notifications Area
                         return (that._oPluginCollection[sPluginCategory][sId].component === S_FLP_AREAS_PLUGIN_COMPONENT);
                     });
                 case "noDiscard":
                 default:
                     return aPluginIds;
-                }
+            }
         };
 
         /**
@@ -526,9 +544,9 @@ sap.ui.define([
          * @private
          */
         this.loadPlugins = function (sPluginCategory) {
-            var oPostMessageInterfacePromise = Promise.resolve();
+            let oPostMessageInterfacePromise = Promise.resolve();
 
-            ushellUtils.setPerformanceMark("FLP -- PluginManager.startLoadPlugins[" + sPluginCategory + "]");
+            ushellUtils.setPerformanceMark(`FLP -- PluginManager.startLoadPlugins[${sPluginCategory}]`);
 
             //plugins are now getting interface to define custom post
             //message api
@@ -545,17 +563,17 @@ sap.ui.define([
                 }
                 // check whether plugins are existing in the respective category
                 if (Object.keys(that._oPluginCollection[sPluginCategory]).length > 0) {
-                    var aPluginPromises = [];
-                    var aPluginIds = Object.keys(that._oPluginCollection[sPluginCategory]);
-                    var sPluginMode = new URLSearchParams(window.location.search).get("sap-ushell-xx-pluginmode") || "";
+                    const aPluginPromises = [];
+                    let aPluginIds = Object.keys(that._oPluginCollection[sPluginCategory]);
+                    const sPluginMode = new URLSearchParams(window.location.search).get("sap-ushell-xx-pluginmode") || "";
                     aPluginIds = this.filterPluginIds(aPluginIds, sPluginMode, sPluginCategory, that);
 
                     // loop over plugins in respective plugin category which should be loaded
-                    aPluginIds.forEach(function (sPluginName) {
-                        var oPlugin = that._oPluginCollection[sPluginCategory][sPluginName];
+                    aPluginIds.forEach((sPluginName) => {
+                        const oPlugin = that._oPluginCollection[sPluginCategory][sPluginName];
                         if (!oPlugin.loaded) {
                             oPlugin.loaded = true;
-                            var oPluginDeferred = new jQuery.Deferred();
+                            const oPluginDeferred = new jQuery.Deferred();
                             aPluginPromises.push(oPluginDeferred.promise());
                             that._handlePluginCreation(sPluginCategory, sPluginName, oPluginDeferred, oPostMessageInterfacePromise);
                         }
@@ -564,23 +582,23 @@ sap.ui.define([
                     if (aPluginPromises.length > 0) {
                         // we will resolve the category promise when all the plugins finish loading, regardless if they fail or not,
                         // this means that the category promise will be resolved only after the last plugin finish loading
-                        Promise.allSettled(aPluginPromises.map(function (oPromise, idx) {
-                            return new Promise(function (fnResolve) {
-                                var oResult = {
+                        Promise.allSettled(aPluginPromises.map((oPromise, idx) => {
+                            return new Promise((fnResolve) => {
+                                const oResult = {
                                     pluginName: aPluginIds[idx],
                                     success: true
                                 };
-                                oPromise.done(function () {
+                                oPromise.done(() => {
                                     fnResolve(oResult);
-                                }).fail(function (ex) {
+                                }).fail((ex) => {
                                     oResult.success = false;
                                     oResult.error = ex;
                                     fnResolve(oResult);
                                 });
                             });
-                        })).then(function (aResults) {
-                            ushellUtils.setPerformanceMark("FLP -- PluginManager.endLoadPlugins[" + sPluginCategory + "]");
-                            that._oCategoryLoadingProgress[sPluginCategory].resolve(aResults.map(function (element) {
+                        })).then((aResults) => {
+                            ushellUtils.setPerformanceMark(`FLP -- PluginManager.endLoadPlugins[${sPluginCategory}]`);
+                            that._oCategoryLoadingProgress[sPluginCategory].resolve(aResults.map((element) => {
                                 return element.value;
                             }));
                         });
@@ -591,8 +609,8 @@ sap.ui.define([
                 }
             } else {
                 // plugin category is not supported
-                Log.error("Plugins with category " + sPluginCategory + " cannot be loaded by the PluginManager", S_COMPONENT_NAME);
-                that._oCategoryLoadingProgress[sPluginCategory].reject("Plugins with category " + sPluginCategory + " cannot be loaded by the PluginManager");
+                Log.error(`Plugins with category ${sPluginCategory} cannot be loaded by the PluginManager`, S_COMPONENT_NAME);
+                that._oCategoryLoadingProgress[sPluginCategory].reject(`Plugins with category ${sPluginCategory} cannot be loaded by the PluginManager`);
             }
 
             return that._oCategoryLoadingProgress[sPluginCategory].promise();
@@ -607,14 +625,14 @@ sap.ui.define([
          * @private
          */
         this._buildNamesOfPluginsWithAgents = function () {
-            var sNames = "";
+            let sNames = "";
 
-            Object.keys(that._oPluginCollection).forEach(function (sCategory) {
-                Object.keys(that._oPluginCollection[sCategory]).forEach(function (sPlugin) {
-                    var oPlugin = that._oPluginCollection[sCategory][sPlugin];
+            Object.keys(that._oPluginCollection).forEach((sCategory) => {
+                Object.keys(that._oPluginCollection[sCategory]).forEach((sPlugin) => {
+                    const oPlugin = that._oPluginCollection[sCategory][sPlugin];
                     if (oPlugin && oPlugin.enabled && oPlugin.enabled === true) {
                         if (oPlugin.config && oPlugin.config["sap-plugin-agent"] === true) {
-                            sNames += (oPlugin.config["sap-plugin-agent-id"] || sPlugin) + ",";
+                            sNames += `${oPlugin.config["sap-plugin-agent-id"] || sPlugin},`;
                         }
                     }
                 });

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's search service which provides Enterprise Search via SINA.
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define(["sap/ui/core/Lib"], function (Library) {
     "use strict";

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search for myHome.
  *
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes the searchable content.
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Shell Navigation Service.
- * @version 1.134.1
+ * @version 1.135.0
  * @deprecated since 1.120. Use {@link sap.ushell.services.Navigation} for Navigation instead.
  */
 sap.ui.define([

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

@@ -12,7 +12,7 @@
  * it is pertinent that the API user employs this service's version of <code>toExternal()</code> for cross application
  * navigation (instead) of using the one provided by CrossApplicationNavigation service.</p>
  *
- * @version 1.134.1
+ * @version 1.135.0
  *
  * @deprecated since 1.112. This service has been deprecated. Please use the CrossApplicationNavigation service instead.
  */

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview APIs for the S/4 MyHome
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's UI tracing service.
  *
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",

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

@@ -6,7 +6,7 @@
  * Service wrapper for the sap/ushell/utils/UrlShortening module.
  * @deprecated since 1.118. Please use the UrlShortening module directly.
  *
- * @version 1.134.1
+ * @version 1.135.0
  */
  sap.ui.define(["sap/ushell/utils/UrlShortening"], function (UrlShortening) {
     "use strict";

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

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.134.1
+ * @version 1.135.0
  */
 sap.ui.define([
     "sap/ushell/utils",