feat(sdk): Add new timeline API

Author: jplatte

Cargo.lock

@@ -23,7 +23,7 @@ futures-signals = { version = "0.3.28" }
 futures-util = { version = "0.3.17", default-features = false }
 # FIXME: we currently can't feature flag anything in the api.udl, therefore we must enforce sliding-sync being exposed here..
 # see https://github.com/matrix-org/matrix-rust-sdk/issues/1014
-matrix-sdk = { path = "../../crates/matrix-sdk", features = ["anyhow", "markdown", "sliding-sync", "socks"], version = "0.6.0" }
+matrix-sdk = { path = "../../crates/matrix-sdk", features = ["anyhow", "experimental-timeline", "markdown", "sliding-sync", "socks"], version = "0.6.0" }
 once_cell = "1.10.0"
 sanitize-filename-reader-friendly = "2.2.1"
 serde = { version = "1", features = ["derive"] }

bindings/matrix-sdk-ffi/Cargo.toml

@@ -42,6 +42,8 @@ appservice = ["ruma/appservice-api-s"]
 image-proc = ["dep:image"]
 image-rayon = ["image-proc", "image?/jpeg_rayon"]
 
+experimental-timeline = []
+
 sliding-sync = [
     "matrix-sdk-base/sliding-sync",
     "anyhow",
@@ -70,6 +72,7 @@ futures-core = "0.3.21"
 futures-signals = { version = "0.3.30", default-features = false }
 futures-util = { version = "0.3.21", default-features = false }
 http = "0.2.6"
+indexmap = "1.9.1"
 matrix-sdk-base = { version = "0.6.0", path = "../matrix-sdk-base", default_features = false }
 matrix-sdk-common = { version = "0.6.0", path = "../matrix-sdk-common" }
 matrix-sdk-indexeddb = { version = "0.2.0", path = "../matrix-sdk-indexeddb", default-features = false, optional = true }
@@ -107,7 +110,7 @@ features = [
 optional = true
 
 [dependencies.ruma]
-version = "0.7.0"
+version = "0.7.4"
 features = ["client-api-c", "compat", "rand", "unstable-msc2448", "unstable-msc2965"]
 
 [target.'cfg(target_arch = "wasm32")'.dependencies]
@@ -120,6 +123,7 @@ tokio = { version = "1.17.0", default-features = false, features = ["fs", "rt"]
 
 [dev-dependencies]
 anyhow = "1.0.57"
+assert_matches = "1.5.0"
 dirs = "4.0.0"
 futures = { version = "0.3.21", default-features = false, features = ["executor"] }
 matches = "0.1.9"

crates/matrix-sdk/Cargo.toml

@@ -37,6 +37,8 @@ use ruma::{
 };
 use serde::de::DeserializeOwned;
 
+#[cfg(feature = "experimental-timeline")]
+use super::timeline::Timeline;
 use crate::{
     event_handler::{EventHandler, EventHandlerHandle, EventHandlerResult, SyncEvent},
     media::{MediaFormat, MediaRequest},
@@ -251,6 +253,16 @@ impl Common {
         self.client.add_room_event_handler(self.room_id(), handler)
     }
 
+    /// Get a [`Timeline`] for this room.
+    ///
+    /// This offers a higher-level API than event handlers, in treating things
+    /// like edits and reactions as updates of existing items rather than new
+    /// independent events.
+    #[cfg(feature = "experimental-timeline")]
+    pub fn timeline(&self) -> Timeline {
+        Timeline::new(self)
+    }
+
     /// Fetch the event with the given `EventId` in this room.
     pub async fn event(&self, event_id: &EventId) -> Result<TimelineEvent> {
         let request = get_room_event::v3::Request::new(self.room_id(), event_id);

crates/matrix-sdk/src/room/common.rs

@@ -9,6 +9,8 @@ mod invited;
 mod joined;
 mod left;
 mod member;
+#[cfg(feature = "experimental-timeline")]
+pub mod timeline;
 
 pub use self::{
     common::{Common, Messages, MessagesOptions},