Payload CMS Release: 3.0.0-beta.32

TL;DR

PayloadCMS 3.0.0-beta.32 introduces significant enhancements to the rich text editor, improves server-side component props, and consolidates admin routes configuration. This release includes breaking changes that affect custom React Server Components and admin route configuration, requiring migration steps for existing implementations. The update also fixes GraphQL issues with upload relations and draft values.

Highlight of the Release

• Added rootFeatures prop to Lexical rich text editor for enhanced customization
• Improved server-side component props with additional context like i18n, locale, and user data
• Consolidated admin route configuration with new admin.routes structure
• Fixed GraphQL issues with upload relations and draft values

Migration Guide

Migrating Server Components

If you use any of the following components in your project, you'll need to update them to accept additional server-only props:

• Account view
• Default Dashboard view
• DefaultTemplate
• WithServerSideProps
• RenderCustomComponent (optional)
• Logo

Previously, these components only required the payload prop. Now they need additional server-side props as detailed in the release notes.

If you're using an HOC as a custom component that passes props to client components, you'll need to either:

• Use the withMergedProps helper to automatically filter out server-only props
• Mark your HOC with 'use client' directive

Migrating Admin Routes Configuration

To migrate from the old route configuration to the new structure:

Old way:

// payload.config.ts
{ 
  // ...
  admin: {
    logoutRoute: '/custom-logout',
    inactivityRoute: '/custom-inactivity'
  }
}

New way:

// payload.config.ts
{
  // ...
  admin: {
    routes: {
      logout: '/custom-logout',
      inactivity: '/custom-inactivity'
    }
  }
}

Upgrade Recommendations

For developers using PayloadCMS in beta environments or projects that can tolerate breaking changes:

• Upgrade to 3.0.0-beta.32 to take advantage of the new features and bug fixes
• Follow the migration guide to update your custom components and admin route configurations

For production environments:

• Test the upgrade thoroughly in a staging environment before deploying
• Pay special attention to custom React Server Components and admin route configurations
• If you use GraphQL with upload relations, verify that draft values are handled correctly after the upgrade

This release contains breaking changes, so be prepared to make the necessary code adjustments as outlined in the migration guide.

Bug Fixes

GraphQL Upload Relations Fix

Fixed an issue in GraphQL where upload relations weren't correctly handling draft values. This ensures that when querying related uploads through GraphQL, the system properly respects the draft status of those uploads, providing more consistent and expected results.

New Features

Enhanced Rich Text Editor

The Lexical rich text editor now supports a new rootFeatures prop, allowing for more granular customization of the editor's capabilities at the root level.

Improved Server Component Props

React Server Components now receive a more comprehensive set of server-side props:

• For components rendered outside buildComponentMap: i18n, locale, params, payload, permissions, searchParams, and user
• For components within buildComponentMap: i18n and payload

This provides more context and data to server components, enabling more powerful and flexible implementations.

Consolidated Admin Routes Configuration

Admin routes configuration has been streamlined with a new admin.routes object that consolidates previously separate route configurations into a single, more organized structure.

Security Updates

No security fixes were mentioned in this release.

Performance Improvements

No specific performance improvements were highlighted in this release. The changes are primarily focused on feature enhancements, bug fixes, and structural improvements to the codebase.

Impact Summary

This release introduces significant improvements to PayloadCMS's developer experience and component architecture. The enhanced server component props system provides more context and data to custom components, enabling more powerful implementations but requiring updates to existing code. The consolidated admin routes configuration simplifies the API but requires migration from the previous structure.

The addition of the rootFeatures prop to the Lexical rich text editor enhances customization options for content editing experiences. Meanwhile, the GraphQL fix for upload relations ensures more reliable handling of media assets in draft states.

Overall, this beta release continues to refine the architecture and developer experience of PayloadCMS 3.0, though it does require some migration effort due to the breaking changes.

Full Release Notes