@sapui5/sap.ushell_abap 1.148.1 → 1.149.0

package/src/main/js/sap/ushell_abap/bootstrap/DirectAppStart.js

@@ -1,39 +1,63 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+/**
+ * @fileoverview This module handles the direct start of an application.
+ */
 sap.ui.define([
     "sap/base/Log",
     "sap/base/util/ObjectPath",
     "sap/ushell_abap/bootstrap/StartupRequestHandler",
-    "sap/ushell/bootstrap/Config",
     "sap/ushell/base/promisify",
     "sap/ushell/base/requireAsync",
-    "sap/ushell/base/UrlParsing"
+    "sap/ushell/base/UrlParsing",
+    "sap/ushell/bootstrap/Config"
 ], (
     Log,
     ObjectPath,
     StartupRequestHandler,
-    BootstrapConfig,
     promisify,
     requireAsync,
-    UrlParsing
+    UrlParsing,
+    BootstrapConfig
 ) => {
     "use strict";
 
+    /**
+     * @alias sap.ushell_abap.bootstrap.DirectAppStart
+     * @namespace
+     * @description This module handles the direct start of an application by preloading necessary resources and starting the app.
+     *
+     * @since 1.147.0
+     * @private
+     */
     class DirectAppStart {
         #aInternTargets = [
             "#Shell-home",
             "#Launchpad-openFLPPage",
             "#Shell-appfinder",
-            "#Shell-catalog",
-            "#shell-catalog",
             "#Action-search"
         ];
 
+        /**
+         * Checks whether conditions apply for this module.
+         * @returns {boolean} True if this module is relevant and should be executed, false otherwise.
+         *
+         * @since 1.147.0
+         * @private
+         */
         #isRelevant () {
             const sHash = this.#getFullHash();
 
             return sHash !== "#" && !this.#aInternTargets.some((sTarget) => sHash.startsWith(sTarget));
         }
 
+        /**
+         * Prepares the direct app start by preloading target mappings and app states for the application to be started directly.
+         * This is safe to be called during the boot process.
+         * @returns {Promise<undefined>} A promise that resolves when the preparation is complete.
+         *
+         * @since 1.147.0
+         * @private
+         */
         async prepare () {
             const oUshellConfig = BootstrapConfig.get();
 
@@ -113,6 +137,14 @@ sap.ui.define([
             ]);
         }
 
+        /**
+         * Starts the application directly based on the current hash.
+         * This is NOT safe to be called during the boot process.
+         * @returns {Promise<undefined>} A promise that resolves when the start is complete.
+         *
+         * @since 1.147.0
+         * @private
+         */
         async startApp () {
             if (!this.#isRelevant()) {
                 return;
@@ -123,6 +155,17 @@ sap.ui.define([
             await window["sap-ushell-async-libs-promise-directstart"];
         }
 
+        /**
+         * Starts the application directly based on the current hash.
+         * This is NOT safe to be called during the boot process.
+         *
+         * Handles the dynamic resolution of the ssb evaluation id.
+         * It triggers the start of the application as early as possible which should allow for early dependency loading by UI5.
+         * @returns {Promise<{resolvedHashFragment: object}>} An object containing the resolved hash fragment for the direct start.
+         *
+         * @since 1.147.0
+         * @private
+         */
         async #startApp () {
             let sHash = this.#getFullHash();
             if (sHash.includes("sap-ssb-eval-id")) {
@@ -150,15 +193,13 @@ sap.ui.define([
                 );
 
                 return {
-                    resolvedHashFragment: oResolvedHashFragmentWithComponentHandle,
-                    dependenciesLoaded: true
+                    resolvedHashFragment: oResolvedHashFragmentWithComponentHandle
                 };
             }
 
             // non-ui5 app
             return {
-                resolvedHashFragment: oResolvedHashFragment,
-                dependenciesLoaded: false
+                resolvedHashFragment: oResolvedHashFragment
             };
         }
 
@@ -167,6 +208,9 @@ sap.ui.define([
          * resolved by Smart Business early so that the resolved parameters are already
          * passed to the app component during the early component creation.
          * @param {string} sHash the current hash
+         *
+         * @since 1.147.0
+         * @private
          */
         async #resolveEvalId (sHash) {
             const [SmartBusiness] = await requireAsync(["sap/ushell/utils/SmartBusiness"]);
@@ -190,6 +234,8 @@ sap.ui.define([
          * This method must only be called after the shell bootstrap!
          * @param {sap.ushell.Container} Container The shell container instance
          * @returns {Promise} A promise to chain following steps.
+         *
+         * @since 1.147.0
          * @private
          */
         async #createWaitForRendererCreatedPromise (Container) {
@@ -215,6 +261,13 @@ sap.ui.define([
             return oDeferred.promise;
         }
 
+        /**
+         * Prepares the hash to be used for the UrlParsing utilities.
+         * @returns {string} The full hash including the "#" prefix.
+         *
+         * @since 1.147.0
+         * @private
+         */
         #getFullHash () {
             const sHash = this.getLocationHash();
             const sSanitizedHash = sHash.startsWith("#") ? sHash : `#${sHash}`;
@@ -222,6 +275,14 @@ sap.ui.define([
             return decodeURI(sSanitizedHash);
         }
 
+        /**
+         * Returns the window.location.hash string.
+         * Extracted as a method to allow stubbing in tests.
+         * @returns {string} The hash portion of the URL
+         *
+         * @since 1.147.0
+         * @private
+         */
         getLocationHash () {
             return window.location.hash;
         }

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad/CreateRenderer.js

@@ -1,13 +1,16 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+/**
+ * @fileoverview This module provides a function for creating and placing the renderer.
+ */
 sap.ui.define([
     "sap/ushell/Container",
-    "sap/ushell/state/StateManager",
     "sap/ushell/renderer/ShellLayout",
+    "sap/ushell/state/StateManager",
     "sap/ushell/ui/shell/SysInfoBar"
 ], (
     Container,
-    StateManager,
     ShellLayout,
+    StateManager,
     SysInfoBar
 ) => {
     "use strict";
@@ -15,7 +18,23 @@ sap.ui.define([
     // shortcut for sap.ushell.state.StateManager.ShellMode
     const ShellMode = StateManager.ShellMode;
 
+    /**
+     * @alias sap.ushell_abap.bootstrap.LoadLaunchpad.CreateRenderer
+     * @namespace
+     * @description This module is responsible for creating and placing the renderer.
+     * It shall only be called AFTER the the bootstrap is done and the core is ready.
+     *
+     * @since 1.147.0
+     * @private
+     */
     class CreateRenderer {
+        /**
+         * Creates the renderer and places it into the DOM.
+         * @returns {Promise<undefined>} Resolves when the renderer is created and placed
+         *
+         * @since 1.147.0
+         * @private
+         */
         async run () {
             const oRenderer = await Container.createRendererInternal("fiori2");
             oRenderer.placeAt("canvas", "only");

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad/InitXhrLogon.js

@@ -1,20 +1,38 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+/**
+ * @fileoverview This module initializes the XHR logon for the ABAP launchpad.
+ */
 sap.ui.define([
-    "sap/ushell_abap/bootstrap/XhrLogonLibLoader", // triggers loading of the XHR logon lib, once required
-    "sap/ushell_abap/bootstrap/XhrLogonEventHandler",
-    "sap/ushell/bootstrap/Config",
     "sap/base/Log",
-    "sap/ushell/Container"
+    "sap/ushell_abap/bootstrap/XhrLogonEventHandler",
+    "sap/ushell_abap/bootstrap/XhrLogonLibLoader",
+    "sap/ushell/Container",
+    "sap/ushell/Config"
 ], (
-    XhrLogonLibLoader,
-    XhrLogonEventHandler,
-    BootstrapConfig,
     Log,
-    Container
+    XhrLogonEventHandler,
+    XhrLogonLibLoader,
+    Container,
+    Config
 ) => {
     "use strict";
 
+    /**
+     * @alias sap.ushell_abap.bootstrap.LoadLaunchpad.InitXhrLogon
+     * @namespace
+     * @description This module initializes the XHR logon for the ABAP launchpad.
+     * It is called during the oninit phase as it is not critical for the startup of the FLP.
+     *
+     * @since 1.147.0
+     * @private
+     */
     class InitXhrLogon {
+        /**
+         * Initializes the XHR logon
+         *
+         * @since 1.147.0
+         * @private
+         */
         async run () {
             await Promise.all([
                 this.#initXhrLogon(),
@@ -26,9 +44,12 @@ sap.ui.define([
          * Determines the XHR logon mode based on the bootstrap configuration
          * and the URL parameters sap-ushell-xhrLogon-mode and saml2.
          * @returns {string} the logon mode
+         *
+         * @since 1.147.0
+         * @private
          */
         #getLogonMode () {
-            const oUshellConfig = BootstrapConfig.get();
+            const oUshellConfig = Config.getRawBootstrapConfig();
             const sSearch = this.getWindowLocationSearch();
             const oUrlParameters = new URLSearchParams(sSearch);
 
@@ -40,8 +61,8 @@ sap.ui.define([
 
         /**
          * Initializes and starts XHR logon lib based on a given configuration.
-         * <p>
          *
+         * @since 1.147.0
          * @private
          */
         async #initXhrLogon () {
@@ -70,6 +91,13 @@ sap.ui.define([
             this.#initXhrLogonIgnoreList(oXHRLogonManager);
         }
 
+        /**
+         * Initializes the XHR logon lib by storing the instance of the logon manager in the Container.
+         * This is later used to have indirect access to the logon manager.
+         *
+         * @since 1.147.0
+         * @private
+         */
         async #initFrameLogonManager () {
             const oXhrLogonLib = await XhrLogonLibLoader.getLib();
             const oFrameLogonManager = oXhrLogonLib.FrameLogonManager.getInstance();
@@ -77,12 +105,10 @@ sap.ui.define([
         }
 
         /**
-         * Creates a logger for XMLHttpRequest(s) that logs errors, warnings, info
-         * and debug messages via Log.
-         *
-         * @returns {object}
-         *    A logger that can be assigned to XMLHttpRequest.
+         * Creates a logger for XMLHttpRequest(s) that logs errors, warnings, info and debug messages via Log.
+         * @returns {object} A logger that can be assigned to XMLHttpRequest.
          *
+         * @since 1.147.0
          * @private
          */
         #createUi5ConnectedXhrLogger () {
@@ -96,15 +122,13 @@ sap.ui.define([
 
         /**
          * Initializes the ignore list of the XHR logon manager.
-         * <p>
          * If the UI5 resources (including the own bootstrap script) are loaded from an absolute URL
          * (in case CDN is activated),
          * this URL is added to the ignore list to prevent CORS preflight requests due to the X headers.
          * We expect that all resources can be loaded without authentication in this case.
+         * @param {object} oXHRLogonManager the logon frame manager instance to use
          *
-         * @param {object} oXHRLogonManager
-         *     the logon frame manager instance to use
-         *
+         * @since 1.147.0
          * @private
          */
         #initXhrLogonIgnoreList (oXHRLogonManager) {
@@ -135,10 +159,26 @@ sap.ui.define([
             return new XhrLogonEventHandler(oWindow, sXhrLogonMode);
         }
 
+        /**
+         * Returns the window.location.search string.
+         * Extracted as a method to allow stubbing in tests.
+         * @returns {string} The query string portion of the URL
+         *
+         * @since 1.147.0
+         * @private
+         */
         getWindowLocationSearch () {
             return window.location.search;
         }
 
+        /**
+         * Returns the window.location.origin string.
+         * Extracted as a method to allow stubbing in tests.
+         * @returns {string} The origin portion of the URL
+         *
+         * @since 1.147.0
+         * @private
+         */
         getLocationOrigin () {
             return window.location.origin;
         }

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad/RequestPages.js

@@ -1,27 +1,48 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+/**
+ * @fileoverview This module is responsible for requesting the launchpad page content.
+ */
 sap.ui.define([
     "sap/base/util/ObjectPath",
-    "sap/ushell/bootstrap/Config",
-    "sap/ushell/Container",
     "sap/ushell/components/pages/controller/PagesAndSpaceId",
+    "sap/ushell/Config",
+    "sap/ushell/Container",
     "sap/ushell/resources"
 ], (
     ObjectPath,
-    BootstrapConfig,
-    Container,
     PagesAndSpaceId,
+    Config,
+    Container,
     ushellResources
 ) => {
     "use strict";
 
+    /**
+     * @alias sap.ushell_abap.bootstrap.LoadLaunchpad.RequestPages
+     * @namespace
+     * @description This module is responsible for requesting the launchpad page content.
+     * It fetches the page data of the current page and the personalization.
+     *
+     * Shall NOT be called before the bootstrap is done and the core is ready, as it relies on the ushell services.
+     *
+     * @since 1.147.0
+     * @private
+     */
     class RequestPages {
         #aInternTargets = [
             "Shell-home",
             "Launchpad-openFLPPage"
         ];
 
+        /**
+         * Checks whether conditions apply for this module.
+         * @returns {boolean} True if this module is relevant and should be executed, false otherwise.
+         *
+         * @since 1.147.0
+         * @private
+         */
         #isRelevant () {
-            const oUshellConfig = BootstrapConfig.get();
+            const oUshellConfig = Config.getRawBootstrapConfig();
             if (!ObjectPath.get("ushell.spaces.enabled", oUshellConfig)) {
                 return false;
             }
@@ -32,6 +53,14 @@ sap.ui.define([
             return !sHash || this.#aInternTargets.some((sTarget) => sHash.startsWith(sTarget));
         }
 
+        /**
+         * Executes the module.
+         * It fetches the page data of the current page and the personalization.
+         * @returns {Promise<undefined>} A promise that resolves when the requests are done
+         *
+         * @since 1.147.0
+         * @private
+         */
         async run () {
             if (!this.#isRelevant()) {
                 return;
@@ -43,6 +72,13 @@ sap.ui.define([
             ]);
         }
 
+        /**
+         * Requests the personalization data for the pages.
+         * @returns {Promise<undefined>} A promise that resolves when the personalization data is fetched
+         *
+         * @since 1.147.0
+         * @private
+         */
         async #requestPagesPersonalization () {
             const PersonalizationV2 = await Container.getServiceAsync("PersonalizationV2");
             const oPersId = {
@@ -60,6 +96,13 @@ sap.ui.define([
             return oPersonalizer.getPersData();
         }
 
+        /**
+         * Requests the page content for the current page.
+         * @returns {Promise<undefined>} A promise that resolves when the page content is fetched
+         *
+         * @since 1.147.0
+         * @private
+         */
         async #requestPagesContent () {
             await ushellResources.awaitResourceBundle();
 
@@ -77,6 +120,14 @@ sap.ui.define([
             await PagePersistence.getPage(oIds.pageId);
         }
 
+        /**
+         * Returns the window.location.hash string.
+         * Extracted as a method to allow stubbing in tests.
+         * @returns {string} The hash portion of the URL
+         *
+         * @since 1.147.0
+         * @private
+         */
         getLocationHash () {
             return window.location.hash;
         }

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpad.js

@@ -1,33 +1,52 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
-
+/**
+ * @fileoverview This modules is run during the oninit phase of the bootstrap.
+ */
 sap.ui.define([
     "sap/base/Log",
-    "sap/ushell_abap/bootstrap/PlatformConfig",
-    "sap/ushell_abap/bootstrap/ThemeHandler",
-    "sap/ushell_abap/bootstrap/SAPCompanionConditionSetter",
+    "sap/ushell_abap/bootstrap/DirectAppStart",
     "sap/ushell_abap/bootstrap/LoadLaunchpad/CreateRenderer",
     "sap/ushell_abap/bootstrap/LoadLaunchpad/InitXhrLogon",
     "sap/ushell_abap/bootstrap/LoadLaunchpad/RequestPages",
-    "sap/ushell_abap/bootstrap/DirectAppStart",
+    "sap/ushell_abap/bootstrap/PlatformConfig",
+    "sap/ushell_abap/bootstrap/SAPCompanionConditionSetter",
+    "sap/ushell_abap/bootstrap/ThemeHandler",
+    "sap/ushell_abap/pbServices/ui2/Contracts",
     "sap/ushell/Container",
     "sap/ushell/iconfonts",
-    "sap/ushell_abap/pbServices/ui2/Contracts"
+    "sap/ushell_abap/integration/WebSsoBridge"
 ], (
     Log,
-    PlatformConfig,
-    ThemeHandler,
-    SAPCompanionConditionSetter,
+    DirectAppStart,
     CreateRenderer,
     InitXhrLogon,
     RequestPages,
-    DirectAppStart,
+    PlatformConfig,
+    SAPCompanionConditionSetter,
+    ThemeHandler,
+    Contracts,
     Container,
     IconFonts,
-    Contracts
+    WebSsoBridge
 ) => {
     "use strict";
 
+    /**
+     * @alias sap.ushell_abap.bootstrap.LoadLaunchpad
+     * @namespace
+     * @description This module loads the necessary parts of the launchpad after the bootstrap is done.
+     *
+     * @since 1.147.0
+     * @private
+     */
     class LoadLaunchpad {
+        /**
+         * Loads the necessary parts of the launchpad after the bootstrap is done.
+         * @returns {Promise<undefined>} Resolves when the launchpad is loaded
+         *
+         * @since 1.147.0
+         * @private
+         */
         async run () {
             const aParallelPromises = [];
 
@@ -55,6 +74,8 @@ sap.ui.define([
 
             aParallelPromises.push(InitXhrLogon.run());
 
+            aParallelPromises.push(WebSsoBridge.init());
+
             await Promise.all(aParallelPromises);
         }
     }

package/src/main/js/sap/ushell_abap/bootstrap/LoadLaunchpadModule.js

@@ -1,5 +1,8 @@
 // Copyright (c) 2009-2026 SAP SE, All Rights Reserved
-
+/**
+ * @fileoverview This modules is used as reference for the sap-ui-oninit callback in the bootstrap.
+ * It ensures testability of the actual LoadLaunchpad module.
+ */
 sap.ui.define([
     "sap/ushell_abap/bootstrap/LoadLaunchpad"
 ], (