@shipengine/elements 0.16.1 → 0.17.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/components/items-breakdown/items-breakdown.d.ts +1 -1
  2. package/components/templates/completion-page/completion-page.d.ts +4 -0
  3. package/components/templates/completion-page/index.d.ts +1 -0
  4. package/components/templates/index.d.ts +2 -1
  5. package/components/templates/list-carriers-row/list-carriers-row.styles.d.ts +1 -1
  6. package/components/templates/shipment-form/shipment-form.d.ts +1 -1
  7. package/components/templates/suspend-sales-order/index.d.ts +1 -0
  8. package/components/templates/suspend-sales-order/suspend-sales-order.d.ts +8 -0
  9. package/components/templates/suspend-shipment/index.d.ts +1 -0
  10. package/components/templates/suspend-shipment/suspend-shipment.d.ts +8 -0
  11. package/elements/components/configure-shipment/configure-shipment.d.ts +1 -1
  12. package/elements/components/configure-shipment/hooks/use-address.d.ts +1 -1
  13. package/elements/components/configure-shipment/hooks/use-shipment-form.d.ts +2 -2
  14. package/elements/components/index.d.ts +1 -1
  15. package/elements/components/{sales-order → purchase-label}/hooks/use-configure-shipment.d.ts +1 -1
  16. package/elements/components/purchase-label/hooks/use-load-shipment.d.ts +9 -0
  17. package/elements/components/purchase-label/index.d.ts +3 -0
  18. package/elements/components/{sales-order/sales-order.d.ts → purchase-label/purchase-label-by-sales-order.d.ts} +1 -1
  19. package/elements/components/purchase-label/purchase-label-by-shipment.d.ts +9 -0
  20. package/elements/components/purchase-label/purchase-label.d.ts +6 -0
  21. package/elements/purchase-label.d.ts +3 -1
  22. package/hooks/use-elements.d.ts +2 -1
  23. package/index.cjs +330 -198
  24. package/index.js +331 -200
  25. package/package.json +3 -3
  26. package/utilities/shipengine/sales-order.d.ts +10 -0
  27. package/components/templates/sales-order/index.d.ts +0 -1
  28. package/components/templates/sales-order/sales-order.d.ts +0 -8
  29. package/elements/components/sales-order/index.d.ts +0 -1
  30. /package/elements/components/{sales-order → purchase-label}/hooks/index.d.ts +0 -0
  31. /package/elements/components/{sales-order → purchase-label}/hooks/use-import-sales-order.d.ts +0 -0
  32. /package/elements/components/{sales-order → purchase-label}/hooks/use-pending-shipment.d.ts +0 -0
@@ -6,7 +6,7 @@ export type Item = {
6
6
  subDetail?: string;
7
7
  subDetailValue?: SE.Money;
8
8
  totalValue?: SE.Money;
9
- value: SE.Money;
9
+ value?: SE.Money;
10
10
  };
