@shipengine/elements 0.15.0 → 0.16.1

package/locales/en/index.d.ts

@@ -50,11 +50,10 @@ declare const _default: {
         };
     };
     "register-wallet": {
-        agreeToTerms: string;
         sections: {
             setup: {
                 title: string;
-                subTitle: string;
+                subtitle: string;
                 descriptionTitle: string;
                 description: string;
             };
@@ -62,8 +61,42 @@ declare const _default: {
                 title: string;
                 cardSubTitle: string;
                 addressSubTitle: string;
+                info: string;
+            };
+            carriers: {
+                title: string;
+                subtitle: string;
+            };
+            notifications: {
+                error: {
+                    title: string;
+                };
+                info: {
+                    title: string;
+                    description: string;
+                };
+                poBox: {
+                    title: string;
+                    description: string;
+                };
+                carrier: {
+                    title: string;
+                    confirmAddress: string;
+                    description: string;
+                };
             };
         };
+        settings: {
+            title: string;
+            billing: {
+                title: string;
+                subtitle: string;
+            };
+        };
+    };
+    "register-carrier": {
+        formTitle: string;
+        agreeToTerms: string;
     };
     "purchase-label": {
         actions: {
@@ -149,13 +182,53 @@ declare const _default: {
             rate_other: string;
         };
     };
+    onboarding: {
+        inlineTitle: string;
+        landing: {
+            action: string;
+            title: string;
+            subtitle: string;
+            descriptionTitle: string;
+            description: string;
+        };
+        steps: {
+            login: string;
+            carriers: string;
+            addresses: string;
+            payment: string;
+        };
+        warehouse: {
+            title: string;
+            subtitle: string;
+            inlineMessage: string;
+        };
+        success: {
+            title: string;
+            subtitle: string;
+            action: string;
+        };
+    };
     "manage-warehouses": {
+        addNew: string;
+        contactName: string;
+        default: string;
+        isDefault: string;
+        locationName: string;
+        residentialAddress: string;
         returnTo: string;
+        returnToAddressIsDifferent: string;
+        setDefault: string;
         shipFrom: string;
     };
     "manage-funding": {
-        addFunds: string;
+        actions: {
+            addFunds: string;
+            addFundsAndPurchase: string;
+            addNow: string;
+            saveRule: string;
+        };
         autoFunding: {
+            addFundsAutomatically: string;
             error: {
                 title: string;
                 message: string;
@@ -166,7 +239,8 @@ declare const _default: {
             maximumPurchasesPerDay: string;
             purchaseAmount: string;
         };
-        otp: {
+        addFunds: {
+            custom: string;
             error: {
                 title: string;
                 message: string;
@@ -174,17 +248,43 @@ declare const _default: {
             isLoading: string;
             labels: {
                 amount: string;
-                currentBalance: string;
-                resultingBalance: string;
             };
             minimumPurchaseAmount: string;
         };
+        fundAndPurchase: {
+            finalBalance: string;
+            insufficientFunds: string;
+            insufficientFundsTitle: string;
+            negativeBalance: string;
+            negativeBalanceTitle: string;
+            newBalance: string;
+        };
+        errors: {
+            balanceUnknown: string;
+            unableToFindBalance: string;
+        };
+        currentBalance: string;
         maximumBalanceAmount: string;
     };
+    "list-carriers": {
+        headers: {
+            accountCarriers: string;
+            carriers: string;
+            settings: string;
+        };
+        actions: {
+            status: {
+                connected: string;
+                notConnected: string;
+            };
+        };
+    };
     common: {
         actions: {
             add: string;
             cancel: string;
+            close: string;
+            confirm: string;
             continue: string;
             delete: string;
             edit: string;
@@ -195,6 +295,7 @@ declare const _default: {
             save: string;
             skipForNow: string;
             submit: string;
+            tryAgain: string;
         };
         address: {
             fields: {
@@ -208,6 +309,7 @@ declare const _default: {
                 postalCode: string;
                 phone: string;
                 email: string;
+                addressResidentialIndicator: string;
             };
             subFields: {
                 optional: string;
@@ -234,6 +336,7 @@ declare const _default: {
         };
         billing: {
             fields: {
+                differentBillingAddress: string;
                 name: string;
                 cardNumber: string;
                 expirationMonth: string;
@@ -245,6 +348,10 @@ declare const _default: {
             fields: {
                 agreement: string;
             };
+            terms: {
+                agreeToTerms: string;
+                title: string;
+            };
         };
         charsetWarnings: {
             name: {
@@ -297,12 +404,14 @@ declare const _default: {
             invalidNameOrCompany: string;
             noWarehouses: string;
             unableToLoad: {
+                carrier: string;
                 carriers: string;
                 salesOrder: string;
                 shipment: string;
                 warehouses: string;
             };
             unknown: string;
+            noRatesAvailable: string;
         };
         errorTypes: {
             accountStatus: string;
@@ -322,6 +431,7 @@ declare const _default: {
             thirdParty: string;
         };
         loading: {
+            carrier: string;
             carriers: string;
             data: string;
             importingSalesOrder: string;
@@ -350,13 +460,18 @@ declare const _default: {
         packageCodes: {
             package: string;
         };
+        schema: {
+            optionalLabel: string;
+        };
         schemaErrors: {
             notAValidPhoneNumber: string;
+            mustAgreeToTerms: string;
             group: {
                 allMeasurementsOrNone: string;
             };
             invalidAddressName: string;
             invalidAddressPoBox: string;
+            invalidCreditCardType: string;
             invalidPostalCode: string;
             invalidStateProvince: string;
             invalidString: string;
@@ -388,6 +503,7 @@ declare const _default: {
         "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
         QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
         "QWRkcmVzcyBub3QgZm91bmQ=": string;
+        QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
     };
 };
 export default _default;

package/mocks/browser.d.ts

@@ -0,0 +1 @@
+export declare const worker: false | import("msw").SetupWorkerApi;

package/mocks/carriers/handlers.d.ts

@@ -0,0 +1,12 @@
+import { DeepPartial } from "fishery";
+import { SE } from "@shipengine/api";
+export type CreateCarrierHandlersParams = {
+    get?: DeepPartial<SE.Carrier>;
+    list?: [count: number, listParams?: DeepPartial<SE.Carrier>];
+};
+export declare const createCarrierHandlers: (params?: CreateCarrierHandlersParams) => {
+    database: {
+        balanceAmount: number;
+    };
+    handlers: import("msw").RestHandler<import("msw/lib/glossary-de6278a9").M<import("msw/lib/glossary-de6278a9").h>>[];
+};

package/mocks/carriers/index.d.ts

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

package/mocks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./carriers";
+export * from "./warehouses";

package/mocks/server.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("msw/lib/SetupServerApi-39df862c").S;
+export default _default;

package/mocks/warehouses/handlers.d.ts

@@ -0,0 +1 @@
+export declare const warehouseHandlers: import("msw").RestHandler<import("msw/lib/glossary-de6278a9").M<import("msw/lib/glossary-de6278a9").h>>[];

package/mocks/warehouses/index.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.15.0",
+  "version": "0.16.1",
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "readmeFile": "../../README.md",
@@ -11,6 +11,9 @@
     "react-i18next": "*",
     "i18next": "*"
   },
+  "msw": {
+    "workerDirectory": "public"
+  },
   "module": "./index.js",
   "main": "./index.cjs",
   "type": "module",
@@ -19,21 +22,21 @@
     "react": "^18.2.0",
     "@emotion/react": "^11.10.0",
     "@packlink/brands": "^3.18.0",
-    "@shipengine/react": "0.15.0",
     "react-hook-form": "^7.31.2",
+    "@shipengine/api": "0.16.1",
+    "@shipengine/react": "0.16.1",
+    "zod": "^3.17.3",
     "@emotion/css": "^11.10.5",
     "humps": "^2.0.1",
     "react-datepicker": "^4.8.0",
-    "@shipengine/types": "0.15.0",
-    "zod": "^3.17.3",
+    "react-query": "^3.39.3",
     "react-dom": "^18.2.0",
     "libphonenumber-js": "^1.10.14",
-    "card-validator": "^8.1.1",
-    "js-base64": "^3.7.2",
     "@faker-js/faker": "^7.3.0",
+    "js-base64": "^3.7.2",
+    "card-validator": "^8.1.1",
     "i18next-browser-languagedetector": "^6.1.4",
     "stylis": "^4.1.2",
-    "swr": "^2.0.0-beta.5",
     "axios": "^0.26.1",
     "@hookform/resolvers": "2.9.1"
   }

package/register.d.ts

@@ -8,12 +8,9 @@ export interface ErrorFallbackProps {
  * @see {@link registerElement}
  */
 export declare const ErrorFallback: ({ error }: ErrorFallbackProps) => import("@emotion/react/jsx-runtime").JSX.Element;
-type KeyWithStringValue<T> = string & keyof {
-    [K in keyof Required<T> as Required<T>[K] extends string ? K : never]: T[K] extends string ? T[K] : never;
-};
 type ExtendedElementProps<ElementProps> = ElementProps & Record<string, unknown>;
 /**
  * Registers element with all necessary providers and wrappers
  */
-export declare const registerElement: <ElementProps>(name: string, Element: import("react").ComponentType<ElementProps>, invalidationKey?: KeyWithStringValue<ElementProps> | KeyWithStringValue<ElementProps>[] | undefined) => (props: ExtendedElementProps<ElementProps>) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const registerElement: <ElementProps>(name: string, Element: import("react").ComponentType<ElementProps>, rootId?: string) => (props: ExtendedElementProps<ElementProps>) => import("@emotion/react/jsx-runtime").JSX.Element;
 export {};

package/schemas/shipengine/index.d.ts

@@ -1,3 +1,2 @@
-export * from "./address";
 export * from "./money";
 export * from "./phone";

package/schemas/shipengine/money.d.ts

@@ -1,5 +1,5 @@
 import { z } from "zod";
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 /**
  * @category Form Validation
  */

package/testing/index.d.ts

@@ -1,2 +1 @@
 export * from "./render";
-export * from "./swr";

package/testing/render.d.ts

@@ -1 +1,6 @@
 export declare const renderWithProviders: (component: any) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;
+/**
+ * Wraps the test with all of the usual Shipengine / Giger / i18 / etc providers that a full, registered "Element" would have.
+ * This allows components to simulate usage in an Element via `decorators: [withAllProviders]`
+ **/
+export declare const renderWithAllProviders: (component: any) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;

package/types/carrier-metadata.d.ts

@@ -1,17 +1,22 @@
-import * as SE from "@shipengine/types";
+import { CarrierConnection, SE } from "@shipengine/api";
 export type CarrierTerm = {
     description: string;
     name: string;
     url: string;
 };
+export type CarrierTerms = {
+    content: string[];
+    links: CarrierTerm[];
+    title: string;
+};
 export type CarrierMetadata = {
-    carrierCode: SE.Carrier["carrierCode"];
+    carrierCode: CarrierConnection["carrierCode"];
     logo: string;
     name: string;
-    optionalFields: string[];
-    requiredFields: string[];
+    optionalFields?: string[];
+    requiredFields?: string[];
     shortname: string;
-    terms: Record<string, CarrierTerm[]> | Record<never, never>;
+    terms?: CarrierTerms;
 };
 export type CarriersFeatures = {
     enabledCarriers?: SE.Carrier["carrierCode"][];

package/types/shipping-preset/shipping-preset.d.ts

@@ -1,8 +1,8 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 export type ShippingPreset = {
     confirmation?: SE.ConfirmationType;
     dimensions?: SE.DimensionsWithUnit;
-    insuranceProvider?: SE.InsuranceProvider;
+    insuranceProvider?: SE.InsuranceProviderType;
     insuredValue?: SE.InsuranceAccount;
     name: string;
     packageCode?: string;

package/utilities/date.d.ts

@@ -17,8 +17,20 @@ export declare const mostRecent: (...dates: Date[]) => Date;
 /**
  * @category Utilities
  */
-export declare const omitTime: (shipDate: string) => Date;
+export declare const omitTime: (shipDate?: string) => Date;
 /**
  * @category Utilities
  */
 export declare const getExpirationYears: (yearsValid: number) => string[];
+/**
+ * @category Utilities
+ */
+type HasCreationDate = {
+    createdAt: string;
+};
+export declare const sortByCreationDate: (a: HasCreationDate, b: HasCreationDate, order?: "asc" | "desc") => number;
+/**
+ * @category Utilities
+ */
+export declare const isNowOrInTheFuture: (shipDate?: string) => boolean;
+export {};

package/utilities/money.d.ts

@@ -1,4 +1,5 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 export declare const currencySymbol: Record<SE.Currency, string>;
 export declare const formatMoney: (value: SE.Money, locale?: string) => string;
 export declare const calculateTotal: (...values: SE.Money[]) => number;
+export declare const formatCreditCardNumber: (cc: string) => string;

package/utilities/rates.d.ts

@@ -1,6 +1,6 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 export declare const getRateRequiresAcknowledgement: (serviceCode: string) => boolean;
-export declare const getTotalRateAmount: (rateCosts: {
+export declare const getTotalRateAmount: (rateCosts?: {
     confirmationAmount?: SE.Money;
     insuranceAmount?: SE.Money;
     otherAmount?: SE.Money;

package/utilities/shipengine/address.d.ts

@@ -1,4 +1,4 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 /**
  * @category Utilities
  */

package/utilities/shipengine/dimensions.d.ts

@@ -1,4 +1,4 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 type ConvertDimensionsOptions = {
     allowAllZeroes?: boolean;
 };

package/utilities/shipengine/sales-order.d.ts

@@ -1,4 +1,4 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 /**
  * @category Utilities
  */

package/utilities/shipengine/shipment.d.ts

@@ -1,4 +1,4 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 /**
  * @category Utilities
  */

package/utilities/shipengine/weight.d.ts

@@ -1,4 +1,4 @@
-import * as SE from "@shipengine/types";
+import { SE } from "@shipengine/api";
 /**
  * @category Utilities
  */

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

@@ -1,15 +0,0 @@
-import { CarrierAutoFunding } from "@shipengine/types";
-import { AutoFundingFormPayload } from "./auto-funding-schema";
-export type AutoFundingFormProps = {
-    defaultValues: CarrierAutoFunding;
-    errorMessage?: string;
-    hasError: boolean;
-    isLoading: boolean;
-    onSubmit: (payload: AutoFundingFormPayload) => Promise<void> | void;
-    onToggle: (enabled: boolean) => Promise<void> | void;
-};
-/**
- * This form that allows users to enable or disable auto funding, and
- * configure auto funding settings in ShipEngine API.
- */
-export declare const AutoFundingForm: ({ defaultValues, errorMessage, hasError, isLoading, onSubmit, onToggle, }: AutoFundingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

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

@@ -1 +0,0 @@
-export * from "./auto-funding-form";

package/components/organisms/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./auto-funding-form";
-export * from "./manual-funding-form";

package/components/organisms/manual-funding-form/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./manual-funding-form";
-export * from "./manual-funding-schema";

package/components/organisms/manual-funding-form/manual-funding-form.d.ts

@@ -1,17 +0,0 @@
-/// <reference types="react" />
-import { ManualFundingFormPayload } from "./manual-funding-schema";
-export type ManualFundingFormProps<T = undefined> = {
-    currentBalance: number;
-    errorMessage?: string;
-    hasError: boolean;
-    isLoading: boolean;
-    onSubmit: (payload: ManualFundingFormPayload) => Promise<void> | void;
-    requiredAmount?: number;
-} & ({
-    formId: string;
-    portalRef: React.RefObject<T>;
-} | {
-    formId?: string;
-    portalRef?: never;
-});
-export declare const ManualFundingForm: <T extends Element>({ currentBalance, errorMessage, formId, hasError, isLoading, onSubmit, portalRef, requiredAmount, }: ManualFundingFormProps<T>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/organisms/manual-funding-form/manual-funding-schema.d.ts

@@ -1,27 +0,0 @@
-import { z } from "zod";
-export declare const manualFundingSchema: z.ZodObject<{
-    funds: z.ZodObject<z.extendShape<{
-        amount: z.ZodNumber;
-        currency: z.ZodNativeEnum<typeof import("dist/shipengine-types/src").Currency>;
-    }, {
-        amount: z.ZodNumber;
-    }>, "strip", z.ZodTypeAny, {
-        amount: number;
-        currency: import("dist/shipengine-types/src").Currency;
-    }, {
-        amount: number;
-        currency: import("dist/shipengine-types/src").Currency;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    funds: {
-        amount: number;
-        currency: import("dist/shipengine-types/src").Currency;
-    };
-}, {
-    funds: {
-        amount: number;
-        currency: import("dist/shipengine-types/src").Currency;
-    };
-}>;
-export type ManualFundingFormFields = z.input<typeof manualFundingSchema>;
-export type ManualFundingFormPayload = z.output<typeof manualFundingSchema>;

package/components/templates/add-carriers/add-carriers.d.ts

@@ -1,5 +0,0 @@
-import { CarriersFeatures } from "../../../types";
-export type AddCarriersProps = {
-    features?: CarriersFeatures;
-};
-export declare const AddCarriers: ({ features }: AddCarriersProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/add-carriers/index.d.ts

@@ -1 +0,0 @@
-export * from './add-carriers';

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

@@ -1,10 +0,0 @@
-import { z } from "zod";
-export declare const agreementFormSchema: z.ZodObject<{
-    agreement: z.ZodLiteral<boolean>;
-}, "strip", z.ZodTypeAny, {
-    agreement: boolean;
-}, {
-    agreement: boolean;
-}>;
-export type AgreementFormFields = z.input<typeof agreementFormSchema>;
-export type AgreementFormPayload = z.output<typeof agreementFormSchema>;

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

@@ -1,8 +0,0 @@
-import { ReactNode } from "react";
-import { AgreementFormPayload } from "./agreement-form-schema";
-export type AgreementFormProps = {
-    checkboxLabel: ReactNode;
-    onAgree: (values: AgreementFormPayload) => Promise<void>;
-    onSkip?: () => void;
-};
-export declare const AgreementForm: ({ checkboxLabel, onAgree, onSkip }: AgreementFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/agreement-form/agreement-form.styles.d.ts

@@ -1 +0,0 @@
-export declare const getAgreementStyles: () => import("@emotion/utils").SerializedStyles;

package/components/templates/agreement-form/index.d.ts

@@ -1 +0,0 @@
-export * from "./agreement-form";

package/components/templates/billing-form/billing-form-stories.d.ts

@@ -1,6 +0,0 @@
-import { ComponentMeta, ComponentStory } from "@storybook/react";
-import { BillingFormProps } from "./billing-form";
-declare const _default: ComponentMeta<({ onSkip, onSubmit }: BillingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element>;
-export default _default;
-export declare const Default: ComponentStory<({ onSkip, onSubmit }: BillingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element>;
-export declare const WithLabels: ComponentStory<({ onSkip, onSubmit }: BillingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element>;

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

@@ -1,9 +0,0 @@
-import * as SE from "@shipengine/types";
-import { BillingFormPayload } from "./billing-schema";
-export type BillingFormProps = {
-    address?: SE.Address;
-    onCancel?: () => void;
-    onSkip: () => void;
-    onSubmit: (billingPayload: BillingFormPayload) => void;
-};
-export declare const BillingForm: ({ onSkip, onSubmit }: BillingFormProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/billing-form/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./billing-form";
-export * from "./billing-form-styles";

package/components/templates/funding-methods/funding-methods.d.ts

@@ -1,17 +0,0 @@
-import { CarrierAutoFunding } from "@shipengine/types";
-import { ManualFundingFormPayload } from "../../organisms/manual-funding-form/manual-funding-schema";
-export type FundingMethodsProps = {
-    addFundsErrorMessage?: string;
-    autoFundingData: CarrierAutoFunding;
-    autoFundingErrorMessage?: string;
-    hasAutoFundingError: boolean;
-    hasManualFundingError: boolean;
-    isAutoFundingLoading: boolean;
-    isManualFundingLoading: boolean;
-    manualFundingCurrentBalance: number;
-    manualFundingRequiredAmount?: number;
-    onSubmitAutoFunding: (payload: CarrierAutoFunding) => Promise<void> | void;
-    onSubmitManualFunding: (payload: ManualFundingFormPayload) => Promise<void> | void;
-    onToggleAutoFunding: (enabled: boolean) => Promise<void> | void;
-};
-export declare const FundingMethods: ({ addFundsErrorMessage, autoFundingData, autoFundingErrorMessage, hasAutoFundingError, hasManualFundingError, isAutoFundingLoading, isManualFundingLoading, manualFundingCurrentBalance, manualFundingRequiredAmount, onSubmitAutoFunding, onSubmitManualFunding, onToggleAutoFunding, }: FundingMethodsProps) => import("@emotion/react/jsx-runtime").JSX.Element;

package/components/templates/funding-methods/index.d.ts

@@ -1 +0,0 @@
-export * from "./funding-methods";

package/components/templates/register-wallet/index.d.ts

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

package/components/templates/register-wallet/register-wallet.d.ts

@@ -1,3 +0,0 @@
-export type RegisterWalletFeatures = {};
-export type RegisterWalletProps = {};
-export declare const RegisterWallet: ({}: RegisterWalletProps) => import("@emotion/react/jsx-runtime").JSX.Element;