feat: allow attaching meta to filter rule

lawvs · Aug 10, 2024 · 744b13e · 744b13e
1 parent 0ce4129
commit 744b13e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/.changeset/seven-years-exercise.md b/.changeset/seven-years-exercise.md
@@ -0,0 +1,5 @@
+---
+"@fn-sphere/core": patch
+---
+
+Allow attaching meta to filter rule
diff --git a/packages/core/src/filter/types.ts b/packages/core/src/filter/types.ts
@@ -36,6 +36,7 @@ export interface SingleFilterInput {
    */
   args?: unknown[];
   invert?: boolean;
+  meta?: Record<string, unknown>;
 }
 
 export interface SingleFilter extends SingleFilterInput {
@@ -54,6 +55,7 @@ export interface FilterGroupInput {
   op: "and" | "or";
   conditions?: FilterRule[];
   invert?: boolean;
+  meta?: Record<string, unknown>;
 }
 
 export interface FilterGroup extends FilterGroupInput {
@@ -68,9 +70,10 @@ export interface FilterGroup extends FilterGroupInput {
 export type FilterRule = SingleFilter | FilterGroup;
 
 export type StrictSingleFilter = Readonly<
-  Required<SingleFilter> & {
+  Required<Omit<SingleFilter, "meta">> & {
     name: string;
     path: FilterPath;
+    meta?: Record<string, unknown>;
   }
 >;
 export type StrictFilterGroup = Readonly<{
@@ -82,6 +85,7 @@ export type StrictFilterGroup = Readonly<{
   op: "and" | "or";
   conditions: StrictFilterRule[];
   invert: boolean;
+  meta?: Record<string, unknown>;
 }>;
 
 export type StrictFilterRule = StrictSingleFilter | StrictFilterGroup;