fix: naming of delete notification

Author: ChengShi-1

docs/useCases.md

@@ -87,7 +87,7 @@ The different use cases currently available in the package are classified below,
   - [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)
+  - [Delete Notification](#delete-notification)
 
 ## Collections
 
@@ -2017,24 +2017,24 @@ getAllNotificationsByUser.execute().then((notifications: Notification[]) => {
 
 _See [use case](../src/notifications/domain/useCases/GetAllNotificationsByUser.ts) implementation_.
 
-#### Delete Notification by User
+#### Delete Notification
 
 Deletes a specific notification for the current authenticated user by its ID.
 
 ##### Example call:
 
 ```typescript
-import { deleteNotificationByUser } from '@iqss/dataverse-client-javascript'
+import { deleteNotification } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 
 const notificationId = 123
 
-deleteNotificationByUser.execute(notificationId: number).then(() => {
+deleteNotification.execute(notificationId: number).then(() => {
   /* ... */
 })
 
 /* ... */
 ```
 
-_See [use case](../src/notifications/domain/useCases/DeleteNotificationByUser.ts) implementation_.
+_See [use case](../src/notifications/domain/useCases/DeleteNotification.ts) implementation_.

src/notifications/domain/repositories/INotificationsRepository.ts

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

…ain/useCases/DeleteNotificationByUser.ts …ns/domain/useCases/DeleteNotification.tssrc/notifications/domain/useCases/DeleteNotificationByUser.ts renamed to src/notifications/domain/useCases/DeleteNotification.ts src/notifications/domain/useCases/DeleteNotificationByUser.ts renamed to src/notifications/domain/useCases/DeleteNotification.ts

@@ -7,10 +7,10 @@ import { INotificationsRepository } from '../repositories/INotificationsReposito
  * @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> {
+export class DeleteNotification implements UseCase<void> {
   constructor(private readonly notificationsRepository: INotificationsRepository) {}
 
   async execute(notificationId: number): Promise<void> {
-    return this.notificationsRepository.deleteNotificationByUser(notificationId)
+    return this.notificationsRepository.deleteNotification(notificationId)
   }
 }

src/notifications/index.ts

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

src/notifications/infra/repositories/NotificationsRepository.ts

@@ -13,7 +13,7 @@ export class NotificationsRepository extends ApiRepository implements INotificat
       })
   }
 
-  public async deleteNotificationByUser(notificationId: number): Promise<void> {
+  public async deleteNotification(notificationId: number): Promise<void> {
     return this.doDelete(
       this.buildApiEndpoint(this.notificationsResourceName, notificationId.toString())
     )

…cations/DeleteNotificationByUser.test.ts …notifications/DeleteNotification.test.tstest/functional/notifications/DeleteNotificationByUser.test.ts renamed to test/functional/notifications/DeleteNotification.test.ts test/functional/notifications/DeleteNotificationByUser.test.ts renamed to test/functional/notifications/DeleteNotification.test.ts

@@ -1,9 +1,4 @@
-import {
-  ApiConfig,
-  deleteNotificationByUser,
-  getAllNotificationsByUser,
-  WriteError
-} from '../../../src'
+import { ApiConfig, deleteNotification, getAllNotificationsByUser, WriteError } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 
@@ -20,13 +15,13 @@ describe('execute', () => {
     const notifications = await getAllNotificationsByUser.execute()
     const notificationId = notifications[notifications.length - 1].id
 
-    await deleteNotificationByUser.execute(notificationId)
+    await deleteNotification.execute(notificationId)
 
     const notificationsAfterDelete = await getAllNotificationsByUser.execute()
     expect(notificationsAfterDelete.length).toBe(notifications.length - 1)
   })
 
   test('should throw an error when the notification id does not exist', async () => {
-    await expect(deleteNotificationByUser.execute(123)).rejects.toThrow(WriteError)
+    await expect(deleteNotification.execute(123)).rejects.toThrow(WriteError)
   })
 })

test/integration/notifications/NotificationsRepository.test.ts

@@ -55,7 +55,7 @@ describe('NotificationsRepository', () => {
 
     const notificationToDelete = notifications[0]
 
-    await sut.deleteNotificationByUser(notificationToDelete.id)
+    await sut.deleteNotification(notificationToDelete.id)
 
     const notificationsAfterDelete: Notification[] = await sut.getAllNotificationsByUser()
     const deletedNotification = notificationsAfterDelete.find(
@@ -65,14 +65,12 @@ describe('NotificationsRepository', () => {
   })
 
   test('should throw error when trying to delete notification with wrong ID', async () => {
-    const nonExistentMetadataBlockName = 99999
+    const nonExistentNotificationId = 99999
 
     const expectedError = new WriteError(
-      `[404] Notification ${nonExistentMetadataBlockName} not found.`
+      `[404] Notification ${nonExistentNotificationId} not found.`
     )
 
-    await expect(sut.deleteNotificationByUser(nonExistentMetadataBlockName)).rejects.toThrow(
-      expectedError
-    )
+    await expect(sut.deleteNotification(nonExistentNotificationId)).rejects.toThrow(expectedError)
   })
 })

…cations/DeleteNotificationByUser.test.ts …notifications/DeleteNotification.test.tstest/unit/notifications/DeleteNotificationByUser.test.ts renamed to test/unit/notifications/DeleteNotification.test.ts test/unit/notifications/DeleteNotificationByUser.test.ts renamed to test/unit/notifications/DeleteNotification.test.ts

@@ -1,4 +1,4 @@
-import { DeleteNotificationByUser } from '../../../src/notifications/domain/useCases/DeleteNotificationByUser'
+import { DeleteNotification } from '../../../src/notifications/domain/useCases/DeleteNotification'
 import { INotificationsRepository } from '../../../src/notifications/domain/repositories/INotificationsRepository'
 import { Notification } from '../../../src/notifications/domain/models/Notification'
 
@@ -23,23 +23,21 @@ describe('execute', () => {
   test('should delete notification from repository', async () => {
     const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
     notificationsRepositoryStub.getAllNotificationsByUser = jest.fn().mockResolvedValue([])
-    notificationsRepositoryStub.deleteNotificationByUser = jest
-      .fn()
-      .mockResolvedValue(mockNotifications)
-    const sut = new DeleteNotificationByUser(notificationsRepositoryStub)
+    notificationsRepositoryStub.deleteNotification = jest.fn().mockResolvedValue(mockNotifications)
+    const sut = new DeleteNotification(notificationsRepositoryStub)
 
     await sut.execute(123)
 
-    expect(notificationsRepositoryStub.deleteNotificationByUser).toHaveBeenCalledWith(123)
+    expect(notificationsRepositoryStub.deleteNotification).toHaveBeenCalledWith(123)
   })
 
   test('should throw error when repository throws error', async () => {
     const notificationsRepositoryStub: INotificationsRepository = {} as INotificationsRepository
     notificationsRepositoryStub.getAllNotificationsByUser = jest.fn().mockResolvedValue([])
-    notificationsRepositoryStub.deleteNotificationByUser = jest
+    notificationsRepositoryStub.deleteNotification = jest
       .fn()
       .mockRejectedValue(new Error('Repository error'))
-    const sut = new DeleteNotificationByUser(notificationsRepositoryStub)
+    const sut = new DeleteNotification(notificationsRepositoryStub)
 
     await expect(sut.execute(123)).rejects.toThrow('Repository error')
   })