swell-js 4.0.7 → 4.0.8

package/dist/api.mjs

@@ -135,7 +135,7 @@ const options = {
 };
 
 const api = {
-  version: '4.0.7',
+  version: '4.0.8',
   options,
   request,
 

package/dist/payment.mjs

@@ -326,7 +326,7 @@ class Payment {
   /**
    * Returns a cart.
    *
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async getCart() {
     const cart = await methods(this.request, this.options).get();
@@ -342,7 +342,7 @@ class Payment {
    * Updates a cart.
    *
    * @param {object} data
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async updateCart(data) {
     const updateData = cloneDeep(data);
@@ -367,7 +367,7 @@ class Payment {
   /**
    * Returns the store settings.
    *
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async getSettings() {
     return methods$1(this.request, this.options).get();
@@ -377,7 +377,7 @@ class Payment {
    * Creates a payment intent.
    *
    * @param {object} data
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async createIntent(data) {
     return this._vaultRequest('post', '/intent', data);
@@ -387,7 +387,7 @@ class Payment {
    * Updates a payment intent.
    *
    * @param {object} data
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async updateIntent(data) {
     return this._vaultRequest('put', '/intent', data);
@@ -397,7 +397,7 @@ class Payment {
    * Authorizes a payment gateway.
    *
    * @param {object} data
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async authorizeGateway(data) {
     return this._vaultRequest('post', '/authorization', data);
@@ -460,7 +460,7 @@ class Payment {
    * Adjusts cart data.
    *
    * @param {object} cart
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async _adjustCart(cart) {
     return this._ensureCartSettings(cart).then(toSnake);
@@ -470,7 +470,7 @@ class Payment {
    * Sets the store settings to cart.
    *
    * @param {object} cart
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async _ensureCartSettings(cart) {
     if (cart.settings) {
@@ -488,7 +488,7 @@ class Payment {
    * @param {string} method
    * @param {string} url
    * @param {object} data
-   * @returns {object}
+   * @returns {Promise<object>}
    */
   async _vaultRequest(method, url, data) {
     const response = await vaultRequest(method, url, data);
@@ -539,6 +539,11 @@ class Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+/** @typedef {import('@stripe/stripe-js').StripeCardElement} StripeCardElement */
+/** @typedef {import('@stripe/stripe-js').StripeCardNumberElement} StripeCardNumberElement */
+/** @typedef {import('@stripe/stripe-js').CreateSourceData} CreateSourceData */
+
 // https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts
 const MINIMUM_CHARGE_AMOUNT = {
   USD: 0.5,
@@ -610,6 +615,10 @@ function getBillingDetails(cart) {
   return details;
 }
 
+/**
+ * @param {CreateSourceData} source
+ * @param {object} data
+ */
 function setBancontactOwner(source, data) {
   const fillValues = (fieldsMap, data) =>
     reduce(
@@ -639,11 +648,17 @@ function setBancontactOwner(source, data) {
       ? { phone: billingData.phone }
       : account.phone
         ? { phone: account.phone }
-        : {}),
-    ...(!isEmpty(billingAddress) ? { address: billingAddress } : {}),
+        : undefined),
+    ...(!isEmpty(billingAddress) ? { address: billingAddress } : undefined),
   };
 }
 
+/**
+ * @param {string} type
+ * @param {import('@stripe/stripe-js').StripeElements} elements
+ * @param {object} params
+ * @returns {import('@stripe/stripe-js').StripeElement}
+ */
 function createElement(type, elements, params) {
   const elementParams = params[type] || params;
   const elementOptions = elementParams.options || {};
@@ -662,6 +677,11 @@ function createElement(type, elements, params) {
   return element;
 }
 
+/**
+ * @param {Stripe} stripe
+ * @param {StripeCardElement | StripeCardNumberElement} cardElement
+ * @param {object} cart
+ */
 async function createPaymentMethod(stripe, cardElement, cart) {
   const billingDetails = getBillingDetails(cart);
   const { paymentMethod, error } = await stripe.createPaymentMethod({
@@ -678,18 +698,24 @@ async function createPaymentMethod(stripe, cardElement, cart) {
         exp_month: paymentMethod.card.exp_month,
         exp_year: paymentMethod.card.exp_year,
         brand: paymentMethod.card.brand,
+        display_brand: paymentMethod.card.display_brand,
         address_check: paymentMethod.card.checks.address_line1_check,
         cvc_check: paymentMethod.card.checks.cvc_check,
-        zip_check: paymentMethod.card.checks.address_zip_check,
+        zip_check: paymentMethod.card.checks.address_postal_code_check,
       };
 }
 
+/**
+ * @param {Stripe} stripe
+ * @param {import('@stripe/stripe-js').StripeIdealBankElement} element
+ * @param {object} cart
+ */
 async function createIDealPaymentMethod(stripe, element, cart) {
   const billingDetails = getBillingDetails(cart);
-  return await stripe.createPaymentMethod({
+  return stripe.createPaymentMethod({
     type: 'ideal',
     ideal: element,
-    ...(billingDetails ? { billing_details: billingDetails } : {}),
+    ...(billingDetails ? { billing_details: billingDetails } : undefined),
   });
 }
 
@@ -712,6 +738,10 @@ function getKlarnaIntentDetails(cart) {
   return details;
 }
 
+/**
+ * @param {object} cart
+ * @returns {import('@stripe/stripe-js').ConfirmKlarnaPaymentData}
+ */
 function getKlarnaConfirmationDetails(cart) {
   const billingDetails = getBillingDetails(cart);
   const returnUrl = `${
@@ -726,7 +756,12 @@ function getKlarnaConfirmationDetails(cart) {
   };
 }
 
+/**
+ * @param {Stripe} stripe
+ * @param {object} cart
+ */
 async function createBancontactSource(stripe, cart) {
+  /** @type {CreateSourceData} */
   const sourceObject = {
     type: 'bancontact',
     amount: Math.round(get(cart, 'grand_total', 0) * 100),
@@ -735,11 +770,17 @@ async function createBancontactSource(stripe, cart) {
       return_url: window.location.href,
     },
   };
+
   setBancontactOwner(sourceObject, cart);
 
-  return await stripe.createSource(sourceObject);
+  return stripe.createSource(sourceObject);
 }
 
+/**
+ * @param {object} cart
+ * @param {object} params
+ * @returns {import('@stripe/stripe-js').PaymentRequestOptions}
+ */
 function getPaymentRequestData(cart, params) {
   const {
     currency,
@@ -802,29 +843,30 @@ function getPaymentRequestData(cart, params) {
   };
 }
 
+const zeroDecimalCurrencies = new Set([
+  'BIF', // Burundian Franc
+  'DJF', // Djiboutian Franc,
+  'JPY', // Japanese Yen
+  'KRW', // South Korean Won
+  'PYG', // Paraguayan Guaraní
+  'VND', // Vietnamese Đồng
+  'XAF', // Central African Cfa Franc
+  'XPF', // Cfp Franc
+  'CLP', // Chilean Peso
+  'GNF', // Guinean Franc
+  'KMF', // Comorian Franc
+  'MGA', // Malagasy Ariary
+  'RWF', // Rwandan Franc
+  'VUV', // Vanuatu Vatu
+  'XOF', // West African Cfa Franc
+]);
+
 function stripeAmountByCurrency(currency, amount) {
-  const zeroDecimalCurrencies = [
-    'BIF', // Burundian Franc
-    'DJF', // Djiboutian Franc,
-    'JPY', // Japanese Yen
-    'KRW', // South Korean Won
-    'PYG', // Paraguayan Guaraní
-    'VND', // Vietnamese Đồng
-    'XAF', // Central African Cfa Franc
-    'XPF', // Cfp Franc
-    'CLP', // Chilean Peso
-    'GNF', // Guinean Franc
-    'KMF', // Comorian Franc
-    'MGA', // Malagasy Ariary
-    'RWF', // Rwandan Franc
-    'VUV', // Vanuatu Vatu
-    'XOF', // West African Cfa Franc
-  ];
-  if (zeroDecimalCurrencies.includes(currency.toUpperCase())) {
+  if (zeroDecimalCurrencies.has(currency.toUpperCase())) {
     return amount;
-  } else {
-    return Math.round(amount * 100);
   }
+
+  return Math.round(amount * 100);
 }
 
 function isStripeChargeableAmount(amount, currency) {
@@ -832,6 +874,10 @@ function isStripeChargeableAmount(amount, currency) {
   return !minAmount || amount >= minAmount;
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+/** @typedef {import('@stripe/stripe-js').StripeCardElement} StripeCardElement */
+/** @typedef {import('@stripe/stripe-js').StripeCardNumberElement} StripeCardNumberElement */
+
 class StripeCardPayment extends Payment {
   constructor(request, options, params, methods) {
     super(request, options, params, methods.card);
@@ -841,6 +887,7 @@ class StripeCardPayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeCardPayment.stripe) {
       if (window.Stripe) {
@@ -855,14 +902,17 @@ class StripeCardPayment extends Payment {
     return StripeCardPayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeCardPayment.stripe = stripe;
   }
 
+  /** @returns {StripeCardElement | StripeCardNumberElement} */
   get stripeElement() {
     return StripeCardPayment.stripeElement;
   }
 
+  /** @param {StripeCardElement | StripeCardNumberElement} stripeElement */
   set stripeElement(stripeElement) {
     StripeCardPayment.stripeElement = stripeElement;
   }
@@ -1005,6 +1055,9 @@ class StripeCardPayment extends Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+/** @typedef {import('@stripe/stripe-js').StripeIdealBankElement} StripeIdealBankElement */
+
 class StripeIDealPayment extends Payment {
   constructor(request, options, params, methods) {
     if (!methods.card) {
@@ -1023,6 +1076,7 @@ class StripeIDealPayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeIDealPayment.stripe) {
       if (window.Stripe) {
@@ -1037,14 +1091,17 @@ class StripeIDealPayment extends Payment {
     return StripeIDealPayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeIDealPayment.stripe = stripe;
   }
 
+  /** @returns {StripeIdealBankElement} */
   get stripeElement() {
     return StripeIDealPayment.stripeElement;
   }
 
+  /** @param {StripeIdealBankElement} stripeElement */
   set stripeElement(stripeElement) {
     StripeIDealPayment.stripeElement = stripeElement;
   }
@@ -1077,6 +1134,10 @@ class StripeIDealPayment extends Payment {
     await this.stripe.handleCardAction(intent.client_secret);
   }
 
+  /**
+   * @param {object} cart
+   * @param {import('@stripe/stripe-js').PaymentMethod} paymentMethod
+   */
   async _createIntent(cart, paymentMethod) {
     const { currency, capture_total } = cart;
     const stripeCurrency = (currency || 'EUR').toLowerCase();
@@ -1122,6 +1183,8 @@ class StripeIDealPayment extends Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+
 class StripeBancontactPayment extends Payment {
   constructor(request, options, params, methods) {
     if (!methods.card) {
@@ -1140,6 +1203,7 @@ class StripeBancontactPayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeBancontactPayment.stripe) {
       if (window.Stripe) {
@@ -1154,6 +1218,7 @@ class StripeBancontactPayment extends Payment {
     return StripeBancontactPayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeBancontactPayment.stripe = stripe;
   }
@@ -1181,6 +1246,8 @@ class StripeBancontactPayment extends Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+
 class StripeKlarnaPayment extends Payment {
   constructor(request, options, params, methods) {
     if (!methods.card) {
@@ -1199,6 +1266,7 @@ class StripeKlarnaPayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeKlarnaPayment.stripe) {
       if (window.Stripe) {
@@ -1213,6 +1281,7 @@ class StripeKlarnaPayment extends Payment {
     return StripeKlarnaPayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeKlarnaPayment.stripe = stripe;
   }
@@ -1271,6 +1340,9 @@ class StripeKlarnaPayment extends Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+/** @typedef {import('@stripe/stripe-js').PaymentRequestPaymentMethodEvent} PaymentRequestPaymentMethodEvent */
+
 class StripeGooglePayment extends Payment {
   constructor(request, options, params, methods) {
     if (!methods.card) {
@@ -1289,6 +1361,7 @@ class StripeGooglePayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeGooglePayment.stripe) {
       if (window.Stripe) {
@@ -1303,6 +1376,7 @@ class StripeGooglePayment extends Payment {
     return StripeGooglePayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeGooglePayment.stripe = stripe;
   }
@@ -1360,6 +1434,7 @@ class StripeGooglePayment extends Payment {
     return paymentRequest;
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingAddressEvent} event */
   async _onShippingAddressChange(event) {
     const { shippingAddress, updateWith } = event;
     const shipping = this._mapShippingAddress(shippingAddress);
@@ -1378,6 +1453,7 @@ class StripeGooglePayment extends Payment {
     }
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingOptionEvent} event */
   async _onShippingOptionChange(event) {
     const { shippingOption, updateWith } = event;
     const cart = await this.updateCart({
@@ -1394,6 +1470,7 @@ class StripeGooglePayment extends Payment {
     }
   }
 
+  /** @param {PaymentRequestPaymentMethodEvent} event */
   async _onPaymentMethod(event) {
     const {
       payerEmail,
@@ -1421,6 +1498,7 @@ class StripeGooglePayment extends Payment {
           gateway: 'stripe',
           token: paymentMethod,
           brand: card.brand,
+          display_brand: card.display_brand,
           exp_month: card.exp_month,
           exp_year: card.exp_year,
           last4: card.last4,
@@ -1436,8 +1514,11 @@ class StripeGooglePayment extends Payment {
     this.onSuccess();
   }
 
-  // Provides backward compatibility with Google Pay button options
-  // https://developers.google.com/pay/api/web/reference/request-objects#ButtonOptions
+  /**
+   * Provides backward compatibility with Google Pay button options
+   *
+   * @see {@link https://developers.google.com/pay/api/web/reference/request-objects#ButtonOptions}
+   */
   _getButtonStyles() {
     let { style: { color = 'dark', type = 'default', height = '45px' } = {} } =
       this.params;
@@ -1467,6 +1548,7 @@ class StripeGooglePayment extends Payment {
     };
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingAddress} [address] */
   _mapShippingAddress(address = {}) {
     return {
       name: address.recipient,
@@ -1480,6 +1562,7 @@ class StripeGooglePayment extends Payment {
     };
   }
 
+  /** @param {PaymentRequestPaymentMethodEvent['paymentMethod']['billing_details']} [address] */
   _mapBillingAddress(address = {}) {
     return {
       name: address.name,
@@ -1494,6 +1577,9 @@ class StripeGooglePayment extends Payment {
   }
 }
 
+/** @typedef {import('@stripe/stripe-js').Stripe} Stripe */
+/** @typedef {import('@stripe/stripe-js').PaymentRequestPaymentMethodEvent} PaymentRequestPaymentMethodEvent */
+
 class StripeApplePayment extends Payment {
   constructor(request, options, params, methods) {
     if (!methods.card) {
@@ -1512,6 +1598,7 @@ class StripeApplePayment extends Payment {
     return ['stripe-js'];
   }
 
+  /** @returns {Stripe} */
   get stripe() {
     if (!StripeApplePayment.stripe) {
       if (window.Stripe) {
@@ -1526,6 +1613,7 @@ class StripeApplePayment extends Payment {
     return StripeApplePayment.stripe;
   }
 
+  /** @param {Stripe} stripe */
   set stripe(stripe) {
     StripeApplePayment.stripe = stripe;
   }
@@ -1606,6 +1694,7 @@ class StripeApplePayment extends Payment {
     return paymentRequest;
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingAddressEvent} event */
   async _onShippingAddressChange(event) {
     const { shippingAddress, updateWith } = event;
     const shipping = this._mapShippingAddress(shippingAddress);
@@ -1624,6 +1713,7 @@ class StripeApplePayment extends Payment {
     }
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingOptionEvent} event */
   async _onShippingOptionChange(event) {
     const { shippingOption, updateWith } = event;
     const cart = await this.updateCart({
@@ -1640,6 +1730,7 @@ class StripeApplePayment extends Payment {
     }
   }
 
+  /** @param {PaymentRequestPaymentMethodEvent} event */
   async _onPaymentMethod(event) {
     const {
       payerEmail,
@@ -1667,6 +1758,7 @@ class StripeApplePayment extends Payment {
           gateway: 'stripe',
           token: paymentMethod,
           brand: card.brand,
+          display_brand: card.display_brand,
           exp_month: card.exp_month,
           exp_year: card.exp_year,
           last4: card.last4,
@@ -1682,6 +1774,7 @@ class StripeApplePayment extends Payment {
     this.onSuccess();
   }
 
+  /** @param {import('@stripe/stripe-js').PaymentRequestShippingAddress} [address] */
   _mapShippingAddress(address = {}) {
     return {
       name: address.recipient,
@@ -1695,6 +1788,7 @@ class StripeApplePayment extends Payment {
     };
   }
 
+  /** @param {PaymentRequestPaymentMethodEvent['paymentMethod']['billing_details']} [address] */
   _mapBillingAddress(address = {}) {
     return {
       name: address.name,