@shipengine/elements 2.18.0 → 2.20.0

package/esm/elements/purchase-label/hooks/use-rates-with-cache.js

@@ -0,0 +1,90 @@
+import { useShipmentMetadata } from '../../../hooks/options/use-shipment-metadata.js';
+import { useState, useEffect, useCallback } from 'react';
+import { useGetShipmentRates } from '@shipengine/react-api';
+import { useRequestRates } from './use-request-rates.js';
+
+/**
+ * Since useFormHook doesn't have a "submit if valid and don't paint errors" option,
+ * instead one can use this hook to prefetch previously calculated rates from /v1/shipments/:shipment_id/rates
+ * which this hook will blend into the "real" useRequestRates hook's loading state and response values,
+ * masquerading as a cached value from the real endpoint without having a flash of error hints.
+ *
+ * It also intercepts the resetRates function from useRequestRates to set a flag to ignore this caching.
+ * (this transparently returns the behaviors to the default useRequestRates behavior)
+ */
+const useRatesWithCache = ({
+  disabledShippingServices,
+  onRatesCalculated,
+  getPreferredRates,
+  shipment
+}) => {
+  /* Flag to ignore cached rates once rates have ever been actually requested */
+  const [bypassRateCache, setBypassRateCache] = useState(false);
+  const [mustRequestRates, setMustRequestRates] = useState(false);
+  const shouldGetCachedRates = !!(shipment === null || shipment === void 0 ? void 0 : shipment.packages[0].weight.value) || !!(shipment === null || shipment === void 0 ? void 0 : shipment.carrierId) || !!(shipment === null || shipment === void 0 ? void 0 : shipment.serviceCode);
+  const cachedRates = useGetShipmentRates({
+    enabled: shouldGetCachedRates && !!(shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId),
+    queryFnParams: {
+      shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
+    }
+  });
+  const {
+    isInternational
+  } = useShipmentMetadata(shipment);
+  const {
+    isCalculating,
+    preferredRatesResponse: preferredRates,
+    ratesErrors,
+    ratesResponse: standardRequestedRateResponse,
+    requestPreferredRates,
+    requestRates,
+    resetRates
+  } = useRequestRates({
+    disabledShippingServices,
+    getPreferredRates,
+    onRatesCalculated
+  });
+  useEffect(() => {
+    if (
+    // if we don't have a preferredRates fetcher don't proceed
+    getPreferredRates !== undefined &&
+    // if there is no cached data, we'll have to fetch manually instead
+    cachedRates.data && cachedRates.data.length > 0 && cachedRates.data[0].rates.length > 0 &&
+    // as these are dependencies for the effect only proceed when they have actual values as to not call the mutator multiple times
+    shipment && isInternational !== undefined) {
+      void requestPreferredRates([shipment, isInternational]);
+    }
+  }, [requestPreferredRates, isInternational, shipment, getPreferredRates, cachedRates.data]);
+  // if there is a serviceCode on the shipment and more than one rate in cache,
+  // refetch rates to ensure only the one rate is returned
+  useEffect(() => {
+    if ((shipment === null || shipment === void 0 ? void 0 : shipment.serviceCode) && cachedRates.data && cachedRates.data.length > 0 && cachedRates.data[0].rates.length > 1) {
+      setMustRequestRates(true);
+      setBypassRateCache(true);
+    }
+  }, [shipment === null || shipment === void 0 ? void 0 : shipment.serviceCode, cachedRates.data]);
+  const resetAllRates = useCallback(() => {
+    resetRates();
+    setBypassRateCache(true);
+  }, [resetRates]);
+  const ratesCalculating = shouldGetCachedRates ? bypassRateCache || mustRequestRates ? isCalculating : isCalculating || cachedRates.status !== "success" : false;
+  useEffect(() => {
+    if (shipment && mustRequestRates) {
+      void requestRates(shipment, isInternational);
+      setMustRequestRates(false);
+    }
+  }, [isInternational, mustRequestRates, requestRates, shipment]);
+  const ratesResponse = !bypassRateCache && !ratesCalculating && cachedRates.status === "success" && cachedRates.data.length > 0 ? cachedRates.data[0] : standardRequestedRateResponse;
+  // If there is a carrierId on the shipment then don't show preferred rates. There is a saved rate on the shipment.
+  const preferredRatesResponse = cachedRates.status === "success" && cachedRates.data.length > 0 && (shipment === null || shipment === void 0 ? void 0 : shipment.carrierId) ? undefined : preferredRates;
+  return {
+    preferredRatesResponse,
+    ratesCalculating,
+    ratesErrors,
+    ratesResponse,
+    requestRates,
+    resetRates: resetAllRates
+  };
+};
+
+export { useRatesWithCache };

