@sapui5/sap.fe.macros 1.141.0 → 1.142.0

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

@@ -1,7 +1,7 @@
 import type { EntitySet, Property, PropertyPath } from "@sap-ux/vocabularies-types";
 import Log from "sap/base/Log";
 import merge from "sap/base/util/merge";
-import type { PropertiesOf } from "sap/fe/base/ClassSupport";
+import type { EventsOf, PropertiesOf } from "sap/fe/base/ClassSupport";
 import { aggregation, defineUI5Class, event, mixin, property, xmlEventHandler } from "sap/fe/base/ClassSupport";
 import { controllerExtensionHandler } from "sap/fe/base/HookSupport";
 import CommonUtils from "sap/fe/core/CommonUtils";
@@ -26,7 +26,7 @@ import { NavType } from "sap/fe/navigation/library";
 import type { default as ListReportController } from "sap/fe/templates/ListReport/ListReportController.controller";
 import type Input from "sap/m/Input";
 import type { Input$ValueHelpRequestEventParameters } from "sap/m/Input";
-import type { default as Event } from "sap/ui/base/Event";
+import type UI5Event from "sap/ui/base/Event";
 import type { $ControlSettings } from "sap/ui/core/Control";
 import UI5Element from "sap/ui/core/Element";
 import type View from "sap/ui/core/mvc/View";
@@ -38,12 +38,16 @@ import type Control from "sap/ui/mdc/Control";
 import type ValueHelp from "sap/ui/mdc/ValueHelp";
 import type { ConditionObject } from "sap/ui/mdc/condition/Condition";
 import FieldEditMode from "sap/ui/mdc/enums/FieldEditMode";
-import type { FilterBarBase$FiltersChangedEvent, FilterBarBase$SearchEvent } from "sap/ui/mdc/filterbar/FilterBarBase";
+import type {
+	FilterBarBase$FiltersChangedEvent,
+	FilterBarBase$FiltersChangedEventParameters,
+	FilterBarBase$SearchEvent
+} from "sap/ui/mdc/filterbar/FilterBarBase";
 import type { Filter as StateUtilFilter } from "sap/ui/mdc/p13n/StateUtil";
 import StateUtil from "sap/ui/mdc/p13n/StateUtil";
-import type JSONModel from "sap/ui/model/json/JSONModel";
 import type { default as MetaModel, default as ODataMetaModel } from "sap/ui/model/odata/v4/ODataMetaModel";
 import jQuery from "sap/ui/thirdparty/jquery";
+import type { EventHandler } from "../../../../../../../types/extension_types";
 import FilterBarAPIStateHandler from "./mixin/FilterBarAPIStateHandler";
 
 // Track telemetry content for the filterBar
@@ -295,7 +299,7 @@ class FilterBarAPI extends MacroAPI {
 			if (filterVariantApplied || useFLPDefaultValues) {
 				svToSet = await this._getAdjustedSV(sv, useFLPDefaultValues);
 			}
-			return filterBarAPI.setSelectionVariant(svToSet, true);
+			return filterBarAPI.setSelectionVariant(svToSet, true, true);
 		}
 	}
 
