add use cases for creating datasets based on dataset type including linked metadata blocks

package.json

@@ -18,7 +18,7 @@
     "@dnd-kit/sortable": "8.0.0",
     "@dnd-kit/utilities": "3.2.2",
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.67",
+    "@iqss/dataverse-client-javascript": "2.0.0-alpha.75",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

public/locales/en/header.json

@@ -8,6 +8,7 @@
     "addData": "Add Data",
     "newCollection": "New Collection",
     "newDataset": "New Dataset",
+    "newReview": "New Review",
     "accountInfo": "Account Information",
     "apiToken": "API Token",
     "myData": "My Data"

src/dataset/domain/hooks/useGetAvailableDatasetTypes.ts

@@ -0,0 +1,56 @@
+import { useCallback, useEffect, useState } from 'react'
+import { ReadError } from '@iqss/dataverse-client-javascript'
+import { JSDataverseReadErrorHandler } from '@/shared/helpers/JSDataverseReadErrorHandler'
+import { DatasetRepository } from '../repositories/DatasetRepository'
+import { getAvailableDatasetTypes } from '../useCases/getAvailableDatasetTypes'
+import { DatasetType } from '../models/DatasetType'
+
+interface useGetAvailableDatasetTypesProps {
+  datasetRepository: DatasetRepository
+  autoFetch?: boolean
+}
+
+export const useGetAvailableDatasetTypes = ({
+  datasetRepository,
+  autoFetch = true
+}: useGetAvailableDatasetTypesProps) => {
+  const [datasetTypes, setDatasetTypes] = useState<DatasetType[]>([])
+  const [isLoadingDatasetTypes, setIsLoadingDatasetTypes] = useState<boolean>(autoFetch)
+  const [errorGetDatasetTypes, setErrorGetDatasetTypes] = useState<string | null>(null)
+
+  const fetchDatasetTypes = useCallback(async () => {
+    setIsLoadingDatasetTypes(true)
+    setErrorGetDatasetTypes(null)
+
+    try {
+      const response: DatasetType[] = await getAvailableDatasetTypes(datasetRepository)
+
+      setDatasetTypes(response)
+    } catch (err) {
+      if (err instanceof ReadError) {
+        const error = new JSDataverseReadErrorHandler(err)
+        const formattedError =
+          error.getReasonWithoutStatusCode() ?? /* istanbul ignore next */ error.getErrorMessage()
+
+        setErrorGetDatasetTypes(formattedError)
+      } else {
+        setErrorGetDatasetTypes('Something went wrong getting the dataset types. Try again later.')
+      }
+    } finally {
+      setIsLoadingDatasetTypes(false)
+    }
+  }, [datasetRepository])
+
+  useEffect(() => {
+    if (autoFetch) {
+      void fetchDatasetTypes()
+    }
+  }, [autoFetch, fetchDatasetTypes])
+
+  return {
+    datasetTypes,
+    isLoadingDatasetTypes,
+    errorGetDatasetTypes,
+    fetchDatasetTypes
+  }
+}

src/dataset/domain/models/Dataset.ts

@@ -430,7 +430,8 @@ export class Dataset {
     public readonly nextMajorVersion?: string,
     public readonly nextMinorVersion?: string,
     public readonly requiresMajorVersionUpdate?: boolean,
-    public readonly fileStore?: string
+    public readonly fileStore?: string,
+    public readonly datasetType?: string
   ) {}
 
   public checkIsLockedFromPublishing(userPersistentId: string): boolean {
@@ -525,7 +526,8 @@ export class Dataset {
       public readonly nextMajorVersionNumber?: string,
       public readonly nextMinorVersionNumber?: string,
       public readonly requiresMajorVersionUpdate?: boolean,
-      public readonly fileStore?: string
+      public readonly fileStore?: string,
+      public readonly datasetType?: string
     ) {
       this.withAlerts()
     }
@@ -597,7 +599,8 @@ export class Dataset {
         this.nextMajorVersionNumber,
         this.nextMinorVersionNumber,
         this.requiresMajorVersionUpdate,
-        this.fileStore
+        this.fileStore,
+        this.datasetType
       )
     }
   }

src/dataset/domain/models/DatasetType.ts

