Added: extended properties to CollectionDTO for creation

Author: GPortas

src/collections/domain/dtos/CollectionDTO.ts

@@ -5,6 +5,15 @@ export interface CollectionDTO {
   type: CollectionType
   affiliation?: string
   description?: string
+  metadataBlockNames: string[]
+  facetIds?: string[]
+  inputLevels?: DatasetFieldTypeInputLevelDTO[]
+}
+
+export interface DatasetFieldTypeInputLevelDTO {
+  datasetFieldName: string
+  include: boolean
+  required: boolean
 }
 
 export enum CollectionType {

src/collections/domain/useCases/GetCollectionFacets.ts

@@ -0,0 +1 @@
+// TODO

src/collections/index.ts

@@ -10,4 +10,4 @@ const createCollection = new CreateCollection(collectionsRepository)
 
 export { getCollection, createCollection }
 export { Collection } from './domain/models/Collection'
-export { CollectionDTO } from './domain/dtos/CollectionDTO'
+export { CollectionDTO, DatasetFieldTypeInputLevelDTO } from './domain/dtos/CollectionDTO'

src/collections/infra/repositories/CollectionsRepository.ts

@@ -9,12 +9,25 @@ export interface NewCollectionRequestPayload {
   name: string
   dataverseContacts: NewCollectionContactRequestPayload[]
   dataverseType: string
+  metadataBlocks: NewCollectionMetadataBlocksRequestPayload
 }
 
 export interface NewCollectionContactRequestPayload {
   contactEmail: string
 }
 
+export interface NewCollectionMetadataBlocksRequestPayload {
+  metadataBlockNames: string[]
+  facetIds: string[]
+  inputLevels: NewCollectionInputLevelRequestPayload[]
+}
+
+export interface NewCollectionInputLevelRequestPayload {
+  datasetFieldTypeName: string
+  include: boolean
+  required: boolean
+}
+
 export class CollectionsRepository extends ApiRepository implements ICollectionsRepository {
   private readonly collectionsResourceName: string = 'dataverses'
 
@@ -40,11 +53,25 @@ export class CollectionsRepository extends ApiRepository implements ICollections
       })
     )
 
+    const inputLevelsRequestBody: NewCollectionInputLevelRequestPayload[] = []
+    collectionDTO.inputLevels.forEach((element) => {
+      inputLevelsRequestBody.push({
+        datasetFieldTypeName: element.datasetFieldName,
+        include: element.include,
+        required: element.required
+      })
+    })
+
     const requestBody: NewCollectionRequestPayload = {
       alias: collectionDTO.alias,
       name: collectionDTO.name,
       dataverseContacts: dataverseContacts,
-      dataverseType: collectionDTO.type.toString()
+      dataverseType: collectionDTO.type.toString(),
+      metadataBlocks: {
+        metadataBlockNames: collectionDTO.metadataBlockNames,
+        facetIds: collectionDTO.facetIds,
+        inputLevels: inputLevelsRequestBody
+      }
     }
 
     return this.doPost(`/${this.collectionsResourceName}/${parentCollectionId}`, requestBody)

test/testHelpers/collections/collectionHelper.ts

@@ -108,7 +108,16 @@ export const createCollectionDTO = (alias = 'test-collection'): CollectionDTO =>
     alias: alias,
     name: 'Test Collection',
     contacts: ['[email protected]'],
-    type: CollectionType.DEPARTMENT
+    type: CollectionType.DEPARTMENT,
+    metadataBlockNames: ['citation', 'geospatial'],
+    facetIds: ['authorName', 'authorAffiliation'],
+    inputLevels: [
+      {
+        datasetFieldName: 'geographicCoverage',
+        required: true,
+        include: true
+      }
+    ]
   }
 }
 
@@ -121,6 +130,17 @@ export const createNewCollectionRequestPayload = (): NewCollectionRequestPayload
         contactEmail: '[email protected]'
       }
     ],
-    dataverseType: 'DEPARTMENT'
+    dataverseType: 'DEPARTMENT',
+    metadataBlocks: {
+      metadataBlockNames: ['citation', 'geospatial'],
+      facetIds: ['authorName', 'authorAffiliation'],
+      inputLevels: [
+        {
+          datasetFieldTypeName: 'geographicCoverage',
+          include: true,
+          required: true
+        }
+      ]
+    }
   }
 }