Merge pull request #6 from feathersjs/feat/new-util-add-to-query

feat(utils): new util addToQuery

Author: fratzinger

src/utils/add-to-query/add-to-query.util.md

@@ -0,0 +1,4 @@
+---
+title: addToQuery
+category: utils
+---

src/utils/add-to-query/add-to-query.util.test.ts

@@ -0,0 +1,39 @@
+import { addToQuery } from './add-to-query.util.js'
+
+describe('addToQuery', () => {
+  it('basic usage', () => {
+    const result = addToQuery({}, 'id', 1)
+
+    expect(result).toEqual({ id: 1 })
+  })
+
+  it('adds if property not in original query', () => {
+    const result = addToQuery({ name: 'John' }, 'id', 1)
+
+    expect(result).toEqual({ name: 'John', id: 1 })
+  })
+
+  it('does not add if exact same property-value pair exists', () => {
+    const result = addToQuery({ id: 1 }, 'id', 1)
+
+    expect(result).toEqual({ id: 1 })
+  })
+
+  it('adds to $and if property exists with different value', () => {
+    const result = addToQuery({ id: 1 }, 'id', 2)
+
+    expect(result).toEqual({ id: 1, $and: [{ id: 2 }] })
+  })
+
+  it('does not add to $and if exact same property-value pair exists in $and', () => {
+    const result = addToQuery({ id: 1, $and: [{ id: 2 }] }, 'id', 2)
+
+    expect(result).toEqual({ id: 1, $and: [{ id: 2 }] })
+  })
+
+  it('adds to $and if property exists with different value and $and already exists', () => {
+    const result = addToQuery({ id: 1, $and: [{ id: 2 }] }, 'id', 3)
+
+    expect(result).toEqual({ id: 1, $and: [{ id: 2 }, { id: 3 }] })
+  })
+})

src/utils/add-to-query/add-to-query.util.ts

@@ -0,0 +1,45 @@
+import type { Query } from '@feathersjs/feathers'
+import { deepEqual } from 'fast-equals'
+
+/**
+ * Safely adds a property to a query object. If the property already exists, it adds it to the `$and` array.
+ * If the exact same property-value pair already exists, it does nothing.
+ */
+export const addToQuery = <Q extends Query>(
+  targetQuery: Q,
+  property: string,
+  value: any,
+) => {
+  if (!(property in targetQuery)) {
+    return {
+      ...targetQuery,
+      [property]: value,
+    }
+  }
+
+  if (deepEqual(targetQuery[property], value)) {
+    // if the exact same value already exists, do nothing
+    return targetQuery
+  }
+
+  if (!targetQuery.$and) {
+    return {
+      ...targetQuery,
+      $and: [{ [property]: value }],
+    }
+  }
+
+  // check if the exact same value already exists in $and
+  if (
+    targetQuery.$and.some(
+      (q: any) => property in q && deepEqual(q[property], value),
+    )
+  ) {
+    return targetQuery
+  }
+
+  return {
+    ...targetQuery,
+    $and: [...targetQuery.$and, { [property]: value }],
+  }
+}

src/utils/index.ts

@@ -1,3 +1,4 @@
+export * from './add-to-query/add-to-query.util.js'
 export * from './add-skip/add-skip.util.js'
 export * from './check-context/check-context.util.js'
 export * from './context-to-json/context-to-json.util.js'

test/index.test.ts

@@ -39,6 +39,7 @@ const hooks = [
 
 const utils = [
   'addSkip',
+  'addToQuery',
   'checkContext',
   'contextToJson',
   'defineHooks',