@auth0/auth0-react 1.4.0 → 1.8.0

package/dist/index.d.ts

@@ -3,6 +3,6 @@ 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, RedirectLoginOptions, } from './auth0-context';
-export { PopupLoginOptions, PopupConfigOptions, GetIdTokenClaimsOptions, GetTokenWithPopupOptions, LogoutOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, } from '@auth0/auth0-spa-js';
+export { PopupLoginOptions, PopupConfigOptions, GetIdTokenClaimsOptions, GetTokenWithPopupOptions, LogoutOptions, LogoutUrlOptions, CacheLocation, GetTokenSilentlyOptions, IdToken, User, ICache, InMemoryCache, LocalStorageCache, Cacheable, } 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,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,GACR,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,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,oBAAoB,GACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAClB,uBAAuB,EACvB,wBAAwB,EACxB,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,uBAAuB,EACvB,OAAO,EACP,IAAI,EACJ,MAAM,EACN,aAAa,EACb,iBAAiB,EACjB,SAAS,GACV,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC"}

package/dist/reducer.d.ts

@@ -1,8 +1,9 @@
-import { AuthState, User } from './auth-state';
+import { User } from '@auth0/auth0-spa-js';
+import { AuthState } from './auth-state';
 declare type Action = {
     type: 'LOGIN_POPUP_STARTED';
 } | {
-    type: 'INITIALISED' | 'LOGIN_POPUP_COMPLETE' | 'GET_ACCESS_TOKEN_COMPLETE';
+    type: 'INITIALISED' | 'LOGIN_POPUP_COMPLETE' | 'GET_ACCESS_TOKEN_COMPLETE' | 'HANDLE_REDIRECT_COMPLETE';
     user?: User;
 } | {
     type: 'LOGOUT';
@@ -13,6 +14,6 @@ declare type Action = {
 /**
  * Handles how that state changes in the `useAuth0` hook.
  */
-export declare const reducer: (state: AuthState, action: Action) => AuthState;
+export declare const reducer: (state: AuthState<User>, action: Action) => AuthState<User>;
 export {};
 //# sourceMappingURL=reducer.d.ts.map

package/dist/reducer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../src/reducer.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAE/C,aAAK,MAAM,GACP;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAC/B;IACE,IAAI,EACA,aAAa,GACb,sBAAsB,GACtB,2BAA2B,CAAC;IAChC,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,OAAO,iDAsCnB,CAAC"}
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../src/reducer.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,aAAK,MAAM,GACP;IAAE,IAAI,EAAE,qBAAqB,CAAA;CAAE,GAC/B;IACE,IAAI,EACA,aAAa,GACb,sBAAsB,GACtB,2BAA2B,GAC3B,0BAA0B,CAAC;IAC/B,IAAI,CAAC,EAAE,IAAI,CAAC;CACb,GACD;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,OAAO,6DAuCnB,CAAC"}

package/dist/use-auth0.d.ts

@@ -1,3 +1,4 @@
+import { User } from '@auth0/auth0-spa-js';
 import { Auth0ContextInterface } from './auth0-context';
 /**
  * ```js
@@ -14,11 +15,13 @@ import { Auth0ContextInterface } from './auth0-context';
  *   loginWithRedirect,
  *   loginWithPopup,
  *   logout,
- * } = useAuth0();
+ * } = useAuth0<TUser>();
  * ```
  *
  * Use the `useAuth0` hook in your components to access the auth state and methods.
+ *
+ * TUser is an optional type param to provide a type to the `user` field.
  */
-declare const useAuth0: () => Auth0ContextInterface;
+declare const useAuth0: <TUser extends User = User>() => Auth0ContextInterface<TUser>;
 export default useAuth0;
 //# sourceMappingURL=use-auth0.d.ts.map

package/dist/use-auth0.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-auth0.d.ts","sourceRoot":"","sources":["../src/use-auth0.tsx"],"names":[],"mappings":"AACA,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,QAAA,MAAM,QAAQ,6BAAwD,CAAC;AAEvE,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"use-auth0.d.ts","sourceRoot":"","sources":["../src/use-auth0.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAC3C,OAAqB,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,QAAQ,+DAC4C,CAAC;AAE3D,eAAe,QAAQ,CAAC"}

package/dist/with-authentication-required.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { RedirectLoginOptions } from '@auth0/auth0-spa-js';
+import { RedirectLoginOptions, User } from '@auth0/auth0-spa-js';
 /**
  * Options for the withAuthenticationRequired Higher Order Component
  */
@@ -47,6 +47,11 @@ export interface WithAuthenticationRequiredOptions {
      * This will be merged with the `returnTo` option used by the `onRedirectCallback` handler.
      */
     loginOptions?: RedirectLoginOptions;
+    /**
+     * Check the user object for JWT claims and return a boolean indicating
+     * whether or not they are authorized to view the component.
+     */
+    claimCheck?: (claims?: User) => boolean;
 }
 /**
  * ```js

package/dist/with-authentication-required.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"with-authentication-required.d.ts","sourceRoot":"","sources":["../src/with-authentication-required.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAc3D;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACnC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,CAAC,OAAO,CAAC;IAClC;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;CACrC;AAED;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,mHA8B/B,CAAA;AAED,eAAe,0BAA0B,CAAC"}
+{"version":3,"file":"with-authentication-required.d.ts","sourceRoot":"","sources":["../src/with-authentication-required.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAuC,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAE,oBAAoB,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAcjE;;GAEG;AACH,MAAM,WAAW,iCAAiC;IAChD;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACnC;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,CAAC,OAAO,CAAC;IAClC;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAU,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC;CACzC;AAED;;;;;;;GAOG;AACH,QAAA,MAAM,0BAA0B,mHA2C/B,CAAC;AAEF,eAAe,0BAA0B,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "author": "Auth0",
   "name": "@auth0/auth0-react",
-  "version": "1.4.0",
+  "version": "1.8.0",
   "description": "Auth0 SDK for React Single Page Applications (SPA)",
   "keywords": [
     "auth0",
@@ -24,7 +24,7 @@
     "lint": "eslint --ext=tsx ./src ./__tests__",
     "start": "rollup -cw",
     "test": "jest --coverage",
-    "prepack": "npm run test && npm run build",
+    "prepack": "npm run build",
     "docs": "typedoc --options typedoc.js src",
     "install:examples": "npm i --prefix=examples/cra-react-router --no-package-lock && npm i --prefix=examples/gatsby-app --no-package-lock && npm i --prefix=examples/nextjs-app --no-package-lock && npm ci --prefix=examples/users-api",
     "start:cra": "npm start --prefix=examples/cra-react-router",
@@ -38,7 +38,7 @@
     "test:nextjs": "start-server-and-test start:api 3001 start:nextjs 3000 cypress:run",
     "test:nextjs:watch": "start-server-and-test start:api 3001 start:nextjs 3000 cypress:open",
     "test:integration": "npm run test:cra && npm run test:gatsby && npm run test:nextjs",
-    "cypress:run": "cypress run",
+    "cypress:run": "cypress run --spec 'cypress/integration/smoke.test.ts'",
     "cypress:open": "cypress open",
     "codecov": "codecov"
   },
@@ -62,22 +62,25 @@
     "@types/react-dom": "^16.9.6",
     "@typescript-eslint/eslint-plugin": "^2.30.0",
     "@typescript-eslint/parser": "^2.30.0",
+    "browserstack-cypress-cli": "^1.8.1",
     "codecov": "^3.7.2",
-    "cypress": "^4.12.1",
+    "cypress": "^7.2.0",
     "eslint": "^6.8.0",
     "eslint-plugin-react": "^7.19.0",
     "eslint-plugin-react-hooks": "^4.0.0",
     "husky": "^4.2.5",
     "jest": "^26.6.3",
     "jest-junit": "^10.0.0",
+    "oidc-provider": "^7.6.0",
     "prettier": "2.0.5",
     "pretty-quick": "^2.0.1",
-    "react": "^16.13.1",
-    "react-dom": "^16.13.1",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
     "react-test-renderer": "^16.13.1",
     "rollup": "^2.7.2",
     "rollup-plugin-analyzer": "^3.3.0",
     "rollup-plugin-delete": "^1.2.0",
+    "rollup-plugin-dev": "^1.1.3",
     "rollup-plugin-livereload": "^1.2.0",
     "rollup-plugin-peer-deps-external": "^2.2.2",
     "rollup-plugin-serve": "^1.0.1",
@@ -99,6 +102,6 @@
     }
   },
   "dependencies": {
-    "@auth0/auth0-spa-js": "^1.14.0"
+    "@auth0/auth0-spa-js": "^1.18.0"
   }
 }

package/src/auth-state.tsx

@@ -1,13 +1,13 @@
-export type User = any; // eslint-disable-line @typescript-eslint/no-explicit-any
+import { User } from '@auth0/auth0-spa-js';
 
 /**
  * The auth state which, when combined with the auth methods, make up the return object of the `useAuth0` hook.
  */
-export interface AuthState {
+export interface AuthState<TUser extends User = User> {
   error?: Error;
   isAuthenticated: boolean;
   isLoading: boolean;
-  user?: User;
+  user?: TUser;
 }
 
 /**

package/src/auth0-context.tsx

@@ -9,6 +9,8 @@ import {
   PopupLoginOptions,
   PopupConfigOptions,
   RedirectLoginOptions as Auth0RedirectLoginOptions,
+  RedirectLoginResult,
+  User,
 } from '@auth0/auth0-spa-js';
 import { createContext } from 'react';
 import { AuthState, initialAuthState } from './auth-state';
@@ -36,7 +38,8 @@ export interface RedirectLoginOptions extends BaseLoginOptions {
 /**
  * Contains the authenticated state and authentication methods provided by the `useAuth0` hook.
  */
-export interface Auth0ContextInterface extends AuthState {
+export interface Auth0ContextInterface<TUser extends User = User>
+  extends AuthState<TUser> {
   /**
    * ```js
    * const token = await getAccessTokenSilently(options);
@@ -156,6 +159,16 @@ export interface Auth0ContextInterface extends AuthState {
    * @param options
    */
   buildLogoutUrl: (options?: LogoutUrlOptions) => string;
+
+  /**
+   * After the browser redirects back to the callback page,
+   * call `handleRedirectCallback` to handle success and error
+   * responses from Auth0. If the response is successful, results
+   * will be valid according to their expiration times.
+   *
+   * @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>;
 }
 
 /**
@@ -178,6 +191,7 @@ const initialContext = {
   loginWithRedirect: stub,
   loginWithPopup: stub,
   logout: stub,
+  handleRedirectCallback: stub,
 };
 
 /**

package/src/auth0-provider.tsx

@@ -12,6 +12,8 @@ import {
   GetTokenWithPopupOptions,
   GetTokenSilentlyOptions,
   GetIdTokenClaimsOptions,
+  RedirectLoginResult,
+  ICache,
 } from '@auth0/auth0-spa-js';
 import Auth0Context, { RedirectLoginOptions } from './auth0-context';
 import { hasAuthParams, loginError, tokenError } from './utils';
@@ -89,6 +91,12 @@ export interface Auth0ProviderOptions {
    * Read more about [changing storage options in the Auth0 docs](https://auth0.com/docs/libraries/auth0-single-page-app-sdk#change-storage-options)
    */
   cacheLocation?: CacheLocation;
+  /**
+   * Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over `cacheLocation` if they are both specified.
+   *
+   * Read more about [creating a custom cache](https://github.com/auth0/auth0-spa-js#creating-a-custom-cache)
+   */
+  cache?: ICache;
   /**
    * If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the legacy technique of using a hidden iframe and the `authorization_code` grant with `prompt=none` is used.
    * The default setting is `false`.
@@ -130,7 +138,7 @@ export interface Auth0ProviderOptions {
    */
   audience?: string;
   /**
-   * The Id of an organization to log in to (Organizations is currently a Closed Beta).
+   * The Id of an organization to log in to.
    *
    * This will specify an `organization` parameter in your user's login request and will add a step to validate
    * the `org_id` claim in your user's ID Token.
@@ -276,11 +284,15 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
   );
 
   const logout = useCallback(
-    (opts: LogoutOptions = {}): void => {
-      client.logout(opts);
+    (opts: LogoutOptions = {}): Promise<void> | void => {
+      const maybePromise = client.logout(opts);
       if (opts.localOnly) {
+        if (maybePromise && typeof maybePromise.then === 'function') {
+          return maybePromise.then(() => dispatch({ type: 'LOGOUT' }));
+        }
         dispatch({ type: 'LOGOUT' });
       }
+      return maybePromise;
     },
     [client]
   );
@@ -330,6 +342,22 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
     [client]
   );
 
+  const handleRedirectCallback = useCallback(
+    async (url?: string): Promise<RedirectLoginResult> => {
+      try {
+        return await client.handleRedirectCallback(url);
+      } catch (error) {
+        throw tokenError(error);
+      } finally {
+        dispatch({
+          type: 'HANDLE_REDIRECT_COMPLETE',
+          user: await client.getUser(),
+        });
+      }
+    },
+    [client]
+  );
+
   return (
     <Auth0Context.Provider
       value={{
@@ -342,6 +370,7 @@ const Auth0Provider = (opts: Auth0ProviderOptions): JSX.Element => {
         loginWithRedirect,
         loginWithPopup,
         logout,
+        handleRedirectCallback,
       }}
     >
       {children}

package/src/index.tsx

@@ -24,5 +24,10 @@ export {
   CacheLocation,
   GetTokenSilentlyOptions,
   IdToken,
+  User,
+  ICache,
+  InMemoryCache,
+  LocalStorageCache,
+  Cacheable,
 } from '@auth0/auth0-spa-js';
 export { OAuthError } from './errors';

package/src/reducer.tsx

@@ -1,4 +1,5 @@
-import { AuthState, User } from './auth-state';
+import { User } from '@auth0/auth0-spa-js';
+import { AuthState } from './auth-state';
 
 type Action =
   | { type: 'LOGIN_POPUP_STARTED' }
@@ -6,7 +7,8 @@ type Action =
       type:
         | 'INITIALISED'
         | 'LOGIN_POPUP_COMPLETE'
-        | 'GET_ACCESS_TOKEN_COMPLETE';
+        | 'GET_ACCESS_TOKEN_COMPLETE'
+        | 'HANDLE_REDIRECT_COMPLETE';
       user?: User;
     }
   | { type: 'LOGOUT' }
@@ -31,6 +33,7 @@ export const reducer = (state: AuthState, action: Action): AuthState => {
         isLoading: false,
         error: undefined,
       };
+    case 'HANDLE_REDIRECT_COMPLETE':
     case 'GET_ACCESS_TOKEN_COMPLETE':
       if (state.user?.updated_at === action.user?.updated_at) {
         return state;

package/src/use-auth0.tsx

@@ -1,4 +1,5 @@
 import { useContext } from 'react';
+import { User } from '@auth0/auth0-spa-js';
 import Auth0Context, { Auth0ContextInterface } from './auth0-context';
 
 /**
@@ -16,11 +17,14 @@ import Auth0Context, { Auth0ContextInterface } from './auth0-context';
  *   loginWithRedirect,
  *   loginWithPopup,
  *   logout,
- * } = useAuth0();
+ * } = useAuth0<TUser>();
  * ```
  *
  * Use the `useAuth0` hook in your components to access the auth state and methods.
+ *
+ * TUser is an optional type param to provide a type to the `user` field.
  */
-const useAuth0 = (): Auth0ContextInterface => useContext(Auth0Context);
+const useAuth0 = <TUser extends User = User>(): Auth0ContextInterface<TUser> =>
+  useContext(Auth0Context) as Auth0ContextInterface<TUser>;
 
-export default useAuth0;
+export default useAuth0;  

package/src/utils.tsx

@@ -5,8 +5,8 @@ const STATE_RE = /[?&]state=[^&]+/;
 const ERROR_RE = /[?&]error=[^&]+/;
 
 export const hasAuthParams = (searchParams = window.location.search): boolean =>
-  (CODE_RE.test(searchParams) && STATE_RE.test(searchParams)) ||
-  ERROR_RE.test(searchParams);
+  (CODE_RE.test(searchParams) || ERROR_RE.test(searchParams)) &&
+  STATE_RE.test(searchParams);
 
 const normalizeErrorFn = (fallbackMessage: string) => (
   error: Error | { error: string; error_description?: string } | ProgressEvent

package/src/with-authentication-required.tsx

@@ -1,5 +1,5 @@
 import React, { ComponentType, useEffect, FC } from 'react';
-import { RedirectLoginOptions } from '@auth0/auth0-spa-js';
+import { RedirectLoginOptions, User } from '@auth0/auth0-spa-js';
 import useAuth0 from './use-auth0';
 
 /**
@@ -60,6 +60,11 @@ export interface WithAuthenticationRequiredOptions {
    * This will be merged with the `returnTo` option used by the `onRedirectCallback` handler.
    */
   loginOptions?: RedirectLoginOptions;
+  /**
+   * Check the user object for JWT claims and return a boolean indicating
+   * whether or not they are authorized to view the component.
+   */
+  claimCheck?: (claims?: User) => boolean;
 }
 
 /**
@@ -75,15 +80,22 @@ const withAuthenticationRequired = <P extends object>(
   options: WithAuthenticationRequiredOptions = {}
 ): FC<P> => {
   return function WithAuthenticationRequired(props: P): JSX.Element {
-    const { isAuthenticated, isLoading, loginWithRedirect } = useAuth0();
+    const { user, isAuthenticated, isLoading, loginWithRedirect } = useAuth0();
     const {
       returnTo = defaultReturnTo,
       onRedirecting = defaultOnRedirecting,
       loginOptions = {},
+      claimCheck = (): boolean => true,
     } = options;
 
+    /**
+     * The route is authenticated if the user has valid auth and there are no
+     * JWT claim mismatches.
+     */
+    const routeIsAuthenticated = isAuthenticated && claimCheck(user);
+
     useEffect(() => {
-      if (isLoading || isAuthenticated) {
+      if (isLoading || routeIsAuthenticated) {
         return;
       }
       const opts = {
@@ -96,10 +108,16 @@ const withAuthenticationRequired = <P extends object>(
       (async (): Promise<void> => {
         await loginWithRedirect(opts);
       })();
-    }, [isLoading, isAuthenticated, loginWithRedirect, loginOptions, returnTo]);
+    }, [
+      isLoading,
+      routeIsAuthenticated,
+      loginWithRedirect,
+      loginOptions,
+      returnTo,
+    ]);
 
-    return isAuthenticated ? <Component {...props} /> : onRedirecting();
+    return routeIsAuthenticated ? <Component {...props} /> : onRedirecting();
   };
-}
+};
 
 export default withAuthenticationRequired;

package/CHANGELOG.md

@@ -1,101 +0,0 @@
-# Change Log
-
-## [v1.4.0](https://github.com/auth0/auth0-react/tree/v1.4.0) (2021-03-26)
-
-**Added**
-
-- Update SPA JS, add organizations docs and example [\#211](https://github.com/auth0/auth0-react/pull/211) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-**Fixed**
-
-- Update auth state on access token fail [\#219](https://github.com/auth0/auth0-react/pull/219) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Updates to user should not update memoized getAccessToken* methods [\#213](https://github.com/auth0/auth0-react/pull/213) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v1.3.0](https://github.com/auth0/auth0-react/tree/v1.3.0) (2021-02-16)
-
-**Added**
-
-- Added `buildAuthorizeUrl` and `buildLogoutUrl`  [\#190](https://github.com/auth0/auth0-react/pull/190) ([THISS](https://github.com/THISS))
-
-**Changed**
-
-- `isLoading` should default to `true` even when doing SSR [\#193](https://github.com/auth0/auth0-react/pull/193) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v1.2.0](https://github.com/auth0/auth0-react/tree/v1.2.0) (2020-11-04)
-
-**Added**
-
-- [SDK-2106] Memoize auth methods [\#150](https://github.com/auth0/auth0-react/pull/150) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Add react fast refresh support [\#151](https://github.com/auth0/auth0-react/pull/151) ([Idered](https://github.com/Idered)) 
-- [SDK-2105] Skip redirect callback option [\#148](https://github.com/auth0/auth0-react/pull/148) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-2104] Update peerDeps to account for react 17 [\#147](https://github.com/auth0/auth0-react/pull/147) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1938] Update the user/isAuthenticated state after getting a token  [\#146](https://github.com/auth0/auth0-react/pull/146) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Add config argument to getAccessTokenWithPopup [\#141](https://github.com/auth0/auth0-react/pull/141) ([ygist](https://github.com/ygist))
-- Export AppState type for custom onRedirectCallback's [\#120](https://github.com/auth0/auth0-react/pull/120) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v1.1.0](https://github.com/auth0/auth0-react/tree/v1.1.0) (2020-09-17)
-
-**Added**
-
-- [SDK-1927] Check for state param in callback url [\#107](https://github.com/auth0/auth0-react/pull/107) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Support react v16.11 [\#99](https://github.com/auth0/auth0-react/pull/99) ([tiagob](https://github.com/tiagob))
-
-**Fixed**
-
-- [SDK-1836] Update state for local logouts [\#81](https://github.com/auth0/auth0-react/pull/81) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Add config argument to loginWithPopup [\#77](https://github.com/auth0/auth0-react/pull/77) ([Aulos](https://github.com/Aulos))
-
-## [v1.0.0](https://github.com/auth0/auth0-react/tree/v1.0.0) (2020-06-19)
-
-**Breaking Change**
-
-- Allow custom `returnTo` in `withAuthenticationRequired` [\#41](https://github.com/auth0/auth0-react/pull/41) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v0.4.0](https://github.com/auth0/auth0-react/tree/v0.4.0) (2020-06-05)
-
-**Added**
-
-- [SDK-1697] Add custom user agent to spa js [\#28](https://github.com/auth0/auth0-react/pull/28) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Use `checkSession` to start login [\#27](https://github.com/auth0/auth0-react/pull/27) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1690] Add generated API docs [\#25](https://github.com/auth0/auth0-react/pull/25) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v0.3.1](https://github.com/auth0/auth0-react/tree/v0.3.1) (2020-06-01)
-
-**Fixed**
-
-- getToken methods were being called in the wrong scope [\#24](https://github.com/auth0/auth0-react/pull/24) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v0.3.0](https://github.com/auth0/auth0-react/tree/v0.3.0) (2020-05-29)
-
-**Added**
-
-- [SDK-1641] Add SSR support [\#17](https://github.com/auth0/auth0-react/pull/17) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-**Breaking Changes**
-
-- [SDK-1694] Camel case props [\#22](https://github.com/auth0/auth0-react/pull/22) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1693] Renames some init props [\#21](https://github.com/auth0/auth0-react/pull/21) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v0.2.0](https://github.com/auth0/auth0-react/tree/v0.2.0) (2020-05-20)
-
-**Added**
-
-- [SDK-1642] Add missing methods from SPA JS [\#11](https://github.com/auth0/auth0-react/pull/11) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1582] Normalize the auth0 error and add error handling to the basic example [\#10](https://github.com/auth0/auth0-react/pull/10) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-**Changed**
-
-- Rename auth prop to prevent clashes and align with public api [\#14](https://github.com/auth0/auth0-react/pull/14) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- Bundle SPA JS with the SDK for easier install [\#13](https://github.com/auth0/auth0-react/pull/13) ([adamjmcgrath](https://github.com/adamjmcgrath))
-
-## [v0.1.0](https://github.com/auth0/auth0-react/tree/v0.1.0) (2020-05-08)
-
-**Added**
-
-- [SDK-1580][SDK-1581] Add withAuth and withLoginRequired [\#7](https://github.com/auth0/auth0-react/pull/7) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1583] Setup basic README for Early Access [\#6](https://github.com/auth0/auth0-react/pull/6) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1577][SDK-1578] Add login functionality [\#5](https://github.com/auth0/auth0-react/pull/5) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1576] Linting [\#4](https://github.com/auth0/auth0-react/pull/4) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1572] Added CircleCI config [\#3](https://github.com/auth0/auth0-react/pull/3) ([Widcket](https://github.com/Widcket))
-- [SDK-1568] Set up unit tests [\#2](https://github.com/auth0/auth0-react/pull/2) ([adamjmcgrath](https://github.com/adamjmcgrath))
-- [SDK-1570][SDK-1571] Setup dev environment and build targets [\#1](https://github.com/auth0/auth0-react/pull/1) ([adamjmcgrath](https://github.com/adamjmcgrath))