@stripe/stripe-js 3.0.10 → 3.2.0

package/dist/stripe-js/elements/p24-bank.d.mts

@@ -0,0 +1,140 @@
+import {
+  StripeElementBase,
+  StripeElementStyle,
+  StripeElementClasses,
+  StripeElementChangeEvent,
+} from './base';
+
+export type StripeP24BankElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Updates the options the `P24BankElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   *
+   * The styles of an `P24BankElement` can be dynamically changed using `element.update`.
+   * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
+   */
+  update(options: Partial<StripeP24BankElementOptions>): void;
+};
+
+export interface StripeP24BankElementOptions {
+  classes?: StripeElementClasses;
+
+  style?: StripeElementStyle;
+
+  /**
+   * Appearance of the icon in the Element.
+   */
+  iconStyle?: 'default' | 'solid';
+
+  /**
+   * A pre-filled value for the Element.
+   * Can be one of the banks listed in the [Przelewy24 guide](https://stripe.com/docs/payments/p24/accept-a-payment#bank-values) (e.g., `bank_austria`).
+   */
+  value?: string;
+
+  /**
+   * Hides the icon in the Element.
+   * Default is `false`.
+   */
+  hideIcon?: boolean;
+
+  /**
+   * Applies a disabled state to the Element such that user input is not accepted.
+   * Default is false.
+   */
+  disabled?: boolean;
+}
+
+export interface StripeP24BankElementChangeEvent
+  extends StripeElementChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'p24Bank';
+
+  /**
+   * A pre-filled value for the Element.
+   * Can be one of the banks listed in the [Przelewy24 guide](https://stripe.com/docs/payments/p24/accept-a-payment#bank-values) (e.g., `ing`).
+   */
+  value?: string;
+}

package/dist/stripe-js/elements/p24-bank.d.ts

@@ -0,0 +1,140 @@
+import {
+  StripeElementBase,
+  StripeElementStyle,
+  StripeElementClasses,
+  StripeElementChangeEvent,
+} from './base';
+
+export type StripeP24BankElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'change',
+    handler: (event: StripeP24BankElementChangeEvent) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'ready',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'focus',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'blur',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+  off(
+    eventType: 'escape',
+    handler: (event: {elementType: 'p24Bank'}) => any
+  ): StripeP24BankElement;
+
+  /**
+   * Updates the options the `P24BankElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   *
+   * The styles of an `P24BankElement` can be dynamically changed using `element.update`.
+   * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
+   */
+  update(options: Partial<StripeP24BankElementOptions>): void;
+};
+
+export interface StripeP24BankElementOptions {
+  classes?: StripeElementClasses;
+
+  style?: StripeElementStyle;
+
+  /**
+   * Appearance of the icon in the Element.
+   */
+  iconStyle?: 'default' | 'solid';
+
+  /**
+   * A pre-filled value for the Element.
+   * Can be one of the banks listed in the [Przelewy24 guide](https://stripe.com/docs/payments/p24/accept-a-payment#bank-values) (e.g., `bank_austria`).
+   */
+  value?: string;
+
+  /**
+   * Hides the icon in the Element.
+   * Default is `false`.
+   */
+  hideIcon?: boolean;
+
+  /**
+   * Applies a disabled state to the Element such that user input is not accepted.
+   * Default is false.
+   */
+  disabled?: boolean;
+}
+
+export interface StripeP24BankElementChangeEvent
+  extends StripeElementChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'p24Bank';
+
+  /**
+   * A pre-filled value for the Element.
+   * Can be one of the banks listed in the [Przelewy24 guide](https://stripe.com/docs/payments/p24/accept-a-payment#bank-values) (e.g., `ing`).
+   */
+  value?: string;
+}

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

