Peertube/packages/models/src/server/server-config.model.ts

import { ActorImage, LogoType, VideoCommentPolicyType } from '../index.js'
import { ClientScriptJSON } from '../plugins/plugin-package-json.model.js'
import { NSFWPolicyType } from '../videos/nsfw-policy.type.js'
import { VideoPrivacyType } from '../videos/video-privacy.enum.js'
import { BroadcastMessageLevel } from './broadcast-message-level.type.js'

export interface ServerConfigPlugin {
  name: string
  npmName: string
  version: string
  description: string
  clientScripts: { [name: string]: ClientScriptJSON }
}

export interface ServerConfigTheme extends ServerConfigPlugin {
  css: string[]
}

export interface RegisteredExternalAuthConfig {
  npmName: string
  name: string
  version: string
  authName: string
  authDisplayName: string
}

export interface RegisteredIdAndPassAuthConfig {
  npmName: string
  name: string
  version: string
  authName: string
  weight: number
}

export interface ServerConfig {
  serverVersion: string
  serverCommit?: string

  client: {
    header: {
      hideInstanceName: boolean
    }

    videos: {
      miniature: {
        preferAuthorDisplayName: boolean
      }
      resumableUpload: {
        maxChunkSize: number
      }
    }

    browseVideos: {
      defaultSort: string
      defaultScope: string
    }

    menu: {
      login: {
        redirectOnSingleExternalAuth: boolean
      }
    }

    openInApp: {
      android: {
        intent: {
          enabled: boolean
          host: string
          scheme: string
          fallbackUrl: string
        }
      }

      ios: {
        enabled: boolean
        host: string
        scheme: string
        fallbackUrl: string
      }
    }
  }

  defaults: {
    publish: {
      downloadEnabled: boolean

      // TODO: remove, deprecated in 6.2
      commentsEnabled: boolean
      commentsPolicy: VideoCommentPolicyType

      privacy: VideoPrivacyType
      licence: number
    }

    p2p: {
      webapp: {
        enabled: boolean
      }

      embed: {
        enabled: boolean
      }
    }

    player: {
      autoPlay: boolean
    }
  }

  webadmin: {
    configuration: {
      edition: {
        allowed: boolean
      }
    }
  }

  instance: {
    name: string
    shortDescription: string
    isNSFW: boolean
    defaultNSFWPolicy: NSFWPolicyType

    serverCountry: string

    support: {
      text: string
    }

    social: {
      externalLink: string
      mastodonLink: string
      blueskyLink: string
    }

    defaultClientRoute: string
    customizations: {
      javascript: string
      css: string
    }

    avatars: ActorImage[]
    banners: ActorImage[]

    defaultLanguage: string

    logo: {
      type: LogoType
      width: number
      height: number
      fileUrl: string
      isFallback: boolean
    }[]
  }

  search: {
    remoteUri: {
      users: boolean
      anonymous: boolean
    }

    searchIndex: {
      enabled: boolean
      url: string
      disableLocalSearch: boolean
      isDefaultSearch: boolean
    }
  }

  plugin: {
    registered: ServerConfigPlugin[]

    registeredExternalAuths: RegisteredExternalAuthConfig[]

    registeredIdAndPassAuths: RegisteredIdAndPassAuthConfig[]
  }

  theme: {
    registered: ServerConfigTheme[]

    builtIn: { name: 'peertube-core-light-beige' | 'peertube-core-dark-brown' }[]

    default: string

    customization: {
      primaryColor: string
      foregroundColor: string
      backgroundColor: string
      backgroundSecondaryColor: string
      menuForegroundColor: string
      menuBackgroundColor: string
      menuBorderRadius: string
      headerForegroundColor: string
      headerBackgroundColor: string
      inputBorderRadius: string
    }
  }

  email: {
    enabled: boolean
  }

  contactForm: {
    enabled: boolean
  }

  signup: {
    allowed: boolean
    allowedForCurrentIP: boolean
    requiresEmailVerification: boolean
    requiresApproval: boolean
    minimumAge: number
  }

  transcoding: {
    hls: {
      enabled: boolean
    }

    web_videos: {
      enabled: boolean
    }

    enabledResolutions: number[]

    profile: string
    availableProfiles: string[]

    remoteRunners: {
      enabled: boolean
    }
  }

  live: {
    enabled: boolean

    allowReplay: boolean
    latencySetting: {
      enabled: boolean
    }

    maxDuration: number
    maxInstanceLives: number
    maxUserLives: number

    transcoding: {
      enabled: boolean

      remoteRunners: {
        enabled: boolean
      }

      enabledResolutions: number[]

      profile: string
      availableProfiles: string[]
    }

    rtmp: {
      port: number
    }
  }

  videoStudio: {
    enabled: boolean

    remoteRunners: {
      enabled: boolean
    }
  }

  videoFile: {
    update: {
      enabled: boolean
    }
  }

  import: {
    videos: {
      http: {
        enabled: boolean
      }
      torrent: {
        enabled: boolean
      }
    }

    videoChannelSynchronization: {
      enabled: boolean
    }

    users: {
      enabled: boolean
    }
  }

  export: {
    users: {
      enabled: boolean
      exportExpiration: number
      maxUserVideoQuota: number
    }
  }

  autoBlacklist: {
    videos: {
      ofUsers: {
        enabled: boolean
      }
    }
  }

  avatar: {
    file: {
      size: {
        max: number
      }
      extensions: string[]
    }
  }

  banner: {
    file: {
      size: {
        max: number
      }
      extensions: string[]
    }
  }

  video: {
    image: {
      size: {
        max: number
      }
      extensions: string[]
    }
    file: {
      extensions: string[]
    }
  }

  videoCaption: {
    file: {
      size: {
        max: number
      }
      extensions: string[]
    }
  }

  user: {
    videoQuota: number
    videoQuotaDaily: number
  }

  videoChannels: {
    maxPerUser: number
  }

  trending: {
    videos: {
      intervalDays: number
      algorithms: {
        enabled: string[]
        default: string
      }
    }
  }

  tracker: {
    enabled: boolean
  }

  followings: {
    instance: {
      autoFollowIndex: {
        indexUrl: string
      }
    }
  }

  federation: {
    enabled: boolean
  }

  broadcastMessage: {
    enabled: boolean
    message: string
    level: BroadcastMessageLevel
    dismissable: boolean
  }

  homepage: {
    enabled: boolean
  }

  openTelemetry: {
    metrics: {
      enabled: boolean

      // milliseconds
      playbackStatsInterval: number
    }
  }

  views: {
    videos: {
      watchingInterval: {
        // milliseconds
        anonymous: number

        // milliseconds
        users: number
      }
    }
  }

  storyboards: {
    enabled: boolean
    remoteRunners: {
      enabled: boolean
    }
  }

  videoTranscription: {
    enabled: boolean

    remoteRunners: {
      enabled: boolean
    }
  }

  webrtc: {
    stunServers: string[]
  }

  nsfwFlagsSettings: {
    enabled: boolean
  }
}

export type HTMLServerConfig = Omit<ServerConfig, 'signup'>