add linkCollection and unlinkCollection use cases

Author: ekraffmiller

.DS_Store

@@ -50,4 +50,12 @@ export interface ICollectionsRepository {
   ): Promise<FeaturedItem[]>
   deleteCollectionFeaturedItems(collectionIdOrAlias: number | string): Promise<void>
   deleteCollectionFeaturedItem(featuredItemId: number): Promise<void>
+  linkCollection(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void>
+  unlinkCollection(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void>
 }

src/collections/domain/repositories/ICollectionsRepository.ts

@@ -0,0 +1,27 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class LinkCollection implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Deletes the Dataverse collection whose database ID or alias is given:
+   *
+   * @param {number| string} [linkedCollectionIdOrAlias] - The collection to be linked. Can be either a string (collection alias), or a number (collection id)
+   * @param { number | string} [linkingCollectionIdOrAlias] - The collection that will be linking to the linked collection.  Can be either a  string (collection alias), or a number (collection id)
+   * @returns {Promise<void>} -This method does not return anything upon successful completion.
+   */
+  async execute(
+    linkedCollectionIdOrAlias: string,
+    linkingCollectionIdOrAlias: string
+  ): Promise<void> {
+    return await this.collectionsRepository.linkCollection(
+      linkedCollectionIdOrAlias,
+      linkingCollectionIdOrAlias
+    )
+  }
+}

src/collections/domain/useCases/LinkCollection.ts

@@ -0,0 +1,27 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { ICollectionsRepository } from '../repositories/ICollectionsRepository'
+
+export class UnLinkCollection implements UseCase<void> {
+  private collectionsRepository: ICollectionsRepository
+
+  constructor(collectionsRepository: ICollectionsRepository) {
+    this.collectionsRepository = collectionsRepository
+  }
+
+  /**
+   * Unlinks a collection from the collection that links to it
+   *
+   * @param {number| string} [linkedCollectionIdOrAlias] - The collection that is linked. Can be either a string (collection alias), or a number (collection id)
+   * @param { number | string} [linkingCollectionIdOrAlias] - The collection that links to the linked collection.  Can be either a  string (collection alias), or a number (collection id)
+   * @returns {Promise<void>} -This method does not return anything upon successful completion.
+   */
+  async execute(
+    linkedCollectionIdOrAlias: string,
+    linkingCollectionIdOrAlias: string
+  ): Promise<void> {
+    return await this.collectionsRepository.unlinkCollection(
+      linkedCollectionIdOrAlias,
+      linkingCollectionIdOrAlias
+    )
+  }
+}

src/collections/domain/useCases/UnLinkCollection.ts

@@ -446,4 +446,30 @@ export class CollectionsRepository extends ApiRepository implements ICollections
         throw error
       })
   }
+  public async linkCollection(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void> {
+    console.log(linkedCollectionIdOrAlias, linkingCollectionIdOrAlias)
+    return this.doPut(
+      `/dataverses/${linkedCollectionIdOrAlias}` + `/link/${linkingCollectionIdOrAlias}`,
+      {} // No data is needed for this operation
+    )
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
+  public async unlinkCollection(
+    linkedCollectionIdOrAlias: number | string,
+    linkingCollectionIdOrAlias: number | string
+  ): Promise<void> {
+    return this.doDelete(
+      `/dataverses/${linkedCollectionIdOrAlias}` + `/deleteLink/${linkingCollectionIdOrAlias}`
+    )
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

src/collections/infra/repositories/CollectionsRepository.ts

@@ -1911,4 +1911,84 @@ describe('CollectionsRepository', () => {
       ).rejects.toThrow(expectedError)
     })
   })
+  describe('linkCollection', () => {
+    const firstCollectionAlias = 'linkCollectionFirst'
+    const secondCollectionAlias = 'linkCollectionSecond'
+
+    beforeAll(async () => {
+      await createCollectionViaApi(firstCollectionAlias)
+      await createCollectionViaApi(secondCollectionAlias)
+    })
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(firstCollectionAlias)
+      await deleteCollectionViaApi(secondCollectionAlias)
+    })
+
+    test('should link a collection successfully', async () => {
+      const firstCollection = await sut.getCollection(firstCollectionAlias)
+      await sut.getCollection(secondCollectionAlias)
+
+      await sut.linkCollection(secondCollectionAlias, firstCollectionAlias)
+
+      await sut.getCollection(secondCollectionAlias)
+      await new Promise((res) => setTimeout(res, 2000))
+      const collectionItemSubset = await sut.getCollectionItems(firstCollection.alias)
+      expect(collectionItemSubset.items.length).toBe(1)
+    })
+
+    test('should throw error when linking a non-existent collection', async () => {
+      const invalidCollectionId = 99999
+      const firstCollection = await sut.getCollection(firstCollectionAlias)
+
+      const expectedError = new WriteError("[404] Can't find dataverse with identifier='99999'")
+
+      await expect(sut.linkCollection(invalidCollectionId, firstCollection.id)).rejects.toThrow(
+        expectedError
+      )
+    })
+  })
+
+  describe('unlinkCollection', () => {
+    const firstCollectionAlias = 'unlinkCollectionFirst'
+    const secondCollectionAlias = 'unlinkCollectionSecond'
+
+    beforeAll(async () => {
+      await createCollectionViaApi(firstCollectionAlias)
+      await createCollectionViaApi(secondCollectionAlias)
+
+      const firstCollection = await sut.getCollection(firstCollectionAlias)
+      const secondCollection = await sut.getCollection(secondCollectionAlias)
+
+      await sut.linkCollection(secondCollection.id, firstCollection.id)
+    })
+
+    afterAll(async () => {
+      await deleteCollectionViaApi(firstCollectionAlias)
+      await deleteCollectionViaApi(secondCollectionAlias)
+    })
+
+    test('should unlink a collection successfully', async () => {
+      const firstCollection = await sut.getCollection(firstCollectionAlias)
+      const secondCollection = await sut.getCollection(secondCollectionAlias)
+
+      await sut.unlinkCollection(secondCollection.id, firstCollection.id)
+      await new Promise((res) => setTimeout(res, 2000))
+
+      await sut.getCollection(secondCollectionAlias)
+      const collectionItemSubset = await sut.getCollectionItems(firstCollection.alias)
+      expect(collectionItemSubset.items).toStrictEqual([])
+    })
+
+    test('should throw error when unlinking a non-existent collection', async () => {
+      const invalidCollectionId = 99999
+      const firstCollection = await sut.getCollection(firstCollectionAlias)
+
+      const expectedError = new WriteError("[404] Can't find dataverse with identifier='99999'")
+
+      await expect(sut.unlinkCollection(invalidCollectionId, firstCollection.id)).rejects.toThrow(
+        expectedError
+      )
+    })
+  })
 })