@shipengine/elements 0.5.6 → 0.6.0

package/components/sales-order/sales-order.d.ts

@@ -6,18 +6,20 @@ import { RateFormProps } from "../rate-form";
 export declare type SalesOrderProps = {
     externalOrderId?: string;
     externalOrderNumber?: string;
-    onAddressValidation?: (addressPreference: Templates.AddressPreference) => void;
-    onChangeAddress?: ShipmentFormProps["onChangeAddress"];
+    onAddressValidation?: (addressPreference: Templates.AddressPreference) => Promise<void> | void;
+    onApplyPreset?: ShipmentFormProps["onApplyPreset"];
     onBeforeLabelCreate?: RateFormProps["onBeforeLabelCreate"];
+    onChangeAddress?: ShipmentFormProps["onChangeAddress"];
+    onChangeShipmentFormMode?: ShipmentFormProps["onChangeShipmentFormMode"];
     onLabelCreateFailure?: RateFormProps["onLabelCreateFailure"];
     onLabelCreateSuccess?: RateFormProps["onLabelCreateSuccess"];
-    onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[]) => void;
+    onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[]) => Promise<void> | void;
     onRateSaved?: RateFormProps["onRateSaved"];
-    onRatesReturned?: (rates: SE.Rate[], shipment: SE.SalesOrderShipment) => void;
-    onChangeShipmentFormMode?: ShipmentFormProps["onChangeShipmentFormMode"];
+    onRatesReturned?: (rates: SE.Rate[], shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onToggleAddressPreferenceDisclosure?: ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
     orderSourceCode?: string;
     salesOrderId?: string;
     shippingPresets?: UseShippingPresetsOptionsProps;
 };
-export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onAddressValidation, onChangeAddress, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onLoad, onRateSaved, onRatesReturned, onChangeShipmentFormMode, onToggleAddressPreferenceDisclosure, orderSourceCode, salesOrderId, shippingPresets, }: SalesOrderProps) => JSX.Element;
+export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onChangeShipmentFormMode, onLabelCreateFailure, onLabelCreateSuccess, onLoad, onRateSaved, onRatesReturned, onShipmentUpdated, onToggleAddressPreferenceDisclosure, orderSourceCode, salesOrderId, shippingPresets, }: SalesOrderProps) => JSX.Element;

