@shipengine/elements 1.3.2 → 1.5.0

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

@@ -321,6 +321,24 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     noCarrier: string;
                     noWarehouseOrCarrier: string;
                 };
+                servicePoints: {
+                    searchLabel: string;
+                    noRatesForType: string;
+                    dropOff: string;
+                    pickUp: string;
+                    closed: string;
+                    hideLocations: string;
+                    moreLocations: string;
+                    nearestLocation: string;
+                    open: string;
+                    nextOpeningDay: string;
+                    until: string;
+                    selected: string;
+                    selectLocation: string;
+                    viewMap: string;
+                    otherLocations: string;
+                    noServicePointsFound: string;
+                };
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
@@ -371,11 +389,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                    "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                    RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
                 };
             };
             "manage-defaults": {
@@ -481,9 +501,42 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     balanceUnknown: string;
                     unableToFindBalance: string;
                 };
+                byoc: {
+                    invoiceNotification: string;
+                };
                 currentBalance: string;
                 maximumBalanceAmount: string;
             };
+            "list-shipments": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    shipmentId: string;
+                    shipDate: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
+            "list-labels": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    labelId: string;
+                    service: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
             "list-carriers": {
                 title: string;
                 headers: {
@@ -609,8 +662,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    currencyChange: string;
                     declarations: string;
-                    each: string;
+                    descriptionTooltip: {
+                        message: string;
+                        example1: string;
+                        example2: string;
+                    };
                     fields: {
                         contentsType: string;
                         countryOfOrigin: string;
@@ -642,10 +700,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         connectCarrierForm: string;
                         fundingSourceMetadata: string;
                         label: string;
+                        labels: string;
                         salesOrder: string;
                         shipment: string;
+                        shipments: string;
                         warehouses: string;
                     };
+                    emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
                 };
@@ -683,9 +744,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     data: string;
                     importingSalesOrder: string;
                     label: string;
+                    labels: string;
                     onboarding: string;
                     salesOrder: string;
                     shipment: string;
+                    shipments: string;
                     warehouses: string;
                 };
                 months: {
@@ -721,6 +784,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
+                    invalidAddressOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;
@@ -777,10 +841,26 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
             "connect-carrier": {
+                actions: {
+                    cancel: string;
+                    connectCarriers: string;
+                    disconnect: string;
+                    disconnectCarrier: string;
+                };
+                noCarriersDescription: string;
                 registrationForm: {
+                    error: string;
                     title: string;
                     betaWarning: string;
                 };
+                search: string;
+                settingsModal: {
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
             };
             "account-settings": {
                 messages: {
@@ -794,6 +874,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: string;
+                    externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
                 };

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

@@ -319,6 +319,24 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     noCarrier: string;
                     noWarehouseOrCarrier: string;
                 };
+                servicePoints: {
+                    searchLabel: string;
+                    noRatesForType: string;
+                    dropOff: string;
+                    pickUp: string;
+                    closed: string;
+                    hideLocations: string;
+                    moreLocations: string;
+                    nearestLocation: string;
+                    open: string;
+                    nextOpeningDay: string;
+                    until: string;
+                    selected: string;
+                    selectLocation: string;
+                    viewMap: string;
+                    otherLocations: string;
+                    noServicePointsFound: string;
+                };
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
@@ -372,11 +390,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+                    "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+                    RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
                 };
             };
             "manage-defaults": {
@@ -482,9 +502,42 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     balanceUnknown: string;
                     unableToFindBalance: string;
                 };
+                byoc: {
+                    invoiceNotification: string;
+                };
                 currentBalance: string;
                 maximumBalanceAmount: string;
             };
