feat: add delete single featured item use case

Author: g-saracca

docs/useCases.md

@@ -23,6 +23,7 @@ The different use cases currently available in the package are classified below,
     - [Delete a Collection](#delete-a-collection)
     - [Update Collection Featured Items](#update-collection-featured-items)
     - [Delete Collection Featured Items](#delete-collection-featured-items)
+    - [Delete a Collection Featured Item](#delete-a-collection-featured-item)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)
@@ -451,6 +452,26 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 _See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItems.ts)_ definition.
 
+#### Delete A Collection Featured Item
+
+Deletes a single featured item, given a featured item id.
+
+##### Example call:
+
+```typescript
+import { deleteCollectionFeaturedItem } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const featuredItemId = 12345
+
+deleteCollectionFeaturedItem.execute(featuredItemId)
+
+/* ... */
+```
+
+_See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItem.ts)_ definition.
+
 ## Datasets
 
 ### Datasets Read Use Cases

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -50,4 +50,5 @@ export interface ICollectionsRepository {
     featuredItemDTOs: CollectionFeaturedItemsDTO
   ): Promise<CollectionFeaturedItem[]>
   deleteCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<void>
+  deleteCollectionFeaturedItem(featuredItemId: number): Promise<void>
 }

src/collections/domain/useCases/DeleteCollectionFeaturedItem.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class DeleteCollectionFeaturedItem implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Deletes a single featured item, given a featured item id.
+   *
+   * @param {number} [featuredItemId] - The id of the featured item to delete.
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   * @throws {WriteError} - If there are errors while writing data.
+   */
+  async execute(featuredItemId: number): Promise<void> {
+    return await this.collectionsRepository.deleteCollectionFeaturedItem(featuredItemId)
+  }
+}

src/collections/index.ts

@@ -11,6 +11,7 @@ import { UpdateCollectionFeaturedItems } from './domain/useCases/UpdateCollectio
 import { DeleteCollectionFeaturedItems } from './domain/useCases/DeleteCollectionFeaturedItems'
 import { DeleteCollection } from './domain/useCases/DeleteCollection'
 import { GetMyDataCollectionItems } from './domain/useCases/GetMyDataCollectionItems'
