@shipengine/elements 2.20.0 → 2.22.0

package/cjs/elements/purchase-label/hooks/use-rates-form.cjs

@@ -0,0 +1,295 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var useShipmentMetadata = require('../../../hooks/options/use-shipment-metadata.cjs');
+var useBalanceServices = require('../../../hooks/use-balance-services.cjs');
+var useScrubErrors = require('../../../hooks/use-scrub-errors.cjs');
+var date = require('../../../utilities/date.cjs');
+var rates = require('../../../utilities/rates.cjs');
+var vat = require('../../../utilities/vat.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var useRatesWithCache = require('./use-rates-with-cache.cjs');
+var useServicePoints = require('./use-service-points.cjs');
+
+/* https://auctane.atlassian.net/browse/ENGINE-7329
+ * For iteration one we would hardcode services for which it will be available  (in the future this data will be in the registry. We will change hardcoding then)
+ * carriersWithPaperless and servicesWithPaperless are hardcoded for iteration one
+ */
+const servicesWithPaperless = ["hermes_domestic_parcelshop_dropoff", "hermes_domestic_parcelshop_dropoff_next_day", "hermes_postable", "hermes_postable_next_day"];
+const useRatesForm = ({
+  getPreferredRates,
+  disabledShippingServices,
+  onBeforeRateSaved,
+  onBeforeLabelCreate,
+  onLabelCreateFailure,
+  onLabelCreateSuccess,
+  onRateSaved,
+  onRatesCalculated,
+  onShipmentUpdated,
+  printLabelLayout,
+  selectedRate,
+  shipment
+}) => {
+  var _a, _b, _c;
+  const [beforeCreateError, setBeforeCreateError] = React.useState();
+  const [beforeSaveError, setBeforeSaveError] = React.useState();
+  const [isSavingRate, setIsSavingRate] = React.useState(false);
+  const fundingSourceMetadata = reactApi.useGetFundingSourceMetadata();
+  const fundingSourceRegion = (_a = fundingSourceMetadata.data) === null || _a === void 0 ? void 0 : _a.defaultRegionProfile.countryCode;
+  const isVatRequiredCountry = vat.getIsVatRequired(fundingSourceRegion);
+  const {
+    isInternational
+  } = useShipmentMetadata.useShipmentMetadata(shipment);
+  const {
+    data: carriers
+  } = reactApi.useListCarriers();
+  const {
+    fundingOrigin
+  } = useBalanceServices.useBalanceServices({
+    carrierId: selectedRate === null || selectedRate === void 0 ? void 0 : selectedRate.carrierId
+  });
+  const {
+    data: {
+      labels = []
+    } = {},
+    isInitialLoading: labelsLoading
+  } = reactApi.useListLabels();
+  const {
+    mutateAsync: updateShipment
+  } = reactApi.useUpdateSalesOrderShipment();
+  const {
+    error: labelErrors,
+    reset: resetLabel,
+    mutateAsync: createLabel
+  } = reactApi.useCreateLabel();
+  const {
+    ratesErrors,
+    preferredRatesResponse,
+    requestRates,
+    resetRates,
+    ratesCalculating,
+    ratesResponse
+  } = useRatesWithCache.useRatesWithCache({
+    disabledShippingServices,
+    getPreferredRates,
+    onRatesCalculated,
+    shipment
+  });
+  const {
+    servicePointsResponse,
+    servicePointsFetching,
+    fetchServicePoints,
+    listServicePointsErrors,
+    servicePointSearchQuery
+  } = useServicePoints.useServicePoints(ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates, shipment);
+  const isDisplaySchemePaperless = rate => {
+    if ("hermes" === rate.carrierCode) {
+      return !!servicesWithPaperless.find(service => service === rate.serviceCode);
+    }
+    return false;
+  };
+  const purchaseLabel = React.useCallback((rateId, shipment, rate, servicePoint) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _d;
+    try {
+      const label = yield createLabel({
+        displayScheme: isDisplaySchemePaperless(rate) ? "label_and_paperless" : "label",
+        labelDownloadType: "url",
+        labelFormat: "pdf",
+        labelLayout: (_d = printLabelLayout === null || printLabelLayout === void 0 ? void 0 : printLabelLayout.toLowerCase()) !== null && _d !== void 0 ? _d : "4x6",
+        rateId,
+        shipFromServicePointId: servicePoint === null || servicePoint === void 0 ? void 0 : servicePoint.servicePointId,
+        validateAddress: "no_validation"
+      });
+      if (label) {
+        yield onLabelCreateSuccess === null || onLabelCreateSuccess === void 0 ? void 0 : onLabelCreateSuccess(label, shipment);
+      } else {
+        yield onLabelCreateFailure === null || onLabelCreateFailure === void 0 ? void 0 : onLabelCreateFailure(rate, shipment);
+      }
+    } catch (e) {
+      yield onLabelCreateFailure === null || onLabelCreateFailure === void 0 ? void 0 : onLabelCreateFailure(rate, shipment);
+    }
+  }), [createLabel, onLabelCreateFailure, onLabelCreateSuccess, printLabelLayout]);
+  const onUpdatedShipment = React.useCallback(shipment => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    yield requestRates(shipment, isInternational);
+    yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(shipment);
+    yield onRateSaved === null || onRateSaved === void 0 ? void 0 : onRateSaved(shipment);
+  }), [isInternational, onRateSaved, onShipmentUpdated, requestRates]);
+  const handleSave = React.useCallback(({
+    carrierId,
+    serviceCode
+  }) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _e, _f;
+    if (!shipment) throw new Error("shipment not found");
+    // clear any errors before attempting to save
+    setBeforeSaveError(undefined);
+    setIsSavingRate(true);
+    try {
+      const beforeSaveResponse = yield onBeforeRateSaved === null || onBeforeRateSaved === void 0 ? void 0 : onBeforeRateSaved(carrierId, serviceCode);
+      let updatedShipment;
+      if (!beforeSaveResponse || Object.keys(beforeSaveResponse).length === 0) {
+        updatedShipment = yield updateShipment(Object.assign(Object.assign({}, shipment), {
+          carrierId,
+          serviceCode,
+          shipDate: date.isNowOrInTheFuture(shipment.shipDate) ? shipment.shipDate : undefined
+        }));
+        if (updatedShipment) {
+          yield onUpdatedShipment(updatedShipment);
+          setIsSavingRate(false);
+        }
+        return;
+      }
+      // The user has selected a house rate that requires some type of set up to happen before saving.
+      // For white label this would be a user has selected a house account UPS ground saver rate and needs to register and
+      // re-rate their shipment to get a real rate. If its successful, we'll save the new rate.
+      if (beforeSaveResponse.error) {
+        resetRates();
+        throw new Error(beforeSaveResponse.error.message);
+      } else if (beforeSaveResponse.data && !beforeSaveResponse.error) {
+        const {
+          carrierId,
+          serviceCode
+        } = beforeSaveResponse.data;
+        updatedShipment = yield updateShipment(Object.assign(Object.assign({}, shipment), {
+          carrierId,
+          serviceCode,
+          shipDate: date.isNowOrInTheFuture(shipment.shipDate) ? shipment.shipDate : undefined
+        }));
+        if (updatedShipment) {
+          yield onUpdatedShipment(updatedShipment);
+          setIsSavingRate(false);
+        }
+        return;
+      }
+    } catch (e) {
+      if (Array.isArray(e)) {
+        if (e[0] instanceof reactApi.SE.CodedError) setBeforeSaveError(e[0]);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_e = e[0].message) !== null && _e !== void 0 ? _e : "An unknown error occurred"
+        });
+      } else {
+        if (e instanceof reactApi.SE.CodedError) setBeforeSaveError(e);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_f = e.message) !== null && _f !== void 0 ? _f : "An unknown error occurred"
+        });
+      }
+      setIsSavingRate(false);
+      return;
+    }
+  }), [onBeforeRateSaved, onUpdatedShipment, resetRates, shipment, updateShipment]);
+  const handleSubmit = React.useCallback((rateId, servicePoint) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _g, _h, _j;
+    setBeforeCreateError(undefined);
+    if (!shipment) return;
+    const preferredRates = preferredRatesResponse === null || preferredRatesResponse === void 0 ? void 0 : preferredRatesResponse.map(r => r.rate);
+    const rate = [...((_g = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates) !== null && _g !== void 0 ? _g : []), ...(preferredRates !== null && preferredRates !== void 0 ? preferredRates : [])].find(r => r.rateId === rateId);
+    if (rate) {
+      try {
+        const beforePurchaseResponse = yield onBeforeLabelCreate === null || onBeforeLabelCreate === void 0 ? void 0 : onBeforeLabelCreate(rate, shipment);
+        if (!beforePurchaseResponse || Object.keys(beforePurchaseResponse).length === 0) {
+          yield purchaseLabel(rateId, shipment, rate, servicePoint);
+          return;
+        }
+        // The user has selected a house rate that requires some type of set up to happen before purchase.
+        // For white label this would be a user has selected a house account UPS ground saver rate and needs to register and
+        // re-rate their shipment to get a real rate. If its successful, we'll purchase a label with the new rate.
+        if (beforePurchaseResponse.error) {
+          resetRates();
+          throw new Error(beforePurchaseResponse.error.message);
+        } else if (beforePurchaseResponse.rate && !beforePurchaseResponse.error) {
+          const _rate = beforePurchaseResponse.rate;
+          const totalRateAmount = rates.getTotalRateAmount(_rate);
+          if (!fundingOrigin) throw new Error("Unable to find balance");
+          if (fundingOrigin.balance < totalRateAmount) {
+            yield handleSave({
+              carrierId: _rate.carrierId,
+              serviceCode: _rate.serviceCode
+            });
+            throw new Error("Insufficient funds. Please add funds before purchasing and try again.");
+          } else {
+            yield purchaseLabel(_rate.rateId, shipment, _rate, servicePoint);
+            return;
+          }
+        }
+      } catch (e) {
+        if (Array.isArray(e)) {
+          if (e[0] instanceof reactApi.SE.CodedError) setBeforeCreateError(e[0]);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_h = e[0].message) !== null && _h !== void 0 ? _h : "An unknown error occurred"
+          });
+        } else {
+          if (e instanceof reactApi.SE.CodedError) setBeforeCreateError(e);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_j = e.message) !== null && _j !== void 0 ? _j : "An unknown error occurred"
+          });
+        }
+        return;
+      }
+    }
+  }), [fundingOrigin, handleSave, onBeforeLabelCreate, preferredRatesResponse, purchaseLabel, ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates, resetRates, shipment]);
+  let errors = [...(ratesErrors !== null && ratesErrors !== void 0 ? ratesErrors : []), ...((_b = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.errors) !== null && _b !== void 0 ? _b : [])];
+  if (beforeCreateError) errors = [...errors, beforeCreateError];
+  if (beforeSaveError) errors = [...errors, beforeSaveError];
+  // Sometimes no rates are returned and no top-level errors are returned
+  // but there are invalid rates with errors. This will filter out duplicate error messages and expose those to the user
+  // so the rate list isn't empty after calculating rates.
+  if (!errors.length) {
+    const uniqueMessages = new Set(ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.invalidRates.flatMap(r => r.errorMessages));
+    errors = (_c = [...uniqueMessages].map(m => ({
+      errorCode: "unknown",
+      errorSource: "shipengine",
+      errorType: "unknown",
+      message: m,
+      name: "CodedError"
+    }))) !== null && _c !== void 0 ? _c : [];
+  }
+  const displayableRateErrors = useScrubErrors.useScrubErrors({
+    errors: errors,
+    predicate: React.useCallback(e => e.message.includes("No rates are available for service_codes"), []),
+    scrubber: React.useCallback(() => "common:errorMessages.noRatesAvailable", [])
+  });
+  const displayableLabelErrors = useScrubErrors.useScrubErrors({
+    errors: labelErrors !== null && labelErrors !== void 0 ? labelErrors : undefined,
+    scrubber: React.useCallback(e => {
+      if (e.message.includes("The ship from email is required") || e.message.includes("The ship to email is required")) return "common:errorMessages.emailIsRequired";
+      return e.message.replace(/Exception with code \w+; module \d+, category \d+, item \d+/g, "");
+    }, [])
+  });
+  return {
+    carriers,
+    displayableRateErrors,
+    errors: errors.length > 0 ? errors : undefined,
+    fetchServicePoints,
+    fundingOrigin,
+    isCalculatingRates: ratesCalculating,
+    isSavingRate,
+    labelErrors: displayableLabelErrors,
+    labels,
+    labelsLoading,
+    listServicePointsErrors,
+    onSave: handleSave,
+    onSubmit: handleSubmit,
+    preferredRates: preferredRatesResponse,
+    rates: ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates,
+    requestRates,
+    resetLabel,
+    resetRates,
+    servicePointSearchQuery,
+    servicePointsFetching,
+    servicePointsResponse,
+    shipment,
+    showVatFeatures: isVatRequiredCountry
+  };
+};
+
+exports.useRatesForm = useRatesForm;

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

