@unifold/connect-react-native 0.1.23 → 0.1.25

package/dist/stripe.d.mts

@@ -1,31 +1,252 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { Onramp } from '@stripe/stripe-react-native';
+
+declare function setStripeOnrampPublishableKey(key: string): void;
+declare function setStripeOnrampApiUrl(url: string): void;
+declare function getStripePublishableKey(): Promise<string>;
+type OnrampSessionTransactionDetails = {
+    destination_amount: string;
+    destination_currency: string;
+    destination_network: string;
+    source_amount: string;
+    source_currency: string;
+    fees: {
+        network_fee_amount: string;
+        transaction_fee_amount: string;
+    };
+    quote_expiration: number;
+    wallet_address: string;
+    last_error: string | null;
+};
+type OnrampSession = {
+    id: string;
+    client_secret: string;
+    status: string;
+    transaction_details: OnrampSessionTransactionDetails;
+};
+type CreateSessionParams = {
+    cryptoCustomerId: string;
+    paymentToken: string;
+    sourceAmount: number;
+    sourceCurrency: string;
+    destinationCurrency: string;
+    walletAddress: string;
+    destinationNetwork: string;
+};
+type CustomerVerification = {
+    name: "kyc_verified" | "phone_verified" | "id_document_verified" | string;
+    status: "verified" | "unverified" | string;
+    errors: string[];
+};
+type OnrampCustomer = {
+    id: string;
+    provided_fields: string[];
+    verifications: CustomerVerification[];
+};
+
+type KYCData = {
+    firstName: string;
+    lastName: string;
+    idNumber: string;
+    dobMonth: string;
+    dobDay: string;
+    dobYear: string;
+    addressLine1: string;
+    addressLine2: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    country: string;
+};
+type KYCWizardScreenProps = {
+    initialData?: Partial<KYCData>;
+    loading?: boolean;
+    onComplete: (data: KYCData) => void;
+    onCancel: () => void;
+};
+declare function KYCWizardScreen({ initialData, loading, onComplete, onCancel, }: KYCWizardScreenProps): react_jsx_runtime.JSX.Element;
+
+type OnrampStep = "email" | "register" | "kyc" | "identity" | "amount" | "wallet" | "payment_method" | "session_params" | "quote" | "processing" | "success";
+type OnrampErrorCode = "configuration_error" | "authorization_error" | "registration_error" | "kyc_error" | "identity_error" | "wallet_error" | "payment_error" | "session_error" | "validation_error" | "unknown_error";
+type OnrampError = {
+    code: OnrampErrorCode;
+    message: string;
+    step: OnrampStep;
+    stripeErrorCode?: string;
+};
+type OnrampTransaction = {
+    sessionId: string;
+    status: string;
+    sourceAmount: string;
+    sourceCurrency: string;
+    destinationAmount: string;
+    destinationCurrency: string;
+    destinationNetwork: string;
+    walletAddress: string;
+    fees: {
+        networkFee: string;
+        transactionFee: string;
+    };
+};
+type OnrampConfig = {
+    merchantDisplayName?: string;
+    defaultWalletAddress?: string;
+    defaultNetwork?: Onramp.CryptoNetwork;
+    defaultSourceAmount?: string;
+    defaultSourceCurrency?: string;
+    defaultDestinationCurrency?: string;
+    onComplete?: (transaction: OnrampTransaction) => void;
+    onError?: (error: OnrampError) => void;
+    onStepChange?: (step: OnrampStep, previousStep: OnrampStep) => void;
+    /** Pre-fill email — skips the email screen and goes to register (phone) */
+    email?: string;
+    /** Pre-fill phone — combined with email, skips both screens and auto-triggers Link check + register */
+    phone?: string;
+    /** Same fields as DepositConfig / beginDeposit() — used to auto-resolve wallet */
+    publishableKey?: string;
+    externalUserId?: string;
+    recipientAddress?: string;
+    destinationChainType?: "ethereum" | "solana" | "bitcoin";
+    destinationChainId?: string;
+    destinationTokenAddress?: string;
+    /** Flow order: "verify_first" (default) starts with email, "amount_first" starts with amount entry */
+    flowOrder?: "verify_first" | "amount_first";
+    /**
+     * Apple Pay / Platform Pay merchant id (e.g. `merchant.com.your.app`).
+     * When unset or blank, Apple Pay is not offered and `isPlatformPaySupported` is not used for that path.
+     */
+    merchantIdentifier?: string;
+};
+declare function useStripeOnramp(config?: OnrampConfig): {
+    step: OnrampStep;
+    loading: boolean;
+    status: string;
+    error: OnrampError | null;
+    email: string;
+    phone: string;
+    fullName: string;
+    country: string;
+    customerId: string;
+    accessToken: string;
+    session: OnrampSession | null;
+    kycData: KYCData;
+    walletAddress: string;
+    resolvedRecipientAddress: string;
+    walletNetwork: Onramp.CryptoNetwork;
+    sourceAmount: string;
+    sourceCurrency: string;
+    destinationCurrency: string;
+    applePaySupported: boolean;
+    walletReady: boolean;
+    walletLoading: boolean;
+    setStep: react.Dispatch<react.SetStateAction<OnrampStep>>;
+    setStatus: react.Dispatch<react.SetStateAction<string>>;
+    setEmail: react.Dispatch<react.SetStateAction<string>>;
+    setPhone: react.Dispatch<react.SetStateAction<string>>;
+    setFullName: react.Dispatch<react.SetStateAction<string>>;
+    setCountry: react.Dispatch<react.SetStateAction<string>>;
+    setWalletAddress: react.Dispatch<react.SetStateAction<string>>;
+    setWalletNetwork: react.Dispatch<react.SetStateAction<Onramp.CryptoNetwork>>;
+    setSourceAmount: react.Dispatch<react.SetStateAction<string>>;
+    setSourceCurrency: react.Dispatch<react.SetStateAction<string>>;
+    setDestinationCurrency: react.Dispatch<react.SetStateAction<string>>;
+    checkEmail: () => Promise<void>;
+    register: () => Promise<void>;
+    attachKyc: (data: KYCData) => Promise<void>;
+    verifyIdentity: () => Promise<void>;
+    registerWallet: () => Promise<void>;
+    collectPaymentMethod: (useApplePay?: boolean) => Promise<void>;
+    refreshQuote: () => Promise<void>;
+    confirmCheckout: () => Promise<void>;
+    reset: () => void;
+    clearError: () => void;
+    resumeFulfillmentPolling: () => void;
+    amountFirst: boolean;
+};
+type StripeOnrampHook = ReturnType<typeof useStripeOnramp>;
+
+declare function OnrampScreen({ config, onComplete }: {
+    config?: OnrampConfig;
+    onComplete?: () => void;
+}): react_jsx_runtime.JSX.Element | null;
+
+type AmountScreenProps = {
+    initialAmount?: string;
+    currency?: string;
+    onConfirm: (amount: string) => void;
+    onCancel: () => void;
+};
+declare function AmountScreen({ initialAmount, currency, onConfirm, onCancel, }: AmountScreenProps): react_jsx_runtime.JSX.Element;
+
 /**
- * Declaration for `@unifold/connect-react-native/stripe`.
- * Runtime re-exports `@unifold/ui-react-native/stripe`; types follow the UI package.
+ * Props for the high-level StripeOnramp component.
+ *
+ * The developer only needs to provide their user-specific info.
+ * Everything else (Stripe key, StripeProvider, SDK preconfiguration)
+ * is handled automatically using the Unifold SDK context.
  */
