Merge pull request #246 from MarZab/feat/custom-query

src/AbstractFirestoreRepository.ts

@@ -18,6 +18,7 @@ import {
   PartialBy,
   IEntityConstructor,
   ITransactionReferenceStorage,
+  ICustomQuery,
 } from './types';
 
 import { isDocumentReference, isGeoPoint, isObject, isTimestamp } from './TypeGuards';
@@ -356,6 +357,19 @@ export abstract class AbstractFirestoreRepository<T extends IEntity>
     return new QueryBuilder<T>(this).findOne();
   }
 
+  /**
+   * Returns a new QueryBuilder with an custom query
+   * specified by @param func. Can only be used once per query.
+   *
+   * @param {ICustomQuery<T>} func function to run in a new query
+   * @returns {QueryBuilder<T>} A new QueryBuilder with the specified
+   * custom query applied.
+   * @memberof AbstractFirestoreRepository
+   */
+  customQuery(func: ICustomQuery<T>): IQueryBuilder<T> {
+    return new QueryBuilder<T>(this).customQuery(func);
+  }
+
   /**
    * Uses class-validator to validate an entity using decorators set in the collection class
    *
@@ -403,7 +417,8 @@ export abstract class AbstractFirestoreRepository<T extends IEntity>
     queries: IFireOrmQueryLine[],
     limitVal?: number,
     orderByObj?: IOrderByParams,
-    single?: boolean
+    single?: boolean,
+    customQuery?: ICustomQuery<T>
   ): Promise<T[]>;
 
   /**

src/BaseFirestoreRepository.ts

@@ -9,6 +9,7 @@ import {
   IEntity,
   PartialBy,
   ITransactionRepository,
+  ICustomQuery,
 } from './types';
 
 import { getMetadataStorage } from './MetadataUtils';
@@ -93,7 +94,8 @@ export class BaseFirestoreRepository<T extends IEntity>
     queries: Array<IFireOrmQueryLine>,
     limitVal?: number,
     orderByObj?: IOrderByParams,
-    single?: boolean
+    single?: boolean,
+    customQuery?: ICustomQuery<T>
   ): Promise<T[]> {
     let query = queries.reduce<Query>((acc, cur) => {
       const op = cur.operator as WhereFilterOp;
@@ -110,6 +112,10 @@ export class BaseFirestoreRepository<T extends IEntity>
       query = query.limit(limitVal);
     }
 
+    if (customQuery) {
+      query = await customQuery(query, this.firestoreColRef);
+    }
+
     return query.get().then(this.extractTFromColSnap);
   }
 }

src/QueryBuilder.ts

@@ -9,12 +9,14 @@ import {
   IQueryExecutor,
   IEntity,
   IWherePropParam,
+  ICustomQuery,
 } from './types';
 
 export class QueryBuilder<T extends IEntity> implements IQueryBuilder<T> {
   protected queries: Array<IFireOrmQueryLine> = [];
   protected limitVal: number;
   protected orderByObj: IOrderByParams;
+  protected customQueryFunction?: ICustomQuery<T>;
 
   constructor(protected executor: IQueryExecutor<T>) {}
 
@@ -172,15 +174,32 @@ export class QueryBuilder<T extends IEntity> implements IQueryBuilder<T> {
   }
 
   find() {
-    return this.executor.execute(this.queries, this.limitVal, this.orderByObj);
+    return this.executor.execute(
+      this.queries,
+      this.limitVal,
+      this.orderByObj,
+      false,
+      this.customQueryFunction
+    );
+  }
+
+  customQuery(func: ICustomQuery<T>) {
+    if (this.customQueryFunction) {
+      throw new Error('Only one custom query can be used per query expression');
+    }
+
+    this.customQueryFunction = func;
+
+    return this;
   }
 
   async findOne() {
     const queryResult = await this.executor.execute(
       this.queries,
       this.limitVal,
       this.orderByObj,
-      true
+      true,
+      this.customQueryFunction
     );
 
     return queryResult.length ? queryResult[0] : null;

src/types.ts

@@ -1,4 +1,5 @@
-import { OrderByDirection, DocumentReference } from '@google-cloud/firestore';
+import { OrderByDirection, DocumentReference, CollectionReference } from '@google-cloud/firestore';
+import { Query } from '@google-cloud/firestore';
 
 export type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
 export type PartialWithRequiredBy<T, K extends keyof T> = Pick<T, K> & Partial<Omit<T, K>>;
@@ -49,6 +50,7 @@ export interface IQueryable<T extends IEntity> {
   whereNotIn(prop: IWherePropParam<T>, val: IFirestoreVal[]): IQueryBuilder<T>;
   find(): Promise<T[]>;
   findOne(): Promise<T | null>;
+  customQuery(func: ICustomQuery<T>): IQueryBuilder<T>;
 }
 
 export interface IOrderable<T extends IEntity> {
@@ -62,12 +64,18 @@ export interface ILimitable<T extends IEntity> {
 
 export type IQueryBuilder<T extends IEntity> = IQueryable<T> & IOrderable<T> & ILimitable<T>;
 
+export type ICustomQuery<T> = (
+  query: Query,
+  firestoreColRef: CollectionReference
+) => Promise<Query>;
+
 export interface IQueryExecutor<T> {
   execute(
     queries: IFireOrmQueryLine[],
     limitVal?: number,
     orderByObj?: IOrderByParams,
-    single?: boolean
+    single?: boolean,
+    customQuery?: ICustomQuery<T>
   ): Promise<T[]>;
 }