@sapui5/sap.fe.base 1.128.0 → 1.129.0

package/src/sap/fe/base/BindingToolkit.ts

@@ -101,6 +101,7 @@ type ComplexTypeExpression<T> = BaseExpression<T> & {
 	_type: "ComplexType";
 	type: string;
 	formatOptions: FormatOptions;
+	constraints: object;
 	parameters: object;
 	bindingParameters: BindingToolkitExpression<unknown>[];
 };
@@ -174,7 +175,6 @@ export function isProperty(serviceObject: unknown): serviceObject is Property {
 
 /**
  * An expression that evaluates to type T.
- *
  * @typedef BindingToolkitExpression
  */
 export type BindingToolkitExpression<T> =
@@ -275,7 +275,6 @@ export function hasUnresolvableExpression(...expressions: BindingToolkitExpressi
 }
 /**
  * Check two expressions for (deep) equality.
- *
  * @param a
  * @param b
  * @returns `true` if the two expressions are equal
@@ -375,7 +374,6 @@ export function _checkExpressionsAreEqual<T>(a: BindingToolkitExpression<T>, b:
 
 /**
  * Converts a nested SetExpression by inlining operands of type SetExpression with the same operator.
- *
  * @param expression The expression to flatten
  * @returns A new SetExpression with the same operator
  */
@@ -397,7 +395,6 @@ function flattenSetExpression(expression: SetExpression): SetExpression {
 
 /**
  * Detects whether an array of boolean expressions contains an expression and its negation.
- *
  * @param expressions Array of expressions
  * @returns `true` if the set of expressions contains an expression and its negation
  */
@@ -418,7 +415,6 @@ function hasOppositeExpressions(expressions: BindingToolkitExpression<boolean>[]
  *
  * The expression is simplified to false if this can be decided statically (that is, if one operand is a constant
  * false or if the expression contains an operand and its negation).
- *
  * @param operands Expressions to connect by `and`
  * @returns Expression evaluating to boolean
  */
@@ -463,7 +459,6 @@ export function and(...operands: ExpressionOrPrimitive<boolean>[]): BindingToolk
  *
  * The expression is simplified to true if this can be decided statically (that is, if one operand is a constant
  * true or if the expression contains an operand and its negation).
- *
  * @param operands Expressions to connect by `or`
  * @returns Expression evaluating to boolean
  */
@@ -504,7 +499,6 @@ export function or(...operands: ExpressionOrPrimitive<boolean>[]): BindingToolki
 
 /**
  * Logical `not` operator.
- *
  * @param operand The expression to reverse
  * @returns The resulting expression that evaluates to boolean
  */
@@ -556,7 +550,6 @@ export function not(operand: ExpressionOrPrimitive<boolean>): BindingToolkitExpr
 
 /**
  * Evaluates whether a binding expression is equal to true with a loose equality.
- *
  * @param operand The expression to check
  * @returns The resulting expression that evaluates to boolean
  */
@@ -573,7 +566,6 @@ export function isTruthy(operand: BindingToolkitExpression<string>): BindingTool
 
 /**
  * Creates a binding expression that will be evaluated by the corresponding model.
- *
  * @param path
  * @param modelName
  * @param visitedNavigationPaths
@@ -592,7 +584,6 @@ export function bindingExpression<TargetType extends PrimitiveType>(
 
 /**
  * Creates a binding expression that will be evaluated by the corresponding model.
- *
  * @template TargetType
  * @param path The path on the model
  * @param [modelName] The name of the model
@@ -649,7 +640,6 @@ type PlainExpressionObject = { [index: string]: BindingToolkitExpression<unknown
 
 /**
  * Creates a constant expression based on a primitive value.
- *
  * @template T
  * @param value The constant to wrap in an expression
  * @returns The constant expression
@@ -711,7 +701,6 @@ export function resolveBindingString<T extends PrimitiveType>(
 
 /**
  * A named reference.
- *
  * @see fn
  * @param reference Reference
  * @returns The object reference binding part
@@ -722,7 +711,6 @@ export function ref(reference: string | null): ReferenceExpression {
 
 /**
  * Wrap a primitive into a constant expression if it is not already an expression.
- *
  * @template T
  * @param something The object to wrap in a Constant expression
  * @returns Either the original object or the wrapped one depending on the case
@@ -740,7 +728,6 @@ export function wrapPrimitive<T extends PrimitiveType>(something: ExpressionOrPr
  *
  * Every object having a property named `_type` of some value is considered an expression, even if there is actually
  * no such expression type supported.
- *
  * @param expression
  * @returns `true` if the expression is a binding toolkit expression
  */
@@ -752,7 +739,6 @@ export function isBindingToolkitExpression(
 
 /**
  * Checks if the expression or value provided is constant or not.
- *
  * @template T The target type
  * @param  maybeConstant The expression or primitive value that is to be checked
  * @returns `true` if it is constant
@@ -771,7 +757,6 @@ function isFalse(expression: BindingToolkitExpression<PrimitiveType>): boolean {
 
 /**
  * Checks if the expression or value provided is a path in model expression or not.
- *
  * @template T The target type
  * @param  maybeBinding The expression or primitive value that is to be checked
  * @returns `true` if it is a path in model expression
@@ -784,7 +769,6 @@ export function isPathInModelExpression<T extends PrimitiveType>(
 
 /**
  * Checks if the expression or value provided is a complex type expression.
- *
  * @template T The target type
  * @param  maybeBinding The expression or primitive value that is to be checked
  * @returns `true` if it is a path in model expression
@@ -797,7 +781,6 @@ export function isComplexTypeExpression<T extends PrimitiveType>(
 
 /**
  * Checks if the expression or value provided is a concat expression or not.
- *
  * @param expression
  * @returns `true` if the expression is a ConcatExpression
  */
@@ -807,7 +790,6 @@ function isConcatExpression(expression: BindingToolkitExpression<PrimitiveType>)
 
 /**
  * Checks if the expression or value provided is a IfElse expression or not.
- *
  * @param expression
  * @returns `true` if the expression is a IfElseExpression
  */
@@ -817,7 +799,6 @@ function isIfElseExpression(expression: BindingToolkitExpression<PrimitiveType>)
 
 /**
  * Checks if the expression provided is a comparison or not.
- *
  * @template T The target type
  * @param expression The expression
  * @returns `true` if the expression is a ComparisonExpression
@@ -828,7 +809,6 @@ function isComparison<T extends PrimitiveType>(expression: BindingToolkitExpress
 
 /**
  * Checks whether the input parameter is a constant expression of type undefined.
- *
  * @param expression The input expression or object in general
  * @returns `true` if the input is constant which has undefined for value
  */
@@ -863,7 +843,6 @@ function isPrimitiveObject(objectType: object): boolean {
 }
 /**
  * Check if the passed annotation annotationValue is a ComplexAnnotationExpression.
- *
  * @template T The target type
  * @param  annotationValue The annotation annotationValue to evaluate
  * @returns `true` if the object is a {ComplexAnnotationExpression}
@@ -874,7 +853,6 @@ function isComplexAnnotationExpression<T>(annotationValue: PropertyAnnotationVal
 
 /**
  * Generate the corresponding annotationValue for a given annotation annotationValue.
- *
  * @template T The target type
  * @param annotationValue The source annotation annotationValue
  * @param visitedNavigationPaths The path from the root entity set
@@ -961,7 +939,6 @@ export function getExpressionFromAnnotation<T extends PrimitiveType>(
 
 /**
  * Parse the annotation condition into an expression.
- *
  * @template T The target type
  * @param annotationValue The condition or value from the annotation
  * @param visitedNavigationPaths The path from the root entity set
@@ -1052,7 +1029,6 @@ function parseAnnotationCondition<T extends PrimitiveType>(
 
 /**
  * Process the {IfAnnotationExpressionValue} into an expression.
- *
  * @template T The target type
  * @param annotationValue An If expression returning the type T
  * @param visitedNavigationPaths The path from the root entity set
@@ -1144,7 +1120,6 @@ export function annotationApplyExpression(
 
 /**
  * Generic helper for the comparison operations (equal, notEqual, ...).
- *
  * @template T The target type
  * @param operator The operator to apply
  * @param leftOperand The operand on the left side of the operator
@@ -1220,7 +1195,6 @@ function comparison<T extends PrimitiveType>(
 
 /**
  * Generic helper for the length of an expression.
- *
  * @param expression The input expression pointing to an array
  * @param checkUndefined Is the array potentially undefined
  * @returns An expression representing the length
@@ -1243,7 +1217,6 @@ export function length(
 
 /**
  * Comparison: "equal" (===).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1295,7 +1268,6 @@ export function equal<T extends PrimitiveType>(
 
 /**
  * Comparison: "not equal" (!==).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1310,7 +1282,6 @@ export function notEqual<T extends PrimitiveType>(
 
 /**
  * Comparison: "greater or equal" (>=).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1325,7 +1296,6 @@ export function greaterOrEqual<T extends DefinedPrimitiveType>(
 
 /**
  * Comparison: "greater than" (>).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1340,7 +1310,6 @@ export function greaterThan<T extends DefinedPrimitiveType>(
 
 /**
  * Comparison: "less or equal" (<=).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1355,7 +1324,6 @@ export function lessOrEqual<T extends DefinedPrimitiveType>(
 
 /**
  * Comparison: "less than" (<).
- *
  * @template T The target type
  * @param leftOperand The operand on the left side
  * @param rightOperand The operand on the right side of the comparison
@@ -1372,7 +1340,6 @@ export function lessThan<T extends DefinedPrimitiveType>(
  * If-then-else expression.
  *
  * Evaluates to onTrue if the condition evaluates to true, else evaluates to onFalse.
- *
  * @template T The target type
  * @param condition The condition to evaluate
  * @param onTrue Expression result if the condition evaluates to true
@@ -1470,7 +1437,6 @@ export function ifElse<T extends PrimitiveType>(
 
 /**
  * Checks whether the current expression has a reference to the default model (undefined).
- *
  * @param expression The expression to evaluate
  * @returns `true` if there is a reference to the default context
  */
@@ -1528,7 +1494,6 @@ type FunctionParameters<T, F extends FunctionOrName<T>> = F extends Fn<T> ? Para
 /**
  * Calls a formatter function to process the parameters.
  * If requireContext is set to true and no context is passed a default context will be added automatically.
- *
  * @template T
  * @template U
  * @param parameters The list of parameter that should match the type and number of the formatter function
@@ -1640,7 +1605,6 @@ export function setUpConstraints(targetMapping: TypeMappingDefinition, property:
 
 /**
  * Generates the binding expression for the property, and sets up the formatOptions and constraints.
- *
  * @param property The Property for which we are setting up the binding
  * @param propertyBindingExpression The BindingExpression of the property above. Serves as the basis to which information can be added
  * @param ignoreConstraints Ignore constraints of the property
@@ -1678,7 +1642,7 @@ export function formatWithTypeInformation<T>(
 		});
 	}
 	if (outExpression.type === "sap.ui.model.odata.type.String" && isProperty(property)) {
-		if (outExpression.constraints?.isDigitSequence || outExpression.constraints?.nullable !== false) {
+		if (outExpression.constraints?.isDigitSequence || (outExpression.constraints?.nullable !== false && property.nullable === true)) {
 			outExpression.formatOptions.parseKeepsEmptyString = false;
 		} else {
 			outExpression.formatOptions.parseKeepsEmptyString = true;
@@ -1750,20 +1714,21 @@ export const getFiscalType = function (property: Property): string | undefined {
 /**
  * Calls a complex type to process the parameters.
  * If requireContext is set to true and no context is passed, a default context will be added automatically.
- *
  * @template T
  * @template U
  * @param parameters The list of parameters that should match the type for the complex type=
  * @param type The complex type to use
  * @param [contextEntityType] The context entity type to consider
  * @param oFormatOptions
+ * @param oConstraintOptions
  * @returns The corresponding expression
  */
 export function addTypeInformation<T, U extends Fn<T>>(
 	parameters: WrappedTuple<Parameters<U>>,
 	type: string,
 	contextEntityType?: EntityType,
-	oFormatOptions?: ComplexTypeFormatOptions
+	oFormatOptions?: ComplexTypeFormatOptions,
+	oConstraintOptions?: ComplexTypeConstraintOptions
 ): UnresolvablePathExpression | ComplexTypeExpression<T> | ConstantExpression<T> {
 	const parameterExpressions = (parameters as ExpressionOrPrimitive<PrimitiveType>[]).map(wrapPrimitive);
 	if (hasUnresolvableExpression(...parameterExpressions)) {
@@ -1796,6 +1761,7 @@ export function addTypeInformation<T, U extends Fn<T>>(
 		_type: "ComplexType",
 		type: type,
 		formatOptions: oFormatOptions || {},
+		constraints: oConstraintOptions || {},
 		parameters: {},
 		bindingParameters: parameterExpressions
 	};
@@ -1812,9 +1778,12 @@ type ComplexTypeFormatOptions = {
 	showTimezone?: boolean;
 };
 
+export type ComplexTypeConstraintOptions = {
+	skipDecimalsValidation?: boolean;
+};
+
 /**
  * Process the formatOptions for a complexType based on the first parameter.
- *
  * @param param The first parameter of the complex type
  * @param formatOptions Initial formatOptions
  * @returns The modified formatOptions
@@ -1837,13 +1806,16 @@ function _getComplexTypeFormatOptionsFromFirstParam<T, U extends Fn<T>>(
 		} else {
 			formatOptions = formatOptions?.showMeasure === false ? { parseAsString: false, showMeasure: false } : { parseAsString: false };
 		}
-		formatOptions.emptyString = null;
+		if (param?.constraints?.nullable !== false) {
+			formatOptions.emptyString = null;
+		} else {
+			formatOptions.emptyString = "";
+		}
 	}
 	return formatOptions;
 }
 /**
  * Function call, optionally with arguments.
- *
  * @param func Function name or reference to function
  * @param parameters Arguments
  * @param on Object to call the function on
@@ -1868,7 +1840,6 @@ export function fn<T, U extends FunctionOrName<T>>(
 
 /**
  * Shortcut function to determine if a binding value is null, undefined or empty.
- *
  * @param expression
  * @returns A Boolean expression evaluating the fact that the current element is empty
  */
@@ -2075,7 +2046,6 @@ const needParenthesis = function <T extends PrimitiveType>(expr: ExpressionOrPri
 
 /**
  * Compiles a constant object to a string.
- *
  * @param expr
  * @param isNullable
  * @returns The compiled string
@@ -2098,7 +2068,6 @@ function compileConstantObject(expr: ConstantExpression<object>, isNullable = fa
 
 /**
  * Compiles a Constant Binding Expression.
- *
  * @param expr
  * @param embeddedInBinding
  * @param isNullable
@@ -2156,7 +2125,6 @@ export function compileConstant<T extends PrimitiveType>(
 
 /**
  * Generates the binding string for a Binding expression.
- *
  * @param expressionForBinding The expression to compile
  * @param embeddedInBinding Whether the expression to compile is embedded into another expression
  * @param embeddedSeparator The binding value evaluator ($ or % depending on whether we want to force the type or not)
@@ -2207,6 +2175,9 @@ function compileComplexTypeExpression<T extends PrimitiveType>(expression: Compl
 	if (hasElements(expression.formatOptions)) {
 		outputEnd += `, formatOptions: ${compileExpression(expression.formatOptions)}`;
 	}
+	if (hasElements(expression.constraints)) {
+		outputEnd += `, constraints: ${compileExpression(expression.constraints)}`;
+	}
 	if (hasElements(expression.parameters)) {
 		outputEnd += `, parameters: ${compileExpression(expression.parameters)}`;
 	}
@@ -2219,7 +2190,6 @@ function compileComplexTypeExpression<T extends PrimitiveType>(expression: Compl
 
 /**
  * Wrap the compiled binding string as required depending on its context.
- *
  * @param expression The compiled expression
  * @param embeddedInBinding True if the compiled expression is to be embedded in a binding
  * @param parenthesisRequired True if the embedded binding needs to be wrapped in parethesis so that it is evaluated as one
@@ -2243,7 +2213,6 @@ export function wrapBindingExpression(
 
 /**
  * Compile an expression into an expression binding.
- *
  * @template T The target type
  * @param expression The expression to compile
  * @param embeddedInBinding Whether the expression to compile is embedded into another expression
@@ -2368,7 +2337,6 @@ export function compileExpression<T extends PrimitiveType>(
 
 /**
  * Compile a comparison expression.
- *
  * @param expression The comparison expression.
  * @returns The compiled expression. Needs wrapping before it can be used as an expression binding.
  */
@@ -2383,7 +2351,6 @@ function compileComparisonExpression(expression: ComparisonExpression): string {
 
 /**
  * Compile a formatter expression.
- *
  * @param expression The formatter expression.
  * @returns The compiled expression.
  */
@@ -2406,7 +2373,6 @@ function compileFormatterExpression<T extends PrimitiveType>(expression: Formatt
 
 /**
  * Compile the path parameter of a formatter call.
- *
  * @param expression The binding part to evaluate
  * @param singlePath Whether there is one or multiple path to consider
  * @returns The string snippet to include in the overall binding definition
@@ -2448,7 +2414,6 @@ function hasElements(obj: object | undefined): boolean {
 
 /**
  * Compile a binding expression path.
- *
  * @param expression The expression to compile.
  * @returns The compiled path.
  */