@privy-io/react-auth 1.81.2 → 1.81.3

package/dist/esm/ui.js

@@ -1,4 +1,4 @@
-import{$a as Q,G as K,Ma as R,Oa as u,Pa as Y,Wa as J,eb as q,fb as j,hb as f,kb as e1,nb as t1,ob as o1,pb as r1,w as $}from"./chunk-M4HAID4L.js";import{jsx as _,jsxs as n1}from"react/jsx-runtime";var i1=e=>n1("svg",{width:"44",height:"44",viewBox:"0 0 30 30",fill:"none",xmlns:"http://www.w3.org/2000/svg",...e,children:[n1("g",{clipPath:"url(#clip0_57_8744)",children:[_("path",{d:"M15 21.6347C20.1355 21.6347 24.3 17.4714 24.3 12.3374C24.3 7.20348 20.1355 3.04016 15 3.04016C9.86455 3.04016 5.70001 7.20348 5.70001 12.3374C5.70001 17.4714 9.86455 21.6347 15 21.6347Z",fill:"currentColor"}),_("path",{d:"M15 27.0402C18.5098 27.0402 21.3556 26.4414 21.3556 25.7069C21.3556 24.9725 18.5117 24.3737 15 24.3737C11.4883 24.3737 8.64438 24.9725 8.64438 25.7069C8.64438 26.4414 11.4883 27.0402 15 27.0402Z",fill:"currentColor"})]}),_("defs",{children:_("clipPath",{id:"clip0_57_8744",children:_("rect",{width:"18.6",height:"24",fill:"currentColor",transform:"translate(5.70001 3.04016)"})})})]});import L2 from"styled-components";var E=L2.button`
+import{$a as Q,G as K,Ma as R,Oa as u,Pa as Y,Wa as J,eb as q,fb as j,hb as f,kb as e1,nb as t1,ob as o1,pb as r1,w as $}from"./chunk-XBTZ7LOU.js";import{jsx as _,jsxs as n1}from"react/jsx-runtime";var i1=e=>n1("svg",{width:"44",height:"44",viewBox:"0 0 30 30",fill:"none",xmlns:"http://www.w3.org/2000/svg",...e,children:[n1("g",{clipPath:"url(#clip0_57_8744)",children:[_("path",{d:"M15 21.6347C20.1355 21.6347 24.3 17.4714 24.3 12.3374C24.3 7.20348 20.1355 3.04016 15 3.04016C9.86455 3.04016 5.70001 7.20348 5.70001 12.3374C5.70001 17.4714 9.86455 21.6347 15 21.6347Z",fill:"currentColor"}),_("path",{d:"M15 27.0402C18.5098 27.0402 21.3556 26.4414 21.3556 25.7069C21.3556 24.9725 18.5117 24.3737 15 24.3737C11.4883 24.3737 8.64438 24.9725 8.64438 25.7069C8.64438 26.4414 11.4883 27.0402 15 27.0402Z",fill:"currentColor"})]}),_("defs",{children:_("clipPath",{id:"clip0_57_8744",children:_("rect",{width:"18.6",height:"24",fill:"currentColor",transform:"translate(5.70001 3.04016)"})})})]});import L2 from"styled-components";var E=L2.button`
   --size: ${({size:e="44px"})=>e};
 
   -webkit-font-smoothing: antialiased;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react from 'react';
 import react__default, { MouseEvent } from 'react';
