@shipengine/elements 1.3.2 → 1.5.0

package/src/components/templates/warehouse-form/warehouse-form.d.ts

@@ -6,6 +6,7 @@ export type WarehouseFormProps = {
     onSubmit: (payload: WarehousePayload) => void;
     shouldForceDefault?: boolean;
     submitButtonTitle: string;
+    useStrictSchema?: boolean;
     warehouse?: SE.Warehouse | Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
 };
-export declare const WarehouseForm: ({ onCancel, onDelete, onSubmit, submitButtonTitle, warehouse, shouldForceDefault, }: WarehouseFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const WarehouseForm: ({ onCancel, onDelete, onSubmit, submitButtonTitle, warehouse, shouldForceDefault, useStrictSchema, }: WarehouseFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { AccountSettingsFeatures } from "../../components/templates/account-settings";
 /**
  * # Account Settings Component Props
  *
@@ -7,6 +8,10 @@
  * @see {@link AccountSettings.Component | This prop types usage in the `<AccountSettings /> component`}
  */
 export type ComponentProps = {
+    /**
+     * Feature flags controlling operation of various sub components.
+     */
+    features?: AccountSettingsFeatures;
     /**
      * This callback function will be used to house the logic you wish to execute when the
      * user saves new changes to their account settings.
@@ -35,7 +40,7 @@ export type ComponentProps = {
  *
  * @see {@link AccountSettings.Element | The **Element** created to render `<AccountSettings />`}
  */
-export declare const Component: ({ onSaveSettings }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ features, onSaveSettings }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Account Settings Element
  *
@@ -182,30 +187,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     billing: {
                         title: string;
                         subtitleCard: 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 ListCarriers.Component | The `<List-Carriers />` component used to view connected carriers}
-                         * @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}
-                         */
                         subtitleBilling: string;
                     };
                 };
@@ -223,6 +204,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     purchaseLabel: string;
                     purchaseNow: string;
                     showItems: string;
+                    showMoreRates: string;
+                    showFewerRates: string;
                     /**
                      * # Account Settings Component Props
                      *
@@ -230,8 +213,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                      *
                      * @see {@link AccountSettings.Component | This prop types usage in the `<AccountSettings /> component`}
                      */
-                    showMoreRates: string;
-                    showFewerRates: string;
                     saveRate: string;
                 };
                 balance: {
@@ -313,6 +294,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;
@@ -363,11 +362,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": {
@@ -399,6 +400,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         metric: string;
                     };
                     weight: {
+                        /**
+                         * This callback function will be used to house the logic you wish to execute when the
+                         * user saves new changes to their account settings.
+                         */
                         title: string;
                         standard: string;
                         g: string;
@@ -467,9 +472,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: {
@@ -496,16 +534,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     edit: string;
                     hide: string;
                     parse: string;
-                    purchase: string; /**
+                    purchase: string;
+                    remove: string;
+                    save: string;
+                    skipForNow: string;
+                    /**
                      * # Account Settings Component Props
                      *
                      * - These are the base props that will be passed into the `<AccountSettings />` component.
                      *
                      * @see {@link AccountSettings.Component | This prop types usage in the `<AccountSettings /> component`}
                      */
-                    remove: string;
-                    save: string;
-                    skipForNow: string;
                     submit: string;
                     tryAgain: string;
                 };
@@ -519,7 +558,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
-                        postalCode: string;
+                        postalCode: string; /**
+                         * This callback function will be used to house the logic you wish to execute when the
+                         * user saves new changes to their account settings.
+                         */
                         phone: string;
                         email: string;
                         addressResidentialIndicator: string;
@@ -598,8 +640,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;
@@ -631,10 +678,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;
                 };
