@shipengine/elements 2.20.0 → 2.22.0

package/cjs/hooks/use-address-validation.cjs

@@ -0,0 +1,108 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var address = require('../utilities/shipengine/address.cjs');
+var isEqual = require('lodash/isEqual.js');
+var omit = require('lodash/omit.js');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
+var omit__default = /*#__PURE__*/_interopDefaultLegacy(omit);
+
+/**
+ * @internal
+ *
+ * # Address Validation Hook
+ *
+ * @cateogry Hooks
+ */
+const useAddressValidation = () => {
+  const [validationPreference, setValidationPreference] = React.useState();
+  const {
+    error: validateAddressErrors,
+    mutateAsync: validateAddresses
+  } = reactApi.useValidateAddresses();
+  const caseInsensitiveCompare = React.useCallback((matched, original) => {
+    if (matched === undefined || original === undefined) return false;
+    const originalAddress = Object.fromEntries(Object.entries(original).map(([key, value]) => [key, typeof value == "string" ? value.toLowerCase() : value]));
+    const matchedAddress = Object.fromEntries(Object.entries(matched).map(([key, value]) => [key, typeof value == "string" ? value.toLowerCase() : value]));
+    // SE api returns addressLine2 as an empty string if it is not provided
+    if (matchedAddress.addressLine2 === "") {
+      matchedAddress.addressLine2 = null;
+    }
+    if (isEqual__default["default"](omit__default["default"](matchedAddress, ["postalCode", "addressResidentialIndicator"]), omit__default["default"](originalAddress, ["postalCode", "addressResidentialIndicator"]))) return true;else return false;
+  }, []);
+  const postalCodeCompare = React.useCallback((matched, original) => {
+    if (matched === undefined || original === undefined) return false;
+    if (matched === original) return true;
+    return matched.includes(original);
+  }, []);
+  const buildAddressValidationPreference = React.useCallback(addressValidation => {
+    /**
+     * Address validation matching criteria
+     * 1. Case-insensitive string comparison
+     * 2. Zip Code only added 4 extra digits to the original Zip Code
+     */
+    var _a;
+    if (addressValidation.status === "error") {
+      return {
+        validation: addressValidation,
+        validationType: "ERROR"
+      };
+    }
+    //  Valid if the matched address and input address were EXACTLY the same
+    if (addressValidation.matchedAddress && addressValidation.matchedAddress.name === addressValidation.originalAddress.name && addressValidation.matchedAddress.companyName === addressValidation.originalAddress.companyName && addressValidation.matchedAddress.addressLine1 === addressValidation.originalAddress.addressLine1 && addressValidation.matchedAddress.addressLine2 === addressValidation.originalAddress.addressLine2 && addressValidation.matchedAddress.cityLocality === addressValidation.originalAddress.cityLocality && addressValidation.matchedAddress.stateProvince === addressValidation.originalAddress.stateProvince && addressValidation.matchedAddress.postalCode === addressValidation.originalAddress.postalCode && addressValidation.matchedAddress.countryCode === addressValidation.originalAddress.countryCode) {
+      return {
+        address: addressValidation.originalAddress,
+        validationType: "EXACT"
+      };
+    }
+    // Valid if the matched address passes matching criteria but are not exactly the same address
+    if (addressValidation.matchedAddress && caseInsensitiveCompare(addressValidation.matchedAddress, addressValidation.originalAddress) && postalCodeCompare((_a = addressValidation.matchedAddress) === null || _a === void 0 ? void 0 : _a.postalCode, addressValidation.originalAddress.postalCode)) {
+      return {
+        address: addressValidation.matchedAddress,
+        validationType: "SOFT"
+      };
+    }
+    // If there is a matched address and does not pass the matching criteria
+    if (addressValidation.matchedAddress) {
+      return {
+        validation: addressValidation,
+        validationType: "SUGGESTED"
+      };
+    }
+    // error or address was not valiqated
+    return {
+      validation: addressValidation,
+      validationType: "ERROR"
+    };
+  }, [caseInsensitiveCompare, postalCodeCompare]);
+  const validate = React.useCallback(addresses => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const result = yield validateAddresses([addresses.originAddress, ...(addresses.returnAddress ? [addresses.returnAddress] : [])]);
+    const [originAddress, returnAddress] = result;
+    const originAddressPreference = buildAddressValidationPreference(address.addEmailToValidation(originAddress, addresses.originAddress.email));
+    const returnAddressPreference = returnAddress && buildAddressValidationPreference(address.addEmailToValidation(returnAddress, (_a = addresses.returnAddress) === null || _a === void 0 ? void 0 : _a.email));
+    setValidationPreference({
+      originAddress: originAddressPreference,
+      returnAddress: returnAddressPreference
+    });
+    return {
+      originAddress: originAddressPreference,
+      returnAddress: returnAddressPreference
+    };
+  }), [buildAddressValidationPreference, validateAddresses]);
+  return {
+    errors: validateAddressErrors,
+    setValidationPreference,
+    validate,
+    validationPreference
+  };
+};
+
+exports.useAddressValidation = useAddressValidation;

