@shipengine/elements 0.37.4 → 0.37.20

package/index.cjs

@@ -14659,6 +14659,7 @@ const RateForm = ({
   carriers,
   disabled,
   displayableRateErrors,
+  displayableSaveRateErrors,
   errors,
   features,
   isLoading,
@@ -14791,6 +14792,12 @@ const RateForm = ({
         title: "errorTypes.rateInvalid"
       };
     }
+    if (displayableSaveRateErrors === null || displayableSaveRateErrors === void 0 ? void 0 : displayableSaveRateErrors.length) {
+      return {
+        messages: displayableSaveRateErrors,
+        title: "errorTypes.saveRate"
+      };
+    }
     if (labelErrors === null || labelErrors === void 0 ? void 0 : labelErrors.length) {
       return {
         messages: labelErrors,
@@ -14798,7 +14805,7 @@ const RateForm = ({
       };
     }
     return undefined;
-  }, [rateOptions, labelErrors, displayableRateErrors, outOfBandDisplayableErrors]);
+  }, [displayableRateErrors, outOfBandDisplayableErrors, rateOptions.length, displayableSaveRateErrors, labelErrors]);
   return jsxRuntime.jsxs("form", Object.assign({
     id: "rate-form",
     onSubmit: handleSubmit,
@@ -16907,7 +16914,8 @@ var common = {
 			warehouses: "Unable to load warehouses"
 		},
 		unknown: "Oops! Something went wrong.",
-		noRatesAvailable: "No rates available for this shipment. Please check your shipment configuration."
+		noRatesAvailable: "No rates available for this shipment. Please check your shipment configuration.",
+		saveRateError: "An error occurred while attempting to save your rate. Please try again later or save a different rate option."
 	},
 	errorTypes: {
 		accountStatus: "Account status error",
@@ -16915,6 +16923,7 @@ var common = {
 		integrations: "Integrations error",
 		purchase: "Purchase error",
 		rateInvalid: "Invalid rate configuration",
+		saveRate: "Error saving rate",
 		security: "Security error",
 		shipmentStatus: "Shipment status error",
 		system: "System error",
@@ -18195,11 +18204,14 @@ const useRatesForm = ({
     carrierId,
     serviceCode
   }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _d, _e;
     if (!shipment) throw new Error("shipment not found");
+    // clear any errors before attempting to save
+    setBeforeSaveError(undefined);
     try {
       const beforeSaveResponse = yield onBeforeRateSaved === null || onBeforeRateSaved === void 0 ? void 0 : onBeforeRateSaved(carrierId, serviceCode);
       let updatedShipment;
-      if (!beforeSaveResponse) {
+      if (!beforeSaveResponse || Object.keys(beforeSaveResponse).length === 0) {
         updatedShipment = yield updateShipment(Object.assign(Object.assign({}, shipment), {
           carrierId,
           serviceCode,
@@ -18232,24 +18244,34 @@ const useRatesForm = ({
         return;
       }
     } catch (e) {
-      setBeforeSaveError({
-        errorCode: "unknown",
-        errorSource: "client",
-        errorType: "unknown",
-        message: e.message
-      });
+      if (Array.isArray(e)) {
+        if (e[0] instanceof alchemy.SE.CodedError) setBeforeSaveError(e[0]);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_d = e[0].message) !== null && _d !== void 0 ? _d : "An unknown error occurred"
+        });
+      } else {
+        if (e instanceof alchemy.SE.CodedError) setBeforeSaveError(e);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_e = e.message) !== null && _e !== void 0 ? _e : "An unknown error occurred"
+        });
+      }
+      return;
     }
   }), [onBeforeRateSaved, onUpdatedShipment, resetRates, shipment, updateShipment]);
   const handleSubmit = React.useCallback(rateId => __awaiter(void 0, void 0, void 0, function* () {
-    var _d;
+    var _f, _g, _h;
     setBeforeCreateError(undefined);
     if (!shipment) return;
     const preferredRates = preferredRatesResponse === null || preferredRatesResponse === void 0 ? void 0 : preferredRatesResponse.map(r => r.rate);
-    const rate = [...((_d = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates) !== null && _d !== void 0 ? _d : []), ...(preferredRates !== null && preferredRates !== void 0 ? preferredRates : [])].find(r => r.rateId === rateId);
+    const rate = [...((_f = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates) !== null && _f !== void 0 ? _f : []), ...(preferredRates !== null && preferredRates !== void 0 ? preferredRates : [])].find(r => r.rateId === rateId);
     if (rate) {
       try {
         const beforePurchaseResponse = yield onBeforeLabelCreate === null || onBeforeLabelCreate === void 0 ? void 0 : onBeforeLabelCreate(rate, shipment);
-        if (!beforePurchaseResponse) {
+        if (!beforePurchaseResponse || Object.keys(beforePurchaseResponse).length === 0) {
           yield purchaseLabel(rateId, shipment, rate);
           return;
         }
@@ -18276,12 +18298,21 @@ const useRatesForm = ({
           }
         }
       } catch (e) {
-        setBeforeCreateError({
-          errorCode: "unknown",
-          errorSource: "client",
-          errorType: "unknown",
-          message: e.message
-        });
+        if (Array.isArray(e)) {
+          if (e[0] instanceof alchemy.SE.CodedError) setBeforeCreateError(e[0]);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_g = e[0].message) !== null && _g !== void 0 ? _g : "An unknown error occurred"
+          });
+        } else {
+          if (e instanceof alchemy.SE.CodedError) setBeforeCreateError(e);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_h = e.message) !== null && _h !== void 0 ? _h : "An unknown error occurred"
+          });
+        }
         return;
       }
     }
