aboutsummaryrefslogtreecommitdiffhomepage
path: root/server/typings/express/index.d.ts
blob: 66acfb3f5ea7c4db9f6de142cba09988a9b4c9c8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
import { RegisterServerAuthExternalOptions } from '@server/types'
import {
  MAbuseMessage,
  MAbuseReporter,
  MAccountBlocklist,
  MActorUrl,
  MStreamingPlaylist,
  MVideoChangeOwnershipFull,
  MVideoFile,
  MVideoImmutable,
  MVideoLive,
  MVideoPlaylistFull,
  MVideoPlaylistFullSummary
} 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'
import { UserRole } from '@shared/models'
import { RegisteredPlugin } from '../../lib/plugins/plugin-manager'
import {
  MAccountDefault,
  MActorAccountChannelId,
  MActorFollowActorsDefault,
  MActorFollowActorsDefaultSubscription,
  MActorFull,
  MChannelAccountDefault,
  MComment,
  MCommentOwnerVideoReply,
  MUserDefault,
  MVideoBlacklist,
  MVideoCaptionVideo,
  MVideoFullLight,
  MVideoIdThumbnail,
  MVideoRedundancyVideo,
  MVideoShareActor,
  MVideoThumbnail,
  MVideoWithRights
} from '../../types/models'

declare module 'express' {
  export interface Request {
    query: any
  }
  interface Response {
    locals: PeerTubeLocals
  }
}

interface PeerTubeLocals {
  bypassLogin?: {
    bypass: boolean
    pluginName: string
    authName?: string
    user: {
      username: string
      email: string
      displayName: string
      role: UserRole
    }
  }

  refreshTokenAuthName?: string

  explicitLogout?: boolean

  videoAll?: MVideoFullLight
  onlyImmutableVideo?: MVideoImmutable
  onlyVideo?: MVideoThumbnail
  onlyVideoWithRights?: MVideoWithRights
  videoId?: MVideoIdThumbnail

  videoLive?: MVideoLive

  videoShare?: MVideoShareActor

  videoFile?: MVideoFile

  videoImport?: MVideoImportDefault

  videoBlacklist?: MVideoBlacklist

  videoCaption?: MVideoCaptionVideo

  abuse?: MAbuseReporter
  abuseMessage?: MAbuseMessage

  videoStreamingPlaylist?: MStreamingPlaylist

  videoChannel?: MChannelAccountDefault

  videoPlaylistFull?: MVideoPlaylistFull
  videoPlaylistSummary?: MVideoPlaylistFullSummary

  videoPlaylistElement?: MVideoPlaylistElement
  videoPlaylistElementAP?: MVideoPlaylistElementVideoUrlPlaylistPrivacy

  accountVideoRate?: MAccountVideoRateAccountVideo

  videoCommentFull?: MCommentOwnerVideoReply
  videoCommentThread?: MComment

  follow?: MActorFollowActorsDefault
  subscription?: MActorFollowActorsDefaultSubscription

  nextOwner?: MAccountDefault
  videoChangeOwnership?: MVideoChangeOwnershipFull

  account?: MAccountDefault

  actorUrl?: MActorUrl
  actorFull?: MActorFull

  user?: MUserDefault

  server?: MServer

  videoRedundancy?: MVideoRedundancyVideo

  accountBlock?: MAccountBlocklist
  serverBlock?: MServerBlocklist

  oauth?: {
    token: MOAuthTokenUser
  }

  signature?: {
    actor: MActorAccountChannelId
  }

  authenticated?: boolean

  registeredPlugin?: RegisteredPlugin

  externalAuth?: RegisterServerAuthExternalOptions

  plugin?: MPlugin
}