-export {
-  StripeOnramp,
-  OnrampScreen,
-  AmountScreen,
-  KYCWizardScreen,
-  StripeOnrampPreconfigure,
-  useStripeOnramp,
-  setStripeOnrampPublishableKey,
-  setStripeOnrampApiUrl,
-  getStripePublishableKey,
-} from "@unifold/ui-react-native/stripe";
-
-export type {
-  StripeOnrampProps,
-  KYCData,
-  OnrampStep,
-  OnrampErrorCode,
-  OnrampError,
-  OnrampTransaction,
-  OnrampConfig,
-  StripeOnrampHook,
-  OnrampSession,
-  OnrampSessionTransactionDetails,
-  CreateSessionParams,
-  CustomerVerification,
-  OnrampCustomer,
-} from "@unifold/ui-react-native/stripe";
+interface StripeOnrampProps {
+    /** Unifold publishable key — pass from useUnifold().publishableKey */
+    publishableKey?: string;
+    /** User's email — pre-fills the email step */
+    email?: string;
+    /** User's phone — combined with email, skips both screens */
+    phone?: string;
+    /** Your app's user ID — used to auto-resolve the deposit wallet */
+    externalUserId: string;
+    /** Flow order: "verify_first" (default) or "amount_first" */
+    flowOrder?: "verify_first" | "amount_first";
+    /** Override destination chain type (default: "ethereum") */
+    destinationChainType?: "ethereum" | "solana" | "bitcoin";
+    /** Override destination chain ID (default: "8453" for Base) */
+    destinationChainId?: string;
+    /** Override destination token address */
+    destinationTokenAddress?: string;
+    /** Recipient wallet address — where purchased crypto is sent */
+    recipientAddress: string;
+    /** Called when the transaction completes successfully */
+    onComplete?: (transaction: OnrampTransaction) => void;
+    /** Called when an error occurs */
+    onError?: (error: OnrampError) => void;
+    /** Called when the flow step changes */
+    onStepChange?: (step: OnrampStep, previousStep: OnrampStep) => void;
+    /** Called when the user closes the flow (via ✕ or Done) */
+    onClose?: () => void;
+    /**
+     * Apple Pay merchant identifier (e.g. `merchant.com.your.app`). Defaults to empty — when empty,
+     * Apple Pay is hidden and `initStripe` is called without a merchant id.
+     */
+    merchantIdentifier?: string;
+    /** URL scheme for Stripe redirects (default: "unifoldOnramp") */
+    urlScheme?: string;
+}
+/**
+ * High-level Stripe Onramp component.
+ *
+ * Handles all the plumbing automatically:
+ * - Reads the Unifold publishable key from UnifoldProvider context
+ * - Fetches the Stripe publishable key from the Unifold API
+ * - Wraps in StripeProvider
+ * - Eagerly configures the Stripe Onramp SDK
+ * - Renders OnrampScreen with the config
+ *
+ * Usage:
+ * ```tsx
+ * <StripeOnramp
+ *   email={user.email}
+ *   externalUserId={user.id}
+ *   onClose={() => navigation.goBack()}
+ * />
+ * ```
+ */
+declare function StripeOnramp({ publishableKey, email, phone, externalUserId, flowOrder, destinationChainType, destinationChainId, destinationTokenAddress, recipientAddress, onComplete, onError, onStepChange, onClose, merchantIdentifier, urlScheme, }: StripeOnrampProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Render inside StripeOnramp after initStripe() has completed.
+ * Eagerly calls configure() so the Onramp SDK is ready by the time
+ * useStripeOnramp needs it. Renders nothing.
+ */
+declare function StripeOnrampPreconfigure(): null;
+
+export { AmountScreen, type CreateSessionParams, type CustomerVerification, type KYCData, KYCWizardScreen, type OnrampConfig, type OnrampCustomer, type OnrampError, type OnrampErrorCode, OnrampScreen, type OnrampSession, type OnrampSessionTransactionDetails, type OnrampStep, type OnrampTransaction, StripeOnramp, type StripeOnrampHook, StripeOnrampPreconfigure, type StripeOnrampProps, getStripePublishableKey, setStripeOnrampApiUrl, setStripeOnrampPublishableKey, useStripeOnramp };

package/dist/stripe.d.ts

@@ -1,31 +1,252 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { Onramp } from '@stripe/stripe-react-native';
+
+declare function setStripeOnrampPublishableKey(key: string): void;
+declare function setStripeOnrampApiUrl(url: string): void;
+declare function getStripePublishableKey(): Promise<string>;
+type OnrampSessionTransactionDetails = {
+    destination_amount: string;
+    destination_currency: string;
+    destination_network: string;
+    source_amount: string;
+    source_currency: string;
+    fees: {
+        network_fee_amount: string;
+        transaction_fee_amount: string;
+    };
+    quote_expiration: number;
+    wallet_address: string;
+    last_error: string | null;
+};
+type OnrampSession = {
+    id: string;
+    client_secret: string;
+    status: string;
+    transaction_details: OnrampSessionTransactionDetails;
+};
+type CreateSessionParams = {
+    cryptoCustomerId: string;
+    paymentToken: string;
+    sourceAmount: number;
+    sourceCurrency: string;
+    destinationCurrency: string;
+    walletAddress: string;
+    destinationNetwork: string;
+};
+type CustomerVerification = {
+    name: "kyc_verified" | "phone_verified" | "id_document_verified" | string;
+    status: "verified" | "unverified" | string;
+    errors: string[];
+};
+type OnrampCustomer = {
+    id: string;
+    provided_fields: string[];
+    verifications: CustomerVerification[];
+};
+
+type KYCData = {
+    firstName: string;
+    lastName: string;
+    idNumber: string;
+    dobMonth: string;
+    dobDay: string;
+    dobYear: string;
+    addressLine1: string;
+    addressLine2: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    country: string;
+};
+type KYCWizardScreenProps = {
+    initialData?: Partial<KYCData>;
+    loading?: boolean;
+    onComplete: (data: KYCData) => void;
+    onCancel: () => void;
+};
+declare function KYCWizardScreen({ initialData, loading, onComplete, onCancel, }: KYCWizardScreenProps): react_jsx_runtime.JSX.Element;
+
+type OnrampStep = "email" | "register" | "kyc" | "identity" | "amount" | "wallet" | "payment_method" | "session_params" | "quote" | "processing" | "success";
+type OnrampErrorCode = "configuration_error" | "authorization_error" | "registration_error" | "kyc_error" | "identity_error" | "wallet_error" | "payment_error" | "session_error" | "validation_error" | "unknown_error";
+type OnrampError = {
+    code: OnrampErrorCode;
+    message: string;
+    step: OnrampStep;
+    stripeErrorCode?: string;
+};
+type OnrampTransaction = {
+    sessionId: string;
+    status: string;
+    sourceAmount: string;
+    sourceCurrency: string;
+    destinationAmount: string;
+    destinationCurrency: string;
+    destinationNetwork: string;
+    walletAddress: string;
+    fees: {
+        networkFee: string;
+        transactionFee: string;
+    };
+};
+type OnrampConfig = {
+    merchantDisplayName?: string;
+    defaultWalletAddress?: string;
+    defaultNetwork?: Onramp.CryptoNetwork;
+    defaultSourceAmount?: string;
+    defaultSourceCurrency?: string;
+    defaultDestinationCurrency?: string;
+    onComplete?: (transaction: OnrampTransaction) => void;
+    onError?: (error: OnrampError) => void;
+    onStepChange?: (step: OnrampStep, previousStep: OnrampStep) => void;
+    /** Pre-fill email — skips the email screen and goes to register (phone) */
+    email?: string;
+    /** Pre-fill phone — combined with email, skips both screens and auto-triggers Link check + register */
+    phone?: string;
+    /** Same fields as DepositConfig / beginDeposit() — used to auto-resolve wallet */
+    publishableKey?: string;
+    externalUserId?: string;
+    recipientAddress?: string;
+    destinationChainType?: "ethereum" | "solana" | "bitcoin";
+    destinationChainId?: string;
+    destinationTokenAddress?: string;
+    /** Flow order: "verify_first" (default) starts with email, "amount_first" starts with amount entry */
+    flowOrder?: "verify_first" | "amount_first";
+    /**
+     * Apple Pay / Platform Pay merchant id (e.g. `merchant.com.your.app`).
+     * When unset or blank, Apple Pay is not offered and `isPlatformPaySupported` is not used for that path.
+     */
+    merchantIdentifier?: string;
+};
+declare function useStripeOnramp(config?: OnrampConfig): {
+    step: OnrampStep;
+    loading: boolean;
+    status: string;
+    error: OnrampError | null;
+    email: string;
+    phone: string;
+    fullName: string;
+    country: string;
+    customerId: string;
+    accessToken: string;
+    session: OnrampSession | null;
+    kycData: KYCData;
+    walletAddress: string;
+    resolvedRecipientAddress: string;
+    walletNetwork: Onramp.CryptoNetwork;
+    sourceAmount: string;
+    sourceCurrency: string;
+    destinationCurrency: string;
+    applePaySupported: boolean;
+    walletReady: boolean;
+    walletLoading: boolean;
+    setStep: react.Dispatch<react.SetStateAction<OnrampStep>>;
+    setStatus: react.Dispatch<react.SetStateAction<string>>;
+    setEmail: react.Dispatch<react.SetStateAction<string>>;
+    setPhone: react.Dispatch<react.SetStateAction<string>>;
+    setFullName: react.Dispatch<react.SetStateAction<string>>;
+    setCountry: react.Dispatch<react.SetStateAction<string>>;
+    setWalletAddress: react.Dispatch<react.SetStateAction<string>>;
+    setWalletNetwork: react.Dispatch<react.SetStateAction<Onramp.CryptoNetwork>>;
+    setSourceAmount: react.Dispatch<react.SetStateAction<string>>;
+    setSourceCurrency: react.Dispatch<react.SetStateAction<string>>;
+    setDestinationCurrency: react.Dispatch<react.SetStateAction<string>>;
+    checkEmail: () => Promise<void>;
+    register: () => Promise<void>;
+    attachKyc: (data: KYCData) => Promise<void>;
+    verifyIdentity: () => Promise<void>;
+    registerWallet: () => Promise<void>;
+    collectPaymentMethod: (useApplePay?: boolean) => Promise<void>;
+    refreshQuote: () => Promise<void>;
+    confirmCheckout: () => Promise<void>;
+    reset: () => void;
+    clearError: () => void;
+    resumeFulfillmentPolling: () => void;
+    amountFirst: boolean;
+};
+type StripeOnrampHook = ReturnType<typeof useStripeOnramp>;
+
+declare function OnrampScreen({ config, onComplete }: {
+    config?: OnrampConfig;
+    onComplete?: () => void;
+}): react_jsx_runtime.JSX.Element | null;
+
+type AmountScreenProps = {
+    initialAmount?: string;
+    currency?: string;
+    onConfirm: (amount: string) => void;
+    onCancel: () => void;
+};
+declare function AmountScreen({ initialAmount, currency, onConfirm, onCancel, }: AmountScreenProps): react_jsx_runtime.JSX.Element;
+
 /**
- * Declaration for `@unifold/connect-react-native/stripe`.
- * Runtime re-exports `@unifold/ui-react-native/stripe`; types follow the UI package.
+ * Props for the high-level StripeOnramp component.
+ *
+ * The developer only needs to provide their user-specific info.
+ * Everything else (Stripe key, StripeProvider, SDK preconfiguration)
+ * is handled automatically using the Unifold SDK context.
  */
-export {
-  StripeOnramp,
-  OnrampScreen,
-  AmountScreen,
-  KYCWizardScreen,
-  StripeOnrampPreconfigure,
-  useStripeOnramp,
-  setStripeOnrampPublishableKey,
-  setStripeOnrampApiUrl,
-  getStripePublishableKey,
-} from "@unifold/ui-react-native/stripe";
-
-export type {
-  StripeOnrampProps,
-  KYCData,
-  OnrampStep,
-  OnrampErrorCode,
-  OnrampError,
-  OnrampTransaction,
-  OnrampConfig,
-  StripeOnrampHook,
-  OnrampSession,
-  OnrampSessionTransactionDetails,
-  CreateSessionParams,
-  CustomerVerification,
-  OnrampCustomer,
-} from "@unifold/ui-react-native/stripe";
+interface StripeOnrampProps {
+    /** Unifold publishable key — pass from useUnifold().publishableKey */
+    publishableKey?: string;
+    /** User's email — pre-fills the email step */
+    email?: string;
+    /** User's phone — combined with email, skips both screens */
+    phone?: string;
+    /** Your app's user ID — used to auto-resolve the deposit wallet */
+    externalUserId: string;
+    /** Flow order: "verify_first" (default) or "amount_first" */
+    flowOrder?: "verify_first" | "amount_first";
+    /** Override destination chain type (default: "ethereum") */
+    destinationChainType?: "ethereum" | "solana" | "bitcoin";
+    /** Override destination chain ID (default: "8453" for Base) */
+    destinationChainId?: string;
+    /** Override destination token address */
+    destinationTokenAddress?: string;
+    /** Recipient wallet address — where purchased crypto is sent */
+    recipientAddress: string;
+    /** Called when the transaction completes successfully */
+    onComplete?: (transaction: OnrampTransaction) => void;
+    /** Called when an error occurs */
+    onError?: (error: OnrampError) => void;
+    /** Called when the flow step changes */
+    onStepChange?: (step: OnrampStep, previousStep: OnrampStep) => void;
+    /** Called when the user closes the flow (via ✕ or Done) */
+    onClose?: () => void;
+    /**
+     * Apple Pay merchant identifier (e.g. `merchant.com.your.app`). Defaults to empty — when empty,
+     * Apple Pay is hidden and `initStripe` is called without a merchant id.
+     */
+    merchantIdentifier?: string;
+    /** URL scheme for Stripe redirects (default: "unifoldOnramp") */
+    urlScheme?: string;
+}
+/**
+ * High-level Stripe Onramp component.
+ *
+ * Handles all the plumbing automatically:
+ * - Reads the Unifold publishable key from UnifoldProvider context
+ * - Fetches the Stripe publishable key from the Unifold API
+ * - Wraps in StripeProvider
+ * - Eagerly configures the Stripe Onramp SDK
+ * - Renders OnrampScreen with the config
+ *
+ * Usage:
+ * ```tsx
+ * <StripeOnramp
+ *   email={user.email}
+ *   externalUserId={user.id}
+ *   onClose={() => navigation.goBack()}
+ * />
+ * ```
+ */
+declare function StripeOnramp({ publishableKey, email, phone, externalUserId, flowOrder, destinationChainType, destinationChainId, destinationTokenAddress, recipientAddress, onComplete, onError, onStepChange, onClose, merchantIdentifier, urlScheme, }: StripeOnrampProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Render inside StripeOnramp after initStripe() has completed.
+ * Eagerly calls configure() so the Onramp SDK is ready by the time
+ * useStripeOnramp needs it. Renders nothing.
+ */
+declare function StripeOnrampPreconfigure(): null;
+
+export { AmountScreen, type CreateSessionParams, type CustomerVerification, type KYCData, KYCWizardScreen, type OnrampConfig, type OnrampCustomer, type OnrampError, type OnrampErrorCode, OnrampScreen, type OnrampSession, type OnrampSessionTransactionDetails, type OnrampStep, type OnrampTransaction, StripeOnramp, type StripeOnrampHook, StripeOnrampPreconfigure, type StripeOnrampProps, getStripePublishableKey, setStripeOnrampApiUrl, setStripeOnrampPublishableKey, useStripeOnramp };