External tools require terms or guestbook response if applicable

CHANGELOG.md

@@ -19,6 +19,8 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 
 ### Fixed
 
+- Edit Dataset Terms: navigate to the draft version of the dataset after saving changes to the terms, instead of the latest published version.
+
 ### Removed
 
 ---

public/locales/en/file.json

@@ -160,6 +160,8 @@
   "getCategoriesError": "Something went wrong fetching available categories. Try again later.",
   "previewTab": {
     "openInNewWindow": "Open in New Window",
-    "defaultLoadingToolError": "Something went wrong loading the external tool. Try again later."
+    "defaultLoadingToolError": "Something went wrong loading the external tool. Try again later.",
+    "acceptTermsAndGuestbooks": "Accept the dataset terms or guestbooks",
+    "termsRequired": "before previewing this file."
   }
 }

public/locales/es/file.json

@@ -160,6 +160,8 @@
   "getCategoriesError": "Algo salió mal al obtener las categorías disponibles. Intenta nuevamente más tarde.",
   "previewTab": {
     "openInNewWindow": "Abrir en una nueva ventana",
-    "defaultLoadingToolError": "Algo salió mal al cargar la herramienta externa. Intenta nuevamente más tarde."
+    "defaultLoadingToolError": "Algo salió mal al cargar la herramienta externa. Intenta nuevamente más tarde.",
+    "acceptTermsAndGuestbooks": "Acepta los términos del dataset o guestbooks",
+    "termsRequired": "antes de previsualizar este fichero."
   }
 }

src/sections/dataset/dataset-files/files-table/file-actions/file-actions-cell/file-action-buttons/file-options-menu/DownloadWithTermsAndGuestbookModal.tsx

@@ -31,6 +31,7 @@ interface DownloadWithTermsAndGuestbookModalProps {
   datasetCustomTerms?: CustomTermsModel
   show: boolean
   handleClose: () => void
+  onAccept?: () => void
 }
 
 type GuestbookFormValues = Record<string, string>
