@shipengine/elements 2.17.0 → 2.19.0

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

@@ -18,6 +18,9 @@ declare const _default: {
             thisMonth: string;
             lastMonth: string;
         };
+        category: {
+            fundsAdded: string;
+        };
     };
     "void-label": {
         title: string;
@@ -614,8 +617,10 @@ declare const _default: {
         trackingStatus: {
             unknown: string;
             inTransit: string;
+            in_transit: string;
             delivered: string;
             error: string;
+            voided: string;
         };
         actions: {
             title: string;
@@ -635,6 +640,17 @@ declare const _default: {
             connectCarriers: string;
             disconnect: string;
             disconnectCarrier: string;
+            downloadEula: string;
+        };
+        customForms: {
+            fedex: {
+                eulaName: string;
+                disclaimerFooter: string;
+            };
+        };
+        eula: {
+            toContinue: string;
+            iAgree: string;
         };
         noCarriersDescription: string;
         registrationForm: {
@@ -681,6 +697,7 @@ declare const _default: {
         address: {
             fields: {
                 name: string;
+                fullName: string;
                 company: string;
                 county: string;
                 countryCode: string;
@@ -843,6 +860,7 @@ declare const _default: {
             unknown: string;
             noRatesAvailable: string;
             refreshAndTryAgain: string;
+            updateShipFromAddress: string;
             windsorFramework: {
                 doNotConform: string;
                 pleaseAddTheFollowingTaxIds: string;
@@ -861,6 +879,7 @@ declare const _default: {
             saveRate: string;
             security: string;
             shipmentStatus: string;
+            shipFromAddress: string;
             system: string;
             unknown: string;
             validation: string;
@@ -874,6 +893,8 @@ declare const _default: {
             shipmentId: string;
             labelId: string;
             labelIdFilter: string;
+            filteredTrackingStatus: string;
+            more: string;
             createdDate: string;
             shipmentIdFilter: string;
             createdDateFilter: string;

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

@@ -144,7 +144,7 @@ export type FilterableLabelColumnConfig = {
     /**
      * The name identifying the column
      */
-    name: Extract<LabelColumnName, "shipmentId" | "labelId">;
+    name: Extract<LabelColumnName, "shipmentId" | "labelId" | "trackingStatus">;
     nickname?: string;
 };
 export type LabelColumnConfig = BaseLabelColumnConfig | FilterableLabelColumnConfig;
@@ -159,6 +159,10 @@ export type LabelsGridFeatures = {
     showActions?: boolean;
 };
 export type GlobalFeatures = {
+    /**
+     * Disable default usage of  Shadow DOM for all elements
+     */
+    disableShadowDOM?: boolean;
     /**
      * Availible "Bring your own carrier" carrier codes for carriers that may be added. If this is omitted, new carriers may not be added by this element.
      */

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

@@ -78,7 +78,7 @@ export declare const getDefaultShipFromAddress: (addresses?: ShipFromAddress[])
  * @internal
  *
  * # Address Utilities - getSavedShipFromAddressId
- *  Gets the address ID of from the shipment if it is a saved address and not a warehouse
+ *  Gets the address ID of the Ship From Address on the shipment if it is a saved address and not a warehouse
  *
  * @category Utilities
  */

package/src/utilities/storybook-local-storage-config.d.ts

@@ -0,0 +1,12 @@
+interface ShipEngineLocalStorageConfig {
+    carrierId?: string;
+    labelId?: string;
+    salesOrderId?: string;
+    sellerId?: number;
+    shipmentId?: string;
+    token?: string;
+    warehouseId?: string;
+}
+export declare const getLocalStorageConfig: () => ShipEngineLocalStorageConfig | undefined;
+export declare const setLocalStorageConfig: (config: ShipEngineLocalStorageConfig) => void;
+export {};

package/src/utilities/validation.d.ts

@@ -1,5 +1,6 @@
 import { Resolver } from "@hookform/resolvers/zod";
 import { z } from "zod";
+import { ShipFromAddress } from "../types";
 /**
  * @internal
  *
@@ -16,3 +17,21 @@ export declare const errorMap: z.ZodErrorMap;
  * @category Utilities
  */
 export declare const validationResolver: <T extends z.ZodType<any, any, any>>(schema: T, sensitiveValues?: string[]) => ReturnType<Resolver>;
+/**
+ * Validates a ship-from address against the shipFromAddressFormSchema.
+ *
+ * @param shipFromAddress The ship-from address to validate.
+ * @returns An object indicating validation status and any error messages.
+ *
+ * @example
+ * const result = validateShipFromAddress(myAddress);
+ * if (result.isValid) {
+ * console.log("Address is valid.");
+ * } else {
+ * console.error("Address is invalid:", result.errors);
+ * }
+ */
+export declare const validateShipFromAddress: (shipFromAddress: ShipFromAddress) => {
+    errors: unknown;
+    isValid: boolean;
+};

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

@@ -54,6 +54,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -650,8 +653,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -671,6 +676,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -717,6 +733,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -879,6 +896,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -897,6 +915,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -910,6 +929,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -1,5 +1,4 @@
 /// <reference types="react" />
-import { CodedError } from "@shipengine/react-api";
 /**
  * # Carrier-Services Component
  *
@@ -24,11 +23,9 @@ import { CodedError } from "@shipengine/react-api";
  * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<CarrierServices />` component}
  */
 export type CarrierServicesProps = {
-    addFunds?: () => Promise<any>;
-    addFundsError?: CodedError[] | null;
     onRedirectToOnboarding?: () => void;
 };
-export declare const Component: ({ onRedirectToOnboarding, addFunds, addFundsError, }: CarrierServicesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ onRedirectToOnboarding }: CarrierServicesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
     resources?: {
         en: {
@@ -51,6 +48,9 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -647,8 +647,10 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -668,6 +670,17 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -714,6 +727,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -876,6 +890,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -894,6 +909,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -907,6 +923,8 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;
@@ -1074,29 +1092,6 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     accountBalance: string;
                     paymentMethod: string;
                     transactionHistory: string;
-                    /**
-                     * # Carrier-Services 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 `<CarrierServices />` component}
-                     * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<CarrierServices />` component}
-                     */
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: {

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

@@ -55,6 +55,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -73,29 +76,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     dpdwallet: string;
                 };
                 refund_process: string;
-                /**
-                 * # ConnectExternalCarrier Component
-                 *
-                 * @param ComponentProps The base props that will be passed into the `<ConnectExternalCarrier />` component.
-                 *
-                 * @returns Element A React element that renders the `<ConnectExternalCarrier />` 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 <ConnectExternalCarrier.Component features={features} />;
-                 * })();
-                 * ```
-                 *
-                 * <br />
-                 *
-                 * @see {@link ConnectExternalCarrier.ComponentProps | The props that are passed into the `<ConnectExternalCarrier />` component}
-                 */
                 refund_rules: string;
                 resultTitles: {
                     approved: string;
@@ -599,7 +579,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         metric: string;
                     };
                     weight: {
-                        title: string;
+                        title: string; /**
+                         * # ConnectExternalCarrier Props
+                         *
+                         * @see {@link ConnectExternalCarrier.Component | The `<ConnectExternalCarrier />` component}
+                         */
                         standard: string;
                         g: string;
                         kg: string;
@@ -674,8 +658,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -695,6 +681,17 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -741,6 +738,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -748,6 +746,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: string;
+                        /**
+                         * # ConnectExternalCarrier Props
+                         *
+                         * @see {@link ConnectExternalCarrier.Component | The `<ConnectExternalCarrier />` component}
+                         */
                         postalCode: string;
                         phone: string;
                         email: string;
@@ -903,6 +906,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -921,6 +925,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -934,6 +939,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

package/src/workflows/label-workflow/label-workflow.d.ts

@@ -122,6 +122,9 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -729,8 +732,10 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -750,6 +755,17 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -796,6 +812,7 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -958,6 +975,7 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -976,6 +994,7 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -989,6 +1008,8 @@ export declare const Element: ({ resources, ...props }: Omit<PurchaseLabel.Purch
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

package/src/workflows/onboarding/components/onboarding-wizard/onboarding-wizard.d.ts

@@ -16,5 +16,6 @@ export type OnboardingWizardProps = {
     defaultShipFromAddress?: ShipFromAddressStepProps["defaultShipFromAddress"];
     onComplete: () => void;
     onSellerOnboarded?: () => void;
+    skipWelcomePage?: boolean;
 };
-export declare const OnboardingWizard: ({ defaultShipFromAddress, onComplete: onWizardComplete, onSellerOnboarded, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const OnboardingWizard: ({ defaultShipFromAddress, onComplete: onWizardComplete, onSellerOnboarded, skipWelcomePage, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;