create-brainerce-store 1.88.0 → 1.89.0

package/templates/nextjs/base/src/app/products/[slug]/page.tsx

@@ -1,220 +1,267 @@
-import type { Metadata } from 'next';
-import { notFound, permanentRedirect } from 'next/navigation';
-import { BrainerceError, getProductPriceInfo } from 'brainerce';
-import { getServerClient, fetchStoreInfo } from '@/core/lib/brainerce.server';
-import { getRegionId } from '@/core/lib/region.server';
-import { resolveCurrency } from '@/core/lib/resolve-currency';
-import { buildMetaDescription } from '@/core/lib/seo';
-import { canPurchaseProduct } from '@/core/lib/kit';
-import { decodeSlug } from '@/core/lib/utils';
-import { ProductJsonLd } from '@/components/seo/product-json-ld';
-import { getCanonicalSiteUrl } from '@/core/lib/site-url';
-import { Breadcrumbs } from '@/components/seo/breadcrumbs';
-import { ReviewsSection } from '@/ui/product/reviews-section';
-import { ProductFaqSection } from '@/ui/product/faq-section';
-import { ProductClientSection } from '@/ui/product/product-client-section';
-
-type Props = {
-  params: Promise<{ slug: string; locale?: string }>;
-};
-
-function buildHreflang(
-  baseUrl: string,
-  baseSlug: string,
-  localeSlugs: Record<string, string>,
-  locales: string[],
-  defaultLoc: string
-): Record<string, string> {
-  const langs: Record<string, string> = {};
-  for (const loc of locales) {
-    const locSlug = localeSlugs[loc] || baseSlug;
-    const path = loc === defaultLoc ? `/products/${locSlug}` : `/${loc}/products/${locSlug}`;
-    langs[loc] = `${baseUrl}${path}`;
-  }
-  // x-default points to the default-locale canonical (no prefix)
-  langs['x-default'] = `${baseUrl}/products/${localeSlugs[defaultLoc] || baseSlug}`;
-  return langs;
-}
-
-export async function generateMetadata({ params }: Props): Promise<Metadata> {
-  const { slug: rawSlug, locale } = await params;
-  const slug = decodeSlug(rawSlug);
-
-  try {
-    const client = await getServerClient(locale);
-    // Fetch product + store info in parallel; storeInfo gives us the live
-    // currency for OG price tags (with env-var + USD fallbacks so we never
-    // silently emit a wrong currency when the API is briefly unreachable).
-    // ⛔ `regionId` belongs on EVERY product read. Without it the backend
-    // prices in the default region, so a shopper elsewhere gets the wrong
-    // currency in the OG price meta that link previews and Merchant Center
-    // read. `getRegionId()` is `cache()`-wrapped and shared with the layout
-    // and the page body below, so this is not an extra round trip. It
-    // resolves to `undefined` on a store with no regions, and the SDK then
-    // omits the query param entirely.
-    const regionId = await getRegionId();
-    const [product, storeInfo] = await Promise.all([
-      client.getProductBySlug(slug, { regionId }),
-      fetchStoreInfo(locale),
-    ]);
-    const imageUrl = product.images?.[0]?.url;
-    // Prefer merchant-authored SEO copy; fall back to a stripped+truncated
-    // version of the visible description, then product name. We must NEVER
-    // emit raw HTML or a mid-word cut into <meta name="description">.
-    const seoTitle = (product as { seoTitle?: string | null }).seoTitle || product.name;
-    const seoDescription =
-      (product as { seoDescription?: string | null }).seoDescription ||
-      buildMetaDescription(product.description) ||
-      product.name;
-
-    // OG product meta tags drive WhatsApp / Facebook / X link previews and
-    // Google Merchant Center product enrichment. Emitting the literal "0"
-    // here (the previous bug) causes price-zero link cards. Use the real
-    // effective price from the SDK helper.
-    const priceInfo = getProductPriceInfo(product);
-    const currency = resolveCurrency(storeInfo);
-    const priceAmount = priceInfo.price > 0 ? priceInfo.price.toFixed(2) : null;
-    // ⛔ A KIT has NO `inventory` block — its stock is `product.kitAvailable`.
-    // Reading `inventory` here published `product:availability: in stock` for a
-    // sold-out kit, so Facebook/WhatsApp link previews and Google Merchant
-    // Center advertised something nobody could buy. `canPurchaseProduct` reads
-    // the right field per product type.
-    const inStock = canPurchaseProduct(product);
-    const brandName = (product as { brand?: { name?: string } | null }).brand?.name;
-
-    // Multilingual SEO: hreflang tags + correct canonical per locale.
-    // Locales come from storeInfo.i18n — already fetched above, zero extra cost.
-    const supportedLocales = storeInfo?.i18n?.supportedLocales ?? [];
-    const defaultLoc = storeInfo?.i18n?.defaultLocale ?? storeInfo?.language ?? '';
-    const baseUrl = await getCanonicalSiteUrl();
-    const baseSlug = product.slug || slug;
-    const localeSlugs = product.localeSlugs ?? {};
-
-    // Canonical: use the locale-specific slug for this locale when available.
-    const canonicalSlug = (locale && localeSlugs[locale]) || baseSlug;
-    const canonicalPath =
-      locale && locale !== defaultLoc
-        ? `/${locale}/products/${canonicalSlug}`
-        : `/products/${canonicalSlug}`;
-
-    const hreflangLanguages =
-      supportedLocales.length > 1
-        ? buildHreflang(baseUrl, baseSlug, localeSlugs, supportedLocales, defaultLoc)
-        : undefined;
-
-    return {
-      title: seoTitle,
-      description: seoDescription,
-      alternates: {
-        canonical: canonicalPath,
-        ...(hreflangLanguages ? { languages: hreflangLanguages } : {}),
-      },
-      openGraph: {
-        title: seoTitle,
-        description: seoDescription,
-        images: imageUrl ? [{ url: imageUrl, alt: product.name }] : [],
-        type: 'website',
-      },
-      twitter: {
-        card: 'summary_large_image',
-        title: seoTitle,
-        description: seoDescription,
-        images: imageUrl ? [imageUrl] : [],
-      },
-      // Emit the OG product extension (Facebook / WhatsApp / X link previews,
-      // Google Merchant Center). Skips the price pair entirely when the SDK
-      // can't determine a positive amount, rather than shipping "0".
-      other: {
-        ...(priceAmount
-          ? {
-              'og:price:amount': priceAmount,
-              'og:price:currency': currency,
-              'product:price:amount': priceAmount,
-              'product:price:currency': currency,
-            }
-          : {}),
-        'product:availability': inStock ? 'in stock' : 'out of stock',
-        'product:condition': 'new',
-        ...(brandName ? { 'product:brand': brandName } : {}),
-      },
-    };
-  } catch (err) {
-    if (err instanceof BrainerceError && err.statusCode === 404) {
-      return { title: 'Product not found' };
-    }
-    // Anything else (channel origin rejection, network failure) hits the page
-    // render below too and surfaces there — don't stamp a misleading title.
-    return {};
-  }
-}
-
-export default async function ProductDetailPage({ params }: Props) {
-  const { slug: rawSlug, locale } = await params;
-  const slug = decodeSlug(rawSlug);
-
-  const client = await getServerClient(locale);
-  // Same region as the metadata above (one shared `cache()`d resolve), so the
-  // price in the <head> and the price on the page cannot disagree.
-  const regionId = await getRegionId();
-  let product;
-  try {
-    product = await client.getProductBySlug(slug, { regionId });
-  } catch (err) {
-    // Only a genuine 404 may become a storefront 404. Anything else — a 403
-    // from the channel's origin check, a network failure, a 5xx — is a
-    // configuration or availability problem; disguising it as "product not
-    // found" sends the merchant hunting for a slug bug that isn't there.
-    if (!(err instanceof BrainerceError && err.statusCode === 404)) {
-      throw err;
-    }
-    // The slug may have been RENAMED — the platform records every rename.
-    // 301 the old URL to the current slug so its ranking and inbound links
-    // carry over; genuine unknowns fall through to the 404 page. Default
-    // locale stays unprefixed (matches the sitemap/hreflang convention); the
-    // destination page's canonical then points crawlers at the localized URL.
-    const redirect = await client.resolveSlugRedirect('product', slug);
-    if (redirect) {
-      const info = await fetchStoreInfo(locale);
-      const defaultLoc = info?.i18n?.defaultLocale ?? info?.language ?? '';
-      const prefix = locale && locale !== defaultLoc ? `/${locale}` : '';
-      permanentRedirect(`${prefix}/products/${redirect.currentSlug}`);
-    }
-    notFound();
-  }
-
-  const baseUrl = await getCanonicalSiteUrl();
-  const productUrl = `${baseUrl}/products/${slug}`;
-  // Reuse the cached storeInfo from generateMetadata's call — React cache()
-  // collapses both into one backend request per render. resolveCurrency owns
-  // the env-var + USD fallback chain so this stays a single source of truth.
-  const storeInfo = await fetchStoreInfo(locale);
-  const currency = resolveCurrency(storeInfo);
-  const localePrefix = locale ? `/${locale}` : '';
-  const primaryCategory = product.categories?.find((c) => c.slug);
-  const breadcrumbItems = [
-    { name: 'Home', href: `${localePrefix}/` },
-    ...(primaryCategory
-      ? [{ name: primaryCategory.name, href: `${localePrefix}/category/${primaryCategory.slug}` }]
-      : []),
-    { name: product.name },
-  ];
-
-  return (
-    <>
-      <ProductJsonLd
-        product={product}
-        url={productUrl}
-        currency={currency}
-        shipping={storeInfo?.shipping}
-      />
-      <div className="mx-auto max-w-7xl px-4 pt-6 sm:px-6 lg:px-8">
-        <Breadcrumbs items={breadcrumbItems} />
-      </div>
-      <ProductClientSection product={product} stockAlertsEnabled={storeInfo?.stockAlertsEnabled} />
-      {/* Visible Q&A + the FAQPage JSON-LD above read the same product.faq —
-          the extractable format AI answer engines cite. */}
-      <ProductFaqSection product={product} locale={locale} />
-      <ReviewsSection productId={product.id} />
-    </>
-  );
-}
+import type { Metadata } from 'next';
+import { notFound, permanentRedirect } from 'next/navigation';
+import { BrainerceError, deriveSeoDescription, getProductPriceInfo } from 'brainerce';
+import type { Product } from 'brainerce';
+import { getServerClient, fetchStoreInfo } from '@/core/lib/brainerce.server';
+import { getRegionId } from '@/core/lib/region.server';
+import { resolveCurrency } from '@/core/lib/resolve-currency';
+import { reviewsAreOn } from '@/core/lib/store-info';
+import { canPurchaseProduct } from '@/core/lib/kit';
+import { localePath } from '@/core/lib/locale-path';
+import { getServerNamespace } from '@/core/lib/server-messages';
+import { decodeSlug } from '@/core/lib/utils';
+import { ProductJsonLd } from '@/components/seo/product-json-ld';
+import { ProductOgMeta } from '@/components/seo/product-og-meta';
+import { getCanonicalSiteUrl } from '@/core/lib/site-url';
+import { Breadcrumbs } from '@/components/seo/breadcrumbs';
+import { ReviewsSection } from '@/ui/product/reviews-section';
+import { ProductFaqSection } from '@/ui/product/faq-section';
+import { ProductClientSection } from '@/ui/product/product-client-section';
+
+type Props = {
+  params: Promise<{ slug: string; locale?: string }>;
+};
+
+function buildHreflang(
+  baseUrl: string,
+  baseSlug: string,
+  localeSlugs: Record<string, string>,
+  locales: string[],
+  defaultLoc: string
+): Record<string, string> {
+  const langs: Record<string, string> = {};
+  for (const loc of locales) {
+    const locSlug = localeSlugs[loc] || baseSlug;
+    const path = loc === defaultLoc ? `/products/${locSlug}` : `/${loc}/products/${locSlug}`;
+    langs[loc] = `${baseUrl}${path}`;
+  }
+  // x-default points to the default-locale canonical (no prefix)
+  langs['x-default'] = `${baseUrl}/products/${localeSlugs[defaultLoc] || baseSlug}`;
+  return langs;
+}
+
+/**
+ * The public path of a product in a locale: the locale's own slug when it has
+ * one, else the product's slug, else the one in the URL. The canonical tag, the
+ * JSON-LD `url` and the breadcrumb all use this, so the three cannot name three
+ * different URLs for one page (the JSON-LD used to carry the unprefixed,
+ * requested slug while the canonical carried the locale prefix and the locale's
+ * slug).
+ */
+function productPath(
+  locale: string | undefined,
+  product: Pick<Product, 'slug' | 'localeSlugs'>,
+  requestedSlug: string
+): string {
+  const slug = (locale && product.localeSlugs?.[locale]) || product.slug || requestedSlug;
+  return localePath(locale, `/products/${slug}`);
+}
+
+export async function generateMetadata({ params }: Props): Promise<Metadata> {
+  const { slug: rawSlug, locale } = await params;
+  const slug = decodeSlug(rawSlug);
+
+  try {
+    const client = await getServerClient(locale);
+    // Fetch product + store info in parallel; storeInfo gives us the store name,
+    // the hreflang locales and the live currency.
+    // ⛔ `regionId` belongs on EVERY product read. Without it the backend
+    // prices in the default region, so a shopper elsewhere gets the wrong
+    // currency in the OG price meta that link previews and Merchant Center
+    // read. `getRegionId()` is `cache()`-wrapped and shared with the layout
+    // and the page body below, so this is not an extra round trip. It
+    // resolves to `undefined` on a store with no regions, and the SDK then
+    // omits the query param entirely.
+    const regionId = await getRegionId();
+    const [product, storeInfo] = await Promise.all([
+      client.getProductBySlug(slug, { regionId }),
+      fetchStoreInfo(locale),
+    ]);
+    const imageUrl = product.images?.[0]?.url;
+    // The merchant's own SEO copy first, then a tag-stripped, word-boundary
+    // truncated description, then the name. `deriveSeoDescription` reads BOTH
+    // `seoDescription` and `metaDescription`: a salesChannelId read can carry the
+    // merchant's text under either name, and reading only `seoDescription` meant
+    // the meta description they wrote never reached the page (every product fell
+    // back to the start of its description, with no error and no sign).
+    const seoTitle = (product as { seoTitle?: string | null }).seoTitle || product.name;
+    const seoDescription = deriveSeoDescription(product) || product.name;
+
+    // Multilingual SEO: hreflang tags + correct canonical per locale.
+    // Locales come from storeInfo.i18n — already fetched above, zero extra cost.
+    const supportedLocales = storeInfo?.i18n?.supportedLocales ?? [];
+    const defaultLoc = storeInfo?.i18n?.defaultLocale ?? storeInfo?.language ?? '';
+    const baseUrl = await getCanonicalSiteUrl();
+    const baseSlug = product.slug || slug;
+    const localeSlugs = product.localeSlugs ?? {};
+
+    const hreflangLanguages =
+      supportedLocales.length > 1
+        ? buildHreflang(baseUrl, baseSlug, localeSlugs, supportedLocales, defaultLoc)
+        : undefined;
+
+    return {
+      title: seoTitle,
+      description: seoDescription,
+      alternates: {
+        canonical: productPath(locale, product, slug),
+        ...(hreflangLanguages ? { languages: hreflangLanguages } : {}),
+      },
+      // No `type` here, deliberately. Next's `openGraph.type` has no `product`
+      // value, and the page emits `og:type: product` itself (<ProductOgMeta/>,
+      // with the price and availability tags). A `type` here would put a second
+      // `og:type` in the head. `siteName` is repeated because this object
+      // replaces the root layout's rather than merging into it.
+      openGraph: {
+        title: seoTitle,
+        description: seoDescription,
+        ...(storeInfo?.name ? { siteName: storeInfo.name } : {}),
+        images: imageUrl ? [{ url: imageUrl, alt: product.name }] : [],
+      },
+      twitter: {
+        card: 'summary_large_image',
+        title: seoTitle,
+        description: seoDescription,
+        images: imageUrl ? [imageUrl] : [],
+      },
+    };
+  } catch (err) {
+    if (err instanceof BrainerceError && err.statusCode === 404) {
+      const seo = await getServerNamespace('seo', locale);
+      return { title: seo.productNotFound ?? '' };
+    }
+    // Anything else (channel origin rejection, network failure) hits the page
+    // render below too and surfaces there — don't stamp a misleading title.
+    return {};
+  }
+}
+
+export default async function ProductDetailPage({ params }: Props) {
+  const { slug: rawSlug, locale } = await params;
+  const slug = decodeSlug(rawSlug);
+
+  const client = await getServerClient(locale);
+  // Same region as the metadata above (one shared `cache()`d resolve), so the
+  // price in the <head> and the price on the page cannot disagree.
+  const regionId = await getRegionId();
+  let product;
+  try {
+    product = await client.getProductBySlug(slug, { regionId });
+  } catch (err) {
+    // Only a genuine 404 may become a storefront 404. Anything else — a 403
+    // from the channel's origin check, a network failure, a 5xx — is a
+    // configuration or availability problem; disguising it as "product not
+    // found" sends the merchant hunting for a slug bug that isn't there.
+    if (!(err instanceof BrainerceError && err.statusCode === 404)) {
+      throw err;
+    }
+    // The slug may have been RENAMED — the platform records every rename.
+    // 301 the old URL to the current slug so its ranking and inbound links
+    // carry over; genuine unknowns fall through to the 404 page. Default
+    // locale stays unprefixed (matches the sitemap/hreflang convention); the
+    // destination page's canonical then points crawlers at the localized URL.
+    const redirect = await client.resolveSlugRedirect('product', slug);
+    if (redirect) {
+      permanentRedirect(localePath(locale, `/products/${redirect.currentSlug}`));
+    }
+    notFound();
+  }
+
+  // Reviews are read HERE, once, and gate the whole section. The reviews API
+  // refuses (403) when the store has reviews turned off, and the section used to
+  // swallow that and render its heading, "no reviews yet" and the submit form
+  // anyway: a storefront inviting reviews the store does not collect. A failed
+  // read hides the section for the same reason, instead of showing a false
+  // "no reviews yet".
+  //
+  // `storeInfo.reviewsEnabled === false` skips the call outright (no failing
+  // request per page view). A backend too old to send the flag answers the call
+  // with a 403 `REVIEWS_DISABLED`, which lands in the same `null`.
+  const readReviews = async () => {
+    // Cached by generateMetadata's call, so this costs no second request.
+    if (!reviewsAreOn(await fetchStoreInfo(locale))) return null;
+    const result = await client.listProductReviews(product.id, {
+      page: 1,
+      limit: 20,
+      sort: 'photos_first',
+    });
+    return result.data;
+  };
+  const [storeInfo, seo, reviews] = await Promise.all([
+    // Reuse the cached storeInfo from generateMetadata's call — React cache()
+    // collapses both into one backend request per render.
+    fetchStoreInfo(locale),
+    getServerNamespace('seo', locale),
+    readReviews().catch(() => null),
+  ]);
+  const baseUrl = await getCanonicalSiteUrl();
+  // resolveCurrency owns the env-var + USD fallback chain so this stays a single
+  // source of truth.
+  const currency = resolveCurrency(storeInfo);
+
+  const productHref = productPath(locale, product, slug);
+  const productUrl = `${baseUrl}${productHref}`;
+  const primaryCategory = product.categories?.find((c) => c.slug);
+  // One trail, two renderings: the visible breadcrumb and the BreadcrumbList
+  // JSON-LD are built from the SAME items, so they cannot disagree (the JSON-LD
+  // used to say Home > Products > name while the page showed Home > Category).
+  const breadcrumbItems = [
+    { name: seo.home ?? '', href: localePath(locale, '/') },
+    ...(primaryCategory
+      ? [
+          {
+            name: primaryCategory.name,
+            href: localePath(locale, `/category/${primaryCategory.slug}`),
+          },
+        ]
+      : []),
+    { name: product.name, href: undefined as string | undefined },
+  ];
+  const breadcrumbJsonLd = breadcrumbItems.map((item) => ({
+    name: item.name,
+    url: item.href ? `${baseUrl}${item.href}` : productUrl,
+  }));
+
+  // `og:type` and the price/availability tags, from the same helpers the rest of
+  // the page uses. Emitting the literal "0" for a missing price causes
+  // price-zero link cards, so the amount is null unless the SDK finds a real one.
+  const priceInfo = getProductPriceInfo(product);
+  const priceAmount = priceInfo.price > 0 ? priceInfo.price.toFixed(2) : null;
+  // ⛔ A KIT has NO `inventory` block — its stock is `product.kitAvailable`.
+  // Reading `inventory` published `product:availability: in stock` for a sold-out
+  // kit, so link previews and Merchant Center advertised something nobody could
+  // buy. `canPurchaseProduct` reads the right field per product type.
+  const inStock = canPurchaseProduct(product);
+  const brandName = (product as { brand?: { name?: string } | null }).brand?.name;
+
+  // aggregateRating markup describes reviews a visitor can see. With the section
+  // hidden (reviews off, or unreadable) the rating is withheld too, whatever
+  // counts the product still carries from before.
+  const jsonLdProduct = reviews ? product : { ...product, avgRating: 0, reviewCount: 0 };
+
+  return (
+    <>
+      <ProductOgMeta
+        priceAmount={priceAmount}
+        currency={currency}
+        inStock={inStock}
+        brandName={brandName}
+      />
+      <ProductJsonLd
+        product={jsonLdProduct}
+        url={productUrl}
+        currency={currency}
+        shipping={storeInfo?.shipping}
+        breadcrumbs={breadcrumbJsonLd}
+      />
+      <div className="mx-auto max-w-7xl px-4 pt-6 sm:px-6 lg:px-8">
+        <Breadcrumbs items={breadcrumbItems} />
+      </div>
+      <ProductClientSection product={product} stockAlertsEnabled={storeInfo?.stockAlertsEnabled} />
+      {/* Visible Q&A + the FAQPage JSON-LD above read the same product.faq —
+          the extractable format AI answer engines cite. */}
+      <ProductFaqSection product={product} locale={locale} />
+      {reviews ? <ReviewsSection productId={product.id} initialReviews={reviews} locale={locale} /> : null}
+    </>
+  );
+}