Timeline : start reworking timeline apis

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt

@@ -31,7 +31,7 @@ import io.element.android.libraries.matrix.api.poll.PollKind
 import io.element.android.libraries.matrix.api.room.location.AssetType
 import io.element.android.libraries.matrix.api.room.powerlevels.MatrixRoomPowerLevels
 import io.element.android.libraries.matrix.api.room.powerlevels.UserRoleChange
-import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
+import io.element.android.libraries.matrix.api.timeline.LiveTimeline
 import io.element.android.libraries.matrix.api.timeline.ReceiptType
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetDriver
 import io.element.android.libraries.matrix.api.widget.MatrixWidgetSettings
@@ -97,7 +97,7 @@ interface MatrixRoom : Closeable {
 
     val syncUpdateFlow: StateFlow<Long>
 
-    val timeline: MatrixTimeline
+    val liveTimeline: LiveTimeline
 
     fun destroy()
 

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/DetachedTimeline.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.timeline
+
+import kotlinx.coroutines.flow.StateFlow
+
+interface DetachedTimeline : Timeline {
+    suspend fun paginateForwards(): Result<Boolean>
+    val forwardPaginationStatus: StateFlow<Timeline.PaginationStatus>
+}

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/LiveTimeline.kt

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.timeline
+
+import io.element.android.libraries.matrix.api.core.EventId
+import kotlinx.coroutines.flow.Flow
+
+interface LiveTimeline: Timeline {
+    val membershipChangeEventReceived: Flow<Unit>
+    suspend fun sendReadReceipt(eventId: EventId, receiptType: ReceiptType): Result<Unit>
+}

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/MatrixTimeline.kt

@@ -1,48 +0,0 @@
-/*
- * Copyright (c) 2023 New Vector Ltd
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-package io.element.android.libraries.matrix.api.timeline
-
-import io.element.android.libraries.matrix.api.core.EventId
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.StateFlow
-
-interface MatrixTimeline : AutoCloseable {
-    data class PaginationState(
-        val isBackPaginating: Boolean,
-        val hasMoreToLoadBackwards: Boolean,
-        val beginningOfRoomReached: Boolean,
-    ) {
-        val canBackPaginate = !isBackPaginating && hasMoreToLoadBackwards
-
-        companion object {
-            val Initial = PaginationState(
-                isBackPaginating = false,
-                hasMoreToLoadBackwards = true,
-                beginningOfRoomReached = false
-            )
-        }
-    }
-
-    val paginationState: StateFlow<PaginationState>
-    val timelineItems: Flow<List<MatrixTimelineItem>>
-    val membershipChangeEventReceived: Flow<Unit>
-
-    suspend fun paginateBackwards(requestSize: Int): Result<Unit>
-    suspend fun paginateBackwards(requestSize: Int, untilNumberOfItems: Int): Result<Unit>
-    suspend fun fetchDetailsForEvent(eventId: EventId): Result<Unit>
-    suspend fun sendReadReceipt(eventId: EventId, receiptType: ReceiptType): Result<Unit>
-}

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/Timeline.kt

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2024 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.timeline
+
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.StateFlow
+
+interface Timeline : AutoCloseable {
+
+    data class PaginationStatus(
+        val isPaginating: Boolean,
+        val hasMoreToLoad: Boolean,
+    ) {
+        val canPaginate: Boolean = !isPaginating && hasMoreToLoad
+    }
+
+    suspend fun paginateBackwards(): Result<Boolean>
+    val backPaginationStatus: StateFlow<PaginationStatus>
+    val timelineItems: Flow<List<MatrixTimelineItem>>
+}

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/timeline/item/virtual/VirtualTimelineItem.kt

@@ -24,4 +24,11 @@ sealed interface VirtualTimelineItem {
     data object ReadMarker : VirtualTimelineItem
 
     data object EncryptedHistoryBanner : VirtualTimelineItem
+
+    data object RoomBeginning: VirtualTimelineItem
+
+    data class LoadingIndicator(
+        val backwards: Boolean,
+        val timestamp: Long,
+    ): VirtualTimelineItem
 }