@sapui5/sap.ushell 1.136.2 → 1.138.0

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

@@ -1,11 +1,10 @@
 // Copyright (c) 2009-2025 SAP SE, All Rights Reserved
-
 /**
  * @fileOverview The Fiori20 adapter is not a platform adapter, but a UI adapter.
  *
  * The Fiori20 adapter automatically re-styles old (Fiori 1) applications to match Fiori2 design requirements.
  *
- * @version 1.136.2
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/ui/base/Object",
@@ -16,7 +15,7 @@ sap.ui.define([
     "sap/m/Fiori20Adapter",
     "sap/ui/thirdparty/hasher",
     "sap/base/util/extend"
-], function (
+], (
     BaseObject,
     Component,
     UIComponent,
@@ -25,93 +24,80 @@ sap.ui.define([
     SapMFiori20Adapter,
     hasher,
     extend
-) {
+) => {
     "use strict";
-
-    ComponentHooks.onUIComponentInstanceDestroy.register(function (oComponent) {
+    ComponentHooks.onUIComponentInstanceDestroy.register((oComponent) => {
         if (oComponent._fioriAdapter) {
             oComponent._fioriAdapter.destroy();
         }
-
         if (oComponent._oShellUIService) {
             oComponent._oShellUIService.destroy();
         }
     });
-
     /**
      * Fetches application information from app-descriptor or metadata
      *
      * @type {function}
      */
