@shipengine/elements 2.20.0 → 2.21.0

package/cjs/utilities/shipengine/shipment.cjs

@@ -0,0 +1,94 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var date = require('../date.cjs');
+var address = require('./address.cjs');
+
+/**
+ * @internal
+ *
+ * # Shipment Utilities - getIsInternationalShipment
+ *
+ * @category Utilities
+ */
+const getIsInternationalShipment = ({
+  shipFrom,
+  shipTo
+}) => (shipFrom === null || shipFrom === void 0 ? void 0 : shipFrom.countryCode) !== (shipTo === null || shipTo === void 0 ? void 0 : shipTo.countryCode);
+/**
+ * @internal
+ *
+ * # Shipment Utilities - getIsCustomsRequiredForShipment
+ *
+ * @category Utilities
+ */
+const getIsCustomsRequiredForShipment = ({
+  shipFrom,
+  shipTo
+}) => shipFrom && address.isMilitaryAddress(shipFrom) || shipTo && (address.isMilitaryAddress(shipTo) || address.isUnitedStatesTerritory(shipTo)) || (shipFrom === null || shipFrom === void 0 ? void 0 : shipFrom.countryCode) !== (shipTo === null || shipTo === void 0 ? void 0 : shipTo.countryCode);
+/**
+ * @internal
+ *
+ * @deprecated please use getShipmentByStatus instead
+ * # Shipment Utilities - getPendingShipment
+ *
+ * @category Utilities
+ */
+const getPendingShipment = shipments => shipments === null || shipments === void 0 ? void 0 : shipments.filter(s => s.shipmentStatus === "pending").sort(date.sortByCreationDate)[0];
+/**
+ *
+ * @deprecated please use getShipmentByStatus instead
+ * @internal
+ * @param shipments
+ * @returns the latest created shipment whose status is `cancelled`
+ */
+const getCancelledShipment = shipments => shipments === null || shipments === void 0 ? void 0 : shipments.filter(shipment => shipment.shipmentStatus === "cancelled").sort(date.sortByCreationDate)[0];
+/**
+ *
+ * @param status string containing one of the following values - "pending", "processing", "label_purchased", "cancelled"
+ * @param shipments optional list of shipments to filter from
+ * @returns latest created shipment whose shipmentStatus matches the param status
+ */
+const getShipmentByStatus = (status, shipments) => shipments === null || shipments === void 0 ? void 0 : shipments.filter(({
+  shipmentStatus
+}) => shipmentStatus === status).sort(date.sortByCreationDate)[0];
+/**
+ * @internal
+ *
+ * # Shipment Utilities - map customsItems to products and delete customsItems from the customs object
+ *
+ * @category Utilities
+ * @param shipment
+ * @returns the shipment with customsItems moved to products
+ * @see https://www.shipengine.com/docs/shipping/international/#the-customs-object:~:text=New%20products%20array%20replaces%20the%20customs_items%20array
+ */
+const moveCustomsItemsToProducts = shipment => {
+  var _a, _b;
+  if (!((_b = (_a = shipment.customs) === null || _a === void 0 ? void 0 : _a.customsItems) === null || _b === void 0 ? void 0 : _b.length)) return shipment;
+  const productsFromCustomsItems = shipment.customs.customsItems.map(item => {
+    return Object.assign(Object.assign({}, item), {
+      value: item.value instanceof Object ? item.value : {
+        amount: item.value,
+        currency: item.valueCurrency || "USD"
+      }
+    });
+  });
+  const _c = shipment.customs,
+    restCustoms = tslib.__rest(_c, ["customsItems"]);
+  const updatedShipment = Object.assign(Object.assign({}, shipment), {
+    customs: restCustoms,
+    packages: shipment.packages.map((pkg, index) => index === 0 ? Object.assign(Object.assign({}, pkg), {
+      products: productsFromCustomsItems
+    }) : pkg)
+  });
+  return updatedShipment;
+};
+
+exports.getCancelledShipment = getCancelledShipment;
+exports.getIsCustomsRequiredForShipment = getIsCustomsRequiredForShipment;
+exports.getIsInternationalShipment = getIsInternationalShipment;
+exports.getPendingShipment = getPendingShipment;
+exports.getShipmentByStatus = getShipmentByStatus;
+exports.moveCustomsItemsToProducts = moveCustomsItemsToProducts;

package/cjs/utilities/shipengine/warehouses.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const getDefaultWarehouse = warehouses => {
+  return warehouses === null || warehouses === void 0 ? void 0 : warehouses.find(w => w.isDefault);
+};
+const getWarehouseById = (warehouseId, warehouses) => {
+  return warehouses === null || warehouses === void 0 ? void 0 : warehouses.find(w => w.warehouseId === warehouseId);
+};
+
+exports.getDefaultWarehouse = getDefaultWarehouse;
+exports.getWarehouseById = getWarehouseById;

