resolve merge conflicts

Author: ekraffmiller

CHANGELOG.md

@@ -18,7 +18,9 @@ This changelog follows the principles of [Keep a Changelog](https://keepachangel
 - Added Notifications tab in Account Page
 - Added runtime configuration options for homepage branding and support link.
 - Added an environment variable to docker-compose-dev.yml to hide the OIDC client used in the SPA from the JSF frontend: DATAVERSE_AUTH_OIDC_HIDDEN_JSF: 1
+- Added a message note to the login page
 - Download with terms of use and guestbook.
+- Show terms modal before download when dataset has custom terms, a non-default license (not CC0 1.0), or a guestbook. Draft datasets and dataset editors bypass the modal.
 - Layout: added a configurable homepage banner for announcements and important messages. (#787)
 
 ### Changed

dev-env/shib-dev-env/keycloak/test-realm.json

@@ -940,7 +940,7 @@
       "alwaysDisplayInConsole": false,
       "clientAuthenticatorType": "client-secret",
       "redirectUris": [
-        "https://localhost/spa/*"
+        "https://localhost/modern/*"
       ],
       "webOrigins": [
         "+"

packages/design-system/CHANGELOG.md

@@ -5,6 +5,15 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 # Non Published Changes
 
+### Fixed
+
+- **FormText:** Add `className` prop to allow custom styling.
+- **FormInput:** Add `size` prop to allow different input sizes (e.g., 'sm', 'lg'). Defaults to standard size if not specified.
+- **Badge:**:
+  - Add `pill` prop to allow pill-shaped badges.
+  - Add `dataTestId` prop to facilitate testing.
+  - Add `className` prop to allow custom styling.
+
 # [2.1.0](https://github.com/IQSS/dataverse-frontend/compare/@iqss/dataverse-design-system@2.0.2...@iqss/dataverse-design-system@2.1.0) (2025-10-09)
 
 ### Added
@@ -28,12 +37,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
   - Fix word wrapping in options list to prevent overflow and ensure long text is displayed correctly.
 - **ButtonGroup:**
   - Fix styles for vertical button groups when using tooltips.
-- **FormText:** Add `className` prop to allow custom styling.
-- **FormInput:** Add `size` prop to allow different input sizes (e.g., 'sm', 'lg'). Defaults to standard size if not specified.
-- **Badge:**:
-  - Add `pill` prop to allow pill-shaped badges.
-  - Add `dataTestId` prop to facilitate testing.
-  - Add `className` prop to allow custom styling.
 
 # [2.0.2](https://github.com/IQSS/dataverse-frontend/compare/@iqss/dataverse-design-system@2.0.1...@iqss/dataverse-design-system@2.0.2) (2024-06-23)
 

src/index.tsx

@@ -11,31 +11,35 @@ const AppEntrypoint = lazy(() => import('./index.app'))
 const container = document.getElementById('root') as HTMLElement
 const root = createRoot(container)
 
-const appConfigInit = initAppConfig()
-
-if (!appConfigInit.ok) {
+if (window.kcContext) {
   root.render(
-    <ConfigError message={appConfigInit.message} schemaError={appConfigInit.schemaError} />
+    <StrictMode>
+      <KcPage kcContext={window.kcContext} />
+    </StrictMode>
   )
 } else {
-  const appConfig = requireAppConfig()
+  const appConfigInit = initAppConfig()
 
-  ApiConfig.init(
-    `${appConfig.backendUrl}/api/v1`,
-    DataverseApiAuthMechanism.BEARER_TOKEN,
-    undefined,
-    `${appConfig.oidc.localStorageKeyPrefix}token`
-  )
+  if (!appConfigInit.ok) {
+    root.render(
+      <ConfigError message={appConfigInit.message} schemaError={appConfigInit.schemaError} />
+    )
+  } else {
+    const appConfig = requireAppConfig()
 
-  root.render(
-    <StrictMode>
-      {window.kcContext ? (
-        <KcPage kcContext={window.kcContext} />
-      ) : (
+    ApiConfig.init(
+      `${appConfig.backendUrl}/api/v1`,
+      DataverseApiAuthMechanism.BEARER_TOKEN,
+      undefined,
+      `${appConfig.oidc.localStorageKeyPrefix}token`
+    )
+
+    root.render(
+      <StrictMode>
         <Suspense>
           <AppEntrypoint />
         </Suspense>
-      )}
-    </StrictMode>
-  )
+      </StrictMode>
+    )
+  }
 }

src/keycloak-theme/login/Template.tsx

@@ -9,6 +9,7 @@ import type { KcContext } from './KcContext'
 import { Alert, DropdownButton, DropdownButtonItem, Tooltip } from '@iqss/dataverse-design-system'
 import { ArrowUpRightSquareFill } from 'react-bootstrap-icons'
 import dataverse_logo from '@/assets/dataverse_brand_icon.svg'
+import { SignInNotice } from './components/SignInNotice'
 import styles from './template.module.scss'
 
 /*
@@ -64,11 +65,13 @@ export default function Template(props: TemplateProps<KcContext, I18n>) {
 
   return (
     <div className={styles.login} id="kc-login-template">
+      {kcContext.pageId === 'login.ftl' && <SignInNotice i18n={i18n} />}
       <div id="kc-header">
         <div id="kc-header-wrapper" className={styles['header-wrapper']}>
           <img src={dataverse_logo} alt="Brand Logo Image" />
         </div>
       </div>
+
       <div className={styles['login-card']}>
         <header>
           {enabledLanguages.length > 1 && (

src/keycloak-theme/login/components/SignInNotice.module.scss

@@ -0,0 +1,4 @@
+.top-notice {
+  margin: 0.5rem;
+  border-radius: 8px;
+}

src/keycloak-theme/login/components/SignInNotice.tsx

@@ -0,0 +1,27 @@
+import { Alert } from '@iqss/dataverse-design-system'
+import type { I18n } from '../i18n'
+import styles from './SignInNotice.module.scss'
+
+const DATAVERSE_BASE_URL =
+  (import.meta.env.VITE_DATAVERSE_BASE_URL as string) ?? 'https://dataverse.harvard.edu'
+const HARVARD_SIGN_UP_URL = `${DATAVERSE_BASE_URL}/dataverseuser.xhtml?editMode=CREATE&redirectPage=%2Fdataverse_homepage.xhtml`
+
+interface SignInNoticeProps {
+  i18n: I18n
+}
+
+export function SignInNotice({ i18n }: SignInNoticeProps) {
+  const { msg, msgStr } = i18n
+
+  return (
+    <div className={styles['top-notice']}>
+      <Alert variant="warning" customHeading={msgStr('signInNoticeTitle')} dismissible={false}>
+        <>
+          {msg('signInNoticeBodyPrefix')}
+          <a href={HARVARD_SIGN_UP_URL}>{msg('signInNoticeSignUpLinkText')}</a>
+          {msg('signInNoticeBodySuffix')}
+        </>
+      </Alert>
+    </div>
+  )
+}

src/keycloak-theme/login/i18n.ts

@@ -3,7 +3,18 @@ import { i18nBuilder } from 'keycloakify/login'
 import type { ThemeName } from '../kc.gen'
 
 /** @see: https://docs.keycloakify.dev/features/i18n */
-const { useI18n, ofTypeI18n } = i18nBuilder.withThemeName<ThemeName>().build()
+const { useI18n, ofTypeI18n } = i18nBuilder
+  .withThemeName<ThemeName>()
+  .withCustomTranslations({
+    en: {
+      signInNoticeTitle: 'Note about Federated Login options sign-in',
+      signInNoticeBodyPrefix:
+        'Federated Login options are available only to the existing accounts that previously authenticated with these methods. New sign-ups via these options are not supported. Please use your Harvard Login or Username/Email to ',
+      signInNoticeSignUpLinkText: 'sign up in Harvard Dataverse',
+      signInNoticeBodySuffix: ', then you may login here.'
+    }
+  })
+  .build()
 
 type I18n = typeof ofTypeI18n
 

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

@@ -8,12 +8,13 @@ import {
   DatasetLicense,
   DatasetPermissions,
   DatasetPublishingStatus,
-  DatasetVersion
+  DatasetVersion,
+  defaultLicense
 } from '../../../../dataset/domain/models/Dataset'
 import { FileDownloadSize, FileDownloadMode } from '../../../../files/domain/models/FileMetadata'
 import { DatasetExploreOptions } from '../DatasetToolsOptions'
 import { useAccessRepository } from '@/sections/access/AccessRepositoryContext'
-import { DownloadWithGuestbookModal } from '@/sections/dataset/dataset-files/files-table/file-actions/file-actions-cell/file-action-buttons/file-options-menu/DownloadWithGuestbookModal'
+import { DownloadWithTermsAndGuestbookModal } from '@/sections/dataset/dataset-files/files-table/file-actions/file-actions-cell/file-action-buttons/file-options-menu/DownloadWithTermsAndGuestbookModal'
 import {
   downloadFromSignedUrl,
   EMPTY_GUESTBOOK_RESPONSE,
@@ -47,14 +48,18 @@ export function AccessDatasetMenu({
   customTerms
 }: AccessDatasetMenuProps) {
   const { t } = useTranslation('dataset')
-  const [showDownloadWithGuestbookModal, setShowDownloadWithGuestbookModal] = useState(false)
+  const [showDownloadWithTermsAndGuestbookModal, setShowDownloadWithTermsAndGuestbookModal] =
+    useState(false)
   const [selectedDownloadFormat, setSelectedDownloadFormat] = useState<FileDownloadMode>(
     FileDownloadMode.ORIGINAL
   )
-  const hasGuestbook =
-    guestbookId !== undefined &&
-    version.publishingStatus !== DatasetPublishingStatus.DRAFT &&
-    !permissions.canUpdateDataset
+  const isDraft = version.publishingStatus === DatasetPublishingStatus.DRAFT
+  const bypassTermsGuard = isDraft || permissions.canUpdateDataset
+  const hasGuestbook = guestbookId !== undefined
+  const hasNonDefaultLicense = license !== undefined && license.name !== defaultLicense.name
+  const hasCustomTerms = customTerms !== undefined
+  const shouldShowModal =
+    !bypassTermsGuard && (hasGuestbook || hasCustomTerms || hasNonDefaultLicense)
 
   const flesToDownloadSizeIsZero =
     fileDownloadSizes.map(({ value }) => value).reduce((acc, curr) => acc + curr, 0) === 0
@@ -79,7 +84,7 @@ export function AccessDatasetMenu({
   ) => {
     event.preventDefault()
     setSelectedDownloadFormat(mode)
-    setShowDownloadWithGuestbookModal(true)
+    setShowDownloadWithTermsAndGuestbookModal(true)
   }
 
   return (
@@ -96,15 +101,15 @@ export function AccessDatasetMenu({
           datasetNumericId={datasetNumericId}
           hasOneTabularFileAtLeast={hasOneTabularFileAtLeast}
           fileDownloadSizes={fileDownloadSizes}
-          hasGuestbook={hasGuestbook}
+          requiresTermsOrGuestbook={shouldShowModal}
           onDownloadWithGuestbook={handleDownloadWithGuestbook}
         />
         <DatasetExploreOptions persistentId={persistentId} />
       </DropdownButton>
-      {hasGuestbook && showDownloadWithGuestbookModal && (
-        <DownloadWithGuestbookModal
-          show={showDownloadWithGuestbookModal}
-          handleClose={() => setShowDownloadWithGuestbookModal(false)}
+      {shouldShowModal && showDownloadWithTermsAndGuestbookModal && (
+        <DownloadWithTermsAndGuestbookModal
+          show={showDownloadWithTermsAndGuestbookModal}
+          handleClose={() => setShowDownloadWithTermsAndGuestbookModal(false)}
           datasetId={datasetNumericId} // TODO: we should allow this to pass persistentId when we have the backend support for guestbook submission with persistentId
           datasetPersistentId={persistentId}
           guestbookId={guestbookId}
@@ -121,15 +126,15 @@ interface DatasetDownloadOptionsProps {
   datasetNumericId?: number | string
   hasOneTabularFileAtLeast: boolean
   fileDownloadSizes: FileDownloadSize[]
-  hasGuestbook: boolean
+  requiresTermsOrGuestbook: boolean
   onDownloadWithGuestbook: (event: React.MouseEvent<HTMLElement>, mode: FileDownloadMode) => void
 }
 
 const DatasetDownloadOptions = ({
   datasetNumericId,
   hasOneTabularFileAtLeast,
   fileDownloadSizes,
-  hasGuestbook,
+  requiresTermsOrGuestbook,
   onDownloadWithGuestbook
 }: DatasetDownloadOptionsProps) => {
   const { t } = useTranslation('dataset')
@@ -140,7 +145,7 @@ const DatasetDownloadOptions = ({
     event: React.MouseEvent<HTMLElement>,
     mode: FileDownloadMode
   ): void => {
-    if (hasGuestbook) {
+    if (requiresTermsOrGuestbook) {
       onDownloadWithGuestbook(event, mode)
       return
     }

src/sections/dataset/dataset-files/files-table/file-actions/download-files/DownloadFilesButton.tsx

@@ -3,14 +3,14 @@ import { useTranslation } from 'react-i18next'
 import { Button, DropdownButton, DropdownButtonItem } from '@iqss/dataverse-design-system'
 import { MouseEvent, useState } from 'react'
 import { toast } from 'react-toastify'
-import { DatasetPublishingStatus } from '@/dataset/domain/models/Dataset'
+import { DatasetPublishingStatus, defaultLicense } from '@/dataset/domain/models/Dataset'
 import { FileDownloadMode } from '../../../../../../files/domain/models/FileMetadata'
 import { useDataset } from '../../../../DatasetContext'
 import { FileSelection } from '../../row-selection/useFileSelection'
 import { NoSelectedFilesModal } from '../no-selected-files-modal/NoSelectedFilesModal'
 import { FilePreview } from '../../../../../../files/domain/models/FilePreview'
 import { useMediaQuery } from '../../../../../../shared/hooks/useMediaQuery'
-import { DownloadWithGuestbookModal } from '../file-actions-cell/file-action-buttons/file-options-menu/DownloadWithGuestbookModal'
+import { DownloadWithTermsAndGuestbookModal } from '../file-actions-cell/file-action-buttons/file-options-menu/DownloadWithTermsAndGuestbookModal'
 import {
   downloadFromSignedUrl,
   EMPTY_GUESTBOOK_RESPONSE,
@@ -31,7 +31,8 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
   const { t } = useTranslation('files')
   const { dataset } = useDataset()
   const [showNoFilesSelectedModal, setShowNoFilesSelectedModal] = useState(false)
-  const [showDownloadWithGuestbookModal, setShowDownloadWithGuestbookModal] = useState(false)
+  const [showDownloadWithTermsAndGuestbookModal, setShowDownloadWithTermsAndGuestbookModal] =
+    useState(false)
   const [selectedDownloadFormat, setSelectedDownloadFormat] = useState<FileDownloadMode>(
     FileDownloadMode.ORIGINAL
   )
@@ -43,10 +44,15 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
   const fileIdsForGuestbookSubmission = allFilesSelected
     ? undefined
     : getFileIdsFromSelection(fileSelection)
-  const hasGuestbook =
-    dataset?.guestbookId !== undefined &&
-    dataset?.version.publishingStatus !== DatasetPublishingStatus.DRAFT &&
-    !dataset?.permissions.canUpdateDataset
+  const isDraftDataset = dataset?.version.publishingStatus === DatasetPublishingStatus.DRAFT
+  const canEdit = dataset?.permissions.canUpdateDataset ?? false
+  const bypassTermsGuard = isDraftDataset || canEdit
+  const hasGuestbook = dataset?.guestbookId !== undefined
+  const hasNonDefaultLicense =
+    dataset?.license !== undefined && dataset.license.name !== defaultLicense.name
+  const hasCustomTerms = dataset?.termsOfUse?.customTerms !== undefined
+  const shouldShowModal =
+    !bypassTermsGuard && (hasGuestbook || hasCustomTerms || hasNonDefaultLicense)
 
   const onClick = (event: MouseEvent<HTMLElement>, downloadMode: FileDownloadMode) => {
     if (fileSelectionCount === SELECTED_FILES_EMPTY) {
@@ -55,10 +61,10 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
       return
     }
 
-    if (hasGuestbook) {
+    if (shouldShowModal) {
       event.preventDefault()
       setSelectedDownloadFormat(downloadMode)
-      setShowDownloadWithGuestbookModal(true)
+      setShowDownloadWithTermsAndGuestbookModal(true)
       return
     }
 
@@ -101,15 +107,17 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
         show={showNoFilesSelectedModal}
         handleClose={() => setShowNoFilesSelectedModal(false)}
       />
-      {hasGuestbook && showDownloadWithGuestbookModal && (
-        <DownloadWithGuestbookModal
+      {shouldShowModal && showDownloadWithTermsAndGuestbookModal && (
+        <DownloadWithTermsAndGuestbookModal
           fileIds={fileIdsForGuestbookSubmission}
           datasetId={allFilesSelected ? dataset.id : undefined}
           guestbookId={dataset.guestbookId}
           format={selectedDownloadFormat}
           datasetPersistentId={dataset.persistentId}
-          show={showDownloadWithGuestbookModal}
-          handleClose={() => setShowDownloadWithGuestbookModal(false)}
+          datasetLicense={dataset.license}
+          datasetCustomTerms={dataset.termsOfUse?.customTerms}
+          show={showDownloadWithTermsAndGuestbookModal}
+          handleClose={() => setShowDownloadWithTermsAndGuestbookModal(false)}
         />
       )}
     </>
@@ -140,27 +148,15 @@ export function DownloadFilesButton({ files, fileSelection }: DownloadFilesButto
   // no tabular file content
   return (
     <>
-      {hasGuestbook ? (
-        <Button
-          id="download-files"
-          variant="secondary"
-          icon={<Download className={styles.icon} />}
-          aria-label={t('actions.downloadFiles.title')}
-          withSpacing
-          onClick={(event) => onClick(event, FileDownloadMode.ORIGINAL)}>
-          {dropdownButtonTitle}
-        </Button>
-      ) : (
-        <Button
-          id="download-files"
-          variant="secondary"
-          icon={<Download className={styles.icon} />}
-          aria-label={t('actions.downloadFiles.title')}
-          withSpacing
-          onClick={(event) => onClick(event, FileDownloadMode.ORIGINAL)}>
-          {dropdownButtonTitle}
-        </Button>
-      )}
+      <Button
+        id="download-files"
+        variant="secondary"
+        icon={<Download className={styles.icon} />}
+        aria-label={t('actions.downloadFiles.title')}
+        withSpacing
+        onClick={(event) => onClick(event, FileDownloadMode.ORIGINAL)}>
+        {dropdownButtonTitle}
+      </Button>
 
       {downloadFeedbackModals}
     </>