@stripe/stripe-react-native 0.6.0 → 0.9.0

package/src/types/PaymentMethod.ts

@@ -0,0 +1,290 @@
+import type { FormDetails } from './components/AuBECSDebitFormComponent';
+import type {
+  CardBrand,
+  BankAcccountHolderType,
+  BankAcccountType,
+} from './Token';
+import type { FutureUsage } from './PaymentIntent';
+import type { Address, BillingDetails } from './Common';
+
+export interface Result {
+  id: string;
+  liveMode: boolean;
+  customerId: string;
+  billingDetails: BillingDetails;
+  paymentMethodType: Type;
+  AuBecsDebit: AuBecsDebitResult;
+  BacsDebit: BacsDebitResult;
+  Card: CardResult;
+  Fpx: FpxResult;
+  Ideal: IdealResult;
+  SepaDebit: SepaDebitResult;
+  Sofort: SofortResult;
+  Upi: UpiResult;
+  USBankAccount: USBankAccountResult;
+}
+
+export type CreateParams =
+  | CardParams
+  | IdealParams
+  | OxxoParams
+  | P24Params
+  | AlipayParams
+  | GiropayParams
+  | SepaParams
+  | EpsParams
+  | AuBecsDebitParams
+  | SofortParams
+  | GrabPayParams
+  | FPXParams
+  | AfterpayClearpayParams
+  | KlarnaParams
+  // | WeChatPayParams
+  | BancontactParams
+  | USBankAccountParams
+  | PayPalParams;
+
+export type ConfirmParams = CreateParams;
+
+export type CreateOptions = {
+  setupFutureUsage?: FutureUsage;
+};
+
+export type ConfirmOptions = CreateOptions;
+
+export type ShippingDetails = BillingDetails;
+
+export type CardParams =
+  | {
+      paymentMethodType: 'Card';
+      paymentMethodData?: {
+        token?: string;
+        billingDetails?: BillingDetails;
+      };
+    }
+  | {
+      paymentMethodType: 'Card';
+      paymentMethodData: {
+        paymentMethodId: string;
+        cvc?: string;
+        billingDetails?: BillingDetails;
+      };
+    };
+
+export interface IdealParams {
+  paymentMethodType: 'Ideal';
+  paymentMethodData?: {
+    bankName?: string;
+    billingDetails?: BillingDetails;
+  };
+}
+
+export interface FPXParams {
+  paymentMethodType: 'Fpx';
+  paymentMethodData?: { testOfflineBank?: boolean };
+}
+
+export interface AlipayParams {
+  paymentMethodType: 'Alipay';
+}
+
+export interface OxxoParams {
+  paymentMethodType: 'Oxxo';
+  paymentMethodData: {
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface SofortParams {
+  paymentMethodType: 'Sofort';
+  paymentMethodData: {
+    country: string;
+    billingDetails: BillingDetails;
+  };
+}
+export interface GrabPayParams {
+  paymentMethodType: 'GrabPay';
+  paymentMethodData?: {
+    billingDetails?: BillingDetails;
+  };
+}
+
+export interface BancontactParams {
+  paymentMethodType: 'Bancontact';
+  paymentMethodData: {
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface SepaParams {
+  paymentMethodType: 'SepaDebit';
+  paymentMethodData: {
+    iban: string;
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface GiropayParams {
+  paymentMethodType: 'Giropay';
+  paymentMethodData: {
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface AfterpayClearpayParams {
+  paymentMethodType: 'AfterpayClearpay';
+  paymentMethodData: {
+    shippingDetails: ShippingDetails;
+    billingDetails: BillingDetails;
+  };
+}
+
+export type KlarnaParams = {
+  paymentMethodType: 'Klarna';
+  paymentMethodData: {
+    billingDetails: Pick<Required<BillingDetails>, 'email'> & {
+      address: Pick<Required<Address>, 'country'>;
+    } & BillingDetails;
+  };
+};
+
+export interface EpsParams {
+  paymentMethodType: 'Eps';
+  paymentMethodData: {
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface P24Params {
+  paymentMethodType: 'P24';
+  paymentMethodData: {
+    billingDetails: BillingDetails;
+  };
+}
+
+export interface WeChatPayParams {
+  paymentMethodType: 'WeChatPay';
+  paymentMethodData: {
+    appId: string;
+    billingDetails?: BillingDetails;
+  };
+}
+
+export interface AuBecsDebitParams {
+  paymentMethodType: 'AuBecsDebit';
+  paymentMethodData: { formDetails: FormDetails };
+}
+
+/**
+ * If paymentMethodData is null, it is assumed that the bank account details have already been attached
+ * via `collectBankAccountForPayment` or `collectBankAccountForSetup`.
+ */
+export type USBankAccountParams = {
+  paymentMethodType: 'USBankAccount';
+  paymentMethodData?: {
+    billingDetails: Pick<Required<BillingDetails>, 'name'> & BillingDetails;
+    accountNumber: string;
+    routingNumber: string;
+    /** Defaults to Individual */
+    accountHolderType?: BankAcccountHolderType;
+    /** Defaults to Checking */
+    accountType?: BankAcccountType;
+  };
+};
+
+export type PayPalParams = {
+  paymentMethodType: 'PayPal';
+  paymentMethodData?: {
+    billingDetails?: BillingDetails;
+  };
+};
+
+export interface AuBecsDebitResult {
+  fingerprint?: string;
+  last4?: string;
+  bsbNumber?: string;
+}
+
+export interface BacsDebitResult {
+  sortCode?: string;
+  last4?: string;
+  fingerprint?: string;
+}
+
+export interface CardResult {
+  brand?: CardBrand;
+  country?: string;
+  expYear?: number;
+  expMonth?: number;
+  fingerprint?: string;
+  funding?: string;
+  last4?: string;
+}
+
+export interface FpxResult {
+  bank?: string;
+}
+
+export interface IdealResult {
+  bankIdentifierCode?: string;
+  bank?: string;
+}
+
+export interface SepaDebitResult {
+  bankCode?: string;
+  country?: string;
+  fingerprint?: string;
+  last4?: string;
+}
+
+export interface SofortResult {
+  country?: string;
+}
+
+export interface UpiResult {
+  vpa?: string;
+}
+
+export type USBankAccountResult = {
+  routingNumber?: string;
+  accountHolderType?: BankAcccountHolderType;
+  accountType?: BankAcccountType;
+  last4?: string;
+  bankName?: string;
+  linkedAccount?: string;
+  fingerprint?: string;
+  preferredNetwork?: string;
+  supportedNetworks?: string[];
+};
+
+export type Type =
+  | 'AfterpayClearpay'
+  | 'Card'
+  | 'Alipay'
+  | 'GrabPay'
+  | 'Ideal'
+  | 'Fpx'
+  | 'CardPresent'
+  | 'SepaDebit'
+  | 'AuBecsDebit'
+  | 'BacsDebit'
+  | 'Giropay'
+  | 'P24'
+  | 'Eps'
+  | 'Bancontact'
+  | 'Oxxo'
+  | 'Sofort'
+  | 'Upi'
+  | 'USBankAccount'
+  | 'PayPal'
+  | 'Unknown';
+
+export type CollectBankAccountParams = {
+  paymentMethodType: 'USBankAccount';
+  paymentMethodData: {
+    billingDetails: {
+      name: string;
+      email?: string;
+    };
+  };
+};

package/src/types/PaymentSheet.ts

@@ -1,67 +1,53 @@
-export declare namespace PaymentSheet {
-  export type SetupParams = ClientSecretParams &
-    GooglePayParams &
-    ApplePayParams & {
-      customerId?: string;
-      customerEphemeralKeySecret?: string;
-      customFlow?: boolean;
-      merchantDisplayName?: string;
-      style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
-      returnURL?: string;
-      primaryButtonColor?: string;
-      defaultBillingDetails?: BillingDetails;
-      allowsDelayedPaymentMethods?: boolean;
-    };
+import type { BillingDetails } from './Common';
 
-  type ClientSecretParams =
-    | {
-        paymentIntentClientSecret: string;
-        setupIntentClientSecret?: undefined;
-      }
-    | {
-        setupIntentClientSecret: string;
-        paymentIntentClientSecret?: undefined;
-      };
+export type SetupParams = ClientSecretParams &
+  GooglePayParams &
+  ApplePayParams & {
+    customerId?: string;
+    customerEphemeralKeySecret?: string;
+    customFlow?: boolean;
+    merchantDisplayName?: string;
+    style?: 'alwaysLight' | 'alwaysDark' | 'automatic';
+    returnURL?: string;
+    primaryButtonColor?: string;
+    defaultBillingDetails?: BillingDetails;
+    allowsDelayedPaymentMethods?: boolean;
+  };
 
-  type ApplePayParams =
-    | {
-        applePay?: true;
-        merchantCountryCode: string;
-      }
-    | {
-        applePay?: false;
-        merchantCountryCode?: string;
-      };
+type ClientSecretParams =
+  | {
+      paymentIntentClientSecret: string;
+      setupIntentClientSecret?: undefined;
+    }
+  | {
+      setupIntentClientSecret: string;
+      paymentIntentClientSecret?: undefined;
+    };
 
-  type GooglePayParams =
-    | {
-        googlePay?: true;
-        merchantCountryCode: string;
-        currencyCode?: string;
-        testEnv?: boolean;
-      }
-    | {
-        googlePay?: false;
-        merchantCountryCode?: string;
-        currencyCode?: string;
-        testEnv?: boolean;
-      };
-  export interface Address {
-    city?: string;
-    country?: string;
-    line1?: string;
-    line2?: string;
-    postalCode?: string;
-    state?: string;
-  }
-  export interface BillingDetails {
-    address: Address;
-    name?: string;
-    email?: string;
-    phone?: string;
-  }
-  export interface PaymentOption {
-    label: string;
-    image: string;
-  }
+type ApplePayParams =
+  | {
+      applePay?: true;
+      merchantCountryCode: string;
+    }
+  | {
+      applePay?: false;
+      merchantCountryCode?: string;
+    };
+
+type GooglePayParams =
+  | {
+      googlePay?: true;
+      merchantCountryCode: string;
+      currencyCode?: string;
+      testEnv?: boolean;
+    }
+  | {
+      googlePay?: false;
+      merchantCountryCode?: string;
+      currencyCode?: string;
+      testEnv?: boolean;
+    };
+export interface PaymentOption {
+  label: string;
+  image: string;
 }

package/src/types/SetupIntent.ts

@@ -1,90 +1,55 @@
-import type { Nullable, StripeError } from '.';
-import type { AuBECSDebitFormComponent } from './components/AuBECSDebitForm';
+import type { Type } from './PaymentMethod';
+import type { LastPaymentError } from './PaymentIntent';
 import type { NextAction } from './NextAction';
-import type {
-  PaymentMethod,
-  PaymentMethods,
-  PaymentMethodCreateParams,
-} from './PaymentMethods';
-
-export interface SetupIntent {
+import type * as PaymentMethod from './PaymentMethod';
+export interface Result {
   id: string;
   clientSecret: string;
-  lastSetupError: Nullable<ConfirmSetupIntent.LastPaymentError>;
-  created: Nullable<string>;
+  lastSetupError: LastPaymentError | null;
+  created: string | null;
   livemode: boolean;
-  paymentMethodId: Nullable<string>;
-  status: SetupIntents.Status;
-  paymentMethodTypes: PaymentMethods.Types[];
-  usage: SetupIntents.FutureUsage;
-  description: Nullable<string>;
+  paymentMethodId: string | null;
+  status: Status;
+  paymentMethodTypes: Type[];
+  usage: FutureUsage;
+  description: string | null;
   nextAction: NextAction | null;
 }
 
-export namespace ConfirmSetupIntent {
-  export type LastPaymentError = StripeError<string> & {
-    paymentMethod: PaymentMethod;
-  };
-
-  export type Params =
-    | CardParams
-    | IdealParams
-    | BancontactParams
-    | SofortParams
-    | AuBecsDebitParams
-    | SepaParams
-    | PaymentMethodCreateParams.USBankAccountParams;
-
-  export interface Options {}
-
-  export interface BaseParams {
-    billingDetails?: PaymentMethods.BillingDetails;
-  }
-
-  export interface CardParams extends BaseParams {
-    type: 'Card';
-  }
-
-  export interface IdealParams extends BaseParams {
-    type: 'Ideal';
-    bankName?: string;
-  }
-
-  export interface SofortParams extends BaseParams {
-    type: 'Sofort';
-    country: string;
-  }
-  export interface BancontactParams extends Required<BaseParams> {
-    type: 'Bancontact';
-  }
-
-  export interface SepaParams extends Required<BaseParams> {
-    type: 'SepaDebit';
-    iban: string;
-  }
-
-  export interface AuBecsDebitParams {
-    type: 'AuBecsDebit';
-    formDetails: AuBECSDebitFormComponent.FormDetails;
-  }
-}
-
-export namespace SetupIntents {
-  export type FutureUsage =
-    | 'Unknown'
-    | 'None'
-    | 'OnSession'
-    | 'OffSession'
-    | 'OneTime';
-
-  export enum Status {
-    Succeeded = 'Succeeded',
-    RequiresPaymentMethod = 'RequiresPaymentMethod',
-    RequiresConfirmation = 'RequiresConfirmation',
-    Canceled = 'Canceled',
-    Processing = 'Processing',
-    RequiresAction = 'RequiresAction',
-    RequiresCapture = 'RequiresCapture',
-    Unknown = 'Unknown',
-  }
+export type ConfirmParams =
+  | PaymentMethod.CardParams
+  | PaymentMethod.IdealParams
+  | PaymentMethod.OxxoParams
+  | PaymentMethod.P24Params
+  | PaymentMethod.AlipayParams
+  | PaymentMethod.GiropayParams
+  | PaymentMethod.SepaParams
+  | PaymentMethod.EpsParams
+  | PaymentMethod.AuBecsDebitParams
+  | PaymentMethod.SofortParams
+  | PaymentMethod.GrabPayParams
+  | PaymentMethod.FPXParams
+  | PaymentMethod.AfterpayClearpayParams
+  | PaymentMethod.KlarnaParams
+  | PaymentMethod.BancontactParams
+  | PaymentMethod.USBankAccountParams;
+// TODO: Change the above back to PaymentMethod.CreateParams when PayPal is supported through SetupIntents
+
+export type ConfirmOptions = {};
+
+export type FutureUsage =
+  | 'Unknown'
+  | 'None'
+  | 'OnSession'
+  | 'OffSession'
+  | 'OneTime';
+
+export enum Status {
+  Succeeded = 'Succeeded',
+  RequiresPaymentMethod = 'RequiresPaymentMethod',
+  RequiresConfirmation = 'RequiresConfirmation',
+  Canceled = 'Canceled',
+  Processing = 'Processing',
+  RequiresAction = 'RequiresAction',
+  Unknown = 'Unknown',
 }

package/src/types/ThreeDSecure.ts

@@ -1,81 +1,75 @@
-export interface ThreeDSecureConfigurationParams extends ThreeDSecure.Props {
+export interface ConfigurationParams extends Props {
   timeout?: number;
-  label?: ThreeDSecure.LabelProps;
-  navigationBar?: ThreeDSecure.NavigationBarProps;
-  textField?: ThreeDSecure.TextFieldProps;
-  submitButton?: ThreeDSecure.ButtonProps;
-  cancelButton?: ThreeDSecure.ButtonProps;
-  continueButton?: ThreeDSecure.ButtonProps;
-  nextButton?: ThreeDSecure.ButtonProps;
-  resendButton?: ThreeDSecure.ButtonProps;
+  label?: LabelProps;
+  navigationBar?: NavigationBarProps;
+  textField?: TextFieldProps;
+  submitButton?: ButtonProps;
+  cancelButton?: ButtonProps;
+  continueButton?: ButtonProps;
+  nextButton?: ButtonProps;
+  resendButton?: ButtonProps;
 }
 
-export namespace ThreeDSecure {
-  export interface Props extends IOS.Props, Android.Props {}
+export interface Props extends IOSProps, AndroidProps {}
 
-  export enum NavigationBarStyle {
-    default = 0,
-    black = 1,
-    blackTranslucent = 2,
-  }
+export enum NavigationBarStyle {
+  default = 0,
+  black = 1,
+  blackTranslucent = 2,
+}
 
-  export namespace IOS {
-    export interface Props {
-      backgroundColor?: string;
-      footer?: FooterProps;
-    }
-    export interface NavigationBarProps {
-      barStyle?: NavigationBarStyle;
-      translucent?: boolean;
-      barTintColor?: string;
-    }
-  }
+export interface IOSProps {
+  backgroundColor?: string;
+  footer?: FooterProps;
+}
+export interface IOSNavigationBarProps {
+  barStyle?: NavigationBarStyle;
+  translucent?: boolean;
+  barTintColor?: string;
+}
 
-  export namespace Android {
-    export interface Props {
-      accentColor?: string;
-    }
-    export interface NavigationBarProps {
-      statusBarColor?: string;
-      backgroundColor?: string;
-    }
-  }
+export interface AndroidProps {
+  accentColor?: string;
+}
+export interface AndroidNavigationBarProps {
+  statusBarColor?: string;
+  backgroundColor?: string;
+}
 
-  export interface NavigationBarProps
-    extends IOS.NavigationBarProps,
-      Android.NavigationBarProps {
-    headerText?: string;
-    buttonText?: string;
-    textColor?: string;
-    textFontSize?: number;
-  }
+export interface NavigationBarProps
+  extends IOSNavigationBarProps,
+    AndroidNavigationBarProps {
+  headerText?: string;
+  buttonText?: string;
+  textColor?: string;
+  textFontSize?: number;
+}
 
-  export interface FooterProps {
-    backgroundColor?: string;
-    chevronColor?: string;
-    headingTextColor?: string;
-    textColor?: string;
-  }
+export interface FooterProps {
+  backgroundColor?: string;
+  chevronColor?: string;
+  headingTextColor?: string;
+  textColor?: string;
+}
 
-  export interface LabelProps {
-    headingTextColor?: string;
-    textColor?: string;
-    textFontSize?: number;
-    headingFontSize?: number;
-  }
+export interface LabelProps {
+  headingTextColor?: string;
+  textColor?: string;
+  textFontSize?: number;
+  headingFontSize?: number;
+}
 
-  export interface TextFieldProps {
-    borderColor?: string;
-    borderWidth?: number;
-    borderRadius?: number;
-    textColor?: string;
-    textFontSize?: number;
-  }
+export interface TextFieldProps {
+  borderColor?: string;
+  borderWidth?: number;
+  borderRadius?: number;
+  textColor?: string;
+  textFontSize?: number;
+}
 
-  export interface ButtonProps {
-    backgroundColor?: string;
-    borderRadius?: number;
-    textColor?: string;
-    textFontSize?: number;
-  }
+export interface ButtonProps {
+  backgroundColor?: string;
+  borderRadius?: number;
+  textColor?: string;
+  textFontSize?: number;
 }