fix: add totalCount to version summaries

ChengShi-1 · ChengShi-1 · commit ad571e5dfa84 · 2025-10-29T15:53:14.000-04:00
diff --git a/src/datasets/domain/models/DatasetVersionSummaryInfo.ts b/src/datasets/domain/models/DatasetVersionSummaryInfo.ts
@@ -6,6 +6,11 @@ export interface DatasetVersionSummaryInfo {
   publishedOn?: string
 }
 
+export interface DatasetVersionSummarySubset {
+  summaries: DatasetVersionSummaryInfo[]
+  totalCount: number
+}
+
 export type DatasetVersionSummary = {
   [key: string]:
     | SummaryUpdates
diff --git a/src/datasets/domain/repositories/IDatasetsRepository.ts b/src/datasets/domain/repositories/IDatasetsRepository.ts
@@ -8,7 +8,7 @@ import { DatasetDeaccessionDTO } from '../dtos/DatasetDeaccessionDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
 import { DatasetVersionDiff } from '../models/DatasetVersionDiff'
 import { DatasetDownloadCount } from '../models/DatasetDownloadCount'
-import { DatasetVersionSummaryInfo } from '../models/DatasetVersionSummaryInfo'
+import { DatasetVersionSummarySubset } from '../models/DatasetVersionSummaryInfo'
 import { DatasetLinkedCollection } from '../models/DatasetLinkedCollection'
 import { CitationFormat } from '../models/CitationFormat'
 import { FormattedCitation } from '../models/FormattedCitation'
@@ -70,7 +70,7 @@ export interface IDatasetsRepository {
     datasetId: number | string,
     limit?: number,
     offset?: number
-  ): Promise<DatasetVersionSummaryInfo[]>
+  ): Promise<DatasetVersionSummarySubset>
   deleteDatasetDraft(datasetId: number | string): Promise<void>
   linkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
   unlinkDataset(datasetId: number | string, collectionIdOrAlias: number | string): Promise<void>
diff --git a/src/datasets/domain/useCases/GetDatasetVersionsSummaries.ts b/src/datasets/domain/useCases/GetDatasetVersionsSummaries.ts
@@ -1,8 +1,8 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { DatasetVersionSummaryInfo } from '../models/DatasetVersionSummaryInfo'
+import { DatasetVersionSummarySubset } from '../models/DatasetVersionSummaryInfo'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
 