11
11
  export type ItemsBreakdownProps = {
12
12
  items: Item[];
@@ -0,0 +1,4 @@
1
+ export type CompletionPageProps = {
2
+ onContinue: () => void;
3
+ };
4
+ export declare const CompletionPage: ({ onContinue }: CompletionPageProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1 @@
1
+ export * from "./completion-page";
@@ -12,9 +12,10 @@ export * from "./list-carriers";
12
12
  export * from "./manage-warehouses";
13
13
  export * from "./onboarding";
14
14
  export * from "./rate-form";
15
- export * from "./sales-order";
15
+ export * from "./suspend-sales-order";
16
16
  export * from "./shipment-form";
17
17
  export * from "./shipment";
18
+ export * from "./suspend-shipment";
18
19
  export * from "./warehouse-form";
19
20
  export * from "./void-label";
20
21
  export * from "./wallet-form";
@@ -1 +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>>;
1
+ export declare const getStyles: (isConnected?: boolean) => Record<"connectButton" | "container" | "logoContainer" | "rowContainer", import("@emotion/serialize").Interpolation<import("@packlink/brands/dist/js/theme/Theme").Theme>>;
@@ -30,7 +30,7 @@ export type ShipmentFormProps = {
30
30
  onSubmitParseShipTo: (payload: AddressParserPayload) => Promise<SE.AddressExtraction | undefined>;
31
31
  onToggleAddressPreferenceDisclosure?: AddressPreferenceDisplayProps["onToggleDisclosure"];
32
32
  onUpdateCustoms?: (customs: SE.Customs) => Promise<SE.SalesOrderShipment | undefined>;
33
- salesOrder: SE.SalesOrder;
33
+ salesOrder?: SE.SalesOrder;
34
34
  shipment?: SE.SalesOrderShipment;
35
35
  shippingPresets?: UseShippingPresetsOptionsProps;
36
36
  warehouseId?: string;
@@ -0,0 +1 @@
1
+ export * from "./suspend-sales-order";
@@ -0,0 +1,8 @@
1
+ import { WithChildrenCommonProps } from "@packlink/giger";
2
+ import { SE } from "@shipengine/api";
3
+ export type SuspendSalesOrderProps = WithChildrenCommonProps<{
4
+ errors?: SE.CodedError[];
5
+ isLoading?: boolean;
6
+ salesOrder?: SE.SalesOrder;
7
+ }>;
8
+ export declare const SuspendSalesOrder: ({ children, errors, isLoading, salesOrder, }: SuspendSalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1 @@
1
+ export * from "./suspend-shipment";
@@ -0,0 +1,8 @@
1
+ import { WithChildrenCommonProps } from "@packlink/giger";
2
+ import { SE } from "@shipengine/api";
3
+ export type SuspendShipmentProps = WithChildrenCommonProps<{
4
+ errors?: SE.CodedError[];
5
+ isLoading?: boolean;
6
+ shipment?: SE.SalesOrderShipment;
7
+ }>;
8
+ export declare const SuspendShipment: ({ children, errors, isLoading, shipment, }: SuspendShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -24,7 +24,7 @@ export type ConfigureShipmentProps = {
24
24
  onShipmentUpdated: UseShipmentFormProps["onShipmentUpdated"];
25
25
  onToggleAddressPreferenceDisclosure?: Templates.ShipmentFormProps["onToggleAddressPreferenceDisclosure"];
26
26
  printLabelLayout?: UseRatesFormProps["printLabelLayout"];
27
- salesOrder: SE.SalesOrder;
27
+ salesOrder?: SE.SalesOrder;
28
28
  shipment?: SE.SalesOrderShipment;
29
29
  shippingPresets?: UseShippingPresetsOptionsProps;
30
30
  warehouseId?: string;
@@ -5,7 +5,7 @@ export type UseAddressProps = {
5
5
  compatibleCountryCodes?: CountryCode[];
6
6
  onChange?: (oldShipment: SE.SalesOrderShipment, updatedShipment: SE.SalesOrderShipment) => Promise<void> | void;
7
7
  onValidation?: (addressPreference: Templates.AddressPreference) => Promise<void> | void;
8
- salesOrder: SE.SalesOrder;
8
+ salesOrder?: SE.SalesOrder;
9
9
  shipment?: SE.SalesOrderShipment;
10
10
  };
11
11
  export declare const useAddress: ({ compatibleCountryCodes, onChange, onValidation, salesOrder, shipment, }: UseAddressProps) => {
@@ -9,7 +9,7 @@ export type UseShipmentFormProps = {
9
9
  onChangeAddress?: UseAddressProps["onChange"];
10
10
  onShipmentUpdated?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
11
11
  onSubmit?: (shipment: SE.SalesOrderShipment) => Promise<void> | void;
12
- salesOrder: SE.SalesOrder;
12
+ salesOrder?: SE.SalesOrder;
13
13
  shipment?: SE.SalesOrderShipment;
14
14
  };
15
15
  export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValidation, onApplyPreset, onChangeAddress, onShipmentUpdated, onSubmit, salesOrder, shipment, }: UseShipmentFormProps) => {
@@ -25,7 +25,7 @@ export declare const useShipmentForm: ({ compatibleCountryCodes, onAddressValida
25
25
  fullAddress: string;
26
26
  }) => Promise<SE.AddressExtraction>;
27
27
  onUpdateCustoms: (customs: SE.Customs) => Promise<SE.SalesOrderShipment>;
28
- salesOrder: SE.SalesOrder;
28
+ salesOrder: SE.SalesOrder | undefined;
29
29
  shipment: SE.SalesOrderShipment | undefined;
30
30
  warehouses: SE.Warehouse[] | undefined;
31
31
  };
@@ -2,6 +2,6 @@ export * from "./configure-shipment";
2
2
  export * from "./list-carriers";
3
3
  export * from "./manage-warehouses";
4
4
  export * from "./onboarding";
5
- export * from "./sales-order";
5
+ export * from "./purchase-label";
6
6
  export * from "./shipment";
7
7
  export * from "./void-label";
@@ -8,7 +8,7 @@ export type UseConfigureShipmentProps = {
8
8
  salesOrder?: SE.SalesOrder;
9
9
  warehouseId?: UsePendingShipmentProps["warehouseId"];
10
10
  };
11
- export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, }: UseConfigureShipmentProps) => {
11
+ export declare const useConfigureShipment: ({ onLoad, onShipmentUpdated, salesOrder, warehouseId, printLabelLayout, }: UseConfigureShipmentProps) => {
12
12
  errors: SE.CodedError[] | undefined;
13
13
  isLoading: boolean;
14
14
  onShipmentUpdated: (shipment: SE.SalesOrderShipment) => Promise<void>;
@@ -0,0 +1,9 @@
1
+ export type UseLoadShipmentProps = {
2
+ shipmentId: string;
3
+ };
4
+ export declare const useLoadShipment: ({ shipmentId }: UseLoadShipmentProps) => {
5
+ errors: import("@shipengine/api").CodedError[] | undefined;
6
+ isLoading: boolean;
7
+ 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[]>>;
8
+ shipment: import("@shipengine/api").SalesOrderShipment | undefined;
9
+ };
@@ -0,0 +1,3 @@
1
+ export * from "./purchase-label-by-sales-order";
2
+ export * from "./purchase-label";
3
+ export * from "./purchase-label-by-shipment";
@@ -23,4 +23,4 @@ export type SalesOrderProps = {
23
23
  shippingPresets?: UseShippingPresetsOptionsProps;
24
24
  warehouseId?: UseConfigureShipmentProps["warehouseId"];
25
25
  };
26
- export declare const SalesOrder: ({ features, externalOrderId, externalOrderNumber, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, warehouseId, printLabelLayout, ...props }: SalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
26
+ export declare const PurchaseLabelBySalesOrder: ({ features, externalOrderId, externalOrderNumber, onLoad, onShipmentUpdated, orderSourceCode, salesOrderId, warehouseId, printLabelLayout, ...props }: SalesOrderProps) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { ReactNode } from "react";
2
+ import { SalesOrderProps } from "./purchase-label-by-sales-order";
3
+ type ShipmentOrderProps = {
4
+ children?: ReactNode;
5
+ shipmentId: string;
6
+ };
7
+ type PurchaseLabelByShipmentProps = Partial<SalesOrderProps> & ShipmentOrderProps;
8
+ export declare const PurchaseLabelByShipment: ({ shipmentId, onLoad, onShipmentUpdated, features, ...props }: PurchaseLabelByShipmentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
9
+ export {};
@@ -0,0 +1,6 @@
1
+ import { SalesOrderProps } from "./purchase-label-by-sales-order";
2
+ type PurchaseLabelProps = SalesOrderProps & {
3
+ shipmentId?: string;
4
+ };
5
+ export declare const PurchaseLabel: ({ shipmentId, ...props }: PurchaseLabelProps) => import("@emotion/react/jsx-runtime").JSX.Element;
6
+ export {};
@@ -1 +1,3 @@
1
- export declare const Element: (props: import("./components/sales-order").SalesOrderProps & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;
1
+ export declare const Element: (props: import("./components").SalesOrderProps & {
2
+ shipmentId?: string | undefined;
3
+ } & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;
@@ -1,4 +1,5 @@
1
1
  /// <reference types="react" />
2
+ import { ShipEngineProviderProps } from "@shipengine/react";
2
3
  export type ElementsEnvironment = `dde:${string}` | "development" | "staging" | "production";
3
4
  export type ElementsErrorHandler = (err: Error, context: {
4
5
  componentStack: string;
@@ -18,7 +19,7 @@ export interface ElementsProviderProps {
18
19
  brandName?: string;
19
20
  children: JSX.Element;
20
21
  environment?: ElementsEnvironment;
21
- getToken: () => string;
22
+ getToken: ShipEngineProviderProps["getToken"];
22
23
  onError?: ElementsErrorHandler;
23
24
  proxyTarget?: string;
24
25
  }