Home

>

Tools

>

Payload CMS

>

Releases

>

Release 1.11.0

Payload CMS Release: Release 1.11.0

Tag Name: v1.11.0

Release Date: 7/5/2023

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.

TL;DR

Payload CMS v1.11.0 Release

This release brings important TypeScript improvements, bug fixes for rich text fields, block field access control, and GraphQL number field types. It enhances developer experience with better type safety for endpoint methods and error handling, while fixing several UI issues related to row IDs and relationship fields. The release also includes documentation updates for Payload Cloud.

Highlight of the Release

    • Improved TypeScript typing for endpoint methods and error handling
    • Fixed critical bug with nested rich text fields
    • Enhanced field-level access control within blocks
    • Fixed GraphQL type definitions for number fields
    • Added comprehensive Payload Cloud documentation

Migration Guide

No migration steps are required for this release. The changes are primarily bug fixes and TypeScript improvements that don't break existing functionality.

If you're using TypeScript with custom endpoint methods or error handling, you may benefit from the improved type definitions, but no code changes are necessary for compatibility.

Upgrade Recommendations

This release is recommended for all Payload CMS users, especially those who:

  • Use TypeScript in their projects
  • Work with rich text fields, particularly nested ones
  • Implement field-level access control within blocks
  • Use relationship fields with custom props
  • Work with GraphQL and number fields

The upgrade should be straightforward with no breaking changes reported. Update your Payload CMS version to v1.11.0 using your package manager:

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

Bug Fixes

UI and Field Fixes

  • Rich Text Field: Fixed a bug with nested rich text fields that was causing unexpected behavior (PR #2966)

  • Row IDs: Ensured that rows always have proper IDs, fixing UI inconsistencies and potential rendering issues (PR #2968)

  • Relationship Field: Fixed custom props handling in relationship fields, properly threading custom react-select props through the component (PR #2973)

Access Control and GraphQL

  • Block Field Access Control: Fixed an issue where fields within blocks weren't properly respecting field-level access control rules (PR #2969)

  • GraphQL Number Field Type: Corrected the GraphQL type definition for number fields, ensuring proper type validation and querying (PR #2954)

New Features

TypeScript Improvements

  • Narrower Endpoint Method Types: The endpoint.method type has been narrowed to provide more precise type checking, improving developer experience and reducing potential errors (PR #1880)

  • Enhanced Error Type Definitions: Improved typing of ExtendableError and APIError classes for better error handling and type safety throughout the application (PR #2864)

Template Enhancements

  • Added front-end components to the ecommerce template, making it more complete and ready to use out of the box

Documentation

  • Added comprehensive documentation for Payload Cloud
  • Fixed various documentation links and improved MDX formatting

Security Updates

No security fixes were explicitly mentioned in this release.

Performance Improvements

No specific performance improvements were highlighted in this release. The focus was primarily on bug fixes, TypeScript improvements, and documentation updates.

Impact Summary

Payload CMS v1.11.0 is a quality-focused release that improves developer experience through better TypeScript definitions and fixes several important bugs related to rich text fields, access control, and UI components.

The TypeScript improvements provide more precise type checking for endpoint methods and error handling, which will help catch potential issues during development rather than at runtime. This is particularly valuable for larger projects with complex API interactions.

The bug fixes address issues that could impact content editors' workflow, particularly those working with nested rich text fields or relationship fields with custom styling. The fix for field-level access control within blocks ensures that security policies are correctly applied throughout the application.

For GraphQL users, the correction to number field type definitions ensures proper schema validation and query execution. The documentation updates for Payload Cloud provide valuable resources for users of that platform.

Overall, this release enhances stability, type safety, and user experience without introducing breaking changes, making it a recommended upgrade for all Payload CMS users.

Full Release Notes

1.11.0 (2023-07-05)

Bug Fixes

  • ensures fields within blocks respect field level access control (#2969) (5b79067)
  • ensures rows always have id's (#2968) (04851d0)
  • GraphQL type for number field (#2954) (29d8bf0)
  • nested richtext bug and test (#2966) (801f609)
  • properly threads custom react-select props through relationship field (#2973) (79393e8)

Features

Statistics:

File Changed199
Line Additions8,498
Line Deletions1,296
Line Changes9,794
Total Commits19

User Affected:

  • Benefit from improved typing of ExtendableError and APIError for better error handling
  • Experience narrower and more precise endpoint.method type definitions
  • Get better type safety when working with the Payload API

Contributors:

jacobsfletchAlessioGrtylandavisjessrynkardenolfeJarrodMFleschDanRibbens