@stripe/stripe-react-native 0.55.1 → 0.56.0

package/src/specs/NativeStripeSdkModule.ts

@@ -11,6 +11,7 @@ import type {
   CreateTokenForCVCUpdateResult,
   CreateTokenResult,
   CustomerAdapter,
+  CustomerSessionClientSecret,
   CustomerSheetError,
   CustomerSheetInitParams,
   CustomerSheetPresentParams,
@@ -175,6 +176,12 @@ export interface Spec extends TurboModule {
   customerAdapterSetupIntentClientSecretForCustomerAttachCallback(
     clientSecret: string
   ): Promise<void>;
+  clientSecretProviderSetupIntentClientSecretCallback(
+    setupIntentClientSecret: string
+  ): Promise<void>;
+  clientSecretProviderCustomerSessionClientSecretCallback(
+    customerSessionClientSecret: UnsafeObject<CustomerSessionClientSecret>
+  ): Promise<void>;
   createEmbeddedPaymentElement(
     intentConfig: UnsafeObject<IntentConfiguration>,
     configuration: UnsafeObject<EmbeddedPaymentElementConfiguration>

package/src/types/ConfirmationToken.ts

@@ -4,9 +4,6 @@ import type { Type as PaymentMethodType } from './PaymentMethod';
 
 /**
  * ConfirmationToken result type.
- *
- * @internal DO NOT USE - This API is under active development and is not ready for use.
- * The API is subject to breaking changes without notice. Do not use in production or development.
  */
 export interface Result {
   /** Unique identifier for the object (e.g. `ctoken_...`). */

package/src/types/CustomerSheet.ts

@@ -7,17 +7,11 @@ import type {
   CardBrand,
 } from '../types';
 
-export type CustomerSheetInitParams = {
+type CustomerSheetOptionalInitParams = {
   /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. iOS only. */
   style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
   /** Configuration for the look and feel of the UI. */
   appearance?: PaymentSheet.AppearanceParams;
-  /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
-  setupIntentClientSecret?: string;
-  /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
-  customerId: string;
-  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
-  customerEphemeralKeySecret: string;
   /** Your customer-facing business name. The default value is the name of your app. */
   merchantDisplayName?: string;
   /** Optional configuration for setting the header text of the Payment Method selection screen */
@@ -37,11 +31,6 @@ export type CustomerSheetInitParams = {
   /** The list of preferred networks that should be used to process payments made with a co-branded card.
    * This value will only be used if your user hasn't selected a network themselves. */
   preferredNetworks?: Array<CardBrand>;
-  /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
-   * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
-   * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
-   */
-  customerAdapter?: CustomerAdapter;
   /** This is an experimental feature that may be removed at any time.
    *  Defaults to true. If true, the customer can delete all saved payment methods.
    *  If false, the customer can't delete if they only have one saved payment method remaining.
@@ -56,6 +45,45 @@ export type CustomerSheetInitParams = {
   cardBrandAcceptance?: PaymentSheet.CardBrandAcceptance;
 };
 
+/**
+ * Required params for initializing a CustomerSheet using a legacy CustomerAdapter
+ */
+type CustomerAdapterInitParams = {
+  /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
+  customerId: string;
+  /** Optional but recommended for cards, required for other payment methods. The SetupIntent client secret that will be used to confirm a new payment method. If this is missing, you will only be able to add cards without authentication steps. */
+  setupIntentClientSecret?: string;
+  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
+  customerEphemeralKeySecret: string;
+  /** Optional override. It is generally recommended to rely on the default behavior, but- provide a CustomerAdapter here if
+   * you would prefer retrieving and updating your Stripe customer object via your own backend instead.
+   * WARNING: When implementing your own CustomerAdapter, ensure your application complies with all applicable laws and regulations, including data privacy and consumer protection.
+   */
+  customerAdapter?: CustomerAdapter;
+  intentConfiguration?: never;
+  clientSecretProvider?: never;
+};
+
+/**
+ * Required params for initializing a CustomerSheet with a CustomerSession
+ */
+type CustomerSessionInitParams = {
+  /** An object that configures the intent used to display saved payment methods to a customer.*/
+  intentConfiguration: CustomerSheetIntentConfiguration;
+  /** An object that provides the client secret for the customer session. */
+  clientSecretProvider: ClientSecretProvider;
+  customerId?: never;
+  setupIntentClientSecret?: never;
+  customerEphemeralKeySecret?: never;
+  customerAdapter?: never;
+};
+
+export type CustomerSheetInitParams = (
+  | CustomerAdapterInitParams
+  | CustomerSessionInitParams
+) &
+  CustomerSheetOptionalInitParams;
+
 export type CustomerSheetPresentParams = {
   /** Controls how the modal is presented (after animation). iOS only. Defaults to `popover`. See https://developer.apple.com/documentation/uikit/uimodalpresentationstyle for more info. */
   presentationStyle?:
@@ -131,3 +159,43 @@ export type CustomerPaymentOption =
   | 'google_pay'
   | 'link'
   | string;
+
+export interface ClientSecretProvider {
+  /**
+   * Provides the `SetupIntent` client secret that is used when attaching a payment method
+   * to a customer.
+   */
+  provideSetupIntentClientSecret(): Promise<string>;
+
+  /**
+   * Provides the CustomerSessionClientSecret that will be claimed and used to access a
+   * customer's saved payment methods.
+   */
+  provideCustomerSessionClientSecret(): Promise<CustomerSessionClientSecret>;
+}
+
+export type CustomerSheetIntentConfiguration = {
+  /** A list of payment method types to display to the customer. If undefined or empty, we dynamically determine the payment methods using your Stripe Dashboard settings. */
+  paymentMethodTypes?: Array<string>;
+  /** The connected account whose payment method configurations will apply to the CustomerSheet session.
+   * Affects the allowed payment methods and whether card brand choice is enabled.
+   * When provided, the payment method will be saved to your platform account. See our
+   * [SetupIntent docs](https://docs.stripe.com/api/setup_intents/object#setup_intent_object-on_behalf_of)
+   * for more information.
+   */
+  onBehalfOf?: string;
+};
+
+export type CustomerSessionClientSecret = {
+  /**
+   * The Customer the Customer Session was created for.
+   */
+  customerId: string;
+  /**
+   * The client secret of this Customer Session.
+   * Used on the client to set up secure access to the given customer.
+   * See our [CustomerSession docs](https://docs.stripe.com/api/customer_sessions/object)
+   * for more information
+   */
+  clientSecret: string;
+};

package/src/types/EmbeddedPaymentElement.tsx

@@ -135,11 +135,9 @@ export interface EmbeddedPaymentElementConfiguration {
   merchantDisplayName: string;
   /** The identifier of the Stripe Customer object. See https://stripe.com/docs/api/customers/object#customer_object-id */
   customerId?: string;
-  /** A short-lived token that allows the SDK to access a Customer’s payment methods. */
+  /** A short-lived token that allows the SDK to access a Customer's payment methods. */
   customerEphemeralKeySecret?: string;
-  /** (Experimental) This parameter can be changed or removed at any time (use at your own risk).
-   *  The client secret of this Customer Session. Used on the client to set up secure access to the given customer.
-   */
+  /** The client secret of this Customer Session. Used on the client to set up secure access to the given customer. */
   customerSessionClientSecret?: string;
   /** iOS only. Enable Apple Pay in the Payment Sheet by passing an ApplePayParams object.  */
   applePay?: PaymentSheetTypes.ApplePayParams;

package/src/types/PaymentSheet.ts

@@ -97,9 +97,7 @@ export type SetupParams =
     })
   | (SetupParamsBase & {
       customerEphemeralKeySecret?: never;
-      /** (Experimental) This parameter can be changed or removed at any time (use at your own risk).
-       *  The client secret of this Customer Session. Used on the client to set up secure access to the given customer.
-       */
+      /** The client secret of this Customer Session. Used on the client to set up secure access to the given customer. */
       customerSessionClientSecret: string;
     })
   | SetupParamsBase;
@@ -580,9 +578,6 @@ export type IntentConfiguration = {
   ) => void;
 
   /**
-   * @internal DO NOT USE - This API is under active development and is not ready for use.
-   * The API is subject to breaking changes without notice. Do not use in production or development.
-   *
    * Called when the customer confirms payment using confirmation tokens.
    * Your implementation should follow the guide to create (and optionally confirm) a PaymentIntent or SetupIntent on your server and call the `intentCreationCallback` with its client secret or an error if one occurred.
    *

package/stripe-react-native.podspec

@@ -2,7 +2,7 @@ require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
 # Keep stripe_version in sync with https://github.com/stripe/stripe-identity-react-native/blob/main/stripe-identity-react-native.podspec
-stripe_version = '~> 24.24.0'
+stripe_version = '~> 24.25.0'
 
 fabric_enabled = ENV['RCT_NEW_ARCH_ENABLED'] == '1'