Android AggregateQuery support

Author: Daeda88

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

@@ -12,6 +12,12 @@ import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.android
 import dev.gitlive.firebase.firestore.internal.NativeDocumentSnapshotWrapper
 import java.util.concurrent.Executor
+import com.google.firebase.firestore.AggregateField as AndroidAggregateField
+import com.google.firebase.firestore.AggregateField.AverageAggregateField as AndroidAverageAggregateField
+import com.google.firebase.firestore.AggregateField.CountAggregateField as AndroidCountAggregateField
+import com.google.firebase.firestore.AggregateField.SumAggregateField as AndroidSumAggregateField
+import com.google.firebase.firestore.AggregateQuery as AndroidAggregateQuery
+import com.google.firebase.firestore.AggregateQuerySnapshot as AndroidAggregateQuerySnapshot
 import com.google.firebase.firestore.CollectionReference as AndroidCollectionReference
 import com.google.firebase.firestore.DocumentChange as AndroidDocumentChange
 import com.google.firebase.firestore.DocumentReference as AndroidDocumentReference
@@ -124,6 +130,15 @@ internal actual typealias NativeQuery = AndroidQuery
 public operator fun Query.Companion.invoke(android: AndroidQuery): Query = Query(android)
 public val Query.android: AndroidQuery get() = native
 
+internal actual typealias NativeAggregateQuery = AndroidAggregateQuery
+internal actual typealias NativeAggregateQuerySnapshot = AndroidAggregateQuerySnapshot
+
+public operator fun AggregateQuery.Companion.invoke(android: AndroidQuery): AggregateQuery = AggregateQuery(android)
+public val AggregateQuery.android: AndroidAggregateQuery get() = native
+
+public operator fun AggregateQuerySnapshot.Companion.invoke(android: AndroidAggregateQuerySnapshot): AggregateQuerySnapshot = AggregateQuerySnapshot(android)
+public val AggregateQuerySnapshot.android: AndroidAggregateQuerySnapshot get() = native
+
 public actual typealias Direction = AndroidQuery.Direction
 public actual typealias ChangeType = AndroidDocumentChange.Type
 
