@shipengine/elements 2.11.1 → 2.12.0

package/src/components/ship-from-address-form/ship-from-address-form.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/js-api";
+import { ShipFromAddress } from "../../types";
+import { AddressParserPayload } from "../templates";
+export type ShipFromAddressFormProps<T = undefined> = {
+    onCancel?: () => void;
+    onCancelParse?: () => void;
+    onSubmit: (payload: Partial<ShipFromAddress> & Pick<ShipFromAddress, "originAddress">) => void;
+    onSubmitParse?: (payload: AddressParserPayload) => Promise<SE.AddressExtraction | undefined>;
+    parseAddressErrors?: SE.CodedError[];
+    resetParseAddress?: () => void;
+    shipFromAddress?: ShipFromAddress;
+} & ({
+    formId: string;
+    portalRef: React.RefObject<T>;
+} | {
+    formId?: string;
+    portalRef?: never;
+});
+export declare const ShipFromAddressForm: <T extends Element>({ shipFromAddress, onSubmit, onSubmitParse, resetParseAddress, onCancelParse, parseAddressErrors, onCancel, formId, portalRef, }: ShipFromAddressFormProps<T>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/ship-from-address-form/ship-from-address-form.styles.d.ts

@@ -0,0 +1,20 @@
+export declare const styles: {
+    getHeaderTypography: (isAddressParserOpen: boolean) => (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        marginBottom?: number | undefined;
+        width: string;
+    };
+    getHeaderWrapper: (isAddressParserOpen: boolean) => (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        display: "flex";
+        flexDirection: "column" | "row";
+        justifyContent: "space-between";
+        paddingBottom: number;
+        width: string;
+    };
+    pasteList: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
+        flexShrink: number;
+        fontWeight: number;
+    };
+    pasteWrapper: () => {
+        flexShrink: number;
+    };
+};

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

@@ -11,7 +11,7 @@ export * from "./rate-form";
 export * from "./shipment-form";
 export * from "./shipment";
 export * from "./suspend-sales-order";
-export * from "./suspend-shipment";
+export * from "./suspend-purchase";
 export * from "./theme-creator";
 export * from "./wallet-form";
 export * from "./register-funding-source-carrier-form";

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

@@ -1,10 +1,11 @@
 import { SE } from "@shipengine/react-api";
 import { ServicePointSearchQuery } from "../../../hooks";
 import { PreferredRatesResponse } from "../../../types";
