New Query API

Author: schmidt-sebastian

packages/firestore/exp/index.d.ts

@@ -273,28 +273,50 @@ export type WhereFilterOp =
 export class Query<T = DocumentData> {
   protected constructor();
   readonly firestore: FirebaseFirestore;
-  where(
-    fieldPath: string | FieldPath,
-    opStr: WhereFilterOp,
-    value: any
-  ): Query<T>;
-  orderBy(
-    fieldPath: string | FieldPath,
-    directionStr?: OrderByDirection
-  ): Query<T>;
-  limit(limit: number): Query<T>;
-  limitToLast(limit: number): Query<T>;
-  startAt(snapshot: DocumentSnapshot<any>): Query<T>;
-  startAt(...fieldValues: any[]): Query<T>;
-  startAfter(snapshot: DocumentSnapshot<any>): Query<T>;
-  startAfter(...fieldValues: any[]): Query<T>;
-  endBefore(snapshot: DocumentSnapshot<any>): Query<T>;
-  endBefore(...fieldValues: any[]): Query<T>;
-  endAt(snapshot: DocumentSnapshot<any>): Query<T>;
-  endAt(...fieldValues: any[]): Query<T>;
+
   withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 
+export type QueryConstraintType =
+  | 'where'
+  | 'orderBy'
+  | 'limit'
+  | 'limitToLast'
+  | 'startAt'
+  | 'startAfter'
+  | 'endAt'
+  | 'endBefore';
+
+export class QueryConstraint {
+  private constructor();
+  readonly type: QueryConstraintType;
+}
+
+export function query<T>(
+  query: CollectionReference<T> | Query<T>,
+  ...constraints: QueryConstraint[]
+): Query<T>;
+
+export function where(
+  fieldPath: string | FieldPath,
+  opStr: WhereFilterOp,
+  value: any
+): QueryConstraint;
+export function orderBy(
+  fieldPath: string | FieldPath,
+  directionStr?: OrderByDirection
+): QueryConstraint;
+export function limit(limit: number): QueryConstraint;
+export function limitToLast(limit: number): QueryConstraint;
+export function startAt(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function startAt(...fieldValues: any[]): QueryConstraint;
+export function startAfter(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function startAfter(...fieldValues: any[]): QueryConstraint;
+export function endBefore(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function endBefore(...fieldValues: any[]): QueryConstraint;
+export function endAt(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function endAt(...fieldValues: any[]): QueryConstraint;
+
 export class QuerySnapshot<T = DocumentData> {
   private constructor();
   readonly query: Query<T>;

packages/firestore/karma.conf.js

@@ -18,7 +18,7 @@
 const karmaBase = require('../../config/karma.base');
 const { argv } = require('yargs');
 
-module.exports = function (config) {
+module.exports = function(config) {
   const karmaConfig = Object.assign({}, karmaBase, {
     // files to load into karma
     files: getTestFiles(argv),

packages/firestore/lite/index.d.ts

@@ -228,28 +228,50 @@ export type WhereFilterOp =
 export class Query<T = DocumentData> {
   protected constructor();
   readonly firestore: FirebaseFirestore;
-  where(
-    fieldPath: string | FieldPath,
-    opStr: WhereFilterOp,
-    value: any
-  ): Query<T>;
-  orderBy(
-    fieldPath: string | FieldPath,
-    directionStr?: OrderByDirection
-  ): Query<T>;
-  limit(limit: number): Query<T>;
-  limitToLast(limit: number): Query<T>;
-  startAt(snapshot: DocumentSnapshot<any>): Query<T>;
-  startAt(...fieldValues: any[]): Query<T>;
-  startAfter(snapshot: DocumentSnapshot<any>): Query<T>;
-  startAfter(...fieldValues: any[]): Query<T>;
-  endBefore(snapshot: DocumentSnapshot<any>): Query<T>;
-  endBefore(...fieldValues: any[]): Query<T>;
-  endAt(snapshot: DocumentSnapshot<any>): Query<T>;
-  endAt(...fieldValues: any[]): Query<T>;
+
   withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 
+export type QueryConstraintType =
+  | 'where'
+  | 'orderBy'
+  | 'limit'
+  | 'limitToLast'
+  | 'startAt'
+  | 'startAfter'
+  | 'endAt'
+  | 'endBefore';
+
+export class QueryConstraint {
+  private constructor();
+  readonly type: QueryConstraintType;
+}
+
+export function query<T>(
+  query: CollectionReference<T> | Query<T>,
+  ...constraints: QueryConstraint[]
+): Query<T>;
+
+export function where(
+  fieldPath: string | FieldPath,
+  opStr: WhereFilterOp,
+  value: any
+): QueryConstraint;
+export function orderBy(
+  fieldPath: string | FieldPath,
+  directionStr?: OrderByDirection
+): QueryConstraint;
+export function limit(limit: number): QueryConstraint;
+export function limitToLast(limit: number): QueryConstraint;
+export function startAt(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function startAt<T>(...fieldValues: any[]): QueryConstraint;
+export function startAfter(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function startAfter(...fieldValues: any[]): QueryConstraint;
+export function endBefore(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function endBefore(...fieldValues: any[]): QueryConstraint;
+export function endAt(snapshot: DocumentSnapshot<any>): QueryConstraint;
+export function endAt(...fieldValues: any[]): QueryConstraint;
+
 export class QuerySnapshot<T = DocumentData> {
   private constructor();
   readonly query: Query<T>;

packages/firestore/lite/index.node.ts

@@ -42,7 +42,17 @@ export {
   updateDoc,
   addDoc,
   refEqual,
-  queryEqual
+  queryEqual,
+  QueryConstraint,
+  startAt,
+  startAfter,
+  endAt,
+  endBefore,
+  query,
+  limit,
+  limitToLast,
+  where,
+  orderBy
 } from './src/api/reference';
 
 // TOOD(firestorelite): Add tests when Queries are usable