feat: repositories and models

Author: g-saracca

src/datasets/domain/models/DatasetVersionSummary.ts

@@ -0,0 +1,115 @@
+export interface DatasetVersionSummary {
+  id: number
+  versionNumber: string
+  summary?: Summary | SummaryStringValues
+  contributors: string
+  publishedOn?: string
+}
+
+export type Summary = {
+  [key: string]: SummaryUpdates | SummaryUpdatesWithFields | FilesSummaryUpdates | boolean
+}
+
+export interface SummaryUpdates {
+  added: string // deberia ser number chequear
+  deleted: string
+  changed: string
+}
+
+export interface SummaryUpdatesWithFields {
+  [key: string]: SummaryUpdates
+}
+
+export interface FilesSummaryUpdates {
+  added: number
+  removed: number
+  replaced: number
+  changedFileMetaData: number
+  changedVariableMetadata: number
+}
+
+export enum SummaryStringValues {
+  firstPublished = 'firstPublished',
+  firstDraft = 'firstDraft',
+  versionDeaccessioned = 'versionDeaccessioned',
+  previousVersionDeaccessioned = 'previousVersionDeaccessioned'
+}
+
+export enum SummaryKnownFields {
+  files = 'files',
+  termsAccessChanged = 'termsAccessChanged'
+}
+
+// SummaryUpdates Example:
+/*
+    summary: {
+        "Geospatial Metadata": {
+            added: 1,
+            deleted: 0,
+            changed: 0
+        },
+    }
+*/
+
+// SummaryUpdatesWithFields Example:
+/*
+    summary: {
+        'Citation Metadata': {
+            Description: {
+                added: 0,
+                deleted: 0,
+                changed: 1
+            },
+            Title: {
+                added: 0,
+                deleted: 0,
+                changed: 1
+            }
+        }
+    }
+*/
+
+// FilesSummaryUpdates Example:
+/*
+    summary: {
+        files: {
+            added: 1,
+            removed: 0,
+            replaced: 0,
+            changedFileMetaData: 2,
+            changedVariableMetadata: 0
+        },
+    }
+*/
+
+const version: DatasetVersionSummary = {
+  id: 1,
+  versionNumber: '1.0',
+  contributors: 'John Doe',
+  publishedOn: '2021-06-01',
+  summary: {
+    files: {
+      added: 1,
+      changedFileMetaData: 2,
+      removed: 0,
+      replaced: 0,
+      changedVariableMetadata: 0
+    },
+    'Citation Metadata': {
+      Title: {
+        added: '0',
+        deleted: '0',
+        changed: '1'
+      }
+    },
+    termsAccessChanged: true
+  }
+}
+
+console.log({
+  typeof: typeof (
+    (version.summary as Summary)?.['Citation Metadata'] as SummaryUpdatesWithFields
+  )?.['Title'].changed
+})
+
+// console.log({ typeof: typeof (version.summary as SummaryChanges)?.['Title'].changed })

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -7,6 +7,7 @@ import { DatasetDTO } from '../dtos/DatasetDTO'
 import { DatasetDeaccessionDTO } from '../dtos/DatasetDeaccessionDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
 import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
+import { DatasetVersionSummary } from '../models/DatasetVersionSummary'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -51,4 +52,5 @@ export interface IDatasetsRepository {
     datasetVersionId: string,
     deaccessionDTO: DatasetDeaccessionDTO
   ): Promise<void>
+  getDatasetVersions(datasetId: number | string): Promise<DatasetVersionSummary[]>
 }

src/datasets/domain/useCases/GetDatasetVersions.ts

@@ -0,0 +1,21 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { DatasetVersionSummary } from '../models/DatasetVersionSummary'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class GetDatasetVersions implements UseCase<DatasetVersionSummary[]> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Returns a list of versions for a given dataset including a summary of differences between consecutive versions where available.
+   * Draft versions will only be available to users who have permission to view unpublished drafts.
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<DatasetVersionSummary[]>} - An array of DatasetVersionSummary.
+   */
+  async execute(datasetId: number | string): Promise<DatasetVersionSummary[]> {
+    return await this.datasetsRepository.getDatasetVersions(datasetId)
+  }
+}

src/datasets/index.ts

@@ -17,6 +17,7 @@ import { PublishDataset } from './domain/useCases/PublishDataset'
 import { UpdateDataset } from './domain/useCases/UpdateDataset'
 import { GetDatasetVersionDiff } from './domain/useCases/GetDatasetVersionDiff'
 import { DeaccessionDataset } from './domain/useCases/DeaccessionDataset'
+import { GetDatasetVersions } from './domain/useCases/GetDatasetVersions'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -48,6 +49,7 @@ const updateDataset = new UpdateDataset(
   datasetResourceValidator
 )
 const deaccessionDataset = new DeaccessionDataset(datasetsRepository)
+const getDatasetVersions = new GetDatasetVersions(datasetsRepository)
 
 export {
   getDataset,
@@ -62,7 +64,8 @@ export {
   publishDataset,
   createDataset,
   updateDataset,
-  deaccessionDataset
+  deaccessionDataset,
+  getDatasetVersions
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -18,6 +18,7 @@ import { transformDatasetLocksResponseToDatasetLocks } from './transformers/data
 import { transformDatasetPreviewsResponseToDatasetPreviewSubset } from './transformers/datasetPreviewsTransformers'
 import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import { transformDatasetVersionDiffResponseToDatasetVersionDiff } from './transformers/datasetVersionDiffTransformers'
+import { DatasetVersionSummary } from '../../domain/models/DatasetVersionSummary'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -162,6 +163,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
   public async createDataset(
     newDataset: DatasetDTO,
     datasetMetadataBlocks: MetadataBlock[],
@@ -234,4 +236,15 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
+  public async getDatasetVersions(datasetId: string | number): Promise<DatasetVersionSummary[]> {
+    return this.doGet(
+      this.buildApiEndpoint(this.datasetsResourceName, 'versions/compareSummary', datasetId),
+      true
+    )
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/environment/.env

@@ -1,6 +1,6 @@
 POSTGRES_VERSION=13
 DATAVERSE_DB_USER=dataverse
 SOLR_VERSION=9.3.0
-DATAVERSE_IMAGE_REGISTRY=docker.io
-DATAVERSE_IMAGE_TAG=unstable
+DATAVERSE_IMAGE_REGISTRY=ghcr.io
+DATAVERSE_IMAGE_TAG=11188-version-difference-summary
 DATAVERSE_BOOTSTRAP_TIMEOUT=5m