package/cjs/utilities/shipengine/weight.cjs

@@ -0,0 +1,160 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @internal
+ *
+ * # Weight Utilities - isMetricWeightUnit
+ *
+ * - This utility function checks if the weight unit is `metric` and returns a `boolean`
+ * indicating if it is metric or not.
+ *
+ * @param unit The weight unit to check (optional).
+ *
+ * @returns boolean Indicating if the weight unit is `metric`.
+ *
+ * @category Utilities
+ */
+const isMetricWeightUnit = unit => !!unit && ["gram", "kilogram"].includes(unit);
+/**
+ * @internal
+ *
+ * # Weight Utilities - isDecimalWeight
+ *
+ * - This utility function checks if the weight is a `decimal` weight and returns a `boolean`
+ * indicating if it is decimal or not.
+ *
+ * @param weight The weight to `check for a decimal` (optional).
+ *
+ * @returns boolean Indicating if the weight is a decimal weight.
+ *
+ * @category Utilities
+ */
+const isDecimalWeight = weight => "value" in weight;
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertPoundsAndOuncesToOunces
+ *
+ * - This utility function converts `pounds and ounces` to a `total of ounces`.
+ *
+ * @param weight The `pound + ounce` weight to convert to ounces.
+ *
+ * @returns number The total weight in `ounces`.
+ *
+ * @category Utilities
+ */
+const convertPoundsAndOuncesToOunces = weight => {
+  var _a, _b;
+  const pounds = (_a = weight.whole) !== null && _a !== void 0 ? _a : 0;
+  const ounces = (_b = weight.fractional) !== null && _b !== void 0 ? _b : 0;
+  return pounds * 16 + ounces;
+};
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertFractionalWeightToDecimalWeight
+ *
+ * - This utility function converts a `fractional weight` to a `decimal weight`.
+ *
+ * @param weight The fractional weight to convert to a decimal weight.
+ * @param unit The target weight unit to convert to (optional).
+ *
+ * @returns WeightWithUnit The decimal weight with its unit.
+ *
+ * @category Utilities
+ */
+const convertFractionalWeightToDecimalWeight = (weight, unit) => isMetricWeightUnit(unit) ? {
+  unit,
+  value: weight.whole
+} : {
+  unit: "ounce",
+  value: convertPoundsAndOuncesToOunces(weight)
+};
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertDecimalWeightToFractionalWeight
+ *
+ * - This utility function converts a `decimal weight` to a `fractional weight`.
+ *
+ * @param weight The decimal weight to convert to a fractional weight.
+ *
+ * @returns FractionalWeight The converted fractional weight.
+ *
+ * @category Utilities
+ */
+const convertDecimalWeightToFractionalWeight = weight => {
+  // ex. 1.5 lbs = 1 lb 8 oz
+  if (weight.unit === "pound") {
+    const pounds = Math.floor(weight.value);
+    const ounces = Math.round((weight.value - pounds) * 16 * 100) / 100;
+    return {
+      fractional: ounces,
+      whole: pounds
+    };
+  }
+  // ex. 24 oz = 1 lb 8 oz
+  if (weight.unit === "ounce") {
+    const pounds = Math.floor(weight.value / 16);
+    const ounces = weight.value % 16;
+    return {
+      fractional: ounces,
+      whole: pounds
+    };
+  }
+  // return the weight as the whole weight - g/kg do not need to be converted to fractional/whole
+  return {
+    fractional: 0,
+    whole: weight.value
+  };
+};
+/**
+ * @internal
+ *
+ * # Weight Utilities - convertWeight/2
+ */
+function convertWeight(weight, unit) {
+  return isDecimalWeight(weight) ? convertDecimalWeightToFractionalWeight(weight) : convertFractionalWeightToDecimalWeight(weight, unit);
+}
+/**
+ * @internal
+ *
+ * # Weight Utilities - formatFractionalWeight
+ *
+ * - This utility function formats a `fractional weight` for ease of use.
+ *
+ * @param weight The fractional weight to be formatted.
+ *
+ * @return FractionalWeight The formatted fractional weight.
+ *
+ * @category Utilities
+ */
+function formatFractionalWeight(weight, unit) {
+  if (!weight) return {
+    fractional: 0,
+    whole: 0
+  };
+  //allow up to 5 decimal places for metric weights
+  if (isMetricWeightUnit(unit) && weight.whole) {
+    return {
+      fractional: 0,
+      whole: Number(weight.whole.toFixed(5)) || 0
+    };
+  }
+  const valueAsOz = convertPoundsAndOuncesToOunces(weight);
+  const valueAsLbs = valueAsOz / 16;
+  return {
+    fractional: Math.round((valueAsLbs - Math.floor(valueAsLbs)) * 16 * 100) / 100,
+    whole: Math.floor(valueAsLbs)
+  };
+}
+
+exports.convertDecimalWeightToFractionalWeight = convertDecimalWeightToFractionalWeight;
+exports.convertFractionalWeightToDecimalWeight = convertFractionalWeightToDecimalWeight;
+exports.convertPoundsAndOuncesToOunces = convertPoundsAndOuncesToOunces;
+exports.convertWeight = convertWeight;
+exports.formatFractionalWeight = formatFractionalWeight;
+exports.isDecimalWeight = isDecimalWeight;
+exports.isMetricWeightUnit = isMetricWeightUnit;

