Update from js dataverse type

Author: jp-tosca

src/dataset/domain/repositories/DatasetRepository.ts

@@ -12,6 +12,7 @@ import { DatasetLicenseUpdateRequest } from '../models/DatasetLicenseUpdateReque
 import { CollectionSummary } from '@/collection/domain/models/CollectionSummary'
 import { DatasetVersionPaginationInfo } from '../models/DatasetVersionPaginationInfo'
 import { DatasetUploadLimits } from '../models/DatasetUploadLimits'
+import { DatasetType } from '../models/DatasetType'
 
 export interface DatasetRepository {
   getByPersistentId: (
@@ -29,7 +30,11 @@ export interface DatasetRepository {
     includeDeaccessioned: boolean
   ) => Promise<DatasetVersionDiff>
 
-  create: (dataset: DatasetDTO, collectionId: string) => Promise<{ persistentId: string }>
+  create: (
+    dataset: DatasetDTO, 
+    collectionId: string, 
+    datasetType?: DatasetType
+  ) => Promise<{ persistentId: string }>
   updateMetadata: (
     datasetId: string | number,
     datasetDTO: DatasetDTO,
@@ -70,4 +75,5 @@ export interface DatasetRepository {
   unlink(datasetId: string | number, collectionIdOrAlias: string | number): Promise<void>
   getDatasetLinkedCollections: (datasetId: string | number) => Promise<CollectionSummary[]>
   getDatasetUploadLimits: (datasetId: string | number) => Promise<DatasetUploadLimits>
+  getAvailableDatasetTypes: () => Promise<DatasetType[]>
 }

src/dataset/domain/useCases/createDataset.ts

@@ -4,9 +4,10 @@ import { DatasetDTO } from './DTOs/DatasetDTO'
 export function createDataset(
   datasetRepository: DatasetRepository,
   dataset: DatasetDTO,
-  collectionId: string
+  collectionId: string,
+  datasetType?: string
 ): Promise<{ persistentId: string }> {
-  return datasetRepository.create(dataset, collectionId).catch((error: Error) => {
+  return datasetRepository.create(dataset, collectionId, datasetType).catch((error: Error) => {
     throw new Error(error.message)
   })
 }

src/dataset/infrastructure/mappers/JSDatasetMapper.ts

@@ -49,7 +49,8 @@ export class JSDatasetMapper {
     latestPublishedVersionMajorNumber?: number,
     latestPublishedVersionMinorNumber?: number,
     datasetVersionDiff?: JSDatasetVersionDiff,
-    fileStore?: string
+    fileStore?: string,
+    datasetType?: string
   ): Dataset {
     const version = JSDatasetVersionMapper.toVersion(
       jsDataset.versionId,
@@ -100,7 +101,8 @@ export class JSDatasetMapper {
         latestPublishedVersionMinorNumber
       ),
       JSDatasetMapper.toRequiresMajorVersionUpdate(datasetVersionDiff),
-      fileStore
+      fileStore,
+      datasetType
     ).build()
   }
 

src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts

@@ -44,7 +44,9 @@ import {
   getDatasetLinkedCollections,
   updateTermsOfAccess,
   updateDatasetLicense,
-  getDatasetUploadLimits
+  getDatasetUploadLimits,
+  DatasetType,
+  getDatasetAvailableDatasetTypes
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 import { DatasetPaginationInfo } from '../../domain/models/DatasetPaginationInfo'
@@ -64,6 +66,7 @@ import { AxiosResponse } from 'axios'
 import { JSDataverseReadErrorHandler } from '@/shared/helpers/JSDataverseReadErrorHandler'
 import { CollectionSummary } from '@/collection/domain/models/CollectionSummary'
 import { DatasetUploadLimits } from '@/dataset/domain/models/DatasetUploadLimits'
+import { DatasetType } from '@/dataset/domain/models/DatasetType'
 
 const includeDeaccessioned = true
 
@@ -269,7 +272,8 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           datasetDetails.latestPublishedVersionMajorNumber,
           datasetDetails.latestPublishedVersionMinorNumber,
           datasetDetails.datasetVersionDiff,
-          datasetDetails.fileStore
+          datasetDetails.fileStore,
+          datasetDetails.datasetType
         )
       })
       .catch((error: ReadError) => {
@@ -327,9 +331,13 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
       })
   }
 
-  create(dataset: DatasetDTO, collectionId: string): Promise<{ persistentId: string }> {
+  create(
+    dataset: DatasetDTO, 
+    collectionId: string, 
+    datasetType?: string
+  ): Promise<{ persistentId: string }> {
     return createDataset
-      .execute(DatasetDTOMapper.toJSDatasetDTO(dataset), collectionId)
+      .execute(DatasetDTOMapper.toJSDatasetDTO(dataset), collectionId, datasetType)
       .then((jsDatasetIdentifiers: JSDatasetIdentifiers) => ({
         persistentId: jsDatasetIdentifiers.persistentId
       }))
@@ -431,6 +439,10 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
     return getDatasetLinkedCollections.execute(datasetId)
   }
 
+  getAvailableDatasetTypes: () => Promise<DatasetType[]> = () => {
+    return getDatasetAvailableDatasetTypes.execute()
+  }
+
   /*
     TODO: This is a temporary solution as this use case doesn't exist in js-dataverse yet and the API should also return the file store type rather than name only.
     After https://github.com/IQSS/dataverse/issues/11695 is implemented, create a js-dataverse use case.

src/metadata-block-info/domain/repositories/MetadataBlockInfoRepository.ts

@@ -8,8 +8,12 @@ export interface MetadataBlockInfoRepository {
   getByName: (name: string) => Promise<MetadataBlockInfoDisplayFormat | undefined>
   getAll: () => Promise<MetadataBlockInfo[]>
   getDisplayedOnCreateByCollectionId: (
-    collectionId: number | string
+    collectionId: number | string,
+    datasetType?: string
+  ) => Promise<MetadataBlockInfo[]>
+  getByCollectionId: (
+    collectionId: number | string,
+    datasetType?: string
   ) => Promise<MetadataBlockInfo[]>
-  getByCollectionId: (collectionId: number | string) => Promise<MetadataBlockInfo[]>
   getAllFacetableMetadataFields: () => Promise<MetadataField[]>
 }

src/metadata-block-info/domain/useCases/getDisplayedOnCreateMetadataBlockInfoByCollectionId.ts

@@ -3,10 +3,11 @@ import { MetadataBlockInfoRepository } from '../repositories/MetadataBlockInfoRe
 
 export async function getDisplayedOnCreateMetadataBlockInfoByCollectionId(
   metadataBlockInfoRepository: MetadataBlockInfoRepository,
-  collectionId: number | string
+  collectionId: number | string,
+  datasetType?: string
 ): Promise<MetadataBlockInfo[]> {
   return metadataBlockInfoRepository
-    .getDisplayedOnCreateByCollectionId(collectionId)
+    .getDisplayedOnCreateByCollectionId(collectionId, datasetType)
     .catch((error: Error) => {
       throw new Error(error.message)
     })

src/metadata-block-info/domain/useCases/getMetadataBlockInfoByCollectionId.ts

@@ -3,9 +3,13 @@ import { MetadataBlockInfoRepository } from '../repositories/MetadataBlockInfoRe
 
 export async function getMetadataBlockInfoByCollectionId(
   metadataBlockInfoRepository: MetadataBlockInfoRepository,
-  collectionId: number | string
+  collectionId: number | string,
+  onlyDisplayedOnCreate?: boolean,
+  datasetType?: string
 ): Promise<MetadataBlockInfo[]> {
-  return metadataBlockInfoRepository.getByCollectionId(collectionId).catch((error: Error) => {
-    throw new Error(error.message)
-  })
-}
+  return metadataBlockInfoRepository
+    .getByCollectionId(collectionId, onlyDisplayedOnCreate, datasetType)
+    .catch((error: Error) => {
+      throw new Error(error.message)
+    })
+}

src/metadata-block-info/infrastructure/repositories/MetadataBlockInfoJSDataverseRepository.ts

@@ -37,9 +37,13 @@ export class MetadataBlockInfoJSDataverseRepository implements MetadataBlockInfo
       })
   }
 
-  getByCollectionId(collectionIdOrAlias: number | string): Promise<MetadataBlockInfo[]> {
+  getByCollectionId(
+    collectionIdOrAlias: number | string,
+    onlyDisplayedOnCreate?: boolean,
+    datasetType?: string
+  ): Promise<MetadataBlockInfo[]> {
     return getCollectionMetadataBlocks
-      .execute(collectionIdOrAlias)
+      .execute(collectionIdOrAlias, onlyDisplayedOnCreate, datasetType)
       .then((metadataBlocks: MetadataBlockInfo[]) => {
         return metadataBlocks
       })
@@ -49,12 +53,23 @@ export class MetadataBlockInfoJSDataverseRepository implements MetadataBlockInfo
   }
 
   getDisplayedOnCreateByCollectionId(
-    collectionIdOrAlias: number | string
+    collectionIdOrAlias: number | string,
+    datasetType?: string
   ): Promise<MetadataBlockInfo[]> {
     return getCollectionMetadataBlocks
-      .execute(collectionIdOrAlias, true)
+      .execute(collectionIdOrAlias, true, datasetType)
       .then((metadataBlocks: MetadataBlockInfo[]) => {
-        return metadataBlocks
+        const metadataBlocksWithFields: MetadataBlockInfo[] = []
+        metadataBlocks.forEach((block) => {
+          const numFields = Object.keys(block.metadataFields).length
+          // numFields can be zero if you pass a datasetType that's linked to
+          // a metadata block that doesn't have any fields set to displayOnCreate.
+          // See https://github.com/IQSS/dataverse/blob/v6.7.1/src/test/java/edu/harvard/iq/dataverse/api/DatasetTypesIT.java#L512
+          if (numFields > 0) {
+            metadataBlocksWithFields.push(block)
+          }
+        })
+        return metadataBlocksWithFields
       })
       .catch((error: ReadError) => {
         throw new Error(error.message)

src/sections/create-dataset/CreateDataset.tsx

@@ -19,6 +19,9 @@ import { type Template } from '@/templates/domain/models/Template'
 import { DatasetTemplateSelect } from './dataset-template-select/DatasetTemplateSelect'
 import { TemplateRepository } from '@/templates/domain/repositories/TemplateRepository'
 import { useCollectionRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
+import { useGetAvailableDatasetTypes } from '@/dataset/domain/hooks/useGetAvailableDatasetTypes'
+import { DatasetType } from '@/dataset/domain/models/DatasetType'
+import { DatasetTypeSelect } from './dataset-type-select/DatasetTypeSelect'
 
 interface CreateDatasetProps {
   datasetRepository: DatasetRepository
@@ -38,12 +41,15 @@ export function CreateDataset({
   const { isModalOpen, hideModal } = useNotImplementedModal()
   const { setIsLoading } = useLoading()
   const [selectedTemplate, setSelectedTemplate] = useState<Template | null>(null)
+  const [selectedDatasetType, setSelectedDatasetType] = useState<DatasetType | null>(null)
 
   const { collection, isLoading: isLoadingCollection } = useCollection(
     collectionRepository,
     collectionId
   )
 
+  const { datasetTypes, isLoading: isLoadingDatasetTypes } = useGetAvailableDatasetTypes({ datasetRepository })
+
   const { collectionUserPermissions, isLoading: isLoadingCollectionUserPermissions } =
     useGetCollectionUserPermissions({
       collectionIdOrAlias: collectionId,
@@ -63,13 +69,33 @@ export function CreateDataset({
     setSelectedTemplate(template)
   }
 
+  const handleDatasetTypeChange = (selectedTypeId: string) => {
+    const type: DatasetType | null =
+      datasetTypes.find((type) => type.id === Number(selectedTypeId)) || null
+
+    setSelectedType(type)
+  }
+
   const isLoadingData =
-    isLoadingCollectionUserPermissions || isLoadingCollection || isLoadingDatasetTemplates
+    isLoadingCollectionUserPermissions || 
+    isLoadingCollection || 
+    isLoadingDatasetTemplates || 
+    isLoadingDatasetTypes
 
   useEffect(() => {
     setIsLoading(isLoadingData)
   }, [isLoadingData, setIsLoading])
 
+  // When dataset types are loaded we set the default one to DATASET if available, it should always be there
+  useEffect(() => {
+    if (datasetTypes.length > 0) {
+      const defaultType: DatasetType | null =
+        datasetTypes.find((type) => type.name === 'dataset') || null
+
+      setSelectedType(defaultType)
+    }
+  }, [datasetTypes])
+
   // When dataset templates are loaded we set the default one if any
   useEffect(() => {
     if (datasetTemplates.length > 0) {
@@ -88,6 +114,11 @@ export function CreateDataset({
     return <CreateDatasetSkeleton />
   }
 
+  // We use the template id and dataset type id as key to force remounting the form when the template or type changes
+  const formKey = `${selectedType ? selectedType.id : 'no-type'}--${
+    selectedTemplate ? selectedTemplate.id : 'no-template'
+  }`
+
   if (collectionUserPermissions && !canUserAddDataset) {
     return (
       <div className="pt-4" data-testid="not-allowed-to-create-dataset-alert">
@@ -120,13 +151,23 @@ export function CreateDataset({
           />
         )}
 
+        {/* Show the dataset type selector only if there's more than one dataset type (besides 'dataset') */}
+        {datasetTypes.length > 1 && selectedType && (
+          <DatasetTypeSelect
+            datasetTypes={datasetTypes}
+            onChange={handleDatasetTypeChange}
+            selectedType={selectedType}
+          />
+        )}
+
         <DatasetMetadataForm
           mode="create"
           collectionId={collectionId}
           datasetRepository={datasetRepository}
           metadataBlockInfoRepository={metadataBlockInfoRepository}
           datasetTemplate={selectedTemplate ?? undefined}
-          key={selectedTemplate ? selectedTemplate.id : 'no-template-selected'} // We use the template id as key to force remounting the form when the template changes
+          datasetTypeName={selectedType ? selectedType.name : undefined}          
+          key={formKey}
         />
       </section>
     </>