orionplace-react 0.7.7 → 0.8.0

package/templates/lib/orionplace/productSearch.ts

@@ -1,280 +0,0 @@
-import type {
-  IProductSearchFacets,
-  ProductFacetSelection,
-} from '@/interfaces/orionplace/products/IProductSearchFacets';
-import type {
-  IProductSearchFilters,
-  IProductSearchResponse,
-} from '@/interfaces/orionplace/products/IProductSearchApi';
-import type { OrionplaceApi } from '@/lib/orionplace/api';
-import { initialSearchFacets } from '@/lib/orionplace/searchFilters';
-
-export type ProductSearchPage = NonNullable<
-  IProductSearchResponse['page_data']
->;
-
-export interface ProductSearchScope {
-  query?: string;
-  categoryId?: number;
-  // The category and its public descendants (`catalogBranchIds`).
-  categoryIds?: number[];
-  sellerId?: number;
-  manufacturerId?: number;
-  storeId?: number;
-  featured?: boolean;
-}
-
-export interface ProductSearchScopeNames {
-  manufacturer?: string;
-  seller?: string;
-  store?: string;
-}
-
-export interface ProductSearchScopeLabels {
-  home: string;
-  searchCrumb: string;
-  searchResults: string;
-  products: string;
-  manufacturers: string;
-  sellers: string;
-  stores: string;
-  manufacturerProducts: string;
-  sellerProducts: string;
-  storeProducts: string;
-}
-
-export interface ProductSearchCrumb {
-  label: string;
-  path?: string;
-  query?: Record<string, string | number>;
-}
-
-interface DirectoryScope {
-  queryKey: 'manufacturer' | 'seller' | 'store';
-  id: number;
-  name: string;
-  section: string;
-  sectionPath: string;
-  caption: string;
-}
-
-function directoryScopes(
-  scope: ProductSearchScope,
-  names: ProductSearchScopeNames,
-  labels: ProductSearchScopeLabels,
-): DirectoryScope[] {
-  const entries: Array<DirectoryScope | undefined> = [
-    scope.manufacturerId
-      ? {
-          queryKey: 'manufacturer',
-          id: scope.manufacturerId,
-          name: names.manufacturer ?? '',
-          section: labels.manufacturers,
-          sectionPath: '/manufacturers',
-          caption: labels.manufacturerProducts,
-        }
-      : undefined,
-    scope.sellerId
-      ? {
-          queryKey: 'seller',
-          id: scope.sellerId,
-          name: names.seller ?? '',
-          section: labels.sellers,
-          sectionPath: '/sellers',
-          caption: labels.sellerProducts,
-        }
-      : undefined,
-    scope.storeId
-      ? {
-          queryKey: 'store',
-          id: scope.storeId,
-          name: names.store ?? '',
-          section: labels.stores,
-          sectionPath: '/stores',
-          caption: labels.storeProducts,
-        }
-      : undefined,
-  ];
-
-  return entries.filter((entry): entry is DirectoryScope => Boolean(entry));
-}
-
-export function productSearchTrail(
-  scope: ProductSearchScope,
-  names: ProductSearchScopeNames,
-  labels: ProductSearchScopeLabels,
-): ProductSearchCrumb[] {
-  const query                              = scope.query?.trim() ?? '';
-  const directories                        = directoryScopes(scope, names, labels);
-  const trail: ProductSearchCrumb[]        = [{ label: labels.home, path: '/' }];
-  const scopeQuery: Record<string, number> = {};
-
-  if (directories[0]) {
-    trail.push({
-      label: directories[0].section,
-      path: directories[0].sectionPath,
-    });
-  } else {
-    trail.push({ label: labels.searchCrumb });
-  }
-
-  for (const directory of directories) {
-    scopeQuery[directory.queryKey] = directory.id;
-    trail.push({
-      label: directory.name || directory.caption,
-      path: '/browse',
-      query: { ...scopeQuery },
-    });
-  }
-
-  if (query) {
-    trail.push({ label: `«${query}»` });
-  }
-
-  const current                            = trail.at(-1);
-  if (current && trail.length > 1) {
-    delete current.path;
-    delete current.query;
-  }
-
-  return trail;
-}
-
-export function productSearchHeading(
-  scope: ProductSearchScope,
-  names: ProductSearchScopeNames,
-  labels: ProductSearchScopeLabels,
-) {
-  const [directory] = directoryScopes(scope, names, labels);
-
-  if (!directory) {
-    return { title: labels.searchResults, caption: '', named: false };
-  }
-
-  return {
-    title: directory.name || directory.caption,
-    caption: directory.caption,
-    named: Boolean(directory.name),
-  };
-}
-
-export function productSearchSeoTitle(
-  scope: ProductSearchScope,
-  names: ProductSearchScopeNames,
-  labels: ProductSearchScopeLabels,
-) {
-  const query   = scope.query?.trim() ?? '';
-  const heading = productSearchHeading(scope, names, labels);
-  const base    = heading.named
-    ? `${heading.title} — ${labels.products}`
-    : heading.title;
-
-  return query ? `${base} · ${query}` : base;
-}
-
-export function productSearchFixedFilters(
-  scope: ProductSearchScope,
-): IProductSearchFilters {
-  return {
-    ...(scope.query ? { search_string: scope.query } : {}),
-    ...(scope.categoryId
-      ? { categories: scope.categoryIds ?? [scope.categoryId] }
-      : {}),
-    ...(scope.sellerId ? { product_owner: [scope.sellerId] } : {}),
-    ...(scope.manufacturerId
-      ? { product_manufacture: [scope.manufacturerId] }
-      : {}),
-    ...(scope.storeId ? { physical_store: scope.storeId } : {}),
-    ...(scope.featured ? { only_featured: true } : {}),
-  };
-}
-
-export function productSearchFacetData(
-  page: ProductSearchPage | undefined,
-): IProductSearchFacets | null {
-  if (!page?.selects && !page?.variants) {
-    return null;
-  }
-  return {
-    selects: page.selects ?? {},
-    variants: page.variants,
-  } as IProductSearchFacets;
-}
-
-/** Products per result page, as in the Nuxt and Svelte packages. */
-export const productSearchPageSize = 12;
-
-export function productSearchRequest(
-  scope: ProductSearchScope,
-  filters: ProductFacetSelection,
-  page: number,
-) {
-  return {
-    filters: {
-      ...filters,
-      ...productSearchFixedFilters(scope),
-    } as IProductSearchFilters,
-    paginate: { page, pp_items: productSearchPageSize },
-  };
-}
-
-export async function loadProductSearch(
-  api: OrionplaceApi,
-  scope: ProductSearchScope,
-  filters: ProductFacetSelection = {},
-  page = 1,
-  signal?: AbortSignal,
-) {
-  return api.request<ProductSearchPage>(
-    'products_search',
-    productSearchRequest(scope, filters, page),
-    signal,
-  );
-}
-
-/**
- * A result page with `fullFacets`: the filter choices of the unfiltered
- * first page, when the page was a later one or loaded with filters.
- */
-export type ProductListPage = ProductSearchPage & {
-  fullFacets?: IProductSearchFacets | null;
-};
-
-/**
- * A list opened from its URL (Back, a reload) on a later page or with
- * filters gets only the filtered choices, or none after the first page.
- * With `withFullFacets` this also asks for the unfiltered first page, so the
- * filter panel keeps every seller, price and option to choose from. The
- * extra request is only for the panel: when it fails the panel shows the
- * choices of the result.
- */
-export async function loadProductListPage(
-  api: OrionplaceApi,
-  scope: ProductSearchScope,
-  filters: ProductFacetSelection = {},
-  page = 1,
-  signal?: AbortSignal,
-  withFullFacets = true,
-): Promise<ProductListPage> {
-  // Both requests run together.
-  const [data, full] = await Promise.all([
-    loadProductSearch(api, scope, filters, page, signal),
-    withFullFacets && (page > 1 || Object.keys(filters).length > 0)
-      ? loadProductSearch(api, scope, {}, 1, signal).catch(() => undefined)
-      : undefined,
-  ]);
-
-  return full ? { ...data, fullFacets: productSearchFacetData(full) } : data;
-}
-
-/** The filter choices of a list page: the full ones first, as kept by the store. */
-export function productListFacetData(
-  page: ProductListPage | undefined,
-  previous: IProductSearchFacets | null = null,
-) {
-  return [page?.fullFacets ?? null, productSearchFacetData(page)].reduce(
-    (current, incoming) =>
-      incoming ? initialSearchFacets(current, incoming) : current,
-    previous,
-  );
-}

