feat: add internalVersionNumber to update dataset use case

Author: g-saracca

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -45,7 +45,8 @@ export interface IDatasetsRepository {
   updateDataset(
     datasetId: number | string,
     dataset: DatasetDTO,
-    datasetMetadataBlocks: MetadataBlock[]
+    datasetMetadataBlocks: MetadataBlock[],
+    internalVersionNumber?: number
   ): Promise<void>
   deaccessionDataset(
     datasetId: number | string,

src/datasets/domain/useCases/UpdateDataset.ts

@@ -18,14 +18,24 @@ export class UpdateDataset extends DatasetWriteUseCase<void> {
    *
    * @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.
+   * @param {number} [internalVersionNumber] - The internal version number of the dataset. If another user updates the dataset version metadata before you send the update request, data inconsistencies may occur. To prevent this, you can use the optional internalVersionNumber parameter. This parameter must include the internal version number corresponding to the dataset version being updated. Note that internal version numbers increase sequentially with each version update.
    * @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> {
+  async execute(
+    datasetId: number | string,
+    updatedDataset: DatasetDTO,
+    internalVersionNumber?: number
+  ): Promise<void> {
     const metadataBlocks = await this.getNewDatasetMetadataBlocks(updatedDataset)
     this.getNewDatasetValidator().validate(updatedDataset, metadataBlocks)
-    return this.getDatasetsRepository().updateDataset(datasetId, updatedDataset, metadataBlocks)
+    return this.getDatasetsRepository().updateDataset(
+      datasetId,
+      updatedDataset,
+      metadataBlocks,
+      internalVersionNumber
+    )
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -205,12 +205,18 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
   public async updateDataset(
     datasetId: string | number,
     dataset: DatasetDTO,
-    datasetMetadataBlocks: MetadataBlock[]
+    datasetMetadataBlocks: MetadataBlock[],
+    internalVersionNumber?: number
   ): Promise<void> {
     return this.doPut(
       this.buildApiEndpoint(this.datasetsResourceName, `editMetadata`, datasetId),
       transformDatasetModelToUpdateDatasetRequestPayload(dataset, datasetMetadataBlocks),
-      { replace: true }
+      {
+        replace: true,
+        ...(typeof internalVersionNumber === 'number' && {
+          sourceInternalVersionNumber: internalVersionNumber
+        })
+      }
     )
       .then(() => undefined)
       .catch((error) => {