@stripe/stripe-react-native 0.19.0 → 0.20.0

package/lib/typescript/src/hooks/usePaymentSheet.d.ts

@@ -7,4 +7,10 @@ export declare function usePaymentSheet(): {
     initPaymentSheet: (params: PaymentSheet.SetupParams) => Promise<import("../types").InitPaymentSheetResult>;
     presentPaymentSheet: () => Promise<import("../types").PresentPaymentSheetResult>;
     confirmPaymentSheetPayment: () => Promise<import("../types").ConfirmPaymentSheetPaymentResult>;
+    /**
+     * You must call this method when the user logs out from your app. This will ensure that
+     * any persisted authentication state in the PaymentSheet, such as authentication cookies,
+     * is also cleared during logout.
+     */
+    resetPaymentSheetCustomer: () => Promise<null>;
 };

package/lib/typescript/src/hooks/useStripe.d.ts

@@ -38,4 +38,10 @@ export declare function useStripe(): {
     canAddCardToWallet: (params: CanAddCardToWalletParams) => Promise<CanAddCardToWalletResult>;
     collectBankAccountToken: (clientSecret: string) => Promise<FinancialConnections.TokenResult>;
     collectFinancialConnectionsAccounts: (clientSecret: string) => Promise<FinancialConnections.SessionResult>;
+    /**
+     * You must call this method when the user logs out from your app. This will ensure that
+     * any persisted authentication state in the PaymentSheet, such as authentication cookies,
+     * is also cleared during logout.
+     */
+    resetPaymentSheetCustomer: () => Promise<null>;
 };

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

