Home

>

Tools

>

Payload CMS

>

Releases

>

Release 1.7.1

Payload CMS Release: Release 1.7.1

Tag Name: v1.7.1

Release Date: 4/18/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.7.1 Release

This minor release adds important compatibility fixes for Next.js 13, resolves GraphQL variable passing issues, and introduces new configuration extension points that enable more flexible customization of your Payload CMS setup. These changes improve developer experience while maintaining backward compatibility.

Highlight of the Release

    • Added 'use client' directive for Next.js 13 compatibility
    • Fixed GraphQL variables not being passed properly
    • Introduced new configuration extension points for enhanced customization
    • Improved developer experience with more flexible configuration options

Migration Guide

No migration steps are required for this release. The changes are backward compatible and should work seamlessly with existing Payload CMS implementations.

If you're using Next.js 13 with the app directory structure:

  • The 'use client' directive has been added to relevant components
  • No additional configuration is needed to maintain compatibility

For developers using the GraphQL API:

  • The fix for GraphQL variables is applied automatically
  • Existing GraphQL queries and mutations should now work correctly without modifications

For those interested in using the new configuration extension points:

  • Review the updated documentation for implementation details
  • Existing configurations will continue to work without changes

Upgrade Recommendations

This is a recommended upgrade for all Payload CMS users, especially for:

  • Developers using Next.js 13 with the app directory structure
  • Users experiencing issues with GraphQL variable passing
  • Anyone looking to leverage the new configuration extension capabilities

The upgrade is low-risk as it contains targeted bug fixes and backward-compatible feature additions. To upgrade, simply update your Payload CMS package to version 1.7.1:

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

No configuration changes are required after upgrading.

Bug Fixes

Next.js 13 Compatibility

  • Added the 'use client' directive to components for compatibility with Next.js 13's app directory structure
  • Ensures Payload components work properly in the client-side rendering context of Next.js 13

GraphQL Variables Fix

  • Resolved an issue where GraphQL variables were not being passed properly to queries and mutations
  • Fixed data handling in GraphQL operations, ensuring variables are correctly processed
  • Improves reliability of GraphQL API interactions

New Features

Configuration Extension Points

This release introduces new configuration extension points that allow developers to customize Payload CMS more extensively:

  • Added the ability to extend Payload's configuration in more flexible ways
  • Introduced custom field extensions to the core configuration
  • Improved plugin development capabilities through these extension points
  • Enhanced documentation for custom field implementation

These extension points make Payload more adaptable to specific project requirements and enable plugin developers to create more powerful integrations.

Security Updates

No security fixes were explicitly mentioned in this release. The changes are focused on compatibility improvements, bug fixes, and feature enhancements rather than security vulnerabilities.

Performance Improvements

No specific performance improvements were mentioned in this release. The changes focus primarily on compatibility, bug fixes, and feature enhancements rather than performance optimizations.

Impact Summary

Payload CMS v1.7.1 is a maintenance release with important compatibility improvements and feature additions. The Next.js 13 compatibility fix ensures developers can use Payload components within the new app directory structure. The GraphQL variables fix resolves data passing issues that may have affected API operations. The new configuration extension points expand Payload's customization capabilities, particularly beneficial for plugin developers and complex implementations.

This release maintains backward compatibility while addressing specific pain points and enhancing the developer experience. The changes are focused on improving stability and flexibility rather than introducing breaking changes or major new functionality.

Full Release Notes

1.7.1 (2023-04-18)

Bug Fixes

  • adds 'use client' for next 13 compatibility (5e02985)
  • graphql variables not being passed properly (72be80a)

Features

  • configuration extension points (023719d)

Statistics:

File Changed42
Line Additions363
Line Deletions239
Line Changes602
Total Commits7

User Affected:

  • Can now use Payload components in Next.js 13 with the 'use client' directive
  • Better compatibility with the Next.js 13 app directory structure

Contributors:

jmikrutdenolfeteunmooij