Skip to content

Commit fbd9e61

Browse files
committed
fix: naming and refactor the replace test
1 parent 8846d27 commit fbd9e61

File tree

7 files changed

+141
-152
lines changed

7 files changed

+141
-152
lines changed

docs/useCases.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ The different use cases currently available in the package are classified below,
5252
- [Get the size of Downloading all the files of a Dataset Version](#get-the-size-of-downloading-all-the-files-of-a-dataset-version)
5353
- [Get User Permissions on a File](#get-user-permissions-on-a-file)
5454
- [List Files in a Dataset](#list-files-in-a-dataset)
55+
- [Is File Deleted](#is-file-deleted)
5556
- [Files write use cases](#files-write-use-cases)
5657
- [File Uploading Use Cases](#file-uploading-use-cases)
5758
- [Delete a File](#delete-a-file)
@@ -1571,27 +1572,27 @@ If restrict is false then enableAccessRequest and termsOfAccess are ignored
15711572
If restrict is true and enableAccessRequest is false then termsOfAccess is required.
15721573
The enableAccessRequest and termsOfAccess are applied to the Draft version of the Dataset and affect all of the restricted files in said Draft version.
15731574

1574-
#### File Has Been Deleted
1575+
#### Is File Deleted
15751576

15761577
Check if the file has been deleted, return a boolean.
15771578

15781579
##### Example call:
15791580

15801581
```typescript
1581-
import { getFileHasBeenDeleted } from '@iqss/dataverse-client-javascript'
1582+
import { isFileDeleted } from '@iqss/dataverse-client-javascript'
15821583

15831584
/* ... */
15841585

15851586
const fileId = 12345
15861587

1587-
await getFileHasBeenDeleted.execute(fileId).then((hasBeenDeleted: boolean) => {
1588+
await isFileDeleted.execute(fileId).then((isDeleted: boolean) => {
15881589
/* ... */
15891590
})
15901591

15911592
/* ... */
15921593
```
15931594

1594-
_See [use case](../src/files/domain/useCases/GetFileHasBeenDeleted.ts) implementation_.
1595+
_See [use case](../src/files/domain/useCases/isFileDeleted.ts) implementation_.
15951596

15961597
The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
15971598

src/files/domain/repositories/IFilesRepository.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,5 +85,5 @@ export interface IFilesRepository {
8585
replace?: boolean
8686
): Promise<void>
8787

88-
getFileHasBeenDeleted(fileId: number | string): Promise<boolean>
88+
isFileDeleted(fileId: number | string): Promise<boolean>
8989
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { IFilesRepository } from '../repositories/IFilesRepository'
22
import { UseCase } from '../../../core/domain/useCases/UseCase'
33

4-
export class GetFileHasBeenDeleted implements UseCase<boolean> {
4+
export class IsFileDeleted implements UseCase<boolean> {
55
constructor(private readonly filesRepository: IFilesRepository) {}
66

77
/**
@@ -11,6 +11,6 @@ export class GetFileHasBeenDeleted implements UseCase<boolean> {
1111
* @returns {Promise<boolean>} - A boolean indicating whether the file has been deleted or not.
1212
*/
1313
async execute(fileId: number | string): Promise<boolean> {
14-
return await this.filesRepository.getFileHasBeenDeleted(fileId)
14+
return await this.filesRepository.isFileDeleted(fileId)
1515
}
1616
}

src/files/index.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ import { RestrictFile } from './domain/useCases/RestrictFile'
1717
import { UpdateFileMetadata } from './domain/useCases/UpdateFileMetadata'
1818
import { UpdateFileTabularTags } from './domain/useCases/UpdateFileTabularTags'
1919
import { UpdateFileCategories } from './domain/useCases/UpdateFileCategories'
20-
import { GetFileHasBeenDeleted } from './domain/useCases/GetFileHasBeenDeleted'
20+
import { IsFileDeleted } from './domain/useCases/IsFileDeleted'
2121

2222
const filesRepository = new FilesRepository()
2323
const directUploadClient = new DirectUploadClient(filesRepository)
@@ -39,7 +39,7 @@ const restrictFile = new RestrictFile(filesRepository)
3939
const updateFileMetadata = new UpdateFileMetadata(filesRepository)
4040
const updateFileTabularTags = new UpdateFileTabularTags(filesRepository)
4141
const updateFileCategories = new UpdateFileCategories(filesRepository)
42-
const getFileHasBeenDeleted = new GetFileHasBeenDeleted(filesRepository)
42+
const isFileDeleted = new IsFileDeleted(filesRepository)
4343

4444
export {
4545
getDatasetFiles,
@@ -59,7 +59,7 @@ export {
5959
updateFileTabularTags,
6060
updateFileCategories,
6161
replaceFile,
62-
getFileHasBeenDeleted
62+
isFileDeleted
6363
}
6464

6565
export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'

src/files/infra/repositories/FilesRepository.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -416,7 +416,7 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
416416
})
417417
}
418418

419-
public async getFileHasBeenDeleted(fileId: number | string): Promise<boolean> {
419+
public async isFileDeleted(fileId: number | string): Promise<boolean> {
420420
return this.doGet(this.buildApiEndpoint(this.filesResourceName, 'hasBeenDeleted', fileId), true)
421421
.then((response) => response.data.data)
422422
.catch((error) => {

0 commit comments

Comments
 (0)