feat: update get notification parameter

Author: ChengShi-1

src/notifications/domain/models/Notification.ts

@@ -1,7 +1,72 @@
+export enum NotificationType {
+  ASSIGNROLE = 'ASSIGNROLE',
+  REVOKEROLE = 'REVOKEROLE',
+  CREATEDV = 'CREATEDV',
+  CREATEDS = 'CREATEDS',
+  CREATEACC = 'CREATEACC',
+  SUBMITTEDDS = 'SUBMITTEDDS',
+  RETURNEDDS = 'RETURNEDDS',
+  PUBLISHEDDS = 'PUBLISHEDDS',
+  REQUESTFILEACCESS = 'REQUESTFILEACCESS',
+  GRANTFILEACCESS = 'GRANTFILEACCESS',
+  REJECTFILEACCESS = 'REJECTFILEACCESS',
+  FILESYSTEMIMPORT = 'FILESYSTEMIMPORT',
+  CHECKSUMIMPORT = 'CHECKSUMIMPORT',
+  CHECKSUMFAIL = 'CHECKSUMFAIL',
+  CONFIRMEMAIL = 'CONFIRMEMAIL',
+  APIGENERATED = 'APIGENERATED',
+  INGESTCOMPLETED = 'INGESTCOMPLETED',
+  INGESTCOMPLETEDWITHERRORS = 'INGESTCOMPLETEDWITHERRORS',
+  PUBLISHFAILED_PIDREG = 'PUBLISHFAILED_PIDREG',
+  WORKFLOW_SUCCESS = 'WORKFLOW_SUCCESS',
+  WORKFLOW_FAILURE = 'WORKFLOW_FAILURE',
+  STATUSUPDATED = 'STATUSUPDATED',
+  DATASETCREATED = 'DATASETCREATED',
+  DATASETMENTIONED = 'DATASETMENTIONED',
+  GLOBUSUPLOADCOMPLETED = 'GLOBUSUPLOADCOMPLETED',
+  GLOBUSUPLOADCOMPLETEDWITHERRORS = 'GLOBUSUPLOADCOMPLETEDWITHERRORS',
+  GLOBUSDOWNLOADCOMPLETED = 'GLOBUSDOWNLOADCOMPLETED',
+  GLOBUSDOWNLOADCOMPLETEDWITHERRORS = 'GLOBUSDOWNLOADCOMPLETEDWITHERRORS',
+  REQUESTEDFILEACCESS = 'REQUESTEDFILEACCESS',
+  GLOBUSUPLOADREMOTEFAILURE = 'GLOBUSUPLOADREMOTEFAILURE',
+  GLOBUSUPLOADLOCALFAILURE = 'GLOBUSUPLOADLOCALFAILURE',
+  PIDRECONCILED = 'PIDRECONCILED'
+}
+
+export interface RoleAssignment {
+  id: number
+  assignee: string
+  definitionPointId: number
+  roleId: number
+  roleName: string
+  _roleAlias: string
+}
+
 export interface Notification {
   id: number
-  type: string
-  subjectText: string
-  messageText: string
+  type: NotificationType
+  subjectText?: string
+  messageText?: string
   sentTimestamp: string
+  displayAsRead?: boolean
+  installationBrandName?: string
+  userGuidesBaseUrl?: string
+  userGuidesVersion?: string
+  userGuidesSectionPath?: string
+  roleAssignments?: RoleAssignment[]
+  dataverseAlias?: string
+  dataverseDisplayName?: string
+  datasetPersistentIdentifier?: string
+  datasetDisplayName?: string
+  ownerPersistentIdentifier?: string
+  ownerAlias?: string
+  ownerDisplayName?: string
+  requestorFirstName?: string
+  requestorLastName?: string
+  requestorEmail?: string
+  dataFileId?: number
+  dataFileDisplayName?: string
+  currentCurationStatus?: string
+  additionalInfo?: string
+  objectDeleted?: boolean
 }

src/notifications/domain/repositories/INotificationsRepository.ts

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