package/cjs/utilities/storybook-local-storage-config.cjs

@@ -0,0 +1,30 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const getLocalStorageConfig = () => {
+  try {
+    const config = window.localStorage.getItem("config");
+    if (config) {
+      return JSON.parse(config);
+    } else {
+      return undefined;
+    }
+  } catch (error) {
+    console.log(error);
+    return undefined;
+  }
+};
+const setLocalStorageConfig = config => {
+  try {
+    const storedConfig = getLocalStorageConfig();
+    if (typeof window !== "undefined") {
+      window.localStorage.setItem("config", JSON.stringify(Object.assign(Object.assign({}, storedConfig), config)));
+    }
+  } catch (error) {
+    console.log(error);
+  }
+};
+
+exports.getLocalStorageConfig = getLocalStorageConfig;
+exports.setLocalStorageConfig = setLocalStorageConfig;

package/cjs/utilities/styles.cjs

@@ -0,0 +1,40 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var giger = require('@shipengine/giger');
+
+/**
+ * @internal
+ *
+ * Creates a Record of Emotion styles; eliminating the need to explicitly type styles
+ * while remaining fully typesafe w/ autocomplete.
+ *
+ * Keys prefixed with `get` are assumed to be getters and support arbitrary props.
+ *
+ * Values may be any variant of `Interpolation` that the `css` prop can accept:
+ * a `CSSObject`, `SerializedStyles`, a `FunctionInterpolation` with theme, etc.
+ *
+ * @example
+ * ```
+ * const styles = createStyles({
+ *   basicObject: { color: "red" },
+ *   withTheme: (theme) => ({ backgroundColor: theme.palette.primary.main }),
+ *
+ *   getWithArbitraryPropsAndTheme: (disabled?: boolean) => (theme) => ({
+ *     color: theme.palette[disabled ? 'primary' : 'gray'].main,
+ *   }),
+ * });
+ * ```
+ *
+ * @category Utilities
+ */
+const createStyles = styles => {
+  return styles;
+};
+const scopeTheme = theme => {
+  return theme && giger.THEME_ID in theme ? theme[giger.THEME_ID] : theme;
+};
+
+exports.createStyles = createStyles;
+exports.scopeTheme = scopeTheme;

package/cjs/utilities/tracking-formatter.cjs

@@ -0,0 +1,32 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+// Match this https://www.shipengine.com/docs/tracking/#tracking-status-codes where applicable
+const trackingStatusFormatter = status => {
+  switch (status) {
+    case "in_transit":
+      return "In Transit";
+    case "error":
+      return "Exception";
+    case "delivered":
+      return "Delivered";
+    case "unknown":
+      return "Unknown";
+    default:
+      return undefined;
+  }
+};
+/**
+ * @internal
+ *
+ * # Format Tracking Number Utility Function
+ *
+ * - This is a utility function that formats the tracking number to display only the last 25 characters, in reverse truncated fashion as the last numbers of a tracking number are the most unique/important.
+ */
+const formatTrackingNumber = trackingNumber => {
+  return trackingNumber.length > 25 ? `...${trackingNumber.slice(-25)}` : trackingNumber;
+};
+
+exports.formatTrackingNumber = formatTrackingNumber;
+exports.trackingStatusFormatter = trackingStatusFormatter;

package/cjs/utilities/validation.cjs

