1 import { omit, pick } from '@shared/core-utils'
15 } from '@shared/models'
16 import { unwrapBody } from '../requests'
17 import { AbstractCommand, OverrideCommandOptions } from '../shared'
19 export class UsersCommand extends AbstractCommand {
21 askResetPassword (options: OverrideCommandOptions & {
24 const { email } = options
25 const path = '/api/v1/users/ask-reset-password'
27 return this.postBodyRequest({
33 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
37 resetPassword (options: OverrideCommandOptions & {
39 verificationString: string
42 const { userId, verificationString, password } = options
43 const path = '/api/v1/users/' + userId + '/reset-password'
45 return this.postBodyRequest({
49 fields: { password, verificationString },
51 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
55 // ---------------------------------------------------------------------------
57 askSendVerifyEmail (options: OverrideCommandOptions & {
60 const { email } = options
61 const path = '/api/v1/users/ask-send-verify-email'
63 return this.postBodyRequest({
69 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
73 verifyEmail (options: OverrideCommandOptions & {
75 verificationString: string
76 isPendingEmail?: boolean // default false
78 const { userId, verificationString, isPendingEmail = false } = options
79 const path = '/api/v1/users/' + userId + '/verify-email'
81 return this.postBodyRequest({
90 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
94 // ---------------------------------------------------------------------------
96 banUser (options: OverrideCommandOptions & {
100 const { userId, reason } = options
101 const path = '/api/v1/users' + '/' + userId + '/block'
103 return this.postBodyRequest({
109 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
113 unbanUser (options: OverrideCommandOptions & {
116 const { userId } = options
117 const path = '/api/v1/users' + '/' + userId + '/unblock'
119 return this.postBodyRequest({
124 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
128 // ---------------------------------------------------------------------------
130 getMyScopedTokens (options: OverrideCommandOptions = {}) {
131 const path = '/api/v1/users/scoped-tokens'
133 return this.getRequestBody<ScopedToken>({
138 defaultExpectedStatus: HttpStatusCode.OK_200
142 renewMyScopedTokens (options: OverrideCommandOptions = {}) {
143 const path = '/api/v1/users/scoped-tokens'
145 return this.postBodyRequest({
150 defaultExpectedStatus: HttpStatusCode.OK_200
154 // ---------------------------------------------------------------------------
156 create (options: OverrideCommandOptions & {
160 videoQuotaDaily?: number
162 adminFlags?: UserAdminFlag
167 password = 'password',
168 videoQuota = 42000000,
169 videoQuotaDaily = -1,
173 const path = '/api/v1/users'
175 return unwrapBody<{ user: UserCreateResult }>(this.postBodyRequest({
184 email: username + '@example.com',
189 defaultExpectedStatus: HttpStatusCode.OK_200
190 })).then(res => res.user)
193 async generate (username: string, role?: UserRole) {
194 const password = 'password'
195 const user = await this.create({ username, password, role })
197 const token = await this.server.login.getAccessToken({ username, password })
199 const me = await this.getMyInfo({ token })
204 userChannelId: me.videoChannels[0].id,
205 userChannelName: me.videoChannels[0].name
209 async generateUserAndToken (username: string, role?: UserRole) {
210 const password = 'password'
211 await this.create({ username, password, role })
213 return this.server.login.getAccessToken({ username, password })
216 register (options: OverrideCommandOptions & {
226 const { username, password = 'password', displayName, channel, email = username + '@example.com' } = options
227 const path = '/api/v1/users/register'
229 return this.postBodyRequest({
240 implicitToken: false,
241 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
245 // ---------------------------------------------------------------------------
247 getMyInfo (options: OverrideCommandOptions = {}) {
248 const path = '/api/v1/users/me'
250 return this.getRequestBody<MyUser>({
255 defaultExpectedStatus: HttpStatusCode.OK_200
259 getMyQuotaUsed (options: OverrideCommandOptions = {}) {
260 const path = '/api/v1/users/me/video-quota-used'
262 return this.getRequestBody<UserVideoQuota>({
267 defaultExpectedStatus: HttpStatusCode.OK_200
271 getMyRating (options: OverrideCommandOptions & {
272 videoId: number | string
274 const { videoId } = options
275 const path = '/api/v1/users/me/videos/' + videoId + '/rating'
277 return this.getRequestBody<UserVideoRate>({
282 defaultExpectedStatus: HttpStatusCode.OK_200
286 deleteMe (options: OverrideCommandOptions = {}) {
287 const path = '/api/v1/users/me'
289 return this.deleteRequest({
294 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
298 updateMe (options: OverrideCommandOptions & UserUpdateMe) {
299 const path = '/api/v1/users/me'
301 const toSend: UserUpdateMe = omit(options, [ 'expectedStatus', 'token' ])
303 return this.putBodyRequest({
309 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
313 updateMyAvatar (options: OverrideCommandOptions & {
316 const { fixture } = options
317 const path = '/api/v1/users/me/avatar/pick'
319 return this.updateImageRequest({
324 fieldname: 'avatarfile',
327 defaultExpectedStatus: HttpStatusCode.OK_200
331 // ---------------------------------------------------------------------------
333 get (options: OverrideCommandOptions & {
335 withStats?: boolean // default false
337 const { userId, withStats } = options
338 const path = '/api/v1/users/' + userId
340 return this.getRequestBody<User>({
344 query: { withStats },
346 defaultExpectedStatus: HttpStatusCode.OK_200
350 list (options: OverrideCommandOptions & {
357 const path = '/api/v1/users'
359 return this.getRequestBody<ResultList<User>>({
363 query: pick(options, [ 'start', 'count', 'sort', 'search', 'blocked' ]),
365 defaultExpectedStatus: HttpStatusCode.OK_200
369 remove (options: OverrideCommandOptions & {
372 const { userId } = options
373 const path = '/api/v1/users/' + userId
375 return this.deleteRequest({
380 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
384 update (options: OverrideCommandOptions & {
387 emailVerified?: boolean
389 videoQuotaDaily?: number
391 adminFlags?: UserAdminFlag
395 const path = '/api/v1/users/' + options.userId
397 const toSend: UserUpdate = {}
398 if (options.password !== undefined && options.password !== null) toSend.password = options.password
399 if (options.email !== undefined && options.email !== null) toSend.email = options.email
400 if (options.emailVerified !== undefined && options.emailVerified !== null) toSend.emailVerified = options.emailVerified
401 if (options.videoQuota !== undefined && options.videoQuota !== null) toSend.videoQuota = options.videoQuota
402 if (options.videoQuotaDaily !== undefined && options.videoQuotaDaily !== null) toSend.videoQuotaDaily = options.videoQuotaDaily
403 if (options.role !== undefined && options.role !== null) toSend.role = options.role
404 if (options.adminFlags !== undefined && options.adminFlags !== null) toSend.adminFlags = options.adminFlags
405 if (options.pluginAuth !== undefined) toSend.pluginAuth = options.pluginAuth
407 return this.putBodyRequest({
413 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204