fix: order of version parameters

Author: ekraffmiller

docs/useCases.md

@@ -26,6 +26,7 @@ The different use cases currently available in the package are classified below,
     - [Get Dataset Locks](#get-dataset-locks)
     - [Get Dataset Summary Field Names](#get-dataset-summary-field-names)
     - [Get User Permissions on a Dataset](#get-user-permissions-on-a-dataset)
+    - [Get Differences between Two Dataset Versions](#get-differences-between-two-dataset-versions)
     - [List All Datasets](#list-all-datasets)
   - [Datasets write use cases](#datasets-write-use-cases)
     - [Create a Dataset](#create-a-dataset)
@@ -428,6 +429,35 @@ _See [use case](../src/datasets/domain/useCases/GetDatasetUserPermissions.ts) im
 
 The `datasetId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
 
+#### Get Differences between Two Dataset Versions
+
+Returns an instance of [DatasetVersionDiff](../src/datasets/domain/models/DatasetVersionDiff.ts) that contains the differences between two Dataset Versions.
+
+##### Example call:
+
+```typescript
+import { getDatasetVersionDiff } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const datasetId = 'doi:10.77777/FK2/AAAAAA'
+const oldVersion = '1.0'
+const newVersion = '2.0'
+
+getDatasetVersionDiff.execute(datasetId, oldVersion, newVersion).then((versionDiff: DatasetVersionDiff) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/datasets/domain/useCases/GetDatasetVersionDiff.ts) implementation_.
+
+The `datasetId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
+
+The `oldVersion` and `newVersion` parameters specify the versions of the dataset to compare.
+
+
 #### List All Datasets
 
 Returns an instance of [DatasetPreviewSubset](../src/datasets/domain/models/DatasetPreviewSubset.ts) that contains reduced information for each dataset that the calling user can access in the installation.

src/datasets/domain/useCases/GetDatasetVersionDiff.ts

@@ -12,18 +12,18 @@ export class GetDatasetVersionDiff implements UseCase<DatasetVersionDiff> {
   /**
    * Returns a DatasetVersionDiff instance, which contains the differences between the two given versions.
    * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
-   * @param {string } [newVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value.
    * @param {string } [oldVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value.
+   * @param {string } [newVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value.
    */
   async execute(
     datasetId: number | string,
-    newVersionId: string,
-    oldVersionId: string
+    oldVersionId: string,
+    newVersionId: string
   ): Promise<DatasetVersionDiff> {
     return await this.datasetsRepository.getDatasetVersionDiff(
       datasetId,
-      newVersionId,
-      oldVersionId
+      oldVersionId,
+      newVersionId
     )
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -145,8 +145,8 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
 
   public async getDatasetVersionDiff(
     datasetId: string | number,
-    newVersionId: string,
-    oldVersionId: string
+    oldVersionId: string,
+    newVersionId: string
   ): Promise<DatasetVersionDiff> {
     return this.doGet(
       this.buildApiEndpoint(

test/integration/datasets/DatasetsRepository.test.ts

@@ -490,8 +490,8 @@ describe('DatasetsRepository', () => {
       ])
       const actual = await sut.getDatasetVersionDiff(
         testDatasetIds.numericId,
-        DatasetNotNumberedVersion.DRAFT,
-        '1.0'
+        '1.0',
+        DatasetNotNumberedVersion.DRAFT
       )
       expect(actual.metadataChanges[0].blockName).toEqual('Citation Metadata')
     })
@@ -516,8 +516,8 @@ describe('DatasetsRepository', () => {
       await uploadFileViaApi(testDatasetIds.numericId, testTextFile1Name, fileMetadata)
       const actual = await sut.getDatasetVersionDiff(
         testDatasetIds.numericId,
-        DatasetNotNumberedVersion.DRAFT,
-        '1.0'
+        '1.0',
+        DatasetNotNumberedVersion.DRAFT
       )
       expect(actual.filesAdded).toEqual(expectedFilesAdded)
     })