25 lines
1002 B
TypeScript
25 lines
1002 B
TypeScript
import type { BasePayload } from 'payload';
|
|
import type { TitleOrder } from './composeTitle.js';
|
|
export type SiteMetaConfig = {
|
|
/** Slug of the page assigned as Homepage; collapses to the locale root. */
|
|
homeSlug?: string;
|
|
order?: TitleOrder;
|
|
/** Padded separator, e.g. ' | ' — the panel stores the bare character. */
|
|
separator?: string;
|
|
siteName: null | string;
|
|
};
|
|
/**
|
|
* Reads the site-wide inputs to title and URL composition from SiteSettings.
|
|
*
|
|
* Split out of metadata assembly because these are one concern with one source:
|
|
* whatever an editor set in the panel. Metadata generation shouldn't also know
|
|
* that the separator arrives unpadded, or that the home slug hides inside a
|
|
* relationship — it should receive a resolved config.
|
|
*/
|
|
export declare function readSiteMetaConfig({ locale, payload, settingsSlug, siteNameField, }: {
|
|
locale: string;
|
|
payload: BasePayload;
|
|
settingsSlug?: string;
|
|
siteNameField?: string;
|
|
}): Promise<SiteMetaConfig>;
|