src/notifications/domain/useCases/GetAllNotificationsByUser.ts

@@ -8,9 +8,12 @@ export class GetAllNotificationsByUser implements UseCase<Notification[]> {
   /**
    * Use case for retrieving all notifications for the current user.
    *
+   * @param inAppNotificationFormat - Optional parameter to retrieve fields needed for in-app notifications
    * @returns {Promise<Notification[]>} - A promise that resolves to an array of Notification instances.
    */
-  async execute(): Promise<Notification[]> {
-    return (await this.notificationsRepository.getAllNotificationsByUser()) as Notification[]
+  async execute(inAppNotificationFormat?: boolean): Promise<Notification[]> {
+    return (await this.notificationsRepository.getAllNotificationsByUser(
+      inAppNotificationFormat
+    )) as Notification[]
   }
 }

src/notifications/index.ts

@@ -9,4 +9,4 @@ const deleteNotification = new DeleteNotification(notificationsRepository)
 
 export { getAllNotificationsByUser, deleteNotification }
 
-export { Notification } from './domain/models/Notification'
+export { Notification, NotificationType, RoleAssignment } from './domain/models/Notification'

src/notifications/infra/repositories/NotificationsRepository.ts

@@ -5,8 +5,15 @@ 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)
+  public async getAllNotificationsByUser(
+    inAppNotificationFormat?: boolean
+  ): Promise<Notification[]> {
+    const queryParams = inAppNotificationFormat ? { inAppNotificationFormat: 'true' } : undefined
+    return this.doGet(
+      this.buildApiEndpoint(this.notificationsResourceName, 'all'),
+      true,
+      queryParams
+    )
       .then((response) => response.data.data.notifications as Notification[])
       .catch((error) => {
         throw error

test/environment/.env

@@ -1,6 +1,6 @@
 POSTGRES_VERSION=17
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=9.8.0
-DATAVERSE_IMAGE_REGISTRY=docker.io
-DATAVERSE_IMAGE_TAG=unstable
+DATAVERSE_IMAGE_REGISTRY=ghcr.io
+DATAVERSE_IMAGE_TAG=11648-notifications-api-extension
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m

test/functional/notifications/GetAllNotificationsByUser.test.ts

@@ -25,4 +25,20 @@ describe('execute', () => {
     expect(notifications[0]).toHaveProperty('type')
     expect(notifications[0]).toHaveProperty('sentTimestamp')
   })
+
+  test('should have correct in-app notification properties when inAppNotificationFormat is true', async () => {
+    const notifications = await getAllNotificationsByUser.execute(true)
+
+    expect(notifications[0]).toHaveProperty('id')
+    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)
+  })
 })

test/integration/notifications/NotificationsRepository.test.ts

@@ -4,13 +4,21 @@ import {
 } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { NotificationsRepository } from '../../../src/notifications/infra/repositories/NotificationsRepository'
