@shipengine/elements 0.21.3 → 0.21.5

package/src/elements/onboarding/onboarding.d.ts

@@ -0,0 +1,581 @@
+/// <reference types="react" />
+export type ComponentProps = {
+    onCompleteOnboarding: () => void;
+};
+export declare const Component: ({ onCompleteOnboarding }: ComponentProps) => import("@emotion/react/jsx-runtime").JSX.Element;
+export declare const Element: ({ resources, ...props }: ComponentProps & {
+    resources?: {
+        en: {
+            "wallet-history": {
+                actions: {
+                    downloadCsv: string;
+                    chooseDate: string;
+                };
+                dateRange: string;
+                historyOptions: {
+                    custom: string;
+                    last30days: string;
+                    thisMonth: string;
+                    lastMonth: string;
+                };
+            };
+            "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": {
+                sections: {
+                    setup: {
+                        title: string;
+                        subtitle: string;
+                        descriptionTitle: string;
+                        description: string;
+                    };
+                    billing: {
+                        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: {
+                    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;
+                    contentDescription: 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;
+                };
+                hints: {
+                    contentDescription: string;
+                };
+                loading: {
+                    calculatingRates: string;
+                };
+                modes: {
+                    browseRates: string;
+                    selectService: string;
+                };
+                multipleShippingServices: string;
+                recommendedRates: {
+                    recommended: string;
+                    stayInformed: string;
+                };
+                schemaErrors: {
+                    shipFromUnitedStatesOnly: string;
+                    shipFromAddressRequired: string;
+                    needToAcknowledge: string;
+                };
+                rates: {
+                    uspsMediaMailAcknowledgement: string;
+                };
+                shipToAddressFormFields: string;
+                sections: {
+                    customsForm: string;
+                    shipment: string;
+                    rate_one: string;
+                    rate_other: string;
+                };
+            };
+            onboarding: {
+                inlineTitle: string;
+                landing: {
+                    action: string;
+                    title: string;
+                    subtitle: string;
+                    welcome: string;
+                    messageLine1: string;
+                    messageLine2: 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-defaults": {
+                units: {
+                    title: string;
+                    dimensions: {
+                        title: string;
+                        standard: string;
+                        metric: string;
+                    };
+                    weight: {
+                        title: string;
+                        standard: string;
+                        g: string;
+                        kg: string;
+                    };
+                };
+                label: {
+                    letter: {
+                        title: string;
+                        description: string;
+                    };
+                    purchase: {
+                        title: string;
+                        description: string;
+                    };
+                    thermal: {
+                        title: string;
+                        description: string;
+                    };
+                    title: string;
+                };
+            };
+            "manage-warehouses": {
+                addNew: string;
+                editWarehouse: string;
+                contactName: string;
+                default: string;
+                isDefault: string;
+                locationName: string;
+                residentialAddress: string;
+                returnTo: string;
+                returnToAddressIsDifferent: string;
+                setDefault: string;
+                shipFrom: string;
+            };
+            "manage-funding": {
+                actions: {
+                    addFunds: string;
+                    addFundsAndPurchase: string;
+                    addNow: string;
+                    saveRule: string;
+                };
+                autoFunding: {
+                    edit: string;
+                    editSettings: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isEnabledCTA: string;
+                    isEnabled: string;
+                    isLoading: string;
+                    lowBalancePurchaseThreshold: string;
+                    maximumPurchasesPerDay: string;
+                    purchaseAmount: string;
+                    readSettings: string;
+                };
+                addFunds: {
+                    custom: string;
+                    error: {
+                        title: string;
+                        message: string;
+                    };
+                    isLoading: string;
+                    labels: {
+                        amount: string;
+                    };
+                    minimumPurchaseAmount: string;
+                    other: 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;
+                    hide: string;
+                    parse: string;
+                    purchase: string;
+                    remove: string;
+                    save: string;
+                    skipForNow: string;
+                    submit: string;
+                    tryAgain: string;
+                };
+                address: {
+                    fields: {
+                        name: string;
+                        company: string;
+                        countryCode: string;
+                        addressLine1: string;
+                        addressLine2: string;
+                        cityLocality: string;
+                        stateProvince: string;
+                        postalCode: string;
+                        phone: string;
+                        email: string;
+                        addressResidentialIndicator: string;
+                    };
+                    noResults: string;
+                    subFields: {
+                        optional: string;
+                    };
+                    parserFields: {
+                        fullAddress: string;
+                    };
+                    paste: string;
+                    preference: {
+                        confirm: string;
+                        addressNotValidated: string;
+                        modified: string;
+                        title: string;
+                        originalAddress: string;
+                        matchedAddress: string;
+                        unableToValidate: string;
+                        use: {
+                            originalAddress: string;
+                            matchedAddress: string;
+                        };
+                    };
+                    validation: {
+                        notValidated: string;
+                        validated: string;
+                    };
+                };
+                billing: {
+                    fields: {
+                        differentBillingAddress: string;
+                        name: string;
+                        cardNumber: string;
+                        expiration: string;
+                        cvv: string;
+                        cvvPlaceholder: string;
+                        expirationPlaceholder: string;
+                        cardNumberPlaceholder: string;
+                    };
+                };
+                carriers: {
+                    fields: {
+                        agreement: string;
+                    };
+                    terms: {
+                        agreeToTerms: string;
+                        title: 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: {
+                        autoFundingSettings: string;
+                        carrier: string;
+                        carriers: string;
+                        salesOrder: string;
+                        shipment: string;
+                        warehouses: string;
+                    };
+                    unknown: string;
+                    noRatesAvailable: 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: {
+                    carrier: string;
+                    carriers: string;
+                    data: string;
+                    importingSalesOrder: string;
+                    onboarding: 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;
+                };
+                schema: {
+                    optionalLabel: string;
+                };
+                schemaErrors: {
+                    notAValidPhoneNumber: string;
+                    mustAgreeToTerms: string;
+                    group: {
+                        allMeasurementsOrNone: string;
+                    };
+                    invalidAddressName: string;
+                    invalidAddressPoBox: string;
+                    invalidCreditCardType: string;
+                    invalidExpiration: string;
+                    invalidPostalCode: string;
+                    invalidStateProvince: 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;
+                QSBzaGlwcGluZyBjYXJyaWVyIGVycm9yIG9jY3VycmVkOiBVUFMgd2VpZ2h0IGxpbWl0IHBlciBwYWNrYWdlIGlzIDE1MCBsYnMu: string;
+            };
+        };
+    } | undefined;
+}) => import("@emotion/react/jsx-runtime").JSX.Element;
+export type ElementProps = React.ComponentProps<typeof Element>;

package/src/elements/{components/purchase-label → purchase-label}/hooks/use-configure-shipment.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/js-api";
+import { SE } from "@shipengine/alchemy";
 import { ConfigureShipmentProps } from "../../configure-shipment";
 import { UsePendingShipmentProps } from "./use-pending-shipment";
 export type UseConfigureShipmentProps = {

package/src/elements/{components/purchase-label → purchase-label}/hooks/use-import-sales-order.d.ts

@@ -5,7 +5,7 @@ export type UseImportSalesOrderProps = {
     salesOrderId?: string;
 };
 export declare const useImportSalesOrder: ({ externalOrderId, externalOrderNumber, orderSourceCode, salesOrderId, }: UseImportSalesOrderProps) => {
-    errors: import("@shipengine/react-api").CodedError[] | undefined;
+    errors: import("@shipengine/alchemy").CodedError[] | undefined;
     isLoading: boolean;
-    salesOrder: import("@shipengine/react-api").SalesOrder | undefined;
+    salesOrder: import("@shipengine/alchemy").SalesOrder | undefined;
 };

package/src/elements/{components/purchase-label → purchase-label}/hooks/use-load-shipment.d.ts

@@ -2,8 +2,8 @@ export type UseLoadShipmentProps = {
     shipmentId: string;
 };
 export declare const useLoadShipment: ({ shipmentId }: UseLoadShipmentProps) => {
-    errors: import("@shipengine/react-api").CodedError[] | undefined;
+    errors: import("@shipengine/alchemy").CodedError[] | undefined;
     isLoading: boolean;
-    refetchShipment: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<import("@shipengine/react-api").SalesOrderShipment, import("@shipengine/react-api").CodedError[]>>;
-    shipment: import("@shipengine/react-api").SalesOrderShipment | undefined;
+    refetchShipment: <TPageData>(options?: (import("react-query").RefetchOptions & import("react-query").RefetchQueryFilters<TPageData>) | undefined) => Promise<import("react-query").QueryObserverResult<import("@shipengine/alchemy").SalesOrderShipment, import("@shipengine/alchemy").CodedError[]>>;
+    shipment: import("@shipengine/alchemy").SalesOrderShipment | undefined;
 };

package/src/elements/{components/purchase-label → purchase-label}/hooks/use-pending-shipment.d.ts

@@ -1,4 +1,4 @@
-import { SE } from "@shipengine/js-api";
+import { SE } from "@shipengine/alchemy";
 export type UsePendingShipmentProps = {
     onLoad?: (salesOrder: SE.SalesOrder, shipments: SE.SalesOrderShipment[], pendingShipment?: SE.SalesOrderShipment) => Promise<void> | void;
     salesOrder?: SE.SalesOrder;

package/src/elements/purchase-label/index.d.ts

@@ -0,0 +1 @@
+export * as PurchaseLabel from "./purchase-label";

package/src/elements/{components/purchase-label → purchase-label}/purchase-label-by-sales-order.d.ts

@@ -1,4 +1,4 @@
-import { UseShippingPresetsOptionsProps } from "../../../hooks";
+import { UseShippingPresetsOptionsProps } from "../../hooks";
 import { ConfigureShipmentProps } from "../configure-shipment";
 import { UseConfigureShipmentProps, UseImportSalesOrderProps } from "./hooks";
 export type SalesOrderProps = {