@@ -69,8 +69,8 @@ export declare type Account = {
 export declare type AccountStatus = 'active' | 'inactive' | 'disconnected';
 export declare type Category = 'cash' | 'credit' | 'investment' | 'other';
 export declare type PaymentMethodType = 'us_bank_account' | 'link';
-export declare type Subcategory = 'checking' | 'credit_card' | 'line_of_credit' | 'mortgage' | 'other' | 'savings';
-export declare type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions' | 'account_numbers';
+export declare type Subcategory = 'checking' | 'creditCard' | 'lineOfCredit' | 'mortgage' | 'other' | 'savings';
+export declare type Permission = 'balances' | 'ownership' | 'paymentMethod' | 'transactions' | 'accountNumbers';
 export declare type Balance = {
     /** The UNIX timestamp (in milliseconds) of time that the external institution calculated this balance. */
     asOf: number;

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

@@ -181,6 +181,8 @@ export interface CardResult {
     fingerprint?: string;
     funding?: string;
     last4?: string;
+    preferredNetwork?: string;
+    availableNetworks?: Array<string>;
 }
 export interface FpxResult {
     bank?: string;

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

@@ -3,18 +3,35 @@ import type { CartSummaryItem } from './ApplePay';
 export declare type SetupParams = ClientSecretParams & {
     /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
     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. */
     customerEphemeralKeySecret?: string;
+    /** When set to true, separates out the payment method selection & confirmation steps.
+     * If true, you must call `confirmPaymentSheetPayment` on your own. Defaults to false. */
     customFlow?: boolean;
     /** iOS only. Enable Apple Pay in the Payment Sheet by passing an ApplePayParams object.  */
     applePay?: ApplePayParams;
     /** Android only. Enable Google Pay in the Payment Sheet by passing a GooglePayParams object.  */
     googlePay?: GooglePayParams;
+    /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. */
     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. */
     defaultBillingDetails?: BillingDetails;
+    /** If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.
+     *
+     * Some payment methods can’t guarantee you will receive funds from your customer at the end of the checkout
+     * because they take time to settle (eg. most bank debits, like SEPA or ACH) or require customer action to
+     * complete (e.g. OXXO, Konbini, Boleto). If this is set to true, make sure your integration listens to webhooks
+     * for notifications on whether a payment has succeeded or not.
+     */
     allowsDelayedPaymentMethods?: boolean;
+    /** Customizes the appearance of PaymentSheet */
     appearance?: AppearanceParams;
+    /** The label to use for the primary button. If not set, Payment Sheet will display suitable default labels for payment and setup intents. */
+    primaryButtonLabel?: string;
 };
 export declare type ClientSecretParams = {
     paymentIntentClientSecret: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",

package/src/NativeStripeSdk.tsx

@@ -105,6 +105,7 @@ type NativeStripeSdkType = {
   collectFinancialConnectionsAccounts(
     clientSecret: string
   ): Promise<FinancialConnections.SessionResult>;
+  resetPaymentSheetCustomer(): Promise<null>;
 };
 
 const { StripeSdk } = NativeModules;

package/src/functions.ts

@@ -455,6 +455,15 @@ export const confirmPaymentSheetPayment =
     }
   };
 
+/**
+ * You must call this method when the user logs out from your app. This will ensure that
+ * any persisted authentication state in the PaymentSheet, such as authentication cookies,
+ * is also cleared during logout.
+ */
+export const resetPaymentSheetCustomer = async (): Promise<null> => {
+  return await NativeStripeSdk.resetPaymentSheetCustomer();
+};
+
 export const isGooglePaySupported = async (
   params?: GooglePay.IsSupportedParams
 ): Promise<boolean> => {

package/src/hooks/usePaymentSheet.tsx

@@ -10,6 +10,7 @@ export function usePaymentSheet() {
     initPaymentSheet: initPaymentSheetNative,
     presentPaymentSheet: presentPaymentSheetNative,
     confirmPaymentSheetPayment: confirmPaymentSheetPaymentNative,
+    resetPaymentSheetCustomer: resetPaymentSheetCustomerNative,
   } = useStripe();
   const [loading, setLoading] = useState(false);
 
@@ -34,10 +35,23 @@ export function usePaymentSheet() {
     return result;
   };
 
+  const resetPaymentSheetCustomer = async () => {
+    setLoading(true);
+    const result = await resetPaymentSheetCustomerNative();
+    setLoading(false);
+    return result;
+  };
+
   return {
     loading,
     initPaymentSheet,
     presentPaymentSheet,
     confirmPaymentSheetPayment,
+    /**
+     * You must call this method when the user logs out from your app. This will ensure that
+     * any persisted authentication state in the PaymentSheet, such as authentication cookies,
+     * is also cleared during logout.
+     */
+    resetPaymentSheetCustomer,
   };
 }

package/src/hooks/useStripe.tsx

@@ -64,6 +64,7 @@ import {
   canAddCardToWallet,
   collectBankAccountToken,
   collectFinancialConnectionsAccounts,
+  resetPaymentSheetCustomer,
 } from '../functions';
 
 /**
@@ -311,6 +312,10 @@ export function useStripe() {
     []
   );
 
+  const _resetPaymentSheetCustomer = useCallback(async (): Promise<null> => {
+    return resetPaymentSheetCustomer();
+  }, []);
+
   return {
     retrievePaymentIntent: _retrievePaymentIntent,
     retrieveSetupIntent: _retrieveSetupIntent,
@@ -340,5 +345,11 @@ export function useStripe() {
     canAddCardToWallet: _canAddCardToWallet,
     collectBankAccountToken: _collectBankAccountToken,
     collectFinancialConnectionsAccounts: _collectFinancialConnectionsAccounts,
+    /**
+     * You must call this method when the user logs out from your app. This will ensure that
+     * any persisted authentication state in the PaymentSheet, such as authentication cookies,
+     * is also cleared during logout.
+     */
+    resetPaymentSheetCustomer: _resetPaymentSheetCustomer,
   };
 }

package/src/types/FinancialConnections.ts

@@ -84,8 +84,8 @@ export type PaymentMethodType = 'us_bank_account' | 'link';
 
 export type Subcategory =
   | 'checking'
-  | 'credit_card'
-  | 'line_of_credit'
+  | 'creditCard'
+  | 'lineOfCredit'
   | 'mortgage'
   | 'other'
   | 'savings';
@@ -93,9 +93,9 @@ export type Subcategory =
 export type Permission =
   | 'balances'
   | 'ownership'
-  | 'payment_method'
+  | 'paymentMethod'
   | 'transactions'
