@shipengine/elements 2.9.1 → 2.10.0

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

@@ -53,6 +53,7 @@ declare const _default: {
             showItems: string;
             void: string;
             download: string;
+            fileClaim: string;
         };
         fields: {
             dimensions: string;
@@ -68,6 +69,20 @@ declare const _default: {
             insuredValue: string;
             deliveryConfirmation: string;
         };
+        insurance: {
+            parcelguard: {
+                title: string;
+                description: string;
+                cta: {
+                    title: string;
+                    description: string;
+                };
+                registerSuccess: {
+                    title: string;
+                    description: string;
+                };
+            };
+        };
         highVolumeForms: string;
         multipleShippingServices: string;
         sections: {
@@ -110,12 +125,6 @@ declare const _default: {
     };
     "register-wallet": {
         sections: {
-            setup: {
-                title: string;
-                subtitle: string;
-                descriptionTitle: string;
-                description: string;
-            };
             billing: {
                 title: string;
                 cardSubTitle: string;
@@ -128,6 +137,17 @@ declare const _default: {
                 title: string;
                 subtitle: string;
             };
+            insuranceProviders: {
+                parcelguard: {
+                    description: string;
+                    terms: string;
+                    termsLink: string;
+                    popover: {
+                        title: string;
+                        description: string;
+                    };
+                };
+            };
             notifications: {
                 error: {
                     title: string;
@@ -222,6 +242,7 @@ declare const _default: {
         };
         cta: {
             addPackageDetails: string;
+            parcelguard: string;
         };
         errorMessages: {
             customsItemsRequired: string;
@@ -292,6 +313,17 @@ declare const _default: {
             dhlExpressTermsAcknowledgement: string;
             noRateService: string;
         };
+        windsorFramework: {
+            movementIndicator: string;
+            movementIndicators: {
+                b2c: string;
+                c2b: string;
+                c2c: string;
+                b2b: string;
+            };
+            notAtRisk: string;
+            notAtRiskShipmentTootip: string;
+        };
         requirements: {
             noWarehouse: string;
             noCarrier: string;
@@ -322,6 +354,7 @@ declare const _default: {
         shipToAddressFormFields: string;
         sections: {
             customsForm: string;
+            windsorFramework: string;
             shipment: string;
             rate_one: string;
             rate_other: string;
@@ -346,6 +379,10 @@ declare const _default: {
             shipFromAddress: string;
             fundingAndCarrierConnection: string;
         };
+        termsAgreement: {
+            title: string;
+            subtitle: string;
+        };
         warehouse: {
             title: string;
             subtitle: string;
@@ -622,6 +659,7 @@ declare const _default: {
             continue: string;
             delete: string;
             edit: string;
+            enable: string;
             hide: string;
             parse: string;
             purchase: string;
@@ -782,6 +820,14 @@ declare const _default: {
             unknown: string;
             noRatesAvailable: string;
             refreshAndTryAgain: string;
+            windsorFramework: {
+                doNotConform: string;
+                pleaseAddTheFollowingTaxIds: string;
+                windsorFrameworkDefaultMessage: string;
+                shipperEori: string;
+                recipientEori: string;
+                ukims: string;
+            };
         };
         errorTypes: {
             accountStatus: string;
@@ -795,6 +841,7 @@ declare const _default: {
             system: string;
             unknown: string;
             validation: string;
+            windsorFramework: string;
         };
         grid: {
             "row-count_one": string;
@@ -821,8 +868,10 @@ declare const _default: {
         insuranceProviders: {
             carrier: string;
             none: string;
+            parcelguard: string;
             shipsurance: string;
             thirdParty: string;
+            x_cover: string;
         };
         loading: {
             accountSettings: string;
@@ -900,6 +949,9 @@ declare const _default: {
             platform: string;
             user: string;
         };
+        tags: {
+            new: string;
+        };
         terms: {
             fields: {
                 agreement: string;
@@ -907,6 +959,7 @@ declare const _default: {
             agreeToTerms: string;
             carriersTitle: string;
             fundingSourceTitle: string;
+            insuranceProvidersTitle: string;
             shipEngineTitle: string;
         };
         weight: {

package/src/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./carrier-metadata";
 export * from "./shipping-preset";
 export * from "./preferred-rates";
+export * from "./insurance-metadata";

package/src/types/insurance-metadata.d.ts

@@ -0,0 +1,25 @@
+import { SE } from "@shipengine/react-api";
+/**
+ * @internal
+ *
+ * # Insurance Metadata - Insurance Provider With Friendly Name
+ */
+export type InsuranceProviderWithFriendlyName = {
+    friendlyName: "ParcelGuard" | "XCover";
+    provider: SE.FundingSourceInsuranceProvider;
+};
+/**
+ * @internal
+ *
+ * # Insurance Metadata - Insurance Provider Profile
+ */
+export type InsuranceProviderProfile = {
+    agreedToTerms?: boolean;
+    terms: SE.MetadataOptionalTerm;
+} & InsuranceProviderWithFriendlyName;
+/**
+ * @internal
+ *
+ * # Insurance Metadata - Insurance Provider Record
+ */
+export type InsuranceProviderRecord = Record<string, InsuranceProviderWithFriendlyName>;

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

@@ -42,6 +42,10 @@ export type ShipmentFormFeatures = {
      * varying shipment configurations. This is useful for rate shopping.
      */
     browseRates?: boolean;
+    /**
+     * Enables the `carrier insurance` feature, allowing users to select carrier insurance when insuring their shipment.
+     */
+    includeCarrierInsurance?: boolean;
     /**
      * Enables the `shipsurance insurance` feature, allowing users to select Shipsurance when insuring their shipment.
      */
@@ -64,6 +68,10 @@ export type ShipmentSummaryFeatures = {
     schedulePickup?: boolean;
 };
 export type PurchaseLabelFeatures = {
+    /**
+     * Feature still in beta. When enabled, the Windsor Framework will display forms, messaging, and error messages if a shipment requires specific Windsor Framework features.
+     */
+    betaEnableWindsorFramework?: boolean;
     /**
      * List of all supported `countries` available in ShipEngine Elements.
      */

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

@@ -15,6 +15,22 @@ export declare const isUspsCarrier: (carrierCode: string) => boolean;
  * @category Utilities
  */
 export declare const isUpsCarrier: (carrierCode: string) => boolean;
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isYodelCarrier
+ *
+ * @category Utilities
+ */
+export declare const isYodelCarrier: (carrierCode: string) => boolean;
+/**
+ * @internal
+ *
+ * # Carrier Utilities - isEvriCarrier
+ *
+ * @category Utilities
+ */
+export declare const isEvriCarrier: (carrierCode: string) => boolean;
 /**
  * @internal
  *

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

@@ -6,3 +6,4 @@ export * from "./shipment";
 export * from "./weight";
 export * from "./package";
 export * from "./warehouses";
+export * from "./insurance";

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

@@ -0,0 +1,17 @@
+import { SE } from "@shipengine/react-api";
+/**
+ * @internal
+ *
+ * # Insurance Utilities - getInsuranceProviderWithFriendlyName
+ *
+ * @category Utilities
+ */
+export declare const getInsuranceProviderWithFriendlyName: (termType: string) => import("../../types").InsuranceProviderWithFriendlyName;
+/**
+ * @internal
+ *
+ * # Insurance Utilities - getIsInsuraceProviderAccepted
+ *
+ * @category Utilities
+ */
+export declare const getIsInsuraceProviderAccepted: (termType: string, acceptedTerms?: SE.Term[]) => boolean;

package/src/workflows/account-settings/account-settings.d.ts

@@ -89,6 +89,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -104,6 +105,20 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     insuredValue: string;
                     deliveryConfirmation: string;
                 };
+                insurance: {
+                    parcelguard: {
+                        title: string;
+                        description: string;
+                        cta: {
+                            title: string;
+                            description: string;
+                        };
+                        registerSuccess: {
+                            title: string;
+                            description: string;
+                        };
+                    };
+                };
                 highVolumeForms: string;
                 multipleShippingServices: string;
                 sections: {
@@ -148,12 +163,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -166,6 +175,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -260,6 +280,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -330,6 +351,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
                 };
+                windsorFramework: {
+                    movementIndicator: string;
+                    movementIndicators: {
+                        b2c: string;
+                        c2b: string;
+                        c2c: string;
+                        b2b: string;
+                    };
+                    notAtRisk: string;
+                    notAtRiskShipmentTootip: string;
+                };
                 requirements: {
                     noWarehouse: string;
                     noCarrier: string;
@@ -360,6 +392,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -384,11 +417,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
                     inlineMessage: string;
-                };
+                }; /**
+                 * `features` is a set of feature flags you would like to enable or disable in this component.
+                 */
                 errors: {
                     noCarriers: {
                         title: string;
@@ -429,6 +468,30 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 tooltip: {
                     warehouse: string;
                 };
+                /**
+                 * # Registered Account Settings Element
+                 *
+                 * - This is the registered `<AccountSettings />` element that will be used to render the
+                 * `<AccountSettings.Element />` component.
+                 *
+                 * @param ElementProps The props, callbacks, and resources necessary to render
+                 * the `<AccountSettings.Element />` component.
+                 *
+                 * @example
+                 * The `<Component />` is the source JSX that is rendered when you make use of the `AccountSettings`
+                 * Element directly. Here is a brief example of how you would use it within your application.
+                 * ```tsx
+                 * <AccountSettings.Element/>
+                 * ```
+                 *
+                 * <br />
+                 *
+                 * @see {@link AccountSettings.ComponentProps | The **props** that can be passed into the `<AccountSettings.Element />` component}
+                 * @see {@link CarrierServices.Element | The `<CarrierServices />` component used to view connected carriers and manage funding}
+                 * @see {@link ManageWarehouses.Component | The `<ManageWarehouses />` component used to add, update, or remove warehouses}
+                 * @see {@link PaymentMethodSettings | The `<PaymentMethodSettings />` component used to manage payment methods}
+                 * @see {@link ManageFunding | The `<ManageFunding />` component used to manage funding rules and add funds to a carrier account}
+                 */
                 welcomePage: {
                     title: string;
                     message: string;
@@ -660,6 +723,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -820,6 +884,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -833,6 +905,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -859,8 +932,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -938,6 +1013,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -945,6 +1023,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

package/src/workflows/carrier-services/carrier-services.d.ts

@@ -83,6 +83,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -98,6 +99,20 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     insuredValue: string;
                     deliveryConfirmation: string;
                 };
+                insurance: {
+                    parcelguard: {
+                        title: string;
+                        description: string;
+                        cta: {
+                            title: string;
+                            description: string;
+                        };
+                        registerSuccess: {
+                            title: string;
+                            description: string;
+                        };
+                    };
+                };
                 highVolumeForms: string;
                 multipleShippingServices: string;
                 sections: {
@@ -140,12 +155,6 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -158,6 +167,17 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -252,6 +272,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -322,6 +343,17 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     dhlExpressTermsAcknowledgement: string;
                     noRateService: string;
                 };
+                windsorFramework: {
+                    movementIndicator: string;
+                    movementIndicators: {
+                        b2c: string;
+                        c2b: string;
+                        c2c: string;
+                        b2b: string;
+                    };
+                    notAtRisk: string;
+                    notAtRiskShipmentTootip: string;
+                };
                 requirements: {
                     noWarehouse: string;
                     noCarrier: string;
@@ -352,6 +384,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -376,6 +409,10 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -652,6 +689,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -812,6 +850,14 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -825,6 +871,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -851,8 +898,10 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -930,6 +979,9 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -937,6 +989,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {