@shipengine/alchemy 5.0.29 → 5.1.0

package/components/alchemy-provider/alchemy-provider.d.ts

@@ -1,5 +1,5 @@
 import { CustomThemeData, Theme } from "@shipengine/giger-theme";
-import { ShipEngineProps } from "@shipengine/react-api";
+import { ShipEngineAPIConfig, ShipEngineProps } from "@shipengine/react-api";
 export type AlchemyErrorHandler = (err: Error) => void;
 export type AlchemyContextValue = {
     baseURL: string;
@@ -12,17 +12,15 @@ export type AlchemyContextValue = {
     theme: Theme;
 };
 export declare const AlchemyContext: import("react").Context<AlchemyContextValue | undefined>;
-export interface AlchemyProviderProps {
-    baseURL?: string;
+export type AlchemyProviderProps = {
     cdnURL?: string;
     children: React.ReactNode;
     container?: HTMLElement;
-    getToken: ShipEngineProps["getToken"];
     locale?: string;
     onError?: AlchemyErrorHandler;
     /** Scope of the Alchemy Provider. Can be null to not specify a specific element */
     scope?: string | null;
     themeConfig?: CustomThemeData;
-}
-export declare const AlchemyProvider: ({ baseURL, cdnURL, container, children, getToken, locale: localeProp, onError, scope, themeConfig, }: AlchemyProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+} & ShipEngineAPIConfig;
+export declare const AlchemyProvider: ({ baseURL, cdnURL, container, children, getToken, locale: localeProp, onError, scope, themeConfig, onApiError, headers, }: AlchemyProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const useAlchemy: () => AlchemyContextValue;

package/index.js

@@ -11005,6 +11005,21 @@ class AddressesAPI {
 
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
+const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
+const parseError = (err) => {
+  var _a;
+  if (!((_a = err.response) == null ? void 0 : _a.data))
+    return [new CodedError(err.message)];
+  if (isDataCodedErrors(err.response.data)) {
+    return err.response.data.errors.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedErrors(err.response.data)) {
+    return err.response.data.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedError(err.response.data)) {
+    return [CodedError.fromObject(err.response.data)];
+  } else {
+    return [new CodedError(err.message)];
+  }
+};
 
 var axiosExports$1 = {};
 var axios$3 = {
@@ -13784,19 +13799,6 @@ class CarriersAPI {
         `/v1/carriers/${carrierId}/auto_funding`
       );
     };
-    /**
-     * The `getWalletHistory` method retrieves the wallet transaction history for
-     * a ShipEngine wallet account.
-     */
-    this.getWalletHistory = (startDate, endDate, page) => {
-      return this.client.get(`/v1/carriers/wallet_history`, {
-        params: {
-          endDate: endDate.toISOString(),
-          page,
-          startDate: startDate.toISOString()
-        }
-      });
-    };
     /**
      * The `getServices` method retrieves a list of shipping services that a given carrier offers.
      */
@@ -16583,6 +16585,7 @@ var __async$y = (__this, __arguments, generator) => {
   });
 };
 const logger$1 = E({
+  level: process.env.NODE_ENV === "production" ? "fatal" : "info",
   name: "shipengine-api",
   serializers: __spreadProps$2(__spreadValues$4({}, k), {
     req: (req) => ({
@@ -16604,9 +16607,8 @@ const logger$1 = E({
     }
   ]
 });
-const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken }) {
+  constructor(token, { baseURL, headers, getToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps$2(__spreadValues$4({}, headers), {
@@ -16657,7 +16659,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async$y(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         logger$1.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -16676,22 +16678,9 @@ class ShipEngineAPI {
           }
           return axios(config);
         }
-        if ((_g = err.response) == null ? void 0 : _g.data) {
-          if (isDataCodedErrors(err.response.data)) {
-            return Promise.reject(
-              err.response.data.errors.map((err2) => CodedError.fromObject(err2))
-            );
-          }
-          if (isCodedErrors(err.response.data)) {
-            return Promise.reject(err.response.data.map((err2) => CodedError.fromObject(err2)));
-          }
-          if (isCodedError(err.response.data)) {
-            return Promise.reject([CodedError.fromObject(err.response.data)]);
-          }
-          return Promise.reject([new CodedError(err.response.data)]);
-        } else {
-          return Promise.reject([new CodedError(err.message)]);
-        }
+        const codedErrors = parseError(err);
+        onApiError == null ? void 0 : onApiError(codedErrors, err);
+        return Promise.reject(codedErrors);
       })
     );
     this.client = client;
@@ -16855,21 +16844,29 @@ class ShipEngineAPI {
 }
 
 const ShipEngineContext = React.createContext(void 0);
-const ShipEngine = ({ baseURL, children, headers, getToken }) => {
+const ShipEngine = ({
+  baseURL,
+  children,
+  headers,
+  getToken,
+  onApiError
+}) => {
   const [client, setClient] = React.useState(() => {
     const token = getToken();
     if (typeof token === "string")
       return new ShipEngineAPI(token, {
         baseURL,
         getToken,
-        headers: headers != null ? headers : {}
+        headers: headers != null ? headers : {},
+        onApiError
       });
     token.then(
       (t) => setClient(
         new ShipEngineAPI(t, {
           baseURL,
           getToken,
-          headers: headers != null ? headers : {}
+          headers: headers != null ? headers : {},
+          onApiError
         })
       )
     );
@@ -16905,7 +16902,7 @@ const delay = (ms) => new Promise((resolve) => {
   setTimeout(() => resolve(true), ms);
 });
 
-const onError = (errors) => errors.forEach(console.log);
+const onError = (_errors) => _default();
 
 var __defProp$3 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
@@ -17335,24 +17332,6 @@ const useGetServicesByCarrier = (carrierId) => {
   });
 };
 
-const useGetWalletHistory = ({
-  enabled,
-  page,
-  range
-}) => {
-  const { client } = useShipEngine();
-  const [startDate, endDate] = range;
-  return reactQuery.useQuery({
-    enabled,
-    keepPreviousData: true,
-    // See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
-    onError,
-    queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
-    queryKey: ["useGetWalletHistory", startDate, endDate, page],
-    select: (result) => result.data
-  });
-};
-
 const useListCarriers = () => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -17595,8 +17574,8 @@ const useGetFundingSourceMetadata = () => {
 const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
+    enabled: !!fundingSourceId,
     keepPreviousData: true,
-    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -19087,7 +19066,9 @@ const AlchemyProvider = ({
   locale: localeProp,
   onError = _default,
   scope = "lmnt",
-  themeConfig
+  themeConfig,
+  onApiError,
+  headers
 }) => {
   const locale = localeProp || getDefaultLocale();
   const resolveIcon = useLoadIcons({ cdnURL });
@@ -19109,7 +19090,7 @@ const AlchemyProvider = ({
       cdnUrl: cdnURL,
       resolveIcon,
       theme,
-      children: /* @__PURE__ */ jsx(ShipEngine, { baseURL, getToken, children })
+      children: /* @__PURE__ */ jsx(ShipEngine, { baseURL, headers, getToken, onApiError, children })
     }
   ) });
 };
@@ -19825,8 +19806,10 @@ exports.getEmotionCache = getEmotionCache;
 exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;
 exports.isCodedErrors = isCodedErrors;
+exports.isDataCodedErrors = isDataCodedErrors;
 exports.logger = logger;
 exports.onError = onError;
+exports.parseError = parseError;
 exports.retryUntil = retryUntil;
 exports.useAddFunds = useAddFunds;
 exports.useAlchemy = useAlchemy;
@@ -19869,7 +19852,6 @@ exports.useGetShipmentRates = useGetShipmentRates;
 exports.useGetShippingRuleById = useGetShippingRuleById;
 exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
 exports.useGetThemeById = useGetThemeById;
-exports.useGetWalletHistory = useGetWalletHistory;
 exports.useGetZonesByCarrier = useGetZonesByCarrier;
 exports.useI18n = useI18n;
 exports.useListCarriers = useListCarriers;

package/index.mjs

@@ -10983,6 +10983,21 @@ class AddressesAPI {
 
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
+const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
+const parseError = (err) => {
+  var _a;
+  if (!((_a = err.response) == null ? void 0 : _a.data))
+    return [new CodedError(err.message)];
+  if (isDataCodedErrors(err.response.data)) {
+    return err.response.data.errors.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedErrors(err.response.data)) {
+    return err.response.data.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedError(err.response.data)) {
+    return [CodedError.fromObject(err.response.data)];
+  } else {
+    return [new CodedError(err.message)];
+  }
+};
 
 var axiosExports$1 = {};
 var axios$3 = {
@@ -13762,19 +13777,6 @@ class CarriersAPI {
         `/v1/carriers/${carrierId}/auto_funding`
       );
     };
-    /**
-     * The `getWalletHistory` method retrieves the wallet transaction history for
-     * a ShipEngine wallet account.
-     */
-    this.getWalletHistory = (startDate, endDate, page) => {
-      return this.client.get(`/v1/carriers/wallet_history`, {
-        params: {
-          endDate: endDate.toISOString(),
-          page,
-          startDate: startDate.toISOString()
-        }
-      });
-    };
     /**
      * The `getServices` method retrieves a list of shipping services that a given carrier offers.
      */
@@ -16561,6 +16563,7 @@ var __async$y = (__this, __arguments, generator) => {
   });
 };
 const logger$1 = E({
+  level: process.env.NODE_ENV === "production" ? "fatal" : "info",
   name: "shipengine-api",
   serializers: __spreadProps$2(__spreadValues$4({}, k), {
     req: (req) => ({
@@ -16582,9 +16585,8 @@ const logger$1 = E({
     }
   ]
 });
-const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken }) {
+  constructor(token, { baseURL, headers, getToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps$2(__spreadValues$4({}, headers), {
@@ -16635,7 +16637,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async$y(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         logger$1.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -16654,22 +16656,9 @@ class ShipEngineAPI {
           }
           return axios(config);
         }
-        if ((_g = err.response) == null ? void 0 : _g.data) {
-          if (isDataCodedErrors(err.response.data)) {
-            return Promise.reject(
-              err.response.data.errors.map((err2) => CodedError.fromObject(err2))
-            );
-          }
-          if (isCodedErrors(err.response.data)) {
-            return Promise.reject(err.response.data.map((err2) => CodedError.fromObject(err2)));
-          }
-          if (isCodedError(err.response.data)) {
-            return Promise.reject([CodedError.fromObject(err.response.data)]);
-          }
-          return Promise.reject([new CodedError(err.response.data)]);
-        } else {
-          return Promise.reject([new CodedError(err.message)]);
-        }
+        const codedErrors = parseError(err);
+        onApiError == null ? void 0 : onApiError(codedErrors, err);
+        return Promise.reject(codedErrors);
       })
     );
     this.client = client;
@@ -16833,21 +16822,29 @@ class ShipEngineAPI {
 }
 
 const ShipEngineContext = createContext(void 0);
-const ShipEngine = ({ baseURL, children, headers, getToken }) => {
+const ShipEngine = ({
+  baseURL,
+  children,
+  headers,
+  getToken,
+  onApiError
+}) => {
   const [client, setClient] = useState(() => {
     const token = getToken();
     if (typeof token === "string")
       return new ShipEngineAPI(token, {
         baseURL,
         getToken,
-        headers: headers != null ? headers : {}
+        headers: headers != null ? headers : {},
+        onApiError
       });
     token.then(
       (t) => setClient(
         new ShipEngineAPI(t, {
           baseURL,
           getToken,
-          headers: headers != null ? headers : {}
+          headers: headers != null ? headers : {},
+          onApiError
         })
       )
     );
@@ -16883,7 +16880,7 @@ const delay = (ms) => new Promise((resolve) => {
   setTimeout(() => resolve(true), ms);
 });
 
-const onError = (errors) => errors.forEach(console.log);
+const onError = (_errors) => _default();
 
 var __defProp$3 = Object.defineProperty;
 var __defProps$1 = Object.defineProperties;
@@ -17313,24 +17310,6 @@ const useGetServicesByCarrier = (carrierId) => {
   });
 };
 
-const useGetWalletHistory = ({
-  enabled,
-  page,
-  range
-}) => {
-  const { client } = useShipEngine();
-  const [startDate, endDate] = range;
-  return useQuery({
-    enabled,
-    keepPreviousData: true,
-    // See https://react-query-v3.tanstack.com/guides/paginated-queries#better-paginated-queries-with-keeppreviousdata
-    onError,
-    queryFn: () => client.carriers.getWalletHistory(startDate, endDate, page),
-    queryKey: ["useGetWalletHistory", startDate, endDate, page],
-    select: (result) => result.data
-  });
-};
-
 const useListCarriers = () => {
   const { client } = useShipEngine();
   return useQuery({
@@ -17573,8 +17552,8 @@ const useGetFundingSourceMetadata = () => {
 const useGetFundingSourceTransactions = (fundingSourceId, params) => {
   const { client } = useShipEngine();
   return useQuery({
+    enabled: !!fundingSourceId,
     keepPreviousData: true,
-    onError,
     queryFn: () => client.fundingSources.transactions(fundingSourceId, params),
     queryKey: ["useGetFundingSourceTransactions", fundingSourceId, params],
     select: (result) => result.data
@@ -19065,7 +19044,9 @@ const AlchemyProvider = ({
   locale: localeProp,
   onError = _default,
   scope = "lmnt",
-  themeConfig
+  themeConfig,
+  onApiError,
+  headers
 }) => {
   const locale = localeProp || getDefaultLocale();
   const resolveIcon = useLoadIcons({ cdnURL });
@@ -19087,7 +19068,7 @@ const AlchemyProvider = ({
       cdnUrl: cdnURL,
       resolveIcon,
       theme,
-      children: /* @__PURE__ */ jsx(ShipEngine, { baseURL, getToken, children })
+      children: /* @__PURE__ */ jsx(ShipEngine, { baseURL, headers, getToken, onApiError, children })
     }
   ) });
 };
@@ -19760,4 +19741,4 @@ const alchemy = {
   createElement
 };
 
-export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEmotionCache, getEndUserIpAddress, isCodedError, isCodedErrors, logger, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetWalletHistory, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useLoadIcons, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEmotionCache, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, logger, onError, parseError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useLoadIcons, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/alchemy",
-  "version": "5.0.29",
+  "version": "5.1.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {