@shipengine/elements 2.20.0 → 2.22.0

package/cjs/utilities/pudo.cjs

@@ -0,0 +1,45 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @internal
+ *
+ * # Rates Utilities - Determines if an Elements supported carrier is enabled in https://shipengine.github.io/shipengine-openapi/#operation/service_points_list and if the carrier has services which are exclusively Carrier Pick Up Services. TODO: This is a temporary solution until we have a better way to determine if a carrier is a PUDO carrier with pick up services via a service metadata registry.
+ *
+ * @category Utilities
+ */
+// These are explicitly known carriers and services that are PUDO carriers with pick up services. Manually update this list as needed.
+const pudoCarriersAndServices = [{
+  carrier: "yodel_walleted"
+}, {
+  carrier: "hermes",
+  serviceCodes: [{
+    serviceCode: "domestic_courier_collections",
+    type: "pick_up"
+  }, {
+    serviceCode: "postable_courier_collections",
+    type: "pick_up"
+  }]
+}, {
+  carrier: "dpdwallet"
+}];
+const isPudoEligibleRate = rate => {
+  return pudoCarriersAndServices.some(pudoCarrier => {
+    return rate.carrierCode === pudoCarrier.carrier;
+  });
+};
+// Optimistically assumes if "collection" is in the service name, it's a collection service
+// This is so dumb, but it's the best we can do until we have a better way to determine if a carrier is a PUDO carrier with pick up services via a service metadata registry.
+const serviceCodeIncludesCollection = serviceCode => {
+  return serviceCode.toLowerCase().includes("collection");
+};
+const isCollectionService = (carrier, serviceCode) => {
+  return pudoCarriersAndServices.some(c => {
+    var _a;
+    return c.carrier === carrier && serviceCodeIncludesCollection(serviceCode) || ((_a = c.serviceCodes) === null || _a === void 0 ? void 0 : _a.some(s => s.serviceCode === serviceCode && s.type === "pick_up"));
+  });
+};
+
+exports.isCollectionService = isCollectionService;
+exports.isPudoEligibleRate = isPudoEligibleRate;

package/cjs/utilities/rate-details.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const aggregateRateDetailItems = rateDetails => rateDetails.reduce((prev, curr) => {
+  // check if the item already exists
+  const index = prev.findIndex(item => {
+    var _a, _b, _c, _d;
+    return item.rateDetailType === curr.rateDetailType && ((_a = item.rateDetailAttributes) === null || _a === void 0 ? void 0 : _a.taxPercentage) === ((_b = curr.rateDetailAttributes) === null || _b === void 0 ? void 0 : _b.taxPercentage) && ((_c = item.rateDetailAttributes) === null || _c === void 0 ? void 0 : _c.taxType) === ((_d = curr.rateDetailAttributes) === null || _d === void 0 ? void 0 : _d.taxType);
+  });
+  // If it doesn't exist, add it to the array
+  if (index < 0) {
+    prev.push({
+      amount: curr.amount.amount,
+      currency: curr.amount.currency,
+      rateDetailAttributes: curr.rateDetailAttributes,
+      rateDetailType: curr.rateDetailType
+    });
+  } else {
+    // If it exists, add the amount to the existing amount
+    prev[index].amount += curr.amount.amount;
+  }
+  return prev;
+}, []);
+const calculateRateDetailBreakdown = aggregatedRates => aggregatedRates.reduce((prev, curr) => {
+  // sum all concepts
+  prev.total += curr.amount;
+  prev.subtotal += curr.amount;
+  // if the item is a tax, set hasTax to true
+  // and substract this ammount from subtotal
+  if (curr.rateDetailType === "tax") {
+    prev.hasTax = true;
+    prev.subtotal -= curr.amount;
+    prev.tax.push(curr);
+  } else {
+    prev.items.push(curr);
+  }
+  return prev;
+}, {
+  hasTax: false,
+  items: [],
+  subtotal: 0,
+  tax: [],
+  total: 0
+});
+
+exports.aggregateRateDetailItems = aggregateRateDetailItems;
+exports.calculateRateDetailBreakdown = calculateRateDetailBreakdown;

