From 5cf61be2f7fd979c9098008ceca165e9e4d8e431 Mon Sep 17 00:00:00 2001 From: Frederik Prijck Date: Thu, 13 Jul 2023 11:37:20 +0200 Subject: [PATCH] Release v2.2.0 (#553) --- CHANGELOG.md | 10 +++ docs/classes/OAuthError.html | 8 +- docs/classes/User.html | 42 ++++----- docs/functions/Auth0Provider.html | 2 +- docs/functions/useAuth0.html | 2 +- docs/functions/withAuth0.html | 2 +- .../functions/withAuthenticationRequired.html | 2 +- docs/interfaces/Auth0ContextInterface.html | 32 +++---- docs/interfaces/Auth0ProviderOptions.html | 46 +++++----- docs/interfaces/AuthorizationParams.html | 15 ++-- docs/interfaces/GetTokenSilentlyOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +- docs/interfaces/IdToken.html | 85 ++++++++++--------- docs/interfaces/LogoutOptions.html | 8 +- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 6 +- docs/interfaces/PopupLoginOptions.html | 4 +- docs/interfaces/RedirectLoginOptions.html | 10 +-- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +-- docs/types/AppState.html | 2 +- docs/types/CacheLocation.html | 2 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 25 files changed, 172 insertions(+), 152 deletions(-) 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

    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 node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:546
    • @@ -70,102 +70,102 @@

    Properties

    Optional address

    address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:564

    • Optional birthdate

    birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:559

    • Optional email

    email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:556

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:557

    • Optional family_name

    family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:549

    • Optional gender

    gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:558

    • Optional given_name

    given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:548

    • Optional locale

    locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:561

    • Optional middle_name

    middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:550

    • Optional name

    name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:547

    • Optional nickname

    nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:551

    • Optional phone_number

    phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:562

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:563

    • Optional picture

    picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:554

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:552

    • Optional profile

    profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:553

    • Optional sub

    sub?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:566

    • Optional updated_at

    updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:565

    • Optional website

    website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:555

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:560
    • diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index 98688c62..1b08f682 100644 --- a/docs/functions/Auth0Provider.html +++ b/docs/functions/Auth0Provider.html @@ -30,7 +30,7 @@

    Parameters

    opts: Auth0ProviderOptions

    Returns Element

    +
  • Defined in src/auth0-provider.tsx:135
    • diff --git a/docs/functions/useAuth0.html b/docs/functions/useAuth0.html index de190902..47f277e8 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 6c797265..0f8449dc 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 35161801..c94f8449 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/interfaces/Auth0ContextInterface.html b/docs/interfaces/Auth0ContextInterface.html index dc9567d9..fb5e699c 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,18 +278,18 @@

    Parameters

    Optional options: RedirectLoginOptions<AppState>

    Returns Promise<void>

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

    • logout

    -
    logout: ((options?: LogoutOptions) => void)
    +
    logout: ((options?: LogoutOptions) => Promise<void>)

    Type declaration

      • -
      • (options?: LogoutOptions): void
        • +
      • (options?: LogoutOptions): Promise<void>
      • -
        auth0.logout({ returnTo: window.location.origin });
+
        auth0.logout({ logoutParams: { returnTo: window.location.origin } });
 
        
 
        Clears the application session and performs a redirect to /v2/logout, using
 the parameters provided as arguments, to clear the Auth0 session.
@@ -301,15 +301,15 @@ 
        Parameters
        
 
        
-
        Returns 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 69ea310f..182db3f2 100644 --- a/docs/interfaces/Auth0ProviderOptions.html +++ b/docs/interfaces/Auth0ProviderOptions.html @@ -25,7 +25,7 @@

    Hierarchy

    • Auth0ProviderOptions
    +
  • Defined in src/auth0-provider.tsx:44
    • @@ -77,7 +77,7 @@
    name: : string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:176

    • Optional authorizationParams

    authorizationParams?: AuthorizationParams
    @@ -86,7 +86,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional authorizeTimeoutInSeconds

    authorizeTimeoutInSeconds?: number
    @@ -95,7 +95,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:167

    • Optional cache

    cache?: ICache
    @@ -103,7 +103,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:134

    • Optional cacheLocation

    cacheLocation?: CacheLocation
    @@ -113,14 +113,14 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:130

    • Optional children

    children?: ReactNode

    The child nodes your Provider has wrapped

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

    • clientId

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

    clientId

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:117

    • Optional context

    context?: Context<Auth0ContextInterface<User>>
    @@ -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
    @@ -160,7 +160,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:220

    • domain

    domain: string
    @@ -170,7 +170,7 @@

    domain

    Inherited from Auth0ClientOptions.domain

      -
    • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:106

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:109

    • Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number
    @@ -178,7 +178,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:171

    • Optional issuer

    issuer?: string
    @@ -186,7 +186,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:113

    • Optional leeway

    leeway?: number
    @@ -196,7 +196,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:123

    • Optional legacySameSiteCookie

    legacySameSiteCookie?: boolean
    @@ -209,7 +209,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:191

    • Optional nowProvider

    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

    • Optional onRedirectCallback

    onRedirectCallback?: ((appState?: AppState, user?: User) => void)
    @@ -250,7 +250,7 @@
    Optional appState: Optional user: User

    Returns void

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

    • Optional sessionCheckExpiryDays

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

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:208

    • Optional skipRedirectCallback

    skipRedirectCallback?: boolean
    @@ -270,7 +270,7 @@

    Optional

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

    • Optional useCookiesForTransactions

    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

    • Optional useFormData

    useFormData?: boolean
    @@ -293,7 +293,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:227

    • Optional useRefreshTokens

    useRefreshTokens?: boolean
    @@ -303,7 +303,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:141

    • Optional useRefreshTokensFallback

    useRefreshTokensFallback?: boolean
    @@ -319,7 +319,7 @@

    Example

    let
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:162
    • diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 31900050..f80f1308 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -94,7 +94,7 @@

    Optional

    The Id of an invitation to accept. This is available from the user invitation URL that is given when participating in a user invitation flow.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:81

    • Optional login_hint

    login_hint?: string
    @@ -117,12 +117,15 @@

    Optional

    Optional organization

    organization?: string
    -

    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.

    +

    The organization to log in to.

    +

    This will specify an organization parameter in your user's login request.

    +
      +
    • If you provide an Organization ID (a string with the prefix org_), it will be validated against the org_id claim of your user's ID Token. The validation is case-sensitive.
      • +
    • If you provide an Organization Name (a string without the prefix org_), it will be validated against the org_name claim of your user's ID Token. The validation is case-insensitive.
      • +
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:77

    • Optional prompt

    prompt?: "none" | "login" | "consent" | "select_account"
    @@ -145,7 +148,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:89

    • Optional scope

    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

    • GetTokenSilentlyOptions
    +
  • 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

    • Optional cacheMode

    cacheMode?: "on" | "off" | "cache-only"
    @@ -73,7 +73,7 @@

    Optionalon, where it both reads from the cache and sends a request to Auth0 as needed.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:322

    • Optional detailedResponse

    detailedResponse?: boolean
    @@ -82,7 +82,7 @@

    OptionalThe default is false.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:360

    • Optional timeoutInSeconds

    timeoutInSeconds?: number
    @@ -90,7 +90,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:353
    • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 530d297f..183f37c8 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetTokenWithPopupOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:362
    • @@ -43,7 +43,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional cacheMode

    cacheMode?: "on" | "off" | "cache-only"
    @@ -52,7 +52,7 @@

    Optionalon, where it both reads from the cache and sends a request to Auth0 as needed.

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:368
    • diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 220ea195..5578ccbe 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:505
    • @@ -58,6 +58,7 @@

    Properties

    nickname? nonce? org_id? +org_name? phone_number? phone_number_verified? picture? @@ -75,187 +76,192 @@

    Properties

    __raw

    __raw: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:506

    • Optional acr

    acr?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:537

    • Optional address

    address?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:524

    • Optional amr

    -
    amr?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:538

    • Optional at_hash

    at_hash?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:535

    • Optional aud

    aud?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:527

    • Optional auth_time

    auth_time?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:534

    • Optional azp

    azp?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:532

    • Optional birthdate

    birthdate?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:519

    • Optional c_hash

    c_hash?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:536

    • Optional cnf

    cnf?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:540

    • Optional email

    email?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:516

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:517

    • Optional exp

    exp?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:528

    • Optional family_name

    family_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:509

    • Optional gender

    gender?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:518

    • Optional given_name

    given_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:508

    • Optional iat

    iat?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:530

    • Optional iss

    iss?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:526

    • Optional jti

    jti?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:531

    • Optional locale

    locale?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:521

    • Optional middle_name

    middle_name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:510

    • Optional name

    name?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:507

    • Optional nbf

    nbf?: number
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:529

    • Optional nickname

    nickname?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:511

    • Optional nonce

    nonce?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:533

    • Optional org_id

    org_id?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:542
    • +
    +

    Optional org_name

    +
    org_name?: string

    Optional phone_number

    phone_number?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:522

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:523

    • Optional picture

    picture?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:514

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:512

    • Optional profile

    profile?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:513

    • Optional sid

    sid?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:541

    • Optional sub_jwk

    sub_jwk?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:539

    • Optional updated_at

    updated_at?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:525

    • Optional website

    website?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:515

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:520
    • @@ -307,6 +313,7 @@

    nickname?
  • nonce?
  • org_id?
    • +
  • org_name?
  • phone_number?
  • phone_number_verified?
  • picture?
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 58af3ba5..15a820fe 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in src/auth0-context.tsx:18
    • @@ -46,7 +46,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:380

    • Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }
    @@ -78,7 +78,7 @@
    Optional returnTo
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:385

    • Optional openUrl

    openUrl?: false | ((url: string) => void | Promise<void>)
    @@ -93,7 +93,7 @@

    Example

    import<
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:446
    • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 356d9bd0..0c452c30 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • LogoutUrlOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:370
    • @@ -42,7 +42,7 @@

    OptionalRead more about how redirecting after logout works

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:380

    • Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }
    @@ -73,7 +73,7 @@
    Optional returnToRead more about how redirecting after logout works

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:385
    • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 25ad66b2..0774add4 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • PopupConfigOptions
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:302
    • @@ -41,7 +41,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:313

    • Optional timeoutInSeconds

    timeoutInSeconds?: number
    @@ -49,7 +49,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:307
    • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 51eabfcb..d0c88d87 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:300
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index d1ef4c25..88a27327 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RedirectLoginOptions
    +
  • Defined in src/auth0-context.tsx:20
    • @@ -49,7 +49,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:256

    • Optional authorizationParams

    authorizationParams?: AuthorizationParams
    @@ -58,7 +58,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:101

    • Optional fragment

    fragment?: string
    @@ -66,7 +66,7 @@

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:260

    • Optional openUrl

    openUrl?: ((url: string) => void | Promise<void>)
    @@ -93,7 +93,7 @@
    url: string

    Returns void | Promise<void>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:292
    • diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index 22156aad..d54940bd 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 82a33298..fd8e4381 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 3b91f3e4..917fc4b3 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/types/CacheLocation.html b/docs/types/CacheLocation.html index c849015f..aece520f 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -19,7 +19,7 @@

    Type alias CacheLocation

    The possible locations where tokens can be stored

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:238
    • diff --git a/docs/variables/Auth0Context.html b/docs/variables/Auth0Context.html index 13ecc8b2..b1c39b19 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 ac11ba0c..77f81dd3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.1.1", + "version": "2.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.1.1", + "version": "2.2.0", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.1.0" diff --git a/package.json b/package.json index 9a13485b..91ea1254 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.1.1", + "version": "2.2.0", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",