feat: use case

Author: g-saracca

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -10,6 +10,8 @@ import { CollectionUserPermissions } from '../models/CollectionUserPermissions'
 import { PublicationStatus } from '../../../core/domain/models/PublicationStatus'
 import { CollectionItemType } from '../../../collections/domain/models/CollectionItemType'
 import { CollectionLinks } from '../models/CollectionLinks'
+import { CollectionSummary } from '../models/CollectionSummary'
+import { LinkingObjectType } from '../useCases/GetCollectionsForLinking'
 
 export interface ICollectionsRepository {
   getCollection(collectionIdOrAlias: number | string): Promise<Collection>
@@ -60,4 +62,9 @@ export interface ICollectionsRepository {
     linkingCollectionIdOrAlias: number | string
   ): Promise<void>
   getCollectionLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks>
+  getCollectionsForLinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm: string
+  ): Promise<CollectionSummary[]>
 }

src/collections/domain/useCases/GetCollectionsForLinking.ts

@@ -0,0 +1,27 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+import { CollectionSummary } from '../models/CollectionSummary'
+
+export type LinkingObjectType = 'collection' | 'dataset'
+
+export class GetCollectionsForLinking implements UseCase<CollectionSummary[]> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Returns an array of CollectionSummary (id, alias, displayName) to which the given Dataverse collection or Dataset may be linked.
+   * @param objectType - 'dataverse' when providing a collection identifier/alias; 'dataset' when providing a dataset persistentId.
+   * @param id - For objectType 'dataverse', a numeric id or alias string. For 'dataset', the persistentId string (e.g., doi:...)
+   * @param searchTerm - Optional search term to filter by collection name. Defaults to empty string (no filtering).
+   */
+  async execute(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm = ''
+  ): Promise<CollectionSummary[]> {
+    return await this.collectionsRepository.getCollectionsForLinking(objectType, id, searchTerm)
+  }
+}

src/collections/index.ts

@@ -15,6 +15,7 @@ import { DeleteCollectionFeaturedItem } from './domain/useCases/DeleteCollection
 import { LinkCollection } from './domain/useCases/LinkCollection'
 import { UnlinkCollection } from './domain/useCases/UnlinkCollection'
 import { GetCollectionLinks } from './domain/useCases/GetCollectionLinks'
+import { GetCollectionsForLinking } from './domain/useCases/GetCollectionsForLinking'
 
 const collectionsRepository = new CollectionsRepository()
 
@@ -34,6 +35,7 @@ const deleteCollectionFeaturedItem = new DeleteCollectionFeaturedItem(collection
 const linkCollection = new LinkCollection(collectionsRepository)
 const unlinkCollection = new UnlinkCollection(collectionsRepository)
 const getCollectionLinks = new GetCollectionLinks(collectionsRepository)
+const getCollectionsForLinking = new GetCollectionsForLinking(collectionsRepository)
 
 export {
   getCollection,
@@ -51,7 +53,8 @@ export {
   deleteCollectionFeaturedItem,
   linkCollection,
   unlinkCollection,
-  getCollectionLinks
+  getCollectionLinks,
+  getCollectionsForLinking
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'
@@ -62,3 +65,4 @@ export { CollectionItemType } from './domain/models/CollectionItemType'
 export { CollectionSearchCriteria } from './domain/models/CollectionSearchCriteria'
 export { FeaturedItem } from './domain/models/FeaturedItem'
 export { FeaturedItemsDTO } from './domain/dtos/FeaturedItemsDTO'
+export { CollectionSummary } from './domain/models/CollectionSummary'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -38,6 +38,8 @@ import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { PublicationStatus } from '../../../core/domain/models/PublicationStatus'
 import { ReadError } from '../../../core/domain/repositories/ReadError'
 import { CollectionLinks } from '../../domain/models/CollectionLinks'
+import { CollectionSummary } from '../../domain/models/CollectionSummary'
+import { LinkingObjectType } from '../../domain/useCases/GetCollectionsForLinking'
 
 export interface NewCollectionRequestPayload {
   alias: string
@@ -93,7 +95,6 @@ export enum GetMyDataCollectionItemsQueryParams {
 
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
-
   public async getCollection(
     collectionIdOrAlias: number | string = ROOT_COLLECTION_ID
   ): Promise<Collection> {
@@ -485,4 +486,41 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+
+  public async getCollectionsForLinking(
+    objectType: LinkingObjectType,
+    id: number | string,
+    searchTerm: string
+  ): Promise<CollectionSummary[]> {
+    let path: string
+    const queryParams = new URLSearchParams()
+    if (objectType === 'collection') {
+      path = `/${this.collectionsResourceName}/${id}/dataverse/linkingDataverses`
+    } else {
+      path = `/${this.collectionsResourceName}/:persistentId/dataset/linkingDataverses`
+      queryParams.set('persistentId', String(id))
+    }
+
+    if (searchTerm) {
+      queryParams.set('searchTerm', searchTerm)
+    }
+
+    return this.doGet(path, true, queryParams)
+      .then((response) => {
+        const payload = response.data.data as {
+          id: number
+          alias: string
+          name: string
+        }[]
+
+        return payload.map((item) => ({
+          id: item.id,
+          alias: item.alias,
+          displayName: item.name
+        }))
+      })
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/environment/.env

@@ -1,6 +1,6 @@
 POSTGRES_VERSION=17
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=9.8.0
-DATAVERSE_IMAGE_REGISTRY=docker.io
-DATAVERSE_IMAGE_TAG=unstable
+DATAVERSE_IMAGE_REGISTRY=ghcr.io
+DATAVERSE_IMAGE_TAG=11710-find-dataverses-for-linking
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m