@shoppexio/storefront 1.0.85 → 1.0.88

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.0.88
+
+- Cart pings carry `cart_seq` and `cart_seq_scope`, a sequence number taken when the cart state is reported and shared by all tabs of the shop (the current time in ms, or one above the highest sequence any tab handed out). The counter record holds the scope (created on first use) and is updated under a Web Lock (`navigator.locks`), so two tabs never hand out the same sequence or create two scopes; where Web Locks are unavailable it is updated without the lock. The server keeps the cart with the highest sequence of the scope and ignores an older one that arrives later, so a slow ping from one tab can no longer overwrite a newer cart another tab already reported.
+- The confirmed cart state records its sequence and is only replaced by a delivered state with a higher one, the same rule the server applies. A cart state counts as already reported when it is the state the server will hold: a newer state another tab is sending, else the confirmed state. So reverting to the confirmed cart while another tab sends a newer one still goes out.
+- Each tab still sends its cart states one at a time and drops a waiting state once a newer one is asked for; this now only saves pings, the order comes from the sequence.
+- Page views and heartbeats without a cart are unchanged and carry no sequence.
+
+## 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.

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

@@ -25924,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", {
@@ -25938,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
       }
@@ -25953,10 +25957,7 @@ async function getShopReviewsPage(cursor) {
       }
     };
   }
