@shipengine/elements 2.20.0 → 2.21.0

package/cjs/create-element/element/index.cjs

@@ -0,0 +1,11 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var element = require('./element.cjs');
+var useI18n = require('./hooks/use-i18n.cjs');
+
+
+
+exports.Element = element.Element;
+exports.useI18n = useI18n.useI18n;

package/cjs/create-element/error-boundary/error-boundary.cjs

@@ -0,0 +1,63 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var jsxRuntime = require('@emotion/react/jsx-runtime');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+
+class ErrorBoundary extends React__namespace.Component {
+  constructor(props) {
+    super(props);
+    this.state = {
+      error: undefined
+    };
+  }
+  componentDidCatch(error, context) {
+    error.stack = context.componentStack;
+    this.props.onError(error);
+    reactApi.logger.error({
+      error
+    }, error.message);
+    this.setState({
+      error
+    });
+  }
+  render() {
+    const {
+      fallback: Fallback,
+      children
+    } = this.props;
+    const {
+      error
+    } = this.state;
+    if (error) {
+      return jsxRuntime.jsx(Fallback, {
+        error: error
+      });
+    }
+    return children;
+  }
+}
+
+exports.ErrorBoundary = ErrorBoundary;

package/cjs/create-element/error-boundary/index.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var errorBoundary = require('./error-boundary.cjs');
+
+
+
+exports.ErrorBoundary = errorBoundary.ErrorBoundary;

package/cjs/create-element/index.cjs

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

package/cjs/data/carrier-metadatas.cjs

@@ -0,0 +1,88 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var aramex_au_walleted = {
+	name: "Aramex Australia"
+};
+var canada_post_walleted = {
+	name: "Canada Post"
+};
+var canpar_walleted = {
+	name: "Canpar"
+};
+var couriersplease_walleted = {
+	name: "CouriersPlease"
+};
+var dhl_express_worldwide = {
+	name: "DHL Express"
+};
+var dpd_germany_walleted = {
+	name: "DPD Germany"
+};
+var dpdwallet = {
+	name: "DPD"
+};
+var globalpost = {
+	name: "GlobalPost"
+};
+var hermes = {
+	name: "Evri"
+};
+var parcelguard = {
+	name: "ParcelGuard"
+};
+var purolator_walleted = {
+	name: "Purolator"
+};
+var sendle_walleted = {
+	name: "Sendle"
+};
+var stamps_com = {
+	name: "USPS"
+};
+var ups_walleted = {
+	name: "UPS"
+};
+var x_cover = {
+	name: "XCover"
+};
+var yodel_walleted = {
+	name: "Yodel"
+};
+var _carrierMetadata = {
+	aramex_au_walleted: aramex_au_walleted,
+	canada_post_walleted: canada_post_walleted,
+	canpar_walleted: canpar_walleted,
+	couriersplease_walleted: couriersplease_walleted,
+	dhl_express_worldwide: dhl_express_worldwide,
+	dpd_germany_walleted: dpd_germany_walleted,
+	dpdwallet: dpdwallet,
+	globalpost: globalpost,
+	hermes: hermes,
+	parcelguard: parcelguard,
+	purolator_walleted: purolator_walleted,
+	sendle_walleted: sendle_walleted,
+	stamps_com: stamps_com,
+	ups_walleted: ups_walleted,
+	x_cover: x_cover,
+	yodel_walleted: yodel_walleted
+};
+
+exports.aramex_au_walleted = aramex_au_walleted;
+exports.canada_post_walleted = canada_post_walleted;
+exports.canpar_walleted = canpar_walleted;
+exports.couriersplease_walleted = couriersplease_walleted;
+exports["default"] = _carrierMetadata;
+exports.dhl_express_worldwide = dhl_express_worldwide;
+exports.dpd_germany_walleted = dpd_germany_walleted;
+exports.dpdwallet = dpdwallet;
+exports.globalpost = globalpost;
+exports.hermes = hermes;
+exports.parcelguard = parcelguard;
+exports.purolator_walleted = purolator_walleted;
+exports.sendle_walleted = sendle_walleted;
+exports.stamps_com = stamps_com;
+exports.ups_walleted = ups_walleted;
+exports.x_cover = x_cover;
+exports.yodel_walleted = yodel_walleted;

package/cjs/data/insurance-provider-metadatas.cjs

