feat: use case and docs

Author: g-saracca

docs/useCases.md

@@ -20,6 +20,7 @@ The different use cases currently available in the package are classified below,
     - [Update a Collection](#update-a-collection)
     - [Publish a Collection](#publish-a-collection)
     - [Update Collection Featured Items](#update-collection-featured-items)
+    - [Delete Collection Featured Items](#delete-collection-featured-items)
 - [Datasets](#Datasets)
   - [Datasets read use cases](#datasets-read-use-cases)
     - [Get a Dataset](#get-a-dataset)
@@ -340,6 +341,28 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 _See [use case](../src/collections/domain/useCases/UpdateCollectionFeaturedItems.ts)_ definition.
 
+#### Delete Collection Featured Items
+
+Deletes all featured items from a collection, given a collection identifier.
+
+##### Example call:
+
+```typescript
+import { deleteCollectionFeaturedItems } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const collectionIdOrAlias = 12345
+
+deleteCollectionFeaturedItems.execute(collectionIdOrAlias)
+
+/* ... */
+```
+
+The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
+
+_See [use case](../src/collections/domain/useCases/DeleteCollectionFeaturedItems.ts)_ definition.
+
 ## Datasets
 
 ### Datasets Read Use Cases

src/collections/domain/useCases/DeleteCollectionFeaturedItems.ts

@@ -0,0 +1,23 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ROOT_COLLECTION_ID } from '../models/Collection'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class DeleteCollectionFeaturedItems implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Deletes all featured items from a collection, given a collection identifier.
+   *
+   * @param {number | string} [collectionIdOrAlias = ':root'] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
+   * If this parameter is not set, the default value is: ':root'
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   * @throws {WriteError} - If there are errors while writing data.
+   */
+  async execute(collectionIdOrAlias: number | string = ROOT_COLLECTION_ID): Promise<void> {
+    return await this.collectionsRepository.deleteCollectionFeaturedItems(collectionIdOrAlias)
+  }
+}

src/collections/index.ts

@@ -8,6 +8,7 @@ import { UpdateCollection } from './domain/useCases/UpdateCollection'
 import { GetCollectionFeaturedItems } from './domain/useCases/GetCollectionFeaturedItems'
 import { CollectionsRepository } from './infra/repositories/CollectionsRepository'
 import { UpdateCollectionFeaturedItems } from './domain/useCases/UpdateCollectionFeaturedItems'
+import { DeleteCollectionFeaturedItems } from './domain/useCases/DeleteCollectionFeaturedItems'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -20,6 +21,7 @@ const publishCollection = new PublishCollection(collectionsRepository)
 const updateCollection = new UpdateCollection(collectionsRepository)
 const getCollectionFeaturedItems = new GetCollectionFeaturedItems(collectionsRepository)
 const updateCollectionFeaturedItems = new UpdateCollectionFeaturedItems(collectionsRepository)
+const deleteCollectionFeaturedItems = new DeleteCollectionFeaturedItems(collectionsRepository)
 
 export {
   getCollection,
@@ -30,7 +32,8 @@ export {
   publishCollection,
   updateCollection,
   getCollectionFeaturedItems,
-  updateCollectionFeaturedItems
+  updateCollectionFeaturedItems,
+  deleteCollectionFeaturedItems
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'