Feature/expanded query #857

Author: EddyVerbruggen

demo-ng/app/tabs/firestore/firestore.component.html

@@ -25,7 +25,8 @@
     <Button text="Where" (tap)="firestoreWhere()" class="button"></Button>
     <Button text="Where, Order, Limit" (tap)="firestoreWhereOrderLimit()" class="button"></Button>
     <Button text="Where array_contains" (tap)="firestoreWhereCityHasALake()" class="button"></Button>
-    <Button text="Start After" (tap)="firestoreStartAfter()" class="button"></Button>
+    <Button text="Start at 'LA'" (tap)="firestoreStartAt()" class="button"></Button>
+    <Button text="Start after 'LA'" (tap)="firestoreStartAfter()" class="button"></Button>
     <Button text="Delete" (tap)="firestoreDelete()" class="button"></Button>
     <Button text="Transactional update (iOS)" (tap)="transactionalUpdate()" class="button"></Button>
     <Button text="Write batch" (tap)="writeBatch()" class="button"></Button>

demo-ng/app/tabs/firestore/firestore.component.ts

@@ -345,13 +345,26 @@ export class FirestoreComponent {
         .catch(error => console.log("doTransaction error: " + error));
   }
 
+  public firestoreStartAt(): void {
+    firebase.firestore().collection('cities')
+      .doc('LA')
+      .get()
+      .then(doc => {
+        firebase.firestore().collection('cities')
+          .orderBy('name', 'asc')
+          .startAt(doc)
+          .get()
+          .then(snap => snap.forEach(doc => console.log(doc.id, doc.data())));
+      });
+  }
+
   public firestoreStartAfter(): void {
-    const beijingSnapshot = firebase.firestore().collection('cities')
-      .doc('BJ')
+    firebase.firestore().collection('cities')
+      .doc('LA')
       .get()
       .then(doc => {
         firebase.firestore().collection('cities')
-          .orderBy('country', 'asc')
+          .orderBy('name', 'asc')
           .startAfter(doc)
           .get()
           .then(snap => snap.forEach(doc => console.log(doc.id, doc.data())));

docs/FIRESTORE.md

@@ -239,6 +239,24 @@ query
     });
 ```
 
+### Paginate data with query cursors
+You can use `startAt`, `startAfter`, `endAt`, and `endBefore` as documented for 'WEB' [here](https://firebase.google.com/docs/firestore/query-data/query-cursors).
+
+Here's an example, grabbing cities ordered by name, starting after 'LA':
+
+```typescript
+firebase.firestore().collection('cities')
+  .doc('LA')
+  .get()
+  .then(doc => {
+    firebase.firestore().collection('cities')
+      .orderBy('name', 'asc')
+      .startAfter(doc)
+      .get()
+      .then(snap => snap.forEach(doc => console.log(doc.id, doc.data())));
+  });
+```
+
 ### Batched Writes: `batch()`
 To perform a (mixed) sequence of `set`, `update`, and/or `delete` operations in an atomic fashion
 (everything is rolled back if 1 operation fails), use the `batch` feature.

src/firebase.android.ts

@@ -2672,20 +2672,19 @@ firebase.firestore.limit = (collectionPath: string, limit: number, query: com.go
 };
 
 firebase.firestore.startAfter = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
-  query = query.startAt(snapshot.android);
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.startAfter(snapshot.android));
 };
 
 firebase.firestore.startAt = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.startAt(snapshot.android));
 };
 
 firebase.firestore.endAt = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.endAt(snapshot.android));
 };
 
 firebase.firestore.endBefore = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.endBefore(snapshot.android));
 };
 
 

src/firebase.d.ts

@@ -713,8 +713,8 @@ export namespace firestore {
   }
 
   export interface DocumentSnapshot {
-    ios?: FIRDocumentSnapshot;
-    android?: com.google.firebase.firestore.DocumentSnapshot;
+    ios?: any; /* FIRDocumentSnapshot */
+    android?: any; /* com.google.firebase.firestore.DocumentSnapshot */
     id: string;
     exists: boolean;
     data(): DocumentData;
@@ -750,7 +750,7 @@ export namespace firestore {
 
     startAfter(snapshot: DocumentSnapshot): Query;
 
-    endAt(snaptshot: DocumentSnapshot): Query;
+    endAt(snapshot: DocumentSnapshot): Query;
 
     endBefore(snapshot: DocumentSnapshot): Query;
   }

src/firebase.ios.ts

@@ -2161,7 +2161,7 @@ firebase.firestore.Transaction = (nativeTransaction: FIRTransaction): firestore.
 
     public get = (documentRef: firestore.DocumentReference): DocumentSnapshot => {
       const docSnapshot: FIRDocumentSnapshot = nativeTransaction.getDocumentError(documentRef.ios);
-      return new DocumentSnapshot(docSnapshot.exists ? docSnapshot.documentID : null, docSnapshot.exists, firebase.toJsObject(docSnapshot.data()));
+      return new DocumentSnapshot(docSnapshot);
     };
 
     public set = (documentRef: firestore.DocumentReference, data: firestore.DocumentData, options?: firestore.SetOptions): firestore.Transaction => {
@@ -2590,23 +2590,19 @@ firebase.firestore.limit = (collectionPath: string, limit: number, query: FIRQue
 };
 
 firebase.firestore.startAt = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
-  query = query.queryStartingAtDocument(document.ios);
-  return firebase.firestore._getQuery(collectionPath, query);
-}
+  return firebase.firestore._getQuery(collectionPath, query.queryStartingAtDocument(document.ios));
+};
 
 firebase.firestore.startAfter = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
-  query = query.queryStartingAfterDocument(document.ios);
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.queryStartingAfterDocument(document.ios));
 };
 
 firebase.firestore.endAt = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
-  query = query.queryEndingAtDocument(document.ios);
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.queryEndingAtDocument(document.ios));
 };
 
 firebase.firestore.endBefore = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
-  query = query.queryEndingBeforeDocument(document.ios);
-  return firebase.firestore._getQuery(collectionPath, query);
+  return firebase.firestore._getQuery(collectionPath, query.queryEndingBeforeDocument(document.ios));
 };
 
 // see https://developer.apple.com/reference/usernotifications/unusernotificationcenterdelegate?language=objc