@@ -44,7 +45,8 @@ export function DownloadWithTermsAndGuestbookModal({
   datasetLicense,
   datasetCustomTerms,
   show,
-  handleClose
+  handleClose,
+  onAccept
 }: DownloadWithTermsAndGuestbookModalProps) {
   const { t: tFiles } = useTranslation('files')
   const { t: tDataset } = useTranslation('dataset')
@@ -226,7 +228,8 @@ export function DownloadWithTermsAndGuestbookModal({
     format,
     handleClose,
     accessRepository,
-    downloadFromSignedUrl
+    downloadFromSignedUrl,
+    onSubmitSuccess: onAccept
   })
 
   useEffect(() => {

src/sections/dataset/dataset-files/files-table/file-actions/file-actions-cell/file-action-buttons/file-options-menu/useGuestbookCollectSubmission.ts

@@ -20,6 +20,7 @@ interface UseGuestbookCollectSubmissionProps {
   handleClose: () => void
   accessRepository: AccessRepository
   downloadFromSignedUrl: (signedUrl: string) => Promise<void>
+  onSubmitSuccess?: () => void
 }
 
 interface HandleSubmitProps {
@@ -34,7 +35,8 @@ export const useGuestbookCollectSubmission = ({
   format,
   handleClose,
   accessRepository,
-  downloadFromSignedUrl
+  downloadFromSignedUrl,
+  onSubmitSuccess
 }: UseGuestbookCollectSubmissionProps) => {
   const { t: tFiles } = useTranslation('files')
   const [hasAttemptedAccept, setHasAttemptedAccept] = useState(false)
@@ -108,6 +110,12 @@ export const useGuestbookCollectSubmission = ({
         setIsSubmittingGuestbook(false)
       }
 
+      if (signedUrl && onSubmitSuccess) {
+        handleModalClose()
+        onSubmitSuccess()
+        return
+      }
+
       if (signedUrl) {
         void downloadFromSignedUrl(signedUrl)
           .then(() => {
@@ -132,6 +140,7 @@ export const useGuestbookCollectSubmission = ({
       fileIds,
       format,
       handleModalClose,
+      onSubmitSuccess,
       tFiles
     ]
   )

src/sections/edit-dataset-terms/datasetTermsNavigation.ts

@@ -0,0 +1,27 @@
+import {
+  Dataset,
+  DatasetNonNumericVersionSearchParam,
+  DatasetPublishingStatus
+} from '@/dataset/domain/models/Dataset'
+import { QueryParamKey, Route } from '@/sections/Route.enum'
+
+export const buildDatasetTermsReturnUrl = (dataset: Dataset): string => {
+  const searchParams = new URLSearchParams()
+  searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+
+  if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
+    searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
+  } else {
+    searchParams.set(QueryParamKey.VERSION, dataset.version.number.toString())
+  }
+
+  return `${Route.DATASETS}?${searchParams.toString()}`
+}
+
+export const buildDatasetDraftReturnUrl = (dataset: Dataset): string => {
+  const searchParams = new URLSearchParams()
+  searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+  searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
+
+  return `${Route.DATASETS}?${searchParams.toString()}`
+}

src/sections/edit-dataset-terms/edit-guestbook/EditGuestbook.tsx

@@ -4,16 +4,12 @@ import { Trans, useTranslation } from 'react-i18next'
 import { useNavigate } from 'react-router-dom'
 import { toast } from 'react-toastify'
 import { Guestbook } from '@/guestbooks/domain/models/Guestbook'
-import {
-  DatasetNonNumericVersionSearchParam,
-  DatasetPublishingStatus
-} from '@/dataset/domain/models/Dataset'
 import { useGetGuestbooksByCollectionId } from '@/sections/guestbooks/useGetGuestbooksByCollectionId'
-import { QueryParamKey, Route } from '@/sections/Route.enum'
 import { useAssignDatasetGuestbook } from './useAssignDatasetGuestbook'
 import { useRemoveDatasetGuestbook } from './useRemoveDatasetGuestbook'
 import { useDataset } from '../../dataset/DatasetContext'
 import { PreviewGuestbookModal } from '@/sections/guestbooks/preview-modal/PreviewGuestbookModal'
+import { buildDatasetDraftReturnUrl, buildDatasetTermsReturnUrl } from '../datasetTermsNavigation'
 import { useGuestbookRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
 import styles from './EditGuestbook.module.scss'
 
@@ -36,16 +32,13 @@ export function EditGuestbook({ onPreview, onFormStateChange }: EditGuestbookPro
   const navigateToDatasetView = useCallback(() => {
     if (!dataset) return
 
-    const searchParams = new URLSearchParams()
-    searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+    navigate(buildDatasetTermsReturnUrl(dataset))
+  }, [dataset, navigate])
 
-    if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
-      searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
-    } else {
-      searchParams.set(QueryParamKey.VERSION, dataset.version.number.toString())
-    }
+  const navigateToDatasetDraftView = useCallback(() => {
+    if (!dataset) return
 
-    navigate(`${Route.DATASETS}?${searchParams.toString()}`)
+    navigate(buildDatasetDraftReturnUrl(dataset))
   }, [dataset, navigate])
 
   const handleCancel = () => {
@@ -66,7 +59,7 @@ export function EditGuestbook({ onPreview, onFormStateChange }: EditGuestbookPro
     onSuccessfulAssignDatasetGuestbook: () => {
       toast.success(t('alerts.termsUpdated.alertText'))
       refreshDataset()
-      navigateToDatasetView()
+      navigateToDatasetDraftView()
     }
   })
   const {
@@ -78,7 +71,7 @@ export function EditGuestbook({ onPreview, onFormStateChange }: EditGuestbookPro
     onSuccessfulRemoveDatasetGuestbook: () => {
       toast.success(t('alerts.termsUpdated.alertText'))
       refreshDataset()
-      navigateToDatasetView()
+      navigateToDatasetDraftView()
     }
   })
 

src/sections/edit-dataset-terms/edit-license-and-terms/EditLicenseAndTerms.tsx

@@ -9,11 +9,7 @@ import { LicenseRepository } from '../../../licenses/domain/repositories/License
 import { useGetLicenses } from './useGetLicenses'
 import { useDataset } from '../../dataset/DatasetContext'
 import { useUpdateDatasetLicense } from './useUpdateDatasetLicense'
-import { Route, QueryParamKey } from '../../Route.enum'
-import {
-  DatasetNonNumericVersionSearchParam,
-  DatasetPublishingStatus
-} from '../../../dataset/domain/models/Dataset'
+import { buildDatasetDraftReturnUrl, buildDatasetTermsReturnUrl } from '../datasetTermsNavigation'
 import { useDatasetRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
 import styles from './EditLicenseAndTerms.module.scss'
 
@@ -49,24 +45,21 @@ export function EditLicenseAndTerms({
   const navigateToDatasetView = useCallback(() => {
     if (!dataset) return
 
-    const searchParams = new URLSearchParams()
-    searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
+    navigate(buildDatasetTermsReturnUrl(dataset))
+  }, [dataset, navigate])
 
-    if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
-      searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
-    } else {
-      searchParams.set(QueryParamKey.VERSION, dataset.version.number.toString())
-    }
+  const navigateToDatasetDraftView = useCallback(() => {
+    if (!dataset) return
 
-    navigate(`${Route.DATASETS}?${searchParams.toString()}`)
+    navigate(buildDatasetDraftReturnUrl(dataset))
   }, [dataset, navigate])
 
   const { handleUpdateLicense, isLoading, error } = useUpdateDatasetLicense({
     datasetRepository,
     onSuccessfulUpdateLicense: () => {
       toast.success(t('alerts.licenseUpdated.alertText'))
       refreshDataset()
-      navigateToDatasetView()
+      navigateToDatasetDraftView()
     }
   })
 

src/sections/edit-dataset-terms/edit-terms-of-access/EditTermsOfAccess.tsx

@@ -1,18 +1,14 @@
-import { useEffect, useMemo, useRef } from 'react'
+import { useCallback, useEffect, useMemo, useRef } from 'react'
 import { useTranslation } from 'react-i18next'
 import { useForm, Controller, FormProvider, useWatch } from 'react-hook-form'
 import { toast } from 'react-toastify'
 import { Form, Row, Col, Button, Alert } from '@iqss/dataverse-design-system'
 import styles from '../edit-license-and-terms/EditLicenseAndTerms.module.scss'
-import {
-  DatasetNonNumericVersionSearchParam,
-  DatasetPublishingStatus,
-  TermsOfAccess
-} from '@/dataset/domain/models/Dataset'
+import { TermsOfAccess } from '@/dataset/domain/models/Dataset'
 import { useDataset } from '../../dataset/DatasetContext'
 import { useUpdateTermsOfAccess } from './useUpdateTermsOfAccess'
-import { QueryParamKey, Route } from '@/sections/Route.enum'
 import { useNavigate } from 'react-router-dom'
+import { buildDatasetDraftReturnUrl, buildDatasetTermsReturnUrl } from '../datasetTermsNavigation'
 import { useDatasetRepositories } from '@/shared/contexts/repositories/RepositoriesProvider'
 
 interface EditTermsOfAccessProps {
@@ -40,12 +36,18 @@ export function EditTermsOfAccess({ onFormStateChange }: EditTermsOfAccessProps)
   const initialTermsOfAccess =
     (dataset?.termsOfUse.termsOfAccess as TermsOfAccess) ?? defaultTermsOfAccess
   const formContainerRef = useRef<HTMLDivElement>(null)
+  const navigateToDatasetDraftView = useCallback(() => {
+    if (!dataset) return
+
+    navigate(buildDatasetDraftReturnUrl(dataset))
+  }, [dataset, navigate])
 
   const { handleUpdateTermsOfAccess, isLoading, error } = useUpdateTermsOfAccess({
     datasetRepository,
     onSuccessfulUpdateTermsOfAccess: () => {
       toast.success(t('alerts.termsUpdated.alertText'))
       refreshDataset()
+      navigateToDatasetDraftView()
     }
   })
 
@@ -119,16 +121,7 @@ export function EditTermsOfAccess({ onFormStateChange }: EditTermsOfAccessProps)
   const handleCancel = () => {
     if (!dataset) return
 
-    const searchParams = new URLSearchParams()
-    searchParams.set(QueryParamKey.PERSISTENT_ID, dataset.persistentId)
-
-    if (dataset.version.publishingStatus === DatasetPublishingStatus.DRAFT) {
-      searchParams.set(QueryParamKey.VERSION, DatasetNonNumericVersionSearchParam.DRAFT)
-    } else {
-      searchParams.set(QueryParamKey.VERSION, dataset.version.number.toString())
-    }
-
-    navigate(`${Route.DATASETS}?${searchParams.toString()}`)
+    navigate(buildDatasetTermsReturnUrl(dataset))
   }
 
   return (

src/sections/file/file-action-buttons/access-file-menu/FileToolOptions.tsx

@@ -54,7 +54,7 @@ const FileToolOptions = ({ fileId, fileType, kind }: FileToolOptionsProps) => {
         <Icon />
       </DropdownHeader>
 
-      {tools.map((tool) => (
+      {applicableTools.map((tool) => (
         <ToolOption
           key={tool.id}
           toolId={tool.id}