Add peertube runner cli

[github/Chocobozzz/PeerTube.git] / shared / models / server / job.model.ts

diff --git a/shared/models/server/job.model.ts b/shared/models/server/job.model.ts
index 6b07eba6913a8baeb3b58ed13fb8792cb8ced8b8..16187d133b1b9430863465f406ea725a532c841f 100644 (file)
--- a/shared/models/server/job.model.ts
+++ b/shared/models/server/job.model.ts
@@ -1,32 +1,39 @@
 import { ContextType } from '../activitypub/context'
-import { VideoEditorTaskCut } from '../videos/editor'
+import { VideoState } from '../videos'
 import { VideoResolution } from '../videos/file/video-resolution.enum'
+import { VideoStudioTaskCut } from '../videos/studio'
 import { SendEmailOptions } from './emailer.model'
 
-export type JobState = 'active' | 'completed' | 'failed' | 'waiting' | 'delayed' | 'paused'
+export type JobState = 'active' | 'completed' | 'failed' | 'waiting' | 'delayed' | 'paused' | 'waiting-children'
 
 export type JobType =
-  | 'activitypub-http-unicast'
-  | 'activitypub-http-broadcast'
-  | 'activitypub-http-fetcher'
   | 'activitypub-cleaner'
   | 'activitypub-follow'
-  | 'video-file-import'
-  | 'video-transcoding'
-  | 'email'
-  | 'video-import'
-  | 'videos-views-stats'
+  | 'activitypub-http-broadcast-parallel'
+  | 'activitypub-http-broadcast'
+  | 'activitypub-http-fetcher'
+  | 'activitypub-http-unicast'
   | 'activitypub-refresher'
-  | 'video-redundancy'
-  | 'video-live-ending'
   | 'actor-keys'
+  | 'after-video-channel-import'
+  | 'email'
+  | 'federate-video'
+  | 'transcoding-job-builder'
   | 'manage-video-torrent'
   | 'move-to-object-storage'
