Merge pull request #857 from vcooley/feature/expanded-query

EddyVerbruggen · web-flow · commit 041dd7bf6ae4 · 2018-08-27T10:58:35.000+02:00
Feature/expanded query
diff --git a/demo-ng/app/tabs/firestore/firestore.component.html b/demo-ng/app/tabs/firestore/firestore.component.html
@@ -25,6 +25,7 @@
     <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="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>
diff --git a/demo-ng/app/tabs/firestore/firestore.component.ts b/demo-ng/app/tabs/firestore/firestore.component.ts
@@ -344,4 +344,17 @@ export class FirestoreComponent {
         .then(() => console.log(`Transaction successfully committed`))
         .catch(error => console.log("doTransaction error: " + error));
   }
+
+  public firestoreStartAfter(): void {
+    const beijingSnapshot = firebase.firestore().collection('cities')
+      .doc('BJ')
+      .get()
+      .then(doc => {
+        firebase.firestore().collection('cities')
+          .orderBy('country', 'asc')
+          .startAfter(doc)
+          .get()
+          .then(snap => snap.forEach(doc => console.log(doc.id, doc.data())));
+      });
+  }
 }
diff --git a/demo-ng/tsconfig.json b/demo-ng/tsconfig.json
@@ -26,4 +26,4 @@
         "node_modules",
         "platforms"
     ]
-}
+}
diff --git a/src/firebase-common.ts b/src/firebase-common.ts
@@ -215,7 +215,7 @@ export const firebase: any = {
   }
 };
 