-  return {
-    success: false,
-    message: response.message
-  };
+  return forwardFailure(response);
 }
 async function getShopReviews() {
   const allFeedback = [];
@@ -26426,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();
@@ -26452,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
@@ -26639,6 +26634,7 @@ function isPlatformPageTrackerActive() {
 // ../sdk/src/modules/analytics.ts
 var CONFIRMED_CART_STORAGE_PREFIX = "reported_cart_";
 var IN_FLIGHT_CART_STORAGE_PREFIX = "reporting_cart_";
+var CART_SEQUENCE_STORAGE_PREFIX = "presence_cart_seq_";
 var CART_CLAIM_TTL_MS = 1e4;
 function confirmedCartKey(storeSlug) {
   return `${CONFIRMED_CART_STORAGE_PREFIX}${storeSlug}`;
@@ -26646,33 +26642,77 @@ function confirmedCartKey(storeSlug) {
 function inFlightCartKey(storeSlug) {
   return `${IN_FLIGHT_CART_STORAGE_PREFIX}${storeSlug}`;
 }
+function cartSequenceKey(storeSlug) {
+  return `${CART_SEQUENCE_STORAGE_PREFIX}${storeSlug}`;
+}
 function cartSnapshot(cartValue, itemCount) {
   return `${cartValue ?? ""}|${itemCount ?? ""}`;
 }
+function isCartSequence(value) {
+  return typeof value === "number" && Number.isSafeInteger(value) && value > 0;
+}
+var CART_SEQUENCE_SCOPE_MAX_LENGTH = 64;
+function readCartCounter(storeSlug) {
+  const counter = getItem(cartSequenceKey(storeSlug));
+  if (!counter || typeof counter.scope !== "string" || counter.scope.length === 0 || counter.scope.length > CART_SEQUENCE_SCOPE_MAX_LENGTH || !isCartSequence(counter.seq)) {
+    return null;
+  }
+  return counter;
+}
+var lastCartOrder = null;
+function nextCartOrder(storeSlug) {
+  const stored = readCartCounter(storeSlug);
+  const scope = stored?.scope ?? lastCartOrder?.scope ?? createClaimToken();
+  const floor = Math.max(stored?.seq ?? 0, lastCartOrder?.scope === scope ? lastCartOrder.seq : 0);
+  const order2 = { scope, seq: Math.max(Date.now(), floor + 1) };
+  lastCartOrder = order2;
+  setItem(cartSequenceKey(storeSlug), order2);
+  return order2;
+}
+function cartSequenceLocks() {
+  if (typeof navigator === "undefined") return null;
+  const locks = navigator.locks;
+  return locks && typeof locks.request === "function" ? locks : null;
+}
+function reserveCartOrder(storeSlug) {
+  const take = () => nextCartOrder(storeSlug);
+  const locks = cartSequenceLocks();
+  if (!locks) return Promise.resolve(take());
+  return locks.request(cartSequenceKey(storeSlug), take).catch(take);
+}
+function readConfirmedCart(storeSlug) {
+  const confirmed = getItem(confirmedCartKey(storeSlug));
+  if (!confirmed || typeof confirmed.snapshot !== "string" || !isCartSequence(confirmed.seq)) return null;
+  return confirmed;
+}
 function readInFlightCart(storeSlug) {
   const claim2 = getItem(inFlightCartKey(storeSlug));
-  if (!claim2 || typeof claim2.snapshot !== "string" || typeof claim2.token !== "string" || typeof claim2.at !== "number") {
+  if (!claim2 || typeof claim2.snapshot !== "string" || !isCartSequence(claim2.seq) || typeof claim2.token !== "string" || typeof claim2.at !== "number") {
     return null;
   }
   return claim2;
 }
 function isCartReportedOrInFlight(storeSlug, snapshot) {
-  if (getItem(confirmedCartKey(storeSlug)) === snapshot) return true;
+  const confirmed = readConfirmedCart(storeSlug);
   const claim2 = readInFlightCart(storeSlug);
-  return claim2 !== null && claim2.snapshot === snapshot && Date.now() - claim2.at < CART_CLAIM_TTL_MS;
+  const liveClaim = claim2 && Date.now() - claim2.at < CART_CLAIM_TTL_MS ? claim2 : null;
+  const expected = liveClaim && (!confirmed || liveClaim.seq > confirmed.seq) ? liveClaim : confirmed;
+  return expected?.snapshot === snapshot;
 }
 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) {
+function claimCartReport(storeSlug, seq, cartValue, itemCount) {
   const snapshot = cartSnapshot(cartValue, itemCount);
   const token = createClaimToken();
-  setItem(inFlightCartKey(storeSlug), { snapshot, token, at: Date.now() });
+  setItem(inFlightCartKey(storeSlug), { snapshot, seq, token, at: Date.now() });
   return (delivered) => {
-    if (readInFlightCart(storeSlug)?.token !== token) return;
-    if (delivered) setItem(confirmedCartKey(storeSlug), snapshot);
-    removeItem(inFlightCartKey(storeSlug));
+    if (delivered) {
+      const confirmed = readConfirmedCart(storeSlug);
+      if (!confirmed || seq > confirmed.seq) setItem(confirmedCartKey(storeSlug), { snapshot, seq });
+    }
+    if (readInFlightCart(storeSlug)?.token === token) removeItem(inFlightCartKey(storeSlug));
   };
 }
 var cartSendTail = Promise.resolve();
@@ -26713,42 +26753,50 @@ async function postPing(body) {
 async function trackPageView(cartValue, itemCount) {
   if (!isInitialized()) return;
   if (typeof document === "undefined") return;
+  const config2 = getConfig();
   const carriesCart = cartValue !== void 0 || itemCount !== void 0;
+  const reservedOrder = carriesCart ? reserveCartOrder(config2.storeSlug) : void 0;
   if (isPlatformPageTrackerActive()) {
-    if (carriesCart) await enqueueCartSend(() => sendCartActivity(cartValue, itemCount));
+    if (reservedOrder) await enqueueCartSend(async () => sendCartActivity(await reservedOrder, cartValue, itemCount));
     return;
   }
-  const config2 = getConfig();
   const sendView = async () => {
-    const settle2 = carriesCart ? claimCartReport(config2.storeSlug, cartValue, itemCount) : void 0;
+    const order2 = reservedOrder ? await reservedOrder : void 0;
+    const settle2 = order2 ? claimCartReport(config2.storeSlug, order2.seq, cartValue, itemCount) : void 0;
     const delivered = await postPing({
       referer: document.referrer || void 0,
       cart_value: cartValue,
       item_count: itemCount,
+      cart_seq: order2?.seq,
+      cart_seq_scope: order2?.scope,
       connection_id: getStorefrontConnectionId(config2.storeSlug) ?? void 0,
       path: resolveStorefrontPagePath(),
       utm: resolveUtmParameters(config2.storeSlug)
     });
     settle2?.(delivered);
   };
-  await (carriesCart ? enqueueCartSend(sendView) : sendView());
+  await (reservedOrder ? enqueueCartSend(sendView) : sendView());
 }
 async function trackCartActivity(cartValue, itemCount) {
   if (!isInitialized()) return;
   if (typeof document === "undefined") return;
   const snapshot = cartSnapshot(cartValue, itemCount);
+  const reservedOrder = reserveCartOrder(getConfig().storeSlug);
   await enqueueCartSend(async (isLatest) => {
+    const order2 = await reservedOrder;
     if (!isLatest() || isCartReportedOrInFlight(getConfig().storeSlug, snapshot)) return;
-    await sendCartActivity(cartValue, itemCount);
+    await sendCartActivity(order2, cartValue, itemCount);
   });
 }
-async function sendCartActivity(cartValue, itemCount) {
+async function sendCartActivity(order2, cartValue, itemCount) {
   const config2 = getConfig();
-  const settle2 = claimCartReport(config2.storeSlug, cartValue, itemCount);
+  const settle2 = claimCartReport(config2.storeSlug, order2.seq, cartValue, itemCount);
   const delivered = await postPing({
     event_type: "presence",
     cart_value: cartValue,
     item_count: itemCount,
+    cart_seq: order2.seq,
+    cart_seq_scope: order2.scope,
     connection_id: getStorefrontConnectionId(config2.storeSlug) ?? void 0,
     path: resolveStorefrontPagePath()
   });