@zonos/elements 1.3.246 → 1.3.248

package/dist/types/components/checkout/zonos-checkout/zonos-checkout-finish/zonos-checkout-finish.d.ts

@@ -35,6 +35,10 @@ export declare class ZonosCheckoutFinish {
      */
     isWaitingToRedirect: boolean;
     private pullOrder;
+    /**
+     * Metadata for purchase event in GA4
+     */
+    private buildPurchaseMetadata;
     private redirectToUrl;
     private isRedirectBehavior;
     /**

package/dist/types/components/checkout/zonos-checkout/zonos-customer-info/zonos-customer-info.d.ts

@@ -61,6 +61,10 @@ export declare class ZonosCustomerInfo {
      * Whether or not the tax id input is invalid
      */
     taxIdErrorMessage: string;
+    /**
+     * Whether or not the short address code input is invalid
+     */
+    shortAddressCodeErrorMessage: string;
     /**
      * Whether or not the shipping address contains invalid characters
      */

package/dist/types/components/checkout/zonos-checkout/zonos-shipping/zonos-shipping.d.ts

@@ -14,6 +14,10 @@ export declare class ZonosShipping {
      * Whether or not the checkout is in mobile mode
      */
     submitBtnType?: HTMLZonosButtonElement['variant'];
+    /**
+     * Whether or not the checkout is in mobile mode
+     */
+    isMobile: boolean;
     /**
      * Event to emit when the continue button is clicked
      */

package/dist/types/components/common/zonos-shipping-rich-radio/zonos-shipping-rich-radio.d.ts

@@ -13,6 +13,7 @@ export type ShippingRichRadioItem = {
     value: string | number;
 };
 export declare class ZonosShippingRichRadio {
+    ele: HTMLZonosShippingRichRadioElement;
     /**
      * List of items to display
      */
@@ -31,6 +32,10 @@ export declare class ZonosShippingRichRadio {
      * Theme of the radio item
      */
     theme?: ElementsUiTheme;
+    /**
+     * Whether or not the radio item is in mobile mode
+     */
+    isMobile: boolean;
     /**
      * Selected item
      * @default {null|firstItem}

package/dist/types/components/store/checkout/stripe.d.ts

@@ -70,6 +70,10 @@ type StripeStore = {
      * Shipping party id (used for async address update)
      */
     partyShippingId: string | null;
+    /**
+     * Short address code only required for Saudi Arabia
+     */
+    shortAddressCode: string;
     /**
      * Toggle to indicate if we should refund the inventory when the payment is failed
      */
@@ -181,6 +185,8 @@ declare const stripeStoreRetrievePayment: ({ clientSecret: _clientSecret, storyb
     error: boolean;
     messages: string[];
     message?: undefined;
+    amount?: undefined;
+    currency?: undefined;
     paymentIntentId?: undefined;
     paymentMethod?: undefined;
     status?: undefined;
@@ -188,10 +194,14 @@ declare const stripeStoreRetrievePayment: ({ clientSecret: _clientSecret, storyb
     error: boolean;
     message: string[];
     messages?: undefined;
+    amount?: undefined;
+    currency?: undefined;
     paymentIntentId?: undefined;
     paymentMethod?: undefined;
     status?: undefined;
 } | {
+    amount: number | undefined;
+    currency: string | undefined;
     error: boolean;
     messages: string[];
     paymentIntentId: string | undefined;

package/dist/types/components/store/translationStore/strings.arabic.d.ts

@@ -284,6 +284,9 @@ export declare const stringsArabic: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsArabic: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.base.d.ts

@@ -284,6 +284,9 @@ export declare const stringsBase: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsBase: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.chinese.d.ts

@@ -284,6 +284,9 @@ export declare const stringsChinese: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsChinese: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.danish.d.ts

@@ -284,6 +284,9 @@ export declare const stringsDanish: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsDanish: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.dutch.d.ts

@@ -284,6 +284,9 @@ export declare const stringsDutch: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsDutch: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.french.d.ts

@@ -284,6 +284,9 @@ export declare const stringsFrench: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsFrench: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.german.d.ts

@@ -284,6 +284,9 @@ export declare const stringsGerman: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsGerman: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.hebrew.d.ts

@@ -284,6 +284,9 @@ export declare const stringsHebrew: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsHebrew: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.indonesian.d.ts

@@ -284,6 +284,9 @@ export declare const stringsIndonesian: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsIndonesian: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.italian.d.ts

@@ -284,6 +284,9 @@ export declare const stringsItalian: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsItalian: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.japanese.d.ts

@@ -284,6 +284,9 @@ export declare const stringsJapanese: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsJapanese: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.korean.d.ts

@@ -284,6 +284,9 @@ export declare const stringsKorean: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsKorean: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.norwegian.d.ts

@@ -284,6 +284,9 @@ export declare const stringsNorwegian: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsNorwegian: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.polish.d.ts

@@ -284,6 +284,9 @@ export declare const stringsPolish: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsPolish: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.portuguese.d.ts

@@ -284,6 +284,9 @@ export declare const stringsPortuguese: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsPortuguese: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.russian.d.ts

@@ -284,6 +284,9 @@ export declare const stringsRussian: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsRussian: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.spanish.d.ts

@@ -284,6 +284,9 @@ export declare const stringsSpanish: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsSpanish: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.swedish.d.ts

@@ -284,6 +284,9 @@ export declare const stringsSwedish: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsSwedish: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.turkish.d.ts

@@ -284,6 +284,9 @@ export declare const stringsTurkish: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsTurkish: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/store/translationStore/strings.vietnamese.d.ts

@@ -284,6 +284,9 @@ export declare const stringsVietnamese: {
     'Invalid session': {
         value: string;
     };
+    'Invalid short address code format. Must be 4 letters and 4 numbers.': {
+        value: string;
+    };
     'Invoice:': {
         value: string;
     };
@@ -527,6 +530,12 @@ export declare const stringsVietnamese: {
     'Shopping cart expired': {
         value: string;
     };
+    'Short address code': {
+        value: string;
+    };
+    'Short address code is required.': {
+        value: string;
+    };
     Show: {
         value: string;
     };

package/dist/types/components/stripe/zonos-address/zonos-address.d.ts

@@ -22,6 +22,10 @@ export declare class ZonosAddress {
      * Error message for tax id input
      */
     taxIdErrorMessage: string;
+    /**
+     * Error message for short address code input
+     */
+    shortAddressCodeErrorMessage: string;
     /**
      * Event to emit when address is not containing allowed character sets
      */
@@ -65,6 +69,10 @@ export declare class ZonosAddress {
      * Render tax id input based on ship to country code
      */
     private renderTaxIdInput;
+    /**
+     * Render short address code input based on ship to country code
+     */
+    private renderShortAddressCodeInput;
     private renderCompanyNameInput;
     disconnectedCallback(): void;
     componentDidLoad(): void;

package/dist/types/components/stripe/zonos-custom-address/zonos-custom-address.d.ts

@@ -23,6 +23,10 @@ export declare class ZonosAddress {
      * Error message for tax id input
      */
     taxIdErrorMessage: string;
+    /**
+     * Error message for short address code input
+     */
+    shortAddressCodeErrorMessage: string;
     /**
      * Event to emit when address is not containing allowed character sets
      */
@@ -137,6 +141,10 @@ export declare class ZonosAddress {
      * Render tax id input based on ship to country code
      */
     private renderTaxIdInput;
+    /**
+     * Render short address code input based on ship to country code
+     */
+    private renderShortAddressCodeInput;
     private renderCompanyNameInput;
     private initCountryField;
     private initDefaultCustomAddressForm;

package/dist/types/components/utils/api/getLocaleMessages.d.ts

@@ -4,7 +4,7 @@ export declare const getLocaleMessages: ({ countryCode, localeTo, storeId, }: {
     localeTo?: string;
     storeId: number;
 }) => Promise<{
-    countryCodes: Array<string>;
+    countryCodes: Array<string> | null;
     countryCodesPageMessageLinks: Array<{
         id: number;
         message: {

package/dist/types/components/utils/checkout/shouldRenderShortAddressCodeInput.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Checks if the short address code input should be rendered based on the country code.
+ */
+export declare const shouldRenderShortAddressCodeInput: ({ countryCode, }: {
+    countryCode: string;
+}) => boolean;

package/dist/types/components/utils/shortAddressCodeValidationResult.d.ts

@@ -0,0 +1,12 @@
+type ShortAddressCodeValidationResult = {
+    error: 'Short address code is required.' | 'Invalid short address code format. Must be 4 letters and 4 numbers.';
+    valid: false;
+} | {
+    error: null;
+    valid: true;
+};
+export declare const shortAddressCodeValidationResult: ({ shippingCountry, shortAddressCode, }: {
+    shippingCountry: string;
+    shortAddressCode: string;
+}) => ShortAddressCodeValidationResult;
+export {};

package/dist/types/components/utils/submitGtag.d.ts

@@ -1,11 +1,41 @@
 type CheckoutEvent = 'zonos-checkout-start' | 'zonos-checkout-close' | 'zonos-checkout-success' | 'zonos-checkout-payment-fail' | 'zonos-checkout-customer-info' | 'zonos-checkout-shipping-info' | 'zonos-checkout-payment-info';
+export type PurchaseMetadata = {
+    items: {
+        item_id: string;
+        item_name: string;
+        price: number;
+        quantity: number;
+    }[];
+    transaction_id: string;
+} & ({
+    currency: string;
+    value: number;
+} | {
+    currency: undefined;
+    value: undefined;
+});
+type GtagEvent = {
+    event: CheckoutEvent;
+    metadata?: Record<string, unknown>;
+} | {
+    event: 'purchase';
+    metadata: PurchaseMetadata;
+};
 declare global {
     interface Window {
-        gtag: (event: string, action: string, data: Record<string, unknown>) => void;
+        dataLayer: unknown[];
+        gtag: (event: string, action: string | Date, data?: Record<string, unknown>) => void;
     }
 }
+/**
+ * Sends ping to parent with googleAnalyticId so parent can inject/configure GA and respond with ready.
+ * Call after customHTML or custom script sets window.Zonos.googleAnalyticId.
+ */
+export declare function ensureAnalyticsRelayPing(): void;
 /**
  * Submit a gtag event if the gtag function is available.
+ * When running inside an iframe, only posts to parent after the parent has
+ * confirmed (via analyticsRelayOnInit) that gtag is available.
  */
-export declare const submitGtag: (event: CheckoutEvent) => void;
+export declare const submitGtag: ({ event, metadata }: GtagEvent) => void;
 export {};