@shoppexio/storefront-react 0.1.1 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.1.3
+
+- Cart: every add carries the add-ons the merchant marked required
+  (`withRequiredAddons`), including adds from cards, bundle dialogs and
+  bundle offers, so the quote and the invoice include the mandatory
+  surcharge.
+
+## 0.1.2
+
+- Contact form: a message that is longer than the 2,000-character ticket
+  limit once the name line is added is refused with an error naming the
+  limit, instead of being cut off and reported as sent.
+- Contact form: a subject over 30 characters is refused, not cut.
+- `loadLatestWrittenReviews(limit, labels)`: the newest written reviews for a
+  sample, paging the feed only until it has enough. `getShopReviewsPage` is
+  typed on the SDK global.
+
 ## 0.1.1
 
 - README rewritten for theme developers: install, quick start, theming,

package/dist/index.d.ts

@@ -892,6 +892,20 @@ interface ShoppexSdk {
         success: boolean;
         data?: SdkShopReview[];
     }>;
+    /**
+     * One page of the same feed, newest first. `cursor` is the previous page's
+     * `pagination.next_cursor`; omit it for the first page.
+     */
+    getShopReviewsPage(cursor?: string | null): Promise<{
+        success: boolean;
+        data?: {
+            feedback: SdkShopReview[];
+            pagination: {
+                next_cursor: string | null;
+                has_more: boolean;
+            };
+        };
+    }>;
     /** Starts an in-page sign-in. Sends the email and nothing else. */
     requestOtp(email: string): Promise<SdkResponse<unknown>>;
     /**
@@ -2264,6 +2278,15 @@ declare function useCart(): CartContextValue;
  * the call site rather than leaving the rejection unhandled — the error is
  * displayed, not swallowed.
  */
+/**
+ * The add-ons a cart line carries: the caller's choice plus every add-on the
+ * merchant marked required, once each.
+ *
+ * PAYMENT PATH. The buy box preselects and locks required add-ons, but a card,
+ * a bundle dialog or a related tile adds without choosing any. Without this the
+ * line, its quote and the invoice omit a surcharge the merchant made mandatory.
+ */
+declare function withRequiredAddons(product: StorefrontProduct, chosen: readonly ProductAddon[]): ProductAddon[];
 declare function startCartMutation(mutation: Promise<void>): void;
 
 /**
@@ -2894,6 +2917,14 @@ declare function toShopReviews(rows: readonly SdkShopReview[], labels: ShopRevie
  * derive a number from them.
  */
 declare function reviewsForProduct(reviews: readonly ShopReview[], productTitle: string): ShopReview[];
+/**
+ * The newest WRITTEN reviews, at most `limit`, for a sample such as a home
+ * section. Pages through the feed only until it has enough: a shop with a
+ * thousand reviews costs one request, not ten. Automated entries and ratings
+ * without words are skipped, since a sample of quotes needs quotes.
+ * Resolves null when a page request fails.
+ */
+declare function loadLatestWrittenReviews(limit: number, labels: ShopReviewLabels): Promise<ShopReview[] | null>;
 declare function averageRating(reviews: readonly ShopReview[]): number | null;
 declare function useShopReviews(labels: ShopReviewLabels): ShopReviewsState;
 
@@ -3084,4 +3115,4 @@ declare function useOnlineUserCount(): number | null;
  */
 declare function resolveProductVideoEmbedSrc(value: unknown): string | null;
 
