feat: update delete dataset

Author: ChengShi-1

docs/useCases.md

@@ -39,6 +39,7 @@ The different use cases currently available in the package are classified below,
     - [Update a Dataset](#update-a-dataset)
     - [Publish a Dataset](#publish-a-dataset)
     - [Deaccession a Dataset](#deaccession-a-dataset)
+    - [Delete a Dataset](#delete-a-dataset)
 - [Files](#Files)
   - [Files read use cases](#files-read-use-cases)
     - [Get a File](#get-a-file)
@@ -837,6 +838,28 @@ The `version` parameter should be a string or a [DatasetNotNumberedVersion](../s
 
 You cannot deaccession a dataset more than once. If you call this endpoint twice for the same dataset version, you will get a not found error on the second call, since the dataset you are looking for will no longer be published since it is already deaccessioned.
 
+#### Delete a Dataset
+
+Delete a Dataset, given its identifier.
+
+##### Example call:
+
+```typescript
+import { deleteDataset } from '@iqss/dataverse-client-javascript'
+
+/* ... */
+
+const datasetId = 1
+
+deletedataset.execute(datasetId)
+
+/* ... */
+```
+
+_See [use case](../src/datasets/domain/useCases/DeleteDataset.ts) implementation_.
+
+The `datasetId` parameter is a number for numeric identifiers or string for persistent identifiers.
+
 #### Get Download Count of a Dataset
 
 Total number of downloads requested for a dataset, given a dataset numeric identifier,

src/datasets/domain/repositories/IDatasetsRepository.ts

@@ -60,4 +60,5 @@ export interface IDatasetsRepository {
     includeMDC?: boolean
   ): Promise<DatasetDownloadCount>
   getDatasetVersionsSummaries(datasetId: number | string): Promise<DatasetVersionSummaryInfo[]>
+  deleteDataset(datasetId: number | string): Promise<void>
 }

src/datasets/domain/useCases/DeleteDataset.ts

@@ -0,0 +1,19 @@
+import { UseCase } from '../../../core/domain/useCases/UseCase'
+import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
+
+export class DeleteDataset implements UseCase<void> {
+  private datasetsRepository: IDatasetsRepository
+
+  constructor(datasetsRepository: IDatasetsRepository) {
+    this.datasetsRepository = datasetsRepository
+  }
+
+  /**
+   * Delete a Dataset
+   *
+   * @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
+   */
+  async execute(datasetId: number | string): Promise<void> {
+    return this.datasetsRepository.deleteDataset(datasetId)
+  }
+}

src/datasets/index.ts

@@ -19,6 +19,7 @@ import { GetDatasetVersionDiff } from './domain/useCases/GetDatasetVersionDiff'
 import { DeaccessionDataset } from './domain/useCases/DeaccessionDataset'
 import { GetDatasetDownloadCount } from './domain/useCases/GetDatasetDownloadCount'
 import { GetDatasetVersionsSummaries } from './domain/useCases/GetDatasetVersionsSummaries'
+import { DeleteDataset } from './domain/useCases/DeleteDataset'
 
 const datasetsRepository = new DatasetsRepository()
 
@@ -52,6 +53,7 @@ const updateDataset = new UpdateDataset(
 const deaccessionDataset = new DeaccessionDataset(datasetsRepository)
 const getDatasetDownloadCount = new GetDatasetDownloadCount(datasetsRepository)
 const getDatasetVersionsSummaries = new GetDatasetVersionsSummaries(datasetsRepository)
+const deleteDataset = new DeleteDataset(datasetsRepository)
 
 export {
   getDataset,
@@ -68,7 +70,8 @@ export {
   updateDataset,
   deaccessionDataset,
   getDatasetDownloadCount,
-  getDatasetVersionsSummaries
+  getDatasetVersionsSummaries,
+  deleteDataset
 }
 export { DatasetNotNumberedVersion } from './domain/models/DatasetNotNumberedVersion'
 export { DatasetUserPermissions } from './domain/models/DatasetUserPermissions'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -277,4 +277,12 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
         throw error
       })
   }
+
+  public async deleteDataset(datasetId: string | number): Promise<void> {
+    return this.doDelete(this.buildApiEndpoint(this.datasetsResourceName, undefined, datasetId))
+      .then(() => undefined)
+      .catch((error) => {
+        throw error
+      })
+  }
 }

test/functional/datasets/DeleteDataset.test.ts

@@ -0,0 +1,87 @@
+import {
+  createDataset,
+  publishDataset,
+  VersionUpdateType,
+  deleteDataset
+} from '../../../src/datasets'
+import { ApiConfig, WriteError } from '../../../src'
+import { TestConstants } from '../../testHelpers/TestConstants'
+import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
+import { waitForNoLocks } from '../../testHelpers/datasets/datasetHelper'
+
+const testDataset = {
+  license: {
+    name: 'CC0 1.0',
+    uri: 'http://creativecommons.org/publicdomain/zero/1.0',
+    iconUri: 'https://licensebuttons.net/p/zero/1.0/88x31.png'
+  },
+  metadataBlockValues: [
+    {
+      name: 'citation',
+      fields: {
+        title: 'Dataset created using the createDataset use case',
+        author: [
+          {
+            authorName: 'Admin, Dataverse',
+            authorAffiliation: 'Dataverse.org'
+          },
+          {
+            authorName: 'Owner, Dataverse',
+            authorAffiliation: 'Dataversedemo.org'
+          }
+        ],
+        datasetContact: [
+          {
+            datasetContactEmail: '[email protected]',
+            datasetContactName: 'Finch, Fiona'
+          }
+        ],
+        dsDescription: [
+          {
+            dsDescriptionValue: 'This is the description of the dataset.'
+          }
+        ],
+        subject: ['Medicine, Health and Life Sciences']
+      }
+    }
+  ]
+}
+
+describe('execute', () => {
+  beforeEach(async () => {
+    ApiConfig.init(
+      TestConstants.TEST_API_URL,
+      DataverseApiAuthMechanism.API_KEY,
+      process.env.TEST_API_KEY
+    )
+  })
+
+  test('should delete a dataset when it is published successfully', async () => {
+    const createdDatasetIdentifiers = await createDataset.execute(testDataset)
+
+    const response = await publishDataset.execute(
+      createdDatasetIdentifiers.persistentId,
+      VersionUpdateType.MAJOR
+    )
+
+    await waitForNoLocks(createdDatasetIdentifiers.numericId, 10)
+
+    expect(response).toBeUndefined()
+
+    const actual = await deleteDataset.execute(createdDatasetIdentifiers.numericId)
+
+    expect(actual).toBeUndefined()
+  })
+
+  test('should delete a dataset when it is not published successfully', async () => {
+    const createdDatasetIdentifiers = await createDataset.execute(testDataset)
+
+    const actual = await deleteDataset.execute(createdDatasetIdentifiers.numericId)
+
+    expect(actual).toBeUndefined()
+  })
+
+  test('should throw an error when the dataset id is incorrect', async () => {
+    await expect(deleteDataset.execute(1111)).rejects.toBeInstanceOf(WriteError)
+  })
+})

test/integration/datasets/DatasetsRepository.test.ts

@@ -1336,4 +1336,52 @@ describe('DatasetsRepository', () => {
       )
     })
   })
+
+  describe('deleteDataset', () => {
+    test('should delete a draft dataset', async () => {
+      const testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const actual = await sut.deleteDataset(testDatasetIds.numericId)
+
+      expect(actual).toBeUndefined()
+
+      const expectedError = new ReadError(
+        `[404] Dataset with ID ${testDatasetIds.numericId} not found.`
+      )
+
+      await expect(
+        sut.getDataset(testDatasetIds.numericId, DatasetNotNumberedVersion.LATEST, false, false)
+      ).rejects.toThrow(expectedError)
+    })
+
+    test('should delete a published dataset', async () => {
+      const testDatasetIds = await createDataset.execute(TestConstants.TEST_NEW_DATASET_DTO)
+
+      await publishDatasetViaApi(testDatasetIds.numericId)
+
+      await waitForNoLocks(testDatasetIds.numericId, 10)
+
+      const actual = await sut.deleteDataset(testDatasetIds.numericId)
+
+      expect(actual).toBeUndefined()
+
+      const expectedError = new ReadError(
+        `[404] Dataset with ID ${testDatasetIds.numericId} not found.`
+      )
+
+      await expect(
+        sut.getDataset(testDatasetIds.numericId, DatasetNotNumberedVersion.LATEST, false, false)
+      ).rejects.toThrow(expectedError)
+    })
+
+    test('should return error when dataset does not exist', async () => {
+      const expectedError = new WriteError(
+        `[404] Dataset with ID ${nonExistentTestDatasetId} not found.`
+      )
+
+      await expect(sut.deleteDataset(nonExistentTestDatasetId)).rejects.toThrow(expectedError)
+    })
+  })
 })

test/unit/datasets/DeleteDataset.test.ts

@@ -0,0 +1,23 @@
+import { DeleteDataset } from '../../../src/datasets/domain/useCases/DeleteDataset'
+import { IDatasetsRepository } from '../../../src/datasets/domain/repositories/IDatasetsRepository'
+import { WriteError } from '../../../src'
+
+describe('execute', () => {
+  test('should return undefined on delete success', async () => {
+    const datasetsRepositoryStub: IDatasetsRepository = {} as IDatasetsRepository
+    datasetsRepositoryStub.deleteDataset = jest.fn().mockResolvedValue(undefined)
+    const sut = new DeleteDataset(datasetsRepositoryStub)
+
+    const actual = await sut.execute(1)
+    expect(actual).toEqual(undefined)
+  })
+
+  test('should return error result on delete error', async () => {
+    const datasetsRepositoryStub: IDatasetsRepository = {} as IDatasetsRepository
+    datasetsRepositoryStub.deleteDataset = jest.fn().mockRejectedValue(new WriteError())
+    const sut = new DeleteDataset(datasetsRepositoryStub)
+
+    const nonExistentDatasetId = 111
+    await expect(sut.execute(nonExistentDatasetId)).rejects.toThrow(WriteError)
+  })
+})