604 deaccession dataset

package.json

@@ -17,7 +17,7 @@
     "@dnd-kit/sortable": "8.0.0",
     "@dnd-kit/utilities": "3.2.2",
     "@faker-js/faker": "7.6.0",
-    "@iqss/dataverse-client-javascript": "2.0.0-alpha.26",
+    "@iqss/dataverse-client-javascript": "2.0.0-alpha.29",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",
@@ -50,7 +50,6 @@
     "react-toastify": "11.0.2",
     "react-topbar-progress-indicator": "4.1.1",
     "sass": "1.58.1",
-    "turndown": "7.2.0",
     "typescript": "5.7.2",
     "use-deep-compare": "1.2.1",
     "vite-plugin-istanbul": "4.0.1",

packages/design-system/src/lib/components/form/form-group/form-element/FormCheckbox.tsx

@@ -12,7 +12,7 @@ export interface FormCheckboxProps
 }
 
 export const FormCheckbox = React.forwardRef(function FormCheckbox(
-  { label, id, isValid, isInvalid, validFeedback, invalidFeedback, ...props }: FormCheckboxProps,
+  { label, id, isValid, isInvalid, ...props }: FormCheckboxProps,
   ref
 ) {
   return (
@@ -25,8 +25,6 @@ export const FormCheckbox = React.forwardRef(function FormCheckbox(
         {...props}
       />
       <FormBS.Check.Label>{label}</FormBS.Check.Label>
-      <FormBS.Control.Feedback type="invalid">{invalidFeedback}</FormBS.Control.Feedback>
-      <FormBS.Control.Feedback type="valid">{validFeedback}</FormBS.Control.Feedback>
     </FormBS.Check>
   )
 })

packages/design-system/tests/component/form/form-group/FormGroupCheckbox.spec.tsx

@@ -71,38 +71,6 @@ describe('FormCheckbox', () => {
     cy.findByText(tooltipMessage).should('be.visible')
   })
 
-  it('renders with invalid feedback', () => {
-    cy.mount(
-      <FormCheckboxGroup title="Checkbox">
-        <FormGroup.Checkbox
-          id="checkbox-1"
-          label={option1Label}
-          name={checkboxName}
-          isInvalid
-          invalidFeedback="Invalid feedback"
-        />
-      </FormCheckboxGroup>
-    )
-
-    cy.findByText('Invalid feedback').should('exist')
-  })
-
-  it('renders with valid feedback', () => {
-    cy.mount(
-      <FormCheckboxGroup title="Checkbox">
-        <FormGroup.Checkbox
-          id="checkbox-1"
-          label={option1Label}
-          name={checkboxName}
-          isValid
-          validFeedback="Valid feedback"
-        />
-      </FormCheckboxGroup>
-    )
-
-    cy.findByText('Valid feedback').should('exist')
-  })
-
   it('renders with invalid feedback as a group', () => {
     cy.mount(
       <FormCheckboxGroup title="Checkbox" isInvalid>

public/locales/en/dataset.json

@@ -181,5 +181,40 @@
     "majorVersion": "Major Release",
     "updateCurrentVersion": "Update Current Version (will permanently overwrite the latest published version)",
     "error": "An error occurred while publishing the dataset."
+  },
+  "deaccession": {
+    "warning": "This dataset will no longer be public and a tombstone will display the reason for deaccessioning. Please read the <anchor>documentation</anchor> if you have any questions.",
+    "version": {
+      "label": "Which version(s) do you want to deaccession?",
+      "validation": "Please select at least one version to deaccession."
+    },
+    "reason": {
+      "label": "What is the reason for Deaccession?",
+      "validation": "Please select a reason for deaccessioning this dataset.",
+      "options": {
+        "identifiable": "There is identifiable data in one or more files.",
+        "retracted": "The research article has been retracted.",
+        "transferred": "The dataset has been transferred to another repository.",
+        "irb": "IRB request.",
+        "legalIssue": "Legal issue or Data Usage Agreement.",
+        "invalid": "Not a valid dataset."
+      }
+    },
+    "reasonOther": {
+      "label": "Please enter additional information about the reason for deaccession."
+    },
+    "forwardUrl": {
+      "label": "If applicable, please provide the URL where this dataset can be accessed after deaccessioning.",
+      "validation": "Please enter a valid URL."
+    }
+  },
+  "confirmDeaccession": {
+    "title": "Confirm Deaccession",
+    "message": "Are you sure you want to deaccession? This is permanent and the selected version(s) will no longer be viewable by the public.",
+    "reason": "Reason for deaccessioning:",
+    "reasonOther": "Additional information about the reason for deaccession:",
+    "forwardUrl": "URL where this dataset can be accessed after deaccessioning:",
+    "cancelButton": "Cancel",
+    "deaccessionButton": "Deaccession"
   }
 }

public/locales/en/shared.json

@@ -2,6 +2,8 @@
   "asterisksIndicateRequiredFields": "Asterisks indicate required fields",
   "remove": "Remove",
   "add": "Add",
+  "yes": "Yes",
+  "no": "No",
   "cancel": "Cancel",
   "close": "Close",
   "continue": "Continue",

src/dataset/domain/models/Dataset.ts

@@ -1,6 +1,7 @@
 import { Alert, AlertMessageKey } from '../../../alert/domain/models/Alert'
 import { UpwardHierarchyNode } from '../../../shared/hierarchy/domain/models/UpwardHierarchyNode'
 import { FileDownloadSize } from '../../../files/domain/models/FileMetadata'
+import { DatasetVersionSummaryInfo } from '@/dataset/domain/models/DatasetVersionSummaryInfo'
 
 export enum DatasetLabelSemanticMeaning {
   DATASET = 'dataset',
@@ -419,7 +420,8 @@ export class Dataset {
     public readonly publicationDate?: string,
     public readonly nextMajorVersion?: string,
     public readonly nextMinorVersion?: string,
-    public readonly requiresMajorVersionUpdate?: boolean
+    public readonly requiresMajorVersionUpdate?: boolean,
+    public readonly versionsSummaries?: DatasetVersionSummaryInfo[]
   ) {}
 
   public checkIsLockedFromPublishing(userPersistentId: string): boolean {
@@ -512,7 +514,8 @@ export class Dataset {
       public readonly requestedVersion?: string,
       public readonly nextMajorVersionNumber?: string,
       public readonly nextMinorVersionNumber?: string,
-      public readonly requiresMajorVersionUpdate?: boolean
+      public readonly requiresMajorVersionUpdate?: boolean,
+      public readonly versionsSummaries?: DatasetVersionSummaryInfo[]
     ) {
       this.withAlerts()
     }
@@ -581,7 +584,8 @@ export class Dataset {
         undefined,
         this.nextMajorVersionNumber,
         this.nextMinorVersionNumber,
-        this.requiresMajorVersionUpdate
+        this.requiresMajorVersionUpdate,
+        this.versionsSummaries
       )
     }
   }

src/dataset/domain/models/DatasetVersionSummaryInfo.ts

@@ -0,0 +1,36 @@
+export interface DatasetVersionSummaryInfo {
+  id: number
+  versionNumber: string
+  summary?: DatasetVersionSummary | DatasetVersionSummaryStringValues
+  contributors: string
+  publishedOn?: string
+}
+
+export type DatasetVersionSummary = {
+  [key: string]: SummaryUpdates | SummaryUpdatesWithFields | FilesSummaryUpdates | boolean
+}
+
+interface SummaryUpdates {
+  added: number
+  deleted: number
+  changed: number
+}
+
+interface SummaryUpdatesWithFields {
+  [key: string]: SummaryUpdates
+}
+
+interface FilesSummaryUpdates {
+  added: number
+  removed: number
+  replaced: number
+  changedFileMetaData: number
+  changedVariableMetadata: number
+}
+
+export enum DatasetVersionSummaryStringValues {
+  firstPublished = 'firstPublished',
+  firstDraft = 'firstDraft',
+  versionDeaccessioned = 'versionDeaccessioned',
+  previousVersionDeaccessioned = 'previousVersionDeaccessioned'
+}

src/dataset/domain/repositories/DatasetRepository.ts

@@ -4,6 +4,7 @@ import { DatasetPaginationInfo } from '../models/DatasetPaginationInfo'
 import { DatasetDTO } from '../useCases/DTOs/DatasetDTO'
 import { DatasetsWithCount } from '../models/DatasetsWithCount'
 import { VersionUpdateType } from '../models/VersionUpdateType'
+import { DatasetDeaccessionDTO } from '../useCases/DTOs/DatasetDTO'
 
 export interface DatasetRepository {
   getByPersistentId: (
@@ -22,6 +23,12 @@ export interface DatasetRepository {
 
   create: (dataset: DatasetDTO, collectionId: string) => Promise<{ persistentId: string }>
   updateMetadata: (datasetId: string | number, datasetDTO: DatasetDTO) => Promise<void>
+  deaccession: (
+    datasetId: string | number,
+    version: string,
+    deaccessionDTO: DatasetDeaccessionDTO
+  ) => Promise<void>
+
   getAllWithCount: (
     collectionId: string,
     paginationInfo: DatasetPaginationInfo

src/dataset/domain/useCases/DTOs/DatasetDTO.ts

@@ -19,3 +19,8 @@ type DatasetMetadataFieldValueDTO =
   | DatasetMetadataChildFieldValueDTO[]
 
 export type DatasetMetadataChildFieldValueDTO = Record<string, string>
+
+export interface DatasetDeaccessionDTO {
+  deaccessionReason: string
+  deaccessionForwardURL?: string
+}

src/dataset/domain/useCases/deaccessionDataset.ts

@@ -0,0 +1,13 @@
+import { DatasetRepository } from '../repositories/DatasetRepository'
+import { DatasetDeaccessionDTO } from '@iqss/dataverse-client-javascript'
+
+export function deaccessionDataset(
+  datasetRepository: DatasetRepository,
+  datasetId: string | number,
+  version: string,
+  deaccessionDTO: DatasetDeaccessionDTO
+): Promise<void> {
+  return datasetRepository.deaccession(datasetId, version, deaccessionDTO).catch((error: Error) => {
+    throw new Error(error.message)
+  })
+}

src/dataset/infrastructure/mappers/JSDatasetMapper.ts

@@ -6,7 +6,8 @@ import {
   DatasetMetadataFields as JSDatasetMetadataFields,
   DatasetUserPermissions as JSDatasetPermissions,
   DatasetVersionDiff as JSDatasetVersionDiff,
-  DvObjectOwnerNode as JSUpwardHierarchyNode
+  DvObjectOwnerNode as JSUpwardHierarchyNode,
+  DatasetVersionSummaryInfo as JSDatasetVersionSummaryInfo
 } from '@iqss/dataverse-client-javascript'
 import { DatasetVersionDiff } from '../../domain/models/DatasetVersionDiff'
 import {
@@ -43,6 +44,7 @@ export class JSDatasetMapper {
     jsDatasetLocks: JSDatasetLock[],
     jsDatasetFilesTotalOriginalDownloadSize: number,
     jsDatasetFilesTotalArchivalDownloadSize: number,
+    jsDatasetVersionSummaries?: JSDatasetVersionSummaryInfo[],
     requestedVersion?: string,
     privateUrl?: PrivateUrl,
     latestPublishedVersionMajorNumber?: number,
@@ -92,7 +94,8 @@ export class JSDatasetMapper {
         latestPublishedVersionMajorNumber,
         latestPublishedVersionMinorNumber
       ),
-      JSDatasetMapper.toRequiresMajorVersionUpdate(datasetVersionDiff)
+      JSDatasetMapper.toRequiresMajorVersionUpdate(datasetVersionDiff),
+      jsDatasetVersionSummaries
     ).build()
   }
 

src/dataset/infrastructure/repositories/DatasetJSDataverseRepository.ts

@@ -12,6 +12,7 @@ import {
   DatasetVersionState,
   FileDownloadSizeMode,
   DatasetVersionDiff as JSDatasetVersionDiff,
+  DatasetVersionSummaryInfo as JSDatasetVersionSummaryInfo,
   getAllDatasetPreviews,
   getDataset,
   getDatasetCitation,
@@ -24,9 +25,12 @@ import {
   publishDataset,
   ReadError,
   updateDataset,
+  deaccessionDataset,
   VersionUpdateType as JSVersionUpdateType,
   WriteError,
-  getDatasetVersionDiff
+  getDatasetVersionDiff,
+  DatasetDeaccessionDTO,
+  getDatasetVersionsSummaries
 } from '@iqss/dataverse-client-javascript'
 import { JSDatasetMapper } from '../mappers/JSDatasetMapper'
 import { DatasetPaginationInfo } from '../../domain/models/DatasetPaginationInfo'
@@ -37,7 +41,6 @@ import { DatasetsWithCount } from '../../domain/models/DatasetsWithCount'
 import { VersionUpdateType } from '../../domain/models/VersionUpdateType'
 
 const includeDeaccessioned = true
-type DatasetDetails = [JSDataset, string[], string, JSDatasetPermissions, JSDatasetLock[]]
 
 interface IDatasetDetails {
   jsDataset: JSDataset
@@ -50,6 +53,7 @@ interface IDatasetDetails {
   latestPublishedVersionMajorNumber?: number
   latestPublishedVersionMinorNumber?: number
   datasetVersionDiff?: JSDatasetVersionDiff
+  jsDatasetVersionsSummaries: JSDatasetVersionSummaryInfo[]
 }
 
 export class DatasetJSDataverseRepository implements DatasetRepository {
@@ -116,25 +120,32 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
     version?: string
   ): Promise<IDatasetDetails> {
     return Promise.all([
-      jsDataset,
       getDatasetSummaryFieldNames.execute(),
       getDatasetCitation.execute(jsDataset.id, version, includeDeaccessioned),
       getDatasetUserPermissions.execute(jsDataset.id),
-      getDatasetLocks.execute(jsDataset.id)
+      getDatasetLocks.execute(jsDataset.id),
+      getDatasetVersionsSummaries.execute(jsDataset.id)
     ]).then(
       ([
-        jsDataset,
         summaryFieldsNames,
         citation,
         jsDatasetPermissions,
-        jsDatasetLocks
-      ]: DatasetDetails) => {
+        jsDatasetLocks,
+        jsDatasetVersionsSummaries
+      ]: [
+        string[],
+        string,
+        JSDatasetPermissions,
+        JSDatasetLock[],
+        JSDatasetVersionSummaryInfo[]
+      ]) => {
         return {
           jsDataset,
           summaryFieldsNames,
           citation,
           jsDatasetPermissions,
           jsDatasetLocks,
+          jsDatasetVersionsSummaries,
           jsDatasetFilesTotalOriginalDownloadSize: 0,
           jsDatasetFilesTotalArchivalDownloadSize: 0
         }
@@ -209,6 +220,7 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
           datasetDetails.jsDatasetLocks,
           datasetDetails.jsDatasetFilesTotalOriginalDownloadSize,
           datasetDetails.jsDatasetFilesTotalArchivalDownloadSize,
+          datasetDetails.jsDatasetVersionsSummaries,
           requestedVersion,
           undefined,
           datasetDetails.latestPublishedVersionMajorNumber,
@@ -303,9 +315,6 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
     return publishDataset.execute(persistentId, jsVersionUpdateType).catch((error: WriteError) => {
       throw new Error(error.message)
     })
-    return publishDataset.execute(persistentId, jsVersionUpdateType).catch((error: WriteError) => {
-      throw new Error(error.message)
-    })
   }
 
   updateMetadata(datasetId: string | number, updatedDataset: DatasetDTO): Promise<void> {
@@ -315,4 +324,15 @@ export class DatasetJSDataverseRepository implements DatasetRepository {
         throw new Error(error.message)
       })
   }
+  deaccession(
+    datasetId: string | number,
+    version: string,
+    deaccessionDTO: DatasetDeaccessionDTO
+  ): Promise<void> {
+    return deaccessionDataset
+      .execute(datasetId, version, deaccessionDTO)
+      .catch((error: WriteError) => {
+        throw new Error(error.message)
+      })
+  }
 }

src/sections/dataset/DatasetContext.ts

@@ -4,10 +4,12 @@ import { Dataset } from '../../dataset/domain/models/Dataset'
 interface DatasetContextProps {
   dataset: Dataset | undefined
   isLoading: boolean
+  refreshDataset: () => void
 }
 export const DatasetContext = createContext<DatasetContextProps>({
   dataset: undefined,
-  isLoading: false
+  isLoading: false,
+  refreshDataset: () => {}
 })
 
 export const useDataset = () => useContext(DatasetContext)