swell-js 5.4.1 → 5.5.1

package/dist/api.mjs

@@ -446,7 +446,7 @@ function swell(initStore = undefined, initKey, initOptions = {}) {
   const api = {};
 
   Object.assign(api, {
-    version: '5.4.1',
+    version: '5.5.1',
     options,
     request,
 

package/dist/payment.mjs

@@ -21,6 +21,7 @@ const SCRIPT_HANDLERS = {
   'braintree-google-payment': loadBraintreeGoogle,
   'braintree-apple-payment': loadBraintreeApple,
   'amazon-checkout': loadAmazonCheckout,
+  'convesiopay-js': loadConvesioPay,
   'sezzle-sdk': loadSezzleCheckout,
 };
 
@@ -189,6 +190,16 @@ async function loadAmazonCheckout() {
   }
 }
 
+async function loadConvesioPay() {
+  if (!window.ConvesioPay) {
+    await loadScript('convesiopay-js', 'https://js.convesiopay.com/v1/');
+  }
+
+  if (!window.ConvesioPay) {
+    console.error('Warning: ConvesioPay was not loaded');
+  }
+}
+
 async function loadSezzleCheckout() {
   if (!window.Checkout) {
     await loadScript(
@@ -560,6 +571,8 @@ class Payment {
 /** @typedef {import('@stripe/stripe-js').StripeCardNumberElement} StripeCardNumberElement */
 /** @typedef {import('@stripe/stripe-js').CreateSourceData} CreateSourceData */
 
+/** @typedef {import('../../types').Cart} Cart */
+
 // https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts
 const MINIMUM_CHARGE_AMOUNT = {
   USD: 0.5,
@@ -614,6 +627,10 @@ function mapValues(fieldsMap, data) {
   return result;
 }
 
+/**
+ * @param {Cart} cart
+ * @returns {object}
+ */
 function getBillingDetails(cart) {
   const details = {
     ...mapValues(billingFieldsMap, cart.billing),
@@ -658,7 +675,7 @@ function createElement(type, elements, params) {
 /**
  * @param {Stripe} stripe
  * @param {StripeCardElement | StripeCardNumberElement} cardElement
- * @param {object} cart
+ * @param {Cart} cart
  */
 async function createPaymentMethod(stripe, cardElement, cart) {
   const billingDetails = getBillingDetails(cart);
@@ -686,7 +703,7 @@ async function createPaymentMethod(stripe, cardElement, cart) {
 /**
  * @param {Stripe} stripe
  * @param {import('@stripe/stripe-js').StripeIdealBankElement} element
- * @param {object} cart
+ * @param {Cart} cart
  */
 async function createIDealPaymentMethod(stripe, element, cart) {
   const billingDetails = getBillingDetails(cart);
@@ -697,6 +714,10 @@ async function createIDealPaymentMethod(stripe, element, cart) {
   });
 }
 
+/**
+ * @param {Cart} cart
+ * @returns {object}
+ */
 function getKlarnaIntentDetails(cart) {
   const { account, currency, capture_total } = cart;
   const stripeCustomer = account && account.stripe_customer;
@@ -717,7 +738,7 @@ function getKlarnaIntentDetails(cart) {
 }
 
 /**
- * @param {object} cart
+ * @param {Cart} cart
  * @returns {import('@stripe/stripe-js').ConfirmKlarnaPaymentData}
  */
 function getKlarnaConfirmationDetails(cart) {
@@ -737,7 +758,7 @@ function getKlarnaConfirmationDetails(cart) {
 /**
  * Returns Bancontact Setup Intent confirmation details.
  *
- * @param {object} cart
+ * @param {Cart} cart
  * @returns {import('@stripe/stripe-js').ConfirmBancontactPaymentData}
  */
 function getBancontactConfirmationDetails(cart) {
@@ -755,7 +776,7 @@ function getBancontactConfirmationDetails(cart) {
 }
 
 /**
- * @param {object} cart
+ * @param {Cart} cart
  * @param {object} params
  * @returns {import('@stripe/stripe-js').PaymentRequestOptions}
  */
@@ -839,6 +860,11 @@ const zeroDecimalCurrencies = new Set([
   'XOF', // West African Cfa Franc
 ]);
 
+/**
+ * @param {string} currency
+ * @param {number} amount
+ * @returns {number}
+ */
 function stripeAmountByCurrency(currency, amount) {
   if (zeroDecimalCurrencies.has(currency.toUpperCase())) {
     return amount;
@@ -847,6 +873,11 @@ function stripeAmountByCurrency(currency, amount) {
   return Math.round(amount * 100);
 }
 
+/**
+ * @param {number} amount
+ * @param {string} currency
+ * @returns {boolean}
+ */
 function isStripeChargeableAmount(amount, currency) {
   const minAmount = MINIMUM_CHARGE_AMOUNT[currency];
   return !minAmount || amount >= minAmount;
@@ -2075,6 +2106,44 @@ function getDiscountLabel(discount, cart) {
   return discount.id;
 }
 
+/** @type {Map<string, number>} */
+const CURRENCIES_CENTS = new Map();
+
+/**
+ * @param {string} currency
+ * @returns {number}
+ */
+function getCurrencyCents(currency) {
+  let cents = CURRENCIES_CENTS.get(currency);
+
+  if (cents !== undefined) {
+    return cents;
+  }
+
+  const formatter = new Intl.NumberFormat('en-US', {
+    style: 'currency',
+    currency,
+  });
+
+  const options = formatter.resolvedOptions();
+  const decimals = options.maximumFractionDigits ?? 2;
+
+  cents = 10 ** decimals;
+
+  CURRENCIES_CENTS.set(currency, cents);
+
+  return cents;
+}
+
+/**
+ * @param {string} currency
+ * @param {number} amount
+ * @returns {number}
+ */
+function amountInCents$1(currency, amount) {
+  return Math.round(amount * getCurrencyCents(currency));
+}
+
 /** @typedef {import('./payment').default} Payment */
 /** @typedef {import('../../types').Cart} Cart */
 /** @typedef {import('../../types').Address} Address */
@@ -2646,29 +2715,16 @@ class BraintreeGooglePayment extends Payment {
 /** @typedef {import('../../types').Address} Address */
 
 /**
- * Handles Apple Pay shipping contact selection event
- *
- * IMPORTANT: This event fires automatically when the Apple Pay sheet opens
- * with the user's default address. This is expected Apple Pay behavior.
- *
- * The flow:
- * 1. Apple Pay sheet opens → This event fires with default address
- * 2. User changes address → This event fires again with new address
- * 3. Each time, we:
- *    - Send the address to Swell to calculate shipping/tax
- *    - Return updated totals and available shipping methods
- *
  * @this {Payment}
- * @param {ApplePaySession} session
- * @param {ApplePayJS.ApplePayShippingContactSelectedEvent} event
- * @returns {void}
+ * @param {ApplePayJS.ApplePayPaymentContact} shippingContact
+ * @returns {Promise<ApplePayJS.ApplePayShippingContactUpdate>}
  */
-async function onShippingContactSelected(session, event) {
+async function onShippingAddressChange(shippingContact) {
   try {
     // Update cart with Apple Pay shipping address to get shipping options and tax
     // This happens immediately when the sheet opens with the default address
     const cart = await this.updateCart({
-      shipping: convertToSwellAddress$1(event.shippingContact),
+      shipping: convertToSwellAddress$1(shippingContact),
     });
 
     if (!cart.shipment_rating?.services?.length) {
@@ -2676,69 +2732,104 @@ async function onShippingContactSelected(session, event) {
         cart.shipment_rating?.errors?.find(Boolean)?.message ??
         'Shipping is not available for the provided address.';
 
-      return session.completeShippingContactSelection({
+      return {
         newTotal: getTotal(cart),
-        newLineItems: getLineItems(cart),
+        newLineItems: getLineItems$1(cart),
         newShippingMethods: [], // REQUIRED: Must always provide this, even as empty array
         errors: [
           new ApplePayError('addressUnserviceable', 'postalAddress', message),
         ],
-      });
+      };
     }
 
     // Success: Return updated totals and shipping methods
-    session.completeShippingContactSelection({
+    return {
       newTotal: getTotal(cart),
-      newLineItems: getLineItems(cart),
-      newShippingMethods: getShippingMethods(cart),
-    });
+      newLineItems: getLineItems$1(cart),
+      newShippingMethods: getShippingMethods$1(cart),
+    };
   } catch (err) {
     const cartData = await this.getCart();
 
-    session.completeShippingContactSelection({
+    return {
       newTotal: getTotal(cartData),
-      newLineItems: getLineItems(cartData),
+      newLineItems: getLineItems$1(cartData),
       newShippingMethods: [], // REQUIRED: Must always provide this, even as empty array
       errors: [new ApplePayError('unknown', undefined, err.message)],
-    });
+    };
   }
 }
 
 /**
- * Handles Apple Pay shipping method selection
+ * Handles Apple Pay shipping contact selection event
  *
- * Triggered when the user selects a shipping method from the available options.
- * We update the cart with the selected shipping service and return the updated
- * total and line items (which now include the shipping cost).
+ * IMPORTANT: This event fires automatically when the Apple Pay sheet opens
+ * with the user's default address. This is expected Apple Pay behavior.
  *
- * After this event, the total changes from type 'pending' to 'final' and shows
- * the actual final amount to the user.
+ * The flow:
+ * 1. Apple Pay sheet opens → This event fires with default address
+ * 2. User changes address → This event fires again with new address
+ * 3. Each time, we:
+ *    - Send the address to Swell to calculate shipping/tax
+ *    - Return updated totals and available shipping methods
  *
  * @this {Payment}
  * @param {ApplePaySession} session
- * @param {ApplePayJS.ApplePayShippingMethodSelectedEvent} event
+ * @param {ApplePayJS.ApplePayShippingContactSelectedEvent} event
  * @returns {void}
  */
-async function onShippingMethodSelected(session, event) {
+async function onShippingContactSelected(session, event) {
+  session.completeShippingContactSelection(
+    await onShippingAddressChange.call(this, event.shippingContact),
+  );
+}
+
+/**
+ * @this {Payment}
+ * @param {ApplePayJS.ApplePayShippingMethod} shippingMethod
+ * @returns {Promise<ApplePayJS.ApplePayShippingMethodUpdate>}
+ */
+async function onShippingMethodChange(shippingMethod) {
   try {
     const cart = await this.updateCart({
       shipping: {
-        service: event.shippingMethod.identifier,
+        service: shippingMethod.identifier,
       },
     });
 
-    session.completeShippingMethodSelection({
+    return {
       newTotal: getTotal(cart),
-      newLineItems: getLineItems(cart),
-    });
+      newLineItems: getLineItems$1(cart),
+    };
   } catch (err) {
-    session.completeShippingMethodSelection({
+    return {
       newTotal: getTotal(await this.getCart()),
       errors: [new ApplePayError('unknown', undefined, err.message)],
-    });
+    };
   }
 }
 
+/**
+ * Handles Apple Pay shipping method selection
+ *
+ * Triggered when the user selects a shipping method from the available options.
+ * We update the cart with the selected shipping service and return the updated
+ * total and line items (which now include the shipping cost).
+ *
+ * After this event, the total changes from type 'pending' to 'final' and shows
+ * the actual final amount to the user.
+ *
+ * @this {Payment}
+ * @param {ApplePaySession} session
+ * @param {ApplePayJS.ApplePayShippingMethodSelectedEvent} event
+ * @returns {void}
+ */
+async function onShippingMethodSelected(session, event) {
+  session.completeShippingMethodSelection(
+    await onShippingMethodChange.call(this, event.shippingMethod),
+  );
+}
+
 /**
  * Handles Apple Pay coupon code changes
  *
@@ -2759,7 +2850,7 @@ async function onCouponCodeChanged(session, event) {
     // Valid coupon applied successfully
     session.completeCouponCodeChange({
       newTotal: getTotal(cart),
-      newLineItems: getLineItems(cart),
+      newLineItems: getLineItems$1(cart),
     });
   } catch (err) {
     // HTTP 400 error from invalid coupon - get fresh cart state
@@ -2767,7 +2858,7 @@ async function onCouponCodeChanged(session, event) {
 
     session.completeCouponCodeChange({
       newTotal: getTotal(currentCart),
-      newLineItems: getLineItems(currentCart),
+      newLineItems: getLineItems$1(currentCart),
       errors: [new ApplePayError('couponCodeInvalid', undefined, err.message)],
     });
   }
@@ -2821,7 +2912,7 @@ function getTotal(cart) {
  * @param {Cart} cart
  * @returns {ApplePayJS.ApplePayLineItem[]}
  */
-function getLineItems(cart) {
+function getLineItems$1(cart) {
   const { sub_total, shipment_price, discount_total, tax_total } = cart;
 
   /** @type {ApplePayJS.ApplePayLineItem[]} */
@@ -2867,7 +2958,7 @@ function getLineItems(cart) {
  * @param {Cart} cart
  * @returns {ApplePayJS.ApplePayShippingMethod[]}
  */
-function getShippingMethods(cart) {
+function getShippingMethods$1(cart) {
   const { shipment_delivery, shipment_rating } = cart;
 
   if (!shipment_delivery) {
@@ -3520,7 +3611,7 @@ class AuthorizeNetApplePayment extends Payment {
       requiredShippingContactFields,
       requiredBillingContactFields,
       supportsCouponCode: true,
-      lineItems: getLineItems(cart),
+      lineItems: getLineItems$1(cart),
     };
   }
 
@@ -3780,6 +3871,298 @@ class QuickpayCardPayment extends Payment {
   }
 }
 
+class ConvesioCardPayment extends Payment {
+  static convesioPay = null;
+  static convesioPayComponent = null;
+
+  constructor(api, options, params, methods) {
+    super(api, options, params, methods.card);
+  }
+
+  get scripts() {
+    return ['convesiopay-js'];
+  }
+
+  get convesioPay() {
+    if (ConvesioCardPayment.convesioPay === null) {
+      if (window.ConvesioPay) {
+        this.convesioPay = window.ConvesioPay(this.method.public_key);
+      }
+
+      if (!ConvesioCardPayment.convesioPay) {
+        throw new LibraryNotLoadedError('ConvesioPay');
+      }
+    }
+
+    return ConvesioCardPayment.convesioPay;
+  }
+
+  set convesioPay(convesioPay) {
+    ConvesioCardPayment.convesioPay = convesioPay;
+  }
+
+  get convesioPayComponent() {
+    return ConvesioCardPayment.convesioPayComponent;
+  }
+
+  set convesioPayComponent(convesioPayComponent) {
+    ConvesioCardPayment.convesioPayComponent = convesioPayComponent;
+  }
+
+  async createElements(cart) {
+    await this.loadScripts(this.scripts);
+
+    const component = this.convesioPay.component({
+      environment: isLiveMode(this.method.mode) ? 'live' : 'test',
+      integration: this.method.integration,
+      customerEmail: cart.account?.email,
+      express: false,
+      disabledPaymentMethods: {
+        btcpay: true,
+        applePay: true,
+        googlePay: true,
+      },
+    });
+
+    this.convesioPayComponent = component;
+
+    component.mount(`#${this.params.elementId || 'card-element'}`);
+  }
+
+  async tokenize() {
+    if (!this.convesioPayComponent) {
+      throw new Error('ConvesioPay element is not defined');
+    }
+
+    const token = await this.convesioPayComponent.createToken();
+
+    await this.updateCart({
+      billing: {
+        method: 'card',
+        account_card_id: null,
+        card: {
+          gateway: 'convesiopay',
+          token,
+          last4: '????',
+          brand: null,
+          exp_month: null,
+          exp_year: null,
+        },
+        convesiopay: {
+          return_url: this.params.returnUrl,
+        },
+      },
+    });
+
+    return this.onSuccess();
+  }
+}
+
+/** @typedef {import('../../../types').Cart} Cart */
+
+class ConvesioPayApplePayment extends Payment {
+  static convesioPay = null;
+  static convesioPayComponent = null;
+
+  constructor(api, options, params, methods) {
+    if (!methods.card) {
+      throw new PaymentMethodDisabledError('Credit cards');
+    }
+
+    super(api, options, params, methods.apple);
+
+    this.convesiopay = methods.card;
+  }
+
+  get scripts() {
+    return ['convesiopay-js'];
+  }
+
+  get convesioPay() {
+    if (ConvesioPayApplePayment.convesioPay === null) {
+      if (window.ConvesioPay) {
+        this.convesioPay = window.ConvesioPay(this.convesiopay.public_key);
+      }
+
+      if (!ConvesioPayApplePayment.convesioPay) {
+        throw new LibraryNotLoadedError('ConvesioPay');
+      }
+    }
+
+    return ConvesioPayApplePayment.convesioPay;
+  }
+
+  set convesioPay(convesioPay) {
+    ConvesioPayApplePayment.convesioPay = convesioPay;
+  }
+
+  get convesioPayComponent() {
+    return ConvesioPayApplePayment.convesioPayComponent;
+  }
+
+  set convesioPayComponent(convesioPayComponent) {
+    ConvesioPayApplePayment.convesioPayComponent = convesioPayComponent;
+  }
+
+  /**
+   * Creates the Apple Pay button element
+   *
+   * @param {Cart} cart
+   */
+  async createElements(cart) {
+    const { elementId = 'applepay-button' } = this.params;
+
+    this.setElementContainer(elementId);
+    await this.loadScripts(this.scripts);
+
+    this.convesioPayComponent = this.convesioPay.component({
+      environment: isLiveMode(this.method.mode) ? 'live' : 'test',
+      integration: this.convesiopay.integration,
+      customerEmail: cart.account?.email,
+      express: true,
+      disabledPaymentMethods: {
+        cards: true,
+        btcpay: true,
+        googlePay: true,
+      },
+    });
+
+    // When initiating a payment request,
+    // we should not display the shipping cost, as it will be calculated later.
+    cart = { ...cart };
+    cart.shipment_price = 0;
+    cart.shipping = {};
+
+    this.sessionOptions = {
+      integration: this.convesiopay.integration,
+      returnUrl: this.params.returnUrl,
+      amount: amountInCents$1(cart.currency, cart.capture_total),
+      currency: cart.currency,
+      shippingMethods: getShippingMethods(cart),
+      lineItems: getLineItems(cart),
+    };
+  }
+
+  /**
+   * Mounts the Apple Pay button to the DOM
+   */
+  mountElements() {
+    const { classes = {} } = this.params;
+    const container = this.elementContainer;
+
+    this.convesioPayComponent.mount(`#${container.id}`);
+
+    if (classes.base) {
+      container.classList.add(classes.base);
+    }
+
+    this.convesioPayComponent.createApplePaySession({
+      ...this.sessionOptions,
+      onShippingAddressChange: onShippingAddressChange.bind(this),
+      onShippingMethodChange: onShippingMethodChange.bind(this),
+      onPaymentMethodChange: async (_paymentMethod) => {
+        const currentCart = await this.getCart();
+
+        return {
+          newTotal: getTotal(currentCart),
+          newLineItems: getLineItems$1(currentCart),
+        };
+      },
+    });
+
+    this.convesioPayComponent.on('change', async (event) => {
+      if (event.type === 'applepay') {
+        if (event.isSuccessful) {
+          const { token, shippingContact, billingContact } = event;
+          const { require: { shipping: requireShipping } = {} } = this.params;
+
+          await this.updateCart({
+            account: {
+              email: shippingContact.emailAddress,
+            },
+            billing: {
+              method: 'apple',
+              account_card_id: null,
+              card: null,
+              apple: {
+                token,
+                gateway: 'convesiopay',
+              },
+              ...convertToSwellAddress$1(billingContact),
+            },
+            ...(requireShipping && {
+              shipping: convertToSwellAddress$1(shippingContact),
+            }),
+          });
+        }
+      }
+    });
+  }
+}
+
+/**
+ * @param {Cart} cart
+ * @returns {object[]}
+ */
+function getLineItems(cart) {
+  const { sub_total, shipment_price, discount_total, tax_total, currency } =
+    cart;
+
+  /** @type {ApplePayJS.ApplePayLineItem[]} */
+  const lineItems = [
+    {
+      label: 'Subtotal',
+      amount: amountInCents$1(currency, sub_total || 0),
+    },
+  ];
+
+  if (shipment_price) {
+    lineItems.push({
+      label: 'Shipping',
+      amount: amountInCents$1(currency, shipment_price),
+    });
+  }
+
+  if (discount_total) {
+    lineItems.push({
+      label: 'Discount',
+      amount: amountInCents$1(currency, -discount_total),
+    });
+  }
+
+  if (tax_total) {
+    lineItems.push({
+      label: 'Taxes',
+      amount: amountInCents$1(currency, tax_total),
+    });
+  }
+
+  return lineItems;
+}
+
+/**
+ * @param {Cart} cart
+ * @returns {object[]}
+ */
+function getShippingMethods(cart) {
+  const { shipment_delivery, shipment_rating, currency } = cart;
+
+  if (!shipment_delivery) {
+    return [];
+  }
+
+  if (!shipment_rating?.services?.length) {
+    return [];
+  }
+
+  return shipment_rating.services.map((service, index) => ({
+    label: service.name || `Shipping ${index + 1}`,
+    detail: service.description || '',
+    amount: amountInCents$1(currency, service.price || 0),
+    identifier: service.id,
+  }));
+}
+
 function createPaysafecardPaymentData(cart) {
   const returnUrl = window.location.origin + window.location.pathname;
   const url = `${returnUrl}?gateway=paysafecard`;
@@ -5156,6 +5539,8 @@ class PaymentController {
         return StripeCardPayment;
       case 'quickpay':
         return QuickpayCardPayment;
+      case 'convesiopay':
+        return ConvesioCardPayment;
       default:
         return null;
     }
@@ -5227,6 +5612,8 @@ class PaymentController {
         return BraintreeApplePayment;
       case 'authorizenet':
         return AuthorizeNetApplePayment;
+      case 'convesiopay':
+        return ConvesioPayApplePayment;
       default:
         return null;
     }