package/templates/lib/orionplace/productSeller.ts

@@ -1,56 +0,0 @@
-import type {
-  IAppLoadProduct,
-  IProduct,
-  IProductSearchSeller,
-  IProductSeller,
-} from '@/interfaces/orionplace/products/IProduct';
-
-type LegacyAppLoadProduct = IAppLoadProduct & {
-  seller?: IProductSeller;
-};
-
-export function resolveAppLoadProducts(
-  products: readonly IAppLoadProduct[] | undefined,
-  sellers: Readonly<Record<string, IProductSeller>> | undefined,
-): IProduct[] {
-  const resolved: IProduct[] = [];
-
-  for (const product of products ?? []) {
-    const legacySeller = (product as LegacyAppLoadProduct).seller;
-    const seller = legacySeller ?? sellers?.[String(product.seller_id)];
-    if (!seller) {
-      continue;
-    }
-
-    resolved.push({ ...product, seller });
-  }
-
-  return resolved;
-}
-
-/**
- * A product search response lists the preorder permission of each seller in
- * `selects.sellers`. A product without its own `is_accepting_preorders`
- * receives the permission of its seller; an existing value is kept.
- */
-export function productWithSellerPermission(
-  product: IProduct,
-  sellers: readonly IProductSearchSeller[] = [],
-): IProduct {
-  if (product.seller.is_accepting_preorders != null) {
-    return product;
-  }
-
-  const seller = sellers.find((item) => item.id === product.seller.id);
-  if (typeof seller?.is_accepting_preorders !== 'boolean') {
-    return product;
-  }
-
-  return {
-    ...product,
-    seller: {
-      ...product.seller,
-      is_accepting_preorders: seller.is_accepting_preorders,
-    },
-  };
-}

