fix: typo and add a test

Author: ChengShi-1

docs/useCases.md

@@ -754,9 +754,9 @@ The `versionUpdateType` parameter can be a [VersionUpdateType](../src/datasets/d
 - `VersionUpdateType.MAJOR`
 - `VersionUpdateType.UPDATE_CURRENT`
 
-#### Deaccesion a Dataset
+#### Deaccession a Dataset
 
-Deaccesion a Dataset, given its identifier, version, and deaccessionDatasetDTO to perform.
+Deaccession a Dataset, given its identifier, version, and deaccessionDatasetDTO to perform.
 
 ##### Example call:
 
@@ -777,7 +777,7 @@ deaccessionDataset.execute(datasetId, version, deaccessionDatasetDTO)
 /* ... */
 ```
 
-_See [use case](../src/datasets/domain/useCases/DeaccesionDataset.ts) implementation_.
+_See [use case](../src/datasets/domain/useCases/DeaccessionDataset.ts) implementation_.
 The `datasetId` parameter can be a string for persistent identifiers, or a number for numeric identifiers.
 The `version` parameter should be a string or a [DatasetNotNumberedVersion](../src/datasets/domain/models/DatasetNotNumberedVersion.ts) enum value.
 

src/datasets/domain/dtos/DatasetDTO.ts

@@ -10,11 +10,6 @@ export interface DatasetMetadataBlockValuesDTO {
   fields: DatasetMetadataFieldsDTO
 }
 
-export interface DatasetDeaccessionDTO {
-  deaccessionReason: string
-  deaccessionForwardURL?: string
-}
-
 export type DatasetMetadataFieldsDTO = Record<string, DatasetMetadataFieldValueDTO>
 
 export type DatasetMetadataFieldValueDTO =

src/datasets/domain/dtos/DatasetDeaccessionDTO.ts

@@ -0,0 +1,4 @@
+export interface DatasetDeaccessionDTO {
+  deaccessionReason: string
+  deaccessionForwardURL?: string
+}

src/datasets/domain/useCases/DeaccessionDataset.ts

@@ -1,6 +1,6 @@
 import { UseCase } from '../../../core/domain/useCases/UseCase'
 import { IDatasetsRepository } from '../repositories/IDatasetsRepository'
-import { DatasetDeaccessionDTO } from '../dtos/DatasetDTO'
+import { DatasetDeaccessionDTO } from '../dtos/DatasetDeaccessionDTO'
 import { DatasetNotNumberedVersion } from '../models/DatasetNotNumberedVersion'
 
 export class DeaccessionDataset implements UseCase<void> {

src/datasets/index.ts

@@ -86,8 +86,8 @@ export {
   DatasetMetadataFieldsDTO,
   DatasetMetadataFieldValueDTO,
   DatasetMetadataBlockValuesDTO,
-  DatasetMetadataChildFieldValueDTO,
-  DatasetDeaccessionDTO
+  DatasetMetadataChildFieldValueDTO
 } from './domain/dtos/DatasetDTO'
+export { DatasetDeaccessionDTO } from './domain/dtos/DatasetDeaccessionDTO'
 export { CreatedDatasetIdentifiers } from './domain/models/CreatedDatasetIdentifiers'
 export { VersionUpdateType } from './domain/models/Dataset'

src/datasets/infra/repositories/DatasetsRepository.ts

@@ -10,7 +10,8 @@ import { transformDatasetUserPermissionsResponseToDatasetUserPermissions } from
 import { DatasetLock } from '../../domain/models/DatasetLock'
 import { CreatedDatasetIdentifiers } from '../../domain/models/CreatedDatasetIdentifiers'
 import { DatasetPreviewSubset } from '../../domain/models/DatasetPreviewSubset'
-import { DatasetDTO, DatasetDeaccessionDTO } from '../../domain/dtos/DatasetDTO'
+import { DatasetDTO } from '../../domain/dtos/DatasetDTO'
+import { DatasetDeaccessionDTO } from '../../domain/dtos/DatasetDeaccessionDTO'
 import { MetadataBlock } from '../../../metadataBlocks'
 import { transformDatasetModelToNewDatasetRequestPayload } from './transformers/datasetTransformers'
 import { transformDatasetLocksResponseToDatasetLocks } from './transformers/datasetLocksTransformers'

test/functional/datasets/DeaccessionDataset.test.ts

@@ -72,15 +72,15 @@ describe('execute', () => {
 
     expect(response).toBeUndefined()
 
-    const testDeaccessionDataset: DatasetDeaccessionDTO = {
+    const testDeaccessionDatasetDTO: DatasetDeaccessionDTO = {
       deaccessionReason: 'Description of the deaccession reason.',
       deaccessionForwardURL: 'https://demo.dataverse.org'
     }
 
     const actual = await deaccessionDataset.execute(
       createdDatasetIdentifiers.numericId,
       '1.0',
-      testDeaccessionDataset
+      testDeaccessionDatasetDTO
     )
 
     expect(actual).toBeUndefined()
@@ -91,7 +91,7 @@ describe('execute', () => {
   test('should throw an error when the dataset id is incorrect', async () => {
     const createdDatasetIdentifiers = await createDataset.execute(testDataset)
 
-    const testDeaccessionDataset: DatasetDeaccessionDTO = {
+    const testDeaccessionDatasetDTO: DatasetDeaccessionDTO = {
       deaccessionReason: 'Description of the deaccession reason.',
       deaccessionForwardURL: 'https://demo.dataverse.org'
     }
@@ -100,7 +100,7 @@ describe('execute', () => {
       deaccessionDataset.execute(
         createdDatasetIdentifiers.numericId,
         ':latest-published',
-        testDeaccessionDataset
+        testDeaccessionDatasetDTO
       )
     ).rejects.toThrow(Error)
 
@@ -109,22 +109,22 @@ describe('execute', () => {
 
   test('should not deaccession a dataset when it is not published', async () => {
     const createdDatasetIdentifiers = await createDataset.execute(testDataset)
-    const testDeaccessionDataset: DatasetDeaccessionDTO = {
+    const testDeaccessionDatasetDTO: DatasetDeaccessionDTO = {
       deaccessionReason: 'Description of the deaccession reason.'
     }
 
     await expect(
       deaccessionDataset.execute(
         createdDatasetIdentifiers.numericId,
         ':latest-published',
-        testDeaccessionDataset
+        testDeaccessionDatasetDTO
       )
     ).rejects.toBeInstanceOf(WriteError)
 
     await deleteUnpublishedDatasetViaApi(createdDatasetIdentifiers.numericId)
   })
 
-  test('should deaccession a dataset when it is deaccessioned once', async () => {
+  test('should not deaccession a dataset when it is deaccessioned once', async () => {
     const createdDatasetIdentifiers = await createDataset.execute(testDataset)
 
     const response = await publishDataset.execute(
@@ -135,21 +135,25 @@ describe('execute', () => {
 
     expect(response).toBeUndefined()
 
-    const testDeaccessionDataset: DatasetDeaccessionDTO = {
+    const testDeaccessionDatasetDTO: DatasetDeaccessionDTO = {
       deaccessionReason: 'Description of the deaccession reason.',
       deaccessionForwardURL: 'https://demo.dataverse.org'
     }
 
     const actual = await deaccessionDataset.execute(
       createdDatasetIdentifiers.numericId,
       '1.0',
-      testDeaccessionDataset
+      testDeaccessionDatasetDTO
     )
 
     expect(actual).toBeUndefined()
 
     await expect(
-      deaccessionDataset.execute(createdDatasetIdentifiers.numericId, '1.0', testDeaccessionDataset)
+      deaccessionDataset.execute(
+        createdDatasetIdentifiers.numericId,
+        '1.0',
+        testDeaccessionDatasetDTO
+      )
     ).rejects.toThrow(Error)
 
     await deletePublishedDatasetViaApi(createdDatasetIdentifiers.persistentId)

test/integration/datasets/DatasetsRepository.test.ts

@@ -881,6 +881,10 @@ describe('DatasetsRepository', () => {
       const actual = await sut.deaccessionDataset(testDatasetIds.numericId, '1.0', deaccessionDTO)
 
       expect(actual).toBeUndefined()
+
+      const dataset = await sut.getDataset(testDatasetIds.numericId, '1.0', true, false)
+
+      expect(dataset.versionInfo.state).toBe('DEACCESSIONED')
     })
 
     test('should return error when dataset is deaccessioned', async () => {

test/testHelpers/datasets/datasetHelper.ts

@@ -10,9 +10,9 @@ import { DvObjectType } from '../../../src/core/domain/models/DvObjectOwnerNode'
 import TurndownService from 'turndown'
 import {
   DatasetDTO,
-  DatasetMetadataFieldValueDTO,
-  DatasetDeaccessionDTO
+  DatasetMetadataFieldValueDTO
 } from '../../../src/datasets/domain/dtos/DatasetDTO'
+import { DatasetDeaccessionDTO } from '../../../src/datasets/domain/dtos/DatasetDeaccessionDTO'
 import { MetadataBlock, MetadataFieldType } from '../../../src'
 import {
   NewDatasetRequestPayload,

test/unit/datasets/DatasetsRepository.test.ts

@@ -910,15 +910,15 @@ describe('DatasetsRepository', () => {
     const expectedApiKeyRequestConfig = {
       ...TestConstants.TEST_EXPECTED_AUTHENTICATED_REQUEST_CONFIG_API_KEY
     }
-    const testDeaccessionDataset = createDatasetDeaccessionDTO()
-    const testDeaccessionDatasetJSON = JSON.stringify(testDeaccessionDataset)
+    const testDeaccessionDatasetDTO = createDatasetDeaccessionDTO()
+    const testDeaccessionDatasetJSON = JSON.stringify(testDeaccessionDatasetDTO)
     test('should return nothing when providing id, version update type and response is successful', async () => {
       jest.spyOn(axios, 'post').mockResolvedValue(undefined)
 
       let actual = await sut.deaccessionDataset(
         testDatasetModel.id,
         version,
-        testDeaccessionDataset
+        testDeaccessionDatasetDTO
       )
 
       expect(axios.post).toHaveBeenCalledWith(
@@ -930,7 +930,7 @@ describe('DatasetsRepository', () => {
 
       ApiConfig.init(TestConstants.TEST_API_URL, DataverseApiAuthMechanism.SESSION_COOKIE)
 
-      actual = await sut.deaccessionDataset(testDatasetModel.id, version, testDeaccessionDataset)
+      actual = await sut.deaccessionDataset(testDatasetModel.id, version, testDeaccessionDatasetDTO)
 
       expect(axios.post).toHaveBeenCalledWith(
         expectedApiEndpoint,
@@ -945,7 +945,7 @@ describe('DatasetsRepository', () => {
 
       let error: WriteError | undefined = undefined
       await sut
-        .deaccessionDataset(testDatasetModel.id, version, testDeaccessionDataset)
+        .deaccessionDataset(testDatasetModel.id, version, testDeaccessionDatasetDTO)
         .catch((e) => (error = e))
 
       expect(axios.post).toHaveBeenCalledWith(