+import { DeleteCollectionFeaturedItem } from './domain/useCases/DeleteCollectionFeaturedItem'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -26,6 +27,7 @@ const getCollectionFeaturedItems = new GetCollectionFeaturedItems(collectionsRep
 const updateCollectionFeaturedItems = new UpdateCollectionFeaturedItems(collectionsRepository)
 const deleteCollectionFeaturedItems = new DeleteCollectionFeaturedItems(collectionsRepository)
 const deleteCollection = new DeleteCollection(collectionsRepository)
+const deleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(collectionsRepository)
 
 export {
   getCollection,
@@ -39,7 +41,8 @@ export {
   getCollectionFeaturedItems,
   updateCollectionFeaturedItems,
   deleteCollectionFeaturedItems,
-  deleteCollection
+  deleteCollection,
+  deleteCollectionFeaturedItem
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -436,4 +436,12 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+
+  public async deleteCollectionFeaturedItem(featuredItemId: number): Promise<void> {
+    return this.doDelete(`/dataverseFeaturedItems/${featuredItemId}`)
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/functional/collections/DeleteCollectionFeaturedItem.test.ts

@@ -0,0 +1,70 @@
+import { ApiConfig, deleteCollectionFeaturedItem, WriteError } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import {
+  createCollectionViaApi,
+  deleteCollectionViaApi
+} from '../../testHelpers/collections/collectionHelper'
+import { createCollectionCustomFeaturedItemViaApi } from '../../testHelpers/collections/collectionFeaturedItemsHelper'
+
+describe('execute', () => {
+  const testCollectionAlias = 'deleteCollectionFeaturedItemTest'
+  let featuredItemTestId: number
+
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  beforeAll(async () => {
+    try {
+      await createCollectionViaApi(testCollectionAlias)
+      const featuredItem = await createCollectionCustomFeaturedItemViaApi(testCollectionAlias, {
+        content: '<p class="rte-paragraph">Test content</p>',
+        displayOrder: 1,
+        withFile: true,
+        fileName: 'featured-item-test-image.png'
+      })
+      featuredItemTestId = featuredItem.id
+    } catch (error) {
+      throw new Error(
+        `Tests beforeAll(): Error while creating test collection: ${testCollectionAlias}`
+      )
+    }
+  })
+
+  afterAll(async () => {
+    try {
+      await deleteCollectionViaApi(testCollectionAlias)
+    } catch (error) {
+      throw new Error(
+        `Tests afterAll(): Error while deleting test collection: ${testCollectionAlias}`
+      )
+    }
+  })
+
+  test('should succesfully delete the featured item', async () => {
+    const actual = await deleteCollectionFeaturedItem.execute(featuredItemTestId)
+
+    expect(actual).toBeUndefined()
+  })
+
+  test('should throw an error when featured item does not exist', async () => {
+    const invalidFeaturedItemId = 99
+    let writeError: WriteError | undefined
+
+    try {
+      await deleteCollectionFeaturedItem.execute(invalidFeaturedItemId)
+    } catch (error) {
+      writeError = error as WriteError
+    } finally {
+      expect(writeError).toBeInstanceOf(WriteError)
+      expect((writeError as WriteError).message).toEqual(
+        `There was an error when writing the resource. Reason was: [404] Could not find dataverse featured item with identifier ${invalidFeaturedItemId}`
+      )
+    }
+  })
+})

test/integration/collections/CollectionsRepository.test.ts

@@ -1440,6 +1440,42 @@ describe('CollectionsRepository', () => {
       expect(featuredItemsResponseAfterDeletion).toStrictEqual([])
     })
   })
+
+  describe('deleteCollectionFeaturedItem', () => {
+    let featuredItemTestId: number
+
+    beforeAll(async () => {
+      try {
+        const featuredItem = await createCollectionCustomFeaturedItemViaApi(testCollectionAlias, {
+          content: '<p class="rte-paragraph">Test content</p>',
+          displayOrder: 1,
+          withFile: true,
+          fileName: 'featured-item-test-image.png'
+        })
+        featuredItemTestId = featuredItem.id
+      } catch (error) {
+        throw new Error(
+          `Tests afterAll(): Error while creating test featured items for collection: ${testCollectionAlias}`
+        )
+      }
+    })
+
+    it('should delete a collection featured item', async () => {
+      const featuredItemsResponseBeforeDeletion = await sut.getCollectionFeaturedItems(
+        testCollectionAlias
+      )
+
+      expect(featuredItemsResponseBeforeDeletion).toHaveLength(1)
+
+      await sut.deleteCollectionFeaturedItem(featuredItemTestId)
+
+      const featuredItemsResponseAfterDeletion = await sut.getCollectionFeaturedItems(
+        testCollectionAlias
+      )
+
+      expect(featuredItemsResponseAfterDeletion).toStrictEqual([])
+    })
+  })
   describe('getMyDataCollectionItems', () => {
     let testDatasetIds: CreatedDatasetIdentifiers
 

test/unit/collections/DeleteCollectionFeaturedItem.test.ts

@@ -0,0 +1,29 @@
+import { ICollectionsRepository } from '../../../src/collections/domain/repositories/ICollectionsRepository'
+import { WriteError } from '../../../src'
+import { DeleteCollectionFeaturedItem } from '../../../src/collections/domain/useCases/DeleteCollectionFeaturedItem'
+
+describe('execute', () => {
+  test('should return undefined on repository success', async () => {
+    const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionRepositoryStub.deleteCollectionFeaturedItem = jest.fn().mockResolvedValue(undefined)
+    const testDeleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(
+      collectionRepositoryStub
+    )
+
+    const actual = await testDeleteCollectionFeaturedItem.execute(1)
+
+    expect(actual).toEqual(undefined)
+  })
+
+  test('should return error result on repository error', async () => {
+    const collectionRepositoryStub: ICollectionsRepository = {} as ICollectionsRepository
+    collectionRepositoryStub.deleteCollectionFeaturedItem = jest
+      .fn()
+      .mockRejectedValue(new WriteError())
+    const testDeleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(
+      collectionRepositoryStub
+    )
+
+    await expect(testDeleteCollectionFeaturedItem.execute(1)).rejects.toThrow(WriteError)
+  })
+})