feat(DatasetActionButtons): add ChangeCurationStatusMenu component

Author: MellyGray

src/dataset/domain/models/Dataset.ts

@@ -1,5 +1,3 @@
-import exp from 'constants'
-
 export enum DatasetLabelSemanticMeaning {
   DATASET = 'dataset',
   FILE = 'file',

src/sections/dataset/dataset-action-buttons/AccessDatasetMenu.tsx

@@ -1,5 +1,4 @@
 import {
-  Dataset,
   DatasetPermissions,
   DatasetStatus,
   DatasetVersion

src/sections/dataset/dataset-action-buttons/ChangeCurationStatusMenu.tsx

@@ -0,0 +1,41 @@
+import {
+  DropdownButton,
+  DropdownButtonItem,
+  DropdownSeparator
+} from '@iqss/dataverse-design-system'
+import { useSettings } from '../../settings/SettingsContext'
+import { useEffect, useState } from 'react'
+import { SettingName } from '../../../settings/domain/models/Setting'
+import { AllowedExternalStatuses } from '../../../settings/domain/models/AllowedExternalStatuses'
+
+export function ChangeCurationStatusMenu() {
+  const { getSettingByName } = useSettings()
+  const [allowedExternalStatuses, setAllowedExternalStatuses] = useState<string[]>([])
+  useEffect(() => {
+    getSettingByName<AllowedExternalStatuses>(SettingName.ALLOWED_EXTERNAL_STATUSES)
+      .then((allowedExternalStatuses) => {
+        setAllowedExternalStatuses(allowedExternalStatuses.value)
+      })
+      .catch((error) => {
+        console.error(error)
+      })
+  }, [getSettingByName])
+
+  if (allowedExternalStatuses.length === 0) {
+    return <></>
+  }
+
+  return (
+    <DropdownButton
+      id={`change-curation-status-menu`}
+      title="Change Curation Status"
+      asButtonGroup
+      variant="secondary">
+      {allowedExternalStatuses.map((status) => (
+        <DropdownButtonItem key={status}>{status}</DropdownButtonItem>
+      ))}
+      <DropdownSeparator />
+      <DropdownButtonItem>Remove Current Status</DropdownButtonItem>
+    </DropdownButton>
+  )
+}

src/sections/dataset/dataset-action-buttons/PublishDatasetMenu.tsx

@@ -1,10 +1,6 @@
-import {
-  Dataset,
-  DatasetPermissions,
-  DatasetStatus,
-  DatasetVersion
-} from '../../../dataset/domain/models/Dataset'
+import { Dataset, DatasetStatus } from '../../../dataset/domain/models/Dataset'
 import { DropdownButton, DropdownButtonItem } from '@iqss/dataverse-design-system'
+import { ChangeCurationStatusMenu } from './ChangeCurationStatusMenu'
 
 interface PublishDatasetMenuProps {
   dataset: Dataset
@@ -27,6 +23,7 @@ export function PublishDatasetMenu({ dataset }: PublishDatasetMenuProps) {
       variant="secondary"
       disabled={dataset.isLockedFromPublishing}>
       <DropdownButtonItem>Publish</DropdownButtonItem>
+      <ChangeCurationStatusMenu />
     </DropdownButton>
   )
 }

src/settings/domain/models/AllowedExternalStatuses.ts

@@ -0,0 +1 @@
+export type AllowedExternalStatuses = string[]

src/settings/domain/models/Setting.ts

@@ -1,5 +1,6 @@
 export enum SettingName {
-  ZIP_DOWNLOAD_LIMIT = 'ZIP_DOWNLOAD_LIMIT'
+  ZIP_DOWNLOAD_LIMIT = 'ZIP_DOWNLOAD_LIMIT',
+  ALLOWED_EXTERNAL_STATUSES = 'ALLOWED_EXTERNAL_STATUSES'
 }
 
 export interface Setting<T> {

tests/component/sections/dataset/dataset-action-buttons/ChangeCurationStatusMenu.spec.tsx

@@ -0,0 +1,35 @@
+import { ChangeCurationStatusMenu } from '../../../../../src/sections/dataset/dataset-action-buttons/ChangeCurationStatusMenu'
+
+import { SettingMother } from '../../../settings/domain/models/SettingMother'
+import { SettingsProvider } from '../../../../../src/sections/settings/SettingsProvider'
+import { SettingRepository } from '../../../../../src/settings/domain/repositories/SettingRepository'
+
+describe('ChangeCurationStatusMenu', () => {
+  it('renders the ChangeCurationStatusMenu if external statuses are allowed and the user has update dataset permissions', () => {
+    const settingRepository = {} as SettingRepository
+    settingRepository.getByName = cy
+      .stub()
+      .resolves(SettingMother.createExternalStatusesAllowed(['Author Contacted', 'Privacy Review']))
+
+    cy.customMount(
+      <SettingsProvider repository={settingRepository}>
+        <ChangeCurationStatusMenu />
+      </SettingsProvider>
+    )
+
+    cy.findByRole('button', { name: 'Change Curation Status' })
+      .should('exist')
+      .should('be.enabled')
+      .click()
+
+    cy.findByRole('button', { name: 'Author Contacted' }).should('exist')
+    cy.findByRole('button', { name: 'Privacy Review' }).should('exist')
+    cy.findByRole('button', { name: 'Remove Current Status' }).should('exist')
+  })
+
+  it('does not render the ChangeCurationStatusMenu if external statuses are not allowed', () => {
+    cy.customMount(<ChangeCurationStatusMenu />)
+
+    cy.findByRole('button', { name: 'Change Curation Status' }).should('not.exist')
+  })
+})

tests/component/sections/dataset/dataset-action-buttons/PublishDatasetMenu.spec.tsx

@@ -5,6 +5,9 @@ import {
   DatasetVersionMother
 } from '../../../dataset/domain/models/DatasetMother'
 import { DatasetLockReason } from '../../../../../src/dataset/domain/models/Dataset'
+import { SettingRepository } from '../../../../../src/settings/domain/repositories/SettingRepository'
+import { SettingMother } from '../../../settings/domain/models/SettingMother'
+import { SettingsProvider } from '../../../../../src/sections/settings/SettingsProvider'
 
 describe('PublishDatasetMenu', () => {
   it('renders the PublishDatasetMenu if is dataset latest version and it is a draft and publishing is allowed', () => {
@@ -16,7 +19,35 @@ describe('PublishDatasetMenu', () => {
 
     cy.customMount(<PublishDatasetMenu dataset={dataset} />)
 
-    cy.findByRole('button', { name: 'Publish Dataset' }).should('exist').should('be.enabled')
+    cy.findByRole('button', { name: 'Publish Dataset' })
+      .should('exist')
+      .should('be.enabled')
+      .click()
+
+    cy.findByRole('button', { name: 'Publish' }).should('exist')
+  })
+
+  it('renders the PublishDatasetMenu with the Change Curation Status sub menu', () => {
+    const dataset = DatasetMother.create({
+      version: DatasetVersionMother.createDraftAsLatestVersion(),
+      permissions: DatasetPermissionsMother.createWithPublishingDatasetAllowed(),
+      locks: []
+    })
+
+    const settingRepository = {} as SettingRepository
+    settingRepository.getByName = cy
+      .stub()
+      .resolves(SettingMother.createExternalStatusesAllowed(['Author Contacted', 'Privacy Review']))
+
+    cy.customMount(
+      <SettingsProvider repository={settingRepository}>
+        <PublishDatasetMenu dataset={dataset} />
+      </SettingsProvider>
+    )
+
+    cy.findByRole('button', { name: 'Publish Dataset' }).click()
+
+    cy.findByRole('button', { name: 'Change Curation Status' }).should('exist')
   })
 
   it('does not render the PublishDatasetMenu if publishing is not allowed', () => {

tests/component/settings/domain/models/SettingMother.ts

@@ -15,4 +15,11 @@ export class SettingMother {
           )
     }
   }
+
+  static createExternalStatusesAllowed(value?: string[]): Setting<string[]> {
+    return {
+      name: SettingName.ALLOWED_EXTERNAL_STATUSES,
+      value: value ? value : [faker.datatype.string(), faker.datatype.string()]
+    }
+  }
 }