@stripe/stripe-js 3.0.10 → 3.2.0

package/dist/stripe-js/custom-checkout.d.ts

@@ -0,0 +1,402 @@
+import {
+  LayoutObject,
+  Layout,
+  TermsOption,
+  StripePaymentElement,
+} from './elements/payment';
+import {
+  AddressMode,
+  ContactOption,
+  StripeAddressElement,
+} from './elements/address';
+import {Appearance, CssFontSource, CustomFontSource} from './elements-group';
+import {StripeError} from './stripe';
+import {
+  StripeElementBase,
+  StripeExpressCheckoutElement,
+  StripeExpressCheckoutElementConfirmEvent,
+  StripeExpressCheckoutElementOptions,
+  StripeExpressCheckoutElementReadyEvent,
+} from './elements';
+
+/**
+ * Requires beta access:
+ * Contact [Stripe support](https://support.stripe.com/) for more information.
+ */
+
+export interface StripeCustomCheckoutElementsOptions {
+  appearance?: Appearance;
+  loader?: 'auto' | 'always' | 'never';
+  fonts?: Array<CssFontSource | CustomFontSource>;
+}
+
+export interface StripeCustomCheckoutOptions {
+  clientSecret: string;
+  elementsOptions?: StripeCustomCheckoutElementsOptions;
+}
+
+/* Custom Checkout types */
+export type StripeCustomCheckoutAddress = {
+  country: string;
+  line1?: string | null;
+  line2?: string | null;
+  city?: string | null;
+  postal_code?: string | null;
+  state?: string | null;
+};
+
+export type StripeCustomCheckoutAdjustableQuantity = {
+  maximum: number;
+  minimum: number;
+};
+
+export type StripeCustomCheckoutBillingInterval =
+  | 'day'
+  | 'month'
+  | 'week'
+  | 'year';
+
+export type StripeCustomCheckoutConfirmationRequirement =
+  | 'phoneNumber'
+  | 'shippingAddress'
+  | 'billingAddress'
+  | 'paymentDetails'
+  | 'email';
+
+export type StripeCustomCheckoutContact = {
+  name?: string | null;
+  address: StripeCustomCheckoutAddress;
+};
+
+export type StripeCustomCheckoutDeliveryEstimate = {
+  maximum: StripeCustomCheckoutEstimate | null;
+  minimum: StripeCustomCheckoutEstimate | null;
+};
+
+export type StripeCustomCheckoutDiscountAmount = {
+  amount: number;
+  displayName: string;
+  promotionCode: string | null;
+  recurring:
+    | {type: 'forever'}
+    | {type: 'repeating'; durationInMonths: number}
+    | null;
+};
+
+export type StripeCustomCheckoutDueNext = {
+  amountSubtotal: number;
+  amountDiscount: number;
+  amountTaxInclusive: number;
+  amountTaxExclusive: number;
+  billingCycleAnchor: number | null;
+};
+
+export type StripeCustomCheckoutEstimate = {
+  unit: 'business_day' | 'day' | 'hour' | 'week' | 'month';
+  value: number;
+};
+
+export type StripeCustomCheckoutLastPaymentError = {
+  message: string;
+};
+
+export type StripeCustomCheckoutTaxAmount = {
+  amount: number;
+  inclusive: boolean;
+  displayName: string;
+};
+
+export type StripeCustomCheckoutLineItem = {
+  id: string;
+  name: string;
+  amountDiscount: number;
+  amountSubtotal: number;
+  amountTaxExclusive: number;
+  amountTaxInclusive: number;
+  unitAmount: number;
+  description: string | null;
+  quantity: number;
+  discountAmounts: Array<StripeCustomCheckoutDiscountAmount> | null;
+  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
+  recurring: {
+    interval: StripeCustomCheckoutBillingInterval;
+    intervalCount: number;
+    isProrated: boolean;
+    usageType: 'metered' | 'licensed';
+  } | null;
+  adjustableQuantity: StripeCustomCheckoutAdjustableQuantity | null;
+};
+
+export type StripeCustomCheckoutRecurring = {
+  interval: StripeCustomCheckoutBillingInterval;
+  intervalCount: number;
+  dueNext: StripeCustomCheckoutDueNext;
+  trial: StripeCustomCheckoutTrial | null;
+};
+
+export type StripeCustomCheckoutShipping = {
+  shippingOption: StripeCustomCheckoutShippingOption;
+  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
+};
+
+export type StripeCustomCheckoutShippingOption = {
+  id: string;
+  amount: number;
+  currency: string;
+  displayName: string | null;
+  deliveryEstimate: StripeCustomCheckoutDeliveryEstimate | null;
+};
+
+export type StripeCustomCheckoutStatus =
+  | {type: 'open'}
+  | {type: 'expired'}
+  | {
+      type: 'complete';
+      paymentStatus: 'paid' | 'unpaid' | 'no_payment_required';
+    };
+
+export type StripeCustomCheckoutTaxStatus =
+  | {status: 'ready'}
+  | {status: 'requires_shipping_address'}
+  | {status: 'requires_billing_address'};
+
+export type StripeCustomCheckoutTotalSummary = {
+  appliedBalance: number;
+  balanceAppliedToNextInvoice: boolean;
+  discount: number;
+  shippingRate: number;
+  subtotal: number;
+  taxExclusive: number;
+  taxInclusive: number;
+  total: number;
+};
+
+export type StripeCustomCheckoutTrial = {
+  trialEnd: number;
+  trialPeriodDays: number;
+};
+
+/* Custom Checkout session */
+export interface StripeCustomCheckoutSession {
+  billingAddress: StripeCustomCheckoutContact | null;
+  canConfirm: boolean;
+  confirmationRequirements: StripeCustomCheckoutConfirmationRequirement[];
+  currency: string;
+  discountAmounts: Array<StripeCustomCheckoutDiscountAmount> | null;
+  email: string | null;
+  lastPaymentError: StripeCustomCheckoutLastPaymentError | null;
+  lineItems: Array<StripeCustomCheckoutLineItem>;
+  phoneNumber: string | null;
+  recurring: StripeCustomCheckoutRecurring | null;
+  shipping: StripeCustomCheckoutShipping | null;
+  shippingAddress: StripeCustomCheckoutContact | null;
+  shippingOptions: Array<StripeCustomCheckoutShippingOption>;
+  status: StripeCustomCheckoutStatus;
+  tax: StripeCustomCheckoutTaxStatus;
+  taxAmounts: Array<StripeCustomCheckoutTaxAmount> | null;
+  total: StripeCustomCheckoutTotalSummary;
+}
+
+export type StripeCustomCheckoutResult =
+  | {session: StripeCustomCheckoutSession; error?: undefined}
+  | {session?: undefined; error: StripeError};
+
+export type StripeCustomCheckoutPaymentElementOptions = {
+  layout?: Layout | LayoutObject;
+  paymentMethodOrder?: Array<string>;
+  readonly?: boolean;
+  terms?: TermsOption;
+};
+
+export type StripeCustomCheckoutAddressElementOptions = {
+  mode: AddressMode;
+  contacts?: ContactOption[];
+  display?: {
+    name?: 'full' | 'split' | 'organization';
+  };
+};
+
+export type StripeCustomCheckoutExpressCheckoutElementOptions = {
+  buttonHeight: StripeExpressCheckoutElementOptions['buttonHeight'];
+  buttonTheme: StripeExpressCheckoutElementOptions['buttonTheme'];
+  buttonType: StripeExpressCheckoutElementOptions['buttonType'];
+  layout: StripeExpressCheckoutElementOptions['layout'];
+};
+
+export type StripeCustomCheckoutUpdateHandler = (
+  session: StripeCustomCheckoutSession
+) => void;
+
+export type StripeCustomCheckoutExpressCheckoutElementConfirmEvent = StripeExpressCheckoutElementConfirmEvent & {
+  confirm: () => Promise<StripeCustomCheckoutResult>;
+};
+
+export type StripeCustomCheckoutExpressCheckoutElement = StripeElementBase & {
+  /**
+   * Triggered when the element is fully rendered.
+   */
+  on(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'ready',
+    handler: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'ready',
+    handler?: (event: StripeExpressCheckoutElementReadyEvent) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element gains focus.
+   */
+  on(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'focus',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'focus',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element loses focus.
+   */
+  on(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'blur',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'blur',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the escape key is pressed within the element.
+   */
+  on(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'escape',
+    handler: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'escape',
+    handler?: (event: {elementType: 'expressCheckout'}) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when the element fails to load.
+   */
+  on(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'loaderror',
+    handler: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'loaderror',
+    handler?: (event: {
+      elementType: 'expressCheckout';
+      error: StripeError;
+    }) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Triggered when a buyer authorizes a payment within a supported payment method.
+   */
+  on(
+    eventType: 'confirm',
+    handler: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  once(
+    eventType: 'confirm',
+    handler: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+  off(
+    eventType: 'confirm',
+    handler?: (
+      event: StripeCustomCheckoutExpressCheckoutElementConfirmEvent
+    ) => any
+  ): StripeCustomCheckoutExpressCheckoutElement;
+
+  /**
+   * Updates the options the `ExpressCheckoutElement` was initialized with.
+   * Updates are merged into the existing configuration.
+   */
+  update: StripeExpressCheckoutElement['update'];
+};
+
+export interface StripeCustomCheckout {
+  /* Custom Checkout methods */
+  applyPromotionCode: (
+    promotionCode: string
+  ) => Promise<StripeCustomCheckoutResult>;
+  removePromotionCode: () => Promise<StripeCustomCheckoutResult>;
+  updateShippingAddress: (
+    shippingAddress: StripeCustomCheckoutContact | null
+  ) => Promise<StripeCustomCheckoutResult>;
+  updateBillingAddress: (
+    billingAddress: StripeCustomCheckoutContact | null
+  ) => Promise<StripeCustomCheckoutResult>;
+  updatePhoneNumber: (phoneNumber: string) => void;
+  updateEmail: (email: string) => void;
+  updateLineItemQuantity: (args: {
+    lineItem: string;
+    quantity: number;
+  }) => Promise<StripeCustomCheckoutResult>;
+  updateShippingOption: (
+    shippingOption: string
+  ) => Promise<StripeCustomCheckoutResult>;
+  confirm: (args?: {
+    return_url?: string;
+  }) => Promise<StripeCustomCheckoutResult>;
+  session: () => StripeCustomCheckoutSession;
+  on: (event: 'change', handler: StripeCustomCheckoutUpdateHandler) => void;
+
+  /* Elements methods */
+  changeAppearance: (appearance: Appearance) => void;
+  getElement(elementType: 'payment'): StripePaymentElement | null;
+  getElement(
+    elementType: 'address',
+    mode: AddressMode
+  ): StripeAddressElement | null;
+  getElement(
+    elementType: 'expressCheckout'
+  ): StripeCustomCheckoutExpressCheckoutElement | null;
+  createElement(
+    elementType: 'payment',
+    options?: StripeCustomCheckoutPaymentElementOptions
+  ): StripePaymentElement;
+  createElement(
+    elementType: 'address',
+    options: StripeCustomCheckoutAddressElementOptions
+  ): StripeAddressElement;
+  createElement(
+    elementType: 'expressCheckout',
+    options: StripeCustomCheckoutExpressCheckoutElementOptions
+  ): StripeCustomCheckoutExpressCheckoutElement;
+}

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

@@ -0,0 +1,261 @@
+import {StripeElementBase} 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;
+
+  /**
+   * Validates and retrieves form values from the `AddressElement`.
+   */
+  getValue(): Promise<
+    Pick<StripeAddressElementChangeEvent, 'complete' | 'isNewAddress' | 'value'>
+  >;
+};
+
+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 {
+  /**
+   * 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;
+  };
+}