server/models/video/video-interface.ts

   1 import * as Sequelize from 'sequelize'
   2 import * as Promise from 'bluebird'
   3
   4 import { TagAttributes, TagInstance } from './tag-interface'
   5 import { VideoFileAttributes, VideoFileInstance } from './video-file-interface'
   6
   7 // Don't use barrel, import just what we need
   8 import {
   9   Video as FormattedVideo,
  10   VideoDetails as FormattedDetailsVideo
  11 } from '../../../shared/models/videos/video.model'
  12 import { RemoteVideoUpdateData } from '../../../shared/models/pods/remote-video/remote-video-update-request.model'
  13 import { RemoteVideoCreateData } from '../../../shared/models/pods/remote-video/remote-video-create-request.model'
  14 import { ResultList } from '../../../shared/models/result-list.model'
  15 import { VideoChannelInstance } from './video-channel-interface'
  16
  17 export namespace VideoMethods {
  18   export type GetThumbnailName = (this: VideoInstance) => string
  19   export type GetPreviewName = (this: VideoInstance) => string
  20   export type IsOwned = (this: VideoInstance) => boolean
  21   export type ToFormattedJSON = (this: VideoInstance) => FormattedVideo
  22   export type ToFormattedDetailsJSON = (this: VideoInstance) => FormattedDetailsVideo
  23
  24   export type GetOriginalFile = (this: VideoInstance) => VideoFileInstance
  25   export type GetTorrentFileName = (this: VideoInstance, videoFile: VideoFileInstance) => string
  26   export type GetVideoFilename = (this: VideoInstance, videoFile: VideoFileInstance) => string
  27   export type CreatePreview = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<string>
  28   export type CreateThumbnail = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<string>
  29   export type GetVideoFilePath = (this: VideoInstance, videoFile: VideoFileInstance) => string
  30   export type CreateTorrentAndSetInfoHash = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
  31
  32   export type ToAddRemoteJSON = (this: VideoInstance) => Promise<RemoteVideoCreateData>
  33   export type ToUpdateRemoteJSON = (this: VideoInstance) => RemoteVideoUpdateData
  34
  35   export type OptimizeOriginalVideofile = (this: VideoInstance) => Promise<void>
  36   export type TranscodeOriginalVideofile = (this: VideoInstance, resolution: number) => Promise<void>
  37   export type GetOriginalFileHeight = (this: VideoInstance) => Promise<number>
  38   export type GetEmbedPath = (this: VideoInstance) => string
  39   export type GetThumbnailPath = (this: VideoInstance) => string
  40   export type GetPreviewPath = (this: VideoInstance) => string
  41   export type GetDescriptionPath = (this: VideoInstance) => string
  42   export type GetTruncatedDescription = (this: VideoInstance) => string
  43
  44   // Return thumbnail name
  45   export type GenerateThumbnailFromData = (video: VideoInstance, thumbnailData: string) => Promise<string>
  46
  47   export type List = () => Promise<VideoInstance[]>
  48   export type ListOwnedAndPopulateAuthorAndTags = () => Promise<VideoInstance[]>
  49   export type ListOwnedByAuthor = (author: string) => Promise<VideoInstance[]>
  50
  51   export type ListForApi = (start: number, count: number, sort: string) => Promise< ResultList<VideoInstance> >
  52   export type SearchAndPopulateAuthorAndPodAndTags = (
  53     value: string,
  54     field: string,
  55     start: number,
  56     count: number,
  57     sort: string
  58   ) => Promise< ResultList<VideoInstance> >
  59
  60   export type Load = (id: number) => Promise<VideoInstance>
  61   export type LoadByUUID = (uuid: string, t?: Sequelize.Transaction) => Promise<VideoInstance>
  62   export type LoadLocalVideoByUUID = (uuid: string, t?: Sequelize.Transaction) => Promise<VideoInstance>
  63   export type LoadByHostAndUUID = (fromHost: string, uuid: string, t?: Sequelize.Transaction) => Promise<VideoInstance>
  64   export type LoadAndPopulateAuthor = (id: number) => Promise<VideoInstance>
  65   export type LoadAndPopulateAuthorAndPodAndTags = (id: number) => Promise<VideoInstance>
  66   export type LoadByUUIDAndPopulateAuthorAndPodAndTags = (uuid: string) => Promise<VideoInstance>
  67
  68   export type RemoveThumbnail = (this: VideoInstance) => Promise<void>
  69   export type RemovePreview = (this: VideoInstance) => Promise<void>
  70   export type RemoveFile = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
  71   export type RemoveTorrent = (this: VideoInstance, videoFile: VideoFileInstance) => Promise<void>
  72 }
  73
  74 export interface VideoClass {
  75   generateThumbnailFromData: VideoMethods.GenerateThumbnailFromData
  76   list: VideoMethods.List
  77   listForApi: VideoMethods.ListForApi
  78   listOwnedAndPopulateAuthorAndTags: VideoMethods.ListOwnedAndPopulateAuthorAndTags
  79   listOwnedByAuthor: VideoMethods.ListOwnedByAuthor
  80   load: VideoMethods.Load
  81   loadAndPopulateAuthor: VideoMethods.LoadAndPopulateAuthor
  82   loadAndPopulateAuthorAndPodAndTags: VideoMethods.LoadAndPopulateAuthorAndPodAndTags
  83   loadByHostAndUUID: VideoMethods.LoadByHostAndUUID
  84   loadByUUID: VideoMethods.LoadByUUID
  85   loadLocalVideoByUUID: VideoMethods.LoadLocalVideoByUUID
  86   loadByUUIDAndPopulateAuthorAndPodAndTags: VideoMethods.LoadByUUIDAndPopulateAuthorAndPodAndTags
  87   searchAndPopulateAuthorAndPodAndTags: VideoMethods.SearchAndPopulateAuthorAndPodAndTags
  88 }
  89
  90 export interface VideoAttributes {
  91   id?: number
  92   uuid?: string
  93   name: string
  94   category: number
  95   licence: number
  96   language: number
  97   nsfw: boolean
  98   description: string
  99   duration: number
 100   views?: number
 101   likes?: number
 102   dislikes?: number
 103   remote: boolean
 104
 105   channelId?: number
 106
 107   VideoChannel?: VideoChannelInstance
 108   Tags?: TagInstance[]
 109   VideoFiles?: VideoFileInstance[]
 110 }
 111
 112 export interface VideoInstance extends VideoClass, VideoAttributes, Sequelize.Instance<VideoAttributes> {
 113   createdAt: Date
 114   updatedAt: Date
 115
 116   createPreview: VideoMethods.CreatePreview
 117   createThumbnail: VideoMethods.CreateThumbnail
 118   createTorrentAndSetInfoHash: VideoMethods.CreateTorrentAndSetInfoHash
 119   getOriginalFile: VideoMethods.GetOriginalFile
 120   getPreviewName: VideoMethods.GetPreviewName
 121   getPreviewPath: VideoMethods.GetPreviewPath
 122   getThumbnailName: VideoMethods.GetThumbnailName
 123   getThumbnailPath: VideoMethods.GetThumbnailPath
 124   getTorrentFileName: VideoMethods.GetTorrentFileName
 125   getVideoFilename: VideoMethods.GetVideoFilename
 126   getVideoFilePath: VideoMethods.GetVideoFilePath
 127   isOwned: VideoMethods.IsOwned
 128   removeFile: VideoMethods.RemoveFile
 129   removePreview: VideoMethods.RemovePreview
 130   removeThumbnail: VideoMethods.RemoveThumbnail
 131   removeTorrent: VideoMethods.RemoveTorrent
 132   toAddRemoteJSON: VideoMethods.ToAddRemoteJSON
 133   toFormattedJSON: VideoMethods.ToFormattedJSON
 134   toFormattedDetailsJSON: VideoMethods.ToFormattedDetailsJSON
 135   toUpdateRemoteJSON: VideoMethods.ToUpdateRemoteJSON
 136   optimizeOriginalVideofile: VideoMethods.OptimizeOriginalVideofile
 137   transcodeOriginalVideofile: VideoMethods.TranscodeOriginalVideofile
 138   getOriginalFileHeight: VideoMethods.GetOriginalFileHeight
 139   getEmbedPath: VideoMethods.GetEmbedPath
 140   getDescriptionPath: VideoMethods.GetDescriptionPath
 141   getTruncatedDescription : VideoMethods.GetTruncatedDescription
 142
 143   setTags: Sequelize.HasManySetAssociationsMixin<TagAttributes, string>
 144   addVideoFile: Sequelize.HasManyAddAssociationMixin<VideoFileAttributes, string>
 145   setVideoFiles: Sequelize.HasManySetAssociationsMixin<VideoFileAttributes, string>
 146 }
 147
 148 export interface VideoModel extends VideoClass, Sequelize.Model<VideoInstance, VideoAttributes> {}