586 dataset terms tab

merged-coverage/lcov.info

@@ -2412,7 +2412,7 @@ DA:17,201
 DA:26,16
 BRDA:1,0,0,16
 end_of_record
-SF:src/sections/dataset/dataset-summary/License.tsx
+SF:src/sections/dataset/dataset-summary/SummaryLicense.tsx
 DA:9,332
 DA:10,332
 DA:12,327

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.16",
+    "@iqss/dataverse-client-javascript": "2.0.0-alpha.20",
     "@iqss/dataverse-design-system": "*",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
     "@tanstack/react-table": "8.9.2",

packages/design-system/src/lib/components/tabs/Tabs.tsx

@@ -4,12 +4,15 @@ import { Tabs as TabsBS } from 'react-bootstrap'
 
 interface TabsProps {
   defaultActiveKey: string
+  onSelect?: (key: string | null) => void
 }
 
-function Tabs({ defaultActiveKey, children }: PropsWithChildren<TabsProps>) {
-  return <TabsBS defaultActiveKey={defaultActiveKey}>{children}</TabsBS>
+function Tabs({ defaultActiveKey, onSelect, children }: PropsWithChildren<TabsProps>) {
+  return (
+    <TabsBS onSelect={onSelect} activeKey={defaultActiveKey}>
+      {children}
+    </TabsBS>
+  )
 }
-
 Tabs.Tab = Tab
-
 export { Tabs }

public/locales/en/dataset.json

@@ -1,7 +1,12 @@
 {
   "filesTabTitle": "Files",
   "metadataTabTitle": "Metadata",
+  "termsTabTitle": "Terms",
   "anonymizedFieldValue": "withheld",
+  "customTerms": {
+    "title": "Custom Dataset Terms",
+    "description": "The following custom terms have been defined for this dataset."
+  },
   "license": {
     "title": "License/Data Use Agreement",
     "altTextPrefix": "License image for "
@@ -116,6 +121,50 @@
       "alertText": "This unpublished dataset is being privately shared."
     }
   },
+  "termsTab": {
+    "editTermsButton": "Edit Term Requirements",
+    "licenseTitle": "Dataset Terms",
+    "termsTitle": "Restricted Files + Terms of Access",
+    "licenseHelpText": "Our <anchor>Community Norms</anchor> as well as good scientific practices expect that proper credit is given via citation. Please use the data citation shown on the dataset page.",
+    "restrictedFiles": "Restricted Files",
+    "termsOfAccess": "Terms of Access for Restricted Files",
+    "requestAccess": "Request Access",
+    "dataAccessPlace": "Data Access Place",
+    "originalArchive": "Original Archive",
+    "availabilityStatus": "Availability Status",
+    "contactForAccess": "Contact for Access",
+    "sizeOfCollection": "Size of Collection",
+    "studyCompletion": "Study Completion",
+    "termsOfUse": "Terms of Use",
+    "termsOfUseTip": "The terms of use for this dataset.",
+    "confidentialityDeclaration": "Confidentiality Declaration",
+    "specialPermissions": "Special Permissions",
+    "restrictions": "Restrictions",
+    "citationRequirements": "Citation Requirements",
+    "depositorRequirements": "Depositor Requirements",
+    "conditions": "Conditions",
+    "disclaimer": "Disclaimer",
+    "confidentialityDeclarationTip": "Indicates whether signing of a confidentiality declaration is needed to access a resource.",
+    "specialPermissionsTip": "Determine if any special permissions are required to access a resource (e.g., if form is a needed and where to access the form).",
+    "restrictionsTip": "Any restrictions on access to or use of the collection, such as privacy certification or distribution restrictions, should be indicated here. These can be restrictions applied by the author, producer, or disseminator of the data collection. If the data are restricted to only a certain class of user, specify which type.",
+    "citationRequirementsTip": "Include special/explicit citation requirements for data to be cited properly in articles or other publications that are based on analysis of the data. For standard data citation requirements refer to our Community Norms.",
+    "depositorRequirementsTip": "Information regarding user responsibility for informing Dataset Depositors, Authors or Curators of their use of data through providing citations to the published work or providing copies of the manuscripts.",
+    "conditionsTip": "Any additional information that will assist the user in understanding the access and use conditions of the Dataset.",
+    "disclaimerTip": "Information regarding responsibility for uses of the Dataset.",
+    "restrictedFilesOne": "There is 1 restricted file in this dataset.",
+    "restrictedFilesMany": "There are {{count}} restricted files in this dataset.",
+    "termsOfAccessTip": "Information on how and if users can access restricted files in this Dataset",
+    "requestAccessTip": "If checked, users can request access to the restricted files in this dataset.",
+    "requestAccessTrue": "Users may request access to files.",
+    "requestAccessFalse": "Users may not request access to files.",
+    "restrictedFilesTip": "The number of restricted files in this dataset.",
+    "dataAccessPlaceTip": "If the data is not only in Dataverse, list the location(s) where the data are currently stored.",
+    "originalArchiveTip": "Archive from which the data was obtained.",
+    "availabilityStatusTip": "Statement of Dataset availability. A depositor may need to indicate that a Dataset is unavailable because it is embargoed for a period of time, because it has been superseded, because a new edition is imminent, etc.",
+    "contactForAccessTip": "If different from the Dataset Contact, this is the Contact person or organization (include email or full address, and telephone number if available) that controls access to a collection.",
+    "sizeOfCollectionTip": "Summary of the number of physical files that exist in a Dataset, recording the number of files that contain data and noting whether the collection contains machine readable documentation and/or other supplementary files and information, such as code, data dictionaries, data definition statements, or data collection instruments.",
+    "studyCompletionTip": "Relationship of the data collected to the amount of data coded and stored in the Dataset. Information as to why certain items of collected information were not included in the dataset or a specific data file should be provided."
+  },
   "publish": {
     "draftQuestion": "Are you sure you want to publish this dataset? Once you do so, it must remain published.",
     "draftSubtext": "This version of the dataset will be published with the following terms:",

src/collection/domain/useCases/DTOs/CollectionDTO.ts

@@ -10,6 +10,8 @@ export interface CollectionDTO {
   metadataBlockNames?: string[]
   facetIds?: string[]
   inputLevels?: CollectionInputLevelDTO[]
+  inheritMetadataBlocksFromParent: boolean
+  inheritFacetsFromParent: boolean
 }
 
 export interface CollectionInputLevelDTO {

src/dataset/domain/models/Dataset.ts

@@ -368,13 +368,39 @@ export interface DatasetDownloadUrls {
   archival: string
 }
 
+export interface TermsOfAccess {
+  fileAccessRequest: boolean
+  termsOfAccessForRestrictedFiles?: string
+  dataAccessPlace?: string
+  originalArchive?: string
+  availabilityStatus?: string
+  contactForAccess?: string
+  sizeOfCollection?: string
+  studyCompletion?: string
+}
+
+export interface CustomTerms {
+  termsOfUse: string
+  confidentialityDeclaration?: string
+  specialPermissions?: string
+  restrictions?: string
+  citationRequirements?: string
+  depositorRequirements?: string
+  conditions?: string
+  disclaimer?: string
+}
+export interface DatasetTermsOfUse {
+  termsOfAccess: TermsOfAccess
+  customTerms?: CustomTerms
+}
+
 export class Dataset {
   constructor(
     public readonly persistentId: string,
     public readonly version: DatasetVersion,
     public readonly alerts: Alert[],
     public readonly summaryFields: DatasetMetadataBlock[],
-    public readonly license: DatasetLicense,
+    public readonly termsOfUse: DatasetTermsOfUse,
     public readonly metadataBlocks: DatasetMetadataBlocks,
     public readonly permissions: DatasetPermissions,
     public readonly locks: DatasetLock[],
@@ -384,6 +410,7 @@ export class Dataset {
     public readonly downloadUrls: DatasetDownloadUrls,
     public readonly fileDownloadSizes: FileDownloadSize[],
     public readonly hierarchy: UpwardHierarchyNode,
+    public readonly license?: DatasetLicense,
     public readonly thumbnail?: string,
     public readonly privateUrl?: PrivateUrl, // will be set if the user requested a version that did not exist
     public readonly requestedVersion?: string,
@@ -466,7 +493,7 @@ export class Dataset {
       public readonly persistentId: string,
       public readonly version: DatasetVersion,
       public readonly summaryFields: DatasetMetadataBlock[],
-      public readonly license: DatasetLicense = defaultLicense,
+      public readonly termsOfUse: DatasetTermsOfUse,
       public readonly metadataBlocks: DatasetMetadataBlocks,
       public readonly permissions: DatasetPermissions,
       public readonly locks: DatasetLock[],
@@ -476,6 +503,7 @@ export class Dataset {
       public readonly downloadUrls: DatasetDownloadUrls,
       public readonly fileDownloadSizes: FileDownloadSize[],
       public readonly hierarchy: UpwardHierarchyNode,
+      public readonly license?: DatasetLicense,
       public readonly thumbnail?: string,
       public readonly privateUrl?: PrivateUrl, // will be set if the user requested a version that did not exist
 
@@ -534,7 +562,7 @@ export class Dataset {
         this.version,
         this.alerts,
         this.summaryFields,
-        this.license,
+        this.termsOfUse,
         this.metadataBlocks,
         this.permissions,
         this.locks,
@@ -544,6 +572,7 @@ export class Dataset {
         this.downloadUrls,
         this.fileDownloadSizes,
         this.hierarchy,
+        this.license,
         this.thumbnail,
         this.privateUrl,
         this.requestedVersion,

src/dataset/infrastructure/mappers/JSDatasetMapper.ts

@@ -60,7 +60,7 @@ export class JSDatasetMapper {
       jsDataset.persistentId,
       version,
       JSDatasetMapper.toSummaryFields(jsDataset.metadataBlocks, jsDatasetSummaryFieldsNames),
-      jsDataset.license,
+      jsDataset.termsOfUse,
       JSDatasetMapper.toMetadataBlocks(
         jsDataset.metadataBlocks,
         jsDataset.alternativePersistentId,
@@ -83,6 +83,7 @@ export class JSDatasetMapper {
         version,
         jsDataset.isPartOf
       ),
+      jsDataset.license,
       undefined, // TODO: get dataset thumbnail from js-dataverse https://github.com/IQSS/dataverse-frontend/issues/203
       privateUrl,
       requestedVersion,

src/sections/Route.enum.ts

@@ -30,5 +30,6 @@ export enum QueryParamKey {
   VERSION = 'version',
   PERSISTENT_ID = 'persistentId',
   PAGE = 'page',
-  COLLECTION_ID = 'collectionId'
+  COLLECTION_ID = 'collectionId',
+  TAB = 'tab'
 }

src/sections/dataset/Dataset.tsx

@@ -1,7 +1,7 @@
-import { useEffect } from 'react'
+import { useRef, useEffect, useState } from 'react'
 import { Col, Row, Tabs } from '@iqss/dataverse-design-system'
 import styles from './Dataset.module.scss'
-import { useNavigate } from 'react-router-dom'
+import { useNavigate, useSearchParams } from 'react-router-dom'
 import { DatasetLabels } from './dataset-labels/DatasetLabels'
 import { useLoading } from '../loading/LoadingContext'
 import { DatasetSkeleton, TabsSkeleton } from './DatasetSkeleton'
@@ -26,6 +26,7 @@ import useUpdateDatasetAlerts from './useUpdateDatasetAlerts'
 import { QueryParamKey, Route } from '../Route.enum'
 import { MetadataBlockInfoRepository } from '../../metadata-block-info/domain/repositories/MetadataBlockInfoRepository'
 import { CollectionRepository } from '../../collection/domain/repositories/CollectionRepository'
+import { DatasetTerms } from '@/sections/dataset/dataset-terms/DatasetTerms'
 
 interface DatasetProps {
   datasetRepository: DatasetRepository
@@ -36,6 +37,7 @@ interface DatasetProps {
   metadataUpdated?: boolean
   filesTabInfiniteScrollEnabled?: boolean
   publishInProgress?: boolean
+  tab?: string
 }
 
 export function Dataset({
@@ -46,14 +48,18 @@ export function Dataset({
   created,
   metadataUpdated,
   filesTabInfiniteScrollEnabled,
-  publishInProgress
+  publishInProgress,
+  tab = 'files'
 }: DatasetProps) {
   const { setIsLoading } = useLoading()
   const { dataset, isLoading: isDatasetLoading } = useDataset()
   const { t } = useTranslation('dataset')
   const navigate = useNavigate()
+  const [searchParams] = useSearchParams()
   const { hideModal, isModalOpen } = useNotImplementedModal()
   const publishCompleted = useCheckPublishCompleted(publishInProgress, dataset, datasetRepository)
+  const [activeTab, setActiveTab] = useState<string>(tab)
+  const termsTabRef = useRef<HTMLDivElement>(null)
 
   useUpdateDatasetAlerts({
     dataset,
@@ -78,7 +84,20 @@ export function Dataset({
   if (isDatasetLoading && !dataset) {
     return <DatasetSkeleton />
   }
+  const handleCustomTermsClick = () => {
+    setActiveTab('terms')
+    const newParams = new URLSearchParams(searchParams)
+    newParams.set('tab', 'terms')
+    // Update URL without reloading
+    navigate(`?${newParams.toString()}`, { replace: true })
+    termsTabRef.current?.scrollIntoView({ behavior: 'smooth' })
+  }
 
+  const handleTabSelect = (key: string | null) => {
+    if (key) {
+      setActiveTab(key)
+    }
+  }
   return (
     <>
       <NotImplementedModal show={isModalOpen} handleClose={hideModal} />
@@ -118,14 +137,15 @@ export function Dataset({
                   <DatasetSummary
                     summaryFields={dataset.summaryFields}
                     license={dataset.license}
+                    onCustomTermsClick={handleCustomTermsClick}
                     metadataBlockInfoRepository={metadataBlockInfoRepository}
                   />
                 </Col>
               </Row>
               {publishInProgress && <TabsSkeleton />}
 
               {(!publishInProgress || !isDatasetLoading) && (
-                <Tabs defaultActiveKey="files">
+                <Tabs defaultActiveKey={activeTab} onSelect={handleTabSelect}>
                   <Tabs.Tab eventKey="files" title={t('filesTabTitle')}>
                     <div className={styles['tab-container']}>
                       {filesTabInfiniteScrollEnabled ? (
@@ -152,6 +172,17 @@ export function Dataset({
                       />
                     </div>
                   </Tabs.Tab>
+                  <Tabs.Tab title={t('termsTabTitle')} eventKey={'terms'}>
+                    <div ref={termsTabRef} className={styles['tab-container']}>
+                      <DatasetTerms
+                        license={dataset.license}
+                        termsOfUse={dataset.termsOfUse}
+                        filesRepository={fileRepository}
+                        datasetPersistentId={dataset.persistentId}
+                        datasetVersion={dataset.version}
+                      />
+                    </div>
+                  </Tabs.Tab>
                 </Tabs>
               )}
               <SeparationLine />

src/sections/dataset/DatasetFactory.tsx

@@ -48,6 +48,7 @@ function DatasetWithSearchParams() {
   const persistentId = searchParams.get('persistentId') ?? undefined
   const privateUrlToken = searchParams.get('privateUrlToken')
   const searchParamVersion = searchParams.get('version') ?? undefined
+  const tab = searchParams.get('tab') ?? undefined
   const version = searchParamVersionToDomainVersion(searchParamVersion)
   const location = useLocation()
   const state = location.state as
@@ -73,6 +74,7 @@ function DatasetWithSearchParams() {
           fileRepository={fileRepository}
           metadataBlockInfoRepository={metadataBlockInfoRepository}
           filesTabInfiniteScrollEnabled={FILES_TAB_INFINITE_SCROLL_ENABLED}
+          tab={tab}
         />
       </DatasetProvider>
     )
@@ -92,6 +94,7 @@ function DatasetWithSearchParams() {
         publishInProgress={publishInProgress}
         metadataUpdated={metadataUpdated}
         filesTabInfiniteScrollEnabled={FILES_TAB_INFINITE_SCROLL_ENABLED}
+        tab={tab}
       />
     </DatasetProvider>
   )

src/sections/dataset/DatasetProvider.tsx

@@ -1,4 +1,5 @@
-import { PropsWithChildren, useCallback, useEffect, useState } from 'react'
+import { PropsWithChildren, useEffect, useState } from 'react'
+import { useDeepCompareCallback } from 'use-deep-compare'
 import { DatasetContext } from './DatasetContext'
 import { DatasetRepository } from '../../dataset/domain/repositories/DatasetRepository'
 import { Dataset } from '../../dataset/domain/models/Dataset'
@@ -23,7 +24,7 @@ export function DatasetProvider({
   const [dataset, setDataset] = useState<Dataset>()
   const [isLoading, setIsLoading] = useState(true)
 
-  const getDataset = useCallback(() => {
+  const getDataset = useDeepCompareCallback(() => {
     if (searchParams.persistentId) {
       return getDatasetByPersistentId(repository, searchParams.persistentId, searchParams.version)
     }
@@ -46,7 +47,7 @@ export function DatasetProvider({
         console.error('There was an error getting the dataset', error)
         setIsLoading(false)
       })
-  }, [repository, searchParams, getDataset, isPublishing])
+  }, [repository, getDataset, isPublishing])
 
   return (
     <DatasetContext.Provider value={{ dataset, isLoading }}>{children}</DatasetContext.Provider>