feat: collection-level preferences (#12909)

Needed for #12860.
The new live preview pattern requires collection-level preferences, a
pattern that does not yet exist.
Instead of creating a new record for these types of preferences, we can
simply reuse `<collectionSlug>-list` under a more general key:
`collection-<slug>`. This way other relevant properties can be attached
in the future that might not specifically apply to the list view.
This will also match the conventions already estalished by
document-level preferences in `collection-<slug>-<id>` and
`global-<slug>`.
---
- To see the specific tasks where the Asana app for GitHub is being
used, see below:
- https://app.asana.com/0/0/1210628212784050

Author: jacobsfletch

packages/next/src/views/List/handleServerFunction.tsx

@@ -1,4 +1,4 @@
-importtype{ListPreferences,ListQuery,ServerFunction,VisibleEntities}from'payload'
+importtype{CollectionPreferences,ListQuery,ServerFunction,VisibleEntities}from'payload'
 
 import{getClientConfig}from'@payloadcms/ui/utilities/getClientConfig'
 import{headersasgetHeaders}from'next/headers.js'
@@ -8,7 +8,7 @@ import { renderListView } from './index.js'
 
 typeRenderListResult={
 List: React.ReactNode
-preferences: ListPreferences
+preferences: CollectionPreferences
 }
 
 exportconstrenderListHandler: ServerFunction<
@@ -92,7 +92,7 @@ export const renderListHandler: ServerFunction<
 importMap: payload.importMap,
 })
 
-constpreferencesKey=`${collectionSlug}-list`
+constpreferencesKey=`collection-${collectionSlug}`
 
 constpreferences=awaitpayload
 .find({
@@ -119,7 +119,7 @@ export const renderListHandler: ServerFunction<
 ],
 },
 })