-  | 'account_numbers';
+  | 'accountNumbers';
 
 export type Balance = {
   /** The UNIX timestamp (in milliseconds) of time that the external institution calculated this balance. */

package/src/types/PaymentMethod.ts

@@ -229,6 +229,8 @@ export interface CardResult {
   fingerprint?: string;
   funding?: string;
   last4?: string;
+  preferredNetwork?: string;
+  availableNetworks?: Array<string>;
 }
 
 export interface FpxResult {

package/src/types/PaymentSheet.ts

@@ -4,18 +4,35 @@ import type { CartSummaryItem } from './ApplePay';
 export type SetupParams = ClientSecretParams & {
   /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
   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. */
   customerEphemeralKeySecret?: string;
+  /** When set to true, separates out the payment method selection & confirmation steps.
+   * If true, you must call `confirmPaymentSheetPayment` on your own. Defaults to false. */
   customFlow?: boolean;
   /** iOS only. Enable Apple Pay in the Payment Sheet by passing an ApplePayParams object.  */
   applePay?: ApplePayParams;
   /** Android only. Enable Google Pay in the Payment Sheet by passing a GooglePayParams object.  */
   googlePay?: GooglePayParams;
+  /** The color styling to use for PaymentSheet UI. Defaults to 'automatic'. */
   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. */
   defaultBillingDetails?: BillingDetails;
+  /** If true, allows payment methods that do not move money at the end of the checkout. Defaults to false.
+   *
+   * Some payment methods can’t guarantee you will receive funds from your customer at the end of the checkout
+   * because they take time to settle (eg. most bank debits, like SEPA or ACH) or require customer action to
+   * complete (e.g. OXXO, Konbini, Boleto). If this is set to true, make sure your integration listens to webhooks
+   * for notifications on whether a payment has succeeded or not.
+   */
   allowsDelayedPaymentMethods?: boolean;
+  /** Customizes the appearance of PaymentSheet */
   appearance?: AppearanceParams;
+  /** The label to use for the primary button. If not set, Payment Sheet will display suitable default labels for payment and setup intents. */
+  primaryButtonLabel?: string;
 };
 
 export type ClientSecretParams =
@@ -35,6 +52,8 @@ export type ApplePayParams = {
    * An array of CartSummaryItem item objects that summarize the amount of the payment. If you're using a SetupIntent
    * for a recurring payment, you should set this to display the amount you intend to charge. */
   paymentSummaryItems?: CartSummaryItem[];
+  // TODO: Uncomment when https://github.com/stripe/stripe-react-native/pull/1164 lands
+  // buttonType: ButtonType
 };
 
 export type GooglePayParams = {

package/stripe-react-native.podspec

@@ -1,7 +1,7 @@
 require 'json'
 
 package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
-stripe_version = '~> 22.8.1'
+stripe_version = '~> 23.1.0'
 
 Pod::Spec.new do |s|
   s.name         = 'stripe-react-native'
@@ -11,7 +11,7 @@ Pod::Spec.new do |s|
   s.license      = package['license']
   s.authors      = package['author']
 
-  s.platforms    = { ios: '12.0' }
+  s.platforms    = { ios: '13.0' }
   s.source       = { git: 'https://github.com/stripe/stripe-react-native.git', tag: s.version.to_s }
 
   s.source_files = 'ios/**/*.{h,m,mm,swift}'
@@ -23,5 +23,9 @@ Pod::Spec.new do |s|
 
   s.dependency 'React-Core'
   s.dependency 'Stripe', stripe_version
+  s.dependency 'StripePaymentSheet', stripe_version
+  s.dependency 'StripePayments', stripe_version
+  s.dependency 'StripePaymentsUI', stripe_version
+  s.dependency 'StripeApplePay', stripe_version
   s.dependency 'StripeFinancialConnections', stripe_version
 end

package/android/.gradle/buildOutputCleanup/cache.properties

@@ -1,2 +0,0 @@
-#Tue Jun 21 15:53:42 EDT 2022
-gradle.version=7.1

package/android/.idea/gradle.xml

@@ -1,13 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="GradleMigrationSettings" migrationVersion="1" />
-  <component name="GradleSettings">
-    <option name="linkedExternalProjectsSettings">
-      <GradleProjectSettings>
-        <option name="testRunner" value="GRADLE" />
-        <option name="distributionType" value="DEFAULT_WRAPPED" />
-        <option name="externalProjectPath" value="$PROJECT_DIR$" />
-      </GradleProjectSettings>
-    </option>
-  </component>
-</project>

package/android/.idea/misc.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="Android Studio default JDK" project-jdk-type="JavaSDK">
-    <output url="file://$PROJECT_DIR$/build/classes" />
-  </component>
-  <component name="ProjectType">
-    <option name="id" value="Android" />
-  </component>
-</project>

package/android/.idea/modules/android.iml

@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module external.linked.project.id=":" external.linked.project.path="$MODULE_DIR$/../.." external.root.project.path="$MODULE_DIR$/../.." external.system.id="GRADLE" type="JAVA_MODULE" version="4">
-  <component name="FacetManager">
-    <facet type="android-gradle" name="Android-Gradle">
-      <configuration>
-        <option name="GRADLE_PROJECT_PATH" value=":" />
-        <option name="LAST_SUCCESSFUL_SYNC_AGP_VERSION" />
-        <option name="LAST_KNOWN_AGP_VERSION" />
-      </configuration>
-    </facet>
-  </component>
-  <component name="NewModuleRootManager" inherit-compiler-output="true">
-    <exclude-output />
-    <content url="file://$MODULE_DIR$/../.." />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

package/android/.idea/modules.xml

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/modules/android.iml" filepath="$PROJECT_DIR$/.idea/modules/android.iml" />
-    </modules>
-  </component>
-</project>

package/android/.idea/vcs.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$/.." vcs="Git" />
-  </component>
-</project>

package/android/local.properties

@@ -1,8 +0,0 @@
-## This file must *NOT* be checked into Version Control Systems,
-# as it contains information specific to your local configuration.
-#
-# Location of the SDK. This is only used by Gradle.
-# For customization when using a Version Control System, please read the
-# header note.
-#Tue Jun 21 15:53:06 EDT 2022
-sdk.dir=/Users/charliecruzan/Library/Android/sdk

package/ios/StripeSdk.xcodeproj/project.xcworkspace/contents.xcworkspacedata

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Workspace
-   version = "1.0">
-   <FileRef
-      location = "self:">
-   </FileRef>
-</Workspace>

package/ios/StripeSdk.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

@@ -1,8 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>IDEDidComputeMac32BitWarning</key>
-	<true/>
-</dict>
-</plist>

package/ios/StripeSdk.xcodeproj/xcuserdata/charliecruzan.xcuserdatad/xcdebugger/Breakpoints_v2.xcbkptlist

@@ -1,22 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<Bucket
-   uuid = "18A7FEF5-1FA3-4609-B152-0287F2E115A0"
-   type = "1"
-   version = "2.0">
-   <Breakpoints>
-      <BreakpointProxy
-         BreakpointExtensionID = "Xcode.Breakpoint.FileBreakpoint">
-         <BreakpointContent
-            uuid = "C0FB3E07-7654-41DA-96B5-07363EE2CDC7"
-            shouldBeEnabled = "Yes"
-            ignoreCount = "0"
-            continueAfterRunningActions = "No"
-            filePath = "ApplePayButtonManager.m"
-            startingColumnNumber = "9223372036854775807"
-            endingColumnNumber = "9223372036854775807"
-            startingLineNumber = "11"
-            endingLineNumber = "11">
-         </BreakpointContent>
-      </BreakpointProxy>
-   </Breakpoints>
-</Bucket>

package/ios/StripeSdk.xcodeproj/xcuserdata/charliecruzan.xcuserdatad/xcschemes/xcschememanagement.plist

@@ -1,27 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>SchemeUserState</key>
-	<dict>
-		<key>StripeSdk.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>0</integer>
-		</dict>
-		<key>Tests.xcscheme_^#shared#^_</key>
-		<dict>
-			<key>orderHint</key>
-			<integer>1</integer>
-		</dict>
-	</dict>
-	<key>SuppressBuildableAutocreation</key>
-	<dict>
-		<key>FC55C2D928620B7D00526360</key>
-		<dict>
-			<key>primary</key>
-			<true/>
-		</dict>
-	</dict>
-</dict>
-</plist>