shared/server-commands/users/users-command.ts

   1 import { omit, pick } from '@shared/core-utils'
   2 import {
   3   HttpStatusCode,
   4   MyUser,
   5   ResultList,
   6   ScopedToken,
   7   User,
   8   UserAdminFlag,
   9   UserCreateResult,
  10   UserRole,
  11   UserUpdate,
  12   UserUpdateMe,
  13   UserVideoQuota,
  14   UserVideoRate
  15 } from '@shared/models'
  16 import { unwrapBody } from '../requests'
  17 import { AbstractCommand, OverrideCommandOptions } from '../shared'
  18
  19 export class UsersCommand extends AbstractCommand {
  20
  21   askResetPassword (options: OverrideCommandOptions & {
  22     email: string
  23   }) {
  24     const { email } = options
  25     const path = '/api/v1/users/ask-reset-password'
  26
  27     return this.postBodyRequest({
  28       ...options,
  29
  30       path,
  31       fields: { email },
  32       implicitToken: false,
  33       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  34     })
  35   }
  36
  37   resetPassword (options: OverrideCommandOptions & {
  38     userId: number
  39     verificationString: string
  40     password: string
  41   }) {
  42     const { userId, verificationString, password } = options
  43     const path = '/api/v1/users/' + userId + '/reset-password'
  44
  45     return this.postBodyRequest({
  46       ...options,
  47
  48       path,
  49       fields: { password, verificationString },
  50       implicitToken: false,
  51       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  52     })
  53   }
  54
  55   // ---------------------------------------------------------------------------
  56
  57   askSendVerifyEmail (options: OverrideCommandOptions & {
  58     email: string
  59   }) {
  60     const { email } = options
  61     const path = '/api/v1/users/ask-send-verify-email'
  62
  63     return this.postBodyRequest({
  64       ...options,
  65
  66       path,
  67       fields: { email },
  68       implicitToken: false,
  69       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  70     })
  71   }
  72
  73   verifyEmail (options: OverrideCommandOptions & {
  74     userId: number
  75     verificationString: string
  76     isPendingEmail?: boolean // default false
  77   }) {
  78     const { userId, verificationString, isPendingEmail = false } = options
  79     const path = '/api/v1/users/' + userId + '/verify-email'
  80
  81     return this.postBodyRequest({
  82       ...options,
  83
  84       path,
  85       fields: {
  86         verificationString,
  87         isPendingEmail
  88       },
  89       implicitToken: false,
  90       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
  91     })
  92   }
  93
  94   // ---------------------------------------------------------------------------
  95
  96   banUser (options: OverrideCommandOptions & {
  97     userId: number
  98     reason?: string
  99   }) {
 100     const { userId, reason } = options
 101     const path = '/api/v1/users' + '/' + userId + '/block'
 102
 103     return this.postBodyRequest({
 104       ...options,
 105
 106       path,
 107       fields: { reason },
 108       implicitToken: true,
 109       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 110     })
 111   }
 112
 113   unbanUser (options: OverrideCommandOptions & {
 114     userId: number
 115   }) {
 116     const { userId } = options
 117     const path = '/api/v1/users' + '/' + userId + '/unblock'
 118
 119     return this.postBodyRequest({
 120       ...options,
 121
 122       path,
 123       implicitToken: true,
 124       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 125     })
 126   }
 127
 128   // ---------------------------------------------------------------------------
 129
 130   getMyScopedTokens (options: OverrideCommandOptions = {}) {
 131     const path = '/api/v1/users/scoped-tokens'
 132
 133     return this.getRequestBody<ScopedToken>({
 134       ...options,
 135
 136       path,
 137       implicitToken: true,
 138       defaultExpectedStatus: HttpStatusCode.OK_200
 139     })
 140   }
 141
 142   renewMyScopedTokens (options: OverrideCommandOptions = {}) {
 143     const path = '/api/v1/users/scoped-tokens'
 144
 145     return this.postBodyRequest({
 146       ...options,
 147
 148       path,
 149       implicitToken: true,
 150       defaultExpectedStatus: HttpStatusCode.OK_200
 151     })
 152   }
 153
 154   // ---------------------------------------------------------------------------
 155
 156   create (options: OverrideCommandOptions & {
 157     username: string
 158     password?: string
 159     videoQuota?: number
 160     videoQuotaDaily?: number
 161     role?: UserRole
 162     adminFlags?: UserAdminFlag
 163   }) {
 164     const {
 165       username,
 166       adminFlags,
 167       password = 'password',
 168       videoQuota,
 169       videoQuotaDaily,
 170       role = UserRole.USER
 171     } = options
 172
 173     const path = '/api/v1/users'
 174
 175     return unwrapBody<{ user: UserCreateResult }>(this.postBodyRequest({
 176       ...options,
 177
 178       path,
 179       fields: {
 180         username,
 181         password,
 182         role,
 183         adminFlags,
 184         email: username + '@example.com',
 185         videoQuota,
 186         videoQuotaDaily
 187       },
 188       implicitToken: true,
 189       defaultExpectedStatus: HttpStatusCode.OK_200
 190     })).then(res => res.user)
 191   }
 192
 193   async generate (username: string, role?: UserRole) {
 194     const password = 'password'
 195     const user = await this.create({ username, password, role })
 196
 197     const token = await this.server.login.getAccessToken({ username, password })
 198
 199     const me = await this.getMyInfo({ token })
 200
 201     return {
 202       token,
 203       userId: user.id,
 204       userChannelId: me.videoChannels[0].id,
 205       userChannelName: me.videoChannels[0].name,
 206       password
 207     }
 208   }
 209
 210   async generateUserAndToken (username: string, role?: UserRole) {
 211     const password = 'password'
 212     await this.create({ username, password, role })
 213
 214     return this.server.login.getAccessToken({ username, password })
 215   }
 216
 217   // ---------------------------------------------------------------------------
 218
 219   getMyInfo (options: OverrideCommandOptions = {}) {
 220     const path = '/api/v1/users/me'
 221
 222     return this.getRequestBody<MyUser>({
 223       ...options,
 224
 225       path,
 226       implicitToken: true,
 227       defaultExpectedStatus: HttpStatusCode.OK_200
 228     })
 229   }
 230
 231   getMyQuotaUsed (options: OverrideCommandOptions = {}) {
 232     const path = '/api/v1/users/me/video-quota-used'
 233
 234     return this.getRequestBody<UserVideoQuota>({
 235       ...options,
 236
 237       path,
 238       implicitToken: true,
 239       defaultExpectedStatus: HttpStatusCode.OK_200
 240     })
 241   }
 242
 243   getMyRating (options: OverrideCommandOptions & {
 244     videoId: number | string
 245   }) {
 246     const { videoId } = options
 247     const path = '/api/v1/users/me/videos/' + videoId + '/rating'
 248
 249     return this.getRequestBody<UserVideoRate>({
 250       ...options,
 251
 252       path,
 253       implicitToken: true,
 254       defaultExpectedStatus: HttpStatusCode.OK_200
 255     })
 256   }
 257
 258   deleteMe (options: OverrideCommandOptions = {}) {
 259     const path = '/api/v1/users/me'
 260
 261     return this.deleteRequest({
 262       ...options,
 263
 264       path,
 265       implicitToken: true,
 266       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 267     })
 268   }
 269
 270   updateMe (options: OverrideCommandOptions & UserUpdateMe) {
 271     const path = '/api/v1/users/me'
 272
 273     const toSend: UserUpdateMe = omit(options, [ 'expectedStatus', 'token' ])
 274
 275     return this.putBodyRequest({
 276       ...options,
 277
 278       path,
 279       fields: toSend,
 280       implicitToken: true,
 281       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 282     })
 283   }
 284
 285   updateMyAvatar (options: OverrideCommandOptions & {
 286     fixture: string
 287   }) {
 288     const { fixture } = options
 289     const path = '/api/v1/users/me/avatar/pick'
 290
 291     return this.updateImageRequest({
 292       ...options,
 293
 294       path,
 295       fixture,
 296       fieldname: 'avatarfile',
 297
 298       implicitToken: true,
 299       defaultExpectedStatus: HttpStatusCode.OK_200
 300     })
 301   }
 302
 303   // ---------------------------------------------------------------------------
 304
 305   get (options: OverrideCommandOptions & {
 306     userId: number
 307     withStats?: boolean // default false
 308   }) {
 309     const { userId, withStats } = options
 310     const path = '/api/v1/users/' + userId
 311
 312     return this.getRequestBody<User>({
 313       ...options,
 314
 315       path,
 316       query: { withStats },
 317       implicitToken: true,
 318       defaultExpectedStatus: HttpStatusCode.OK_200
 319     })
 320   }
 321
 322   list (options: OverrideCommandOptions & {
 323     start?: number
 324     count?: number
 325     sort?: string
 326     search?: string
 327     blocked?: boolean
 328   } = {}) {
 329     const path = '/api/v1/users'
 330
 331     return this.getRequestBody<ResultList<User>>({
 332       ...options,
 333
 334       path,
 335       query: pick(options, [ 'start', 'count', 'sort', 'search', 'blocked' ]),
 336       implicitToken: true,
 337       defaultExpectedStatus: HttpStatusCode.OK_200
 338     })
 339   }
 340
 341   remove (options: OverrideCommandOptions & {
 342     userId: number
 343   }) {
 344     const { userId } = options
 345     const path = '/api/v1/users/' + userId
 346
 347     return this.deleteRequest({
 348       ...options,
 349
 350       path,
 351       implicitToken: true,
 352       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 353     })
 354   }
 355
 356   update (options: OverrideCommandOptions & {
 357     userId: number
 358     email?: string
 359     emailVerified?: boolean
 360     videoQuota?: number
 361     videoQuotaDaily?: number
 362     password?: string
 363     adminFlags?: UserAdminFlag
 364     pluginAuth?: string
 365     role?: UserRole
 366   }) {
 367     const path = '/api/v1/users/' + options.userId
 368
 369     const toSend: UserUpdate = {}
 370     if (options.password !== undefined && options.password !== null) toSend.password = options.password
 371     if (options.email !== undefined && options.email !== null) toSend.email = options.email
 372     if (options.emailVerified !== undefined && options.emailVerified !== null) toSend.emailVerified = options.emailVerified
 373     if (options.videoQuota !== undefined && options.videoQuota !== null) toSend.videoQuota = options.videoQuota
 374     if (options.videoQuotaDaily !== undefined && options.videoQuotaDaily !== null) toSend.videoQuotaDaily = options.videoQuotaDaily
 375     if (options.role !== undefined && options.role !== null) toSend.role = options.role
 376     if (options.adminFlags !== undefined && options.adminFlags !== null) toSend.adminFlags = options.adminFlags
 377     if (options.pluginAuth !== undefined) toSend.pluginAuth = options.pluginAuth
 378
 379     return this.putBodyRequest({
 380       ...options,
 381
 382       path,
 383       fields: toSend,
 384       implicitToken: true,
 385       defaultExpectedStatus: HttpStatusCode.NO_CONTENT_204
 386     })
 387   }
 388 }