@@ -0,0 +1,20 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var parcelguard_terms = {
+	friendlyName: "ParcelGuard",
+	provider: "parcelguard"
+};
+var x_cover_terms = {
+	friendlyName: "XCover",
+	provider: "x_cover"
+};
+var _insuranceProviderMetadata = {
+	parcelguard_terms: parcelguard_terms,
+	x_cover_terms: x_cover_terms
+};
+
+exports["default"] = _insuranceProviderMetadata;
+exports.parcelguard_terms = parcelguard_terms;
+exports.x_cover_terms = x_cover_terms;

package/cjs/data/rate-messages.cjs

@@ -0,0 +1,99 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var usps_first_class_mail = [
+	"First Class Mail shipments must weigh less than {{weight}} oz. Shipments exceeding the weight entered when buying the label will be charged an adjustment fee by USPS."
+];
+var usps_ground_advantage = [
+	"USPS Ground Advantage™ service is an affordable and reliable way to send packages inside the U.S. expected in 2–5 business days for items up to 70 lbs."
+];
+var usps_media_mail = [
+	"Media Mail® can only be used for shipping books, sound recordings, manuscripts, printed music, and other media in packages weighing 70 lbs. or less. Packages containing unsupported items may be subject to post-billing adjustment fees or returned to the sender."
+];
+var usps_parcel_select = [
+	"Parcel Select Ground is a USPS mail class that offers ground delivery service at very low rates for large or heavy packages. When using this mail class, shipments can weigh up to 70lbs. and delivery ranges from 2–8 days."
+];
+var usps_priority_mail = [
+	"Priority (Delivery in 1-3 days on average for letters, envelopes, tubes and small packages 70 lbs. or less)."
+];
+var usps_priority_mail_express = [
+	"Priority Mail Express provides next-day to 2-day delivery service by 6 PM with a money-back guarantee."
+];
+var ups_ground_saver = [
+	"UPS® Ground Saver is an economy, residential, ground delivery service for packages up to 70lbs, shipping from 48 continental states. Delivers 7 days a week to all 50 states, PO Boxes, APO/FPO, and all US territories."
+];
+var ups_ground = [
+	"Ground (Delivery in 1-5 days, 150 lbs. or less)."
+];
+var ups_2nd_day_air = [
+	"2nd Day Air (Delivery by the end of the second business day, 150 lbs. or less)."
+];
+var ups_next_day_air_saver = [
+	"Next Day Air Saver (Delivery on next business day by end of day for residential destinations. Delivery on next business day by 3:00 or 4:30 pm where Next Day Air is committed by 10:30 am or 12:00 noon, respectively, for commercial destinations. 150 lbs. or less)."
+];
+var ups_next_day_air = [
+	"Next Day Air (Delivery by 10:30 a.m., 12:00 p.m. or end of next business day depending on destination, 150 lbs. or less)."
+];
+var ups_next_day_air_early_am = [
+	"Next Day Air Early (Delivery on next business day by 8:00 a.m. to major cities in the 48 contiguous states, 8:30 or 9:00 a.m. to most other U.S. cities (including Anchorage, Alaska), or 10:00 a.m. to additional locations. 150 lbs. or less)."
+];
+var ups_2nd_day_air_am = [
+	"2nd Day Air (Delivery on the second business day by 10:30 a.m. or 12:00 noon to most commercial destinations, 150 lbs. or less)."
+];
+var ups_3_day_select = [
+	"3 Day Select (Delivery by the end of the third business day, 150 lbs. or less)."
+];
+var rateMessages = {
+	"usps_first_class_mail:letter": [
+	"First Class Mail letter is not eligible for USPS tracking nor refund if unused. If the package weight exceeds the weight provided when buying the label, USPS will charge an adjustment fee."
+],
+	"usps_first_class_mail:large_envelope_or_flat": [
+	"Tracking and refunds are not available for First Class Mail Large Envelopes or Flats labels."
+],
+	usps_first_class_mail: usps_first_class_mail,
+	usps_ground_advantage: usps_ground_advantage,
+	usps_media_mail: usps_media_mail,
+	usps_parcel_select: usps_parcel_select,
+	usps_priority_mail: usps_priority_mail,
+	usps_priority_mail_express: usps_priority_mail_express,
+	ups_ground_saver: ups_ground_saver,
+	ups_ground: ups_ground,
+	ups_2nd_day_air: ups_2nd_day_air,
+	"ups_2nd_day_air:Saturday": [
+	"Additional fees may apply post-delivery if picked up on a Saturday."
+],
+	ups_next_day_air_saver: ups_next_day_air_saver,
+	"ups_next_day_air_saver:Saturday": [
+	"Additional fees may apply post-delivery if picked up on a Saturday."
+],
+	ups_next_day_air: ups_next_day_air,
+	"ups_next_day_air:Saturday": [
+	"Additional fees may apply post-delivery if picked up on a Saturday."
+],
+	ups_next_day_air_early_am: ups_next_day_air_early_am,
+	"ups_next_day_air_early_am:Saturday": [
+	"Additional fees may apply post-delivery if picked up on a Saturday."
+],
+	ups_2nd_day_air_am: ups_2nd_day_air_am,
+	"ups_2nd_day_air_am:Saturday": [
+	"Additional fees may apply post-delivery if picked up on a Saturday."
+],
+	ups_3_day_select: ups_3_day_select
+};
+
+exports["default"] = rateMessages;
+exports.ups_2nd_day_air = ups_2nd_day_air;
+exports.ups_2nd_day_air_am = ups_2nd_day_air_am;
+exports.ups_3_day_select = ups_3_day_select;
+exports.ups_ground = ups_ground;
+exports.ups_ground_saver = ups_ground_saver;
+exports.ups_next_day_air = ups_next_day_air;
+exports.ups_next_day_air_early_am = ups_next_day_air_early_am;
+exports.ups_next_day_air_saver = ups_next_day_air_saver;
+exports.usps_first_class_mail = usps_first_class_mail;
+exports.usps_ground_advantage = usps_ground_advantage;
+exports.usps_media_mail = usps_media_mail;
+exports.usps_parcel_select = usps_parcel_select;
+exports.usps_priority_mail = usps_priority_mail;
+exports.usps_priority_mail_express = usps_priority_mail_express;

