Refactor: dataset DTO renaming and restructuring

Author: GPortas

src/core/domain/useCases/validators/NewResourceValidator.ts

@@ -0,0 +1,3 @@
+export interface ResourceValidator {
+  validate(...args: unknown[]): void
+}

src/core/domain/useCases/validators/ResourceValidator.ts

@@ -0,0 +1,21 @@
+import { DatasetLicense } from '../models/Dataset'
+
+export interface DatasetDTO {
+  license?: DatasetLicense
+  metadataBlockValues: DatasetMetadataBlockValuesDTO[]
+}
+
+export interface DatasetMetadataBlockValuesDTO {
+  name: string
+  fields: DatasetMetadataFieldsDTO
+}
+
+export type DatasetMetadataFieldsDTO = Record<string, DatasetMetadataFieldValueDTO>
+
+export type DatasetMetadataFieldValueDTO =
+  | string
+  | string[]
+  | DatasetMetadataChildFieldValueDTO
+  | DatasetMetadataChildFieldValueDTO[]
+
+export type DatasetMetadataChildFieldValueDTO = Record<string, string>

src/datasets/domain/dtos/DatasetDTO.ts

@@ -3,7 +3,7 @@ import { DatasetLock } from '../models/DatasetLock'
 import { DatasetPreviewSubset } from '../models/DatasetPreviewSubset'
 import { DatasetUserPermissions } from '../models/DatasetUserPermissions'
 import { CreatedDatasetIdentifiers } from '../models/CreatedDatasetIdentifiers'
-import { NewDatasetDTO } from '../dtos/NewDatasetDTO'
+import { NewDatasetDTO } from '../dtos/DatasetDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
 
 export interface IDatasetsRepository {
@@ -33,4 +33,9 @@ export interface IDatasetsRepository {
     collectionId: string
   ): Promise<CreatedDatasetIdentifiers>
   publishDataset(datasetId: number | string, versionUpdateType: VersionUpdateType): Promise<void>
+  updateDataset(
+    datasetId: number | string,
+    newDataset: NewDatasetDTO,
+    datasetMetadataBlocks: MetadataBlock[]
+  ): Promise<void>
 }

src/datasets/domain/dtos/NewDatasetDTO.ts

@@ -1,6 +1,6 @@
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
-import { NewDatasetDTO } from '../dtos/NewDatasetDTO'
-import { NewResourceValidator } from '../../../core/domain/useCases/validators/NewResourceValidator'
+import { DatasetDTO } from '../dtos/DatasetDTO'
+import { ResourceValidator } from '../../../core/domain/useCases/validators/ResourceValidator'
 import { IMetadataBlocksRepository } from '../../../metadataBlocks/domain/repositories/IMetadataBlocksRepository'
 import { CreatedDatasetIdentifiers } from '../models/CreatedDatasetIdentifiers'
 import { ROOT_COLLECTION_ALIAS } from '../../../collections/domain/models/Collection'
