Payload CMS Release: Release 1.5.5

TL;DR

Payload CMS v1.5.5 brings important bug fixes and localization improvements

This release focuses on fixing several critical bugs related to localization, relationship fields, and the rich text editor. Key improvements include better handling of localized data in arrays and blocks, compatibility with Azure Cosmos DB and AWS DocumentDB, and enhanced upload field functionality. The update also adds support for setting non-default locales to null to use fallback values, improving the content management experience for multilingual sites.

Highlight of the Release

• Fixed critical bug where arrays and blocks weren't saving localized nested field data when reordering rows
• Added compatibility with Azure Cosmos DB and AWS DocumentDB
• Implemented ability to set non-default locales to null to use fallback values
• Fixed relationship field clearing bug when hasMany is false
• Improved upload field functionality and fixed filterOptions

Migration Guide

This release doesn't require any specific migration steps. The changes are backward compatible and should work with existing Payload CMS implementations.

If you're using localized arrays and blocks, you'll now be able to take advantage of the new null value support for non-default locales. This allows content to fall back to the default locale when a translation isn't available.

For developers using Azure Cosmos DB or AWS DocumentDB, Payload now offers improved compatibility with these database systems.

Upgrade Recommendations

This release is recommended for all users, especially those working with:

1. Multilingual content using arrays and blocks
2. Relationship fields
3. Upload fields with conditions
4. Rich text editor with links
5. Azure Cosmos DB or AWS DocumentDB

To upgrade, run:

npm install [email protected]
# or
yarn add [email protected]

The update is backward compatible and should not cause any breaking changes to existing implementations.

Bug Fixes

• Localization:

  • Fixed critical issue where arrays and blocks weren't saving localized nested field data when reordering rows (#1808)
  • Corrected typos in Thai translation
  • Fixed wrong translation and punctuation spacing

• Fields and Components:

  • Fixed bug when clearing relationship field without hasMany: true (#1829)
  • Ensured upload file data is available for conditions (#1737)
  • Fixed upload field filterOptions (#1801)
  • Updated margin for group field within a row
  • Fixed date formatting when used with useAsTitle property

• Rich Text Editor:

  • Fixed rich text editor link element initial state (#1848)
  • Prevented uploads drawer from crashing when no uploads are enabled

New Features

• Fallback Locale Support: Added ability to set non-default locales to null to use fallback values, improving content management for multilingual sites
• Database Compatibility: Ensured compatibility with Azure Cosmos DB and AWS DocumentDB, expanding deployment options
• Localization Improvements: Added translations for the fallbackToDefaultLocale feature
• Null Value Support: Implemented explicit null value setting for localized arrays and blocks

Security Updates

No specific security fixes were included in this release.

Performance Improvements

• Database Operations: Improved handling of draft aggregation to ensure proper ordering and efficiency
• Data Layer: Optimized how arrays and blocks store undefined values, using undefined instead of empty arrays by default
• Localization: More efficient handling of localized content with the new fallback mechanism, reducing redundant data storage

Impact Summary

Payload CMS v1.5.5 delivers significant improvements to localization handling, particularly for arrays and blocks. The release fixes several critical bugs that affected content editing workflows, including issues with relationship fields, upload functionality, and the rich text editor.

The most notable enhancement is the ability to set non-default locales to null, allowing content to fall back to the default locale when translations aren't available. This feature streamlines content management for multilingual sites by reducing redundant data entry.

Database compatibility has been expanded to include Azure Cosmos DB and AWS DocumentDB, giving developers more deployment options. Various UI improvements and bug fixes round out the release, making it a recommended update for all Payload CMS users.

Overall, this release focuses on stability and quality-of-life improvements rather than introducing major new features, making it a safe and beneficial upgrade for production environments.

Full Release Notes