@shipengine/elements 2.4.0 → 2.6.0

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

@@ -143,7 +143,6 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -151,7 +150,6 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -165,7 +163,6 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -366,18 +363,15 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -424,6 +418,14 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -532,18 +534,38 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
                 };
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 title: string;
@@ -577,6 +599,10 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -777,6 +803,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -891,6 +918,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -915,6 +943,7 @@ export declare const Element: ({ resources, ...props }: CarrierServicesProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -150,7 +150,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     setup: {
                         title: string;
                         subtitle: string;
-                        hiddenTermsSubtitle: string;
                         descriptionTitle: string;
                         description: string;
                     };
@@ -158,7 +157,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         title: string;
                         cardSubTitle: string;
                         addressSubTitle: string;
-                        info: string;
                     };
                     vatSettings: {
                         title: string;
@@ -172,7 +170,6 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                             title: string;
                         };
                         info: {
-                            title: string;
                             description: string;
                         };
                         poBox: {
@@ -373,18 +370,15 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             onboarding: {
                 title: string;
-                inlineTitle: string;
-                accountRegistration: {
-                    action: string;
+                confirmation: {
                     title: string;
-                    subtitle: string;
-                    welcome: string;
-                    messageLine1: string;
-                    partnerMessageLine1: string;
-                    messageLine2: string;
+                    warehouse: string;
+                    billingAddress: string;
+                    paymentMethod: string;
+                    action: string;
                 };
                 stepLabel: {
-                    accountRegistration: string;
+                    confirmation: string;
                     termsAgreement: string;
                     shipFromAddress: string;
                     fundingAndCarrierConnection: string;
@@ -431,6 +425,14 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     "UHVyb2xhdG9yIFRlcm1zIGFuZCBDb25kaXRpb25zIG9mIFNlcnZpY2U=": string;
                     UHVyb2xhdG9yIE1vZGFsaXTDqXMgZXQgY29uZGl0aW9ucyBkZSBzZXJ2aWNl: string;
                 };
+                tooltip: {
+                    warehouse: string;
+                };
+                welcomePage: {
+                    title: string;
+                    message: string;
+                    action: string;
+                };
             };
             "manage-warehouses": {
                 title: string;
@@ -539,18 +541,38 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
             };
             "list-shipments": {
                 title: string;
+                none: string;
                 headers: {
                     created: string;
-                    download: string;
+                    modified: string;
+                    shipping: string;
                     shipmentId: string;
-                    shipDate: string;
-                    shipTo: string;
+                    parcels: string;
+                    recipient: string;
+                    status: string;
+                };
+                status: {
+                    cancelled: string;
+                    purchased: string;
+                    readyToBuy: string;
+                    processing: string;
                 };
                 actions: {
                     download: {
                         pdf: string;
                     };
                 };
+                emptyState: {
+                    title: string;
+                    subtitle: string;
+                    filtersTitle: string;
+                    filtersSubtitle: string;
+                    viewAll: string;
+                };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "list-labels": {
                 title: string;
@@ -584,6 +606,10 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     void: string;
                     printForms: string;
                 };
+                errorMessages: {
+                    title: string;
+                    subtitle: string;
+                };
             };
             "connect-carrier": {
                 actions: {
@@ -784,6 +810,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     emailIsRequired: string;
                     unknown: string;
                     noRatesAvailable: string;
+                    refreshAndTryAgain: string;
                 };
                 errorTypes: {
                     accountStatus: string;
@@ -898,6 +925,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     agreeToTerms: string;
                     carriersTitle: string;
                     fundingSourceTitle: string;
+                    shipEngineTitle: string;
                 };
                 weight: {
                     ounces: string;
@@ -922,6 +950,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         printForms: string;
                         edit: string;
                         remove: string;
+                        viewDetails: string;
                     };
                 };
                 ZnVuZGluZ19zb3VyY2VfaWQgbXVzdCBiZSBhbiBpbnRlZ2Vy: string;

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

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 import { Shipment } from "@shipengine/js-api";
+import { SE } from "@shipengine/react-api";
 import { PurchaseLabelFeatures, ShipmentSummaryFeatures } from "../../utilities";
 /**
  * @internal
@@ -23,11 +24,21 @@ export type LabelWorkflowProps = {
         onLabelCreateSuccess?: (label: {
             labelId: string;
         }, shipment: Shipment) => void;
+        /**
+         * `onVoidLabelComplete` is a callback function that will be invoked when the request to void a given
+         * shipping label is completed.
+         */
+        onVoidLabelComplete?: (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void;
+        /**
+         * `onVoidLabelSuccess` is a callback function that will be invoked when the request to void a given
+         * shipping label is successful.
+         */
+        onVoidLabelSuccess?: (label: SE.Label, shipment: SE.SalesOrderShipment) => void;
     };
     /**
      * `features` is a set of feature flags you would like to enable or disable in this component.
      */
-    features: PurchaseLabelFeatures & ShipmentSummaryFeatures;
+    features?: PurchaseLabelFeatures & ShipmentSummaryFeatures;
     /**
      * `multiplexedId` is the unique pattern of props that help index which Element is being displayed.
      */
@@ -39,37 +50,14 @@ export type LabelWorkflowProps = {
         externalOrderId: string;
     })) | {
         salesOrderId: string;
+    } | {
+        externalShipmentId: string;
     } | {
         shipmentId: string;
     } | {
         oneOff: true;
     };
 };
-/**
- * @internal
- *
- * # Label Workflow Component
- *
- * @example
- * ```tsx
- *   const {
- *     labelId,
- *     multiplexedId,
- *     isVoidingLabel,
- *     shipmentId,
- *     setLabelId,
- *     setShipmentId,
- *     setIsVoidingLabel,
- *   } = useLabelWorkflow({
- *     _labelId,
- *     _multiplexedId,
- *   });
- * ```
- *
- * <br />
- *
- * @see {@link LabelWorkflow.Element | The `<LabelWorkflow.Element />` component using this hook}
- */
 export declare const useLabelWorkflow: ({ _multiplexedId, }: {
     _callbacks?: {
         /**
@@ -79,6 +67,16 @@ export declare const useLabelWorkflow: ({ _multiplexedId, }: {
         onLabelCreateSuccess?: ((label: {
             labelId: string;
         }, shipment: Shipment) => void) | undefined;
+        /**
+         * `onVoidLabelComplete` is a callback function that will be invoked when the request to void a given
+         * shipping label is completed.
+         */
+        onVoidLabelComplete?: ((request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void) | undefined;
+        /**
+         * `onVoidLabelSuccess` is a callback function that will be invoked when the request to void a given
+         * shipping label is successful.
+         */
+        onVoidLabelSuccess?: ((label: SE.Label, shipment: SE.SalesOrderShipment) => void) | undefined;
     } | undefined;
     _multiplexedId: ({
         orderSourceCode: string;
@@ -88,13 +86,15 @@ export declare const useLabelWorkflow: ({ _multiplexedId, }: {
         externalOrderId: string;
     })) | {
         salesOrderId: string;
+    } | {
+        externalShipmentId: string;
     } | {
         shipmentId: string;
     } | {
         oneOff: true;
     };
 }) => {
-    isVoidingLabel: boolean;
+    element: "purchaseLabel" | "shipmentSummary" | "voidLabel" | undefined;
     labelId: string | undefined;
     multiplexedId: ({
         orderSourceCode: string;
@@ -104,13 +104,15 @@ export declare const useLabelWorkflow: ({ _multiplexedId, }: {
         externalOrderId: string;
     })) | {
         salesOrderId: string;
+    } | {
+        externalShipmentId: string;
     } | {
         shipmentId: string;
     } | {
         oneOff: true;
     };
-    setIsVoidingLabel: import("react").Dispatch<import("react").SetStateAction<boolean>>;
-    setLabelId: (nextLabelId?: string) => void;
+    setElement: import("react").Dispatch<import("react").SetStateAction<"purchaseLabel" | "shipmentSummary" | "voidLabel" | undefined>>;
+    setLabelId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     setShipmentId: import("react").Dispatch<import("react").SetStateAction<string | undefined>>;
     shipmentId: string | undefined;
 };

package/src/workflows/onboarding/components/confirmation-and-submission-step/confirmation-and-submission-step.d.ts

@@ -0,0 +1,12 @@
+import { SE } from "@shipengine/js-api";
+import { WarehousePayload } from "../../../../components";
+import { WalletPayload } from "../../../../components/templates";
+export type ConfirmationAndSubmissionStepProps = {
+    createFundingSourceErrors: SE.CodedError[] | null;
+    onEdit: (step: number) => void;
+    onSubmit: (wallet: WalletPayload, warehouse: WarehousePayload) => Promise<void>;
+    registerCarrierErrors: SE.CodedError[] | null;
+    walletPayload: WalletPayload;
+    warehousePayload: WarehousePayload;
+};
+export declare const ConfirmationAndSubmissionStep: ({ createFundingSourceErrors, onSubmit, onEdit, registerCarrierErrors, walletPayload, warehousePayload, }: ConfirmationAndSubmissionStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/confirmation-and-submission-step/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./confirmation-and-submission-step";
+export * from "./use-confirmation-and-submission-step";

package/src/workflows/onboarding/components/confirmation-and-submission-step/use-confirmation-and-submission-step.d.ts

@@ -0,0 +1,19 @@
+import { SE } from "@shipengine/react-api";
+import { WarehousePayload } from "../../../../components";
+import { WalletPayload } from "../../../../components/templates/wallet-form";
+type UseConfirmationAndSubmissionProps = {
+    onStepComplete: () => void;
+};
+export declare const useConfirmationAndSubmissionStep: ({ onStepComplete, }: UseConfirmationAndSubmissionProps) => {
+    createFundingSourceErrors: SE.CodedError[] | null;
+    createOnboardingSubmissionHandler: ({ carrierProfiles, fundingSourceTerms, }: {
+        carrierProfiles: SE.MetadataCarrierProfile[];
+        fundingSourceTerms: SE.MetadataRequiredTerm[];
+    }) => ({ address, creditCard, iovationBlackbox }: WalletPayload, warehousePayload: WarehousePayload) => Promise<void>;
+    isCreatingFundingSource: boolean;
+    isRegisteringCarriers: boolean;
+    isRegisteringCarriersSuccess: boolean;
+    registerCarrierErrors: SE.CodedError[] | null;
+    resetMutations: () => void;
+};
+export {};

package/src/workflows/onboarding/components/funding-step/funding-step.d.ts

@@ -0,0 +1,7 @@
+import { SE } from "@shipengine/react-api";
+import { WalletPayload } from "../../../../components/templates/wallet-form";
+export type FundingStepProps = {
+    address: SE.Address;
+    onSubmit: (payload: WalletPayload) => void;
+};
+export declare const FundingStep: ({ address, onSubmit, }: FundingStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/funding-step/index.d.ts

@@ -0,0 +1 @@
+export * from "./funding-step";

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

@@ -15,6 +15,5 @@ export type ValidateAddress = ValidateWarehouse | ValidateBilling;
 export type OnboardingWizardProps = {
     defaultShipFromAddress?: ShipFromAddressStepProps["defaultShipFromAddress"];
     onComplete: () => void;
-    partnerName?: string;
 };
-export declare const OnboardingWizard: ({ defaultShipFromAddress, onComplete: onWizardComplete, partnerName, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const OnboardingWizard: ({ defaultShipFromAddress, onComplete: onWizardComplete, }: OnboardingWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1,5 +1,8 @@
 export declare const styles: {
     container: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        display: "grid";
+        gridTemplateRows: string;
+        minHeight: string;
         padding: number;
     };
     step: {

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

@@ -1,2 +1 @@
 export * from "./ship-from-address-step";
-export * from "./use-ship-from-address-step";

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

@@ -2,6 +2,7 @@ import { SE } from "@shipengine/react-api";
 import { WarehousePayload } from "../../../../components";
 export type ShipFromAddressStepProps = {
     defaultShipFromAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
-    onSubmit: (payload: WarehousePayload) => Promise<void>;
+    onSubmit: (payload: WarehousePayload) => void;
+    warehousePayload?: WarehousePayload;
 };
-export declare const ShipFromAddressStep: ({ defaultShipFromAddress, onSubmit, }: ShipFromAddressStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ShipFromAddressStep: ({ defaultShipFromAddress, warehousePayload, onSubmit, }: ShipFromAddressStepProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/step-header/step-header.d.ts

@@ -1,5 +1,6 @@
 export type StepHeaderProps = {
-    subtitle: string;
+    subtitle?: string;
     title: string;
+    tooltipMessage?: string;
 };
-export declare const StepHeader: ({ title, subtitle }: StepHeaderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const StepHeader: ({ title, subtitle, tooltipMessage }: StepHeaderProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/workflows/onboarding/components/{funding-and-carrier-connection-step/funding-and-carrier-connection-step.styles.d.ts → step-header/step-header.styles.d.ts}

@@ -1,18 +1,15 @@
 export declare const styles: {
+    header: () => {
+        alignItems: "center";
+        display: "flex";
+        justifyContent: "center";
+    };
     iconTooltip: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
         color: string;
-        display: "inline-block";
         marginLeft: number;
-        verticalAlign: string;
     };
     tooltipContainer: {
         maxWidth: string;
         textAlign: "left";
     };
-    walletFormHeader: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
-        margin: number;
-    };
-    walletFormTitle: {
-        textAlign: "center";
-    };
 };

package/src/workflows/onboarding/components/welcome-page/index.d.ts

@@ -0,0 +1 @@
+export * from "./welcome-page";

package/src/workflows/onboarding/components/welcome-page/welcome-page.d.ts

@@ -0,0 +1,4 @@
+export type CompletionPageProps = {
+    onContinue: () => void;
+};
+export declare const WelcomePage: ({ onContinue }: CompletionPageProps) => import("@emotion/react/jsx-runtime").JSX.Element;