@unifold/connect-react-native 0.1.19 → 0.1.21

package/dist/index.d.ts

@@ -0,0 +1,464 @@
+// Generated by dts-bundle-generator v9.5.1
+
+import React$1 from 'react';
+import { ReactNode } from 'react';
+
+declare const defaultColors: {
+	light: {
+		background: string;
+		card: string;
+		cardHover: string;
+		foreground: string;
+		foregroundMuted: string;
+		foregroundSubtle: string;
+		border: string;
+		borderSecondary: string;
+		primary: string;
+		primaryForeground: string;
+		success: string;
+		successBackground: string;
+		warning: string;
+		warningBackground: string;
+		error: string;
+		errorBackground: string;
+		overlay: string;
+	};
+	dark: {
+		background: string;
+		card: string;
+		cardHover: string;
+		foreground: string;
+		foregroundMuted: string;
+		foregroundSubtle: string;
+		border: string;
+		borderSecondary: string;
+		primary: string;
+		primaryForeground: string;
+		success: string;
+		successBackground: string;
+		warning: string;
+		warningBackground: string;
+		error: string;
+		errorBackground: string;
+		overlay: string;
+	};
+};
+export type ThemeColors = typeof defaultColors.light;
+export type ThemeMode = "light" | "dark";
+/** Partial theme colors for customization */
+export type CustomThemeColors = Partial<ThemeColors>;
+/** Theme customization options */
+export interface ThemeConfig {
+	/** Override colors for light mode */
+	light?: CustomThemeColors;
+	/** Override colors for dark mode */
+	dark?: CustomThemeColors;
+}
+/** Font configuration */
+export interface FontConfig {
+	/** Regular weight font family */
+	regular?: string;
+	/** Medium weight font family */
+	medium?: string;
+	/** Semi-bold weight font family */
+	semibold?: string;
+	/** Bold weight font family */
+	bold?: string;
+}
+/** Header component tokens */
+export interface HeaderTokens {
+	titleColor: string;
+	buttonColor: string;
+}
+/** Shadow style for card/sheet */
+export interface ThemeShadowStyle {
+	width: number;
+	height: number;
+}
+/** Back shadow offset (absolute inset values for the view behind the card) */
+export interface ThemeBackShadowOffset {
+	top: number;
+	left: number;
+	right: number;
+	bottom: number;
+}
+/** Card/row component tokens (colors + optional border/shadow) */
+export interface CardTokens {
+	backgroundColor: string;
+	titleColor: string;
+	subtitleColor: string;
+	labelColor: string;
+	headerColor: string;
+	labelRightColor: string;
+	labelHighlightRightColor: string;
+	textRightColor: string;
+	subtextRightColor: string;
+	rowLeftLabel: string;
+	rowRightLabel: string;
+	iconColor: string;
+	iconBackgroundColor: string;
+	actionColor: string;
+	actionIcon: string;
+	descriptionColor: string;
+	/** Card/row border radius (default 12) */
+	borderRadius: number;
+	/** Card border width (default 0) */
+	borderWidth: number;
+	/** Card border color */
+	borderColor: string;
+	/** Card shadow color */
+	shadowColor: string;
+	/** Card shadow offset */
+	shadowOffset: ThemeShadowStyle;
+	/** Card shadow opacity (0 = no shadow) */
+	shadowOpacity: number;
+	/** Card shadow radius */
+	shadowRadius: number;
+	/** Android elevation */
+	elevation: number;
+	/** Icon container (e.g. detail icon) border radius (default 12) */
+	iconContainerBorderRadius: number;
+	/** Back shadow: color of the view behind the card (default 'transparent' = no back shadow) */
+	backShadowColor: string;
+	/** Back shadow: offset of the view behind the card (default { top: 4, left: 4, right: -4, bottom: -4 }) */
+	backShadowOffset: ThemeBackShadowOffset;
+	/** Extra vertical spacing below the card when back shadow is used (default 8) */
+	backShadowSpacing: number;
+}
+/** Input component tokens */
+export interface InputTokens {
+	backgroundColor: string;
+	textColor: string;
+	placeholderColor: string;
+	borderColor: string;
+	/** Input border radius (default 8) */
+	borderRadius: number;
+	/** Input border width (default 1) */
+	borderWidth: number;
+}
+/** Button component tokens */
+export interface ButtonTokens {
+	primaryBackground: string;
+	primaryText: string;
+	secondaryBackground: string;
+	secondaryText: string;
+	/** Button border radius (default 12) */
+	borderRadius: number;
+	/** Button border width (default 0) */
+	borderWidth: number;
+	/** Button border color (outline/secondary) */
+	borderColor: string;
+}
+/** Badge/tag component tokens */
+export interface BadgeTokens {
+	/** Badge border radius (default 8) */
+	borderRadius: number;
+}
+/** Container/status display component tokens */
+export interface ContainerTokens {
+	titleColor: string;
+	subtitleColor: string;
+	actionColor: string;
+	actionTitle: string;
+	buttonColor: string;
+	buttonTitleColor: string;
+	iconBackgroundColor: string;
+	iconColor: string;
+}
+/** Search component tokens */
+export interface SearchTokens {
+	backgroundColor: string;
+	inputColor: string;
+	placeholderColor: string;
+	/** Search container border radius (default 8) */
+	borderRadius: number;
+}
+/** Sheet (modal) shadow tokens – e.g. BottomSheet */
+export interface SheetTokens {
+	shadowColor: string;
+	shadowOffset: ThemeShadowStyle;
+	shadowOpacity: number;
+	shadowRadius: number;
+	elevation: number;
+}
+/** List component tokens */
+export interface ListTokens {
+	titleSectionColor: string;
+	/** List row border radius (default 12) */
+	rowBorderRadius: number;
+}
+/** Per-surface card overrides (config input) */
+export interface DepositMenuOverrides {
+	card?: Partial<CardTokens>;
+}
+export interface TransferCryptoOverrides {
+	depositAddress?: {
+		card?: Partial<CardTokens>;
+	};
+}
+export interface DepositCardOverrides {
+	quoteProvider?: {
+		card?: Partial<CardTokens>;
+	};
+}
+export interface DepositTrackerOverrides {
+	executionRow?: {
+		card?: Partial<CardTokens>;
+	};
+}
+/** Per-mode overrides including per-surface card overrides */
+export interface ComponentOverridesWithSurfaces {
+	depositMenu?: DepositMenuOverrides;
+	transferCrypto?: TransferCryptoOverrides;
+	depositCard?: DepositCardOverrides;
+	depositTracker?: DepositTrackerOverrides;
+}
+/** Per-component overrides structure */
+export interface ComponentOverrides {
+	header?: Partial<HeaderTokens>;
+	card?: Partial<CardTokens>;
+	input?: Partial<InputTokens>;
+	button?: Partial<ButtonTokens>;
+	container?: Partial<ContainerTokens>;
+	search?: Partial<SearchTokens>;
+	list?: Partial<ListTokens>;
+	badge?: Partial<BadgeTokens>;
+	sheet?: Partial<SheetTokens>;
+}
+/**
+ * User-provided component overrides (all optional).
+ * Use flat keys (card, button, ...) for global tokens, or per-surface keys to style
+ * specific card surfaces (deposit menu, transfer crypto address box, quote provider, tracker rows).
+ */
+export interface ComponentConfig extends ComponentOverrides, ComponentOverridesWithSurfaces {
+	/** Light mode specific overrides */
+	light?: ComponentOverrides & ComponentOverridesWithSurfaces;
+	/** Dark mode specific overrides */
+	dark?: ComponentOverrides & ComponentOverridesWithSurfaces;
+}
+export interface BorderRadiusConfig {
+	borderTopLeftRadius?: number;
+	borderTopRightRadius?: number;
+}
+/** Controls which transfer crypto input variant is rendered */
+export type TransferInputVariant = "single_input" | "double_input";
+export interface DepositModalProps {
+	/** Whether the modal is visible */
+	visible: boolean;
+	/** Callback when the modal should close */
+	onClose: () => void;
+	/** User ID for the deposit */
+	externalUserId: string;
+	/** Publishable API key */
+	publishableKey: string;
+	/** Custom modal title */
+	modalTitle?: string;
+	/** Target token symbol (e.g., "USDC") */
+	destinationTokenSymbol?: string;
+	/** Recipient wallet address */
+	recipientAddress?: string;
+	/** Target chain type */
+	destinationChainType?: "ethereum" | "solana" | "bitcoin";
+	/** Target chain ID (e.g., "137" for Polygon) */
+	destinationChainId?: string;
+	/** Target token contract address */
+	destinationTokenAddress?: string;
+	/** Default source chain type to pre-select in UI */
+	defaultChainType?: "ethereum" | "solana" | "bitcoin";
+	/** Default source chain ID to pre-select in UI (e.g., "137" for Polygon) */
+	defaultChainId?: string;
+	/** Default source token address to pre-select in UI */
+	defaultTokenAddress?: string;
+	/** Show recipient's destination token balance in the header */
+	showBalance?: boolean;
+	/** Hide the deposit tracker button */
+	hideDepositTracker?: boolean;
+	/** Show "Pay with Link" (Stripe) option in the deposit menu */
+	enableStripeLinkPay?: boolean;
+	/** Injected StripeOnramp component — avoids bundling Stripe into the main entry */
+	StripeOnrampComponent?: React$1.ComponentType<any>;
+	/** Pre-fills Stripe Link Pay email (forwarded as `email` on `StripeOnramp`) */
+	stripeOnrampEmail?: string;
+	/** Pre-fills Stripe Link Pay phone (forwarded as `phone` on `StripeOnramp`) */
+	stripeOnrampPhone?: string;
+	/**
+	 * How deposit confirmation is handled: auto_ui (show waiting UI + poll after 10s),
+	 * auto_silent (poll after 10s, no waiting UI), manual ("I've deposited" button starts polling).
+	 */
+	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;
+	/** Callback when deposit succeeds */
+	onDepositSuccess?: (data: {
+		message: string;
+		executionId?: string;
+	}) => void;
+	/** Callback when deposit fails */
+	onDepositError?: (error: {
+		message: string;
+		error?: unknown;
+		code?: string;
+	}) => void;
+	/** Theme mode: 'light', 'dark', or 'auto' */
+	theme?: ThemeMode | "auto";
+	/** Border radius configuration for all bottom sheets */
+	sheetBorderRadius?: {
+		/** Default top-left corner radius for all bottom sheets (default: 24) */
+		globalBorderTopLeftRadius?: number;
+		/** Default top-right corner radius for all bottom sheets (default: 24) */
+		globalBorderTopRightRadius?: number;
+		/** The main deposit modal sheet */
+		main?: BorderRadiusConfig;
+		/** Transfer crypto wrapper sheet */
+		transferCrypto?: BorderRadiusConfig;
+		/** Buy with card wrapper sheet */
+		buyWithCard?: BorderRadiusConfig;
+		/** Deposits tracker modal */
+		depositsTracker?: BorderRadiusConfig;
+		/** Token selector sheet (inside transfer crypto) */
+		tokenSelector?: BorderRadiusConfig;
+		/** Chain selector sheet (inside transfer crypto, double_input variant) */
+		chainSelector?: BorderRadiusConfig;
+		/** Currency selector modal (inside buy with card) */
+		currencyModal?: BorderRadiusConfig;
+		/** Provider selection modal (inside buy with card) */
+		providerModal?: BorderRadiusConfig;
+		/** Deposit status sheet */
+		depositStatus?: BorderRadiusConfig;
+		/** Price impact & slippage info sheet */
+		infoSheet?: BorderRadiusConfig;
+		/** WebView sheet (inside buy with card) */
+		webView?: BorderRadiusConfig;
+	};
+}
+/**
+ * Set development API URL (only works in __DEV__ mode)
+ * For internal Unifold developers testing against localhost
+ */
+export declare function setDevApiUrl(url: string): void;
+/**
+ * Result of the useAllowedCountry hook
+ */
+export interface AllowedCountryResult {
+	/** Whether the user is in an allowed country. null while loading. */
+	isAllowed: boolean | null;
+	/** ISO 3166-1 alpha-2 country code in lowercase (e.g., "us", "pt") */
+	alpha2: string | null;
+	/** Full country name (e.g., "United States", "Portugal") */
+	country: string | null;
+	/** Whether the hook is still loading data */
+	isLoading: boolean;
+	/** Error if either API call failed */
+	error: Error | null;
+}
+/**
+ * Hook to determine if the current user is in an allowed country
+ *
+ * Combines the IP geolocation API with the project's blocked countries configuration
+ * to determine if the user should be allowed to access geo-restricted features.
+ *
+ * @param publishableKey - Publishable key for API calls
+ * @param enabled - Whether to enable the check (defaults to true)
+ * @returns AllowedCountryResult with isAllowed status and location info
+ *
+ * @example
+ * ```tsx
+ * function MyComponent() {
+ *   const { isAllowed, alpha2, country, isLoading, error } = useAllowedCountry(publishableKey);
+ *
+ *   if (isLoading) return <LoadingSpinner />;
+ *   if (error) return <ErrorMessage error={error} />;
+ *   if (!isAllowed) return <GeoBlockedView country={country} />;
+ *
+ *   return <YourContent />;
+ * }
+ * ```
+ */
+export declare function useAllowedCountry(publishableKey: string, enabled?: boolean): AllowedCountryResult;
+/**
+ * Register the StripeOnramp component so the deposit menu can render it.
+ * Called automatically by `@unifold/connect-react-native/stripe` when imported,
+ * or manually by the consumer.
+ *
+ * Uses globalThis so the registration survives across separately-bundled entries
+ * (tsup bundles index.js and stripe.js with splitting:false, creating isolated scopes).
+ */
+export declare function registerStripeOnramp(component: React$1.ComponentType<any>): void;
+export interface UnifoldConnectProviderConfig {
+	publishableKey: string;
+	config?: {
+		modalTitle?: string;
+		hideDepositTracker?: boolean;
+		/** Theme appearance: 'light', 'dark', or 'auto' (system preference). Defaults to 'dark' */
+		appearance?: ThemeMode | "auto";
+		/** Transfer input variant: 'single_input' (unified selector) or 'double_input' (separate token/chain). Defaults to 'double_input' */
+		transferInputVariant?: TransferInputVariant;
+		/** Simple accent/primary color override (applies to both light and dark modes) */
+		accentColor?: string;
+		/** Full theme color customization per mode */
+		theme?: ThemeConfig;
+		/** Single font family for all text (host app must load the font) */
+		fontFamily?: string;
+		/** Granular font family configuration for different weights */
+		fonts?: FontConfig;
+		/** Component-specific token overrides */
+		components?: ComponentConfig;
+		/** Border radius configuration for all bottom sheets */
+		sheetBorderRadius?: DepositModalProps["sheetBorderRadius"];
+		/**
+		 * Show "Pay with Link" (Stripe) option in the deposit menu.
+		 * Requires `import "@unifold/connect-react-native/stripe"` in your app entry
+		 * and `@stripe/stripe-react-native` to be installed.
+		 */
+		enableStripeLinkPay?: boolean;
+	};
+}
+export interface DepositResult {
+	message: string;
+	transaction?: unknown;
+	executionId?: string;
+}
+export interface DepositError {
+	message: string;
+	error?: unknown;
+	code?: string;
+}
+export interface DepositConfig {
+	externalUserId: string;
+	destinationChainType?: "ethereum" | "solana" | "bitcoin";
+	destinationChainId?: string;
+	destinationTokenAddress?: string;
+	destinationTokenSymbol?: string;
+	recipientAddress?: string;
+	defaultChainType?: "ethereum" | "solana" | "bitcoin";
+	defaultChainId?: string;
+	defaultTokenAddress?: string;
+	showBalance?: boolean;
+	/** Pre-fills Stripe Link Pay email step (deposit menu → Pay with Stripe Link) */
+	stripeOnrampEmail?: string;
+	/** Pre-fills Stripe Link Pay phone; with `stripeOnrampEmail`, can skip verify steps per Stripe flow */
+	stripeOnrampPhone?: string;
+	/**
+	 * How deposit confirmation and waiting behavior is handled.
+	 * - auto_ui (default): Automatically show "Processing deposit" UI and start polling after 10s. No "I've deposited" button.
+	 * - auto_silent: Automatically start polling after 10s. Do not show waiting UI (host controls UI).
+	 * - manual: Show "I've deposited" button. Clicking enters waiting UI and starts polling. No automatic polling.
+	 */
+	depositConfirmationMode?: "auto_ui" | "auto_silent" | "manual";
+	onSuccess?: (data: DepositResult) => void;
+	onError?: (error: DepositError) => void;
+}
+export interface ConnectContextValue {
+	publishableKey: string;
+	beginDeposit: (config: DepositConfig) => Promise<DepositResult>;
+	closeDeposit: () => void;
+}
+export interface UnifoldProviderProps {
+	children: React$1.ReactNode;
+	publishableKey: string;
+	config?: UnifoldConnectProviderConfig["config"];
+}
+export declare function UnifoldProvider({ children, publishableKey, config, }: UnifoldProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useUnifold(): ConnectContextValue;
+
+export {};