@shipengine/elements 0.17.3 → 0.19.0

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

@@ -1,9 +1,10 @@
 import { SE } from "@shipengine/api";
+import { WarehousePayload } from "../manage-warehouses";
 export type WarehouseFormProps = {
     isOnboarding?: boolean;
     onCancel?: () => void;
     onDelete?: () => void;
-    onSubmit: (payload: Omit<SE.Warehouse, "createdAt" | "warehouseId">) => void;
+    onSubmit: (payload: WarehousePayload) => void;
     submitButtonTitle: string;
     warehouse?: SE.Warehouse;
 };

package/components/templates/warehouse-preference-select/index.d.ts

@@ -0,0 +1 @@
+export * from "./warehouse-preference-select";

package/components/templates/warehouse-preference-select/warehouse-preference-select.d.ts

@@ -0,0 +1,24 @@
+import { SE } from "@shipengine/api";
+export type WarehouseSuggested = {
+    validation: SE.AddressValidation;
+    validationType: "SUGGESTED";
+};
+export type WarehouseError = {
+    validation: SE.AddressValidation;
+    validationType: "ERROR";
+};
+export type WarehouseExactOrSoft = {
+    address: SE.Address;
+    validationType: "EXACT" | "SOFT";
+};
+export type WarehouseAddressPreference = WarehouseSuggested | WarehouseError | WarehouseExactOrSoft;
+export type WarehousePreferenceFormProps = {
+    onCancel: () => void;
+    onSubmit: (payload: {
+        originAddress: SE.Address;
+        returnAddress?: SE.Address;
+    }) => Promise<void> | void;
+    originAddress: WarehouseAddressPreference;
+    returnAddress?: WarehouseAddressPreference;
+};
+export declare const WarehousePreferenceSelect: ({ onCancel, onSubmit, originAddress, returnAddress, }: WarehousePreferenceFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/warehouse-preference-wizard/index.d.ts

@@ -0,0 +1 @@
+export * from "./warehouse-preference-wizard";

package/components/templates/warehouse-preference-wizard/warehouse-preference-wizard.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/api";
+import { ManageWarehousesProps, WarehousePayload } from "../manage-warehouses";
+import { WarehouseAddressPreference } from "../warehouse-preference-select";
+export type WarehousePreference = {
+    isDefault?: boolean;
+    name: string;
+    originAddress: WarehouseAddressPreference;
+    returnAddress?: WarehouseAddressPreference;
+};
+export type WarehousePreferenceWizardProps = {
+    className?: string;
+    formHeader?: React.ReactNode;
+    isOnboarding?: boolean;
+    onSubmit: (payload: WarehousePayload) => Promise<void> | void;
+    onValidate: ManageWarehousesProps["onValidate"];
+    onWarehouseDelete?: () => Promise<void> | void;
+    onWarehouseFormCancel?: () => void;
+    submitButtonTitle: string;
+    warehouse?: SE.Warehouse;
+    warehousePreference?: WarehousePreference;
+};
+export declare const WarehousePreferenceWizard: ({ className, formHeader, isOnboarding, onSubmit, onValidate, onWarehouseDelete, onWarehouseFormCancel, submitButtonTitle, warehouse, warehousePreference, }: WarehousePreferenceWizardProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/components/index.d.ts

@@ -4,4 +4,5 @@ export * from "./manage-warehouses";
 export * from "./onboarding";
 export * from "./purchase-label";
 export * from "./shipment";
+export * from "./wallet-history";
 export * from "./void-label";

package/elements/components/manage-warehouses/manage-warehouses.d.ts

@@ -1,2 +1,5 @@
-export type ManageWarehousesProps = {};
-export declare const ManageWarehouses: () => import("@emotion/react/jsx-runtime").JSX.Element;
+import { Templates } from "../../../components";
+export type ManageWarehousesProps = {
+    onWarehouseAddressValidation?: (originAddressPreference: Templates.AddressPreference, returnAddressPreference?: Templates.AddressPreference) => Promise<void> | void;
+};
+export declare const ManageWarehouses: ({ onWarehouseAddressValidation }: ManageWarehousesProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/components/wallet-history/index.d.ts

@@ -0,0 +1 @@
+export * from "./wallet-history";

package/elements/components/wallet-history/wallet-history.d.ts

@@ -0,0 +1 @@
+export declare const WalletHistory: () => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/index.d.ts

@@ -2,5 +2,6 @@ export { Element as ListCarriers } from "./list-carriers";
 export { Element as ManageWarehouses } from "./manage-warehouses";
 export { Element as PurchaseLabel } from "./purchase-label";
 export { Element as Onboarding } from "./onboarding";
+export { Element as WalletHistory } from "./wallet-history";
 export { Element as ViewShipment } from "./view-shipment";
 export { Element as VoidLabel } from "./void-label";

package/elements/manage-warehouses.d.ts

@@ -1 +1 @@
-export declare const Element: (props: Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: (props: import("./components/manage-warehouses").ManageWarehousesProps & Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/elements/wallet-history.d.ts

@@ -0,0 +1 @@
+export declare const Element: (props: Record<string, unknown>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/factories/shipengine/index.d.ts

@@ -8,5 +8,6 @@ export * from "./resource";
 export * from "./sales-order";
 export * from "./service";
 export * from "./shipment";
+export * from "./wallet-history";
 export * from "./warehouse";
 export * from "./weight";

package/factories/shipengine/wallet-history.d.ts

@@ -0,0 +1,14 @@
+import { Factory } from "fishery";
+import { SE } from "@shipengine/api";
+/**
+ * Wallet Transaction Factory
+ *
+ * @category Factories
+ */
+export declare const walletTransactionFactory: Factory<SE.WalletTransaction, any, SE.WalletTransaction>;
+/**
+ * Wallet History Factory
+ *
+ * @category Factories
+ */
+export declare const walletHistoryFactory: (currentPage?: number, count?: number) => Factory<SE.WalletTransactionHistory, any, SE.WalletTransactionHistory>;

package/factories/shipengine/warehouse.d.ts

@@ -1,6 +1,8 @@
 import { Factory } from "fishery";
 import { SE } from "@shipengine/api";
+import { Templates } from "../../components";
 /**
  * @category Factories
  */
 export declare const warehouseFactory: Factory<SE.Warehouse, any, SE.Warehouse>;
+export declare const warehouseAddressPreferenceFactory: Factory<Templates.WarehouseAddressPreference, any, Templates.WarehouseAddressPreference>;

package/hooks/index.d.ts

@@ -6,3 +6,4 @@ export * from "./use-page-layout";
 export * from "./use-root-portal";
 export * from "./use-run-once-on-true";
 export * from "./use-toggle";
+export * from "./use-warehouse-validation";

package/hooks/use-warehouse-validation.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+import { SE } from "@shipengine/api";
+import { Templates } from "../components";
+export declare const useWarehouseValidation: () => {
+    errors: SE.CodedError[] | null;
+    setWarehousePreference: import("react").Dispatch<import("react").SetStateAction<Templates.WarehousePreference | undefined>>;
+    validate: (warehouse: Partial<SE.Warehouse> & Pick<SE.Warehouse, "name" | "originAddress" | "isDefault">) => Promise<{
+        isDefault: boolean;
+        name: string;
+        originAddress: Templates.WarehouseAddressPreference;
+        returnAddress: Templates.WarehouseAddressPreference;
+    }>;
+    warehousePreference: Templates.WarehousePreference | undefined;
+};