package/cjs/hooks/use-balance-services.cjs

@@ -0,0 +1,145 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var money = require('../utilities/money.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+
+/**
+ * The `useBalanceServices` hook retrieves and manages balance information for a carrier or funding source. If a funding source cannot be found, the hook will default to using the carrier balance associated with the provided `carrierId` as the primary source of truth.
+ *
+ * @returns `UseBalanceServicesReturnType`
+ */
+const useBalanceServices = ({
+  carrierId,
+  fundingSourceId
+}) => {
+  const {
+    mutateAsync: addFSFundsMutation,
+    error: addFSFundsErrors,
+    reset: resetFSAddFunds
+  } = reactApi.useFundingSourcesAddFunds();
+  const {
+    error: addCarrierFundsErrors,
+    mutateAsync: addCarrierFundsMutation,
+    reset: resetCarrierAddfunds
+  } = reactApi.useAddFunds();
+  const {
+    data: carriersData,
+    error: carriersErrors,
+    isInitialLoading: isInitialLoadingCarriers
+  } = reactApi.useListCarriers();
+  const {
+    data: fundingSources,
+    error: fundingSourcesErrors,
+    isInitialLoading: isFundingSourceInitialLoading
+  } = reactApi.useListFundingSources();
+  const [fundingOriginError, setFundingOriginError] = React.useState(null);
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  //@ts-ignore
+  const fundingOrigin = React.useMemo(() => {
+    let fundingSource;
+    let walletedCarrier;
+    // If a funding source ID is provided, prioritize that as the origin.
+    if (fundingSourceId) {
+      fundingSource = fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.find(source => source.fundingSourceId === fundingSourceId);
+    }
+    // If a carrier ID is provided, see if it has a funding source,
+    // otherwise use that carrier as the origin.
+    if (carrierId) {
+      const carrier = carriersData === null || carriersData === void 0 ? void 0 : carriersData.find(carrier => carrier.carrierId === carrierId);
+      // Use the carrier's funding source if available.
+      if (!fundingSource && (carrier === null || carrier === void 0 ? void 0 : carrier.fundingSourceId)) {
+        fundingSource = fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.find(source => source.fundingSourceId === (carrier === null || carrier === void 0 ? void 0 : carrier.fundingSourceId));
+      }
+      // Use the carrier itself if it's walleted
+      if (carrier && carrier.requiresFundedAmount) {
+        walletedCarrier = carrier;
+      }
+    }
+    // Otherwise, use the first available funding source or carrier balance.
+    if (!fundingSource && !walletedCarrier) {
+      if (!fundingSource && (fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.length)) {
+        fundingSource = fundingSources[0];
+      }
+      if (!walletedCarrier && (carriersData === null || carriersData === void 0 ? void 0 : carriersData.length)) {
+        walletedCarrier = carriersData.find(carrier => carrier.requiresFundedAmount);
+      }
+    }
+    // If we found a funding source, use that as funding origin.
+    if (fundingSource) {
+      return {
+        balance: fundingSource.balance,
+        currency: money.getCurrencyFromString(fundingSource.currencyCode),
+        id: fundingSource.fundingSourceId,
+        originType: "fundingSource"
+      };
+    }
+    // Otherwise, use walleted carrier as funding origin.
+    if (walletedCarrier) {
+      return {
+        balance: walletedCarrier.balance,
+        currency: reactApi.SE.Currency.USD,
+        id: walletedCarrier.carrierId,
+        originType: "carrier"
+      };
+    }
+  }, [carriersData, fundingSources, fundingSourceId, carrierId]);
+  const addFundsMutation = React.useCallback(funds => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    try {
+      if (!fundingOrigin) throw new reactApi.CodedError("No funding origin", {
+        errorCode: "invalid_status",
+        errorSource: "elements",
+        errorType: "business_rules"
+      });
+      if (fundingOrigin.originType === "carrier") {
+        yield addCarrierFundsMutation({
+          carrierId: fundingOrigin.id,
+          funds
+        });
+      } else {
+        yield addFSFundsMutation({
+          fundingSourceId: fundingOrigin.id,
+          funds: funds
+        });
+      }
+    } catch (error) {
+      // If the error was already set, we do not want to set it again.
+      if (fundingOriginError === null && error instanceof reactApi.CodedError) {
+        setFundingOriginError(error);
+      }
+    }
+  }), [addCarrierFundsMutation, addFSFundsMutation, fundingOrigin, fundingOriginError]);
+  const resetAddFundsMutationState = React.useCallback(() => {
+    resetCarrierAddfunds();
+    resetFSAddFunds();
+    setFundingOriginError(null);
+  }, [resetCarrierAddfunds, resetFSAddFunds]);
+  const isLoadingBalance = React.useMemo(() => isInitialLoadingCarriers || isFundingSourceInitialLoading, [isInitialLoadingCarriers, isFundingSourceInitialLoading]);
+  const fetchBalanceErrors = React.useMemo(() => {
+    if (!fundingSourcesErrors && !carriersErrors) {
+      return undefined;
+    }
+    return [...(fundingSourcesErrors !== null && fundingSourcesErrors !== void 0 ? fundingSourcesErrors : []), ...(carriersErrors !== null && carriersErrors !== void 0 ? carriersErrors : [])];
+  }, [carriersErrors, fundingSourcesErrors]);
+  const addFundsErrors = React.useMemo(() => {
+    if (!addCarrierFundsErrors && !addFSFundsErrors && !fundingOriginError) {
+      return undefined;
+    }
+    return [...(addCarrierFundsErrors !== null && addCarrierFundsErrors !== void 0 ? addCarrierFundsErrors : []), ...(addFSFundsErrors !== null && addFSFundsErrors !== void 0 ? addFSFundsErrors : []), ...(fundingOriginError ? [fundingOriginError] : [])];
+  }, [addCarrierFundsErrors, addFSFundsErrors, fundingOriginError]);
+  return {
+    addFundsMutation,
+    errors: {
+      addFundsErrors,
+      fetchBalanceErrors
+    },
+    fundingOrigin,
+    isLoadingBalance,
+    resetAddFundsMutationState
+  };
+};
+
+exports.useBalanceServices = useBalanceServices;

