3.42.0

TL;DR

PayloadCMS v3.42.0 brings significant improvements to the rich text editor performance, adds Bangla translations, and enhances the import/export plugin with custom CSV transformation capabilities. This release also fixes several bugs in the rich text editors, improves documentation, and adds automatic creation of missing importmap files. Developers will benefit from better typing performance in the Lexical rich text editor and more robust handling of text state styling.

Highlight of the Release

• Significant performance improvements for typing in Lexical rich text editor with enabled toolbars
• Added Bangla translations for the admin panel
• New custom toCSV function for fields in the import/export plugin
• Automatic creation of missing importmap files
• Fixed text state CSS not being applied when multiple text state groups are present

Migration Guide

No breaking changes were introduced in this release, so no migration is required.

If you're using the import/export plugin with a custom jobs configuration, you may want to verify that the plugin is properly extending your jobs configuration after updating.

Upgrade Recommendations

This is a recommended upgrade for all users, especially those who:

• Use the Lexical rich text editor and experience performance issues during typing
• Need Bangla language support
• Use the import/export plugin and need custom CSV transformation capabilities
• Have encountered any of the bugs fixed in this release

The upgrade should be straightforward with no breaking changes. Simply update your dependencies to v3.42.0:

npm install payload@3.42.0
# or
yarn add payload@3.42.0
# or
pnpm add payload@3.42.0

If you're using PayloadCMS plugins, make sure to update those as well to maintain compatibility.

Bug Fixes

Rich Text Editor Fixes

• Lexical Editor: Fixed a runtime error that occurred when using TextStateFeature without props. While not intended to be used without props, it now gracefully handles this case.
• Text State CSS Application: Resolved an issue where text state CSS was not being applied correctly when multiple text state groups were present. The fix ensures that styles from different groups don't overwrite each other.
• Slate Editor: Added 'li' string literal to RichTextElement type, fixing type errors when working with list items.

Import/Export Plugin Fixes

• Jobs Configuration: Fixed incorrect config extension of jobs in the import/export plugin that was causing validation errors.

Translation Fixes

• Folder Movement i18n: Corrected the dynamic variable name for 'movingFromFolder' in translations from {{folderName}} to {{fromFolder}} to ensure proper value retrieval.

Other Fixes

• Globals Version Cleanup: Implemented proper cleanup of globals max versions to prevent memory leaks.
• Form Builder Plugin: Fixed missing export of the DateField type.

New Features

Import/Export Plugin Enhancements

• Custom toCSV Function: Added ability to define custom transformation logic for converting document data to CSV format on a field-by-field basis. This allows for more flexible data exports with custom formatting.
• Debug Logging Option: Added debug logging capabilities to help troubleshoot import/export operations.

Translations

• Bangla Language Support: Added complete Bangla (Bengali) translations for the admin panel, making PayloadCMS more accessible to Bengali-speaking users.
• Improved zh-TW Translations: Revised Traditional Chinese (Taiwan) translations for the import/export plugin to improve wording and consistency.

System Improvements

• Auto-create importmap.js: The system now automatically creates the importmap file if it's missing and the location can be found, preventing errors during startup.
• Route Parameters in Views: Added routeParams to the request object on views, making these parameters accessible in custom components.

Form Builder Plugin

• Exported DateField Type: The DateField type is now properly exported from the form builder plugin, allowing for better TypeScript integration.

Security Updates

No security fixes were included in this release.

Performance Improvements

Rich Text Editor Optimizations

• Lexical Editor Typing Performance: Significantly improved typing performance when toolbars are enabled in the Lexical rich text editor. This was achieved through:
  • Deprioritizing state calculations using useDeferredValue and requestIdleCallback
  • Adding additional memoization to reduce unnecessary re-renders
  • Replacing inefficient useEffect hooks with more optimized solutions

This improvement is particularly noticeable on slower machines or when working with complex documents, resulting in a much smoother typing experience.

Development Workflow

• Turbopack by Default: Enabled Turbopack by default in the monorepo, which provides faster development server startup and module rebuilds. This change was made after no issues were reported with Turbopack usage.

Impact Summary

PayloadCMS v3.42.0 delivers notable improvements to both developer and content editor experiences. The most impactful change is the significant performance optimization in the Lexical rich text editor, making typing much smoother when toolbars are enabled - a common pain point for content editors on slower machines.

For developers, the addition of custom CSV transformation functions in the import/export plugin provides greater flexibility when exporting data, while the automatic creation of missing importmap files removes a potential source of startup errors.

The addition of Bangla translations expands PayloadCMS's accessibility to Bengali-speaking users, continuing the CMS's commitment to internationalization.

Several quality-of-life bug fixes are included, such as fixing text state CSS application when multiple state groups are present, correcting translation variable names, and properly exporting types from the form builder plugin.

Overall, this release focuses on performance, developer experience, and internationalization without introducing breaking changes, making it a recommended upgrade for all users.

Full Release Notes