@stripe/stripe-react-native 0.22.1 → 0.23.1

package/lib/typescript/src/types/PaymentSheet.d.ts

@@ -18,7 +18,7 @@ export declare type SetupParams = ClientSecretParams & {
     style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
     /** A URL that redirects back to your app that PaymentSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2 */
     returnURL?: string;
-    /** PaymentSheet pre-populates the billing fields with the values provided. */
+    /** PaymentSheet pre-populates the billing fields that are displayed in the Payment Sheet (only country and postal code, as of this version) with the values provided. */
     defaultBillingDetails?: BillingDetails;
     /**
      * The shipping information for the customer. If set, PaymentSheet will pre-populate the form fields with the values provided.

package/lib/typescript/src/types/PlatformPay.d.ts

@@ -262,10 +262,15 @@ export declare type ShippingContact = ApplePayShippingContact;
 export declare type IsGooglePaySupportedParams = IsSupportedParams;
 export declare type PaymentMethodResult = {
     paymentMethod: PaymentMethod;
-    token: Token;
     error?: undefined;
 } | {
     paymentMethod?: undefined;
+    error: StripeError<PlatformPayError>;
+};
+export declare type TokenResult = {
+    token: Token;
+    error?: undefined;
+} | {
     token?: undefined;
     error: StripeError<PlatformPayError>;
 };

package/lib/typescript/src/types/PushProvisioning.d.ts

@@ -35,7 +35,7 @@ export declare type CanAddCardToWalletParams = {
     primaryAccountIdentifier: string | null;
     /** Last 4 digits of the card number. */
     cardLastFour: string;
-    /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If true, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
+    /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If false, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
     testEnv?: boolean;
     /** iOS only. Set this to `true` if: your user has an Apple Watch device currently paired, and you want to check that device for the presence of the specified card. */
     hasPairedAppleWatch?: boolean;

package/lib/typescript/src/types/SetupIntent.d.ts

@@ -9,7 +9,9 @@ export interface Result {
     /** The UNIX timestamp (in milliseconds) of the date this Setup Intent was created. */
     created: string | null;
     livemode: boolean;
+    /** @deprecated Use paymentMethod.id instead. */
     paymentMethodId: string | null;
+    paymentMethod: PaymentMethod.Result | null;
     status: Status;
     paymentMethodTypes: Type[];
     usage: FutureUsage;

package/lib/typescript/src/types/index.d.ts

@@ -17,7 +17,7 @@ import * as PlatformPay from './PlatformPay';
 export { ApplePay, PaymentIntent, PaymentMethod, PaymentSheet, SetupIntent, ThreeDSecure, GooglePay, ApplePayButtonComponent, GooglePayButtonComponent, AuBECSDebitFormComponent, CardFieldInput, CardFormView, Token, FinancialConnections, PlatformPay, };
 export * from './PushProvisioning';
 export * from './Errors';
-export { Address, BillingDetails, AddressDetails } from './Common';
+export type { Address, BillingDetails, AddressDetails } from './Common';
 /**
  * @ignore
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.22.1",
+  "version": "0.23.1",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",
@@ -12,7 +12,7 @@
     "test": "jest",
     "typescript": "tsc --noEmit",
     "lint": "eslint \"**/*.{js,ts,tsx}\" --ignore-pattern \"docs/api-reference/*\" --ignore-path .gitignore",
-    "prepare": "bob build",
+    "prepare": "bob build && husky install",
     "release": "./scripts/publish",
     "example": "yarn --cwd example",
     "pods": "cd example && npx pod-install --quiet",

package/src/NativeStripeSdk.tsx

@@ -111,8 +111,9 @@ type NativeStripeSdkType = {
     googlePay?: GooglePay.IsSupportedParams;
   }): Promise<boolean>;
   createPlatformPayPaymentMethod(
-    params: PlatformPay.PaymentMethodParams
-  ): Promise<PlatformPay.PaymentMethodResult>;
+    params: PlatformPay.PaymentMethodParams,
+    usesDeprecatedTokenFlow: boolean
+  ): Promise<PlatformPay.PaymentMethodResult | PlatformPay.TokenResult>;
   dismissPlatformPay(): Promise<boolean>;
   updatePlatformPaySheet(
     summaryItems: Array<ApplePay.CartSummaryItem>,

package/src/components/AddToWalletButton.tsx

@@ -27,7 +27,7 @@ export interface Props extends AccessibilityProps {
   /** The image asset to use as the Google Pay button. Downloadable from https://developers.google.com/pay/issuers/apis/push-provisioning/android/downloads/flutter/googlepay_flutter_buttons.zip */
   androidAssetSource: ImageSourcePropType;
   testID?: string;
-  /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If true, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
+  /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If false, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
   testEnv?: boolean;
   /** Details of the Issued Card you'd like added to the device's wallet */
   cardDetails: {

package/src/functions.ts

@@ -810,16 +810,19 @@ export const dismissPlatformPay = async (): Promise<boolean> => {
 };
 
 /**
- * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [PaymentMethod](https://stripe.com/docs/api/payment_methods) and [token](https://stripe.com/docs/api/tokens).
+ * Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [PaymentMethod](https://stripe.com/docs/api/payment_methods).
  * @param params an object describing the Apple Pay and Google Pay configurations.
- * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentMethod` and `token` fields.
+ * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with a `paymentMethod` field.
  */
 export const createPlatformPayPaymentMethod = async (
   params: PlatformPay.PaymentMethodParams
 ): Promise<PlatformPay.PaymentMethodResult> => {
   try {
-    const { error, paymentMethod, token } =
-      await NativeStripeSdk.createPlatformPayPaymentMethod(params);
+    const { error, paymentMethod } =
+      (await NativeStripeSdk.createPlatformPayPaymentMethod(
+        params,
+        false
+      )) as PlatformPay.PaymentMethodResult;
     if (error) {
       return {
         error,
@@ -827,6 +830,34 @@ export const createPlatformPayPaymentMethod = async (
     }
     return {
       paymentMethod: paymentMethod!,
+    };
+  } catch (error: any) {
+    return {
+      error,
+    };
+  }
+};
+
+/**
+ * @deprecated The Tokens API is deprecated, you should use Payment Methods and `createPlatformPayPaymentMethod` instead.  Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [token](https://stripe.com/docs/api/tokens).
+ * @param params an object describing the Apple Pay and Google Pay configurations.
+ * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with a `token` field.
+ */
+export const createPlatformPayToken = async (
+  params: PlatformPay.PaymentMethodParams
+): Promise<PlatformPay.TokenResult> => {
+  try {
+    const { error, token } =
+      (await NativeStripeSdk.createPlatformPayPaymentMethod(
+        params,
+        true
+      )) as PlatformPay.TokenResult;
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
       token: token!,
     };
   } catch (error: any) {

package/src/hooks/useApplePay.tsx

@@ -3,8 +3,6 @@ import { useCallback, useEffect, useState } from 'react';
 import { useStripe } from './useStripe';
 import { NativeEventEmitter, NativeModules } from 'react-native';
 
-const eventEmitter = new NativeEventEmitter(NativeModules.StripeSdk);
-
 export interface Props {
   /**
    *
@@ -105,6 +103,7 @@ export function useApplePay({
   );
 
   useEffect(() => {
+    const eventEmitter = new NativeEventEmitter(NativeModules.StripeSdk);
     const didSetShippingMethodListener = eventEmitter.addListener(
       SET_SHIPPING_METHOD_CALLBACK_NAME,
       onDidSetShippingMethod

package/src/hooks/usePlatformPay.tsx

@@ -15,6 +15,7 @@ export function usePlatformPay() {
     confirmPlatformPaySetupIntent,
     confirmPlatformPayPayment,
     createPlatformPayPaymentMethod,
+    createPlatformPayToken,
     dismissPlatformPay,
     updatePlatformPaySheet,
     canAddCardToWallet,
@@ -70,6 +71,18 @@ export function usePlatformPay() {
     [createPlatformPayPaymentMethod]
   );
 
+  const _createPlatformPayToken = useCallback(
+    async (params: PlatformPay.PaymentMethodParams) => {
+      setLoading(true);
+
+      const result = await createPlatformPayToken(params);
+      setLoading(false);
+
+      return result;
+    },
+    [createPlatformPayToken]
+  );
+
   const _dismissPlatformPay = useCallback(async () => {
     setLoading(true);
 
@@ -143,6 +156,12 @@ export function usePlatformPay() {
      * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with both `paymentMethod` and `token` fields.
      */
     createPlatformPayPaymentMethod: _createPlatformPayPaymentMethod,
+    /**
+     * @deprecated The Tokens API is deprecated, you should use Payment Methods and `createPlatformPayPaymentMethod` instead.  Launches the relevant native wallet sheet (Apple Pay on iOS, Google Pay on Android) in order to create a Stripe [token](https://stripe.com/docs/api/tokens).
+     * @param params an object describing the Apple Pay and Google Pay configurations.
+     * @returns An object with an error field if something went wrong or the flow was cancelled, otherwise an object with a `token` field.
+     */
+    createPlatformPayToken: _createPlatformPayToken,
     /**
      * Dismiss the Apple Pay sheet if it is open. iOS only, this is a no-op on Android.
      * @returns A boolean indicating whether or not the sheet was successfully closed. Will return false if the Apple Pay sheet was not open.

package/src/hooks/useStripe.tsx

@@ -72,6 +72,7 @@ import {
   confirmPlatformPayPayment,
   dismissPlatformPay,
   createPlatformPayPaymentMethod,
+  createPlatformPayToken,
   updatePlatformPaySheet,
   openPlatformPaySetup,
 } from '../functions';
@@ -367,6 +368,15 @@ export function useStripe() {
     []
   );
 
+  const _createPlatformPayToken = useCallback(
+    async (
+      params: PlatformPay.PaymentMethodParams
+    ): Promise<PlatformPay.TokenResult> => {
+      return createPlatformPayToken(params);
+    },
+    []
+  );
+
   const _updatePlatformPaySheet = useCallback(
     async (params: {
       applePay: {
@@ -426,6 +436,7 @@ export function useStripe() {
     confirmPlatformPayPayment: _confirmPlatformPayPayment,
     dismissPlatformPay: _dismissPlatformPay,
     createPlatformPayPaymentMethod: _createPlatformPayPaymentMethod,
+    createPlatformPayToken: _createPlatformPayToken,
     updatePlatformPaySheet: _updatePlatformPaySheet,
     openPlatformPaySetup: _openPlatformPaySetup,
   };

package/src/index.tsx

@@ -3,47 +3,33 @@ export { useConfirmPayment } from './hooks/useConfirmPayment';
 export { useConfirmSetupIntent } from './hooks/useConfirmSetupIntent';
 export { useStripe } from './hooks/useStripe';
 export { usePlatformPay } from './hooks/usePlatformPay';
-export { useApplePay, Props as UseApplePayProps } from './hooks/useApplePay';
+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
-export {
-  initStripe,
-  StripeProvider,
-  Props as StripeProviderProps,
-} from './components/StripeProvider';
-export { CardField, Props as CardFieldProps } from './components/CardField';
-export { CardForm, Props as CardFormProps } from './components/CardForm';
-export {
-  ApplePayButton,
-  Props as ApplePayButtonProps,
-} from './components/ApplePayButton';
-export {
-  AuBECSDebitForm,
-  Props as AuBECSDebitFormProps,
-} from './components/AuBECSDebitForm';
-export {
-  StripeContainer,
-  Props as StripeContainerProps,
-} from './components/StripeContainer';
-export {
-  GooglePayButton,
-  Props as GooglePayButtonProps,
-} from './components/GooglePayButton';
-export {
-  AddToWalletButton,
-  Props as AddToWalletButtonProps,
-} from './components/AddToWalletButton';
-export {
-  AddressSheet,
-  Props as AddressSheetProps,
-} from './components/AddressSheet';
-export {
-  PlatformPayButton,
-  Props as PlatformPayButtonProps,
-} from './components/PlatformPayButton';
+export { initStripe, StripeProvider } from './components/StripeProvider';
+export type { Props as StripeProviderProps } from './components/StripeProvider';
+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';
+export type { Props as AddressSheetProps } from './components/AddressSheet';
+export { PlatformPayButton } from './components/PlatformPayButton';
+export type { Props as PlatformPayButtonProps } from './components/PlatformPayButton';
 
 export * from './functions';
 

package/src/types/PaymentIntent.ts

@@ -16,7 +16,9 @@ export interface Result {
   canceledAt: string | null;
   clientSecret: string;
   livemode: boolean;
+  /** @deprecated Use paymentMethod.id instead. */
   paymentMethodId: string;
+  paymentMethod: PaymentMethodResult | null;
   captureMethod: 'Automatic' | 'Manual';
   confirmationMethod: 'Automatic' | 'Manual';
   lastPaymentError: LastPaymentError | null;

package/src/types/PaymentMethod.ts

@@ -146,6 +146,7 @@ export type KlarnaParams = {
     billingDetails: Pick<Required<BillingDetails>, 'email'> & {
       address: Pick<Required<Address>, 'country'>;
     } & BillingDetails;
+    shippingDetails?: ShippingDetails;
   };
 };
 

package/src/types/PaymentSheet.ts

@@ -19,7 +19,7 @@ export type SetupParams = ClientSecretParams & {
   style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
   /** A URL that redirects back to your app that PaymentSheet can use to auto-dismiss web views used for additional authentication, e.g. 3DS2 */
   returnURL?: string;
-  /** PaymentSheet pre-populates the billing fields with the values provided. */
+  /** PaymentSheet pre-populates the billing fields that are displayed in the Payment Sheet (only country and postal code, as of this version) with the values provided. */
   defaultBillingDetails?: BillingDetails;
   /**
    * The shipping information for the customer. If set, PaymentSheet will pre-populate the form fields with the values provided.

package/src/types/PlatformPay.ts

@@ -296,11 +296,19 @@ export type IsGooglePaySupportedParams = IsSupportedParams;
 export type PaymentMethodResult =
   | {
       paymentMethod: PaymentMethod;
-      token: Token;
       error?: undefined;
     }
   | {
       paymentMethod?: undefined;
+      error: StripeError<PlatformPayError>;
+    };
+
+export type TokenResult =
+  | {
+      token: Token;
+      error?: undefined;
+    }
+  | {
       token?: undefined;
       error: StripeError<PlatformPayError>;
     };

package/src/types/PushProvisioning.ts

@@ -41,7 +41,7 @@ export type CanAddCardToWalletParams = {
   primaryAccountIdentifier: string | null;
   /** Last 4 digits of the card number. */
   cardLastFour: string;
-  /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If true, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
+  /** iOS only. Set this to `true` until shipping through TestFlight || App Store. If false, you must be using live cards, and have the proper iOS entitlement set up. See https://stripe.com/docs/issuing/cards/digital-wallets?platform=react-native#requesting-access-for-ios */
   testEnv?: boolean;
   /** iOS only. Set this to `true` if: your user has an Apple Watch device currently paired, and you want to check that device for the presence of the specified card. */
   hasPairedAppleWatch?: boolean;

package/src/types/SetupIntent.ts

@@ -9,7 +9,9 @@ export interface Result {
   /** The UNIX timestamp (in milliseconds) of the date this Setup Intent was created. */
   created: string | null;
   livemode: boolean;
+  /** @deprecated Use paymentMethod.id instead. */
   paymentMethodId: string | null;
+  paymentMethod: PaymentMethod.Result | null;
   status: Status;
   paymentMethodTypes: Type[];
   usage: FutureUsage;

package/src/types/index.ts

@@ -49,7 +49,7 @@ export {
 
 export * from './PushProvisioning';
 export * from './Errors';
-export { Address, BillingDetails, AddressDetails } from './Common';
+export type { Address, BillingDetails, AddressDetails } from './Common';
 
 /**
  * @ignore