@sapui5/sap.fe.core 1.102.0 → 1.103.0

package/src/sap/fe/core/converters/controls/ObjectPage/HeaderFacet.ts

@@ -1,27 +1,28 @@
-import {
+import type {
 	DataFieldAbstractTypes,
 	DataPoint,
 	FacetTypes,
 	FieldGroup,
-	ReferenceFacetTypes,
-	UIAnnotationTypes
-} from "@sap-ux/vocabularies-types";
+	ReferenceFacetTypes
+} from "@sap-ux/vocabularies-types/vocabularies/UI";
+import { UIAnnotationTypes } from "@sap-ux/vocabularies-types/vocabularies/UI";
 import { getSemanticObjectPath } from "sap/fe/core/converters/annotations/DataField";
+import type { ConfigurableObject, ConfigurableRecord, CustomElement, Position } from "sap/fe/core/converters/helpers/ConfigurableObject";
+import { insertCustomElements, Placement } from "sap/fe/core/converters/helpers/ConfigurableObject";
 import {
-	ConfigurableObject,
-	ConfigurableRecord,
-	CustomElement,
-	insertCustomElements,
-	Placement,
-	Position
-} from "sap/fe/core/converters/helpers/ConfigurableObject";
-import { CustomHeaderFacetID, HeaderFacetContainerID, HeaderFacetFormID, HeaderFacetID } from "sap/fe/core/converters/helpers/ID";
+	getCustomHeaderFacetID,
+	getHeaderFacetContainerID,
+	getHeaderFacetFormID,
+	getHeaderFacetID
+} from "sap/fe/core/converters/helpers/ID";
 import { KeyHelper } from "sap/fe/core/converters/helpers/Key";
-import { ManifestHeaderFacet } from "sap/fe/core/converters/ManifestSettings";
-import { annotationExpression, BindingExpression, compileBinding, equal, not } from "sap/fe/core/helpers/BindingExpression";
+import type { ManifestHeaderFacet } from "sap/fe/core/converters/ManifestSettings";
+import type { CompiledBindingToolkitExpression } from "sap/fe/core/helpers/BindingToolkit";
+import { compileExpression, equal, getExpressionFromAnnotation, not } from "sap/fe/core/helpers/BindingToolkit";
 import { generate } from "../../../helpers/StableIdHelper";
-import ConverterContext from "../../ConverterContext";
-import { AnnotationFormElement, FormElement, FormElementType, getFormElementsFromManifest } from "../Common/Form";
+import type ConverterContext from "../../ConverterContext";
+import type { AnnotationFormElement, FormElement } from "../Common/Form";
+import { FormElementType, getFormElementsFromManifest } from "../Common/Form";
 
 // region definitions
 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -82,7 +83,7 @@ type BaseHeaderFacet = ConfigurableObject & {
 	annotationPath?: string;
 	flexSettings: FlexSettings;
 	stashed: boolean;
-	visible: BindingExpression<boolean>;
+	visible: CompiledBindingToolkitExpression;
 	targetAnnotationValue?: string;
 	targetAnnotationType?: TargetAnnotationType;
 };
