@shipengine/elements 2.9.1 → 2.10.0

package/src/elements/vat-settings/vat-settings-element.d.ts

@@ -57,6 +57,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -72,6 +73,20 @@ export declare const Element: ({ resources, ...props }: object & {
                     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: {
@@ -114,12 +129,6 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             "register-wallet": {
                 sections: {
-                    setup: {
-                        title: string;
-                        subtitle: string;
-                        descriptionTitle: string;
-                        description: string;
-                    };
                     billing: {
                         title: string;
                         cardSubTitle: string;
@@ -132,6 +141,17 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                         subtitle: string;
                     };
+                    insuranceProviders: {
+                        parcelguard: {
+                            description: string;
+                            terms: string;
+                            termsLink: string;
+                            popover: {
+                                title: string;
+                                description: string;
+                            };
+                        };
+                    };
                     notifications: {
                         error: {
                             title: string;
@@ -226,6 +246,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -296,6 +317,17 @@ export declare const Element: ({ resources, ...props }: object & {
                     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;
@@ -326,6 +358,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -350,6 +383,10 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
                     subtitle: string;
@@ -626,6 +663,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -786,6 +824,14 @@ export declare const Element: ({ resources, ...props }: object & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    windsorFramework: {
+                        doNotConform: string;
+                        pleaseAddTheFollowingTaxIds: string;
+                        windsorFrameworkDefaultMessage: string;
+                        shipperEori: string;
+                        recipientEori: string;
+                        ukims: string;
+                    };
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -799,6 +845,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -825,8 +872,10 @@ export declare const Element: ({ resources, ...props }: object & {
                 insuranceProviders: {
                     carrier: string;
                     none: string;
+                    parcelguard: string;
                     shipsurance: string;
                     thirdParty: string;
+                    x_cover: string;
                 };
                 loading: {
                     accountSettings: string;
@@ -904,6 +953,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -911,6 +963,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

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

@@ -144,6 +144,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     showItems: string;
                     void: string;
                     download: string;
+                    fileClaim: string;
                 };
                 fields: {
                     dimensions: string;
@@ -159,11 +160,21 @@ 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;
-                /**
-                 * `onSuccess` is a callback function that will be invoked when the request to void a given
-                 * shipping label is successful.
-                 */
                 multipleShippingServices: string;
                 sections: {
                     labels: string;
@@ -205,12 +216,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;
@@ -223,6 +228,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;
@@ -233,10 +249,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         poBox: {
                             title: string;
                             description: string;
-                        }; /**
-                         * `onSuccess` is a callback function that will be invoked when the request to void a given
-                         * shipping label is successful.
-                         */
+                        };
                         carrier: {
                             title: string;
                             confirmAddress: string;
@@ -320,6 +333,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 cta: {
                     addPackageDetails: string;
+                    parcelguard: string;
                 };
                 errorMessages: {
                     customsItemsRequired: string;
@@ -390,41 +404,22 @@ 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;
                     noWarehouseOrCarrier: string;
-                }; /**
-                 * # Registered Void Label Element
-                 *
-                 * - This is the registered `<VoidLabel />` element that will be used to render the
-                 * `<VoidLabel.Element />` component.
-                 *
-                 * @param ElementProps The props, callbacks, and resources necessary to render
-                 * the `<VoidLabel.Element />` component.
-                 *
-                 * @example
-                 * The `<Component />` is the source JSX that is rendered when you make use of the `VoidLabel`
-                 * Element directly. Here is a brief example of how you would use it within your application.
-                 * ```tsx
-                 * <VoidLabel.Element
-                 *   labelId="se-1234567"
-                 *   onComplete={() => console.log('onComplete')}
-                 *   onSuccess={(_, { salesOrderIds: [salesOrderId] }) =>
-                 *     console.log('sales order ID', salesOrderId)
-                 *   }
-                 *   onViewShipment={({ shipmentId }) => {
-                 *     console.log('onViewShipment', shipmentId);
-                 *   }}
-                 * />
-                 * ```
-                 *
-                 * <br />
-                 *
-                 * @see {@link VoidLabel.ComponentProps | The **props** that can be passed into the `<VoidLabel.Element />` component}
-                 *
-                 * @see {@link PurchaseLabel.Element | Go back to the frst step in the label purchase workflow `<PurchaseLabel.Element />`}
-                 */
+                };
                 servicePoints: {
                     searchLabel: string;
                     noRatesForType: string;
@@ -450,6 +445,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 shipToAddressFormFields: string;
                 sections: {
                     customsForm: string;
+                    windsorFramework: string;
                     shipment: string;
                     rate_one: string;
                     rate_other: string;
@@ -474,15 +470,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
                 };
+                termsAgreement: {
+                    title: string;
+                    subtitle: string;
+                };
                 warehouse: {
                     title: string;
-                    /**
-                     * # Void Label Component Props
-                     *
-                     * - These are the base props that will be passed into the `<VoidLabel />` component.
-                     *
-                     * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
-                     */
                     subtitle: string;
                     inlineMessage: string;
                 };
@@ -493,7 +486,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                 };
                 success: {
-                    title: string;
+                    title: string; /**
+                     * `onSuccess` is a callback function that will be invoked when the request to void a given
+                     * shipping label is successful.
+                     */
                     subtitle: string;
                     action: string;
                 };
@@ -761,6 +757,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     continue: string;
                     delete: string;
                     edit: string;
+                    enable: string;
                     hide: string;
                     parse: string;
                     purchase: string;
@@ -771,6 +768,13 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     tryAgain: string;
                 };
                 address: {
+                    /**
+                     * # Void Label Component Props
+                     *
+                     * - These are the base props that will be passed into the `<VoidLabel />` component.
+                     *
+                     * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
+                     */
                     fields: {
                         name: string;
                         company: string;
@@ -791,10 +795,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     parserFields: {
                         fullAddress: string;
-                    }; /**
-                     * `onSuccess` is a callback function that will be invoked when the request to void a given
-                     * shipping label is successful.
-                     */
+                    };
                     paste: string;
                     preference: {
                         confirm: string;
@@ -924,6 +925,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;
@@ -937,6 +946,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     system: string;
                     unknown: string;
                     validation: string;
+                    windsorFramework: string;
                 };
                 grid: {
                     "row-count_one": string;
@@ -963,8 +973,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;
@@ -1042,6 +1054,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     platform: string;
                     user: string;
                 };
+                tags: {
+                    new: string;
+                };
                 terms: {
                     fields: {
                         agreement: string;
@@ -1049,6 +1064,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    insuranceProvidersTitle: string;
                     shipEngineTitle: string;
                 };
                 weight: {

package/src/features/manage-carriers/hooks/use-list-funding-source-carriers.d.ts

@@ -1,4 +1,4 @@
-import { CarrierMetadataFromFundingSource } from "../../../types";
+import { CarrierMetadataFromFundingSource, InsuranceProviderProfile } from "../../../types";
 export type ConnectedCarrierMetadata = {
     carrier: CarrierMetadataFromFundingSource;
     isConnected: boolean;
@@ -6,6 +6,8 @@ export type ConnectedCarrierMetadata = {
 export declare const useListFundingSourceCarriers: () => {
     data: ConnectedCarrierMetadata[] | undefined;
     error: import("@shipengine/react-api").CodedError[] | null;
+    insuranceProviderProfiles: InsuranceProviderProfile[];
     isLoading: boolean;
     refetch: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/react-api").Carrier[], import("@shipengine/react-api").CodedError[]>>;
+    refetchInsuranceProviderAcceptedTerms: <TPageData_1>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData_1>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/react-api").InsuranceFundingSourceAcceptedTermsResponse, import("@shipengine/react-api").CodedError[]>>;
 };

package/src/features/manage-carriers/manage-insurance-provider-row/index.d.ts

@@ -0,0 +1 @@
+export * from "./manage-insurance-provider-row";

package/src/features/manage-carriers/manage-insurance-provider-row/info-popover.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/js-api";
+type InfoPopoverProps = {
+    iconRef: React.RefObject<HTMLElement>;
+    insuranceProvider: SE.FundingSourceInsuranceProvider;
+    isOpen: boolean;
+    toggleIsOpen: () => void;
+};
+export declare const InfoPopover: ({ insuranceProvider, iconRef, toggleIsOpen, isOpen, }: InfoPopoverProps) => import("@emotion/react/jsx-runtime").JSX.Element | null;
+export {};

package/src/features/manage-carriers/manage-insurance-provider-row/manage-insurance-provider-row.d.ts

@@ -0,0 +1,7 @@
+import { InsuranceProviderProfile } from "../../../types";
+export * from "./manage-insurance-provider-row";
+export type ManageInsuranceProviderRowProps = {
+    insuranceProviderProfile: InsuranceProviderProfile;
+    registerProvider: (p: InsuranceProviderProfile) => Promise<void>;
+};
+export declare const ManageInsuranceProviderRow: ({ registerProvider, insuranceProviderProfile, }: ManageInsuranceProviderRowProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/manage-carriers/manage-insurance-provider-row/manage-insurance-provider-row.styles.d.ts

@@ -0,0 +1,37 @@
+export declare const styles: {
+    container: {
+        display: "flex";
+        flexDirection: "column";
+    };
+    formContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        backgroundColor: string;
+        padding: number;
+    };
+    getConnectButton: (isConnected?: boolean) => (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        backgroundColor?: string | undefined;
+        borderRadius?: string | undefined;
+        color?: string | undefined;
+        padding: string;
+    };
+    link: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        "&:visited": {
+            color: string;
+        };
+        cursor: "pointer";
+        fontWeight: number;
+    };
+    logoContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        columnGap: string;
+        display: "flex";
+    };
+    popover: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        fontSize: string;
+    };
+    rowContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        alignItems: "center";
+        display: "flex";
+        justifyContent: "space-between";
+        padding: string;
+    };
+};

package/src/hooks/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./options";
+export * from "./insurance";
 export * from "./use-address-validation";
 export * from "./use-black-box-detection";
 export * from "./use-get-service-name";

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

@@ -0,0 +1,2 @@
+export * from "./use-get-funding-source-insurance-provider";
+export * from "./use-manage-funding-source-insurance";

package/src/hooks/insurance/use-get-funding-source-insurance-provider.d.ts

@@ -0,0 +1,14 @@
+import { SE } from "@shipengine/react-api";
+/**
+ * @internal
+ *
+ * # Get Funding Source Insurance Providers
+ *
+ * - description: This hook is used to get the enabled funding source insurance provider
+ *
+ * @example
+ */
+export declare const useGetFundingSourceInsuranceProvider: () => {
+    fundingSourceInsuranceProvider: SE.FundingSourceInsuranceProvider | undefined;
+    refetchInsuranceAcceptedTerms: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<SE.InsuranceFundingSourceAcceptedTermsResponse, SE.CodedError[]>>;
+};

package/src/hooks/insurance/use-manage-funding-source-insurance.d.ts

@@ -0,0 +1,10 @@
+import { SE } from "@shipengine/react-api";
+import { InsuranceProviderProfile } from "../../types";
+export declare const useManageFundingSourceInsurance: () => {
+    hasInsuranceToRegister: boolean;
+    insuranceAcceptedTerms: SE.Term[] | undefined;
+    insuranceProviderProfiles: InsuranceProviderProfile[] | undefined;
+    loading: boolean;
+    registerInsuranceProvider: () => Promise<void>;
+    registerInsuranceProviderSuccess: boolean;
+};

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

@@ -5,6 +5,7 @@ export * from "./use-customs-non-delivery-options";
 export * from "./use-date-range-options";
 export * from "./use-expiration-month-options";
 export * from "./use-insurance-provider-options";
+export * from "./use-movement-indicator-options";
 export * from "./use-package-options";
 export * from "./use-rate-options";
 export * from "./use-service-code-options";
@@ -13,3 +14,4 @@ export * from "./use-shipping-presets-options";
 export * from "./use-state-code-options";
 export * from "./use-warehouse-options";
 export * from "./use-service-points";
+export * from "./use-windsor-framework";

package/src/hooks/options/use-insurance-provider-options.d.ts

@@ -1,5 +1,6 @@
 import { SE } from "@shipengine/react-api";
 interface InsuranceFeatures {
+    includeCarrierInsurance?: boolean;
     includeShipsuranceInsurance?: boolean;
     includeThirdPartyInsurance?: boolean;
 }
@@ -11,7 +12,11 @@ interface InsuranceFeatures {
  * @category Hooks
  */
 export declare const useInsuranceProviderOptions: (insuranceAccount?: SE.InsuranceAccount, features?: InsuranceFeatures) => {
-    label: string;
-    value: SE.InsuranceProviderType;
-}[];
+    fundingSourceInsuranceProvider: SE.FundingSourceInsuranceProvider | undefined;
+    insuranceProviderOptions: {
+        label: string;
+        value: SE.InsuranceProviderType;
+    }[];
+    refetchInsuranceAcceptedTerms: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<SE.InsuranceFundingSourceAcceptedTermsResponse, SE.CodedError[]>>;
+};
 export {};

package/src/hooks/options/use-movement-indicator-options.d.ts

@@ -0,0 +1,12 @@
+import { SE } from "@shipengine/react-api";
+/**
+ * @internal
+ *
+ * # Customs Non-Delivery Options Hooks
+ *
+ * @category Hooks
+ */
+export declare const useMovementIndicatorOptions: () => {
+    label: string;
+    value: SE.MovementIndicator;
+}[];

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

@@ -16,6 +16,9 @@ export declare enum PudoType {
  */
 export type RateOption = Omit<SE.Rate, "warningMessages"> & {
     balance?: number;
+    insuranceClaim?: SE.LinkedResource;
+    insuranceProvider?: SE.InsuranceProviderType;
+    insuredValue?: SE.Money;
     messages: string[];
     pudoType?: PudoType;
     rateAcknowledgementMessage?: PreferredRateAcknowledgementMessage;
@@ -29,4 +32,4 @@ export type RateOption = Omit<SE.Rate, "warningMessages"> & {
  *
  * # Rate Options Hook
  */
-export declare const useRateOptions: (rates?: SE.Rate[], preferredRates?: PreferredRatesResponse, carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, servicePoints?: SE.ServicePoint[], 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, windsorFrameworkEnabled?: boolean) => RateOption[];

package/src/hooks/options/use-windsor-framework.d.ts

@@ -0,0 +1,9 @@
+import { SE } from "@shipengine/react-api";
+export declare const useWindsorFramework: (shipment?: SE.SalesOrderShipment, enabled?: boolean) => {
+    isWindsorFrameworkInvalid: {
+        isInvalid: boolean;
+        messages?: string[] | undefined;
+    };
+    movementIndicator: SE.MovementIndicator | undefined;
+    requiresWindsorFramework: boolean | undefined;
+};