@shipengine/elements 2.22.0 → 2.24.1

package/esm/hooks/use-page-layout.js

@@ -1,80 +0,0 @@
-import { jsx, jsxs } from '@emotion/react/jsx-runtime';
-import { createContext, useRef, useState, useContext } from 'react';
-import { Portal } from '../components/portal/portal.js';
-
-const PageLayoutContext = /*#__PURE__*/createContext(undefined);
-PageLayoutContext.displayName = "PageLayoutContext";
-/**
- * @internal
- *
- * # Page Layout Component
- *
- * @see {@link PageLayoutProviderProps | The props passed into the `<PageLayoutProvider />` component}
- */
-const PageLayoutProvider = ({
-  children
-}) => {
-  const headerRef = useRef(null);
-  const footerRef = useRef(null);
-  // eslint-disable-next-line react/hook-use-state -- We don't need a setter
-  const [layoutPortals] = useState({
-    FooterPortal: p => jsx(Portal, Object.assign({
-      target: footerRef
-    }, {
-      children: p.children
-    })),
-    HeaderPortal: p => jsx(Portal, Object.assign({
-      target: headerRef
-    }, {
-      children: p.children
-    }))
-  });
-  return jsx(PageLayoutContext.Provider, Object.assign({
-    value: layoutPortals
-  }, {
-    children: jsxs("div", Object.assign({
-      css: {
-        display: "flex",
-        flexDirection: "column",
-        height: "100%"
-      }
-    }, {
-      children: [jsx("div", {
-        css: {
-          flexShrink: 0
-        },
-        id: "page-layout-header",
-        ref: headerRef
-      }), jsx("div", Object.assign({
-        css: {
-          overflow: "scroll"
-        },
-        id: "page-layout-content"
-      }, {
-        children: children
-      })), jsx("div", {
-        css: {
-          flexShrink: 0
-        },
-        id: "page-layout-footer",
-        ref: footerRef
-      })]
-    }))
-  }));
-};
-/**
- * @internal
- *
- * # Page Layout Hook
- *
- * @category Hooks
- */
-const usePageLayout = () => {
-  const layoutPortals = useContext(PageLayoutContext);
-  if (!layoutPortals) {
-    throw new Error("usePageLayout must be called from within the scope of PageLayoutProvider");
-  }
-  return layoutPortals;
-};
-
-export { PageLayoutProvider, usePageLayout };

package/esm/hooks/use-replace-support-email.js

@@ -1,37 +0,0 @@
-import { useElements } from '../elements-provider/elements-context-provider.js';
-
-/**
- * Hook that provides functions to replace support email in error messages
- * using the configured support email address from feature flags
- *
- * @returns Functions to replace support email in error messages
- */
-const useReplaceSupportEmail = () => {
-  const {
-    globalFeatures
-  } = useElements();
-  const supportEmail = globalFeatures.supportEmailAddress || "platform@shipengine.com";
-  // Replace support email in a single string
-  const replaceEmailInString = text => {
-    // Replace both support@shipengine.com and support@shipstation.com with the configured email
-    return text.replace(/support@shipengine\.com/g, supportEmail).replace(/support@shipstation\.com/g, supportEmail);
-  };
-  // Replace support email in a single error object
-  const replaceEmailInError = error => {
-    return Object.assign(Object.assign({}, error), {
-      message: replaceEmailInString(error.message)
-    });
-  };
-  // Replace support email in an array of errors
-  const replaceEmailInErrors = errors => {
-    if (!errors || errors.length === 0) return undefined;
-    return errors.map(replaceEmailInError);
-  };
-  return {
-    replaceEmailInError,
-    replaceEmailInErrors,
-    replaceEmailInString
-  };
-};
-
-export { useReplaceSupportEmail };

package/esm/hooks/use-root-portal.js

