initial work

Author: g-saracca

src/collections/domain/dtos/CollectionFeaturedItemsDTO.ts

@@ -1,9 +1,19 @@
-export type CollectionFeaturedItemsDTO = CollectionFeaturedItemDTO[]
+import { CustomFeaturedItem, DvObjectFeaturedItem } from '../models/CollectionFeaturedItem'
 
-export interface CollectionFeaturedItemDTO {
+export type CollectionFeaturedItemsDTO = (CustomFeaturedItemDTO | DvObjectFeaturedItemDTO)[]
+
+export interface CustomFeaturedItemDTO {
   id?: number
+  type: CustomFeaturedItem['type']
   content: string
   displayOrder: number
   file?: File
   keepFile: boolean
 }
+
+export interface DvObjectFeaturedItemDTO {
+  id?: number
+  type: DvObjectFeaturedItem['type']
+  dvObjectIdentifier: string
+  displayOrder: number
+}

src/collections/domain/models/CollectionFeaturedItem.ts

@@ -1,7 +1,17 @@
-export interface CollectionFeaturedItem {
+export type CollectionFeaturedItem = CustomFeaturedItem | DvObjectFeaturedItem
+
+export interface CustomFeaturedItem {
   id: number
+  type: 'custom'
   content: string
   imageFileName?: string
   imageFileUrl?: string
   displayOrder: number
 }
+
+export interface DvObjectFeaturedItem {
+  id: number
+  type: 'collection' | 'dataset' | 'file'
+  dvObjectIdentifier: string
+  displayOrder: number
+}

src/collections/infra/repositories/CollectionsRepository.ts

@@ -20,7 +20,11 @@ import {
 import { CollectionItemType } from '../../domain/models/CollectionItemType'
 import { CollectionFeaturedItem } from '../../domain/models/CollectionFeaturedItem'
 import { transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems } from './transformers/collectionFeaturedItemsTransformer'
-import { CollectionFeaturedItemsDTO } from '../../domain/dtos/CollectionFeaturedItemsDTO'
+import {
+  CollectionFeaturedItemsDTO,
+  CustomFeaturedItemDTO,
+  DvObjectFeaturedItemDTO
+} from '../../domain/dtos/CollectionFeaturedItemsDTO'
 import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { PublicationStatus } from '../../../../src/core/domain/models/PublicationStatus'
 import { ReadError } from '../../../core/domain/repositories/ReadError'
@@ -382,18 +386,40 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
     const formData = new FormData()
 
-    orderedFeaturedItemsDTO.forEach((item) => {
-      const { id, content, displayOrder, file, keepFile } = item
-      const fileName = file ? file.name : ''
-
-      formData.append('id', id ? id.toString() : '0')
-      formData.append('content', content)
-      formData.append('displayOrder', displayOrder.toString())
-      formData.append('keepFile', keepFile.toString())
-      formData.append('fileName', fileName)
-      if (file) {
-        formData.append('file', file)
+    orderedFeaturedItemsDTO.forEach((item: CustomFeaturedItemDTO | DvObjectFeaturedItemDTO) => {
+      formData.append('id', item.id !== undefined ? item.id.toString() : '0')
+      formData.append('type', item.type)
+      formData.append('displayOrder', item.displayOrder.toString())
+
+      if (item.type === 'custom') {
+        // CustomFeaturedItemDTO
+        formData.append('content', item.content)
+        formData.append('keepFile', item.keepFile.toString())
+        formData.append('fileName', item.file ? item.file.name : '')
+        if (item.file) {
+          formData.append('file', item.file)
+        }
+      } else {
+        // DvObjectFeaturedItemDTO
+        formData.append('dvObjectIdentifier', item.dvObjectIdentifier)
+
+        // We still need to append content, keepFile, and fileName as they are expected by the backend even empty
+        formData.append('content', '')
+        formData.append('keepFile', '')
+        formData.append('fileName', '')
       }
+
+      // const { id, content, displayOrder, file, keepFile } = item
+      // const fileName = file ? file.name : ''
+
+      // formData.append('id', id ? id.toString() : '0')
+      // formData.append('content', content)
+      // formData.append('displayOrder', displayOrder.toString())
+      // formData.append('keepFile', keepFile.toString())
+      // formData.append('fileName', fileName)
+      // if (file) {
+      //   formData.append('file', file)
+      // }
     })
 
     return formData

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

@@ -1,7 +1,17 @@
-export interface CollectionFeaturedItemPayload {
+export type CollectionFeaturedItemPayload = CustomFeaturedItemPayload | DvObjectFeaturedItemPayload
+
+export interface CustomFeaturedItemPayload {
   id: number
+  type: 'custom'
   content: string
   imageFileName: string | null
   imageFileUrl: string | null
   displayOrder: number
 }
+
+export interface DvObjectFeaturedItemPayload {
+  id: number
+  type: 'dataverse' | 'dataset' | 'datafile'
+  dvObjectIdentifier: string
+  displayOrder: number
+}

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

@@ -1,16 +1,52 @@
-import { CollectionFeaturedItem } from '../../../domain/models/CollectionFeaturedItem'
-import { CollectionFeaturedItemPayload } from './CollectionFeaturedItemPayload'
+import {
+  CollectionFeaturedItem,
+  CustomFeaturedItem,
+  DvObjectFeaturedItem
+} from '../../../domain/models/CollectionFeaturedItem'
+import {
+  CollectionFeaturedItemPayload,
+  DvObjectFeaturedItemPayload
+} from './CollectionFeaturedItemPayload'
+
+const dvObjectTypeMap: Record<DvObjectFeaturedItemPayload['type'], DvObjectFeaturedItem['type']> = {
+  dataverse: 'collection',
+  dataset: 'dataset',
+  datafile: 'file'
+}
 
 export const transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems = (
-  collectionFeaturedItemsPayload: CollectionFeaturedItemPayload[]
+  payload: CollectionFeaturedItemPayload[]
 ): CollectionFeaturedItem[] => {
-  return collectionFeaturedItemsPayload
-    .map((collectionFeaturedItemPayload) => ({
-      id: collectionFeaturedItemPayload.id,
-      content: collectionFeaturedItemPayload.content,
-      imageFileUrl: collectionFeaturedItemPayload.imageFileUrl || undefined,
-      imageFileName: collectionFeaturedItemPayload.imageFileName || undefined,
-      displayOrder: collectionFeaturedItemPayload.displayOrder
-    }))
+  return payload
+    .map((item) => {
+      if (item.type === 'custom') {
+        const customFeaturedItem: CustomFeaturedItem = {
+          id: item.id,
+          type: 'custom',
+          content: item.content,
+          imageFileUrl: item.imageFileUrl || undefined,
+          imageFileName: item.imageFileName || undefined,
+          displayOrder: item.displayOrder
+        }
+
+        return customFeaturedItem
+      } else {
+        // Map API types to domain types
+        const type = dvObjectTypeMap[item.type]
+
+        if (!type) {
+          throw new Error(`Unknown dvObject type: ${item.type}`)
+        }
+
+        const dvObjectFeaturedItem: DvObjectFeaturedItem = {
+          id: item.id,
+          type,
+          dvObjectIdentifier: item.dvObjectIdentifier,
+          displayOrder: item.displayOrder
+        }
+
+        return dvObjectFeaturedItem
+      }
+    })
     .sort((a, b) => a.displayOrder - b.displayOrder)
 }

test/functional/collections/DeleteCollectionFeaturedItems.test.ts

@@ -6,7 +6,7 @@ import {
   deleteCollectionViaApi
 } from '../../testHelpers/collections/collectionHelper'
 import {
-  createCollectionFeaturedItemViaApi,
+  createCollectionCustomFeaturedItemViaApi,
   deleteCollectionFeaturedItemsViaApi
 } from '../../testHelpers/collections/collectionFeaturedItemsHelper'
 
@@ -24,18 +24,18 @@ describe('execute', () => {
   beforeAll(async () => {
     try {
       await createCollectionViaApi(testCollectionAlias)
-      await createCollectionFeaturedItemViaApi(testCollectionAlias, {
+      await createCollectionCustomFeaturedItemViaApi(testCollectionAlias, {
         content: '<p class="rte-paragraph">Test content</p>',
         displayOrder: 1,
         withFile: true,
         fileName: 'featured-item-test-image.png'
       })
-      await createCollectionFeaturedItemViaApi(testCollectionAlias, {
+      await createCollectionCustomFeaturedItemViaApi(testCollectionAlias, {
         content: '<p class="rte-paragraph">Test content 2</p>',
         displayOrder: 2,
         withFile: false
       })
-      await createCollectionFeaturedItemViaApi(testCollectionAlias, {
+      await createCollectionCustomFeaturedItemViaApi(testCollectionAlias, {
         content: '<p class="rte-paragraph">Test content 3</p>',
         displayOrder: 3,
         withFile: false

test/functional/collections/GetCollectionFeaturedItems.test.ts

@@ -2,14 +2,15 @@ import { ApiConfig, ReadError, getCollectionFeaturedItems } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import {
-  createCollectionFeaturedItemViaApi,
+  createCollectionCustomFeaturedItemViaApi,
   deleteCollectionFeaturedItemViaApi
 } from '../../testHelpers/collections/collectionFeaturedItemsHelper'
 import {
   createCollectionViaApi,
   deleteCollectionViaApi
 } from '../../testHelpers/collections/collectionHelper'
 import { ROOT_COLLECTION_ID } from '../../../src/collections/domain/models/Collection'
+import { CustomFeaturedItem } from '../../../src/collections/domain/models/CollectionFeaturedItem'
 
 describe('execute', () => {
   const testCollectionAlias = 'getCollectionsFeaturedItemsTest'
@@ -27,12 +28,15 @@ describe('execute', () => {
     try {
       await createCollectionViaApi(testCollectionAlias)
 
-      const featuredItemCreated = await createCollectionFeaturedItemViaApi(testCollectionAlias, {
-        content: '<p class="rte-paragraph">Test content</p>',
-        displayOrder: 1,
-        withFile: true,
-        fileName: 'featured-item-test-image.png'
-      })
+      const featuredItemCreated = await createCollectionCustomFeaturedItemViaApi(
+        testCollectionAlias,
+        {
+          content: '<p class="rte-paragraph">Test content</p>',
+          displayOrder: 1,
+          withFile: true,
+          fileName: 'featured-item-test-image.png'
+        }
+      )
 
       testFeaturedItemId = featuredItemCreated.id
     } catch (error) {
@@ -54,30 +58,37 @@ describe('execute', () => {
   test('should return featured items array given a valid collection alias that has featured items', async () => {
     const featuredItemsResponse = await getCollectionFeaturedItems.execute(testCollectionAlias)
 
+    const featuredItemOne = featuredItemsResponse[0] as CustomFeaturedItem
+
     expect(featuredItemsResponse.length).toBe(1)
-    expect(featuredItemsResponse[0].id).toBe(testFeaturedItemId)
-    expect(featuredItemsResponse[0].displayOrder).toBe(1)
-    expect(featuredItemsResponse[0].content).toBe('<p class="rte-paragraph">Test content</p>')
-    expect(featuredItemsResponse[0].imageFileUrl).toBe(
-      `http://localhost:8080/api/access/dataverseFeaturedItemImage/${featuredItemsResponse[0].id}`
+    expect(featuredItemOne.id).toBe(testFeaturedItemId)
+    expect(featuredItemOne.displayOrder).toBe(1)
+    expect(featuredItemOne.content).toBe('<p class="rte-paragraph">Test content</p>')
+    expect(featuredItemOne.imageFileUrl).toBe(
+      `http://localhost:8080/api/access/dataverseFeaturedItemImage/${featuredItemOne.id}`
     )
-    expect(featuredItemsResponse[0].imageFileName).toBe('featured-item-test-image.png')
+    expect(featuredItemOne.imageFileName).toBe('featured-item-test-image.png')
   })
 
   it('should return imageFileUrl and imageFileName as undefined when featured item does not have an image', async () => {
-    const featuredItemCreated = await createCollectionFeaturedItemViaApi(testCollectionAlias, {
-      content: '<p class="rte-paragraph">Test content</p>',
-      displayOrder: 2
-    })
+    const featuredItemCreated = await createCollectionCustomFeaturedItemViaApi(
+      testCollectionAlias,
+      {
+        content: '<p class="rte-paragraph">Test content</p>',
+        displayOrder: 2
+      }
+    )
 
     const featuredItemsResponse = await getCollectionFeaturedItems.execute(testCollectionAlias)
 
+    const featuredItemTwo = featuredItemsResponse[1] as CustomFeaturedItem
+
     expect(featuredItemsResponse.length).toBe(2)
-    expect(featuredItemsResponse[1].id).toBe(featuredItemCreated.id)
-    expect(featuredItemsResponse[1].displayOrder).toBe(2)
-    expect(featuredItemsResponse[1].content).toBe('<p class="rte-paragraph">Test content</p>')
-    expect(featuredItemsResponse[1].imageFileUrl).toBeUndefined()
-    expect(featuredItemsResponse[1].imageFileName).toBeUndefined()
+    expect(featuredItemTwo.id).toBe(featuredItemCreated.id)
+    expect(featuredItemTwo.displayOrder).toBe(2)
+    expect(featuredItemTwo.content).toBe('<p class="rte-paragraph">Test content</p>')
+    expect(featuredItemTwo.imageFileUrl).toBeUndefined()
+    expect(featuredItemTwo.imageFileName).toBeUndefined()
 
     await deleteCollectionFeaturedItemViaApi(featuredItemCreated.id)
   })