@stripe/stripe-js 1.20.3 → 1.21.0

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

@@ -1,153 +1,151 @@
-declare module '@stripe/stripe-js' {
-  interface RedirectToCheckoutServerOptions {
-    /**
-     * The ID of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions) that is used in [Checkout's server integration](https://stripe.com/docs/payments/checkout/one-time).
-     */
-    sessionId: string;
-  }
-
-  interface RedirectToCheckoutClientOptions {
-    /**
-     * The URL to which Stripe should send customers when payment is complete.
-     * If you’d like access to the Checkout Session for the successful payment, read more about it in our guide on [fulfilling your payments with webhooks](https://stripe.com/docs/payments/checkout/fulfillment#webhooks).
-     */
-    successUrl: string;
-
-    /**
-     * The URL to which Stripe should send customers when payment is canceled.
-     */
-    cancelUrl: string;
-
-    /**
-     * An array of objects representing the items that your customer would like to purchase.
-     * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
-     */
-    lineItems?: Array<{
-      /**
-       * The ID of the price that the customer would like to purchase. SKU or plan IDs may also be used.
-       */
-      price?: string;
-
-      /**
-       * The quantity of units for the item.
-       */
-      quantity?: number;
-    }>;
-
-    /**
-     * An array of objects representing the items that your customer would like to purchase.
-     * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
-     *
-     * @deprecated
-     */
-    items?: Array<{
-      /**
-       * The ID of the SKU that the customer would like to purchase
-       */
-      sku?: string;
-
-      /**
-       * The ID of the plan that the customer would like to subscribe to.
-       */
-      plan?: string;
-
-      /**
-       * The quantity of units for the item.
-       */
-      quantity?: number;
-    }>;
-
-    /**
-     * The mode of the Checkout Session. Required if using lineItems.
-     */
-    mode?: 'payment' | 'subscription';
+export interface RedirectToCheckoutServerOptions {
+  /**
+   * The ID of the [Checkout Session](https://stripe.com/docs/api/checkout/sessions) that is used in [Checkout's server integration](https://stripe.com/docs/payments/checkout/one-time).
+   */
+  sessionId: string;
+}
 
+export interface RedirectToCheckoutClientOptions {
+  /**
+   * The URL to which Stripe should send customers when payment is complete.
+   * If you’d like access to the Checkout Session for the successful payment, read more about it in our guide on [fulfilling your payments with webhooks](https://stripe.com/docs/payments/checkout/fulfillment#webhooks).
+   */
+  successUrl: string;
+
+  /**
+   * The URL to which Stripe should send customers when payment is canceled.
+   */
+  cancelUrl: string;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   */
+  lineItems?: Array<{
     /**
-     * A unique string to reference the Checkout session.
-     * This can be a customer ID, a cart ID, or similar.
-     * It is included in the `checkout.session.completed` webhook and can be used to fulfill the purchase.
+     * The ID of the price that the customer would like to purchase. SKU or plan IDs may also be used.
      */
-    clientReferenceId?: string;
+    price?: string;
 
     /**
-     * The email address used to create the customer object.
-     * If you already know your customer's email address, use this attribute to prefill it on Checkout.
+     * The quantity of units for the item.
      */
-    customerEmail?: string;
-
+    quantity?: number;
+  }>;
+
+  /**
+   * An array of objects representing the items that your customer would like to purchase.
+   * These items are shown as line items in the Checkout interface and make up the total amount to be collected by Checkout.
+   *
+   * @deprecated
+   */
+  items?: Array<{
     /**
-     * Specify whether Checkout should collect the customer’s billing address.
-     * If set to `required`, Checkout will attempt to collect the customer’s billing address.
-     * If not set or set to `auto` Checkout will only attempt to collect the billing address when necessary.
+     * The ID of the SKU that the customer would like to purchase
      */
-    billingAddressCollection?: 'auto' | 'required';
+    sku?: string;
 
     /**
-     * Provides configuration for Checkout to collect a shipping address from a customer.
+     * The ID of the plan that the customer would like to subscribe to.
      */
-    shippingAddressCollection?: {
-      /**
-       * An array of two-letter ISO country codes representing which countries
-       * Checkout should provide as options for shipping locations. The codes are
-       * expected to be uppercase. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
-       */
-      allowedCountries: string[];
-    };
+    plan?: string;
 
     /**
-     * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display Checkout in.
-     * Default is `auto` (Stripe detects the locale of the browser).
+     * The quantity of units for the item.
      */
-    locale?: CheckoutLocale;
-
+    quantity?: number;
+  }>;
+
+  /**
+   * The mode of the Checkout Session. Required if using lineItems.
+   */
+  mode?: 'payment' | 'subscription';
+
+  /**
+   * A unique string to reference the Checkout session.
+   * This can be a customer ID, a cart ID, or similar.
+   * It is included in the `checkout.session.completed` webhook and can be used to fulfill the purchase.
+   */
+  clientReferenceId?: string;
+
+  /**
+   * The email address used to create the customer object.
+   * If you already know your customer's email address, use this attribute to prefill it on Checkout.
+   */
+  customerEmail?: string;
+
+  /**
+   * Specify whether Checkout should collect the customer’s billing address.
+   * If set to `required`, Checkout will attempt to collect the customer’s billing address.
+   * If not set or set to `auto` Checkout will only attempt to collect the billing address when necessary.
+   */
+  billingAddressCollection?: 'auto' | 'required';
+
+  /**
+   * Provides configuration for Checkout to collect a shipping address from a customer.
+   */
+  shippingAddressCollection?: {
     /**
-     * Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the **Submit** button.
-     * `submitType` can only be specified when using using line items or SKUs, and not subscriptions.
-     * The default is `auto`.
+     * An array of two-letter ISO country codes representing which countries
+     * Checkout should provide as options for shipping locations. The codes are
+     * expected to be uppercase. Unsupported country codes: AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI.
      */
-    submitType?: 'auto' | 'book' | 'donate' | 'pay';
-  }
-
-  type RedirectToCheckoutOptions =
-    | RedirectToCheckoutServerOptions
-    | RedirectToCheckoutClientOptions;
-
-  type CheckoutLocale =
-    | 'auto'
-    | 'bg'
-    | 'cs'
-    | 'da'
-    | 'de'
-    | 'el'
-    | 'en'
-    | 'en-GB'
-    | 'es'
-    | 'es-419'
-    | 'et'
-    | 'fi'
-    | 'fr'
-    | 'fr-CA'
-    | 'hu'
-    | 'id'
-    | 'it'
-    | 'ja'
-    | 'lt'
-    | 'lv'
-    | 'ms'
-    | 'mt'
-    | 'nb'
-    | 'nl'
-    | 'pl'
-    | 'pt'
-    | 'pt-BR'
-    | 'ro'
-    | 'ru'
-    | 'sk'
-    | 'sl'
-    | 'sv'
-    | 'th'
-    | 'tr'
-    | 'zh'
-    | 'zh-HK'
-    | 'zh-TW';
+    allowedCountries: string[];
+  };
+
+  /**
+   * The [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the locale to display Checkout in.
+   * Default is `auto` (Stripe detects the locale of the browser).
+   */
+  locale?: CheckoutLocale;
+
+  /**
+   * Describes the type of transaction being performed by Checkout in order to customize relevant text on the page, such as the **Submit** button.
+   * `submitType` can only be specified when using using line items or SKUs, and not subscriptions.
+   * The default is `auto`.
+   */
+  submitType?: 'auto' | 'book' | 'donate' | 'pay';
 }
+
+export type RedirectToCheckoutOptions =
+  | RedirectToCheckoutServerOptions
+  | RedirectToCheckoutClientOptions;
+
+export type CheckoutLocale =
+  | 'auto'
+  | 'bg'
+  | 'cs'
+  | 'da'
+  | 'de'
+  | 'el'
+  | 'en'
+  | 'en-GB'
+  | 'es'
+  | 'es-419'
+  | 'et'
+  | 'fi'
+  | 'fr'
+  | 'fr-CA'
+  | 'hu'
+  | 'id'
+  | 'it'
+  | 'ja'
+  | 'lt'
+  | 'lv'
+  | 'ms'
+  | 'mt'
+  | 'nb'
+  | 'nl'
+  | 'pl'
+  | 'pt'
+  | 'pt-BR'
+  | 'ro'
+  | 'ru'
+  | 'sk'
+  | 'sl'
+  | 'sv'
+  | 'th'
+  | 'tr'
+  | 'zh'
+  | 'zh-HK'
+  | 'zh-TW';

package/types/stripe-js/elements/affirm-message.d.ts

@@ -1,62 +1,60 @@
-declare module '@stripe/stripe-js' {
-  type StripeAffirmMessageElement = {
-    /**
-     * 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., `'#affirm-message'`) 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 `AffirmMessageElement` was initialized with.
-     * Updates are merged into the existing configuration.
-     */
-    update(options: Partial<StripeAffirmMessageElementOptions>): void;
-
-    /**
-     * Triggered when the element is fully loaded and ready to perform method calls.
-     */
-    on(
-      eventType: 'ready',
-      handler: (event: {elementType: 'affirmMessage'}) => any
-    ): StripeAffirmMessageElement;
-  };
-
-  interface StripeAffirmMessageElementOptions {
-    /**
-     * The total amount in the smallest currency unit.
-     */
-    amount: number;
-
-    /**
-     * The currency to display.
-     */
-    currency: 'USD';
-
-    /**
-     * The affirm logo color.
-     */
-    logoColor?: 'primary' | 'black' | 'white';
-
-    /**
-     * The font color of the promotional message.
-     */
-    fontColor?: string;
-
-    /**
-     * The font size of the promotional message.
-     */
-    fontSize?: string;
-  }
+export type StripeAffirmMessageElement = {
+  /**
+   * 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., `'#affirm-message'`) 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 `AffirmMessageElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: Partial<StripeAffirmMessageElementOptions>): void;
+
+  /**
+   * Triggered when the element is fully loaded and ready to perform method calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'affirmMessage'}) => any
+  ): StripeAffirmMessageElement;
+};
+
+export interface StripeAffirmMessageElementOptions {
+  /**
+   * The total amount in the smallest currency unit.
+   */
+  amount: number;
+
+  /**
+   * The currency to display.
+   */
+  currency: 'USD';
+
+  /**
+   * The affirm logo color.
+   */
+  logoColor?: 'primary' | 'black' | 'white';
+
+  /**
+   * The font color of the promotional message.
+   */
+  fontColor?: string;
+
+  /**
+   * The font size of the promotional message.
+   */
+  fontSize?: string;
 }

package/types/stripe-js/elements/afterpay-clearpay-message.d.ts

@@ -1,121 +1,119 @@
-declare module '@stripe/stripe-js' {
-  type StripeAfterpayClearpayMessageElement = {
-    /**
-     * 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., `'#afterpay-clearpay-message'`) 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 `AfterpayClearpayMessageElement` was initialized with.
-     * Updates are merged into the existing configuration.
-     */
-    update(options: Partial<StripeAfterpayClearpayMessageElementOptions>): void;
-
-    /**
-     * Triggered when the element is fully loaded and ready to perform method calls.
-     */
-    on(
-      eventType: 'ready',
-      handler: (event: {elementType: 'afterpayClearpayMessage'}) => any
-    ): StripeAfterpayClearpayMessageElement;
-  };
-
-  interface StripeAfterpayClearpayMessageElementOptions {
-    /**
-     * The total amount, divided into 4 installments, in the smallest currency unit.
-     */
-    amount: number;
-
-    /**
-     * The currency to display.
-     */
-    currency: 'USD' | 'AUD' | 'CAD' | 'GBP' | 'NZD' | 'EUR';
-
-    /**
-     * The badge color theme, applied when `logoType` is set to badge.
-     */
-    badgeTheme?:
-      | 'black-on-mint'
-      | 'black-on-white'
-      | 'mint-on-black'
-      | 'white-on-black';
-
-    /**
-     * The leading text for the mesage.
-     */
-    introText?: 'In' | 'in' | 'Or' | 'or' | 'Pay' | 'pay' | 'Pay in' | 'pay in';
-
-    /**
-     * Indicates whether an item is eligible for purchase with Afterpay Clearpay.
-     */
-    isEligible?: boolean;
-
-    /**
-     * Indicates whether an entire cart is eligible for purchase with Afterpay Clearpay.
-     */
-    isCartEligible?: boolean;
-
-    /**
-     * The lockup color theme, applied when `logoType` is set to lockup.
-     */
-    lockupTheme?: 'black' | 'white' | 'mint';
-
-    /**
-     * The logo style to display.
-     */
-    logoType?: 'badge' | 'lockup';
-
-    /**
-     * The maximum `amount` allowed for a purchase. This should match the limit defined in your Stripe dashboard.
-     */
-    max?: number;
-
-    /**
-     * The minimum `amount` allowed for a purchase. This should match the limit defined in your Stripe dashboard.
-     */
-    min?: number;
-
-    /**
-     * The style of modal link to display.
-     */
-    modalLinkStyle?: 'circled-info-icon' | 'learn-more-text' | 'more-info-text';
-
-    /**
-     * The background color for the info modal.
-     */
-    modalTheme?: 'mint' | 'white';
-
-    /**
-     * Determines whether 'interest-free' is displayed in the message.
-     */
-    showInterestFree?: boolean;
-
-    /**
-     * Determines whether 'with' is displayed before the logo.
-     */
-    showLowerLimit?: boolean;
-
-    /**
-     * Determines whether the lower limit is displayed when `amount` exceeds price limits.
-     */
-    showUpperLimit?: boolean;
-
-    /**
-     * Determines whether the upper limit is displayed when `amount` exceeds price limits.
-     */
-    showWith?: boolean;
-  }
+export type StripeAfterpayClearpayMessageElement = {
+  /**
+   * 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., `'#afterpay-clearpay-message'`) 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 `AfterpayClearpayMessageElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: Partial<StripeAfterpayClearpayMessageElementOptions>): void;
+
+  /**
+   * Triggered when the element is fully loaded and ready to perform method calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'afterpayClearpayMessage'}) => any
+  ): StripeAfterpayClearpayMessageElement;
+};
+
+export interface StripeAfterpayClearpayMessageElementOptions {
+  /**
+   * The total amount, divided into 4 installments, in the smallest currency unit.
+   */
+  amount: number;
+
+  /**
+   * The currency to display.
+   */
+  currency: 'USD' | 'AUD' | 'CAD' | 'GBP' | 'NZD' | 'EUR';
+
+  /**
+   * The badge color theme, applied when `logoType` is set to badge.
+   */
+  badgeTheme?:
+    | 'black-on-mint'
+    | 'black-on-white'
+    | 'mint-on-black'
+    | 'white-on-black';
+
+  /**
+   * The leading text for the mesage.
+   */
+  introText?: 'In' | 'in' | 'Or' | 'or' | 'Pay' | 'pay' | 'Pay in' | 'pay in';
+
+  /**
+   * Indicates whether an item is eligible for purchase with Afterpay Clearpay.
+   */
+  isEligible?: boolean;
+
+  /**
+   * Indicates whether an entire cart is eligible for purchase with Afterpay Clearpay.
+   */
+  isCartEligible?: boolean;
+
+  /**
+   * The lockup color theme, applied when `logoType` is set to lockup.
+   */
+  lockupTheme?: 'black' | 'white' | 'mint';
+
+  /**
+   * The logo style to display.
+   */
+  logoType?: 'badge' | 'lockup';
+
+  /**
+   * The maximum `amount` allowed for a purchase. This should match the limit defined in your Stripe dashboard.
+   */
+  max?: number;
+
+  /**
+   * The minimum `amount` allowed for a purchase. This should match the limit defined in your Stripe dashboard.
+   */
+  min?: number;
+
+  /**
+   * The style of modal link to display.
+   */
+  modalLinkStyle?: 'circled-info-icon' | 'learn-more-text' | 'more-info-text';
+
+  /**
+   * The background color for the info modal.
+   */
+  modalTheme?: 'mint' | 'white';
+
+  /**
+   * Determines whether 'interest-free' is displayed in the message.
+   */
+  showInterestFree?: boolean;
+
+  /**
+   * Determines whether 'with' is displayed before the logo.
+   */
+  showLowerLimit?: boolean;
+
+  /**
+   * Determines whether the lower limit is displayed when `amount` exceeds price limits.
+   */
+  showUpperLimit?: boolean;
+
+  /**
+   * Determines whether the upper limit is displayed when `amount` exceeds price limits.
+   */
+  showWith?: boolean;
 }