Add oembed endpoint

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

diff --git a/server/models/video/video-interface.ts b/server/models/video/video-interface.ts
index 2fabcd9065111b94ba71bcffa52020158ae4c39b..1402df26a2aaf20f44403b6e16937d1c06f1df36 100644 (file)
--- a/server/models/video/video-interface.ts
+++ b/server/models/video/video-interface.ts
@@ -3,69 +3,41 @@ import * as Promise from 'bluebird'
 
 import { AuthorInstance } from './author-interface'
 import { TagAttributes, TagInstance } from './tag-interface'
+import { VideoFileAttributes, VideoFileInstance } from './video-file-interface'
 
 // Don't use barrel, import just what we need
-import { Video as FormatedVideo } from '../../../shared/models/videos/video.model'
+import { Video as FormattedVideo } from '../../../shared/models/videos/video.model'
+import { RemoteVideoUpdateData } from '../../../shared/models/pods/remote-video/remote-video-update-request.model'
+import { RemoteVideoCreateData } from '../../../shared/models/pods/remote-video/remote-video-create-request.model'
 import { ResultList } from '../../../shared/models/result-list.model'
 
-export type FormatedAddRemoteVideo = {
-  uuid: string
-  name: string
-  category: number
-  licence: number
-  language: number
-  nsfw: boolean
-  description: string
-  infoHash: string
-  author: string
-  duration: number
-  thumbnailData: string
-  tags: string[]
-  createdAt: Date
-  updatedAt: Date
-  extname: string
-  views: number
-  likes: number
-  dislikes: number
-}
-
-export type FormatedUpdateRemoteVideo = {
-  uuid: string
-  name: string
-  category: number
-  licence: number
-  language: number
-  nsfw: boolean
-  description: string
-  infoHash: string
-  author: string
-  duration: number
-  tags: string[]
-  createdAt: Date
-  updatedAt: Date
-  extname: string
-  views: number
-  likes: number
-  dislikes: number
-}
-
 export namespace VideoMethods {
-  export type GenerateMagnetUri = (this: VideoInstance) => string
-  export type GetVideoFilename = (this: VideoInstance) => string
   export type GetThumbnailName = (this: VideoInstance) => string
   export type GetPreviewName = (this: VideoInstance) => string
-  export type GetTorrentName = (this: VideoInstance) => string
   export type IsOwned = (this: VideoInstance) => boolean
-  export type ToFormatedJSON = (this: VideoInstance) => FormatedVideo
-
-  export type ToAddRemoteJSON = (this: VideoInstance) => Promise<FormatedAddRemoteVideo>
-  export type ToUpdateRemoteJSON = (this: VideoInstance) => FormatedUpdateRemoteVideo
-
-  export type TranscodeVideofile = (this: VideoInstance) => Promise<void>
+  export type ToFormattedJSON = (this: VideoInstance) => FormattedVideo
+
+  export type GetOriginalFile = (this: VideoInstance) => VideoFileInstance
+  export type GenerateMagnetUri = (this: VideoInstance, videoFile: VideoFileInstance) => string
+  export type GetTorrentFileName = (this: VideoInstance, videoFile: VideoFileInstance) => string
+  export type GetVideoFilename = (this: VideoInstance, videoFile: VideoFileInstance) => string
+  export type CreatePreview = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<string>
+  export type CreateThumbnail = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<string>
+  export type GetVideoFilePath = (this: VideoInstance, videoFile: VideoFileInstance) => string
+  export type CreateTorrentAndSetInfoHash = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
+
+  export type ToAddRemoteJSON = (this: VideoInstance) => Promise<RemoteVideoCreateData>
+  export type ToUpdateRemoteJSON = (this: VideoInstance) => RemoteVideoUpdateData
+
+  export type OptimizeOriginalVideofile = (this: VideoInstance) => Promise<void>
+  export type TranscodeOriginalVideofile = (this: VideoInstance, resolution: number) => Promise<void>
+  export type GetOriginalFileHeight = (this: VideoInstance) => Promise<number>
+  export type GetEmbedPath = (this: VideoInstance) => string
+  export type GetThumbnailPath = (this: VideoInstance) => string
+  export type GetPreviewPath = (this: VideoInstance) => string
 
   // Return thumbnail name
   export type GenerateThumbnailFromData = (video: VideoInstance, thumbnailData: string) => Promise<string>
-  export type GetDurationFromFile = (videoPath: string) => Promise<number>
 
   export type List = () => Promise<VideoInstance[]>
   export type ListOwnedAndPopulateAuthorAndTags = () => Promise<VideoInstance[]>
@@ -86,45 +58,37 @@ export namespace VideoMethods {
   export type LoadAndPopulateAuthor = (id: number) => Promise<VideoInstance>
   export type LoadAndPopulateAuthorAndPodAndTags = (id: number) => Promise<VideoInstance>
   export type LoadByUUIDAndPopulateAuthorAndPodAndTags = (uuid: string) => Promise<VideoInstance>
+
+  export type RemoveThumbnail = (this: VideoInstance) => Promise<void>
+  export type RemovePreview = (this: VideoInstance) => Promise<void>
+  export type RemoveFile = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
+  export type RemoveTorrent = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
 }
 
 export interface VideoClass {
-  generateMagnetUri: VideoMethods.GenerateMagnetUri
-  getVideoFilename: VideoMethods.GetVideoFilename
-  getThumbnailName: VideoMethods.GetThumbnailName
-  getPreviewName: VideoMethods.GetPreviewName
-  getTorrentName: VideoMethods.GetTorrentName
-  isOwned: VideoMethods.IsOwned
-  toFormatedJSON: VideoMethods.ToFormatedJSON
-  toAddRemoteJSON: VideoMethods.ToAddRemoteJSON
-  toUpdateRemoteJSON: VideoMethods.ToUpdateRemoteJSON
-  transcodeVideofile: VideoMethods.TranscodeVideofile
-
   generateThumbnailFromData: VideoMethods.GenerateThumbnailFromData
-  getDurationFromFile: VideoMethods.GetDurationFromFile
   list: VideoMethods.List
   listForApi: VideoMethods.ListForApi
-  loadByHostAndUUID: VideoMethods.LoadByHostAndUUID
   listOwnedAndPopulateAuthorAndTags: VideoMethods.ListOwnedAndPopulateAuthorAndTags
   listOwnedByAuthor: VideoMethods.ListOwnedByAuthor
   load: VideoMethods.Load
-  loadByUUID: VideoMethods.LoadByUUID
   loadAndPopulateAuthor: VideoMethods.LoadAndPopulateAuthor
   loadAndPopulateAuthorAndPodAndTags: VideoMethods.LoadAndPopulateAuthorAndPodAndTags
+  loadByHostAndUUID: VideoMethods.LoadByHostAndUUID
+  loadByUUID: VideoMethods.LoadByUUID
   loadByUUIDAndPopulateAuthorAndPodAndTags: VideoMethods.LoadByUUIDAndPopulateAuthorAndPodAndTags
   searchAndPopulateAuthorAndPodAndTags: VideoMethods.SearchAndPopulateAuthorAndPodAndTags
 }
 
 export interface VideoAttributes {
+  id?: number
   uuid?: string
   name: string
-  extname: string
   category: number
   licence: number
   language: number
   nsfw: boolean
   description: string
-  infoHash?: string
   duration: number
   views?: number
   likes?: number
@@ -133,25 +97,41 @@ export interface VideoAttributes {
 
   Author?: AuthorInstance
   Tags?: TagInstance[]
+  VideoFiles?: VideoFileInstance[]
 }
 
 export interface VideoInstance extends VideoClass, VideoAttributes, Sequelize.Instance<VideoAttributes> {
-  id: number
   createdAt: Date
   updatedAt: Date
 
+  createPreview: VideoMethods.CreatePreview
+  createThumbnail: VideoMethods.CreateThumbnail
+  createTorrentAndSetInfoHash: VideoMethods.CreateTorrentAndSetInfoHash
+  getOriginalFile: VideoMethods.GetOriginalFile
   generateMagnetUri: VideoMethods.GenerateMagnetUri
-  getVideoFilename: VideoMethods.GetVideoFilename
-  getThumbnailName: VideoMethods.GetThumbnailName
   getPreviewName: VideoMethods.GetPreviewName
-  getTorrentName: VideoMethods.GetTorrentName
+  getPreviewPath: VideoMethods.GetPreviewPath
+  getThumbnailName: VideoMethods.GetThumbnailName
+  getThumbnailPath: VideoMethods.GetThumbnailPath
+  getTorrentFileName: VideoMethods.GetTorrentFileName
+  getVideoFilename: VideoMethods.GetVideoFilename
+  getVideoFilePath: VideoMethods.GetVideoFilePath
   isOwned: VideoMethods.IsOwned
-  toFormatedJSON: VideoMethods.ToFormatedJSON
+  removeFile: VideoMethods.RemoveFile
+  removePreview: VideoMethods.RemovePreview
+  removeThumbnail: VideoMethods.RemoveThumbnail
+  removeTorrent: VideoMethods.RemoveTorrent
   toAddRemoteJSON: VideoMethods.ToAddRemoteJSON
+  toFormattedJSON: VideoMethods.ToFormattedJSON
   toUpdateRemoteJSON: VideoMethods.ToUpdateRemoteJSON
-  transcodeVideofile: VideoMethods.TranscodeVideofile
+  optimizeOriginalVideofile: VideoMethods.OptimizeOriginalVideofile
+  transcodeOriginalVideofile: VideoMethods.TranscodeOriginalVideofile
+  getOriginalFileHeight: VideoMethods.GetOriginalFileHeight
+  getEmbedPath: VideoMethods.GetEmbedPath
 
   setTags: Sequelize.HasManySetAssociationsMixin<TagAttributes, string>
+  addVideoFile: Sequelize.HasManyAddAssociationMixin<VideoFileAttributes, string>
+  setVideoFiles: Sequelize.HasManySetAssociationsMixin<VideoFileAttributes, string>
 }
 
 export interface VideoModel extends VideoClass, Sequelize.Model<VideoInstance, VideoAttributes> {}