@sapui5/sap.fe.core 1.101.0 → 1.103.0

package/src/sap/fe/core/converters/controls/ListReport/FilterBar.ts

@@ -1,22 +1,26 @@
-import { EntityType, NavigationProperty, Property } from "@sap-ux/annotation-converter";
-import { AnnotationTerm, DataFieldAbstractTypes, DataFieldTypes, ReferenceFacetTypes, UIAnnotationTerms } from "@sap-ux/vocabularies-types";
-import { PropertyPath } from "@sap-ux/vocabularies-types/dist/Edm";
-import { FieldGroup, FieldGroupType, SelectOptionType } from "@sap-ux/vocabularies-types/dist/generated/UI";
-import { ChartVisualization } from "sap/fe/core/converters/controls/Common/Chart";
-import {
-	getSelectionVariantConfiguration,
-	getTypeConfig,
-	isFilteringCaseSensitive,
-	SelectionVariantConfiguration,
-	TableVisualization
-} from "sap/fe/core/converters/controls/Common/Table";
-import { getVisualFilters, VisualFilters } from "sap/fe/core/converters/controls/ListReport/VisualFilters";
-import ConverterContext from "sap/fe/core/converters/ConverterContext";
-import { ConfigurableObject, CustomElement, insertCustomElements, Placement } from "sap/fe/core/converters/helpers/ConfigurableObject";
+import type { AnnotationTerm, EntityType, NavigationProperty, Property, PropertyPath } from "@sap-ux/vocabularies-types";
+import type {
+	DataFieldAbstractTypes,
+	DataFieldTypes,
+	FieldGroup,
+	FieldGroupType,
+	ReferenceFacetTypes,
+	SelectOptionType
+} from "@sap-ux/vocabularies-types/vocabularies/UI";
+import { UIAnnotationTerms } from "@sap-ux/vocabularies-types/vocabularies/UI";
+import type { ChartVisualization } from "sap/fe/core/converters/controls/Common/Chart";
+import type { SelectionVariantConfiguration, TableVisualization } from "sap/fe/core/converters/controls/Common/Table";
+import { getSelectionVariantConfiguration, getTypeConfig, isFilteringCaseSensitive } from "sap/fe/core/converters/controls/Common/Table";
+import type { VisualFilters } from "sap/fe/core/converters/controls/ListReport/VisualFilters";
+import { getVisualFilters } from "sap/fe/core/converters/controls/ListReport/VisualFilters";
+import type ConverterContext from "sap/fe/core/converters/ConverterContext";
+import type { ConfigurableObject, CustomElement } from "sap/fe/core/converters/helpers/ConfigurableObject";
+import { insertCustomElements, Placement } from "sap/fe/core/converters/helpers/ConfigurableObject";
 import { IssueCategory, IssueSeverity, IssueType } from "sap/fe/core/converters/helpers/IssueManager";
 import { KeyHelper } from "sap/fe/core/converters/helpers/Key";
-import { annotationExpression, compileBinding } from "sap/fe/core/helpers/BindingExpression";
-import { AvailabilityType, FilterFieldManifestConfiguration, FilterManifestConfiguration, FilterSettings } from "../../ManifestSettings";
+import { compileExpression, getExpressionFromAnnotation } from "sap/fe/core/helpers/BindingToolkit";
+import type { FilterFieldManifestConfiguration, FilterManifestConfiguration, FilterSettings } from "../../ManifestSettings";
+import { AvailabilityType } from "../../ManifestSettings";
 import { getSelectionVariant } from "../Common/DataVisualization";
 //import { hasValueHelp } from "sap/fe/core/templating/PropertyHelper";
 
