@openfort/react-native 0.1.21 → 0.1.23

package/dist/types/hooks/auth/useGuestAuth.d.ts

@@ -7,24 +7,34 @@ export type GuestHookResult = {
 };
 export type GuestHookOptions = OpenfortHookOptions<GuestHookResult>;
 /**
- * Hook for creating guest accounts.
+ * Hook for guest account authentication.
  *
- * Guest accounts allow users to access certain features without full authentication and can later be upgraded to full accounts
- * by linking additional authentication methods.
+ * This hook provides functionality for creating anonymous guest accounts that allow
+ * users to access features without full authentication. Guest accounts can later be
+ * upgraded to permanent accounts by linking email, OAuth, or wallet authentication.
  *
- * @param hookOptions - Configuration options including success and error callbacks.
- * @returns Current guest authentication helpers with flow status indicators.
+ * @param hookOptions - Configuration options including success and error callbacks
+ * @returns Guest authentication method and flow state including:
+ *   - `signUpGuest` - Create anonymous guest account
+ *   - `isLoading` - Whether guest account creation is in progress
+ *   - `isError` - Whether guest account creation failed
+ *   - `isSuccess` - Whether guest account was created successfully
+ *   - `error` - Error from the last failed operation
  *
  * @example
  * ```tsx
  * const { signUpGuest, isLoading } = useGuestAuth({
- *   onSuccess: ({ user }) => console.log('Guest account created:', user),
+ *   onSuccess: ({ user }) => console.log('Guest account created:', user?.id),
  *   onError: ({ error }) => console.error('Failed to create guest account:', error),
  * });
  *
+ * // Create guest account for anonymous access
  * if (!isLoading) {
  *   await signUpGuest();
  * }
+ *
+ * // Later, upgrade to permanent account by linking authentication
+ * // Use linkEmail, linkOauth, or linkSiwe from other hooks
  * ```
  */
 export declare const useGuestAuth: (hookOptions?: GuestHookOptions) => {

package/dist/types/hooks/auth/useOAuth.d.ts

@@ -20,15 +20,24 @@ export type AuthHookOptions = {
 /**
  * Hook for OAuth-based authentication with supported providers.
  *
- * This hook provides helpers for starting OAuth login flows (`initOAuth`) and linking
- * additional providers to an authenticated user (`linkOauth`). Some advanced flows may
- * require manual credential storage via `storeCredentials`, which is currently a TODO.
+ * This hook provides OAuth authentication flows including login and account linking
+ * for various OAuth providers (Google, Apple, Discord, Twitter, Facebook, etc.).
+ * Supports both web-based OAuth flows and native Apple Sign-In on iOS.
  *
- * @param hookOptions - Configuration options including success and error callbacks.
- * @returns OAuth helpers and derived flow state flags.
+ * @param hookOptions - Configuration options including success and error callbacks
+ * @returns OAuth authentication methods and flow state including:
+ *   - `initOAuth` - Start OAuth login flow for authentication
+ *   - `linkOauth` - Link additional OAuth provider to authenticated account
+ *   - `storeCredentials` - (Reserved for future use)
+ *   - `isLoading` - Whether OAuth flow is in progress
+ *   - `isError` - Whether the last OAuth flow failed
+ *   - `isSuccess` - Whether the last OAuth flow succeeded
+ *   - `error` - Error from the last failed OAuth operation
  *
  * @example
  * ```tsx
+ * import { OAuthProvider } from '@openfort/openfort-js';
+ *
  * const { initOAuth, linkOauth, isLoading, isError, error } = useOAuth({
  *   onSuccess: ({ user }) => console.log('OAuth completed for', user?.id),
  * });

package/dist/types/hooks/auth/useWalletAuth.d.ts

@@ -31,28 +31,47 @@ type GenerateSiweMessageResult = {
     message?: string;
 };
 /**
- * Hook for handling Sign-In With Ethereum (SIWE) flows.
+ * Hook for Sign-In With Ethereum (SIWE) authentication flows.
  *
- * This hook orchestrates SIWE message generation, signature submission, and state
- * tracking so that external wallets can either authenticate a user (`signInWithSiwe`)
- * or be linked to an existing account (`linkSiwe`).
+ * This hook provides SIWE authentication functionality allowing users to authenticate
+ * or link accounts using their external Ethereum wallets. It handles message generation,
+ * signature verification, and state management throughout the authentication flow.
  *
- * @param hookOptions - Optional callbacks for handling success or error events from the SIWE flows.
- * @returns SIWE helpers for generating messages, signing in, linking wallets, and inspecting flow status.
+ * @param hookOptions - Optional callbacks for handling success or error events from SIWE flows
+ * @returns SIWE authentication methods and flow state including:
+ *   - `generateSiweMessage` - Generate SIWE message for wallet to sign
+ *   - `signInWithSiwe` - Authenticate user with signed SIWE message
+ *   - `linkSiwe` - Link external wallet to existing authenticated account
+ *   - `isLoading` - Whether a SIWE operation is in progress
+ *   - `isError` - Whether the last SIWE operation failed
+ *   - `isSuccess` - Whether the last SIWE operation succeeded
+ *   - `isAwaitingSignature` - Whether waiting for user to sign message
+ *   - `isGeneratingMessage` - Whether generating SIWE message
+ *   - `isSubmittingSignature` - Whether submitting signature to server
+ *   - `error` - Error from the last failed operation
  *
  * @example
  * ```tsx
- * const { generateSiweMessage, signInWithSiwe, linkSiwe, isAwaitingSignature } = useWalletAuth({
- *   onSuccess: ({ user }) => console.log('SIWE flow completed for', user?.id),
+ * // Using with an external wallet like WalletConnect or MetaMask
+ * const { generateSiweMessage, signInWithSiwe, isAwaitingSignature } = useWalletAuth({
+ *   onSuccess: ({ user }) => console.log('SIWE authentication successful:', user?.id),
  * });
  *
+ * // Step 1: Generate SIWE message
  * const { message } = await generateSiweMessage({
  *   wallet: connectedWallet.address,
- *   from: { domain: 'app.openfort.io', uri: 'https://app.openfort.io' },
+ *   from: { domain: 'myapp.com', uri: 'https://myapp.com' },
  * });
  *
+ * // Step 2: Request signature from user's wallet
  * const signature = await connectedWallet.signMessage(message);
- * await signInWithSiwe({ walletAddress: connectedWallet.address, signature, messageOverride: message });
+ *
+ * // Step 3: Authenticate with signed message
+ * await signInWithSiwe({
+ *   walletAddress: connectedWallet.address,
+ *   signature,
+ *   messageOverride: message
+ * });
  * ```
  */
 export declare function useWalletAuth(hookOptions?: WalletHookOptions): {

package/dist/types/hooks/wallet/solanaProvider.d.ts

@@ -1,17 +1,5 @@
 import type { EmbeddedAccount } from '@openfort/openfort-js';
-import type { OpenfortEmbeddedSolanaWalletProvider } from '../../types/wallet';
-type SignMessageRequestArguments = {
-    method: 'signMessage';
-    params: {
-        message: string;
-    };
-};
-type SignTransactionRequestArguments<T = any> = {
-    method: 'signTransaction';
-    params: {
-        transaction: T;
-    };
-};
+import type { OpenfortEmbeddedSolanaWalletProvider, SignedSolanaTransaction, SolanaSignMessageRequest, SolanaSignTransactionRequest, SolanaTransaction } from '../../types/wallet';
 /**
  * Embedded Solana wallet provider implementation for Openfort.
  *
@@ -38,8 +26,8 @@ export declare class OpenfortSolanaProvider implements OpenfortEmbeddedSolanaWal
      */
     constructor(params: {
         account: EmbeddedAccount;
-        signTransaction: (transaction: any) => Promise<any>;
-        signAllTransactions: (transactions: any[]) => Promise<any[]>;
+        signTransaction: (transaction: SolanaTransaction) => Promise<SignedSolanaTransaction>;
+        signAllTransactions: (transactions: SolanaTransaction[]) => Promise<SignedSolanaTransaction[]>;
         signMessage: (message: string) => Promise<string>;
     });
     /**
@@ -49,20 +37,20 @@ export declare class OpenfortSolanaProvider implements OpenfortEmbeddedSolanaWal
     /**
      * Request-based API for wallet operations
      */
-    request(args: SignMessageRequestArguments): Promise<{
+    request(args: SolanaSignMessageRequest): Promise<{
         signature: string;
     }>;
-    request(args: SignTransactionRequestArguments): Promise<{
-        signedTransaction: any;
+    request(args: SolanaSignTransactionRequest): Promise<{
+        signedTransaction: SignedSolanaTransaction;
     }>;
     /**
      * Sign a single transaction (direct method)
      */
-    signTransaction(transaction: any): Promise<any>;
+    signTransaction(transaction: SolanaTransaction): Promise<SignedSolanaTransaction>;
     /**
      * Sign multiple transactions (direct method)
      */
-    signAllTransactions(transactions: any[]): Promise<any[]>;
+    signAllTransactions(transactions: SolanaTransaction[]): Promise<SignedSolanaTransaction[]>;
     /**
      * Sign a message (direct method)
      */
@@ -72,4 +60,3 @@ export declare class OpenfortSolanaProvider implements OpenfortEmbeddedSolanaWal
      */
     toJSON(): string;
 }
-export {};

package/dist/types/hooks/wallet/useEmbeddedEthereumWallet.d.ts

@@ -13,39 +13,90 @@ type UseEmbeddedEthereumWalletOptions = {
 /**
  * Hook for managing embedded Ethereum wallets.
  *
- * This hook provides comprehensive Ethereum wallet management including creation, activation,
- * and recovery. It returns a discriminated union state that enables type-safe wallet interactions.
+ * This hook provides comprehensive management of embedded Ethereum wallets including creation,
+ * recovery, activation, and EIP-1193 provider access. Returns a discriminated union state that
+ * enables type-safe wallet interactions based on connection status.
  *
- * @param options - Configuration with default chainId and callback functions
- * @returns Discriminated union state object. The `status` field determines available properties.
- * Possible states: 'disconnected', 'connecting', 'reconnecting', 'creating', 'needs-recovery',
- * 'connected', 'error'. When connected, includes `provider` and `activeWallet`. All states include
- * `create`, `setActive`, `setRecovery`, `exportPrivateKey`, and `wallets` methods/properties.
+ * **Wallet Types Supported:**
+ * - Smart Contract Accounts (Account Abstraction)
+ * - EOA (Externally Owned Accounts)
+ *
+ * **Recovery Methods:**
+ * - Automatic recovery (via encryption session)
+ * - Password-based recovery
+ *
+ * @param options - Configuration options including:
+ *   - `chainId` - Default chain ID for wallet operations
+ *   - `onCreateSuccess` - Callback when wallet is created
+ *   - `onCreateError` - Callback when wallet creation fails
+ *   - `onSetActiveSuccess` - Callback when wallet is activated/recovered
+ *   - `onSetActiveError` - Callback when wallet activation fails
+ *   - `onSetRecoverySuccess` - Callback when recovery method is updated
+ *   - `onSetRecoveryError` - Callback when recovery update fails
+ *
+ * @returns Discriminated union state based on `status` field:
+ *   - **'disconnected'**: No active wallet. Properties: `create`, `setActive`, `wallets`, `setRecovery`, `exportPrivateKey`
+ *   - **'connecting'**: Activating wallet. Properties: same as disconnected + `activeWallet`
+ *   - **'reconnecting'**: Reconnecting to wallet. Properties: same as connecting
+ *   - **'creating'**: Creating new wallet. Properties: same as disconnected
+ *   - **'needs-recovery'**: Recovery required. Properties: same as connecting
+ *   - **'connected'**: Wallet ready. Properties: all + `provider` (EIP-1193 provider)
+ *   - **'error'**: Operation failed. Properties: all + `error` message
  *
  * @example
  * ```tsx
- * import { useEmbeddedEthereumWallet, isConnected, isLoading } from '@openfort/react-native';
+ * import { useEmbeddedEthereumWallet } from '@openfort/react-native';
+ * import { ActivityIndicator } from 'react-native';
  *
- * const ethereum = useEmbeddedEthereumWallet({
- *   chainId: 1,
- *   onCreateSuccess: (account, provider) => console.log('Wallet created:', account.address),
- * });
+ * function WalletComponent() {
+ *   const ethereum = useEmbeddedEthereumWallet({
+ *     chainId: 137, // Polygon
+ *     onCreateSuccess: (account, provider) => {
+ *       console.log('Wallet created:', account.address);
+ *     },
+ *   });
  *
- * if (isLoading(ethereum)) {
- *   return <ActivityIndicator />;
- * }
+ *   // Handle loading states
+ *   if (ethereum.status === 'creating' || ethereum.status === 'connecting') {
+ *     return <ActivityIndicator />;
+ *   }
  *
- * if (isConnected(ethereum)) {
- *   // TypeScript knows provider and activeWallet are available
- *   const tx = await ethereum.provider.request({
- *     method: 'eth_sendTransaction',
- *     params: [{ from: ethereum.activeWallet.address, to: '0x...', value: '0x0' }]
- *   });
- * }
+ *   // Create first wallet
+ *   if (ethereum.status === 'disconnected' && ethereum.wallets.length === 0) {
+ *     return <Button onPress={() => ethereum.create()} title="Create Wallet" />;
+ *   }
+ *
+ *   // Activate existing wallet
+ *   if (ethereum.status === 'disconnected' && ethereum.wallets.length > 0) {
+ *     return (
+ *       <Button
+ *         onPress={() => ethereum.setActive({
+ *           address: ethereum.wallets[0].address,
+ *           recoveryPassword: 'optional-password'
+ *         })}
+ *         title="Connect Wallet"
+ *       />
+ *     );
+ *   }
+ *
+ *   // Use connected wallet
+ *   if (ethereum.status === 'connected') {
+ *     const sendTransaction = async () => {
+ *       const tx = await ethereum.provider.request({
+ *         method: 'eth_sendTransaction',
+ *         params: [{
+ *           from: ethereum.activeWallet.address,
+ *           to: '0x...',
+ *           value: '0x0'
+ *         }]
+ *       });
+ *       console.log('Transaction hash:', tx);
+ *     };
+ *
+ *     return <Button onPress={sendTransaction} title="Send Transaction" />;
+ *   }
  *
- * // Create wallet if none exist
- * if (ethereum.status === 'disconnected' && ethereum.wallets.length === 0) {
- *   await ethereum.create({ chainId: 1 });
+ *   return null;
  * }
  * ```
  */

package/dist/types/hooks/wallet/useEmbeddedSolanaWallet.d.ts

@@ -10,36 +10,100 @@ type UseEmbeddedSolanaWalletOptions = {
 /**
  * Hook for managing embedded Solana wallets.
  *
- * This hook provides comprehensive Solana wallet management including creation, activation,
- * and recovery. It returns a discriminated union state that enables type-safe wallet interactions.
+ * This hook provides comprehensive management of embedded Solana (SVM) wallets including
+ * creation, recovery, activation, and transaction signing. Returns a discriminated union
+ * state that enables type-safe wallet interactions based on connection status.
  *
- * @param options - Configuration with callback functions
- * @returns Discriminated union state object. The `status` field determines available properties.
- * Possible states: 'disconnected', 'connecting', 'reconnecting', 'creating', 'needs-recovery',
- * 'connected', 'error'. When connected, includes `provider` and `activeWallet`. All states include
- * `create`, `setActive`, and `wallets` methods/properties.
+ * **Note:** Solana wallets are always EOA (Externally Owned Accounts) and work across
+ * all Solana networks (mainnet, devnet, testnet).
+ *
+ * **Recovery Methods:**
+ * - Automatic recovery (via encryption session)
+ * - Password-based recovery
+ *
+ * @param options - Configuration options including:
+ *   - `onCreateSuccess` - Callback when wallet is created
+ *   - `onCreateError` - Callback when wallet creation fails
+ *   - `onSetActiveSuccess` - Callback when wallet is activated/recovered
+ *   - `onSetActiveError` - Callback when wallet activation fails
+ *
+ * @returns Discriminated union state based on `status` field:
+ *   - **'disconnected'**: No active wallet. Properties: `create`, `setActive`, `wallets`
+ *   - **'connecting'**: Activating wallet. Properties: same as disconnected
+ *   - **'reconnecting'**: Reconnecting to wallet. Properties: same as disconnected + `activeWallet`
+ *   - **'creating'**: Creating new wallet. Properties: same as disconnected
+ *   - **'needs-recovery'**: Recovery required. Properties: same as reconnecting
+ *   - **'connected'**: Wallet ready. Properties: all + `provider` (Solana wallet adapter)
+ *   - **'error'**: Operation failed. Properties: all + `error` message + optional `activeWallet`
  *
  * @example
  * ```tsx
- * import { useEmbeddedSolanaWallet, isConnected, isLoading } from '@openfort/react-native';
+ * import { useEmbeddedSolanaWallet } from '@openfort/react-native';
+ * import { Transaction } from '@solana/web3.js';
+ * import { ActivityIndicator } from 'react-native';
  *
- * const solana = useEmbeddedSolanaWallet({
- *   onCreateSuccess: (account, provider) => console.log('Wallet created:', account.address),
- * });
+ * function SolanaWalletComponent() {
+ *   const solana = useEmbeddedSolanaWallet({
+ *     onCreateSuccess: (account, provider) => {
+ *       console.log('Solana wallet created:', account.address);
+ *       console.log('Public key:', provider.publicKey);
+ *     },
+ *   });
  *
- * if (isLoading(solana)) {
- *   return <ActivityIndicator />;
- * }
+ *   // Handle loading states
+ *   if (solana.status === 'creating' || solana.status === 'connecting') {
+ *     return <ActivityIndicator />;
+ *   }
  *
- * if (isConnected(solana)) {
- *   // TypeScript knows provider and activeWallet are available
- *   const signed = await solana.provider.signTransaction(transaction);
- *   const publicKey = solana.provider.publicKey;
- * }
+ *   // Create first wallet
+ *   if (solana.status === 'disconnected' && solana.wallets.length === 0) {
+ *     return (
+ *       <Button
+ *         onPress={() => solana.create({ recoveryPassword: 'optional' })}
+ *         title="Create Solana Wallet"
+ *       />
+ *     );
+ *   }
+ *
+ *   // Activate existing wallet
+ *   if (solana.status === 'disconnected' && solana.wallets.length > 0) {
+ *     return (
+ *       <Button
+ *         onPress={() => solana.setActive({
+ *           address: solana.wallets[0].address,
+ *           recoveryPassword: 'optional'
+ *         })}
+ *         title="Connect Solana Wallet"
+ *       />
+ *     );
+ *   }
+ *
+ *   // Use connected wallet
+ *   if (solana.status === 'connected') {
+ *     const signTransaction = async () => {
+ *       const transaction = new Transaction();
+ *       // ... add instructions to transaction
+ *
+ *       const signed = await solana.provider.signTransaction(transaction);
+ *       console.log('Signed transaction:', signed);
+ *     };
+ *
+ *     const signMessage = async () => {
+ *       const message = 'Hello Solana!';
+ *       const signature = await solana.provider.signMessage(message);
+ *       console.log('Message signature:', signature);
+ *     };
+ *
+ *     return (
+ *       <View>
+ *         <Text>Connected: {solana.activeWallet.address}</Text>
+ *         <Button onPress={signTransaction} title="Sign Transaction" />
+ *         <Button onPress={signMessage} title="Sign Message" />
+ *       </View>
+ *     );
+ *   }
  *
- * // Create wallet if none exist
- * if (solana.status === 'disconnected' && solana.wallets.length === 0) {
- *   await solana.create({ recoveryMethod: 'automatic' });
+ *   return null;
  * }
  * ```
  */

package/dist/types/types/index.d.ts

@@ -8,4 +8,4 @@ export interface UseOpenfort {
 }
 export type { AuthSuccessCallback, EmailLoginHookOptions, EmailLoginHookResult, ErrorCallback, GenerateSiweMessage, GenerateSiweMessageResponse, PasswordFlowState, RecoveryFlowState, SiweFlowState, SiweLoginHookOptions, SiweLoginHookResult, } from './auth';
 export type { LinkWithOAuthInput, LoginWithOAuthInput, OAuthFlowState, UseLoginWithOAuth, } from './oauth';
-export type { ConnectedEmbeddedEthereumWallet, ConnectedEmbeddedSolanaWallet, CreateSolanaEmbeddedWalletOpts, EmbeddedEthereumWalletState, EmbeddedSolanaWalletState, OpenfortEmbeddedEthereumWalletProvider, OpenfortEmbeddedSolanaWalletProvider, } from './wallet';
+export type { ConnectedEmbeddedEthereumWallet, ConnectedEmbeddedSolanaWallet, CreateEthereumWalletOptions, CreateEthereumWalletResult, CreateSolanaEmbeddedWalletOpts, CreateSolanaWalletOptions, CreateSolanaWalletResult, EIP1193EventHandler, EIP1193EventName, EIP1193RequestArguments, EmbeddedEthereumWalletState, EmbeddedSolanaWalletState, EthereumWalletActions, OpenfortEmbeddedEthereumWalletProvider, OpenfortEmbeddedSolanaWalletProvider, SetActiveEthereumWalletOptions, SetActiveEthereumWalletResult, SetActiveSolanaWalletOptions, SetActiveSolanaWalletResult, SetRecoveryOptions, SetRecoveryResult, SignedSolanaTransaction, SolanaRequestArguments, SolanaSignMessageRequest, SolanaSignTransactionRequest, SolanaTransaction, SolanaWalletActions, } from './wallet';