server/typings/express/index.d.ts

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