feat: update notification usecases

Author: ChengShi-1

docs/useCases.md

@@ -85,6 +85,9 @@ The different use cases currently available in the package are classified below,
   - [Get Application Terms of Use](#get-application-terms-of-use)
 - [Contact](#Contact)
   - [Send Feedback to Object Contacts](#send-feedback-to-object-contacts)
+- [Notifications](#Notifications)
+  - [Get All Notifications by User](#get-all-notifications-by-user)
+  - [Delete Notification by User](#delete-notification-by-user)
 
 ## Collections
 
@@ -1991,3 +1994,47 @@ In ContactDTO, it takes the following information:
 - **subject**: the email subject line.
 - **body**: the email body to send.
 - **fromEmail**: the email to list in the reply-to field.
+
+## Notifications
+
+#### Get All Notifications by User
+
+Returns a [Notification](../src/notifications/domain/models/Notification.ts) array containing all notifications for the current authenticated user.
+
+##### Example call:
+
+```typescript
+import { getAllNotificationsByUser } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAllNotificationsByUser.execute().then((notifications: Notification[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/GetAllNotificationsByUser.ts) implementation_.
+
+#### Delete Notification by User
+
+Deletes a specific notification for the current authenticated user by its ID.
+
+##### Example call:
+
+```typescript
+import { deleteNotificationByUser } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const notificationId = 123
+
+deleteNotificationByUser.execute(notificationId: number).then(() => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/DeleteNotificationByUser.ts) implementation_.

src/index.ts

@@ -8,3 +8,4 @@ export * from './collections'
 export * from './metadataBlocks'
 export * from './files'
 export * from './contactInfo'
+export * from './notifications'

src/notifications/domain/models/Notification.ts

@@ -0,0 +1,7 @@
+export interface Notification {
+  id: number
+  type: string
+  subjectText: string
+  messageText: string
+  sentTimestamp: string
+}

src/notifications/domain/repositories/INotificationsRepository.ts

@@ -0,0 +1,6 @@
+import { Notification } from '../models/Notification'
+
+export interface INotificationsRepository {
+  getAllNotificationsByUser(): Promise<Notification[]>
+  deleteNotificationByUser(notificationId: number): Promise<void>
+}

src/notifications/domain/useCases/DeleteNotificationByUser.ts

@@ -0,0 +1,16 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { INotificationsRepository } from '../repositories/INotificationsRepository'
+
+/**
+ * Use case for deleting a specific notification for the current user.
+ *
+ * @param notificationId - The ID of the notification to delete.
+ * @returns {Promise<void>} - A promise that resolves when the notification is deleted.
+ */
+export class DeleteNotificationByUser implements UseCase<void> {
+  constructor(private readonly notificationsRepository: INotificationsRepository) {}
+
+  async execute(notificationId: number): Promise<void> {
+    return this.notificationsRepository.deleteNotificationByUser(notificationId)
+  }
+}

src/notifications/domain/useCases/GetAllNotificationsByUser.ts

@@ -0,0 +1,16 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { Notification } from '../models/Notification'
+import { INotificationsRepository } from '../repositories/INotificationsRepository'
+
+export class GetAllNotificationsByUser implements UseCase<Notification[]> {
+  constructor(private readonly notificationsRepository: INotificationsRepository) {}
+
+  /**
+   * Use case for retrieving all notifications for the current user.
+   *
+   * @returns {Promise<Notification[]>} - A promise that resolves to an array of Notification instances.
+   */
+  async execute(): Promise<Notification[]> {
+    return (await this.notificationsRepository.getAllNotificationsByUser()) as Notification[]
+  }
+}

src/notifications/index.ts

@@ -0,0 +1,12 @@
+import { NotificationsRepository } from './infra/repositories/NotificationsRepository'
+import { GetAllNotificationsByUser } from './domain/useCases/GetAllNotificationsByUser'
+import { DeleteNotificationByUser } from './domain/useCases/DeleteNotificationByUser'
+
+const notificationsRepository = new NotificationsRepository()
+
+const getAllNotificationsByUser = new GetAllNotificationsByUser(notificationsRepository)
+const deleteNotificationByUser = new DeleteNotificationByUser(notificationsRepository)
+
+export { getAllNotificationsByUser, deleteNotificationByUser }
+
+export { Notification } from './domain/models/Notification'

src/notifications/infra/repositories/NotificationsRepository.ts

@@ -0,0 +1,25 @@
+import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
+import { INotificationsRepository } from '../../domain/repositories/INotificationsRepository'
+import { Notification } from '../../domain/models/Notification'
+
+export class NotificationsRepository extends ApiRepository implements INotificationsRepository {
+  private readonly notificationsResourceName: string = 'notifications'
+
+  public async getAllNotificationsByUser(): Promise<Notification[]> {
+    return this.doGet(this.buildApiEndpoint(this.notificationsResourceName, 'all'), true)
+      .then((response) => response.data.data.notifications as Notification[])
+      .catch((error) => {
+        throw error
+      })
+  }
+
+  public async deleteNotificationByUser(notificationId: number): Promise<void> {
+    return this.doDelete(
+      this.buildApiEndpoint(this.notificationsResourceName, notificationId.toString())
+    )
+      .then(() => {})
+      .catch((error) => {
+        throw error
+      })
+  }
+}

test/functional/notifications/DeleteNotificationByUser.test.ts

@@ -0,0 +1,30 @@
+import {
+  ApiConfig,
+  deleteNotificationByUser,
+  getAllNotificationsByUser,
+  WriteError
+} from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+
+describe('execute', () => {
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should successfully delete a notification for authenticated user', async () => {
+    const notificationId = 1
+    await deleteNotificationByUser.execute(notificationId)
+
+    const notifications = await getAllNotificationsByUser.execute()
+    expect(notifications.length).toBe(0)
+  })
+
+  test('should throw an error when the notification id does not exist', async () => {
+    await expect(deleteNotificationByUser.execute(123)).rejects.toThrow(WriteError)
+  })
+})

test/functional/notifications/GetAllNotificationsByUser.test.ts

@@ -0,0 +1,33 @@
+import { ApiConfig, getAllNotificationsByUser, Notification } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+
+describe('execute', () => {
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should successfully return notifications for authenticated user', async () => {
+    const notifications: Notification[] = await getAllNotificationsByUser.execute()
+
+    expect(notifications).not.toBeNull()
+    expect(Array.isArray(notifications)).toBe(true)
+  })
+
+  test('should have correct notification properties if notifications exist', async () => {
+    const notifications = await getAllNotificationsByUser.execute()
+    if (notifications.length === 0) {
+      return
+    }
+    const first = notifications[0]
+    expect(first).toHaveProperty('id')
+    expect(first).toHaveProperty('type')
+    expect(first).toHaveProperty('subjectText')
+    expect(first).toHaveProperty('messageText')
+    expect(first).toHaveProperty('sentTimestamp')
+  })
+})