fix(plugin-seo)!: data types plugin seo (#6979)

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.
This commit is contained in:
Paul
2024-06-28 12:58:36 -04:00
committed by GitHub
parent 75a3040029
commit 559c0646fa
7 changed files with 48 additions and 25 deletions

View File

@@ -2,6 +2,9 @@ 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'
@@ -13,6 +16,18 @@ 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: {
@@ -59,10 +74,9 @@ export default buildConfigWithDefaults({
label: 'og:title',
},
],
generateDescription: ({ doc }: any) => doc?.excerpt?.value || 'generated description',
generateTitle: (data: any) => `Website.com — ${data?.doc?.title?.value}`,
generateURL: ({ doc, locale }: any) =>
`https://yoursite.com/${locale ? locale + '/' : ''}${doc?.slug?.value || ''}`,
generateDescription,
generateTitle,
generateURL,
tabbedUI: true,
uploadsCollection: 'media',
}),