lemmy-js-client/src/interfaces/api/comment.ts

import { CommentReportView, CommentView } from '../views';

export interface CreateComment {
  content: string;
  parent_id?: number;
  post_id: number;
  form_id?: string;
  auth: string;
}

export interface EditComment {
  content: string;
  edit_id: number;
  form_id?: string;
  auth: string;
}

export interface DeleteComment {
  edit_id: number;
  deleted: boolean;
  auth: string;
}

export interface RemoveComment {
  edit_id: number;
  removed: boolean;
  reason?: string;
  auth: string;
}

export interface MarkCommentAsRead {
  comment_id: number;
  read: boolean;
  auth: string;
}

export interface SaveComment {
  comment_id: number;
  save: boolean;
  auth: string;
}

export interface CommentResponse {
  comment_view: CommentView;
  recipient_ids: number[]; // TODO another way to do this? Maybe a UserMention belongs to Comment
  form_id?: string; // An optional front end ID, to tell which is coming ba,
}

export interface CreateCommentLike {
  comment_id: number;
  score: number;
  auth: string;
}

export interface GetComments {
  type_: string;
  sort: string;
  page?: number;
  limit?: number;
  community_id?: number;
  community_name?: string;
  auth?: string;
}

export interface GetCommentsResponse {
  comments: CommentView[];
}

export interface CreateCommentReport {
  comment_id: number;
  reason: string;
  auth: string;
}

export interface CreateCommentReportResponse {
  success: boolean;
}

export interface ResolveCommentReport {
  report_id: number;
  resolved: boolean;
  auth: string;
}

export interface ResolveCommentReportResponse {
  // TODO this should probably return the view
  report_id: number;
  resolved: boolean;
}

export interface ListCommentReports {
  page?: number;
  limit?: number;
  /// if no community is given, it returns reports for all communities moderated by the auth user
  community?: number;
  auth: string;
}

export interface ListCommentReportsResponse {
  comments: CommentReportView[];
}