package/esm/elements/purchase-label/hooks/use-request-preferred-rates.js

@@ -0,0 +1,17 @@
+import { __awaiter } from 'tslib';
+import { useMutation } from '@tanstack/react-query';
+
+const useRequestPreferredRates = ({
+  getPreferredRates
+}) => {
+  return useMutation({
+    mutationFn: ([shipment, isInternational]) => __awaiter(void 0, void 0, void 0, function* () {
+      if (!getPreferredRates) throw new Error("getPreferredRates is required");
+      return yield getPreferredRates(shipment, isInternational);
+    }),
+    mutationKey: ["useRequestPreferredRates"],
+    onError: errors => errors.forEach(console.log)
+  });
+};
+
+export { useRequestPreferredRates };

package/esm/elements/purchase-label/hooks/use-request-rates.js

@@ -0,0 +1,121 @@
+import { __awaiter } from 'tslib';
+import { omitTime } from '../../../utilities/date.js';
+import { useCallback, useMemo } from 'react';
+import { useListCarriers, useListCustomPackageTypes, useCalculateRates } from '@shipengine/react-api';
+import rateMessages from '../../../data/rate-messages.js';
+import { useRequestPreferredRates } from './use-request-preferred-rates.js';
+import { isShippingServiceServiceDisabled } from '../../../utilities/feature-flags/utils.js';
+
+const useRequestRates = ({
+  disabledShippingServices,
+  onRatesCalculated,
+  getPreferredRates
+}) => {
+  const {
+    data: carriers
+  } = useListCarriers();
+  const {
+    data: customPackageTypes
+  } = useListCustomPackageTypes();
+  const {
+    data: ratedShipment,
+    error: ratesErrors,
+    isLoading: standardRatesCalculating,
+    reset: resetStandardRates,
+    mutateAsync: calculateRates
+  } = useCalculateRates();
+  const {
+    data: preferredResponse,
+    isLoading: preferredRatesCalculating,
+    reset: resetPreferredRates,
+    mutateAsync: requestPreferredRates
+  } = useRequestPreferredRates({
+    getPreferredRates
+  });
+  const requestRates = useCallback((shipment, isInternational) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    // filter out DHL for domestic shipments
+    const carrierIds = (_a = carriers === null || carriers === void 0 ? void 0 : carriers.filter(c => isInternational || !c.carrierCode.includes("dhl")).map(c => c.carrierId)) !== null && _a !== void 0 ? _a : [];
+    // Gets the correct package types for the carrier attached to the shipment
+    const getPackageType = shipment => {
+      var _a;
+      const shipmentPackageCodes = shipment.packages.map(pkg => pkg.packageCode);
+      /**
+       * Yodel does not accepts a package type of "package". Fitler "package" from the shipments packge codes
+       * Requesting rates with an empty array is equivelint to the default ["package"] for Yodel
+       */
+      if ((_a = shipment.serviceCode) === null || _a === void 0 ? void 0 : _a.includes("yodel")) {
+        return shipmentPackageCodes.filter(p => p !== "package");
+      }
+      if (customPackageTypes === null || customPackageTypes === void 0 ? void 0 : customPackageTypes.find(p => p.packageId === shipment.packages[0].packageId)) {
+        return ["package"];
+      }
+      return shipmentPackageCodes;
+    };
+    const standardRatesResponse = yield calculateRates({
+      rateOptions: {
+        carrierIds: shipment.carrierId ? [shipment.carrierId] : carrierIds,
+        packageTypes: getPackageType(shipment),
+        serviceCodes: shipment.serviceCode ? [shipment.serviceCode] : undefined
+      },
+      shipmentId: shipment.shipmentId
+    });
+    // get the preferred rates if the callback is provided
+    if (getPreferredRates) {
+      try {
+        yield requestPreferredRates([shipment, isInternational]);
+      } catch (e) {}
+    }
+    if (standardRatesResponse) yield onRatesCalculated === null || onRatesCalculated === void 0 ? void 0 : onRatesCalculated(standardRatesResponse.rateResponse.rates, shipment);
+  }), [carriers, calculateRates, getPreferredRates, onRatesCalculated, customPackageTypes, requestPreferredRates]);
+  const resetRates = useCallback(() => {
+    resetPreferredRates();
+    resetStandardRates();
+  }, [resetPreferredRates, resetStandardRates]);
+  let ratesResponse = ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.rateResponse;
+  // Remove rates for disabled shipping services
+  ratesResponse = useMemo(() => ratesResponse && Object.assign(Object.assign({}, ratesResponse), {
+    rates: ratesResponse.rates.filter(rate => !isShippingServiceServiceDisabled(rate, disabledShippingServices))
+  }), [disabledShippingServices, ratesResponse]);
+  const shipDay = useMemo(() => {
+    if (ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.shipDate) {
+      return omitTime(ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.shipDate).toLocaleString("en-us", {
+        weekday: "long"
+      });
+    }
+    return;
+  }, [ratedShipment]);
+  const ratesCalculating = getPreferredRates ? preferredRatesCalculating || standardRatesCalculating : standardRatesCalculating;
+  ratesResponse = useMemo(() => ratesResponse && Object.assign(Object.assign({}, ratesResponse), {
+    rates: ratesResponse.rates.map(rate => {
+      var _a, _b, _c;
+      return Object.assign(Object.assign({}, rate), {
+        warningMessages: [
+        // add additional rateMessages based on combinations of serviceCode, packageType and shipDay
+        ...((_a = rateMessages[`${rate.serviceCode}:${shipDay}`]) !== null && _a !== void 0 ? _a : []), ...((_b = rateMessages[`${rate.serviceCode}:${rate.packageType}`]) !== null && _b !== void 0 ? _b : []), ...((_c = rateMessages[rate.serviceCode]) !== null && _c !== void 0 ? _c : []), ...rate.warningMessages]
+      });
+    })
+  }), [ratesResponse, shipDay]);
+  const preferredRatesResponse = useMemo(() => preferredResponse && preferredResponse.map(r => {
+    var _a, _b, _c;
+    return {
+      rate: Object.assign(Object.assign({}, r.rate), {
+        warningMessages: [
+        // add additional rateMessages based on combinations of serviceCode, packageType and shipDay
+        ...((_a = rateMessages[`${r.rate.serviceCode}:${shipDay}`]) !== null && _a !== void 0 ? _a : []), ...((_b = rateMessages[`${r.rate.serviceCode}:${r.rate.packageType}`]) !== null && _b !== void 0 ? _b : []), ...((_c = rateMessages[r.rate.serviceCode]) !== null && _c !== void 0 ? _c : []), ...r.rate.warningMessages]
+      }),
+      rateAcknowledgementMessage: r.rateAcknowledgementMessage
+    };
+  }), [preferredResponse, shipDay]);
+  return {
+    isCalculating: ratesCalculating,
+    preferredRatesResponse,
+    ratesErrors,
+    ratesResponse,
+    requestPreferredRates,
+    requestRates,
+    resetRates
+  };
+};
+
+export { useRequestRates };