package/cjs/elements/index.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var manageCarriers = require('./manage-carriers/manage-carriers.cjs');
+var manageWarehouses = require('./manage-warehouses/manage-warehouses.cjs');
+var purchaseLabel = require('./purchase-label/purchase-label.cjs');
+var manageExternalCarriers = require('./manage-external-carriers/manage-external-carriers.cjs');
+var labelsGrid = require('./labels-grid/labels-grid.cjs');
+var shipmentsGrid = require('./shipments-grid/shipments-grid.cjs');
+var themeCreatorProvider = require('./theme-creator/theme-creator-provider.cjs');
+var themeCreator = require('./theme-creator/theme-creator.cjs');
+var shipmentSummary = require('./shipment-summary/shipment-summary.cjs');
+var voidLabel = require('./void-label/void-label.cjs');
+var unitSettingsElement = require('./unit-settings/unit-settings-element.cjs');
+var manageFundingElement = require('./manage-funding/manage-funding-element.cjs');
+var selectLabelLayoutElement = require('./select-label-layout/select-label-layout-element.cjs');
+var paymentMethodSettingsElement = require('./payment-method-settings/payment-method-settings-element.cjs');
+var carrierServices = require('../workflows/carrier-services/carrier-services.cjs');
+var transactionHistoryElement = require('./transaction-history/transaction-history-element.cjs');
+
+
+
+exports.ManageCarriers = manageCarriers;
+exports.ManageWarehouses = manageWarehouses;
+exports.PurchaseLabel = purchaseLabel;
+exports.ManageExternalCarriers = manageExternalCarriers;
+exports.LabelsGrid = labelsGrid;
+exports.ShipmentsGrid = shipmentsGrid;
+exports.ThemeCreatorProvider = themeCreatorProvider.ThemeCreatorProvider;
+exports.useThemeCreator = themeCreatorProvider.useThemeCreator;
+exports.ThemeCreator = themeCreator;
+exports.ShipmentSummary = shipmentSummary;
+exports.VoidLabel = voidLabel;
+exports.UnitSettings = unitSettingsElement;
+exports.ManageFunding = manageFundingElement;
+exports.SelectLabelLayout = selectLabelLayoutElement;
+exports.PaymentMethodSettings = paymentMethodSettingsElement;
+exports.CarrierServices = carrierServices;
+exports.TransactionHistory = transactionHistoryElement;

package/cjs/elements/labels-grid/hooks/use-labels-grid.cjs

