@stripe/stripe-js 4.10.0 → 5.1.0

package/dist/stripe-js/elements/currency-selector.d.mts

@@ -0,0 +1,93 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeCurrencySelectorElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+};

package/dist/stripe-js/elements/currency-selector.d.ts

@@ -0,0 +1,93 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeCurrencySelectorElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'currencySelector'}) => any
+  ): StripeCurrencySelectorElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {
+      elementType: 'currencySelector';
+      error: StripeError;
+    }) => any
+  ): StripeCurrencySelectorElement;
+};

package/dist/stripe-js/elements/express-checkout.d.mts

@@ -374,8 +374,11 @@ export interface StripeExpressCheckoutElementUpdateOptions {
 }
 
 export type AvailablePaymentMethods = {
+  amazonPay: boolean;
   applePay: boolean;
   googlePay: boolean;
+  link: boolean;
+  paypal: boolean;
 };
 
 export interface StripeExpressCheckoutElementReadyEvent {

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

@@ -374,8 +374,11 @@ export interface StripeExpressCheckoutElementUpdateOptions {
 }
 
 export type AvailablePaymentMethods = {
+  amazonPay: boolean;
   applePay: boolean;
   googlePay: boolean;
+  link: boolean;
+  paypal: boolean;
 };
 
 export interface StripeExpressCheckoutElementReadyEvent {

package/dist/stripe-js/elements/index.d.mts

@@ -8,6 +8,7 @@ export * from './card-cvc';
 export * from './card-expiry';
 export * from './card-number';
 export * from './card';
+export * from './currency-selector';
 export * from './eps-bank';
 export * from './express-checkout';
 export * from './fpx-bank';

package/dist/stripe-js/elements/index.d.ts

@@ -8,6 +8,7 @@ export * from './card-cvc';
 export * from './card-expiry';
 export * from './card-number';
 export * from './card';
+export * from './currency-selector';
 export * from './eps-bank';
 export * from './express-checkout';
 export * from './fpx-bank';

package/dist/stripe-js/elements/payment.d.mts

@@ -116,6 +116,31 @@ export type StripePaymentElement = StripeElementBase & {
     handler?: (event: {elementType: 'payment'}) => any
   ): StripePaymentElement;
 
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   * Represents the details of a selected Card payment method.
+   */
+  on(
+    eventType: 'carddetailschange',
+    handler: (event: StripePaymentElementCardDetailsChangeEvent) => any
+  ): StripePaymentElement;
+
+  /**
+   * Triggered when a Saved Payment Method is updated.
+   */
+  on(
+    eventType: 'savedpaymentmethodupdate',
+    handler: (event: StripePaymentElementSavedPaymentMethodUpdateEvent) => any
+  ): StripePaymentElement;
+
+  /**
+   * Triggered when a Saved Payment Method is removed.
+   */
+  on(
+    eventType: 'savedpaymentmethodremove',
+    handler: (event: StripePaymentElementSavedPaymentMethodRemoveEvent) => any
+  ): StripePaymentElement;
+
   /**
    * Updates the options the `PaymentElement` was initialized with.
    * Updates are merged into the existing configuration.
@@ -158,6 +183,7 @@ export interface FieldsOption {
         phone?: FieldOption;
         address?:
           | FieldOption
+          | 'if_required'
           | {
               country?: FieldOption;
               postalCode?: FieldOption;
@@ -199,6 +225,7 @@ export interface LayoutObject {
   defaultCollapsed?: boolean;
   radios?: boolean;
   spacedAccordionItems?: boolean;
+  visibleAccordionItemsCount?: number;
 }
 
 export interface StripePaymentElementOptions {
@@ -297,3 +324,112 @@ export interface StripePaymentElementChangeEvent {
     };
   };
 }
+
+type CardBrand =
+  | 'amex'
+  | 'diners'
+  | 'discover'
+  | 'eftpos_au'
+  | 'jcb'
+  | 'mastercard'
+  | 'unionpay'
+  | 'visa'
+  | 'unknown';
+type CardFunding = 'credit' | 'debit' | 'prepaid' | 'unknown';
+
+export interface StripePaymentElementCardDetailsChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the card details are loading.
+   */
+  loading: boolean;
+
+  /**
+   * The card details for the selected payment method.
+   * Undefined while loading and for non card payment methods.
+   */
+  details?: {
+    brands: CardBrand[] | null;
+    funding: CardFunding | null;
+  };
+}
+
+export interface StripePaymentElementSavedPaymentMethodUpdateEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the saved payment method is successfully updated.
+   */
+  success: boolean;
+
+  /**
+   * Error message if the saved payment method update fails.
+   */
+  error?: string;
+
+  /**
+   * The updated saved payment method.
+   */
+  payment_method: {
+    id: string;
+    type: string;
+    billing_details: {
+      address: {
+        city: null | string;
+        country: null | string;
+        line1: null | string;
+        line2: null | string;
+        postal_code: null | string;
+        state: null | string;
+      };
+      name: null | string;
+      email: null | string;
+      phone: null | string;
+    };
+  };
+}
+
+export interface StripePaymentElementSavedPaymentMethodRemoveEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the saved payment method is successfully removed.
+   */
+  success: boolean;
+
+  /**
+   * Error message if the saved payment method removal fails.
+   */
+  error?: string;
+
+  /**
+   * The removed saved payment method.
+   */
+  payment_method: {
+    id: string;
+    type: string;
+    billing_details: {
+      address: {
+        city: null | string;
+        country: null | string;
+        line1: null | string;
+        line2: null | string;
+        postal_code: null | string;
+        state: null | string;
+      };
+      name: null | string;
+      email: null | string;
+      phone: null | string;
+    };
+  };
+}

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

