@shipengine/elements 0.34.0 → 0.36.0

package/src/elements/void-label/void-label.d.ts

@@ -1,17 +1,100 @@
 /// <reference types="react" />
 import { SE } from "@shipengine/alchemy";
+/**
+ * # Void Label Component Props
+ *
+ * - These are the base props that will be passed into the `<VoidLabel />` component.
+ *
+ * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
+ */
 export type ComponentProps = {
+    /**
+     * `features` is a set of feature flags you would like to enable or disable in this component.
+     */
     features?: {
         presentation?: {
             poweredByShipEngine?: boolean;
         };
     };
+    /**
+     * `labelId` is the unique identifier for the label you wish to void.
+     */
     labelId?: string;
+    /**
+     * `onComplete` is a callback function that will be invoked when the request to void a given
+     * shipping label is completed.
+     */
     onComplete: (request: SE.VoidRequest, shipment: SE.SalesOrderShipment) => void;
+    /**
+     * `onSuccess` is a callback function that will be invoked when the request to void a given
+     * shipping label is successful.
+     */
     onSuccess?: (label: SE.Label, shipment: SE.SalesOrderShipment) => void;
+    /**
+     * `onViewShipment` is a callback function that will be invoked when the user clicks the
+     * `View Shipment` button. This will take you back to the
+     * {@link ViewShipment.Element | `View Shipment Element`} for the given shipment, where you
+     * will be able to see the voided label listed.
+     */
     onViewShipment: (shipment: SE.SalesOrderShipment) => void;
 };