-.then((res)=>res.docs[0]?.valueasListPreferences)
+.then((res)=>res.docs[0]?.valueasCollectionPreferences)
 
 constvisibleEntities: VisibleEntities={
 collections: payload.config.collections

packages/next/src/views/List/index.tsx

@@ -1,8 +1,8 @@
 importtype{
 AdminViewServerProps,
+CollectionPreferences,
 ColumnPreference,
 DefaultDocumentIDType,
-ListPreferences,
 ListQuery,
 ListViewClientProps,
 ListViewServerPropsOnly,
@@ -98,8 +98,8 @@ export const renderListView = async (
  * This will ensure that prefs are only updated when explicitly set by the user
  * This could potentially be done by injecting a `sessionID` into the params and comparing it against a session cookie
  */
-constlistPreferences=awaitupsertPreferences<ListPreferences>({
-key: `${collectionSlug}-list`,
+constcollectionPreferences=awaitupsertPreferences<CollectionPreferences>({
+key: `collection-${collectionSlug}`,
  req,
 value: {
  columns,
@@ -120,10 +120,10 @@ export const renderListView = async (
 
 constpage=isNumber(query?.page) ? Number(query.page) : 0
 
-constlimit=listPreferences?.limit||collectionConfig.admin.pagination.defaultLimit
+constlimit=collectionPreferences?.limit||collectionConfig.admin.pagination.defaultLimit
 
 constsort=
-listPreferences?.sort||
+collectionPreferences?.sort||
 (typeofcollectionConfig.defaultSort==='string' ? collectionConfig.defaultSort : undefined)
 
 letwhere=mergeListSearchAndWhere({
@@ -150,10 +150,10 @@ export const renderListView = async (
 letqueryPreset: QueryPreset|undefined
 letqueryPresetPermissions: SanitizedCollectionPermission|undefined
 
-if(listPreferences?.preset){
+if(collectionPreferences?.preset){
 try{
 queryPreset=(awaitpayload.findByID({
-id: listPreferences?.preset,
+id: collectionPreferences?.preset,
 collection: 'payload-query-presets',
 depth: 0,
 overrideAccess: false,
@@ -194,7 +194,7 @@ export const renderListView = async (
 const{ columnState, Table }=renderTable({
  clientCollectionConfig,
  collectionConfig,
-columnPreferences: listPreferences?.columns,
+columnPreferences: collectionPreferences?.columns,
  columns,
  customCellProps,
 docs: data.docs,
@@ -230,7 +230,7 @@ export const renderListView = async (
  data,
  i18n,
  limit,
- listPreferences,
+listPreferences: collectionPreferences,
 listSearchableFields: collectionConfig.admin.listSearchableFields,
 locale: fullLocale,
  params,
@@ -264,7 +264,7 @@ export const renderListView = async (
 data={data}
 defaultLimit={limit}
 defaultSort={sort}
-listPreferences={listPreferences}
+listPreferences={collectionPreferences}
 modifySearchParams={!isInDrawer}
 orderableFieldName={collectionConfig.orderable===true ? '_order' : undefined}
 >
@@ -278,7 +278,7 @@ export const renderListView = async (
  disableQueryPresets,
  enableRowSelections,
  hasCreatePermission,
- listPreferences,
+listPreferences: collectionPreferences,
  newDocumentURL,
  queryPreset,
  queryPresetPermissions,

packages/payload/src/admin/views/list.ts

@@ -4,7 +4,7 @@ import type {
 SanitizedCollectionConfig,
 }from'../../collections/config/types.js'
 importtype{ServerProps}from'../../config/types.js'
-importtype{ListPreferences}from'../../preferences/types.js'
+importtype{CollectionPreferences}from'../../preferences/types.js'
 importtype{QueryPreset}from'../../query-presets/types.js'
 importtype{ResolvedFilterOptions}from'../../types/index.js'
 importtype{Column}from'../elements/Table.js'
@@ -30,7 +30,7 @@ export type ListViewServerPropsOnly = {
 collectionConfig: SanitizedCollectionConfig
 data: Data
 limit: number
-listPreferences: ListPreferences
+listPreferences: CollectionPreferences
 listSearchableFields: CollectionAdminOptions['listSearchableFields']
 }&ServerProps
 
@@ -48,7 +48,7 @@ export type ListViewClientProps = {
 /**
  * @deprecated
  */
-listPreferences?: ListPreferences
+listPreferences?: CollectionPreferences
 newDocumentURL: string
 /**
  * @deprecated

packages/payload/src/index.ts

@@ -1475,11 +1475,15 @@ export { restoreVersionOperation as restoreVersionOperationGlobal } from './glob
 export{updateOperationasupdateOperationGlobal}from'./globals/operations/update.js'
 exporttype{
 CollapsedPreferences,
+CollectionPreferences,
+/**
+ * @deprecated Use `CollectionPreferences` instead.
+ */
+CollectionPreferencesasListPreferences,
 ColumnPreference,
 DocumentPreferences,
 FieldsPreferences,
 InsideFieldsPreferences,
-ListPreferences,
 PreferenceRequest,
 PreferenceUpdateRequest,
 TabsPreferences,

packages/payload/src/preferences/types.ts

@@ -34,7 +34,7 @@ export type ColumnPreference = {
 active: boolean
 }
 
-exporttypeListPreferences={
+exporttypeCollectionPreferences={
 columns?: ColumnPreference[]
 limit?: number
 preset?: DefaultDocumentIDType

packages/payload/src/query-presets/types.ts

@@ -1,6 +1,6 @@
 importtype{Field}from'../fields/config/types.js'
 importtype{Access,CollectionSlug}from'../index.js'
-importtype{ListPreferences}from'../preferences/types.js'
+importtype{CollectionPreferences}from'../preferences/types.js'
 importtype{Where}from'../types/index.js'
 
 // Note: order matters here as it will change the rendered order in the UI
@@ -19,7 +19,7 @@ export type QueryPreset = {
 users?: string[]
 }
 }
-columns: ListPreferences['columns']
+columns: CollectionPreferences['columns']
 id: number|string
 isShared: boolean
 relatedCollection: CollectionSlug

packages/plugin-import-export/src/components/FieldsToExport/index.tsx

@@ -1,6 +1,6 @@
 'use client'
 
-importtype{ListPreferences,SelectFieldClientComponent}from'payload'
+importtype{CollectionPreferences,SelectFieldClientComponent}from'payload'
 importtype{ReactNode}from'react'
 
 import{
@@ -51,10 +51,11 @@ export const FieldsToExport: SelectFieldClientComponent = (props) => {
 if(id||!collectionSlug){
 return
 }
+
 constdoAsync=async()=>{
 constcurrentPreferences=awaitgetPreference<{
-columns: ListPreferences['columns']
-}>(`${collectionSlug}-list`)
+columns: CollectionPreferences['columns']
+}>(`collection-${collectionSlug}`)
 
 constcolumns=currentPreferences?.columns?.filter((a)=>a.active).map((b)=>b.accessor)
 setValue(columns??collectionConfig?.admin?.defaultColumns??[])

packages/ui/src/elements/RelationshipTable/index.tsx

@@ -124,7 +124,7 @@ export const RelationshipTable: React.FC<RelationshipTableComponentProps> = (pro
 newQuery.where=hoistQueryParamsToAnd(newQuery.where,filterOptions)
 }
 
-// map columns from string[] to ListPreferences['columns']
+// map columns from string[] to CollectionPreferences['columns']
 constdefaultColumns=field.admin.defaultColumns
  ? field.admin.defaultColumns.map((accessor)=>({
  accessor,

packages/ui/src/exports/client/index.ts

@@ -387,7 +387,7 @@ export type {
 /**
  * @deprecated
  * This export will be removed in the next major version.
- * Use `import type { ListPreferences } from 'payload'` instead.
+ * Use `import type { CollectionPreferences } from 'payload'` instead.
  */
 ListPreferences,
 }from'payload'

packages/ui/src/providers/ListQuery/types.ts

@@ -1,7 +1,7 @@
 importtype{
 ClientCollectionConfig,
+CollectionPreferences,
 ColumnPreference,
-ListPreferences,
 ListQuery,
 PaginatedDocs,
 Sort,
@@ -25,7 +25,7 @@ export type ListQueryProps = {
 readonlydata: PaginatedDocs
 readonlydefaultLimit?: number
 readonlydefaultSort?: Sort
-readonlylistPreferences?: ListPreferences
+readonlylistPreferences?: CollectionPreferences
 readonlymodifySearchParams?: boolean
 readonlyonQueryChange?: OnListQueryChange
 readonlyorderableFieldName?: string