@privy-io/react-auth 1.73.2 → 1.74.0

package/dist/index.d.ts

@@ -1267,7 +1267,7 @@ type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
  * Supported OAuth providers for the recovery flow. Can be `'google-drive'`
  */
 type RecoveryProviderType = (typeof SUPPORTED_RECOVERY_PROVIDERS)[number];
-type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram' | `privy:${string}`;
+type LoginMethod = 'email' | 'sms' | 'siwe' | 'farcaster' | OAuthProviderType | 'passkey' | 'telegram' | 'custom' | `privy:${string}`;
 type LoginWithCode = {
     /**
      * One-time password _([OTP](https://en.wikipedia.org/wiki/One-time_password))_ that was sent to user during first login step
@@ -2437,6 +2437,8 @@ interface PrivyProviderProps {
     /** Your Privy App Client ID, which can be retrieved from the Privy dashboard. */
     clientId?: string;
     /**
+     * @deprecated. Use the `onSuccess` callback registered via the `useLogin` hook instead.
+     *
      * An optional callback that will execute once a `login` call successfully completes.
      *
      * Within this callback, you can access:
@@ -3186,7 +3188,10 @@ declare function errorIndicatesMaxMfaRetries(error: unknown): error is PrivyIfra
 
 declare const VERSION: string;
 
-type CallbackError = (error: PrivyErrorCode) => void;
+/**
+ * `CallbackError` optionally includes a second parameter with further error details.
+ */
+type CallbackError<Details extends Record<string, any> | undefined = undefined> = Details extends Record<string, any> ? (error: PrivyErrorCode, details: Details) => void : (error: PrivyErrorCode) => void;
 interface PrivyEvents {
     login: {
         /**
@@ -3276,9 +3281,12 @@ interface PrivyEvents {
          * Callback that will execute in the case of a non-successful account linking.
          *
          * @param error {PrivyErrorCode} - the corresponding error code
+         * @param details.linkMethod {LoginMethod} - the type of (attempted) linked account
          *
          */
-        onError?: CallbackError;
+        onError?: CallbackError<{
+            linkMethod: LoginMethod;
+        }>;
     };
     configureMfa: {
         /**
@@ -3378,8 +3386,12 @@ interface PrivyEvents {
          * if the refresh token is present and this field is undefined, it is assumed
          * that the refresh token does not have an expiration date.
          * @param oAuthTokens.scopes -  {string[]} (optional) The list of OAuth scopes the access token is approved for.
+         *
+         * @param o.user {@link User} (optional) The list of OAuth scopes the access token is approved for.
          */
-        onOAuthTokenGrant: (oAuthTokens: OAuthTokens) => void;
+        onOAuthTokenGrant: (oAuthTokens: OAuthTokens, o: {
+            user: User;
+        }) => void;
     };
 }