package/cjs/hooks/use-black-box-detection.cjs

@@ -0,0 +1,69 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+
+/*
+ * ****** WARNING *******
+ * This hook was designed with the intention of only being used within the onboarding flow during carrier registration and carrier recovery and as such is not intended to be used elsewhere.
+ * There is a chance that more than one script will be mounted if this hook is used elsewhere.
+ */
+/**
+ * @internal
+ *
+ * - Creates an encoded device fingerprint string - aka black box - containing information about the end-user's computing device such as OS, browser, etc.
+ * https://developer.bazaarvoice.com/conversations-api/deprecations/iovation-web#snare_js_only
+ */
+const useBlackboxDetection = ({
+  onSuccess,
+  onError
+}) => {
+  React.useEffect(() => {
+    // basic configurations must be on page before snare.js is loaded
+    window.io_install_stm = false; // do not install Active X
+    window.io_exclude_stm = 12; // do not run Active X
+    window.io_install_flash = false; // do not install Flash
+    window.io_enable_rip = true; // collect Real IP information
+    const pollBlackBox = () => {
+      try {
+        if (typeof ioGetBlackbox !== "function") {
+          return;
+        }
+        // eslint-disable-next-line
+        const blackboxInfo = ioGetBlackbox();
+        // Each call to ioGetBlackbox() returns a JavaScript object with information about the current state of the black box and eventually the black box string itself
+        if (blackboxInfo.finished) {
+          clearTimeout(intervalId);
+          onSuccess(blackboxInfo.blackbox);
+        }
+      } catch (_e) {
+        onError();
+      }
+    };
+    const intervalId = setInterval(pollBlackBox, 500);
+    // attach script to DOM
+    const script = document.createElement("script");
+    script.type = "text/javascript";
+    script.async = true;
+    script.src = "https://mpsnare.iesnare.com/snare.js";
+    script.addEventListener("error", _e => {
+      if (typeof ioGetBlackbox !== "function") {
+        onError();
+      }
+    });
+    document.head.appendChild(script);
+    return () => {
+      if (intervalId) {
+        clearTimeout(intervalId);
+      }
+      delete window.io_install_stm;
+      delete window.io_exclude_stm;
+      delete window.io_install_flash;
+      delete window.io_enable_rip;
+      document.head.removeChild(script);
+    };
+  }, [onSuccess, onError]);
+};
+
+exports.useBlackboxDetection = useBlackboxDetection;

