@shipengine/elements 2.20.0 → 2.22.0

package/cjs/utilities/date.cjs

@@ -0,0 +1,223 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var format = require('date-fns/format');
+var locale = require('date-fns/locale');
+var parse = require('date-fns/parse');
+
+/**
+ * @internal
+ *
+ * # Date Utils - Formats a date to the current locale
+ *
+ * @category Utilities
+ */
+const formatDate = (date, locale = "en-US") => new Date(date).toLocaleDateString(locale, {
+  day: "numeric",
+  month: "long",
+  year: "numeric"
+});
+/**
+ * @internal
+ * Get the locale data for a given locale string.
+ * @param locale string i.e. "en-US"
+ * @returns locale data
+ */
+const findDateLocale = (locale$1 = "en-US") => {
+  const loadableLocale = locale$1.replaceAll("-", "");
+  const rootLocale = locale$1.split("-")[0];
+  const Locales = {
+    ca: locale.ca,
+    de: locale.de,
+    enAU: locale.enAU,
+    enGB: locale.enGB,
+    enUS: locale.enUS,
+    es: locale.es,
+    fr: locale.fr,
+    it: locale.it,
+    pt: locale.pt
+  };
+  const targetLocale = loadableLocale in Locales ? loadableLocale : rootLocale;
+  return Locales[targetLocale];
+};
+/**
+ * @internal
+ * Given a date and a locale, format the date to the locale's date format.
+ * @param date
+ * @param locale string i.e. "en-US"
+ * @param dateFormat string. See https://date-fns.org/v3.3.1/docs/format
+ * @returns formatted date string
+ */
+const formatByDateAndLocale = (date, locale = "en-US", dateFormat) => {
+  const localeData = findDateLocale(locale);
+  const localeDateFormat = getlocaleDateStringFormat(locale);
+  return format.format(date, dateFormat !== null && dateFormat !== void 0 ? dateFormat : localeDateFormat, {
+    locale: localeData
+  });
+};
+/**
+ * @internal
+ * Parse a string in the CURRENT locale into a Date object.
+ * @param date string
+ * @param locale
+ * @returns date
+ */
+const parseLocaleDate = (date, locale = "en-US", dateFormat = "P") => {
+  const localeData = findDateLocale(locale);
+  return parse.parse(date, dateFormat, new Date(), {
+    locale: localeData
+  });
+};
+/**
+ * @internal
+ *
+ * # Date Utils - formatDateDDMMYY
+ *
+ * @category Utilities
+ */
+const formatDateDDMMYY = (date, locale = "en-US") => new Date(date).toLocaleDateString(locale, {
+  day: "2-digit",
+  month: "2-digit",
+  year: "2-digit"
+});
+/**
+ * @internal
+ *
+ * # Date Utils - formatDateDDMMYYYY
+ *
+ * @category Utilities
+ */
+const formatDateDDMMYYYY = (date, locale = "en-US") => new Date(date).toLocaleDateString(locale, {
+  day: "2-digit",
+  month: "2-digit",
+  year: "numeric"
+});
+/**
+ * @internal
+ *
+ * Get the date format in the current locale i.e., "MM/DD/YYYY"
+ *
+ * @category Utilities
+ * @returns Date format as string
+ */
+const getlocaleDateStringFormat = (locale = "en-US") => {
+  var _a;
+  const localeData = findDateLocale(locale) || findDateLocale("en-US");
+  const dateFormatString = (_a = localeData.formatLong) === null || _a === void 0 ? void 0 : _a.date({
+    width: "short"
+  });
+  return dateFormatString;
+};
+/**
+ * @internal
+ *
+ * # Date Utils - Get the date a number of days after a given date
+ *
+ * @category Utilities
+ */
+const daysAfter = (days, date = new Date()) => {
+  date = new Date(date);
+  date.setDate(date.getDate() + days);
+  return date;
+};
+/**
+ * @internal
+ *
+ * # Date Utils - Get a cutoff date for a given date or the current date
+ *
+ * @category Utilities
+ */
+const nextDayCutoff = (cutoff, date = new Date()) => date.getHours() >= cutoff ? daysAfter(1, new Date(date)) : new Date(date);
+/**
+ * @internal
+ *
+ * # Date Utils - get the most recent date from a list of dates
+ *
+ * @category Utilities
+ */
+const mostRecent = (...dates) => new Date(Math.max(...dates.map(Number)));
+/**
+ * @internal
+ *
+ * # Date Utils - Given a date, return a new date with the time set to 00:00:00
+ *
+ * @category Utilities
+ */
+const omitTime = shipDate => {
+  const date = shipDate ? new Date(shipDate) : new Date();
+  return new Date(date.getUTCFullYear(), date.getUTCMonth(), date.getUTCDate());
+};
+/**
+ * @internal
+ *
+ * # Date Utils - getExpirationYears
+ *
+ * @category Utilities
+ */
+const getExpirationYears = yearsValid => {
+  const currentYear = new Date().getFullYear();
+  const years = [];
+  for (let i = 0; i < yearsValid; i++) {
+    years.push(`${currentYear + i}`);
+  }
+  return years;
+};
+/**
+ * @internal
+ *
+ * # Date Utilities - sortByCreationDate
+ *
+ * @category Utilities
+ */
+const sortByCreationDate = (a, b, order = "desc") => {
+  const [x, y] = order === "asc" ? [a, b] : [b, a];
+  return new Date(x.createdAt).getTime() - new Date(y.createdAt).getTime();
+};
+/**
+ * @internal
+ *
+ * # Date Utilities - isNowOrInTheFuture
+ *
+ * @category Utilities
+ */
+const isNowOrInTheFuture = date => {
+  if (date) {
+    return (typeof date === "string" ? new Date(date) : date) >= new Date();
+  }
+  return false;
+};
+/**
+ * @internal
+ *
+ * # Date Utilities - getRelativeDates
+ *
+ * @category Utilities
+ */
+const getRelativeDates = from => {
+  const origin = from !== null && from !== void 0 ? from : new Date();
+  return {
+    firstDayOfMonth: new Date(origin.getFullYear(), origin.getMonth(), 1),
+    lastDayOfTheMonth: new Date(origin.getFullYear(), origin.getMonth() + 1, 0),
+    origin,
+    previousMonthFirstDay: new Date(origin.getFullYear(), origin.getMonth() - 1, 1),
+    previousMonthLastDay: new Date(origin.getFullYear(), origin.getMonth() - 1 + 1, 0),
+    thirtyDaysAgo: new Date(new Date().setDate(origin.getDate() - 30))
+  };
+};
+
+exports.daysAfter = daysAfter;
+exports.findDateLocale = findDateLocale;
+exports.formatByDateAndLocale = formatByDateAndLocale;
+exports.formatDate = formatDate;
+exports.formatDateDDMMYY = formatDateDDMMYY;
+exports.formatDateDDMMYYYY = formatDateDDMMYYYY;
+exports.getExpirationYears = getExpirationYears;
+exports.getRelativeDates = getRelativeDates;
+exports.getlocaleDateStringFormat = getlocaleDateStringFormat;
+exports.isNowOrInTheFuture = isNowOrInTheFuture;
+exports.mostRecent = mostRecent;
+exports.nextDayCutoff = nextDayCutoff;
+exports.omitTime = omitTime;
+exports.parseLocaleDate = parseLocaleDate;
+exports.sortByCreationDate = sortByCreationDate;

