@stripe/stripe-js 3.0.9 → 3.0.10

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

@@ -1,153 +0,0 @@
-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<{
-    /**
-     * 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';
-
-  /**
-   * 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?: {
-    /**
-     * 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[];
-  };
-
-  /**
-   * 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'
-  | 'fil'
-  | 'fr'
-  | 'fr-CA'
-  | 'hr'
-  | '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/dist/stripe-js/custom-checkout.d.mts

@@ -1,402 +0,0 @@
-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;
-}