package/esm/elements/purchase-label/hooks/use-service-code-options/index.js

@@ -0,0 +1 @@
+export { useServiceCodeOptions } from './use-service-code-options.js';

package/esm/elements/purchase-label/hooks/use-service-code-options/use-service-code-options.js

@@ -0,0 +1,44 @@
+import { formatCarrierLabel } from '../../../../hooks/options/format-carrier-label.js';
+import { useShipmentMetadata } from '../../../../hooks/options/use-shipment-metadata.js';
+import { isUspsCarrier, isUpsCarrier } from '../../../../utilities/shipengine/carrier.js';
+import orderBy from 'lodash/orderBy.js';
+import { useMemo } from 'react';
+import { isShippingServiceServiceDisabled } from '../../../../utilities/feature-flags/utils.js';
+
+/**
+ * @internal
+ *
+ * # Service Code Options Hook
+ *
+ * @category Hooks
+ */
+const useServiceCodeOptions = (carriers, shipment, disabledShippingServices) => {
+  const {
+    isInternational,
+    isPoBox,
+    isUnsupportedUpsCountry
+  } = useShipmentMetadata(shipment);
+  return useMemo(() => {
+    return (carriers !== null && carriers !== void 0 ? carriers : []).reduce((options, carrier) => {
+      // Filter out non-USPS service for PO Box shipments
+      // Filter out UPS service for unsupported countries
+      if (!isUspsCarrier(carrier.carrierCode) && isPoBox || isUpsCarrier(carrier.carrierCode) && isUnsupportedUpsCountry) return options;
+      const services = carrier.services.filter(s => s.domestic === !isInternational && !isShippingServiceServiceDisabled(s, disabledShippingServices));
+      if (services.length === 0) return options;
+      const sortedServices = orderBy(services, "name", "asc");
+      return [...options, {
+        label: formatCarrierLabel(carriers || [], carrier),
+        options: sortedServices.map(s => ({
+          label: s.name,
+          value: {
+            carrierId: carrier.carrierId,
+            serviceCode: s.serviceCode
+          }
+        })),
+        value: carrier.carrierId
+      }];
+    }, []);
+  }, [carriers, isPoBox, isUnsupportedUpsCountry, isInternational, disabledShippingServices]);
+};
+
+export { useServiceCodeOptions };

