@auth0/auth0-react 2.6.0 → 2.8.0

package/dist/index.d.ts

@@ -1,8 +1,8 @@
-export { default as Auth0Provider, Auth0ProviderOptions, AppState, } from './auth0-provider';
+export { default as Auth0Provider, Auth0ProviderOptions, AppState, ConnectedAccount } from './auth0-provider';
 export { default as useAuth0 } from './use-auth0';
 export { default as withAuth0, WithAuth0Props } from './with-auth0';
 export { default as withAuthenticationRequired, WithAuthenticationRequiredOptions, } from './with-authentication-required';
 export { default as Auth0Context, Auth0ContextInterface, initialContext, LogoutOptions, RedirectLoginOptions, } from './auth0-context';
-export { AuthorizationParams, PopupLoginOptions, PopupConfigOptions, GetTokenWithPopupOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, User, ICache, InMemoryCache, LocalStorageCache, Cacheable, TimeoutError, MfaRequiredError, PopupCancelledError, PopupTimeoutError, AuthenticationError, MissingRefreshTokenError, GenericError, UseDpopNonceError, type FetcherConfig } from '@auth0/auth0-spa-js';
+export { AuthorizationParams, PopupLoginOptions, PopupConfigOptions, GetTokenWithPopupOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, User, ICache, InMemoryCache, LocalStorageCache, Cacheable, TimeoutError, MfaRequiredError, PopupCancelledError, PopupTimeoutError, AuthenticationError, MissingRefreshTokenError, GenericError, UseDpopNonceError, type FetcherConfig, RedirectConnectAccountOptions, ConnectAccountRedirectResult, ResponseType, ConnectError } from '@auth0/auth0-spa-js';
 export { OAuthError } from './errors';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,aAAa,EACxB,oBAAoB,EACpB,QAAQ,GACT,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,iCAAiC,GAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EACjB,KAAK,aAAa,EACnB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,IAAI,aAAa,EACxB,oBAAoB,EACpB,QAAQ,EACR,gBAAgB,EACjB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,IAAI,QAAQ,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACpE,OAAO,EACL,OAAO,IAAI,0BAA0B,EACrC,iCAAiC,GAClC,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,OAAO,IAAI,YAAY,EACvB,qBAAqB,EACrB,cAAc,EACd,aAAa,EACb,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,mBAAmB,EACnB,wBAAwB,EACxB,YAAY,EACZ,iBAAiB,EACjB,KAAK,aAAa,EAClB,6BAA6B,EAC7B,4BAA4B,EAC5B,YAAY,EACZ,YAAY,EACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Auth0",
   "name": "@auth0/auth0-react",
-  "version": "2.6.0",
+  "version": "2.8.0",
   "description": "Auth0 SDK for React Single Page Applications (SPA)",
   "keywords": [
     "auth0",
@@ -95,6 +95,6 @@
     "react-dom": "^16.11.0 || ^17 || ^18 || ^19"
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "^2.5.0"
+    "@auth0/auth0-spa-js": "^2.7.0"
   }
 }

package/src/auth0-context.tsx

@@ -10,6 +10,8 @@ import {
   GetTokenSilentlyVerboseResponse,
   RedirectLoginOptions as SPARedirectLoginOptions,
   type Auth0Client,
+  RedirectConnectAccountOptions,
+  ConnectAccountRedirectResult
 } from '@auth0/auth0-spa-js';
 import { createContext } from 'react';
 import { AuthState, initialAuthState } from './auth-state';
@@ -120,6 +122,28 @@ export interface Auth0ContextInterface<TUser extends User = User>
     config?: PopupConfigOptions
   ) => Promise<void>;
 
+  /**
+   * ```js
+   * await connectAccountWithRedirect({
+   *   connection: 'google-oauth2',
+   *   authorizationParams: {
+   *     access_type: 'offline',
+   *     scope: 'openid profile email https://www.googleapis.com/auth/drive.readonly',
+   *   }
+   * });
+   * ```
+   *
+   * Redirects to the `/connect` URL using the parameters
+   * provided as arguments. This then redirects to the connection's login page
+   * where the user can authenticate and authorize the account to be connected.
+   *
+   * If connecting the account is successful `onRedirectCallback` will be called
+   * with the details of the connected account.
+   */
+  connectAccountWithRedirect: (
+    options: RedirectConnectAccountOptions
+  ) => Promise<void>;
+
   /**
    * ```js
    * auth0.logout({ logoutParams: { returnTo: window.location.origin } });
@@ -140,7 +164,7 @@ export interface Auth0ContextInterface<TUser extends User = User>
    *
    * @param url The URL to that should be used to retrieve the `state` and `code` values. Defaults to `window.location.href` if not given.
    */
