@shipengine/elements 2.26.5 → 2.27.0

package/dist/esm/hooks/use-configure-shipment.js

@@ -20,8 +20,8 @@ const useConfigureShipment = ({
   warehouseId,
   useWarehouses = true
 }) => {
-  // Track when we've created a replacement shipment for a "not found" case
-  const [replacementShipmentId, setReplacementShipmentId] = useState();
+  // Track when user manually created a shipment for a "not found" case
+  const [manuallyCreatedShipmentId, setManuallyCreatedShipmentId] = useState();
   // Queue of incomplete requirement keys (i.e., Ship From addresses, Warehouses, Carriers)
   const incompleteRequirementsKeys = useMemo(() => [], []);
   const {
@@ -45,6 +45,7 @@ const useConfigureShipment = ({
     // Dont run Sales Order Import unless the Sales order info is present
     enabled: !!externalOrderNumber || !!orderSourceCode || !!salesOrderId || !!externalOrderId,
     externalOrderId,
+    externalOrderNumber,
     orderSourceCode,
     salesOrderId
   });
@@ -61,24 +62,49 @@ const useConfigureShipment = ({
     isInitialLoading: isExternalShipmentInitialLoading,
     isFetching: isExternalShipmentFetching
   } = useGetShipmentByExternalId({
-    enabled: !!externalShipmentId && !shipmentId,
+    enabled: !!externalShipmentId && !shipmentId && !manuallyCreatedShipmentId,
     queryFnParams: {
       externalId: externalShipmentId !== null && externalShipmentId !== void 0 ? externalShipmentId : ""
     }
+    // TODO: weird refetch on focus behavior
   });
+  // #region List Sales Order Shipments
+  const externalOrderIds = useMemo(() => {
+    return externalOrderId ? [externalOrderId] : undefined;
+  }, [externalOrderId]);
+  const salesOrderIds = useMemo(() => {
+    return salesOrderId ? [salesOrderId] : salesOrder ? [salesOrder.salesOrderId] :
+    // TODO: current workaround - revert to being undefined rather than empty list
+    [];
+  }, [salesOrderId, salesOrder]);
+  const shipmentIds = useMemo(() => {
+    return manuallyCreatedShipmentId ? [manuallyCreatedShipmentId] : shipmentId ? [shipmentId] : externalShipment ? [externalShipment.shipmentId] : newV1Shipment ? [newV1Shipment.shipments[0].shipmentId] : undefined;
+  }, [manuallyCreatedShipmentId, shipmentId, externalShipment, newV1Shipment]);
+  const listSalesOrderShipmentsParams = useMemo(() => {
+    // TODO: useListSalesOrderShipments needs to be able to use the enabled prop, this is a workaround
+    // Prevent query with stale params during shipment creation or when V1 shipment exists but manuallyCreatedShipmentId not set
+    if (creatingV1Shipment && !manuallyCreatedShipmentId || newV1Shipment && !manuallyCreatedShipmentId) {
+      return {};
+    }
+    if (manuallyCreatedShipmentId) {
+      return {
+        shipmentIds
+      };
+    }
+    return {
+      externalOrderIds,
+      salesOrderIds,
+      shipmentIds
+    };
+  }, [manuallyCreatedShipmentId, externalOrderIds, salesOrderIds, shipmentIds, creatingV1Shipment, newV1Shipment]);
   const {
     data: salesOrderShipments,
     error: listSalesOrderShipmentsErrors,
     refetch: refetchSalesOrderShipments,
     isInitialLoading: listSalesOrderShipmentsInitiallyLoading,
     isFetching: listSalesOrderShipmentsIsFetching
-  } = useListSalesOrderShipments({
-    externalOrderIds: externalOrderId ? [externalOrderId] : undefined,
-    salesOrderIds: salesOrderId ? [salesOrderId] : salesOrder ? [salesOrder.salesOrderId] :
-    // TODO: current workaround - revert to being undefined rather than empty list
-    [],
-    shipmentIds: replacementShipmentId ? [replacementShipmentId] : shipmentId ? [shipmentId] : externalShipment ? [externalShipment.shipmentId] : newV1Shipment ? [newV1Shipment.shipments[0].shipmentId] : undefined
-  });
+  } = useListSalesOrderShipments(listSalesOrderShipmentsParams);
+  // #endregion
   const {
     error: createSalesOrderShipmentErrors,
     mutateAsync: createSalesOrderShipment,
@@ -103,6 +129,7 @@ const useConfigureShipment = ({
     }
     return null;
   }), [createV1Shipment, defaultShipFromAddress, defaultWarehouse, warehouseId, refetchSalesOrderShipments]);
+  // #region Create Sales Order Shipment
   // Handles the creation of new shipments for the sales order flow and one-off flow
   const handleShipmentCreation = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
@@ -152,17 +179,23 @@ const useConfigureShipment = ({
     }
     // Create a Shipment for one-off flow
     if (!salesOrderId && !externalOrderId && !externalOrderNumber && !orderSourceCode && !shipmentId && !externalShipmentId) {
-      yield createV1ShipmentWithDefaults();
+      const v1Shipment = yield createV1ShipmentWithDefaults();
+      // Set manuallyCreatedShipmentId to ensure proper query parameter handling
+      if (v1Shipment) {
+        setManuallyCreatedShipmentId(v1Shipment.shipments[0].shipmentId);
+      }
     }
   }), [createSalesOrderShipment, createV1ShipmentWithDefaults, creatingSalesOrderShipment, creatingV1Shipment, defaultShipFromAddress, defaultWarehouse, externalOrderId, externalOrderNumber, externalShipmentId, incompleteRequirementsKeys, isExternalShipmentFetching, isExternalShipmentInitialLoading, isFetchingWarehouses, isInitialLoadingWarehouses, labelPurchasedSalesOrderShipment, listSalesOrderShipmentsInitiallyLoading, listSalesOrderShipmentsIsFetching, orderSourceCode, pendingSalesOrderShipment, salesOrder, salesOrderId, salesOrderShipmentCreated, shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.length, shipmentId, useWarehouses, v1shipmentCreated, warehouseId, warehouses]);
