@shipengine/elements 0.11.1 → 0.13.0

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

@@ -0,0 +1,4 @@
+export declare const useExpirationMonthOptions: () => {
+    label: string;
+    value: string;
+}[];

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

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

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

@@ -0,0 +1,3 @@
+import * as SE from "@shipengine/types";
+import { SelectCategory } from "../../components/field/select";
+export declare const usePackageOptions: (carriers?: SE.Carrier[], customPackageTypes?: SE.Package[], poBox?: boolean) => SelectCategory[] | undefined;

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

@@ -0,0 +1,21 @@
+import * as SE from "@shipengine/types";
+export type RateOption = Omit<SE.Rate, "warningMessages"> & {
+    balance?: number;
+    messages: string[];
+    recommended?: boolean;
+    requiresAcknowledgement?: boolean;
+    requiresFundedAmount?: boolean;
+};
+type RateRecommendation = {
+    carrierCode: string;
+    ignoreIfPresent?: string;
+    serviceCode: string;
+    tagline?: string;
+    walleted: boolean;
+};
+type RateRecommendations = {
+    domestic: RateRecommendation;
+    international: RateRecommendation;
+};
+export declare const useRateOptions: (rates?: SE.Rate[], carriers?: SE.Carrier[], shipment?: SE.SalesOrderShipment, enableGlobalPostFiltering?: boolean, rateRecommendations?: RateRecommendations) => RateOption[];
+export {};

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

@@ -0,0 +1,3 @@
+import * as SE from "@shipengine/types";
+import { SelectCategory } from "../../components/field/select";
+export declare const useServiceCodeOptions: (carriers?: SE.Carrier[], domestic?: boolean, poBox?: boolean) => SelectCategory[];

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

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

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

@@ -0,0 +1,4 @@
+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/hooks/options/use-warehouse-options.d.ts

@@ -0,0 +1,5 @@
+import * as SE from "@shipengine/types";
+export declare const useWarehouseOptions: (warehouses?: SE.Warehouse[]) => {
+    label: string;
+    value: string;
+}[] | undefined;

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

@@ -0,0 +1,6 @@
+import { CarrierMetadata } from "../types";
+type UseCarrierMetadataReturn = {
+    carrierMetadatas: CarrierMetadata[];
+};
+export declare const useCarrierMetadata: () => UseCarrierMetadataReturn;
+export {};

package/hooks/use-elements.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="react" />
+export type ElementsEnvironment = `dde:${string}` | "development" | "staging" | "production";
+export type ElementsErrorHandler = (err: Error, context: {
+    element?: string;
+    componentStack: string;
+}) => void;
+export interface ElementsContextValue {
+    environment: ElementsEnvironment;
+    onError?: ElementsErrorHandler;
+    brandName?: string;
+}
+/**
+ * @category Contexts
+ */
+export declare const ElementsContext: import("react").Context<ElementsContextValue | undefined>;
+export interface ElementsProviderProps {
+    baseURL?: string;
+    children: JSX.Element;
+    environment?: ElementsEnvironment;
+    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;
+/**
+ * Must be used within {@link ElementsProvider}
+ *
+ * @category Elements Hooks
+ *
+ * @see {@link registerElement}
+ */
+export declare const useElements: () => ElementsContextValue;

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

@@ -0,0 +1,22 @@
+import React from "react";
+export type NestedFormProps<T, U> = {
+    formId: string;
+    onCancel?: () => void;
+    onSubmit: (payload: U) => Promise<void>;
+} & T;
+/**
+ * Returns a nested form element that can be rendered within another form
+ *
+ * Handles closing the form on cancel or submission
+ *
+ * Mounts on the root portal, and must be used within {@link RootPortalProvider}
+ *
+ * @category Elements Hooks
+ */
+export declare const useNestedForm: <T, U>(form: React.FC<NestedFormProps<T, U>>, props: {
+    formId: string;
+    onCancel?: (() => void) | undefined;
+    onSubmit: (payload: U) => Promise<void>;
+} & T & {
+    portalRef?: undefined;
+}) => readonly [import("@emotion/react/jsx-runtime").JSX.Element, boolean, React.DispatchWithoutAction];

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

@@ -0,0 +1,11 @@
+import React, { PropsWithChildren } from "react";
+type PageLayoutContextValue = {
+    HeaderPortal: React.FC<PropsWithChildren>;
+    FooterPortal: React.FC<PropsWithChildren>;
+};
+type PageLayoutProviderProps = {
+    children: React.ReactNode;
+};
+export declare const PageLayoutProvider: ({ children }: PageLayoutProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const usePageLayout: () => PageLayoutContextValue;
+export {};

package/hooks/use-root-portal.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+type RootPortalProviderProps = {
+    children: React.ReactNode;
+};
+/**
+ * Provides access to a top-level 'root-portal' DOM node, adjacent the app 'root' div
+ *
+ * @category Providers
+ *
+ * @see {@link ElementsProvider}
+ */
+export declare const RootPortalProvider: ({ children }: RootPortalProviderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+/**
+ * Must be used within {@link RootPortalProvider}
+ *
+ * @category Elements Hooks
+ */
+export declare const useRootPortal: () => HTMLDivElement;
+export {};

package/hooks/use-run-once-on-true.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Runs a callback once and only once when a condition is true.
+ *
+ * @param conditionalEffect A logical expression ending with a callback
+ * @example useRunOnceOnTrue(testValue && anotherTestValue && (() => console.log("Hello world!")));
+ */
+export declare const useRunOnceOnTrue: (conditionalEffect?: false | null | React.EffectCallback) => void;