create-brainerce-store 1.36.0 → 1.39.0

package/templates/nextjs/base/src/components/seo/organization-json-ld.tsx

@@ -0,0 +1,94 @@
+import type { StoreInfo } from 'brainerce';
+import { getNonce } from '@/lib/nonce';
+import { stripHtmlForSeo } from '@/lib/seo';
+
+interface OrganizationJsonLdProps {
+  storeInfo: StoreInfo;
+  baseUrl: string;
+}
+
+// Emits Organization + WebSite JSON-LD on the storefront homepage.
+//
+// Why these two specifically:
+//   - Organization → feeds the Google Knowledge Panel (store name, logo,
+//     description) and is the primary signal AI Overviews / ChatGPT /
+//     Perplexity ingest when citing the store.
+//   - WebSite → enables Sitelinks Searchbox (Google) and tells crawlers
+//     the canonical site URL. The `potentialAction` block is what makes
+//     the search box appear in branded SERP results.
+export async function OrganizationJsonLd({ storeInfo, baseUrl }: OrganizationJsonLdProps) {
+  const nonce = await getNonce();
+
+  const cleanDescription = stripHtmlForSeo(storeInfo.metaDescription ?? undefined);
+  const logo =
+    typeof storeInfo.logo === 'string' && storeInfo.logo.trim() ? storeInfo.logo : undefined;
+  const contactEmail =
+    typeof storeInfo.contactEmail === 'string' && storeInfo.contactEmail.trim()
+      ? storeInfo.contactEmail.trim()
+      : undefined;
+  const contactPhone =
+    typeof storeInfo.contactPhone === 'string' && storeInfo.contactPhone.trim()
+      ? storeInfo.contactPhone.trim()
+      : undefined;
+  // sameAs is the JSON-LD property Google uses to associate a brand with its
+  // social profiles. Order doesn't matter; we just filter out empties.
+  const sameAs = storeInfo.socialLinks
+    ? Object.values(storeInfo.socialLinks).filter(
+        (url): url is string => typeof url === 'string' && url.trim().length > 0,
+      )
+    : [];
+
+  const organizationJsonLd: Record<string, unknown> = {
+    '@context': 'https://schema.org',
+    '@type': 'Organization',
+    name: storeInfo.name,
+    url: baseUrl,
+    ...(logo ? { logo } : {}),
+    ...(cleanDescription ? { description: cleanDescription } : {}),
+    ...(contactEmail ? { email: contactEmail } : {}),
+    ...(contactPhone ? { telephone: contactPhone } : {}),
+    ...(sameAs.length > 0 ? { sameAs } : {}),
+  };
+
+  const websiteJsonLd: Record<string, unknown> = {
+    '@context': 'https://schema.org',
+    '@type': 'WebSite',
+    name: storeInfo.name,
+    url: baseUrl,
+    potentialAction: {
+      '@type': 'SearchAction',
+      target: {
+        '@type': 'EntryPoint',
+        urlTemplate: `${baseUrl}/products?q={search_term_string}`,
+      },
+      'query-input': 'required name=search_term_string',
+    },
+  };
+
+  return (
+    <>
+      <script
+        type="application/ld+json"
+        nonce={nonce}
+        suppressHydrationWarning
+        dangerouslySetInnerHTML={{ __html: serializeJsonLd(organizationJsonLd) }}
+      />
+      <script
+        type="application/ld+json"
+        nonce={nonce}
+        suppressHydrationWarning
+        dangerouslySetInnerHTML={{ __html: serializeJsonLd(websiteJsonLd) }}
+      />
+    </>
+  );
+}
+
+// Escape `<`, `>`, `&` to \uXXXX so seller-controlled fields can't break out
+// of the <script> with `</script>` or inject HTML. Same approach as
+// product-json-ld.tsx — keep the two in sync.
+function serializeJsonLd(value: unknown): string {
+  return JSON.stringify(value)
+    .replace(/</g, '\\u003c')
+    .replace(/>/g, '\\u003e')
+    .replace(/&/g, '\\u0026');
+}