@@ -0,0 +1,79 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var zod$1 = require('@hookform/resolvers/zod');
+var zod = require('zod');
+var formLogger = require('./form-logger.cjs');
+
+const buildError = (translationKey, error) => {
+  const meta = tslib.__rest(error, ["code", "message", "path"]);
+  return JSON.stringify(Object.assign({
+    message: translationKey
+  }, meta));
+};
+/**
+ * @internal
+ *
+ * # Error Map
+ *
+ * @category Utilities
+ */
+const errorMap = (issue, ctx) => {
+  let messageCode;
+  // TODO - Fill in the rest of the codes (positive, max, etc)
+  switch (issue.code) {
+    // Invalid Type
+    case zod.z.ZodIssueCode.invalid_type:
+      switch (issue.received) {
+        case "null":
+        case "undefined":
+          messageCode = ctx.defaultError.includes("schemaErrors") ? ctx.defaultError : "schemaErrors.required";
+          break;
+      }
+      break;
+    case zod.z.ZodIssueCode.invalid_string:
+      messageCode = "schemaErrors.invalidString";
+      break;
+    case zod.z.ZodIssueCode.too_small:
+      switch (issue.type) {
+        case "number":
+          if (issue.minimum === 0) {
+            messageCode = issue.inclusive ? "schemaErrors.nonnegative" : "schemaErrors.positive";
+          }
+          break;
+        case "string":
+          messageCode = buildError("schemaErrors.tooFewCharacters", issue);
+          break;
+      }
+      break;
+    case zod.z.ZodIssueCode.too_big:
+      switch (issue.type) {
+        case "string":
+          messageCode = buildError("schemaErrors.tooManyCharacters", issue);
+          break;
+      }
+      break;
+  }
+  return {
+    message: messageCode !== null && messageCode !== void 0 ? messageCode : ctx.defaultError
+  };
+};
+/**
+ * @internal
+ *
+ * # Validation Resolver
+ *
+ * @category Utilities
+ */
+const validationResolver = (schema, sensitiveValues) => (values, _context, resolverOptions) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+  const getValidationResult = () => zod$1.zodResolver(schema, {
+    errorMap
+  })(values, undefined, resolverOptions);
+  const validationResult = yield formLogger.formLogger.isSubmitting ? formLogger.formLogger.log(getValidationResult, sensitiveValues) : getValidationResult();
+  return validationResult;
+});
+
+exports.errorMap = errorMap;
+exports.validationResolver = validationResolver;

package/cjs/utilities/vat.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const NO_VAT_COUNTRIES = ["US", "CA", "AU"];
+/**
+ * Product logic.
+ * “Tax settings” hidden outside Europe.
+ */
+const getIsVatRequired = countryCode => {
+  const country = countryCode !== null && countryCode !== void 0 ? countryCode : "";
+  return !NO_VAT_COUNTRIES.includes(country);
+};
+
+exports.NO_VAT_COUNTRIES = NO_VAT_COUNTRIES;
+exports.getIsVatRequired = getIsVatRequired;

package/cjs/workflows/account-settings/account-settings.cjs

