@shipengine/elements 2.0.0 → 2.1.0

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

@@ -176,6 +176,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -360,6 +361,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -405,6 +412,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -452,6 +460,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -551,6 +560,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -653,6 +665,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -660,6 +673,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: {
@@ -677,6 +698,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;
@@ -749,6 +775,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -827,6 +855,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;
@@ -842,7 +880,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/elements/vat-settings/vat-settings-element.d.ts

@@ -176,6 +176,7 @@ export declare const Element: ({ resources, ...props }: object & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -360,6 +361,12 @@ export declare const Element: ({ resources, ...props }: object & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
                     title: string;
                     subtitle: string;
@@ -405,6 +412,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -452,6 +460,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -551,6 +560,9 @@ export declare const Element: ({ resources, ...props }: object & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -653,6 +665,7 @@ export declare const Element: ({ resources, ...props }: object & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -660,6 +673,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: {
@@ -677,6 +698,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;
@@ -749,6 +775,8 @@ export declare const Element: ({ resources, ...props }: object & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -827,6 +855,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;
@@ -842,7 +880,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/elements/void-label/void-label.d.ts

@@ -267,6 +267,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                     };
                 };
+                noFundingSource: string;
             };
             "rate-details": {
                 total: string;
@@ -451,8 +452,23 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     subtitle: string;
                     inlineMessage: string;
                 };
+                errors: {
+                    noCarriers: {
+                        /**
+                         * `onSuccess` is a callback function that will be invoked when the request to void a given
+                         * shipping label is successful.
+                         */
+                        title: string;
+                        subtitle: string;
+                    };
+                };
                 success: {
-                    title: string;
+                    title: 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;
                     action: string;
                 };
@@ -496,6 +512,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 returnToAddressIsDifferent: string;
                 setDefault: string;
                 shipFrom: string;
+                noWarehouses: string;
             };
             "manage-funding": {
                 actions: {
@@ -545,6 +562,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 errors: {
                     balanceUnknown: string;
                     unableToFindBalance: string;
+                    noFundingSource: string;
                 };
                 byoc: {
                     invoiceNotification: string;
@@ -646,6 +664,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     toastTitle: string;
                     toastBody: string;
                 };
+                deleteCarrierErrorTitle: string;
+                deleteCarrierErrorMessage: string;
+                loadingDeletingCarrier: string;
             };
             common: {
                 actions: {
@@ -751,6 +772,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 customs: {
                     addDeclaration: string;
+                    noResults: string;
                     contents: {
                         documents: string;
                         gift: string;
@@ -758,6 +780,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: {
@@ -775,6 +805,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;
@@ -847,6 +882,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     shipment: string;
                     shipments: string;
                     warehouses: string;
+                    funding: string;
+                    paymentMethod: string;
                 };
                 months: {
                     january: string;
@@ -925,6 +962,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;
@@ -940,7 +987,11 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "account-settings": {
                 messages: {
-                    noFundingSources: string;
+                    transactionHistory: {
+                        noTransactions: string;
+                    };
+                    noFundingSourceDescription: string;
+                    noFundingSourceAction: string;
                 };
                 title: string;
                 sections: {
@@ -950,18 +1001,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     adjustmentHistory: string;
                     warehouses: string;
                     carriers: string;
-                    /**
-                     * # Void Label Component Props
-                     *
-                     * - These are the base props that will be passed into the `<VoidLabel />` component.
-                     *
-                     * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
-                     */
                     externalCarriers: string;
                     labelLayout: string;
                     unitSettings: string;
                     vatSettings: string;
-                };
+                }; /**
+                 * `onComplete` is a callback function that will be invoked when the request to void a given
+                 * shipping label is completed.
+                 */
             };
         };
     } | undefined;

package/src/elements-provider/elements-context-provider.d.ts

@@ -0,0 +1,44 @@
+/// <reference types="react" />
+import { Theme } from "@shipengine/giger-theme";
+import { ShipEngineAPIConfig, ShipEngineProps } from "@shipengine/react-api";
+import { ElementsFeatureFlags, GlobalFeatures } from "../utilities";
+export type ElementsErrorHandler = (err: Error) => void;
+export interface ElementsContextValue {
+    baseURL: string;
+    cdnURL: string;
+    container?: HTMLElement;
+    getFeatures: (key: keyof ElementsFeatureFlags) => ElementsFeatureFlags[keyof ElementsFeatureFlags];
+    getToken: ShipEngineProps["getToken"];
+    globalFeatures: GlobalFeatures;
+    locale?: string;
+    onError: ElementsErrorHandler;
+    scope: string | null;
+    theme: Theme;
+}
+/**
+ * @category Contexts
+ */
+export declare const ElementsContext: import("react").Context<ElementsContextValue | undefined>;
+export type ElementsContextProviderProps = {
+    cdnURL?: string;
+    children: React.ReactNode;
+    container?: HTMLElement;
+    features?: ElementsFeatureFlags;
+    locale?: string;
+    onError?: ElementsErrorHandler;
+    /** Scope of the Elements Provider. Can be null to not specify a specific element */
+    scope?: string | null;
+    theme: Theme;
+} & Pick<ShipEngineAPIConfig, "getToken" | "baseURL">;
+/**
+ * @category Providers
+ */
+export declare const ElementsContextProvider: ({ baseURL, cdnURL, children, container, features, getToken, locale: localeProp, onError, scope, theme, }: ElementsContextProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * Must be used within {@link ElementsProvider}
+ *
+ * @category Elements Hooks
+ *
+ * @see {@link registerElement}
+ */
+export declare const useElements: () => ElementsContextValue;

package/src/elements-provider/elements-provider.d.ts

@@ -1,46 +1,12 @@
-/// <reference types="react" />
 import { DefaultOptions } from "@tanstack/react-query";
-import { CustomThemeData, Theme } from "@shipengine/giger-theme";
-import { ShipEngineAPIConfig, ShipEngineProps } from "@shipengine/react-api";
-import { ElementsFeatureFlags, GlobalFeatures } from "../utilities";
-export type ElementsErrorHandler = (err: Error) => void;
-export interface ElementsContextValue {
-    baseURL: string;
-    cdnURL: string;
-    container?: HTMLElement;
-    getFeatures: (key: keyof ElementsFeatureFlags) => ElementsFeatureFlags[keyof ElementsFeatureFlags];
-    getToken: ShipEngineProps["getToken"];
-    globalFeatures: GlobalFeatures;
-    locale?: string;
-    onError: ElementsErrorHandler;
-    scope: string | null;
-    theme: Theme;
-}
-/**
- * @category Contexts
- */
-export declare const ElementsContext: import("react").Context<ElementsContextValue | undefined>;
-export type ElementsProviderProps = {
-    cdnURL?: string;
-    children: React.ReactNode;
-    container?: HTMLElement;
+import { CustomThemeData } from "@shipengine/giger-theme";
+import { ShipEngineAPIConfig } from "@shipengine/react-api";
+import { ElementsContextProviderProps } from "./elements-context-provider";
+export type ElementsProviderProps = Omit<ElementsContextProviderProps, "theme"> & ShipEngineAPIConfig & {
     defaultQueryClientOptions?: DefaultOptions;
-    features?: ElementsFeatureFlags;
-    locale?: string;
-    onError?: ElementsErrorHandler;
-    /** Scope of the Elements Provider. Can be null to not specify a specific element */
-    scope?: string | null;
     themeConfig?: CustomThemeData;
-} & ShipEngineAPIConfig;
+};
 /**
  * @category Providers
  */
-export declare const ElementsProvider: ({ baseURL, cdnURL, children, container, features, getToken, headers, locale: localeProp, onApiError, onError, scope, themeConfig, defaultQueryClientOptions, }: ElementsProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-/**
- * Must be used within {@link ElementsProvider}
- *
- * @category Elements Hooks
- *
- * @see {@link registerElement}
- */
-export declare const useElements: () => ElementsContextValue;
+export declare const ElementsProvider: ({ baseURL, cdnURL, children, container, features, getToken, headers, locale, onApiError, onError, scope, themeConfig, defaultQueryClientOptions, }: ElementsProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/elements-provider/index.d.ts

@@ -1 +1,3 @@
+export * from "./elements-context-provider";
 export * from "./elements-provider";
+export * from "./elements-test-provider";

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

@@ -4,7 +4,7 @@ export type ConnectedCarrierMetadata = {
     isConnected: boolean;
 };
 export declare const useListFundingSourceCarriers: () => {
-    data: ConnectedCarrierMetadata[];
+    data: ConnectedCarrierMetadata[] | undefined;
     error: import("@shipengine/react-api").CodedError[] | null;
     isLoading: boolean;
     refetch: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/react-api").Carrier[], import("@shipengine/react-api").CodedError[]>>;

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

@@ -1,4 +1,5 @@
 export type ShipEngineCarriersProps = {
+    onRedirectToOnboarding?: () => void;
     showFunds?: boolean;
 };
-export declare const ShipEngineCarriers: ({ showFunds }: ShipEngineCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ShipEngineCarriers: ({ showFunds, onRedirectToOnboarding, }: ShipEngineCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/manage-external-carriers/index.d.ts

@@ -1 +1,2 @@
 export * from "./manage-external-carriers";
+export * from "./use-manage-external-carriers";

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

@@ -1,4 +1,14 @@
+import { Carrier, CodedError, ListCarrierConnectionsResponse } from "@shipengine/js-api";
 export type ExternalCarriersProps = {
+    carrierMetadata?: ListCarrierConnectionsResponse;
+    carrierMetadataLoading: boolean;
+    connectedExternalCarriers?: Carrier[];
+    deleteCarrier: (carrierId: string) => Promise<void>;
+    deleteCarrierErrors: CodedError[] | null;
+    isDeletingCarrier: boolean;
+    isListCarriersFetching: boolean;
+    isListCarriersLoading: boolean;
     isModalFullScreen?: boolean;
+    refetchConnectedCarriers: () => void;
 };
-export declare const ExternalCarriers: ({ isModalFullScreen }: ExternalCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ExternalCarriers: ({ isModalFullScreen, carrierMetadata, carrierMetadataLoading, connectedExternalCarriers, deleteCarrier, isDeletingCarrier, isListCarriersFetching, isListCarriersLoading, deleteCarrierErrors, refetchConnectedCarriers, }: ExternalCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,12 @@
+export declare const useManageExternalCarriers: () => {
+    carrierMetadata: import("@shipengine/react-api").ListCarrierConnectionsResponse | undefined;
+    carrierMetadataLoading: boolean;
+    connectedExternalCarriers: import("@shipengine/react-api").Carrier[] | undefined;
+    deleteCarrier: import("@tanstack/react-query").UseMutateAsyncFunction<void, import("@shipengine/react-api").CodedError[], string, unknown>;
+    deleteCarrierErrors: import("@shipengine/react-api").CodedError[] | null;
+    deleteCarrierSuccess: boolean;
+    isDeletingCarrier: boolean;
+    isListCarriersFetching: boolean;
+    isListCarriersLoading: boolean;
+    refetchConnectedCarriers: <TPageData>(options?: (import("@tanstack/query-core").RefetchOptions & import("@tanstack/query-core").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("@tanstack/query-core").QueryObserverResult<import("@shipengine/react-api").Carrier[], import("@shipengine/react-api").CodedError[]>>;
+};

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

@@ -13,4 +13,7 @@
  *
  * @see {@link ManageFundingProps | The props that are passed into the `<ManageFunding />` component}
  */
-export declare const ManageFunding: () => import("@emotion/react/jsx-runtime").JSX.Element;
+export type ManageFundingProps = {
+    onRedirectToOnboarding?: () => void;
+};
+export declare const ManageFunding: ({ onRedirectToOnboarding }: ManageFundingProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/payment-method-settings/payment-method-settings.d.ts

@@ -17,4 +17,7 @@
  *
  * @see {@link AccountSettings.Element | The `<AccountSettings />` component renders the `<PaymentMethodSettings />` component}
  */
-export declare const PaymentMethodSettings: () => import("@emotion/react/jsx-runtime").JSX.Element;
+export type PaymentMethodSettingsProps = {
+    onRedirectToOnboarding: () => void;
+};
+export declare const PaymentMethodSettings: ({ onRedirectToOnboarding }: PaymentMethodSettingsProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/react-api";
-import { SelectCategory } from "../../components/field/select";
+import { SelectCategory } from "../../components/field/select/select-with-categories";
 /**
  * @internal
  *

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

@@ -6,7 +6,9 @@ import { SE } from "@shipengine/react-api";
  *
  * @category Hooks
  */
-export declare const useWarehouseOptions: (warehouses?: SE.Warehouse[]) => {
+export declare const useWarehouseOptions: (warehouses?: SE.Warehouse[], rightContentAction?: ((warehouseId: string) => void) | undefined) => {
     label: string;
+    rightContent: import("@emotion/react/jsx-runtime").JSX.Element;
+    subLabel: string;
     value: string;
 }[] | undefined;

package/src/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./components";
 export * from "./constants";
+export * from "./create-element";
 export * from "./elements";
 export * from "./extensions";
 export * from "./hooks";