2 RegisterClientFormFieldOptions,
3 RegisterClientHookOptions,
4 RegisterClientRouteOptions,
5 RegisterClientSettingsScriptOptions,
6 RegisterClientVideoFieldOptions,
7 ServerConfig, SettingEntries
8 } from '@shared/models'
10 export type RegisterClientOptions = {
11 registerHook: (options: RegisterClientHookOptions) => void
13 registerVideoField: (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
15 registerSettingsScript: (options: RegisterClientSettingsScriptOptions) => void
17 registerClientRoute: (options: RegisterClientRouteOptions) => void
19 peertubeHelpers: RegisterClientHelpers
22 export type RegisterClientHelpers = {
23 getBaseStaticRoute: () => string
25 getBaseRouterRoute: () => string
27 getBasePluginClientPath: () => string
29 isLoggedIn: () => boolean
31 getAuthHeader: () => { 'Authorization': string } | undefined
33 getSettings: () => Promise<SettingEntries>
35 getServerConfig: () => Promise<ServerConfig>
38 info: (text: string, title?: string, timeout?: number) => void
39 error: (text: string, title?: string, timeout?: number) => void
40 success: (text: string, title?: string, timeout?: number) => void
47 cancel?: { value: string, action?: () => void }
48 confirm?: { value: string, action?: () => void }
52 textMarkdownToHTML: (textMarkdown: string) => Promise<string>
53 enhancedMarkdownToHTML: (enhancedMarkdown: string) => Promise<string>
56 translate: (toTranslate: string) => Promise<string>