Payload CMS Release: Release v2.0.13

TL;DR

PayloadCMS v2.0.13 Release

This release focuses on bug fixes and improvements to the PayloadCMS platform. Key improvements include fixes for live preview functionality, user preferences management, GraphQL mutation types, and UI component enhancements. The update addresses several critical issues that improve stability and user experience without introducing breaking changes.

Highlight of the Release

• Fixed live preview functionality for global content
• Improved UI components with better alignment and stability
• Enhanced GraphQL mutation input types for named tabs
• Prevented duplicate user preferences storage
• Added security improvements for live preview message handling
• Fixed document sidebar from unexpectedly collapsing

Migration Guide

This release contains no breaking changes and should be a straightforward upgrade from v2.0.12.

If you were using functions for before and after field props, note that you can now use components directly as well, though the function approach remains supported for backward compatibility.

No database migrations or configuration changes are required for this update.

Upgrade Recommendations

We recommend all users upgrade to v2.0.13 as it contains important bug fixes that improve stability and user experience. The upgrade process should be straightforward:

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

This is a patch release with no breaking changes, making it a low-risk upgrade that addresses several important issues, particularly for users who rely on live preview functionality, GraphQL, or have complex UI requirements.

Bug Fixes

This release addresses several important bugs:

• UI Improvements:

  • Fixed alignment of collapsible elements within rows for better visual consistency
  • Prevented document sidebar from unexpectedly collapsing
  • Improved rendering of live preview for globals

• GraphQL Fixes:

  • Fixed named tabs not appearing in the GraphQL mutation input type
  • Fixed GraphQL footer queries in templates

• User Experience:

  • Resolved issue with duplicate user preferences being stored
  • Fixed live preview message parsing to only occur when from the same origin

• System Stability:

  • Reverted problematic changes to localized versions

New Features

This release primarily focuses on bug fixes, but does include some feature enhancements:

• Component Support for Field Props: Now accepts components for before and after fields instead of just functions, providing more flexibility in UI customization.
• Enhanced Live Preview: Improved live preview functionality now works properly with global content.
• Origin Validation: Added origin validation for live preview ready messages, improving security.

Security Updates

• Origin Validation: Added origin validation for live preview ready messages, ensuring that only messages from trusted sources are processed. This helps prevent potential cross-origin attacks and improves the overall security posture of the application.

Performance Improvements

• User Preferences Optimization: The fix for duplicate user preferences not only resolves a bug but also improves performance by reducing unnecessary storage operations and preventing potential memory bloat.

• Live Preview Efficiency: By only parsing live preview ready messages when they come from the same origin, the system avoids unnecessary processing of irrelevant messages, improving overall responsiveness.

Impact Summary

PayloadCMS v2.0.13 is a maintenance release that focuses on bug fixes and minor enhancements. The update addresses several UI issues, improves GraphQL functionality, enhances live preview capabilities, and fixes user preference management.

The most significant improvements include fixing live preview for global content, preventing document sidebar collapse, resolving issues with named tabs in GraphQL mutation input types, and preventing duplicate user preferences. These changes collectively improve the stability and usability of the CMS.

This release is particularly beneficial for content editors who will experience a more stable UI, and developers who will benefit from more reliable GraphQL functionality and component-based field customization options. The security enhancement for live preview message validation also adds an important layer of protection for all users.

As a patch release with no breaking changes, upgrading should be straightforward and is recommended for all users.

Full Release Notes