1 import { Router, Response } from 'express'
2 import { Logger } from 'winston'
3 import { ActorModel } from '@server/models/activitypub/actor'
5 PluginPlaylistPrivacyManager,
8 PluginTranscodingManager,
9 PluginVideoCategoryManager,
10 PluginVideoLanguageManager,
11 PluginVideoLicenceManager,
12 PluginVideoPrivacyManager,
13 RegisterServerHookOptions,
14 RegisterServerSettingOptions,
18 } from '@shared/models'
19 import { MVideoThumbnail } from '../models'
21 RegisterServerAuthExternalOptions,
22 RegisterServerAuthExternalResult,
23 RegisterServerAuthPassOptions
24 } from './register-server-auth.model'
26 export type PeerTubeHelpers = {
34 loadByUrl: (url: string) => Promise<MVideoThumbnail>
35 loadByIdOrUUID: (id: number | string) => Promise<MVideoThumbnail>
37 removeVideo: (videoId: number) => Promise<void>
41 getWebserverUrl: () => string
43 getServerConfig: () => Promise<ServerConfig>
47 blockServer: (options: { byAccountId: number, hostToBlock: string }) => Promise<void>
48 unblockServer: (options: { byAccountId: number, hostToUnblock: string }) => Promise<void>
49 blockAccount: (options: { byAccountId: number, handleToBlock: string }) => Promise<void>
50 unblockAccount: (options: { byAccountId: number, handleToUnblock: string }) => Promise<void>
52 blacklistVideo: (options: { videoIdOrUUID: number | string, createOptions: VideoBlacklistCreate }) => Promise<void>
53 unblacklistVideo: (options: { videoIdOrUUID: number | string }) => Promise<void>
57 getServerActor: () => Promise<ActorModel>
61 getBaseStaticRoute: () => string
63 getBaseRouterRoute: () => string
65 getDataDirectoryPath: () => string
69 getAuthUser: (response: Response) => {
79 export type RegisterServerOptions = {
80 registerHook: (options: RegisterServerHookOptions) => void
82 registerSetting: (options: RegisterServerSettingOptions) => void
84 settingsManager: PluginSettingsManager
86 storageManager: PluginStorageManager
88 videoCategoryManager: PluginVideoCategoryManager
89 videoLanguageManager: PluginVideoLanguageManager
90 videoLicenceManager: PluginVideoLicenceManager
92 videoPrivacyManager: PluginVideoPrivacyManager
93 playlistPrivacyManager: PluginPlaylistPrivacyManager
95 transcodingManager: PluginTranscodingManager
97 registerIdAndPassAuth: (options: RegisterServerAuthPassOptions) => void
98 registerExternalAuth: (options: RegisterServerAuthExternalOptions) => RegisterServerAuthExternalResult
99 unregisterIdAndPassAuth: (authName: string) => void
100 unregisterExternalAuth: (authName: string) => void
102 // Get plugin router to create custom routes
103 // Base routes of this router are
104 // * /plugins/:pluginName/:pluginVersion/router/...
105 // * /plugins/:pluginName/router/...
108 peertubeHelpers: PeerTubeHelpers