package/components/shipment-form/shipment-form.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { Templates } from "@shipengine/elements-ui";
-import SE from "@shipengine/elements-core";
+import SE, { ShippingPreset } from "@shipengine/elements-core";
 import { UseShippingPresetsOptionsProps } from "@shipengine/elements-ui";
 export declare type ShipmentFormMode = "browse_rates" | "select_service";
 export declare type ShipmentUpdatedOptions = {
@@ -10,14 +10,15 @@ export declare type ShipmentUpdatedOptions = {
 declare type ShipmentFormTemplateProps = React.ComponentProps<typeof Templates.ShipmentForm>;
 export declare type ShipmentFormProps = {
     addressPreference?: Templates.AddressPreference;
+    onApplyPreset?: (preset: ShippingPreset, shipment?: SE.SalesOrderShipment) => Promise<void> | void;
     onChangeAddress?: (addressPreference: Templates.AddressPreference) => any | void;
     onChangeShipmentFormMode?: ShipmentFormTemplateProps["onChangeMode"];
     onShipmentDirty: () => void;
-    onShipmentUpdated: (shipment: SE.SalesOrderShipment, options?: ShipmentUpdatedOptions) => void;
+    onShipmentUpdated: (shipment: SE.SalesOrderShipment, options?: ShipmentUpdatedOptions) => Promise<void> | void;
     onToggleAddressPreferenceDisclosure?: ShipmentFormTemplateProps["onToggleAddressPreferenceDisclosure"];
     salesOrder: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
 };
-export declare const ShipmentForm: ({ addressPreference, onChangeAddress, onChangeShipmentFormMode, onShipmentDirty, onShipmentUpdated, onToggleAddressPreferenceDisclosure, salesOrder, shipment, shippingPresets, }: ShipmentFormProps) => JSX.Element;
+export declare const ShipmentForm: ({ addressPreference, onApplyPreset, onChangeAddress, onChangeShipmentFormMode, onShipmentDirty, onShipmentUpdated, onToggleAddressPreferenceDisclosure, salesOrder, shipment, shippingPresets, }: ShipmentFormProps) => JSX.Element;
 export {};

package/index.cjs

@@ -2731,6 +2731,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
 
 const ShipmentForm = ({
   addressPreference,
+  onApplyPreset,
   onChangeAddress,
   onChangeShipmentFormMode,
   onShipmentDirty,
@@ -2773,7 +2774,7 @@ const ShipmentForm = ({
   }), [createShipment, updateShipment, logger, salesOrder, shipment, t]);
   const handleSubmit = react.useCallback(values => __awaiter(void 0, void 0, void 0, function* () {
     const updatedShipment = yield createOrUpdateShipment(values);
-    if (updatedShipment) onShipmentUpdated(updatedShipment, {
+    if (updatedShipment) yield onShipmentUpdated(updatedShipment, {
       shouldCalculateRates: true
     });
   }), [createOrUpdateShipment, onShipmentUpdated]); // Handles any changes to the ship to address as well as handling user
@@ -2787,7 +2788,7 @@ const ShipmentForm = ({
     }));
 
     if (updatedShipment) {
-      onShipmentUpdated(updatedShipment, {
+      yield onShipmentUpdated(updatedShipment, {
         shouldCalculateRates: false,
         shouldResetAddressPreference: options.shouldValidate
       });
@@ -2808,10 +2809,14 @@ const ShipmentForm = ({
         packageCode: preset.packageCode
       }] : undefined
     }));
-    if (updatedShipment) onShipmentUpdated(updatedShipment, {
-      shouldCalculateRates: !!(preset.dimensions && preset.weight),
-      shouldResetAddressPreference: false
-    });
+
+    if (updatedShipment) {
+      yield onApplyPreset === null || onApplyPreset === void 0 ? void 0 : onApplyPreset(preset, updatedShipment);
+      yield onShipmentUpdated(updatedShipment, {
+        shouldCalculateRates: !!(preset.dimensions && preset.weight),
+        shouldResetAddressPreference: false
+      });
+    }
   });
 
   const handleSubmitParseShipTo = ({
@@ -2830,7 +2835,7 @@ const ShipmentForm = ({
     }));
 
     if (updatedShipment) {
-      onShipmentUpdated(updatedShipment);
+      yield onShipmentUpdated(updatedShipment);
     }
   });
 
@@ -20176,14 +20181,16 @@ const SalesOrder = ({
   externalOrderId,
   externalOrderNumber,
   onAddressValidation,
-  onChangeAddress,
+  onApplyPreset,
   onBeforeLabelCreate,
+  onChangeAddress,
+  onChangeShipmentFormMode,
   onLabelCreateFailure,
   onLabelCreateSuccess,
   onLoad,
   onRateSaved,
   onRatesReturned,
-  onChangeShipmentFormMode,
+  onShipmentUpdated,
   onToggleAddressPreferenceDisclosure,
   orderSourceCode,
   salesOrderId,
@@ -20286,7 +20293,7 @@ const SalesOrder = ({
               validation: result.addressValidation,
               fallbackAddress: currentSalesOrder.shipTo
             });
-            onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+            yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
           }
         } else if (currentSalesOrder && pendingShipment && !validateAddresses.data && !validateAddresses.errors && !validateAddresses.isMutating) {
           // We have a preexisting shipment; validate the address
@@ -20300,7 +20307,7 @@ const SalesOrder = ({
               validation: addressValidation,
               fallbackAddress: currentSalesOrder.shipTo
             });
-            onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+            yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
           }
         }
       }