@@ -0,0 +1,98 @@
+export type StripePaymentMethodMessagingElement = {
+  /**
+   * The `element.mount` method attaches your [Element](https://stripe.com/docs/js/element) to the DOM.
+   * `element.mount` accepts either a CSS Selector (e.g., `'#payment-method-messaging'`) or a DOM element.
+   */
+  mount(domElement: string | HTMLElement): void;
+
+  /**
+   * Removes the element from the DOM and destroys it.
+   * A destroyed element can not be re-activated or re-mounted to the DOM.
+   */
+  destroy(): void;
+
+  /**
+   * Unmounts the element from the DOM.
+   * Call `element.mount` to re-attach it to the DOM.
+   */
+  unmount(): void;
+
+  /**
+   * Updates the options the `PaymentMethodMessagingElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: Partial<StripePaymentMethodMessagingElementOptions>): void;
+
+  /**
+   * Triggered when the element is fully loaded and ready to perform method calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'paymentMethodMessaging'}) => any
+  ): StripePaymentMethodMessagingElement;
+};
+
+export interface StripePaymentMethodMessagingElementOptions {
+  /**
+   * The total amount in the smallest currency unit.
+   */
+  amount: number;
+
+  /**
+   * The currency to display.
+   */
+  currency:
+    | 'USD'
+    | 'GBP'
+    | 'EUR'
+    | 'DKK'
+    | 'NOK'
+    | 'SEK'
+    | 'AUD'
+    | 'CAD'
+    | 'NZD';
+
+  /**
+   * Payment methods to show messaging for.
+   */
+  paymentMethodTypes: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;
+
+  /**
+   * @deprecated Use `paymentMethodTypes` instead.
+   */
+  paymentMethods?: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;
+
+  /**
+   * The country the end-buyer is in.
+   */
+  countryCode:
+    | 'US'
+    | 'CA'
+    | 'AU'
+    | 'NZ'
+    | 'GB'
+    | 'IE'
+    | 'FR'
+    | 'ES'
+    | 'DE'
+    | 'AT'
+    | 'BE'
+    | 'DK'
+    | 'FI'
+    | 'IT'
+    | 'NL'
+    | 'NO'
+    | 'SE';
+
+  /**
+   * The logo color to display in the message. Defaults to black
+   */
+  logoColor?: 'black' | 'white' | 'color';
+
+  /**
+   * The font size of the promotional message.
+   */
+  metaData?: {
+    messagingClientReferenceId: string | null;
+  };
+}

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

@@ -0,0 +1,98 @@
+export type StripePaymentMethodMessagingElement = {
+  /**
+   * The `element.mount` method attaches your [Element](https://stripe.com/docs/js/element) to the DOM.
+   * `element.mount` accepts either a CSS Selector (e.g., `'#payment-method-messaging'`) or a DOM element.
+   */
+  mount(domElement: string | HTMLElement): void;
+
+  /**
+   * Removes the element from the DOM and destroys it.
+   * A destroyed element can not be re-activated or re-mounted to the DOM.
+   */
+  destroy(): void;
+
+  /**
+   * Unmounts the element from the DOM.
+   * Call `element.mount` to re-attach it to the DOM.
+   */
+  unmount(): void;
+
+  /**
+   * Updates the options the `PaymentMethodMessagingElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: Partial<StripePaymentMethodMessagingElementOptions>): void;
+
+  /**
+   * Triggered when the element is fully loaded and ready to perform method calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'paymentMethodMessaging'}) => any
+  ): StripePaymentMethodMessagingElement;
+};
+
+export interface StripePaymentMethodMessagingElementOptions {
+  /**
+   * The total amount in the smallest currency unit.
+   */
+  amount: number;
+
+  /**
+   * The currency to display.
+   */
+  currency:
+    | 'USD'
+    | 'GBP'
+    | 'EUR'
+    | 'DKK'
+    | 'NOK'
+    | 'SEK'
+    | 'AUD'
+    | 'CAD'
+    | 'NZD';
+
+  /**
+   * Payment methods to show messaging for.
+   */
+  paymentMethodTypes: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;
+
+  /**
+   * @deprecated Use `paymentMethodTypes` instead.
+   */
+  paymentMethods?: Array<'afterpay_clearpay' | 'klarna' | 'affirm'>;
+
+  /**
+   * The country the end-buyer is in.
+   */
+  countryCode:
+    | 'US'
+    | 'CA'
+    | 'AU'
+    | 'NZ'
+    | 'GB'
+    | 'IE'
+    | 'FR'
+    | 'ES'
+    | 'DE'
+    | 'AT'
+    | 'BE'
+    | 'DK'
+    | 'FI'
+    | 'IT'
+    | 'NL'
+    | 'NO'
+    | 'SE';
+
+  /**
+   * The logo color to display in the message. Defaults to black
+   */
+  logoColor?: 'black' | 'white' | 'color';
+
+  /**
+   * The font size of the promotional message.
+   */
+  metaData?: {
+    messagingClientReferenceId: string | null;
+  };
+}

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