@@ -116,6 +116,31 @@ export type StripePaymentElement = StripeElementBase & {
     handler?: (event: {elementType: 'payment'}) => any
   ): StripePaymentElement;
 
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   * Represents the details of a selected Card payment method.
+   */
+  on(
+    eventType: 'carddetailschange',
+    handler: (event: StripePaymentElementCardDetailsChangeEvent) => any
+  ): StripePaymentElement;
+
+  /**
+   * Triggered when a Saved Payment Method is updated.
+   */
+  on(
+    eventType: 'savedpaymentmethodupdate',
+    handler: (event: StripePaymentElementSavedPaymentMethodUpdateEvent) => any
+  ): StripePaymentElement;
+
+  /**
+   * Triggered when a Saved Payment Method is removed.
+   */
+  on(
+    eventType: 'savedpaymentmethodremove',
+    handler: (event: StripePaymentElementSavedPaymentMethodRemoveEvent) => any
+  ): StripePaymentElement;
+
   /**
    * Updates the options the `PaymentElement` was initialized with.
    * Updates are merged into the existing configuration.
@@ -158,6 +183,7 @@ export interface FieldsOption {
         phone?: FieldOption;
         address?:
           | FieldOption
+          | 'if_required'
           | {
               country?: FieldOption;
               postalCode?: FieldOption;
@@ -199,6 +225,7 @@ export interface LayoutObject {
   defaultCollapsed?: boolean;
   radios?: boolean;
   spacedAccordionItems?: boolean;
+  visibleAccordionItemsCount?: number;
 }
 
 export interface StripePaymentElementOptions {
@@ -297,3 +324,112 @@ export interface StripePaymentElementChangeEvent {
     };
   };
 }
+
+type CardBrand =
+  | 'amex'
+  | 'diners'
+  | 'discover'
+  | 'eftpos_au'
+  | 'jcb'
+  | 'mastercard'
+  | 'unionpay'
+  | 'visa'
+  | 'unknown';
+type CardFunding = 'credit' | 'debit' | 'prepaid' | 'unknown';
+
+export interface StripePaymentElementCardDetailsChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the card details are loading.
+   */
+  loading: boolean;
+
+  /**
+   * The card details for the selected payment method.
+   * Undefined while loading and for non card payment methods.
+   */
+  details?: {
+    brands: CardBrand[] | null;
+    funding: CardFunding | null;
+  };
+}
+
+export interface StripePaymentElementSavedPaymentMethodUpdateEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the saved payment method is successfully updated.
+   */
+  success: boolean;
+
+  /**
+   * Error message if the saved payment method update fails.
+   */
+  error?: string;
+
+  /**
+   * The updated saved payment method.
+   */
+  payment_method: {
+    id: string;
+    type: string;
+    billing_details: {
+      address: {
+        city: null | string;
+        country: null | string;
+        line1: null | string;
+        line2: null | string;
+        postal_code: null | string;
+        state: null | string;
+      };
+      name: null | string;
+      email: null | string;
+      phone: null | string;
+    };
+  };
+}
+
+export interface StripePaymentElementSavedPaymentMethodRemoveEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'payment';
+
+  /**
+   * `true` when the saved payment method is successfully removed.
+   */
+  success: boolean;
+
+  /**
+   * Error message if the saved payment method removal fails.
+   */
+  error?: string;
+
+  /**
+   * The removed saved payment method.
+   */
+  payment_method: {
+    id: string;
+    type: string;
+    billing_details: {
+      address: {
+        city: null | string;
+        country: null | string;
+        line1: null | string;
+        line2: null | string;
+        postal_code: null | string;
+        state: null | string;
+      };
+      name: null | string;
+      email: null | string;
+      phone: null | string;
+    };
+  };
+}