@@ -0,0 +1,103 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var useShipmentMetadata = require('../../../hooks/options/use-shipment-metadata.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var useRequestRates = require('./use-request-rates.cjs');
+
+/**
+ * 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
+}) => {
+  const shouldFetchCachedRates = React.useMemo(() => {
+    return !!(shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId) && (!!(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));
+  }, [shipment]);
+  const [cachedRatesEnabled, setCachedRatesEnabled] = React.useState(shouldFetchCachedRates);
+  const {
+    isInternational
+  } = useShipmentMetadata.useShipmentMetadata(shipment);
+  const {
+    data: cachedRatesResponse,
+    isFetching: cachedRatesFetching,
+    status: cachedRatesStatus
+  } = reactApi.useGetShipmentRates({
+    enabled: cachedRatesEnabled,
+    queryFnParams: {
+      shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
+    }
+  });
+  const {
+    isCalculating,
+    preferredRatesResponse: preferredRates,
+    ratesErrors,
+    ratesResponse: standardRequestedRateResponse,
+    requestPreferredRates,
+    requestRates,
+    resetRates
+  } = useRequestRates.useRequestRates({
+    disabledShippingServices,
+    getPreferredRates,
+    onRatesCalculated
+  });
+  const hasCachedRates = React.useMemo(() => {
+    return cachedRatesResponse && cachedRatesResponse.length > 0 && cachedRatesResponse[0].rates.length > 0;
+  }, [cachedRatesResponse]);
+  const cachedRates = cachedRatesResponse ? cachedRatesResponse[0] : undefined;
+  const enableCache = React.useCallback(() => {
+    setCachedRatesEnabled(true);
+  }, []);
+  const disableCache = React.useCallback(() => {
+    setCachedRatesEnabled(false);
+  }, []);
+  React.useEffect(() => {
+    var _a, _b;
+    // Handle preferred rates
+    if (getPreferredRates !== undefined && hasCachedRates && shipment && isInternational !== undefined) {
+      void requestPreferredRates([shipment, isInternational]);
+    }
+    // determine if the cached rates are valid for the current shipment by comparing the service code and carrier id
+    if (hasCachedRates && (shipment === null || shipment === void 0 ? void 0 : shipment.serviceCode) && (shipment === null || shipment === void 0 ? void 0 : shipment.carrierId)) {
+      const {
+        serviceCode: cachedRateServiceCode,
+        carrierId: cachedRateCarrierId
+      } = (_b = (_a = cachedRates === null || cachedRates === void 0 ? void 0 : cachedRates.rates) === null || _a === void 0 ? void 0 : _a[0]) !== null && _b !== void 0 ? _b : {};
+      const ratesMatch = shipment.serviceCode === cachedRateServiceCode && shipment.carrierId === cachedRateCarrierId;
+      // enable or disable the cache based on whether the rates match
+      ratesMatch ? enableCache() : disableCache();
+    }
+  }, [requestPreferredRates, isInternational, shipment, getPreferredRates, hasCachedRates, cachedRates === null || cachedRates === void 0 ? void 0 : cachedRates.rates, shipment === null || shipment === void 0 ? void 0 : shipment.carrierId, shipment === null || shipment === void 0 ? void 0 : shipment.serviceCode, enableCache, disableCache]);
+  const resetAllRates = React.useCallback(() => {
+    resetRates();
+    // Clear the cached rates by disabling cache and forcing a refetch
+    setCachedRatesEnabled(false);
+  }, [resetRates]);
+  const ratesCalculating = React.useMemo(() => {
+    return isCalculating || cachedRatesFetching;
+  }, [isCalculating, cachedRatesFetching]);
+  const ratesResponse = cachedRatesEnabled ? cachedRates : 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 = cachedRatesStatus === "success" && hasCachedRates && (shipment === null || shipment === void 0 ? void 0 : shipment.carrierId) ? undefined : preferredRates;
+  return {
+    preferredRatesResponse,
+    ratesCalculating,
+    ratesErrors,
+    ratesResponse,
+    requestRates,
+    resetRates: resetAllRates
+  };
+};
+
+exports.useRatesWithCache = useRatesWithCache;

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

@@ -0,0 +1,21 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var reactQuery = require('@tanstack/react-query');
+
+const useRequestPreferredRates = ({
+  getPreferredRates
+}) => {
+  return reactQuery.useMutation({
+    mutationFn: ([shipment, isInternational]) => tslib.__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)
+  });
+};
+
+exports.useRequestPreferredRates = useRequestPreferredRates;

package/cjs/elements/purchase-label/hooks/use-request-rates.cjs

@@ -0,0 +1,125 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var date = require('../../../utilities/date.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var rateMessages = require('../../../data/rate-messages.cjs');
+var useRequestPreferredRates = require('./use-request-preferred-rates.cjs');
+var utils = require('../../../utilities/feature-flags/utils.cjs');
+
+const useRequestRates = ({
+  disabledShippingServices,
+  onRatesCalculated,
+  getPreferredRates
+}) => {
+  const {
+    data: carriers
+  } = reactApi.useListCarriers();
+  const {
+    data: customPackageTypes
+  } = reactApi.useListCustomPackageTypes();
+  const {
+    data: ratedShipment,
+    error: ratesErrors,
+    isLoading: standardRatesCalculating,
+    reset: resetStandardRates,
+    mutateAsync: calculateRates
+  } = reactApi.useCalculateRates();
+  const {
+    data: preferredResponse,
+    isLoading: preferredRatesCalculating,
+    reset: resetPreferredRates,
+    mutateAsync: requestPreferredRates
+  } = useRequestPreferredRates.useRequestPreferredRates({
+    getPreferredRates
+  });
+  const requestRates = React.useCallback((shipment, isInternational) => tslib.__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 = React.useCallback(() => {
+    resetPreferredRates();
+    resetStandardRates();
+  }, [resetPreferredRates, resetStandardRates]);
+  let ratesResponse = ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.rateResponse;
+  // Remove rates for disabled shipping services
+  ratesResponse = React.useMemo(() => ratesResponse && Object.assign(Object.assign({}, ratesResponse), {
+    rates: ratesResponse.rates.filter(rate => !utils.isShippingServiceServiceDisabled(rate, disabledShippingServices))
+  }), [disabledShippingServices, ratesResponse]);
+  const shipDay = React.useMemo(() => {
+    if (ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.shipDate) {
+      return date.omitTime(ratedShipment === null || ratedShipment === void 0 ? void 0 : ratedShipment.shipDate).toLocaleString("en-us", {
+        weekday: "long"
+      });
+    }
+    return;
+  }, [ratedShipment]);
+  const ratesCalculating = getPreferredRates ? preferredRatesCalculating || standardRatesCalculating : standardRatesCalculating;
+  ratesResponse = React.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["default"][`${rate.serviceCode}:${shipDay}`]) !== null && _a !== void 0 ? _a : []), ...((_b = rateMessages["default"][`${rate.serviceCode}:${rate.packageType}`]) !== null && _b !== void 0 ? _b : []), ...((_c = rateMessages["default"][rate.serviceCode]) !== null && _c !== void 0 ? _c : []), ...rate.warningMessages]
+      });
+    })
+  }), [ratesResponse, shipDay]);
+  const preferredRatesResponse = React.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["default"][`${r.rate.serviceCode}:${shipDay}`]) !== null && _a !== void 0 ? _a : []), ...((_b = rateMessages["default"][`${r.rate.serviceCode}:${r.rate.packageType}`]) !== null && _b !== void 0 ? _b : []), ...((_c = rateMessages["default"][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
+  };
+};
+
+exports.useRequestRates = useRequestRates;

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

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var useServiceCodeOptions = require('./use-service-code-options.cjs');
+
+
+
+exports.useServiceCodeOptions = useServiceCodeOptions.useServiceCodeOptions;

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

@@ -0,0 +1,52 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var formatCarrierLabel = require('../../../../hooks/options/format-carrier-label.cjs');
+var useShipmentMetadata = require('../../../../hooks/options/use-shipment-metadata.cjs');
+var carrier = require('../../../../utilities/shipengine/carrier.cjs');
+var orderBy = require('lodash/orderBy.js');
+var React = require('react');
+var utils = require('../../../../utilities/feature-flags/utils.cjs');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var orderBy__default = /*#__PURE__*/_interopDefaultLegacy(orderBy);
+
+/**
+ * @internal
+ *
+ * # Service Code Options Hook
+ *
+ * @category Hooks
+ */
+const useServiceCodeOptions = (carriers, shipment, disabledShippingServices) => {
+  const {
+    isInternational,
+    isPoBox,
+    isUnsupportedUpsCountry
+  } = useShipmentMetadata.useShipmentMetadata(shipment);
+  return React.useMemo(() => {
+    return (carriers !== null && carriers !== void 0 ? carriers : []).reduce((options, carrier$1) => {
+      // Filter out non-USPS service for PO Box shipments
+      // Filter out UPS service for unsupported countries
+      if (!carrier.isUspsCarrier(carrier$1.carrierCode) && isPoBox || carrier.isUpsCarrier(carrier$1.carrierCode) && isUnsupportedUpsCountry) return options;
+      const services = carrier$1.services.filter(s => s.domestic === !isInternational && !utils.isShippingServiceServiceDisabled(s, disabledShippingServices));
+      if (services.length === 0) return options;
+      const sortedServices = orderBy__default["default"](services, "name", "asc");
+      return [...options, {
+        label: formatCarrierLabel.formatCarrierLabel(carriers || [], carrier$1),
+        options: sortedServices.map(s => ({
+          label: s.name,
+          value: {
+            carrierId: carrier$1.carrierId,
+            serviceCode: s.serviceCode
+          }
+        })),
+        value: carrier$1.carrierId
+      }];
+    }, []);
+  }, [carriers, isPoBox, isUnsupportedUpsCountry, isInternational, disabledShippingServices]);
+};
+
+exports.useServiceCodeOptions = useServiceCodeOptions;

package/cjs/elements/purchase-label/hooks/use-service-points.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var pudo = require('../../../utilities/pudo.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+
+const useServicePoints = (rates, shipment) => {
+  var _a;
+  const [servicePointSearchQuery, setServicePointSearchQuery] = React.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 = React.useMemo(() => ({
+    addressQuery: servicePointSearchQuery,
+    maxResults: 50,
+    providers: []
+  }), [servicePointSearchQuery]);
+  const servicePointOptions = React.useMemo(() => {
+    const pudoRates = (rates === null || rates === void 0 ? void 0 : rates.filter(rate => pudo.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] = React.useState();
+  //useListServicePoints is not enabled until options.providers.length > 0, once providers are loaded, update listServicePointsOptions for use as options in useListServicePoints
+  React.useEffect(() => {
+    if (servicePointOptions.providers.length > 0) {
+      setListServicePointsOptions(servicePointOptions);
+    }
+  }, [servicePointOptions]);
+  const {
+    data: servicePoints,
+    isFetching: servicePointsFetching,
+    error: listServicePointsErrors
+  } = reactApi.useListServicePoints(listServicePointsOptions !== null && listServicePointsOptions !== void 0 ? listServicePointsOptions : baseOptions);
+  const fetchServicePoints = React.useCallback(searchQuery => {
+    setServicePointSearchQuery(searchQuery);
+  }, []);
+  return {
+    fetchServicePoints,
+    listServicePointsErrors,
+    nestedServicePointErrors: servicePoints === null || servicePoints === void 0 ? void 0 : servicePoints.errors,
+    servicePointSearchQuery,
+    servicePointsFetching,
+    servicePointsResponse: servicePoints
+  };
+};
+
+exports.useServicePoints = useServicePoints;