@privy-io/react-auth 3.48.1 → 3.49.0

package/dist/dts/internal.d.mts

@@ -1,4 +1,4 @@
-import { U as User } from './types-DbK0_UgU.mjs';
+import { U as User } from './types-CMDNG5O5.mjs';
 export { D as DepositFundsCryptoOptions, a as DepositFundsDestination, b as DepositFundsFiatOptions, c as DepositFundsOptions, d as DepositFundsResult, U as UseDepositAddressResult, e as UseDepositFundsResult, f as UseHeadlessCryptoDepositResult, u as useDepositAddress, g as useDepositFunds, h as useHeadlessCryptoDeposit } from './use-headless-crypto-deposit-DnTCCMq5.mjs';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
@@ -44,6 +44,100 @@ type UseLoginWithSsoToken = {
  */
 declare function useLoginWithSsoToken(): UseLoginWithSsoToken;
 
+type UseAuthMfa = {
+    /**
+     * Trigger the verification flow for auth MFA.
+     *
+     * @param o options for the verification flow
+     * @returns a promise that resolves to void on success, rejects otherwise
+     */
+    verify: (o?: {
+        /**
+         * If set to false, `verify` can be used within other Privy flows e.g. enrollment.
+         *
+         * @default true
+         */
+        standalone?: boolean;
+    }) => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to trigger MFA verification for Privy authentication
+ */
+declare const useAuthMfa: () => UseAuthMfa;
+
+type UseAuthMfaEnrollment = {
+    /**
+     * Trigger the enrollment/un-enrollment flow for auth MFA.
+     *
+     * @param o options for the verification flow
+     * @returns a promise that resolves to an object with the updated user
+     */
+    enroll: (o?: {
+        onBack?: () => void;
+    }) => Promise<{
+        user: User;
+    }>;
+};
+/**
+ * @experimental
+ *
+ * Hook to trigger MFA enrollment for Privy authentication
+ */
+declare const useAuthMfaEnrollment: () => UseAuthMfaEnrollment;
+
+/** MFA methods supported for Privy authentication (SMS is not). */
+type AuthMfaMethod = 'totp' | 'passkey';
+type UseAuthMfaMethods = {
+    /**
+     * The MFA methods the current user can verify with headlessly: `'totp'` and/or `'passkey'`.
+     * Empty when there is no user or they aren't enrolled in MFA.
+     */
+    mfaMethods: AuthMfaMethod[];
+};
+/**
+ * @experimental
+ *
+ * Hook to list the MFA methods the current user can verify Privy authentication with headlessly.
+ */
+declare const useAuthMfaMethods: () => UseAuthMfaMethods;
+type UseVerifyAuthMfaWithTotp = {
+    /**
+     * Headlessly verify auth MFA with a code from the user's authenticator app, without opening the
+     * Privy modal. Use this to build your own MFA UI.
+     *
+     * @param o.code the 6-digit TOTP code
+     * @returns a promise that resolves to void on success, rejects otherwise. API failures reject with
+     * a {@link PrivyApiError} whose `privyErrorCode` is `missing_or_invalid_mfa` for a wrong code and
+     * `too_many_requests` once rate limited.
+     */
+    verifyWithTotp: (o: {
+        code: string;
+    }) => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to headlessly verify MFA for Privy authentication with a TOTP code
+ */
+declare const useVerifyAuthMfaWithTotp: () => UseVerifyAuthMfaWithTotp;
+type UseVerifyAuthMfaWithPasskey = {
+    /**
+     * Headlessly verify auth MFA with the user's MFA-enrolled passkey, without opening the Privy modal.
+     * Prompts the browser's passkey UI.
+     *
+     * @returns a promise that resolves to void on success, rejects otherwise
+     */
+    verifyWithPasskey: () => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to headlessly verify MFA for Privy authentication with the user's passkey
+ */
+declare const useVerifyAuthMfaWithPasskey: () => UseVerifyAuthMfaWithPasskey;
+
 /** Payment network shown as the bottom-right brand mark. Omit for a card with no network mark. */
 type CardBrand = 'visa';
 type SkeuomorphicDebitCardProps = {
@@ -75,5 +169,5 @@ type SkeuomorphicDebitCardProps = {
 };
 declare const SkeuomorphicDebitCard: ({ cardColor, cardholderName, last4, expMonth, expYear, brand, logo, flipped, back, }: SkeuomorphicDebitCardProps) => react_jsx_runtime.JSX.Element;
 
-export { SkeuomorphicDebitCard, useLoginWithSsoToken };
-export type { CardBrand, SkeuomorphicDebitCardProps, UseLoginWithSsoToken };
+export { SkeuomorphicDebitCard, useAuthMfa, useAuthMfaEnrollment, useAuthMfaMethods, useLoginWithSsoToken, useVerifyAuthMfaWithPasskey, useVerifyAuthMfaWithTotp };
+export type { AuthMfaMethod, CardBrand, SkeuomorphicDebitCardProps, UseAuthMfa, UseAuthMfaEnrollment, UseAuthMfaMethods, UseLoginWithSsoToken, UseVerifyAuthMfaWithPasskey, UseVerifyAuthMfaWithTotp };

package/dist/dts/internal.d.ts

@@ -1,4 +1,4 @@
-import { U as User } from './types-DbK0_UgU.js';
+import { U as User } from './types-CMDNG5O5.js';
 export { D as DepositFundsCryptoOptions, a as DepositFundsDestination, b as DepositFundsFiatOptions, c as DepositFundsOptions, d as DepositFundsResult, U as UseDepositAddressResult, e as UseDepositFundsResult, f as UseHeadlessCryptoDepositResult, u as useDepositAddress, g as useDepositFunds, h as useHeadlessCryptoDeposit } from './use-headless-crypto-deposit-DnTCCMq5.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
@@ -44,6 +44,100 @@ type UseLoginWithSsoToken = {
  */
 declare function useLoginWithSsoToken(): UseLoginWithSsoToken;
 
+type UseAuthMfa = {
+    /**
+     * Trigger the verification flow for auth MFA.
+     *
+     * @param o options for the verification flow
+     * @returns a promise that resolves to void on success, rejects otherwise
+     */
+    verify: (o?: {
+        /**
+         * If set to false, `verify` can be used within other Privy flows e.g. enrollment.
+         *
+         * @default true
+         */
+        standalone?: boolean;
+    }) => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to trigger MFA verification for Privy authentication
+ */
+declare const useAuthMfa: () => UseAuthMfa;
+
+type UseAuthMfaEnrollment = {
+    /**
+     * Trigger the enrollment/un-enrollment flow for auth MFA.
+     *
+     * @param o options for the verification flow
+     * @returns a promise that resolves to an object with the updated user
+     */
+    enroll: (o?: {
+        onBack?: () => void;
+    }) => Promise<{
+        user: User;
+    }>;
+};
+/**
+ * @experimental
+ *
+ * Hook to trigger MFA enrollment for Privy authentication
+ */
+declare const useAuthMfaEnrollment: () => UseAuthMfaEnrollment;
+
+/** MFA methods supported for Privy authentication (SMS is not). */
+type AuthMfaMethod = 'totp' | 'passkey';
+type UseAuthMfaMethods = {
+    /**
+     * The MFA methods the current user can verify with headlessly: `'totp'` and/or `'passkey'`.
+     * Empty when there is no user or they aren't enrolled in MFA.
+     */
+    mfaMethods: AuthMfaMethod[];
+};
+/**
+ * @experimental
+ *
+ * Hook to list the MFA methods the current user can verify Privy authentication with headlessly.
+ */
+declare const useAuthMfaMethods: () => UseAuthMfaMethods;
+type UseVerifyAuthMfaWithTotp = {
+    /**
+     * Headlessly verify auth MFA with a code from the user's authenticator app, without opening the
+     * Privy modal. Use this to build your own MFA UI.
+     *
+     * @param o.code the 6-digit TOTP code
+     * @returns a promise that resolves to void on success, rejects otherwise. API failures reject with
+     * a {@link PrivyApiError} whose `privyErrorCode` is `missing_or_invalid_mfa` for a wrong code and
+     * `too_many_requests` once rate limited.
+     */
+    verifyWithTotp: (o: {
+        code: string;
+    }) => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to headlessly verify MFA for Privy authentication with a TOTP code
+ */
+declare const useVerifyAuthMfaWithTotp: () => UseVerifyAuthMfaWithTotp;
+type UseVerifyAuthMfaWithPasskey = {
+    /**
+     * Headlessly verify auth MFA with the user's MFA-enrolled passkey, without opening the Privy modal.
+     * Prompts the browser's passkey UI.
+     *
+     * @returns a promise that resolves to void on success, rejects otherwise
+     */
+    verifyWithPasskey: () => Promise<void>;
+};
+/**
+ * @experimental
+ *
+ * Hook to headlessly verify MFA for Privy authentication with the user's passkey
+ */
+declare const useVerifyAuthMfaWithPasskey: () => UseVerifyAuthMfaWithPasskey;
+
 /** Payment network shown as the bottom-right brand mark. Omit for a card with no network mark. */
 type CardBrand = 'visa';
 type SkeuomorphicDebitCardProps = {
@@ -75,5 +169,5 @@ type SkeuomorphicDebitCardProps = {
 };
 declare const SkeuomorphicDebitCard: ({ cardColor, cardholderName, last4, expMonth, expYear, brand, logo, flipped, back, }: SkeuomorphicDebitCardProps) => react_jsx_runtime.JSX.Element;
 
-export { SkeuomorphicDebitCard, useLoginWithSsoToken };
-export type { CardBrand, SkeuomorphicDebitCardProps, UseLoginWithSsoToken };
+export { SkeuomorphicDebitCard, useAuthMfa, useAuthMfaEnrollment, useAuthMfaMethods, useLoginWithSsoToken, useVerifyAuthMfaWithPasskey, useVerifyAuthMfaWithTotp };
+export type { AuthMfaMethod, CardBrand, SkeuomorphicDebitCardProps, UseAuthMfa, UseAuthMfaEnrollment, UseAuthMfaMethods, UseLoginWithSsoToken, UseVerifyAuthMfaWithPasskey, UseVerifyAuthMfaWithTotp };

package/dist/dts/smart-wallets.d.mts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
-import { f as SendTransactionModalUIOptions, g as SignMessageModalUIOptions } from './types-DbK0_UgU.mjs';
+import { f as SendTransactionModalUIOptions, g as SignMessageModalUIOptions } from './types-CMDNG5O5.mjs';
 import { SmartAccountClient } from 'permissionless';
 import { EIP1193Provider, Chain, PublicClient, HttpTransport, WalletClient, PaymasterRpcSchema, SendTransactionParameters, Hash, SignableMessage, Hex, TypedData, SignTypedDataParameters } from 'viem';
 import { SmartAccount, SendUserOperationParameters } from 'viem/account-abstraction';

package/dist/dts/smart-wallets.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import react__default from 'react';
-import { f as SendTransactionModalUIOptions, g as SignMessageModalUIOptions } from './types-DbK0_UgU.js';
+import { f as SendTransactionModalUIOptions, g as SignMessageModalUIOptions } from './types-CMDNG5O5.js';
 import { SmartAccountClient } from 'permissionless';
 import { EIP1193Provider, Chain, PublicClient, HttpTransport, WalletClient, PaymasterRpcSchema, SendTransactionParameters, Hash, SignableMessage, Hex, TypedData, SignTypedDataParameters } from 'viem';
 import { SmartAccount, SendUserOperationParameters } from 'viem/account-abstraction';

package/dist/dts/solana.d.mts

@@ -1,13 +1,13 @@
-import { I as ImportWalletInput } from './importWallet-CkFeiMf4.mjs';
-import { W as Wallet, g as SignMessageModalUIOptions, d as SolanaChain, h as SolanaStandardWallet, i as CreateWalletOptions, f as SendTransactionModalUIOptions, j as SolanaFundingConfig } from './types-DbK0_UgU.mjs';
-export { k as SolanaAdapterConnector, l as defaultSolanaRpcsPlugin, t as toSolanaWalletConnectors } from './types-DbK0_UgU.mjs';
+import { I as ImportWalletInput } from './importWallet-DdlcXOFn.mjs';
+import { W as Wallet, g as SignMessageModalUIOptions, d as SolanaChain, h as SolanaStandardWallet, i as CreateWalletOptions, f as SendTransactionModalUIOptions, j as SolanaFundingConfig } from './types-CMDNG5O5.mjs';
+export { k as SolanaAdapterConnector, l as defaultSolanaRpcsPlugin, t as toSolanaWalletConnectors } from './types-CMDNG5O5.mjs';
 import { SolanaSignAndSendTransactionFeature, SolanaSignTransactionFeature, SolanaSignMessageFeature } from '@solana/wallet-standard-features';
 import { WalletAccount, WalletIcon, WalletVersion } from '@wallet-standard/base';
 import { StandardConnectFeature, StandardDisconnectFeature, StandardEventsFeature } from '@wallet-standard/features';
 import EventEmitter from 'eventemitter3';
 import { SolanaSignAndSendTransactionOptions, SolanaSignTransactionOptions, ConnectedStandardSolanaWallet } from '@privy-io/js-sdk-core';
 export { ConnectedStandardSolanaWallet } from '@privy-io/js-sdk-core';
-import { P as PrivyEvents } from './events-context-B0pEGTJZ.mjs';
+import { P as PrivyEvents } from './events-context-D_XQ2Qxr.mjs';
 import '@coinbase/wallet-sdk';
 import '@simplewebauthn/browser';
 import '@solana/kit';

package/dist/dts/solana.d.ts

@@ -1,13 +1,13 @@
-import { I as ImportWalletInput } from './importWallet-CkFeiMf4.js';
-import { W as Wallet, g as SignMessageModalUIOptions, d as SolanaChain, h as SolanaStandardWallet, i as CreateWalletOptions, f as SendTransactionModalUIOptions, j as SolanaFundingConfig } from './types-DbK0_UgU.js';
-export { k as SolanaAdapterConnector, l as defaultSolanaRpcsPlugin, t as toSolanaWalletConnectors } from './types-DbK0_UgU.js';
+import { I as ImportWalletInput } from './importWallet-DdlcXOFn.js';
+import { W as Wallet, g as SignMessageModalUIOptions, d as SolanaChain, h as SolanaStandardWallet, i as CreateWalletOptions, f as SendTransactionModalUIOptions, j as SolanaFundingConfig } from './types-CMDNG5O5.js';
+export { k as SolanaAdapterConnector, l as defaultSolanaRpcsPlugin, t as toSolanaWalletConnectors } from './types-CMDNG5O5.js';
 import { SolanaSignAndSendTransactionFeature, SolanaSignTransactionFeature, SolanaSignMessageFeature } from '@solana/wallet-standard-features';
 import { WalletAccount, WalletIcon, WalletVersion } from '@wallet-standard/base';
 import { StandardConnectFeature, StandardDisconnectFeature, StandardEventsFeature } from '@wallet-standard/features';
 import EventEmitter from 'eventemitter3';
 import { SolanaSignAndSendTransactionOptions, SolanaSignTransactionOptions, ConnectedStandardSolanaWallet } from '@privy-io/js-sdk-core';
 export { ConnectedStandardSolanaWallet } from '@privy-io/js-sdk-core';
-import { P as PrivyEvents } from './events-context-B0pEGTJZ.js';
+import { P as PrivyEvents } from './events-context-D_XQ2Qxr.js';
 import '@coinbase/wallet-sdk';
 import '@simplewebauthn/browser';
 import '@solana/kit';

package/dist/dts/tempo.d.mts

@@ -1,8 +1,8 @@
 import { Hex } from 'viem';
 import { StrictUnsignedTempoTransactionRequest, StrictUnsignedTransactionRequest, StrictUnsignedTransactionRequestWithChainId } from '@privy-io/ethereum';
 export { StrictUnsignedTempoTransactionRequest } from '@privy-io/ethereum';
-import { B as BaseConnectedEthereumWallet } from './types-DbK0_UgU.mjs';
-export { P as PrivyViemAccount, t as toViemAccount } from './toViemAccount-v2QSvSZB.mjs';
+import { B as BaseConnectedEthereumWallet } from './types-CMDNG5O5.mjs';
+export { P as PrivyViemAccount, t as toViemAccount } from './toViemAccount-CKai_9Xf.mjs';
 import '@coinbase/wallet-sdk';
 import '@simplewebauthn/browser';
 import '@solana/kit';

package/dist/dts/tempo.d.ts

@@ -1,8 +1,8 @@
 import { Hex } from 'viem';
 import { StrictUnsignedTempoTransactionRequest, StrictUnsignedTransactionRequest, StrictUnsignedTransactionRequestWithChainId } from '@privy-io/ethereum';
 export { StrictUnsignedTempoTransactionRequest } from '@privy-io/ethereum';
-import { B as BaseConnectedEthereumWallet } from './types-DbK0_UgU.js';
-export { P as PrivyViemAccount, t as toViemAccount } from './toViemAccount-v2QSvSZB.js';
+import { B as BaseConnectedEthereumWallet } from './types-CMDNG5O5.js';
+export { P as PrivyViemAccount, t as toViemAccount } from './toViemAccount-CKai_9Xf.js';
 import '@coinbase/wallet-sdk';
 import '@simplewebauthn/browser';
 import '@solana/kit';

package/dist/dts/toViemAccount-CKai_9Xf.d.mts

@@ -0,0 +1,27 @@
+import { LocalAccount } from 'viem/accounts';
+import { Account } from 'viem/tempo';
+import { SignatureOptions } from '@privy-io/api-types';
+import { C as ConnectedWallet } from './types-CMDNG5O5.mjs';
+
+type PrivySignTransaction = LocalAccount['signTransaction'] & Account.Account_base['signTransaction'];
+/**
+ * Extends viem's LocalAccount with Tempo transaction signing support.
+ * Structurally assignable to LocalAccount — existing consumers are unaffected.
+ */
+type PrivyViemAccount = Omit<LocalAccount, 'signTransaction'> & {
+    signTransaction: PrivySignTransaction;
+};
+/**
+ * Helper function to create a viem Account instance given a connected Ethereum wallet.
+ *
+ * @param wallet {ConnectedWallet} the connected Ethereum wallet to create an Account for
+ * @param signatureOptions optional signature options for ERC-1271 signing
+ * @returns the corresponding viem account for the wallet
+ */
+declare const toViemAccount: ({ wallet, signatureOptions, }: {
+    wallet: ConnectedWallet;
+    signatureOptions?: SignatureOptions;
+}) => Promise<PrivyViemAccount>;
+
+export { toViemAccount as t };
+export type { PrivyViemAccount as P };

package/dist/dts/toViemAccount-CKai_9Xf.d.ts

@@ -0,0 +1,27 @@
+import { LocalAccount } from 'viem/accounts';
+import { Account } from 'viem/tempo';
+import { SignatureOptions } from '@privy-io/api-types';
+import { C as ConnectedWallet } from './types-CMDNG5O5.js';
+
+type PrivySignTransaction = LocalAccount['signTransaction'] & Account.Account_base['signTransaction'];
+/**
+ * Extends viem's LocalAccount with Tempo transaction signing support.
+ * Structurally assignable to LocalAccount — existing consumers are unaffected.
+ */
+type PrivyViemAccount = Omit<LocalAccount, 'signTransaction'> & {
+    signTransaction: PrivySignTransaction;
+};
+/**
+ * Helper function to create a viem Account instance given a connected Ethereum wallet.
+ *
+ * @param wallet {ConnectedWallet} the connected Ethereum wallet to create an Account for
+ * @param signatureOptions optional signature options for ERC-1271 signing
+ * @returns the corresponding viem account for the wallet
+ */
+declare const toViemAccount: ({ wallet, signatureOptions, }: {
+    wallet: ConnectedWallet;
+    signatureOptions?: SignatureOptions;
+}) => Promise<PrivyViemAccount>;
+
+export { toViemAccount as t };
+export type { PrivyViemAccount as P };