package/cjs/hooks/use-configure-shipment.cjs

@@ -0,0 +1,237 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var reactQuery = require('@tanstack/react-query');
+var address = require('../utilities/shipengine/address.cjs');
+var salesOrder = require('../utilities/shipengine/sales-order.cjs');
+var shipment = require('../utilities/shipengine/shipment.cjs');
+var warehouses = require('../utilities/shipengine/warehouses.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var useImportSalesOrder = require('./use-import-sales-order.cjs');
+
+const useConfigureShipment = ({
+  onShipmentUpdated,
+  onLoad,
+  errorWhenShipmentCancelled: _errorWhenShipmentCancelled = false,
+  externalOrderId,
+  externalOrderNumber,
+  externalShipmentId,
+  orderSourceCode,
+  salesOrderId,
+  shipFromAddresses,
+  shipmentId,
+  warehouseId,
+  useWarehouses: _useWarehouses = true
+}) => {
+  const queryClient = reactQuery.useQueryClient();
+  // Queue of incomplete requirement keys (i.e., Ship From addresses, Warehouses, Carriers)
+  const incompleteRequirementsKeys = React.useMemo(() => [], []);
+  const {
+    data: carriers,
+    isInitialLoading: isInitialLoadingCarriers,
+    isFetching: isFetchingCarriers
+  } = reactApi.useListCarriers();
+  const {
+    data: warehouses$1,
+    error: listWarehouseErrors,
+    isInitialLoading: isInitialLoadingWarehouses,
+    isFetching: isFetchingWarehouses
+  } = reactApi.useListWarehouses({
+    enabled: _useWarehouses
+  });
+  const {
+    salesOrder: salesOrder$1,
+    errors: importSalesOrderErrors,
+    isLoading: isSalesOrderLoading
+  } = useImportSalesOrder.useImportSalesOrder({
+    // Dont run Sales Order Import unless the Sales order info is present
+    enabled: !!externalOrderNumber || !!orderSourceCode || !!salesOrderId || !!externalOrderId,
+    externalOrderId,
+    externalOrderNumber,
+    orderSourceCode,
+    salesOrderId
+  });
+  const {
+    error: updateShipmentErrors,
+    mutate: updateShipment
+  } = reactApi.useUpdateSalesOrderShipment();
+  const {
+    data: newV1Shipment,
+    mutateAsync: createV1Shipment,
+    isLoading: creatingV1Shipment,
+    isSuccess: v1shipmentCreated,
+    error: createV1ShipmentErrors
+  } = reactApi.useCreateShipment();
+  const {
+    data: externalShipment,
+    error: getExternalShipmentErrors,
+    isInitialLoading: isExternalShipmentInitialLoading,
+    isFetching: isExternalShipmentFetching
+  } = reactApi.useGetShipmentByExternalId({
+    enabled: !!externalShipmentId && !shipmentId,
+    queryFnParams: {
+      externalId: externalShipmentId !== null && externalShipmentId !== void 0 ? externalShipmentId : ""
+    }
+  });
+  const {
+    data: salesOrderShipments,
+    error: listSalesOrderShipmentsErrors,
+    refetch: refetchSalesOrderShipments,
+    isInitialLoading: listSalesOrderShipmentsInitiallyLoading,
+    isFetching: listSalesOrderShipmentsIsFetching
+  } = reactApi.useListSalesOrderShipments({
+    externalOrderIds: externalOrderId ? [externalOrderId] : undefined,
+    salesOrderIds: salesOrderId ? [salesOrderId] : salesOrder$1 ? [salesOrder$1.salesOrderId]
+    // TODO: current workaround - revert to being undefined rather than empty list
+    : [],
+    shipmentIds: shipmentId ? [shipmentId] : externalShipment ? [externalShipment.shipmentId] : newV1Shipment ? [newV1Shipment.shipments[0].shipmentId] : undefined
+  });
+  const {
+    error: createSalesOrderShipmentErrors,
+    mutateAsync: createSalesOrderShipment,
+    isLoading: creatingSalesOrderShipment,
+    isSuccess: salesOrderShipmentCreated
+  } = reactApi.useCreateSalesOrderShipment();
+  const pendingSalesOrderShipment = shipment.getShipmentByStatus("pending", salesOrderShipments);
+  const labelPurchasedSalesOrderShipment = shipment.getShipmentByStatus("label_purchased", salesOrderShipments);
+  const cancelledShipment = shipment.getShipmentByStatus("cancelled", salesOrderShipments);
+  const defaultWarehouse = warehouses.getDefaultWarehouse(warehouses$1);
+  const defaultShipFromAddress = address.getDefaultShipFromAddress(shipFromAddresses);
+  // Handles the creation of new shipments for the sales order flow and one-off flow
+  const handleShipmentCreation = React.useCallback(() => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    if (listSalesOrderShipmentsInitiallyLoading || listSalesOrderShipmentsIsFetching || isExternalShipmentFetching || isExternalShipmentInitialLoading || creatingSalesOrderShipment || salesOrderShipmentCreated || creatingV1Shipment || v1shipmentCreated || isInitialLoadingWarehouses || isFetchingWarehouses || !!pendingSalesOrderShipment || !!labelPurchasedSalesOrderShipment) {
+      return;
+    }
+    const isMissingShipFrom = !(shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.length);
+    const isMissingWarehouse = !(warehouses$1 === null || warehouses$1 === void 0 ? void 0 : warehouses$1.length);
+    const isMissingWarehouseId = !warehouseId;
+    // Check if warehouses are disabled and if shipFrom addresses are available to create a shipment.
+    if (!_useWarehouses && isMissingShipFrom) {
+      incompleteRequirementsKeys.push("no_warehouses");
+      return;
+      // If warehouses are enabled then we need to check all of the availible address sources
+    } else if (isMissingShipFrom && isMissingWarehouse && isMissingWarehouseId) {
+      incompleteRequirementsKeys.push("no_warehouses");
+      return;
+    }
+    // Create a shipment using a Sales Order
+    if (salesOrder$1) {
+      const originAddress = (_c = (_a = defaultShipFromAddress === null || defaultShipFromAddress === void 0 ? void 0 : defaultShipFromAddress.originAddress) !== null && _a !== void 0 ? _a : (_b = warehouses.getWarehouseById(warehouseId, warehouses$1)) === null || _b === void 0 ? void 0 : _b.originAddress) !== null && _c !== void 0 ? _c : defaultWarehouse === null || defaultWarehouse === void 0 ? void 0 : defaultWarehouse.originAddress;
+      const isCustomsRequired = salesOrder.getIsCustomsRequiredForSalesOrder(salesOrder$1, originAddress);
+      // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+      const customsFromSalesOrder = salesOrder.getCustomsFromSalesOrder(salesOrder$1, originAddress);
+      const salesOrderShipment = yield createSalesOrderShipment(Object.assign(Object.assign(Object.assign({
+        salesOrderId: salesOrder$1.salesOrderId
+      }, (defaultShipFromAddress === null || defaultShipFromAddress === void 0 ? void 0 : defaultShipFromAddress.originAddress) ? {
+        shipFrom: defaultShipFromAddress.originAddress
+      } : {
+        warehouseId: warehouseId ? warehouseId : defaultWarehouse === null || defaultWarehouse === void 0 ? void 0 : defaultWarehouse.warehouseId
+      }), isCustomsRequired && {
+        customs: customsFromSalesOrder.customs
+      }), {
+        packages: [Object.assign(Object.assign({
+          packageCode: "package"
+        }, isCustomsRequired && {
+          products: customsFromSalesOrder.products
+        }), {
+          weight: {
+            unit: "pound",
+            value: 0
+          }
+        })]
+      }));
+      if (salesOrderShipment) {
+        yield refetchSalesOrderShipments();
+      }
+    }
+    // Create a Shipment for one-off flow
+    if (!salesOrderId && !externalOrderId && !externalOrderNumber && !orderSourceCode && !shipmentId && !externalShipmentId) {
+      const v1Shipment = yield createV1Shipment(Object.assign({}, (defaultShipFromAddress === null || defaultShipFromAddress === void 0 ? void 0 : defaultShipFromAddress.originAddress) ? {
+        shipFrom: defaultShipFromAddress.originAddress
+      } : {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        warehouseId: warehouseId ? warehouseId : defaultWarehouse.warehouseId
+      }));
+      if (v1Shipment) {
+        yield refetchSalesOrderShipments();
+      }
+    }
+  }), [createSalesOrderShipment, createV1Shipment, creatingSalesOrderShipment, creatingV1Shipment, defaultShipFromAddress, defaultWarehouse, externalOrderId, externalOrderNumber, externalShipmentId, incompleteRequirementsKeys, isExternalShipmentFetching, isExternalShipmentInitialLoading, isFetchingWarehouses, isInitialLoadingWarehouses, labelPurchasedSalesOrderShipment, listSalesOrderShipmentsInitiallyLoading, listSalesOrderShipmentsIsFetching, orderSourceCode, pendingSalesOrderShipment, refetchSalesOrderShipments, salesOrder$1, salesOrderId, salesOrderShipmentCreated, shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.length, shipmentId, _useWarehouses, v1shipmentCreated, warehouseId, warehouses$1]);
+  /**
+   * Update a shipment with deprecated customs items. Move items to the products array on the Shipment's packages array
+   *
+   * Invalidate useGetShipment's cache
+   */
+  const formatCustoms = React.useCallback(shipment$1 => {
+    const formattedShipment = shipment.moveCustomsItemsToProducts(shipment$1);
+    updateShipment(formattedShipment, {
+      onSuccess(data) {
+        void (onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(data));
+        void queryClient.invalidateQueries(["useListSalesOrderShipments", {
+          shipmentId: data.shipmentId
+        }], {
+          exact: false
+        } // Invalidate queries with similar keys
+        );
+      }
+    });
+  }, [onShipmentUpdated, queryClient, updateShipment]);
+  const refetchPendingSalesOrderShipments = React.useCallback(() => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    const {
+      data: shipments
+    } = yield refetchSalesOrderShipments();
+    return shipment.getShipmentByStatus("pending", shipments);
+  }), [refetchSalesOrderShipments]);
+  // useEffect to handle creating new shipments
+  React.useEffect(() => {
+    void (() => tslib.__awaiter(void 0, void 0, void 0, function* () {
+      yield handleShipmentCreation();
+    }))();
+  }, [shipmentId, externalShipmentId, salesOrderId, salesOrder$1, warehouses$1, warehouseId, handleShipmentCreation]);
+  // useEffect to handle formating customs
+  React.useEffect(() => {
+    var _a, _b;
+    if ((_b = (_a = pendingSalesOrderShipment === null || pendingSalesOrderShipment === void 0 ? void 0 : pendingSalesOrderShipment.customs) === null || _a === void 0 ? void 0 : _a.customsItems) === null || _b === void 0 ? void 0 : _b.length) {
+      formatCustoms(pendingSalesOrderShipment);
+    }
+  }, [formatCustoms, pendingSalesOrderShipment]);
+  // useEffect to check and run the onLoad prop
+  React.useEffect(() => {
+    if ((salesOrderShipments === null || salesOrderShipments === void 0 ? void 0 : salesOrderShipments.length) && salesOrderShipments.every(s => s.shipmentStatus === "label_purchased")) {
+      void (onLoad === null || onLoad === void 0 ? void 0 : onLoad(salesOrderShipments, salesOrder$1, pendingSalesOrderShipment));
+    }
+  }, [onLoad, pendingSalesOrderShipment, salesOrder$1, salesOrderShipments]);
+  // useEffect to validate the Seller has carriers accounts connected.
+  React.useEffect(() => {
+    if (isInitialLoadingCarriers || isFetchingCarriers) return;
+    if ((carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0) incompleteRequirementsKeys.push("no_carriers");
+  }, [carriers, incompleteRequirementsKeys, isFetchingCarriers, isInitialLoadingCarriers]);
+  const errors = [...(listWarehouseErrors !== null && listWarehouseErrors !== void 0 ? listWarehouseErrors : []), ...(createSalesOrderShipmentErrors !== null && createSalesOrderShipmentErrors !== void 0 ? createSalesOrderShipmentErrors : []), ...(createV1ShipmentErrors !== null && createV1ShipmentErrors !== void 0 ? createV1ShipmentErrors : []), ...(listSalesOrderShipmentsErrors !== null && listSalesOrderShipmentsErrors !== void 0 ? listSalesOrderShipmentsErrors : []), ...(getExternalShipmentErrors !== null && getExternalShipmentErrors !== void 0 ? getExternalShipmentErrors : []), ...(importSalesOrderErrors !== null && importSalesOrderErrors !== void 0 ? importSalesOrderErrors : []), ...(updateShipmentErrors !== null && updateShipmentErrors !== void 0 ? updateShipmentErrors : []), ...(_errorWhenShipmentCancelled && cancelledShipment ? [new reactApi.CodedError("shipment_cancelled", {
+    errorCode: "invalid_status",
+    errorSource: "elements",
+    errorType: "business_rules"
+  })] : []), ...(labelPurchasedSalesOrderShipment ? [new reactApi.CodedError("label_purchased", {
+    errorCode: "invalid_status",
+    errorSource: "elements",
+    errorType: "business_rules"
+  })] : []), ...(incompleteRequirementsKeys.length > 0 ? [new reactApi.CodedError(incompleteRequirementsKeys.length > 1 ? "no_carriers_and_warehouses" : incompleteRequirementsKeys[0], {
+    errorCode: "unknown",
+    errorSource: "elements",
+    errorType: "business_rules"
+  })] : [])];
+  return {
+    carriers,
+    errors: errors.length > 0 ? errors : undefined,
+    isLoading: (isSalesOrderLoading || !(salesOrderShipments === null || salesOrderShipments === void 0 ? void 0 : salesOrderShipments.length) || creatingSalesOrderShipment) && errors.length === 0,
+    refetchPendingSalesOrderShipments,
+    salesOrder: salesOrder$1,
+    shipment: pendingSalesOrderShipment !== null && pendingSalesOrderShipment !== void 0 ? pendingSalesOrderShipment : labelPurchasedSalesOrderShipment,
+    warehouses: warehouses$1
+  };
+};
+
+exports.useConfigureShipment = useConfigureShipment;

