merchi_cart 1.4.6 → 1.4.8

package/esm/forms/FormShipmentAddressAndNotes.js

@@ -17,10 +17,10 @@ import { useForm } from "react-hook-form";
 import InputsAddress from "./InputsAddress";
 import { CheckoutContainer, InnerContainer } from "../components/containers";
 import { Title } from "../components";
-import { shipmentFormId } from "../utilities/shipment";
+import { checkoutShipmentHydrationAction, shipmentFormId } from "../utilities/shipment";
 import { faMapMarkerAlt } from "@fortawesome/free-solid-svg-icons";
 import { useCartContext } from "../CartProvider";
-import { useState } from "react";
+import { useEffect, useRef, useState } from "react";
 import { getCartCookieToken } from "../utilities/cookie";
 import { makeAddress, sanitizeAddressFields } from "../utilities/address";
 import { makeCart } from "../utilities/cart";
@@ -122,7 +122,9 @@ export function ActiveFormShipmentAddressAndNotes() {
     cart = _useCartContext2.cart,
     setCart = _useCartContext2.setCart,
     setLoadingTotals = _useCartContext2.setLoadingTotals,
-    setActiveTabAndEditDisabled = _useCartContext2.setActiveTabAndEditDisabled;
+    setActiveTabAndEditDisabled = _useCartContext2.setActiveTabAndEditDisabled,
+    updateCartShipmentAddress = _useCartContext2.updateCartShipmentAddress,
+    getCartShipmentOptions = _useCartContext2.getCartShipmentOptions;
   var saved = getSavedCheckoutAddress(domainId);
   var cartAddress = cart === null || cart === void 0 ? void 0 : cart.receiverAddress;
   var receiverAddress = addressHasContent(cartAddress) ? cartAddress : saved.address || {};
@@ -131,6 +133,25 @@ export function ActiveFormShipmentAddressAndNotes() {
     _useState2 = _slicedToArray(_useState, 2),
     addressFieldsOpen = _useState2[0],
     setAddressFieldsOpen = _useState2[1];
+  var hydratedShipmentOptionsRef = useRef(false);
+  useEffect(function () {
+    if (hydratedShipmentOptionsRef.current || !(cart !== null && cart !== void 0 && cart.id)) return;
+    var draft = getSavedCheckoutAddress(domainId);
+    var action = checkoutShipmentHydrationAction({
+      cartAddress: cart === null || cart === void 0 ? void 0 : cart.receiverAddress,
+      savedAddress: draft.address,
+      shipmentGroups: cart === null || cart === void 0 ? void 0 : cart.shipmentGroups
+    });
+    if (!action) return;
+    hydratedShipmentOptionsRef.current = true;
+    if (action === "apply-saved-address" && draft.address) {
+      updateCartShipmentAddress(draft.address);
+      return;
+    }
+    if (action === "refresh-quotes") {
+      getCartShipmentOptions === null || getCartShipmentOptions === void 0 || getCartShipmentOptions();
+    }
+  }, [cart === null || cart === void 0 ? void 0 : cart.id, cart === null || cart === void 0 ? void 0 : cart.receiverAddress, cart === null || cart === void 0 ? void 0 : cart.shipmentGroups, domainId, getCartShipmentOptions, updateCartShipmentAddress]);
   function saveCartShipmentAddressAndGoToNextTab(_x) {
     return _saveCartShipmentAddressAndGoToNextTab.apply(this, arguments);
   }

package/esm/utilities/shipment.js

@@ -1,3 +1,4 @@
+import { addressHasContent } from './local_storage';
 export var shipmentFormId = '_shipment-address-form-id';
 export function cartItemsNeedShipment(cart) {
   var _cart$cartItems = cart.cartItems,
@@ -8,4 +9,25 @@ export function cartItemsNeedShipment(cart) {
     }
   }
   return false;
+}
+export function shipmentGroupsHaveQuotes(groups) {
+  if (!(groups !== null && groups !== void 0 && groups.length)) return false;
+  return groups.some(function (group) {
+    return Array.isArray(group === null || group === void 0 ? void 0 : group.quotes) && group.quotes.length > 0;
+  });
+}
+/**
+ * When checkout hydrates a saved address (localStorage) the form shows it,
+ * but quotes are only fetched after the user edits the field. Returning
+ * `apply-saved-address` means the cart still needs that address applied so
+ * quotes can be generated; `refresh-quotes` means the cart already has an
+ * address but no usable shipment options.
+ */
+export function checkoutShipmentHydrationAction(options) {
+  var hasCartAddress = addressHasContent(options.cartAddress);
+  var hasSavedAddress = addressHasContent(options.savedAddress);
+  var hasQuotes = shipmentGroupsHaveQuotes(options.shipmentGroups);
+  if (!hasCartAddress && hasSavedAddress) return 'apply-saved-address';
+  if (hasCartAddress && !hasQuotes) return 'refresh-quotes';
+  return null;
 }

package/esm/utilities/shipment.test.js

@@ -0,0 +1,60 @@
+import { checkoutShipmentHydrationAction, shipmentGroupsHaveQuotes } from './shipment';
+var savedAddress = {
+  lineOne: '32 Bridge St',
+  city: 'Brighton',
+  state: 'VIC',
+  postcode: '3186',
+  country: 'AU'
+};
+describe('shipmentGroupsHaveQuotes', function () {
+  it('is false when groups are missing or empty', function () {
+    expect(shipmentGroupsHaveQuotes(undefined)).toBe(false);
+    expect(shipmentGroupsHaveQuotes([])).toBe(false);
+    expect(shipmentGroupsHaveQuotes([{
+      quotes: []
+    }])).toBe(false);
+  });
+  it('is true when any group has quotes', function () {
+    expect(shipmentGroupsHaveQuotes([{
+      quotes: []
+    }, {
+      quotes: [{
+        id: 1
+      }]
+    }])).toBe(true);
+  });
+});
+describe('checkoutShipmentHydrationAction', function () {
+  it('applies a localStorage address when the cart has none', function () {
+    expect(checkoutShipmentHydrationAction({
+      cartAddress: {},
+      savedAddress: savedAddress,
+      shipmentGroups: []
+    })).toBe('apply-saved-address');
+  });
+  it('refreshes quotes when the cart already has an address but no options', function () {
+    expect(checkoutShipmentHydrationAction({
+      cartAddress: savedAddress,
+      savedAddress: savedAddress,
+      shipmentGroups: []
+    })).toBe('refresh-quotes');
+  });
+  it('does nothing when quotes are already available', function () {
+    expect(checkoutShipmentHydrationAction({
+      cartAddress: savedAddress,
+      savedAddress: savedAddress,
+      shipmentGroups: [{
+        quotes: [{
+          id: 9
+        }]
+      }]
+    })).toBe(null);
+  });
+  it('does nothing when neither cart nor localStorage has an address', function () {
+    expect(checkoutShipmentHydrationAction({
+      cartAddress: {},
+      savedAddress: {},
+      shipmentGroups: []
+    })).toBe(null);
+  });
+});

package/lib/forms/FormShipmentAddressAndNotes.js

@@ -129,7 +129,9 @@ function ActiveFormShipmentAddressAndNotes() {
     cart = _useCartContext2.cart,
     setCart = _useCartContext2.setCart,
     setLoadingTotals = _useCartContext2.setLoadingTotals,
-    setActiveTabAndEditDisabled = _useCartContext2.setActiveTabAndEditDisabled;
+    setActiveTabAndEditDisabled = _useCartContext2.setActiveTabAndEditDisabled,
+    updateCartShipmentAddress = _useCartContext2.updateCartShipmentAddress,
+    getCartShipmentOptions = _useCartContext2.getCartShipmentOptions;
   var saved = (0, _local_storage.getSavedCheckoutAddress)(domainId);
   var cartAddress = cart === null || cart === void 0 ? void 0 : cart.receiverAddress;
   var receiverAddress = (0, _local_storage.addressHasContent)(cartAddress) ? cartAddress : saved.address || {};
@@ -138,6 +140,25 @@ function ActiveFormShipmentAddressAndNotes() {
     _useState2 = _slicedToArray(_useState, 2),
     addressFieldsOpen = _useState2[0],
     setAddressFieldsOpen = _useState2[1];
+  var hydratedShipmentOptionsRef = (0, _react.useRef)(false);
+  (0, _react.useEffect)(function () {
+    if (hydratedShipmentOptionsRef.current || !(cart !== null && cart !== void 0 && cart.id)) return;
+    var draft = (0, _local_storage.getSavedCheckoutAddress)(domainId);
+    var action = (0, _shipment.checkoutShipmentHydrationAction)({
+      cartAddress: cart === null || cart === void 0 ? void 0 : cart.receiverAddress,
+      savedAddress: draft.address,
+      shipmentGroups: cart === null || cart === void 0 ? void 0 : cart.shipmentGroups
+    });
+    if (!action) return;
+    hydratedShipmentOptionsRef.current = true;
+    if (action === "apply-saved-address" && draft.address) {
+      updateCartShipmentAddress(draft.address);
+      return;
+    }
+    if (action === "refresh-quotes") {
+      getCartShipmentOptions === null || getCartShipmentOptions === void 0 || getCartShipmentOptions();
+    }
+  }, [cart === null || cart === void 0 ? void 0 : cart.id, cart === null || cart === void 0 ? void 0 : cart.receiverAddress, cart === null || cart === void 0 ? void 0 : cart.shipmentGroups, domainId, getCartShipmentOptions, updateCartShipmentAddress]);
   function saveCartShipmentAddressAndGoToNextTab(_x) {
     return _saveCartShipmentAddressAndGoToNextTab.apply(this, arguments);
   }

package/lib/utilities/shipment.d.ts

@@ -1,2 +1,17 @@
+import { SavedCheckoutAddress } from './local_storage';
 export declare const shipmentFormId = "_shipment-address-form-id";
 export declare function cartItemsNeedShipment(cart: any): boolean;
+export declare function shipmentGroupsHaveQuotes(groups?: any[] | null): boolean;
+export type CheckoutShipmentHydrationAction = 'apply-saved-address' | 'refresh-quotes' | null;
+/**
+ * When checkout hydrates a saved address (localStorage) the form shows it,
+ * but quotes are only fetched after the user edits the field. Returning
+ * `apply-saved-address` means the cart still needs that address applied so
+ * quotes can be generated; `refresh-quotes` means the cart already has an
+ * address but no usable shipment options.
+ */
+export declare function checkoutShipmentHydrationAction(options: {
+    cartAddress?: SavedCheckoutAddress | null;
+    savedAddress?: SavedCheckoutAddress | null;
+    shipmentGroups?: any[] | null;
+}): CheckoutShipmentHydrationAction;

package/lib/utilities/shipment.js

@@ -4,7 +4,10 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.cartItemsNeedShipment = cartItemsNeedShipment;
+exports.checkoutShipmentHydrationAction = checkoutShipmentHydrationAction;
 exports.shipmentFormId = void 0;
+exports.shipmentGroupsHaveQuotes = shipmentGroupsHaveQuotes;
+var _local_storage = require("./local_storage");
 var shipmentFormId = exports.shipmentFormId = '_shipment-address-form-id';
 function cartItemsNeedShipment(cart) {
   var _cart$cartItems = cart.cartItems,
@@ -15,4 +18,25 @@ function cartItemsNeedShipment(cart) {
     }
   }
   return false;
+}
+function shipmentGroupsHaveQuotes(groups) {
+  if (!(groups !== null && groups !== void 0 && groups.length)) return false;
+  return groups.some(function (group) {
+    return Array.isArray(group === null || group === void 0 ? void 0 : group.quotes) && group.quotes.length > 0;
+  });
+}
+/**
+ * When checkout hydrates a saved address (localStorage) the form shows it,
+ * but quotes are only fetched after the user edits the field. Returning
+ * `apply-saved-address` means the cart still needs that address applied so
+ * quotes can be generated; `refresh-quotes` means the cart already has an
+ * address but no usable shipment options.
+ */
+function checkoutShipmentHydrationAction(options) {
+  var hasCartAddress = (0, _local_storage.addressHasContent)(options.cartAddress);
+  var hasSavedAddress = (0, _local_storage.addressHasContent)(options.savedAddress);
+  var hasQuotes = shipmentGroupsHaveQuotes(options.shipmentGroups);
+  if (!hasCartAddress && hasSavedAddress) return 'apply-saved-address';
+  if (hasCartAddress && !hasQuotes) return 'refresh-quotes';
+  return null;
 }

package/lib/utilities/shipment.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_cart",
-  "version": "1.4.6",
+  "version": "1.4.8",
   "description": "Merchi's cart",
   "source": "src/index.ts",
   "main": "lib/index.js",
@@ -94,7 +94,7 @@
     "browser-or-node": "^3.0.0-pre.0",
     "js-cookie": "^3.0.5",
     "lodash": "^4.17.21",
-    "merchi_product_form": "^1.19.4",
+    "merchi_product_form": "^1.19.14",
     "merchi_sdk_product_form": "^1.0.9",
     "merchi_sdk_ts": "^1.42.0",
     "react-country-region-selector": "^3.6.1",

package/src/forms/FormShipmentAddressAndNotes.tsx

@@ -2,10 +2,13 @@ import { useForm } from "react-hook-form";
 import InputsAddress from "./InputsAddress";
 import { CheckoutContainer, InnerContainer } from "../components/containers";
 import { Title } from "../components";
-import { shipmentFormId } from "../utilities/shipment";
+import {
+  checkoutShipmentHydrationAction,
+  shipmentFormId,
+} from "../utilities/shipment";
 import { faMapMarkerAlt } from "@fortawesome/free-solid-svg-icons";
 import { useCartContext } from "../CartProvider";
-import { useState } from "react";
+import { useEffect, useRef, useState } from "react";
 import { getCartCookieToken } from "../utilities/cookie";
 import { makeAddress, sanitizeAddressFields } from "../utilities/address";
 import { makeCart } from "../utilities/cart";
@@ -114,6 +117,8 @@ export function ActiveFormShipmentAddressAndNotes() {
     setCart,
     setLoadingTotals,
     setActiveTabAndEditDisabled,
+    updateCartShipmentAddress,
+    getCartShipmentOptions,
   } = useCartContext();
   const saved = getSavedCheckoutAddress(domainId);
   const cartAddress = cart?.receiverAddress;
@@ -122,6 +127,33 @@ export function ActiveFormShipmentAddressAndNotes() {
     : saved.address || {};
   const receiverNotes = cart?.receiverNotes || saved.receiverNotes || "";
   const [addressFieldsOpen, setAddressFieldsOpen] = useState(false);
+  const hydratedShipmentOptionsRef = useRef(false);
+
+  useEffect(() => {
+    if (hydratedShipmentOptionsRef.current || !cart?.id) return;
+    const draft = getSavedCheckoutAddress(domainId);
+    const action = checkoutShipmentHydrationAction({
+      cartAddress: cart?.receiverAddress,
+      savedAddress: draft.address,
+      shipmentGroups: cart?.shipmentGroups,
+    });
+    if (!action) return;
+    hydratedShipmentOptionsRef.current = true;
+    if (action === "apply-saved-address" && draft.address) {
+      updateCartShipmentAddress(draft.address);
+      return;
+    }
+    if (action === "refresh-quotes") {
+      getCartShipmentOptions?.();
+    }
+  }, [
+    cart?.id,
+    cart?.receiverAddress,
+    cart?.shipmentGroups,
+    domainId,
+    getCartShipmentOptions,
+    updateCartShipmentAddress,
+  ]);
 
   async function saveCartShipmentAddressAndGoToNextTab(values: any) {
     const { receiverAddress: address, receiverNotes } = values;

package/src/utilities/shipment.test.ts

@@ -0,0 +1,68 @@
+import {
+  checkoutShipmentHydrationAction,
+  shipmentGroupsHaveQuotes,
+} from './shipment';
+
+const savedAddress = {
+  lineOne: '32 Bridge St',
+  city: 'Brighton',
+  state: 'VIC',
+  postcode: '3186',
+  country: 'AU',
+};
+
+describe('shipmentGroupsHaveQuotes', () => {
+  it('is false when groups are missing or empty', () => {
+    expect(shipmentGroupsHaveQuotes(undefined)).toBe(false);
+    expect(shipmentGroupsHaveQuotes([])).toBe(false);
+    expect(shipmentGroupsHaveQuotes([{ quotes: [] }])).toBe(false);
+  });
+
+  it('is true when any group has quotes', () => {
+    expect(
+      shipmentGroupsHaveQuotes([{ quotes: [] }, { quotes: [{ id: 1 }] }])
+    ).toBe(true);
+  });
+});
+
+describe('checkoutShipmentHydrationAction', () => {
+  it('applies a localStorage address when the cart has none', () => {
+    expect(
+      checkoutShipmentHydrationAction({
+        cartAddress: {},
+        savedAddress,
+        shipmentGroups: [],
+      })
+    ).toBe('apply-saved-address');
+  });
+
+  it('refreshes quotes when the cart already has an address but no options', () => {
+    expect(
+      checkoutShipmentHydrationAction({
+        cartAddress: savedAddress,
+        savedAddress,
+        shipmentGroups: [],
+      })
+    ).toBe('refresh-quotes');
+  });
+
+  it('does nothing when quotes are already available', () => {
+    expect(
+      checkoutShipmentHydrationAction({
+        cartAddress: savedAddress,
+        savedAddress,
+        shipmentGroups: [{ quotes: [{ id: 9 }] }],
+      })
+    ).toBe(null);
+  });
+
+  it('does nothing when neither cart nor localStorage has an address', () => {
+    expect(
+      checkoutShipmentHydrationAction({
+        cartAddress: {},
+        savedAddress: {},
+        shipmentGroups: [],
+      })
+    ).toBe(null);
+  });
+});

package/src/utilities/shipment.ts

@@ -1,3 +1,5 @@
+import { addressHasContent, SavedCheckoutAddress } from './local_storage';
+
 export const shipmentFormId = '_shipment-address-form-id';
 
 export function cartItemsNeedShipment(cart: any) {
@@ -9,3 +11,35 @@ export function cartItemsNeedShipment(cart: any) {
   }
   return false;
 }
+
+export function shipmentGroupsHaveQuotes(groups?: any[] | null) {
+  if (!groups?.length) return false;
+  return groups.some(
+    (group) => Array.isArray(group?.quotes) && group.quotes.length > 0
+  );
+}
+
+export type CheckoutShipmentHydrationAction =
+  | 'apply-saved-address'
+  | 'refresh-quotes'
+  | null;
+
+/**
+ * When checkout hydrates a saved address (localStorage) the form shows it,
+ * but quotes are only fetched after the user edits the field. Returning
+ * `apply-saved-address` means the cart still needs that address applied so
+ * quotes can be generated; `refresh-quotes` means the cart already has an
+ * address but no usable shipment options.
+ */
+export function checkoutShipmentHydrationAction(options: {
+  cartAddress?: SavedCheckoutAddress | null;
+  savedAddress?: SavedCheckoutAddress | null;
+  shipmentGroups?: any[] | null;
+}): CheckoutShipmentHydrationAction {
+  const hasCartAddress = addressHasContent(options.cartAddress);
+  const hasSavedAddress = addressHasContent(options.savedAddress);
+  const hasQuotes = shipmentGroupsHaveQuotes(options.shipmentGroups);
+  if (!hasCartAddress && hasSavedAddress) return 'apply-saved-address';
+  if (hasCartAddress && !hasQuotes) return 'refresh-quotes';
+  return null;
+}