package/dist/stripe-js/elements-group.d.mts

@@ -1,6 +1,7 @@
 import {
   StripeAddressElement,
   StripeAddressElementOptions,
+  StripeCurrencySelectorElement,
   StripeShippingAddressElement,
   StripeShippingAddressElementOptions,
   StripePaymentRequestButtonElement,
@@ -68,7 +69,10 @@ export interface StripeElements {
    * Before confirming payment, call elements.submit() to validate the state of the
    * Payment Element and collect any data required for wallets.
    */
-  submit(): Promise<{error?: StripeError}>;
+  submit(): Promise<
+    | {error?: StripeError; selectedPaymentMethod?: undefined}
+    | {selectedPaymentMethod: string; error?: undefined}
+  >;
 
   /////////////////////////////
   /// address
@@ -332,9 +336,6 @@ export interface StripeElements {
   /////////////////////////////
 
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
-   *
    * Creates a `LinkAuthenticationElement`.
    */
   create(
@@ -343,9 +344,6 @@ export interface StripeElements {
   ): StripeLinkAuthenticationElement;
 
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
-   *
    * Looks up a previously created `Element` by its type.
    */
   getElement(
@@ -500,6 +498,7 @@ export type StripeElementType =
   | 'cardNumber'
   | 'cardExpiry'
   | 'cardCvc'
+  | 'currencySelector'
   | 'epsBank'
   | 'expressCheckout'
   | 'fpxBank'
@@ -531,6 +530,7 @@ export type StripeElement =
   | StripeIbanElement
   | StripeIdealBankElement
   | StripeP24BankElement
+  | StripeCurrencySelectorElement
   | StripeExpressCheckoutElement
   | StripePaymentElement
   | StripePaymentMethodMessagingElement
@@ -670,6 +670,14 @@ interface BaseStripeElementsOptions {
    * Display saved PaymentMethods and Customer information.
    */
   customerSessionClientSecret?: string;
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Display Custom Payment Methods in the Payment Element that you are already registered with.
+   */
+  customPaymentMethods?: CustomPaymentMethod[];
 }
 
 export interface StripeElementsOptionsClientSecret
@@ -1128,3 +1136,25 @@ export interface CustomerOptions {
    */
   ephemeralKey: string;
 }
+
+export interface CustomPaymentMethod {
+  /**
+   * The Custom Payment Method id, prefixed with `cpmt_`.
+   */
+  id: string;
+
+  /**
+   * Additional options to configure the Custom Payment Method.
+   */
+  options: {
+    /**
+     * The payment form type.
+     */
+    type: 'static';
+
+    /**
+     * Display additional information about the payment method, max 100 characters.
+     */
+    subtitle?: string;
+  };
+}