@zonos/elements 1.3.248 → 1.3.250

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

@@ -56,6 +56,7 @@ export declare class ZonosCheckoutFinish {
     private checkStripePaymentStatus;
     private checkStagingOrderStatus;
     private checkPaypalPaymentStatus;
+    private checkStoreCreditOrderStatus;
     private closeClickHandler;
     private saveOrderIdForDuplicationIssue;
     componentDidLoad(): void;

package/dist/types/components/checkout/zonos-checkout/zonos-checkout-payment/zonos-store-credit/zonos-store-credit.d.ts

@@ -0,0 +1,17 @@
+export declare class ZonosStoreCredit {
+    el: HTMLZonosStoreCreditElement;
+    /**
+     * Whether the component is enabled
+     */
+    enabled: boolean;
+    /**
+     * Local state for custom amount input
+     */
+    customAmountInput: string;
+    componentWillLoad(): Promise<void>;
+    private handleUseStoreCreditChange;
+    private handleAmountModeChange;
+    private handleCustomAmountChange;
+    private handleApplyCustomAmount;
+    render(): any;
+}

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

@@ -127,6 +127,7 @@ type CartStore = {
      */
     shouldHideDiscountInput: boolean;
     step: Step;
+    storeCredit: number;
     subtotal: number;
     tabItems: TabItems;
     total: number;
@@ -190,6 +191,7 @@ type CartSubtotals = {
     landedCostTotal: number;
     presentmentCurrencyCode: CurrencyCode;
     shipping: number;
+    storeCredit?: number;
     total: number;
 };
 declare const cartStoreApplySubtotals: ({ dutiesTaxesFeesEstimate, method, subtotals, }: {
@@ -242,4 +244,9 @@ declare const cartStoreUpdateItems: ({ adjustments, cartItems, landedCostId, sho
 declare const cartStorePreviousStep: () => void;
 declare const cartStoreNextStep: () => void;
 declare const cartStoreResetTabItems: () => void;
-export { cartStore, cartStoreApplySubtotals, cartStoreCheckItemRestrictions, cartStoreClearCheckoutInterval, cartStoreGetMethod, cartStoreGetShippingTransitInfo, cartStoreHasOneEligibleItem, cartStoreNextStep, cartStoreOnChange, cartStorePreviousStep, cartStoreReCalculateTotal, cartStoreReset, cartStoreResetCartItems, cartStoreResetTabItems, cartStoreSetCheckoutSession, cartStoreStartCheckoutInterval, cartStoreUpdateItems, cartStoreUpdateSelectedShippingOption, cartStoreUpdateToErrorState, };
+/**
+ * Update the checkout session with the current store credit selection.
+ * Debounced to prevent multiple rapid requests when store changes cascade.
+ */
+declare const cartStoreUpdateStoreCredit: () => void;
+export { cartStore, cartStoreApplySubtotals, cartStoreCheckItemRestrictions, cartStoreClearCheckoutInterval, cartStoreGetMethod, cartStoreGetShippingTransitInfo, cartStoreHasOneEligibleItem, cartStoreNextStep, cartStoreOnChange, cartStorePreviousStep, cartStoreReCalculateTotal, cartStoreReset, cartStoreResetCartItems, cartStoreResetTabItems, cartStoreSetCheckoutSession, cartStoreStartCheckoutInterval, cartStoreUpdateItems, cartStoreUpdateSelectedShippingOption, cartStoreUpdateStoreCredit, cartStoreUpdateToErrorState, };

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

@@ -0,0 +1,111 @@
+type StoreCreditStore = {
+    /**
+     * User-selected amount to apply
+     */
+    amountToApply: number | null;
+    /**
+     * Amount actually applied after API call
+     */
+    appliedAmount: number | null;
+    /**
+     * Available store credit balance from checkout session customerProfile
+     */
+    availableBalance: number | null;
+    /**
+     * Error message
+     */
+    error: string | null;
+    /**
+     * Whether store credit is currently being applied
+     */
+    isApplying: boolean;
+    /**
+     * Whether the user has enabled store credit usage (checkbox checked)
+     */
+    isEnabled: boolean;
+    /**
+     * Order ID created when store credit covers the full order amount
+     */
+    orderIdCreated: string | null;
+    /**
+     * Remaining balance after application
+     */
+    remainingBalance: number | null;
+    /**
+     * Whether to use full balance (vs custom amount)
+     */
+    useFullBalance: boolean;
+};
+declare const storeCreditStoreOnChange: import("@stencil/store/dist/types").OnChangeHandler<StoreCreditStore>, storeCreditStore: StoreCreditStore;
+/**
+ * Reset store credit store to initial state
+ */
+declare const storeCreditStoreReset: () => void;
+/**
+ * Set the available balance from the checkout session's customerProfile.storeCreditBalance
+ */
+declare const storeCreditStoreSetBalanceFromSession: (balance: number | null) => void;
+/**
+ * Re-fetch the store credit balance from the checkout session.
+ * Called when the payment step loads to ensure the balance is fresh.
+ */
+declare const storeCreditStoreRefreshBalance: () => Promise<void>;
+/**
+ * Apply store credit to the checkout session.
+ * This must be called BEFORE payment confirmation.
+ * The amount/mode are already set via checkout session update with storeCreditApplication.
+ */
+declare const storeCreditStoreApplyCredit: () => Promise<{
+    error: string | null;
+    success: boolean;
+}>;
+/**
+ * Enable or disable store credit usage.
+ * When enabling, defaults to full balance mode.
+ * When disabling, clears the amount.
+ */
+declare const storeCreditStoreSetEnabled: (enabled: boolean) => void;
+/**
+ * Set the amount of store credit to apply
+ * Validates against available balance and cart total
+ */
+declare const storeCreditStoreSetAmount: (amount: number | null) => void;
+/**
+ * Toggle whether to use full balance or custom amount.
+ * When switching to custom mode, clears the applied amount so the user
+ * must explicitly apply via the Apply button.
+ */
+declare const storeCreditStoreSetUseFullBalance: (useFullBalance: boolean) => void;
+/**
+ * Get the storeCreditApplication input for checkout session update.
+ * Sends mode: 'NONE' when store credit is not being used to clear any
+ * previously applied store credit on the backend.
+ */
+declare const storeCreditStoreGetInput: () => {
+    amount?: number;
+    mode: "FULL" | "NONE" | "PARTIAL";
+};
+/**
+ * Get the effective amount to apply based on settings
+ */
+declare const storeCreditStoreGetEffectiveAmount: () => number;
+/**
+ * Check whether the effective store credit amount covers the full order total.
+ * When true, the Stripe/PayPal payment flow should be skipped and
+ * `storeCreditStoreCreateOrder` should be used instead.
+ *
+ * Relies on the backend's computed `cartStore.total` (remaining amount to pay
+ * after store credit) rather than a client-side comparison, which avoids issues
+ * with currency mismatches or rounding.
+ */
+declare const storeCreditStoreCoversFullAmount: () => boolean;
+/**
+ * Create an order paid entirely by store credit.
+ * Should only be called when `storeCreditStoreCoversFullAmount()` is true.
+ */
+declare const storeCreditStoreCreateOrder: () => Promise<{
+    error: string | null;
+    orderId: string | null;
+    success: boolean;
+}>;
+export { storeCreditStore, storeCreditStoreApplyCredit, storeCreditStoreCoversFullAmount, storeCreditStoreCreateOrder, storeCreditStoreGetEffectiveAmount, storeCreditStoreGetInput, storeCreditStoreOnChange, storeCreditStoreRefreshBalance, storeCreditStoreReset, storeCreditStoreSetAmount, storeCreditStoreSetBalanceFromSession, storeCreditStoreSetEnabled, storeCreditStoreSetUseFullBalance, };

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

@@ -223,7 +223,7 @@ declare const stripeStoreUpdateCheckoutSessionBaseCurrency: () => Promise<boolea
 /**
  * Update checkout session. Use for updating amount with landed cost id, or update session when cart items change
  */
-declare const stripeStoreUpdateCheckoutSession: ({ adjustmentsAmount, cartId, currency, id, itemsAmount, landedCostId, presentmentCountryCode, }: CheckoutSessionUpdateRequest) => Promise<{
+declare const stripeStoreUpdateCheckoutSession: ({ adjustmentsAmount, cartId, currency, id, itemsAmount, landedCostId, presentmentCountryCode, storeCreditApplication, }: CheckoutSessionUpdateRequest) => Promise<{
     errors: import("src/types").JsonError[];
     json: CheckoutSessionUpdateMutation | null;
 }>;

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

@@ -44,18 +44,27 @@ export declare const stringsArabic: {
     'Adresa vulytsi': {
         value: string;
     };
+    'Amount to apply: [amount]': {
+        value: string;
+    };
     'An unexpected error occurred when processing PayPal order.': {
         value: string;
     };
     Apply: {
         value: string;
     };
+    'Apply full balance': {
+        value: string;
+    };
     'Are you sure?': {
         value: string;
     };
     Area: {
         value: string;
     };
+    'Available balance: [amount]': {
+        value: string;
+    };
     Back: {
         value: string;
     };
@@ -224,6 +233,9 @@ export declare const stringsArabic: {
     Emirate: {
         value: string;
     };
+    'Enter amount': {
+        value: string;
+    };
     'Error creating Checkout': {
         value: string;
     };
@@ -347,6 +359,9 @@ export declare const stringsArabic: {
     'No shipping methods found - try editing your address or contacting support if the error persists': {
         value: string;
     };
+    'No store credit available': {
+        value: string;
+    };
     'Nothing due at delivery': {
         value: string;
     };
@@ -413,6 +428,9 @@ export declare const stringsArabic: {
     'Phone number': {
         value: string;
     };
+    'Place order': {
+        value: string;
+    };
     'Place test order': {
         value: string;
     };
@@ -569,6 +587,12 @@ export declare const stringsArabic: {
     'State/Province/Region/Prefecture': {
         value: string;
     };
+    'Store credit': {
+        value: string;
+    };
+    'Store credit covers your full order': {
+        value: string;
+    };
     'Street address': {
         value: string;
     };
@@ -656,12 +680,18 @@ export declare const stringsArabic: {
     Ulica: {
         value: string;
     };
+    'Unable to apply store credit. Please try again.': {
+        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 place order with store credit. Please try again.': {
+        value: string;
+    };
     'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
         value: string;
     };
@@ -674,6 +704,9 @@ export declare const stringsArabic: {
     'Update your address': {
         value: string;
     };
+    'Use store credit': {
+        value: string;
+    };
     'View GAA Form.': {
         value: string;
     };

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

@@ -44,18 +44,27 @@ export declare const stringsBase: {
     'Adresa vulytsi': {
         value: string;
     };
+    'Amount to apply: [amount]': {
+        value: string;
+    };
     'An unexpected error occurred when processing PayPal order.': {
         value: string;
     };
     Apply: {
         value: string;
     };
+    'Apply full balance': {
+        value: string;
+    };
     'Are you sure?': {
         value: string;
     };
     Area: {
         value: string;
     };
+    'Available balance: [amount]': {
+        value: string;
+    };
     Back: {
         value: string;
     };
@@ -224,6 +233,9 @@ export declare const stringsBase: {
     Emirate: {
         value: string;
     };
+    'Enter amount': {
+        value: string;
+    };
     'Error creating Checkout': {
         value: string;
     };
@@ -347,6 +359,9 @@ export declare const stringsBase: {
     'No shipping methods found - try editing your address or contacting support if the error persists': {
         value: string;
     };
+    'No store credit available': {
+        value: string;
+    };
     'Nothing due at delivery': {
         value: string;
     };
@@ -413,6 +428,9 @@ export declare const stringsBase: {
     'Phone number': {
         value: string;
     };
+    'Place order': {
+        value: string;
+    };
     'Place test order': {
         value: string;
     };
@@ -569,6 +587,12 @@ export declare const stringsBase: {
     'State/Province/Region/Prefecture': {
         value: string;
     };
+    'Store credit': {
+        value: string;
+    };
+    'Store credit covers your full order': {
+        value: string;
+    };
     'Street address': {
         value: string;
     };
@@ -656,12 +680,18 @@ export declare const stringsBase: {
     Ulica: {
         value: string;
     };
+    'Unable to apply store credit. Please try again.': {
+        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 place order with store credit. Please try again.': {
+        value: string;
+    };
     'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
         value: string;
     };
@@ -674,6 +704,9 @@ export declare const stringsBase: {
     'Update your address': {
         value: string;
     };
+    'Use store credit': {
+        value: string;
+    };
     'View GAA Form.': {
         value: string;
     };

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

@@ -44,18 +44,27 @@ export declare const stringsChinese: {
     'Adresa vulytsi': {
         value: string;
     };
+    'Amount to apply: [amount]': {
+        value: string;
+    };
     'An unexpected error occurred when processing PayPal order.': {
         value: string;
     };
     Apply: {
         value: string;
     };
+    'Apply full balance': {
+        value: string;
+    };
     'Are you sure?': {
         value: string;
     };
     Area: {
         value: string;
     };
+    'Available balance: [amount]': {
+        value: string;
+    };
     Back: {
         value: string;
     };
@@ -224,6 +233,9 @@ export declare const stringsChinese: {
     Emirate: {
         value: string;
     };
+    'Enter amount': {
+        value: string;
+    };
     'Error creating Checkout': {
         value: string;
     };
@@ -347,6 +359,9 @@ export declare const stringsChinese: {
     'No shipping methods found - try editing your address or contacting support if the error persists': {
         value: string;
     };
+    'No store credit available': {
+        value: string;
+    };
     'Nothing due at delivery': {
         value: string;
     };
@@ -413,6 +428,9 @@ export declare const stringsChinese: {
     'Phone number': {
         value: string;
     };
+    'Place order': {
+        value: string;
+    };
     'Place test order': {
         value: string;
     };
@@ -569,6 +587,12 @@ export declare const stringsChinese: {
     'State/Province/Region/Prefecture': {
         value: string;
     };
+    'Store credit': {
+        value: string;
+    };
+    'Store credit covers your full order': {
+        value: string;
+    };
     'Street address': {
         value: string;
     };
@@ -656,12 +680,18 @@ export declare const stringsChinese: {
     Ulica: {
         value: string;
     };
+    'Unable to apply store credit. Please try again.': {
+        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 place order with store credit. Please try again.': {
+        value: string;
+    };
     'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
         value: string;
     };
@@ -674,6 +704,9 @@ export declare const stringsChinese: {
     'Update your address': {
         value: string;
     };
+    'Use store credit': {
+        value: string;
+    };
     'View GAA Form.': {
         value: string;
     };

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

@@ -44,18 +44,27 @@ export declare const stringsDanish: {
     'Adresa vulytsi': {
         value: string;
     };
+    'Amount to apply: [amount]': {
+        value: string;
+    };
     'An unexpected error occurred when processing PayPal order.': {
         value: string;
     };
     Apply: {
         value: string;
     };
+    'Apply full balance': {
+        value: string;
+    };
     'Are you sure?': {
         value: string;
     };
     Area: {
         value: string;
     };
+    'Available balance: [amount]': {
+        value: string;
+    };
     Back: {
         value: string;
     };
@@ -224,6 +233,9 @@ export declare const stringsDanish: {
     Emirate: {
         value: string;
     };
+    'Enter amount': {
+        value: string;
+    };
     'Error creating Checkout': {
         value: string;
     };
@@ -347,6 +359,9 @@ export declare const stringsDanish: {
     'No shipping methods found - try editing your address or contacting support if the error persists': {
         value: string;
     };
+    'No store credit available': {
+        value: string;
+    };
     'Nothing due at delivery': {
         value: string;
     };
@@ -413,6 +428,9 @@ export declare const stringsDanish: {
     'Phone number': {
         value: string;
     };
+    'Place order': {
+        value: string;
+    };
     'Place test order': {
         value: string;
     };
@@ -569,6 +587,12 @@ export declare const stringsDanish: {
     'State/Province/Region/Prefecture': {
         value: string;
     };
+    'Store credit': {
+        value: string;
+    };
+    'Store credit covers your full order': {
+        value: string;
+    };
     'Street address': {
         value: string;
     };
@@ -656,12 +680,18 @@ export declare const stringsDanish: {
     Ulica: {
         value: string;
     };
+    'Unable to apply store credit. Please try again.': {
+        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 place order with store credit. Please try again.': {
+        value: string;
+    };
     'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
         value: string;
     };
@@ -674,6 +704,9 @@ export declare const stringsDanish: {
     'Update your address': {
         value: string;
     };
+    'Use store credit': {
+        value: string;
+    };
     'View GAA Form.': {
         value: string;
     };

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

@@ -44,18 +44,27 @@ export declare const stringsDutch: {
     'Adresa vulytsi': {
         value: string;
     };
+    'Amount to apply: [amount]': {
+        value: string;
+    };
     'An unexpected error occurred when processing PayPal order.': {
         value: string;
     };
     Apply: {
         value: string;
     };
+    'Apply full balance': {
+        value: string;
+    };
     'Are you sure?': {
         value: string;
     };
     Area: {
         value: string;
     };
+    'Available balance: [amount]': {
+        value: string;
+    };
     Back: {
         value: string;
     };
@@ -224,6 +233,9 @@ export declare const stringsDutch: {
     Emirate: {
         value: string;
     };
+    'Enter amount': {
+        value: string;
+    };
     'Error creating Checkout': {
         value: string;
     };
@@ -347,6 +359,9 @@ export declare const stringsDutch: {
     'No shipping methods found - try editing your address or contacting support if the error persists': {
         value: string;
     };
+    'No store credit available': {
+        value: string;
+    };
     'Nothing due at delivery': {
         value: string;
     };
@@ -413,6 +428,9 @@ export declare const stringsDutch: {
     'Phone number': {
         value: string;
     };
+    'Place order': {
+        value: string;
+    };
     'Place test order': {
         value: string;
     };
@@ -569,6 +587,12 @@ export declare const stringsDutch: {
     'State/Province/Region/Prefecture': {
         value: string;
     };
+    'Store credit': {
+        value: string;
+    };
+    'Store credit covers your full order': {
+        value: string;
+    };
     'Street address': {
         value: string;
     };
@@ -656,12 +680,18 @@ export declare const stringsDutch: {
     Ulica: {
         value: string;
     };
+    'Unable to apply store credit. Please try again.': {
+        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 place order with store credit. Please try again.': {
+        value: string;
+    };
     'Unable to retrieve the checkout session at the moment. Please try again or contact our support team.': {
         value: string;
     };
@@ -674,6 +704,9 @@ export declare const stringsDutch: {
     'Update your address': {
         value: string;
     };
+    'Use store credit': {
+        value: string;
+    };
     'View GAA Form.': {
         value: string;
     };