@@ -672,9 +722,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: {
@@ -710,6 +762,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
+                    invalidAddressOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;
@@ -766,10 +819,29 @@ 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: {
+                    /**
+                     * Feature flags controlling operation of various sub components.
+                     */
+                    closeDialog: string;
+                    header: string;
+                };
+                status: {
+                    connected: string;
+                };
             };
             "account-settings": {
                 messages: {
@@ -783,6 +855,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: string;
+                    externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
                 };

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

@@ -19,6 +19,7 @@ export type ShipmentFormMode = "browse_rates" | "select_service";
 export type RateFormFeatures = {
     enableFunding?: boolean;
     enableGlobalPostFiltering?: boolean;
+    enablePudoUI?: boolean;
     labelLayout?: boolean;
     nicknameRate?: boolean;
     requireDhlTermsAcknowledgement?: boolean;

package/src/elements/configure-shipment/hooks/use-rates-form.d.ts

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

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

@@ -23,6 +23,7 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
     errors: SE.CodedError[] | undefined;
     onApplyPreset: (preset: ShippingPreset) => Promise<void>;
     onChangeAddress: (shipTo: SE.Address, { shouldValidate }: import("../../../components/templates").OnChangeAddressOptions) => Promise<SE.SalesOrderShipment>;
+    onChangeWarehouse: (warehouseId: string) => Promise<void>;
     onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<SE.SalesOrderShipment>;
     onSubmitParseShipTo: ({ fullAddress }: {
         fullAddress: string;

package/src/elements/connect-carrier/connect-carrier.d.ts

@@ -1,8 +1,42 @@
 /// <reference types="react" />
+export type ConnectCarrierFeatures = {
+    availableCarrierConnections?: string[];
+};
+/**
+ * # Connect-Carrier Props
+ *
+ * @see {@link ConnectCarrier.Component | The `<ConnectCarrier />` component}
+ */
 export type ComponentProps = {
-    carrierName: string;
+    carrierName?: string;
+    features?: ConnectCarrierFeatures;
+    onCancel?: () => void;
+    onCarrierConnected?: (carrierId: string) => void;
 };
-export declare const Component: ({ carrierName }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # Connect-Carriers Component
+ *
+ * @param ComponentProps The base props that will be passed into the `<ConnectCarrier />` component.
+ *
+ * @returns Element A React element that renders the `<ConnectCarrier />` component allowing users
+ * to connect their own existing carrier account. If no carrier is provided, the user may
+ * select from a list of carriers specified by `features.availableCarrierConnections`.
+ * This component is composed in the `<AccountSettings />` Element.
+ *
+ * @example
+ * ```tsx
+ * (() => {
+ *   const features = useFeatures("CarrierConnections");
+ *
+ *   return <ConnectCarrier.Component features={features} />;
+ * })();
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link ConnectCarrier.ComponentProps | The props that are passed into the `<ConnectCarrier />` component}
+ */
+export declare const Component: ({ carrierName, features, onCancel, onCarrierConnected, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: ComponentProps & {
     resources?: {
         en: {
@@ -225,6 +259,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;
@@ -275,11 +327,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": {
@@ -379,9 +433,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: {
@@ -428,6 +515,29 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         postalCode: string;
                         phone: string;
                         email: string;
+                        /**
+                         * # Connect-Carriers Component
+                         *
+                         * @param ComponentProps The base props that will be passed into the `<ConnectCarrier />` component.
+                         *
+                         * @returns Element A React element that renders the `<ConnectCarrier />` component allowing users
+                         * to connect their own existing carrier account. If no carrier is provided, the user may
+                         * select from a list of carriers specified by `features.availableCarrierConnections`.
+                         * This component is composed in the `<AccountSettings />` Element.
+                         *
+                         * @example
+                         * ```tsx
+                         * (() => {
+                         *   const features = useFeatures("CarrierConnections");
+                         *
+                         *   return <ConnectCarrier.Component features={features} />;
+                         * })();
+                         * ```
+                         *
+                         * <br />
+                         *
+                         * @see {@link ConnectCarrier.ComponentProps | The props that are passed into the `<ConnectCarrier />` component}
+                         */
                         addressResidentialIndicator: string;
                     };
                     noResults: string;
@@ -504,8 +614,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;
@@ -537,10 +652,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;
                 };
@@ -578,9 +696,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: {
@@ -616,6 +736,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     invalidAddressName: string;
                     invalidAddressNameStrict: string;
+                    invalidAddressOnboarding: string;
                     invalidAddressPoBox: string;
                     invalidCreditCardType: string;
                     invalidExpirationDate: string;
@@ -672,10 +793,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: {
@@ -689,6 +826,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: string;
+                    externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
                 };

package/src/elements/external-carriers/external-carriers.d.ts

@@ -0,0 +1,34 @@
+import { ConnectCarrierFeatures } from "../connect-carrier/connect-carrier";
+export type ExternalCarriersFeatures = ConnectCarrierFeatures;
+export type ComponentProps = {
+    /**
+     * `availableCarrierConnections` is a set of carrier codes for carriers that may be added. If this is omitted,
+     * new carriers may not be added by this element.
+     */
+    features?: ExternalCarriersFeatures;
+};
+/**
+ * # ExternalCarriers Component
+ *
+ * @param ComponentProps The base props that will be passed into the `<ExternalCarriers />` component.
+ *
+ * @returns Element A React element that renders the `<ExternalCarriers />` component allowing users
+ * to view a list of their own carrier accounts that have been connected to their ShipEngine account,
+ * and to add additional carriers.
+ * This component is composed in the `<AccountSettings />` Element.
+ *
+ * @example
+ * ```tsx
+ * (() => {
+ *   const features = useFeatures("Global");
+ *
+ *   return <ExternalCarriers.Component features={features} />;
+ * })();
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link ExternalCarriers.ComponentProps | The props that are passed into the `<ExternalCarriers />` component}
+ * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<ExternalCarriers />` component}
+ */
+export declare const Component: ({ features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1 @@
+export * as ExternalCarriers from "./external-carriers";

package/src/elements/index.d.ts

@@ -2,6 +2,7 @@ export * from "./account-settings";
 export * from "./list-carriers";
 export * from "./manage-warehouses";
 export * from "./purchase-label";
+export * from "./external-carriers";
 export * from "./shipengine-workflow";
 export * from "./theme-creator";
 export * from "./view-shipment";