@shipengine/elements 2.0.0 → 2.1.0

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

@@ -172,6 +172,7 @@ declare const _default: {
                 title: string;
             };
         };
+        noFundingSource: string;
     };
     "rate-details": {
         total: string;
@@ -356,6 +357,12 @@ declare const _default: {
             subtitle: string;
             inlineMessage: string;
         };
+        errors: {
+            noCarriers: {
+                title: string;
+                subtitle: string;
+            };
+        };
         success: {
             title: string;
             subtitle: string;
@@ -401,6 +408,7 @@ declare const _default: {
         returnToAddressIsDifferent: string;
         setDefault: string;
         shipFrom: string;
+        noWarehouses: string;
     };
     "manage-funding": {
         actions: {
@@ -448,6 +456,7 @@ declare const _default: {
         errors: {
             balanceUnknown: string;
             unableToFindBalance: string;
+            noFundingSource: string;
         };
         byoc: {
             invoiceNotification: string;
@@ -547,6 +556,9 @@ declare const _default: {
             toastTitle: string;
             toastBody: string;
         };
+        deleteCarrierErrorTitle: string;
+        deleteCarrierErrorMessage: string;
+        loadingDeletingCarrier: string;
     };
     common: {
         actions: {
@@ -649,6 +661,7 @@ declare const _default: {
         };
         customs: {
             addDeclaration: string;
+            noResults: string;
             contents: {
                 documents: string;
                 gift: string;
@@ -656,6 +669,14 @@ declare const _default: {
                 returnedGoods: string;
                 sample: string;
             };
+            taxIds: {
+                sectionTitle: string;
+                addTaxId: string;
+                sectionTitleTooltip: string;
+                entityTypeTooltipText: string;
+                entityTypeTooltipPointOne: string;
+                entityTypeTooltipPointTwo: string;
+            };
             currencyChange: string;
             declarations: string;
             descriptionTooltip: {
@@ -673,6 +694,11 @@ declare const _default: {
                 sku: string;
                 value: string;
                 valueQuantity: string;
+                taxId: string;
+                taxIdType: string;
+                taxIdTypeValue: string;
+                taxIssuingAuthority: string;
+                entityType: string;
             };
             nonDelivery: {
                 returnToSender: string;
@@ -745,6 +771,8 @@ declare const _default: {
             shipment: string;
             shipments: string;
             warehouses: string;
+            funding: string;
+            paymentMethod: string;
         };
         months: {
             january: string;
@@ -823,6 +851,16 @@ declare const _default: {
             gram: string;
             kilogram: string;
         };
+        actionsMenu: {
+            menuTitle: string;
+            actions: {
+                printLabel: string;
+                voidLabel: string;
+                printForms: string;
+                edit: string;
+                remove: string;
+            };
+        };
         ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
         T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
         "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -838,7 +876,11 @@ declare const _default: {
     };
     "account-settings": {
         messages: {
-            noFundingSources: string;
+            transactionHistory: {
+                noTransactions: string;
+            };
+            noFundingSourceDescription: string;
+            noFundingSourceAction: string;
         };
         title: string;
         sections: {

package/src/testing/test-utils.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { prettyFormat as __ } from "@testing-library/dom/types/pretty-dom";
 import { RenderOptions } from "@testing-library/react";
 import { UserEvent } from "@testing-library/user-event/dist/types/setup/setup";

package/src/utilities/formatString.d.ts

@@ -6,5 +6,7 @@
  * - This is a utility function that `capitalizes` the first letter of a given string.
  */
 export declare const capitalizeFirstLetter: (str: string) => string;
+export declare const capitalizeFirstLetterOfEachWord: (str: string) => string;
 export declare const pascalize: (str: string) => string;
+export declare const replaceSpacesWithDashes: (str?: string) => string | undefined;
 export declare const addSpaceBetweenWords: (str: string) => string;

package/src/utilities/index.d.ts

@@ -12,3 +12,4 @@ export * from "./formatString";
 export * from "./styles";
 export * from "./tracking-status-formatter";
 export * from "./validation";
+export * from "./pudo";

package/src/utilities/pudo.d.ts

@@ -0,0 +1,3 @@
+import { Rate } from "@shipengine/js-api";
+export declare const isPudoEligibleRate: (rate: Rate) => boolean;
+export declare const isCollectionService: (carrier: string, serviceCode: string) => boolean;

package/src/utilities/rates.d.ts

@@ -1,4 +1,4 @@
-import { Rate, SE } from "@shipengine/react-api";
+import { SE } from "@shipengine/react-api";
 /**
  * @internal
  *
@@ -29,5 +29,3 @@ 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/carrier.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/react-api";
+import { MetadataCarrierProfile, SE } from "@shipengine/react-api";
 /**
  * @internal
  *
@@ -31,3 +31,6 @@ export declare const getCarrierIdByCarrierCode: (carriers: SE.Carrier[] | undefi
  * @category Utilities
  */
 export declare const getLogoOrIconByCarrierCode: (carrierCode: string, type: "logo" | "icon") => string;
+export declare const isGlobalPostEligible: (region?: string) => boolean;
+export declare const isSendleEligible: (region?: string) => boolean;
+export declare const filterFundingSourceCarriers: (carriers?: MetadataCarrierProfile[], fundingSourceRegion?: string) => MetadataCarrierProfile[] | undefined;

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

@@ -5,8 +5,9 @@ export type ComponentProps = {
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
     features?: AccountSettingsFeatures;
+    onRedirectToOnboarding?: () => void;
 };
-export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ features, onRedirectToOnboarding }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Account Settings Element
  *
@@ -207,6 +208,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -393,6 +395,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -438,6 +446,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -485,6 +494,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -584,6 +594,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -686,6 +699,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -693,6 +707,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -710,6 +732,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -782,6 +809,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -860,6 +889,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -875,7 +914,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

package/src/workflows/account-settings/use-get-panel-props.d.ts

@@ -1,9 +1,9 @@
 import { CollapsiblePanelProps } from "../../components";
-import { UnitSettingsProps } from "../../features";
+import { ExternalCarriersProps, UnitSettingsProps } from "../../features";
 import { LabelLayoutSettingsProps } from "../../features/label-layout/label-layout";
 import { ManageWarehousesProps } from "../../features/manage-warehouses/";
-type SettingProps = LabelLayoutSettingsProps | UnitSettingsProps | ManageWarehousesProps;
-export type SettingPropsIntersection = LabelLayoutSettingsProps & UnitSettingsProps & ManageWarehousesProps;
+type SettingProps = ExternalCarriersProps | LabelLayoutSettingsProps | UnitSettingsProps | ManageWarehousesProps;
+export type SettingPropsIntersection = ExternalCarriersProps & LabelLayoutSettingsProps & UnitSettingsProps & ManageWarehousesProps;
 export declare const useGetPanelProps: () => {
     getSettingPanelProps: (setting: string) => [panelProps?: CollapsiblePanelProps, settingProps?: SettingProps];
 };

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

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 /**
- * # Manage-Wallet-Workflow Component
+ * # Carrier-Services Component
  *
  * @param ComponentProps The base props that will be passed into the `<CarrierServices />` component.
  *
@@ -19,11 +19,14 @@
  *
  * <br />
  *
- * @see {@link CarrierServices.ComponentProps | The props that are passed into the `<Manage-Wallet-Workflow />` component}
- * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<Manage-Wallet-Workflow />` component}
+ * @see {@link CarrierServices.ComponentProps | The props that are passed into the `<CarrierServices />` component}
+ * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<CarrierServices />` component}
  */
-export declare const Component: () => import("@emotion/react/jsx-runtime").JSX.Element;
-export declare const Element: ({ resources, ...props }: object & {
+export type CarrierServicesProps = {
+    onRedirectToOnboarding?: () => void;
+};
+export declare const Component: ({ onRedirectToOnboarding }: CarrierServicesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
     resources?: {
         en: {
             "wallet-history": {
@@ -146,29 +149,6 @@ export declare const Element: ({ resources, ...props }: object & {
                     };
                     billing: {
                         title: string;
-                        /**
-                         * # Manage-Wallet-Workflow Component
-                         *
-                         * @param ComponentProps The base props that will be passed into the `<CarrierServices />` component.
-                         *
-                         * @returns Element A React element that renders the `<CarrierServices />` component allowing users
-                         * to view a list of carriers that are connected to their ShipEngine account, add funds to their wallet, view transaction history, and manage their payment method. This component is
-                         * composed in the `<AccountSettings />` Element.
-                         *
-                         * @example
-                         * ```tsx
-                         * (() => {
-                         *   const features = useFeatures("Global");
-                         *
-                         *   return <CarrierServices.Element features={features} />;
-                         * })();
-                         * ```
-                         *
-                         * <br />
-                         *
-                         * @see {@link CarrierServices.ComponentProps | The props that are passed into the `<Manage-Wallet-Workflow />` component}
-                         * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<Manage-Wallet-Workflow />` component}
-                         */
                         cardSubTitle: string;
                         addressSubTitle: string;
                         info: string;
@@ -222,6 +202,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -406,6 +387,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -451,6 +438,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -498,6 +486,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -597,6 +586,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -699,6 +691,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -706,6 +699,14 @@ export declare const Element: ({ resources, ...props }: object & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -723,6 +724,11 @@ export declare const Element: ({ resources, ...props }: object & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -795,6 +801,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -873,6 +881,16 @@ export declare const Element: ({ resources, ...props }: object & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -888,7 +906,11 @@ export declare const Element: ({ resources, ...props }: object & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

package/src/workflows/connect-external-carrier/connect-external-carrier.d.ts

@@ -209,6 +209,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -393,6 +394,12 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -438,6 +445,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -485,6 +493,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -584,6 +593,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -686,6 +698,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -693,6 +706,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         returnedGoods: string;
                         sample: string;
                     };
+                    taxIds: {
+                        sectionTitle: string;
+                        addTaxId: string;
+                        sectionTitleTooltip: string;
+                        entityTypeTooltipText: string;
+                        entityTypeTooltipPointOne: string;
+                        entityTypeTooltipPointTwo: string;
+                    };
                     currencyChange: string;
                     declarations: string;
                     descriptionTooltip: {
@@ -710,6 +731,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         sku: string;
                         value: string;
                         valueQuantity: string;
+                        taxId: string;
+                        taxIdType: string;
+                        taxIdTypeValue: string;
+                        taxIssuingAuthority: string;
+                        entityType: string;
                     };
                     nonDelivery: {
                         returnToSender: string;
@@ -782,6 +808,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -860,6 +888,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     gram: string;
                     kilogram: string;
                 };
+                actionsMenu: {
+                    menuTitle: string;
+                    actions: {
+                        printLabel: string;
+                        voidLabel: string;
+                        printForms: string;
+                        edit: string;
+                        remove: string;
+                    };
+                };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;
                 T25seSByZXNpZGVudGlhbCBkZWxpdmVyeSBhZGRyZXNzZXMgYXJlIGFsbG93ZWQgZm9yIFVQUyBHcm91bmQgU2F2ZXIu: string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
@@ -875,7 +913,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {

package/src/workflows/onboarding/components/terms-agreement-form/terms-agreement-form.d.ts

@@ -2,6 +2,7 @@ import { SE } from "@shipengine/js-api";
 export type TermsAgreementFormProps = {
     carrierTerms: SE.MetadataRequiredTerm[];
     hideTerms: boolean;
+    isSubmitDisabled?: boolean;
     onSubmit: (agreement: boolean) => void;
 };
-export declare const TermsAgreementForm: ({ carrierTerms, hideTerms, onSubmit, }: TermsAgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const TermsAgreementForm: ({ carrierTerms, hideTerms, onSubmit, isSubmitDisabled, }: TermsAgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;