PayloadCMS releases filter

v3.0.0-beta.111 (2024-10-04)

🚀 Features

• update next@15.0.0-canary.173, react@19.0.0-rc-3edc000d-20240926 (#8489) (fa59d4c)

🐛 Bug Fixes

• db-postgres: missing types for db.pool by moving @types/pg from devDependencies to dependencies (#8556) (0d3416c)
• drizzle: make radio and select column names to snake_case (#8439) (0128eed)
• drizzle: row / collapsible inside of localized fields (#8539) (414030e)
• ui: disableBulkEdit on ui fields, defaults to true (#8540) (cf8347f)
• plugin-seo: now respects serverURL and api routes configuration (#8546) (157b1e1)
• templates: dark and light mode not correctly working on website template's header (#8542) (dffdb22)
• templates: add no search results text to website template search page (#8531) (eb4e371)
• templates: static generation from incorrect params provided (#8530) (132131a)
• ui crashes editing doc with deleted upload (#8526) (9ef4fab)
• templates: add force-static to pages and posts (#8527) (65015aa)
• next: safely checks user within useEffect (#8524) (0f7d444)
• properly resolves cjs withPayload export (#8521) (ca90d2b)
• templates: remove lock from website template (#8520) (ecfd90b)
• templates: fixed drafts not being unpublished in the frontend of the website template (#8514) (8637144)
• next: current published version label (#8505) (a8eceb0)
• ui: admin.allowCreate in upload field (#8484) (d80410b)
• db-postgres, db-sqlite: joins relation name (#8491) (27b1629)

⚠️ BREAKING CHANGES

• drizzle: make radio and select column names to snake_case (#8439) (0128eed)

  Fixes https://github.com/payloadcms/payload/issues/8402 and https://github.com/payloadcms/payload/issues/8027

  Before DB column names were camelCase:

  

  After this change, they are snake_case:

  Breaking SQLite / Postgres ⚠️

  If you had any select (not hasMany: true) or radio fields with the name in camelCase, for example:

  {
    name: 'selectReadOnly',
    type: 'select',
    admin: {
      readOnly: true,
    },
    options: [
      {
        label: 'Value One',
        value: 'one',
      },
      {
        label: 'Value Two',
        value: 'two',
      },
    ],
  },
  

  This previously was mapped to the db column name "selectReadOnly". Now it's select_read_only. Generate a new migration to rename your columns.

  pnpm payload migrate:create
  

  Then select "rename column" for targeted columns and Drizzle will handle the migration.

• update next@15.0.0-canary.173, react@19.0.0-rc-3edc000d-20240926 (#8489) (fa59d4c)

  Updates the minimal supported versions of next.js to 15.0.0-canary.173 and react to 19.0.0-rc-3edc000d-20240926.

  Adds neccessary awaits according to this breaking change https://github.com/vercel/next.js/pull/68812

  The params and searchParams types in app/(payload)/admin/[[...segments]]/page.tsx and app/(payload)/admin/[[...segments]]/not-found.tsx must be changed to promises:

  - type Args = {
  -   params: {
  -     segments: string[]
  -   }
  -   searchParams: {
  -     [key: string]: string | string[]
  -   }
  - }
  
  + type Args = {
  +   params: Promise<{
  +     segments: string[]
  +   }>
  +   searchParams: Promise<{
  +     [key: string]: string | string[]
  +   }>
  + }
  
  

🤝 Contributors

• Sasha (@r1tsuu)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Dan Ribbens (@DanRibbens)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Germán Jabloñski (@GermanJablo)

v3.0.0-beta.110 (2024-09-30)

🚀 Features

• join field on upload fields (#8379) (3f375cc)
• richtext-lexical: export $createInlineBlockNode, $isInlineBlockNode and InlineBlockNode (#8480) (163f3c0)
• translations: add danish translations (#7809) (22f120d)
• richtext-lexical: upgrade lexical from 0.17.0 to 0.18.0, make tables more reliable (#8444) (8b44676)
• templates: add search functionality to the website template (#8454) (fb60344)
• payload, ui: add admin.allowEdit relationship field (#8398) (17e0547)

🐛 Bug Fixes

• db-*: make db.begintransactions required (#8419) (3847428)
• db-mongodb: duplicate versions with parent string ids (#8487) (7b6a760)
• draft status access control checks (#8486) (0c10045)
• reset password link extra slash and thread admin.routes.reset property (#8448) (e765a5e)
• sorting by id incorrectly orders by version.id (#8442) (4241811)
• db-mongodb: properly filters out number field values with the exists operator filter (#8416) (8110cb9)
• ui: RTL not applying for localised textarea fields (#8474) (e5ca476)
• drizzle: hasMany / poly relationships nested to localized fields / nested blocks to localized fields (#8456) (613d3b0)
• richtext-lexical: match the indentation spacing of paragraphs and lists (#8437) (f50174f)

⚠️ BREAKING CHANGES

• richtext-lexical: upgrade lexical from 0.17.0 to 0.18.0, make tables more reliable (#8444) (8b44676)

  This upgrades lexical from 0.17.0 to 0.18.0. If you have any lexical packages installed in your project, please update them accordingly. Additionally, if you depend on the lexical APIs, please consult their changelog, as lexical may introduce breaking changes: https://github.com/facebook/lexical/releases/tag/v0.18.0

🤝 Contributors

• Dan Ribbens (@DanRibbens)
• Sasha (@r1tsuu)
• James Mikrut (@jmikrut)
• Ante (@azivkovi)
• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)
• Paul (@paulpopus)
• Mike Bailey (@mykz)
• Germán Jabloñski (@GermanJablo)

v3.0.0-beta.109 (2024-09-26)

🚀 Features

• preselected theme (#8354) (84d2026)
• drizzle: customize schema with before / after init hooks (#8196) (8acbda0)
• add upsert to database interface and adapters (#8397) (82ba193)
• improve afterError hook to accept array of functions, change to object args (#8389) (28ea0c5)
• templates update (#8391) (e72f12a)

🐛 Bug Fixes

• db-mongodb: docs duplicated in list view with drafts (#8435) (adc9bb5)
• richtext-lexical: add max-width to tables (temporary fix for overflow). (#8431) (a09811f)
• ui: autosave and preventLeaveWithoutSaving interfering with fetching form-state reliably (#8434) (c73f6c7)
• ui: number field not being able to clear out the field's value (#8425) (5c2e39e)
• ui: align to the top fields inside row field (#8421) (4b0351f)
• ui: versions in documentInfo and status component reverse latest true changes (#8417) (95231da)
• db-mongodb: add req to migration templates for transactions (#8407) (b10f61c)
• make field property of FieldLabel optional and partial (#8409) (87360f2)
• plugin-seo: titles being displayed twice (#8310) (8fadc33)
• drizzle: migrate args no longer partial payload request (#8375) (c6519ab)
• client function error on forgot password view (#8374) (06ea67a)
• drizzle: use alias for localized field sorting (#8396) (775e6e4)
• lock documents using the live-preview view (#8343) (57f93c9)
• ui: published, draft and changed labels should now be correctly displayed (#8382) (a37abd1)
• db-vercel-postgres: include needed pg dependency (#8393) (6da4f06)
• templates: proper migration file import source for vercel-postgres (#8394) (50da212)
• safely access user in auth operations (#8381) (a80f5b6)
• db-mongodb: db.find default limit to 0 (#8376) (dc69e2c)
• richtext-lexical: regression in lexical blocks (#8378) (19e2f10)
• richtext-lexical: table dropdown menu dark mode color (#8368) (bd41b4d)
• optional sortOptions type for SingleRelationshipFieldClient (#8340) (fbc395b)
• next: set the user data after first user registration (#8360) (30eb1d5)
• drizzle: sanitize query value uuid / number id NaN (#8369) (dedcff0)
• drizzle: array/relationship/select hasMany in localized field (#8355) (338c93a)
• cannot use join on relationships in unnamed fields (#8359) (c696728)
• ui: inconsistent arrow dropdown on buttons, popover missing caret (#8341) (3583c45)

⚠️ BREAKING CHANGES

• improve afterError hook to accept array of functions, change to object args (#8389) (28ea0c5)

  Changes the afterError hook structure, adds tests / more docs. Ensures that the req.responseHeaders property is respected in the error handler.

  afterError now accepts an array of functions instead of a single function:

  - afterError: () => {...}
  + afterError: [() => {...}]
  

  The args are changed to accept an object with the following properties:

  | Argument | Description | | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | error | The error that occurred. | | context | Custom context passed between Hooks. More details. | | graphqlResult | The GraphQL result object, available if the hook is executed within a GraphQL context. | | req | The Request object containing the currently authenticated user | | collection | The Collection in which this Hook is running against. This will be undefined if the hook is executed from a non-collection endpoint or GraphQL. | | result | The formatted error result object, available if the hook is executed from a REST context. |

🤝 Contributors

• Dan Ribbens (@DanRibbens)
• Germán Jabloñski (@GermanJablo)
• Paul (@paulpopus)
• Riley Pearce (@rilrom)
• Jessica Chowdhury (@JessChowdhury)
• Sasha (@r1tsuu)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Tylan Davis (@tylandavis)

v3.0.0-beta.108 (2024-09-20)

🚀 Features

• richtext-lexical: dropdown menu disabled status (#8177) (7d2022f)
• upgrade next, react and react-dom, move react/next dependency checker from payload to next package (#8323) (1afcaa3)
• join field (#7518) (6ef2bde)
• adds overrideLock flag to update & delete operations (#8294) (9c3f863)
• ui: hides lock icon when locked by current user (#8309) (879f690)
• ui: threads collectionSlugs through useListDrawer (#8292) (405a6c3)
• storage-vercel-blob: threads cacheControlMaxAge through static handler (#8065) (a94e40f)
• ui: useTableColumns add abillity to reset columns state (#8296) (72995fc)
• plugin-form-builder: new wildcards {{}} and {{:table}} are now supported in email bodies and emails fall back to a global configuration value in addition to base email configuration (#8271) (9821aeb)
• lock documents while being edited (#7970) (f98d032)
• plugin-seo: add vietnamese translation (#8179) (89601f1)
• add virtual property to the fields config (#7621) (bf48af4)
• add publish specific locale (#7669) (b7a0b15)

⚡ Performance

• disable router cache refresh that occurs after every page transition or page load (#8318) (0cdd5b6)
• optimizes admin ui loading by using react cache to memoize req / auth (#8315) (c6a7ad2)

🐛 Bug Fixes

• ui: hide dot menu in read-only mode for locked documents (#8342) (493b121)
• db-mongodb: treat empty strings as null / undefined for exists queries (#8337) (e916512)
• ui: client side error when passing labels as functions for custom view tabs (#8339) (1f7d47a)
• add logger to serverOnlyConfigProperties (#8325) (afb8805)
• plugin-form-builder: emails array field has read access by authenticated users only by default now (#8338) (0789f4d)
• drizzle: equals polymorphic querying with object notation (#8316) (265d7fa)
• drizzle: nested arrays with localized items and versions (#8331) (2596b85)
• ui: adjust list view table alignment (#8330) (b51d2bc)
• only add snapshot to versions query when localization is enabled (#8293) (2d29b7e)
• findByID adjust type to null if disableErrors: true is passed (#8282) (37e1adf)
• richtext-slate: fix issue with richText field cell not being a link when used as a useAsTitle (#8272) (dd96f9a)
• templates: optional chaining bug (#8268) (4d54cc6)
• ui: code field adjusts its height to its content dynamically. Scrolling over the container is not prevented. (#8209) (f011e4f)
• strongly types field validation args (#8263) (c0aad3c)
• ui: mobile menu button sizing (#8264) (110fda7)
• drizzle: in query on polymorphic relations across ID types (#8240) (31ffc57)
• ui: filter collection crashes when navigating away (#8260) (9035467)
• properly infers field validation args (#8243) (029eba5)
• richtext-lexical: dropdown item disabled status (#8159) (67cd3b3)
• ui: pass label as prop through to the textarea input (#8248) (a06458d)
• ui: field alignment when labels overflow inside rows (#8246) (149b7cb)
• ui: draft docs are now correctly provided in preview URL (#8245) (ccd0b1e)
• error on forgot-password route (#8244) (d2eafdf)
• ui: nav button height being stretched and navWrapper border on RTL (#8242) (a68f0ce)
• drizzle: optimize count querying when no joins (#7749) (8520fd9)
• plugin-seo: threads entity slug and document config through generation fn args (#8238) (aee76cb)
• drizzle: localized fields uniqueness per locale (#8230) (b7db53c)

⚠️ BREAKING CHANGES

• richtext-lexical: dropdown menu disabled status (#8177) (7d2022f)

  ToolbarDropdown no longer receives groupKey={group.key} and items={group.items} as props, but instead group={group}

• plugin-form-builder: emails array field has read access by authenticated users only by default now (#8338) (0789f4d)

• upgrade next, react and react-dom, move react/next dependency checker from payload to next package (#8323) (1afcaa3)

  • Upgrades minimum supported @types/react version from npm:types-react@19.0.0-rc.0 to npm:types-react@19.0.0-rc.1
  • Upgrades minimum supported @types/react-dom version from npm:types-react-dom@19.0.0-rc.0 to npm:types-react-dom@19.0.0-rc.1
  • Upgrades minimum supported react and react-dom version from 19.0.0-rc-06d0b89e-20240801 to 19.0.0-rc-5dcb0097-20240918
  • Upgrades minimum supported Next.js version from 15.0.0-canary.104 to 15.0.0-canary.160

• join field (#7518) (6ef2bde)

  • Adds a new "join" field type to Payload and is supported by all database adapters
  • The UI uses a table view for the new field
  • db-mongodb changes relationships to be stored as ObjectIDs instead of strings (for now querying works using both types internally to the DB so no data migration should be necessary unless you're querying directly, see breaking changes for details
  • Adds a reusable traverseFields utility to Payload to make it easier to work with nested fields, used internally and for plugin maintainers

  export const Categories: CollectionConfig = {
      slug: 'categories',
      fields: [
          {
              name: 'relatedPosts',
              type: 'join',
              collection: 'posts',
              on: 'category',
          }
      ]
  }
  

  All mongodb relationship and upload values will be stored as MongoDB ObjectIDs instead of strings going forward. If you have existing data and you are querying data directly, outside of Payload's APIs, you get different results. For example, a contains query will no longer works given a partial ID of a relationship since the ObjectID requires the whole identifier to work.

• drizzle: localized fields uniqueness per locale (#8230) (b7db53c)

  Previously, this worked with MongoDB but failed with Postgres / SQLite when the slug field has both localized: true and unique: true.

  await payload.create({
    collection: "posts",
    locale: "en",
    data: {
      slug: "my-post"
    }
  })
  
  await payload.create({
    collection: "posts",
    locale: "de",
    data: {
      slug: "my-post"
    }
  })
  

  Now, we build unique constraints and indexes in combination with the _locale column. This should also improve query performance for fields with both index: true and localized: true.

  Migration steps (Postgres/SQLite only)

  This change updates the database schema and requires a migration (if you have any localized fields). To apply it, run the following commands:

  pnpm payload migrate:create locale_unique_indexes
  pnpm payload migrate
  

  Note that if you use db.push: true which is a default, you don't have to run pnpm payload migrate in the development mode, only in the production, as Payload automatically pushes the schema to your DB with it.

🤝 Contributors

• Germán Jabloñski (@GermanJablo)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Louis Ba (@muyunz)
• Alessio Gravili (@AlessioGr)
• Sasha (@r1tsuu)
• Dan Ribbens (@DanRibbens)
• Tylan Davis (@tylandavis)
• James Mikrut (@jmikrut)
• gervickas.js (@wellitongervickas)
• Jessica Chowdhury (@JessChowdhury)
• Frank Omondi (@Dofften)
• Jacob Fletcher (@jacobsfletch)
• Because789 (@Because789)
• Thành Trang (@trangcongthanh)

v3.0.0-beta.107 (2024-09-16)

🚀 Features

• add new option for admin.components.header (#7647) (3b59416)
• cpa: add node engines (#8234) (7c8272b)

⚡ Performance

• remove find-up dependency, upgrade file-type dependency (#8195) (6d1a287)

🐛 Bug Fixes

• duplication with localized arrays in unnamed tabs (#8236) (c460868)
• drizzle: polymorphic querying of different ID types (#8191) (a0a1e20)

🤝 Contributors

• James Mikrut (@jmikrut)
• Sasha (@r1tsuu)
• Jessica Chowdhury (@JessChowdhury)
• Elliot DeNolf (@denolfe)
• Jacob Fletcher (@jacobsfletch)
• Alessio Gravili (@AlessioGr)

v3.0.0-beta.106 (2024-09-15)

🐛 Bug Fixes

• duplicating localized nested arrays (#8220) (5873a3d)

🤝 Contributors

• James Mikrut (@jmikrut)

v3.0.0-beta.105 (2024-09-15)

⚡ Performance

• upgrade ajv, and upgrade typescript to 5.6.2 in monorepo (#8204) (fbc28b0)
• upgrade jsonwebtoken from 9.0.1 to 9.0.2 (#8202) (ec624bd)

🐛 Bug Fixes

• plugin-seo: removes duplicative json translations (#8206) (64f2395)
• error when viewing versions if plural label is set as a function (#8213) (ff1c1e0)
• richtext-lexical: default Cell not being a link when used as the primary column in lists (#8212) (d0bb1c9)
• ui: field type being overridden when providing a Cell component (#8211) (1608150)
• db-postgres: preserve parent createdAt when creating a new version (#8160) (43a9109)
• richtext-lexical: unnecessary isEnabled computations on toolbar items (#8176) (334f940)
• graphql: id field non null (#8169) (db29e1e)
• ui: bulk selection and useSelection hook losing types of the IDs its returning (#8194) (d28d40c)
• ui: properly extracts label from field in FieldLabel component (#8190) (a6f13f7)
• requires client field prop in server field components (#8188) (c28618b)

⚠️ BREAKING CHANGES

• ui: bulk selection and useSelection hook losing types of the IDs its returning (#8194) (d28d40c)

This PR changes the type of selected returned from the useSelection hook from the SelectionProvider from an object to a Map.

This fixes a bug where in some situations we lose the type of the ID which can break data entry when using postgres, due to keys being cast to strings inside of objects which doesn't happen when using a Map.

This PR also fixes a CSS bug with the checkbox when it should be partially selected.

// before
selected: Record<number | string, boolean>

// after
selected: Map<number | string, boolean>

This means you now need to read the data differently than before.

// before
Object.entries(selected).forEach(([key, value]) => {
  // do something
})

// after
for (const [key, value] of selected) {
  // do something
}

🤝 Contributors

• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Sasha (@r1tsuu)
• Germán Jabloñski (@GermanJablo)
• Jarrod Flesch (@JarrodMFlesch)
• Elliot DeNolf (@denolfe)
• Victor Winberg (@VictorWinberg)
• Florian Quiblier (@fofoy)
• Christoffer Hasselberg (@stofolus)

v3.0.0-beta.104 (2024-09-12)

🚀 Features

• passes client field config to server components (#8166) (8b30701)
• document drawer controls (#7679) (51bc8b4)
• drizzle: add support for in and not_in operators on json field (#8148) (ec37307)

🐛 Bug Fixes

• ui: properly retrieves singular labels for array field rows (#8171) (6e94884)
• templates: website media staticDir to public folder (#8175) (9561aa3)
• properly names BlocksField and related types (#8174) (465e47a)
• cpa: match vercel postgres db type with package name (#8141) (043bf95)
• ui: fix row width bug (#7940) (cd734b0)
• ui: set max-width for row (efe17ff)

⚠️ BREAKING CHANGES

• properly names BlocksField and related types (#8174) (465e47a)

  The BlockField type is not representative of the underlying "blocks" field type, which is plural, i.e. BlocksField. This is a semantic change that will better align the type with the field.

  Breaking Changes

  Types related to the blocks field have change names. If you were using the BlockField or related types in your own applications, simply change the import name to be plural and instead of singular.

  Old (singular):

  import type {
    BlockField,
    BlockFieldClient,
    BlockFieldValidation,
    BlockFieldDescriptionClientComponent,
    BlockFieldDescriptionServerComponent,
    BlockFieldErrorClientComponent,
    BlocksFieldErrorServerComponent,
    BlockFieldLabelClientComponent,
    BlockFieldLabelServerComponent,
  } from 'payload'
  

  New (plural):

  import type {
    BlocksField,
    BlocksFieldClient,
    BlocksFieldValidation,
    BlocksFieldDescriptionClientComponent,
    BlocksFieldDescriptionServerComponent,
    BlocksFieldErrorClientComponent,
    BlocksFieldErrorServerComponent,
    BlocksFieldLabelClientComponent,
    BlocksFieldLabelServerComponent,
  } from 'payload'
  

🤝 Contributors

• Dan Ribbens (@DanRibbens)
• Patrik (@PatrikKozak)
• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Hampus Wallentin Olsen (@hampusolsen)
• Germán Jabloñski (@GermanJablo)
• Bruno Crosier (@brunocrosier)

v3.0.0-beta.103 (2024-09-11)

🚀 Features

• examples: adds custom components example (#8162) (8fe6ffd)

🐛 Bug Fixes

• useAsTitle validation now accounts for default and base fields (#8165) (663e511)
• next: set the user data before redirect after login (#8135) (0118bce)
• upload.defParamCharset: utf8 by default (#8157) (a234092)
• richtext-lexical: hover style of the button to remove blocks (#8154) (281c80d)
• extends server props onto field component types (#8155) (12a30a0)
• db-postgres: querying on array wtihin a relationship field (#8152) (0c563eb)

🤝 Contributors

• Paul (@paulpopus)
• Jacob Fletcher (@jacobsfletch)
• Sasha (@r1tsuu)
• Jarrod Flesch (@JarrodMFlesch)
• Germán Jabloñski (@GermanJablo)

v3.0.0-beta.102 (2024-09-09)

🚀 Features

• explicitly types field components (#8136) (8e1a5c8)

🐛 Bug Fixes

• beforeDuplicate localized blocks and arrays (#8144) (d267cad)
• richtext-lexical: indent regression (#8138) (fa38dfc)

⚠️ BREAKING CHANGES

• explicitly types field components (#8136) (8e1a5c8)

  We are no longer exporting TextFieldProps etc. for each field type. Instead, we now export props for each client/server environment explicitly. If you were previously importing one of these types into your custom component, simply change the import name to reflect your environment.

  Old:

  import type { TextFieldProps } from 'payload'
  

  New:

  import type { TextFieldClientProps, TextFieldServerProps } from 'payload'
  

🤝 Contributors

• Dan Ribbens (@DanRibbens)
• Germán Jabloñski (@GermanJablo)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.101 (2024-09-09)

🚀 Features

• add validation for useAsTitle to throw an error if it's an invalid or nested field (#8122) (638382e)

🐛 Bug Fixes

• #6800, graphql parallel queries with different fallback locales (#8140) (d44fb2d)
• multiple preferences for the same user and entry (#8100) (852f9fc)
• removes transactions wrapping auth strategies and login (#8137) (e2d8038)
• ui: wrong block indication when an error occurred (#7963) (7fa68d1)
• ui: bulk select checkbox being selected by default when in drawer (#8126) (9ec431a)
• ui: thumbnails when serverURL config is provided (#8124) (cadf815)
• ui: various issues around documents lists, listQuery provider and search params (#8081) (b27e42c)
• ui: missing thumbnail for non-image files in bulk upload sidebar (#8102) (32cc1a5)
• ui: better responsiveness for upload fields in sidebar (#8101) (38be69b)

🤝 Contributors

• James Mikrut (@jmikrut)
• Dan Ribbens (@DanRibbens)
• Germán Jabloñski (@GermanJablo)
• Paul (@paulpopus)
• Elliot DeNolf (@denolfe)
• Tylan Davis (@tylandavis)

v3.0.0-beta.100 (2024-09-06)

🚀 Features

• cpa: add support for bun package manager in v3 installer (#7709) (b69826a)

🐛 Bug Fixes

• ui, next: adjust modal alignment and padding (#7931) (ead12c8)
• ui: optimizes the relationship field by sharing a single document drawer across all values (#8094) (6253ec5)
• ui: handles falsey relationship options on reset (#8095) (f9ae56e)
• db-postgres: sanitize tab/group path for table name (#8009) (0688c2b)
• cpa: detect package manager from command execution environment (#8087) (c624661)

🤝 Contributors

• Tylan Davis (@tylandavis)
• Jacob Fletcher (@jacobsfletch)
• Sasha (@r1tsuu)
• Alexander (@Arctomachine)
• Paul (@paulpopus)
• Francisco Lourenço (@franciscolourenco)

v3.0.0-beta.99 (2024-09-05)

🐛 Bug Fixes

• ui: significantly optimizes relationship field (#8063) (308fad8)
• only show restore as draft option when drafts enabled (#8066) (6427b7e)
• db-postgres: query hasMany text/number in array/blocks (#8003) (3a65784)

🤝 Contributors

• Jacob Fletcher (@jacobsfletch)
• Jessica Chowdhury (@JessChowdhury)
• Sasha (@r1tsuu)
• Elliot DeNolf (@denolfe)

v3.0.0-beta.98 (2024-09-03)

🚀 Features

• plugin-seo: add Italian translations (#8020) (1130a58)

⚡ Performance

• richtext-lexical: greatly simplify lexical loading and improve performance (#8041) (b6a8d1c)

🐛 Bug Fixes

• richtext-lexical: toolbar styles (#7936) (7a3507d)
• plugin-seo: meta image selection not working (#8024) (9bcdf0d)
• padding on the right of the default padding when scrollbars are enabled in the browser (#8023) (8203fe8)
• richtext-lexical: incorrect error check in TableActionMenu (#7964) (d9cccc7)
• collection pagination limits being merged with defaults instead of overidden (#8004) (ee3d585)
• ui: radio fields are now selectable as options in filtering in query builder (#8002) (cf9e13a)
• ui: list view crash when using a code field type (#7994) (e25730f)

⚠️ BREAKING CHANGES

• richtext-lexical: greatly simplify lexical loading and improve performance (#8041) (b6a8d1c)

  We noticed that we can bring functions down to the client directly without having to wrap them in a component first. This greatly simplifies the loading of all lexical client components

  BREAKING:

  • createClientComponent is no longer exported as it's not needed anymore
  • The exported ClientComponentProps type has been renamed to BaseClientFeatureProps.
  • The order of arguments in sanitizeClientEditorConfig has changed

🤝 Contributors

• Alessio Gravili (@AlessioGr)
• Elliot DeNolf (@denolfe)
• Germán Jabloñski (@GermanJablo)
• Paul (@paulpopus)
• Giuseppe Chiruzzi (@xfloor)
• Riley Pearce (@rilrom)

v3.0.0-beta.97 (2024-08-30)

🚀 Features

• move logger configuration to Payload config (#7973) (8202c3d)
• templates: update website src directory structure (#7971) (90b3e83)

🐛 Bug Fixes

• templates: add button to exit preview mode (#7991) (c1533bf)
• migrations exit code (#7989) (442d105)
• ui: upload field not showing admin.description (#7978) (b6ae689)
• nested-docs-plugin: throw an error to the UI if children are not passing validation (#7977) (e033488)
• ui: upload with has many bulk select not working with postgres (#7976) (e071382)
• ui: propagates sort change events through list query provider (#7968) (c072822)

Contributors

• Paul (@paulpopus)
• Elliot DeNolf (@denolfe)
• Jarrod Flesch (@JarrodMFlesch)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.96 (2024-08-29)

🚀 Features

• auto-removes localized property from localized fields within other localized fields (#7933) (538b7ee)
• significantly reduce payload install size by removing unnecessary monaco-editor dependency (#7939) (e375f6e)
• reduce package size and amount of dependencies by upgrading json-schema-to-typescript (#7938) (dc12047)

🐛 Bug Fixes

• db-postgres: nested localized arrays (#7962) (ac10bad)
• prevents duplicate active nav indicators (#7943) (de3d7c9)
• improve validation errors for unique fields (#7937) (cc9b877)
• incorrect config.upload types (#7874) (0962850)

⚠️ BREAKING CHANGES

• auto-removes localized property from localized fields within other localized fields (#7933) (538b7ee)

  Payload localization works on a field-by-field basis. As you can nest fields within other fields, you could potentially nest a localized field within a localized field—but this would be redundant and unnecessary. There would be no reason to define a localized field within a localized parent field, given that the entire data structure from the parent field onward would be localized.

  Up until this point, Payload would allow you to nest a localized field within another localized field, and this might have worked in MongoDB but it will throw errors in Postgres.

  Now, Payload will automatically remove the localized: true property from sub-fields within sanitizeFields if a parent field is localized.

  This could potentially be a breaking change if you have a configuration with MongoDB that nests localized fields within localized fields.

  Migrating

  You probably only need to migrate if you are using MongoDB, as there, you may not have noticed any problems. But in Postgres or SQLite, this would have caused issues so it's unlikely that you've made it too far without experiencing issues due to a nested localized fields config.

  In the event you would like to keep existing data in this fashion, we have added a compatibility.allowLocalizedWithinLocalized flag to the Payload config, which you can set to true, and Payload will then disable this new sanitization step.

  Set this compatibility flag to true only if you have an existing Payload MongoDB database from pre-3.0, and you have nested localized fields that you would like to maintain without migrating.

Contributors

• James Mikrut (@jmikrut)
• Elliot DeNolf (@denolfe)
• Jarrod Flesch (@JarrodMFlesch)
• Alessio Gravili (@AlessioGr)
• Paul (@paulpopus)

v3.0.0-beta.95 (2024-08-28)

🐛 Bug Fixes

• ui: admin.dependencies components not added to client config (#7928) (ef818fd)
• richtext-lexical: enabledCollections and disabledCollections props in RelationshipFeature (#7926) (0aaf3af)
• db-postgres, db-sqlite: hasMany text, number, poly relationship, blocks, arrays within localized fields (#7900) (18b0806)
• richtext-lexical: ensure html converter text is escaped (#7919) (c7e7dc7)
• active nav item set incorrectly in child routes (#7918) (375671c)
• depth not being respected by upload has many (#7897) (27d743e)

Contributors

• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Germán Jabloñski (@GermanJablo)
• James Mikrut (@jmikrut)
• Jacob Fletcher (@jacobsfletch)
• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)

v3.0.0-beta.94 (2024-08-27)

🚀 Features

• templates: add new slug component to the website (#7895) (5d97d57)

🐛 Bug Fixes

• upload has many field updates (#7894) (a76be81)
• richtext-lexical: html converters can populate relationships infinitely (#7890) (de7ff1f)
• locale selector + autosave race condition (#7891) (3d714d3)

Contributors

• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• James Mikrut (@jmikrut)
• Elliot DeNolf (@denolfe)

v3.0.0-beta.93 (2024-08-27)

🐛 Bug Fixes

• bugs in versions UI with perPage, pagination and diffs not showing for tabs. publish button no longer double saves when using keyboard (#7889) (23c5ef4)
• richtext-lexical: dependency checker suggesting incorrect version (#7888) (f046a04)

Contributors

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

v3.0.0-beta.92 (2024-08-27)

🚀 Features

• implement info command (#7882) (ea48cfb)
• add nextjs and react version checks to dependency checker (#7868) (dfb4c8e)
• richtext-lexical: more lenient url validation, URL-encode invalid urls on save (#7870) (ad7a387)

🐛 Bug Fixes

• templates: website live preview and code block (#7881) (1aeb912)
• plugin-seo: remove dependency on import from payload/next package (#7879) (ce2cb35)
• error when closing the live preview popup window (#7878) (d3ec68a)
• templates: website bug fixes for slug generation and form builder and adds support for strictNullChecks: true (#7877) (05bf52a)
• sanitizes modifyResponseHeaders from client config (#7876) (fed7f2f)
• exports richtext-slate useSlatePlugin (#7875) (686b086)

Contributors

• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Jacob Fletcher (@jacobsfletch)
• James Mikrut (@jmikrut)
• Alessio Gravili (@AlessioGr)

v3.0.0-beta.91 (2024-08-23)

Features

• templates: add vercel postgres template (#7841) (825d8b8)
• enable react compiler for @payloadcms/next package (#7839) (83022f6)
• richtext-lexical: improve upload and relationship node types (#7822) (6349cd4)
• ui: add styling for no docs and clear all on hasmany upload (#7816) (95ebead)

Bug Fixes

• next: properly 404s not found documents (#7833) (03440f5)
• trim down accepted args of getPayloadHMR (#7834) (0fa6611)
• collapsible toggle hover stacking issue (#7812) (49c0709)
• weaken JsonObject type to allow types from payload-types being assigned to it (#7815) (c2b2f10)
• ui: relationship field "add new" button styling (#7814) (3eed8b1)
• richtext-lexical: slate => lexical migrator improvements (#7802) (1eefb12)

Contributors

• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Tylan Davis (@tylandavis)
• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)
• Dan Ribbens (@DanRibbens)
• Ritsu (@r1tsuu)

v3.0.0-beta.90 (2024-08-22)

Features

• @payloadcms/db-vercel-postgres adapter (#7806) (631431e)

Bug Fixes

• ui: upload has many no rows error (#7804) (492d920)

Contributors

• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)

v3.0.0-beta.89 (2024-08-22)

Features

• upload hasmany (#7796) (d2571e1)
• bulk upload (#7800) (1ee19d3)
• log document id in ValidationError cause, if present (9beaa28)
• extends Button and extracts ListHeader components (#7777) (cad1906)

Bug Fixes

• richtext-lexical: ensure errors during slate => lexical migration are caught and do not halt migration progress (cf66341)
• richtext-lexical: inaccurate detection of whether the editor is empty or not (5174c70)
• richtext-lexical: migrate scripts not working due to migration hooks running during migrate script (d894ac7)
• no longer handle disabling node deprecation warnings within bin script shebangs, as it errored on some systems (#7797) (af0105c)
• ui, richtext-lexical: corrects clickable areas on block headers (#7791) (93e8131)
• handles custom collection description components (#7789) (cb9b80a)

BREAKING CHANGES

• handles custom collection description components (#7789) (cb9b80a)

  If you were previously defining a custom description component on a collection, simply move it into the correct position.

  Old:

  {
    admin: {
      components: {
        edit: {
          Description: ''
        }
      }
    }
  }
  

  New:

  {
    admin: {
      components: {
        Description: ''
      }
    }
  }
  

Contributors

• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)
• Tylan Davis (@tylandavis)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.88 (2024-08-20)

Features

• ui: export Banner component (#7779) (95a8bb0)

Bug Fixes

• ui: on Table component crashing when looking for className on admin (#7776) (9c2ccbf)
• plugin-search: not being able to override labels (#7775) (3ee0e84)
• ui: text clipping on document header title with Segoe UI font (#7774) (6ec9820)

Contributors

• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Tylan Davis (@tylandavis)

v3.0.0-beta.87 (2024-08-20)

Features

• threads field config through components and strictly types props (#7754) (3a91deb)

Contributors

• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.86 (2024-08-20)

Features

• pre-compile ui and richtext-lexical with react compiler (#7688) (ebd43c7)

Bug Fixes

• type generation for block fields with no blocks (#7765) (0c36cbd)
• useField incorrect initialization of errorMessage on update (#7756) (adf2f31)
• postgres migrate args (#7766) (17312d9)

Contributors

• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)
• James Mikrut (@jmikrut)

v3.0.0-beta.85 (2024-08-19)

Features

• custom view and document-level metadata (#7716) (a526c7b)
• abstract postgres base adapter (#7732) (2835e1d)

Bug Fixes

• migrate error on windows (#7759) (bb09da0)
• ui: tabs preferences not being saved (#7761) (ab09f2a)
• richtext-lexical: richtext editor features overriding other editor features props if multiple editors in one document (#7758) (2f38290)
• prevent vertical scrolling on tab fields (#7729) (b3b1cd2)
• ui: relationship cells in table from list drawer not shown (#7730) (6eb4438)

Contributors

• Dan Ribbens (@DanRibbens)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Elliot DeNolf (@denolfe)
• Tylan Davis (@tylandavis)

v3.0.0-beta.84 (2024-08-16)

Bug Fixes

• adds default drizzle package exports (#7728) (3d37d74)
• ensures user is accurate in useAuth (#7727) (de19822)
• corrects logout icon styling (#7726) (2b2bcb5)

Contributors

• James Mikrut (@jmikrut)
• Tylan Davis (@tylandavis)

v3.0.0-beta.83 (2024-08-16)

Features

• plugin-seo: pass req through to generate functions (#7711) (5eee49d)

Bug Fixes

• type RelationshipFieldClient typed incorrectly (#7725) (b0a7601)
• login with username server validations (#7719) (95569e4)
• bin script error when running on linux (#7721) (1181608)
• ui: ensure that aborting Autosave always has a valid reason for the controller - fixes uncaught error (#7723) (3a86822)
• ensures users cannot be created without confirming pw (#7583) (6f8604e)

Contributors

• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)
• Tylan Davis (@tylandavis)

v3.0.0-beta.82 (2024-08-15)

Bug Fixes

• importMap windows paths (#7706) (3a6c75a)

Contributors

• Jacob Fletcher (@jacobsfletch)
• Dan Ribbens (@DanRibbens)
• Alessio Gravili (@AlessioGr)
• Elliot DeNolf (@denolfe)

v3.0.0-beta.81 (2024-08-14)

Features

• allow passing false as PayloadComponent which signals that the component should not be rendered (#7682) (49a2d70)

Bug Fixes

• use tsx instead of swc as default bin script transpiler, as swc errors when it encounters 'next/cache' (#7681) (cb7fa00)
• next: supports root document view overrides as separate from default edit view (#7673) (a212cde)
• ui: issue with checking for undefined json when autosave and validate is enabled (#7678) (4f323a3)

Contributors

• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)

v3.0.0-beta.80 (2024-08-14)

Bug Fixes

• next: properly closes leave-without-saving modal after navigating from Leave anyway button (#7661) (806c22e)
• sidebar nav jumping around when loading page (#7574) (39d7b71)
• ui: ensure field components safely access field.admin property (#7670) (c65f502)

Contributors

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

v3.0.0-beta.79 (2024-08-14)

:rotating_light: This release includes breaking changes :rotating_light:

Follow along with the migration guide below for full details on each of the changes. Please reference this document as you migrate your own apps to this release.

So what's included in this release? By far the biggest change comes from this PR (migration guide below).

This PR made significant optimizations to the underlying codebase

• The Payload Config is now 100% Node-safe
• Compile times are 2x faster for some applications
• Greatly increases type-safety throughout the codebase
• Significant improvements for Custom Component types

For a complete list of all other bug fixes and features included in this release, scroll to the bottom of this document.

[!IMPORTANT] The payload config cannot import client files anymore. If you do that, you will get errors when running bin scripts, e.g. "Unknown file extension ".css". This means that you are still importing client modules somewhere in your config - could be components you're still importing without component paths, or older plugins that still import client modules into your config. Follow this migration guide to find out how you can migrate your config.

Migration Guide

To migrate from beta.78 to beta.79, you'll need to make a few changes to your Payload Config. Although this release is substantial, migration is relatively straightforward, with most of the changes only effecting the use of Custom Components.

The following changes are required of all projects:

1. The new "Import Map"

• Add a blank "import map" to your project. Create a new file called importMap.js and add it to /app/(payload)/admin/importMap.js in your app with the following content:

  export const importMap = {}
  

  Payload will dynamically inject this file with imports at compile time. If you are using a custom admin route, change the path accordingly.

  It is recommended to run the payload generate:importMap command after you're done with the migration (make sure you follow all migration steps below first). Additionally, if the automatic import map generation fails, try running payload generate:importMap.

2. Using the Import Map in your NextJS app

• Thread the "import map" file through your Root Layout, Root Page, and Not Found Pages:

  The Root Layout at /app/(payload)/layout.tsx:

  // ...
  import { importMap } from "./admin/importMap.js"
  
  //...
  
  const Layout = ({ children }: Args) => (
    <RootLayout config={configPromise} importMap={importMap}>
      {children}
    </RootLayout>
  )
  
  export default Layout
  

  The Root Page at /app/(payload)/admin/[[...segments]]/page.tsx:

  // ...
  import { importMap } from "../importMap.js"
  
  //...
  
  const Page = ({ params, searchParams }: Args) =>
    RootPage({ config, importMap, params, searchParams })
  
  export default Page
  

  The Not Found Page at /app/(payload)/admin/[[...segments]]/not-found.tsx:

  // ...
  import { importMap } from "../importMap.js"
  
  //...
  
  const NotFound = ({ params, searchParams }: Args) =>
    NotFoundPage({ config, importMap, params, searchParams })
  
  export default NotFound
  

3. Importing your Config file

• If you are importing the Payload Config in a Node.js environment, there is no longer a need for a special loader to process it. Instead, you can simply import the Payload Config directly. To migrate, remove the importConfig and importWithoutClientFiles functions from your Node.js code:

  Old:

  import { importConfig, importWithoutClientFiles } from "payload"
  import { join } from "path"
  
  const config = importConfig(join(__dirname, "payload.config.js"))
  const configWithoutClientFiles = importWithoutClientFiles(
    join(__dirname, "payload.config.js")
  )
  

  New:

  import config from "./payload.config.js"
  

If you are not using Custom Components in your applications, then you are done! If you are using Custom Components, please continue reading.

Custom Components

If you are using Custom Components in your application, please follow these next steps. Not all of these changes will apply to every project. So first, review this list of changes, and if a change applies to yours, scroll down to that individual section for full details:

1. Update component imports to component paths (required)
2. Update useConfig hook usage (if applicable)
3. Update useComponentMap hook usage (if applicable)
4. Update Custom Field prop references (if applicable)
5. Remove useFieldProps hook usage (if applicable)
6. Update Custom Views and Tabs keys (if applicable)

Here's a full breakdown of each step:

1. Custom Component import changes

• If you are using Custom Components in your Payload Config, the pattern for defining them has changed. You'll need to update your Custom Component definitions to use "component paths" instead of direct imports. To migrate, pass the path to the component's file:

  Old:

  import { MyCustomComponent } from './MyCustomComponent.js'
  
  // ...
  
  {
    // ...
    admin: {
      components: {
        Label: MyCustomComponent
      },
    },
  }
  

  New:

  {
    // ...
    admin: {
      components: {
        // NOTE: this path is relative to your `baseDir`, NOT the importing file
        // The `#` character is used to specify the export name, if necessary
        Label: '/collections/Posts/MyServerComponent.js#MyExportName',
      },
    },
  }
  

  Regarding the extension in the component path: you'd write it as if you were to write an import statement yourself. Few examples, assuming the imports are done from the base directory:

  If you'd previously write import { sth } from './file.js' the component path would be '/file.js#sth'

  if you'd previously write import { sth } from './file' the component path would be '/file#sth'

  if you'd previously write import file from './file.tsx' the component path would be '/file.tsx' or '/file.tsx#default'

  Alternatively, you can also define the custom component as a "PayloadComponent" in the Payload Config. This allows you to pass in client-side vs server-side props explicitly, which get automatically sanitized from the client. Previously, you'd have to use an HOC, or a utility such as withMergedProps in order to do that.

      {
        // ...
        admin: {
          components: {
            Label: {
              path: '/collections/Posts/MyServerComponent.js#MyExportName',
              // exportName: 'MyComponent2' // optional if you wish to omit the export name from the path
              clientProps: {
                someClientProp: 'someValue'
              },
              serverProps: {
                someServerProp: () => 'someValue'
              }
            }
          },
        },
      }
  

  More info regarding how the new component path imports work can be found in our custom component imports docs

2. useConfig hook changes

• If you are using the useConfig React hook anywhere in your Custom Components, its return value has changed in shape. The config is now a property within the context object, rather than the return value itself. To migrate, simply destructure the config property from the return value of useConfig:

  Old:

  import { useConfig } from "@payloadcms/ui"
  // ...
  const config = useConfig()
  

  New:

  import { useConfig } from "@payloadcms/ui"
  // ...
  const { config } = useConfig()
  

3. useComponentMap hook was deprecated

• If you were using the useComponentMap React hook anywhere in your Custom Components, it no longer exists. Instead, it has been merged into useConfig. To migrate, swap it out for the new hook:

  Old:

  import { useComponentMap } from "@payloadcms/ui"
  // ...
  const { componentMap, getComponentMap } = useComponentMap()
  const collectionComponentMap = getComponentMap({ collectionSlug: "pages" })
  

  New:

  import { useConfig } from "@payloadcms/ui"
  // ...
  const { config, getEntityConfig } = useConfig()
  const collectionClientConfig = getEntityConfig({ collectionSlug: "pages" })
  

4. Custom Component props have changed

• If you were using Custom Fields anywhere in your code, their props have changed in shape. Previously, field props were spread in at the top-level of the component. Now, they are nested under the field key, which is a client-safe version of that field's config. To migrate, simply change your prop references to be nested under field:

  Old:

  import type { TextFieldProps } from "payload"
  
  const MyCustomField: : React.FC<TextFieldProps> = ({ name }) => {
    return <div>{name}</div>
  }
  

  New:

  import type { TextFieldProps } from "payload"
  
  const MyCustomField: : React.FC<TextFieldProps> = ({ field: { name } }) => {
    return <div>{name}</div>
  }
  

  This example demonstrates a simple text field, but this same thing applies to all field types. The type naming convention is consistent across all field types, so you can easily find the type definitions for your respective field type.

5. useFieldProps is not necessary anymore

• If you were using the useFieldProps hook in your Custom Client Components, this is no longer needed. Now, client components are automatically detected and rendered client-side which direct props. To migrate your Custom Client Components, simply remove the useFieldProps hook from your component and read directly from props:

  Old:

  "use client"
  import type { TextFieldProps } from "payload"
  import { useFieldProps } from "@payloadcms/ui"
  
  const MyCustomClientComponent: React.FC<TextFieldProps> = () => {
    const { path } = useFieldProps()
    return <div>{path}</div>
  }
  

  New:

  "use client"
  import type { TextFieldProps } from "payload"
  
  const MyCustomClientComponent: React.FC<TextFieldProps> = ({
    field: { _path },
  }) => {
    return <div>{_path}</div>
  }
  

6. Custom views and tab config changes

• The shape of Custom Views and Custom Tabs has changed. Previously, you could define Custom Views and Tabs top-level in the config object OR as a configuration object. Now, you can only define them as a configuration object. For this reason, the keys have changed in casing to reflect the new shape (CapitalCase denotes a React component, camelCase denotes a regular object). To migrate, simply change the casing of of these keys within your Payload Config:

  Old:

  {
    // ...
    admin: {
      components: {
        views: {
          Edit: {
            Default: {
              Tab: MyCustomTab
            },
            API: MyCustomAPIView
          }
        }
      }
    }
  }
  

  New:

  {
    // ...
    admin: {
      components: {
        views: {
          edit: {
            default: {
              tab: {
                // ...
              }
            },
            api: {
              // ...
            }
          }
        }
      }
    }
  }
  

  This example demonstrates only a subset of the Custom Views that are available in the Payload Config. The same change applies to all Custom Views and Tabs, such as admin.views.account at the root-level, or admin.views.list on Collection Configs.

Other Updates

This release also includes other miscellaneous features and fixes, including:

FEATURES

• richtext-lexical: move migration related features to /migrate subpath export in order to decrease module count when those are not used (#7660) (a192632)
• filename compound index (#7651) (5fc9f76)

BUG FIXES

• richtext-lexical: inline blocks and tables not functioning correctly if they are used in more than one editor on the same page (#7665) (fca4ee9)
• live-preview: encode query string url (#7635) (9cb84c4)

BREAKING CHANGES

• richtext-lexical: move migration related features to /migrate subpath export in order to decrease module count when those are not used (#7660) (a192632)

This lowers the module count by 31 modules

BREAKING: Migration-related lexical modules are now exported from @payloadcms/richtext-lexical/migrate instead of @payloadcms/richtext-lexical

Contributors

• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• James Mikrut (@jmikrut)
• Patrik (@PatrikKozak)
• Paul (@paulpopus)

v3.0.0-beta.78 (2024-08-13)

Features

• add support for custom image size file names (#7634) (56aded8)
• plugin-form-builder: pass beforeChange params into beforeEmail hook and add types to it (#7626) (78dd6a2)
• plugin-redirects: added new option for redirect type in the redirects collection (#7625) (5dfcffa)
• indent migration sql (#7475) (fa3d250)
• adds classnames to list, edit views (#7596) (c1b0d93)

Bug Fixes

• config deepmerge, fixes #7580 (#7639) (b33b5f4)
• autoLogin not working if old, invalid token is present (#7456) (a063b81)
• payload: filtering by polymorphic relationships with drafts enabled (#7570) (8d12037)
• ui: render singular label for ArrayCell when length is 1 (#7586) (f88cef5)
• ui: field permissions not being correctly updated when locale changes (#7611) (4b2a9f7)
• ui: apiKey field not being customisable and field access control not being updated with correct data (#7591) (69ada97)
• set correct step nav path to Account on account page (#7599) (81e7355)
• add editDepth to account view so that it doesn't redirect from modals (#7597) (ce8b95f)
• corrects local strategy user lookup when using loginWithUsername (#7587) (6227276)

Contributors

• James Mikrut (@jmikrut)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Dan Ribbens (@DanRibbens)
• Tylan Davis (@tylandavis)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.77 (2024-08-08)

Bug Fixes

• empty path in error message (#7555) (b546c7b)

Contributors

• Elliot DeNolf (@denolfe)
• Jessica Chowdhury (@JessChowdhury)

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

Bug Fixes

• richtext-lexical: next.js multiple refs of same fix (#7572) (b5d65dd)

Contributors

• Elliot DeNolf (@denolfe)

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

Features

• db-*: allows for running migrations in production automatically (#7563) (1cb1e5e)
• bump next canary to 104 and update withPayload for new config (#7541) (8d1fc6e)
• richtext-lexical: export serialized inline blocks and table node types (ffd8ea5)

Bug Fixes

• db-postgres: #7492 migrate snapshots (#7540) (46f70d9)
• plugin-seo: issue with generating image from a function (#7566) (b7e2c59)
• hydrate permissions on dashboard, fix active menu item logic (0cc7184)
• ui: fixes issue when filtering by checkbox value in a different language (#7547) (4a20a63)
• next, payload: enable relationship & upload version tracking when localization enabled (#7508) (62744e7)
• richtext-lexical: html converters not respecting overrideAccess property when populating values, in local API (c15d679)
• scopes preferences queries and mutations by user (#7534) (a422a0d)
• ensure pw confirmation when creating users in admin panel (#7535) (edaeb1e)
• custom meta icons getting overwritten by default icon (#7466) (6f35c35)

BREAKING CHANGES

• adjusts auth hydration from server (#7545) (e905675)

  Fixes https://github.com/payloadcms/payload/issues/6823

  Allows the server to initialize the AuthProvider via props. Renames HydrateClientUser to HydrateAuthProvider. It now only hydrates the permissions as the user can be set from props. Permissions can be initialized from props, but still need to be hydrated for some pages as access control can be specific to docs/lists etc.

  • Renames exported HydrateClientUser to HydrateAuthProvider

• ⚠️ bump next canary to 104 and update withPayload for new config (#7541) (8d1fc6e)

  We are now bumping up the Next canary version to 15.0.0-canary.104 and react and react-dom to ^19.0.0-rc-06d0b89e-20240801.

  Your new dependencies should look like this:

  "next": "15.0.0-canary.104",
  "react": "^19.0.0-rc-06d0b89e-20240801",
  "react-dom": "^19.0.0-rc-06d0b89e-20240801",
  

• richtext-lexical: html converters not respecting overrideAccess property when populating values, in local API (c15d679)

Contributors

• James Mikrut (@jmikrut)
• Paul (@paulpopus)
• Dan Ribbens (@DanRibbens)
• Jarrod Flesch (@JarrodMFlesch)
• Patrik (@PatrikKozak)
• Alessio Gravili (@AlessioGr)
• Jessica Chowdhury (@JessChowdhury)

v3.0.0-beta.74 (2024-08-06)

Features

• richtext-lexical: add HTML converter to table feature (9bccdfd)
• richtext-lexical: accessible editor placeholders (c348081)
• richtext-lexical: add table hover actions to quickly add rows or columns (12ba820)
• allows loginWithUsername to not require username (#7480) (1ebd54b)
• updated admin UI (#7424) (68553ff)
• expose useTableColumns hook (#7448) (9a3bce1)
• richtext-lexical: upgrade lexical from 0.16.1 to 0.17.0 (e65b647)

Bug Fixes

• email and username fields rendering in drawers (#7520) (442189e)
• richtext-lexical: various table and icon style issues (#7522) (5d1cc76)
• ui: prevents hasMany text going outside of input boundaries (#7455) (3f5403a)
• ui: properly handles ID field component type based on payload.db.defaultIDType (#7416) (62666a9)
• db-*: drizzle enums, bump drizzle-kit (#7514) (95fcd13)
• cpa: adjust template file location detection (#7507) (0040e17)
• error thrown in version view when localization is false (#7502) (cdb2072)
• #7488, cant deploy SQLite to Vercel (#7490) (005befc)

BREAKING CHANGES

• updated admin UI (#7424) (68553ff)

  • Custom components and styling that don't utilize Payload's CSS/SCSS variables may need adjustments to match the updated styling.
  • If you are using the Merriweather font, you will need to manually configure next/font in your own project.

• richtext-lexical: upgrade lexical from 0.16.1 to 0.17.0 (e65b647)

  • This upgrades lexical from 0.16.1 to 0.17.0. If you have any lexical packages installed in your project, please update them accordingly. Additionally, if you depend on the lexical APIs, please consult their changelog, as lexical may introduce breaking changes: https://github.com/facebook/lexical/releases/tag/v0.17.0

Contributors

• Jarrod Flesch (@JarrodMFlesch)
• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Jessica Chowdhury (@JessChowdhury)
• Tylan Davis (@tylandavis)
• Willy Brauner (@willybrauner)
• James Mikrut (@jmikrut)

v3.0.0-beta.73 (2024-08-02)

Features

• adds upload's relationship thumbnail (#7473) (4d19e64)
• cpa: add sqlite (#7470) (3114359)

Bug Fixes

• too many RSC props were being passed, inflating initial HTML size (#7474) (995f51d)
• set active nav item (#7467) (f752804)

v3.0.0-beta.72 (2024-08-01)

Features

• adds restore as draft option to versions (#7100) (d307d62)
• ui: expose custom errors in deleteMany (#7438) (febd7f7)
• db-*: add defaultValues to database schemas (#7368) (695ef32)
• cpa: warn on unsupported Next.js version (#7434) (6f5cf5d)
• db-*, payload: better transactions (#7395) (3545888)

Bug Fixes

• db-postgres: incorrect schema type on adapter (#7459) (449c16d)
• db-postgres, db-sqlite: enum schema (#7453) (0758199)
• db-postgres: localized array inside blocks field (#7457) (1ec78a1)
• validates password and confirm password on the server (#7410) (290ffd3)
• ui: reincorporate basePath into logout component link (#7451) (3d89508)
• db-postgres: proper migrations table detection query (#7436) (b5b2bb1)
• formats locales for version comparison view (#7433) (5ef2951)
• hide force unlock button if the user has no permissions to interact with it (#7418) (a943487)
• page param not getting reset when applying filters (#7243) (ada9978)
• next: infinite loop when logging into root admin (#7412) (874279c)
• types for the 'validate' property across fields so internal validation functions can be reused (#7394) (7ed6634)
• export default was not found in graphql (#6975) (09a0ee3)
• plugin-search: ensure search updates are unique to collection (#6363) (67acab2)
• layout preferences for array/blocks were being saved twice in dev mode (#7396) (5cd0c7e)

Contributors

• Dan Ribbens (@DanRibbens)
• Jessica Chowdhury (@JessChowdhury)
• Jarrod Flesch (@JarrodMFlesch)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Michel v. Varendorff (@mvarendorff)
• Lynn Dylan Hurley (@lynndylanhurley)

v3.0.0-beta.71 (2024-07-29)

Features

• ui: passes field props to custom components (#7360) (97837f0)
• adds keepAfterRead to plugin-relationship-objectid (#7388) (f9e5573)

Bug Fixes

• db-sqlite: migration template errors (#7404) (6d066c2)
• db-postgres: migration template type error (#7403) (1dc4288)
• merges headers safely in nextjs route handlers (#7399) (c8da9b1)
• ui: stacking drawers (#7397) (2021028)
• docs: update import path for validation functions for fields (#7392) (2ea56fe)
• ui: handle abort() call signal error (#7390) (5655266)
• ui: spacing in row fields by using gap instead of inner margins (#7387) (e823051)

BREAKING CHANGES

• ui: passes field props to custom components (#7360) (97837f0)

  Currently, there is no way to read field props from within a custom field component, i.e. admin.components.Description. For example, if you set maxLength: 100 on your field, your custom description component cannot read it from props.maxLength or any other methods. Because these components are rendered on the server, there is also no way of using admin.component.Field to inject custom props yourself, either. To support this, we can simply pass the base component props into these components on the server, as expected. This has also led to custom field component props becoming more strictly typed within the config.

  This change is considered breaking only because the types have changed. This only affects you if you were previously importing the following types into your own custom components. To migrate, simply change the import paths for that type.

  Old:

  import type {
    ArrayFieldProps,
    ReducedBlock,
    BlocksFieldProps,
    CheckboxFieldProps,
    CodeFieldProps,
    CollapsibleFieldProps,
    DateFieldProps,
    EmailFieldProps,
    GroupFieldProps,
    HiddenFieldProps,
    JSONFieldProps,
    NumberFieldProps,
    PointFieldProps,
    RadioFieldProps,
    RelationshipFieldProps,
    RichTextComponentProps,
    RowFieldProps,
    SelectFieldProps,
    TabsFieldProps,
    TextFieldProps,
    TextareaFieldProps,
    UploadFieldProps,
    ErrorProps,
    FormFieldBase, 
    FieldComponentProps,
    FieldMap,
    MappedField,
    MappedTab,
    ReducedBlock,
  } from '@payloadcms/ui'
  

  New:

  import type {
    FormFieldBase, 
    // etc.
  } from 'payload'
  

  Custom field components are now much more strongly typed. To make this happen, an explicit type for every custom component has been generated for every field type. The convention is to append DescriptionComponent, LabelComponent, and ErrorComponent onto the end of the field name, i.e. TextFieldDescriptionComponent. Here's an example:

  import type { TextFieldDescriptionComponent } from 'payload'
  
  import React from 'react'
  
  export const CustomDescription: TextFieldDescriptionComponent = (props) => {
    return (
      <div id="custom-field-description">{`The max length of this field is: ${props?.maxLength}`}</div>
    )
  }
  

  Here's the full list of all new types:

  Label Components:

  import type {
    ArrayFieldLabelComponent,
    BlocksFieldLabelComponent,
    CheckboxFieldLabelComponent,
    CodeFieldLabelComponent,
    CollapsibleFieldLabelComponent,
    DateFieldLabelComponent,
    EmailFieldLabelComponent,
    GroupFieldLabelComponent,
    HiddenFieldLabelComponent,
    JSONFieldLabelComponent,
    NumberFieldLabelComponent,
    PointFieldLabelComponent,
    RadioFieldLabelComponent,
    RelationshipFieldLabelComponent,
    RichTextFieldLabelComponent,
    RowFieldLabelComponent,
    SelectFieldLabelComponent,
    TabsFieldLabelComponent,
    TextFieldLabelComponent,
    TextareaFieldLabelComponent,
    UploadFieldLabelComponent
  } from 'payload'
  

  Error Components:

  import type {
    ArrayFieldErrorComponent,
    BlocksFieldErrorComponent,
    CheckboxFieldErrorComponent,
    CodeFieldErrorComponent,
    CollapsibleFieldErrorComponent,
    DateFieldErrorComponent,
    EmailFieldErrorComponent,
    GroupFieldErrorComponent,
    HiddenFieldErrorComponent,
    JSONFieldErrorComponent,
    NumberFieldErrorComponent,
    PointFieldErrorComponent,
    RadioFieldErrorComponent,
    RelationshipFieldErrorComponent,
    RichTextFieldErrorComponent,
    RowFieldErrorComponent,
    SelectFieldErrorComponent,
    TabsFieldErrorComponent,
    TextFieldErrorComponent,
    TextareaFieldErrorComponent,
    UploadFieldErrorComponent
  } from 'payload'
  

  Description Components:

  import type {
    ArrayFieldDescriptionComponent,
    BlocksFieldDescriptionComponent,
    CheckboxFieldDescriptionComponent,
    CodeFieldDescriptionComponent,
    CollapsibleFieldDescriptionComponent,
    DateFieldDescriptionComponent,
    EmailFieldDescriptionComponent,
    GroupFieldDescriptionComponent,
    HiddenFieldDescriptionComponent,
    JSONFieldDescriptionComponent,
    NumberFieldDescriptionComponent,
    PointFieldDescriptionComponent,
    RadioFieldDescriptionComponent,
    RelationshipFieldDescriptionComponent,
    RichTextFieldDescriptionComponent,
    RowFieldDescriptionComponent,
    SelectFieldDescriptionComponent,
    TabsFieldDescriptionComponent,
    TextFieldDescriptionComponent,
    TextareaFieldDescriptionComponent,
    UploadFieldDescriptionComponent
  } from 'payload'
  

  This PR also:

  • Standardizes the FieldBase['label'] type with a new LabelStatic type. This makes type usage much more consistent across components.
  • Simplifies some of the typings in the field component map, removes unneeded <Omit>, etc.
  • Fixes misc. linting issues around voiding promises

• ui: update the names of internal components so that they respect eslint rules (#7362) (e734d51)

So _Upload becomes UploadComponent which doesnt break the naming convention of react components and we no longer export these internal components

Contributors

• Dan Ribbens (@DanRibbens)
• James Mikrut (@jmikrut)
• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Patrik (@PatrikKozak)

v3.0.0-beta.70 (2024-07-26)

Features

• templates: add live preview breakpoints for mobile, tablet and desktop to website template (#7384) (4704c8d)
• cpa: support next.config.ts (#7367) (a64f37e)

Bug Fixes

• db-postgres: properly reference drizzle createTableName function (#7383) (55c6ce9)

Contributors

• Paul (@paulpopus)
• Elliot DeNolf (@denolfe)

v3.0.0-beta.69 (2024-07-26)

Features

• payload: allows metadata to be appended to the file of the output media (#7293) (b5afc62)
• drizzle: abstract shared sql code to new package (#7320) (09ad6e4)
• adds @payloadcms/live-preview-vue to release pipeline (#7328) (904ec01)
• next: root admin (#7276) (863abc0)

Bug Fixes

• filterOptions for upload fields (#7347) (70f2e16)
• db-mongodb: adds new optional collation feature flag behind mongodb collation option (#7361) (8ba39aa)
• ui: hide 'Create new' button entirely if user has no access to create a media item (#7348) (128d721)
• attempts to use query.locale when present in createLocalReq (#7345) (2796d21)
• relaxes equality check for relationship options in filter (#7343) (cbac62a)
• db-postgres: localized groups/tabs and nested fields (#6158) (51f1c8e)
• some email adapters not working if they're promises due to config sanitisation (#7326) (c129c10)
• misc issues with loginWithUsername (#7311) (b2814eb)
• ui: email field now correctly renders autocomplete attribute (#7322) (c405e59)
• plugin-stripe: properly types async webhooks (#7317) (a35979f)
• ui: Where query selectors for checkboxes are now translated (#7309) (b9cf6c7)
• first version doc throws error (#7314) (f2b3305)
• db-mongodb: removes precedence of regular chars over international chars in sort (#7294) (b3e8ddf)
• cpa: check cmd exists after first checking flag and lock file (#7297) (83ad453)

Contributors

• James Mikrut (@jmikrut)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Jarrod Flesch (@JarrodMFlesch)
• Ritsu (@r1tsuu)
• Dan Ribbens (@DanRibbens)
• Jacob Fletcher (@jacobsfletch)
• Jessica Chowdhury (@JessChowdhury)

v3.0.0-beta.68 (2024-07-22)

Features

• upgrade pino and pino-pretty, clean up hacky esm imports (#7291) (4584478)
• remove joi schema validation (#7226) (e83eb99)
• 700% faster deepCopyObject, refactor deep merging and deep copying, type improvements (#7272) (c45fbb9)
• new server-only, faster and immediate autoLogin (#7224) (a7b0f8b)
• ui: change autosave logic to send updates as soon as possible, improving live preview speed (#7201) (014ee1a)
• update reserved fields name check to be more comprehensive and only check top level fields (#7235) (76b3075)

Bug Fixes

• search plugin localized fields (#7292) (5aa3283)
• templates: website template building error with postgres number IDs (#7281) (bba7cf3)
• ui: not updating permissions when locale changes (#7245) (1ae71a3)
• payload: resizes images first before applying focal point (#7277) (2c16c60)
• api errors not populating in prod (#7232) (3d63ce9)

BREAKING CHANGES

• 700% faster deepCopyObject, refactor deep merging and deep copying, type improvements (#7272) (c45fbb9)

  • The deepMerge exported from payload now handles more complex data and is slower. The old, simple deepMerge is now exported as deepMergeSimple
  • combineMerge is no longer exported. You can use deepMergeWithCombinedArrays instead
  • The behavior of the exported deepCopyObject and isPlainObject may be different and more reliable, as the underlying algorithm has changed

• new server-only, faster and immediate autoLogin (#7224) (a7b0f8b)

  • autoLogin without prefillOnly set now also affects graphQL/Rest operations. Only the user specified in autoLogin will be returned. Within the graphQL/Rest/Local API, this should still allow you to authenticate with a different user, as the autoLogin user is only used if no token is set.

Contributors

• Jarrod Flesch (@JarrodMFlesch)
• Alessio Gravili (@AlessioGr)
• Paul (@paulpopus)
• Dan Ribbens (@DanRibbens)
• Patrik (@PatrikKozak)
• Jacob Fletcher (@jacobsfletch)
• Elliot DeNolf (@denolfe)

v3.0.0-beta.67 (2024-07-18)

Bug Fixes

• ui: uploading from drawer & focal point positioning (#7117) (00771b1)

Contributors

• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.66 (2024-07-18)

Features

• ability to login with email, username or both (#7086) (7b3b021)
• add db idType to generated payload types (#7186) (502548a)
• richtext-lexical: inline blocks (#7102) (676dfa3)
• next: strongly type getNextRequestI18n (#7157) (c6da04a)

Bug Fixes

• cherry picks lockUntil fix from #6052 (#7213) (478fb8d)
• aliases AfterMe, AfterLogout, and AfterRefresh hook types (#7216) (700baf1)
• templates: bad import in website seed script (#7198) (a3af360)
• maxListenersExceeded warning due to atomically, which is a peerdep of conf (#7182) (1fe6761)
• ui: search queries remain between navigation (#7169) (f909f06)
• richtext-lexical: slash menu keyboard navigation not triggering auto-scroll (#7185) (fe23ca5)
• webpack error if dbName or enumName was set (#7184) (8fdd88b)
• ui: date field background color specificity (#7181) (1ea2e32)
• version comparison view showing empty localized fields (#7180) (8fb17c2)
• localised relationship fields (#7178) (2f0aa83)

BREAKING CHANGES

• aliases AfterMe, AfterLogout, and AfterRefresh hook types (#7216) (700baf1)

Duplicate of #7146 but for beta. If you were using the AfterMeHook, AfterLogoutHook, or AfterRefreshHook, these types have been renamed and are now prefixed with Collection to match all other hook naming conventions, just as the documentation already indicates.

Old:

import type { AfterMeHook, AfterLogoutHook, AfterRefreshHook } from 'payload'

New:

import type { CollectionAfterMeHook, CollectionAfterLogoutHook, CollectionAfterRefreshHook } from 'payload'

Contributors

• Jarrod Flesch (@JarrodMFlesch)
• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jessica Chowdhury (@JessChowdhury)

v3.0.0-beta.65 (2024-07-15)

Features

• configure cors allowed headers (#6837) (9c72ab9)

Bug Fixes

• richtext-lexical: newly created upload nodes with extra fields do not display fields when opening extra fields drawer (#7155) (35f7a9e)
• richtext-*: nested field recursion for named tabs did not work (8c5a1f0)
• richtext-lexical: one-line migrators not detecting richText migrations in nested fields (6d68a4a)
• email-nodemailer: skipVerify behavior being reversed (#6790) (f494eba)
• custom tabs not working in globals (#7148) (24f55c9)

Contributors

• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Hulpoi George-Valentin (@GeorgeHulpoi)
• Jasper Beaurain (@JasperBeaurain)
• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)

v3.0.0-beta.63 (2024-07-12)

Fixes publishing issue

v3.0.0-beta.62 (2024-07-12)

Features

• validate field names for reserved names (#7130) (03d854e)
• ui: various admin panel styling improvements (#7121) (c359c34)
• suppress email adapter warning on build (#7129) (b750ebf)
• ui: updates version status UI to be more informative (#6661) (c019969)
• richtext-lexical: add missing SerializedLineBreakNode to default node types, remove SerializedBlockNode from default node types (1c8bed5)
• richtext-lexical: allow SerializedBlockNode fields to be typed via generic (10336ba)

Contributors

• Paul (@paulpopus)
• Tylan Davis (@tylandavis)
• Jacob Fletcher (@jacobsfletch)
• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Jessica Chowdhury (@JessChowdhury)

v3.0.0-beta.61 (2024-07-12)

Features

• upgrade minimum react, react-dom, @types/react and @types/react-dom versions to match exactly what Next.js is using, various dependency cleanup (#7106) (f86e0ed)
• adds ability to upload files from a remote url (#7063) (d99bff9)

Bug Fixes

• ui: ctrl+s not triggering a save if autosave is enabled (#7120) (840e075)
• templates: website template gitignore issue for case sensitivity (#7118) (1baf775)
• richtext-lexical: export types as type-only exports (#7097) (edf743e)

BREAKING CHANGES

• upgrade minimum react, react-dom, @types/react and @types/react-dom versions to match exactly what Next.js is using, various dependency cleanup (#7106) (f86e0ed)

BREAKING:

• Upgrades minimum supported @types/react version from npm:types-react@19.0.0-beta.2 to npm:types-react@19.0.0-rc.0
• Upgrades minimum supported @types/react-dom version from npm:types-react-dom@19.0.0-beta.2 to npm:types-react-dom@19.0.0-rc.0
• Upgrades minimum supported react and react-dom version from 19.0.0-rc-f994737d14-20240522 to 19.0.0-rc-6230622a1a-20240610

Contributors

• Jacob Fletcher (@jacobsfletch)
• Paul (@paulpopus)
• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)
• Patrik (@PatrikKozak)

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)

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)

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)

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)

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)

v3.0.0-beta.46 (2024-06-12)

Features

• diff generated types before write (#6749) (be0462d)
• richtext-lexical: sub-field hooks and localization support (#6591) (4e12705)

Bug Fixes

• corrects block duplicate action and add tests (#6589) (763a34f)
• unawaited emails (#6265) (6e55a2e)
• ui: hideGutter was ignored in group field (#6613) (de45e60)
• add missing export for useLeaf hook (#6693) (74159de)
• list sort preferences (#6731) (ba92d86)

BREAKING CHANGES

• richtext-lexical: sub-field hooks and localization support (#6591) (4e12705)

BREAKING

• Our internal field hook methods now have new required schemaPath and path props. This affects the following functions, if you are using those: afterChangeTraverseFields, afterReadTraverseFields, beforeChangeTraverseFields, beforeValidateTraverseFields, afterReadPromise
• The afterChange field hook's value is now the value AFTER the previous hooks were run. Previously, this was the original value, which I believe is a bug
• Only relevant if you have built your own richText adapter: the richText adapter populationPromises property has been renamed to graphQLPopulationPromises and is now only run for graphQL. Previously, it was run for graphQL AND the rest API. To migrate, use hooks.afterRead to run population for the rest API
• Only relevant if you have built your own lexical features: The populationPromises server feature property has been renamed to graphQLPopulationPromises and is now only run for graphQL. Previously, it was run for graphQL AND the rest API. To migrate, use hooks.afterRead to run population for the rest API
• Serialized lexical link and upload nodes now have a new id property. While not breaking, localization / hooks will not work for their fields until you have migrated to that. Re-saving the old document on the new version will automatically add the id property for you. You will also get a bunch of console logs for every lexical node which is not migrated

Contributors

• Jessica Chowdhury (@JessChowdhury)
• Elliot DeNolf (@denolfe)
• Alessio Gravili (@AlessioGr)
• Anders Semb Hermansen (@andershermansen)
• Patryk Kowalczyk (@Patryk-Kowalczyk)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.45 (2024-06-11)

Features

• move from react-toastify to sonner (#6682) (cb3355b)

Bug Fixes

• toasts padding and button placement by 1px (#6730) (2ada6fc)
• only use metadata.pages for height if animated (#6728) (10c6ffa)
• create sharp file for fileHasAdjustments files or fileIsAnimated files (#6708) (6512d5c)
• corrects field-paths that were incorrectly being set (#6724) (57fcc91)

BREAKING CHANGES

• move from react-toastify to sonner (#6682) (cb3355b)

We now export toast from sonner instead of react-toastify. If you send out toasts from your own projects, make sure to use our toast export, or install sonner. React-toastify toasts will no longer work anymore. The Toast APIs are mostly similar, but there are some differences if you provide options to your toast

CSS styles have been changed from Toastify

/* before */
.Toastify


/* current */
.payload-toast-container
.payload-toast-item
.payload-toast-close-button

/* individual toast items will also have these classes depending on the state */
.toast-info
.toast-warning
.toast-success
.toast-error

https://github.com/payloadcms/payload/assets/70709113/da3e732e-aafc-4008-9469-b10f4eb06b35

Contributors

• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Patrik (@PatrikKozak)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.44 (2024-06-11)

Features

• type auto-generation (#6657) (7309d47)

Bug Fixes

• get auto type-gen to work on turbo, by running type gen in a child process outside turbo/webpack (#6714) (7b7dc71)
• corrects tab paths when nested within other row like fields (#6712) (ba513d5)
• re-exports graphql json types for external use (#6711) (a26d031)
• ui: removes array & blocks & group fields from sort (#6576) (9f52562)
• global draft validations (#6709) (45e8683)
• ui: set checkbox htmlFor by default, fixing some checkbox labels not toggling the checkbox (#6684) (ac34380)

BREAKING CHANGES

• type auto-generation (#6657) (7309d47)

Types are now auto-generated by default.

You can opt-out of this behavior by setting:

buildConfig({
  // Rest of config
  typescript: {
    autoGenerate: false
  },
})

Contributors

• Alessio Gravili (@AlessioGr)
• Jarrod Flesch (@JarrodMFlesch)
• Patrik (@PatrikKozak)
• Elliot DeNolf (@denolfe)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.43 (2024-06-07)

Features

• adds draft validation option (#6677) (52c81ad)
• plugin-redirects: update fields overrides to use a function (#6675) (e4a9029)
• richtext-*: allow omitting the root editor property (#6660) (11c3a65)
• upgrade minimum node 20 version from 20.6.0 to 20.9.0 (#6659) (9bd9e7a)

Bug Fixes

• next: live preview device position when using zoom (#6665) (7c8d562)
• max versions config not being respected on globals (#6654) (8dd5e4d)

BREAKING CHANGES

• plugin-redirects: update fields overrides to use a function (#6675) (e4a9029)

Description

Updates the fields override in plugin redirects to allow for overriding

// before
overrides: {
  fields: [
    {
      type: 'text',
      name: 'customField',
    },
  ],
},

// current
overrides: {
  fields: ({ defaultFields }) => {
    return [
      ...defaultFields,
      {
        type: 'text',
        name: 'customField',
      },
    ]
  },
},

• upgrade minimum node 20 version from 20.6.0 to 20.9.0 (#6659) (9bd9e7a)

• This bumps the minimum required node version from node 20.6.0 to node 20.9.0. This is because 20.6.0 breaks type generation due to a CJS node bug, and 20.9.0 is the next v20 LTS version. The minimum node 18 version stays the same (18.20.2)

Contributors

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

v3.0.0-beta.42 (2024-06-06)

Bug Fixes

• ui: global documents disabled after save (#6652) (267c236)

Contributors

• Jacob Fletcher (@jacobsfletch)
• Alessio Gravili (@AlessioGr)

v3.0.0-beta.41 (2024-06-05)

Features

• support Next.js basePath config property (#6628) (b2751f7)
• ui: expose RowLabelProps (#6627) (1afd221)
• richtext-lexical: upgrade lexical from 0.15.0 to 0.16.0 and port over relevant playground changes (#6620) (da35afb)

Bug Fixes

• db-postgres: create predefined migration missing json schema output (#6641) (ff82bb5)
• update file-type dependency and fix dependency version mismatch (#6638) (2077da8)
• translations: explicitly declare date-fns v3 as a dependency (#6626) (aeb4df8)
• resizing animated images (#6623) (bcd277e)
• migration file cannot be imported (#6616) (cafc13a)

BREAKING CHANGES

• db-postgres: create predefined migration missing json schema output (#6641) (ff82bb5)

Fixes #6630

This only applies to you if you using db-postgres and have created the v2-v3-relationships migration released in v3.0.0-beta.39 from @payloadcms/db-postgres <= v3.0.0-beta.40.

Steps to fix

• Delete the existing v2-v3-relationships migration file.
• If changes were made to your config since the previous migration was made, you will need to revert those by checking out a previous commit in your version control.
• Recreate the migration using payload migrate:create --file @payloadcms/db-postgres/relationships-v2-v3 to make the migration with the snapshot .json file.

• richtext-lexical: upgrade lexical from 0.15.0 to 0.16.0 and port over relevant playground changes (#6620) (da35afb)

BREAKING:

• This upgrades the required version of lexical from 0.15.0 to 0.16.0. If you are using lexical directly in your project, possibly due to custom features, there might be breaking changes for you. Please consult the lexical 0.16.0 changelog: https://github.com/facebook/lexical/releases/tag/v0.16.0

Contributors

• Dan Ribbens (@DanRibbens)
• Alessio Gravili (@AlessioGr)
• Elliot DeNolf (@denolfe)
• Jacob Fletcher (@jacobsfletch)
• Patrik (@PatrikKozak)
• Paul (@paulpopus)

v3.0.0-beta.40 (2024-06-04)

Features

• match next.js env file loading behavior in bin scripts & importConfig, clean up installed packages & mismatching package versions (#6601) (59cde0d)
• richtext-lexical: configurable fixed toolbar (#6560) (f41bb05)

Bug Fixes

• pin ajv to 8.14.0, as 8.15.0 is broken (#6606) (45b02d8)
• plugin-form-builder: fix bug with optional chain operator in field overrides logic (#6602) (1aece39)
• db-postgres: type issue in migratePostgresV2toV3 call if ts strict mode is enabled (#6585) (c3589de)
• richtext-lexical: minor design improvements (#6575) (c7fbd76)
• critical getPredefinedMigration dependency error (#6578) (6b9c796)
• richtext-*: fix client features were not loaded properly, improve performance of LexicalProvider, slate cell component was non-functional, support richtext adapter Cell RSCs (#6573) (5cb49c3)

BREAKING CHANGES

• richtext-lexical: configurable fixed toolbar (#6560) (f41bb05)

BREAKING: useEditorFocusProvider has been removed and merged with useEditorConfigContext. You can now find information about the focused editor, parent editors and child editors within useEditorConfigContext

Contributors

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

v3.0.0-beta.39 (2024-05-30)

Features

• db-postgres: relationship column (#6339) (edfa85b)

Bug Fixes

• next: ssr live preview was not dispatching document save events (#6572) (e603c83)

BREAKING CHANGES 💥

• db-postgres: relationship column (#6339) (edfa85b)

Moves upload field and relationship fields with hasMany: false & relationTo: string from the many-to-many _rels join table to simple columns. This only affects Postgres database users.

TL;DR

We have dramatically simplified the storage of simple relationships in relational databases to boost performance and align with more expected relational paradigms. If you are using the beta Postgres adapter, and you need to keep simple relationship data, you'll need to run a migration script that we provide you.

Background

For example, prior to this update, a collection of "posts" with a simple hasMany: false and relationTo: 'categories' field would have a posts_rels table where the category relations would be stored.

This was somewhat unnecessary as simple relations like this can be expressed with a category_id column which is configured as a foreign key. This also introduced added complexity for dealing directly with the database if all you have are simple relations.

Who needs to migrate

You need to migrate if you are using the beta Postgres database adapter and any of the following applies to you.

• If you have versions enabled on any collection / global
• If you use the upload field
• If you have relationship fields that are hasMany: false (default) and relationTo to a single category (has one) relations

We have a migration for you

Even though the Postgres adapter is in beta, we've prepared a predefined migration that will work out of the box for you to migrate from an earlier version of the adapter to the most recent version easily.

It makes the schema changes in step with actually moving the data from the old locations to the new before adding any null constraints and dropping the old columns and tables.

How to migrate

The steps to preserve your data while making this update are as follows. These steps are the same whether you are moving from Payload v2 to v3 or a previous version of v3 beta to the most recent v3 beta.

Important: during these steps, don't start the dev server unless you have push: false set on your Postgres adapter.

⚠️ Step 1 - backup

Always back up your database before performing big changes, especially in production cases.

⚠️ Step 2 - create a pre-update migration

Before updating to new Payload and Postgres adapter versions, run payload migrate:create without any other config changes to have a prior snapshot of the schema from the previous adapter version

⚠️ Step 3 - if you're migrating a dev DB, delete the dev push row from your payload_migrations table

If you're migrating a dev database where you have the default setting to push database changes directly to your DB, and you need to preserve data in your development database, then you need to delete a dev migration record from your database.

Connect directly to your database in any tool you'd like and delete the dev push record from the payload_migrations table using the following SQL statement:

DELETE FROM payload_migrations where batch = -1

⚠️ Step 4 - update Payload and Postgres versions to most recent

Update packages, making sure you have matching versions across all @payloadcms/* and payload packages (including @payloadcms/db-postgres)

⚠️ Step 5 - create the predefined migration

Run the following command to create the predefined migration we've provided:

payload migrate:create --file @payloadcms/db-postgres/relationships-v2-v3

⚠️ Step 6 - migrate!

Run migrations with the following command:

payload migrate

Assuming the migration worked, you can proceed to commit this change and distribute it to be run on all other environments.

Note that if two servers connect to the same database, only one should be running migrations to avoid transaction conflicts.

Related discussion: https://github.com/payloadcms/payload/discussions/4163

Contributors

• Elliot DeNolf (@denolfe)
• Dan Ribbens (@DanRibbens)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.38 (2024-05-30)

Features

• next,ui: improves loading states (#6434) (92f458d)
• extracts buildFormState logic from endpoint for reuse (#6501) (321e97f)

Bug Fixes

• cpa: safer command exists check (#6569) (4884f0d)
• ui: adjusts sizing of remove/add buttons to be same size (#6529) (f1db24e)
• ui field validation error with admin.disableListColumn property (#6531) (7f15147)
• translations: adds new userEmailAlreadyRegistered translations (#6550) (e0a6db7)
• cpa: more package manager detection improvements (#6566) (0d7d3e5)
• duplicate options appearing in relationship where builder (#6557) (3474642)
• plugin-search: Render error on custom UI component (#6562) (aa02801)
• ensure relationship field pills respect isSortable property (#6561) (425576b)
• ability to query relationships not equal to ID (#6555) (043a91d)

Contributors

• Elliot DeNolf (@denolfe)
• Patrik (@PatrikKozak)
• Jarrod Flesch (@JarrodMFlesch)
• Paul (@paulpopus)
• Jessica Chowdhury (@JessChowdhury)
• Jacob Fletcher (@jacobsfletch)

v3.0.0-beta.37 (2024-05-29)

Features

• richtext-lexical: link markdown transformers (#6543) (33d5312)
• richtext-lexical: i18n (#6542) (a8000f6)
• plugin-form-builder: update form builder plugin field overrides to use a function instead (#6497) (7d0e909)
• cpa: update existing payload installation (#6193) (10c94b3)
• richtext-lexical: i18n support (#6524) (c383f39)
• richtext-lexical: update validation of custom URLs to include relative and anchor links (#6525) (8a91a7a)

Bug Fixes

• cpa: improve package manager detection (#6546) (8506385)
• multi value draggable/sortable pills (#6500) (e749529)
• richtext-lexical: various html converter fixes (#6544) (4a51f4d)
• richtext-lexical: user-defined html converters not taking precedence, and shared default html converters doubling in size after every field initialization (2c283bc)
• richtext-lexical: list converters and nodes being added duplicatively (a2e9bcd)
• richtext-lexical: link html converter: serialize newTab to target="_blank" (#6350) (e0b201c)
• deps: proper location for scheduler peer dep (#6537) (2ddd50e)
• Add missing He lang export in payload/i18n (#6484) (6f5d86e)
• next: unable to pass custom view client components (#6513) (eff5129)
• separate collection docs with same ids were excluded in selectable (#6499) (18bc4b7)
• richtext-lexical: localized sub-fields were omitted from the API output (#6489) (7a76814)
• ui: where builder issues (#6478) (42222cd)

BREAKING CHANGES

• plugin-form-builder: update form builder plugin field overrides to use a function instead (#6497) (7d0e909)

Changes the fields override for form builder plugin to use a function instead so that we can actually override existing fields which currently will not work.

//before
fields: [
  {
    name: 'custom',
    type: 'text',
  }
]

// current
fields: ({ defaultFields }) => {
  return [
    ...defaultFields,
    {
      name: 'custom',
      type: 'text',
    },
  ]
}

Contributors

• Elliot DeNolf (@denolfe)
• Jarrod Flesch (@JarrodMFlesch)
• Alessio Gravili (@AlessioGr)
• Leo Hilsheimer (@linobino1)
• Paul (@paulpopus)
• zvizvi (@zvizvi)
• Dan Ribbens (@DanRibbens)
• Patrik (@PatrikKozak)

v3.0.0-beta.36 (2024-05-23)

Features

• next.js 15, react 19, react compiler support (#6429) (35f961f)
• add website template (#6470) (85bfca7)
• ui: split up Select component into Select and SelectInput (#6471) (661a4a0)
• richtext-lexical: various UX and performance improvements (#6467) (78579ed)
• richtext-lexical: improve block dragging UX (6b45cf3)
• next: server-side theme detection (#6452) (1fe9790)
• translations: add Hebrew translation (#6428) (3c0853a)
• richtext-lexical: various gutter, error states & add/drag handle improvements (#6448) (6c95287)

Bug Fixes

• adds host to initPage req creation (#6476) (72c0534)
• isHotkey webpack error (#6466) (73d0b20)
• richtext-lexical: order of add/drag handles was inconsistent between gutter and no-gutter mode (c93752b)
• ui: field errors aren't red in light mode (7a4dd58)
• next,ui: fixes global doc permissions and optimizes publish access data loading (#6451) (2b941b7)
• richtext-lexical: link drawer sending too many form state requests for actions unrelated to links (0bfbf9c)
• ui: disableListColumn fields not hidden in table columns (#6445) (bcc506b)

BREAKING CHANGES

• next.js 15, react 19, react compiler support (#6429) (35f961f)

BREAKING:

• bumps minimum required next.js version from 14.3.0-canary.68 to 15.0.0-rc.0
• bumps minimum required react and react-dom versions to 19.0.0 (19.0.0-rc-f994737d14-20240522 should be used)
• @types/react and @types/react-dom have to be bumped to npm:types-react@19.0.0-beta.2 using overrides and pnpm overrides, if you want correct types. You can find an example of this here: https://github.com/payloadcms/payload/pull/6429/files#diff-10cb9e57a77733f174ee2888587281e94c31f79e434aa3f932a8ec72fa7a5121L32

Issues

• Bunch of todos for our react-select package which is having type issues. Works fine, just type issues. Their type defs are importing JSX in a weird way, we likely just have to wait until they fix them in a future update.

• ui: uses consistent button naming conventions (#6444) (af7e12a)

Description

Renames the Save to SaveButton, etc. to match the already established convention of the PreviewButton, etc. This matches the imports with their respective component and type names, and also gives these components more context to the developer whenever they're rendered, i.e. its clearly just a button and not an entire block or complex component.

BREAKING:

Import paths for these components have changed, if you were previously importing these components into your own projects to customize, change the import paths accordingly:

Old:

import { PublishButton } from '@payloadcms/ui/elements/Publish'
import { SaveButton } from '@payloadcms/ui/elements/Save'
import { SaveDraftButton } from '@payloadcms/ui/elements/SaveDraft'

New:

import { PublishButton } from '@payloadcms/ui/elements/PublishButton'
import { SaveButton } from '@payloadcms/ui/elements/SaveButton'
import { SaveDraftButton } from '@payloadcms/ui/elements/SaveDraftButton'

• [x] I have read and understand the CONTRIBUTING.md document in this repository.

Contributors

• Alessio Gravili (@AlessioGr)
• Paul (@paulpopus)
• Jarrod Flesch (@JarrodMFlesch)
• Elliot DeNolf (@denolfe)
• Jacob Fletcher (@jacobsfletch)
• zvizvi (@zvizvi)
• Patrik (@PatrikKozak)

v3.0.0-beta.35 (2024-05-21)

Features

• store focal point on uploads (#6436) (36fda30)

Bug Fixes

• user verification email broken (#6442) (23f9a32)
• ui: blocks browser save dialog from opening when hotkey used with no changes (#6366) (0190eb8)
• separate sort and search fields when looking up relationship. (#6440) (f482fdc)
• ui: tooltip positioning issues (#6439) (ed47661)
• ui: update relationship cell formatted value when when search changes (#6208) (e682cb1)
• richtext-lexical: field required validation not working if content was removed manually (#6435) (fa7cc37)
• attributes graphql packages, adds esm import path (#6431) (1d81eef)
• plugin-seo: white screen of death on choosing an existing media for meta image (#6424) (8fcfac6)

BREAKING CHANGES

• export DefaultListView as ListView (#6432) (a8a2dc2)

Change the exports of DefaultListView and DefaultEditView to be renamed without "Default" as ListView

// before
import { DefaultEditView } from '@payloadcms/next/views'
import { DefaultListView } from '@payloadcms/next/views'

// after 
import { EditView } from '@payloadcms/next/views'
import { ListView } from '@payloadcms/next/views'

Contributors

• Paul (@paulpopus)
• Alessio Gravili (@AlessioGr)
• Jessica Chowdhury (@JessChowdhury)
• Anders Semb Hermansen (@andershermansen)
• Ritsu (@r1tsuu)
• Elliot DeNolf (@denolfe)
• Jarrod Flesch (@JarrodMFlesch)

v3.0.0-beta.34 (2024-05-17)

Bug Fixes

• page metadata generation not working in turbopack (#6417) (147b50e)

Contributors

• Alessio Gravili (@AlessioGr)

v3.0.0-beta.33 (2024-05-17)

Features

• richtext-lexical: new aboveContainer and belowContainer plugin positioning options, fix incorrect placeholder positioning (#6410) (bf106db)
• upgrade minimum next version to 14.3.0-canary.68 & upgrade react packages, react-toastify (#6387) (9d5c0d3)
• allow client components and extra rsc props for custom edit and list views (#6395) (2762131)
• replaces admin.meta.ogImage with admin.meta.openGraph.images (#6227) (9556d1b)
• richtext-lexical: upgrade lexical from 0.14.5 to 0.15.0 (#6371) (fbea524)
• richtext-lexical: upgrade lexical from 0.14.5 to 0.15.0 and ensure peerDependencies force correct lexical version (22480a7)

Bug Fixes

• db-postgres: uuid custom db name (#6408) (c2571cf)
• db-postgres: query with like on id columns (#6414) (12c812d)
• ui: properly sets hasSavePermission on nested documents (#6394) (1800934)
• component is undefined error within isReactServerComponentOrFunction (#6411) (89b6055)
• turbopack RSC detection (#6405) (4dedd6e)
• next: removes initPage export from barrel file (#6403) (553bb4b)
• loader support for server-only (#6383) (5083525)
• react-select menu is hidden behind lexical fixed toolbar (#6396) (5323d76)
• richtext-lexical: upload, relationship and block node insertion fails sometimes (6083870)
• next: incorrect stepnav breadcrumbs after selecting existing upload (#6372) (a4deaf0)
• next: does not wrap custom views with template by default (#6379) (4adf01a)
• translations: type StripCountVariants not working in TS strict mode (#6374) (1abcdf9)
• safely access cookie header for uploads (#6373) (fbad39a)
• db-postgres: filter with ID not_in AND queries (#6359) (e8d1d36)
• loader throwing errors for client files imported using TS paths (#6369) (cb9a20f)
• richtext-lexical: autoLink node styles not inherited from original text node on creation (8db9664)
• multiselect relationship bug and improve accessibility (#6286) (5a4074e)

BREAKING CHANGES

• upgrade minimum next version to 14.3.0-canary.68 & upgrade react packages, react-toastify (#6387) (9d5c0d3)

BREAKING:

• The minimum required next version is now 14.3.0-canary.68. This is because we are migrating away from the deprecated experimental.serverComponentsExternalPackages next config key to experimental.serverExternalPackages, which is not available in older next canaries
• The minimum react and react-dom versions have been bumped to ^18.2.0 or ^19.0.0. This matches the minimum react version recommended by next

• next: removes initPage export from barrel file (#6403) (553bb4b)

• replaces admin.meta.ogImage with admin.meta.openGraph.images (#6227) (9556d1b)

• remove unused staticOptions config on uploads (#6378) (a6bf058)

Removes the unused staticOptions on upload config, it was previously typed to express configuration and is unused anywhere in the codebase

• richtext-lexical: upgrade lexical from 0.14.5 to 0.15.0 (#6371) (fbea524)

BREAKING: This upgrades all lexical packages from 0.14.5 to 0.15.0. If there are any breaking changes within lexical, this could break your project if you use lexical APIs directly (e.g. in custom features). We have not noticed any breaking changes within core. Please consult their changelog: https://github.com/facebook/lexical/releases/tag/v0.15.0"

• richtext-lexical: upgrade lexical from 0.14.5 to 0.15.0 and ensure peerDependencies force correct lexical version (22480a7)

Contributors

• James Mikrut (@jmikrut)
• Dan Ribbens (@DanRibbens)
• Alessio Gravili (@AlessioGr)
• Jacob Fletcher (@jacobsfletch)
• Francis Turmel (@fturmel)
• Elliot DeNolf (@denolfe)
• Paul (@paulpopus)
• Patrik (@PatrikKozak)
• Jarrod Flesch (@JarrodMFlesch)
• Jessica Chowdhury (@JessChowdhury)