change delete dataset to datasetDraft

Author: ChengShi-1

docs/useCases.md

@@ -39,7 +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)
+    - [Delete a Draft Dataset](#delete-a-draft-dataset)
 - [Files](#Files)
   - [Files read use cases](#files-read-use-cases)
     - [Get a File](#get-a-file)
@@ -845,21 +845,23 @@ Delete a Draft Dataset, given its identifier.
 ##### Example call:
 
 ```typescript
-import { deleteDataset } from '@iqss/dataverse-client-javascript'
+import { deleteDatasetDraft } from '@iqss/dataverse-client-javascript'
 
 /* ... */
 
 const datasetId = 1
 
-deletedataset.execute(datasetId)
+deleteDatasetDraft.execute(datasetId)
 
 /* ... */
 ```
 
-_See [use case](../src/datasets/domain/useCases/DeleteDataset.ts) implementation_.
+_See [use case](../src/datasets/domain/useCases/DeleteDatasetDraft.ts) implementation_.
 
 The `datasetId` parameter is a number for numeric identifiers or string for persistent identifiers.
 
+If you try to delete a dataset without draft version, you will get a not found error.
+
 #### 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,5 +60,5 @@ export interface IDatasetsRepository {
     includeMDC?: boolean
   ): Promise<DatasetDownloadCount>
   getDatasetVersionsSummaries(datasetId: number | string): Promise<DatasetVersionSummaryInfo[]>
-  deleteDataset(datasetId: number | string): Promise<void>
+  deleteDatasetDraft(datasetId: number | string): Promise<void>
 }

…atasets/domain/useCases/DeleteDataset.ts …ts/domain/useCases/DeleteDatasetDraft.tssrc/datasets/domain/useCases/DeleteDataset.ts renamed to src/datasets/domain/useCases/DeleteDatasetDraft.ts src/datasets/domain/useCases/DeleteDataset.ts renamed to src/datasets/domain/useCases/DeleteDatasetDraft.ts

@@ -1,7 +1,7 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
 
-export class DeleteDataset implements UseCase<void> {
+export class DeleteDatasetDraft implements UseCase<void> {
   private datasetsRepository: IDatasetsRepository
 
   constructor(datasetsRepository: IDatasetsRepository) {
@@ -14,6 +14,6 @@ export class DeleteDataset implements UseCase<void> {
    * @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)
+    return this.datasetsRepository.deleteDatasetDraft(datasetId)
   }
 }

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -278,7 +278,7 @@ export class DatasetsRepository extends ApiRepository implements IDatasetsReposi
       })
   }
 
-  public async deleteDataset(datasetId: string | number): Promise<void> {
+  public async deleteDatasetDraft(datasetId: string | number): Promise<void> {
     return this.doDelete(
       this.buildApiEndpoint(this.datasetsResourceName, 'versions/:draft', datasetId)
     )

…unctional/datasets/DeleteDataset.test.ts …onal/datasets/DeleteDatasetDraft.test.tstest/functional/datasets/DeleteDataset.test.ts renamed to test/functional/datasets/DeleteDatasetDraft.test.ts test/functional/datasets/DeleteDataset.test.ts renamed to test/functional/datasets/DeleteDatasetDraft.test.ts

@@ -1,4 +1,4 @@
-import { createDataset, deleteDataset } from '../../../src/datasets'
+import { createDataset, deleteDatasetDraft } from '../../../src/datasets'
 import { ApiConfig, WriteError } from '../../../src'
 import { TestConstants } from '../../testHelpers/TestConstants'
 import { DataverseApiAuthMechanism } from '../../../src/core/infra/repositories/ApiConfig'
@@ -53,12 +53,12 @@ describe('execute', () => {
   test('should delete a dataset when it is draft successfully', async () => {
     const createdDatasetIdentifiers = await createDataset.execute(testDataset)
 
-    const actual = await deleteDataset.execute(createdDatasetIdentifiers.numericId)
+    const actual = await deleteDatasetDraft.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)
+    await expect(deleteDatasetDraft.execute(1111)).rejects.toBeInstanceOf(WriteError)
   })
 })

test/integration/datasets/DatasetsRepository.test.ts

@@ -1337,13 +1337,13 @@ describe('DatasetsRepository', () => {
     })
   })
 
-  describe('deleteDataset', () => {
+  describe('deleteDatasetDraft', () => {
     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)
+      const actual = await sut.deleteDatasetDraft(testDatasetIds.numericId)
 
       expect(actual).toBeUndefined()
 
@@ -1361,7 +1361,7 @@ describe('DatasetsRepository', () => {
         `[404] Dataset with ID ${nonExistentTestDatasetId} not found.`
       )
 
-      await expect(sut.deleteDataset(nonExistentTestDatasetId)).rejects.toThrow(expectedError)
+      await expect(sut.deleteDatasetDraft(nonExistentTestDatasetId)).rejects.toThrow(expectedError)
     })
   })
 })

test/unit/datasets/DeleteDataset.test.ts …unit/datasets/DeleteDatasetDraft.test.tstest/unit/datasets/DeleteDataset.test.ts renamed to test/unit/datasets/DeleteDatasetDraft.test.ts test/unit/datasets/DeleteDataset.test.ts renamed to test/unit/datasets/DeleteDatasetDraft.test.ts

@@ -1,21 +1,21 @@
-import { DeleteDataset } from '../../../src/datasets/domain/useCases/DeleteDataset'
+import { DeleteDatasetDraft } from '../../../src/datasets/domain/useCases/DeleteDatasetDraft'
 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)
+    datasetsRepositoryStub.deleteDatasetDraft = jest.fn().mockResolvedValue(undefined)
+    const sut = new DeleteDatasetDraft(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)
+    datasetsRepositoryStub.deleteDatasetDraft = jest.fn().mockRejectedValue(new WriteError())
+    const sut = new DeleteDatasetDraft(datasetsRepositoryStub)
 
     const nonExistentDatasetId = 111
     await expect(sut.execute(nonExistentDatasetId)).rejects.toThrow(WriteError)