feat: add dvObjectDisplayName property

Author: g-saracca

src/collections/domain/models/CollectionFeaturedItem.ts

@@ -13,6 +13,7 @@ export interface DvObjectFeaturedItem {
   id: number
   type: DvObjectFeaturedItemType
   dvObjectIdentifier: string
+  dvObjectDisplayName: string
   displayOrder: number
 }
 

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

@@ -13,5 +13,6 @@ export interface DvObjectFeaturedItemPayload {
   id: number
   type: 'dataverse' | 'dataset' | 'datafile'
   dvObjectIdentifier: string
+  dvObjectDisplayName: string
   displayOrder: number
 }

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

@@ -55,6 +55,7 @@ export const transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems =
           id: item.id,
           type,
           dvObjectIdentifier: item.dvObjectIdentifier,
+          dvObjectDisplayName: item.dvObjectDisplayName,
           displayOrder: item.displayOrder
         }
 

test/functional/collections/GetCollectionFeaturedItems.test.ts

@@ -97,6 +97,7 @@ describe('execute', () => {
     expect(featuredItemTwo.id).toBe(testFeaturedItemIds[1])
     expect(featuredItemTwo.type).toBe(DvObjectFeaturedItemType.COLLECTION)
     expect(featuredItemTwo.dvObjectIdentifier).toBe(featuredCollectionAlias)
+    expect(featuredItemTwo.dvObjectDisplayName).toBe('Scientific Research')
     expect(featuredItemTwo.displayOrder).toBe(2)
   })
 

test/functional/collections/UpdateCollectionFeaturedItems.test.ts

@@ -176,16 +176,21 @@ describe('execute', () => {
 
     expect(fourthItemResponse.type).toBe(DvObjectFeaturedItemType.COLLECTION)
     expect(fourthItemResponse.dvObjectIdentifier).toBe(featuredCollectionAlias)
+    expect(fourthItemResponse.dvObjectDisplayName).toBe('Scientific Research')
     expect(fourthItemResponse.displayOrder).toBe(newFeaturedItems[3].displayOrder)
     expect(fourthItemResponse.id).toBeDefined()
 
     expect(fifthItemResponse.type).toBe(DvObjectFeaturedItemType.DATASET)
     expect(fifthItemResponse.dvObjectIdentifier).toBe(testDatasetIds.persistentId)
+    expect(fifthItemResponse.dvObjectDisplayName).toBe(
+      'Dataset created using the createDataset use case'
+    )
     expect(fifthItemResponse.displayOrder).toBe(newFeaturedItems[4].displayOrder)
     expect(fifthItemResponse.id).toBeDefined()
 
     expect(sixthItemResponse.type).toBe(DvObjectFeaturedItemType.FILE)
     expect(sixthItemResponse.dvObjectIdentifier).toBe(featuredFileId.toString())
+    expect(sixthItemResponse.dvObjectDisplayName).toBe(testTextFile1Name)
     expect(sixthItemResponse.displayOrder).toBe(newFeaturedItems[5].displayOrder)
     expect(sixthItemResponse.id).toBeDefined()
   })

test/integration/collections/CollectionsRepository.test.ts

@@ -1295,25 +1295,22 @@ describe('CollectionsRepository', () => {
       ).rejects.toThrow(expectedError)
     })
 
-    // TODO:ME - Fix from API. getting 500 error right now instead of 400
-
-    // eslint-disable-next-line jest/no-commented-out-tests
-    // it('should return error when the dvObjectIdentifier of a file does not exist', async () => {
-    //   const invalidFileId = '99'
-    //   const newFeaturedItems: DvObjectFeaturedItemDTO[] = [
-    //     {
-    //       type: DvObjectFeaturedItemType.FILE,
-    //       dvObjectIdentifier: invalidFileId,
-    //       displayOrder: 0
-    //     }
-    //   ]
-    //   const expectedError = new WriteError(
-    //     `[400] Cant find Collection, Dataset, or Datafile with identifier: ${invalidFileId}.`
-    //   )
-    //   await expect(
-    //     sut.updateCollectionFeaturedItems(testCollectionAlias, newFeaturedItems)
-    //   ).rejects.toThrow(expectedError)
-    // })
+    it('should return error when the dvObjectIdentifier of a file does not exist', async () => {
+      const invalidFileId = '99'
+      const newFeaturedItems: DvObjectFeaturedItemDTO[] = [
+        {
+          type: DvObjectFeaturedItemType.FILE,
+          dvObjectIdentifier: invalidFileId,
+          displayOrder: 0
+        }
+      ]
+      const expectedError = new WriteError(
+        `[400] Cant find Collection, Dataset, or Datafile with identifier: ${invalidFileId}.`
+      )
+      await expect(
+        sut.updateCollectionFeaturedItems(testCollectionAlias, newFeaturedItems)
+      ).rejects.toThrow(expectedError)
+    })
 
     it('should return error when the collection to feature is not published', async () => {
       const unpublishedCollectionAlias = 'unpublished-collection-featured-item-test'

test/testHelpers/collections/collectionFeaturedItemsHelper.ts

@@ -142,7 +142,8 @@ export const createCollectionFeaturedItemsModel = (): CollectionFeaturedItem[] =
       id: 3,
       type: DvObjectFeaturedItemType.DATASET,
       displayOrder: 3,
-      dvObjectIdentifier: 'doi:10.5072/FK2/8YOKQI'
+      dvObjectIdentifier: 'doi:10.5072/FK2/8YOKQI',
+      dvObjectDisplayName: 'Dataset Title'
     }
   ]
 }