@sapui5/sap.ushell 1.133.0 → 1.134.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sapui5/sap.ushell",
-    "version": "1.133.0",
+    "version": "1.134.0",
     "description": "SAPUI5 Library sap.ushell",
     "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
     "keywords": [

package/src/main/js/sap/ushell/.library

@@ -2,8 +2,8 @@
 <library xmlns="http://www.sap.com/sap.ui.library.xsd">
     <name>sap.ushell</name>
     <vendor>SAP SE</vendor>
-    <version>1.133.0</version>
-    <copyright>Copyright (c) 2009-2024 SAP SE, All Rights Reserved</copyright>
+    <version>1.134.0</version>
+    <copyright>Copyright (c) 2009-2025 SAP SE, All Rights Reserved</copyright>
     <documentation>SAP library: sap.ushell</documentation>
 
     <dependencies>
@@ -70,6 +70,7 @@
             </module-infos>
             <all-in-one>
                 <exclude name="sap/ushell/bootstrap/cdm.js" />
+                <exclude name="sap/ushell/thirdparty/" />
             </all-in-one>
         </packaging>
         <jsdoc xmlns="http://www.sap.com/ui5/buildext/jsdoc">

package/src/main/js/sap/ushell/AppInfoParameters.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/base/Log",
@@ -27,7 +27,8 @@ sap.ui.define([
     const aRestrictedParameters = [
         "productName",
         "theme",
-        "appIntent"
+        "appIntent",
+        "url"
     ];
 
     // Those parameters are supported by the AppInfoParameters any
@@ -45,7 +46,8 @@ sap.ui.define([
         "appFrameworkId",
         "title",
         "applicationParams",
-        "shellFrameworkVersion"
+        "shellFrameworkVersion",
+        "url"
     ];
 
     /**
@@ -68,7 +70,8 @@ sap.ui.define([
             appId: this.#getAppId.bind(this),
             appVersion: this.#getAppVersion.bind(this),
             productName: _curry(this.#getSystemContextProperty.bind(this))("productName"),
-            applicationParams: this.#getStartupParams.bind(this)
+            applicationParams: this.#getStartupParams.bind(this),
+            url: this.#getUrl.bind(this)
         };
 
         // overrides by the application for the standard app info parameters
@@ -528,6 +531,17 @@ sap.ui.define([
             return true;
         }
 
+        /**
+         * Retrieves the FLP URL with the current hash included.
+         *
+         * @returns {Promise<string>} Resolves the FLP URL with hash.
+         * @since 1.133.0
+         * @private
+         */
+        #getUrl () {
+            return Container.getFLPUrl(true);
+        }
+
         /**
          * Stores the custom app info parameters into the given storage entry.
          * @param {object} oStorageEntry The storage entry.

package/src/main/js/sap/ushell/ApplicationType/UrlPostProcessing.js

@@ -0,0 +1,217 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview Post processing of resolution result.
+ */
+sap.ui.define([
+    "sap/ui/core/Supportability",
+    "sap/ui/thirdparty/hasher",
+    "sap/ushell/Config",
+    "sap/ushell/Container",
+    "sap/ushell/library",
+    "sap/ushell/User",
+    "sap/ushell/utils",
+    "sap/ushell/utils/UriParameters",
+    "sap/ushell/utils/UrlParsing"
+], (
+    Supportability,
+    hasher,
+    Config,
+    Container,
+    ushellLibrary,
+    User,
+    ushellUtils,
+    UriParameters,
+    UrlParsing
+) => {
+    "use strict";
+
+    if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+        return {};
+    }
+
+    // shortcut for sap.ushell.components.applicationIntegration.contracts.StatefulType
+    const StatefulType = ushellLibrary.components.applicationIntegration.contracts.StatefulType;
+
+    const UrlPostProcessing = {};
+
+    /**
+     * Checks if url needs to be adjusted and adjusts it if necessary.
+     *
+     * @param {string} sUrl Url that needs to be adjusted
+     * @param {sap.ushell.ApplicationType} sApplicationType Application type
+     * @param {boolean} [bForFramelessWindow=false] whether the url is for a frameless window
+     * @param {sap.ushell.components.applicationIntegration.ApplicationContainer} [oApplicationContainer] Application Container the base URL
+     * @returns {string} The adjusted url.
+     *
+     * @since 1.134.0
+     * @private
+     */
+    UrlPostProcessing.processUrl = function (sUrl, sApplicationType, bForFramelessWindow, oApplicationContainer) {
+        const bIsWda = ushellUtils.isApplicationTypeEmbeddedInIframe(sApplicationType, true);
+        const bIsApplicationContainerWithIframe = oApplicationContainer && ushellUtils.isApplicationTypeEmbeddedInIframe(oApplicationContainer.getFrameworkId());
+
+        if (!bIsWda && !bIsApplicationContainerWithIframe) {
+            return sUrl;
+        }
+
+        let sTargetNavigationMode;
+        let bIsReusableContainer;
+        // todo: [FLPCOREANDUX-10024] fix this
+        let sUi5Version;
+        if (oApplicationContainer) {
+            sTargetNavigationMode = oApplicationContainer.getTargetNavigationMode();
+            bIsReusableContainer = oApplicationContainer.getStatefulType() !== StatefulType.NotSupported;
+            sUi5Version = oApplicationContainer.getUi5Version();
+        }
+
+        // amend already resolved url with additional parameters
+        sUrl = this._processUrl(sUrl, sApplicationType, sTargetNavigationMode, bIsReusableContainer, bForFramelessWindow, sUi5Version);
+
+        return sUrl;
+    };
+
+    /**
+     * Amends the NavTargetResolutionInternal response with theme, sap-ushell-version, accessibility and post parameters if present.
+     * Theme and accessibility information is only added for the NWBC application type.
+     *
+     * @param {string} sUrl
+     *   Already resolved url (NavTargetResolutionInternal response)
+     * @param {string} sApplicationType
+     *   The application type of <code>sUrl</code>
+     * @param {string} sTargetNavigationMode
+     *   The (external) navigation mode to add in the sap-target-navmode parameter
+     * @param {boolean} bReuseSession whether the session should is reused
+     * @param {boolean} bForFramelessWindow whether the url is for a frameless window
+     * @param {string} sUi5Version the UI5 version.
+     * @returns {string} Modified url having additional parameters
+     *
+     * @since 1.134.0
+     * @private
+     */
+    UrlPostProcessing._processUrl = function (sUrl, sApplicationType, sTargetNavigationMode, bReuseSession, bForFramelessWindow, sUi5Version) {
+        // Parameters of the shell specific part to be added for NWBC Url
+        const oParams = {};
+
+        oParams["sap-ie"] = "edge"; // force IE to edge mode
+
+        const sTheme = this._getTheme(sUrl);
+        if (sTheme) {
+            // note, we do not replace existing parameters
+            oParams["sap-theme"] = sTheme;
+        }
+
+        if (this._getAccessibility()) {
+            // propagate accessibility mode
+            // Note: This is handled by the WebGUI/WDA framework which expects a value of "X"!
+            oParams["sap-accessibility"] = "X";
+            // note, we do not replace existing parameters
+        }
+        if (this._getStatistics(sUrl)) {
+            // propagate statistics = true
+            // Note: This is handled by the IFC handler on ABAP, which expects a value of "true" (not "X")
+            oParams["sap-statistics"] = "true";
+            // note, we do not replace existing parameters
+        }
+
+        const sDensity = this._getDensity();
+        if (sDensity && sDensity.length > 0) {
+            oParams["sap-touch"] = sDensity;
+        }
+
+        if (!bForFramelessWindow) {
+            if (sTargetNavigationMode) {
+                oParams["sap-target-navmode"] = sTargetNavigationMode;
+                // note, we do not replace existing parameters
+            }
+
+            if (sApplicationType === "TR" || sApplicationType === "GUI") {
+                oParams["sap-keepclientsession"] = "2";
+            } else if (bReuseSession) { // 'NWBC', 'WCF', 'WDA'
+                oParams["sap-keepclientsession"] = "1";
+            }
+
+            const sKey = this._getInAppState();
+            if (sKey && sKey.length > 0) {
+                oParams["sap-iapp-state"] = sKey;
+            }
+
+            let iSessionTimeout = 0;
+            if (Config.last("/core/shell/sessionTimeoutIntervalInMinutes") > 0) {
+                iSessionTimeout = Config.last("/core/shell/sessionTimeoutIntervalInMinutes");
+            }
+            oParams["sap-ushell-timeout"] = iSessionTimeout;
+
+            sUrl = this._addSearchOrShellParamsToURL(sUrl, oParams);
+
+            // The renderer "waits" for the ui5 version to be available
+            return ushellUtils.appendSapShellParamSync(sUrl, sApplicationType, sUi5Version);
+        }
+        return this._addSearchOrShellParamsToURL(sUrl, oParams);
+    };
+
+    UrlPostProcessing._addSearchOrShellParamsToURL = function (sUrlOrHash, oShellParams) {
+        if (sUrlOrHash.indexOf("#") === -1) {
+            return UrlParsing.addParamsToUrl(sUrlOrHash, oShellParams);
+        }
+        return UrlParsing.addShellParamsToURL(sUrlOrHash, oShellParams);
+    };
+
+    UrlPostProcessing._getAccessibility = function () {
+        const vUrl = ushellUtils.getParameterValueBoolean("sap-accessibility");
+        if (vUrl !== undefined) {
+            return vUrl;
+        }
+        return Container.getUser().getAccessibilityMode();
+    };
+
+    UrlPostProcessing._getTheme = function (sUrl) {
+        const oResolvedUrlParameters = UriParameters.fromURL(sUrl) || { mParams: {} };
+
+        // To take care of the precedence of the intent over UI5 configuration
+        if (oResolvedUrlParameters.mParams["sap-theme"] === undefined) {
+            return Container.getUser().getTheme(User.prototype.constants.themeFormat.NWBC);
+        }
+        return;
+    };
+
+    UrlPostProcessing._getStatistics = function (sUrl) {
+        let bAddStatistics = false;
+        const oResolvedUrlParameters = UriParameters.fromURL(sUrl) || { mParams: {} };
+
+        // To take care of the precedence of the intent over UI5 configuration
+        bAddStatistics = Supportability.isStatisticsEnabled() && oResolvedUrlParameters.mParams["sap-statistics"] === undefined;
+        return bAddStatistics;
+    };
+
+    UrlPostProcessing._getInAppState = function () {
+        const sHash = hasher.getHash();
+        let sKey = "";
+        let aParams;
+
+        if (sHash && sHash.length > 0 && sHash.indexOf("sap-iapp-state=") > 0) {
+            aParams = /(?:sap-iapp-state=)([^&/]+)/.exec(sHash);
+            if (aParams && aParams.length === 2) {
+                sKey = aParams[1];
+            }
+        }
+
+        return sKey;
+    };
+
+    UrlPostProcessing._getDensity = function () {
+        let sVal = "";
+        const bIsCompact = !!document.body?.classList.contains("sapUiSizeCompact");
+        const bIsCozy = !!document.body?.classList.contains("sapUiSizeCozy");
+
+        if (bIsCompact === true) {
+            sVal = "0";
+        } else if (bIsCozy) {
+            sVal = "1";
+        }
+
+        return sVal;
+    };
+
+    return UrlPostProcessing;
+});

package/src/main/js/sap/ushell/ApplicationType/guiResolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepExtend",

package/src/main/js/sap/ushell/ApplicationType/systemAlias.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ui/thirdparty/URI",

package/src/main/js/sap/ushell/ApplicationType/ui5Resolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepExtend",

package/src/main/js/sap/ushell/ApplicationType/urlResolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/util/deepExtend",
     "sap/ui/thirdparty/URI",

package/src/main/js/sap/ushell/ApplicationType/urlTemplateResolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/Log",
     "sap/base/i18n/Localization",
@@ -220,12 +220,19 @@ sap.ui.define([
                     _addLanguageToURLTemplateResult(oResult, oTemplateContext.siteAppSection, oRuntime);
 
                     var oPromisePostTemplateProcessing = new Promise(function (fnResolve) {
-                        Container.getServiceAsync("URLTemplate").then(function (srv) {
-                            sap.ui.require(["sap/ushell/components/applicationIntegration/application/BlueBoxesCache"], function (BlueBoxesCache) {
-                                // todo: [FLPCOREANDUX-10024] should rather be done via the BlueBoxHandler
-                                var bForNewIframe = (BlueBoxesCache.get(oResult.url) === undefined);
-                                srv.handlePostTemplateProcessing(oResult.url, oTemplateContext.siteAppSection, bForNewIframe).then(fnResolve);
-                            });
+                        Container.getServiceAsync("URLTemplate").then(function (URLTemplate) {
+                            if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/application/BlueBoxesCache"], function (BlueBoxesCache) {
+                                    var bForNewIframe = (BlueBoxesCache.get(oResult.url) === undefined);
+                                    URLTemplate.handlePostTemplateProcessing(oResult.url, oTemplateContext.siteAppSection, bForNewIframe).then(fnResolve);
+                                });
+                            } else {
+                                sap.ui.require(["sap/ushell/components/applicationIntegration/ApplicationContainerCache"], function (ApplicationContainerCache) {
+                                    // todo: [FLPCOREANDUX-10024] should this really be necessary?
+                                    var bForNewIframe = !ApplicationContainerCache.findFreeContainerByUrl(oResult.url);
+                                    URLTemplate.handlePostTemplateProcessing(oResult.url, oTemplateContext.siteAppSection, bForNewIframe).then(fnResolve);
+                                });
+                            }
                         });
                     });
 

package/src/main/js/sap/ushell/ApplicationType/utils.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ushell/utils/UrlParsing",

package/src/main/js/sap/ushell/ApplicationType/wcfResolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/deepExtend",

package/src/main/js/sap/ushell/ApplicationType/wdaResolution.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/base/util/deepExtend",
     "sap/base/util/ObjectPath",

package/src/main/js/sap/ushell/ApplicationType.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ushell/Config"

package/src/main/js/sap/ushell/CanvasShapesManager.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 sap.ui.define([
     "sap/ui/Device",

package/src/main/js/sap/ushell/Config/utils.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 /**
  * @fileOverview Utility functions for sap/ushell/Config.
  *

package/src/main/js/sap/ushell/Config.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ushell/EventHub",
     "sap/ushell/bootstrap/common/common.create.configcontract.core",

package/src/main/js/sap/ushell/Container.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 /**
  * @namespace sap.ushell.services

package/src/main/js/sap/ushell/EventHub.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview provides a sticky EventHub implementation to be used internally by the shell.

package/src/main/js/sap/ushell/Fiori20Adapter.js

@@ -1,11 +1,11 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The Fiori20 adapter is not a platform adapter, but a UI adapter.
  *
  * The Fiori20 adapter automatically re-styles old (Fiori 1) applications to match Fiori2 design requirements.
  *
- * @version 1.133.0
+ * @version 1.134.0
  */
 sap.ui.define([
     "sap/ui/base/Object",

package/src/main/js/sap/ushell/Fiori20AdapterTest.js

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The purpose Fiori20AdapterTest in this file is to decide whether to load the Fiori20Adapter at all.
  * This file is kept small in size on purpose as it is always required in productive code even when Fiori 2 adaptation is not required.
  *
- * @version 1.133.0
+ * @version 1.134.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/Layout.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 /**
  * @deprecated As of version 1.120
  * @fileoverview Classical home page layout

package/src/main/js/sap/ushell/NWBCInterface.js

@@ -1,8 +1,8 @@
-//Copyright (c) 2009-2024 SAP SE, All Rights Reserved
+//Copyright (c) 2009-2025 SAP SE, All Rights Reserved
 /**
  * @fileOverview NWBCInterface for NWBC client
  *
- * @version 1.133.0
+ * @version 1.134.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",
@@ -52,9 +52,15 @@ sap.ui.define([
      */
     NWBCInterface.isAnyAppKeptAlive = function () {
         return new Promise(function (fnResolve) {
-            sap.ui.require(["sap/ushell/components/applicationIntegration/Storage"], function (Storage) {
-                fnResolve(Storage.length() > 0);
-            });
+            if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
+                sap.ui.require(["sap/ushell/components/applicationIntegration/Storage"], function (Storage) {
+                    fnResolve(Storage.length() > 0);
+                });
+            } else {
+                sap.ui.require(["sap/ushell/components/applicationIntegration/KeepAliveApps"], function (KeepAliveApps) {
+                    fnResolve(KeepAliveApps.length() > 0);
+                });
+            }
         });
     };