HomeContent Toolkit Logo

Content Toolkit

Home

>

Tools

>

Payload CMS

>

Releases

>

Release 1.0.28

Payload CMS Release: Release 1.0.28

Tag Name: v1.0.28

Release Date: 8/29/2022

View Release
Payload CMS LogoPayload CMS

Payload 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.

Open SourceDeveloper-FriendlyHeadless

TL;DR

PayloadCMS v1.0.28 brings important bug fixes and feature enhancements to improve developer experience and system stability. Key improvements include relationship field validation, better TypeScript support, and fixes for UI issues with arrays, blocks, and unpublishing. This release focuses on making PayloadCMS more robust while maintaining backward compatibility.

Highlight of the Release

    • Fixed UI crash when unpublishing items
    • Improved relationship field validation and loading performance
    • Enhanced TypeScript support with more exported types
    • Fixed issues with nested unnamed fields
    • Added validation for relationship and upload IDs

Migration Guide

No breaking changes were introduced in this release, so no migration is required. The changes are backward compatible and should work with existing PayloadCMS implementations.

If you're using custom components with TypeScript, you may want to review your type definitions as this release allows for more flexible prop types.

Upgrade Recommendations

This release is recommended for all PayloadCMS users as it contains important bug fixes and feature enhancements without introducing breaking changes. The improvements to TypeScript support, field validation, and UI stability make this a valuable upgrade.

To upgrade:

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

After upgrading, test your application thoroughly, especially if you're using relationship fields, array fields, block fields, or custom components with TypeScript.

Bug Fixes

UI and Rendering Fixes

  • Fixed UI crash when unpublishing items
  • Removed lazy loading of array and block components to improve reliability
  • Fixed relationship cell loading issues with items in viewport
  • Fixed collection list page parameter changing

Field Configuration and Validation

  • Made blocks required in block fields
  • Made fields required in array fields
  • Fixed incorrect field paths when nesting unnamed fields (issue #976)

Request Handling

  • Now keeping original request properties and adding to them instead of copying, improving compatibility with Node 15+

New Features

Enhanced TypeScript Support

  • Exported more field configuration types and validation types, improving developer experience when working with TypeScript
  • Custom components can now accept any props, providing greater flexibility for developers

Improved Field Validation

  • Added validation for relationship and upload IDs, ensuring data integrity
  • Frontend validation for relationship and upload IDs is skipped, maintaining performance

Developer Experience Improvements

  • Exported PayloadHandler interface for better TypeScript integration
  • CI improvements with GitHub Actions now running on PRs

Security Updates

No specific security fixes were mentioned in this release.

Performance Improvements

UI Performance

  • Improved relationship cell loading by optimizing how items in the viewport are loaded
  • Removed lazy loading of array and blocks components, which was causing rendering issues

Request Handling

  • Optimized request handling by keeping original request properties and adding to them instead of copying, which is more efficient and compatible with newer Node.js versions

Impact Summary

PayloadCMS v1.0.28 is a maintenance release that focuses on bug fixes and quality-of-life improvements for developers. The release addresses several UI issues, enhances TypeScript support, and improves field validation.

For developers, the enhanced TypeScript support and exported types will make development more robust. The ability to use any props with custom components provides greater flexibility when extending PayloadCMS.

Content editors will benefit from fixed UI issues, particularly the fix for UI crashes when unpublishing items and improved relationship field loading.

System administrators will appreciate the improved stability and CI/CD integration.

Overall, this release makes PayloadCMS more stable and developer-friendly without introducing breaking changes or requiring migration efforts.

Full Release Notes

1.0.28 (2022-08-29)

Bug Fixes

  • incorrect field paths when nesting unnamed fields (#1011) (50b0303), closes #976
  • relationship cell loading (#1021) (6a3cfce)
  • remove lazy loading of array and blocks (4900fa7)
  • require properties in blocks and arrays fields (#1020) (6bc6e7b)
  • unpublish item will not crash the UI anymore (#1016) (0586d7a)

Features

  • export more fields config types and validation type (#989) (25f5d68)
  • types custom components to allow any props (#1013) (3736755)
  • validate relationship and upload ids (#1004) (d727fc8)

Statistics:

File Changed101
Line Additions1,852
Line Deletions1,343
Line Changes3,195
Total Commits23

User Affected:

  • Better TypeScript support with exported field config types and validation types
  • Improved relationship and upload field validation
  • Fixed issues with nested unnamed fields
  • More flexibility with custom components through improved typing

Contributors:

denolfecharkourjmikrutDanRibbensjacobsfletchhunghvu