@shipengine/elements 0.9.15 → 0.10.1

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

@@ -3,8 +3,13 @@ import * as SE from "@shipengine/types";
 import { UseShippingPresetsOptionsProps } from "@shipengine/elements-ui";
 import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
 export type ShipmentFormMode = "browse_rates" | "select_service";
+export type Features = {
+    shipmentForm?: Templates.ShipmentFormFeatures;
+    rateForm?: Templates.RateFormFeatures;
+};
 export type ConfigureShipmentProps = {
     errors?: Templates.ShipmentFormProps["errors"];
+    features?: Features;
     isLoading?: Templates.ShipmentFormProps["isLoading"];
     onAddressValidation?: UseShipmentFormProps["onAddressValidation"];
     onApplyPreset?: UseShipmentFormProps["onApplyPreset"];
@@ -23,4 +28,4 @@ export type ConfigureShipmentProps = {
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;
 };
-export declare const ConfigureShipment: ({ onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, salesOrder, shipment, ...props }: ConfigureShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ConfigureShipment: ({ features, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, salesOrder, shipment, ...props }: ConfigureShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/configure-shipment/hooks/use-customs.d.ts

@@ -4,6 +4,6 @@ export type UseCustomsProps = {
     shipment?: SE.SalesOrderShipment;
 };
 export declare const useCustoms: ({ onUpdate, shipment }: UseCustomsProps) => {
-    handleUpdateCustoms: (customs: SE.Customs) => Promise<void>;
+    handleUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
     customsErrors: SE.CodedError[] | undefined;
 };

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

@@ -13,11 +13,13 @@ export type UseRatesFormProps = {
 export declare const useRatesForm: ({ onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
     carriers: SE.Carrier[] | undefined;
     errors: SE.CodedError[] | undefined;
+    labelErrors: SE.CodedError[] | undefined;
     isLoading: boolean;
     onSave: ({ carrierId, serviceCode }: Pick<SE.Rate, "carrierId" | "serviceCode">) => Promise<void>;
     onSubmit: (rateId: string) => Promise<void>;
     rates: SE.Rate[] | undefined;
     requestRates: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    resetLabel: () => void;
     resetRates: () => void;
     shipment: SE.SalesOrderShipment | undefined;
 };

package/components/configure-shipment/hooks/use-shipment-form.d.ts

@@ -18,11 +18,11 @@ export declare const useShipmentForm: ({ onAddressValidation, onApplyPreset, onC
     errors: SE.CodedError[] | undefined;
     onApplyPreset: (preset: ShippingPreset) => Promise<void>;
     onChangeAddress: (shipTo: SE.Address, { shouldValidate }: import("dist/elements-ui/components/templates").OnChangeAddressOptions) => Promise<void>;
-    onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<void>;
+    onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<SE.SalesOrderShipment | undefined>;
     onSubmitParseShipTo: ({ fullAddress }: {
         fullAddress: string;
     }) => Promise<SE.AddressParseResponse | undefined>;
-    onUpdateCustoms: (customs: SE.Customs) => Promise<void>;
+    onUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
     salesOrder: SE.SalesOrder;
     shipment: SE.SalesOrderShipment | undefined;
     warehouses: SE.Warehouse[] | undefined;

package/index.cjs

@@ -19003,6 +19003,7 @@ const useCustoms = ({
     if (updatedShipment) {
       yield onUpdate === null || onUpdate === void 0 ? void 0 : onUpdate(updatedShipment);
     }
+    return updatedShipment;
   }), [onUpdate, shipment, updateShipment]);
   return {
     handleUpdateCustoms,
@@ -19338,6 +19339,8 @@ const useRatesForm = ({
     shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
   });
   const {
+    errors: labelErrors,
+    reset: resetLabel,
     trigger: createLabel
   } = elementsCore.useCreateLabel(printLabelLayout);
   const {
@@ -19408,11 +19411,13 @@ const useRatesForm = ({
   return {
     carriers,
     errors: errors.length > 0 ? errors : undefined,
+    labelErrors: (labelErrors === null || labelErrors === void 0 ? void 0 : labelErrors.length) ? labelErrors : undefined,
     isLoading: ratesCalculating,
     onSave: handleSave,
     onSubmit: handleSubmit,
     rates: ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates,
     requestRates,
+    resetLabel,
     resetRates,
     shipment
   };
@@ -19479,6 +19484,7 @@ const useShipmentForm = ({
       yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
       yield onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(updatedShipment);
     }
+    return updatedShipment;
   }), [onShipmentUpdated, onSubmit, updateShipment]);
   const errors = [...(addressErrors !== null && addressErrors !== void 0 ? addressErrors : []), ...(customsErrors !== null && customsErrors !== void 0 ? customsErrors : []), ...(presetErrors !== null && presetErrors !== void 0 ? presetErrors : []), ...(updateShipmentErrors !== null && updateShipmentErrors !== void 0 ? updateShipmentErrors : [])];
   return {
@@ -19499,6 +19505,7 @@ const useShipmentForm = ({
 
 const ConfigureShipment = _a => {
   var {
+      features,
       onAddressValidation,
       onApplyPreset,
       onBeforeLabelCreate,
@@ -19512,7 +19519,7 @@ const ConfigureShipment = _a => {
       salesOrder,
       shipment
     } = _a,
-    props = __rest(_a, ["onAddressValidation", "onApplyPreset", "onBeforeLabelCreate", "onChangeAddress", "onLabelCreateFailure", "onLabelCreateSuccess", "onRateSaved", "onRatesCalculated", "onShipmentUpdated", "printLabelLayout", "salesOrder", "shipment"]);
+    props = __rest(_a, ["features", "onAddressValidation", "onApplyPreset", "onBeforeLabelCreate", "onChangeAddress", "onLabelCreateFailure", "onLabelCreateSuccess", "onRateSaved", "onRatesCalculated", "onShipmentUpdated", "printLabelLayout", "salesOrder", "shipment"]);
   const _b = useRatesForm({
       onBeforeLabelCreate,
       onLabelCreateFailure,
@@ -19524,10 +19531,11 @@ const ConfigureShipment = _a => {
       shipment
     }),
     {
+      requestRates,
       resetRates,
-      requestRates
+      resetLabel
     } = _b,
-    rateFormProps = __rest(_b, ["resetRates", "requestRates"]);
+    rateFormProps = __rest(_b, ["requestRates", "resetRates", "resetLabel"]);
   const shipmentFormProps = useShipmentForm({
     onAddressValidation,
     onApplyPreset: react.useCallback((_preset, shipment) => __awaiter(void 0, void 0, void 0, function* () {
@@ -19543,10 +19551,28 @@ const ConfigureShipment = _a => {
     salesOrder,
     shipment
   });
+  const [rateFormDisabled, setRateFormDisabled] = react.useState(false);
+  const handleCharsetWarning = react.useCallback(charsetWarning => {
+    if (charsetWarning === null || charsetWarning === void 0 ? void 0 : charsetWarning.error) {
+      setRateFormDisabled(true);
+    } else {
+      setRateFormDisabled(false);
+    }
+  }, []);
+  const handleOnDirty = react.useCallback(() => {
+    resetRates();
+    resetLabel();
+  }, [resetRates, resetLabel]);
   return jsxRuntime.jsxs(jsxRuntime.Fragment, {
     children: [jsxRuntime.jsx(elementsUi.Templates.ShipmentForm, Object.assign({}, shipmentFormProps, props, {
-      onDirty: resetRates
-    })), jsxRuntime.jsx(elementsUi.Templates.RateForm, Object.assign({}, rateFormProps))]
+      onDirty: handleOnDirty,
+      onCharsetWarning: handleCharsetWarning,
+      features: features === null || features === void 0 ? void 0 : features.shipmentForm
+    })), jsxRuntime.jsx(elementsUi.Templates.RateForm, Object.assign({}, rateFormProps, {
+      disabled: rateFormDisabled,
+      features: features === null || features === void 0 ? void 0 : features.rateForm,
+      onSelectRate: resetLabel
+    }))]
   });
 };
 

package/index.js

@@ -18999,6 +18999,7 @@ const useCustoms = ({
     if (updatedShipment) {
       yield onUpdate === null || onUpdate === void 0 ? void 0 : onUpdate(updatedShipment);
     }
+    return updatedShipment;
   }), [onUpdate, shipment, updateShipment]);
   return {
     handleUpdateCustoms,
@@ -19334,6 +19335,8 @@ const useRatesForm = ({
     shipmentId: shipment === null || shipment === void 0 ? void 0 : shipment.shipmentId
   });
   const {
+    errors: labelErrors,
+    reset: resetLabel,
     trigger: createLabel
   } = useCreateLabel(printLabelLayout);
   const {
@@ -19404,11 +19407,13 @@ const useRatesForm = ({
   return {
     carriers,
     errors: errors.length > 0 ? errors : undefined,
+    labelErrors: (labelErrors === null || labelErrors === void 0 ? void 0 : labelErrors.length) ? labelErrors : undefined,
     isLoading: ratesCalculating,
     onSave: handleSave,
     onSubmit: handleSubmit,
     rates: ratesResponse === null || ratesResponse === void 0 ? void 0 : ratesResponse.rates,
     requestRates,
+    resetLabel,
     resetRates,
     shipment
   };
@@ -19475,6 +19480,7 @@ const useShipmentForm = ({
       yield onShipmentUpdated === null || onShipmentUpdated === void 0 ? void 0 : onShipmentUpdated(updatedShipment);
       yield onSubmit === null || onSubmit === void 0 ? void 0 : onSubmit(updatedShipment);
     }
+    return updatedShipment;
   }), [onShipmentUpdated, onSubmit, updateShipment]);
   const errors = [...(addressErrors !== null && addressErrors !== void 0 ? addressErrors : []), ...(customsErrors !== null && customsErrors !== void 0 ? customsErrors : []), ...(presetErrors !== null && presetErrors !== void 0 ? presetErrors : []), ...(updateShipmentErrors !== null && updateShipmentErrors !== void 0 ? updateShipmentErrors : [])];
   return {
@@ -19495,6 +19501,7 @@ const useShipmentForm = ({
 
 const ConfigureShipment = _a => {
   var {
+      features,
       onAddressValidation,
       onApplyPreset,
       onBeforeLabelCreate,
@@ -19508,7 +19515,7 @@ const ConfigureShipment = _a => {
       salesOrder,
       shipment
     } = _a,
-    props = __rest(_a, ["onAddressValidation", "onApplyPreset", "onBeforeLabelCreate", "onChangeAddress", "onLabelCreateFailure", "onLabelCreateSuccess", "onRateSaved", "onRatesCalculated", "onShipmentUpdated", "printLabelLayout", "salesOrder", "shipment"]);
+    props = __rest(_a, ["features", "onAddressValidation", "onApplyPreset", "onBeforeLabelCreate", "onChangeAddress", "onLabelCreateFailure", "onLabelCreateSuccess", "onRateSaved", "onRatesCalculated", "onShipmentUpdated", "printLabelLayout", "salesOrder", "shipment"]);
   const _b = useRatesForm({
       onBeforeLabelCreate,
       onLabelCreateFailure,
@@ -19520,10 +19527,11 @@ const ConfigureShipment = _a => {
       shipment
     }),
     {
+      requestRates,
       resetRates,
-      requestRates
+      resetLabel
     } = _b,
-    rateFormProps = __rest(_b, ["resetRates", "requestRates"]);
+    rateFormProps = __rest(_b, ["requestRates", "resetRates", "resetLabel"]);
   const shipmentFormProps = useShipmentForm({
     onAddressValidation,
     onApplyPreset: useCallback((_preset, shipment) => __awaiter(void 0, void 0, void 0, function* () {
@@ -19539,10 +19547,28 @@ const ConfigureShipment = _a => {
     salesOrder,
     shipment
   });
+  const [rateFormDisabled, setRateFormDisabled] = useState(false);
+  const handleCharsetWarning = useCallback(charsetWarning => {
+    if (charsetWarning === null || charsetWarning === void 0 ? void 0 : charsetWarning.error) {
+      setRateFormDisabled(true);
+    } else {
+      setRateFormDisabled(false);
+    }
+  }, []);
+  const handleOnDirty = useCallback(() => {
+    resetRates();
+    resetLabel();
+  }, [resetRates, resetLabel]);
   return jsxs(Fragment, {
     children: [jsx(Templates.ShipmentForm, Object.assign({}, shipmentFormProps, props, {
-      onDirty: resetRates
-    })), jsx(Templates.RateForm, Object.assign({}, rateFormProps))]
+      onDirty: handleOnDirty,
+      onCharsetWarning: handleCharsetWarning,
+      features: features === null || features === void 0 ? void 0 : features.shipmentForm
+    })), jsx(Templates.RateForm, Object.assign({}, rateFormProps, {
+      disabled: rateFormDisabled,
+      features: features === null || features === void 0 ? void 0 : features.rateForm,
+      onSelectRate: resetLabel
+    }))]
   });
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.9.15",
+  "version": "0.10.1",
   "peerDependencies": {
     "@packlink/giger": "*",
     "react-i18next": "*",
@@ -12,9 +12,9 @@
   "types": "./index.d.ts",
   "dependencies": {
     "react": "^18.2.0",
-    "@shipengine/elements-core": "0.9.15",
-    "@shipengine/elements-ui": "0.9.15",
-    "@shipengine/types": "0.9.15",
+    "@shipengine/elements-core": "0.10.1",
+    "@shipengine/elements-ui": "0.10.1",
+    "@shipengine/types": "0.10.1",
     "@emotion/react": "^11.10.0",
     "@packlink/brands": "^3.18.0"
   }