@sapui5/sap.fe.core 1.101.0 → 1.103.0

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

@@ -1,20 +1,24 @@
-import { Property } from "@sap-ux/annotation-converter";
-import {
-	CommunicationAnnotationTypes,
-	Contact,
+import type { PrimitiveType, Property } from "@sap-ux/vocabularies-types";
+import type { Contact } from "@sap-ux/vocabularies-types/vocabularies/Communication";
+import { CommunicationAnnotationTypes } from "@sap-ux/vocabularies-types/vocabularies/Communication";
+import type {
 	DataField,
 	DataFieldAbstractTypes,
 	DataFieldForActionAbstractTypes,
 	DataFieldForAnnotation,
 	DataFieldTypes,
-	DataPoint,
-	UIAnnotationTypes
-} from "@sap-ux/vocabularies-types";
-import * as Edm from "@sap-ux/vocabularies-types/dist/Edm";
-import { TableType } from "sap/fe/core/converters/controls/Common/Table";
-import { getDisplayMode, PropertyOrPath } from "sap/fe/core/templating/DisplayModeFormatter";
-import { getAssociatedCurrencyProperty, getAssociatedUnitProperty, isProperty } from "sap/fe/core/templating/PropertyHelper";
-import ConverterContext from "../ConverterContext";
+	DataPoint
+} from "@sap-ux/vocabularies-types/vocabularies/UI";
+import { UIAnnotationTypes } from "@sap-ux/vocabularies-types/vocabularies/UI";
+import type { TableType } from "sap/fe/core/converters/controls/Common/Table";
+import { getDisplayMode } from "sap/fe/core/templating/DisplayModeFormatter";
+import {
+	getAssociatedCurrencyProperty,
+	getAssociatedTimezoneProperty,
+	getAssociatedUnitProperty,
+	isProperty
+} from "sap/fe/core/templating/PropertyHelper";
+import type ConverterContext from "../ConverterContext";
 
 export type ComplexPropertyInfo = {
 	properties: Record<string, Property>;
@@ -25,14 +29,16 @@ export type ComplexPropertyInfo = {
 	visualSettingsToBeExcluded?: string;
 	exportUnitName?: string;
 	exportUnitString?: string;
+	exportTimezoneName?: string;
+	exportTimezoneString?: string;
 };
 
 /**
  * Identifies if the given dataFieldAbstract that is passed is a "DataFieldForActionAbstract".
  * DataFieldForActionAbstract has an inline action defined.
  *
- * @param {DataFieldAbstractTypes} dataField DataField to be evaluated
- * @returns {boolean} Validates that dataField is a DataFieldForActionAbstractType
+ * @param dataField DataField to be evaluated
+ * @returns Validates that dataField is a DataFieldForActionAbstractType
  */
 export function isDataFieldForActionAbstract(dataField: DataFieldAbstractTypes): dataField is DataFieldForActionAbstractTypes {
 	return (dataField as DataFieldForActionAbstractTypes).hasOwnProperty("Action");
@@ -42,8 +48,8 @@ export function isDataFieldForActionAbstract(dataField: DataFieldAbstractTypes):
  * Identifies if the given dataFieldAbstract that is passed is a "DataField".
  * DataField has a value defined.
  *
- * @param {DataFieldAbstractTypes} dataField DataField to be evaluated
- * @returns {boolean} Validate that dataField is a DataFieldTypes
+ * @param dataField DataField to be evaluated
+ * @returns Validate that dataField is a DataFieldTypes
  */
 export function isDataFieldTypes(dataField: DataFieldAbstractTypes): dataField is DataFieldTypes {
 	return (dataField as DataFieldTypes).hasOwnProperty("Value");
@@ -52,8 +58,8 @@ export function isDataFieldTypes(dataField: DataFieldAbstractTypes): dataField i
 /**
  * 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
+ * @param dataField The DataField to check
+ * @returns `true` if DataField or referenced property has a static Hidden annotation, false else
  * @private
  */
 export function isDataFieldAlwaysHidden(dataField: DataFieldAbstractTypes): boolean {
@@ -83,7 +89,7 @@ export function getSemanticObjectPath(converterContext: ConverterContext, object
  * Returns the navigation path prefix for a property path.
  *
  * @param path The property path For e.g. /EntityType/Navigation/Property
- * @returns {string} The navigation path prefix For e.g. /EntityType/Navigation/
+ * @returns The navigation path prefix For e.g. /EntityType/Navigation/
  */
 function _getNavigationPathPrefix(path: string): string {
 	return path.indexOf("/") > -1 ? path.substring(0, path.lastIndexOf("/") + 1) : "";
@@ -93,14 +99,15 @@ function _getNavigationPathPrefix(path: string): string {
  * Collect additional properties for the ALP table use-case.
  *
  * For e.g. If UI.Hidden points to a property, include this property in the additionalProperties of ComplexPropertyInfo object.
+ *
  * @param target Property or DataField being processed
  * @param navigationPathPrefix Navigation path prefix, applicable in case of navigation properties.
  * @param tableType Table type.
  * @param relatedProperties The related properties identified so far.
- * @returns {ComplexPropertyInfo} The related properties identified.
+ * @returns The related properties identified.
  */
 function _collectAdditionalPropertiesForAnalyticalTable(
-	target: Edm.PrimitiveType,
+	target: PrimitiveType,
 	navigationPathPrefix: string,
 	tableType: TableType,
 	relatedProperties: ComplexPropertyInfo
@@ -126,11 +133,11 @@ function _collectAdditionalPropertiesForAnalyticalTable(
  * @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.
+ * @returns The related properties identified.
  */
 export function collectRelatedProperties(
 	path: string,
-	property: Edm.PrimitiveType,
+	property: PrimitiveType,
 	converterContext: ConverterContext,
 	ignoreSelf: boolean,
 	tableType: TableType,
@@ -170,6 +177,7 @@ export function collectRelatedProperties(
 		let valueIndex: number;
 		let targetValue: string;
 		let currencyOrUoMIndex: number;
+		let timezoneOrUoMIndex: number;
 
 		if (relatedProperties.exportSettingsTemplate) {
 			// FieldGroup use-case. Need to add each Field in new line.
@@ -181,7 +189,7 @@ export function collectRelatedProperties(
 			// Check for Text Arrangement.
 			const dataModelObjectPath = converterContext.getDataModelObjectPath();
 			const textAnnotationPropertyPath = navigationPathPrefix + textAnnotation.path;
-			const displayMode = getDisplayMode(property as PropertyOrPath<Property>, dataModelObjectPath);
+			const displayMode = getDisplayMode(property, dataModelObjectPath);
 			let descriptionIndex: number;
 			switch (displayMode) {
 				case "Value":
@@ -208,11 +216,15 @@ export function collectRelatedProperties(
 					descriptionIndex = _pushUnique(textAnnotationPropertyPath, textAnnotation.$target);
 					_appendTemplate(`{${descriptionIndex}} ({${valueIndex}})`);
 					break;
+				// no default
 			}
 		} else {
-			// Check for field containing Currency Or Unit Properties.
+			// Check for field containing Currency Or Unit Properties or Timezone
 			const currencyOrUoMProperty = getAssociatedCurrencyProperty(property) || getAssociatedUnitProperty(property);
 			const currencyOrUnitAnnotation = property?.annotations?.Measures?.ISOCurrency || property?.annotations?.Measures?.Unit;
+			const timezoneProperty = getAssociatedTimezoneProperty(property);
+			const timezoneAnnotation = property?.annotations?.Common?.Timezone;
+
 			if (currencyOrUoMProperty && currencyOrUnitAnnotation?.$target) {
 				valueIndex = _pushUnique(path, property);
 				currencyOrUoMIndex = _pushUnique(currencyOrUoMProperty.name, currencyOrUnitAnnotation.$target);
@@ -221,8 +233,16 @@ export function collectRelatedProperties(
 				} else {
 					relatedProperties.exportUnitName = currencyOrUoMProperty.name;
 				}
+			} else if (timezoneProperty && timezoneAnnotation?.$target) {
+				valueIndex = _pushUnique(path, property);
+				timezoneOrUoMIndex = _pushUnique(timezoneProperty.name, timezoneAnnotation.$target);
+				if (addUnitInTemplate) {
+					_appendTemplate(`{${valueIndex}}  {${timezoneOrUoMIndex}}`);
+				} else {
+					relatedProperties.exportTimezoneName = timezoneProperty.name;
+				}
 			} else if (property.Target?.$target?.Visualization) {
-				const dataPointProperty: Edm.PrimitiveType = property.Target.$target.Value.$target;
+				const dataPointProperty: PrimitiveType = property.Target.$target.Value.$target;
 				valueIndex = _pushUnique(path, dataPointProperty);
 				// New fake property created for the Rating/Progress Target Value. It'll be used for the export on split mode.
 				_pushUnique(property.Target.value, property.Target.$target);
@@ -230,7 +250,7 @@ export function collectRelatedProperties(
 				_appendTemplate(`{${valueIndex}}/${targetValue}`);
 			} else if (property.annotations?.UI?.DataFieldDefault?.Target?.$target?.$Type === UIAnnotationTypes.DataPointType) {
 				// DataPoint use-case using DataFieldDefault.
-				const dataPointDefaultProperty: Edm.PrimitiveType = property.annotations.UI.DataFieldDefault;
+				const dataPointDefaultProperty: PrimitiveType = property.annotations.UI.DataFieldDefault;
 				valueIndex = _pushUnique(path, property);
 				// New fake property created for the Rating/Progress Target Value. It'll be used for the export on split mode.
 				_pushUnique(dataPointDefaultProperty.Target.value, property);
@@ -249,6 +269,8 @@ export function collectRelatedProperties(
 				_appendTemplate(`{${valueIndex}}`);
 				if (currencyOrUnitAnnotation) {
 					relatedProperties.exportUnitString = `${currencyOrUnitAnnotation}`; // Hard-coded currency/unit
+				} else if (timezoneAnnotation) {
+					relatedProperties.exportTimezoneString = `${timezoneAnnotation}`; // Hard-coded timezone
 				}
 			}
 		}
@@ -269,12 +291,12 @@ export function collectRelatedProperties(
  * Collect properties consumed by a DataField.
  * This is for populating the ComplexPropertyInfos of the table delegate.
  *
- * @param {DataFieldAbstractTypes} dataField The DataField for which the properties need to be identified.
+ * @param 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.
- * @param {boolean} isEmbedded True if the datafield is embedded in another annotation (e.g. FieldGroup).
- * @returns {ComplexPropertyInfo} The properties related to the DataField.
+ * @param tableType The table type.
+ * @param relatedProperties The properties identified so far.
+ * @param isEmbedded True if the DataField is embedded in another annotation (e.g. FieldGroup).
+ * @returns The properties related to the DataField.
  */
 export function collectRelatedPropertiesRecursively(
 	dataField: DataFieldAbstractTypes,
@@ -283,57 +305,79 @@ export function collectRelatedPropertiesRecursively(
 	relatedProperties: ComplexPropertyInfo = { properties: {}, additionalProperties: {} },
 	isEmbedded: boolean = false
 ): ComplexPropertyInfo {
-	if ((dataField.$Type === UIAnnotationTypes.DataField || dataField.$Type === UIAnnotationTypes.DataFieldWithUrl) && dataField.Value) {
-		const property = dataField.Value;
-		relatedProperties = collectRelatedProperties(
-			property.path,
-			property.$target,
-			converterContext,
-			false,
-			tableType,
-			relatedProperties,
-			isEmbedded
-		);
-		const navigationPathPrefix = _getNavigationPathPrefix(property.path);
-		relatedProperties = _collectAdditionalPropertiesForAnalyticalTable(dataField, navigationPathPrefix, tableType, relatedProperties);
-	} else if (dataField.$Type === UIAnnotationTypes.DataFieldForAnnotation) {
-		switch (dataField.Target?.$target?.$Type) {
-			case UIAnnotationTypes.FieldGroupType:
-				dataField.Target.$target.Data?.forEach((innerDataField: DataFieldAbstractTypes) => {
-					relatedProperties = collectRelatedPropertiesRecursively(
-						innerDataField,
+	switch (dataField?.$Type) {
+		case UIAnnotationTypes.DataField:
+		case UIAnnotationTypes.DataFieldWithUrl:
+		case UIAnnotationTypes.DataFieldWithNavigationPath:
+		case UIAnnotationTypes.DataFieldWithIntentBasedNavigation:
+		case UIAnnotationTypes.DataFieldWithAction:
+			const property = dataField.Value;
+			relatedProperties = collectRelatedProperties(
+				property.path,
+				property.$target,
+				converterContext,
+				false,
+				tableType,
+				relatedProperties,
+				isEmbedded
+			);
+			const navigationPathPrefix = _getNavigationPathPrefix(property.path);
+			relatedProperties = _collectAdditionalPropertiesForAnalyticalTable(
+				dataField,
+				navigationPathPrefix,
+				tableType,
+				relatedProperties
+			);
+			break;
+
+		case UIAnnotationTypes.DataFieldForAction:
+		case UIAnnotationTypes.DataFieldForIntentBasedNavigation:
+			break;
+
+		case UIAnnotationTypes.DataFieldForAnnotation:
+			switch (dataField.Target?.$target?.$Type) {
+				case UIAnnotationTypes.FieldGroupType:
+					dataField.Target.$target.Data?.forEach((innerDataField: DataFieldAbstractTypes) => {
+						relatedProperties = collectRelatedPropertiesRecursively(
+							innerDataField,
+							converterContext,
+							tableType,
+							relatedProperties,
+							true
+						);
+					});
+					break;
+
+				case UIAnnotationTypes.DataPointType:
+					relatedProperties = collectRelatedProperties(
+						dataField.Target.$target.Value.path,
+						dataField,
 						converterContext,
+						false,
 						tableType,
 						relatedProperties,
-						true
+						isEmbedded
 					);
-				});
-				break;
+					break;
 
-			case UIAnnotationTypes.DataPointType:
-				relatedProperties = collectRelatedProperties(
-					dataField.Target.$target.Value.path,
-					dataField,
-					converterContext,
-					false,
-					tableType,
-					relatedProperties,
-					isEmbedded
-				);
-				break;
+				case "com.sap.vocabularies.Communication.v1.ContactType":
+					relatedProperties = collectRelatedProperties(
+						dataField.Target.value,
+						dataField,
+						converterContext,
+						false,
+						tableType,
+						relatedProperties,
+						isEmbedded
+					);
+					break;
+				default:
+					break;
+			}
+			break;
 
-			case "com.sap.vocabularies.Communication.v1.ContactType":
-				relatedProperties = collectRelatedProperties(
-					dataField.Target.value,
-					dataField,
-					converterContext,
-					false,
-					tableType,
-					relatedProperties,
-					isEmbedded
-				);
-				break;
-		}
+		default:
+			break;
 	}
 
 	return relatedProperties;