@zonos/elements 1.3.51 → 1.3.52

package/dist/types/scripts/_zonosBase.d.ts

@@ -1,13 +1,11 @@
 import type { PayPalNamespace } from '@paypal/paypal-js';
 import type { Stripe } from '@stripe/stripe-js';
 import type { AppearanceConfig } from "../components/store/zonosStore";
-import { type InjectScriptType } from "./_getNextFallbackUrl";
 import type { NotificationInit } from "../types/index";
-import type { TempCart } from "../types/checkout/api/TempCart";
-import type { CheckoutConfig } from "../types/checkout/CheckoutConfig";
+import type { NormalizedTempCart } from "../types/checkout/api/NormalizedTempCart";
+import { type CheckoutConfig } from "../types/checkout/CheckoutConfig";
 import type { CountryCode, CurrencyCode, PaypalMockResponse } from "../types/generated/graphql.customer.types";
 import type { HelloConfig } from "../types/hello/HelloConfig";
-export declare const MAIN_LOAD_CDN_TYPE: InjectScriptType;
 /**
  * Currency converter function to be used in Hello and Checkout
  * @note don't modify the element directly in this function, otherwise it might cause unexpected behavior like an infinite loop
@@ -173,17 +171,17 @@ export type LoadZonosParamsConfig = {
 export type LoadZonosParams = LoadZonosParamsConfig & {
     storeId: number;
     /**
-     * Temporary cart UUID to be used for legacy zonos checkout. If this is provided, no need to configure `buildCartDetail`, `buildLandedCost` callback, zonosApiKey or storeId
-     * @note This would be deprecated in the future when we fully migrate to new zonos checkout
+     * If cart id is provided in the url with query param zCartUUID, you don't need to provide zonosApiKey
      */
