@sapui5/sap.ushell 1.141.2 → 1.142.0

package/src/main/js/sap/ushell/modules/loader/SearchLoader.js

@@ -0,0 +1,153 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/Container",
+    "sap/ushell/modules/loader/AbstractLoader",
+    "sap/ushell/modules/Search/SearchAPI",
+    "sap/ushell/utils/UrlParsing"
+], (
+    Config,
+    Container,
+    AbstractLoader,
+    SearchAPI,
+    UrlParsing
+) => {
+    "use strict";
+    const sConfigBasePath = "/core/search";
+
+    /**
+     * Search module loader for the Fiori Launchpad.
+     *
+     * @since 1.142.0
+     * @private
+     */
+    class SearchLoader extends AbstractLoader {
+        /**
+         * The module instance.
+         * @type {sap.ushell.modules.Search.SearchProvider}
+         */
+        #oModuleInstance;
+
+        /**
+         * The module API instance.
+         * @type {sap.ushell.modules.Search.SearchAPI}
+         */
+        #oModuleAPI;
+
+        /**
+         * A promise that resolves when the loader is initialized.
+         * @type {Promise}
+         */
+        #pInitialized;
+
+        constructor () {
+            super();
+            this.#init();
+        }
+
+        #init () {
+            this.registerConfigListener(sConfigBasePath, async () => {
+                const bEnabled = Config.last(`${sConfigBasePath}/enabled`);
+                await this.#cleanup();
+
+                if (bEnabled) {
+                    this.#oModuleInstance = await this.#load();
+                }
+                this.#pInitialized.resolve();
+            });
+        }
+
+        /**
+         * Returns a promise that resolves when the loader is initialized.
+         * @returns {Promise} A promise that resolves when the loader is initialized.
+         * @since 1.142.0
+         * @private
+         */
+        initialized () {
+            return this.#pInitialized.promise;
+        }
+
+        /**
+         * Loads the search module and creates an instance of it.
+         *
+         * @returns {Promise<sap.ushell.modules.Search.SearchProvider>} A promise that resolves to the search module instance.
+         * @since 1.142.0
+         * @private
+         */
+        async #load () {
+            this.#oModuleAPI = new SearchAPI(this.parseJSONFromConfig(`${sConfigBasePath}/configuration`));
+
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            AppLifeCycle.attachAppLoaded(this.#handleSearchFieldExpandState, this);
+
+            this.#handleSearchFieldExpandState();
+
+            // load the module
+            return this.loadModule(Config.last(`${sConfigBasePath}/modulePath`), this.#oModuleAPI);
+        }
+
+        /**
+         * Handles the search field expand state based on the appOpened event. If the search result app is opened,
+         * it sets the search field to be shown.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        async #handleSearchFieldExpandState () {
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            const oCurrentApplication = await AppLifeCycle.getCurrentApplication();
+            const oAppInfo = await oCurrentApplication.getInfo(["appIntent"]);
+
+            const sSearchResultAppIntent = Config.last(`${sConfigBasePath}/searchResultAppIntent`);
+            if (UrlParsing.compareHashes(oAppInfo.appIntent, sSearchResultAppIntent).sameIntent) {
+                this.#oModuleAPI.setShowSearchField(true);
+            }
+        }
+
+        /**
+         * Resets the loader by cleaning up the current module instance and re-initializing it.
+         *
+         * @returns {Promise} A promise that resolves when the module instance is destroyed and references are cleared.
+         * @since 1.142.0
+         * @private
+         */
+        async reset () {
+            await this.exit();
+            this.#init();
+        }
+
+        /**
+         * Cleans up the current module instance and clears the API reference.
+         * @returns {Promise} A promise that resolves when the cleanup is complete.
+         * @since 1.142.0
+         * @private
+         */
+        async #cleanup () {
+            if (this.#oModuleInstance) {
+                await this.#oModuleInstance.exit();
+            }
+
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            AppLifeCycle.detachAppLoaded(this.#handleSearchFieldExpandState, this);
+
+            this.#oModuleAPI = null;
+            this.#oModuleInstance = null;
+            this.#pInitialized = Promise.withResolvers();
+        }
+
+        /**
+         * Cleans up the loader by resetting the module instance and calling the superclass exit method.
+         *
+         * @returns {Promise} A promise that resolves when the loader is cleaned up.
+         * @since 1.142.0
+         * @private
+         * @override
+         */
+        async exit () {
+            await super.exit();
+            await this.#cleanup();
+        }
+    }
+    return new SearchLoader();
+});

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

