Add the ability to save a DocumentReference #875

Author: EddyVerbruggen

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

@@ -133,10 +133,14 @@ export class FirestoreComponent {
   }
 
   public firestoreUpdate(): void {
+    // get a document reference so we can add a city reference to our favourite dog
+    const sfDocRef: firestore.DocumentReference = firebase.firestore().collection("cities").doc("SF");
+
     firebase.firestore().collection("dogs").doc("fave")
         .update({
           name: "Woofieupdate",
           last: "updatedwoofie!",
+          city: sfDocRef,
           updateTs: firestore.FieldValue.serverTimestamp(),
           updateTsAlt: firebase.firestore().FieldValue().serverTimestamp(),
           lastKnownLocation: firebase.firestore().GeoPoint(4.34, 5.67)

src/firebase-common.ts

@@ -222,6 +222,10 @@ export class DocumentSnapshot implements firestore.DocumentSnapshot {
   }
 }
 
+export function isDocumentReference(object: any): object is firestore.DocumentReference {
+  return object && object.discriminator === "docRef";
+}
+
 export class QuerySnapshot implements firestore.QuerySnapshot {
   public docSnapshots: firestore.DocumentSnapshot[];
 

src/firebase.android.ts

@@ -1,4 +1,4 @@
-import { DocumentSnapshot, firebase, GeoPoint, QuerySnapshot } from "./firebase-common";
+import { DocumentSnapshot, 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";
@@ -132,6 +132,8 @@ firebase.toHashMap = obj => {
         } else if (obj[property] instanceof GeoPoint) {
           const geo = <GeoPoint>obj[property];
           node.put(property, new com.google.firebase.firestore.GeoPoint(geo.latitude, geo.longitude));
+        } else if (isDocumentReference(obj[property])) {
+          node.put(property, obj[property].android);
         } else if (Array.isArray(obj[property])) {
           node.put(property, firebase.toJavaArray(obj[property]));
         } else {
@@ -2308,6 +2310,7 @@ firebase.firestore.onCollectionSnapshot = (colRef: com.google.firebase.firestore
 
 firebase.firestore._getDocumentReference = (javaObj, collectionPath, documentPath): firestore.DocumentReference => {
   return {
+    discriminator: "docRef",
     id: javaObj.getId(),
     collection: cp => firebase.firestore.collection(`${collectionPath}/${documentPath}/${cp}`),
     set: (data: any, options?: firestore.SetOptions) => firebase.firestore.set(collectionPath, javaObj.getId(), data, options),
@@ -2350,6 +2353,7 @@ firebase.firestore.add = (collectionPath: string, document: any): Promise<firest
       const onSuccessListener = new com.google.android.gms.tasks.OnSuccessListener({
         onSuccess: (docRef: com.google.firebase.firestore.DocumentReference) => {
           resolve({
+            discriminator: "docRef",
             id: docRef.getId(),
             collection: cp => firebase.firestore.collection(cp),
             set: (data: any, options?: firestore.SetOptions) => firebase.firestore.set(collectionPath, docRef.getId(), data, options),

src/firebase.d.ts

@@ -720,6 +720,7 @@ export namespace firestore {
   }
 
   export interface DocumentReference {
+    discriminator: "docRef";
     id: string;
     collection: (collectionPath: string) => CollectionReference;
     set: (document: any, options?: SetOptions) => Promise<void>;

src/firebase.ios.ts

@@ -1,4 +1,4 @@
-import { firebase, DocumentSnapshot, QuerySnapshot, GeoPoint } from "./firebase-common";
+import { firebase, DocumentSnapshot, 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";
@@ -2260,6 +2260,7 @@ firebase.firestore.onCollectionSnapshot = (colRef: FIRCollectionReference, callb
 
 firebase.firestore._getDocumentReference = (fIRDocumentReference, collectionPath: string, documentPath: string): firestore.DocumentReference => {
   return {
+    discriminator: "docRef",
     id: fIRDocumentReference.documentID,
     collection: cp => firebase.firestore.collection(`${collectionPath}/${documentPath}/${cp}`),
     set: (data: any, options?: firestore.SetOptions) => firebase.firestore.set(collectionPath, fIRDocumentReference.documentID, data, options),
@@ -2303,6 +2304,7 @@ firebase.firestore.add = (collectionPath: string, document: any): Promise<firest
               reject(error.localizedDescription);
             } else {
               resolve({
+                discriminator: "docRef",
                 id: fIRDocumentReference.documentID,
                 collection: cp => firebase.firestore.collection(cp),
                 set: (data: any, options?: firestore.SetOptions) => firebase.firestore.set(collectionPath, fIRDocumentReference.documentID, data, options),
@@ -2372,6 +2374,8 @@ function fixSpecialFields(item) {
           latitude: geo.latitude,
           longitude: geo.longitude
         });
+      } else if (isDocumentReference(item[k])) {
+        item[k] = item[k].ios;
       }
     }
   }