f12b4dc6b0
When deploying to Vercel, preview deployment URLs are dynamically generated. This breaks Live Preview within those deployments because there is no mechanism by which we can detect and set that URL within Payload. Although Vercel provides various environment variables at our disposal, they provide no concrete identifier for exactly _which_ URL is being currently previewed (you an access the same deployment from a number of different URLs). The fix is to support _relative_ live preview URLs, that way Payload can prepend the application's top-level domain dynamically at render-time in order to create a fully qualified URL. So when you visit a Vercel preview deployment, for example, that deployment's unique URL is used to load the iframe of the preview window, instead of the application's root/production domain. Note: this does not fix multi-tenancy single-domain setups, as those still require a static top-level domain for each tenant.
46 lines
1.3 KiB
TypeScript
46 lines
1.3 KiB
TypeScript
import type { LivePreviewConfig } from 'payload'
|
|
|
|
export const formatLivePreviewURL: LivePreviewConfig['url'] = async ({
|
|
data,
|
|
collectionConfig,
|
|
payload,
|
|
}) => {
|
|
let baseURL = '/live-preview'
|
|
|
|
// You can run async requests here, if needed
|
|
// For example, multi-tenant apps may need to lookup additional data
|
|
if (data.tenant) {
|
|
try {
|
|
const fullTenant = await payload
|
|
.find({
|
|
collection: 'tenants',
|
|
where: {
|
|
id: {
|
|
equals: data.tenant,
|
|
},
|
|
},
|
|
limit: 1,
|
|
depth: 0,
|
|
})
|
|
.then((res) => res?.docs?.[0])
|
|
|
|
if (fullTenant?.clientURL) {
|
|
// Note: appending a fully-qualified URL here won't work for preview deployments on Vercel
|
|
baseURL = `${fullTenant.clientURL}/live-preview`
|
|
}
|
|
} catch (e) {
|
|
console.error(e)
|
|
}
|
|
}
|
|
|
|
// Format the URL as needed, based on the document and data
|
|
// I.e. append '/posts' to the URL if the document is a post
|
|
// You can also do this on individual collection or global config, if preferred
|
|
const isPage = collectionConfig && collectionConfig.slug === 'pages'
|
|
const isHomePage = isPage && data?.slug === 'home'
|
|
|
|
return `${baseURL}${
|
|
!isPage && collectionConfig ? `/${collectionConfig.slug}` : ''
|
|
}${!isHomePage && data.slug ? `/${data.slug}` : ''}`
|
|
}
|