-export { ACCOUNT_ARTIFACT_CAPABILITIES, ACCOUNT_PATH, ACCOUNT_PATH_ALIAS, ACCOUNT_ROUTE_MESSAGE_KEYS, ACCOUNT_STOREFRONT_ROUTES, ACCOUNT_TABS, type AccountRouteMessageKey, type AccountRouteParts, type AccountTab, type AccountView, type BuyBoxVariantModel, CATALOG_PAGE_SIZE, CATALOG_SORTS, CATALOG_SORT_LABELS, type CartBoundsHeal, CartProvider, type CartQuoteLineBounds, type CartTotals, type CartView, type CartViewLine, type CatalogCardModel, type CatalogPage, type CatalogSort, type CheckoutFieldGroup, type CheckoutFieldValues, type CheckoutFields, type ContactFormValues, type ContactSubmissionContext, DEFAULT_ACCOUNT_TAB, DEFAULT_LOW_STOCK_THRESHOLD, DELIVERY_TIME_UNITS, type DeliveryPromise, type DeliveryTimeUnit, type GroupCardModel, IMPLEMENTED_ACCOUNT_TABS, type ImplementedAccountTab, type LicenseStatement, type LicenseTerm, type LinePricing, MAX_PAY_WHAT_YOU_WANT_PRICE, type MenuNavLink, type MenuSlot, type NavLink, type NavigationLinks, PRODUCT_BADGE_ICON_NAMES, type ProductAddon, type ProductAutomaticDeal, type ProductBadge, type ProductBadgeIconName, type ProductBundle, type ProductBundleItem, type ProductCardModel, type ProductCategoryRef, type ProductContentTab, type ProductCustomField, type ProductDetailModel, type ProductFaq, type ProductRatingModel, type ProductSubscription, type ProductType, QUOTE_UNAVAILABLE_CHECKOUT_ERROR, type RatingStars, type ResellerProgramSummary, type RewardProgramItem, type RewardProgramSummary, SERVING_CONTEXT_HINT, SHOP_REVIEW_PAGE_SIZE, STOREFRONT_SORT_KEYS, type SdkCartAddOptions, type SdkCartAddon, type SdkCartAppliedDiscount, type SdkCartCodeSource, type SdkCartItem, type SdkCartQuote, type SdkCartQuoteLine, type SdkCheckoutResult, type SdkCustomerAffiliateLink, type SdkCustomerAffiliateSummary, type SdkCustomerDashboard, type SdkCustomerDashboardOrder, type SdkCustomerDeliverable, type SdkCustomerDeliveryStatus, type SdkCustomerDeliverySummary, type SdkCustomerLicense, type SdkCustomerLoyalty, type SdkCustomerLoyaltyRedeem, type SdkCustomerLoyaltyTransactionType, type SdkCustomerOrderDetail, type SdkCustomerOrderPage, type SdkCustomerOrderSummary, type SdkCustomerRewardActivity, type SdkCustomerRewards, type SdkCustomerSubscription, type SdkCustomerTicketSummary, type SdkCustomerWarranty, type SdkCustomerWarrantyClaim, type SdkCustomerWarrantyClaimStatus, type SdkCustomerWarrantyList, type SdkCustomerWarrantyStatus, type SdkEligibleCartDeal, type SdkInitOptions, type SdkMenu, type SdkMenuItem, type SdkPage, type SdkRecentSaleEntry, type SdkResponse, type SdkShopReview, type ShopPageFaqItem, type ShopPageModel, type ShopPageState, type ShopReview, type ShopReviewLabels, type ShopReviewsState, type ShoppexSdk, type SocialLink, type SocialNetwork, type StockChip, type StockTone, type StorefrontAddon, type StorefrontCatalog, type StorefrontCategory, type StorefrontData, type StorefrontGroup, type StorefrontListingItem, type StorefrontPriceVariant, type StorefrontProduct, StorefrontProvider, type StorefrontSettings, type StorefrontShop, type StorefrontShopStats, type StorefrontSortKey, type SubscriptionIntervalUnit, type SupportChannel, type VolumeDiscountRule, accountOrderHref, accountRouteMessage, accountTabHref, accountTabLabelKey, averageRating, badgesForCard, badgesForProductPage, buildCartTotals, buildCartView, buildCustomFieldPayload, buildInitialCheckoutFieldValues, buildProductDetail, buildStorefrontCatalog, calculateDisplayLineTotal, calculateLinePricing, canonicalAccountPath, checkoutFieldKey, checkoutFieldWriteRepriced, checkoutNeedsDetails, clampQuantity, clearRecoveredQuoteCheckoutError, filterCatalogCards, findStorefrontProduct, firstOptionalString, flattenMerchantHtmlToText, formatCompactCount, formatDeliveryTime, formatLicenseTerm, formatMoney, formatSubscriptionCadence, formatSubscriptionTrial, getAuthoredContent, getBuyerCurrency, getProductGroups, getProducts, getShoppex, getStorefrontAddons, getStorefrontCategories, getStorefrontListing, getStorefrontSettings, getStorefrontShop, hasInjectedStorefrontData, isAccountTab, isBlankMerchantHtml, isCheckboxValueChecked, isImplementedAccountTab, isProductSoldOut, isRecord, isSelectionSoldOut, loadShopPage, missingRequiredCheckoutValues, optionalBoolean, optionalString, optionalStringWithDefault, paginateCatalogCards, parseAccountPath, parseCartQuoteLines, parseEnum, parseFiniteNumber, parseProductBadges, parseStorefrontSortKey, readCheckoutNeedsDetails, readStorefrontData, requireArray, requireBoolean, requireNumber, requireRecord, requireString, requireStringFromKeys, requireUnknownRecord, resolveAccountView, resolveBadgeForeground, resolveCartBoundsHeals, resolveCategorySelection, resolveCheckoutFields, resolveDeliveryPromise, resolveDisplayStock, resolveHideStockCounter, resolveLicenseTerm, resolveMenuLinksForSlot, resolvePayWhatYouWantMinimum, resolveProductVideoEmbedSrc, resolveQuantityBounds, resolveSupportChannels, resolveUnsellableLineIds, resolveVariantStock, reviewsForProduct, roundCurrency, sanitizeMerchantHtml, sortCatalogCards, startCartMutation, stripMerchantHtmlImages, submitContactTicket, toShopReviews, toStarCount, useCart, useNavigationLinks, useOnlineUserCount, useShopReviews, useStorefront, validateCheckoutFieldValue, validateCheckoutFields, validateContactSubmission };
+export { ACCOUNT_ARTIFACT_CAPABILITIES, ACCOUNT_PATH, ACCOUNT_PATH_ALIAS, ACCOUNT_ROUTE_MESSAGE_KEYS, ACCOUNT_STOREFRONT_ROUTES, ACCOUNT_TABS, type AccountRouteMessageKey, type AccountRouteParts, type AccountTab, type AccountView, type BuyBoxVariantModel, CATALOG_PAGE_SIZE, CATALOG_SORTS, CATALOG_SORT_LABELS, type CartBoundsHeal, CartProvider, type CartQuoteLineBounds, type CartTotals, type CartView, type CartViewLine, type CatalogCardModel, type CatalogPage, type CatalogSort, type CheckoutFieldGroup, type CheckoutFieldValues, type CheckoutFields, type ContactFormValues, type ContactSubmissionContext, DEFAULT_ACCOUNT_TAB, DEFAULT_LOW_STOCK_THRESHOLD, DELIVERY_TIME_UNITS, type DeliveryPromise, type DeliveryTimeUnit, type GroupCardModel, IMPLEMENTED_ACCOUNT_TABS, type ImplementedAccountTab, type LicenseStatement, type LicenseTerm, type LinePricing, MAX_PAY_WHAT_YOU_WANT_PRICE, type MenuNavLink, type MenuSlot, type NavLink, type NavigationLinks, PRODUCT_BADGE_ICON_NAMES, type ProductAddon, type ProductAutomaticDeal, type ProductBadge, type ProductBadgeIconName, type ProductBundle, type ProductBundleItem, type ProductCardModel, type ProductCategoryRef, type ProductContentTab, type ProductCustomField, type ProductDetailModel, type ProductFaq, type ProductRatingModel, type ProductSubscription, type ProductType, QUOTE_UNAVAILABLE_CHECKOUT_ERROR, type RatingStars, type ResellerProgramSummary, type RewardProgramItem, type RewardProgramSummary, SERVING_CONTEXT_HINT, SHOP_REVIEW_PAGE_SIZE, STOREFRONT_SORT_KEYS, type SdkCartAddOptions, type SdkCartAddon, type SdkCartAppliedDiscount, type SdkCartCodeSource, type SdkCartItem, type SdkCartQuote, type SdkCartQuoteLine, type SdkCheckoutResult, type SdkCustomerAffiliateLink, type SdkCustomerAffiliateSummary, type SdkCustomerDashboard, type SdkCustomerDashboardOrder, type SdkCustomerDeliverable, type SdkCustomerDeliveryStatus, type SdkCustomerDeliverySummary, type SdkCustomerLicense, type SdkCustomerLoyalty, type SdkCustomerLoyaltyRedeem, type SdkCustomerLoyaltyTransactionType, type SdkCustomerOrderDetail, type SdkCustomerOrderPage, type SdkCustomerOrderSummary, type SdkCustomerRewardActivity, type SdkCustomerRewards, type SdkCustomerSubscription, type SdkCustomerTicketSummary, type SdkCustomerWarranty, type SdkCustomerWarrantyClaim, type SdkCustomerWarrantyClaimStatus, type SdkCustomerWarrantyList, type SdkCustomerWarrantyStatus, type SdkEligibleCartDeal, type SdkInitOptions, type SdkMenu, type SdkMenuItem, type SdkPage, type SdkRecentSaleEntry, type SdkResponse, type SdkShopReview, type ShopPageFaqItem, type ShopPageModel, type ShopPageState, type ShopReview, type ShopReviewLabels, type ShopReviewsState, type ShoppexSdk, type SocialLink, type SocialNetwork, type StockChip, type StockTone, type StorefrontAddon, type StorefrontCatalog, type StorefrontCategory, type StorefrontData, type StorefrontGroup, type StorefrontListingItem, type StorefrontPriceVariant, type StorefrontProduct, StorefrontProvider, type StorefrontSettings, type StorefrontShop, type StorefrontShopStats, type StorefrontSortKey, type SubscriptionIntervalUnit, type SupportChannel, type VolumeDiscountRule, accountOrderHref, accountRouteMessage, accountTabHref, accountTabLabelKey, averageRating, badgesForCard, badgesForProductPage, buildCartTotals, buildCartView, buildCustomFieldPayload, buildInitialCheckoutFieldValues, buildProductDetail, buildStorefrontCatalog, calculateDisplayLineTotal, calculateLinePricing, canonicalAccountPath, checkoutFieldKey, checkoutFieldWriteRepriced, checkoutNeedsDetails, clampQuantity, clearRecoveredQuoteCheckoutError, filterCatalogCards, findStorefrontProduct, firstOptionalString, flattenMerchantHtmlToText, formatCompactCount, formatDeliveryTime, formatLicenseTerm, formatMoney, formatSubscriptionCadence, formatSubscriptionTrial, getAuthoredContent, getBuyerCurrency, getProductGroups, getProducts, getShoppex, getStorefrontAddons, getStorefrontCategories, getStorefrontListing, getStorefrontSettings, getStorefrontShop, hasInjectedStorefrontData, isAccountTab, isBlankMerchantHtml, isCheckboxValueChecked, isImplementedAccountTab, isProductSoldOut, isRecord, isSelectionSoldOut, loadLatestWrittenReviews, loadShopPage, missingRequiredCheckoutValues, optionalBoolean, optionalString, optionalStringWithDefault, paginateCatalogCards, parseAccountPath, parseCartQuoteLines, parseEnum, parseFiniteNumber, parseProductBadges, parseStorefrontSortKey, readCheckoutNeedsDetails, readStorefrontData, requireArray, requireBoolean, requireNumber, requireRecord, requireString, requireStringFromKeys, requireUnknownRecord, resolveAccountView, resolveBadgeForeground, resolveCartBoundsHeals, resolveCategorySelection, resolveCheckoutFields, resolveDeliveryPromise, resolveDisplayStock, resolveHideStockCounter, resolveLicenseTerm, resolveMenuLinksForSlot, resolvePayWhatYouWantMinimum, resolveProductVideoEmbedSrc, resolveQuantityBounds, resolveSupportChannels, resolveUnsellableLineIds, resolveVariantStock, reviewsForProduct, roundCurrency, sanitizeMerchantHtml, sortCatalogCards, startCartMutation, stripMerchantHtmlImages, submitContactTicket, toShopReviews, toStarCount, useCart, useNavigationLinks, useOnlineUserCount, useShopReviews, useStorefront, validateCheckoutFieldValue, validateCheckoutFields, validateContactSubmission, withRequiredAddons };

