@privy-io/react-auth 1.30.4 → 1.31.0-beta.1

package/dist/index.d.ts

@@ -177,6 +177,13 @@ declare enum PrivyErrorCode {
     INVALID_DATA = "invalid_data",
     LINKED_TO_ANOTHER_USER = "linked_to_another_user",
     ALLOWLIST_REJECTED = "allowlist_rejected",
+    OAUTH_INVALID_AUTH_CODE = "oauth_invalid_auth_code",
+    OAUTH_USER_DENIED = "oauth_user_denied",
+    UNKNOWN_AUTH_ERROR = "unknown_auth_error",
+    USER_EXITED_AUTH_FLOW = "exited_auth_flow",
+    MUST_BE_AUTHENTICATED = "must_be_authenticated",
+    UNKNOWN_CONNECT_WALLET_ERROR = "unknown_connect_wallet_error",
+    GENERIC_CONNECT_WALLET_ERROR = "generic_connect_wallet_error",
     CLIENT_REQUEST_TIMEOUT = "client_request_timeout"
 }
 
@@ -1386,4 +1393,73 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy, useWallets };
+type CallbackError = (error: PrivyErrorCode) => void;
+type PrivyEvents = {
+    login: {
+        /**
+         * Callback that will execute once a `login` flow successfully completes.
+         * - If `config.embeddedWallets.createOnLogin` is set to 'off' or a wallet creation flow is not applicable,
+         *   this will run after the user successfully authenticates.
+         * - If `config.embeddedWallets.createOnLogin` is set to 'users-without-wallets' or 'all-users',
+         *   this will run after the user successfully authenticates _and_ creates their wallet (if applicable).
+         *
+         * @param user {User} - the `user` oject corresponding to the authenticated user
+         * @param isNewUser {boolean} - boolean flag indicating if this is the user's first time logging in to your app
+         *
+         */
+        onSuccess?: (user: User, isNewUser: boolean) => void;
+        /**
+         * Callback that will execute in the case of a non-successful login.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         *
+         */
+        onError?: CallbackError;
+    };
+    logout: {
+        /**
+         * Callback that will execute when a user successfully logs out.
+         */
+        onSuccess?: () => void;
+    };
+    connectWallet: {
+        /**
+         * Callback that will execute once a successful `connectWallet` completes.
+         * This will not run in the case of a wallet-based authentication flow.
+         *
+         * @param wallet {BaseConnectedWallet}- the `wallet` object correspending to the connection
+         *
+         */
+        onSuccess?: (wallet: BaseConnectedWallet) => void;
+        /**
+         * Callback that will execute in the case of a non-successful wallet connection.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         *
+         */
+        onError?: CallbackError;
+    };
+};
+
+declare function useLogin(callbacks?: PrivyEvents['login']): {
+    /**
+     * Opens the Privy login modal and prompts the user to login.
+     */
+    login: () => void;
+};
+
+declare function useLogout(callbacks?: PrivyEvents['logout']): {
+    /**
+     * Log the current user out and clears their authentication state. `authenticated` will become false, `user` will become null, and the Privy Auth tokens will be deleted from the browser's local storage.
+     */
+    logout: () => Promise<void>;
+};
+
+declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
+    /**
+     * Opens the Privy modal and prompts the user to connect a wallet.
+     */
+    connectWallet: () => void;
+};
+
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };