feat: add link and unlink use cases

Author: g-saracca

docs/useCases.md

@@ -42,6 +42,8 @@ The different use cases currently available in the package are classified below,
     - [Publish a Dataset](#publish-a-dataset)
     - [Deaccession a Dataset](#deaccession-a-dataset)
     - [Delete a Draft Dataset](#delete-a-draft-dataset)
+    - [Link a Dataset](#link-a-dataset)
+    - [Unlink a Dataset](#unlink-a-dataset)
 - [Files](#Files)
   - [Files read use cases](#files-read-use-cases)
     - [Get a File](#get-a-file)
@@ -944,6 +946,48 @@ The `datasetId` parameter is a number for numeric identifiers or string for pers
 
 If you try to delete a dataset without draft version, you will get a not found error.
 
+#### Link a Dataset
+
+Creates a link between a Dataset and a Collection.
+
+##### Example call:
+
+```typescript
+import { linkDataset } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const datasetId = 1
+const collectionIdOrAlias = 12345
+
+linkDataset.execute(datasetId, collectionIdOrAlias)
+
+/* ... */
+```
+
+_See [use case](../src/datasets/domain/useCases/LinkDataset.ts) implementation_.
+
+#### Unlink a Dataset
+
+Removes a link between a Dataset and a Collection.
+
+##### Example call:
+
+```typescript
+import { unlinkDataset } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const datasetId = 1
+const collectionIdOrAlias = 12345
+
+unlinkDataset.execute(datasetId, collectionIdOrAlias)
+
+/* ... */
+```
+
+_See [use case](../src/datasets/domain/useCases/UnlinkDataset.ts) implementation_.
+
 #### Get Download Count of a Dataset
 
 Total number of downloads requested for a dataset, given a dataset numeric identifier,

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -61,4 +61,6 @@ export interface IDatasetsRepository {
   ): Promise<DatasetDownloadCount>
   getDatasetVersionsSummaries(datasetId: number | string): Promise<DatasetVersionSummaryInfo[]>
   deleteDatasetDraft(datasetId: number | string): Promise<void>
+  linkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
+  unlinkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
 }

src/datasets/domain/useCases/LinkDataset.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class LinkDataset implements UseCase<void> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Creates a link between a Dataset and a Collection.
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @param {number | string} [collectionIdOrAlias] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   */
+  async execute(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void> {
+    return await this.datasetsRepository.linkDataset(datasetId, collectionIdOrAlias)
+  }
+}

src/datasets/domain/useCases/UnlinkDataset.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class UnlinkDataset implements UseCase<void> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Removes a link between a Dataset and a Collection.
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @param {number | string} [collectionIdOrAlias] - A generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId)
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   */
+  async execute(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void> {
+    return await this.datasetsRepository.unlinkDataset(datasetId, collectionIdOrAlias)
+  }
+}

src/datasets/index.ts

@@ -20,6 +20,8 @@ import { DeaccessionDataset } from './domain/useCases/DeaccessionDataset'
 import { GetDatasetDownloadCount } from './domain/useCases/GetDatasetDownloadCount'
 import { GetDatasetVersionsSummaries } from './domain/useCases/GetDatasetVersionsSummaries'
 import { DeleteDatasetDraft } from './domain/useCases/DeleteDatasetDraft'
+import { LinkDataset } from './domain/useCases/LinkDataset'
+import { UnlinkDataset } from './domain/useCases/UnlinkDataset'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -54,6 +56,8 @@ const deaccessionDataset = new DeaccessionDataset(datasetsRepository)
 const getDatasetDownloadCount = new GetDatasetDownloadCount(datasetsRepository)
 const getDatasetVersionsSummaries = new GetDatasetVersionsSummaries(datasetsRepository)
 const deleteDatasetDraft = new DeleteDatasetDraft(datasetsRepository)
+const linkDataset = new LinkDataset(datasetsRepository)
+const unlinkDataset = new UnlinkDataset(datasetsRepository)
 
 export {
   getDataset,
@@ -71,7 +75,9 @@ export {
   deaccessionDataset,
   getDatasetDownloadCount,
   getDatasetVersionsSummaries,
-  deleteDatasetDraft
+  deleteDatasetDraft,
+  linkDataset,
+  unlinkDataset
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -287,4 +287,28 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
+  public async linkDataset(
+    datasetId: number | string,
+    collectionIdOrAlias: number | string
+  ): Promise<void> {
+    return this.doPut(`/${this.datasetsResourceName}/${datasetId}/link/${collectionIdOrAlias}`, {})
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
+
+  public async unlinkDataset(
+    datasetId: number | string,
+    collectionIdOrAlias: number | string
+  ): Promise<void> {
+    return this.doDelete(
+      `/${this.datasetsResourceName}/${datasetId}/deleteLink/${collectionIdOrAlias}`
+    )
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }