Dessalines 42bd941f35
Upgrading ts-rs, and adding feature flag (#5777)
* Upgrading ts-rs, and adding feature flag.

- Lets us remove all the ts-optionals on every field.
- Should speed up compilation, and this feature is only needed for
  lemmy-js-client.
- Fixes #5741

* Removing ts_optional_fields from enums

* Updating translations.

* Fix tests

* Fixing translations

* Adding ts-rs feature to ts_bindings script

* Consolidating optional fields and export to one line.

* Dont export federation_queue_state
2025-06-12 16:30:48 +02:00

98 lines
3.3 KiB
Rust

use crate::{
newtypes::{DbUrl, InstanceId, SiteId},
sensitive::SensitiveString,
};
use chrono::{DateTime, Utc};
#[cfg(feature = "full")]
use lemmy_db_schema_file::schema::site;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;
#[skip_serializing_none]
#[derive(PartialEq, Eq, Debug, Clone, Serialize, Deserialize)]
#[cfg_attr(feature = "full", derive(Queryable, Selectable, Identifiable))]
#[cfg_attr(feature = "full", diesel(table_name = site))]
#[cfg_attr(feature = "full", diesel(check_for_backend(diesel::pg::Pg)))]
#[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
#[cfg_attr(feature = "ts-rs", ts(optional_fields, export))]
/// Additional data for federated instances. This may be missing for other platforms which are not
/// fully compatible. Basic data is guaranteed to be available via [[Instance]].
pub struct Site {
pub id: SiteId,
pub name: String,
/// A sidebar for the site in markdown.
pub sidebar: Option<String>,
pub published_at: DateTime<Utc>,
pub updated_at: Option<DateTime<Utc>>,
/// An icon URL.
pub icon: Option<DbUrl>,
/// A banner url.
pub banner: Option<DbUrl>,
/// A shorter, one-line description of the site.
pub description: Option<String>,
/// The federated ap_id.
pub ap_id: DbUrl,
/// The time the site was last refreshed.
pub last_refreshed_at: DateTime<Utc>,
/// The site inbox
pub inbox_url: DbUrl,
#[serde(skip)]
pub private_key: Option<SensitiveString>,
// TODO: mark as `serde(skip)` in next major release as its not needed for api
pub public_key: String,
pub instance_id: InstanceId,
/// If present, nsfw content is visible by default. Should be displayed by frontends/clients
/// when the site is first opened by a user.
pub content_warning: Option<String>,
}
#[derive(Clone, derive_new::new)]
#[cfg_attr(feature = "full", derive(Insertable, AsChangeset))]
#[cfg_attr(feature = "full", diesel(table_name = site))]
pub struct SiteInsertForm {
pub name: String,
pub instance_id: InstanceId,
#[new(default)]
pub sidebar: Option<String>,
#[new(default)]
pub updated_at: Option<DateTime<Utc>>,
#[new(default)]
pub icon: Option<DbUrl>,
#[new(default)]
pub banner: Option<DbUrl>,
#[new(default)]
pub description: Option<String>,
#[new(default)]
pub ap_id: Option<DbUrl>,
#[new(default)]
pub last_refreshed_at: Option<DateTime<Utc>>,
#[new(default)]
pub inbox_url: Option<DbUrl>,
#[new(default)]
pub private_key: Option<String>,
#[new(default)]
pub public_key: Option<String>,
#[new(default)]
pub content_warning: Option<String>,
}
#[derive(Clone, Default)]
#[cfg_attr(feature = "full", derive(AsChangeset))]
#[cfg_attr(feature = "full", diesel(table_name = site))]
pub struct SiteUpdateForm {
pub name: Option<String>,
pub sidebar: Option<Option<String>>,
pub updated_at: Option<Option<DateTime<Utc>>>,
// when you want to null out a column, you have to send Some(None)), since sending None means you
// just don't want to update that column.
pub icon: Option<Option<DbUrl>>,
pub banner: Option<Option<DbUrl>>,
pub description: Option<Option<String>>,
pub ap_id: Option<DbUrl>,
pub last_refreshed_at: Option<DateTime<Utc>>,
pub inbox_url: Option<DbUrl>,
pub private_key: Option<Option<String>>,
pub public_key: Option<String>,
pub content_warning: Option<Option<String>>,
}