@shipengine/elements 0.33.0 → 0.35.0

package/src/components/spacer/spacer.d.ts

@@ -1,6 +1,36 @@
 import { Theme } from "@packlink/giger-theme";
+/**
+ * @internal
+ *
+ * # Spacer Component Props
+ *
+ * - These are the base props that will be passed into the `<Spacer />` component, and you can
+ * specify the breakpoint you would like the spacer to be visible on, as well as the multiplier
+ * you would like to use for the spacing.
+ *
+ * @see {@link Spacer | The `<Spacer />` component that uses these props}
+ *
+ */
 export type SpacerProps = {
+    /**
+     * `displayOn` is the breakpoint you would like the spacer to be visible on.
+     */
     displayOn?: keyof Theme["breakPoints"];
+    /**
+     * `multiplier` is the number you would like to multiply the base theme spacing by.
+     */
     multiplier?: number;
 };
+/**
+ * @internal
+ *
+ * # Spacer Composition Component
+ *
+ * - The `Spacer` is a composition component used to create a space between elements
+ * in the UI.
+ *
+ * @see {@link Spacer.SpacerProps | The props necessary to render the `<Spacer />` component}
+ * @see {@link Spacer.getSpacerStyles | The util function that generates the styles for the `<Spacer />` component}
+ *
+ */
 export declare const Spacer: (props: SpacerProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/spread/spread.d.ts

@@ -1,5 +1,15 @@
 /// <reference types="react" />
+/**
+ * @internal
+ *
+ * # Spread Props
+ */
 export type SpreadProps = {
     children: [React.ReactNode, React.ReactNode];
 };
+/**
+ * @internal
+ *
+ * # Spread Component
+ */
 export declare const Spread: ({ children }: SpreadProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/story-notes/story-notes.d.ts

@@ -1,10 +1,19 @@
 /// <reference types="react" />
+/**
+ * @internal
+ *
+ * # Story Notes Props
+ */
 export type StoryNotesProps = {
     children: React.ReactNode;
     notes: string[];
 };
 /**
- * For relevant notes about Storybook stories
+ * @internal
+ *
+ * # Story Notes Component
+ *
+ * - For relevant notes about Storybook stories
  *
  * Stopgap until we setup https://storybook.js.org/addons/@storybook/addon-docs
  */

package/src/components/templates/carrier-terms-form/carrier-terms-form.styles.d.ts

@@ -47,6 +47,7 @@ export declare const styles: {
         flexDirection: "column";
         paddingBottom: number;
         paddingTop: number;
+        textAlign: "center";
     };
     termsLink: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
         alignItems: "center";

package/src/components/templates/landing-page/landing-page.d.ts

@@ -1,4 +1,5 @@
 export type LandingPageProps = {
     onSubmit: (payload: string) => void;
+    partnerName?: string;
 };
-export declare const LandingPage: ({ onSubmit }: LandingPageProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const LandingPage: ({ onSubmit, partnerName }: LandingPageProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -30,12 +30,14 @@ export type OnboardingProps = {
     features?: OnboardingFeatures;
     fundingSources?: SE.FundingSource[];
     isRegisteringCarriers?: boolean;
+    onboardingAddress?: Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
     onCarrierCreated: () => Promise<void>;
     onCompleteOnboarding: () => void;
     onFundingSourceCreated: () => Promise<void>;
     onWarehouseCreated: () => Promise<void>;
+    partnerName?: string;
     registerCarrier: (payload: SE.CarrierRegistration) => Promise<SE.CarrierRegistrationResponse>;
     registerCarrierErrors: SE.CodedError[] | null;
     warehouses: SE.Warehouse[];
 };
-export declare const Onboarding: ({ connectedCarriers, createWarehouse, features, fundingSources, isRegisteringCarriers, onCarrierCreated, onCompleteOnboarding, onFundingSourceCreated, onWarehouseCreated, registerCarrier, registerCarrierErrors, createFundingSource, createFundingSourceErrors, warehouses, }: OnboardingProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Onboarding: ({ connectedCarriers, createFundingSource, createFundingSourceErrors, createWarehouse, features, fundingSources, isRegisteringCarriers, onboardingAddress, onCarrierCreated, onCompleteOnboarding, onFundingSourceCreated, onWarehouseCreated, partnerName, registerCarrier, registerCarrierErrors, warehouses, }: OnboardingProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -2,11 +2,21 @@ export declare const styles: {
     container: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
         padding: number;
     };
+    iconTooltip: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
+        color: string;
+        display: "inline-block";
+        marginLeft: number;
+        verticalAlign: string;
+    };
     step: {
         "& > span:last-child": {
             position: "static";
         };
     };
+    tooltipContainer: () => {
+        maxWidth: string;
+        textAlign: "left";
+    };
     walletFormHeader: (theme: import("@packlink/giger-theme/dist/lib/Theme").Theme) => {
         margin: number;
     };

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

@@ -3,8 +3,8 @@ import { ConfigureShipmentFeatures } from "../../../elements/configure-shipment"
 export type RateFormProps = {
     carriers?: SE.Carrier[];
     disabled?: boolean;
-    displayableErrors?: string[];
     displayableLabelErrors?: string[];
+    displayableRateErrors?: string[];
     errors?: SE.CodedError[];
     features?: ConfigureShipmentFeatures;
     isLoading?: boolean;
@@ -18,4 +18,4 @@ export type RateFormProps = {
     rates?: SE.Rate[];
     shipment?: SE.SalesOrderShipment;
 };
-export declare const RateForm: ({ carriers, disabled, errors, displayableErrors, displayableLabelErrors, features, labelErrors, labels, labelsLoading, isLoading, onSave, onSelectRate, onSubmit, rates, shipment, outOfBandDisplayableErrors, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const RateForm: ({ carriers, disabled, errors, displayableRateErrors, displayableLabelErrors, features, labelErrors, labels, labelsLoading, isLoading, onSave, onSelectRate, onSubmit, rates, shipment, outOfBandDisplayableErrors, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -9,6 +9,7 @@ export type OnChangeAddressOptions = {
 };
 export type ShipmentFormMode = "browse_rates" | "select_service";
 export type ShipmentFormProps = {
+    accountSettings?: SE.AccountSettings;
     addressLoading: boolean;
     addressPreference?: AddressPreference;
     carriers?: SE.Carrier[];
@@ -51,4 +52,4 @@ export type ShipmentFormFeatures = {
     selectService?: boolean;
     shippingPresets?: boolean;
 };
-export declare const ShipmentForm: ({ addressLoading, addressPreference, charsetWarning, carriers, customPackageTypes, errors, features, hydrateRef, insuranceAccount, isLoading, onApplyPreset, onChangeAddress, onChangeMode, onDirty, onSubmit, onSubmitParseShipTo, onToggleAddressPreferenceDisclosure, onUpdateCustoms, parseAddressErrors, resetParseAddress, salesOrder, shipment, shippingPresets, warehouseId, warehouses, }: ShipmentFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ShipmentForm: ({ accountSettings, addressLoading, addressPreference, charsetWarning, carriers, customPackageTypes, errors, features, hydrateRef, insuranceAccount, isLoading, onApplyPreset, onChangeAddress, onChangeMode, onDirty, onSubmit, onSubmitParseShipTo, onToggleAddressPreferenceDisclosure, onUpdateCustoms, parseAddressErrors, resetParseAddress, salesOrder, shipment, shippingPresets, warehouseId, warehouses, }: ShipmentFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -2,12 +2,14 @@ import { z } from "zod";
 import { SE } from "@shipengine/alchemy";
 type GetShipmentSchemaOptions = {
     allowInternationalShipFrom?: boolean;
+    dimensionsUnit?: SE.DimensionUnit;
     isContentDescriptionRequired?: boolean;
     isCustomsRequired?: boolean;
     requireMeasurements?: boolean;
     warehouses?: SE.Warehouse[];
+    weightUnit?: SE.WeightUnit;
 };
-export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouses, requireMeasurements, isContentDescriptionRequired, isCustomsRequired, }?: GetShipmentSchemaOptions) => z.ZodEffects<z.ZodDiscriminatedUnion<"__mode", z.Primitive, z.ZodObject<z.extendShape<{
+export declare const getShipmentSchema: ({ allowInternationalShipFrom, dimensionsUnit, isContentDescriptionRequired, isCustomsRequired, requireMeasurements, warehouses, weightUnit, }?: GetShipmentSchemaOptions) => z.ZodEffects<z.ZodDiscriminatedUnion<"__mode", z.Primitive, z.ZodObject<z.extendShape<{
     advancedOptions: z.ZodOptional<z.ZodObject<{
         additionalHandling: z.ZodOptional<z.ZodBoolean>;
     }, "strip", z.ZodTypeAny, {
@@ -80,7 +82,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
-        }>>>, SE.DimensionsWithUnit | undefined, {
+        }>>>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
@@ -96,7 +108,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length: number;
             height: number;
             width: number;
-        }>, SE.DimensionsWithUnit | undefined, {
+        }>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length: number;
             height: number;
             width: number;
@@ -156,7 +178,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
         }>;
     }, "strip", z.ZodTypeAny, {
         contentDescription?: string | null | undefined;
-        dimensions?: SE.DimensionsWithUnit | undefined;
+        dimensions?: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         insuredValue?: {
             amount: number;
             currency: SE.Currency;
@@ -235,7 +267,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
     insuranceProvider: SE.InsuranceProviderType;
     packages: {
         contentDescription?: string | null | undefined;
-        dimensions?: SE.DimensionsWithUnit | undefined;
+        dimensions?: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         insuredValue?: {
             amount: number;
             currency: SE.Currency;
@@ -375,7 +417,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
-        }>>>, SE.DimensionsWithUnit | undefined, {
+        }>>>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
@@ -391,7 +443,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length: number;
             height: number;
             width: number;
-        }>, SE.DimensionsWithUnit | undefined, {
+        }>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length: number;
             height: number;
             width: number;
@@ -451,7 +513,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
         }>;
     }, "strip", z.ZodTypeAny, {
         contentDescription?: string | null | undefined;
-        dimensions?: SE.DimensionsWithUnit | undefined;
+        dimensions?: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         insuredValue?: {
             amount: number;
             currency: SE.Currency;
@@ -517,7 +589,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
-        }>>>, SE.DimensionsWithUnit | undefined, {
+        }>>>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
@@ -533,7 +615,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length: number;
             height: number;
             width: number;
-        }>, SE.DimensionsWithUnit | undefined, {
+        }>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length: number;
             height: number;
             width: number;
@@ -612,14 +704,34 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
-        }>>>, SE.DimensionsWithUnit | undefined, {
+        }>>>, {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined, {
             length?: number | null | undefined;
             height?: number | null | undefined;
             width?: number | null | undefined;
         } | null | undefined>;
     }>, "strip", z.ZodTypeAny, {
         contentDescription?: string | null | undefined;
-        dimensions?: SE.DimensionsWithUnit | undefined;
+        dimensions?: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         insuredValue?: {
             amount: number;
             currency: SE.Currency;
@@ -685,7 +797,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
     insuranceProvider: SE.InsuranceProviderType;
     packages: {
         contentDescription?: string | null | undefined;
-        dimensions?: SE.DimensionsWithUnit | undefined;
+        dimensions?: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         insuredValue?: {
             amount: number;
             currency: SE.Currency;
@@ -767,7 +889,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
         nonDelivery: SE.CustomsNonDeliveryType;
     } | null | undefined;
     packages: ({
-        dimensions: SE.DimensionsWithUnit | undefined;
+        dimensions: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         packageCode: string | null | undefined;
         weight?: {
             unit: string;
@@ -790,7 +922,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             currency: SE.Currency;
         } | undefined;
     } | {
-        dimensions: SE.DimensionsWithUnit | undefined;
+        dimensions: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         packageCode: string | null | undefined;
         weight?: {
             unit: string;
@@ -838,7 +980,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
         nonDelivery: SE.CustomsNonDeliveryType;
     } | null | undefined;
     packages: ({
-        dimensions: SE.DimensionsWithUnit | undefined;
+        dimensions: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         packageCode: string | null | undefined;
         weight?: {
             unit: string;
@@ -861,7 +1013,17 @@ export declare const getShipmentSchema: ({ allowInternationalShipFrom, warehouse
             currency: SE.Currency;
         } | undefined;
     } | {
-        dimensions: SE.DimensionsWithUnit | undefined;
+        dimensions: {
+            unit: SE.DimensionUnit;
+            girth?: number | undefined;
+            height: number;
+            length: number;
+            lengthPlusGirth?: number | undefined;
+            noThreeSidesExceed?: number | undefined;
+            noTwoSidesExceed?: number | undefined;
+            volume?: number | undefined;
+            width: number;
+        } | undefined;
         packageCode: string | null | undefined;
         weight?: {
             unit: string;

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

@@ -6,6 +6,6 @@ export type WarehouseFormProps = {
     onDelete?: () => void;
     onSubmit: (payload: WarehousePayload) => void;
     submitButtonTitle: string;
-    warehouse?: SE.Warehouse;
+    warehouse?: SE.Warehouse | Pick<SE.Warehouse, "name" | "isDefault" | "originAddress" | "returnAddress">;
 };
 export declare const WarehouseForm: ({ isOnboarding, onCancel, onDelete, onSubmit, submitButtonTitle, warehouse, }: WarehouseFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/unit-settings/unit-settings.d.ts

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

package/src/constants/shipengine/address.d.ts

@@ -1,3 +1,8 @@
+/**
+ * @internal
+ *
+ * # Address Utils - CountryRules Utility Type
+ */
 export type CountryRules = {
     hasEuCustomsRules?: boolean;
     hasProvinces?: boolean;
@@ -5,6 +10,11 @@ export type CountryRules = {
     isUnsupportedByUps?: boolean;
     supportsByoa?: boolean;
 };
+/**
+ * @internal
+ *
+ * # Address Utils - Country Type
+ */
 export declare class Country<T extends string, U extends string> {
     name: T;
     code: U;
@@ -15,15 +25,50 @@ export declare class Country<T extends string, U extends string> {
     isUnsupportedByUps: boolean;
     constructor(name: T, code: U, rules?: CountryRules);
 }
+/**
+ * @internal
+ *
+ * # Address Utils - Array of Countries and their codes
+ */
 export declare const countries: readonly [Country<"Afghanistan", "AF">, Country<"Aland Islands", "AX">, Country<"Albania", "AL">, Country<"Algeria", "DZ">, Country<"American Samoa", "AS">, Country<"Andorra", "AD">, Country<"Angola", "AO">, Country<"Anguilla", "AI">, Country<"Antarctica", "AQ">, Country<"Antigua Barbuda", "AG">, Country<"Argentina", "AR">, Country<"Armenia", "AM">, Country<"Aruba", "AW">, Country<"Australia", "AU">, Country<"Austria", "AT">, Country<"Azerbaijan", "AZ">, Country<"Bahamas", "BS">, Country<"Bahrain", "BH">, Country<"Bangladesh", "BD">, Country<"Barbados", "BB">, Country<"Belarus", "BY">, Country<"Belgium", "BE">, Country<"Belize", "BZ">, Country<"Benin", "BJ">, Country<"Bermuda", "BM">, Country<"Bhutan", "BT">, Country<"Bolivia", "BO">, Country<"Bonaire, Sint Eustatius And Saba", "BQ">, Country<"Bosnia and Herzegovina", "BA">, Country<"Botswana", "BW">, Country<"Brazil", "BR">, Country<"British Indian Ocean Territory", "IO">, Country<"British Virgin Islands", "VG">, Country<"Brunei Darussalam", "BN">, Country<"Bulgaria", "BG">, Country<"Burkina Faso", "BF">, Country<"Burundi", "BI">, Country<"Canada", "CA">, Country<"Cambodia", "KH">, Country<"Cameroon", "CM">, Country<"Cape Verde Islands", "CV">, Country<"Cayman Islands", "KY">, Country<"Central African Republic", "CF">, Country<"Chad", "TD">, Country<"Chile", "CL">, Country<"China", "CN">, Country<"Christmas Island", "CX">, Country<"Cocos(Keeling) Islands", "CC">, Country<"Colombia", "CO">, Country<"Comoros", "KM">, Country<"Congo", "CG">, Country<"Congo, The Democratic Republic of", "CD">, Country<"Cook Islands", "CK">, Country<"Costa Rica", "CR">, Country<"Croatia", "HR">, Country<"Cuba", "CU">, Country<"Curacao", "CW">, Country<"Cyprus", "CY">, Country<"Czech Republic", "CZ">, Country<"Denmark", "DK">, Country<"Djibouti", "DJ">, Country<"Dominica", "DM">, Country<"Dominican Republic", "DO">, Country<"Ecuador", "EC">, Country<"Egypt", "EG">, Country<"El Salvador", "SV">, Country<"Equatorial Guinea", "GQ">, Country<"Eritrea", "ER">, Country<"Estonia", "EE">, Country<"Ethiopia", "ET">, Country<"Falkland Islands", "FK">, Country<"Faroe Islands", "FO">, Country<"Federated States of Micronesia", "FM">, Country<"Fiji", "FJ">, Country<"Finland", "FI">, Country<"France", "FR">, Country<"French Guiana", "GF">, Country<"French Polynesia", "PF">, Country<"French Southern Territories", "TF">, Country<"Gabon", "GA">, Country<"Gambia", "GM">, Country<"Georgia", "GE">, Country<"Germany", "DE">, Country<"Ghana", "GH">, Country<"Gibraltar", "GI">, Country<"Greece", "GR">, Country<"Greenland", "GL">, Country<"Grenada", "GD">, Country<"Guadeloupe", "GP">, Country<"Guam", "GU">, Country<"Guatemala", "GT">, Country<"Guernsey", "GG">, Country<"Guinea", "GN">, Country<"Guinea - Bissau", "GW">, Country<"Guyana", "GY">, Country<"Haiti", "HT">, Country<"Holy See", "VA">, Country<"Honduras", "HN">, Country<"Hong Kong", "HK">, Country<"Hungary", "HU">, Country<"Iceland", "IS">, Country<"India", "IN">, Country<"Indonesia", "ID">, Country<"Iran", "IR">, Country<"Iraq", "IQ">, Country<"Ireland", "IE">, Country<"Isle of Man", "IM">, Country<"Israel", "IL">, Country<"Italy", "IT">, Country<"Ivory Coast", "CI">, Country<"Jamaica", "JM">, Country<"Japan", "JP">, Country<"Jersey", "JE">, Country<"Jordan", "JO">, Country<"Kazakhstan", "KZ">, Country<"Kenya", "KE">, Country<"Kiribati", "KI">, Country<"Korea, Republic of", "KR">, Country<"Kuwait", "KW">, Country<"Kyrgyzstan", "KG">, Country<"Laos", "LA">, Country<"Latvia", "LV">, Country<"Lebanon", "LB">, Country<"Lesotho", "LS">, Country<"Liberia", "LR">, Country<"Libya", "LY">, Country<"Liechtenstein", "LI">, Country<"Lithuania", "LT">, Country<"Luxembourg", "LU">, Country<"Macao", "MO">, Country<"Macedonia", "MK">, Country<"Madagascar", "MG">, Country<"Malawi", "MW">, Country<"Malaysia", "MY">, Country<"Maldives", "MV">, Country<"Mali", "ML">, Country<"Malta", "MT">, Country<"Marshall Islands", "MH">, Country<"Martinique", "MQ">, Country<"Mauritania", "MR">, Country<"Mauritius0", "MU">, Country<"Mayotte", "YT">, Country<"Mexico", "MX">, Country<"Moldova", "MD">, Country<"Monaco", "MC">, Country<"Mongolia", "MN">, Country<"Montenegro", "ME">, Country<"Montserrat", "MS">, Country<"Morocco", "MA">, Country<"Mozambique", "MZ">, Country<"Myanmar", "MM">, Country<"Namibia", "NA">, Country<"Nauru", "NR">, Country<"Nepal", "NP">, Country<"Netherlands", "NL">, Country<"Netherlands Antilles", "AN">, Country<"New Caledonia", "NC">, Country<"New Zealand", "NZ">, Country<"Nicaragua", "NI">, Country<"Niger", "NE">, Country<"Nigeria", "NG">, Country<"Niue", "NU">, Country<"Norfolk Island", "NF">, Country<"North Korea", "KP">, Country<"Northern Mariana Islands", "MP">, Country<"Norway", "NO">, Country<"Oman", "OM">, Country<"Pakistan", "PK">, Country<"Palau", "PW">, Country<"Palestinian Territory", "PS">, Country<"Panama", "PA">, Country<"Papua New Guinea", "PG">, Country<"Paraguay", "PY">, Country<"Peru", "PE">, Country<"Philippines", "PH">, Country<"Pitcairn Island", "PN">, Country<"Poland", "PL">, Country<"Portugal", "PT">, Country<"Puerto Rico", "PR">, Country<"Qatar", "QA">, Country<"Reunion", "RE">, Country<"Romania", "RO">, Country<"Russia", "RU">, Country<"Rwanda", "RW">, Country<"Saint Barthelemy", "BL">, Country<"Saint Helena", "SH">, Country<"Saint Kitts and Nevis", "KN">, Country<"Saint Lucia", "LC">, Country<"Saint Martin", "MF">, Country<"Saint Pierre and Miquelon", "PM">, Country<"Saint Vincent & the Grenadines", "VC">, Country<"Samoa", "WS">, Country<"San Marino", "SM">, Country<"Sao Tome and Principe", "ST">, Country<"Saudi Arabia", "SA">, Country<"Senegal", "SN">, Country<"Serbia", "RS">, Country<"Seychelles", "SC">, Country<"Sierra Leone", "SL">, Country<"Singapore", "SG">, Country<"Sint Maarten(Dutch)", "SX">, Country<"Slovakia", "SK">, Country<"Slovenia", "SI">, Country<"Solomon Islands", "SB">, Country<"Somalia", "SO">, Country<"South Africa", "ZA">, Country<"South Georgia & the South Sandwich Islands", "GS">, Country<"South Sudan", "SS">, Country<"Spain", "ES">, Country<"Sri Lanka", "LK">, Country<"Sudan", "SD">, Country<"Suriname", "SR">, Country<"Svalbard & Jan Mayen Islands", "SJ">, Country<"Swaziland", "SZ">, Country<"Sweden", "SE">, Country<"Switzerland", "CH">, Country<"Syria", "SY">, Country<"Taiwan", "TW">, Country<"Tajikistan", "TJ">, Country<"Tanzania", "TZ">, Country<"Thailand", "TH">, Country<"Timor - Leste(formerly East Timor)", "TL">, Country<"Togo", "TG">, Country<"Tokelau", "TK">, Country<"Tonga", "TO">, Country<"Trinidad and Tobago", "TT">, Country<"Tunisia", "TN">, Country<"Turkey", "TR">, Country<"Turkmenistan", "TM">, Country<"Turks and Caicos Islands", "TC">, Country<"Tuvalu", "TV">, Country<"Uganda", "UG">, Country<"Ukraine", "UA">, Country<"United Arab Emirates", "AE">, Country<"United Kingdom", "GB">, Country<"United States Virgin Islands", "VI">, Country<"U.S. Minor Outlying Islands", "UM">, Country<"United States of America", "US">, Country<"Uruguay", "UY">, Country<"Uzbekistan", "UZ">, Country<"Vanuatu", "VU">, Country<"Venezuela", "VE">, Country<"Vietnam", "VN">, Country<"Wallis and Futuna Islands", "WF">, Country<"Western Sahara", "EH">, Country<"Yemen", "YE">, Country<"Zambia", "ZM">, Country<"Zimbabwe", "ZW">];
+/**
+ * @internal
+ *
+ * # Address Utils - Map of Country Codes
+ */
 export declare const countryCodes: ["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"];
+/**
+ * @internal
+ *
+ * # Address Utils - Country Code Type
+ */
 export type CountryCode = typeof countryCodes[number];
+/**
+ * @internal
+ *
+ * # Address Utils - EU Country Codes
+ */
 export declare const euCountryCodes: ("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")[];
+/**
+ * @internal
+ *
+ * # Address Utils - Postal Code Regex
+ */
 export declare const postalCodeRegex: RegExp;
+/**
+ * @internal
+ *
+ * # Address Utils US State Rules Utility Type
+ */
 export type UsStateRules = {
     isMilitary?: boolean;
     isUnitedStatesTerritory?: boolean;
 };
+/**
+ * @internal
+ *
+ * # Address Utils - US State Type
+ */
 export declare class UsState<T extends string, U extends string> {
     name: T;
     code: U;
@@ -31,16 +76,46 @@ export declare class UsState<T extends string, U extends string> {
     isUnitedStatesTerritory: boolean;
     constructor(name: T, code: U, rules?: UsStateRules);
 }
+/**
+ * @internal
+ *
+ * # Address Utils - Array US States and their codes
+ */
 export declare const usStates: readonly [UsState<"Alabama", "AL">, UsState<"Alaska", "AK">, UsState<"American Samoa", "AS">, UsState<"Arizona", "AZ">, UsState<"Arkansas", "AR">, UsState<"Armed Forces Americas", "AA">, UsState<"Armed Forces Europe", "AE">, UsState<"Armed Forces Pacific", "AP">, UsState<"California", "CA">, UsState<"Colorado", "CO">, UsState<"Connecticut", "CT">, UsState<"Delaware", "DE">, UsState<"District of Columbia", "DC">, UsState<"Florida", "FL">, UsState<"Georgia", "GA">, UsState<"Guam", "GU">, UsState<"Hawaii", "HI">, UsState<"Idaho", "ID">, UsState<"Illinois", "IL">, UsState<"Indiana", "IN">, UsState<"Iowa", "IA">, UsState<"Kansas", "KS">, UsState<"Kentucky", "KY">, UsState<"Louisiana", "LA">, UsState<"Maine", "ME">, UsState<"Maryland", "MD">, UsState<"Massachusetts", "MA">, UsState<"Michigan", "MI">, UsState<"Minnesota", "MN">, UsState<"Mississippi", "MS">, UsState<"Missouri", "MO">, UsState<"Montana", "MT">, UsState<"Nebraska", "NE">, UsState<"Nevada", "NV">, UsState<"New Hampshire", "NH">, UsState<"New Jersey", "NJ">, UsState<"New Mexico", "NM">, UsState<"New York", "NY">, UsState<"North Carolina", "NC">, UsState<"North Dakota", "ND">, UsState<"Ohio", "OH">, UsState<"Oklahoma", "OK">, UsState<"Oregon", "OR">, UsState<"Pennsylvania", "PA">, UsState<"Puerto Rico", "PR">, UsState<"Rhode Island", "RI">, UsState<"South Carolina", "SC">, UsState<"South Dakota", "SD">, UsState<"Tennessee", "TN">, UsState<"Texas", "TX">, UsState<"Utah", "UT">, UsState<"Vermont", "VT">, UsState<"Virgin Islands", "VI">, UsState<"Virginia", "VA">, UsState<"Washington", "WA">, UsState<"West Virginia", "WV">, UsState<"Wisconsin", "WI">, UsState<"Wyoming", "WY">, UsState<"Northern Mariana Islands", "MP">, UsState<"U.S. Minor Outlying Islands", "UM">];
+/**
+ * @internal
+ *
+ * # Address Utils - Map of US State Codes
+ */
 export declare const usStateCodes: ["AL", "AK", "AS", "AZ", "AR", "AA", "AE", "AP", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "GU", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "PR", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VI", "VA", "WA", "WV", "WI", "WY", "MP", "UM"];
+/**
+ * @internal
+ *
+ * # Address Utils - US State Codes
+ */
 export type UsStateCode = typeof usStateCodes[number];
+/**
+ * @internal
+ *
+ * # Address Utils - USA City Rules Utility Type
+ */
 export type UsaCityRules = {
     isMilitary?: boolean;
 };
+/**
+ * @internal
+ *
+ * # Address Utils - USA City Type
+ */
 export declare class UsaCity<T extends string, U extends string> {
     name: T;
     code: U;
     isMilitary: boolean;
     constructor(name: T, code: U, rules?: UsaCityRules);
 }
+/**
+ * @internal
+ *
+ * # Address Utils - US Cities
+ */
 export declare const usCities: readonly [UsaCity<"Army Post Office", "APO">, UsaCity<"Diplomatic Post Office", "DPO">, UsaCity<"Fleet Post Office", "FPO">];