@sapui5/sap.fe.core 1.121.2 → 1.123.0

package/src/sap/fe/core/converters/annotations/DataField.ts

@@ -11,9 +11,11 @@ import type {
 	DataFieldTypes,
 	DataPoint,
 	DataPointType,
+	DataPointTypeTypes,
 	FieldGroup
 } from "@sap-ux/vocabularies-types/vocabularies/UI";
 import { UIAnnotationTypes, VisualizationType } from "@sap-ux/vocabularies-types/vocabularies/UI";
+import type { PageContextPathTarget } from "sap/fe/core/converters/TemplateConverter";
 import type { ColumnExportSettings, TableType } from "sap/fe/core/converters/controls/Common/Table";
 import { isAnnotationOfType, isPathAnnotationExpression, isProperty } from "sap/fe/core/helpers/TypeGuards";
 import { getDisplayMode } from "sap/fe/core/templating/DisplayModeFormatter";
@@ -26,14 +28,14 @@ import {
 	hasStaticPercentUnit
 } from "sap/fe/core/templating/PropertyHelper";
 import { enhanceDataModelPath, getContextRelativeTargetObjectPath, type DataModelObjectPath } from "../../templating/DataModelPathHelper";
+import type { DisplayMode } from "../../templating/UIFormatters";
 import type ConverterContext from "../ConverterContext";
 import { isReferencePropertyStaticallyHidden } from "../helpers/DataFieldHelper";
 
 export type ComplexPropertyInfo = {
-	properties: Record<string, Property>;
+	properties: Record<string, { annotationProperty: Property; displayModeOfPropertyUsedAsDescription?: DisplayMode }>;
 	additionalProperties: Record<string, Property>;
 	exportSettings: ColumnExportSettings;
-	textOnlyPropertiesFromTextAnnotation: string[];
 };
 
 /**
@@ -54,7 +56,9 @@ export function isDataFieldForActionAbstract(dataField: DataFieldAbstractTypes):
  * @param dataField DataField to be evaluated
  * @returns Validates that dataField is a DataFieldForAnnotation
  */