package/cjs/utilities/error.cjs

@@ -0,0 +1,55 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var axios = require('axios');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
+
+/**
+ * @internal
+ *
+ * # Create Coded Errors Utlity Function
+ *
+ * - This function extracts errors from our `Axios Responses`.
+ *
+ * @category Utilities
+ */
+const createCodedErrors = err => {
+  var _a;
+  if (axios__default["default"].isAxiosError(err)) {
+    return (_a = err.response) === null || _a === void 0 ? void 0 : _a.data;
+  }
+  return [{
+    errorCode: "unknown",
+    errorSource: "elements",
+    errorType: "unknown",
+    message: err.message
+  }];
+};
+/**
+ * @internal
+ *
+ * - Joins a list of error-like object's messages and throws them as a single error.
+ *
+ * @category Utilities
+ */
+function throwJoinedMessages(errors) {
+  throw new Error(errors.map(e => e.message).join(", "));
+}
+/**
+ * @internal
+ *
+ * - If any CodedErrors exist, throw them all as a single error, otherwise assert errors is null.
+ *
+ * @category Utilities
+ */
+function throwAny(errors) {
+  if (errors) throwJoinedMessages(errors);
+}
+
+exports.createCodedErrors = createCodedErrors;
+exports.throwAny = throwAny;
+exports.throwJoinedMessages = throwJoinedMessages;

