feat: add use case

Author: g-saracca

src/files/domain/repositories/IFilesRepository.ts

@@ -61,4 +61,6 @@ export interface IFilesRepository {
   ): Promise<undefined>
 
   deleteFile(fileId: number | string): Promise<undefined>
+
+  restrictFile(fileId: number | string): Promise<undefined>
 }

src/files/domain/useCases/RestrictFile.ts

@@ -0,0 +1,17 @@
+import { IFilesRepository } from '../repositories/IFilesRepository'
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+
+export class RestrictFile implements UseCase<void> {
+  constructor(private readonly filesRepository: IFilesRepository) {}
+
+  /**
+   * Restrict or unrestrict an existing file.
+   * More detailed information about the file restriction behavior can be found in https://guides.dataverse.org/en/latest/api/native-api.html#restrict-files
+   *
+   * @param {number | string} [fileId] - The File identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   * @returns {Promise<void>} -This method does not return anything upon successful completion.
+   */
+  async execute(fileId: number | string): Promise<void> {
+    return await this.filesRepository.restrictFile(fileId)
+  }
+}

src/files/index.ts

@@ -12,6 +12,7 @@ import { UploadFile } from './domain/useCases/UploadFile'
 import { DirectUploadClient } from './infra/clients/DirectUploadClient'
 import { AddUploadedFilesToDataset } from './domain/useCases/AddUploadedFilesToDataset'
 import { DeleteFile } from './domain/useCases/DeleteFile'
+import { RestrictFile } from './domain/useCases/RestrictFile'
 
 const filesRepository = new FilesRepository()
 const directUploadClient = new DirectUploadClient(filesRepository)
@@ -28,6 +29,7 @@ const getFileCitation = new GetFileCitation(filesRepository)
 const uploadFile = new UploadFile(directUploadClient)
 const addUploadedFilesToDataset = new AddUploadedFilesToDataset(filesRepository)
 const deleteFile = new DeleteFile(filesRepository)
+const restrictFile = new RestrictFile(filesRepository)
 
 export {
   getDatasetFiles,
@@ -41,7 +43,8 @@ export {
   getFileCitation,
   uploadFile,
   addUploadedFilesToDataset,
-  deleteFile
+  deleteFile,
+  restrictFile
 }
 
 export { FileModel as File, FileEmbargo, FileChecksum } from './domain/models/FileModel'

src/files/infra/repositories/FilesRepository.ts

@@ -301,4 +301,12 @@ export class FilesRepository extends ApiRepository implements IFilesRepository {
         throw error
       })
   }
+
+  public async restrictFile(fileId: number | string): Promise<undefined> {
+    return this.doPut(this.buildApiEndpoint(this.filesResourceName, 'restrict', fileId), {})
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }