@shipengine/elements 2.23.0 → 2.25.0

package/dist/esm/elements/purchase-label/hooks/use-filter-visible-rate-options/use-filter-visible-rate-options.js

@@ -0,0 +1,29 @@
+import { useMemo, useCallback } from 'react';
+
+const COLLAPSED_RATE_VIEW_LIMIT = 4;
+const filterRateOptions = (rateOptions, selectedRate, preferredServiceCodes) => {
+  // Show the selected rate
+  const isSelectedRate = option => !!(selectedRate === null || selectedRate === void 0 ? void 0 : selectedRate.rateId) && option.rateId === selectedRate.rateId;
+  // Show the rate if it is a preferred service
+  const isPreferredService = option => !!option.serviceCode && !!(preferredServiceCodes === null || preferredServiceCodes === void 0 ? void 0 : preferredServiceCodes.includes(option.serviceCode));
+  // Show the first 5 rates in the list
+  const isWithinRateViewLimit = index => index < COLLAPSED_RATE_VIEW_LIMIT;
+  return rateOptions.filter((option, index) => isSelectedRate(option) || isPreferredService(option) || isWithinRateViewLimit(index));
+};
+/**
+ * @internal
+ *
+ * # Filter Visible Rate Options Hook
+ *
+ */
+const useFilterVisibleRateOptions = (rateOptions, selectedRate, preferredServiceCodes) => {
+  const collapsedRateOptionList = useMemo(() => filterRateOptions(rateOptions, selectedRate, preferredServiceCodes), [rateOptions, selectedRate, preferredServiceCodes]);
+  const filterVisibleRateOptions = useCallback(options => filterRateOptions(options, selectedRate, preferredServiceCodes), [selectedRate, preferredServiceCodes]);
+  return {
+    COLLAPSED_RATE_VIEW_LIMIT,
+    collapsedRateOptionList,
+    filterVisibleRateOptions
+  };
+};
+
+export { COLLAPSED_RATE_VIEW_LIMIT, useFilterVisibleRateOptions };

package/dist/esm/elements/purchase-label/hooks/use-insurance-provider-options.js

@@ -0,0 +1,39 @@
+import { useGetFundingSourceInsuranceProvider } from '../../../hooks/use-get-funding-source-insurance-provider.js';
+import { SE } from '@shipengine/react-api';
+import * as humps from 'humps';
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useElements } from '../../../elements-provider/elements-context-provider.js';
+
+/**
+ * @internal
+ *
+ * # Insurance Provider Options Hook
+ *
+ * @category Hooks
+ */
+const useInsuranceProviderOptions = (insuranceAccount, features) => {
+  const {
+    t
+  } = useTranslation("common");
+  const {
+    globalFeatures
+  } = useElements();
+  const {
+    fundingSourceInsuranceProvider,
+    refetchInsuranceAcceptedTerms
+  } = useGetFundingSourceInsuranceProvider();
+  const insuranceProviderOptions = useMemo(() => Object.values(SE.InsuranceProviderType).flatMap(v => {
+    return v === "none" || v === "funding_source" || v === "parcelguard" && (v !== fundingSourceInsuranceProvider || !globalFeatures.enableParcelGuard) || v === "x_cover" && v !== fundingSourceInsuranceProvider || v === "carrier" && !(features === null || features === void 0 ? void 0 : features.includeCarrierInsurance) || v === "third_party" && !(features === null || features === void 0 ? void 0 : features.includeThirdPartyInsurance) || v === "shipsurance" && (!(insuranceAccount === null || insuranceAccount === void 0 ? void 0 : insuranceAccount.amount) || !(features === null || features === void 0 ? void 0 : features.includeShipsuranceInsurance)) ? [] : {
+      label: t(`insuranceProviders.${humps.camelize(v)}`),
+      value: v
+    };
+  }), [fundingSourceInsuranceProvider, globalFeatures.enableParcelGuard, features, insuranceAccount === null || insuranceAccount === void 0 ? void 0 : insuranceAccount.amount, t]);
+  return {
+    fundingSourceInsuranceProvider,
+    insuranceProviderOptions,
+    refetchInsuranceAcceptedTerms
+  };
+};
+
+export { useInsuranceProviderOptions };

package/dist/esm/elements/purchase-label/hooks/use-movement-indicator-options.js

@@ -0,0 +1,22 @@
+import { SE } from '@shipengine/react-api';
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+
+/**
+ * @internal
+ *
+ * # Customs Non-Delivery Options Hooks
+ *
+ * @category Hooks
+ */
+const useMovementIndicatorOptions = () => {
+  const {
+    t
+  } = useTranslation("purchase-label");
+  return useMemo(() => Object.values(SE.MovementIndicator).flatMap(v => ({
+    label: t(`windsorFramework.movementIndicators.${v}`),
+    value: v
+  })), [t]);
+};
+
+export { useMovementIndicatorOptions };

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

@@ -0,0 +1,81 @@
+import { formatCarrierLabel } from '../../../../hooks/options/format-carrier-label.js';
+import { useShipmentMetadata } from '../../../../hooks/options/use-shipment-metadata.js';
+import { isUspsCarrier, isUpsCarrier } from '../../../../utilities/shipengine/carrier.js';
+import { formatDimensions } from '../../../../utilities/shipengine/dimensions.js';
+import { useMemo } from 'react';
+import { useTranslation } from 'react-i18next';
+
+const findGenericPackageFromCarriers = carriers => {
+  const carrier = carriers.find(c => c.packages.some(p => p.packageCode === "package"));
+  return carrier === null || carrier === void 0 ? void 0 : carrier.packages.find(p => p.packageCode === "package");
+};
+/**
+ * @internal
+ *
+ * # Package Options Hook
+ *
+ * @category Hooks
+ */
+const usePackageOptions = (carriers, customPackageTypes, shipment) => {
+  const {
+    t
+  } = useTranslation("common");
+  const {
+    isPoBox,
+    isUnsupportedUpsCountry
+  } = useShipmentMetadata(shipment);
+  return useMemo(() => {
+    if (!carriers) return undefined;
+    const genericPackage = findGenericPackageFromCarriers(carriers);
+    const genericPackageOption = genericPackage ? [{
+      label: t("packageCodes.package"),
+      value: {
+        code: "package"
+      }
+    }] : [];
+    const getCustomPackageOptions = () => {
+      if (!customPackageTypes) return [];
+      return customPackageTypes.sort((a, b) => a.name.localeCompare(b.name)).map(({
+        dimensions,
+        name,
+        packageId,
+        packageCode
+      }) => {
+        const dimensionLabel = dimensions ? ` - ${formatDimensions(dimensions)}` : "";
+        return {
+          label: `${name}${dimensionLabel}`,
+          value: {
+            code: packageCode,
+            packageId
+          }
+        };
+      });
+    };
+    const customPackageOptions = [{
+      label: t`packageCategories.customPackages`,
+      options: [...genericPackageOption, ...getCustomPackageOptions()]
+    }];
+    return carriers.reduce((options, carrier) => {
+      if (carrier.packages.length === 0) return options;
+      // Filter out non-USPS packages for PO Box shipments
+      // Filter out UPS packages for unsupported countries
+      if (!isUspsCarrier(carrier.carrierCode) && isPoBox || isUpsCarrier(carrier.carrierCode) && isUnsupportedUpsCountry) return options;
+      return [...options, {
+        // Check the uniqueness of the carrierCode, if unique default to friendlyName and if non-unique use nickname.
+        label: formatCarrierLabel(carriers, carrier),
+        options: carrier.packages.filter(pkg => !["cubic", "letter", "package",
+        // remove these two once API no longer returns them
+        "regional_rate_box_a", "regional_rate_box_b"].includes(pkg.packageCode)).sort((a, b) => a.name.localeCompare(b.name)).map(pkg => ({
+          label: pkg.name,
+          value: {
+            carrierId: carrier.carrierId,
+            code: pkg.packageCode
+          }
+        })),
+        value: carrier.carrierId
+      }];
+    }, customPackageOptions);
+  }, [carriers, customPackageTypes, isPoBox, isUnsupportedUpsCountry, t]);
+};
+
+export { usePackageOptions };

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

@@ -0,0 +1,50 @@
+import { __awaiter } from '../../../_virtual/_tslib.js';
+import { useUpdateSalesOrderShipment } from '@shipengine/react-api';
+import { isNowOrInTheFuture } from '../../../utilities/date.js';
+import { isFlatRatePackageCode } from '../../../utilities/shipengine/package.js';
+import merge from 'lodash/merge.js';
+
+const usePresets = ({
+  onApply,
+  onShipmentUpdated,
+  shipment
+}) => {
+  const {
+    error: updateShipmentErrors,
+    mutateAsync: updateShipment
+  } = useUpdateSalesOrderShipment();
+  const handleApplyPreset = preset => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b, _c;
+    if (!shipment) throw new Error("shipment not found");
+    const isFlatRate = isFlatRatePackageCode(preset.packageCode);
+    const updatedShipmentValues = merge(shipment, {
+      carrierId: (_a = preset.carrierId) !== null && _a !== void 0 ? _a : null,
+      // we dont need to fallback to null for confirmation or provider because if not defined in the preset, NONE is passed
+      confirmation: preset.confirmation,
+      insuranceProvider: preset.insuranceProvider,
+      packages: preset.packageCode ? [{
+        dimensions: preset.dimensions,
+        insuredValue: (_b = preset.insuredValue) !== null && _b !== void 0 ? _b : null,
+        packageCode: preset.packageCode,
+        weight: preset.weight
+      }] : undefined,
+      serviceCode: (_c = preset.serviceCode) !== null && _c !== void 0 ? _c : null,
+      shipDate: isNowOrInTheFuture(shipment.shipDate) ? shipment.shipDate : null
+    });
+    if (!preset.weight && !isFlatRate) {
+      yield onApply === null || onApply === void 0 ? void 0 : onApply(preset, updatedShipmentValues);
+    } else {
+      const updatedShipment = yield updateShipment(updatedShipmentValues);
+      if (updatedShipment) {
+        yield onApply === null || onApply === void 0 ? void 0 : onApply(preset, updatedShipment);
+        yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
+      }
+    }
+  });
+  return {
+    handleApplyPreset,
+    presetErrors: updateShipmentErrors
+  };
+};
+
+export { usePresets };

