@stripe/stripe-js 3.0.10 → 3.1.0

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

@@ -0,0 +1,224 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeCartElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'change',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'ready',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the 'checkout' button in the element is clicked
+   */
+  on(
+    eventType: 'checkout',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'checkout',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'checkout',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when a line item in the element is clicked
+   */
+  on(
+    eventType: 'lineitemclick',
+    handler: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'lineitemclick',
+    handler: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'lineitemclick',
+    handler?: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Updates the options the `CartElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: StripeCartElementUpdateOptions): StripeCartElement;
+
+  /**
+   * Makes the Cart Element visible
+   */
+  show(): StripeCartElement;
+
+  /**
+   * Makes the Cart Element not visible
+   */
+  hide(): StripeCartElement;
+
+  /**
+   * Cancels the "Check Out" button loader and displays an error message regarding why going to checkout failed
+   */
+  cancelCheckout(errorMessage?: string | null): StripeCartElement;
+
+  /**
+   * Adds a line item to the CartSession
+   */
+  addLineItem(
+    lineItemData:
+      | {
+          product: string;
+          price?: null;
+          item_details?: null;
+          quantity?: number | null;
+        }
+      | {
+          product?: null;
+          price: string;
+          item_details?: null;
+          quantity?: number | null;
+        }
+      | {
+          price?: null;
+          product?: null;
+          item_details: CartItemDetails;
+          quantity?: number | null;
+        }
+  ): Promise<{error?: StripeError}>;
+};
+
+export type CartItemDetails = {
+  external_id: string;
+  name: string;
+  description?: string;
+  image?: string;
+  unit_amount: number;
+};
+
+export type CartDescriptor = 'cart' | 'bag' | 'basket';
+
+export type CartShowOnAdd = 'never' | 'auto';
+
+export interface StripeCartElementOptions {
+  /**
+   * Identifies the CartSession the Element will display and modify.
+   */
+  clientSecret: string;
+
+  /**
+   * Override the verbiage used within the Element to refer to itself.
+   * By default the Cart Element will use the term 'cart'.
+   */
+  descriptor?: CartDescriptor | null;
+
+  /**
+   * Override the text used in the title of the Element.
+   * By default the Cart Element will use the title 'Your [descriptor]'.
+   */
+  header?: {
+    text?: string | null;
+  };
+
+  /**
+   * Control whether the Element automatically appears when items are added to the cart.
+   * By default, the Cart Element will use 'auto'.
+   */
+  showOnAdd?: CartShowOnAdd | null;
+}
+
+/*
+ * Updatable options for an `Elements` instance
+ */
+export interface StripeCartElementUpdateOptions {
+  /**
+   * Override the text used in the title of the Element.
+   * By default the Cart Element will use the title 'Your [descriptor]'.
+   */
+  header?: {
+    text?: string | null;
+  };
+
+  /**
+   * Control whether the Element automatically appears when items are added to the cart.
+   * By default, the Cart Element will use 'auto'.
+   */
+  showOnAdd?: CartShowOnAdd | null;
+}
+
+export interface StripeCartElementPayloadEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'cart';
+
+  /**
+   * The ID of the CartSession associated with the Element.
+   */
+  id: string;
+
+  /**
+   * The number of line items currently in the cart.
+   */
+  lineItems: {
+    count: number;
+  };
+}
+
+export interface StripeCartElementLineItemClickEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'cart';
+
+  /**
+   * The ID of the CartSession associated with the Element.
+   */
+  preventDefault: () => void;
+
+  /**
+   * The type of element that emitted this event.
+   */
+  url: string;
+}

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

@@ -0,0 +1,224 @@
+import {StripeElementBase} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeCartElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'change',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'ready',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {elementType: 'cart'; error: StripeError}) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when the 'checkout' button in the element is clicked
+   */
+  on(
+    eventType: 'checkout',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'checkout',
+    handler: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'checkout',
+    handler?: (event: StripeCartElementPayloadEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Triggered when a line item in the element is clicked
+   */
+  on(
+    eventType: 'lineitemclick',
+    handler: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+  once(
+    eventType: 'lineitemclick',
+    handler: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+  off(
+    eventType: 'lineitemclick',
+    handler?: (event: StripeCartElementLineItemClickEvent) => any
+  ): StripeCartElement;
+
+  /**
+   * Updates the options the `CartElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: StripeCartElementUpdateOptions): StripeCartElement;
+
+  /**
+   * Makes the Cart Element visible
+   */
+  show(): StripeCartElement;
+
+  /**
+   * Makes the Cart Element not visible
+   */
+  hide(): StripeCartElement;
+
+  /**
+   * Cancels the "Check Out" button loader and displays an error message regarding why going to checkout failed
+   */
+  cancelCheckout(errorMessage?: string | null): StripeCartElement;
+
+  /**
+   * Adds a line item to the CartSession
+   */
+  addLineItem(
+    lineItemData:
+      | {
+          product: string;
+          price?: null;
+          item_details?: null;
+          quantity?: number | null;
+        }
+      | {
+          product?: null;
+          price: string;
+          item_details?: null;
+          quantity?: number | null;
+        }
+      | {
+          price?: null;
+          product?: null;
+          item_details: CartItemDetails;
+          quantity?: number | null;
+        }
+  ): Promise<{error?: StripeError}>;
+};
+
+export type CartItemDetails = {
+  external_id: string;
+  name: string;
+  description?: string;
+  image?: string;
+  unit_amount: number;
+};
+
+export type CartDescriptor = 'cart' | 'bag' | 'basket';
+
+export type CartShowOnAdd = 'never' | 'auto';
+
+export interface StripeCartElementOptions {
+  /**
+   * Identifies the CartSession the Element will display and modify.
+   */
+  clientSecret: string;
+
+  /**
+   * Override the verbiage used within the Element to refer to itself.
+   * By default the Cart Element will use the term 'cart'.
+   */
+  descriptor?: CartDescriptor | null;
+
+  /**
+   * Override the text used in the title of the Element.
+   * By default the Cart Element will use the title 'Your [descriptor]'.
+   */
+  header?: {
+    text?: string | null;
+  };
+
+  /**
+   * Control whether the Element automatically appears when items are added to the cart.
+   * By default, the Cart Element will use 'auto'.
+   */
+  showOnAdd?: CartShowOnAdd | null;
+}
+
+/*
+ * Updatable options for an `Elements` instance
+ */
+export interface StripeCartElementUpdateOptions {
+  /**
+   * Override the text used in the title of the Element.
+   * By default the Cart Element will use the title 'Your [descriptor]'.
+   */
+  header?: {
+    text?: string | null;
+  };
+
+  /**
+   * Control whether the Element automatically appears when items are added to the cart.
+   * By default, the Cart Element will use 'auto'.
+   */
+  showOnAdd?: CartShowOnAdd | null;
+}
+
+export interface StripeCartElementPayloadEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'cart';
+
+  /**
+   * The ID of the CartSession associated with the Element.
+   */
+  id: string;
+
+  /**
+   * The number of line items currently in the cart.
+   */
+  lineItems: {
+    count: number;
+  };
+}
+
+export interface StripeCartElementLineItemClickEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'cart';
+
+  /**
+   * The ID of the CartSession associated with the Element.
+   */
+  preventDefault: () => void;
+
+  /**
+   * The type of element that emitted this event.
+   */
+  url: string;
+}

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

@@ -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;
+}