orionplace-react 0.7.8 → 0.8.0

package/templates/lib/orionplace/pageMetadata.ts

@@ -1,361 +0,0 @@
-import type { Metadata } from 'next';
-import type { IAppLoadCommon } from '@/interfaces/orionplace/appBase/IAppLoadCommon';
-import type {
-  IProduct,
-  IProductLocale,
-} from '@/interfaces/orionplace/products/IProduct';
-import type { IBlogPost } from '@/interfaces/orionplace/blog/IBlogApi';
-import type {
-  ISubscribeTariff,
-  ISubscribeTariffLocales,
-} from '@/interfaces/orionplace/subscribeTariff/ISubscribeTariff';
-import type { ICategoryLocale } from '@/interfaces/orionplace/category/ICategory';
-import type { IPromoDefinition } from '@/interfaces/orionplace/cart/ICartData';
-import { promoName } from '@/lib/orionplace/promoPresentation';
-import {
-  storefrontAbsoluteUrl,
-  storefrontAlternateLinks,
-  storefrontArticleData,
-  storefrontCanonicalUrl,
-  storefrontIconLinks,
-  storefrontIsoDate,
-  storefrontOpenGraphLocale,
-  storefrontOpenGraphType,
-  storefrontPageMetadata,
-  storefrontPagedText,
-  type StorefrontSeoPage,
-} from '@/lib/orionplace/pageSeo';
-import { structuredDataJson } from '@/lib/orionplace/productStructuredData';
-import { getStorefrontSeo } from '@/lib/orionplace/seo';
-import { findCatalogCategory } from '@/lib/orionplace/catalog';
-import { blogPostCover } from '@/lib/orionplace/blogPresentation';
-import { browseLabels } from '@/lib/orionplace/browseLabels';
-import {
-  productSearchSeoTitle,
-  type ProductSearchScope,
-  type ProductSearchScopeNames,
-} from '@/lib/orionplace/productSearch';
-import {
-  getAvailableNestedValueFromObject,
-  plainText,
-} from '@/lib/orionplace/presentation';
-
-const privatePages = new Set([
-  'activity',
-  'addresses',
-  'cart',
-  'logout',
-  'orders',
-  'profile',
-  'subscriptions',
-  'tickets',
-  'unsubscribe',
-  'wallet',
-  'wishlist',
-]);
-
-type MetadataValues = {
-  title?: string;
-  description?: string;
-  keywords?: string;
-};
-type MetaTags = ReturnType<typeof getStorefrontSeo>['meta'];
-
-export type StorefrontPageRecords = {
-  product?: IProduct;
-  post?: IBlogPost;
-  tariff?: ISubscribeTariff;
-  promo?: IPromoDefinition | null;
-  search?: { scope: ProductSearchScope; names: ProductSearchScopeNames };
-  pageKind?: 'notFound' | 'error';
-};
-
-export function storefrontSeoPage(pathname: string): StorefrontSeoPage {
-  const segments    = pathname.split('/').filter(Boolean);
-  const section     = segments[0];
-  const staticPages = new Set([
-    'browse',
-    'catalog',
-    'featured',
-    'journal',
-    'manufacturers',
-    'sellers',
-    'stores',
-    'contact',
-    'privacy',
-    'tariffs',
-    ...privatePages,
-  ]);
-
-  if (!section) {
-    return 'home';
-  }
-  if (segments.length === 1 && staticPages.has(section)) {
-    return section as StorefrontSeoPage;
-  }
-  const id          = segments.at(-1) ?? '';
-  if (section === 'promo' && segments.length === 2) {
-    const promoId    = Number(id);
-    const validPromo =
-      /^\d+$/.test(id) && Number.isSafeInteger(promoId) && promoId > 0;
-    return validPromo ? 'promo' : 'notFound';
-  }
-  const positiveId  = /^[1-9]\d*$/.test(id);
-  if (!positiveId) {
-    return 'notFound';
-  }
-  if (section === 'tariffs' && segments.length === 3) {
-    return 'tariff';
-  }
-  if (section === 'journal' && segments.length === 2) {
-    return 'publication';
-  }
-  if (segments.length === 2 && ['category', 'product'].includes(section)) {
-    return section as StorefrontSeoPage;
-  }
-  return 'notFound';
-}
-
-export function storefrontMetadata(
-  init: IAppLoadCommon | null,
-  locale: string,
-  url: URL,
-  records: StorefrontPageRecords = {},
-  // The public origin (the proxy's host on the server, the page's own in the browser).
-  origin = url.origin,
-) {
-  const segments               = url.pathname.split('/').filter(Boolean);
-  let page                     = records.pageKind ?? storefrontSeoPage(url.pathname);
-  if (
-    page === 'category' &&
-    init &&
-    !findCatalogCategory(init.catalog ?? [], Number(segments[1]))
-  ) {
-    page = 'notFound';
-  }
-  const values: MetadataValues = {};
-  let image: string | undefined;
-  let published: string | undefined;
-  let modified: string | undefined;
-  const tags: MetaTags         = [];
-  let robots: string | undefined;
-  // A private product link (`key`) stays out of search results, loaded or not.
-  if (
-    privatePages.has(page) ||
-    page === 'notFound' ||
-    page === 'error' ||
-    (page === 'product' && url.searchParams.get('key'))
-  ) {
-    robots = 'noindex, nofollow';
-  } else if (page === 'browse') {
-    robots = 'noindex, follow';
-  }
-
-  if (page === 'home') {
-    const seo          = getStorefrontSeo(init?.seo ?? [], locale);
-    values.title       = seo.title || init?.contact?.company_name || 'Orionplace';
-    values.description = seo.meta.findLast(
-      (tag) => 'name' in tag && tag.name === 'description',
-    )?.content;
-    values.keywords    = seo.meta.findLast(
-      (tag) => 'name' in tag && tag.name === 'keywords',
-    )?.content;
-    tags.push(
-      ...seo.meta.filter(
-        (tag) =>
-          !('name' in tag && ['description', 'keywords'].includes(tag.name)),
-      ),
-    );
-  } else if (page === 'browse') {
-    const scope  = records.search?.scope ?? {
-      query: url.searchParams.get('q') ?? '',
-      manufacturerId: Number(url.searchParams.get('manufacturer')) || undefined,
-      sellerId: Number(url.searchParams.get('seller')) || undefined,
-      storeId: Number(url.searchParams.get('store')) || undefined,
-    };
-    values.title = productSearchSeoTitle(
-      scope,
-      records.search?.names ?? {},
-      browseLabels(locale),
-    );
-  } else if (page === 'category') {
-    const category     = findCatalogCategory(
-      init?.catalog ?? [],
-      Number(segments[1]),
-    );
-    const field        = <Key extends keyof ICategoryLocale>(name: Key) =>
-      getAvailableNestedValueFromObject(category?.locale, locale, name);
-    values.title       = field('cg_title') || field('cg_name');
-    values.description = field('meta_description');
-    values.keywords    = field('meta_keywords');
-  } else if (page === 'product' && records.product) {
-    const product      = records.product;
-    const field        = <Key extends keyof IProductLocale>(name: Key) =>
-      getAvailableNestedValueFromObject(product.locale, locale, name);
-    values.title       = field('product_name');
-    values.description = plainText(
-      field('meta_description') || field('short_description'),
-    ).slice(0, 160);
-    image              = product.images?.full?.[0] ?? product.images?.small?.[0];
-  } else if (page === 'publication' && records.post) {
-    values.title       = getAvailableNestedValueFromObject(
-      records.post.locale,
-      locale,
-      'post_title',
-    );
-    values.description = plainText(
-      getAvailableNestedValueFromObject(
-        records.post.locale,
-        locale,
-        'post_preview_text',
-      ),
-    ).slice(0, 160);
-    image              = blogPostCover(records.post);
-    published          = storefrontIsoDate(records.post.date_created?.date);
-    modified           =
-      storefrontIsoDate(records.post.date_updated?.date) ?? published;
-  } else if (page === 'tariff' && records.tariff) {
-    const tariff       = records.tariff;
-    const field        = <Key extends keyof ISubscribeTariffLocales>(name: Key) =>
-      getAvailableNestedValueFromObject(tariff.locales, locale, name);
-    values.title       = field('tariff_title') || field('tariff_name');
-    values.description = plainText(
-      field('tariff_meta_description') || field('tariff_short_description'),
-    ).slice(0, 160);
-    values.keywords    = field('tariff_meta_keywords');
-    image              = tariff.tariff_image?.full?.[0] ?? tariff.tariff_image?.small?.[0];
-    robots             = 'index, follow';
-  } else if (page === 'promo' && records.promo) {
-    // The offer's name, as the other packages title this page.
-    values.title       = promoName(records.promo, locale);
-  }
-  const listContent            = storefrontPageMetadata(page, locale, values);
-  // Link previews load only complete image addresses; the canonical address
-  // is the sitemap's one for this page.
-  image                        = storefrontAbsoluteUrl(image, origin);
-  const canonical              = storefrontCanonicalUrl(
-    origin,
-    url.pathname,
-    url.search,
-    locale,
-    robots,
-  );
-  // A later list page (`?page=2`) names its page number.
-  const content                = {
-    ...listContent,
-    title: storefrontPagedText(listContent.title, canonical, locale) ?? listContent.title,
-    description: storefrontPagedText(listContent.description, canonical, locale) ?? listContent.description,
-  };
-  // The home page may carry the admin's own og:type (tags, rendered as is).
-  const ogType                 = tags.some(
-    (tag) => 'property' in tag && tag.property === 'og:type',
-  )
-    ? undefined
-    : storefrontOpenGraphType(page);
-  const ogLocale               = storefrontOpenGraphLocale(locale);
-  // The page in the storefront's other languages, beside the canonical one.
-  const languages              = Object.fromEntries(
-    storefrontAlternateLinks(canonical, Object.keys(init?.locale ?? {})).map(
-      (alternate) => [alternate.hreflang, alternate.href],
-    ),
-  );
-  const icon                   = storefrontIconLinks(init?.logos?.ico)[0]?.href;
-  // Next.js has no og:type "product"; that page gets it as a plain tag below.
-  const openGraph              = ogType === 'article'
-    ? {
-        type: 'article' as const,
-        ...(published ? { publishedTime: published } : {}),
-        ...(modified ? { modifiedTime: modified } : {}),
-      }
-    : ogType === 'website'
-      ? { type: 'website' as const }
-      : {};
-  const metadata: Metadata     = {
-    ...content,
-    ...(robots ? { robots } : {}),
-    ...(canonical
-      ? {
-          alternates: {
-            canonical,
-            ...(Object.keys(languages).length ? { languages } : {}),
-          },
-        }
-      : {}),
-    ...(icon ? { icons: { icon } } : {}),
-    openGraph: {
-      ...openGraph,
-      title: content.title,
-      description: content.description,
-      ...(ogLocale ? { locale: ogLocale } : {}),
-      ...(canonical ? { url: canonical } : {}),
-      ...(image ? { images: [image] } : {}),
-    },
-  };
-  if (ogType === 'product') {
-    tags.unshift({ property: 'og:type', content: 'product' });
-  }
-  // A journal article as schema.org BlogPosting, with the store as its author.
-  const jsonLd                 =
-    page === 'publication' && records.post && canonical && origin
-      ? structuredDataJson(
-          storefrontArticleData({
-            canonical,
-            origin,
-            headline: content.title,
-            description: content.description,
-            image,
-            published,
-            modified,
-            locale,
-            storeName: init?.contact?.company_name,
-          }),
-        )
-      : '';
-  const headTags               = new Map<
-    string,
-    { name?: string; property?: string; content: string }
-  >();
-  for (const [name, value] of Object.entries({
-    description: content.description,
-    keywords: content.keywords,
-    robots,
-    'og:title': content.title,
-    'og:description': content.description,
-    'og:image': image,
-    'og:url': canonical,
-    'og:type': ogType,
-    'og:locale': ogLocale,
-    'article:published_time': ogType === 'article' ? published : undefined,
-    'article:modified_time': ogType === 'article' ? modified : undefined,
-  })) {
-    headTags.set(name, {
-      ...(/^(?:og|article):/.test(name) ? { property: name } : { name }),
-      content: value ?? '',
-    });
-  }
-  for (const tag of tags) {
-    const name = 'property' in tag ? tag.property : tag.name;
-    headTags.set(name, tag);
-  }
-  return {
-    metadata,
-    tags,
-    jsonLd,
-    head: {
-      title: content.title,
-      meta: [...headTags.values()],
-      // The canonical address and its other languages, for the browser's
-      // head after an in-page change (a list page, a language).
-      links: canonical
-        ? [
-            { rel: 'canonical', href: canonical },
-            ...Object.entries(languages).map(([hreflang, href]) => ({
-              rel: 'alternate',
-              hreflang,
-              href,
-            })),
-          ]
-        : [],
-    },
-  };
-}