-import { RateFormFeatures } from "../../../utilities";
+import { PurchaseLabelFeatures, RateFormFeatures } from "../../../utilities";
 export type RateFormProps = {
     carriers?: SE.Carrier[];
     currency: SE.Currency;
+    defaultFeatures?: PurchaseLabelFeatures;
     disabled?: boolean;
     displayableRateErrors?: string[];
     displayableSaveRateErrors?: string[];
@@ -31,4 +32,4 @@ export type RateFormProps = {
     shipment?: SE.SalesOrderShipment;
     showVatFeatures?: boolean;
 };
-export declare const RateForm: ({ carriers, currency, disabled, displayableRateErrors, displayableSaveRateErrors, displayableShipmentErrors, errors, features, fetchServicePoints, isLoading, labelErrors, labels, labelsLoading, listServicePointsErrors, onSave, onSelectRate, onSubmit, onVatRegistrationComplete, preferredRates, preferredServiceCodes, rates, salesOrder, servicePointSearchQuery, servicePointsFetching, servicePointsResponse, shipment, showVatFeatures, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const RateForm: ({ carriers, currency, defaultFeatures, disabled, displayableRateErrors, displayableSaveRateErrors, displayableShipmentErrors, errors, features, fetchServicePoints, isLoading, labelErrors, labels, labelsLoading, listServicePointsErrors, onSave, onSelectRate, onSubmit, onVatRegistrationComplete, preferredRates, preferredServiceCodes, rates, salesOrder, servicePointSearchQuery, servicePointsFetching, servicePointsResponse, shipment, showVatFeatures, }: RateFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/src/components/templates/shipment-form/sections/customs-forms/customs-forms.d.ts

@@ -4,8 +4,9 @@ import { ShipmentFormProps } from "../../shipment-form";
 import { ShipmentFormFields } from "../../shipment-schema";
 type CustomsFormsProps = {
     form: UseFormReturn<ShipmentFormFields>;
+    isCanadaDeliveredDutyEligible: boolean;
     requiresWindsorFramework?: boolean;
     shipment: SE.SalesOrderShipment;
 } & Pick<ShipmentFormProps, "currency" | "onDirty" | "onUpdateCustoms" | "onUpdateTaxableIds">;
-export declare const CustomsForms: ({ form, currency, onUpdateCustoms, onUpdateTaxableIds, shipment, onDirty, requiresWindsorFramework, }: CustomsFormsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const CustomsForms: ({ form, currency, onUpdateCustoms, onUpdateTaxableIds, isCanadaDeliveredDutyEligible, shipment, onDirty, requiresWindsorFramework, }: CustomsFormsProps) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,8 +1,8 @@
 import React from "react";
 import { SE } from "@shipengine/react-api";
 import { UseShippingPresetsOptionsProps } from "../../../hooks";
-import { ShippingPreset } from "../../../types";
-import { ShipmentFormFeatures } from "../../../utilities";
+import { ShipFromAddress, ShippingPreset } from "../../../types";
+import { PurchaseLabelFeatures, ShipmentFormFeatures } from "../../../utilities";
 import { AddressParserPayload } from "../address-parser";
 import { AddressPreference, AddressPreferenceDisplayProps } from "../address-preference-display";
 export type OnChangeAddressOptions = {
@@ -17,6 +17,7 @@ export type ShipmentFormProps = {
     charsetWarning?: CharsetWarning;
     currency: SE.Currency;
     customPackageTypes?: SE.CustomPackage[];
+    defaultFeatures?: PurchaseLabelFeatures;
     errors?: SE.CodedError[];
     features?: ShipmentFormFeatures;
     hydrateRef: React.MutableRefObject<((updatedShipment: SE.SalesOrderShipment) => void) | undefined>;
@@ -29,16 +30,19 @@ export type ShipmentFormProps = {
         previousMode: ShipmentFormMode;
         selectedMode: ShipmentFormMode;
     }) => Promise<void> | void;
-    onChangeWarehouse: (warehouseId: string) => Promise<void>;
+    onChangeShipFromAddress: (id?: string, shipFromAddress?: ShipFromAddress) => Promise<void>;
     onDirty: () => void;
     onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<SE.SalesOrderShipment | undefined>;
-    onSubmitParseShipTo: (payload: AddressParserPayload) => Promise<SE.AddressExtraction | undefined>;
+    onSubmitParseAddress: (payload: AddressParserPayload) => Promise<SE.AddressExtraction | undefined>;
     onToggleAddressPreferenceDisclosure?: AddressPreferenceDisplayProps["onToggleDisclosure"];
-    onUpdateCustoms?: (customs: SE.Customs, products: SE.Product[]) => Promise<SE.SalesOrderShipment | undefined>;
+    onUpdateCustoms?: (customs: SE.Customs, products: SE.Product[], canadaDeliveredDuty?: string | null) => Promise<SE.SalesOrderShipment | undefined>;
     onUpdateTaxableIds?: (taxIds: SE.TaxIdentifier[], onError: (errors: SE.CodedError[]) => void) => Promise<SE.SalesOrderShipment>;
     parseAddressErrors?: SE.CodedError[];
     resetParseAddress?: () => void;
     salesOrder?: SE.SalesOrder;
+    shipFromAddresses?: (ShipFromAddress & {
+        addressId: string;
+    })[];
     shipment?: SE.SalesOrderShipment;
     shippingPresets?: UseShippingPresetsOptionsProps;
     warehouseId?: string;
@@ -49,4 +53,4 @@ export type CharsetWarning = {
     message: string;
     title?: string;
 };
-export declare const ShipmentForm: ({ accountSettings, addressLoading, addressPreference, charsetWarning, carriers, customPackageTypes, currency, features, hydrateRef, insuranceAccount, isLoading, onApplyPreset, onChangeAddress, onChangeMode, onChangeWarehouse, onDirty, onSubmit, onSubmitParseShipTo, onToggleAddressPreferenceDisclosure, onUpdateCustoms, onUpdateTaxableIds, 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, currency, defaultFeatures, features, hydrateRef, insuranceAccount, isLoading, onApplyPreset, onChangeAddress, onChangeMode, onChangeShipFromAddress, onDirty, onSubmit, onSubmitParseAddress, onToggleAddressPreferenceDisclosure, onUpdateCustoms, onUpdateTaxableIds, parseAddressErrors, resetParseAddress, salesOrder, shipment, shipFromAddresses, shippingPresets, warehouseId, warehouses, }: ShipmentFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -31,6 +31,7 @@ export declare const styles: {
         display: "flex";
         gap: number;
         justifyContent: "space-between";
+        marginBottom: number;
     };
     well: (theme: import("@shipengine/giger-theme/dist/lib/Theme").Theme) => {
         backgroundColor: string;

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

@@ -1,17 +1,19 @@
 import { z } from "zod";
 import { SE } from "@shipengine/react-api";
+import { CanadaDeliveredDutyOptions } from "../../../types";
 type GetShipmentSchemaOptions = {
     dimensionsUnit?: SE.DimensionUnit;
     isContentDescriptionRequired?: boolean;
     isCustomsRequired?: boolean;
     requireMeasurements?: boolean;
     requiresWindsorFramework?: boolean;
-    warehouses?: SE.Warehouse[];
     weightUnit?: SE.WeightUnit;
 };
-export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionRequired, requiresWindsorFramework, isCustomsRequired, requireMeasurements, warehouses, weightUnit, }?: GetShipmentSchemaOptions) => z.ZodEffects<z.ZodDiscriminatedUnion<"__mode", z.Primitive, z.ZodObject<z.extendShape<{
+export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionRequired, requiresWindsorFramework, isCustomsRequired, requireMeasurements, weightUnit, }?: GetShipmentSchemaOptions) => z.ZodEffects<z.ZodDiscriminatedUnion<"__mode", z.Primitive, z.ZodObject<z.extendShape<{
+    addressId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     advancedOptions: z.ZodNullable<z.ZodOptional<z.ZodObject<{
         additionalHandling: z.ZodOptional<z.ZodBoolean>;
+        canadaDeliveredDuty: z.ZodNullable<z.ZodOptional<z.ZodDefault<z.ZodNativeEnum<typeof CanadaDeliveredDutyOptions>>>>;
         windsorFrameworkDetails: z.ZodObject<{
             movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
             notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -33,6 +35,7 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         }>>;
     }, "strip", z.ZodTypeAny, {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -42,6 +45,7 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         } | undefined;
     }, {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -348,12 +352,13 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
     }>>>;
     shipDate: z.ZodString;
     shipmentId: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
-    warehouseId: z.ZodEffects<z.ZodString, string, string>;
 }, {
     __mode: z.ZodLiteral<"browse_rates">;
 }>, "strip", z.ZodTypeAny, {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -419,10 +424,11 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         } | null;
     }[];
     shipDate: string;
-    warehouseId: string;
 }, {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -492,10 +498,11 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         };
     }[];
     shipDate: string;
-    warehouseId: string;
 }> | z.ZodObject<z.extendShape<{
+    addressId: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     advancedOptions: z.ZodNullable<z.ZodOptional<z.ZodObject<{
         additionalHandling: z.ZodOptional<z.ZodBoolean>;
+        canadaDeliveredDuty: z.ZodNullable<z.ZodOptional<z.ZodDefault<z.ZodNativeEnum<typeof CanadaDeliveredDutyOptions>>>>;
         windsorFrameworkDetails: z.ZodObject<{
             movementIndicator: z.ZodNativeEnum<typeof SE.MovementIndicator>;
             notAtRisk: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
@@ -517,6 +524,7 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         }>>;
     }, "strip", z.ZodTypeAny, {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -526,6 +534,7 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         } | undefined;
     }, {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -832,7 +841,6 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
     }>>>;
     shipDate: z.ZodString;
     shipmentId: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
