feat: GetDatasetLinkedCollections use case

Author: g-saracca

docs/useCases.md

@@ -36,6 +36,7 @@ The different use cases currently available in the package are classified below,
     - [Get Differences between Two Dataset Versions](#get-differences-between-two-dataset-versions)
     - [List All Datasets](#list-all-datasets)
     - [Get Dataset Versions Summaries](#get-dataset-versions-summaries)
+    - [Get Dataset Linked Collections](#get-dataset-linked-collections)
   - [Datasets write use cases](#datasets-write-use-cases)
     - [Create a Dataset](#create-a-dataset)
     - [Update a Dataset](#update-a-dataset)
@@ -737,6 +738,30 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetVersionsSummaries.ts)
 
 The `datasetId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
 
+#### Get Dataset Linked Collections
+
+Returns an array of [DatasetLinkedCollection](../src/datasets/domain/models/DatasetLinkedCollection.ts) that contains the collections linked to a dataset.
+
+##### Example call:
+
+```typescript
+import { getDatasetLinkedCollections } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const datasetId = 'doi:10.77777/FK2/AAAAAA'
+
+getDatasetLinkedCollections
+  .execute(datasetId)
+  .then((datasetLinkedCollections: DatasetLinkedCollection[]) => {
+    /* ... */
+  })
+
+/* ... */
+```
+
+_See [use case](../src/datasets/domain/useCases/GetDatasetLinkedCollections.ts) implementation_.
+
 ### Datasets Write Use Cases
 
 #### Create a Dataset

src/datasets/domain/models/DatasetLinkedCollection.ts

@@ -0,0 +1,5 @@
+export interface DatasetLinkedCollection {
+  id: number
+  alias: string
+  displayName: string
+}

src/datasets/domain/useCases/GetDatasetLinkedCollections.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetLinkedCollection } from '../models/DatasetLinkedCollection'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class GetDatasetLinkedCollections implements UseCase<DatasetLinkedCollection[]> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Returns a list of collections linked to a dataset.
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<DatasetLinkedCollection[]>}
+   */
+  async execute(datasetId: number | string): Promise<DatasetLinkedCollection[]> {
+    return await this.datasetsRepository.getDatasetLinkedCollections(datasetId)
+  }
+}

src/datasets/index.ts

@@ -22,6 +22,7 @@ import { GetDatasetVersionsSummaries } from './domain/useCases/GetDatasetVersion
 import { DeleteDatasetDraft } from './domain/useCases/DeleteDatasetDraft'
 import { LinkDataset } from './domain/useCases/LinkDataset'
 import { UnlinkDataset } from './domain/useCases/UnlinkDataset'
+import { GetDatasetLinkedCollections } from './domain/useCases/GetDatasetLinkedCollections'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -58,6 +59,7 @@ const getDatasetVersionsSummaries = new GetDatasetVersionsSummaries(datasetsRepo
 const deleteDatasetDraft = new DeleteDatasetDraft(datasetsRepository)
 const linkDataset = new LinkDataset(datasetsRepository)
 const unlinkDataset = new UnlinkDataset(datasetsRepository)
+const getDatasetLinkedCollections = new GetDatasetLinkedCollections(datasetsRepository)
 
 export {
   getDataset,
@@ -77,7 +79,8 @@ export {
   getDatasetVersionsSummaries,
   deleteDatasetDraft,
   linkDataset,
-  unlinkDataset
+  unlinkDataset,
+  getDatasetLinkedCollections
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'
@@ -111,3 +114,4 @@ export {
   DatasetVersionSummaryInfo,
   DatasetVersionSummaryStringValues
 } from './domain/models/DatasetVersionSummaryInfo'
+export { DatasetLinkedCollection } from './domain/models/DatasetLinkedCollection'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -21,6 +21,7 @@ import { transformDatasetVersionDiffResponseToDatasetVersionDiff } from './trans
 import { DatasetDownloadCount } from '../../domain/models/DatasetDownloadCount'
 import { DatasetVersionSummaryInfo } from '../../domain/models/DatasetVersionSummaryInfo'
 import { DatasetLinkedCollection } from '../../domain/models/DatasetLinkedCollection'
+import { transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection } from './transformers/datasetLinkedCollectionsTransformers'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -309,7 +310,9 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
     datasetId: number | string
   ): Promise<DatasetLinkedCollection[]> {
     return this.doGet(this.buildApiEndpoint(this.datasetsResourceName, 'links', datasetId), true)
-      .then((response) => response.data.data)
+      .then((response) =>
+        transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection(response.data.data)
+      )
       .catch((error) => {
         throw error
       })

src/datasets/infra/repositories/transformers/DatasetLinkedCollectionsPayload.ts

@@ -0,0 +1,9 @@
+export interface DatasetLinkedCollectionsPayload {
+  id: number
+  identifier: string
+  'linked-dataverses': {
+    id: number
+    alias: string
+    displayName: string
+  }[]
+}

src/datasets/infra/repositories/transformers/datasetLinkedCollectionsTransformers.ts

@@ -0,0 +1,12 @@
+import { DatasetLinkedCollection } from '../../../domain/models/DatasetLinkedCollection'
+import { DatasetLinkedCollectionsPayload } from './DatasetLinkedCollectionsPayload'
+
+export const transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection = (
+  payload: DatasetLinkedCollectionsPayload
+): DatasetLinkedCollection[] => {
+  return payload['linked-dataverses'].map((linkedDataverse) => ({
+    id: linkedDataverse.id,
+    alias: linkedDataverse.alias,
+    displayName: linkedDataverse.displayName
+  }))
+}