-  | 'video-edition'
+  | 'notify'
+  | 'video-channel-import'
+  | 'video-file-import'
+  | 'video-import'
+  | 'video-live-ending'
+  | 'video-redundancy'
+  | 'video-studio-edition'
+  | 'video-transcoding'
+  | 'videos-views-stats'
 
 export interface Job {
-  id: number
-  state: JobState
+  id: number | string
+  state: JobState | 'unknown'
   type: JobType
   data: any
   priority: number
@@ -35,13 +42,17 @@ export interface Job {
   createdAt: Date | string
   finishedOn: Date | string
   processedOn: Date | string
+
+  parent?: {
+    id: string
+  }
 }
 
 export type ActivitypubHttpBroadcastPayload = {
   uris: string[]
-  signatureActorId?: number
+  contextType: ContextType
   body: any
-  contextType?: ContextType
+  signatureActorId?: number
 }
 
 export type ActivitypubFollowPayload = {
@@ -52,7 +63,7 @@ export type ActivitypubFollowPayload = {
   assertIsChannel?: boolean
 }
 
-export type FetchType = 'activity' | 'video-likes' | 'video-dislikes' | 'video-shares' | 'video-comments' | 'account-playlists'
+export type FetchType = 'activity' | 'video-shares' | 'video-comments' | 'account-playlists'
 export type ActivitypubHttpFetcherPayload = {
   uri: string
   type: FetchType
@@ -61,9 +72,9 @@ export type ActivitypubHttpFetcherPayload = {
 
 export type ActivitypubHttpUnicastPayload = {
   uri: string
+  contextType: ContextType
   signatureActorId?: number
   body: object
-  contextType?: ContextType
 }
 
 export type RefreshPayload = {
@@ -78,20 +89,32 @@ export type VideoFileImportPayload = {
   filePath: string
 }
 
+// ---------------------------------------------------------------------------
+
 export type VideoImportTorrentPayloadType = 'magnet-uri' | 'torrent-file'
 export type VideoImportYoutubeDLPayloadType = 'youtube-dl'
 
-export type VideoImportYoutubeDLPayload = {
+export interface VideoImportYoutubeDLPayload {
   type: VideoImportYoutubeDLPayloadType
   videoImportId: number
 
   fileExt?: string
 }
-export type VideoImportTorrentPayload = {
+
+export interface VideoImportTorrentPayload {
   type: VideoImportTorrentPayloadType
   videoImportId: number
 }
-export type VideoImportPayload = VideoImportYoutubeDLPayload | VideoImportTorrentPayload
+
+export type VideoImportPayload = (VideoImportYoutubeDLPayload | VideoImportTorrentPayload) & {
+  preventException: boolean
+}
+
+export interface VideoImportPreventExceptionResult {
+  resultType: 'success' | 'error'
+}
+
+// ---------------------------------------------------------------------------
 
 export type VideoRedundancyPayload = {
   videoId: number
@@ -121,33 +144,28 @@ interface BaseTranscodingPayload {
 export interface HLSTranscodingPayload extends BaseTranscodingPayload {
   type: 'new-resolution-to-hls'
   resolution: VideoResolution
+  fps: number
   copyCodecs: boolean
 
-  hasAudio: boolean
-  isPortraitMode?: boolean
-
-  autoDeleteWebTorrentIfNeeded: boolean
-  isMaxQuality: boolean
+  deleteWebTorrentFiles: boolean
 }
 
 export interface NewWebTorrentResolutionTranscodingPayload extends BaseTranscodingPayload {
   type: 'new-resolution-to-webtorrent'
   resolution: VideoResolution
-
-  hasAudio: boolean
-  createHLSIfNeeded: boolean
-
-  isPortraitMode?: boolean
+  fps: number
 }
 
 export interface MergeAudioTranscodingPayload extends BaseTranscodingPayload {
   type: 'merge-audio-to-webtorrent'
   resolution: VideoResolution
-  createHLSIfNeeded: true
+  fps: number
 }
 
 export interface OptimizeTranscodingPayload extends BaseTranscodingPayload {
   type: 'optimize-to-webtorrent'
+
+  quickTranscode: boolean
 }
 
 export type VideoTranscodingPayload =
@@ -158,6 +176,11 @@ export type VideoTranscodingPayload =
 
 export interface VideoLiveEndingPayload {
   videoId: number
+  publishedAt: string
+  liveSessionId: number
+  streamingPlaylistId: number
+
+  replayDirectory?: string
 }
 
 export interface ActorKeysPayload {
@@ -171,11 +194,12 @@ export interface DeleteResumableUploadMetaFilePayload {
 export interface MoveObjectStoragePayload {
   videoUUID: string
   isNewVideo: boolean
+  previousVideoState: VideoState
 }
 
-export type VideoEditorTaskCutPayload = VideoEditorTaskCut
+export type VideoStudioTaskCutPayload = VideoStudioTaskCut
 
-export type VideoEditorTaskIntroPayload = {
+export type VideoStudioTaskIntroPayload = {
   name: 'add-intro'
 
   options: {
@@ -183,7 +207,7 @@ export type VideoEditorTaskIntroPayload = {
   }
 }
 
-export type VideoEditorTaskOutroPayload = {
+export type VideoStudioTaskOutroPayload = {
   name: 'add-outro'
 
   options: {
@@ -191,7 +215,7 @@ export type VideoEditorTaskOutroPayload = {
   }
 }
 
-export type VideoEditorTaskWatermarkPayload = {
+export type VideoStudioTaskWatermarkPayload = {
   name: 'add-watermark'
 
   options: {
@@ -199,13 +223,65 @@ export type VideoEditorTaskWatermarkPayload = {
   }
 }
 
-export type VideoEditionTaskPayload =
-  VideoEditorTaskCutPayload |
-  VideoEditorTaskIntroPayload |
-  VideoEditorTaskOutroPayload |
-  VideoEditorTaskWatermarkPayload
+export type VideoStudioTaskPayload =
+  VideoStudioTaskCutPayload |
+  VideoStudioTaskIntroPayload |
+  VideoStudioTaskOutroPayload |
+  VideoStudioTaskWatermarkPayload
 
-export interface VideoEditionPayload {
+export interface VideoStudioEditionPayload {
   videoUUID: string
-  tasks: VideoEditionTaskPayload[]
+  tasks: VideoStudioTaskPayload[]
+}
+
+// ---------------------------------------------------------------------------
+
+export interface VideoChannelImportPayload {
+  externalChannelUrl: string
+  videoChannelId: number
+
+  partOfChannelSyncId?: number
+}
+
+export interface AfterVideoChannelImportPayload {
+  channelSyncId: number
+}
+
+// ---------------------------------------------------------------------------
+
+export type NotifyPayload =
+  {
+    action: 'new-video'
+    videoUUID: string
+  }
+
+// ---------------------------------------------------------------------------
+
+export interface FederateVideoPayload {
+  videoUUID: string
+  isNewVideo: boolean
+}
+
+// ---------------------------------------------------------------------------
+
+export interface TranscodingJobBuilderPayload {
+  videoUUID: string
+
+  optimizeJob?: {
+    isNewVideo: boolean
+  }
+
+  // Array of jobs to create
+  jobs?: {
+    type: 'video-transcoding'
+    payload: VideoTranscodingPayload
+    priority?: number
+  }[]
+
+  // Array of sequential jobs to create
+  sequentialJobs?: {
+    type: 'video-transcoding'
+    payload: VideoTranscodingPayload
+    priority?: number
+  }[][]
 }