-import { Notification } from '../../../src/notifications/domain/models/Notification'
-import { createDataset } from '../../../src/datasets'
-import { publishDatasetViaApi, waitForNoLocks } from '../../testHelpers/datasets/datasetHelper'
+import {
+  Notification,
+  NotificationType
+} from '../../../src/notifications/domain/models/Notification'
+import { createDataset, CreatedDatasetIdentifiers } from '../../../src/datasets'
+import {
+  deletePublishedDatasetViaApi,
+  publishDatasetViaApi,
+  waitForNoLocks
+} from '../../testHelpers/datasets/datasetHelper'
 import { WriteError } from '../../../src'
 
 describe('NotificationsRepository', () => {
   const sut: NotificationsRepository = new NotificationsRepository()
+  let testDatasetIds: CreatedDatasetIdentifiers
 
   beforeEach(() => {
     ApiConfig.init(
@@ -20,9 +28,13 @@ 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
-    const testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+    testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
 
     await publishDatasetViaApi(testDatasetIds.numericId)
     await waitForNoLocks(testDatasetIds.numericId, 10)
@@ -32,7 +44,9 @@ describe('NotificationsRepository', () => {
     expect(Array.isArray(notifications)).toBe(true)
     expect(notifications.length).toBeGreaterThan(0)
 
-    const publishedNotification = notifications.find((n) => n.type === 'PUBLISHEDDS')
+    const publishedNotification = notifications.find(
+      (n) => n.type === NotificationType.PUBLISHEDDS
+    ) as Notification
 
     expect(publishedNotification).toBeDefined()
 
@@ -73,4 +87,30 @@ describe('NotificationsRepository', () => {
 
     await expect(sut.deleteNotification(nonExistentNotificationId)).rejects.toThrow(expectedError)
   })
+
+  test('should return notifications with basic properties when inAppNotificationFormat is true', async () => {
+    const notifications: Notification[] = await sut.getAllNotificationsByUser(true)
+
+    const notification = notifications[0]
+    expect(notification).toHaveProperty('id')
+    expect(notification).toHaveProperty('type')
+    expect(notification.type).toBe(NotificationType.ASSIGNROLE)
+    expect(notification).toHaveProperty('sentTimestamp')
+    expect(notification).toHaveProperty('displayAsRead')
+    expect(notification).toHaveProperty('dataverseDisplayName')
+
+    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)
+  })
+
+  test('should return array when inAppNotificationFormat is false', async () => {
+    const notifications: Notification[] = await sut.getAllNotificationsByUser(false)
+
+    expect(Array.isArray(notifications)).toBe(true)
+  })
 })

test/unit/notifications/DeleteNotification.test.ts

@@ -1,21 +1,26 @@
 import { DeleteNotification } from '../../../src/notifications/domain/useCases/DeleteNotification'
 import { INotificationsRepository } from '../../../src/notifications/domain/repositories/INotificationsRepository'
-import { Notification } from '../../../src/notifications/domain/models/Notification'
+import {
+  Notification,
+  NotificationType
+} from '../../../src/notifications/domain/models/Notification'
 
 const mockNotifications: Notification[] = [
   {
     id: 1,
-    type: 'PUBLISHEDDS',
+    type: NotificationType.PUBLISHEDDS,
     subjectText: 'Test notification',
     messageText: 'Test message',
-    sentTimestamp: '2025-01-01T00:00:00Z'
+    sentTimestamp: '2025-01-01T00:00:00Z',
+    displayAsRead: false
   },
   {
     id: 2,
-    type: 'ASSIGNROLE',
+    type: NotificationType.ASSIGNROLE,
     subjectText: 'Role assignment',
     messageText: 'Role assigned',
-    sentTimestamp: '2025-01-01T00:00:00Z'
+    sentTimestamp: '2025-01-01T00:00:00Z',
+    displayAsRead: false
   }
 ]
 

test/unit/notifications/GetAllNotificationsByUser.test.ts

@@ -1,21 +1,26 @@
 import { GetAllNotificationsByUser } from '../../../src/notifications/domain/useCases/GetAllNotificationsByUser'
 import { INotificationsRepository } from '../../../src/notifications/domain/repositories/INotificationsRepository'
-import { Notification } from '../../../src/notifications/domain/models/Notification'
+import {
+  Notification,
+  NotificationType
+} from '../../../src/notifications/domain/models/Notification'
 
 const mockNotifications: Notification[] = [
   {
     id: 1,
-    type: 'PUBLISHEDDS',
+    type: NotificationType.PUBLISHEDDS,
     subjectText: 'Test notification',
     messageText: 'Test message',
-    sentTimestamp: '2025-01-01T00:00:00Z'
+    sentTimestamp: '2025-01-01T00:00:00Z',
+    displayAsRead: false
   },
   {
     id: 2,
-    type: 'ASSIGNROLE',
+    type: NotificationType.ASSIGNROLE,
     subjectText: 'Role assignment',
     messageText: 'Role assigned',
-    sentTimestamp: '2025-01-01T00:00:00Z'
+    sentTimestamp: '2025-01-01T00:00:00Z',
+    displayAsRead: false
   }
 ]