feat: add register user use case

Author: g-saracca

docs/useCases.md

@@ -58,6 +58,7 @@ The different use cases currently available in the package are classified below,
   - [Users write use cases](#users-write-use-cases)
     - [Delete Current API Token](#delete-current-api-token)
     - [Recreate Current API Token](#recreate-current-api-token)
+    - [Register User](#register-user)
 - [Info](#Info)
   - [Get Dataverse Backend Version](#get-dataverse-backend-version)
   - [Get Maximum Embargo Duration In Months](#get-maximum-embargo-duration-in-months)
@@ -1269,6 +1270,34 @@ recreateCurrentApiToken.execute().then((apiTokenInfo: ApiTokenInfo) => {
 
 _See [use case](../src/users/domain/useCases/RecreateCurrentApiToken.ts) implementation_.
 
+### Register User
+
+Register a new user, given a [UserDTO](../src/users/domain/dtos/UserDTO.ts)
+
+##### Example call:
+
+```typescript
+import { registerUser } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const userDTO: UserDTO = {
+  username: 'johndoe'
+  firstName: 'John'
+  lastName: 'Doe'
+  emailAddress: '[email protected]'
+  position: ''
+  affiliation: ''
+  termsAccepted: true
+}
+
+registerUser.execute(userDTO)
+
+/* ... */
+```
+
+_See [use case](../src/users/domain/useCases/RegisterUser.ts) implementation_.
+
 ## Info
 
 #### Get Dataverse Backend Version

src/users/domain/dtos/UserDTO.ts

@@ -0,0 +1,9 @@
+export interface UserDTO {
+  username?: string
+  firstName?: string
+  lastName?: string
+  emailAddress?: string
+  position?: string
+  affiliation?: string
+  termsAccepted: boolean
+}

src/users/domain/repositories/IUsersRepository.ts

@@ -1,9 +1,11 @@
 import { ApiTokenInfo } from '../models/ApiTokenInfo'
 import { AuthenticatedUser } from '../models/AuthenticatedUser'
+import { UserDTO } from '../dtos/UserDTO'
 
 export interface IUsersRepository {
   getCurrentAuthenticatedUser(): Promise<AuthenticatedUser>
   recreateCurrentApiToken(): Promise<ApiTokenInfo>
   getCurrentApiToken(): Promise<ApiTokenInfo>
   deleteCurrentApiToken(): Promise<void>
+  registerUser(userDTO: UserDTO): Promise<void>
 }

src/users/domain/useCases/RegisterUser.ts

@@ -0,0 +1,22 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { UserDTO } from '../dtos/UserDTO'
+import { IUsersRepository } from '../repositories/IUsersRepository'
+
+export class RegisterUser implements UseCase<void> {
+  private usersRepository: IUsersRepository
+
+  constructor(usersRepository: IUsersRepository) {
+    this.usersRepository = usersRepository
+  }
+
+  /**
+   * Registers a new user, given a UserDTO object. Only available through DataverseApiAuthMechanism.BEARER_TOKEN auth mechanism.
+   *
+   * @param {UserDTO} [userDTO] - UserDTO object including the new user data.
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   * @throws {WriteError} - If there are errors while writing data.
+   */
+  async execute(userDTO: UserDTO): Promise<void> {
+    return await this.usersRepository.registerUser(userDTO)
+  }
+}

src/users/index.ts

@@ -3,19 +3,23 @@ import { GetCurrentAuthenticatedUser } from './domain/useCases/GetCurrentAuthent
 import { RecreateCurrentApiToken } from './domain/useCases/RecreateCurrentApiToken'
 import { GetCurrentApiToken } from './domain/useCases/GetCurrentApiToken'
 import { DeleteCurrentApiToken } from './domain/useCases/DeleteCurrentApiToken'
+import { RegisterUser } from './domain/useCases/RegisterUser'
 
 const usersRepository = new UsersRepository()
 
 const getCurrentAuthenticatedUser = new GetCurrentAuthenticatedUser(usersRepository)
 const recreateCurrentApiToken = new RecreateCurrentApiToken(usersRepository)
 const getCurrentApiToken = new GetCurrentApiToken(usersRepository)
 const deleteCurrentApiToken = new DeleteCurrentApiToken(usersRepository)
+const registerUser = new RegisterUser(usersRepository)
 
 export {
   getCurrentAuthenticatedUser,
   recreateCurrentApiToken,
   getCurrentApiToken,
-  deleteCurrentApiToken
+  deleteCurrentApiToken,
+  registerUser
 }
 export { AuthenticatedUser } from './domain/models/AuthenticatedUser'
 export { ApiTokenInfo } from './domain/models/ApiTokenInfo'
+export { UserDTO } from './domain/dtos/UserDTO'

src/users/infra/repositories/UsersRepository.ts

@@ -7,6 +7,7 @@ import {
   transformGetApiTokenResponseToApiTokenInfo,
   transformRecreateApiTokenResponseToApiTokenInfo
 } from './transformers/apiTokenInfoTransformers'
+import { UserDTO } from '../../domain/dtos/UserDTO'
 
 export class UsersRepository extends ApiRepository implements IUsersRepository {
   private readonly usersResourceName: string = 'users'
@@ -43,6 +44,14 @@ export class UsersRepository extends ApiRepository implements IUsersRepository {
       })
   }
 
+  public async registerUser(userDTO: UserDTO): Promise<void> {
+    return this.doPost(`/${this.usersResourceName}/register`, userDTO)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
+
   private getAuthenticatedUserFromResponse(response: AxiosResponse): AuthenticatedUser {
     const responseData = response.data.data
     return {