package/cjs/utilities/rates.cjs

@@ -0,0 +1,47 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var money = require('./money.cjs');
+
+/**
+ * @internal
+ *
+ * # Rates Utilities - getRateRequiresAcknowledgement
+ *
+ * @category Utilities
+ */
+const getRateRequiresAcknowledgement = (serviceCode, packageType, requireDhlTermsAcknowledgement) => {
+  switch (serviceCode) {
+    case "usps_media_mail":
+      return true;
+    case "usps_first_class_mail":
+      return packageType === "large_envelope_or_flat";
+    case "dhl_express_worldwide":
+      return requireDhlTermsAcknowledgement;
+    default:
+      return false;
+  }
+};
+/**
+ * @internal
+ *
+ * # Rates Utilities - getTotalRateAmount
+ *
+ * @category Utilities
+ */
+const getTotalRateAmount = (rateCosts = {}) => money.calculateTotal(...Object.values(rateCosts));
+/**
+ * @internal
+ *
+ * # Rates Utilities - overrideCarrierCodes
+ *
+ * @category Utilities
+ */
+const overrideCarrierCodes = (carrier, overrides) => {
+  return overrides[carrier] || carrier;
+};
+
+exports.getRateRequiresAcknowledgement = getRateRequiresAcknowledgement;
+exports.getTotalRateAmount = getTotalRateAmount;
+exports.overrideCarrierCodes = overrideCarrierCodes;

package/cjs/utilities/shipengine/address.cjs

