From 46d5c42b2f8de4acbd8af9760c6a1d00940c6e3d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Germ=C3=A1n=20Saracca?= Date: Tue, 25 Feb 2025 15:00:25 -0300 Subject: [PATCH] refactor: interface naming --- .../{DatasetVersionSummary.ts => DatasetVersionInfo.ts} | 6 +++--- src/datasets/domain/repositories/IDatasetsRepository.ts | 4 ++-- src/datasets/domain/useCases/GetDatasetVersions.ts | 8 ++++---- src/datasets/infra/repositories/DatasetsRepository.ts | 4 ++-- test/integration/datasets/DatasetsRepository.test.ts | 8 ++++---- 5 files changed, 15 insertions(+), 15 deletions(-) rename src/datasets/domain/models/{DatasetVersionSummary.ts => DatasetVersionInfo.ts} (86%) diff --git a/src/datasets/domain/models/DatasetVersionSummary.ts b/src/datasets/domain/models/DatasetVersionInfo.ts similarity index 86% rename from src/datasets/domain/models/DatasetVersionSummary.ts rename to src/datasets/domain/models/DatasetVersionInfo.ts index d47b3ac7..5501af10 100644 --- a/src/datasets/domain/models/DatasetVersionSummary.ts +++ b/src/datasets/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 index 8b3c6be2..11cd0485 100644 --- 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 - getDatasetVersions(datasetId: number | string): Promise + getDatasetVersions(datasetId: number | string): Promise } diff --git a/src/datasets/domain/useCases/GetDatasetVersions.ts b/src/datasets/domain/useCases/GetDatasetVersions.ts index f0897952..b2e109cd 100644 --- 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 { +export class GetDatasetVersions implements UseCase { private datasetsRepository: IDatasetsRepository constructor(datasetsRepository: IDatasetsRepository) { @@ -13,9 +13,9 @@ export class GetDatasetVersions implements UseCase { * 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} - An array of DatasetVersionSummary. + * @returns {Promise} - An array of DatasetVersionInfo. */ - async execute(datasetId: number | string): Promise { + async execute(datasetId: number | string): Promise { return await this.datasetsRepository.getDatasetVersions(datasetId) } } diff --git a/src/datasets/infra/repositories/DatasetsRepository.ts b/src/datasets/infra/repositories/DatasetsRepository.ts index df240cc1..affb9709 100644 --- 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 { + public async getDatasetVersions(datasetId: string | number): Promise { 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 index 5ed2c314..9ea95ec4 100644 --- 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({ + expect(actual[0].summary).toMatchObject({ '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({ + expect(actual[0].summary).toMatchObject({ files: { added: 1, removed: 0,