@shipengine/elements 0.16.1 → 0.17.3

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

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

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

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

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

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

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

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

package/components/field/fields.d.ts

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

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

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

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

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

package/components/items-breakdown/items-breakdown.d.ts

@@ -6,7 +6,7 @@ export type Item = {
     subDetail?: string;
     subDetailValue?: SE.Money;
     totalValue?: SE.Money;
-    value: SE.Money;
+    value?: SE.Money;
 };
 export type ItemsBreakdownProps = {
     items: Item[];

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

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

package/components/templates/completion-page/completion-page.d.ts

@@ -0,0 +1,4 @@
+export type CompletionPageProps = {
+    onContinue: () => void;
+};
+export declare const CompletionPage: ({ onContinue }: CompletionPageProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/completion-page/index.d.ts

@@ -0,0 +1 @@
+export * from "./completion-page";

package/components/templates/index.d.ts

@@ -12,9 +12,10 @@ export * from "./list-carriers";
 export * from "./manage-warehouses";
 export * from "./onboarding";
 export * from "./rate-form";
-export * from "./sales-order";
+export * from "./suspend-sales-order";
 export * from "./shipment-form";
 export * from "./shipment";
+export * from "./suspend-shipment";
 export * from "./warehouse-form";
 export * from "./void-label";
 export * from "./wallet-form";

package/components/templates/list-carriers-row/list-carriers-row.styles.d.ts

@@ -1 +1 @@
-export declare const styles: Record<"carrierTypography" | "container" | "loadingButtonContainer" | "logoContainer" | "rowContainer" | "statusChipConnected" | "statusChipNotConnected", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;
+export declare const getStyles: (isConnected?: boolean) => Record<"connectButton" | "container" | "logoContainer" | "rowContainer", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;

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

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

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

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

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

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

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

@@ -30,7 +30,7 @@ export type ShipmentFormProps = {
     onSubmitParseShipTo: (payload: AddressParserPayload) => Promise<SE.AddressExtraction | undefined>;
     onToggleAddressPreferenceDisclosure?: AddressPreferenceDisplayProps["onToggleDisclosure"];
     onUpdateCustoms?: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
-    salesOrder: SE.SalesOrder;
+    salesOrder?: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;

package/components/templates/suspend-sales-order/index.d.ts

@@ -0,0 +1 @@
+export * from "./suspend-sales-order";

package/components/templates/suspend-sales-order/suspend-sales-order.d.ts

@@ -0,0 +1,8 @@
+import { WithChildrenCommonProps } from "@packlink/giger";
+import { SE } from "@shipengine/api";
+export type SuspendSalesOrderProps = WithChildrenCommonProps<{
+    errors?: SE.CodedError[];
+    isLoading?: boolean;
+    salesOrder?: SE.SalesOrder;
+}>;
+export declare const SuspendSalesOrder: ({ children, errors, isLoading, salesOrder, }: SuspendSalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/suspend-shipment/index.d.ts

@@ -0,0 +1 @@
+export * from "./suspend-shipment";

package/components/templates/suspend-shipment/suspend-shipment.d.ts

@@ -0,0 +1,8 @@
+import { WithChildrenCommonProps } from "@packlink/giger";
+import { SE } from "@shipengine/api";
+export type SuspendShipmentProps = WithChildrenCommonProps<{
+    errors?: SE.CodedError[];
+    isLoading?: boolean;
+    shipment?: SE.SalesOrderShipment;
+}>;
+export declare const SuspendShipment: ({ children, errors, isLoading, shipment, }: SuspendShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

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

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

@@ -24,7 +24,7 @@ export type ConfigureShipmentProps = {
     onShipmentUpdated: UseShipmentFormProps["onShipmentUpdated"];
     onToggleAddressPreferenceDisclosure?: Templates.ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
     printLabelLayout?: UseRatesFormProps["printLabelLayout"];
-    salesOrder: SE.SalesOrder;
+    salesOrder?: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;

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

@@ -5,7 +5,7 @@ export type UseAddressProps = {
     compatibleCountryCodes?: CountryCode[];
     onChange?: (oldShipment: SE.SalesOrderShipment, updatedShipment: SE.SalesOrderShipment) => Promise<void> | void;
     onValidation?: (addressPreference: Templates.AddressPreference) => Promise<void> | void;
-    salesOrder: SE.SalesOrder;
+    salesOrder?: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
 };
 export declare const useAddress: ({ compatibleCountryCodes, onChange, onValidation, salesOrder, shipment, }: UseAddressProps) => {

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

@@ -9,7 +9,7 @@ export type UseShipmentFormProps = {
     onChangeAddress?: UseAddressProps["onChange"];
     onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
     onSubmit?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
-    salesOrder: SE.SalesOrder;
+    salesOrder?: SE.SalesOrder;
     shipment?: SE.SalesOrderShipment;
 };
 export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, }: UseShipmentFormProps) => {
@@ -25,7 +25,7 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
         fullAddress: string;
     }) => Promise<SE.AddressExtraction>;
     onUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment>;
-    salesOrder: SE.SalesOrder;
+    salesOrder: SE.SalesOrder | undefined;
     shipment: SE.SalesOrderShipment | undefined;
     warehouses: SE.Warehouse[] | undefined;
 };

package/elements/components/index.d.ts

@@ -2,6 +2,6 @@ export * from "./configure-shipment";
 export * from "./list-carriers";
 export * from "./manage-warehouses";
 export * from "./onboarding";
-export * from "./sales-order";
+export * from "./purchase-label";
 export * from "./shipment";
 export * from "./void-label";

package/elements/components/{sales-order → purchase-label}/hooks/use-configure-shipment.d.ts

@@ -8,7 +8,7 @@ export type UseConfigureShipmentProps = {
     salesOrder?: SE.SalesOrder;
     warehouseId?: UsePendingShipmentProps["warehouseId"];
 };
-export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, }: UseConfigureShipmentProps) => {
+export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, printLabelLayout, }: UseConfigureShipmentProps) => {
     errors: SE.CodedError[] | undefined;
     isLoading: boolean;
     onShipmentUpdated: (shipment: SE.SalesOrderShipment) => Promise<void>;

package/elements/components/purchase-label/hooks/use-load-shipment.d.ts

@@ -0,0 +1,9 @@
+export type UseLoadShipmentProps = {
+    shipmentId: string;
+};
+export declare const useLoadShipment: ({ shipmentId }: UseLoadShipmentProps) => {
+    errors: import("@shipengine/api").CodedError[] | undefined;
+    isLoading: boolean;
+    refetchShipment: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<import("@shipengine/api").SalesOrderShipment, import("@shipengine/api").CodedError[]>>;
+    shipment: import("@shipengine/api").SalesOrderShipment | undefined;
+};

package/elements/components/purchase-label/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./purchase-label-by-sales-order";
+export * from "./purchase-label";
+export * from "./purchase-label-by-shipment";

package/elements/components/{sales-order/sales-order.d.ts → purchase-label/purchase-label-by-sales-order.d.ts}

@@ -23,4 +23,4 @@ export type SalesOrderProps = {
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: UseConfigureShipmentProps["warehouseId"];
 };
-export declare const SalesOrder: ({ features, externalOrderId, externalOrderNumber, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, warehouseId, printLabelLayout, ...props }: SalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const PurchaseLabelBySalesOrder: ({ features, externalOrderId, externalOrderNumber, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, warehouseId, printLabelLayout, ...props }: SalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/components/purchase-label/purchase-label-by-shipment.d.ts

@@ -0,0 +1,9 @@
+import { ReactNode } from "react";
+import { SalesOrderProps } from "./purchase-label-by-sales-order";
+type ShipmentOrderProps = {
+    children?: ReactNode;
+    shipmentId: string;
+};
+type PurchaseLabelByShipmentProps = Partial<SalesOrderProps> & ShipmentOrderProps;
+export declare const PurchaseLabelByShipment: ({ shipmentId, onLoad, onShipmentUpdated, features, ...props }: PurchaseLabelByShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export {};

package/elements/components/purchase-label/purchase-label.d.ts

@@ -0,0 +1,6 @@
+import { SalesOrderProps } from "./purchase-label-by-sales-order";
+type PurchaseLabelProps = SalesOrderProps & {
+    shipmentId?: string;
+};
+export declare const PurchaseLabel: ({ shipmentId, ...props }: PurchaseLabelProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export {};

package/elements/purchase-label.d.ts

@@ -1 +1,3 @@
-export declare const Element: (props: import("./components/sales-order").SalesOrderProps & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: (props: import("./components").SalesOrderProps & {
+    shipmentId?: string | undefined;
+} & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/hooks/use-elements.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="react" />
+import { ShipEngineProviderProps } from "@shipengine/react";
 export type ElementsEnvironment = `dde:${string}` | "development" | "staging" | "production";
 export type ElementsErrorHandler = (err: Error, context: {
     componentStack: string;
@@ -18,7 +19,7 @@ export interface ElementsProviderProps {
     brandName?: string;
     children: JSX.Element;
     environment?: ElementsEnvironment;
-    getToken: () => string;
+    getToken: ShipEngineProviderProps["getToken"];
     onError?: ElementsErrorHandler;
     proxyTarget?: string;
 }