@privy-io/react-auth 1.43.4 → 1.44.0-beta-20231020144049

package/dist/index.d.ts

@@ -220,6 +220,8 @@ type WalletConnectRequestDataType = {
 };
 type WalletRpcRequestDataType = {
     accessToken: string;
+    mfaCode?: string;
+    mfaMethod?: MfaMethod;
     address: string;
     request: RpcRequestType;
 };
@@ -290,6 +292,8 @@ declare enum PrivyErrorCode {
     GENERIC_CONNECT_WALLET_ERROR = "generic_connect_wallet_error",
     CLIENT_REQUEST_TIMEOUT = "client_request_timeout",
     INVALID_CREDENTIALS = "invalid_credentials",
+    MISSING_MFA_CREDENTIALS = "missing_mfa_credentials",
+    UNKNOWN_MFA_ERROR = "unknown_mfa_error",
     EMBEDDED_WALLET_ALREADY_EXISTS = "embedded_wallet_already_exists",
     UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error",
     EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed",
@@ -565,10 +569,16 @@ interface ResponseCustomJwtAccount {
     verified_at: number;
 }
 type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthTiktok | ResponseOAuthLinkedIn | ResponseOAuthApple | ResponseCustomJwtAccount>;
+interface ResponseSmsMfaMethod {
+    type: 'sms';
+    verified_at: number;
+}
+type LinkedMfaMethodsResponseType = Array<ResponseSmsMfaMethod>;
 interface GetCurrentUserResponse {
     id: string;
     created_at: number;
     linked_accounts: LinkedAccountsResponseType;
+    mfa_methods: LinkedMfaMethodsResponseType;
 }
 
 interface DefaultsType {
@@ -691,6 +701,16 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     setActiveWallet(address: string): void;
 }
 
+type MfaAuthMeta = {
+    [key: string]: any;
+};
+interface MfaFlow {
+    api?: Http;
+    meta?: MfaAuthMeta;
+    init(): Promise<void>;
+    authenticate(): Promise<User>;
+}
+
 /**
  * This should not be directly used by developers at the moment,
  * so we doc-ignore it.
@@ -708,6 +728,7 @@ declare class PrivyClient {
     apiUrl: string;
     fallbackApiUrl: string;
     authFlow?: AuthFlow;
+    mfaFlow?: MfaFlow;
     connectors?: ConnectorManager;
     /**
      * Creates a new Privy client.
@@ -746,6 +767,7 @@ declare class PrivyClient {
     link(): Promise<User | null>;
     logout(): Promise<void>;
     startAuthFlow(authFlow: AuthFlow): void;
+    startMfaFlow(mfaFlow: MfaFlow): void;
     unlinkEmail(address: string): Promise<User>;
     unlinkPhone(phoneNumber: string): Promise<User>;
     unlinkWallet(address: string): Promise<User>;
@@ -829,6 +851,8 @@ type MoonpaySignResponse = {
 };
 
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "tiktok", "linkedin", "apple"];
+declare const SUPPORTED_MFA_METHODS: readonly ["sms"];
+type MfaMethod = (typeof SUPPORTED_MFA_METHODS)[number];
 type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
 type EmbeddedWalletClientType = 'privy';
 type InjectedWalletClientType = 'metamask' | 'phantom';
@@ -1168,6 +1192,8 @@ interface User {
     /** The list of accounts associated with this user. Each account contains additional metadata
      * that may be helpful for advanced use cases. */
     linkedAccounts: Array<LinkedAccountWithMetadata>;
+    /** The list of MFA Methods associated with this user. */
+    mfaMethods: Array<MfaMethod>;
 }
 type PrivyServerConfig = {
     id?: string;
@@ -1795,6 +1821,42 @@ interface PrivyInterface {
      * @returns Promise for the signature as a string
      */
     signMessage: (message: string, uiOptions?: SignMessageModalUIOptions) => Promise<string>;
+    /**
+     * Initiate the enrollment flow for MFA for the current user.
+     *
+     * @param mfaMethod {@link MfaMethod} The MFA method to enroll for the current user.
+     * @param meta {@link {phoneNumber: string}} The meta data needed to complete the MFA flow.
+     * @returns Promise for enrolling the current user with the chosen MFA method.
+     */
+    initEnroll: (mfaMethod: MfaMethod, meta: {
+        phoneNumber: string;
+    }) => Promise<void>;
+    /**
+     * Submit the MFA code to complete enrollment process.
+     *
+     * @param method {@link MfaMethod} The MFA method to be used.
+     * @param meta {@link {phoneNumber: string; mfaCode: string}} The MFA code and phone number to submit.
+     * @returns Promise for the MFA code submission.
+     */
+    submitEnroll: (mfaMethod: MfaMethod, meta: {
+        phoneNumber: string;
+        mfaCode: string;
+    }) => Promise<void>;
+    /**
+     * Initiate the MFA flow for the current user.
+     *
+     * @param mfaMethod {@link MfaMethod} The available MFA method to trigger for the current user.
+     * @returns Promise for sending the MFA code to the user's device.
+     */
+    init: (mfaMethod: MfaMethod) => Promise<void>;
+    /**
+     * Submit the MFA code for the current user.
+     *
+     * @param method {@link MfaMethod} The MFA method to be used.
+     * @param mfaCode {string} The MFA code to submit.
+     * @returns Promise for the MFA code submission.
+     */
+    submit: (mfaMethod: MfaMethod, mfaCode: string) => Promise<void>;
     /**
      * Prompts a user to send a transaction using their embedded wallet.
      *
@@ -1843,8 +1905,6 @@ interface UseWalletsInterface {
 }
 declare function useWallets(): UseWalletsInterface;
 
-declare const VERSION: string;
-
 type CallbackError = (error: PrivyErrorCode) => void;
 type PrivyEvents = {
     login: {
@@ -1908,8 +1968,43 @@ type PrivyEvents = {
          */
         onError?: CallbackError;
     };
+    configureMfa: {
+        /**
+         * Callback that will execute when MFA is required to complete a given action.
+         * @param mfaMethods {@link MfaMethod[]} - List of MFA methods that the user can choose from
+         */
+        onPromptMfa: (mfaMethods: MfaMethod[]) => void;
+        /**
+         * Callback that will execute in the case of a non-successful MFA flow.
+         *
+         * @param error {PrivyErrorCode} - the corresponding error code
+         *
+         */
+        onError?: CallbackError;
+    };
 };
 
