@sapui5/sap.ushell 1.112.3 → 1.113.0

package/src/main/js/sap/ushell/adapters/cdm/v3/AdapterBase.js

@@ -1,10 +1,10 @@
-// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The Base of Unified Shell's LaunchPageAdapter for the 'CDM' platform - Version 3 (V3)
  *   and StaticGroupsContainer for Featured Group
  *
- * @version 1.112.3
+ * @version 1.113.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",
@@ -128,15 +128,14 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype._ensureLoaded = function () {
-        var that = this,
-            oDeferred;
+        var that = this;
 
         // bundle multiple requests running in parallel
         if (this._ensureLoadedDeferred) {
             return this._ensureLoadedDeferred.promise();
         }
 
-        oDeferred = new jQuery.Deferred();
+        var oDeferred = new jQuery.Deferred();
         this._ensureLoadedDeferred = oDeferred;
 
         this._getSiteData()
@@ -169,7 +168,7 @@ sap.ui.define([
                     });
             })
             .fail(function (sErrorMessage0) {
-                oLogger.error("Delivering hompage groups failed - " + sErrorMessage0);
+                oLogger.error("Delivering homepage groups failed - " + sErrorMessage0);
                 that._ensureLoadedDeferred.resolve([]);
                 // ensure that following _ensureLoaded calls get resolved with a new parameter
                 delete that._ensureLoadedDeferred;
@@ -192,9 +191,9 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype._ensureGroupItemsResolved = function (oGroup, oSite) {
-        var aPromises = [],
-            aResolvedTilesPromises,
-            aResolvedLinksPromises;
+        var aPromises = [];
+        var aResolvedTilesPromises;
+        var aResolvedLinksPromises;
 
         // Tiles
         if (oGroup.payload && oGroup.payload.tiles) {
@@ -352,19 +351,19 @@ sap.ui.define([
      *  to the fail handler which will be called in this case.
      */
     AdapterBase.prototype._resolveTileByVizId = function (oTile, oSite) {
-        var oVisualization,
-            sVisualizationId,
-            oVisualizationType,
-            sVisualizationTypeId,
-            sAppId,
-            oAppDescriptor,
-            oInboundResult,
-            oMapped,
-            sNavigationMode,
-            oApp,
-            sHash,
-            oOutbound,
-            sExternalUrl;
+        var oVisualization;
+        var sVisualizationId;
+        var oVisualizationType;
+        var sVisualizationTypeId;
+        var sAppId;
+        var oAppDescriptor;
+        var oInboundResult;
+        var oMapped;
+        var sNavigationMode;
+        var oApp;
+        var sHash;
+        var oOutbound;
+        var sExternalUrl;
 
         // Reject tile resolution
         function reject (iLogLevel, sMessage) {
@@ -415,10 +414,10 @@ sap.ui.define([
             // Extract tile information from inbound
             oMapped = oUtilsCdm.mapOne(oInboundResult.key, oInboundResult.inbound, oAppDescriptor, oVisualization, oVisualizationType, oSite);
 
-            var sApplicationType = oMapped.resolutionResult.applicationType,
-                sAdditionalInformation = oMapped.resolutionResult.additionalInformation,
-                oEnableInPlaceForClassicUIsConfig = Config.last("/core/navigation/enableInPlaceForClassicUIs"),
-                bIsApplicationTypeConfiguredInPlace = oEnableInPlaceForClassicUIsConfig ? oEnableInPlaceForClassicUIsConfig[sApplicationType] : false;
+            var sApplicationType = oMapped.resolutionResult.applicationType;
+            var sAdditionalInformation = oMapped.resolutionResult.additionalInformation;
+            var oEnableInPlaceForClassicUIsConfig = Config.last("/core/navigation/enableInPlaceForClassicUIs");
+            var bIsApplicationTypeConfiguredInPlace = oEnableInPlaceForClassicUIsConfig ? oEnableInPlaceForClassicUIsConfig[sApplicationType] : false;
             sNavigationMode = navigationMode.computeNavigationModeForHomepageTiles(sApplicationType, sAdditionalInformation, bIsApplicationTypeConfiguredInPlace);
 
             oOutbound = oReadVisualization.getOutbound(oVisualization, oInboundResult.inbound);
@@ -451,19 +450,13 @@ sap.ui.define([
                 tileIntent: sExternalUrl || sHash
             });
         } else {
-            // request service only once
-            if (!this._oUrlParsingPromise) {
-                this._oUrlParsingPromise = sap.ushell.Container.getServiceAsync("URLParsing");
+            if (oTile.target) {
+                var oTarget = deepClone(oTile.target);
+                sHash = oUtilsCdm.toHashFromTarget(readUtils.harmonizeTarget(oTarget));
             }
-            this._oUrlParsingPromise.then(function (oUrlParsing) {
-                if (oTile.target) {
-                    var oTarget = deepClone(oTile.target);
-                    sHash = oUtilsCdm.toHashFromTarget(readUtils.harmonizeTarget(oTarget), oUrlParsing);
-                }
-                oDeferred.resolve({
-                    tileResolutionResult: oApp,
-                    tileIntent: sHash
-                });
+            oDeferred.resolve({
+                tileResolutionResult: oApp,
+                tileIntent: sHash
             });
         }
 
@@ -504,8 +497,8 @@ sap.ui.define([
      *  the first inbound object
      */
     AdapterBase.prototype._getFirstInbound = function (oAppDescriptor) {
-        var sFirstInboundKey = Object.keys(oAppDescriptor["sap.app"].crossNavigation.inbounds).shift(),
-            oInbound = oAppDescriptor["sap.app"].crossNavigation.inbounds[sFirstInboundKey];
+        var sFirstInboundKey = Object.keys(oAppDescriptor["sap.app"].crossNavigation.inbounds).shift();
+        var oInbound = oAppDescriptor["sap.app"].crossNavigation.inbounds[sFirstInboundKey];
 
         return {
             key: sFirstInboundKey,
@@ -548,15 +541,14 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype._allPromisesDone = function (aPromises) {
-        var oDeferred = new jQuery.Deferred(),
-            oDeferredAlways;
+        var oDeferred = new jQuery.Deferred();
 
         if (aPromises.length === 0) {
             oDeferred.resolve([]);
         } else {
             // "replace" aPromises with an array of promises which will always resolve.
             var aNoneFailingPromises = aPromises.map(function (oPromise) {
-                oDeferredAlways = new jQuery.Deferred();
+                var oDeferredAlways = new jQuery.Deferred();
                 oPromise.always(oDeferredAlways.resolve.bind(oDeferredAlways));
                 return oDeferredAlways.promise();
             });
@@ -592,8 +584,8 @@ sap.ui.define([
             oMessagesByLogLevel[oLogLevel[sLevelKey]] = "";
         });
 
-        Object.keys(oFailedResolvedTiles).forEach(function (sFailuredKey) {
-            var oFailureInfo = oFailedResolvedTiles[sFailuredKey];
+        Object.keys(oFailedResolvedTiles).forEach(function (sKey) {
+            var oFailureInfo = oFailedResolvedTiles[sKey];
             if (oFailureInfo.logLevel) {
                 oMessagesByLogLevel[oFailureInfo.logLevel] =
                     oMessagesByLogLevel[oFailureInfo.logLevel].concat(oFailureInfo.message).concat("\n");
@@ -795,7 +787,7 @@ sap.ui.define([
      *      },
      *      indicatorDataSource : {
      *          // relative path:
-     *          "path" : "Foo$fitler=startswith(lastName, 'A') eq true",
+     *          "path" : "Foo$filter=startswith(lastName, 'A') eq true",
      *          "refresh" : 10
      *      },
      *  }
@@ -805,7 +797,7 @@ sap.ui.define([
      *  {
      *      indicatorDataSource : {
      *          // absolute path:
-     *          "path" : "/sap/opu/odata/snce/SRV/Foo$fitler=startswith(lastName, 'A') eq true",
+     *          "path" : "/sap/opu/odata/snce/SRV/Foo$filter=startswith(lastName, 'A') eq true",
      *          "refresh" : 10
      *      },
      *  }
@@ -822,7 +814,7 @@ sap.ui.define([
      *          }
      *      },
      *      indicatorDataSource : {
-     *          "path" : "Foo$fitler=startswith(lastName, 'A') eq true",
+     *          "path" : "Foo$filter=startswith(lastName, 'A') eq true",
      *          "refresh" : 10
      *      },
      *  }
@@ -832,9 +824,8 @@ sap.ui.define([
      */
     AdapterBase.prototype.getTileIndicatorDataSource = function (oTile) {
         // TODO works in all cases? e.g. for tiles added via addTile?
-        var oResolvedTile = this._mResolvedTiles[oTile.id],
-            oResult = {},
-            oResolutionResult;
+        var oResolvedTile = this._mResolvedTiles[oTile.id];
+        var oResult = {};
 
         // Reuse explicit information set by the user via bookmark service
         if (oTile.indicatorDataSource) {
@@ -851,16 +842,15 @@ sap.ui.define([
         }
 
         // Respond with ...
-        oResolutionResult = oResolvedTile.tileResolutionResult;
+        var oResolutionResult = oResolvedTile.tileResolutionResult;
         if (oResolutionResult.indicatorDataSource) {
-
             // ... indicator data source
             oResult.indicatorDataSource = deepExtend({}, oResolutionResult.indicatorDataSource);
 
             // ... and related data source (if given)
             if (oResolutionResult.indicatorDataSource.hasOwnProperty("dataSource")) {
-                var sDataSourceName = oResolutionResult.indicatorDataSource.dataSource,
-                    oDataSources = oResolutionResult.dataSources;
+                var sDataSourceName = oResolutionResult.indicatorDataSource.dataSource;
+                var oDataSources = oResolutionResult.dataSources;
                 if (oDataSources && oDataSources.hasOwnProperty(sDataSourceName)) {
                     oResult.dataSource = deepExtend({}, oDataSources[sDataSourceName]);
                 } else {
@@ -869,10 +859,9 @@ sap.ui.define([
             }
 
             // Relative URI paths in DataSource and IndicatorDatasource must relate to the component URL, no the HTML page
-            // bust as the tile is not aware of the (applicaiton's) component URL, the mentioned paths need to be adopted.
+            // bust as the tile is not aware of the (application's) component URL, the mentioned paths need to be adopted.
             // BCP: 1880246066
             if (oUshellUtils.getMember(oResolutionResult, "runtimeInformation.componentProperties.url")) {
-
                 var sPathIndicatorDataSource = oUshellUtils.getMember(oResult, "indicatorDataSource.path");
                 var sUriDataSource = oUshellUtils.getMember(oResult, "dataSource.uri");
                 var sUrlComponent = oUshellUtils.getMember(oResolutionResult, "runtimeInformation.componentProperties.url");
@@ -887,9 +876,7 @@ sap.ui.define([
                         oResult.dataSource.uri = oTransformed.uriParent;
                     }
                 }
-
             }
-
         }
 
         return oResult;
@@ -998,8 +985,8 @@ sap.ui.define([
      *  String could be empty.
      */
     AdapterBase.prototype.getTileTarget = function (oTile) {
-        var sTileId = oReadHomePageUtils.getTileId(oTile),
-            oResolvedTile = this._mResolvedTiles[sTileId];
+        var sTileId = oReadHomePageUtils.getTileId(oTile);
+        var oResolvedTile = this._mResolvedTiles[sTileId];
 
         if (oTile.target && oTile.target.url) {
             // this seems to be a URL bookmark tile
@@ -1065,11 +1052,8 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype.getCardManifest = function (oGroupCard) {
-        var oResolutionResult,
-            oResolvedCard = this._mResolvedTiles[oGroupCard.id];
-
-        oResolutionResult = oResolvedCard.tileResolutionResult;
-
+        var oResolvedCard = this._mResolvedTiles[oGroupCard.id];
+        var oResolutionResult = oResolvedCard.tileResolutionResult;
         return oResolutionResult.tileComponentLoadInfo;
     };
 
@@ -1093,14 +1077,14 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype._getTileUiComponentContainer = function (oTile, oResolvedTile, bIsCatalogTile) {
-        var that = this,
-            oResolutionResult,
-            oComponentLoader,
-            sNavigationMode,
-            oTileComponentInstance,
-            oCompContainer,
-            bIsCustomTile,
-            oDeferred = new jQuery.Deferred();
+        var that = this;
+        var oResolutionResult;
+        var oComponentLoader;
+        var sNavigationMode;
+        var oTileComponentInstance;
+        var oCompContainer;
+        var bIsCustomTile;
+        var oDeferred = new jQuery.Deferred();
 
         sap.ushell.Container.getServiceAsync("Ui5ComponentLoader")
             .then(function (oComponentLoaderService) {
@@ -1157,15 +1141,15 @@ sap.ui.define([
 
                 var _tileCreateCompContainer = function () {
                     return oComponentLoader.createComponent({
-                            loadCoreExt: bIsCustomTile, // custom tiles may need modules from core-ext-light
-                            loadDefaultDependencies: false,
-                            componentData: oTileComponentData,
-                            url: oTileComponentProperties.url,
-                            applicationConfiguration: {},
-                            reservedParameters: {},
-                            applicationDependencies: oTileComponentProperties,
-                            ui5ComponentName: oTileComponentProperties.name
-                        },
+                        loadCoreExt: bIsCustomTile, // custom tiles may need modules from core-ext-light
+                        loadDefaultDependencies: false,
+                        componentData: oTileComponentData,
+                        url: oTileComponentProperties.url,
+                        applicationConfiguration: {},
+                        reservedParameters: {},
+                        applicationDependencies: oTileComponentProperties,
+                        ui5ComponentName: oTileComponentProperties.name
+                    },
                         {}, // don't generate an id
                         [], // instantiate directly
                         UI5ComponentType.Visualization
@@ -1264,9 +1248,8 @@ sap.ui.define([
      * @private
      */
     AdapterBase.prototype._getTileView = function (oGroupTile) {
-        var oResolvedTile,
-            sErrorMessage,
-            oDeferred = new jQuery.Deferred();
+        var sErrorMessage;
+        var oDeferred = new jQuery.Deferred();
 
         if (typeof oGroupTile !== "object" || !oGroupTile.id) {
             sErrorMessage = "Invalid input parameter passed to _getTileView: " + oGroupTile;
@@ -1274,8 +1257,7 @@ sap.ui.define([
             return oDeferred.reject(sErrorMessage).promise();
         }
 
-        oResolvedTile = this._mResolvedTiles[oGroupTile.id];
-
+        var oResolvedTile = this._mResolvedTiles[oGroupTile.id];
         if (!oResolvedTile) {
             sErrorMessage = "No resolved tile found for tile ID: " + oGroupTile.id;
             Log.error(sErrorMessage);
@@ -1297,19 +1279,18 @@ sap.ui.define([
      * @returns {object}
      * data of tile component
      */
-    // eslint-disable-next-line complexity
     AdapterBase.prototype._createTileComponentData = function (oTile, bIsCatalogTile, oResolutionResult) {
-        var sTitle = bIsCatalogTile ? this.getCatalogTileTitle(oTile) : this.getTileTitle(oTile),
-            sSubTitle = bIsCatalogTile ? this.getCatalogTilePreviewSubtitle(oTile) : this.getTileSubtitle(oTile),
-            sIcon = bIsCatalogTile ? this.getCatalogTilePreviewIcon(oTile) : this.getTileIcon(oTile),
-            sInfo = bIsCatalogTile ? this.getCatalogTilePreviewInfo(oTile) : this.getTileInfo(oTile),
-            sTarget = bIsCatalogTile ? this.getCatalogTileTargetURL(oTile) : this.getTileTarget(oTile),
-            oIndicatorDataSource = this.getTileIndicatorDataSource(oTile),
-            sNumberUnit = oTile.numberUnit || (oResolutionResult.tileResolutionResult && oResolutionResult.tileResolutionResult.numberUnit),
-            oComponentData = {
-                properties: {},
-                startupParameters: {}
-            };
+        var sTitle = bIsCatalogTile ? this.getCatalogTileTitle(oTile) : this.getTileTitle(oTile);
+        var sSubTitle = bIsCatalogTile ? this.getCatalogTilePreviewSubtitle(oTile) : this.getTileSubtitle(oTile);
+        var sIcon = bIsCatalogTile ? this.getCatalogTilePreviewIcon(oTile) : this.getTileIcon(oTile);
+        var sInfo = bIsCatalogTile ? this.getCatalogTilePreviewInfo(oTile) : this.getTileInfo(oTile);
+        var sTarget = bIsCatalogTile ? this.getCatalogTileTargetURL(oTile) : this.getTileTarget(oTile);
+        var oIndicatorDataSource = this.getTileIndicatorDataSource(oTile);
+        var sNumberUnit = oTile.numberUnit || (oResolutionResult.tileResolutionResult && oResolutionResult.tileResolutionResult.numberUnit);
+        var oComponentData = {
+            properties: {},
+            startupParameters: {}
+        };
 
         // Check whether tile is a custom tile
         if (oResolutionResult.tileResolutionResult
@@ -1410,7 +1391,7 @@ sap.ui.define([
      * @returns {string}
      *  ID of respective group tile or catalog tile.
      *  In case the id could not be determined for group tiles,
-     *  <code>undefined<code> is returned.
+     *  <code>undefined</code> is returned.
      */
     AdapterBase.prototype.getCatalogTileId = function (oGroupTileOrCatalogTile) {
         if (this._isGroupTile(oGroupTileOrCatalogTile)) {
@@ -1421,7 +1402,6 @@ sap.ui.define([
             // for bookmarks group tiles the target url corresponds to the id of the catalog tile
             if (oGroupTileOrCatalogTile.isBookmark
                 && ObjectPath.get("target.url", oGroupTileOrCatalogTile)) {
-
                 return oGroupTileOrCatalogTile.target.url;
             }
 
@@ -1514,8 +1494,8 @@ sap.ui.define([
      */
     AdapterBase.prototype.getCdmVersionsSupported = function () {
         return {
-            min: Version("3.0.0"),
-            max: Version("3.1.0")
+            min: new Version("3.0.0"),
+            max: new Version("3.1.0")
         };
     };
 
@@ -1532,8 +1512,8 @@ sap.ui.define([
     AdapterBase.prototype.isSiteSupported = function (oSite) {
         // Check if site has the expected CDM version
         if (!oSite._version ||
-            Version(oSite._version).compareTo(this.getCdmVersionsSupported().min) < 0 ||
-            Version(oSite._version).compareTo(this.getCdmVersionsSupported().max) > 0) {
+            new Version(oSite._version).compareTo(this.getCdmVersionsSupported().min) < 0 ||
+            new Version(oSite._version).compareTo(this.getCdmVersionsSupported().max) > 0) {
             Log.fatal("Invalid CDM site version: Only version 3.0.0 is supported");
             return false;
         }
@@ -1552,4 +1532,4 @@ sap.ui.define([
     };
 
     return AdapterBase;
-}, /* bExport = */ false);
+});