Merge pull request #377 from IQSS/revert-367-feat/345-get-collection-for-linking

Revert "Get Collections For Linking Use Case"

Author: g-saracca

docs/useCases.md

@@ -16,7 +16,6 @@ The different use cases currently available in the package are classified below,
     - [List All Collection Items](#list-all-collection-items)
     - [List My Data Collection Items](#list-my-data-collection-items)
     - [Get Collection Featured Items](#get-collection-featured-items)
-    - [Get Collections for Linking](#get-collections-for-linking)
   - [Collections write use cases](#collections-write-use-cases)
     - [Create a Collection](#create-a-collection)
     - [Update a Collection](#update-a-collection)
@@ -337,69 +336,6 @@ The `collectionIdOrAlias` is a generic collection identifier, which can be eithe
 
 If no collection identifier is specified, the default collection identifier; `:root` will be used. If you want to search for a different collection, you must add the collection identifier as a parameter in the use case call.
 
-#### Get Collections for Linking
-
-Returns an array of [CollectionSummary](../src/collections/domain/models/CollectionSummary.ts) (id, alias, displayName) representing the Dataverse collections to which a given Dataverse collection or Dataset may be linked.
-
-This use case supports an optional `searchTerm` to filter by collection name.
-
-##### Example calls:
-
-```typescript
-import { getCollectionsForLinking } from '@iqss/dataverse-client-javascript'
-
-/* ... */
-
-// Case 1: For a given Dataverse collection (by numeric id or alias)
-const collectionIdOrAlias: number | string = 'collectionAlias' // or 123
-const searchTerm = 'searchOn'
-
-getCollectionsForLinking
-  .execute('collection', collectionIdOrAlias, searchTerm)
-  .then((collections) => {
-    // collections: CollectionSummary[]
-    /* ... */
-  })
-  .catch((error: Error) => {
-    /* ... */
-  })
-
-/* ... */
-
-// Case 2: For a given Dataset (by persistent identifier)
-const persistentId = 'doi:10.5072/FK2/J8SJZB'
-
-getCollectionsForLinking
-  .execute('dataset', persistentId, searchTerm)
-  .then((collections) => {
-    // collections: CollectionSummary[]
-    /* ... */
-  })
-  .catch((error: Error) => {
-    /* ... */
-  })
-
-// Case 3: [alreadyLinked] Optional flag. When true, returns collections currently linked (candidates to unlink). Defaults to false.
-const alreadyLinked = true
-
-getCollectionsForLinking
-  .execute('dataset', persistentId, searchTerm, alreadyLinked)
-  .then((collections) => {
-    // collections: CollectionSummary[]
-    /* ... */
-  })
-  .catch((error: Error) => {
-    /* ... */
-  })
-```
-
-_See [use case](../src/collections/domain/useCases/GetCollectionsForLinking.ts) implementation_.
-
-Notes:
-
-- When the first argument is `'collection'`, the second argument can be a numeric collection id or a collection alias.
-- When the first argument is `'dataset'`, the second argument must be the dataset persistent identifier string (e.g., `doi:...`).
-
 ### Collections Write Use Cases
 
 #### Create a Collection

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -10,8 +10,6 @@ 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>
@@ -62,10 +60,4 @@ export interface ICollectionsRepository {
     linkingCollectionIdOrAlias: number | string
   ): Promise<void>
   getCollectionLinks(collectionIdOrAlias: number | string): Promise<CollectionLinks>
-  getCollectionsForLinking(
-    objectType: LinkingObjectType,
-    id: number | string,
-    searchTerm: string,
-    alreadyLinked: boolean
-  ): Promise<CollectionSummary[]>
 }

src/collections/domain/useCases/GetCollectionsForLinking.ts

@@ -15,7 +15,6 @@ 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()
 
@@ -35,7 +34,6 @@ 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,
@@ -53,8 +51,7 @@ export {
   deleteCollectionFeaturedItem,
   linkCollection,
   unlinkCollection,
-  getCollectionLinks,
-  getCollectionsForLinking
+  getCollectionLinks
 }
 export { Collection, CollectionInputLevel } from './domain/models/Collection'
 export { CollectionFacet } from './domain/models/CollectionFacet'
@@ -65,4 +62,3 @@ 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/index.ts

@@ -38,8 +38,6 @@ 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
@@ -95,6 +93,7 @@ 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> {
@@ -486,46 +485,4 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
-
-  public async getCollectionsForLinking(
-    objectType: LinkingObjectType,
-    id: number | string,
-    searchTerm: string,
-    alreadyLinked: boolean
-  ): 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)
-    }
-
-    if (alreadyLinked) {
-      queryParams.set('alreadyLinking', 'true')
-    }
-
-    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
-      })
-  }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -159,13 +159,7 @@ export const transformCollectionLinksResponseToCollectionLinks = (
   const responseDataPayload = response.data.data
   const linkedCollections = responseDataPayload.linkedDataverses
   const collectionsLinkingToThis = responseDataPayload.dataversesLinkingToThis
-  const linkedDatasets = responseDataPayload.linkedDatasets.map(
-    (ld: { identifier: string; title: string }) => ({
-      persistentId: ld.identifier,
-      title: ld.title
-    })
-  )
-
+  const linkedDatasets = responseDataPayload.linkedDatasets
   return {
     linkedCollections,
     collectionsLinkingToThis,

src/collections/infra/repositories/transformers/collectionTransformers.ts

@@ -67,8 +67,8 @@ 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[]>
   getDatasetAvailableCategories(datasetId: number | string): Promise<string[]>
   getDatasetCitationInOtherFormats(

src/datasets/domain/repositories/IDatasetsRepository.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 id (numeric) or persistent identifier string.
-   * @param {number | string} [collectionIdOrAlias] - The collection identifier (numeric id) or alias.
+   * @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/LinkDataset.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 id (numeric) or persistent identifier string.
-   * @param {number | string} [collectionIdOrAlias] - The collection identifier (numeric id) or alias.
+   * @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/domain/useCases/UnlinkDataset.ts

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