-import { C as Chain, B as BaseConnectedWallet, W as WalletClientType, R as RpcConfig, a as ConnectorType, P as PrivyProxyProvider, E as Embedded1193Provider, b as ConnectedWalletMetadata, c as WalletBranding, d as WalletListEntry, e as ExternalWalletsConfig, f as EIP1193Provider, U as User, O as OAuthTokens, g as OAuthProviderType, M as MoonpaySignRequest, h as MoonpaySignResponse, i as PrivyServerConfig, j as PrivyFarcasterSignerInitResponse, k as PrivyClientConfig, l as RuntimeLoginOverridableOptions, m as Wallet, S as SetWalletRecoveryOptions, n as SignMessageModalUIOptions, o as SignTypedDataParams, p as MfaMethod, q as UnsignedTransactionRequest, r as SendTransactionModalUIOptions, F as FundWalletConfig, T as TransactionReceipt, s as ConnectedWallet, t as PrivyIframeErrorTypesType, u as PrivyErrorCode, L as LoginMethod, v as LinkedAccountWithMetadata, w as UserRecoveryMethod, x as FundingMethod, y as LoginWithCode, z as OtpFlowState, A as ConnectedSolanaWallet, D as UnsignedTransactionRequestWithChainId } from './types-afedc06b.js';
-export { a4 as Apple, ae as AppleOAuthWithMetadata, G as AsExternalProvider, am as ContractUIOptions, a7 as CrossAppAccount, ah as CrossAppAccountWithMetadata, a1 as Discord, aa as DiscordOAuthWithMetadata, aj as Email, Y as EmailWithMetadata, aq as Farcaster, af as FarcasterWithMetadata, a2 as Github, ab as GithubOAuthWithMetadata, $ as Google, a8 as GoogleOAuthWithMetadata, a3 as LinkedIn, ad as LinkedInOAuthWithMetadata, as as LoginMethodOrderOption, I as MessageTypes, J as MoonpayConfig, K as MoonpayCurrencyCode, ao as MoonpayFundingConfig, N as MoonpayPaymentMethod, an as NativeFundingConfig, X as NonEmptyArray, ar as Passkey, ai as PasskeyWithMetadata, ak as Phone, Z as PhoneWithMetadata, ap as PriceDisplayOptions, Q as Quantity, a6 as Telegram, ag as TelegramWithMetadata, a5 as Tiktok, ac as TiktokOAuthWithMetadata, V as TransactionLog, al as TransactionUIOptions, a0 as Twitter, a9 as TwitterOAuthWithMetadata, H as TypedMessage, _ as WalletWithMetadata } from './types-afedc06b.js';
+import { C as Chain, B as BaseConnectedWallet, W as WalletClientType, R as RpcConfig, a as ConnectorType, P as PrivyProxyProvider, E as Embedded1193Provider, b as ConnectedWalletMetadata, c as WalletBranding, d as WalletListEntry, e as ExternalWalletsConfig, f as EIP1193Provider, U as User, O as OAuthTokens, g as OAuthProviderType, M as MoonpaySignRequest, h as MoonpaySignResponse, i as PrivyServerConfig, j as PrivyFarcasterSignerInitResponse, k as PrivyClientConfig, l as RuntimeLoginOverridableOptions, m as CreateWalletOptions, n as Wallet, S as SetWalletRecoveryOptions, o as SignMessageModalUIOptions, p as SignTypedDataParams, q as MfaMethod, r as UnsignedTransactionRequest, s as SendTransactionModalUIOptions, F as FundWalletConfig, T as TransactionReceipt, t as ConnectedWallet, u as PrivyIframeErrorTypesType, v as PrivyErrorCode, L as LoginMethod, w as LinkedAccountWithMetadata, x as UserRecoveryMethod, y as FundingMethod, z as LoginWithCode, A as OtpFlowState, D as ConnectedSolanaWallet, G as UnsignedTransactionRequestWithChainId, H as CustomAuthFlowState } from './types-65e80fae.js';
+export { a6 as Apple, ag as AppleOAuthWithMetadata, I as AsExternalProvider, ao as ContractUIOptions, a9 as CrossAppAccount, aj as CrossAppAccountWithMetadata, a3 as Discord, ac as DiscordOAuthWithMetadata, al as Email, _ as EmailWithMetadata, as as Farcaster, ah as FarcasterWithMetadata, a4 as Github, ad as GithubOAuthWithMetadata, a1 as Google, aa as GoogleOAuthWithMetadata, a5 as LinkedIn, af as LinkedInOAuthWithMetadata, au as LoginMethodOrderOption, K as MessageTypes, N as MoonpayConfig, Q as MoonpayCurrencyCode, aq as MoonpayFundingConfig, V as MoonpayPaymentMethod, ap as NativeFundingConfig, Z as NonEmptyArray, at as Passkey, ak as PasskeyWithMetadata, am as Phone, $ as PhoneWithMetadata, ar as PriceDisplayOptions, X as Quantity, a8 as Telegram, ai as TelegramWithMetadata, a7 as Tiktok, ae as TiktokOAuthWithMetadata, Y as TransactionLog, an as TransactionUIOptions, a2 as Twitter, ab as TwitterOAuthWithMetadata, J as TypedMessage, a0 as WalletWithMetadata } from './types-65e80fae.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { TurnstileProps } from '@marsidev/react-turnstile';
 import EventEmitter from 'eventemitter3';
