@stripe/stripe-react-native 0.16.0 → 0.17.0

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

@@ -3,6 +3,7 @@ export declare type CardBrand = 'AmericanExpress' | 'DinersClub' | 'Discover' |
 export declare type Type = 'Account' | 'BankAccount' | 'Card' | 'CvcUpdate' | 'Person' | 'Pii';
 export interface Result {
     id: string;
+    /** The UNIX timestamp (in milliseconds) of the date this token was created. */
     created: string;
     type: Type;
     used: boolean;
@@ -11,14 +12,24 @@ export interface Result {
     bankAccount?: BankAccount;
 }
 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 declare type BankAccountStatus = 'Errored' | 'New' | 'Validated' | 'VerificationFailed' | 'Verified';
 export interface Card {
     country: string;
     brand: CardBrand;

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

@@ -11,7 +11,8 @@ import * as AuBECSDebitFormComponent from './components/AuBECSDebitFormComponent
 import * as CardFieldInput from './components/CardFieldInput';
 import * as CardFormView from './components/CardFormView';
 import * as Token from './Token';
-export { ApplePay, PaymentIntent, PaymentMethod, PaymentSheet, SetupIntent, ThreeDSecure, GooglePay, ApplePayButtonComponent, AuBECSDebitFormComponent, CardFieldInput, CardFormView, Token, };
+import * as FinancialConnections from './FinancialConnections';
+export { ApplePay, PaymentIntent, PaymentMethod, PaymentSheet, SetupIntent, ThreeDSecure, GooglePay, ApplePayButtonComponent, AuBECSDebitFormComponent, CardFieldInput, CardFormView, Token, FinancialConnections, };
 export * from './Errors';
 export { Address, BillingDetails } from './Common';
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stripe/stripe-react-native",
-  "version": "0.16.0",
+  "version": "0.17.0",
   "author": "Stripe",
   "description": "Stripe SDK for React Native",
   "main": "lib/commonjs/index",
@@ -50,19 +50,19 @@
     "@wdio/mocha-framework": "^7.16.15",
     "@wdio/spec-reporter": "^7.16.14",
     "@wdio/sync": "^7.16.15",
-    "appium": "^1.22.2",
+    "appium": "^1.22.3",
     "appium-chromedriver": "4.26.2",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^6.11.0",
     "eslint-plugin-prettier": "^3.1.3",
     "expect-webdriverio": "^2.0.1",
-    "husky": "^4.2.5",
+    "husky": "^8.0.0",
     "jest": "^26.6.3",
-    "metro-react-native-babel-preset": "^0.67.0",
+    "metro-react-native-babel-preset": "^0.70.3",
     "mocha": "^8.3.2",
     "prettier": "^2.0.5",
-    "react": "17.0.2",
-    "react-native": "0.68.1",
+    "react": "18.0.0",
+    "react-native": "0.69.2",
     "ts-node": "^9.1.1",
     "typedoc": "^0.22.12",
     "typescript": "~4.4.4",
@@ -81,11 +81,6 @@
       "<rootDir>/e2e"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint && yarn typescript"
-    }
-  },
   "eslintConfig": {
     "extends": [
       "@react-native-community",
@@ -145,6 +140,9 @@
     ]
   },
   "dependencies": {
-    "@expo/config-plugins": "^4.1.4"
+    "@expo/config-plugins": "^4.1.5"
+  },
+  "resolutions": {
+    "simple-plist": "1.3.1"
   }
 }

package/src/NativeStripeSdk.tsx

@@ -27,6 +27,7 @@ import type {
   IsCardInWalletResult,
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
+  FinancialConnections,
 } from './types';
 
 type NativeStripeSdkType = {
@@ -96,6 +97,12 @@ type NativeStripeSdkType = {
   isCardInWallet(params: {
     cardLastFour: string;
   }): Promise<IsCardInWalletResult>;
+  collectBankAccountToken(
+    clientSecret: string
+  ): Promise<FinancialConnections.TokenResult>;
+  collectFinancialConnectionsAccounts(
+    clientSecret: string
+  ): Promise<FinancialConnections.SessionResult>;
 };
 
 const { StripeSdk } = NativeModules;

package/src/functions.ts

@@ -35,6 +35,7 @@ import {
   IsCardInWalletResult,
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
+  FinancialConnections,
 } from './types';
 
 const APPLE_PAY_NOT_SUPPORTED_MESSAGE =
@@ -567,6 +568,63 @@ export const collectBankAccountForSetup = async (
   }
 };
 