package/esm/elements/purchase-label/hooks/use-service-points.js

@@ -0,0 +1,51 @@
+import { isPudoEligibleRate } from '../../../utilities/pudo.js';
+import { useState, useMemo, useEffect, useCallback } from 'react';
+import { useListServicePoints } from '@shipengine/react-api';
+
+const useServicePoints = (rates, shipment) => {
+  var _a;
+  const [servicePointSearchQuery, setServicePointSearchQuery] = useState((_a = shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom) === null || _a === void 0 ? void 0 : _a.postalCode);
+  //TODO: add radius filter to limit to 10km.
+  //Currently not all carriers support radius filter, so limit to 50 results
+  const baseOptions = useMemo(() => ({
+    addressQuery: servicePointSearchQuery,
+    maxResults: 50,
+    providers: []
+  }), [servicePointSearchQuery]);
+  const servicePointOptions = useMemo(() => {
+    const pudoRates = (rates === null || rates === void 0 ? void 0 : rates.filter(rate => isPudoEligibleRate(rate))) || [];
+    const carrierIds = Array.from(new Set(pudoRates.map(rate => rate.carrierId)));
+    const providers = carrierIds.map(carrierId => ({
+      carrierId,
+      serviceCode: pudoRates.filter(rate => rate.carrierId === carrierId).map(rate => rate.serviceCode)
+    }));
+    return Object.assign(Object.assign({}, baseOptions), {
+      providers
+    });
+  }, [rates, baseOptions]);
+  const [listServicePointsOptions, setListServicePointsOptions] = useState();
+  //useListServicePoints is not enabled until options.providers.length > 0, once providers are loaded, update listServicePointsOptions for use as options in useListServicePoints
+  useEffect(() => {
+    if (servicePointOptions.providers.length > 0) {
+      setListServicePointsOptions(servicePointOptions);
+    }
+  }, [servicePointOptions]);
+  const {
+    data: servicePoints,
+    isFetching: servicePointsFetching,
+    error: listServicePointsErrors
+  } = useListServicePoints(listServicePointsOptions !== null && listServicePointsOptions !== void 0 ? listServicePointsOptions : baseOptions);
+  const fetchServicePoints = useCallback(searchQuery => {
+    setServicePointSearchQuery(searchQuery);
+  }, []);
+  return {
+    fetchServicePoints,
+    listServicePointsErrors,
+    nestedServicePointErrors: servicePoints === null || servicePoints === void 0 ? void 0 : servicePoints.errors,
+    servicePointSearchQuery,
+    servicePointsFetching,
+    servicePointsResponse: servicePoints
+  };
+};
+
+export { useServicePoints };

