server/typings/express/index.d.ts

   1 import { RegisterServerAuthExternalOptions } from '@server/types'
   2 import {
   3   MAbuseMessage,
   4   MAbuseReporter,
   5   MAccountBlocklist,
   6   MActorFollowActorsDefault,
   7   MActorUrl,
   8   MChannelBannerAccountDefault,
   9   MStreamingPlaylist,
  10   MVideoChangeOwnershipFull,
  11   MVideoFile,
  12   MVideoImmutable,
  13   MVideoLive,
  14   MVideoPlaylistFull,
  15   MVideoPlaylistFullSummary
  16 } from '@server/types/models'
  17 import { MOAuthTokenUser } from '@server/types/models/oauth/oauth-token'
  18 import { MPlugin, MServer, MServerBlocklist } from '@server/types/models/server'
  19 import { MVideoImportDefault } from '@server/types/models/video/video-import'
  20 import { MVideoPlaylistElement, MVideoPlaylistElementVideoUrlPlaylistPrivacy } from '@server/types/models/video/video-playlist-element'
  21 import { MAccountVideoRateAccountVideo } from '@server/types/models/video/video-rate'
  22 import { RegisteredPlugin } from '../../lib/plugins/plugin-manager'
  23 import {
  24   MAccountDefault,
  25   MActorAccountChannelId,
  26   MActorFollowActorsDefaultSubscription,
  27   MActorFull,
  28   MComment,
  29   MCommentOwnerVideoReply,
  30   MUserDefault,
  31   MVideoBlacklist,
  32   MVideoCaptionVideo,
  33   MVideoFullLight,
  34   MVideoIdThumbnail,
  35   MVideoRedundancyVideo,
  36   MVideoShareActor,
  37   MVideoThumbnail,
  38   MVideoWithRights
  39 } from '../../types/models'
  40
  41 declare module 'express' {
  42   export interface Request {
  43     query: any
  44   }
  45   interface Response {
  46     locals: PeerTubeLocals
  47   }
  48 }
  49
  50 interface PeerTubeLocals {
  51   videoAll?: MVideoFullLight
  52   onlyImmutableVideo?: MVideoImmutable
  53   onlyVideo?: MVideoThumbnail
  54   onlyVideoWithRights?: MVideoWithRights
  55   videoId?: MVideoIdThumbnail
  56
  57   videoLive?: MVideoLive
  58
  59   videoShare?: MVideoShareActor
  60
  61   videoFile?: MVideoFile
  62
  63   videoImport?: MVideoImportDefault
  64
  65   videoBlacklist?: MVideoBlacklist
  66
  67   videoCaption?: MVideoCaptionVideo
  68
  69   abuse?: MAbuseReporter
  70   abuseMessage?: MAbuseMessage
  71
  72   videoStreamingPlaylist?: MStreamingPlaylist
  73
  74   videoChannel?: MChannelBannerAccountDefault
  75
  76   videoPlaylistFull?: MVideoPlaylistFull
  77   videoPlaylistSummary?: MVideoPlaylistFullSummary
  78
  79   videoPlaylistElement?: MVideoPlaylistElement
  80   videoPlaylistElementAP?: MVideoPlaylistElementVideoUrlPlaylistPrivacy
  81
  82   accountVideoRate?: MAccountVideoRateAccountVideo
  83
  84   videoCommentFull?: MCommentOwnerVideoReply
  85   videoCommentThread?: MComment
  86
  87   follow?: MActorFollowActorsDefault
  88   subscription?: MActorFollowActorsDefaultSubscription
  89
  90   nextOwner?: MAccountDefault
  91   videoChangeOwnership?: MVideoChangeOwnershipFull
  92
  93   account?: MAccountDefault
  94
  95   actorUrl?: MActorUrl
  96   actorFull?: MActorFull
  97
  98   user?: MUserDefault
  99
 100   server?: MServer
 101
 102   videoRedundancy?: MVideoRedundancyVideo
 103
 104   accountBlock?: MAccountBlocklist
 105   serverBlock?: MServerBlocklist
 106
 107   oauth?: {
 108     token: MOAuthTokenUser
 109   }
 110
 111   signature?: {
 112     actor: MActorAccountChannelId
 113   }
 114
 115   authenticated?: boolean
 116
 117   registeredPlugin?: RegisteredPlugin
 118
 119   externalAuth?: RegisterServerAuthExternalOptions
 120
 121   plugin?: MPlugin
 122 }