+/**
+ * Use collectBankAccountToken in the [Add a Financial Connections Account to a US Custom Connect](https://stripe.com/docs/financial-connections/connect-payouts) account flow.
+ * When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account for payouts.
+ * @param clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @returns A promise that resolves to an object containing either `session` and `token` fields, or an error field.
+ */
+export const collectBankAccountToken = async (
+  clientSecret: string
+): Promise<FinancialConnections.TokenResult> => {
+  try {
+    const { session, token, error } =
+      await NativeStripeSdk.collectBankAccountToken(clientSecret);
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      session: session!,
+      token: token!,
+    };
+  } catch (error: any) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
+/**
+ * Use collectFinancialConnectionsAccounts in the [Collect an account to build data-powered products](https://stripe.com/docs/financial-connections/other-data-powered-products) flow.
+ * When called, it will load the Authentication Flow, an on-page modal UI which allows your user to securely link their external financial account.
+ * @param clientSecret The client_secret of the [Financial Connections Session](https://stripe.com/docs/api/financial_connections/session).
+ * @returns A promise that resolves to an object containing either a `session` field, or an error field.
+ */
+export const collectFinancialConnectionsAccounts = async (
+  clientSecret: string
+): Promise<FinancialConnections.SessionResult> => {
+  try {
+    const { session, error } =
+      await NativeStripeSdk.collectFinancialConnectionsAccounts(clientSecret);
+
+    if (error) {
+      return {
+        error,
+      };
+    }
+    return {
+      session: session!,
+    };
+  } catch (error: any) {
+    return {
+      error: createError(error),
+    };
+  }
+};
+
 export const canAddCardToWallet = async (
   params: CanAddCardToWalletParams
 ): Promise<CanAddCardToWalletResult> => {

package/src/hooks/useFinancialConnectionsSheet.tsx

@@ -0,0 +1,34 @@
+import { useState } from 'react';
+import { useStripe } from './useStripe';
+
+/**
+ * React hook for accessing functions on the Financial Connections sheet.
+ *
+ * Retuns the `collectBankAccountToken` and `collectFinancialConnectionsAccounts` functions, and a `loading` boolean that you can use
+ * to display loading state (like showing a spinner).
+ */
+export function useFinancialConnectionsSheet() {
+  const [loading, setLoading] = useState(false);
+  const { collectBankAccountToken, collectFinancialConnectionsAccounts } =
+    useStripe();
+
+  const _collectBankAccountToken = async (clientSecret: string) => {
+    setLoading(true);
+    const result = await collectBankAccountToken(clientSecret);
+    setLoading(false);
+    return result;
+  };
+
+  const _collectFinancialConnectionsAccounts = async (clientSecret: string) => {
+    setLoading(true);
+    const result = await collectFinancialConnectionsAccounts(clientSecret);
+    setLoading(false);
+    return result;
+  };
+
+  return {
+    collectBankAccountToken: _collectBankAccountToken,
+    collectFinancialConnectionsAccounts: _collectFinancialConnectionsAccounts,
+    loading,
+  };
+}

package/src/hooks/useStripe.tsx

@@ -30,6 +30,7 @@ import type {
   CollectBankAccountForPaymentResult,
   CanAddCardToWalletParams,
   CanAddCardToWalletResult,
+  FinancialConnections,
 } from '../types';
 import { useCallback, useEffect, useState } from 'react';
 import { isiOS } from '../helpers';
@@ -60,6 +61,8 @@ import {
   verifyMicrodepositsForPayment,
   verifyMicrodepositsForSetup,
   canAddCardToWallet,
+  collectBankAccountToken,
+  collectFinancialConnectionsAccounts,
 } from '../functions';
 
 /**
@@ -290,6 +293,22 @@ export function useStripe() {
     []
   );
 
+  const _collectBankAccountToken = useCallback(
+    async (clientSecret: string): Promise<FinancialConnections.TokenResult> => {
+      return collectBankAccountToken(clientSecret);
+    },
+    []
+  );
+
+  const _collectFinancialConnectionsAccounts = useCallback(
+    async (
+      clientSecret: string
+    ): Promise<FinancialConnections.SessionResult> => {
+      return collectFinancialConnectionsAccounts(clientSecret);
+    },
+    []
+  );
+
   return {
     retrievePaymentIntent: _retrievePaymentIntent,
     retrieveSetupIntent: _retrieveSetupIntent,
@@ -317,5 +336,7 @@ export function useStripe() {
     verifyMicrodepositsForPayment: _verifyMicrodepositsForPayment,
     verifyMicrodepositsForSetup: _verifyMicrodepositsForSetup,
     canAddCardToWallet: _canAddCardToWallet,
+    collectBankAccountToken: _collectBankAccountToken,
+    collectFinancialConnectionsAccounts: _collectFinancialConnectionsAccounts,
   };
 }

package/src/index.tsx

@@ -5,6 +5,7 @@ export { useStripe } from './hooks/useStripe';
 export { useApplePay, Props as UseApplePayProps } from './hooks/useApplePay';
 export { usePaymentSheet } from './hooks/usePaymentSheet';
 export { useGooglePay } from './hooks/useGooglePay';
+export { useFinancialConnectionsSheet } from './hooks/useFinancialConnectionsSheet';
 
 //components
 export {

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