@justanarthur/payload-www 0.3.5 → 1.2.0

package/dist/render-metadata.js

@@ -1,390 +0,0 @@
-
-var __defProp = Object.defineProperty;
-var __returnValue = (v) => v;
-function __exportSetter(name, newValue) {
-  this[name] = __returnValue.bind(null, newValue);
-}
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, {
-      get: all[name],
-      enumerable: true,
-      configurable: true,
-      set: __exportSetter.bind(all, name)
-    });
-};
-var __esm = (fn, res) => () => (fn && (res = fn(fn = 0)), res);
-
-// src/render/metadata/jsonld.ts
-function getImageUrl(doc, siteUrl) {
-  const img = doc?.meta?.image ?? doc?.heroImage ?? doc?.image;
-  if (!img)
-    return null;
-  if (typeof img === "string")
-    return img;
-  if (img?.url)
-    return img.url.startsWith("http") ? img.url : `${siteUrl}${img.url}`;
-  return null;
-}
-function getImageUrlWithLog(doc, siteUrl) {
-  const result = getImageUrl(doc, siteUrl);
-  console.log("[WWW] render/metadata:jsonld:getImageUrl ->", result);
-  return result;
-}
-function resolveLocalizedField(value, locale) {
-  if (value == null)
-    return "";
-  if (typeof value === "string") {
-    if (!value.startsWith("{"))
-      return value;
-    try {
-      const parsed = JSON.parse(value);
-      return resolveLocalizedField(parsed, locale);
-    } catch {
-      return value;
-    }
-  }
-  if (typeof value !== "object")
-    return "";
-  const obj = value;
-  if (typeof obj[locale] === "string" && obj[locale].length > 0) {
-    return obj[locale];
-  }
-  return Object.values(obj).filter((v) => typeof v === "string" && v.length > 0).join(" / ");
-}
-function resolveLocalizedFieldWithLog(value, locale) {
-  const result = resolveLocalizedField(value, locale);
-  if (value && typeof value === "object") {
-    console.log("[WWW] render/metadata:jsonld:resolveLocalizedField locale=", locale, "->", JSON.stringify(result));
-  }
-  return result;
-}
-function buildArticleLd({
-  doc,
-  url,
-  locale,
-  siteUrl,
-  type = "BlogPosting",
-  publisherName,
-  publisherLogo
-}) {
-  const name = publisherName ?? new URL(siteUrl).hostname;
-  console.log("[WWW] render/metadata:buildArticleLd url=", url, "locale=", locale, "type=", type, "publisherName=", name);
-  const ld = {
-    "@context": "https://schema.org",
-    "@type": type,
-    "@id": `${url}#article`,
-    headline: resolveLocalizedFieldWithLog(doc.title, locale),
-    description: resolveLocalizedFieldWithLog(doc.meta?.description ?? doc.description ?? doc.excerpt, locale),
-    inLanguage: locale,
-    url,
-    dateModified: doc.updatedAt ? new Date(doc.updatedAt).toISOString() : undefined
-  };
-  const datePublished = doc.publishedAt ?? doc.createdAt;
-  if (datePublished)
-    ld.datePublished = new Date(datePublished).toISOString();
-  const imgUrl = getImageUrlWithLog(doc, siteUrl);
-  if (imgUrl)
-    ld.image = imgUrl;
-  ld.author = { "@type": "Organization", name, url: siteUrl };
-  const publisher = { "@type": "Organization", name };
-  if (publisherLogo !== undefined) {
-    if (publisherLogo !== null)
-      publisher.logo = { "@type": "ImageObject", url: publisherLogo };
-  }
-  ld.publisher = publisher;
-  return ld;
-}
-function buildBreadcrumbsLd({
-  items,
-  currentUrl
-}) {
-  console.log("[WWW] render/metadata:buildBreadcrumbsLd items=", items.length, "currentUrl=", currentUrl);
-  return {
-    "@context": "https://schema.org",
-    "@type": "BreadcrumbList",
-    itemListElement: items.map((item, index) => ({
-      "@type": "ListItem",
-      position: index + 1,
-      name: item.label,
-      item: index === items.length - 1 ? currentUrl : item.url
-    }))
-  };
-}
-function buildOrganizationLd({
-  siteUrl,
-  name,
-  logo,
-  sameAs
-}) {
-  console.log("[WWW] render/metadata:buildOrganizationLd siteUrl=", siteUrl, "name=", name, "logo?", Boolean(logo), "sameAs?", Boolean(sameAs));
-  const org = {
-    "@context": "https://schema.org",
-    "@type": "Organization",
-    "@id": `${siteUrl}#organization`,
-    url: siteUrl,
-    ...name && { name },
-    ...logo && { logo: { "@type": "ImageObject", url: logo } },
-    ...sameAs && sameAs.length > 0 && { sameAs }
-  };
-  return org;
-}
-
-// src/render/metadata/hreflang.ts
-async function buildHreflangAlternates({
-  siteUrl,
-  locale,
-  urlPrefix,
-  storedSlug,
-  queryAllLocaleSlugs,
-  nested,
-  homeSlug,
-  defaultLocale,
-  locales,
-  localePrefix = "always"
-}) {
-  const allLocaleSlugs = await queryAllLocaleSlugs(storedSlug, locale);
-  console.log("[WWW] render/metadata:buildHreflangAlternates storedSlug=", storedSlug, "locale=", locale, "allLocaleSlugs=", JSON.stringify(allLocaleSlugs));
-  const languages = {};
-  const urlFor = (l, slug) => {
-    const trimmedPrefix = urlPrefix.replace(/^\/|\/$/g, "");
-    const prefixSegment = trimmedPrefix ? `/${trimmedPrefix}` : "";
-    const urlPath = slug === homeSlug ? "/" : nested ? "/" + slug.replaceAll("_", "/") : "/" + slug;
-    const localeSegment = localePrefix === "never" ? "" : localePrefix === "as-needed" && l === defaultLocale ? "" : `/${l}`;
-    return `${siteUrl}${localeSegment}${prefixSegment}${urlPath}`;
-  };
-  for (const l of locales) {
-    const slugForLocale = allLocaleSlugs?.[l];
-    if (!slugForLocale)
-      continue;
-    languages[l] = urlFor(l, slugForLocale);
-  }
-  if (allLocaleSlugs?.[defaultLocale]) {
-    languages["x-default"] = urlFor(defaultLocale, allLocaleSlugs[defaultLocale]);
-  }
-  console.log("[WWW] render/metadata:buildHreflangAlternates ->", JSON.stringify(languages));
-  return languages;
-}
-
-// src/render/metadata/slug.ts
-var SLUG_NESTED_DIVIDER = "_";
-function segmentsToStoredSlug(segments, nested) {
-  if (!Array.isArray(segments)) {
-    console.log("[WWW] render/metadata:segmentsToStoredSlug string passthrough:", JSON.stringify(segments));
-    return segments;
-  }
-  const result = nested ? segments.join(SLUG_NESTED_DIVIDER) : segments[0] ?? "";
-  console.log("[WWW] render/metadata:segmentsToStoredSlug nested=", nested, "segments=", JSON.stringify(segments), "->", result);
-  return result;
-}
-function segmentsToUrlPath(segments, nested) {
-  let result;
-  if (!Array.isArray(segments))
-    result = "/" + segments;
-  else if (nested)
-    result = "/" + segments.join("/");
-  else
-    result = "/" + (segments[0] ?? "");
-  console.log("[WWW] render/metadata:segmentsToUrlPath nested=", nested, "segments=", JSON.stringify(segments), "->", result);
-  return result;
-}
-function storedSlugToSegments(storedSlug, nested) {
-  const result = nested ? storedSlug.split(SLUG_NESTED_DIVIDER) : storedSlug;
-  console.log("[WWW] render/metadata:storedSlugToSegments nested=", nested, "storedSlug=", storedSlug, "->", JSON.stringify(result));
-  return result;
-}
-function buildCanonicalUrl({
-  siteUrl,
-  locale,
-  urlPrefix,
-  urlPath
-}) {
-  const trimmedPrefix = urlPrefix.replace(/^\/|\/$/g, "");
-  const prefixSegment = trimmedPrefix ? `/${trimmedPrefix}` : "";
-  const result = `${siteUrl}/${locale}${prefixSegment}${urlPath}`;
-  console.log("[WWW] render/metadata:buildCanonicalUrl siteUrl=", siteUrl, "locale=", locale, "urlPrefix=", urlPrefix, "urlPath=", urlPath, "->", result);
-  return result;
-}
-function getUrlPath(segments, nested, homeSlug) {
-  const urlPath = segmentsToUrlPath(segments, nested);
-  if (nested && !Array.isArray(segments)) {
-    if (segments === homeSlug)
-      return "/";
-  } else if (nested && Array.isArray(segments)) {
-    const stored = segments.join(SLUG_NESTED_DIVIDER);
-    if (stored === homeSlug)
-      return "/";
-  }
-  return urlPath;
-}
-
-// src/render/metadata/query.ts
-import { getPayload } from "payload";
-import { cache } from "react";
-
-// src/core/utils/getFromImportMap.ts
-function getFromImportMap(key, importMap) {
-  return importMap[key.includes("#") ? key : key + "#default"];
-}
-
-// src/render/metadata/query.ts
-var queryDocBySlug = cache(async function queryDocBySlug2({
-  collectionSlug,
-  slug,
-  slugField = "slug",
-  locale,
-  draft = false,
-  config
-}) {
-  console.log("[WWW] render/metadata:queryDocBySlug collection=", collectionSlug, "slug=", slug, "slugField=", slugField, "locale=", locale, "draft=", draft);
-  const payload = await getPayload({ config });
-  const result = await payload.find({
-    collection: collectionSlug,
-    draft,
-    limit: 1,
-    pagination: false,
-    overrideAccess: draft,
-    where: { [slugField]: { equals: slug } },
-    locale
-  });
-  const doc = result.docs?.[0] ?? null;
-  console.log("[WWW] render/metadata:queryDocBySlug ->", doc ? "hit" : "miss");
-  return doc;
-});
-var queryAllDocs = cache(async function queryAllDocs2({
-  collectionSlug,
-  slugField = "slug",
-  locale,
-  config
-}) {
-  console.log("[WWW] render/metadata:queryAllDocs collection=", collectionSlug, "locale=", locale);
-  const payload = await getPayload({ config });
-  const result = await payload.find({
-    collection: collectionSlug,
-    draft: false,
-    limit: 1000,
-    pagination: false,
-    overrideAccess: false,
-    select: { [slugField]: true },
-    locale
-  });
-  const docs = result.docs ?? [];
-  console.log("[WWW] render/metadata:queryAllDocs -> count=", docs.length);
-  return docs;
-});
-var queryAllLocaleSlugs = cache(async function queryAllLocaleSlugs2({
-  collectionSlug,
-  slug,
-  slugField = "slug",
-  locale,
-  config
-}) {
-  console.log("[WWW] render/metadata:queryAllLocaleSlugs collection=", collectionSlug, "slug=", slug, "locale=", locale);
-  const payload = await getPayload({ config });
-  const result = await payload.find({
-    collection: collectionSlug,
-    draft: false,
-    limit: 1,
-    pagination: false,
-    overrideAccess: false,
-    locale,
-    where: { [slugField]: { equals: slug } },
-    select: { [slugField]: true }
-  });
-  const doc = result.docs?.[0];
-  if (!doc) {
-    console.log("[WWW] render/metadata:queryAllLocaleSlugs -> undefined (no doc)");
-    return;
-  }
-  let fieldValue = doc[slugField];
-  if (doc.id != null) {
-    const allLocales = await payload.findByID({
-      collection: collectionSlug,
-      id: doc.id,
-      locale: "all",
-      draft: false,
-      overrideAccess: false,
-      select: { [slugField]: true }
-    }).catch(() => null);
-    if (allLocales)
-      fieldValue = allLocales[slugField];
-  }
-  if (fieldValue && typeof fieldValue === "object") {
-    console.log("[WWW] render/metadata:queryAllLocaleSlugs -> localized map=", JSON.stringify(fieldValue));
-    return fieldValue;
-  }
-  const resolved = await config;
-  const rawLocales = Array.isArray(resolved?.localization?.localeCodes) ? resolved.localization.localeCodes : resolved?.localization?.locales?.map((l) => l.code) ?? [];
-  const out = {};
-  for (const l of rawLocales)
-    out[l] = String(fieldValue ?? slug);
-  console.log("[WWW] render/metadata:queryAllLocaleSlugs -> flat-fanout locales=", rawLocales.length, "slug=", JSON.stringify(fieldValue ?? slug));
-  return out;
-});
-var queryGlobal = cache(async function queryGlobal2({
-  globalSlug,
-  locale,
-  depth = 0,
-  draft = false,
-  config
-}) {
-  console.log("[WWW] render/metadata:queryGlobal global=", globalSlug, "locale=", locale, "depth=", depth, "draft=", draft);
-  const payload = await getPayload({ config });
-  try {
-    const global = await payload.findGlobal({
-      slug: globalSlug,
-      depth,
-      draft,
-      locale
-    });
-    console.log("[WWW] render/metadata:queryGlobal -> hit");
-    return global;
-  } catch (error) {
-    console.warn("[WWW] render/metadata:queryGlobal failed for slug=", globalSlug, "err=", String(error));
-    return null;
-  }
-});
-function getRenderModuleExports(exportName, collection, importMap) {
-  const path = collection?.custom?.path;
-  if (!path) {
-    console.log("[WWW] render/metadata:getRenderModuleExports no custom.path exportName=", exportName);
-    return;
-  }
-  const mod = getFromImportMap(path, importMap);
-  const value = mod?.[exportName];
-  console.log("[WWW] render/metadata:getRenderModuleExports exportName=", exportName, "path=", path, "hit=", Boolean(value));
-  return value;
-}
-
-// src/exports/render-metadata.ts
-var render_metadata_default = {
-  buildArticleLd,
-  buildBreadcrumbsLd,
-  buildOrganizationLd,
-  buildHreflangAlternates,
-  queryDocBySlug,
-  queryAllDocs,
-  queryAllLocaleSlugs,
-  getUrlPath,
-  segmentsToStoredSlug,
-  segmentsToUrlPath,
-  storedSlugToSegments,
-  buildCanonicalUrl,
-  getRenderModuleExports
-};
-export {
-  storedSlugToSegments,
-  segmentsToUrlPath,
-  segmentsToStoredSlug,
-  queryDocBySlug,
-  queryAllLocaleSlugs,
-  queryAllDocs,
-  getUrlPath,
-  getRenderModuleExports,
-  render_metadata_default as default,
-  buildOrganizationLd,
-  buildHreflangAlternates,
-  buildCanonicalUrl,
-  buildBreadcrumbsLd,
-  buildArticleLd
-};