@@ -0,0 +1,212 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var react = require('@emotion/react');
+var useGetServiceName = require('../../../hooks/use-get-service-name.cjs');
+var React = require('react');
+var reactApi = require('@shipengine/react-api');
+var usePager = require('../../../components/pager/usePager.cjs');
+
+const PAGE_SIZE = 20;
+const useLabelsGrid = ({
+  createdDateSortBy,
+  labelStatus,
+  showShipmentIdFilter,
+  showLabelIdFilter,
+  showTrackingStatusFilter,
+  fetchShipments
+}) => {
+  var _a, _b, _c;
+  const initialFilters = {
+    labelId: {
+      enabled: !!showLabelIdFilter,
+      value: ""
+    },
+    shipmentId: {
+      enabled: !!showShipmentIdFilter,
+      value: ""
+    },
+    trackingStatus: {
+      enabled: !!showTrackingStatusFilter,
+      value: []
+    }
+  };
+  const theme = react.useTheme();
+  const {
+    getServiceName
+  } = useGetServiceName.useGetServiceName();
+  const {
+    page,
+    pageSize,
+    pagerProps
+  } = usePager.usePager(PAGE_SIZE);
+  const [filters, setFilters] = React.useState(initialFilters);
+  const clearAllFilters = () => {
+    setFilters(initialFilters);
+  };
+  // This will refresh the pagination when a filter is applied
+  const onSetFilters = newFilters => {
+    pagerProps.onPageSelect(1);
+    setFilters(newFilters);
+  };
+  const hasActiveFilterValue = value => {
+    if (value === null || value === undefined) {
+      return false;
+    }
+    if (Array.isArray(value)) {
+      return value.length > 0;
+    }
+    if (value !== null && typeof value === "object") {
+      return Object.keys(value).length > 0;
+    }
+    if (typeof value === "string") {
+      return value.trim() !== "";
+    }
+    return Boolean(value);
+  };
+  const isAnyFilterActive = Object.keys(filters).some(key => {
+    const filter = filters[key];
+    return (filter === null || filter === void 0 ? void 0 : filter.enabled) && hasActiveFilterValue(filter === null || filter === void 0 ? void 0 : filter.value);
+  });
+  const isAnyFilterEnabled = Object.keys(filters).some(key => {
+    const filter = filters[key];
+    return filter === null || filter === void 0 ? void 0 : filter.enabled;
+  });
+  React.useEffect(() => {
+    const updatedFilters = {
+      labelId: {
+        enabled: !!showLabelIdFilter,
+        value: ""
+      },
+      shipmentId: {
+        enabled: !!showShipmentIdFilter,
+        value: ""
+      },
+      trackingStatus: {
+        enabled: !!showTrackingStatusFilter,
+        value: []
+      }
+    };
+    setFilters(updatedFilters);
+  }, [showLabelIdFilter, showShipmentIdFilter, showTrackingStatusFilter]);
+  const {
+    data: listLabelsData,
+    isLoading: isListLabelsLoading,
+    isError: isListLabelsError
+  } = reactApi.useListLabels({
+    queryFnParams: {
+      labelStatus,
+      page,
+      pageSize,
+      shipmentId: filters.shipmentId.value || undefined,
+      sortDir: createdDateSortBy !== null && createdDateSortBy !== void 0 ? createdDateSortBy : "desc"
+    }
+  });
+  const labels = React.useMemo(() => {
+    if (!(listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.labels)) {
+      return [];
+    }
+    return listLabelsData.labels.filter(label => {
+      var _a, _b, _c, _d;
+      // Filter by tracking status
+      return !((_b = (_a = filters === null || filters === void 0 ? void 0 : filters.trackingStatus) === null || _a === void 0 ? void 0 : _a.value) === null || _b === void 0 ? void 0 : _b.length) ||
+      // Voided labels still have an in_transit tracking status, exclude them if the in_transit filter is selected
+      label.status !== "voided" && ((_c = filters === null || filters === void 0 ? void 0 : filters.trackingStatus) === null || _c === void 0 ? void 0 : _c.value.includes(label.trackingStatus)) ||
+      // We show voided labels under tracking status also, include them if the voided filter is selected
+      label.status === "voided" && ((_d = filters === null || filters === void 0 ? void 0 : filters.trackingStatus) === null || _d === void 0 ? void 0 : _d.value.includes(label.status));
+    }).map(label => Object.assign(Object.assign({}, label), {
+      bodyCellStyles: {
+        color: label.status === "voided" ? theme.palette.gray[400] : undefined
+      },
+      serviceName: getServiceName(label)
+    }));
+  }, [listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.labels, (_a = filters === null || filters === void 0 ? void 0 : filters.trackingStatus) === null || _a === void 0 ? void 0 : _a.value, theme.palette.gray, getServiceName]);
+  const {
+    data: listShipmentsData,
+    isFetching: isListShipmentsLoading,
+    isError: isListShipmentsError
+  } = reactApi.useListSalesOrderShipments({
+    // An empty array here should disable the query
+    shipmentIds: fetchShipments ? labels === null || labels === void 0 ? void 0 : labels.map(label => label.shipmentId) : []
+  });
+  const shouldShowFilters = isAnyFilterEnabled && (isAnyFilterActive || Boolean(labels === null || labels === void 0 ? void 0 : labels.length));
+  const {
+    data: labelFilterData,
+    isError: isLabelFilterError,
+    isInitialLoading: isLabelFilterLoading
+  } = reactApi.useGetLabel(((_b = filters.labelId) === null || _b === void 0 ? void 0 : _b.value) || undefined);
+  const isLabelFilterActive = (_c = filters.labelId) === null || _c === void 0 ? void 0 : _c.value;
+  const isStatusFilteredOut = (status, filter) => {
+    return (filter === null || filter === void 0 ? void 0 : filter.length) && !filter.includes(status);
+  };
+  const getLabelById = labelById => {
+    var _a, _b;
+    // Check if filter by label id is active and there are no errors
+    if (isLabelFilterActive && !isLabelFilterError) {
+      let labelPassFilters = true;
+      // Check if label filtered by id has same status if defined
+      if (labelStatus && labelStatus !== (labelById === null || labelById === void 0 ? void 0 : labelById.status)) {
+        labelPassFilters = false;
+      }
+      // Check if shipment filter has the same value if defined
+      if ((filters === null || filters === void 0 ? void 0 : filters.shipmentId.value) !== "" && (filters === null || filters === void 0 ? void 0 : filters.shipmentId.value) !== (labelById === null || labelById === void 0 ? void 0 : labelById.shipmentId)) {
+        labelPassFilters = false;
+      }
+      if (
+      // If Label status is voided and voided status is filtered out, don't show the label
+      (labelById === null || labelById === void 0 ? void 0 : labelById.status) === "voided" && isStatusFilteredOut("voided", (_a = filters.trackingStatus) === null || _a === void 0 ? void 0 : _a.value) ||
+      //  If Label status is not voided and tracking status is filtered out, don't show the label
+      (labelById === null || labelById === void 0 ? void 0 : labelById.status) !== "voided" && (labelById === null || labelById === void 0 ? void 0 : labelById.trackingStatus) && isStatusFilteredOut(labelById.trackingStatus, (_b = filters.trackingStatus) === null || _b === void 0 ? void 0 : _b.value)) {
+        labelPassFilters = false;
+      }
+      return labelPassFilters ? labelById : undefined;
+    }
+    return undefined;
+  };
+  const labelFilteredById = getLabelById(labelFilterData);
+  const labelFilteredByIdHasErrors = isLabelFilterActive && (isLabelFilterError || !labelFilteredById);
+  const getGridData = () => {
+    if (labelFilteredById) {
+      return [Object.assign(Object.assign({}, labelFilteredById), {
+        bodyCellStyles: {
+          color: labelFilteredById.status === "voided" ? theme.palette.gray[400] : undefined
+        },
+        serviceName: getServiceName(labelFilteredById)
+      })];
+    } else if (labelFilteredByIdHasErrors) {
+      return [];
+    } else if (labels && fetchShipments && listShipmentsData) {
+      return labels.map(label => {
+        const shipment = listShipmentsData === null || listShipmentsData === void 0 ? void 0 : listShipmentsData.find(shipment => shipment.shipmentId === label.shipmentId);
+        return Object.assign(Object.assign({}, label), {
+          shipmentNumber: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentNumber
+        });
+      });
+    } else if (labels) {
+      return labels;
+    }
+    return [];
+  };
+  return {
+    clearAllFilters,
+    filters,
+    getGridData,
+    isAnyFilterActive,
+    isError: isListLabelsError || isListShipmentsError && fetchShipments,
+    isLoading: isListLabelsLoading || isLabelFilterLoading || isListShipmentsLoading && fetchShipments,
+    labels,
+    pageConfig: {
+      currentPage: labelFilteredById ? 1 : (listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.page) || 0,
+      pagerProps,
+      pagesAmount: (listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.pages) || 0,
+      pageSize,
+      showPagination: labelFilteredById ? false : ((listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.total) || 0) > pageSize,
+      totalElements: labelFilteredById ? 1 : (listLabelsData === null || listLabelsData === void 0 ? void 0 : listLabelsData.total) || 0
+    },
+    setFilters: onSetFilters,
+    shouldShowFilters
+  };
+};
+
+exports.useLabelsGrid = useLabelsGrid;

package/cjs/elements/labels-grid/index.cjs

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var labelsGrid = require('./labels-grid.cjs');
+
+
+
+exports.LabelsGrid = labelsGrid;