@@ -1,62 +0,0 @@
-import { jsx } from '@emotion/react/jsx-runtime';
-import { createContext, useMemo, useContext } from 'react';
-
-const RootPortalContext = /*#__PURE__*/createContext(undefined);
-RootPortalContext.displayName = "RootPortalContext";
-/**
- * @internal
- *
- * # Root Portal Provider
- *
- * Provides access to a top-level 'root-portal' DOM node, adjacent the app 'root' div
- *
- * @category Providers
- *
- * @see {@link useRootPortal | The associated `hook` for this provider}
- */
-const RootPortalProvider = ({
-  children,
-  emotionCacheShadowRootContainer
-}) => {
-  const rootPortal = useMemo(() => {
-    if (emotionCacheShadowRootContainer) {
-      return emotionCacheShadowRootContainer;
-    } else {
-      let rootPortal = document.getElementById("root-portal");
-      if (!rootPortal) {
-        rootPortal = document.createElement("div");
-        rootPortal.setAttribute("id", "root-portal");
-        document.body.appendChild(rootPortal);
-      }
-      return rootPortal;
-    }
-  }, [emotionCacheShadowRootContainer]);
-  return jsx(RootPortalContext.Provider, Object.assign({
-    value: rootPortal
-  }, {
-    children: children
-  }));
-};
-/**
- * @internal
- *
- * # Root Portal Provider Hook
- *
- * The `useRootPortal` hook provides access to a top-level 'root-portal' DOM node, adjacent
- * the app 'root' div.
- *
- * -  Must be used within {@link RootPortalProvider | a `<RootPortalProvider />`}
- *
- * @category Elements Hooks
- *
- * @see {@link RootPortalProvider | The associated `provider` for this hook}
- */
-const useRootPortal = () => {
-  const rootPortal = useContext(RootPortalContext);
-  if (!rootPortal) {
-    throw new Error("useRootPortal must be called from within the scope of RootPortalProvider");
-  }
-  return rootPortal;
-};
-
-export { RootPortalProvider, useRootPortal };

package/esm/hooks/use-run-once-on-true.js

@@ -1,23 +0,0 @@
-import { useRef, useEffect } from 'react';
-
-/**
- * @internal
- *
- * # Run Once On True Hook
- *
- * - Runs a callback once and only once when a condition is true.
- *
- * @param conditionalEffect A logical expression ending with a callback
- * @example useRunOnceOnTrue(testValue && anotherTestValue && (() => console.log("Hello world!")));
- */
-const useRunOnceOnTrue = conditionalEffect => {
-  const hasRunRef = useRef(false);
-  useEffect(() => {
-    if (typeof conditionalEffect === "function" && !hasRunRef.current) {
-      hasRunRef.current = true;
-      conditionalEffect();
-    }
-  }, [conditionalEffect]);
-};
-
-export { useRunOnceOnTrue };

package/esm/hooks/use-scrub-errors.js

@@ -1,32 +0,0 @@
-import { encode } from 'js-base64';
-import { useMemo } from 'react';
-import { useTranslation } from 'react-i18next';
-
-/**
- * @internal
- *
- * # Scrub Errors Hook
- *
- * Generic error pretty printer
- *
- * @category Hooks
- */
-const useScrubErrors = ({
-  scrubber,
-  errors,
-  predicate
-}) => {
-  const {
-    t
-  } = useTranslation();
-  return useMemo(() => errors === null || errors === void 0 ? void 0 : errors.map(e => {
-    return t(encode(e.message), {
-      defaultValue: !predicate || predicate(e) ? t(scrubber(e)) : networkErrorPrettyPrinter(e)
-    });
-  }), [errors, predicate, scrubber, t]);
-};
-const networkErrorPrettyPrinter = e => {
-  return e.message.replaceAll(/Invalid rate\. Invalid rate\./g, "Invalid rate.");
-};
-
-export { useScrubErrors };

package/esm/hooks/use-sortable-query.js

@@ -1,32 +0,0 @@
-import { useState } from 'react';
-
-const useSortableQuery = ({
-  defaultSortBy: _defaultSortBy = "modified_at",
-  defaultSortDir: _defaultSortDir = "desc"
-}) => {
-  const [sortState, setSortState] = useState({
-    by: _defaultSortBy,
-    createdAtDir: _defaultSortDir,
-    dir: _defaultSortDir,
-    modifiedAtDir: _defaultSortDir
-  });
-  const toggleSort = sortQuery => {
-    const newSortState = Object.assign({}, sortState);
-    if (sortQuery === "created_at") {
-      newSortState.createdAtDir = sortState.createdAtDir === "asc" ? "desc" : "asc";
-      newSortState.dir = newSortState.createdAtDir;
-      newSortState.by = "created_at";
-    } else if (sortQuery === "modified_at") {
-      newSortState.modifiedAtDir = sortState.modifiedAtDir === "asc" ? "desc" : "asc";
-      newSortState.dir = newSortState.modifiedAtDir;
-      newSortState.by = "modified_at";
-    }
-    setSortState(newSortState);
-  };
-  return {
-    sortState,
-    toggleSort
-  };
-};
-
-export { useSortableQuery };

package/esm/hooks/use-toggle.js

