@privy-io/react-auth 1.18.0 → 1.19.0-beta.2

package/dist/index.d.ts

@@ -168,13 +168,10 @@ interface User {
      * that may be helpful for advanced use cases. */
     linkedAccounts: Array<LinkedAccountWithMetadata>;
 }
-interface AppSettings {
+type PrivyServerConfig = {
     id?: string;
     name?: string;
     verificationKey?: string;
-    logoUrl?: string;
-    theme?: 'System' | 'Light' | 'Dark' | string;
-    accentColor?: string;
     showWalletLoginFirst?: boolean;
     allowlistConfig: AllowlistConfig;
     walletAuth?: boolean;
@@ -188,7 +185,30 @@ interface AppSettings {
     privacyPolicyUrl: string | null;
     createdAt?: Date;
     updatedAt?: Date;
-}
+    logoUrl?: string;
+    accentColor?: string;
+};
+type HexColor = `#${string}`;
+type PrivyClientConfig = {
+    /** All UI and theme related configuration */
+    appearance?: {
+        /** Primary theme for the privy UI. This dictates the foreground and background colors within the UI.
+         *
+         *  'light' (default): The privy default light UI.
+         *  'dark': The privy default dark UI.
+         *  custom hex code (i.e. '#13152F'): A custom background. This will generate the remainder of the foreground and
+         *  background colors for the UI by modulating the luminance of the passed color. This value should be _either_ dark
+         *  or light (<20% or >80% luminance), for accessibility. */
+        theme?: 'light' | 'dark' | HexColor;
+        /** Accent color for the privy UI.
+         *  Used for buttons, active borders, etc. This will generate light and dark variants.
+         *  This overrides the server setting `accent_color`. */
+        accentColor?: HexColor;
+        /** Logo url for the main privy modal screen.
+         *  This overrides the server setting `logo_url` */
+        logo?: string;
+    };
+};
 interface AllowlistConfig {
     errorTitle: string | null;
     errorDetail: string | null;
@@ -223,6 +243,11 @@ interface PrivyProviderProps {
      * have any wallet associated with their user object.
      */
     createPrivyWalletOnLogin?: boolean;
+    /**
+     * Client configuration options.
+     * Values here will override their server-configuration counterparts.
+     */
+    config?: PrivyClientConfig;
     /**
      * @ignore
      * @class
@@ -809,7 +834,7 @@ declare class PrivyClient {
     getAccessToken(options?: {
         disableAutoRefresh?: boolean;
     }): Promise<string | null>;
-    getAppSettings(): Promise<AppSettings>;
+    getServerConfig(): Promise<PrivyServerConfig>;
     setActiveWallet(address: string, user: User): Promise<User>;
     /**
      * Get a short-lived token to start a new Privy session from the existing authenticated session.
@@ -823,4 +848,4 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, SignMessageModalUIOptions, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };
+export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, SignMessageModalUIOptions, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };