@stripe/stripe-react-native 0.28.0 → 0.29.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,14 @@ import {
   CreatePaymentMethodResult,
   CreateTokenForCVCUpdateResult,
   CreateTokenResult,
-  GooglePayInitResult,
   HandleNextActionResult,
   InitPaymentSheetResult,
   PaymentMethod,
   PaymentSheet,
-  PayWithGooglePayResult,
   PresentPaymentSheetResult,
   RetrievePaymentIntentResult,
   RetrieveSetupIntentResult,
   StripeError,
-  GooglePay,
-  CreateGooglePayPaymentMethodResult,
-  OpenApplePaySetupResult,
   Token,
   VerifyMicrodepositsParams,
   VerifyMicrodepositsForPaymentResult,
@@ -39,10 +31,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,94 +170,6 @@ 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,
-      },
-    };
-  }
-
-  try {
-    const { paymentMethod, error } = await NativeStripeSdk.presentApplePay(
-      params
-    );
-    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,
-      },
-    };
-  }
-  try {
-    await NativeStripeSdk.confirmApplePayPayment(clientSecret);
-    return {};
-  } catch (error: any) {
-    return {
-      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
  *
@@ -345,8 +251,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 +317,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 +423,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/useStripe.tsx

@@ -1,7 +1,6 @@
 import type {
   PaymentMethod,
   PaymentIntent,
-  ApplePay,
   PaymentSheet,
   CreatePaymentMethodResult,
   RetrievePaymentIntentResult,
@@ -10,19 +9,12 @@ import type {
   HandleNextActionResult,
   ConfirmSetupIntentResult,
   CreateTokenForCVCUpdateResult,
-  ApplePayResult,
-  ApplePayError,
   StripeError,
   InitPaymentSheetResult,
   PresentPaymentSheetResult,
   ConfirmPaymentSheetPaymentResult,
   SetupIntent,
   CreateTokenResult,
-  PayWithGooglePayResult,
-  GooglePayInitResult,
-  GooglePay,
-  CreateGooglePayPaymentMethodResult,
-  OpenApplePaySetupResult,
   Token,
   VerifyMicrodepositsParams,
   VerifyMicrodepositsForPaymentResult,
@@ -35,30 +27,20 @@ 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,
   handleURLCallback,
-  presentApplePay,
-  updateApplePaySummaryItems,
   initPaymentSheet,
   presentPaymentSheet,
   confirmPaymentSheetPayment,
   createToken,
-  isGooglePaySupported,
-  initGooglePay,
-  createGooglePayPaymentMethod,
-  presentGooglePay,
-  openApplePaySetup,
   collectBankAccountForPayment,
   collectBankAccountForSetup,
   verifyMicrodepositsForPayment,
@@ -81,20 +63,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,35 +105,6 @@ 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(
-    async (
-      clientSecret: string
-    ): Promise<{ error?: StripeError<ApplePayError> }> => {
-      return confirmApplePayPayment(clientSecret);
-    },
-    []
-  );
-
   const _handleNextAction = useCallback(
     async (
       paymentIntentClientSecret: string,
@@ -224,43 +163,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 +234,7 @@ export function useStripe() {
 
   const _isPlatformPaySupported = useCallback(
     async (params?: {
-      googlePay?: GooglePay.IsSupportedParams;
+      googlePay?: PlatformPay.IsGooglePaySupportedParams;
     }): Promise<boolean> => {
       return isPlatformPaySupported(params);
     },
@@ -406,22 +308,13 @@ export function useStripe() {
     confirmPayment: _confirmPayment,
     createPaymentMethod: _createPaymentMethod,
     handleNextAction: _handleNextAction,
-    isApplePaySupported: isApplePaySupported,
-    presentApplePay: _presentApplePay,
-    confirmApplePayPayment: _confirmApplePayPayment,
     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,

package/src/index.tsx

@@ -3,10 +3,7 @@ export { useConfirmPayment } from './hooks/useConfirmPayment';
 export { useConfirmSetupIntent } from './hooks/useConfirmSetupIntent';
 export { useStripe } from './hooks/useStripe';
 export { usePlatformPay } from './hooks/usePlatformPay';
-export { useApplePay } from './hooks/useApplePay';
-export type { Props as UseApplePayProps } from './hooks/useApplePay';
 export { usePaymentSheet } from './hooks/usePaymentSheet';
-export { useGooglePay } from './hooks/useGooglePay';
 export { useFinancialConnectionsSheet } from './hooks/useFinancialConnectionsSheet';
 
 //components
@@ -16,14 +13,10 @@ export { CardField } from './components/CardField';
 export type { Props as CardFieldProps } from './components/CardField';
 export { CardForm } from './components/CardForm';
 export type { Props as CardFormProps } from './components/CardForm';
-export { ApplePayButton } from './components/ApplePayButton';
-export type { Props as ApplePayButtonProps } from './components/ApplePayButton';
 export { AuBECSDebitForm } from './components/AuBECSDebitForm';
 export type { Props as AuBECSDebitFormProps } from './components/AuBECSDebitForm';
 export { StripeContainer } from './components/StripeContainer';
 export type { Props as StripeContainerProps } from './components/StripeContainer';
-export { GooglePayButton } from './components/GooglePayButton';
-export type { Props as GooglePayButtonProps } from './components/GooglePayButton';
 export { AddToWalletButton } from './components/AddToWalletButton';
 export type { Props as AddToWalletButtonProps } from './components/AddToWalletButton';
 export { AddressSheet } from './components/AddressSheet';

package/src/types/ApplePay.ts

@@ -1,64 +1,3 @@
-export type ContactFieldsType =
-  | 'emailAddress'
-  | 'name'
-  | 'phoneNumber'
-  | 'phoneticName'
-  | 'postalAddress';
-
-export type AddressFields =
-  | 'street'
-  | 'city'
-  | 'subAdministrativeArea'
-  | 'state'
-  | 'postalCode'
-  | 'country'
-  | 'countryCode'
-  | 'subLocality';
-
-export interface ShippingMethod {
-  /** A short, localized description. */
-  label: string;
-  /** The cost associated with this shipping option. */
-  amount: string;
-  /** When creating items for estimates or charges whose final value is not yet known, set this to true. */
-  isPending?: boolean;
-  /** A unique identifier for the shipping method. */
-  identifier: string;
-  /** A user-readable description of the shipping method. For example “Ships in 24 hours.” Don't repeat the content of the 'label' property. */
-  detail?: string;
-  /** The unix timestamp of the start date of the expected range of delivery or shipping dates for a package, or the time range when an item is available for pickup. Measured in seconds. */
-  startDate?: number;
-  /** The unix timestamp of the end date of the expected range of delivery or shipping dates for a package, or the time range when an item is available for pickup. Measured in seconds. */
-  endDate?: number;
-}
-
-interface PostalAddress {
-  city?: string;
-  country?: string;
-  postalCode?: string;
-  state?: string;
-  street?: string;
-  isoCountryCode?: string;
-  subAdministrativeArea?: string;
-  subLocality?: string;
-}
-
-interface ContactName {
-  familyName?: string;
-  namePrefix?: string;
-  nameSuffix?: string;
-  givenName?: string;
-  middleName?: string;
-  nickname?: string;
-}
-
-export interface ShippingContact {
-  emailAddress?: string;
-  name: ContactName;
-  phoneNumber?: string;
-  postalAddress: PostalAddress;
-}
-
 export type CartSummaryItem =
   | DeferredCartSummaryItem
   | ImmediateCartSummaryItem
@@ -98,13 +37,3 @@ export type RecurringCartSummaryItem = {
   label: string;
   amount: string;
 };
-
-export interface PresentParams {
-  cartItems: CartSummaryItem[];
-  country: string;
-  currency: string;
-  requiredShippingAddressFields?: ContactFieldsType[];
-  requiredBillingContactFields?: ContactFieldsType[];
-  shippingMethods?: ShippingMethod[];
-  jcbEnabled?: boolean;
-}

package/src/types/PaymentIntent.ts

@@ -20,13 +20,15 @@ export interface Result {
   /** @deprecated Use paymentMethod.id instead. */
   paymentMethodId: string;
   paymentMethod: PaymentMethodResult | null;
-  captureMethod: 'Automatic' | 'Manual';
-  confirmationMethod: 'Automatic' | 'Manual';
+  captureMethod: CaptureMethod;
+  confirmationMethod: CaptureMethod;
   lastPaymentError: LastPaymentError | null;
   shipping: ShippingDetails | null;
   nextAction: NextAction | null;
 }
 
+export type CaptureMethod = 'Automatic' | 'Manual';
+
 export type ConfirmParams =
   | CardParams
   | IdealParams