2021-06-02 16:15:41 +00:00
|
|
|
|
2021-07-22 09:15:17 +00:00
|
|
|
import { OutgoingHttpHeaders } from 'http'
|
2020-06-23 12:10:17 +00:00
|
|
|
import { RegisterServerAuthExternalOptions } from '@server/types'
|
|
|
|
import {
|
2020-07-24 13:05:51 +00:00
|
|
|
MAbuseMessage,
|
2020-07-28 09:12:16 +00:00
|
|
|
MAbuseReporter,
|
2020-06-23 12:10:17 +00:00
|
|
|
MAccountBlocklist,
|
2021-04-06 15:01:35 +00:00
|
|
|
MActorFollowActorsDefault,
|
2020-06-23 12:10:17 +00:00
|
|
|
MActorUrl,
|
2021-04-06 15:01:35 +00:00
|
|
|
MChannelBannerAccountDefault,
|
2020-06-23 12:10:17 +00:00
|
|
|
MStreamingPlaylist,
|
|
|
|
MVideoChangeOwnershipFull,
|
|
|
|
MVideoFile,
|
2021-06-11 07:57:19 +00:00
|
|
|
MVideoFormattableDetails,
|
2021-06-11 12:09:33 +00:00
|
|
|
MVideoId,
|
2020-06-23 12:10:17 +00:00
|
|
|
MVideoImmutable,
|
2021-03-03 14:22:38 +00:00
|
|
|
MVideoLive,
|
2020-06-23 12:10:17 +00:00
|
|
|
MVideoPlaylistFull,
|
2021-03-03 14:22:38 +00:00
|
|
|
MVideoPlaylistFullSummary
|
2020-06-23 12:10:17 +00:00
|
|
|
} from '@server/types/models'
|
|
|
|
import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
|
|
|
|
import { MPlugin, MServer, MServerBlocklist } from '@server/types/models/server'
|
|
|
|
import { MVideoImportDefault } from '@server/types/models/video/video-import'
|
|
|
|
import { MVideoPlaylistElement, MVideoPlaylistElementVideoUrlPlaylistPrivacy } from '@server/types/models/video/video-playlist-element'
|
|
|
|
import { MAccountVideoRateAccountVideo } from '@server/types/models/video/video-rate'
|
2021-07-16 08:42:24 +00:00
|
|
|
import { HttpMethod, PeerTubeProblemDocumentData, ServerErrorCode, VideoCreate } from '@shared/models'
|
2021-05-10 09:13:41 +00:00
|
|
|
import { File as UploadXFile, Metadata } from '@uploadx/core'
|
2020-06-18 11:38:20 +00:00
|
|
|
import { RegisteredPlugin } from '../../lib/plugins/plugin-manager'
|
2019-08-15 09:53:26 +00:00
|
|
|
import {
|
|
|
|
MAccountDefault,
|
|
|
|
MActorAccountChannelId,
|
|
|
|
MActorFollowActorsDefaultSubscription,
|
|
|
|
MActorFull,
|
|
|
|
MComment,
|
|
|
|
MCommentOwnerVideoReply,
|
|
|
|
MUserDefault,
|
|
|
|
MVideoBlacklist,
|
|
|
|
MVideoCaptionVideo,
|
|
|
|
MVideoFullLight,
|
|
|
|
MVideoRedundancyVideo,
|
|
|
|
MVideoShareActor,
|
2021-06-11 12:26:37 +00:00
|
|
|
MVideoThumbnail
|
2022-02-11 09:51:33 +00:00
|
|
|
} from './models'
|
2021-07-22 09:15:17 +00:00
|
|
|
import { Writable } from 'stream'
|
2021-06-02 16:15:41 +00:00
|
|
|
|
2019-03-19 09:35:15 +00:00
|
|
|
declare module 'express' {
|
2020-06-18 08:45:25 +00:00
|
|
|
export interface Request {
|
2020-06-17 08:55:40 +00:00
|
|
|
query: any
|
2021-05-10 09:13:41 +00:00
|
|
|
method: HttpMethod
|
2020-06-17 08:55:40 +00:00
|
|
|
}
|
2021-05-10 09:13:41 +00:00
|
|
|
|
|
|
|
// Upload using multer or uploadx middleware
|
|
|
|
export type MulterOrUploadXFile = UploadXFile | Express.Multer.File
|
|
|
|
|
|
|
|
export type UploadFiles = {
|
|
|
|
[fieldname: string]: MulterOrUploadXFile[]
|
|
|
|
} | MulterOrUploadXFile[]
|
|
|
|
|
|
|
|
// Partial object used by some functions to check the file mimetype/extension
|
|
|
|
export type UploadFileForCheck = {
|
|
|
|
originalname: string
|
|
|
|
mimetype: string
|
2022-02-11 09:51:33 +00:00
|
|
|
size: number
|
2021-03-03 14:22:38 +00:00
|
|
|
}
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
export type UploadFilesForCheck = {
|
|
|
|
[fieldname: string]: UploadFileForCheck[]
|
|
|
|
} | UploadFileForCheck[]
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
// Upload file with a duration added by our middleware
|
|
|
|
export type VideoUploadFile = Pick<Express.Multer.File, 'path' | 'filename' | 'size'> & {
|
|
|
|
duration: number
|
|
|
|
}
|
2020-09-17 07:20:52 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
// Extends Metadata property of UploadX object
|
|
|
|
export type UploadXFileMetadata = Metadata & VideoCreate & {
|
|
|
|
previewfile: Express.Multer.File[]
|
|
|
|
thumbnailfile: Express.Multer.File[]
|
|
|
|
}
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
// Our custom UploadXFile object using our custom metadata
|
|
|
|
export type CustomUploadXFile <T extends Metadata> = UploadXFile & { metadata: T }
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
export type EnhancedUploadXFile = CustomUploadXFile<UploadXFileMetadata> & {
|
|
|
|
duration: number
|
|
|
|
path: string
|
|
|
|
filename: string
|
|
|
|
}
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-31 23:36:53 +00:00
|
|
|
// Extends Response with added functions and potential variables passed by middlewares
|
2021-05-10 09:13:41 +00:00
|
|
|
interface Response {
|
2021-05-31 23:36:53 +00:00
|
|
|
fail: (options: {
|
|
|
|
message: string
|
2021-06-02 16:15:41 +00:00
|
|
|
|
|
|
|
title?: string
|
|
|
|
status?: number
|
|
|
|
type?: ServerErrorCode
|
|
|
|
instance?: string
|
|
|
|
|
|
|
|
data?: PeerTubeProblemDocumentData
|
|
|
|
}) => void
|
2021-05-31 23:36:53 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
locals: {
|
2021-07-22 09:15:17 +00:00
|
|
|
apicache: {
|
|
|
|
content: string | Buffer
|
|
|
|
write: Writable['write']
|
|
|
|
writeHead: Response['writeHead']
|
|
|
|
end: Response['end']
|
|
|
|
cacheable: boolean
|
|
|
|
headers: OutgoingHttpHeaders
|
|
|
|
}
|
|
|
|
|
2021-06-02 16:15:41 +00:00
|
|
|
docUrl?: string
|
|
|
|
|
2021-06-11 07:57:19 +00:00
|
|
|
videoAPI?: MVideoFormattableDetails
|
2021-05-10 09:13:41 +00:00
|
|
|
videoAll?: MVideoFullLight
|
|
|
|
onlyImmutableVideo?: MVideoImmutable
|
|
|
|
onlyVideo?: MVideoThumbnail
|
2021-06-11 12:09:33 +00:00
|
|
|
videoId?: MVideoId
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoLive?: MVideoLive
|
2022-05-03 09:38:07 +00:00
|
|
|
videoLiveSession?: MVideoLiveSession
|
2019-08-15 09:53:26 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoShare?: MVideoShareActor
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoFile?: MVideoFile
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoFileResumable?: EnhancedUploadXFile
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoImport?: MVideoImportDefault
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoBlacklist?: MVideoBlacklist
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoCaption?: MVideoCaptionVideo
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
abuse?: MAbuseReporter
|
|
|
|
abuseMessage?: MAbuseMessage
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoStreamingPlaylist?: MStreamingPlaylist
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoChannel?: MChannelBannerAccountDefault
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoPlaylistFull?: MVideoPlaylistFull
|
|
|
|
videoPlaylistSummary?: MVideoPlaylistFullSummary
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoPlaylistElement?: MVideoPlaylistElement
|
|
|
|
videoPlaylistElementAP?: MVideoPlaylistElementVideoUrlPlaylistPrivacy
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
accountVideoRate?: MAccountVideoRateAccountVideo
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
videoCommentFull?: MCommentOwnerVideoReply
|
|
|
|
videoCommentThread?: MComment
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
follow?: MActorFollowActorsDefault
|
|
|
|
subscription?: MActorFollowActorsDefaultSubscription
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
nextOwner?: MAccountDefault
|
|
|
|
videoChangeOwnership?: MVideoChangeOwnershipFull
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
account?: MAccountDefault
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
actorUrl?: MActorUrl
|
|
|
|
actorFull?: MActorFull
|
|
|
|
|
|
|
|
user?: MUserDefault
|
|
|
|
|
|
|
|
server?: MServer
|
|
|
|
|
|
|
|
videoRedundancy?: MVideoRedundancyVideo
|
2019-03-19 09:35:15 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
accountBlock?: MAccountBlocklist
|
|
|
|
serverBlock?: MServerBlocklist
|
2019-07-05 11:54:32 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
oauth?: {
|
|
|
|
token: MOAuthTokenUser
|
|
|
|
}
|
2019-07-10 14:59:53 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
signature?: {
|
|
|
|
actor: MActorAccountChannelId
|
|
|
|
}
|
2020-04-28 12:49:03 +00:00
|
|
|
|
2021-05-10 09:13:41 +00:00
|
|
|
authenticated?: boolean
|
|
|
|
|
|
|
|
registeredPlugin?: RegisteredPlugin
|
|
|
|
|
|
|
|
externalAuth?: RegisterServerAuthExternalOptions
|
|
|
|
|
|
|
|
plugin?: MPlugin
|
2022-03-24 12:36:47 +00:00
|
|
|
|
|
|
|
localViewerFull?: MLocalVideoViewerWithWatchSections
|
2021-05-10 09:13:41 +00:00
|
|
|
}
|
|
|
|
}
|
2019-03-19 09:35:15 +00:00
|
|
|
}
|