feat(utils): add getFilteredCollection()

src/index.ts

@@ -140,6 +140,7 @@ export { TableWithSelectableRows } from './tables/TableWithSelectableRows'
 export { cleanString } from './utils/cleanString'
 export { customDayjs } from './utils/customDayjs'
 export { getCoordinates, coordinatesAreDistinct } from './utils/coordinates'
+export { getFilteredCollection } from './utils/getFilteredCollection'
 export { getHashFromCollection } from './utils/getHashFromCollection'
 export { getLocalizedDayjs } from './utils/getLocalizedDayjs'
 export { getMaybeBooleanFromRichBoolean } from './utils/getMaybeBooleanFromRichBoolean'

src/utils/__tests__/getFilteredCollection.test.ts

@@ -0,0 +1,61 @@
+import { describe, expect, it } from '@jest/globals'
+
+import { getFilteredCollection } from '../getFilteredCollection'
+
+import type { Filter } from '../../types/definitions'
+
+describe('utils/getFilteredCollection()', () => {
+  it('should return the collection with 0 filter', () => {
+    type Item = { id: number; name: string }
+
+    const collection: Item[] = [{ id: 1, name: 'Item A' }]
+    const filters: Array<Filter<Item>> = []
+
+    const result = getFilteredCollection(collection, filters)
+
+    expect(result).toEqual(collection)
+  })
+
+  it('should filter the collection with 1 filter', () => {
+    type Item = { id: number; name: string }
+
+    const collection: Item[] = [
+      { id: 1, name: 'Item A' },
+      { id: 2, name: 'Item B' }
+    ]
+    const filters: Array<Filter<Item>> = [items => items.filter(item => item.id === 1)]
+
+    const result = getFilteredCollection(collection, filters)
+
+    expect(result).toEqual([{ id: 1, name: 'Item A' }])
+  })
+
+  it('should filter the collection with 2 filters', () => {
+    type Item = { id: number; isActive: boolean; name: string }
+
+    const collection: Item[] = [
+      { id: 1, isActive: true, name: 'Item A' },
+      { id: 2, isActive: false, name: 'Item B' },
+      { id: 3, isActive: true, name: 'Item C' }
+    ]
+    const filters: Array<Filter<Item>> = [
+      items => items.filter(item => item.isActive),
+      items => items.filter(item => item.id > 1)
+    ]
+
+    const result = getFilteredCollection(collection, filters)
+
+    expect(result).toEqual([{ id: 3, isActive: true, name: 'Item C' }])
+  })
+
+  it('should return `undefined` with an undefined collection', () => {
+    type Item = { id: number; name: string }
+
+    const collection = undefined
+    const filters: Array<Filter<Item>> = [items => items.filter(item => item.id === 1)]
+
+    const result = getFilteredCollection(collection, filters)
+
+    expect(result).toBeUndefined()
+  })
+})

src/utils/getFilteredCollection.ts

@@ -0,0 +1,11 @@
+import type { Filter } from '../types/definitions'
+
+export function getFilteredCollection<T>(collection: undefined, filters: Array<Filter<T>>): undefined
+export function getFilteredCollection<T>(collection: T[], filters: Array<Filter<T>>): T[]
+export function getFilteredCollection<T>(collection: T[] | undefined, filters: Array<Filter<T>>): T[] | undefined {
+  if (collection === undefined) {
+    return undefined
+  }
+
+  return filters.reduce((acc, filter) => filter(acc), collection)
+}