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     },
  95     signup: {
  96       enabled: false,
  97       limit: 5,
  98       requiresEmailVerification: false
  99     },
 100     admin: {
 101       email: 'superadmin1@example.com'
 102     },
 103     contactForm: {
 104       enabled: true
 105     },
 106     user: {
 107       videoQuota: 5242881,
 108       videoQuotaDaily: 318742
 109     },
 110     transcoding: {
 111       enabled: true,
 112       allowAdditionalExtensions: true,
 113       allowAudioFiles: true,
 114       threads: 1,
 115       profile: 'default',
 116       resolutions: {
 117         '0p': false,
 118         '240p': false,
 119         '360p': true,
 120         '480p': true,
 121         '720p': false,
 122         '1080p': false,
 123         '1440p': false,
 124         '2160p': false
 125       },
 126       webtorrent: {
 127         enabled: true
 128       },
 129       hls: {
 130         enabled: false
 131       }
 132     },
 133     live: {
 134       enabled: true,
 135       allowReplay: false,
 136       maxDuration: -1,
 137       maxInstanceLives: -1,
 138       maxUserLives: 50,
 139       transcoding: {
 140         enabled: true,
 141         threads: 4,
 142         profile: 'default',
 143         resolutions: {
 144           '240p': true,
 145           '360p': true,
 146           '480p': true,
 147           '720p': true,
 148           '1080p': true,
 149           '1440p': true,
 150           '2160p': true
 151         }
 152       }
 153     },
 154     import: {
 155       videos: {
 156         http: {
 157           enabled: false
 158         },
 159         torrent: {
 160           enabled: false
 161         }
 162       }
 163     },
 164     trending: {
 165       videos: {
 166         algorithms: {
 167           enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
 168           default: 'hot'
 169         }
 170       }
 171     },
 172     autoBlacklist: {
 173       videos: {
 174         ofUsers: {
 175           enabled: false
 176         }
 177       }
 178     },
 179     followers: {
 180       instance: {
 181         enabled: true,
 182         manualApproval: false
 183       }
 184     },
 185     followings: {
 186       instance: {
 187         autoFollowBack: {
 188           enabled: false
 189         },
 190         autoFollowIndex: {
 191           indexUrl: 'https://instances.joinpeertube.org/api/v1/instances/hosts',
 192           enabled: false
 193         }
 194       }
 195     },
 196     broadcastMessage: {
 197       enabled: true,
 198       level: 'warning',
 199       message: 'hello',
 200       dismissable: true
 201     },
 202     search: {
 203       remoteUri: {
 204         users: true,
 205         anonymous: true
 206       },
 207       searchIndex: {
 208         enabled: true,
 209         url: 'https://search.joinpeertube.org',
 210         disableLocalSearch: true,
 211         isDefaultSearch: true
 212       }
 213     }
 214   }
 215
 216   merge(updateParams, newConfig)
 217
 218   return updateCustomConfig(url, token, updateParams)
 219 }
 220
 221 function deleteCustomConfig (url: string, token: string, statusCodeExpected = HttpStatusCode.OK_200) {
 222   const path = '/api/v1/config/custom'
 223
 224   return makeDeleteRequest({
 225     url,
 226     token,
 227     path,
 228     statusCodeExpected
 229   })
 230 }
 231
 232 // ---------------------------------------------------------------------------
 233
 234 export {
 235   getConfig,
 236   getCustomConfig,
 237   updateCustomConfig,
 238   getAbout,
 239   deleteCustomConfig,
 240   updateCustomSubConfig
 241 }