@sapui5/sap.fe.core 1.95.0 → 1.98.0

package/src/sap/fe/core/templating/UIFormatters.ts

@@ -26,7 +26,8 @@ import {
 	isComputed,
 	isImmutable,
 	isKey,
-	isPathExpression
+	isPathExpression,
+	isProperty
 } from "sap/fe/core/templating/PropertyHelper";
 import { NavigationProperty, Property } from "@sap-ux/annotation-converter";
 import { PathAnnotationExpression } from "@sap-ux/vocabularies-types/types/Edm";
@@ -38,6 +39,13 @@ import {
 } from "sap/fe/core/templating/DataModelPathHelper";
 import { isReadOnlyExpression, isNonEditableExpression, isDisabledExpression } from "sap/fe/core/templating/FieldControlHelper";
 import valueFormatters from "sap/fe/core/formatters/ValueFormatter";
+import { DataFieldAbstractTypes } from "@sap-ux/vocabularies-types";
+import * as DisplayModeFormatter from "sap/fe/core/templating/DisplayModeFormatter";
+
+// Import-export method used by the converter to use them in the templating through the UIFormatters.
+export type DisplayMode = DisplayModeFormatter.DisplayMode;
+export const getDisplayMode = DisplayModeFormatter.getDisplayMode;
+export const EDM_TYPE_MAPPING = DisplayModeFormatter.EDM_TYPE_MAPPING;
 
 export type PropertyOrPath<P> = string | P | PathAnnotationExpression<P>;
 export type MetaModelContext = {
@@ -49,49 +57,26 @@ export type ComputedAnnotationInterface = {
 	$$valueAsPromise: boolean;
 };
 
-export const EDM_TYPE_MAPPING: Record<string, any> = {
-	"Edm.Boolean": { type: "sap.ui.model.odata.type.Boolean" },
-	"Edm.Byte": { type: "sap.ui.model.odata.type.Byte" },
-	"Edm.Date": { type: "sap.ui.model.odata.type.Date" },
-	"Edm.DateTimeOffset": {
-		constraints: {
-			"$Precision": "precision"
-		},
-		type: "sap.ui.model.odata.type.DateTimeOffset"
-	},
-	"Edm.Decimal": {
-		constraints: {
-			"@Org.OData.Validation.V1.Minimum/$Decimal": "minimum",
-			"@Org.OData.Validation.V1.Minimum@Org.OData.Validation.V1.Exclusive": "minimumExclusive",
-			"@Org.OData.Validation.V1.Maximum/$Decimal": "maximum",
-			"@Org.OData.Validation.V1.Maximum@Org.OData.Validation.V1.Exclusive": "maximumExclusive",
-			"$Precision": "precision",
-			"$Scale": "scale"
-		},
-		type: "sap.ui.model.odata.type.Decimal"
-	},
-	"Edm.Double": { type: "sap.ui.model.odata.type.Double" },
-	"Edm.Guid": { type: "sap.ui.model.odata.type.Guid" },
-	"Edm.Int16": { type: "sap.ui.model.odata.type.Int16" },
-	"Edm.Int32": { type: "sap.ui.model.odata.type.Int32" },
-	"Edm.Int64": { type: "sap.ui.model.odata.type.Int64" },
-	"Edm.SByte": { type: "sap.ui.model.odata.type.SByte" },
-	"Edm.Single": { type: "sap.ui.model.odata.type.Single" },
-	"Edm.Stream": { type: "sap.ui.model.odata.type.Stream" },
-	"Edm.String": {
-		constraints: {
-			"@com.sap.vocabularies.Common.v1.IsDigitSequence": "isDigitSequence",
-			"$MaxLength": "maxLength",
-			"$Nullable": "nullable"
-		},
-		type: "sap.ui.model.odata.type.String"
-	},
-	"Edm.TimeOfDay": {
-		constraints: {
-			"$Precision": "precision"
-		},
-		type: "sap.ui.model.odata.type.TimeOfDay"
-	}
+export type configTypeConstraints = {
+	scale?: number;
+	precision?: number;
+	maxLength?: number;
+	nullable?: boolean;
+	minimum?: string;
+	maximum?: string;
+	isDigitSequence?: boolean;
+};
+
+export type configTypeformatOptions = {
+	parseAsString?: boolean;
+	emptyString?: string;
+	parseKeepsEmptyString?: boolean;
+};
+
+export type configType = {
+	type: string;
+	constraints: configTypeConstraints;
+	formatOptions: configTypeformatOptions;
 };
 
 /**
@@ -265,34 +250,6 @@ export const ifUnitEditable = function(
 	return compileBinding(ifElse(editableExpression, sEditableValue, sNonEditableValue));
 };
 
-export type DisplayMode = "Value" | "Description" | "DescriptionValue" | "ValueDescription";
-export const getDisplayMode = function(oPropertyPath: PropertyOrPath<Property>, oDataModelObjectPath?: DataModelObjectPath): DisplayMode {
-	if (!oPropertyPath || typeof oPropertyPath === "string") {
-		return "Value";
-	}
-	const oProperty = (isPathExpression(oPropertyPath) && oPropertyPath.$target) || (oPropertyPath as Property);
-	const oEntityType = oDataModelObjectPath && oDataModelObjectPath.targetEntityType;
-	const oTextAnnotation = oProperty.annotations?.Common?.Text;
-	const oTextArrangementAnnotation =
-		(typeof oTextAnnotation !== "string" && oTextAnnotation?.annotations?.UI?.TextArrangement?.toString()) ||
-		oEntityType?.annotations?.UI?.TextArrangement?.toString();
-
-	let sDisplayValue = oTextAnnotation ? "DescriptionValue" : "Value";
-	if ((oTextAnnotation && oTextArrangementAnnotation) || oEntityType?.annotations?.UI?.TextArrangement?.toString()) {
-		if (oTextArrangementAnnotation === "UI.TextArrangementType/TextOnly") {
-			sDisplayValue = "Description";
-		} else if (oTextArrangementAnnotation === "UI.TextArrangementType/TextLast") {
-			sDisplayValue = "ValueDescription";
-		} else if (oTextArrangementAnnotation === "UI.TextArrangementType/TextSeparate") {
-			sDisplayValue = "Value";
-		} else {
-			//Default should be TextFirst if there is a Text annotation and neither TextOnly nor TextLast are set
-			sDisplayValue = "DescriptionValue";
-		}
-	}
-	return sDisplayValue as DisplayMode;
-};
-
 export const getFieldDisplay = function(
 	oPropertyPath: PropertyOrPath<Property>,
 	sTargetDisplayMode: string,
@@ -376,6 +333,53 @@ export const formatWithTypeInformation = function(oProperty: Property, propertyB
 	return outExpression;
 };
 
+export const getTypeConfig = function(oProperty: Property | DataFieldAbstractTypes, dataType: string | undefined): any {
+	const oTargetMapping = EDM_TYPE_MAPPING[(oProperty as Property)?.type] || (dataType ? EDM_TYPE_MAPPING[dataType] : undefined);
+	const propertyTypeConfig: configType = {
+		type: oTargetMapping.type,
+		constraints: {},
+		formatOptions: {}
+	};
+	if (isProperty(oProperty)) {
+		propertyTypeConfig.constraints = {
+			scale: oTargetMapping.constraints?.$Scale ? oProperty.scale : undefined,
+			precision: oTargetMapping.constraints?.$Precision ? oProperty.precision : undefined,
+			maxLength: oTargetMapping.constraints?.$MaxLength ? oProperty.maxLength : undefined,
+			nullable: oTargetMapping.constraints?.$Nullable ? oProperty.nullable : undefined,
+			minimum:
+				oTargetMapping.constraints?.["@Org.OData.Validation.V1.Minimum/$Decimal"] &&
+				!isNaN(oProperty.annotations?.Validation?.Minimum)
+					? `${oProperty.annotations?.Validation?.Minimum}`
+					: undefined,
+			maximum:
+				oTargetMapping.constraints?.["@Org.OData.Validation.V1.Maximum/$Decimal"] &&
+				!isNaN(oProperty.annotations?.Validation?.Maximum)
+					? `${oProperty.annotations?.Validation?.Maximum}`
+					: undefined,
+			isDigitSequence:
+				propertyTypeConfig.type === "sap.ui.model.odata.type.String" &&
+				oTargetMapping.constraints?.["@com.sap.vocabularies.Common.v1.IsDigitSequence"] &&
+				(oProperty as Property).annotations?.Common?.IsDigitSequence
+					? true
+					: undefined
+		};
+	}
+	propertyTypeConfig.formatOptions = {
+		parseAsString:
+			propertyTypeConfig?.type?.indexOf("sap.ui.model.odata.type.Int") === 0 ||
+			propertyTypeConfig?.type?.indexOf("sap.ui.model.odata.type.Double") === 0
+				? false
+				: undefined,
+		emptyString:
+			propertyTypeConfig?.type?.indexOf("sap.ui.model.odata.type.Int") === 0 ||
+			propertyTypeConfig?.type?.indexOf("sap.ui.model.odata.type.Double") === 0
+				? ""
+				: undefined,
+		parseKeepsEmptyString: propertyTypeConfig.type === "sap.ui.model.odata.type.String" ? true : undefined
+	};
+	return propertyTypeConfig;
+};
+
 export const getBindingWithUnitOrCurrency = function(
 	oPropertyDataModelPath: DataModelObjectPath,
 	propertyBindingExpression: Expression<string>