feat: update linkDataset and unlinkDataset methods to accept string or number for dataset and collection identifiers

Author: g-saracca

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -65,8 +65,8 @@ export interface IDatasetsRepository {
   ): Promise<DatasetDownloadCount>
   getDatasetVersionsSummaries(datasetId: number | string): Promise<DatasetVersionSummaryInfo[]>
   deleteDatasetDraft(datasetId: number | string): Promise<void>
-  linkDataset(datasetId: number, collectionAlias: string): Promise<void>
-  unlinkDataset(datasetId: number, collectionAlias: string): Promise<void>
+  linkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
+  unlinkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
   getDatasetLinkedCollections(datasetId: number | string): Promise<DatasetLinkedCollection[]>
   getDatasetAvailableCategories(datasetId: number | string): Promise<string[]>
   getDatasetCitationInOtherFormats(

src/datasets/domain/useCases/LinkDataset.ts

@@ -11,11 +11,11 @@ export class LinkDataset implements UseCase<void> {
   /**
    * Creates a link between a Dataset and a Collection.
    *
-   * @param {number} [datasetId] - The dataset id.
-   * @param {string} [collectionAlias] - The collection alias.
+   * @param {number | string} [datasetId] - The dataset id (numeric) or persistent identifier string.
+   * @param {number | string} [collectionIdOrAlias] - The collection identifier (numeric id) or alias.
    * @returns {Promise<void>} - This method does not return anything upon successful completion.
    */
-  async execute(datasetId: number, collectionAlias: string): Promise<void> {
-    return await this.datasetsRepository.linkDataset(datasetId, collectionAlias)
+  async execute(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void> {
+    return await this.datasetsRepository.linkDataset(datasetId, collectionIdOrAlias)
   }
 }

src/datasets/domain/useCases/UnlinkDataset.ts

@@ -11,11 +11,11 @@ export class UnlinkDataset implements UseCase<void> {
   /**
    * Removes a link between a Dataset and a Collection.
    *
-   * @param {number} [datasetId] - The dataset id.
-   * @param {string} [collectionAlias] - The collection alias.
+   * @param {number | string} [datasetId] - The dataset id (numeric) or persistent identifier string.
+   * @param {number | string} [collectionIdOrAlias] - The collection identifier (numeric id) or alias.
    * @returns {Promise<void>} - This method does not return anything upon successful completion.
    */
-  async execute(datasetId: number, collectionAlias: string): Promise<void> {
-    return await this.datasetsRepository.unlinkDataset(datasetId, collectionAlias)
+  async execute(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void> {
+    return await this.datasetsRepository.unlinkDataset(datasetId, collectionIdOrAlias)
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

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

test/integration/datasets/DatasetsRepository.test.ts

@@ -1533,6 +1533,21 @@ describe('DatasetsRepository', () => {
         sut.linkDataset(testDatasetIds.numericId, 'nonExistentCollectionAlias')
       ).rejects.toThrow()
     })
+
+    test('should link a dataset to another collection using persistent id', async () => {
+      const persistentCollectionAlias = 'testLinkDatasetCollectionPersistent'
+      await createCollectionViaApi(persistentCollectionAlias)
+
+      const actual = await sut.linkDataset(testDatasetIds.persistentId, persistentCollectionAlias)
+
+      expect(actual).toBeUndefined()
+
+      const linkedCollections = await sut.getDatasetLinkedCollections(testDatasetIds.numericId)
+      const aliases = linkedCollections.map((c) => c.alias)
+      expect(aliases).toContain(persistentCollectionAlias)
+
+      await deleteCollectionViaApi(persistentCollectionAlias)
+    })
   })
 
   describe('unlinkDataset', () => {
@@ -1578,6 +1593,27 @@ describe('DatasetsRepository', () => {
         sut.unlinkDataset(testDatasetIds.numericId, testCollectionAlias)
       ).rejects.toThrow()
     })
+
+    test('should unlink a dataset from a collection using persistent id', async () => {
+      const persistentCollectionAlias = 'testUnlinkDatasetCollectionPersistent'
+      await createCollectionViaApi(persistentCollectionAlias)
+
+      await sut.linkDataset(testDatasetIds.persistentId, persistentCollectionAlias)
+      const linkedCollections = await sut.getDatasetLinkedCollections(testDatasetIds.numericId)
+      const aliases = linkedCollections.map((c) => c.alias)
+      expect(aliases).toContain(persistentCollectionAlias)
+
+      const actual = await sut.unlinkDataset(testDatasetIds.persistentId, persistentCollectionAlias)
+
+      expect(actual).toBeUndefined()
+      const updatedLinkedCollections = await sut.getDatasetLinkedCollections(
+        testDatasetIds.numericId
+      )
+      const updatedAliases = updatedLinkedCollections.map((c) => c.alias)
+      expect(updatedAliases).not.toContain(persistentCollectionAlias)
+
+      await deleteCollectionViaApi(persistentCollectionAlias)
+    })
   })
 
   describe('getDatasetLinkedCollections', () => {