payload

v3.0.0-beta.60 (2024-07-10)

Features

• plugin-search: make search collection fields override into a function that provides defaultFields inline with other plugins (#7095) (2bc8666)
• cpa: add website template to CPA (#7079) (c1c12bc)
• replace qs with qs-esm (#6966) (6c99326)
• storage-azure: expose storage client (#7069) (f46ea01)
• richtext-lexical: remove unused json-schema dependency (#7072) (376a651)
• updated admin panel color palette (#7011) (c2022f6)

Bug Fixes

• ui: tooltips for fields rendered outside RenderFields not positioned correctly (#7074) (bd5f5a2)
• exports getSiblingData, getDataByPath, and reduceFieldsToValues from payload (#7070) (0a2ecf8)
• graphql query concurrency issues (#6925) (fb72d19)
• plugin-form-builder: make fields optional type in overrides (#7062) (cd9df73)
• plugin-redirects: make fields optional type in overrides (#7061) (b7acfe5)

BREAKING CHANGES

• plugin-search: make search collection fields override into a function that provides defaultFields inline with other plugins (#7095) (2bc8666)

  searchPlugin's searchOverrides for the collection now takes in a fields
  function instead of array similar to other plugins and patterns we use
  to allow you to map over existing fields as well if needed.

  // before
  searchPlugin({
    searchOverrides: {
      slug: 'search-results',
      fields: [
        {
          name: 'excerpt',
          type: 'textarea',
          admin: {
            position: 'sidebar',
          },
        },
      ]
    },
  }),
  
  // current
  searchPlugin({
    searchOverrides: {
      slug: 'search-results',
      fields: ({ defaultFields }) =[
        ...defaultFields,
        {
          name: 'excerpt',
          type: 'textarea',
          admin: {
            position: 'sidebar',
          },
        },
      ]
    },
  }),
  

• exports getSiblingData, getDataByPath, and reduceFieldsToValues from payload (#7070) (0a2ecf8)

  Exports getSiblingData, getDataByPath, reduceFieldsToValues, and
  unflatten from payload. These utilities were previously accessible
  using direct import paths from @payloadcms/ui—but this is no longer
  advised since moving to a pre-bundled UI library pattern. Instead of
  simply exporting these from the @payloadcms/ui package, these exports
  have been moved to Payload itself to provision for use outside of React
  environments.

  This is considered a breaking change. If you were previously importing
  any of these utilities, the imports paths have changed as follows:

  Old:

  import { getSiblingData, getDataByPath, reduceFieldsToValues } from '@payloadcms/ui/forms/Form'
  import { unflatten } from '@payloadcms/ui/utilities'
  

  New:

  import { getSiblingData, getDataByPath, reduceFieldsToValues, unflatten } from 'payload/shared'
  

  The is-buffer dependency was also removed in this PR.

• updated admin panel color palette (#7011) (c2022f6)

  Color values have changed and will have different
  contrasts. If you use any of Payload's colors in your apps, you may need
  to adjust your use of them to maintain proper styling/accessibility.

  Colors palettes changed:

  • --theme-success-*
  • --theme-error-*
  • --theme-warning-*
  • --color-success-*
  • --color-error-*
  • --color-warning-*
  • --color-blue-*

  Updates the color palette used throughout Payload to be more consistent
  between dark and light values. Contrast values are now more in line with
  the theme-elevation contrasts. Some adjustments to the Toast
  components as well to match light/dark mode better.

v3.0.0-beta.59 (2024-07-08)

Features

• support latest Next.js versions, fix server-only props being passed to Client Document Views (#7026) (1cf7d4d)
• ui: support nested tabs, groups, collapsibles and rows in where filters in list view (#7044) (b6d85f6)
• avoid unnecessary config await in getPayloadHMR (#7045) (187813e)

Bug Fixes

• richtext-lexical: avoid conflicts between internal component/schema map paths and field names (#7042) (16c1d94)

BREAKING CHANGES

• support latest Next.js versions, fix server-only props being passed to Client Document Views (#7026) (1cf7d4d)

BREAKING: The minimum required Next.js version has been bumped from
15.0.0-rc.0 to 15.0.0-canary.53. This is because the way client
components are represented changed somewhere between those versions, and
it is not feasible to support both versions in our RSC detection logic.

Contributors

• Alessio Gravili (@AlessioGr)
• Wilson (@WilsonLe)
• Paul (@paulpopus)

v3.0.0-beta.58 (2024-07-03)

Features

• richtext-lexical: add EXPERIMENTAL_TableFeature, allow Client Features to register providers (#7010) (93bdc0e)

Bug Fixes

• ensures req has headers, passes it through in view rendering (#7012) (4a8d3a0)

Contributors

• Jacob Fletcher (@jacobsfletch)
• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.57 (2024-07-02)

Features

• ui: allows filtering on group and tab fields from list controls (#6647) (d4d4101)
• richtext-lexical: upgrade lexical from 0.16.0 to 0.16.1 (#7009) (2a2ab53)
• allow users/plugins to modify and extend generated types for fields & config, add generated types for json field (#6984) (eb2f763)
• adds loginWithUsername option to auth config (#7000) (955b845)
• plugin-seo: export fields from plugin seo so that they can be imported freely in a collection fields config (#6996) (25d368a)
• ui: export iterateFields function (#6995) (cce1397)
• export missing utilities and types from payload (#6993) (d05a033)
• plugin-seo: russian translations (#6987) (2285624)

Bug Fixes

• richtext-lexical: auto link node escapes on second "." (98ff746)
• ui: content alignment in modal (#7003) (fd7d500)
• translation fallback language returning the label and not the language key (#7001) (9ab057d)

BREAKING CHANGES

• richtext-lexical: upgrade lexical from 0.16.0 to 0.16.1 (#7009) (2a2ab53)

BREAKING: Lexical may introduce undocumented breaking changes, if
you use the lexical API directly. Please consult their changelog:
https://github.com/facebook/lexical/releases/tag/v0.16.1

• simplify api handler (#6910) (0711f88)

Removes PayloadRequestWithData in favour of just PayloadRequest with
optional types for data and locale

addDataAndFileToRequest and addLocalesToRequestFromData now takes in
a single argument instead of an object

// before
await addDataAndFileToRequest({ request: req })
addLocalesToRequestFromData({ request: req })

// current
await addDataAndFileToRequest(req)
addLocalesToRequestFromData(req)

Contributors

• Jessica Chowdhury (@JessChowdhury)
• Alessio Gravili (@AlessioGr)
• Ritsu (@r1tsuu)
• Paul (@paulpopus)
• Jarrod Flesch (@JarrodMFlesch)
• Harley Salas (@HarleySalas)

2.23.1 (2024-06-28)

Bug Fixes

• remove unused refresh arg, this affected me/refresh hooks (#6976) (c82d2ca)

2.23.0 (2024-06-28)

Features

• adds me and refresh hooks (#6968) (c82d2ca)

Bug Fixes

• richtext-lexical: html converters unnecessarily growing over time (#6963) (cf52d64)

v3.0.0-beta.56 (2024-06-28)

Features

• richtext-lexical: simplify schemaMap handling (#6980) (368dd2c)
• show detailed validation errors in console (#6551) (8f346df)
• richtext-lexical: export SerializedHeadingNode, add default node types (#6978) (75a3040)
• ui: expose CheckboxInput, SelectInput and DatePicker (#6972) (9cdcf20)
• next: allows auth strategies to return headers that need to be… (#6964) (37e2da0)
• adds refresh hooks (#6965) (07f3f27)
• richtext-lexical: new FieldsDrawer utility, improve blocks feature performance (#6967) (0017c67)
• richtext-lexical: new FieldsDrawer utility (0a42281)
• ui: export SaveButton / SaveDraftButton components (#6952) (4404a3c)
• richtext-lexical: upgradeLexicalData function (#6949) (8e232e6)

Bug Fixes

• plugin-seo: data types plugin seo (#6979) (559c064)
• richtext-lexical: remove unnecessary JSON.parse(JSON.stringify()) of blocks feature formData (69a42fa)
• properly cases custom collection components (#6948) (70957b0)

BREAKING CHANGES

• show detailed validation errors in console (#6551) (8f346df)

ValidationError now requires the global or collection slug, as well as an errors property. The actual errors are no longer at the top-level.

• plugin-seo: data types plugin seo (#6979) (559c064)

Changed the data to correctly match type generic being sent to the
generate functions. So now you can type your generateTitle etc.
functions like this

// before
const generateTitle: GenerateTitle = async <Page>({ doc, locale }) => {
  return `Website.com — ${doc?.title?.value}`
}


// curent
import type { GenerateDescription, GenerateTitle, GenerateURL } from '@payloadcms/plugin-seo/types'
import type { Page } from './payload-types'

const generateTitle: GenerateTitle<Page> = async ({ doc, locale }) => {
  return `Website.com — ${doc?.title}`
}

const generateDescription: GenerateDescription<Page> = async ({ doc, locale }) => {
  return doc?.excerpt || 'generated description'
}

const generateURL: GenerateURL<Page> = async ({ doc, locale }) => {
  return `https://yoursite.com/${locale ? locale + '/' : ''}${doc?.slug || ''}`
}

Breaking change because it was previously a FormState value.

• next: allows auth strategies to return headers that need to be… (#6964) (37e2da0)

Some authentication strategies may need to set headers for responses,
such as updating cookies via a refresh token, and similar. This PR
extends Payload's auth strategy capabilities with a manner of
accomplishing this.

This is a breaking change if you have custom authentication strategies
in Payload's 3.0 beta. But it's a simple one to update.

Instead of your custom auth strategy returning the user, now you must
return an object with a user property.

This is because you can now also optionally return responseHeaders,
which will be returned by Payload API responses if you define them in
your auth strategies. This can be helpful for cases where you need to
set cookies and similar, directly within your auth strategies.

Before:

return user

After:

return { user }

• properly cases custom collection components (#6948) (70957b0)

Properties within the Custom Collection Components config were not
properly cased. In the Payload Config, there are places where we expose
an array of Custom Components to render. These properties should be
cased in camelCase to indicate that its type is not a component,
but rather, it's an array of components. This is how all other
arrays are already cased throughout the config, therefore these
components break exiting convention. The CapitalCase convention is
reserved for components themselves, however, fixing this introduces a
breaking change. Here's how to migrate:

Old:

{
 // ...
 admin: {
   components: {
     AfterList: [],
     AfterListTable: [],
     BeforeList: [],
     BeforeListTable: [],
   }
  }
}

New:

{
 // ...
 admin: {
   components: {
     afterList: [],
     afterListTable: [],
     beforeList: [],
     beforeListTable: [],
   }
 }
}

The docs were also out of date for the Root-level Custom Components.
These components are documented in CaptalCase but are in fact cased
correctly in Payload. This PR fixes that.

Contributors

• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Paul (@paulpopus)
• James Mikrut (@jmikrut)
• Frederic Perron (@FredPerr)
• Ritsu (@r1tsuu)
• Jacob Fletcher (@jacobsfletch)
  &prerelease=1

v3.0.0-beta.55 (2024-06-26)

Features

• richtext-lexical: new slate => lexical migration function which migrates all your documents at once (#6947) (5105676)
• add the ability to pass in a response to upload handlers (#6926) (6b7ec6c)
• ability to pass uploadActions to the Upload component (#6941) (35eb16b)
• ability to add custom upload component (#6927) (d8d5a44)
• richtext-lexical: improve lexical types (#6928) (0b2be54)

Bug Fixes

• richtext-lexical: properly set heading level translation for nb and pl (#6900) (abf6e9a)
• auth strategy exp (#6945) (5ffc5a1)
• should not display create/login view with disableLocalStrategy: true (#6940) (c34aa86)

Contributors

• Alessio Gravili (@AlessioGr)
• Anders Semb Hermansen (@andershermansen)
• James Mikrut (@jmikrut)
• Jacob Fletcher (@jacobsfletch)
• Jarrod Flesch (@JarrodMFlesch)
• Jessica Chowdhury (@JessChowdhury)

2.22.2 (2024-06-26)

Bug Fixes

• return exp and strategy from auth (#6943) (ea18735)

v3.0.0-beta.54 (2024-06-25)

Features

• replace bloated deep-equal dependency and minimize usage of qs (#6912) (2920a5d)
• various type improvements (#6385) (ccbaee4)
• richtext-lexical: properly define client-only and server-only exports (#6890) (8f977b9)
• richtext-lexical: simplify creation of features (#6885) (d66b348)

Bug Fixes

• ui: standardizes named field exports (#6907) (776e3f7)
• payload, ui: sends cropped image pixel values to server instead of percent values (#6903) (e782d99)
• prevent dependency version checker finding node_modules outside the project (#6892) (7333706)
• update select options when the options prop changes (#6878) (8773e3a)
• adjusts json field defaultValue joi validation (#6873) (6ba619f)
• allow req mutation inside upload handlers (#6855) (62b1332)

BREAKING CHANGES

• various type improvements (#6385) (ccbaee4)

  • Type narrowing for relationTo props on filterOptions, relationship
    fields and upload fields
  • Type narrowing for arguments of lexical relationship, link and upload
    features

• ui: standardizes named field exports (#6907) (776e3f7)

Standardizes all named field exports. This improves semantics when using these components by appending Field onto the end of their names. Some components were already doing this, i.e. ArrayField and BlocksField. Now, all field components share this same convention. And since bundled components were already aliasing most exports in this way, this change will largely go unnoticed because most apps were already importing the correctly named components. What is ultimately means is that there was a mismatch between the unbundled vs bundled exports. This PR resolves that conflict. But this also introduces a potentially breaking change for your app. If your app is using components that import from the unbundled @payloadcms/ui package, those import paths likely changed:

Old:

import { Text } from '@payloadcms/ui/fields/Text'

New:

import { TextField } from '@payloadcms/ui/fields/Text'

If you were importing direcetly from the bundled version, you're
imports likely have not changed. For example:

This still works (the import path is top-level, pointing to the
bundled code):

import { TextField } from '@payloadcms/ui'

• richtext-lexical: properly define client-only and server-only exports (#6890) (8f977b9)

A bunch of exports have been moved around. There are now two of them: @payloadcms/richtext-lexical and @payloadcms/richtext-lexical/client. The root export is server-only. If any imports don't resolve anymore after this version, simply change the import to one of those, depending on if you are on the server or the client

• richtext-lexical: simplify creation of features (#6885) (d66b348)

  • ServerFeature: ClientComponent has been renamed to ClientFeature
  • ServerFeature: The nested serverFeatureProps has been renamed to
    sanitizedServerFeatureProps
  • ServerFeature: The FeatureProviderProviderServer type now expects 3
    generics instead of 2. We have split the props generic into sanitized &
    unsanitized props
  • ClientFeature: The FeatureProviderProviderClient type now expects 2
    generics instead of 1. We have split the props generic into sanitized &
    unsanitized props
  • ClientFeature: The nested clientFeatureProps has been renamed to
    sanitizedClientFeatureProps

Contributors

• Alessio Gravili (@AlessioGr)
• James Mikrut (@jmikrut)
• Jacob Fletcher (@jacobsfletch)
• Patrik (@PatrikKozak)
• Jarrod Flesch (@JarrodMFlesch)

2.22.1 (2024-06-25)

Bug Fixes

• graphql query concurrency issues (#6857) (bb911cc)
• sends cropped image pixel values to server instead of percent values (#6852) (8747743)

2.22.0 (2024-06-20)

Features

• passes prev value through to validate functions (#6805) (0a51de7)

Bug Fixes

• adjust json field schema for defaultValue (#6872) (58427ff)
• array row validation messages (#6780) (68ea693)
• cannot use empty string in defaultValue on text-like fields (#6842) (3364385)
• corrects redirect with lonely slash on login (#6784) (dae56e6)
• db-postgres: cascade delete FKs on hasMany relationships (#6735) (9ecc6c8)
• payload, db-mongodb: querying relationships with in & not_in (#6773) (f6ba3be), closes #6741
• plugin-cloud-storage: missing error handling for invalid plugin config, leading to unexpected webpack errors (#6786) (015aafd)
• ui: withinCollapsible always false from useCollapsible provider (#6783) (9f0aaf0), closes #6760
• unflattening json objects containing keys with periods (#6834) (025306f), closes #5378
• upgrade swc, fixing swc issues on linux (#6809) (1c986a9)

v3.0.0-beta.53 (2024-06-19)

Features

• richtext-lexical: make req available to html converters, use req.dataLoader instead of payload.findByID for upload node population (#6858) (285835f)
• rename @payloadcms/ui/client to @payloadcms/ui, and other auto-suggestion & exports improvements (#6848) (bc98567)

Bug Fixes

• fix all ui imports in our plugins, and get rid of ui subpath exports within monorepo (#6854) (aef2a52)
• cannot use empty strings defaultValue in text-like fields (#6847) (317bc07)
• ui: unflattening json objects containing keys with periods (#6839) (3ddc2a0)

BREAKING CHANGES

• rename @payloadcms/ui/client to @payloadcms/ui, and other auto-suggestion & exports improvements (#6848) (bc98567)

BREAKING: All @payloadcms/ui/client exports have been renamed to
@payloadcms/ui. A simple find & replace across your entire project
will be enough to migrate. This change greatly improves import
auto-completions in IDEs which lack proper support for package.json
exports, like Webstorm.

Contributors

• Alessio Gravili (@AlessioGr)
• Dan Ribbens (@DanRibbens)
• Elliot DeNolf (@denolfe)
• Patrik (@PatrikKozak)

v3.0.0-beta.52 (2024-06-18)

Features

• payload, richtext-lexical: runtime dependency checks (#6838) (bf374a2)

Bug Fixes

• payload: generated types issues (#6840) (cf50eab)
• templates: set correct minimum node version in package.json engines (#6835) (223d726)

Contributors

• James Mikrut (@jmikrut)
• Alessio Gravili (@AlessioGr)

v3.0.0-beta.51 (2024-06-18)

Bug Fixes

• ui: react-datepicker inserting invalid require("react") calls in our bundle (#6833) (b7d5a6a)
• generated template imports (#6832) (040893f)
• corrects permission access reading for disabling fields (#6815) (cedd916)

Contributors

• Alessio Gravili (@AlessioGr)
• Elliot DeNolf (@denolfe)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.50 (2024-06-17)

Bug Fixes

• richtext-*: do not use different version of faceless-ui by importing prebundled faceless-ui from ui (#6816) (35a5d0c)
• ui: basePath not handled for logout route (#6817) (47ee40a)

Contributors

• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)

v3.0.0-beta.49 (2024-06-17)

Features

• prebundle payload, ui, richtext-lexical (#6579) (9e76c8f)

🚧 BREAKING CHANGES

• prebundle payload, ui, richtext-lexical (#6579) (9e76c8f)

New file import locations

Exports from the payload package have been significantly cleaned up. Now, just about everything is able to be imported from payload directly, rather than an assortment of subpath exports. This means that things like import { buildConfig } from 'payload/config' are now just imported via import { buildConfig } from 'payload'. The mental model is significantly simpler for developers, but you might need to update some of your imports.

Payload now exposes only three exports:

1. payload - all types and server-only Payload code
2. payload/shared - utilities that can be used in either the browser or in Node environments
3. payload/node - heavy utilities that should only be imported in Node scripts and never be imported into bundled code like Next.js

UI library pre-bundling

With this release, we've dramatically sped up the compile time for Payload by pre-bundling our entire UI package for use inside of the Payload admin itself. There are new exports that should be used within Payload custom components:

1. @payloadcms/ui/client - all client components
2. @payloadcms/ui/server - all server components

For all of your custom Payload admin UI components, you should be importing from one of these two pre-compiled barrel files rather than importing from the more deeply nested exports directly. That will keep compile times nice and speedy, and will also make sure that the bundled JS for your admin UI is kept small.

For example, whereas before, if you imported the Payload Button, you would have imported it like this:

import { Button } from '@payloadcms/ui/elements/Button'

Now, you would import it like this:

import { Button } from '@payloadcms/ui/client'

This is a significant DX / performance optimization that we're pretty pumped about.

However, if you are importing or re-using Payload UI components outside of the Payload admin UI, for example in your own frontend apps, you can import from the individual component exports which will make sure that the bundled JS is kept to a minimum in your frontend apps. So in your own frontend, you can continue to import directly to the components that you want to consume rather than importing from the pre-compiled barrel files.

Individual component exports will now come with their corresponding CSS and everything will work perfectly as-expected.

Specific exports have changed

• '@payloadcms/ui/templates/Default' and '@payloadcms/ui/templates/Minimal' are now exported from '@payloadcms/next/templates'
• Some components are now more explicitly named while being exported, such as the LogOut icon. Old: import { LogOut } from '@payloadcms/ui/icons/LogOut' New: import { LogOutIcon } from '@payloadcms/ui/icons/LogOut'

Background info

In effort to make local dev as fast as possible, we need to import as few files as possible so that the compiler has less to process. One way we've achieved this in the Admin Panel was to remove all .scss imports from all components in the @payloadcms/ui module using a build process. This stripped all import './index.scss' statements out of each component before injecting them into dist. Instead, it bundles all of the CSS into a single main.css file, and we import that at the root of the app.

While this concept is still the right solution to the problem, this particular approach is not viable when using these components outside the Admin Panel, where not only does this root stylesheet not exist, but where it would also bloat your app with unused styles. Instead, we need to keep these .scss imports in place so they are imported directly alongside your components, as expected. Then, we need create a new build step that separately compiles the components without their stylesheets—this way your app can consume either as needed from the new client and server barrel files within @payloadcms/ui, i.e. from within @payloadcms/next and all other admin-specific packages and plugins.

This way, all other applications will simply import using the direct file paths, just as they did before. Except now they come with stylesheets.

And we've gotten a pretty awesome initial compilation performance boost.

Contributors

• James Mikrut (@jmikrut)
• Jacob Fletcher (@jacobsfletch)
• Alessio Gravili (@AlessioGr)

v3.0.0-beta.48 (2024-06-17)

Features

• prevent setting column preferences unless edited (#6774) (7c35e88)

Bug Fixes

• date hydration error if user locale is different to server (#6806) (a3e1856)
• richtext-lexical: lexicalHTML field was persisted in database even though it should not (#6795) (6612bd1)
• loader windows path resolution (#6804) (ce2ae95)
• prevent clearing of language selection on account view (#6803) (1a03e9a)
• ui,richtext-*: path from context should always have precedence over path from props, even if it's an empty string (#6782) (e7159c0)
• ui: properly type Select element onChange type, as well as any components using it (#6785) (6287495)
• array row validation messages (#6781) (0920c8a)
• allows navigation to reset-pw route, adds customization for route (#6778) (680ed1d)
• passes toast success and error handlers to form handleResponse fn (#6775) (ddc3ab5)

Contributors

• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Dan Ribbens (@DanRibbens)
• Jarrod Flesch (@JarrodMFlesch)

2.21.0 (2024-06-14)

Features

• draft validation (#6746) (ff70fd9)

Bug Fixes

• adjust version status pill when unpublished (#6744) (b7e8529)
• use correct time for isLocked check (#6052) (3b4bb30)
• unable to save animated file types with undefined image sizes (#6733) (e40570b), closes #6727

v3.0.0-beta.47 (2024-06-13)

Features

• adds X-HTTP-Method-Override header (#6487) (7bb2e3b)
• plugin-stripe: add full req object to stripe webhook handlers (#6770) (78db50a)
• use Gravatar for default avatar (#6765) (11de4b0)
• warn if image resizing enabled but sharp is not passed to config (#6763) (ed0820f)

Bug Fixes

• adds translation for authentication:apiKey (#6771) (f36bf5e)
• attempt to use user locale preference when not set as query param (#6761) (082650c)
• adds siteName to openGraphSchema joi validation (#6764) (0162560)
• payload, ui: unable to save animated file types with undefined image sizes (#6757) (e148243)
• meta.icons type and schema validation (#6759) (8e56328)

BREAKING CHANGES

• use Gravatar for default avatar (#6765) (11de4b0)

• Makes Gravatar the default

• meta.icons type and schema validation (#6759) (8e56328)

Contributors

• Anders Semb Hermansen (@andershermansen)
• Paul (@paulpopus)
• Jarrod Flesch (@JarrodMFlesch)
• Elliot DeNolf (@denolfe)
• Viet-Tien (@nvti)
• Patrik (@PatrikKozak)
• Jacob Fletcher (@jacobsfletch)