@websolutespa/bom-next 4.0.0-next.11 → 4.0.0-next.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (49) hide show
  1. package/CHANGELOG.md +21 -0
  2. package/README.md +5 -1
  3. package/dist/cache-handler/redis.d.ts +20 -3
  4. package/dist/cache-handler/redis.d.ts.map +1 -1
  5. package/dist/cache-handler/redis.js +54 -8
  6. package/dist/cache-handler/redis.js.map +1 -1
  7. package/dist/client/user.d.ts.map +1 -1
  8. package/dist/client/user.js.map +1 -1
  9. package/dist/exports/cache-handlers-isr.d.ts +2 -2
  10. package/dist/exports/cache-handlers-isr.js +2 -2
  11. package/dist/exports/server.d.ts +4 -3
  12. package/dist/exports/server.js +4 -3
  13. package/dist/index.d.ts +2 -2
  14. package/dist/index.js +2 -2
  15. package/dist/instrumentation/server.d.ts.map +1 -1
  16. package/dist/instrumentation/server.js +4 -0
  17. package/dist/instrumentation/server.js.map +1 -1
  18. package/dist/lib/const.d.ts +9 -1
  19. package/dist/lib/const.d.ts.map +1 -1
  20. package/dist/lib/const.js +16 -1
  21. package/dist/lib/const.js.map +1 -1
  22. package/dist/lib/page-metadata.d.ts +13 -2
  23. package/dist/lib/page-metadata.d.ts.map +1 -1
  24. package/dist/lib/page-metadata.js +10 -3
  25. package/dist/lib/page-metadata.js.map +1 -1
  26. package/dist/server/cache/inspector/redis.js +2 -2
  27. package/dist/server/cache/inspector/redis.js.map +1 -1
  28. package/dist/server/handlers/preview.handler.d.ts +27 -3
  29. package/dist/server/handlers/preview.handler.d.ts.map +1 -1
  30. package/dist/server/handlers/preview.handler.js +57 -6
  31. package/dist/server/handlers/preview.handler.js.map +1 -1
  32. package/dist/server/metadata.d.ts +1 -1
  33. package/dist/server/mixer.d.ts +1 -1
  34. package/dist/server/mixer.d.ts.map +1 -1
  35. package/dist/server/mixer.js +11 -2
  36. package/dist/server/mixer.js.map +1 -1
  37. package/package.json +2 -2
  38. package/src/cache-handler/redis.test.ts +78 -1
  39. package/src/cache-handler/redis.ts +70 -8
  40. package/src/client/user.tsx +3 -2
  41. package/src/exports/cache-handlers-isr.ts +7 -1
  42. package/src/instrumentation/server.ts +6 -0
  43. package/src/lib/const.ts +10 -0
  44. package/src/lib/page-metadata.test.ts +33 -1
  45. package/src/lib/page-metadata.ts +20 -1
  46. package/src/server/cache/inspector/redis.ts +8 -2
  47. package/src/server/handlers/preview.handler.test.ts +92 -0
  48. package/src/server/handlers/preview.handler.ts +85 -53
  49. package/src/server/mixer.ts +19 -2
@@ -1,7 +1,14 @@
1
1
  import { getPublicUrl } from "./utils.js";
2
- import { defaultLocale, defaultMarket, getMetaRobots } from "@websolutespa/bom-core";
2
+ import { defaultLocale, defaultMarket, getIsProduction, getMetaRobots } from "@websolutespa/bom-core";
3
3
  import { convert } from "html-to-text";
4
4
  //#region src/lib/page-metadata.ts
5
+ /**
6
+ * The deployment policy: pages are indexable only in production (`PRODUCTION=true`, as the BOM 3 `Meta` component
7
+ * required) and unless `NOINDEX=true`. Every other deployment (staging, previews, local) is `noindex`.
8
+ */
9
+ function isIndexableDeployment(env = process.env) {
10
+ return getIsProduction() && env.NOINDEX !== "true";
11
+ }
5
12
  /** Converts CMS HTML (titles, abstracts) to a single line of plain text. */