-    var AppInfo = BaseObject.extend("AppInfo", {
+    const AppInfo = BaseObject.extend("AppInfo", {
         constructor: function (oComponent) {
             BaseObject.call(this);
             this._oComponent = oComponent;
         },
-
-        getDefaultTitle: function () {
-            var sTitle,
-                sResBundle;
-
+        getDefaultTitle: async function () {
             // first possible source
-            var oAppInfo = this._oComponent.getManifestEntry("sap.app");
+            const oAppInfo = this._oComponent.getManifestEntry("sap.app");
             if (oAppInfo && oAppInfo.title) {
-                sTitle = oAppInfo.title;
+                const sTitle = oAppInfo.title;
                 if (this._isLocalizationKey(sTitle)) {
-                    sResBundle = (oAppInfo.i18n || "i18n/i18n.properties");
+                    const sResBundle = (oAppInfo.i18n || "i18n/i18n.properties");
                     return this._getLocalized(sTitle, sResBundle);
                 }
                 return sTitle;
             }
-
             // second possible source
-            var oUI5Info = this._oComponent.getManifestEntry("sap.ui5");
-            if (oUI5Info && oUI5Info.config && oUI5Info.config.resourceBundle && oUI5Info.config.titleResource) {
-                sTitle = oUI5Info.config.titleResource;
-                sResBundle = oUI5Info.config.resourceBundle;
+            const oUI5Info = this._oComponent.getManifestEntry("sap.ui5");
+            if (oUI5Info?.config?.resourceBundle && oUI5Info.config.titleResource) {
+                const sTitle = oUI5Info.config.titleResource;
+                const sResBundle = oUI5Info.config.resourceBundle;
                 return this._getLocalized(sTitle, sResBundle);
             }
-
-            return;
         },
-
-        _getLocalized: function (sText, sResBundle) {
-            var oModel = new ResourceModel({
-                bundleUrl: sap.ui.require.toUrl(this._oComponent.getMetadata().getComponentName()) + "/" + sResBundle
+        _getLocalized: async function (sText, sResBundle) {
+            const oModel = new ResourceModel({
+                async: true,
+                bundleUrl: `${sap.ui.require.toUrl(this._oComponent.getMetadata().getComponentName())}/${sResBundle}`
             });
-            return oModel.getResourceBundle().getText(sText.replace(/^{{/, "").replace(/}}$/, ""));
+            const oResourceBundle = await oModel.getResourceBundle();
+            return oResourceBundle.getText(sText.replace(/^{{/, "").replace(/}}$/, ""));
         },
-
         _isLocalizationKey: function (sTitle) {
             return (sTitle.indexOf("{{") === 0) && (sTitle.indexOf("}}") > 0);
         }
     });
-
     /**
      * Sets header info (title and navigation hierarchy) to the FLP header via the ShellUIService
      *
      * @type {function}
      */
-    var HeaderInfo = BaseObject.extend("HeaderInfo", {
+    const HeaderInfo = BaseObject.extend("HeaderInfo", {
         constructor: function (oComponent, oConfig, oAppInfo) {
             BaseObject.call(this);
             this._oConfig = oConfig;
             this._oAppInfo = oAppInfo;
             this._oShellUIService = oComponent._oShellUIService;
-
             this._aHierarchy = [];
-            this._defaultTitle = this._oAppInfo.getDefaultTitle();
-            this._oCurrentViewInfo = { oTitleInfo: { text: this._defaultTitle } };
+            this._pInit = this._oAppInfo.getDefaultTitle().then((sDefaultTitle) => {
+                this._sDefaultTitle = sDefaultTitle;
+            });
         },
-
-        registerView: function (oViewInfo) {
+        registerView: async function (oViewInfo) {
             if (this._oConfig.bMoveTitle === true) { // disabled by configuration
                 if (!oViewInfo.oTitleInfo && oViewInfo.oSubTitleInfo) {
                     oViewInfo.oTitleInfo = oViewInfo.oSubTitleInfo; // subtitle promotion in the absence of title
                 }
-
                 this._oCurrentViewInfo = oViewInfo;
-                var sTitle = this._oCurrentViewInfo.oTitleInfo ? this._oCurrentViewInfo.oTitleInfo.text : undefined;
+                const sTitle = oViewInfo.oTitleInfo ? oViewInfo.oTitleInfo.text : undefined;
                 if (sTitle !== this._oShellUIService.getTitle()) {
                     try {
                         this._oShellUIService.setTitle(sTitle);
@@ -122,43 +108,37 @@ sap.ui.define([
                          */
                     }
                 }
-                this._updateHierarchy();
+                await this._updateHierarchy(oViewInfo);
             }
-
             this._setBackNavigation(oViewInfo.oBackButton, oViewInfo.oAdaptOptions);
         },
-
         _setBackNavigation: function (oBackButton, oAdaptOptions) {
             if (oAdaptOptions && oAdaptOptions.bHideBackButton === false) { // disabled by configuration
                 return;
             }
-            var fnBackPress;
+            let fnBackPress;
             if (oBackButton) {
                 fnBackPress = oBackButton.firePress.bind(oBackButton);
             }
             this._oShellUIService.setBackNavigation(fnBackPress);
         },
-
-        _updateHierarchy: function () {
+        _updateHierarchy: async function (oViewInfo) {
             if (this._oConfig.bHierarchy === false) { // disabled by configuration
                 return;
             }
-
-            if (!this._oCurrentViewInfo) {
+            await this._pInit;
+            if (!oViewInfo) {
                 return;
             }
-
-            var bNew = true,
-                sHash = "#" + hasher.getHash();
-
-            for (var i = this._aHierarchy.length - 1; i >= 0; i--) {
-                var oEntry = this._aHierarchy[i],
-                    bKnownView = (oEntry.id === this._oCurrentViewInfo.sViewId),
-                    bKnownHash = (oEntry.intent === sHash);
-
+            let bNew = true;
+            const sHash = `#${hasher.getHash()}`;
+            for (let i = this._aHierarchy.length - 1; i >= 0; i--) {
+                let oEntry = this._aHierarchy[i];
+                const bKnownView = (oEntry.id === oViewInfo.sViewId);
+                const bKnownHash = (oEntry.intent === sHash);
                 if (bKnownView || bKnownHash) {
                     bNew = false;
-                    oEntry = this._updateHierarchyEntry(oEntry);
+                    oEntry = this._updateHierarchyEntry(oEntry, oViewInfo);
                     this._aHierarchy[i] = oEntry;
                     this._aHierarchy = this._aHierarchy.slice(0, i + 1);
                     if (bKnownView) {
@@ -167,16 +147,14 @@ sap.ui.define([
                     break;
                 }
             }
-
             if (bNew) {
-                this._aHierarchy.push(this._createHierarchyEntry());
+                const oHierarchyEntry = this._createHierarchyEntry(oViewInfo);
+                this._aHierarchy.push(oHierarchyEntry);
             }
-
-            var aNewHierarchy = [];
-            for (var j = this._aHierarchy.length - 2; j >= 0; j--) {
+            const aNewHierarchy = [];
+            for (let j = this._aHierarchy.length - 2; j >= 0; j--) {
                 aNewHierarchy.push(this._aHierarchy[j]);
             }
-
             try {
                 this._oShellUIService.setHierarchy(this._deleteUndefinedProperties(aNewHierarchy));
             } catch {
@@ -186,29 +164,24 @@ sap.ui.define([
                  */
             }
         },
-
-        _createHierarchyEntry: function () {
-            var sHash = "#" + hasher.getHash(),
-                oEntry = {
-                    id: this._oCurrentViewInfo.sViewId,
-                    title: this._oCurrentViewInfo.oTitleInfo ? this._oCurrentViewInfo.oTitleInfo.text : this._defaultTitle,
-                    subtitle: this._oCurrentViewInfo.oSubTitleInfo ? this._oCurrentViewInfo.oSubTitleInfo.text : undefined,
-                    intent: sHash
-                };
-            return oEntry;
+        _createHierarchyEntry: function (oViewInfo) {
+            return {
+                id: oViewInfo.sViewId,
+                title: oViewInfo.oTitleInfo ? oViewInfo.oTitleInfo.text : this._sDefaultTitle,
+                subtitle: oViewInfo.oSubTitleInfo ? oViewInfo.oSubTitleInfo.text : undefined,
+                intent: `#${hasher.getHash()}`
+            };
         },
-
-        _updateHierarchyEntry: function (oEntry) {
-            oEntry.id = this._oCurrentViewInfo.sViewId;
-            oEntry.title = this._oCurrentViewInfo.oTitleInfo ? this._oCurrentViewInfo.oTitleInfo.text : this._defaultTitle;
-            oEntry.subtitle = this._oCurrentViewInfo.oSubTitleInfo ? this._oCurrentViewInfo.oSubTitleInfo.text : undefined;
+        _updateHierarchyEntry: function (oEntry, oViewInfo) {
+            oEntry.id = oViewInfo.sViewId;
+            oEntry.title = oViewInfo.oTitleInfo ? oViewInfo.oTitleInfo.text : this._sDefaultTitle;
+            oEntry.subtitle = oViewInfo.oSubTitleInfo ? oViewInfo.oSubTitleInfo.text : undefined;
             return oEntry;
         },
-
         /* ShellUIService validation throws an error if a string field received a falsy (undefined or null) value */
         _deleteUndefinedProperties: function (aObjects) { // TODO: think refactor
-            aObjects.forEach(function (oObject) {
-                for (var sPropertyName in oObject) {
+            aObjects.forEach((oObject) => {
+                for (const sPropertyName in oObject) {
                     if (oObject.hasOwnProperty(sPropertyName) && !oObject[sPropertyName] && sPropertyName !== "title") {
                         delete oObject[sPropertyName];
                     }
@@ -217,57 +190,45 @@ sap.ui.define([
             return aObjects;
         }
     });
-
-    var Fiori20Adapter = BaseObject.extend("sap.ushell.Fiori20Adapter", {
+    const Fiori20Adapter = BaseObject.extend("sap.ushell.Fiori20Adapter", {
         constructor: function (oComponent, oConfig) {
             BaseObject.call(this);
             this._oComponent = oComponent;
             this._oConfig = oConfig;
-
             this._oHeaderInfo = new HeaderInfo(oComponent, oConfig, new AppInfo(oComponent));
-
             if (SapMFiori20Adapter) {
                 SapMFiori20Adapter.attachViewChange(this._onViewChange, this);
             }
         },
-
         init: function () {
             if (!SapMFiori20Adapter) {
                 return;
             }
-
-            var oConfig = extend({}, this._oConfig);
+            const oConfig = extend({}, this._oConfig);
             SapMFiori20Adapter.traverse(this._oComponent.getAggregation("rootControl"), oConfig);
         },
-
         destroy: function () {
             if (SapMFiori20Adapter) {
                 SapMFiori20Adapter.detachViewChange(this._onViewChange, this);
             }
         },
-
-        _onViewChange: function (oEvent) {
-            this._oHeaderInfo.registerView(oEvent.getParameters());
+        _onViewChange: async function (oEvent) {
+            await this._oHeaderInfo.registerView(oEvent.getParameters());
         }
     });
-
     Fiori20Adapter.applyTo = function (oControl, oComponent, oConfig, oShellUIService) {
-        var oOwner = oControl instanceof UIComponent ? oControl : Component.getOwnerComponentFor(oControl);
+        let oOwner = oControl instanceof UIComponent ? oControl : Component.getOwnerComponentFor(oControl);
         if (!oOwner) {
             oOwner = oComponent;
         }
-
         if (!oOwner) {
             return;
         }
-
         oOwner._oShellUIService = oShellUIService;
-
         if (!oOwner._fioriAdapter) {
             oOwner._fioriAdapter = new Fiori20Adapter(oOwner, oConfig);
             oOwner._fioriAdapter.init();
         }
     };
-
     return Fiori20Adapter;
 });

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

@@ -4,7 +4,7 @@
  * @fileOverview The purpose Fiori20AdapterTest in this file is to decide whether to load the Fiori20Adapter at all.
  * This file is kept small in size on purpose as it is always required in productive code even when Fiori2 adaptation is not required.
  *
- * @version 1.136.2
+ * @version 1.138.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -16,7 +16,7 @@ sap.ui.define([
     "sap/ui/core/UIComponent",
     "sap/ui/core/ComponentHooks",
     "sap/ushell/Fiori20Adapter"
-], function (
+], (
     Log,
     isEmptyObject,
     Version,
@@ -26,7 +26,7 @@ sap.ui.define([
     UIComponent,
     ComponentHooks,
     Fiori20Adapter
-) {
+) => {
     "use strict";
 
     // Note: the code below runs once ever after the Launchpad is started.
@@ -39,7 +39,7 @@ sap.ui.define([
      *   (1) url parameter sap-ui-xx-fiori2Adaptation or
      *   (2) parameter “sapFiori2Adaptation” in the metadata or the app descriptor (where the url parameter is given priority over metadata)
      */
-    var Fiori20AdapterConfiguration = {
+    const Fiori20AdapterConfiguration = {
         I_DEFAULT_SEARCH_DEPTH: 5,
         B_DEFAULT_LATE_ADAPTATION: false,
         S_FIORI20ADAPTER_URL_PARAM_NAME: "sap-ui-xx-fiori2Adaptation",
@@ -77,7 +77,7 @@ sap.ui.define([
         ],
 
         getConfiguration: function (oComp) {
-            var oConfig;
+            let oConfig;
 
             oConfig = this._getURLParamConfiguration(); // highest priority
 
@@ -89,7 +89,7 @@ sap.ui.define([
                 oConfig = this._getDefaultConfiguration(oComp); // default config, if no custom config specified
             }
 
-            //undocumented config option for handling special cases:
+            // undocumented config option for handling special cases:
             oConfig.iSearchDepth = oConfig.iSearchDepth || Fiori20AdapterConfiguration.I_DEFAULT_SEARCH_DEPTH;
             if ((typeof oConfig.iSearchDepth === "string") && !isNaN(oConfig.iSearchDepth)) {
                 oConfig.iSearchDepth = parseInt(oConfig.iSearchDepth, 10);
@@ -108,14 +108,14 @@ sap.ui.define([
                 return; // parameter is not defined in the Core
             }
 
-            var oUriParameters = new URLSearchParams(window.location.search);
+            const oUriParameters = new URLSearchParams(window.location.search);
             if (!oUriParameters.get(Fiori20AdapterConfiguration.S_FIORI20ADAPTER_URL_PARAM_NAME)) {
                 return; // no param value specified in the URL
             }
 
-            var vUrlConfig = Configuration.getFiori2Adaptation();
-            var bUrlConfig;
-            var sUrlConfig;
+            const vUrlConfig = Configuration.getFiori2Adaptation();
+            let bUrlConfig;
+            let sUrlConfig;
 
             if (typeof (vUrlConfig) === "boolean") {
                 bUrlConfig = vUrlConfig;
@@ -137,10 +137,10 @@ sap.ui.define([
         },
 
         _getMetadataConfiguration: function (oComp) {
-            var oUI5Config = oComp.getManifestEntry("/sap.ui5/config") || {};
-            var vAppConfig = oUI5Config[Fiori20AdapterConfiguration.S_FIORI20ADAPTER_METADATA_PARAM_NAME];
-            var bAppConfig;
-            var oAppConfig;
+            const oUI5Config = oComp.getManifestEntry("/sap.ui5/config") || {};
+            const vAppConfig = oUI5Config[Fiori20AdapterConfiguration.S_FIORI20ADAPTER_METADATA_PARAM_NAME];
+            let bAppConfig;
+            let oAppConfig;
 
             if (typeof (vAppConfig) === "boolean") {
                 bAppConfig = vAppConfig;
@@ -164,7 +164,7 @@ sap.ui.define([
         },
 
         _getDefaultConfiguration: function (oComp) {
-            var bEnabled = this._hasMinVersionSmallerThan(oComp, "1.42") && this._isAllowed(oComp);
+            const bEnabled = this._hasMinVersionSmallerThan(oComp, "1.42") && this._isAllowed(oComp);
             return {
                 bStylePage: bEnabled,
                 bMoveTitle: bEnabled,
@@ -175,9 +175,9 @@ sap.ui.define([
         },
 
         _isAllowed: function (oComp) {
-            var sComponentName = oComp.getMetadata().getName();
-            for (var i = 0; i < Fiori20AdapterConfiguration.A_ALLOWLIST.length; i++) {
-                var sNextPrefix = Fiori20AdapterConfiguration.A_ALLOWLIST[i].substring(0, Fiori20AdapterConfiguration.A_ALLOWLIST[i].length - 2);
+            const sComponentName = oComp.getMetadata().getName();
+            for (let i = 0; i < Fiori20AdapterConfiguration.A_ALLOWLIST.length; i++) {
+                const sNextPrefix = Fiori20AdapterConfiguration.A_ALLOWLIST[i].substring(0, Fiori20AdapterConfiguration.A_ALLOWLIST[i].length - 2);
                 if (this._isPrefixedString(sComponentName, sNextPrefix)) {
                     return true;
                 }
@@ -186,7 +186,7 @@ sap.ui.define([
         },
 
         _isAdaptationRequired: function (oAdaptOptions) {
-            for (var sOption in oAdaptOptions) {
+            for (const sOption in oAdaptOptions) {
                 if (oAdaptOptions[sOption] === true) {
                     return true;
                 }
@@ -208,11 +208,11 @@ sap.ui.define([
          * @returns {boolean} Whether the component has a min version smaller than the given version
          */
         _hasMinVersionSmallerThan: function (oComp, sVersion) {
-            var oInfo = oComp.getManifestEntry("sap.ui5");
-            var bMinVersion = true; // by default considered smaller unless otherwise specified (to cover old apps w/o min version)
+            const oInfo = oComp.getManifestEntry("sap.ui5");
+            let bMinVersion = true; // by default considered smaller unless otherwise specified (to cover old apps w/o min version)
 
             if (oInfo && oInfo.dependencies && oInfo.dependencies.minUI5Version) {
-                var oMinVersion = new Version(oInfo.dependencies.minUI5Version);
+                const oMinVersion = new Version(oInfo.dependencies.minUI5Version);
                 bMinVersion = oMinVersion.compareTo(new Version(sVersion)) < 0;
             }
             return bMinVersion;
@@ -222,7 +222,7 @@ sap.ui.define([
         }
     };
 
-    ComponentHooks.onUIComponentInstanceInitialized.register(function (oComponent) {
+    ComponentHooks.onUIComponentInstanceInitialized.register((oComponent) => {
         const oRootControl = oComponent.getAggregation("rootControl");
 
         if (!oRootControl
@@ -237,12 +237,10 @@ sap.ui.define([
             return;
         }
 
-
         /* check: Service registry is available */
         if (!coreLibrary.service
             || !ServiceFactoryRegistry
             || typeof ServiceFactoryRegistry.get !== "function") {
-
             Log.warning(
                 "Fiori20Adapter not loaded because static FactoryRegistry is not available",
                 "sap.ui.core.service.ServiceFactoryRegistry should be a function",
@@ -251,7 +249,6 @@ sap.ui.define([
             return;
         }
 
-
         const oDelegate = {
             onBeforeRendering: function () {
                 oRootControl.removeEventDelegate(oDelegate);