Added: getCollectionMetadataBlocks functional tests and tweaks

Author: GPortas

docs/useCases.md

@@ -37,6 +37,7 @@ The different use cases currently available in the package are classified below,
 - [Metadata Blocks](#metadata-blocks)
   - [Metadata Blocks read use cases](#metadata-blocks-read-use-cases)
     - [Get Metadata Block By Name](#get-metadata-block-by-name)
+    - [Get Collection Metadata Blocks](#get-collection-metadata-blocks)
 - [Users](#Users)
   - [Users read use cases](#users-read-use-cases)
     - [Get Current Authenticated User](#get-current-authenticated-user)
@@ -730,6 +731,32 @@ getMetadataBlockByName.execute(name).then((metadataBlock: MetadataBlock) => {
 
 _See [use case](../src/metadataBlocks/domain/useCases/GetMetadataBlockByName.ts) implementation_.
 
+#### Get Collection Metadata Blocks
+
+Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing the metadata blocks from the requested collection.
+
+##### Example call:
+
+```typescript
+import { getCollectionMetadataBlocks } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const collectionIdOrAlias = 'citation'
+
+getCollectionMetadataBlocks.execute(collectionAlias).then((metadataBlocks: MetadataBlock[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/metadataBlocks/domain/useCases/GetCollectionMetadataBlocks.ts) implementation_.
+
+The `collectionIdOrAlias` is a generic collection identifier, which can be either a string (for queries by CollectionAlias), or a number (for queries by CollectionId).
+
+There is a second optional parameter called `onlyDisplayedOnCreate` which indicates whether or not to return only the metadata blocks that are displayed on dataset creation. The default value is false.
+
 ## Users
 
 ### Users read use cases

test/functional/metadataBlocks/GetCollectionMetadataBlocks.test.ts

@@ -0,0 +1,42 @@
+import { ApiConfig, getCollectionMetadataBlocks, MetadataBlock, ReadError } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+
+describe('execute', () => {
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should successfully return collection metadatablocks when collection exists', async () => {
+    let collectionMetadataBlocks: MetadataBlock[] = null
+    try {
+      collectionMetadataBlocks = await getCollectionMetadataBlocks.execute('root')
+    } catch (error) {
+      throw new Error('Should not raise an error')
+    } finally {
+      expect(collectionMetadataBlocks).not.toBeNull()
+      expect(collectionMetadataBlocks.length).toBe(1)
+      expect(collectionMetadataBlocks[0].metadataFields.title.name).toBe('title')
+    }
+  })
+
+  test('should throw an error when a collection is not found', async () => {
+    expect.assertions(2)
+    let readError: ReadError
+    try {
+      await getCollectionMetadataBlocks.execute('notFoundCollectionAlias')
+      throw new Error('Use case should throw an error')
+    } catch (error) {
+      readError = error
+    } finally {
+      expect(readError).toBeInstanceOf(ReadError)
+      expect(readError.message).toEqual(
+        `There was an error when reading the resource. Reason was: [404] Can't find dataverse with identifier='notFoundCollectionAlias'`
+      )
+    }
+  })
+})

test/testHelpers/datasets/newDatasetHelper.ts

@@ -2,8 +2,12 @@ import {
   NewDatasetDTO,
   NewDatasetMetadataFieldValueDTO
 } from '../../../src/datasets/domain/dtos/NewDatasetDTO'
-import { DatasetLicense, MetadataBlock } from '../../../src'
+import { DatasetLicense, MetadataBlock, MetadataFieldType } from '../../../src'
 import { NewDatasetRequestPayload } from '../../../src/datasets/infra/repositories/transformers/newDatasetTransformers'
+import {
+  MetadataFieldWatermark,
+  MetadataFieldTypeClass
+} from '../../../src/metadataBlocks/domain/models/MetadataBlock'
 
 export const createNewDatasetDTO = (
   titleFieldValue?: NewDatasetMetadataFieldValueDTO,
@@ -102,121 +106,130 @@ export const createNewDatasetMetadataBlockModel = (): MetadataBlock => {
     id: 1,
     name: 'citation',
     displayName: 'Citation Metadata',
+    displayOnCreate: true,
     metadataFields: {
       title: {
         name: 'title',
         displayName: 'title',
         title: 'title',
-        type: 'DatasetField',
-        watermark: 'watermark',
+        type: MetadataFieldType.Text,
+        watermark: MetadataFieldWatermark.Empty,
         description: 'description',
         multiple: false,
         isControlledVocabulary: false,
         displayFormat: '#VALUE',
         isRequired: true,
         displayOrder: 0,
-        typeClass: 'primitive'
+        displayOnCreate: true,
+        typeClass: MetadataFieldTypeClass.Primitive
       },
       author: {
         name: 'author',
         displayName: 'author',
         title: 'author',
-        type: 'NONE',
-        watermark: 'watermark',
+        type: MetadataFieldType.None,
+        watermark: MetadataFieldWatermark.Empty,
         description: 'description',
         multiple: true,
         isControlledVocabulary: false,
         displayFormat: '#VALUE',
         isRequired: true,
         displayOrder: 1,
-        typeClass: 'compound',
+        typeClass: MetadataFieldTypeClass.Compound,
+        displayOnCreate: true,
         childMetadataFields: {
           authorName: {
             name: 'authorName',
             displayName: 'author name',
             title: 'author name',
-            type: 'TEXT',
-            watermark: 'watermark',
+            type: MetadataFieldType.Text,
+            watermark: MetadataFieldWatermark.Empty,
             description: 'description',
             multiple: false,
             isControlledVocabulary: false,
             displayFormat: '#VALUE',
             isRequired: true,
             displayOrder: 2,
-            typeClass: 'primitive'
+            displayOnCreate: true,
+            typeClass: MetadataFieldTypeClass.Primitive
           },
           authorAffiliation: {
             name: 'authorAffiliation',
             displayName: 'author affiliation',
             title: 'author affiliation',
-            type: 'TEXT',
-            watermark: 'watermark',
+            type: MetadataFieldType.Text,
+            watermark: MetadataFieldWatermark.Empty,
             description: 'descriprion',
             multiple: false,
             isControlledVocabulary: false,
             displayFormat: '#VALUE',
             isRequired: false,
             displayOrder: 3,
-            typeClass: 'primitive'
+            displayOnCreate: true,
+            typeClass: MetadataFieldTypeClass.Primitive
           }
         }
       },
       alternativeRequiredTitle: {
         name: 'alternativeRequiredTitle',
         displayName: 'Alternative Required Title',
         title: 'Alternative Title',
-        type: 'TEXT',
-        watermark: '',
+        type: MetadataFieldType.Text,
+        watermark: MetadataFieldWatermark.Empty,
         description:
           'Either 1) a title commonly used to refer to the Dataset or 2) an abbreviation of the main title',
         multiple: true,
         isControlledVocabulary: false,
         displayFormat: '',
         isRequired: true,
         displayOrder: 4,
-        typeClass: 'primitive'
+        displayOnCreate: true,
+        typeClass: MetadataFieldTypeClass.Primitive
       },
       timePeriodCoveredStart: {
         name: 'timePeriodCoveredStart',
         displayName: 'Time Period Start Date',
         title: 'Start Date',
-        type: 'DATE',
-        watermark: 'YYYY-MM-DD',
+        type: MetadataFieldType.Date,
+        watermark: MetadataFieldWatermark.Empty,
         description: 'The start date of the time period that the data refer to',
         multiple: false,
         isControlledVocabulary: false,
         displayFormat: '#NAME: #VALUE ',
         isRequired: false,
         displayOrder: 5,
-        typeClass: 'primitive'
+        displayOnCreate: true,
+        typeClass: MetadataFieldTypeClass.Primitive
       },
       contributor: {
         name: 'contributor',
         displayName: 'Contributor',
         title: 'Contributor',
-        type: 'NONE',
-        watermark: '',
+        type: MetadataFieldType.None,
+        watermark: MetadataFieldWatermark.Empty,
         description:
           'The entity, such as a person or organization, responsible for collecting, managing, or otherwise contributing to the development of the Dataset',
         multiple: true,
         isControlledVocabulary: false,
         displayFormat: ':',
         isRequired: false,
         displayOrder: 6,
-        typeClass: 'compound',
+        typeClass: MetadataFieldTypeClass.Compound,
+        displayOnCreate: true,
         childMetadataFields: {
           contributorType: {
             name: 'contributorType',
             displayName: 'Contributor Type',
             title: 'Type',
-            type: 'TEXT',
-            watermark: '',
+            type: MetadataFieldType.Text,
+            watermark: MetadataFieldWatermark.Empty,
             description: 'Indicates the type of contribution made to the dataset',
             multiple: false,
             isControlledVocabulary: true,
             displayFormat: '#VALUE ',
             isRequired: false,
             displayOrder: 7,
+            displayOnCreate: true,
             controlledVocabularyValues: [
               'Data Collector',
               'Data Curator',
@@ -236,22 +249,23 @@ export const createNewDatasetMetadataBlockModel = (): MetadataBlock => {
               'Work Package Leader',
               'Other'
             ],
-            typeClass: 'controlledVocabulary'
+            typeClass: MetadataFieldTypeClass.ControlledVocabulary
           },
           contributorName: {
             name: 'contributorName',
             displayName: 'Contributor Name',
             title: 'Name',
-            type: 'TEXT',
-            watermark: '1) FamilyName, GivenName or 2) Organization',
+            type: MetadataFieldType.Text,
+            watermark: MetadataFieldWatermark.Empty,
             description:
               "The name of the contributor, e.g. the person's name or the name of an organization",
             multiple: false,
             isControlledVocabulary: false,
             displayFormat: '#VALUE',
             isRequired: true,
             displayOrder: 8,
-            typeClass: 'primitive'
+            typeClass: MetadataFieldTypeClass.Primitive,
+            displayOnCreate: true
           }
         }
       }