@sapui5/sap.fe.macros 1.141.2 → 1.143.0

package/src/sap/fe/macros/filterBar/FilterBarDelegate.ts

@@ -18,6 +18,8 @@ import type { BaseTreeModifier, PreprocessorSettings } from "sap/fe/core/CommonU
 import CommonUtils from "sap/fe/core/CommonUtils";
 import TemplateModel from "sap/fe/core/TemplateModel";
 import { getInvolvedDataModelObjects } from "sap/fe/core/converters/MetaModelConverter";
+import type { PageContextPathTarget } from "sap/fe/core/converters/TemplateConverter";
+import FilterRestrictions from "sap/fe/core/converters/controls/Common/filter/FilterRestrictions";
 import type {
 	PropertyInfo as FEPropertyInfo,
 	FilterField,
@@ -29,6 +31,7 @@ import { isPropertyFilterable } from "sap/fe/core/helpers/MetaModelFunction";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
 import { getLocalizedText, getResourceModel } from "sap/fe/core/helpers/ResourceModelHelper";
 import { generate } from "sap/fe/core/helpers/StableIdHelper";
+import type { DataModelObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
 import { hasValueHelp } from "sap/fe/core/templating/PropertyFormatters";
 import { getModelType } from "sap/fe/core/type/EDM";
 import CommonHelper from "sap/fe/macros/CommonHelper";
@@ -36,6 +39,7 @@ import DelegateUtil from "sap/fe/macros/DelegateUtil";
 import FieldHelper from "sap/fe/macros/field/FieldHelper";
 import type { IFilterControl } from "sap/fe/macros/filter/FilterUtils";
 import FilterUtils from "sap/fe/macros/filter/FilterUtils";
+import UOMValidationDelegate from "sap/fe/macros/filterBar/UOMValidationDelegate";
 import type { PropertyInfo } from "sap/fe/macros/internal/PropertyInfo";
 import { getValueHelpTemplate } from "sap/fe/macros/internal/valuehelp/ValueHelpTemplating";
 import type { ControlPropertyInfo } from "sap/fe/macros/mdc/adapter/StateHelper";
@@ -57,61 +61,62 @@ import type MacroAPI from "../MacroAPI";
 
 type ModifierElement = UI5Element | UI5Element[] | Element | Element[];
 type NullableModifierElement = void | ModifierElement | null;
-const ODataFilterBarDelegate = Object.assign({}, FilterBarDelegate) as typeof FilterBarDelegate & {
-	apiVersion: number;
-	_isFilterInSelectionFields(selectionFields: SelectionFields, filterFieldInfo: FilterField): boolean;
-	_findSelectionField(aSelectionFields: FilterField[], sFlexName: string): FilterField | undefined;
-	clearFilters(oFilterControl: FilterBar): Promise<void>;
-	getTypeMap(): typeof TypeMap;
-	fetchFilterProperties(filterBar: IFilterControl): Promise<ControlPropertyInfo[] | PropertyInfoExternal[]>;
-	fetchProperties(filterBar: FilterBar): Promise<PropertyInfoExternal[]>;
-	_isFilterAdaptable(
-		filterFieldInfo: FilterField,
-		propertyAnnotations: Property,
-		selectionFields?: SelectionFields,
-		filterFacets?: FilterFacets
-	): boolean;
-	fetchPropertiesForEntity(sEntityTypePath: string, oMetaModel: ODataMetaModel, oFilterControl: IFilterControl): PropertyInfo[];
-	_templateCustomFilter(
-		oFilterBar: IFilterControl,
-		sIdPrefix: string,
-		oSelectionFieldInfo: FilterField,
-		oMetaModel: ODataMetaModel,
-		oModifier: BaseTreeModifier
-	): Promise<ModifierElement>;
-	_addP13nItem(sPropertyInfoName: string, oParentControl: FilterBar): Promise<NullableModifierElement>;
-	_addFlexItem(
-		sFlexPropertyName: string,
-		oParentControl: FilterBar,
-		oMetaModel: ODataMetaModel,
-		oModifier: BaseTreeModifier | undefined,
-		oAppComponent?: AppComponent,
-		view?: View
-	): Promise<NullableModifierElement>;
-	addItem(
-		oParentControl: FilterBar,
-		sPropertyInfoName: string,
-		mPropertyBag?: { modifier: BaseTreeModifier; appComponent: AppComponent }
-	): Promise<NullableModifierElement>;
-	addCondition(
-		oParentControl: FilterBar,
-		sPropertyInfoName: string,
-		mPropertyBag: { appComponent: AppComponent; modifier: BaseTreeModifier }
-	): Promise<void | null>;
-	removeItem(
-		oParentControl: FilterBar,
-		oFilterFieldProperty: UI5Element | Element,
-		mPropertyBag: { appComponent: AppComponent; modifier: BaseTreeModifier }
-	): Promise<boolean | null>;
-	removeCondition(
-		oParentControl: FilterBar,
-		sPropertyInfoName: string,
-		mPropertyBag: {
-			appComponent: AppComponent;
-			modifier: BaseTreeModifier;
-		}
-	): Promise<void | null>;
-};
+const ODataFilterBarDelegate = Object.assign({}, FilterBarDelegate, UOMValidationDelegate) as typeof FilterBarDelegate &
+	typeof UOMValidationDelegate & {
+		apiVersion: number;
+		_isFilterInSelectionFields(selectionFields: SelectionFields, filterFieldInfo: FilterField): boolean;
+		_findSelectionField(aSelectionFields: FilterField[], sFlexName: string): FilterField | undefined;
+		clearFilters(oFilterControl: FilterBar): Promise<void>;
+		getTypeMap(): typeof TypeMap;
+		fetchFilterProperties(filterBar: IFilterControl): Promise<ControlPropertyInfo[] | PropertyInfoExternal[]>;
+		fetchProperties(filterBar: FilterBar): Promise<PropertyInfoExternal[]>;
+		_isFilterAdaptable(
+			filterFieldInfo: FilterField,
+			propertyAnnotations: Property,
+			selectionFields?: SelectionFields,
+			filterFacets?: FilterFacets
+		): boolean;
+		fetchPropertiesForEntity(sEntityTypePath: string, oMetaModel: ODataMetaModel, oFilterControl: IFilterControl): PropertyInfo[];
+		_templateCustomFilter(
+			oFilterBar: IFilterControl,
+			sIdPrefix: string,
+			oSelectionFieldInfo: FilterField,
+			oMetaModel: ODataMetaModel,
+			oModifier: BaseTreeModifier
+		): Promise<ModifierElement>;
+		_addP13nItem(sPropertyInfoName: string, oParentControl: FilterBar): Promise<NullableModifierElement>;
+		_addFlexItem(
+			sFlexPropertyName: string,
+			oParentControl: FilterBar,
+			oMetaModel: ODataMetaModel,
+			oModifier: BaseTreeModifier | undefined,
+			oAppComponent?: AppComponent,
+			view?: View
+		): Promise<NullableModifierElement>;
+		addItem(
+			oParentControl: FilterBar,
+			sPropertyInfoName: string,
+			mPropertyBag?: { modifier: BaseTreeModifier; appComponent: AppComponent }
+		): Promise<NullableModifierElement>;
+		addCondition(
+			oParentControl: FilterBar,
+			sPropertyInfoName: string,
+			mPropertyBag: { appComponent: AppComponent; modifier: BaseTreeModifier }
+		): Promise<void | null>;
+		removeItem(
+			oParentControl: FilterBar,
+			oFilterFieldProperty: UI5Element | Element,
+			mPropertyBag: { appComponent: AppComponent; modifier: BaseTreeModifier }
+		): Promise<boolean | null>;
+		removeCondition(
+			oParentControl: FilterBar,
+			sPropertyInfoName: string,
+			mPropertyBag: {
+				appComponent: AppComponent;
+				modifier: BaseTreeModifier;
+			}
+		): Promise<void | null>;
+	};
 ODataFilterBarDelegate.apiVersion = 2;
 const EDIT_STATE_PROPERTY_NAME = "$editState",
 	SEARCH_PROPERTY_NAME = "$search",
@@ -417,8 +422,9 @@ async function _addPropertyInfo(
 
 		const delegate = await mPropertyBag.modifier.getProperty<FilterBarDelegate>(oParentControl, "delegate");
 		const aPropertyInfo = await mPropertyBag.modifier.getProperty<FEPropertyInfo[]>(oParentControl, "propertyInfo");
+		const propertyInfoExists = await FilterUtils._checkIfPropertyInfoExists(oParentControl, mPropertyBag.modifier, sPropertyInfoName);
 		//We do not get propertyInfo in case of table filters
-		if (aPropertyInfo) {
+		if (aPropertyInfo && !propertyInfoExists) {
 			const hasPropertyInfo = aPropertyInfo.some(function (prop: FEPropertyInfo) {
 				return prop.key === sPropertyInfoKey || prop.name === sPropertyInfoKey;
 			});
@@ -476,12 +482,13 @@ async function _updatePropertyInfo(
 	propertyBag.modifier.setProperty(parentControl, "propertyInfo", _propertyInfo);
 }
 /**
- * Method responsible for creating filter field in standalone mode / in the personalization settings of the filter bar.
+ * Method responsible for creating the filter field in standalone mode and in the personalization settings of the filter bar.
  * @param oParentControl Parent control instance to which the filter field is added
  * @param sPropertyInfoName Name of the property being added as the filter field
  * @param mPropertyBag Instance of the property bag from Flex API
  * @param mPropertyBag.appComponent AppComponent
  * @param mPropertyBag.modifier Modifier from Flex API
+ * @param mPropertyBag.view Instance of the view
  * @returns Once resolved, a filter field definition is returned
  */
 ODataFilterBarDelegate.addItem = async function (
@@ -500,7 +507,8 @@ ODataFilterBarDelegate.addItem = async function (
 		return Promise.resolve(null);
 	}
 	const isXML = modifier && modifier.targets === "xmlTree";
-	if (isXML) {
+	const propertyInfoExists = isXML ? await FilterUtils._checkIfPropertyInfoExists(oParentControl, modifier, sPropertyInfoName) : true;
+	if (isXML && !propertyInfoExists) {
 		await _addPropertyInfo(oParentControl, mPropertyBag, oMetaModel, sPropertyInfoName);
 	}
 	return ODataFilterBarDelegate._addFlexItem(
@@ -537,6 +545,7 @@ ODataFilterBarDelegate.removeItem = async function (
 			return Promise.resolve(null);
 		}
 		const filterFieldProperty = await mPropertyBag.modifier.getProperty(oFilterFieldProperty, "propertyKey");
+
 		await _addPropertyInfo(oParentControl, mPropertyBag, oMetaModel, filterFieldProperty as string);
 	}
 	if (
@@ -704,8 +713,8 @@ ODataFilterBarDelegate.fetchPropertiesForEntity = function (
 	aFetchedProperties = aFetchedProperties.filter(function (oProp: FEPropertyInfo) {
 		return processedFieldsKeys.includes(oProp.key!);
 	});
-
-	const oFR = CommonUtils.getFilterRestrictionsByPath(sEntitySetPath, oMetaModel),
+	const dataModel = getInvolvedDataModelObjects(oMetaModel.getContext(sEntitySetPath));
+	const oFR = FilterRestrictions.getFilterRestrictionsByDataModel(dataModel as DataModelObjectPath<PageContextPathTarget>),
 		mAllowedExpressions = oFR.FilterAllowedExpressions;
 	//Object.keys(processedFields).forEach(function (sFilterFieldKey: string) {
 	processedFields.forEach(function (oProp, iFilterFieldIndex: number) {
@@ -861,6 +870,14 @@ ODataFilterBarDelegate._addFlexItem = async function (
 	oAppComponent: AppComponent | undefined,
 	view?: View | undefined
 ): Promise<NullableModifierElement> {
+	let propertyInfosFromFilterBar: PropertyInfo[] = [];
+	const bIsXML = !!oModifier && oModifier.targets === "xmlTree";
+	if (bIsXML) {
+		const customDataValue = await DelegateUtil.getCustomDataWithModifier<string>(oParentControl, "feFilterInfo", oModifier);
+		if (customDataValue) {
+			propertyInfosFromFilterBar = JSON.parse(customDataValue) as PropertyInfo[]; // retrieve pre-fetched filter info from custom data, required during templating
+		}
+	}
 	const sFilterBarId = oModifier ? oModifier.getId(oParentControl) : oParentControl.getId(),
 		sIdPrefix = oModifier ? "" : "Adaptation",
 		aSelectionFields = FilterUtils.getConvertedFilterFields(
@@ -870,11 +887,12 @@ ODataFilterBarDelegate._addFlexItem = async function (
 			oMetaModel,
 			oAppComponent,
 			oModifier,
-			oModifier ? undefined : getLineItemQualifierFromTable(oParentControl.getParent()!, oMetaModel)
+			oModifier ? undefined : getLineItemQualifierFromTable(oParentControl.getParent()!, oMetaModel),
+			propertyInfosFromFilterBar
 		),
 		oSelectionField = ODataFilterBarDelegate._findSelectionField(aSelectionFields, sFlexPropertyName),
-		sPropertyPath = _getPropertyPath(sFlexPropertyName),
-		bIsXML = !!oModifier && oModifier.targets === "xmlTree";
+		sPropertyPath = _getPropertyPath(sFlexPropertyName);
+
 	if (sFlexPropertyName === EDIT_STATE_PROPERTY_NAME) {
 		return _templateEditState(_generateIdPrefix(sFilterBarId, `${sIdPrefix}FilterField`), oMetaModel, oModifier);
 	} else if (sFlexPropertyName === SEARCH_PROPERTY_NAME) {