@sapui5/sap.ushell 1.124.2 → 1.124.4

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

@@ -5,13 +5,15 @@
  * This files exposes an API to extend the launchpad with new elements.
  * It is exposed publicly and meant to be used by apps and plugins.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
+    "sap/ui/core/Element",
     "sap/ushell/services/Extension/Item",
     "sap/ushell/Container",
     "sap/ushell/utils"
 ], function (
+    Element,
     ExtensionItem,
     Container,
     ushellUtils
@@ -135,10 +137,11 @@ sap.ui.define([
         const fnShow = oRenderer.showHeaderItem.bind(oRenderer);
         const fnHide = oRenderer.hideHeaderItem.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     /**
@@ -162,10 +165,11 @@ sap.ui.define([
         const fnShow = oRenderer.showHeaderEndItem.bind(oRenderer);
         const fnHide = oRenderer.hideHeaderEndItem.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     // ========================================== UserAction ====================================================================
@@ -200,10 +204,11 @@ sap.ui.define([
         const fnShow = oRenderer.showActionButton.bind(oRenderer);
         const fnHide = oRenderer.hideActionButton.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     Extension.hasNoAdapter = true;

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

@@ -4,7 +4,7 @@
  * @file The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
  * This is the privately used subset of the previously deprecated public LaunchPage service API
  * @private
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/services/FrameBoundExtension/FloatingContainer.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ui/base/ManagedObject",

package/src/main/js/sap/ushell/services/FrameBoundExtension/Footer.js

@@ -5,7 +5,7 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/Container"

package/src/main/js/sap/ushell/services/FrameBoundExtension/Item.js

@@ -5,13 +5,15 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/ushell/components/applicationIntegration/AppLifeCycle",
     "sap/ushell/Config"
 ], function (
     Log,
+    AppLifeCycleAI,
     Config
 ) {
     "use strict";
@@ -21,7 +23,11 @@ sap.ui.define([
      * @class
      * @classdesc Item wrapping an item positioned in an extension point.
      * To be instantiated by {@link sap.ushell.services.FrameBoundExtension}.
-     *
+     * <br>
+     * The item will be automatically destroyed when the user navigates away from the current application.
+     * After calling {@link sap.ushell.services.FrameBoundExtension.Item#showOnHome} or {@link sap.ushell.services.FrameBoundExtension.Item#showForAllApps}
+     * the item is not destroyed automatically and has to be destroyed manually via {@link sap.ushell.services.FrameBoundExtension.Item#destroy}.
+     * <br>
      * <p><b>Restriction:</b> Does not work when called from within a iframe.
      * The calling function has to be in the 'same frame' as the launchpad itself.</p>
      *
@@ -48,9 +54,32 @@ sap.ui.define([
             throw new Error("Shall be implemented by item");
         };
 
-        constructor (oControl, visibilityHandler) {
+        constructor (oControl, visibilityHandler, controlWasPreCreated) {
             this.#control = oControl;
             this.#visibilityHandler = visibilityHandler;
+
+            /*
+             * if the control was pre-created the application should take care of the control life cycle.
+             * Add the control to the managed queue by default and remove it once it is related to a base state.
+             */
+            if (!controlWasPreCreated) {
+                const ShellModel = AppLifeCycleAI.getElementsModel();
+                ShellModel.addElementToManagedQueue(this.#control);
+            } else {
+                Log.warning("The control was pre-created and the application is responsible for the control life cycle");
+            }
+        }
+
+        /**
+         * Removes the item from the managed queue.
+         * With this the item will not be destroyed when the user navigates away from the application.
+         *
+         * @since 1.128.0
+         * @private
+         */
+        #removeFromManagedQueue () {
+            const ShellModel = AppLifeCycleAI.getElementsModel();
+            ShellModel.removeElementFromManagedQueue(this.#control);
         }
 
         /**
@@ -99,6 +128,11 @@ sap.ui.define([
          * @private
          */
         setVisibilityForLaunchpadState (launchpadState, visible) {
+            if (visible) {
+                // if the item was once related to the base state it should not be added to the managed queue.
+                this.#removeFromManagedQueue();
+            }
+
             this.#visibilityMap[launchpadState] = visible;
             this.#visibilityHandler(visible, false, launchpadState);
         }
@@ -136,6 +170,7 @@ sap.ui.define([
         /**
          * Shows the item for all applications.
          * Does not change the visibility of the item for the launchpad "home".
+         * Disables the automatic destruction of the item when the user navigates away from the current application.
          * @returns {this} Reference to <code>this</code> for method chaining.
          *
          * @since 1.124.0
@@ -162,6 +197,7 @@ sap.ui.define([
         /**
          * Shows the item for launchpad "home".
          * Does not change the visibility of the item within applications.
+         * Disables the automatic destruction of the item when the user navigates away from the current application.
          * @returns {this} Reference to <code>this</code> for method chaining.
          *
          * @since 1.124.0

package/src/main/js/sap/ushell/services/FrameBoundExtension/SidePane.js

@@ -5,13 +5,15 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
+    "sap/ui/core/Element",
     "sap/ushell/services/FrameBoundExtension/Item",
     "sap/ushell/Container",
     "sap/ushell/utils"
 ], function (
+    Element,
     ExtensionItem,
     Container,
     ushellUtils
@@ -76,6 +78,7 @@ sap.ui.define([
             const fnShow = this.#renderer.showLeftPaneContent.bind(this.#renderer);
             const fnHide = this.#renderer.hideLeftPaneContent.bind(this.#renderer);
 
+            const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
             const oControl = await ushellUtils.promisify(fnCreate(...aCreateArgs));
 
             async function visibilityHandler (visible, currentState, state) {
@@ -87,7 +90,7 @@ sap.ui.define([
                 await ushellUtils.promisify(fnHide(oControl.getId(), currentState, states));
             }
 
-            return new ExtensionItem(oControl, visibilityHandler);
+            return new ExtensionItem(oControl, visibilityHandler, bControlWasPreCreated);
         }
 
         /**

package/src/main/js/sap/ushell/services/FrameBoundExtension/ToolArea.js

@@ -5,13 +5,15 @@
  *
  * This interface does NOT work when called from within a iframe.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
+    "sap/ui/core/Element",
     "sap/ushell/services/FrameBoundExtension/Item",
     "sap/ushell/Container",
     "sap/ushell/utils"
 ], function (
+    Element,
     ExtensionItem,
     Container,
     ushellUtils
@@ -73,6 +75,7 @@ sap.ui.define([
             const fnShow = this.#renderer.showToolAreaItem.bind(this.#renderer);
             const fnHide = this.#renderer.removeToolAreaItem.bind(this.#renderer);
 
+            const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
             const oControl = await ushellUtils.promisify(fnCreate(...aCreateArgs));
 
             async function visibilityHandler (visible, currentState, state) {
@@ -84,7 +87,7 @@ sap.ui.define([
                 await ushellUtils.promisify(fnHide(oControl.getId(), currentState, states));
             }
 
-            return new ExtensionItem(oControl, visibilityHandler);
+            return new ExtensionItem(oControl, visibilityHandler, bControlWasPreCreated);
         }
 
         /**

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

@@ -8,9 +8,10 @@
  * This service can only be called from the outer shell and is not available
  * in the inner shell or via post message API.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
+    "sap/ui/core/Element",
     "sap/ushell/services/FrameBoundExtension/FloatingContainer",
     "sap/ushell/services/FrameBoundExtension/Footer",
     "sap/ushell/services/FrameBoundExtension/Item",
@@ -19,6 +20,7 @@ sap.ui.define([
     "sap/ushell/Container",
     "sap/ushell/utils"
 ], function (
+    Element,
     FloatingContainerArea,
     FooterItem,
     ExtensionItem,
@@ -137,10 +139,11 @@ sap.ui.define([
         const fnShow = oRenderer.showHeaderItem.bind(oRenderer);
         const fnHide = oRenderer.hideHeaderItem.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     /**
@@ -164,10 +167,11 @@ sap.ui.define([
         const fnShow = oRenderer.showHeaderEndItem.bind(oRenderer);
         const fnHide = oRenderer.hideHeaderEndItem.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     // ========================================== SubHeader ====================================================================
@@ -199,13 +203,14 @@ sap.ui.define([
         const fnShow = oRenderer.showSubHeader.bind(oRenderer);
         const fnHide = oRenderer.hideSubHeader.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
         // hide
         // fnVisibilityHandler(false, true, []);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     // ========================================== SidePane ====================================================================
@@ -262,10 +267,11 @@ sap.ui.define([
         const fnShow = oRenderer.showActionButton.bind(oRenderer);
         const fnHide = oRenderer.hideActionButton.bind(oRenderer);
 
+        const bControlWasPreCreated = !!Element.getElementById(controlProperties.id);
         const oControl = await this._createControl(fnCreate, aCreateArgs);
         const fnVisibilityHandler = this._createItemVisibilityHandler(oControl.getId(), fnShow, fnHide);
 
-        return new ExtensionItem(oControl, fnVisibilityHandler);
+        return new ExtensionItem(oControl, fnVisibilityHandler, bControlWasPreCreated);
     };
 
     // ========================================== Footer ====================================================================

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileoverview The Unified Shell's page builder service providing the data for the Fiori launchpad's classic Homepage.
- * @version 1.124.2
+ * @version 1.124.4
  * @deprecated since 1.120
  */
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The menu service provides the entries for the menu bar
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/Config",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's message service.
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes API endpoints for Generic Communication
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/services/_MessageBroker/MessageBrokerEngine",

package/src/main/js/sap/ushell/services/Navigation/compatibility.js

@@ -4,7 +4,7 @@
  * compatible with the CrossApplicationNavigation service.
  * This shall only be used for the AppRuntime to enable 1.x inner shell running in 2.x host.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/services/Navigation/utils.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Navigation utility functions
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 
 

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

@@ -5,7 +5,7 @@
  * This file exposes an API to perform (invoke) Navigation for applications.
  * It exposes interfaces to perform a hash change and trigger a navigation.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -8,7 +8,7 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/resources"

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page building service.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery"

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

@@ -6,7 +6,7 @@
  * It provides the layout and tile data of pages in the pages runtime.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([], function () {
     "use strict";

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with page related referencing and dereferencing.
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/services/_PageReferencing/PageReferencer"

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module exposes a model containing the pages hierarchy to its clients.
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.124.2
+ * @version 1.124.4
  * @deprecated since 1.120 Please use {@link sap.ushell.services.PersonalizationV2} instead
  */
 sap.ui.define([

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's personalization service, which provides generic read and write access to the currently logged on user's
  * personalization settings for the app currently executed in the shell.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview resolves references
- * @version 1.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  * @deprecated since 1.120
  */
 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.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview APIs for the S/4 MyHome
- * @version 1.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  */
 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.124.2
+ * @version 1.124.4
  */
  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-2023 SAP SE, All Rights Reserved
 /**
  * @fileOverview The URLTemplate service provides utilities when working with URL templates
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/utils",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UI5 component loader service.
  * This is a shell-internal service and no public or application facing API!
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",
@@ -225,9 +225,9 @@ sap.ui.define([
                 if (typeof oComponentProperties.manifest === "string" && oComponentProperties.manifest.length > 0 && "sap.ui.fl" in Library.all()) {
                     sap.ui.require(["sap/ui/fl/apply/api/FlexRuntimeInfoAPI"], (FlexRuntimeInfoAPI) => {
                         try {
-                            let sNewVersion = FlexRuntimeInfoAPI.getFlexVersion({ reference: oComponentProperties.name });
+                            const sNewVersion = FlexRuntimeInfoAPI.getFlexVersion({ reference: oData.appPropertiesSafe.ui5ComponentName });
                             if (typeof sNewVersion === "string" && sNewVersion.length > 0) {
-                                let oManifestUrl = new URI(oComponentProperties.manifest);
+                                const oManifestUrl = new URI(oComponentProperties.manifest);
                                 oManifestUrl.addQuery("version", sNewVersion);
                                 oComponentProperties.manifest = oManifestUrl.toString();
                             }

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

@@ -14,7 +14,7 @@
  *
  * This is *not* an application facing service, but for Shell Internal usage.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -7,7 +7,7 @@
  *               This service should be accessed by the application
  *               via the CrossApplicationNavigation service.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's user information service. Allows retrieving information about the logged-in user.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The Unified Shell's user activity service.
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/base/util/ObjectPath",

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

@@ -7,7 +7,7 @@
  *
  * Configured with the LaunchPageAdapter.
  *
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/resources",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview This module deals with the instantiation of visualizations in a platform independent way.
- * @version 1.124.2
+ * @version 1.124.4
  */
 sap.ui.define([
     "sap/ushell/ui/launchpad/VizInstance",