@@ -198,3 +213,26 @@ public actual class FieldPath private constructor(internal val android: AndroidF
 public actual typealias EncodedFieldPath = AndroidFieldPath
 
 internal typealias NativeSource = AndroidSource
+
+public actual sealed class AggregateField {
+
+    public abstract val android: AndroidAggregateField
+
+    public actual companion object {
+        public actual fun average(field: String): Average = Average(AndroidAggregateField.average(field))
+        public actual fun average(fieldPath: FieldPath): Average = Average(AndroidAggregateField.average(fieldPath.android))
+        public actual fun count(): Count = Count
+        public actual fun sum(field: String): Sum = Sum(AndroidAggregateField.sum(field))
+        public actual fun sum(fieldPath: FieldPath): Sum = Sum(AndroidAggregateField.sum(fieldPath.android))
+    }
+
+    public actual data object Count : AggregateField() {
+        override val android: AndroidCountAggregateField get() = AndroidAggregateField.count()
+    }
+    public actual data class Average(
+        override val android: AndroidAverageAggregateField
+    ) : AggregateField()
+    public actual data class Sum(
+        override val android: AndroidSumAggregateField
+    ) : AggregateField()
+}

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

@@ -0,0 +1,28 @@
+package dev.gitlive.firebase.firestore.internal
+
+import dev.gitlive.firebase.firestore.AggregateField
+import dev.gitlive.firebase.firestore.AggregateSource
+import dev.gitlive.firebase.firestore.NativeAggregateQuery
+import dev.gitlive.firebase.firestore.NativeAggregateQuerySnapshot
+import dev.gitlive.firebase.firestore.NativeQuery
+import kotlinx.coroutines.tasks.await
+
+internal actual class NativeAggregateQueryWrapper actual constructor(actual val native: NativeAggregateQuery) {
+
+    actual val query: NativeQuery get() = native.query
+
+    actual suspend fun get(source: AggregateSource): NativeAggregateQuerySnapshot = native.get(when (source) {
+        AggregateSource.SERVER -> com.google.firebase.firestore.AggregateSource.SERVER
+    }).await()
+}
+
+internal actual class NativeAggregateQuerySnapshotWrapper actual constructor(actual val native: NativeAggregateQuerySnapshot) {
+    actual val query: NativeAggregateQuery get() = native.query
+    actual val count: Long get() = native.count
+
+    actual operator fun get(aggregateField: AggregateField): Number? = native.get(aggregateField.android) as? Number
+    actual operator fun get(averageAggregateField: AggregateField.Average): Double? = native.get(averageAggregateField.android)
+    actual operator fun get(countAggregateField: AggregateField.Count): Long = native.get(countAggregateField.android)
+    actual fun getDouble(aggregateField: AggregateField): Double? = native.getDouble(aggregateField.android)
+    actual fun getLong(aggregateField: AggregateField): Long? = native.getLong(aggregateField.android)
+}

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

@@ -4,9 +4,11 @@ import com.google.android.gms.tasks.TaskExecutors
 import com.google.firebase.firestore.FieldPath
 import com.google.firebase.firestore.MetadataChanges
 import com.google.firebase.firestore.Query
+import dev.gitlive.firebase.firestore.AggregateField
 import dev.gitlive.firebase.firestore.Direction
 import dev.gitlive.firebase.firestore.EncodedFieldPath
 import dev.gitlive.firebase.firestore.Filter
+import dev.gitlive.firebase.firestore.NativeAggregateQuery
 import dev.gitlive.firebase.firestore.NativeDocumentSnapshot
 import dev.gitlive.firebase.firestore.QuerySnapshot
 import dev.gitlive.firebase.firestore.Source
@@ -19,6 +21,7 @@ import kotlinx.coroutines.tasks.await
 internal actual open class NativeQueryWrapper internal actual constructor(actual open val native: Query) {
 
     actual fun limit(limit: Number) = native.limit(limit.toLong())
+    actual fun limitToLast(limit: Number) = native.limitToLast(limit.toLong())
 
     actual val snapshots get() = callbackFlow {
         val listener = native.addSnapshotListener { snapshot, exception ->
@@ -137,4 +140,7 @@ internal actual open class NativeQueryWrapper internal actual constructor(actual
             }
         awaitClose { registration.remove() }
     }
+
+    actual fun count(): NativeAggregateQuery = native.count()
+    actual fun aggregate(aggregateField: AggregateField, vararg aggregateFields: AggregateField) = native.aggregate(aggregateField.android, *aggregateFields.map { it.android }.toTypedArray())
 }

firebase-firestore/src/appleMain/kotlin/dev/gitlive/firebase/firestore/internal/NativeQueryWrapper.kt

@@ -18,6 +18,7 @@ import platform.Foundation.NSNull
 internal actual open class NativeQueryWrapper internal actual constructor(actual open val native: NativeQuery) {
 
     actual fun limit(limit: Number) = native.queryLimitedTo(limit.toLong())
+    actual fun limitToLast(limit: Number) = native.queryLimitedToLast(limit.toLong())
 
     actual suspend fun get(source: Source) = QuerySnapshot(awaitResult { native.getDocumentsWithSource(source.toIosSource(), it) })
 

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

@@ -10,6 +10,8 @@ import dev.gitlive.firebase.internal.EncodedObject
 import dev.gitlive.firebase.Firebase
 import dev.gitlive.firebase.FirebaseApp
 import dev.gitlive.firebase.FirebaseException
+import dev.gitlive.firebase.firestore.internal.NativeAggregateQuerySnapshotWrapper
+import dev.gitlive.firebase.firestore.internal.NativeAggregateQueryWrapper
 import dev.gitlive.firebase.firestore.internal.NativeCollectionReferenceWrapper
 import dev.gitlive.firebase.firestore.internal.NativeDocumentReference
 import dev.gitlive.firebase.firestore.internal.NativeDocumentSnapshotWrapper
@@ -247,6 +249,7 @@ public open class Query internal constructor(internal val nativeQuery: NativeQue
     internal open val native: NativeQuery = nativeQuery.native
 
     public fun limit(limit: Number): Query = Query(nativeQuery.limit(limit))
+    public fun limitToLast(limit: Number): Query = Query(nativeQuery.limitToLast(limit))
     public val snapshots: Flow<QuerySnapshot> = nativeQuery.snapshots
     public fun snapshots(includeMetadataChanges: Boolean = false): Flow<QuerySnapshot> = nativeQuery.snapshots(includeMetadataChanges)
     public suspend fun get(source: Source = Source.DEFAULT): QuerySnapshot = nativeQuery.get(source)
@@ -340,6 +343,10 @@ public open class Query internal constructor(internal val nativeQuery: NativeQue
      * @param builder closure for configuring the [FieldValuesDSL]
      */
     public fun endAtFieldValues(builder: FieldValuesDSL.() -> Unit): Query = Query(nativeQuery.endAt(*FieldValuesDSL().apply(builder).fieldValues.toTypedArray()))
+
+    public fun aggregate(aggregateField: AggregateField, vararg  aggregateFields: AggregateField): AggregateQuery = AggregateQuery(
+        nativeQuery.aggregate(aggregateField, *aggregateFields)
+    )
 }
 
 @Deprecated("Deprecated in favor of using a [FilterBuilder]", replaceWith = ReplaceWith("where { field equalTo equalTo }", "dev.gitlive.firebase.firestore"))
@@ -394,6 +401,39 @@ public fun Query.where(path: FieldPath, inArray: List<Any>? = null, arrayContain
     )
 }
 
+internal expect class NativeAggregateQuery
+internal expect class NativeAggregateQuerySnapshot
+
+public class AggregateQuery internal constructor(internal val nativeQuery: NativeAggregateQueryWrapper) {
+
+    public companion object {}
+
+    public val query: Query get() = Query(nativeQuery.query)
+    internal val native = nativeQuery.native
+
+    internal constructor(native: NativeAggregateQuery) : this(NativeAggregateQueryWrapper(native))
+
+    public suspend fun get(source: AggregateSource = AggregateSource.SERVER): AggregateQuerySnapshot = AggregateQuerySnapshot(nativeQuery.get(source))
+
+}
+
+public class AggregateQuerySnapshot internal constructor(internal val nativeSnapshot: NativeAggregateQuerySnapshotWrapper) {
+
+    public companion object {}
+
+    public val query: AggregateQuery get() = AggregateQuery(nativeSnapshot.query)
+    internal val native = nativeSnapshot.native
+    public val count: Long get() = nativeSnapshot.count
+
+    internal constructor(native: NativeAggregateQuerySnapshot) : this(NativeAggregateQuerySnapshotWrapper(native))
+
+    public operator fun get(aggregateField: AggregateField): Number? = nativeSnapshot[aggregateField]
+    public operator fun get(averageAggregateField: AggregateField.Average): Double? = nativeSnapshot[averageAggregateField]
+    public operator fun get(countAggregateField: AggregateField.Count): Long = nativeSnapshot[countAggregateField]
+    public fun getDouble(aggregateField: AggregateField): Double? = nativeSnapshot.getDouble(aggregateField)
+    public fun getLong(aggregateField: AggregateField): Long? = nativeSnapshot.getLong(aggregateField)
+}
+
 internal expect class NativeWriteBatch
 
 public data class WriteBatch internal constructor(internal val nativeWrapper: NativeWriteBatchWrapper) {
@@ -827,3 +867,23 @@ public enum class Source {
     SERVER,
     DEFAULT,
 }
+
+public enum class AggregateSource {
+    SERVER
+}
+
+public expect sealed class AggregateField {
+
+    public companion object {
+        public fun average(field: String): Average
+        public fun average(fieldPath: FieldPath): Average
+        public fun count(): Count
+        public fun sum(field: String): Sum
+        public fun sum(fieldPath: FieldPath): Sum
+    }
+
+    public object Count : AggregateField
+    public class Average : AggregateField
+    public class Sum : AggregateField
+
+}

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

@@ -0,0 +1,28 @@
+package dev.gitlive.firebase.firestore.internal
+
+import dev.gitlive.firebase.firestore.AggregateField
+import dev.gitlive.firebase.firestore.AggregateSource
+import dev.gitlive.firebase.firestore.NativeAggregateQuery
+import dev.gitlive.firebase.firestore.NativeAggregateQuerySnapshot
+import dev.gitlive.firebase.firestore.NativeQuery
+
+internal expect class NativeAggregateQueryWrapper(native: NativeAggregateQuery) {
+
+    val native: NativeAggregateQuery
+    val query: NativeQuery
+
+    suspend fun get(source: AggregateSource = AggregateSource.SERVER): NativeAggregateQuerySnapshot
+
+}
+
+internal expect class NativeAggregateQuerySnapshotWrapper(native: NativeAggregateQuerySnapshot) {
+    val native: NativeAggregateQuerySnapshot
+    val query: NativeAggregateQuery
+    val count: Long
+
+    operator fun get(aggregateField: AggregateField): Number?
+    operator fun get(averageAggregateField: AggregateField.Average): Double?
+    operator fun get(countAggregateField: AggregateField.Count): Long
+    fun getDouble(aggregateField: AggregateField): Double?
+    fun getLong(aggregateField: AggregateField): Long?
+}

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

@@ -1,8 +1,10 @@
 package dev.gitlive.firebase.firestore.internal
 
+import dev.gitlive.firebase.firestore.AggregateField
 import dev.gitlive.firebase.firestore.Direction
 import dev.gitlive.firebase.firestore.EncodedFieldPath
 import dev.gitlive.firebase.firestore.Filter
+import dev.gitlive.firebase.firestore.NativeAggregateQuery
 import dev.gitlive.firebase.firestore.NativeDocumentSnapshot
 import dev.gitlive.firebase.firestore.NativeQuery
 import dev.gitlive.firebase.firestore.QuerySnapshot
@@ -14,6 +16,7 @@ internal expect open class NativeQueryWrapper internal constructor(native: Nativ
     open val native: NativeQuery
 
     fun limit(limit: Number): NativeQuery
+    fun limitToLast(limit: Number): NativeQuery
     val snapshots: Flow<QuerySnapshot>
     fun snapshots(includeMetadataChanges: Boolean = false): Flow<QuerySnapshot>
     suspend fun get(source: Source = Source.DEFAULT): QuerySnapshot
@@ -32,4 +35,7 @@ internal expect open class NativeQueryWrapper internal constructor(native: Nativ
     fun endBefore(vararg fieldValues: Any): NativeQuery
     fun endAt(document: NativeDocumentSnapshot): NativeQuery
     fun endAt(vararg fieldValues: Any): NativeQuery
+
+    fun count(): NativeAggregateQuery
+    fun aggregate(aggregateField: AggregateField, vararg  aggregateFields: AggregateField): NativeAggregateQuery
 }

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

@@ -88,6 +88,7 @@ public external fun increment(n: Int): FieldValue
 public external fun initializeFirestore(app: FirebaseApp, settings: dynamic = definedExternally, databaseId: String? = definedExternally): Firestore
 
 public external fun limit(limit: Number): QueryConstraint
+public external fun limitToLast(limit: Number): QueryConstraint
 
 public external fun onSnapshot(
     reference: DocumentReference,

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

@@ -38,6 +38,11 @@ internal actual open class NativeQueryWrapper internal actual constructor(actual
         dev.gitlive.firebase.firestore.externals.limit(limit),
     ).wrapped
 
+    actual fun limitToLast(limit: Number) = query(
+        js,
+        dev.gitlive.firebase.firestore.externals.limitToLast(limit)
+    ).wrapped
+
     actual fun where(filter: Filter) = query(js, filter.toQueryConstraint()).wrapped
 
     private fun Filter.toQueryConstraint(): QueryConstraint = when (this) {