@sapui5/sap.ushell 1.139.0 → 1.141.0

package/src/test/js/sap/ushell/bootstrap/sandbox.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's bootstrap code for development sandbox scenarios.
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 
 (function () {
@@ -11,33 +11,22 @@
     window.sap = window.sap || {};
     window.sap.ushell = window.sap.ushell || {};
     window.sap.ushell.__sandbox__ = window.sap.ushell.__sandbox__ || {};
-    window.sap.ushell.__sandbox__.init = init;
-
-
-    // ushell bootstrap is registered as sapui5 boot task; would not be required for the sandbox case, but we stick to the ABAP pattern for consistency
-    // on ABAP, this is required, because some ui5 settings (e.g. theme) are retrieved from the back-end and have to be set early in the ui5 bootstrap
-    window["sap-ui-config"] = {
-        "xx-bootTask": function (fnCallback) {
-            init().then(function (bootstrap) {
-                bootstrap(fnCallback);
-            });
-        }
-    };
 
     function init () {
-        return new Promise(function (resolve) {
-
+        return new Promise((resolve) => {
             sap.ui.require([
                 "sap/base/Log",
+                "sap/ui/thirdparty/jquery",
                 "sap/base/util/ObjectPath",
                 "sap/ushell/bootstrap/common/common.util",
                 "sap/ushell/utils"
-            ], function (
+            ], (
                 Log,
+                jQuery,
                 ObjectPath,
                 commonUtils,
                 ushellUtils
-            ) {
+            ) => {
                 /*
                  * Function copied from boottask.js
                  * The original function could be moved to sap.ushell_abap.pbServices.ui2.Utils
@@ -49,7 +38,7 @@
                         return;
                     }
 
-                    Object.keys(oActualConfigToMerge).forEach(function (sKey) {
+                    Object.keys(oActualConfigToMerge).forEach((sKey) => {
                         if (Object.prototype.toString.apply(oMutatedBaseConfig[sKey]) === "[object Object]" &&
                             Object.prototype.toString.apply(oActualConfigToMerge[sKey]) === "[object Object]") {
                             mergeConfig(oMutatedBaseConfig[sKey], oActualConfigToMerge[sKey], false);
@@ -75,8 +64,8 @@
                     const oApplicationConfig = {};
 
                     function getApplicationKeys (oCfg) {
-                        var aAppKeys = [],
-                            sApplicationKey;
+                        const aAppKeys = [];
+                        let sApplicationKey;
 
                         if (!oCfg || !oCfg.applications || typeof oCfg.applications !== "object") {
                             return aAppKeys;
@@ -94,9 +83,9 @@
                     }
 
                     function createTile (oApplication, iIdSuffix, sKey) {
-                        var sApplicationTitle = oApplication.title || oApplication.additionalInformation.replace("SAPUI5.Component=", "").split(".").pop();
+                        const sApplicationTitle = oApplication.title || oApplication.additionalInformation.replace("SAPUI5.Component=", "").split(".").pop();
                         return {
-                            id: "sap_ushell_generated_tile_id_" + iIdSuffix,
+                            id: `sap_ushell_generated_tile_id_${iIdSuffix}`,
                             title: sApplicationTitle,
                             size: "1x1",
                             tileType: "sap.ushell.ui.tile.StaticTile",
@@ -104,7 +93,7 @@
                                 chipId: "sap_ushell_generated_chip_id",
                                 title: sApplicationTitle,
                                 info: oApplication.description,
-                                targetURL: "#" + sKey
+                                targetURL: `#${sKey}`
                             }
                         };
                     }
@@ -129,7 +118,7 @@
                         oLaunchPageAdapterConfig.groups.unshift(oAutoGeneratedGroup);
 
                         // generate the tile
-                        aApplicationKeys.forEach(function (sApplicationKey, iSuffix) {
+                        aApplicationKeys.forEach((sApplicationKey, iSuffix) => {
                             oAutoGeneratedGroup.tiles.push(
                                 createTile(oUshellConfig.applications[sApplicationKey], iSuffix, sApplicationKey)
                             );
@@ -147,21 +136,54 @@
                     return oUshellConfig;
                 }
 
+                /**
+                 * Get the path of our own script; module paths are registered relative to this path, not
+                 * relative to the HTML page we introduce an ID for the bootstrap script, similar to UI5;
+                 * allows to reference it later as well
+                 * @returns {string} path of the bootstrap script
+                 */
+                function getBootstrapScriptPath () {
+                    let oScripts;
+                    let oBootstrapScript;
+                    oBootstrapScript = window.document.getElementById("sap-ushell-bootstrap");
+                    if (!oBootstrapScript) {
+                        // fallback to last script element, if no ID set (should work on most browsers)
+                        // it might happen that script tags are loaded lazily and are not available yet at this point
+                        oScripts = window.document.getElementsByTagName("script");
+                        oBootstrapScript = oScripts[oScripts.length - 1];
+                    }
+                    const sBootstrapScriptUrl = oBootstrapScript.src;
+                    const sBootstrapScriptPath = `${sBootstrapScriptUrl.split("?")[0].split("/").slice(0, -1).join("/")}/`;
+                    return sBootstrapScriptPath;
+                }
+
                 /**
                  * Read a new JSON application config defined by its URL and merge into
                  * provided config.
                  * @param {object} oUshellConfig The ushell config
                  */
                 function applyDefaultApplicationConfig (oUshellConfig) {
-                    var sUrl = getBootstrapScriptPath() + "../shells/sandbox/fioriSandboxConfig.json";
+                    const sUrl = `${getBootstrapScriptPath()}../shells/sandbox/fioriSandboxConfig.json`;
+
+                    function adaptInboundUrl (data) {
+                        const oInbounds = data.services.ClientSideTargetResolution.adapter.config.inbounds;
+                        const sBasePath = sap.ui.require.toUrl("").substring(0, sap.ui.require.toUrl("").indexOf("resources"));
+                        let sInboundUrl;
+                        Object.keys(oInbounds).forEach((sKey) => {
+                            sInboundUrl = oInbounds[sKey].resolutionResult.url;
+                            sInboundUrl = sBasePath + sInboundUrl;
+                            oInbounds[sKey].resolutionResult.url = sInboundUrl;
+                        });
+                        return data;
+                    }
 
-                    Log.info("Mixing/Overwriting sandbox configuration from " + sUrl + ".");
+                    Log.info(`Mixing/Overwriting sandbox configuration from ${sUrl}.`);
                     jQuery.ajax({
                         async: false,
                         url: sUrl,
                         dataType: "json",
                         success: function (data) {
-                            Log.debug("Evaluating fiori launchpad sandbox config JSON: " + JSON.stringify(data));
+                            Log.debug(`Evaluating fiori launchpad sandbox config JSON: ${JSON.stringify(data)}`);
 
                             const oDefaultApplicationConfig = adaptInboundUrl(data);
                             const oDefaultApplicationMigration = commonUtils.getV2ServiceMigrationConfig(oDefaultApplicationConfig);
@@ -171,22 +193,10 @@
                         },
                         error: function (xhr) {
                             if (xhr.status !== 404) {
-                                Log.error("Failed to load Fiori Launchpad Sandbox configuration from " + sUrl + ": status: " + xhr.status + "; error: " + xhr.statusText);
+                                Log.error(`Failed to load Fiori Launchpad Sandbox configuration from ${sUrl}: status: ${xhr.status}; error: ${xhr.statusText}`);
                             }
                         }
                     });
-
-                    function adaptInboundUrl (data) {
-                        var oInbounds = data.services.ClientSideTargetResolution.adapter.config.inbounds,
-                            sBasePath = sap.ui.require.toUrl("").substring(0, sap.ui.require.toUrl("").indexOf("resources")),
-                            sInboundUrl;
-                        Object.keys(oInbounds).forEach(function (sKey) {
-                            sInboundUrl = oInbounds[sKey].resolutionResult.url;
-                            sInboundUrl = sBasePath + sInboundUrl;
-                            oInbounds[sKey].resolutionResult.url = sInboundUrl;
-                        });
-                        return data;
-                    }
                 }
 
                 /**
@@ -197,15 +207,15 @@
                  * @param {object} oUshellConfig The ushell config
                  */
                 function applyJsonApplicationConfig (sUrlPrefix, oUshellConfig) {
-                    var sUrl = /\.json/i.test(sUrlPrefix) ? sUrlPrefix : sUrlPrefix + ".json";
+                    const sUrl = /\.json/i.test(sUrlPrefix) ? sUrlPrefix : `${sUrlPrefix}.json`;
 
-                    Log.info("Mixing/Overwriting sandbox configuration from " + sUrl + ".");
+                    Log.info(`Mixing/Overwriting sandbox configuration from ${sUrl}.`);
                     jQuery.ajax({
                         async: false,
                         url: sUrl,
                         dataType: "json",
                         success: function (data) {
-                            Log.debug("Evaluating fiori launchpad sandbox config JSON: " + JSON.stringify(data));
+                            Log.debug(`Evaluating fiori launchpad sandbox config JSON: ${JSON.stringify(data)}`);
 
                             const oConfigMigration = commonUtils.getV2ServiceMigrationConfig(data);
 
@@ -214,32 +224,12 @@
                         },
                         error: function (xhr) {
                             if (xhr.status !== 404) {
-                                Log.error("Failed to load Fiori Launchpad Sandbox configuration from " + sUrl + ": status: " + xhr.status + "; error: " + xhr.statusText);
+                                Log.error(`Failed to load Fiori Launchpad Sandbox configuration from ${sUrl}: status: ${xhr.status}; error: ${xhr.statusText}`);
                             }
                         }
                     });
                 }
 
-                /**
-                 * Get the path of our own script; module paths are registered relative to this path, not
-                 * relative to the HTML page we introduce an ID for the bootstrap script, similar to UI5;
-                 * allows to reference it later as well
-                 * @returns {string} path of the bootstrap script
-                 */
-                function getBootstrapScriptPath () {
-                    var oScripts, oBootstrapScript, sBootstrapScriptUrl, sBootstrapScriptPath;
-                    oBootstrapScript = window.document.getElementById("sap-ushell-bootstrap");
-                    if (!oBootstrapScript) {
-                        // fallback to last script element, if no ID set (should work on most browsers)
-                        // it might happen that script tags are loaded lazily and are not available yet at this point
-                        oScripts = window.document.getElementsByTagName("script");
-                        oBootstrapScript = oScripts[oScripts.length - 1];
-                    }
-                    sBootstrapScriptUrl = oBootstrapScript.src;
-                    sBootstrapScriptPath = sBootstrapScriptUrl.split("?")[0].split("/").slice(0, -1).join("/") + "/";
-                    return sBootstrapScriptPath;
-                }
-
                 /*
                  * The config needs to be adjusted depending on the renderer specified in the URL parameter
                  * sap-ushell-sandbox-renderer. We have to make sure that no navigation target "" is defined
@@ -248,7 +238,7 @@
                  * in the configuration.
                  */
                 function evaluateCustomRenderer (sRenderer, oUshellConfig) {
-                    var oApplications;
+                    let oApplications;
 
                     if (typeof sRenderer === "string" && sRenderer !== "") {
                         oUshellConfig.defaultRenderer = sRenderer;
@@ -265,7 +255,6 @@
                     }
                 }
 
-
                 /*
                  * Perform sandbox bootstrap of local platform. The promise will make sure to call the UI5
                  * callback in case of success.
@@ -277,7 +266,7 @@
 
                     sap.ui.loader.config({
                         paths: {
-                            "sap/ushell/renderers/fiorisandbox": getBootstrapScriptPath() + "../renderers/fiorisandbox/"
+                            "sap/ushell/renderers/fiorisandbox": `${getBootstrapScriptPath()}../renderers/fiorisandbox/`
                         }
                     });
 
@@ -328,7 +317,7 @@
                     ObjectPath.set("services.ClientSideTargetResolution.adapter.config.applications", oApplications, oUshellConfig);
 
                     if (oUshellConfig && oUshellConfig.modulePaths) {
-                        var oModules = Object.keys(oUshellConfig.modulePaths).reduce(function (result, sModulePath) {
+                        const oModules = Object.keys(oUshellConfig.modulePaths).reduce((result, sModulePath) => {
                             result[sModulePath.replace(/\./g, "/")] = oUshellConfig.modulePaths[sModulePath];
                             return result;
                         }, {});
@@ -346,15 +335,25 @@
 
                 // Attach private functions which should be testable to the public namespace
                 // to make them available outside for testing.
-                var oSandbox = ObjectPath.get("sap.ushell.__sandbox__");
+                const oSandbox = ObjectPath.get("sap.ushell.__sandbox__");
                 oSandbox._adjustApplicationConfiguration = adjustApplicationConfiguration;
                 oSandbox._applyJsonApplicationConfig = applyJsonApplicationConfig;
                 oSandbox._evaluateCustomRenderer = evaluateCustomRenderer;
                 oSandbox._bootstrap = bootstrap;
 
-
                 resolve(bootstrap);
             });
         });
     }
+    window.sap.ushell.__sandbox__.init = init;
+
+    // ushell bootstrap is registered as sapui5 boot task; would not be required for the sandbox case, but we stick to the ABAP pattern for consistency
+    // on ABAP, this is required, because some ui5 settings (e.g. theme) are retrieved from the back-end and have to be set early in the ui5 bootstrap
+    window["sap-ui-config"] = {
+        "xx-bootTask": function (fnCallback) {
+            init().then((bootstrap) => {
+                bootstrap(fnCallback);
+            });
+        }
+    };
 }());

package/ui5.yaml

@@ -37,6 +37,27 @@ framework:
       optional: true
 builder:
   bundles:
+    - bundleDefinition:
+        name: sap/ushell/preload-bundles/flex-plugins.js
+        sections:
+          - mode: preload
+            name: sap/ushell/preload-bundles/flex-plugins
+            filters: &preload-flex-plugins
+              - sap/ushell/plugins/BaseRTAPlugin.js # base component class
+              - sap/ushell/appRuntime/ui5/plugins/baseRta/ # reuse files
+              # components are bundled via Component-preload any deps are loaded via this bundle
+              #   - sap/ushell/appRuntime/ui5/plugins/rtaAgent/
+              #   - sap/ushell/appRuntime/ui5/plugins/rtaShell/
+              #   - sap/ushell/plugins/rta/
+              #   - sap/ushell/plugins/rta-personalize/
+              # the related bundle infos have to be maintained for all scenarios in all repos:
+              #   - ushell
+              #   - ushell_abap
+              #   - sap/fiori
+            resolve: false
+      bundleOptions:
+        optimize: true
+        usePredefineCalls: true
     - bundleDefinition:
         name: sap/ushell/bootstrap/appruntime-min.js
         sections:
@@ -46,6 +67,10 @@ builder:
             declareRawModules: false
             resolve: true
             sort: true
+          - mode: bundleInfo
+            name: sap/ushell/preload-bundles/flex-plugins.js
+            filters: *preload-flex-plugins
+            resolve: false
           - mode: preload
             filters:
               - sap/ui/core/Core.js
@@ -54,7 +79,7 @@ builder:
             resolveConditional: false
           - mode: preload
             name: sap/ushell/core-lib111-preload
-            filters:
+            filters: &appruntime-preload
               - sap/ushell/appRuntime/ui5/
               - sap/ushell/appRuntime/ui5/AppRuntimeDefaultConfiguration.json
               - sap/ushell/ui5service/UserStatus.js
@@ -97,6 +122,9 @@ builder:
               - sap/ushell/Fiori20Adapter.js
               - sap/ui/core/Core.js
               - '!sap/viz/libs/sap-viz.js'
+              - '!sap/ushell/appRuntime/ui5/plugins/baseRta/'
+              - '!sap/ushell/appRuntime/ui5/plugins/rtaAgent/'
+              - '!sap/ushell/appRuntime/ui5/plugins/rtaShell/'
             resolve: true
             renderer: true
           - mode: require
@@ -179,6 +207,10 @@ builder:
               - sap/ushell/bootstrap/cdm/cdm-def.js
               - sap/ushell/bootstrap/ui5loader-config.js
             resolve: true
+          - mode: bundleInfo
+            name: sap/ushell/preload-bundles/flex-plugins.js
+            filters: *preload-flex-plugins
+            resolve: false
           - mode: preload
             name: sap/ushell/core-lib-preload
             filters: &core-min-preload
@@ -447,21 +479,6 @@ builder:
         optimize: true
         usePredefineCalls: true
         numberOfParts: 4
-    - bundleDefinition:
-        name: sap/ushell/preload-bundles/flex-plugins.js
-        sections:
-          - mode: provided
-            filters: *core-min-preload
-            resolve: true
-          - mode: preload
-            filters:
-              - sap/ushell/appRuntime/ui5/plugins/baseRta/
-              - sap/ushell/appRuntime/ui5/plugins/rtaAgent/
-              - sap/ushell/appRuntime/ui5/plugins/rtaShell/
-              - sap/ushell/plugins/rta/
-              - sap/ushell/plugins/rta-personalize/
-              - sap/ushell/plugins/BaseRtaPlugin.js
-            renderer: false
     - bundleDefinition:
         name: sap/ushell/preload-bundles/homepage-af-dep.js
         sections:
@@ -624,5 +641,9 @@ builder:
       - sap/ushell/components/workPageRuntime/Component.js
       - sap/ushell/plugins/appwarmup/Component.js
       - sap/ushell/plugins/ghostapp/Component.js
+      # dependencies are covered by the flex-plugins bundle
+      - sap/ushell/appRuntime/ui5/plugins/rtaAgent/Component.js
+      - sap/ushell/appRuntime/ui5/plugins/rtaShell/Component.js
       - sap/ushell/plugins/rta/Component.js
       - sap/ushell/renderer/rendererTargetWrapper/Component.js
+      - sap/ushell/plugins/rta-personalize/Component.js

package/src/main/js/sap/ushell/appIntegration/PostMessageManager/AppruntimeHandler.js

@@ -1,121 +0,0 @@
-// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
-/**
- * @file This file contains the AppruntimeHandler class.
- */
-sap.ui.define([
-    "sap/base/Log",
-    "sap/ui/thirdparty/hasher",
-    "sap/ushell/appIntegration/PostMessageManager",
-    "sap/ushell/Container"
-], (
-    Log,
-    hasher,
-    PostMessageManager,
-    Container
-) => {
-    "use strict";
-
-    const oDistributionPolicies = {
-        "sap.ushell.appRuntime.keepAliveAppHide": {
-            preventBroadcast: true,
-            ignoreCapabilities: true
-        },
-        "sap.ushell.appRuntime.keepAliveAppShow": {
-            preventBroadcast: true,
-            ignoreCapabilities: true
-        },
-        "sap.ushell.sessionHandler.beforeApplicationHide": {
-            preventBroadcast: true,
-            ignoreCapabilities: true
-        },
-        "sap.ushell.sessionHandler.afterApplicationShow": {
-            preventBroadcast: true,
-            ignoreCapabilities: true
-        },
-
-        "sap.ushell.appRuntime.innerAppRouteChange": {
-            onlyCurrentApplication: true,
-            ignoreCapabilities: true
-        },
-        "sap.ushell.appRuntime.hashChange": {
-            onlyCurrentApplication: true,
-            ignoreCapabilities: true
-        },
-
-        "sap.ushell.appRuntime.themeChange": {
-            ignoreCapabilities: true
-        },
-        "sap.ushell.appRuntime.uiDensityChange": {
-            ignoreCapabilities: true
-        }
-    };
-
-    const oServiceRequestHandlers = {
-        "sap.ushell.appRuntime.hashChange": {
-            async handler (oMessageBody, oMessageEvent) {
-                const { newHash, direction } = oMessageBody;
-
-                // FIX for internal incident #1980317281 - In general, hash structure in FLP is splitted into 3 parts:
-                // A - application identification & B - Application parameters & C - Internal application area
-                // Now, when an IFrame changes its hash, it sends PostMessage up to the FLP. The FLP does 2 things: Change its URL
-                // and send a PostMessage back to the IFrame. This fix instruct the Shell.Controller.js to block only
-                // the message back to the IFrame.
-                hasher.disableBlueBoxHashChangeTrigger = true;
-                hasher.replaceHash(newHash);
-                hasher.disableBlueBoxHashChangeTrigger = false;
-
-                // Getting the history direction, taken from the history object of UI5 (sent by the Iframe).
-                // The direction value is used to update the direction property of the UI5 history object
-                // that is running in the Iframe.
-                if (direction) {
-                    const ShellNavigationInternal = await Container.getServiceAsync("ShellNavigationInternal");
-                    ShellNavigationInternal.hashChanger.fireEvent(
-                        "hashReplaced",
-                        {
-                            hash: ShellNavigationInternal.hashChanger.getHash(),
-                            direction: direction
-                        }
-                    );
-                    Log.debug(`PostMessageAPI.hashChange :: Informed by the Iframe, to change the History direction property in FLP to: ${direction}`);
-                }
-            }
-        },
-        "sap.ushell.appRuntime.iframeIsValid": {
-            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
-                oApplicationContainer.setIsIframeValidTime({ time: new Date().getTime() });
-            },
-            options: {
-                provideApplicationContext: true,
-                allowInactive: true
-            }
-        },
-        "sap.ushell.appRuntime.iframeIsBusy": {
-            async handler (oMessageBody, oMessageEvent) {
-                // deprecated since 1.118 and not used anymore
-            }
-        },
-        "sap.ushell.appRuntime.isInvalidIframe": {
-            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
-                oApplicationContainer.setIsInvalidIframe(oMessageBody.bValue);
-            },
-            options: {
-                provideApplicationContext: true,
-                allowInactive: true
-            }
-        }
-    };
-
-    return {
-        register () {
-            Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {
-                const oDistributionPolicy = oDistributionPolicies[sServiceRequest];
-                PostMessageManager.setDistributionPolicy(sServiceRequest, oDistributionPolicy);
-            });
-
-            Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {
-                const oHandler = oServiceRequestHandlers[sServiceRequest];
-                PostMessageManager.setRequestHandler(sServiceRequest, oHandler.handler, oHandler.options);
-            });
-        }
-    };
-});