@privy-io/react-auth 1.34.2-beta.1 → 1.35.0-beta.10

package/dist/index.d.ts

@@ -459,7 +459,7 @@ type WalletBranding = {
     name: string;
     icon?: string | EmbeddedSVG;
 };
-type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'apple_oauth';
+type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth' | 'apple_oauth' | 'custom_auth';
 /** @ignore */
 interface LinkMetadata {
     /** Account type, most commonly useful when filtering through linkedAccounts */
@@ -634,6 +634,10 @@ interface Apple {
     /** The email associated with the Apple account. */
     email: string;
 }
+interface CustomJwtAccount {
+    /** The user ID given by the custom auth provider */
+    customUserId: string;
+}
 /** Object representation of a user's email, with additional metadata for advanced use cases. */
 interface EmailWithMetadata extends LinkMetadata, Email {
     /** Denotes that this is an email account. */
@@ -674,10 +678,15 @@ interface AppleOAuthWithMetadata extends LinkMetadata, Apple {
     /** Denotes that this is a Apple account. */
     type: 'apple_oauth';
 }
+/** Object representation of a user's Custom JWT Account, with additional metadata for advanced use cases. */
+interface CustomJwtAccountWithMetadata extends LinkMetadata, CustomJwtAccount {
+    /** Denotes that this is an custom account. */
+    type: 'custom_auth';
+}
 /**
  * Object representation of a user's linked accounts
  */
-type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | AppleOAuthWithMetadata;
+type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata | AppleOAuthWithMetadata | CustomJwtAccountWithMetadata;
 interface User {
     /** The Privy-issued DID for the user. If you need to store additional information
      * about a user, you can use this DID to reference them. */
@@ -767,6 +776,52 @@ type PrivyClientConfig = {
      *  `loginMethods` cannot be an empty array if specified.
      *  The order of this array does not currently dictate order of the login methods in the UI, but may in the future. */
     loginMethods?: Array<'wallet' | 'email' | 'sms' | 'google' | 'twitter' | 'discord' | 'github' | 'apple'>;
+    /**
+     * This property is only required for apps that use a third-party authentication provider.
+     */
+    customAuth?: {
+        /**
+         * If true, enable custom authentication integration.
+         * This enables a JWT from a custom auth provider to be used to authenticate Privy embedded wallets.
+         * Defaults to true.
+         *
+         * @default true
+         */
+        enabled?: boolean;
+        /**
+         * A callback that returns the user's custom auth provider's access token as a string.
+         * Can be left blank if using cookies to store and send access tokens
+         *
+         * @example
+         * const {getAccessTokenSilently} = useAuth();
+         *
+         * <PrivyProvider
+         *   {...props}
+         *   config={{
+         *     customAuth: {
+         *       getCustomAccessToken: getAccessTokenSilently
+         *     },
+         *   }}
+         * />
+         */
+        getCustomAccessToken: () => Promise<string | undefined>;
+        /**
+         * Custom auth providers loading state
+         *
+         * @example
+         * const {isLoading} = useAuth();
+         *
+         * <PrivyProvider
+         *   {...props}
+         *   config={{
+         *     customAuth: {
+         *       isLoading,
+         *     },
+         *   }}
+         * />
+         */
+        isLoading: boolean;
+    };
     /** All legal configuration */
     legal?: {
         /** URL to the terms and conditions page for your application.
@@ -1443,7 +1498,12 @@ interface ResponseOAuthApple {
     email: string;
     verified_at: number;
 }
-type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthApple>;
+interface ResponseCustomJwtAccount {
+    type: 'custom_auth';
+    custom_user_id: string;
+    verified_at: number;
+}
+type LinkedAccountsResponseType = Array<ResponseEmailAccount | ResponsePhoneAccount | ResponseEthereumAccount | ResponseOAuthGoogle | ResponseOAuthTwitter | ResponseOAuthDiscord | ResponseOAuthGithub | ResponseOAuthApple | ResponseCustomJwtAccount>;
 interface GetCurrentUserResponse {
     id: string;
     created_at: number;