@justanarthur/payload-www 2.2.9 → 2.3.0

package/README.md

@@ -20,7 +20,7 @@ The composition root is `createWWWConfig()` — see [Quick start](#quick-start)
 | Fields | [`/fields`](#fields) | `link`, `linkGroup` (with `disableLabel` / `appearances` / `localized` / `relationTo` / `extraFields`), `slugField`, `appearanceOptions`. |
 | Access | [`/access`](#access) | `anyone`, `authenticated`, `authenticatedOrPublished`. |
 | Caching | [`Caching`](#caching) | Cached query getters wrap `@pro-laico/payload-revalidate` finders; tag-based invalidation via `revalidatePlugin()`; `seedPayloadCache` singleton seed. |
-| Metadata | [`/metadata`](#metadata) | `buildArticleLd`, `buildBreadcrumbsLd`, `buildOrganizationLd`, `buildWebSiteLd`, `buildProductLd`, `buildRootJsonLd`; slug transforms; `queryDocBySlug`, `queryDocByID`, `queryGlobal`, `queryAllDocs`, `queryAllLocaleSlugs`; `seedPayloadCache`, `tagsFor`. |
+| Metadata | [`/metadata`](#metadata) | `buildArticleLd`, `buildBreadcrumbsLd`, `buildOrganizationLd`, `buildWebSiteLd`, `buildProductLd`, `buildRootJsonLd`; slug transforms; `queryDocBySlug`, `queryDocByID`, `queryGlobal`, `queryDocs`, `queryAllDocs`, `queryAllLocaleSlugs`; `seedPayloadCache`, `tagsFor`. |
 | Next.js page renderers | [`/render-pages`](#render-pages) | `createCollectionPageExports`, `createRootLayoutExports`; default render components `PagesPage`, `PostsPage`, `HeaderPage`, `FooterPage`, `RootJsonLd`. |
 | Sitemap | [`/sitemap`](#sitemap) | `createSitemapFromCollections` (Next.js file-convention helper). |
 | Plugin re-exports | [`/imagehash`](#plugin-re-exports), [`/translator`](#plugin-re-exports) | Drop-in for hosts that don't want to import the sibling packages directly. |
@@ -255,8 +255,8 @@ in the host's `revalidatePlugin()` registration (see [Caching](#caching) below).
 
 ### Caching
 
-The lib's cached query layer (`queryDocBySlug`, `queryGlobal`, `queryAllDocs`, `queryAllLocaleSlugs`,
-`queryDocByID`) wraps `@pro-laico/payload-revalidate`'s finders in `'use cache'` + `cacheLife('weeks')`
+The lib's cached query layer (`queryDocBySlug`, `queryGlobal`, `queryDocs`, `queryAllDocs`,
+`queryAllLocaleSlugs`, `queryDocByID`) wraps `@pro-laico/payload-revalidate`'s finders in `'use cache'` + `cacheLife('weeks')`
 scopes. Setup:
 
 1. **Install the peer deps at the workspace root** (not in the lib's `dependencies` — `file:` links
@@ -303,6 +303,34 @@ scopes. Setup:
    seedPayloadCache({ config })
    ```
 
+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:
+
+   ```ts
+   import { queryDocs } from '@justanarthur/payload-www/metadata'
+
+   const { docs, totalPages } = await queryDocs({
+     collectionSlug: 'posts',
+     locale,
+     sort: '-publishedAt',
+     limit: 10,
+     depth: 1,
+     list: 'archive'
+   })
+   ```
+
+   `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'] } } } }
+     }
+   })
+   ```
+
 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
 purely tag-based: `revalidatePlugin()` fires the same tags the finders emit, so every save /
@@ -346,6 +374,7 @@ import {
   queryDocBySlug,           // cached collection fetch
   queryDocByID,             // cached collection fetch by id
   queryGlobal,              // cached global fetch
+  queryDocs,                // cached, tagged listing (where / sort / limit / page)
   queryAllDocs,             // for generateStaticParams
   queryAllLocaleSlugs,      // for hreflang alternates
   seedPayloadCache,         // one-time seed for the pro-laico cache helpers
@@ -398,7 +427,7 @@ The package's `package.json#exports` map:
 | `@justanarthur/payload-www/collections` | `createWWWCollectionGlobal`, `queryDoc` |
 | `@justanarthur/payload-www/fields` | `link`, `linkGroup`, `appearanceOptions`, `slugField`, `LinkAppearances`, `LinkOptions` |
 | `@justanarthur/payload-www/access` | `anyone`, `authenticated`, `authenticatedOrPublished` |
-| `@justanarthur/payload-www/metadata` | `buildArticleLd`, `buildBreadcrumbsLd`, `buildOrganizationLd`, `buildWebSiteLd`, `buildProductLd`, `buildRootJsonLd`, `queryDocBySlug`, `queryDocByID`, `queryGlobal`, `queryAllDocs`, `queryAllLocaleSlugs`, `seedPayloadCache`, `tagsFor`, `paramsSlugToSlug`, `slugToParamsSlug` + types |
+| `@justanarthur/payload-www/metadata` | `buildArticleLd`, `buildBreadcrumbsLd`, `buildOrganizationLd`, `buildWebSiteLd`, `buildProductLd`, `buildRootJsonLd`, `queryDocBySlug`, `queryDocByID`, `queryGlobal`, `queryDocs`, `queryAllDocs`, `queryAllLocaleSlugs`, `seedPayloadCache`, `tagsFor`, `paramsSlugToSlug`, `slugToParamsSlug` + types |
 | `@justanarthur/payload-www/utils` | `generateImportName`, `getFromImportMap` |
 | `@justanarthur/payload-www/imagehash` | `imageHashPlugin`, `BlurhashPluginOptions` (re-export of `@justanarthur/payload-imagehash-plugin`) |
 | `@justanarthur/payload-www/translator` | `translator` (re-export of `@justanarthur/payload-plugin-translator`) |

package/dist/collections.js

@@ -119,7 +119,7 @@ function seedPayloadCache({ config }) {
     return;
   _seedPromise = (async () => {
     const payload = await getPayload({ config: await config });
-    _helpers = createCacheHelpers(payload);
+    _helpers = { ...createCacheHelpers(payload), payload };
   })();
 }
 async function requireCacheHelpers() {
@@ -176,6 +176,28 @@ async function queryAllDocs(args) {
   const docs = await Promise.all(ids.map((id) => findDocByID(collection, id, { locale: args.locale, overrideAccess: false, depth: 0 })));
   return docs.filter((d) => d !== null);
 }
+async function queryDocs({
+  collectionSlug,
+  list,
+  draft = false,
+  depth = RENDER_DEPTH,
+  ...find
+}) {
+  "use cache";
+  cacheLife("weeks");
+  const { payload, cacheIds, cacheDoc } = await requireCacheHelpers();
+  const collection = collectionSlug;
+  const result = await payload.find({ ...find, collection, draft, depth, overrideAccess: draft });
+  await cacheIds(result, collection, { list, draft });
+  for (const doc of result.docs)
+    await cacheDoc(doc, collection, { draft });
+  return {
+    docs: result.docs,
+    totalDocs: result.totalDocs,
+    totalPages: result.totalPages,
+    page: result.page ?? 1
+  };
+}
 async function queryDoc(args) {
   if ("globalSlug" in args)
     return queryGlobal(args);

package/dist/config.d.ts

@@ -1,5 +1,6 @@
 import { CollectionConfig, Config, GlobalConfig, Plugin } from "payload";
 import { MCPPluginConfig } from "@payloadcms/plugin-mcp";
+import { RevalidatePluginOptions } from "@pro-laico/payload-revalidate";
 import { SEOPluginConfig } from "@justanarthur/payload-plugin-seo/types";
 import { BlurhashPluginOptions } from "@justanarthur/payload-imagehash-plugin/types";
 import { TranslatorConfig } from "@justanarthur/payload-plugin-translator/types";
@@ -15,7 +16,7 @@ type WWWInputConfig = Omit<Config, "collections" | "globals" | "plugins"> & {
 		imageHash?: MergeOrOverride<BlurhashPluginOptions>;
 		translator?: MergeOrOverride<TranslatorConfig>;
 		mcp?: MergeOrOverride<MCPPluginConfig>;
-		revalidate?: false | (<D>(d: D) => D);
+		revalidate?: false | MergeOrOverride<RevalidatePluginOptions>;
 	};
 };
 declare function createWWWConfig(): WWWConfigApi;

package/dist/config.js

@@ -317,6 +317,7 @@ import { revalidatePlugin } from "@pro-laico/payload-revalidate";
 function createWWWConfig() {
   function withWWWConfig(input) {
     const { defaultPluginsConfigs, ...config } = input;
+    const revalidate = defaultPluginsConfigs?.revalidate;
     const blocks = config.blocks || [];
     const collections = mergeOrOverride([
       createPagesCollection(blocks),
@@ -362,7 +363,7 @@ function createWWWConfig() {
     ];
     const plugins = [
       ...mergeOrOverride(defaultPlugins, config.plugins),
-      revalidatePlugin()
+      revalidatePlugin(revalidate === false ? { enabled: false } : mergeOrOverride({}, revalidate))
     ];
     return {
       ...config,

package/dist/metadata.d.ts

@@ -22,7 +22,7 @@ declare function paramsSlugToSlug(slug: string | string[] | undefined, _shape: S
 declare function slugToParamsSlug(slug: string, shape: SlugShape): string | string[];
 declare function isIndexSlug(slug: string | null | undefined): boolean;
 declare function shapeHasIndexPath(shape: SlugShape): boolean;
-import { DataFromCollectionSlug, DataFromGlobalSlug, SanitizedConfig } from "payload";
+import { DataFromCollectionSlug, DataFromGlobalSlug, SanitizedConfig, SelectType, Sort, Where } from "payload";
 import { tagsFor } from "@pro-laico/payload-revalidate";
 type SeedPayloadCacheArgs = {
 	config: SanitizedConfig | Promise<SanitizedConfig>;
@@ -47,9 +47,28 @@ type QueryListArgs<S extends string> = {
 	slugField?: string;
 	locale: string;
 };
+type QueryDocsArgs<S extends string> = {
+	collectionSlug: S;
+	locale: string;
+	where?: Where;
+	sort?: Sort;
+	limit?: number;
+	page?: number;
+	depth?: number;
+	select?: SelectType;
+	draft?: boolean;
+	list?: string;
+};
+type QueryDocsResult<S extends string> = {
+	docs: DataFromCollectionSlug<S>[];
+	totalDocs: number;
+	totalPages: number;
+	page: number;
+};
 declare function queryDocBySlug<S extends string>(args: QueryCollectionArgs<S>): Promise<DataFromCollectionSlug<S> | null>;
 declare function queryGlobal<G extends string>(args: QueryGlobalArgs<G>): Promise<DataFromGlobalSlug<G> | null>;
 declare function queryAllDocs<S extends string = string>(args: QueryListArgs<S>): Promise<DataFromCollectionSlug<S>[]>;
+declare function queryDocs<S extends string>({ collectionSlug, list, draft, depth,...find }: QueryDocsArgs<S>): Promise<QueryDocsResult<S>>;
 declare function queryAllLocaleSlugs(args: {
 	collectionSlug: string;
 	id: number | string;
@@ -74,6 +93,7 @@ declare const metadata: {
 	queryDocBySlug: typeof queryDocBySlug;
 	queryDocByID: typeof queryDocByID;
 	queryGlobal: typeof queryGlobal;
+	queryDocs: typeof queryDocs;
 	queryAllDocs: typeof queryAllDocs;
 	queryAllLocaleSlugs: typeof queryAllLocaleSlugs;
 	paramsSlugToSlug: typeof paramsSlugToSlug;
@@ -83,4 +103,4 @@ declare const metadata: {
 	seedPayloadCache: typeof seedPayloadCache;
 	tagsFor: (payload: Payload_eipjla) => Tags_1jpdl;
 };
-export { ArticleLdOptions, BreadcrumbItem, BuildOrganizationLdOptions, BuildProductLdOptions, BuildRootJsonLdOptions, BuildWebSiteLdOptions, SeedPayloadCacheArgs, SlugShape, buildArticleLd, buildBreadcrumbsLd, buildOrganizationLd, buildProductLd, buildRootJsonLd, buildWebSiteLd, metadata as default, isIndexSlug, paramsSlugToSlug, queryAllDocs, queryAllLocaleSlugs, queryDocByID, queryDocBySlug, queryGlobal, seedPayloadCache, shapeHasIndexPath, slugToParamsSlug, tagsFor };
+export { ArticleLdOptions, BreadcrumbItem, BuildOrganizationLdOptions, BuildProductLdOptions, BuildRootJsonLdOptions, BuildWebSiteLdOptions, QueryDocsArgs, QueryDocsResult, SeedPayloadCacheArgs, SlugShape, buildArticleLd, buildBreadcrumbsLd, buildOrganizationLd, buildProductLd, buildRootJsonLd, buildWebSiteLd, metadata as default, isIndexSlug, paramsSlugToSlug, queryAllDocs, queryAllLocaleSlugs, queryDocByID, queryDocBySlug, queryDocs, queryGlobal, seedPayloadCache, shapeHasIndexPath, slugToParamsSlug, tagsFor };

package/dist/metadata.js

@@ -127,7 +127,7 @@ function seedPayloadCache({ config }) {
     return;
   _seedPromise = (async () => {
     const payload = await getPayload({ config: await config });
-    _helpers = createCacheHelpers(payload);
+    _helpers = { ...createCacheHelpers(payload), payload };
   })();
 }
 async function requireCacheHelpers() {
@@ -184,6 +184,28 @@ async function queryAllDocs(args) {
   const docs = await Promise.all(ids.map((id) => findDocByID(collection, id, { locale: args.locale, overrideAccess: false, depth: 0 })));
   return docs.filter((d) => d !== null);
 }
+async function queryDocs({
+  collectionSlug,
+  list,
+  draft = false,
+  depth = RENDER_DEPTH,
+  ...find
+}) {
+  "use cache";
+  cacheLife("weeks");
+  const { payload, cacheIds, cacheDoc } = await requireCacheHelpers();
+  const collection = collectionSlug;
+  const result = await payload.find({ ...find, collection, draft, depth, overrideAccess: draft });
+  await cacheIds(result, collection, { list, draft });
+  for (const doc of result.docs)
+    await cacheDoc(doc, collection, { draft });
+  return {
+    docs: result.docs,
+    totalDocs: result.totalDocs,
+    totalPages: result.totalPages,
+    page: result.page ?? 1
+  };
+}
 async function queryDoc(args) {
   if ("globalSlug" in args)
     return queryGlobal(args);
@@ -223,6 +245,7 @@ var metadata = {
   queryDocBySlug,
   queryDocByID,
   queryGlobal,
+  queryDocs,
   queryAllDocs,
   queryAllLocaleSlugs,
   paramsSlugToSlug,
@@ -247,6 +270,7 @@ export {
   queryAllLocaleSlugs,
   queryDocByID,
   queryDocBySlug,
+  queryDocs,
   queryGlobal,
   seedPayloadCache,
   shapeHasIndexPath,

package/dist/pages.js

@@ -212,7 +212,7 @@ function seedPayloadCache({ config }) {
     return;
   _seedPromise = (async () => {
     const payload = await getPayload({ config: await config });
-    _helpers = createCacheHelpers(payload);
+    _helpers = { ...createCacheHelpers(payload), payload };
   })();
 }
 async function requireCacheHelpers() {
@@ -269,6 +269,28 @@ async function queryAllDocs(args) {
   const docs = await Promise.all(ids.map((id) => findDocByID(collection, id, { locale: args.locale, overrideAccess: false, depth: 0 })));
   return docs.filter((d) => d !== null);
 }
+async function queryDocs({
+  collectionSlug,
+  list,
+  draft = false,
+  depth = RENDER_DEPTH,
+  ...find
+}) {
+  "use cache";
+  cacheLife("weeks");
+  const { payload, cacheIds, cacheDoc } = await requireCacheHelpers();
+  const collection = collectionSlug;
+  const result = await payload.find({ ...find, collection, draft, depth, overrideAccess: draft });
+  await cacheIds(result, collection, { list, draft });
+  for (const doc of result.docs)
+    await cacheDoc(doc, collection, { draft });
+  return {
+    docs: result.docs,
+    totalDocs: result.totalDocs,
+    totalPages: result.totalPages,
+    page: result.page ?? 1
+  };
+}
 async function queryDoc(args) {
   if ("globalSlug" in args)
     return queryGlobal(args);

package/dist/render-pages.js

@@ -242,7 +242,7 @@ function seedPayloadCache({ config }) {
     return;
   _seedPromise = (async () => {
     const payload = await getPayload({ config: await config });
-    _helpers = createCacheHelpers(payload);
+    _helpers = { ...createCacheHelpers(payload), payload };
   })();
 }
 async function requireCacheHelpers() {
@@ -299,6 +299,28 @@ async function queryAllDocs(args) {
   const docs = await Promise.all(ids.map((id) => findDocByID(collection, id, { locale: args.locale, overrideAccess: false, depth: 0 })));
   return docs.filter((d) => d !== null);
 }
+async function queryDocs({
+  collectionSlug,
+  list,
+  draft = false,
+  depth = RENDER_DEPTH,
+  ...find
+}) {
+  "use cache";
+  cacheLife("weeks");
+  const { payload, cacheIds, cacheDoc } = await requireCacheHelpers();
+  const collection = collectionSlug;
+  const result = await payload.find({ ...find, collection, draft, depth, overrideAccess: draft });
+  await cacheIds(result, collection, { list, draft });
+  for (const doc of result.docs)
+    await cacheDoc(doc, collection, { draft });
+  return {
+    docs: result.docs,
+    totalDocs: result.totalDocs,
+    totalPages: result.totalPages,
+    page: result.page ?? 1
+  };
+}
 async function queryDoc(args) {
   if ("globalSlug" in args)
     return queryGlobal(args);

package/dist/sitemap.js

@@ -37,7 +37,7 @@ function seedPayloadCache({ config }) {
     return;
   _seedPromise = (async () => {
     const payload = await getPayload({ config: await config });
-    _helpers = createCacheHelpers(payload);
+    _helpers = { ...createCacheHelpers(payload), payload };
   })();
 }
 async function requireCacheHelpers() {
@@ -94,6 +94,28 @@ async function queryAllDocs(args) {
   const docs = await Promise.all(ids.map((id) => findDocByID(collection, id, { locale: args.locale, overrideAccess: false, depth: 0 })));
   return docs.filter((d) => d !== null);
 }
+async function queryDocs({
+  collectionSlug,
+  list,
+  draft = false,
+  depth = RENDER_DEPTH,
+  ...find
+}) {
+  "use cache";
+  cacheLife("weeks");
+  const { payload, cacheIds, cacheDoc } = await requireCacheHelpers();
+  const collection = collectionSlug;
+  const result = await payload.find({ ...find, collection, draft, depth, overrideAccess: draft });
+  await cacheIds(result, collection, { list, draft });
+  for (const doc of result.docs)
+    await cacheDoc(doc, collection, { draft });
+  return {
+    docs: result.docs,
+    totalDocs: result.totalDocs,
+    totalPages: result.totalPages,
+    page: result.page ?? 1
+  };
+}
 async function queryDoc(args) {
   if ("globalSlug" in args)
     return queryGlobal(args);

package/package.json

@@ -1,7 +1,8 @@
 {
   "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.2.9",
+  "version": "2.3.0",
+  "license": "MIT",
   "type": "module",
   "private": false,
   "files": [