import {
ClientHookName,
clientHookObject,
- ClientScript,
+ ClientScriptJSON,
HTMLServerConfig,
PluginClientScope,
PluginType,
RegisterClientFormFieldOptions,
RegisterClientHookOptions,
- RegisterClientSettingsScript,
+ RegisterClientRouteOptions,
+ RegisterClientSettingsScriptOptions,
RegisterClientVideoFieldOptions,
+ RegisteredExternalAuthConfig,
ServerConfigPlugin
-} from '../../../shared/models'
+} from '@shared/models'
import { environment } from '../environments/environment'
-import { ClientScript as ClientScriptModule } from '../types/client-script.model'
+import { ClientScript } from '../types'
interface HookStructValue extends RegisterClientHookOptions {
plugin: ServerConfigPlugin
- clientScript: ClientScript
+ clientScript: ClientScriptJSON
}
type Hooks = { [ name: string ]: HookStructValue[] }
type PluginInfo = {
plugin: ServerConfigPlugin
- clientScript: ClientScript
+ clientScript: ClientScriptJSON
pluginType: PluginType
isTheme: boolean
}
type PeertubeHelpersFactory = (pluginInfo: PluginInfo) => RegisterClientHelpers
-type OnFormFields = (options: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
-type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScript) => void
+
+type OnFormFields = (
+ pluginInfo: PluginInfo,
+ options: RegisterClientFormFieldOptions,
+ videoFormOptions: RegisterClientVideoFieldOptions
+) => void
+
+type OnSettingsScripts = (pluginInfo: PluginInfo, options: RegisterClientSettingsScriptOptions) => void
+
+type OnClientRoute = (options: RegisterClientRouteOptions) => void
const logger = debug('peertube:plugins')
private readonly peertubeHelpersFactory: PeertubeHelpersFactory
private readonly onFormFields: OnFormFields
private readonly onSettingsScripts: OnSettingsScripts
+ private readonly onClientRoute: OnClientRoute
constructor (options: {
peertubeHelpersFactory: PeertubeHelpersFactory
onFormFields?: OnFormFields
onSettingsScripts?: OnSettingsScripts
+ onClientRoute?: OnClientRoute
}) {
this.peertubeHelpersFactory = options.peertubeHelpersFactory
this.onFormFields = options.onFormFields
this.onSettingsScripts = options.onSettingsScripts
+ this.onClientRoute = options.onClientRoute
}
static getPluginPathPrefix (isTheme: boolean) {
return isTheme ? '/themes' : '/plugins'
}
+ static getExternalAuthHref (auth: RegisteredExternalAuthConfig) {
+ return environment.apiUrl + `/plugins/${auth.name}/${auth.version}/auth/${auth.authName}`
+
+ }
+
loadPluginsList (config: HTMLServerConfig) {
for (const plugin of config.plugin.registered) {
this.addPlugin(plugin)
throw new Error('Video field registration is not supported')
}
- return this.onFormFields(commonOptions, videoFormOptions)
+ return this.onFormFields(pluginInfo, commonOptions, videoFormOptions)
}
- const registerSettingsScript = (options: RegisterClientSettingsScript) => {
+ const registerSettingsScript = (options: RegisterClientSettingsScriptOptions) => {
if (!this.onSettingsScripts) {
throw new Error('Registering settings script is not supported')
}
return this.onSettingsScripts(pluginInfo, options)
}
+ const registerClientRoute = (options: RegisterClientRouteOptions) => {
+ if (!this.onClientRoute) {
+ throw new Error('Registering client route is not supported')
+ }
+
+ return this.onClientRoute(options)
+ }
+
const peertubeHelpers = this.peertubeHelpersFactory(pluginInfo)
console.log('Loading script %s of plugin %s.', clientScript.script, plugin.name)
const absURL = (environment.apiUrl || window.location.origin) + clientScript.script
return dynamicImport(absURL)
- .then((script: ClientScriptModule) => script.register({ registerHook, registerVideoField, registerSettingsScript, peertubeHelpers }))
+ .then((script: ClientScript) => {
+ return script.register({
+ registerHook,
+ registerVideoField,
+ registerSettingsScript,
+ registerClientRoute,
+ peertubeHelpers
+ })
+ })
.then(() => this.sortHooksByPriority())
.catch(err => console.error('Cannot import or register plugin %s.', pluginInfo.plugin.name, err))
}