Update datasetType model

CHANGELOG.md

@@ -16,6 +16,7 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - New Use Case: [Get a Template](./docs/useCases.md#get-a-template) under Templates.
 - New Use Case: [Delete a Template](./docs/useCases.md#delete-a-template) under Templates.
 - New Use Case: [Update Terms of Access](./docs/useCases.md#update-terms-of-access).
+- DatasetType: Updated datasetType data model. Added two more fields: description and displayName.
 
 ### Changed
 

src/datasets/domain/models/DatasetType.ts

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

test/functional/datasets/AddDatasetType.test.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto'
 import { ApiConfig, DatasetType, addDatasetType, deleteDatasetType } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
@@ -13,11 +14,13 @@ describe('AddDatasetType', () => {
     })
 
     test('should allow for adding and deleting a dataset type', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 

test/functional/datasets/DeleteDatasetType.test.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto'
 import { ApiConfig, DatasetType, addDatasetType, deleteDatasetType } from '../../../src'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
 import { TestConstants } from '../../testHelpers/TestConstants'
@@ -13,11 +14,13 @@ describe('DeleteDatasetType', () => {
     })
 
     test('should allow for adding and deleting a dataset type', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 

test/functional/datasets/GetDatasetAvailableDatasetType.test.ts

@@ -20,8 +20,11 @@ describe('getDatasetAvailableDatasetType', () => {
       const expectedDatasetType = {
         id: 1,
         name: 'dataset',
+        displayName: 'Dataset',
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        description:
+          'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
       }
 
       expect(actualDatasetType).toEqual(expectedDatasetType)

test/functional/datasets/GetDatasetAvailableDatasetTypes.test.ts

@@ -19,10 +19,12 @@ describe('getDatasetAvailableDatasetTypes', () => {
           id: 1,
           name: 'dataset',
           linkedMetadataBlocks: [],
-          availableLicenses: []
+          availableLicenses: [],
+          description:
+            'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.',
+          displayName: 'Dataset'
         }
       ]
-
       expect(actualDatasetTypes).toEqual(expectedDatasetTypes)
     })
   })

test/functional/datasets/LinkDatasetTypeWithMetadataBlocks.test.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto'
 import {
   ApiConfig,
   DatasetType,
@@ -19,11 +20,13 @@ describe('LinkDatasetTypeWithMetadataBlocks', () => {
     })
 
     test('should allow for linking a dataset type to metadata blocks', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 

test/functional/datasets/SetAvailableLicensesForDatasetType.test.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto'
 import {
   ApiConfig,
   DatasetType,
@@ -19,11 +20,13 @@ describe('SetAvailableLicensesForDatasetType', () => {
     })
 
     test('should allow for setting available licenses for a dataset type', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 

test/integration/datasets/DatasetsRepository.test.ts

@@ -1,3 +1,4 @@
+import { randomUUID } from 'node:crypto'
 import { DatasetsRepository } from '../../../src/datasets/infra/repositories/DatasetsRepository'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import {
@@ -1821,8 +1822,11 @@ describe('DatasetsRepository', () => {
         {
           id: 1,
           name: 'dataset',
+          displayName: 'Dataset',
           linkedMetadataBlocks: [],
-          availableLicenses: []
+          availableLicenses: [],
+          description:
+            'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
         }
       ]
 
@@ -1839,8 +1843,11 @@ describe('DatasetsRepository', () => {
       const expectedDatasetType = {
         id: 1,
         name: 'dataset',
+        displayName: 'Dataset',
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        description:
+          'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
       }
 
       expect(actualDatasetType).toEqual(expectedDatasetType)
@@ -1849,11 +1856,13 @@ describe('DatasetsRepository', () => {
 
   describe('addDatasetType', () => {
     test('should add a dataset type', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
 
       expect(actual.name).toEqual(randomName)
@@ -1862,11 +1871,13 @@ describe('DatasetsRepository', () => {
 
   describe('deleteDatasetType', () => {
     test('should delete a dataset type (after adding it)', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 
@@ -1877,11 +1888,13 @@ describe('DatasetsRepository', () => {
 
   describe('linkDatasetTypeWithMetadataBlocks', () => {
     test('should allow for linking a dataset type to metadata blocks', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 
@@ -1899,11 +1912,13 @@ describe('DatasetsRepository', () => {
 
   describe('setAvailableLicensesForDatasetType', () => {
     test('should allow for setting available licenses for a dataset type', async () => {
-      const randomName = `datasetType-${crypto.randomUUID().slice(0, 6)}`
+      const randomName = `datasetType-${randomUUID().slice(0, 6)}`
       const actual: DatasetType = await addDatasetType.execute({
         name: randomName,
         linkedMetadataBlocks: [],
-        availableLicenses: []
+        availableLicenses: [],
+        displayName: randomName,
+        description: 'A dataset type created for testing purposes'
       })
       expect(actual.name).toEqual(randomName)
 

test/unit/datasets/GetDatasetAvailableDatasetType.test.ts

@@ -11,8 +11,11 @@ describe('GetDatasetAvailableDatasetType', () => {
   const expectedDatasetType: DatasetType = {
     id: datasetTypeId,
     name: datasetTypeName,
+    displayName: 'Dataset',
     linkedMetadataBlocks: [],
-    availableLicenses: []
+    availableLicenses: [],
+    description:
+      'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
   }
 
   it('should get a dataset type by database id', async () => {

test/unit/datasets/GetDatasetAvailableDatasetTypes.test.ts

@@ -12,14 +12,19 @@ describe('GetDatasetAvailableDatasetTypes', () => {
         {
           id: 1,
           name: 'dataset',
+          displayName: 'Dataset',
           linkedMetadataBlocks: [],
-          availableLicenses: []
+          availableLicenses: [],
+          description:
+            'A study, experiment, set of observations, or publication. A dataset can comprise a single file or multiple files.'
         },
         {
           id: 2,
           name: 'software',
+          displayName: 'Software',
           linkedMetadataBlocks: ['codeMeta20'],
-          availableLicenses: ['MIT', 'Apache-2.0']
+          availableLicenses: ['MIT', 'Apache-2.0'],
+          description: 'Software data and metadata.'
         }
       ]