@shipengine/elements 1.5.1 → 1.7.0

package/src/elements/{configure-shipment → purchase-label}/configure-shipment.d.ts

@@ -2,19 +2,8 @@ import { SE } from "@shipengine/alchemy";
 import { RateFormProps } from "../../components/templates/rate-form";
 import { ShipmentFormFeatures, ShipmentFormProps } from "../../components/templates/shipment-form";
 import { UseShippingPresetsOptionsProps } from "../../hooks";
+import { PreferredRatesResponse } from "../../types";
 import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
-export type PreferredRateAcknowledgementMessage = {
-    link?: {
-        text: string;
-        url: string;
-    };
-    primaryMessage: string;
-    secondaryMessage?: string;
-};
-export type PreferredRatesResponse = Array<{
-    rate: SE.Rate;
-    rateAcknowledgementMessage?: PreferredRateAcknowledgementMessage;
-}>;
 export type ShipmentFormMode = "browse_rates" | "select_service";
 export type RateFormFeatures = {
     enableFunding?: boolean;

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

@@ -1,3 +1,11 @@
 export * from "./use-configure-shipment";
 export * from "./use-import-sales-order";
 export * from "./use-pending-shipment";
+export * from "./use-address";
+export * from "./use-customs";
+export * from "./use-presets";
+export * from "./use-rates-form";
+export * from "./use-shipment-form";
+export * from "./use-rates-with-cache";
+export * from "./use-request-rates";
+export * from "./use-request-preferred-rates";

package/src/elements/purchase-label/hooks/use-configure-shipment.d.ts

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/alchemy";
-import { ConfigureShipmentProps } from "../../configure-shipment";
+import { ConfigureShipmentProps } from "../configure-shipment";
 import { UsePendingShipmentProps } from "./use-pending-shipment";
 export type UseConfigureShipmentProps = {
     errorWhenShipmentCancelled?: boolean;

package/src/elements/{configure-shipment → purchase-label}/hooks/use-rates-form.d.ts

@@ -31,7 +31,7 @@ export declare const useRatesForm: ({ getPreferredRates, onBeforeRateSaved, onBe
     labelsLoading: boolean;
     onSave: ({ carrierId, serviceCode }: Pick<SE.Rate, "carrierId" | "serviceCode">) => Promise<void>;
     onSubmit: (rateId: string, servicePoint?: SE.ServicePoint) => Promise<void>;
-    preferredRates: import("..").PreferredRatesResponse | undefined;
+    preferredRates: import("../../..").PreferredRatesResponse | undefined;
     rates: SE.Rate[] | undefined;
     requestRates: (shipment: SE.SalesOrderShipment, isInternational: boolean) => Promise<void>;
     resetLabel: () => void;

package/src/elements/{configure-shipment → purchase-label}/hooks/use-rates-with-cache.d.ts

@@ -15,7 +15,7 @@ export type UseRatesWithCacheProps = {
  * (this transparently returns the behaviors to the default useRequestRates behavior)
  */
 export declare const useRatesWithCache: ({ shipment, onRatesCalculated, getPreferredRates, }: UseRatesWithCacheProps) => {
-    preferredRatesResponse: import("..").PreferredRatesResponse | undefined;
+    preferredRatesResponse: import("../../..").PreferredRatesResponse | undefined;
     ratesCalculating: boolean;
     ratesErrors: SE.CodedError[] | null;
     ratesResponse: {

package/src/elements/{configure-shipment → purchase-label}/hooks/use-request-preferred-rates.d.ts

@@ -4,4 +4,4 @@ export type RequestPreferredRatesProps = {
     getPreferredRates?: UseRequestRatesProps["getPreferredRates"];
 };
 export type CalculatePreferredRatesData = Parameters<Required<UseRequestRatesProps>["getPreferredRates"]>;
-export declare const useRequestPreferredRates: ({ getPreferredRates }: RequestPreferredRatesProps) => import("@tanstack/react-query").UseMutationResult<import("..").PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;
+export declare const useRequestPreferredRates: ({ getPreferredRates }: RequestPreferredRatesProps) => import("@tanstack/react-query").UseMutationResult<import("../../..").PreferredRatesResponse | undefined, SE.CodedError[], [shipment: SE.SalesOrderShipment, isInternational: boolean], unknown>;

package/src/elements/{configure-shipment → purchase-label}/hooks/use-request-rates.d.ts

@@ -1,5 +1,6 @@
 import { SE } from "@shipengine/alchemy";
-import { ConfigureShipmentProps, PreferredRatesResponse } from "../configure-shipment";
+import { PreferredRatesResponse } from "../../../types";
+import { ConfigureShipmentProps } from "../configure-shipment";
 export type UseRequestRatesProps = {
     getPreferredRates?: ConfigureShipmentProps["getPreferredRates"];
     onRatesCalculated?: (rates: SE.Rate[], shipment: SE.SalesOrderShipment) => Promise<void> | void;

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

@@ -1,6 +1,6 @@
 import React from "react";
 import { UseShippingPresetsOptionsProps } from "../../hooks";
-import { ConfigureShipmentProps } from "../configure-shipment";
+import { ConfigureShipmentProps } from "./configure-shipment";
 import { UseConfigureShipmentProps } from "./hooks";
 import { PurchaseLabelSalesOrderProps } from "./purchase-label-by-sales-order";
 import { PurchaseLabelByShipmentProps } from "./purchase-label-by-shipment";
@@ -270,6 +270,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     setup: {
                         title: string;
                         subtitle: string;
+                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -339,7 +340,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     addPackageDetails: string;
                 };
                 errorMessages: {
-                    customsItemsRequired: string;
+                    customsItemsRequired: 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 />`}
+                     */
                     invalidAddress: string;
                     noRates: string;
                     salesOrderNotLoaded: string;
@@ -382,14 +390,14 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     weightGroup: string;
                     today: string;
                 };
-                /**
-                 * `onBeforeLabelCreate` is an async/sync callback function that will be invoked before every
-                 * label purchase.
-                 */
                 hints: {
                     contentDescription: string;
                 };
                 loading: {
+                    /**
+                     * `onBeforeRateSave` is an async/sync callback function that will be invoked before each time a user
+                     * saves a rate.
+                     */
                     calculatingRates: string;
                 };
                 modes: {
@@ -403,6 +411,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     needToAcknowledge: string;
                 };
                 rates: {
+                    requestedShippingNotification: string;
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
                     rateSavings: string;
@@ -411,10 +420,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 };
                 requirements: {
                     noWarehouse: string;
-                    noCarrier: string; /**
-                     * `onLoad` is an async/sync callback provided by the host application that is invoked after the
-                     * element is loaded. (This may be useful to grab the shipmentId of a one-off label)
-                     */
+                    noCarrier: string;
                     noWarehouseOrCarrier: string;
                 };
                 servicePoints: {
@@ -430,7 +436,8 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     nextOpeningDay: string;
                     until: string;
                     selected: string;
-                    selectLocation: string;
+                    select: string;
+                    today: string;
                     viewMap: string;
                     otherLocations: string;
                     noServicePointsFound: string;
@@ -466,14 +473,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     fundingAndCarrierConnection: string;
                 };
                 warehouse: {
-                    /**
-                     * # 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 />`}
-                     */
                     title: string;
                     subtitle: string;
                     inlineMessage: string;
@@ -482,9 +481,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     title: string;
                     subtitle: string;
                     action: string;
-                }; /**
-                 * `features` is a set of feature flags you would like to enable or disable in this component.
-                 */
+                };
                 termsAndAgreementLinkText: {
                     aHR0cHM6Ly9teWRobC5leHByZXNzLmRobC91cy9lbi9sZWdhbC90ZXJtcy1hbmQtY29uZGl0aW9ucy5odG1s: string;
                     "aHR0cHM6Ly93d3cuc3RhbXBzLmNvbS9wcml2YWN5LXBvbGljeQ==": string;
@@ -496,12 +493,18 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9mci9tb2RhbGl0ZXMtZXQtY29uZGl0aW9ucy1kZS1zZXJ2aWNl: string;
+                    aHR0cHM6Ly93d3cucHVyb2xhdG9yLmNvbS9lbi90ZXJtcy1hbmQtY29uZGl0aW9ucy1zZXJ2aWNl: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
+                    "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
+                    UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
             };
             "manage-defaults": {
@@ -589,14 +592,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     minimumPurchaseAmount: string;
                     other: 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.
-                 */
                 fundAndPurchase: {
                     finalBalance: string;
                     insufficientFunds: string;
@@ -645,7 +640,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     };
                 };
             };
-            "list-carriers": {
+            "shipengine-carriers": {
                 title: string;
                 headers: {
                     accountCarriers: string;
@@ -705,14 +700,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         confirm: string;
                         addressNotValidated: string;
                         modified: string;
-                        title: 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.
-                         */
+                        title: string;
                         originalAddress: string;
                         matchedAddress: string;
                         unableToValidate: string;
@@ -760,13 +748,13 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                     adultSignature: string;
                     delivery: string;
                     deliveryMailed: string;
-                    directSignature: string;
-                    none: string;
-                    signature: string;
                     /**
                      * `onChangeShipmentFormMode` is an async/sync callback function that will be invoked each time
                      * the user toggles the `Shipment Form Mode` between `Browse Rates` and `Selected Rate`.
                      */
+                    directSignature: string;
+                    none: string;
+                    signature: string;
                     verbalConfirmation: string;
                 };
                 customs: {
@@ -797,10 +785,6 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         valueQuantity: string;
                     };
                     nonDelivery: {
-                        /**
-                         * `onRatesCalculated` is an async/sync callback function that will be invoked each time rates
-                         * are calculated for a given shipment.
-                         */
                         returnToSender: string;
                         treatAsAbandoned: string;
                     };
@@ -822,10 +806,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                         label: string;
                         labels: string;
                         salesOrder: string;
-                        shipment: string; /**
-                         * `printLabelLayout` is a string that represents the label layout you would like to use when
-                         * purchasing a label. e.g. `4x6`
-                         */
+                        shipment: string;
                         shipments: string;
                         warehouses: string;
                     };
@@ -966,6 +947,7 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
             "connect-carrier": {
                 actions: {
                     cancel: string;
+                    carrierSettings: string;
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
@@ -984,6 +966,10 @@ export declare const Element: ({ resources, ...props }: ElementProps & {
                 status: {
                     connected: string;
                 };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
+                };
             };
             "account-settings": {
                 messages: {

package/src/elements/shipengine-carriers/index.d.ts

@@ -0,0 +1 @@
+export * as ShipEngineCarriers from "./shipengine-carriers";