client/src/types/register-client-option.model.ts

   1 import {
   2   RegisterClientFormFieldOptions,
   3   RegisterClientHookOptions,
   4   RegisterClientSettingsScript,
   5   RegisterClientVideoFieldOptions,
   6   ServerConfig
   7 } from '@shared/models'
   8
   9 export type RegisterClientOptions = {
  10   registerHook: (options: RegisterClientHookOptions) => void
  11
  12   registerVideoField: (commonOptions: RegisterClientFormFieldOptions, videoFormOptions: RegisterClientVideoFieldOptions) => void
  13
  14   registerSettingsScript: (options: RegisterClientSettingsScript) => void
  15
  16   peertubeHelpers: RegisterClientHelpers
  17 }
  18
  19 export type RegisterClientHelpers = {
  20   getBaseStaticRoute: () => string
  21
  22   isLoggedIn: () => boolean
  23
  24   getAuthHeader: () => { 'Authorization': string } | undefined
  25
  26   getSettings: () => Promise<{ [ name: string ]: string }>
  27
  28   getServerConfig: () => Promise<ServerConfig>
  29
  30   notifier: {
  31     info: (text: string, title?: string, timeout?: number) => void,
  32     error: (text: string, title?: string, timeout?: number) => void,
  33     success: (text: string, title?: string, timeout?: number) => void
  34   }
  35
  36   showModal: (input: {
  37     title: string,
  38     content: string,
  39     close?: boolean,
  40     cancel?: { value: string, action?: () => void },
  41     confirm?: { value: string, action?: () => void }
  42   }) => void
  43
  44   markdownRenderer: {
  45     textMarkdownToHTML: (textMarkdown: string) => Promise<string>
  46     enhancedMarkdownToHTML: (enhancedMarkdown: string) => Promise<string>
  47   }
  48
  49   translate: (toTranslate: string) => Promise<string>
  50 }