@shipengine/elements 0.11.1 → 0.13.0

package/locales/en/index.d.ts

@@ -0,0 +1,386 @@
+declare const _default: {
+    "void-label": {
+        actions: {
+            complete: string;
+            confirmVoid: string;
+            viewShipment: string;
+        };
+        resultMessages: {
+            approved: string;
+            rejected: string;
+        };
+        refund_process: string;
+        refund_rules: string;
+        resultTitles: {
+            approved: string;
+            rejected: string;
+        };
+        sections: {
+            salesOrder: string;
+        };
+    };
+    "view-shipment": {
+        actions: {
+            buyAnotherLabel: string;
+            hideItems: string;
+            printForms: string;
+            printLabel: string;
+            schedulePickup: string;
+            showItems: string;
+            void: string;
+        };
+        fields: {
+            dimensions: string;
+            estimatedShipping: string;
+            items: string;
+            orderDate: string;
+            orderValue: string;
+            requestedShipping: string;
+            shipDate: string;
+            shipTo: string;
+            warehouse: string;
+            weight: string;
+            insuredValue: string;
+            deliveryConfirmation: string;
+        };
+        highVolumeForms: string;
+        multipleShippingServices: string;
+        sections: {
+            labels: string;
+        };
+    };
+    "register-wallet": {
+        agreeToTerms: string;
+        sections: {
+            setup: {
+                title: string;
+                subTitle: string;
+                descriptionTitle: string;
+                description: string;
+            };
+            billing: {
+                title: string;
+                cardSubTitle: string;
+                addressSubTitle: string;
+            };
+        };
+    };
+    "purchase-label": {
+        actions: {
+            calculateRates_one: string;
+            calculateRates_other: string;
+            hideItems: string;
+            purchaseLabel: string;
+            purchaseNow: string;
+            showItems: string;
+            showMoreRates: string;
+            showFewerRates: string;
+            saveRate: string;
+        };
+        balance: {
+            currentBalance: string;
+            insufficientBalanceCTA: string;
+        };
+        cta: {
+            addPackageDetails: string;
+        };
+        errorMessages: {
+            customsItemsRequired: string;
+            invalidAddress: string;
+            noRates: string;
+            salesOrderNotLoaded: string;
+            unsupportedAddress: string;
+        };
+        errorTypes: {
+            results: string;
+        };
+        fields: {
+            addOns: string;
+            confirmation: string;
+            dimensions: {
+                length: string;
+                width: string;
+                height: string;
+            };
+            dimensionsGroup: string;
+            estimatedShipping: string;
+            insurance: string;
+            insuranceProvider: string;
+            insuredValue: string;
+            items: string;
+            orderDate: string;
+            orderValue: string;
+            packageCode: string;
+            requestedShipping: string;
+            shipDate: string;
+            service: string;
+            shipTo: string;
+            warehouse: string;
+            weight: {
+                whole: string;
+                fractional: string;
+            };
+            weightGroup: string;
+        };
+        loading: {
+            calculatingRates: string;
+        };
+        modes: {
+            browseRates: string;
+            selectService: string;
+        };
+        multipleShippingServices: string;
+        recommendedRates: {
+            recommended: string;
+            stayInformed: string;
+        };
+        schemaErrors: {
+            shipFromUnitedStatesOnly: string;
+            needToAcknowledge: string;
+        };
+        rates: {
+            uspsMediaMailAcknowledgement: string;
+        };
+        shipToAddressFormFields: string;
+        sections: {
+            customsForm: string;
+            shipment: string;
+            rate_one: string;
+            rate_other: string;
+        };
+    };
+    "manage-warehouses": {
+        returnTo: string;
+        shipFrom: string;
+    };
+    "manage-funding": {
+        addFunds: string;
+        autoFunding: {
+            error: {
+                title: string;
+                message: string;
+            };
+            isEnabled: string;
+            isLoading: string;
+            lowBalancePurchaseThreshold: string;
+            maximumPurchasesPerDay: string;
+            purchaseAmount: string;
+        };
+        otp: {
+            labels: {
+                amount: string;
+                currentBalance: string;
+                resultingBalance: string;
+            };
+            minimumPurchaseAmount: string;
+        };
+        maximumBalanceAmount: string;
+    };
+    common: {
+        actions: {
+            add: string;
+            cancel: string;
+            continue: string;
+            delete: string;
+            edit: string;
+            hide: string;
+            parse: string;
+            purchase: string;
+            remove: string;
+            save: string;
+            skipForNow: string;
+            submit: string;
+        };
+        address: {
+            fields: {
+                name: string;
+                company: string;
+                countryCode: string;
+                addressLine1: string;
+                addressLine2: string;
+                cityLocality: string;
+                stateProvince: string;
+                postalCode: string;
+                phone: string;
+                email: string;
+            };
+            subFields: {
+                optional: string;
+            };
+            parserFields: {
+                fullAddress: string;
+            };
+            paste: string;
+            preference: {
+                addressNotValidated: string;
+                modified: string;
+                originalAddress: string;
+                matchedAddress: string;
+                unableToValidate: string;
+                use: {
+                    originalAddress: string;
+                    matchedAddress: string;
+                };
+            };
+            validation: {
+                notValidated: string;
+                validated: string;
+            };
+        };
+        billing: {
+            fields: {
+                name: string;
+                cardNumber: string;
+                expirationMonth: string;
+                expirationYear: string;
+                cvv: string;
+            };
+        };
+        carriers: {
+            fields: {
+                agreement: string;
+            };
+        };
+        charsetWarnings: {
+            name: {
+                message: string;
+            };
+            address: {
+                message: string;
+                title: string;
+            };
+        };
+        confirmationTypes: {
+            adultSignature: string;
+            delivery: string;
+            deliveryMailed: string;
+            directSignature: string;
+            none: string;
+            signature: string;
+            verbalConfirmation: string;
+        };
+        customs: {
+            addDeclaration: string;
+            contents: {
+                documents: string;
+                gift: string;
+                merchandise: string;
+                returnedGoods: string;
+                sample: string;
+            };
+            declarations: string;
+            each: string;
+            fields: {
+                contentsType: string;
+                countryOfOrigin: string;
+                description: string;
+                harmonizedTariffCode: string;
+                ifDeliveryFails: string;
+                quantity: string;
+                sku: string;
+                value: string;
+                valueQuantity: string;
+            };
+            nonDelivery: {
+                returnToSender: string;
+                treatAsAbandoned: string;
+            };
+            removeAllDeclarations: string;
+            total: string;
+        };
+        errorMessages: {
+            invalidNameOrCompany: string;
+            noWarehouses: string;
+            unableToLoad: {
+                carriers: string;
+                salesOrder: string;
+                shipment: string;
+                warehouses: string;
+            };
+            unknown: string;
+        };
+        errorTypes: {
+            accountStatus: string;
+            businessRules: string;
+            integrations: string;
+            purchase: string;
+            rateInvalid: string;
+            security: string;
+            system: string;
+            unknown: string;
+            validation: string;
+        };
+        insuranceProviders: {
+            carrier: string;
+            none: string;
+            shipsurance: string;
+            thirdParty: string;
+        };
+        loading: {
+            carriers: string;
+            data: string;
+            importingSalesOrder: string;
+            salesOrder: string;
+            shipment: string;
+            warehouses: string;
+        };
+        months: {
+            january: string;
+            february: string;
+            march: string;
+            april: string;
+            may: string;
+            june: string;
+            july: string;
+            august: string;
+            september: string;
+            october: string;
+            november: string;
+            december: string;
+        };
+        packageCategories: {
+            browseRates: string;
+            myCustomPackages: string;
+        };
+        packageCodes: {
+            package: string;
+        };
+        schemaErrors: {
+            notAValidPhoneNumber: string;
+            group: {
+                allMeasurementsOrNone: string;
+            };
+            invalidAddressName: string;
+            invalidAddressPoBox: string;
+            invalidString: string;
+            nonnegative: string;
+            nonnegativeList: string;
+            positive: string;
+            positiveList: string;
+            required: string;
+            requiredList: string;
+            tooFewCharacters: string;
+            tooManyCharacters: string;
+        };
+        shippingPresets: {
+            apply: string;
+            platform: string;
+            user: string;
+        };
+        weight: {
+            ounces: string;
+            pounds_one: string;
+            pounds_other: string;
+        };
+        units: {
+            in: string;
+            lbs: string;
+            oz: string;
+        };
+        "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkMTAwLgo=": string;
+        "VGhlIHNlbGVjdGVkIHNlcnZpY2UgaW5jbHVkZXMgaW5zdXJhbmNlIGZvciBhbiBpbnN1cmVkIGFtb3VudCB1cCB0byAkNTAuCg==": string;
+        QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBJbnN1ZmZpY2llbnQgYWNjb3VudCBiYWxhbmNlLiBBY2NvdW50IGV4Y2VwdGlvbiBFeGNlcHRpb24gd2l0aCBjb2RlIDB4MDA1NjAxMDE7IG1vZHVsZSA4NiwgY2F0ZWdvcnkgMSwgaXRlbSAx: string;
+        "QWRkcmVzcyBub3QgZm91bmQ=": string;
+    };
+};
+export default _default;