package/cjs/utilities/feature-flags/feature-flags.cjs

@@ -0,0 +1,119 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var get = require('lodash/get.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var get__default = /*#__PURE__*/_interopDefaultLegacy(get);
+
+const defaultLabelsGridColumns = [{
+  allowFilter: true,
+  name: "labelId"
+}, {
+  allowFilter: false,
+  name: "trackingStatus"
+}, {
+  name: "recipient"
+}, {
+  name: "shippingService"
+}, {
+  name: "createdDate"
+}];
+const defaultFeatureFlags = {
+  accountSettingsFeatures: {
+    enableFunding: true,
+    showCarrierServices: true,
+    showExternalCarriers: false,
+    showLabelLayout: true,
+    showManageWarehouses: true,
+    showUnitSettings: true,
+    showVatSettings: true
+  },
+  globalFeatures: {
+    disableShadowDOM: false,
+    enableParcelGuard: true,
+    isSandbox: false,
+    poweredByShipEngine: true,
+    showVatSettings: false,
+    supportEmailAddress: "platform@shipengine.com"
+  },
+  labelsGridFeatures: {
+    columns: defaultLabelsGridColumns,
+    showActions: true
+  },
+  purchaseLabelFeatures: {
+    betaEnableWindsorFramework: false,
+    compatibleCountryCodes: ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"],
+    enableErrorWhenShipmentCancelled: false,
+    partnerMessages: {
+      incompleteLabelPurchaseRequirements: undefined
+    },
+    rateForm: {
+      enableFunding: true,
+      enablePudoUI: false,
+      labelLayout: false,
+      nicknameRate: true,
+      requireDhlTermsAcknowledgement: false,
+      saveRate: true
+    },
+    shipmentForm: {
+      addOns: true,
+      browseRates: true,
+      includeCarrierInsurance: false,
+      includeShipsuranceInsurance: true,
+      includeThirdPartyInsurance: false,
+      selectService: true,
+      shippingPresets: false,
+      useWarehouses: true
+    }
+  },
+  shipmentSummaryFeatures: {
+    schedulePickup: true
+  }
+};
+/**
+ * @internal
+ *
+ * # Feature Flags - featureFlagComponentNameLookup
+ */
+const featureFlagComponentNameLookup = componentName => {
+  var _a;
+  const lookup = {
+    PurchaseLabel: "ConfigureSalesOrderShipment"
+  };
+  return (_a = lookup[componentName]) !== null && _a !== void 0 ? _a : "";
+};
+/**
+ * @internal
+ *
+ * # Feature Flags - getFeatures
+ */
+const getDefaultFeatures = elements => {
+  return elements.map(feat => get__default["default"](defaultFeatureFlags, feat)).reduce((acc, feat) => Object.assign(acc, feat));
+};
+const isObject = item => item !== null && typeof item === "object" && !Array.isArray(item);
+function deepMergeFeatures(defaults, custom) {
+  const features = Object.assign({}, defaults);
+  if (isObject(defaults) && isObject(custom)) {
+    Object.keys(custom).forEach(key => {
+      if (isObject(custom[key])) {
+        if (!features[key]) Object.assign(features, {
+          [key]: {}
+        });
+        features[key] = deepMergeFeatures(features[key], custom[key]);
+      } else {
+        Object.assign(features, {
+          [key]: custom[key]
+        });
+      }
+    });
+  }
+  return features;
+}
+
+exports.deepMergeFeatures = deepMergeFeatures;
+exports.featureFlagComponentNameLookup = featureFlagComponentNameLookup;
+exports.getDefaultFeatures = getDefaultFeatures;
+exports.isObject = isObject;

package/cjs/utilities/feature-flags/index.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var featureFlags = require('./feature-flags.cjs');
+var utils = require('./utils.cjs');
+
+
+
+exports.deepMergeFeatures = featureFlags.deepMergeFeatures;
+exports.featureFlagComponentNameLookup = featureFlags.featureFlagComponentNameLookup;
+exports.getDefaultFeatures = featureFlags.getDefaultFeatures;
+exports.isObject = featureFlags.isObject;
+exports.isShippingServiceServiceDisabled = utils.isShippingServiceServiceDisabled;

package/cjs/utilities/feature-flags/types.cjs

@@ -0,0 +1,2 @@
+'use strict';
+

package/cjs/utilities/feature-flags/utils.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const isShippingServiceServiceDisabled = (service, disabledShippingServices) => {
+  if (!disabledShippingServices) return false;
+  const disabledServiceCodes = disabledShippingServices[service.carrierCode];
+  if (!disabledServiceCodes) return false;
+  return disabledServiceCodes.includes(service.serviceCode);
+};
+
+exports.isShippingServiceServiceDisabled = isShippingServiceServiceDisabled;

package/cjs/utilities/form-logger.cjs

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var tslib = require('tslib');
+var reactApi = require('@shipengine/react-api');
+
+/**
+ * @internal
+ *
+ * # Form Logger
+ *
+ * @description
+ * This will log the values that are submitted to the validation resolver
+ * (only REGISTERED form fields) and the results of that validation.
+ *
+ * @usage Wrap the submission:
+ * `<form onSubmit={formLogger.capture(handleSubmit)}>`
+ *
+ * @category Utilities
+ */
+const formLogger = {
+  capture(handleSubmit) {
+    return e => {
+      // Prevent parent form submission in nested forms. This shouldn't be necessary, but React's
+      // event bubbling doesn't handle the formId target properly when passed through a portal.
+      e === null || e === void 0 ? void 0 : e.stopPropagation();
+      this.isSubmitting = true;
+      void handleSubmit(e);
+      this.isSubmitting = false;
+    };
+  },
+  isSubmitting: false,
+  log: (getValidationResult, sensitiveValues) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+    const validationResult = yield getValidationResult();
+    if (Object.keys(validationResult.errors).length) reactApi.logger.error({
+      obj: validationResult.errors
+    }, "Validation failed. Errors object:");else reactApi.logger.info({
+      obj: sanitizeValues(validationResult.values, sensitiveValues)
+    }, "Validation passed. Final payload after defaults & transforms:");
+    return validationResult;
+  })
+};
+/**
+ * @internal
+ *
+ * # Sanitize Values
+ *
+ * @description
+ * Helper function to sanitize sensitive values
+ *
+ * @category Utilities
+ */
+const sanitizeValues = (values, fieldsToHide) => {
+  if (typeof values !== "object" || !fieldsToHide || fieldsToHide.length === 0) return values;
+  return Object.fromEntries(Object.entries(values).map(([key, value]) => fieldsToHide.includes(key) ? [key, "[REDACTED]"] : [key, value]));
+};
+
+exports.formLogger = formLogger;

