From bcfd2199b616ca50c20c2701acbd6e7e2e06f92b Mon Sep 17 00:00:00 2001 From: Frederik Prijck Date: Wed, 14 Jun 2023 23:52:59 +0200 Subject: [PATCH] Release v2.1.1 (#544) --- CHANGELOG.md | 6 ++ 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 | 24 +++--- docs/interfaces/Auth0ProviderOptions.html | 10 +-- docs/interfaces/GetTokenSilentlyOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 4 +- docs/interfaces/IdToken.html | 76 +++++++++---------- docs/interfaces/LogoutOptions.html | 15 ++-- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 6 +- docs/interfaces/PopupLoginOptions.html | 2 +- docs/interfaces/RedirectLoginOptions.html | 15 ++-- docs/interfaces/WithAuth0Props.html | 4 +- .../WithAuthenticationRequiredOptions.html | 12 +-- docs/types/AppState.html | 2 +- docs/variables/Auth0Context.html | 2 +- package-lock.json | 4 +- package.json | 2 +- 23 files changed, 135 insertions(+), 123 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 21d52462..fc87d482 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [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) + +**Changed** +- bump SPA-JS to the latest version [\#543](https://github.com/auth0/auth0-react/pull/543) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.1.0](https://github.com/auth0/auth0-react/tree/v2.1.0) (2023-05-05) [Full Changelog](https://github.com/auth0/auth0-react/compare/v2.0.2...v2.1.0) diff --git a/docs/classes/OAuthError.html b/docs/classes/OAuthError.html index 8ad2496d..e0d4a1a3 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:542
    • @@ -70,102 +70,102 @@

    Properties

    Optional address

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

    • Optional birthdate

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

    • Optional email

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

    • Optional email_verified

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

    • Optional family_name

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

    • Optional gender

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

    • Optional given_name

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

    • Optional locale

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

    • Optional middle_name

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

    • Optional name

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

    • Optional nickname

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

    • Optional phone_number

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

    • Optional phone_number_verified

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

    • Optional picture

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

    • Optional preferred_username

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

    • Optional profile

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

    • Optional sub

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

    • Optional updated_at

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

    • Optional website

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

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:556
    • diff --git a/docs/functions/Auth0Provider.html b/docs/functions/Auth0Provider.html index aefb85e6..98688c62 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 7e38732c..de190902 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 15ebc129..6c797265 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 9c171081..35161801 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 c89f1fe5..dc9567d9 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) => void)
    @@ -303,13 +303,13 @@

    Parameters

    Optional options: LogoutOptions

    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 bd757b2c..69ea310f 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/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index c5d2179c..2311e279 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:312
    • @@ -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:323

    • 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:319

    • 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:357

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:350
    • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 8edfd9e3..530d297f 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:359
    • @@ -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:365
    • diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index dbe8a62f..220ea195 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:502
    • @@ -75,187 +75,187 @@

    Properties

    __raw

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

    • Optional acr

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

    • Optional address

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

    • Optional amr

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

    • Optional at_hash

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

    • Optional aud

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

    • Optional auth_time

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

    • Optional azp

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

    • Optional birthdate

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

    • Optional c_hash

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

    • Optional cnf

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

    • Optional email

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

    • Optional email_verified

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

    • Optional exp

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

    • Optional family_name

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

    • Optional gender

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

    • Optional given_name

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

    • Optional iat

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

    • Optional iss

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

    • Optional jti

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

    • Optional locale

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

    • Optional middle_name

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

    • Optional name

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

    • Optional nbf

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

    • Optional nickname

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

    • Optional nonce

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

    • Optional org_id

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

    • Optional phone_number

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

    • Optional phone_number_verified

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

    • Optional picture

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

    • Optional preferred_username

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

    • Optional profile

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

    • Optional sid

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

    • Optional sub_jwk

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

    • Optional updated_at

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

    • Optional website

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

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:517
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 6ef34e8f..58af3ba5 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:377

    • Optional logoutParams

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

    • Optional openUrl

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

    Used to control the redirect and not rely on the SDK to do the actual redirect.

    Set to false to disable the redirect, or provide a function to handle the actual redirect yourself.

    -

    Example

    await auth0.logout({
      async openUrl(url) {
        window.location.replace(url);
      }
    });
+
    Example
    await auth0.logout({
      openUrl(url) {
        window.location.replace(url);
      }
    });
+
    
+
+
    Example
    import { Browser } from '@capacitor/browser';

    await auth0.logout({
      async openUrl(url) {
        await Browser.open({ url });
      }
    });
    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:443
    • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index db40cea1..356d9bd0 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:367
    • @@ -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:377

    • 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:382
    • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 18ae994c..25ad66b2 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:299
    • @@ -41,7 +41,7 @@

    Optional

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

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:304
    • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 580f6c01..51eabfcb 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:297
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 7b7b9379..d1ef4c25 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

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

    OptionalDefined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:257

    Optional openUrl

    -
    openUrl?: ((url: string) => Promise<void>)
    +
    openUrl?: ((url: string) => void | Promise<void>)

    Type declaration

      • -
      • (url: string): Promise<void>
        • +
      • (url: string): void | Promise<void>

      • Used to control the redirect and not rely on the SDK to do the actual redirect.

        -

        Example

        const client = new Auth0Client({
          async openUrl(url) {
            window.location.replace(url);
          }
        });
+
        Example
        const client = new Auth0Client({
          openUrl(url) {
            window.location.replace(url);
          }
        });
+
        
+
+
        Example
        import { Browser } from '@capacitor/browser';

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
        @@ -87,10 +90,10 @@

        Parameters

        • url: string
        -

        Returns Promise<void>

    +
  • Defined in node_modules/@auth0/auth0-spa-js/dist/typings/global.d.ts:289
    • diff --git a/docs/interfaces/WithAuth0Props.html b/docs/interfaces/WithAuth0Props.html index df463107..22156aad 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 c52962d2..82a33298 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 0e2bf44f..3b91f3e4 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 fcd61262..13ecc8b2 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 74c35558..b24127ac 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-react", - "version": "2.1.0", + "version": "2.1.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-react", - "version": "2.1.0", + "version": "2.1.1", "license": "MIT", "dependencies": { "@auth0/auth0-spa-js": "^2.0.8" diff --git a/package.json b/package.json index d5a12aad..7c4459da 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "author": "Auth0", "name": "@auth0/auth0-react", - "version": "2.1.0", + "version": "2.1.1", "description": "Auth0 SDK for React Single Page Applications (SPA)", "keywords": [ "auth0",