@sapui5/sap.suite.ui.generic.template 1.131.1 → 1.133.0

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

@@ -11,16 +11,18 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 	"sap/ui/core/library",
 	"sap/suite/ui/generic/template/genericUtilities/metadataAnalyser",
 	"sap/ui/base/ManagedObject",
-	"sap/suite/ui/generic/template/lib/SideEffectUtil",
 	"sap/base/util/isEmptyObject",
 	"sap/suite/ui/generic/template/js/RuntimeFormatters"// just to make sure that it is loaded
 ], function (AnnotationHelperModel, AnnotationHelperModelBasics, SmartField, FeLogger, formatMessage, deepExtend, StableIdHelper, utils, Device,
-	SapMLibrary, SapCoreLibrary, metadataAnalyser, ManagedObject, SideEffectUtil, isEmptyObject) {
+	SapMLibrary, SapCoreLibrary, metadataAnalyser, ManagedObject, isEmptyObject) {
 	"use strict";
 
 	// shortcut for sap.ui.core.ValueState
 	var ValueState = SapCoreLibrary.ValueState;
 
+	// shortcut for sap.m.OverflowToolbarPriority
+	var OverflowToolbarPriority = SapMLibrary.OverflowToolbarPriority;
+
 	var oLogger = new FeLogger("js.AnnotationHelper").getLogger();
 
 	function fnGetFallbackId(oFacet) {
@@ -351,20 +353,20 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 			return false;
 		},
 
-		getValueListReadOnly: function (oInterface, sEntityType, oDataField) {
+		getValueListReadOnly: function (oInterface, vEntityType, oDataField) {
 			var oMetaModel = oInterface.getInterface(1).getModel();
 			var sPath = oInterface.getInterface(1).getPath() + '/Value';
 			var sTargetPropertyPath = AnnotationHelperModel.resolvePath(oMetaModel.getContext(sPath));
-			var oDataFieldValue = oMetaModel.getObject(sTargetPropertyPath);
-			if (oDataFieldValue['com.sap.vocabularies.UI.v1.TextArrangement']) {
+			var oDataFieldValue = sTargetPropertyPath && oMetaModel.getObject(sTargetPropertyPath);
+			if (oDataFieldValue?.['com.sap.vocabularies.UI.v1.TextArrangement']) {
 				// case 1 - text arrangement defined at property level
 				return oDataFieldValue['com.sap.vocabularies.UI.v1.TextArrangement'].EnumMember !== 'com.sap.vocabularies.UI.v1.TextArrangementType/TextSeparate';
-			} else if (oDataFieldValue['com.sap.vocabularies.Common.v1.Text']) {
+			} else if (oDataFieldValue?.['com.sap.vocabularies.Common.v1.Text']) {
 				// case 2 - text arrangement defined for property via sap:text
 				return true;
 			} else {
 				// case 3 - text arrangement defined at entity level
-				var oEntityType = oMetaModel.getODataEntityType(sEntityType);
+				var oEntityType = typeof vEntityType === "object" ? vEntityType : oMetaModel.getODataEntityType(vEntityType); // vEntityType can be object or string.
 				if (oEntityType['com.sap.vocabularies.UI.v1.TextArrangement']) {
 					return oEntityType['com.sap.vocabularies.UI.v1.TextArrangement'].EnumMember !== 'com.sap.vocabularies.UI.v1.TextArrangementType/TextSeparate';
 				}
@@ -385,9 +387,6 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 		getCustomDataForContactPopup: function (oContactDetails) {
 			return ((JSON.stringify(oContactDetails)).replace(/\}/g, "\\}").replace(/\{/g, "\\{")); //check bindingParser.escape
 		},
-		getPropsForLinkFields: function(oEntitySet, oTarget, sFieldName) {
-			return SideEffectUtil.getPropsForLinkFields(oEntitySet, oTarget, sFieldName);
-		},
 		checkIsEmailAddress: function (oInterface, sEntityType, oDataField) {
 			var oMetaModel = oInterface.getInterface(1).getModel();
 			var sPath = oInterface.getInterface(1).getPath() + '/Value';
@@ -1093,21 +1092,21 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 		// builds the expression for the Rating Indicator Subtitle
 		buildRatingIndicatorSubtitleExpression: function (mSampleSize) {
 			if (mSampleSize) {
-				return "{parts: [{path: '" + mSampleSize.Path + "'}], formatter: 'formatRatingIndicatorSubTitle'}";
+				return "{parts: [{path: '" + mSampleSize.Path + "'}], formatter: 'RuntimeFormatters.formatRatingIndicatorSubTitle.bind($control)'}";
 			}
 		},
 
 		// builds the expression for the Rating Indicator footer
 		buildRatingIndicatorFooterExpression: function (mValue, mTargetValue) {
 			if (mTargetValue) {
-				return "{parts: [{path: '" + mValue.Path + "'}, {path: '" + mTargetValue.Path + "'}], formatter: 'formatRatingIndicatorFooterText'}";
+				return "{parts: [{path: '" + mValue.Path + "'}, {path: '" + mTargetValue.Path + "'}], formatter: 'RuntimeFormatters.formatRatingIndicatorFooterText.bind($control)'}";
 			}
-			return "{parts: [{path: '" + mValue.Path + "'}], formatter: 'formatRatingIndicatorFooterText'}";
+			return "{parts: [{path: '" + mValue.Path + "'}], formatter: 'RuntimeFormatters.formatRatingIndicatorFooterText.bind($control)'}";
 		},
 
 		// builds the expression for the Rating Indicator aggregate Count
 		buildRatingIndicatorAggregateCountExpression: function (mValue) {
-			return "{parts: [{path: '" + mValue.Path + "'}], formatter: 'formatRatingIndicatorAggregateCount'}";
+			return "{parts: [{path: '" + mValue?.Path + "'}], formatter: 'RuntimeFormatters.formatRatingIndicatorAggregateCount.bind($control)'}";
 		},
 
 		getIdForMoreBlockContent: function (oFacet) {
@@ -1231,7 +1230,7 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 			if (oImageUrl.Path) {
 				var sPrefix = "{parts: [{path: '" + oImageUrl.Path + "'}, {value: '" + sAppComponentName + "'}";
 				var sInfix = bSuppressIcons ? ", {value: true}" : "";
-				var sPostfix = "], formatter: 'formatImageUrl'}";
+				var sPostfix = "], formatter: 'RuntimeFormatters.formatImageUrl.bind($control)'}";
 				return sPrefix + sInfix + sPostfix;
 			}
 			// Apply
@@ -1265,7 +1264,7 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 		},
 
 		formatHeaderImage: function (oInterface, oHeaderInfo, sAppComponentName) {
-			return oAnnotationHelper.formatImageOrTypeUrl(oInterface, oHeaderInfo.ImageUrl, oHeaderInfo.TypeImageUrl, sAppComponentName, true);
+			return oAnnotationHelper.formatImageOrTypeUrl(oInterface, oHeaderInfo?.ImageUrl, oHeaderInfo?.TypeImageUrl, sAppComponentName, true);
 		},
 
 		getPathWithExpandFromHeader: function (oInterface, oEntitySet, sNavigationProperty, oInputImageUrl, oTypeImageUrl) {
@@ -2639,7 +2638,7 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 		getColumnListItemType: function (oListEntitySet, aSubPages, oManifest, oTreeNode, bIsDraftEnabled, sAnnotationPath) {
 			var bIsRoot = !oTreeNode.level; // information, whether we are on the root page
 			// check for special feature: navigation from list report to object page via navigationProperty
-			var bIsListWithNavigationProperty = bIsRoot && aSubPages.some(function (oSubPage) {
+			var bIsListWithNavigationProperty = bIsRoot && aSubPages && aSubPages.some(function (oSubPage) {
 				return oSubPage.navigationProperty;
 			});
 			var bAllowsNavigationInEditMode = bIsDraftEnabled || bIsRoot; // in non-draft mode forward navigation is disabled in edit mode
@@ -2945,19 +2944,13 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 			return sTextArrangement;
 		},
 
-		getTextArrangementForSmartControl: function (oInterface, oField, refEntitySet, oEntitySet) {
+		getTextArrangementForSmartControl: function (oInterface, oField, oEntitySet) {
 			oInterface = oInterface.getInterface(0);
-			var oEntityType;
 			var oMetaModel = oInterface.getModel();
-
-			if (refEntitySet.name == undefined) {
-				oEntityType = oMetaModel.getODataEntityType(oEntitySet.entityType);
-			} else {
-				oEntityType = oMetaModel.getODataEntityType(refEntitySet.entityType);
-			}
-
+			var oEntityType = oMetaModel.getODataEntityType(oEntitySet.entityType);
+			
 			var sTextArrangement = "descriptionAndId";
-			if (oMetaModel.getODataProperty(oEntityType, oField.Value.Path)) {
+			if (oField?.Value?.Path && oMetaModel.getODataProperty(oEntityType, oField.Value.Path)) {
 				var oPropertyTextModel = oMetaModel.getODataProperty(oEntityType, oField.Value.Path)["com.sap.vocabularies.Common.v1.Text"];
 				// 1. check TextArrangement definition for property
 				if (oPropertyTextModel && oPropertyTextModel["com.sap.vocabularies.UI.v1.TextArrangement"] && oPropertyTextModel["com.sap.vocabularies.UI.v1.TextArrangement"].EnumMember) {
@@ -3267,7 +3260,7 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 
 			sParts = buildPart(oInterface, dataPoint.Value) + ", " + buildPart(oInterface, dataPoint.TargetValue) + ", " + buildPart(oInterface, mUoM);
 
-			var sDisplayValueExpression = "{ parts: [" + sParts + "], formatter: 'formatDisplayValueForProgressIndicator' }";
+			var sDisplayValueExpression = "{ parts: [" + sParts + "], formatter: 'RuntimeFormatters.formatDisplayValueForProgressIndicator.bind($control)' }";
 			return sDisplayValueExpression;
 		},
 
@@ -3740,7 +3733,7 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 			// More precisely: {path: '_templPrivMessage>/'} is included to listen to changes of the Message model
 			// {path: ''} is included to listen to change of the row context. This is in particular important for scrolling in grid tables (recommendation from ui5).
 			// sCriticalityPiece is needed to listen to changes of the criticality property. Note that there is a gap in case the criticality actually should be evaluated from the lineItemQualifier
-			return "{parts: [" + sDraftParts + ", " + sMessageParts + sCriticalityPiece + ", {path: ''}], formatter: 'setInfoHighlight'}";
+			return "{parts: [" + sDraftParts + ", " + sMessageParts + sCriticalityPiece + ", {path: ''}], formatter: 'RuntimeFormatters.setInfoHighlight.bind($control)'}";
 		},
 
 		getDataFieldLabel: function (oInterface, oDataField) {
@@ -3892,12 +3885,14 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 					break;
 				}
 			}
+
+			aConnectedDataFields = aConnectedDataFields || [];
 			for (var j = 0; j < aConnectedDataFields.length; j++) {
 				if (aConnectedDataFields[j].RecordType === "com.sap.vocabularies.UI.v1.DataField" && aConnectedDataFields[j].Value.Path === sDescriptionField) {
 					return "idOnly";
 				}
 			}
-			sTextArrangement = oAnnotationHelper.getTextArrangementForSmartControl(oInterface, oField, {}, oEntitySet);
+			sTextArrangement = oAnnotationHelper.getTextArrangementForSmartControl(oInterface, oField, oEntitySet);
 			return sTextArrangement;
 		},
 
@@ -4380,6 +4375,48 @@ sap.ui.define(["sap/ui/model/odata/AnnotationHelper",
 			var sNavigationPath = AnnotationHelperModel.getNavigationPath(oInterface, vRawValue);
 			var sNavigationPropertyPath = sNavigationPath.replace("{", "").replace("}", "");
 			return sNavigationPropertyPath;
+		},
+
+		/**
+		 * Derives the sap.m.OverflowToolbarPriority from the given importance.
+		 * If the input is High or Medium
+		 *  - Returns OverflowToolbarPriority.High
+		 * If the input is Low
+		 *  - Returns OverflowToolbarPriority.Low
+		 * Otherwise
+		 *  - Returns the default value OverflowToolbarPriority.High
+		 * 
+		 * @param {string} sImportance Importance from annotation (for annotated actions) or manifest (breakout actions).
+		 * The possible importance values
+		 * - High
+		 * - Medium
+		 * - Low
+		 * - com.sap.vocabularies.UI.v1.ImportanceType/High
+		 * - com.sap.vocabularies.UI.v1.ImportanceType/Medium
+		 * - com.sap.vocabularies.UI.v1.ImportanceType/Low
+		 * @returns {sap.m.OverflowToolbarPriority} The priority 
+		 */
+		getToolbarButtonPriorityFromImportance: function (sImportance) {
+			var sPriority = "";
+			// If importance is in "com.sap.vocabularies.UI.v1.ImportanceType/High" format, omit the prefix and just keep "High"
+			if (sImportance && sImportance.includes("/")) {
+				sImportance = sImportance.split("/")[1];
+			}
+			// The enum sap.m.OverflowToolbarPriority only has the values "High", "Low" and it doesn't have "Medium".
+			// So, if the input is "Medium", return the priority "High" (The default priority)
+			switch (sImportance) {
+				case "High":
+				case "Medium":
+					sPriority = OverflowToolbarPriority.High;
+					break;
+				case "Low": 
+					sPriority = OverflowToolbarPriority.Low;
+					break;
+				default:
+					sPriority = OverflowToolbarPriority.High;
+					break;
+			}
+			return sPriority;
 		}
 	};
 	oAnnotationHelper.getBlockForEditableHeaderFacet.requiresIContext = true;

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

@@ -114,6 +114,9 @@ sap.ui.define([
 		getAcceptableMimeTypes: function(oInterface, oEntitySet){
 			var oEntityType = oInterface.getModel(0).getODataEntityType(oEntitySet.entityType);
 			var aAcceptableMediaTypes = oEntityType["Org.OData.Core.V1.AcceptableMediaTypes"];
+			if (!aAcceptableMediaTypes) {
+				return "";
+			}
 			var sAcceptableMimeType = new String();
 			for (var i = 0; i < aAcceptableMediaTypes.length; i++) {
 				sAcceptableMimeType = sAcceptableMimeType.concat(aAcceptableMediaTypes[i].String).concat(",");

package/src/sap/suite/ui/generic/template/js/QuickTemplates/QuickTemplateComponentFactory.js

@@ -1,21 +1,32 @@
 /*global Promise */
 sap.ui.define([
-		"sap/ui/base/Object",
-		"sap/ui/core/UIComponent",
-		"sap/ui/model/resource/ResourceModel",
-		"sap/ui/core/library",
-		"sap/ui/model/json/JSONModel",
-		"sap/ui/generic/app/ApplicationController",
-	    "sap/suite/ui/generic/template/genericUtilities/FeLogger",
-		"sap/base/util/extend",
-		"sap/base/util/deepExtend",
-		"sap/ui/core/mvc/View"
-	],
-	function(BaseObject, UIComponent, ResourceModel, coreLibrary, JSONModel, ApplicationController, FeLogger, extend, deepExtend, View) {
+	"sap/ui/base/Object",
+	"sap/ui/core/UIComponent",
+	"sap/ui/model/resource/ResourceModel",
+	"sap/ui/core/mvc/ViewType",
+	"sap/ui/model/json/JSONModel",
+	"sap/ui/generic/app/ApplicationController",
+	"sap/suite/ui/generic/template/genericUtilities/FeLogger",
+	"sap/base/util/extend",
+	"sap/base/util/deepExtend",
+	"sap/ui/core/mvc/View",
+	"sap/ui/core/Element"
+], function (
+	BaseObject,
+	UIComponent,
+	ResourceModel,
+	ViewType,
+	JSONModel,
+	ApplicationController,
+	FeLogger,
+	extend,
+	deepExtend,
+	View,
+	Element
+) {
 		"use strict";
 
 		var oLogger = new FeLogger("js.QuickTemplates.QuickTemplateComponentFactory").getLogger();
-		var ViewType = coreLibrary.mvc.ViewType;
 
 		var factory = BaseObject.extend("sap.suite.ui.generic.template.js.QuickTemplates.QuickTemplateComponentFactory");
 
@@ -82,7 +93,7 @@ sap.ui.define([
 
 					var sStableId = fnDetermineStableViewID(this);
 
-					oView = sap.ui.getCore().byId(sStableId);
+					oView = Element.getElementById(sStableId);
 					if (oView) {
 						oLogger.warning("View with ID: " + sStableId + " already exists - old view is getting destroyed now!");
 						try {

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

@@ -1,5 +1,24 @@
-sap.ui.define(["sap/ui/core/format/NumberFormat", "sap/ui/core/message/MessageType", "sap/suite/ui/generic/template/genericUtilities/FeLogger", "sap/suite/ui/generic/template/genericUtilities/testableHelper", "sap/suite/ui/generic/template/genericUtilities/utils"
-	], function (NumberFormat, MessageType, FeLogger, testableHelper, utils) {
+sap.ui.define([
+	"sap/base/i18n/Formatting", 
+	"sap/ui/core/Locale",
+	"sap/ui/core/format/DateFormat",
+	"sap/ui/core/format/NumberFormat", 
+	"sap/ui/core/message/MessageType", 
+	"sap/m/RatingIndicator",
+	"sap/suite/ui/generic/template/genericUtilities/FeLogger", 
+	"sap/suite/ui/generic/template/genericUtilities/testableHelper", 
+	"sap/suite/ui/generic/template/genericUtilities/utils"
+], function (
+	Formatting,
+	Locale,
+	DateFormat,
+	NumberFormat,
+	MessageType,
+	RatingIndicator,
+	FeLogger,
+	testableHelper,
+	utils
+) {
 	"use strict";
 
 	var oLogger = new FeLogger("js.RuntimeFormatters").getLogger();
@@ -89,6 +108,34 @@ sap.ui.define(["sap/ui/core/format/NumberFormat", "sap/ui/core/message/MessageTy
 		return "None";
 	}
 
+	/** Utility methods */
+	var oLocale;
+	var oCurrencyFormatter;
+	var oDateTimeFormatter;
+
+	function getFormatLocale() {
+		if (!oLocale) {
+			oLocale = new Locale(Formatting.getLanguageTag());
+		}
+		return oLocale;
+	}
+
+	
+	function getCurrencyFormatter() {
+		if (!oCurrencyFormatter) {
+			oCurrencyFormatter = NumberFormat.getCurrencyInstance();
+		}
+		return oCurrencyFormatter;
+	}
+
+	
+	function getDateTimeFormatter() {
+		if (!oDateTimeFormatter) {
+			oDateTimeFormatter = DateFormat.getDateTimeInstance();
+		}
+		return oDateTimeFormatter;
+	}
+
 	// Expose selected private static functions to unit tests
 	/* eslint-disable */
 	var getLineItemQualifier = testableHelper.testableStatic(getLineItemQualifier, "RuntimeFormatters_getLineItemQualifier");
@@ -167,29 +214,25 @@ sap.ui.define(["sap/ui/core/format/NumberFormat", "sap/ui/core/message/MessageTy
 		// ii. if the Property TargetValue is not a Path (i.e. 'Decimal') then we get the value from the control's Custom Data
 		// iii. if neither i. or ii. apply then we use the default max value for the sap.m.RatingIndicator control
 		formatRatingIndicatorFooterText: function (value, targetValue) {
-			if (value) {
-				var oResBundle = this.getModel("i18n").getResourceBundle();
-				if (targetValue) {
-					return oResBundle.getText("RATING_INDICATOR_FOOTER", [value, targetValue]);
-				} else if (this.getCustomData().length > 0) {
-					return oResBundle.getText("RATING_INDICATOR_FOOTER", [value, this.data("Footer")]);
-				} else {
-					var iRatingIndicatorDefaultMaxValue = sap.m.RatingIndicator.getMetadata().getPropertyDefaults().maxValue;
-					return oResBundle.getText("RATING_INDICATOR_FOOTER", [value, iRatingIndicatorDefaultMaxValue]);
-				}
-			}
+			if (!value) {
+				return "";
+			}	
+			var oResBundle = this.getModel("i18n").getResourceBundle();
+			targetValue = targetValue 
+				|| this.data("Footer") 
+				|| RatingIndicator.getMetadata().getPropertyDefaults().maxValue;
+
+			return oResBundle.getText("RATING_INDICATOR_FOOTER", [value, targetValue]);
 		},
 		
 		// returns the text for the Rating Indicator aggregated count (e.g. (243))
-		formatRatingIndicatorAggregateCount: function (value) {
+		formatRatingIndicatorAggregateCount: function (vValue) {
 			var oResBundle = this.getModel("i18n").getResourceBundle();
-			var sText;
-			if (value) {
-				sText = oResBundle.getText("RATING_INDICATOR_AGGREGATE_COUNT", [value]);
-			} else if (this.getCustomData().length > 0) {
-				sText = oResBundle.getText("RATING_INDICATOR_AGGREGATE_COUNT", [this.data("AggregateCount")]);
-			} else {
-				sText = "";
+			var sText = "";
+			// If the input value is not provided, try to get value from "AggregateCount" custom data
+			vValue = vValue || this.data("AggregateCount");
+			if (vValue) {
+				sText = oResBundle.getText("RATING_INDICATOR_AGGREGATE_COUNT", [vValue]);
 			}
 
 			return sText;
@@ -213,7 +256,7 @@ sap.ui.define(["sap/ui/core/format/NumberFormat", "sap/ui/core/message/MessageTy
 				var oControl = this;
 				var oResourceBundle = oControl.getModel("i18n").getResourceBundle();
 				var aCustomData = oControl.getCustomData();
-				var oLocale = sap.ui.getCore().getConfiguration().getFormatSettings().getFormatLocale();
+				var oLocale = getFormatLocale();
 				sValue = NumberFormat.getInstance(oLocale).format(sValue);
 				sTarget = sTarget || aCustomData.filter(function (oObject) {
 					if (oObject.getKey() === "Target") {
@@ -252,6 +295,19 @@ sap.ui.define(["sap/ui/core/format/NumberFormat", "sap/ui/core/message/MessageTy
 			}
 
 			return sDisplayValue;
+		},
+		formatDate: function (oDate) {
+			return getDateTimeFormatter().format(oDate);
+		},
+		/**
+		 * Formats the given amount and currency
+		 * 
+		 * @param {number|string} vAmount 
+		 * @param {string} sCurrency 
+		 * @returns {string}
+		 */
+		formatCurrency: function (vAmount, sCurrency) {
+			return getCurrencyFormatter().format(vAmount, sCurrency);
 		}
 	};