@privy-io/react-auth 1.27.0-beta.5 → 1.27.0-beta.7

package/dist/index.d.ts

@@ -632,9 +632,12 @@ type PrivyServerConfig = {
     privacyPolicyUrl: string | null;
     createdAt?: Date;
     updatedAt?: Date;
+    customApiUrl?: string | null;
+    embeddedWalletConfig: EmbeddedWalletsConfig;
+    /** May be deprecated from the server config in a future release */
     logoUrl?: string;
+    /** May be deprecated from the server config in a future release */
     accentColor?: string;
-    customApiUrl?: string | null;
 };
 type HexColor = `#${string}`;
 type PrivyClientConfig = {
@@ -683,12 +686,30 @@ type PrivyClientConfig = {
     /** All embedded wallets configuration */
     embeddedWallets?: {
         /**
-         * If true, privy will prompt users to create a password for their privy embedded wallet.
+         * Whether an embedded wallet should be created for the user on login. This overrides the
+         * deprecated `createPrivyWalletOnLogin`.
+         *
+         * For `all-users`, the user will be prompted to create a Privy wallet after successfully
+         * logging in. If they cancel or are visiting after this flag was put in place, they will be
+         * prompted to create a wallet on their next login.
+         *
+         * For `users-without-wallets`, the user will be prompted to create a Privy wallet after\
+         * successfully logging in, only if they do not currently have any wallet associated with their
+         * user object - for example if they have linked an external wallet.
+         *
+         * For `off`, an embedded wallet is not created during login. You can always prompt the user to
+         * create one manually with your app.
+         *
+         * Defaults to 'off'.
+         */
+        createOnLogin?: EmbeddedWalletCreateOnLoginConfig;
+        /**
+         * If true, Privy will prompt users to create a password for their Privy embedded wallet.
          * If false, embedded wallets will be created without the need of password.
          *
-         * Defaults to true.
+         * Defaults to false.
          */
-        requirePassword?: boolean;
+        requireUserPasswordOnCreate?: boolean;
     };
     /**
      * Override the default rendering settings, used for displaying in a non-modal setting.
@@ -719,6 +740,11 @@ interface AllowlistConfig {
     errorCtaText: string | null;
     errorCtaLink: string | null;
 }
+type EmbeddedWalletCreateOnLoginConfig = 'users-without-wallets' | 'all-users' | 'off';
+interface EmbeddedWalletsConfig {
+    createOnLogin: EmbeddedWalletCreateOnLoginConfig;
+    requireUserPasswordOnCreate: boolean;
+}
 type SignMessageModalUIOptions = {
     title?: string;
     description?: string;
@@ -763,9 +789,7 @@ interface PrivyProviderProps {
      */
     onSuccess?: (user: User, isNewUser: boolean) => void;
     /**
-     * If true, the user will be prompted to create a Privy wallet
-     * after successfully logging in, if they do not currently
-     * have any wallet associated with their user object.
+     * @deprecated use `config.embeddedWallets.createOnLogin` instead
      */
     createPrivyWalletOnLogin?: boolean;
     /**
@@ -800,7 +824,7 @@ interface PrivyProviderProps {
  * ```
  *
  */
-declare const PrivyProvider: (props: PrivyProviderProps) => JSX.Element;
+declare const PrivyProvider: ({ config, ...props }: PrivyProviderProps) => JSX.Element;
 
 interface ConnectorManagerEvents {
     walletsUpdated(): void;