c41ef65a2b
### What?
Adds `defaultPopulate` property to collection config that allows to
specify which fields to select when the collection is populated from
another document.
```ts
import type { CollectionConfig } from 'payload'
// The TSlug generic can be passed to have type safety for `defaultPopulate`.
// If avoided, the `defaultPopulate` type resolves to `SelectType`.
export const Pages: CollectionConfig<'pages'> = {
slug: 'pages',
// I need only slug, NOT the WHOLE CONTENT!
defaultPopulate: {
slug: true,
},
fields: [
{
name: 'slug',
type: 'text',
required: true,
},
],
}
```
### Why?
This is essential for example in case of links. You don't need the whole
document, which can contain large data but only the `slug`.
### How?
Implements `defaultPopulate` when populating relationships, including
inside of lexical / slate rich text fields.
76 lines
1.9 KiB
TypeScript
76 lines
1.9 KiB
TypeScript
import { lexicalEditor } from '@payloadcms/richtext-lexical'
|
|
import { fileURLToPath } from 'node:url'
|
|
import path from 'path'
|
|
|
|
import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js'
|
|
import { devUser } from '../credentials.js'
|
|
import { DeepPostsCollection } from './collections/DeepPosts/index.js'
|
|
import { LocalizedPostsCollection } from './collections/LocalizedPosts/index.js'
|
|
import { Pages } from './collections/Pages/index.js'
|
|
import { PostsCollection } from './collections/Posts/index.js'
|
|
import { VersionedPostsCollection } from './collections/VersionedPosts/index.js'
|
|
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
|
|
export default buildConfigWithDefaults({
|
|
// ...extend config here
|
|
collections: [
|
|
PostsCollection,
|
|
LocalizedPostsCollection,
|
|
VersionedPostsCollection,
|
|
DeepPostsCollection,
|
|
Pages,
|
|
],
|
|
globals: [
|
|
{
|
|
slug: 'global-post',
|
|
fields: [
|
|
{
|
|
name: 'text',
|
|
type: 'text',
|
|
},
|
|
{
|
|
name: 'number',
|
|
type: 'number',
|
|
},
|
|
],
|
|
},
|
|
],
|
|
admin: {
|
|
importMap: {
|
|
baseDir: path.resolve(dirname),
|
|
},
|
|
},
|
|
localization: {
|
|
locales: ['en', 'de'],
|
|
defaultLocale: 'en',
|
|
},
|
|
editor: lexicalEditor({
|
|
features: ({ defaultFeatures }) => [...defaultFeatures],
|
|
}),
|
|
cors: ['http://localhost:3000', 'http://localhost:3001'],
|
|
onInit: async (payload) => {
|
|
await payload.create({
|
|
collection: 'users',
|
|
data: {
|
|
email: devUser.email,
|
|
password: devUser.password,
|
|
},
|
|
})
|
|
|
|
// // Create image
|
|
// const imageFilePath = path.resolve(dirname, '../uploads/image.png')
|
|
// const imageFile = await getFileByPath(imageFilePath)
|
|
|
|
// await payload.create({
|
|
// collection: 'media',
|
|
// data: {},
|
|
// file: imageFile,
|
|
// })
|
|
},
|
|
typescript: {
|
|
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
|
},
|
|
})
|