@shipengine/elements 0.9.0 → 0.9.1

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

@@ -0,0 +1,27 @@
+/// <reference types="react" />
+import { Templates } from "@shipengine/elements-ui";
+import * as SE from "@shipengine/types";
+import { UseShippingPresetsOptionsProps } from "@shipengine/elements-ui";
+import { UseRatesFormProps, UseShipmentFormProps } from "./hooks";
+export declare type ShipmentFormMode = "browse_rates" | "select_service";
+export declare type ConfigureShipmentProps = {
+    errors?: Templates.ShipmentFormProps["errors"];
+    isLoading?: Templates.ShipmentFormProps["isLoading"];
+    onAddressValidation?: UseShipmentFormProps["onAddressValidation"];
+    onApplyPreset?: UseShipmentFormProps["onApplyPreset"];
+    onBeforeLabelCreate?: UseRatesFormProps["onBeforeLabelCreate"];
+    onChangeAddress?: UseShipmentFormProps["onChangeAddress"];
+    onChangeShipmentFormMode?: Templates.ShipmentFormProps["onChangeMode"];
+    onLabelCreateFailure?: UseRatesFormProps["onLabelCreateFailure"];
+    onLabelCreateSuccess?: UseRatesFormProps["onLabelCreateSuccess"];
+    onRateSaved?: UseRatesFormProps["onRateSaved"];
+    onRatesCalculated?: UseRatesFormProps["onRatesCalculated"];
+    onShipmentUpdated: UseShipmentFormProps["onShipmentUpdated"];
+    onToggleAddressPreferenceDisclosure?: Templates.ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
+    printLabelLayout?: UseRatesFormProps["printLabelLayout"];
+    salesOrder: SE.SalesOrder;
+    shipment?: SE.SalesOrderShipment;
+    shippingPresets?: UseShippingPresetsOptionsProps;
+    warehouseId?: string;
+};
+export declare const ConfigureShipment: ({ onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, salesOrder, shipment, ...props }: ConfigureShipmentProps) => JSX.Element;

package/components/configure-shipment/hooks/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./use-address";
+export * from "./use-customs";
+export * from "./use-presets";
+export * from "./use-rates-form";
+export * from "./use-shipment-form";

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

