crates/apub/src/protocol/objects/instance.rs

   1 use crate::{
   2   objects::instance::ApubSite,
   3   protocol::{ImageObject, Source},
   4 };
   5 use activitypub_federation::{
   6   core::{object_id::ObjectId, signatures::PublicKey},
   7   deser::{helpers::deserialize_skip_error, values::MediaTypeHtml},
   8 };
   9 use chrono::{DateTime, FixedOffset};
  10 use serde::{Deserialize, Serialize};
  11 use serde_with::skip_serializing_none;
  12 use url::Url;
  13
  14 #[derive(Clone, Copy, Debug, Deserialize, Serialize, PartialEq, Eq)]
  15 pub enum InstanceType {
  16   Application,
  17   Service,
  18 }
  19
  20 #[skip_serializing_none]
  21 #[derive(Clone, Debug, Deserialize, Serialize)]
  22 #[serde(rename_all = "camelCase")]
  23 pub struct Instance {
  24   #[serde(rename = "type")]
  25   pub(crate) kind: InstanceType,
  26   pub(crate) id: ObjectId<ApubSite>,
  27   // site name
  28   pub(crate) name: String,
  29   pub(crate) inbox: Url,
  30   /// mandatory field in activitypub, lemmy currently serves an empty outbox
  31   pub(crate) outbox: Url,
  32   pub(crate) public_key: PublicKey,
  33
  34   // sidebar
  35   pub(crate) content: Option<String>,
  36   #[serde(deserialize_with = "deserialize_skip_error", default)]
  37   pub(crate) source: Option<Source>,
  38   // short instance description
  39   pub(crate) summary: Option<String>,
  40   pub(crate) media_type: Option<MediaTypeHtml>,
  41   /// instance icon
  42   pub(crate) icon: Option<ImageObject>,
  43   /// instance banner
  44   pub(crate) image: Option<ImageObject>,
  45   pub(crate) published: DateTime<FixedOffset>,
  46   pub(crate) updated: Option<DateTime<FixedOffset>>,
  47 }