@sapui5/sap.fe.core 1.97.0 → 1.100.0

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

@@ -10,7 +10,7 @@ import {
 	UIAnnotationTypes
 } from "@sap-ux/vocabularies-types";
 import * as Edm from "@sap-ux/vocabularies-types/dist/Edm";
-import { getDisplayMode, PropertyOrPath } from "sap/fe/core/templating/UIFormatters";
+import { getDisplayMode, PropertyOrPath } from "sap/fe/core/templating/DisplayModeFormatter";
 import { Property } from "@sap-ux/annotation-converter";
 import { getAssociatedCurrencyProperty, getAssociatedUnitProperty, isProperty } from "sap/fe/core/templating/PropertyHelper";
 import ConverterContext from "../ConverterContext";
@@ -23,13 +23,15 @@ export type ComplexPropertyInfo = {
 	exportSettingsWrapping?: boolean;
 	exportSettingsContactProperty?: string;
 	visualSettingsToBeExcluded?: string;
+	exportUnitName?: string;
+	exportUnitString?: string;
 };
 
 /**
  * Identifies if the given dataFieldAbstract that is passed is a "DataFieldForActionAbstract".
  * DataFieldForActionAbstract has an inline action defined.
  *
- * @param {DataFieldAbstractTypes} dataField Data field to be evaluated
+ * @param {DataFieldAbstractTypes} dataField DataField to be evaluated
  * @returns {boolean} Validates that dataField is a DataFieldForActionAbstractType
  */
 export function isDataFieldForActionAbstract(dataField: DataFieldAbstractTypes): dataField is DataFieldForActionAbstractTypes {
@@ -40,7 +42,7 @@ export function isDataFieldForActionAbstract(dataField: DataFieldAbstractTypes):
  * Identifies if the given dataFieldAbstract that is passed is a "DataField".
  * DataField has a value defined.
  *
- * @param {DataFieldAbstractTypes} dataField Data field to be evaluated
+ * @param {DataFieldAbstractTypes} dataField DataField to be evaluated
  * @returns {boolean} Validate that dataField is a DataFieldTypes
  */
 export function isDataFieldTypes(dataField: DataFieldAbstractTypes): dataField is DataFieldTypes {
@@ -48,7 +50,7 @@ export function isDataFieldTypes(dataField: DataFieldAbstractTypes): dataField i
 }
 
 /**
- * Returns whether given data field has a static hidden annotation.
+ * Returns whether given DataField has a static hidden annotation.
  *
  * @param {DataFieldAbstractTypes} dataField The datafield to check
  * @returns {boolean} `true` if datafield or referenced property has a static Hidden annotation, false else
@@ -123,6 +125,7 @@ function _collectAdditionalPropertiesForAnalyticalTable(
  * @param ignoreSelf Whether to exclude the same property from related properties.
  * @param tableType The table type.
  * @param relatedProperties The related properties identified so far.
+ * @param addUnitInTemplate True if the unit/currency property needs to be added in the export template
  * @returns {ComplexPropertyInfo} The related properties identified.
  */
 export function collectRelatedProperties(
@@ -131,7 +134,8 @@ export function collectRelatedProperties(
 	converterContext: ConverterContext,
 	ignoreSelf: boolean,
 	tableType: TableType,
-	relatedProperties: ComplexPropertyInfo = { properties: {}, additionalProperties: {} }
+	relatedProperties: ComplexPropertyInfo = { properties: {}, additionalProperties: {} },
+	addUnitInTemplate: boolean = false
 ): ComplexPropertyInfo {
 	/**
 	 * Helper to push unique related properties.
@@ -213,7 +217,11 @@ export function collectRelatedProperties(
 			if (currencyOrUoMProperty && currencyOrUnitAnnotation?.$target) {
 				valueIndex = _pushUnique(path, property);
 				currencyOrUoMIndex = _pushUnique(currencyOrUoMProperty.name, currencyOrUnitAnnotation.$target);
-				_appendTemplate(`{${valueIndex}}  {${currencyOrUoMIndex}}`);
+				if (addUnitInTemplate) {
+					_appendTemplate(`{${valueIndex}}  {${currencyOrUoMIndex}}`);
+				} else {
+					relatedProperties.exportUnitName = currencyOrUoMProperty.name;
+				}
 			} else if (property.Target?.$target?.Visualization) {
 				const dataPointProperty: Edm.PrimitiveType = property.Target.$target.Value.$target;
 				valueIndex = _pushUnique(path, dataPointProperty);
@@ -240,6 +248,9 @@ export function collectRelatedProperties(
 				// Collect underlying property
 				valueIndex = _pushUnique(path, property);
 				_appendTemplate(`{${valueIndex}}`);
+				if (currencyOrUnitAnnotation) {
+					relatedProperties.exportUnitString = `${currencyOrUnitAnnotation}`; // Hard-coded currency/unit
+				}
 			}
 		}
 
@@ -256,20 +267,22 @@ export function collectRelatedProperties(
 }
 
 /**
- * Collect properties consumed by a Data Field.
+ * Collect properties consumed by a DataField.
  * This is for populating the ComplexPropertyInfos of the table delegate.
  *
- * @param {DataFieldAbstractTypes} dataField The Data Field for which the properties need to be identified.
+ * @param {DataFieldAbstractTypes} dataField The DataField for which the properties need to be identified.
  * @param converterContext The converter context.
  * @param {TableType} tableType The table type.
  * @param {ComplexPropertyInfo} relatedProperties The properties identified so far.
- * @returns {ComplexPropertyInfo} The properties related to the Data Field.
+ * @param {boolean} isEmbedded True if the datafield is embedded in another annotation (e.g. FieldGroup).
+ * @returns {ComplexPropertyInfo} The properties related to the DataField.
  */
 export function collectRelatedPropertiesRecursively(
 	dataField: DataFieldAbstractTypes,
 	converterContext: ConverterContext,
 	tableType: TableType,
-	relatedProperties: ComplexPropertyInfo = { properties: {}, additionalProperties: {} }
+	relatedProperties: ComplexPropertyInfo = { properties: {}, additionalProperties: {} },
+	isEmbedded: boolean = false
 ): ComplexPropertyInfo {
 	if ((dataField.$Type === UIAnnotationTypes.DataField || dataField.$Type === UIAnnotationTypes.DataFieldWithUrl) && dataField.Value) {
 		const property = dataField.Value;
@@ -279,7 +292,8 @@ export function collectRelatedPropertiesRecursively(
 			converterContext,
 			false,
 			tableType,
-			relatedProperties
+			relatedProperties,
+			isEmbedded
 		);
 		const navigationPathPrefix = _getNavigationPathPrefix(property.path);
 		relatedProperties = _collectAdditionalPropertiesForAnalyticalTable(dataField, navigationPathPrefix, tableType, relatedProperties);
@@ -287,7 +301,13 @@ export function collectRelatedPropertiesRecursively(
 		switch (dataField.Target?.$target?.$Type) {
 			case UIAnnotationTypes.FieldGroupType:
 				dataField.Target.$target.Data?.forEach((innerDataField: DataFieldAbstractTypes) => {
-					relatedProperties = collectRelatedPropertiesRecursively(innerDataField, converterContext, tableType, relatedProperties);
+					relatedProperties = collectRelatedPropertiesRecursively(
+						innerDataField,
+						converterContext,
+						tableType,
+						relatedProperties,
+						true
+					);
 				});
 				break;
 
@@ -298,7 +318,8 @@ export function collectRelatedPropertiesRecursively(
 					converterContext,
 					false,
 					tableType,
-					relatedProperties
+					relatedProperties,
+					isEmbedded
 				);
 				break;
 
@@ -309,7 +330,8 @@ export function collectRelatedPropertiesRecursively(
 					converterContext,
 					false,
 					tableType,
-					relatedProperties
+					relatedProperties,
+					isEmbedded
 				);
 				break;
 		}
@@ -329,6 +351,8 @@ export const getDataFieldDataType = function(oDataField: DataFieldAbstractTypes
 		case UIAnnotationTypes.DataField:
 		case UIAnnotationTypes.DataFieldWithNavigationPath:
 		case UIAnnotationTypes.DataFieldWithUrl:
+		case UIAnnotationTypes.DataFieldWithIntentBasedNavigation:
+		case UIAnnotationTypes.DataFieldWithAction:
 			sDataType = (oDataField as DataField)?.Value?.$target?.type;
 			break;