init commit for iPAL-kit plugin

src/modules/frontend/createContentHelpers.ts

@@ -3,9 +3,9 @@ import type { BasePayload, SanitizedConfig } from 'payload'
 import { getPayload } from 'payload'
 import { cache } from 'react'
 
-import type { ContentOption, ResolvedRoute  } from '../content/index.js'
+import type { ArchiveEntries, ContentOption, ResolvedRoute } from '../content/index.js'
 
-import { resolveRoute as resolveRouteRaw } from '../content/index.js'
+import { getArchiveEntries, resolveRoute as resolveRouteRaw } from '../content/index.js'
 
 type CreateContentHelpersArgs = {
   /**
@@ -24,7 +24,7 @@ type CreateContentHelpersArgs = {
 /**
  * Bundles the per-request data helpers a frontend needs — the same cached
  * wrappers every project was writing by hand (getPayload, settings, locale
- * list, route resolution).
+ * list, route resolution, archive entries).
  *
  * Everything is wrapped in React `cache()`, so within one request a value is
  * fetched once no matter how many times it's asked for — which matters because
@@ -39,9 +39,13 @@ type CreateContentHelpersArgs = {
  * import config from '@/payload.config'
  * import { contentConfig } from '@/content.config'
  *
- * export const { getCachedPayload, getSettings, getConfiguredLocales, resolveRoute } =
+ * export const { getCachedPayload, getSettings, getConfiguredLocales, resolveRoute, getEntries } =
  *   createContentHelpers({ config, content: contentConfig })
  * ```
+ *
+ * `resolveRoute` and `getEntries` are separate on purpose: routing decides what
+ * a URL is, fetching gets the listing. Metadata generation needs the first and
+ * not the second, and a page component composes them in two obvious lines.
  */
 export function createContentHelpers({
   config,
@@ -63,31 +67,30 @@ export function createContentHelpers({
     return payload.findGlobal({ slug: settingsSlug as never, depth: 2, locale: locale as never })
   })
 
-  /**
-   * Resolves a URL to a page / archive / entry. Pass `withEntries` on the page
-   * component (it needs the listing); omit it for metadata (it doesn't, and the
-   * query would be wasted).
-   */
+  /** What does this URL point at? Routing only — no listing data. */
   const resolveRoute = cache(
     async (
       locale: string,
       segments: string[] | undefined,
       page: number,
-      withEntries = false,
     ): Promise<null | ResolvedRoute> => {
       const payload = await getCachedPayload()
-      return resolveRouteRaw({
-        content,
-        locale,
-        page,
-        pagesSlug,
-        payload,
-        segments,
-        settingsSlug,
-        withEntries,
-      })
+      return resolveRouteRaw({ content, locale, page, pagesSlug, payload, segments, settingsSlug })
     },
   )
 
-  return { getCachedPayload, getConfiguredLocales, getSettings, resolveRoute }
+  /** One page of a collection's entries, for an archive listing. */
+  const getEntries = cache(
+    async (
+      collection: string,
+      locale: string,
+      page: number,
+      perPage: number,
+    ): Promise<ArchiveEntries> => {
+      const payload = await getCachedPayload()
+      return getArchiveEntries({ collection, locale, page, payload, perPage })
+    },
+  )
+
+  return { getCachedPayload, getConfiguredLocales, getEntries, getSettings, resolveRoute }
 }