@shipengine/elements 0.37.0 → 0.37.1

package/index.cjs

@@ -2648,6 +2648,14 @@ const featureFlags = {
      * Elements.
      */
     compatibleCountryCodes: ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"],
+    /**
+     * @internal
+     *
+     * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
+     */
+    partnerMessages: {
+      incompleteLabelPurchaseRequirements: undefined
+    },
     /**
      *  `rateForm` all scoped feature flags for the `rate form` section of the `<PurchaseLabel />`
      *  element.
@@ -2701,14 +2709,6 @@ const featureFlags = {
        * to opt for third party insurance when insuring their shipment.
        */
       includeThirdPartyInsurance: true,
-      /**
-       * @internal
-       *
-       * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
-       */
-      partnerMessages: {
-        incompleteLabelPurchaseRequirements: undefined
-      },
       /**
        * `selectService` enables the `select service` feature, allowing users to select a service
        * when rate shopping across multiple carrier providers.
@@ -15411,7 +15411,7 @@ const ShipmentForm = ({
   warehouseId,
   warehouses
 }) => {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
   features = Object.assign({
     browseRates: true,
     includeShipsuranceInsurance: true,
@@ -15597,16 +15597,16 @@ const ShipmentForm = ({
   }, [form]);
   const handleSubmit = form.handleSubmit(values => __awaiter(void 0, void 0, void 0, function* () {
     try {
-      const _o = values,
+      const _l = values,
         {
           __mode: discard
-        } = _o,
-        payload = __rest(_o, ["__mode"]);
+        } = _l,
+        payload = __rest(_l, ["__mode"]);
       const updatedShipment = yield onSubmit(Object.assign(Object.assign({}, shipment || {}), payload));
       // Defer shipment hydration to the task queue so that the submission promise resolves first, otherwise the
       // submission count will increment after hydration resets the form, keeping it in revalidate mode
       if (updatedShipment) setTimeout(() => hydrateShipment(updatedShipment), 0);
-    } catch (_p) {
+    } catch (_m) {
       // Reset the form to its current state, but as a side effect this sets isDirty to false
       // That way, form lifecycle contract is upheld
       form.reset(form.getValues());
@@ -15739,19 +15739,6 @@ const ShipmentForm = ({
   const hasUpsOptions = React.useMemo(() => {
     return (packageOptions === null || packageOptions === void 0 ? void 0 : packageOptions.some(option => option.label === "UPS")) && ((selectedPackage === null || selectedPackage === void 0 ? void 0 : selectedPackage.code) === "package" || selectedCarrierId === upsCarrierId);
   }, [packageOptions, selectedPackage, selectedCarrierId, upsCarrierId]);
-  const incompleteRequirementsKeys = React.useMemo(() => {
-    if ((warehouses === null || warehouses === void 0 ? void 0 : warehouses.length) === 0 && (carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0) {
-      return ["noWarehouseOrCarrier"];
-    } else {
-      const keys = [(warehouses === null || warehouses === void 0 ? void 0 : warehouses.length) === 0 && "noWarehouse", (carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0 && "noCarrier"].filter(Boolean);
-      return keys;
-    }
-  }, [carriers, warehouses]);
-  const isPartnerMessagingEnabled = !!((_d = features.partnerMessages) === null || _d === void 0 ? void 0 : _d.incompleteLabelPurchaseRequirements);
-  const incompleteRequirementsError = isPartnerMessagingEnabled ? (_e = features.partnerMessages) === null || _e === void 0 ? void 0 : _e.incompleteLabelPurchaseRequirements : t("errorMessages.incompleteLabelPurchaseRequirements", {
-    requirements: incompleteRequirementsKeys.map(key => t(`purchase-label:requirements.${key}`))
-  });
-  if (incompleteRequirementsKeys.length > 0) throw new Error(incompleteRequirementsError);
   if (isLoading) return jsxRuntime.jsx(Loader, {
     message: t("loading.shipment")
   });
@@ -15825,7 +15812,7 @@ const ShipmentForm = ({
         }, {
           children: formatDate(salesOrder.orderDate)
         })), jsxRuntime.jsx(Spacer, {})]
-      })), ((_f = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.paymentDetails) === null || _f === void 0 ? void 0 : _f.grandTotal) && jsxRuntime.jsxs(FieldLabel, Object.assign({
+      })), ((_d = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.paymentDetails) === null || _d === void 0 ? void 0 : _d.grandTotal) && jsxRuntime.jsxs(FieldLabel, Object.assign({
         label: t("purchase-label:fields.orderValue")
       }, {
         children: [jsxRuntime.jsx(giger.Typography, Object.assign({
@@ -15903,7 +15890,7 @@ const ShipmentForm = ({
       }), jsxRuntime.jsx(CustomsItemsDisplay, {
         onUpdate: handleUpdateCustomsItems,
         shipment: shipment
-      }), ((_g = customsErrors === null || customsErrors === void 0 ? void 0 : customsErrors.customsItems) === null || _g === void 0 ? void 0 : _g.type) === "too_small" && jsxRuntime.jsxs(jsxRuntime.Fragment, {
+      }), ((_e = customsErrors === null || customsErrors === void 0 ? void 0 : customsErrors.customsItems) === null || _e === void 0 ? void 0 : _e.type) === "too_small" && jsxRuntime.jsxs(jsxRuntime.Fragment, {
         children: [jsxRuntime.jsx(Spacer, {}), jsxRuntime.jsx(giger.InlineNotification, {
           title: t("purchase-label:errorMessages.customsItemsRequired"),
           type: giger.NotificationType.ERROR
@@ -16094,14 +16081,14 @@ const ShipmentForm = ({
         label: "purchase-label:fields.addOns"
       }, {
         children: [jsxRuntime.jsx(Switch, Object.assign({
-          defaultChecked: ((_h = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _h !== void 0 ? _h : "none") !== "none",
+          defaultChecked: ((_f = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _f !== void 0 ? _f : "none") !== "none",
           label: t("purchase-label:fields.confirmation"),
           name: "confirmationEnabled",
           onChange: e => form.setValue("confirmation", e.target.checked ? alchemy.SE.ConfirmationType.DELIVERY : undefined, {
             shouldDirty: true
           }),
           shouldUnmount: true,
-          value: ((_j = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _j !== void 0 ? _j : "none") !== "none"
+          value: ((_g = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _g !== void 0 ? _g : "none") !== "none"
         }, {
           children: jsxRuntime.jsx(Select, {
             control: form.control,
@@ -16113,7 +16100,7 @@ const ShipmentForm = ({
             shouldUnregister: true
           })
         })), jsxRuntime.jsxs(Switch, Object.assign({
-          defaultChecked: ((_k = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _k !== void 0 ? _k : "none") !== "none",
+          defaultChecked: ((_h = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _h !== void 0 ? _h : "none") !== "none",
           label: t("purchase-label:fields.insurance"),
           name: "insuranceEnabled",
           onChange: e => {
@@ -16123,7 +16110,7 @@ const ShipmentForm = ({
             });
           },
           shouldUnmount: true,
-          value: ((_l = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _l !== void 0 ? _l : "none") !== "none"
+          value: ((_j = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _j !== void 0 ? _j : "none") !== "none"
         }, {
           children: [insuranceProviderOptions.length === 1 && insuranceProviderOptions[0].value === "carrier" ? null : jsxRuntime.jsx(Select, {
             control: form.control,
@@ -16147,7 +16134,7 @@ const ShipmentForm = ({
             showCurrencySymbol: true
           })]
         })), hasUpsOptions && jsxRuntime.jsx(Switch, {
-          defaultChecked: ((_m = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _m === void 0 ? void 0 : _m.additionalHandling) || false,
+          defaultChecked: ((_k = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _k === void 0 ? void 0 : _k.additionalHandling) || false,
           label: jsxRuntime.jsx(reactI18next.Trans, {
             components: {
               Link: jsxRuntime.jsx(giger.Link, {
@@ -18774,7 +18761,27 @@ const PurchaseLabelByShipment = _a => {
  * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
  */
 const Component$2 = _a => {
-  var props = __rest(_a, []);
+  var _b;
+  var {
+      features
+    } = _a,
+    props = __rest(_a, ["features"]);
+  const {
+    t
+  } = reactI18next.useTranslation();
+  const warehouses = alchemy.useListWarehouses();
+  const carriers = alchemy.useListCarriers();
+  const incompleteRequirementsKeys = React.useMemo(() => {
+    var _a, _b;
+    const isMissingWarehouse = ((_a = warehouses.data) === null || _a === void 0 ? void 0 : _a.length) === 0;
+    const isMissingCarrier = ((_b = carriers.data) === null || _b === void 0 ? void 0 : _b.length) === 0;
+    return isMissingWarehouse && isMissingCarrier ? ["noWarehouseOrCarrier"] : [isMissingWarehouse && "noWarehouse", isMissingCarrier && "noCarrier"].filter(Boolean);
+  }, [carriers, warehouses]);
+  const partnerMessages = (_b = features === null || features === void 0 ? void 0 : features.partnerMessages) === null || _b === void 0 ? void 0 : _b.incompleteLabelPurchaseRequirements;
+  const incompleteRequirementsError = partnerMessages ? partnerMessages : t("errorMessages.incompleteLabelPurchaseRequirements", {
+    requirements: incompleteRequirementsKeys.map(key => t(`purchase-label:requirements.${key}`))
+  });
+  if (incompleteRequirementsKeys.length > 0) throw new Error(incompleteRequirementsError);
   if ("salesOrderId" in props || "orderSourceCode" in props) {
     return jsxRuntime.jsx(PurchaseLabelBySalesOrder, Object.assign({}, props));
   } else {

package/index.js

@@ -2616,6 +2616,14 @@ const featureFlags = {
      * Elements.
      */
     compatibleCountryCodes: ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"],
+    /**
+     * @internal
+     *
+     * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
+     */
+    partnerMessages: {
+      incompleteLabelPurchaseRequirements: undefined
+    },
     /**
      *  `rateForm` all scoped feature flags for the `rate form` section of the `<PurchaseLabel />`
      *  element.
@@ -2669,14 +2677,6 @@ const featureFlags = {
        * to opt for third party insurance when insuring their shipment.
        */
       includeThirdPartyInsurance: true,
-      /**
-       * @internal
-       *
-       * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
-       */
-      partnerMessages: {
-        incompleteLabelPurchaseRequirements: undefined
-      },
       /**
        * `selectService` enables the `select service` feature, allowing users to select a service
        * when rate shopping across multiple carrier providers.
@@ -15379,7 +15379,7 @@ const ShipmentForm = ({
   warehouseId,
   warehouses
 }) => {
-  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
   features = Object.assign({
     browseRates: true,
     includeShipsuranceInsurance: true,
@@ -15565,16 +15565,16 @@ const ShipmentForm = ({
   }, [form]);
   const handleSubmit = form.handleSubmit(values => __awaiter(void 0, void 0, void 0, function* () {
     try {
-      const _o = values,
+      const _l = values,
         {
           __mode: discard
-        } = _o,
-        payload = __rest(_o, ["__mode"]);
+        } = _l,
+        payload = __rest(_l, ["__mode"]);
       const updatedShipment = yield onSubmit(Object.assign(Object.assign({}, shipment || {}), payload));
       // Defer shipment hydration to the task queue so that the submission promise resolves first, otherwise the
       // submission count will increment after hydration resets the form, keeping it in revalidate mode
       if (updatedShipment) setTimeout(() => hydrateShipment(updatedShipment), 0);
-    } catch (_p) {
+    } catch (_m) {
       // Reset the form to its current state, but as a side effect this sets isDirty to false
       // That way, form lifecycle contract is upheld
       form.reset(form.getValues());
@@ -15707,19 +15707,6 @@ const ShipmentForm = ({
   const hasUpsOptions = useMemo(() => {
     return (packageOptions === null || packageOptions === void 0 ? void 0 : packageOptions.some(option => option.label === "UPS")) && ((selectedPackage === null || selectedPackage === void 0 ? void 0 : selectedPackage.code) === "package" || selectedCarrierId === upsCarrierId);
   }, [packageOptions, selectedPackage, selectedCarrierId, upsCarrierId]);
-  const incompleteRequirementsKeys = useMemo(() => {
-    if ((warehouses === null || warehouses === void 0 ? void 0 : warehouses.length) === 0 && (carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0) {
-      return ["noWarehouseOrCarrier"];
-    } else {
-      const keys = [(warehouses === null || warehouses === void 0 ? void 0 : warehouses.length) === 0 && "noWarehouse", (carriers === null || carriers === void 0 ? void 0 : carriers.length) === 0 && "noCarrier"].filter(Boolean);
-      return keys;
-    }
-  }, [carriers, warehouses]);
-  const isPartnerMessagingEnabled = !!((_d = features.partnerMessages) === null || _d === void 0 ? void 0 : _d.incompleteLabelPurchaseRequirements);
-  const incompleteRequirementsError = isPartnerMessagingEnabled ? (_e = features.partnerMessages) === null || _e === void 0 ? void 0 : _e.incompleteLabelPurchaseRequirements : t("errorMessages.incompleteLabelPurchaseRequirements", {
-    requirements: incompleteRequirementsKeys.map(key => t(`purchase-label:requirements.${key}`))
-  });
-  if (incompleteRequirementsKeys.length > 0) throw new Error(incompleteRequirementsError);
   if (isLoading) return jsx(Loader, {
     message: t("loading.shipment")
   });
@@ -15793,7 +15780,7 @@ const ShipmentForm = ({
         }, {
           children: formatDate(salesOrder.orderDate)
         })), jsx(Spacer, {})]
-      })), ((_f = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.paymentDetails) === null || _f === void 0 ? void 0 : _f.grandTotal) && jsxs(FieldLabel, Object.assign({
+      })), ((_d = salesOrder === null || salesOrder === void 0 ? void 0 : salesOrder.paymentDetails) === null || _d === void 0 ? void 0 : _d.grandTotal) && jsxs(FieldLabel, Object.assign({
         label: t("purchase-label:fields.orderValue")
       }, {
         children: [jsx(Typography, Object.assign({
@@ -15871,7 +15858,7 @@ const ShipmentForm = ({
       }), jsx(CustomsItemsDisplay, {
         onUpdate: handleUpdateCustomsItems,
         shipment: shipment
-      }), ((_g = customsErrors === null || customsErrors === void 0 ? void 0 : customsErrors.customsItems) === null || _g === void 0 ? void 0 : _g.type) === "too_small" && jsxs(Fragment, {
+      }), ((_e = customsErrors === null || customsErrors === void 0 ? void 0 : customsErrors.customsItems) === null || _e === void 0 ? void 0 : _e.type) === "too_small" && jsxs(Fragment, {
         children: [jsx(Spacer, {}), jsx(InlineNotification, {
           title: t("purchase-label:errorMessages.customsItemsRequired"),
           type: NotificationType.ERROR
@@ -16062,14 +16049,14 @@ const ShipmentForm = ({
         label: "purchase-label:fields.addOns"
       }, {
         children: [jsx(Switch, Object.assign({
-          defaultChecked: ((_h = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _h !== void 0 ? _h : "none") !== "none",
+          defaultChecked: ((_f = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _f !== void 0 ? _f : "none") !== "none",
           label: t("purchase-label:fields.confirmation"),
           name: "confirmationEnabled",
           onChange: e => form.setValue("confirmation", e.target.checked ? SE.ConfirmationType.DELIVERY : undefined, {
             shouldDirty: true
           }),
           shouldUnmount: true,
-          value: ((_j = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _j !== void 0 ? _j : "none") !== "none"
+          value: ((_g = shipment === null || shipment === void 0 ? void 0 : shipment.confirmation) !== null && _g !== void 0 ? _g : "none") !== "none"
         }, {
           children: jsx(Select, {
             control: form.control,
@@ -16081,7 +16068,7 @@ const ShipmentForm = ({
             shouldUnregister: true
           })
         })), jsxs(Switch, Object.assign({
-          defaultChecked: ((_k = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _k !== void 0 ? _k : "none") !== "none",
+          defaultChecked: ((_h = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _h !== void 0 ? _h : "none") !== "none",
           label: t("purchase-label:fields.insurance"),
           name: "insuranceEnabled",
           onChange: e => {
@@ -16091,7 +16078,7 @@ const ShipmentForm = ({
             });
           },
           shouldUnmount: true,
-          value: ((_l = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _l !== void 0 ? _l : "none") !== "none"
+          value: ((_j = shipment === null || shipment === void 0 ? void 0 : shipment.insuranceProvider) !== null && _j !== void 0 ? _j : "none") !== "none"
         }, {
           children: [insuranceProviderOptions.length === 1 && insuranceProviderOptions[0].value === "carrier" ? null : jsx(Select, {
             control: form.control,
@@ -16115,7 +16102,7 @@ const ShipmentForm = ({
             showCurrencySymbol: true
           })]
         })), hasUpsOptions && jsx(Switch, {
-          defaultChecked: ((_m = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _m === void 0 ? void 0 : _m.additionalHandling) || false,
+          defaultChecked: ((_k = shipment === null || shipment === void 0 ? void 0 : shipment.advancedOptions) === null || _k === void 0 ? void 0 : _k.additionalHandling) || false,
           label: jsx(Trans, {
             components: {
               Link: jsx(Link, {
@@ -18742,7 +18729,27 @@ const PurchaseLabelByShipment = _a => {
  * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
  */
 const Component$2 = _a => {
-  var props = __rest(_a, []);
+  var _b;
+  var {
+      features
+    } = _a,
+    props = __rest(_a, ["features"]);
+  const {
+    t
+  } = useTranslation();
+  const warehouses = useListWarehouses();
+  const carriers = useListCarriers();
+  const incompleteRequirementsKeys = useMemo(() => {
+    var _a, _b;
+    const isMissingWarehouse = ((_a = warehouses.data) === null || _a === void 0 ? void 0 : _a.length) === 0;
+    const isMissingCarrier = ((_b = carriers.data) === null || _b === void 0 ? void 0 : _b.length) === 0;
+    return isMissingWarehouse && isMissingCarrier ? ["noWarehouseOrCarrier"] : [isMissingWarehouse && "noWarehouse", isMissingCarrier && "noCarrier"].filter(Boolean);
+  }, [carriers, warehouses]);
+  const partnerMessages = (_b = features === null || features === void 0 ? void 0 : features.partnerMessages) === null || _b === void 0 ? void 0 : _b.incompleteLabelPurchaseRequirements;
+  const incompleteRequirementsError = partnerMessages ? partnerMessages : t("errorMessages.incompleteLabelPurchaseRequirements", {
+    requirements: incompleteRequirementsKeys.map(key => t(`purchase-label:requirements.${key}`))
+  });
+  if (incompleteRequirementsKeys.length > 0) throw new Error(incompleteRequirementsError);
   if ("salesOrderId" in props || "orderSourceCode" in props) {
     return jsx(PurchaseLabelBySalesOrder, Object.assign({}, props));
   } else {

package/package.json

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

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

@@ -12,9 +12,6 @@ export type ShipmentFormFeatures = {
     browseRates?: boolean;
     includeShipsuranceInsurance?: boolean;
     includeThirdPartyInsurance?: boolean;
-    partnerMessages?: {
-        incompleteLabelPurchaseRequirements?: string;
-    };
     selectService?: boolean;
     shippingPresets?: boolean;
 };

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

@@ -25,6 +25,9 @@ export type RateFormFeatures = {
 };
 export type ConfigureShipmentFeatures = {
     compatibleCountryCodes?: UseShipmentFormProps["compatibleCountryCodes"];
+    partnerMessages?: {
+        incompleteLabelPurchaseRequirements?: string;
+    };
     presentation?: {
         poweredByShipEngine?: boolean;
     };

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

@@ -149,7 +149,7 @@ export type ElementProps = PurchaseLabelByShipmentProps | PurchaseLabelSalesOrde
  *
  * @see {@link PurchaseLabel.Element | The **Element** created to render `<PurchaseLabel />`}
  */
-export declare const Component: ({ ...props }: ElementProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ features, ...props }: ElementProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Purchase Label Element
  *
@@ -254,7 +254,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 highVolumeForms: string;
                 multipleShippingServices: string;
                 sections: {
-                    labels: string;
+                    labels: string; /**
+                     *`getPreferredRates is an async/sync optional callback function that will be invoked each time rates are caculated.
+                     * This is an optional callback function that returns an array of ShipEngine rates. The rates from this response will
+                     * be spliced into the normal get rates response the Elements makes internally. If a service code matches a service
+                     * code on a rate returned from getPreferredRates, the rate returned from getPreferredRates will not be shown in the
+                     * rate form. These preferred rates will be displayed with a set of UI enhancements that incude a dynamic cost savings
+                     * flag and green checkmark when the rate is selected.
+                     */
                 };
                 noLabels: string;
             };
@@ -328,22 +335,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     currentBalance: string;
                     insufficientBalanceCTA: string;
                 };
-                /**
-                 * # Purchase Label Component Props
-                 *
-                 * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
-                 * for either shipment-based or sales order-based label purchasing.
-                 *
-                 * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
-                 */
                 cta: {
                     addPackageDetails: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
-                    invalidAddress: string; /**
-                     * `features` is a set of feature flags you would like to enable or disable in this component.
-                     */
+                    invalidAddress: string;
                     noRates: string;
                     salesOrderNotLoaded: string;
                     unsupportedAddress: string;
@@ -367,19 +364,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     estimatedShipping: string;
                     insurance: string;
                     insuranceProvider: string;
-                    insuredValue: string; /**
-                     *  `onApplyPreset` is an async/sync callback function that will be invoked each time a `Preset`
-                     *  has been applied to a shipment.
-                     */
+                    insuredValue: string;
                     items: string;
                     orderDate: string;
                     orderValue: string;
                     packageCode: string;
                     requestedShipping: string;
-                    shipDate: string; /**
-                     * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
-                     * label purchase.
-                     */
+                    shipDate: string;
                     service: string;
                     shipTo: string;
                     addShipToAddress: string;
@@ -392,6 +383,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     today: string;
                 };
                 hints: {
+                    /**
+                     * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
+                     * saves a rate.
+                     */
                     contentDescription: string;
                 };
                 loading: {
@@ -410,15 +405,15 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 rates: {
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
-                    rateSavings: string;
+                    rateSavings: string; /**
+                     * `onLabelCreateSuccess` is an async/sync callback provided by the client that is invoked if the
+                     * label is successfully created/purchased.
+                     */
                     upsGroundSaverTermsAcknowledgement: string;
                     dhlExpressTermsAcknowledgement: string;
                 };
                 requirements: {
-                    noWarehouse: string; /**
-                     * `onRateSaved` is an async/sync callback function that will be invoked each time a rate is
-                     * saved by the user when rate shopping in the host application.
-                     */
+                    noWarehouse: string;
                     noCarrier: string;
                     noWarehouseOrCarrier: string;
                 };
@@ -458,6 +453,9 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     inlineMessage: string;
                 };
                 success: {
+                    /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                     title: string;
                     subtitle: string;
                     action: string;
@@ -482,14 +480,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 status: {
                     saving: string;
                     saved: string;
-                    /**
-                     * # Purchase Label Component Props
-                     *
-                     * These are the shared props that will be passed into the `<PurchaseLabel.Element />`, and work
-                     * for either shipment-based or sales order-based label purchasing.
-                     *
-                     * @see {@link PurchaseLabel.Element | This prop types usage in `<PurchaseLabel.Element />`}
-                     */
                     savingFailed: string;
                 };
                 units: {
@@ -503,9 +493,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         title: string;
                         standard: string;
                         g: string;
-                        kg: string; /**
-                         * `features` is a set of feature flags you would like to enable or disable in this component.
-                         */
+                        kg: string;
                     };
                 };
             };
@@ -683,10 +671,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     none: string;
                     signature: string;
                     verbalConfirmation: string;
-                }; /**
-                 * `onLabelCreateFailure` is an async/sync callback function that will be invoked each time a
-                 * label purchase fails.
-                 */
+                };
                 customs: {
                     addDeclaration: string;
                     contents: {
@@ -725,6 +710,12 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         autoFundingSettings: string;
                         carrier: string;
                         carriers: string;
+                        /**
+                         * `onToggleAddressPreferenceDisclosure` is an async/sync callback function that will be invoked
+                         * each time the user toggles the `Address Preference` disclosure. This disclosure component
+                         * allows the user to select whether they would like to use the address they entered, or
+                         * the formatted address that we return after validation.
+                         */
                         label: string;
                         salesOrder: string;
                         shipment: string;
@@ -757,7 +748,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     connectingCarriers: string;
                     data: string;
                     importingSalesOrder: string;
-                    label: string;
+                    label: string; /**
+                     * `warehouseId` is a string that represents a previously configured warehouse you would
+                     * like to use as the `Ship From Address` when purchasing a label.
+                     */
                     onboarding: string;
                     salesOrder: string;
                     shipment: string;

package/src/utilities/feature-flags.d.ts

@@ -51,6 +51,14 @@ export declare const featureFlags: {
          * Elements.
          */
         readonly compatibleCountryCodes: readonly ["AU", "CA", "FR", "DE", "GB", "IL", "IT", "NO", "ES", "SE", "US"];
+        /**
+         * @internal
+         *
+         * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
+         */
+        readonly partnerMessages: {
+            readonly incompleteLabelPurchaseRequirements: undefined;
+        };
         /**
          *  `rateForm` all scoped feature flags for the `rate form` section of the `<PurchaseLabel />`
          *  element.
@@ -104,14 +112,6 @@ export declare const featureFlags: {
              * to opt for third party insurance when insuring their shipment.
              */
             readonly includeThirdPartyInsurance: true;
-            /**
-             * @internal
-             *
-             * `partnerMessages` enables the partner consuming elements to specify override messages in specific cases.
-             */
-            readonly partnerMessages: {
-                readonly incompleteLabelPurchaseRequirements: undefined;
-            };
             /**
              * `selectService` enables the `select service` feature, allowing users to select a service
              * when rate shopping across multiple carrier providers.