@shoppexio/storefront-react 0.1.4 → 0.2.0

package/dist/index.js

@@ -5,19 +5,25 @@ import {
   ACCOUNT_STOREFRONT_ROUTES,
   ACCOUNT_TABS,
   DEFAULT_ACCOUNT_TAB,
+  FAVORITES_CHANGED_EVENT,
+  FavoritesProvider,
   IMPLEMENTED_ACCOUNT_TABS,
   SERVING_CONTEXT_HINT,
   accountOrderHref,
   accountTabHref,
   accountTabLabelKey,
   canonicalAccountPath,
+  createFavoritesStore,
   getBuyerCurrency,
   getShoppex,
   isAccountTab,
   isImplementedAccountTab,
+  notifyFavoritesChanged,
   parseAccountPath,
-  resolveAccountView
-} from "./chunk-D6XKDVAV.js";
+  resolveAccountView,
+  sdkFavoritesTransport,
+  useFavorites
+} from "./chunk-ZEFZPUAW.js";
 
 // src/account-route-messages.ts
 var ACCOUNT_ROUTE_MESSAGE_KEYS = [
@@ -283,6 +289,43 @@ function badgesForProductPage(badges) {
   return badges.filter((badge) => badge.showOnProductPage);
 }
 
+// src/service-status.ts
+var SERVICE_STATES = ["operational", "updating", "detected", "offline"];
+var STATE_ORDER = { detected: 0, offline: 1, updating: 2, operational: 3 };
+function parseServiceStatus(value, context) {
+  if (value === null || value === void 0) return null;
+  if (typeof value !== "object" || Array.isArray(value)) {
+    throw new Error(`Invalid Shoppex ${context}.service_status: expected an object or null.`);
+  }
+  const record = value;
+  const state = record.state;
+  if (typeof state !== "string" || !SERVICE_STATES.includes(state)) {
+    throw new Error(`Invalid Shoppex ${context}.service_status.state: expected one of ${SERVICE_STATES.join(", ")}.`);
+  }
+  const updatedAt = record.updated_at;
+  if (typeof updatedAt !== "string" || Number.isNaN(Date.parse(updatedAt))) {
+    throw new Error(`Invalid Shoppex ${context}.service_status.updated_at: expected an ISO timestamp.`);
+  }
+  const note = typeof record.note === "string" && record.note.trim() ? record.note.trim() : null;
+  return { state, note, updatedAt };
+}
+function buildStatusPageModel(products) {
+  const entries = [];
+  const seen = /* @__PURE__ */ new Set();
+  for (const product of products) {
+    if (product.serviceStatus === null || seen.has(product.id)) continue;
+    seen.add(product.id);
+    entries.push({ product, status: product.serviceStatus });
+  }
+  if (entries.length === 0) return null;
+  entries.sort((a, b) => STATE_ORDER[a.status.state] - STATE_ORDER[b.status.state]);
+  const counts = { operational: 0, updating: 0, detected: 0, offline: 0 };
+  for (const entry of entries) counts[entry.status.state] += 1;
+  const presentStates = [...SERVICE_STATES].sort((a, b) => STATE_ORDER[a] - STATE_ORDER[b]).filter((state) => counts[state] > 0);
+  const lastUpdatedAt = entries.map((entry) => entry.status.updatedAt).reduce((latest, value) => Date.parse(value) > Date.parse(latest) ? value : latest);
+  return { entries, counts, presentStates, lastUpdatedAt };
+}
+
 // src/video-embed.ts
 var ALLOWED_VIDEO_EMBED_HOSTS = /* @__PURE__ */ new Set([
   "www.youtube-nocookie.com",
@@ -372,11 +415,30 @@ function resolveProductVideoEmbedSrc(value) {
 var PRODUCT_TYPES = ["PRODUCT", "SUBSCRIPTION", "INFO_CARD", "SERIALS", "PHYSICAL"];
 function resolveDeliveryPromise(product) {
   if (product.productType === "PHYSICAL") return { kind: "shipped" };
+  if (!product.deliveryTimeStated) return { kind: "unspecified" };
   if (product.deliveryTimeCount !== null) {
     return { kind: "timed", count: product.deliveryTimeCount, unit: product.deliveryTimeUnit };
   }
   return { kind: "instant" };
 }
+var DELIVERABLES_BY_TYPE = {
+  SERIALS: "serials",
+  FILE: "file",
+  SERVICE: "service",
+  DYNAMIC: "dynamic",
+  INFO_CARD: "info_card",
+  SUBSCRIPTION: "subscription",
+  PHYSICAL: "physical"
+};
+function parseDeliverable(value) {
+  const normalized = typeof value === "string" ? value.trim().toUpperCase() : "";
+  return DELIVERABLES_BY_TYPE[normalized] ?? null;
+}
+function resolveYouReceive(product) {
+  if (product.deliverable === "serials") return { kind: "serials", unitLabel: product.unitLabelSingular };
+  if (product.deliverable === "file") return { kind: "download" };
+  return null;
+}
 var SUBSCRIPTION_INTERVAL_UNITS = ["DAY", "WEEK", "MONTH", "YEAR"];
 var SUBSCRIPTION_INTERVAL_NOUNS = {
   DAY: "day",
@@ -405,6 +467,25 @@ function parseSubscription(product, productType) {
     trialDays: normalizePositiveDays(product.trial_period) ?? 0
   };
 }
+var PAYMENT_METHOD_KINDS = ["card", "wallet", "crypto"];
+function parsePaymentMethods(value) {
+  if (!Array.isArray(value)) {
+    throw new Error("Invalid Shoppex store: payment_methods must be an array.");
+  }
+  return value.map((entry, index) => {
+    const context = `store.payment_methods[${index}]`;
+    const record = requireUnknownRecord(entry, context);
+    const kind = record.kind;
+    if (typeof kind !== "string" || !PAYMENT_METHOD_KINDS.includes(kind)) {
+      throw new Error(`Invalid Shoppex ${context}: kind must be card, wallet or crypto.`);
+    }
+    return {
+      id: requireString(record, "id", context),
+      label: requireString(record, "label", context),
+      kind
+    };
+  });
+}
 function hasInjectedStorefrontData() {
   return window.__SHOPPEX_INITIAL__ !== void 0;
 }
@@ -583,7 +664,7 @@ function getStorefrontSettings() {
     ]),
     defaultCurrency,
     activeCurrency,
-    availableGateways: (Array.isArray(store.available_gateways) ? store.available_gateways : []).filter((entry) => typeof entry === "string" && entry.trim() !== ""),
+    paymentMethods: parsePaymentMethods(store.payment_methods),
     cartEnabled: optionalBoolean(store.cart_enabled, true, "store.cart_enabled"),
     hideOutOfStock: optionalBoolean(store.hide_out_of_stock, false, "store.hide_out_of_stock"),
     hideStockCounter: optionalBoolean(store.hide_stock_counter, false, "store.hide_stock_counter"),
@@ -608,6 +689,7 @@ function getStorefrontSettings() {
     // visitor only found out from the backend's refusal. A payload without them
     // is broken, so it fails here instead.
     contactFormEnabled: requireBoolean(store.contact_form_enabled, "store.contact_form_enabled"),
+    stockAlertsEnabled: requireBoolean(store.stock_alerts_enabled, "store.stock_alerts_enabled"),
     requireInvoiceForContact: requireBoolean(
       store.require_invoice_for_contact,
       "store.require_invoice_for_contact"
@@ -724,13 +806,19 @@ function parseProduct(value, index) {
     rating: rating?.average ?? null,
     ratingCount: rating?.count ?? 0,
     ratingTally: rating?.tally ?? null,
+    shortDescription: optionalString(product.short_description),
+    deliverable: parseDeliverable(product.type),
+    unitLabelSingular: optionalString(product.label_singular),
+    unitLabelPlural: optionalString(product.label_plural),
+    serviceStatus: parseServiceStatus(product.service_status, context),
     highlights: parseHighlights(product.product_highlights),
     metadata: parseMetadata(product.metadata),
     descriptionTabs: parseContentTabs(product.description_tabs),
     faqs: parseFaqs(product.faqs),
     license: parseProductLicense(product),
     licensingEnabled: product.licensing_enabled === true || product.licensing_enabled === 1,
-    deliveryTimeCount: normalizePositiveDays(product.delivery_time),
+    deliveryTimeStated: Object.prototype.hasOwnProperty.call(product, "delivery_time") && product.delivery_time !== void 0,
+    deliveryTimeCount: normalizeDeliveryCount(product.delivery_time),
     deliveryTimeUnit: normalizeDeliveryTimeUnit(product.delivery_time_unit),
     subscription: parseSubscription(product, productType)
   };
@@ -796,6 +884,7 @@ function parsePriceVariants(value, productContext) {
     return {
       id: requireString(variant, "id", context),
       label: requireStringFromKeys(variant, ["label", "title"], context),
+      description: optionalString(variant.description),
       license: parseVariantLicense(variant),
       price: unitPrice,
       baseUnitPrice: unitPrice,
@@ -1105,6 +1194,11 @@ function normalizeDiscountPercent(value) {
   if (!Number.isFinite(percent) || percent <= 0) return 0;
   return Math.min(percent, 100);
 }
+function normalizeDeliveryCount(value) {
+  if (value === null || value === void 0 || value === "") return null;
+  const parsed = Number(value);
+  return Number.isFinite(parsed) && parsed > 0 ? Math.ceil(parsed) : null;
+}
 function normalizePositiveDays(value) {
   if (value === null || value === void 0 || value === "") return null;
   const parsed = Number(value);
@@ -2542,7 +2636,7 @@ function useNavigationLinks(slot, themeLinks, authored) {
 }
 
 // src/reviews.ts
-import { useEffect as useEffect3, useState as useState3 } from "react";
+import { useCallback as useCallback2, useEffect as useEffect3, useRef as useRef2, useState as useState3 } from "react";
 var SHOP_REVIEW_PAGE_SIZE = 12;
 function toTimestamp(value) {
   if (typeof value === "number" && Number.isFinite(value)) {
@@ -2582,7 +2676,8 @@ function toShopReviews(rows, labels) {
       dateLabel: formatDateLabel(timestamp),
       timestamp,
       productTitle: row.product_title?.trim() || null,
-      verified: row.verified === true
+      verified: row.verified === true,
+      automated: row.is_automated === true
     };
   }).sort((a, b) => b.timestamp - a.timestamp);
 }
@@ -2591,20 +2686,83 @@ function reviewsForProduct(reviews, productTitle) {
   if (!title) return [];
   return reviews.filter((review) => review.productTitle === title);
 }
-async function loadLatestWrittenReviews(limit, labels) {
+async function loadShopReviewsPage(options) {
+  const product = options.product?.trim() || null;
+  const result = await getShoppex().getShopReviewsPage(options.cursor ?? null, product ? { product } : void 0);
+  if (!result.success || !result.data) {
+    throw new Error(result.message?.trim() || "Reviews could not be loaded.");
+  }
+  if (product !== null && result.data.product !== product) {
+    throw new Error("This store does not filter reviews by product yet.");
+  }
+  const { pagination } = result.data;
+  return {
+    reviews: toShopReviews(result.data.feedback, options.labels),
+    nextCursor: pagination.has_more ? pagination.next_cursor : null,
+    summary: result.data.summary ?? null
+  };
+}
+async function loadLatestWrittenReviews(limit, labels, options = {}) {
   const written = [];
   const seen = /* @__PURE__ */ new Set();
   let cursor = null;
-  while (written.length < limit) {
-    const result = await getShoppex().getShopReviewsPage(cursor);
-    if (!result.success || !result.data) return null;
-    written.push(...result.data.feedback.filter((row) => !row.is_automated && (row.comment ?? row.message ?? "").trim() !== ""));
-    const next = result.data.pagination.has_more ? result.data.pagination.next_cursor : null;
-    if (!next || seen.has(next)) break;
-    seen.add(next);
-    cursor = next;
+  try {
+    while (written.length < limit) {
+      const page = await loadShopReviewsPage({ cursor, product: options.product, labels: { anonymousAuthor: labels.anonymousAuthor, emptyComment: "" } });
+      written.push(...page.reviews.filter((review) => !review.automated && review.comment !== ""));
+      if (!page.nextCursor || seen.has(page.nextCursor)) break;
+      seen.add(page.nextCursor);
+      cursor = page.nextCursor;
+    }
+  } catch {
+    return null;
   }
-  return toShopReviews(written, labels).slice(0, limit);
+  return written.slice(0, limit).map((review) => ({ ...review, comment: review.comment || labels.emptyComment }));
+}
+function usePagedShopReviews(options) {
+  const product = options.product?.trim() || null;
+  const { anonymousAuthor, emptyComment } = options.labels;
+  const [state, setState] = useState3({ status: "loading" });
+  const [cursor, setCursor] = useState3(null);
+  const generation = useRef2(0);
+  useEffect3(() => {
+    const current = generation.current += 1;
+    setState({ status: "loading" });
+    setCursor(null);
+    loadShopReviewsPage({ product, labels: { anonymousAuthor, emptyComment } }).then((page) => {
+      if (generation.current !== current) return;
+      setCursor(page.nextCursor);
+      setState({
+        status: "ready",
+        reviews: page.reviews,
+        summary: page.summary,
+        hasMore: page.nextCursor !== null,
+        loadingMore: false,
+        moreFailed: false
+      });
+    }).catch(() => {
+      if (generation.current === current) setState({ status: "error" });
+    });
+  }, [product, anonymousAuthor, emptyComment]);
+  const loadMore = useCallback2(() => {
+    if (state.status !== "ready" || state.loadingMore || cursor === null) return;
+    const current = generation.current;
+    setState({ ...state, loadingMore: true, moreFailed: false });
+    loadShopReviewsPage({ cursor, product, labels: { anonymousAuthor, emptyComment } }).then((page) => {
+      if (generation.current !== current) return;
+      setCursor(page.nextCursor);
+      setState((previous) => previous.status !== "ready" ? previous : {
+        ...previous,
+        reviews: [...previous.reviews, ...page.reviews],
+        hasMore: page.nextCursor !== null,
+        loadingMore: false
+      });
+    }).catch(() => {
+      if (generation.current !== current) return;
+      setState((previous) => previous.status !== "ready" ? previous : { ...previous, loadingMore: false, moreFailed: true });
+    });
+  }, [state, cursor, product, anonymousAuthor, emptyComment]);
+  return { ...state, loadMore };
 }
 function averageRating(reviews) {
   if (reviews.length === 0) return null;
@@ -2663,18 +2821,69 @@ async function buildShopPageModel(page) {
   };
 }
 async function loadShopPage(slug) {
+  let result;
+  try {
+    result = await getShoppex().getPage(slug);
+  } catch {
+    return { status: "error" };
+  }
+  if (!result.success) return result.status === 404 ? { status: "missing" } : { status: "error" };
+  const page = result.data;
+  if (!page || typeof page.name !== "string" || !page.name.trim()) return { status: "missing" };
   try {
-    const result = await getShoppex().getPage(slug);
-    const page = result.success ? result.data : void 0;
-    if (!page || typeof page.name !== "string" || !page.name.trim()) {
-      return { status: "missing" };
-    }
     return { status: "ready", page: await buildShopPageModel(page) };
   } catch {
-    return { status: "missing" };
+    return { status: "error" };
   }
 }
 
+// src/stock-alerts.ts
+function canRequestStockAlert(settings, product, soldOut) {
+  return settings.stockAlertsEnabled && soldOut && !product.onHold && product.productType !== "INFO_CARD";
+}
+function bootstrapGlobal(name) {
+  const value = window[name];
+  if (typeof value !== "string" || !value.trim()) {
+    throw new Error(
+      `Shoppex bootstrap global "${name}" is missing. This storefront must be served by the Shoppex storefront (or preview) worker.`
+    );
+  }
+  return value.trim().replace(/\/+$/, "");
+}
+function pageLocale() {
+  const lang = typeof document === "undefined" ? "" : document.documentElement.lang.trim();
+  return lang || null;
+}
+var GENERIC_FAILURE = "We could not save your request. Please try again.";
+async function requestStockAlert(request) {
+  const email = request.email.trim();
+  if (!email) return { ok: false, status: null, message: "Enter your email address." };
+  let response;
+  try {
+    const shopSlug = bootstrapGlobal("shopSlug");
+    const apiBaseUrl = bootstrapGlobal("apiBaseUrl");
+    response = await fetch(
+      `${apiBaseUrl}/v1/storefront/shops/name/${encodeURIComponent(shopSlug)}/products/${encodeURIComponent(request.productId)}/stock-alerts`,
+      {
+        method: "POST",
+        headers: { "Content-Type": "application/json", Accept: "application/json" },
+        body: JSON.stringify({
+          email,
+          variant_id: request.variantId,
+          locale: pageLocale(),
+          ...request.honeypot ? { website: request.honeypot } : {}
+        })
+      }
+    );
+  } catch {
+    return { ok: false, status: null, message: GENERIC_FAILURE };
+  }
+  if (response.status === 202) return { ok: true };
+  const payload = await response.json().catch(() => null);
+  const serverMessage = typeof payload?.error === "string" && payload.error.trim() ? payload.error.trim() : typeof payload?.message === "string" && payload.message.trim() ? payload.message.trim() : null;
+  return { ok: false, status: response.status, message: serverMessage ?? GENERIC_FAILURE };
+}
+
 // src/storefront-context.tsx
 import { createContext as createContext2, useContext as useContext2, useEffect as useEffect4, useState as useState4 } from "react";
 import { jsx as jsx2 } from "react/jsx-runtime";
@@ -2721,10 +2930,13 @@ export {
   DEFAULT_ACCOUNT_TAB,
   DEFAULT_LOW_STOCK_THRESHOLD,
   DELIVERY_TIME_UNITS,
+  FAVORITES_CHANGED_EVENT,
+  FavoritesProvider,
   IMPLEMENTED_ACCOUNT_TABS,
   MAX_PAY_WHAT_YOU_WANT_PRICE,
   PRODUCT_BADGE_ICON_NAMES,
   QUOTE_UNAVAILABLE_CHECKOUT_ERROR,
+  SERVICE_STATES,
   SERVING_CONTEXT_HINT,
   SHOP_REVIEW_PAGE_SIZE,
   STOREFRONT_SORT_KEYS,
@@ -2741,15 +2953,18 @@ export {
   buildCustomFieldPayload,
   buildInitialCheckoutFieldValues,
   buildProductDetail,
+  buildStatusPageModel,
   buildStorefrontCatalog,
   calculateDisplayLineTotal,
   calculateLinePricing,
+  canRequestStockAlert,
   canonicalAccountPath,
   checkoutFieldKey,
   checkoutFieldWriteRepriced,
   checkoutNeedsDetails,
   clampQuantity,
   clearRecoveredQuoteCheckoutError,
+  createFavoritesStore,
   filterCatalogCards,
   findStorefrontProduct,
   firstOptionalString,
@@ -2781,7 +2996,9 @@ export {
   isSelectionSoldOut,
   loadLatestWrittenReviews,
   loadShopPage,
+  loadShopReviewsPage,
   missingRequiredCheckoutValues,
+  notifyFavoritesChanged,
   optionalBoolean,
   optionalString,
   optionalStringWithDefault,
@@ -2791,9 +3008,11 @@ export {
   parseEnum,
   parseFiniteNumber,
   parseProductBadges,
+  parseServiceStatus,
   parseStorefrontSortKey,
   readCheckoutNeedsDetails,
   readStorefrontData,
+  requestStockAlert,
   requireArray,
   requireBoolean,
   requireNumber,
@@ -2817,9 +3036,11 @@ export {
   resolveSupportChannels,
   resolveUnsellableLineIds,
   resolveVariantStock,
+  resolveYouReceive,
   reviewsForProduct,
   roundCurrency,
   sanitizeMerchantHtml,
+  sdkFavoritesTransport,
   sortCatalogCards,
   startCartMutation,
   stripMerchantHtmlImages,
@@ -2827,8 +3048,10 @@ export {
   toShopReviews,
   toStarCount,
   useCart,
+  useFavorites,
   useNavigationLinks,
   useOnlineUserCount,
+  usePagedShopReviews,
   useShopReviews,
   useStorefront,
   validateCheckoutFieldValue,