mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-12-13 22:22:10 +00:00
ad90cd77f9
* add private visibility * filter private communities in post_view.rs * also filter in comment_view * community follower state * remove unused method * sql fmt * add CommunityFollower.approved_by * implement api endpoints * api changes * only admins can create private community for now * add local api tests * fix api tests * follow remote private community * use authorized fetch for content in private community * federate community visibility * dont mark content in private community as public * expose ApprovalRequired in api * also check content fetchable for outbox/featured * address private community content to followers * implement reject activity * fix tests * add files * remove local api tests * dont use delay * is_new_instance * single query for is_new_instance * return subscribed type for pending follow * working * need to catch errors in waitUntil * clippy * fix query * lint for unused async * diesel.toml comment * add comment * avoid db reads * rename approved_by to approver_id * add helper * form init * list pending follows should return items for all communities * clippy * ci * fix down migration * fix api tests * references * rename * run git diff * ci * fix schema check * fix joins * ci * ci * skip_serializing_none * fix test --------- Co-authored-by: Dessalines <dessalines@users.noreply.github.com>
325 lines
11 KiB
Rust
325 lines
11 KiB
Rust
use lemmy_db_schema::{
|
|
newtypes::{CommunityId, LanguageId, PersonId},
|
|
source::site::Site,
|
|
CommunityVisibility,
|
|
ListingType,
|
|
};
|
|
use lemmy_db_views_actor::structs::{
|
|
CommunityModeratorView,
|
|
CommunitySortType,
|
|
CommunityView,
|
|
PendingFollow,
|
|
PersonView,
|
|
};
|
|
use serde::{Deserialize, Serialize};
|
|
use serde_with::skip_serializing_none;
|
|
#[cfg(feature = "full")]
|
|
use ts_rs::TS;
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
// TODO make this into a tagged enum
|
|
/// Get a community. Must provide either an id, or a name.
|
|
pub struct GetCommunity {
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub id: Option<CommunityId>,
|
|
/// Example: star_trek , or star_trek@xyz.tld
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub name: Option<String>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The community response.
|
|
pub struct GetCommunityResponse {
|
|
pub community_view: CommunityView,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub site: Option<Site>,
|
|
pub moderators: Vec<CommunityModeratorView>,
|
|
pub discussion_languages: Vec<LanguageId>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
/// Create a community.
|
|
pub struct CreateCommunity {
|
|
/// The unique name.
|
|
pub name: String,
|
|
/// A longer title.
|
|
pub title: String,
|
|
/// A sidebar for the community in markdown.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub sidebar: Option<String>,
|
|
/// A shorter, one line description of your community.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub description: Option<String>,
|
|
/// An icon URL.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub icon: Option<String>,
|
|
/// A banner URL.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub banner: Option<String>,
|
|
/// Whether its an NSFW community.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub nsfw: Option<bool>,
|
|
/// Whether to restrict posting only to moderators.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub posting_restricted_to_mods: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub discussion_languages: Option<Vec<LanguageId>>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub visibility: Option<CommunityVisibility>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// A simple community response.
|
|
pub struct CommunityResponse {
|
|
pub community_view: CommunityView,
|
|
pub discussion_languages: Vec<LanguageId>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Fetches a list of communities.
|
|
pub struct ListCommunities {
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub type_: Option<ListingType>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub sort: Option<CommunitySortType>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub show_nsfw: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub page: Option<i64>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub limit: Option<i64>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The response for listing communities.
|
|
pub struct ListCommunitiesResponse {
|
|
pub communities: Vec<CommunityView>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Ban a user from a community.
|
|
pub struct BanFromCommunity {
|
|
pub community_id: CommunityId,
|
|
pub person_id: PersonId,
|
|
pub ban: bool,
|
|
/// Optionally remove or restore all their data. Useful for new troll accounts.
|
|
/// If ban is true, then this means remove. If ban is false, it means restore.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub remove_or_restore_data: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub reason: Option<String>,
|
|
/// A time that the ban will expire, in unix epoch seconds.
|
|
///
|
|
/// An i64 unix timestamp is used for a simpler API client implementation.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub expires: Option<i64>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The response for banning a user from a community.
|
|
pub struct BanFromCommunityResponse {
|
|
pub person_view: PersonView,
|
|
pub banned: bool,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Add a moderator to a community.
|
|
pub struct AddModToCommunity {
|
|
pub community_id: CommunityId,
|
|
pub person_id: PersonId,
|
|
pub added: bool,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The response of adding a moderator to a community.
|
|
pub struct AddModToCommunityResponse {
|
|
pub moderators: Vec<CommunityModeratorView>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Edit a community.
|
|
pub struct EditCommunity {
|
|
pub community_id: CommunityId,
|
|
/// A longer title.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub title: Option<String>,
|
|
/// A sidebar for the community in markdown.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub sidebar: Option<String>,
|
|
/// A shorter, one line description of your community.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub description: Option<String>,
|
|
/// An icon URL.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub icon: Option<String>,
|
|
/// A banner URL.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub banner: Option<String>,
|
|
/// Whether its an NSFW community.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub nsfw: Option<bool>,
|
|
/// Whether to restrict posting only to moderators.
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub posting_restricted_to_mods: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub discussion_languages: Option<Vec<LanguageId>>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub visibility: Option<CommunityVisibility>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Hide a community from the main view.
|
|
pub struct HideCommunity {
|
|
pub community_id: CommunityId,
|
|
pub hidden: bool,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub reason: Option<String>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Delete your own community.
|
|
pub struct DeleteCommunity {
|
|
pub community_id: CommunityId,
|
|
pub deleted: bool,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Remove a community (only doable by moderators).
|
|
pub struct RemoveCommunity {
|
|
pub community_id: CommunityId,
|
|
pub removed: bool,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub reason: Option<String>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Follow / subscribe to a community.
|
|
pub struct FollowCommunity {
|
|
pub community_id: CommunityId,
|
|
pub follow: bool,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Block a community.
|
|
pub struct BlockCommunity {
|
|
pub community_id: CommunityId,
|
|
pub block: bool,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The block community response.
|
|
pub struct BlockCommunityResponse {
|
|
pub community_view: CommunityView,
|
|
pub blocked: bool,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Transfer a community to a new owner.
|
|
pub struct TransferCommunity {
|
|
pub community_id: CommunityId,
|
|
pub person_id: PersonId,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Fetches a random community
|
|
pub struct GetRandomCommunity {
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub type_: Option<ListingType>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
pub struct ListCommunityPendingFollows {
|
|
/// Only shows the unapproved applications
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub pending_only: Option<bool>,
|
|
// Only for admins, show pending follows for communities which you dont moderate
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub all_communities: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub page: Option<i64>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub limit: Option<i64>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
pub struct GetCommunityPendingFollowsCount {
|
|
pub community_id: CommunityId,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
pub struct GetCommunityPendingFollowsCountResponse {
|
|
pub count: i64,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
pub struct ListCommunityPendingFollowsResponse {
|
|
pub items: Vec<PendingFollow>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
pub struct ApproveCommunityPendingFollower {
|
|
pub community_id: CommunityId,
|
|
pub follower_id: PersonId,
|
|
pub approve: bool,
|
|
}
|