package/cjs/hooks/use-get-funding-source-insurance-provider.cjs

@@ -0,0 +1,51 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var elementsContextProvider = require('../elements-provider/elements-context-provider.cjs');
+
+/**
+ * @internal
+ *
+ * # Get Funding Source Insurance Providers
+ *
+ * - description: This hook is used to get the enabled funding source insurance provider
+ *
+ * @example
+ */
+const useGetFundingSourceInsuranceProvider = () => {
+  const {
+    globalFeatures: {
+      enableParcelGuard
+    }
+  } = elementsContextProvider.useElements();
+  const {
+    data,
+    refetch: refetchInsuranceAcceptedTerms
+  } = reactApi.useGetInsuranceFundingSourceAcceptedTerms({
+    enabled: enableParcelGuard
+  });
+  const fundingSourceInsuranceProvider = React.useMemo(() => {
+    var _a;
+    let provider;
+    (_a = data === null || data === void 0 ? void 0 : data.acceptedTerms) === null || _a === void 0 ? void 0 : _a.forEach(term => {
+      if (enableParcelGuard && term.termType === "parcelguard_terms") {
+        provider = "parcelguard";
+      }
+      // TODO: once x_cover is enabled, confirm the term type and uncomment
+      // if (term.termType === "x_cover_terms") {
+      //   provider = "x_cover";
+      // }
+    });
+
+    return provider;
+  }, [data, enableParcelGuard]);
+  return {
+    fundingSourceInsuranceProvider,
+    refetchInsuranceAcceptedTerms
+  };
+};
+
+exports.useGetFundingSourceInsuranceProvider = useGetFundingSourceInsuranceProvider;