package/templates/lib/orionplace/productStructuredData.ts

@@ -1,221 +0,0 @@
-// The product page's schema.org data for search engines: Google merchant
-// listings and Yandex product snippets read the same block. Every value
-// repeats what the page shows: the price and the crossed-out old price,
-// stock, return terms, photos, brand, seller and rating. The delivery cost is
-// left out: it depends on the buyer's address.
-// The same file is in the three packages; it has no imports so that it stays
-// identical.
-
-const SCHEMA_ORG       = 'https://schema.org/';
-const MAX_IMAGES       = 10;
-// EProductStatus.PUBLISHED and PUBLISHED_AS_OPTION: the product is on sale.
-const ON_SALE_STATUSES = [2, 1];
-
-interface StructuredPrice {
-  transform_value: number;
-}
-
-/** The product fields the data uses (IProduct has them all). */
-export interface StorefrontStructuredProduct {
-  id: number;
-  is_digital?: boolean;
-  discount: number;
-  base_price_dict: Record<string, StructuredPrice>;
-  product_price_dict: Record<string, StructuredPrice>;
-  images?: { full?: string[] | null; small?: string[] | null } | null;
-  status: { status: number };
-  c_real_left: number;
-  seller?: { name?: string | null } | null;
-  manufacture?: { name?: string | null } | null;
-  refunds?: {
-    customer_max_refund_days: number;
-    max_refund_days_with_defect: number;
-  } | null;
-  feedback_stat?: {
-    c_feedbacks?: number | null;
-    avg_raiting?: number | string | null;
-  } | null;
-}
-
-export interface StorefrontProductDataOptions {
-  /** The page's canonical address; without one the page gets no data. */
-  url: string | undefined;
-  name: string | undefined;
-  description?: string;
-  /** The currency the page shows prices in (its ID and code). */
-  currencyId: string;
-  currencyCode: string | undefined;
-  /** App Load `init.shipping_countries`, parsed by shippingCountryCodes(). */
-  shippingCountries: string[];
-  /** False when the page hides the seller (single-seller storefront). */
-  showSeller: boolean;
-  /** Makes an image address complete (storefrontAbsoluteUrl). */
-  absoluteUrl: (value: string | undefined) => string | undefined;
-}
-
-/**
- * The countries the shop ships to: App Load `init.shipping_countries` (the
- * backend's countries marked as shipping countries), as valid ISO 3166-1
- * alpha-2 codes.
- */
-export function shippingCountryCodes(value: unknown): string[] {
-  const codes = (Array.isArray(value) ? value.join(' ') : String(value ?? ''))
-    .split(/[\s,;]+/)
-    .map((code) => code.trim().toUpperCase())
-    .filter((code) => /^[A-Z]{2}$/.test(code));
-
-  return [...new Set(codes)];
-}
-
-function wholeDays(value: unknown) {
-  const days = Math.floor(Number(value));
-
-  return Number.isFinite(days) && days > 0 ? days : 0;
-}
-
-/**
- * The return terms the page shows: the days for a product without a defect
- * are the return window (sent back by mail at the buyer's cost); a defective
- * product goes back at the shop's cost. A digital product or one without
- * days cannot be returned. Without a shipping country there is no policy:
- * search engines require the country.
- */
-export function productReturnPolicy(
-  product: Pick<StorefrontStructuredProduct, 'is_digital' | 'refunds'>,
-  countries: string[],
-) {
-  if (!countries.length) {
-    return undefined;
-  }
-
-  const applicableCountry = countries.length === 1 ? countries[0] : countries;
-  const returnDays        = product.is_digital
-    ? 0
-    : wholeDays(product.refunds?.customer_max_refund_days);
-  const defectDays        = product.is_digital
-    ? 0
-    : wholeDays(product.refunds?.max_refund_days_with_defect);
-
-  if (!returnDays) {
-    return {
-      '@type': 'MerchantReturnPolicy',
-      applicableCountry,
-      'returnPolicyCategory': `${SCHEMA_ORG}MerchantReturnNotPermitted`,
-    };
-  }
-
-  return {
-    '@type': 'MerchantReturnPolicy',
-    applicableCountry,
-    'returnPolicyCategory': `${SCHEMA_ORG}MerchantReturnFiniteReturnWindow`,
-    'merchantReturnDays': returnDays,
-    'returnMethod': `${SCHEMA_ORG}ReturnByMail`,
-    'returnFees': `${SCHEMA_ORG}ReturnFeesCustomerResponsibility`,
-    ...(defectDays ? { itemDefectReturnFees: `${SCHEMA_ORG}FreeReturn` } : {}),
-  };
-}
-
-function priceValue(
-  prices: Record<string, StructuredPrice> | undefined,
-  currencyId: string,
-) {
-  const value = Number(prices?.[currencyId]?.transform_value);
-
-  return prices?.[currencyId] && Number.isFinite(value) ? value : undefined;
-}
-
-/** The schema.org Product of the page, or undefined when it cannot be built. */
-export function storefrontProductStructuredData(
-  product: StorefrontStructuredProduct | undefined,
-  options: StorefrontProductDataOptions,
-) {
-  const name         = options.name?.trim();
-  const currencyCode = options.currencyCode?.trim().toUpperCase() ?? '';
-
-  if (!product || !options.url || !name) {
-    return undefined;
-  }
-
-  // The price the page shows, as ProductCardPrice picks it.
-  const currencyId   =
-    options.currencyId ||
-    Object.keys(product.product_price_dict ?? {})[0] ||
-    Object.keys(product.base_price_dict ?? {})[0] ||
-    '';
-  const basePrice    = priceValue(product.base_price_dict, currencyId);
-  const price        =
-    priceValue(product.product_price_dict, currencyId) ?? basePrice;
-  const images       = [
-    ...(product.images?.full ?? []),
-    ...(product.images?.small ?? []),
-  ]
-    .map((image) => options.absoluteUrl(image))
-    .filter((image, index, list): image is string =>
-      Boolean(image) && list.indexOf(image) === index,
-    )
-    .slice(0, MAX_IMAGES);
-  const inStock      =
-    ON_SALE_STATUSES.includes(product.status?.status) &&
-    product.c_real_left > 0;
-  const returns      = productReturnPolicy(product, options.shippingCountries);
-  const brand        = product.manufacture?.name?.trim();
-  const seller       = options.showSeller ? product.seller?.name?.trim() : '';
-  const reviews      = Number(product.feedback_stat?.c_feedbacks ?? 0);
-  const rating       = Number(product.feedback_stat?.avg_raiting ?? 0);
-  const offer        =
-    price !== undefined && /^[A-Z]{3}$/.test(currencyCode)
-      ? {
-          '@type': 'Offer',
-          'url': options.url,
-          price,
-          'priceCurrency': currencyCode,
-          // The crossed-out old price, when the page shows one.
-          ...(basePrice !== undefined && price < basePrice
-            ? {
-                priceSpecification: {
-                  '@type': 'UnitPriceSpecification',
-                  'priceType': `${SCHEMA_ORG}StrikethroughPrice`,
-                  'price': basePrice,
-                  'priceCurrency': currencyCode,
-                },
-              }
-            : {}),
-          'availability': `${SCHEMA_ORG}${inStock ? 'InStock' : 'OutOfStock'}`,
-          'itemCondition': `${SCHEMA_ORG}NewCondition`,
-          ...(returns ? { hasMerchantReturnPolicy: returns } : {}),
-          ...(seller
-            ? { seller: { '@type': 'Organization', 'name': seller } }
-            : {}),
-        }
-      : undefined;
-
-  return {
-    '@context': 'https://schema.org',
-    '@type': 'Product',
-    name,
-    'url': options.url,
-    'sku': String(product.id),
-    ...(options.description?.trim()
-      ? { description: options.description.trim() }
-      : {}),
-    ...(images.length ? { image: images } : {}),
-    ...(brand ? { brand: { '@type': 'Brand', 'name': brand } } : {}),
-    ...(offer ? { offers: offer } : {}),
-    ...(reviews > 0 && Number.isFinite(rating) && rating > 0
-      ? {
-          aggregateRating: {
-            '@type': 'AggregateRating',
-            'ratingValue': Math.round(rating * 10) / 10,
-            'reviewCount': reviews,
-          },
-        }
-      : {}),
-  };
-}
-
-/** The data as the text of a <script type="application/ld+json"> tag. */
-export function structuredDataJson(value: unknown): string {
-  return value === undefined
-    ? ''
-    : JSON.stringify(value).replace(/</g, '\\u003c');
-}