@unifold/connect-react-native 0.1.30 → 0.1.32

package/dist/index.d.mts

@@ -190,6 +190,40 @@ interface ListTokens {
     /** List row border radius (default 12) */
     rowBorderRadius: number;
 }
+/** All resolved component tokens */
+interface ComponentTokens {
+    header: HeaderTokens;
+    card: CardTokens;
+    input: InputTokens;
+    button: ButtonTokens;
+    container: ContainerTokens;
+    search: SearchTokens;
+    list: ListTokens;
+    badge: BadgeTokens;
+    sheet: SheetTokens;
+    /** Card tokens for Add Funds menu options (Transfer Crypto, Deposit with Card, Deposit Tracker) */
+    depositMenu: {
+        card: CardTokens;
+    };
+    /** Card tokens for Transfer Crypto deposit address box */
+    transferCrypto: {
+        depositAddress: {
+            card: CardTokens;
+        };
+    };
+    /** Card tokens for Deposit with Card provider card and quote list rows */
+    depositCard: {
+        quoteProvider: {
+            card: CardTokens;
+        };
+    };
+    /** Card tokens for Deposit Tracker execution rows */
+    depositTracker: {
+        executionRow: {
+            card: CardTokens;
+        };
+    };
+}
 /** Per-surface card overrides (config input) */
 interface DepositMenuOverrides {
     card?: Partial<CardTokens>;
@@ -258,13 +292,47 @@ interface ThemeProviderProps {
 /** Same props as ThemeProvider without children — for re-wrapping subtrees (e.g. nested modals). */
 type ThemeProviderConfig = Omit<ThemeProviderProps, "children">;
 
+/** Resolved font families for use in styles */
+interface ResolvedFonts {
+    regular: string | undefined;
+    medium: string | undefined;
+    semibold: string | undefined;
+    bold: string | undefined;
+}
+interface ThemeContextValue {
+    mode: ThemeMode;
+    colors: ThemeColors;
+    fonts: ResolvedFonts;
+    components: ComponentTokens;
+    isDark: boolean;
+}
+declare function useTheme(): ThemeContextValue;
+
 interface BorderRadiusConfig {
     borderTopLeftRadius?: number;
     borderTopRightRadius?: number;
 }
+interface BottomSheetProps {
+    visible: boolean;
+    onClose: () => void;
+    children: React$1.ReactNode;
+    closeOnBackdropPress?: boolean;
+    showHandle?: boolean;
+    /** Height as percentage of screen (0-1), e.g. 0.9 for 90% */
+    heightPercent?: number;
+    /** Remove bottom safe area padding */
+    noPadding?: boolean;
+    /** Top-left corner radius (default: 24) */
+    borderTopLeftRadius?: number;
+    /** Top-right corner radius (default: 24) */
+    borderTopRightRadius?: number;
+}
+declare function BottomSheet({ visible, onClose, children, closeOnBackdropPress, showHandle, heightPercent, noPadding, borderTopLeftRadius, borderTopRightRadius, }: BottomSheetProps): react_jsx_runtime.JSX.Element;
 
 /** Controls which transfer crypto input variant is rendered */
 type TransferInputVariant = "single_input" | "double_input";
+/** Controls which screen opens first when the deposit modal is shown */
+type DepositInitialScreen = "main" | "transfer" | "card" | "tracker";
 interface DepositModalProps {
     /** Whether the modal is visible */
     visible: boolean;
@@ -323,6 +391,14 @@ interface DepositModalProps {
     depositConfirmationMode?: "auto_ui" | "auto_silent" | "manual";
     /** Transfer input variant: 'single_input' (unified selector) or 'double_input' (separate token/chain). Defaults to 'double_input' */
     transferInputVariant?: TransferInputVariant;
+    /**
+     * Which screen to open first. Defaults to 'main' (the option menu).
+     * - 'main': show the menu (default)
+     * - 'transfer': open Transfer Crypto immediately
+     * - 'card': open Buy with Card immediately
+     * - 'tracker': open Deposit Tracker immediately (ignored if hideDepositTracker is true)
+     */
+    initialScreen?: DepositInitialScreen;
     /** Callback when deposit succeeds */
     onDepositSuccess?: (data: {
         message: string;
@@ -373,6 +449,71 @@ interface DepositModalProps {
  * No-op when not `__DEV__`; empty / whitespace clears the override.
  */
 declare function setDevApiUrl(url: string): void;
+/**
+ * Normalize an icon URL from API response
+ * If the URL is relative (starts with /), prepend the API base URL
+ * If the URL contains localhost, replace with the configured API base URL
+ * If the URL is already absolute (starts with http), return as-is
+ */
+declare function normalizeIconUrl(iconUrl: string | undefined | null): string;
+interface IconUrl {
+    url: string;
+    format: "svg" | "png";
+}
+/**
+ * Get the preferred icon URL from an object with icon_url and icon_urls
+ * @param item - Object with icon_url and optional icon_urls array
+ * @param preferredFormat - Preferred format ("svg" or "png"), defaults to "svg"
+ * @returns The URL string for the preferred format, or icon_url as fallback
+ */
+declare function getPreferredIcon(item: {
+    icon_url: string;
+    icon_urls?: IconUrl[];
+} | undefined | null, preferredFormat?: "svg" | "png"): string;
+interface DestinationTokenChain {
+    chain_id: string;
+    chain_type: string;
+    chain_name: string;
+    icon_url: string;
+    icon_urls?: IconUrl[];
+    token_address: string;
+}
+interface DestinationToken {
+    symbol: string;
+    name: string;
+    icon_url: string;
+    icon_urls?: IconUrl[];
+    chains: DestinationTokenChain[];
+}
+interface SupportedDestinationTokensResponse {
+    data: DestinationToken[];
+}
+/**
+ * Get supported destination tokens for withdrawals
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getSupportedDestinationTokens(publishableKey?: string): Promise<SupportedDestinationTokensResponse>;
+
+interface WithdrawTransactionInfo {
+    sourceChainType: string;
+    sourceChainId: string;
+    sourceTokenAddress: string;
+    sourceTokenSymbol: string;
+    sourceTokenIconUrl?: string;
+    destinationChainType: string;
+    destinationChainId: string;
+    destinationTokenAddress: string;
+    destinationTokenSymbol: string;
+    destinationChainName?: string;
+    destinationTokenIconUrl?: string;
+    amount: string;
+    amountBaseUnit: string;
+    submittedAt?: Date;
+    /** The Unifold deposit wallet address to send funds to */
+    withdrawIntentAddress: string;
+    /** The user-provided final destination address */
+    recipientAddress: string;
+}
 
 /**
  * Result of the useAllowedCountry hook
@@ -490,13 +631,68 @@ interface DepositConfig {
      * - manual: Show "I've deposited" button. Clicking enters waiting UI and starts polling. No automatic polling.
      */
     depositConfirmationMode?: "auto_ui" | "auto_silent" | "manual";
+    /**
+     * Which screen to open first when the deposit modal appears.
+     * - 'main' (default): show the option menu
+     * - 'transfer': open Transfer Crypto immediately
+     * - 'card': open Buy with Card immediately
+     * - 'tracker': open Deposit Tracker immediately
+     */
+    initialScreen?: DepositInitialScreen;
     onSuccess?: (data: DepositResult) => void;
     onError?: (error: DepositError) => void;
 }
+interface WithdrawResult {
+    message: string;
+    transaction?: unknown;
+}
+interface WithdrawError {
+    message: string;
+    error?: unknown;
+    code?: string;
+}
+/**
+ * Configuration for beginWithdraw().
+ *
+ * The consumer must provide `withdraw` to handle the actual transaction
+ * signing and broadcasting. The SDK creates the intermediary deposit wallet
+ * and polls for execution completion.
+ *
+ * Source token/chain must be passed directly.
+ */
+interface WithdrawConfig {
+    externalUserId: string;
+    /** The user's wallet address — used to fetch balance. Wallet-agnostic: pass any address string. */
+    senderAddress: string;
+    /** Source token chain type (e.g. "ethereum") */
+    sourceChainType: "ethereum" | "solana" | "bitcoin";
+    /** Source token chain ID (e.g. "8453" for Base) */
+    sourceChainId: string;
+    /** Source token contract address */
+    sourceTokenAddress: string;
+    /** Source token symbol for display (e.g. "USDC") */
+    sourceTokenSymbol?: string;
+    /** Optional pre-fill for the recipient address field */
+    recipientAddress?: string;
+    /**
+     * Called when the user confirms withdrawal. The consumer is responsible for
+     * signing and broadcasting the transaction — matches the web SDK interface.
+     * @param txInfo - All information needed to construct the EVM/Solana transaction
+     */
+    withdraw: (txInfo: WithdrawTransactionInfo) => void | Promise<void>;
+    /** Called when the withdrawal execution reaches SUCCEEDED status */
+    onSuccess?: (data: WithdrawResult) => void;
+    /** Called on withdrawal errors */
+    onError?: (error: WithdrawError) => void;
+    /** Called when the user dismisses the withdraw modal */
+    onClose?: () => void;
+}
 interface ConnectContextValue {
     publishableKey: string;
     beginDeposit: (config: DepositConfig) => Promise<DepositResult>;
     closeDeposit: () => void;
+    beginWithdraw: (config: WithdrawConfig) => Promise<WithdrawResult>;
+    closeWithdraw: () => void;
 }
 interface UnifoldProviderProps {
     children: ReactNode;
@@ -506,4 +702,4 @@ interface UnifoldProviderProps {
 declare function UnifoldProvider({ children, publishableKey, config, }: UnifoldProviderProps): react_jsx_runtime.JSX.Element;
 declare function useUnifold(): ConnectContextValue;
 
-export { type AllowedCountryResult, type BorderRadiusConfig, type ComponentConfig, type CustomThemeColors, type DepositConfig, type DepositError, type DepositResult, type FontConfig, type ThemeColors, type ThemeConfig, type ThemeMode, type ThemeProviderConfig, type TransferInputVariant, type UnifoldConnectProviderConfig, UnifoldProvider, type UnifoldProviderProps, registerStripeOnramp, setDevApiUrl, useAllowedCountry, useUnifold };
+export { type AllowedCountryResult, type BorderRadiusConfig, BottomSheet, type ComponentConfig, type CustomThemeColors, type DepositConfig, type DepositError, type DepositInitialScreen, type DepositResult, type DestinationToken, type DestinationTokenChain, type FontConfig, type ThemeColors, type ThemeConfig, type ThemeMode, type ThemeProviderConfig, type TransferInputVariant, type UnifoldConnectProviderConfig, UnifoldProvider, type UnifoldProviderProps, type WithdrawConfig, type WithdrawError, type WithdrawResult, type WithdrawTransactionInfo, getPreferredIcon, getSupportedDestinationTokens, normalizeIconUrl, registerStripeOnramp, setDevApiUrl, useAllowedCountry, useTheme, useUnifold };

package/dist/index.d.ts

@@ -190,6 +190,40 @@ interface ListTokens {
     /** List row border radius (default 12) */
     rowBorderRadius: number;
 }
+/** All resolved component tokens */
+interface ComponentTokens {
+    header: HeaderTokens;
+    card: CardTokens;
+    input: InputTokens;
+    button: ButtonTokens;
+    container: ContainerTokens;
+    search: SearchTokens;
+    list: ListTokens;
+    badge: BadgeTokens;
+    sheet: SheetTokens;
+    /** Card tokens for Add Funds menu options (Transfer Crypto, Deposit with Card, Deposit Tracker) */
+    depositMenu: {
+        card: CardTokens;
+    };
+    /** Card tokens for Transfer Crypto deposit address box */
+    transferCrypto: {
+        depositAddress: {
+            card: CardTokens;
+        };
+    };
+    /** Card tokens for Deposit with Card provider card and quote list rows */
+    depositCard: {
+        quoteProvider: {
+            card: CardTokens;
+        };
+    };
+    /** Card tokens for Deposit Tracker execution rows */
+    depositTracker: {
+        executionRow: {
+            card: CardTokens;
+        };
+    };
+}
 /** Per-surface card overrides (config input) */
 interface DepositMenuOverrides {
     card?: Partial<CardTokens>;
@@ -258,13 +292,47 @@ interface ThemeProviderProps {
 /** Same props as ThemeProvider without children — for re-wrapping subtrees (e.g. nested modals). */
 type ThemeProviderConfig = Omit<ThemeProviderProps, "children">;
 
+/** Resolved font families for use in styles */
+interface ResolvedFonts {
+    regular: string | undefined;
+    medium: string | undefined;
+    semibold: string | undefined;
+    bold: string | undefined;
+}
+interface ThemeContextValue {
+    mode: ThemeMode;
+    colors: ThemeColors;
+    fonts: ResolvedFonts;
+    components: ComponentTokens;
+    isDark: boolean;
+}
+declare function useTheme(): ThemeContextValue;
+
 interface BorderRadiusConfig {
     borderTopLeftRadius?: number;
     borderTopRightRadius?: number;
 }
+interface BottomSheetProps {
+    visible: boolean;
+    onClose: () => void;
+    children: React$1.ReactNode;
+    closeOnBackdropPress?: boolean;
+    showHandle?: boolean;
+    /** Height as percentage of screen (0-1), e.g. 0.9 for 90% */
+    heightPercent?: number;
+    /** Remove bottom safe area padding */
+    noPadding?: boolean;
+    /** Top-left corner radius (default: 24) */
+    borderTopLeftRadius?: number;
+    /** Top-right corner radius (default: 24) */
+    borderTopRightRadius?: number;
+}
+declare function BottomSheet({ visible, onClose, children, closeOnBackdropPress, showHandle, heightPercent, noPadding, borderTopLeftRadius, borderTopRightRadius, }: BottomSheetProps): react_jsx_runtime.JSX.Element;
 
 /** Controls which transfer crypto input variant is rendered */
 type TransferInputVariant = "single_input" | "double_input";
+/** Controls which screen opens first when the deposit modal is shown */
+type DepositInitialScreen = "main" | "transfer" | "card" | "tracker";
 interface DepositModalProps {
     /** Whether the modal is visible */
     visible: boolean;
@@ -323,6 +391,14 @@ interface DepositModalProps {
     depositConfirmationMode?: "auto_ui" | "auto_silent" | "manual";
     /** Transfer input variant: 'single_input' (unified selector) or 'double_input' (separate token/chain). Defaults to 'double_input' */
     transferInputVariant?: TransferInputVariant;
+    /**
+     * Which screen to open first. Defaults to 'main' (the option menu).
+     * - 'main': show the menu (default)
+     * - 'transfer': open Transfer Crypto immediately
+     * - 'card': open Buy with Card immediately
+     * - 'tracker': open Deposit Tracker immediately (ignored if hideDepositTracker is true)
+     */
+    initialScreen?: DepositInitialScreen;
     /** Callback when deposit succeeds */
     onDepositSuccess?: (data: {
         message: string;
@@ -373,6 +449,71 @@ interface DepositModalProps {
  * No-op when not `__DEV__`; empty / whitespace clears the override.
  */
 declare function setDevApiUrl(url: string): void;
+/**
+ * Normalize an icon URL from API response
+ * If the URL is relative (starts with /), prepend the API base URL
+ * If the URL contains localhost, replace with the configured API base URL
+ * If the URL is already absolute (starts with http), return as-is
+ */
+declare function normalizeIconUrl(iconUrl: string | undefined | null): string;
+interface IconUrl {
+    url: string;
+    format: "svg" | "png";
+}
+/**
+ * Get the preferred icon URL from an object with icon_url and icon_urls
+ * @param item - Object with icon_url and optional icon_urls array
+ * @param preferredFormat - Preferred format ("svg" or "png"), defaults to "svg"
+ * @returns The URL string for the preferred format, or icon_url as fallback
+ */
+declare function getPreferredIcon(item: {
+    icon_url: string;
+    icon_urls?: IconUrl[];
+} | undefined | null, preferredFormat?: "svg" | "png"): string;
+interface DestinationTokenChain {
+    chain_id: string;
+    chain_type: string;
+    chain_name: string;
+    icon_url: string;
+    icon_urls?: IconUrl[];
+    token_address: string;
+}
+interface DestinationToken {
+    symbol: string;
+    name: string;
+    icon_url: string;
+    icon_urls?: IconUrl[];
+    chains: DestinationTokenChain[];
+}
+interface SupportedDestinationTokensResponse {
+    data: DestinationToken[];
+}
+/**
+ * Get supported destination tokens for withdrawals
+ * @param publishableKey - Optional publishable key, defaults to configured key
+ */
+declare function getSupportedDestinationTokens(publishableKey?: string): Promise<SupportedDestinationTokensResponse>;
+
+interface WithdrawTransactionInfo {
+    sourceChainType: string;
+    sourceChainId: string;
+    sourceTokenAddress: string;
+    sourceTokenSymbol: string;
+    sourceTokenIconUrl?: string;
+    destinationChainType: string;
+    destinationChainId: string;
+    destinationTokenAddress: string;
+    destinationTokenSymbol: string;
+    destinationChainName?: string;
+    destinationTokenIconUrl?: string;
+    amount: string;
+    amountBaseUnit: string;
+    submittedAt?: Date;
+    /** The Unifold deposit wallet address to send funds to */
+    withdrawIntentAddress: string;
+    /** The user-provided final destination address */
+    recipientAddress: string;
+}
 
 /**
  * Result of the useAllowedCountry hook
@@ -490,13 +631,68 @@ interface DepositConfig {
      * - manual: Show "I've deposited" button. Clicking enters waiting UI and starts polling. No automatic polling.
      */
     depositConfirmationMode?: "auto_ui" | "auto_silent" | "manual";
+    /**
+     * Which screen to open first when the deposit modal appears.
+     * - 'main' (default): show the option menu
+     * - 'transfer': open Transfer Crypto immediately
+     * - 'card': open Buy with Card immediately
+     * - 'tracker': open Deposit Tracker immediately
+     */
+    initialScreen?: DepositInitialScreen;
     onSuccess?: (data: DepositResult) => void;
     onError?: (error: DepositError) => void;
 }
+interface WithdrawResult {
+    message: string;
+    transaction?: unknown;
+}
+interface WithdrawError {
+    message: string;
+    error?: unknown;
+    code?: string;
+}
+/**
+ * Configuration for beginWithdraw().
+ *
+ * The consumer must provide `withdraw` to handle the actual transaction
+ * signing and broadcasting. The SDK creates the intermediary deposit wallet
+ * and polls for execution completion.
+ *
+ * Source token/chain must be passed directly.
+ */
+interface WithdrawConfig {
+    externalUserId: string;
+    /** The user's wallet address — used to fetch balance. Wallet-agnostic: pass any address string. */
+    senderAddress: string;
+    /** Source token chain type (e.g. "ethereum") */
+    sourceChainType: "ethereum" | "solana" | "bitcoin";
+    /** Source token chain ID (e.g. "8453" for Base) */
+    sourceChainId: string;
+    /** Source token contract address */
+    sourceTokenAddress: string;
+    /** Source token symbol for display (e.g. "USDC") */
+    sourceTokenSymbol?: string;
+    /** Optional pre-fill for the recipient address field */
+    recipientAddress?: string;
+    /**
+     * Called when the user confirms withdrawal. The consumer is responsible for
+     * signing and broadcasting the transaction — matches the web SDK interface.
+     * @param txInfo - All information needed to construct the EVM/Solana transaction
+     */
+    withdraw: (txInfo: WithdrawTransactionInfo) => void | Promise<void>;
+    /** Called when the withdrawal execution reaches SUCCEEDED status */
+    onSuccess?: (data: WithdrawResult) => void;
+    /** Called on withdrawal errors */
+    onError?: (error: WithdrawError) => void;
+    /** Called when the user dismisses the withdraw modal */
+    onClose?: () => void;
+}
 interface ConnectContextValue {
     publishableKey: string;
     beginDeposit: (config: DepositConfig) => Promise<DepositResult>;
     closeDeposit: () => void;
+    beginWithdraw: (config: WithdrawConfig) => Promise<WithdrawResult>;
+    closeWithdraw: () => void;
 }
 interface UnifoldProviderProps {
     children: ReactNode;
@@ -506,4 +702,4 @@ interface UnifoldProviderProps {
 declare function UnifoldProvider({ children, publishableKey, config, }: UnifoldProviderProps): react_jsx_runtime.JSX.Element;
 declare function useUnifold(): ConnectContextValue;
 
-export { type AllowedCountryResult, type BorderRadiusConfig, type ComponentConfig, type CustomThemeColors, type DepositConfig, type DepositError, type DepositResult, type FontConfig, type ThemeColors, type ThemeConfig, type ThemeMode, type ThemeProviderConfig, type TransferInputVariant, type UnifoldConnectProviderConfig, UnifoldProvider, type UnifoldProviderProps, registerStripeOnramp, setDevApiUrl, useAllowedCountry, useUnifold };
+export { type AllowedCountryResult, type BorderRadiusConfig, BottomSheet, type ComponentConfig, type CustomThemeColors, type DepositConfig, type DepositError, type DepositInitialScreen, type DepositResult, type DestinationToken, type DestinationTokenChain, type FontConfig, type ThemeColors, type ThemeConfig, type ThemeMode, type ThemeProviderConfig, type TransferInputVariant, type UnifoldConnectProviderConfig, UnifoldProvider, type UnifoldProviderProps, type WithdrawConfig, type WithdrawError, type WithdrawResult, type WithdrawTransactionInfo, getPreferredIcon, getSupportedDestinationTokens, normalizeIconUrl, registerStripeOnramp, setDevApiUrl, useAllowedCountry, useTheme, useUnifold };