Merge pull request #1172 from izaera/LPS-197299

feat(js-api)!: improve FDS filter CX interfaces
liferay · Sep 28, 2023 · 5cdde6f · 5cdde6f
2 parents 2717f15 + f9e7f81
commit 5cdde6f
Showing 1 changed file with 18 additions and 19 deletions.
diff --git a/projects/js-toolkit/packages/js-api/data-set/index.ts b/projects/js-toolkit/packages/js-api/data-set/index.ts
@@ -3,6 +3,8 @@
  * SPDX-License-Identifier: LGPL-3.0-or-later
  */
 
+// Frontend data set cell renderer
+
 export interface FDSTableCellHTMLElementBuilderArgs {
 	value: boolean | number | string | object | [];
 }
@@ -11,34 +13,31 @@ export interface FDSTableCellHTMLElementBuilder {
 	(args: FDSTableCellHTMLElementBuilderArgs): HTMLElement;
 }
 
-export interface FDSCellRendererArgs {
-	value: boolean | number | string | object | [];
-}
+// Frontend data set filter
 
-export interface FDSCellRenderer {
-	(args: FDSCellRendererArgs): HTMLElement;
+export interface FDSFilterData<T> {
+	selectedData: T;
 }
 
-export interface FDSFilterData {
-	id: string;
-	odataFilterString: string;
-	selectedData: string;
+export interface FDSFilterHTMLElementBuilderArgs<T> {
+	filter: FDSFilterData<T>;
+	setFilter: (partialFilter: Partial<FDSFilterData<T>>) => void;
 }
 
-export interface FDSFilterArgs {
-	filter: FDSFilterData;
-	setFilter: (val: Partial<FDSFilterData>) => void;
+export interface FDSFilterHTMLElementBuilder<T> {
+	(args: FDSFilterHTMLElementBuilderArgs<T>): HTMLElement;
 }
 
-export interface FDSFilter {
-	(args: FDSFilterArgs): HTMLElement;
+export interface FDSFilterODataQueryBuilder<T> {
+	(selectedData: T): string;
 }
 
-export interface FDSFilterHTMLElementBuilderArgs {
-	filter: FDSFilterData;
-	setFilter: (val: Partial<FDSFilterData>) => void;
+export interface FDSFilterDescriptionBuilder<T> {
+	(selectedData: T): string;
 }
 
-export interface FDSFilterHTMLElementBuilder {
-	(args: FDSFilterHTMLElementBuilderArgs): HTMLElement;
+export interface FDSFilter<T> {
+	descriptionBuilder: FDSFilterDescriptionBuilder<T>;
+	htmlElementBuilder: FDSFilterHTMLElementBuilder<T>;
+	oDataQueryBuilder: FDSFilterODataQueryBuilder<T>;
 }