TL;DR

Payload CMS v0.8.0 introduces important TypeScript configuration improvements with revised naming conventions for config types and exposed validated config types. This release enhances developer experience with better type safety and consistency while fixing a critical issue with the text component to ensure it always remains controlled.

Highlight of the Release

• Revised naming conventions for configuration types in TypeScript
• Exposed validated configuration types for better developer experience
• Fixed text component to ensure it always functions as a controlled component

Migration Guide

for v0.8.0

TypeScript Type Naming Changes

If your project relies on Payload's TypeScript types, you may need to update your imports and type references to match the new naming conventions. The core functionality remains the same, but type names have been revised for better consistency.

Example of potential changes:

// Before v0.8.0
import { SomeConfigType } from 'payload/config';

// After v0.8.0
import { ValidatedSomeConfigType } from 'payload/config';

Refer to the updated TypeScript documentation for specific details on the new type naming conventions and how to properly use the validated config types.

Upgrade Recommendations

This release is recommended for all Payload CMS users, especially those using TypeScript in their projects.

• TypeScript Users: Strongly recommended to upgrade to benefit from improved type definitions and exposed validated config types.

• All Users: Recommended to upgrade to ensure text components function correctly as controlled components in all scenarios.

To upgrade:

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

After upgrading, TypeScript users should review any code that relies on Payload's type definitions and update as needed to match the new naming conventions.

Bug Fixes

Text Component Fix

• Fixed an issue where the text component wasn't consistently functioning as a controlled component in all scenarios (c649362)

• This ensures more reliable form handling and prevents potential issues with data synchronization between the component state and form values

New Features

TypeScript Configuration Improvements

• Revised Naming Conventions: Configuration types have been renamed to follow more consistent patterns, improving code readability and maintainability (5a7e5b9)

• Exposed Validated Config Types: Developers can now access the validated configuration types directly, providing better type safety when working with Payload configurations

• Enhanced TypeScript Documentation: Added comprehensive documentation for TypeScript configurations to help developers understand and utilize the type system effectively

Security Updates

No security fixes were mentioned in this release.

Performance Improvements

No specific performance improvements were mentioned in this release.

Impact Summary

Payload CMS v0.8.0 primarily focuses on improving the TypeScript developer experience through revised naming conventions for configuration types and exposing validated config types. This change enhances type safety and code consistency for TypeScript users but may require updates to existing codebases that rely on the previous type naming patterns.

The release also includes an important bug fix for the text component, ensuring it always functions as a controlled component. This improves reliability in form handling and prevents potential data synchronization issues.

While this release doesn't introduce major new features, the TypeScript improvements represent a significant step forward for developer experience and code maintainability in Payload projects. The changes lay groundwork for more robust type checking and better developer tooling in future releases.

Full Release Notes