+/**
+ * Use this hook to listen for MFA required events and prompt the user to complete MFA.
+ *
+ * @param callbacks.onPromptMfa {@link PrivyEvents} callback to execute to start `MFA Flow` when it is required for an action.
+ * @param callbacks.onError {@link PrivyEvents} callback to execute if there is an error during `MFA Flow`.
+ * @returns initMfa, submitMfa, cancelMfaFlow - Tells the developer where they are in the MFA flow.
+ */
+declare function useConfigureMfa(callbacks: PrivyEvents['configureMfa']): {
+    init: (mfaMethod: "sms") => Promise<void>;
+    submit: (mfaMethod: "sms", mfaCode: string) => Promise<void>;
+    submitEnroll: (mfaMethod: "sms", meta: {
+        phoneNumber: string;
+        mfaCode: string;
+    }) => Promise<void>;
+    initEnroll: (mfaMethod: "sms", meta: {
+        phoneNumber: string;
+    }) => Promise<void>;
+};
+
+declare const VERSION: string;
+
 /**
  * Use this hook to log the user in, and to attach callbacks
  * for successful `login`s, already-`authenticated` users, and
@@ -1980,4 +2075,4 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
     createWallet: () => Promise<Wallet>;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLogout, usePrivy, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConfigureMfa, useConnectWallet, useCreateWallet, useLogin, useLogout, usePrivy, useWallets };