@@ -10,23 +10,23 @@ export class CreateDataset extends DatasetWriteUseCase<CreatedDatasetIdentifiers
   constructor(
     datasetsRepository: IDatasetsRepository,
     metadataBlocksRepository: IMetadataBlocksRepository,
-    newDatasetValidator: NewResourceValidator
+    newDatasetValidator: ResourceValidator
   ) {
     super(datasetsRepository, metadataBlocksRepository, newDatasetValidator)
   }
 
   /**
    * Creates a new Dataset in a collection, given a NewDatasetDTO object and an optional collection identifier, which defaults to root.
    *
-   * @param {NewDatasetDTO} [newDataset] - NewDatasetDTO object including the new dataset metadata field values for each metadata block.
+   * @param {DatasetDTO} [newDataset] - DatasetDTO object including the new dataset metadata field values for each metadata block.
    * @param {string} [collectionId] - Specifies the collection identifier where the new dataset should be created (optional, defaults to root).
    * @returns {Promise<CreatedDatasetIdentifiers>}
    * @throws {ResourceValidationError} - If there are validation errors related to the provided information.
    * @throws {ReadError} - If there are errors while reading data.
    * @throws {WriteError} - If there are errors while writing data.
    */
   async execute(
-    newDataset: NewDatasetDTO,
+    newDataset: DatasetDTO,
     collectionId = ROOT_COLLECTION_ALIAS
   ): Promise<CreatedDatasetIdentifiers> {
     const metadataBlocks = await this.getNewDatasetMetadataBlocks(newDataset)

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -1,19 +1,19 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
-import { NewDatasetDTO, NewDatasetMetadataBlockValuesDTO } from '../dtos/NewDatasetDTO'
-import { NewResourceValidator } from '../../../core/domain/useCases/validators/NewResourceValidator'
+import { DatasetDTO, DatasetMetadataBlockValuesDTO } from '../dtos/DatasetDTO'
+import { ResourceValidator } from '../../../core/domain/useCases/validators/ResourceValidator'
 import { IMetadataBlocksRepository } from '../../../metadataBlocks/domain/repositories/IMetadataBlocksRepository'
 import { MetadataBlock } from '../../../metadataBlocks'
 
 export abstract class DatasetWriteUseCase<T> implements UseCase<T> {
   private datasetsRepository: IDatasetsRepository
   private metadataBlocksRepository: IMetadataBlocksRepository
-  private newDatasetValidator: NewResourceValidator
+  private newDatasetValidator: ResourceValidator
 
   constructor(
     datasetsRepository: IDatasetsRepository,
     metadataBlocksRepository: IMetadataBlocksRepository,
-    newDatasetValidator: NewResourceValidator
+    newDatasetValidator: ResourceValidator
   ) {
     this.datasetsRepository = datasetsRepository
     this.metadataBlocksRepository = metadataBlocksRepository
@@ -30,20 +30,18 @@ export abstract class DatasetWriteUseCase<T> implements UseCase<T> {
     return this.metadataBlocksRepository
   }
 
-  getNewDatasetValidator(): NewResourceValidator {
+  getNewDatasetValidator(): ResourceValidator {
     return this.newDatasetValidator
   }
 
-  async getNewDatasetMetadataBlocks(newDataset: NewDatasetDTO): Promise<MetadataBlock[]> {
+  async getNewDatasetMetadataBlocks(dataset: DatasetDTO): Promise<MetadataBlock[]> {
     const metadataBlocks: MetadataBlock[] = []
     await Promise.all(
-      newDataset.metadataBlockValues.map(
-        async (metadataBlockValue: NewDatasetMetadataBlockValuesDTO) => {
-          metadataBlocks.push(
-            await this.metadataBlocksRepository.getMetadataBlockByName(metadataBlockValue.name)
-          )
-        }
-      )
+      dataset.metadataBlockValues.map(async (metadataBlockValue: DatasetMetadataBlockValuesDTO) => {
+        metadataBlocks.push(
+          await this.metadataBlocksRepository.getMetadataBlockByName(metadataBlockValue.name)
+        )
+      })
     )
     return metadataBlocks
   }

src/datasets/domain/useCases/CreateDataset.ts

@@ -0,0 +1,31 @@
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+import { DatasetDTO } from '../dtos/DatasetDTO'
+import { ResourceValidator } from '../../../core/domain/useCases/validators/ResourceValidator'
+import { IMetadataBlocksRepository } from '../../../metadataBlocks/domain/repositories/IMetadataBlocksRepository'
+import { DatasetWriteUseCase } from './DatasetWriteUseCase'
+
+export class UpdateDataset extends DatasetWriteUseCase<void> {
+  constructor(
+    datasetsRepository: IDatasetsRepository,
+    metadataBlocksRepository: IMetadataBlocksRepository,
+    newDatasetValidator: ResourceValidator
+  ) {
+    super(datasetsRepository, metadataBlocksRepository, newDatasetValidator)
+  }
+
+  /**
+   * Updates a Dataset, given a NewDatasetDTO object including the updated dataset metadata field values for each metadata block
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @param {DatasetDTO} [updatedDataset] - DatasetDTO object including the updated dataset metadata field values for each metadata block.
+   * @returns {Promise<void>} - This method does not return anything upon successful completion.
+   * @throws {ResourceValidationError} - If there are validation errors related to the provided information.
+   * @throws {ReadError} - If there are errors while reading data.
+   * @throws {WriteError} - If there are errors while writing data.
+   */
+  async execute(datasetId: number | string, updatedDataset: DatasetDTO): Promise<void> {
+    const metadataBlocks = await this.getNewDatasetMetadataBlocks(updatedDataset)
+    this.getNewDatasetValidator().validate(updatedDataset, metadataBlocks)
+    this.getDatasetsRepository().updateDataset(datasetId, updatedDataset, metadataBlocks)
+  }
+}

src/datasets/domain/useCases/DatasetWriteUseCase.ts

@@ -1,28 +1,28 @@
-import { NewDatasetMetadataFieldValueDTO } from '../../dtos/NewDatasetDTO'
+import { DatasetMetadataFieldValueDTO } from '../../dtos/DatasetDTO'
 import { FieldValidationError } from './errors/FieldValidationError'
 import { MetadataFieldInfo } from '../../../../metadataBlocks'
 
-export interface NewDatasetMetadataFieldAndValueInfo {
+export interface DatasetMetadataFieldAndValueInfo {
   metadataFieldInfo: MetadataFieldInfo
   metadataFieldKey: string
-  metadataFieldValue: NewDatasetMetadataFieldValueDTO
+  metadataFieldValue: DatasetMetadataFieldValueDTO
   metadataBlockName: string
   metadataParentFieldKey?: string
   metadataFieldPosition?: number
 }
 
 export abstract class BaseMetadataFieldValidator {
-  abstract validate(newDatasetMetadataFieldAndValueInfo: NewDatasetMetadataFieldAndValueInfo): void
+  abstract validate(datasetMetadataFieldAndValueInfo: DatasetMetadataFieldAndValueInfo): void
 
   protected createGeneralValidationError(
-    newDatasetMetadataFieldAndValueInfo: NewDatasetMetadataFieldAndValueInfo,
+    datasetMetadataFieldAndValueInfo: DatasetMetadataFieldAndValueInfo,
     reason: string
   ): FieldValidationError {
     return new FieldValidationError(
-      newDatasetMetadataFieldAndValueInfo.metadataFieldKey,
-      newDatasetMetadataFieldAndValueInfo.metadataBlockName,
-      newDatasetMetadataFieldAndValueInfo.metadataParentFieldKey,
-      newDatasetMetadataFieldAndValueInfo.metadataFieldPosition,
+      datasetMetadataFieldAndValueInfo.metadataFieldKey,
+      datasetMetadataFieldAndValueInfo.metadataBlockName,
+      datasetMetadataFieldAndValueInfo.metadataParentFieldKey,
+      datasetMetadataFieldAndValueInfo.metadataFieldPosition,
       reason
     )
   }

src/datasets/domain/useCases/UpdateDataset.ts

@@ -1,19 +1,19 @@
-import { NewDatasetDTO, NewDatasetMetadataBlockValuesDTO } from '../../dtos/NewDatasetDTO'
-import { NewResourceValidator } from '../../../../core/domain/useCases/validators/NewResourceValidator'
+import { DatasetDTO, DatasetMetadataBlockValuesDTO } from '../../dtos/DatasetDTO'
+import { ResourceValidator } from '../../../../core/domain/useCases/validators/ResourceValidator'
 import { MetadataBlock } from '../../../../metadataBlocks'
 import { BaseMetadataFieldValidator } from './BaseMetadataFieldValidator'
 
-export class NewDatasetResourceValidator implements NewResourceValidator {
+export class DatasetResourceValidator implements ResourceValidator {
   constructor(private metadataFieldValidator: BaseMetadataFieldValidator) {}
 
-  public validate(resource: NewDatasetDTO, metadataBlocks: MetadataBlock[]) {
+  public validate(resource: DatasetDTO, metadataBlocks: MetadataBlock[]) {
     for (const metadataBlockValues of resource.metadataBlockValues) {
       this.validateMetadataBlock(metadataBlockValues, metadataBlocks)
     }
   }
 
   private validateMetadataBlock(
-    metadataBlockValues: NewDatasetMetadataBlockValuesDTO,
+    metadataBlockValues: DatasetMetadataBlockValuesDTO,
     metadataBlocks: MetadataBlock[]
   ) {
     const metadataBlockName = metadataBlockValues.name