@sapui5/sap.ushell 1.136.3 → 1.138.1

package/src/main/js/sap/ushell/appRuntime/ui5/plugins/rtaShell/Component.js

@@ -1,146 +1,138 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
-	"sap/ui/core/Component",
-	"sap/ui/core/Element",
-	"sap/ui/thirdparty/jquery",
-	"sap/ushell/api/RTA",
-	"sap/ushell/appRuntime/ui5/plugins/baseRta/AppLifeCycleUtils",
-	"sap/ushell/appRuntime/ui5/plugins/baseRta/Renderer"
-], function (
-	Component,
-	Element,
-	jQuery,
-	RtaApi,
-	AppLifeCycleUtils,
-	Renderer
-) {
-	"use strict";
+    "sap/ui/core/Component",
+    "sap/ui/core/Element",
+    "sap/ui/thirdparty/jquery",
+    "sap/ushell/api/RTA",
+    "sap/ushell/appRuntime/ui5/plugins/baseRta/AppLifeCycleUtils",
+    "sap/ushell/appRuntime/ui5/plugins/baseRta/Renderer"
+], (
+    Component,
+    Element,
+    jQuery,
+    RtaApi,
+    AppLifeCycleUtils,
+    Renderer
+) => {
+    "use strict";
 
-	let oPostMessageInterface;
+    let oPostMessageInterface;
 
-	function getInitialConfiguration () {
-		return {
-			sComponentName: "sap.ushell.appRuntime.ui5.plugins.rtaShell",
-			layer: "CUSTOMER",
-			id: "RTA_AppRuntime_Plugin_ActionButton",
-			text: "RTA_BUTTON_TEXT",
-			icon: "sap-icon://wrench",
-			visible: false
-		};
-	}
+    function getInitialConfiguration () {
+        return {
+            sComponentName: "sap.ushell.appRuntime.ui5.plugins.rtaShell",
+            layer: "CUSTOMER",
+            id: "RTA_AppRuntime_Plugin_ActionButton",
+            text: "RTA_BUTTON_TEXT",
+            icon: "sap-icon://wrench",
+            visible: false
+        };
+    }
 
-	function switchToolbarVisibility (bVisible) {
-		RtaApi.setShellHeaderVisibility(bVisible, false);
-	}
+    function switchToolbarVisibility (bVisible) {
+        RtaApi.setShellHeaderVisibility(bVisible, false);
+    }
 
-	function postStartUIAdaptationToApp () {
-		return new Promise(function (resolve, reject) {
-			switchToolbarVisibility(false);
-			oPostMessageInterface.postMessageToApp(
-				"user.postapi.rtaPlugin",
-				"startUIAdaptation"
-			).done(resolve).fail(reject);
-		});
-	}
+    function postStartUIAdaptationToApp () {
+        return new Promise((resolve, reject) => {
+            switchToolbarVisibility(false);
+            oPostMessageInterface.postMessageToApp(
+                "user.postapi.rtaPlugin",
+                "startUIAdaptation"
+            ).done(resolve).fail(reject);
+        });
+    }
 
-	return Component.extend("sap.ushell.appRuntime.ui5.plugins.rtaShell.Component", {
-		metadata: {
-			manifest: "json",
+    return Component.extend("sap.ushell.appRuntime.ui5.plugins.rtaShell.Component", {
+        metadata: {
+            manifest: "json",
             library: "sap.ushell"
-		},
+        },
 
-		init: function () {
-			this.mConfig = getInitialConfiguration();
+        init: function () {
+            this.mConfig = getInitialConfiguration();
 
-			oPostMessageInterface = this.getComponentData().oPostMessageInterface;
+            oPostMessageInterface = this.getComponentData().oPostMessageInterface;
 
-			this._registerPostMessages();
-		},
+            this._registerPostMessages();
+        },
 
-		_registerPostMessages: function () {
-			oPostMessageInterface.registerPostMessageAPIs({
-				"user.postapi.rtaPlugin": {
-					inCalls: {
-						activatePlugin: {
-							executeServiceCallFn: function () {
-								return oPostMessageInterface.createPostMessageResult(this._initPlugin());
-							}.bind(this)
-						},
-						showAdaptUI: {
-							executeServiceCallFn: async function () {
-								await this._changeActionButtonVisibility(true/*bVisible*/);
-								return oPostMessageInterface.createPostMessageResult();
-							}.bind(this)
-						},
-						switchToolbarVisibility: {
-							executeServiceCallFn: function (oServiceParams) {
-								const bVisible = oServiceParams.oMessageData.body.visible;
-								switchToolbarVisibility(bVisible);
-								return oPostMessageInterface.createPostMessageResult();
-							}
-						}
-					},
-					outCalls: {
-						startUIAdaptation: {}
-					}
-				}
-			});
-		},
+        _registerPostMessages: function () {
+            oPostMessageInterface.registerPostMessageAPIs({
+                "user.postapi.rtaPlugin": {
+                    inCalls: {
+                        activatePlugin: {
+                            executeServiceCallFn: function () {
+                                return oPostMessageInterface.createPostMessageResult(this._initPlugin());
+                            }.bind(this)
+                        },
+                        showAdaptUI: {
+                            executeServiceCallFn: async function () {
+                                await this._changeActionButtonVisibility(true/* bVisible */);
+                                return oPostMessageInterface.createPostMessageResult();
+                            }.bind(this)
+                        },
+                        hideAdaptUI: {
+                            executeServiceCallFn: async function () {
+                                await this._changeActionButtonVisibility(false/* bVisible */);
+                                return oPostMessageInterface.createPostMessageResult();
+                            }.bind(this)
+                        },
+                        switchToolbarVisibility: {
+                            executeServiceCallFn: function (oServiceParams) {
+                                const bVisible = oServiceParams.oMessageData.body.visible;
+                                switchToolbarVisibility(bVisible);
+                                return oPostMessageInterface.createPostMessageResult();
+                            }
+                        }
+                    },
+                    outCalls: {
+                        startUIAdaptation: {}
+                    }
+                }
+            });
+        },
 
-		_initPlugin: function () {
-			if (this.bIsInitialized) {
-				return new jQuery.Deferred().resolve();
-			}
-			this.bIsInitialized = true;
-			this.mConfig.i18n = this.getModel("i18n").getResourceBundle();
+        _initPlugin: function () {
+            if (this.bIsInitialized) {
+                return new jQuery.Deferred().resolve();
+            }
+            this.bIsInitialized = true;
+            this.mConfig.i18n = this.getModel("i18n").getResourceBundle();
 
-			return new jQuery.Deferred(function (oDeffered) {
-				Renderer.createActionButton(
-					this,
-					postStartUIAdaptationToApp.bind(undefined),
-					this.mConfig.visible
-				)
-				.then(function (oActionButton) {
-					this.oActionButton = oActionButton;
-					return AppLifeCycleUtils.getAppLifeCycleService();
-				}.bind(this))
-				.then(function (oAppLifeCycleService) {
-					oAppLifeCycleService.attachAppLoaded(this._onAppLoaded, this);
-				}.bind(this))
-				.catch(function (vError) {
-					this.bIsInitialized = false;
-					return Promise.reject(vError);
-				}.bind(this))
-				.then(oDeffered.resolve, oDeffered.reject);
-			}.bind(this)).promise();
-		},
+            return new jQuery.Deferred((oDeferred) => {
+                Renderer.createActionButton(
+                    this,
+                    postStartUIAdaptationToApp.bind(undefined),
+                    this.mConfig.visible
+                )
+                    .then((oActionButton) => {
+                        this.oActionButton = oActionButton;
+                    })
+                    .catch((vError) => {
+                        this.bIsInitialized = false;
+                        return Promise.reject(vError);
+                    })
+                    .then(oDeferred.resolve, oDeferred.reject);
+            }).promise();
+        },
 
-		_changeActionButtonVisibility: async function (bVisible) {
-			if (!this.oActionButton) {
-				return;
-			}
-			// If the application type is not URL, the plugin is running in an app without iFrames
-			// and the button should not be shown. The monolitic RTA plugin should be used instead.
-			const oALCService = await AppLifeCycleUtils.getAppLifeCycleService();
-			if (bVisible && oALCService.getCurrentApplication().applicationType === "URL") {
-				this.oActionButton.showForAllApps();
-			} else {
-				this.oActionButton.hideForAllApps();
-			}
-		},
+        _changeActionButtonVisibility: async function (bVisible) {
+            if (!this.oActionButton) {
+                return;
+            }
+            // If the application type is not URL, the plugin is running in an app without iFrames
+            // and the button should not be shown. The monolitic RTA plugin should be used instead.
+            const oALCService = await AppLifeCycleUtils.getAppLifeCycleService();
+            if (bVisible && oALCService.getCurrentApplication().applicationType === "URL") {
+                this.oActionButton.showForAllApps();
+            } else {
+                this.oActionButton.hideForAllApps();
+            }
+        },
 
-		_onAppLoaded: function () {
-			// check for restart adaptation happens is on rtaAgent site
-			// the visibility of the action button is also triggered by the rtaAgent
-			this._changeActionButtonVisibility(false/*bVisible*/);
-		},
-
-		exit: function () {
-			switchToolbarVisibility(false);
-			AppLifeCycleUtils.getAppLifeCycleService()
-			.then(function (oAppLifeCycleService) {
-				oAppLifeCycleService.detachAppLoaded(this._onAppLoaded, this);
-			}.bind(this));
-		}
-	});
+        exit: function () {
+            switchToolbarVisibility(false);
+        }
+    });
 });

