update GetAllNotificationsByUser use case

Author: ekraffmiller

src/notifications/domain/models/Notification.ts

@@ -67,6 +67,6 @@ export interface Notification {
   dataFileId?: number
   dataFileDisplayName?: string
   currentCurationStatus?: string
-  additionalInfo?: string
+  additionalInfo?: Record<string, unknown>
   objectDeleted?: boolean
 }

src/notifications/domain/repositories/INotificationsRepository.ts

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

src/notifications/domain/useCases/GetAllNotificationsByUser.ts

@@ -9,11 +9,22 @@ 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
+   * @param onlyUnread - Optional parameter to filter only unread notifications
+   * @param limit - Optional parameter to limit the number of notifications returned
+   * @param offset - Optional parameter to skip a number of notifications (for pagination)
    * @returns {Promise<Notification[]>} - A promise that resolves to an array of Notification instances.
    */
-  async execute(inAppNotificationFormat?: boolean): Promise<Notification[]> {
+  async execute(
+    inAppNotificationFormat?: boolean,
+    onlyUnread?: boolean,
+    limit?: number,
+    offset?: number
+  ): Promise<Notification[]> {
     return (await this.notificationsRepository.getAllNotificationsByUser(
-      inAppNotificationFormat
+      inAppNotificationFormat,
+      onlyUnread,
+      limit,
+      offset
     )) as Notification[]
   }
 }

src/notifications/infra/repositories/NotificationsRepository.ts

@@ -7,13 +7,22 @@ export class NotificationsRepository extends ApiRepository implements INotificat
   private readonly notificationsResourceName: string = 'notifications'
 
   public async getAllNotificationsByUser(
-    inAppNotificationFormat?: boolean
+    inAppNotificationFormat?: boolean,
+    onlyUnread?: boolean,
+    limit?: number,
+    offset?: number
   ): Promise<Notification[]> {
-    const queryParams = inAppNotificationFormat ? { inAppNotificationFormat: 'true' } : undefined
+    const queryParams: Record<string, string | number> = {}
+
+    if (inAppNotificationFormat) queryParams.inAppNotificationFormat = 'true'
+    if (onlyUnread) queryParams.onlyUnread = 'true'
+    if (limit !== undefined) queryParams.limit = limit
+    if (offset !== undefined) queryParams.offset = offset
+
     return this.doGet(
       this.buildApiEndpoint(this.notificationsResourceName, 'all'),
       true,
-      queryParams
+      Object.keys(queryParams).length ? queryParams : undefined
     )
       .then((response) => {
         const notifications = response.data.data.notifications

src/notifications/infra/transformers/NotificationPayload.ts

@@ -25,6 +25,6 @@ export interface NotificationPayload {
   dataFileId?: number
   dataFileDisplayName?: string
   currentCurationStatus?: string
-  additionalInfo?: string
+  additionalInfo?: Record<string, unknown>
   objectDeleted?: boolean
 }

test/functional/notifications/GetAllNotificationsByUser.test.ts

@@ -34,4 +34,13 @@ describe('execute', () => {
     expect(notifications[0]).toHaveProperty('sentTimestamp')
     expect(notifications[0]).toHaveProperty('displayAsRead')
   })
+  test('should have correct in-app notification properties when filter and paging params are set', async () => {
+    const notifications = await getAllNotificationsByUser.execute(true, true, 1, 0)
+
+    expect(notifications[0]).toHaveProperty('id')
+    expect(notifications[0]).toHaveProperty('type')
+    expect(notifications[0]).toHaveProperty('sentTimestamp')
+    expect(notifications[0]).toHaveProperty('displayAsRead')
+    expect(notifications.length).toBeLessThanOrEqual(1)
+  })
 })