@stripe/stripe-js 1.36.0 → 1.38.0

package/dist/pure.esm.js

@@ -54,7 +54,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "1.36.0",
+    version: "1.38.0",
     startTime: startTime
   });
 };

package/dist/pure.js

@@ -58,7 +58,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "1.36.0",
+    version: "1.38.0",
     startTime: startTime
   });
 };

package/dist/stripe.esm.js

@@ -38,7 +38,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "1.36.0",
+    version: "1.38.0",
     startTime: startTime
   });
 };

package/dist/stripe.js

@@ -42,7 +42,7 @@ var registerWrapper = function registerWrapper(stripe, startTime) {
 
   stripe._registerWrapper({
     name: 'stripe-js',
-    version: "1.36.0",
+    version: "1.38.0",
     startTime: startTime
   });
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-js",
-  "version": "1.36.0",
+  "version": "1.38.0",
   "description": "Stripe.js loading utility",
   "main": "dist/stripe.js",
   "module": "dist/stripe.esm.js",

package/types/stripe-js/elements/address.d.ts

@@ -0,0 +1,255 @@
+import {StripeElementBase, StripeElementChangeEvent} from './base';
+import {StripeError} from '../stripe';
+
+export type StripeAddressElement = StripeElementBase & {
+  /**
+   * The change event is triggered when the `Element`'s value changes.
+   */
+  on(
+    eventType: 'change',
+    handler: (event: StripeAddressElementChangeEvent) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'change',
+    handler: (event: StripeAddressElementChangeEvent) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'change',
+    handler?: (event: StripeAddressElementChangeEvent) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the element is fully rendered and can accept `element.focus` calls.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'ready',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'address'; error: StripeError}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {elementType: 'address'; error: StripeError}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {elementType: 'address'; error: StripeError}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Triggered when the loader UI is mounted to the DOM and ready to be displayed.
+   */
+  on(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  once(
+    eventType: 'loaderstart',
+    handler: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+  off(
+    eventType: 'loaderstart',
+    handler?: (event: {elementType: 'address'}) => any
+  ): StripeAddressElement;
+
+  /**
+   * Updates the options the `AddressElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update(options: Partial<StripeAddressElementOptions>): StripeAddressElement;
+};
+
+export interface ContactOption {
+  name: string;
+  phone?: string;
+  address: {
+    line1: string;
+    line2?: string;
+    city: string;
+    state: string;
+    postal_code: string;
+    country: string;
+  };
+}
+
+export type AddressMode = 'shipping' | 'billing';
+
+export interface StripeAddressElementOptions {
+  /**
+   * Control which mode the AddressElement will be used for.
+   */
+  mode: AddressMode;
+
+  /**
+   * An array of two-letter ISO country codes representing which countries
+   * are displayed in the AddressElement.
+   */
+  allowedCountries?: string[] | null;
+
+  /**
+   * Control autocomplete settings in the AddressElement.
+   */
+  autocomplete?:
+    | {mode: 'automatic'}
+    | {mode: 'disabled'}
+    | {mode: 'google_maps_api'; apiKey: string};
+
+  /**
+   * Whether or not AddressElement accepts PO boxes
+   */
+  blockPoBox?: boolean;
+
+  /**
+   * An array of saved addresses.
+   */
+  contacts?: ContactOption[];
+
+  /**
+   * Default value for AddressElement fields
+   */
+  defaultValues?: {
+    name?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    address?: {
+      line1?: string | null;
+      line2?: string | null;
+      city?: string | null;
+      state?: string | null;
+      postal_code?: string | null;
+      country: string;
+    };
+    phone?: string | null;
+  };
+
+  /**
+   * Control which additional fields to display in the AddressElement.
+   */
+  fields?: {
+    phone?: 'always' | 'never' | 'auto';
+  };
+
+  /**
+   * Specify validation rules for the above additional fields.
+   */
+  validation?: {
+    phone?: {
+      required: 'always' | 'never' | 'auto';
+    };
+  };
+
+  /**
+   * Specify display options in the AddressElement
+   */
+  display?: {
+    name?: 'full' | 'split' | 'organization';
+  };
+}
+
+export interface StripeAddressElementChangeEvent
+  extends StripeElementChangeEvent {
+  /**
+   * The type of element that emitted this event.
+   */
+  elementType: 'address';
+
+  /**
+   * The mode of the AddressElement that emitted this event.
+   */
+  elementMode: AddressMode;
+
+  /**
+   * Whether or not the AddressElement is currently empty.
+   */
+  empty: boolean;
+
+  /**
+   * Whether or not the AddressElement is complete.
+   */
+  complete: boolean;
+
+  /**
+   * Whether or not the address is new.
+   */
+  isNewAddress: boolean;
+
+  /**
+   * An object containing the current address.
+   */
+  value: {
+    name: string;
+    firstName?: string;
+    lastName?: string;
+    address: {
+      line1: string;
+      line2: string | null;
+      city: string;
+      state: string;
+      postal_code: string;
+      country: string;
+    };
+    phone?: string;
+  };
+}

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

@@ -1,3 +1,5 @@
+export * from './address';
+export * from './payment-method-messaging';
 export * from './affirm-message';
 export * from './afterpay-clearpay-message';
 export * from './au-bank-account';

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

@@ -0,0 +1,93 @@
+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.
+   */
+  paymentMethods: Array<'afterpay_clearpay' | 'klarna'>;
+
+  /**
+   * 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 font color of the promotional message.
+   */
+  darkMode?: boolean;
+
+  /**
+   * The font size of the promotional message.
+   */
+  metaData?: {
+    messagingClientReferenceId: string | null;
+  };
+}

package/types/stripe-js/elements/shipping-address.d.ts

@@ -194,7 +194,7 @@ export interface StripeShippingAddressElementChangeEvent
   complete: boolean;
 
   /**
-   * Whether or not the the shipping address is new.
+   * Whether or not the shipping address is new.
    */
   isNewAddress: boolean;
 

package/types/stripe-js/elements-group.d.ts

@@ -1,4 +1,6 @@
 import {
+  StripeAddressElement,
+  StripeAddressElementOptions,
   StripeShippingAddressElement,
   StripeShippingAddressElementOptions,
   StripePaymentRequestButtonElement,
@@ -29,6 +31,8 @@ import {
   StripeAfterpayClearpayMessageElementOptions,
   StripeAffirmMessageElement,
   StripeAffirmMessageElementOptions,
+  StripePaymentMethodMessagingElementOptions,
+  StripePaymentMethodMessagingElement,
   StripeAfterpayClearpayMessageElement,
   StripeAuBankAccountElementOptions,
 } from './elements';
@@ -46,6 +50,48 @@ export interface StripeElements {
    */
   fetchUpdates(): Promise<{error?: {message: string; status?: string}}>;
 
+  /////////////////////////////
+  /// address
+  /////////////////////////////
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Creates a `AddressElement`.
+   */
+  create(
+    elementType: 'address',
+    options: StripeAddressElementOptions
+  ): StripeAddressElement;
+
+  /**
+   * Requires beta access:
+   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   *
+   * Looks up a previously created `Element` by its type.
+   */
+  getElement(elementType: 'address'): StripeAddressElement | null;
+
+  /////////////////////////////
+  /// paymentMethodMessaging
+  /////////////////////////////
+
+  /**
+   * Creates an `paymentMethodMessagingElement`.
+   */
+  create(
+    elementType: 'paymentMethodMessaging',
+    options: StripePaymentMethodMessagingElementOptions
+  ): StripePaymentMethodMessagingElement;
+
+  /**
+   * Looks up a previously created `Element` by its type.
+   */
+  getElement(
+    elementType: 'paymentMethodMessaging'
+  ): StripePaymentMethodMessagingElement | null;
+
   /////////////////////////////
   /// affirmMessage
   /////////////////////////////
@@ -329,9 +375,13 @@ export interface StripeElements {
     elementType: 'paymentRequestButton'
   ): StripePaymentRequestButtonElement | null;
 
+  /////////////////////////////
+  /// shippingAddress
+  /////////////////////////////
+
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   * @deprecated
+   * Use `Address` element instead.
    *
    * Creates a `ShippingAddressElement`.
    */
@@ -341,8 +391,8 @@ export interface StripeElements {
   ): StripeShippingAddressElement;
 
   /**
-   * Requires beta access:
-   * Contact [Stripe support](https://support.stripe.com/) for more information.
+   * @deprecated
+   * Use `Address` element instead.
    *
    * Looks up a previously created `Element` by its type.
    */
@@ -352,6 +402,7 @@ export interface StripeElements {
 }
 
 export type StripeElementType =
+  | 'address'
   | 'affirmMessage'
   | 'afterpayClearpayMessage'
   | 'auBankAccount'