@sapui5/sap.suite.ui.generic.template 1.150.1 → 1.152.0

package/src/sap/suite/ui/generic/template/lib/ai/EasyFilterBarHandler.js

@@ -107,12 +107,36 @@ sap.ui.define([
             // Helper to add properties to mFilterProperties, with optional prefix.
             // bOverrideSortable and mOverrideNonSortable allow callers (e.g. nav property processing)
             // to pass entity-set-specific sort restrictions instead of the root entity set's.
-            function addPropertiesFromEntityType(entityType, prefix, bOverrideSortable, mOverrideNonSortable) {
+            // oEffectiveEntitySetMeta allows callers to pass the entity-set metadata for
+            // Capabilities.FilterRestrictions lookup; falls back to the root entity set's metadata.
+            function addPropertiesFromEntityType(entityType, prefix, bOverrideSortable, mOverrideNonSortable, oEffectiveEntitySetMeta) {
                 var bEffectiveSortable = (bOverrideSortable !== undefined) ? bOverrideSortable : bEntitySetSortable;
                 var mEffectiveNonSortable = mOverrideNonSortable || mNonSortableProperties;
+
+                // Capabilities.FilterRestrictions takes priority over sap:filterable (matches SFB behaviour).
+                var oCapFilterRestrictions = oEffectiveEntitySetMeta &&
+                    oEffectiveEntitySetMeta["Org.OData.Capabilities.V1.FilterRestrictions"];
+                var bEntityNonFilterable = !!oCapFilterRestrictions &&
+                    oCapFilterRestrictions.Filterable === "false";
+                var mCapNonFilterable = {};
+                if (oCapFilterRestrictions && oCapFilterRestrictions.NonFilterableProperties) {
+                    oCapFilterRestrictions.NonFilterableProperties.forEach(function(oEntry) {
+                        if (oEntry.PropertyPath) {
+                            mCapNonFilterable[oEntry.PropertyPath] = true;
+                        }
+                    });
+                }
+
                 entityType.property.forEach(function (oProperty) {
                     var sTokenType = "ValueHelp";
                     var bFilterable = filterHelper.isPropertyFilterable(oProperty);
+
+                    // When Capabilities.FilterRestrictions is present, its answer is authoritative.
+                    // A property absent from NonFilterableProperties is filterable even if sap:filterable="false".
+                    if (oCapFilterRestrictions) {
+                        bFilterable = !bEntityNonFilterable && !mCapNonFilterable[oProperty.name];
+                    }
+
                     var bIsCodeListRequired;
                     var bIsHidden = false;
                     var bIsHiddenFilter = false;
@@ -132,6 +156,10 @@ sap.ui.define([
                             sFilterRestriction = oExtension.value;
                         }
                     });
+                    // sap:hidden-filter extension may be absent when only the vocabulary annotation is set
+                    if (!bIsHiddenFilter && oProperty["com.sap.vocabularies.UI.v1.HiddenFilter"]) {
+                        bIsHiddenFilter = oProperty["com.sap.vocabularies.UI.v1.HiddenFilter"].Bool === "true";
+                    }
                     if ((oProperty.type === "Edm.DateTime" && oProperty["sap:display-format"] === "Date") ||
                         (oProperty.type === "Edm.String" && oProperty["com.sap.vocabularies.Common.v1.IsCalendarDate"] && oProperty["com.sap.vocabularies.Common.v1.IsCalendarDate"].Bool === "true")) {
                         sTokenType = "Calendar";
@@ -163,7 +191,7 @@ sap.ui.define([
             }
 
             // Add direct properties
-            addPropertiesFromEntityType(oEntityType, "");
+            addPropertiesFromEntityType(oEntityType, "", undefined, undefined, oEntitySetMeta);
 
             // Add 1:1 navigation properties' properties
             if (oEntityType.navigationProperty) {
@@ -210,7 +238,7 @@ sap.ui.define([
                                         }
                                     }
                                 }
-                                addPropertiesFromEntityType(oTargetEntityType, navProp.name, bNavSortable, mNavNonSortable);
+                                addPropertiesFromEntityType(oTargetEntityType, navProp.name, bNavSortable, mNavNonSortable, oNavEntitySetMeta);
                             }
                         }
                     }
@@ -577,6 +605,17 @@ sap.ui.define([
                     setState: fnApplyEasyFilterVariantState
                 });
 
+                // Sync sLoadedVariantFilterMode on afterSave (Save As path)
+                // so layout switches after saving correctly show the dirty indicator.
+                var oSVM = oState.oSmartFilterbar.getSmartVariant();
+                if (oSVM && oSVM.attachAfterSave) {
+                    oSVM.attachAfterSave(function() {
+                        var oTMModel = oTemplateUtils.oComponentUtils.getTemplatePrivateModel();
+                        var sCurrentFilterMode = oTMModel.getProperty("/listReport/filterMode");
+                        sLoadedVariantFilterMode = sCurrentFilterMode;
+                    });
+                }
+
                 // Handle INIT timing gap: the "INIT" afterVariantLoad fires before this handler
                 // is created. Read whatever the variant already loaded into customFilterData now.
                 var oCustomData = oState.oSmartFilterbar.getCustomFilterData();
@@ -694,10 +733,119 @@ sap.ui.define([
 			oSmartFilterBarWrapper.setState(oSmartFilterBarVariant);
 			// currentVariantSetModified intentionally omitted — pressing Go with the same
 			// query must not mark the variant as dirty.
-			// oSmartFilterbar.getSmartVariant() && oSmartFilterbar.getSmartVariant().currentVariantSetModified(true);
+
+			var aSelectOptionsNeedingInjection = fnGetCustomFieldsNeedingInjection(oSmartFilterbar, oVariantDataFromAI.aSelectOptions);
+			fnInjectCustomFiltersOnRebind(aSelectOptionsNeedingInjection);
+			fnSyncCustomFieldInputValues(aSelectOptionsNeedingInjection, oSmartFilterbar);
+
+			// Apply sorters/groupLevels bundled with tokens after SFB state is set but
+			// before triggering search, to prevent a premature rebind with incomplete filters.
+			var aBundledSorters = oEvent.getParameter("sorters");
+			var aBundledGroupLevels = oEvent.getParameter("groupLevels");
+			if (aBundledSorters !== undefined) {
+				fnApplySortersToTable(aBundledSorters);
+			}
+			if (aBundledGroupLevels !== undefined) {
+				fnApplyGroupLevelsToTable(aBundledGroupLevels);
+			}
+
 			oSmartFilterbar.search();
 		}
 
+        /**
+         * Returns the subset of aSelectOptions whose property names landed in SFB's _CUSTOM
+         * bucket after setState — meaning SFB could not route them through its standard filter
+         * pipeline (plain Input fields with no value-list annotation).
+         * @param {object} oSmartFilterbar - The SmartFilterBar control instance
+         * @param {Array} aSelectOptions - Select options built from AI tokens
+         * @returns {Array} Select options that require direct filter injection
+         */
+        function fnGetCustomFieldsNeedingInjection(oSmartFilterbar, aSelectOptions) {
+            var oFilterData = oSmartFilterbar.getFilterData();
+            var oCustomData = oFilterData && oFilterData._CUSTOM;
+            return aSelectOptions.filter(function(oSelectOption) {
+                return oCustomData && oCustomData.hasOwnProperty(oSelectOption.PropertyName);
+            });
+        }
+
+        /**
+         * Builds UI5 Filter objects for each _CUSTOM select option and registers a one-shot
+         * beforeRebindTable handler on the SmartTable that injects them into bindingParams.filters
+         * just before the OData request is built — bypassing SFB's filter pipeline entirely.
+         * EQ is remapped to Contains to match Classic SFB substringof behaviour on plain Input fields.
+         * @param {Array} aSelectOptionsNeedingInjection - Select options that require direct filter injection
+         * @returns {void}
+         */
+        function fnInjectCustomFiltersOnRebind(aSelectOptionsNeedingInjection) {
+            if (aSelectOptionsNeedingInjection.length === 0 || !oState.oPresentationControlHandler) {
+                return;
+            }
+            var oSmartTable = oState.oPresentationControlHandler.getControl();
+            if (!oSmartTable || typeof oSmartTable.attachBeforeRebindTable !== 'function') {
+                return;
+            }
+            var aInjectFilters = [];
+            aSelectOptionsNeedingInjection.forEach(function(oSelectOption) {
+                oSelectOption.Ranges.forEach(function(oRange) {
+                    var sOp = oRange.Option;
+                    var sVal = oRange.Low;
+                    if (sOp === 'CP') {
+                        aInjectFilters.push(new Filter(oSelectOption.PropertyName, FilterOperator.Contains, sVal.replace(/^\*|\*$/g, '')));
+                    } else if (sOp === 'EQ') {
+                        aInjectFilters.push(new Filter(oSelectOption.PropertyName, FilterOperator.Contains, sVal));
+                    } else if (sOp === 'BT') {
+                        aInjectFilters.push(new Filter(oSelectOption.PropertyName, FilterOperator.BT, oRange.Low, oRange.High));
+                    } else if (sOp === 'NB') {
+                        aInjectFilters.push(new Filter({path: oSelectOption.PropertyName, operator: FilterOperator.BT, value1: oRange.Low, value2: oRange.High, bExclude: true}));
+                    } else {
+                        var sMappedOp = FilterOperator[sOp];
+                        if (!sMappedOp) {
+                            oLogger.warning("EasyFilterBarHandler: unsupported select-option operator '" + sOp + "' for property '" + oSelectOption.PropertyName + "' — skipping filter injection");
+                            return;
+                        }
+                        aInjectFilters.push(new Filter(oSelectOption.PropertyName, sMappedOp, sVal));
+                    }
+                });
+            });
+            var fnOnBeforeRebind = function(oRebindEvent) {
+                oSmartTable.detachBeforeRebindTable(fnOnBeforeRebind);
+                var oBindingParams = oRebindEvent.getParameter('bindingParams');
+                oBindingParams.filters = oBindingParams.filters || [];
+                var aBindingFilters = oBindingParams.filters;
+                // Remove prior easy-filter entries for the same properties to avoid stacking.
+                aInjectFilters.forEach(function(oF) {
+                    for (var i = aBindingFilters.length - 1; i >= 0; i--) {
+                        if (aBindingFilters[i] && aBindingFilters[i].sPath === oF.sPath) {
+                            aBindingFilters.splice(i, 1);
+                        }
+                    }
+                    aBindingFilters.push(oF);
+                });
+            };
+            oSmartTable.attachBeforeRebindTable(fnOnBeforeRebind);
+        }
+
+        /**
+         * Sets the visible value on the SFB Input control for each _CUSTOM field so the Classic
+         * filter tab shows the correct value when the user switches filter modes.
+         * Uses setValue only — no fireChange — to avoid triggering SFB's async filter rebuild.
+         * @param {Array} aSelectOptionsNeedingInjection - Select options that require direct filter injection
+         * @param {object} oSmartFilterbar - The SmartFilterBar control instance
+         * @returns {void}
+         */
+        function fnSyncCustomFieldInputValues(aSelectOptionsNeedingInjection, oSmartFilterbar) {
+            aSelectOptionsNeedingInjection.forEach(function(oSelectOption) {
+                if (oSelectOption.Ranges.length > 0) {
+                    var aItems = oSmartFilterbar.getAllFilterItems(true) || [];
+                    var oItem = aItems.find(function(i) { return i.getName && i.getName() === oSelectOption.PropertyName; });
+                    var oCtrl = oItem && oItem.getControl && oItem.getControl();
+                    if (oCtrl && oCtrl.setValue) {
+                        oCtrl.setValue(oSelectOption.Ranges[0].Low);
+                    }
+                }
+            });
+        }
+
         /**
          * Event handler for the EasyFilterBarContainer's tokensChangedByUser event.
          * Fired when the user manually deletes or modifies a token (distinct from AI-resolved tokens).
@@ -708,42 +856,30 @@ sap.ui.define([
             fnSetCreationAllowed(false);
         }
 
-        /**
-		/**
-		 * Event handler for the EasyFilter control's sortersChanged event.
-		 * Applies the AI-determined sort order to the SmartTable via setUiState,
-		 * which updates the data binding, column sort indicators, and P13n state
-		 * through the PersonalizationController.
-		 * @param {sap.ui.base.Event} oEvent The sortersChanged event containing sort definitions
-		 */
-		function fnSortersChanged(oEvent) {
+        function fnApplySortersToTable(aSorters) {
             try {
-                var aSorters = oEvent.getParameter("sorters");
-    
                 var oPresentationControlHandler = oState.oPresentationControlHandler;
                 if (!oPresentationControlHandler) {
-                    oLogger.error("EasyFilterBarHandler.onSortersChanged: PresentationControlHandler not found.");
+                    oLogger.error("EasyFilterBarHandler: PresentationControlHandler not found.");
                     return;
                 }
-    
+
                 var oControl = oPresentationControlHandler.getControl();
                 if (!oControl) {
-                    oLogger.error("EasyFilterBarHandler.onSortersChanged: Presentation control not found.");
+                    oLogger.error("EasyFilterBarHandler: Presentation control not found.");
                     return;
                 }
 
                 if (!controlHelper.isSmartTable(oControl)) {
-                    oLogger.warning("EasyFilterBarHandler.onSortersChanged: Sorting is only supported for SmartTable.");
+                    oLogger.warning("EasyFilterBarHandler: Sorting is only supported for SmartTable.");
                     return;
                 }
-    
+
                 var oUiState = oControl.getUiState();
                 var oPresentationVariant = oUiState.getPresentationVariant();
-    
-                oPresentationVariant.SortOrder = undefined; // Clear existing sort order before applying new one
 
-                // Set new sort order (empty array clears sorting)
-                const aSortersMapped = (aSorters && aSorters.length ) ? aSorters.map(function (oSorter) {
+                oPresentationVariant.SortOrder = undefined;
+                var aSortersMapped = (aSorters && aSorters.length) ? aSorters.map(function(oSorter) {
                     return {
                         Property: oSorter.key,
                         Descending: !!oSorter.descending
@@ -757,51 +893,38 @@ sap.ui.define([
                 } finally {
                     bApplyingSorting = false;
                 }
-    
             } catch (error) {
                 bApplyingSorting = false;
                 oLogger.warning("EasyFilterBar: unexpected error while handling sortersChanged", String(error));
             }
-		}
+        }
 
-		/**
-		 * Event handler for the EasyFilter control's groupLevelsChanged event.
-		 * Applies the AI-determined group levels to the SmartTable via setUiState,
-		 * which updates the data binding and table grouping state
-		 * through the PersonalizationController.
-		 * @param {sap.ui.base.Event} oEvent The groupLevelsChanged event containing group level definitions
-		 */
-		function fnGroupLevelsChanged(oEvent) {
+        function fnApplyGroupLevelsToTable(aGroupLevels) {
             try {
-                var aGroupLevels = oEvent.getParameter("groupLevels");
-    
                 var oPresentationControlHandler = oState.oPresentationControlHandler;
                 if (!oPresentationControlHandler) {
-                    oLogger.error("EasyFilterBarHandler.onGroupLevelsChanged: PresentationControlHandler not found.");
+                    oLogger.error("EasyFilterBarHandler: PresentationControlHandler not found.");
                     return;
                 }
-    
+
                 var oControl = oPresentationControlHandler.getControl();
                 if (!oControl) {
-                    oLogger.error("EasyFilterBarHandler.onGroupLevelsChanged: Presentation control not found.");
+                    oLogger.error("EasyFilterBarHandler: Presentation control not found.");
                     return;
                 }
 
                 if (!controlHelper.isSmartTable(oControl)) {
-                    oLogger.warning("EasyFilterBarHandler.onGroupLevelsChanged: Grouping is only supported for SmartTable.");
+                    oLogger.warning("EasyFilterBarHandler: Grouping is only supported for SmartTable.");
                     return;
                 }
-    
+
                 var oUiState = oControl.getUiState();
                 var oPresentationVariant = oUiState.getPresentationVariant();
-    
-                oPresentationVariant.GroupBy = undefined; // Clear existing group levels before applying new ones
-
-                // SmartTable supports grouping by only one column at a time,
-                // so we take only the first group level even if multiple are provided.
-                oPresentationVariant.GroupBy = (aGroupLevels && aGroupLevels.length) ? 
-                aGroupLevels?.flatMap(aGroup => Object.values(aGroup)) : undefined;
-    
+
+                oPresentationVariant.GroupBy = undefined;
+                oPresentationVariant.GroupBy = (aGroupLevels && aGroupLevels.length) ?
+                    aGroupLevels.flatMap(function(aGroup) { return Object.values(aGroup); }) : undefined;
+
                 bApplyingGrouplevels = true;
                 try {
                     oControl.setUiState(oUiState);
@@ -812,13 +935,13 @@ sap.ui.define([
                 bApplyingGrouplevels = false;
                 oLogger.warning("EasyFilterBar: unexpected error while handling groupLevelsChanged", String(error));
             }
-		}
+        }
 
 		/**
 		 * Event handler for the EasyFilter control's showValueHelp event.
 		 * Identifies the input field for which the value help is requested and triggers the value help opening from SFB.
-		 * @param {*} oEvent
-		 * @param {*} oState
+		 * @param {sap.ui.base.Event} oEvent - The showValueHelp event fired by the EasyFilter control
+		 * @param {object} oState - The current controller state object
 		 */
 		function fnShowValueHelp(oEvent) {
 			var oSmartFilterbar = oState.oSmartFilterbar;
@@ -1030,8 +1153,6 @@ sap.ui.define([
             onQueryChanged : fnQueryChanged,
 			onTokensChanged: fnTokensChanged,
             onTokensChangedByUser: fnTokensChangedByUser,
-			onSortersChanged: fnSortersChanged,
-			onGroupLevelsChanged: fnGroupLevelsChanged,
 			onShowValueHelp: fnShowValueHelp,
             onFilterChange : fnOnFilterChange,
             handleVariantLoad : fnHandleVariantLoad,

package/src/sap/suite/ui/generic/template/lib/ai/EasyFilterDataFetcherHelper.js

@@ -287,7 +287,7 @@ sap.ui.define([
                 if (!isValueHelpTableAvailable) {
                     // When there is no valueList associate, just return the original value in CodeList type
                     aFilters.forEach(oFilter => aFinalResponse.push(getkeySpecifiedResultFromFilters(oFilter)));
-                    resolve(aFinalResponse);
+                    return resolve(aFinalResponse);
                 }
 
                 // Get value help lists from metadata