server/types/plugins/register-server-option.model.ts

   1 import { Response, Router } from 'express'
   2 import { Server } from 'http'
   3 import { Logger } from 'winston'
   4 import { ActorModel } from '@server/models/actor/actor'
   5 import {
   6   PluginPlaylistPrivacyManager,
   7   PluginSettingsManager,
   8   PluginStorageManager,
   9   PluginTranscodingManager,
  10   PluginVideoCategoryManager,
  11   PluginVideoLanguageManager,
  12   PluginVideoLicenceManager,
  13   PluginVideoPrivacyManager,
  14   RegisterServerHookOptions,
  15   RegisterServerSettingOptions,
  16   ServerConfig,
  17   ThumbnailType,
  18   VideoBlacklistCreate
  19 } from '@shared/models'
  20 import { MUserDefault, MVideo, MVideoThumbnail, UserNotificationModelForApi } from '../models'
  21 import {
  22   RegisterServerAuthExternalOptions,
  23   RegisterServerAuthExternalResult,
  24   RegisterServerAuthPassOptions
  25 } from './register-server-auth.model'
  26 import { RegisterServerWebSocketRouteOptions } from './register-server-websocket-route.model'
  27
  28 export type PeerTubeHelpers = {
  29   logger: Logger
  30
  31   database: {
  32     query: Function
  33   }
  34
  35   videos: {
  36     loadByUrl: (url: string) => Promise<MVideoThumbnail>
  37     loadByIdOrUUID: (id: number | string) => Promise<MVideoThumbnail>
  38
  39     removeVideo: (videoId: number) => Promise<void>
  40
  41     ffprobe: (path: string) => Promise<any>
  42
  43     getFiles: (id: number | string) => Promise<{
  44       webtorrent: {
  45         videoFiles: {
  46           path: string // Could be null if using remote storage
  47           url: string
  48           resolution: number
  49           size: number
  50           fps: number
  51         }[]
  52       }
  53
  54       hls: {
  55         videoFiles: {
  56           path: string // Could be null if using remote storage
  57           url: string
  58           resolution: number
  59           size: number
  60           fps: number
  61         }[]
  62       }
  63
  64       thumbnails: {
  65         type: ThumbnailType
  66         path: string
  67       }[]
  68     }>
  69   }
  70
  71   config: {
  72     getWebserverUrl: () => string
  73
  74     // PeerTube >= 5.1
  75     getServerListeningConfig: () => { hostname: string, port: number }
  76
  77     getServerConfig: () => Promise<ServerConfig>
  78   }
  79
  80   moderation: {
  81     blockServer: (options: { byAccountId: number, hostToBlock: string }) => Promise<void>
  82     unblockServer: (options: { byAccountId: number, hostToUnblock: string }) => Promise<void>
  83     blockAccount: (options: { byAccountId: number, handleToBlock: string }) => Promise<void>
  84     unblockAccount: (options: { byAccountId: number, handleToUnblock: string }) => Promise<void>
  85
  86     blacklistVideo: (options: { videoIdOrUUID: number | string, createOptions: VideoBlacklistCreate }) => Promise<void>
  87     unblacklistVideo: (options: { videoIdOrUUID: number | string }) => Promise<void>
  88   }
  89
  90   server: {
  91     // PeerTube >= 5.0
  92     getHTTPServer: () => Server
  93
  94     getServerActor: () => Promise<ActorModel>
  95   }
  96
  97   socket: {
  98     sendNotification: (userId: number, notification: UserNotificationModelForApi) => void
  99     sendVideoLiveNewState: (video: MVideo) => void
 100   }
 101
 102   plugin: {
 103     // PeerTube >= 3.2
 104     getBaseStaticRoute: () => string
 105
 106     // PeerTube >= 3.2
 107     getBaseRouterRoute: () => string
 108     // PeerTube >= 5.0
 109     getBaseWebSocketRoute: () => string
 110
 111     // PeerTube >= 3.2
 112     getDataDirectoryPath: () => string
 113   }
 114
 115   user: {
 116     // PeerTube >= 3.2
 117     getAuthUser: (response: Response) => Promise<MUserDefault>
 118
 119     // PeerTube >= 4.3
 120     loadById: (id: number) => Promise<MUserDefault>
 121   }
 122 }
 123
 124 export type RegisterServerOptions = {
 125   registerHook: (options: RegisterServerHookOptions) => void
 126
 127   registerSetting: (options: RegisterServerSettingOptions) => void
 128
 129   settingsManager: PluginSettingsManager
 130
 131   storageManager: PluginStorageManager
 132
 133   videoCategoryManager: PluginVideoCategoryManager
 134   videoLanguageManager: PluginVideoLanguageManager
 135   videoLicenceManager: PluginVideoLicenceManager
 136
 137   videoPrivacyManager: PluginVideoPrivacyManager
 138   playlistPrivacyManager: PluginPlaylistPrivacyManager
 139
 140   transcodingManager: PluginTranscodingManager
 141
 142   registerIdAndPassAuth: (options: RegisterServerAuthPassOptions) => void
 143   registerExternalAuth: (options: RegisterServerAuthExternalOptions) => RegisterServerAuthExternalResult
 144   unregisterIdAndPassAuth: (authName: string) => void
 145   unregisterExternalAuth: (authName: string) => void
 146
 147   // Get plugin router to create custom routes
 148   // Base routes of this router are
 149   //  * /plugins/:pluginName/:pluginVersion/router/...
 150   //  * /plugins/:pluginName/router/...
 151   getRouter(): Router
 152
 153   // PeerTube >= 5.0
 154   // Register WebSocket route
 155   // Base routes of the WebSocket router are
 156   //  * /plugins/:pluginName/:pluginVersion/ws/...
 157   //  * /plugins/:pluginName/ws/...
 158   registerWebSocketRoute: (options: RegisterServerWebSocketRouteOptions) => void
 159
 160   peertubeHelpers: PeerTubeHelpers
 161 }