-export class DocumentSnapshot implements firestore.DocumentSnapshot {
+export abstract class DocumentSnapshot implements firestore.DocumentSnapshot {
   public data: () => firestore.DocumentData;
   constructor(public id: string, public exists: boolean, documentData: firestore.DocumentData) {
     this.data = () => exists ? documentData : undefined;
diff --git a/src/firebase.android.ts b/src/firebase.android.ts
@@ -1,4 +1,4 @@
-import { DocumentSnapshot, firebase, GeoPoint, QuerySnapshot, isDocumentReference } from "./firebase-common";
+import { DocumentSnapshot as DocumentSnapshotBase, firebase, GeoPoint, QuerySnapshot, isDocumentReference } from "./firebase-common";
 import * as appModule from "tns-core-modules/application";
 import { AndroidActivityResultEventData } from "tns-core-modules/application";
 import { ad as AndroidUtils, layout } from "tns-core-modules/utils/utils";
@@ -8,6 +8,15 @@ import { firestore, User } from "./firebase";
 
 declare const android, com, org: any;
 
+class DocumentSnapshot extends DocumentSnapshotBase {
+  android: com.google.firebase.firestore.DocumentSnapshot;
+
+  constructor(public snapshot: com.google.firebase.firestore.DocumentSnapshot) {
+    super(snapshot ? snapshot.getId() : null, snapshot.exists(), firebase.toJsObject(snapshot.getData()));
+    this.android = snapshot;
+  }
+}
+
 firebase._launchNotification = null;
 firebase._cachedDynamicLink = null;
 
@@ -2264,7 +2273,11 @@ firebase.firestore.collection = (collectionPath: string): firestore.CollectionRe
       where: (fieldPath: string, opStr: firestore.WhereFilterOp, value: any) => firebase.firestore.where(collectionPath, fieldPath, opStr, value),
       orderBy: (fieldPath: string, directionStr: firestore.OrderByDirection): firestore.Query => firebase.firestore.orderBy(collectionPath, fieldPath, directionStr, collectionRef),
       limit: (limit: number): firestore.Query => firebase.firestore.limit(collectionPath, limit, collectionRef),
-      onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(collectionRef, callback)
+      onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(collectionRef, callback),
+      startAfter: (snapshot: DocumentSnapshot): firestore.Query => firebase.firestore.startAfter(collectionPath, snapshot, collectionRef),
+      startAt: (snapshot: DocumentSnapshot): firestore.Query => firebase.firestore.startAt(collectionPath, snapshot, collectionRef),
+      endAt: (snapshot: DocumentSnapshot): firestore.Query => firebase.firestore.endAt(collectionPath, snapshot, collectionRef),
+      endBefore: (snapshot: DocumentSnapshot): firestore.Query => firebase.firestore.endBefore(collectionPath, snapshot, collectionRef),
     };
 
   } catch (ex) {
@@ -2277,7 +2290,7 @@ firebase.firestore.onDocumentSnapshot = (docRef: com.google.firebase.firestore.D
   const listener = docRef.addSnapshotListener(new com.google.firebase.firestore.EventListener({
         onEvent: ((snapshot: com.google.firebase.firestore.DocumentSnapshot, exception) => {
           if (exception === null) {
-            callback(new DocumentSnapshot(snapshot ? snapshot.getId() : null, snapshot.exists(), firebase.toJsObject(snapshot.getData())));
+            callback(new DocumentSnapshot(snapshot));
           }
         })
       })
@@ -2296,7 +2309,7 @@ firebase.firestore.onCollectionSnapshot = (colRef: com.google.firebase.firestore
           const docSnapshots: Array<firestore.DocumentSnapshot> = [];
           for (let i = 0; i < snapshot.size(); i++) {
             const documentSnapshot: com.google.firebase.firestore.DocumentSnapshot = snapshot.getDocuments().get(i);
-            docSnapshots.push(new DocumentSnapshot(documentSnapshot.getId(), true, firebase.toJsObject(documentSnapshot.getData())));
+            docSnapshots.push(new DocumentSnapshot(documentSnapshot));
           }
           const snap = new QuerySnapshot();
           snap.docSnapshots = docSnapshots;
@@ -2505,7 +2518,7 @@ firebase.firestore.getCollection = (collectionPath: string): Promise<firestore.Q
             const docSnapshots: Array<firestore.DocumentSnapshot> = [];
             for (let i = 0; i < result.size(); i++) {
               const documentSnapshot: com.google.firebase.firestore.DocumentSnapshot = result.getDocuments().get(i);
-              docSnapshots.push(new DocumentSnapshot(documentSnapshot.getId(), true, firebase.toJsObject(documentSnapshot.getData())));
+              docSnapshots.push(new DocumentSnapshot(documentSnapshot));
             }
             const snap = new QuerySnapshot();
             snap.docSnapshots = docSnapshots;
@@ -2554,8 +2567,7 @@ firebase.firestore.getDocument = (collectionPath: string, documentPath: string):
             reject(ex && ex.getReason ? ex.getReason() : ex);
           } else {
             const result: com.google.firebase.firestore.DocumentSnapshot = task.getResult();
-            const exists = result.exists();
-            resolve(new DocumentSnapshot(exists ? result.getId() : null, exists, firebase.toJsObject(result.getData())));
+            resolve(new DocumentSnapshot(result));
           }
         }
       });
@@ -2592,7 +2604,7 @@ firebase.firestore._getQuery = (collectionPath: string, query: com.google.fireba
             const docSnapshots: Array<firestore.DocumentSnapshot> = [];
             for (let i = 0; i < result.size(); i++) {
               const documentSnapshot: com.google.firebase.firestore.DocumentSnapshot = result.getDocuments().get(i);
-              docSnapshots.push(new DocumentSnapshot(documentSnapshot.getId(), true, firebase.toJsObject(documentSnapshot.getData())));
+              docSnapshots.push(new DocumentSnapshot(documentSnapshot));
             }
             const snap = new QuerySnapshot();
             snap.docSnapshots = docSnapshots;
@@ -2605,7 +2617,11 @@ firebase.firestore._getQuery = (collectionPath: string, query: com.google.fireba
     where: (fp: string, os: firestore.WhereFilterOp, v: any): firestore.Query => firebase.firestore.where(collectionPath, fp, os, v, query),
     orderBy: (fp: string, directionStr: firestore.OrderByDirection): firestore.Query => firebase.firestore.orderBy(collectionPath, fp, directionStr, query),
     limit: (limit: number): firestore.Query => firebase.firestore.limit(collectionPath, limit, query),
-    onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(query, callback)
+    onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(query, callback),
+    startAfter: (snapshot: DocumentSnapshot) => firebase.firestore.startAfter(collectionPath, snapshot, query),
+    startAt: (snapshot: DocumentSnapshot) => firebase.firestore.startAt(collectionPath, snapshot, query),
+    endAt: (snapshot: DocumentSnapshot) => firebase.firestore.endAt(collectionPath, snapshot, query),
+    endBefore: (snapshot: DocumentSnapshot) => firebase.firestore.endBefore(collectionPath, snapshot, query),
   };
 };
 
@@ -2655,4 +2671,22 @@ firebase.firestore.limit = (collectionPath: string, limit: number, query: com.go
   return firebase.firestore._getQuery(collectionPath, query);
 };
 
+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);
+};
+
+firebase.firestore.startAt = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
+firebase.firestore.endAt = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
+firebase.firestore.endBefore = (collectionPath: string, snapshot: DocumentSnapshot, query: com.google.firebase.firestore.Query): firestore.Query => {
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
+
 module.exports = firebase;
diff --git a/src/firebase.d.ts b/src/firebase.d.ts
@@ -713,9 +713,10 @@ export namespace firestore {
   }
 
   export interface DocumentSnapshot {
+    ios?: FIRDocumentSnapshot;
+    android?: com.google.firebase.firestore.DocumentSnapshot;
     id: string;
     exists: boolean;
-
     data(): DocumentData;
   }
 
@@ -744,6 +745,14 @@ export namespace firestore {
     limit(limit: number): Query;
 
     onSnapshot(callback: (snapshot: QuerySnapshot) => void): () => void;
+
+    startAt(snapshot: DocumentSnapshot): Query;
+
+    startAfter(snapshot: DocumentSnapshot): Query;
+
+    endAt(snaptshot: DocumentSnapshot): Query;
+
+    endBefore(snapshot: DocumentSnapshot): Query;
   }
 
   export interface CollectionReference extends Query {
diff --git a/src/firebase.ios.ts b/src/firebase.ios.ts
@@ -1,4 +1,4 @@
-import { firebase, DocumentSnapshot, QuerySnapshot, GeoPoint, isDocumentReference } from "./firebase-common";
+import { firebase, DocumentSnapshot as DocumentSnapshotBase, QuerySnapshot, GeoPoint, isDocumentReference } from "./firebase-common";
 import * as application from "tns-core-modules/application";
 import { ios as iOSUtils } from "tns-core-modules/utils/utils";
 import { getClass } from "tns-core-modules/utils/types";
@@ -14,6 +14,14 @@ firebase._cachedInvitation = null;
 firebase._cachedDynamicLink = null;
 firebase._configured = false;
 
+class DocumentSnapshot extends DocumentSnapshotBase {
+  ios: FIRDocumentSnapshot;
+  constructor(snapshot: FIRDocumentSnapshot) {
+    super(snapshot.documentID, snapshot.exists, firebase.toJsObject(snapshot.data()));
+    this.ios = snapshot;
+  }
+}
+
 // Note that FIRApp.configure must be called only once, but not here (see https://github.com/EddyVerbruggen/nativescript-plugin-firebase/issues/564)
 
 const invokeOnRunLoop = (() => {
@@ -2205,7 +2213,11 @@ firebase.firestore.collection = (collectionPath: string): firestore.CollectionRe
       where: (fieldPath: string, opStr: firestore.WhereFilterOp, value: any) => firebase.firestore.where(collectionPath, fieldPath, opStr, value),
       orderBy: (fieldPath: string, directionStr: firestore.OrderByDirection): firestore.Query => firebase.firestore.orderBy(collectionPath, fieldPath, directionStr, fIRCollectionReference),
       limit: (limit: number): firestore.Query => firebase.firestore.limit(collectionPath, limit, fIRCollectionReference),
-      onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(fIRCollectionReference, callback)
+      onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(fIRCollectionReference, callback),
+      startAfter: (document: DocumentSnapshot) => firebase.firestore.startAfter(collectionPath, document, fIRCollectionReference),
+      startAt: (document: DocumentSnapshot) => firebase.firestore.startAt(collectionPath, document, fIRCollectionReference),
+      endAt: (document: DocumentSnapshot) => firebase.firestore.endAt(collectionPath, document, fIRCollectionReference),
+      endBefore: (document: DocumentSnapshot) => firebase.firestore.endBefore(collectionPath, document, fIRCollectionReference),
     };
 
   } catch (ex) {
@@ -2217,7 +2229,7 @@ firebase.firestore.collection = (collectionPath: string): firestore.CollectionRe
 firebase.firestore.onDocumentSnapshot = (docRef: FIRDocumentReference, callback: (doc: DocumentSnapshot) => void): () => void => {
   const listener = docRef.addSnapshotListener((snapshot: FIRDocumentSnapshot, error: NSError) => {
     if (!error && snapshot) {
-      callback(new DocumentSnapshot(snapshot.documentID, snapshot.exists, firebase.toJsObject(snapshot.data())));
+      callback(new DocumentSnapshot(snapshot));
     }
   });
 
@@ -2238,7 +2250,7 @@ firebase.firestore.onCollectionSnapshot = (colRef: FIRCollectionReference, callb
     const docSnapshots: Array<firestore.DocumentSnapshot> = [];
     for (let i = 0, l = snapshot.documents.count; i < l; i++) {
       const document: FIRQueryDocumentSnapshot = snapshot.documents.objectAtIndex(i);
-      docSnapshots.push(new DocumentSnapshot(document.documentID, true, firebase.toJsObject(document.data())));
+      docSnapshots.push(new DocumentSnapshot(document));
     }
 
     const snap = new QuerySnapshot();
@@ -2454,7 +2466,7 @@ firebase.firestore.getCollection = (collectionPath: string): Promise<firestore.Q
               const docSnapshots: Array<firestore.DocumentSnapshot> = [];
               for (let i = 0, l = snapshot.documents.count; i < l; i++) {
                 const document: FIRQueryDocumentSnapshot = snapshot.documents.objectAtIndex(i);
-                docSnapshots.push(new DocumentSnapshot(document.documentID, true, firebase.toJsObject(document.data())));
+                docSnapshots.push(new DocumentSnapshot(document));
               }
               const snap = new QuerySnapshot();
               snap.docSnapshots = docSnapshots;
@@ -2489,7 +2501,7 @@ firebase.firestore.getDocument = (collectionPath: string, documentPath: string):
               reject(error.localizedDescription);
             } else {
               const exists = snapshot.exists;
-              resolve(new DocumentSnapshot(exists ? snapshot.documentID : null, exists, firebase.toJsObject(snapshot.data())));
+              resolve(new DocumentSnapshot(snapshot));
             }
           });
 
@@ -2511,7 +2523,7 @@ firebase.firestore._getQuery = (collectionPath: string, query: FIRQuery): firest
           const docSnapshots: Array<firestore.DocumentSnapshot> = [];
           for (let i = 0, l = snapshot.documents.count; i < l; i++) {
             const document: FIRQueryDocumentSnapshot = snapshot.documents.objectAtIndex(i);
-            docSnapshots.push(new DocumentSnapshot(document.documentID, true, firebase.toJsObject(document.data())));
+            docSnapshots.push(new DocumentSnapshot(document));
           }
           const snap = new QuerySnapshot();
           snap.docSnapshots = docSnapshots;
@@ -2522,7 +2534,11 @@ firebase.firestore._getQuery = (collectionPath: string, query: FIRQuery): firest
     where: (fp: string, os: firestore.WhereFilterOp, v: any): firestore.Query => firebase.firestore.where(collectionPath, fp, os, v, query),
     orderBy: (fp: string, directionStr: firestore.OrderByDirection): firestore.Query => firebase.firestore.orderBy(collectionPath, fp, directionStr, query),
     limit: (limit: number): firestore.Query => firebase.firestore.limit(collectionPath, limit, query),
-    onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(query, callback)
+    onSnapshot: (callback: (snapshot: QuerySnapshot) => void) => firebase.firestore.onCollectionSnapshot(query, callback),
+    startAfter: (document: DocumentSnapshot) => firebase.firestore.startAfter(collectionPath, document, query),
+    startAt: (document: DocumentSnapshot) => firebase.firestore.startAt(collectionPath, document, query),
+    endAt: (document: DocumentSnapshot) => firebase.firestore.endAt(collectionPath, document, query),
+    endBefore: (document: DocumentSnapshot) => firebase.firestore.endBefore(collectionPath, document, query),
   };
 };
 
