Skip to content

CHANGELOG.md

Latest commit

 

History

History
138 lines (102 loc) · 9.46 KB

CHANGELOG.md

File metadata and controls

138 lines (102 loc) · 9.46 KB
Raw

Changelog

All notable changes to Dataverse Frontend are documented here. We also maintain a separate Design System Changelog for component-specific changes.

This changelog follows the principles of Keep a Changelog and adheres to Semantic Versioning. This document is intended for developers, contributors, and users who need to understand the technical details.

[Unreleased]

Added

  • Edit Dataset Template Integration: "Edit Template" dropdown on the Dataset Templates listing now opens the Metadata or Terms editor and shows a "Template updated" toast on return.
  • External Tools: Added guestbook and terms modal for Dataverse external tools.
  • Manage Guestbooks page integration, including:
    • a guestbooks table with sorting, enable/disable actions, preview, and per-guestbook response download
    • Create Guestbook and Download All Responses actions
    • the Create Guestbook page
    • a checkbox for including guestbooks from parent collections
  • Dataset Templates UI integration, including create/edit flows, previews, and skeleton states.
  • Dataset Page: added a sidebar to show dataset reviews

Changed

  • Add multilingual support for the banner message.
  • File pages now include a "Cite Data File" dropdown for downloading file citations in EndNote XML, RIS, and BibTeX formats.
  • Hide "Export Metadata" on dataset and file pages that are not for the latest published dataset version.
  • Show "Export Metadata" on dataset and file pages for draft version.
  • Avoided prop-drilling for file, guestbook, user and external tool repository, so used context to share repository instances.

