diff --git a/CHANGELOG.md b/CHANGELOG.md index fc87d482..fb483115 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Change Log +## [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) + +**Added** +- Support Organization Name [\#552](https://github.com/auth0/auth0-react/pull/552) ([frederikprijck](https://github.com/frederikprijck)) + +**Fixed** +- Fix incorrect logout jsdocx example [\#551](https://github.com/auth0/auth0-react/pull/551) ([frederikprijck](https://github.com/frederikprijck)) +- Fix inconsistent logout function types [\#548](https://github.com/auth0/auth0-react/pull/548) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.1.1](https://github.com/auth0/auth0-react/tree/v2.1.1) (2023-06-14) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.1.0...v2.1.1) diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index e0d4a1a3..ad33eca2 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: string
    +
  • Defined in src/errors.tsx:8
  • error_description?: string
    +
  • Defined in src/errors.tsx:8
  • message: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:546
  • @@ -70,102 +70,102 @@

    Properties

    address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:564
  • birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:559
  • email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:556
  • email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:557
  • family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:549
  • gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:558
  • given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:548
  • locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561
  • middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:550
  • name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:547
  • nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:551
  • phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:562
  • phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:563
  • picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554
  • preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552
  • profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:553
  • sub?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:566
  • updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:565
  • website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:555
  • zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:560
  • +
  • Defined in src/auth0-provider.tsx:135
  • +
  • Defined in src/use-auth0.tsx:27
  • +
  • Defined in src/with-auth0.tsx:29
  • +
  • Defined in src/with-authentication-required.tsx:97
  • Returns Promise<string | GetTokenSilentlyVerboseResponse>

    +
  • Defined in src/auth0-context.tsx:52
  • 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: (() => Promise<undefined | IdToken>)
    @@ -187,7 +187,7 @@

    Type declaration

    Returns Promise<undefined | IdToken>

    +
  • Defined in src/auth0-context.tsx:86
  • handleRedirectCallback: ((url?: string) => Promise<RedirectLoginResult<any>>)
    @@ -212,19 +212,19 @@
    Optional url: Returns Promise<RedirectLoginResult<any>>
    +
  • Defined in src/auth0-context.tsx:140
  • isAuthenticated: boolean
    +
  • Defined in src/auth-state.tsx:8
  • isLoading: boolean
    +
  • Defined in src/auth-state.tsx:9
  • 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: ((options?: RedirectLoginOptions<AppState>) => Promise<void>)
    @@ -278,18 +278,18 @@

    Parameters

    Optional options: RedirectLoginOptions<AppState>

    Returns Promise<void>

    +
  • Defined in src/auth0-context.tsx:97
  • -
    logout: ((options?: LogoutOptions) => void)
    +
    logout: ((options?: LogoutOptions) => Promise<void>)

    Type declaration

    +
  • Defined in src/auth0-context.tsx:130
  • user?: TUser
    +
  • Defined in src/auth-state.tsx:10
  • +
  • Defined in src/auth0-provider.tsx:86
  • cookieDomain?: string
    @@ -160,7 +160,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:220
  • domain: string
    @@ -170,7 +170,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:109
  • httpTimeoutInSeconds?: number
    @@ -178,7 +178,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:171
  • issuer?: string
    @@ -186,7 +186,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:113
  • leeway?: number
    @@ -196,7 +196,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:123
  • legacySameSiteCookie?: boolean
    @@ -209,7 +209,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:191
  • nowProvider?: (() => number | Promise<number>)
    @@ -226,7 +226,7 @@

    Type declaration

    Returns number | Promise<number>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:233
  • onRedirectCallback?: ((appState?: AppState, user?: User) => void)
    @@ -250,7 +250,7 @@
    Optional appState: Optional user: User

    Returns void

    +
  • Defined in src/auth0-provider.tsx:54
  • sessionCheckExpiryDays?: number
    @@ -259,7 +259,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:208
  • skipRedirectCallback?: boolean
    @@ -270,7 +270,7 @@
    +
  • Defined in src/auth0-provider.tsx:68
  • useCookiesForTransactions?: boolean
    @@ -283,7 +283,7 @@

    Notes

    You might want to enable this if you rely on your users being a

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:203
  • useFormData?: boolean
    @@ -293,7 +293,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:227
  • useRefreshTokens?: boolean
    @@ -303,7 +303,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:141
  • useRefreshTokensFallback?: boolean
    @@ -319,7 +319,7 @@

    Example

    let
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:162
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:89
  • scope?: string
    diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 2311e279..22c17e93 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:315
  • @@ -63,7 +63,7 @@
    Optional scope

    The scope that was used in the authentication request

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:326
  • cacheMode?: "on" | "off" | "cache-only"
    @@ -73,7 +73,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:322
  • detailedResponse?: boolean
    @@ -82,7 +82,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:360
  • timeoutInSeconds?: number
    @@ -90,7 +90,7 @@
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:353
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:368
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:446
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:385
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:307
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:292
  • +
  • Defined in src/with-authentication-required.tsx:80
  • onBeforeAuthentication?: (() => Promise<void>)
    @@ -74,7 +74,7 @@

    Type declaration

    Returns Promise<void>

    +
  • Defined in src/with-authentication-required.tsx:65
  • onRedirecting?: (() => Element)
    @@ -91,7 +91,7 @@

    Type declaration

    Returns Element

    +
  • Defined in src/with-authentication-required.tsx:55
  • returnTo?: string | (() => string)
    @@ -103,7 +103,7 @@
    +
  • Defined in src/with-authentication-required.tsx:45
  • +
  • Defined in src/auth0-provider.tsx:36
  • +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:238
  • +
  • Defined in src/auth0-context.tsx:169