@privy-io/react-auth 1.76.6 → 1.77.0-beta-20240802164445

package/dist/index.d.ts

@@ -894,6 +894,7 @@ interface ResponseSmsMfaMethod {
 type LinkedMfaMethodsResponseType = Array<ResponseSmsMfaMethod>;
 interface GetCurrentUserResponse {
     id: string;
+    is_guest: boolean;
     created_at: number;
     linked_accounts: LinkedAccountsResponseType;
     mfa_methods: LinkedMfaMethodsResponseType;
@@ -1274,7 +1275,7 @@ type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
  * Supported OAuth providers for the recovery flow. Can be `'google-drive'`
  */
 type RecoveryProviderType = (typeof SUPPORTED_RECOVERY_PROVIDERS)[number];
-type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram' | 'custom' | `privy:${string}`;
+type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram' | 'custom' | `privy:${string}` | 'guest';
 type LoginWithCode = {
     /**
      * One-time password _([OTP](https://en.wikipedia.org/wiki/One-time_password))_ that was sent to user during first login step
@@ -1301,7 +1302,7 @@ type WalletBranding = {
     id: string;
     icon?: string | EmbeddedSVG;
 };
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster' | 'passkey' | 'telegram' | 'cross_app';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'spotify_oauth' | 'instagram_oauth' | 'tiktok_oauth' | 'linkedin_oauth' | 'apple_oauth' | 'custom_auth' | 'farcaster' | 'passkey' | 'telegram' | 'cross_app' | 'guest';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -1822,6 +1823,8 @@ interface User {
      * and/or Privacy Policy
      */
     hasAcceptedTerms: boolean;
+    /** Whether or not the user is a guest */
+    isGuest: boolean;
 }
 type OAuthTokens = {
     /** The OAuth provider. */
@@ -2490,6 +2493,7 @@ type PrivyFarcasterSignerInitResponse = {
 type RuntimeLoginOverridableOptions = {
     loginMethods?: PrivyClientConfig['loginMethods'];
 };
+type SetWalletRecoveryOptions = {};
 
 declare function getAccessToken(): Promise<string | null>;
 /**
@@ -2909,7 +2913,7 @@ interface PrivyInterface {
      *
      * @returns Promise for the {@link Wallet} object for the updated embedded wallet
      */
-    setWalletRecovery: () => Promise<Wallet>;
+    setWalletRecovery: (o?: SetWalletRecoveryOptions) => Promise<Wallet>;
     /**
      * Prompts a user to sign a message using their embedded wallet using EIP-191's `personal_sign`
      * method (0x45).
@@ -3960,6 +3964,15 @@ declare function useSetWalletPassword(callbacks?: PrivyEvents['setWalletPassword
     setWalletPassword: () => Promise<Wallet>;
 };
 
+/**
+ * Use this hook to create a guest account
+ *
+ * @returns createGuestAccount - {@link createGuestAccount} creates a guest account
+ */
+declare function useGuestAccounts(): {
+    createGuestAccount: () => Promise<User>;
+};
+
 /**
  * Use this hook to set user-controlled recovery on the embedded wallet, and to attach callbacks
  * for successful `recovery set`s, and `recovery set` errors.
@@ -3974,7 +3987,7 @@ declare function useSetWalletRecovery(callbacks?: PrivyEvents['setWalletRecovery
     /**
      * Opens the Privy set recovery modal and prompts the user to set wallet password.
      */
-    setWalletRecovery: () => Promise<Wallet>;
+    setWalletRecovery: (o?: SetWalletRecoveryOptions) => Promise<Wallet>;
 };
 
 /**
@@ -4126,4 +4139,4 @@ declare const LoginModal: ({ open }: {
     open: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedSolanaWallet, ConnectedWallet, ConnectorManager, ContractUIOptions, CrossAppAccount, CrossAppAccountWithMetadata, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginModal, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayFundingConfig, MoonpayPaymentMethod, NativeFundingConfig, NonEmptyArray, OAuthProviderType, OAuthTokens, Passkey, PasskeyWithMetadata, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Telegram, TelegramWithMetadata, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseOAuthTokens, UseSolanaWalletsInterface, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useExperimentalFarcasterSigner, useFarcasterSigner, useFundWallet, useLinkAccount, useLinkWithSiwe, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, useOAuthTokens, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useSolanaWallets, useToken, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedSolanaWallet, ConnectedWallet, ConnectorManager, ContractUIOptions, CrossAppAccount, CrossAppAccountWithMetadata, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Farcaster, FarcasterWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginMethodOrderOption, LoginModal, LoginWithCode, MessageTypes, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayFundingConfig, MoonpayPaymentMethod, NativeFundingConfig, NonEmptyArray, OAuthProviderType, OAuthTokens, Passkey, PasskeyWithMetadata, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, Telegram, TelegramWithMetadata, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, TypedMessage, UnsignedTransactionRequest, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseOAuthTokens, UseSolanaWalletsInterface, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useExperimentalFarcasterSigner, useFarcasterSigner, useFundWallet, useGuestAccounts, useLinkAccount, useLinkWithSiwe, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, useOAuthTokens, usePrivy, useRegisterMfaListener, useSendTransaction, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useSolanaWallets, useToken, useWallets };