@shipengine/elements 0.17.2 → 0.18.0

package/components/auto-funding-form/auto-funding-form.d.ts

@@ -3,6 +3,8 @@ export type AutoFundingFormProps = {
 };
 /**
  * This form that allows users to enable or disable auto funding, and
- * configure auto funding settings in ShipEngine API.
+ * configure auto funding rules in ShipEngine API.
+ *
+ * @param carrierId The carrierId of the carrier provider you wish to configure auto-funding rules for.
  */
 export declare const AutoFundingForm: ({ carrierId }: AutoFundingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/auto-funding-form/auto-funding-form.styles.d.ts

@@ -1 +1,2 @@
-export declare const styles: Record<"form", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;
+import { Theme } from "@packlink/brands";
+export declare const getStyles: (showForm: boolean) => Record<"edit" | "form" | "input" | "marginLeft", import("@emotion/serialize").Interpolation<Theme>>;

package/components/field/expiration-input/expiration-input.d.ts

@@ -0,0 +1,3 @@
+import { InputProps as NativeInputProps } from "@packlink/giger";
+import { ControlledField } from "../create-field-controller";
+export declare const ExpirationInput: ControlledField<NativeInputProps>;

package/components/field/expiration-input/index.d.ts

@@ -0,0 +1 @@
+export * from "./expiration-input";

package/components/field/fields.d.ts

@@ -1,6 +1,7 @@
 export * from "./credit-card-input";
 export * from "./checkbox-input";
 export * from "./date-picker";
+export * from "./expiration-input";
 export * from "./input-group";
 export * from "./money-input";
 export * from "./number-input";

package/components/field/switch/switch.d.ts

@@ -3,7 +3,7 @@ import { ISwitchProps } from "@packlink/giger";
 export type SwitchProps = {
     children?: React.ReactNode;
     defaultChecked?: boolean;
-    label: string;
+    label?: string;
     shouldUnmount?: boolean;
 } & Omit<ISwitchProps, "children">;
 export declare const Switch: ({ defaultChecked, children, shouldUnmount, label, onChange, ...props }: SwitchProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/fund-and-purchase/fund-and-purchase.d.ts

@@ -1,7 +1,10 @@
+import { Control } from "react-hook-form";
 export type FundAndPurchaseProps = {
     carrierId?: string;
     className?: string;
+    control: Control<any, any>;
     disabled?: boolean;
+    isFundingEnabled?: boolean;
     isFundingRequired: boolean;
     onPurchase: () => void;
     onSave: () => Promise<void>;
@@ -12,4 +15,4 @@ export type FundAndPurchaseProps = {
  * has the necessary funds available and can add them if not. It allows a single button
  * to submit the funding form followed by the purchase form.
  */
-export declare const FundAndPurchase: ({ carrierId, className, disabled, isFundingRequired, onSave, purchaseAmount, onPurchase, }: FundAndPurchaseProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const FundAndPurchase: ({ carrierId, className, control, disabled, isFundingEnabled, isFundingRequired, onSave, purchaseAmount, onPurchase, }: FundAndPurchaseProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/address-form/address-fields.styles.d.ts

@@ -0,0 +1 @@
+export declare const styles: Record<"grow" | "stateWrapper" | "stateZipWrapper" | "zipWrapper", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;

package/components/templates/index.d.ts

@@ -19,3 +19,5 @@ export * from "./suspend-shipment";
 export * from "./warehouse-form";
 export * from "./void-label";
 export * from "./wallet-form";
+export * from "./warehouse-preference-wizard";
+export * from "./warehouse-preference-select";

package/components/templates/manage-warehouses/manage-warehouse.styles.d.ts

@@ -0,0 +1 @@
+export declare const styles: Record<"cardSpacing" | "header" | "well", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;

package/components/templates/manage-warehouses/manage-warehouses.d.ts

@@ -1,10 +1,15 @@
 import { SE } from "@shipengine/api";
+import { WarehousePreference } from "../warehouse-preference-wizard";
+export type WarehousePayload = Partial<SE.Warehouse> & Pick<SE.Warehouse, "name" | "originAddress" | "isDefault">;
 export type ManageWarehousesProps = {
     errors?: SE.CodedError[];
-    onAdd: (payload: Omit<SE.Warehouse, "createdAt" | "warehouseId">) => Promise<void> | void;
-    onDelete: (warehouseId: string) => Promise<void> | void;
-    onEdit: (payload: Omit<SE.Warehouse, "createdAt" | "warehouseId">, warehouseId: string) => Promise<void> | void;
-    onSetDefault: (warehouse: Partial<SE.Warehouse>, warehouseId: string) => Promise<void> | void;
+    onAdd: (payload: WarehousePayload) => Promise<void>;
+    onDelete: (warehouseId: string) => Promise<void>;
+    onEdit: (payload: WarehousePayload, warehouseId: string) => Promise<void>;
+    onSetDefault: (warehouse: Partial<SE.Warehouse>, warehouseId: string) => Promise<void>;
+    onValidate: (warehouse: WarehousePayload) => Promise<WarehousePreference>;
+    setWarehousePreference: (warehousePreference?: WarehousePreference) => void;
+    warehousePreference?: WarehousePreference;
     warehouses: SE.Warehouse[];
 };
-export declare const ManageWarehouses: ({ errors, onAdd, onDelete, onEdit, onSetDefault, warehouses, }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ManageWarehouses: ({ errors, onAdd, onDelete, onEdit, onSetDefault, onValidate, setWarehousePreference, warehousePreference, warehouses, }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/onboarding/onboarding.d.ts

@@ -1,9 +1,8 @@
 import { SE } from "@shipengine/api";
+import { Templates } from "../../../components";
 export type OnboardingProps = {
     carriers: SE.Carrier[];
     createWarehouse: (payload: Partial<SE.Warehouse>) => Promise<SE.Warehouse>;
-    isLoadingDhl: boolean;
-    isLoadingUps: boolean;
     onCarrierCreated: () => Promise<void>;
     onCompleteOnboarding: () => void;
     onWarehouseCreated: () => Promise<void>;
@@ -15,4 +14,4 @@ export type OnboardingProps = {
     registerUpsCarrierErrors: SE.CodedError[] | null;
     warehouses: SE.Warehouse[];
 };
-export declare const Onboarding: ({ carriers, createWarehouse, onCarrierCreated, onWarehouseCreated, isLoadingDhl, isLoadingUps, onCompleteOnboarding, registerDhlCarrier, registerDhlCarrierErrors, registerStampsCarrier, registerStampsCarrierErrors, registerUpsCarrier, registerUpsCarrierErrors, warehouses, }: OnboardingProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Onboarding: ({ carriers, createWarehouse, onCarrierCreated, onWarehouseCreated, onCompleteOnboarding, registerDhlCarrier, registerDhlCarrierErrors, registerStampsCarrier, registerStampsCarrierErrors, registerUpsCarrier, registerUpsCarrierErrors, warehouses, }: OnboardingProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/onboarding/onboarding.styles.d.ts

@@ -1 +1 @@
-export declare const styles: Record<"lastStep" | "step", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;
+export declare const styles: Record<"step" | "wrapper", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;

package/components/templates/rate-form/rate-form.d.ts

@@ -1,5 +1,6 @@
 import { SE } from "@shipengine/api";
 export type RateFormFeatures = {
+    enableFunding?: boolean;
     enableGlobalPostFiltering?: boolean;
     includeRecommendedRates?: boolean;
     nicknameRate?: boolean;

package/components/templates/shipment-form/shipment-schema.d.ts

@@ -194,7 +194,7 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
     }>>>;
     shipDate: z.ZodString;
     shipmentId: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
-    warehouseId: z.ZodEffects<z.ZodString, string, string>;
+    warehouseId: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 }, {
     __mode: z.ZodLiteral<"browse_rates">;
 }>, "strip", z.ZodTypeAny, {
@@ -471,7 +471,7 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
     }>>>;
     shipDate: z.ZodString;
     shipmentId: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
-    warehouseId: z.ZodEffects<z.ZodString, string, string>;
+    warehouseId: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
 }, {
     __mode: z.ZodLiteral<"select_service">;
     packages: z.ZodArray<z.ZodObject<z.extendShape<{

package/components/templates/wallet-form/wallet-schema.d.ts

@@ -197,24 +197,21 @@ export declare const walletSchema: z.ZodObject<{
     }>;
     creditCard: z.ZodEffects<z.ZodObject<{
         cvv: z.ZodEffects<z.ZodString, string, string>;
-        expirationMonth: z.ZodEnum<["01", "02", "03", "04", "05", "06", "07", "08", "09", "10", "11", "12"]>;
-        expirationYear: z.ZodEffects<z.ZodString, string, string>;
+        expiration: z.ZodEffects<z.ZodString, string, string>;
         name: z.ZodString;
         number: z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>;
     }, "strip", z.ZodTypeAny, {
         number: string;
         name: string;
         cvv: string;
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
-        expirationYear: string;
+        expiration: string;
     }, {
         number: string;
         name: string;
         cvv: string;
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
-        expirationYear: string;
+        expiration: string;
     }>, {
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
+        expirationMonth: string;
         expirationYear: string;
         name: string;
         number: string;
@@ -223,8 +220,7 @@ export declare const walletSchema: z.ZodObject<{
         number: string;
         name: string;
         cvv: string;
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
-        expirationYear: string;
+        expiration: string;
     }>;
 }, "strip", z.ZodTypeAny, {
     address: {
@@ -239,7 +235,7 @@ export declare const walletSchema: z.ZodObject<{
         stateProvince: string;
     };
     creditCard: {
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
+        expirationMonth: string;
         expirationYear: string;
         name: string;
         number: string;
@@ -261,8 +257,7 @@ export declare const walletSchema: z.ZodObject<{
         number: string;
         name: string;
         cvv: string;
-        expirationMonth: "01" | "02" | "03" | "04" | "05" | "06" | "07" | "08" | "09" | "10" | "11" | "12";
-        expirationYear: string;
+        expiration: string;
     };
 }>;
 export type WalletFormFields = z.input<typeof walletSchema>;

package/components/templates/warehouse-form/warehouse-form-schema.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-export declare const warehouseSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"returnToAddressIsDifferent", z.Primitive, z.ZodObject<{
+export declare const warehouseSchema: z.ZodDiscriminatedUnion<"returnToAddressIsDifferent", z.Primitive, z.ZodObject<{
     isDefault: z.ZodBoolean;
     name: z.ZodString;
     originAddress: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<z.extendShape<{
@@ -398,106 +398,6 @@ export declare const warehouseSchema: z.ZodEffects<z.ZodDiscriminatedUnion<"retu
         name: string;
         postalCode: string;
     };
-}>>, {
-    name: string;
-    returnToAddressIsDifferent: true;
-    isDefault: boolean;
-    originAddress: {
-        addressLine2?: string | undefined;
-        companyName?: string | undefined;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        phone: string;
-        postalCode: string;
-        stateProvince: string;
-        addressResidentialIndicator: "yes" | "no";
-    };
-    returnAddress: {
-        addressLine2?: string | undefined;
-        companyName?: string | undefined;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        phone: string;
-        postalCode: string;
-        stateProvince: string;
-        addressResidentialIndicator: "yes" | "no";
-    };
-} | {
-    returnAddress: {
-        addressLine2?: string | undefined;
-        companyName?: string | undefined;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        phone: string;
-        postalCode: string;
-        stateProvince: string;
-        addressResidentialIndicator: "yes" | "no";
-    };
-    name: string;
-    returnToAddressIsDifferent: false;
-    isDefault: boolean;
-    originAddress: {
-        addressLine2?: string | undefined;
-        companyName?: string | undefined;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        phone: string;
-        postalCode: string;
-        stateProvince: string;
-        addressResidentialIndicator: "yes" | "no";
-    };
-}, {
-    name: string;
-    returnToAddressIsDifferent: true;
-    isDefault: boolean;
-    originAddress: {
-        addressLine2?: string | null | undefined;
-        companyName?: string | null | undefined;
-        phone?: string | null | undefined;
-        stateProvince?: string | null | undefined;
-        addressResidentialIndicator?: unknown;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        postalCode: string;
-    };
-    returnAddress: {
-        addressLine2?: string | null | undefined;
-        companyName?: string | null | undefined;
-        phone?: string | null | undefined;
-        stateProvince?: string | null | undefined;
-        addressResidentialIndicator?: unknown;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        postalCode: string;
-    };
-} | {
-    name: string;
-    returnToAddressIsDifferent: false;
-    isDefault: boolean;
-    originAddress: {
-        addressLine2?: string | null | undefined;
-        companyName?: string | null | undefined;
-        phone?: string | null | undefined;
-        stateProvince?: string | null | undefined;
-        addressResidentialIndicator?: unknown;
-        addressLine1: string;
-        cityLocality: string;
-        countryCode: "AF" | "AX" | "AL" | "DZ" | "AS" | "AD" | "AO" | "AI" | "AQ" | "AG" | "AR" | "AM" | "AW" | "AU" | "AT" | "AZ" | "BS" | "BH" | "BD" | "BB" | "BY" | "BE" | "BZ" | "BJ" | "BM" | "BT" | "BO" | "BQ" | "BA" | "BW" | "BR" | "IO" | "VG" | "BN" | "BG" | "BF" | "BI" | "CA" | "KH" | "CM" | "CV" | "KY" | "CF" | "TD" | "CL" | "CN" | "CX" | "CC" | "CO" | "KM" | "CG" | "CD" | "CK" | "CR" | "HR" | "CU" | "CW" | "CY" | "CZ" | "DK" | "DJ" | "DM" | "DO" | "EC" | "EG" | "SV" | "GQ" | "ER" | "EE" | "ET" | "FK" | "FO" | "FM" | "FJ" | "FI" | "FR" | "GF" | "PF" | "TF" | "GA" | "GM" | "GE" | "DE" | "GH" | "GI" | "GR" | "GL" | "GD" | "GP" | "GU" | "GT" | "GG" | "GN" | "GW" | "GY" | "HT" | "VA" | "HN" | "HK" | "HU" | "IS" | "IN" | "ID" | "IR" | "IQ" | "IE" | "IM" | "IL" | "IT" | "CI" | "JM" | "JP" | "JE" | "JO" | "KZ" | "KE" | "KI" | "KR" | "KW" | "KG" | "LA" | "LV" | "LB" | "LS" | "LR" | "LY" | "LI" | "LT" | "LU" | "MO" | "MK" | "MG" | "MW" | "MY" | "MV" | "ML" | "MT" | "MH" | "MQ" | "MR" | "MU" | "YT" | "MX" | "MD" | "MC" | "MN" | "ME" | "MS" | "MA" | "MZ" | "MM" | "NA" | "NR" | "NP" | "NL" | "AN" | "NC" | "NZ" | "NI" | "NE" | "NG" | "NU" | "NF" | "KP" | "MP" | "NO" | "OM" | "PK" | "PW" | "PS" | "PA" | "PG" | "PY" | "PE" | "PH" | "PN" | "PL" | "PT" | "PR" | "QA" | "RE" | "RO" | "RU" | "RW" | "BL" | "SH" | "KN" | "LC" | "MF" | "PM" | "VC" | "WS" | "SM" | "ST" | "SA" | "SN" | "RS" | "SC" | "SL" | "SG" | "SX" | "SK" | "SI" | "SB" | "SO" | "ZA" | "GS" | "SS" | "ES" | "LK" | "SD" | "SR" | "SJ" | "SZ" | "SE" | "CH" | "SY" | "TW" | "TJ" | "TZ" | "TH" | "TL" | "TG" | "TK" | "TO" | "TT" | "TN" | "TR" | "TM" | "TC" | "TV" | "UG" | "UA" | "AE" | "GB" | "VI" | "UM" | "US" | "UY" | "UZ" | "VU" | "VE" | "VN" | "WF" | "EH" | "YE" | "ZM" | "ZW";
-        name: string;
-        postalCode: string;
-    };
-}>;
+}>>;
 export type WarehouseFormFields = z.input<typeof warehouseSchema>;
 export type WarehouseFormPayload = z.output<typeof warehouseSchema>;

package/components/templates/warehouse-form/warehouse-form.d.ts

@@ -1,9 +1,10 @@
 import { SE } from "@shipengine/api";
+import { WarehousePayload } from "../manage-warehouses";
 export type WarehouseFormProps = {
     isOnboarding?: boolean;
     onCancel?: () => void;
     onDelete?: () => void;
-    onSubmit: (payload: Omit<SE.Warehouse, "createdAt" | "warehouseId">) => void;
+    onSubmit: (payload: WarehousePayload) => void;
     submitButtonTitle: string;
     warehouse?: SE.Warehouse;
 };

package/components/templates/warehouse-preference-select/index.d.ts

@@ -0,0 +1 @@
+export * from "./warehouse-preference-select";

package/components/templates/warehouse-preference-select/warehouse-preference-select.d.ts

@@ -0,0 +1,24 @@
+import { SE } from "@shipengine/api";
+export type WarehouseSuggested = {
+    validation: SE.AddressValidation;
+    validationType: "SUGGESTED";
+};
+export type WarehouseError = {
+    validation: SE.AddressValidation;
+    validationType: "ERROR";
+};
+export type WarehouseExactOrSoft = {
+    address: SE.Address;
+    validationType: "EXACT" | "SOFT";
+};
+export type WarehouseAddressPreference = WarehouseSuggested | WarehouseError | WarehouseExactOrSoft;
+export type WarehousePreferenceFormProps = {
+    onCancel: () => void;
+    onSubmit: (payload: {
+        originAddress: SE.Address;
+        returnAddress?: SE.Address;
+    }) => Promise<void> | void;
+    originAddress: WarehouseAddressPreference;
+    returnAddress?: WarehouseAddressPreference;
+};
+export declare const WarehousePreferenceSelect: ({ onCancel, onSubmit, originAddress, returnAddress, }: WarehousePreferenceFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/warehouse-preference-wizard/index.d.ts

@@ -0,0 +1 @@
+export * from "./warehouse-preference-wizard";

package/components/templates/warehouse-preference-wizard/warehouse-preference-wizard.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/api";
+import { ManageWarehousesProps, WarehousePayload } from "../manage-warehouses";
+import { WarehouseAddressPreference } from "../warehouse-preference-select";
+export type WarehousePreference = {
+    isDefault?: boolean;
+    name: string;
+    originAddress: WarehouseAddressPreference;
+    returnAddress?: WarehouseAddressPreference;
+};
+export type WarehousePreferenceWizardProps = {
+    className?: string;
+    formHeader?: React.ReactNode;
+    isOnboarding?: boolean;
+    onSubmit: (payload: WarehousePayload) => Promise<void> | void;
+    onValidate: ManageWarehousesProps["onValidate"];
+    onWarehouseDelete?: () => Promise<void> | void;
+    onWarehouseFormCancel?: () => void;
+    submitButtonTitle: string;
+    warehouse?: SE.Warehouse;
+    warehousePreference?: WarehousePreference;
+};
+export declare const WarehousePreferenceWizard: ({ className, formHeader, isOnboarding, onSubmit, onValidate, onWarehouseDelete, onWarehouseFormCancel, submitButtonTitle, warehouse, warehousePreference, }: WarehousePreferenceWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/components/manage-warehouses/manage-warehouses.d.ts

@@ -1,2 +1,5 @@
-export type ManageWarehousesProps = {};
-export declare const ManageWarehouses: () => import("@emotion/react/jsx-runtime").JSX.Element;
+import { Templates } from "../../../components";
+export type ManageWarehousesProps = {
+    onWarehouseAddressValidation?: (originAddressPreference: Templates.AddressPreference, returnAddressPreference?: Templates.AddressPreference) => Promise<void> | void;
+};
+export declare const ManageWarehouses: ({ onWarehouseAddressValidation }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/manage-warehouses.d.ts

@@ -1 +1 @@
-export declare const Element: (props: Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: (props: import("./components/manage-warehouses").ManageWarehousesProps & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/factories/shipengine/warehouse.d.ts

@@ -1,6 +1,8 @@
 import { Factory } from "fishery";
 import { SE } from "@shipengine/api";
+import { Templates } from "../../components";
 /**
  * @category Factories
  */
 export declare const warehouseFactory: Factory<SE.Warehouse, any, SE.Warehouse>;
+export declare const warehouseAddressPreferenceFactory: Factory<Templates.WarehouseAddressPreference, any, Templates.WarehouseAddressPreference>;

package/hooks/index.d.ts

@@ -6,3 +6,4 @@ export * from "./use-page-layout";
 export * from "./use-root-portal";
 export * from "./use-run-once-on-true";
 export * from "./use-toggle";
+export * from "./use-warehouse-validation";

package/hooks/use-warehouse-validation.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/api";
+import { Templates } from "../components";
+export declare const useWarehouseValidation: () => {
+    errors: SE.CodedError[] | null;
+    setWarehousePreference: import("react").Dispatch<import("react").SetStateAction<Templates.WarehousePreference | undefined>>;
+    validate: (warehouse: Partial<SE.Warehouse> & Pick<SE.Warehouse, "name" | "originAddress" | "isDefault">) => Promise<{
+        isDefault: boolean;
+        name: string;
+        originAddress: Templates.WarehouseAddressPreference;
+        returnAddress: Templates.WarehouseAddressPreference;
+    }>;
+    warehousePreference: Templates.WarehousePreference | undefined;
+};