@@ -2573,6 +2589,26 @@ firebase.firestore.limit = (collectionPath: string, limit: number, query: FIRQue
   return firebase.firestore._getQuery(collectionPath, query);
 };
 
+firebase.firestore.startAt = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
+  query = query.queryStartingAtDocument(document.ios);
+  return firebase.firestore._getQuery(collectionPath, query);
+}
+
+firebase.firestore.startAfter = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
+  query = query.queryStartingAfterDocument(document.ios);
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
+firebase.firestore.endAt = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
+  query = query.queryEndingAtDocument(document.ios);
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
+firebase.firestore.endBefore = (collectionPath: string, document: DocumentSnapshot, query: FIRQuery) => {
+  query = query.queryEndingBeforeDocument(document.ios);
+  return firebase.firestore._getQuery(collectionPath, query);
+};
+
 // see https://developer.apple.com/reference/usernotifications/unusernotificationcenterdelegate?language=objc
 class UNUserNotificationCenterDelegateImpl extends NSObject implements UNUserNotificationCenterDelegate {
   public static ObjCProtocols = [];
diff --git a/src/package.json b/src/package.json
@@ -45,6 +45,7 @@
     "demo.android": "npm run preparedemo && cd ../demo && rimraf platforms/android && tns run android",
     "demo.android.linked": "npm run tsc && cd ../demo && tns run android --syncAllFiles",
     "demo-ng.android": "npm run preparedemo-ng && cd ../demo-ng && tns run android",
+    "demo-ng.android.bundled": "npm run preparedemo-ng && cd ../demo-ng && tns run android --bundle",
     "test": "npm run tslint && npm run tslint.demo && cd ../demo && tns build ios && tns build android",
     "test.ios": "cd ../demo && tns test ios --emulator",
     "test.ios.device": "cd ../demo && tns platform remove ios && tns test ios",

Original file line number	Diff line number	Diff line change
`@@ -26,4 +26,4 @@`
`26`	`26`	`"node_modules",`
`27`	`27`	`"platforms"`
`28`	`28`	`]`
`29`		`-}`
	`29`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ export const firebase: any = {`
`215`	`215`	`}`
`216`	`216`	`};`
`217`	`217`
`218`		`-export class DocumentSnapshot implements firestore.DocumentSnapshot {`
	`218`	`+export abstract class DocumentSnapshot implements firestore.DocumentSnapshot {`
`219`	`219`	`public data: () => firestore.DocumentData;`
`220`	`220`	`constructor(public id: string, public exists: boolean, documentData: firestore.DocumentData) {`
`221`	`221`	`this.data = () => exists ? documentData : undefined;`