@shoppexio/storefront 1.0.84 → 1.0.87

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 1.0.87
+
+- `getPage()`, `getPages()` and `getShopReviewsPage()` keep the transport `status` (and `code`) on a failure, like the other modules, so a storefront can tell a page that does not exist (404) from an API it could not reach.
+- `getShopReviewsPage(cursor, { product })` narrows a page to one product by its public id (the catalog `id`). The page's `summary` then counts that product's reviews only, so a product's review list can page on demand with a correct breakdown.
+
+## 1.0.85
+
+- Cart reporting keeps two shared values: the cart state the server confirmed (written only after a 2xx response) and a short-lived in-flight claim that lets another tab skip the `storage` echo while a send runs. Only the newest claim settles: a send whose claim was replaced confirms and clears nothing, and a failed send (network error, non-OK response, or no answer within 10 seconds) writes nothing, so an unsent cart can never look reported. A tab sends its cart states one at a time and in order, dropping a waiting state once a newer one is asked for, so an older cart cannot reach the server after a newer one. Whether a change is already reported is decided when its turn comes, so reverting to the confirmed cart while another state is being sent still goes out.
+- On code storefronts, `trackPageView(cartValue, itemCount)` passes a partial cart through unchanged instead of filling the missing field with 0.
+- Storefront client-error reports cut `endpoint`/`message` to 500 and `page_url`/`request_url` to 2000 characters, the bounds the ping endpoint enforces, so a long page URL no longer gets the report rejected.
+
 ## 1.0.84
 
 - `touchStorefrontPresence()` sends `event_type: "presence"`. The server refreshes the live session but no longer counts the ping as a shop view, so an idle tab with `sx-online-users` (or any theme that touches presence on a timer) stops adding a view every few minutes.

package/README.md

