@zonos/elements 1.3.238 → 1.3.240

package/dist/scripts/index.d.ts

@@ -833,8 +833,10 @@ declare const notificationActiveStatus: {
 type NotificationActiveStatus = (typeof notificationActiveStatus)[keyof typeof notificationActiveStatus];
 declare const orderStatus: {
     readonly Canceled: "CANCELED";
+    readonly Combined: "COMBINED";
     readonly Completed: "COMPLETED";
     readonly FraudHold: "FRAUD_HOLD";
+    readonly Hold: "HOLD";
     readonly InTransitToConsolidationCenter: "IN_TRANSIT_TO_CONSOLIDATION_CENTER";
     readonly Open: "OPEN";
     readonly PartiallyShipped: "PARTIALLY_SHIPPED";
@@ -6157,6 +6159,761 @@ type CartCheckoutResult = {
     storeLogoUrl: string;
 };
 
+declare const stringsBase: {
+    ' (Duties due at door)': {
+        value: string;
+    };
+    ' (Duties prepaid)': {
+        value: string;
+    };
+    '"[itemName]" is out of stock. Please remove it from your cart and try again.': {
+        value: string;
+    };
+    'A confirmation email with your payment details has been sent for your records. If you have any questions or need support, our team is here to help.': {
+        value: string;
+    };
+    'Above de minimis threshold for': {
+        value: string;
+    };
+    'Add promotional code': {
+        value: string;
+    };
+    Address: {
+        value: string;
+    };
+    'Address 2': {
+        value: string;
+    };
+    'Address line 1': {
+        value: string;
+    };
+    'Address line 2': {
+        value: string;
+    };
+    'Address line 3': {
+        value: string;
+    };
+    Address1: {
+        value: string;
+    };
+    Address2: {
+        value: string;
+    };
+    Address3: {
+        value: string;
+    };
+    'Adresa vulytsi': {
+        value: string;
+    };
+    'An unexpected error occurred when processing PayPal order.': {
+        value: string;
+    };
+    Apply: {
+        value: string;
+    };
+    'Are you sure?': {
+        value: string;
+    };
+    Area: {
+        value: string;
+    };
+    Back: {
+        value: string;
+    };
+    Billing: {
+        value: string;
+    };
+    'Billing address': {
+        value: string;
+    };
+    'Billing info': {
+        value: string;
+    };
+    'By paying in USD, your card will be charged directly with no currency conversion. However, using a non-USD based card may result in additional currency conversion fees at the bank level.': {
+        value: string;
+    };
+    CEDEX: {
+        value: string;
+    };
+    'CPF/CNPJ number': {
+        value: string;
+    };
+    Cancel: {
+        value: string;
+    };
+    'Card number copied to clipboard': {
+        value: string;
+    };
+    'Cart subtotal': {
+        value: string;
+    };
+    City: {
+        value: string;
+    };
+    'City/Town': {
+        value: string;
+    };
+    'Click to copy the card number. Use any future expiration date and three number CVC.': {
+        value: string;
+    };
+    'Click to pay in USD': {
+        value: string;
+    };
+    Close: {
+        value: string;
+    };
+    'Code postal': {
+        value: string;
+    };
+    Commune: {
+        value: string;
+    };
+    'Company name (optional)': {
+        value: string;
+    };
+    Confirm: {
+        value: string;
+    };
+    'Confirmation #:[confirmationId]': {
+        value: string;
+    };
+    Contact: {
+        value: string;
+    };
+    'Continue to shipping': {
+        value: string;
+    };
+    "Couldn't place order": {
+        value: string;
+    };
+    Country: {
+        value: string;
+    };
+    County: {
+        value: string;
+    };
+    'County or sector': {
+        value: string;
+    };
+    Customer: {
+        value: string;
+    };
+    'Customer information': {
+        value: string;
+    };
+    'Customs charges for your recent purchase from [companyName] are available for payment': {
+        value: string;
+    };
+    'Customs charges from your recent purchase are available for payment': {
+        value: string;
+    };
+    'Customs fees total': {
+        value: string;
+    };
+    Delivery: {
+        value: string;
+    };
+    'Delivery options': {
+        value: string;
+    };
+    Department: {
+        value: string;
+    };
+    Derzhava: {
+        value: string;
+    };
+    Discounts: {
+        value: string;
+    };
+    District: {
+        value: string;
+    };
+    'Do/Si': {
+        value: string;
+    };
+    "Don't close": {
+        value: string;
+    };
+    'Due at delivery': {
+        value: string;
+    };
+    'Due to the Australia tax law, all orders will be assessed at [percentage] GST regardless of order total.': {
+        value: string;
+    };
+    'Due to the IOSS tax law, all orders will be assessed at [percentage] VAT regardless of order total.': {
+        value: string;
+    };
+    'Due to the New Zealand tax law, all orders will be assessed at [percentage] GST regardless of order total.': {
+        value: string;
+    };
+    'Due to the Singapore tax law, all orders will be assessed at [percentage] GST regardless of order total.': {
+        value: string;
+    };
+    'Due to the UK tax law, all orders will be assessed at [percentage] VAT regardless of order total.': {
+        value: string;
+    };
+    'Due to the VOEC tax law, all orders will be assessed at [percentage] VAT regardless of order total.': {
+        value: string;
+    };
+    Duties: {
+        value: string;
+    };
+    'Duties and fees': {
+        value: string;
+    };
+    'Duties and fees included': {
+        value: string;
+    };
+    'Duties and taxes will be applied to items and shipping.': {
+        value: string;
+    };
+    'Duties and taxes will be charged upon delivery.': {
+        value: string;
+    };
+    'Duties will apply to all orders.': {
+        value: string;
+    };
+    'Duties, taxes, and fees': {
+        value: string;
+    };
+    'EORI number': {
+        value: string;
+    };
+    Email: {
+        value: string;
+    };
+    Emirate: {
+        value: string;
+    };
+    'Error creating Checkout': {
+        value: string;
+    };
+    'Error updating Checkout': {
+        value: string;
+    };
+    'Estimated [amount]': {
+        value: string;
+    };
+    'Expected delivery': {
+        value: string;
+    };
+    'Failed to create PayPal order. Please try again, or consider using an alternative method.': {
+        value: string;
+    };
+    Failure: {
+        value: string;
+    };
+    'Fedex Shipping Procedure': {
+        value: string;
+    };
+    Fees: {
+        value: string;
+    };
+    'First name': {
+        value: string;
+    };
+    'Go to payment': {
+        value: string;
+    };
+    Gorod: {
+        value: string;
+    };
+    Guaranteed: {
+        value: string;
+    };
+    Hide: {
+        value: string;
+    };
+    'Hide non-prepaid options': {
+        value: string;
+    };
+    "If you select FedEx Ground as your shipping option, you'll need to complete a General Agency Agreement (GAA) after placing your order. This form allows FedEx to clear your package through Canadian customs on your behalf. FedEx will contact you directly\u2014usually by email or phone\u2014with instructions on how to complete the GAA. To avoid delays or the return of your package, please respond promptly to their request.": {
+        value: string;
+    };
+    Indeks: {
+        value: string;
+    };
+    'Invalid RFC format. Must be 12\u201313 uppercase letters and numbers only.': {
+        value: string;
+    };
+    'Invalid promo code': {
+        value: string;
+    };
+    'Invalid session': {
+        value: string;
+    };
+    'Invoice:': {
+        value: string;
+    };
+    Island: {
+        value: string;
+    };
+    'It looks like you placed an order recently ([date] at [time]) under order number #[orderNumber]. Check your email for the order confirmation. Are you sure you want to place another order?': {
+        value: string;
+    };
+    'It looks like you placed an order recently ([date] at [time]). Check your email for the order confirmation. Are you sure you want to place another one?': {
+        value: string;
+    };
+    'Keep shopping': {
+        value: string;
+    };
+    'Know about duties and taxes before you buy. Shop with confidence!': {
+        value: string;
+    };
+    Kodepos: {
+        value: string;
+    };
+    'Last name': {
+        value: string;
+    };
+    'Learn more.': {
+        value: string;
+    };
+    Locality: {
+        value: string;
+    };
+    'Missing required fields. Make sure all fields are completed.': {
+        value: string;
+    };
+    Misto: {
+        value: string;
+    };
+    Municipality: {
+        value: string;
+    };
+    Name: {
+        value: string;
+    };
+    'No countries found': {
+        value: string;
+    };
+    'No payment method needed for staging': {
+        value: string;
+    };
+    'No shipment rating selected. Please go back to the "Shipping" step and select a shipment rating to proceed.': {
+        value: string;
+    };
+    'No shipping method selected': {
+        value: string;
+    };
+    'No shipping methods found - please review and update your address details by selecting the "Customer" tab above. If you continue to encounter issues, contact our support team for assistance.': {
+        value: string;
+    };
+    'No shipping methods found - try editing your address or contacting support if the error persists': {
+        value: string;
+    };
+    'Nothing due at delivery': {
+        value: string;
+    };
+    'Nothing due at the door': {
+        value: string;
+    };
+    OK: {
+        value: string;
+    };
+    Oblast: {
+        value: string;
+    };
+    'Order complete!': {
+        value: string;
+    };
+    'Order details': {
+        value: string;
+    };
+    'Order total': {
+        value: string;
+    };
+    'Ordered from': {
+        value: string;
+    };
+    'Orders to [countryName] must be over [threshold] to ship.': {
+        value: string;
+    };
+    Parish: {
+        value: string;
+    };
+    'Pay [orderTotal]': {
+        value: string;
+    };
+    'Pay [organizationName]': {
+        value: string;
+    };
+    'Pay in USD (United States Dollar)?': {
+        value: string;
+    };
+    Payment: {
+        value: string;
+    };
+    'Payment failed': {
+        value: string;
+    };
+    'Payment failed. Please reload the page and try another payment method.': {
+        value: string;
+    };
+    'Payment failed. Please try another payment method.': {
+        value: string;
+    };
+    'Payment method': {
+        value: string;
+    };
+    "Payment processing. We'll update you when payment is received.": {
+        value: string;
+    };
+    'Payment total': {
+        value: string;
+    };
+    'Personal Customers Clearance Code': {
+        value: string;
+    };
+    'Phone number': {
+        value: string;
+    };
+    'Place test order': {
+        value: string;
+    };
+    'Please ensure your text uses the Latin alphabet only (A-Z, a-z).': {
+        value: string;
+    };
+    'Please enter a valid email address.': {
+        value: string;
+    };
+    'Please provide a mobile phone number.': {
+        value: string;
+    };
+    'Please provide your first name.': {
+        value: string;
+    };
+    'Please provide your last name.': {
+        value: string;
+    };
+    'Poshtovyy indeks': {
+        value: string;
+    };
+    'Postal code': {
+        value: string;
+    };
+    Postcode: {
+        value: string;
+    };
+    'Powered by': {
+        value: string;
+    };
+    Prefecture: {
+        value: string;
+    };
+    'Prepay duties and taxes at checkout': {
+        value: string;
+    };
+    'Privacy policy': {
+        value: string;
+    };
+    'Proceed with order': {
+        value: string;
+    };
+    'Product prices already include duties and fees. No additional duties or fees will be added at checkout.': {
+        value: string;
+    };
+    'Product prices already include duties, taxes and fees. No additional duties, taxes, or fees will be added at checkout.': {
+        value: string;
+    };
+    'Product prices already include taxes. No additional taxes will be added at checkout.': {
+        value: string;
+    };
+    Province: {
+        value: string;
+    };
+    Quantity: {
+        value: string;
+    };
+    'RFC number': {
+        value: string;
+    };
+    Region: {
+        value: string;
+    };
+    Reload: {
+        value: string;
+    };
+    'Restricted item': {
+        value: string;
+    };
+    'Restricted items found': {
+        value: string;
+    };
+    'Return to cart': {
+        value: string;
+    };
+    'Return to merchant site': {
+        value: string;
+    };
+    'Search countries': {
+        value: string;
+    };
+    Sector: {
+        value: string;
+    };
+    'See duty and tax thresholds': {
+        value: string;
+    };
+    Select: {
+        value: string;
+    };
+    'Select a country': {
+        value: string;
+    };
+    'Select a language': {
+        value: string;
+    };
+    'Session does not have valid landed cost. Please contact [organizationName] for assistance.': {
+        value: string;
+    };
+    'Session timed out': {
+        value: string;
+    };
+    Shipping: {
+        value: string;
+    };
+    'Shipping address': {
+        value: string;
+    };
+    'Shipping address same as billing': {
+        value: string;
+    };
+    'Shipping method': {
+        value: string;
+    };
+    'Shopping cart expired': {
+        value: string;
+    };
+    Show: {
+        value: string;
+    };
+    'Show non-prepaid options': {
+        value: string;
+    };
+    'Something went wrong.': {
+        value: string;
+    };
+    'Spend up to [threshold] duty free.': {
+        value: string;
+    };
+    'Spend up to [threshold] tax free.': {
+        value: string;
+    };
+    'Staging mode': {
+        value: string;
+    };
+    State: {
+        value: string;
+    };
+    'State or Territory': {
+        value: string;
+    };
+    'State or province': {
+        value: string;
+    };
+    'State/Province': {
+        value: string;
+    };
+    'State/Province/Region/Prefecture': {
+        value: string;
+    };
+    'Street address': {
+        value: string;
+    };
+    'Street address 2': {
+        value: string;
+    };
+    'Street address 3': {
+        value: string;
+    };
+    'Street or avenue': {
+        value: string;
+    };
+    Subtotal: {
+        value: string;
+    };
+    Success: {
+        value: string;
+    };
+    'Tax id is required': {
+        value: string;
+    };
+    Taxes: {
+        value: string;
+    };
+    'Taxes and fees': {
+        value: string;
+    };
+    'Taxes included': {
+        value: string;
+    };
+    'Taxes will apply to all orders.': {
+        value: string;
+    };
+    'Taxes, duties, and fees included': {
+        value: string;
+    };
+    'Test cards': {
+        value: string;
+    };
+    'Test mode': {
+        value: string;
+    };
+    'Thank you for submitting your payment. We appreciate your prompt attention.': {
+        value: string;
+    };
+    'The field is incomplete': {
+        value: string;
+    };
+    'The following items are unable to be shipped to your country and are not included in your cart total.': {
+        value: string;
+    };
+    "The item you're looking for is currently unavailable in our inventory. Please check back later or contact support for assistance with availability.": {
+        value: string;
+    };
+    'The low-value GST law passed July 1st, 2018 applies to this retailer.': {
+        value: string;
+    };
+    'The purchase price covers duties, taxes and fees.': {
+        value: string;
+    };
+    "There's been an error creating your checkout session. Please reload and try again or contact support if the error persists": {
+        value: string;
+    };
+    "There's been an error updating your checkout session. Please reload and try again or contact support if the error persists": {
+        value: string;
+    };
+    'To ensure delivery all address details must be in Latin characters.': {
+        value: string;
+    };
+    'Total paid': {
+        value: string;
+    };
+    Town: {
+        value: string;
+    };
+    'Town / City': {
+        value: string;
+    };
+    'Town or city': {
+        value: string;
+    };
+    'Translated address': {
+        value: string;
+    };
+    Ulica: {
+        value: string;
+    };
+    'Unable to check inventory. Please try again.': {
+        value: string;
+    };
+    'Unable to complete payment in [currency]. Please try again or select a different currency. If the issue persists, contact our support team for assistance.': {
+        value: string;
+    };
+    'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
+        value: string;
+    };
+    'Unique Labor Identification Code': {
+        value: string;
+    };
+    'Update address': {
+        value: string;
+    };
+    'Update your address': {
+        value: string;
+    };
+    'View GAA Form.': {
+        value: string;
+    };
+    'View receipt': {
+        value: string;
+    };
+    Village: {
+        value: string;
+    };
+    "We couldn't complete your payment. Please verify the payment details and try again.": {
+        value: string;
+    };
+    "We've sent an email confirmation of the order details for your review. And our team is carefully preparing your order so it arrives on time.": {
+        value: string;
+    };
+    'Welcome to [storeName]': {
+        value: string;
+    };
+    'Welcome!': {
+        value: string;
+    };
+    'What you entered': {
+        value: string;
+    };
+    'Would you like to close checkout and return to the site?': {
+        value: string;
+    };
+    'You are being sent back to the shop to re-add items to your cart.': {
+        value: string;
+    };
+    'You may incur additional fees from the shipping carrier by not prepaying.': {
+        value: string;
+    };
+    "You will be redirected back to the merchant's site in a few seconds.": {
+        value: string;
+    };
+    "You're all set!": {
+        value: string;
+    };
+    'Your [zipLabel] is invalid': {
+        value: string;
+    };
+    'Your checkout session has expired. Please reload the page to continue.': {
+        value: string;
+    };
+    'Your mobile phone number is incomplete.': {
+        value: string;
+    };
+    'Your order has been successfully placed.': {
+        value: string;
+    };
+    'Your payment went through successfully! Thank you for shopping with us! We hope you had an enjoyable experience and your support means the world to us.': {
+        value: string;
+    };
+    'Your selected payment method requires additional verification. Please follow the instructions provided by your payment provider to complete the transaction.': {
+        value: string;
+    };
+    'ZIP code': {
+        value: string;
+    };
+    Zip: {
+        value: string;
+    };
+    '[fieldLabel] is [currentLength] characters. Please shorten to [maxLength] or less or move the rest to address line 2.': {
+        value: string;
+    };
+    '[fieldLabel] is [currentLength] characters. Please shorten to [maxLength] or less.': {
+        value: string;
+    };
+    '[percentage] GST due on any order above [threshold].': {
+        value: string;
+    };
+    'business days': {
+        value: string;
+    };
+    'click to learn more': {
+        value: string;
+    };
+    days: {
+        value: string;
+    };
+    'restricted items': {
+        value: string;
+    };
+    weeks: {
+        value: string;
+    };
+};
+
+type ITranslationKey = keyof typeof stringsBase;
+
 type BuildLandedCostParams = {
     billingAddress: CalculateLandedCostRequest['billingAddress'];
     billingContact: CalculateLandedCostRequest['billingContact'];
@@ -6369,6 +7126,14 @@ type CheckoutConfig = {
      */
     onInventoryCheck?: (params: {
         items: CartItem[];
+        /**
+         * The URL for the Zonos API.
+         */
+        zonosApiRoute: string;
+        /**
+         * Utility function to translate strings.
+         */
+        translate: (key: ITranslationKey) => string;
     }) => Promise<string | null>;
     /**
      * Callback trigger when payment succeeds