@privy-io/react-auth 1.49.2 → 1.49.3-beta-20231130190830

package/dist/index.d.ts

@@ -1274,6 +1274,7 @@ type PrivyServerConfig = {
     logoUrl?: string;
     /** May be deprecated from the server config in a future release */
     accentColor?: string;
+    mfaMethods?: Array<MfaMethod>;
 };
 type HexColor = `#${string}`;
 /**
@@ -1480,6 +1481,20 @@ type PrivyClientConfig = {
          */
         priceDisplay?: PriceDisplayOptions;
     };
+    /**
+     * All multi-factor authentication configuration
+     */
+    mfa?: {
+        /**
+         * If true, Privy will not prompt or instantiate any UI for MFA Verification. The developer
+         * must handle MFA verification themselves.
+         * If false, any action that requires MFA will raise a modal and require user to verify MFA
+         * before proceeding.
+         *
+         * Defaults to false.
+         */
+        noPromptOnMfaRequired?: boolean;
+    };
     /**
      * Setting associated with fiat-on-ramp flows
      */
@@ -1934,6 +1949,13 @@ interface PrivyInterface {
      * @returns Promise for the signature as a string
      */
     signMessage: (message: string, uiOptions?: SignMessageModalUIOptions) => Promise<string>;
+    /**
+     * Function to control the visibility of the enrollment modal.
+     *
+     * @param show {boolean} controls the visibility of the enrollment modal.
+     * @returns Promise for opening the enrollment modal.
+     */
+    enrollInMfa: (show?: boolean) => void;
     /**
      * Initiate the enrollment flow for MFA for the current user.
      *
@@ -2154,6 +2176,8 @@ declare function useMfa(): {
  * @returns submitEnrollmentWithTotp - completes the MFA enrollment flow for TOTP
  * @returns unenrollWithSms - unenrolls the SMS MFA method
  * @returns unenrollWithTotp - unenrolls the TOTP MFA method
+ * @returns showMfaEnrollmentModal - opens the MFA enrollment modal
+ * @returns closeMfaEnrollmentModal - closes the MFA enrollment modal
  *
  * @example
  * const {initEnrollment} = useMfaEnrollment();
@@ -2200,6 +2224,8 @@ declare function useMfaEnrollment(): {
     }) => Promise<void>;
     unenrollWithSms: () => Promise<void>;
     unenrollWithTotp: () => Promise<void>;
+    showMfaEnrollmentModal: () => void;
+    closeMfaEnrollmentModal: () => void;
 };
 
 declare class PrivyIframeError extends Error {