@privy-io/react-auth 1.52.4 → 1.52.5-beta-20240108212636

package/dist/index.d.ts

@@ -703,6 +703,8 @@ interface ConnectorManagerEvents {
 declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     walletConnectors: WalletConnector[];
     initialized: boolean;
+    walletsReady: boolean;
+    private initializedWalletConnectors;
     private storedConnections;
     private activeWallet?;
     private walletConnectCloudProjectId;
@@ -783,6 +785,8 @@ declare class PrivyClient {
     authFlow?: AuthFlow;
     mfaFlow?: MfaFlow;
     connectors?: ConnectorManager;
+    onStoreToken?: ((token: string | null) => void) | undefined;
+    onDeleteToken?: (() => void) | undefined;
     /**
      * Creates a new Privy client.
      * @param options Initialization options.
@@ -2131,6 +2135,7 @@ interface UseWalletsInterface {
      * The user's connected wallets.
      */
     wallets: ConnectedWallet[];
+    ready: boolean;
 }
 declare function useWallets(): UseWalletsInterface;
 
@@ -2384,6 +2389,17 @@ type PrivyEvents = {
          */
         onMfaRequired: (mfaMethods: MfaMethod[]) => void;
     };
+    accessToken: {
+        /**
+         * Callback that will execute when a user's access token is granted.
+         * @param accessToken - The user's access token
+         */
+        onAccessTokenGranted: (accessToken: string) => void;
+        /**
+         * Callback that will execute when a user's access token is removed.
+         */
+        onAccessTokenRemoved: () => void;
+    };
 };
 
 /**
@@ -2549,4 +2565,15 @@ declare const useModalStatus: () => {
     isOpen: boolean;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseLoginWithEmail, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useWallets };
+/**
+ * Use this hook to tap into access token grant and revoke events.
+ *
+ * @param callbacks.onAccessTokenGranted {@link PrivyEvents} callback to automatically execute when a user is granted an access token. This will be called when a user logs in, or when a user's access token is refreshed.
+ * @param callbacks.onAccessTokenRemoved {@link PrivyEvents} callback to automatically execute when a user's access token is revoked.
+ * @returns getAccessToken - returns the user's current access token
+ */
+declare function useToken(callbacks?: PrivyEvents['accessToken']): {
+    getAccessToken: () => Promise<string | null>;
+};
+
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseLoginWithEmail, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletListEntry, WalletWithMetadata, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLogout, useMfa, useMfaEnrollment, useModalStatus, usePrivy, useRegisterMfaListener, useToken, useWallets };