+            "list-shipments": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    shipmentId: string;
+                    shipDate: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
+            "list-labels": {
+                title: string;
+                headers: {
+                    created: string;
+                    download: string;
+                    labelId: string;
+                    service: string;
+                    shipTo: string;
+                };
+                actions: {
+                    download: {
+                        pdf: string;
+                    };
+                };
+            };
             "list-carriers": {
                 title: string;
                 headers: {
@@ -607,8 +660,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    currencyChange: string;
                     declarations: string;
-                    each: string;
+                    descriptionTooltip: {
+                        message: string;
+                        example1: string;
+                        example2: string;
+                    };
                     fields: {
                         contentsType: string;
                         countryOfOrigin: string;
@@ -640,10 +698,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         connectCarrierForm: string;
                         fundingSourceMetadata: string;
                         label: string;
+                        labels: string;
                         salesOrder: string;
                         shipment: string;
+                        shipments: string;
                         warehouses: string;
                     };
+                    emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
                 };
@@ -681,9 +742,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     data: string;
                     importingSalesOrder: string;
                     label: string;
+                    labels: string;
                     onboarding: string;
                     salesOrder: string;
                     shipment: string;
+                    shipments: string;
                     warehouses: string;
                 };
                 months: {
@@ -719,6 +782,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
+                    invalidAddressOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;
@@ -775,10 +839,26 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
             "connect-carrier": {
+                actions: {
+                    cancel: string;
+                    connectCarriers: string;
+                    disconnect: string;
+                    disconnectCarrier: string;
+                };
+                noCarriersDescription: string;
                 registrationForm: {
+                    error: string;
                     title: string;
                     betaWarning: string;
                 };
+                search: string;
+                settingsModal: {
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
             };
             "account-settings": {
                 messages: {
@@ -792,8 +872,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: string;
+                    externalCarriers: string;
                     labelLayout: string;
-                    unitSettings: string;
+                    unitSettings: string; /**
+                     * `features` is a set of feature flags you would like to enable or disable in this component.
+                     */
                 };
             };
         };

package/src/factories/shipengine/service-point.d.ts

@@ -0,0 +1,3 @@
+import { Factory } from "fishery";
+import type { SE } from "@shipengine/alchemy";
+export declare const servicePointFactory: Factory<SE.ServicePoint, any, SE.ServicePoint>;

package/src/hooks/options/index.d.ts

@@ -12,3 +12,4 @@ export * from "./use-shipment-metadata";
 export * from "./use-shipping-presets-options";
 export * from "./use-state-code-options";
 export * from "./use-warehouse-options";
+export * from "./use-service-points";

package/src/hooks/options/use-rate-options.d.ts

@@ -1,5 +1,14 @@
 import { SE } from "@shipengine/alchemy";
 import { PreferredRateAcknowledgementMessage, PreferredRatesResponse } from "../../elements/configure-shipment";
+/**
+ * @internal
+ *
+ * # Rate Options Hook - PUDO type
+ */
+export declare enum PudoType {
+    PICKUP = "pick_up",
+    DROPOFF = "drop_off"
+}
 /**
  * @internal
  *
@@ -8,13 +17,15 @@ import { PreferredRateAcknowledgementMessage, PreferredRatesResponse } from "../
 export type RateOption = Omit<SE.Rate, "warningMessages"> & {
     balance?: number;
     messages: string[];
+    pudoType?: PudoType;
     rateAcknowledgementMessage?: PreferredRateAcknowledgementMessage;
     requiresAcknowledgement?: boolean;
     requiresFundedAmount?: boolean;
+    servicePoints?: SE.ServicePoint[];
 };
 /**
  * @internal
  *
  * # Rate Options Hook
  */
-export declare const useRateOptions: (rates?: SE.Rate[], preferredRates?: PreferredRatesResponse, carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean, requireDhlTermsAcknowledgement?: boolean) => RateOption[];
+export declare const useRateOptions: (rates?: SE.Rate[], preferredRates?: PreferredRatesResponse, carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, servicePoints?: SE.ServicePoint[], enableGlobalPostFiltering?: boolean, requireDhlTermsAcknowledgement?: boolean) => RateOption[];

package/src/hooks/options/use-service-points.d.ts

@@ -0,0 +1,8 @@
+import { Rate, SE } from "@shipengine/alchemy";
+export declare const useServicePoints: (rates?: Rate[], shipment?: SE.SalesOrderShipment) => {
+    fetchServicePointsByPostalCode: (postalCode: string) => void;
+    listServicePointsErrors: SE.CodedError[] | null;
+    nestedServicePointErrors: SE.CodedError[] | SE.ServicePointCustomError[] | undefined;
+    servicePoints: SE.ServicePoint[];
+    servicePointsFetching: boolean;
+};

package/src/hooks/use-nested-form.d.ts

@@ -9,6 +9,9 @@ export type NestedFormProps<T, U> = {
     onCancel?: () => void;
     onSubmit: (payload: U) => Promise<void> | void;
 } & T;
+type HookProps = {
+    initialOpenState?: boolean;
+};
 /**
  * @internal
  *
@@ -28,4 +31,5 @@ export declare const useNestedForm: <T, U>(form: React.FC<NestedFormProps<T, U>>
     onSubmit: (payload: U) => Promise<void> | void;
 } & T & {
     portalRef?: undefined;
-}) => readonly [import("@emotion/react/jsx-runtime").JSX.Element, boolean, React.DispatchWithoutAction];
+}, hookProps?: HookProps) => readonly [import("@emotion/react/jsx-runtime").JSX.Element, boolean, React.DispatchWithoutAction];
+export {};

package/src/locales/en/index.d.ts

@@ -218,6 +218,24 @@ declare const _default: {
             noCarrier: string;
             noWarehouseOrCarrier: string;
         };
+        servicePoints: {
+            searchLabel: string;
+            noRatesForType: string;
+            dropOff: string;
+            pickUp: string;
+            closed: string;
+            hideLocations: string;
+            moreLocations: string;
+            nearestLocation: string;
+            open: string;
+            nextOpeningDay: string;
+            until: string;
+            selected: string;
+            selectLocation: string;
+            viewMap: string;
+            otherLocations: string;
+            noServicePointsFound: string;
+        };
         shipToAddressFormFields: string;
         sections: {
             customsForm: string;
@@ -268,11 +286,13 @@ declare const _default: {
             "aHR0cHM6Ly93d3cuZXZyaS5jb20vdGVybXMtYW5kLWNvbmRpdGlvbnM=": string;
             "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
             aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
+            "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
         };
         termsAndAgreementTitles: {
             "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
             "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
             "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
+            RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
         };
     };
     "manage-defaults": {
@@ -372,9 +392,42 @@ declare const _default: {
             balanceUnknown: string;
             unableToFindBalance: string;
         };
+        byoc: {
+            invoiceNotification: string;
+        };
         currentBalance: string;
         maximumBalanceAmount: string;
     };
+    "list-shipments": {
+        title: string;
+        headers: {
+            created: string;
+            download: string;
+            shipmentId: string;
+            shipDate: string;
+            shipTo: string;
+        };
+        actions: {
+            download: {
+                pdf: string;
+            };
+        };
+    };
+    "list-labels": {
+        title: string;
+        headers: {
+            created: string;
+            download: string;
+            labelId: string;
+            service: string;
+            shipTo: string;
+        };
+        actions: {
+            download: {
+                pdf: string;
+            };
+        };
+    };
     "list-carriers": {
         title: string;
         headers: {
@@ -497,8 +550,13 @@ declare const _default: {
                 returnedGoods: string;
                 sample: string;
             };
+            currencyChange: string;
             declarations: string;
-            each: string;
+            descriptionTooltip: {
+                message: string;
+                example1: string;
+                example2: string;
+            };
             fields: {
                 contentsType: string;
                 countryOfOrigin: string;
@@ -530,10 +588,13 @@ declare const _default: {
                 connectCarrierForm: string;
                 fundingSourceMetadata: string;
                 label: string;
+                labels: string;
                 salesOrder: string;
                 shipment: string;
+                shipments: string;
                 warehouses: string;
             };
+            emailIsRequired: string;
             unknown: string;
             noRatesAvailable: string;
         };
@@ -571,9 +632,11 @@ declare const _default: {
             data: string;
             importingSalesOrder: string;
             label: string;
+            labels: string;
             onboarding: string;
             salesOrder: string;
             shipment: string;
+            shipments: string;
             warehouses: string;
         };
         months: {
@@ -609,6 +672,7 @@ declare const _default: {
             };
             invalidAddressName: string;
             invalidAddressNameStrict: string;
+            invalidAddressOnboarding: string;
             invalidAddressPoBox: string;
             invalidCreditCardType: string;
             invalidExpirationDate: string;
@@ -665,10 +729,26 @@ declare const _default: {
         "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
     };
     "connect-carrier": {
+        actions: {
+            cancel: string;
+            connectCarriers: string;
+            disconnect: string;
+            disconnectCarrier: string;
+        };
+        noCarriersDescription: string;
         registrationForm: {
+            error: string;
             title: string;
             betaWarning: string;
         };
+        search: string;
+        settingsModal: {
+            closeDialog: string;
+            header: string;
+        };
+        status: {
+            connected: string;
+        };
     };
     "account-settings": {
         messages: {
@@ -682,6 +762,7 @@ declare const _default: {
             adjustmentHistory: string;
             warehouses: string;
             carriers: string;
+            externalCarriers: string;
             labelLayout: string;
             unitSettings: string;
         };

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

@@ -41,6 +41,12 @@
  * ```
  */
 export declare const featureFlags: {
+    /**
+     * `CarrierConnections` all scoped feature flags for "Bring your own carrier" connections.
+     */
+    readonly CarrierConnections: {
+        readonly availableCarrierConnections: readonly ["apc", "asendia", "better_trucks", "canpar", "chronopost", "couriers_please", "courierpost", "dpd", "hermes_germany", "intelliquick_delivery", "lso", "ontrac", "seko", "ups", "yodel"];
+    };
     /**
      * `ConfigureSalesOrderShipment` all scoped feature flags for the shipment configuration
      * section of the `<PurchaseLabel />` element.
@@ -82,6 +88,10 @@ export declare const featureFlags: {
              * in the rates form.
              */
             readonly enableGlobalPostFiltering: false;
+            /**
+            `enablePudoUI` enables the Pick Up/Drop Off tabs UI in the Rate Form to separate rates with PUDO capability by type.
+             */
+            readonly enablePudoUI: false;
             /**
              * `labelLayout` enables the `label layout` section of the `<PurchaseLabel /> element.
              */
@@ -105,6 +115,11 @@ export declare const featureFlags: {
          * `<PurchaseLabel />` element.
          */
         readonly shipmentForm: {
+            /**
+             * `addOns` enables the `Add-Ons` section of the shipment form. This allows users to
+             * add additional services to their shipment such as delivery confirmation and insurance.
+             */
+            readonly addOns: true;
             /**
              * `browseRates` enables the `browse rates` button in the shipment form. This allows users
              * to browse rates for a shipment with varying shipment configurations. This is useful for
@@ -146,7 +161,7 @@ export declare const featureFlags: {
              * `enabledCarriers` is a list of all `carriers` that are enabled for use in ShipEngine
              * Elements.
              */
-            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted"];
+            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted", "dpdwallet"];
         };
         /**
          * All global `presentation` related feature flags.

package/src/utilities/rates.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/alchemy";
+import { Rate, SE } from "@shipengine/alchemy";
 /**
  * @internal
  *
@@ -29,3 +29,5 @@ export declare const getTotalRateAmount: (rateCosts?: {
  * @category Utilities
  */
 export declare const overrideCarrierCodes: (carrier: string, overrides: object) => never;
+export declare const isPudoEligibleRate: (rate: Rate) => boolean;
+export declare const isCollectionService: (carrier: string, serviceCode: string) => boolean;

package/src/utilities/shipengine/address.d.ts

@@ -55,3 +55,12 @@ export declare const isPoBoxAddress: (address: SE.Address) => boolean;
  * @category Utilities
  */
 export declare const isEmptyAddress: (address?: SE.Address) => boolean;
+/**
+ * @internal
+ *
+ * # Address Utilities - addEmailToValidation
+ *  Even though the documentation says otherwise, the email is dropped from the returned address validation object
+ *
+ * @category Utilities
+ */
+export declare const addEmailToValidation: (addressValidation: SE.AddressValidation, email?: string) => SE.AddressValidation;