@sapui5/sap.ushell_abap 1.146.0 → 1.147.0

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

@@ -0,0 +1,385 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ushell_abap/bootstrap/BootTask",
+    "sap/ushell_abap/bootstrap/ThemeHandler",
+    "sap/ushell/base/requireAsync",
+    "sap/ushell/bootstrap/Config",
+    "sap/base/util/ObjectPath"
+], (
+    Log,
+    BootTask,
+    ThemeHandler,
+    requireAsync,
+    BootstrapConfig,
+    ObjectPath
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell_abap.bootstrap.PlatformConfig
+     * @namespace
+     * @description ABAP platform configuration. Responsible for applying ABAP-specific settings to the ushell configuration,
+     * determining the active theme and theme roots, and providing the merged UI5 configuration for the ABAP platform.
+     *
+     * @since 1.147.0
+     * @private
+     */
+    class PlatformConfig {
+        /**
+         * Reads the messages array from the ushell config and logs error/warning
+         * messages from the ABAP server to the browser console.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #logServerSideMessages () {
+            const oUshellConfig = BootstrapConfig.get();
+            const sComponent = "ABAP Server Error Messages";
+            const aMessages = oUshellConfig.messages;
+            if (aMessages && aMessages.length > 0) {
+                for (let i = 0; i < aMessages.length; i += 1) {
+                    if (aMessages[i].severity === "error") {
+                        Log.error(aMessages[i].text, null, sComponent);
+                    } else if (aMessages[i].severity === "warning") {
+                        Log.warning(aMessages[i].text, null, sComponent);
+                    }
+                }
+            }
+        }
+
+        /**
+         * Sets the isLanguagePersonalized property based on the PREFERRED_LOGON_LANGUAGE
+         * value in the user profile.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #adaptLanguageConfig () {
+            const oUshellConfig = BootstrapConfig.get();
+            const aUserProfile = ObjectPath.get("startupConfig.userProfile", oUshellConfig) || [];
+            const oPreferredLanguage = aUserProfile.filter((oProfile) => {
+                return oProfile.id === "PREFERRED_LOGON_LANGUAGE";
+            })[0];
+            if (oPreferredLanguage && oPreferredLanguage.value !== undefined) {
+                const bIsLanguagePersonalized = oPreferredLanguage.value !== "";
+                ObjectPath.set("startupConfig.isLanguagePersonalized", bIsLanguagePersonalized, oUshellConfig);
+            }
+        }
+
+        /**
+         * Configures IANA timezone settings based on server configuration.
+         * Sets defaults for timeZone and timeZoneFromServerInUI5 if not already defined.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #setIanaSettings () {
+            const oUshellConfig = BootstrapConfig.get();
+
+            // IANA Timezone support based on server config
+            let bTimeZoneIana = ObjectPath.get("ui5.timeZoneFromServerInUI5", oUshellConfig);
+            if (bTimeZoneIana === undefined) {
+                bTimeZoneIana = false;
+                ObjectPath.set("startupConfig.timeZoneFromServerInUI5", bTimeZoneIana, oUshellConfig);
+                ObjectPath.set("ushell.ui5.timeZoneFromServerInUI5", bTimeZoneIana);
+            }
+            let sTimeZoneIana = ObjectPath.get("startupConfig.timeZone", oUshellConfig);
+            if (sTimeZoneIana === undefined) {
+                sTimeZoneIana = "";
+                ObjectPath.set("startupConfig.timeZone", sTimeZoneIana, oUshellConfig);
+            }
+        }
+
+        /**
+         * Copies the startupConfig to the Container adapter config path.
+         * Preserves any pre-existing systemProperties so they are not overwritten.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #setStartupConfigAsContainerAdapterConfig () {
+            const oUshellConfig = BootstrapConfig.get();
+            const oStartUpConfig = ObjectPath.get("startupConfig", oUshellConfig);
+            if (!oStartUpConfig) {
+                return;
+            }
+
+            // first store systemProperties if they exist, as they should not be overridden by startupConfig
+            const oSystemProperties = ObjectPath.get("services.Container.adapter.config.systemProperties", oUshellConfig);
+
+            ObjectPath.set("services.Container.adapter.config", oStartUpConfig, oUshellConfig);
+
+            if (oSystemProperties) {
+                ObjectPath.set("services.Container.adapter.config.systemProperties", oSystemProperties, oUshellConfig);
+            }
+        }
+
+        /**
+         * Activates FLP spaces (based on pages and sections therein)
+         * or the classic homepage mode (based on app groups)
+         * by setting the configuration switch <code>config.ushell.spaces.enabled</code> .
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #setSpacesOrHomepageMode () {
+            const oUshellConfig = BootstrapConfig.get();
+            // Check if user is allowed to configure FLP spaces or homepage mode, and if so consider it
+            const bSpacesConfigurableByUser = ObjectPath.get("ushell.spaces.configurable", oUshellConfig);
+            if (bSpacesConfigurableByUser) {
+                // Check if spaces have been activated by the user
+                const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig);
+                const aUserProfileItems = ObjectPath.get("userProfile", oContainerAdapterConfig) || [];
+                const oSpacesProfile = aUserProfileItems.filter((property) => {
+                    return property.id === "SPACES_ENABLEMENT";
+                })[0];
+                const sSpacesEnabledByUser = oSpacesProfile && oSpacesProfile.value;
+
+                // If the user hasn't chosen any setting yet the personalization is undefined
+                // and the admin setting isn't overwritten
+                if (sSpacesEnabledByUser === "true") {
+                    ObjectPath.set("ushell.spaces.enabled", true, oUshellConfig);
+                } else if (sSpacesEnabledByUser === "false") {
+                    ObjectPath.set("ushell.spaces.enabled", false, oUshellConfig);
+                }
+            }
+
+            if (ObjectPath.get("ushell.spaces.enabled", oUshellConfig)) {
+                // Use CDM adapters in case the user views a sap ushell page
+                ObjectPath.set("services.CommonDataModel.adapter.module", "sap.ushell.adapters.cdm.PagesCommonDataModelAdapter", oUshellConfig);
+                // VisualizationDataProvider and LaunchPageAdapter should have the same configuration
+                const oLaunchPageAdapterConfig = ObjectPath.get("services.LaunchPage.adapter.config", oUshellConfig) || {};
+                ObjectPath.set("services.VisualizationDataProvider.adapter.config", oLaunchPageAdapterConfig, oUshellConfig);
+            }
+        }
+
+        /**
+         * Enables or disables the SupportTicket service based on the service config.
+         * Does not enable the service if it is already explicitly disabled.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #enableSupportTicket () {
+            const oUshellConfig = BootstrapConfig.get();
+
+            // write the support ticket service enablement to the bootstrap config;
+            // do not enable if already disabled, but disable if not available in backend
+            const vSupportTicketEnabled = ObjectPath.get("services.SupportTicket.config.enabled", oUshellConfig);
+            if (vSupportTicketEnabled !== false) { // default true
+                const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig);
+                ObjectPath.set("services.SupportTicket.config.enabled", oContainerAdapterConfig.isEmbReportingActive === true, oUshellConfig);
+            }
+        }
+
+        /**
+         * Writes service endpoint URLs (targetMappings, pageBuilding, personalization)
+         * from the Container adapter config into the respective service adapter configurations.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #setServiceEndpoints () {
+            const oUshellConfig = BootstrapConfig.get();
+            const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig);
+            const oTargetMappingEndpoint = ObjectPath.get("services.targetMappings", oContainerAdapterConfig);
+            const oPageBuildingEndpoint = ObjectPath.get("services.pbFioriHome", oContainerAdapterConfig);
+            const oPersonalizationEndpoint = ObjectPath.get("services.personalization", oContainerAdapterConfig);
+
+            const oTmpConfig = {};
+
+            ObjectPath.set("services.ClientSideTargetResolution.adapter.config.services.targetMappings", oTargetMappingEndpoint, oTmpConfig);
+
+            ObjectPath.set("services.LaunchPage.adapter.config.services.targetMappings", oTargetMappingEndpoint, oTmpConfig);
+            ObjectPath.set("services.LaunchPage.adapter.config.services.launchPage", oPageBuildingEndpoint, oTmpConfig);
+
+            // this service reuses the LaunchPageAdapter internally
+            ObjectPath.set("services.VisualizationDataProvider.adapter.module", "sap.ushell_abap.adapters.abap.FlpLaunchPageAdapter", oTmpConfig);
+            ObjectPath.set("services.VisualizationDataProvider.adapter.config.services.targetMappings", oTargetMappingEndpoint, oTmpConfig);
+            ObjectPath.set("services.VisualizationDataProvider.adapter.config.services.launchPage", oPageBuildingEndpoint, oTmpConfig);
+
+            ObjectPath.set("services.PageBuilding.adapter.config.services.pageBuilding", oPageBuildingEndpoint, oTmpConfig);
+
+            ObjectPath.set("services.Personalization.adapter.config.services.personalization", oPersonalizationEndpoint, oTmpConfig);
+
+            const oMigrationConfig = BootstrapConfig.getV2MigrationConfig(oTmpConfig);
+            BootstrapConfig.extendConfig(oUshellConfig, oMigrationConfig, true);
+            BootstrapConfig.extendConfig(oUshellConfig, oTmpConfig, true);
+        }
+
+        /**
+         * NavigationDataProvider and ClientSideTargetResolution both create a ClientSideTargetResolutionAdapter instance.
+         * These should use the same config object (not copies) as the request promises are stored
+         * in the config and need to be accessible for all instances.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #shareClientSideTargetResolutionAdapterConfig () {
+            const oUshellConfig = BootstrapConfig.get();
+
+            const oClientSideTargetResolutionAdapterConfig = ObjectPath.get("services.ClientSideTargetResolution.adapter.config", oUshellConfig) || {};
+            ObjectPath.set("services.ClientSideTargetResolution.adapter.config", oClientSideTargetResolutionAdapterConfig, oUshellConfig);
+            ObjectPath.set("services.NavigationDataProvider.adapter.config", oClientSideTargetResolutionAdapterConfig, oUshellConfig);
+        }
+
+        /**
+         * Sanitizes the plugins configuration by ensuring that formFactors are set consistently.
+         *
+         * @since 1.147.0
+         * @private
+         */
+        #sanitizePluginsConfiguration () {
+            const oUshellConfig = BootstrapConfig.get();
+            const oPlugins = ObjectPath.get("bootstrapPlugins", oUshellConfig) || {};
+
+            Object.keys(oPlugins).forEach((sPluginId) => {
+                const oPluginConfig = oPlugins[sPluginId];
+                // some plugins don't have formFactors configuration and should be loaded for any device type
+                if (oPluginConfig.hasOwnProperty("formFactors")) {
+                    const oFormFactors = oPluginConfig.formFactors;
+                    const oDeviceTypes = {};
+                    oDeviceTypes.desktop = oFormFactors.desktop || false;
+                    oDeviceTypes.tablet = oFormFactors.tablet || false;
+                    oDeviceTypes.phone = oFormFactors.phone || false;
+                    oPluginConfig.deviceTypes = oDeviceTypes;
+                    delete oPluginConfig.formFactors;
+                }
+            });
+        }
+
+        /**
+         * Applies ABAP specific configuration to the ushell config
+         *
+         * @since 1.147.0
+         * @private
+         */
+        configureUshell () {
+            // Write any warnings and errors related to server-side config to console.
+            this.#logServerSideMessages();
+
+            this.#adaptLanguageConfig();
+            this.#setIanaSettings();
+            this.#setStartupConfigAsContainerAdapterConfig();
+
+            // now only access to the startupConfig should happen via the Container adapter config
+
+            ThemeHandler.setBootThemeInUserConfig();
+            this.#setSpacesOrHomepageMode();
+            this.#setServiceEndpoints();
+            this.#shareClientSideTargetResolutionAdapterConfig();
+            this.#enableSupportTicket();
+            this.#sanitizePluginsConfiguration();
+        }
+
+        /**
+         * Returns the ABAP platform-specific UI5 configuration.
+         * Respects the sap-locale URL parameter to skip local settings.
+         *
+         * @returns {object} UI5 configuration with camelCase keys (sapUiLanguage, sapUiABAPDateFormat, sapUiTheme, etc.)
+         *
+         * @since 1.147.0
+         * @private
+         */
+        getUI5Config () {
+            const oUshellConfig = BootstrapConfig.get();
+            const { theme, themeRoots } = ThemeHandler.getUI5ConfigTheme();
+
+            const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig) || {};
+            const sCalendarWeekNumbering = oContainerAdapterConfig.calendarWeekNumbering || "Default";
+            let sLanguage = oContainerAdapterConfig.languageBcp47 || oContainerAdapterConfig.language;
+            let sLegacyDateFormat = oContainerAdapterConfig.dateFormat;
+            let sLegacyNumberFormat = oContainerAdapterConfig.numberFormat === "" ? " " : oContainerAdapterConfig.numberFormat;
+            let sLegacyTimeFormat = oContainerAdapterConfig.timeFormat;
+
+            const oUrlParameters = new URLSearchParams(this.getWindowLocationSearch());
+            const bSkipLocalSettings = !!oUrlParameters.get("sap-locale");
+            if (bSkipLocalSettings) {
+                sLanguage = undefined;
+                sLegacyDateFormat = undefined;
+                sLegacyNumberFormat = undefined;
+                sLegacyTimeFormat = undefined;
+            }
+
+            const bUseTimeZoneIana = oContainerAdapterConfig.timeZoneFromServerInUI5;
+            let sTimeZoneIana = oContainerAdapterConfig.timeZone;
+            if (bUseTimeZoneIana && oContainerAdapterConfig.timeZone !== "") {
+                sTimeZoneIana = oContainerAdapterConfig.timeZone;
+            }
+
+            return {
+                sapUiLanguage: sLanguage,
+                sapUiABAPDateFormat: sLegacyDateFormat,
+                sapUiABAPNumberFormat: sLegacyNumberFormat,
+                sapUiABAPTimeFormat: sLegacyTimeFormat,
+                sapUiTimezone: sTimeZoneIana,
+                sapUiCalendarWeekNumbering: sCalendarWeekNumbering,
+                sapUiTheme: theme,
+                sapUiThemeRoots: themeRoots,
+                /**
+                 * @deprecated since 1.120
+                 */
+                sapUiXxBootTask: BootTask.run.bind(BootTask),
+                sapUiOnInit: "module:sap/ushell_abap/bootstrap/LoadLaunchpadModule"
+            };
+        }
+
+        /**
+         * Applies additional UI5 settings that require async API calls.
+         * Sets Islamic calendar customizing data, language with ABAP language code,
+         * and custom currencies.
+         *
+         * @returns {Promise} Resolves when all settings have been applied
+         *
+         * @since 1.147.0
+         * @private
+         */
+        async setUI5Settings () {
+            const oUshellConfig = BootstrapConfig.get();
+            const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig) || {};
+
+            const [
+                Formatting,
+                Localization
+            ] = await requireAsync([
+                "sap/base/i18n/Formatting",
+                "sap/base/i18n/Localization"
+            ]);
+
+            const sLegacyDateCalendarCustomizing = oContainerAdapterConfig.tislcal;
+            const sLanguage = oContainerAdapterConfig.languageBcp47 || oContainerAdapterConfig.language;
+            const sABAPLanguage = oContainerAdapterConfig.language;
+            const oCurrencyFormats = oContainerAdapterConfig.currencyFormats;
+
+            if (sLegacyDateCalendarCustomizing) {
+                Formatting.setCustomIslamicCalendarData(sLegacyDateCalendarCustomizing);
+            }
+
+            if (sABAPLanguage) { // only set abap language if it is provided, the regular language was already configured
+                Localization.setLanguage(sLanguage, sABAPLanguage);
+            }
+
+            // Copy currency formats, if provided, to the UI5 custom currencies format settings
+            if (typeof oCurrencyFormats === "object") {
+                Formatting.addCustomCurrencies(oCurrencyFormats);
+            }
+        }
+
+        /**
+         * 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;
+        }
+    }
+
+    return new PlatformConfig();
+});

package/src/main/js/sap/ushell_abap/bootstrap/{evo/SAPCompanionConditionSetter.js → SAPCompanionConditionSetter.js}

@@ -7,10 +7,12 @@
  */
 sap.ui.define([
     "sap/base/Log",
-    "sap/base/util/Deferred"
+    "sap/base/util/Deferred",
+    "sap/ushell/bootstrap/Config"
 ], (
     Log,
-    Deferred
+    Deferred,
+    BootstrapConfig
 ) => {
     "use strict";
 
@@ -24,7 +26,7 @@ sap.ui.define([
 
         // The ushell config is not yet prepared when the module is loaded, therefore set only on "run", not earlier
         if (Setter._ushellConfig === undefined) {
-            Setter._ushellConfig = window["sap-ushell-config"];
+            Setter._ushellConfig = BootstrapConfig.get();
         }
 
         function fnTryToSetConditions () {
@@ -40,7 +42,7 @@ sap.ui.define([
                 oConditions.FLPClientRole = Setter._ushellConfig.startupConfig.clientRole;
 
                 window.Help4.API.setConditions(oConditions);
-                Log.info(`Conditions transferred to SAP Compagnion / SAP Help: ${JSON.stringify(oConditions)}`);
+                Log.info(`Conditions transferred to SAP Companion / SAP Help: ${JSON.stringify(oConditions)}`);
                 return true;
             }
             return false;

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

@@ -0,0 +1,145 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+sap.ui.define([
+    "sap/ushell_abap/bootstrap/XhrFactory",
+    "sap/ushell/bootstrap/Config",
+    "sap/base/util/ObjectPath",
+    "sap/ushell_abap/pbServices/ui2/Utils",
+    "sap/ushell/base/SAPBusinessClientEnablement"
+], (
+    XhrFactory,
+    BootstrapConfig,
+    ObjectPath,
+    ui2Utils,
+    SAPBusinessClientEnablement
+) => {
+    "use strict";
+
+    class StartupRequestHandler {
+        /**
+         * Performs the start-up request.
+         * @param {string} sQuery
+         *    String which is added to the "/sap/bc/ui2/start_up?"
+         * @param {string[]} aParametersFromUrl
+         *    The List of parameters which should be copied to the requested url
+         *
+         * @returns {Promise}
+         *    Result of the GET request should be resolved
+         */
+        #requestStartup (sQuery, aParametersFromUrl) {
+            const oUshellConfig = BootstrapConfig.get();
+            const oContainerAdapterConfig = ObjectPath.get("services.Container.adapter.config", oUshellConfig);
+
+            let sRequestUrl = "/sap/bc/ui2/start_up?";
+            const mParameterMap = ui2Utils.getParameterMap();
+
+            if (sQuery) {
+                sRequestUrl += `${sQuery}&`;
+            }
+
+            /**
+             * Copies the URL parameter with the given name from <code>mParameterMap</code> to
+             * <code>sRequestUrl</code>.
+             *
+             * @param {string} sName
+             *   URL parameter name
+             * @private
+             */
+            function copyParameter (sName) {
+                const sValue = mParameterMap[sName];
+                if (sValue) {
+                    sRequestUrl += `${sName}=${encodeURIComponent(sValue[0])}&`;
+                }
+            }
+
+            aParametersFromUrl.forEach(copyParameter);
+            sRequestUrl += `shellType=${SAPBusinessClientEnablement.getShellType()}&depth=0`;
+            sRequestUrl += this.#getCacheIdAsQueryParameter(oContainerAdapterConfig);
+            const oXhr = XhrFactory.createAndOpen(sRequestUrl, oContainerAdapterConfig); // XMLHttpRequest + headers
+
+            return new Promise((resolve, reject) => {
+                ui2Utils.get(
+                    sRequestUrl,
+                    false, /* xml=*/
+                    (sStartupCallResult) => {
+                        try {
+                            const oStartupResult = JSON.parse(sStartupCallResult);
+                            resolve(oStartupResult);
+                        } catch (oError) {
+                            reject(oError);
+                        }
+                    },
+                    (sErrorMessage) => {
+                        reject(new Error(sErrorMessage));
+                    },
+                    oXhr
+                );
+            });
+        }
+
+        /**
+         * Performs the full start-up request (so=%2A&action=%2A).
+         *
+         * @param {boolean} bNoOData
+         *    If Odata is not allowed. If true - return rejected promise.
+         *
+         * @returns {Promise}
+         *    Result of the GET request should be resolved
+         */
+        async requestFullTM () {
+            const oResult = await this.#requestStartup("so=%2A&action=%2A&systemAliasesFormat=object", ["sap-language", "sap-client", "sap-ui2-cache-disable"]);
+
+            if (oResult) {
+                if (oResult.client) { // double check we get the correct response
+                    // TODO: move this to integration test perhaps
+                    throw new Error("A start up response was returned in a target mappings request.");
+                }
+                return oResult;
+            }
+
+            return {};
+        }
+
+        /**
+         * Performs an extra request to retrieve a direct Start Request.
+         *
+         * @param {sap.ushell.services.URLParsing.DecomposedHash} oParsedHash
+         *    The parsed shell hash object. The object must contain semanticObject and action
+         * @param {object} oInitialKeys
+         *    The parameters which should be copied to the requested url
+         *
+         *  @returns {Promise}
+         *    Result of the GET request should be resolved
+         */
+        async requestDirectStart (oParsedHash, oInitialKeys) {
+            const sFormFactor = ui2Utils.getFormFactor();
+            let sQueryPath = "";
+
+            sQueryPath = `so=${oParsedHash.semanticObject}&action=${oParsedHash.action}`;
+            sQueryPath += "&systemAliasesFormat=object";
+            Object.keys(oInitialKeys).forEach((sKey) => {
+                sQueryPath += `&${sKey}=${oInitialKeys[sKey]}`;
+            });
+            if (sFormFactor) {
+                sQueryPath += `&formFactor=${encodeURIComponent(sFormFactor)}`;
+            }
+
+            return this.#requestStartup(sQueryPath, ["sap-language", "sap-client"]);
+        }
+
+        /**
+         * Get cacheId from startup config and return it as query parameter like "&sap-cache-id=xxxx"
+         * If cacheId not found in config, return empty string
+         * @param {object} oContainerAdapterConfig startup config
+         * @returns {string} "&sap-cache-id=xxxx" if found, otherwise ""
+         */
+        #getCacheIdAsQueryParameter (oContainerAdapterConfig) {
+            const sCacheId = ObjectPath.get("services.targetMappings.cacheId", oContainerAdapterConfig);
+            if (typeof sCacheId === "string") {
+                return `&sap-cache-id=${sCacheId}`;
+            }
+            return "";
+        }
+    }
+
+    return new StartupRequestHandler();
+});