@stripe/stripe-react-native 0.5.0 → 0.8.0

package/src/types/Token.ts

@@ -0,0 +1,74 @@
+import type { Address } from './Common';
+
+export type CardBrand =
+  | 'AmericanExpress'
+  | 'DinersClub'
+  | 'Discover'
+  | 'JCB'
+  | 'MasterCard'
+  | 'UnionPay'
+  | 'Visa'
+  | 'Unknown';
+
+export type Type =
+  | 'Account'
+  | 'BankAccount'
+  | 'Card'
+  | 'CvcUpdate'
+  | 'Person'
+  | 'Pii';
+
+export interface Result {
+  id: string;
+  created: string;
+  type: Type;
+  used: boolean;
+  livemode: boolean;
+  card?: Card;
+  bankAccount?: BankAccount;
+}
+
+export interface BankAccount {
+  bankName: string;
+  accountHolderName: string;
+  accountHolderType: BankAcccountHolderType;
+  currency: string;
+  country: string;
+  routingNumber: string;
+  status: 'Errored' | 'New' | 'Validated' | 'VerificationFailed' | 'Verified';
+}
+
+export interface Card {
+  country: string;
+  brand: CardBrand;
+  currency?: string;
+  expMonth: number;
+  expYear: number;
+  last4: string;
+  funding: 'Credit' | 'Debit' | 'Prepaid' | 'Unknown';
+  address: Address;
+  name?: string;
+}
+
+export type CreateParams = CreateCardTokenParams | CreateBankAccountTokenParams;
+
+export type CreateCardTokenParams = {
+  type: 'Card';
+  address?: Address;
+  name?: string;
+  currency?: string;
+};
+
+export type BankAcccountHolderType = 'Company' | 'Individual';
+
+export type BankAcccountType = 'Checking' | 'Savings';
+
+export type CreateBankAccountTokenParams = {
+  type: 'BankAccount';
+  accountHolderName?: string;
+  accountHolderType?: BankAcccountHolderType;
+  accountNumber: string;
+  country: string;
+  currency: string;
+  routingNumber?: string;
+};

package/src/types/components/ApplePayButtonComponent.ts

@@ -1,31 +1,29 @@
 import type { StyleProp, ViewStyle } from 'react-native';
 
-export namespace ApplePayButtonComponent {
-  export interface NativeProps {
-    style?: StyleProp<ViewStyle>;
-    type?: number;
-    buttonStyle?: number;
-    borderRadius?: number;
-    onPressAction(): void;
-  }
+export interface NativeProps {
+  style?: StyleProp<ViewStyle>;
+  type?: number;
+  buttonStyle?: number;
+  borderRadius?: number;
+  onPressAction(): void;
+}
 
-  export type Types =
-    | 'plain'
-    | 'buy'
-    | 'setUp'
-    | 'inStore'
-    | 'donate'
-    | 'checkout'
-    | 'book'
-    | 'subscribe'
-    | 'reload'
-    | 'addMoney'
-    | 'topUp'
-    | 'order'
-    | 'rent'
-    | 'support'
-    | 'contribute'
-    | 'tip';
+export type Type =
+  | 'plain'
+  | 'buy'
+  | 'setUp'
+  | 'inStore'
+  | 'donate'
+  | 'checkout'
+  | 'book'
+  | 'subscribe'
+  | 'reload'
+  | 'addMoney'
+  | 'topUp'
+  | 'order'
+  | 'rent'
+  | 'support'
+  | 'contribute'
+  | 'tip';
 
-  export type Styles = 'white' | 'whiteOutline' | 'black' | 'automatic';
-}
+export type Style = 'white' | 'whiteOutline' | 'black' | 'automatic';

package/src/types/components/AuBECSDebitFormComponent.ts

