@shipengine/elements 1.5.1 → 1.6.0

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

@@ -0,0 +1,10 @@
+import { ConnectCarrier } from "../../workflows";
+export type ExternalCarriersFeatures = ConnectCarrier.ConnectCarrierFeatures;
+export type ExternalCarriersProps = {
+    /**
+     * `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;
+};
+export declare const ExternalCarriers: ({ features }: ExternalCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

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

package/src/features/index.d.ts

@@ -1 +1,8 @@
 export * from "./wallet-history";
+export * from "./label-layout";
+export * from "./manage-funding";
+export * from "./unit-settings";
+export * from "./payment-method-settings";
+export * from "./manage-warehouses";
+export * from "./list-carriers";
+export * from "./external-carriers";

package/src/features/label-layout/index.d.ts

@@ -0,0 +1,2 @@
+export * as LabelLayout from "./label-layout";
+export * from "./use-label-layout";

package/src/features/label-layout/label-layout.d.ts

@@ -0,0 +1,2 @@
+export declare const Settings: () => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Purchase: () => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/label-layout/use-label-layout.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/alchemy";
+export declare const useLabelLayout: () => {
+    accountSettings: SE.AccountSettings | undefined;
+    errors: SE.CodedError[] | null;
+    loading: boolean;
+    updateAccountSettings: (newLabelLayout: SE.LabelLayout) => Promise<void>;
+};

package/src/features/list-carriers/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./use-carrier-metadata";
+export * from "./use-list-connected-carriers";

package/src/{hooks → features/list-carriers/hooks}/use-carrier-metadata.d.ts

@@ -1,5 +1,5 @@
 import { CarrierConnection } from "@shipengine/alchemy";
-import { CarrierMetadata } from "../types";
+import { CarrierMetadata } from "../../../types";
 /**
  * @internal
  *

package/src/{components/templates → features/list-carriers}/list-carriers-row/list-carriers-row.d.ts

@@ -1,6 +1,6 @@
 import { CodedError } from "@shipengine/alchemy";
-import { ConnectedCarrierMetadata } from "../../../elements/list-carriers/hooks/use-list-connected-carriers";
-import { AddCarrierFormPayload } from "../add-carrier-form";
+import { AddCarrierFormPayload } from "../../../components/templates/add-carrier-form";
+import { ConnectedCarrierMetadata } from "../hooks/use-list-connected-carriers";
 export type ListCarriersRowProps = {
     connectedCarrier: ConnectedCarrierMetadata;
     registerCarrier: (payload?: AddCarrierFormPayload) => Promise<void>;

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

@@ -0,0 +1,9 @@
+export type ListCarriersFeatures = {
+    carriers: {
+        enabledCarriers: ("stamps_com" | "ups_walleted" | "ups" | "dhl_express_walleted" | "dhl_express_worldwide" | "hermes" | "yodel_walleted" | "dpdwallet" | "globalpost")[];
+    };
+};
+export type ListCarriersProps = {
+    features?: ListCarriersFeatures;
+};
+export declare const ListCarriers: ({ features, }: ListCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,16 @@
+/**
+ * @namespace ManageFunding
+ *
+ * # Manage Funding Component
+ *
+ * - The `<ManageFunding />` component is used to manage funding rules and add funds to a carrier
+ * account, and is composed in the `<AccountSettings />` component.
+ *
+ * @param ManageFundingProps The base props that will be passed into the `<ManageFunding />` component.
+ *
+ * @returns Element A React element that renders the `<ManageFunding />` component allowing users
+ * manage funding rules and add funds to their carrier accounts.
+ *
+ * @see {@link ManageFundingProps | The props that are passed into the `<ManageFunding />` component}
+ */
+export declare const ManageFunding: () => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1 @@
+export declare const ManageWarehouses: () => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/{components → features}/unit-settings/unit-settings.d.ts

@@ -1,6 +1 @@
-/**
- * @namespace UnitSettings
- *
- * # Unit Settings Component
- */
 export declare const UnitSettings: () => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/features/wallet-history/wallet-history.styles.d.ts

@@ -21,10 +21,11 @@ export declare const styles: {
         padding: number;
         textAlign: "center";
     };
-    gridContainer: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
-        display: "flex";
-        justifyContent: "space-between";
-        placeItems: "center";
+    gridContainer: {
+        "@media (max-width: 550px)": {
+            display: "flex";
+            flexDirection: "column-reverse";
+        };
     };
     linkAction: {
         margin: string;
@@ -40,7 +41,6 @@ export declare const styles: {
         textAlign: "center";
     };
     skeletonCard: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
-        backgroundColor: string;
         display: "flex";
         justifyContent: "space-between";
         padding: number;
@@ -58,9 +58,13 @@ export declare const styles: {
         rowGap: number;
     };
     skeletonCardList: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        "& > li:not(:last-child)": {
+            borderBottom: string;
+        };
+        border: string;
         display: "flex";
         flexDirection: "column";
-        rowGap: number;
+        listStyle: "none";
     };
     skeletonCardLogo: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
         alignItems: "center";
@@ -79,8 +83,4 @@ export declare const styles: {
         marginRight: string;
         maxWidth: string;
     };
-    transactionTypeSelect: {
-        height: string;
-        width: string;
-    };
 };

