@privy-io/react-auth 1.60.7 → 1.61.0-beta-20240423144828

package/dist/index.d.ts

@@ -223,6 +223,8 @@ declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Ch
 type WalletCreateRequestDataType = {
     accessToken: string;
     recoveryPassword?: string;
+    recoveryMethod?: 'user-passcode' | 'google-drive';
+    recoveryAccessToken?: string;
     /**
      * Will be deprecated in a future release, use `recoveryPassword` instead
      * @deprecated
@@ -245,6 +247,8 @@ type WalletRecoverRequestDataType = {
     mfaCode?: string;
     mfaMethod?: MfaMethod;
     recoveryPassword?: string;
+    recoveryMethod?: 'user-passcode' | 'google-drive';
+    recoveryAccessToken?: string;
     /**
      * Will be deprecated in a future release, use `recoveryPassword` instead
      * @deprecated
@@ -456,6 +460,7 @@ declare enum PrivyErrorCode {
     UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error",
     EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed",
     EMBEDDED_WALLET_PASSWORD_ALREADY_EXISTS = "embedded_wallet_password_already_exists",
+    EMBEDDED_WALLET_RECOVERY_ALREADY_EXISTS = "embedded_wallet_recovery_already_exists",
     TRANSACTION_FAILURE = "transaction_failure",
     UNSUPPORTED_CHAIN_ID = "unsupported_chain_id",
     CAPTCHA_TIMEOUT = "captcha_timeout",
@@ -934,10 +939,10 @@ interface MfaFlow {
  */
 declare class PrivyClient {
     #private;
-    private api;
     private appId;
     private session;
     private timeout;
+    api: Http;
     clientAnalyticsId: string | null;
     useServerCookies: boolean;
     apiUrl: string;
@@ -1137,6 +1142,11 @@ type FundWalletConfig = {
     config: MoonpayConfig;
     provider?: 'moonpay';
 };
+/**
+ * Possible methods of user-driven recovery.
+ * This is set, per app, on the server.
+ */
+type UserRecoveryMethod = 'user-passcode' | 'google-drive';
 /**
  * Object representation of a user's wallet.
  */
@@ -1196,7 +1206,7 @@ interface Wallet {
      *     1. 'privy': privy escrow of the recovery material
      *     2. 'user-passcode': recovery protected by user-input passcode
      */
-    recoveryMethod?: 'privy' | 'user-passcode';
+    recoveryMethod?: 'privy' | UserRecoveryMethod;
 }
 /**
  * Object representation of metadata reported by a connected wallet from a wallet connector
@@ -1871,7 +1881,8 @@ interface AllowlistConfig {
 type EmbeddedWalletCreateOnLoginConfig = 'users-without-wallets' | 'all-users' | 'off';
 interface EmbeddedWalletsConfig {
     createOnLogin: EmbeddedWalletCreateOnLoginConfig;
-    requireUserPasswordOnCreate: boolean;
+    requireUserOwnedRecoveryOnCreate: boolean;
+    userOwnedRecoveryOptions: UserRecoveryMethod[];
 }
 type OtpFlowState = {
     status: 'initial';
@@ -2388,9 +2399,9 @@ interface PrivyInterface {
      * This method will error if the user already has an embedded wallet or if they
      * exit in the middle of the flow.
      *
-     * If the `config.embeddedWallets.requireUserPasswordOnCreate` property is set to true,
-     * this will prompt the user to enter a passcode to secure the recovery share of their
-     * embedded wallet.
+     * If the `config.embeddedWallets.requireUserOwnedRecoveryOnCreate` property is set to true,
+     * this will prompt the user to complete a recovery flow to secure the recovery
+     * share of their embedded wallet.
      *
      * Otherwise (the default), Privy will secure the recovery share, and the embedded wallet
      * will be created without showing any UIs to the user.
@@ -2399,8 +2410,6 @@ interface PrivyInterface {
      */
     createWallet: () => Promise<Wallet>;
     /**
-     * Prompt the user to enter a password to secure the recovery of their embedded wallet.
-     *
      * This method will error if the user does not have an embedded wallet, if the user's
      * embedded wallet already has a password set, or if the user exits in the middle of the flow.
      *
@@ -3171,9 +3180,9 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
      *
      * This method will error if the user already has an embedded wallet
      *
-     * If the `config.embeddedWallets.requireUserPasswordOnCreate` property is set to true,
-     * this will prompt the user to enter a password to secure the recovery share of their
-     * embedded wallet.
+     * If the `config.embeddedWallets.requireUserOwnedRecoveryOnCreate` property is set to true,
+     * this will prompt the user to complete a recovery flow to secure
+     * the recovery share of their embedded wallet.
      *
      * Otherwise (the default), Privy will secure the recovery share, and the embedded wallet
      * will be created without showing any UIs to the user.