feat: update code to work with dv objects

Author: g-saracca

src/collections/domain/models/CollectionFeaturedItem.ts

@@ -11,7 +11,13 @@ export interface CustomFeaturedItem {
 
 export interface DvObjectFeaturedItem {
   id: number
-  type: 'collection' | 'dataset' | 'file'
+  type: DvObjectFeaturedItemType
   dvObjectIdentifier: string
   displayOrder: number
 }
+
+export enum DvObjectFeaturedItemType {
+  COLLECTION = 'collection',
+  DATASET = 'dataset',
+  FILE = 'file'
+}

src/collections/infra/repositories/CollectionsRepository.ts

@@ -18,8 +18,14 @@ import {
   SortType
 } from '../../domain/models/CollectionSearchCriteria'
 import { CollectionItemType } from '../../domain/models/CollectionItemType'
-import { CollectionFeaturedItem } from '../../domain/models/CollectionFeaturedItem'
-import { transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems } from './transformers/collectionFeaturedItemsTransformer'
+import {
+  CollectionFeaturedItem,
+  DvObjectFeaturedItem
+} from '../../domain/models/CollectionFeaturedItem'
+import {
+  domainTypeToApiType,
+  transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems
+} from './transformers/collectionFeaturedItemsTransformer'
 import {
   CollectionFeaturedItemsDTO,
   CustomFeaturedItemDTO,
@@ -388,38 +394,30 @@ export class CollectionsRepository extends ApiRepository implements ICollections
 
     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('type', item.type)
         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)
         }
+
+        // We still need to append dvObjectIdentifier as it is expected by the backend even empty
+        formData.append('dvObjectIdentifier', '')
       } else {
         // DvObjectFeaturedItemDTO
+        formData.append('type', domainTypeToApiType[item.type as DvObjectFeaturedItem['type']])
         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/collectionFeaturedItemsTransformer.ts

@@ -1,17 +1,30 @@
 import {
   CollectionFeaturedItem,
   CustomFeaturedItem,
-  DvObjectFeaturedItem
+  DvObjectFeaturedItem,
+  DvObjectFeaturedItemType
 } from '../../../domain/models/CollectionFeaturedItem'
 import {
   CollectionFeaturedItemPayload,
   DvObjectFeaturedItemPayload
 } from './CollectionFeaturedItemPayload'
 
-const dvObjectTypeMap: Record<DvObjectFeaturedItemPayload['type'], DvObjectFeaturedItem['type']> = {
-  dataverse: 'collection',
-  dataset: 'dataset',
-  datafile: 'file'
+const apiTypeToDomainType: Record<
+  DvObjectFeaturedItemPayload['type'],
+  DvObjectFeaturedItem['type']
+> = {
+  dataverse: DvObjectFeaturedItemType.COLLECTION,
+  dataset: DvObjectFeaturedItemType.DATASET,
+  datafile: DvObjectFeaturedItemType.FILE
+}
+
+export const domainTypeToApiType: Record<
+  DvObjectFeaturedItem['type'],
+  DvObjectFeaturedItemPayload['type']
+> = {
+  [DvObjectFeaturedItemType.COLLECTION]: 'dataverse',
+  [DvObjectFeaturedItemType.DATASET]: 'dataset',
+  [DvObjectFeaturedItemType.FILE]: 'datafile'
 }
 
 export const transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems = (
@@ -32,10 +45,10 @@ export const transformCollectionFeaturedItemsPayloadToCollectionFeaturedItems =
         return customFeaturedItem
       } else {
         // Map API types to domain types
-        const type = dvObjectTypeMap[item.type]
+        const type = apiTypeToDomainType[item.type]
 
         if (!type) {
-          throw new Error(`Unknown dvObject type: ${item.type}`)
+          throw new Error(`Unknown type: ${item.type}`)
         }
 
         const dvObjectFeaturedItem: DvObjectFeaturedItem = {