@sapui5/sap.ushell 1.141.3 → 1.142.1

package/src/main/js/sap/ushell/adapters/cep/MenuAdapter.js

@@ -90,7 +90,6 @@ sap.ui.define([
             this.siteId = oAdapterConfiguration.config.siteId;
             this.oWorkPageService = new WorkPageService();
             this.oSiteDataPromise = this._doRequest(this.serviceUrl, this.siteId);
-            this.oVizDataPromise = this._loadVisualizations();
         } else {
             Log.error("Invalid configuration provided.", "", sCEPMenuAdapterComponent);
         }
@@ -160,11 +159,8 @@ sap.ui.define([
      * @private
      */
     MenuAdapter.prototype.getMenuEntries = async function () {
-        const [aMenu, aVisualizations] = await Promise.all([
-            this._getMenu(),
-            this._getVisualizations()
-        ]);
-        return this._buildMenuEntries(aMenu, aVisualizations);
+        const aMenu = await this._getMenu();
+        return this._buildMenuEntries(aMenu);
     };
 
     /**
@@ -209,24 +205,40 @@ sap.ui.define([
      * Builds a menu which is accepted by the menu service.
      *
      * @param {MenuData[]} aMenu The menu fetched from the site data.
-     * @param {object[]} aVisualizations The Visualizations.
      * @returns {MenuEntry[]} The menu structure required by the menu service, @see sap.ushell.services.menu#MenuEntry
      * @since 1.106.0
      * @private
      */
-    MenuAdapter.prototype._buildMenuEntries = function (aMenu, aVisualizations) {
+    MenuAdapter.prototype._buildMenuEntries = async function (aMenu) {
+        if (!this.aVisualizations) {
+            /**
+             * Temporary fallback until the extended menu query is available in every system.
+             * If the extended menu query is not yet available, load visualizations via query
+             */
+            const bNeedsVizFetch = aMenu.some((oMenuEntry) =>
+                Array.isArray(oMenuEntry.subMenu) &&
+                oMenuEntry.subMenu.some((oSubMenuNode) =>
+                    oSubMenuNode.type === SubMenuType.Visualization &&
+                    !(oSubMenuNode.navigationTarget && oSubMenuNode.navigationTarget.intent)
+                )
+            );
+            if (bNeedsVizFetch) {
+                const oVisualizationData = await this._loadVisualizations();
+                this.aVisualizations = await this._getVisualizations(oVisualizationData);
+            }
+        }
+
         // Create a 1st level menu entry for each space
         // having 2nd level sub menu entries for its pages and visualizations inside if needed.
-
         return aMenu
             .filter(this._isSpaceNotEmpty.bind(null, SpaceEntity.Menu))
             .map((oMenu) => {
-                const oTopMenuEntry = this._buildMenuEntry(oMenu, aVisualizations);
+                const oTopMenuEntry = this._buildMenuEntry(oMenu);
                 const aSubMenuEntries = [];
 
                 oMenu.subMenu.forEach((oSubMenuNode) => {
                     oSubMenuNode.spaceid = oMenu.id;
-                    const oSubMenuEntry = this._buildMenuEntry(oSubMenuNode, aVisualizations);
+                    const oSubMenuEntry = this._buildMenuEntry(oSubMenuNode);
                     aSubMenuEntries.push(oSubMenuEntry);
                 });
 
@@ -242,12 +254,11 @@ sap.ui.define([
      * Builds the menu structure for a single menu entry.
      *
      * @param {MenuData} oMenuEntry The menu object fetched from the site data.
-     * @param {object[]} aVisualizations The Visualizations.
      * @returns {MenuEntry[]} The menu structure required by the menu service, @see sap.ushell.services.menu#MenuEntry
      * @since 1.132.0
      * @private
      */
-    MenuAdapter.prototype._buildMenuEntry = function (oMenuEntry, aVisualizations) {
+    MenuAdapter.prototype._buildMenuEntry = function (oMenuEntry) {
         // By default we expect that the menu entry is a page.
         let oSubMenuNode = oMenuEntry;
         let sTitle = oMenuEntry.title;
@@ -271,18 +282,25 @@ sap.ui.define([
             }
         }
         // If the node is a visualization the target action should be the visualization target action.
-        const oViz = aVisualizations.find((obj) => obj.id === oSubMenuNode?.id);
-
-        if (oViz && oViz !== undefined) {
+        if (oSubMenuNode.type === SubMenuType.Visualization) {
             sHelpId = "App-";
             sName = "sap-ui-app-id-hint";
-
-            if (oViz.targetAppIntent) {
-                sValue = oViz.targetAppIntent.businessAppId;
-                sSemanticObject = oViz.targetAppIntent.semanticObject;
-                sAction = oViz.targetAppIntent.action;
+            if (oSubMenuNode?.navigationTarget?.intent) {
+                sValue = oSubMenuNode.navigationTarget.intent.businessAppId;
+                sSemanticObject = oSubMenuNode.navigationTarget.intent.semanticObject;
+                sAction = oSubMenuNode.navigationTarget.intent.action;
             } else {
-                Log.warning(`Visualization ${oViz.id} does not contain a targetAppIntent for site-id: ${this.siteId}, ${sCEPMenuAdapterComponent}`);
+                // Temporary Fallback until the extended menu query is available in every system.
+                const oViz = this.aVisualizations.find((obj) => obj.id === oSubMenuNode?.id);
+                if (oViz && oViz !== undefined) {
+                    if (oViz.targetAppIntent) {
+                        sValue = oViz.targetAppIntent.businessAppId;
+                        sSemanticObject = oViz.targetAppIntent.semanticObject;
+                        sAction = oViz.targetAppIntent.action;
+                    } else {
+                        Log.warning(`Visualization ${oViz.id} does not contain a targetAppIntent for site-id: ${this.siteId}, ${sCEPMenuAdapterComponent}`);
+                    }
+                }
             }
         }
 
@@ -482,8 +500,7 @@ sap.ui.define([
     * @returns {Promise<aVisualizations[]>} The visualizations as an array
     * @private
     */
-    MenuAdapter.prototype._getVisualizations = async function () {
-        const oVisualizationData = await this.oVizDataPromise;
+    MenuAdapter.prototype._getVisualizations = function (oVisualizationData) {
         if (Array.isArray(oVisualizationData?.visualizations?.nodes) && oVisualizationData.visualizations.nodes.length > 0
         ) {
             return oVisualizationData.visualizations.nodes;

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileoverview The NavTargetResolution adapter for SAP MyHome used in FioriLaunchpad.CEP.MyHome
- * @version 1.141.3
+ * @version 1.142.1
  * @deprecated since 1.120
  * @private
  */

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileoverview The NavTargetResolutionInternal adapter for SAP MyHome
- * @version 1.141.3
+ * @version 1.142.1
  * @since 1.120
  */
 
@@ -97,7 +97,8 @@ sap.ui.define([
         const oHeaders = {
             "Content-Type": "application/json; charset=utf-8",
             Accept: "application/json",
-            "Accept-Language": Localization.getLanguageTag().toString() || ""
+            "Accept-Language": Localization.getLanguageTag().toString() || "",
+            "sap-consumer": "sap.start"
         };
 
         const sBasePath = `${this.oAdapterConfiguration.config.navServiceUrl}/`;

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for CEP applications (client-side search).
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ui/core/Lib",
@@ -62,28 +62,34 @@ sap.ui.define([
      * @returns {Promise<object>} the result of the search.
      */
     SearchCEPAdapter.prototype._searchWithSearchableContentAndJsSearch = function (oParameters) {
-        return Promise.all([this._getNormalizedSearchableContentApps(oParameters), this._loadJsSearchModule()]).then((aPromiseResults) => {
-            const aNormalizedSearchableContentApps = aPromiseResults[0];
-            const JsSearch = aPromiseResults[1];
-            const oSearchEngine = new JsSearch({
-                objects: aNormalizedSearchableContentApps,
-                fields: ["title", "label", "contentProviderLabel", "description", "keywords", "fioriAppId"],
-                shouldNormalize: !String.prototype.normalize,
-                algorithm: {
-                    id: "contains-ranked",
-                    options: [50, 49, 40, 39, 5, 4, 51]
-                }
+        // Build and cache the search index once; reuse for subsequent queries
+        if (!this._searchEnginePromise) {
+            this._searchEnginePromise = Promise.all([
+                this._getNormalizedSearchableContentApps(oParameters),
+                this._loadJsSearchModule()
+            ]).then((aPromiseResults) => {
+                const aNormalizedSearchableContentApps = aPromiseResults[0];
+                const JsSearch = aPromiseResults[1];
+                return new JsSearch({
+                    objects: aNormalizedSearchableContentApps,
+                    fields: ["title", "label", "contentProviderLabel", "description", "keywords", "fioriAppId"],
+                    shouldNormalize: !String.prototype.normalize,
+                    algorithm: {
+                        id: "contains-ranked",
+                        options: [50, 49, 40, 39, 5, 4, 51]
+                    }
+                });
             });
+        }
+
+        return this._searchEnginePromise.then((oSearchEngine) => {
             const oSearchOptions = {
                 searchFor: oParameters?.searchTerm || "*", // set wildcard if no search term specified
                 top: Number.MAX_SAFE_INTEGER, // apply pagination after search due to filtering
                 skip: 0
             };
             const oSearchResult = oSearchEngine.search(oSearchOptions);
-            const aResultData = oSearchResult.results.map((o) => {
-                return o.object;
-            });
-
+            const aResultData = oSearchResult.results.map((o) => o.object);
             return this._getPaginatedResult(
                 this._applyFiltersAndSorter(aResultData, oParameters.filter, oParameters.sort),
                 oParameters.skip || 0,

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's UserDefaultParameterPersistence adapter for the CFLP
  *               platform.
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ushell/utils/HttpClient",

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

@@ -5,7 +5,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -5,7 +5,7 @@
  *   TODO will be replaced by true persistence within this SP!
  *   This adapter delegates to the Personalization Adapter
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ushell/services/appstate/AppStatePersistencyMethod",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's ClientSideTargetResolutionAdapter for the local
  *               platform.
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's container adapter for standalone demos.
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  *
  * @deprecated since 1.100
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ushell/adapters/local/FlpLaunchPageAdapter"

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.141.3
+ * @version 1.142.1
  * @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.141.3
+ * @version 1.142.1
  * @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.141.3
+ * @version 1.142.1
  */
 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.141.3
+ * @version 1.142.1
  */
 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.141.3
+ * @version 1.142.1
  */
 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.141.3
+ * @version 1.142.1
  */
 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.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
 ], () => {

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.141.3
+ * @version 1.142.1
  */
 /* eslint-disable quote-props */
 sap.ui.define([], () => {

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The SupportTicket adapter for the local platform.
  *
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
 ], () => {

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.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
 ], () => {

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.141.3
+ * @version 1.142.1
  */
 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.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview handle all the resources for the different applications.
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/base/util/Deferred",
@@ -196,7 +196,6 @@ sap.ui.define([
      * Events will only be added the first time AppLifeCycle.init() is called.
      */
     AppLifeCycle.prototype._addEvents = function () {
-        this._aDoables.push(EventHub.on("disableKeepAliveRestoreRouterRetrigger").do(this._useLegacyRestoreFlowForCurrentApplication.bind(this)));
         this._aDoables.push(EventHub.on("setApplicationFullWidth").do((oData) => {
             this._setApplicationFullWidth(oData.bValue);
         }));
@@ -282,7 +281,7 @@ sap.ui.define([
      * @since 1.138.0
      * @private
      */
-    AppLifeCycle.prototype._useLegacyRestoreFlowForCurrentApplication = function () {
+    AppLifeCycle.prototype.useLegacyRestoreFlowForCurrentApplication = function () {
         // for direct app start the app creation and this call might be faster than the app life cycle flow
         if (!this.getCurrentApplication()?.appId) {
             this._bUseLegacyRestoreFlowForNextApp = true;
@@ -944,11 +943,10 @@ sap.ui.define([
      * @param {string} sStorageAppId the storage app id.
      * @param {sap.ushell.appIntegration.ApplicationContainer} oApplicationContainer the application container.
      * @param {object} oResolvedHashFragment the resolved hash fragment.
-     * @param {object} oParsedShellHash the parsed shell hash.
      * @param {boolean} bWasKeptAlive whether the app should be kept alive.
      * @returns {Promise} after the application was opened.
      */
-    AppLifeCycle.prototype._openApp = async function (sStorageAppId, oApplicationContainer, oResolvedHashFragment, oParsedShellHash, bWasKeptAlive) {
+    AppLifeCycle.prototype._openApp = async function (sStorageAppId, oApplicationContainer, oResolvedHashFragment, bWasKeptAlive) {
         const bWasFetchedFromCache = oApplicationContainer.getIsFetchedFromCache();
         if (bWasKeptAlive && bWasFetchedFromCache && StatefulContainerV2Handler.isStatefulContainerSupportingKeepAlive(oApplicationContainer)) {
             return StatefulContainerV2Handler.restoreAppWithinSameFrame(
@@ -1007,7 +1005,7 @@ sap.ui.define([
             if (!bComponentLoadedInDirectAppStart) {
                 AppConfiguration.setApplicationInInitMode();
 
-                await EmbeddedUI5Handler.createApp(oApplicationContainer, oResolvedHashFragment, oParsedShellHash);
+                await EmbeddedUI5Handler.createApp(oApplicationContainer, oResolvedHashFragment);
             }
 
             // todo: [FLPCOREANDUX-10024] rework abap direct app start
@@ -1254,7 +1252,6 @@ sap.ui.define([
             sStorageAppId,
             oApplicationContainer,
             oResolvedHashFragment,
-            oParsedShellHash,
             bWasKeptAlive
         );
         const oApplicationHandle = new ApplicationHandle(

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

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The UI integration's SAPUI5 control which supports application embedding.
- * @version 1.141.3
+ * @version 1.142.1
  */
 sap.ui.define([
     "sap/base/Log",
@@ -71,6 +71,16 @@ sap.ui.define([
 
                 currentAppTargetResolution: { type: "object" },
 
+                /* ==========================================
+                 * =============== Rendering ================
+                 * General flow:
+                 *  1) readyForRendering=false => render placeholder
+                 *  2) readyForRendering=true => invalidation
+                 *  3) final rendering
+                 *  4) set renderComplete=true
+                 *  5) rendered() resolves
+                 */
+
                 /**
                  * Whether the container is ready for rendering.
                  * Subclasses should prevent any preparation steps and the actual rendering if this
@@ -129,23 +139,13 @@ sap.ui.define([
         renderer: ApplicationContainerRenderer
     });
 
-    // we have to cache the UI5 version first to have it available sync for the renderer
-    ApplicationContainer.ui5version = null;
-    ApplicationContainer.ui5versionPromise = ushellUtils.getUi5Version().then((sVersion) => {
-        Log.debug(`Using ui5-version: ${sVersion}`, null, "sap.ushell.appIntegration.ApplicationContainer");
-        ApplicationContainer.ui5version = sVersion;
-    });
-
-    ApplicationContainer.prototype.getUi5Version = function () {
-        return ApplicationContainer.ui5version;
-    };
-
     /**
      * Initialization of <code>ApplicationContainer</code> instance.
      */
     ApplicationContainer.prototype.init = function () {
         // set object default values again to prevent them from being "synced"
         this.setProperty("capabilities", {}, true);
+        this.oRenderedDeferred = Promise.withResolvers();
     };
 
     ApplicationContainer.prototype.invalidate = function () {
@@ -157,6 +157,37 @@ sap.ui.define([
         return Control.prototype.invalidate.apply(this, arguments);
     };
 
+    /**
+     * Sets the rendering complete state of the application container.
+     * @param {boolean} bComplete The new rendering complete state.
+     * @returns {this} <code>this</code> to allow method chaining.
+     *
+     * @since 1.141.0
+     * @private
+     */
+    ApplicationContainer.prototype.setRenderComplete = function (bComplete) {
+        this.setProperty("renderComplete", bComplete);
+
+        if (bComplete) {
+            this.oRenderedDeferred.resolve();
+        }
+
+        return this;
+    };
+
+    /**
+     * The ApplicationContainer is rendered multiple times.
+     * This helper function awaits the final rendering triggered by
+     * {@link sap.ushell.appIntegration.ApplicationContainer#setRenderComplete}.
+     * @returns {Promise} Resolves once the ApplicationContainer is rendered
+     *
+     * @since 1.141.0
+     * @private
+     */
+    ApplicationContainer.prototype.rendered = function () {
+        return this.oRenderedDeferred.promise;
+    };
+
     /**
      * Implementation of sap.ushell.renderer.INavContainerPage interface.
      * @param {boolean} bVisible The new visibility state of the control.
@@ -408,13 +439,5 @@ sap.ui.define([
         return true;
     };
 
-    // helper for tests
-    ApplicationContainer._setCachedUI5Version = function (sNewVersion) {
-        ApplicationContainer.ui5version = sNewVersion;
-        ApplicationContainer.ui5versionPromise = ApplicationContainer.ui5versionPromise.then(() => {
-            ApplicationContainer.ui5version = sNewVersion;
-        });
-    };
-
     return ApplicationContainer;
 });

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

@@ -9,17 +9,6 @@ sap.ui.define([
         apiVersion: 2
     };
 
-    ApplicationContainerRenderer.waitForUI5Version = function (oContainer) {
-        const ApplicationContainer = oContainer.getMetadata().getClass();
-        // we have to cache the UI5 version first
-        if (ApplicationContainer.ui5version === null) {
-            ApplicationContainer.ui5versionPromise.then(() => {
-                oContainer.invalidate();
-            });
-            return true;
-        }
-    };
-
     ApplicationContainerRenderer.render = function (oRenderManager, oContainer) {
         /*
          * This is only a placeholder rendering, the actual rendering is done by the sub classes.