@@ -0,0 +1,179 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var isEqual = require('lodash/isEqual.js');
+var isNil = require('lodash/isNil.js');
+var omit = require('lodash/omit.js');
+var omitBy = require('lodash/omitBy.js');
+var address = require('../../constants/shipengine/address.cjs');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var isEqual__default = /*#__PURE__*/_interopDefaultLegacy(isEqual);
+var isNil__default = /*#__PURE__*/_interopDefaultLegacy(isNil);
+var omit__default = /*#__PURE__*/_interopDefaultLegacy(omit);
+var omitBy__default = /*#__PURE__*/_interopDefaultLegacy(omitBy);
+
+/**
+ * @internal
+ *
+ * # Address Utilities - isDomesticAddress
+ *
+ * @category Utilities
+ */
+const isDomesticAddress = address$1 => {
+  var _a;
+  return address$1.countryCode === "US" || ((_a = address.countries.find(c => c.code === address$1.countryCode)) === null || _a === void 0 ? void 0 : _a.isUnitedStatesTerritory);
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - isMilitaryAddress
+ *
+ * @category Utilities
+ */
+const isMilitaryAddress = address$1 => {
+  var _a, _b;
+  return !!(((_a = address.usStates.find(s => s.code === address$1.stateProvince)) === null || _a === void 0 ? void 0 : _a.isMilitary) || ((_b = address.usCities.find(c => c.code === address$1.cityLocality)) === null || _b === void 0 ? void 0 : _b.isMilitary));
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - isUnitedStatesTerritory
+ *
+ * @category Utilities
+ */
+const isUnitedStatesTerritory = address$1 => {
+  var _a, _b;
+  return !!(((_a = address.countries.find(c => c.code === address$1.countryCode)) === null || _a === void 0 ? void 0 : _a.isUnitedStatesTerritory) || ((_b = address.usStates.find(s => s.code === address$1.stateProvince)) === null || _b === void 0 ? void 0 : _b.isUnitedStatesTerritory));
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - isUnsupportedByUps
+ *
+ * @category Utilities
+ */
+const isUnsupportedByUps = address$1 => {
+  var _a;
+  return !!((_a = address.countries.find(c => c.code === address$1.countryCode)) === null || _a === void 0 ? void 0 : _a.isUnsupportedByUps);
+};
+const PO_BOX_REGEX =
+// eslint-disable-next-line no-useless-escape
+/^(((p[\s\.\'\,]?[o\s][\.\'\,]?)\s?)|(post\s?office\s?))((box|bin|bo|b\.?)?\s?(num|number|#)?\s?\d+)/i;
+/**
+ * @internal
+ *
+ * # Address Utilities - isPoBox
+ *
+ * @category Utilities
+ */
+const isPoBox = addressLine => PO_BOX_REGEX.test(addressLine);
+/**
+ * @internal
+ *
+ * # Address Utilities - isPoBoxAddress
+ *
+ * @category Utilities
+ */
+const isPoBoxAddress = address => !!(isPoBox(address.addressLine1) || address.addressLine2 && isPoBox(address.addressLine2));
+/**
+ * @internal
+ *
+ * # Address Utilities - isEmptyAddress
+ *
+ * @category Utilities
+ */
+const isEmptyAddress = address => {
+  return !address || Object.entries(address).every(([key, value]) => key === "countryCode" || [null, "", "unknown"].includes(value));
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - addEmailToValidation
+ *  Even though the documentation says otherwise, the email is dropped from the returned address validation object
+ *
+ * @category Utilities
+ */
+const addEmailToValidation = (addressValidation, email) => {
+  return Object.assign(Object.assign(Object.assign({}, addressValidation), addressValidation.matchedAddress && {
+    matchedAddress: Object.assign(Object.assign({}, addressValidation.matchedAddress), {
+      email: email
+    })
+  }), {
+    originalAddress: Object.assign(Object.assign({}, addressValidation.originalAddress), {
+      email: email
+    })
+  });
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - getDefaultShipFromAddress
+ *  Gets the default ship from address from an array of ship from addresses
+ *
+ * @category Utilities
+ */
+const getDefaultShipFromAddress = addresses => {
+  var _a;
+  if (!addresses) return undefined;
+  return (_a = addresses.find(address => address.isDefault)) !== null && _a !== void 0 ? _a : addresses[0];
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - getSavedShipFromAddressId
+ *  Gets the address ID of the Ship From Address on the shipment if it is a saved address and not a warehouse
+ *
+ * @category Utilities
+ */
+const getSavedShipFromAddressId = (shipment, shipFromAddresses) => {
+  if (!shipment && !shipFromAddresses) return;
+  // Remove addressResidentialIndicator and clean any null or undefined values.
+  const cleanShipment = {
+    originAddress: omitBy__default["default"](omit__default["default"](shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom, ["addressResidentialIndicator"]), isNil__default["default"]),
+    returnAddress: omitBy__default["default"](omit__default["default"](shipment === null || shipment === void 0 ? void 0 : shipment.returnTo, ["addressResidentialIndicator"]), isNil__default["default"])
+  };
+  // Find the saved ship from address that matches the shipment
+  const savedShipFromAddressOnShipment = shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.find(address => {
+    return isEqual__default["default"](cleanShipment, omit__default["default"](Object.assign(Object.assign({}, address), address.returnAddress === undefined && {
+      returnAddress: address.originAddress
+    }), ["addressId", "name", "isDefault"]));
+  });
+  return (savedShipFromAddressOnShipment === null || savedShipFromAddressOnShipment === void 0 ? void 0 : savedShipFromAddressOnShipment.addressId) || "custom-shipment-address";
+};
+/**
+ * @internal
+ *
+ * # Address Utilities - getIsShipmentUsingSavedShipFromAddress
+ *  Returns true if the shipment is using a saved ship from address
+ *
+ * @category Utilities
+ */
+const getIsShipmentUsingSavedShipFromAddress = (shipment, shipFromAddresses) => {
+  if (!shipment || !shipFromAddresses) return;
+  // Remove addressResidentialIndicator and clean any null or undefined values.
+  const cleanShipment = {
+    originAddress: omitBy__default["default"](omit__default["default"](shipment === null || shipment === void 0 ? void 0 : shipment.shipFrom, ["addressResidentialIndicator"]), isNil__default["default"]),
+    returnAddress: omitBy__default["default"](omit__default["default"](shipment === null || shipment === void 0 ? void 0 : shipment.returnTo, ["addressResidentialIndicator"]), isNil__default["default"])
+  };
+  // Check is the Shipment address is the same as any of the prop ship from addresses
+  return shipFromAddresses === null || shipFromAddresses === void 0 ? void 0 : shipFromAddresses.some(address => {
+    return isEqual__default["default"](cleanShipment, omit__default["default"](Object.assign(Object.assign({}, address), address.returnAddress === undefined && {
+      returnAddress: address.originAddress
+    }), ["addressId", "name", "isDefault"]));
+  });
+};
+
+exports.addEmailToValidation = addEmailToValidation;
+exports.getDefaultShipFromAddress = getDefaultShipFromAddress;
+exports.getIsShipmentUsingSavedShipFromAddress = getIsShipmentUsingSavedShipFromAddress;
+exports.getSavedShipFromAddressId = getSavedShipFromAddressId;
+exports.isDomesticAddress = isDomesticAddress;
+exports.isEmptyAddress = isEmptyAddress;
+exports.isMilitaryAddress = isMilitaryAddress;
+exports.isPoBox = isPoBox;
+exports.isPoBoxAddress = isPoBoxAddress;
+exports.isUnitedStatesTerritory = isUnitedStatesTerritory;
+exports.isUnsupportedByUps = isUnsupportedByUps;

package/cjs/utilities/shipengine/carrier.cjs

@@ -0,0 +1,95 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var icon = require('../../assets/parcelguard/icon.cjs');
+var logo = require('../../assets/parcelguard/logo.cjs');
+
+const USPS_CARRIER_CODES = ["usps", "stamps_com"];
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isUspsCarrier
+ *
+ * @category Utilities
+ */
+const isUspsCarrier = carrierCode => USPS_CARRIER_CODES.includes(carrierCode);
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isUpsCarrier
+ *
+ * @category Utilities
+ */
+const isUpsCarrier = carrierCode => carrierCode === "ups";
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isYodelCarrier
+ *
+ * @category Utilities
+ */
+const isYodelCarrier = carrierCode => carrierCode.includes("yodel");
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isEvriCarrier
+ *
+ * @category Utilities
+ */
+const isEvriCarrier = carrierCode => carrierCode === "hermes";
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isFedexCarrier
+ *
+ * @category Utilities
+ */
+const getCarrierIdByCarrierCode = (carriers = [], carrierCode) => {
+  const carrier = carriers.find(c => c.carrierCode === carrierCode);
+  return carrier === null || carrier === void 0 ? void 0 : carrier.carrierId;
+};
+/**
+ * @internal
+ *
+ * # Carrier Utilities - getLogoOrIconByCarrierCode
+ *
+ * @category Utilities
+ */
+const getLogoOrIconByCarrierCode = (carrierCode, type) => {
+  var _a;
+  if (carrierCode === "parcelguard") {
+    return type === "logo" ? logo : icon;
+  }
+  const carrierCodeOverrides = {
+    stamps_com: "stamps_com_wl",
+    usps: "stamps_com_wl"
+  };
+  return `https://logos.shipstation.com/ipaas/carriers/${(_a = carrierCodeOverrides[carrierCode]) !== null && _a !== void 0 ? _a : carrierCode}/${type}.svg`;
+};
+// Since we use the global feature `enabledShipEngineCarriers`, if a partner adds "globalpost"/"sendle_walleted" to their global carriers array, GlobalPost/Sendle will appear for supported & unsupported regions. GlobalPost and Sendle appear in US/AU/GB/CA funding source profiles, but are currently only live in production for GB and CA as of July 2024.
+// This is necessary to filter out carriers that are not currently supported by the funding source region. This filter will have to be manually updated as these carriers are enabled in more regions.
+// ShipEngine Walleted Carriers available in Elements: https://auctane.atlassian.net/wiki/spaces/SEEU/pages/3877503042/ShipEngine+Carriers+available+in+Elements+and+Carrier+Portal+Dashboard
+const isGlobalPostEligible = region => region ? ["GB", "CA", "US"].includes(region) : false;
+const isSendleEligible = region => region === "AU";
+const filterFundingSourceCarriers = (carriers, fundingSourceRegion) => {
+  return carriers === null || carriers === void 0 ? void 0 : carriers.filter(carrier => {
+    if (carrier.carrierCode === "globalpost") {
+      return isGlobalPostEligible(fundingSourceRegion);
+    }
+    if (carrier.carrierCode === "sendle_walleted") {
+      return isSendleEligible(fundingSourceRegion);
+    }
+    return true;
+  });
+};
+
+exports.filterFundingSourceCarriers = filterFundingSourceCarriers;
+exports.getCarrierIdByCarrierCode = getCarrierIdByCarrierCode;
+exports.getLogoOrIconByCarrierCode = getLogoOrIconByCarrierCode;
+exports.isEvriCarrier = isEvriCarrier;
+exports.isGlobalPostEligible = isGlobalPostEligible;
+exports.isSendleEligible = isSendleEligible;
+exports.isUpsCarrier = isUpsCarrier;
+exports.isUspsCarrier = isUspsCarrier;
+exports.isYodelCarrier = isYodelCarrier;

package/cjs/utilities/shipengine/dimensions.cjs

@@ -0,0 +1,30 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @internal
+ *
+ * # Convert Dimensions Utility Function
+ *
+ * @category Utilities
+ */
+const formatDimensions = dimensions => `${dimensions.length} x ${dimensions.width} x ${dimensions.height} `;
+function convertDimensions(dimensions, {
+  allowAllZeroes
+} = {}) {
+  const {
+    length,
+    width,
+    height,
+    unit
+  } = dimensions;
+  const hasAllZeroes = [length, width, height].every(v => v === 0);
+  if (hasAllZeroes && !allowAllZeroes) return undefined;
+  return Object.assign(Object.assign({}, dimensions), {
+    unit: unit !== null && unit !== void 0 ? unit : "inch"
+  });
+}
+
+exports.convertDimensions = convertDimensions;
+exports.formatDimensions = formatDimensions;

package/cjs/utilities/shipengine/index.cjs

@@ -0,0 +1,60 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var address = require('./address.cjs');
+var carrier = require('./carrier.cjs');
+var dimensions = require('./dimensions.cjs');
+var salesOrder = require('./sales-order.cjs');
+var shipment = require('./shipment.cjs');
+var weight = require('./weight.cjs');
+var _package = require('./package.cjs');
+var warehouses = require('./warehouses.cjs');
+var insurance = require('./insurance.cjs');
+
+
+
+exports.addEmailToValidation = address.addEmailToValidation;
+exports.getDefaultShipFromAddress = address.getDefaultShipFromAddress;
+exports.getIsShipmentUsingSavedShipFromAddress = address.getIsShipmentUsingSavedShipFromAddress;
+exports.getSavedShipFromAddressId = address.getSavedShipFromAddressId;
+exports.isDomesticAddress = address.isDomesticAddress;
+exports.isEmptyAddress = address.isEmptyAddress;
+exports.isMilitaryAddress = address.isMilitaryAddress;
+exports.isPoBox = address.isPoBox;
+exports.isPoBoxAddress = address.isPoBoxAddress;
+exports.isUnitedStatesTerritory = address.isUnitedStatesTerritory;
+exports.isUnsupportedByUps = address.isUnsupportedByUps;
+exports.filterFundingSourceCarriers = carrier.filterFundingSourceCarriers;
+exports.getCarrierIdByCarrierCode = carrier.getCarrierIdByCarrierCode;
+exports.getLogoOrIconByCarrierCode = carrier.getLogoOrIconByCarrierCode;
+exports.isEvriCarrier = carrier.isEvriCarrier;
+exports.isGlobalPostEligible = carrier.isGlobalPostEligible;
+exports.isSendleEligible = carrier.isSendleEligible;
+exports.isUpsCarrier = carrier.isUpsCarrier;
+exports.isUspsCarrier = carrier.isUspsCarrier;
+exports.isYodelCarrier = carrier.isYodelCarrier;
+exports.convertDimensions = dimensions.convertDimensions;
+exports.formatDimensions = dimensions.formatDimensions;
+exports.getCustomsFromSalesOrder = salesOrder.getCustomsFromSalesOrder;
+exports.getIsCustomsRequiredForSalesOrder = salesOrder.getIsCustomsRequiredForSalesOrder;
+exports.getRequestedServices = salesOrder.getRequestedServices;
+exports.getSalesOrderItemsFromSalesOrderOrShipment = salesOrder.getSalesOrderItemsFromSalesOrderOrShipment;
+exports.getCancelledShipment = shipment.getCancelledShipment;
+exports.getIsCustomsRequiredForShipment = shipment.getIsCustomsRequiredForShipment;
+exports.getIsInternationalShipment = shipment.getIsInternationalShipment;
+exports.getPendingShipment = shipment.getPendingShipment;
+exports.getShipmentByStatus = shipment.getShipmentByStatus;
+exports.moveCustomsItemsToProducts = shipment.moveCustomsItemsToProducts;
+exports.convertDecimalWeightToFractionalWeight = weight.convertDecimalWeightToFractionalWeight;
+exports.convertFractionalWeightToDecimalWeight = weight.convertFractionalWeightToDecimalWeight;
+exports.convertPoundsAndOuncesToOunces = weight.convertPoundsAndOuncesToOunces;
+exports.convertWeight = weight.convertWeight;
+exports.formatFractionalWeight = weight.formatFractionalWeight;
+exports.isDecimalWeight = weight.isDecimalWeight;
+exports.isMetricWeightUnit = weight.isMetricWeightUnit;
+exports.isFlatRatePackageCode = _package.isFlatRatePackageCode;
+exports.getDefaultWarehouse = warehouses.getDefaultWarehouse;
+exports.getWarehouseById = warehouses.getWarehouseById;
+exports.getInsuranceProviderWithFriendlyName = insurance.getInsuranceProviderWithFriendlyName;
+exports.getIsInsuraceProviderAccepted = insurance.getIsInsuraceProviderAccepted;

package/cjs/utilities/shipengine/insurance.cjs

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var insuranceProviderMetadatas = require('../../data/insurance-provider-metadatas.cjs');
+
+/**
+ * @internal
+ *
+ * # Insurance Utilities - getInsuranceProviderWithFriendlyName
+ *
+ * @category Utilities
+ */
+const getInsuranceProviderWithFriendlyName = termType => {
+  return insuranceProviderMetadatas["default"][termType];
+};
+/**
+ * @internal
+ *
+ * # Insurance Utilities - getIsInsuraceProviderAccepted
+ *
+ * @category Utilities
+ */
+const getIsInsuraceProviderAccepted = (termType, acceptedTerms) => {
+  return !!(acceptedTerms === null || acceptedTerms === void 0 ? void 0 : acceptedTerms.map(t => t.termType).includes(termType));
+};
+
+exports.getInsuranceProviderWithFriendlyName = getInsuranceProviderWithFriendlyName;
+exports.getIsInsuraceProviderAccepted = getIsInsuraceProviderAccepted;

package/cjs/utilities/shipengine/package.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @internal
+ *
+ * # Package Utilities - isFlatRatePackageCode
+ *
+ * @category Utilities
+ */
+const isFlatRatePackageCode = packageCode => {
+  return packageCode ? packageCode.includes("flat_rate") : false;
+};
+
+exports.isFlatRatePackageCode = isFlatRatePackageCode;

package/cjs/utilities/shipengine/sales-order.cjs

@@ -0,0 +1,92 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var address = require('./address.cjs');
+
+/**
+ * @internal
+ *
+ * # Sales Order Utilities - getCustomsFromSalesOrder
+ *
+ * @category Utilities
+ */
+const getCustomsFromSalesOrder = (salesOrder, originAddress) => ({
+  customs: {
+    contents: "merchandise",
+    nonDelivery: "return_to_sender"
+  },
+  products: salesOrder.salesOrderItems.filter(item => item.salesOrderItemId.length > 0).map(item => ({
+    countryOfOrigin: originAddress.countryCode,
+    description: item.lineItemDetails.name || "---",
+    quantity: item.quantity || 1,
+    sku: item.lineItemDetails.sku,
+    value: {
+      amount: item.priceSummary.unitPrice.amount,
+      currency: item.priceSummary.unitPrice.currency
+    }
+  }))
+});
+/**
+ * @internal
+ *
+ * # Sales Order Utilities - getIsCustomsRequiredForSalesOrder
+ *
+ * @category Utilities
+ */
+const getIsCustomsRequiredForSalesOrder = ({
+  shipTo
+}, originAddress) => originAddress && address.isMilitaryAddress(originAddress) || shipTo && (address.isMilitaryAddress(shipTo) || address.isUnitedStatesTerritory(shipTo)) || (originAddress === null || originAddress === void 0 ? void 0 : originAddress.countryCode) !== (shipTo === null || shipTo === void 0 ? void 0 : shipTo.countryCode);
+/**
+ * @internal
+ *
+ * # Sales Order Utilities - getRequestedServices
+ *
+ * @category Utilities
+ */
+const getRequestedServices = salesOrder => {
+  var _a;
+  return Array.from(new Set((_a = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.salesOrderItems) === null || _a === void 0 ? void 0 : _a.filter(item => {
+    var _a;
+    return !!((_a = item.requestedShippingOptions) === null || _a === void 0 ? void 0 : _a.shippingService);
+  }).map(item => {
+    var _a;
+    return (_a = item.requestedShippingOptions) === null || _a === void 0 ? void 0 : _a.shippingService;
+  })));
+};
+/**
+ * @internal
+ *
+ * # Sales Order Utilities - getSalesOrderItemsFromSalesOrderOrShipment
+ *
+ * @category Utilities
+ */
+const getSalesOrderItemsFromSalesOrderOrShipment = ({
+  salesOrder,
+  shipment
+}) => {
+  var _a, _b;
+  return (_b = (_a = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.salesOrderItems.map(item => {
+    var _a;
+    return {
+      detail: `SKU ${item.lineItemDetails.sku}`,
+      name: item.lineItemDetails.name,
+      quantity: item.quantity,
+      // INFO: current issue with sales order sometimes returning null for requestedShippingOptions
+      // TODO: remove this conditional as normally this type is not optional
+      subDetail: (_a = item.requestedShippingOptions) === null || _a === void 0 ? void 0 : _a.shippingService,
+      subDetailValue: item.priceSummary.estimatedShipping,
+      totalValue: item.priceSummary.total,
+      value: item.priceSummary.unitPrice
+    };
+  })) !== null && _a !== void 0 ? _a : shipment === null || shipment === void 0 ? void 0 : shipment.items.map((item, i) => ({
+    detail: `SKU ${item.sku}`,
+    name: (item === null || item === void 0 ? void 0 : item.name) || `ITEM ${i}`,
+    quantity: item.quantity
+  }))) !== null && _b !== void 0 ? _b : [];
+};
+
+exports.getCustomsFromSalesOrder = getCustomsFromSalesOrder;
+exports.getIsCustomsRequiredForSalesOrder = getIsCustomsRequiredForSalesOrder;
+exports.getRequestedServices = getRequestedServices;
+exports.getSalesOrderItemsFromSalesOrderOrShipment = getSalesOrderItemsFromSalesOrderOrShipment;