@shipengine/elements 0.13.1 → 0.15.0

package/constants/shipengine/address.d.ts

@@ -27,6 +27,7 @@ export declare class UsState<T extends string, U extends string> {
 }
 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">];
 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"];
+export type UsStateCode = typeof usStateCodes[number];
 export type UsaCityRules = {
     isMilitary?: boolean;
 };

package/elements/components/configure-shipment/configure-shipment.d.ts

@@ -1,6 +1,6 @@
 import * as SE from "@shipengine/types";
-import { UseShippingPresetsOptionsProps } from "../../../hooks";
 import { Templates } from "../../../components";
+import { UseShippingPresetsOptionsProps } from "../../../hooks";
 import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
 export type ShipmentFormMode = "browse_rates" | "select_service";
 export type ConfigureShipmentFeatures = {

package/elements/components/configure-shipment/hooks/use-address.d.ts

@@ -1,6 +1,6 @@
 import * as SE from "@shipengine/types";
-import { CountryCode } from "../../../../constants";
 import { Templates } from "../../../../components";
+import { CountryCode } from "../../../../constants";
 export type UseAddressProps = {
     compatibleCountryCodes?: CountryCode[];
     onChange?: (oldShipment: SE.SalesOrderShipment, updatedShipment: SE.SalesOrderShipment) => Promise<void> | void;

package/elements/components/configure-shipment/hooks/use-customs.d.ts

@@ -4,6 +4,6 @@ export type UseCustomsProps = {
     shipment?: SE.SalesOrderShipment;
 };
 export declare const useCustoms: ({ onUpdate, shipment }: UseCustomsProps) => {
-    handleUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
     customsErrors: SE.CodedError[] | undefined;
+    handleUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
 };

package/elements/components/configure-shipment/hooks/use-presets.d.ts

@@ -1,5 +1,5 @@
-import { ShippingPreset } from "../../../../types";
 import * as SE from "@shipengine/types";
+import { ShippingPreset } from "../../../../types";
 export type UsePresetsProps = {
     onApply?: (preset: ShippingPreset, shipment: SE.SalesOrderShipment) => Promise<void> | void;
     shipment?: SE.SalesOrderShipment;

package/elements/components/configure-shipment/hooks/use-rates-form.d.ts

@@ -7,14 +7,14 @@ export type UseRatesFormProps = {
     onRateSaved?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onRatesCalculated?: UseRequestRatesProps["onRatesCalculated"];
     onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
-    printLabelLayout?: string;
+    printLabelLayout?: SE.LabelLayout;
     shipment?: SE.SalesOrderShipment;
 };
 export declare const useRatesForm: ({ onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
     carriers: SE.Carrier[] | undefined;
     errors: SE.CodedError[] | undefined;
-    labelErrors: SE.CodedError[] | undefined;
     isLoading: boolean;
+    labelErrors: SE.CodedError[] | undefined;
     onSave: ({ carrierId, serviceCode }: Pick<SE.Rate, "carrierId" | "serviceCode">) => Promise<void>;
     onSubmit: (rateId: string) => Promise<void>;
     rates: SE.Rate[] | undefined;

package/elements/components/configure-shipment/hooks/use-shipment-form.d.ts

@@ -1,5 +1,5 @@
-import { ShippingPreset } from "../../../../types";
 import * as SE from "@shipengine/types";
+import { ShippingPreset } from "../../../../types";
 import { UseAddressProps } from "./use-address";
 import { UsePresetsProps } from "./use-presets";
 export type UseShipmentFormProps = {
@@ -14,8 +14,8 @@ export type UseShipmentFormProps = {
 };
 export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, }: UseShipmentFormProps) => {
     addressPreference: import("../../../../components/templates").AddressPreference | undefined;
-    charsetWarning: import("../../../../components/templates").CharsetWarning | undefined;
     carriers: SE.Carrier[] | undefined;
+    charsetWarning: import("../../../../components/templates").CharsetWarning | undefined;
     customPackageTypes: SE.Package[] | undefined;
     errors: SE.CodedError[] | undefined;
     onApplyPreset: (preset: ShippingPreset) => Promise<void>;

package/factories/shipengine/address.d.ts

@@ -15,9 +15,9 @@ type AddressPreference = SE.AddressValidation & {
     alternative?: SE.Address;
     alternativeSource: "originalAddress" | "matchedAddress";
     isModified: boolean;
-    toggle: () => SE.Address;
     selection: SE.Address;
     selectionSource: "originalAddress" | "matchedAddress";
+    toggle: () => SE.Address;
 };
 /**
  * Mock the addressValidation object used to hyrdate address valiation feature

package/factories/shipengine/sales-order.d.ts

@@ -1,6 +1,6 @@
 import { Factory } from "fishery";
-import { MoneyTransientParams } from "./money";
 import * as SE from "@shipengine/types";
+import { MoneyTransientParams } from "./money";
 export declare const randomPaymentStatus: () => SE.PaymentStatus;
 export declare const randomFulfillmentStatus: () => SE.FulfillmentStatus;
 /**

package/factories/shipengine/shipment.d.ts

@@ -1,6 +1,6 @@
 import { Factory } from "fishery";
-import { MoneyTransientParams } from "./money";
 import * as SE from "@shipengine/types";
+import { MoneyTransientParams } from "./money";
 export declare const randomDeliveryConfirmation: () => SE.ConfirmationType;
 export declare const randomInsuranceProvider: (allowNone?: boolean) => SE.InsuranceProvider;
 /**
@@ -24,8 +24,8 @@ export type ShipmentTransientParams = {
     isInsured?: boolean;
     isInternational?: boolean;
     isShipped?: boolean;
-    service?: SE.Service;
     salesOrder?: SE.SalesOrder;
+    service?: SE.Service;
     warehouse?: SE.Warehouse;
 };
 /**

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

@@ -1,7 +1,7 @@
 import * as SE from "@shipengine/types";
 interface InsuranceFeatures {
-    includeThirdPartyInsurance?: boolean;
     includeShipsuranceInsurance?: boolean;
+    includeThirdPartyInsurance?: boolean;
 }
 export declare const useInsuranceProviderOptions: (insuranceAccount?: SE.InsuranceAccount, features?: InsuranceFeatures) => {
     label: string;

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

@@ -12,8 +12,8 @@ export type UseShippingPresetsOptionsProps = {
 export declare const useShippingPresetsOptions: ({ platform, user }: UseShippingPresetsOptionsProps | undefined, isInternationalShipment: boolean) => {
     categoryName: string;
     options: {
-        displayName: string;
         description: import("@emotion/react/jsx-runtime").JSX.Element;
+        displayName: string;
         value: ShippingPreset;
     }[];
 }[];

package/hooks/use-elements.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="react" />
 export type ElementsEnvironment = `dde:${string}` | "development" | "staging" | "production";
 export type ElementsErrorHandler = (err: Error, context: {
-    element?: string;
     componentStack: string;
+    element?: string;
 }) => void;
 export interface ElementsContextValue {
+    brandName?: string;
     environment: ElementsEnvironment;
     onError?: ElementsErrorHandler;
-    brandName?: string;
 }
 /**
  * @category Contexts
@@ -15,17 +15,17 @@ export interface ElementsContextValue {
 export declare const ElementsContext: import("react").Context<ElementsContextValue | undefined>;
 export interface ElementsProviderProps {
     baseURL?: string;
+    brandName?: string;
     children: JSX.Element;
     environment?: ElementsEnvironment;
+    getToken: () => string;
     onError?: ElementsErrorHandler;
     proxyTarget?: string;
-    brandName?: string;
-    token: string;
 }
 /**
  * @category Providers
  */
-export declare const ElementsProvider: ({ baseURL, children, environment, onError, brandName, token, }: ElementsProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const ElementsProvider: ({ baseURL, brandName, children, environment, getToken, onError, }: ElementsProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 /**
  * Must be used within {@link ElementsProvider}
  *

package/hooks/use-page-layout.d.ts

@@ -1,7 +1,7 @@
 import React, { PropsWithChildren } from "react";
 type PageLayoutContextValue = {
-    HeaderPortal: React.FC<PropsWithChildren>;
     FooterPortal: React.FC<PropsWithChildren>;
+    HeaderPortal: React.FC<PropsWithChildren>;
 };
 type PageLayoutProviderProps = {
     children: React.ReactNode;