+  // #endregion
   const createNewShipmentForNotFound = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
     // Force create a new shipment even if shipmentId exists (for shipment_not_found case)
     const v1Shipment = yield createV1ShipmentWithDefaults();
     if (v1Shipment) {
-      // Store the new shipment ID to override the stale one
-      setReplacementShipmentId(v1Shipment.shipments[0].shipmentId);
+      setManuallyCreatedShipmentId(v1Shipment.shipments[0].shipmentId);
+      // Refetch to ensure we have the latest shipment data
+      yield refetchSalesOrderShipments();
     }
-  }), [createV1ShipmentWithDefaults]);
+  }), [createV1ShipmentWithDefaults, refetchSalesOrderShipments]);
   const refetchPendingSalesOrderShipments = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
     const {
       data: shipments

package/dist/esm/hooks/use-get-funding-source-insurance-provider.js

@@ -14,14 +14,15 @@ import { useElements } from '../elements-provider/elements-context-provider.js';
 const useGetFundingSourceInsuranceProvider = () => {
   const {
     globalFeatures: {
-      enableParcelGuard
+      enableParcelGuard,
+      enableXCover
     }
   } = useElements();
   const {
     data,
     refetch: refetchInsuranceAcceptedTerms
   } = useGetInsuranceFundingSourceAcceptedTerms({
-    enabled: enableParcelGuard
+    enabled: enableParcelGuard || enableXCover
   });
   const fundingSourceInsuranceProvider = useMemo(() => {
     var _a;
@@ -30,13 +31,12 @@ const useGetFundingSourceInsuranceProvider = () => {
       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";
-      // }
+      if (enableXCover && term.termType === "xcover_terms") {
+        provider = "x_cover";
+      }
     });
     return provider;
-  }, [data, enableParcelGuard]);
+  }, [data === null || data === void 0 ? void 0 : data.acceptedTerms, enableParcelGuard, enableXCover]);
   return {
     fundingSourceInsuranceProvider,
     refetchInsuranceAcceptedTerms

package/dist/esm/hooks/use-import-sales-order.js

@@ -1,28 +1,51 @@
 import { __awaiter } from '../_virtual/_tslib.js';
-import { useGetSalesOrderByExternalOrderId, useGetSalesOrder, useListOrderSources, useRefreshOrderSource } from '@shipengine/react-api';
+import { useListSalesOrders, useGetSalesOrder, useListOrderSources, useRefreshOrderSource } from '@shipengine/react-api';
 import { useQueryClient } from '@tanstack/react-query';
-import { useState, useMemo, useEffect } from 'react';
+import { useState, useMemo, useCallback, useEffect } from 'react';
 
+/**
+ * Imports and retrieves sales orders by either:
+ * - Sales order ID lookup
+ * - External order ID/number search
+ *
+ * 1. First attempts to find the sales order using provided identifiers
+ * 2. If no order is found and initial fetches have run, automatically refreshes order sources
+ * 3. Invalidates relevant queries after successful refresh to refetch updated data
+ *
+ * @returns Object:
+ * - `salesOrder`: The found sales order, or undefined
+ * - `isLoading`: Boolean indicating if the hook is currently loading data
+ * - `errors`: Array of errors from failed queries, or undefined
+ */
 const useImportSalesOrder = ({
   enabled,
   externalOrderId,
+  externalOrderNumber,
   orderSourceCode,
   salesOrderId
 }) => {
   var _a, _b, _c;
   const queryClient = useQueryClient();
   const [refreshAttempted, setRefreshAttempted] = useState(false);
-  // attempt to get sales order through external id means
-  const orderByExternalIdQuery = useGetSalesOrderByExternalOrderId(externalOrderId, {
-    enabled: enabled && !!externalOrderId && !salesOrderId
+  // Fetch sales order by External Order ID or External Order Number
+  const salesOrderByExternalIdQuery = useListSalesOrders({
+    externalOrderId,
+    externalOrderNumber
   });
   // if an order was found through external search disable this query
-  const orderByIdQuery = useGetSalesOrder(salesOrderId, {
+  const salesOrderByIdQuery = useGetSalesOrder(salesOrderId, {
     enabled: enabled && !!salesOrderId
   });
-  const salesOrder = useMemo(() => salesOrderId ? orderByIdQuery.data : orderByExternalIdQuery.data, [salesOrderId, orderByIdQuery.data, orderByExternalIdQuery.data]);
+  const salesOrder = useMemo(() => {
+    if (salesOrderId) {
+      return salesOrderByIdQuery.data;
+    } else if (salesOrderByExternalIdQuery.data && salesOrderByExternalIdQuery.data.length > 0) {
+      return salesOrderByExternalIdQuery.data[0];
+    }
+    return undefined;
+  }, [salesOrderId, salesOrderByIdQuery.data, salesOrderByExternalIdQuery.data]);
   // Determine if the initial fetch attempts (if applicable) have settled without finding data
-  const initialFetchSettled = (salesOrderId ? !orderByIdQuery.isInitialLoading && !orderByIdQuery.isFetching : true) && (externalOrderId && !salesOrderId ? !orderByExternalIdQuery.isLoading && !orderByExternalIdQuery.isFetching : true);
+  const initialFetchSettled = (salesOrderId ? !salesOrderByIdQuery.isInitialLoading && !salesOrderByIdQuery.isFetching : true) && ((externalOrderNumber || externalOrderId) && !salesOrderId ? !salesOrderByExternalIdQuery.isLoading && !salesOrderByExternalIdQuery.isFetching : true);
   const shouldAttemptRefresh = enabled && initialFetchSettled && !salesOrder && !refreshAttempted;
   const listOrderSourcesQuery = useListOrderSources({
     enabled: shouldAttemptRefresh
@@ -32,6 +55,17 @@ const useImportSalesOrder = ({
     isLoading: isRefreshingOrderSource,
     mutateAsync: refreshOrderSource
   } = useRefreshOrderSource();
+  const invalidateSalesOrderQueries = useCallback(() => {
+    if (salesOrderId) {
+      void queryClient.invalidateQueries({
+        queryKey: ["useGetSalesOrder", salesOrderId]
+      });
+    } else if (externalOrderId || externalOrderNumber) {
+      void queryClient.invalidateQueries({
+        queryKey: ["useListSalesOrders", externalOrderId, externalOrderNumber]
+      });
+    }
+  }, [queryClient, salesOrderId, externalOrderId, externalOrderNumber]);
   useEffect(() => {
     if (listOrderSourcesQuery.isSuccess && listOrderSourcesQuery.data && shouldAttemptRefresh && !isRefreshingOrderSource) {
       const orderSourcesToRefresh = orderSourceCode ? listOrderSourcesQuery.data.filter(o => o.orderSourceCode.includes(orderSourceCode) && o.active) : listOrderSourcesQuery.data.filter(o => o.active);
@@ -39,29 +73,20 @@ const useImportSalesOrder = ({
         setRefreshAttempted(true);
         void (() => __awaiter(void 0, void 0, void 0, function* () {
           yield Promise.all(orderSourcesToRefresh.map(o => refreshOrderSource(o.orderSourceId, {
-            // Invalidate relevant queries on successful refresh
+            // Invalidate relevant queries
             onSuccess: () => {
-              if (salesOrderId) {
-                void queryClient.invalidateQueries({
-                  queryKey: ["useGetSalesOrder", salesOrderId]
-                });
-              }
-              if (externalOrderId && !salesOrderId) {
-                void queryClient.invalidateQueries({
-                  queryKey: ["useGetSalesOrderByExternalOrderId", externalOrderId]
-                });
-              }
+              invalidateSalesOrderQueries();
             }
           })));
         }))();
       }
     }
   }, [externalOrderId, isRefreshingOrderSource, listOrderSourcesQuery.data, listOrderSourcesQuery.isSuccess, orderSourceCode, queryClient, refreshOrderSource, salesOrderId, shouldAttemptRefresh]);
-  const isLoading = orderByIdQuery.isInitialLoading || orderByExternalIdQuery.isInitialLoading || listOrderSourcesQuery.isInitialLoading || isRefreshingOrderSource;
-  const errors = [...((_a = orderByIdQuery.error) !== null && _a !== void 0 ? _a : []), ...((_b = orderByExternalIdQuery.error) !== null && _b !== void 0 ? _b : []), ...((_c = listOrderSourcesQuery.error) !== null && _c !== void 0 ? _c : []), ...(refreshOrderSourceErrors !== null && refreshOrderSourceErrors !== void 0 ? refreshOrderSourceErrors : [])];
+  const isLoading = salesOrderByIdQuery.isInitialLoading || salesOrderByExternalIdQuery.isInitialLoading || listOrderSourcesQuery.isInitialLoading || isRefreshingOrderSource;
+  const errors = [...((_a = salesOrderByIdQuery.error) !== null && _a !== void 0 ? _a : []), ...((_b = salesOrderByExternalIdQuery.error) !== null && _b !== void 0 ? _b : []), ...((_c = listOrderSourcesQuery.error) !== null && _c !== void 0 ? _c : []), ...(refreshOrderSourceErrors !== null && refreshOrderSourceErrors !== void 0 ? refreshOrderSourceErrors : [])];
   return {
     errors: errors.length > 0 ? errors : undefined,
-    isLoading,
+    isLoading: isLoading && errors.length === 0,
     salesOrder
   };
 };

package/dist/esm/hooks/use-manage-funding-source-insurance.js

@@ -1,13 +1,15 @@
 import { __awaiter } from '../_virtual/_tslib.js';
 import { useListFundingSources, useGetFundingSourceMetadata, useGetInsuranceFundingSourceAcceptedTerms, useRegisterCarrier } from '@shipengine/react-api';
+import { groupTermsByProvider, getIsFundingSourceInsuranceProviderEnabledAndSupported } from '../utilities/shipengine/insurance.js';
 import { useMemo, useCallback } from 'react';
 import { useElements } from '../elements-provider/elements-context-provider.js';
 
 const useManageFundingSourceInsurance = () => {
-  var _a;
+  var _a, _b;
   const {
     globalFeatures: {
-      enableParcelGuard
+      enableParcelGuard,
+      enableXCover
     }
   } = useElements();
   const {
@@ -19,25 +21,12 @@ const useManageFundingSourceInsurance = () => {
     data: insuranceAcceptedTerms,
     isLoading: loadingInsuranceAcceptedTerms
   } = useGetInsuranceFundingSourceAcceptedTerms({
-    enabled: enableParcelGuard
+    enabled: enableParcelGuard || enableXCover
   });
   const insuranceProviderProfiles = useMemo(() => {
     var _a;
-    return (_a = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.data) === null || _a === void 0 ? void 0 : _a.defaultFundingSourceProfile.optionalTerms.map(terms => {
-      const providerLookup = {
-        parcelguard_terms: "parcelguard"
-      };
-      const friendlyNameLookup = {
-        parcelguard_terms: "ParcelGuard"
-      };
-      const provider = providerLookup[terms.termType];
-      const friendlyName = friendlyNameLookup[terms.termType];
-      return {
-        friendlyName,
-        provider,
-        terms
-      };
-    });
+    const optionalTerms = (_a = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.data) === null || _a === void 0 ? void 0 : _a.defaultFundingSourceProfile.optionalTerms;
+    return groupTermsByProvider(optionalTerms);
   }, [fundingSourceMetadata]);
   const {
     mutateAsync: registerCarrier
@@ -77,12 +66,15 @@ const useManageFundingSourceInsurance = () => {
     }
   }), [fundingSources, insuranceProviderProfiles, registerCarrier]);
   const hasInsuranceToRegister = useMemo(() => {
-    return enableParcelGuard &&
-    // has insurance provider profiles but none have been accepted AND has a funding source
-    !!(insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) && (insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms.length) === 0 && !!(fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.length);
-  }, [enableParcelGuard, insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length, insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms.length, fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.length]);
+    var _a, _b;
+    const isProviderEnabled = getIsFundingSourceInsuranceProviderEnabledAndSupported(insuranceProviderProfiles, enableXCover, enableParcelGuard);
+    const hasProfiles = Boolean(insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length);
+    const hasNoAcceptedTerms = ((_b = (_a = insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms) === null || _a === void 0 ? void 0 : _a.length) !== null && _b !== void 0 ? _b : 0) === 0;
+    const hasFundingSources = Boolean(fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.length);
+    return isProviderEnabled && hasProfiles && hasNoAcceptedTerms && hasFundingSources;
+  }, [insuranceProviderProfiles, enableXCover, enableParcelGuard, (_a = insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms) === null || _a === void 0 ? void 0 : _a.length, fundingSources === null || fundingSources === void 0 ? void 0 : fundingSources.length]);
   return {
-    fundingSourceCountryCode: (_a = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.data) === null || _a === void 0 ? void 0 : _a.defaultFundingSourceProfile.countryCode,
+    fundingSourceCountryCode: (_b = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.data) === null || _b === void 0 ? void 0 : _b.defaultFundingSourceProfile.countryCode,
     hasInsuranceToRegister,
     insuranceAcceptedTerms: insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms,
     insuranceProviderProfiles,

package/dist/esm/index.js

@@ -35,6 +35,9 @@ import * as carrierServices from './workflows/carrier-services/carrier-services.
 export { carrierServices as CarrierServices };
 import * as transactionHistoryElement from './elements/transaction-history/transaction-history-element.js';
 export { transactionHistoryElement as TransactionHistory };
+import * as customsFormElement from './elements/customs-form/customs-form-element.js';
+export { customsFormElement as CustomsForm };
+export { extractCustomsFormData, getDefaultCustomsFormValues } from './elements/customs-form/customs-form-types.js';
 export { useAddressValidation } from './hooks/use-address-validation.js';
 export { useHelpers } from './hooks/use-helpers.js';
 export { useConfigureShipment } from './hooks/use-configure-shipment.js';

package/dist/esm/locales/en/common.json.js

@@ -244,7 +244,7 @@ var common = {
 		parcelguard: "ParcelGuard",
 		shipsurance: "Shipsurance",
 		thirdParty: "Third Party",
-		x_cover: "XCover"
+		xCover: "XCover"
 	},
 	loading: {
 		accountSettings: "Loading account settings...",

package/dist/esm/locales/en/purchase-label.json.js

@@ -91,7 +91,15 @@ var purchaseLabel = {
 		rateSavings: "Save ${{amount}}",
 		upsGroundSaverTermsAcknowledgement: "To start shipping with UPS Ground Saver, you are confirming that you have agreed to the <1>terms and conditions</1>",
 		dhlExpressTermsAcknowledgement: "To start shipping with DHL, you are confirming that you have agreed to the <1>terms and conditions</1>",
-		noRateService: "Rate and services will be billed based on carrier."
+		noRateService: "Rate and services will be billed based on carrier.",
+		rateAttributes: {
+			bestValue: "Best Value",
+			cheapest: "Cheapest",
+			fastest: "Fastest",
+			bestValueTooltip: "Lowest cost option arriving on a specified date within 4 days, with free carrier coverage up to $100 and a free dropoff option.",
+			cheapestTooltip: "Lowest cost option.",
+			fastestTooltip: "Fastest delivery option."
+		}
 	},
 	windsorFramework: {
 		movementIndicator: "Movement Indicator",

package/dist/esm/package.json.js

@@ -1,3 +1,3 @@
-var version = "2.26.5";
+var version = "2.27.0";
 
 export { version };

package/dist/esm/utilities/feature-flags/feature-flags.js

@@ -26,6 +26,7 @@ const defaultFeatureFlags = {
   globalFeatures: {
     disableShadowDOM: false,
     enableParcelGuard: true,
+    enableXCover: false,
     isSandbox: false,
     poweredByShipEngine: true,
     showVatSettings: false,

package/dist/esm/utilities/shipengine/carrier.js

@@ -1,5 +1,6 @@
 import SvgIcon from '../../assets/parcelguard/icon.svg.js';
 import SvgLogo from '../../assets/parcelguard/logo.svg.js';
+import SvgLogo$1 from '../../assets/xcover/logo.svg.js';
 
 const USPS_CARRIER_CODES = ["usps", "stamps_com"];
 /**
@@ -57,6 +58,9 @@ const getLogoOrIconByCarrierCode = (carrierCode, type) => {
   if (carrierCode === "parcelguard") {
     return type === "logo" ? SvgLogo : SvgIcon;
   }
+  if (carrierCode === "xcover") {
+    return SvgLogo$1;
+  }
   const carrierCodeOverrides = {
     stamps_com: "stamps_com_wl",
     usps: "stamps_com_wl"

package/dist/esm/utilities/shipengine/index.js

@@ -6,4 +6,4 @@ export { getCancelledShipment, getIsCustomsRequiredForShipment, getIsInternation
 export { convertDecimalWeightToFractionalWeight, convertFractionalWeightToDecimalWeight, convertPoundsAndOuncesToOunces, convertWeight, formatFractionalWeight, isDecimalWeight, isMetricWeightUnit } from './weight.js';
 export { isFlatRatePackageCode } from './package.js';
 export { getDefaultWarehouse, getWarehouseById } from './warehouses.js';
-export { getInsuranceProviderWithFriendlyName, getIsInsuraceProviderAccepted } from './insurance.js';
+export { filterProfilesByAcceptedTerms, getInsuranceProviderWithFriendlyName, getIsFundingSourceInsuranceProviderEnabledAndSupported, getIsInsuraceProviderAccepted, groupTermsByProvider } from './insurance.js';

package/dist/esm/utilities/shipengine/insurance.js

@@ -10,6 +10,22 @@ import _insuranceProviderMetadata from '../../data/insurance-provider-metadatas.
 const getInsuranceProviderWithFriendlyName = termType => {
   return _insuranceProviderMetadata[termType];
 };
+/**
+ * @internal
+ *
+ * # Insurance Utilities - getIsFundingSourceInsuranceProviderEnabledAndSupported
+ *
+ * Determines if any insurance providers are enabled and supported based on feature flags and funding source data.
+ *
+ * @category Utilities
+ */
+const getIsFundingSourceInsuranceProviderEnabledAndSupported = (insuranceProviders, xcoverEnabled, parcelguardEnabled) => {
+  if (!(insuranceProviders === null || insuranceProviders === void 0 ? void 0 : insuranceProviders.length)) return false;
+  const supportedProviders = insuranceProviders.map(p => p.provider);
+  if (xcoverEnabled && supportedProviders.includes("xcover")) return true;
+  if (parcelguardEnabled && supportedProviders.includes("parcelguard")) return true;
+  return false;
+};
 /**
  * @internal
  *
@@ -20,5 +36,49 @@ const getInsuranceProviderWithFriendlyName = termType => {
 const getIsInsuraceProviderAccepted = (termType, acceptedTerms) => {
   return !!(acceptedTerms === null || acceptedTerms === void 0 ? void 0 : acceptedTerms.map(t => t.termType).includes(termType));
 };
+/**
+ * @internal
+ *
+ * # Insurance Utilities - groupTermsByProvider
+ *
+ * Groups optional terms by insurance provider, creating InsuranceProviderProfile objects.
+ *
+ * @category Utilities
+ */
+const groupTermsByProvider = optionalTerms => {
+  if (!optionalTerms) return [];
+  // Group terms by provider
+  const providerTermsMap = new Map();
+  optionalTerms.forEach(term => {
+    const providerInfo = getInsuranceProviderWithFriendlyName(term.termType);
+    if (providerInfo === null || providerInfo === void 0 ? void 0 : providerInfo.provider) {
+      const existingTerms = providerTermsMap.get(providerInfo.provider) || [];
+      providerTermsMap.set(providerInfo.provider, [...existingTerms, term]);
+    }
+  });
+  // Convert Map to InsuranceProviderProfile array
+  return Array.from(providerTermsMap.entries()).map(([, terms]) => {
+    const providerInfo = getInsuranceProviderWithFriendlyName(terms[0].termType);
+    return Object.assign(Object.assign({}, providerInfo), {
+      terms
+    });
+  });
+};
+/**
+ * @internal
+ *
+ * # Insurance Utilities - filterProfilesByAcceptedTerms
+ *
+ * Filters insurance provider profiles to exclude those that have already been accepted.
+ *
+ * @category Utilities
+ */
+const filterProfilesByAcceptedTerms = (profiles, acceptedTerms) => {
+  if (!(acceptedTerms === null || acceptedTerms === void 0 ? void 0 : acceptedTerms.length)) return profiles;
+  const connectedTermTypes = new Set(acceptedTerms.map(t => t.termType));
+  return profiles.filter(profile => {
+    return !profile.terms.some(term => connectedTermTypes.has(term.termType));
+  });
+};
 
-export { getInsuranceProviderWithFriendlyName, getIsInsuraceProviderAccepted };
+export { filterProfilesByAcceptedTerms, getInsuranceProviderWithFriendlyName, getIsFundingSourceInsuranceProviderEnabledAndSupported, getIsInsuraceProviderAccepted, groupTermsByProvider };

package/dist/esm/workflows/onboarding/components/confirmation-and-submission-step/use-confirmation-and-submission-step.js

@@ -105,12 +105,12 @@ const useConfirmationAndSubmissionStep = ({
     iovationBlackbox
   }) {
     const addressToRegister = address !== null && address !== void 0 ? address : defaultWarehouse.originAddress;
-    // parcel guard check
-    const insuranceProviders = globalFeatures.enableParcelGuard ? insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.map(p => ({
-      acceptedTerms: [{
-        termType: p.terms.termType,
-        version: p.terms.version
-      }],
+    // funding source insurance check
+    const insuranceProviders = globalFeatures.enableParcelGuard || globalFeatures.enableXCover ? insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.map(p => ({
+      acceptedTerms: p.terms.map(term => ({
+        termType: term.termType,
+        version: term.version
+      })),
       agreeToTerms: true,
       fundingSourceId,
       provider: p.provider
@@ -144,7 +144,7 @@ const useConfirmationAndSubmissionStep = ({
       console.error(error);
       throw error;
     }
-  }), [registerCarrier, globalFeatures.enableParcelGuard]);
+  }), [globalFeatures.enableParcelGuard, globalFeatures.enableXCover, registerCarrier]);
   const onboardSeller = useCallback(({
     carrierProfiles,
     fundingSourceRequiredTerms,
@@ -203,7 +203,7 @@ const useConfirmationAndSubmissionStep = ({
           yield createHandleCarrierConnections({
             carrierProfiles,
             defaultWarehouse: warehouse,
-            insuranceProviderProfiles: globalFeatures.enableParcelGuard ? insuranceProviderProfiles : undefined
+            insuranceProviderProfiles
           })(fundingSource.fundingSource.fundingSourceId, {
             iovationBlackbox
           });
@@ -213,7 +213,7 @@ const useConfirmationAndSubmissionStep = ({
         }
       }
     }
-  }), [addSandboxCarriers, createFundingSource, createHandleCarrierConnections, createOrUpdateWarehouse, getToken, globalFeatures.enableParcelGuard, globalFeatures.isSandbox]);
+  }), [addSandboxCarriers, createFundingSource, createHandleCarrierConnections, createOrUpdateWarehouse, getToken, globalFeatures.isSandbox]);
   const updateExistingFundingSource = useCallback(({
     carrierProfiles,
     fundingSource,

package/dist/esm/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.js

@@ -28,7 +28,8 @@ const TermsAgreementForm = ({
   } = useTranslation();
   const {
     globalFeatures: {
-      enableParcelGuard
+      enableParcelGuard,
+      enableXCover
     }
   } = useElements();
   const [showTerms, setShowTerms] = useState(false);
@@ -107,7 +108,7 @@ const TermsAgreementForm = ({
           }), carrierTerms.map((term, idx) => jsx(DisplayTerm, {
             terms: term
           }, idx))]
-        }), enableParcelGuard && !!insuranceProviderTerms.length && jsxs(Fragment, {
+        }), (enableParcelGuard || enableXCover) && !!insuranceProviderTerms.length && jsxs(Fragment, {
           children: [jsx(Spacer, {}), jsx(Typography, {
             bold: true,
             variant: "body1",

package/dist/esm/workflows/onboarding/components/terms-agreement-step/terms-agreement-step.js

@@ -20,13 +20,14 @@ const TermsAgreementStep = ({
   fundingSourceRequiredTerms,
   showStampsLogo = false
 }) => {
-  var _a, _b, _c, _d, _e;
+  var _a, _b, _c, _d, _e, _f;
   const {
     t
   } = useTranslation("onboarding");
   const {
     globalFeatures: {
-      enableParcelGuard
+      enableParcelGuard,
+      enableXCover
     }
   } = useElements();
   const carrierFriendlyNames = useCarrierMetadata();
@@ -39,11 +40,12 @@ const TermsAgreementStep = ({
     };
   });
   const insuranceProviderTerms = (_a = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.flatMap(p => p.terms)) !== null && _a !== void 0 ? _a : [];
-  const showParcelGuard = enableParcelGuard && ((_b = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) !== null && _b !== void 0 ? _b : 0) > 0;
-  const hasInsuranceToRegister = showParcelGuard && ((_c = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) !== null && _c !== void 0 ? _c : 0) > 0;
+  const showParcelGuard = enableParcelGuard && ((_b = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles[0]) === null || _b === void 0 ? void 0 : _b.friendlyName) === "ParcelGuard";
+  const showXCover = enableXCover && ((_c = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles[0]) === null || _c === void 0 ? void 0 : _c.friendlyName) === "XCover";
+  const hasInsuranceToRegister = (showParcelGuard || showXCover) && ((_d = insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) !== null && _d !== void 0 ? _d : 0) > 0;
   const hasEnabledCarriersConfigurationError = !showStampsLogo && (!enabledCarrierProfiles || (enabledCarrierProfiles === null || enabledCarrierProfiles === void 0 ? void 0 : enabledCarrierProfiles.length) === 0);
-  const hasAlreadyConnectedCarriers = ((_d = enabledCarrierProfiles === null || enabledCarrierProfiles === void 0 ? void 0 : enabledCarrierProfiles.length) !== null && _d !== void 0 ? _d : 0) > 0 && carrierProfilesToRegister.length === 0 && (insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) === 0;
-  const hasCarriersToRegister = ((_e = enabledCarrierProfiles === null || enabledCarrierProfiles === void 0 ? void 0 : enabledCarrierProfiles.length) !== null && _e !== void 0 ? _e : 0) > 0 && carrierProfilesToRegister.length > 0;
+  const hasAlreadyConnectedCarriers = ((_e = enabledCarrierProfiles === null || enabledCarrierProfiles === void 0 ? void 0 : enabledCarrierProfiles.length) !== null && _e !== void 0 ? _e : 0) > 0 && carrierProfilesToRegister.length === 0 && (insuranceProviderProfiles === null || insuranceProviderProfiles === void 0 ? void 0 : insuranceProviderProfiles.length) === 0;
+  const hasCarriersToRegister = ((_f = enabledCarrierProfiles === null || enabledCarrierProfiles === void 0 ? void 0 : enabledCarrierProfiles.length) !== null && _f !== void 0 ? _f : 0) > 0 && carrierProfilesToRegister.length > 0;
   // Handle case where partner has not correctly enabled carriers and there is no insurance to register
   // Insurance does not get set in the same enabled carriers list and should bypass this check
   if (hasEnabledCarriersConfigurationError && !hasInsuranceToRegister) {

package/dist/esm/workflows/onboarding/components/terms-agreement-step/use-terms-agreement-step.js

@@ -1,6 +1,6 @@
 import { useListFundingSources, useListCarriers, useGetFundingSourceMetadata, useGetInsuranceFundingSourceAcceptedTerms } from '@shipengine/react-api';
 import { filterFundingSourceCarriers } from '../../../../utilities/shipengine/carrier.js';
-import { getInsuranceProviderWithFriendlyName } from '../../../../utilities/shipengine/insurance.js';
+import { groupTermsByProvider, filterProfilesByAcceptedTerms } from '../../../../utilities/shipengine/insurance.js';
 import { useMemo, useCallback } from 'react';
 
 const useTermsAgreementStep = ({
@@ -67,25 +67,10 @@ const useTermsAgreementStep = ({
     });
   }, [fundingSourceRequiredTerms, fundingSources, carriers, enabledCarrierProfiles]);
   const insuranceProviderProfiles = useMemo(() => {
-    const insuranceProfiles = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.defaultFundingSourceProfile.optionalTerms.map(terms => {
-      return Object.assign(Object.assign({}, getInsuranceProviderWithFriendlyName(terms.termType)), {
-        terms
-      });
-    });
-    if (!insuranceProfiles) return [];
-    // filter out insurance profiles that are already connected from insurance accepted terms
-    const connectedInsuranceProfiles = insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms.map(terms => {
-      return Object.assign(Object.assign({}, getInsuranceProviderWithFriendlyName(terms.termType)), {
-        terms
-      });
-    });
-    return insuranceProfiles.filter(profile => {
-      const isConnected = connectedInsuranceProfiles === null || connectedInsuranceProfiles === void 0 ? void 0 : connectedInsuranceProfiles.some(c => c.terms.termType === profile.terms.termType);
-      if (isConnected) {
-        return false;
-      }
-      return true;
-    });
+    const optionalTerms = fundingSourceMetadata === null || fundingSourceMetadata === void 0 ? void 0 : fundingSourceMetadata.defaultFundingSourceProfile.optionalTerms;
+    const acceptedTerms = insuranceAcceptedTerms === null || insuranceAcceptedTerms === void 0 ? void 0 : insuranceAcceptedTerms.acceptedTerms;
+    const profiles = groupTermsByProvider(optionalTerms);
+    return filterProfilesByAcceptedTerms(profiles, acceptedTerms);
   }, [fundingSourceMetadata, insuranceAcceptedTerms]);
   const handleSubmitTermsAgreement = useCallback(() => {
     onStepComplete();

package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/index.d.ts

@@ -0,0 +1,2 @@
+export { RateAttributeItem } from "./rate-attribute-item";
+//# sourceMappingURL=index.d.ts.map

package/dist/types/components/field/rate-select/rate-card/rate-attribute-item/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/components/field/rate-select/rate-card/rate-attribute-item/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC"}