feat(query): add secondary closure support for the where clause

Author: kiaking

src/query/Options.ts

@@ -1,14 +1,19 @@
+import { Model } from '../model/Model'
 import { Query } from './Query'
 
-export interface Where {
-  field: string | number
-  value: any
+export type WhereSecondaryClosure<M extends Model, K extends keyof M> = (
+  value: M[K]
+) => boolean
+
+export interface Where<M extends Model, T extends keyof M> {
+  field: T
+  value: WhereSecondaryClosure<M, T> | M[T] | M[T][]
   boolean: 'and' | 'or'
 }
 
-export interface WhereGroup {
-  and?: Where[]
-  or?: Where[]
+export interface WhereGroup<M extends Model, T extends keyof M> {
+  and?: Where<M, T>[]
+  or?: Where<M, T>[]
 }
 
 export interface Order {

src/query/Query.ts

@@ -1,11 +1,18 @@
 import { Store } from 'vuex'
-import { isArray, isEmpty, orderBy, groupBy } from '../support/Utils'
+import {
+  isArray,
+  isFunction,
+  isEmpty,
+  orderBy,
+  groupBy
+} from '../support/Utils'
 import { Element, Item, Collection } from '../data/Data'
 import { Relation } from '../model/attributes/relations/Relation'
 import { Model } from '../model/Model'
 import { Connection } from '../connection/Connection'
 import {
   Where,
+  WhereSecondaryClosure,
   Order,
   OrderDirection,
   EagerLoad,
@@ -26,7 +33,7 @@ export class Query<M extends Model = Model> {
   /**
    * The where constraints for the query.
    */
-  protected wheres: Where[] = []
+  protected wheres: Where<M, any>[] = []
 
   /**
    * The orderings for the query.
@@ -73,7 +80,9 @@ export class Query<M extends Model = Model> {
   /**
    * Add a basic where clause to the query.
    */
-  where(field: string, value: any): this {
+  where<T extends keyof M>(field: T, value: WhereSecondaryClosure<M, T>): this
+  where<T extends keyof M>(field: T, value: M[T] | M[T][]): this
+  where(field: any, value: any): any {
     this.wheres.push({ field, value, boolean: 'and' })
 
     return this
@@ -82,7 +91,7 @@ export class Query<M extends Model = Model> {
   /**
    * Add a "where in" clause to the query.
    */
-  whereIn(field: string, values: any[]): this {
+  whereIn<T extends keyof M>(field: T, values: M[T][]): this {
     this.wheres.push({ field, value: values, boolean: 'and' })
 
     return this
@@ -91,14 +100,16 @@ export class Query<M extends Model = Model> {
   /**
    * Add a where clause on the primary key to the query.
    */
-  whereId(ids: string | number | (string | number)[]): this {
-    return this.where(this.model.$getPrimaryKey(), ids)
+  whereId<T extends keyof M>(ids: M[T] | M[T][]): this {
+    return this.where(this.model.$getPrimaryKey() as T, ids)
   }
 
   /**
    * Add an "or where" clause to the query.
    */
-  orWhere(field: string, value: any): Query<M> {
+  orWhere<T extends keyof M>(field: T, value: WhereSecondaryClosure<M, T>): this
+  orWhere<T extends keyof M>(field: T, value: M[T] | M[T][]): this
+  orWhere(field: any, value: any): any {
     this.wheres.push({ field, value, boolean: 'or' })
 
     return this
@@ -261,11 +272,15 @@ export class Query<M extends Model = Model> {
   /**
    * The function to compare where clause to the given model.
    */
-  protected whereComparator(model: M, where: Where): boolean {
+  protected whereComparator(model: M, where: Where<M, any>): boolean {
     if (isArray(where.value)) {
       return where.value.includes(model[where.field])
     }
 
+    if (isFunction(where.value)) {
+      return where.value(model[where.field])
+    }
+
     return model[where.field] === where.value
   }
 
@@ -396,7 +411,7 @@ export class Query<M extends Model = Model> {
   /**
    * Destroy the models for the given id.
    */
-  async destroyMany(ids: (string | number)[]): Promise<Collection<M>> {
+  async destroyMany<T extends keyof M>(ids: M[T][]): Promise<Collection<M>> {
     return this.whereId(ids).delete()
   }
 

src/repository/Repository.ts

@@ -11,7 +11,7 @@ import {
 import { Model } from '../model/Model'
 import { Interpretation } from '../interpretation/Interpretation'
 import { Query } from '../query/Query'
-import { OrderDirection } from '../query/Options'
+import { WhereSecondaryClosure, OrderDirection } from '../query/Options'
 
 export type PersistMethod = 'insert' | 'merge'
 
@@ -66,14 +66,24 @@ export class Repository<M extends Model> {
   /**
    * Add a basic where clause to the query.
    */
-  where(field: string, value: any): Query<M> {
+  where<T extends keyof M>(
+    field: T,
+    value: WhereSecondaryClosure<M, T>
+  ): Query<M>
+  where<T extends keyof M>(field: T, value: M[T] | M[T][]): Query<M>
+  where(field: any, value: any): any {
     return this.query().where(field, value)
   }
 
   /**
    * Add an "or where" clause to the query.
    */
-  orWhere(field: string, value: any): Query<M> {
+  orWhere<T extends keyof M>(
+    field: T,
+    value: WhereSecondaryClosure<M, T>
+  ): Query<M>
+  orWhere<T extends keyof M>(field: T, value: M[T] | M[T][]): Query<M>
+  orWhere(field: any, value: any): any {
     return this.query().orWhere(field, value)
   }
 

src/support/Utils.ts

@@ -25,6 +25,13 @@ export function isArray(value: any): value is any[] {
   return Array.isArray(value)
 }
 
+/**
+ * Check if the given value is the type of array.
+ */
+export function isFunction(value: any): value is Function {
+  return typeof value === 'function'
+}
+
 /**
  * Check if the given array or object is empty.
  */

test/feature/repository/retrieves_where.spec.ts

@@ -61,4 +61,30 @@ describe('feature/repository/retrieves_where', () => {
     assertInstanceOf(users, User)
     assertModels(users, expected)
   })
+
+  it('can filter records by passing closure as a value', () => {
+    const store = createStore([User])
+
+    fillState(store, {
+      users: {
+        1: { id: 1, name: 'John Doe', age: 30 },
+        2: { id: 2, name: 'Jane Doe', age: 30 },
+        3: { id: 3, name: 'Johnny Doe', age: 20 }
+      }
+    })
+
+    const users = store
+      .$repo(User)
+      .where('age', (value) => value === 30)
+      .get()
+
+    const expected = [
+      { id: 1, name: 'John Doe', age: 30 },
+      { id: 2, name: 'Jane Doe', age: 30 }
+    ]
+
+    expect(users.length).toBe(2)
+    assertInstanceOf(users, User)
+    assertModels(users, expected)
+  })
 })