package/dist/esm/elements/purchase-label/hooks/use-rate-options.js

@@ -0,0 +1,142 @@
+import { useShipmentMetadata } from '../../../hooks/options/use-shipment-metadata.js';
+import { createDictionary } from '../../../utilities/create-dictionary.js';
+import { isPudoEligibleRate, isCollectionService } from '../../../utilities/pudo.js';
+import { getRateRequiresAcknowledgement, getTotalRateAmount } from '../../../utilities/rates.js';
+import { isUspsCarrier, isUpsCarrier, isYodelCarrier, isEvriCarrier } from '../../../utilities/shipengine/carrier.js';
+import { useMemo, useCallback } from 'react';
+import { useTranslation } from 'react-i18next';
+import { useWindsorFramework } from './use-windsor-framework.js';
+import { PudoType } from '../../../types/pudo.js';
+import { CanadaDeliveredDutyOptions } from '../../../types/canada-ddp.js';
+
+/* 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 hermesPaperlessSupportedServices = ["hermes_domestic_parcelshop_dropoff", "hermes_domestic_parcelshop_dropoff_next_day", "hermes_postable", "hermes_postable_next_day"];
+const paperlessSupportedCarriers = [{
+  carrier: "hermes",
+  services: hermesPaperlessSupportedServices,
+  displaySchemes: ["label_and_paperless"]
+}, {
+  carrier: "usps",
+  displaySchemes: ["qr_code"]
+}, {
+  carrier: "stamps_com",
+  displaySchemes: ["qr_code"]
+}];
+/**
+ * @internal
+ *
+ * # Rate Options Hook
+ */
+const useRateOptions = (rates, fundingOrigin, preferredRates, carriers, shipment, servicePoints, requireDhlTermsAcknowledgement, windsorFrameworkEnabled) => {
+  var _a;
+  const {
+    t
+  } = useTranslation();
+  const carriersById = useMemo(() => createDictionary(carriers, c => ({
+    [c.carrierId]: c
+  })), [carriers]);
+  const {
+    isInternational,
+    isPoBox,
+    isUnsupportedUpsCountry
+  } = useShipmentMetadata(shipment);
+  const {
+    requiresWindsorFramework,
+    movementIndicator
+  } = useWindsorFramework(shipment, windsorFrameworkEnabled);
+  const hasSenderPrepayDuties = useMemo(() => {
+    var _a;
+    return ((_a = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _a === void 0 ? void 0 : _a.canadaDeliveredDuty) === CanadaDeliveredDutyOptions.SENDER_PREPAY;
+  }, [(_a = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _a === void 0 ? void 0 : _a.canadaDeliveredDuty]);
+  const buildSupportedLabelDisplaySchemes = (carrierCode, serviceCode) => {
+    const carrier = paperlessSupportedCarriers.find(c => c.carrier === carrierCode);
+    if (!carrier || carrier.services && !carrier.services.includes(serviceCode)) {
+      return [];
+    }
+    // Only return USPS/stamps_com display schemes for domestic shipments
+    if ((carrierCode === 'usps' || carrierCode === 'stamps_com') && isInternational) {
+      return [];
+    }
+    return [...carrier.displaySchemes];
+  };
+  const rateOptionsFilters = useCallback(carrierCode => {
+    return (
+      // Filter out non-USPS carriers for Canada Delivered Duty prepaid shipments
+      (isUspsCarrier(carrierCode) || !hasSenderPrepayDuties) && (
+      // Filter out non-USPS carriers for PO Box shipments
+      isUspsCarrier(carrierCode) || !isPoBox) && (
+      // Filter out UPS for unsupported countries
+      !isUpsCarrier(carrierCode) || !isUnsupportedUpsCountry) && (
+      // Filter out Yodel rates for b2b Windsor Framework Shipments
+      !isYodelCarrier(carrierCode) || !(requiresWindsorFramework && movementIndicator === "b2b")) && (
+      // Filter out Evri rates for b2b Windsor Framework Shipments
+      !isEvriCarrier(carrierCode) || !(requiresWindsorFramework && movementIndicator === "b2b"))
+    );
+  }, [isPoBox, isUnsupportedUpsCountry, movementIndicator, requiresWindsorFramework, hasSenderPrepayDuties]);
+  const preferredRateOptions = useMemo(() => {
+    return (preferredRates !== null && preferredRates !== void 0 ? preferredRates : []).filter(r => {
+      return rateOptionsFilters(r.rate.carrierCode);
+    }).map(r => Object.assign(Object.assign({}, r.rate), {
+      balance: undefined,
+      messages: r.rate.warningMessages,
+      rateAcknowledgementMessage: r.rateAcknowledgementMessage,
+      requiresAcknowledgement: !!r.rateAcknowledgementMessage,
+      requiresFundedAmount: false,
+      paperlessDisplaySchemes: buildSupportedLabelDisplaySchemes(r.rate.carrierCode, r.rate.serviceCode)
+    }));
+  }, [preferredRates, rateOptionsFilters]);
+  const noRatesForServiceMessage = t("purchase-label:rates.noRateService");
+  const standardRateOptions = useMemo(() => {
+    return (rates !== null && rates !== void 0 ? rates : []).filter(r => {
+      const carrier = carriersById[r.carrierId];
+      const service = carrier === null || carrier === void 0 ? void 0 : carrier.services.find(s => s.serviceCode === r.serviceCode);
+      return rateOptionsFilters(r.carrierCode) && (service === null || service === void 0 ? void 0 : service.domestic) === !isInternational;
+    }).map(r => {
+      var _a, _b;
+      const requiresFundedAmount = (_b = (_a = carriersById[r.carrierId]) === null || _a === void 0 ? void 0 : _a.requiresFundedAmount) !== null && _b !== void 0 ? _b : false;
+      const baseRateOption = Object.assign(Object.assign({}, r), {
+        balance: fundingOrigin === null || fundingOrigin === void 0 ? void 0 : fundingOrigin.balance,
+        messages: r.warningMessages,
+        requiresAcknowledgement: getRateRequiresAcknowledgement(r.serviceCode, r.packageType, !!requireDhlTermsAcknowledgement),
+        requiresFundedAmount,
+        paperlessDisplaySchemes: buildSupportedLabelDisplaySchemes(r.carrierCode, r.serviceCode)
+      });
+      if (r.shippingAmount.amount === 0 && !r.warningMessages.includes(noRatesForServiceMessage)) {
+        baseRateOption.messages.push(noRatesForServiceMessage);
+      }
+      if (isPudoEligibleRate(r)) {
+        return isCollectionService(r.carrierCode, r.serviceCode) ? Object.assign(Object.assign({}, baseRateOption), {
+          pudoType: PudoType.PICKUP
+        }) : Object.assign(Object.assign({}, baseRateOption), {
+          pudoType: PudoType.DROPOFF,
+          servicePoints: servicePoints === null || servicePoints === void 0 ? void 0 : servicePoints.filter(sp => {
+            const hasMatchingCarrierCode = sp.carrierCode === r.carrierCode;
+            const hasMatchingServiceCode = sp.serviceCodes.includes(r.serviceCode);
+            //dpd does not designate drop_off feature, instead they allow drop off at all service point locations
+            const isDPD = sp.carrierCode === "dpdwallet";
+            if (isDPD) {
+              return hasMatchingCarrierCode && hasMatchingServiceCode;
+            }
+            const hasDropOffFeatureOrNone = !sp.features || sp.features.length === 0 || sp.features.includes("drop_off_point");
+            return hasMatchingCarrierCode && hasMatchingServiceCode && hasDropOffFeatureOrNone;
+          })
+        });
+      }
+      return baseRateOption;
+    });
+  }, [rates, carriersById, rateOptionsFilters, isInternational, fundingOrigin === null || fundingOrigin === void 0 ? void 0 : fundingOrigin.balance, requireDhlTermsAcknowledgement, noRatesForServiceMessage, servicePoints]);
+  const rateOptions = useMemo(() => {
+    return [...preferredRateOptions, ...standardRateOptions].sort((a, b) => {
+      // both services have no rate, so compare deliveryDays
+      if (a.shippingAmount.amount === 0 && b.shippingAmount.amount === 0) return a.deliveryDays - b.deliveryDays;else if (a.shippingAmount.amount === 0) return 1; // will move 'a' to end
+      else if (b.shippingAmount.amount === 0) return -1; // will move 'b' to end
+      else return getTotalRateAmount(a) - getTotalRateAmount(b); // cheaper price first
+    });
+  }, [preferredRateOptions, standardRateOptions]);
+  return rateOptions;
+};
+
+export { useRateOptions };