@@ -665,10 +669,10 @@ class FilterBarAPI extends MacroAPI {
 	 * @public
 	 */
 	@event()
-	search!: string;
+	search!: EventHandler<UI5Event<{}, FilterBarAPI>>;
 
 	/**
-	 * This event is fired when the 'Go' button is pressed or after a condition change. This is only internally used by sap.fe (Fiori elements) and
+	 * This event is fired when the 'Go' button is pressed or after a condition change. This is only used internally by sap.fe (SAP Fiori elements) and
 	 * exposes parameters from internal MDC-FilterBar search event
 	 * @private
 	 */
@@ -680,18 +684,18 @@ class FilterBarAPI extends MacroAPI {
 	 * @public
 	 */
 	@event()
-	filterChanged!: string;
+	filterChanged!: EventHandler<UI5Event<FilterBarBase$FiltersChangedEventParameters, FilterBarAPI>>;
 
 	/**
 	 * This event is fired when the 'Clear' button is pressed. This is only possible when the 'Clear' button is enabled.
 	 * @public
 	 */
 	@event()
-	afterClear!: string;
+	afterClear!: EventHandler<UI5Event<{}, FilterBarAPI>>;
 
 	/**
 	 * This event is fired after either a filter value or the visibility of a filter item has been changed. The event contains conditions that will be used as filters.
-	 * This is used internally only by sap.fe (Fiori Elements). This exposes parameters from the MDC-FilterBar filterChanged event that is used by sap.fe in some cases.
+	 * This is only used internally by sap.fe (SAP Fiori elements). This exposes parameters from the MDC-FilterBar filterChanged event that is used by sap.fe.
 	 * @private
 	 */
 	@event()
@@ -699,7 +703,7 @@ class FilterBarAPI extends MacroAPI {
 
 	private telemetry?: FilterBarTelemetry;
 
-	constructor(props?: $ControlSettings & PropertiesOf<FilterBarAPI>, others?: $ControlSettings) {
+	constructor(props?: $ControlSettings & PropertiesOf<FilterBarAPI> & EventsOf<FilterBarAPI>, others?: $ControlSettings) {
 		super(props, others);
 		this.telemetry = new FilterBarTelemetry(this);
 		this.attachStateChangeHandler();
@@ -710,7 +714,7 @@ class FilterBarAPI extends MacroAPI {
 		StateUtil.attachStateChange(this.stateChangeHandler);
 	}
 
-	stateChangeHandler(oEvent: Event<{ control: Control }>): void {
+	stateChangeHandler(oEvent: UI5Event<{ control: Control }>): void {
 		const control = oEvent.getParameter("control");
 		if (control.isA<FilterBar>("sap.ui.mdc.FilterBar")) {
 			const filterBarAPI = control.getParent() as unknown as { handleStateChange?: Function };
@@ -722,6 +726,7 @@ class FilterBarAPI extends MacroAPI {
 
 	@xmlEventHandler()
 	handleSearch(oEvent: FilterBarBase$SearchEvent): void {
+		this.getPageController()?.inlineEditFlow?.inlineEditDiscard();
 		const oFilterBar = oEvent.getSource() as FilterBar | undefined;
 		const eventParameters = oEvent.getParameters();
 		if (oFilterBar) {
@@ -971,7 +976,7 @@ class FilterBarAPI extends MacroAPI {
 	 * @public
 	 */
 	setFilterFieldEnabled(name: string, enabled: boolean): void {
-		(this.getModel("internal") as JSONModel).setData(
+		this.getInternalModel()?.setData(
 			{
 				[this.content.data("localId")]: {
 					filterFields: { [name]: { editMode: enabled ? FieldEditMode.Editable : FieldEditMode.Disabled } }
@@ -988,7 +993,7 @@ class FilterBarAPI extends MacroAPI {
 	 * @public
 	 */
 	getFilterFieldEnabled(name: string): boolean {
-		return (this.getModel("internal") as JSONModel).getProperty(`/${this.content.data("localId")}/filterFields/${name}/editMode`) ===
+		return this.getInternalModel()?.getProperty(`/${this.content.data("localId")}/filterFields/${name}/editMode`) ===
 			FieldEditMode.Disabled
 			? false
 			: true;
@@ -1027,10 +1032,15 @@ class FilterBarAPI extends MacroAPI {
 	 * Note: This method cannot set the search field text or any filter field condition that relies on a custom operator.
 	 * @param selectionVariant The {@link sap.fe.navigation.SelectionVariant} to apply to the filter bar
 	 * @param prefillDescriptions Optional. If true, we will use the associated text property values (if they're available in the selectionVariant) to display the filter value descriptions, instead of loading them from the backend
+	 * @param fromNavigationParameters PRIVATE
 	 * @returns A promise for asynchronous handling
 	 * @public
 	 */
-	async setSelectionVariant(selectionVariant: SelectionVariant, prefillDescriptions = false): Promise<unknown> {
+	async setSelectionVariant(
+		selectionVariant: SelectionVariant,
+		prefillDescriptions = false,
+		fromNavigationParameters = false
+	): Promise<unknown> {
 		const content = this.getContent() as FilterBar | undefined;
 		const isLiveMode = content && content?.getLiveMode?.();
 		let result: { diffState: ExternalStateType; applyStateResult: unknown } | undefined;
@@ -1038,7 +1048,12 @@ class FilterBarAPI extends MacroAPI {
 			content.enableRequests(false);
 		}
 		try {
-			result = await stateHelper.setSelectionVariantToMdcControl(this.getContent(), selectionVariant, prefillDescriptions);
+			result = await stateHelper.setSelectionVariantToMdcControl(
+				this.getContent(),
+				selectionVariant,
+				prefillDescriptions,
+				fromNavigationParameters
+			);
 			return result?.applyStateResult;
 		} catch (err: unknown) {
 			const message = err instanceof Error ? err.message : String(err);