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

import { VideoCaptionModel } from '../../../models/video/video-caption'
import { FunctionProperties, PickWith } from '@server/typings/utils'
import { MVideo, MVideoUUID } from './video'

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

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

export type MVideoCaption = Omit<VideoCaptionModel, 'Video'>

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

export type MVideoCaptionLanguage = Pick<MVideoCaption, 'language'>
export type MVideoCaptionLanguageUrl = Pick<MVideoCaption, 'language' | 'fileUrl' | 'getFileUrl'>

export type MVideoCaptionVideo = MVideoCaption &
  Use<'Video', Pick<MVideo, 'id' | 'remote' | 'uuid'>>

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

// Format for API or AP object

export type MVideoCaptionFormattable = FunctionProperties<MVideoCaption> &
  Pick<MVideoCaption, 'language'> &
  Use<'Video', MVideoUUID>
Commit	Line	Data
453e83ea	1	import { VideoCaptionModel } from '../../../models/video/video-caption'
1ca9f7c3	2	import { FunctionProperties, PickWith } from '@server/typings/utils'
d7a25329	3	import { MVideo, MVideoUUID } from './video'
453e83ea	4
0283eaac C	5	type Use<K extends keyof VideoCaptionModel, M> = PickWith<VideoCaptionModel, K, M>
	6
	7	// ############################################################################
	8
453e83ea C	9	export type MVideoCaption = Omit<VideoCaptionModel, 'Video'>
453e83ea C	10
0283eaac C	11	// ############################################################################
0283eaac C	12
453e83ea	13	export type MVideoCaptionLanguage = Pick<MVideoCaption, 'language'>
ca6d3622	14	export type MVideoCaptionLanguageUrl = Pick<MVideoCaption, 'language' \| 'fileUrl' \| 'getFileUrl'>
453e83ea C	15
453e83ea C	16	export type MVideoCaptionVideo = MVideoCaption &
1ca9f7c3 C	17	Use<'Video', Pick<MVideo, 'id' \| 'remote' \| 'uuid'>>
	18
	19	// ############################################################################
	20
	21	// Format for API or AP object
	22
	23	export type MVideoCaptionFormattable = FunctionProperties<MVideoCaption> &
	24	Pick<MVideoCaption, 'language'> &
	25	Use<'Video', MVideoUUID>