package/src/hooks/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./options";
-export * from "./use-carrier-metadata";
 export * from "./use-nested-form";
 export * from "./use-page-layout";
 export * from "./use-root-portal";

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

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/alchemy";
-import { PreferredRateAcknowledgementMessage, PreferredRatesResponse } from "../../elements/configure-shipment";
+import { PreferredRateAcknowledgementMessage, PreferredRatesResponse } from "../../types";
 /**
  * @internal
  *

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

@@ -231,7 +231,8 @@ declare const _default: {
             nextOpeningDay: string;
             until: string;
             selected: string;
-            selectLocation: string;
+            select: string;
+            today: string;
             viewMap: string;
             otherLocations: string;
             noServicePointsFound: string;
@@ -287,12 +288,14 @@ declare const _default: {
             "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
             aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
             "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+            aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
         };
         termsAndAgreementTitles: {
             "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
             "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
             "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
             RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+            "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
         };
     };
     "manage-defaults": {
@@ -731,6 +734,7 @@ declare const _default: {
     "connect-carrier": {
         actions: {
             cancel: string;
+            carrierSettings: string;
             connectCarriers: string;
             disconnect: string;
             disconnectCarrier: string;
@@ -749,6 +753,10 @@ declare const _default: {
         status: {
             connected: string;
         };
+        disconnectDropdown: {
+            toastTitle: string;
+            toastBody: string;
+        };
     };
     "account-settings": {
         messages: {

package/src/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./carrier-metadata";
 export * from "./patch";
 export * from "./shipping-preset";
+export * from "./preferred-rates";

package/src/types/preferred-rates.d.ts

@@ -0,0 +1,13 @@
+import { SE } from "@shipengine/alchemy";
+export type PreferredRateAcknowledgementMessage = {
+    link?: {
+        text: string;
+        url: string;
+    };
+    primaryMessage: string;
+    secondaryMessage?: string;
+};
+export type PreferredRatesResponse = Array<{
+    rate: SE.Rate;
+    rateAcknowledgementMessage?: PreferredRateAcknowledgementMessage;
+}>;

package/src/utilities/date.d.ts

@@ -1,3 +1,4 @@
+import * as Locales from "date-fns/locale";
 /**
  * @internal
  *
@@ -12,7 +13,7 @@ export declare const formatDate: (date: string, locale?: string) => string;
  * @param locale string i.e. "en-US"
  * @returns locale data
  */
-export declare const findDateLocale: (locale?: string) => Locale;
+export declare const findDateLocale: (locale?: string) => Locales.Locale;
 /**
  * @internal
  * Given a date and a locale, format the date to the locale's date format.

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

@@ -161,7 +161,7 @@ export declare const featureFlags: {
              * `enabledCarriers` is a list of all `carriers` that are enabled for use in ShipEngine
              * Elements.
              */