@@ -0,0 +1,29 @@
+import type { NativeSyntheticEvent, StyleProp, ViewStyle } from 'react-native';
+
+/**
+ * @ignore
+ */
+export interface NativeProps {
+  companyName: string;
+  style?: StyleProp<ViewStyle>;
+  formStyle: Styles;
+  onCompleteAction(value: NativeSyntheticEvent<FormDetails>): void;
+}
+
+export interface FormDetails {
+  accountNumber: string;
+  bsbNumber: string;
+  email: string;
+  name: string;
+}
+
+export interface Styles {
+  borderWidth?: number;
+  backgroundColor?: string;
+  borderColor?: string;
+  borderRadius?: number;
+  textColor?: string;
+  fontSize?: number;
+  placeholderColor?: string;
+  textErrorColor?: string;
+}

package/src/types/components/CardFieldInput.ts

@@ -1,75 +1,73 @@
 import type { NativeSyntheticEvent, StyleProp, ViewStyle } from 'react-native';
-import type { Nullable } from '../';
-import type { Card } from '../Card';
+import type { CardBrand } from '../Token';
 
-export namespace CardFieldInput {
-  export type Names = 'CardNumber' | 'Cvc' | 'ExpiryDate' | 'PostalCode';
-  export enum ValidationState {
-    Valid = 'Valid',
-    Invalid = 'Invalid',
-    Incomplete = 'Incomplete',
-    Unknown = 'Unknown',
-  }
+export type FieldName = 'CardNumber' | 'Cvc' | 'ExpiryDate' | 'PostalCode';
 
-  export interface Details {
-    last4: string;
-    expiryMonth: number;
-    expiryYear: number;
-    postalCode?: string;
-    brand: Card.Brand;
-    complete: boolean;
-    validExpiryDate: ValidationState;
-    validCVC: ValidationState;
-    validNumber: ValidationState;
-    /**
-     * WARNING: Full card details are only returned when the `dangerouslyGetFullCardDetails` prop
-     * on the `CardField` component is set to `true`.
-     * Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
-     * Make sure that you're not mistakenly logging or storing full card details!
-     * See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
-     */
-    number?: string;
-  }
-
-  export interface Styles {
-    borderWidth?: number;
-    backgroundColor?: string;
-    borderColor?: string;
-    borderRadius?: number;
-    textColor?: string;
-    fontSize?: number;
-    placeholderColor?: string;
-    cursorColor?: string;
-    textErrorColor?: string;
-    fontFamily?: string;
-  }
-
-  export interface Placeholders {
-    number?: string;
-    expiration?: string;
-    cvc?: string;
-    postalCode?: string;
-  }
+export enum ValidationState {
+  Valid = 'Valid',
+  Invalid = 'Invalid',
+  Incomplete = 'Incomplete',
+  Unknown = 'Unknown',
+}
 
+export interface Details {
+  last4: string;
+  expiryMonth: number;
+  expiryYear: number;
+  postalCode?: string;
+  brand: CardBrand;
+  complete: boolean;
+  validExpiryDate: ValidationState;
+  validCVC: ValidationState;
+  validNumber: ValidationState;
   /**
-   * @ignore
+   * WARNING: Full card details are only returned when the `dangerouslyGetFullCardDetails` prop
+   * on the `CardField` component is set to `true`.
+   * Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+   * Make sure that you're not mistakenly logging or storing full card details!
+   * See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
    */
-  export interface NativeProps {
-    style?: StyleProp<ViewStyle>;
-    value?: Partial<Details>;
-    postalCodeEnabled?: boolean;
-    autofocus?: boolean;
-    onCardChange(event: NativeSyntheticEvent<Details>): void;
-    onFocusChange(
-      event: NativeSyntheticEvent<{ focusedField: Nullable<Names> }>
-    ): void;
-    cardStyle?: Styles;
-    placeholder?: Placeholders;
-  }
+  number?: string;
+}
+
+export interface Styles {
+  borderWidth?: number;
+  backgroundColor?: string;
+  borderColor?: string;
+  borderRadius?: number;
+  textColor?: string;
+  fontSize?: number;
+  placeholderColor?: string;
+  cursorColor?: string;
+  textErrorColor?: string;
+  fontFamily?: string;
+}
+
+export interface Placeholders {
+  number?: string;
+  expiration?: string;
+  cvc?: string;
+  postalCode?: string;
+}
+
+/**
+ * @ignore
+ */
+export interface NativeProps {
+  style?: StyleProp<ViewStyle>;
+  value?: Partial<Details>;
+  postalCodeEnabled?: boolean;
+  autofocus?: boolean;
+  onCardChange(event: NativeSyntheticEvent<Details>): void;
+  onFocusChange(
+    event: NativeSyntheticEvent<{ focusedField: FieldName | null }>
+  ): void;
+  cardStyle?: Styles;
+  placeholders?: Placeholders;
+}
 
-  export interface Methods {
-    focus(): void;
-    blur(): void;
-    clear(): void;
-  }
+export interface Methods {
+  focus(): void;
+  blur(): void;
+  clear(): void;
 }

package/src/types/components/CardFormView.ts

@@ -1,59 +1,66 @@
 import type { NativeSyntheticEvent, StyleProp, ViewStyle } from 'react-native';
-import type { Nullable } from '..';
-import type { Card } from '../Card';
+import type { CardBrand } from '../Token';
 
-export namespace CardFormView {
-  export type Names = 'CardNumber' | 'Cvc' | 'ExpiryDate' | 'PostalCode';
+export type FieldName = 'CardNumber' | 'Cvc' | 'ExpiryDate' | 'PostalCode';
 
-  export interface Details {
-    last4: string;
-    expiryMonth: number;
-    expiryYear: number;
-    postalCode?: string;
-    brand: Card.Brand;
-    complete: boolean;
-    country: string;
-    /**
-     * WARNING: Full card details are only returned when the `dangerouslyGetFullCardDetails` prop
-     * on the `CardField` component is set to `true`.
-     * Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
-     * Make sure that you're not mistakenly logging or storing full card details!
-     * See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
-     */
-    number?: string;
-  }
+export interface Details {
+  last4: string;
+  expiryMonth: number;
+  expiryYear: number;
+  postalCode?: string;
+  brand: CardBrand;
+  complete: boolean;
+  country: string;
+  /**
+   * WARNING: Full card details are only returned when the `dangerouslyGetFullCardDetails` prop
+   * on the `CardField` component is set to `true`.
+   * Only do this if you're certain that you fulfill the necessary PCI compliance requirements.
+   * Make sure that you're not mistakenly logging or storing full card details!
+   * See the docs for details: https://stripe.com/docs/security/guide#validating-pci-compliance
+   */
+  number?: string;
+}
 
-  export interface Styles {
-    backgroundColor?: string;
-    // disabledBackgroundColor?: string;
-    // type?: 'borderless' | 'standard';
-  }
+export interface Styles {
+  backgroundColor?: string;
+  // disabledBackgroundColor?: string;
+  // type?: 'borderless' | 'standard';
+  borderWidth?: number;
+  borderColor?: string;
+  borderRadius?: number;
+  textColor?: string;
+  fontSize?: number;
+  placeholderColor?: string;
+  cursorColor?: string;
+  textErrorColor?: string;
+  fontFamily?: string;
+}
 
-  export interface Placeholders {
-    number?: string;
-    expiration?: string;
-    cvc?: string;
-    postalCode?: string;
-  }
+export interface Placeholders {
+  number?: string;
+  expiration?: string;
+  cvc?: string;
+  postalCode?: string;
+}
 
-  /**
-   * @ignore
-   */
-  export interface NativeProps {
-    style?: StyleProp<ViewStyle>;
-    autofocus?: boolean;
-    // isUserInteractionEnabledValue?: boolean;
-    cardStyle?: Styles;
-    // placeholder: Placeholders;
-    // postalCodeEnabled: boolean;
-    onFocusChange(
-      event: NativeSyntheticEvent<{ focusedField: Nullable<Names> }>
-    ): void;
-    onFormComplete(event: NativeSyntheticEvent<Details>): void;
-  }
+/**
+ * @ignore
+ */
+export interface NativeProps {
+  style?: StyleProp<ViewStyle>;
+  autofocus?: boolean;
+  // isUserInteractionEnabledValue?: boolean;
+  cardStyle?: Styles;
+  /** Android only */
+  placeholders?: Placeholders;
+  // postalCodeEnabled: boolean;
+  onFocusChange(
+    event: NativeSyntheticEvent<{ focusedField: FieldName | null }>
+  ): void;
+  onFormComplete(event: NativeSyntheticEvent<Details>): void;
+}
 
-  export interface Methods {
-    focus(): void;
-    blur(): void;
-  }
+export interface Methods {
+  focus(): void;
+  blur(): void;
 }

package/src/types/index.ts

@@ -1,4 +1,3 @@
-import type { Card } from './Card';
 import type {
   ApplePayError,
   CardActionError,
@@ -11,26 +10,39 @@ import type {
   RetrievePaymentIntentError,
   RetrieveSetupIntentError,
   StripeError,
+  VerifyMicrodepositsError,
+  CollectBankAccountError,
 } from './Errors';
-import type { PaymentIntent } from './PaymentIntents';
-import type { PaymentMethod } from './PaymentMethods';
-import type { PaymentSheet } from './PaymentSheet';
-import type { SetupIntent } from './SetupIntent';
-import type { ThreeDSecureConfigurationParams } from './ThreeDSecure';
-
-export * from './ApplePay';
-export * from './PaymentIntents';
-export * from './PaymentMethods';
-export * from './SetupIntent';
-export * from './GooglePay';
-export * from './ThreeDSecure';
-export * from './components/ApplePayButtonComponent';
-export * from './components/AuBECSDebitForm';
-export * from './components/CardFieldInput';
-export * from './components/CardFormView';
-export * from './Card';
+import * as ApplePay from './ApplePay';
+import * as PaymentIntent from './PaymentIntent';
+import * as PaymentMethod from './PaymentMethod';
+import * as PaymentSheet from './PaymentSheet';
+import * as SetupIntent from './SetupIntent';
+import * as ThreeDSecure from './ThreeDSecure';
+import * as GooglePay from './GooglePay';
+import * as ApplePayButtonComponent from './components/ApplePayButtonComponent';
+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,
+};
+
 export * from './Errors';
-export * from './PaymentSheet';
+export { Address, BillingDetails } from './Common';
 
 /**
  * @ignore
@@ -39,11 +51,6 @@ export type Dictionary<T> = {
   [key: string]: T;
 };
 
-/**
- * @ignore
- */
-export type Nullable<T> = T | null;
-
 export interface AppInfo {
   name?: string;
   partnerId?: string;
@@ -53,7 +60,7 @@ export interface AppInfo {
 
 export type CreatePaymentMethodResult =
   | {
-      paymentMethod: PaymentMethod;
+      paymentMethod: PaymentMethod.Result;
       error?: undefined;
     }
   | {
@@ -63,7 +70,7 @@ export type CreatePaymentMethodResult =
 
 export type RetrievePaymentIntentResult =
   | {
-      paymentIntent: PaymentIntent;
+      paymentIntent: PaymentIntent.Result;
       error?: undefined;
     }
   | {
@@ -73,7 +80,7 @@ export type RetrievePaymentIntentResult =
 
 export type RetrieveSetupIntentResult =
   | {
-      setupIntent: SetupIntent;
+      setupIntent: SetupIntent.Result;
       error?: undefined;
     }
   | {
@@ -83,7 +90,7 @@ export type RetrieveSetupIntentResult =
 
 export type ConfirmPaymentResult =
   | {
-      paymentIntent: PaymentIntent;
+      paymentIntent: PaymentIntent.Result;
       error?: undefined;
     }
   | {
@@ -93,7 +100,7 @@ export type ConfirmPaymentResult =
 
 export type HandleNextActionResult =
   | {
-      paymentIntent: PaymentIntent;
+      paymentIntent: PaymentIntent.Result;
       error?: undefined;
     }
   | {
@@ -103,7 +110,7 @@ export type HandleNextActionResult =
 
 export type ConfirmSetupIntentResult =
   | {
-      setupIntent: SetupIntent;
+      setupIntent: SetupIntent.Result;
       error?: undefined;
     }
   | {
@@ -147,7 +154,7 @@ export type PresentPaymentSheetResult =
 
 export type CreateTokenResult =
   | {
-      token: Card.Token;
+      token: Token.Result;
       error?: undefined;
     }
   | {
@@ -161,7 +168,7 @@ export type ConfirmPaymentSheetPaymentResult = {
 
 export type ApplePayResult =
   | {
-      paymentMethod: PaymentMethod;
+      paymentMethod: PaymentMethod.Result;
       error?: undefined;
     }
   | {
@@ -171,15 +178,11 @@ export type ApplePayResult =
 
 export interface InitStripeParams {
   publishableKey: string;
-  merchantIdentifier?: string;
-  threeDSecureParams?: ThreeDSecureConfigurationParams;
   stripeAccountId?: string;
+  threeDSecureParams?: ThreeDSecure.ConfigurationParams;
+  merchantIdentifier?: string;
   urlScheme?: string;
   setReturnUrlSchemeOnAndroid?: boolean;
-  /**
-   * @deprecated Use setReturnUrlSchemeOnAndroid instead
-   */
-  setUrlSchemeOnAndroid?: boolean;
 }
 
 export interface InitialiseParams extends InitStripeParams {
@@ -204,7 +207,7 @@ export type PayWithGooglePayResult =
 
 export type CreateGooglePayPaymentMethodResult =
   | {
-      paymentMethod: PaymentMethod;
+      paymentMethod: PaymentMethod.Result;
       error?: undefined;
     }
   | {
@@ -220,25 +223,79 @@ export type OpenApplePaySetupResult =
       error: StripeError<ApplePayError>;
     };
 
-export type CreateTokenParams =
-  | CreateTokenCardParams
-  | CreateTokenBankAccountParams;
+export type VerifyMicrodepositsParams =
+  | {
+      amounts: number[];
+      descriptorCode?: undefined;
+    }
+  | {
+      amounts?: undefined;
+      descriptorCode: string;
+    };
 
-export type CreateTokenCardParams = {
-  type: 'Card';
-  address?: Card.Address;
-  name?: string;
-  currency?: string;
-};
+export type VerifyMicrodepositsForPaymentResult =
+  | {
+      paymentIntent: PaymentIntent.Result;
+      error?: undefined;
+    }
+  | {
+      paymentIntent?: undefined;
+      error: StripeError<VerifyMicrodepositsError>;
+    };
 
-export type BankAcccountHolderType = 'Company' | 'Individual';
+export type VerifyMicrodepositsForSetupResult =
+  | {
+      setupIntent: SetupIntent.Result;
+      error?: undefined;
+    }
+  | {
+      setupIntent?: undefined;
+      error: StripeError<VerifyMicrodepositsError>;
+    };
+
+export type CollectBankAccountForPaymentResult =
+  | {
+      paymentIntent: PaymentIntent.Result;
+      error?: undefined;
+    }
+  | {
+      paymentIntent?: undefined;
+      error: StripeError<CollectBankAccountError>;
+    };
+
+export type CollectBankAccountForSetupResult =
+  | {
+      setupIntent: SetupIntent.Result;
+      error?: undefined;
+    }
+  | {
+      setupIntent?: undefined;
+      error: StripeError<CollectBankAccountError>;
+    };
 
-export type CreateTokenBankAccountParams = {
-  type: 'BankAccount';
-  accountHolderName?: string;
-  accountHolderType?: BankAcccountHolderType;
-  accountNumber: string;
-  country: string;
-  currency: string;
-  routingNumber?: string;
+export type GooglePayCardToken = {
+  id: string;
+  cardLastFour: string;
+  network: number;
+  serviceProvider: number;
+  issuer: string;
+  status:
+    | 'TOKEN_STATE_NEEDS_IDENTITY_VERIFICATION'
+    | 'TOKEN_STATE_PENDING'
+    | 'TOKEN_STATE_SUSPENDED'
+    | 'TOKEN_STATE_ACTIVE'
+    | 'TOKEN_STATE_FELICA_PENDING_PROVISIONING'
+    | 'TOKEN_STATE_UNTOKENIZED';
 };
+
+export type IsCardInWalletResult =
+  | {
+      isInWallet: boolean;
+      token?: GooglePayCardToken;
+      error?: undefined;
+    }
+  | {
+      isInWallet?: undefined;
+      token?: undefined;
+      error: StripeError<GooglePayError>;
+    };