@stripe/stripe-js 3.0.7 → 3.0.9

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

@@ -0,0 +1,140 @@
+import {
+  StripeElementBase,
+  StripeElementStyle,
+  StripeElementClasses,
+  StripeElementChangeEvent,
+} from './base';
+
+export type StripeEpsBankElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeEpsBankElementChangeEvent) => any
+  ): StripeEpsBankElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeEpsBankElementChangeEvent) => any
+  ): StripeEpsBankElement;
+  off(
+    eventType: 'change',
+    handler: (event: StripeEpsBankElementChangeEvent) => any
+  ): StripeEpsBankElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  off(
+    eventType: 'ready',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  off(
+    eventType: 'focus',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  off(
+    eventType: 'blur',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+  off(
+    eventType: 'escape',
+    handler: (event: {elementType: 'epsBank'}) => any
+  ): StripeEpsBankElement;
+
+  /**
+   * Updates the options the `EpsBankElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   *
+   * The styles of an `EpsBankElement` 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<StripeEpsBankElementOptions>): void;
+};
+
+export interface StripeEpsBankElementOptions {
+  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 [EPS guide](https://stripe.com/docs/payments/eps/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 StripeEpsBankElementChangeEvent
+  extends StripeElementChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'epsBank';
+
+  /**
+   * A pre-filled value for the Element.
+   * Can be one of the banks listed in the [EPS guide](https://stripe.com/docs/payments/eps/accept-a-payment#bank-values) (e.g., `bank_austria`).
+   */
+  value?: string;
+}

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

@@ -0,0 +1,446 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+import {ApplePayOption, ApplePayUpdateOption} from './apple-pay';
+
+export type StripeExpressCheckoutElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when a button on the element is clicked.
+   */
+  on(
+    eventType: 'click',
+    handler: (event: StripeExpressCheckoutElementClickEvent) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'click',
+    handler: (event: StripeExpressCheckoutElementClickEvent) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'click',
+    handler?: (event: StripeExpressCheckoutElementClickEvent) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when a buyer authorizes a payment within a supported payment method.
+   */
+  on(
+    eventType: 'confirm',
+    handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'confirm',
+    handler: (event: StripeExpressCheckoutElementConfirmEvent) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'confirm',
+    handler?: (event: StripeExpressCheckoutElementConfirmEvent) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when a payment interface is dismissed (e.g., a buyer closes the payment interface)
+   */
+  on(
+    eventType: 'cancel',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'cancel',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'cancel',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when a buyer selects a different shipping address.
+   */
+  on(
+    eventType: 'shippingaddresschange',
+    handler: (
+      event: StripeExpressCheckoutElementShippingAddressChangeEvent
+    ) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'shippingaddresschange',
+    handler: (
+      event: StripeExpressCheckoutElementShippingAddressChangeEvent
+    ) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'shippingaddresschange',
+    handler?: (
+      event: StripeExpressCheckoutElementShippingAddressChangeEvent
+    ) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Triggered when a buyer selects a different shipping rate.
+   */
+  on(
+    eventType: 'shippingratechange',
+    handler: (event: StripeExpressCheckoutElementShippingRateChangeEvent) => any
+  ): StripeExpressCheckoutElement;
+  once(
+    eventType: 'shippingratechange',
+    handler: (event: StripeExpressCheckoutElementShippingRateChangeEvent) => any
+  ): StripeExpressCheckoutElement;
+  off(
+    eventType: 'shippingratechange',
+    handler?: (
+      event: StripeExpressCheckoutElementShippingRateChangeEvent
+    ) => any
+  ): StripeExpressCheckoutElement;
+
+  /**
+   * Updates the options the `ExpressCheckoutElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(
+    options: StripeExpressCheckoutElementUpdateOptions
+  ): StripeExpressCheckoutElement;
+};
+
+export type ExpressPaymentType = 'google_pay' | 'apple_pay' | 'link' | 'paypal';
+
+export type ExpressCheckoutPartialAddress = {
+  city: string;
+  state: string;
+  postal_code: string;
+  country: string;
+};
+
+export type ExpressCheckoutAddress = ExpressCheckoutPartialAddress & {
+  line1: string;
+  line2: string | null;
+};
+
+export type BillingDetails = {
+  name: string;
+  email?: string;
+  phone?: string;
+  address: ExpressCheckoutAddress;
+};
+
+export type ShippingAddress = {
+  name: string;
+  address: ExpressCheckoutAddress;
+};
+
+export type LineItem = {
+  name: string;
+  amount: number;
+};
+
+export type DeliveryUnit = 'hour' | 'day' | 'business_day' | 'week' | 'month';
+
+export type DeliveryEstimate = {
+  unit: DeliveryUnit;
+  value: number;
+};
+
+export type ShippingRate = {
+  id: string;
+  amount: number;
+  displayName: string;
+  deliveryEstimate?:
+    | string
+    | {
+        maximum?: DeliveryEstimate;
+        minimum?: DeliveryEstimate;
+      };
+};
+
+export type LayoutOption = {
+  maxColumns?: number;
+  maxRows?: number;
+  overflow?: 'auto' | 'never';
+};
+
+export type ExpressCheckoutWalletOption = 'always' | 'auto' | 'never';
+
+export type ExpressCheckoutWalletsOption = {
+  applePay?: ExpressCheckoutWalletOption;
+  googlePay?: ExpressCheckoutWalletOption;
+};
+
+export type ApplePayButtonTheme = 'black' | 'white' | 'white-outline';
+
+export type GooglePayButtonTheme = 'black' | 'white';
+
+export type ButtonThemeOption = {
+  applePay?: ApplePayButtonTheme;
+  googlePay?: GooglePayButtonTheme;
+};
+
+export type ApplePayButtonType =
+  | 'add-money'
+  | 'book'
+  | 'buy'
+  | 'check-out'
+  | 'contribute'
+  | 'donate'
+  | 'order'
+  | 'plain'
+  | 'reload'
+  | 'rent'
+  | 'subscribe'
+  | 'support'
+  | 'tip'
+  | 'top-up';
+
+export type GooglePayButtonType =
+  | 'book'
+  | 'buy'
+  | 'checkout'
+  | 'donate'
+  | 'order'
+  | 'pay'
+  | 'plain'
+  | 'subscribe';
+
+export type ButtonTypeOption = {
+  applePay?: ApplePayButtonType;
+  googlePay?: GooglePayButtonType;
+};
+
+export interface StripeExpressCheckoutElementOptions {
+  /**
+   * Manually sets the height of the buttons shown.
+   */
+  buttonHeight?: number;
+
+  /**
+   * Controls the color of each button.
+   */
+  buttonTheme?: ButtonThemeOption;
+
+  /**
+   * Specifies the type of each button.
+   */
+  buttonType?: ButtonTypeOption;
+
+  /**
+   * Specifies how buttons should be laid out in relation to each other.
+   */
+  layout?: LayoutOption;
+
+  /**
+   * Override the order in which payment methods are displayed in the Express Checkout Element.
+   * By default, the Express Checkout Element will use a dynamic ordering that optimizes payment method display for each user.
+   */
+  paymentMethodOrder?: string[];
+
+  /**
+   * Control wallets display in the Express Checkout Element.
+   */
+  wallets?: ExpressCheckoutWalletsOption;
+}
+
+/*
+ * Updatable options for an `Elements` instance
+ */
+export interface StripeExpressCheckoutElementUpdateOptions {
+  /**
+   * Manually sets the height of the buttons shown.
+   */
+  buttonHeight?: number;
+
+  /**
+   * Specifies how buttons should be laid out in relation to each other.
+   */
+  layout?: LayoutOption;
+
+  /**
+   * Override the order in which payment methods are displayed in the Pay Button Element.
+   * By default, the Express Checkout Element will use a dynamic ordering that optimizes payment method display for each user.
+   */
+  paymentMethodOrder?: string[];
+}
+
+export type AvailablePaymentMethods = {
+  applePay: boolean;
+  googlePay: boolean;
+};
+
+export interface StripeExpressCheckoutElementReadyEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'expressCheckout';
+
+  /**
+   * The list of payment methods that could possibly show in the element, or undefined if no payment methods can show.
+   */
+  availablePaymentMethods: undefined | AvailablePaymentMethods;
+}
+
+export type ClickResolveDetails = {
+  /**
+   * An array of two-letter ISO country codes representing which countries
+   * are eligible shipping locations.
+   */
+  allowedShippingCountries?: string[];
+
+  billingAddressRequired?: boolean;
+
+  /**
+   * Provide information about your business that will be displayed in the payment interface.
+   * This information will be retrieved from your Stripe account if not provided.
+   */
+  business?: {name: string};
+
+  emailRequired?: boolean;
+
+  lineItems?: Array<LineItem>;
+
+  phoneNumberRequired?: boolean;
+
+  shippingAddressRequired?: boolean;
+
+  shippingRates?: Array<ShippingRate>;
+
+  applePay?: ApplePayOption;
+};
+
+export interface StripeExpressCheckoutElementClickEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'expressCheckout';
+
+  /**
+   * The payment method associated with the button that was clicked.
+   */
+  expressPaymentType: ExpressPaymentType;
+
+  /**
+   * Callback to configure the details shown on a payment interface, including which fields to collect.
+   * This must be called within 1 second of the 'click' event being emitted.
+   */
+  resolve: (resolveDetails?: ClickResolveDetails) => void;
+}
+
+export interface StripeExpressCheckoutElementConfirmEvent {
+  /**
+   * Callback when a payment is unsuccessful. Optionally, specifying a reason will show a more detailed error in the payment interface.
+   */
+  paymentFailed: (payload?: {
+    reason?: 'fail' | 'invalid_shipping_address';
+  }) => void;
+
+  billingDetails?: BillingDetails;
+
+  shippingAddress?: ShippingAddress;
+
+  shippingRate?: ShippingRate;
+
+  expressPaymentType: ExpressPaymentType;
+}
+
+export type ChangeResolveDetails = {
+  lineItems?: Array<LineItem>;
+  shippingRates?: Array<ShippingRate>;
+  applePay?: ApplePayUpdateOption;
+};
+
+export interface StripeExpressCheckoutElementShippingAddressChangeEvent {
+  name: string;
+  address: ExpressCheckoutPartialAddress;
+  resolve: (resolveDetails?: ChangeResolveDetails) => void;
+  reject: () => void;
+}
+
+export interface StripeExpressCheckoutElementShippingRateChangeEvent {
+  shippingRate: ShippingRate;
+  resolve: (resolveDetails?: ChangeResolveDetails) => void;
+  reject: () => void;
+}