appservice: Move msc2409 types from push_events to push_events::v1

… for consistency with other types.

crates/ruma-appservice-api/src/event/push_events.rs

@@ -2,219 +2,36 @@
 //!
 //! Endpoint to push an event (or batch of events) to the application service.
 
-#[cfg(feature = "unstable-msc2409")]
-use js_int::UInt;
-#[cfg(feature = "unstable-msc2409")]
-use ruma_common::{
-    events::receipt::Receipt, presence::PresenceState, serde::from_raw_json_value, OwnedEventId,
-    OwnedRoomId, OwnedUserId,
-};
-#[cfg(feature = "unstable-msc2409")]
-use serde::{de, Deserialize, Serialize};
-#[cfg(feature = "unstable-msc2409")]
-use serde_json::{value::RawValue as RawJsonValue, Value as JsonValue};
-#[cfg(feature = "unstable-msc2409")]
-use std::collections::BTreeMap;
-
-/// Type for passing ephemeral data to homeservers.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Serialize)]
-#[non_exhaustive]
-pub enum Edu {
-    /// An EDU representing presence updates for users of the sending homeserver.
-    Presence(PresenceContent),
-
-    /// An EDU representing receipt updates for users of the sending homeserver.
-    Receipt(ReceiptContent),
-
-    /// A typing notification EDU for a user in a room.
-    Typing(TypingContent),
-
-    #[doc(hidden)]
-    #[serde(skip)]
-    _Custom(JsonValue),
-}
-
-#[derive(Debug, Deserialize)]
-#[cfg(feature = "unstable-msc2409")]
-struct EduDeHelper {
-    /// The message type field
-    r#type: String,
-    content: Box<RawJsonValue>,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl<'de> Deserialize<'de> for Edu {
-    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
-    where
-        D: de::Deserializer<'de>,
-    {
-        let json = Box::<RawJsonValue>::deserialize(deserializer)?;
-        let EduDeHelper { r#type, content } = from_raw_json_value(&json)?;
-
-        Ok(match r#type.as_ref() {
-            "m.presence" => Self::Presence(from_raw_json_value(&content)?),
-            "m.receipt" => Self::Receipt(from_raw_json_value(&content)?),
-            "m.typing" => Self::Typing(from_raw_json_value(&content)?),
-            _ => Self::_Custom(from_raw_json_value(&content)?),
-        })
-    }
-}
-
-/// The content for "m.presence" Edu.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-pub struct PresenceContent {
-    /// A list of presence updates that the receiving server is likely to be interested in.
-    pub push: Vec<PresenceUpdate>,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl PresenceContent {
-    /// Creates a new `PresenceContent`.
-    pub fn new(push: Vec<PresenceUpdate>) -> Self {
-        Self { push }
-    }
-}
-
-/// An update to the presence of a user.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-pub struct PresenceUpdate {
-    /// The user ID this presence EDU is for.
-    pub user_id: OwnedUserId,
-
-    /// The presence of the user.
-    pub presence: PresenceState,
-
-    /// An optional description to accompany the presence.
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub status_msg: Option<String>,
-
-    /// The number of milliseconds that have elapsed since the user last did something.
-    pub last_active_ago: UInt,
-
-    /// Whether or not the user is currently active.
-    ///
-    /// Defaults to false.
-    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
-    pub currently_active: bool,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl PresenceUpdate {
-    /// Creates a new `PresenceUpdate` with the given `user_id`, `presence` and `last_activity`.
-    pub fn new(user_id: OwnedUserId, presence: PresenceState, last_activity: UInt) -> Self {
-        Self {
-            user_id,
-            presence,
-            last_active_ago: last_activity,
-            status_msg: None,
-            currently_active: false,
-        }
-    }
-}
-
-/// The content for "m.receipt" Edu.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-#[serde(transparent)]
-pub struct ReceiptContent(pub BTreeMap<OwnedRoomId, ReceiptMap>);
-
-#[cfg(feature = "unstable-msc2409")]
-impl ReceiptContent {
-    /// Creates a new `ReceiptContent`.
-    pub fn new(receipts: BTreeMap<OwnedRoomId, ReceiptMap>) -> Self {
-        Self(receipts)
-    }
-}
-
-/// Mapping between user and `ReceiptData`.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-pub struct ReceiptMap {
-    /// Read receipts for users in the room.
-    #[serde(rename = "m.read")]
-    pub read: BTreeMap<OwnedUserId, ReceiptData>,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl ReceiptMap {
-    /// Creates a new `ReceiptMap`.
-    pub fn new(read: BTreeMap<OwnedUserId, ReceiptData>) -> Self {
-        Self { read }
-    }
-}
-
-/// Metadata about the event that was last read and when.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-pub struct ReceiptData {
-    /// Metadata for the read receipt.
-    pub data: Receipt,
-
-    /// The extremity event ID the user has read up to.
-    pub event_ids: Vec<OwnedEventId>,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl ReceiptData {
-    /// Creates a new `ReceiptData`.
-    pub fn new(data: Receipt, event_ids: Vec<OwnedEventId>) -> Self {
-        Self { data, event_ids }
-    }
-}
-
-/// The content for "m.typing" Edu.
-#[cfg(feature = "unstable-msc2409")]
-#[derive(Clone, Debug, Deserialize, Serialize)]
-#[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
-pub struct TypingContent {
-    /// The room where the user's typing status has been updated.
-    pub room_id: OwnedRoomId,
-
-    /// The user ID that has had their typing status changed.
-    pub user_id: OwnedUserId,
-
-    /// Whether the user is typing in the room or not.
-    pub typing: bool,
-}
-
-#[cfg(feature = "unstable-msc2409")]
-impl TypingContent {
-    /// Creates a new `TypingContent`.
-    pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId, typing: bool) -> Self {
-        Self { room_id, user_id, typing }
-    }
-}
-
 pub mod v1 {
     //! `/v1/` ([spec])
     //!
     //! [spec]: https://spec.matrix.org/v1.4/application-service-api/#put_matrixappv1transactionstxnid
 
-    #[cfg(feature = "unstable-msc2409")]
+    #[cfg(any(feature = "unstable-msc2409", feature = "unstable-msc3202"))]
-    use super::Edu;
+    use std::collections::BTreeMap;
+
+    #[cfg(any(feature = "unstable-msc2409", feature = "unstable-msc3202"))]
+    use js_int::UInt;
     #[cfg(feature = "unstable-msc2409")]
     use ruma_common::events::AnyToDeviceEvent;
-
+    #[cfg(any(feature = "unstable-msc2409", feature = "unstable-msc3202"))]
+    use ruma_common::OwnedUserId;
     use ruma_common::{
         api::ruma_api, events::AnyTimelineEvent, serde::Raw, OwnedTransactionId, TransactionId,
     };
-
+    #[cfg(feature = "unstable-msc2409")]
-    #[cfg(feature = "unstable-msc3202")]
+    use ruma_common::{
-    use js_int::UInt;
+        events::receipt::Receipt, presence::PresenceState, serde::from_raw_json_value,
-    #[cfg(feature = "unstable-msc3202")]
+        OwnedEventId, OwnedRoomId,
-    use ruma_common::{DeviceKeyAlgorithm, OwnedDeviceId, OwnedUserId};
+    };
     #[cfg(feature = "unstable-msc3202")]
+    use ruma_common::{DeviceKeyAlgorithm, OwnedDeviceId};
+    #[cfg(feature = "unstable-msc2409")]
+    use serde::Deserializer;
+    #[cfg(any(feature = "unstable-msc2409", feature = "unstable-msc3202"))]
     use serde::{Deserialize, Serialize};
-    #[cfg(feature = "unstable-msc3202")]
+    #[cfg(feature = "unstable-msc2409")]
-    use std::collections::BTreeMap;
+    use serde_json::{value::RawValue as RawJsonValue, Value as JsonValue};
 
     ruma_api! {
         metadata: {
@@ -366,6 +183,183 @@ pub mod v1 {
         }
     }
 
+    /// Type for passing ephemeral data to homeservers.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Serialize)]
+    #[non_exhaustive]
+    pub enum Edu {
+        /// An EDU representing presence updates for users of the sending homeserver.
+        Presence(PresenceContent),
+
+        /// An EDU representing receipt updates for users of the sending homeserver.
+        Receipt(ReceiptContent),
+
+        /// A typing notification EDU for a user in a room.
+        Typing(TypingContent),
+
+        #[doc(hidden)]
+        #[serde(skip)]
+        _Custom(JsonValue),
+    }
+
+    #[derive(Debug, Deserialize)]
+    #[cfg(feature = "unstable-msc2409")]
+    struct EduDeHelper {
+        /// The message type field
+        r#type: String,
+        content: Box<RawJsonValue>,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl<'de> Deserialize<'de> for Edu {
+        fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+        where
+            D: Deserializer<'de>,
+        {
+            let json = Box::<RawJsonValue>::deserialize(deserializer)?;
+            let EduDeHelper { r#type, content } = from_raw_json_value(&json)?;
+
+            Ok(match r#type.as_ref() {
+                "m.presence" => Self::Presence(from_raw_json_value(&content)?),
+                "m.receipt" => Self::Receipt(from_raw_json_value(&content)?),
+                "m.typing" => Self::Typing(from_raw_json_value(&content)?),
+                _ => Self::_Custom(from_raw_json_value(&content)?),
+            })
+        }
+    }
+
+    /// The content for "m.presence" Edu.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    pub struct PresenceContent {
+        /// A list of presence updates that the receiving server is likely to be interested in.
+        pub push: Vec<PresenceUpdate>,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl PresenceContent {
+        /// Creates a new `PresenceContent`.
+        pub fn new(push: Vec<PresenceUpdate>) -> Self {
+            Self { push }
+        }
+    }
+
+    /// An update to the presence of a user.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    pub struct PresenceUpdate {
+        /// The user ID this presence EDU is for.
+        pub user_id: OwnedUserId,
+
+        /// The presence of the user.
+        pub presence: PresenceState,
+
+        /// An optional description to accompany the presence.
+        #[serde(skip_serializing_if = "Option::is_none")]
+        pub status_msg: Option<String>,
+
+        /// The number of milliseconds that have elapsed since the user last did something.
+        pub last_active_ago: UInt,
+
+        /// Whether or not the user is currently active.
+        ///
+        /// Defaults to false.
+        #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
+        pub currently_active: bool,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl PresenceUpdate {
+        /// Creates a new `PresenceUpdate` with the given `user_id`, `presence` and `last_activity`.
+        pub fn new(user_id: OwnedUserId, presence: PresenceState, last_activity: UInt) -> Self {
+            Self {
+                user_id,
+                presence,
+                last_active_ago: last_activity,
+                status_msg: None,
+                currently_active: false,
+            }
+        }
+    }
+
+    /// The content for "m.receipt" Edu.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    #[serde(transparent)]
+    pub struct ReceiptContent(pub BTreeMap<OwnedRoomId, ReceiptMap>);
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl ReceiptContent {
+        /// Creates a new `ReceiptContent`.
+        pub fn new(receipts: BTreeMap<OwnedRoomId, ReceiptMap>) -> Self {
+            Self(receipts)
+        }
+    }
+
+    /// Mapping between user and `ReceiptData`.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    pub struct ReceiptMap {
+        /// Read receipts for users in the room.
+        #[serde(rename = "m.read")]
+        pub read: BTreeMap<OwnedUserId, ReceiptData>,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl ReceiptMap {
+        /// Creates a new `ReceiptMap`.
+        pub fn new(read: BTreeMap<OwnedUserId, ReceiptData>) -> Self {
+            Self { read }
+        }
+    }
+
+    /// Metadata about the event that was last read and when.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    pub struct ReceiptData {
+        /// Metadata for the read receipt.
+        pub data: Receipt,
+
+        /// The extremity event ID the user has read up to.
+        pub event_ids: Vec<OwnedEventId>,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl ReceiptData {
+        /// Creates a new `ReceiptData`.
+        pub fn new(data: Receipt, event_ids: Vec<OwnedEventId>) -> Self {
+            Self { data, event_ids }
+        }
+    }
+
+    /// The content for "m.typing" Edu.
+    #[cfg(feature = "unstable-msc2409")]
+    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[cfg_attr(not(feature = "unstable-exhaustive-types"), non_exhaustive)]
+    pub struct TypingContent {
+        /// The room where the user's typing status has been updated.
+        pub room_id: OwnedRoomId,
+
+        /// The user ID that has had their typing status changed.
+        pub user_id: OwnedUserId,
+
+        /// Whether the user is typing in the room or not.
+        pub typing: bool,
+    }
+
+    #[cfg(feature = "unstable-msc2409")]
+    impl TypingContent {
+        /// Creates a new `TypingContent`.
+        pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId, typing: bool) -> Self {
+            Self { room_id, user_id, typing }
+        }
+    }
+
     #[cfg(feature = "server")]
     #[cfg(test)]
     mod tests {