@justanarthur/payload-www 0.3.4 → 1.0.1

package/dist/pages.d.ts

@@ -1,336 +1,54 @@
 import { ReactElement } from "react";
-import { SanitizedConfig } from "payload";
-type PagesPageProps = {
-	/**
-	* The resolved page document. The host's `[slug]/page.tsx` route
-	* handler is responsible for fetching the doc (via Payload's
-	* `getPayload` or via the lib's `createCollectionPageExports`'s
-	* `generateMetadata` helper). This component just renders the
-	* visual body.
-	*/
-	doc: Record<string, any> | null;
-	/**
-	* Resolved locale string (already validated upstream by the host's
-	* `[locale]` route segment).
-	*/
-	locale: string;
-	/**
-	* Block components keyed by `blockType`. The host passes the same
-	* `importMap` it uses everywhere else; the lib's `RenderBlocks`
-	* resolves each block against the map.
-	*/
-	importMap: Record<string, unknown>;
+import { ImportMap, SanitizedConfig } from "payload";
+type RenderedWWWModule<Data = any> = {
 	config: SanitizedConfig;
-};
-/**
-* Default visual body for the Pages collection. Renders the doc's
-* `blocks` field via the lib's `RenderBlocks`. Hosts can replace
-* this by setting a different `custom.path` on their own Pages
-* collection (via the lib's `createPagesCollection` factory) and
-* pointing it at their own Server Component.
-*/
-declare function PagesPage({ doc,...props }: PagesPageProps): Promise<ReactElement>;
+	importMap: ImportMap;
+	data: Data;
+} & Record<string, any>;
+declare function FooterPage({ data }: RenderedWWWModule): ReactElement;
 import { ReactElement as ReactElement2 } from "react";
-type HeaderPageProps = {
-	/** The resolved Header global document. `null` if the host hasn't
-	* created a Header yet. */
-	data: Record<string, any> | null;
-	/**
-	* Resolved locale string. The default header visual uses this for
-	* per-locale labels via next-intl (if the host has it wired). The
-	* default ships without a label dictionary — the host can override
-	* by setting a different `custom.path` on the header global.
-	*/
-	locale: string;
-};
-/**
-* Default visual for the `header` global. Renders the header's
-* `nav` blocks (a flat list of `navItem` and `navColumn` blocks) as
-* a simple `<nav>` element.
-*
-* Hosts can replace this visual by setting a different `custom.path`
-* on their own header global (via the lib's `createHeaderGlobal`
-* factory).
-*/
-declare function HeaderPage({ data, locale: _locale }: HeaderPageProps): ReactElement2;
+declare function HeaderPage({ data }: RenderedWWWModule): ReactElement2;
 import { ReactElement as ReactElement3 } from "react";
-type FooterPageProps = {
-	/** The resolved Footer global document. `null` if the host hasn't
-	* created a Footer yet. */
-	data: Record<string, any> | null;
-	locale: string;
-};
-/**
-* Default visual for the `footer` global. Renders the footer's
-* `nav` blocks (a flat list of `navItem` and `navColumn` blocks)
-* as a simple `<footer>` element.
-*
-* Hosts can replace this visual by setting a different `custom.path`
-* on their own footer global (via the lib's `createFooterGlobal`
-* factory).
-*/
-declare function FooterPage({ data, locale: _locale }: FooterPageProps): ReactElement3;
+declare function PagesPage({ data, locale,...props }: RenderedWWWModule): Promise<ReactElement3>;
 import { Metadata, MetadataRoute } from "next";
