@unifold/connect-react 0.1.34 → 0.1.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -134,6 +134,7 @@ Launches the deposit modal with the specified configuration. **Returns a Promise
134
134
  | `recipientAddress` | string | ✅ | Recipient wallet address |
135
135
  | `onSuccess` | function | - | Success callback (fired immediately) |
136
136
  | `onError` | function | - | Error callback (fired immediately) |
137
+ | `initialScreen` | `'main' \| 'transfer' \| 'card' \| 'tracker'` | - | `main` (default) = deposit menu. `transfer` / `card` use the **same geo/validation gates** as the menu. `tracker` opens the list **without** those gates. If not `main`, the header **back** is hidden (standalone); from `main`, back returns to the menu. Card quotes/onramp and tracker detail still show back for inner steps. |
137
138
 
138
139
  **Returns:** `Promise<DepositResult>`
139
140
 
@@ -172,6 +173,16 @@ try {
172
173
  console.error('Error:', error);
173
174
  }
174
175
 
176
+ // Standalone Transfer Crypto (geo checks + no back to menu by default)
177
+ await beginDeposit({
178
+ externalUserId: 'user_123',
179
+ destinationChainId: '137',
180
+ destinationTokenAddress: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174',
181
+ destinationTokenSymbol: 'USDC',
182
+ recipientAddress: '0x606C49ca2Fa4982F07016265040F777eD3DA3160',
183
+ initialScreen: 'transfer',
184
+ });
185
+
175
186
  // Hybrid (promise + callbacks)
176
187
  const depositPromise = beginDeposit({
177
188
  userId: 'user_123',
package/dist/index.d.mts CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import React from 'react';
3
- import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
4
- export { AllowedCountryResult, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ContainerTokens, CustomThemeColors, DepositConfirmationMode, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
3
+ import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
4
+ export { AllowedCountryResult, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
5
5
  export { AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SupportedChain, SupportedDepositTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, setApiConfig, useUserIp } from '@unifold/core';
6
6
 
7
7
  interface UnifoldConnectProviderConfig {
@@ -29,6 +29,8 @@ interface UnifoldConnectProviderConfig {
29
29
  fonts?: FontConfig;
30
30
  /** Component-specific token overrides */
31
31
  components?: ComponentConfig;
32
+ /** Default `initialScreen` for `beginDeposit()` when the call omits it */
33
+ defaultInitialScreen?: DepositModalInitialScreen;
32
34
  };
33
35
  }
34
36
  interface DepositResult {
@@ -54,6 +56,13 @@ interface DepositConfig {
54
56
  onError?: (error: DepositError) => void;
55
57
  /** Called when the user dismisses the deposit dialog (X button, Escape key, or programmatic close) */
56
58
  onClose?: () => void;
59
+ /**
60
+ * Which screen opens first: menu (`main`, default), `transfer`, `card`, or `tracker`.
61
+ * `transfer` and `card` run the same geo / recipient checks as the menu before the flow. `tracker` does not
62
+ * (deposit history is always reachable). If not `main`, the header back control is hidden (nothing to return to);
63
+ * card quotes/onramp and tracker detail still show back for inner navigation.
64
+ */
65
+ initialScreen?: DepositModalInitialScreen;
57
66
  }
58
67
  declare function UnifoldProvider({ children, publishableKey, config, }: React.PropsWithChildren<UnifoldConnectProviderConfig>): react_jsx_runtime.JSX.Element;
59
68
  declare function useUnifold(): {
package/dist/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
2
  import React from 'react';
3
- import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
4
- export { AllowedCountryResult, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ContainerTokens, CustomThemeColors, DepositConfirmationMode, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
3
+ import { ThemeMode, ThemeConfig, FontConfig, ComponentConfig, DepositModalInitialScreen, ChainType, DepositConfirmationMode, AllowedCountryResult } from '@unifold/ui-react';
4
+ export { AllowedCountryResult, Button, ButtonProps, ButtonTokens, CardTokens, ComponentConfig, ComponentTokens, ContainerTokens, CustomThemeColors, DepositConfirmationMode, DepositModalInitialScreen as DepositInitialScreen, FontConfig, HeaderTokens, InputTokens, ListTokens, SearchTokens, ThemeColors, ThemeConfig, ThemeMode } from '@unifold/ui-react';
5
5
  export { AutoSwapRequest, AutoSwapResponse, ChainType, CreateDepositAddressRequest, DefaultTokenChain, DefaultTokenMetadata, DefaultTokenResponse, DepositAddressResponse, ExecutionStatus, FeaturedToken, FiatCurrenciesResponse, FiatCurrency, I18nStrings, IconUrl, IpAddressResponse, OnrampQuote, OnrampQuotesRequest, OnrampQuotesResponse, OnrampSessionRequest, OnrampSessionResponse, PaymentNetwork, ProjectConfigResponse, QueryExecutionsRequest, QueryExecutionsResponse, SOLANA_USDC_ADDRESS, SupportedChain, SupportedDepositTokensResponse, SupportedToken, TokenChain, TokenChainIconUrl, TokenChainsResponse, UserIpInfo, Wallet, createDepositAddress, createOnrampSession, getApiBaseUrl, getChainName, getDefaultOnrampToken, getFiatCurrencies, getIconUrl, getIconUrlWithCdn, getIpAddress, getOnrampQuotes, getPreferredIconUrl, getProjectConfig, getSupportedDepositTokens, getTokenChains, getWalletByChainType, i18n, queryExecutions, setApiConfig, useUserIp } from '@unifold/core';
6
6
 
7
7
  interface UnifoldConnectProviderConfig {
@@ -29,6 +29,8 @@ interface UnifoldConnectProviderConfig {
29
29
  fonts?: FontConfig;
30
30
  /** Component-specific token overrides */
31
31
  components?: ComponentConfig;
32
+ /** Default `initialScreen` for `beginDeposit()` when the call omits it */
33
+ defaultInitialScreen?: DepositModalInitialScreen;
32
34
  };
33
35
  }
34
36
  interface DepositResult {
@@ -54,6 +56,13 @@ interface DepositConfig {
54
56
  onError?: (error: DepositError) => void;
55
57
  /** Called when the user dismisses the deposit dialog (X button, Escape key, or programmatic close) */
56
58
  onClose?: () => void;
59
+ /**
60
+ * Which screen opens first: menu (`main`, default), `transfer`, `card`, or `tracker`.
61
+ * `transfer` and `card` run the same geo / recipient checks as the menu before the flow. `tracker` does not
62
+ * (deposit history is always reachable). If not `main`, the header back control is hidden (nothing to return to);
63
+ * card quotes/onramp and tracker detail still show back for inner navigation.
64
+ */
65
+ initialScreen?: DepositModalInitialScreen;
57
66
  }
58
67
  declare function UnifoldProvider({ children, publishableKey, config, }: React.PropsWithChildren<UnifoldConnectProviderConfig>): react_jsx_runtime.JSX.Element;
59
68
  declare function useUnifold(): {