@@ -18302,6 +18333,11 @@ const useRatesForm = ({
       name: "CodedError"
     }))) !== null && _b !== void 0 ? _b : [];
   }
+  const displayableSaveRateErrors = useScrubErrors({
+    errors: errors,
+    predicate: React.useCallback(e => e.message.includes("Only residential delivery addresses are allowed for UPS Ground Saver."), []),
+    scrubber: React.useCallback(() => "common:errorMessages.saveRateError", [])
+  });
   const displayableRateErrors = useScrubErrors({
     errors: errors,
     predicate: React.useCallback(e => e.message.includes("No rates are available for service_codes"), []),
@@ -18314,6 +18350,7 @@ const useRatesForm = ({
   return {
     carriers,
     displayableRateErrors,
+    displayableSaveRateErrors,
     errors: errors.length > 0 ? errors : undefined,
     isLoading: ratesCalculating,
     labelErrors: displayableLabelErrors,

package/index.js

@@ -14627,6 +14627,7 @@ const RateForm = ({
   carriers,
   disabled,
   displayableRateErrors,
+  displayableSaveRateErrors,
   errors,
   features,
   isLoading,
@@ -14759,6 +14760,12 @@ const RateForm = ({
         title: "errorTypes.rateInvalid"
       };
     }
+    if (displayableSaveRateErrors === null || displayableSaveRateErrors === void 0 ? void 0 : displayableSaveRateErrors.length) {
+      return {
+        messages: displayableSaveRateErrors,
+        title: "errorTypes.saveRate"
+      };
+    }
     if (labelErrors === null || labelErrors === void 0 ? void 0 : labelErrors.length) {
       return {
         messages: labelErrors,
@@ -14766,7 +14773,7 @@ const RateForm = ({
       };
     }
     return undefined;
-  }, [rateOptions, labelErrors, displayableRateErrors, outOfBandDisplayableErrors]);
+  }, [displayableRateErrors, outOfBandDisplayableErrors, rateOptions.length, displayableSaveRateErrors, labelErrors]);
   return jsxs("form", Object.assign({
     id: "rate-form",
     onSubmit: handleSubmit,
@@ -16875,7 +16882,8 @@ var common = {
 			warehouses: "Unable to load warehouses"
 		},
 		unknown: "Oops! Something went wrong.",
-		noRatesAvailable: "No rates available for this shipment. Please check your shipment configuration."
+		noRatesAvailable: "No rates available for this shipment. Please check your shipment configuration.",
+		saveRateError: "An error occurred while attempting to save your rate. Please try again later or save a different rate option."
 	},
 	errorTypes: {
 		accountStatus: "Account status error",
@@ -16883,6 +16891,7 @@ var common = {
 		integrations: "Integrations error",
 		purchase: "Purchase error",
 		rateInvalid: "Invalid rate configuration",
+		saveRate: "Error saving rate",
 		security: "Security error",
 		shipmentStatus: "Shipment status error",
 		system: "System error",
@@ -18163,11 +18172,14 @@ const useRatesForm = ({
     carrierId,
     serviceCode
   }) => __awaiter(void 0, void 0, void 0, function* () {
+    var _d, _e;
     if (!shipment) throw new Error("shipment not found");
+    // clear any errors before attempting to save
+    setBeforeSaveError(undefined);
     try {
       const beforeSaveResponse = yield onBeforeRateSaved === null || onBeforeRateSaved === void 0 ? void 0 : onBeforeRateSaved(carrierId, serviceCode);
       let updatedShipment;
-      if (!beforeSaveResponse) {
+      if (!beforeSaveResponse || Object.keys(beforeSaveResponse).length === 0) {
         updatedShipment = yield updateShipment(Object.assign(Object.assign({}, shipment), {
           carrierId,
           serviceCode,
@@ -18200,24 +18212,34 @@ const useRatesForm = ({
         return;
       }
     } catch (e) {
-      setBeforeSaveError({
-        errorCode: "unknown",
-        errorSource: "client",
-        errorType: "unknown",
-        message: e.message
-      });
+      if (Array.isArray(e)) {
+        if (e[0] instanceof SE.CodedError) setBeforeSaveError(e[0]);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_d = e[0].message) !== null && _d !== void 0 ? _d : "An unknown error occurred"
+        });
+      } else {
+        if (e instanceof SE.CodedError) setBeforeSaveError(e);else setBeforeSaveError({
+          errorCode: "unknown",
+          errorSource: "client",
+          errorType: "unknown",
+          message: (_e = e.message) !== null && _e !== void 0 ? _e : "An unknown error occurred"
+        });
+      }
+      return;
     }
   }), [onBeforeRateSaved, onUpdatedShipment, resetRates, shipment, updateShipment]);
   const handleSubmit = useCallback(rateId => __awaiter(void 0, void 0, void 0, function* () {
-    var _d;
+    var _f, _g, _h;
     setBeforeCreateError(undefined);
     if (!shipment) return;
     const preferredRates = preferredRatesResponse === null || preferredRatesResponse === void 0 ? void 0 : preferredRatesResponse.map(r => r.rate);
-    const rate = [...((_d = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates) !== null && _d !== void 0 ? _d : []), ...(preferredRates !== null && preferredRates !== void 0 ? preferredRates : [])].find(r => r.rateId === rateId);
+    const rate = [...((_f = ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates) !== null && _f !== void 0 ? _f : []), ...(preferredRates !== null && preferredRates !== void 0 ? preferredRates : [])].find(r => r.rateId === rateId);
     if (rate) {
       try {
         const beforePurchaseResponse = yield onBeforeLabelCreate === null || onBeforeLabelCreate === void 0 ? void 0 : onBeforeLabelCreate(rate, shipment);
-        if (!beforePurchaseResponse) {
+        if (!beforePurchaseResponse || Object.keys(beforePurchaseResponse).length === 0) {
           yield purchaseLabel(rateId, shipment, rate);
           return;
         }
@@ -18244,12 +18266,21 @@ const useRatesForm = ({
           }
         }
       } catch (e) {
-        setBeforeCreateError({
-          errorCode: "unknown",
-          errorSource: "client",
-          errorType: "unknown",
-          message: e.message
-        });
+        if (Array.isArray(e)) {
+          if (e[0] instanceof SE.CodedError) setBeforeCreateError(e[0]);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_g = e[0].message) !== null && _g !== void 0 ? _g : "An unknown error occurred"
+          });
+        } else {
+          if (e instanceof SE.CodedError) setBeforeCreateError(e);else setBeforeCreateError({
+            errorCode: "unknown",
+            errorSource: "client",
+            errorType: "unknown",
+            message: (_h = e.message) !== null && _h !== void 0 ? _h : "An unknown error occurred"
+          });
+        }
         return;
       }
     }
@@ -18270,6 +18301,11 @@ const useRatesForm = ({
       name: "CodedError"
     }))) !== null && _b !== void 0 ? _b : [];
   }
+  const displayableSaveRateErrors = useScrubErrors({
+    errors: errors,
+    predicate: useCallback(e => e.message.includes("Only residential delivery addresses are allowed for UPS Ground Saver."), []),
+    scrubber: useCallback(() => "common:errorMessages.saveRateError", [])
+  });
   const displayableRateErrors = useScrubErrors({
     errors: errors,
     predicate: useCallback(e => e.message.includes("No rates are available for service_codes"), []),
@@ -18282,6 +18318,7 @@ const useRatesForm = ({
   return {
     carriers,
     displayableRateErrors,
+    displayableSaveRateErrors,
     errors: errors.length > 0 ? errors : undefined,
     isLoading: ratesCalculating,
     labelErrors: displayableLabelErrors,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.37.4",
+  "version": "0.37.20",
   "peerDependencies": {
     "@packlink/giger": "*",
     "react-i18next": "*",

package/src/components/templates/rate-form/rate-form.d.ts

@@ -4,6 +4,7 @@ export type RateFormProps = {
     carriers?: SE.Carrier[];
     disabled?: boolean;
     displayableRateErrors?: string[];
+    displayableSaveRateErrors?: string[];
     errors?: SE.CodedError[];
     features?: ConfigureShipmentFeatures;
     isLoading?: boolean;
@@ -19,4 +20,4 @@ export type RateFormProps = {
     rates?: SE.Rate[];
     shipment?: SE.SalesOrderShipment;
 };
-export declare const RateForm: ({ carriers, disabled, displayableRateErrors, errors, features, isLoading, labelErrors, labels, labelsLoading, onSave, onSelectRate, onSubmit, outOfBandDisplayableErrors, preferredRates, preferredServiceCodes, rates, shipment, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const RateForm: ({ carriers, disabled, displayableRateErrors, displayableSaveRateErrors, errors, features, isLoading, labelErrors, labels, labelsLoading, onSave, onSelectRate, onSubmit, outOfBandDisplayableErrors, preferredRates, preferredServiceCodes, rates, shipment, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/elements/account-settings/account-settings.d.ts

@@ -637,6 +637,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
+                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -644,6 +645,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     integrations: string;
                     purchase: string;
                     rateInvalid: string;
+                    saveRate: string;
                     security: string;
                     shipmentStatus: string;
                     system: string;

package/src/elements/configure-shipment/hooks/use-rates-form.d.ts

@@ -24,6 +24,7 @@ export type UseRatesFormProps = {
 export declare const useRatesForm: ({ getPreferredRates, onBeforeRateSaved, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
     carriers: SE.Carrier[] | undefined;
     displayableRateErrors: string[] | undefined;
+    displayableSaveRateErrors: string[] | undefined;
     errors: SE.CodedError[] | undefined;
     isLoading: boolean;
     labelErrors: string[] | undefined;

package/src/elements/onboarding/onboarding.d.ts

@@ -621,6 +621,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
+                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -628,6 +629,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     integrations: string;
                     purchase: string;
                     rateInvalid: string;
+                    saveRate: string;
                     security: string;
                     shipmentStatus: string;
                     system: string;

package/src/elements/purchase-label/purchase-label.d.ts

@@ -718,6 +718,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
+                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -725,6 +726,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     integrations: string;
                     purchase: string;
                     rateInvalid: string;
+                    saveRate: string;
                     security: string;
                     shipmentStatus: string;
                     system: string;
@@ -762,30 +764,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     september: string;
                     october: string;
                     november: string;
-                    /**
-                     * # Purchase Label Component
-                     *
-                     * The `<PurchaseLabel />` component is used to purchase shipping labels from various carriers
-                     *
-                     * @param ElementProps The props necessary to render the `<PurchaseLabel />` component for shipment
-                     * based or sales order based label purchasing.
-                     *
-                     * @returns Element An EmotionJSX.Element that will render the `<PurchaseLabel />` component
-                     * with all the appropriate wrappers.
-                     *
-                     * @example
-                     * You can see how the `<Component />` is used in the `createElement` function call below.
-                     * ```tsx
-                     * export const Element = alchemy.createElement(Component, ErrorFallback, {
-                     *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
-                     *   resources: { en },
-                     * });
-                     * ```
-                     *
-                     * <br />
-                     *
-                     * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
-                     */
                     december: string;
                 };
                 packageCategories: {

package/src/elements/view-shipment/view-shipment.d.ts

@@ -641,6 +641,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
+                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -648,6 +649,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     integrations: string;
                     purchase: string;
                     rateInvalid: string;
+                    saveRate: string;
                     security: string;
                     shipmentStatus: string;
                     system: string;

package/src/elements/void-label/void-label.d.ts

@@ -637,6 +637,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     unknown: string;
                     noRatesAvailable: string;
+                    saveRateError: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -644,6 +645,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     integrations: string;
                     purchase: string;
                     rateInvalid: string;
+                    saveRate: string;
                     security: string;
                     shipmentStatus: string;
                     system: string;

package/src/locales/en/index.d.ts

@@ -509,6 +509,7 @@ declare const _default: {
             };
             unknown: string;
             noRatesAvailable: string;
+            saveRateError: string;
         };
         errorTypes: {
             accountStatus: string;
@@ -516,6 +517,7 @@ declare const _default: {
             integrations: string;
             purchase: string;
             rateInvalid: string;
+            saveRate: string;
             security: string;
             shipmentStatus: string;
             system: string;