[github/Chocobozzz/PeerTube.git] / server / typings / models / video / video-playlist-element.ts

import { VideoPlaylistElementModel } from '@server/models/video/video-playlist-element'
import { PickWith } from '@server/typings/utils'
import { MVideoFormattable, MVideoPlaylistPrivacy, MVideoThumbnail, MVideoUrl } from '@server/typings/models'

type Use<K extends keyof VideoPlaylistElementModel, M> = PickWith<VideoPlaylistElementModel, K, M>

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

export type MVideoPlaylistElement = Omit<VideoPlaylistElementModel, 'VideoPlaylist' | 'Video'>

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

export type MVideoPlaylistElementId = Pick<MVideoPlaylistElement, 'id'>

export type MVideoPlaylistElementLight = Pick<MVideoPlaylistElement, 'id' | 'videoId' | 'startTimestamp' | 'stopTimestamp'>

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

export type MVideoPlaylistVideoThumbnail = MVideoPlaylistElement &
  Use<'Video', MVideoThumbnail>

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

// For API

export type MVideoPlaylistElementAP = MVideoPlaylistElement &
  Use<'Video', MVideoUrl> &
  Use<'VideoPlaylist', MVideoPlaylistPrivacy>

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

// Format for API or AP object

export type MVideoPlaylistElementFormattable = MVideoPlaylistElement &
  Use<'Video', MVideoFormattable>
Commit	Line	Data
	1	import { VideoPlaylistElementModel } from '@server/models/video/video-playlist-element'
	2	import { PickWith } from '@server/typings/utils'
	3	import { MVideoFormattable, MVideoPlaylistPrivacy, MVideoThumbnail, MVideoUrl } from '@server/typings/models'
	4
	5	type Use<K extends keyof VideoPlaylistElementModel, M> = PickWith<VideoPlaylistElementModel, K, M>
	6
	7	// ############################################################################
	8
	9	export type MVideoPlaylistElement = Omit<VideoPlaylistElementModel, 'VideoPlaylist' \| 'Video'>
	10
	11	// ############################################################################
	12
	13	export type MVideoPlaylistElementId = Pick<MVideoPlaylistElement, 'id'>
	14
	15	export type MVideoPlaylistElementLight = Pick<MVideoPlaylistElement, 'id' \| 'videoId' \| 'startTimestamp' \| 'stopTimestamp'>
	16
	17	// ############################################################################
	18
	19	export type MVideoPlaylistVideoThumbnail = MVideoPlaylistElement &
	20	Use<'Video', MVideoThumbnail>
	21
	22	// ############################################################################
	23
	24	// For API
	25
	26	export type MVideoPlaylistElementAP = MVideoPlaylistElement &
	27	Use<'Video', MVideoUrl> &
	28	Use<'VideoPlaylist', MVideoPlaylistPrivacy>
	29
	30	// ############################################################################
	31
	32	// Format for API or AP object
	33
	34	export type MVideoPlaylistElementFormattable = MVideoPlaylistElement &
	35	Use<'Video', MVideoFormattable>