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,
210 async generateUserAndToken (username: string, role?: UserRole) {
211 const password = 'password'
212 await this.create({ username, password, role })
214 return this.server.login.getAccessToken({ username, password })
217 register (options: OverrideCommandOptions & {
227 const { username, password = 'password', displayName, channel, email = username + '@example.com' } = options
228 const path = '/api/v1/users/register'
230 return this.postBodyRequest({
241 implicitToken: false,
242 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
246 // ---------------------------------------------------------------------------
248 getMyInfo (options: OverrideCommandOptions = {}) {
249 const path = '/api/v1/users/me'
251 return this.getRequestBody<MyUser>({
256 defaultExpectedStatus: HttpStatusCode.OK_200
260 getMyQuotaUsed (options: OverrideCommandOptions = {}) {
261 const path = '/api/v1/users/me/video-quota-used'
263 return this.getRequestBody<UserVideoQuota>({
268 defaultExpectedStatus: HttpStatusCode.OK_200
272 getMyRating (options: OverrideCommandOptions & {
273 videoId: number | string
275 const { videoId } = options
276 const path = '/api/v1/users/me/videos/' + videoId + '/rating'
278 return this.getRequestBody<UserVideoRate>({
283 defaultExpectedStatus: HttpStatusCode.OK_200
287 deleteMe (options: OverrideCommandOptions = {}) {
288 const path = '/api/v1/users/me'
290 return this.deleteRequest({
295 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
299 updateMe (options: OverrideCommandOptions & UserUpdateMe) {
300 const path = '/api/v1/users/me'
302 const toSend: UserUpdateMe = omit(options, [ 'expectedStatus', 'token' ])
304 return this.putBodyRequest({
310 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
314 updateMyAvatar (options: OverrideCommandOptions & {
317 const { fixture } = options
318 const path = '/api/v1/users/me/avatar/pick'
320 return this.updateImageRequest({
325 fieldname: 'avatarfile',
328 defaultExpectedStatus: HttpStatusCode.OK_200
332 // ---------------------------------------------------------------------------
334 get (options: OverrideCommandOptions & {
336 withStats?: boolean // default false
338 const { userId, withStats } = options
339 const path = '/api/v1/users/' + userId
341 return this.getRequestBody<User>({
345 query: { withStats },
347 defaultExpectedStatus: HttpStatusCode.OK_200
351 list (options: OverrideCommandOptions & {
358 const path = '/api/v1/users'
360 return this.getRequestBody<ResultList<User>>({
364 query: pick(options, [ 'start', 'count', 'sort', 'search', 'blocked' ]),
366 defaultExpectedStatus: HttpStatusCode.OK_200
370 remove (options: OverrideCommandOptions & {
373 const { userId } = options
374 const path = '/api/v1/users/' + userId
376 return this.deleteRequest({
381 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
385 update (options: OverrideCommandOptions & {
388 emailVerified?: boolean
390 videoQuotaDaily?: number
392 adminFlags?: UserAdminFlag
396 const path = '/api/v1/users/' + options.userId
398 const toSend: UserUpdate = {}
399 if (options.password !== undefined && options.password !== null) toSend.password = options.password
400 if (options.email !== undefined && options.email !== null) toSend.email = options.email
401 if (options.emailVerified !== undefined && options.emailVerified !== null) toSend.emailVerified = options.emailVerified
402 if (options.videoQuota !== undefined && options.videoQuota !== null) toSend.videoQuota = options.videoQuota
403 if (options.videoQuotaDaily !== undefined && options.videoQuotaDaily !== null) toSend.videoQuotaDaily = options.videoQuotaDaily
404 if (options.role !== undefined && options.role !== null) toSend.role = options.role
405 if (options.adminFlags !== undefined && options.adminFlags !== null) toSend.adminFlags = options.adminFlags
406 if (options.pluginAuth !== undefined) toSend.pluginAuth = options.pluginAuth
408 return this.putBodyRequest({
414 defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204