package/cjs/utilities/formatString.cjs

@@ -0,0 +1,33 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var humps = require('humps');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var humps__default = /*#__PURE__*/_interopDefaultLegacy(humps);
+
+/**
+ * @internal
+ *
+ * # Capitalize First Letter Utility Function
+ *
+ * - This is a utility function that `capitalizes` the first letter of a given string.
+ */
+const capitalizeFirstLetter = str => str.slice(0, 1).toUpperCase() + str.slice(1);
+const capitalizeFirstLetterOfEachWord = str => {
+  const words = str.split(" ");
+  return words.map(word => capitalizeFirstLetter(word.toLowerCase())).join(" ");
+};
+const pascalize = str => humps__default["default"].pascalize(str);
+const replaceSpacesWithDashes = str => str === null || str === void 0 ? void 0 : str.replace(/\s+/g, "-").toLowerCase();
+const addSpaceBetweenWords = str => str.replace(/([a-z])([A-Z])/g, "$1 $2") // add space if there is a lowercase letter followed by an uppercase letter
+.replace(/(?<=[a-zA-Z])(\d)/g, " $1") // add space if there is a letter followed by a number
+.trim();
+
+exports.addSpaceBetweenWords = addSpaceBetweenWords;
+exports.capitalizeFirstLetter = capitalizeFirstLetter;
+exports.capitalizeFirstLetterOfEachWord = capitalizeFirstLetterOfEachWord;
+exports.pascalize = pascalize;
+exports.replaceSpacesWithDashes = replaceSpacesWithDashes;