package/dist/index.js

@@ -1998,7 +1998,7 @@ function CartProvider({ children }) {
       );
     }
     const { min: minimum, max: maximum } = resolveQuantityBounds(product, variant);
-    const addons = options?.addons ?? [];
+    const addons = withRequiredAddons(product, options?.addons ?? []);
     const payWhatYouWantPrice = options?.payWhatYouWantPrice ?? (product.payWhatYouWant ? resolvePayWhatYouWantMinimum(product, variant) : void 0);
     const addonsUnitPrice = addons.reduce((sum, addon) => sum + addon.price, 0);
     const unitPriceSnapshot = payWhatYouWantPrice !== void 0 ? payWhatYouWantPrice + addonsUnitPrice : calculateLinePricing(product, variant, addons, quantity).effectiveUnitPrice;
@@ -2039,12 +2039,18 @@ function CartProvider({ children }) {
     }
     const { bounds } = member;
     const payWhatYouWantPrice = member.product.payWhatYouWant ? resolvePayWhatYouWantMinimum(member.product, member.variant) : void 0;
+    const requiredAddons = withRequiredAddons(member.product, []);
+    const addonsUnitPrice = requiredAddons.reduce((sum, addon) => sum + addon.price, 0);
     const addOptions = {
       ...item.variantId !== "default" ? { price_variant_id: item.variantId } : {},
       // The offer states each member's unit price; a line without that
       // snapshot shows no money in the cart until the quote answers. A named
       // price overrides it, because that is the amount the backend charges.
-      ...payWhatYouWantPrice !== void 0 ? { price_data: { unit_price: payWhatYouWantPrice }, pay_what_you_want_price: payWhatYouWantPrice } : item.unitPrice > 0 ? { price_data: { unit_price: item.unitPrice } } : {},
+      ...payWhatYouWantPrice !== void 0 ? { price_data: { unit_price: payWhatYouWantPrice + addonsUnitPrice }, pay_what_you_want_price: payWhatYouWantPrice } : item.unitPrice > 0 ? { price_data: { unit_price: item.unitPrice + addonsUnitPrice } } : {},
+      ...requiredAddons.length > 0 ? {
+        addons: requiredAddons.map((addon) => ({ id: addon.id })),
+        addon_labels: requiredAddons.map((addon) => addon.title)
+      } : {},
       title: item.title,
       ...item.variantTitle ? { variant_title: item.variantTitle } : {},
       ...item.imageUrl ? { image_url: item.imageUrl } : {},
@@ -2327,6 +2333,10 @@ function useCart() {
   if (!context) throw new Error("useCart must be used inside CartProvider.");
   return context;
 }
+function withRequiredAddons(product, chosen) {
+  const ids = new Set(chosen.map((addon) => addon.id));
+  return [...chosen, ...product.addons.filter((addon) => addon.required && !ids.has(addon.id))];
+}
 function startCartMutation(mutation) {
   void mutation.catch(() => void 0);
 }
@@ -2416,6 +2426,12 @@ function validateContactSubmission(values, context) {
   if (context.requireInvoice && !values.invoiceId.trim()) {
     return "An order or invoice ID is required.";
   }
+  if (values.subject.trim().length > MAX_TITLE_LENGTH) {
+    return `Keep the subject under ${MAX_TITLE_LENGTH} characters.`;
+  }
+  if (buildTicketMessage(values).length > MESSAGE_MAX_LENGTH) {
+    return `Your message is too long. Keep it under ${MESSAGE_MAX_LENGTH.toLocaleString("en-US")} characters.`;
+  }
   return null;
 }
 function requiredGlobal(name) {
@@ -2432,7 +2448,7 @@ function buildTicketMessage(values) {
   const body = values.message.trim();
   return `${name ? `Name: ${name}
 
-` : ""}${body}`.slice(0, MESSAGE_MAX_LENGTH);
+` : ""}${body}`;
 }
 async function submitContactTicket(values, context) {
   const error = validateContactSubmission(values, context);
@@ -2448,7 +2464,7 @@ async function submitContactTicket(values, context) {
       headers: { "Content-Type": "application/json", Accept: "application/json" },
       body: JSON.stringify({
         email: values.email.trim().toLowerCase(),
-        title: subject.length >= MIN_SUBJECT_LENGTH ? subject.slice(0, MAX_TITLE_LENGTH) : DEFAULT_TICKET_TITLE,
+        title: subject.length >= MIN_SUBJECT_LENGTH ? subject : DEFAULT_TICKET_TITLE,
         message: buildTicketMessage(values),
         ...invoiceId ? { invoice_id: invoiceId } : {}
       })
@@ -2571,6 +2587,21 @@ function reviewsForProduct(reviews, productTitle) {
   if (!title) return [];
   return reviews.filter((review) => review.productTitle === title);
 }
+async function loadLatestWrittenReviews(limit, labels) {
+  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;
+  }
+  return toShopReviews(written, labels).slice(0, limit);
+}
 function averageRating(reviews) {
   if (reviews.length === 0) return null;
   return reviews.reduce((total, review) => total + review.rating, 0) / reviews.length;
@@ -2743,6 +2774,7 @@ export {
   isProductSoldOut,
   isRecord,
   isSelectionSoldOut,
+  loadLatestWrittenReviews,
   loadShopPage,
   missingRequiredCheckoutValues,
   optionalBoolean,
@@ -2796,6 +2828,7 @@ export {
   useStorefront,
   validateCheckoutFieldValue,
   validateCheckoutFields,
-  validateContactSubmission
+  validateContactSubmission,
+  withRequiredAddons
 };
 //# sourceMappingURL=index.js.map