@@ -126,6 +126,7 @@ interface BaseResponseWalletAccount {
      * @deprecated Use `wallet_client_type` instead.
      */
     wallet_client: 'privy' | 'unknown';
+    wallet_index: number | null;
     wallet_client_type?: string;
     connector_type?: string;
     recovery_method?: 'privy' | 'user-passcode';
@@ -299,6 +300,7 @@ interface GetCurrentUserResponse {
         refresh_token_expires_in_seconds?: number;
         scopes?: string[];
     };
+    custom_metadata?: Record<string, string>;
 }
 
 interface DefaultsType {
@@ -620,6 +622,12 @@ declare class PrivyClient {
         walletClientType?: string;
         connectorType?: string;
     }): Promise<User>;
+    /**
+     * Method to update the custom metadata associated with an authenticated user.
+     *
+     * @returns The user object.
+     */
+    setCustomMetadata(customMetadata: Record<string, string>): Promise<User>;
 }
 
 declare function getAccessToken(): Promise<string | null>;
@@ -1022,7 +1030,7 @@ interface PrivyInterface {
      *
      * @returns Promise for the {@link Wallet} object for the newly created embedded wallet
      */
-    createWallet: () => Promise<Wallet>;
+    createWallet: (options?: CreateWalletOptions | MouseEvent<any, any>) => Promise<Wallet>;
     /**
      * @deprecated. Use `setWalletRecovery` instead.
      *
@@ -1613,6 +1621,32 @@ interface PrivyEvents {
             balance: bigint | undefined;
         }) => void;
     };
+    setCustomMetadata: {
+        /**
+         * Callback that will execute once a successful `setCustomMetadata` completes.
+         * @param user - the the user with updated customMetadata
+         */
+        onSuccess?: (user: User) => void;
+        /**
+         * Callback that will execute in the case of a non-successful setCustomMetadata.
+         *
+         * @param error {@link PrivyErrorCode} - the corresponding error code
+         *  */
+        onError?: CallbackError;
+    };
+    customAuth: {
+        /**
+         * Callback that will execute when Privy successfully exchanges a custom auth JWT for a Privy JWT
+         * @param o.user - The Privy user
+         */
+        onAuthenticated: (o: {
+            user: User;
+        }) => void;
+        /**
+         * Callback that will execute when Privy detects a user is logged out from the third-party auth system, and correspondingly logs the user out.
+         */
+        onUnauthenticated: () => void;
+    };
 }
 
 /**
@@ -1933,7 +1967,7 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
      *
      * @returns Promise for the {@link Wallet} object for the newly created embedded wallet
      */
-    createWallet: () => Promise<Wallet>;
+    createWallet: (options?: CreateWalletOptions | react.MouseEvent<any, any>) => Promise<Wallet>;
 };
 
 /**
@@ -2212,6 +2246,28 @@ type UseOAuthTokens = {
  */
 declare function useOAuthTokens(callbacks?: PrivyEvents['oAuthAuthorization']): UseOAuthTokens;
 