package/esm/elements/purchase-label/hooks/use-ship-from-address-options.js

@@ -0,0 +1,47 @@
+import { capitalizeFirstLetterOfEachWord } from '../../../utilities/formatString.js';
+import { getIsShipmentUsingSavedShipFromAddress } from '../../../utilities/shipengine/address.js';
+import { useMemo } from 'react';
+
+/**
+ * @internal
+ *
+ * # Warehouse Options Hook
+ *
+ * @category Hooks
+ */
+const useShipFromAddressOptions = (warehouses, shipFromAddresses, shipment) => {
+  return useMemo(() => {
+    var _a, _b, _c, _d, _e;
+    if (!warehouses && !shipFromAddresses && !shipment) return undefined;
+    // Check if the shipment has a warehouse Id
+    const shipmentHasWarehouse = !!(shipment === null || shipment === void 0 ? void 0 : shipment.warehouseId);
+    const shipmentUsingSavedShipFromAddress = getIsShipmentUsingSavedShipFromAddress(shipment, shipFromAddresses);
+    const shipmentAddressOption = {
+      label: (_b = (_a = shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom) === null || _a === void 0 ? void 0 : _a.addressLine1) !== null && _b !== void 0 ? _b : "",
+      subLabel: `${capitalizeFirstLetterOfEachWord((_d = (_c = shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom) === null || _c === void 0 ? void 0 : _c.cityLocality) !== null && _d !== void 0 ? _d : "")}, ${(_e = shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom) === null || _e === void 0 ? void 0 : _e.stateProvince} `,
+      value: "custom-shipment-address"
+    };
+    const warehouseOptions = warehouses === null || warehouses === void 0 ? void 0 : warehouses.map(warehouse => ({
+      label: warehouse.name,
+      subLabel: `${capitalizeFirstLetterOfEachWord(warehouse.originAddress.addressLine1)}. ${capitalizeFirstLetterOfEachWord(warehouse.originAddress.cityLocality)}, ${warehouse.originAddress.stateProvince} `,
+      value: warehouse.warehouseId
+    }));
+    const shipFromAddressOptions = shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.map(address => {
+      var _a;
+      return {
+        label: (_a = address.name) !== null && _a !== void 0 ? _a : address.originAddress.addressLine1,
+        subLabel: address.name ? `${capitalizeFirstLetterOfEachWord(address.originAddress.addressLine1)}. ${capitalizeFirstLetterOfEachWord(address.originAddress.cityLocality)}, ${address.originAddress.stateProvince}  ` : `${capitalizeFirstLetterOfEachWord(address.originAddress.cityLocality)}, ${address.originAddress.stateProvince} `,
+        value: address.addressId
+      };
+    });
+    return [...(!shipmentHasWarehouse && !shipmentUsingSavedShipFromAddress ? [{
+      label: "Shipment Address",
+      options: [shipmentAddressOption]
+    }] : []), ...((shipFromAddressOptions === null || shipFromAddressOptions === void 0 ? void 0 : shipFromAddressOptions.length) || (warehouseOptions === null || warehouseOptions === void 0 ? void 0 : warehouseOptions.length) ? [{
+      label: "Saved Ship From Locations",
+      options: [...(shipFromAddressOptions !== null && shipFromAddressOptions !== void 0 ? shipFromAddressOptions : []), ...(warehouseOptions !== null && warehouseOptions !== void 0 ? warehouseOptions : [])]
+    }] : [])];
+  }, [shipFromAddresses, shipment, warehouses]);
+};
+
+export { useShipFromAddressOptions };

package/esm/elements/purchase-label/hooks/use-shipment-form.js

