refactor(filter): simplify filter definition

Author: ChronicStone

.gitignore

@@ -9,3 +9,4 @@ lib-cov
 logs
 node_modules
 temp
+playground/.nuxt

README.md

@@ -70,10 +70,8 @@ The main function to query your array data.
 - `key: string`: The property to filter on
 - `value: any`: The value to compare against
 - `matchMode: FilterMatchMode`: The type of comparison to make
-- `required?: boolean`: Whether this filter must match
-- `postCondition?: boolean`: Apply this filter after other operations
-- `arrayLookup?: Operator`: How to combine multiple matches in arrays
-- `lookupAtRoot?: boolean`: Whether to apply the filter at the root level
+- `operator?: Operator` (`'AND' | 'OR' | (() => 'AND' | 'OR')`): How to combine multiple matches in arrays
+- `params?: MatcherParams`: Additional parameters for the match mode
 
 ### FilterMatchMode
 

src/query.ts

@@ -35,12 +35,12 @@ export function query<T extends GenericObject, P extends QueryParams>(
     result = result.filter((item) => {
       return (params.filter ?? []).every((filter) => {
         const value = getObjectProperty(item, filter.key)
-        const arrayLookup = typeof filter.arrayLookup === 'function' ? filter.arrayLookup() : filter.arrayLookup ?? 'OR'
+        const operator = typeof filter.operator === 'function' ? filter.operator() : filter.operator ?? 'OR'
         if (filter.matchMode === 'equals') {
           return processFilterWithLookup({
             type: 'equals',
             params: null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -50,7 +50,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'contains',
             params: null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -59,7 +59,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'between',
             params: filter?.params ?? null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -69,7 +69,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'greaterThan',
             params: filter?.params ?? null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -79,7 +79,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'greaterThanOrEqual',
             params: filter?.params ?? null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -89,7 +89,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'lessThan',
             params: filter?.params ?? null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -99,7 +99,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'lessThanOrEqual',
             params: filter?.params ?? null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -109,17 +109,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'exists',
             params: null,
-            arrayLookup,
-            value,
-            filter: filter.value,
-          })
-        }
-
-        if (filter.matchMode === 'objectStringMap') {
-          return processFilterWithLookup({
-            type: 'objectStringMap',
-            params: filter.params,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -129,7 +119,7 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'arrayLength',
             params: null,
-            arrayLookup,
+            operator,
             value,
             filter: filter.value,
           })
@@ -141,8 +131,8 @@ export function query<T extends GenericObject, P extends QueryParams>(
           return processFilterWithLookup({
             type: 'objectMatch',
             params,
-            arrayLookup,
-            value: filter.lookupAtRoot ? item : value,
+            operator,
+            value: params?.applyAtRoot ? item : value,
             filter: filterValue,
           })
         }
@@ -201,7 +191,7 @@ function processFilterWithLookup<
   P = Parameters<MatchModeProcessorMap[T]>[0],
 >(params: {
   type: FilterMatchMode
-  arrayLookup: 'AND' | 'OR'
+  operator: 'AND' | 'OR'
   value: any
   filter: any
   params: P extends { params: infer U } ? U : P extends { params?: infer U } ? U : null
@@ -219,7 +209,7 @@ function processFilterWithLookup<
       : MatchModeProcessor[params.type]({ params: params.params as any, value: params.value, filter: params.filter })
   }
 
-  else if (params.arrayLookup === 'AND') {
+  else if (params.operator === 'AND') {
     return Array.isArray(params.filter) && params.filter.every((filter, index) => {
       if (Array.isArray(params.value)) {
         return params.value.some(value =>
@@ -237,7 +227,7 @@ function processFilterWithLookup<
     })
   }
 
-  else if (params.arrayLookup === 'OR') {
+  else if (params.operator === 'OR') {
     return Array.isArray(params.filter) && params.filter.some((filter, index) =>
       Array.isArray(params.value)
         ? params.value.some(value =>

src/types.ts

@@ -13,11 +13,10 @@ export type FilterMatchMode =
   | 'lessThan'
   | 'lessThanOrEqual'
   | 'exists'
-  | 'objectStringMap'
   | 'arrayLength'
   | 'objectMatch'
 
-export type NonObjectMatchMode = Exclude<FilterMatchMode, 'objectStringMap' | 'objectMatch'>
+export type NonObjectMatchMode = Exclude<FilterMatchMode, 'objectMatch'>
 export type ComparatorMatchMode = Extract<FilterMatchMode, 'between' | 'greaterThan' | 'greaterThanOrEqual' | 'lessThan' | 'lessThanOrEqual'>
 
 export interface ComparatorParams {
@@ -28,33 +27,18 @@ export interface ObjectMapFilterParams {
   operator: 'AND' | 'OR'
   properties: Array<{
     key: string
-    matchMode: Exclude<FilterMatchMode, 'objectStringMap' | 'objectMap'>
+    matchMode: Exclude<FilterMatchMode, 'objectMap'>
   }>
   transformFilterValue?: (value: any) => any
   matchPropertyAtIndex?: boolean
-}
-
-export interface ObjectStringMapFilterParams {
-  stringMap: Array<
-    | string
-    | {
-      propertyName: string
-      matchMode: Exclude<FilterMatchMode, 'objectStringMap'>
-    }
-  >
-  stringMapSeparator?: string
-  stringMapOperator?: 'AND' | 'OR'
-  dateMode?: boolean
+  applyAtRoot?: boolean
 }
 
 export type MatchModeCore = ({
   matchMode: Exclude<FilterMatchMode, 'objectStringMap' | 'objectMatch' | ComparatorMatchMode>
 } | {
   matchMode: ComparatorMatchMode
   params?: ComparatorParams
-} | {
-  matchMode: 'objectStringMap'
-  params: ObjectStringMapFilterParams
 } | {
   matchMode: 'objectMatch'
   params: ObjectMapFilterParams | ((value: any) => ObjectMapFilterParams)
@@ -63,10 +47,7 @@ export type MatchModeCore = ({
 export type QueryFilter = {
   key: string
   value: any
-  required?: boolean | undefined
-  postCondition?: boolean
-  arrayLookup?: Operator
-  lookupAtRoot?: boolean
+  operator?: Operator
 } & MatchModeCore
 
 export interface QueryParams {
@@ -91,7 +72,6 @@ export interface MatchModeProcessorMap {
   lessThan: ({ value, filter }: { value: any, filter: any, params?: ComparatorParams }) => boolean
   lessThanOrEqual: ({ value, filter }: { value: any, filter: any, params?: ComparatorParams }) => boolean
   between: ({ value, filter }: { value: any, filter: any, params?: ComparatorParams }) => boolean
-  objectStringMap: (p: { value: any, filter: any }) => boolean
   arrayLength: ({ value, filter }: { value: any, filter: any }) => boolean
   objectMatch: ({ value, filter, params }: { value: any, filter: any, params: ObjectMapFilterParams, index?: number }) => boolean
 }

src/utils.ts

@@ -38,7 +38,6 @@ export const MatchModeProcessor: MatchModeProcessorMap = {
   between: ({ value, filter, params }) => {
     return params?.dateMode ? new Date(value) >= new Date(filter[0]) && new Date(value) <= new Date(filter[1]) : value >= filter[0] && value <= filter[1]
   },
-  objectStringMap: p => !!p,
   arrayLength: ({ value, filter }) => Array.isArray(value) && value.length === filter,
   objectMatch: ({ value, filter, params, index }) => {
     const properties = typeof index !== 'undefined' && params.matchPropertyAtIndex ? [params.properties[index]] : params.properties