-            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted", "dpdwallet"];
+            readonly enabledCarriers: readonly ["stamps_com", "ups_walleted", "dhl_express_walleted", "ups", "hermes", "yodel_walleted", "dpdwallet", "globalpost"];
         };
         /**
          * All global `presentation` related feature flags.

package/src/utilities/index.d.ts

@@ -10,4 +10,5 @@ export * from "./rates";
 export * from "./shipengine";
 export * from "./formatString";
 export * from "./styles";
+export * from "./tracking-status-formatter";
 export * from "./validation";

package/src/utilities/tracking-status-formatter.d.ts

@@ -0,0 +1 @@
+export declare const trackingStatusFormatter: (status: string) => string | undefined;

package/src/{elements → workflows}/account-settings/account-settings.d.ts

@@ -1,5 +1,7 @@
 /// <reference types="react" />
-import { AccountSettingsFeatures } from "../../components/templates/account-settings";
+import { ListCarriersFeatures } from "../../features";
+import { ConnectCarrier } from "../connect-carrier";
+export type AccountSettingsFeatures = ListCarriersFeatures & ConnectCarrier.ConnectCarrierFeatures;
 /**
  * # Account Settings Component Props
  *
@@ -18,29 +20,7 @@ export type ComponentProps = {
      */
     onSaveSettings: () => void;
 };
-/**
- * # Account Settings Component
- *
- * - The `<AccountSettings />` component is used to display the user's account settings, as well as
- * allowing them to make changes to various aspects of their account.
- *
- * @returns Element An EmotionJSX.Element that will render the `<AccountSettings />` component
- * with all the appropriate wrappers.
- *
- * @example
- * You can see how the `<Component />` is used in the `createElement` function call below.
- * ```tsx
- * export const Element = alchemy.createElement(Component, ErrorFallback, {
- *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
- *   resources: { en },
- * });
- * ```
- *
- * <br />
- *
- * @see {@link AccountSettings.Element | The **Element** created to render `<AccountSettings />`}
- */
-export declare const Component: ({ features, onSaveSettings }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Component: ({ onSaveSettings, features }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * # Registered Account Settings Element
  *
@@ -206,13 +186,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     showItems: string;
                     showMoreRates: string;
                     showFewerRates: 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`}
-                     */
                     saveRate: string;
                 };
                 balance: {
@@ -307,7 +280,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     nextOpeningDay: string;
                     until: string;
                     selected: string;
-                    selectLocation: string;
+                    select: string;
+                    today: string;
                     viewMap: string;
                     otherLocations: string;
                     noServicePointsFound: string;
@@ -363,12 +337,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
                 };
             };
             "manage-defaults": {
@@ -400,10 +376,6 @@ 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;
@@ -538,13 +510,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     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`}
-                     */
                     submit: string;
                     tryAgain: string;
                 };
@@ -558,10 +523,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         addressLine2: string;
                         cityLocality: string;
                         stateProvince: 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.
-                         */
+                        postalCode: string;
                         phone: string;
                         email: string;
                         addressResidentialIndicator: string;