-  handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult>;
+  handleRedirectCallback: (url?: string) => Promise<RedirectLoginResult | ConnectAccountRedirectResult>;
 
   /**
    * Returns the current DPoP nonce used for making requests to Auth0.
@@ -207,6 +231,7 @@ export const initialContext = {
   getIdTokenClaims: stub,
   loginWithRedirect: stub,
   loginWithPopup: stub,
+  connectAccountWithRedirect: stub,
   logout: stub,
   handleRedirectCallback: stub,
   getDpopNonce: stub,

package/src/auth0-provider.tsx

@@ -15,6 +15,9 @@ import {
   RedirectLoginResult,
   GetTokenSilentlyOptions,
   User,
+  RedirectConnectAccountOptions,
+  ConnectAccountRedirectResult,
+  ResponseType
 } from '@auth0/auth0-spa-js';
 import Auth0Context, {
   Auth0ContextInterface,
@@ -31,10 +34,18 @@ import { reducer } from './reducer';
 import { initialAuthState, type AuthState } from './auth-state';
 
 /**
- * The state of the application before the user was redirected to the login page.
+ * The account that has been connected during the connect flow.
+ */
+export type ConnectedAccount = Omit<ConnectAccountRedirectResult, 'appState' | 'response_type'>;
+
+/**
+ * The state of the application before the user was redirected to the login page
+ * and any account that the user may have connected to.
  */
 export type AppState = {
   returnTo?: string;
+  connectedAccount?: ConnectedAccount;
+  response_type?: ResponseType;
   [key: string]: any; // eslint-disable-line @typescript-eslint/no-explicit-any
 };
 
@@ -116,7 +127,7 @@ const defaultOnRedirectCallback = (appState?: AppState): void => {
   window.history.replaceState(
     {},
     document.title,
-    appState?.returnTo ?? window.location.pathname
+    appState!.returnTo ?? window.location.pathname
   );
 };
 
@@ -160,8 +171,12 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
       try {
         let user: TUser | undefined;
         if (hasAuthParams() && !skipRedirectCallback) {
-          const { appState } = await client.handleRedirectCallback();
+          const { appState = {}, response_type, ...result } = await client.handleRedirectCallback();
           user = await client.getUser();
+          appState.response_type = response_type;
+          if (response_type === ResponseType.ConnectCode) {
+            appState.connectedAccount = result as ConnectedAccount;
+          }
           onRedirectCallback(appState, user);
         } else {
           await client.checkSession();
@@ -251,13 +266,21 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
     [client]
   );
 
+  const connectAccountWithRedirect = useCallback(
+    (options: RedirectConnectAccountOptions) =>
+      client.connectAccountWithRedirect(options),
+    [client]
+  );
+
   const getIdTokenClaims = useCallback(
     () => client.getIdTokenClaims(),
     [client]
   );
 
   const handleRedirectCallback = useCallback(
-    async (url?: string): Promise<RedirectLoginResult> => {
+    async (
+      url?: string
+    ): Promise<RedirectLoginResult | ConnectAccountRedirectResult> => {
       try {
         return await client.handleRedirectCallback(url);
       } catch (error) {
@@ -300,6 +323,7 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
       getIdTokenClaims,
       loginWithRedirect,
       loginWithPopup,
+      connectAccountWithRedirect,
       logout,
       handleRedirectCallback,
       getDpopNonce,
@@ -314,6 +338,7 @@ const Auth0Provider = <TUser extends User = User>(opts: Auth0ProviderOptions<TUs
     getIdTokenClaims,
     loginWithRedirect,
     loginWithPopup,
+    connectAccountWithRedirect,
     logout,
     handleRedirectCallback,
     getDpopNonce,

package/src/index.tsx

@@ -2,6 +2,7 @@ export {
   default as Auth0Provider,
   Auth0ProviderOptions,
   AppState,
+  ConnectedAccount
 } from './auth0-provider';
 export { default as useAuth0 } from './use-auth0';
 export { default as withAuth0, WithAuth0Props } from './with-auth0';
@@ -38,6 +39,10 @@ export {
   MissingRefreshTokenError,
   GenericError,
   UseDpopNonceError,
-  type FetcherConfig
+  type FetcherConfig,
+  RedirectConnectAccountOptions,
+  ConnectAccountRedirectResult,
+  ResponseType,
+  ConnectError
 } from '@auth0/auth0-spa-js';
 export { OAuthError } from './errors';

package/src/utils.tsx

@@ -1,6 +1,6 @@
 import { OAuthError } from './errors';
 
-const CODE_RE = /[?&]code=[^&]+/;
+const CODE_RE = /[?&](?:connect_)?code=[^&]+/;
 const STATE_RE = /[?&]state=[^&]+/;
 const ERROR_RE = /[?&]error=[^&]+/;