@sapui5/sap.ushell 1.135.0 → 1.136.0

package/src/main/js/sap/ushell/adapters/local/NavTargetResolutionAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolution adapter for the demo platform used in scube ui5appruntime.scube.
- * @version 1.135.0
+ * @version 1.136.0
  * @deprecated since 1.120
  * @private
  */

package/src/main/js/sap/ushell/adapters/local/NavTargetResolutionInternalAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolutionInternal adapter for the demo platform.
- * @version 1.135.0
+ * @version 1.136.0
  * @since 1.120
  * @private
  */

package/src/main/js/sap/ushell/adapters/local/PageBuildingAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  * It creates chip instances from chip raw data. Compared to the other platforms this adapter has restricted functionality.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/ui/core/ComponentContainer",

package/src/main/js/sap/ushell/adapters/local/PagePersistenceAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview PagePersistenceAdapter for the local platform.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/adapters/local/PersonalizationAdapter.js

@@ -6,7 +6,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/adapters/local/PersonalizationV2Adapter.js

@@ -6,7 +6,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell/adapters/local/SearchAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Search adapter for the demo platform.
  *
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/SearchCEPAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for CEP Search
  *
- * @version 1.135.0
+ * @version 1.136.0
  */
 /*eslint-disable quote-props*/
 sap.ui.define([], function () {

package/src/main/js/sap/ushell/adapters/local/SupportTicketAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The SupportTicket adapter for the local platform.
  *
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/Ui5ComponentLoaderAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the local platform
  *
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/UserDefaultParameterPersistenceAdapter.js

@@ -6,7 +6,7 @@
  *               TODO will be replaced by true persistence within this SP!
  *               This adapter delegates to the Personalization Adapter
  *
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/adapters/local/UserInfoAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The UserInfo adapter for the demo platform.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/api/DWS.js

@@ -49,7 +49,7 @@ sap.ui.define([
 
     /**
      * Returns the all application iframes and their origins.
-     * @returns {{iframe: HTMLIFrameElement, origin: string}[]} The iframes and their origins.
+     * @returns {Array<{iframe: HTMLIFrameElement, origin: string}>} The iframes and their origins.
      *
      * @since 1.135.0
      * @private

package/src/main/js/sap/ushell/api/NewExperience.js

@@ -6,11 +6,13 @@
 sap.ui.define([
     "sap/ui/base/EventProvider",
     "sap/ui/model/json/JSONModel",
-    "sap/ushell/api/NewExperience/CustomOverflowListItem"
+    "sap/ushell/api/NewExperience/CustomOverflowListItem",
+    "sap/ushell/Config"
 ], function (
     EventProvider,
     JSONModel,
-    CustomOverflowListItem
+    CustomOverflowListItem,
+    Config
 ) {
     "use strict";
 
@@ -35,6 +37,7 @@ sap.ui.define([
         #shellHeaderControl = null;
         #overflowControl = null;
         #model = null;
+        #newExperienceHeadEndItem = null;
 
         constructor () {
             this.#initModel();
@@ -224,6 +227,8 @@ sap.ui.define([
          * In the shell header, the switch control is placed directly "as is".
          * In the shell header overflow, the switch control is wrapped.
          * Because of this wrapping, whenever toggling the visibility of the switch control, it is also necessary to call {@link #setSwitchVisibility}.
+         * If the ShellBar is enabled, this method also creates a header end item using the `FrameBoundExtension` service
+         * and configures it to show for all apps and on the home page.
          * @param {sap.ui.core.Control} oShellHeaderControl The shell header switch control
          *
          * @since 1.124.0
@@ -244,6 +249,23 @@ sap.ui.define([
                 this.#eventProvider.fireEvent("activeChanged", { active: this.isActive() });
             }
 
+            if (Config.last("/core/shellBar/enabled")) {
+                if (oShellHeaderControl) {
+                    if (!oShellHeaderControl.data("help-id")) {
+                        oShellHeaderControl.data("help-id", "ushell-new-experience-switch", true);
+                    }
+                const Container = sap.ui.require("sap/ushell/Container");
+                Container.getServiceAsync("FrameBoundExtension").then(async (FrameBoundExtension) => {
+                    this.#newExperienceHeadEndItem = await FrameBoundExtension.createHeaderItem({ id: oShellHeaderControl.getId() });
+                    this.#newExperienceHeadEndItem.showForAllApps();
+                    this.#newExperienceHeadEndItem.showOnHome();
+                });
+                } else {
+                    this.#newExperienceHeadEndItem?.hideForAllApps();
+                    this.#newExperienceHeadEndItem?.hideOnHome();
+                }
+            }
+
             this.#updateShellHeaderVisibility();
         }
 

package/src/main/js/sap/ushell/api/RTA.js

@@ -3,11 +3,17 @@
  * @fileOverview Utility functions for RTA.
  */
 sap.ui.define([
+    "sap/ui/core/theming/Parameters",
     "sap/ushell/Container",
-    "sap/ushell/EventHub"
+    "sap/ushell/EventHub",
+    "sap/ushell/Config",
+    "sap/ushell/state/ShellModel"
 ], function (
+    ThemingParameters,
     Container,
-    EventHub
+    EventHub,
+    Config,
+    ShellModel
 ) {
     "use strict";
 
@@ -23,15 +29,70 @@ sap.ui.define([
 
     /**
      * Returns the shell header control.
-     * @returns {sap.ui.core.Control} The shellHeader
+     * @returns {sap.ushell.ui.ShellHeader} The shellHeader
      *
      * @since 1.120.0
      * @private
      * @ui5-restricted sap.ui.fl, sap.ui.rta
+     * @deprecated Since version 1.136.1
      */
     RtaUtils.getShellHeader = function () {
         const oRenderer = Container.getRendererInternal();
-        return oRenderer.getRootControl().getShellHeader();
+        if (!Config.last("/core/shellBar/enabled")) {
+            return oRenderer.getRootControl().getShellHeader();
+        } else {
+            // the webComponent is very different from the previous shell header
+            return {
+                getLogo: this.getLogo
+            };
+        }
+    };
+
+    /**
+     * RTA uses getLogo() to find the current logo URL.
+     * Modify getLogo until a better way is implemented in RTA.
+     * Logo priority:
+     *  1) Custom Company logo URL
+     *  2) set in the constructor of the shell header
+     *  3) theme logo
+     *  4) SAP logo
+     *  5) undefined
+     * In case the logo cannot yet be retrieved from the theme, a invalidation is triggered.
+     *
+     * @since 1.136.1
+     * @returns {string|undefined} Logo URL
+     * @private
+     * @ui5-restricted sap.ui.rta
+     */
+    RtaUtils.getLogo = function () {
+        const bShowLogo = ShellModel.getModel().getProperty("/header/home/showLogo");
+        if (!bShowLogo) {
+            return;
+        }
+
+        const sCustomCompanyLogoUrl = Config.last("/core/companyLogo/url");
+
+        if (sCustomCompanyLogoUrl !== "") {
+            return sCustomCompanyLogoUrl;
+        }
+
+        const sThemeLogo = ThemingParameters.get({
+            name: "sapUiGlobalLogo",
+            callback: () => { }
+        });
+
+        if (sThemeLogo) {
+            // check given logo URL: Is it valid?
+            const aMatch = /url[\s]*\('?"?([^'")]*)'?"?\)/.exec(sThemeLogo);
+            if (aMatch) {
+                return aMatch[1];
+            }
+        }
+        if (sThemeLogo === "none") {
+            return sap.ui.require.toUrl("sap/ushell/themes/base/img/SAPLogo.svg");
+        }
+
+        return "";
     };
 
     /**

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

@@ -2,12 +2,11 @@
 
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.135.0
+ * @version 1.136.0
  */
 sap.ui.define([
     "sap/base/util/deepEqual",
     "sap/base/util/Deferred",
-    "sap/base/util/ObjectPath",
     "sap/ui/Device",
     "sap/ui/core/Element",
     "sap/ui/core/EventBus",
@@ -34,7 +33,6 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/Config",
     "sap/ushell/ApplicationType",
-    "sap/base/util/deepExtend",
     "sap/ushell/utils/UriParameters",
     "sap/base/Log",
     "sap/ushell/EventHub",
@@ -51,12 +49,10 @@ sap.ui.define([
     "sap/ushell/state/KeepAlive",
     "sap/ushell/ui5service/ShellUIServiceFactory",
     "sap/ui/core/service/ServiceFactoryRegistry",
-    "sap/ushell/library",
-    "sap/ushell/components/applicationIntegrationOld/AppLifeCycle"
+    "sap/ushell/library"
 ], (
     deepEqual,
     Deferred,
-    ObjectPath,
     Device,
     Element,
     EventBus,
@@ -83,7 +79,6 @@ sap.ui.define([
     ushellUtils,
     Config,
     ApplicationType,
-    deepExtend,
     UriParameters,
     Log,
     EventHub,
@@ -100,16 +95,10 @@ sap.ui.define([
     KeepAlive,
     ShellUIServiceFactory,
     ServiceFactoryRegistry,
-    ushellLibrary,
-    AppLifeCycleFallback
+    ushellLibrary
 ) => {
     "use strict";
 
-    if (Config.last("/core/navigation/enableAppLifeCycleFallback")) {
-        ObjectPath.set("sap.ushell.components.applicationIntegration.AppLifeCycle", AppLifeCycleFallback);
-        return AppLifeCycleFallback;
-    }
-
     // shortcut for sap.ushell.appIntegration.contracts.StatefulType
     const StatefulType = ushellLibrary.appIntegration.contracts.StatefulType;
 
@@ -429,13 +418,51 @@ sap.ui.define([
             "Shell-appfinder-component",
             "Shell-home-component",
             "pages-component-container",
+            "homeApp-component-wrapper-container",
             "homeApp-component-container",
             "workPageRuntime-component-container",
             "runtimeSwitcher-component-container"
         ];
 
+        const bNavWithinSameContainer = sFromId === sToId;
         const bNavigationToFlpComponent = aFlpComponentIds.some((sFlpComponentId) => sToId.includes(sFlpComponentId));
 
+        // first cleanup
+        if (sFromId && oFrom) {
+            // ==== Navigation from app to [any] ====
+            if (oFrom.isA("sap.ushell.appIntegration.ApplicationContainer")) {
+                const oApplicationContainer = oFrom;
+
+                if (!bNavWithinSameContainer) {
+                    await this._handleExitApplication(oApplicationContainer, bNavigationToFlpComponent);
+                }
+
+            // ==== Navigation from renderer managed component to [any] ====
+            } else {
+                const sFromControlId = sFromId;
+                const oFromControl = oFrom;
+
+                if (bNavWithinSameContainer) {
+                    return;
+                }
+
+                // handle the case of appFinder
+                if (sToId.indexOf("Shell-appfinder-component") > 0) {
+                    EventBus.getInstance().publish("sap.ushell", "appFinderAfterNavigate");
+                }
+
+                if (this._bDisableHomeAppCache) {
+                    try {
+                        this._removeApplicationContainerFromNavContainer(oFromControl);
+                        oFromControl.destroy();
+                    } catch (oError) {
+                        Log.error(`Error when trying to destroy the home component: '${sFromControlId}'`, oError);
+                    }
+                }
+            }
+        }
+
+        // second restore state
         if (sToId && oTo) {
             // ==== Navigation from [any] to app ====
             if (oTo.isA("sap.ushell.appIntegration.ApplicationContainer")) {
@@ -466,37 +493,6 @@ sap.ui.define([
                 AppInfoParameters.flush();
             }
         }
-
-        if (sFromId && oFrom) {
-            // ==== Navigation from app to [any] ====
-            if (oFrom.isA("sap.ushell.appIntegration.ApplicationContainer")) {
-                const bNavWithinSameContainer = sFromId === sToId;
-                const oApplicationContainer = oFrom;
-
-                if (!bNavWithinSameContainer) {
-                    await this._handleExitApplication(oApplicationContainer, bNavigationToFlpComponent);
-                }
-
-            // ==== Navigation from renderer managed component to [any] ====
-            } else {
-                const sFromControlId = sFromId;
-                const oFromControl = oFrom;
-
-                // handle the case of appFinder
-                if (sToId.indexOf("Shell-appfinder-component") > 0) {
-                    EventBus.getInstance().publish("sap.ushell", "appFinderAfterNavigate");
-                }
-
-                if (this._bDisableHomeAppCache) {
-                    try {
-                        this._removeApplicationContainerFromNavContainer(oFromControl);
-                        oFromControl.destroy();
-                    } catch (oError) {
-                        Log.error(`Error when trying to destroy the home component: '${sFromControlId}'`, oError);
-                    }
-                }
-            }
-        }
     };
 
     /**
@@ -514,6 +510,8 @@ sap.ui.define([
             }
 
             if (oApplicationContainer.isA("sap.ushell.appIntegration.IframeApplicationContainer")) {
+                oApplicationContainer.setDataHelpId("");
+
                 if (oApplicationContainer.getStatefulType() === StatefulType.ContractV2) {
                     const bSupportsKeepAliveWithinSameFrame = StatefulContainerV2Handler.isStatefulContainerSupportingKeepAlive(oApplicationContainer);
 
@@ -579,6 +577,8 @@ sap.ui.define([
 
         const bIsReusableContainer = oApplicationContainer.getStatefulType() !== StatefulType.NotSupported;
         if (!bHardDestroy && bIsReusableContainer) {
+            oApplicationContainer.setDataHelpId("");
+
             // First return the container to the pool in case it was keep alive.
             // the "return to pool" step requires the current metadata and has to be done before the actual close
             this._setContainerReadyForReuse(oApplicationContainer);
@@ -879,10 +879,11 @@ sap.ui.define([
      * Opens an application in an application container and sets it as the current application.
      *
      * @param {string} sStorageAppId the id of the application.
+     * @param {string} sBaseAppId the base application id.
      * @param {object} oResolvedHashFragment the resolved hash fragment.
      * @param {object} bShouldBeCached Wether it should be cached.
      */
-    AppLifeCycle.prototype._createOrReuseApplicationContainer = function (sStorageAppId, oResolvedHashFragment, bShouldBeCached) {
+    AppLifeCycle.prototype._createOrReuseApplicationContainer = function (sStorageAppId, sBaseAppId, oResolvedHashFragment, bShouldBeCached) {
         let oApplicationContainer;
 
         const oStorageEntry = KeepAliveApps.get(sStorageAppId);
@@ -910,6 +911,7 @@ sap.ui.define([
             const bIsUI5App = !!sTargetUi5ComponentName;
 
             const oCommonProperties = {
+                dataHelpId: sBaseAppId,
                 initialAppId: sStorageAppId,
                 currentAppId: sStorageAppId,
                 currentAppUrl: oResolvedHashFragment.url,
@@ -937,6 +939,7 @@ sap.ui.define([
             this._oNavContainer.addPage(oApplicationContainer);
         } else {
             oApplicationContainer.setIsFetchedFromCache(true);
+            oApplicationContainer.setDataHelpId(sBaseAppId);
         }
 
         ApplicationContainerCache.setContainerActive(oApplicationContainer);
@@ -1199,11 +1202,17 @@ sap.ui.define([
         return bFullWidth;
     };
 
-    AppLifeCycle.prototype._getStorageAppId = function (sFixedShellHash) {
+    AppLifeCycle.prototype._getBaseAppId = function (sFixedShellHash) {
         const sStableHash = UrlParsing.getStableIntent(sFixedShellHash);
         const sBasicHash = UrlParsing.getBasicHash(sStableHash);
         const sBaseAppId = `application-${sBasicHash}`;
 
+        return sBaseAppId;
+    };
+
+    AppLifeCycle.prototype._getStorageAppId = function (sFixedShellHash, sBaseAppId) {
+        const sStableHash = UrlParsing.getStableIntent(sFixedShellHash);
+
         if (this._oStorageAppIdMap[sStableHash]) {
             return this._oStorageAppIdMap[sStableHash];
         }
@@ -1248,7 +1257,8 @@ sap.ui.define([
      * @returns
      */
     AppLifeCycle.prototype._startApplication = async function (sAppId, oParsedShellHash, oResolvedHashFragment, bNavigationFromHome, bNavigationWithInnerAppRoute) {
-        const sStorageAppId = this._getStorageAppId(oResolvedHashFragment.sFixedShellHash);
+        const sBaseAppId = this._getBaseAppId(oResolvedHashFragment.sFixedShellHash);
+        const sStorageAppId = this._getStorageAppId(oResolvedHashFragment.sFixedShellHash, sBaseAppId);
 
         await this._cleanupBeforeNewApp(
             sStorageAppId,
@@ -1265,7 +1275,7 @@ sap.ui.define([
         const sKeepAliveMode = this._calculateKeepAliveMode(sStorageAppId, oResolvedHashFragment, oParsedShellHash);
         const bShouldBeCached = sKeepAliveMode !== KeepAliveMode.False;
 
-        const oApplicationContainer = this._createOrReuseApplicationContainer(sStorageAppId, oResolvedHashFragment, bShouldBeCached);
+        const oApplicationContainer = this._createOrReuseApplicationContainer(sStorageAppId, sBaseAppId, oResolvedHashFragment, bShouldBeCached);
 
         // check after cleanup, but before creating the storage entry
         const bWasKeptAlive = !!KeepAliveApps.get(sStorageAppId);