@zonos/elements 1.3.7-alpha.0 → 1.3.7-alpha.1

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

@@ -39,6 +39,20 @@ type StripeStore = {
     stripeShippingSameAsBilling: boolean;
 };
 declare const stripeStore: StripeStore;
+export type DomesticShippingSession = {
+    address1: string;
+    address2: string;
+    city: string;
+    countryCode: string;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    postalCode: string;
+    state: string;
+};
+declare const stripeStoreCleanupDomesticShippingSession: () => void;
+declare const stripeStoreSaveDomesticShippingSession: (props: DomesticShippingSession) => void;
+declare const stripeStoreGetDomesticShippingSession: () => DomesticShippingSession | null;
 declare const initStripeElements: (props?: {
     overrideBorderRaidus?: ElementsUiStyle;
     overridePrimaryColor?: string;
@@ -54,10 +68,17 @@ declare const stripeStoreRetrievePayment: ({ clientSecret: _clientSecret, storyb
     error: boolean;
     messages: string[];
     message?: undefined;
+    paymentMethod?: undefined;
 } | {
     error: boolean;
     message: string[];
     messages?: undefined;
+    paymentMethod?: undefined;
+} | {
+    error: boolean;
+    messages: string[];
+    paymentMethod: string | import("@stripe/stripe-js").PaymentMethod | null | undefined;
+    message?: undefined;
 }>;
 declare const stripeStoreConfirmPayment: () => Promise<void>;
 /**
@@ -83,4 +104,4 @@ declare const stripeStoreUpdateCheckoutSession: ({ currency, id, itemsAmount, la
     errors: import("../../..").JsonError[];
     json: CheckoutSessionUpdateMutation | null;
 }>;
-export { initStripeElements, stripeStore, stripeStoreConfirmPayment, stripeStoreInitCheckoutSession, stripeStorePrefetchLandedCost, stripeStoreReset, stripeStoreRetrievePayment, stripeStoreUpdateCheckoutSession, };
+export { initStripeElements, stripeStore, stripeStoreCleanupDomesticShippingSession, stripeStoreConfirmPayment, stripeStoreGetDomesticShippingSession, stripeStoreInitCheckoutSession, stripeStorePrefetchLandedCost, stripeStoreReset, stripeStoreRetrievePayment, stripeStoreSaveDomesticShippingSession, stripeStoreUpdateCheckoutSession, };

package/dist/types/components/store/hello/localization.d.ts

@@ -27,7 +27,7 @@ type ILocaleMessageForUse = {
     pageName: Locale_PageName_Enum;
 };
 declare const localizationStore: LocalizationStore;
-declare const localizationStoreUpdateSelectedCountryCode: (newSelectedCountryCode: CountryCode | null) => Promise<void>;
+declare const localizationStoreUpdateSelectedCountryCode: (newSelectedCountryCode: CountryCode | null) => void;
 declare const initLocalizationStore: () => Promise<void>;
 declare const localizationStoreUpdateSelectedLocale: (newSelectedLocale: Locale_ElementsSupportedLocationCode_Enum) => void;
 export { initLocalizationStore, localizationStore, localizationStoreUpdateSelectedCountryCode, localizationStoreUpdateSelectedLocale, };

package/dist/types/components/store/zonosStore.d.ts

@@ -17,6 +17,7 @@ export type ZonosConfig = {
     currencyConverter?: CurrencyConverter;
     currentHelloPage: Page | '';
     helloSettings: HelloConfig;
+    organizationId: string;
     organizationName: string;
     sourceCurrency: string;
     storeId: number | null;

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

@@ -0,0 +1,3 @@
+type ConversionEvent = 'checkout_open' | 'checkout_customerInfoCompleted' | 'checkout_shippingInfoCompleted' | 'checkout_paymentInfoCompleted' | 'checkout_orderCompleted';
+export declare const trackConversionEvent: (eventName: ConversionEvent, metadata?: Record<string, unknown>) => Promise<void>;
+export {};

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

@@ -0,0 +1 @@
+export declare const isShippableCountry: (showLog?: boolean) => boolean;

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

@@ -0,0 +1,20 @@
+type Params = {
+    domesticRedirectedBtnSelector: string;
+    onShippingAddressSessionFound?: (shippingAddress: {
+        address1: string;
+        address2: string;
+        city: string;
+        countryCode: string;
+        firstName: string;
+        lastName: string;
+        phone: string;
+        postalCode: string;
+        state: string;
+    }) => void;
+};
+/**
+ * Watch for changes in domestic checkout step, this is to redirect user to home page and open checkout if user enters the ship to country that's in the shipping zone
+ * @note Only works on default bigcommerce checkout page
+ */
+export declare const watchBigcommerceDomesticCheckout: ({ domesticRedirectedBtnSelector, onShippingAddressSessionFound, }: Params) => void;
+export {};

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

@@ -0,0 +1 @@
+export declare const formatStringWithLinks: (str: string) => string;

package/dist/types/components/utils/hello/currencyConversion/getCurrencyElements.d.ts

@@ -1 +1 @@
-export declare const getCurrencyElements: (selector: string) => NodeListOf<Element> | null;
+export declare const getCurrencyElements: (selector: string) => Element[] | null;

package/dist/types/components/utils/logging/log.d.ts

@@ -1,3 +1,3 @@
-type LogType = 'warn' | 'info' | 'log';
+type LogType = 'warn' | 'info' | 'log' | 'error';
 export declare const log: (message: unknown, type?: LogType, ...additionalInfo: unknown[]) => void;
 export {};

package/dist/types/components/utils/logging/sendErrorLog.d.ts

@@ -0,0 +1,7 @@
+type Params = {
+    endpoint: string;
+    errors: string[];
+    metadata: Record<string, unknown>;
+};
+export declare const sendErrorLog: ({ endpoint, errors, metadata }: Params) => Promise<void>;
+export {};

package/dist/types/components.d.ts

@@ -478,12 +478,12 @@ export namespace Components {
           * This method will convert the currency and return the converted value
           * @returns number
          */
-        "convert": (value: number) => Promise<void>;
+        "convert": (value: number) => Promise<number>;
         /**
           * This method will call convert and format, and return the converted and formatted string
           * @returns string
          */
-        "convertAndFormat": (value: number) => Promise<void>;
+        "convertAndFormat": (value: number) => Promise<string>;
         /**
           * This method will trigger the currency conversion and display the converted value
           * @returns void
@@ -493,12 +493,17 @@ export namespace Components {
           * This method will format the currency and return the formatted string
           * @returns number
          */
-        "format": (value: number) => Promise<void>;
+        "format": (value: number) => Promise<string>;
         /**
           * Force mobile styling instead of media query and use the passed location value
           * @default false
          */
         "mobileLocationOverride"?: HelloMobileLocation;
+        /**
+          * This method show the hello dialog
+          * @returns void
+         */
+        "openHelloDialog": (value: boolean) => Promise<void>;
     }
     interface ZonosHelloDialog {
         /**
@@ -575,6 +580,24 @@ export namespace Components {
          */
         "handleOnClose": () => void;
     }
+    interface ZonosLink {
+        /**
+          * The href for the link
+         */
+        "href": string;
+        /**
+          * The title attribute for the link
+         */
+        "linkTitle"?: string;
+        /**
+          * The rel attribute for the link
+         */
+        "rel"?: string;
+        /**
+          * The target attribute for the link
+         */
+        "target"?: string;
+    }
     interface ZonosLinkAuthentication {
         /**
           * The title text for the authentication element
@@ -971,6 +994,12 @@ declare global {
         prototype: HTMLZonosLanguageSelectElement;
         new (): HTMLZonosLanguageSelectElement;
     };
+    interface HTMLZonosLinkElement extends Components.ZonosLink, HTMLStencilElement {
+    }
+    var HTMLZonosLinkElement: {
+        prototype: HTMLZonosLinkElement;
+        new (): HTMLZonosLinkElement;
+    };
     interface HTMLZonosLinkAuthenticationElement extends Components.ZonosLinkAuthentication, HTMLStencilElement {
     }
     var HTMLZonosLinkAuthenticationElement: {
@@ -1091,6 +1120,7 @@ declare global {
         "zonos-hello-dialog-footer": HTMLZonosHelloDialogFooterElement;
         "zonos-icon": HTMLZonosIconElement;
         "zonos-language-select": HTMLZonosLanguageSelectElement;
+        "zonos-link": HTMLZonosLinkElement;
         "zonos-link-authentication": HTMLZonosLinkAuthenticationElement;
         "zonos-logo": HTMLZonosLogoElement;
         "zonos-notification": HTMLZonosNotificationElement;
@@ -1612,6 +1642,24 @@ declare namespace LocalJSX {
          */
         "handleOnClose"?: () => void;
     }
+    interface ZonosLink {
+        /**
+          * The href for the link
+         */
+        "href"?: string;
+        /**
+          * The title attribute for the link
+         */
+        "linkTitle"?: string;
+        /**
+          * The rel attribute for the link
+         */
+        "rel"?: string;
+        /**
+          * The target attribute for the link
+         */
+        "target"?: string;
+    }
     interface ZonosLinkAuthentication {
         /**
           * The title text for the authentication element
@@ -1773,6 +1821,7 @@ declare namespace LocalJSX {
         "zonos-hello-dialog-footer": ZonosHelloDialogFooter;
         "zonos-icon": ZonosIcon;
         "zonos-language-select": ZonosLanguageSelect;
+        "zonos-link": ZonosLink;
         "zonos-link-authentication": ZonosLinkAuthentication;
         "zonos-logo": ZonosLogo;
         "zonos-notification": ZonosNotification;
@@ -1816,6 +1865,7 @@ declare module "@stencil/core" {
             "zonos-hello-dialog-footer": LocalJSX.ZonosHelloDialogFooter & JSXBase.HTMLAttributes<HTMLZonosHelloDialogFooterElement>;
             "zonos-icon": LocalJSX.ZonosIcon & JSXBase.HTMLAttributes<HTMLZonosIconElement>;
             "zonos-language-select": LocalJSX.ZonosLanguageSelect & JSXBase.HTMLAttributes<HTMLZonosLanguageSelectElement>;
+            "zonos-link": LocalJSX.ZonosLink & JSXBase.HTMLAttributes<HTMLZonosLinkElement>;
             "zonos-link-authentication": LocalJSX.ZonosLinkAuthentication & JSXBase.HTMLAttributes<HTMLZonosLinkAuthenticationElement>;
             "zonos-logo": LocalJSX.ZonosLogo & JSXBase.HTMLAttributes<HTMLZonosLogoElement>;
             "zonos-notification": LocalJSX.ZonosNotification & JSXBase.HTMLAttributes<HTMLZonosNotificationElement>;

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

@@ -0,0 +1,13 @@
+type Params = {
+    loadScriptSrc?: string;
+};
+/**
+ * Get the load version and url based on the loadScriptSrc and version
+ * @returns
+ */
+export declare const checkIfLoadVersionDomain: ({ loadScriptSrc }: Params) => {
+    currentLoadScriptUrl: string;
+    isForceLoadVersionDomain: boolean;
+    isWhiteListed: boolean;
+};
+export {};

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

@@ -33,6 +33,7 @@ export interface Zonos {
     getCurrentTimestamp: () => number;
     init: (params: LoadZonosParams) => Promise<void>;
     injectSupportGoogleFont: (fontUrl: string) => void;
+    openHelloDialog: (state?: boolean) => void;
     setupGoogleFont: (fontFamily: string) => void;
     showNotification: (props: NotificationInit) => void;
     updateOrganizationName: (organizationName: string) => void;
@@ -52,6 +53,7 @@ export declare abstract class Zonos {
     private static zonosController;
     static init: ({ appearance, checkoutSettings, currencyConverter, helloSettings, storeId, zonosApiKey, }: LoadZonosParams) => Promise<void>;
     static displayCurrency: () => void;
+    static openHelloDialog: (value?: boolean) => void;
     static showNotification: (notification: NotificationInit) => void;
     static updateOrganizationName: (organizationName: string) => void;
     private static disablePlaceOrderButtons;

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

@@ -56,5 +56,5 @@ export type CheckoutConfig = {
      */
     buildCartDetail?: () => Promise<CartItem[]>;
     buildLandedCost?: (params: BuildLandedCostParams) => BuildLandedCostResponse;
-    onOrderSuccess?: (zonosOrder: ZonosOrder) => void;
+    onOrderSuccess?: (zonosOrder: ZonosOrder) => Promise<void>;
 };

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

@@ -1155,6 +1155,7 @@ export declare const emailTemplateStatus: {
 export type EmailTemplateStatus = (typeof emailTemplateStatus)[keyof typeof emailTemplateStatus];
 export declare const emailTemplateType: {
     readonly AbandonedCart: "ABANDONED_CART";
+    readonly CatalogExport: "CATALOG_EXPORT";
     readonly OrderCanceled: "ORDER_CANCELED";
     readonly OrderConfirmation: "ORDER_CONFIRMATION";
     readonly OrderReceipt: "ORDER_RECEIPT";
@@ -1378,11 +1379,6 @@ export declare const invoiceLanguageCode: {
     readonly ZhTw: "ZH_TW";
 };
 export type InvoiceLanguageCode = (typeof invoiceLanguageCode)[keyof typeof invoiceLanguageCode];
-export declare const invoiceLineRecordBehaviorCode: {
-    readonly Finalize: "FINALIZE";
-    readonly Pending: "PENDING";
-};
-export type InvoiceLineRecordBehaviorCode = (typeof invoiceLineRecordBehaviorCode)[keyof typeof invoiceLineRecordBehaviorCode];
 export declare const invoiceLineRecordStatusCode: {
     readonly Failed: "FAILED";
     readonly Pending: "PENDING";
@@ -2117,31 +2113,7 @@ export type CalculateLandedCostMutation = {
     } | null> | null;
     checkoutSessionWorkflow: Array<{
         landedCost: {
-            amountSubtotals: {
-                duties: number;
-                fees: number;
-                items: number;
-                landedCostTotal: number;
-                shipping: number;
-                taxes: number;
-            } | null;
-            currencyCode: CurrencyCode;
-            deMinimis: Array<{
-                formula: string;
-                method: IncotermCode;
-                note: string;
-                threshold: DeMinimisThreshold;
-                type: DeMinimisType;
-            }>;
             id: string;
-            landedCostGuaranteeCode: LandedCostGuaranteeCode;
-            method: IncotermCode;
-            shipmentRating: {
-                amount: number;
-                currencyCode: CurrencyCode;
-                displayName: string;
-                id: string;
-            };
         } | null;
         subtotals: {
             duties: number;
@@ -2174,6 +2146,9 @@ export type CalculateLandedCostMutation = {
             type: LandedCostAdjustmentType | null;
         } | null> | null;
         deMinimis: Array<{
+            formula: string;
+            method: IncotermCode;
+            note: string;
             threshold: DeMinimisThreshold;
             type: DeMinimisType;
         }>;
@@ -2217,31 +2192,7 @@ export type CalculateLandedCostMutation = {
 };
 export type CheckoutPresentmentFragment = {
     landedCost: {
-        amountSubtotals: {
-            duties: number;
-            fees: number;
-            items: number;
-            landedCostTotal: number;
-            shipping: number;
-            taxes: number;
-        } | null;
-        currencyCode: CurrencyCode;
-        deMinimis: Array<{
-            formula: string;
-            method: IncotermCode;
-            note: string;
-            threshold: DeMinimisThreshold;
-            type: DeMinimisType;
-        }>;
         id: string;
-        landedCostGuaranteeCode: LandedCostGuaranteeCode;
-        method: IncotermCode;
-        shipmentRating: {
-            amount: number;
-            currencyCode: CurrencyCode;
-            displayName: string;
-            id: string;
-        };
     } | null;
     subtotals: {
         duties: number;
@@ -2270,6 +2221,9 @@ export type LandedCostFragment = {
         type: LandedCostAdjustmentType | null;
     } | null> | null;
     deMinimis: Array<{
+        formula: string;
+        method: IncotermCode;
+        note: string;
         threshold: DeMinimisThreshold;
         type: DeMinimisType;
     }>;
@@ -2656,6 +2610,7 @@ export type ZonosSettingsQuery = {
         allowedDomains: Array<string>;
     };
     organization: {
+        id: string;
         name: string;
         references: {
             storeId: number | null;

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

@@ -1297,6 +1297,7 @@ export type EmailTemplateStatus =
   (typeof emailTemplateStatus)[keyof typeof emailTemplateStatus];
 export const emailTemplateType = {
   AbandonedCart: 'ABANDONED_CART',
+  CatalogExport: 'CATALOG_EXPORT',
   OrderCanceled: 'ORDER_CANCELED',
   OrderConfirmation: 'ORDER_CONFIRMATION',
   OrderReceipt: 'ORDER_RECEIPT',
@@ -1582,13 +1583,7 @@ export const invoiceLanguageCode = {
 
 export type InvoiceLanguageCode =
   (typeof invoiceLanguageCode)[keyof typeof invoiceLanguageCode];
-export const invoiceLineRecordBehaviorCode = {
-  Finalize: 'FINALIZE',
-  Pending: 'PENDING',
-} as const;
 
-export type InvoiceLineRecordBehaviorCode =
-  (typeof invoiceLineRecordBehaviorCode)[keyof typeof invoiceLineRecordBehaviorCode];
 export const invoiceLineRecordStatusCode = {
   Failed: 'FAILED',
   Pending: 'PENDING',
@@ -2506,33 +2501,7 @@ export type CalculateLandedCostMutation = {
     type: PackagingType;
   } | null> | null;
   checkoutSessionWorkflow: Array<{
-    landedCost: {
-      amountSubtotals: {
-        duties: number;
-        fees: number;
-        items: number;
-        landedCostTotal: number;
-        shipping: number;
-        taxes: number;
-      } | null;
-      currencyCode: CurrencyCode;
-      deMinimis: Array<{
-        formula: string;
-        method: IncotermCode;
-        note: string;
-        threshold: DeMinimisThreshold;
-        type: DeMinimisType;
-      }>;
-      id: string;
-      landedCostGuaranteeCode: LandedCostGuaranteeCode;
-      method: IncotermCode;
-      shipmentRating: {
-        amount: number;
-        currencyCode: CurrencyCode;
-        displayName: string;
-        id: string;
-      };
-    } | null;
+    landedCost: { id: string } | null;
     subtotals: {
       duties: number;
       exchangeRate: {
@@ -2558,7 +2527,13 @@ export type CalculateLandedCostMutation = {
       item: { amount: number } | null;
       type: LandedCostAdjustmentType | null;
     } | null> | null;
-    deMinimis: Array<{ threshold: DeMinimisThreshold; type: DeMinimisType }>;
+    deMinimis: Array<{
+      formula: string;
+      method: IncotermCode;
+      note: string;
+      threshold: DeMinimisThreshold;
+      type: DeMinimisType;
+    }>;
     duties: Array<{ amount: number; currencyCode: CurrencyCode }>;
     fees: Array<{ amount: number; currencyCode: CurrencyCode }>;
     id: string;
@@ -2590,33 +2565,7 @@ export type CalculateLandedCostMutation = {
 };
 
 export type CheckoutPresentmentFragment = {
-  landedCost: {
-    amountSubtotals: {
-      duties: number;
-      fees: number;
-      items: number;
-      landedCostTotal: number;
-      shipping: number;
-      taxes: number;
-    } | null;
-    currencyCode: CurrencyCode;
-    deMinimis: Array<{
-      formula: string;
-      method: IncotermCode;
-      note: string;
-      threshold: DeMinimisThreshold;
-      type: DeMinimisType;
-    }>;
-    id: string;
-    landedCostGuaranteeCode: LandedCostGuaranteeCode;
-    method: IncotermCode;
-    shipmentRating: {
-      amount: number;
-      currencyCode: CurrencyCode;
-      displayName: string;
-      id: string;
-    };
-  } | null;
+  landedCost: { id: string } | null;
   subtotals: {
     duties: number;
     exchangeRate: {
@@ -2642,7 +2591,13 @@ export type LandedCostFragment = {
     item: { amount: number } | null;
     type: LandedCostAdjustmentType | null;
   } | null> | null;
-  deMinimis: Array<{ threshold: DeMinimisThreshold; type: DeMinimisType }>;
+  deMinimis: Array<{
+    formula: string;
+    method: IncotermCode;
+    note: string;
+    threshold: DeMinimisThreshold;
+    type: DeMinimisType;
+  }>;
   duties: Array<{ amount: number; currencyCode: CurrencyCode }>;
   fees: Array<{ amount: number; currencyCode: CurrencyCode }>;
   id: string;
@@ -2999,6 +2954,7 @@ export type ZonosSettingsQuery = {
   } | null;
   onlineStoreSettings: { allowedDomains: Array<string> };
   organization: {
+    id: string;
     name: string;
     references: { storeId: number | null } | null;
   } | null;

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

@@ -547,6 +547,11 @@ export type LocaleCountryMessagesQuery = {
         pageName: Locale_PageName_Enum;
     }>;
 };
+export type InsertConversionEventMutation = {
+    insert_usage_conversionEvent_one: {
+        id: number;
+    } | null;
+};
 export type CreateErrorEventMutation = {
     insert_error_event: {
         returning: Array<{
@@ -741,6 +746,9 @@ export declare function getSdk(client: GraphQLClient, withWrapper?: SdkFunctionW
     cleanupTestZonosElementSetting(variables?: {
         [x: string]: never;
     } | undefined, requestHeaders?: GraphQLClientRequestHeaders): Promise<CleanupTestZonosElementSettingMutation>;
+    insertConversionEvent(variables?: {
+        [x: string]: never;
+    } | undefined, requestHeaders?: GraphQLClientRequestHeaders): Promise<InsertConversionEventMutation>;
     zonosElementsSetting(variables?: {
         [x: string]: never;
     } | undefined, requestHeaders?: GraphQLClientRequestHeaders): Promise<ZonosElementsSettingQuery>;

package/dist/types/types/generated/graphql.frontend.types.ts

@@ -548,6 +548,10 @@ export type LocaleCountryMessagesQuery = {
   }>;
 };
 
+export type InsertConversionEventMutation = {
+  insert_usage_conversionEvent_one: { id: number } | null;
+};
+
 export type CreateErrorEventMutation = {
   insert_error_event: {
     returning: Array<{
@@ -959,6 +963,20 @@ export function getSdk(
         'mutation',
       );
     },
+    insertConversionEvent(
+      variables?: { [x: string]: never },
+      requestHeaders?: GraphQLClientRequestHeaders,
+    ): Promise<InsertConversionEventMutation> {
+      return withWrapper(
+        wrappedRequestHeaders =>
+          client.request<InsertConversionEventMutation>('', variables, {
+            ...requestHeaders,
+            ...wrappedRequestHeaders,
+          }),
+        'insertConversionEvent',
+        'mutation',
+      );
+    },
     zonosElementsSetting(
       variables?: { [x: string]: never },
       requestHeaders?: GraphQLClientRequestHeaders,