@sapui5/sap.suite.ui.generic.template 1.128.0 → 1.129.0

package/src/sap/suite/ui/generic/template/lib/insights/InsightsHandler.js

@@ -5,17 +5,17 @@ sap.ui.define([
     "sap/suite/ui/generic/template/lib/insights/InsightsCardHelper",
     "sap/suite/ui/generic/template/lib/cards/DTCardHelper",
     "sap/base/util/merge",
-    "sap/base/util/deepClone"
-], function(BaseObject, extend, MessageBox, InsightsCardHelper, DTCardHelper, merge, deepClone) {
+    "sap/base/util/deepClone",
+	"sap/suite/ui/generic/template/genericUtilities/FeLogger"
+], function(BaseObject, extend, MessageBox, InsightsCardHelper, DTCardHelper, merge, deepClone, FeLogger) {
     'use strict';
     function getMethods(oState, oController, oTemplateUtils) {
-
+        var oLogger = new FeLogger("lib.InsightsHandler").getLogger();
         var oTemplatePrivateModel = oTemplateUtils.oComponentUtils.getTemplatePrivateModel();
         var oTemplatePrivateGlobalModel = oTemplateUtils.oComponentUtils.getTemplatePrivateGlobalModel();
         var oInsightsInstance = oTemplatePrivateGlobalModel.getProperty("/generic/insights/oInsightsInstance");
         /**
          * This function can be called by any InsightsHandler instance to add the card that the user wants to share
-         * @param {*} oInsightsCardProvider single insight instance which is shared across the application
          * @param {string} sType card type that will be provided by the component (LR/ALP/OP)
          * @param {*} oPresentationControlHandler
          * @returns {Promise<Array<object>>}
@@ -60,37 +60,31 @@ sap.ui.define([
 
             // updating the same card to the global model so that the additional details can be used when card detail is requested from a card consumer.
             var oShareCardInfo = deepClone(oCardInfo);
-
-            var fnGetCardInfoPromise = new Promise(function (fnResolve) {
-                if (sType === InsightsCardHelper.CardTypes.DT_CARD) {
-                    oState.oDTCardHelper.getCardManifest(DTCardHelper.CardTypes.INTEGRATION)
-                    .then(function (oCardManifest) {
-                        if (!oCardManifest) {
-                            fnResolve(null);
-                            return;
-                        }
-                        oShareCardInfo.descriptorContent = merge(
-                            oShareCardInfo.descriptorContent,
-                            oCardManifest
-                        );
-                        fnResolve(oShareCardInfo);
-                    })
-                    .catch(function (oError) {
-                        fnResolve(null);
-                    });
-                } else {
-                    fnResolve(oShareCardInfo);
-                }
-            });
-            return fnGetCardInfoPromise.then(function (oShareCardInfo) {
-                if (oShareCardInfo) {
+            let oGetCardInfoPromise = Promise.resolve(oCardInfo);
+            if (sType === InsightsCardHelper.CardTypes.DT_CARD) {
+                oGetCardInfoPromise = fnFetchDTCardManifest();
+            }
+            return oGetCardInfoPromise.then(function (oCardInfo) {
+                const aShareCardInfo = [];
+                if (oCardInfo) {
                     oShareCardInfo.cardType = sType;
                     oShareCardInfo.viewId = sViewId;
                     oTemplatePrivateGlobalModel.setProperty("/generic/insights/shareCards/" + iViewLevel, [oShareCardInfo]);
+                    aShareCardInfo.push(oShareCardInfo);
                 }
-                return oShareCardInfo ? [oCardInfo] : [];
+                return aShareCardInfo;
             });
-            
+        }
+
+        async function fnFetchDTCardManifest() { 
+            let oCardManifest;
+            try {
+                oCardManifest = await oState.oDTCardHelper.getCardManifest(DTCardHelper.CardTypes.INTEGRATION) || null;
+            } catch (error) {
+                oLogger.error("Error while fetching the DT Card manifest", error);
+            } finally {
+                return oCardManifest;
+            }
         }
 
         function isCardCreationAllowed(oState) {
@@ -140,13 +134,24 @@ sap.ui.define([
                 oPresentationControlHandler = oTemplateUtils.oServices.oPresentationControlHandlerFactory.getPresentationControlHandler(oState.oSmartChart);
             } else if (oCard.cardType === InsightsCardHelper.CardTypes.DT_CARD) {
                 var sEntitySet = oComponent.getEntitySet();
+                var  oClonedCard = deepClone(oCard);
                 var oMetaModel = oComponent.getModel().getMetaModel();
-                
 
                 var oInsightsCardProvider = oTemplateUtils.oServices.oInsightsFECardProvider.getCardProviderInsightsInstance();
-                oInsightsCardProvider.channel.publishCard(oInsightsCardProvider.id, oCard, mAdditionalProperties.consumerId);
+
+                // Fetch the DT Card manifest
+                fnFetchDTCardManifest()
+                    .then(function (oCardManifest) {
+                        if (!oCardManifest) {
+                            return;
+                        }
+                        oClonedCard.descriptorContent = merge(
+                            oClonedCard.descriptorContent,
+                            oCardManifest
+                        );
+                        oInsightsCardProvider.channel.publishCard(oInsightsCardProvider.id, oClonedCard, mAdditionalProperties.consumerId);
+                    });
                 return;
-                
             } else {
                 oPresentationControlHandler = oPresentationControlHandler || oState.oPresentationControlHandler;
             }

package/src/sap/suite/ui/generic/template/lib/navigation/NavigationController.js

@@ -77,9 +77,10 @@ sap.ui.define(["sap/ui/base/Object",
 	"sap/suite/ui/generic/template/lib/navigation/startupParameterHelper",
 	"sap/suite/ui/generic/template/lib/TemplateComponent",
 	"sap/base/strings/whitespaceReplacer",
-	"sap/m/IllustratedMessageType"
+	"sap/m/IllustratedMessageType",
+	"sap/ui/util/openWindow"
 ], function(BaseObject, extend, isEmptyObject, HashChanger, History, coreLibrary, controlHelper, FeLogger, jsonHelper, oDataModelHelper, ProcessObserver, Queue, testableHelper, CRUDHelper, MessageUtils, routingHelper, startupParameterHelper,
-			TemplateComponent, whitespaceReplacer, IllustratedMessageType) {
+			TemplateComponent, whitespaceReplacer, IllustratedMessageType, openWindow) {
 	"use strict";
 	var	sClassName = "lib.navigation.NavigationController";
 	var oLogger = new FeLogger(sClassName).getLogger();
@@ -356,6 +357,7 @@ sap.ui.define(["sap/ui/base/Object",
 			} else {
 				fnInitializeRouter();	
 			}
+			
 			return Promise.all(aStartupPromises);
 		}
 
@@ -1674,6 +1676,67 @@ sap.ui.define(["sap/ui/base/Object",
 			oTemplateContract.oBusyHelper.setBusy(oRet, undefined, undefined, oTargetIdentityInfo.willShowPlaceholder);
 			return oRet;
 		}
+
+		// Opens the context in new tab
+		function fnOpenContextInNewTab(oSourceNode, oNavigationContext) {
+			var oTargetIdentityInfo = getTargetIdentityInfoForContext({ treeNode: oSourceNode }, oNavigationContext, true, false);
+			var oTargetIdentityPromise = oTargetIdentityInfo.promise;
+			return oTargetIdentityPromise.then(function(oTargetIdentity){
+				// Construct the query params
+				var mQueryParameters = {};
+				// In case FCL layout is supported by app, the target context should be opened in full screen mode.
+				// So, calculate the full screen layout type and add it as a query param.
+				var sFCLLayout = oTemplateContract.oFlexibleColumnLayoutHandler && oTemplateContract.oFlexibleColumnLayoutHandler.getFullscreenLayout(oTargetIdentity.treeNode.fCLLevel);
+				if (sFCLLayout) {
+					mQueryParameters["FCLLayout"] = sFCLLayout;
+				}
+				// Get the route information from target identity
+				var oRouterInput = fnGetRouterInput(oTargetIdentity.treeNode, oTargetIdentity.keys, mQueryParameters);
+				// Construct the app specific route URL from route name and parameters
+				var sTargetAppSpecificRoute = oNavigationControllerProxy.oRouter.getURL(oRouterInput.route, oRouterInput.parameters);
+				// Add the prefix
+				var sRoutePrefix = sTargetAppSpecificRoute.startsWith("/") ? "&" : "&/";
+				sTargetAppSpecificRoute = sRoutePrefix + sTargetAppSpecificRoute;
+				// Construct the fully qualified URL updated with the target app route
+				return fnConstructUrlFromRoute(sTargetAppSpecificRoute);
+			}).then(function (sTargetUrl) {
+				// Open the URL in new tab/window
+				openWindow(sTargetUrl);
+			}).catch(function (oError) {
+				oLogger.error("Error while opening the context '" + oNavigationContext.getPath() + "' in a new tab: " + oError);
+			});
+		}
+
+		// Constructs the fully qualified URL with the given app specific route.
+		function fnConstructUrlFromRoute(sTargetAppSpecificRoute) {
+			var UShellContainer = sap.ui.require("sap/ushell/Container");
+
+			if (!UShellContainer) {
+				return Promise.reject("Unable to proceed as 'sap/ushell/Container' is not found!");
+			}
+			//Encode the route
+			sTargetAppSpecificRoute = encodeURI(sTargetAppSpecificRoute);
+			
+			var oUrlParsingPromise = UShellContainer.getServiceAsync("URLParsing");
+			var oFLPUrlPromise = UShellContainer.getFLPUrlAsync(true);
+			return Promise.all([oUrlParsingPromise, oFLPUrlPromise]).then(function (aResults) {
+				var oUrlParser = aResults[0];
+				var sFLPUrl = aResults[1];
+
+				// Construct URL object from FLP URL
+				var oFLPUrl = new URL(sFLPUrl);
+				// Get the hash from URL object
+				var sHash = oFLPUrl.hash;
+				// Parse the hash and update "appSpecificRoute" with "sTargetAppSpecificRoute"
+				var oHash = oUrlParser.parseShellHash(sHash);
+				oHash.appSpecificRoute = sTargetAppSpecificRoute;
+				// Then, reconstruct the hash with updated value.
+				sHash = oUrlParser.constructShellHash(oHash);
+				// Update the hash on the FLP URL and reconstruct the URL
+				oFLPUrl.hash = sHash;
+				return oFLPUrl.toString();
+			});
+		}
 		
 		// This function is called when only tables could be found as focus target for the message oMessage.
 		// sFullTarget is one of the full targets defined for this message.
@@ -2117,6 +2180,25 @@ sap.ui.define(["sap/ui/base/Object",
 			}) : Promise.reject();
 		}
 
+		/**
+		 * Calls state changer per each (template) component on url change.
+		 * @param {Array<sap.suite.ui.generic.template.lib.StatePreserver>} aStateChangers array of StatePreserver instances
+		 * @param {map} appStates map of appStates
+		 * @param {boolean} bIsFCLMode optional, defined only in FLC
+		 * @returns {boolean} returns true if url change can be handled by state changer,
+		 * 	returns false in FCL, so the route-matched logic will continue as normal.
+		 */
+		function fnGetIsStateChange(aStateChangers, appStates, bIsFCLMode) {
+			var bIsStateChangeResult = false;
+			for (var i = 0; i < aStateChangers.length; i++){
+				var oStateChanger = aStateChangers[i];
+				if (oStateChanger.isStateChange(appStates)){
+					bIsStateChangeResult = bIsFCLMode ? false : true;
+				}
+			}
+			return bIsStateChangeResult;
+		}
+
 		// Start: Handling url-changes
 		/*
 		 * calls onActivate on the specified view, if it exists
@@ -2398,16 +2480,11 @@ sap.ui.define(["sap/ui/base/Object",
 				fnNavigate(sTargetHash, true);
 				return; // fnHandleRouteMatched will be called with the new url, so leave further processing to that call
 			}
+			// State changers can interfere in FCL, for example between LR and OP when the search query is updated. In particular, it is necessary to skip the early return in FCL and display an error in case of 404.
+			// The last parameter will still trigger state changers (with possible side effects), but will never return true as a result.
+			var bIsStateChange = fnGetIsStateChange(oTemplateContract.aStateChangers, oCurrentIdentity.appStates, !!oTemplateContract.oFlexibleColumnLayoutHandler);
 			// State changers may identify the hash change as something which can be handled by them internally. In this case we do not need to run the whole mechanism.
 			// Since isStateChange is allowed to have side-effects we call all StateChangers.
-			var bIsStateChange = false;
-			for (var i = 0; i < oTemplateContract.aStateChangers.length; i++){
-				var oStateChanger = oTemplateContract.aStateChangers[i];
-				if (oStateChanger.isStateChange(oCurrentIdentity.appStates)){
-					bIsStateChange = true;
-				}
-			}
-
 			if (bIsStateChange){
 				oRoutingOptions = null;
 				oCurrentHash.hash = sHash;
@@ -2983,14 +3060,15 @@ sap.ui.define(["sap/ui/base/Object",
 		oNavigationControllerProxy.userHasAcceptedDataLoss = fnUserHasAcceptedDataLoss;
 		oNavigationControllerProxy.unwantedDataLossPossible = fnUnwantedDataLossPossible;
 		oNavigationControllerProxy.isBackLeavingTheEditScope = isBackLeavingTheEditScope;
-
+		oNavigationControllerProxy.openContextInNewTab = fnOpenContextInNewTab;
 		// Make private function accessible to unit tests
 		/* eslint-disable */
 		var fnCreateTemplateComponent = testableHelper.testable(fnCreateTemplateComponent, "createTemplateComponent");
 		var getParsedShellHashFromFLP = testableHelper.testable(getParsedShellHashFromFLP, "getParsedShellHashFromFLP");
 		var fnPreloadComponent = testableHelper.testable(fnPreloadComponent, "preloadComponent");
 		var fnGetRouteInfoByHash = testableHelper.testable(fnGetRouteInfoByHash, "getRouteInfoByHash");
-		
+		var fnGetIsStateChange = testableHelper.testable(fnGetIsStateChange, "getIsStateChange");
+
 		// Note: Function createHostView will be added by routingHelper.
 		// Allow to mock this by unit tests
 		testableHelper.testable(function(fnCreateHostView){
@@ -3087,7 +3165,7 @@ sap.ui.define(["sap/ui/base/Object",
 	 * @param {sap.suite.ui.generic.template.lib.AppComponent} oAppComponent The AppComponent instance
 	 * @public
 	 * @extends sap.ui.base.Object
-	 * @version 1.128.0
+	 * @version 1.129.0
 	 * @since 1.30.0
 	 * @alias sap.suite.ui.generic.template.lib.NavigationController
 	 */

package/src/sap/suite/ui/generic/template/library.js

@@ -62,7 +62,7 @@ sap.ui.define([
 		interfaces: [],
 		controls: [],
 		elements: [],
-		version: "1.128.0",
+		version: "1.129.0",
 		extensions: {
 			//Configuration used for rule loading of Support Assistant
 			"sap.ui.support": {

package/src/sap/suite/ui/generic/template/listTemplates/fragments/DetailSmartTable.fragment.xml

@@ -256,7 +256,9 @@
 													</ColumnListItem>
 												</items>
 												<contextMenu>
-													<core:Fragment fragmentName="sap.suite.ui.generic.template.fragments.SmartControlContextMenu" type="XML"/>
+													<template:with path="entitySet>" var="listEntitySet">
+														<core:Fragment fragmentName="sap.suite.ui.generic.template.fragments.SmartControlContextMenu" type="XML"/>
+													</template:with>
 												</contextMenu>
 												<dependents>
 													<plugins.ContextMenuSetting scope="Selection"/>

package/src/sap/suite/ui/generic/template/manifestMerger/ChangePageConfiguration.js

@@ -13,13 +13,34 @@ sap.ui.define([
     * @private
     */
 
+    /**
+     * @typedef {Object} ChangeContent
+     * 
+     * @property {object} parentPage - The parent page details
+     * @property {string} parentPage.component - The source page component where the new page will be added
+     * @property {string} parentPage.entitySet - The source page entityset name where the new page will be added
+     * 
+     * @property {object} entityPropertyChange - The details of the configuration to be changed
+     * @property {string} entityPropertyChange.propertyPath - The property path where the change has to be added
+     * @property {string} entityPropertyChange.operation - The operation type
+     * @property {object} entityPropertyChange.propertyValue - The property details that has to be modified
+     * 
+     */
+    
+    /**
+     * @typedef {Object} Change
+     * @property {string} changeType - The app descriptor change type name
+     * @property {string} layer - The target layer, can have values "CUSTOMER", "CUSTOMER_BASE", "PARTNER" or "VENDOR"
+     * @property {() => ChangeContent} getContent - The content of the change
+     */
+    var GLOBAL_MANIFEST_CHANGE_COMPONENT = "sap.suite.ui.generic.template";
     var changePageConfiguration = {
         /**
          * @param {object} oManifest - Contains the existing Manifest of the application
-         * @param {object} oChange - Contains the setting changes that the user wants to add to the oManifest
+         * @param {Change} oChange - Contains the setting changes that the user wants to add to the oManifest
          * The oChange for changePageConfiguration should have the following structure:
-         *
-         *  {
+         * @example 
+         * {
          *      "changeType": "appdescr_ui_generic_app_changePageConfiguration", // the app descriptor change type name
          *      "layer": Layer.CUSTOMER, // The target layer, can have values  "CUSTOMER" , "CUSTOMER_BASE", "PARTNER" or "VENDOR"
          *      "content": {
@@ -28,7 +49,7 @@ sap.ui.define([
          *              "entitySet": "C_STTA_SalesOrder_WD_20" // source page entityset name where the new page will be added
          *          },
          *          "entityPropertyChange": { // details of the configuration to be changed
-         *              "propertyPath": "component/settings", // property pth where the change has to be added
+         *              "propertyPath": "component/settings", // property path where the change has to be added
          *              "operation": "UPSERT", // operation type 
          *              "propertyValue": { // contains the property details that has to be modified
          *                  "tableType": "ResponsiveTable"
@@ -36,6 +57,25 @@ sap.ui.define([
          *          }
          *      }
          *  }
+         * 
+         * @example 
+         * {
+         *      "changeType": "appdescr_ui_generic_app_changePageConfiguration", // the app descriptor change type name
+         *      "layer": Layer.VENDOR, // The target layer, can have values  "CUSTOMER" , "CUSTOMER_BASE", "PARTNER" or "VENDOR"
+         *      "content": {
+         *          "parentPage" : { // source page details
+         *              "component": "sap.suite.ui.generic.template", // This is the global manifest change
+         *          },
+         *          "entityPropertyChange": { // details of the configuration to be changed
+         *              "propertyPath": "settings", // property path where the change has to be added
+         *              "operation": "UPSERT", // operation type 
+         *              "propertyValue": { // contains the property details that has to be modified
+         *                  "statePreservationMode": "persistence"
+         *              }
+         *          }
+         *      }
+         *  }
+         * 
          * @returns {object} the updated oManifest containing the oChange settings
          * @protected
          */
@@ -45,9 +85,13 @@ sap.ui.define([
             MergerUtil.consistencyCheck(oChangeContent, "MODIFY");
             var sParentEntitySet = oChangeContent.parentPage.entitySet;
             var sParentComponent = oChangeContent.parentPage.component;
-            var oPageStructure = MergerUtil.iterateAndFind(oManifest["sap.ui.generic.app"],sParentEntitySet, sParentComponent);
+            var oPageStructure;
+            if (sParentComponent === GLOBAL_MANIFEST_CHANGE_COMPONENT) {
+                oPageStructure = oManifest["sap.ui.generic.app"];
+            } else {
+                oPageStructure = MergerUtil.iterateAndFind(oManifest["sap.ui.generic.app"], sParentEntitySet, sParentComponent);
+            }
             var oPropertyChange = oChangeContent.entityPropertyChange;
-            
             var aPropertyKeys = Object.keys(oPropertyChange.propertyValue);
             aPropertyKeys.forEach(function(sCurrentKey) {
                 var aPropertyPath = oPropertyChange.propertyPath.split("/");

package/src/sap/suite/ui/generic/template/manifestMerger/MergerUtil.js

@@ -9,6 +9,7 @@ sap.ui.define([
     * This class holds the helper functions that are invoked from the manifestMergers
     * @private
     */
+    var GLOBAL_MANIFEST_CHANGE_COMPONENT = "sap.suite.ui.generic.template";
     var mergerUtil = {
 
         /** 
@@ -74,12 +75,12 @@ sap.ui.define([
             if (!oChangeContent["parentPage"]) {
                 throw new Error("Mandatory 'parentPage' parameter is not provided.");
             }
-            if (!oChangeContent.parentPage.entitySet) {
-                throw new Error("Mandatory 'parentPage.entitySet' parameter is not provided.");
-            }
             if (!oChangeContent.parentPage.component) {
                 throw new Error("Mandatory 'parentPage.component' parameter is not provided.");
             }
+            if (!oChangeContent.parentPage.entitySet && oChangeContent.parentPage.component !== GLOBAL_MANIFEST_CHANGE_COMPONENT) {
+                throw new Error("Mandatory 'parentPage.entitySet' parameter is not provided.");
+            }
             if (sMergerType === "ADD") {
 
                 if (!oChangeContent.childPage.id) {

package/src/sap/suite/ui/generic/template/themes/base/ObjectPage.less

@@ -389,3 +389,7 @@ html[dir="rtl"] .sapSmartTemplatesObjectPage .sapSmartTemplatesObjectPageSubSect
 .sapSmartTemplatesObjectPageHeaderFormObjectStatus{
   line-height: 1.320rem !important;
 }
+
+.sapSmartTemplatesObjectPageHeaderFormField .sapMObjStatusText {
+  line-height: 1.320rem !important;
+}