@@ -126,9 +127,8 @@ export type CustomObjectPageHeaderFacet = CustomElement<ObjectPageHeaderFacet> &
 /**
  * Retrieve header facets from annotations.
  *
- * @param {ConverterContext} converterContext
- *
- * @returns {ObjectPageHeaderFacet} Header facets from annotations
+ * @param converterContext
+ * @returns Header facets from annotations
  */
 export function getHeaderFacetsFromAnnotations(converterContext: ConverterContext): ObjectPageHeaderFacet[] {
 	const headerFacets: ObjectPageHeaderFacet[] = [];
@@ -145,9 +145,8 @@ export function getHeaderFacetsFromAnnotations(converterContext: ConverterContex
 /**
  * Retrieve custom header facets from manifest.
  *
- * @param {ConfigurableRecord<ManifestHeaderFacet>} manifestCustomHeaderFacets
- *
- * @returns {Record<string, CustomObjectPageHeaderFacet>} HeaderFacets from manifest
+ * @param manifestCustomHeaderFacets
+ * @returns HeaderFacets from manifest
  */
 export function getHeaderFacetsFromManifest(
 	manifestCustomHeaderFacets: ConfigurableRecord<ManifestHeaderFacet>
@@ -165,11 +164,10 @@ export function getHeaderFacetsFromManifest(
 /**
  * Retrieve stashed settings for header facets from manifest.
  *
- * @param {FacetTypes} facetDefinition
- * @param {FacetTypes} collectionFacetDefinition
- * @param {ConverterContext} converterContext
- *
- * @returns {boolean} Stashed setting for header facet or false
+ * @param facetDefinition
+ * @param collectionFacetDefinition
+ * @param converterContext
+ * @returns Stashed setting for header facet or false
  */
 export function getStashedSettingsForHeaderFacet(
 	facetDefinition: FacetTypes,
@@ -192,11 +190,10 @@ export function getStashedSettingsForHeaderFacet(
 /**
  * Retrieve flexibility designtime settings from manifest.
  *
- * @param {FacetTypes} facetDefinition
- * @param {FacetTypes} collectionFacetDefinition
- * @param {ConverterContext} converterContext
- *
- * @returns {FlexDesignTimeType} Designtime setting or default
+ * @param facetDefinition
+ * @param collectionFacetDefinition
+ * @param converterContext
+ * @returns Designtime setting or default
  */
 export function getDesignTimeMetadataSettingsForHeaderFacet(
 	facetDefinition: FacetTypes,
@@ -221,6 +218,9 @@ export function getDesignTimeMetadataSettingsForHeaderFacet(
 				case FlexDesignTimeType.NotAdaptableTree:
 				case FlexDesignTimeType.NotAdaptableVisibility:
 					designTimeMetadata = designTime;
+					break;
+				default:
+					break;
 			}
 		}
 	}
@@ -236,9 +236,9 @@ function createReferenceHeaderFacet(
 	converterContext: ConverterContext
 ): ReferenceFacet | undefined {
 	if (facetDefinition.$Type === UIAnnotationTypes.ReferenceFacet && !(facetDefinition.annotations?.UI?.Hidden?.valueOf() === true)) {
-		const headerFacetID = HeaderFacetID({ Facet: facetDefinition }),
-			getHeaderFacetKey = (facetDefinition: FacetTypes, fallback: string): string => {
-				return facetDefinition.ID?.toString() || facetDefinition.Label?.toString() || fallback;
+		const headerFacetID = getHeaderFacetID({ Facet: facetDefinition }),
+			getHeaderFacetKey = (facetDefinitionToCheck: FacetTypes, fallback: string): string => {
+				return facetDefinitionToCheck.ID?.toString() || facetDefinitionToCheck.Label?.toString() || fallback;
 			},
 			targetAnnotationValue = facetDefinition.Target.value,
 			targetAnnotationType = getTargetAnnotationType(facetDefinition);
@@ -255,6 +255,8 @@ function createReferenceHeaderFacet(
 				headerDataPointData = getDataPointData(facetDefinition);
 				break;
 			// ToDo: Handle other cases
+			default:
+				break;
 		}
 
 		const { annotations } = facetDefinition;
@@ -262,14 +264,14 @@ function createReferenceHeaderFacet(
 			type: HeaderFacetType.Annotation,
 			facetType: FacetType.Reference,
 			id: headerFacetID,
-			containerId: HeaderFacetContainerID({ Facet: facetDefinition }),
+			containerId: getHeaderFacetContainerID({ Facet: facetDefinition }),
 			key: getHeaderFacetKey(facetDefinition, headerFacetID),
 			flexSettings: {
 				designtime: getDesignTimeMetadataSettingsForHeaderFacet(facetDefinition, collectionFacetDefinition, converterContext)
 			},
 			stashed: getStashedSettingsForHeaderFacet(facetDefinition, collectionFacetDefinition, converterContext),
-			visible: compileBinding(not(equal(annotationExpression(annotations?.UI?.Hidden?.valueOf()), true))),
-			annotationPath: converterContext.getEntitySetBasedAnnotationPath(facetDefinition.fullyQualifiedName) + "/",
+			visible: compileExpression(not(equal(getExpressionFromAnnotation(annotations?.UI?.Hidden?.valueOf()), true))),
+			annotationPath: `${converterContext.getEntitySetBasedAnnotationPath(facetDefinition.fullyQualifiedName)}/`,
 			targetAnnotationValue,
 			targetAnnotationType,
 			headerFormData,
@@ -286,7 +288,7 @@ function createCollectionHeaderFacet(
 ): CollectionFacet | undefined {
 	if (collectionFacetDefinition.$Type === UIAnnotationTypes.CollectionFacet) {
 		const facets: ReferenceFacet[] = [],
-			headerFacetID = HeaderFacetID({ Facet: collectionFacetDefinition }),
+			headerFacetID = getHeaderFacetID({ Facet: collectionFacetDefinition }),
 			getHeaderFacetKey = (facetDefinition: FacetTypes, fallback: string): string => {
 				return facetDefinition.ID?.toString() || facetDefinition.Label?.toString() || fallback;
 			};
@@ -306,7 +308,7 @@ function createCollectionHeaderFacet(
 			type: HeaderFacetType.Annotation,
 			facetType: FacetType.Collection,
 			id: headerFacetID,
-			containerId: HeaderFacetContainerID({ Facet: collectionFacetDefinition }),
+			containerId: getHeaderFacetContainerID({ Facet: collectionFacetDefinition }),
 			key: getHeaderFacetKey(collectionFacetDefinition, headerFacetID),
 			flexSettings: {
 				designtime: getDesignTimeMetadataSettingsForHeaderFacet(
@@ -316,8 +318,10 @@ function createCollectionHeaderFacet(
 				)
 			},
 			stashed: getStashedSettingsForHeaderFacet(collectionFacetDefinition, collectionFacetDefinition, converterContext),
-			visible: compileBinding(not(equal(annotationExpression(collectionFacetDefinition.annotations?.UI?.Hidden?.valueOf()), true))),
-			annotationPath: converterContext.getEntitySetBasedAnnotationPath(collectionFacetDefinition.fullyQualifiedName) + "/",
+			visible: compileExpression(
+				not(equal(getExpressionFromAnnotation(collectionFacetDefinition.annotations?.UI?.Hidden?.valueOf()), true))
+			),
+			annotationPath: `${converterContext.getEntitySetBasedAnnotationPath(collectionFacetDefinition.fullyQualifiedName)}/`,
 			facets
 		};
 	}
@@ -355,7 +359,7 @@ function getFieldGroupFormData(facetDefinition: ReferenceFacetTypes, converterCo
 	);
 
 	return {
-		id: HeaderFacetFormID({ Facet: facetDefinition }),
+		id: getHeaderFacetFormID({ Facet: facetDefinition }),
 		label: facetDefinition.Label?.toString(),
 		formElements
 	};
@@ -364,10 +368,9 @@ function getFieldGroupFormData(facetDefinition: ReferenceFacetTypes, converterCo
 /**
  * Creates an array of manifest-based FormElements.
  *
- * @param {FacetType} facetDefinition The definition of the facet
- * @param {ConverterContext} converterContext The converter context for the facet
- *
- * @returns {Array} Annotation-based FormElements
+ * @param facetDefinition The definition of the facet
+ * @param converterContext The converter context for the facet
+ * @returns Annotation-based FormElements
  */
 function getFormElementsFromAnnotations(facetDefinition: FacetTypes, converterContext: ConverterContext): AnnotationFormElement[] {
 	const annotationBasedFormElements: AnnotationFormElement[] = [];
@@ -389,23 +392,23 @@ function getFormElementsFromAnnotations(facetDefinition: FacetTypes, converterCo
 						isValueMultilineText: dataField.Value?.$target?.annotations?.UI?.MultiLineText?.valueOf() === true,
 						type: FormElementType.Annotation,
 						key: KeyHelper.generateKeyFromDataField(dataField),
-						visible: compileBinding(not(equal(annotationExpression(annotations?.UI?.Hidden?.valueOf()), true))),
+						visible: compileExpression(not(equal(getExpressionFromAnnotation(annotations?.UI?.Hidden?.valueOf()), true))),
 						label: dataField.Value?.$target?.annotations?.Common?.Label || dataField.Label,
-						idPrefix: HeaderFacetFormID({ Facet: facetDefinition }, dataField),
-						annotationPath: converterContext.getEntitySetBasedAnnotationPath(dataField.fullyQualifiedName) + "/",
+						idPrefix: getHeaderFacetFormID({ Facet: facetDefinition }, dataField),
+						annotationPath: `${converterContext.getEntitySetBasedAnnotationPath(dataField.fullyQualifiedName)}/`,
 						semanticObjectPath: semanticObjectAnnotationPath
 					});
 				} else if (dataField.$Type === UIAnnotationTypes.DataFieldForAnnotation) {
 					const { annotations } = dataField;
 					annotationBasedFormElements.push({
-						// FIXME this is wrong
+						// FIXME this is wrong, the annotation should exist, so the target is not properly identified
 						isValueMultilineText: (dataField.Target?.$target?.annotations?.UI as any)?.MultiLineText?.valueOf() === true,
 						type: FormElementType.Annotation,
 						key: KeyHelper.generateKeyFromDataField(dataField),
-						visible: compileBinding(not(equal(annotationExpression(annotations?.UI?.Hidden?.valueOf()), true))),
+						visible: compileExpression(not(equal(getExpressionFromAnnotation(annotations?.UI?.Hidden?.valueOf()), true))),
 						label: dataField.Target?.$target?.annotations?.Common?.Label?.toString() || dataField.Label?.toString(),
-						idPrefix: HeaderFacetFormID({ Facet: facetDefinition }, dataField),
-						annotationPath: converterContext.getEntitySetBasedAnnotationPath(dataField.fullyQualifiedName) + "/",
+						idPrefix: getHeaderFacetFormID({ Facet: facetDefinition }, dataField),
+						annotationPath: `${converterContext.getEntitySetBasedAnnotationPath(dataField.fullyQualifiedName)}/`,
 						semanticObjectPath: semanticObjectAnnotationPath
 					});
 				}
@@ -432,10 +435,9 @@ function getDataPointData(facetDefinition: FacetTypes): HeaderDataPointData {
 /**
  * Creates an annotation-based header facet.
  *
- * @param {FacetTypes} facetDefinition The definition of the facet
- * @param {ConverterContext} converterContext The converter context
- *
- * @returns {ObjectPageHeaderFacet} The created annotation-based header facet
+ * @param facetDefinition The definition of the facet
+ * @param converterContext The converter context
+ * @returns The created annotation-based header facet
  */
 function createHeaderFacet(facetDefinition: FacetTypes, converterContext: ConverterContext): ObjectPageHeaderFacet | undefined {
 	let headerFacet: ObjectPageHeaderFacet | undefined;
@@ -447,6 +449,8 @@ function createHeaderFacet(facetDefinition: FacetTypes, converterContext: Conver
 		case UIAnnotationTypes.CollectionFacet:
 			headerFacet = createCollectionHeaderFacet(facetDefinition, converterContext);
 			break;
+		default:
+			break;
 	}
 
 	return headerFacet;
@@ -461,21 +465,20 @@ function generateBinding(requestGroupId?: string): string | undefined {
 		return undefined;
 	}
 	const groupId =
-		["Heroes", "Decoration", "Workers", "LongRunners"].indexOf(requestGroupId) !== -1 ? "$auto." + requestGroupId : requestGroupId;
+		["Heroes", "Decoration", "Workers", "LongRunners"].indexOf(requestGroupId) !== -1 ? `$auto.${requestGroupId}` : requestGroupId;
 
-	return "{ path : '', parameters : { $$groupId : '" + groupId + "' } }";
+	return `{ path : '', parameters : { $$groupId : '${groupId}' } }`;
 }
 
 /**
  * Create a manifest based custom header facet.
  *
- * @param {ManifestHeaderFacet} customHeaderFacetDefinition
- * @param {string} headerFacetKey
- *
- * @returns {CustomObjectPageHeaderFacet} The manifest based custom header facet created
+ * @param customHeaderFacetDefinition
+ * @param headerFacetKey
+ * @returns The manifest based custom header facet created
  */
 function createCustomHeaderFacet(customHeaderFacetDefinition: ManifestHeaderFacet, headerFacetKey: string): CustomObjectPageHeaderFacet {
-	const customHeaderFacetID = CustomHeaderFacetID(headerFacetKey);
+	const customHeaderFacetID = getCustomHeaderFacetID(headerFacetKey);
 
 	let position: Position | undefined = customHeaderFacetDefinition.position;
 	if (!position) {