Add Firestore Metadata (#106)

Author: Daeda88

firebase-common/src/jsMain/kotlin/dev/gitlive/firebase/externals.kt

@@ -366,16 +366,23 @@ external object firebase {
         open class QuerySnapshot {
             val docs: Array<DocumentSnapshot>
             val empty: Boolean
+            val metadata: SnapshotMetadata
         }
 
         open class DocumentSnapshot {
             val id: String
             val ref: DocumentReference
             val exists: Boolean
+            val metadata: SnapshotMetadata
             fun data(options: Any? = definedExternally): Any?
             fun get(fieldPath: Any, options: Any? = definedExternally): Any?
         }
 
+        open class SnapshotMetadata {
+            val hasPendingWrites: Boolean
+            val fromCache: Boolean
+        }
+
         open class DocumentReference {
             val id: String
             val path: String

firebase-firestore/src/androidMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt

@@ -335,6 +335,7 @@ actual typealias FirestoreExceptionCode = com.google.firebase.firestore.Firebase
 actual class QuerySnapshot(val android: com.google.firebase.firestore.QuerySnapshot) {
     actual val documents
         get() = android.documents.map { DocumentSnapshot(it) }
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(android.metadata)
 }
 
 @Suppress("UNCHECKED_CAST")
@@ -355,6 +356,13 @@ actual class DocumentSnapshot(val android: com.google.firebase.firestore.Documen
     actual fun contains(field: String) = android.contains(field)
 
     actual val exists get() = android.exists()
+
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(android.metadata)
+}
+
+actual class SnapshotMetadata(val android: com.google.firebase.firestore.SnapshotMetadata) {
+    actual val hasPendingWrites: Boolean get() = android.hasPendingWrites()
+    actual val isFromCache: Boolean get() = android.isFromCache()
 }
 
 actual typealias FieldPath = com.google.firebase.firestore.FieldPath

firebase-firestore/src/commonMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt

@@ -147,6 +147,7 @@ expect enum class FirestoreExceptionCode {
 
 expect class QuerySnapshot {
     val documents: List<DocumentSnapshot>
+    val metadata: SnapshotMetadata
 }
 
 expect class DocumentSnapshot {
@@ -162,6 +163,12 @@ expect class DocumentSnapshot {
     val exists: Boolean
     val id: String
     val reference: DocumentReference
+    val metadata: SnapshotMetadata
+}
+
+expect class SnapshotMetadata {
+    val hasPendingWrites: Boolean
+    val isFromCache: Boolean
 }
 
 expect class FieldPath

firebase-firestore/src/iosMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt

@@ -284,6 +284,7 @@ fun NSError.toException() = when(domain) {
 actual class QuerySnapshot(val ios: FIRQuerySnapshot) {
     actual val documents
         get() = ios.documents.map { DocumentSnapshot(it as FIRDocumentSnapshot) }
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(ios.metadata)
 }
 
 @Suppress("UNCHECKED_CAST")
@@ -305,6 +306,13 @@ actual class DocumentSnapshot(val ios: FIRDocumentSnapshot) {
     actual fun contains(field: String) = ios.valueForField(field) != null
 
     actual val exists get() = ios.exists
+
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(ios.metadata)
+}
+
+actual class SnapshotMetadata(val ios: FIRSnapshotMetadata) {
+    actual val hasPendingWrites: Boolean get() = ios.pendingWrites
+    actual val isFromCache: Boolean get() = ios.fromCache
 }
 
 actual typealias FieldPath = FIRFieldPath

firebase-firestore/src/jsMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt

@@ -317,14 +317,15 @@ actual val FirebaseFirestoreException.code: FirestoreExceptionCode get() = code
 actual class QuerySnapshot(val js: firebase.firestore.QuerySnapshot) {
     actual val documents
         get() = js.docs.map { DocumentSnapshot(it) }
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(js.metadata)
 }
 
 actual class DocumentSnapshot(val js: firebase.firestore.DocumentSnapshot) {
 
     actual val id get() = rethrow { js.id }
     actual val reference get() = rethrow { DocumentReference(js.ref) }
 
-    actual inline fun <reified T: Any> data(): T =
+    actual inline fun <reified T : Any> data(): T =
         rethrow { decode<T>(value = js.data()) }
 
     actual fun <T> data(strategy: DeserializationStrategy<T>): T =
@@ -337,7 +338,13 @@ actual class DocumentSnapshot(val js: firebase.firestore.DocumentSnapshot) {
         rethrow { decode(strategy, js.get(field)) }
 
     actual fun contains(field: String) = rethrow { js.get(field) != undefined }
-    actual val exists get() =  rethrow { js.exists }
+    actual val exists get() = rethrow { js.exists }
+    actual val metadata: SnapshotMetadata get() = SnapshotMetadata(js.metadata)
+}
+
+actual class SnapshotMetadata(val js: firebase.firestore.SnapshotMetadata) {
+    actual val hasPendingWrites: Boolean get() = js.hasPendingWrites
+    actual val isFromCache: Boolean get() = js.fromCache
 }
 
 actual typealias FieldPath = Any