Merge branch 'develop' of github.com:IQSS/dataverse-client-javascript into 167-get-all-facets

GPortas · GPortas · commit 7fd61ba5cc69 · 2024-08-13T11:38:27.000+02:00
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,9 @@ node_modules
 # intellij
 .idea
 
+# Visual Studio
+/.vscode
+
 # unit tests
 coverage
 
diff --git a/docs/useCases.md b/docs/useCases.md
@@ -44,6 +44,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 All Facetable Metadata Fields](#get-all-facetable-metadata-fields)
+    - [Get All Metadata Blocks](#get-all-metadata-blocks)
     - [Get Metadata Block By Name](#get-metadata-block-by-name)
     - [Get Collection Metadata Blocks](#get-collection-metadata-blocks)
 - [Users](#Users)
@@ -507,15 +508,16 @@ publishDataset.execute(datasetId, versionUpdateType)
 _See [use case](../src/datasets/domain/useCases/PublishDataset.ts) implementation_.
 
 The above example publishes the dataset with the specified identifier and performs a minor version update. If the response
-is successful, the use case does not return the dataset object, but the HTTP status code `200`. Otherwise, it throws an error.
-If you want to perform a major version update, you must set the `versionUpdateType` parameter to `VersionUpdateType.MAJOR`.
-
+is successful, the use case does not return the dataset object, but the HTTP status code `200`. Otherwise, it throws an error.\
+If you want to perform a major version update, you must set the `versionUpdateType` parameter to `VersionUpdateType.MAJOR`.\
+Superusers can pass `VersionUpdateType.UPDATE_CURRENT` to update metadata without changing the version number. This will overwrite the latest published version and therefore will only work for a dataset that has been published at least once. \*Note that this will only work also if there were no file changes in the update.\
 The `datasetId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
 
 The `versionUpdateType` parameter can be a [VersionUpdateType](../src/datasets/domain/models/VersionUpdateType.ts) enum value, which can be one of the following:
 
 - `VersionUpdateType.MINOR`
 - `VersionUpdateType.MAJOR`
+- `VersionUpdateType.UPDATE_CURRENT`
 
 ## Files
 
@@ -985,6 +987,26 @@ getAllFacetableMetadataFields.execute().then((metadataFieldInfos: MetadataFieldI
 
 _See [use case](../src/metadataBlocks/domain/useCases/GetAllFacetableMetadataFields.ts) implementation_.
 
+#### Get All Metadata Blocks
+
+Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) array containing the metadata blocks defined in the installation.
+
+##### Example call:
+
+```typescript
+import { getAllMetadataBlocks } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+getAllMetadataBlocks.execute().then((metadataBlocks: MetadataBlock[]) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/metadataBlocks/domain/useCases/GetAllMetadataBlocks.ts) implementation_.
+
 #### Get Metadata Block By Name
 
 Returns a [MetadataBlock](../src/metadataBlocks/domain/models/MetadataBlock.ts) instance, given its name.
diff --git a/src/datasets/domain/models/Dataset.ts b/src/datasets/domain/models/Dataset.ts
@@ -186,5 +186,6 @@ interface Software extends DatasetMetadataSubField {
 
 export enum VersionUpdateType {
   MAJOR = 'major',
-  MINOR = 'minor'
+  MINOR = 'minor',
+  UPDATE_CURRENT = 'updatecurrent'
 }
diff --git a/src/datasets/domain/useCases/PublishDataset.ts b/src/datasets/domain/useCases/PublishDataset.ts
@@ -13,7 +13,7 @@ export class PublishDataset implements UseCase<void> {
    * Publishes a dataset, given its identifier and the type of version update type.
    *
    * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
-   * @param {VersionUpdateType} versionUpdateType - Specifies the type of version update, 'major' or 'minor'.
+   * @param {VersionUpdateType} versionUpdateType - Specifies the type of version update, 'major', 'minor' or 'updatecurrent'
    * @returns {Promise<void>} - This method does not return anything upon successful completion.
    */
   async execute(datasetId: number | string, versionUpdateType: VersionUpdateType): Promise<void> {
diff --git a/src/datasets/domain/useCases/validators/SingleMetadataFieldValidator.ts b/src/datasets/domain/useCases/validators/SingleMetadataFieldValidator.ts
@@ -7,7 +7,10 @@ import { DateFormatFieldError } from './errors/DateFormatFieldError'
 import { MetadataFieldValidator } from './MetadataFieldValidator'
 import { DatasetMetadataChildFieldValueDTO } from '../../dtos/DatasetDTO'
 import { MultipleMetadataFieldValidator } from './MultipleMetadataFieldValidator'
-import { MetadataFieldType } from '../../../../metadataBlocks/domain/models/MetadataBlock'
+import {
+  MetadataFieldType,
+  MetadataFieldWatermark
+} from '../../../../metadataBlocks/domain/models/MetadataBlock'
 
 export class SingleMetadataFieldValidator extends BaseMetadataFieldValidator {
   validate(datasetMetadataFieldAndValueInfo: DatasetMetadataFieldAndValueInfo): void {
@@ -75,11 +78,38 @@ export class SingleMetadataFieldValidator extends BaseMetadataFieldValidator {
   private validateDateFieldValue(
     datasetMetadataFieldAndValueInfo: DatasetMetadataFieldAndValueInfo
   ) {
-    const dateFormatRegex = /^\d{4}-\d{2}-\d{2}$/
-    if (!dateFormatRegex.test(datasetMetadataFieldAndValueInfo.metadataFieldValue as string)) {
+    const {
+      metadataFieldInfo: { watermark },
+      metadataFieldValue
+    } = datasetMetadataFieldAndValueInfo
+
+    const acceptsAllDateFormats = watermark === MetadataFieldWatermark.YYYYOrYYYYMMOrYYYYMMDD
+
+    const YYYY_MM_DD_DATE_FORMAT_REGEX = /^\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$/
+
+    const YYYY_MM_FORMAT_REGEX = /^\d{4}-(0[1-9]|1[0-2])$/
+
+    const YYYY_FORMAT_REGEX = /^\d{4}$/
+
+    const isValidDateFormat = (value: string): boolean => {
+      if (acceptsAllDateFormats) {
+        // Check if it matches any of the formats
+        return (
+          YYYY_MM_DD_DATE_FORMAT_REGEX.test(value) ||
+          YYYY_MM_FORMAT_REGEX.test(value) ||
+          YYYY_FORMAT_REGEX.test(value)
+        )
+      } else {
+        // Only accepts YYYY-MM-DD format
+        return YYYY_MM_DD_DATE_FORMAT_REGEX.test(value)
+      }
+    }
+
+    if (!isValidDateFormat(metadataFieldValue as string)) {
       throw new DateFormatFieldError(
         datasetMetadataFieldAndValueInfo.metadataFieldKey,
         datasetMetadataFieldAndValueInfo.metadataBlockName,
+        watermark,
         datasetMetadataFieldAndValueInfo.metadataParentFieldKey,
         datasetMetadataFieldAndValueInfo.metadataFieldPosition
       )
diff --git a/src/datasets/domain/useCases/validators/errors/DateFormatFieldError.ts b/src/datasets/domain/useCases/validators/errors/DateFormatFieldError.ts
@@ -4,6 +4,7 @@ export class DateFormatFieldError extends FieldValidationError {
   constructor(
     metadataFieldName: string,
     citationBlockName: string,
+    validDateFormat: string,
     parentMetadataFieldName?: string,
     fieldPosition?: number
   ) {
@@ -12,7 +13,7 @@ export class DateFormatFieldError extends FieldValidationError {
       citationBlockName,
       parentMetadataFieldName,
       fieldPosition,
-      'The field requires a valid date format (YYYY-MM-DD).'
+      `The field requires a valid date format (${validDateFormat}).`
     )
   }
 }
diff --git a/src/metadataBlocks/domain/repositories/IMetadataBlocksRepository.ts b/src/metadataBlocks/domain/repositories/IMetadataBlocksRepository.ts
@@ -7,4 +7,6 @@ export interface IMetadataBlocksRepository {
     collectionIdOrAlias: number | string,
     onlyDisplayedOnCreate: boolean
   ): Promise<MetadataBlock[]>
+
+  getAllMetadataBlocks(): Promise<MetadataBlock[]>
 }
diff --git a/src/metadataBlocks/domain/useCases/GetAllMetadataBlocks.ts b/src/metadataBlocks/domain/useCases/GetAllMetadataBlocks.ts
@@ -0,0 +1,20 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { MetadataBlock } from '../..'
+import { IMetadataBlocksRepository } from '../repositories/IMetadataBlocksRepository'
+
+export class GetAllMetadataBlocks implements UseCase<MetadataBlock[]> {
+  private metadataBlocksRepository: IMetadataBlocksRepository
+
+  constructor(metadataBlocksRepository: IMetadataBlocksRepository) {
+    this.metadataBlocksRepository = metadataBlocksRepository
+  }
+
+  /**
+   * Returns a MetadataBlock array containing the metadata blocks defined in the installation.
+   *
+   * @returns {Promise<MetadataBlock[]>}
+   */
+  async execute(): Promise<MetadataBlock[]> {
+    return await this.metadataBlocksRepository.getAllMetadataBlocks()
+  }
+}
diff --git a/src/metadataBlocks/index.ts b/src/metadataBlocks/index.ts
@@ -3,6 +3,7 @@ import { MetadataBlocksRepository } from './infra/repositories/MetadataBlocksRep
 import { GetCollectionMetadataBlocks } from './domain/useCases/GetCollectionMetadataBlocks'
 import { GetAllFacetableMetadataFields } from './domain/useCases/GetAllFacetableMetadataFields'
 import { MetadataFieldInfosRepository } from './infra/repositories/MetadataFieldInfosRepository'
+import { GetAllMetadataBlocks } from './domain/useCases/GetAllMetadataBlocks'
 
 const metadataBlocksRepository = new MetadataBlocksRepository()
 const metadataFieldInfosRepository = new MetadataFieldInfosRepository()
@@ -12,12 +13,15 @@ const getCollectionMetadataBlocks = new GetCollectionMetadataBlocks(metadataBloc
 const getAllFacetableMetadataFields = new GetAllFacetableMetadataFields(
   metadataFieldInfosRepository
 )
+const getAllMetadataBlocks = new GetAllMetadataBlocks(metadataBlocksRepository)
 
 export {
   getMetadataBlockByName,
   getCollectionMetadataBlocks,
-  getAllFacetableMetadataFields
+  getAllFacetableMetadataFields,
+  getAllMetadataBlocks
 }
+
 export {
   MetadataBlock,
   MetadataFieldInfo,
diff --git a/src/metadataBlocks/infra/repositories/MetadataBlocksRepository.ts b/src/metadataBlocks/infra/repositories/MetadataBlocksRepository.ts
@@ -28,4 +28,14 @@ export class MetadataBlocksRepository extends ApiRepository implements IMetadata
         throw error
       })
   }
+
+  public async getAllMetadataBlocks(): Promise<MetadataBlock[]> {
+    return this.doGet('/metadatablocks', false, {
+      returnDatasetFieldTypes: true
+    })
+      .then((response) => transformMetadataBlocksResponseToMetadataBlocks(response))
+      .catch((error) => {
+        throw error
+      })
+  }
 }
diff --git a/test/functional/datasets/PublishDataset.test.ts b/test/functional/datasets/PublishDataset.test.ts
@@ -2,6 +2,7 @@ import {
   ApiConfig,
   createDataset,
   publishDataset,
+  updateDataset,
   VersionUpdateType,
   WriteError
 } from '../../../src'
@@ -72,6 +73,28 @@ describe('execute', () => {
     await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)
   })
 
+  test('should successfully publish a dataset with update current version', async () => {
+    const createdDatasetIdentifiers = await createDataset.execute(testNewDataset)
+
+    const firstPublishResponse = await publishDataset.execute(
+      createdDatasetIdentifiers.persistentId,
+      VersionUpdateType.MAJOR
+    )
+    await waitForNoLocks(createdDatasetIdentifiers.numericId, 10)
+
+    await updateDataset.execute(createdDatasetIdentifiers.numericId, testNewDataset)
+
+    const secondPublishResponse = await publishDataset.execute(
+      createdDatasetIdentifiers.persistentId,
+      VersionUpdateType.UPDATE_CURRENT
+    )
+    await waitForNoLocks(createdDatasetIdentifiers.numericId, 10)
+
+    expect(firstPublishResponse).toBeUndefined()
+    expect(secondPublishResponse).toBeUndefined()
+    await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)
+  })
+
   test('should throw an error when trying to publish a dataset that does not exist', async () => {
     const nonExistentTestDatasetId = 'non-existent-dataset'
     const expectedError = new WriteError(
@@ -82,4 +105,16 @@ describe('execute', () => {
       publishDataset.execute(nonExistentTestDatasetId, VersionUpdateType.MAJOR)
     ).rejects.toThrow(expectedError)
   })
+
+  test('should throw an error when trying to publish with the current version a dataset that has never been published before', async () => {
+    const createdDatasetIdentifiers = await createDataset.execute(testNewDataset)
+
+    await waitForNoLocks(createdDatasetIdentifiers.numericId, 10)
+
+    await expect(
+      publishDataset.execute(createdDatasetIdentifiers.numericId, VersionUpdateType.UPDATE_CURRENT)
+    ).rejects.toBeInstanceOf(WriteError)
+
+    await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)
+  })
 })
diff --git a/test/functional/metadataBlocks/GetAllMetadataBlocks.test.ts b/test/functional/metadataBlocks/GetAllMetadataBlocks.test.ts
@@ -0,0 +1,26 @@
+import { ApiConfig, getAllMetadataBlocks, MetadataBlock } 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 metadatablocks', async () => {
+    let metadataBlocks: MetadataBlock[] = null
+    try {
+      metadataBlocks = await getAllMetadataBlocks.execute()
+    } catch (error) {
+      throw new Error('Should not raise an error')
+    } finally {
+      expect(metadataBlocks).not.toBeNull()
+      expect(metadataBlocks.length).toBe(6)
+      expect(metadataBlocks[0].metadataFields.title.name).toBe('title')
+    }
+  })
+})
diff --git a/test/integration/datasets/DatasetsRepository.test.ts b/test/integration/datasets/DatasetsRepository.test.ts
@@ -516,6 +516,64 @@ describe('DatasetsRepository', () => {
     })
   })
 
+  describe('publish dataset with current version', () => {
+    let testDatasetIds: CreatedDatasetIdentifiers
+
+    beforeEach(async () => {
+      testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+    })
+
+    afterEach(async () => {
+      await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
+    })
+
+    test('should update current dataset version keeping same version number', async () => {
+      const expectedMajorVersion = 1
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      // Dataset is in draft, so we need to publish it first
+      await sut.publishDataset(testDatasetIds.numericId, VersionUpdateType.MAJOR)
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const datasetAfterFirstPublish = await sut.getDataset(
+        testDatasetIds.numericId,
+        DatasetNotNumberedVersion.LATEST,
+        false
+      )
+
+      // Update dataset
+      const metadataBlocksRepository = new MetadataBlocksRepository()
+      const citationMetadataBlock = await metadataBlocksRepository.getMetadataBlockByName(
+        'citation'
+      )
+      await sut.updateDataset(testDatasetIds.numericId, TestConstants.TEST_NEW_DATASET_DTO, [
+        citationMetadataBlock
+      ])
+
+      // Update current version
+      await sut.publishDataset(testDatasetIds.numericId, VersionUpdateType.UPDATE_CURRENT)
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const datasetAfterUpdatingCurrentVersion = await sut.getDataset(
+        testDatasetIds.numericId,
+        DatasetNotNumberedVersion.LATEST,
+        false
+      )
+
+      expect(datasetAfterFirstPublish.versionInfo.majorNumber).toBe(expectedMajorVersion)
+      expect(datasetAfterUpdatingCurrentVersion.versionInfo.majorNumber).toBe(expectedMajorVersion)
+    })
+
+    test('should return error when trying to publish with the current version a dataset that has never been published before', async () => {
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      await expect(
+        sut.publishDataset(testDatasetIds.numericId, VersionUpdateType.UPDATE_CURRENT)
+      ).rejects.toBeInstanceOf(WriteError)
+    })
+  })
+
   describe('updateDataset', () => {
     test('should update an existing dataset with the provided dataset citation fields', async () => {
       const testDataset = {
diff --git a/test/integration/metadataBlocks/MetadataBlocksRepository.test.ts b/test/integration/metadataBlocks/MetadataBlocksRepository.test.ts
diff --git a/test/testHelpers/datasets/datasetHelper.ts b/test/testHelpers/datasets/datasetHelper.ts
diff --git a/test/unit/datasets/DatasetResourceValidator.test.ts b/test/unit/datasets/DatasetResourceValidator.test.ts
diff --git a/test/unit/metadataBlocks/GetAllMetadataBlocks.test.ts b/test/unit/metadataBlocks/GetAllMetadataBlocks.test.ts

Original file line number	Diff line number	Diff line change
`@@ -186,5 +186,6 @@ interface Software extends DatasetMetadataSubField {`
`186`	`186`
`187`	`187`	`export enum VersionUpdateType {`
`188`	`188`	`MAJOR = 'major',`
`189`		`- MINOR = 'minor'`
	`189`	`+ MINOR = 'minor',`
	`190`	`+ UPDATE_CURRENT = 'updatecurrent'`
`190`	`191`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export class PublishDataset implements UseCase<void> {`
`13`	`13`	`* Publishes a dataset, given its identifier and the type of version update type.`
`14`	`14`	`*`
`15`	`15`	`* @param {number \| string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).`
`16`		`- * @param {VersionUpdateType} versionUpdateType - Specifies the type of version update, 'major' or 'minor'.`
	`16`	`+ * @param {VersionUpdateType} versionUpdateType - Specifies the type of version update, 'major', 'minor' or 'updatecurrent'`
`17`	`17`	`* @returns {Promise<void>} - This method does not return anything upon successful completion.`
`18`	`18`	`*/`
`19`	`19`	`async execute(datasetId: number \| string, versionUpdateType: VersionUpdateType): Promise<void> {`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ export class DateFormatFieldError extends FieldValidationError {`
`4`	`4`	`constructor(`
`5`	`5`	`metadataFieldName: string,`
`6`	`6`	`citationBlockName: string,`
	`7`	`+ validDateFormat: string,`
`7`	`8`	`parentMetadataFieldName?: string,`
`8`	`9`	`fieldPosition?: number`
`9`	`10`	`) {`
`@@ -12,7 +13,7 @@ export class DateFormatFieldError extends FieldValidationError {`
`12`	`13`	`citationBlockName,`
`13`	`14`	`parentMetadataFieldName,`
`14`	`15`	`fieldPosition,`
`15`		`- 'The field requires a valid date format (YYYY-MM-DD).'`
	`16`	+ `The field requires a valid date format (${validDateFormat}).`
`16`	`17`	`)`
`17`	`18`	`}`
`18`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,4 +7,6 @@ export interface IMetadataBlocksRepository {`
`7`	`7`	`collectionIdOrAlias: number \| string,`
`8`	`8`	`onlyDisplayedOnCreate: boolean`
`9`	`9`	`): Promise<MetadataBlock[]>`
	`10`	`+`
	`11`	`+ getAllMetadataBlocks(): Promise<MetadataBlock[]>`
`10`	`12`	`}`