-import { DataFromCollectionSlug, ImportMap, SanitizedConfig as SanitizedConfig2 } from "payload";
-import { ReactElement as ReactElement4, ReactNode } from "react";
-type BreadcrumbItem = {
-	label: string;
-	url: string;
-};
-type PageExtendProps = {
-	importMap: ImportMap;
-	config: SanitizedConfig2;
-	locale: string;
-};
-type ArticleJsonLdEntry = {
-	type: "article";
-	id?: string;
-	schemaType?: "BlogPosting" | "Article" | "NewsArticle" | "TechArticle";
-	publisherName?: string;
-	publisherLogo?: string | null;
-};
-type WebSiteJsonLdEntry = {
-	type: "website";
-	id?: string;
-	name?: string;
-	alternateName?: string;
-};
-type OrganizationJsonLdEntry = {
-	type: "organization";
-	id?: string;
-	name?: string;
-	logo?: string;
-	sameAs?: string[];
-};
-type BreadcrumbsJsonLdEntry = {
-	type: "breadcrumbs";
-	id?: string;
-	items?: BreadcrumbItem[];
-	buildItems?: (doc: DataFromCollectionSlug<string>, url: string) => BreadcrumbItem[];
-};
-type CustomJsonLdEntry = {
-	type: "custom";
-	id?: string;
-	build: (ctx: {
-		doc: DataFromCollectionSlug<string>;
-		url: string;
+import { ImportMap as ImportMap2, SanitizedConfig as SanitizedConfig2 } from "payload";
+import { ReactNode as ReactNode2 } from "react";
+type SlugShape = "single" | "catch-all";
+type NextPageProps = {
+	params: Promise<{
 		locale: string;
-		siteUrl: string;
-	}) => Record<string, unknown>;
-};
-type JsonLdEntry = ArticleJsonLdEntry | WebSiteJsonLdEntry | OrganizationJsonLdEntry | BreadcrumbsJsonLdEntry | CustomJsonLdEntry;
-type JsonLdOutput = {
-	id: string;
-	schema: Record<string, unknown>;
-};
-/**
-* Minimal next-intl routing contract the lib reads. Hosts pass
-* their `defineRouting({...})` result directly; the lib only needs
-* the shape below.
-*
-* `localePrefix` accepts either the simple string form
-* (`'always' | 'as-needed' | 'never'`) or next-intl's verbose
-* `LocalePrefixConfigVerbose` shape (`{ mode, prefixes? }`). The lib
-* normalizes both to a string `mode` internally.
-*/
-type LocalePrefixValue = "always" | "as-needed" | "never" | {
-	mode?: "always" | "as-needed" | "never";
-};
-type PageRouting = {
-	locales: readonly string[];
-	defaultLocale: string;
-	localePrefix?: LocalePrefixValue;
-	/** Optional human-readable labels per locale (used by the
-	* `<LocaleSwitcher>`). Falls back to the locale code when missing.
-	* Not part of next-intl's `defineRouting` shape — the host extends
-	* its routing object to include it (e.g. via a type assertion). */
-	labels?: Record<string, string>;
-};
-type MetadataOptions = {
-	urlPrefix?: string;
-	/** When true (default), the lib generates a `{type:'website'}` JSON-LD
-	* entry per page. Pass an array to specify entries; pass `false` to
-	* skip. */
-	jsonLd?: boolean | JsonLdEntry[];
-	changefreq?: MetadataRoute.Sitemap[number]["changeFrequency"];
-	priority?: number;
-	/**
-	* Override the default `'website'` JSON-LD's `name` field. Only
-	* relevant when `jsonLd !== false` and no `name` is set on the
-	* auto-generated entry.
-	*/
-	websiteName?: string;
-};
-type ShowcaseOptions = {
-	/**
-	* Wrap the rendered page in a two-column layout with a sidebar
-	* that surfaces the page's metadata, JSON-LD, and a language
-	* switcher. Hosts that want a clean render (no sidebar) leave
-	* this `false` (the default). The demo's home page enables it
-	* so visitors can see every artifact the lib generates in one
-	* place.
-	*/
-	enabled?: boolean;
-	/** Heading shown above the metadata block. Default: `'Page metadata'`. */
-	metadataHeading?: string;
-	/** Heading shown above the JSON-LD block. Default: `'JSON-LD'`. */
-	jsonLdHeading?: string;
+		slug?: string | string[];
+	}>;
 };
+import { RoutingConfig as GenericRoutingConfig } from "next-intl/routing";
+type RoutingConfig = GenericRoutingConfig<string[], any, any, any>;
 type CreateCollectionPageExportsArgs<S extends string = "pages"> = {
-	config: Promise<SanitizedConfig2>;
-	/**
-	* Defaults to `'pages'`. The collection slug whose documents the
-	* page route renders.
-	*/
 	slug?: S;
-	/**
-	* The next-intl `defineRouting({...})` result from the host's
-	* `i18n/routing.ts`. Drives locale validation, URL building,
-	* hreflang alternates, and the language switcher.
-	*/
-	routing: PageRouting;
-	/**
-	* The host's Payload importMap. The lib uses this to resolve
-	* the collection's `custom.path` (the page renderer module) and
-	* the live-preview listener. Pass `import { importMap } from
-	* '@/app/(payload)/admin/importMap.js'` from the host's page
-	* file. Default: `{}` — the page renders without a live-preview
-	* listener and uses the lib's registered `custom.path` for the
-	* collection renderer (which requires its key to be in the
-	* supplied importMap).
-	*/
-	importMap?: ImportMap;
-	/**
-	* Optional custom path pointing at the host's render module for
-	* the collection. Overrides the lib's registered `custom.path`
-	* (which defaults to `PAGES_RENDER_PATH`). Use this when you've
-	* defined your own Server Component for the collection.
-	*/
-	renderPath?: string;
-	/**
-	* Enable nested (hierarchical) slugs. When `true`, the catch-all
-	* `[...slug]` segments are joined with the `_` divider to form the
-	* stored slug (URL `/about/us` ⇄ stored `about_us`), URL paths and
-	* hreflang alternates are expanded back to `/about/us`, and
-	* `generateStaticParams` emits multi-segment params. When `false`
-	* (the default) only the first URL segment is used — flat slugs.
-	*
-	* Pair with `createPagesCollection({ nested: true })` (or
-	* `createWWWConfig({ nested: true })`) so the collection's slug
-	* validation accepts the `_` divider.
-	*/
-	nested?: boolean;
+	config: Promise<SanitizedConfig2>;
+	importMap: ImportMap2;
+	routing: RoutingConfig;
+	slugShape?: SlugShape;
 };
 type CreateCollectionPageExportsDeps<S extends string> = {
-	/**
-	* Host's `getServerSideURL()` (returns the absolute site URL).
-	*/
 	getServerSideURL: () => string;
-	/**
-	* Host's `generateMeta({ doc, url, type, locale })` (returns Next.js
-	* `Metadata`). The `doc` is the host's typed collection document
-	* (e.g. `Post` for the posts collection, `Page` for pages) with
-	* localized fields already resolved for the active locale. Read
-	* `doc.title` directly as a string — no locale-lookup needed.
-	*/
-	generateMeta: (args: {
-		doc: DataFromCollectionSlug<S> | null;
-		url: string;
-		type: "website" | "article";
-		locale: string;
-	}) => Promise<Metadata>;
-	/**
-	* Override the metadata type passed to `generateMeta` and the
-	* JSON-LD entry default. Defaults to `'article'` for the
-	* `posts` collection, `'website'` everywhere else. Hosts that
-	* want to opt out (e.g. treat a Post like a WebPage) pass
-	* `'website'` explicitly here.
-	*/
-	metadataType?: "website" | "article";
-	/**
-	* Optional showcase configuration. When `enabled: true`, the
-	* default page renders inside a `<PageShowcase>` sidebar that
-	* surfaces the page's metadata, JSON-LD, and a language
-	* switcher — useful for demos and CMS previews. Default: off.
-	*/
-	showcase?: ShowcaseOptions;
-	/**
-	* Optional content injected after the rendered doc body when the
-	* page is the home route (slug = `''`). The lib calls the
-	* function with the resolved locale and the current doc (or
-	* `null` if no home doc exists). Hosts that want the home to
-	* surface additional content — recent pages, recent posts,
-	* navigation — pass a function here. The return value is
-	* rendered as a sibling of the lib's doc body inside the page
-	* (and inside the showcase's main column when showcase is on).
-	*/
-	homeExtras?: (args: {
-		locale: string;
-		doc: DataFromCollectionSlug<S> | null;
-	}) => ReactNode | Promise<ReactNode>;
-};
-/**
-* Build a Pages (or any collection) page route's exports:
-* `default` (the Page Server Component), `generateMetadata`,
-* `generateStaticParams`, and `generateSitemap`.
-*
-* Designed for a next-intl layout: the page lives at
-* `app/(frontend)/[locale]/[...slug]/page.tsx`. The catch-all slug
-* handles both the home route (slug=[]) and any other doc. The lib
-* reads `params.locale` and `params.slug` (string[]), validates
-* the locale against `routing.locales`, fetches the doc, generates
-* metadata + JSON-LD + hreflang alternates, and renders the
-* resolved output.
-*
-* The host's `next-intl/routing` config is the single source of
-* truth for the locale list and URL shape.
-*
-*   // app/(frontend)/[locale]/[...slug]/page.tsx
-*   import { routing } from '@/i18n/routing'
-*   import { createCollectionPageExports } from '@justanarthur/payload-www/render-pages'
-*
-*   const { default: Page, generateMetadata, generateStaticParams } =
-*     createCollectionPageExports(
-*       { config: configPromise, routing },
-*       { getServerSideURL, generateMeta, showcase: { enabled: true } }
-*     )
-*
-*   { generateMetadata, generateStaticParams }
-*   Page
-*/
-declare function createCollectionPageExports<S extends string = "pages">({ slug, config: configPromise, routing, importMap: importMapArg, renderPath, nested }: CreateCollectionPageExportsArgs<S>, deps: CreateCollectionPageExportsDeps<S>, options?: MetadataOptions): {
-	default: (props: {
-		params: Promise<{
-			locale?: string;
-			slug?: string[];
-		}>;
-		searchParams?: Promise<Record<string, string | string[] | undefined>>;
-	}) => Promise<ReactElement4>;
-	generateMetadata: (props: {
-		params: Promise<{
-			locale?: string;
-			slug?: string[];
-		}>;
-	}) => Promise<Metadata>;
-	generateStaticParams: () => Promise<Array<{
-		slug?: string[];
-		locale: string;
-	}>>;
-	generateSitemap: () => Promise<MetadataRoute.Sitemap>;
-	generateJsonLd: (slugSegments: string[], doc: DataFromCollectionSlug<S>, locale: string) => Promise<JsonLdOutput[]>;
-};
-declare function addCollectionsToSitemap(exports: Array<{
-	default: () => Promise<MetadataRoute.Sitemap>;
-	generateSitemap: () => Promise<MetadataRoute.Sitemap>;
-}>): {
-	default: () => Promise<MetadataRoute.Sitemap>;
-	generateSitemap: () => Promise<MetadataRoute.Sitemap>;
-};
-declare const _default: {
+	pagePathPrefix?: string;
+};
+declare function createCollectionPageExports<S extends string = "pages">({ slug: collectionSlug, config: configPromise, importMap, routing, slugShape }: CreateCollectionPageExportsArgs<S>, { getServerSideURL, pagePathPrefix }: CreateCollectionPageExportsDeps<S>): {
+	default: (props: NextPageProps) => Promise<ReactNode2>;
+	generateMetadata: (props: NextPageProps) => Promise<Metadata>;
+	generateStaticParams: (props: NextPageProps) => Promise<{
+		slug: string | string[];
+	}[]>;
+	generateSitemap: {
+		(): Promise<MetadataRoute.Sitemap>;
+		getServerSideURL: () => string;
+		pagePathPrefix: string | undefined;
+	};
+};
+declare const pages: {
 	createCollectionPageExports: typeof createCollectionPageExports;
-	addCollectionsToSitemap: typeof addCollectionsToSitemap;
 	PagesPage: typeof PagesPage;
 	HeaderPage: typeof HeaderPage;
 	FooterPage: typeof FooterPage;
 };
-export { _default as default, createCollectionPageExports, addCollectionsToSitemap, PagesPage, PageExtendProps, MetadataOptions, JsonLdOutput, JsonLdEntry, HeaderPage, FooterPage, CreateCollectionPageExportsDeps, CreateCollectionPageExportsArgs };
+export { pages as default, createCollectionPageExports, PagesPage, HeaderPage, FooterPage, CreateCollectionPageExportsDeps, CreateCollectionPageExportsArgs };