@privy-io/react-auth 1.47.1 → 1.47.2

package/dist/index.d.ts

@@ -1983,6 +1983,16 @@ interface PrivyInterface {
      * @returns Promise for the MFA code submission.
      */
     submit: (mfaMethod: MfaMethod, mfaCode: string) => Promise<void>;
+    /**
+     * Cancel the MFA flow for the current user. If there is no pending MFA verification,
+     * this function is a no-op.
+     *
+     * Call this method instead of `submit` when a user has been prompted for
+     * MFA but decides to exit the flow.
+     *
+     * @returns void.
+     */
+    cancel: () => void;
     /**
      * Prompts a user to send a transaction using their embedded wallet.
      *
@@ -2036,17 +2046,23 @@ declare function useWallets(): UseWalletsInterface;
  *
  * @returns init - starts the MFA verification flow
  * @returns submit - completes the MFA verification flow
+ * @returns cancel - cancels the MFA verification flow
  *
  * @example
  * // MFA flow
  *
  * const MFAModal = ({ mfaMethods, isOpen, setIsOpen }: Props) => {
- *   const {init, submit} = useMfa();
+ *   const {init, submit, cancel} = useMfa();
  *   const [selectedMethod, setSelectedMethod] = useState(null)
  *   const [mfaCode, setMfaCode] = useState('')
  *
+ *   const handleClose = () => {
+ *     cancel();
+ *     setIsOpen(false);
+ *   };
+ *
  *   return (
- *     <Modal isOpen={isOpen} onClose={() => setIsOpen(false)}>
+ *     <Modal isOpen={isOpen} onClose={handleClose}>
  *       // Capture the user's MFA code
  *       {selectedMethod && (
  *         <button
@@ -2106,6 +2122,7 @@ declare function useWallets(): UseWalletsInterface;
 declare function useMfa(): {
     init: (mfaMethod: "sms" | "totp") => Promise<void>;
     submit: (mfaMethod: "sms" | "totp", mfaCode: string) => Promise<void>;
+    cancel: () => void;
 };
 
 /**