package/dist/render-utils.d.ts

@@ -1,166 +0,0 @@
-type CreatePreviewHandlerOptions = {
-	/** Resolves the host's site URL (used to construct preview links if
-	* the host navigates back to the canonical site). */
-	getServerSideURL: () => string;
-	/**
-	* Secret token the host configures in `process.env.PREVIEW_SECRET`.
-	* The handler validates `?previewSecret=...` against this value and
-	* 401s on mismatch.
-	*/
-	secret: string;
-	/**
-	* Whether to enable draft mode on a valid preview. Hosts that use
-	* their own preview mechanism can pass `false`.
-	* Default: `true`.
-	*/
-	enableDraftMode?: boolean;
-};
-/**
-* Build a Next.js `GET` route handler for the host's
-* `app/(payload)/next/preview/route.ts`. Validates the preview secret
-* from the query string, enables draft mode if configured, and
-* redirects to the `?path=...` value.
-*
-* Usage:
-*
-*   // app/(payload)/next/preview/route.ts
-*   import { createPreviewHandler } from '@justanarthur/payload-www/render-utils'
-*   import { getServerSideURL } from '@/utilities/getURL'
-*   const GET = createPreviewHandler({
-*     getServerSideURL,
-*     secret: process.env.PREVIEW_SECRET || ''
-*   })
-*/
-declare function createPreviewHandler(options: CreatePreviewHandlerOptions): (req: Request) => Promise<Response>;
-import { MetadataRoute } from "next";
-type CreateSitemapFileOptions = {
-	/**
-	* Collection slugs whose docs should appear in the sitemap. Each
-	* collection must have a `slug` field on its documents. The lib
-	* emits a single unified sitemap at `/sitemap.xml` listing every
-	* doc from every configured collection across every active locale.
-	*/
-	collections: string[];
-	/**
-	* The Payload config promise. The factory resolves it at request
-	* time.
-	*/
-	config: Promise<any>;
-	/**
-	* The host's site URL — used to build absolute URLs.
-	*/
-	getServerSideURL: () => string;
-	/**
-	* Locale prefix mode. Mirrors next-intl's `localePrefix` so the
-	* sitemap URLs match the host's actual route shape:
-	*
-	* - `'always'`: every URL is prefixed with `/{locale}/…`
-	*   (e.g. `/en/about`, `/uk/about`). The default.
-	* - `'as-needed'`: the default locale renders without a prefix
-	*   (e.g. `/about`), other locales are prefixed (`/uk/about`).
-	* - `'never'`: no locale prefix (only useful for single-locale
-	*   sites or hosts that don't expose locales in the URL).
-	*
-	* The default locale is read from `config.localization.defaultLocale`
-	* — the same single source of truth that next-intl and the rest of
-	* the lib use.
-	*/
-	localePrefix?: "always" | "as-needed" | "never";
-	/**
-	* Optional filter for which locales to include in the sitemap.
-	* Defaults to every locale declared in `config.localization.locales`.
-	*/
-	locales?: string[];
-	/**
-	* Optional URL path prefix per collection. The Pages collection
-	* lives at the root (`/about`) so it doesn't need a prefix, but
-	* collections mounted under a sub-route (e.g. a posts collection
-	* under `/posts/[...slug]`) need their URLs prefixed with `/posts`
-	* so the sitemap entries match the actual route.
-	*
-	* Defaults to `''` (no prefix). Pass a value like `'/posts'`
-	* (leading slash, no trailing slash) for a sub-routed collection.
-	*/
-	urlPrefixes?: Record<string, string>;
-	/**
-	* Optional priority / changeFrequency overrides per collection.
-	*/
-	perCollection?: Record<string, {
-		priority?: number;
-		changefreq?: "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | "never";
-	}>;
-	/**
-	* Per-collection nested-slug flag. When a collection is marked
-	* `true`, its stored `about_us` slug is expanded into the
-	* `/about/us` URL path (and hreflang alternates), matching a
-	* `createCollectionPageExports({ nested: true })` route. Defaults
-	* to `false` (flat slugs) for every collection.
-	*/
-	nested?: Record<string, boolean>;
-};
-/**
-* A Next.js sitemap function for the host's
-* `app/(frontend)/sitemap.ts`. Returns the typed
-* `MetadataRoute.Sitemap` array — Next.js handles XML serialization.
-*
-* Usage — single unified sitemap:
-*
-*   // app/(frontend)/sitemap.ts
-*   import { createSitemapFile } from '@justanarthur/payload-www/render-utils'
-*   import configPromise from '@payload-config'
-*   import { getServerSideURL } from '@/utilities/getURL'
-*
-*   createSitemapFile({
-*     collections: ['pages', 'posts'],
-*     config: configPromise,
-*     getServerSideURL,
-*     localePrefix: 'as-needed',
-*     urlPrefixes: { posts: '/posts' }
-*   })
-*
-* The lib resolves the sitemap at request time, queries every
-* configured collection across every active locale, and emits one
-* unified `<urlset>` with full `alternates.languages` hreflang blocks
-* per URL. Google accepts up to 50,000 URLs per file.
-*/
-type SitemapFunction = () => Promise<MetadataRoute.Sitemap>;
-declare function createSitemapFile(options: CreateSitemapFileOptions): SitemapFunction;
-import { ReactElement } from "react";
-/**
-* Hreflang alternate URLs as a `lang → url` map. Always includes an
-* `'x-default'` entry pointing at the default locale's URL.
-*/
-type HreflangAlternates = Record<string, string>;
-type LocaleSwitcherProps = {
-	/**
-	* The currently-active locale (the one being rendered). The
-	* switcher marks the corresponding link with `aria-current="true"`.
-	*/
-	currentLocale: string;
-	/**
-	* The hreflang alternates map as returned by the lib's metadata
-	* pipeline. Keys are locale codes; values are absolute URLs. An
-	* `'x-default'` entry is also expected.
-	*/
-	hreflangAlternates: HreflangAlternates;
-	/**
-	* Optional human-readable labels per locale. When missing, the
-	* switcher falls back to uppercased locale codes.
-	*/
-	labels?: Record<string, string>;
-};
-/**
-* Render a list of links to the same page in every other locale.
-* The component is server-renderable (no `'use client'`) and emits
-* a single `<nav>` element with one `<a>` per locale plus an
-* `x-default` fallback. The lib's `<PageShowcase>` mounts it as a
-* child of the sidebar; hosts can also drop it elsewhere on the
-* page.
-*/
-declare function LocaleSwitcher({ currentLocale, hreflangAlternates, labels }: LocaleSwitcherProps): ReactElement;
-declare const _default: {
-	createPreviewHandler: typeof createPreviewHandler;
-	createSitemapFile: typeof createSitemapFile;
-	LocaleSwitcher: typeof LocaleSwitcher;
-};
-export { _default as default, createSitemapFile, createPreviewHandler, SitemapFunction, LocaleSwitcherProps, LocaleSwitcher, CreateSitemapFileOptions, CreatePreviewHandlerOptions };