@sapui5/sap.ushell 1.139.0 → 1.140.0

package/src/main/js/sap/ushell/appIntegration/IframeApplicationContainer.js

@@ -195,8 +195,12 @@ sap.ui.define([
         }
     };
 
+    IframeApplicationContainer.prototype._getDocumentUrl = function () {
+        return document.URL;
+    };
+
     IframeApplicationContainer.prototype._calculateIframeWithPost = function () {
-        const oUrlParams = UriParameters.fromURL(document.URL);
+        const oUrlParams = UriParameters.fromURL(this._getDocumentUrl());
         const sApplicationType = this.getApplicationType();
 
         const bPostEnabledByConfig = Config.last("/core/shell/enableOpenIframeWithPost") ?? true;
@@ -242,23 +246,20 @@ sap.ui.define([
             this
         );
 
-        sIframeUrl = this._injectParametersFromUrl(sIframeUrl);
+        sIframeUrl = this._injectParametersFromDocumentUrl(sIframeUrl);
 
         this.setProperty("iframeUrl", sIframeUrl, true);
     };
 
-    IframeApplicationContainer.prototype._injectParametersFromUrl = function (sIframeUrl) {
+    IframeApplicationContainer.prototype._injectParametersFromDocumentUrl = function (sIframeUrl) {
         // generic mechanism for allowing to pass parameters to the iframe URL
-        const oUrlParams = UriParameters.fromURL(document.URL);
+        const oUrlParams = UriParameters.fromURL(this._getDocumentUrl());
         if (!oUrlParams.has("sap-iframe-params")) {
             return sIframeUrl;
         }
 
         const sIframeParams = oUrlParams.get("sap-iframe-params") || "";
         const aParams = sIframeParams.split(",");
-        if (aParams.length === 0) {
-            return sIframeUrl;
-        }
 
         const sTmpURI = new URI(sIframeUrl);
         aParams.forEach((sParam) => {
@@ -367,6 +368,7 @@ sap.ui.define([
             const sFormId = `${oIFrame.getAttribute("id").replace("-iframe", "-form")}`;
             const oForm = document.getElementById(sFormId);
             sIframeUrl = oForm?.action;
+            // todo: [FLPCOREANDUX-10024] check whether this is still required
             if (sIframeUrl === undefined && (new URI()).query(true).hasOwnProperty("sap-isolation-enabled")) {
                 sIframeUrl = oIFrame.src;
             }
@@ -451,8 +453,8 @@ sap.ui.define([
     };
 
     IframeApplicationContainer.prototype.sendBeforeAppCloseEvent = async function () {
-        const oEventData = this.getBeforeAppCloseEvent && this.getBeforeAppCloseEvent();
-        if (oEventData && oEventData.enabled && oEventData.enabled === true) {
+        const oEventData = this.getBeforeAppCloseEvent();
+        if (oEventData?.enabled === true) {
             return this.sendRequest("sap.ushell.services.CrossApplicationNavigation.beforeAppCloseEvent", oEventData.params, true);
         }
     };

package/src/main/js/sap/ushell/appIntegration/KeepAliveApps.js

@@ -4,39 +4,69 @@ sap.ui.define([
 ) => {
     "use strict";
 
-    function KeepAliveApps () {
-        let oMainStorage = {};
+    /**
+     * @alias sap.ushell.appIntegration.KeepAliveApps
+     * @namespace
+     * @description This module provides a storage for applications that should be kept alive.
+     * It allows setting, getting, and removing applications by their keys.
+     *
+     * @private
+     */
+    class KeepAliveApps {
+        #oMainStorage = {};
 
-        // for qunit
-        this._clean = function () {
-            oMainStorage = {};
-        };
-
-        this.get = function (sKey) {
-            if (sKey && oMainStorage.hasOwnProperty(sKey)) {
-                return oMainStorage[sKey];
+        /**
+         * Returns the application with the given key.
+         * @param {string} sKey The key of the application to retrieve.
+         * @returns {object} The application with the given key, or undefined if not found.
+         *
+         * @private
+         */
+        get (sKey) {
+            if (!sKey || !Object.hasOwn(this.#oMainStorage, sKey)) {
+                return;
             }
-            return undefined;
-        };
 
-        this.set = function (sKey, oValue) {
-            if (sKey) {
-                oMainStorage[sKey] = oValue;
+            return this.#oMainStorage[sKey];
+        }
+
+        /**
+         * Sets a value in the storage.
+         * @param {string} sKey The key of the application to set.
+         * @param {object} oValue The value to set.
+         *
+         * @private
+         */
+        set (sKey, oValue) {
+            if (!sKey) {
+                return;
             }
-        };
 
-        this.removeById = function (sKey) {
-            if (sKey && oMainStorage.hasOwnProperty(sKey)) {
-                delete oMainStorage[sKey];
+            this.#oMainStorage[sKey] = oValue;
+        }
+
+        /**
+         * Removes an application from the storage.
+         * @param {string} sKey The key of the application to remove.
+         *
+         * @private
+         */
+        removeById (sKey) {
+            if (!sKey || !Object.hasOwn(this.#oMainStorage, sKey)) {
+                return;
             }
-        };
+
+            delete this.#oMainStorage[sKey];
+        }
 
         /**
          * Removes all entries related to a given container
          * @param {sap.ushell.appIntegration.ApplicationContainer} oApplicationContainer the application container.
-         * @param {function} [fnBeforeRemove] a custom remove function.
+         * @param {function} [fnBeforeRemove] a custom function, which is called before the application is removed.
+         *
+         * @private
          */
-        this.removeByContainer = function (oApplicationContainer, fnBeforeRemove) {
+        removeByContainer (oApplicationContainer, fnBeforeRemove) {
             this.forEach((oStorageEntry, sKey) => {
                 if (oStorageEntry.container === oApplicationContainer) {
                     if (fnBeforeRemove) {
@@ -45,17 +75,39 @@ sap.ui.define([
                     this.removeById(sKey);
                 }
             });
-        };
+        }
 
-        this.forEach = function (fnCallback) {
-            Object.keys(oMainStorage).forEach(function (key) {
-                fnCallback.apply(this, [oMainStorage[key], key, this]);
+        /**
+         * Iterates over all applications in the keep-alive storage.
+         * @param {function} fnCallback The callback function to execute for each application.
+         *
+         * @private
+         */
+        forEach (fnCallback) {
+            Object.keys(this.#oMainStorage).forEach((sKey) => {
+                const oApplication = this.#oMainStorage[sKey];
+                fnCallback(oApplication, sKey);
             });
-        };
+        }
+
+        /**
+         * Returns the number of applications stored in the keep-alive storage.
+         * @returns {int} The number of applications stored in the keep-alive storage.
+         *
+         * @private
+         */
+        length () {
+            return Object.keys(this.#oMainStorage).length;
+        }
 
-        this.length = function () {
-            return Object.keys(oMainStorage).length;
-        };
+        /**
+         * Only for testing!
+         *
+         * @private
+         */
+        reset () {
+            this.#oMainStorage = {};
+        }
     }
 
     return new KeepAliveApps();

package/src/main/js/sap/ushell/appIntegration/PostMessageHandler/AppInfoHandler.js

@@ -0,0 +1,225 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+/**
+ * @file This file contains the AppInfoHandler class.
+ *
+ * Any handlers that are relevant for applications
+ * - ShellUIService (setTitle, setBackNavigation, ...)
+ * - ApplicationWidth
+ * - AppInfo (AboutDialog)
+ * - DirtyState Handling
+ */
+sap.ui.define([
+    "sap/base/util/Deferred",
+    "sap/ushell/appIntegration/PostMessageManager",
+    "sap/ushell/Container",
+    "sap/ushell/utils"
+], (
+    Deferred,
+    PostMessageManager,
+    Container,
+    ushellUtils
+) => {
+    "use strict";
+
+    const oDistributionPolicies = {};
+
+    const oServiceRequestHandlers = {
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.ui5service.ShellUIService.setBackNavigation": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                let fnCallback;
+                if (oMessageBody.callbackMessage?.service) {
+                    oApplicationContainer.addCapabilities([
+                        oMessageBody.callbackMessage.service
+                    ]);
+
+                    fnCallback = () => {
+                        oApplicationContainer.sendRequest(
+                            oMessageBody.callbackMessage.service,
+                            null, // oMessageBody
+                            false // bWaitForResponse
+                        );
+                    };
+                } // empty body or callback message will call the setBackNavigation with undefined, this should reset the back button callback
+
+                ShellUIService.setBackNavigation(fnCallback);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.ui5service.ShellUIService.setTitle": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { sTitle, oAdditionalInformation } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setTitle(sTitle, oAdditionalInformation);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setTitle": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { sTitle, oAdditionalInformation } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setTitle(sTitle, oAdditionalInformation);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setHierarchy": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { aHierarchyLevels } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setHierarchy(aHierarchyLevels);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setRelatedApps": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { aRelatedApps } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setRelatedApps(aRelatedApps);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.AppLifeCycle.setNewAppInfo": {
+            async handler (oMessageBody, oMessageEvent) {
+                const oParams = oMessageBody;
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+
+                AppLifeCycle.setAppInfo(oParams, true);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppLifeCycle.updateCurrentAppInfo": {
+            async handler (oMessageBody, oMessageEvent) {
+                const oParams = oMessageBody;
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+
+                AppLifeCycle.setAppInfo(oParams, false);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppConfiguration.setApplicationFullWidth": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bValue } = oMessageBody;
+
+                const [AppConfiguration] = await ushellUtils.requireAsync(["sap/ushell/services/AppConfiguration"]);
+
+                AppConfiguration.setApplicationFullWidthInternal(bValue);
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setDirtyFlag": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bIsDirty } = oMessageBody;
+
+                Container.setDirtyFlag(bIsDirty);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Container.setDirtyFlag": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bIsDirty } = oMessageBody;
+                Container.setDirtyFlag(bIsDirty);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Container.registerDirtyStateProvider": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { bRegister } = oMessageBody;
+                if (bRegister) {
+                    oApplicationContainer.addCapabilities([
+                        "sap.ushell.appRuntime.handleDirtyStateProvider"
+                    ]);
+
+                    Container.setAsyncDirtyStateProvider(async (oNavigationContext) => {
+                        // safety check in case post message does not get result
+                        const oNativeDeferred = new Deferred();
+                        const backupTimer = setTimeout(() => {
+                            oNativeDeferred.resolve(false);
+                        }, 2500);
+
+                        oApplicationContainer.sendRequest(
+                            "sap.ushell.appRuntime.handleDirtyStateProvider",
+                            { oNavigationContext },
+                            true // bWaitForResponse
+                        ).then((oResponseMessageBody) => {
+                            if (backupTimer) {
+                                clearTimeout(backupTimer);
+                            }
+
+                            oNativeDeferred.resolve(oResponseMessageBody.result ?? false);
+                        });
+
+                        return oNativeDeferred.promise;
+                    });
+                } else {
+                    Container.setAsyncDirtyStateProvider();
+                }
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        }
+    };
+
+    return {
+        register () {
+            Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {
+                const oDistributionPolicy = oDistributionPolicies[sServiceRequest];
+                PostMessageManager.setDistributionPolicy(sServiceRequest, oDistributionPolicy);
+            });
+
+            Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {
+                const oHandler = oServiceRequestHandlers[sServiceRequest];
+                PostMessageManager.setRequestHandler(sServiceRequest, oHandler.handler, oHandler.options);
+            });
+        }
+    };
+});

package/src/main/js/sap/ushell/appIntegration/PostMessageHandler/AppStateHandler.js

@@ -0,0 +1,188 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+/**
+ * @file This file contains the AppStateHandler class.
+ *
+ * AppState handling
+ */
+sap.ui.define([
+    "sap/ui/core/UIComponent",
+    "sap/ui/thirdparty/hasher",
+    "sap/ushell/appIntegration/PostMessageManager",
+    "sap/ushell/Container",
+    "sap/ushell/services/Navigation/compatibility",
+    "sap/ushell/utils"
+], (
+    UIComponent,
+    hasher,
+    PostMessageManager,
+    Container,
+    navigationCompatibility,
+    ushellUtils
+) => {
+    "use strict";
+
+    const oDummyComponent = new UIComponent();
+
+    const oDistributionPolicies = {};
+
+    const oServiceRequestHandlers = {
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.getAppState(sKey);
+
+                const oAppState = await ushellUtils.promisify(oDeferred);
+                delete oAppState._oServiceInstance;
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState._saveAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey, sData, sAppName, sComponent, bTransient, iPersistencyMethod, oPersistencySettings } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState._saveAppState(
+                    sKey,
+                    sData,
+                    sAppName,
+                    sComponent,
+                    bTransient,
+                    iPersistencyMethod,
+                    oPersistencySettings
+                );
+                await ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.deleteAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.deleteAppState(sKey);
+                await ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.makeStatePersistent": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey, iPersistencyMethod, oPersistencySettings } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.makeStatePersistent(sKey, iPersistencyMethod, oPersistencySettings);
+                return ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Navigation.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sAppStateKey } = oMessageBody;
+                const Navigation = await Container.getServiceAsync("Navigation");
+
+                const oAppState = await Navigation.getAppState(oDummyComponent, sAppStateKey);
+                delete oAppState._oServiceInstance;
+
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.CrossApplicationNavigation.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sAppStateKey } = oMessageBody;
+                const Navigation = await Container.getServiceAsync("Navigation");
+
+                const oAppState = await Navigation.getAppState(oDummyComponent, sAppStateKey);
+                delete oAppState._oServiceInstance;
+
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.CrossApplicationNavigation.getAppStateData": {
+            async handler (oMessageBody, oMessageEvent) {
+                // note: sAppStateKey may be an array of argument arrays
+                const { sAppStateKey: vAppStateKey } = oMessageBody;
+
+                return navigationCompatibility.getAppStateData(vAppStateKey);
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.CrossApplicationNavigation.setInnerAppStateData": {
+            handler: async (oMessageBody) => {
+                const { sData } = oMessageBody;
+                let oValue;
+
+                if (sData !== undefined) {
+                    try {
+                        oValue = JSON.parse(sData);
+                    } catch (e) {
+                        oValue = sData;
+                    }
+                } else {
+                    oValue = {};
+                }
+
+                const AppState = await Container.getServiceAsync("AppState");
+                const oNewAppState = AppState.createEmptyAppState();
+
+                oNewAppState.setData(oValue);
+                await ushellUtils.promisify(oNewAppState.save());
+                const sNewAppStateKey = oNewAppState.getKey();
+
+                let sHash = hasher.getHash();
+                if (sHash.indexOf("&/") > 0) {
+                    if (sHash.indexOf("sap-iapp-state=") > 0) {
+                        const sCurrAppStateKey = /(?:sap-iapp-state=)([^&/]+)/.exec(sHash)[1];
+                        sHash = sHash.replace(sCurrAppStateKey, sNewAppStateKey);
+                    } else {
+                        sHash = `${sHash}/sap-iapp-state=${sNewAppStateKey}`;
+                    }
+                } else {
+                    sHash = `${sHash}&/sap-iapp-state=${sNewAppStateKey}`;
+                }
+
+                hasher.disableBlueBoxHashChangeTrigger = true;
+                hasher.replaceHash(sHash);
+                hasher.disableBlueBoxHashChangeTrigger = false;
+
+                return sNewAppStateKey;
+            }
+        }
+    };
+
+    return {
+        register () {
+            Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {
+                const oDistributionPolicy = oDistributionPolicies[sServiceRequest];
+                PostMessageManager.setDistributionPolicy(sServiceRequest, oDistributionPolicy);
+            });
+
+            Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {
+                const oHandler = oServiceRequestHandlers[sServiceRequest];
+                PostMessageManager.setRequestHandler(sServiceRequest, oHandler.handler, oHandler.options);
+            });
+        }
+    };
+});