+/**
+ * # Void Label Component
+ *
+ * - The `<VoidLabel />` component is used to void a given shipping label. When a label is voided,
+ * you then get the option to view the associated shipment via the `View Shipment` Element, or
+ * you can purchase another label for the shipment via the `Purchase Label` Element.
+ *
+ * @param ComponentProps The base props that will be passed into the `<VoidLabel />` component.
+ *
+ * @returns Element An EmotionJSX.Element that will render the `<VoidLabel />` component
+ * with all the appropriate wrappers.
+ *
+ * @example
+ * You can see how the `<Component />` is used in the `createElement` function call below.
+ * ```tsx
+ * export const Element = alchemy.createElement(Component, ErrorFallback, {
+ *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
+ *   resources: { en },
+ * });
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link VoidLabel.Element | The **Element** created to render `<VoidLabel />`}
+ */
 export declare const Component: ({ features, labelId, onComplete, onSuccess, onViewShipment, }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # Registered Void Label Element
+ *
+ * - This is the registered `<VoidLabel />` element that will be used to render the
+ * `<VoidLabel.Element />` component.
+ *
+ * @param ElementProps The props, callbacks, and resources necessary to render
+ * the `<VoidLabel.Element />` component.
+ *
+ * @example
+ * The `<Component />` is the source JSX that is rendered when you make use of the `VoidLabel`
+ * Element directly. Here is a brief example of how you would use it within your application.
+ * ```tsx
+ * <VoidLabel.Element
+ *   labelId="se-1234567"
+ *   onComplete={() => console.log('onComplete')}
+ *   onSuccess={(_, { salesOrderIds: [salesOrderId] }) =>
+ *     console.log('sales order ID', salesOrderId)
+ *   }
+ *   onViewShipment={({ shipmentId }) => {
+ *     console.log('onViewShipment', shipmentId);
+ *   }}
+ * />
+ * ```
+ *
+ * <br />
+ *
+ * @see {@link VoidLabel.ComponentProps | The **props** that can be passed into the `<VoidLabel.Element />` component}
+ *
+ * @see {@link PurchaseLabel.Element | Go back to the frst step in the label purchase workflow `<PurchaseLabel.Element />`}
+ */
 export declare const Element: ({ resources, ...props }: ComponentProps & {
     resources?: {
         en: {
@@ -103,7 +186,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     notifications: {
                         error: {
                             title: string;
-                        };
+                        }; /**
+                         * `labelId` is the unique identifier for the label you wish to void.
+                         */
                         info: {
                             title: string;
                             description: string;
@@ -218,6 +303,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 rates: {
                     uspsMediaMailAcknowledgement: string;
                     uspsFirstClassMailAcknowledgement_leof: string;
+                    dhlExpressTermsAcknowledgement: string;
                 };
                 shipToAddressFormFields: string;
                 sections: {
@@ -398,7 +484,9 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         company: string;
                         countryCode: string;
                         addressLine1: string;
-                        addressLine2: string;
+                        addressLine2: string; /**
+                         * `features` is a set of feature flags you would like to enable or disable in this component.
+                         */
                         cityLocality: string;
                         stateProvince: string;
                         postalCode: string;
@@ -432,6 +520,31 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                         validated: string;
                     };
                 };
+                /**
+                 * # Void Label Component
+                 *
+                 * - The `<VoidLabel />` component is used to void a given shipping label. When a label is voided,
+                 * you then get the option to view the associated shipment via the `View Shipment` Element, or
+                 * you can purchase another label for the shipment via the `Purchase Label` Element.
+                 *
+                 * @param ComponentProps The base props that will be passed into the `<VoidLabel />` component.
+                 *
+                 * @returns Element An EmotionJSX.Element that will render the `<VoidLabel />` component
+                 * with all the appropriate wrappers.
+                 *
+                 * @example
+                 * You can see how the `<Component />` is used in the `createElement` function call below.
+                 * ```tsx
+                 * export const Element = alchemy.createElement(Component, ErrorFallback, {
+                 *   css: { height: "100%", maxWidth: "800px", minWidth: "440px", width: "100%" },
+                 *   resources: { en },
+                 * });
+                 * ```
+                 *
+                 * <br />
+                 *
+                 * @see {@link VoidLabel.Element | The **Element** created to render `<VoidLabel />`}
+                 */
                 billing: {
                     fields: {
                         differentBillingAddress: string;
@@ -604,11 +717,16 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     ounces: string;
                     pounds_one: string;
                     pounds_other: string;
+                    kilogram: string;
+                    gram: string;
                 };
                 units: {
-                    in: string;
+                    inch: string;
                     lbs: string;
                     oz: string;
+                    centimeter: string;
+                    gram: string;
+                    kilogram: string;
                 };
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
                 "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
@@ -617,6 +735,7 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                 QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
                 UGxlYXNlIGFkZCBhIFN0YW1wcy5jb20gYWNjb3VudCB0byBTaGlwRW5naW5lIGluIG9yZGVyIHRvIGNyZWF0ZSBzaGlwcGluZyBsYWJlbHMu: string;
                 QSBzaGlwcGluZyBlcnJvciBvY2N1cnJlZDogTWlzc2luZyBvciBpbnZhbGlkIHNoaXBwZXIgbnVtYmVy: string;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcHBlciBuYW1l: string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBNaXNzaW5nIG9yIGludmFsaWQgc2hpcCB0byBTdGF0ZVByb3ZpbmNlQ29kZQ==": string;
                 "QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnZhbGlkIHNvbGQgdG8gc3RhdGUgcHJvdmluY2UgY29kZS4gVmFsaWQgbGVuZ3RoIGlzIDAgdG8gNSBhbHBoYW51bWVyaWM=": string;
             };
@@ -630,10 +749,22 @@ export declare const Element: ({ resources, ...props }: ComponentProps & {
                     warehouses: string;
                     carriers: string;
                     labelLayout: string;
+                    /**
+                     * # Void Label Component Props
+                     *
+                     * - These are the base props that will be passed into the `<VoidLabel />` component.
+                     *
+                     * @see {@link VoidLabel.Component | This prop types usage in the `<VoidLabel />` component}
+                     */
                     unitSettings: string;
                 };
             };
         };
     } | undefined;
 }) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * # Void Label Element Props
+ *
+ * @see {@link VoidLabel.Element | See the full type that `typeof Element` will return}
+ */
 export type ElementProps = React.ComponentProps<typeof Element>;

package/src/extensions/zod.d.ts

@@ -1,5 +1,6 @@
 import { z } from "zod";
 declare function nullishDefault<T extends z.ZodTypeAny, U>(this: T, defaultValue: U): z.ZodEffects<z.ZodNullable<z.ZodOptional<T>>, U | NonNullable<T["_output"]>, T["_input"] | null | undefined>;
+/** @internal */
 declare module "zod" {
     interface ZodString {
         nullishDefault: typeof nullishDefault;
@@ -12,6 +13,10 @@ declare module "zod" {
     }
 }
 /**
+ * @internal
+ *
+ * # Form Utilities
+ *
  * @category Form Validation
  */
 export declare const extendZod: () => void;

package/src/factories/shipengine/package.d.ts

@@ -1,9 +1,20 @@
 import { Factory } from "fishery";
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Package Transient Params Type
+ *
+ * @catgory Factories
+ */
 export type PackageTransientParams = {
     noDimensions?: boolean;
 };
 /**
+ * @internal
+ *
+ * # Package Factory
+ *
  * @category Factories
  */
 export declare const packageFactory: Factory<SE.CarrierPackage, PackageTransientParams, SE.CarrierPackage>;

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

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

package/src/hooks/index.d.ts

@@ -7,3 +7,4 @@ export * from "./use-run-once-on-true";
 export * from "./use-toggle";
 export * from "./use-address-validation";
 export * from "./use-black-box-detection";
+export * from "./use-scrub-errors";

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

@@ -1,4 +1,11 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Delivery Confirmation Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useConfirmationOptions: () => {
     label: string;
     value: SE.ConfirmationType;

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

@@ -1,4 +1,17 @@
+/**
+ * @internal
+ *
+ * # Country Code Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useCountryCodeOptions: (domestic?: boolean) => {
-    label: "Afghanistan" | "Aland Islands" | "Albania" | "Algeria" | "American Samoa" | "Andorra" | "Angola" | "Anguilla" | "Antarctica" | "Antigua Barbuda" | "Argentina" | "Armenia" | "Aruba" | "Australia" | "Austria" | "Azerbaijan" | "Bahamas" | "Bahrain" | "Bangladesh" | "Barbados" | "Belarus" | "Belgium" | "Belize" | "Benin" | "Bermuda" | "Bhutan" | "Bolivia" | "Bonaire, Sint Eustatius And Saba" | "Bosnia and Herzegovina" | "Botswana" | "Brazil" | "British Indian Ocean Territory" | "British Virgin Islands" | "Brunei Darussalam" | "Bulgaria" | "Burkina Faso" | "Burundi" | "Canada" | "Cambodia" | "Cameroon" | "Cape Verde Islands" | "Cayman Islands" | "Central African Republic" | "Chad" | "Chile" | "China" | "Christmas Island" | "Cocos(Keeling) Islands" | "Colombia" | "Comoros" | "Congo" | "Congo, The Democratic Republic of" | "Cook Islands" | "Costa Rica" | "Croatia" | "Cuba" | "Curacao" | "Cyprus" | "Czech Republic" | "Denmark" | "Djibouti" | "Dominica" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Equatorial Guinea" | "Eritrea" | "Estonia" | "Ethiopia" | "Falkland Islands" | "Faroe Islands" | "Federated States of Micronesia" | "Fiji" | "Finland" | "France" | "French Guiana" | "French Polynesia" | "French Southern Territories" | "Gabon" | "Gambia" | "Georgia" | "Germany" | "Ghana" | "Gibraltar" | "Greece" | "Greenland" | "Grenada" | "Guadeloupe" | "Guam" | "Guatemala" | "Guernsey" | "Guinea" | "Guinea - Bissau" | "Guyana" | "Haiti" | "Holy See" | "Honduras" | "Hong Kong" | "Hungary" | "Iceland" | "India" | "Indonesia" | "Iran" | "Iraq" | "Ireland" | "Isle of Man" | "Israel" | "Italy" | "Ivory Coast" | "Jamaica" | "Japan" | "Jersey" | "Jordan" | "Kazakhstan" | "Kenya" | "Kiribati" | "Korea, Republic of" | "Kuwait" | "Kyrgyzstan" | "Laos" | "Latvia" | "Lebanon" | "Lesotho" | "Liberia" | "Libya" | "Liechtenstein" | "Lithuania" | "Luxembourg" | "Macao" | "Macedonia" | "Madagascar" | "Malawi" | "Malaysia" | "Maldives" | "Mali" | "Malta" | "Marshall Islands" | "Martinique" | "Mauritania" | "Mauritius0" | "Mayotte" | "Mexico" | "Moldova" | "Monaco" | "Mongolia" | "Montenegro" | "Montserrat" | "Morocco" | "Mozambique" | "Myanmar" | "Namibia" | "Nauru" | "Nepal" | "Netherlands" | "Netherlands Antilles" | "New Caledonia" | "New Zealand" | "Nicaragua" | "Niger" | "Nigeria" | "Niue" | "Norfolk Island" | "North Korea" | "Northern Mariana Islands" | "Norway" | "Oman" | "Pakistan" | "Palau" | "Palestinian Territory" | "Panama" | "Papua New Guinea" | "Paraguay" | "Peru" | "Philippines" | "Pitcairn Island" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Reunion" | "Romania" | "Russia" | "Rwanda" | "Saint Barthelemy" | "Saint Helena" | "Saint Kitts and Nevis" | "Saint Lucia" | "Saint Martin" | "Saint Pierre and Miquelon" | "Saint Vincent & the Grenadines" | "Samoa" | "San Marino" | "Sao Tome and Principe" | "Saudi Arabia" | "Senegal" | "Serbia" | "Seychelles" | "Sierra Leone" | "Singapore" | "Sint Maarten(Dutch)" | "Slovakia" | "Slovenia" | "Solomon Islands" | "Somalia" | "South Africa" | "South Georgia & the South Sandwich Islands" | "South Sudan" | "Spain" | "Sri Lanka" | "Sudan" | "Suriname" | "Svalbard & Jan Mayen Islands" | "Swaziland" | "Sweden" | "Switzerland" | "Syria" | "Taiwan" | "Tajikistan" | "Tanzania" | "Thailand" | "Timor - Leste(formerly East Timor)" | "Togo" | "Tokelau" | "Tonga" | "Trinidad and Tobago" | "Tunisia" | "Turkey" | "Turkmenistan" | "Turks and Caicos Islands" | "Tuvalu" | "Uganda" | "Ukraine" | "United Arab Emirates" | "United Kingdom" | "United States Virgin Islands" | "U.S. Minor Outlying Islands" | "United States of America" | "Uruguay" | "Uzbekistan" | "Vanuatu" | "Venezuela" | "Vietnam" | "Wallis and Futuna Islands" | "Western Sahara" | "Yemen" | "Zambia" | "Zimbabwe";
-    value: "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";
-}[];
+    countryCodeOptions: {
+        label: "Afghanistan" | "Aland Islands" | "Albania" | "Algeria" | "American Samoa" | "Andorra" | "Angola" | "Anguilla" | "Antarctica" | "Antigua Barbuda" | "Argentina" | "Armenia" | "Aruba" | "Australia" | "Austria" | "Azerbaijan" | "Bahamas" | "Bahrain" | "Bangladesh" | "Barbados" | "Belarus" | "Belgium" | "Belize" | "Benin" | "Bermuda" | "Bhutan" | "Bolivia" | "Bonaire, Sint Eustatius And Saba" | "Bosnia and Herzegovina" | "Botswana" | "Brazil" | "British Indian Ocean Territory" | "British Virgin Islands" | "Brunei Darussalam" | "Bulgaria" | "Burkina Faso" | "Burundi" | "Canada" | "Cambodia" | "Cameroon" | "Cape Verde Islands" | "Cayman Islands" | "Central African Republic" | "Chad" | "Chile" | "China" | "Christmas Island" | "Cocos(Keeling) Islands" | "Colombia" | "Comoros" | "Congo" | "Congo, The Democratic Republic of" | "Cook Islands" | "Costa Rica" | "Croatia" | "Cuba" | "Curacao" | "Cyprus" | "Czech Republic" | "Denmark" | "Djibouti" | "Dominica" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Equatorial Guinea" | "Eritrea" | "Estonia" | "Ethiopia" | "Falkland Islands" | "Faroe Islands" | "Federated States of Micronesia" | "Fiji" | "Finland" | "France" | "French Guiana" | "French Polynesia" | "French Southern Territories" | "Gabon" | "Gambia" | "Georgia" | "Germany" | "Ghana" | "Gibraltar" | "Greece" | "Greenland" | "Grenada" | "Guadeloupe" | "Guam" | "Guatemala" | "Guernsey" | "Guinea" | "Guinea - Bissau" | "Guyana" | "Haiti" | "Holy See" | "Honduras" | "Hong Kong" | "Hungary" | "Iceland" | "India" | "Indonesia" | "Iran" | "Iraq" | "Ireland" | "Isle of Man" | "Israel" | "Italy" | "Ivory Coast" | "Jamaica" | "Japan" | "Jersey" | "Jordan" | "Kazakhstan" | "Kenya" | "Kiribati" | "Korea, Republic of" | "Kuwait" | "Kyrgyzstan" | "Laos" | "Latvia" | "Lebanon" | "Lesotho" | "Liberia" | "Libya" | "Liechtenstein" | "Lithuania" | "Luxembourg" | "Macao" | "Macedonia" | "Madagascar" | "Malawi" | "Malaysia" | "Maldives" | "Mali" | "Malta" | "Marshall Islands" | "Martinique" | "Mauritania" | "Mauritius0" | "Mayotte" | "Mexico" | "Moldova" | "Monaco" | "Mongolia" | "Montenegro" | "Montserrat" | "Morocco" | "Mozambique" | "Myanmar" | "Namibia" | "Nauru" | "Nepal" | "Netherlands" | "Netherlands Antilles" | "New Caledonia" | "New Zealand" | "Nicaragua" | "Niger" | "Nigeria" | "Niue" | "Norfolk Island" | "North Korea" | "Northern Mariana Islands" | "Norway" | "Oman" | "Pakistan" | "Palau" | "Palestinian Territory" | "Panama" | "Papua New Guinea" | "Paraguay" | "Peru" | "Philippines" | "Pitcairn Island" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Reunion" | "Romania" | "Russia" | "Rwanda" | "Saint Barthelemy" | "Saint Helena" | "Saint Kitts and Nevis" | "Saint Lucia" | "Saint Martin" | "Saint Pierre and Miquelon" | "Saint Vincent & the Grenadines" | "Samoa" | "San Marino" | "Sao Tome and Principe" | "Saudi Arabia" | "Senegal" | "Serbia" | "Seychelles" | "Sierra Leone" | "Singapore" | "Sint Maarten(Dutch)" | "Slovakia" | "Slovenia" | "Solomon Islands" | "Somalia" | "South Africa" | "South Georgia & the South Sandwich Islands" | "South Sudan" | "Spain" | "Sri Lanka" | "Sudan" | "Suriname" | "Svalbard & Jan Mayen Islands" | "Swaziland" | "Sweden" | "Switzerland" | "Syria" | "Taiwan" | "Tajikistan" | "Tanzania" | "Thailand" | "Timor - Leste(formerly East Timor)" | "Togo" | "Tokelau" | "Tonga" | "Trinidad and Tobago" | "Tunisia" | "Turkey" | "Turkmenistan" | "Turks and Caicos Islands" | "Tuvalu" | "Uganda" | "Ukraine" | "United Arab Emirates" | "United Kingdom" | "United States Virgin Islands" | "U.S. Minor Outlying Islands" | "United States of America" | "Uruguay" | "Uzbekistan" | "Vanuatu" | "Venezuela" | "Vietnam" | "Wallis and Futuna Islands" | "Western Sahara" | "Yemen" | "Zambia" | "Zimbabwe";
+        value: "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";
+    }[];
+    defaultCountryCodeOption: {
+        label: "Afghanistan" | "Aland Islands" | "Albania" | "Algeria" | "American Samoa" | "Andorra" | "Angola" | "Anguilla" | "Antarctica" | "Antigua Barbuda" | "Argentina" | "Armenia" | "Aruba" | "Australia" | "Austria" | "Azerbaijan" | "Bahamas" | "Bahrain" | "Bangladesh" | "Barbados" | "Belarus" | "Belgium" | "Belize" | "Benin" | "Bermuda" | "Bhutan" | "Bolivia" | "Bonaire, Sint Eustatius And Saba" | "Bosnia and Herzegovina" | "Botswana" | "Brazil" | "British Indian Ocean Territory" | "British Virgin Islands" | "Brunei Darussalam" | "Bulgaria" | "Burkina Faso" | "Burundi" | "Canada" | "Cambodia" | "Cameroon" | "Cape Verde Islands" | "Cayman Islands" | "Central African Republic" | "Chad" | "Chile" | "China" | "Christmas Island" | "Cocos(Keeling) Islands" | "Colombia" | "Comoros" | "Congo" | "Congo, The Democratic Republic of" | "Cook Islands" | "Costa Rica" | "Croatia" | "Cuba" | "Curacao" | "Cyprus" | "Czech Republic" | "Denmark" | "Djibouti" | "Dominica" | "Dominican Republic" | "Ecuador" | "Egypt" | "El Salvador" | "Equatorial Guinea" | "Eritrea" | "Estonia" | "Ethiopia" | "Falkland Islands" | "Faroe Islands" | "Federated States of Micronesia" | "Fiji" | "Finland" | "France" | "French Guiana" | "French Polynesia" | "French Southern Territories" | "Gabon" | "Gambia" | "Georgia" | "Germany" | "Ghana" | "Gibraltar" | "Greece" | "Greenland" | "Grenada" | "Guadeloupe" | "Guam" | "Guatemala" | "Guernsey" | "Guinea" | "Guinea - Bissau" | "Guyana" | "Haiti" | "Holy See" | "Honduras" | "Hong Kong" | "Hungary" | "Iceland" | "India" | "Indonesia" | "Iran" | "Iraq" | "Ireland" | "Isle of Man" | "Israel" | "Italy" | "Ivory Coast" | "Jamaica" | "Japan" | "Jersey" | "Jordan" | "Kazakhstan" | "Kenya" | "Kiribati" | "Korea, Republic of" | "Kuwait" | "Kyrgyzstan" | "Laos" | "Latvia" | "Lebanon" | "Lesotho" | "Liberia" | "Libya" | "Liechtenstein" | "Lithuania" | "Luxembourg" | "Macao" | "Macedonia" | "Madagascar" | "Malawi" | "Malaysia" | "Maldives" | "Mali" | "Malta" | "Marshall Islands" | "Martinique" | "Mauritania" | "Mauritius0" | "Mayotte" | "Mexico" | "Moldova" | "Monaco" | "Mongolia" | "Montenegro" | "Montserrat" | "Morocco" | "Mozambique" | "Myanmar" | "Namibia" | "Nauru" | "Nepal" | "Netherlands" | "Netherlands Antilles" | "New Caledonia" | "New Zealand" | "Nicaragua" | "Niger" | "Nigeria" | "Niue" | "Norfolk Island" | "North Korea" | "Northern Mariana Islands" | "Norway" | "Oman" | "Pakistan" | "Palau" | "Palestinian Territory" | "Panama" | "Papua New Guinea" | "Paraguay" | "Peru" | "Philippines" | "Pitcairn Island" | "Poland" | "Portugal" | "Puerto Rico" | "Qatar" | "Reunion" | "Romania" | "Russia" | "Rwanda" | "Saint Barthelemy" | "Saint Helena" | "Saint Kitts and Nevis" | "Saint Lucia" | "Saint Martin" | "Saint Pierre and Miquelon" | "Saint Vincent & the Grenadines" | "Samoa" | "San Marino" | "Sao Tome and Principe" | "Saudi Arabia" | "Senegal" | "Serbia" | "Seychelles" | "Sierra Leone" | "Singapore" | "Sint Maarten(Dutch)" | "Slovakia" | "Slovenia" | "Solomon Islands" | "Somalia" | "South Africa" | "South Georgia & the South Sandwich Islands" | "South Sudan" | "Spain" | "Sri Lanka" | "Sudan" | "Suriname" | "Svalbard & Jan Mayen Islands" | "Swaziland" | "Sweden" | "Switzerland" | "Syria" | "Taiwan" | "Tajikistan" | "Tanzania" | "Thailand" | "Timor - Leste(formerly East Timor)" | "Togo" | "Tokelau" | "Tonga" | "Trinidad and Tobago" | "Tunisia" | "Turkey" | "Turkmenistan" | "Turks and Caicos Islands" | "Tuvalu" | "Uganda" | "Ukraine" | "United Arab Emirates" | "United Kingdom" | "United States Virgin Islands" | "U.S. Minor Outlying Islands" | "United States of America" | "Uruguay" | "Uzbekistan" | "Vanuatu" | "Venezuela" | "Vietnam" | "Wallis and Futuna Islands" | "Western Sahara" | "Yemen" | "Zambia" | "Zimbabwe";
+        value: "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";
+    } | undefined;
+};

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

@@ -1,4 +1,11 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Customs Contents Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useCustomsContentsOptions: () => {
     label: string;
     value: SE.CustomsContentsType;

package/src/hooks/options/use-customs-non-delivery-options.d.ts

@@ -1,4 +1,11 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Customs Non-Delivery Options Hooks
+ *
+ * @category Hooks
+ */
 export declare const useCustomsNonDeliveryOptions: () => {
     label: string;
     value: SE.CustomsNonDeliveryType;

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

@@ -1,4 +1,19 @@
+/**
+ * @internal
+ *
+ * # Date Range Type
+ *
+ * @see {@link DateRangeOption | The `DateRangeOption` that uses this type}
+ */
 export type DateRange = [Date, Date];
+/**
+ * @internal
+ *
+ * # Date Range Option Type
+ *
+ * @see {@link DateRange | The `DateRange` type}
+ * @see {@link useDateRangeOptions | The hook that uses this type}
+ */
 export type DateRangeOption = {
     label: string;
 } & ({
@@ -9,6 +24,12 @@ export type DateRangeOption = {
     value: "last30days" | "thisMonth" | "lastMonth";
 });
 /**
- * A curated list of date range options relative to the immediate date
+ * @internal
+ *
+ * # Date Range Options Hook
+ *
+ * A curated list of date range options relative to the immediate date.
+ *
+ * @see {@link DateRangeOption | The `DateRangeOption` type used in this hook}
  */
 export declare const useDateRangeOptions: () => [DateRangeOption[], Record<"custom" | "last30days" | "thisMonth" | "lastMonth", DateRangeOption>];

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

@@ -1,3 +1,10 @@
+/**
+ * @internal
+ *
+ * # Expiration Month Options Hook
+ *
+ * @cateogry Hooks
+ */
 export declare const useExpirationMonthOptions: () => {
     label: string;
     value: string;

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

@@ -3,6 +3,13 @@ interface InsuranceFeatures {
     includeShipsuranceInsurance?: boolean;
     includeThirdPartyInsurance?: boolean;
 }
+/**
+ * @internal
+ *
+ * # Insurance Provider Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useInsuranceProviderOptions: (insuranceAccount?: SE.InsuranceAccount, features?: InsuranceFeatures) => {
     label: string;
     value: SE.InsuranceProviderType;

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

@@ -1,3 +1,10 @@
 import { SE } from "@shipengine/alchemy";
 import { SelectCategory } from "../../components/field/select";
+/**
+ * @internal
+ *
+ * # Package Options Hook
+ *
+ * @category Hooks
+ */
 export declare const usePackageOptions: (carriers?: SE.Carrier[], customPackageTypes?: SE.CustomPackage[], shipment?: SE.SalesOrderShipment) => SelectCategory[] | undefined;

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

@@ -1,8 +1,18 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Rate Options Hook - Rate Option Type
+ */
 export type RateOption = Omit<SE.Rate, "warningMessages"> & {
     balance?: number;
     messages: string[];
     requiresAcknowledgement?: boolean;
     requiresFundedAmount?: boolean;
 };
-export declare const useRateOptions: (rates?: SE.Rate[], carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean) => RateOption[];
+/**
+ * @internal
+ *
+ * # Rate Options Hook
+ */
+export declare const useRateOptions: (rates?: SE.Rate[], carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean, requireDhlTermsAcknowledgement?: boolean) => RateOption[];

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

@@ -1,3 +1,10 @@
 import { SE } from "@shipengine/alchemy";
 import { SelectCategory } from "../../components/field/select";
+/**
+ * @internal
+ *
+ * # Service Code Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useServiceCodeOptions: (carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment) => SelectCategory[];

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

@@ -1,5 +1,13 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Shipment Metadata Hook
+ *
+ * @category Hooks
+ */
 export declare const useShipmentMetadata: (shipment?: SE.SalesOrderShipment) => {
+    hasAllZeroMeasurements: boolean;
     isContentDescriptionRequired: boolean;
     isCustomsRequired: boolean;
     isInternational: boolean;

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

@@ -1,5 +1,10 @@
 import { SE } from "@shipengine/alchemy";
 import { ShippingPreset } from "../../types";
+/**
+ * @internal
+ *
+ * # Shipping Preset Options Props
+ */
 export type UseShippingPresetsOptionsProps = {
     platform?: {
         domestic: ShippingPreset[];
@@ -10,6 +15,11 @@ export type UseShippingPresetsOptionsProps = {
         international: ShippingPreset[];
     };
 };
+/**
+ * @internal
+ *
+ * # Shipping Preset Options Component
+ */
 export declare const useShippingPresetsOptions: ({ platform, user }?: UseShippingPresetsOptionsProps, shipment?: SE.SalesOrderShipment) => {
     categoryName: string;
     options: {

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

@@ -1,3 +1,10 @@
+/**
+ * @internal
+ *
+ * # State Code Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useStateCodeOptions: (domestic?: boolean) => {
     label: "Alabama" | "Alaska" | "American Samoa" | "Arizona" | "Arkansas" | "Armed Forces Americas" | "Armed Forces Europe" | "Armed Forces Pacific" | "California" | "Colorado" | "Connecticut" | "Delaware" | "District of Columbia" | "Florida" | "Georgia" | "Guam" | "Hawaii" | "Idaho" | "Illinois" | "Indiana" | "Iowa" | "Kansas" | "Kentucky" | "Louisiana" | "Maine" | "Maryland" | "Massachusetts" | "Michigan" | "Minnesota" | "Mississippi" | "Missouri" | "Montana" | "Nebraska" | "Nevada" | "New Hampshire" | "New Jersey" | "New Mexico" | "New York" | "North Carolina" | "North Dakota" | "Ohio" | "Oklahoma" | "Oregon" | "Pennsylvania" | "Puerto Rico" | "Rhode Island" | "South Carolina" | "South Dakota" | "Tennessee" | "Texas" | "Utah" | "Vermont" | "Virgin Islands" | "Virginia" | "Washington" | "West Virginia" | "Wisconsin" | "Wyoming" | "Northern Mariana Islands" | "U.S. Minor Outlying Islands";
     value: "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";

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

@@ -1,4 +1,11 @@
 import { SE } from "@shipengine/alchemy";
+/**
+ * @internal
+ *
+ * # Warehouse Options Hook
+ *
+ * @category Hooks
+ */
 export declare const useWarehouseOptions: (warehouses?: SE.Warehouse[]) => {
     label: string;
     value: string;

package/src/hooks/use-address-validation.d.ts

@@ -1,6 +1,13 @@
 /// <reference types="react" />
 import { SE } from "@shipengine/alchemy";
 import { Templates } from "../components";
+/**
+ * @internal
+ *
+ * # Address Validation Hook
+ *
+ * @cateogry Hooks
+ */
 export declare const useAddressValidation: () => {
     errors: SE.CodedError[] | null;
     setValidationPreference: import("react").Dispatch<import("react").SetStateAction<Templates.ValidationPreference | undefined>>;

package/src/hooks/use-black-box-detection.d.ts

@@ -1,5 +1,19 @@
+/**
+ * @internal
+ *
+ * # Black Box Detection Props
+ *
+ * @see {@link useBlackboxDetection | The `useBlackboxDetection` hook that uses these props}
+ *
+ */
 export type BlackBoxDetectionProps = {
+    /**
+     * `onError` is a callback function to be invoked when there is an error detecting the black box.
+     */
     onError: () => void;
+    /**
+     * `onSuccess` is a callback function to be invoked when the black box is successfully detected.
+     */
     onSuccess: (blackbox: string) => void;
 };
 type IoBlackBox = () => {
@@ -16,7 +30,9 @@ declare global {
     let ioGetBlackbox: IoBlackBox | undefined;
 }
 /**
- * Creates an encoded device fingerprint string - aka black box - containing information about the end-user's computing device such as OS, browser, etc.
+ * @internal
+ *
+ * - Creates an encoded device fingerprint string - aka black box - containing information about the end-user's computing device such as OS, browser, etc.
  * https://developer.bazaarvoice.com/conversations-api/deprecations/iovation-web#snare_js_only
  */
 export declare const useBlackboxDetection: ({ onSuccess, onError }: BlackBoxDetectionProps) => void;

package/src/hooks/use-carrier-metadata.d.ts

@@ -1,3 +1,10 @@
 import { CarrierConnection } from "@shipengine/alchemy";
 import { CarrierMetadata } from "../types";
+/**
+ * @internal
+ *
+ * # Carrier Metadata Hook
+ *
+ * @category Hooks
+ */
 export declare const useCarrierMetadata: (carrierCodes?: CarrierConnection["carrierCode"][]) => CarrierMetadata[];

package/src/hooks/use-nested-form.d.ts

@@ -1,10 +1,19 @@
 import React from "react";
+/**
+ * @internal
+ *
+ * # Nested Form Hook Props
+ */
 export type NestedFormProps<T, U> = {
     formId: string;
     onCancel?: () => void;
     onSubmit: (payload: U) => Promise<void> | void;
 } & T;
 /**
+ * @internal
+ *
+ * # Nested Form Hook Component
+ *
  * Returns a nested form element that can be rendered within another form
  *
  * Handles closing the form on cancel or submission