package/cjs/hooks/use-get-service-name.cjs

@@ -0,0 +1,24 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+
+const useGetServiceName = () => {
+  const {
+    data: carrierList,
+    isLoading,
+    isError
+  } = reactApi.useListCarriers();
+  const getServiceName = React.useCallback(itemSelected => {
+    const selectedCarrier = carrierList && carrierList.find(option => option.carrierId === itemSelected.carrierId);
+    const selectedService = selectedCarrier === null || selectedCarrier === void 0 ? void 0 : selectedCarrier.services.find(service => service.serviceCode === itemSelected.serviceCode);
+    return isLoading || isError ? itemSelected.serviceCode : selectedService === null || selectedService === void 0 ? void 0 : selectedService.name;
+  }, [carrierList, isLoading, isError]);
+  return {
+    getServiceName
+  };
+};
+
+exports.useGetServiceName = useGetServiceName;

package/cjs/hooks/use-helpers.cjs

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var checks = require('../utilities/checks.cjs');
+var reactApi = require('@shipengine/react-api');
+
+const useHelpers = () => {
+  const {
+    data: carriers,
+    isLoading: carriersLoading
+  } = reactApi.useListCarriers();
+  const {
+    data: warehouses,
+    isLoading: warehousesLoading
+  } = reactApi.useListWarehouses();
+  const helpersReady = !carriersLoading && !warehousesLoading;
+  const sellerOnboarded = checks.isOnboarded(warehouses, carriers);
+  return {
+    helpersReady,
+    sellerOnboarded,
+    validateShipFromAddress: checks.validateShipFromAddress
+  };
+};
+
+exports.useHelpers = useHelpers;