@@ -821,6 +783,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             "connect-carrier": {
                 actions: {
                     cancel: string;
+                    carrierSettings: string;
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
@@ -833,15 +796,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 };
                 search: string;
                 settingsModal: {
-                    /**
-                     * Feature flags controlling operation of various sub components.
-                     */
                     closeDialog: string;
                     header: string;
                 };
                 status: {
                     connected: string;
                 };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
+                };
             };
             "account-settings": {
                 messages: {

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

@@ -0,0 +1,4 @@
+import { CollapsiblePanelProps } from "../../components";
+export declare const useGetPanelProps: () => {
+    getSettingPanelProps: (setting: string) => CollapsiblePanelProps;
+};

package/src/{elements → workflows}/connect-carrier/connect-carrier.d.ts

@@ -272,7 +272,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     nextOpeningDay: string;
                     until: string;
                     selected: string;
-                    selectLocation: string;
+                    select: string;
+                    today: string;
                     viewMap: string;
                     otherLocations: string;
                     noServicePointsFound: string;
@@ -328,12 +329,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
                 };
             };
             "manage-defaults": {
@@ -795,6 +798,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             "connect-carrier": {
                 actions: {
                     cancel: string;
+                    carrierSettings: string;
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
@@ -813,6 +817,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 status: {
                     connected: string;
                 };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
+                };
             };
             "account-settings": {
                 messages: {

package/src/workflows/index.d.ts

@@ -1 +1,4 @@
 export * from "./onboarding";
+export * from "./purchase-label-workflow";
+export * from "./account-settings";
+export * from "./connect-carrier";

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

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/alchemy";
-import { ListCarriersFeatures } from "../../../../components/templates/list-carriers";
+import { ListCarriersFeatures } from "../../../../features";
 import { ShipFromAddressStepProps } from "../ship-from-address-step";
 export type ValidateWarehouse = {
     type: "warehouse";

package/src/workflows/onboarding/components/ship-from-address-step/ship-from-address-step.d.ts

@@ -1,5 +1,5 @@
 import { SE } from "@shipengine/alchemy";
-import { WarehousePayload } from "../../../../components/templates/manage-warehouses";
+import { WarehousePayload } from "../../../../components";
 export type ShipFromAddressStepProps = {
     defaultShipFromAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
     onSubmit: (payload: WarehousePayload) => Promise<void>;

package/src/workflows/onboarding/components/ship-from-address-step/use-ship-from-address-step.d.ts

@@ -1,4 +1,4 @@
-import { WarehousePayload } from "../../../../components/templates/manage-warehouses";
+import { WarehousePayload } from "../../../../components";
 export type UseShipFromAddressStepProps = {
     onStepComplete: () => void;
 };

package/src/workflows/onboarding/onboarding.d.ts

@@ -309,7 +309,8 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     nextOpeningDay: string;
                     until: string;
                     selected: string;
-                    selectLocation: string;
+                    select: string;
+                    today: string;
                     viewMap: string;
                     otherLocations: string;
                     noServicePointsFound: string;
@@ -365,12 +366,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "aHR0cHM6Ly93d3cueW9kZWxkaXJlY3QuY28udWsvY29udGVudC9hYm91dC10ZXJtcw==": string;
                     aHR0cHM6Ly93d3cuc2hpcHN0YXRpb24uY29tL3Rlcm1zLXNlcnZpY2UtdW5pdGVkLWtpbmdkb20v: string;
                     "aHR0cHM6Ly93d3cuZHBkLmNvLnVrL3N0YW5kYXJkX3Rlcm1zX2FuZF9jb25kaXRpb25zLmpzcA==": string;
+                    aHR0cHM6Ly93d3cuZ29nbG9iYWxwb3N0LmNvbS9jb25kaXRpb25z: string;
                 };
                 termsAndAgreementTitles: {
                     "WW9kZWwgRGlyZWN0IC0gVGVybXMgYW5kIENvbmRpdGlvbnMgKOKAnFRlcm1z4oCdKQ==": string;
                     "RXZyaSBTZW5kIFRlcm1zICYgQ29uZGl0aW9ucw==": string;
                     "VGVybXMgb2YgU2VydmljZSBVbml0ZWQgS2luZ2RvbQ==": string;
                     RFBEIFN0YW5kYXJkIFRlcm1zIGFuZCBDb25kaXRpb25z: string;
+                    "R2xvYmFsUG9zdCBUZXJtcyBhbmQgQ29uZGl0aW9ucw==": string;
                 };
             };
             "manage-defaults": {
@@ -855,6 +858,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             "connect-carrier": {
                 actions: {
                     cancel: string;
+                    carrierSettings: string;
                     connectCarriers: string;
                     disconnect: string;
                     disconnectCarrier: string;
@@ -862,7 +866,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 noCarriersDescription: string;
                 registrationForm: {
                     error: string;
-                    title: string; /** If provided, the address form will be pre-filled */
+                    title: string;
                     betaWarning: string;
                 };
                 search: string;
@@ -873,6 +877,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 status: {
                     connected: string;
                 };
+                disconnectDropdown: {
+                    toastTitle: string;
+                    toastBody: string;
+                };
             };
             "account-settings": {
                 messages: {

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

@@ -0,0 +1 @@
+export * as PurchaseLabelWorkflow from "./purchase-label-workflow";

package/src/{elements/shipengine-workflow/label-workflow.d.ts → workflows/purchase-label-workflow/purchase-label-workflow.d.ts}

@@ -1,18 +1,16 @@
-import React from "react";
+/// <reference types="react" />
 import { Shipment } from "@shipengine/js-api";
-import { PurchaseLabel } from "../purchase-label";
-import { ViewShipment } from "../view-shipment";
-import { VoidLabel } from "../void-label";
+import { PurchaseLabel, ViewShipment, VoidLabel } from "../../elements";
 /**
  * @internal
  *
  * # Label Workflow Props
  *
- * - These are the base props that will be passed into the `<LabelWorkflow />` component.
+ * - These are the base props that will be passed into the `<PurchaseLabelWorkflow />` component.
  *
- * @see {@link LabelWorkflow.Element | The `<LabelWorkflow.Element />` component}
+ * @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component}
  */
-export type LabelWorkflowProps = {
+export type PurchaseLabelWorkflowProps = {
     /**
      * `callbacks` is an optional set of callbacks that will be invoked at various points in the
      * label purchasing workflow.
@@ -66,7 +64,7 @@ export type LabelWorkflowProps = {
  *     setLabelId,
  *     setShipmentId,
  *     setIsVoidingLabel,
- *   } = useLabelWorkflow({
+ *   } = usePurchaseLabelWorkflow({
  *     _labelId,
  *     _multiplexedId,
  *   });
@@ -74,9 +72,9 @@ export type LabelWorkflowProps = {
  *
  * <br />
  *
- * @see {@link LabelWorkflow.Element | The `<LabelWorkflow.Element />` component using this hook}
+ * @see {@link PurchaseLabelWorkflow.Element | The `<PurchaseLabelWorkflow.Element />` component using this hook}
  */
-export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
+export declare const usePurchaseLabelWorkflow: ({ _multiplexedId, _labelId, }: {
     _callbacks?: {
         /**
          * `onLabelCreateSuccess` is an optional callback function that will be invoked when a label
@@ -116,9 +114,9 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
     } | {
         oneOff: true;
     };
-    setIsVoidingLabel: React.Dispatch<React.SetStateAction<boolean>>;
-    setLabelId: (nextLabelId: LabelWorkflowProps["labelId"]) => void;
-    setMultiplexedId: React.Dispatch<React.SetStateAction<({
+    setIsVoidingLabel: import("react").Dispatch<import("react").SetStateAction<boolean>>;
+    setLabelId: (nextLabelId: PurchaseLabelWorkflowProps["labelId"]) => void;
+    setMultiplexedId: import("react").Dispatch<import("react").SetStateAction<({
         orderSourceCode: string;
     } & ({
         externalOrderNumber: string;
@@ -131,7 +129,7 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
     } | {
         oneOff: true;
     }>>;
-    setShipmentId: React.Dispatch<React.SetStateAction<string | undefined>>;
+    setShipmentId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     shipmentId: string | undefined;
 };
 /**
@@ -139,17 +137,17 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
  *
  * # Label Workflow Element
  *
- * - The `<LabelWorkflow.Element />` component is a composition of the PurchaseLabel, ViewShipment,
+ * - The `<PurchaseLabelWorkflow.Element />` component is a composition of the PurchaseLabel, ViewShipment,
  * and VoidLabel elements that allows users to purchase a label, view the shipment details, and optionally void their shipping label.
  *
- * @param LabelWorkflowProps The props necessary to render the `<LabelWorkflow.Element />` for shipment
+ * @param PurchaseLabelWorkflowProps The props necessary to render the `<PurchaseLabelWorkflow.Element />` for shipment
  * based or sales order based label purchasing.
  *
- * @returns Element A React Element that will render the `<LabelWorkflow />` component.
+ * @returns Element A React Element that will render the `<PurchaseLabelWorkflow />` component.
  *
  * @example
  * ```tsx
- * <LabelWorkflow
+ * <PurchaseLabelWorkflow
  *       {...elementProps}
  *       callbacks={{ onLabelCreateSuccess }}
  *       multiplexedId={elementIdProps}
@@ -158,7 +156,7 @@ export declare const useLabelWorkflow: ({ _multiplexedId, _labelId, }: {
  *
  * <br />
  *
- * @see {@link LabelWorkflowProps | The props that are passed into the `<LabelWorkflow />` component}
- * @see {@link LabelWorkflow.useLabelWorkflow | The `hook` that is used to manage the state of the `<LabelWorkflow />` component}
+ * @see {@link PurchaseLabelWorkflowProps | The props that are passed into the `<PurchaseLabelWorkflow />` component}
+ * @see {@link PurchaseLabelWorkflow.usePurchaseLabelWorkflow | The `hook` that is used to manage the state of the `<PurchaseLabelWorkflow />` component}
  */
-export declare const Element: ({ multiplexedId: _multiplexedId, labelId: _labelId, features: propFeatures, callbacks, }: LabelWorkflowProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ multiplexedId: _multiplexedId, labelId: _labelId, features: propFeatures, callbacks, }: PurchaseLabelWorkflowProps) => import("@emotion/react/jsx-runtime").JSX.Element;