-    warehouseId: z.ZodEffects<z.ZodString, string, string>;
 }, {
     __mode: z.ZodLiteral<"select_service">;
     packages: z.ZodArray<z.ZodObject<z.extendShape<{
@@ -1151,8 +1159,10 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         serviceCode: string;
     }>;
 }>, "strip", z.ZodTypeAny, {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -1218,10 +1228,11 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         serviceCode: string;
     };
     shipDate: string;
-    warehouseId: string;
 }, {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -1287,7 +1298,6 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         serviceCode: string;
     };
     shipDate: string;
-    warehouseId: string;
 }>>, {
     carrierId: string | undefined;
     customs: {
@@ -1424,8 +1434,10 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         } | null;
     })[];
     serviceCode: string | undefined;
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -1439,7 +1451,6 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
     confirmation: SE.ConfirmationType;
     insuranceProvider: SE.InsuranceProviderType;
     shipDate: string;
-    warehouseId: string;
 } | {
     carrierId: string | undefined;
     customs: {
@@ -1576,8 +1587,10 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         } | null;
     })[];
     serviceCode: string | undefined;
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             movementIndicator: SE.MovementIndicator;
             notAtRisk: boolean;
@@ -1591,10 +1604,11 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
     confirmation: SE.ConfirmationType;
     insuranceProvider: SE.InsuranceProviderType;
     shipDate: string;
-    warehouseId: string;
 }, {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -1664,10 +1678,11 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         };
     }[];
     shipDate: string;
-    warehouseId: string;
 } | {
+    addressId?: string | null | undefined;
     advancedOptions?: {
         additionalHandling?: boolean | undefined;
+        canadaDeliveredDuty?: CanadaDeliveredDutyOptions | null | undefined;
         windsorFrameworkDetails?: {
             notAtRisk?: boolean | undefined;
             movementIndicator: SE.MovementIndicator;
@@ -1733,7 +1748,6 @@ export declare const getShipmentSchema: ({ dimensionsUnit, isContentDescriptionR
         serviceCode: string;
     };
     shipDate: string;
-    warehouseId: string;
 }>;
 type ShipmentSchema = ReturnType<typeof getShipmentSchema>;
 export type ShipmentFormFields = z.input<ShipmentSchema>;

package/src/components/templates/suspend-purchase/index.d.ts

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

package/src/components/templates/suspend-purchase/suspend-purchase.d.ts

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