+type UseCustomAuth = {
+    /**
+     * Object that indicates the status of Privy's custom auth flow.
+     *
+     * Possible values include: {
+     * status: 'initial' | 'loading' | 'not-enabled' | 'done';
+     * }
+     * or {
+     * status: 'error';
+     * error: Error | null;
+     * }
+     *
+     */
+    status: CustomAuthFlowState;
+};
+/**
+ * Use this hook to check the Privy auth flow status for whenever third-party/custom auth is enabled.
+ *
+ * @returns status - auth flow/ JWT exchange status of the Privy user, if custom auth is enabled
+ */
+declare const useCustomAuth: (callbacks?: PrivyEvents["customAuth"]) => UseCustomAuth;
+
 /**
  * @deprecated Use `useFarcasterSigner` instead.
  */
@@ -2227,6 +2283,27 @@ declare function useFarcasterSigner(): {
     requestFarcasterSignerFromWarpcast: () => Promise<void>;
 };
 
+type UseSetCustomMetadata = {
+    /**
+     * Method that allows a user to set the custom metadata value for their account. Fails if the input byte size is >1KB.
+     *
+     * @param customMetadata - JSON object of key-value string pairs to input as a user's customMetadata field.
+     * @returns - The user object with the updated customMetadata value.
+     *
+     */
+    setCustomMetadata: <CustomMetadataInput extends Record<string, string>>(customMetadata: CustomMetadataInput) => Promise<User>;
+};
+/**
+ * Use this hook to set custon metadata on the user object, and to attach callbacks
+ * for successful `metadata set`s, and `metadata set` errors.
+ *
+ * @param callbacks.onSuccess {@link PrivyEvents} callback to execute for a successful metadata setting
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `setCustomMetadata` -- ie.
+ * if the custom metadata input is too large (>1KB)
+ * @returns setCustomMetadata - makes a request to the Privy API to update user.customMetadata with the given input JSON
+ */
+declare function useSetCustomMetadata(callbacks?: PrivyEvents['setCustomMetadata']): UseSetCustomMetadata;
+
 /**
  * Allows you to override the RPC url for the given chain
  *
@@ -2294,4 +2371,4 @@ declare const LoginModal: ({ open }: {
     open: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
-export { CallbackError, Captcha, ConnectedSolanaWallet, ConnectedWallet, ConnectorManager, EIP1193Provider, FundWalletConfig, LoginModal, LoginWithCode, MfaMethod, OAuthProviderType, OAuthTokens, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, TransactionReceipt, UnsignedTransactionRequest, UseConnectCoinbaseSmartWalletInterface, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseOAuthTokens, UseSolanaWalletsInterface, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectCoinbaseSmartWallet, 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 };
+export { CallbackError, Captcha, ConnectedSolanaWallet, ConnectedWallet, ConnectorManager, CustomAuthFlowState, EIP1193Provider, FundWalletConfig, LoginModal, LoginWithCode, MfaMethod, OAuthProviderType, OAuthTokens, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendCodeToSms, SendTransactionModalUIOptions, SignMessageModalUIOptions, SignTypedDataParams, TransactionReceipt, UnsignedTransactionRequest, UseConnectCoinbaseSmartWalletInterface, UseCustomAuth, UseFundWalletInterface, UseLoginWithEmail, UseLoginWithSms, UseOAuthTokens, UseSetCustomMetadata, UseSolanaWalletsInterface, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, addRpcUrlOverrideToChain, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, getEmbeddedConnectedWallet, useConnectCoinbaseSmartWallet, useConnectWallet, useCreateWallet, useCrossAppAccounts, useCustomAuth, useExperimentalFarcasterSigner, useFarcasterSigner, useFundWallet, useGuestAccounts, useLinkAccount, useLinkWithSiwe, useLogin, useLoginWithEmail, useLoginWithOAuth, useLoginWithSms, useLogout, useMfa, useMfaEnrollment, useModalStatus, useOAuthTokens, usePrivy, useRegisterMfaListener, useSendTransaction, useSetCustomMetadata, useSetWalletPassword, useSetWalletRecovery, useSignMessage, useSignTypedData, useSolanaWallets, useToken, useWallets };