server/typings/express/index.d.ts

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