PeerTube/shared/extra-utils/videos/video-channels.ts

186 lines
4.9 KiB
TypeScript
Raw Normal View History

2020-01-31 16:56:52 +01:00
/* eslint-disable @typescript-eslint/no-floating-promises */
2017-10-24 19:41:30 +02:00
import * as request from 'supertest'
import { VideoChannelUpdate } from '../../models/videos/channel/video-channel-update.model'
import { VideoChannelCreate } from '../../models/videos/channel/video-channel-create.model'
2021-04-07 10:36:13 +02:00
import { makeDeleteRequest, makeGetRequest, updateImageRequest } from '../requests/requests'
import { ServerInfo } from '../server/servers'
import { User } from '../../models/users/user.model'
import { getMyUserInformation } from '../users/users'
import { HttpStatusCode } from '../../../shared/core-utils/miscs/http-error-codes'
2017-10-24 19:41:30 +02:00
2020-03-27 22:26:39 +01:00
function getVideoChannelsList (url: string, start: number, count: number, sort?: string, withStats?: boolean) {
2018-04-24 17:05:32 +02:00
const path = '/api/v1/video-channels'
2017-10-24 19:41:30 +02:00
const req = request(url)
.get(path)
.query({ start: start })
.query({ count: count })
if (sort) req.query({ sort })
2020-03-27 22:26:39 +01:00
if (withStats) req.query({ withStats })
2017-10-24 19:41:30 +02:00
return req.set('Accept', 'application/json')
.expect(HttpStatusCode.OK_200)
2017-10-24 19:41:30 +02:00
.expect('Content-Type', /json/)
}
function getAccountVideoChannelsList (parameters: {
2020-01-31 16:56:52 +01:00
url: string
accountName: string
start?: number
count?: number
sort?: string
specialStatus?: HttpStatusCode
2020-03-27 22:26:39 +01:00
withStats?: boolean
search?: string
}) {
const {
url,
accountName,
start,
count,
sort = 'createdAt',
specialStatus = HttpStatusCode.OK_200,
withStats = false,
search
} = parameters
2018-05-25 09:57:16 +02:00
const path = '/api/v1/accounts/' + accountName + '/video-channels'
2017-10-24 19:41:30 +02:00
return makeGetRequest({
url,
path,
query: {
start,
count,
2020-03-27 22:26:39 +01:00
sort,
withStats,
search
},
statusCodeExpected: specialStatus
})
2017-10-24 19:41:30 +02:00
}
2018-04-24 17:05:32 +02:00
function addVideoChannel (
url: string,
token: string,
2018-04-26 16:11:38 +02:00
videoChannelAttributesArg: VideoChannelCreate,
expectedStatus = HttpStatusCode.OK_200
2018-04-24 17:05:32 +02:00
) {
const path = '/api/v1/video-channels/'
2017-10-24 19:41:30 +02:00
// Default attributes
let attributes = {
2018-04-26 16:11:38 +02:00
displayName: 'my super video channel',
description: 'my super channel description',
support: 'my super channel support'
2017-10-24 19:41:30 +02:00
}
attributes = Object.assign(attributes, videoChannelAttributesArg)
return request(url)
.post(path)
.send(attributes)
.set('Accept', 'application/json')
.set('Authorization', 'Bearer ' + token)
.expect(expectedStatus)
}
2018-04-24 17:05:32 +02:00
function updateVideoChannel (
url: string,
token: string,
2018-08-24 11:04:02 +02:00
channelName: string,
2018-04-26 16:11:38 +02:00
attributes: VideoChannelUpdate,
expectedStatus = HttpStatusCode.NO_CONTENT_204
2018-04-24 17:05:32 +02:00
) {
const body: any = {}
2018-08-24 11:04:02 +02:00
const path = '/api/v1/video-channels/' + channelName
2017-10-24 19:41:30 +02:00
if (attributes.displayName) body.displayName = attributes.displayName
if (attributes.description) body.description = attributes.description
if (attributes.support) body.support = attributes.support
if (attributes.bulkVideosSupportUpdate) body.bulkVideosSupportUpdate = attributes.bulkVideosSupportUpdate
2017-10-24 19:41:30 +02:00
return request(url)
.put(path)
.send(body)
.set('Accept', 'application/json')
.set('Authorization', 'Bearer ' + token)
.expect(expectedStatus)
}
function deleteVideoChannel (url: string, token: string, channelName: string, expectedStatus = HttpStatusCode.NO_CONTENT_204) {
2018-08-24 11:04:02 +02:00
const path = '/api/v1/video-channels/' + channelName
2017-10-24 19:41:30 +02:00
return request(url)
2018-04-24 17:05:32 +02:00
.delete(path)
2017-10-24 19:41:30 +02:00
.set('Accept', 'application/json')
.set('Authorization', 'Bearer ' + token)
.expect(expectedStatus)
}
2018-08-24 11:04:02 +02:00
function getVideoChannel (url: string, channelName: string) {
const path = '/api/v1/video-channels/' + channelName
2017-10-24 19:41:30 +02:00
return request(url)
.get(path)
.set('Accept', 'application/json')
.expect(HttpStatusCode.OK_200)
2017-10-24 19:41:30 +02:00
.expect('Content-Type', /json/)
}
2021-04-07 10:36:13 +02:00
function updateVideoChannelImage (options: {
2020-01-31 16:56:52 +01:00
url: string
accessToken: string
fixture: string
2018-08-17 15:45:42 +02:00
videoChannelName: string | number
2021-04-07 10:36:13 +02:00
type: 'avatar' | 'banner'
}) {
2021-04-07 10:36:13 +02:00
const path = `/api/v1/video-channels/${options.videoChannelName}/${options.type}/pick`
2021-04-07 10:36:13 +02:00
return updateImageRequest({ ...options, path, fieldname: options.type + 'file' })
}
function deleteVideoChannelImage (options: {
url: string
accessToken: string
videoChannelName: string | number
type: 'avatar' | 'banner'
}) {
const path = `/api/v1/video-channels/${options.videoChannelName}/${options.type}`
2021-04-07 10:36:13 +02:00
return makeDeleteRequest({
url: options.url,
token: options.accessToken,
path,
statusCodeExpected: 204
})
}
2019-03-05 10:58:44 +01:00
function setDefaultVideoChannel (servers: ServerInfo[]) {
const tasks: Promise<any>[] = []
for (const server of servers) {
const p = getMyUserInformation(server.url, server.accessToken)
2020-01-31 16:56:52 +01:00
.then(res => { server.videoChannel = (res.body as User).videoChannels[0] })
2019-03-05 10:58:44 +01:00
tasks.push(p)
}
return Promise.all(tasks)
}
2017-10-24 19:41:30 +02:00
// ---------------------------------------------------------------------------
export {
2021-04-07 10:36:13 +02:00
updateVideoChannelImage,
2017-10-24 19:41:30 +02:00
getVideoChannelsList,
2017-11-17 12:05:59 +01:00
getAccountVideoChannelsList,
2017-10-24 19:41:30 +02:00
addVideoChannel,
updateVideoChannel,
deleteVideoChannel,
2019-03-05 10:58:44 +01:00
getVideoChannel,
2021-04-07 10:36:13 +02:00
setDefaultVideoChannel,
deleteVideoChannelImage
2017-10-24 19:41:30 +02:00
}