@@ -53,8 +57,8 @@ export type CustomElementFilterField = CustomElement<FilterField>;
 /**
  * Enter all DataFields of a given FieldGroup into the filterFacetMap.
  *
- * @param {AnnotationTerm<FieldGroupType>} fieldGroup
- * @returns {Record<string, FilterGroup>} The map of facets for the given FieldGroup
+ * @param fieldGroup
+ * @returns The map of facets for the given FieldGroup
  */
 function getFieldGroupFilterGroups(fieldGroup: AnnotationTerm<FieldGroupType>): Record<string, FilterGroup> {
 	const filterFacetMap: Record<string, FilterGroup> = {};
@@ -63,8 +67,8 @@ function getFieldGroupFilterGroups(fieldGroup: AnnotationTerm<FieldGroupType>):
 			filterFacetMap[dataField.Value.path] = {
 				group: fieldGroup.fullyQualifiedName,
 				groupLabel:
-					compileBinding(
-						annotationExpression(fieldGroup.Label || fieldGroup.annotations?.Common?.Label || fieldGroup.qualifier)
+					compileExpression(
+						getExpressionFromAnnotation(fieldGroup.Label || fieldGroup.annotations?.Common?.Label || fieldGroup.qualifier)
 					) || fieldGroup.qualifier
 			};
 		}
@@ -83,9 +87,10 @@ function getExcludedFilterProperties(selectionVariants: SelectionVariantConfigur
 
 /**
  * Check that all the tables for a dedicated entity set are configured as analytical table.
- * @param {TableVisualization[]} listReportTables List report tables
- * @param {string} contextPath
- * @returns {boolean} Is FilterBar search field hidden or not
+ *
+ * @param listReportTables List report tables
+ * @param contextPath
+ * @returns Is FilterBar search field hidden or not
  */
 function checkAllTableForEntitySetAreAnalytical(listReportTables: TableVisualization[], contextPath: string | undefined) {
 	if (contextPath && listReportTables.length > 0) {
@@ -130,7 +135,7 @@ function getSelectionVariants(
  *
  * @param entityType The root EntityType
  * @param propertyPath The full path to the target property
- * @returns {string} The formatted condition path
+ * @returns The formatted condition path
  */
 const _getConditionPath = function (entityType: EntityType, propertyPath: string): string {
 	const parts = propertyPath.split("/");
@@ -138,12 +143,12 @@ const _getConditionPath = function (entityType: EntityType, propertyPath: string
 	let key = "";
 	while (parts.length) {
 		let part = parts.shift() as string;
-		partialPath = partialPath ? partialPath + "/" + part : part;
+		partialPath = partialPath ? `${partialPath}/${part}` : part;
 		const property: Property | NavigationProperty = entityType.resolvePath(partialPath);
 		if (property._type === "NavigationProperty" && property.isCollection) {
 			part += "*";
 		}
-		key = key ? key + "/" + part : part;
+		key = key ? `${key}/${part}` : part;
 	}
 	return key;
 };
@@ -168,10 +173,10 @@ const _createFilterSelectionField = function (
 			conditionPath: _getConditionPath(entityType, fullPropertyPath),
 			availability:
 				property.annotations?.UI?.HiddenFilter?.valueOf() === true ? AvailabilityType.Hidden : AvailabilityType.Adaptation,
-			label: compileBinding(annotationExpression(property.annotations.Common?.Label?.valueOf() || property.name)),
+			label: compileExpression(getExpressionFromAnnotation(property.annotations.Common?.Label?.valueOf() || property.name)),
 			group: targetEntityType.name,
-			groupLabel: compileBinding(
-				annotationExpression(targetEntityType?.annotations?.Common?.Label?.valueOf() || targetEntityType.name)
+			groupLabel: compileExpression(
+				getExpressionFromAnnotation(targetEntityType?.annotations?.Common?.Label?.valueOf() || targetEntityType.name)
 			)
 		};
 	}
@@ -253,7 +258,7 @@ const _getSelectionFields = function (
 	if (properties) {
 		properties.forEach((property: Property) => {
 			const propertyPath: string = property.name;
-			const fullPath: string = (navigationPath ? navigationPath + "/" : "") + propertyPath;
+			const fullPath: string = (navigationPath ? `${navigationPath}/` : "") + propertyPath;
 			const selectionField = _createFilterSelectionField(entityType, property, fullPath, includeHidden, converterContext);
 			if (selectionField) {
 				selectionFieldMap[fullPath] = selectionField;
@@ -352,12 +357,12 @@ const _getDefaultFilterFields = function (
 		aSelectOptions?.forEach((selectOption: SelectOptionType) => {
 			const propertyName: any = selectOption.PropertyName;
 			const sPropertyPath: string = propertyName.value;
-			const UISelectionFields: any = {};
+			const currentSelectionFields: any = {};
 			annotatedSelectionFields?.forEach((SelectionField) => {
-				UISelectionFields[SelectionField.value] = true;
+				currentSelectionFields[SelectionField.value] = true;
 			});
 			if (!(sPropertyPath in excludedFilterProperties)) {
-				if (!(sPropertyPath in UISelectionFields)) {
+				if (!(sPropertyPath in currentSelectionFields)) {
 					const FilterField: FilterField | undefined = getFilterField(sPropertyPath, converterContext, entityType);
 					if (FilterField) {
 						selectionFields.push(FilterField);
@@ -368,10 +373,10 @@ const _getDefaultFilterFields = function (
 	} else if (properties) {
 		properties.forEach((property: Property) => {
 			const defaultFilterValue = property.annotations?.Common?.FilterDefaultValue;
-			const PropertyPath = property.name;
-			if (!(PropertyPath in excludedFilterProperties)) {
-				if (defaultFilterValue && !(PropertyPath in UISelectionFields)) {
-					const FilterField: FilterField | undefined = getFilterField(PropertyPath, converterContext, entityType);
+			const propertyPath = property.name;
+			if (!(propertyPath in excludedFilterProperties)) {
+				if (defaultFilterValue && !(propertyPath in UISelectionFields)) {
+					const FilterField: FilterField | undefined = getFilterField(propertyPath, converterContext, entityType);
 					if (FilterField) {
 						selectionFields.push(FilterField);
 					}
@@ -384,17 +389,18 @@ const _getDefaultFilterFields = function (
 
 /**
  * Get all parameter filter fields in case of a parameterized service.
- * @param {ConverterContext} converterContext
- * @returns {FilterField[]} An array of parameter filterfields
+ *
+ * @param converterContext
+ * @returns An array of parameter filterfields
  */
 function _getParameterFields(converterContext: ConverterContext): FilterField[] {
 	const dataModelObjectPath = converterContext.getDataModelObjectPath();
 	const parameterEntityType = dataModelObjectPath.startingEntitySet.entityType;
-	const isParameterized = !!parameterEntityType.annotations?.Common?.ResultContext;
+	const isParameterized = !!parameterEntityType.annotations?.Common?.ResultContext && !dataModelObjectPath.targetEntitySet;
 	const parameterConverterContext =
-		isParameterized && converterContext.getConverterContextFor("/" + dataModelObjectPath.startingEntitySet.name);
+		isParameterized && converterContext.getConverterContextFor(`/${dataModelObjectPath.startingEntitySet.name}`);
 
-	const parameterFields = (
+	return (
 		parameterConverterContext
 			? parameterEntityType.entityProperties.map(function (property) {
 					return _getFilterField(
@@ -406,17 +412,15 @@ function _getParameterFields(converterContext: ConverterContext): FilterField[]
 			  })
 			: []
 	) as FilterField[];
-
-	return parameterFields;
 }
 
 /**
  * Determines if the FilterBar search field is hidden or not.
  *
- * @param {TableVisualization[]} listReportTables The list report tables
- * @param {ChartVisualization[]} charts The ALP charts
- * @param {ConverterContext} converterContext The converter context
- * @returns {boolean} The information if the FilterBar search field is hidden or not
+ * @param listReportTables The list report tables
+ * @param charts The ALP charts
+ * @param converterContext The converter context
+ * @returns The information if the FilterBar search field is hidden or not
  */
 export const getFilterBarhideBasicSearch = function (
 	listReportTables: TableVisualization[],
@@ -443,7 +447,7 @@ export const getFilterBarhideBasicSearch = function (
  *
  * @param entityType The current entityType
  * @param converterContext The converter context
- * @returns {Record<string, CustomElementFilterField>} The filter fields defined in the manifest
+ * @returns The filter fields defined in the manifest
  */
 export const getManifestFilterFields = function (
 	entityType: EntityType,
@@ -651,7 +655,8 @@ export const isMultiValue = function (oProperty: any) {
 const getAnnotatedSelectionFieldData = function (
 	converterContext: ConverterContext,
 	lrTables: TableVisualization[] = [],
-	annotationPath: string = ""
+	annotationPath: string = "",
+	includeHidden: boolean = false
 ) {
 	// Fetch all selectionVariants defined in the different visualizations and different views (multi table mode)
 	const selectionVariants: SelectionVariantConfiguration[] = getSelectionVariants(lrTables, converterContext);
@@ -667,12 +672,12 @@ const getAnnotatedSelectionFieldData = function (
 	// create a map of all potential filter fields based on...
 	const filterFields: Record<string, FilterField> = {
 		// ...non hidden properties of the entity
-		..._getSelectionFields(entityType, "", entityType.entityProperties, false, converterContext),
+		..._getSelectionFields(entityType, "", entityType.entityProperties, includeHidden, converterContext),
 		// ...additional manifest defined navigation properties
 		..._getSelectionFieldsByPath(
 			entityType,
 			converterContext.getManifestWrapper().getFilterConfiguration().navigationProperties,
-			false,
+			includeHidden,
 			converterContext
 		)
 	};
@@ -696,7 +701,7 @@ const getAnnotatedSelectionFieldData = function (
 			return selectionFields;
 		}, []) || [];
 
-	let defaultFilterFields = _getDefaultFilterFields(
+	const defaultFilterFields = _getDefaultFilterFields(
 		aSelectOptions,
 		entityType,
 		converterContext,
@@ -716,7 +721,7 @@ const getAnnotatedSelectionFieldData = function (
 export const processSelectionFields = function (
 	propertyInfoFields: any,
 	converterContext: ConverterContext,
-	defaultValuePropertyFields: any
+	defaultValuePropertyFields?: any
 ) {
 	//get TypeConfig function
 	const selectionFieldTypes: any = [];
@@ -724,7 +729,10 @@ export const processSelectionFields = function (
 	const _fnTypeConfig = function (property: Property, key: string) {
 		const oTypeConfig = getTypeConfig(property, property?.type);
 		selectionFieldTypes.push(property?.type);
-		if (property?.type === sEdmString && (!oTypeConfig.constraints.nullable || oTypeConfig.constraints.nullable === true)) {
+		if (
+			property?.type === sEdmString &&
+			(oTypeConfig.constraints.nullable === undefined || oTypeConfig.constraints.nullable === true)
+		) {
 			oTypeConfig.formatOptions.parseKeepsEmptyString = false;
 		}
 		aTypeConfig[key] = oTypeConfig;
@@ -829,17 +837,20 @@ export const insertCustomManifestElements = function (
 /**
  * Retrieve the configuration for the selection fields that will be used within the filter bar
  * This configuration takes into account annotation and the selection variants.
- * @param {ConverterContext} converterContext
- * @param {TableVisualization[]} lrTables
- * @param {string} annotationPath
- * @returns {FilterSelectionField[]} An array of selection fields
+ *
+ * @param converterContext
+ * @param lrTables
+ * @param annotationPath
+ * @param [includeHidden]
+ * @returns An array of selection fields
  */
 export const getSelectionFields = function (
 	converterContext: ConverterContext,
 	lrTables: TableVisualization[] = [],
-	annotationPath: string = ""
+	annotationPath: string = "",
+	includeHidden?: boolean
 ): any {
-	const oAnnotatedSelectionFieldData = getAnnotatedSelectionFieldData(converterContext, lrTables, annotationPath);
+	const oAnnotatedSelectionFieldData = getAnnotatedSelectionFieldData(converterContext, lrTables, annotationPath, includeHidden);
 	const parameterFields = _getParameterFields(converterContext);
 	let propertyInfoFields: FilterField[] = JSON.parse(JSON.stringify(oAnnotatedSelectionFieldData.propertyInfoFields));
 	const entityType = oAnnotatedSelectionFieldData.entityType;
@@ -944,12 +955,13 @@ export const getSelectionFields = function (
  * (1) a filter property is mandatory,
  * (2) no search field exists (entity isn't search enabled),
  * (3) when the data isn't loaded by default (annotation FetchValues = 2).
- * @param {ConverterContext} converterContext The converter context
- * @param {any} filterRestrictionsAnnotation The FilterRestriction annotation
- * @param {any} valueListAnnotation The ValueList annotation
- * @returns {boolean} The value for expandFilterFields
+ *
+ * @param converterContext The converter context
+ * @param filterRestrictionsAnnotation The FilterRestriction annotation
+ * @param valueListAnnotation The ValueList annotation
+ * @returns The value for expandFilterFields
  */
-export const getExpandFilterFields = function(
+export const getExpandFilterFields = function (
 	converterContext: ConverterContext,
 	filterRestrictionsAnnotation: any,
 	valueListAnnotation: any