@@ -0,0 +1,166 @@
+import { __awaiter } from 'tslib';
+import { useScrubErrors } from '../../../hooks/use-scrub-errors.js';
+import { isNowOrInTheFuture } from '../../../utilities/date.js';
+import isEqual from 'lodash/isEqual.js';
+import { useCallback, useMemo } from 'react';
+import { ZodError } from 'zod';
+import { useListCarriers, useListCustomPackageTypes, useListWarehouses, useGetAccountSettings, useUpdateSalesOrderShipment, CodedError } from '@shipengine/react-api';
+import { useAddress } from './use-address.js';
+import { useCustoms } from './use-customs.js';
+import { usePresets } from './use-presets.js';
+import { shipFromAddressFormSchema } from '../../../components/forms/ship-from-address-form/ship-from-address-form-schema.js';
+
+const useShipmentForm = ({
+  compatibleCountryCodes,
+  onAddressValidation,
+  onApplyPreset,
+  onChangeAddress,
+  onShipmentUpdated,
+  onSubmit,
+  salesOrder,
+  shipment,
+  shipFromAddresses: shipFromAddressesProp,
+  useWarehouses: _useWarehouses = true
+}) => {
+  const {
+    data: carriers
+  } = useListCarriers();
+  const {
+    data: customPackageTypes
+  } = useListCustomPackageTypes();
+  const {
+    data: warehouses
+  } = useListWarehouses({
+    enabled: _useWarehouses
+  });
+  const {
+    data: accountSettings
+  } = useGetAccountSettings();
+  const {
+    error: updateShipmentErrors,
+    mutateAsync: updateShipment,
+    reset: resetSalesOrderShipment
+  } = useUpdateSalesOrderShipment();
+  const {
+    addressLoading,
+    addressErrors,
+    addressPreference: shipToAddressPreference,
+    charsetWarning,
+    handleChangeAddress,
+    handleParseAddress,
+    parseAddressErrors,
+    resetParseAddress
+  } = useAddress({
+    compatibleCountryCodes,
+    onChange: useCallback((oldShipment, updatedShipment) => __awaiter(void 0, void 0, void 0, function* () {
+      yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(oldShipment, updatedShipment);
+    }), [onShipmentUpdated, onChangeAddress]),
+    onValidation: onAddressValidation,
+    salesOrder,
+    shipment
+  });
+  const {
+    handleApplyPreset,
+    presetErrors
+  } = usePresets({
+    onApply: onApplyPreset,
+    onShipmentUpdated: onShipmentUpdated,
+    shipment
+  });
+  const {
+    customsErrors,
+    handleUpdateCustoms,
+    handleUpdateTaxableIds
+  } = useCustoms({
+    onUpdate: onShipmentUpdated,
+    shipment
+  });
+  // Adds a unique id to each address in the ship from address prop
+  const shipFromAddresses = useMemo(() => {
+    if (!shipFromAddressesProp) return;
+    return shipFromAddressesProp.map((address, index) => Object.assign(Object.assign({}, address), {
+      addressId: `custom-${index}`
+    }));
+  }, [shipFromAddressesProp]);
+  // if the shipment is not using warehouses, run the ship from address through the schema to check for errors
+  const shipFromAddressSchemaErrors = useMemo(() => {
+    if (shipment === null || shipment === void 0 ? void 0 : shipment.warehouseId) return;
+    try {
+      shipFromAddressFormSchema.parse({
+        originAddress: shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom,
+        returnAddress: shipment === null || shipment === void 0 ? void 0 : shipment.returnTo,
+        returnToAddressIsDifferent: !isEqual(shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom, shipment === null || shipment === void 0 ? void 0 : shipment.returnTo)
+      });
+    } catch (error) {
+      if (error instanceof ZodError) {
+        return [new CodedError("Invalid Ship From Address", {
+          errorCode: "invalid_address",
+          errorSource: "elements",
+          errorType: "validation"
+        })];
+      }
+    }
+    return;
+  }, [shipment]);
+  const handleSubmit = useCallback(values => __awaiter(void 0, void 0, void 0, function* () {
+    if (!shipment) throw new Error("shipment not found");
+    const updatedShipment = yield updateShipment(Object.assign(Object.assign(Object.assign({}, shipment), values), {
+      shipDate: isNowOrInTheFuture(values.shipDate) ? values.shipDate : undefined
+    }));
+    if (updatedShipment) {
+      yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
+      yield onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(updatedShipment);
+    }
+    return updatedShipment;
+  }), [onShipmentUpdated, onSubmit, updateShipment, shipment]);
+  // We now allow users to ship from and to countries outside the US. Update the shipments warehouseId
+  // when it is changed in the UI to include or remove customs requirements.
+  const handleChangeShipFromAddress = useCallback((id, shipFromAddress) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    if (!shipment) throw new Error("shipment not found");
+    const shipFrom = (_a = shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.find(address => address.addressId === id)) !== null && _a !== void 0 ? _a : shipFromAddress;
+    const warehouse = warehouses === null || warehouses === void 0 ? void 0 : warehouses.find(warehouse => warehouse.warehouseId === id);
+    const updatedShipment = yield updateShipment(Object.assign(Object.assign({}, shipment), {
+      returnTo: shipFrom ? shipFrom === null || shipFrom === void 0 ? void 0 : shipFrom.returnAddress : undefined,
+      shipFrom: shipFrom ? shipFrom === null || shipFrom === void 0 ? void 0 : shipFrom.originAddress : undefined,
+      warehouseId: warehouse ? id : undefined
+    }));
+    if (updatedShipment) {
+      yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(shipment, updatedShipment);
+    }
+  }), [onChangeAddress, onShipmentUpdated, shipFromAddresses, shipment, updateShipment, warehouses]);
+  const errors = useMemo(() => [...(addressErrors !== null && addressErrors !== void 0 ? addressErrors : []), ...(customsErrors !== null && customsErrors !== void 0 ? customsErrors : []), ...(presetErrors !== null && presetErrors !== void 0 ? presetErrors : []), ...(shipFromAddressSchemaErrors !== null && shipFromAddressSchemaErrors !== void 0 ? shipFromAddressSchemaErrors : []), ...(updateShipmentErrors !== null && updateShipmentErrors !== void 0 ? updateShipmentErrors : [])], [addressErrors, customsErrors, presetErrors, shipFromAddressSchemaErrors, updateShipmentErrors]);
+  const displayableErrors = useScrubErrors({
+    errors: errors,
+    predicate: useCallback(e => e.errorSource === "shipengine" && e.errorType === "business_rules", []),
+    scrubber: useCallback(() => "common:errorMessages.noRatesAvailable", [])
+  });
+  return {
+    accountSettings,
+    addressLoading,
+    carriers,
+    charsetWarning,
+    customPackageTypes,
+    displayableErrors,
+    errors: errors.length > 0 ? errors : undefined,
+    onApplyPreset: handleApplyPreset,
+    onChangeAddress: handleChangeAddress,
+    onChangeShipFromAddress: handleChangeShipFromAddress,
+    onSubmit: handleSubmit,
+    onSubmitParseAddress: handleParseAddress,
+    onUpdateCustoms: handleUpdateCustoms,
+    onUpdateTaxableIds: handleUpdateTaxableIds,
+    parseAddressErrors,
+    resetParseAddress,
+    resetSalesOrderShipment,
+    salesOrder,
+    shipFromAddresses,
+    shipment,
+    shipToAddressPreference,
+    warehouses
+  };
+};
+
+export { useShipmentForm };