package/templates/nextjs/base/src/components/seo/product-json-ld.tsx

@@ -1,6 +1,7 @@
 import type { Product } from 'brainerce';
 import { getProductPriceInfo } from 'brainerce';
 import { getNonce } from '@/lib/nonce';
+import { stripHtmlForSeo } from '@/lib/seo';
 
 interface ProductJsonLdProps {
   product: Product;
@@ -39,11 +40,15 @@ export async function ProductJsonLd({ product, url, currency = 'USD' }: ProductJ
           url,
         };
 
+  // schema.org/Product.description must be plain text — Google's Rich Results
+  // and AI Overviews ingest this field directly and reject markup. Strip HTML
+  // first; if the description is empty after stripping, fall back to the name.
+  const cleanDescription = stripHtmlForSeo(product.description) || product.name;
   const productJsonLd: Record<string, unknown> = {
     '@context': 'https://schema.org',
     '@type': 'Product',
     name: product.name,
-    description: product.description || product.name,
+    description: cleanDescription,
     image: imageUrl,
     url,
     sku: product.sku || product.id,

package/templates/nextjs/base/src/i18n.ts.ejs

@@ -1,13 +1,18 @@
 <% if (i18nEnabled) { %>
 // Multi-language store — locales loaded dynamically
+import { getDirectionForLocale } from 'brainerce';
+
 export const defaultLocale = '<%= defaultLocale %>';
 export const supportedLocales = <%- supportedLocales %> as const;
 export type Locale = (typeof supportedLocales)[number];
 
-const RTL_LOCALES = new Set(['he', 'ar']);
-
+/**
+ * Resolve script direction. Delegates to the SDK so the storefront stays in
+ * sync as Brainerce adds support for new RTL locales — never maintain a
+ * local RTL locale set here.
+ */
 export function getDirection(locale: string): 'ltr' | 'rtl' {
-  return RTL_LOCALES.has(locale) ? 'rtl' : 'ltr';
+  return getDirectionForLocale(locale);
 }
 
 export async function getMessages(locale: string): Promise<Record<string, Record<string, string>>> {

package/templates/nextjs/base/src/lib/sanitize.ts.ejs

@@ -0,0 +1,26 @@
+/**
+ * Single-source HTML sanitizer for merchant-authored content.
+ *
+ * Brainerce returns RICH_TEXT.html, PAGE.html, and FAQ answer values as raw
+ * HTML — the server does NOT pre-sanitize because some merchants embed
+ * iframes (e.g. YouTube). Run every merchant-authored HTML string through
+ * this wrapper before injecting via `dangerouslySetInnerHTML`.
+ *
+ *   const safe = sanitizeHtml(rawHtml);
+ *   <div dangerouslySetInnerHTML={{ __html: safe }} />
+ *
+ * Uses isomorphic-dompurify so the same call works in Server Components and
+ * Client Components.
+ */
+import DOMPurify from 'isomorphic-dompurify';
+
+const DEFAULT_CONFIG: DOMPurify.Config = {
+  // Allow iframes for embedded videos/maps the merchant may include.
+  ADD_TAGS: ['iframe'],
+  ADD_ATTR: ['allow', 'allowfullscreen', 'frameborder', 'scrolling', 'target', 'rel'],
+};
+
+export function sanitizeHtml(html: string | null | undefined): string {
+  if (!html) return '';
+  return DOMPurify.sanitize(html, DEFAULT_CONFIG) as unknown as string;
+}

package/templates/nextjs/base/src/lib/seo.ts

@@ -0,0 +1,49 @@
+// SEO helpers for meta tags and JSON-LD. Strips HTML and decodes common
+// entities so seller-authored rich-text descriptions don't leak markup into
+// <meta name="description">, og:description, twitter:description, or
+// schema.org Product.description.
+
+const NAMED_ENTITIES: Record<string, string> = {
+  nbsp: ' ',
+  amp: '&',
+  lt: '<',
+  gt: '>',
+  quot: '"',
+  apos: "'",
+};
+
+function decodeEntities(text: string): string {
+  return text
+    .replace(/&(nbsp|amp|lt|gt|quot|apos);/g, (_, name: string) => NAMED_ENTITIES[name] ?? '')
+    .replace(/&#(\d+);/g, (_, code: string) => String.fromCodePoint(Number(code)))
+    .replace(/&#x([0-9a-f]+);/gi, (_, code: string) => String.fromCodePoint(parseInt(code, 16)));
+}
+
+// Strip HTML tags, decode entities, collapse whitespace. Idempotent on plain text.
+export function stripHtmlForSeo(input: string | null | undefined): string {
+  if (!input) return '';
+  return decodeEntities(input.replace(/<[^>]*>/g, ' '))
+    .replace(/\s+/g, ' ')
+    .trim();
+}
+
+// Build a meta description from raw HTML/text.
+// Truncates at the nearest word boundary so we never cut mid-word, and
+// appends a Unicode ellipsis. Returns '' for null/empty input so callers
+// can fall back cleanly.
+export function buildMetaDescription(
+  input: string | null | undefined,
+  maxLength = 160
+): string {
+  const stripped = stripHtmlForSeo(input);
+  if (!stripped) return '';
+  if (stripped.length <= maxLength) return stripped;
+
+  const room = maxLength - 1; // leave room for ellipsis
+  const cut = stripped.slice(0, room);
+  const lastSpace = cut.lastIndexOf(' ');
+  // Only break on word boundary when it's reasonably close to the cap — otherwise
+  // a single very long word would shrink the description to almost nothing.
+  const safeCut = lastSpace > room * 0.7 ? cut.slice(0, lastSpace) : cut;
+  return `${safeCut.trim()}…`;
+}

package/templates/nextjs/base/src/components/layout/footer.tsx

@@ -1,47 +0,0 @@
-'use client';
-
-import { Link } from '@/lib/navigation';
-import { useTranslations } from '@/lib/translations';
-import { useStoreInfo, useAuth } from '@/providers/store-provider';
-
-export function Footer() {
-  const t = useTranslations('common');
-  const tn = useTranslations('nav');
-  const { storeInfo } = useStoreInfo();
-  const { isLoggedIn } = useAuth();
-  const year = new Date().getFullYear();
-
-  return (
-    <footer className="border-border bg-background border-t">
-      <div className="mx-auto max-w-7xl px-4 py-8 sm:px-6 lg:px-8">
-        <div className="flex flex-col items-center justify-between gap-4 sm:flex-row">
-          <p className="text-muted-foreground text-sm">
-            {year} {storeInfo?.name || t('store')}. {t('allRightsReserved')}
-          </p>
-          <nav className="flex items-center gap-4">
-            <Link
-              href="/products"
-              className="text-muted-foreground hover:text-foreground text-sm transition-colors"
-            >
-              {tn('products')}
-            </Link>
-            <Link
-              href="/contact"
-              className="text-muted-foreground hover:text-foreground text-sm transition-colors"
-            >
-              {tn('contact')}
-            </Link>
-            {isLoggedIn && (
-              <Link
-                href="/account"
-                className="text-muted-foreground hover:text-foreground text-sm transition-colors"
-              >
-                {tn('account')}
-              </Link>
-            )}
-          </nav>
-        </div>
-      </div>
-    </footer>
-  );
-}

package/templates/nextjs/base/src/components/layout/header.tsx

@@ -1,335 +0,0 @@
-'use client';
-
-import { useState, useEffect, useRef, useCallback } from 'react';
-import { Link, useRouter } from '@/lib/navigation';
-import Image from 'next/image';
-import type { SearchSuggestions, ProductSuggestion } from 'brainerce';
-import { formatPrice } from 'brainerce';
-import { getClient } from '@/lib/brainerce';
-import { useTranslations } from '@/lib/translations';
-import { useStoreInfo, useAuth, useCart } from '@/providers/store-provider';
-export function Header() {
-  const t = useTranslations('nav');
-  const tc = useTranslations('common');
-  const { storeInfo } = useStoreInfo();
-  const { isLoggedIn, logout } = useAuth();
-  const { itemCount } = useCart();
-  const router = useRouter();
-
-  const [searchQuery, setSearchQuery] = useState('');
-  const [suggestions, setSuggestions] = useState<SearchSuggestions | null>(null);
-  const [showSuggestions, setShowSuggestions] = useState(false);
-  const [mobileMenuOpen, setMobileMenuOpen] = useState(false);
-  const searchRef = useRef<HTMLDivElement>(null);
-  const debounceRef = useRef<ReturnType<typeof setTimeout> | null>(null);
-
-  const currency = storeInfo?.currency || 'USD';
-
-  // Debounced search suggestions
-  const fetchSuggestions = useCallback((query: string) => {
-    if (debounceRef.current) clearTimeout(debounceRef.current);
-
-    if (query.length < 2) {
-      setSuggestions(null);
-      setShowSuggestions(false);
-      return;
-    }
-
-    debounceRef.current = setTimeout(async () => {
-      try {
-        const client = getClient();
-        const result = await client.getSearchSuggestions(query, 5);
-        setSuggestions(result);
-        setShowSuggestions(true);
-      } catch {
-        setSuggestions(null);
-      }
-    }, 300);
-  }, []);
-
-  // Close suggestions on click outside
-  useEffect(() => {
-    function handleClickOutside(e: MouseEvent) {
-      if (searchRef.current && !searchRef.current.contains(e.target as Node)) {
-        setShowSuggestions(false);
-      }
-    }
-    document.addEventListener('mousedown', handleClickOutside);
-    return () => document.removeEventListener('mousedown', handleClickOutside);
-  }, []);
-
-  function handleSearchSubmit(e: React.FormEvent) {
-    e.preventDefault();
-    if (searchQuery.trim()) {
-      router.push(`/products?search=${encodeURIComponent(searchQuery.trim())}`);
-      setShowSuggestions(false);
-      setSearchQuery('');
-    }
-  }
-
-  function handleSuggestionClick(suggestion: ProductSuggestion) {
-    const href = suggestion.slug ? `/products/${suggestion.slug}` : `/products/${suggestion.id}`;
-    router.push(href);
-    setShowSuggestions(false);
-    setSearchQuery('');
-  }
-
-  return (
-    <header className="bg-background border-border sticky top-0 z-50 border-b">
-      <div className="mx-auto max-w-7xl px-4 sm:px-6 lg:px-8">
-        <div className="flex h-16 items-center justify-between gap-4">
-          {/* Logo / Store Name */}
-          <Link href="/" className="text-foreground flex-shrink-0 text-xl font-bold">
-            {storeInfo?.name || process.env.NEXT_PUBLIC_STORE_NAME || tc('store')}
-          </Link>
-
-          {/* Desktop Navigation */}
-          <nav className="hidden items-center gap-6 md:flex">
-            <Link
-              href="/products"
-              className="text-muted-foreground hover:text-foreground text-sm transition-colors"
-            >
-              {t('products')}
-            </Link>
-            {isLoggedIn && (
-              <Link
-                href="/account"
-                className="text-muted-foreground hover:text-foreground text-sm transition-colors"
-              >
-                {t('account')}
-              </Link>
-            )}
-          </nav>
-
-          {/* Search */}
-          <div ref={searchRef} className="relative hidden max-w-md flex-1 sm:block">
-            <form onSubmit={handleSearchSubmit}>
-              <input
-                type="text"
-                value={searchQuery}
-                onChange={(e) => {
-                  setSearchQuery(e.target.value);
-                  fetchSuggestions(e.target.value);
-                }}
-                onFocus={() => {
-                  if (suggestions && searchQuery.length >= 2) {
-                    setShowSuggestions(true);
-                  }
-                }}
-                placeholder={t('searchPlaceholder')}
-                className="border-border bg-background text-foreground placeholder:text-muted-foreground focus:ring-primary/20 focus:border-primary h-9 w-full rounded border px-3 pe-9 text-sm focus:outline-none focus:ring-2"
-              />
-              <button
-                type="submit"
-                className="text-muted-foreground hover:text-foreground absolute end-0 top-0 flex h-9 w-9 items-center justify-center"
-                aria-label={t('search')}
-              >
-                <svg className="h-4 w-4" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-                  <path
-                    strokeLinecap="round"
-                    strokeLinejoin="round"
-                    strokeWidth={2}
-                    d="M21 21l-6-6m2-5a7 7 0 11-14 0 7 7 0 0114 0z"
-                  />
-                </svg>
-              </button>
-            </form>
-
-            {/* Search Suggestions Dropdown */}
-            {showSuggestions && suggestions && (
-              <div className="bg-background border-border absolute top-full z-50 mt-1 w-full overflow-hidden rounded-lg border shadow-lg">
-                {suggestions.products.length > 0 && (
-                  <div>
-                    <div className="text-muted-foreground bg-muted px-3 py-1.5 text-xs font-medium">
-                      {t('products')}
-                    </div>
-                    {suggestions.products.map((product) => (
-                      <button
-                        key={product.id}
-                        type="button"
-                        onClick={() => handleSuggestionClick(product)}
-                        className="hover:bg-muted flex w-full items-center gap-3 px-3 py-2 text-start transition-colors"
-                      >
-                        {product.image ? (
-                          <Image
-                            src={product.image}
-                            alt={product.name}
-                            width={32}
-                            height={32}
-                            className="flex-shrink-0 rounded object-cover"
-                          />
-                        ) : (
-                          <div className="bg-muted h-8 w-8 flex-shrink-0 rounded" />
-                        )}
-                        <div className="min-w-0 flex-1">
-                          <p className="text-foreground truncate text-sm">{product.name}</p>
-                          <p className="text-muted-foreground text-xs">
-                            {
-                              formatPrice(product.salePrice || product.price, {
-                                currency,
-                              }) as string
-                            }
-                          </p>
-                        </div>
-                      </button>
-                    ))}
-                  </div>
-                )}
-
-                {suggestions.categories.length > 0 && (
-                  <div>
-                    <div className="text-muted-foreground bg-muted px-3 py-1.5 text-xs font-medium">
-                      {t('categories')}
-                    </div>
-                    {suggestions.categories.map((cat) => (
-                      <button
-                        key={cat.id}
-                        type="button"
-                        onClick={() => {
-                          router.push(`/products?category=${cat.id}`);
-                          setShowSuggestions(false);
-                          setSearchQuery('');
-                        }}
-                        className="hover:bg-muted flex w-full items-center justify-between px-3 py-2 text-start transition-colors"
-                      >
-                        <span className="text-foreground text-sm">{cat.name}</span>
-                        <span className="text-muted-foreground text-xs">
-                          {cat.productCount} {tc('products')}
-                        </span>
-                      </button>
-                    ))}
-                  </div>
-                )}
-
-                {suggestions.products.length === 0 && suggestions.categories.length === 0 && (
-                  <div className="text-muted-foreground px-3 py-4 text-center text-sm">
-                    {tc('noResults')}
-                  </div>
-                )}
-              </div>
-            )}
-          </div>
-
-          {/* Right side actions */}
-          <div className="flex items-center gap-3">
-            {/* Auth */}
-            {isLoggedIn ? (
-              <button
-                onClick={logout}
-                className="text-muted-foreground hover:text-foreground hidden text-sm transition-colors sm:inline-flex"
-              >
-                {t('logout')}
-              </button>
-            ) : (
-              <Link
-                href="/login"
-                className="text-muted-foreground hover:text-foreground hidden text-sm transition-colors sm:inline-flex"
-              >
-                {t('login')}
-              </Link>
-            )}
-
-            {/* Cart */}
-            <Link
-              href="/cart"
-              className="text-foreground hover:text-primary relative p-2 transition-colors"
-              aria-label={`${itemCount} ${itemCount === 1 ? tc('item') : tc('items')}`}
-            >
-              <svg className="h-5 w-5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-                <path
-                  strokeLinecap="round"
-                  strokeLinejoin="round"
-                  strokeWidth={2}
-                  d="M16 11V7a4 4 0 00-8 0v4M5 9h14l1 12H4L5 9z"
-                />
-              </svg>
-              {itemCount > 0 && (
-                <span className="bg-primary text-primary-foreground absolute -end-0.5 -top-0.5 flex h-[18px] min-w-[18px] items-center justify-center rounded-full text-[10px] font-bold">
-                  {itemCount > 99 ? '99+' : itemCount}
-                </span>
-              )}
-            </Link>
-
-            {/* Mobile menu button */}
-            <button
-              type="button"
-              onClick={() => setMobileMenuOpen(!mobileMenuOpen)}
-              className="text-foreground p-2 md:hidden"
-              aria-label={t('menu')}
-            >
-              <svg className="h-5 w-5" fill="none" viewBox="0 0 24 24" stroke="currentColor">
-                {mobileMenuOpen ? (
-                  <path
-                    strokeLinecap="round"
-                    strokeLinejoin="round"
-                    strokeWidth={2}
-                    d="M6 18L18 6M6 6l12 12"
-                  />
-                ) : (
-                  <path
-                    strokeLinecap="round"
-                    strokeLinejoin="round"
-                    strokeWidth={2}
-                    d="M4 6h16M4 12h16M4 18h16"
-                  />
-                )}
-              </svg>
-            </button>
-          </div>
-        </div>
-
-        {/* Mobile Menu */}
-        {mobileMenuOpen && (
-          <div className="border-border space-y-2 border-t py-3 md:hidden">
-            <Link
-              href="/products"
-              onClick={() => setMobileMenuOpen(false)}
-              className="text-foreground hover:bg-muted block rounded px-2 py-2 text-sm"
-            >
-              {t('products')}
-            </Link>
-            {isLoggedIn && (
-              <Link
-                href="/account"
-                onClick={() => setMobileMenuOpen(false)}
-                className="text-foreground hover:bg-muted block rounded px-2 py-2 text-sm"
-              >
-                {t('account')}
-              </Link>
-            )}
-            {isLoggedIn ? (
-              <button
-                onClick={() => {
-                  logout();
-                  setMobileMenuOpen(false);
-                }}
-                className="text-foreground hover:bg-muted block w-full rounded px-2 py-2 text-start text-sm"
-              >
-                {t('logout')}
-              </button>
-            ) : (
-              <Link
-                href="/login"
-                onClick={() => setMobileMenuOpen(false)}
-                className="text-foreground hover:bg-muted block rounded px-2 py-2 text-sm"
-              >
-                {t('login')}
-              </Link>
-            )}
-
-            {/* Mobile search */}
-            <form onSubmit={handleSearchSubmit} className="px-2 pt-2">
-              <input
-                type="text"
-                value={searchQuery}
-                onChange={(e) => setSearchQuery(e.target.value)}
-                placeholder={t('searchPlaceholder')}
-                className="border-border bg-background text-foreground placeholder:text-muted-foreground focus:ring-primary/20 focus:border-primary h-9 w-full rounded border px-3 text-sm focus:outline-none focus:ring-2"
-              />
-            </form>
-          </div>
-        )}
-      </div>
-    </header>
-  );
-}