package/cjs/utilities/index.cjs

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var styles = require('./styles.cjs');
+var checks = require('./checks.cjs');
+var featureFlags = require('./feature-flags/feature-flags.cjs');
+
+
+
+exports.createStyles = styles.createStyles;
+exports.scopeTheme = styles.scopeTheme;
+exports.getSellerIdFromToken = checks.getSellerIdFromToken;
+exports.isOnboarded = checks.isOnboarded;
+exports.validateShipFromAddress = checks.validateShipFromAddress;
+exports.getDefaultFeatures = featureFlags.getDefaultFeatures;

package/cjs/utilities/money.cjs

@@ -0,0 +1,107 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var reactApi = require('@shipengine/react-api');
+
+/**
+ * @internal
+ *
+ * # Money Utils - currency Symbol
+ */
+const currencySymbol = {
+  aud: "$",
+  cad: "$",
+  eur: "€",
+  gbp: "£",
+  nzd: "$",
+  usd: "$"
+};
+/**
+ * @internal
+ *
+ * # Money Utils - formatMoney
+ */
+const formatMoney = (value, locale = "en-US") => {
+  const currency = Intl.NumberFormat(locale, {
+    currency: value.currency,
+    style: "currency"
+  });
+  return currency.format(value.amount);
+};
+/**
+ * @internal
+ *
+ * # Money Utils - calculateTotal
+ */
+const calculateTotal = (...values) => {
+  return values.reduce((total, value) => {
+    var _a;
+    return value ? total + ((_a = value.amount) !== null && _a !== void 0 ? _a : 0) : total;
+  }, 0);
+};
+/**
+ * @internal
+ *
+ * # Money Utils - formatCreditCardNumber
+ */
+const formatCreditCardNumber = cc => [cc.substring(0, 4), cc.substring(4, 8), cc.substring(8, 12), cc.substring(12)].join(" ").trim();
+/**
+ * @internal
+ *
+ * # Money Utils - formatExpiration
+ */
+const formatExpiration = exp => {
+  const digits = exp.replace(/\//g, "");
+  if (digits.length > 2) return [digits.substring(0, 2), digits.substring(2, 6)].join("/").trim();
+  return digits;
+};
+/**
+ * @internal
+ *
+ * # Money Utils - getCurrencyFromString
+ */
+const getCurrencyFromString = currency => {
+  switch (currency === null || currency === void 0 ? void 0 : currency.toLowerCase()) {
+    case "usd":
+      return reactApi.SE.Currency.USD;
+    case "cad":
+      return reactApi.SE.Currency.CAD;
+    case "aud":
+      return reactApi.SE.Currency.AUD;
+    case "gbp":
+      return reactApi.SE.Currency.GBP;
+    case "eur":
+      return reactApi.SE.Currency.EUR;
+    case "nzd":
+      return reactApi.SE.Currency.NZD;
+    default:
+      return reactApi.SE.Currency.USD;
+  }
+};
+const getCurrencySymbolFromString = currency => {
+  let currencySymbol = undefined;
+  switch (currency) {
+    case reactApi.SE.Currency.USD:
+    case reactApi.SE.Currency.CAD:
+    case reactApi.SE.Currency.AUD:
+    case reactApi.SE.Currency.NZD:
+      currencySymbol = "$";
+      break;
+    case reactApi.SE.Currency.GBP:
+      currencySymbol = "£‎";
+      break;
+    case reactApi.SE.Currency.EUR:
+      currencySymbol = "€";
+      break;
+  }
+  return currencySymbol;
+};
+
+exports.calculateTotal = calculateTotal;
+exports.currencySymbol = currencySymbol;
+exports.formatCreditCardNumber = formatCreditCardNumber;
+exports.formatExpiration = formatExpiration;
+exports.formatMoney = formatMoney;
+exports.getCurrencyFromString = getCurrencyFromString;
+exports.getCurrencySymbolFromString = getCurrencySymbolFromString;

package/cjs/utilities/predicates/index.cjs

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

package/cjs/utilities/predicates/isString.cjs

@@ -0,0 +1,14 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+/**
+ * @internal
+ *
+ * # String Predicate Utilities
+ *
+ * @category Utilities
+ */
+const isString = x => typeof x === "string";
+
+exports.isString = isString;