Skip to content

Commit 839d153

Browse files
GPortasGPortas
committed
Changed: rename File to FileModel
1 parent 7a6eea5 commit 839d153

File tree

12 files changed

+33
-30
lines changed

12 files changed

+33
-30
lines changed

‎docs/useCases.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ The `versionUpdateType` parameter can be a [VersionUpdateType](../src/datasets/d
459459

460460
#### Get a File
461461

462-
Returns a [File](../src/files/domain/models/File.ts) instance, given the search parameters to identify it.
462+
Returns a [FileModel](../src/files/domain/models/FileModel.ts) instance, given the search parameters to identify it.
463463

464464
##### Example call:
465465

@@ -471,7 +471,7 @@ import { getFile } from '@iqss/dataverse-client-javascript'
471471
const fileId = 2
472472
const datasetVersionId = '1.0'
473473

474-
getFile.execute(fileId, datasetVersionId).then((file: File) => {
474+
getFile.execute(fileId, datasetVersionId).then((file: FileModel) => {
475475
/* ... */
476476
})
477477

@@ -486,7 +486,7 @@ The optional `datasetVersionId` parameter can correspond to a numeric version id
486486

487487
#### Get a File and its Dataset
488488

489-
Returns a tuple of [File](../src/files/domain/models/File.ts) and [Dataset](../src/datasets/domain/models/Dataset.ts) objects (`[File, Dataset]`), given the search parameters to identify the file.
489+
Returns a tuple of [FileModel](../src/files/domain/models/FileModel.ts) and [Dataset](../src/datasets/domain/models/Dataset.ts) objects (`[FileModel, Dataset]`), given the search parameters to identify the file.
490490

491491
The returned dataset object corresponds to the dataset version associated with the requested file.
492492

@@ -500,7 +500,7 @@ import { getFileAndDataset } from '@iqss/dataverse-client-javascript'
500500
const fileId = 2
501501
const datasetVersionId = '1.0'
502502

503-
getFileAndDataset.execute(fileId, datasetVersionId).then((fileAndDataset: [File, Dataset]) => {
503+
getFileAndDataset.execute(fileId, datasetVersionId).then((fileAndDataset: [FileModel, Dataset]) => {
504504
/* ... */
505505
})
506506

src/files/domain/models/File.ts renamed to src/files/domain/models/FileModel.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { DvObjectOwnerNode } from '../../../core/domain/models/DvObjectOwnerNode'
22

3-
export interface File {
3+
export interface FileModel {
44
id: number
55
persistentId: string
66
name: string

‎src/files/domain/models/FilesSubset.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
import { File } from './File'
1+
import { FileModel } from './FileModel'
22

33
export interface FilesSubset {
4-
files: File[]
4+
files: FileModel[]
55
totalFilesCount: number
66
}

‎src/files/domain/repositories/IFilesRepository.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { FileUserPermissions } from '../models/FileUserPermissions'
44
import { FileSearchCriteria, FileOrderCriteria } from '../models/FileCriteria'
55
import { FileCounts } from '../models/FileCounts'
66
import { FileDownloadSizeMode } from '../models/FileDownloadSizeMode'
7-
import { File as FileModel } from '../models/File'
7+
import { FileModel } from '../models/FileModel'
88
import { Dataset } from '../../../datasets'
99
import { FileUploadDestination } from '../models/FileUploadDestination'
1010
import { UploadedFileDTO } from '../dtos/UploadedFileDTO'

‎src/files/domain/useCases/GetFile.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
import { IFilesRepository } from '../repositories/IFilesRepository'
2-
import { File } from '../models/File'
2+
import { FileModel } from '../models/FileModel'
33
import { DatasetNotNumberedVersion } from '../../../datasets'
44
import { UseCase } from '../../../core/domain/useCases/UseCase'
55

6-
export class GetFile implements UseCase<File> {
6+
export class GetFile implements UseCase<FileModel> {
77
constructor(private readonly filesRepository: IFilesRepository) {}
88

99
/**
10-
* Returns a File instance, given the search parameters to identify it.
10+
* Returns a FileModel instance, given the search parameters to identify it.
1111
*
1212
* @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
1313
* @param {string | DatasetNotNumberedVersion} [datasetVersionId=DatasetNotNumberedVersion.LATEST] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST
14-
* @returns {Promise<File>}
14+
* @returns {Promise<FileModel>}
1515
*/
1616
async execute(
1717
fileId: number | string,
1818
datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST
19-
): Promise<File> {
20-
return (await this.filesRepository.getFile(fileId, datasetVersionId, false)) as File
19+
): Promise<FileModel> {
20+
return (await this.filesRepository.getFile(fileId, datasetVersionId, false)) as FileModel
2121
}
2222
}

‎src/files/domain/useCases/GetFileAndDataset.ts‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
import { IFilesRepository } from '../repositories/IFilesRepository'
2-
import { File } from '../models/File'
2+
import { FileModel } from '../models/FileModel'
33
import { DatasetNotNumberedVersion, Dataset } from '../../../datasets'
44
import { UseCase } from '../../../core/domain/useCases/UseCase'
55

6-
export class GetFileAndDataset implements UseCase<[File, Dataset]> {
6+
export class GetFileAndDataset implements UseCase<[FileModel, Dataset]> {
77
constructor(private readonly filesRepository: IFilesRepository) {}
88

99
/**
10-
* Returns a tuple including the File instance and the associated Dataset, given the search parameters to identify the File.
10+
* Returns a tuple including the FileModel instance and the associated Dataset, given the search parameters to identify the File.
1111
*
1212
* @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
1313
* @param {string | DatasetNotNumberedVersion} [datasetVersionId=DatasetNotNumberedVersion.LATEST] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST
14-
* @returns {Promise<[File, Dataset]>}
14+
* @returns {Promise<[FileModel, Dataset]>}
1515
*/
1616
async execute(
1717
fileId: number | string,
1818
datasetVersionId: string | DatasetNotNumberedVersion = DatasetNotNumberedVersion.LATEST
19-
): Promise<[File, Dataset]> {
20-
return (await this.filesRepository.getFile(fileId, datasetVersionId, true)) as [File, Dataset]
19+
): Promise<[FileModel, Dataset]> {
20+
return (await this.filesRepository.getFile(fileId, datasetVersionId, true)) as [
21+
FileModel,
22+
Dataset
23+
]
2124
}
2225
}

‎src/files/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export {
4141
addUploadedFileToDataset
4242
}
4343

44-
export { File, FileEmbargo, FileChecksum } from './domain/models/File'
44+
export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'
4545
export { FileUserPermissions } from './domain/models/FileUserPermissions'
4646
export {
4747
FileSearchCriteria,

‎src/files/infra/repositories/FilesRepository.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { ApiRepository } from '../../../core/infra/repositories/ApiRepository'
22
import { IFilesRepository } from '../../domain/repositories/IFilesRepository'
3-
import { File as FileModel } from '../../domain/models/File'
3+
import { FileModel as FileModel } from '../../domain/models/FileModel'
44
import {
55
transformFileResponseToFile,
66
transformFilesResponseToFilesSubset

‎src/files/infra/repositories/transformers/fileTransformers.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { File, FileEmbargo, FileChecksum } from '../../../domain/models/File'
1+
import { FileModel, FileEmbargo, FileChecksum } from '../../../domain/models/FileModel'
22
import { AxiosResponse } from 'axios'
33
import { FilesSubset } from '../../../domain/models/FilesSubset'
44
import { Dataset } from '../../../../datasets'
@@ -8,7 +8,7 @@ import { transformPayloadToOwnerNode } from '../../../../core/infra/repositories
88

99
export const transformFilesResponseToFilesSubset = (response: AxiosResponse): FilesSubset => {
1010
const filesPayload = response.data.data
11-
const files: File[] = []
11+
const files: FileModel[] = []
1212
filesPayload.forEach(function (filePayload: FilePayload) {
1313
files.push(transformFilePayloadToFile(filePayload))
1414
})
@@ -22,7 +22,7 @@ export const transformFilesResponseToFilesSubset = (response: AxiosResponse): Fi
2222
export const transformFileResponseToFile = (
2323
response: AxiosResponse,
2424
returnDatasetVersion: boolean
25-
): File | [File, Dataset] => {
25+
): FileModel | [FileModel, Dataset] => {
2626
const filePayload = response.data.data
2727
if (returnDatasetVersion) {
2828
return [
@@ -33,7 +33,7 @@ export const transformFileResponseToFile = (
3333
return transformFilePayloadToFile(filePayload)
3434
}
3535

36-
const transformFilePayloadToFile = (filePayload: FilePayload): File => {
36+
const transformFilePayloadToFile = (filePayload: FilePayload): FileModel => {
3737
return {
3838
id: filePayload.dataFile.id,
3939
persistentId: filePayload.dataFile.persistentId,

‎test/integration/files/FilesRepository.test.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
CreatedDatasetIdentifiers,
2323
createDataset
2424
} from '../../../src/datasets'
25-
import { File as FileModel } from '../../../src/files/domain/models/File'
25+
import { FileModel } from '../../../src/files/domain/models/FileModel'
2626
import { FileCounts } from '../../../src/files/domain/models/FileCounts'
2727
import { FileDownloadSizeMode } from '../../../src'
2828
import {

0 commit comments

Comments
 (0)