feat: update filehasbeendeleted

Author: ChengShi-1

docs/useCases.md

@@ -1571,6 +1571,30 @@ If restrict is false then enableAccessRequest and termsOfAccess are ignored
 If restrict is true and enableAccessRequest is false then termsOfAccess is required.
 The enableAccessRequest and termsOfAccess are applied to the Draft version of the Dataset and affect all of the restricted files in said Draft version.
 
+#### File Has Been Deleted
+
+Check if the file has been deleted, return a boolean.
+
+##### Example call:
+
+```typescript
+import { fileHasBeenDeleted } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const fileId = 12345
+
+await fileHasBeenDeleted.execute(fileId).then((deleted: boolean) => {
+  /* ... */
+})
+
+/* ... */
+```
+
+_See [use case](../src/files/domain/useCases/FileHasBeenDeleted.ts) implementation_.
+
+The `fileId` parameter can be a string, for persistent identifiers, or a number, for numeric identifiers.
+
 ## Metadata Blocks
 
 ### Metadata Blocks read use cases

src/files/domain/repositories/IFilesRepository.ts

@@ -84,4 +84,6 @@ export interface IFilesRepository {
     categories: string[],
     replace?: boolean
   ): Promise<void>
+
+  fileHasBeenDeleted(fileId: number | string): Promise<boolean>
 }

src/files/domain/useCases/FileHasBeenDeleted.ts

@@ -0,0 +1,16 @@
+import { IFilesRepository } from '../repositories/IFilesRepository'
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+
+export class FileHasBeenDeleted implements UseCase<boolean> {
+  constructor(private readonly filesRepository: IFilesRepository) {}
+
+  /**
+   * Returns a boolean, indicating whether the file has been deleted or not.
+   *
+   * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<boolean>} - A boolean indicating whether the file has been deleted or not.
+   */
+  async execute(fileId: number | string): Promise<boolean> {
+    return await this.filesRepository.fileHasBeenDeleted(fileId)
+  }
+}

src/files/index.ts

@@ -17,6 +17,7 @@ import { RestrictFile } from './domain/useCases/RestrictFile'
 import { UpdateFileMetadata } from './domain/useCases/UpdateFileMetadata'
 import { UpdateFileTabularTags } from './domain/useCases/UpdateFileTabularTags'
 import { UpdateFileCategories } from './domain/useCases/UpdateFileCategories'
+import { FileHasBeenDeleted } from './domain/useCases/FileHasBeenDeleted'
 
 const filesRepository = new FilesRepository()
 const directUploadClient = new DirectUploadClient(filesRepository)
@@ -38,6 +39,7 @@ const restrictFile = new RestrictFile(filesRepository)
 const updateFileMetadata = new UpdateFileMetadata(filesRepository)
 const updateFileTabularTags = new UpdateFileTabularTags(filesRepository)
 const updateFileCategories = new UpdateFileCategories(filesRepository)
+const fileHasBeenDeleted = new FileHasBeenDeleted(filesRepository)
 
 export {
   getDatasetFiles,
@@ -56,7 +58,8 @@ export {
   updateFileMetadata,
   updateFileTabularTags,
   updateFileCategories,
-  replaceFile
+  replaceFile,
+  fileHasBeenDeleted
 }
 
 export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'

src/files/infra/repositories/FilesRepository.ts

@@ -415,4 +415,12 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
         throw error
       })
   }
+
+  public async fileHasBeenDeleted(fileId: number | string): Promise<boolean> {
+    return this.doGet(this.buildApiEndpoint(this.filesResourceName, 'hasBeenDeleted', fileId), true)
+      .then((response) => response.data.data)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/integration/files/FilesRepository.test.ts

@@ -840,6 +840,83 @@ describe('FilesRepository', () => {
     })
   })
 
