shared/extra-utils/server/config.ts

   1 import { makeDeleteRequest, makeGetRequest, makePutBodyRequest } from '../requests/requests'
   2 import { CustomConfig } from '../../models/server/custom-config.model'
   3 import { DeepPartial, HttpStatusCode } from '@shared/core-utils'
   4 import { merge } from 'lodash'
   5
   6 function getConfig (url: string) {
   7   const path = '/api/v1/config'
   8
   9   return makeGetRequest({
  10     url,
  11     path,
  12     statusCodeExpected: HttpStatusCode.OK_200
  13   })
  14 }
  15
  16 function getAbout (url: string) {
  17   const path = '/api/v1/config/about'
  18
  19   return makeGetRequest({
  20     url,
  21     path,
  22     statusCodeExpected: HttpStatusCode.OK_200
  23   })
  24 }
  25
  26 function getCustomConfig (url: string, token: string, statusCodeExpected = HttpStatusCode.OK_200) {
  27   const path = '/api/v1/config/custom'
  28
  29   return makeGetRequest({
  30     url,
  31     token,
  32     path,
  33     statusCodeExpected
  34   })
  35 }
  36
  37 function updateCustomConfig (url: string, token: string, newCustomConfig: CustomConfig, statusCodeExpected = HttpStatusCode.OK_200) {
  38   const path = '/api/v1/config/custom'
  39
  40   return makePutBodyRequest({
  41     url,
  42     token,
  43     path,
  44     fields: newCustomConfig,
  45     statusCodeExpected
  46   })
  47 }
  48
  49 function updateCustomSubConfig (url: string, token: string, newConfig: DeepPartial<CustomConfig>) {
  50   const updateParams: CustomConfig = {
  51     instance: {
  52       name: 'PeerTube updated',
  53       shortDescription: 'my short description',
  54       description: 'my super description',
  55       terms: 'my super terms',
  56       codeOfConduct: 'my super coc',
  57
  58       creationReason: 'my super creation reason',
  59       moderationInformation: 'my super moderation information',
  60       administrator: 'Kuja',
  61       maintenanceLifetime: 'forever',
  62       businessModel: 'my super business model',
  63       hardwareInformation: '2vCore 3GB RAM',
  64
  65       languages: [ 'en', 'es' ],
  66       categories: [ 1, 2 ],
  67
  68       isNSFW: true,
  69       defaultNSFWPolicy: 'blur',
  70
  71       defaultClientRoute: '/videos/recently-added',
  72
  73       customizations: {
  74         javascript: 'alert("coucou")',
  75         css: 'body { background-color: red; }'
  76       }
  77     },
  78     theme: {
  79       default: 'default'
  80     },
  81     services: {
  82       twitter: {
  83         username: '@MySuperUsername',
  84         whitelisted: true
  85       }
  86     },
  87     cache: {
  88       previews: {
  89         size: 2
  90       },
  91       captions: {
  92         size: 3
  93       },
  94       torrents: {
  95         size: 4
  96       }
  97     },
  98     signup: {
  99       enabled: false,
 100       limit: 5,
 101       requiresEmailVerification: false,
 102       minimumAge: 16
 103     },
 104     admin: {
 105       email: 'superadmin1@example.com'
 106     },
 107     contactForm: {
 108       enabled: true
 109     },
 110     user: {
 111       videoQuota: 5242881,
 112       videoQuotaDaily: 318742
 113     },
 114     transcoding: {
 115       enabled: true,
 116       allowAdditionalExtensions: true,
 117       allowAudioFiles: true,
 118       threads: 1,
 119       concurrency: 3,
 120       profile: 'default',
 121       resolutions: {
 122         '0p': false,
 123         '240p': false,
 124         '360p': true,
 125         '480p': true,
 126         '720p': false,
 127         '1080p': false,
 128         '1440p': false,
 129         '2160p': false
 130       },
 131       webtorrent: {
 132         enabled: true
 133       },
 134       hls: {
 135         enabled: false
 136       }
 137     },
 138     live: {
 139       enabled: true,
 140       allowReplay: false,
 141       maxDuration: -1,
 142       maxInstanceLives: -1,
 143       maxUserLives: 50,
 144       transcoding: {
 145         enabled: true,
 146         threads: 4,
 147         profile: 'default',
 148         resolutions: {
 149           '240p': true,
 150           '360p': true,
 151           '480p': true,
 152           '720p': true,
 153           '1080p': true,
 154           '1440p': true,
 155           '2160p': true
 156         }
 157       }
 158     },
 159     import: {
 160       videos: {
 161         concurrency: 3,
 162         http: {
 163           enabled: false
 164         },
 165         torrent: {
 166           enabled: false
 167         }
 168       }
 169     },
 170     trending: {
 171       videos: {
 172         algorithms: {
 173           enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
 174           default: 'hot'
 175         }
 176       }
 177     },
 178     autoBlacklist: {
 179       videos: {
 180         ofUsers: {
 181           enabled: false
 182         }
 183       }
 184     },
 185     followers: {
 186       instance: {
 187         enabled: true,
 188         manualApproval: false
 189       }
 190     },
 191     followings: {
 192       instance: {
 193         autoFollowBack: {
 194           enabled: false
 195         },
 196         autoFollowIndex: {
 197           indexUrl: 'https://instances.joinpeertube.org/api/v1/instances/hosts',
 198           enabled: false
 199         }
 200       }
 201     },
 202     broadcastMessage: {
 203       enabled: true,
 204       level: 'warning',
 205       message: 'hello',
 206       dismissable: true
 207     },
 208     search: {
 209       remoteUri: {
 210         users: true,
 211         anonymous: true
 212       },
 213       searchIndex: {
 214         enabled: true,
 215         url: 'https://search.joinpeertube.org',
 216         disableLocalSearch: true,
 217         isDefaultSearch: true
 218       }
 219     }
 220   }
 221
 222   merge(updateParams, newConfig)
 223
 224   return updateCustomConfig(url, token, updateParams)
 225 }
 226
 227 function getCustomConfigResolutions (enabled: boolean) {
 228   return {
 229     '240p': enabled,
 230     '360p': enabled,
 231     '480p': enabled,
 232     '720p': enabled,
 233     '1080p': enabled,
 234     '1440p': enabled,
 235     '2160p': enabled
 236   }
 237 }
 238
 239 function deleteCustomConfig (url: string, token: string, statusCodeExpected = HttpStatusCode.OK_200) {
 240   const path = '/api/v1/config/custom'
 241
 242   return makeDeleteRequest({
 243     url,
 244     token,
 245     path,
 246     statusCodeExpected
 247   })
 248 }
 249
 250 // ---------------------------------------------------------------------------
 251
 252 export {
 253   getConfig,
 254   getCustomConfig,
 255   updateCustomConfig,
 256   getAbout,
 257   deleteCustomConfig,
 258   updateCustomSubConfig,
 259   getCustomConfigResolutions
 260 }