mirror of
https://github.com/LemmyNet/lemmy.git
synced 2024-12-03 09:41:19 +00:00
df664d9d9a
* Upgrading ts_rs to 10.0.0 * Adding ts_option directives, and woodpecker test. * Fixing ts_options.
222 lines
7.2 KiB
Rust
222 lines
7.2 KiB
Rust
use lemmy_db_schema::{
|
|
newtypes::{CommentId, CommentReportId, CommunityId, LanguageId, LocalUserId, PostId},
|
|
CommentSortType,
|
|
ListingType,
|
|
};
|
|
use lemmy_db_views::structs::{CommentReportView, CommentView, VoteView};
|
|
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))]
|
|
/// Create a comment.
|
|
pub struct CreateComment {
|
|
pub content: String,
|
|
pub post_id: PostId,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub parent_id: Option<CommentId>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub language_id: Option<LanguageId>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, Copy, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Fetch an individual comment.
|
|
pub struct GetComment {
|
|
pub id: CommentId,
|
|
}
|
|
|
|
#[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 comment.
|
|
pub struct EditComment {
|
|
pub comment_id: CommentId,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub content: Option<String>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub language_id: Option<LanguageId>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Distinguish a comment (IE speak as moderator).
|
|
pub struct DistinguishComment {
|
|
pub comment_id: CommentId,
|
|
pub distinguished: bool,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Delete your own comment.
|
|
pub struct DeleteComment {
|
|
pub comment_id: CommentId,
|
|
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 comment (only doable by mods).
|
|
pub struct RemoveComment {
|
|
pub comment_id: CommentId,
|
|
pub removed: bool,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub reason: Option<String>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Save / bookmark a comment.
|
|
pub struct SaveComment {
|
|
pub comment_id: CommentId,
|
|
pub save: bool,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// A comment response.
|
|
pub struct CommentResponse {
|
|
pub comment_view: CommentView,
|
|
pub recipient_ids: Vec<LocalUserId>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Like a comment.
|
|
pub struct CreateCommentLike {
|
|
pub comment_id: CommentId,
|
|
/// Must be -1, 0, or 1 .
|
|
pub score: i16,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Get a list of comments.
|
|
pub struct GetComments {
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub type_: Option<ListingType>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub sort: Option<CommentSortType>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub max_depth: Option<i32>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub page: Option<i64>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub limit: Option<i64>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub community_id: Option<CommunityId>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub community_name: Option<String>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub post_id: Option<PostId>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub parent_id: Option<CommentId>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub saved_only: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub liked_only: Option<bool>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub disliked_only: Option<bool>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The comment list response.
|
|
pub struct GetCommentsResponse {
|
|
pub comments: Vec<CommentView>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Default)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Report a comment.
|
|
pub struct CreateCommentReport {
|
|
pub comment_id: CommentId,
|
|
pub reason: String,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The comment report response.
|
|
pub struct CommentReportResponse {
|
|
pub comment_report_view: CommentReportView,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// Resolve a comment report (only doable by mods).
|
|
pub struct ResolveCommentReport {
|
|
pub report_id: CommentReportId,
|
|
pub resolved: bool,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// List comment reports.
|
|
pub struct ListCommentReports {
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub comment_id: Option<CommentId>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub page: Option<i64>,
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub limit: Option<i64>,
|
|
/// Only shows the unresolved reports
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub unresolved_only: Option<bool>,
|
|
/// if no community is given, it returns reports for all communities moderated by the auth user
|
|
#[cfg_attr(feature = "full", ts(optional))]
|
|
pub community_id: Option<CommunityId>,
|
|
}
|
|
|
|
#[derive(Debug, Serialize, Deserialize, Clone)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// The comment report list response.
|
|
pub struct ListCommentReportsResponse {
|
|
pub comment_reports: Vec<CommentReportView>,
|
|
}
|
|
|
|
#[skip_serializing_none]
|
|
#[derive(Debug, Serialize, Deserialize, Clone, Copy, Default, PartialEq, Eq, Hash)]
|
|
#[cfg_attr(feature = "full", derive(TS))]
|
|
#[cfg_attr(feature = "full", ts(export))]
|
|
/// List comment likes. Admins-only.
|
|
pub struct ListCommentLikes {
|
|
pub comment_id: CommentId,
|
|
#[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 comment likes response
|
|
pub struct ListCommentLikesResponse {
|
|
pub comment_likes: Vec<VoteView>,
|
|
}
|