Add support for MSC3983

Co-authored-by: Jonas Platte <jplatte@matrix.org>

crates/ruma-client-api/CHANGELOG.md

@@ -1,5 +1,9 @@
 # [unreleased]
 
+Improvements:
+
+- Add unstable support for MSC3983
+
 # 0.17.1
 
 Improvements:

crates/ruma-client-api/Cargo.toml

@@ -46,6 +46,7 @@ unstable-msc2967 = []
 unstable-msc3488 = []
 unstable-msc3575 = []
 unstable-msc3814 = []
+unstable-msc3983 = []
 
 [dependencies]
 assign = { workspace = true }

crates/ruma-client-api/src/keys/claim_keys.rs

@@ -3,3 +3,5 @@
 //! Claims one-time keys for use in pre-key messages.
 
 pub mod v3;
+#[cfg(feature = "unstable-msc3983")]
+pub mod v4;

crates/ruma-client-api/src/keys/claim_keys/v4.rs

@@ -0,0 +1,69 @@
+//! `/v4/` ([MSC])
+//!
+//! [MSC]: https://github.com/matrix-org/matrix-spec-proposals/pull/3983
+
+use std::{collections::BTreeMap, time::Duration};
+
+use ruma_common::{
+    api::{request, response, Metadata},
+    encryption::OneTimeKey,
+    metadata,
+    serde::Raw,
+    DeviceKeyAlgorithm, OwnedDeviceId, OwnedDeviceKeyId, OwnedUserId,
+};
+use serde_json::Value as JsonValue;
+
+const METADATA: Metadata = metadata! {
+    method: POST,
+    rate_limited: false,
+    authentication: AccessToken,
+    history: {
+        unstable => "/_matrix/client/unstable/org.matrix.msc3983/keys/claim",
+    }
+};
+
+/// Request type for the `claim_keys` endpoint.
+#[request(error = crate::Error)]
+pub struct Request {
+    /// The time (in milliseconds) to wait when downloading keys from remote servers.
+    /// 10 seconds is the recommended default.
+    #[serde(
+        with = "ruma_common::serde::duration::opt_ms",
+        default,
+        skip_serializing_if = "Option::is_none"
+    )]
+    pub timeout: Option<Duration>,
+
+    /// The keys to be claimed.
+    pub one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<DeviceKeyAlgorithm>>>,
+}
+
+/// Response type for the `claim_keys` endpoint.
+#[response(error = crate::Error)]
+pub struct Response {
+    /// If any remote homeservers could not be reached, they are recorded here.
+    /// The names of the properties are the names of the unreachable servers.
+    pub failures: BTreeMap<String, JsonValue>,
+
+    /// One-time keys for the queried devices.
+    pub one_time_keys: BTreeMap<OwnedUserId, OneTimeKeys>,
+}
+
+impl Request {
+    /// Creates a new `Request` with the given key claims and the recommended 10 second timeout.
+    pub fn new(
+        one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Vec<DeviceKeyAlgorithm>>>,
+    ) -> Self {
+        Self { timeout: Some(Duration::from_secs(10)), one_time_keys }
+    }
+}
+
+impl Response {
+    /// Creates a new `Response` with the given keys and no failures.
+    pub fn new(one_time_keys: BTreeMap<OwnedUserId, OneTimeKeys>) -> Self {
+        Self { failures: BTreeMap::new(), one_time_keys }
+    }
+}
+
+/// The one-time keys for a given device.
+pub type OneTimeKeys = BTreeMap<OwnedDeviceId, BTreeMap<OwnedDeviceKeyId, Raw<OneTimeKey>>>;

crates/ruma/Cargo.toml

@@ -213,6 +213,7 @@ unstable-msc3954 = ["ruma-events?/unstable-msc3954"]
 unstable-msc3955 = ["ruma-events?/unstable-msc3955"]
 unstable-msc3956 = ["ruma-events?/unstable-msc3956"]
 unstable-msc3958 = ["ruma-common/unstable-msc3958"]
+unstable-msc3983 = ["ruma-client-api?/unstable-msc3983"]
 unstable-pdu = ["ruma-events?/unstable-pdu"]
 unstable-unspecified = [
     "ruma-common/unstable-unspecified",
@@ -257,6 +258,7 @@ __ci = [
     "unstable-msc3955",
     "unstable-msc3956",
     "unstable-msc3958",
+    "unstable-msc3983",
 ]
 
 [dependencies]