server/typings/express/index.d.ts

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