@privy-io/react-auth 1.62.0 → 1.63.0-beta-20240501173029

package/dist/index.d.ts

@@ -3,10 +3,13 @@ import { ExternalProvider, StaticJsonRpcProvider, Web3Provider, TransactionRespo
 import { CountryCode } from 'libphonenumber-js/min';
 import { AbstractProvider } from 'web3-core';
 import EventEmitter from 'eventemitter3';
+import { PasskeyAuthenticateInputType } from '@privy-io/public-api';
 import { TypedMessage as TypedMessage$1, MessageTypes as MessageTypes$1 } from '@metamask/eth-sig-util';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { TurnstileProps } from '@marsidev/react-turnstile';
 import { Store, EIP6963ProviderDetail } from 'mipd';
+import * as _simplewebauthn_types from '@simplewebauthn/types';
+import { PublicKeyCredentialRequestOptionsJSON } from '@simplewebauthn/types';
 import { FetchOptions } from 'ofetch';
 
 /**
@@ -244,8 +247,9 @@ type WalletSetRecoveryPasswordRequestDataType = {
 type WalletRecoverRequestDataType = {
     address: string;
     accessToken: string;
-    mfaCode?: string;
+    mfaCode?: string | PasskeyAuthenticateInputType['authenticator_response'];
     mfaMethod?: MfaMethod;
+    relyingParty?: string;
     recoveryPassword?: string;
     recoveryMethod?: 'user-passcode' | 'google-drive';
     recoveryAccessToken?: string;
@@ -261,8 +265,9 @@ type WalletConnectRequestDataType = {
 };
 type WalletRpcRequestDataType = {
     accessToken: string;
-    mfaCode?: string;
+    mfaCode?: string | PasskeyAuthenticateInputType['authenticator_response'];
     mfaMethod?: MfaMethod;
+    relyingParty?: string;
     address: string;
     request: RpcRequestType;
 };
@@ -286,6 +291,10 @@ type MfaSubmitEnrollmentRequestDataType = {
     accessToken: string;
     method: 'totp';
     code: string;
+} | {
+    accessToken: string;
+    method: 'passkey';
+    credentialIds: string[];
 };
 type MfaUnenrollRequestDataType = {
     accessToken: string;
@@ -298,15 +307,17 @@ type FarcasterSignerInitRequestDataType = {
     address: string;
     hdWalletIndex: number | null;
     accessToken: string;
-    mfaCode: string | null;
+    mfaCode: string | PasskeyAuthenticateInputType['authenticator_response'] | null;
     mfaMethod: string | null;
+    relyingParty: string;
 };
 type FarcasterSubmitCastRequestDataType = {
     address: string;
     hdWalletIndex: number | null;
     accessToken: string;
-    mfaCode: string | null;
+    mfaCode: string | PasskeyAuthenticateInputType['authenticator_response'] | null;
     mfaMethod: string | null;
+    relyingParty: string;
     payload: any;
     fid: bigint;
 };
@@ -314,8 +325,9 @@ type FarcasterRemoveCastRequestDataType = {
     address: string;
     hdWalletIndex: number | null;
     accessToken: string;
-    mfaCode: string | null;
+    mfaCode: string | PasskeyAuthenticateInputType['authenticator_response'] | null;
     mfaMethod: string | null;
+    relyingParty: string;
     payload: any;
     fid: bigint;
 };
@@ -323,8 +335,9 @@ type FarcasterReactToCastRequestDataType = {
     address: string;
     hdWalletIndex: number | null;
     accessToken: string;
-    mfaCode: string | null;
+    mfaCode: string | PasskeyAuthenticateInputType['authenticator_response'] | null;
     mfaMethod: string | null;
+    relyingParty?: string;
     payload: any;
     fid: bigint;
 };
@@ -332,8 +345,9 @@ type FarcasterLinkRequestDataType = {
     address: string;
     hdWalletIndex: number | null;
     accessToken: string;
-    mfaCode: string | null;
+    mfaCode: string | PasskeyAuthenticateInputType['authenticator_response'] | null;
     mfaMethod: string | null;
+    relyingParty?: string;
     payload: any;
     fid: bigint;
 };
@@ -796,6 +810,7 @@ interface ResponseCustomJwtAccount {
 interface ResponsePasskeyAccount {
     type: 'passkey';
     credential_id: string;
+    enrolled_in_mfa: boolean;
     authenticator_name?: string;
     created_with_device?: string;
     created_with_os?: string;
@@ -1024,6 +1039,21 @@ declare class PrivyClient {
     logout(): Promise<void>;
     startAuthFlow<T extends AuthFlow>(authFlow: T): T;
     initMfaSmsVerification(): Promise<void>;
+    initMfaPasskeyVerification(): Promise<{
+        challenge: string;
+        allowCredentials: {
+            id: string;
+            type: "public-key";
+            transports: AuthenticatorTransport[];
+        }[];
+        timeout: number | undefined;
+        extensions: {
+            appid: string | undefined;
+            credProps: boolean | undefined;
+            hmacCreateSecret: boolean | undefined;
+        };
+        userVerification: UserVerificationRequirement;
+    }>;
     unlinkEmail(address: string): Promise<User>;
     acceptTerms(): Promise<User>;
     unlinkPhone(phoneNumber: string): Promise<User>;
@@ -1118,7 +1148,7 @@ type MoonpaySignResponse = {
 };
 
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github", "spotify", "tiktok", "linkedin", "apple"];
-declare const SUPPORTED_MFA_METHODS: readonly ["sms", "totp"];
+declare const SUPPORTED_MFA_METHODS: readonly ["sms", "totp", "passkey"];
 type MfaMethod = (typeof SUPPORTED_MFA_METHODS)[number];
 /**
  * Supported OAuth providers. Can be `'google'`, `'discord'`, `'twitter'`, `'github'`, `'spotify'`,
@@ -1450,6 +1480,8 @@ interface Farcaster {
 interface Passkey {
     /** The passkey credential ID */
     credentialId: string;
+    /** Whether or not this passkey can be used for MFA */
+    enrolledInMfa: boolean;
     /** The type of authenticator holding the passkey */
     authenticatorName?: string;
     /** Metadata about the device that registered the passkey  */
@@ -2521,6 +2553,13 @@ interface PrivyInterface {
         secret: string;
         authUrl: string;
     }>;
+    /**
+     * Initiate the enrollment flow for Passkey MFA for the current user.
+     *
+     * @returns {@link void} The TOTP Auth Url is used to encode
+     * into a QR Code for the user to scane.
+     */
+    initEnrollmentWithPasskey: () => Promise<void>;
     /**
      * Submit the MFA code to complete SMS enrollment process.
      *
@@ -2540,6 +2579,15 @@ interface PrivyInterface {
     submitEnrollmentWithTotp: (meta: {
         mfaCode: string;
     }) => Promise<void>;
+    /**
+     * Submit the passkey to complete the enrollment process.
+     *
+     * @param meta {@link {credentialIds: string[]}} The passkey credentialIds to enroll in MFA.
+     * @returns Promise for the MFA code submission.
+     */
+    submitEnrollmentWithPasskey: (meta: {
+        credentialIds: string[];
+    }) => Promise<void>;
     /**
      * Triggers the MFA verification flow if the user has an MFA method enrolled.
      *
@@ -2552,7 +2600,7 @@ interface PrivyInterface {
      * @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>;
+    init: (mfaMethod: MfaMethod) => Promise<void | PublicKeyCredentialRequestOptionsJSON>;
     /**
      * Submit the MFA code for the current user. This will attempt to complete the MFA flow.
      *
@@ -2568,7 +2616,7 @@ interface PrivyInterface {
      * @param mfaCode {string} The MFA code to submit.
      * @returns Promise for the MFA code submission.
      */
-    submit: (mfaMethod: MfaMethod, mfaCode: string) => Promise<void>;
+    submit: (mfaMethod: MfaMethod, mfaCode: string | PublicKeyCredentialRequestOptionsJSON) => Promise<void>;
     /**
      * Cancel the MFA flow for the current user. If there is no pending MFA verification,
      * this function is a no-op.
@@ -2720,8 +2768,8 @@ declare function useWallets(): UseWalletsInterface;
  */
 declare function useMfa(): {
     promptMfa: () => Promise<void>;
-    init: (mfaMethod: "sms" | "totp") => Promise<void>;
-    submit: (mfaMethod: "sms" | "totp", mfaCode: string) => Promise<void>;
+    init: (mfaMethod: "sms" | "totp" | "passkey") => Promise<void | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON>;
+    submit: (mfaMethod: "sms" | "totp" | "passkey", mfaCode: string | _simplewebauthn_types.PublicKeyCredentialRequestOptionsJSON) => Promise<void>;
     cancel: () => void;
 };
 
@@ -2738,34 +2786,6 @@ declare function useMfa(): {
  * @returns closeMfaEnrollmentModal - closes the MFA enrollment modal
  *
  * @example
- * const {initEnrollment} = useMfaEnrollment();
- *
- * <button
- *   onClick={() => {
- *     initEnrollment(
- *       'sms',
- *       { phoneNumber: '<user-phone-number>' },
- *     );
- *   }}
- * >
- *   Enroll in SMS MFA
- * </button>
- *
- * @example
- * const {submitEnrollment} = useMfaEnrollment();
- *
- * <button
- *   onClick={() => {
- *     submitEnrollment(
- *       'sms',
- *       { phoneNumber: '<user-phone-number>', mfaCode: '<user-mfa-code>' },
- *     );
- *   }}
- * >
- *   Enroll in SMS MFA
- * </button>
- *
- * @example
  * const {unenrollWithSms} = useMfaEnrollment();
  *
  * <button
@@ -2795,6 +2815,7 @@ declare function useMfaEnrollment(): {
         secret: string;
         authUrl: string;
     }>;
+    initEnrollmentWithPasskey: () => Promise<void>;
     submitEnrollmentWithSms: (meta: {
         phoneNumber: string;
         mfaCode: string;
@@ -2802,8 +2823,12 @@ declare function useMfaEnrollment(): {
     submitEnrollmentWithTotp: (meta: {
         mfaCode: string;
     }) => Promise<void>;
+    submitEnrollmentWithPasskey: (meta: {
+        credentialIds: string[];
+    }) => Promise<void>;
     unenrollWithSms: () => Promise<void>;
     unenrollWithTotp: () => Promise<void>;
+    unenrollWithPasskey: () => Promise<void>;
     showMfaEnrollmentModal: () => void;
     closeMfaEnrollmentModal: () => void;
 };