@@ -20320,8 +20327,8 @@ const SalesOrder = ({
       const updatedAddressPreference = resetAddressPreference({
         validation: shipment.addressValidation
       });
-      onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
-      onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
+      yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
     }
 
     if (options.shouldCalculateRates) {
@@ -20334,7 +20341,7 @@ const SalesOrder = ({
           : shipment.packages.map(pkg => pkg.packageCode)
         }
       });
-      result && (onRatesReturned === null || onRatesReturned === void 0 ? void 0 : onRatesReturned(result.rates, shipment)); // We are hiding, from the user, any errors in the rate response if the response
+      if (result) yield onRatesReturned === null || onRatesReturned === void 0 ? void 0 : onRatesReturned(result.rates, shipment); // We are hiding, from the user, any errors in the rate response if the response
       // contains rates. Log to the console any rate errors if the response has rates.
 
       if ((result === null || result === void 0 ? void 0 : result.errors.length) && result.rates.length) {
@@ -20343,7 +20350,9 @@ const SalesOrder = ({
         }, `Rate response had errors`);
       }
     }
-  }), [calculateRates, carriers.data, hasCustomPackage, logger, onChangeAddress, onAddressValidation, onRatesReturned, resetAddressPreference, shipments]);
+
+    yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(shipment);
+  }), [calculateRates, carriers.data, hasCustomPackage, logger, onAddressValidation, onChangeAddress, onRatesReturned, onShipmentUpdated, resetAddressPreference, shipments]);
   const handleShipmentDirty = react.useCallback(() => {
     calculateRates.reset();
   }, [calculateRates]);