@@ -11,7 +11,7 @@
  * Method Compute is used by ClientSide TargetResolution and takes not only the
  * next application but also the current application into account.
  *
- * @version 1.141.2
+ * @version 1.142.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/FesrEnhancer.js

@@ -60,11 +60,19 @@ sap.ui.define([
     const oFieldFormatting = {
         stepName: {
             maxLength: 20,
-            postfix: "@H2H"
+            postfix: "@H2H",
+            formatter: this.formatStepName
         },
         // appNameLong does not use any prefixes yet
         appNameShort: {
             maxLength: 20
+        },
+        appNameLong: {
+            maxLength: 70,
+            formatter: this.formatAppNameLong
+        },
+        genericField: {
+            formatter: this.shortenByFormatKey
         }
     };
 
@@ -171,6 +179,39 @@ sap.ui.define([
             this._oLastFesrHandle = oFesrHandle;
         },
 
+        /**
+         * Checks and updates the stepName for external navigation from FLP.
+         * If the stepName is "FLP@DEEP_LINK" and the window opener exists,
+         * and the window opener has a ushell config,
+         * the stepName is changed to "FLP@DEEP_LINK:FLP".
+         * If the window opener exists but it is cross-origin, the stepName is changed to "FLP@DEEP_LINK:CORS".
+         * @param {object} oEnhancement The enhancement object to check and update.
+         * @private
+         */
+        _handleExternalNavigationFromFlp: function (oEnhancement) {
+            if (oEnhancement.stepName !== "FLP@DEEP_LINK") {
+                return;
+            }
+            Log.info(`${sLogPrefix} window opener exists: ${!!window.opener}`, null, sModuleName);
+            if (!window.opener) {
+                return;
+            }
+            try {
+                if (window.opener["sap-ushell-config"]) {
+                    Log.info(`${sLogPrefix} Changing Step to FLP@DEEP_LINK:FLP`, null, sModuleName);
+                    oEnhancement.stepName = "FLP@DEEP_LINK:FLP";
+                }
+            } catch (oError) {
+                Log.info(`${sLogPrefix} error:`, oError, sModuleName);
+                if (oError.name === "SecurityError" && oError.message.includes("cross-origin")) {
+                    Log.info(`${sLogPrefix} Changing Step to FLP@DEEP_LINK:CORS`, null, sModuleName);
+                    oEnhancement.stepName = "FLP@DEEP_LINK:CORS";
+                } else {
+                    Log.error(`${sLogPrefix} Unexpected error:`, oError, sModuleName);
+                }
+            }
+        },
+
         /**
          * Hook for {@link sap.ui.performance.trace.FESR#onBeforeCreated} which enhances the "oUi5FesrHandle" with FLP-specific information.
          * The handler will try to detect selected scenarios related to the FLP like open homepage or app to app navigation.
@@ -227,6 +268,7 @@ sap.ui.define([
                 if (START_UP_SCENARIOS.includes(scenario)) {
                     EventHub.emit("startUpFesrEnhanced", Date.now());
                 }
+                this._handleExternalNavigationFromFlp(oEnhancement);
 
                 // Sanitize Enhancements
                 oEnhancement = this.sanitizeEnhancement(oEnhancement);
@@ -245,19 +287,18 @@ sap.ui.define([
         /**
          * Shortens a value according to the formatter ignoring postfix.
          *
-         * @param {string} vValue The value to be shortened
+         * @param {string|int} vValue The value to be shortened
          * @param {object} oFormatter the formatter
          * @returns {string} the shortened value
          *
          * @private
-         * @since 1.121.0
+         * @since 1.141.0
          */
-        shortenAccordingToFormatter: function (vValue, oFormatter) {
+        shortenByFormatter: function (vValue, oFormatter) {
             let sShortenendValue = "";
 
             // shorten if max Length is provided else keep it as it is
-            if (oFormatter && oFormatter.maxLength) {
-                // FLP uses prefixes we want them to be always visible
+            if (oFormatter && oFormatter.maxLength && typeof vValue === "string" && vValue.length > oFormatter.maxLength) {
                 sShortenendValue = vValue.substring(0, oFormatter.maxLength);
             } else {
                 sShortenendValue = vValue;
@@ -266,12 +307,28 @@ sap.ui.define([
         },
 
         /**
-         * Shortens a value at the end according to the formatting key and
+         * Shortens a value according to the format key
+         * ignoring the postfix defined by the respective formatter.
+         * uses a fallback formatter if no formatter is found.
+         * @param {string|int} vValue The value to be shortened.
+         * @param {string} sFormatKey The format key
+         * @returns {string} The shortened value
+         *
+         * @private
+         * @since 1.141.0
+         */
+        shortenByFormatKey: function (vValue, sFormatKey) {
+            const oFormatter = oFieldFormatting[sFormatKey];
+            return this.shortenByFormatter(vValue, oFormatter);
+        },
+
+        /**
+         * Shortens a value at the end according to the format key and
          * does not shorten the postfix
          * which is considered part of the length.
          *
-         * @param {string|int} vValue the Value
-         * @param {string} sFormatKey The formatting key
+         * @param {string|int} vValue The value
+         * @param {string} sFormatKey The format key
          * @param {int} [iModifiedMaxLength=0] The modified max length to be used for shortening
          * @returns {sShortenedValue} The shortened value
          *
@@ -280,31 +337,65 @@ sap.ui.define([
          */
         shortenWithPostfix: function (vValue, sFormatKey, iModifiedMaxLength = 0) {
             const oFormatter = oFieldFormatting[sFormatKey];
-            // if no formatter pass through the value
-            if (oFormatter) {
-                // if no postfix in formatter do simple shortening
-                if (oFormatter.postfix) {
-                    // if no postfix in value do simple shortening
-                    if (vValue.endsWith(oFormatter.postfix)) {
-                        // take away postfix
-                        // do the shortening
-                        // add it again.
-                        const oPostfixFormatter = {
-                            ...oFormatter,
-                            maxLength: oFormatter.maxLength - oFormatter.postfix.length + iModifiedMaxLength
-                        };
-                        // Format the value without postfix
-                        const sShortenedWithoutPostfix = this.shortenAccordingToFormatter(
-                            vValue.slice(0, -1 * oPostfixFormatter.postfix.length),
-                            oPostfixFormatter
-                        );
-                        // return the shortened value with postfix
-                        return sShortenedWithoutPostfix + oPostfixFormatter.postfix;
-                    }
+            // if no postfix in formatter do simple shortening
+            if (oFormatter.postfix) {
+                // if no postfix in value do simple shortening
+                if (vValue.endsWith(oFormatter.postfix)) {
+                    // 1. take away postfix
+                    // 2. do the shortening
+                    // 3. add it again.
+                    const oPostfixFormatter = {
+                        ...oFormatter,
+                        maxLength: oFormatter.maxLength - oFormatter.postfix.length + iModifiedMaxLength
+                    };
+                    // Format the value without postfix
+                    const sShortenedWithoutPostfix = this.shortenByFormatter(
+                        vValue.slice(0, -1 * oPostfixFormatter.postfix.length),
+                        oPostfixFormatter
+                    );
+                    // return the shortened value with postfix
+                    return sShortenedWithoutPostfix + oPostfixFormatter.postfix;
                 }
-                return this.shortenAccordingToFormatter(vValue, oFormatter);
             }
-            return vValue;
+            return this.shortenByFormatKey(vValue, sFormatKey);
+        },
+
+        /**
+         * Shortens a stepName value, handling colon-separated postfix.
+         *
+         * @param {string|int} vValue The value to be shortened
+         * @param {string} sFormatKey The format key to be used for shortening
+         * @returns {string} The shortened value
+         * @private
+         */
+        formatStepName: function (vValue, sFormatKey) {
+            if (typeof vValue === "string" && vValue.includes(":")) {
+                const [sPrefix, sPostfix] = vValue.split(":");
+                return `${oFesrEnhancer.shortenWithPostfix(sPrefix, sFormatKey, -5)}:${sPostfix}`;
+            }
+            return oFesrEnhancer.shortenWithPostfix(vValue, sFormatKey);
+        },
+
+        /**
+         * Shortens an appNameLong value, handling colon-separated space and page.
+         * A space and a page cannot have a colon inside.
+         * Space is shortened to 35 chars, page to 34 chars.
+         *
+         * @param {string|int} vValue The value to be shortened
+         * @param {string} sFormatKey The format key to be used for shortening
+         * @returns {string} The shortened value
+         * @private
+         */
+        formatAppNameLong: function (vValue, sFormatKey) {
+            if (typeof vValue === "string" && vValue.includes(":")) {
+                const [sPrefix, sPostfix] = vValue.split(":");
+                return `${
+                    oFesrEnhancer.shortenByFormatter(sPrefix, {maxLength: 35 })
+                }:${
+                    oFesrEnhancer.shortenByFormatter(sPostfix, {maxLength: 34 })
+                }`;
+            }
+            return oFesrEnhancer.shortenByFormatKey(vValue, sFormatKey);
         },
 
         /**
@@ -321,15 +412,15 @@ sap.ui.define([
         sanitizeValue: function (vValue, sFormatKey) {
             // only keep supported fields and actual values
             if (aSupportedFields.includes(sFormatKey) && vValue) {
-                // shorten if max Length is provided else keep it as it is
-                if (typeof (vValue) === "string" && vValue.includes(":")) {
-                    // strip the postfix and shorten the first part
-                    // and add the second part again.
-                    const [sPrefix, sPostfix] = vValue.split(":");
-                    return `${this.shortenWithPostfix(sPrefix, sFormatKey, -5)}:${sPostfix}`;
+                switch (sFormatKey) {
+                    case "appNameLong":
+                        return this.formatAppNameLong(vValue, sFormatKey);
+                    case "stepName":
+                        return this.formatStepName(vValue, sFormatKey);
+                    default:
+                        // shorten the value according to the formatter
+                        return this.shortenByFormatKey(vValue, sFormatKey);
                 }
-                // shorten the value according to the formatter
-                return this.shortenWithPostfix(vValue, sFormatKey);
             }
         },
 
@@ -414,6 +505,7 @@ sap.ui.define([
          * @private
          */
         _detectScenario: function (oFesrHandle) {
+            Log.debug(`${sLogPrefix} UI5: ${oFesrHandle.stepName} - ${oFesrHandle.appNameShort} - ${oFesrEnhancer.appNameLong}`, null, sModuleName);
             if (oFesrHandle.stepName === "undetermined_startup") {
                 let sDeterminedScenario;
 
@@ -556,6 +648,10 @@ sap.ui.define([
 
             oResult.appNameShort = oRelatedRecord.getTargetAppNameShort() || oRelatedRecord.getTargetApplication();
 
+            // the space and page ID is stored in the appNameLong if available
+            const sSpaceAndPageId = oRelatedRecord.getSpaceAndPageId();
+            oResult.appNameLong = sSpaceAndPageId || oResult.appNameLong;
+
             // Adding TTI for navigating back from direct app start to home
             const oPerformanceMark = this._getRelevantPerformanceMark(oRelatedRecord);
             if (/^FLP_BACK/.test(oResult.stepName) && oPerformanceMark) {

package/src/main/js/sap/ushell/performance/ShellAnalytics.js

@@ -3,7 +3,7 @@
  * @fileOverview Provides analytical data like duration for navigation steps in the shell, in FLP,
  *               in particular an array of all statistical records
  *
- * @version 1.141.2
+ * @version 1.142.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/StatisticalRecord.js

@@ -3,7 +3,7 @@
  * @fileOverview Class for statistical record
  *               It should contain data like step, duration after a navigation in the shell, can have status open.
  *               The closing of a record is logged in debug mode
- * @version 1.141.2
+ * @version 1.142.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -165,6 +165,19 @@ sap.ui.define([
             }
         }
 
+        /**
+         * Getter for source and target application ids
+         * @returns {string} sSpaceAndPageId The space and page id
+         * @since 1.140.0
+         * */
+        getSpaceAndPageId () {
+            const oTargetApplicationData = this.getTargetApplicationData();
+            if (!oTargetApplicationData || !oTargetApplicationData.spaceId || !oTargetApplicationData.pageId) {
+                return "";
+            }
+            return `${oTargetApplicationData.spaceId || ""}:${oTargetApplicationData.pageId || ""}`;
+        }
+
         /**
          * calculates step out of source and target application
          *
@@ -466,9 +479,21 @@ sap.ui.define([
             return sApplicationId && ["FLP_HOME", "FLP_PAGE", "FLP_FINDER"].includes(sApplicationId);
         }
 
+        /**
+         * get for target application data
+         * @returns {object} target application data
+         * @since 1.117.0
+         *
+         */
+        getTargetApplicationData () {
+            return this.#targetApplicationData;
+        }
+
         /**
          * Saves data related to the target application of this StatisticalRecord.
          * @param {object} oData The related data
+         * @param {string} [oData.pageId] The page id, if the target application is a page
+         * @param {string} [oData.spaceId] The space id, if the target application is a page
          */
         enhanceTargetApplicationData (oData) {
             if (this.isClosed() || this.isClosedWithError()) {

package/src/main/js/sap/ushell/plugins/appwarmup/Component.js

@@ -87,7 +87,7 @@ sap.ui.define(
         const sComponentName = "sap.ushell.plugins.appwarmup.Component";
         return Component.extend(sComponentName, {
             metadata: {
-                version: "1.141.2",
+                version: "1.142.0",
                 library: "sap.ushell"
             },
 

package/src/main/js/sap/ushell/plugins/ghostapp/FakeModel.js

@@ -7,22 +7,27 @@ sap.ui.define([
 ) => {
     "use strict";
 
-    const FakeModel = ODataModel.extend("sap.ushell.plugins.ghostapp.FakeModel", {
-        constructor: function (sServiceUrl, mParameters) {
-            ODataModel.apply(this, arguments);
+    const FakeModel = new Proxy(ODataModel, {
+        construct: function (Target, aArgs) {
+            const oModel = new Target(...aArgs);
+            const oModelProxy = new Proxy(oModel, {
+                get: function (oTarget, sProperty) {
+                    if (sProperty === "setDeferredGroups") {
+                        return function () {
+                            ODataModel.prototype.setDeferredGroups.apply(oTarget, arguments);
+                            oTarget.mDeferredGroups.undefined = "undefined";
+                        };
+                    }
+                    return oTarget[sProperty];
+                }
+            });
+
             // set default group as deferred to suppress requests
-            this.setDeferredGroups(["undefined", this.sDefaultChangeGroup]);
-        },
-        // make the default group deferred to prevent outgoing requests
-        // intercept all calls as sap.suite.ui.generic.template sets deferred groups without merging them with already deferred groups
-        setDeferredGroups: function () {
-            ODataModel.prototype.setDeferredGroups.apply(this, arguments);
-            this.mDeferredGroups.undefined = "undefined";
+            oModelProxy.setDeferredGroups(["undefined", oModel.sDefaultChangeGroup]);
+
+            return oModelProxy;
         }
     });
-    // AnalyticalVersionInfo checks for hard-coded model names, thus we return a known one.
-    FakeModel.getMetadata().getName = function () {
-        return "sap.ui.model.odata.v2.ODataModel";
-    };
+
     return FakeModel;
 });

package/src/main/js/sap/ushell/renderer/Renderer.js

@@ -106,9 +106,9 @@ sap.ui.define([
      */
     const Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.141.2",
+            version: "1.142.0",
             dependencies: {
-                version: "1.141.2",
+                version: "1.142.0",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -2083,7 +2083,7 @@ sap.ui.define([
         const oItem = this.createItem(oControlProperties, bCurrentState, (oProperties) => {
             if (Config.last("/core/shellBar/enabled")) {
                 // TODO Move to async import once the infrastructure gets updated with the latest browser version
-                const Button = sap.ui.require("sap/ushell/gen/ui5/webcomponents/dist/Button");
+                const Button = sap.ui.require("sap/f/gen/ui5/webcomponents/dist/Button");
                 oProperties = {
                     ...oProperties,
                     click: oProperties.press
@@ -2303,7 +2303,7 @@ sap.ui.define([
                 delete oProperties.press;
                 delete oProperties.ariaLabel;
                 // TODO Move to async import once the infrastructure gets updated with the latest browser version
-                const ShellBarItem = sap.ui.require("sap/ushell/gen/ui5/webcomponents-fiori/dist/ShellBarItem");
+                const ShellBarItem = sap.ui.require("sap/f/gen/ui5/webcomponents_fiori/dist/ShellBarItem");
                 return new ShellBarItem(oProperties);
             }
             return new ShellHeadItem(oProperties);