@shipengine/elements 0.6.42 → 0.6.44

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

@@ -7,7 +7,8 @@ export declare type RateFormProps = {
     onLabelCreateFailure?: (rate?: SE.Rate, shipment?: SE.SalesOrderShipment) => Promise<void> | void;
     onLabelCreateSuccess?: (label: SE.Label, shipment?: SE.SalesOrderShipment) => Promise<void> | void;
     onRateSaved?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    printLabelLayout?: SE.LabelLayout;
     rates?: SE.Rate[];
     shipment?: SE.SalesOrderShipment;
 };
-export declare const RateForm: ({ errors, loading, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, rates, shipment, }: RateFormProps) => JSX.Element;
+export declare const RateForm: ({ errors, loading, onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, printLabelLayout, rates, shipment, }: RateFormProps) => JSX.Element;

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

@@ -19,8 +19,9 @@ export declare type SalesOrderProps = {
     onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onToggleAddressPreferenceDisclosure?: ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
     orderSourceCode?: string;
+    printLabelLayout?: RateFormProps["printLabelLayout"];
     salesOrderId?: string;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;
 };
-export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onChangeShipmentFormMode, onLabelCreateFailure, onLabelCreateSuccess, onLoad, onRateSaved, onRatesReturned, onShipmentUpdated, onToggleAddressPreferenceDisclosure, orderSourceCode, salesOrderId, shippingPresets, warehouseId, }: SalesOrderProps) => JSX.Element;
+export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onChangeShipmentFormMode, onLabelCreateFailure, onLabelCreateSuccess, onLoad, onRateSaved, onRatesReturned, onShipmentUpdated, onToggleAddressPreferenceDisclosure, orderSourceCode, printLabelLayout, salesOrderId, shippingPresets, warehouseId, }: SalesOrderProps) => JSX.Element;

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

@@ -16,11 +16,12 @@ export declare type ShipmentFormProps = {
     onChangeShipmentFormMode?: ShipmentFormTemplateProps["onChangeMode"];
     onShipmentDirty: () => void;
     onShipmentUpdated: (shipment: SE.SalesOrderShipment, options?: ShipmentUpdatedOptions) => Promise<void> | void;
+    onShipmentUpdateFailure?: () => void;
     onToggleAddressPreferenceDisclosure?: ShipmentFormTemplateProps["onToggleAddressPreferenceDisclosure"];
     salesOrder: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;
 };
-export declare const ShipmentForm: ({ addressPreference, onApplyPreset, onChangeAddress, onChangeShipmentFormMode, onShipmentDirty, onShipmentUpdated, onToggleAddressPreferenceDisclosure, salesOrder, shipment, shippingPresets, warehouseId, }: ShipmentFormProps) => JSX.Element;
+export declare const ShipmentForm: ({ addressPreference, onApplyPreset, onChangeAddress, onChangeShipmentFormMode, onShipmentDirty, onShipmentUpdated, onShipmentUpdateFailure, onToggleAddressPreferenceDisclosure, salesOrder, shipment, shippingPresets, warehouseId, }: ShipmentFormProps) => JSX.Element;
 export {};

package/index.cjs

@@ -2848,6 +2848,7 @@ const ShipmentForm = ({
   onShipmentDirty,
   // Must be referentially stable
   onShipmentUpdated,
+  onShipmentUpdateFailure,
   onToggleAddressPreferenceDisclosure,
   salesOrder,
   shipment,
@@ -2901,6 +2902,8 @@ const ShipmentForm = ({
         shouldCalculateRates: false,
         shouldResetAddressPreference: options.shouldValidate
       });
+    } else if (onShipmentUpdateFailure) {
+      onShipmentUpdateFailure();
     }
   });
 
