Support Firestore "in" queries #1472

Author: EddyVerbruggen

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

@@ -27,7 +27,7 @@
     <Button text="Stop listening" (tap)="firestoreStopListening()" class="button"></Button>
     <Button text="Where (by reference)" (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="Where array_contains" (tap)="firestoreWhereCityHasALakeAndOrMountain()" 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>

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

@@ -358,24 +358,25 @@ export class FirestoreComponent {
 
   firestoreWhereOrderLimit(): void {
     const query: firestore.Query = firebase.firestore().collection("cities")
-        .where("state", "==", "CA")
+        // .where("state", "==", "CA")
+        .where("state", "in", ["CA", "WA"])
         .where("population", "<", 99999999)
         .orderBy("population", "desc")
-        .limit(2);
+        .limit(4);
 
     query
         .get()
         .then((querySnapshot: firestore.QuerySnapshot) => {
           querySnapshot.forEach(doc => {
-            console.log(`Large Californian city: ${doc.id} => ${JSON.stringify(doc.data())}`);
+            console.log(`Large CA/WA city: ${doc.id} => ${JSON.stringify(doc.data())}`);
           });
         })
         .catch(err => console.log("firestoreWhereOrderLimit failed, error: " + err));
   }
 
-  firestoreWhereCityHasALake(): void {
+  firestoreWhereCityHasALakeAndOrMountain(): void {
     const query: firestore.Query = firebase.firestore().collection("cities")
-        .where("landmarks", "array-contains", "lake");
+        .where("landmarks", "array-contains-any", ["mountain", "lake"]);
 
     query
         .get()

docs/FIRESTORE.md

@@ -236,7 +236,7 @@ sanFranciscoDocument.update({
 ### `collection.where()`
 Firestore supports advanced querying with the `where` function. Those `where` clauses can be chained to form logical 'AND' queries:
 
-You can use the operators defined in `firestore.WhereFilterOp`, which are: `'<' | '<=' | '==' | '>=' | '>' | 'array-contains'`.
+You can use the operators defined in `firestore.WhereFilterOp`, which are: `'<' | '<=' | '==' | '>=' | '>' | 'in' | 'array-contains' | 'array-contains-any'`.
 
 ```typescript
 const citiesCollection = firebase.firestore().collection("cities");

src/firebase.android.ts

@@ -2602,9 +2602,12 @@ firebase.firestore.where = (collectionPath: string, fieldPath: string, opStr: fi
       query = query.whereGreaterThanOrEqualTo(fieldPath, firebase.toValue(value));
     } else if (opStr === ">") {
       query = query.whereGreaterThan(fieldPath, firebase.toValue(value));
+    } else if (opStr === "in") {
+      query = query.whereIn(fieldPath, firebase.toValue(value));
     } else if (opStr === "array-contains") {
-      // TODO remove 'any' when typings have been updated
-      query = (<any>query).whereArrayContains(fieldPath, firebase.toValue(value));
+      query = query.whereArrayContains(fieldPath, firebase.toValue(value));
+    } else if (opStr === "array-contains-any") {
+      query = query.whereArrayContainsAny(fieldPath, firebase.toValue(value));
     } else {
       console.log("Illegal argument for opStr: " + opStr);
       return null;

src/firebase.d.ts

@@ -668,7 +668,7 @@ export namespace dynamicLinks {
 
 export namespace firestore {
   export type DocumentData = { [field: string]: any };
-  export type WhereFilterOp = '<' | '<=' | '==' | '>=' | '>' | 'array-contains';
+  export type WhereFilterOp = '<' | '<=' | '==' | '>=' | '>' | 'in' | 'array-contains'  | 'array-contains-any';
   export type OrderByDirection = 'desc' | 'asc';
 
   export interface GeoPoint {

src/firebase.ios.ts

@@ -2261,6 +2261,10 @@ firebase.firestore.where = (collectionPath: string, fieldPath: string, opStr: fi
       query = query.queryWhereFieldIsGreaterThan(fieldPath, value);
     } else if (opStr === "array-contains") {
       query = query.queryWhereFieldArrayContains(fieldPath, value);
+    } else if (opStr === "array-contains-any") {
+      query = query.queryWhereFieldArrayContainsAny(fieldPath, value);
+    } else if (opStr === "in") {
+      query = query.queryWhereFieldIn(fieldPath, value);
     } else {
       console.log("Illegal argument for opStr: " + opStr);
       return null;