-export class GetDatasetVersionsSummaries implements UseCase<DatasetVersionSummaryInfo[]> {
+export class GetDatasetVersionsSummaries implements UseCase<DatasetVersionSummarySubset> {
   private datasetsRepository: IDatasetsRepository
 
   constructor(datasetsRepository: IDatasetsRepository) {
@@ -16,13 +16,13 @@ export class GetDatasetVersionsSummaries implements UseCase<DatasetVersionSummar
    * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
    * @param {number} [limit] - Limit for pagination (optional).
    * @param {number} [offset] - Offset for pagination (optional).
-   * @returns {Promise<DatasetVersionSummaryInfo[]>} - An array of DatasetVersionSummaryInfo.
+   * @returns {Promise<DatasetVersionSummarySubset>} - A DatasetVersionSummarySubset containing the summaries and total count.
    */
   async execute(
     datasetId: number | string,
     limit?: number,
     offset?: number
-  ): Promise<DatasetVersionSummaryInfo[]> {
+  ): Promise<DatasetVersionSummarySubset> {
     return await this.datasetsRepository.getDatasetVersionsSummaries(datasetId, limit, offset)
   }
 }
diff --git a/src/datasets/index.ts b/src/datasets/index.ts
@@ -141,7 +141,8 @@ export { CreatedDatasetIdentifiers } from './domain/models/CreatedDatasetIdentif
 export { VersionUpdateType } from './domain/models/Dataset'
 export {
   DatasetVersionSummaryInfo,
-  DatasetVersionSummaryStringValues
+  DatasetVersionSummaryStringValues,
+  DatasetVersionSummarySubset
 } from './domain/models/DatasetVersionSummaryInfo'
 export { DatasetLinkedCollection } from './domain/models/DatasetLinkedCollection'
 export { DatasetType } from './domain/models/DatasetType'
diff --git a/src/datasets/infra/repositories/DatasetsRepository.ts b/src/datasets/infra/repositories/DatasetsRepository.ts
@@ -20,7 +20,7 @@ import { transformDatasetPreviewsResponseToDatasetPreviewSubset } from './transf
 import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import { transformDatasetVersionDiffResponseToDatasetVersionDiff } from './transformers/datasetVersionDiffTransformers'
 import { DatasetDownloadCount } from '../../domain/models/DatasetDownloadCount'
-import { DatasetVersionSummaryInfo } from '../../domain/models/DatasetVersionSummaryInfo'
+import { DatasetVersionSummarySubset } from '../../domain/models/DatasetVersionSummaryInfo'
 import { DatasetLinkedCollection } from '../../domain/models/DatasetLinkedCollection'
 import { CitationFormat } from '../../domain/models/CitationFormat'
 import { transformDatasetLinkedCollectionsResponseToDatasetLinkedCollection } from './transformers/datasetLinkedCollectionsTransformers'
@@ -309,18 +309,26 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
     datasetId: string | number,
     limit?: number,
     offset?: number
-  ): Promise<DatasetVersionSummaryInfo[]> {
-    const queryParams: { limit?: string; offset?: string } = {
-      limit: limit?.toString(),
-      offset: offset?.toString()
+  ): Promise<DatasetVersionSummarySubset> {
+    const queryParams = new URLSearchParams()
+
+    if (limit) {
+      queryParams.set('limit', limit.toString())
+    }
+
+    if (offset) {
+      queryParams.set('offset', offset.toString())
     }
 
     return this.doGet(
       this.buildApiEndpoint(this.datasetsResourceName, 'versions/compareSummary', datasetId),
       true,
       queryParams
     )
-      .then((response) => response.data.data)
+      .then((response) => ({
+        summaries: response.data.data,
+        totalCount: response.data.totalCount
+      }))
       .catch((error) => {
         throw error
       })
diff --git a/src/files/domain/models/FileVersionSummaryInfo.ts b/src/files/domain/models/FileVersionSummaryInfo.ts
@@ -11,6 +11,11 @@ export interface FileVersionSummaryInfo {
   versionNote?: string
 }
 
+export interface FileVersionSummarySubset {
+  summaries: FileVersionSummaryInfo[]
+  totalCount: number
+}
+
 export type FileDifferenceSummary = {
   file?: FileChangeType
   fileAccess?: 'Restricted' | 'Unrestricted'
diff --git a/src/files/domain/repositories/IFilesRepository.ts b/src/files/domain/repositories/IFilesRepository.ts
@@ -10,7 +10,7 @@ import { FileUploadDestination } from '../models/FileUploadDestination'
 import { UploadedFileDTO } from '../dtos/UploadedFileDTO'
 import { UpdateFileMetadataDTO } from '../dtos/UpdateFileMetadataDTO'
 import { RestrictFileDTO } from '../dtos/RestrictFileDTO'
-import { FileVersionSummaryInfo } from '../models/FileVersionSummaryInfo'
+import { FileVersionSummarySubset } from '../models/FileVersionSummaryInfo'
 
 export interface IFilesRepository {
   getDatasetFiles(
@@ -92,7 +92,7 @@ export interface IFilesRepository {
     fileId: number | string,
     limit?: number,
     offset?: number
-  ): Promise<FileVersionSummaryInfo[]>
+  ): Promise<FileVersionSummarySubset>
 
   isFileDeleted(fileId: number | string): Promise<boolean>
 }
diff --git a/src/files/domain/useCases/GetFileVersionSummaries.ts b/src/files/domain/useCases/GetFileVersionSummaries.ts
@@ -1,8 +1,8 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { FileVersionSummaryInfo } from '../models/FileVersionSummaryInfo'
+import { FileVersionSummarySubset } from '../models/FileVersionSummaryInfo'
 import { IFilesRepository } from '../repositories/IFilesRepository'
 
-export class GetFileVersionSummaries implements UseCase<FileVersionSummaryInfo[]> {
+export class GetFileVersionSummaries implements UseCase<FileVersionSummarySubset> {
   private filesRepository: IFilesRepository
 
   constructor(filesRepository: IFilesRepository) {
@@ -15,13 +15,13 @@ export class GetFileVersionSummaries implements UseCase<FileVersionSummaryInfo[]
    * @param {number | string} [fileId] - The file identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
    * @param {number} [limit] - Limit for pagination (optional).
    * @param {number} [offset] - Offset for pagination (optional).
-   * @returns {Promise<FileVersionSummaryInfo[]>} - An array of FileVersionSummaryInfo.
+   * @returns {Promise<FileVersionSummarySubset>} - A FileVersionSummarySubset containing the summaries and total count.
    */
   async execute(
     fileId: number | string,
     limit?: number,
     offset?: number
-  ): Promise<FileVersionSummaryInfo[]> {
+  ): Promise<FileVersionSummarySubset> {
     return await this.filesRepository.getFileVersionSummaries(fileId, limit, offset)
   }
 }
diff --git a/src/files/index.ts b/src/files/index.ts
@@ -93,3 +93,10 @@ export { FilesSubset } from './domain/models/FilesSubset'
 export { FilePreview, FilePreviewChecksum } from './domain/models/FilePreview'
 export { UploadedFileDTO } from './domain/dtos/UploadedFileDTO'
 export { UpdateFileMetadataDTO } from './domain/dtos/UpdateFileMetadataDTO'
+export {
+  FileVersionSummaryInfo,
+  FileDifferenceSummary,
+  FileChangeType,
+  FileMetadataChange,
+  FileVersionSummarySubset
+} from './domain/models/FileVersionSummaryInfo'
diff --git a/src/files/infra/repositories/FilesRepository.ts b/src/files/infra/repositories/FilesRepository.ts
@@ -22,7 +22,7 @@ import { UploadedFileDTO } from '../../domain/dtos/UploadedFileDTO'
 import { UpdateFileMetadataDTO } from '../../domain/dtos/UpdateFileMetadataDTO'
 import { ApiConstants } from '../../../core/infra/repositories/ApiConstants'
 import { RestrictFileDTO } from '../../domain/dtos/RestrictFileDTO'
-import { FileVersionSummaryInfo } from '../../domain/models/FileVersionSummaryInfo'
+import { FileVersionSummarySubset } from '../../domain/models/FileVersionSummaryInfo'
 import { transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo } from './transformers/fileVersionSummaryInfoTransformers'
 
 export interface GetFilesQueryParams {
@@ -427,10 +427,15 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
     fileId: number | string,
     limit?: number,
     offset?: number
-  ): Promise<FileVersionSummaryInfo[]> {
-    const queryParams: { limit?: string; offset?: string } = {
-      limit: limit?.toString(),
-      offset: offset?.toString()
+  ): Promise<FileVersionSummarySubset> {
+    const queryParams = new URLSearchParams()
+
+    if (limit) {
+      queryParams.set('limit', limit.toString())
+    }
+
+    if (offset) {
+      queryParams.set('offset', offset.toString())
     }
 
     return this.doGet(
diff --git a/src/files/infra/repositories/transformers/fileVersionSummaryInfoTransformers.ts b/src/files/infra/repositories/transformers/fileVersionSummaryInfoTransformers.ts
@@ -2,7 +2,8 @@ import { AxiosResponse } from 'axios'
 import {
   FileVersionSummaryInfo,
   FileMetadataChange,
-  FileDifferenceSummary
+  FileDifferenceSummary,
+  FileVersionSummarySubset
 } from '../../../domain/models/FileVersionSummaryInfo'
 import { DatasetVersionState } from '../../../../datasets/domain/models/Dataset'
 
@@ -29,10 +30,11 @@ export interface FileVersionSummaryInfoPayload {
 
 export const transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo = (
   response: AxiosResponse
-): FileVersionSummaryInfo[] => {
+): FileVersionSummarySubset => {
   const payload = response.data.data
+  const totalCount = response.data.totalCount
 
-  return payload.map((item: FileVersionSummaryInfoPayload): FileVersionSummaryInfo => {
+  const summaries = payload.map((item: FileVersionSummaryInfoPayload): FileVersionSummaryInfo => {
     const summary = item.fileDifferenceSummary || {}
 
     const fileDifferenceSummary: FileDifferenceSummary = {
@@ -54,4 +56,9 @@ export const transformFileVersionSummaryInfoResponseToFileVersionSummaryInfo = (
       versionNote: item.versionNote
     }
   })
+
+  return {
+    summaries,
+    totalCount
+  }
 }
diff --git a/test/integration/datasets/DatasetsRepository.test.ts b/test/integration/datasets/DatasetsRepository.test.ts
@@ -42,8 +42,7 @@ import {
   createCollectionViaApi,
   deleteCollectionViaApi,
   publishCollectionViaApi,
-  ROOT_COLLECTION_ALIAS,
-  setStorageDriverViaApi
+  ROOT_COLLECTION_ALIAS
 } from '../../testHelpers/collections/collectionHelper'
 import {
   calculateBlobChecksum,
@@ -1292,7 +1291,6 @@ describe('DatasetsRepository', () => {
     beforeAll(async () => {
       await createCollectionViaApi(testDatasetVersionsCollectionAlias)
       await publishCollectionViaApi(testDatasetVersionsCollectionAlias)
-      await setStorageDriverViaApi(testDatasetVersionsCollectionAlias, 'LocalStack')
     })
 
     afterAll(async () => {
@@ -1306,10 +1304,12 @@ describe('DatasetsRepository', () => {
       )
 
       const actual = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
+      console.log('actual summaries', actual)
 
-      expect(actual.length).toBeGreaterThan(0)
-      expect(actual[0].versionNumber).toBe('DRAFT')
-      expect(actual[0].summary).toBe(DatasetVersionSummaryStringValues.firstDraft)
+      expect(actual.summaries.length).toBeGreaterThan(0)
+      expect(actual.totalCount).toBeGreaterThan(0)
+      expect(actual.summaries[0].versionNumber).toBe('DRAFT')
+      expect(actual.summaries[0].summary).toBe(DatasetVersionSummaryStringValues.firstDraft)
 
       await deleteUnpublishedDatasetViaApi(testDatasetIds.numericId)
     })
@@ -1325,9 +1325,10 @@ describe('DatasetsRepository', () => {
 
       const actual = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
 
-      expect(actual.length).toBeGreaterThan(0)
-      expect(actual[0].versionNumber).toBe('1.0')
-      expect(actual[0].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
+      expect(actual.summaries.length).toBeGreaterThan(0)
+      expect(actual.totalCount).toBeGreaterThan(0)
+      expect(actual.summaries[0].versionNumber).toBe('1.0')
+      expect(actual.summaries[0].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })
@@ -1348,9 +1349,10 @@ describe('DatasetsRepository', () => {
 
       const actual = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
 
-      expect(actual.length).toBeGreaterThan(0)
-      expect(actual[0].versionNumber).toBe('1.0')
-      expect(actual[0].summary).toStrictEqual(deaccessionReason)
+      expect(actual.summaries.length).toBeGreaterThan(0)
+      expect(actual.totalCount).toBeGreaterThan(0)
+      expect(actual.summaries[0].versionNumber).toBe('1.0')
+      expect(actual.summaries[0].summary).toStrictEqual(deaccessionReason)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })
@@ -1387,9 +1389,10 @@ describe('DatasetsRepository', () => {
 
       const actual = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
 
-      expect(actual.length).toEqual(2)
-      expect(actual[0].versionNumber).toBe('DRAFT')
-      expect(actual[0].summary).toMatchObject<DatasetVersionSummary>({
+      expect(actual.summaries.length).toEqual(2)
+      expect(actual.totalCount).toEqual(2)
+      expect(actual.summaries[0].versionNumber).toBe('DRAFT')
+      expect(actual.summaries[0].summary).toMatchObject<DatasetVersionSummary>({
         'Citation Metadata': {
           Title: {
             added: 0,
@@ -1407,8 +1410,8 @@ describe('DatasetsRepository', () => {
         termsAccessChanged: false
       })
 
-      expect(actual[1].versionNumber).toBe('1.0')
-      expect(actual[1].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
+      expect(actual.summaries[1].versionNumber).toBe('1.0')
+      expect(actual.summaries[1].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })
@@ -1454,10 +1457,11 @@ describe('DatasetsRepository', () => {
 
       const actual = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
 
-      expect(actual.length).toEqual(2)
+      expect(actual.summaries.length).toEqual(2)
+      expect(actual.totalCount).toEqual(2)
 
-      expect(actual[0].versionNumber).toBe('DRAFT')
-      expect(actual[0].summary).toMatchObject<DatasetVersionSummary>({
+      expect(actual.summaries[0].versionNumber).toBe('DRAFT')
+      expect(actual.summaries[0].summary).toMatchObject<DatasetVersionSummary>({
         files: {
           added: 1,
           removed: 0,
@@ -1467,8 +1471,8 @@ describe('DatasetsRepository', () => {
         },
         termsAccessChanged: false
       })
-      expect(actual[1].versionNumber).toBe('1.0')
-      expect(actual[1].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
+      expect(actual.summaries[1].versionNumber).toBe('1.0')
+      expect(actual.summaries[1].summary).toBe(DatasetVersionSummaryStringValues.firstPublished)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     })
@@ -1517,27 +1521,34 @@ describe('DatasetsRepository', () => {
         await waitForNoLocks(testDatasetIds.numericId, 10)
       }
 
+      const summaries = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
+      console.log('summaries', summaries)
+
       const firstPage = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId, 5, 0)
 
-      expect(firstPage.length).toBe(5)
-      expect(firstPage[0].versionNumber).toBe('1.21')
-      expect(firstPage[4].versionNumber).toBe('1.17')
+      expect(firstPage.summaries.length).toBe(5)
+      expect(firstPage.totalCount).toBe(22)
+      expect(firstPage.summaries[0].versionNumber).toBe('1.21')
+      expect(firstPage.summaries[4].versionNumber).toBe('1.17')
 
       // Test pagination with limit=5, offset=5 (second page)
       const secondPage = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId, 5, 5)
-      expect(secondPage.length).toBe(5)
-      expect(secondPage[0].versionNumber).toBe('1.16')
-      expect(secondPage[4].versionNumber).toBe('1.12')
+      expect(secondPage.summaries.length).toBe(5)
+      expect(secondPage.totalCount).toBe(22)
+      expect(secondPage.summaries[0].versionNumber).toBe('1.16')
+      expect(secondPage.summaries[4].versionNumber).toBe('1.12')
 
       // Test pagination with limit=5, offset=10 (third page)
       const thirdPage = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId, 5, 10)
-      expect(thirdPage.length).toBe(5)
-      expect(thirdPage[0].versionNumber).toBe('1.11')
-      expect(thirdPage[4].versionNumber).toBe('1.7')
+      expect(thirdPage.summaries.length).toBe(5)
+      expect(thirdPage.totalCount).toBe(22)
+      expect(thirdPage.summaries[0].versionNumber).toBe('1.11')
+      expect(thirdPage.summaries[4].versionNumber).toBe('1.7')
 
       // Test that all versions are returned without pagination
       const allVersions = await sut.getDatasetVersionsSummaries(testDatasetIds.numericId)
-      expect(allVersions.length).toBe(22) // 1 initial + 21 updates
+      expect(allVersions.summaries.length).toBe(22) // 1 initial + 21 updates
+      expect(allVersions.totalCount).toBe(22)
 
       await deletePublishedDatasetViaApi(testDatasetIds.persistentId)
     }, 180000)
diff --git a/test/integration/files/FilesRepository.test.ts b/test/integration/files/FilesRepository.test.ts
diff --git a/test/unit/datasets/DatasetsRepository.test.ts b/test/unit/datasets/DatasetsRepository.test.ts
diff --git a/test/unit/datasets/GetDatasetVersionsSummaries.test.ts b/test/unit/datasets/GetDatasetVersionsSummaries.test.ts
diff --git a/test/unit/files/GetFileVersionSummaries.test.ts b/test/unit/files/GetFileVersionSummaries.test.ts