@@ -0,0 +1,151 @@
+import {StripeElementBase, StripeElementClasses} from './base';
+import {PaymentRequest} from '../payment-request';
+import {Omit} from '../../utils';
+
+export type StripePaymentRequestButtonElement = StripeElementBase & {
+  /**
+   * Triggered when the payment request button is clicked.
+   */
+  on(
+    eventType: 'click',
+    handler: (event: StripePaymentRequestButtonElementClickEvent) => any
+  ): StripePaymentRequestButtonElement;
+  once(
+    eventType: 'click',
+    handler: (event: StripePaymentRequestButtonElementClickEvent) => any
+  ): StripePaymentRequestButtonElement;
+  off(
+    eventType: 'click',
+    handler?: (event: StripePaymentRequestButtonElementClickEvent) => any
+  ): StripePaymentRequestButtonElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'paymentRequestButton'}) => any
+  ): StripePaymentRequestButtonElement;
+
+  /**
+   * Updates the options the `PaymentRequestButtonElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   *
+   * The styles of an `PaymentRequestButtonElement` can be dynamically changed using `element.update`.
+   * This method can be used to simulate CSS media queries that automatically adjust the size of elements when viewed on different devices.
+   */
+  update(
+    options: Partial<
+      Omit<StripePaymentRequestButtonElementOptions, 'paymentRequest'>
+    >
+  ): void;
+};
+
+export interface StripePaymentRequestButtonElementOptions {
+  classes?: StripeElementClasses;
+
+  /**
+   * An object used to customize the appearance of the Payment Request Button.
+   * The object must have a single `paymentRequestButton` field, containing any of the following sub-fields
+   */
+  style?: {
+    paymentRequestButton: {
+      /**
+       * Preferred button type to display. Available types, by wallet:
+       *
+       * Browser card: default, book, buy, or donate.
+       *
+       * Google Pay: default, buy, or donate.
+       *
+       * Apple Pay: default, book, buy, donate, check-out, subscribe, reload, add-money, top-up, order, rent, support, contribute, tip
+       *
+       * When a wallet does not support the provided value, default is used as a fallback.
+       */
+      type?:
+        | 'default'
+        | 'book'
+        | 'buy'
+        | 'donate'
+        | 'check-out'
+        | 'subscribe'
+        | 'reload'
+        | 'add-money'
+        | 'top-up'
+        | 'order'
+        | 'rent'
+        | 'support'
+        | 'contribute'
+        | 'tip';
+
+      /**
+       * One of dark, light, or light-outline. The default is dark.
+       */
+      theme?: 'dark' | 'light' | 'light-outline';
+
+      /**
+       * The height of the Payment Request Button. Accepts px unit values.
+       */
+      height?: string;
+
+      /**
+       * The gap between buttons when multile buttons are shown. Accepts px unit values.
+       */
+      buttonSpacing?: string;
+    };
+  };
+
+  /**
+   * A `PaymentRequest` object used to configure the element.
+   */
+  paymentRequest: PaymentRequest;
+
+  /**
+   * Disable showing multiple buttons.
+   * Default is `false`.
+   */
+  disableMultipleButtons?: boolean;
+}
+
+export interface StripePaymentRequestButtonElementClickEvent {
+  preventDefault: () => void;
+}