@stripe/stripe-js 2.2.1 → 2.3.0

package/dist/pure.esm.js

@@ -54,7 +54,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "2.2.1",
+    version: "2.3.0",
     startTime: startTime
   });
 };

package/dist/pure.js

@@ -58,7 +58,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "2.2.1",
+    version: "2.3.0",
     startTime: startTime
   });
 };

package/dist/stripe.esm.js

@@ -38,7 +38,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "2.2.1",
+    version: "2.3.0",
     startTime: startTime
   });
 };
@@ -130,15 +130,29 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   return stripe;
 }; // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 
+var stripePromise$1;
+var loadCalled = false;
+
+var getStripePromise = function getStripePromise() {
+  if (stripePromise$1) {
+    return stripePromise$1;
+  }
+
+  stripePromise$1 = loadScript(null)["catch"](function (error) {
+    // clear cache on error
+    stripePromise$1 = null;
+    return Promise.reject(error);
+  });
+  return stripePromise$1;
+}; // Execute our own script injection after a tick to give users time to do their
 // own script injection.
 
-var stripePromise$1 = Promise.resolve().then(function () {
-  return loadScript(null);
-});
-var loadCalled = false;
-stripePromise$1["catch"](function (err) {
+
+Promise.resolve().then(function () {
+  return getStripePromise();
+})["catch"](function (error) {
   if (!loadCalled) {
-    console.warn(err);
+    console.warn(error);
   }
 });
 var loadStripe = function loadStripe() {
@@ -147,8 +161,9 @@ var loadStripe = function loadStripe() {
   }
 
   loadCalled = true;
-  var startTime = Date.now();
-  return stripePromise$1.then(function (maybeStripe) {
+  var startTime = Date.now(); // if previous attempts are unsuccessful, will re-load script
+
+  return getStripePromise().then(function (maybeStripe) {
     return initStripe(maybeStripe, args, startTime);
   });
 };

package/dist/stripe.js

@@ -42,7 +42,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "2.2.1",
+    version: "2.3.0",
     startTime: startTime
   });
 };
@@ -134,15 +134,29 @@ var initStripe = function initStripe(maybeStripe, args, startTime) {
   return stripe;
 }; // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 
+var stripePromise$1;
+var loadCalled = false;
+
+var getStripePromise = function getStripePromise() {
+  if (stripePromise$1) {
+    return stripePromise$1;
+  }
+
+  stripePromise$1 = loadScript(null)["catch"](function (error) {
+    // clear cache on error
+    stripePromise$1 = null;
+    return Promise.reject(error);
+  });
+  return stripePromise$1;
+}; // Execute our own script injection after a tick to give users time to do their
 // own script injection.
 
-var stripePromise$1 = Promise.resolve().then(function () {
-  return loadScript(null);
-});
-var loadCalled = false;
-stripePromise$1["catch"](function (err) {
+
+Promise.resolve().then(function () {
+  return getStripePromise();
+})["catch"](function (error) {
   if (!loadCalled) {
-    console.warn(err);
+    console.warn(error);
   }
 });
 var loadStripe = function loadStripe() {
@@ -151,8 +165,9 @@ var loadStripe = function loadStripe() {
   }
 
   loadCalled = true;
-  var startTime = Date.now();
-  return stripePromise$1.then(function (maybeStripe) {
+  var startTime = Date.now(); // if previous attempts are unsuccessful, will re-load script
+
+  return getStripePromise().then(function (maybeStripe) {
     return initStripe(maybeStripe, args, startTime);
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-js",
-  "version": "2.2.1",
+  "version": "2.3.0",
   "description": "Stripe.js loading utility",
   "repository": "github:stripe/stripe-js",
   "main": "dist/stripe.js",

package/src/index.test.ts

@@ -150,6 +150,68 @@ describe('Stripe module loader', () => {
         new Error('Stripe.js not available')
       );
     });
+
+    it('rejects on first load, and succeeds on second load resolving with Stripe object', async () => {
+      const {loadStripe} = require(requirePath);
+
+      // start of first load, expect load failure
+      let stripePromise = loadStripe('pk_test_foo');
+
+      await Promise.resolve();
+      dispatchScriptEvent('error');
+
+      await expect(stripePromise).rejects.toEqual(
+        new Error('Failed to load Stripe.js')
+      );
+
+      expect(console.warn).not.toHaveBeenCalled();
+
+      // start of second load, expect successful load
+      stripePromise = loadStripe('pk_test_foo');
+
+      await new Promise((resolve) => setTimeout(resolve));
+      window.Stripe = jest.fn((key) => ({key})) as any;
+      dispatchScriptEvent('load');
+
+      return expect(stripePromise).resolves.toEqual({key: 'pk_test_foo'});
+    });
+
+    it('rejects on first load and second load but succeeds on third load resolving with Stripe object', async () => {
+      const {loadStripe} = require(requirePath);
+
+      // start of first load, expect load failure
+      let stripePromise = loadStripe('pk_test_foo');
+
+      await Promise.resolve();
+      dispatchScriptEvent('error');
+
+      await expect(stripePromise).rejects.toEqual(
+        new Error('Failed to load Stripe.js')
+      );
+
+      expect(console.warn).not.toHaveBeenCalled();
+
+      // start of second load, expect load failure
+      stripePromise = loadStripe('pk_test_foo');
+
+      await Promise.resolve();
+      dispatchScriptEvent('error');
+
+      await expect(stripePromise).rejects.toEqual(
+        new Error('Failed to load Stripe.js')
+      );
+
+      expect(console.warn).not.toHaveBeenCalled();
+
+      // start of third load, expect success
+      stripePromise = loadStripe('pk_test_foo');
+
+      await new Promise((resolve) => setTimeout(resolve));
+      window.Stripe = jest.fn((key) => ({key})) as any;
+      dispatchScriptEvent('load');
+
+      return expect(stripePromise).resolves.toEqual({key: 'pk_test_foo'});
+    });
   });
 
   describe('loadStripe (index.ts)', () => {

package/src/index.ts

@@ -1,22 +1,38 @@
+import {StripeConstructor} from '../types';
 import {loadScript, initStripe, LoadStripe} from './shared';
 
-// Execute our own script injection after a tick to give users time to do their
-// own script injection.
-const stripePromise = Promise.resolve().then(() => loadScript(null));
-
+let stripePromise: Promise<StripeConstructor | null> | null;
 let loadCalled = false;
 
-stripePromise.catch((err: Error) => {
-  if (!loadCalled) {
-    console.warn(err);
+const getStripePromise: () => Promise<StripeConstructor | null> = () => {
+  if (stripePromise) {
+    return stripePromise;
   }
-});
+
+  stripePromise = loadScript(null).catch((error) => {
+    // clear cache on error
+    stripePromise = null;
+    return Promise.reject(error);
+  });
+  return stripePromise;
+};
+
+// Execute our own script injection after a tick to give users time to do their
+// own script injection.
+Promise.resolve()
+  .then(() => getStripePromise())
+  .catch((error) => {
+    if (!loadCalled) {
+      console.warn(error);
+    }
+  });
 
 export const loadStripe: LoadStripe = (...args) => {
   loadCalled = true;
   const startTime = Date.now();
 
-  return stripePromise.then((maybeStripe) =>
+  // if previous attempts are unsuccessful, will re-load script
+  return getStripePromise().then((maybeStripe) =>
     initStripe(maybeStripe, args, startTime)
   );
 };

package/types/stripe-js/elements/apple-pay.d.ts

@@ -0,0 +1,156 @@
+export type ApplePayRecurringPaymentRequestIntervalUnit =
+  | 'year'
+  | 'month'
+  | 'day'
+  | 'hour'
+  | 'minute';
+
+export interface ApplePayLineItem {
+  /**
+   * A short, localized description of the line item.
+   */
+  label: string;
+
+  /**
+   * The amount in the currency's subunit (e.g. cents, yen, etc.)
+   */
+  amount: number;
+}
+
+export type ApplePayRegularBilling = ApplePayLineItem & {
+  /**
+   * The date of the first payment.
+   */
+  recurringPaymentStartDate?: Date;
+
+  /**
+   * The date of the final payment.
+   */
+  recurringPaymentEndDate?: Date;
+
+  /**
+   * The amount of time — in calendar units, such as day, month, or year — that represents a fraction of the total payment interval.
+   */
+  recurringPaymentIntervalUnit?: ApplePayRecurringPaymentRequestIntervalUnit;
+
+  /**
+   * The number of interval units that make up the total payment interval.
+   */
+  recurringPaymentIntervalCount?: number;
+};
+
+export interface ApplePayRecurringPaymentRequest {
+  /**
+   * The description of the payment that the customer will see in their Apple Pay wallet.
+   */
+  paymentDescription: string;
+
+  /**
+   * The URL to manage items related to the recurring payment on your website.
+   */
+  managementURL: string;
+  regularBilling: ApplePayRegularBilling;
+
+  /**
+   * The billing agreement label that is displayed to the customer in the Apple Pay payment interface.
+   */
+  billingAgreement?: string;
+}
+
+export type ApplePayAutomaticReloadBilling = ApplePayLineItem & {
+  /**
+   * The balance an account reaches before the merchant applies the automatic reload amount.
+   */
+  automaticReloadPaymentThresholdAmount: number;
+};
+
+export interface ApplePayAutomaticReloadPaymentRequest {
+  /**
+   * The description of the payment that the customer will see in their Apple Pay wallet.
+   */
+  paymentDescription: string;
+
+  /**
+   * The URL to manage items related to the automatic reload payment on your website.
+   */
+  managementURL: string;
+  automaticReloadBilling: ApplePayAutomaticReloadBilling;
+
+  /**
+   * The billing agreement label that is displayed to the customer in the Apple Pay payment interface.
+   */
+  billingAgreement?: string;
+}
+
+export type ApplePayDeferredBilling = ApplePayLineItem & {
+  /**
+   * The date, in the future, of the payment.
+   */
+  deferredPaymentDate: Date;
+};
+
+export interface ApplePayDeferredPaymentRequest {
+  /**
+   * The description of the payment that the customer will see in their Apple Pay wallet.
+   */
+  paymentDescription: string;
+
+  /**
+   * The URL to manage items related to the deferred payment on your website.
+   */
+  managementURL: string;
+  deferredBilling: ApplePayDeferredBilling;
+
+  /**
+   * The billing agreement label that is displayed to the customer in the Apple Pay payment interface.
+   */
+  billingAgreement?: string;
+
+  /**
+   * The future date before which the customer can cancel the deferred payment for free.
+   */
+  freeCancellationDate?: Date;
+
+  /**
+   * The time zone of the free cancellation date.
+   *
+   * These are [tz](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) timezones such as `America/Los_Angeles`, `Europe/Dublin`, and `Asia/Singapore`.
+   */
+  freeCancellationDateTimeZone?: string;
+}
+
+export type ApplePayOption =
+  | {
+      recurringPaymentRequest: ApplePayRecurringPaymentRequest;
+      deferredPaymentRequest?: null;
+      automaticReloadPaymentRequest?: null;
+    }
+  | {
+      recurringPaymentRequest?: null;
+      deferredPaymentRequest: ApplePayDeferredPaymentRequest;
+      automaticReloadPaymentRequest?: null;
+    }
+  | {
+      recurringPaymentRequest?: null;
+      deferredPaymentRequest?: null;
+      automaticReloadPaymentRequest: ApplePayAutomaticReloadPaymentRequest;
+    }
+  | {
+      recurringPaymentRequest?: null;
+      deferredPaymentRequest?: null;
+      automaticReloadPaymentRequest?: null;
+    };
+
+export type ApplePayUpdateOption =
+  | {
+      recurringPaymentRequest: ApplePayRecurringPaymentRequest;
+      automaticReloadPaymentRequest?: null;
+    }
+  | {
+      recurringPaymentRequest?: null;
+      automaticReloadPaymentRequest: ApplePayAutomaticReloadPaymentRequest;
+    }
+  | {
+      recurringPaymentRequest?: null;
+      automaticReloadPaymentRequest?: null;
+    };

package/types/stripe-js/elements/express-checkout.d.ts

@@ -1,5 +1,6 @@
 import {StripeElementBase} from './base';
 import {StripeError} from '../stripe';
+import {ApplePayOption, ApplePayUpdateOption} from './apple-pay';
 
 export type StripeExpressCheckoutElement = StripeElementBase & {
   /**
@@ -362,29 +363,6 @@ export interface StripeExpressCheckoutElementReadyEvent {
   availablePaymentMethods: undefined | AvailablePaymentMethods;
 }
 
-export type RecurringPaymentIntervalUnit =
-  | 'year'
-  | 'month'
-  | 'day'
-  | 'hour'
-  | 'minute';
-
-export type ApplePayOption = {
-  recurringPaymentRequest?: {
-    paymentDescription: string;
-    managementURL: string;
-    regularBilling: {
-      amount: number;
-      label: string;
-      recurringPaymentStartDate?: Date;
-      recurringPaymentEndDate?: Date;
-      recurringPaymentIntervalUnit?: RecurringPaymentIntervalUnit;
-      recurringPaymentIntervalCount?: number;
-    };
-    billingAgreement?: string;
-  };
-};
-
 export type ClickResolveDetails = {
   /**
    * An array of two-letter ISO country codes representing which countries
@@ -451,6 +429,7 @@ export interface StripeExpressCheckoutElementConfirmEvent {
 export type ChangeResolveDetails = {
   lineItems?: Array<LineItem>;
   shippingRates?: Array<ShippingRate>;
+  applePay?: ApplePayUpdateOption;
 };
 
 export interface StripeExpressCheckoutElementShippingAddressChangeEvent {

package/types/stripe-js/elements/payment.d.ts

@@ -1,5 +1,6 @@
 import {StripeElementBase} from './base';
 import {StripeError} from '../stripe';
+import {ApplePayOption} from './apple-pay';
 
 export type StripePaymentElement = StripeElementBase & {
   /**
@@ -239,6 +240,11 @@ export interface StripePaymentElementOptions {
    * Specify a layout to use when rendering a Payment Element.
    */
   layout?: Layout | LayoutObject;
+
+  /**
+   * Specify the options to be used when the Apple Pay payment interface opens.
+   */
+  applePay?: ApplePayOption;
 }
 
 export interface StripePaymentElementChangeEvent {

package/types/stripe-js/elements-group.d.ts

@@ -796,6 +796,13 @@ export interface StripeElementsOptionsMode extends BaseStripeElementsOptions {
    * Either use mode or clientSecret when creating an Elements group
    */
   clientSecret?: never;
+
+  /**
+   * The external payment methods to be displayed in the Payment Element that you are already integrated with.
+   *
+   * @docs https://stripe.com/docs/js/elements_object/create#stripe_elements-options-externalPaymentMethodTypes
+   */
+  externalPaymentMethodTypes?: string[];
 }
 
 export type StripeElementsOptions =

package/types/stripe-js/payment-request.d.ts

@@ -1,4 +1,5 @@
 import {Token, PaymentMethod, Source} from '../api';
+import {ApplePayOption, ApplePayUpdateOption} from './elements/apple-pay';
 
 export interface PaymentRequest {
   /**
@@ -154,6 +155,11 @@ export interface PaymentRequestUpdateOptions {
    */
 
   shippingOptions?: PaymentRequestShippingOption[];
+
+  /**
+   * Specify the options to be used when the Apple Pay payment interface opens.
+   */
+  applePay?: ApplePayOption;
 }
 
 /**
@@ -226,6 +232,11 @@ export interface PaymentRequestOptions {
    */
   disableWallets?: PaymentRequestWallet[];
 
+  /**
+   * Specify the options to be used when the Apple Pay payment interface opens.
+   */
+  applePay?: ApplePayOption;
+
   /**
    * @deprecated
    * Use disableWallets instead.
@@ -497,6 +508,11 @@ export interface PaymentRequestUpdateDetails {
    * The first shipping option listed appears in the browser payment interface as the default option.
    */
   shippingOptions?: PaymentRequestShippingOption[];
+
+  /**
+   * Specify new options to refresh the Apple Pay payment interface.
+   */
+  applePay?: ApplePayUpdateOption;
 }
 
 export interface PaymentRequestShippingOptionEvent {