+  describe('fileHasBeenDeleted', () => {
+    let deleFileTestDatasetIds: CreatedDatasetIdentifiers
+    const testTextFile1Name = 'test-file-1.txt'
+    let fileId: number
+
+    beforeAll(async () => {
+      try {
+        deleFileTestDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+      } catch (error) {
+        throw new Error('Tests beforeEach(): Error while creating test dataset')
+      }
+      await uploadFileViaApi(deleFileTestDatasetIds.numericId, testTextFile1Name).catch(() => {
+        throw new Error(`Tests beforeEach(): Error while uploading file ${testTextFile1Name}`)
+      })
+
+      const datasetFiles = await sut.getDatasetFiles(
+        deleFileTestDatasetIds.numericId,
+        latestDatasetVersionId,
+        false,
+        FileOrderCriteria.NAME_AZ
+      )
+
+      fileId = datasetFiles.files[0].id
+    })
+
+    afterAll(async () => {
+      await deletePublishedDatasetViaApi(deleFileTestDatasetIds.persistentId)
+    })
+
+    test('should return False if a file has not been deleted', async () => {
+      const hasBeenDeleted = await sut.fileHasBeenDeleted(fileId)
+      expect(hasBeenDeleted).toBe(false)
+    })
+
+    test('should return error if the dataset is unpublished and the file has been deleted', async () => {
+      await sut.deleteFile(fileId)
+
+      const expectedError = new ReadError(`[404] File with ID ${nonExistentFiledId} not found.`)
+
+      await expect(sut.fileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
+    })
+
+    test('should return True when the dataset is published and the file has not been deleted', async () => {
+      await uploadFileViaApi(deleFileTestDatasetIds.numericId, testTextFile1Name).catch(() => {
+        throw new Error(`Tests beforeEach(): Error while uploading file ${testTextFile1Name}`)
+      })
+
+      await publishDatasetViaApi(deleFileTestDatasetIds.numericId).catch(() => {
+        throw new Error('Error while publishing test Dataset')
+      })
+      await waitForNoLocks(deleFileTestDatasetIds.numericId, 10)
+
+      const datasetFiles = await sut.getDatasetFiles(
+        deleFileTestDatasetIds.numericId,
+        latestDatasetVersionId,
+        false,
+        FileOrderCriteria.NAME_AZ
+      )
+
+      fileId = datasetFiles.files[0].id
+
+      const hasBeenDeleted = await sut.fileHasBeenDeleted(fileId)
+      expect(hasBeenDeleted).toBe(false)
+
+      await sut.deleteFile(fileId)
+
+      const actual = await sut.fileHasBeenDeleted(fileId)
+      expect(actual).toBe(true)
+    })
+
+    test('should return error when file does not exist', async () => {
+      const expectedError = new ReadError(`[404] File with ID ${nonExistentFiledId} not found.`)
+
+      await expect(sut.fileHasBeenDeleted(nonExistentFiledId)).rejects.toThrow(expectedError)
+    })
+  })
+
   describe('restrictFile', () => {
     let restrictFileDatasetIds: CreatedDatasetIdentifiers
     const testTextFile1Name = 'test-file-1.txt'

test/unit/files/FileHasBeenDeleted.test.ts

@@ -0,0 +1,33 @@
+import { IFilesRepository } from '../../../src/files/domain/repositories/IFilesRepository'
+import { FileHasBeenDeleted } from '../../../src/files/domain/useCases/FileHasBeenDeleted'
+import { ReadError } from '../../../src'
+
+describe('execute', () => {
+  test('should return true when file has been deleted', async () => {
+    const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
+    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockResolvedValue(true)
+    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+
+    const result = await sut.execute(1)
+
+    expect(result).toBe(true)
+  })
+
+  test('should return false when file has not been deleted', async () => {
+    const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
+    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockResolvedValue(false)
+    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+
+    const result = await sut.execute(1)
+
+    expect(result).toBe(false)
+  })
+
+  test('should return error result on repository error', async () => {
+    const filesRepositoryStub: IFilesRepository = {} as IFilesRepository
+    filesRepositoryStub.fileHasBeenDeleted = jest.fn().mockRejectedValue(new ReadError())
+    const sut = new FileHasBeenDeleted(filesRepositoryStub)
+
+    await expect(sut.execute(1)).rejects.toThrow(ReadError)
+  })
+})