package/src/main/js/sap/ushell/appRuntime/ui5/plugins/scriptAgent/Component.js

@@ -1,16 +1,16 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
-	"sap/ui/core/Component",
+    "sap/ui/core/Component",
     "sap/ui/thirdparty/URI",
-	"sap/ui/thirdparty/jquery",
+    "sap/ui/thirdparty/jquery",
     "sap/base/Log"
 ],
-function (
-	Component, URI, jQuery, Log
-) {
-	"use strict";
+(
+    Component, URI, jQuery, Log
+) => {
+    "use strict";
 
-	return Component.extend("sap.ushell.appRuntime.ui5.plugins.scriptAgent.Component", {
+    return Component.extend("sap.ushell.appRuntime.ui5.plugins.scriptAgent.Component", {
         metadata: {
             version: "1.0.0",
             dependencies: {
@@ -19,10 +19,10 @@ function (
             }
         },
 
-		init: function () {
-			var mConfig = this.getComponentData(),
-                oPageUriParams = new URI().search(true),
-                scriptURL;
+        init: function () {
+            const mConfig = this.getComponentData();
+            const oPageUriParams = new URI().search(true);
+            let scriptURL;
 
             if (!mConfig.hasOwnProperty("config")) {
                 return;
@@ -33,18 +33,18 @@ function (
                     scriptURL = "https://education3.hana.ondemand.com/education3/web_assistant/framework/FioriAgent.js";
                 } else if (oPageUriParams.hasOwnProperty("sap-wa-debug") && oPageUriParams["sap-wa-debug"] === "prev") {
                     scriptURL = "https://webassistant-outlook.enable-now.cloud.sap/web_assistant/framework/FioriAgent.js";
-                } else { //production script
+                } else { // production script
                     scriptURL = "https://webassistant.enable-now.cloud.sap/web_assistant/framework/FioriAgent.js";
                 }
             } else {
                 scriptURL = mConfig.config.url;
             }
 
-			try {
-				jQuery.getScript(scriptURL);
-			} catch (ex) {
-				Log.error(ex);
-			}
-		}
-	});
+            try {
+                jQuery.getScript(scriptURL);
+            } catch (ex) {
+                Log.error(ex);
+            }
+        }
+    });
 });

package/src/main/js/sap/ushell/appRuntime/ui5/renderers/fiori2/AccessKeysAgent.js

@@ -1,14 +1,14 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/appRuntime/ui5/AppRuntimeService"
-], function (AppRuntimeService) {
+], (AppRuntimeService) => {
     "use strict";
 
-    var AccessKeysAgent = function () {
+    function AccessKeysAgent () {
         this.init = function () {
-            document.addEventListener("keydown", function (oEvent) {
-                var bDelegate = false,
-                    postBody;
+            document.addEventListener("keydown", (oEvent) => {
+                let bDelegate = false;
+                let postBody;
 
                 if (oEvent.altKey && !oEvent.ctrlKey && !oEvent.shiftKey) {
                     if (oEvent.keyCode === 65 || // ALT + A
@@ -22,11 +22,11 @@ sap.ui.define([
                 } else if (oEvent.ctrlKey && !oEvent.altKey && !oEvent.shiftKey) {
                     if (oEvent.keyCode === 188 || // CTRL + COMMA
                         oEvent.keyCode === 112 || // CTRL + F1
-                        oEvent.keyCode === 83) {  // CTRL + S
+                        oEvent.keyCode === 83) { // CTRL + S
                         bDelegate = true;
                     }
                 } else if (oEvent.ctrlKey && oEvent.shiftKey && !oEvent.altKey) {
-                    if (oEvent.keyCode === 70) {  // CTRL + SHIFT + F
+                    if (oEvent.keyCode === 70) { // CTRL + SHIFT + F
                         bDelegate = true;
                     }
                 }
@@ -48,9 +48,9 @@ sap.ui.define([
                         postBody
                     );
                 }
-            }.bind(this), true);
+            }, true);
         };
-    };
+    }
 
     return new AccessKeysAgent();
 }, /* bExport= */ true);

package/src/main/js/sap/ushell/appRuntime/ui5/renderers/fiori2/Renderer.js

@@ -7,44 +7,99 @@ sap.ui.define([
     "sap/base/Log",
     "sap/ui/thirdparty/jquery",
     "sap/ushell/appRuntime/ui5/renderers/fiori2/RendererExtensions"
-], function (
+], (
     uid,
     ObjectPath,
     AppRuntimeService,
     Log,
     jQuery,
     RendererExtensions
-) {
+) => {
     "use strict";
 
-    var aButtonHandlers = [];
+    const aButtonHandlers = [];
 
     function RendererProxy () {
-        var that = this;
+        const that = this;
 
         ObjectPath.set("sap.ushell.renderers.fiori2.Renderer", that);
 
         [
-            "init", "createContent", "createExtendedShellState", "applyExtendedShellState", "showLeftPaneContent", "showHeaderItem",
-            "showRightFloatingContainerItem", "showRightFloatingContainer", "showToolAreaItem",
-            "showFloatingActionButton", "showHeaderEndItem", "setHeaderVisibility", "showSubHeader", "showSignOutItem", "showSettingsItem",
-            "setFooter", "setShellFooter", "setFooterControl", "hideHeaderItem", "removeToolAreaItem", "removeRightFloatingContainerItem",
-            "hideLeftPaneContent", "hideFloatingActionButton", "hideSubHeader", "removeFooter",
-            "getCurrentViewportState", "addShellSubHeader", "addSubHeader", "addUserAction", "addActionButton", "addFloatingButton",
-            "addFloatingActionButton", "addSidePaneContent", "addLeftPaneContent", "addHeaderItem", "addRightFloatingContainerItem",
-            "addToolAreaItem", "getModelConfiguration", "addUserPreferencesEntry", "addUserPreferencesGroupedEntry", "setHeaderTitle",
-            "setLeftPaneVisibility", "showToolArea", "setHeaderHiding", "setFloatingContainerContent", "setFloatingContainerVisibility",
-            "getFloatingContainerVisiblity", "getRightFloatingContainerVisibility", "setFloatingContainerDragSelector",
-            "createTriggers", "convertButtonsToActions",
-            "createItem", "addEntryInShellStates", "removeCustomItems", "addCustomItems", "addRightViewPort", "addLeftViewPort",
-            "getShellController", "getViewPortContainerCurrentState", "ViewPortContainerNavTo", "switchViewPortStateByControl",
-            "setUserActionsMenuSelected", "getUserActionsMenuSelected", "setNotificationsSelected", "getNotificationsSelected", "addShellDanglingControl",
-            "getShellConfig", "reorderUserPrefEntries", "logRecentActivity",
-            "setCurrentCoreView", "getCurrentCoreView"
-        ].forEach(function (sMethod) {
+            "init",
+            "createContent",
+            "createExtendedShellState",
+            "applyExtendedShellState",
+            "showLeftPaneContent",
+            "showHeaderItem",
+            "showRightFloatingContainerItem",
+            "showRightFloatingContainer",
+            "showToolAreaItem",
+            "showFloatingActionButton",
+            "showHeaderEndItem",
+            "setHeaderVisibility",
+            "showSubHeader",
+            "showSignOutItem",
+            "showSettingsItem",
+            "setFooter",
+            "setShellFooter",
+            "setFooterControl",
+            "hideHeaderItem",
+            "removeToolAreaItem",
+            "removeRightFloatingContainerItem",
+            "hideLeftPaneContent",
+            "hideFloatingActionButton",
+            "hideSubHeader",
+            "removeFooter",
+            "getCurrentViewportState",
+            "addShellSubHeader",
+            "addSubHeader",
+            "addUserAction",
+            "addActionButton",
+            "addFloatingButton",
+            "addFloatingActionButton",
+            "addSidePaneContent",
+            "addLeftPaneContent",
+            "addHeaderItem",
+            "addRightFloatingContainerItem",
+            "addToolAreaItem",
+            "getModelConfiguration",
+            "addUserPreferencesEntry",
+            "addUserPreferencesGroupedEntry",
+            "setHeaderTitle",
+            "setLeftPaneVisibility",
+            "showToolArea",
+            "setHeaderHiding",
+            "setFloatingContainerContent",
+            "setFloatingContainerVisibility",
+            "getFloatingContainerVisiblity",
+            "getRightFloatingContainerVisibility",
+            "setFloatingContainerDragSelector",
+            "createTriggers",
+            "convertButtonsToActions",
+            "createItem",
+            "addEntryInShellStates",
+            "removeCustomItems",
+            "addCustomItems",
+            "addRightViewPort",
+            "addLeftViewPort",
+            "getShellController",
+            "getViewPortContainerCurrentState",
+            "ViewPortContainerNavTo",
+            "switchViewPortStateByControl",
+            "setUserActionsMenuSelected",
+            "getUserActionsMenuSelected",
+            "setNotificationsSelected",
+            "getNotificationsSelected",
+            "addShellDanglingControl",
+            "getShellConfig",
+            "reorderUserPrefEntries",
+            "logRecentActivity",
+            "setCurrentCoreView",
+            "getCurrentCoreView"
+        ].forEach((sMethod) => {
             that[sMethod] = function () {
-                Log.error("'Renderer' api '" + sMethod
-                    + "' is not supported when UI5 application is running inside an iframe (sap.ushell.appRuntime.ui5.renderers.fiori2.Renderer)");
+                Log.error(`'Renderer' api '${sMethod
+                }' is not supported when UI5 application is running inside an iframe (sap.ushell.appRuntime.ui5.renderers.fiori2.Renderer)`);
             };
         });
 
@@ -99,7 +154,7 @@ sap.ui.define([
             );
         };
 
-        this.showHeaderItem = function (aIds/*, bCurrentState, aStates*/) {
+        this.showHeaderItem = function (aIds/* , bCurrentState, aStates */) {
             AppRuntimeService.postMessageToFLP("sap.ushell.services.Renderer.showHeaderItem", {
                 aIds: aIds,
                 bCurrentState: true,
@@ -107,7 +162,7 @@ sap.ui.define([
             });
         };
 
-        this.showHeaderEndItem = function (aIds/*, bCurrentState, aStates*/) {
+        this.showHeaderEndItem = function (aIds/* , bCurrentState, aStates */) {
             AppRuntimeService.postMessageToFLP("sap.ushell.services.Renderer.showHeaderEndItem", {
                 aIds: aIds,
                 bCurrentState: true,
@@ -115,7 +170,7 @@ sap.ui.define([
             });
         };
 
-        this.hideHeaderItem = function (aIds/*, bCurrentState, aStates*/) {
+        this.hideHeaderItem = function (aIds/* , bCurrentState, aStates */) {
             AppRuntimeService.postMessageToFLP("sap.ushell.services.Renderer.hideHeaderItem", {
                 aIds: aIds,
                 bCurrentState: true,
@@ -123,7 +178,7 @@ sap.ui.define([
             });
         };
 
-        this.hideHeaderEndItem = function (aIds/*, bCurrentState, aStates*/) {
+        this.hideHeaderEndItem = function (aIds/* , bCurrentState, aStates */) {
             AppRuntimeService.postMessageToFLP("sap.ushell.services.Renderer.hideHeaderEndItem", {
                 aIds: aIds,
                 bCurrentState: true,
@@ -131,7 +186,7 @@ sap.ui.define([
             });
         };
 
-        this._addHeaderItem = function (sAPI, oControlProperties, bIsVisible/*, bCurrentState, aStates*/) {
+        this._addHeaderItem = function (sAPI, oControlProperties, bIsVisible/* , bCurrentState, aStates */) {
             // set unique ids to enable multiple buttons and handlers for the same app
             if (!oControlProperties.id) {
                 oControlProperties.id = uid();
@@ -242,7 +297,7 @@ sap.ui.define([
         };
     }
 
-    var oRendererProxy = new RendererProxy();
+    const oRendererProxy = new RendererProxy();
     RendererExtensions.setRenderer(oRendererProxy);
     return oRendererProxy;
 });