package/locales/index.d.ts

@@ -0,0 +1 @@
+export { default as en } from "./en";

package/package.json

@@ -1,6 +1,11 @@
 {
   "name": "@shipengine/elements",
-  "version": "0.11.1",
+  "version": "0.13.0",
+  "typedoc": {
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "../../README.md",
+    "displayName": "ShipEngine Elements"
+  },
   "peerDependencies": {
     "@packlink/giger": "*",
     "react-i18next": "*",
@@ -12,10 +17,24 @@
   "types": "./index.d.ts",
   "dependencies": {
     "react": "^18.2.0",
-    "@shipengine/elements-core": "0.11.1",
-    "@shipengine/elements-ui": "0.11.1",
-    "@shipengine/types": "0.11.1",
     "@emotion/react": "^11.10.0",
-    "@packlink/brands": "^3.18.0"
+    "@packlink/brands": "^3.18.0",
+    "@shipengine/react": "0.13.0",
+    "react-hook-form": "^7.31.2",
+    "@emotion/css": "^11.10.5",
+    "humps": "^2.0.1",
+    "react-datepicker": "^4.8.0",
+    "@shipengine/types": "0.13.0",
+    "zod": "^3.17.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",
+    "swr": "^2.0.0-beta.5",
+    "stylis": "^4.1.2",
+    "i18next-browser-languagedetector": "^6.1.4",
+    "axios": "^0.26.1",
+    "@hookform/resolvers": "2.9.1"
   }
 }

package/providers/giger-provider.d.ts

@@ -0,0 +1,8 @@
+import { WithChildrenCommonProps } from "@packlink/giger";
+/**
+ * @category Providers
+ */
+export declare const GigerProvider: ({ children, brandName, rootId, }: WithChildrenCommonProps<{
+    brandName?: string | undefined;
+    rootId: string;
+}>) => import("@emotion/react/jsx-runtime").JSX.Element;

package/providers/index.d.ts

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

package/register.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="react" />
+export interface ErrorFallbackProps {
+    error: Error | string;
+}
+/**
+ * Fallback component for the Elements ErrorBoundary
+ *
+ * @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 {};

package/schemas/index.d.ts

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

package/schemas/shipengine/address.d.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+/**
+ * @category Form Validation
+ */
+export declare const addressLine1Schema: z.ZodString;
+/**
+ * @category Form Validation
+ */
+export declare const addressLine1SchemaNoPoBox: z.ZodEffects<z.ZodString, string, string>;
+/**
+ * @category Form Validation
+ */
+export declare const addressLine2Schema: z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>;
+/**
+ * @category Form Validation
+ */
+export declare const addressLine2SchemaNoPoBox: z.ZodEffects<z.ZodEffects<z.ZodNullable<z.ZodOptional<z.ZodString>>, string | undefined, string | null | undefined>, string | undefined, string | null | undefined>;

package/schemas/shipengine/index.d.ts

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

package/schemas/shipengine/money.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import * as SE from "@shipengine/types";
+/**
+ * @category Form Validation
+ */
+export declare const moneySchema: z.ZodObject<{
+    amount: z.ZodNumber;
+    currency: z.ZodNativeEnum<typeof SE.Currency>;
+}, "strip", z.ZodTypeAny, {
+    amount: number;
+    currency: SE.Currency;
+}, {
+    amount: number;
+    currency: SE.Currency;
+}>;

package/schemas/shipengine/phone.d.ts

@@ -0,0 +1,10 @@
+import { z } from "zod";
+import { CountryCode } from "libphonenumber-js/min";
+/**
+ * @category Form Validation
+ */
+export declare const phoneSchema: (defaultCountryCode?: CountryCode) => z.ZodEffects<z.ZodString, string, string>;
+/**
+ * @category Form Validation
+ */
+export declare const phoneSchemaUnvalidated: z.ZodString;

package/testing/index.d.ts

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

package/testing/render.d.ts

@@ -0,0 +1 @@
+export declare const renderWithProviders: (component: any) => import("@testing-library/react").RenderResult<typeof import("@testing-library/dom/types/queries"), HTMLElement, HTMLElement>;

package/testing/swr.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="jest" />
+export declare const buildSwrGetMock: (response: any) => {
+    errors: undefined;
+    mutate: () => Promise<any>;
+    isValidating: boolean;
+    isLoading: boolean;
+    data: any;
+};
+export declare const buildSwrPostMock: (response: any) => {
+    errors: undefined;
+    trigger: () => Promise<any>;
+    isMutating: boolean;
+    data: any;
+    reset: jest.Mock<any, any>;
+};

package/types/carrier-metadata.d.ts

@@ -0,0 +1,7 @@
+import * as SE from "@shipengine/types";
+export type CarrierMetadata = {
+    carrierCode: SE.Carrier["carrierCode"];
+};
+export type CarriersFeatures = {
+    enabledCarriers?: SE.Carrier["carrierCode"][];
+};

package/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./carrier-metadata";
+export * from "./shipping-preset";

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

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

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

@@ -0,0 +1,17 @@
+import * as SE from "@shipengine/types";
+export type ShippingPreset = {
+    confirmation?: SE.ConfirmationType;
+    dimensions?: SE.DimensionsWithUnit;
+    insuranceProvider?: SE.InsuranceProvider;
+    insuredValue?: SE.InsuranceAccount;
+    name: string;
+    packageCode?: string;
+    serviceName?: string;
+    weight?: SE.WeightWithUnit;
+} & ({
+    carrierId: string;
+    serviceCode: string;
+} | {
+    carrierId?: never;
+    serviceCode?: never;
+});

package/utilities/create-dictionary.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Utilities
+ */
+export declare const createDictionary: <T extends object, U>(items: T[] | undefined, getEntry: (item: T, partialResults: Record<string, U | undefined>) => Record<string, U | undefined>) => Record<string, U | undefined>;

package/utilities/date.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @category Utilities
+ */
+export declare const formatDate: (date: string, locale?: string) => string;
+/**
+ * @category Utilities
+ */
+export declare const daysAfter: (days: number, date?: Date) => Date;
+/**
+ * @category Utilities
+ */
+export declare const nextDayCutoff: (cutoff: number, date?: Date) => Date;
+/**
+ * @category Utilities
+ */
+export declare const mostRecent: (...dates: Date[]) => Date;
+/**
+ * @category Utilities
+ */
+export declare const omitTime: (shipDate: string) => Date;
+/**
+ * @category Utilities
+ */
+export declare const getExpirationYears: (yearsValid: number) => string[];

package/utilities/error.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Utilities
+ */
+export declare const createCodedErrors: (err: any) => any;

package/utilities/form-logger.d.ts

@@ -0,0 +1,16 @@
+import { FieldValues, ResolverResult, UseFormHandleSubmit } from "react-hook-form";
+/**
+ * @description
+ * This will log the values that are submitted to the validation resolver
+ * (only REGISTERED form fields) and the results of that validation.
+ *
+ * @usage Wrap the submission:
+ * `<form onSubmit={formLogger.capture(handleSubmit)}>`
+ *
+ * @category Utilities
+ */
+export declare const formLogger: {
+    isSubmitting: boolean;
+    capture(handleSubmit: ReturnType<UseFormHandleSubmit<any>>): (e?: React.BaseSyntheticEvent) => void;
+    log: <T, U extends FieldValues>(values: T, getValidationResult: () => Promise<ResolverResult<U>>) => Promise<ResolverResult<U>>;
+};

package/utilities/index.d.ts

@@ -0,0 +1,11 @@
+export * from "./create-dictionary";
+export * from "./date";
+export * from "./error";
+export * from "./form-logger";
+export * from "./money";
+export * from "./predicates";
+export * from "./rates";
+export * from "./shipengine";
+export * from "./string";
+export * from "./styles";
+export * from "./validation";

package/utilities/money.d.ts

@@ -0,0 +1,4 @@
+import * as SE from "@shipengine/types";
+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;

package/utilities/predicates/index.d.ts

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

package/utilities/predicates/isString.d.ts

@@ -0,0 +1 @@
+export declare const isString: (x: unknown) => x is string;

package/utilities/rates.d.ts

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