559c0646fa
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
```ts
// 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.
88 lines
2.2 KiB
TypeScript
88 lines
2.2 KiB
TypeScript
import { fileURLToPath } from 'node:url'
|
|
import path from 'path'
|
|
const filename = fileURLToPath(import.meta.url)
|
|
const dirname = path.dirname(filename)
|
|
import type { GenerateDescription, GenerateTitle, GenerateURL } from '@payloadcms/plugin-seo/types'
|
|
import type { Page } from 'plugin-seo/payload-types.js'
|
|
|
|
import { seoPlugin } from '@payloadcms/plugin-seo'
|
|
import { en } from '@payloadcms/translations/languages/en'
|
|
import { es } from '@payloadcms/translations/languages/es'
|
|
|
|
import { buildConfigWithDefaults } from '../buildConfigWithDefaults.js'
|
|
import { devUser } from '../credentials.js'
|
|
import { Media } from './collections/Media.js'
|
|
import { Pages } from './collections/Pages.js'
|
|
import { Users } from './collections/Users.js'
|
|
import { seed } from './seed/index.js'
|
|
|
|
const generateTitle: GenerateTitle<Page> = ({ doc }) => {
|
|
return `Website.com — ${doc?.title}`
|
|
}
|
|
|
|
const generateDescription: GenerateDescription<Page> = ({ doc }) => {
|
|
return doc?.excerpt || 'generated description'
|
|
}
|
|
|
|
const generateURL: GenerateURL<Page> = ({ doc, locale }) => {
|
|
return `https://yoursite.com/${locale ? locale + '/' : ''}${doc?.slug || ''}`
|
|
}
|
|
|
|
export default buildConfigWithDefaults({
|
|
collections: [Users, Pages, Media],
|
|
i18n: {
|
|
supportedLanguages: {
|
|
en,
|
|
es,
|
|
},
|
|
translations: {
|
|
es: {
|
|
'plugin-seo': {
|
|
autoGenerate: 'Auto-génerar',
|
|
},
|
|
},
|
|
},
|
|
},
|
|
localization: {
|
|
defaultLocale: 'en',
|
|
fallback: true,
|
|
locales: ['en', 'es', 'de'],
|
|
},
|
|
onInit: async (payload) => {
|
|
await payload.create({
|
|
collection: 'users',
|
|
data: {
|
|
email: devUser.email,
|
|
password: devUser.password,
|
|
},
|
|
})
|
|
|
|
await seed(payload)
|
|
},
|
|
plugins: [
|
|
seoPlugin({
|
|
collections: ['pages'],
|
|
fieldOverrides: {
|
|
title: {
|
|
required: true,
|
|
},
|
|
},
|
|
fields: [
|
|
{
|
|
name: 'ogTitle',
|
|
type: 'text',
|
|
label: 'og:title',
|
|
},
|
|
],
|
|
generateDescription,
|
|
generateTitle,
|
|
generateURL,
|
|
tabbedUI: true,
|
|
uploadsCollection: 'media',
|
|
}),
|
|
],
|
|
typescript: {
|
|
outputFile: path.resolve(dirname, 'payload-types.ts'),
|
|
},
|
|
})
|