Tag Name: v0.5.0
Release Date: 3/29/2021
Payload CMSPayload CMS is a modern, self-hosted headless content management system built with TypeScript, Node.js, and MongoDB. It's designed specifically for developers who want full control over their content management system while maintaining a powerful admin interface for content editors.
What's new: This release introduces API improvements for global operations, better handling of nested arrays, consistent readOnly behavior, and enhanced rich text editing with cursor position preservation.
Why it matters: These changes improve developer experience with more intuitive APIs and fix several critical bugs related to data persistence and validation, making the CMS more reliable.
Who should care: Payload CMS developers working with global collections, nested arrays, rich text fields with relationships, and those who need consistent validation behavior across the admin interface.
slug instead of global as the key identifierfor v0.5.0
If you're using Payload's Local API to interact with globals, you'll need to update your code:
Before:
// Finding a global
payload.findGlobal({ global: 'globalSlug' });
// Updating a global
payload.updateGlobal({ global: 'globalSlug', data: { ... } });
After:
// Finding a global
payload.findGlobal({ slug: 'globalSlug' });
// Updating a global
payload.updateGlobal({ slug: 'globalSlug', data: { ... } });
This change makes the API more consistent with how globals are referenced elsewhere in Payload.
This release contains important bug fixes and API improvements that enhance the stability and usability of Payload CMS.
Recommendation: All users should upgrade to v0.5.0, especially if you:
The API change for global operations requires code updates, but the migration is straightforward and will result in more consistent code.
Nested Arrays: Fixed an issue where moving nested arrays wasn't properly persisting row count, ensuring data integrity when rearranging complex nested structures.
Array Field Data: Resolved issues with handling empty indices within array field data, preventing potential data loss or corruption.
Admin Validation: Improved validation consistency within the admin interface, providing more reliable feedback to users.
Admin Thumbnails: Fixed support for absolute URLs within adminThumbnail configuration, allowing for more flexible image sourcing options.
Global Operations API Change: The Payload API for global find and update operations now uses slug instead of global as the key to find/update with, creating a more consistent developer experience.
Rich Text Editor Enhancement: When adding relationship elements to rich text fields, the cursor position is now saved, improving the editing experience.
ReadOnly Field Consistency: The readOnly property is now applied consistently within create and update operations, providing more predictable behavior across the admin interface.
No security fixes were mentioned in this release.
No specific performance improvements were highlighted in this release. The changes were primarily focused on feature enhancements, API improvements, and bug fixes.
Payload CMS v0.5.0 brings significant improvements to the developer and content editor experience through API refinements and bug fixes. The most notable change is the global operations API update, which now uses slug instead of global as the key identifier, creating a more consistent pattern across the system.
For content editors, the release addresses several pain points: nested arrays now maintain their row count when moved, rich text editing preserves cursor position when adding relationships, and validation is more consistent throughout the admin interface.
Developers will appreciate the more predictable behavior of readOnly fields and the ability to use absolute URLs in adminThumbnail configurations. While these changes may require small code updates, they contribute to a more robust and intuitive CMS.
Overall, this release focuses on quality-of-life improvements and bug fixes that enhance the reliability of Payload CMS without introducing major architectural changes.