6
13
  function toPlainText(html) {
7
14
  if (!html) return "";
@@ -114,7 +121,7 @@ function buildPageMetadata(page, layout, options = {}) {
114
121
  const image = resolveMetadataUrl(getMediaUrl(meta.image) || getMediaUrl(page.media) || options.brand?.logo, baseUrl);
115
122
  const canonicalBase = resolveMetadataUrl(page.href, baseUrl);
116
123
  const canonical = canonicalBase ? `${canonicalBase}${getPaginationQuery(options.searchParams)}` : void 0;
117
- const robots = getMetaRobots(meta);
124
+ const robots = (typeof options.indexable === "function" ? options.indexable(page) : options.indexable ?? isIndexableDeployment()) ? getMetaRobots(meta) : "noindex, nofollow";
118
125
  const languages = {};
119
126
  if (layout) {
120
127
  getPageAlternates(page, layout, baseUrl).forEach((alternate) => {
@@ -187,6 +194,6 @@ function inheritParentMetadata(metadata, parent) {
187
194
  };
188
195
  }
189
196
  //#endregion
190
- export { buildPageMetadata, getPageAlternates, getPageXDefault, getPaginationQuery, inheritParentMetadata, resolveMetadataUrl, toPlainText };
197
+ export { buildPageMetadata, getPageAlternates, getPageXDefault, getPaginationQuery, inheritParentMetadata, isIndexableDeployment, resolveMetadataUrl, toPlainText };
191
198
 
192
199
  //# sourceMappingURL=page-metadata.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"page-metadata.js","names":[],"sources":["../../src/lib/page-metadata.ts"],"sourcesContent":["import {\n defaultLocale,\n defaultMarket,\n getMetaRobots,\n ILayout,\n IMedia,\n IPage,\n IRoute,\n} from '@websolutespa/bom-core';\nimport { convert } from 'html-to-text';\nimport type { Metadata, ResolvedMetadata } from 'next';\nimport type { IAlternate } from './meta-data';\nimport { getPublicUrl } from './utils';\n\nexport type PageMetadataBrand = {\n /** Site name, used for Open Graph `siteName`. */\n name: string;\n /** Fallback image when the page has no meta image or media. */\n logo?: string;\n /** Twitter handle, used for `twitter:site` and `twitter:creator`. */\n twitterName?: string;\n};\n\nexport type PageMetadataSearchParams =\n | URLSearchParams\n | Record<string, string | string[] | undefined>;\n\nexport type PageMetadataContext = {\n page: IPage;\n layout?: ILayout;\n};\n\nexport type PageMetadataOptions = {\n brand?: PageMetadataBrand;\n /** Absolute origin for canonical, alternates and images. Default `NEXT_PUBLIC_URL`. */\n baseUrl?: string;\n /** Request search params; `pagination[page]` > 1 is kept in the canonical URL. */\n searchParams?: PageMetadataSearchParams;\n /** Per-page override applied to the computed metadata. */\n extend?: (metadata: Metadata, context: PageMetadataContext) => Metadata;\n};\n\ntype PageMetaFields = {\n title?: string;\n description?: string;\n keywords?: string;\n robots?: string;\n robot?: string;\n image?: IMedia | string | null;\n};\n\n/** Converts CMS HTML (titles, abstracts) to a single line of plain text. */\nexport function toPlainText(html?: string | null): string {\n if (!html) {\n return '';\n }\n return convert(html, {\n wordwrap: false,\n selectors: [\n { selector: 'a', options: { ignoreHref: true } },\n { selector: 'img', format: 'skip' },\n // keep the original case and drop list bullets: this text ends up in meta tags\n ...['h1', 'h2', 'h3', 'h4', 'h5', 'h6'].map((selector) => ({\n selector,\n options: { uppercase: false },\n })),\n { selector: 'ul', options: { itemPrefix: ' ' } },\n { selector: 'table', format: 'dataTable', options: { uppercaseHeaderCells: false } },\n ],\n })\n .replace(/\\s+/g, ' ')\n .trim();\n}\n\n/** Resolves a relative href against `baseUrl`; absolute URLs are returned as is. */\nexport function resolveMetadataUrl(href: string | undefined, baseUrl: string): string | undefined {\n if (!href) {\n return undefined;\n }\n return /^https?:\\/\\//.test(href) ? href : `${baseUrl}${href}`;\n}\n\nfunction getSearchParam(\n searchParams: PageMetadataSearchParams | undefined,\n key: string\n): string | undefined {\n if (!searchParams) {\n return undefined;\n }\n if (searchParams instanceof URLSearchParams) {\n return searchParams.get(key) ?? undefined;\n }\n const value = searchParams[key];\n return Array.isArray(value) ? value[0] : value;\n}\n\n/** Returns `?pagination[page]=N` for pages after the first, otherwise an empty string. */\nexport function getPaginationQuery(searchParams?: PageMetadataSearchParams): string {\n const value = getSearchParam(searchParams, 'pagination[page]');\n const page = value ? parseInt(value) : NaN;\n return Number.isInteger(page) && page > 1 ? `?pagination[page]=${page}` : '';\n}\n\n/**\n * Builds hreflang alternates from the page's routes. Markets with countries\n * produce one `locale-COUNTRY` entry per country; others use the locale only.\n */\nexport function getPageAlternates(\n page: Pick<IPage, 'alternates'>,\n layout: Pick<ILayout, 'markets'>,\n baseUrl: string\n): IAlternate[] {\n const alternates: IAlternate[] = [];\n (page.alternates || []).forEach((alternate: IRoute) => {\n const market = layout.markets.find((x) => x.id === alternate.market);\n if (!market) {\n return;\n }\n const href = resolveMetadataUrl(alternate.id, baseUrl) as string;\n const countries = (market.countries || []) as Array<\n string | { alpha2Code?: string; id?: string }\n >;\n if (countries.length > 0) {\n countries.forEach((country) => {\n const code = typeof country === 'string' ? country : country.alpha2Code || country.id;\n if (code) {\n alternates.push({\n id: `${alternate.market}-${alternate.locale}-${code}`,\n href,\n hrefLang: `${alternate.locale}-${code.toUpperCase()}`,\n });\n }\n });\n } else {\n alternates.push({\n id: `${alternate.market}-${alternate.locale}`,\n href,\n hrefLang: alternate.locale,\n });\n }\n });\n return alternates;\n}\n\n/** The alternate for the default market and locale, used as `x-default`. */\nexport function getPageXDefault(\n page: Pick<IPage, 'alternates'>,\n layout: Pick<ILayout, 'markets' | 'locales'>,\n baseUrl: string\n): IAlternate | undefined {\n const market = layout.markets.find((x) => x.isDefault)?.id || defaultMarket;\n const locale = layout.locales.find((x) => x.isDefault)?.id || defaultLocale;\n const alternate = (page.alternates || []).find((x) => x.market === market && x.locale === locale);\n if (!alternate) {\n return undefined;\n }\n return {\n id: `${alternate.market}-${alternate.locale}`,\n href: resolveMetadataUrl(alternate.id, baseUrl) as string,\n hrefLang: alternate.locale,\n };\n}\n\nfunction getMediaUrl(media: unknown): string | undefined {\n if (media && typeof media === 'object') {\n const { src, url } = media as { src?: string; url?: string };\n return src || url;\n }\n return undefined;\n}\n\n/**\n * Builds the Next.js `Metadata` for a page: plain-text title and description,\n * canonical (keeping pagination), hreflang alternates with `x-default`,\n * robots, keywords, Open Graph and Twitter card.\n */\nexport function buildPageMetadata(\n page: IPage,\n layout?: ILayout,\n options: PageMetadataOptions = {}\n): Metadata {\n const baseUrl = (options.baseUrl ?? getPublicUrl()).replace(/\\/$/, '');\n const meta = ((page as { meta?: PageMetaFields }).meta || {}) as PageMetaFields;\n const title = toPlainText(meta.title || page.title);\n const description =\n toPlainText(meta.description || (page as { abstract?: string }).abstract) || undefined;\n const image = resolveMetadataUrl(\n getMediaUrl(meta.image) ||\n getMediaUrl((page as { media?: unknown }).media) ||\n options.brand?.logo,\n baseUrl\n );\n const canonicalBase = resolveMetadataUrl(page.href, baseUrl);\n const canonical = canonicalBase\n ? `${canonicalBase}${getPaginationQuery(options.searchParams)}`\n : undefined;\n const robots = getMetaRobots(meta);\n\n const languages: Record<string, string> = {};\n if (layout) {\n getPageAlternates(page, layout, baseUrl).forEach((alternate) => {\n languages[alternate.hrefLang] = alternate.href;\n });\n const xDefault = getPageXDefault(page, layout, baseUrl);\n if (xDefault) {\n languages['x-default'] = xDefault.href;\n }\n }\n\n const images = image ? [{ url: image, alt: title }] : undefined;\n const metadata: Metadata = {\n title,\n description,\n ...(meta.keywords ? { keywords: meta.keywords } : {}),\n ...(robots ? { robots } : {}),\n alternates: {\n canonical,\n ...(Object.keys(languages).length > 0 ? { languages } : {}),\n },\n openGraph: {\n type: 'website',\n title,\n description,\n url: canonical,\n siteName: options.brand?.name,\n locale: layout?.locale ?? page.locale,\n images,\n },\n twitter: {\n card: image ? 'summary_large_image' : 'summary',\n title,\n description,\n images: image ? [image] : undefined,\n ...(options.brand?.twitterName\n ? { site: options.brand.twitterName, creator: options.brand.twitterName }\n : {}),\n },\n };\n return options.extend ? options.extend(metadata, { page, layout }) : metadata;\n}\n\n/**\n * Next.js replaces nested `openGraph` and `twitter` objects instead of merging\n * them, so a page that sets them would drop the layout's images, site name or\n * handles. Fills the fields the page left empty from the parent metadata.\n */\nexport function inheritParentMetadata(metadata: Metadata, parent?: ResolvedMetadata): Metadata {\n if (!parent) {\n return metadata;\n }\n const openGraph = metadata.openGraph;\n const twitter = metadata.twitter;\n return {\n ...metadata,\n ...(openGraph\n ? {\n openGraph: {\n ...openGraph,\n images: openGraph.images ?? parent.openGraph?.images,\n siteName: openGraph.siteName ?? parent.openGraph?.siteName,\n },\n }\n : {}),\n ...(twitter\n ? {\n twitter: {\n ...twitter,\n // without a page image, the card type follows the inherited images\n ...(!twitter.images && parent.twitter?.images ? { card: parent.twitter.card } : {}),\n images: twitter.images ?? parent.twitter?.images,\n site: twitter.site ?? parent.twitter?.site,\n creator: twitter.creator ?? parent.twitter?.creator,\n } as Metadata['twitter'],\n }\n : {}),\n };\n}\n"],"mappings":";;;;;AAoDA,SAAgB,YAAY,MAA8B;AACxD,KAAI,CAAC,KACH,QAAO;AAET,QAAO,QAAQ,MAAM;EACnB,UAAU;EACV,WAAW;GACT;IAAE,UAAU;IAAK,SAAS,EAAE,YAAY,MAAM;IAAE;GAChD;IAAE,UAAU;IAAO,QAAQ;IAAQ;GAEnC,GAAG;IAAC;IAAM;IAAM;IAAM;IAAM;IAAM;IAAK,CAAC,KAAK,cAAc;IACzD;IACA,SAAS,EAAE,WAAW,OAAO;IAC9B,EAAE;GACH;IAAE,UAAU;IAAM,SAAS,EAAE,YAAY,KAAK;IAAE;GAChD;IAAE,UAAU;IAAS,QAAQ;IAAa,SAAS,EAAE,sBAAsB,OAAO;IAAE;GACrF;EACF,CAAC,CACC,QAAQ,QAAQ,IAAI,CACpB,MAAM;;;AAIX,SAAgB,mBAAmB,MAA0B,SAAqC;AAChG,KAAI,CAAC,KACH;AAEF,QAAO,eAAe,KAAK,KAAK,GAAG,OAAO,GAAG,UAAU;;AAGzD,SAAS,eACP,cACA,KACoB;AACpB,KAAI,CAAC,aACH;AAEF,KAAI,wBAAwB,gBAC1B,QAAO,aAAa,IAAI,IAAI,IAAI,KAAA;CAElC,MAAM,QAAQ,aAAa;AAC3B,QAAO,MAAM,QAAQ,MAAM,GAAG,MAAM,KAAK;;;AAI3C,SAAgB,mBAAmB,cAAiD;CAClF,MAAM,QAAQ,eAAe,cAAc,mBAAmB;CAC9D,MAAM,OAAO,QAAQ,SAAS,MAAM,GAAG;AACvC,QAAO,OAAO,UAAU,KAAK,IAAI,OAAO,IAAI,qBAAqB,SAAS;;;;;;AAO5E,SAAgB,kBACd,MACA,QACA,SACc;CACd,MAAM,aAA2B,EAAE;AACnC,EAAC,KAAK,cAAc,EAAE,EAAE,SAAS,cAAsB;EACrD,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,OAAO,UAAU,OAAO;AACpE,MAAI,CAAC,OACH;EAEF,MAAM,OAAO,mBAAmB,UAAU,IAAI,QAAQ;EACtD,MAAM,YAAa,OAAO,aAAa,EAAE;AAGzC,MAAI,UAAU,SAAS,EACrB,WAAU,SAAS,YAAY;GAC7B,MAAM,OAAO,OAAO,YAAY,WAAW,UAAU,QAAQ,cAAc,QAAQ;AACnF,OAAI,KACF,YAAW,KAAK;IACd,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU,OAAO,GAAG;IAC/C;IACA,UAAU,GAAG,UAAU,OAAO,GAAG,KAAK,aAAa;IACpD,CAAC;IAEJ;MAEF,YAAW,KAAK;GACd,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU;GACrC;GACA,UAAU,UAAU;GACrB,CAAC;GAEJ;AACF,QAAO;;;AAIT,SAAgB,gBACd,MACA,QACA,SACwB;CACxB,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,UAAU,EAAE,MAAM;CAC9D,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,UAAU,EAAE,MAAM;CAC9D,MAAM,aAAa,KAAK,cAAc,EAAE,EAAE,MAAM,MAAM,EAAE,WAAW,UAAU,EAAE,WAAW,OAAO;AACjG,KAAI,CAAC,UACH;AAEF,QAAO;EACL,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU;EACrC,MAAM,mBAAmB,UAAU,IAAI,QAAQ;EAC/C,UAAU,UAAU;EACrB;;AAGH,SAAS,YAAY,OAAoC;AACvD,KAAI,SAAS,OAAO,UAAU,UAAU;EACtC,MAAM,EAAE,KAAK,QAAQ;AACrB,SAAO,OAAO;;;;;;;;AAUlB,SAAgB,kBACd,MACA,QACA,UAA+B,EAAE,EACvB;CACV,MAAM,WAAW,QAAQ,WAAW,cAAc,EAAE,QAAQ,OAAO,GAAG;CACtE,MAAM,OAAS,KAAmC,QAAQ,EAAE;CAC5D,MAAM,QAAQ,YAAY,KAAK,SAAS,KAAK,MAAM;CACnD,MAAM,cACJ,YAAY,KAAK,eAAgB,KAA+B,SAAS,IAAI,KAAA;CAC/E,MAAM,QAAQ,mBACZ,YAAY,KAAK,MAAM,IACrB,YAAa,KAA6B,MAAM,IAChD,QAAQ,OAAO,MACjB,QACD;CACD,MAAM,gBAAgB,mBAAmB,KAAK,MAAM,QAAQ;CAC5D,MAAM,YAAY,gBACd,GAAG,gBAAgB,mBAAmB,QAAQ,aAAa,KAC3D,KAAA;CACJ,MAAM,SAAS,cAAc,KAAK;CAElC,MAAM,YAAoC,EAAE;AAC5C,KAAI,QAAQ;AACV,oBAAkB,MAAM,QAAQ,QAAQ,CAAC,SAAS,cAAc;AAC9D,aAAU,UAAU,YAAY,UAAU;IAC1C;EACF,MAAM,WAAW,gBAAgB,MAAM,QAAQ,QAAQ;AACvD,MAAI,SACF,WAAU,eAAe,SAAS;;CAItC,MAAM,SAAS,QAAQ,CAAC;EAAE,KAAK;EAAO,KAAK;EAAO,CAAC,GAAG,KAAA;CACtD,MAAM,WAAqB;EACzB;EACA;EACA,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,UAAU,GAAG,EAAE;EACpD,GAAI,SAAS,EAAE,QAAQ,GAAG,EAAE;EAC5B,YAAY;GACV;GACA,GAAI,OAAO,KAAK,UAAU,CAAC,SAAS,IAAI,EAAE,WAAW,GAAG,EAAE;GAC3D;EACD,WAAW;GACT,MAAM;GACN;GACA;GACA,KAAK;GACL,UAAU,QAAQ,OAAO;GACzB,QAAQ,QAAQ,UAAU,KAAK;GAC/B;GACD;EACD,SAAS;GACP,MAAM,QAAQ,wBAAwB;GACtC;GACA;GACA,QAAQ,QAAQ,CAAC,MAAM,GAAG,KAAA;GAC1B,GAAI,QAAQ,OAAO,cACf;IAAE,MAAM,QAAQ,MAAM;IAAa,SAAS,QAAQ,MAAM;IAAa,GACvE,EAAE;GACP;EACF;AACD,QAAO,QAAQ,SAAS,QAAQ,OAAO,UAAU;EAAE;EAAM;EAAQ,CAAC,GAAG;;;;;;;AAQvE,SAAgB,sBAAsB,UAAoB,QAAqC;AAC7F,KAAI,CAAC,OACH,QAAO;CAET,MAAM,YAAY,SAAS;CAC3B,MAAM,UAAU,SAAS;AACzB,QAAO;EACL,GAAG;EACH,GAAI,YACA,EACE,WAAW;GACT,GAAG;GACH,QAAQ,UAAU,UAAU,OAAO,WAAW;GAC9C,UAAU,UAAU,YAAY,OAAO,WAAW;GACnD,EACF,GACD,EAAE;EACN,GAAI,UACA,EACE,SAAS;GACP,GAAG;GAEH,GAAI,CAAC,QAAQ,UAAU,OAAO,SAAS,SAAS,EAAE,MAAM,OAAO,QAAQ,MAAM,GAAG,EAAE;GAClF,QAAQ,QAAQ,UAAU,OAAO,SAAS;GAC1C,MAAM,QAAQ,QAAQ,OAAO,SAAS;GACtC,SAAS,QAAQ,WAAW,OAAO,SAAS;GAC7C,EACF,GACD,EAAE;EACP"}
1
+ {"version":3,"file":"page-metadata.js","names":[],"sources":["../../src/lib/page-metadata.ts"],"sourcesContent":["import {\n defaultLocale,\n defaultMarket,\n getIsProduction,\n getMetaRobots,\n ILayout,\n IMedia,\n IPage,\n IRoute,\n} from '@websolutespa/bom-core';\nimport { convert } from 'html-to-text';\nimport type { Metadata, ResolvedMetadata } from 'next';\nimport type { IAlternate } from './meta-data';\nimport { getPublicUrl } from './utils';\n\nexport type PageMetadataBrand = {\n /** Site name, used for Open Graph `siteName`. */\n name: string;\n /** Fallback image when the page has no meta image or media. */\n logo?: string;\n /** Twitter handle, used for `twitter:site` and `twitter:creator`. */\n twitterName?: string;\n};\n\nexport type PageMetadataSearchParams =\n | URLSearchParams\n | Record<string, string | string[] | undefined>;\n\nexport type PageMetadataContext = {\n page: IPage;\n layout?: ILayout;\n};\n\nexport type PageMetadataOptions = {\n brand?: PageMetadataBrand;\n /** Absolute origin for canonical, alternates and images. Default `NEXT_PUBLIC_URL`. */\n baseUrl?: string;\n /** Request search params; `pagination[page]` > 1 is kept in the canonical URL. */\n searchParams?: PageMetadataSearchParams;\n /**\n * Whether search engines may index the page. When false (or a function returning false), `robots` is\n * `noindex, nofollow`, over the page's own `meta.robots`. Default: {@link isIndexableDeployment}, so staging\n * and preview deployments are never indexed.\n */\n indexable?: boolean | ((page: IPage) => boolean);\n /** Per-page override applied to the computed metadata. */\n extend?: (metadata: Metadata, context: PageMetadataContext) => Metadata;\n};\n\n/**\n * The deployment policy: pages are indexable only in production (`PRODUCTION=true`, as the BOM 3 `Meta` component\n * required) and unless `NOINDEX=true`. Every other deployment (staging, previews, local) is `noindex`.\n */\nexport function isIndexableDeployment(env: NodeJS.ProcessEnv = process.env): boolean {\n return getIsProduction() && env.NOINDEX !== 'true';\n}\n\ntype PageMetaFields = {\n title?: string;\n description?: string;\n keywords?: string;\n robots?: string;\n robot?: string;\n image?: IMedia | string | null;\n};\n\n/** Converts CMS HTML (titles, abstracts) to a single line of plain text. */\nexport function toPlainText(html?: string | null): string {\n if (!html) {\n return '';\n }\n return convert(html, {\n wordwrap: false,\n selectors: [\n { selector: 'a', options: { ignoreHref: true } },\n { selector: 'img', format: 'skip' },\n // keep the original case and drop list bullets: this text ends up in meta tags\n ...['h1', 'h2', 'h3', 'h4', 'h5', 'h6'].map((selector) => ({\n selector,\n options: { uppercase: false },\n })),\n { selector: 'ul', options: { itemPrefix: ' ' } },\n { selector: 'table', format: 'dataTable', options: { uppercaseHeaderCells: false } },\n ],\n })\n .replace(/\\s+/g, ' ')\n .trim();\n}\n\n/** Resolves a relative href against `baseUrl`; absolute URLs are returned as is. */\nexport function resolveMetadataUrl(href: string | undefined, baseUrl: string): string | undefined {\n if (!href) {\n return undefined;\n }\n return /^https?:\\/\\//.test(href) ? href : `${baseUrl}${href}`;\n}\n\nfunction getSearchParam(\n searchParams: PageMetadataSearchParams | undefined,\n key: string\n): string | undefined {\n if (!searchParams) {\n return undefined;\n }\n if (searchParams instanceof URLSearchParams) {\n return searchParams.get(key) ?? undefined;\n }\n const value = searchParams[key];\n return Array.isArray(value) ? value[0] : value;\n}\n\n/** Returns `?pagination[page]=N` for pages after the first, otherwise an empty string. */\nexport function getPaginationQuery(searchParams?: PageMetadataSearchParams): string {\n const value = getSearchParam(searchParams, 'pagination[page]');\n const page = value ? parseInt(value) : NaN;\n return Number.isInteger(page) && page > 1 ? `?pagination[page]=${page}` : '';\n}\n\n/**\n * Builds hreflang alternates from the page's routes. Markets with countries\n * produce one `locale-COUNTRY` entry per country; others use the locale only.\n */\nexport function getPageAlternates(\n page: Pick<IPage, 'alternates'>,\n layout: Pick<ILayout, 'markets'>,\n baseUrl: string\n): IAlternate[] {\n const alternates: IAlternate[] = [];\n (page.alternates || []).forEach((alternate: IRoute) => {\n const market = layout.markets.find((x) => x.id === alternate.market);\n if (!market) {\n return;\n }\n const href = resolveMetadataUrl(alternate.id, baseUrl) as string;\n const countries = (market.countries || []) as Array<\n string | { alpha2Code?: string; id?: string }\n >;\n if (countries.length > 0) {\n countries.forEach((country) => {\n const code = typeof country === 'string' ? country : country.alpha2Code || country.id;\n if (code) {\n alternates.push({\n id: `${alternate.market}-${alternate.locale}-${code}`,\n href,\n hrefLang: `${alternate.locale}-${code.toUpperCase()}`,\n });\n }\n });\n } else {\n alternates.push({\n id: `${alternate.market}-${alternate.locale}`,\n href,\n hrefLang: alternate.locale,\n });\n }\n });\n return alternates;\n}\n\n/** The alternate for the default market and locale, used as `x-default`. */\nexport function getPageXDefault(\n page: Pick<IPage, 'alternates'>,\n layout: Pick<ILayout, 'markets' | 'locales'>,\n baseUrl: string\n): IAlternate | undefined {\n const market = layout.markets.find((x) => x.isDefault)?.id || defaultMarket;\n const locale = layout.locales.find((x) => x.isDefault)?.id || defaultLocale;\n const alternate = (page.alternates || []).find((x) => x.market === market && x.locale === locale);\n if (!alternate) {\n return undefined;\n }\n return {\n id: `${alternate.market}-${alternate.locale}`,\n href: resolveMetadataUrl(alternate.id, baseUrl) as string,\n hrefLang: alternate.locale,\n };\n}\n\nfunction getMediaUrl(media: unknown): string | undefined {\n if (media && typeof media === 'object') {\n const { src, url } = media as { src?: string; url?: string };\n return src || url;\n }\n return undefined;\n}\n\n/**\n * Builds the Next.js `Metadata` for a page: plain-text title and description,\n * canonical (keeping pagination), hreflang alternates with `x-default`,\n * robots, keywords, Open Graph and Twitter card.\n */\nexport function buildPageMetadata(\n page: IPage,\n layout?: ILayout,\n options: PageMetadataOptions = {}\n): Metadata {\n const baseUrl = (options.baseUrl ?? getPublicUrl()).replace(/\\/$/, '');\n const meta = ((page as { meta?: PageMetaFields }).meta || {}) as PageMetaFields;\n const title = toPlainText(meta.title || page.title);\n const description =\n toPlainText(meta.description || (page as { abstract?: string }).abstract) || undefined;\n const image = resolveMetadataUrl(\n getMediaUrl(meta.image) ||\n getMediaUrl((page as { media?: unknown }).media) ||\n options.brand?.logo,\n baseUrl\n );\n const canonicalBase = resolveMetadataUrl(page.href, baseUrl);\n const canonical = canonicalBase\n ? `${canonicalBase}${getPaginationQuery(options.searchParams)}`\n : undefined;\n const indexable =\n typeof options.indexable === 'function'\n ? options.indexable(page)\n : (options.indexable ?? isIndexableDeployment());\n const robots = indexable ? getMetaRobots(meta) : 'noindex, nofollow';\n\n const languages: Record<string, string> = {};\n if (layout) {\n getPageAlternates(page, layout, baseUrl).forEach((alternate) => {\n languages[alternate.hrefLang] = alternate.href;\n });\n const xDefault = getPageXDefault(page, layout, baseUrl);\n if (xDefault) {\n languages['x-default'] = xDefault.href;\n }\n }\n\n const images = image ? [{ url: image, alt: title }] : undefined;\n const metadata: Metadata = {\n title,\n description,\n ...(meta.keywords ? { keywords: meta.keywords } : {}),\n ...(robots ? { robots } : {}),\n alternates: {\n canonical,\n ...(Object.keys(languages).length > 0 ? { languages } : {}),\n },\n openGraph: {\n type: 'website',\n title,\n description,\n url: canonical,\n siteName: options.brand?.name,\n locale: layout?.locale ?? page.locale,\n images,\n },\n twitter: {\n card: image ? 'summary_large_image' : 'summary',\n title,\n description,\n images: image ? [image] : undefined,\n ...(options.brand?.twitterName\n ? { site: options.brand.twitterName, creator: options.brand.twitterName }\n : {}),\n },\n };\n return options.extend ? options.extend(metadata, { page, layout }) : metadata;\n}\n\n/**\n * Next.js replaces nested `openGraph` and `twitter` objects instead of merging\n * them, so a page that sets them would drop the layout's images, site name or\n * handles. Fills the fields the page left empty from the parent metadata.\n */\nexport function inheritParentMetadata(metadata: Metadata, parent?: ResolvedMetadata): Metadata {\n if (!parent) {\n return metadata;\n }\n const openGraph = metadata.openGraph;\n const twitter = metadata.twitter;\n return {\n ...metadata,\n ...(openGraph\n ? {\n openGraph: {\n ...openGraph,\n images: openGraph.images ?? parent.openGraph?.images,\n siteName: openGraph.siteName ?? parent.openGraph?.siteName,\n },\n }\n : {}),\n ...(twitter\n ? {\n twitter: {\n ...twitter,\n // without a page image, the card type follows the inherited images\n ...(!twitter.images && parent.twitter?.images ? { card: parent.twitter.card } : {}),\n images: twitter.images ?? parent.twitter?.images,\n site: twitter.site ?? parent.twitter?.site,\n creator: twitter.creator ?? parent.twitter?.creator,\n } as Metadata['twitter'],\n }\n : {}),\n };\n}\n"],"mappings":";;;;;;;;AAqDA,SAAgB,sBAAsB,MAAyB,QAAQ,KAAc;AACnF,QAAO,iBAAiB,IAAI,IAAI,YAAY;;;AAa9C,SAAgB,YAAY,MAA8B;AACxD,KAAI,CAAC,KACH,QAAO;AAET,QAAO,QAAQ,MAAM;EACnB,UAAU;EACV,WAAW;GACT;IAAE,UAAU;IAAK,SAAS,EAAE,YAAY,MAAM;IAAE;GAChD;IAAE,UAAU;IAAO,QAAQ;IAAQ;GAEnC,GAAG;IAAC;IAAM;IAAM;IAAM;IAAM;IAAM;IAAK,CAAC,KAAK,cAAc;IACzD;IACA,SAAS,EAAE,WAAW,OAAO;IAC9B,EAAE;GACH;IAAE,UAAU;IAAM,SAAS,EAAE,YAAY,KAAK;IAAE;GAChD;IAAE,UAAU;IAAS,QAAQ;IAAa,SAAS,EAAE,sBAAsB,OAAO;IAAE;GACrF;EACF,CAAC,CACC,QAAQ,QAAQ,IAAI,CACpB,MAAM;;;AAIX,SAAgB,mBAAmB,MAA0B,SAAqC;AAChG,KAAI,CAAC,KACH;AAEF,QAAO,eAAe,KAAK,KAAK,GAAG,OAAO,GAAG,UAAU;;AAGzD,SAAS,eACP,cACA,KACoB;AACpB,KAAI,CAAC,aACH;AAEF,KAAI,wBAAwB,gBAC1B,QAAO,aAAa,IAAI,IAAI,IAAI,KAAA;CAElC,MAAM,QAAQ,aAAa;AAC3B,QAAO,MAAM,QAAQ,MAAM,GAAG,MAAM,KAAK;;;AAI3C,SAAgB,mBAAmB,cAAiD;CAClF,MAAM,QAAQ,eAAe,cAAc,mBAAmB;CAC9D,MAAM,OAAO,QAAQ,SAAS,MAAM,GAAG;AACvC,QAAO,OAAO,UAAU,KAAK,IAAI,OAAO,IAAI,qBAAqB,SAAS;;;;;;AAO5E,SAAgB,kBACd,MACA,QACA,SACc;CACd,MAAM,aAA2B,EAAE;AACnC,EAAC,KAAK,cAAc,EAAE,EAAE,SAAS,cAAsB;EACrD,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,OAAO,UAAU,OAAO;AACpE,MAAI,CAAC,OACH;EAEF,MAAM,OAAO,mBAAmB,UAAU,IAAI,QAAQ;EACtD,MAAM,YAAa,OAAO,aAAa,EAAE;AAGzC,MAAI,UAAU,SAAS,EACrB,WAAU,SAAS,YAAY;GAC7B,MAAM,OAAO,OAAO,YAAY,WAAW,UAAU,QAAQ,cAAc,QAAQ;AACnF,OAAI,KACF,YAAW,KAAK;IACd,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU,OAAO,GAAG;IAC/C;IACA,UAAU,GAAG,UAAU,OAAO,GAAG,KAAK,aAAa;IACpD,CAAC;IAEJ;MAEF,YAAW,KAAK;GACd,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU;GACrC;GACA,UAAU,UAAU;GACrB,CAAC;GAEJ;AACF,QAAO;;;AAIT,SAAgB,gBACd,MACA,QACA,SACwB;CACxB,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,UAAU,EAAE,MAAM;CAC9D,MAAM,SAAS,OAAO,QAAQ,MAAM,MAAM,EAAE,UAAU,EAAE,MAAM;CAC9D,MAAM,aAAa,KAAK,cAAc,EAAE,EAAE,MAAM,MAAM,EAAE,WAAW,UAAU,EAAE,WAAW,OAAO;AACjG,KAAI,CAAC,UACH;AAEF,QAAO;EACL,IAAI,GAAG,UAAU,OAAO,GAAG,UAAU;EACrC,MAAM,mBAAmB,UAAU,IAAI,QAAQ;EAC/C,UAAU,UAAU;EACrB;;AAGH,SAAS,YAAY,OAAoC;AACvD,KAAI,SAAS,OAAO,UAAU,UAAU;EACtC,MAAM,EAAE,KAAK,QAAQ;AACrB,SAAO,OAAO;;;;;;;;AAUlB,SAAgB,kBACd,MACA,QACA,UAA+B,EAAE,EACvB;CACV,MAAM,WAAW,QAAQ,WAAW,cAAc,EAAE,QAAQ,OAAO,GAAG;CACtE,MAAM,OAAS,KAAmC,QAAQ,EAAE;CAC5D,MAAM,QAAQ,YAAY,KAAK,SAAS,KAAK,MAAM;CACnD,MAAM,cACJ,YAAY,KAAK,eAAgB,KAA+B,SAAS,IAAI,KAAA;CAC/E,MAAM,QAAQ,mBACZ,YAAY,KAAK,MAAM,IACrB,YAAa,KAA6B,MAAM,IAChD,QAAQ,OAAO,MACjB,QACD;CACD,MAAM,gBAAgB,mBAAmB,KAAK,MAAM,QAAQ;CAC5D,MAAM,YAAY,gBACd,GAAG,gBAAgB,mBAAmB,QAAQ,aAAa,KAC3D,KAAA;CAKJ,MAAM,UAHJ,OAAO,QAAQ,cAAc,aACzB,QAAQ,UAAU,KAAK,GACtB,QAAQ,aAAa,uBAAuB,IACxB,cAAc,KAAK,GAAG;CAEjD,MAAM,YAAoC,EAAE;AAC5C,KAAI,QAAQ;AACV,oBAAkB,MAAM,QAAQ,QAAQ,CAAC,SAAS,cAAc;AAC9D,aAAU,UAAU,YAAY,UAAU;IAC1C;EACF,MAAM,WAAW,gBAAgB,MAAM,QAAQ,QAAQ;AACvD,MAAI,SACF,WAAU,eAAe,SAAS;;CAItC,MAAM,SAAS,QAAQ,CAAC;EAAE,KAAK;EAAO,KAAK;EAAO,CAAC,GAAG,KAAA;CACtD,MAAM,WAAqB;EACzB;EACA;EACA,GAAI,KAAK,WAAW,EAAE,UAAU,KAAK,UAAU,GAAG,EAAE;EACpD,GAAI,SAAS,EAAE,QAAQ,GAAG,EAAE;EAC5B,YAAY;GACV;GACA,GAAI,OAAO,KAAK,UAAU,CAAC,SAAS,IAAI,EAAE,WAAW,GAAG,EAAE;GAC3D;EACD,WAAW;GACT,MAAM;GACN;GACA;GACA,KAAK;GACL,UAAU,QAAQ,OAAO;GACzB,QAAQ,QAAQ,UAAU,KAAK;GAC/B;GACD;EACD,SAAS;GACP,MAAM,QAAQ,wBAAwB;GACtC;GACA;GACA,QAAQ,QAAQ,CAAC,MAAM,GAAG,KAAA;GAC1B,GAAI,QAAQ,OAAO,cACf;IAAE,MAAM,QAAQ,MAAM;IAAa,SAAS,QAAQ,MAAM;IAAa,GACvE,EAAE;GACP;EACF;AACD,QAAO,QAAQ,SAAS,QAAQ,OAAO,UAAU;EAAE;EAAM;EAAQ,CAAC,GAAG;;;;;;;AAQvE,SAAgB,sBAAsB,UAAoB,QAAqC;AAC7F,KAAI,CAAC,OACH,QAAO;CAET,MAAM,YAAY,SAAS;CAC3B,MAAM,UAAU,SAAS;AACzB,QAAO;EACL,GAAG;EACH,GAAI,YACA,EACE,WAAW;GACT,GAAG;GACH,QAAQ,UAAU,UAAU,OAAO,WAAW;GAC9C,UAAU,UAAU,YAAY,OAAO,WAAW;GACnD,EACF,GACD,EAAE;EACN,GAAI,UACA,EACE,SAAS;GACP,GAAG;GAEH,GAAI,CAAC,QAAQ,UAAU,OAAO,SAAS,SAAS,EAAE,MAAM,OAAO,QAAQ,MAAM,GAAG,EAAE;GAClF,QAAQ,QAAQ,UAAU,OAAO,SAAS;GAC1C,MAAM,QAAQ,QAAQ,OAAO,SAAS;GACtC,SAAS,QAAQ,WAAW,OAAO,SAAS;GAC7C,EACF,GACD,EAAE;EACP"}
@@ -1,4 +1,4 @@
1
- import { getRedisClient, keys, redisPrefix } from "../../../cache-handler/redis.js";
1
+ import { connectRedisClient, keys, redisPrefix } from "../../../cache-handler/redis.js";
2
2
  import { tagState } from "../../../cache-handlers/default.js";
3
3
  import { parseRouteCacheKey } from "./route-cache-key.js";
4
4
  import { functionName } from "./types.js";
@@ -10,7 +10,7 @@ const maxEntries = 2e4;
10
10
  * are never loaded. The state is exact: the tag timestamps the handler writes are compared with each entry.
11
11
  * Entries written by an older handler without meta keys are not listed.
12
12
  */
13
- function createRedisInspector({ getClient = getRedisClient, prefix = redisPrefix() } = {}) {
13
+ function createRedisInspector({ getClient = connectRedisClient, prefix = redisPrefix() } = {}) {
14
14
  const k = keys(prefix);
15
15
  async function scan() {
16
16
  const client = await getClient();
@@ -1 +1 @@
1
- {"version":3,"file":"redis.js","names":[],"sources":["../../../../src/server/cache/inspector/redis.ts"],"sourcesContent":["import { getRedisClient, keys, redisPrefix, type RedisLike } from '../../../cache-handler/redis';\nimport { tagState, type UseCacheMeta } from '../../../cache-handlers/default';\nimport { explicitTags } from './filesystem';\nimport { parseRouteCacheKey } from './route-cache-key';\nimport { type CachedFunction, type CachedPage, type CacheInspector, functionName } from './types';\n\n/** The redis client subset the inspector needs on top of the handler's. */\nexport type RedisScanner = Pick<RedisLike, 'isReady' | 'mGet'> & {\n scanIterator(options: { MATCH: string; COUNT?: number }): AsyncIterable<string | string[]>;\n};\n\ntype Meta = {\n lastModified: number;\n tags: string[];\n revalidate: number | false | null;\n kind: string | null;\n status: number | null;\n size: number;\n};\n\nconst maxEntries = 20_000;\n\n/**\n * Reads the shared Redis cache of `@websolutespa/bom-next/cache-handlers/isr` through its meta keys, so page bodies\n * are never loaded. The state is exact: the tag timestamps the handler writes are compared with each entry.\n * Entries written by an older handler without meta keys are not listed.\n */\nexport function createRedisInspector({\n getClient = getRedisClient as () => Promise<RedisScanner | undefined>,\n prefix = redisPrefix(),\n}: { getClient?: () => Promise<RedisScanner | undefined>; prefix?: string } = {}): CacheInspector {\n const k = keys(prefix);\n\n async function scan(): Promise<{ key: string; meta: Meta; expired: boolean; stale: boolean }[]> {\n const client = await getClient();\n if (!client?.isReady) {\n throw new Error('Redis is not reachable.');\n }\n const metaKeys: string[] = [];\n for await (const batch of client.scanIterator({ MATCH: `${k.meta}*`, COUNT: 500 })) {\n metaKeys.push(...(Array.isArray(batch) ? batch : [batch]));\n if (metaKeys.length >= maxEntries) break;\n }\n if (!metaKeys.length) {\n return [];\n }\n const raw = await client.mGet(metaKeys);\n const entries = metaKeys\n .map((metaKey, index) => {\n try {\n return { key: metaKey.slice(k.meta.length), meta: JSON.parse(raw[index] ?? '') as Meta };\n } catch {\n return undefined;\n }\n })\n .filter((entry): entry is { key: string; meta: Meta } => Boolean(entry));\n const tags = [...new Set(entries.flatMap((entry) => entry.meta.tags))];\n const [expired, stale] = tags.length\n ? await Promise.all([\n client.mGet(tags.map((tag) => k.expired + tag)),\n client.mGet(tags.map((tag) => k.stale + tag)),\n ])\n : [[], []];\n const expiredAt = new Map(tags.map((tag, index) => [tag, Number(expired[index] ?? 0)]));\n const staleAt = new Map(tags.map((tag, index) => [tag, Number(stale[index] ?? 0)]));\n const now = Date.now();\n return entries.map(({ key, meta }) => ({\n key,\n meta,\n expired: meta.tags.some((tag) => {\n const at = expiredAt.get(tag) ?? 0;\n return at > meta.lastModified && at <= now;\n }),\n stale: meta.tags.some((tag) => (staleAt.get(tag) ?? 0) > meta.lastModified),\n }));\n }\n\n let pending: ReturnType<typeof scan> | undefined;\n // pages() and functions() are read together: one scan serves both\n function scanOnce() {\n pending ??= scan().finally(() => {\n setTimeout(() => {\n pending = undefined;\n }, 0);\n });\n return pending;\n }\n\n return {\n backend: 'redis',\n async pages() {\n const pages: CachedPage[] = [];\n for (const { key, meta, expired, stale } of await scanOnce()) {\n if (meta.kind !== 'APP_PAGE' && meta.kind !== 'APP_ROUTE') continue;\n const parsed = parseRouteCacheKey(key);\n if (!parsed || parsed.internalPath.startsWith('/_') || parsed.internalPath === '/index')\n continue;\n pages.push({\n internalPath: parsed.internalPath,\n tags: explicitTags(meta.tags.join(',')),\n generatedAt: meta.lastModified,\n sizeBytes: meta.size,\n revalidateSeconds: typeof meta.revalidate === 'number' ? meta.revalidate : null,\n status: meta.status,\n expired,\n stale: !expired && stale,\n sourceHash: parsed.sourceHash,\n });\n }\n return pages;\n },\n async functions() {\n const functions: CachedFunction[] = [];\n for (const { key, meta, expired, stale } of await scanOnce()) {\n const name = meta.kind === 'FETCH' ? functionName(meta.tags) : undefined;\n if (!name) continue;\n functions.push({\n key,\n name,\n tags: meta.tags,\n generatedAt: meta.lastModified,\n sizeBytes: meta.size,\n revalidateSeconds: typeof meta.revalidate === 'number' ? meta.revalidate : null,\n expired,\n stale: !expired && stale,\n });\n }\n // `'use cache'` results (Cache Components, Redis handler): same tag keys, their own meta prefix\n const client = await getClient();\n if (client?.isReady) {\n const useCacheMeta = `${prefix}use-cache-meta:`;\n const metaKeys: string[] = [];\n for await (const batch of client.scanIterator({ MATCH: `${useCacheMeta}*`, COUNT: 500 })) {\n metaKeys.push(...(Array.isArray(batch) ? batch : [batch]));\n if (metaKeys.length >= maxEntries) break;\n }\n const raw = metaKeys.length ? await client.mGet(metaKeys) : [];\n const metas = raw\n .map((value) => {\n try {\n return JSON.parse(value ?? '') as UseCacheMeta;\n } catch {\n return undefined;\n }\n })\n .filter((meta): meta is UseCacheMeta => Boolean(meta && functionName(meta.tags)));\n const tags = [...new Set(metas.flatMap((meta) => meta.tags))];\n const [expired, stale] = tags.length\n ? await Promise.all([\n client.mGet(tags.map((tag) => k.expired + tag)),\n client.mGet(tags.map((tag) => k.stale + tag)),\n ])\n : [[], []];\n const states = new Map(\n tags.map((tag, index) => [\n tag,\n { expired: Number(expired[index] ?? 0), stale: Number(stale[index] ?? 0) },\n ])\n );\n for (const meta of metas) {\n const state = tagState(meta, (tag) => states.get(tag) ?? {});\n functions.push({\n key: meta.key,\n name: functionName(meta.tags)!,\n tags: meta.tags,\n generatedAt: meta.timestamp,\n sizeBytes: meta.size,\n revalidateSeconds: Number.isFinite(meta.revalidate) ? meta.revalidate : null,\n expired: state === 'expired',\n stale: state === 'stale',\n });\n }\n }\n return functions;\n },\n };\n}\n"],"mappings":";;;;;;AAoBA,MAAM,aAAa;;;;;;AAOnB,SAAgB,qBAAqB,EACnC,YAAY,gBACZ,SAAS,aAAa,KACsD,EAAE,EAAkB;CAChG,MAAM,IAAI,KAAK,OAAO;CAEtB,eAAe,OAAiF;EAC9F,MAAM,SAAS,MAAM,WAAW;AAChC,MAAI,CAAC,QAAQ,QACX,OAAM,IAAI,MAAM,0BAA0B;EAE5C,MAAM,WAAqB,EAAE;AAC7B,aAAW,MAAM,SAAS,OAAO,aAAa;GAAE,OAAO,GAAG,EAAE,KAAK;GAAI,OAAO;GAAK,CAAC,EAAE;AAClF,YAAS,KAAK,GAAI,MAAM,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAE;AAC1D,OAAI,SAAS,UAAU,WAAY;;AAErC,MAAI,CAAC,SAAS,OACZ,QAAO,EAAE;EAEX,MAAM,MAAM,MAAM,OAAO,KAAK,SAAS;EACvC,MAAM,UAAU,SACb,KAAK,SAAS,UAAU;AACvB,OAAI;AACF,WAAO;KAAE,KAAK,QAAQ,MAAM,EAAE,KAAK,OAAO;KAAE,MAAM,KAAK,MAAM,IAAI,UAAU,GAAG;KAAU;WAClF;AACN;;IAEF,CACD,QAAQ,UAAgD,QAAQ,MAAM,CAAC;EAC1E,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,SAAS,UAAU,MAAM,KAAK,KAAK,CAAC,CAAC;EACtE,MAAM,CAAC,SAAS,SAAS,KAAK,SAC1B,MAAM,QAAQ,IAAI,CAChB,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,UAAU,IAAI,CAAC,EAC/C,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC,CAC9C,CAAC,GACF,CAAC,EAAE,EAAE,EAAE,CAAC;EACZ,MAAM,YAAY,IAAI,IAAI,KAAK,KAAK,KAAK,UAAU,CAAC,KAAK,OAAO,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC;EACvF,MAAM,UAAU,IAAI,IAAI,KAAK,KAAK,KAAK,UAAU,CAAC,KAAK,OAAO,MAAM,UAAU,EAAE,CAAC,CAAC,CAAC;EACnF,MAAM,MAAM,KAAK,KAAK;AACtB,SAAO,QAAQ,KAAK,EAAE,KAAK,YAAY;GACrC;GACA;GACA,SAAS,KAAK,KAAK,MAAM,QAAQ;IAC/B,MAAM,KAAK,UAAU,IAAI,IAAI,IAAI;AACjC,WAAO,KAAK,KAAK,gBAAgB,MAAM;KACvC;GACF,OAAO,KAAK,KAAK,MAAM,SAAS,QAAQ,IAAI,IAAI,IAAI,KAAK,KAAK,aAAa;GAC5E,EAAE;;CAGL,IAAI;CAEJ,SAAS,WAAW;AAClB,cAAY,MAAM,CAAC,cAAc;AAC/B,oBAAiB;AACf,cAAU,KAAA;MACT,EAAE;IACL;AACF,SAAO;;AAGT,QAAO;EACL,SAAS;EACT,MAAM,QAAQ;GACZ,MAAM,QAAsB,EAAE;AAC9B,QAAK,MAAM,EAAE,KAAK,MAAM,SAAS,WAAW,MAAM,UAAU,EAAE;AAC5D,QAAI,KAAK,SAAS,cAAc,KAAK,SAAS,YAAa;IAC3D,MAAM,SAAS,mBAAmB,IAAI;AACtC,QAAI,CAAC,UAAU,OAAO,aAAa,WAAW,KAAK,IAAI,OAAO,iBAAiB,SAC7E;AACF,UAAM,KAAK;KACT,cAAc,OAAO;KACrB,MAAM,aAAa,KAAK,KAAK,KAAK,IAAI,CAAC;KACvC,aAAa,KAAK;KAClB,WAAW,KAAK;KAChB,mBAAmB,OAAO,KAAK,eAAe,WAAW,KAAK,aAAa;KAC3E,QAAQ,KAAK;KACb;KACA,OAAO,CAAC,WAAW;KACnB,YAAY,OAAO;KACpB,CAAC;;AAEJ,UAAO;;EAET,MAAM,YAAY;GAChB,MAAM,YAA8B,EAAE;AACtC,QAAK,MAAM,EAAE,KAAK,MAAM,SAAS,WAAW,MAAM,UAAU,EAAE;IAC5D,MAAM,OAAO,KAAK,SAAS,UAAU,aAAa,KAAK,KAAK,GAAG,KAAA;AAC/D,QAAI,CAAC,KAAM;AACX,cAAU,KAAK;KACb;KACA;KACA,MAAM,KAAK;KACX,aAAa,KAAK;KAClB,WAAW,KAAK;KAChB,mBAAmB,OAAO,KAAK,eAAe,WAAW,KAAK,aAAa;KAC3E;KACA,OAAO,CAAC,WAAW;KACpB,CAAC;;GAGJ,MAAM,SAAS,MAAM,WAAW;AAChC,OAAI,QAAQ,SAAS;IACnB,MAAM,eAAe,GAAG,OAAO;IAC/B,MAAM,WAAqB,EAAE;AAC7B,eAAW,MAAM,SAAS,OAAO,aAAa;KAAE,OAAO,GAAG,aAAa;KAAI,OAAO;KAAK,CAAC,EAAE;AACxF,cAAS,KAAK,GAAI,MAAM,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAE;AAC1D,SAAI,SAAS,UAAU,WAAY;;IAGrC,MAAM,SADM,SAAS,SAAS,MAAM,OAAO,KAAK,SAAS,GAAG,EAAE,EAE3D,KAAK,UAAU;AACd,SAAI;AACF,aAAO,KAAK,MAAM,SAAS,GAAG;aACxB;AACN;;MAEF,CACD,QAAQ,SAA+B,QAAQ,QAAQ,aAAa,KAAK,KAAK,CAAC,CAAC;IACnF,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,MAAM,SAAS,SAAS,KAAK,KAAK,CAAC,CAAC;IAC7D,MAAM,CAAC,SAAS,SAAS,KAAK,SAC1B,MAAM,QAAQ,IAAI,CAChB,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,UAAU,IAAI,CAAC,EAC/C,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC,CAC9C,CAAC,GACF,CAAC,EAAE,EAAE,EAAE,CAAC;IACZ,MAAM,SAAS,IAAI,IACjB,KAAK,KAAK,KAAK,UAAU,CACvB,KACA;KAAE,SAAS,OAAO,QAAQ,UAAU,EAAE;KAAE,OAAO,OAAO,MAAM,UAAU,EAAE;KAAE,CAC3E,CAAC,CACH;AACD,SAAK,MAAM,QAAQ,OAAO;KACxB,MAAM,QAAQ,SAAS,OAAO,QAAQ,OAAO,IAAI,IAAI,IAAI,EAAE,CAAC;AAC5D,eAAU,KAAK;MACb,KAAK,KAAK;MACV,MAAM,aAAa,KAAK,KAAK;MAC7B,MAAM,KAAK;MACX,aAAa,KAAK;MAClB,WAAW,KAAK;MAChB,mBAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,KAAK,aAAa;MACxE,SAAS,UAAU;MACnB,OAAO,UAAU;MAClB,CAAC;;;AAGN,UAAO;;EAEV"}
1
+ {"version":3,"file":"redis.js","names":[],"sources":["../../../../src/server/cache/inspector/redis.ts"],"sourcesContent":["import {\n connectRedisClient,\n keys,\n redisPrefix,\n type RedisLike,\n} from '../../../cache-handler/redis';\nimport { tagState, type UseCacheMeta } from '../../../cache-handlers/default';\nimport { explicitTags } from './filesystem';\nimport { parseRouteCacheKey } from './route-cache-key';\nimport { type CachedFunction, type CachedPage, type CacheInspector, functionName } from './types';\n\n/** The redis client subset the inspector needs on top of the handler's. */\nexport type RedisScanner = Pick<RedisLike, 'isReady' | 'mGet'> & {\n scanIterator(options: { MATCH: string; COUNT?: number }): AsyncIterable<string | string[]>;\n};\n\ntype Meta = {\n lastModified: number;\n tags: string[];\n revalidate: number | false | null;\n kind: string | null;\n status: number | null;\n size: number;\n};\n\nconst maxEntries = 20_000;\n\n/**\n * Reads the shared Redis cache of `@websolutespa/bom-next/cache-handlers/isr` through its meta keys, so page bodies\n * are never loaded. The state is exact: the tag timestamps the handler writes are compared with each entry.\n * Entries written by an older handler without meta keys are not listed.\n */\nexport function createRedisInspector({\n // the panel may wait for the connection: on a cold instance the client is not ready yet\n getClient = connectRedisClient as () => Promise<RedisScanner | undefined>,\n prefix = redisPrefix(),\n}: { getClient?: () => Promise<RedisScanner | undefined>; prefix?: string } = {}): CacheInspector {\n const k = keys(prefix);\n\n async function scan(): Promise<{ key: string; meta: Meta; expired: boolean; stale: boolean }[]> {\n const client = await getClient();\n if (!client?.isReady) {\n throw new Error('Redis is not reachable.');\n }\n const metaKeys: string[] = [];\n for await (const batch of client.scanIterator({ MATCH: `${k.meta}*`, COUNT: 500 })) {\n metaKeys.push(...(Array.isArray(batch) ? batch : [batch]));\n if (metaKeys.length >= maxEntries) break;\n }\n if (!metaKeys.length) {\n return [];\n }\n const raw = await client.mGet(metaKeys);\n const entries = metaKeys\n .map((metaKey, index) => {\n try {\n return { key: metaKey.slice(k.meta.length), meta: JSON.parse(raw[index] ?? '') as Meta };\n } catch {\n return undefined;\n }\n })\n .filter((entry): entry is { key: string; meta: Meta } => Boolean(entry));\n const tags = [...new Set(entries.flatMap((entry) => entry.meta.tags))];\n const [expired, stale] = tags.length\n ? await Promise.all([\n client.mGet(tags.map((tag) => k.expired + tag)),\n client.mGet(tags.map((tag) => k.stale + tag)),\n ])\n : [[], []];\n const expiredAt = new Map(tags.map((tag, index) => [tag, Number(expired[index] ?? 0)]));\n const staleAt = new Map(tags.map((tag, index) => [tag, Number(stale[index] ?? 0)]));\n const now = Date.now();\n return entries.map(({ key, meta }) => ({\n key,\n meta,\n expired: meta.tags.some((tag) => {\n const at = expiredAt.get(tag) ?? 0;\n return at > meta.lastModified && at <= now;\n }),\n stale: meta.tags.some((tag) => (staleAt.get(tag) ?? 0) > meta.lastModified),\n }));\n }\n\n let pending: ReturnType<typeof scan> | undefined;\n // pages() and functions() are read together: one scan serves both\n function scanOnce() {\n pending ??= scan().finally(() => {\n setTimeout(() => {\n pending = undefined;\n }, 0);\n });\n return pending;\n }\n\n return {\n backend: 'redis',\n async pages() {\n const pages: CachedPage[] = [];\n for (const { key, meta, expired, stale } of await scanOnce()) {\n if (meta.kind !== 'APP_PAGE' && meta.kind !== 'APP_ROUTE') continue;\n const parsed = parseRouteCacheKey(key);\n if (!parsed || parsed.internalPath.startsWith('/_') || parsed.internalPath === '/index')\n continue;\n pages.push({\n internalPath: parsed.internalPath,\n tags: explicitTags(meta.tags.join(',')),\n generatedAt: meta.lastModified,\n sizeBytes: meta.size,\n revalidateSeconds: typeof meta.revalidate === 'number' ? meta.revalidate : null,\n status: meta.status,\n expired,\n stale: !expired && stale,\n sourceHash: parsed.sourceHash,\n });\n }\n return pages;\n },\n async functions() {\n const functions: CachedFunction[] = [];\n for (const { key, meta, expired, stale } of await scanOnce()) {\n const name = meta.kind === 'FETCH' ? functionName(meta.tags) : undefined;\n if (!name) continue;\n functions.push({\n key,\n name,\n tags: meta.tags,\n generatedAt: meta.lastModified,\n sizeBytes: meta.size,\n revalidateSeconds: typeof meta.revalidate === 'number' ? meta.revalidate : null,\n expired,\n stale: !expired && stale,\n });\n }\n // `'use cache'` results (Cache Components, Redis handler): same tag keys, their own meta prefix\n const client = await getClient();\n if (client?.isReady) {\n const useCacheMeta = `${prefix}use-cache-meta:`;\n const metaKeys: string[] = [];\n for await (const batch of client.scanIterator({ MATCH: `${useCacheMeta}*`, COUNT: 500 })) {\n metaKeys.push(...(Array.isArray(batch) ? batch : [batch]));\n if (metaKeys.length >= maxEntries) break;\n }\n const raw = metaKeys.length ? await client.mGet(metaKeys) : [];\n const metas = raw\n .map((value) => {\n try {\n return JSON.parse(value ?? '') as UseCacheMeta;\n } catch {\n return undefined;\n }\n })\n .filter((meta): meta is UseCacheMeta => Boolean(meta && functionName(meta.tags)));\n const tags = [...new Set(metas.flatMap((meta) => meta.tags))];\n const [expired, stale] = tags.length\n ? await Promise.all([\n client.mGet(tags.map((tag) => k.expired + tag)),\n client.mGet(tags.map((tag) => k.stale + tag)),\n ])\n : [[], []];\n const states = new Map(\n tags.map((tag, index) => [\n tag,\n { expired: Number(expired[index] ?? 0), stale: Number(stale[index] ?? 0) },\n ])\n );\n for (const meta of metas) {\n const state = tagState(meta, (tag) => states.get(tag) ?? {});\n functions.push({\n key: meta.key,\n name: functionName(meta.tags)!,\n tags: meta.tags,\n generatedAt: meta.timestamp,\n sizeBytes: meta.size,\n revalidateSeconds: Number.isFinite(meta.revalidate) ? meta.revalidate : null,\n expired: state === 'expired',\n stale: state === 'stale',\n });\n }\n }\n return functions;\n },\n };\n}\n"],"mappings":";;;;;;AAyBA,MAAM,aAAa;;;;;;AAOnB,SAAgB,qBAAqB,EAEnC,YAAY,oBACZ,SAAS,aAAa,KACsD,EAAE,EAAkB;CAChG,MAAM,IAAI,KAAK,OAAO;CAEtB,eAAe,OAAiF;EAC9F,MAAM,SAAS,MAAM,WAAW;AAChC,MAAI,CAAC,QAAQ,QACX,OAAM,IAAI,MAAM,0BAA0B;EAE5C,MAAM,WAAqB,EAAE;AAC7B,aAAW,MAAM,SAAS,OAAO,aAAa;GAAE,OAAO,GAAG,EAAE,KAAK;GAAI,OAAO;GAAK,CAAC,EAAE;AAClF,YAAS,KAAK,GAAI,MAAM,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAE;AAC1D,OAAI,SAAS,UAAU,WAAY;;AAErC,MAAI,CAAC,SAAS,OACZ,QAAO,EAAE;EAEX,MAAM,MAAM,MAAM,OAAO,KAAK,SAAS;EACvC,MAAM,UAAU,SACb,KAAK,SAAS,UAAU;AACvB,OAAI;AACF,WAAO;KAAE,KAAK,QAAQ,MAAM,EAAE,KAAK,OAAO;KAAE,MAAM,KAAK,MAAM,IAAI,UAAU,GAAG;KAAU;WAClF;AACN;;IAEF,CACD,QAAQ,UAAgD,QAAQ,MAAM,CAAC;EAC1E,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,SAAS,UAAU,MAAM,KAAK,KAAK,CAAC,CAAC;EACtE,MAAM,CAAC,SAAS,SAAS,KAAK,SAC1B,MAAM,QAAQ,IAAI,CAChB,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,UAAU,IAAI,CAAC,EAC/C,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC,CAC9C,CAAC,GACF,CAAC,EAAE,EAAE,EAAE,CAAC;EACZ,MAAM,YAAY,IAAI,IAAI,KAAK,KAAK,KAAK,UAAU,CAAC,KAAK,OAAO,QAAQ,UAAU,EAAE,CAAC,CAAC,CAAC;EACvF,MAAM,UAAU,IAAI,IAAI,KAAK,KAAK,KAAK,UAAU,CAAC,KAAK,OAAO,MAAM,UAAU,EAAE,CAAC,CAAC,CAAC;EACnF,MAAM,MAAM,KAAK,KAAK;AACtB,SAAO,QAAQ,KAAK,EAAE,KAAK,YAAY;GACrC;GACA;GACA,SAAS,KAAK,KAAK,MAAM,QAAQ;IAC/B,MAAM,KAAK,UAAU,IAAI,IAAI,IAAI;AACjC,WAAO,KAAK,KAAK,gBAAgB,MAAM;KACvC;GACF,OAAO,KAAK,KAAK,MAAM,SAAS,QAAQ,IAAI,IAAI,IAAI,KAAK,KAAK,aAAa;GAC5E,EAAE;;CAGL,IAAI;CAEJ,SAAS,WAAW;AAClB,cAAY,MAAM,CAAC,cAAc;AAC/B,oBAAiB;AACf,cAAU,KAAA;MACT,EAAE;IACL;AACF,SAAO;;AAGT,QAAO;EACL,SAAS;EACT,MAAM,QAAQ;GACZ,MAAM,QAAsB,EAAE;AAC9B,QAAK,MAAM,EAAE,KAAK,MAAM,SAAS,WAAW,MAAM,UAAU,EAAE;AAC5D,QAAI,KAAK,SAAS,cAAc,KAAK,SAAS,YAAa;IAC3D,MAAM,SAAS,mBAAmB,IAAI;AACtC,QAAI,CAAC,UAAU,OAAO,aAAa,WAAW,KAAK,IAAI,OAAO,iBAAiB,SAC7E;AACF,UAAM,KAAK;KACT,cAAc,OAAO;KACrB,MAAM,aAAa,KAAK,KAAK,KAAK,IAAI,CAAC;KACvC,aAAa,KAAK;KAClB,WAAW,KAAK;KAChB,mBAAmB,OAAO,KAAK,eAAe,WAAW,KAAK,aAAa;KAC3E,QAAQ,KAAK;KACb;KACA,OAAO,CAAC,WAAW;KACnB,YAAY,OAAO;KACpB,CAAC;;AAEJ,UAAO;;EAET,MAAM,YAAY;GAChB,MAAM,YAA8B,EAAE;AACtC,QAAK,MAAM,EAAE,KAAK,MAAM,SAAS,WAAW,MAAM,UAAU,EAAE;IAC5D,MAAM,OAAO,KAAK,SAAS,UAAU,aAAa,KAAK,KAAK,GAAG,KAAA;AAC/D,QAAI,CAAC,KAAM;AACX,cAAU,KAAK;KACb;KACA;KACA,MAAM,KAAK;KACX,aAAa,KAAK;KAClB,WAAW,KAAK;KAChB,mBAAmB,OAAO,KAAK,eAAe,WAAW,KAAK,aAAa;KAC3E;KACA,OAAO,CAAC,WAAW;KACpB,CAAC;;GAGJ,MAAM,SAAS,MAAM,WAAW;AAChC,OAAI,QAAQ,SAAS;IACnB,MAAM,eAAe,GAAG,OAAO;IAC/B,MAAM,WAAqB,EAAE;AAC7B,eAAW,MAAM,SAAS,OAAO,aAAa;KAAE,OAAO,GAAG,aAAa;KAAI,OAAO;KAAK,CAAC,EAAE;AACxF,cAAS,KAAK,GAAI,MAAM,QAAQ,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAE;AAC1D,SAAI,SAAS,UAAU,WAAY;;IAGrC,MAAM,SADM,SAAS,SAAS,MAAM,OAAO,KAAK,SAAS,GAAG,EAAE,EAE3D,KAAK,UAAU;AACd,SAAI;AACF,aAAO,KAAK,MAAM,SAAS,GAAG;aACxB;AACN;;MAEF,CACD,QAAQ,SAA+B,QAAQ,QAAQ,aAAa,KAAK,KAAK,CAAC,CAAC;IACnF,MAAM,OAAO,CAAC,GAAG,IAAI,IAAI,MAAM,SAAS,SAAS,KAAK,KAAK,CAAC,CAAC;IAC7D,MAAM,CAAC,SAAS,SAAS,KAAK,SAC1B,MAAM,QAAQ,IAAI,CAChB,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,UAAU,IAAI,CAAC,EAC/C,OAAO,KAAK,KAAK,KAAK,QAAQ,EAAE,QAAQ,IAAI,CAAC,CAC9C,CAAC,GACF,CAAC,EAAE,EAAE,EAAE,CAAC;IACZ,MAAM,SAAS,IAAI,IACjB,KAAK,KAAK,KAAK,UAAU,CACvB,KACA;KAAE,SAAS,OAAO,QAAQ,UAAU,EAAE;KAAE,OAAO,OAAO,MAAM,UAAU,EAAE;KAAE,CAC3E,CAAC,CACH;AACD,SAAK,MAAM,QAAQ,OAAO;KACxB,MAAM,QAAQ,SAAS,OAAO,QAAQ,OAAO,IAAI,IAAI,IAAI,EAAE,CAAC;AAC5D,eAAU,KAAK;MACb,KAAK,KAAK;MACV,MAAM,aAAa,KAAK,KAAK;MAC7B,MAAM,KAAK;MACX,aAAa,KAAK;MAClB,WAAW,KAAK;MAChB,mBAAmB,OAAO,SAAS,KAAK,WAAW,GAAG,KAAK,aAAa;MACxE,SAAS,UAAU;MACnB,OAAO,UAAU;MAClB,CAAC;;;AAGN,UAAO;;EAEV"}
@@ -1,7 +1,31 @@
1
- import { NextRequest, NextResponse } from "next/server";
1
+ import { PREVIEW_ROLES } from "../../lib/const.js";
2
+ import { NextRequest } from "next/server";
3
+ import { SanitizedConfig } from "payload";
2
4
 
3
5
  //#region src/server/handlers/preview.handler.d.ts
4
- declare function previewHandler(request: NextRequest): Promise<NextResponse<unknown>>;
6
+ /**
7
+ * The `/api/-preview` route: turns Draft Mode on for an editor and redirects to the page. Draft Mode shows
8
+ * unpublished content (bom-next reads it with an editing role), so only these callers get the cookie:
9
+ * - a logged-in editor: the admin session cookie (admin and site on one origin), or the `_token` Bowl adds to
10
+ * the admin's preview URL (admin on another origin);
11
+ * - `secret` equal to `MIXER_SECRET`.
12
+ * Everyone else gets 401 and no cookie.
13
+ *
14
+ * ```ts
15
+ * // src/app/api/-preview/route.ts
16
+ * export const GET = getPreviewHandler(config);
17
+ * ```
18
+ */
19
+ declare function getPreviewHandler(config: Promise<SanitizedConfig>, {
20
+ roles
21
+ }?: {
22
+ roles?: string[];
23
+ }): (request: NextRequest) => Promise<Response>;
24
+ /**
25
+ * @deprecated Use `getPreviewHandler(config)`, which also accepts an editor session. Without the config this
26
+ * handler cannot authenticate a user, so it turns Draft Mode on only with `secret` equal to `MIXER_SECRET`.
27
+ */
28
+ declare function previewHandler(request: NextRequest): Promise<Response>;
5
29
  //#endregion
6
- export { previewHandler };
30
+ export { getPreviewHandler, previewHandler };
7
31
  //# sourceMappingURL=preview.handler.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"preview.handler.d.ts","names":[],"sources":["../../../src/server/handlers/preview.handler.ts"],"mappings":";;;iBAKsB,cAAA,CAAe,OAAA,EAAS,WAAA,GAAW,OAAA,CAAA,YAAA"}
1
+ {"version":3,"file":"preview.handler.d.ts","names":[],"sources":["../../../src/server/handlers/preview.handler.ts"],"mappings":";;;;;;AAuDA;;;;;;;;;;;;iBAAgB,iBAAA,CACd,MAAA,EAAQ,OAAA,CAAQ,eAAA;EACd;AAAA;EAA2B,KAAA;AAAA,KAEN,OAAA,EAAS,WAAA,KAAc,OAAA,CAAQ,QAAA;;;;;iBA6BlC,cAAA,CAAe,OAAA,EAAS,WAAA,GAAc,OAAA,CAAQ,QAAA"}
@@ -1,15 +1,66 @@
1
+ import { PREVIEW_ROLES } from "../../lib/const.js";
1
2
  import { NextResponse } from "next/server";
2
3
  import { draftMode } from "next/headers";
4
+ import { getPayload } from "payload";
3
5
  //#region src/server/handlers/preview.handler.ts
4
- async function previewHandler(request) {
5
- const { searchParams } = new URL(request.url);
6
- const { marketId, localeId, templateId, documentId, _status, _live } = Object.fromEntries(searchParams);
6
+ const SEGMENT = /^[\w-]+$/;
7
+ function hasSecret(params) {
8
+ return Boolean(process.env.MIXER_SECRET) && params.secret === process.env.MIXER_SECRET;
9
+ }
10
+ /** Turns Draft Mode on and redirects to the internal page path. */
11
+ async function enablePreview(params) {
12
+ const { marketId, localeId, templateId, documentId, _live } = params;
13
+ if (![
14
+ marketId,
15
+ localeId,
16
+ templateId,
17
+ documentId
18
+ ].every((value) => value && SEGMENT.test(value))) return new Response("Bad Request", { status: 400 });
7
19
  const destination = `/${marketId}/${localeId}/${templateId}/${documentId}${_live ? "?_live=true" : ""}`;
8
20
  (await draftMode()).enable();
9
- const path = `${process.env.NEXT_PUBLIC_URL}${destination}`;
10
- return NextResponse.redirect(path, { status: 303 });
21
+ return NextResponse.redirect(`${process.env.NEXT_PUBLIC_URL}${destination}`, { status: 303 });
22
+ }
23
+ /**
24
+ * The `/api/-preview` route: turns Draft Mode on for an editor and redirects to the page. Draft Mode shows
25
+ * unpublished content (bom-next reads it with an editing role), so only these callers get the cookie:
26
+ * - a logged-in editor: the admin session cookie (admin and site on one origin), or the `_token` Bowl adds to
27
+ * the admin's preview URL (admin on another origin);
28
+ * - `secret` equal to `MIXER_SECRET`.
29
+ * Everyone else gets 401 and no cookie.
30
+ *
31
+ * ```ts
32
+ * // src/app/api/-preview/route.ts
33
+ * export const GET = getPreviewHandler(config);
34
+ * ```
35
+ */
36
+ function getPreviewHandler(config, { roles = PREVIEW_ROLES } = {}) {
37
+ return async function(request) {
38
+ const params = Object.fromEntries(request.nextUrl.searchParams);
39
+ if (!hasSecret(params)) {
40
+ const payload = await getPayload({ config });
41
+ const isEditor = async (headers) => {
42
+ try {
43
+ const { user } = await payload.auth({ headers });
44
+ return (user?.roles ?? []).some((role) => roles.includes(role));
45
+ } catch {
46
+ return false;
47
+ }
48
+ };
49
+ if (!(await isEditor(request.headers) || Boolean(params._token) && await isEditor(new Headers({ authorization: `JWT ${params._token}` })))) return new Response("Unauthorized", { status: 401 });
50
+ }
51
+ return enablePreview(params);
52
+ };
53
+ }
54
+ /**
55
+ * @deprecated Use `getPreviewHandler(config)`, which also accepts an editor session. Without the config this
56
+ * handler cannot authenticate a user, so it turns Draft Mode on only with `secret` equal to `MIXER_SECRET`.
57
+ */
58
+ async function previewHandler(request) {
59
+ const params = Object.fromEntries(request.nextUrl.searchParams);
60
+ if (!hasSecret(params)) return new Response("Unauthorized", { status: 401 });
61
+ return enablePreview(params);
11
62
  }
12
63
  //#endregion
13
- export { previewHandler };
64
+ export { getPreviewHandler, previewHandler };
14
65
 
15
66
  //# sourceMappingURL=preview.handler.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"preview.handler.js","names":[],"sources":["../../../src/server/handlers/preview.handler.ts"],"sourcesContent":["import { draftMode } from 'next/headers';\nimport { NextRequest, NextResponse } from 'next/server';\n\n// http://localhost:3000/api/-preview?marketId=ww&localeId=it&templateId=homepage&documentId=6a6b33177d8f191df34b33a3\n\nexport async function previewHandler(request: NextRequest) {\n const { searchParams } = new URL(request.url);\n const params = Object.fromEntries(searchParams) as {\n marketId: string;\n localeId: string;\n templateId: string;\n documentId: string;\n _status: 'published' | 'draft';\n _live: string;\n _token: string;\n };\n /*\n if (params.secret !== process.env.MIXER_SECRET) {\n return new Response('Invalid token', { status: 401 })\n }\n */\n /*\n const headersList = await headers()\n const userAgent = headersList.get('user-agent')\n */\n const { marketId, localeId, templateId, documentId, _status, _live } = params;\n const destination = `/${marketId}/${localeId}/${templateId}/${documentId}${_live ? '?_live=true' : ''}`;\n /*\n response.setPreviewData({ _status });\n response.setDraftMode({ enable: true });\n response.redirect(307, destination);\n redirect(destination, RedirectType.replace);\n */\n const draft = await draftMode();\n draft.enable();\n const path = `${process.env.NEXT_PUBLIC_URL}${destination}`;\n return NextResponse.redirect(path, {\n status: 303,\n });\n /*\n return NextResponse.redirect(path, {\n status: 303,\n });\n */\n /*\n return new Response(null, {\n status: 303,\n headers: {\n Location: path,\n },\n });\n */\n /*\n redirect(path);\n return;\n */\n /*\n return NextResponse.json({\n destination: destination,\n permanent: false\n });\n */\n}\n"],"mappings":";;;AAKA,eAAsB,eAAe,SAAsB;CACzD,MAAM,EAAE,iBAAiB,IAAI,IAAI,QAAQ,IAAI;CAmB7C,MAAM,EAAE,UAAU,UAAU,YAAY,YAAY,SAAS,UAlB9C,OAAO,YAAY,aAAa;CAmB/C,MAAM,cAAc,IAAI,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,QAAQ,gBAAgB;AAQnG,EADc,MAAM,WAAW,EACzB,QAAQ;CACd,MAAM,OAAO,GAAG,QAAQ,IAAI,kBAAkB;AAC9C,QAAO,aAAa,SAAS,MAAM,EACjC,QAAQ,KACT,CAAC"}
1
+ {"version":3,"file":"preview.handler.js","names":[],"sources":["../../../src/server/handlers/preview.handler.ts"],"sourcesContent":["import { draftMode } from 'next/headers';\nimport { NextRequest, NextResponse } from 'next/server';\nimport { getPayload, SanitizedConfig } from 'payload';\nimport { PREVIEW_ROLES } from '../../lib/const';\n\n// http://localhost:3000/api/-preview?marketId=ww&localeId=it&templateId=homepage&documentId=6a6b33177d8f191df34b33a3\n\nexport { PREVIEW_ROLES };\n\ntype PreviewParams = {\n marketId?: string;\n localeId?: string;\n templateId?: string;\n documentId?: string;\n _live?: string;\n /** the editor's token, added by Bowl to the admin's preview URL */\n _token?: string;\n /** `MIXER_SECRET`, for a caller without an editor session */\n secret?: string;\n};\n\n// path segments only: the destination stays on this site\nconst SEGMENT = /^[\\w-]+$/;\n\nfunction hasSecret(params: PreviewParams): boolean {\n return Boolean(process.env.MIXER_SECRET) && params.secret === process.env.MIXER_SECRET;\n}\n\n/** Turns Draft Mode on and redirects to the internal page path. */\nasync function enablePreview(params: PreviewParams): Promise<Response> {\n const { marketId, localeId, templateId, documentId, _live } = params;\n if (\n ![marketId, localeId, templateId, documentId].every((value) => value && SEGMENT.test(value))\n ) {\n return new Response('Bad Request', { status: 400 });\n }\n const destination = `/${marketId}/${localeId}/${templateId}/${documentId}${_live ? '?_live=true' : ''}`;\n const draft = await draftMode();\n draft.enable();\n return NextResponse.redirect(`${process.env.NEXT_PUBLIC_URL}${destination}`, { status: 303 });\n}\n\n/**\n * The `/api/-preview` route: turns Draft Mode on for an editor and redirects to the page. Draft Mode shows\n * unpublished content (bom-next reads it with an editing role), so only these callers get the cookie:\n * - a logged-in editor: the admin session cookie (admin and site on one origin), or the `_token` Bowl adds to\n * the admin's preview URL (admin on another origin);\n * - `secret` equal to `MIXER_SECRET`.\n * Everyone else gets 401 and no cookie.\n *\n * ```ts\n * // src/app/api/-preview/route.ts\n * export const GET = getPreviewHandler(config);\n * ```\n */\nexport function getPreviewHandler(\n config: Promise<SanitizedConfig>,\n { roles = PREVIEW_ROLES }: { roles?: string[] } = {}\n) {\n return async function (request: NextRequest): Promise<Response> {\n const params = Object.fromEntries(request.nextUrl.searchParams) as PreviewParams;\n if (!hasSecret(params)) {\n const payload = await getPayload({ config });\n const isEditor = async (headers: Headers) => {\n try {\n const { user } = await payload.auth({ headers });\n const userRoles = (user as { roles?: string[] } | null)?.roles ?? [];\n return userRoles.some((role) => roles.includes(role));\n } catch {\n return false;\n }\n };\n const allowed =\n (await isEditor(request.headers)) ||\n (Boolean(params._token) &&\n (await isEditor(new Headers({ authorization: `JWT ${params._token}` }))));\n if (!allowed) {\n return new Response('Unauthorized', { status: 401 });\n }\n }\n return enablePreview(params);\n };\n}\n\n/**\n * @deprecated Use `getPreviewHandler(config)`, which also accepts an editor session. Without the config this\n * handler cannot authenticate a user, so it turns Draft Mode on only with `secret` equal to `MIXER_SECRET`.\n */\nexport async function previewHandler(request: NextRequest): Promise<Response> {\n const params = Object.fromEntries(request.nextUrl.searchParams) as PreviewParams;\n if (!hasSecret(params)) {\n return new Response('Unauthorized', { status: 401 });\n }\n return enablePreview(params);\n}\n"],"mappings":";;;;;AAsBA,MAAM,UAAU;AAEhB,SAAS,UAAU,QAAgC;AACjD,QAAO,QAAQ,QAAQ,IAAI,aAAa,IAAI,OAAO,WAAW,QAAQ,IAAI;;;AAI5E,eAAe,cAAc,QAA0C;CACrE,MAAM,EAAE,UAAU,UAAU,YAAY,YAAY,UAAU;AAC9D,KACE,CAAC;EAAC;EAAU;EAAU;EAAY;EAAW,CAAC,OAAO,UAAU,SAAS,QAAQ,KAAK,MAAM,CAAC,CAE5F,QAAO,IAAI,SAAS,eAAe,EAAE,QAAQ,KAAK,CAAC;CAErD,MAAM,cAAc,IAAI,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,aAAa,QAAQ,gBAAgB;AAEnG,EADc,MAAM,WAAW,EACzB,QAAQ;AACd,QAAO,aAAa,SAAS,GAAG,QAAQ,IAAI,kBAAkB,eAAe,EAAE,QAAQ,KAAK,CAAC;;;;;;;;;;;;;;;AAgB/F,SAAgB,kBACd,QACA,EAAE,QAAQ,kBAAwC,EAAE,EACpD;AACA,QAAO,eAAgB,SAAyC;EAC9D,MAAM,SAAS,OAAO,YAAY,QAAQ,QAAQ,aAAa;AAC/D,MAAI,CAAC,UAAU,OAAO,EAAE;GACtB,MAAM,UAAU,MAAM,WAAW,EAAE,QAAQ,CAAC;GAC5C,MAAM,WAAW,OAAO,YAAqB;AAC3C,QAAI;KACF,MAAM,EAAE,SAAS,MAAM,QAAQ,KAAK,EAAE,SAAS,CAAC;AAEhD,aADmB,MAAsC,SAAS,EAAE,EACnD,MAAM,SAAS,MAAM,SAAS,KAAK,CAAC;YAC/C;AACN,YAAO;;;AAOX,OAAI,EAHD,MAAM,SAAS,QAAQ,QAAQ,IAC/B,QAAQ,OAAO,OAAO,IACpB,MAAM,SAAS,IAAI,QAAQ,EAAE,eAAe,OAAO,OAAO,UAAU,CAAC,CAAC,EAEzE,QAAO,IAAI,SAAS,gBAAgB,EAAE,QAAQ,KAAK,CAAC;;AAGxD,SAAO,cAAc,OAAO;;;;;;;AAQhC,eAAsB,eAAe,SAAyC;CAC5E,MAAM,SAAS,OAAO,YAAY,QAAQ,QAAQ,aAAa;AAC/D,KAAI,CAAC,UAAU,OAAO,CACpB,QAAO,IAAI,SAAS,gBAAgB,EAAE,QAAQ,KAAK,CAAC;AAEtD,QAAO,cAAc,OAAO"}
@@ -1,5 +1,5 @@
1
1
  import { LayoutOption, PageContextOptions, PageParams, PageSelect } from "../types.js";
2
- import { PageMetadataBrand, PageMetadataContext, PageMetadataOptions, PageMetadataSearchParams, buildPageMetadata, getPageAlternates, getPageXDefault, getPaginationQuery, inheritParentMetadata, resolveMetadataUrl, toPlainText } from "../lib/page-metadata.js";
2
+ import { PageMetadataBrand, PageMetadataContext, PageMetadataOptions, PageMetadataSearchParams, buildPageMetadata, getPageAlternates, getPageXDefault, getPaginationQuery, inheritParentMetadata, isIndexableDeployment, resolveMetadataUrl, toPlainText } from "../lib/page-metadata.js";
3
3
  import { CollectionSlug, SanitizedConfig } from "payload";
4
4
  import { Metadata, ResolvingMetadata } from "next";
5
5
 
@@ -100,7 +100,7 @@ declare function resolveDraft(draft?: DraftOption): Promise<boolean>;
100
100
  declare function getPayload$1({
101
101
  config,
102
102
  headers,
103
- draft
103
+ draft: requestedDraft
104
104
  }: {
105
105
  config: Promise<SanitizedConfig>;
106
106
  headers?: ReadonlyHeaders;
@@ -1 +1 @@
1
- {"version":3,"file":"mixer.d.ts","names":[],"sources":["../../src/server/mixer.ts"],"mappings":";;;;;;;;;;iBAmEgB,sBAAA,CAAA;AAAA,iBAIA,WAAA,CAAA;EACd,MAAA;EACA,MAAA;EACA,IAAA;EACA;AAAA;EAEA,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA;AAAA,iBAeoB,UAAA,CAAA,GAAU,OAAA,CAAA,QAAA;AAAA,iBAYV,UAAA,CAAW,IAAA,EAAM,OAAA,CAAQ,QAAA,IAAS,OAAA;AAAA,iBAUxC,eAAA,CAAgB,OAAA,EAAS,WAAA;;;;;;;;gBAAA,eAAA;AAAA;AAAA,cAa5B,kBAAA,GAAkB,KAAA;EACb,MAAA,EAAQ,eAAA,GAAkB,OAAA,CAAQ,eAAA;AAAA,MAAkB,OAAA,CAAA,WAAA;AAAA,iBAGtD,UAAA,CAAA;EACd,MAAA;EACA,IAAA;EACA;AAAA;EAEA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA;;;;;;;;AA9CF;;;;iBA+EsB,WAAA,CAAA;EACpB,OAAA;EACA;AAAA;EAEA,OAAA,EAAS,WAAA;EACT,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA,IACE,OAAA,CAAQ,MAAA;AAAA,iBAKU,eAAA,CAAA;EACpB,OAAA;EACA,MAAA;EACA,MAAA;EACA,IAAA;EACA;AAAA;EAEA,OAAA,EAAS,WAAA;EACT,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA,IACE,OAAA,CAAQ,YAAA;;AAnFZ;;;;;iBAmKsB,YAAA,CAAa,KAAA,GAAO,WAAA,GAAsB,OAAA;;;;;;;;;;;AAtJhE;;iBA6KsB,YAAA,CAAA;EACpB,MAAA;EACA,OAAA;EACA;AAAA;EAEA,MAAA,EAAQ,OAAA,CAAQ,eAAA;EAChB,OAAA,GAAU,eAAA;EACV,KAAA;AAAA,IACD,OAAA;WAoBuB,YAAA;;;+BAGO,MAAA,aAAgB,OAAA,CAAA,YAAA;AAAA;AAAA,iBAa/B,YAAA,CAAa,MAAA,EAAQ,MAAA,IAAU,MAAA,UAAgB,MAAA,WAAiB,MAAA;AAAA,iBAMhE,cAAA,CAAe,KAAA;EAAS,KAAA;AAAA,gBAA8B,OAAA;;;;AA3NtE;;iBAwOgB,gBAAA,CAAA;EACd,IAAA;EACA,MAAA;EACA,KAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA;EACA;AAAA,GACC,WAAA;EACD,IAAA;EACA,MAAA;AAAA;;oBAFY,OAAA,CAAA,UAAA;EAAA;;UAKQ,WAAA;kBACe,mBAAA;;;;;;;;;;iBAiBrB,gBAAA,CAAiB,IAAA,OAAW,MAAA,UAAgB,KAAA;;oBAA5B,OAAA,CAAA,UAAA;EAAA;;UAlBV,WAAA;kBACe,mBAAA"}
1
+ {"version":3,"file":"mixer.d.ts","names":[],"sources":["../../src/server/mixer.ts"],"mappings":";;;;;;;;;;iBAmEgB,sBAAA,CAAA;AAAA,iBAIA,WAAA,CAAA;EACd,MAAA;EACA,MAAA;EACA,IAAA;EACA;AAAA;EAEA,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA;AAAA,iBAeoB,UAAA,CAAA,GAAU,OAAA,CAAA,QAAA;AAAA,iBAYV,UAAA,CAAW,IAAA,EAAM,OAAA,CAAQ,QAAA,IAAS,OAAA;AAAA,iBAUxC,eAAA,CAAgB,OAAA,EAAS,WAAA;;;;;;;;gBAAA,eAAA;AAAA;AAAA,cAa5B,kBAAA,GAAkB,KAAA;EACb,MAAA,EAAQ,eAAA,GAAkB,OAAA,CAAQ,eAAA;AAAA,MAAkB,OAAA,CAAA,WAAA;AAAA,iBAGtD,UAAA,CAAA;EACd,MAAA;EACA,IAAA;EACA;AAAA;EAEA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA;;;;;;;;AA9CF;;;;iBA+EsB,WAAA,CAAA;EACpB,OAAA;EACA;AAAA;EAEA,OAAA,EAAS,WAAA;EACT,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA,IACE,OAAA,CAAQ,MAAA;AAAA,iBAKU,eAAA,CAAA;EACpB,OAAA;EACA,MAAA;EACA,MAAA;EACA,IAAA;EACA;AAAA;EAEA,OAAA,EAAS,WAAA;EACT,MAAA;EACA,MAAA;EACA,IAAA,GAAO,IAAA,GAAO,MAAA;EACd,KAAA;AAAA,IACE,OAAA,CAAQ,YAAA;;AAnFZ;;;;;iBAyKsB,YAAA,CAAa,KAAA,GAAO,WAAA,GAAsB,OAAA;;;;;;;;;;;AA5JhE;;iBAmLsB,YAAA,CAAA;EACpB,MAAA;EACA,OAAA;EACA,KAAA,EAAO;AAAA;EAEP,MAAA,EAAQ,OAAA,CAAQ,eAAA;EAChB,OAAA,GAAU,eAAA;EACV,KAAA;AAAA,IACD,OAAA;WA+BuB,YAAA;;;+BAGO,MAAA,aAAgB,OAAA,CAAA,YAAA;AAAA;AAAA,iBAa/B,YAAA,CAAa,MAAA,EAAQ,MAAA,IAAU,MAAA,UAAgB,MAAA,WAAiB,MAAA;AAAA,iBAMhE,cAAA,CAAe,KAAA;EAAS,KAAA;AAAA,gBAA8B,OAAA;;;;AA5OtE;;iBAyPgB,gBAAA,CAAA;EACd,IAAA;EACA,MAAA;EACA,KAAA;EACA,KAAA;EACA,MAAA;EACA,QAAA;EACA;AAAA,GACC,WAAA;EACD,IAAA;EACA,MAAA;AAAA;;oBAFY,OAAA,CAAA,UAAA;EAAA;;UAKQ,WAAA;kBACe,mBAAA;;;;;;;;;;iBAiBrB,gBAAA,CAAiB,IAAA,OAAW,MAAA,UAAgB,KAAA;;oBAA5B,OAAA,CAAA,UAAA;EAAA;;UAlBV,WAAA;kBACe,mBAAA"}
@@ -1,4 +1,4 @@
1
- import { guest } from "../lib/const.js";
1
+ import { PREVIEW_ROLES, guest, previewer } from "../lib/const.js";
2
2
  import { debug } from "../lib/debug.js";
3
3
  import { TtlCache } from "../lib/ttl-cache.js";
4
4
  import { defaultLocale, defaultMarket, isObject } from "@websolutespa/bom-core";
@@ -170,6 +170,10 @@ async function loadMixerContext({ payload, market, locale, user, draft }) {
170
170
  richText: false
171
171
  };
172
172
  }
173
+ /** Whether the user has an editing role, the ones Bowl serves drafts to. */
174
+ function hasPreviewRole(user) {
175
+ return (user?.roles ?? []).some((role) => PREVIEW_ROLES.includes(role));
176
+ }
173
177
  /**
174
178
  * Resolves a draft option to a boolean.
175
179
  * Defaults to `false`. `'auto'` is an explicit opt-in that reads Next's `draftMode()`
@@ -196,7 +200,7 @@ async function resolveDraft(draft = false) {
196
200
  * const headers = await getHeaders();
197
201
  * const { payload, user, getContext } = await getPayload({ config, headers });
198
202
  */
199
- async function getPayload$1({ config, headers, draft = false }) {
203
+ async function getPayload$1({ config, headers, draft: requestedDraft = false }) {
200
204
  const payload = await getPayload({ config });
201
205
  await setContext({ payload });
202
206
  let user = guest;
@@ -209,6 +213,11 @@ async function getPayload$1({ config, headers, draft = false }) {
209
213
  } catch (error) {
210
214
  console.log("getPayload.error", error);
211
215
  }
216
+ let draft = requestedDraft;
217
+ if (draft && !hasPreviewRole(user)) {
218
+ draft = await resolveDraft("auto");
219
+ if (draft) user = previewer;
220
+ }
212
221
  const contexts = /* @__PURE__ */ new Map();
213
222
  return {
214
223
  payload,
@@ -1 +1 @@
1
- {"version":3,"file":"mixer.js","names":["getPayload_","getRoutes","getPayload"],"sources":["../../src/server/mixer.ts"],"sourcesContent":["import {\n defaultLocale,\n defaultMarket,\n ILocale,\n IMarket,\n IRoute,\n isObject,\n} from '@websolutespa/bom-core';\nimport type { Config, User } from '@websolutespa/payload-plugin-bowl';\nimport {\n getRouteStore,\n getRouteStoreDraftRoutes,\n getRouteStoreRoutes,\n onRouteStoreChange,\n} from '@websolutespa/payload-plugin-bowl';\nimport { draftMode } from 'next/headers';\nimport { NextRequest } from 'next/server';\nimport {\n BasePayload,\n getPayload as getPayload_,\n Payload,\n SanitizedConfig,\n TypedFallbackLocale,\n TypedLocale,\n} from 'payload';\nimport { cache } from 'react';\nimport { guest } from '../lib/const';\nimport { debug } from '../lib/debug';\nimport { TtlCache } from '../lib/ttl-cache';\nimport type {\n BaseOptions,\n DraftOption,\n IContext,\n MixerContext,\n ReadOptions,\n ReadonlyHeaders,\n} from '../types';\nimport type { MixerPayload } from './mixer-payload';\n\n// Context entries live for MEMORY_CACHE_DURATION seconds (default 300) and\n// are dropped as soon as the Bowl route store reports a change, locally or\n// from another instance through Redis.\nconst CONTEXT_CACHE_DURATION =\n (process.env.MEMORY_CACHE_DURATION ? parseInt(process.env.MEMORY_CACHE_DURATION) : 5 * 60) * 1000;\nconst CONTEXT_CACHE_MAX = 500;\n\ntype MixerCacheState = {\n cache: TtlCache<MixerContext>;\n subscribed?: boolean;\n};\n\nconst getMixerCacheState = (): MixerCacheState => {\n // A new global key: `_mixer` held an InMemoryCache in earlier versions and\n // can survive a dev hot reload with that shape.\n const globalForMixer = globalThis as typeof globalThis & { _bomMixerContext?: MixerCacheState };\n if (!globalForMixer._bomMixerContext) {\n globalForMixer._bomMixerContext = { cache: new TtlCache<MixerContext>(CONTEXT_CACHE_MAX) };\n }\n const state = globalForMixer._bomMixerContext;\n if (!state.subscribed) {\n state.subscribed = true;\n onRouteStoreChange(() => state.cache.clear());\n }\n return state;\n};\n\n/** Drops every cached mixer context on this instance. */\nexport function clearMixerContextCache() {\n getMixerCacheState().cache.clear();\n}\n\nexport function getCacheKey({\n market = 'all',\n locale = 'all',\n user = guest,\n draft = 'false',\n}: {\n market?: string;\n locale?: string;\n user?: User & Config['user'];\n draft?: string;\n}) {\n const roles = (user?.roles || ['guest']) as string[];\n const tenants = (\n 'tenants' in user && Array.isArray(user.tenants)\n ? user.tenants.map((x: any) => (isObject(x) ? x.id : x))\n : []\n ) as string[];\n roles.sort();\n tenants.sort();\n const keys = [market, locale, draft === 'false' ? 'published' : 'draft', ...roles, ...tenants];\n const key = `context-${keys.join('-')}`;\n return key;\n}\n\nexport async function getContext() {\n let context: IContext | undefined = (globalThis as any)._context;\n if (!context) {\n context = {\n payload: undefined,\n context: undefined,\n } as unknown as IContext;\n (globalThis as any)._context = context;\n }\n return context;\n}\n\nexport async function setContext(data: Partial<IContext>) {\n const context = await getContext();\n if (data.payload) {\n context.payload = data.payload;\n }\n if (data.context) {\n context.context = data.context;\n }\n}\n\nexport function getSearchParams(request: NextRequest) {\n const searchParams = request.nextUrl.searchParams;\n const params = Object.fromEntries(searchParams.entries());\n return {\n market: params.market || defaultMarket,\n locale: params.locale || defaultLocale,\n defaultMarket,\n defaultLocale,\n params,\n searchParams: request.nextUrl.searchParams,\n };\n}\n\nexport const getPayloadInstance = cache(\n async (props: { config: SanitizedConfig | Promise<SanitizedConfig> }) => await getPayload_(props)\n);\n\nexport function getOptions({\n locale = 'all',\n user = guest,\n draft = false,\n}: {\n locale?: string;\n user?: User & Config['user'];\n draft?: boolean;\n}) {\n const localized: BaseOptions = {\n locale: locale as TypedLocale,\n fallbackLocale: defaultLocale as TypedLocale,\n draft,\n depth: 0,\n pagination: false,\n limit: 10000,\n user,\n overrideAccess: false,\n };\n const unlocalized: BaseOptions = {\n locale: 'all',\n fallbackLocale: defaultLocale as TypedLocale,\n draft,\n depth: 0,\n pagination: false,\n limit: 10000,\n user,\n overrideAccess: false,\n };\n return { localized, unlocalized };\n}\n\n/**\n * Returns all routes from the Bowl route store: published routes, or the\n * published routes overlaid with draft pages when `draft` is true.\n *\n * The route store is Guest-readable by design (see payload-plugin-bowl's\n * \"Route Resolution\"), so `market`, `locale` and `user` no longer change the\n * result; they are kept for backward compatibility.\n */\nexport async function getRoutes({\n payload,\n draft = false,\n}: {\n payload: BasePayload;\n market?: string;\n locale?: string;\n user?: User & Config['user'];\n draft?: boolean;\n}): Promise<IRoute[]> {\n const store = await getRouteStore(payload as Payload);\n return draft ? getRouteStoreDraftRoutes(payload as Payload, store) : getRouteStoreRoutes(store);\n}\n\nexport async function getMixerContext({\n payload,\n market,\n locale,\n user = guest,\n draft = false,\n}: {\n payload: BasePayload;\n market: string;\n locale: string;\n user?: User & Config['user'];\n draft?: boolean;\n}): Promise<MixerContext> {\n const load = () => loadMixerContext({ payload, market, locale, user, draft });\n // Draft previews must reflect the latest save, so they are never cached.\n if (draft) {\n const context = await load();\n await setContext({ context });\n return context;\n }\n const cacheKey = getCacheKey({ market, locale, user, draft: 'false' });\n const context = await getMixerCacheState().cache.getOrSet(\n cacheKey,\n () => CONTEXT_CACHE_DURATION,\n () => {\n debug('getContext miss', cacheKey);\n return load();\n }\n );\n await setContext({ context });\n return context;\n}\n\nasync function loadMixerContext({\n payload,\n market,\n locale,\n user,\n draft,\n}: {\n payload: BasePayload;\n market: string;\n locale: string;\n user: User & Config['user'];\n draft: boolean;\n}): Promise<MixerContext> {\n const { localized } = getOptions({ locale, user, draft });\n // Independent reads: run them concurrently. Routes come from the route\n // store, which keeps pages and media in memory.\n const [localeResult, marketRequest, categoryRequest, routes] = await Promise.all([\n payload.findGlobal({\n ...localized,\n slug: 'locale',\n }) as Promise<{ items: ILocale[] }>,\n payload.find({\n ...localized,\n collection: 'market',\n }),\n payload.find({\n ...localized,\n collection: 'category',\n depth: 2,\n }),\n getRoutes({ payload, draft }),\n ]);\n const locales = localeResult.items.filter((x) => x.isActive) as unknown as ILocale[];\n const localeIds = locales.map((x) => x.id) as string[];\n const markets = marketRequest.docs.filter((x) => x.isActive) as unknown as IMarket[];\n const marketIds = markets.map((x) => x.id);\n const categories = categoryRequest.docs;\n const currentRoutes = filterRoutes(routes, market, locale);\n\n return {\n locale,\n localeIds,\n locales,\n market,\n marketIds,\n markets,\n routes,\n currentRoutes,\n categories: categories as unknown as MixerContext['categories'],\n richText: false,\n };\n}\n\n/**\n * Resolves a draft option to a boolean.\n * Defaults to `false`. `'auto'` is an explicit opt-in that reads Next's `draftMode()`\n * (a cookie read); outside a request scope (build, scripts) it resolves to false.\n * Prefer passing `(await draftMode()).isEnabled` from the template.\n */\nexport async function resolveDraft(draft: DraftOption = false): Promise<boolean> {\n if (typeof draft === 'boolean') {\n return draft;\n }\n try {\n return (await draftMode()).isEnabled;\n } catch {\n return false;\n }\n}\n\n/**\n * Runtime (request-time) payload accessor.\n *\n * By default, operates as the guest user for static generation. For auth:\n * call getHeaders() directly in your page/route/layout, then pass it here.\n * This function never reads request data itself: in draft mode pass the\n * request `headers` too, otherwise drafts are read as the guest user.\n *\n * Example:\n * const headers = await getHeaders();\n * const { payload, user, getContext } = await getPayload({ config, headers });\n */\nexport async function getPayload({\n config,\n headers,\n draft = false,\n}: {\n config: Promise<SanitizedConfig>;\n headers?: ReadonlyHeaders;\n draft?: boolean;\n}) {\n const payload = await getPayload_({ config });\n await setContext({ payload: payload as MixerPayload });\n\n let user: User & Config['user'] = guest;\n if (headers) {\n try {\n const auth = await payload.auth({ headers, canSetHeaders: false });\n if (auth.user) {\n user = auth.user as typeof user;\n }\n } catch (error) {\n console.log('getPayload.error', error);\n }\n }\n\n // Draft contexts bypass the shared cache, so share them at least between\n // the callers of this instance (one request when obtained per request).\n const contexts = new Map<string, Promise<MixerContext>>();\n return {\n payload: payload as MixerPayload,\n user,\n draft,\n getContext: (market: string, locale: string) => {\n const key = `${market}|${locale}`;\n let context = contexts.get(key);\n if (!context) {\n context = getMixerContext({ payload, market, locale, user, draft });\n contexts.set(key, context);\n context.catch(() => contexts.delete(key));\n }\n return context;\n },\n };\n}\n\nexport function filterRoutes(routes: IRoute[], market: string, locale: string): IRoute[] {\n market = market === 'all' ? defaultMarket : market;\n locale = locale === 'all' ? defaultLocale : locale;\n return routes.filter((x) => x.market === market && x.locale === locale);\n}\n\nexport function getAuthHeaders(token: { value: string } | undefined): Headers {\n if (token) {\n return new Headers({ Authorization: `JWT ${token.value}` });\n } else {\n return new Headers({ Authorization: `users API-Key ${process.env.STORE_API_KEY}` });\n }\n}\n\n/**\n * Produces the read options shared across payload.find / findByID / findGlobal calls.\n * For payload.find, add pagination: false and limit: 10000 at the call site.\n * `select`, `populate` and `joins` are only included when provided.\n */\nexport function buildReadOptions({\n user,\n locale,\n draft = false,\n depth,\n select,\n populate,\n joins,\n}: ReadOptions & {\n user: any;\n locale: string;\n}) {\n return {\n locale: locale as TypedLocale,\n fallbackLocale: defaultLocale as TypedFallbackLocale,\n draft,\n depth,\n // the logged in user or the guest: bowl decorates only reads with a user, as for the http api\n user: user || guest,\n overrideAccess: false,\n ...(select !== undefined ? { select } : {}),\n ...(populate !== undefined ? { populate } : {}),\n // joins are collection specific: typed by the caller's options, untyped here\n ...(joins !== undefined ? ({ joins } as {}) : {}),\n };\n}\n\n/**\n * @deprecated Use `buildReadOptions({ user, locale, draft, depth })`.\n * Kept for backward compatibility: reads at depth 0.\n */\nexport function buildBaseOptions(user: any, locale: string, draft?: boolean) {\n return buildReadOptions({ user, locale, draft, depth: 0 });\n}\n\n/**\n * Payload proxy example\n *\n *\n * import type { Payload, PayloadRequest } from '../types/index.js'\n\nimport { commitTransaction } from './commitTransaction.js'\nimport { initTransaction } from './initTransaction.js'\nimport { killTransaction } from './killTransaction.js'\n\nconst localOperations = [\n 'count',\n 'countGlobalVersions',\n 'countVersions',\n 'create',\n 'delete',\n 'duplicate',\n 'find',\n 'findByID',\n 'delete',\n 'duplicate',\n 'find',\n 'findByID',\n 'findGlobal',\n 'findGlobalVersionByID',\n 'findGlobalVersions',\n 'findVersionByID',\n 'findVersionByID',\n 'login',\n 'update',\n 'updateGlobal',\n 'restoreVersion',\n 'restoreGlobalVersion',\n] satisfies (keyof Payload)[]\n\ntype LocalOperation = (typeof localOperations)[number]\n\nconst isLocalOperation = (key: string): key is LocalOperation => {\n return localOperations.includes(key as LocalOperation)\n}\n\nexport const withTransaction = async <T>(\n payload: Payload,\n callback: (transaction: Payload) => Promise<T>,\n) => {\n const transactionReq = { payload } as PayloadRequest\n await initTransaction(transactionReq)\n\n const proxy = new Proxy(payload, {\n get(target, property: keyof Payload, receiver) {\n if (isLocalOperation(property)) {\n const operation = Reflect.get(target, property, receiver)\n\n return function (options) {\n let req: Partial<PayloadRequest> = options.req\n\n if (!req) {\n req = {}\n }\n\n if (!req.transactionID) {\n req = { ...req, transactionID: transactionReq.transactionID }\n }\n\n return (operation as (...args: unknown[]) => void)({\n ...options,\n req,\n })\n }\n }\n\n return Reflect.get(target, property, receiver)\n },\n })\n\n try {\n const result = await callback(proxy)\n await commitTransaction(transactionReq)\n return result\n } catch (e) {\n await killTransaction(transactionReq)\n throw e\n }\n}\n\n// -----------------\n\nconst { one, two } = await withTransaction(payload, async (transaction) => {\n const one = await transaction.create({ collection: 'posts', data: { title: 'one' } })\n const two = await transaction.create({ collection: 'posts', data: { title: 'two' } })\n\n return { one, two }\n})\n\n */\n"],"mappings":";;;;;;;;;AA0CA,MAAM,0BACH,QAAQ,IAAI,wBAAwB,SAAS,QAAQ,IAAI,sBAAsB,GAAG,OAAU;AAC/F,MAAM,oBAAoB;AAO1B,MAAM,2BAA4C;CAGhD,MAAM,iBAAiB;AACvB,KAAI,CAAC,eAAe,iBAClB,gBAAe,mBAAmB,EAAE,OAAO,IAAI,SAAuB,kBAAkB,EAAE;CAE5F,MAAM,QAAQ,eAAe;AAC7B,KAAI,CAAC,MAAM,YAAY;AACrB,QAAM,aAAa;AACnB,2BAAyB,MAAM,MAAM,OAAO,CAAC;;AAE/C,QAAO;;;AAIT,SAAgB,yBAAyB;AACvC,qBAAoB,CAAC,MAAM,OAAO;;AAGpC,SAAgB,YAAY,EAC1B,SAAS,OACT,SAAS,OACT,OAAO,OACP,QAAQ,WAMP;CACD,MAAM,QAAS,MAAM,SAAS,CAAC,QAAQ;CACvC,MAAM,UACJ,aAAa,QAAQ,MAAM,QAAQ,KAAK,QAAQ,GAC5C,KAAK,QAAQ,KAAK,MAAY,SAAS,EAAE,GAAG,EAAE,KAAK,EAAG,GACtD,EAAE;AAER,OAAM,MAAM;AACZ,SAAQ,MAAM;AAGd,QADY,WADC;EAAC;EAAQ;EAAQ,UAAU,UAAU,cAAc;EAAS,GAAG;EAAO,GAAG;EAAQ,CAClE,KAAK,IAAI;;AAIvC,eAAsB,aAAa;CACjC,IAAI,UAAiC,WAAmB;AACxD,KAAI,CAAC,SAAS;AACZ,YAAU;GACR,SAAS,KAAA;GACT,SAAS,KAAA;GACV;AACA,aAAmB,WAAW;;AAEjC,QAAO;;AAGT,eAAsB,WAAW,MAAyB;CACxD,MAAM,UAAU,MAAM,YAAY;AAClC,KAAI,KAAK,QACP,SAAQ,UAAU,KAAK;AAEzB,KAAI,KAAK,QACP,SAAQ,UAAU,KAAK;;AAI3B,SAAgB,gBAAgB,SAAsB;CACpD,MAAM,eAAe,QAAQ,QAAQ;CACrC,MAAM,SAAS,OAAO,YAAY,aAAa,SAAS,CAAC;AACzD,QAAO;EACL,QAAQ,OAAO,UAAU;EACzB,QAAQ,OAAO,UAAU;EACzB;EACA;EACA;EACA,cAAc,QAAQ,QAAQ;EAC/B;;AAGH,MAAa,qBAAqB,MAChC,OAAO,UAAkE,MAAMA,WAAY,MAAM,CAClG;AAED,SAAgB,WAAW,EACzB,SAAS,OACT,OAAO,OACP,QAAQ,SAKP;AAqBD,QAAO;EAAE,WApBsB;GACrB;GACR,gBAAgB;GAChB;GACA,OAAO;GACP,YAAY;GACZ,OAAO;GACP;GACA,gBAAgB;GACjB;EAWmB,aAVa;GAC/B,QAAQ;GACR,gBAAgB;GAChB;GACA,OAAO;GACP,YAAY;GACZ,OAAO;GACP;GACA,gBAAgB;GACjB;EACgC;;;;;;;;;;AAWnC,eAAsBC,YAAU,EAC9B,SACA,QAAQ,SAOY;CACpB,MAAM,QAAQ,MAAM,cAAc,QAAmB;AACrD,QAAO,QAAQ,yBAAyB,SAAoB,MAAM,GAAG,oBAAoB,MAAM;;AAGjG,eAAsB,gBAAgB,EACpC,SACA,QACA,QACA,OAAO,OACP,QAAQ,SAOgB;CACxB,MAAM,aAAa,iBAAiB;EAAE;EAAS;EAAQ;EAAQ;EAAM;EAAO,CAAC;AAE7E,KAAI,OAAO;EACT,MAAM,UAAU,MAAM,MAAM;AAC5B,QAAM,WAAW,EAAE,SAAS,CAAC;AAC7B,SAAO;;CAET,MAAM,WAAW,YAAY;EAAE;EAAQ;EAAQ;EAAM,OAAO;EAAS,CAAC;CACtE,MAAM,UAAU,MAAM,oBAAoB,CAAC,MAAM,SAC/C,gBACM,8BACA;AACJ,QAAM,mBAAmB,SAAS;AAClC,SAAO,MAAM;GAEhB;AACD,OAAM,WAAW,EAAE,SAAS,CAAC;AAC7B,QAAO;;AAGT,eAAe,iBAAiB,EAC9B,SACA,QACA,QACA,MACA,SAOwB;CACxB,MAAM,EAAE,cAAc,WAAW;EAAE;EAAQ;EAAM;EAAO,CAAC;CAGzD,MAAM,CAAC,cAAc,eAAe,iBAAiB,UAAU,MAAM,QAAQ,IAAI;EAC/E,QAAQ,WAAW;GACjB,GAAG;GACH,MAAM;GACP,CAAC;EACF,QAAQ,KAAK;GACX,GAAG;GACH,YAAY;GACb,CAAC;EACF,QAAQ,KAAK;GACX,GAAG;GACH,YAAY;GACZ,OAAO;GACR,CAAC;EACFA,YAAU;GAAE;GAAS;GAAO,CAAC;EAC9B,CAAC;CACF,MAAM,UAAU,aAAa,MAAM,QAAQ,MAAM,EAAE,SAAS;CAC5D,MAAM,YAAY,QAAQ,KAAK,MAAM,EAAE,GAAG;CAC1C,MAAM,UAAU,cAAc,KAAK,QAAQ,MAAM,EAAE,SAAS;CAC5D,MAAM,YAAY,QAAQ,KAAK,MAAM,EAAE,GAAG;CAC1C,MAAM,aAAa,gBAAgB;AAGnC,QAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;EACA,eAVoB,aAAa,QAAQ,QAAQ,OAAO;EAW5C;EACZ,UAAU;EACX;;;;;;;;AASH,eAAsB,aAAa,QAAqB,OAAyB;AAC/E,KAAI,OAAO,UAAU,UACnB,QAAO;AAET,KAAI;AACF,UAAQ,MAAM,WAAW,EAAE;SACrB;AACN,SAAO;;;;;;;;;;;;;;;AAgBX,eAAsBC,aAAW,EAC/B,QACA,SACA,QAAQ,SAKP;CACD,MAAM,UAAU,MAAMF,WAAY,EAAE,QAAQ,CAAC;AAC7C,OAAM,WAAW,EAAW,SAAyB,CAAC;CAEtD,IAAI,OAA8B;AAClC,KAAI,QACF,KAAI;EACF,MAAM,OAAO,MAAM,QAAQ,KAAK;GAAE;GAAS,eAAe;GAAO,CAAC;AAClE,MAAI,KAAK,KACP,QAAO,KAAK;UAEP,OAAO;AACd,UAAQ,IAAI,oBAAoB,MAAM;;CAM1C,MAAM,2BAAW,IAAI,KAAoC;AACzD,QAAO;EACI;EACT;EACA;EACA,aAAa,QAAgB,WAAmB;GAC9C,MAAM,MAAM,GAAG,OAAO,GAAG;GACzB,IAAI,UAAU,SAAS,IAAI,IAAI;AAC/B,OAAI,CAAC,SAAS;AACZ,cAAU,gBAAgB;KAAE;KAAS;KAAQ;KAAQ;KAAM;KAAO,CAAC;AACnE,aAAS,IAAI,KAAK,QAAQ;AAC1B,YAAQ,YAAY,SAAS,OAAO,IAAI,CAAC;;AAE3C,UAAO;;EAEV;;AAGH,SAAgB,aAAa,QAAkB,QAAgB,QAA0B;AACvF,UAAS,WAAW,QAAQ,gBAAgB;AAC5C,UAAS,WAAW,QAAQ,gBAAgB;AAC5C,QAAO,OAAO,QAAQ,MAAM,EAAE,WAAW,UAAU,EAAE,WAAW,OAAO;;AAGzE,SAAgB,eAAe,OAA+C;AAC5E,KAAI,MACF,QAAO,IAAI,QAAQ,EAAE,eAAe,OAAO,MAAM,SAAS,CAAC;KAE3D,QAAO,IAAI,QAAQ,EAAE,eAAe,iBAAiB,QAAQ,IAAI,iBAAiB,CAAC;;;;;;;AASvF,SAAgB,iBAAiB,EAC/B,MACA,QACA,QAAQ,OACR,OACA,QACA,UACA,SAIC;AACD,QAAO;EACG;EACR,gBAAgB;EAChB;EACA;EAEA,MAAM,QAAQ;EACd,gBAAgB;EAChB,GAAI,WAAW,KAAA,IAAY,EAAE,QAAQ,GAAG,EAAE;EAC1C,GAAI,aAAa,KAAA,IAAY,EAAE,UAAU,GAAG,EAAE;EAE9C,GAAI,UAAU,KAAA,IAAa,EAAE,OAAO,GAAU,EAAE;EACjD;;;;;;AAOH,SAAgB,iBAAiB,MAAW,QAAgB,OAAiB;AAC3E,QAAO,iBAAiB;EAAE;EAAM;EAAQ;EAAO,OAAO;EAAG,CAAC"}
1
+ {"version":3,"file":"mixer.js","names":["getPayload_","getRoutes","getPayload"],"sources":["../../src/server/mixer.ts"],"sourcesContent":["import {\n defaultLocale,\n defaultMarket,\n ILocale,\n IMarket,\n IRoute,\n isObject,\n} from '@websolutespa/bom-core';\nimport type { Config, User } from '@websolutespa/payload-plugin-bowl';\nimport {\n getRouteStore,\n getRouteStoreDraftRoutes,\n getRouteStoreRoutes,\n onRouteStoreChange,\n} from '@websolutespa/payload-plugin-bowl';\nimport { draftMode } from 'next/headers';\nimport { NextRequest } from 'next/server';\nimport {\n BasePayload,\n getPayload as getPayload_,\n Payload,\n SanitizedConfig,\n TypedFallbackLocale,\n TypedLocale,\n} from 'payload';\nimport { cache } from 'react';\nimport { guest, PREVIEW_ROLES, previewer } from '../lib/const';\nimport { debug } from '../lib/debug';\nimport { TtlCache } from '../lib/ttl-cache';\nimport type {\n BaseOptions,\n DraftOption,\n IContext,\n MixerContext,\n ReadOptions,\n ReadonlyHeaders,\n} from '../types';\nimport type { MixerPayload } from './mixer-payload';\n\n// Context entries live for MEMORY_CACHE_DURATION seconds (default 300) and\n// are dropped as soon as the Bowl route store reports a change, locally or\n// from another instance through Redis.\nconst CONTEXT_CACHE_DURATION =\n (process.env.MEMORY_CACHE_DURATION ? parseInt(process.env.MEMORY_CACHE_DURATION) : 5 * 60) * 1000;\nconst CONTEXT_CACHE_MAX = 500;\n\ntype MixerCacheState = {\n cache: TtlCache<MixerContext>;\n subscribed?: boolean;\n};\n\nconst getMixerCacheState = (): MixerCacheState => {\n // A new global key: `_mixer` held an InMemoryCache in earlier versions and\n // can survive a dev hot reload with that shape.\n const globalForMixer = globalThis as typeof globalThis & { _bomMixerContext?: MixerCacheState };\n if (!globalForMixer._bomMixerContext) {\n globalForMixer._bomMixerContext = { cache: new TtlCache<MixerContext>(CONTEXT_CACHE_MAX) };\n }\n const state = globalForMixer._bomMixerContext;\n if (!state.subscribed) {\n state.subscribed = true;\n onRouteStoreChange(() => state.cache.clear());\n }\n return state;\n};\n\n/** Drops every cached mixer context on this instance. */\nexport function clearMixerContextCache() {\n getMixerCacheState().cache.clear();\n}\n\nexport function getCacheKey({\n market = 'all',\n locale = 'all',\n user = guest,\n draft = 'false',\n}: {\n market?: string;\n locale?: string;\n user?: User & Config['user'];\n draft?: string;\n}) {\n const roles = (user?.roles || ['guest']) as string[];\n const tenants = (\n 'tenants' in user && Array.isArray(user.tenants)\n ? user.tenants.map((x: any) => (isObject(x) ? x.id : x))\n : []\n ) as string[];\n roles.sort();\n tenants.sort();\n const keys = [market, locale, draft === 'false' ? 'published' : 'draft', ...roles, ...tenants];\n const key = `context-${keys.join('-')}`;\n return key;\n}\n\nexport async function getContext() {\n let context: IContext | undefined = (globalThis as any)._context;\n if (!context) {\n context = {\n payload: undefined,\n context: undefined,\n } as unknown as IContext;\n (globalThis as any)._context = context;\n }\n return context;\n}\n\nexport async function setContext(data: Partial<IContext>) {\n const context = await getContext();\n if (data.payload) {\n context.payload = data.payload;\n }\n if (data.context) {\n context.context = data.context;\n }\n}\n\nexport function getSearchParams(request: NextRequest) {\n const searchParams = request.nextUrl.searchParams;\n const params = Object.fromEntries(searchParams.entries());\n return {\n market: params.market || defaultMarket,\n locale: params.locale || defaultLocale,\n defaultMarket,\n defaultLocale,\n params,\n searchParams: request.nextUrl.searchParams,\n };\n}\n\nexport const getPayloadInstance = cache(\n async (props: { config: SanitizedConfig | Promise<SanitizedConfig> }) => await getPayload_(props)\n);\n\nexport function getOptions({\n locale = 'all',\n user = guest,\n draft = false,\n}: {\n locale?: string;\n user?: User & Config['user'];\n draft?: boolean;\n}) {\n const localized: BaseOptions = {\n locale: locale as TypedLocale,\n fallbackLocale: defaultLocale as TypedLocale,\n draft,\n depth: 0,\n pagination: false,\n limit: 10000,\n user,\n overrideAccess: false,\n };\n const unlocalized: BaseOptions = {\n locale: 'all',\n fallbackLocale: defaultLocale as TypedLocale,\n draft,\n depth: 0,\n pagination: false,\n limit: 10000,\n user,\n overrideAccess: false,\n };\n return { localized, unlocalized };\n}\n\n/**\n * Returns all routes from the Bowl route store: published routes, or the\n * published routes overlaid with draft pages when `draft` is true.\n *\n * The route store is Guest-readable by design (see payload-plugin-bowl's\n * \"Route Resolution\"), so `market`, `locale` and `user` no longer change the\n * result; they are kept for backward compatibility.\n */\nexport async function getRoutes({\n payload,\n draft = false,\n}: {\n payload: BasePayload;\n market?: string;\n locale?: string;\n user?: User & Config['user'];\n draft?: boolean;\n}): Promise<IRoute[]> {\n const store = await getRouteStore(payload as Payload);\n return draft ? getRouteStoreDraftRoutes(payload as Payload, store) : getRouteStoreRoutes(store);\n}\n\nexport async function getMixerContext({\n payload,\n market,\n locale,\n user = guest,\n draft = false,\n}: {\n payload: BasePayload;\n market: string;\n locale: string;\n user?: User & Config['user'];\n draft?: boolean;\n}): Promise<MixerContext> {\n const load = () => loadMixerContext({ payload, market, locale, user, draft });\n // Draft previews must reflect the latest save, so they are never cached.\n if (draft) {\n const context = await load();\n await setContext({ context });\n return context;\n }\n const cacheKey = getCacheKey({ market, locale, user, draft: 'false' });\n const context = await getMixerCacheState().cache.getOrSet(\n cacheKey,\n () => CONTEXT_CACHE_DURATION,\n () => {\n debug('getContext miss', cacheKey);\n return load();\n }\n );\n await setContext({ context });\n return context;\n}\n\nasync function loadMixerContext({\n payload,\n market,\n locale,\n user,\n draft,\n}: {\n payload: BasePayload;\n market: string;\n locale: string;\n user: User & Config['user'];\n draft: boolean;\n}): Promise<MixerContext> {\n const { localized } = getOptions({ locale, user, draft });\n // Independent reads: run them concurrently. Routes come from the route\n // store, which keeps pages and media in memory.\n const [localeResult, marketRequest, categoryRequest, routes] = await Promise.all([\n payload.findGlobal({\n ...localized,\n slug: 'locale',\n }) as Promise<{ items: ILocale[] }>,\n payload.find({\n ...localized,\n collection: 'market',\n }),\n payload.find({\n ...localized,\n collection: 'category',\n depth: 2,\n }),\n getRoutes({ payload, draft }),\n ]);\n const locales = localeResult.items.filter((x) => x.isActive) as unknown as ILocale[];\n const localeIds = locales.map((x) => x.id) as string[];\n const markets = marketRequest.docs.filter((x) => x.isActive) as unknown as IMarket[];\n const marketIds = markets.map((x) => x.id);\n const categories = categoryRequest.docs;\n const currentRoutes = filterRoutes(routes, market, locale);\n\n return {\n locale,\n localeIds,\n locales,\n market,\n marketIds,\n markets,\n routes,\n currentRoutes,\n categories: categories as unknown as MixerContext['categories'],\n richText: false,\n };\n}\n\n/** Whether the user has an editing role, the ones Bowl serves drafts to. */\nfunction hasPreviewRole(user: User | null | undefined): boolean {\n const roles = ((user as { roles?: string[] } | null)?.roles ?? []) as string[];\n return roles.some((role) => PREVIEW_ROLES.includes(role));\n}\n\n/**\n * Resolves a draft option to a boolean.\n * Defaults to `false`. `'auto'` is an explicit opt-in that reads Next's `draftMode()`\n * (a cookie read); outside a request scope (build, scripts) it resolves to false.\n * Prefer passing `(await draftMode()).isEnabled` from the template.\n */\nexport async function resolveDraft(draft: DraftOption = false): Promise<boolean> {\n if (typeof draft === 'boolean') {\n return draft;\n }\n try {\n return (await draftMode()).isEnabled;\n } catch {\n return false;\n }\n}\n\n/**\n * Runtime (request-time) payload accessor.\n *\n * By default, operates as the guest user for static generation. For auth:\n * call getHeaders() directly in your page/route/layout, then pass it here.\n * This function never reads request data itself: in draft mode pass the\n * request `headers` too, otherwise drafts are read as the guest user.\n *\n * Example:\n * const headers = await getHeaders();\n * const { payload, user, getContext } = await getPayload({ config, headers });\n */\nexport async function getPayload({\n config,\n headers,\n draft: requestedDraft = false,\n}: {\n config: Promise<SanitizedConfig>;\n headers?: ReadonlyHeaders;\n draft?: boolean;\n}) {\n const payload = await getPayload_({ config });\n await setContext({ payload: payload as MixerPayload });\n\n let user: User & Config['user'] = guest;\n if (headers) {\n try {\n const auth = await payload.auth({ headers, canSetHeaders: false });\n if (auth.user) {\n user = auth.user as typeof user;\n }\n } catch (error) {\n console.log('getPayload.error', error);\n }\n }\n\n // a draft read as a non-editor: the previewer identity while Draft Mode is on (an editor turned it on, see\n // getPreviewHandler), the published site otherwise. Bowl serves drafts to the editing roles only.\n let draft = requestedDraft;\n if (draft && !hasPreviewRole(user)) {\n // only an actual Draft Mode request: the cookie read happens on the draft path alone, which is dynamic anyway\n draft = await resolveDraft('auto');\n if (draft) {\n user = previewer;\n }\n }\n\n // Draft contexts bypass the shared cache, so share them at least between\n // the callers of this instance (one request when obtained per request).\n const contexts = new Map<string, Promise<MixerContext>>();\n return {\n payload: payload as MixerPayload,\n user,\n draft,\n getContext: (market: string, locale: string) => {\n const key = `${market}|${locale}`;\n let context = contexts.get(key);\n if (!context) {\n context = getMixerContext({ payload, market, locale, user, draft });\n contexts.set(key, context);\n context.catch(() => contexts.delete(key));\n }\n return context;\n },\n };\n}\n\nexport function filterRoutes(routes: IRoute[], market: string, locale: string): IRoute[] {\n market = market === 'all' ? defaultMarket : market;\n locale = locale === 'all' ? defaultLocale : locale;\n return routes.filter((x) => x.market === market && x.locale === locale);\n}\n\nexport function getAuthHeaders(token: { value: string } | undefined): Headers {\n if (token) {\n return new Headers({ Authorization: `JWT ${token.value}` });\n } else {\n return new Headers({ Authorization: `users API-Key ${process.env.STORE_API_KEY}` });\n }\n}\n\n/**\n * Produces the read options shared across payload.find / findByID / findGlobal calls.\n * For payload.find, add pagination: false and limit: 10000 at the call site.\n * `select`, `populate` and `joins` are only included when provided.\n */\nexport function buildReadOptions({\n user,\n locale,\n draft = false,\n depth,\n select,\n populate,\n joins,\n}: ReadOptions & {\n user: any;\n locale: string;\n}) {\n return {\n locale: locale as TypedLocale,\n fallbackLocale: defaultLocale as TypedFallbackLocale,\n draft,\n depth,\n // the logged in user or the guest: bowl decorates only reads with a user, as for the http api\n user: user || guest,\n overrideAccess: false,\n ...(select !== undefined ? { select } : {}),\n ...(populate !== undefined ? { populate } : {}),\n // joins are collection specific: typed by the caller's options, untyped here\n ...(joins !== undefined ? ({ joins } as {}) : {}),\n };\n}\n\n/**\n * @deprecated Use `buildReadOptions({ user, locale, draft, depth })`.\n * Kept for backward compatibility: reads at depth 0.\n */\nexport function buildBaseOptions(user: any, locale: string, draft?: boolean) {\n return buildReadOptions({ user, locale, draft, depth: 0 });\n}\n\n/**\n * Payload proxy example\n *\n *\n * import type { Payload, PayloadRequest } from '../types/index.js'\n\nimport { commitTransaction } from './commitTransaction.js'\nimport { initTransaction } from './initTransaction.js'\nimport { killTransaction } from './killTransaction.js'\n\nconst localOperations = [\n 'count',\n 'countGlobalVersions',\n 'countVersions',\n 'create',\n 'delete',\n 'duplicate',\n 'find',\n 'findByID',\n 'delete',\n 'duplicate',\n 'find',\n 'findByID',\n 'findGlobal',\n 'findGlobalVersionByID',\n 'findGlobalVersions',\n 'findVersionByID',\n 'findVersionByID',\n 'login',\n 'update',\n 'updateGlobal',\n 'restoreVersion',\n 'restoreGlobalVersion',\n] satisfies (keyof Payload)[]\n\ntype LocalOperation = (typeof localOperations)[number]\n\nconst isLocalOperation = (key: string): key is LocalOperation => {\n return localOperations.includes(key as LocalOperation)\n}\n\nexport const withTransaction = async <T>(\n payload: Payload,\n callback: (transaction: Payload) => Promise<T>,\n) => {\n const transactionReq = { payload } as PayloadRequest\n await initTransaction(transactionReq)\n\n const proxy = new Proxy(payload, {\n get(target, property: keyof Payload, receiver) {\n if (isLocalOperation(property)) {\n const operation = Reflect.get(target, property, receiver)\n\n return function (options) {\n let req: Partial<PayloadRequest> = options.req\n\n if (!req) {\n req = {}\n }\n\n if (!req.transactionID) {\n req = { ...req, transactionID: transactionReq.transactionID }\n }\n\n return (operation as (...args: unknown[]) => void)({\n ...options,\n req,\n })\n }\n }\n\n return Reflect.get(target, property, receiver)\n },\n })\n\n try {\n const result = await callback(proxy)\n await commitTransaction(transactionReq)\n return result\n } catch (e) {\n await killTransaction(transactionReq)\n throw e\n }\n}\n\n// -----------------\n\nconst { one, two } = await withTransaction(payload, async (transaction) => {\n const one = await transaction.create({ collection: 'posts', data: { title: 'one' } })\n const two = await transaction.create({ collection: 'posts', data: { title: 'two' } })\n\n return { one, two }\n})\n\n */\n"],"mappings":";;;;;;;;;AA0CA,MAAM,0BACH,QAAQ,IAAI,wBAAwB,SAAS,QAAQ,IAAI,sBAAsB,GAAG,OAAU;AAC/F,MAAM,oBAAoB;AAO1B,MAAM,2BAA4C;CAGhD,MAAM,iBAAiB;AACvB,KAAI,CAAC,eAAe,iBAClB,gBAAe,mBAAmB,EAAE,OAAO,IAAI,SAAuB,kBAAkB,EAAE;CAE5F,MAAM,QAAQ,eAAe;AAC7B,KAAI,CAAC,MAAM,YAAY;AACrB,QAAM,aAAa;AACnB,2BAAyB,MAAM,MAAM,OAAO,CAAC;;AAE/C,QAAO;;;AAIT,SAAgB,yBAAyB;AACvC,qBAAoB,CAAC,MAAM,OAAO;;AAGpC,SAAgB,YAAY,EAC1B,SAAS,OACT,SAAS,OACT,OAAO,OACP,QAAQ,WAMP;CACD,MAAM,QAAS,MAAM,SAAS,CAAC,QAAQ;CACvC,MAAM,UACJ,aAAa,QAAQ,MAAM,QAAQ,KAAK,QAAQ,GAC5C,KAAK,QAAQ,KAAK,MAAY,SAAS,EAAE,GAAG,EAAE,KAAK,EAAG,GACtD,EAAE;AAER,OAAM,MAAM;AACZ,SAAQ,MAAM;AAGd,QADY,WADC;EAAC;EAAQ;EAAQ,UAAU,UAAU,cAAc;EAAS,GAAG;EAAO,GAAG;EAAQ,CAClE,KAAK,IAAI;;AAIvC,eAAsB,aAAa;CACjC,IAAI,UAAiC,WAAmB;AACxD,KAAI,CAAC,SAAS;AACZ,YAAU;GACR,SAAS,KAAA;GACT,SAAS,KAAA;GACV;AACA,aAAmB,WAAW;;AAEjC,QAAO;;AAGT,eAAsB,WAAW,MAAyB;CACxD,MAAM,UAAU,MAAM,YAAY;AAClC,KAAI,KAAK,QACP,SAAQ,UAAU,KAAK;AAEzB,KAAI,KAAK,QACP,SAAQ,UAAU,KAAK;;AAI3B,SAAgB,gBAAgB,SAAsB;CACpD,MAAM,eAAe,QAAQ,QAAQ;CACrC,MAAM,SAAS,OAAO,YAAY,aAAa,SAAS,CAAC;AACzD,QAAO;EACL,QAAQ,OAAO,UAAU;EACzB,QAAQ,OAAO,UAAU;EACzB;EACA;EACA;EACA,cAAc,QAAQ,QAAQ;EAC/B;;AAGH,MAAa,qBAAqB,MAChC,OAAO,UAAkE,MAAMA,WAAY,MAAM,CAClG;AAED,SAAgB,WAAW,EACzB,SAAS,OACT,OAAO,OACP,QAAQ,SAKP;AAqBD,QAAO;EAAE,WApBsB;GACrB;GACR,gBAAgB;GAChB;GACA,OAAO;GACP,YAAY;GACZ,OAAO;GACP;GACA,gBAAgB;GACjB;EAWmB,aAVa;GAC/B,QAAQ;GACR,gBAAgB;GAChB;GACA,OAAO;GACP,YAAY;GACZ,OAAO;GACP;GACA,gBAAgB;GACjB;EACgC;;;;;;;;;;AAWnC,eAAsBC,YAAU,EAC9B,SACA,QAAQ,SAOY;CACpB,MAAM,QAAQ,MAAM,cAAc,QAAmB;AACrD,QAAO,QAAQ,yBAAyB,SAAoB,MAAM,GAAG,oBAAoB,MAAM;;AAGjG,eAAsB,gBAAgB,EACpC,SACA,QACA,QACA,OAAO,OACP,QAAQ,SAOgB;CACxB,MAAM,aAAa,iBAAiB;EAAE;EAAS;EAAQ;EAAQ;EAAM;EAAO,CAAC;AAE7E,KAAI,OAAO;EACT,MAAM,UAAU,MAAM,MAAM;AAC5B,QAAM,WAAW,EAAE,SAAS,CAAC;AAC7B,SAAO;;CAET,MAAM,WAAW,YAAY;EAAE;EAAQ;EAAQ;EAAM,OAAO;EAAS,CAAC;CACtE,MAAM,UAAU,MAAM,oBAAoB,CAAC,MAAM,SAC/C,gBACM,8BACA;AACJ,QAAM,mBAAmB,SAAS;AAClC,SAAO,MAAM;GAEhB;AACD,OAAM,WAAW,EAAE,SAAS,CAAC;AAC7B,QAAO;;AAGT,eAAe,iBAAiB,EAC9B,SACA,QACA,QACA,MACA,SAOwB;CACxB,MAAM,EAAE,cAAc,WAAW;EAAE;EAAQ;EAAM;EAAO,CAAC;CAGzD,MAAM,CAAC,cAAc,eAAe,iBAAiB,UAAU,MAAM,QAAQ,IAAI;EAC/E,QAAQ,WAAW;GACjB,GAAG;GACH,MAAM;GACP,CAAC;EACF,QAAQ,KAAK;GACX,GAAG;GACH,YAAY;GACb,CAAC;EACF,QAAQ,KAAK;GACX,GAAG;GACH,YAAY;GACZ,OAAO;GACR,CAAC;EACFA,YAAU;GAAE;GAAS;GAAO,CAAC;EAC9B,CAAC;CACF,MAAM,UAAU,aAAa,MAAM,QAAQ,MAAM,EAAE,SAAS;CAC5D,MAAM,YAAY,QAAQ,KAAK,MAAM,EAAE,GAAG;CAC1C,MAAM,UAAU,cAAc,KAAK,QAAQ,MAAM,EAAE,SAAS;CAC5D,MAAM,YAAY,QAAQ,KAAK,MAAM,EAAE,GAAG;CAC1C,MAAM,aAAa,gBAAgB;AAGnC,QAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;EACA,eAVoB,aAAa,QAAQ,QAAQ,OAAO;EAW5C;EACZ,UAAU;EACX;;;AAIH,SAAS,eAAe,MAAwC;AAE9D,SADgB,MAAsC,SAAS,EAAE,EACpD,MAAM,SAAS,cAAc,SAAS,KAAK,CAAC;;;;;;;;AAS3D,eAAsB,aAAa,QAAqB,OAAyB;AAC/E,KAAI,OAAO,UAAU,UACnB,QAAO;AAET,KAAI;AACF,UAAQ,MAAM,WAAW,EAAE;SACrB;AACN,SAAO;;;;;;;;;;;;;;;AAgBX,eAAsBC,aAAW,EAC/B,QACA,SACA,OAAO,iBAAiB,SAKvB;CACD,MAAM,UAAU,MAAMF,WAAY,EAAE,QAAQ,CAAC;AAC7C,OAAM,WAAW,EAAW,SAAyB,CAAC;CAEtD,IAAI,OAA8B;AAClC,KAAI,QACF,KAAI;EACF,MAAM,OAAO,MAAM,QAAQ,KAAK;GAAE;GAAS,eAAe;GAAO,CAAC;AAClE,MAAI,KAAK,KACP,QAAO,KAAK;UAEP,OAAO;AACd,UAAQ,IAAI,oBAAoB,MAAM;;CAM1C,IAAI,QAAQ;AACZ,KAAI,SAAS,CAAC,eAAe,KAAK,EAAE;AAElC,UAAQ,MAAM,aAAa,OAAO;AAClC,MAAI,MACF,QAAO;;CAMX,MAAM,2BAAW,IAAI,KAAoC;AACzD,QAAO;EACI;EACT;EACA;EACA,aAAa,QAAgB,WAAmB;GAC9C,MAAM,MAAM,GAAG,OAAO,GAAG;GACzB,IAAI,UAAU,SAAS,IAAI,IAAI;AAC/B,OAAI,CAAC,SAAS;AACZ,cAAU,gBAAgB;KAAE;KAAS;KAAQ;KAAQ;KAAM;KAAO,CAAC;AACnE,aAAS,IAAI,KAAK,QAAQ;AAC1B,YAAQ,YAAY,SAAS,OAAO,IAAI,CAAC;;AAE3C,UAAO;;EAEV;;AAGH,SAAgB,aAAa,QAAkB,QAAgB,QAA0B;AACvF,UAAS,WAAW,QAAQ,gBAAgB;AAC5C,UAAS,WAAW,QAAQ,gBAAgB;AAC5C,QAAO,OAAO,QAAQ,MAAM,EAAE,WAAW,UAAU,EAAE,WAAW,OAAO;;AAGzE,SAAgB,eAAe,OAA+C;AAC5E,KAAI,MACF,QAAO,IAAI,QAAQ,EAAE,eAAe,OAAO,MAAM,SAAS,CAAC;KAE3D,QAAO,IAAI,QAAQ,EAAE,eAAe,iBAAiB,QAAQ,IAAI,iBAAiB,CAAC;;;;;;;AASvF,SAAgB,iBAAiB,EAC/B,MACA,QACA,QAAQ,OACR,OACA,QACA,UACA,SAIC;AACD,QAAO;EACG;EACR,gBAAgB;EAChB;EACA;EAEA,MAAM,QAAQ;EACd,gBAAgB;EAChB,GAAI,WAAW,KAAA,IAAY,EAAE,QAAQ,GAAG,EAAE;EAC1C,GAAI,aAAa,KAAA,IAAY,EAAE,UAAU,GAAG,EAAE;EAE9C,GAAI,UAAU,KAAA,IAAa,EAAE,OAAO,GAAU,EAAE;EACjD;;;;;;AAOH,SAAgB,iBAAiB,MAAW,QAAgB,OAAiB;AAC3E,QAAO,iBAAiB;EAAE;EAAM;EAAQ;EAAO,OAAO;EAAG,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@websolutespa/bom-next",
3
- "version": "4.0.0-next.11",
3
+ "version": "4.0.0-next.13",
4
4
  "description": "Next module of the BOM Repository",
5
5
  "keywords": [
6
6
  "bom",
@@ -47,7 +47,7 @@
47
47
  "@websolutespa/bom-cli": "^4.0.0-next.11",
48
48
  "@websolutespa/bom-core": "^4.0.0-next.10",
49
49
  "@websolutespa/oxc": "^4.0.0-next.10",
50
- "@websolutespa/payload-plugin-bowl": "^4.0.0-next.11",
50
+ "@websolutespa/payload-plugin-bowl": "^4.0.0-next.12",
51
51
  "@websolutespa/payload-utils": "^4.0.0-next.10",
52
52
  "@websolutespa/test": "^4.0.0-next.10",
53
53
  "@websolutespa/tsconfig": "^4.0.0-next.10",
@@ -1,6 +1,13 @@
1
1
  // @vitest-environment node
2
2
  import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
3
- import { createRedisCacheHandler, decode, encode, type RedisLike } from './redis';
3
+ import {
4
+ connectRedisClient,
5
+ createRedisCacheHandler,
6
+ decode,
7
+ encode,
8
+ getRedisClient,
9
+ type RedisLike,
10
+ } from './redis';
4
11
 
5
12
  /** An in-memory stand-in for the redis client subset the handler uses. */
6
13
  function fakeRedis(): RedisLike & {
@@ -138,6 +145,31 @@ describe('redis cache handler', () => {
138
145
  expect(await handler.get('/p', {})).toBeNull();
139
146
  });
140
147
 
148
+ it('returns the stored lifetime, so another instance applies it instead of revalidating after 1 s', async () => {
149
+ const handler = new Handler();
150
+ await handler.set('/p', page('bom:all'), pageCtx);
151
+ expect(await handler.get('/p', {})).toMatchObject({
152
+ cacheControl: { revalidate: 3600, expire: 31536000 },
153
+ });
154
+ // the stale path keeps the lifetime: Next.js computes the stale time from it
155
+ vi.advanceTimersByTime(1000);
156
+ await handler.revalidateTag('bom:all', { expire: 31536000 });
157
+ const stale = await handler.get('/p', {});
158
+ expect(stale!.cacheControl).toEqual({ revalidate: 3600, expire: 31536000 });
159
+ expect(stale!.lastModified + 3600 * 1000).toBeLessThan(Date.now());
160
+ });
161
+
162
+ it('derives the lifetime of an entry written before cacheControl was stored', async () => {
163
+ const legacy = { lastModified: Date.now(), tags: [], revalidate: 900, value: page('') };
164
+ redis.store.set('bom:next:/old', encode(legacy));
165
+ expect((await new Handler().get('/old', {}))!.cacheControl).toEqual({
166
+ revalidate: 900,
167
+ expire: undefined,
168
+ });
169
+ redis.store.set('bom:next:/none', encode({ ...legacy, revalidate: null }));
170
+ expect((await new Handler().get('/none', {}))!.cacheControl).toBeUndefined();
171
+ });
172
+
141
173
  it('deletes on null and never throws while Redis is not ready', async () => {
142
174
  const handler = new Handler();
143
175
  await handler.set('/p', page('bom:all'), pageCtx);
@@ -151,3 +183,48 @@ describe('redis cache handler', () => {
151
183
  await expect(offline.revalidateTag('x')).resolves.toBeUndefined();
152
184
  });
153
185
  });
186
+
187
+ describe('shared redis client', () => {
188
+ afterEach(() => {
189
+ delete process.env.REDIS_URL;
190
+ delete (globalThis as { __bomRedisClient?: unknown }).__bomRedisClient;
191
+ });
192
+
193
+ it('is undefined without REDIS_URL', async () => {
194
+ expect(await getRedisClient()).toBeUndefined();
195
+ expect(await connectRedisClient(10)).toBeUndefined();
196
+ });
197
+
198
+ it('is one client per process, shared through globalThis, and waits for it to be ready', async () => {
199
+ const listeners = new Map<string, () => void>();
200
+ const client = {
201
+ isReady: false,
202
+ on: () => client,
203
+ once: (event: string, listener: () => void) => listeners.set(event, listener),
204
+ off: (event: string) => listeners.delete(event),
205
+ };
206
+ (globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
207
+ process.env.REDIS_URL = 'redis://localhost:6379';
208
+ expect(await getRedisClient()).toBeUndefined();
209
+ const connecting = connectRedisClient(2000);
210
+ await vi.advanceTimersByTimeAsync(10);
211
+ client.isReady = true;
212
+ listeners.get('ready')!();
213
+ expect(await connecting).toBe(client);
214
+ });
215
+
216
+ it('gives up after the timeout and leaves no listener behind', async () => {
217
+ const listeners = new Map<string, () => void>();
218
+ const client = {
219
+ isReady: false,
220
+ once: (event: string, listener: () => void) => listeners.set(event, listener),
221
+ off: (event: string) => listeners.delete(event),
222
+ };
223
+ (globalThis as { __bomRedisClient?: unknown }).__bomRedisClient = client;
224
+ process.env.REDIS_URL = 'redis://localhost:6379';
225
+ const connecting = connectRedisClient(2000);
226
+ await vi.advanceTimersByTimeAsync(2001);
227
+ expect(await connecting).toBeUndefined();
228
+ expect(listeners.size).toBe(0);
229
+ });
230
+ });