@@ -151,6 +151,8 @@ await refreshLiveUsers();
 setInterval(refreshLiveUsers, 30_000);
 ```
 
+`getShopReviewsPage(cursor, { product })` pages the shop's reviews on demand; pass a product's `id` to page only its reviews, with a `summary` for that product.
+
 `touchStorefrontPresence()` keeps the visitor online but never counts as a page view, so it is safe on a timer. Report page views with `trackPageView()` (once per page load or navigation) and later cart changes with `trackCartActivity(cartValue, itemCount)`, which updates the live visitor map without counting a view.
 
 ## Not this package

package/dist/index.cjs

@@ -23870,6 +23870,8 @@ function removeItem(key) {
 // ../sdk/src/core/telemetry.ts
 var CONNECTION_ID_STORAGE_PREFIX = "presence_connection_";
 var CLIENT_ERROR_DEDUPE_WINDOW_MS = 15e3;
+var CLIENT_ERROR_TEXT_MAX_LENGTH = 500;
+var CLIENT_ERROR_URL_MAX_LENGTH = 2e3;
 function createPresenceConnectionId() {
   if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") {
     return crypto.randomUUID();
@@ -23920,14 +23922,14 @@ async function reportStorefrontClientError(payload) {
     client_error: {
       source: payload.source ?? "sdk",
       phase: payload.phase ?? "request",
-      endpoint: payload.endpoint,
+      endpoint: payload.endpoint.slice(0, CLIENT_ERROR_TEXT_MAX_LENGTH),
       method: payload.method,
-      message: payload.message,
+      message: payload.message.slice(0, CLIENT_ERROR_TEXT_MAX_LENGTH),
       status_code: payload.statusCode,
       attempt_count: payload.attemptCount,
       response_received: payload.responseReceived ?? false,
-      page_url: payload.pageUrl ?? window.location.href,
-      request_url: payload.requestUrl,
+      page_url: (payload.pageUrl ?? window.location.href).slice(0, CLIENT_ERROR_URL_MAX_LENGTH),
+      request_url: payload.requestUrl?.slice(0, CLIENT_ERROR_URL_MAX_LENGTH),
       online: payload.online ?? (typeof navigator !== "undefined" ? navigator.onLine : void 0),
       visibility_state: payload.visibilityState ?? (typeof document !== "undefined" ? document.visibilityState : void 0)
     }
@@ -25922,13 +25924,17 @@ function normalizeFeedback(raw, index) {
     created_at
   };
 }
-async function getShopReviewsPage(cursor) {
+async function getShopReviewsPage(cursor, options = {}) {
   const config2 = getConfig();
   const query = new URLSearchParams();
   query.set("limit", String(REVIEWS_PAGE_LIMIT));
   if (typeof cursor === "string" && cursor.trim().length > 0) {
     query.set("cursor", cursor);
   }
+  const product = typeof options.product === "string" ? options.product.trim() : "";
+  if (product) {
+    query.set("product", product);
+  }
   const querySuffix = `?${query.toString()}`;
   const response = await get(
     `${buildEndpoint("/v1/storefront/feedback/shop/:storeSlug", {
@@ -25936,7 +25942,7 @@ async function getShopReviewsPage(cursor) {
     })}${querySuffix}`,
     {
       cache: {
-        key: `reviews:${config2.storeSlug}:${cursor ?? "start"}:${REVIEWS_PAGE_LIMIT}`,
+        key: `reviews:${config2.storeSlug}:${product || "all"}:${cursor ?? "start"}:${REVIEWS_PAGE_LIMIT}`,
         ttl: REVIEWS_CACHE_TTL,
         staleWhileRevalidate: true
       }
@@ -25951,10 +25957,7 @@ async function getShopReviewsPage(cursor) {
       }
     };
   }
-  return {
-    success: false,
-    message: response.message
-  };
+  return forwardFailure(response);
 }
 async function getShopReviews() {
   const allFeedback = [];
@@ -26424,10 +26427,7 @@ async function getPages() {
       data: response.data.pages
     };
   }
-  return {
-    success: false,
-    message: response.message
-  };
+  return forwardFailure(response);
 }
 async function getPage(slug) {
   const config2 = getConfig();
@@ -26450,10 +26450,7 @@ async function getPage(slug) {
       data: response.data.page
     };
   }
-  return {
-    success: false,
-    message: response.message
-  };
+  return forwardFailure(response);
 }
 
 // ../sdk/src/modules/navigation.ts
@@ -26635,72 +26632,122 @@ function isPlatformPageTrackerActive() {
 }
 
 // ../sdk/src/modules/analytics.ts
-var REPORTED_CART_STORAGE_PREFIX = "reported_cart_";
-function reportedCartKey(storeSlug) {
-  return `${REPORTED_CART_STORAGE_PREFIX}${storeSlug}`;
+var CONFIRMED_CART_STORAGE_PREFIX = "reported_cart_";
+var IN_FLIGHT_CART_STORAGE_PREFIX = "reporting_cart_";
+var CART_CLAIM_TTL_MS = 1e4;
+function confirmedCartKey(storeSlug) {
+  return `${CONFIRMED_CART_STORAGE_PREFIX}${storeSlug}`;
+}
+function inFlightCartKey(storeSlug) {
+  return `${IN_FLIGHT_CART_STORAGE_PREFIX}${storeSlug}`;
 }
 function cartSnapshot(cartValue, itemCount) {
   return `${cartValue ?? ""}|${itemCount ?? ""}`;
 }
-function rememberReportedCart(storeSlug, cartValue, itemCount) {
-  setItem(reportedCartKey(storeSlug), cartSnapshot(cartValue, itemCount));
-}
-async function trackPageView(cartValue, itemCount) {
-  if (!isInitialized()) return;
-  if (typeof document === "undefined") return;
-  const carriesCart = cartValue !== void 0 || itemCount !== void 0;
-  if (isPlatformPageTrackerActive()) {
-    if (carriesCart) await sendCartActivity(cartValue ?? 0, itemCount ?? 0);
-    return;
+function readInFlightCart(storeSlug) {
+  const claim2 = getItem(inFlightCartKey(storeSlug));
+  if (!claim2 || typeof claim2.snapshot !== "string" || typeof claim2.token !== "string" || typeof claim2.at !== "number") {
+    return null;
   }
+  return claim2;
+}
+function isCartReportedOrInFlight(storeSlug, snapshot) {
+  if (getItem(confirmedCartKey(storeSlug)) === snapshot) return true;
+  const claim2 = readInFlightCart(storeSlug);
+  return claim2 !== null && claim2.snapshot === snapshot && Date.now() - claim2.at < CART_CLAIM_TTL_MS;
+}
+function createClaimToken() {
+  if (typeof crypto !== "undefined" && typeof crypto.randomUUID === "function") return crypto.randomUUID();
+  return `${Date.now().toString(36)}${Math.random().toString(36).slice(2)}`;
+}
+function claimCartReport(storeSlug, cartValue, itemCount) {
+  const snapshot = cartSnapshot(cartValue, itemCount);
+  const token = createClaimToken();
+  setItem(inFlightCartKey(storeSlug), { snapshot, token, at: Date.now() });
+  return (delivered) => {
+    if (readInFlightCart(storeSlug)?.token !== token) return;
+    if (delivered) setItem(confirmedCartKey(storeSlug), snapshot);
+    removeItem(inFlightCartKey(storeSlug));
+  };
+}
+var cartSendTail = Promise.resolve();
+var latestCartRequest = 0;
+function enqueueCartSend(send) {
+  const request2 = ++latestCartRequest;
+  const run = () => send(() => request2 === latestCartRequest);
+  cartSendTail = cartSendTail.then(run, run);
+  return cartSendTail;
+}
+async function postPing(body) {
   const config2 = getConfig();
-  const connectionId = getStorefrontConnectionId(config2.storeSlug);
-  if (carriesCart) rememberReportedCart(config2.storeSlug, cartValue, itemCount);
+  const controller = typeof AbortController === "undefined" ? void 0 : new AbortController();
+  let timer;
+  const timedOut = new Promise((resolve) => {
+    timer = setTimeout(() => {
+      controller?.abort();
+      resolve(false);
+    }, CART_CLAIM_TTL_MS);
+  });
   try {
     const endpoint = buildEndpoint("/v1/storefront/shops/:storeSlug/ping", {
       storeSlug: config2.storeSlug
     });
-    await fetch(`${config2.apiBaseUrl}${endpoint}`, {
+    const delivered = fetch(`${config2.apiBaseUrl}${endpoint}`, {
       method: "POST",
       headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({
-        referer: document.referrer || void 0,
-        cart_value: cartValue ?? void 0,
-        item_count: itemCount ?? void 0,
-        connection_id: connectionId ?? void 0,
-        path: resolveStorefrontPagePath(),
-        utm: resolveUtmParameters(config2.storeSlug)
-      })
-    });
+      body: JSON.stringify(body),
+      signal: controller?.signal
+    }).then((response) => response.ok);
+    return await Promise.race([delivered, timedOut]);
   } catch {
+    return false;
+  } finally {
+    clearTimeout(timer);
   }
 }
+async function trackPageView(cartValue, itemCount) {
+  if (!isInitialized()) return;
+  if (typeof document === "undefined") return;
+  const carriesCart = cartValue !== void 0 || itemCount !== void 0;
+  if (isPlatformPageTrackerActive()) {
+    if (carriesCart) await enqueueCartSend(() => sendCartActivity(cartValue, itemCount));
+    return;
+  }
+  const config2 = getConfig();
+  const sendView = async () => {
+    const settle2 = carriesCart ? claimCartReport(config2.storeSlug, cartValue, itemCount) : void 0;
+    const delivered = await postPing({
+      referer: document.referrer || void 0,
+      cart_value: cartValue,
+      item_count: itemCount,
+      connection_id: getStorefrontConnectionId(config2.storeSlug) ?? void 0,
+      path: resolveStorefrontPagePath(),
+      utm: resolveUtmParameters(config2.storeSlug)
+    });
+    settle2?.(delivered);
+  };
+  await (carriesCart ? enqueueCartSend(sendView) : sendView());
+}
 async function trackCartActivity(cartValue, itemCount) {
   if (!isInitialized()) return;
   if (typeof document === "undefined") return;
-  if (getItem(reportedCartKey(getConfig().storeSlug)) === cartSnapshot(cartValue, itemCount)) return;
-  await sendCartActivity(cartValue, itemCount);
+  const snapshot = cartSnapshot(cartValue, itemCount);
+  await enqueueCartSend(async (isLatest) => {
+    if (!isLatest() || isCartReportedOrInFlight(getConfig().storeSlug, snapshot)) return;
+    await sendCartActivity(cartValue, itemCount);
+  });
 }
 async function sendCartActivity(cartValue, itemCount) {
   const config2 = getConfig();
-  rememberReportedCart(config2.storeSlug, cartValue, itemCount);
-  try {
-    const endpoint = buildEndpoint("/v1/storefront/shops/:storeSlug/ping", {
-      storeSlug: config2.storeSlug
-    });
-    await fetch(`${config2.apiBaseUrl}${endpoint}`, {
-      method: "POST",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify({
-        event_type: "presence",
-        cart_value: cartValue,
-        item_count: itemCount,
-        connection_id: getStorefrontConnectionId(config2.storeSlug) ?? void 0,
-        path: resolveStorefrontPagePath()
-      })
-    });
-  } catch {
-  }
+  const settle2 = claimCartReport(config2.storeSlug, cartValue, itemCount);
+  const delivered = await postPing({
+    event_type: "presence",
+    cart_value: cartValue,
+    item_count: itemCount,
+    connection_id: getStorefrontConnectionId(config2.storeSlug) ?? void 0,
+    path: resolveStorefrontPagePath()
+  });
+  settle2(delivered);
 }
 
 // ../sdk/src/modules/presence.ts