diff --git a/CHANGELOG.md b/CHANGELOG.md index fb483115..c0155fe4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.2.1](https://github.com/auth0/auth0-react/tree/v2.2.1) (2023-08-22) +[Full Changelog](https://github.com/auth0/auth0-react/compare/v2.2.0...v2.2.1) + +**Fixed** +- bump auth0-spa-js to latest version [\#560](https://github.com/auth0/auth0-react/pull/560) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.2.0](https://github.com/auth0/auth0-react/tree/v2.2.0) (2023-07-13) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.1.1...v2.2.0) diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index ad33eca2..5618fc0a 100644 --- a/docs/classes/OAuthError.html +++ b/docs/classes/OAuthError.html @@ -27,7 +27,7 @@

Hierarchy

+
  • Defined in src/errors.tsx:7
    • @@ -68,19 +68,19 @@
    Optional error_description: Returns OAuthError
    +
  • Defined in src/errors.tsx:8

    • Properties

    error

    error: string
    +
  • Defined in src/errors.tsx:8

    • Optional error_description

    error_description?: string
    +
  • Defined in src/errors.tsx:8

    • message

    message: string
    +
  • Defined in src/auth0-provider.tsx:135
    • diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index 47f277e8..72566b84 100644 --- a/docs/functions/useAuth0.html +++ b/docs/functions/useAuth0.html @@ -36,7 +36,7 @@

    Parameters

    context: Context<Auth0ContextInterface<User>> = Auth0Context

    Returns Auth0ContextInterface<TUser>

    +
  • Defined in src/use-auth0.tsx:27
    • diff --git a/docs/functions/withAuth0.html b/docs/functions/withAuth0.html index 0f8449dc..20f2b892 100644 --- a/docs/functions/withAuth0.html +++ b/docs/functions/withAuth0.html @@ -39,7 +39,7 @@
    Component: ComponentTypecontext: Context<Auth0ContextInterface<User>> = Auth0Context

    Returns ComponentType<Omit<P, "auth0">>

    +
  • Defined in src/with-auth0.tsx:29
    • diff --git a/docs/functions/withAuthenticationRequired.html b/docs/functions/withAuthenticationRequired.html index c94f8449..d22a4aa6 100644 --- a/docs/functions/withAuthenticationRequired.html +++ b/docs/functions/withAuthenticationRequired.html @@ -38,7 +38,7 @@
    Component: ComponentTypeoptions: WithAuthenticationRequiredOptions = {}

    Returns FC<P>

    +
  • Defined in src/with-authentication-required.tsx:97
    • diff --git a/docs/index.html b/docs/index.html index 412731f2..311baf23 100644 --- a/docs/index.html +++ b/docs/index.html @@ -53,7 +53,6 @@

    Configure Auth0

    If you're using an existing application, verify that you have configured the following settings in your Single Page Application:

    • Click on the "Settings" tab of your application's page.
      • -
    • Ensure that "Token Endpoint Authentication Method" under "Application Properties" is set to "None"
    • Scroll down and click on the "Show Advanced Settings" link.
    • Under "Advanced Settings", click on the "OAuth" tab.
    • Ensure that "JsonWebToken Signature Algorithm" is set to RS256 and that "OIDC Conformant" is enabled.
      • @@ -85,7 +84,7 @@

      Configure the SDK

    Use the useAuth0 hook in your components to access authentication state (isLoading, isAuthenticated and user) and authentication methods (loginWithRedirect and logout):

    -
    // src/App.js
    import React from 'react';
    import { useAuth0 } from '@auth0/auth0-react';

    function App() {
      const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
        useAuth0();

      if (isLoading) {
        return <div>Loading...</div>;
      }
      if (error) {
        return <div>Oops... {error.message}</div>;
      }

      if (isAuthenticated) {
        return (
          <div>
            Hello {user.name}{' '}
            <button onClick={() => logout({ returnTo: window.location.origin })}>
              Log out
            </button>
          </div>
        );
      } else {
        return <button onClick={() => loginWithRedirect()}>Log in</button>;
      }
    }

    export default App;
+
    // src/App.js
    import React from 'react';
    import { useAuth0 } from '@auth0/auth0-react';

    function App() {
      const { isLoading, isAuthenticated, error, user, loginWithRedirect, logout } =
        useAuth0();

      if (isLoading) {
        return <div>Loading...</div>;
      }
      if (error) {
        return <div>Oops... {error.message}</div>;
      }

      if (isAuthenticated) {
        return (
          <div>
            Hello {user.name}{' '}
            <button onClick={() => logout({ logoutParams: { returnTo: window.location.origin } })}>
              Log out
            </button>
          </div>
        );
      } else {
        return <button onClick={() => loginWithRedirect()}>Log in</button>;
      }
    }

    export default App;
 
    
 
    For more code samples on how to integrate auth0-react SDK in your React application, have a look at our examples.
    
 
diff --git a/docs/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html
index fb5e699c..abe92d59 100644
--- a/docs/interfaces/Auth0ContextInterface.html
+++ b/docs/interfaces/Auth0ContextInterface.html
@@ -30,7 +30,7 @@ 
    Hierarchy
    
 
      
 
    • Auth0ContextInterface
    
+
  • Defined in src/auth0-context.tsx:26
    • 
 
    
 
    
 
    
@@ -57,7 +57,7 @@ 
    Optionalerror?: Error
    +
  • Defined in src/auth-state.tsx:7

    • getAccessTokenSilently

    getAccessTokenSilently: {
        (options: GetTokenSilentlyOptions & {
            detailedResponse: true;
        }): Promise<GetTokenSilentlyVerboseResponse>;
        (options?: GetTokenSilentlyOptions): Promise<string>;
        (options: GetTokenSilentlyOptions): Promise<string | GetTokenSilentlyVerboseResponse>;
    }
    @@ -142,7 +142,7 @@

    Parameters

    options: GetTokenSilentlyOptions

    Returns Promise<string | GetTokenSilentlyVerboseResponse>

    +
  • Defined in src/auth0-context.tsx:52

    • getAccessTokenWithPopup

    getAccessTokenWithPopup: ((options?: GetTokenWithPopupOptions, config?: PopupConfigOptions) => Promise<undefined | string>)
    @@ -170,7 +170,7 @@
    Optional options: Optional config: PopupConfigOptions

    Returns Promise<undefined | string>

    +
  • Defined in src/auth0-context.tsx:74

    • getIdTokenClaims

    getIdTokenClaims: (() => Promise<undefined | IdToken>)
    @@ -187,7 +187,7 @@

    Type declaration

    Returns Promise<undefined | IdToken>

    +
  • Defined in src/auth0-context.tsx:86

    • handleRedirectCallback

    handleRedirectCallback: ((url?: string) => Promise<RedirectLoginResult<any>>)
    @@ -212,19 +212,19 @@
    Optional url: Returns Promise<RedirectLoginResult<any>>
    +
  • Defined in src/auth0-context.tsx:140

    • isAuthenticated

    isAuthenticated: boolean
    +
  • Defined in src/auth-state.tsx:8

    • isLoading

    isLoading: boolean
    +
  • Defined in src/auth-state.tsx:9

    • loginWithPopup

    loginWithPopup: ((options?: PopupLoginOptions, config?: PopupConfigOptions) => Promise<void>)
    @@ -254,7 +254,7 @@
    Optional options: Optional config: PopupConfigOptions

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:115

    • loginWithRedirect

    loginWithRedirect: ((options?: RedirectLoginOptions<AppState>) => Promise<void>)
    @@ -278,7 +278,7 @@

    Parameters

    Optional options: RedirectLoginOptions<AppState>

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:97

    • logout

    logout: ((options?: LogoutOptions) => Promise<void>)
    @@ -303,13 +303,13 @@

    Parameters

    Optional options: LogoutOptions

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:130

    • Optional user

    user?: TUser
    +
  • Defined in src/auth-state.tsx:10
    • diff --git a/docs/interfaces/Auth0ProviderOptions.html b/docs/interfaces/Auth0ProviderOptions.html index 182db3f2..49e14eec 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -25,7 +25,7 @@

    Hierarchy

    • Auth0ProviderOptions
    +
  • Defined in src/auth0-provider.tsx:44
    • @@ -120,7 +120,7 @@

    Optional

    The child nodes your Provider has wrapped

    +
  • Defined in src/auth0-provider.tsx:48

    • clientId

    clientId: string
    @@ -147,7 +147,7 @@

    OptionalFor a sample on using multiple Auth0Providers review the React Account Linking Sample

    +
  • Defined in src/auth0-provider.tsx:86

    • Optional cookieDomain

    cookieDomain?: string
    @@ -250,7 +250,7 @@
    Optional appState: Optional user: User

    Returns void

    +
  • Defined in src/auth0-provider.tsx:54

    • Optional sessionCheckExpiryDays

    sessionCheckExpiryDays?: number
    @@ -270,7 +270,7 @@

    Optional

    +
  • Defined in src/auth0-provider.tsx:68

    • Optional useCookiesForTransactions

    useCookiesForTransactions?: boolean
    diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 15a820fe..6d0c9eaf 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in src/auth0-context.tsx:18
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 88a27327..1ca65432 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RedirectLoginOptions
    +
  • Defined in src/auth0-context.tsx:20
    • diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index d54940bd..16006a1b 100644 --- a/docs/interfaces/WithAuth0Props.html +++ b/docs/interfaces/WithAuth0Props.html @@ -23,7 +23,7 @@

    Hierarchy

    • WithAuth0Props
    +
  • Defined in src/with-auth0.tsx:7
    • @@ -39,7 +39,7 @@

    Properties

    auth0

    auth0: Auth0ContextInterface<User>
    +
  • Defined in src/with-auth0.tsx:8
    • diff --git a/docs/interfaces/WithAuthenticationRequiredOptions.html b/docs/interfaces/WithAuthenticationRequiredOptions.html index fd8e4381..6f39731e 100644 --- a/docs/interfaces/WithAuthenticationRequiredOptions.html +++ b/docs/interfaces/WithAuthenticationRequiredOptions.html @@ -23,7 +23,7 @@

    Hierarchy

    • WithAuthenticationRequiredOptions
    +
  • Defined in src/with-authentication-required.tsx:27
    • @@ -47,7 +47,7 @@

    Optional

    +
  • Defined in src/with-authentication-required.tsx:86

    • Optional loginOptions

    loginOptions?: RedirectLoginOptions<AppState>
    @@ -57,7 +57,7 @@

    OptionalreturnTo option used by the onRedirectCallback handler.

    +
  • Defined in src/with-authentication-required.tsx:80

    • Optional onBeforeAuthentication

    onBeforeAuthentication?: (() => Promise<void>)
    @@ -74,7 +74,7 @@

    Type declaration

    Returns Promise<void>

    +
  • Defined in src/with-authentication-required.tsx:65

    • Optional onRedirecting

    onRedirecting?: (() => Element)
    @@ -91,7 +91,7 @@

    Type declaration

    Returns Element

    +
  • Defined in src/with-authentication-required.tsx:55

    • Optional returnTo

    returnTo?: string | (() => string)
    @@ -103,7 +103,7 @@

    OptionalAdd a path for the onRedirectCallback handler to return the user to after login.

    +
  • Defined in src/with-authentication-required.tsx:45
    • diff --git a/docs/types/AppState.html b/docs/types/AppState.html index 917fc4b3..5ed8a78f 100644 --- a/docs/types/AppState.html +++ b/docs/types/AppState.html @@ -26,7 +26,7 @@
    [key:
    Optional returnTo?: string
    +
  • Defined in src/auth0-provider.tsx:36
    • diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index b1c39b19..02f98353 100644 --- a/docs/variables/Auth0Context.html +++ b/docs/variables/Auth0Context.html @@ -19,7 +19,7 @@

    Variable Auth0ContextConst

    The Auth0 Context

    +
  • Defined in src/auth0-context.tsx:169
    • diff --git a/package-lock.json b/package-lock.json index 837cd9c7..16517732 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.2.0", + "version": "2.2.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.2.0", + "version": "2.2.1", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.1.2" diff --git a/package.json b/package.json index 58e7cd54..80c486c6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.2.0", + "version": "2.2.1", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",