refactor: interface naming

IQSS · Feb 25, 2025 · 46d5c42 · 46d5c42
1 parent 8ae3ac7
commit 46d5c42
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/...ts/domain/models/DatasetVersionSummary.ts → ...asets/domain/models/DatasetVersionInfo.ts b/...ts/domain/models/DatasetVersionSummary.ts → ...asets/domain/models/DatasetVersionInfo.ts
@@ -1,12 +1,12 @@
-export interface DatasetVersionSummary {
+export interface DatasetVersionInfo {
   id: number
   versionNumber: string
-  summary?: Summary | SummaryStringValues
+  summary?: DatasetVersionSummary | SummaryStringValues
   contributors: string
   publishedOn?: string
 }
 
-export type Summary = {
+export type DatasetVersionSummary = {
   [key: string]: SummaryUpdates | SummaryUpdatesWithFields | FilesSummaryUpdates | boolean
 }
 

diff --git a/src/datasets/domain/repositories/IDatasetsRepository.ts b/src/datasets/domain/repositories/IDatasetsRepository.ts
@@ -7,7 +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'
+import { DatasetVersionInfo } from '../models/DatasetVersionInfo'
 
 export interface IDatasetsRepository {
   getDataset(
@@ -52,5 +52,5 @@ export interface IDatasetsRepository {
     datasetVersionId: string,
     deaccessionDTO: DatasetDeaccessionDTO
   ): Promise<void>
-  getDatasetVersions(datasetId: number | string): Promise<DatasetVersionSummary[]>
+  getDatasetVersions(datasetId: number | string): Promise<DatasetVersionInfo[]>
 }
diff --git a/src/datasets/domain/useCases/GetDatasetVersions.ts b/src/datasets/domain/useCases/GetDatasetVersions.ts
@@ -1,8 +1,8 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
-import { DatasetVersionSummary } from '../models/DatasetVersionSummary'
+import { DatasetVersionInfo } from '../models/DatasetVersionInfo'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
 
-export class GetDatasetVersions implements UseCase<DatasetVersionSummary[]> {
+export class GetDatasetVersions implements UseCase<DatasetVersionInfo[]> {
   private datasetsRepository: IDatasetsRepository
 
   constructor(datasetsRepository: IDatasetsRepository) {
@@ -13,9 +13,9 @@ export class GetDatasetVersions implements UseCase<DatasetVersionSummary[]> {
    * 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.
+   * @returns {Promise<DatasetVersionInfo[]>} - An array of DatasetVersionInfo.
    */
-  async execute(datasetId: number | string): Promise<DatasetVersionSummary[]> {
+  async execute(datasetId: number | string): Promise<DatasetVersionInfo[]> {
     return await this.datasetsRepository.getDatasetVersions(datasetId)
   }
 }
diff --git a/src/datasets/infra/repositories/DatasetsRepository.ts b/src/datasets/infra/repositories/DatasetsRepository.ts
@@ -18,7 +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'
+import { DatasetVersionInfo } from '../../domain/models/DatasetVersionInfo'
 
 export interface GetAllDatasetPreviewsQueryParams {
   per_page?: number
@@ -237,7 +237,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       })
   }
 
-  public async getDatasetVersions(datasetId: string | number): Promise<DatasetVersionSummary[]> {
+  public async getDatasetVersions(datasetId: string | number): Promise<DatasetVersionInfo[]> {
     return this.doGet(
       this.buildApiEndpoint(this.datasetsResourceName, 'versions/compareSummary', datasetId),
       true

diff --git a/test/integration/datasets/DatasetsRepository.test.ts b/test/integration/datasets/DatasetsRepository.test.ts
@@ -44,9 +44,9 @@ import {
   uploadFileViaApi
 } from '../../testHelpers/files/filesHelper'
 import {
-  Summary,
+  DatasetVersionSummary,
   SummaryStringValues
-} from '../../../src/datasets/domain/models/DatasetVersionSummary'
+} from '../../../src/datasets/domain/models/DatasetVersionInfo'
 import { FilesRepository } from '../../../src/files/infra/repositories/FilesRepository'
 import { DirectUploadClient } from '../../../src/files/infra/clients/DirectUploadClient'
 import { createTestFileUploadDestination } from '../../testHelpers/files/fileUploadDestinationHelper'
@@ -1026,7 +1026,7 @@ describe('DatasetsRepository', () => {
       expect(actual.length).toEqual(2)
 
       expect(actual[0].versionNumber).toBe('DRAFT')
-      expect(actual[0].summary).toMatchObject<Summary>({
+      expect(actual[0].summary).toMatchObject<DatasetVersionSummary>({
         'Citation Metadata': {
           Title: {
             added: 0,
@@ -1094,7 +1094,7 @@ describe('DatasetsRepository', () => {
       expect(actual.length).toEqual(2)
 
       expect(actual[0].versionNumber).toBe('DRAFT')
-      expect(actual[0].summary).toMatchObject<Summary>({
+      expect(actual[0].summary).toMatchObject<DatasetVersionSummary>({
         files: {
           added: 1,
           removed: 0,