package/esm/elements/purchase-label/hooks/use-shipping-presets-options.js

@@ -0,0 +1,35 @@
+import { jsx } from '@emotion/react/jsx-runtime';
+import { useShipmentMetadata } from '../../../hooks/options/use-shipment-metadata.js';
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+import { PresetDescriptor } from '../components/preset-descriptor/preset-descriptor.js';
+
+const createCategoryFromShippingPresets = (categoryName, presets) => presets ? [{
+  categoryName: categoryName,
+  options: presets.map(p => ({
+    description: jsx(PresetDescriptor, Object.assign({}, p)),
+    displayName: p.name,
+    value: p
+  }))
+}] : [];
+/**
+ * @internal
+ *
+ * # Shipping Preset Options Component
+ */
+const useShippingPresetsOptions = ({
+  platform,
+  user
+} = {}, shipment) => {
+  const {
+    t
+  } = useTranslation();
+  const {
+    isInternational
+  } = useShipmentMetadata(shipment);
+  return useMemo(() => [...createCategoryFromShippingPresets(t("shippingPresets.user"), isInternational ? user === null || user === void 0 ? void 0 : user.international : user === null || user === void 0 ? void 0 : user.domestic),
+  // TODO - platform name should probably be a platform-specific environmental variable ?
+  ...createCategoryFromShippingPresets(t("shippingPresets.platform"), isInternational ? platform === null || platform === void 0 ? void 0 : platform.international : platform === null || platform === void 0 ? void 0 : platform.domestic)], [isInternational, platform, t, user]);
+};
+
+export { useShippingPresetsOptions };