@@ -1,20 +0,0 @@
-import { useReducer } from 'react';
-
-/**
- * @internal
- *
- * # Toggle Hook
- *
- * - Create a boolean that can be toggled or set to a specific value
- *
- * @example
- * ```tsx
- * const [isOn, toggle] = useToggle();
- * toggle(); // isOn = true
- * toggle(); // isOn = false
- * toggle(false); // isOn = false
- * ```
- */
-const useToggle = (initialValue = false) => useReducer((prev, next) => next !== undefined && typeof next !== "object" ? next : !prev, initialValue);
-
-export { useToggle };

package/esm/index.js

@@ -1,54 +0,0 @@
-export * from '@shipengine/react-api';
-export { createStyles, scopeTheme } from './utilities/styles.js';
-export { getDefaultFeatures } from './utilities/feature-flags/feature-flags.js';
-export { getSellerIdFromToken, isOnboarded, validateShipFromAddress } from './utilities/checks.js';
-export { Country, UsState, UsaCity, addressNameRegex, countries, countryCodes, euCountryCodes, postalCodeRegex, usCities, usStateCodes, usStates } from './constants/shipengine/address.js';
-import * as manageCarriers from './elements/manage-carriers/manage-carriers.js';
-export { manageCarriers as ManageCarriers };
-import * as manageWarehouses from './elements/manage-warehouses/manage-warehouses.js';
-export { manageWarehouses as ManageWarehouses };
-import * as purchaseLabel from './elements/purchase-label/purchase-label.js';
-export { purchaseLabel as PurchaseLabel };
-import * as manageExternalCarriers from './elements/manage-external-carriers/manage-external-carriers.js';
-export { manageExternalCarriers as ManageExternalCarriers };
-import * as labelsGrid from './elements/labels-grid/labels-grid.js';
-export { labelsGrid as LabelsGrid };
-import * as shipmentsGrid from './elements/shipments-grid/shipments-grid.js';
-export { shipmentsGrid as ShipmentsGrid };
-export { ThemeCreatorProvider, useThemeCreator } from './elements/theme-creator/theme-creator-provider.js';
-import * as themeCreator from './elements/theme-creator/theme-creator.js';
-export { themeCreator as ThemeCreator };
-import * as shipmentSummary from './elements/shipment-summary/shipment-summary.js';
-export { shipmentSummary as ShipmentSummary };
-import * as voidLabel from './elements/void-label/void-label.js';
-export { voidLabel as VoidLabel };
-import * as unitSettingsElement from './elements/unit-settings/unit-settings-element.js';
-export { unitSettingsElement as UnitSettings };
-import * as manageFundingElement from './elements/manage-funding/manage-funding-element.js';
-export { manageFundingElement as ManageFunding };
-import * as selectLabelLayoutElement from './elements/select-label-layout/select-label-layout-element.js';
-export { selectLabelLayoutElement as SelectLabelLayout };
-import * as paymentMethodSettingsElement from './elements/payment-method-settings/payment-method-settings-element.js';
-export { paymentMethodSettingsElement as PaymentMethodSettings };
-import * as carrierServices from './workflows/carrier-services/carrier-services.js';
-export { carrierServices as CarrierServices };
-import * as transactionHistoryElement from './elements/transaction-history/transaction-history-element.js';
-export { transactionHistoryElement as TransactionHistory };
-export { useAddressValidation } from './hooks/use-address-validation.js';
-export { useHelpers } from './hooks/use-helpers.js';
-export { useConfigureShipment } from './hooks/use-configure-shipment.js';
-export { useImportSalesOrder } from './hooks/use-import-sales-order.js';
-export { useBalanceServices } from './hooks/use-balance-services.js';
-export { CanadaDeliveredDutyOptions } from './types/canada-ddp.js';
-export { PudoType } from './types/pudo.js';
-import * as onboarding from './workflows/onboarding/onboarding.js';
-export { onboarding as Onboarding };
-import * as labelWorkflow from './workflows/label-workflow/label-workflow.js';
-export { labelWorkflow as LabelWorkflow };
-import * as accountSettings from './workflows/account-settings/account-settings.js';
-export { accountSettings as AccountSettings };
-import * as connectExternalCarrier from './workflows/connect-external-carrier/connect-external-carrier.js';
-export { connectExternalCarrier as ConnectExternalCarrier };
-export { ElementsContext, ElementsContextProvider, useElements } from './elements-provider/elements-context-provider.js';
-export { ElementsProvider } from './elements-provider/elements-provider.js';
-export { ElementsTestProvider } from './elements-provider/elements-test-provider.js';