-export function isDataFieldForAnnotation(dataField: DataFieldAbstractTypes | undefined): dataField is DataFieldForAnnotation {
+export function isDataFieldForAnnotation(
+	dataField: DataFieldAbstractTypes | DataPointTypeTypes | undefined
+): dataField is DataFieldForAnnotation {
 	return dataField?.$Type === UIAnnotationTypes.DataFieldForAnnotation;
 }
 
@@ -123,7 +127,9 @@ export function hasDataPointTarget(dataFieldForAnnotation: DataFieldForAnnotatio
  * @param dataModelObjectPath DataModelObjectPath
  * @returns `Dialog` | `None` if a dialog is needed
  */
-export function isDataModelObjectPathForActionWithDialog(dataModelObjectPath: DataModelObjectPath) {
+export function isDataModelObjectPathForActionWithDialog(
+	dataModelObjectPath: DataModelObjectPath<DataFieldAbstractTypes>
+): "Dialog" | "None" {
 	const target = dataModelObjectPath.targetObject;
 	return isActionWithDialog(isDataFieldForAction(target) ? target : undefined);
 }
@@ -211,7 +217,10 @@ export const isAProgressTypeFromDataPoint = function (property: Property | DataF
 	return ((property as DataFieldForAnnotation).Target?.$target as DataPointType)?.Visualization === "UI.VisualizationType/Progress";
 };
 
-export function getSemanticObjectPath(converterContext: ConverterContext, object: DataFieldAbstractTypes | Property): string | undefined {
+export function getSemanticObjectPath(
+	converterContext: ConverterContext<PageContextPathTarget>,
+	object: DataFieldAbstractTypes | Property
+): string | undefined {
 	if (typeof object === "object") {
 		if (isDataFieldTypes(object) && object.Value?.$target) {
 			const property = object.Value?.$target;
@@ -280,11 +289,20 @@ function _collectAdditionalPropertiesForAnalyticalTable(
  * @param relatedProperties
  * @param key The property path
  * @param value The properties object containing value property, description property...
+ * @param displayModeOfPropertyUsedAsDescription The display mode if the property is referenced as description on text arrangement
  * @returns Index at which the property is available
  */
-function _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties: ComplexPropertyInfo, key: string, value: Property): number {
+function _setRelatedPropertiesAndGetIndex(
+	relatedProperties: ComplexPropertyInfo,
+	key: string,
+	value: Property,
+	displayModeOfPropertyUsedAsDescription?: DisplayMode
+): number {
 	if (!relatedProperties.properties.hasOwnProperty(key)) {
-		relatedProperties.properties[key] = value;
+		relatedProperties.properties[key] = { annotationProperty: value };
+		if (displayModeOfPropertyUsedAsDescription) {
+			relatedProperties.properties[key].displayModeOfPropertyUsedAsDescription = displayModeOfPropertyUsedAsDescription;
+		}
 	}
 	return Object.keys(relatedProperties.properties).indexOf(key);
 }
@@ -323,8 +341,7 @@ export function collectRelatedProperties(
 	relatedProperties: ComplexPropertyInfo = {
 		properties: {},
 		additionalProperties: {},
-		exportSettings: {},
-		textOnlyPropertiesFromTextAnnotation: []
+		exportSettings: {}
 	},
 	addUnitInTemplate = false,
 	isAnnotatedAsHidden = false
@@ -334,7 +351,7 @@ export function collectRelatedProperties(
 		let currencyOrUoMIndex: number;
 		if (isAnnotatedAsHidden) {
 			// Collect underlying property
-			valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+			valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
 			_appendTemplate(relatedProperties, `{${valueIndex}}`);
 			return relatedProperties;
 		}
@@ -346,8 +363,8 @@ export function collectRelatedProperties(
 
 		// get the DataModelObjectPath for the column
 		const dataModelObjectPath = converterContext.getConverterContextFor(converterContext.getContextPath()).getDataModelObjectPath();
-		const propertyDataModelObjectPath = enhanceDataModelPath(dataModelObjectPath, path);
-		const textPropertyDataModelObjectPath = enhanceDataModelPath(propertyDataModelObjectPath, textPropertyPath);
+		const propertyDataModelObjectPath = enhanceDataModelPath<Property>(dataModelObjectPath, path);
+		const textPropertyDataModelObjectPath = enhanceDataModelPath<Property>(propertyDataModelObjectPath, textPropertyPath);
 		const textRelativePath = getContextRelativeTargetObjectPath(textPropertyDataModelObjectPath);
 
 		if (relatedProperties.exportSettings?.template) {
@@ -361,43 +378,50 @@ export function collectRelatedProperties(
 			const displayMode = getDisplayMode(property, propertyDataModelObjectPath);
 			let descriptionIndex: number;
 			switch (displayMode) {
-				case "Value":
-					valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
-					_appendTemplate(relatedProperties, `{${valueIndex}}`);
-					break;
-
 				case "Description":
-					descriptionIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, textRelativePath, textProperty);
+					descriptionIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, textRelativePath, textProperty, "Description");
 					_appendTemplate(relatedProperties, `{${descriptionIndex}}`);
-					relatedProperties.textOnlyPropertiesFromTextAnnotation.push(textRelativePath);
 					break;
 
 				case "ValueDescription":
-					valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
-					descriptionIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, textRelativePath, textProperty);
+					valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+					descriptionIndex = _setRelatedPropertiesAndGetIndex(
+						relatedProperties,
+						textRelativePath,
+						textProperty,
+						"ValueDescription"
+					);
 					_appendTemplate(relatedProperties, `{${valueIndex}} ({${descriptionIndex}})`);
 					break;
 
 				case "DescriptionValue":
-					valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
-					descriptionIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, textRelativePath, textProperty);
+					valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+					descriptionIndex = _setRelatedPropertiesAndGetIndex(
+						relatedProperties,
+						textRelativePath,
+						textProperty,
+						"DescriptionValue"
+					);
 					_appendTemplate(relatedProperties, `{${descriptionIndex}} ({${valueIndex}})`);
 					break;
-				// no default
+				default:
+					valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+					_appendTemplate(relatedProperties, `{${valueIndex}}`);
+					break;
 			}
 		} else {
 			// Check for field containing Currency Or Unit Properties or Timezone
 			const currencyProperty = getAssociatedCurrencyProperty(property);
 			const unitProperty = getAssociatedUnitProperty(property);
-			const currencyOrUoMProperty = currencyProperty || unitProperty;
+			const currencyOrUoMProperty = currencyProperty ?? unitProperty;
 			const currencyOrUnitAnnotation: PathAnnotationExpression<string> =
 				property?.annotations?.Measures?.ISOCurrency || property?.annotations?.Measures?.Unit;
 			const timezoneProperty = getAssociatedTimezoneProperty(property);
 			const timezoneAnnotation = property?.annotations?.Common?.Timezone;
 
 			if (currencyOrUoMProperty) {
-				valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
-				currencyOrUoMIndex = _setPropertyInRelatedPropertiesAndGetIndex(
+				valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+				currencyOrUoMIndex = _setRelatedPropertiesAndGetIndex(
 					relatedProperties,
 					navigationPathPrefix + currencyOrUnitAnnotation.path,
 					currencyOrUnitAnnotation.$target!
@@ -420,7 +444,7 @@ export function collectRelatedProperties(
 			} else if (property.$Type === CommunicationAnnotationTypes.ContactType) {
 				const contactProperty = property.fn?.$target;
 				const contactPropertyPath = property.fn?.path;
-				valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(
+				valueIndex = _setRelatedPropertiesAndGetIndex(
 					relatedProperties,
 					navigationPathPrefix ? navigationPathPrefix + contactPropertyPath : contactPropertyPath,
 					contactProperty
@@ -428,7 +452,7 @@ export function collectRelatedProperties(
 				_appendTemplate(relatedProperties, `{${valueIndex}}`);
 			} else if (!ignoreSelf) {
 				// Collect underlying property
-				valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+				valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
 				_appendTemplate(relatedProperties, `{${valueIndex}}`);
 				if (currencyOrUnitAnnotation) {
 					relatedProperties.exportSettings.unit = `${currencyOrUnitAnnotation}`; // Hard-coded currency/unit
@@ -445,7 +469,7 @@ export function collectRelatedProperties(
 		if (Object.keys(relatedProperties.additionalProperties).length > 0 && Object.keys(relatedProperties.properties).length === 0) {
 			// Collect underlying property if not collected already.
 			// This is to ensure that additionalProperties are made available only to complex property infos.
-			valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+			valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
 			_appendTemplate(relatedProperties, `{${valueIndex}}`);
 		}
 	}
@@ -482,7 +506,7 @@ function collectDataPointProperties(property: PrimitiveType, relatedProperties:
 	const navigationPathPrefix = _getNavigationPathPrefix(path);
 	// DataPoint use-case using DataFieldDefault.
 	const dataPointDefaultProperty = property.annotations?.UI?.DataFieldDefault;
-	const valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(
+	const valueIndex = _setRelatedPropertiesAndGetIndex(
 		relatedProperties,
 		navigationPathPrefix ? navigationPathPrefix + path : path,
 		dataPointDefaultProperty ? property : dataPointProperty
@@ -495,7 +519,7 @@ function collectDataPointProperties(property: PrimitiveType, relatedProperties:
 	if (isPathAnnotationExpression(targetValue)) {
 		if (targetValue.$target) {
 			//in case it's a dynamic targetValue
-			const dataPointIndex = _setPropertyInRelatedPropertiesAndGetIndex(
+			const dataPointIndex = _setRelatedPropertiesAndGetIndex(
 				relatedProperties,
 				navigationPathPrefix ? navigationPathPrefix + targetValue.$target.name : targetValue.$target.name,
 				targetValue.$target
@@ -528,9 +552,9 @@ function collectTimezoneProperties(
 ): void {
 	const timezoneAnnotation = property.annotations.Common.Timezone;
 	const navigationPathPrefix = _getNavigationPathPrefix(path);
-	const valueIndex = _setPropertyInRelatedPropertiesAndGetIndex(relatedProperties, path, property);
+	const valueIndex = _setRelatedPropertiesAndGetIndex(relatedProperties, path, property);
 
-	const timezoneOrUoMIndex = _setPropertyInRelatedPropertiesAndGetIndex(
+	const timezoneOrUoMIndex = _setRelatedPropertiesAndGetIndex(
 		relatedProperties,
 		navigationPathPrefix + timezoneAnnotation.path,
 		timezoneAnnotation.$target
@@ -560,7 +584,6 @@ export function collectRelatedPropertiesRecursively(
 	relatedProperties: ComplexPropertyInfo = {
 		properties: {},
 		additionalProperties: {},
-		textOnlyPropertiesFromTextAnnotation: [],
 		exportSettings: {}
 	},
 	isEmbedded = false