@shipengine/elements 2.18.0 → 2.19.0

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

@@ -22,6 +22,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -618,8 +621,10 @@ export declare const Element: ({ resources, ...props }: object & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -639,6 +644,17 @@ export declare const Element: ({ resources, ...props }: object & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -685,6 +701,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -847,6 +864,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -865,6 +883,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -878,6 +897,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -22,6 +22,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -618,8 +621,10 @@ export declare const Element: ({ resources, ...props }: object & {
                 trackingStatus: {
                     unknown: string;
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
@@ -639,6 +644,17 @@ export declare const Element: ({ resources, ...props }: object & {
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
+                    downloadEula: string;
+                };
+                customForms: {
+                    fedex: {
+                        eulaName: string;
+                        disclaimerFooter: string;
+                    };
+                };
+                eula: {
+                    toContinue: string;
+                    iAgree: string;
                 };
                 noCarriersDescription: string;
                 registrationForm: {
@@ -685,6 +701,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -847,6 +864,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -865,6 +883,7 @@ export declare const Element: ({ resources, ...props }: object & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -878,6 +897,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipmentId: string;
                     labelId: string;
                     labelIdFilter: string;
+                    filteredTrackingStatus: string;
+                    more: string;
                     createdDate: string;
                     shipmentIdFilter: string;
                     createdDateFilter: string;

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

@@ -109,6 +109,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     thisMonth: string;
                     lastMonth: string;
                 };
+                category: {
+                    fundsAdded: string;
+                };
             };
             "void-label": {
                 title: string;
@@ -744,23 +747,23 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                      * shipping label is completed.
                      */
                     inTransit: string;
+                    in_transit: string;
                     delivered: string;
                     error: string;
+                    voided: string;
                 };
                 actions: {
                     title: string;
-                    print: string;
+                    print: string; /**
+                     * `onSuccess` is a callback function that will be invoked when the request to void a given
+                     * shipping label is successful.
+                     */
                     void: string;
                     printForms: string;
                 };
                 errorMessages: {
                     title: string;
-                    subtitle: string; /**
-                     * `onViewShipment` is a callback function that will be invoked when the user clicks the
-                     * `View Shipment` button. This will take you back to the
-                     * {@link ShipmentSummary.Element | `Shipment Summary Element`} for the given shipment, where you
-                     * will be able to see the voided label listed.
-                     */
+                    subtitle: string;
                 };
             };
             "connect-carrier": {
@@ -770,6 +773,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: {
@@ -816,6 +830,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 address: {
                     fields: {
                         name: string;
+                        fullName: string;
                         company: string;
                         county: string;
                         countryCode: string;
@@ -828,6 +843,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         email: string;
                         addressResidentialIndicator: string;
                     };
+                    /**
+                     * `onComplete` is a callback function that will be invoked when the request to void a given
+                     * shipping label is completed.
+                     */
                     noResults: string;
                     subFields: {
                         optional: string;
@@ -837,6 +856,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     };
                     paste: string;
                     preference: {
+                        /**
+                         * `onSuccess` is a callback function that will be invoked when the request to void a given
+                         * shipping label is successful.
+                         */
                         confirm: string;
                         addressNotValidated: string;
                         modified: string;
@@ -947,7 +970,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                             restriction: string;
                             requirement1: string;
-                            requirement2: string;
+                            requirement2: string; /**
+                             * # Void Label Element Props
+                             *
+                             * @see {@link VoidLabel.Element | See the full type that `typeof Element` will return}
+                             */
                             requirement3: string;
                         };
                     };
@@ -978,6 +1005,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     unknown: string;
                     noRatesAvailable: string;
                     refreshAndTryAgain: string;
+                    updateShipFromAddress: string;
                     windsorFramework: {
                         doNotConform: string;
                         pleaseAddTheFollowingTaxIds: string;
@@ -996,6 +1024,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     saveRate: string;
                     security: string;
                     shipmentStatus: string;
+                    shipFromAddress: string;
                     system: string;
                     unknown: string;
                     validation: string;
@@ -1009,6 +1038,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/features/manage-carriers/manage-carriers.d.ts

@@ -1,12 +1,10 @@
-import { CodedError, Currency } from "@shipengine/react-api";
+import { CodedError, SE } from "@shipengine/react-api";
+export type AddFundsPayload = {
+    fundingSourceId: string;
+    funds: SE.Money;
+};
 export type ShipEngineCarriersProps = {
-    addFunds?: (payload: {
-        carrierId: string;
-        funds: {
-            amount: number;
-            currency: Currency;
-        };
-    }) => Promise<void>;
+    addFunds: (payload: AddFundsPayload) => Promise<void>;
     addFundsError?: CodedError[] | null;
     isUpdateFundsError?: boolean;
     isUpdatingFunds?: boolean;

package/src/features/manage-carriers/use-manage-carriers.d.ts

@@ -1,13 +1,10 @@
-import { Currency } from "@shipengine/react-api";
+import { SE } from "@shipengine/react-api";
 export declare const useManageCarriers: () => {
     addFunds: (payload: {
-        carrierId: string;
-        funds: {
-            amount: number;
-            currency: Currency;
-        };
+        fundingSourceId: string;
+        funds: SE.Money;
     }) => Promise<void>;
-    addFundsError: import("@shipengine/react-api").CodedError[] | null;
+    addFundsError: SE.CodedError[] | null;
     isAddFundsSuccess: boolean;
     isAddingFunds: boolean;
     isAddingFundsError: boolean;

package/src/features/manage-funding/manage-funding.d.ts

@@ -1,4 +1,4 @@
-import { CodedError, Currency } from "@shipengine/react-api";
+import { CodedError, SE } from "@shipengine/react-api";
 /**
  * @namespace ManageFunding
  *
@@ -15,14 +15,9 @@ import { CodedError, Currency } from "@shipengine/react-api";
  * @see {@link ManageFundingProps | The props that are passed into the `<ManageFunding />` component}
  */
 export type ManageFundingProps = {
-    addFunds?: (payload: {
-        carrierId: string;
-        funds: {
-            amount: number;
-            currency: Currency;
-        };
-    }) => Promise<void>;
+    addFunds?: (payload: SE.Money) => Promise<void>;
     addFundsError?: CodedError[] | null;
+    fundingSource?: SE.FundingSource;
     onRedirectToOnboarding?: () => void;
 };
-export declare const ManageFunding: ({ onRedirectToOnboarding, addFunds, addFundsError, }: ManageFundingProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ManageFunding: ({ onRedirectToOnboarding, addFunds, addFundsError, fundingSource, }: ManageFundingProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/hooks/index.d.ts

@@ -12,3 +12,4 @@ export * from "./use-scrub-errors";
 export * from "./use-toggle";
 export * from "./use-configure-shipment";
 export * from "./use-import-sales-order";
+export * from "./use-balance-services";

package/src/hooks/options/use-date-range-options.d.ts

@@ -5,7 +5,10 @@
  *
  * @see {@link DateRangeOption | The `DateRangeOption` that uses this type}
  */
-export type DateRange = [Date, Date];
+export type DateRange = {
+    endDate: Date;
+    startDate: Date;
+};
 /**
  * @internal
  *

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

@@ -1,5 +1,6 @@
 import { SE } from "@shipengine/react-api";
 import { PreferredRateAcknowledgementMessage, PreferredRatesResponse } from "../../types";
+import { FundingOrigin } from "../use-balance-services";
 /**
  * @internal
  *
@@ -32,4 +33,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[], requireDhlTermsAcknowledgement?: boolean, windsorFrameworkEnabled?: boolean) => RateOption[];
+export declare const useRateOptions: (rates?: SE.Rate[], fundingOrigin?: FundingOrigin, preferredRates?: PreferredRatesResponse, carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, servicePoints?: SE.ServicePoint[], requireDhlTermsAcknowledgement?: boolean, windsorFrameworkEnabled?: boolean) => RateOption[];

package/src/hooks/use-balance-services.d.ts

@@ -0,0 +1,22 @@
+import { CodedError, SE } from "@shipengine/react-api";
+export type FundingOrigin = {
+    balance: number;
+    currency: SE.Currency;
+    id: string;
+};
+export type UseBalanceServicesReturnType = ReturnType<typeof useBalanceServices>;
+/**
+ * The `useBalanceServices` hook retrieves and manages balance information for a carrier or funding source. If a funding source cannot be found, the hook will default to using the carrier balance associated with the provided `carrierId` as the primary source of truth.
+ *
+ * @returns `UseBalanceServicesReturnType`
+ */
+export declare const useBalanceServices: () => {
+    addFundsMutation: (funds: SE.Money) => Promise<void>;
+    errors: {
+        addFundsErrors: CodedError[] | undefined;
+        fetchBalanceErrors: CodedError[] | undefined;
+    };
+    fundingOrigin: FundingOrigin | undefined;
+    isLoadingBalance: boolean;
+    resetAddFundsMutationState: () => void;
+};

package/src/hooks/use-helpers.d.ts

@@ -1,4 +1,8 @@
 export declare const useHelpers: () => {
     helpersReady: boolean;
     sellerOnboarded: boolean;
+    validateShipFromAddress: (shipFromAddress: import("..").ShipFromAddress) => {
+        errors: unknown;
+        isValid: boolean;
+    };
 };

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;

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/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;