@justanarthur/payload-www 2.3.0 → 2.5.0

package/README.md

@@ -124,6 +124,11 @@ done. `export const instant = false` tells Next's dev-time instant validation th
 blocks on purpose. With `partialPrefetching: true`, Next streams the layout shell for slugs it did
 not prerender, so those slugs still get a soft 404.
 
+`prerenderLocales` limits which locales' documents `generateStaticParams` prerenders at build;
+the rest render on their first request and are cached from there. A large multilingual
+collection can prerender only its main locale, e.g. `prerenderLocales: ['en']` for posts, to keep
+the build short. It defaults to every locale.
+
 `slugShape` is `'single'` (default) or `'catch-all'`. Use `'catch-all'` if your route segment is
 `[[...slug]]` (Pages-style), `'single'` for `[slug]` (Posts-style — file convention).
 
@@ -305,7 +310,8 @@ scopes. Setup:
 
 6. **List with `queryDocs`, never a raw `payload.find`** — a read inside `'use cache'` that
    doesn't go through the finders carries no tags, so nothing the admin does can bust it.
-   `queryDocs` tags list membership plus every returned doc and what is populated into it:
+   `queryDocs` tags a per-collection `content` list plus every returned doc and what is
+   populated into it:
 
    ```ts
    import { queryDocs } from '@justanarthur/payload-www/metadata'
@@ -315,21 +321,16 @@ scopes. Setup:
      locale,
      sort: '-publishedAt',
      limit: 10,
-     depth: 1,
-     list: 'archive'
+     depth: 1
    })
    ```
 
-   `list` names a scope whose sort and filter fields are declared on the plugin, so moving a
-   post's date or category reorders the archive even when that post wasn't on the page:
-
-   ```ts
-   createWWWConfig().withWWWConfig({
-     defaultPluginsConfigs: {
-       revalidate: { collections: { posts: { lists: { archive: ['publishedAt', 'categories'] } } } }
-     }
-   })
-   ```
+   `createWWWConfig` declares that `content` scope on every collection over all its top-level
+   fields, so creating, publishing, unpublishing, deleting or really changing any doc refreshes
+   every listing of its collection — a moved date or category reorders an archive even when that
+   post wasn't on the page. Saves that change nothing and draft saves leave it alone. For a
+   narrower listing, declare a scope through `defaultPluginsConfigs.revalidate` and pass it as
+   `list`.
 
 The cached profile is `cacheLife('weeks')` — Next 16's built-in long-tail profile (5 m stale,
 1 w revalidate, 30 d expire). No custom `cacheLife` config entry needed. Invalidations are

package/dist/collections.js

@@ -111,6 +111,27 @@ function slugToPath(slug) {
   return slug.split(SLUG_NESTED_DIVIDER).join("/");
 }
 
+// src/revalidate/contentLists.ts
+import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
 // src/render/metadata/query.ts
 var _helpers = null;
 var _seedPromise = null;
