fix: add boolean parameter to restrict or unrestrict the file

Author: g-saracca

docs/useCases.md

@@ -1278,7 +1278,7 @@ import { restrictFile } from '@iqss/dataverse-client-javascript'
 
 const fileId = 12345
 
-restrictFile.execute(fileId)
+restrictFile.execute(fileId, true)
 
 /* ... */
 ```

src/files/domain/repositories/IFilesRepository.ts

@@ -62,5 +62,5 @@ export interface IFilesRepository {
 
   deleteFile(fileId: number | string): Promise<undefined>
 
-  restrictFile(fileId: number | string): Promise<undefined>
+  restrictFile(fileId: number | string, restrict: boolean): Promise<undefined>
 }

src/files/domain/useCases/RestrictFile.ts

@@ -9,9 +9,10 @@ export class RestrictFile implements UseCase<void> {
    * 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).
+   * @param {boolean} [restrict] - A boolean value that indicates whether the file should be restricted or unrestricted.
    * @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)
+  async execute(fileId: number | string, restrict: boolean): Promise<void> {
+    return await this.filesRepository.restrictFile(fileId, restrict)
   }
 }

src/files/infra/repositories/FilesRepository.ts

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

test/unit/files/RestrictFile.test.ts

@@ -9,7 +9,7 @@ describe('execute', () => {
 
     const sut = new RestrictFile(filesRepositoryStub)
 
-    const actual = await sut.execute(1)
+    const actual = await sut.execute(1, true)
 
     expect(actual).toEqual(undefined)
   })
@@ -20,6 +20,6 @@ describe('execute', () => {
 
     const sut = new RestrictFile(filesRepositoryStub)
 
-    await expect(sut.execute(1)).rejects.toThrow(WriteError)
+    await expect(sut.execute(1, true)).rejects.toThrow(WriteError)
   })
 })