Merge branch 'release/3.2.0' into develop

[github/Chocobozzz/PeerTube.git] / server / types / models / abuse / abuse.ts

import { VideoAbuseModel } from '@server/models/abuse/video-abuse'
import { VideoCommentAbuseModel } from '@server/models/abuse/video-comment-abuse'
import { VideoCommentModel } from '@server/models/video/video-comment'
import { PickWith } from '@shared/core-utils'
import { AbuseModel } from '../../../models/abuse/abuse'
import { MAccountDefault, MAccountFormattable, MAccountLight, MAccountUrl } from '../account'
import { MComment, MCommentOwner, MCommentUrl, MCommentVideo, MVideoUrl } from '../video'
import { MVideo, MVideoAccountLightBlacklistAllFiles } from '../video/video'

type Use<K extends keyof AbuseModel, M> = PickWith<AbuseModel, K, M>
type UseVideoAbuse<K extends keyof VideoAbuseModel, M> = PickWith<VideoAbuseModel, K, M>
type UseCommentAbuse<K extends keyof VideoCommentAbuseModel, M> = PickWith<VideoCommentAbuseModel, K, M>

// ############################################################################

export type MAbuse = Omit<AbuseModel, 'VideoCommentAbuse' | 'VideoAbuse' | 'ReporterAccount' | 'FlaggedAccount' | 'toActivityPubObject'>

export type MVideoAbuse = Omit<VideoAbuseModel, 'Abuse' | 'Video'>

export type MCommentAbuse = Omit<VideoCommentAbuseModel, 'Abuse' | 'VideoComment'>

export type MAbuseReporter =
  MAbuse &
  Use<'ReporterAccount', MAccountDefault>

// ############################################################################

export type MVideoAbuseVideo =
  MVideoAbuse &
  UseVideoAbuse<'Video', MVideo>

export type MVideoAbuseVideoUrl =
  MVideoAbuse &
  UseVideoAbuse<'Video', MVideoUrl>

export type MVideoAbuseVideoFull =
  MVideoAbuse &
  UseVideoAbuse<'Video', Omit<MVideoAccountLightBlacklistAllFiles, 'VideoFiles' | 'VideoStreamingPlaylists'>>

export type MVideoAbuseFormattable =
  MVideoAbuse &
  UseVideoAbuse<'Video', Pick<MVideoAccountLightBlacklistAllFiles,
  'id' | 'uuid' | 'name' | 'nsfw' | 'getMiniatureStaticPath' | 'isBlacklisted' | 'VideoChannel'>>

// ############################################################################

export type MCommentAbuseAccount =
  MCommentAbuse &
  UseCommentAbuse<'VideoComment', MCommentOwner>

export type MCommentAbuseAccountVideo =
  MCommentAbuse &
  UseCommentAbuse<'VideoComment', MCommentOwner & PickWith<VideoCommentModel, 'Video', MVideo>>

export type MCommentAbuseUrl =
  MCommentAbuse &
  UseCommentAbuse<'VideoComment', MCommentUrl>

export type MCommentAbuseFormattable =
  MCommentAbuse &
  UseCommentAbuse<'VideoComment', MComment & PickWith<MCommentVideo, 'Video', Pick<MVideo, 'id' | 'uuid' | 'name'>>>

// ############################################################################

export type MAbuseId = Pick<AbuseModel, 'id'>

export type MAbuseVideo =
  MAbuse &
  Pick<AbuseModel, 'toActivityPubObject'> &
  Use<'VideoAbuse', MVideoAbuseVideo>

export type MAbuseUrl =
  MAbuse &
  Use<'VideoAbuse', MVideoAbuseVideoUrl> &
  Use<'VideoCommentAbuse', MCommentAbuseUrl>

export type MAbuseAccountVideo =
  MAbuse &
  Pick<AbuseModel, 'toActivityPubObject'> &
  Use<'VideoAbuse', MVideoAbuseVideoFull> &
  Use<'ReporterAccount', MAccountDefault>

export type MAbuseFull =
  MAbuse &
  Pick<AbuseModel, 'toActivityPubObject'> &
  Use<'ReporterAccount', MAccountLight> &
  Use<'FlaggedAccount', MAccountLight> &
  Use<'VideoAbuse', MVideoAbuseVideoFull> &
  Use<'VideoCommentAbuse', MCommentAbuseAccountVideo>

// ############################################################################

// Format for API or AP object

export type MAbuseAdminFormattable =
  MAbuse &
  Use<'ReporterAccount', MAccountFormattable> &
  Use<'FlaggedAccount', MAccountFormattable> &
  Use<'VideoAbuse', MVideoAbuseFormattable> &
  Use<'VideoCommentAbuse', MCommentAbuseFormattable>

export type MAbuseUserFormattable =
  MAbuse &
  Use<'FlaggedAccount', MAccountFormattable> &
  Use<'VideoAbuse', MVideoAbuseFormattable> &
  Use<'VideoCommentAbuse', MCommentAbuseFormattable>

export type MAbuseAP =
  MAbuse &
  Pick<AbuseModel, 'toActivityPubObject'> &
  Use<'ReporterAccount', MAccountUrl> &
  Use<'FlaggedAccount', MAccountUrl> &
  Use<'VideoAbuse', MVideoAbuseVideo> &
  Use<'VideoCommentAbuse', MCommentAbuseAccount>