@@ -178,7 +199,7 @@ async function queryAllDocs(args) {
 }
 async function queryDocs({
   collectionSlug,
-  list,
+  list = CONTENT_LIST,
   draft = false,
   depth = RENDER_DEPTH,
   ...find

package/dist/config.js

@@ -313,7 +313,29 @@ import { seoPlugin } from "@justanarthur/payload-plugin-seo";
 import { imageHashPlugin } from "@justanarthur/payload-imagehash-plugin";
 import { translator } from "@justanarthur/payload-plugin-translator";
 import { mcpPlugin } from "@payloadcms/plugin-mcp";
+
+// src/revalidate/contentLists.ts
 import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
+// src/createWWWConfig.ts
 function createWWWConfig() {
   function withWWWConfig(input) {
     const { defaultPluginsConfigs, ...config } = input;
@@ -363,7 +385,7 @@ function createWWWConfig() {
     ];
     const plugins = [
       ...mergeOrOverride(defaultPlugins, config.plugins),
-      revalidatePlugin(revalidate === false ? { enabled: false } : mergeOrOverride({}, revalidate))
+      revalidateWithContentLists(revalidate === false ? { enabled: false } : mergeOrOverride({}, revalidate))
     ];
     return {
       ...config,

package/dist/metadata.js

@@ -120,6 +120,29 @@ import { createCacheHelpers } from "@pro-laico/payload-revalidate/cache";
 import { tagsFor } from "@pro-laico/payload-revalidate";
 import { cacheLife } from "next/cache";
 import { getPayload } from "payload";
+
+// src/revalidate/contentLists.ts
+import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
+// src/render/metadata/query.ts
 var _helpers = null;
 var _seedPromise = null;
 function seedPayloadCache({ config }) {
@@ -186,7 +209,7 @@ async function queryAllDocs(args) {
 }
 async function queryDocs({
   collectionSlug,
-  list,
+  list = CONTENT_LIST,
   draft = false,
   depth = RENDER_DEPTH,
   ...find

package/dist/pages.d.ts

@@ -41,6 +41,8 @@ type CreateCollectionPageExportsArgs<S extends string = "pages"> = {
 	slugShape?: SlugShape;
 	/** Relationship / upload hops populated on the rendered document. `0` renders them as bare ids. */
 	depth?: number;
+	/** Locales whose documents prerender at build. The rest render on their first request and cache from there. Defaults to every locale. */
+	prerenderLocales?: string[];
 };
 type CreateCollectionPageExportsDeps<S extends string> = {
 	getServerSideURL: () => string;
@@ -48,7 +50,7 @@ type CreateCollectionPageExportsDeps<S extends string> = {
 	/** Rendered while the document streams. Defaults to nothing. */
 	fallback?: ReactNode2;
 };
-declare function createCollectionPageExports<S extends string = "pages">({ slug: collectionSlug, _payloadConfig, importMap, routing, slugShape, depth }: CreateCollectionPageExportsArgs<S>, { getServerSideURL, pagePathPrefix, fallback }: CreateCollectionPageExportsDeps<S>): {
+declare function createCollectionPageExports<S extends string = "pages">({ slug: collectionSlug, _payloadConfig, importMap, routing, slugShape, depth, prerenderLocales }: CreateCollectionPageExportsArgs<S>, { getServerSideURL, pagePathPrefix, fallback }: CreateCollectionPageExportsDeps<S>): {
 	default: (props: NextPageProps) => Promise<ReactNode2>;
 	generateMetadata: (props: NextPageProps) => Promise<Metadata>;
 	generateStaticParams: (props: GenerateStaticParamsProps) => Promise<{

package/dist/pages.js

@@ -205,6 +205,29 @@ import { createCacheHelpers } from "@pro-laico/payload-revalidate/cache";
 import { tagsFor } from "@pro-laico/payload-revalidate";
 import { cacheLife } from "next/cache";
 import { getPayload } from "payload";
+
+// src/revalidate/contentLists.ts
+import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
+// src/render/metadata/query.ts
 var _helpers = null;
 var _seedPromise = null;
 function seedPayloadCache({ config }) {
@@ -271,7 +294,7 @@ async function queryAllDocs(args) {
 }
 async function queryDocs({
   collectionSlug,
-  list,
+  list = CONTENT_LIST,
   draft = false,
   depth = RENDER_DEPTH,
   ...find
@@ -392,7 +415,8 @@ function createCollectionPageExports({
   importMap,
   routing,
   slugShape = "single",
-  depth = RENDER_DEPTH
+  depth = RENDER_DEPTH,
+  prerenderLocales = routing.locales
 }, {
   getServerSideURL,
   pagePathPrefix,
@@ -459,7 +483,7 @@ function createCollectionPageExports({
   }
   async function generateStaticParams(props) {
     await props.params;
-    const perLocaleEntries = await Promise.all(routing.locales.map(async (locale) => {
+    const perLocaleEntries = await Promise.all(prerenderLocales.map(async (locale) => {
       const docs = await queryAllDocs({ locale, collectionSlug });
       const entries = docs.filter((doc) => !isIndexSlug(doc.slug)).map((doc) => ({ locale, slug: slugToParamsSlug(doc.slug, slugShape) }));
       if (shapeHasIndexPath(slugShape) && await fetchDoc(locale, ""))

package/dist/render-pages.d.ts

@@ -50,6 +50,8 @@ type CreateCollectionPageExportsArgs<S extends string = "pages"> = {
 	slugShape?: SlugShape;
 	/** Relationship / upload hops populated on the rendered document. `0` renders them as bare ids. */
 	depth?: number;
+	/** Locales whose documents prerender at build. The rest render on their first request and cache from there. Defaults to every locale. */
+	prerenderLocales?: string[];
 };
 type CreateCollectionPageExportsDeps<S extends string> = {
 	getServerSideURL: () => string;
@@ -57,7 +59,7 @@ type CreateCollectionPageExportsDeps<S extends string> = {
 	/** Rendered while the document streams. Defaults to nothing. */
 	fallback?: ReactNode2;
 };
-declare function createCollectionPageExports<S extends string = "pages">({ slug: collectionSlug, _payloadConfig, importMap, routing, slugShape, depth }: CreateCollectionPageExportsArgs<S>, { getServerSideURL, pagePathPrefix, fallback }: CreateCollectionPageExportsDeps<S>): {
+declare function createCollectionPageExports<S extends string = "pages">({ slug: collectionSlug, _payloadConfig, importMap, routing, slugShape, depth, prerenderLocales }: CreateCollectionPageExportsArgs<S>, { getServerSideURL, pagePathPrefix, fallback }: CreateCollectionPageExportsDeps<S>): {
 	default: (props: NextPageProps) => Promise<ReactNode2>;
 	generateMetadata: (props: NextPageProps) => Promise<Metadata>;
 	generateStaticParams: (props: GenerateStaticParamsProps) => Promise<{

package/dist/render-pages.js

@@ -235,6 +235,29 @@ import { createCacheHelpers } from "@pro-laico/payload-revalidate/cache";
 import { tagsFor } from "@pro-laico/payload-revalidate";
 import { cacheLife } from "next/cache";
 import { getPayload } from "payload";
+
+// src/revalidate/contentLists.ts
+import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
+// src/render/metadata/query.ts
 var _helpers = null;
 var _seedPromise = null;
 function seedPayloadCache({ config }) {
@@ -301,7 +324,7 @@ async function queryAllDocs(args) {
 }
 async function queryDocs({
   collectionSlug,
-  list,
+  list = CONTENT_LIST,
   draft = false,
   depth = RENDER_DEPTH,
   ...find
@@ -422,7 +445,8 @@ function createCollectionPageExports({
   importMap,
   routing,
   slugShape = "single",
-  depth = RENDER_DEPTH
+  depth = RENDER_DEPTH,
+  prerenderLocales = routing.locales
 }, {
   getServerSideURL,
   pagePathPrefix,
@@ -489,7 +513,7 @@ function createCollectionPageExports({
   }
   async function generateStaticParams(props) {
     await props.params;
-    const perLocaleEntries = await Promise.all(routing.locales.map(async (locale) => {
+    const perLocaleEntries = await Promise.all(prerenderLocales.map(async (locale) => {
       const docs = await queryAllDocs({ locale, collectionSlug });
       const entries = docs.filter((doc) => !isIndexSlug(doc.slug)).map((doc) => ({ locale, slug: slugToParamsSlug(doc.slug, slugShape) }));
       if (shapeHasIndexPath(slugShape) && await fetchDoc(locale, ""))

package/dist/sitemap.js

@@ -30,6 +30,29 @@ import { createCacheHelpers } from "@pro-laico/payload-revalidate/cache";
 import { tagsFor } from "@pro-laico/payload-revalidate";
 import { cacheLife } from "next/cache";
 import { getPayload } from "payload";
+
+// src/revalidate/contentLists.ts
+import { revalidatePlugin } from "@pro-laico/payload-revalidate";
+import { flattenTopLevelFields } from "payload";
+var CONTENT_LIST = "content";
+function revalidateWithContentLists(options) {
+  return (config) => revalidatePlugin({
+    ...options,
+    collections: { ...options.collections, ...contentLists(config.collections ?? [], options.collections ?? {}) }
+  })(config);
+}
+function contentLists(collections, overrides) {
+  return Object.fromEntries(collections.flatMap(({ slug, fields, custom }) => {
+    const marker = custom?.revalidate;
+    const override = overrides[slug];
+    if (override === false || marker === false && override === undefined)
+      return [];
+    const lists = { [CONTENT_LIST]: flattenTopLevelFields(fields).map(({ name }) => name), ...marker?.lists, ...override?.lists };
+    return [[slug, { ...override, lists }]];
+  }));
+}
+
+// src/render/metadata/query.ts
 var _helpers = null;
 var _seedPromise = null;
 function seedPayloadCache({ config }) {
@@ -96,7 +119,7 @@ async function queryAllDocs(args) {
 }
 async function queryDocs({
   collectionSlug,
-  list,
+  list = CONTENT_LIST,
   draft = false,
   depth = RENDER_DEPTH,
   ...find
@@ -238,7 +261,8 @@ function createCollectionPageExports({
   importMap,
   routing,
   slugShape = "single",
-  depth = RENDER_DEPTH
+  depth = RENDER_DEPTH,
+  prerenderLocales = routing.locales
 }, {
   getServerSideURL,
   pagePathPrefix,
@@ -305,7 +329,7 @@ function createCollectionPageExports({
   }
   async function generateStaticParams(props) {
     await props.params;
-    const perLocaleEntries = await Promise.all(routing.locales.map(async (locale) => {
+    const perLocaleEntries = await Promise.all(prerenderLocales.map(async (locale) => {
       const docs = await queryAllDocs({ locale, collectionSlug });
       const entries = docs.filter((doc) => !isIndexSlug(doc.slug)).map((doc) => ({ locale, slug: slugToParamsSlug(doc.slug, slugShape) }));
       if (shapeHasIndexPath(slugShape) && await fetchDoc(locale, ""))

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@justanarthur/payload-www",
   "description": "Reusable Payload CMS website template — config builder, collections, globals, blocks, fields, access, hooks, metadata (JSON-LD, hreflang), page renderers, and test helpers.",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "license": "MIT",
   "type": "module",
   "private": false,