-    tempCartUUID?: string;
-    zonosApiKey: string;
+    zonosApiKey?: string;
 };
 export interface Zonos {
     /**
      * Mock error response for Paypal. Mainly used for testing purposes
      */
     _paypalMockResponse: PaypalMockResponse | null;
+    cartData: NormalizedTempCart | null;
+    cartId: string | null;
     /**
      * Toggle debug mode (add query param 'zonosDebug=1' to url)
      * @default false
@@ -191,6 +189,10 @@ export interface Zonos {
     debug?: boolean;
     doneInit: boolean;
     isBigCommerce: boolean;
+    /**
+     * This will be set to true when it's called form legacy checkout
+     */
+    isLegacyCheckout: boolean;
     isNpm: boolean;
     /** Flag if already alerted when preview domain is defined and it's connecting production environment */
     modeAlerted: boolean;
@@ -202,9 +204,8 @@ export interface Zonos {
     storeId: number;
     /** Stripe instance */
     stripe: Stripe;
-    tempCartData: TempCart | null;
     version: string;
-    zonosApiKey: string;
+    zonosApiKey?: string;
     /**
      * Flag to send tracking event to api for conversion testing, since we don't send tracking event to api when in debug/development mode
      */
@@ -220,7 +221,7 @@ export interface Zonos {
     updateOrganizationName: (organizationName: string) => void;
 }
 export declare abstract class Zonos {
-    static zonosApiKey: string;
+    static zonosApiKey?: string;
     static stripe: Stripe;
     static storeId: number;
     static doneInit: boolean;
@@ -229,6 +230,7 @@ export declare abstract class Zonos {
     static _paypalMockResponse: PaypalMockResponse | null;
     static isBigCommerce: boolean;
     static releaseDate: string;
+    static isLegacyCheckout: boolean;
     /**
      * By default, the package will load from npm
      */
@@ -236,9 +238,10 @@ export declare abstract class Zonos {
     static zonosQaUrl: string | null;
     static version: string;
     static modeAlerted: boolean;
-    static tempCartData: TempCart | null;
+    static cartData: NormalizedTempCart | null;
     static paypal: PayPalNamespace | null;
     static getCurrentTimestamp: () => number;
+    static cartId: string | null;
     private static zonosController;
     static init: ({ appearance, checkoutSettings, currencyConverter, helloSettings, onCountryChange, overrideCurrencyFormat, storeId, zonosApiKey, }: LoadZonosParams) => Promise<void>;
     static displayCurrency: () => void;

package/dist/types/scripts/cart/_getCartIdFromParam.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Simple function to get the cart id from the query param.
+ */
+export declare const getCartIdFromQueryParam: () => string | null;

package/dist/types/scripts/cart/_setupCartData.d.ts

@@ -0,0 +1,7 @@
+export declare const setupCartData: (cartId: string) => Promise<{
+    cartData: import("../../types/checkout/api/NormalizedTempCart").NormalizedTempCart;
+    storeFavicon: string;
+    storeId: number;
+    storeLogo: string;
+    zonosApiKey: string;
+} | null>;

package/dist/types/types/checkout/CheckoutConfig.d.ts

@@ -1,6 +1,8 @@
 import type { CartItem } from "../../components/store/checkout/cart";
 import type { BuildLandedCostParams, BuildLandedCostResponse } from "../../components/utils/api/triggerBuildLandedCost";
 import type { AnalyticsProviderStatus, AnalyticsProviderType, CheckoutSubscriptionStatus, CheckoutSuccessBehavior, CheckoutVisibilityStatus, CountryCode, CurrencyCode, ExternalPaymentMethodStatus, ExternalPaymentMethodType, ExternalServiceTokenType, GetOrderQuery, Mode, NotificationActiveStatus } from "../generated/graphql.customer.types";
+export declare const checkoutHiddenBtnSelector = "zonos--checkout-hidden-button";
+export declare const domesticRedirectedBtnSelector = "zonos--domestic-redirected-checkout-button";
 export type ZonosOrder = GetOrderQuery['order'];
 export type { BuildLandedCostParams, BuildLandedCostResponse };
 export type BuildCardDetailParams = {
@@ -84,8 +86,11 @@ export type CheckoutConfig = {
     successRedirectUrl: string;
     visibilityStatus: CheckoutVisibilityStatus;
     /**
-     * Cart info callback for checkout (optional)
-     * @note will use temp cart data if available
+     * Cart info callback for checkout (optional),
+     * @deprecated
+     * @note
+     * This function is deprecated in favor of new API `createCartId`
+     * @note will attempt to use cart data if available
      * User can dispatch an event 'zonos--init-cart-info' to update the cart
      * @example
      * const initEvent = new CustomEvent<CartItem[]>('zonos--init-cart-info', {
@@ -106,9 +111,19 @@ export type CheckoutConfig = {
     buildCartDetail?: (params: BuildCardDetailParams) => Promise<CartItem[]>;
     /**
      * Calculate landed cost callback for checkout (optional)
-     * @note will use temp cart data if available
+     * @deprecated
+     * @note
+     * This function is deprecated in favor of new API `createCartId`
+     * @note will attempt to use cart data if available
      */
     buildLandedCost?: (params: BuildLandedCostParams) => Promise<BuildLandedCostResponse>;
+    /**
+     * Callback that returns the cart id from `cartCreate` mutation.
+     * @note
+     * The mutation `cartCreate` is preferred to be called in the server side
+     * @returns string - Cart ID
+     */
+    createCartId?: () => Promise<string> | string;
     /**
      * Callback trigger when the checkout is closed
      */

package/dist/types/types/checkout/api/CalculateLandedCostRequest.d.ts

@@ -1,5 +1,5 @@
 import type { CartItem } from "../../../components/store/checkout/cart";
-import type { LandedCostAdjustmentType } from "../../generated/graphql.customer.types";
+import type { CurrencyCode, LandedCostAdjustmentType } from "../../generated/graphql.customer.types";
 export type CalculateLandedCostRequest = {
     billingAddress: {
         addressLine1: string;
@@ -24,6 +24,8 @@ export type CalculateLandedCostRequest = {
     items: CartItem[];
     landedCostAdjustments?: {
         amount: number;
+        productId: string | null;
+        sku: string | null;
         type: LandedCostAdjustmentType;
     }[];
     metadata?: {
@@ -39,3 +41,42 @@ export type CalculateLandedCostRequest = {
         state: string;
     };
 };
+export type CartCalculateLandedCostRequest = {
+    billingAddress: {
+        addressLine1: string;
+        addressLine2?: string | undefined;
+        city: string;
+        country: string;
+        postalCode: string;
+        state: string;
+    };
+    billingContact: {
+        firstName: string;
+        lastName: string;
+        phone: string;
+    };
+    /**
+     * Currency code of the first item in the cart
+     */
+    cartCurrencyCode: CurrencyCode;
+    cartId: string;
+    checkoutSessionId: string;
+    contact: {
+        email?: string;
+        firstName: string;
+        lastName: string;
+        phone: string;
+    };
+    metadata?: {
+        key: string;
+        value: string;
+    }[];
+    shippingAddress: {
+        addressLine1: string;
+        addressLine2?: string | undefined;
+        city: string;
+        country: string;
+        postalCode: string;
+        state: string;
+    };
+};

package/dist/types/types/checkout/api/NormalizedTempCart.d.ts

@@ -0,0 +1,37 @@
+import type { CartAdjustmentType, CountryCode, CurrencyCode, ItemMeasurementType, ItemType, ItemUnitOfMeasure } from "../../generated/graphql.customer.types";
+export type NormalizedTempCartItem = {
+    amount: number;
+    attributes: {
+        key: string;
+        value: string;
+    }[];
+    countryOfOrigin: CountryCode | null;
+    currencyCode: CurrencyCode;
+    description: string | null;
+    id: string;
+    imageUrl: string | null;
+    itemType: ItemType | null;
+    measurements: {
+        type: ItemMeasurementType;
+        unitOfMeasure: ItemUnitOfMeasure;
+        value: number;
+    }[];
+    name: string | null;
+    productId: string | null;
+    quantity: number;
+    sku: string | null;
+};
+export type NormalizedTempCart = {
+    adjustments: {
+        amount: number;
+        currencyCode: CurrencyCode;
+        description: string;
+        productId: string | null;
+        sku: string | null;
+        type: CartAdjustmentType;
+    }[];
+    credentialToken: string;
+    items: NormalizedTempCartItem[];
+    storeBaseUrl: string;
+    storeId: number;
+};

package/dist/types/types/generated/graphql.customer.types.d.ts

@@ -2593,6 +2593,116 @@ export declare const zonosAttribution: {
     readonly Enabled: "ENABLED";
 };
 export type ZonosAttribution = (typeof zonosAttribution)[keyof typeof zonosAttribution];
+export type CartCalculateLandedCostMutation = {
+    cartWorkflow: {
+        id: string;
+        items: Array<{
+            amount: number;
+            attributes: Array<{
+                key: string | null;
+                value: string | null;
+            } | null> | null;
+            description: string | null;
+            id: string;
+            imageUrl: string | null;
+            name: string | null;
+            quantity: number;
+            restriction: {
+                action: RestrictedItemAction;
+                reason: string;
+            } | null;
+            sku: string | null;
+        }>;
+    };
+    cartonizeWorkflow: Array<{
+        id: string;
+        items: Array<{
+            item: {
+                id: string;
+            };
+        }> | null;
+        type: PackagingType;
+    } | null> | null;
+    checkoutSessionWorkflow: Array<{
+        landedCost: {
+            id: string;
+        } | null;
+        landedCostId: string;
+        subtotals: {
+            adjustments: number;
+            duties: number;
+            presentmentCurrencyCode: CurrencyCode;
+            fees: number;
+            items: number;
+            landedCostTotal: number;
+            taxes: number;
+            shipping: number;
+            exchangeRate: {
+                id: string;
+                rate: number;
+                sourceCurrencyCode: CurrencyCode;
+                targetCurrencyCode: CurrencyCode;
+                type: ExchangeRateType;
+            };
+            total: number;
+        };
+    }> | null;
+    landedCostCalculateWorkflow: Array<{
+        amountSubtotals: {
+            discounts: number | null;
+        } | null;
+        landedCostGuaranteeCode: LandedCostGuaranteeCode;
+        deMinimis: Array<{
+            formula: string;
+            threshold: DeMinimisThreshold;
+            method: IncotermCode;
+            note: string;
+            type: DeMinimisType;
+        }>;
+        duties: Array<{
+            amount: number;
+            currencyCode: CurrencyCode;
+        }>;
+        fees: Array<{
+            amount: number;
+            currencyCode: CurrencyCode;
+        }>;
+        id: string;
+        appliedAdjustments: Array<{
+            amount: number;
+            item: {
+                amount: number;
+            } | null;
+            type: LandedCostAdjustmentType | null;
+        }> | null;
+        method: IncotermCode;
+        shipmentRating: {
+            amount: number;
+            currencyCode: CurrencyCode;
+            displayName: string;
+            id: string;
+            maxTransitAt: string | null;
+            minTransitAt: string | null;
+        };
+        taxes: Array<{
+            amount: number;
+            currencyCode: CurrencyCode;
+        }>;
+    } | null> | null;
+    partyCreateWorkflow: Array<{
+        id: string;
+        organization: string;
+        type: PartyType | null;
+    }>;
+    shipmentRatingCalculateWorkflow: Array<{
+        amount: number;
+        currencyCode: CurrencyCode;
+        displayName: string;
+        id: string;
+        maxTransitAt: string | null;
+        minTransitAt: string | null;
+    }>;
+};
 export type CalculateLandedCostMutation = {
     cartonizeWorkflow: Array<{
         id: string;
@@ -2607,7 +2717,9 @@ export type CalculateLandedCostMutation = {
         landedCost: {
             id: string;
         } | null;
+        landedCostId: string;
         subtotals: {
+            adjustments: number;
             duties: number;
             exchangeRate: {
                 id: string;
@@ -2643,6 +2755,9 @@ export type CalculateLandedCostMutation = {
         sku: string | null;
     }>;
     landedCostCalculateWorkflow: Array<{
+        amountSubtotals: {
+            discounts: number | null;
+        } | null;
         appliedAdjustments: Array<{
             amount: number;
             item: {
@@ -2653,8 +2768,8 @@ export type CalculateLandedCostMutation = {
         deMinimis: Array<{
             formula: string;
             method: IncotermCode;
-            note: string;
             threshold: DeMinimisThreshold;
+            note: string;
             type: DeMinimisType;
         }>;
         duties: Array<{
@@ -2670,8 +2785,8 @@ export type CalculateLandedCostMutation = {
         method: IncotermCode;
         shipmentRating: {
             amount: number;
-            displayName: string;
             currencyCode: CurrencyCode;
+            displayName: string;
             id: string;
             maxTransitAt: string | null;
             minTransitAt: string | null;
@@ -2695,11 +2810,30 @@ export type CalculateLandedCostMutation = {
         minTransitAt: string | null;
     }>;
 };
+export type CartItemFragmentFragment = {
+    amount: number;
+    attributes: Array<{
+        key: string | null;
+        value: string | null;
+    } | null> | null;
+    description: string | null;
+    id: string;
+    imageUrl: string | null;
+    name: string | null;
+    quantity: number;
+    restriction: {
+        action: RestrictedItemAction;
+        reason: string;
+    } | null;
+    sku: string | null;
+};
 export type CheckoutPresentmentFragment = {
     landedCost: {
         id: string;
     } | null;
+    landedCostId: string;
     subtotals: {
+        adjustments: number;
         duties: number;
         exchangeRate: {
             id: string;
@@ -2718,6 +2852,9 @@ export type CheckoutPresentmentFragment = {
     };
 };
 export type LandedCostFragment = {
+    amountSubtotals: {
+        discounts: number | null;
+    } | null;
     appliedAdjustments: Array<{
         amount: number;
         item: {
@@ -2835,10 +2972,12 @@ export type GetTaxIdByCountryQuery = {
 };
 export type CheckoutSessionCreateMutation = {
     checkoutSessionCreate: {
+        cartId: string | null;
         clientSecret: string;
         id: string;
         landedCost: {
             amountSubtotals: {
+                discounts: number | null;
                 duties: number;
                 fees: number;
                 items: number;
@@ -2859,6 +2998,7 @@ export type CheckoutSessionCreateMutation = {
         } | null> | null;
         organizationId: string;
         subtotals: {
+            adjustments: number;
             duties: number;
             exchangeRate: {
                 id: string;
@@ -2878,10 +3018,12 @@ export type CheckoutSessionCreateMutation = {
     };
 };
 export type CheckoutDetailsFragment = {
+    cartId: string | null;
     clientSecret: string;
     id: string;
     landedCost: {
         amountSubtotals: {
+            discounts: number | null;
             duties: number;
             fees: number;
             items: number;
@@ -2902,6 +3044,7 @@ export type CheckoutDetailsFragment = {
     } | null> | null;
     organizationId: string;
     subtotals: {
+        adjustments: number;
         duties: number;
         exchangeRate: {
             id: string;
@@ -2994,10 +3137,12 @@ export type CheckoutSessionUpdateMetadataMutation = {
 };
 export type CheckoutSessionUpdateMutation = {
     checkoutSessionUpdate: {
+        cartId: string | null;
         clientSecret: string;
         id: string;
         landedCost: {
             amountSubtotals: {
+                discounts: number | null;
                 duties: number;
                 fees: number;
                 items: number;
@@ -3018,6 +3163,7 @@ export type CheckoutSessionUpdateMutation = {
         } | null> | null;
         organizationId: string;
         subtotals: {
+            adjustments: number;
             duties: number;
             exchangeRate: {
                 id: string;
@@ -3037,10 +3183,12 @@ export type CheckoutSessionUpdateMutation = {
     };
 };
 export type CheckoutSessionUpdateDetailsFragment = {
+    cartId: string | null;
     clientSecret: string;
     id: string;
     landedCost: {
         amountSubtotals: {
+            discounts: number | null;
             duties: number;
             fees: number;
             items: number;
@@ -3061,6 +3209,7 @@ export type CheckoutSessionUpdateDetailsFragment = {
     } | null> | null;
     organizationId: string;
     subtotals: {
+        adjustments: number;
         duties: number;
         exchangeRate: {
             id: string;
@@ -3175,6 +3324,7 @@ export type ZonosSettingsQuery = {
     } | null;
     onlineStoreSettings: {
         allowedDomains: Array<string>;
+        url: string;
     };
     organization: {
         id: string;
@@ -3468,6 +3618,91 @@ export type RemoveTrackingNumberMutation = {
         trackingNumbers: Array<string | null> | null;
     } | null;
 };
+export type CartQuery = {
+    cart: {
+        adjustments: Array<{
+            amount: number;
+            currencyCode: CurrencyCode;
+            description: string;
+            productId: string | null;
+            sku: string | null;
+            type: CartAdjustmentType;
+        }>;
+        id: string;
+        items: Array<{
+            amount: number;
+            attributes: Array<{
+                key: string | null;
+                value: string | null;
+            } | null> | null;
+            countryOfOrigin: CountryCode | null;
+            currencyCode: CurrencyCode;
+            description: string | null;
+            id: string;
+            imageUrl: string | null;
+            itemType: ItemType | null;
+            measurements: Array<{
+                type: ItemMeasurementType;
+                unitOfMeasure: ItemUnitOfMeasure;
+                value: number;
+            } | null> | null;
+            name: string | null;
+            productId: string;
+            quantity: number;
+            sku: string | null;
+        }>;
+        metadata: Array<{
+            key: string;
+            value: string;
+        }>;
+        organizationId: string;
+    } | null;
+};
+export type GetCartOrganizationInfoQuery = {
+    onlineStoreSettings: {
+        url: string;
+    };
+    organization: {
+        references: {
+            storeId: number | null;
+        } | null;
+    } | null;
+};
+export type CartCreateMutation = {
+    cartCreate: {
+        adjustments: Array<{
+            amount: number;
+            currencyCode: CurrencyCode;
+            description: string;
+            productId: string | null;
+            sku: string | null;
+            type: CartAdjustmentType;
+        }>;
+        id: string;
+        items: Array<{
+            amount: number;
+            attributes: Array<{
+                key: string | null;
+                value: string | null;
+            } | null> | null;
+            description: string | null;
+            id: string;
+            imageUrl: string | null;
+            name: string | null;
+            quantity: number;
+            restriction: {
+                action: RestrictedItemAction;
+                reason: string;
+            } | null;
+            sku: string | null;
+        }>;
+        metadata: Array<{
+            key: string;
+            value: string;
+        }>;
+        organizationId: string;
+    };
+};
 export type SdkFunctionWrapper = <T>(action: (requestHeaders?: Record<string, string>) => Promise<T>, operationName: string, operationType?: string) => Promise<T>;
 export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionWrapper): {
     addTrackingNumber(variables?: {
@@ -3479,6 +3714,15 @@ export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionW
     calculateLandedCost(variables?: {
         [x: string]: never;
     }, requestHeaders?: GraphQLClientRequestHeaders): Promise<CalculateLandedCostMutation>;
+    cart(variables?: {
+        [x: string]: never;
+    }, requestHeaders?: GraphQLClientRequestHeaders): Promise<CartQuery>;
+    cartCalculateLandedCost(variables?: {
+        [x: string]: never;
+    }, requestHeaders?: GraphQLClientRequestHeaders): Promise<CartCalculateLandedCostMutation>;
+    cartCreate(variables?: {
+        [x: string]: never;
+    }, requestHeaders?: GraphQLClientRequestHeaders): Promise<CartCreateMutation>;
     checkItemRestrictions(variables?: {
         [x: string]: never;
     }, requestHeaders?: GraphQLClientRequestHeaders): Promise<CheckItemRestrictionsMutation>;
@@ -3503,6 +3747,9 @@ export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionW
     fulfillmentCenter(variables?: {
         [x: string]: never;
     }, requestHeaders?: GraphQLClientRequestHeaders): Promise<FulfillmentCenterQuery>;
+    getCartOrganizationInfo(variables?: {
+        [x: string]: never;
+    }, requestHeaders?: GraphQLClientRequestHeaders): Promise<GetCartOrganizationInfoQuery>;
     getCheckoutPlaceOrderButtonSelector(variables?: {
         [x: string]: never;
     }, requestHeaders?: GraphQLClientRequestHeaders): Promise<GetCheckoutPlaceOrderButtonSelectorQuery>;