@@ -0,0 +1,6 @@
+export interface DatasetType {
+  id?: number
+  name: string
+  linkedMetadataBlocks?: string[]
+  availableLicenses?: string[]
+}

src/dataset/domain/repositories/DatasetRepository.ts

@@ -9,6 +9,7 @@ import { DatasetDeaccessionDTO } from '../useCases/DTOs/DatasetDTO'
 import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
 import { FormattedCitation, CitationFormat } from '../models/DatasetCitation'
 import { DatasetTemplate } from '../models/DatasetTemplate'
+import { DatasetType } from '../models/DatasetType'
 
 export interface DatasetRepository {
   getByPersistentId: (
@@ -26,7 +27,11 @@ export interface DatasetRepository {
     includeDeaccessioned: boolean
   ) => Promise<DatasetVersionDiff>
 
-  create: (dataset: DatasetDTO, collectionId: string) => Promise<{ persistentId: string }>
+  create: (
+    dataset: DatasetDTO,
+    collectionId: string,
+    datasetType?: string
+  ) => Promise<{ persistentId: string }>
   updateMetadata: (
     datasetId: string | number,
     datasetDTO: DatasetDTO,
@@ -55,5 +60,6 @@ export interface DatasetRepository {
     version: string,
     format: CitationFormat
   ) => Promise<FormattedCitation>
+  getAvailableDatasetTypes: () => Promise<DatasetType[]>
   getTemplates: (collectionIdOrAlias: number | string) => Promise<DatasetTemplate[]>
 }

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/domain/useCases/getAvailableDatasetTypes.ts

@@ -0,0 +1,8 @@
+import { DatasetRepository } from '../repositories/DatasetRepository'
+import { DatasetType } from '@iqss/dataverse-client-javascript'
+
+export function getAvailableDatasetTypes(
+  datasetRepository: DatasetRepository
+): Promise<DatasetType[]> {
+  return datasetRepository.getAvailableDatasetTypes()
+}

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,
@@ -99,7 +100,8 @@ export class JSDatasetMapper {
         latestPublishedVersionMinorNumber
       ),
       JSDatasetMapper.toRequiresMajorVersionUpdate(datasetVersionDiff),
-      fileStore
+      fileStore,
+      datasetType
     ).build()
   }
 

src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts

@@ -34,7 +34,9 @@ import {
   deleteDatasetDraft,
   getDatasetCitationInOtherFormats,
   getDatasetAvailableCategories,
-  getDatasetTemplates
+  getDatasetTemplates,
+  getDatasetAvailableDatasetTypes,
+  DatasetType
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 import { DatasetPaginationInfo } from '../../domain/models/DatasetPaginationInfo'
@@ -254,7 +256,8 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           datasetDetails.latestPublishedVersionMajorNumber,
           datasetDetails.latestPublishedVersionMinorNumber,
           datasetDetails.datasetVersionDiff,
-          datasetDetails.fileStore
+          datasetDetails.fileStore,
+          datasetDetails.jsDataset.datasetType
         )
       })
       .catch((error: ReadError) => {
@@ -312,9 +315,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
       }))
@@ -397,6 +404,9 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
   getAvailableCategories(datasetId: string | number): Promise<string[]> {
     return getDatasetAvailableCategories.execute(datasetId)
   }
+  getAvailableDatasetTypes(): Promise<DatasetType[]> {
+    return getDatasetAvailableDatasetTypes.execute()
+  }
 
   getTemplates(collectionIdOrAlias: number | string): Promise<DatasetTemplate[]> {
     return getDatasetTemplates.execute(collectionIdOrAlias)

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

@@ -8,8 +8,13 @@ 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,
+    onlyDisplayedOnCreate?: boolean,
+    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/Route.enum.ts

@@ -79,6 +79,7 @@ export enum QueryParamKey {
   TAB = 'tab',
   FILE_ID = 'id',
   DATASET_VERSION = 'datasetVersion',
+  DATASET_TYPE = 'datasetType',
   REFERRER = 'referrer',
   AUTH_STATE = 'state',
   VALID_TOKEN_BUT_NOT_LINKED_ACCOUNT = 'validTokenButNotLinkedAccount',