@@ -0,0 +1,112 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var react = require('@emotion/react');
+var jsxRuntime = require('@emotion/react/jsx-runtime');
+var vat = require('../../utilities/vat.cjs');
+var reactApi = require('@shipengine/react-api');
+var useGetPanelProps = require('./use-get-panel-props.cjs');
+var manageWarehouses = require('../../features/manage-warehouses/manage-warehouses.cjs');
+var unitSettings = require('../../features/unit-settings/unit-settings.cjs');
+var vatSettings = require('../../features/vat-settings/vat-settings.cjs');
+var modalContainer = require('../../components/modal/modal-container.cjs');
+var index = require('../../locales/en/index.cjs');
+var elementsContextProvider = require('../../elements-provider/elements-context-provider.cjs');
+var carrierServices = require('../carrier-services/carrier-services.cjs');
+var manageExternalCarriers = require('../../features/manage-external-carriers/manage-external-carriers.cjs');
+var selectLabelLayout = require('../../features/select-label-layout/select-label-layout.cjs');
+var spacer = require('../../components/spacer/spacer.cjs');
+var collapsiblePanel = require('../../components/collapsible-panel/collapsible-panel.cjs');
+var poweredByShipengine = require('../../components/powered-by-shipengine/powered-by-shipengine.cjs');
+var createElement = require('../../create-element/create-element.cjs');
+var errorFallback = require('../../components/error-fallback/error-fallback.cjs');
+
+const Component = ({
+  features,
+  onRedirectToOnboarding
+}) => {
+  var _a;
+  const {
+    globalFeatures,
+    getFeatures
+  } = elementsContextProvider.useElements();
+  const fundingSourceMetadata = reactApi.useGetFundingSourceMetadata();
+  const fundingSourceRegion = (_a = fundingSourceMetadata.data) === null || _a === void 0 ? void 0 : _a.defaultRegionProfile.countryCode;
+  const isVatRequiredCountry = vat.getIsVatRequired(fundingSourceRegion);
+  const defaultFeatures = getFeatures("accountSettingsFeatures");
+  features = Object.assign(Object.assign({}, defaultFeatures), features !== null && features !== void 0 ? features : {});
+  const {
+    getSettingPanelProps
+  } = useGetPanelProps.useGetPanelProps(features);
+  /* eslint-disable sort-keys-fix/sort-keys-fix */
+  const commonSettings = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, features.showCarrierServices ? {
+    CarrierServices: carrierServices.Component
+  } : {}), features.showExternalCarriers ? {
+    ExternalCarriers: manageExternalCarriers.ExternalCarriers
+  } : {}), features.showManageWarehouses ? {
+    ManageWarehouses: manageWarehouses.ManageWarehouses
+  } : {}), features.showLabelLayout ? {
+    SelectLabelLayout: selectLabelLayout.Settings
+  } : {}), features.showUnitSettings ? {
+    UnitSettings: unitSettings.UnitSettings
+  } : {});
+  // ENGINE-7366: TODO Remove feature flag once this is fully in production
+  const settings = globalFeatures.showVatSettings && features.showVatSettings && isVatRequiredCountry ? Object.assign(Object.assign({}, commonSettings), {
+    VatSettings: vatSettings.VatSettings
+  }) : commonSettings;
+  return jsxRuntime.jsx("main", {
+    children: jsxRuntime.jsxs(modalContainer.ModalContainer, {
+      children: [jsxRuntime.jsx(spacer.Spacer, {
+        multiplier: 1
+      }), Object.keys(settings).map((setting, index) => {
+        const [panelProps, settingProps] = getSettingPanelProps(setting);
+        const Setting = settings[setting];
+        if (setting === "CarrierServices") {
+          return react.createElement(collapsiblePanel.CollapsiblePanel, Object.assign({}, panelProps, {
+            key: index
+          }), jsxRuntime.jsx(Setting, Object.assign({}, settingProps, {
+            onRedirectToOnboarding: onRedirectToOnboarding
+          })));
+        }
+        return react.createElement(collapsiblePanel.CollapsiblePanel, Object.assign({}, panelProps, {
+          key: index
+        }), jsxRuntime.jsx(Setting, Object.assign({}, settingProps)));
+      }), globalFeatures.poweredByShipEngine && jsxRuntime.jsxs(jsxRuntime.Fragment, {
+        children: [jsxRuntime.jsx(spacer.Spacer, {}), jsxRuntime.jsx(poweredByShipengine.PoweredByShipEngine, {})]
+      })]
+    })
+  });
+};
+/**
+ * # Registered Account Settings Element
+ *
+ * - This is the registered `<AccountSettings />` element that will be used to render the
+ * `<AccountSettings.Element />` component.
+ *
+ * @param ElementProps The props, callbacks, and resources necessary to render
+ * the `<AccountSettings.Element />` component.
+ *
+ * @example
+ * The `<Component />` is the source JSX that is rendered when you make use of the `AccountSettings`
+ * Element directly. Here is a brief example of how you would use it within your application.
+ * ```tsx
+ * <AccountSettings.Element/>
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link AccountSettings.ComponentProps | The **props** that can be passed into the `<AccountSettings.Element />` component}
+ * @see {@link CarrierServices.Element | The `<CarrierServices />` component used to view connected carriers and manage funding}
+ * @see {@link ManageWarehouses.Component | The `<ManageWarehouses />` component used to add, update, or remove warehouses}
+ * @see {@link PaymentMethodSettings | The `<PaymentMethodSettings />` component used to manage payment methods}
+ * @see {@link ManageFunding | The `<ManageFunding />` component used to manage funding rules and add funds to a carrier account}
+ */
+const Element = createElement.createElement(Component, errorFallback.ErrorFallback, {
+  resources: {
+    en: index
+  }
+});
+
+exports.Component = Component;
+exports.Element = Element;

package/cjs/workflows/account-settings/account-settings.styles.cjs

@@ -0,0 +1,15 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var styles$1 = require('../../utilities/styles.cjs');
+
+const styles = styles$1.createStyles({
+  modalHeadingStyles: theme => ({
+    color: styles$1.scopeTheme(theme).palette.gray.main,
+    fontWeight: styles$1.scopeTheme(theme).typography.fontWeight.bold,
+    paddingLeft: styles$1.scopeTheme(theme).spacing(4)
+  })
+});
+
+exports.styles = styles;

package/cjs/workflows/account-settings/index.cjs

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