From a83940957c48ce070792ee257d2e1e55aa5561f9 Mon Sep 17 00:00:00 2001 From: Yogesh Chaudhary Date: Wed, 7 Jan 2026 16:02:21 +0530 Subject: [PATCH 1/2] Release v2.11.1 --- .version | 2 +- CHANGELOG.md | 6 +++ FAQ.md | 2 +- docs/classes/Auth0Client.html | 38 +++++++-------- docs/classes/AuthenticationError.html | 4 +- docs/classes/CacheKey.html | 10 ++-- docs/classes/ConnectError.html | 4 +- docs/classes/Fetcher.html | 4 +- docs/classes/GenericError.html | 4 +- docs/classes/InMemoryCache.html | 4 +- docs/classes/LocalStorageCache.html | 4 +- docs/classes/MfaRequiredError.html | 4 +- docs/classes/MissingRefreshTokenError.html | 4 +- docs/classes/MyAccountApiError.html | 4 +- docs/classes/PopupCancelledError.html | 4 +- docs/classes/PopupOpenError.html | 4 +- docs/classes/PopupTimeoutError.html | 4 +- docs/classes/TimeoutError.html | 4 +- docs/classes/UseDpopNonceError.html | 4 +- docs/classes/User.html | 4 +- docs/enums/ResponseType.html | 4 +- docs/functions/createAuth0Client.html | 2 +- docs/interfaces/Auth0ClientOptions.html | 46 ++++++++++--------- docs/interfaces/AuthorizationParams.html | 30 ++++++------ .../interfaces/ClientAuthorizationParams.html | 4 +- docs/interfaces/DecodedToken.html | 4 +- docs/interfaces/GetTokenSilentlyOptions.html | 10 ++-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +-- docs/interfaces/ICache.html | 4 +- docs/interfaces/IdToken.html | 4 +- docs/interfaces/LogoutOptions.html | 10 ++-- docs/interfaces/LogoutUrlOptions.html | 6 +-- docs/interfaces/PopupConfigOptions.html | 6 +-- docs/interfaces/PopupLoginOptions.html | 4 +- .../RedirectConnectAccountOptions.html | 14 +++--- docs/interfaces/RedirectLoginOptions.html | 12 ++--- docs/interfaces/RedirectLoginResult.html | 6 +-- docs/types/CacheEntry.html | 2 +- docs/types/CacheKeyData.html | 2 +- docs/types/CacheLocation.html | 2 +- docs/types/Cacheable.html | 2 +- docs/types/ConnectAccountRedirectResult.html | 2 +- docs/types/CustomFetchMinimalOutput.html | 2 +- docs/types/CustomTokenExchangeOptions.html | 2 +- docs/types/FetcherConfig.html | 2 +- .../GetTokenSilentlyVerboseResponse.html | 2 +- docs/types/KeyManifestEntry.html | 2 +- docs/types/MaybePromise.html | 2 +- docs/types/TokenEndpointResponse.html | 2 +- docs/types/WrappedCacheEntry.html | 2 +- package-lock.json | 4 +- package.json | 2 +- src/version.ts | 2 +- 53 files changed, 166 insertions(+), 158 deletions(-) diff --git a/.version b/.version index 805579f30..327d2cce6 100644 --- a/.version +++ b/.version @@ -1 +1 @@ -v2.11.0 \ No newline at end of file +v2.11.1 \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 7fcceed76..b7eb7eff6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.11.1](https://github.com/auth0/auth0-spa-js/tree/v2.11.1) (2026-01-07) +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.11.0...v2.11.1) + +**Added** +- fix: clear cache when different user logs in without logout [\#1456](https://github.com/auth0/auth0-spa-js/pull/1456) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147)) + ## [v2.11.0](https://github.com/auth0/auth0-spa-js/tree/v2.11.0) (2025-12-11) [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.10.0...v2.11.0) diff --git a/FAQ.md b/FAQ.md index 970c35a53..70383fa85 100644 --- a/FAQ.md +++ b/FAQ.md @@ -124,7 +124,7 @@ If you want to use a CDN bundle together with import maps, you will need to use diff --git a/docs/classes/Auth0Client.html b/docs/classes/Auth0Client.html index 00f7e982d..077ba1eeb 100644 --- a/docs/classes/Auth0Client.html +++ b/docs/classes/Auth0Client.html @@ -1,5 +1,5 @@ Auth0Client | @auth0/auth0-spa-js

Class Auth0Client

Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE.

-

Constructors

constructor +

Constructors

constructor

Methods

_assertDpop checkSession connectAccountWithRedirect @@ -17,7 +17,7 @@ loginWithRedirect logout setDpopNonce -

Constructors

constructor

Methods

Protected _assertDpop

  • _assertDpop(dpop): asserts dpop is Dpop

  • Parameters

    • dpop: undefined | Dpop

    Returns asserts dpop is Dpop

checkSession

  • checkSession(options?): Promise<void>
  • await auth0.checkSession();
+

Constructors

constructor

Methods

Protected _assertDpop

  • _assertDpop(dpop): asserts dpop is Dpop

  • Parameters

    • dpop: undefined | Dpop

    Returns asserts dpop is Dpop

checkSession

  • checkSession(options?): Promise<void>
  • await auth0.checkSession();

    Check if the user is logged in using getTokenSilently. The difference with getTokenSilently is that this doesn't return a token, but it will @@ -33,19 +33,19 @@ means that checkSession could silently return without authenticating the user on page refresh when using a private tab, despite having previously logged in. As a workaround, use getTokenSilently instead and handle the possible login_required error as shown in the readme.

    -

    Parameters

    Returns Promise<void>

connectAccountWithRedirect

connectAccountWithRedirect

  • connectAccountWithRedirect<TAppState>(options): Promise<void>

  • Initiates a redirect to connect the user's account with a specified connection. This method generates PKCE parameters, creates a transaction, and redirects to the /connect endpoint.

    You must enable Offline Access from the Connection Permissions settings to be able to use the connection with Connected Accounts.

    Type Parameters

    • TAppState = any

      The application state to persist through the transaction.

    Parameters

    Returns Promise<void>

    Resolves when the redirect is initiated.

    Throws

    If the connect request to the My Account API fails.

    -

createFetcher

createFetcher

  • createFetcher<TOutput>(config?): Fetcher<TOutput>

  • Returns a new Fetcher class that will contain a fetchWithAuth() method. This is a drop-in replacement for the Fetch API's fetch() method, but will handle certain authentication logic for you, like building the proper auth headers or managing DPoP nonces and retries automatically.

    Check the EXAMPLES.md file for a deeper look into this method.

    -

    Type Parameters

    Parameters

    Returns Fetcher<TOutput>

exchangeToken

exchangeToken

  • exchangeToken(options): Promise<TokenEndpointResponse>

  • Exchanges an external subject token for an Auth0 token via a token exchange request.

    Parameters

    Returns Promise<TokenEndpointResponse>

    A promise that resolves to the token endpoint response, which contains the issued Auth0 tokens.

    @@ -65,41 +65,41 @@

    Example Usage:

    // Define the token exchange options
    const options: CustomTokenExchangeOptions = {
      subject_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp...',
      subject_token_type: 'urn:acme:legacy-system-token',
      scope: "openid profile",
      organization: "org_12345"
    };

    // Exchange the external token for Auth0 tokens
    try {
      const tokenResponse = await instance.exchangeToken(options);
      // Use tokenResponse.access_token, tokenResponse.id_token, etc.
      // The organization ID will be present in the access token payload
    } catch (error) {
      // Handle token exchange error
    }
    -

generateDpopProof

  • generateDpopProof(params): Promise<string>

  • Returns a string to be used to demonstrate possession of the private +

generateDpopProof

  • generateDpopProof(params): Promise<string>

  • Returns a string to be used to demonstrate possession of the private key used to cryptographically bind access tokens with DPoP.

    It requires enabling the Auth0ClientOptions.useDpop option.

    -

    Parameters

    • params: {
          accessToken: string;
          method: string;
          nonce?: string;
          url: string;
      }
      • accessToken: string
      • method: string
      • Optional nonce?: string
      • url: string

    Returns Promise<string>

getDpopNonce

  • getDpopNonce(id?): Promise<undefined | string>

  • Returns the current DPoP nonce used for making requests to Auth0.

    +

    Parameters

    • params: {
          accessToken: string;
          method: string;
          nonce?: string;
          url: string;
      }
      • accessToken: string
      • method: string
      • Optional nonce?: string
      • url: string

    Returns Promise<string>

getDpopNonce

  • getDpopNonce(id?): Promise<undefined | string>

  • Returns the current DPoP nonce used for making requests to Auth0.

    It can return undefined because when starting fresh it will not be populated until after the first response from the server.

    It requires enabling the Auth0ClientOptions.useDpop option.

    Parameters

    • Optional id: string

      The identifier of a nonce: if absent, it will get the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

      -

    Returns Promise<undefined | string>

getIdTokenClaims

  • getIdTokenClaims(): Promise<undefined | IdToken>
  • const claims = await auth0.getIdTokenClaims();
+

Returns Promise<undefined | string>

getIdTokenClaims

  • getIdTokenClaims(): Promise<undefined | IdToken>
  • const claims = await auth0.getIdTokenClaims();

    Returns all claims from the id_token if available.

    -

    Returns Promise<undefined | IdToken>

getTokenSilently

getTokenWithPopup

  • getTokenWithPopup(options?, config?): Promise<undefined | string>
  • const token = await auth0.getTokenWithPopup(options);
+

    Returns Promise<undefined | IdToken>

getTokenSilently

getTokenWithPopup

  • getTokenWithPopup(options?, config?): Promise<undefined | string>
  • const token = await auth0.getTokenWithPopup(options);

    Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated. If the response is successful, results will be valid according to their expiration times.

    -

    Parameters

    Returns Promise<undefined | string>

getUser

getUser

  • getUser<TUser>(): Promise<undefined | TUser>
  • const user = await auth0.getUser();

    Returns the user information if available (decoded from the id_token).

    Type Parameters

    Returns Promise<undefined | TUser>

    Typeparam

    TUser The type to return, has to extend User.

    -

handleRedirectCallback

handleRedirectCallback

isAuthenticated

isAuthenticated

  • isAuthenticated(): Promise<boolean>
  • const isAuthenticated = await auth0.isAuthenticated();

    Returns true if there's valid information stored, otherwise returns false.

    -

    Returns Promise<boolean>

loginWithPopup

  • loginWithPopup(options?, config?): Promise<void>
  • try {
     await auth0.loginWithPopup(options);
    } catch(e) {
     if (e instanceof PopupCancelledError) {
       // Popup was closed before login completed
     }
    }
+

    Returns Promise<boolean>

loginWithPopup

  • loginWithPopup(options?, config?): Promise<void>
  • try {
     await auth0.loginWithPopup(options);
    } catch(e) {
     if (e instanceof PopupCancelledError) {
       // Popup was closed before login completed
     }
    }

    Opens a popup with the /authorize URL using the parameters provided as arguments. Random and secure state and nonce @@ -108,21 +108,21 @@

    IMPORTANT: This method has to be called from an event handler that was started by the user like a button click, for example, otherwise the popup will be blocked in most browsers.

    -

    Parameters

    Returns Promise<void>

loginWithRedirect

loginWithRedirect

  • loginWithRedirect<TAppState>(options?): Promise<void>
  • await auth0.loginWithRedirect(options);

    Performs a redirect to /authorize using the parameters provided as arguments. Random and secure state and nonce parameters will be auto-generated.

    -

    Type Parameters

    • TAppState = any

    Parameters

    Returns Promise<void>

logout

logout

  • logout(options?): Promise<void>
  • await auth0.logout(options);

    Clears the application session and performs a redirect to /v2/logout, using the parameters provided as arguments, to clear the Auth0 session.

    If the federated option is specified it also clears the Identity Provider session. Read more about how Logout works at Auth0.

    -

    Parameters

    Returns Promise<void>

setDpopNonce

  • setDpopNonce(nonce, id?): Promise<void>

  • Sets the current DPoP nonce used for making requests to Auth0.

    +

    Parameters

    Returns Promise<void>

setDpopNonce

  • setDpopNonce(nonce, id?): Promise<void>

  • Sets the current DPoP nonce used for making requests to Auth0.

    It requires enabling the Auth0ClientOptions.useDpop option.

    Parameters

    • nonce: string

      The nonce value.

    • Optional id: string

      The identifier of a nonce: if absent, it will set the nonce used for requests to Auth0. Otherwise, it will be used to select a specific non-Auth0 nonce.

      -

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 5e0ef3ba7..ce6bd4c29 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -1,9 +1,9 @@ AuthenticationError | @auth0/auth0-spa-js

Class AuthenticationError

Thrown when handling the redirect callback fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

appState error error_description state

Methods

fromPayload -

Constructors

constructor

Properties

appState

appState: any = null

error

error: string

error_description

error_description: string

state

state: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

appState

appState: any = null

error

error: string

error_description

error_description: string

state

state: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/CacheKey.html b/docs/classes/CacheKey.html index 5f8c5511a..a9242baa0 100644 --- a/docs/classes/CacheKey.html +++ b/docs/classes/CacheKey.html @@ -1,4 +1,4 @@ -CacheKey | @auth0/auth0-spa-js

Class CacheKey

Constructors

constructor +CacheKey | @auth0/auth0-spa-js

Class CacheKey

Constructors

constructor

Properties

audience? clientId prefix @@ -7,12 +7,12 @@

Methods

toKey fromCacheEntry fromKey -

Constructors

constructor

Properties

Optional audience

audience?: string

clientId

clientId: string

prefix

prefix: string = CACHE_KEY_PREFIX

Optional scope

scope?: string

Optional suffix

suffix?: string

Methods

toKey

  • toKey(): string

  • Converts this CacheKey instance into a string for use in a cache

    +

Constructors

constructor

Properties

Optional audience

audience?: string

clientId

clientId: string

prefix

prefix: string = CACHE_KEY_PREFIX

Optional scope

scope?: string

Optional suffix

suffix?: string

Methods

toKey

  • toKey(): string

  • Converts this CacheKey instance into a string for use in a cache

    Returns string

    A string representation of the key

    -

Static fromCacheEntry

Static fromCacheEntry

Static fromKey

Static fromKey

  • fromKey(key): CacheKey

  • Converts a cache key string into a CacheKey instance.

    Parameters

    • key: string

      The key to convert

    Returns CacheKey

    An instance of CacheKey

    -

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/ConnectError.html b/docs/classes/ConnectError.html index 31f513895..2d3078895 100644 --- a/docs/classes/ConnectError.html +++ b/docs/classes/ConnectError.html @@ -1,10 +1,10 @@ ConnectError | @auth0/auth0-spa-js

Class ConnectError

Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

appState connection error error_description state

Methods

fromPayload -

Constructors

constructor

Properties

appState

appState: any = null

connection

connection: string

error

error: string

error_description

error_description: string

state

state: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

appState

appState: any = null

connection

connection: string

error

error: string

error_description

error_description: string

state

state: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/Fetcher.html b/docs/classes/Fetcher.html index 62578f40f..e12b65875 100644 --- a/docs/classes/Fetcher.html +++ b/docs/classes/Fetcher.html @@ -1,4 +1,4 @@ -Fetcher | @auth0/auth0-spa-js

Class Fetcher<TOutput>

Type Parameters

Constructors

constructor +Fetcher | @auth0/auth0-spa-js

Class Fetcher<TOutput>

Type Parameters

Constructors

constructor

Properties

config hooks

Methods

buildBaseRequest @@ -14,4 +14,4 @@ prepareRequest setAuthorizationHeader setDpopProofHeader -

Constructors

constructor

Properties

Protected Readonly config

config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<Pick<FetcherConfig<TOutput>, "fetch">>

Protected Readonly hooks

hooks: FetcherHooks

Methods

Protected buildBaseRequest

  • buildBaseRequest(info, init): Request

  • Parameters

    • info: RequestInfo | URL
    • init: undefined | RequestInit

    Returns Request

Protected buildUrl

  • buildUrl(baseUrl, url): string

  • Parameters

    • baseUrl: undefined | string
    • url: undefined | string

    Returns string

Protected extractUrl

  • extractUrl(info): string

  • Parameters

    • info: RequestInfo | URL

    Returns string

fetchWithAuth

  • fetchWithAuth(info, init?, authParams?): Promise<TOutput>

  • Parameters

    • info: RequestInfo | URL
    • Optional init: RequestInit
    • Optional authParams: AuthParams

    Returns Promise<TOutput>

Protected getAccessToken

Protected getHeader

  • getHeader(headers, name): string

  • Parameters

    • headers: ResponseHeaders
    • name: string

    Returns string

Protected handleResponse

Protected hasUseDpopNonceError

  • hasUseDpopNonceError(response): boolean

  • Parameters

    Returns boolean

Protected internalFetchWithAuth

  • internalFetchWithAuth(info, init, callbacks, authParams?): Promise<TOutput>

  • Parameters

    • info: RequestInfo | URL
    • init: undefined | RequestInit
    • callbacks: FetchWithAuthCallbacks<TOutput>
    • Optional authParams: AuthParams

    Returns Promise<TOutput>

Protected isAbsoluteUrl

  • isAbsoluteUrl(url): boolean

  • Parameters

    • url: string

    Returns boolean

Protected prepareRequest

  • prepareRequest(request, authParams?): Promise<void>

  • Parameters

    • request: Request
    • Optional authParams: AuthParams

    Returns Promise<void>

Protected setAuthorizationHeader

  • setAuthorizationHeader(request, accessToken, tokenType?): void

  • Parameters

    • request: Request
    • accessToken: string
    • tokenType: string = TokenType.Bearer

    Returns void

Protected setDpopProofHeader

  • setDpopProofHeader(request, accessToken): Promise<void>

  • Parameters

    • request: Request
    • accessToken: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

Protected Readonly config

config: Omit<FetcherConfig<TOutput>, "fetch"> & Required<Pick<FetcherConfig<TOutput>, "fetch">>

Protected Readonly hooks

hooks: FetcherHooks

Methods

Protected buildBaseRequest

  • buildBaseRequest(info, init): Request

  • Parameters

    • info: RequestInfo | URL
    • init: undefined | RequestInit

    Returns Request

Protected buildUrl

  • buildUrl(baseUrl, url): string

  • Parameters

    • baseUrl: undefined | string
    • url: undefined | string

    Returns string

Protected extractUrl

  • extractUrl(info): string

  • Parameters

    • info: RequestInfo | URL

    Returns string

fetchWithAuth

  • fetchWithAuth(info, init?, authParams?): Promise<TOutput>

  • Parameters

    • info: RequestInfo | URL
    • Optional init: RequestInit
    • Optional authParams: AuthParams

    Returns Promise<TOutput>

Protected getAccessToken

Protected getHeader

  • getHeader(headers, name): string

  • Parameters

    • headers: ResponseHeaders
    • name: string

    Returns string

Protected handleResponse

Protected hasUseDpopNonceError

  • hasUseDpopNonceError(response): boolean

  • Parameters

    Returns boolean

Protected internalFetchWithAuth

  • internalFetchWithAuth(info, init, callbacks, authParams?): Promise<TOutput>

  • Parameters

    • info: RequestInfo | URL
    • init: undefined | RequestInit
    • callbacks: FetchWithAuthCallbacks<TOutput>
    • Optional authParams: AuthParams

    Returns Promise<TOutput>

Protected isAbsoluteUrl

  • isAbsoluteUrl(url): boolean

  • Parameters

    • url: string

    Returns boolean

Protected prepareRequest

  • prepareRequest(request, authParams?): Promise<void>

  • Parameters

    • request: Request
    • Optional authParams: AuthParams

    Returns Promise<void>

Protected setAuthorizationHeader

  • setAuthorizationHeader(request, accessToken, tokenType?): void

  • Parameters

    • request: Request
    • accessToken: string
    • tokenType: string = TokenType.Bearer

    Returns void

Protected setDpopProofHeader

  • setDpopProofHeader(request, accessToken): Promise<void>

  • Parameters

    • request: Request
    • accessToken: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index be9dd1064..0f0592d51 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -1,6 +1,6 @@ GenericError | @auth0/auth0-spa-js

Class GenericError

Thrown when network requests to the Auth server fail.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

  • fromPayload(__namedParameters): GenericError

  • Parameters

    • __namedParameters: {
          error: string;
          error_description: string;
      }
      • error: string
      • error_description: string

    Returns GenericError

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

  • fromPayload(__namedParameters): GenericError

  • Parameters

    • __namedParameters: {
          error: string;
          error_description: string;
      }
      • error: string
      • error_description: string

    Returns GenericError

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index 65fed3011..43e9131f0 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -1,3 +1,3 @@ -InMemoryCache | @auth0/auth0-spa-js

Class InMemoryCache

Constructors

constructor +InMemoryCache | @auth0/auth0-spa-js

Class InMemoryCache

Constructors

constructor

Properties

enclosedCache -

Constructors

constructor

Properties

enclosedCache

enclosedCache: ICache = ...

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

enclosedCache

enclosedCache: ICache = ...

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index 53493e934..f8b37f390 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -1,6 +1,6 @@ -LocalStorageCache | @auth0/auth0-spa-js

Class LocalStorageCache

Implements

Constructors

constructor +LocalStorageCache | @auth0/auth0-spa-js

Class LocalStorageCache

Implements

Constructors

constructor

Methods

allKeys get remove set -

Constructors

constructor

Methods

allKeys

get

remove

set

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Methods

allKeys

get

remove

set

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index a42c66a77..395566f6e 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -1,7 +1,7 @@ MfaRequiredError | @auth0/auth0-spa-js

Class MfaRequiredError

Error thrown when the token exchange results in a mfa_required error

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description mfa_token

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

mfa_token

mfa_token: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

mfa_token

mfa_token: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 566998884..e53175156 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -1,8 +1,8 @@ MissingRefreshTokenError | @auth0/auth0-spa-js

Class MissingRefreshTokenError

Error thrown when there is no refresh token to use

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

audience error error_description scope

Methods

fromPayload -

Constructors

constructor

Properties

audience

audience: string

error

error: string

error_description

error_description: string

scope

scope: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

audience

audience: string

error

error: string

error_description

error_description: string

scope

scope: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/MyAccountApiError.html b/docs/classes/MyAccountApiError.html index 2c0bc9f09..b1f176f00 100644 --- a/docs/classes/MyAccountApiError.html +++ b/docs/classes/MyAccountApiError.html @@ -1,7 +1,7 @@ -MyAccountApiError | @auth0/auth0-spa-js

Class MyAccountApiError

Hierarchy

  • Error
    • MyAccountApiError

Constructors

constructor +MyAccountApiError | @auth0/auth0-spa-js

Class MyAccountApiError

Hierarchy

  • Error
    • MyAccountApiError

Constructors

constructor

Properties

detail status title type validation_errors? -

Constructors

constructor

Properties

Readonly detail

detail: string

Readonly status

status: number

Readonly title

title: string

Readonly type

type: string

Optional Readonly validation_errors

validation_errors?: {
    detail: string;
    field?: string;
    pointer?: string;
    source?: string;
}[]

Type declaration

  • detail: string
  • Optional field?: string
  • Optional pointer?: string
  • Optional source?: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

Readonly detail

detail: string

Readonly status

status: number

Readonly title

title: string

Readonly type

type: string

Optional Readonly validation_errors

validation_errors?: {
    detail: string;
    field?: string;
    pointer?: string;
    source?: string;
}[]

Type declaration

  • detail: string
  • Optional field?: string
  • Optional pointer?: string
  • Optional source?: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index cffbd23e2..d7616d7a2 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -1,7 +1,7 @@ PopupCancelledError | @auth0/auth0-spa-js

Class PopupCancelledError

Thrown when network requests to the Auth server fail.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description popup

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

popup

popup: Window

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

popup

popup: Window

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/PopupOpenError.html b/docs/classes/PopupOpenError.html index d157a1553..96bbd5a18 100644 --- a/docs/classes/PopupOpenError.html +++ b/docs/classes/PopupOpenError.html @@ -1,6 +1,6 @@ PopupOpenError | @auth0/auth0-spa-js

Class PopupOpenError

Thrown when network requests to the Auth server fail.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index acf887840..7afb5fddb 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -1,7 +1,7 @@ PopupTimeoutError | @auth0/auth0-spa-js

Class PopupTimeoutError

Error thrown when the login popup times out (if the user does not complete auth)

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description popup

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

popup

popup: Window

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

popup

popup: Window

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index d4d9d6a6a..614b230bf 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -1,7 +1,7 @@ TimeoutError | @auth0/auth0-spa-js

Class TimeoutError

Thrown when silent auth times out (usually due to a configuration issue) or when network requests to the Auth server timeout.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/UseDpopNonceError.html b/docs/classes/UseDpopNonceError.html index a3afc023c..be9af2e3c 100644 --- a/docs/classes/UseDpopNonceError.html +++ b/docs/classes/UseDpopNonceError.html @@ -1,7 +1,7 @@ UseDpopNonceError | @auth0/auth0-spa-js

Class UseDpopNonceError

Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

error error_description newDpopNonce

Methods

fromPayload -

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

newDpopNonce

newDpopNonce: undefined | string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

error

error: string

error_description

error_description: string

newDpopNonce

newDpopNonce: undefined | string

Methods

Static fromPayload

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/classes/User.html b/docs/classes/User.html index 0d0b2307e..ca9357c46 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -1,4 +1,4 @@ -User | @auth0/auth0-spa-js

Class User

Indexable

[key: string]: any

Constructors

constructor +User | @auth0/auth0-spa-js

Class User

Indexable

[key: string]: any

Constructors

constructor

Properties

address? birthdate? email? @@ -19,4 +19,4 @@ updated_at? website? zoneinfo? -

Constructors

constructor

Properties

Optional address

address?: string

Optional birthdate

birthdate?: string

Optional email

email?: string

Optional email_verified

email_verified?: boolean

Optional family_name

family_name?: string

Optional gender

gender?: string

Optional given_name

given_name?: string

Optional locale

locale?: string

Optional middle_name

middle_name?: string

Optional name

name?: string

Optional nickname

nickname?: string

Optional phone_number

phone_number?: string

Optional phone_number_verified

phone_number_verified?: boolean

Optional picture

picture?: string

Optional preferred_username

preferred_username?: string

Optional profile

profile?: string

Optional sub

sub?: string

Optional updated_at

updated_at?: string

Optional website

website?: string

Optional zoneinfo

zoneinfo?: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Constructors

constructor

Properties

Optional address

address?: string

Optional birthdate

birthdate?: string

Optional email

email?: string

Optional email_verified

email_verified?: boolean

Optional family_name

family_name?: string

Optional gender

gender?: string

Optional given_name

given_name?: string

Optional locale

locale?: string

Optional middle_name

middle_name?: string

Optional name

name?: string

Optional nickname

nickname?: string

Optional phone_number

phone_number?: string

Optional phone_number_verified

phone_number_verified?: boolean

Optional picture

picture?: string

Optional preferred_username

preferred_username?: string

Optional profile

profile?: string

Optional sub

sub?: string

Optional updated_at

updated_at?: string

Optional website

website?: string

Optional zoneinfo

zoneinfo?: string

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/enums/ResponseType.html b/docs/enums/ResponseType.html index cca067f49..f0ad03103 100644 --- a/docs/enums/ResponseType.html +++ b/docs/enums/ResponseType.html @@ -3,6 +3,6 @@
  • code: used for the standard login flow.
  • connect_code: used for the connect account flow.
    • -

    Enumeration Members

    Code +

    Enumeration Members

    Code ConnectCode -

    Enumeration Members

    Code

    Code: "code"

    ConnectCode

    ConnectCode: "connect_code"

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Enumeration Members

    Code

    Code: "code"

    ConnectCode

    ConnectCode: "connect_code"

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/functions/createAuth0Client.html b/docs/functions/createAuth0Client.html index f0c98f3a5..62ff8129b 100644 --- a/docs/functions/createAuth0Client.html +++ b/docs/functions/createAuth0Client.html @@ -3,4 +3,4 @@ a user on page refresh. Please see the checkSession docs for more info.

    Parameters

    Returns Promise<Auth0Client>

    An instance of Auth0Client

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/interfaces/Auth0ClientOptions.html b/docs/interfaces/Auth0ClientOptions.html index fe7a54a9a..c10e5202e 100644 --- a/docs/interfaces/Auth0ClientOptions.html +++ b/docs/interfaces/Auth0ClientOptions.html @@ -1,4 +1,4 @@ -Auth0ClientOptions | @auth0/auth0-spa-js

    Interface Auth0ClientOptions

    interface Auth0ClientOptions {
        auth0Client?: {
            env?: {
                [key: string]: string;
            };
            name: string;
            version: string;
        };
        authorizationParams?: ClientAuthorizationParams;
        authorizeTimeoutInSeconds?: number;
        cache?: ICache;
        cacheLocation?: CacheLocation;
        clientId: string;
        cookieDomain?: string;
        domain: string;
        httpTimeoutInSeconds?: number;
        issuer?: string;
        leeway?: number;
        legacySameSiteCookie?: boolean;
        nowProvider?: (() => number | Promise<number>);
        sessionCheckExpiryDays?: number;
        useCookiesForTransactions?: boolean;
        useDpop?: boolean;
        useFormData?: boolean;
        useMrrt?: boolean;
        useRefreshTokens?: boolean;
        useRefreshTokensFallback?: boolean;
        workerUrl?: string;
    }

    Properties

    auth0Client? +Auth0ClientOptions | @auth0/auth0-spa-js

    Interface Auth0ClientOptions

    interface Auth0ClientOptions {
        auth0Client?: {
            env?: {
                [key: string]: string;
            };
            name: string;
            version: string;
        };
        authorizationParams?: ClientAuthorizationParams;
        authorizeTimeoutInSeconds?: number;
        cache?: ICache;
        cacheLocation?: CacheLocation;
        clientId: string;
        cookieDomain?: string;
        domain: string;
        httpTimeoutInSeconds?: number;
        issuer?: string;
        leeway?: number;
        legacySameSiteCookie?: boolean;
        nowProvider?: (() => number | Promise<number>);
        sessionCheckExpiryDays?: number;
        useCookiesForTransactions?: boolean;
        useDpop?: boolean;
        useFormData?: boolean;
        useMrrt?: boolean;
        useRefreshTokens?: boolean;
        useRefreshTokensFallback?: boolean;
        workerUrl?: string;
    }

    Properties

    auth0Client? authorizationParams? authorizeTimeoutInSeconds? cache? @@ -20,58 +20,60 @@ useRefreshTokensFallback? workerUrl?

    Properties

    Optional Internal auth0Client

    auth0Client?: {
        env?: {
            [key: string]: string;
        };
        name: string;
        version: string;
    }

    Internal property to send information about the client to the authorization server.

    -

    Type declaration

    • Optional env?: {
          [key: string]: string;
      }
      • [key: string]: string
    • name: string
    • version: string

    Optional authorizationParams

    authorizationParams?: ClientAuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters +

    Type declaration

    • Optional env?: {
          [key: string]: string;
      }
      • [key: string]: string
    • name: string
    • version: string

    Optional authorizationParams

    authorizationParams?: ClientAuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

    -

    Optional authorizeTimeoutInSeconds

    authorizeTimeoutInSeconds?: number

    A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout +

    Optional authorizeTimeoutInSeconds

    authorizeTimeoutInSeconds?: number

    A maximum number of seconds to wait before declaring background calls to /authorize as failed for timeout Defaults to 60s.

    -

    Optional cache

    cache?: ICache

    Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.

    -

    Optional cacheLocation

    cacheLocation?: CacheLocation

    The location to use when storing cache data. Valid values are memory or localstorage. +

    Optional cache

    cache?: ICache

    Specify a custom cache implementation to use for token storage and retrieval. This setting takes precedence over cacheLocation if they are both specified.

    +

    Optional cacheLocation

    cacheLocation?: CacheLocation

    The location to use when storing cache data. Valid values are memory or localstorage. The default setting is memory.

    Read more about changing storage options in the Auth0 docs

    -

    clientId

    clientId: string

    The Client ID found on your Application settings page

    -

    Optional cookieDomain

    cookieDomain?: string

    The domain the cookie is accessible from. If not set, the cookie is scoped to +

    clientId

    clientId: string

    The Client ID found on your Application settings page

    +

    Optional cookieDomain

    cookieDomain?: string

    The domain the cookie is accessible from. If not set, the cookie is scoped to the current domain, including the subdomain.

    Note: setting this incorrectly may cause silent authentication to stop working on page load.

    To keep a user logged in across multiple subdomains set this to your top-level domain and prefixed with a . (eg: .example.com).

    -

    domain

    domain: string

    Your Auth0 account domain such as 'example.auth0.com', +

    domain

    domain: string

    Your Auth0 account domain such as 'example.auth0.com', 'example.eu.auth0.com' or , 'example.mycompany.com' (when using custom domains)

    -

    Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number

    Specify the timeout for HTTP calls using fetch. The default is 10 seconds.

    -

    Optional issuer

    issuer?: string

    The issuer to be used for validation of JWTs, optionally defaults to the domain above

    -

    Optional leeway

    leeway?: number

    The value in seconds used to account for clock skew in JWT expirations. +

    Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number

    Specify the timeout for HTTP calls using fetch. The default is 10 seconds.

    +

    Optional issuer

    issuer?: string

    The issuer to be used for validation of JWTs, optionally defaults to the domain above

    +

    Optional leeway

    leeway?: number

    The value in seconds used to account for clock skew in JWT expirations. Typically, this value is no more than a minute or two at maximum. Defaults to 60s.

    -

    Optional legacySameSiteCookie

    legacySameSiteCookie?: boolean

    Sets an additional cookie with no SameSite attribute to support legacy browsers +

    Optional legacySameSiteCookie

    legacySameSiteCookie?: boolean

    Sets an additional cookie with no SameSite attribute to support legacy browsers that are not compatible with the latest SameSite changes. This will log a warning on modern browsers, you can disable the warning by setting this to false but be aware that some older useragents will not work, See https://www.chromium.org/updates/same-site/incompatible-clients Defaults to true

    -

    Optional nowProvider

    nowProvider?: (() => number | Promise<number>)

    Modify the value used as the current time during the token validation.

    +

    Optional nowProvider

    nowProvider?: (() => number | Promise<number>)

    Modify the value used as the current time during the token validation.

    Note: Using this improperly can potentially compromise the token validation.

    Type declaration

      • (): number | Promise<number>

      • Modify the value used as the current time during the token validation.

        Note: Using this improperly can potentially compromise the token validation.

        -

        Returns number | Promise<number>

    Optional sessionCheckExpiryDays

    sessionCheckExpiryDays?: number

    Number of days until the cookie auth0.is.authenticated will expire +

    Returns number | Promise<number>

    Optional sessionCheckExpiryDays

    sessionCheckExpiryDays?: number

    Number of days until the cookie auth0.is.authenticated will expire Defaults to 1.

    -

    Optional useCookiesForTransactions

    useCookiesForTransactions?: boolean

    If true, the SDK will use a cookie when storing information about the auth transaction while +

    Optional useCookiesForTransactions

    useCookiesForTransactions?: boolean

    If true, the SDK will use a cookie when storing information about the auth transaction while the user is going through the authentication flow on the authorization server.

    The default is false, in which case the SDK will use session storage.

    Notes

    You might want to enable this if you rely on your users being able to authenticate using flows that may end up spanning across multiple tabs (e.g. magic links) or you cannot otherwise rely on session storage being available.

    -

    Optional useDpop

    useDpop?: boolean

    If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) +

    Optional useDpop

    useDpop?: boolean

    If true, DPoP (OAuth 2.0 Demonstrating Proof of Possession, RFC9449) will be used to cryptographically bind tokens to this specific browser so they can't be used from a different device in case of a leak.

    The default setting is false.

    -

    Optional useFormData

    useFormData?: boolean

    If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

    +

    Optional useFormData

    useFormData?: boolean

    If true, data to the token endpoint is transmitted as x-www-form-urlencoded data, if false it will be transmitted as JSON. The default setting is true.

    Note: Setting this to false may affect you if you use Auth0 Rules and are sending custom, non-primitive data. If you disable this, please verify that your Auth0 Rules continue to work as intended.

    -

    Optional useMrrt

    useMrrt?: boolean

    If true, the SDK will allow the refreshing of tokens using MRRT

    -

    Optional useRefreshTokens

    useRefreshTokens?: boolean

    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. +

    Optional useMrrt

    useMrrt?: boolean

    If true, the SDK will allow the refreshing of tokens using MRRT

    +

    Optional useRefreshTokens

    useRefreshTokens?: boolean

    If true, refresh tokens are used to fetch new access tokens from the Auth0 server. If false, the standard technique of using a hidden iframe and the authorization_code grant with prompt=none is used. The default setting is false.

    +

    Standard technique relies on cookies. Because browsers increasingly block third-party cookies, it requires a Custom Domain to function reliably. Refresh tokens serve as a fallback for environments where third-party cookies are blocked. +Using a Custom Domain with this set to false is the most secure and recommended approach.

    Note: Use of refresh tokens must be enabled by an administrator on your Auth0 client application.

    -

    Optional useRefreshTokensFallback

    useRefreshTokensFallback?: boolean

    If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and +

    Optional useRefreshTokensFallback

    useRefreshTokensFallback?: boolean

    If true, fallback to the technique of using a hidden iframe and the authorization_code grant with prompt=none when unable to use refresh tokens. If false, the iframe fallback is not used and errors relating to a failed refresh_token grant should be handled appropriately. The default setting is false.

    Note: There might be situations where doing silent auth with a Web Message response from an iframe is not possible, like when you're serving your application from the file system or a custom protocol (like in a Desktop or Native app). @@ -79,9 +81,9 @@

    E.g. Using the file: protocol in an Electron application does not support that legacy technique.

    Example

    let token: string;
    try {
      token = await auth0.getTokenSilently();
    } catch (e) {
      if (e.error === 'missing_refresh_token' || e.error === 'invalid_grant') {
        auth0.loginWithRedirect();
      }
    }
    -

    Optional workerUrl

    workerUrl?: string

    If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict +

    Optional workerUrl

    workerUrl?: string

    If provided, the SDK will load the token worker from this URL instead of the integrated blob. An example of when this is useful is if you have strict Content-Security-Policy (CSP) and wish to avoid needing to set worker-src: blob:. We recommend either serving the worker, which you can find in the module at <module_path>/dist/auth0-spa-js.worker.production.js, from the same host as your application or using the Auth0 CDN https://cdn.auth0.com/js/auth0-spa-js/<version>/auth0-spa-js.worker.production.js.

    Note: The worker is only used when useRefreshTokens: true, cacheLocation: 'memory', and the cache is not custom.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index e19c795fc..112546c75 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -1,6 +1,6 @@ AuthorizationParams | @auth0/auth0-spa-js

    Interface AuthorizationParams

    interface AuthorizationParams {
        acr_values?: string;
        audience?: string;
        connection?: string;
        display?: "page" | "popup" | "touch" | "wap";
        id_token_hint?: string;
        invitation?: string;
        login_hint?: string;
        max_age?: string | number;
        organization?: string;
        prompt?: "none" | "login" | "consent" | "select_account";
        redirect_uri?: string;
        scope?: string;
        screen_hint?: string;
        ui_locales?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    If you need to send custom parameters to the Authorization Server, make sure to use the original parameter name.

    -

    Properties

    acr_values? +

    Properties

    acr_values? audience? connection? display? @@ -14,26 +14,26 @@ scope? screen_hint? ui_locales? -

    Properties

    Optional acr_values

    acr_values?: string

    Optional audience

    audience?: string

    The default audience to be used for requesting API access.

    -

    Optional connection

    connection?: string

    The name of the connection configured for your application. +

    Properties

    Optional acr_values

    acr_values?: string

    Optional audience

    audience?: string

    The default audience to be used for requesting API access.

    +

    Optional connection

    connection?: string

    The name of the connection configured for your application. If null, it will redirect to the Auth0 Login Page and show the Login Widget.

    -

    Optional display

    display?: "page" | "popup" | "touch" | "wap"
      +

    Optional display

    display?: "page" | "popup" | "touch" | "wap"
    • 'page': displays the UI with a full page view
    • 'popup': displays the UI with a popup window
    • 'touch': displays the UI in a way that leverages a touch interface
    • 'wap': displays the UI with a "feature phone" type interface
    -

    Optional id_token_hint

    id_token_hint?: string

    Previously issued ID Token.

    -

    Optional invitation

    invitation?: string

    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.

    -

    Optional login_hint

    login_hint?: string

    The user's email address or other identifier. When your app knows +

    Optional id_token_hint

    id_token_hint?: string

    Previously issued ID Token.

    +

    Optional invitation

    invitation?: string

    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.

    +

    Optional login_hint

    login_hint?: string

    The user's email address or other identifier. When your app knows which user is trying to authenticate, you can provide this parameter to pre-fill the email box or select the right session for sign-in.

    This currently only affects the classic Lock experience.

    -

    Optional max_age

    max_age?: string | number

    Maximum allowable elapsed time (in seconds) since authentication. +

    Optional max_age

    max_age?: string | number

    Maximum allowable elapsed time (in seconds) since authentication. If the last time the user authenticated is greater than this value, the user must be reauthenticated.

    -

    Optional organization

    organization?: string

    The organization to log in to.

    +

    Optional organization

    organization?: string

    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.
      • @@ -41,25 +41,25 @@ To use an Organization Name you must have "Allow Organization Names in Authentication API" switched on in your Auth0 settings dashboard. More information is available on the Auth0 documentation portal
    -

    Optional prompt

    prompt?: "none" | "login" | "consent" | "select_account"
      +

    Optional prompt

    prompt?: "none" | "login" | "consent" | "select_account"
    • 'none': do not prompt user for login or consent on reauthentication
    • 'login': prompt user for reauthentication
    • 'consent': prompt user for consent before processing request
    • 'select_account': prompt user to select an account
    -

    Optional redirect_uri

    redirect_uri?: string

    The default URL where Auth0 will redirect your browser to with +

    Optional redirect_uri

    redirect_uri?: string

    The default URL where Auth0 will redirect your browser to with the authentication result. It must be whitelisted in the "Allowed Callback URLs" field in your Auth0 Application's settings. If not provided here, it should be provided in the other methods that provide authentication.

    -

    Optional scope

    scope?: string

    The default scope to be used on authentication requests.

    +

    Optional scope

    scope?: string

    The default scope to be used on authentication requests.

    This defaults to profile email if not set. If you are setting extra scopes and require profile and email to be included then you must include them in the provided scope.

    Note: The openid scope is always applied regardless of this setting.

    -

    Optional screen_hint

    screen_hint?: string

    Provides a hint to Auth0 as to what flow should be displayed. +

    Optional screen_hint

    screen_hint?: string

    Provides a hint to Auth0 as to what flow should be displayed. The default behavior is to show a login page but you can override this by passing 'signup' to show the signup page instead.

    This only affects the New Universal Login Experience.

    -

    Optional ui_locales

    ui_locales?: string

    The space-separated list of language tags, ordered by preference. +

    Optional ui_locales

    ui_locales?: string

    The space-separated list of language tags, ordered by preference. For example: 'fr-CA fr en'.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/ClientAuthorizationParams.html b/docs/interfaces/ClientAuthorizationParams.html index f63e919ef..10e07e543 100644 --- a/docs/interfaces/ClientAuthorizationParams.html +++ b/docs/interfaces/ClientAuthorizationParams.html @@ -1,2 +1,2 @@ -ClientAuthorizationParams | @auth0/auth0-spa-js

    Interface ClientAuthorizationParams

    interface ClientAuthorizationParams {
        scope?: string | Record<string, string>;
    }

    Hierarchy

    Properties

    scope? -

    Properties

    Optional scope

    scope?: string | Record<string, string>

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +ClientAuthorizationParams | @auth0/auth0-spa-js

    Interface ClientAuthorizationParams

    interface ClientAuthorizationParams {
        scope?: string | Record<string, string>;
    }

    Hierarchy

    Properties

    scope? +

    Properties

    Optional scope

    scope?: string | Record<string, string>

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/DecodedToken.html b/docs/interfaces/DecodedToken.html index 12d677368..7f3d236a9 100644 --- a/docs/interfaces/DecodedToken.html +++ b/docs/interfaces/DecodedToken.html @@ -1,3 +1,3 @@ -DecodedToken | @auth0/auth0-spa-js

    Interface DecodedToken

    interface DecodedToken {
        claims: IdToken;
        user: User;
    }

    Properties

    claims +DecodedToken | @auth0/auth0-spa-js

    Interface DecodedToken

    interface DecodedToken {
        claims: IdToken;
        user: User;
    }

    Properties

    claims user -

    Properties

    claims

    claims: IdToken

    user

    user: User

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    claims

    claims: IdToken

    user

    user: User

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 8931c536c..914bf419f 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -1,4 +1,4 @@ -GetTokenSilentlyOptions | @auth0/auth0-spa-js

    Interface GetTokenSilentlyOptions

    interface GetTokenSilentlyOptions {
        authorizationParams?: {
            audience?: string;
            redirect_uri?: string;
            scope?: string;
            [key: string]: any;
        };
        cacheMode?: "cache-only" | "on" | "off";
        detailedResponse?: boolean;
        timeoutInSeconds?: number;
    }

    Properties

    authorizationParams? +GetTokenSilentlyOptions | @auth0/auth0-spa-js

    Interface GetTokenSilentlyOptions

    interface GetTokenSilentlyOptions {
        authorizationParams?: {
            audience?: string;
            redirect_uri?: string;
            scope?: string;
            [key: string]: any;
        };
        cacheMode?: "cache-only" | "on" | "off";
        detailedResponse?: boolean;
        timeoutInSeconds?: number;
    }

    Properties

    authorizationParams? cacheMode? detailedResponse? timeoutInSeconds? @@ -13,13 +13,13 @@ It must be whitelisted in the "Allowed Web Origins" in your Auth0 Application's settings.

  • Optional scope?: string

    The scope that was used in the authentication request

    -

    • Optional cacheMode

    cacheMode?: "cache-only" | "on" | "off"

    When off, ignores the cache and always sends a +

    Optional cacheMode

    cacheMode?: "cache-only" | "on" | "off"

    When off, ignores the cache and always sends a request to Auth0. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

    -

    Optional detailedResponse

    detailedResponse?: boolean

    If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned +

    Optional detailedResponse

    detailedResponse?: boolean

    If true, the full response from the /oauth/token endpoint (or the cache, if the cache was used) is returned (minus refresh_token if one was issued). Otherwise, just the access token is returned.

    The default is false.

    -

    Optional timeoutInSeconds

    timeoutInSeconds?: number

    A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout +

    Optional timeoutInSeconds

    timeoutInSeconds?: number

    A maximum number of seconds to wait before declaring the background /authorize call as failed for timeout Defaults to 60s.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 9b620dd0a..d3ff8d284 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -1,8 +1,8 @@ -GetTokenWithPopupOptions | @auth0/auth0-spa-js

    Interface GetTokenWithPopupOptions

    interface GetTokenWithPopupOptions {
        authorizationParams?: AuthorizationParams;
        cacheMode?: "cache-only" | "on" | "off";
    }

    Hierarchy (view full)

    Properties

    authorizationParams? +GetTokenWithPopupOptions | @auth0/auth0-spa-js

    Interface GetTokenWithPopupOptions

    interface GetTokenWithPopupOptions {
        authorizationParams?: AuthorizationParams;
        cacheMode?: "cache-only" | "on" | "off";
    }

    Hierarchy (view full)

    Properties

    authorizationParams? cacheMode?

    Properties

    Optional authorizationParams

    authorizationParams?: AuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

    -

    Optional cacheMode

    cacheMode?: "cache-only" | "on" | "off"

    When off, ignores the cache and always sends a request to Auth0. +

    Optional cacheMode

    cacheMode?: "cache-only" | "on" | "off"

    When off, ignores the cache and always sends a request to Auth0. When cache-only, only reads from the cache and never sends a request to Auth0. Defaults to on, where it both reads from the cache and sends a request to Auth0 as needed.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 8ed9a7910..af298edfe 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -1,5 +1,5 @@ -ICache | @auth0/auth0-spa-js

    Interface ICache

    interface ICache {
        allKeys?(): MaybePromise<string[]>;
        get<T>(key): MaybePromise<undefined | T>;
        remove(key): MaybePromise<void>;
        set<T>(key, entry): MaybePromise<void>;
    }

    Implemented by

    Methods

    allKeys? +ICache | @auth0/auth0-spa-js

    Interface ICache

    interface ICache {
        allKeys?(): MaybePromise<string[]>;
        get<T>(key): MaybePromise<undefined | T>;
        remove(key): MaybePromise<void>;
        set<T>(key, entry): MaybePromise<void>;
    }

    Implemented by

    Methods

    allKeys? get remove set -

    Methods

    Optional allKeys

    get

    remove

    set

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Methods

    Optional allKeys

    get

    remove

    set

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index 69b177715..e1966bb54 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -1,4 +1,4 @@ -IdToken | @auth0/auth0-spa-js

    Interface IdToken

    interface IdToken {
        __raw: string;
        acr?: string;
        address?: string;
        amr?: string[];
        at_hash?: string;
        aud?: string;
        auth_time?: string;
        azp?: string;
        birthdate?: string;
        c_hash?: string;
        cnf?: string;
        email?: string;
        email_verified?: boolean;
        exp?: number;
        family_name?: string;
        gender?: string;
        given_name?: string;
        iat?: number;
        iss?: string;
        jti?: string;
        locale?: string;
        middle_name?: string;
        name?: string;
        nbf?: number;
        nickname?: string;
        nonce?: string;
        org_id?: string;
        org_name?: string;
        phone_number?: string;
        phone_number_verified?: boolean;
        picture?: string;
        preferred_username?: string;
        profile?: string;
        sid?: string;
        sub_jwk?: string;
        updated_at?: string;
        website?: string;
        zoneinfo?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    __raw +IdToken | @auth0/auth0-spa-js

    Interface IdToken

    interface IdToken {
        __raw: string;
        acr?: string;
        address?: string;
        amr?: string[];
        at_hash?: string;
        aud?: string;
        auth_time?: string;
        azp?: string;
        birthdate?: string;
        c_hash?: string;
        cnf?: string;
        email?: string;
        email_verified?: boolean;
        exp?: number;
        family_name?: string;
        gender?: string;
        given_name?: string;
        iat?: number;
        iss?: string;
        jti?: string;
        locale?: string;
        middle_name?: string;
        name?: string;
        nbf?: number;
        nickname?: string;
        nonce?: string;
        org_id?: string;
        org_name?: string;
        phone_number?: string;
        phone_number_verified?: boolean;
        picture?: string;
        preferred_username?: string;
        profile?: string;
        sid?: string;
        sub_jwk?: string;
        updated_at?: string;
        website?: string;
        zoneinfo?: string;
        [key: string]: any;
    }

    Indexable

    [key: string]: any

    Properties

    __raw acr? address? amr? @@ -36,4 +36,4 @@ updated_at? website? zoneinfo? -

    Properties

    __raw

    __raw: string

    Optional acr

    acr?: string

    Optional address

    address?: string

    Optional amr

    amr?: string[]

    Optional at_hash

    at_hash?: string

    Optional aud

    aud?: string

    Optional auth_time

    auth_time?: string

    Optional azp

    azp?: string

    Optional birthdate

    birthdate?: string

    Optional c_hash

    c_hash?: string

    Optional cnf

    cnf?: string

    Optional email

    email?: string

    Optional email_verified

    email_verified?: boolean

    Optional exp

    exp?: number

    Optional family_name

    family_name?: string

    Optional gender

    gender?: string

    Optional given_name

    given_name?: string

    Optional iat

    iat?: number

    Optional iss

    iss?: string

    Optional jti

    jti?: string

    Optional locale

    locale?: string

    Optional middle_name

    middle_name?: string

    Optional name

    name?: string

    Optional nbf

    nbf?: number

    Optional nickname

    nickname?: string

    Optional nonce

    nonce?: string

    Optional org_id

    org_id?: string

    Optional org_name

    org_name?: string

    Optional phone_number

    phone_number?: string

    Optional phone_number_verified

    phone_number_verified?: boolean

    Optional picture

    picture?: string

    Optional preferred_username

    preferred_username?: string

    Optional profile

    profile?: string

    Optional sid

    sid?: string

    Optional sub_jwk

    sub_jwk?: string

    Optional updated_at

    updated_at?: string

    Optional website

    website?: string

    Optional zoneinfo

    zoneinfo?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Properties

    __raw

    __raw: string

    Optional acr

    acr?: string

    Optional address

    address?: string

    Optional amr

    amr?: string[]

    Optional at_hash

    at_hash?: string

    Optional aud

    aud?: string

    Optional auth_time

    auth_time?: string

    Optional azp

    azp?: string

    Optional birthdate

    birthdate?: string

    Optional c_hash

    c_hash?: string

    Optional cnf

    cnf?: string

    Optional email

    email?: string

    Optional email_verified

    email_verified?: boolean

    Optional exp

    exp?: number

    Optional family_name

    family_name?: string

    Optional gender

    gender?: string

    Optional given_name

    given_name?: string

    Optional iat

    iat?: number

    Optional iss

    iss?: string

    Optional jti

    jti?: string

    Optional locale

    locale?: string

    Optional middle_name

    middle_name?: string

    Optional name

    name?: string

    Optional nbf

    nbf?: number

    Optional nickname

    nickname?: string

    Optional nonce

    nonce?: string

    Optional org_id

    org_id?: string

    Optional org_name

    org_name?: string

    Optional phone_number

    phone_number?: string

    Optional phone_number_verified

    phone_number_verified?: boolean

    Optional picture

    picture?: string

    Optional preferred_username

    preferred_username?: string

    Optional profile

    profile?: string

    Optional sid

    sid?: string

    Optional sub_jwk

    sub_jwk?: string

    Optional updated_at

    updated_at?: string

    Optional website

    website?: string

    Optional zoneinfo

    zoneinfo?: string

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 1a157176c..ede58f6f7 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -1,4 +1,4 @@ -LogoutOptions | @auth0/auth0-spa-js

    Interface LogoutOptions

    interface LogoutOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
        onRedirect?: ((url) => Promise<void>);
        openUrl?: false | ((url) => void | Promise<void>);
    }

    Hierarchy (view full)

    Properties

    clientId? +LogoutOptions | @auth0/auth0-spa-js

    Interface LogoutOptions

    interface LogoutOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
        onRedirect?: ((url) => Promise<void>);
        openUrl?: false | ((url) => void | Promise<void>);
    }

    Hierarchy (view full)

    Properties

    clientId? logoutParams? onRedirect? openUrl? @@ -6,7 +6,7 @@

    If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

    If this property is set to null, then no client ID value is sent to the logout endpoint.

    Read more about how redirecting after logout works

    -

    Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }

    Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

    Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }

    Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

    Type declaration

    • [key: string]: any

      If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

    • Optional federated?: boolean

      When supported by the upstream identity provider, @@ -21,7 +21,7 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

      Read more about how redirecting after logout works

      -

    Optional onRedirect

    onRedirect?: ((url) => Promise<void>)

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

    +

    Optional onRedirect

    onRedirect?: ((url) => Promise<void>)

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

    Type declaration

      • (url): Promise<void>

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

        Parameters

        • url: string

        Returns Promise<void>

        Example

        await auth0.logout({
          async onRedirect(url) {
            window.location.replace(url);
          }
        });
        @@ -29,10 +29,10 @@

        Deprecated

        since v2.0.1, use openUrl instead.

    Example

    await auth0.logout({
      async onRedirect(url) {
        window.location.replace(url);
      }
    });

    Deprecated

    since v2.0.1, use openUrl instead.

    -

    Optional openUrl

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

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

    +

    Optional openUrl

    openUrl?: false | ((url) => 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.

    Type declaration

      • (url): void | Promise<void>

      • Parameters

        • url: string

        Returns void | Promise<void>

    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 });
      }
    });
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 9561e6583..f1c98a9f6 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -1,10 +1,10 @@ -LogoutUrlOptions | @auth0/auth0-spa-js

    Interface LogoutUrlOptions

    interface LogoutUrlOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
    }

    Hierarchy (view full)

    Properties

    clientId? +LogoutUrlOptions | @auth0/auth0-spa-js

    Interface LogoutUrlOptions

    interface LogoutUrlOptions {
        clientId?: null | string;
        logoutParams?: {
            federated?: boolean;
            returnTo?: string;
            [key: string]: any;
        };
    }

    Hierarchy (view full)

    Properties

    clientId? logoutParams?

    Properties

    Optional clientId

    clientId?: null | string

    The clientId of your application.

    If this property is not set, then the clientId that was used during initialization of the SDK is sent to the logout endpoint.

    If this property is set to null, then no client ID value is sent to the logout endpoint.

    Read more about how redirecting after logout works

    -

    Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }

    Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters +

    Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }

    Parameters to pass to the logout endpoint. This can be known parameters defined by Auth0 or custom parameters you wish to provide.

    Type declaration

    • [key: string]: any

      If you need to send custom parameters to the logout endpoint, make sure to use the original parameter name.

    • Optional federated?: boolean

      When supported by the upstream identity provider, @@ -19,4 +19,4 @@ returnTo URL must be listed in the "Allowed Logout URLs" at the account level in the Auth0 dashboard.

      Read more about how redirecting after logout works

      -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index cad2bccca..399e10d3f 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -1,8 +1,8 @@ -PopupConfigOptions | @auth0/auth0-spa-js

    Interface PopupConfigOptions

    interface PopupConfigOptions {
        popup?: any;
        timeoutInSeconds?: number;
    }

    Properties

    popup? +PopupConfigOptions | @auth0/auth0-spa-js

    Interface PopupConfigOptions

    interface PopupConfigOptions {
        popup?: any;
        timeoutInSeconds?: number;
    }

    Properties

    popup? timeoutInSeconds?

    Properties

    Optional popup

    popup?: any

    Accepts an already-created popup window to use. If not specified, the SDK will create its own. This may be useful for platforms like iOS that have security restrictions around when popups can be invoked (e.g. from a user click event)

    -

    Optional timeoutInSeconds

    timeoutInSeconds?: number

    The number of seconds to wait for a popup response before +

    Optional timeoutInSeconds

    timeoutInSeconds?: number

    The number of seconds to wait for a popup response before throwing a timeout error. Defaults to 60s

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 90681dcb8..a14570ece 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -1,4 +1,4 @@ -PopupLoginOptions | @auth0/auth0-spa-js

    Interface PopupLoginOptions

    interface PopupLoginOptions {
        authorizationParams?: AuthorizationParams;
    }

    Hierarchy (view full)

    Properties

    authorizationParams? +PopupLoginOptions | @auth0/auth0-spa-js

    Interface PopupLoginOptions

    interface PopupLoginOptions {
        authorizationParams?: AuthorizationParams;
    }

    Hierarchy (view full)

    Properties

    authorizationParams?

    Properties

    Optional authorizationParams

    authorizationParams?: AuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/RedirectConnectAccountOptions.html b/docs/interfaces/RedirectConnectAccountOptions.html index ad37c3f00..514c5fd26 100644 --- a/docs/interfaces/RedirectConnectAccountOptions.html +++ b/docs/interfaces/RedirectConnectAccountOptions.html @@ -1,4 +1,4 @@ -RedirectConnectAccountOptions | @auth0/auth0-spa-js

    Interface RedirectConnectAccountOptions<TAppState>

    interface RedirectConnectAccountOptions<TAppState> {
        appState?: TAppState;
        authorization_params?: AuthorizationParams;
        connection: string;
        openUrl?: ((url) => Promise<void>);
        redirectUri?: string;
        scopes?: string[];
    }

    Type Parameters

    • TAppState = any

    Properties

    appState? +RedirectConnectAccountOptions | @auth0/auth0-spa-js

    Interface RedirectConnectAccountOptions<TAppState>

    interface RedirectConnectAccountOptions<TAppState> {
        appState?: TAppState;
        authorization_params?: AuthorizationParams;
        connection: string;
        openUrl?: ((url) => Promise<void>);
        redirectUri?: string;
        scopes?: string[];
    }

    Type Parameters

    • TAppState = any

    Properties

    appState? authorization_params? connection openUrl? @@ -7,18 +7,18 @@

    Properties

    Optional appState

    appState?: TAppState

    Optional application state to persist through the transaction.

    Example

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      appState: { returnTo: '/settings' }
    });
    -

    Optional authorization_params

    authorization_params?: AuthorizationParams

    Additional authorization parameters for the request.

    +

    Optional authorization_params

    authorization_params?: AuthorizationParams

    Additional authorization parameters for the request.

    Example

    await auth0.connectAccountWithRedirect({
      connection: 'github',
      authorization_params: {
        audience: 'https://api.github.com'
      }
    });
    -

    connection

    connection: string

    The name of the connection to link (e.g. 'google-oauth2').

    -

    Optional openUrl

    openUrl?: ((url) => Promise<void>)

    Optional function to handle the redirect URL.

    +

    connection

    connection: string

    The name of the connection to link (e.g. 'google-oauth2').

    +

    Optional openUrl

    openUrl?: ((url) => Promise<void>)

    Optional function to handle the redirect URL.

    Type declaration

      • (url): Promise<void>

      • Optional function to handle the redirect URL.

        Parameters

        • url: string

        Returns Promise<void>

        Example

        await auth0.connectAccountWithRedirect({
          connection: 'google-oauth2',
          openUrl: async (url) => { myBrowserApi.open(url); }
        });

    Example

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      openUrl: async (url) => { myBrowserApi.open(url); }
    });
    -

    Optional redirectUri

    redirectUri?: string

    The URI to redirect back to after connecting the account.

    -

    Optional scopes

    scopes?: string[]

    Array of scopes to request from the Identity Provider during the connect account flow.

    +

    Optional redirectUri

    redirectUri?: string

    The URI to redirect back to after connecting the account.

    +

    Optional scopes

    scopes?: string[]

    Array of scopes to request from the Identity Provider during the connect account flow.

    Example

    await auth0.connectAccountWithRedirect({
      connection: 'google-oauth2',
      scopes: ['https://www.googleapis.com/auth/calendar']
    });
    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index fc02e4c25..ee3f12d18 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -1,13 +1,13 @@ -RedirectLoginOptions | @auth0/auth0-spa-js

    Interface RedirectLoginOptions<TAppState>

    interface RedirectLoginOptions<TAppState> {
        appState?: TAppState;
        authorizationParams?: AuthorizationParams;
        fragment?: string;
        onRedirect?: ((url) => Promise<void>);
        openUrl?: ((url) => void | Promise<void>);
    }

    Type Parameters

    • TAppState = any

    Hierarchy

    • BaseLoginOptions
      • RedirectLoginOptions

    Properties

    appState? +RedirectLoginOptions | @auth0/auth0-spa-js

    Interface RedirectLoginOptions<TAppState>

    interface RedirectLoginOptions<TAppState> {
        appState?: TAppState;
        authorizationParams?: AuthorizationParams;
        fragment?: string;
        onRedirect?: ((url) => Promise<void>);
        openUrl?: ((url) => void | Promise<void>);
    }

    Type Parameters

    • TAppState = any

    Hierarchy

    • BaseLoginOptions
      • RedirectLoginOptions

    Properties

    appState? authorizationParams? fragment? onRedirect? openUrl?

    Properties

    Optional appState

    appState?: TAppState

    Used to store state before doing the redirect

    -

    Optional authorizationParams

    authorizationParams?: AuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters +

    Optional authorizationParams

    authorizationParams?: AuthorizationParams

    URL parameters that will be sent back to the Authorization Server. This can be known parameters defined by Auth0 or custom parameters that you define.

    -

    Optional fragment

    fragment?: string

    Used to add to the URL fragment before redirecting

    -

    Optional onRedirect

    onRedirect?: ((url) => Promise<void>)

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

    +

    Optional fragment

    fragment?: string

    Used to add to the URL fragment before redirecting

    +

    Optional onRedirect

    onRedirect?: ((url) => Promise<void>)

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

    Type declaration

      • (url): Promise<void>

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

        Parameters

        • url: string

        Returns Promise<void>

        Example

        const client = new Auth0Client({
          async onRedirect(url) {
            window.location.replace(url);
          }
        });
        @@ -15,7 +15,7 @@

        Deprecated

        since v2.0.1, use openUrl instead.

    Example

    const client = new Auth0Client({
      async onRedirect(url) {
        window.location.replace(url);
      }
    });

    Deprecated

    since v2.0.1, use openUrl instead.

    -

    Optional openUrl

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

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

    +

    Optional openUrl

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

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

    Type declaration

      • (url): void | Promise<void>

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

        Parameters

        • url: string

        Returns void | Promise<void>

        Example

        const client = new Auth0Client({
          openUrl(url) {
            window.location.replace(url);
          }
        });
        @@ -25,4 +25,4 @@

        Example

        import<

        Example

        import { Browser } from '@capacitor/browser';

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
        -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/interfaces/RedirectLoginResult.html b/docs/interfaces/RedirectLoginResult.html index 18ca8fa29..2bf32d8d3 100644 --- a/docs/interfaces/RedirectLoginResult.html +++ b/docs/interfaces/RedirectLoginResult.html @@ -1,5 +1,5 @@ -RedirectLoginResult | @auth0/auth0-spa-js

    Interface RedirectLoginResult<TAppState>

    interface RedirectLoginResult<TAppState> {
        appState?: TAppState;
        response_type: Code;
    }

    Type Parameters

    • TAppState = any

    Properties

    appState? +RedirectLoginResult | @auth0/auth0-spa-js

    Interface RedirectLoginResult<TAppState>

    interface RedirectLoginResult<TAppState> {
        appState?: TAppState;
        response_type: Code;
    }

    Type Parameters

    • TAppState = any

    Properties

    appState? response_type

    Properties

    Optional appState

    appState?: TAppState

    State stored when the redirect request was made

    -

    response_type

    response_type: Code

    The type of response, for login it will be code

    -

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file +

    response_type

    response_type: Code

    The type of response, for login it will be code

    +

    Settings

    Member Visibility

    Theme

    On This Page

    \ No newline at end of file diff --git a/docs/types/CacheEntry.html b/docs/types/CacheEntry.html index 80e65c5a7..c697c03ee 100644 --- a/docs/types/CacheEntry.html +++ b/docs/types/CacheEntry.html @@ -1 +1 @@ -CacheEntry | @auth0/auth0-spa-js

    Type alias CacheEntry

    CacheEntry: {
        access_token: string;
        audience: string;
        client_id: string;
        decodedToken?: DecodedToken;
        expires_in: number;
        id_token?: string;
        oauthTokenScope?: string;
        refresh_token?: string;
        scope: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • audience: string
    • client_id: string
    • Optional decodedToken?: DecodedToken
    • expires_in: number
    • Optional id_token?: string
    • Optional oauthTokenScope?: string
    • Optional refresh_token?: string
    • scope: string
    • Optional token_type?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CacheEntry | @auth0/auth0-spa-js

    Type alias CacheEntry

    CacheEntry: {
        access_token: string;
        audience: string;
        client_id: string;
        decodedToken?: DecodedToken;
        expires_in: number;
        id_token?: string;
        oauthTokenScope?: string;
        refresh_token?: string;
        scope: string;
        token_type?: string;
    }

    Type declaration

    • access_token: string
    • audience: string
    • client_id: string
    • Optional decodedToken?: DecodedToken
    • expires_in: number
    • Optional id_token?: string
    • Optional oauthTokenScope?: string
    • Optional refresh_token?: string
    • scope: string
    • Optional token_type?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/CacheKeyData.html b/docs/types/CacheKeyData.html index 9eb2e2e90..3ce40ecf5 100644 --- a/docs/types/CacheKeyData.html +++ b/docs/types/CacheKeyData.html @@ -1 +1 @@ -CacheKeyData | @auth0/auth0-spa-js

    Type alias CacheKeyData

    CacheKeyData: {
        audience?: string;
        clientId: string;
        scope?: string;
    }

    Type declaration

    • Optional audience?: string
    • clientId: string
    • Optional scope?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CacheKeyData | @auth0/auth0-spa-js

    Type alias CacheKeyData

    CacheKeyData: {
        audience?: string;
        clientId: string;
        scope?: string;
    }

    Type declaration

    • Optional audience?: string
    • clientId: string
    • Optional scope?: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 259ef9845..f07402b81 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -1,2 +1,2 @@ CacheLocation | @auth0/auth0-spa-js

    Type alias CacheLocation

    CacheLocation: "memory" | "localstorage"

    The possible locations where tokens can be stored

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index a63869022..502218664 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -1 +1 @@ -Cacheable | @auth0/auth0-spa-js

    Type alias Cacheable

    Cacheable: WrappedCacheEntry | KeyManifestEntry

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +Cacheable | @auth0/auth0-spa-js

    Type alias Cacheable

    Cacheable: WrappedCacheEntry | KeyManifestEntry

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/ConnectAccountRedirectResult.html b/docs/types/ConnectAccountRedirectResult.html index 49376ba54..60d131deb 100644 --- a/docs/types/ConnectAccountRedirectResult.html +++ b/docs/types/ConnectAccountRedirectResult.html @@ -6,4 +6,4 @@
  • response_type: ConnectCode

    The type of response, for connect account it will be connect_code

    • Example

    const result = await auth0.connectAccountWithRedirect(options);
    console.log(result.appState); // Access persisted app state
    console.log(result.connection);   // The connection of the account you connected to.
    console.log(result.response_type === 'connect_code');   // The response type will be 'connect_code'
    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/CustomFetchMinimalOutput.html b/docs/types/CustomFetchMinimalOutput.html index f26ce9649..13ebfc787 100644 --- a/docs/types/CustomFetchMinimalOutput.html +++ b/docs/types/CustomFetchMinimalOutput.html @@ -1 +1 @@ -CustomFetchMinimalOutput | @auth0/auth0-spa-js

    Type alias CustomFetchMinimalOutput

    CustomFetchMinimalOutput: {
        headers: ResponseHeaders;
        status: number;
    }

    Type declaration

    • headers: ResponseHeaders
    • status: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CustomFetchMinimalOutput | @auth0/auth0-spa-js

    Type alias CustomFetchMinimalOutput

    CustomFetchMinimalOutput: {
        headers: ResponseHeaders;
        status: number;
    }

    Type declaration

    • headers: ResponseHeaders
    • status: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/docs/types/CustomTokenExchangeOptions.html b/docs/types/CustomTokenExchangeOptions.html index 740da6096..facc8c859 100644 --- a/docs/types/CustomTokenExchangeOptions.html +++ b/docs/types/CustomTokenExchangeOptions.html @@ -37,4 +37,4 @@

    Example

    "eyJhbGci
 
    Example
    "urn:acme:legacy-system-token"
    "https://api.yourcompany.com/token-type/v1"
 
    
 
    See
    RFC 8693: OAuth 2.0 Token Exchange
    
-
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/FetcherConfig.html b/docs/types/FetcherConfig.html
index fff3edfb8..7ca47c103 100644
--- a/docs/types/FetcherConfig.html
+++ b/docs/types/FetcherConfig.html
@@ -1 +1 @@
-FetcherConfig | @auth0/auth0-spa-js
    Type alias FetcherConfig<TOutput>
    FetcherConfig<TOutput>: { 
        baseUrl?: string; 
        dpopNonceId?: string; 
        fetch?: CustomFetchImpl<TOutput>; 
        getAccessToken?: AccessTokenFactory; 
    }
    Type Parameters
    Type declaration
    • Optional baseUrl?: string
    • Optional dpopNonceId?: string
    • Optional fetch?: CustomFetchImpl<TOutput>
    • Optional getAccessToken?: AccessTokenFactory
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+FetcherConfig | @auth0/auth0-spa-js
    Type alias FetcherConfig<TOutput>
    FetcherConfig<TOutput>: { 
        baseUrl?: string; 
        dpopNonceId?: string; 
        fetch?: CustomFetchImpl<TOutput>; 
        getAccessToken?: AccessTokenFactory; 
    }
    Type Parameters
    Type declaration
    • Optional baseUrl?: string
    • Optional dpopNonceId?: string
    • Optional fetch?: CustomFetchImpl<TOutput>
    • Optional getAccessToken?: AccessTokenFactory
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/GetTokenSilentlyVerboseResponse.html b/docs/types/GetTokenSilentlyVerboseResponse.html
index 219ce7010..2791ae223 100644
--- a/docs/types/GetTokenSilentlyVerboseResponse.html
+++ b/docs/types/GetTokenSilentlyVerboseResponse.html
@@ -1 +1 @@
-GetTokenSilentlyVerboseResponse | @auth0/auth0-spa-js
    Type alias GetTokenSilentlyVerboseResponse
    GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+GetTokenSilentlyVerboseResponse | @auth0/auth0-spa-js
    Type alias GetTokenSilentlyVerboseResponse
    GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/KeyManifestEntry.html b/docs/types/KeyManifestEntry.html
index 6263fb6fa..c11e22e52 100644
--- a/docs/types/KeyManifestEntry.html
+++ b/docs/types/KeyManifestEntry.html
@@ -1 +1 @@
-KeyManifestEntry | @auth0/auth0-spa-js
    Type alias KeyManifestEntry
    KeyManifestEntry: { 
        keys: string[]; 
    }
    Type declaration
    • keys: string[]
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+KeyManifestEntry | @auth0/auth0-spa-js
    Type alias KeyManifestEntry
    KeyManifestEntry: { 
        keys: string[]; 
    }
    Type declaration
    • keys: string[]
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/MaybePromise.html b/docs/types/MaybePromise.html
index e5dd69119..f18a6cd8b 100644
--- a/docs/types/MaybePromise.html
+++ b/docs/types/MaybePromise.html
@@ -1 +1 @@
-MaybePromise | @auth0/auth0-spa-js
    Type alias MaybePromise<T>
    MaybePromise<T>: Promise<T> | T
    Type Parameters
    • T
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+MaybePromise | @auth0/auth0-spa-js
    Type alias MaybePromise<T>
    MaybePromise<T>: Promise<T> | T
    Type Parameters
    • T
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html
index 4a81a0463..95242b766 100644
--- a/docs/types/TokenEndpointResponse.html
+++ b/docs/types/TokenEndpointResponse.html
@@ -1 +1 @@
-TokenEndpointResponse | @auth0/auth0-spa-js
    Type alias TokenEndpointResponse
    TokenEndpointResponse: { 
        access_token: string; 
        expires_in: number; 
        id_token: string; 
        refresh_token?: string; 
        scope?: string; 
        token_type: string; 
    }
    Type declaration
    • access_token: string
    • expires_in: number
    • id_token: string
    • Optional refresh_token?: string
    • Optional scope?: string
    • token_type: string
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+TokenEndpointResponse | @auth0/auth0-spa-js
    Type alias TokenEndpointResponse
    TokenEndpointResponse: { 
        access_token: string; 
        expires_in: number; 
        id_token: string; 
        refresh_token?: string; 
        scope?: string; 
        token_type: string; 
    }
    Type declaration
    • access_token: string
    • expires_in: number
    • id_token: string
    • Optional refresh_token?: string
    • Optional scope?: string
    • token_type: string
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/docs/types/WrappedCacheEntry.html b/docs/types/WrappedCacheEntry.html
index 01042c49f..dfb33af23 100644
--- a/docs/types/WrappedCacheEntry.html
+++ b/docs/types/WrappedCacheEntry.html
@@ -1 +1 @@
-WrappedCacheEntry | @auth0/auth0-spa-js
    Type alias WrappedCacheEntry
    WrappedCacheEntry: { 
        body: Partial<CacheEntry>; 
        expiresAt: number; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
+WrappedCacheEntry | @auth0/auth0-spa-js
    Type alias WrappedCacheEntry
    WrappedCacheEntry: { 
        body: Partial<CacheEntry>; 
        expiresAt: number; 
    }
    Type declaration
    Settings
    Member Visibility
    Theme
    
\ No newline at end of file
diff --git a/package-lock.json b/package-lock.json
index d58f34d73..3b67b92a4 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
 {
   "name": "@auth0/auth0-spa-js",
-  "version": "2.11.0",
+  "version": "2.11.1",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "@auth0/auth0-spa-js",
-      "version": "2.11.0",
+      "version": "2.11.1",
       "license": "MIT",
       "dependencies": {
         "browser-tabs-lock": "^1.2.15",
diff --git a/package.json b/package.json
index 2a8b7ae7d..543c16a96 100644
--- a/package.json
+++ b/package.json
@@ -3,7 +3,7 @@
   "name": "@auth0/auth0-spa-js",
   "description": "Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE",
   "license": "MIT",
-  "version": "2.11.0",
+  "version": "2.11.1",
   "main": "dist/lib/auth0-spa-js.cjs.js",
   "types": "dist/typings/index.d.ts",
   "module": "dist/auth0-spa-js.production.esm.js",
diff --git a/src/version.ts b/src/version.ts
index 42fda4a19..ada3eeaeb 100644
--- a/src/version.ts
+++ b/src/version.ts
@@ -1 +1 @@
-export default '2.11.0';
+export default '2.11.1';

From 9feaff167fdcc9be8f5515f5ebb72b390d092c99 Mon Sep 17 00:00:00 2001
From: Yogesh Chaudhary 
Date: Wed, 7 Jan 2026 16:14:09 +0530
Subject: [PATCH 2/2] chore: update CHANGELOG category from Added to Fixed

---
 CHANGELOG.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index b7eb7eff6..dd70cd633 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,7 +3,7 @@
 ## [v2.11.1](https://github.com/auth0/auth0-spa-js/tree/v2.11.1) (2026-01-07)
 [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.11.0...v2.11.1)
 
-**Added**
+**Fixed**
 - fix: clear cache when different user logs in without logout [\#1456](https://github.com/auth0/auth0-spa-js/pull/1456) ([yogeshchoudhary147](https://github.com/yogeshchoudhary147))
 
 ## [v2.11.0](https://github.com/auth0/auth0-spa-js/tree/v2.11.0) (2025-12-11)