package/esm/elements/purchase-label/hooks/use-windsor-framework.js

@@ -0,0 +1,89 @@
+import { useMemo } from 'react';
+
+const useWindsorFramework = (shipment, enabled) => {
+  // Windsor Framework movement indicator
+  const movementIndicator = useMemo(() => {
+    var _a, _b;
+    return (_b = (_a = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _a === void 0 ? void 0 : _a.windsorFrameworkDetails) === null || _b === void 0 ? void 0 : _b.movementIndicator;
+  }, [shipment]);
+  /**
+   * Check if shipment is fits under the Windsor framework guidelines.
+   *
+   * The Windsor framework only applies to shipments that are coming from mainland Great Britain i.e., England or Scotland and going to Norther Ireland.
+   * The Windsor framework does NOT apply to the reverse i.e., Shipping from Northern Ireland to England or Scotland.
+   * The Windsor framework also does not apply to shipments from within Northern Ireland
+   */
+  const requiresWindsorFramework = useMemo(() => {
+    var _a, _b;
+    if (!shipment) return false;
+    const shipFromCountryCode = (_a = shipment.shipFrom) === null || _a === void 0 ? void 0 : _a.countryCode;
+    const shipToCountryCode = shipment.shipTo.countryCode;
+    const shippingFromNorthernIreland = (_b = shipment.shipFrom) === null || _b === void 0 ? void 0 : _b.postalCode.includes("BT");
+    const shippingToNorthernIreland = shipment.shipTo.postalCode.includes("BT");
+    return shipFromCountryCode === "GB" && shipToCountryCode === "GB" && shippingToNorthernIreland && !shippingFromNorthernIreland;
+  }, [shipment]);
+  const isWindsorFrameworkInvalid = useMemo(() => {
+    var _a;
+    const windsorFrameworkDetails = (_a = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _a === void 0 ? void 0 : _a.windsorFrameworkDetails;
+    if (!windsorFrameworkDetails || !enabled) return {
+      isInvalid: false
+    };
+    const {
+      movementIndicator
+    } = windsorFrameworkDetails;
+    if (movementIndicator === "b2b") {
+      const taxIds = shipment.taxIdentifiers;
+      // If there are no Tax IDs on the Shipment show messaging for all required tax IDs.
+      if (!taxIds) return {
+        isInvalid: true,
+        messages: ["shipperEori", "recipientEori", "ukims"]
+      };
+      // Determine if Shipment has all the required Tax IDs for Windsor Framwork Shipment
+      const taxIdentifiers = taxIds.reduce((acc, taxId) => {
+        switch (taxId.identifierType) {
+          case "eori":
+            acc[`${taxId.taxableEntityType}Eori`] = true;
+            break;
+          case "ukims":
+            acc["ukims"] = true;
+            break;
+        }
+        return acc;
+      }, {
+        recipientEori: false,
+        shipperEori: false,
+        ukims: false
+      });
+      const missingFields = [];
+      // Check for missing identifiers and build the error message
+      if (!taxIdentifiers.shipperEori) {
+        missingFields.push("shipperEori");
+      }
+      if (!taxIdentifiers.recipientEori) {
+        missingFields.push("recipientEori");
+      }
+      if (!taxIdentifiers.ukims) {
+        missingFields.push("ukims");
+      }
+      // If all necessary tax ids are present, return success
+      if (missingFields.length === 0) {
+        return {
+          isInvalid: false
+        };
+      }
+      return {
+        isInvalid: true,
+        messages: missingFields
+      };
+    } else return {
+      isInvalid: false
+    };
+  }, [enabled, shipment]);
+  return {
+    isWindsorFrameworkInvalid,
+    movementIndicator,
+    requiresWindsorFramework: requiresWindsorFramework && enabled
+  };
+};
+
+export { useWindsorFramework };