@@ -2977,12 +2980,13 @@ const RateForm = ({
   onLabelCreateFailure,
   onLabelCreateSuccess,
   onRateSaved,
+  printLabelLayout,
   rates,
   shipment
 }) => {
   var _a;
 
-  const createLabel = elementsCore.useCreateLabel();
+  const createLabel = elementsCore.useCreateLabel(printLabelLayout);
   const updateShipment = elementsCore.useUpdateShipment({
     shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
   });
@@ -20309,6 +20313,7 @@ const SalesOrder = ({
   onShipmentUpdated,
   onToggleAddressPreferenceDisclosure,
   orderSourceCode,
+  printLabelLayout,
   salesOrderId,
   shippingPresets,
   warehouseId
@@ -20380,7 +20385,7 @@ const SalesOrder = ({
 
       if (((_a = salesOrders.data) === null || _a === void 0 ? void 0 : _a.length) && shipments.data && ((_b = warehouses.data) === null || _b === void 0 ? void 0 : _b.length) && !createShipment.data && !createShipment.errors && !createShipment.isMutating) {
         const currentSalesOrder = salesOrders.data[0];
-        const pendingShipment = shipments.data.find(s => s.shipmentStatus === "pending");
+        const pendingShipment = elementsCore.getPendingShipment(shipments.data);
 
         if (currentSalesOrder && !pendingShipment) {
           const defaultWarehouse = (_c = warehouses.data.find(w => w.warehouseId === warehouseId)) !== null && _c !== void 0 ? _c : warehouses.data[0];
@@ -20415,40 +20420,44 @@ const SalesOrder = ({
               yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
             }
           } catch (error) {
-            // Shipment creation failed most likely due to validate_and_clean failing create and update
-            // validate and create the shipment the old fashioned way.
+            // Shipment creation failed, most likely due to validate_and_clean 500ing
+            // and preventing a shipment from being created. Create a shipment with
+            // the sales order ship to address without validating and setting the
+            // address preference to an error state. This will display the not validated
+            // error message to the user.
             logger.warn("createShipment failed to create a shipment, trying plan b", error.message);
-            const result = yield validateAddresses.trigger({
-              addresses: [currentSalesOrder.shipTo]
-            });
-            const addressValidation = result === null || result === void 0 ? void 0 : result[0];
-
-            if (addressValidation) {
-              try {
-                yield createShipment.trigger(Object.assign({
-                  // /v-beta/shipments/sales_order/:salesOrderId requires at minimum
-                  // a (warehouseId or shipFrom) and a package with weight defined.
-                  packages: [{
-                    weight: {
-                      value: 0,
-                      unit: "pound"
-                    }
-                  }],
-                  shipTo: addressValidation.originalAddress,
-                  warehouseId: defaultWarehouse.warehouseId
-                }, elementsCore.getIsCustomsRequiredForSalesOrder(currentSalesOrder, defaultWarehouse) && {
-                  customs: elementsCore.getCustomsFromSalesOrder(currentSalesOrder, defaultWarehouse)
-                }));
-                yield shipments.mutate();
+
+            try {
+              yield createShipment.trigger(Object.assign({
+                // /v-beta/shipments/sales_order/:salesOrderId requires at minimum
+                // a (warehouseId or shipFrom) and a package with weight defined.
+                packages: [{
+                  weight: {
+                    value: 0,
+                    unit: "pound"
+                  }
+                }],
+                shipTo: currentSalesOrder.shipTo,
+                warehouseId: defaultWarehouse.warehouseId
+              }, elementsCore.getIsCustomsRequiredForSalesOrder(currentSalesOrder, defaultWarehouse) && {
+                customs: elementsCore.getCustomsFromSalesOrder(currentSalesOrder, defaultWarehouse)
+              }));
+              const shipmentsMutationResult = yield shipments.mutate();
+              const currentPendingShipment = elementsCore.getPendingShipment(shipmentsMutationResult);
+
+              if (currentPendingShipment) {
                 const updatedAddressPreference = resetAddressPreference({
-                  validation: addressValidation,
-                  fallbackAddress: currentSalesOrder.shipTo
+                  validation: {
+                    messages: [],
+                    originalAddress: currentPendingShipment.shipTo,
+                    status: "error"
+                  }
                 });
                 yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
-              } catch (error) {
-                logger.error("createShipment failed to create a shipment", error.message);
-                throw new Error("errorMessages.unableToLoad.shipment");
               }
+            } catch (error) {
+              logger.error("createShipment failed to create a shipment", error.message);
+              throw new Error("errorMessages.unableToLoad.shipment");
             }
           }
         } else if (currentSalesOrder && pendingShipment && !validateAddresses.data && !validateAddresses.errors && !validateAddresses.isMutating) {
@@ -20473,7 +20482,28 @@ const SalesOrder = ({
     var _a;
 
     return !!((_a = customPackageTypes.data) === null || _a === void 0 ? void 0 : _a.find(p => p.packageId === shipment.packages[0].packageId));
-  }, [customPackageTypes]);
+  }, [customPackageTypes]); // validate_and_clean failure is preventing the address preference object
+  // from being refreshed. Manualy set the address preference to an error state.
+  // with the original address set to the newly updated shipment ship to
+  // This will display the not validated error message with the edited address to the user.
+
+  const handleShipmentUpdateFailure = react.useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield shipments.mutate();
+    const currentShipment = elementsCore.getPendingShipment(result);
+
+    if (currentShipment) {
+      const updatedAddressPreference = resetAddressPreference({
+        validation: {
+          messages: [],
+          originalAddress: currentShipment.shipTo,
+          status: "error"
+        }
+      });
+      yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
+      yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(currentShipment);
+    }
+  }), [onAddressValidation, onChangeAddress, resetAddressPreference, onShipmentUpdated, shipments]);
   const handleShipmentUpdated = react.useCallback((shipment, options = {}) => __awaiter(void 0, void 0, void 0, function* () {
     var _h, _j;
 
@@ -20537,7 +20567,7 @@ const SalesOrder = ({
     message: t("loading.carriers")
   });
   const salesOrder = salesOrders.data[0];
-  const shipment = shipments.data.find(s => s.shipmentStatus === "pending");
+  const shipment = elementsCore.getPendingShipment(shipments.data);
   let rateErrors = [...((_b = calculateRates.errors) !== null && _b !== void 0 ? _b : []), ...((_d = (_c = calculateRates.data) === null || _c === void 0 ? void 0 : _c.errors) !== null && _d !== void 0 ? _d : [])]; // Sometimes no rates are returned and no top-level errors are returned
   // but there are invalid rates with errors. This will expose those to the user
   // so the rate list isn't empty after calculating rates.
@@ -20561,6 +20591,7 @@ const SalesOrder = ({
       onChangeShipmentFormMode: onChangeShipmentFormMode,
       onShipmentDirty: handleShipmentDirty,
       onShipmentUpdated: handleShipmentUpdated,
+      onShipmentUpdateFailure: handleShipmentUpdateFailure,
       onToggleAddressPreferenceDisclosure: onToggleAddressPreferenceDisclosure,
       salesOrder: salesOrder,
       shipment: shipment,
@@ -20573,6 +20604,7 @@ const SalesOrder = ({
       onLabelCreateFailure: onLabelCreateFailure,
       onLabelCreateSuccess: onLabelCreateSuccess,
       onRateSaved: handleRateSaved,
+      printLabelLayout: printLabelLayout,
       rates: (_g = calculateRates.data) === null || _g === void 0 ? void 0 : _g.rates,
       shipment: shipment
     })]

package/index.js

@@ -1,4 +1,4 @@
-import { useLogger, useListWarehouses, useListCarriers, useCreateShipment, useUpdateShipment, useParseAddress, useListCustomPackageTypes, useCreateLabel, isDomesticAddress, useListSalesOrders, useListOrderSources, useRefreshOrderSource, useCalculateRates, useValidateAddresses, useListShipments, getIsCustomsRequiredForSalesOrder, getCustomsFromSalesOrder, registerElement, useGetShipment, useListLabels, useGetLabel, useVoidLabel } from '@shipengine/elements-core';
+import { useLogger, useListWarehouses, useListCarriers, useCreateShipment, useUpdateShipment, useParseAddress, useListCustomPackageTypes, useCreateLabel, isDomesticAddress, useListSalesOrders, useListOrderSources, useRefreshOrderSource, useCalculateRates, useValidateAddresses, useListShipments, getPendingShipment, getIsCustomsRequiredForSalesOrder, getCustomsFromSalesOrder, registerElement, useGetShipment, useListLabels, useGetLabel, useVoidLabel } from '@shipengine/elements-core';
 import { jsx, jsxs } from 'react/jsx-runtime';
 import { useCallback, useState, useEffect } from 'react';
 import { useTranslation } from 'react-i18next';
@@ -2844,6 +2844,7 @@ const ShipmentForm = ({
   onShipmentDirty,
   // Must be referentially stable
   onShipmentUpdated,
+  onShipmentUpdateFailure,
   onToggleAddressPreferenceDisclosure,
   salesOrder,
   shipment,
@@ -2897,6 +2898,8 @@ const ShipmentForm = ({
         shouldCalculateRates: false,
         shouldResetAddressPreference: options.shouldValidate
       });
+    } else if (onShipmentUpdateFailure) {
+      onShipmentUpdateFailure();
     }
   });
 
@@ -2973,12 +2976,13 @@ const RateForm = ({
   onLabelCreateFailure,
   onLabelCreateSuccess,
   onRateSaved,
+  printLabelLayout,
   rates,
   shipment
 }) => {
   var _a;
 
-  const createLabel = useCreateLabel();
+  const createLabel = useCreateLabel(printLabelLayout);
   const updateShipment = useUpdateShipment({
     shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
   });
@@ -20305,6 +20309,7 @@ const SalesOrder = ({
   onShipmentUpdated,
   onToggleAddressPreferenceDisclosure,
   orderSourceCode,
+  printLabelLayout,
   salesOrderId,
   shippingPresets,
   warehouseId
@@ -20376,7 +20381,7 @@ const SalesOrder = ({
 
       if (((_a = salesOrders.data) === null || _a === void 0 ? void 0 : _a.length) && shipments.data && ((_b = warehouses.data) === null || _b === void 0 ? void 0 : _b.length) && !createShipment.data && !createShipment.errors && !createShipment.isMutating) {
         const currentSalesOrder = salesOrders.data[0];
-        const pendingShipment = shipments.data.find(s => s.shipmentStatus === "pending");
+        const pendingShipment = getPendingShipment(shipments.data);
 
         if (currentSalesOrder && !pendingShipment) {
           const defaultWarehouse = (_c = warehouses.data.find(w => w.warehouseId === warehouseId)) !== null && _c !== void 0 ? _c : warehouses.data[0];
@@ -20411,40 +20416,44 @@ const SalesOrder = ({
               yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
             }
           } catch (error) {
-            // Shipment creation failed most likely due to validate_and_clean failing create and update
-            // validate and create the shipment the old fashioned way.
+            // Shipment creation failed, most likely due to validate_and_clean 500ing
+            // and preventing a shipment from being created. Create a shipment with
+            // the sales order ship to address without validating and setting the
+            // address preference to an error state. This will display the not validated
+            // error message to the user.
             logger.warn("createShipment failed to create a shipment, trying plan b", error.message);
-            const result = yield validateAddresses.trigger({
-              addresses: [currentSalesOrder.shipTo]
-            });
-            const addressValidation = result === null || result === void 0 ? void 0 : result[0];
-
-            if (addressValidation) {
-              try {
-                yield createShipment.trigger(Object.assign({
-                  // /v-beta/shipments/sales_order/:salesOrderId requires at minimum
-                  // a (warehouseId or shipFrom) and a package with weight defined.
-                  packages: [{
-                    weight: {
-                      value: 0,
-                      unit: "pound"
-                    }
-                  }],
-                  shipTo: addressValidation.originalAddress,
-                  warehouseId: defaultWarehouse.warehouseId
-                }, getIsCustomsRequiredForSalesOrder(currentSalesOrder, defaultWarehouse) && {
-                  customs: getCustomsFromSalesOrder(currentSalesOrder, defaultWarehouse)
-                }));
-                yield shipments.mutate();
+
+            try {
+              yield createShipment.trigger(Object.assign({
+                // /v-beta/shipments/sales_order/:salesOrderId requires at minimum
+                // a (warehouseId or shipFrom) and a package with weight defined.
+                packages: [{
+                  weight: {
+                    value: 0,
+                    unit: "pound"
+                  }
+                }],
+                shipTo: currentSalesOrder.shipTo,
+                warehouseId: defaultWarehouse.warehouseId
+              }, getIsCustomsRequiredForSalesOrder(currentSalesOrder, defaultWarehouse) && {
+                customs: getCustomsFromSalesOrder(currentSalesOrder, defaultWarehouse)
+              }));
+              const shipmentsMutationResult = yield shipments.mutate();
+              const currentPendingShipment = getPendingShipment(shipmentsMutationResult);
+
+              if (currentPendingShipment) {
                 const updatedAddressPreference = resetAddressPreference({
-                  validation: addressValidation,
-                  fallbackAddress: currentSalesOrder.shipTo
+                  validation: {
+                    messages: [],
+                    originalAddress: currentPendingShipment.shipTo,
+                    status: "error"
+                  }
                 });
                 yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
-              } catch (error) {
-                logger.error("createShipment failed to create a shipment", error.message);
-                throw new Error("errorMessages.unableToLoad.shipment");
               }
+            } catch (error) {
+              logger.error("createShipment failed to create a shipment", error.message);
+              throw new Error("errorMessages.unableToLoad.shipment");
             }
           }
         } else if (currentSalesOrder && pendingShipment && !validateAddresses.data && !validateAddresses.errors && !validateAddresses.isMutating) {
@@ -20469,7 +20478,28 @@ const SalesOrder = ({
     var _a;
 
     return !!((_a = customPackageTypes.data) === null || _a === void 0 ? void 0 : _a.find(p => p.packageId === shipment.packages[0].packageId));
-  }, [customPackageTypes]);
+  }, [customPackageTypes]); // validate_and_clean failure is preventing the address preference object
+  // from being refreshed. Manualy set the address preference to an error state.
+  // with the original address set to the newly updated shipment ship to
+  // This will display the not validated error message with the edited address to the user.
+
+  const handleShipmentUpdateFailure = useCallback(() => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield shipments.mutate();
+    const currentShipment = getPendingShipment(result);
+
+    if (currentShipment) {
+      const updatedAddressPreference = resetAddressPreference({
+        validation: {
+          messages: [],
+          originalAddress: currentShipment.shipTo,
+          status: "error"
+        }
+      });
+      yield onAddressValidation === null || onAddressValidation === void 0 ? void 0 : onAddressValidation(updatedAddressPreference);
+      yield onChangeAddress === null || onChangeAddress === void 0 ? void 0 : onChangeAddress(updatedAddressPreference);
+      yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(currentShipment);
+    }
+  }), [onAddressValidation, onChangeAddress, resetAddressPreference, onShipmentUpdated, shipments]);
   const handleShipmentUpdated = useCallback((shipment, options = {}) => __awaiter(void 0, void 0, void 0, function* () {
     var _h, _j;
 
@@ -20533,7 +20563,7 @@ const SalesOrder = ({
     message: t("loading.carriers")
   });
   const salesOrder = salesOrders.data[0];
-  const shipment = shipments.data.find(s => s.shipmentStatus === "pending");
+  const shipment = getPendingShipment(shipments.data);
   let rateErrors = [...((_b = calculateRates.errors) !== null && _b !== void 0 ? _b : []), ...((_d = (_c = calculateRates.data) === null || _c === void 0 ? void 0 : _c.errors) !== null && _d !== void 0 ? _d : [])]; // Sometimes no rates are returned and no top-level errors are returned
   // but there are invalid rates with errors. This will expose those to the user
   // so the rate list isn't empty after calculating rates.
@@ -20557,6 +20587,7 @@ const SalesOrder = ({
       onChangeShipmentFormMode: onChangeShipmentFormMode,
       onShipmentDirty: handleShipmentDirty,
       onShipmentUpdated: handleShipmentUpdated,
+      onShipmentUpdateFailure: handleShipmentUpdateFailure,
       onToggleAddressPreferenceDisclosure: onToggleAddressPreferenceDisclosure,
       salesOrder: salesOrder,
       shipment: shipment,
@@ -20569,6 +20600,7 @@ const SalesOrder = ({
       onLabelCreateFailure: onLabelCreateFailure,
       onLabelCreateSuccess: onLabelCreateSuccess,
       onRateSaved: handleRateSaved,
+      printLabelLayout: printLabelLayout,
       rates: (_g = calculateRates.data) === null || _g === void 0 ? void 0 : _g.rates,
       shipment: shipment
     })]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.6.42",
+  "version": "0.6.44",
   "peerDependencies": {
     "@packlink/giger": "*",
     "react-i18next": "*",
@@ -12,10 +12,10 @@
   "types": "./index.d.ts",
   "dependencies": {
     "react": "^18.2.0",
-    "@shipengine/elements-core": "0.6.42",
+    "@shipengine/elements-core": "0.6.44",
     "i18next-http-backend": "^1.4.1",
     "i18next-browser-languagedetector": "^6.1.4",
-    "@shipengine/types": "0.6.42",
-    "@shipengine/elements-ui": "0.6.42"
+    "@shipengine/types": "0.6.44",
+    "@shipengine/elements-ui": "0.6.44"
   }
 }