@justanarthur/payload-www 0.1.1

package/dist/collections.d.ts

@@ -0,0 +1,200 @@
+import { Block, CollectionConfig } from "payload";
+type LocalePrefixMode = "always" | "as-needed" | "never";
+type CreateRevalidateCollectionHookOptions = {
+	/**
+	* The collection's slug. Used in the per-collection tag fired
+	* alongside path invalidation: `collection_<slug>_<id>`.
+	*/
+	collectionSlug: string;
+	/**
+	* URL path prefix for this collection's rendered URLs. Pages use
+	* `''` (mounted at root); Posts use `'/posts'`. Leading slash,
+	* no trailing slash — same convention as
+	* `createSitemapFile.urlPrefixes`.
+	*/
+	urlPathPrefix?: string;
+	/**
+	* Sitemap tag the collection's revalidation hook invalidates on
+	* every save. Defaults to `${collectionSlug}-sitemap`. Pass
+	* `false` to opt out (collections without a sitemap handler).
+	*/
+	sitemapTag?: string | false;
+	/**
+	* Locale prefix mode — mirrors next-intl's `localePrefix`.
+	* Defaults to `'always'` (preserves legacy behavior).
+	*/
+	localePrefix?: LocalePrefixMode;
+	/**
+	* Default locale for `localePrefix: 'as-needed'`. Falls back to
+	* `req.payload.config.localization.defaultLocale` at request time
+	* when omitted.
+	*/
+	defaultLocale?: string;
+	/**
+	* Path invalidation strategy. Default: `'url'` — fans out
+	* `revalidatePath` for every locale × every slug. Set to
+	* `'tag-only'` for collections without a URL (e.g. `staticPages`
+	* — addressed by a `kind` discriminator, not a slug). Tag-only
+	* mode still fires the per-collection tag (via `sitemapTag`) and
+	* the per-id tag (`collection_<slug>_<id>`).
+	*/
+	pathMode?: "url" | "tag-only";
+};
+declare const HOME_PAGE_SLUG = "";
+declare const PAGES_SLUG = "pages";
+type CreatePagesCollectionOptions = {
+	/**
+	* Blocks the Pages collection accepts.
+	*/
+	blocks: Block[];
+	/**
+	* Optional override for the collection slug. Default: `'pages'`.
+	* Hosts that want a different slug (e.g. `'site_pages'`) pass
+	* it here. The lib's Header / Footer `linkRelationTo` default
+	* uses `'pages'` — combine this with a matching
+	* `linkRelationTo` to keep nav links targeting the right
+	* collection.
+	*/
+	slug?: string;
+	/**
+	* Optional override for the `custom.path` Payload uses to resolve
+	* the page's render module. Default: the lib's `PAGES_RENDER_PATH`
+	* (a Server Component that calls `RenderBlocks`). Use this when
+	* you've defined your own Server Component for the collection.
+	*/
+	renderPath?: string;
+	/**
+	* Locale prefix mode for path invalidation. Defaults to `'always'`
+	* (preserves current behavior). Set to `'as-needed'` when the host
+	* uses next-intl `localePrefix: 'as-needed'` — otherwise the hook
+	* invalidates paths the public routes don't use.
+	*/
+	localePrefix?: CreateRevalidateCollectionHookOptions["localePrefix"];
+	/**
+	* Default locale for prefix skipping. Falls back to
+	* `req.payload.config.localization.defaultLocale` at request time
+	* when omitted.
+	*/
+	defaultLocale?: CreateRevalidateCollectionHookOptions["defaultLocale"];
+};
+declare const createPagesCollection: (blocks: Block[], options?: Omit<CreatePagesCollectionOptions, "blocks">) => CollectionConfig;
+import { CollectionConfig as CollectionConfig2 } from "payload";
+declare const POSTS_SLUG = "posts";
+type CreatePostsCollectionOptions = {
+	/**
+	* Optional override for the collection slug. Default: `'posts'`.
+	* Hosts that want a different slug (e.g. `'articles'` or `'blog'`)
+	* pass it here. Combine with the page route's URL convention and
+	* the lib's translator plugin's `collections` list.
+	*/
+	slug?: string;
+	/**
+	* Override the `custom.path` Payload uses to resolve the post's
+	* render module. Defaults to the lib's `POSTS_RENDER_PATH`
+	* (the lib's `<PostsPage>` Server Component, which renders
+	* `title` + `excerpt` + Lexical `content`). Hosts that want a
+	* custom render pass their own Server Component's import path
+	* here (e.g. `'@/blog/Post#default'`).
+	*/
+	renderPath?: string;
+	/**
+	* Locale prefix mode for path invalidation. Defaults to `'always'`.
+	* Set to `'as-needed'` when the host uses next-intl
+	* `localePrefix: 'as-needed'` — otherwise the hook invalidates
+	* paths the public routes don't use.
+	*/
+	localePrefix?: "always" | "as-needed" | "never";
+	/**
+	* Default locale for prefix skipping. Falls back to
+	* `req.payload.config.localization.defaultLocale` at request time
+	* when omitted.
+	*/
+	defaultLocale?: string;
+};
+/**
+* Build the Posts collection. Posts have a simpler shape than
+* Pages: `title` + `excerpt` (both localized) + a Lexical `content`
+* rich text field. Hosts that want blocks can either swap the
+* `content` field for a `blocks` field via the returned config, or
+* define a custom Post shape entirely.
+*
+* The Posts collection exists primarily so the lib's translator
+* plugin has a second localized collection to translate.
+*/
+declare const createPostsCollection: (options?: CreatePostsCollectionOptions) => CollectionConfig2;
+import { Block as Block2, CollectionConfig as CollectionConfig3 } from "payload";
+declare const STATIC_PAGES_SLUG = "staticPages";
+type CreateStaticPagesCollectionOptions = {
+	/**
+	* Blocks the StaticPages collection accepts. Hosts pass the same
+	* `blocks` they use for `createPagesCollection` (or a smaller
+	* subset — e.g. just `pageHeroBlock` + `ctaBlock` + `featureGridBlock`).
+	* The lib does not curate a separate block set for system pages.
+	*/
+	blocks: Block2[];
+};
+declare const createStaticPagesCollection: (blocks: Block2[]) => CollectionConfig3;
+import { GlobalConfig } from "payload";
+type CreateHeaderGlobalOptions = {
+	/**
+	* Optional override for the `custom.path` Payload uses to resolve
+	* the header's render module. Default: the lib's `HEADER_RENDER_PATH`.
+	*/
+	renderPath?: string;
+	/**
+	* Collection slugs the nav's link fields can reference. Required
+	* by Payload 3.85 — empty `relationTo` arrays are rejected.
+	* Defaults to `['pages']` (the lib's Pages collection). Pass a
+	* different list when your host has additional linkable collections.
+	*/
+	linkRelationTo?: string[];
+};
+/**
+* Build the Header global. The lib's default shape: a `nav` blocks
+* field with two block types — `navColumn` (a titled group of links)
+* and `navItem` (a single link).
+*/
+declare const createHeaderGlobal: (options?: CreateHeaderGlobalOptions) => GlobalConfig;
+import { GlobalConfig as GlobalConfig2 } from "payload";
+type CreateFooterGlobalOptions = {
+	/**
+	* Optional override for the `custom.path` Payload uses to resolve
+	* the footer's render module. Default: the lib's `FOOTER_RENDER_PATH`.
+	*/
+	renderPath?: string;
+	/**
+	* Collection slugs the nav's link fields can reference. Required
+	* by Payload 3.85 — empty `relationTo` arrays are rejected.
+	* Defaults to `['pages']` (the lib's Pages collection). Pass a
+	* different list when your host has additional linkable collections.
+	*/
+	linkRelationTo?: string[];
+};
+/**
+* Build the Footer global. The lib's default shape mirrors the
+* Header: a `nav` blocks field with `navColumn` (a titled group of
+* links) and `navItem` (a single link) blocks.
+*/
+declare const createFooterGlobal: (options?: CreateFooterGlobalOptions) => GlobalConfig2;
+import { CollectionSlug, PayloadRequest } from "payload";
+declare function generatePreviewPath({ collection, slug }: {
+	collection: CollectionSlug;
+	slug: string | null | undefined;
+	req?: PayloadRequest;
+}): string | null;
+import { Block as Block_129qi5 } from "payload";
+import { CollectionConfig as CollectionConfig_j7kwbk } from "payload";
+import { GlobalConfig as GlobalConfig_fuin17 } from "payload";
+declare const _default: {
+	createPagesCollection: (blocks: Block_129qi5[], options?: Omit<CreatePagesCollectionOptions, "blocks">) => CollectionConfig_j7kwbk;
+	createPostsCollection: (options?: CreatePostsCollectionOptions) => CollectionConfig_j7kwbk;
+	createStaticPagesCollection: (blocks: Block_129qi5[]) => CollectionConfig_j7kwbk;
+	createHeaderGlobal: (options?: CreateHeaderGlobalOptions) => GlobalConfig_fuin17;
+	createFooterGlobal: (options?: CreateFooterGlobalOptions) => GlobalConfig_fuin17;
+	generatePreviewPath: typeof generatePreviewPath;
+	HOME_PAGE_SLUG: string;
+	PAGES_SLUG: string;
+	POSTS_SLUG: string;
+	STATIC_PAGES_SLUG: string;
+};
+export { generatePreviewPath, _default as default, createStaticPagesCollection, createPostsCollection, createPagesCollection, createHeaderGlobal, createFooterGlobal, STATIC_PAGES_SLUG, POSTS_SLUG, PAGES_SLUG, HOME_PAGE_SLUG, CreateStaticPagesCollectionOptions, CreatePostsCollectionOptions, CreatePagesCollectionOptions, CreateHeaderGlobalOptions, CreateFooterGlobalOptions };