@stripe/stripe-react-native 0.14.0 → 0.17.0

package/src/types/ApplePay.ts

@@ -1,5 +1,3 @@
-export type CartSummaryItemType = 'final' | 'pending';
-
 export type ContactFieldsType =
   | 'emailAddress'
   | 'name'
@@ -20,7 +18,7 @@ export type AddressFields =
 export interface ShippingMethod {
   label: string;
   amount: string;
-  type?: CartSummaryItemType;
+  isPending?: boolean;
   identifier: string;
   detail?: string;
 }
@@ -51,11 +49,46 @@ export interface ShippingContact {
   phoneNumber?: number;
   postalAddress: PostalAddress;
 }
-export interface CartSummaryItem {
+
+export type CartSummaryItem =
+  | DeferredCartSummaryItem
+  | ImmediateCartSummaryItem
+  | RecurringCartSummaryItem;
+
+export type CartSummaryItemType = 'Deferred' | 'Immediate' | 'Recurring';
+
+/** Use this type for a payment that occurs in the future, such as a pre-order. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem. */
+export type DeferredCartSummaryItem = {
+  paymentType: 'Deferred';
+  /** The unix timestamp of the date, in the future, of the payment. Measured in seconds. */
+  deferredDate: number;
   label: string;
   amount: string;
-  type?: CartSummaryItemType;
-}
+};
+
+/** Use this type for payments that will occur immediately. */
+export type ImmediateCartSummaryItem = {
+  paymentType: 'Immediate';
+  /** When creating items for estimates or charges whose final value is not yet known, set this to true. */
+  isPending?: boolean;
+  label: string;
+  amount: string;
+};
+
+/** Use this type for payments that occur more than once, such as a subscription. Only available on iOS 15 and up, otherwise falls back to ImmediateCartSummaryItem.*/
+export type RecurringCartSummaryItem = {
+  paymentType: 'Recurring';
+  /** The amount of time – in calendar units such as day, month, or year – that represents a fraction of the total payment interval. For example, if you set the intervalUnit to 'month' and intervalCount to 3, then the payment interval is three months.*/
+  intervalUnit: 'minute' | 'hour' | 'day' | 'month' | 'year';
+  /** The number of interval units that make up the total payment interval. For example, if you set the intervalUnit to 'month' and intervalCount to 3, then the payment interval is three months.*/
+  intervalCount: number;
+  /** The unix timestamp of the start date. Measured in seconds. */
+  startDate?: number;
+  /** The unix timestamp of the end date. Measured in seconds. */
+  endDate?: number;
+  label: string;
+  amount: string;
+};
 
 export interface PresentParams {
   cartItems: CartSummaryItem[];

package/src/types/FinancialConnections.ts

@@ -0,0 +1,126 @@
+import type { BankAccount } from './Token';
+import type { StripeError } from './Errors';
+
+export type SessionResult =
+  | {
+      /** The updated Financial Connections Session object. */
+      session: Session;
+      error?: undefined;
+    }
+  | {
+      session?: undefined;
+      error: StripeError<FinancialConnectionsSheetError>;
+    };
+
+export type TokenResult =
+  | {
+      /** The updated Financial Connections Session object. */
+      session: Session;
+      /** The Stripe token object associated with the bank account. */
+      token: BankAccountToken;
+      error?: undefined;
+    }
+  | {
+      session?: undefined;
+      token?: undefined;
+      error: StripeError<FinancialConnectionsSheetError>;
+    };
+
+export type Session = {
+  /** A unique ID for this session. */
+  id: string;
+  /** The client secret for this session. */
+  clientSecret: string;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  /** The accounts that were collected as part of this Session. */
+  accounts: Array<Account>;
+};
+
+export type BankAccountToken = {
+  /** Bank account details. */
+  bankAccount: BankAccount | null;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  /** A unique ID for this token. */
+  id: string | null;
+  used: boolean;
+  type: 'BankAccount';
+  /** The UNIX timestamp (in milliseconds) of the date this token was created. */
+  created: number | null;
+};
+
+export type Account = {
+  /** A unique ID for this Financial Connections Account. */
+  id: string;
+  /** Has the value true if the object exists in live mode or the value false if the object exists in test mode. */
+  livemode: boolean;
+  displayName: string | null;
+  /** The current status of the account. Either active, inactive, or disconnected. */
+  status: AccountStatus;
+  institutionName: string;
+  last4: string | null;
+  /** The UNIX timestamp (in milliseconds) of the date this account was created. */
+  created: number;
+  /** The balance of this account. */
+  balance: Balance | null;
+  /** The last balance refresh. Includes the timestamp and the status. */
+  balanceRefresh: BalanceRefresh | null;
+  /** The category of this account, either cash, credit, investment, or other. */
+  category: Category;
+  /** The subcategory of this account, either checking, credit_card, line_of_credit, mortgage, savings, or other. */
+  subcategory: Subcategory;
+  /** Permissions requested for accounts collected during this session. */
+  permissions: Array<Permission> | null;
+  /** The supported payment method types for this account. */
+  supportedPaymentMethodTypes: Array<PaymentMethodType>;
+};
+
+export type AccountStatus = 'active' | 'inactive' | 'disconnected';
+
+export type Category = 'cash' | 'credit' | 'investment' | 'other';
+
+export type PaymentMethodType = 'us_bank_account' | 'link';
+
+export type Subcategory =
+  | 'checking'
+  | 'credit_card'
+  | 'line_of_credit'
+  | 'mortgage'
+  | 'other'
+  | 'savings';
+
+export type Permission =
+  | 'balances'
+  | 'ownership'
+  | 'payment_method'
+  | 'transactions'
+  | 'account_numbers';
+
+export type Balance = {
+  /** The UNIX timestamp (in milliseconds) of time that the external institution calculated this balance. */
+  asOf: number;
+  /** The type of this balance, either cash or credit. */
+  type: BalanceType;
+  /** The funds available to the account holder. Typically this is the current balance less any holds.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is an integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  cash: { available: Map<String, number> | null };
+  /** The credit that has been used by the account holder.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  credit: { used: Map<String, number> | null };
+  /** The balances owed to (or by) the account holder.  Each key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.  Each value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder. */
+  current: Map<String, number>;
+};
+
+export type BalanceRefresh = {
+  status: BalanceRefreshStatus;
+  /** The UNIX timestamp (in milliseconds) of the time at which the last refresh attempt was initiated. */
+  lastAttemptedAt: number;
+};
+
+export type BalanceType = 'cash' | 'credit';
+
+export type BalanceRefreshStatus = 'failed' | 'pending' | 'succeeded';
+
+export enum FinancialConnectionsSheetError {
+  Failed = 'Failed',
+  Canceled = 'Canceled',
+}

package/src/types/PaymentIntent.ts

@@ -7,6 +7,7 @@ import type * as PaymentMethod from './PaymentMethod';
 export interface Result {
   id: string;
   amount: number;
+  /** The UNIX timestamp (in milliseconds) of the date this PaymentIntent was created. */
   created: string;
   currency: string;
   status: Status;

package/src/types/PaymentMethod.ts

@@ -42,7 +42,8 @@ export type CreateParams =
   // | WeChatPayParams
   | BancontactParams
   | USBankAccountParams
-  | PayPalParams;
+  | PayPalParams
+  | AffirmParams;
 
 export type ConfirmParams = CreateParams;
 
@@ -175,6 +176,15 @@ export interface AuBecsDebitParams {
   paymentMethodData: { formDetails: FormDetails };
 }
 
+export type AffirmParams = {
+  paymentMethodType: 'Affirm';
+  paymentMethodData?: {
+    /** Affirm requires that shipping is present for the payment to succeed because it significantly helps with loan approval rates. Shipping details can either be provided here or via the Payment Intent- https://stripe.com/docs/api/payment_intents/create#create_payment_intent-shipping. */
+    shippingDetails?: ShippingDetails;
+    billingDetails?: BillingDetails;
+  };
+};
+
 /**
  * If paymentMethodData is null, it is assumed that the bank account details have already been attached
  * via `collectBankAccountForPayment` or `collectBankAccountForSetup`.

package/src/types/PaymentSheet.ts

@@ -1,20 +1,24 @@
 import type { BillingDetails } from './Common';
+import type { CartSummaryItem } from './ApplePay';
 
-export type SetupParams = ClientSecretParams &
-  GooglePayParams &
-  ApplePayParams & {
-    /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
-    merchantDisplayName: string;
-    customerId?: string;
-    customerEphemeralKeySecret?: string;
-    customFlow?: boolean;
-    style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
-    returnURL?: string;
-    defaultBillingDetails?: BillingDetails;
-    allowsDelayedPaymentMethods?: boolean;
-  } & { appearance?: AppearanceParams };
+export type SetupParams = ClientSecretParams & {
+  /** Your customer-facing business name. On Android, this is required and cannot be an empty string. */
+  merchantDisplayName: string;
+  customerId?: string;
+  customerEphemeralKeySecret?: string;
+  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;
+  style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+  returnURL?: string;
+  defaultBillingDetails?: BillingDetails;
+  allowsDelayedPaymentMethods?: boolean;
+  appearance?: AppearanceParams;
+};
 
-type ClientSecretParams =
+export type ClientSecretParams =
   | {
       paymentIntentClientSecret: string;
       setupIntentClientSecret?: undefined;
@@ -24,29 +28,23 @@ type ClientSecretParams =
       paymentIntentClientSecret?: undefined;
     };
 
-type ApplePayParams =
-  | {
-      applePay?: true;
-      merchantCountryCode: string;
-    }
-  | {
-      applePay?: false;
-      merchantCountryCode?: string;
-    };
+export type ApplePayParams = {
+  /** The two-letter ISO 3166 code of the country of your business, e.g. "US"  */
+  merchantCountryCode: string;
+  /**
+   * 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[];
+};
 
-type GooglePayParams =
-  | {
-      googlePay?: true;
-      merchantCountryCode: string;
-      currencyCode?: string;
-      testEnv?: boolean;
-    }
-  | {
-      googlePay?: false;
-      merchantCountryCode?: string;
-      currencyCode?: string;
-      testEnv?: boolean;
-    };
+export type GooglePayParams = {
+  /** The two-letter ISO 3166 code of the country of your business, e.g. "US"  */
+  merchantCountryCode: string;
+  /** The three-letter ISO 4217 alphabetic currency code, e.g. "USD" or "EUR". Required in order to support Google Pay when processing a Setup Intent. */
+  currencyCode?: string;
+  /** Whether or not to use the Google Pay test environment.  Set to `true` until you have applied for and been granted access to the Production environment. */
+  testEnv?: boolean;
+};
 
 /**
  * Used to customize the appearance of your PaymentSheet

package/src/types/SetupIntent.ts

@@ -6,6 +6,7 @@ export interface Result {
   id: string;
   clientSecret: string;
   lastSetupError: LastPaymentError | null;
+  /** The UNIX timestamp (in milliseconds) of the date this Setup Intent was created. */
   created: string | null;
   livemode: boolean;
   paymentMethodId: string | null;

package/src/types/Token.ts

@@ -20,6 +20,7 @@ export type Type =
 
 export interface Result {
   id: string;
+  /** The UNIX timestamp (in milliseconds) of the date this token was created. */
   created: string;
   type: Type;
   used: boolean;
@@ -29,15 +30,31 @@ export interface Result {
 }
 
 export interface BankAccount {
-  bankName: string;
-  accountHolderName: string;
-  accountHolderType: BankAcccountHolderType;
-  currency: string;
-  country: string;
-  routingNumber: string;
-  status: 'Errored' | 'New' | 'Validated' | 'VerificationFailed' | 'Verified';
+  /** A unique ID for this bank account. */
+  id: string;
+  /** The name of the associated bank. */
+  bankName: string | null;
+  /** The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object. */
+  accountHolderName: string | null;
+  /** The type of entity that holds the account. */
+  accountHolderType: BankAcccountHolderType | null;
+  /** The currency the bank account is in. This must be a country/currency pairing that Stripe supports. */
+  currency: string | null;
+  /** The country in which the bank account is located. */
+  country: string | null;
+  routingNumber: string | null;
+  status: BankAccountStatus | null;
+  fingerprint: string | null;
+  last4: string | null;
 }
 
+export type BankAccountStatus =
+  | 'Errored'
+  | 'New'
+  | 'Validated'
+  | 'VerificationFailed'
+  | 'Verified';
+
 export interface Card {
   country: string;
   brand: CardBrand;

package/src/types/index.ts

@@ -25,6 +25,7 @@ import * as AuBECSDebitFormComponent from './components/AuBECSDebitFormComponent
 import * as CardFieldInput from './components/CardFieldInput';
 import * as CardFormView from './components/CardFormView';
 import * as Token from './Token';
+import * as FinancialConnections from './FinancialConnections';
 
 export {
   ApplePay,
@@ -39,6 +40,7 @@ export {
   CardFieldInput,
   CardFormView,
   Token,
+  FinancialConnections,
 };
 
 export * from './Errors';

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/.gitignore

@@ -1,3 +0,0 @@
-# Default ignored files
-/shelf/
-/workspace.xml

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/.idea/workspace.xml

@@ -1,52 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="AutoImportSettings">
-    <option name="autoReloadType" value="NONE" />
-  </component>
-  <component name="ChangeListManager">
-    <list default="true" id="6bd19f01-32d7-4d37-8b5e-6bd0f29ff270" name="Changes" comment="">
-      <change afterPath="$PROJECT_DIR$/src/androidTest/java/com/reactnativestripesdk/pushprovisioning/PushProvisioningProxyTest.kt" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/build.gradle" beforeDir="false" afterPath="$PROJECT_DIR$/build.gradle" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/../ios/StripeSdk.xcodeproj/project.pbxproj" beforeDir="false" afterPath="$PROJECT_DIR$/../ios/StripeSdk.xcodeproj/project.pbxproj" afterDir="false" />
-    </list>
-    <option name="SHOW_DIALOG" value="false" />
-    <option name="HIGHLIGHT_CONFLICTS" value="true" />
-    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
-    <option name="LAST_RESOLUTION" value="IGNORE" />
-  </component>
-  <component name="Git.Settings">
-    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$/.." />
-  </component>
-  <component name="ProjectId" id="2AtuQTRuDgWJsBWelsxPwKKLnTE" />
-  <component name="ProjectLevelVcsManager" settingsEditedManually="true" />
-  <component name="ProjectViewState">
-    <option name="hideEmptyMiddlePackages" value="true" />
-    <option name="showLibraryContents" value="true" />
-  </component>
-  <component name="PropertiesComponent">
-    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
-    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
-    <property name="RunOnceActivity.cidr.known.project.marker" value="true" />
-    <property name="cidr.known.project.marker" value="true" />
-    <property name="last_opened_file_path" value="$PROJECT_DIR$" />
-  </component>
-  <component name="RecentsManager">
-    <key name="CreateTestDialog.Recents.Supers">
-      <recent name="" />
-    </key>
-    <key name="CreateTestDialog.RecentsKey">
-      <recent name="" />
-    </key>
-  </component>
-  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
-  <component name="TaskManager">
-    <task active="true" id="Default" summary="Default task">
-      <changelist id="6bd19f01-32d7-4d37-8b5e-6bd0f29ff270" name="Changes" comment="" />
-      <created>1655841188103</created>
-      <option name="number" value="Default" />
-      <option name="presentableId" value="Default" />
-      <updated>1655841188103</updated>
-    </task>
-    <servers />
-  </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/android/src/androidTest/java/com/reactnativestripesdk/pushprovisioning/PushProvisioningProxyTest.kt

@@ -1,35 +0,0 @@
-package com.reactnativestripesdk.pushprovisioning
-
-import android.content.Context
-import androidx.test.core.app.ApplicationProvider
-import com.facebook.react.bridge.ReactApplicationContext
-import org.junit.Assert.*
-import org.junit.Test
-
-class PushProvisioningProxyTest {
-  private val reactApplicationContext = ReactApplicationContext(
-    ApplicationProvider.getApplicationContext<Context>()
-  )
-
-  @Test
-  fun getApiVersion() {
-    // This value very rarely changes, so the test is hard coded
-    assertEquals(
-      "2019-09-09",
-      PushProvisioningProxy.getApiVersion()
-    )
-  }
-
-  @Test
-  fun isNFCEnabled() {
-    assertEquals(
-      false,
-      PushProvisioningProxy.isNFCEnabled(reactApplicationContext)
-    )
-  }
-
-  @Test
-  fun isTokenInWallet() {
-    assertEquals(TapAndPayProxy.isTokenInWallet({}, "4242"), false)
-  }
-}

package/android/src/main/res/drawable-night/googlepay_button_no_shadow_background.xml

@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<selector xmlns:android="http://schemas.android.com/apk/res/android" >
-    <item
-        android:drawable="@drawable/googlepay_button_no_shadow_background_image" />
-</selector>
-

package/android/src/main/res/drawable-night-v21/googlepay_button_no_shadow_background.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<ripple xmlns:android="http://schemas.android.com/apk/res/android"
-    android:color="#e0ffffff">
-    <item
-        android:drawable="@drawable/googlepay_button_no_shadow_background_image" />
-</ripple>
-

package/android/src/main/res/values-night/googlepay_strings.xml

@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<resources>
-    <string name="googlepay_button_content_description">Google Pay</string>
-    <string name="buy_with_googlepay_button_content_description">Buy with Google Pay</string>
-    <string name="donate_with_googlepay_button_content_description">Donate With Google Pay</string>
-    <string name="pay_with_googlepay_button_content_description">Pay With Google Pay</string>
-    <string name="subscribe_with_googlepay_button_content_description">Subscribe With Google Pay</string>
-    <string name="book_with_googlepay_button_content_description">Book With Google Pay</string>
-    <string name="checkout_with_googlepay_button_content_description">Checkout With Google Pay</string>
-    <string name="order_with_googlepay_button_content_description">Order With Google Pay</string>
-    <string name="view_in_googlepay_button_content_description">View In Google Pay</string>
-</resources>

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>