@@ -0,0 +1,14 @@
+import { Templates } from "@shipengine/elements-ui";
+import * as SE from "@shipengine/types";
+export declare type UseAddressProps = {
+    onChange?: (oldShipment: SE.SalesOrderShipment, updatedShipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onValidation?: (addressPreference: Templates.AddressPreference) => Promise<void> | void;
+    salesOrder: SE.SalesOrder;
+    shipment?: SE.SalesOrderShipment;
+};
+export declare const useAddress: ({ onChange, onValidation, salesOrder, shipment }: UseAddressProps) => {
+    addressErrors: SE.CodedError[] | undefined;
+    addressPreference: Templates.AddressPreference | undefined;
+    handleChangeAddress: (shipTo: SE.Address, { shouldValidate }: Templates.OnChangeAddressOptions) => Promise<void>;
+    handleParseShipTo: ({ fullAddress }: Templates.AddressParserPayload) => Promise<SE.AddressParseResponse | undefined>;
+};

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

@@ -0,0 +1,9 @@
+import * as SE from "@shipengine/types";
+export declare type UseCustomsProps = {
+    onUpdate?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    shipment?: SE.SalesOrderShipment;
+};
+export declare const useCustoms: ({ onUpdate, shipment }: UseCustomsProps) => {
+    handleUpdateCustoms: (customs: SE.Customs) => Promise<void>;
+    customsErrors: SE.CodedError[] | undefined;
+};

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

@@ -0,0 +1,10 @@
+import { ShippingPreset } from "@shipengine/elements-core";
+import * as SE from "@shipengine/types";
+export declare type UsePresetsProps = {
+    onApply?: (preset: ShippingPreset, shipment: SE.SalesOrderShipment) => Promise<void>;
+    shipment?: SE.SalesOrderShipment;
+};
+export declare const usePresets: ({ onApply, shipment }: UsePresetsProps) => {
+    handleApplyPreset: (preset: ShippingPreset) => Promise<void>;
+    presetErrors: SE.CodedError[] | undefined;
+};

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

@@ -0,0 +1,23 @@
+import * as SE from "@shipengine/types";
+import { UseRequestRatesProps } from "./use-request-rates";
+export declare type UseRatesFormProps = {
+    onBeforeLabelCreate?: (rate: SE.Rate, shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onLabelCreateFailure?: (rate: SE.Rate, shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onLabelCreateSuccess?: (label: SE.Label, shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onRateSaved?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    onRatesCalculated?: UseRequestRatesProps["onRatesCalculated"];
+    onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
+    printLabelLayout?: string;
+    shipment?: SE.SalesOrderShipment;
+};
+export declare const useRatesForm: ({ onBeforeLabelCreate, onLabelCreateFailure, onLabelCreateSuccess, onRateSaved, onRatesCalculated, onShipmentUpdated, printLabelLayout, shipment, }: UseRatesFormProps) => {
+    carriers: SE.Carrier[] | undefined;
+    errors: SE.CodedError[] | undefined;
+    isLoading: boolean;
+    onSave: ({ carrierId, serviceCode }: Pick<SE.Rate, "carrierId" | "serviceCode">) => Promise<void>;
+    onSubmit: (rateId: string) => Promise<void>;
+    rates: SE.Rate[] | undefined;
+    requestRates: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    resetRates: () => void;
+    shipment: SE.SalesOrderShipment | undefined;
+};

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

@@ -0,0 +1,11 @@
+import * as SE from "@shipengine/types";
+export declare type UseRequestRatesProps = {
+    onRatesCalculated?: (rates: SE.Rate[], shipment: SE.SalesOrderShipment) => Promise<void> | void;
+};
+export declare const useRequestRates: ({ onRatesCalculated }: UseRequestRatesProps) => {
+    ratesCalculating: boolean;
+    ratesErrors: SE.CodedError[] | undefined;
+    ratesResponse: SE.RateResponse | undefined;
+    requestRates: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    resetRates: () => void;
+};

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

@@ -0,0 +1,29 @@
+import { ShippingPreset } from "@shipengine/elements-core";
+import * as SE from "@shipengine/types";
+import { UseAddressProps } from "./use-address";
+import { UsePresetsProps } from "./use-presets";
+export declare type UseShipmentFormProps = {
+    onAddressValidation?: UseAddressProps["onValidation"];
+    onApplyPreset?: UsePresetsProps["onApply"];
+    onChangeAddress?: UseAddressProps["onChange"];
+    onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    onSubmit?: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    salesOrder: SE.SalesOrder;
+    shipment?: SE.SalesOrderShipment;
+};
+export declare const useShipmentForm: ({ onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, }: UseShipmentFormProps) => {
+    addressPreference: import("dist/elements-ui/components/templates").AddressPreference | undefined;
+    carriers: SE.Carrier[] | undefined;
+    customPackageTypes: SE.Package[] | undefined;
+    errors: SE.CodedError[] | undefined;
+    onApplyPreset: (preset: ShippingPreset) => Promise<void>;
+    onChangeAddress: (shipTo: SE.Address, { shouldValidate }: import("dist/elements-ui/components/templates").OnChangeAddressOptions) => Promise<void>;
+    onSubmit: (values: Partial<SE.SalesOrderShipment>) => Promise<void>;
+    onSubmitParseShipTo: ({ fullAddress }: {
+        fullAddress: string;
+    }) => Promise<SE.AddressParseResponse | undefined>;
+    onUpdateCustoms: (customs: SE.Customs) => Promise<void>;
+    salesOrder: SE.SalesOrder;
+    shipment: SE.SalesOrderShipment | undefined;
+    warehouses: SE.Warehouse[] | undefined;
+};

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

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

package/components/index.d.ts

@@ -1,5 +1,4 @@
-export * from "./rate-form";
+export * from "./configure-shipment";
 export * from "./sales-order";
 export * from "./shipment";
-export * from "./shipment-form";
 export * from "./void-label";

package/components/sales-order/hooks/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./use-configure-shipment";
+export * from "./use-import-sales-order";
+export * from "./use-pending-shipment";

package/components/sales-order/hooks/use-configure-shipment.d.ts

@@ -0,0 +1,16 @@
+import * as SE from "@shipengine/types";
+import { ConfigureShipmentProps } from "../../configure-shipment";
+import { UsePendingShipmentProps } from "./use-pending-shipment";
+export declare type UseConfigureShipmentProps = {
+    onLoad?: UsePendingShipmentProps["onLoad"];
+    onShipmentUpdated?: ConfigureShipmentProps["onShipmentUpdated"];
+    salesOrder?: SE.SalesOrder;
+    warehouseId?: UsePendingShipmentProps["warehouseId"];
+};
+export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, }: UseConfigureShipmentProps) => {
+    errors: SE.CodedError[] | undefined;
+    isLoading: boolean;
+    onShipmentUpdated: (shipment: SE.SalesOrderShipment) => Promise<void>;
+    shipment: SE.SalesOrderShipment | undefined;
+    warehouseId: string | undefined;
+};

package/components/sales-order/hooks/use-import-sales-order.d.ts

@@ -0,0 +1,11 @@
+export declare type UseImportSalesOrderProps = {
+    externalOrderId?: string;
+    externalOrderNumber?: string;
+    orderSourceCode?: string;
+    salesOrderId?: string;
+};
+export declare const useImportSalesOrder: ({ externalOrderId, externalOrderNumber, orderSourceCode, salesOrderId, }: UseImportSalesOrderProps) => {
+    errors: import("dist/shipengine-types/src").CodedError[] | undefined;
+    isLoading: boolean;
+    salesOrder: import("dist/shipengine-types/src").SalesOrder | undefined;
+};

package/components/sales-order/hooks/use-pending-shipment.d.ts

@@ -0,0 +1,12 @@
+import * as SE from "@shipengine/types";
+export declare type UsePendingShipmentProps = {
+    onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[], pendingShipment?: SE.SalesOrderShipment) => Promise<void>;
+    salesOrder?: SE.SalesOrder;
+    warehouseId?: string;
+};
+export declare const usePendingShipment: ({ onLoad, salesOrder, warehouseId, }: UsePendingShipmentProps) => {
+    isPendingShipmentLoading: boolean;
+    pendingShipment: SE.SalesOrderShipment | undefined;
+    pendingShipmentErrors: SE.CodedError[] | undefined;
+    reloadPendingShipment: () => Promise<SE.SalesOrderShipment | undefined>;
+};

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

@@ -1,27 +1,26 @@
 /// <reference types="react" />
-import * as SE from "@shipengine/types";
-import { Templates, UseShippingPresetsOptionsProps } from "@shipengine/elements-ui";
-import { ShipmentFormProps } from "../shipment-form";
-import { RateFormProps } from "../rate-form";
+import { UseShippingPresetsOptionsProps } from "@shipengine/elements-ui";
+import { ConfigureShipmentProps } from "../configure-shipment";
+import { UseConfigureShipmentProps, UseImportSalesOrderProps } from "./hooks";
 export declare type SalesOrderProps = {
-    externalOrderId?: string;
-    externalOrderNumber?: string;
-    onAddressValidation?: (addressPreference: Templates.AddressPreference) => Promise<void> | void;
-    onApplyPreset?: ShipmentFormProps["onApplyPreset"];
-    onBeforeLabelCreate?: RateFormProps["onBeforeLabelCreate"];
-    onChangeAddress?: ShipmentFormProps["onChangeAddress"];
-    onChangeShipmentFormMode?: ShipmentFormProps["onChangeShipmentFormMode"];
-    onLabelCreateFailure?: RateFormProps["onLabelCreateFailure"];
-    onLabelCreateSuccess?: RateFormProps["onLabelCreateSuccess"];
-    onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[]) => Promise<void> | void;
-    onRateSaved?: RateFormProps["onRateSaved"];
-    onRatesReturned?: (rates: SE.Rate[], shipment: SE.SalesOrderShipment) => Promise<void> | void;
-    onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
-    onToggleAddressPreferenceDisclosure?: ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
-    orderSourceCode?: string;
-    printLabelLayout?: RateFormProps["printLabelLayout"];
-    salesOrderId?: string;
+    externalOrderId?: UseImportSalesOrderProps["externalOrderId"];
+    externalOrderNumber?: UseImportSalesOrderProps["externalOrderNumber"];
+    onAddressValidation?: ConfigureShipmentProps["onAddressValidation"];
+    onApplyPreset?: ConfigureShipmentProps["onApplyPreset"];
+    onBeforeLabelCreate?: ConfigureShipmentProps["onBeforeLabelCreate"];
+    onChangeAddress?: ConfigureShipmentProps["onChangeAddress"];
+    onChangeShipmentFormMode?: ConfigureShipmentProps["onChangeShipmentFormMode"];
+    onLabelCreateFailure?: ConfigureShipmentProps["onLabelCreateFailure"];
+    onLabelCreateSuccess?: ConfigureShipmentProps["onLabelCreateSuccess"];
+    onLoad?: UseConfigureShipmentProps["onLoad"];
+    onRateSaved?: ConfigureShipmentProps["onRateSaved"];
+    onRatesCalculated?: ConfigureShipmentProps["onRatesCalculated"];
+    onShipmentUpdated?: ConfigureShipmentProps["onShipmentUpdated"];
+    onToggleAddressPreferenceDisclosure?: ConfigureShipmentProps["onToggleAddressPreferenceDisclosure"];
+    orderSourceCode?: UseImportSalesOrderProps["orderSourceCode"];
+    printLabelLayout?: ConfigureShipmentProps["printLabelLayout"];
+    salesOrderId?: UseImportSalesOrderProps["salesOrderId"];
     shippingPresets?: UseShippingPresetsOptionsProps;
-    warehouseId?: string;
+    warehouseId?: UseConfigureShipmentProps["warehouseId"];
 };
-export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onAddressValidation, onApplyPreset, onBeforeLabelCreate, onChangeAddress, onChangeShipmentFormMode, onLabelCreateFailure, onLabelCreateSuccess, onLoad, onRateSaved, onRatesReturned, onShipmentUpdated, onToggleAddressPreferenceDisclosure, orderSourceCode, printLabelLayout, salesOrderId, shippingPresets, warehouseId, }: SalesOrderProps) => JSX.Element;
+export declare const SalesOrder: ({ externalOrderId, externalOrderNumber, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, warehouseId, ...props }: SalesOrderProps) => JSX.Element;