api!: replace was_seen_recently by freshness in contact object

BREAKING CHANGE: use contact's `freshness` instead of `seen_recently`

deltachat-jsonrpc/src/api/types/chat.rs

@@ -9,6 +9,8 @@ use deltachat::context::Context;
 use serde::{Deserialize, Serialize};
 use typescript_type_def::TypeDef;
 
+use crate::api::types::contact::ContactFreshness;
+
 use super::color_int_to_hex_string;
 
 #[derive(Serialize, TypeDef, schemars::JsonSchema)]
@@ -69,7 +71,7 @@ pub struct FullChat {
     is_muted: bool,
     ephemeral_timer: u32,
     can_send: bool,
-    was_seen_recently: bool,
+    freshness: ContactFreshness,
     mailing_list_address: Option<String>,
 }
 
@@ -92,16 +94,17 @@ impl FullChat {
 
         let can_send = chat.can_send(context).await?;
 
-        let was_seen_recently = if chat.get_type() == Chattype::Single {
+        let freshness = if chat.get_type() == Chattype::Single {
             match contact_ids.first() {
                 Some(contact) => Contact::get_by_id(context, *contact)
                     .await
-                    .context("failed to load contact for was_seen_recently")?
-                    .was_seen_recently(),
-                None => false,
+                    .context("failed to load contact for get_freshness")?
+                    .get_freshness()
+                    .into(),
+                None => ContactFreshness::Normal,
             }
         } else {
-            false
+            ContactFreshness::Normal
         };
 
         let mailing_list_address = chat.get_mailinglist_addr().map(|s| s.to_string());
@@ -126,7 +129,7 @@ impl FullChat {
             is_muted: chat.is_muted(),
             ephemeral_timer,
             can_send,
-            was_seen_recently,
+            freshness,
             mailing_list_address,
         })
     }
@@ -137,7 +140,7 @@ impl FullChat {
 /// - fresh_message_counter
 /// - ephemeral_timer
 /// - self_in_group
-/// - was_seen_recently
+/// - freshness
 /// - can_send
 ///
 /// used when you only need the basic metadata of a chat like type, name, profile picture

deltachat-jsonrpc/src/api/types/chat_list.rs

@@ -11,6 +11,8 @@ use num_traits::cast::ToPrimitive;
 use serde::Serialize;
 use typescript_type_def::TypeDef;
 
+use crate::api::types::contact::ContactFreshness;
+
 use super::chat::JsonrpcChatType;
 use super::color_int_to_hex_string;
 use super::message::MessageViewtype;
@@ -68,7 +70,7 @@ pub enum ChatListItemFetchResult {
         is_contact_request: bool,
         /// contact id if this is a dm chat (for view profile entry in context menu)
         dm_chat_contact: Option<u32>,
-        was_seen_recently: bool,
+        freshness: ContactFreshness,
         last_message_type: Option<MessageViewtype>,
         last_message_id: Option<u32>,
     },
@@ -127,22 +129,20 @@ pub(crate) async fn get_chat_list_item_by_id(
         None => (None, None),
     };
 
-    let (dm_chat_contact, was_seen_recently) = if chat.get_type() == Chattype::Single {
+    let (dm_chat_contact, freshness) = if chat.get_type() == Chattype::Single {
         let chat_contacts = get_chat_contacts(ctx, chat_id).await?;
         let contact = chat_contacts.first();
-        let was_seen_recently = match contact {
+        let freshness = match contact {
             Some(contact) => Contact::get_by_id(ctx, *contact)
                 .await
                 .context("contact")?
-                .was_seen_recently(),
-            None => false,
+                .get_freshness()
+                .into(),
+            None => ContactFreshness::Normal,
         };
-        (
-            contact.map(|contact_id| contact_id.to_u32()),
-            was_seen_recently,
-        )
+        (contact.map(|contact_id| contact_id.to_u32()), freshness)
     } else {
-        (None, false)
+        (None, ContactFreshness::Normal)
     };
 
     let color = color_int_to_hex_string(chat.get_color(ctx).await?);
@@ -170,7 +170,7 @@ pub(crate) async fn get_chat_list_item_by_id(
         is_muted: chat.is_muted(),
         is_contact_request: chat.is_contact_request(),
         dm_chat_contact,
-        was_seen_recently,
+        freshness,
         last_message_type: message_type,
         last_message_id: last_msgid.map(|id| id.to_u32()),
     })

deltachat-jsonrpc/src/api/types/contact.rs

@@ -1,4 +1,5 @@
 use anyhow::Result;
+use deltachat::contact;
 use deltachat::context::Context;
 use deltachat::key::{DcKey, SignedPublicKey};
 use serde::Serialize;
@@ -6,6 +7,27 @@ use typescript_type_def::TypeDef;
 
 use super::color_int_to_hex_string;
 
+/// Freshness of a contact, based on when it was last seen.
+#[derive(Serialize, TypeDef, schemars::JsonSchema)]
+pub enum ContactFreshness {
+    /// Contact shall not be highlighted.
+    Normal,
+    /// Contact was seen recently.
+    RecentlySeen,
+    /// Contact was not seen for a long time.
+    Old,
+}
+
+impl From<contact::Freshness> for ContactFreshness {
+    fn from(freshness: contact::Freshness) -> Self {
+        match freshness {
+            contact::Freshness::Normal => ContactFreshness::Normal,
+            contact::Freshness::RecentlySeen => ContactFreshness::RecentlySeen,
+            contact::Freshness::Old => ContactFreshness::Old,
+        }
+    }
+}
+
 #[derive(Serialize, TypeDef, schemars::JsonSchema)]
 #[serde(rename = "Contact", rename_all = "camelCase")]
 pub struct ContactObject {
@@ -32,7 +54,7 @@ pub struct ContactObject {
 
     /// the contact's last seen timestamp
     last_seen: i64,
-    was_seen_recently: bool,
+    freshness: ContactFreshness,
 
     /// If the contact is a bot.
     is_bot: bool,
@@ -60,7 +82,7 @@ impl ContactObject {
             is_key_contact: contact.is_key_contact(),
             e2ee_avail: contact.e2ee_avail(context).await?,
             last_seen: contact.last_seen(),
-            was_seen_recently: contact.was_seen_recently(),
+            freshness: contact.get_freshness().into(),
             is_bot: contact.is_bot(),
         })
     }