Fixed

  • Fix "Filter by" File Type dropdown getting cut off by adding max-height and scrolling. (#792)
  • Dataset Page: show draft version if user has permission when no version param is provided. (#1003)
  • Display facet name alongside facet value in selected filter chips above search results (#894)
  • Show accurate, user-specific API token status messages on the Account page (#943)
  • Publish Dataset modal custom messages now render configured HTML links and line breaks.
  • Edit Dataset Terms: navigate to the draft version of the dataset after saving changes to the terms, instead of the latest published version.
  • After saving on either Edit Template tab (Metadata or Terms), the user is redirected to the templates listing with a success toast instead of staying on the edit page.
  • Edit Template breadcrumb on the Terms page no longer renders the dataset's "Terms and Guestbook" label (templates have no guestbook).
  • Edit Metadata always loads the latest dataset version (draft if present, otherwise latest published), ignoring the browsed version query param so it matches JSF / Edit Terms. (#1024)

Removed

  • Standalone EditTemplateMetadataFactory and EditTemplateTermsFactory route factories — replaced by a single EditTemplateFactory dispatcher that selects the right page based on editMode.

[v0.3.1] -- 2026-04-30

  • Added pagination to the Versions tabs on Dataset and File pages so version summaries are loaded and displayed one page at a time.

[v0.3.0] -- 2026-04-24

Added

  • Added the value entered by the user in the error messages for metadata field validation errors in EMAIL and URL type fields. For example, instead of showing “Point of Contact E-mail is not a valid email address.“, we now show “Point of Contact E-mail foo is not a valid email address.”
  • Contact Owner button in File Page.
  • Share button in File Page.
  • Link Collection and Link Dataset features.
  • Edit Terms Integration.
  • File upload now shows the remaining storage quota when upload limits are available.
  • With the addition of the new runtime configuration approach, we now support dynamic configuration for languages. If more than one language is configured, the Language Switcher will be shown in the header to allow users to change the language.
  • 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
  • Dataset Templates UI integration, including create/edit flows, previews, and skeleton states.
  • 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

  • Add pagination support to the Dataset Version Summaries and File Version Summaries use cases by introducing optional pagination object. #885
  • Refactored pagination to use consistent CollectionItemsPaginationInfo object in getMyDataCollectionItems, instead of individual limit/selectedPage parameters.
  • Use of the new sourceLastUpdateTime query parameter from update dataset and file metadata endpoints to support optimistic concurrency control during editing operations. See Edit Dataset Metadata and Updating File Metadata guides for more details.
  • Changed the way we were handling DATE type metadata field validation to better match the backend validation and give users better error messages. For example, for an input like “foo AD”, we now show “Production Date is not a valid date. The AD year must be numeric.“. For an input like “99999 AD”, we now show “Production Date is not a valid date. The AD year cant be higher than 9999.“. For an input like “[-9999?], we now show “Production Date is not a valid date. The year in brackets cannot be negative.“, etc.
  • The SPA now fetches the runtime configuration from config.js on each load, allowing configurations without rebuilding the app. We don't use .env variables at build time anymore.
  • Renamed dataset template fetch/create use cases and DTOs to getTemplatesByCollectionId and CreateTemplateDTO for API alignment, and added new getTemplate and deleteTemplate use cases for retrieving a single template by ID and deleting templates.
  • Added disclaimer text and custom popup text to Publish Dataset modal for better communication of the implications of publishing a dataset. The text can be configured through the runtime configuration.
  • Dataset page Terms tab title now depends on permissions: users with dataset update permission see Terms and Guestbook, and read-only users see Terms.
  • Avoided prop-drilling for collection repository, so used context to share epository instances.
  • Added frontend version to the footer of the application, which is retrieved from the version field in package.json at build time.

Fixed

  • Add word-break to items text to prevent layout issues when long descriptions without spaces are entered. (#839)
  • Show toast notification when API token is copied to clipboard.
  • Dataset versions: (1) file changes should be Access: Restricted instead of isResticted: true/false; (2) logic of View Detail button. (#879)
  • File versions: (1) logic of linking to a file version; (2)If file not included, show text information "File not included in this version.". (#879)
  • Dataset page publish flow now avoids rendering duplicate tab sets by making tabs skeleton and tabs content mutually exclusive.
  • Fixed custom terms navigation url while publishing a datsaet.

Removed

[v0.2.0] -- 2025-10-03

Added

  • Dataset Templates integration in the Create Dataset form. (#745)
  • Advanced Search UI replicating legacy JSF, with persistence of queries and facet filters. (#760, dataverse#9993)
  • External Search integration with selectable search service and first-load fetch behavior. (#710)
  • File Edit Tags with populated categories dropdown. (#763)
  • DEMO environment option in deploy actions.
  • Metadata Export Dropdown to the metadata tab of Dataset Page and File Page.
  • External Tools integration. All types supported: Explore, Configure, Preview and Query tools in Dataset and File pages. Still not showing external tools for Auxiliary Files as additional development is needed.
  • Dataset page: citation downloads available in multiple formats with copy-to-clipboard. (#786)

Changed

  • Standardized Node.js to v22 across environments (docker dev, CI, production).
  • Upgrade Keycloak to 26.3.2; updated SPI and test realm JSON.
  • Truncate long collection and dataset descriptions with expandable content. (#789)
  • UI polish: Files Table always shows action buttons. (#800)
  • Removed hard-coded references to /spa path and SPA name, changed to /modern (#945)

Fixed

  • Guest user access: file info retrieval works on deaccessioned datasets. (#752)
  • Collection filter queries with values containing ":" now parsed correctly. (#812)
  • File upload: corrected "drop one file to replace" warning behavior. (#810)
  • Create Collection form: prevent numeric-only aliases. (#798)
  • Improved URL handling and wrapping across the UI. (#774)

Documentation

  • Introduced CHANGELOG and updated related documents. (#828)
  • Added Environments section to README.
  • Expanded Keycloak deployment documentation with realm setup and SPI guidance.

Security

  • Fixed dependencies vulnerabilities: reduced npm audit issues from 100+ (including 12 critical and 33 high) to only 2 moderate.

[v0.1.0] -- 2025-08-13