@stripe/stripe-react-native 0.28.0 → 0.30.0

package/src/functions.ts

@@ -1,10 +1,7 @@
-import { isAndroid, isiOS, createError } from './helpers';
+import { createError } from './helpers';
 import { MissingRoutingNumber } from './types/Errors';
 import NativeStripeSdk from './NativeStripeSdk';
-import {
-  ApplePay,
-  ApplePayError,
-  ApplePayResult,
+import type {
   PlatformPayError,
   ConfirmPaymentResult,
   ConfirmPaymentSheetPaymentResult,
@@ -14,19 +11,15 @@ import {
   CreatePaymentMethodResult,
   CreateTokenForCVCUpdateResult,
   CreateTokenResult,
-  GooglePayInitResult,
   HandleNextActionResult,
+  HandleNextActionForSetupResult,
   InitPaymentSheetResult,
   PaymentMethod,
   PaymentSheet,
-  PayWithGooglePayResult,
   PresentPaymentSheetResult,
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   StripeError,
-  GooglePay,
-  CreateGooglePayPaymentMethodResult,
-  OpenApplePaySetupResult,
   Token,
   VerifyMicrodepositsParams,
   VerifyMicrodepositsForPaymentResult,
@@ -39,10 +32,12 @@ import {
   FinancialConnections,
   PlatformPay,
 } from './types';
-import { Platform } from 'react-native';
-
-const APPLE_PAY_NOT_SUPPORTED_MESSAGE =
-  'Apple pay is not supported on this device';
+import {
+  Platform,
+  NativeEventEmitter,
+  NativeModules,
+  EmitterSubscription,
+} from 'react-native';
 
 export const createPaymentMethod = async (
   params: PaymentMethod.CreateParams,
@@ -176,119 +171,66 @@ export const confirmPayment = async (
   }
 };
 
-/** @deprecated Use `isPlatformPaySupported` instead. */
-export const isApplePaySupported = async (): Promise<boolean> => {
-  return isiOS && (await NativeStripeSdk.isApplePaySupported());
-};
-
-/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
-export const presentApplePay = async (
-  params: ApplePay.PresentParams
-): Promise<ApplePayResult> => {
-  if (!(await NativeStripeSdk.isApplePaySupported())) {
-    return {
-      error: {
-        code: ApplePayError.Canceled,
-        message: APPLE_PAY_NOT_SUPPORTED_MESSAGE,
-      },
-    };
-  }
-
+/** Handles any nextAction required to authenticate the PaymentIntent.
+ * Call this method if you are using manual confirmation. See https://stripe.com/docs/payments/accept-a-payment?platform=react-native&ui=custom
+ *
+ * @param {string} paymentIntentClientSecret The client secret associated with the PaymentIntent.
+ * @param {string=} returnURL An optional return URL so the Stripe SDK can redirect back to your app after authentication. This should match the `return_url` you specified during PaymentIntent confirmation.
+ * */
+export const handleNextAction = async (
+  paymentIntentClientSecret: string,
+  returnURL?: string
+): Promise<HandleNextActionResult> => {
   try {
-    const { paymentMethod, error } = await NativeStripeSdk.presentApplePay(
-      params
-    );
+    const { paymentIntent, error } =
+      Platform.OS === 'ios'
+        ? await NativeStripeSdk.handleNextAction(
+            paymentIntentClientSecret,
+            returnURL ?? null
+          )
+        : await NativeStripeSdk.handleNextAction(paymentIntentClientSecret);
     if (error) {
       return {
         error,
       };
     }
-    return { paymentMethod: paymentMethod! };
-  } catch (error: any) {
     return {
-      error,
-    };
-  }
-};
-
-/** @deprecated Use `updatePlatformPaySheet` instead. */
-export const updateApplePaySummaryItems = async (
-  summaryItems: ApplePay.CartSummaryItem[],
-  errorAddressFields: Array<{
-    field: ApplePay.AddressFields;
-    message?: string;
-  }> = []
-): Promise<{ error?: StripeError<ApplePayError> }> => {
-  if (!(await NativeStripeSdk.isApplePaySupported())) {
-    return {
-      error: {
-        code: ApplePayError.Canceled,
-        message: APPLE_PAY_NOT_SUPPORTED_MESSAGE,
-      },
-    };
-  }
-
-  try {
-    await NativeStripeSdk.updateApplePaySummaryItems(
-      summaryItems,
-      errorAddressFields
-    );
-
-    return {};
-  } catch (error: any) {
-    return {
-      error,
-    };
-  }
-};
-
-/** @deprecated Use `confirmPlatformPaySetupIntent` or `confirmPlatformPayPayment` instead. */
-export const confirmApplePayPayment = async (
-  clientSecret: string
-): Promise<{ error?: StripeError<ApplePayError> }> => {
-  if (!(await NativeStripeSdk.isApplePaySupported())) {
-    return {
-      error: {
-        code: ApplePayError.Canceled,
-        message: APPLE_PAY_NOT_SUPPORTED_MESSAGE,
-      },
+      paymentIntent: paymentIntent!,
     };
-  }
-  try {
-    await NativeStripeSdk.confirmApplePayPayment(clientSecret);
-    return {};
   } catch (error: any) {
     return {
-      error,
+      error: createError(error),
     };
   }
 };
 
-/** Handles any nextAction required to authenticate the PaymentIntent.
- * Call this method if you are using manual confirmation. See https://stripe.com/docs/payments/accept-a-payment?platform=react-native&ui=custom
+/** Handles any nextAction required to authenticate the SetupIntent.
+ * Call this method if you are confirming the SetupIntent on your backend and get a status of requires_action.
  *
- * @param {string} paymentIntentClientSecret The client secret associated with the PaymentIntent.
+ * @param {string} setupIntentClientSecret The client secret associated with the SetupIntent.
  * @param {string=} returnURL An optional return URL so the Stripe SDK can redirect back to your app after authentication. This should match the `return_url` you specified during PaymentIntent confirmation.
  * */
-export const handleNextAction = async (
-  paymentIntentClientSecret: string,
+export const handleNextActionForSetup = async (
+  setupIntentClientSecret: string,
   returnURL?: string
-): Promise<HandleNextActionResult> => {
+): Promise<HandleNextActionForSetupResult> => {
   try {
-    const { paymentIntent, error } =
+    const { setupIntent, error } =
       Platform.OS === 'ios'
-        ? await NativeStripeSdk.handleNextAction(
-            paymentIntentClientSecret,
+        ? await NativeStripeSdk.handleNextActionForSetup(
+            setupIntentClientSecret,
             returnURL ?? null
           )
-        : await NativeStripeSdk.handleNextAction(paymentIntentClientSecret);
+        : await NativeStripeSdk.handleNextActionForSetup(
+            setupIntentClientSecret
+          );
     if (error) {
       return {
         error,
       };
     }
     return {
-      paymentIntent: paymentIntent!,
+      setupIntent: setupIntent!,
     };
   } catch (error: any) {
     return {
@@ -345,8 +287,17 @@ export const createTokenForCVCUpdate = async (
   }
 };
 
+/**
+ * Call this method in your app whenever you receive a URL for a Stripe callback.
+ * For convenience, you can pass all URLs you receive to this method first, and
+ * check the return value to easily determine whether it is a callback URL that Stripe will handle
+ * or if your app should process it normally. This is iOS-only, and will always return false on Android.
+ */
 export const handleURLCallback = async (url: string): Promise<boolean> => {
-  const stripeHandled = await NativeStripeSdk.handleURLCallback(url);
+  const stripeHandled =
+    Platform.OS === 'ios'
+      ? await NativeStripeSdk.handleURLCallback(url)
+      : false;
   return stripeHandled;
 };
 
@@ -402,23 +353,48 @@ export const verifyMicrodepositsForSetup = async (
   }
 };
 
+const eventEmitter = new NativeEventEmitter(NativeModules.StripeSdk);
+let confirmHandlerCallback: EmitterSubscription | null = null;
+let orderTrackingCallbackListener: EmitterSubscription | null = null;
+
 export const initPaymentSheet = async (
   params: PaymentSheet.SetupParams
 ): Promise<InitPaymentSheetResult> => {
   let result;
+  const confirmHandler = params?.intentConfiguration?.confirmHandler;
+  if (confirmHandler) {
+    confirmHandlerCallback?.remove();
+    confirmHandlerCallback = eventEmitter.addListener(
+      'onConfirmHandlerCallback',
+      ({
+        paymentMethod,
+        shouldSavePaymentMethod,
+      }: {
+        paymentMethod: PaymentMethod.Result;
+        shouldSavePaymentMethod: boolean;
+      }) => {
+        confirmHandler(
+          paymentMethod,
+          shouldSavePaymentMethod,
+          NativeStripeSdk.intentCreationCallback
+        );
+      }
+    );
+  }
+
+  const orderTrackingCallback = params?.applePay?.setOrderTracking;
+  if (orderTrackingCallback) {
+    orderTrackingCallbackListener?.remove();
+    orderTrackingCallbackListener = eventEmitter.addListener(
+      'onOrderTrackingCallback',
+      () => {
+        orderTrackingCallback(NativeStripeSdk.configureOrderTracking);
+      }
+    );
+  }
 
-  const setOrderTracking = params?.applePay?.setOrderTracking;
   try {
-    if (setOrderTracking && Platform.OS === 'ios') {
-      result = await NativeStripeSdk.initPaymentSheetWithOrderTracking(
-        params,
-        () => {
-          setOrderTracking(NativeStripeSdk.configureOrderTracking);
-        }
-      );
-    } else {
-      result = await NativeStripeSdk.initPaymentSheet(params);
-    }
+    result = await NativeStripeSdk.initPaymentSheet(params);
 
     if (result.error) {
       return {
@@ -483,92 +459,6 @@ export const resetPaymentSheetCustomer = async (): Promise<null> => {
   return await NativeStripeSdk.resetPaymentSheetCustomer();
 };
 
-/** @deprecated Use `isPlatformPaySupported` instead. */
-export const isGooglePaySupported = async (
-  params?: GooglePay.IsSupportedParams
-): Promise<boolean> => {
-  return (
-    isAndroid && (await NativeStripeSdk.isGooglePaySupported(params ?? {}))
-  );
-};
-
-/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
-export const initGooglePay = async (
-  params: GooglePay.InitParams
-): Promise<GooglePayInitResult> => {
-  try {
-    const { error } = await NativeStripeSdk.initGooglePay(params);
-    if (error) {
-      return {
-        error,
-      };
-    }
-    return {};
-  } catch (error: any) {
-    return {
-      error,
-    };
-  }
-};
-
-/** @deprecated Use `confirmPlatformPaySetupIntent`, `confirmPlatformPayPayment`, or `createPlatformPayPaymentMethod` instead. */
-export const presentGooglePay = async (
-  params: GooglePay.PresentParams
-): Promise<PayWithGooglePayResult> => {
-  try {
-    const { error } = await NativeStripeSdk.presentGooglePay(params);
-    if (error) {
-      return {
-        error,
-      };
-    }
-    return {};
-  } catch (error: any) {
-    return {
-      error,
-    };
-  }
-};
-
-/** @deprecated Use `createPlatformPayPaymentMethod` instead. */
-export const createGooglePayPaymentMethod = async (
-  params: GooglePay.CreatePaymentMethodParams
-): Promise<CreateGooglePayPaymentMethodResult> => {
-  try {
-    const { error, paymentMethod } =
-      await NativeStripeSdk.createGooglePayPaymentMethod(params);
-    if (error) {
-      return {
-        error,
-      };
-    }
-    return {
-      paymentMethod: paymentMethod!,
-    };
-  } catch (error: any) {
-    return {
-      error,
-    };
-  }
-};
-
-/** @deprecated Use `openNativePaySetup` instead. */
-export const openApplePaySetup = async (): Promise<OpenApplePaySetupResult> => {
-  try {
-    const { error } = await NativeStripeSdk.openApplePaySetup();
-    if (error) {
-      return {
-        error,
-      };
-    }
-    return {};
-  } catch (error: any) {
-    return {
-      error,
-    };
-  }
-};
-
 export const collectBankAccountForPayment = async (
   clientSecret: string,
   params: PaymentMethod.CollectBankAccountParams

package/src/hooks/useFinancialConnectionsSheet.tsx

@@ -1,4 +1,4 @@
-import { useState } from 'react';
+import { useState, useCallback } from 'react';
 import { useStripe } from './useStripe';
 
 /**
@@ -12,19 +12,25 @@ export function useFinancialConnectionsSheet() {
   const { collectBankAccountToken, collectFinancialConnectionsAccounts } =
     useStripe();
 
-  const _collectBankAccountToken = async (clientSecret: string) => {
-    setLoading(true);
-    const result = await collectBankAccountToken(clientSecret);
-    setLoading(false);
-    return result;
-  };
+  const _collectBankAccountToken = useCallback(
+    async (clientSecret: string) => {
+      setLoading(true);
+      const result = await collectBankAccountToken(clientSecret);
+      setLoading(false);
+      return result;
+    },
+    [collectBankAccountToken]
+  );
 
-  const _collectFinancialConnectionsAccounts = async (clientSecret: string) => {
-    setLoading(true);
-    const result = await collectFinancialConnectionsAccounts(clientSecret);
-    setLoading(false);
-    return result;
-  };
+  const _collectFinancialConnectionsAccounts = useCallback(
+    async (clientSecret: string) => {
+      setLoading(true);
+      const result = await collectFinancialConnectionsAccounts(clientSecret);
+      setLoading(false);
+      return result;
+    },
+    [collectFinancialConnectionsAccounts]
+  );
 
   return {
     collectBankAccountToken: _collectBankAccountToken,

package/src/hooks/usePaymentSheet.tsx

@@ -1,7 +1,8 @@
-import type { PaymentSheet } from '../types';
-import { useState } from 'react';
+import { useState, useCallback } from 'react';
 import { useStripe } from './useStripe';
 
+import type { PaymentSheet } from '../types';
+
 /**
  * usePaymentSheet hook
  */
@@ -14,33 +15,39 @@ export function usePaymentSheet() {
   } = useStripe();
   const [loading, setLoading] = useState(false);
 
-  const initPaymentSheet = async (params: PaymentSheet.SetupParams) => {
-    setLoading(true);
-    const result = await initPaymentSheetNative(params);
-    setLoading(false);
-    return result;
-  };
+  const initPaymentSheet = useCallback(
+    async (params: PaymentSheet.SetupParams) => {
+      setLoading(true);
+      const result = await initPaymentSheetNative(params);
+      setLoading(false);
+      return result;
+    },
+    [initPaymentSheetNative]
+  );
 
-  const presentPaymentSheet = async (options?: PaymentSheet.PresentOptions) => {
-    setLoading(true);
-    const result = await presentPaymentSheetNative(options);
-    setLoading(false);
-    return result;
-  };
+  const presentPaymentSheet = useCallback(
+    async (options?: PaymentSheet.PresentOptions) => {
+      setLoading(true);
+      const result = await presentPaymentSheetNative(options);
+      setLoading(false);
+      return result;
+    },
+    [presentPaymentSheetNative]
+  );
 
-  const confirmPaymentSheetPayment = async () => {
+  const confirmPaymentSheetPayment = useCallback(async () => {
     setLoading(true);
     const result = await confirmPaymentSheetPaymentNative();
     setLoading(false);
     return result;
-  };
+  }, [confirmPaymentSheetPaymentNative]);
 
-  const resetPaymentSheetCustomer = async () => {
+  const resetPaymentSheetCustomer = useCallback(async () => {
     setLoading(true);
     const result = await resetPaymentSheetCustomerNative();
     setLoading(false);
     return result;
-  };
+  }, [resetPaymentSheetCustomerNative]);
 
   return {
     loading,

package/src/hooks/useStripe.tsx

@@ -1,28 +1,21 @@
 import type {
   PaymentMethod,
   PaymentIntent,
-  ApplePay,
   PaymentSheet,
   CreatePaymentMethodResult,
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   ConfirmPaymentResult,
   HandleNextActionResult,
+  HandleNextActionForSetupResult,
   ConfirmSetupIntentResult,
   CreateTokenForCVCUpdateResult,
-  ApplePayResult,
-  ApplePayError,
   StripeError,
   InitPaymentSheetResult,
   PresentPaymentSheetResult,
   ConfirmPaymentSheetPaymentResult,
   SetupIntent,
   CreateTokenResult,
-  PayWithGooglePayResult,
-  GooglePayInitResult,
-  GooglePay,
-  CreateGooglePayPaymentMethodResult,
-  OpenApplePaySetupResult,
   Token,
   VerifyMicrodepositsParams,
   VerifyMicrodepositsForPaymentResult,
@@ -35,30 +28,21 @@ import type {
   PlatformPay,
   PlatformPayError,
 } from '../types';
-import { useCallback, useEffect, useState } from 'react';
-import { isiOS } from '../helpers';
-import NativeStripeSdk from '../NativeStripeSdk';
+import { useCallback } from 'react';
 import {
   confirmPayment,
   createPaymentMethod,
   retrievePaymentIntent,
   retrieveSetupIntent,
-  confirmApplePayPayment,
   confirmSetupIntent,
   createTokenForCVCUpdate,
   handleNextAction,
+  handleNextActionForSetup,
   handleURLCallback,
-  presentApplePay,
-  updateApplePaySummaryItems,
   initPaymentSheet,
   presentPaymentSheet,
   confirmPaymentSheetPayment,
   createToken,
-  isGooglePaySupported,
-  initGooglePay,
-  createGooglePayPaymentMethod,
-  presentGooglePay,
-  openApplePaySetup,
   collectBankAccountForPayment,
   collectBankAccountForSetup,
   verifyMicrodepositsForPayment,
@@ -81,20 +65,6 @@ import {
  * useStripe hook
  */
 export function useStripe() {
-  const [isApplePaySupported, setApplePaySupported] = useState<boolean | null>(
-    null
-  );
-
-  useEffect(() => {
-    async function checkApplePaySupport() {
-      const isSupported =
-        isiOS && (await NativeStripeSdk.isApplePaySupported());
-      setApplePaySupported(isSupported);
-    }
-
-    checkApplePaySupport();
-  }, []);
-
   const _createPaymentMethod = useCallback(
     async (
       data: PaymentMethod.CreateParams,
@@ -137,41 +107,22 @@ export function useStripe() {
     []
   );
 
-  const _presentApplePay = useCallback(
-    async (params: ApplePay.PresentParams): Promise<ApplePayResult> => {
-      return presentApplePay(params);
-    },
-    []
-  );
-
-  const _updateApplePaySummaryItems = useCallback(
-    async (
-      summaryItems: ApplePay.CartSummaryItem[],
-      errorAddressFields: Array<{
-        field: ApplePay.AddressFields;
-        message?: string;
-      }> = []
-    ): Promise<{ error?: StripeError<ApplePayError> }> => {
-      return updateApplePaySummaryItems(summaryItems, errorAddressFields);
-    },
-    []
-  );
-
-  const _confirmApplePayPayment = useCallback(
+  const _handleNextAction = useCallback(
     async (
-      clientSecret: string
-    ): Promise<{ error?: StripeError<ApplePayError> }> => {
-      return confirmApplePayPayment(clientSecret);
+      paymentIntentClientSecret: string,
+      returnURL?: string
+    ): Promise<HandleNextActionResult> => {
+      return handleNextAction(paymentIntentClientSecret, returnURL);
     },
     []
   );
 
-  const _handleNextAction = useCallback(
+  const _handleNextActionForSetup = useCallback(
     async (
-      paymentIntentClientSecret: string,
+      setupIntentClientSecret: string,
       returnURL?: string
-    ): Promise<HandleNextActionResult> => {
-      return handleNextAction(paymentIntentClientSecret, returnURL);
+    ): Promise<HandleNextActionForSetupResult> => {
+      return handleNextActionForSetup(setupIntentClientSecret, returnURL);
     },
     []
   );
@@ -224,43 +175,6 @@ export function useStripe() {
     []
   );
 
-  const _isGooglePaySupported = useCallback(
-    async (params?: GooglePay.IsSupportedParams): Promise<boolean> => {
-      return isGooglePaySupported(params);
-    },
-    []
-  );
-
-  const _initGooglePay = useCallback(
-    async (params: GooglePay.InitParams): Promise<GooglePayInitResult> => {
-      return initGooglePay(params);
-    },
-    []
-  );
-
-  const _presentGooglePay = useCallback(
-    async (
-      params: GooglePay.PresentParams
-    ): Promise<PayWithGooglePayResult> => {
-      return presentGooglePay(params);
-    },
-    []
-  );
-
-  const _createGooglePayPaymentMethod = useCallback(
-    async (
-      params: GooglePay.CreatePaymentMethodParams
-    ): Promise<CreateGooglePayPaymentMethodResult> => {
-      return createGooglePayPaymentMethod(params);
-    },
-    []
-  );
-
-  const _openApplePaySetup =
-    useCallback(async (): Promise<OpenApplePaySetupResult> => {
-      return openApplePaySetup();
-    }, []);
-
   const _collectBankAccountForPayment = useCallback(
     async (
       clientSecret: string,
@@ -332,7 +246,7 @@ export function useStripe() {
 
   const _isPlatformPaySupported = useCallback(
     async (params?: {
-      googlePay?: GooglePay.IsSupportedParams;
+      googlePay?: PlatformPay.IsGooglePaySupportedParams;
     }): Promise<boolean> => {
       return isPlatformPaySupported(params);
     },
@@ -406,22 +320,14 @@ export function useStripe() {
     confirmPayment: _confirmPayment,
     createPaymentMethod: _createPaymentMethod,
     handleNextAction: _handleNextAction,
-    isApplePaySupported: isApplePaySupported,
-    presentApplePay: _presentApplePay,
-    confirmApplePayPayment: _confirmApplePayPayment,
+    handleNextActionForSetup: _handleNextActionForSetup,
     confirmSetupIntent: _confirmSetupIntent,
     createTokenForCVCUpdate: _createTokenForCVCUpdate,
-    updateApplePaySummaryItems: _updateApplePaySummaryItems,
     handleURLCallback: _handleURLCallback,
     confirmPaymentSheetPayment: _confirmPaymentSheetPayment,
     presentPaymentSheet: _presentPaymentSheet,
     initPaymentSheet: _initPaymentSheet,
     createToken: _createToken,
-    isGooglePaySupported: _isGooglePaySupported,
-    initGooglePay: _initGooglePay,
-    presentGooglePay: _presentGooglePay,
-    createGooglePayPaymentMethod: _createGooglePayPaymentMethod,
-    openApplePaySetup: _openApplePaySetup,
     collectBankAccountForPayment: _collectBankAccountForPayment,
     collectBankAccountForSetup: _collectBankAccountForSetup,
     verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,