CHANGELOG.md

Changelog

All notable changes to Dataverse Client Javascript are documented here.

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

• New Use Case: Update Dataset License under Datasets.
• New Use Case: Get Dataset Storage Driver under Datasets.
• New Use Case: Get Dataset Upload Limits under Datasets.
• New Use Case: Update Terms of Access under Datasets.
• New Use Case: Create a Template under Templates.
• New Use Case: Get a Template under Templates.
• New Use Case: Delete a Template under Templates.
• New Use Case: Set Template as Default under Templates.
• New Use Case: Unset Template as Default under Templates.
• New Use Case: Create Guestbook under Guestbooks.
• New Use Case: Get Guestbooks under Guestbooks.
• New Use Case: Enable Guestbook under Guestbooks.
• New Use Case: Disable Guestbook under Guestbooks.
• New Use Case: Assign Dataset Guestbook under Guestbooks.
• New Use Case: Remove Dataset Guestbook under Guestbooks.
• New Use Case: Get Publish Dataset Disclaimer Text.
• New Use Case: Get Dataset Publish Popup Custom Text.
• New Use Case: Get Allowed Collection Storage Drivers under Collections.
• New Use Case: Get Collection Storage Driver under Collections.
• New Use Case: Set Collection Storage Driver under Collections.
• New Use Case: Delete Collection Storage Driver under Collections.
• New Use Case: Get Collections For Linking under Collections.
• Access: Added access module for guestbook-at-request and download terms/guestbook submission endpoints.
• DatasetType: Updated datasetType data model. Added two more fields: description and displayName.

Changed

• Add pagination query parameters to Dataset Version Summeries and File Version Summaries use cases.
• Templates: Rename CreateDatasetTemplateDTO to CreateTemplateDTO.
• Templates: Rename createDatasetTemplate repository method to createTemplate.
• Templates: Rename getDatasetTemplates repository method to getTemplatesByCollectionId.
• Datasets/Guestbooks: Added guestbookId in getDataset responses.
• DatasetType: Updated datasetType data model. Added two more fields: description and displayName.

Fixed

• In GetAllNotificationsByUser use case, additionalInfo field is returned as an object instead of a string.
• In GetAllNotificationsByUser use case, added support for filtering unread messages and pagination.

Removed

• Removed date fields validations in create and update dataset use cases, since validation is already handled in the backend and SPA frontend (other clients should perform client side validation also). This avoids duplicated logic and keeps the package focused on its core responsibility.

---

[v2.1.0] -- 2025-09-29

Added

• CHANGELOG.md file to track changes in a standard way.

• New property isAdvancedSearchFieldType returned by API in GetCollectionMetadataBlocks and GetMetadataBlockByName use cases.

• Use cases for Notifications: GetAllNotifications, DeleteNotification.

• Use cases for Dataset Linking: LinkDataset, UnlinkDataset, GetDatasetLinkedCollections.

• Use case: GetCitationInOtherFormats.

• Use case: GetDatasetAvailableCategories.

• Use cases for Collections Linking: LinkCollection, UnlinkCollection, GetCollectionLinks.

• Use cases for External Tools: GetExternalTools, GetDatasetExternalToolResolved, GetFileExternalToolResolved.

• Use case: GetTemplatesByCollectionId.

• Use case: GetAvailableStandardLicenses.

• Use case: GetAvailableDatasetMetadataExportFormats.

• Use cases for Dataset Types: GetDatasetAvailableDatasetTypes, GetDatasetAvailableDatasetType, AddDatasetType, LinkDatasetTypeWithMetadataBlocks, SetAvailableLicensesForDatasetType, DeleteDatasetType.

Changed

• CreateDataset use case updated to allow non-default dataset types.

• GetCollectionMetadataBlocks use case updated to support passing a dataset type.

Fixed

• Integration tests in Roles Repository.

• Incorrect Filter Queries split that caused value parts to be truncated.

Security

• Dependencies updated to address vulnerabilities found by npm audit.