feat: display as read

ChengShi-1 · ChengShi-1 · commit 541e89219953 · 2025-08-18T12:06:00.000-04:00
diff --git a/docs/useCases.md b/docs/useCases.md
@@ -91,6 +91,8 @@ The different use cases currently available in the package are classified below,
 - [Notifications](#Notifications)
   - [Get All Notifications by User](#get-all-notifications-by-user)
   - [Delete Notification](#delete-notification)
+  - [Get Unread Count](#get-unread-count)
+  - [Mark As Read](#mark-as-read)
 - [Search](#Search)
   - [Get Search Services](#get-search-services)
 
@@ -2143,6 +2145,48 @@ deleteNotification.execute(notificationId: number).then(() => {
 
 _See [use case](../src/notifications/domain/useCases/DeleteNotification.ts) implementation_.
 
+#### Get Unread Count
+
+Returns the number of unread notifications for the current authenticated user.
+
+##### Example call:
+
+```typescript
+import { getUnreadCount } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getUnreadCount.execute().then((count: number) => {
+  console.log(`You have ${count} unread notifications`)
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/GetUnreadCount.ts) implementation_.
+
+#### Mark As Read
+
+Marks a specific notification as read for the current authenticated user. This operation is idempotent - marking an already-read notification as read will not cause an error.
+
+##### Example call:
+
+```typescript
+import { markAsRead } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const notificationId = 123
+
+markAsRead.execute(notificationId).then(() => {
+  console.log('Notification marked as read')
+})
+
+/* ... */
+```
+
+_See [use case](../src/notifications/domain/useCases/MarkAsRead.ts) implementation_.
+
 ## Search
 
 #### Get Search Services
diff --git a/src/notifications/domain/models/Notification.ts b/src/notifications/domain/models/Notification.ts
@@ -48,7 +48,7 @@ export interface Notification {
   subjectText?: string
   messageText?: string
   sentTimestamp: string
-  displayAsRead?: boolean
+  displayAsRead: boolean
   installationBrandName?: string
   userGuidesBaseUrl?: string
   userGuidesVersion?: string
diff --git a/src/notifications/domain/repositories/INotificationsRepository.ts b/src/notifications/domain/repositories/INotificationsRepository.ts
@@ -3,4 +3,6 @@ import { Notification } from '../models/Notification'
 export interface INotificationsRepository {
   getAllNotificationsByUser(inAppNotificationFormat?: boolean): Promise<Notification[]>
   deleteNotification(notificationId: number): Promise<void>
+  getUnreadCount(): Promise<number>
+  markAsRead(notificationId: number): Promise<void>
 }
diff --git a/src/notifications/domain/useCases/GetUnreadCount.ts b/src/notifications/domain/useCases/GetUnreadCount.ts
@@ -0,0 +1,14 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { INotificationsRepository } from '../repositories/INotificationsRepository'
+
+export class GetUnreadCount implements UseCase<number> {
+  private notificationsRepository: INotificationsRepository
+
+  constructor(notificationsRepository: INotificationsRepository) {
+    this.notificationsRepository = notificationsRepository
+  }
+
+  async execute(): Promise<number> {
+    return await this.notificationsRepository.getUnreadCount()
+  }
+}
diff --git a/src/notifications/domain/useCases/MarkAsRead.ts b/src/notifications/domain/useCases/MarkAsRead.ts
@@ -0,0 +1,14 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { INotificationsRepository } from '../repositories/INotificationsRepository'
+
+export class MarkAsRead implements UseCase<void> {
+  private notificationsRepository: INotificationsRepository
+
+  constructor(notificationsRepository: INotificationsRepository) {
+    this.notificationsRepository = notificationsRepository
+  }
+
+  async execute(notificationId: number): Promise<void> {
+    return await this.notificationsRepository.markAsRead(notificationId)
+  }
+}
diff --git a/src/notifications/index.ts b/src/notifications/index.ts
@@ -1,12 +1,16 @@
 import { NotificationsRepository } from './infra/repositories/NotificationsRepository'
 import { GetAllNotificationsByUser } from './domain/useCases/GetAllNotificationsByUser'
 import { DeleteNotification } from './domain/useCases/DeleteNotification'
+import { GetUnreadCount } from './domain/useCases/GetUnreadCount'
+import { MarkAsRead } from './domain/useCases/MarkAsRead'
 
 const notificationsRepository = new NotificationsRepository()
 
 const getAllNotificationsByUser = new GetAllNotificationsByUser(notificationsRepository)
 const deleteNotification = new DeleteNotification(notificationsRepository)
+const getUnreadCount = new GetUnreadCount(notificationsRepository)
+const markAsRead = new MarkAsRead(notificationsRepository)
 
-export { getAllNotificationsByUser, deleteNotification }
+export { getAllNotificationsByUser, deleteNotification, getUnreadCount, markAsRead }
 
 export { Notification, NotificationType, RoleAssignment } from './domain/models/Notification'
diff --git a/src/notifications/infra/repositories/NotificationsRepository.ts b/src/notifications/infra/repositories/NotificationsRepository.ts
@@ -24,9 +24,23 @@ export class NotificationsRepository extends ApiRepository implements INotificat
     return this.doDelete(
       this.buildApiEndpoint(this.notificationsResourceName, notificationId.toString())
     )
-      .then(() => {})
+      .then(() => undefined)
       .catch((error) => {
         throw error
       })
   }
+
+  public async getUnreadCount(): Promise<number> {
+    return this.doGet(
+      this.buildApiEndpoint(this.notificationsResourceName, 'unreadCount'),
+      true
+    ).then((response) => response.data.data.unreadCount as number)
+  }
+
+  public async markAsRead(notificationId: number): Promise<void> {
+    return this.doPut(
+      this.buildApiEndpoint(this.notificationsResourceName, 'markAsRead', notificationId),
+      {}
+    ).then(() => undefined)
+  }
 }
diff --git a/test/functional/notifications/GetAllNotificationsByUser.test.ts b/test/functional/notifications/GetAllNotificationsByUser.test.ts
@@ -33,12 +33,5 @@ describe('execute', () => {
     expect(notifications[0]).toHaveProperty('type')
     expect(notifications[0]).toHaveProperty('sentTimestamp')
     expect(notifications[0]).toHaveProperty('displayAsRead')
-    expect(notifications[0]).toHaveProperty('roleAssignments')
-    expect(notifications[0].roleAssignments).toBeDefined()
-    expect(notifications[0].roleAssignments?.length).toBeGreaterThan(0)
-    expect(notifications[0].roleAssignments?.[0]).toHaveProperty('roleName', 'Admin')
-    expect(notifications[0].roleAssignments?.[0]).toHaveProperty('assignee', '@dataverseAdmin')
-    expect(notifications[0].roleAssignments?.[0]).toHaveProperty('roleId', 1)
-    expect(notifications[0].roleAssignments?.[0]).toHaveProperty('definitionPointId', 1)
   })
 })
diff --git a/test/functional/notifications/GetUnreadCount.test.ts b/test/functional/notifications/GetUnreadCount.test.ts
@@ -0,0 +1,10 @@
+import { getUnreadCount } from '../../../src/notifications'
+
+describe('GetUnreadCount', () => {
+  test('should return unread count', async () => {
+    const unreadCount = await getUnreadCount.execute()
+
+    expect(typeof unreadCount).toBe('number')
+    expect(unreadCount).toBeGreaterThanOrEqual(0)
+  })
+})
diff --git a/test/functional/notifications/MarkAsRead.test.ts b/test/functional/notifications/MarkAsRead.test.ts
@@ -0,0 +1 @@
+ 
diff --git a/test/integration/notifications/NotificationsRepository.test.ts b/test/integration/notifications/NotificationsRepository.test.ts
@@ -9,11 +9,7 @@ import {
   NotificationType
 } from '../../../src/notifications/domain/models/Notification'
 import { createDataset, CreatedDatasetIdentifiers } from '../../../src/datasets'
-import {
-  deletePublishedDatasetViaApi,
-  publishDatasetViaApi,
-  waitForNoLocks
-} from '../../testHelpers/datasets/datasetHelper'
+import { publishDatasetViaApi, waitForNoLocks } from '../../testHelpers/datasets/datasetHelper'
 import { WriteError } from '../../../src'
 
 describe('NotificationsRepository', () => {
@@ -28,10 +24,6 @@ describe('NotificationsRepository', () => {
     )
   })
 
-  afterAll(async () => {
-    await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
-  })
-
   test('should return notifications after creating and publishing a dataset', async () => {
     // Create a dataset and publish it so that a notification of Dataset published is created
     testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
@@ -81,9 +73,7 @@ describe('NotificationsRepository', () => {
   test('should throw error when trying to delete notification with wrong ID', async () => {
     const nonExistentNotificationId = 99999
 
-    const expectedError = new WriteError(
-      `[404] Notification ${nonExistentNotificationId} not found.`
-    )
+    const expectedError = new WriteError()
 
     await expect(sut.deleteNotification(nonExistentNotificationId)).rejects.toThrow(expectedError)
   })
@@ -102,15 +92,48 @@ describe('NotificationsRepository', () => {
     expect(notification).toHaveProperty('roleAssignments')
     expect(notification.roleAssignments).toBeDefined()
     expect(notification.roleAssignments?.length).toBeGreaterThan(0)
-    expect(notification.roleAssignments?.[0]).toHaveProperty('roleName', 'Admin')
-    expect(notification.roleAssignments?.[0]).toHaveProperty('assignee', '@dataverseAdmin')
-    expect(notification.roleAssignments?.[0]).toHaveProperty('roleId', 1)
-    expect(notification.roleAssignments?.[0]).toHaveProperty('definitionPointId', 1)
+    expect(notification.roleAssignments?.[0]).toHaveProperty('roleName')
+    expect(notification.roleAssignments?.[0]).toHaveProperty('assignee')
+    expect(notification.roleAssignments?.[0]).toHaveProperty('roleId')
+    expect(notification.roleAssignments?.[0]).toHaveProperty('definitionPointId')
   })
 
   test('should return array when inAppNotificationFormat is false', async () => {
     const notifications: Notification[] = await sut.getAllNotificationsByUser(false)
 
     expect(Array.isArray(notifications)).toBe(true)
   })
+
+  test('should return unread count', async () => {
+    const unreadCount = await sut.getUnreadCount()
+
+    console.log('unreadCount', unreadCount)
+    expect(typeof unreadCount).toBe('number')
+    expect(unreadCount).toBeGreaterThanOrEqual(0)
+  })
+
+  test('should mark notification as read successfully', async () => {
+    const notifications: Notification[] = await sut.getAllNotificationsByUser()
+
+    expect(notifications.length).toBeGreaterThan(0)
+
+    const unreadNotification = notifications[0]
+
+    await expect(sut.markAsRead(unreadNotification.id)).resolves.toBeUndefined()
+
+    const updatedNotifications: Notification[] = await sut.getAllNotificationsByUser()
+    const updatedNotification = updatedNotifications.find((n) => n.id === unreadNotification.id)
+
+    expect(updatedNotification?.displayAsRead).toBe(true)
+  })
+
+  test('should throw error when marking non-existent notification as read', async () => {
+    const nonExistentNotificationId = 99999
+
+    const expectedError = new WriteError(
+      `[404] Notification ${nonExistentNotificationId} not found.`
+    )
+
+    await expect(sut.markAsRead(nonExistentNotificationId)).rejects.toThrow(expectedError)
+  })
 })
diff --git a/test/unit/notifications/GetUnreadCount.test.ts b/test/unit/notifications/GetUnreadCount.test.ts
@@ -0,0 +1,25 @@
+import { GetUnreadCount } from '../../../src/notifications/domain/useCases/GetUnreadCount'
+import { INotificationsRepository } from '../../../src/notifications/domain/repositories/INotificationsRepository'
+import { ReadError } from '../../../src'
+
+describe('GetUnreadCount', () => {
+  test('should return unread count from repository', async () => {
+    const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
+
+    notificationsRepositoryStub.getUnreadCount = jest.fn().mockResolvedValue(5)
+    const sut = new GetUnreadCount(notificationsRepositoryStub)
+
+    const result = await sut.execute()
+
+    expect(notificationsRepositoryStub.getUnreadCount).toHaveBeenCalledWith()
+    expect(result).toBe(5)
+  })
+
+  test('should throw error when repository throws error', async () => {
+    const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
+    notificationsRepositoryStub.getUnreadCount = jest.fn().mockRejectedValue(new ReadError())
+    const sut = new GetUnreadCount(notificationsRepositoryStub)
+
+    await expect(sut.execute()).rejects.toThrow(ReadError)
+  })
+})
diff --git a/test/unit/notifications/MarkAsRead.test.ts b/test/unit/notifications/MarkAsRead.test.ts
@@ -0,0 +1,24 @@
+import { MarkAsRead } from '../../../src/notifications/domain/useCases/MarkAsRead'
+import { INotificationsRepository } from '../../../src/notifications/domain/repositories/INotificationsRepository'
+import { ReadError } from '../../../src'
+
+describe('MarkAsRead', () => {
+  test('should mark notification as read in repository', async () => {
+    const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
+
+    notificationsRepositoryStub.markAsRead = jest.fn().mockResolvedValue(undefined)
+    const sut = new MarkAsRead(notificationsRepositoryStub)
+
+    await sut.execute(123)
+
+    expect(notificationsRepositoryStub.markAsRead).toHaveBeenCalledWith(123)
+  })
+
+  test('should throw error when repository throws error', async () => {
+    const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
+    notificationsRepositoryStub.markAsRead = jest.fn().mockRejectedValue(new ReadError())
+    const sut = new MarkAsRead(notificationsRepositoryStub)
+
+    await expect(sut.execute(123)).rejects.toThrow(ReadError)
+  })
+})

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,6 @@ import { Notification } from '../models/Notification'`
`3`	`3`	`export interface INotificationsRepository {`
`4`	`4`	`getAllNotificationsByUser(inAppNotificationFormat?: boolean): Promise<Notification[]>`
`5`	`5`	`deleteNotification(notificationId: number): Promise<void>`
	`6`	`+ getUnreadCount(): Promise<number>`
	`7`	`+ markAsRead(notificationId: number): Promise<void>`
`6`	`8`	`}`