fix: numbers for dataset id and string for collection alias

Author: g-saracca

docs/useCases.md

@@ -958,9 +958,9 @@ import { linkDataset } from '@iqss/dataverse-client-javascript'
 /* ... */
 
 const datasetId = 1
-const collectionIdOrAlias = 12345
+const collectionAlias = 'collection-alias'
 
-linkDataset.execute(datasetId, collectionIdOrAlias)
+linkDataset.execute(datasetId, collectionAlias)
 
 /* ... */
 ```
@@ -979,9 +979,9 @@ import { unlinkDataset } from '@iqss/dataverse-client-javascript'
 /* ... */
 
 const datasetId = 1
-const collectionIdOrAlias = 12345
+const collectionAlias = 'collection-alias'
 
-unlinkDataset.execute(datasetId, collectionIdOrAlias)
+unlinkDataset.execute(datasetId, collectionAlias)
 
 /* ... */
 ```

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -9,6 +9,7 @@ import { MetadataBlock } from '../../../metadataBlocks'
 import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
 import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
 import { DatasetVersionSummaryInfo } from '../models/DatasetVersionSummaryInfo'
+import { DatasetLinkedCollection } from '../models/DatasetLinkedCollection'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -61,6 +62,7 @@ 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>
+  linkDataset(datasetId: number, collectionAlias: string): Promise<void>
+  unlinkDataset(datasetId: number, collectionAlias: string): Promise<void>
+  getDatasetLinkedCollections(datasetId: number | string): Promise<DatasetLinkedCollection[]>
 }

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 | 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)
+   * @param {number} [datasetId] - The dataset id.
+   * @param {string} [collectionAlias] - The collection alias.
    * @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)
+  async execute(datasetId: number, collectionAlias: string): Promise<void> {
+    return await this.datasetsRepository.linkDataset(datasetId, collectionAlias)
   }
 }

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 | 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)
+   * @param {number} [datasetId] - The dataset id.
+   * @param {string} [collectionAlias] - The collection alias.
    * @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)
+  async execute(datasetId: number, collectionAlias: string): Promise<void> {
+    return await this.datasetsRepository.unlinkDataset(datasetId, collectionAlias)
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -20,6 +20,7 @@ import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import { transformDatasetVersionDiffResponseToDatasetVersionDiff } from './transformers/datasetVersionDiffTransformers'
 import { DatasetDownloadCount } from '../../domain/models/DatasetDownloadCount'
 import { DatasetVersionSummaryInfo } from '../../domain/models/DatasetVersionSummaryInfo'
+import { DatasetLinkedCollection } from '../../domain/models/DatasetLinkedCollection'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -288,27 +289,29 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       })
   }
 
-  public async linkDataset(
-    datasetId: number | string,
-    collectionIdOrAlias: number | string
-  ): Promise<void> {
-    return this.doPut(`/${this.datasetsResourceName}/${datasetId}/link/${collectionIdOrAlias}`, {})
+  public async linkDataset(datasetId: number, collectionAlias: string): Promise<void> {
+    return this.doPut(`/${this.datasetsResourceName}/${datasetId}/link/${collectionAlias}`, {})
       .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}`
-    )
+  public async unlinkDataset(datasetId: number, collectionAlias: string): Promise<void> {
+    return this.doDelete(`/${this.datasetsResourceName}/${datasetId}/deleteLink/${collectionAlias}`)
       .then(() => undefined)
       .catch((error) => {
         throw error
       })
   }
+
+  public async getDatasetLinkedCollections(
+    datasetId: number | string
+  ): Promise<DatasetLinkedCollection[]> {
+    return this.doGet(this.buildApiEndpoint(this.datasetsResourceName, 'links', datasetId), true)
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
 }