@@ -20374,6 +20383,7 @@ const SalesOrder = ({
   }, {
     children: [jsxRuntime.jsx(ShipmentForm, {
       addressPreference: addressPreference,
+      onApplyPreset: onApplyPreset,
       onChangeAddress: onChangeAddress,
       onChangeShipmentFormMode: onChangeShipmentFormMode,
       onShipmentDirty: handleShipmentDirty,

package/index.js

@@ -2727,6 +2727,7 @@ function __awaiter(thisArg, _arguments, P, generator) {
 
 const ShipmentForm = ({
   addressPreference,
+  onApplyPreset,
   onChangeAddress,
   onChangeShipmentFormMode,
   onShipmentDirty,
@@ -2769,7 +2770,7 @@ const ShipmentForm = ({
   }), [createShipment, updateShipment, logger, salesOrder, shipment, t]);
   const handleSubmit = useCallback(values => __awaiter(void 0, void 0, void 0, function* () {
     const updatedShipment = yield createOrUpdateShipment(values);
-    if (updatedShipment) onShipmentUpdated(updatedShipment, {
+    if (updatedShipment) yield onShipmentUpdated(updatedShipment, {
       shouldCalculateRates: true
     });
   }), [createOrUpdateShipment, onShipmentUpdated]); // Handles any changes to the ship to address as well as handling user
@@ -2783,7 +2784,7 @@ const ShipmentForm = ({
     }));
 
     if (updatedShipment) {
-      onShipmentUpdated(updatedShipment, {
+      yield onShipmentUpdated(updatedShipment, {
         shouldCalculateRates: false,
         shouldResetAddressPreference: options.shouldValidate
       });
@@ -2804,10 +2805,14 @@ const ShipmentForm = ({
         packageCode: preset.packageCode
       }] : undefined
     }));
-    if (updatedShipment) onShipmentUpdated(updatedShipment, {
-      shouldCalculateRates: !!(preset.dimensions && preset.weight),
-      shouldResetAddressPreference: false
-    });
+
+    if (updatedShipment) {
+      yield onApplyPreset === null || onApplyPreset === void 0 ? void 0 : onApplyPreset(preset, updatedShipment);
+      yield onShipmentUpdated(updatedShipment, {
+        shouldCalculateRates: !!(preset.dimensions && preset.weight),
+        shouldResetAddressPreference: false
+      });
+    }
   });
 
   const handleSubmitParseShipTo = ({
@@ -2826,7 +2831,7 @@ const ShipmentForm = ({
     }));
 
     if (updatedShipment) {
-      onShipmentUpdated(updatedShipment);
+      yield onShipmentUpdated(updatedShipment);
     }
   });
 
@@ -20172,14 +20177,16 @@ const SalesOrder = ({
   externalOrderId,
   externalOrderNumber,
   onAddressValidation,
-  onChangeAddress,
+  onApplyPreset,
   onBeforeLabelCreate,
+  onChangeAddress,
+  onChangeShipmentFormMode,
   onLabelCreateFailure,
   onLabelCreateSuccess,
   onLoad,
   onRateSaved,
   onRatesReturned,
-  onChangeShipmentFormMode,
+  onShipmentUpdated,
   onToggleAddressPreferenceDisclosure,
   orderSourceCode,
   salesOrderId,
@@ -20282,7 +20289,7 @@ const SalesOrder = ({
               validation: result.addressValidation,
               fallbackAddress: currentSalesOrder.shipTo
             });
-            onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+            yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
           }
         } else if (currentSalesOrder && pendingShipment && !validateAddresses.data && !validateAddresses.errors && !validateAddresses.isMutating) {
           // We have a preexisting shipment; validate the address
@@ -20296,7 +20303,7 @@ const SalesOrder = ({
               validation: addressValidation,
               fallbackAddress: currentSalesOrder.shipTo
             });
-            onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+            yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
           }
         }
       }
@@ -20316,8 +20323,8 @@ const SalesOrder = ({
       const updatedAddressPreference = resetAddressPreference({
         validation: shipment.addressValidation
       });
-      onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
-      onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
+      yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
     }
 
     if (options.shouldCalculateRates) {
@@ -20330,7 +20337,7 @@ const SalesOrder = ({
           : shipment.packages.map(pkg => pkg.packageCode)
         }
       });
-      result && (onRatesReturned === null || onRatesReturned === void 0 ? void 0 : onRatesReturned(result.rates, shipment)); // We are hiding, from the user, any errors in the rate response if the response
+      if (result) yield onRatesReturned === null || onRatesReturned === void 0 ? void 0 : onRatesReturned(result.rates, shipment); // We are hiding, from the user, any errors in the rate response if the response
       // contains rates. Log to the console any rate errors if the response has rates.
 
       if ((result === null || result === void 0 ? void 0 : result.errors.length) && result.rates.length) {
@@ -20339,7 +20346,9 @@ const SalesOrder = ({
         }, `Rate response had errors`);
       }
     }
-  }), [calculateRates, carriers.data, hasCustomPackage, logger, onChangeAddress, onAddressValidation, onRatesReturned, resetAddressPreference, shipments]);
+
+    yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(shipment);
+  }), [calculateRates, carriers.data, hasCustomPackage, logger, onAddressValidation, onChangeAddress, onRatesReturned, onShipmentUpdated, resetAddressPreference, shipments]);
   const handleShipmentDirty = useCallback(() => {
     calculateRates.reset();
   }, [calculateRates]);
@@ -20370,6 +20379,7 @@ const SalesOrder = ({
   }, {
     children: [jsx(ShipmentForm, {
       addressPreference: addressPreference,
+      onApplyPreset: onApplyPreset,
       onChangeAddress: onChangeAddress,
       onChangeShipmentFormMode: onChangeShipmentFormMode,
       onShipmentDirty: handleShipmentDirty,

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.5.6",
+  "version": "0.6.0",
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
   "types": "./index.d.ts",
   "dependencies": {
     "react": "^18.2.0",
-    "@shipengine/elements-core": "0.5.6",
+    "@shipengine/elements-core": "0.6.0",
     "react-i18next": "^11.18.4",
     "i18next": "^21.9.1",
     "i18next-http-backend": "^1.4.1",
     "i18next-browser-languagedetector": "^6.1.4",
-    "@shipengine/elements-ui": "0.5.6"
+    "@shipengine/elements-ui": "0.6.0"
   },
   "peerDependencies": {}
 }