From c89fbb7b2ebd6069c83b6ce754a42baf81bfa6c3 Mon Sep 17 00:00:00 2001 From: Frederik Prijck Date: Wed, 19 Jul 2023 07:54:12 +0200 Subject: [PATCH] Release v2.1.1 (#1118) --- CHANGELOG.md | 6 ++ docs/classes/Auth0Client.html | 26 +++---- docs/classes/AuthenticationError.html | 14 ++-- docs/classes/CacheKey.html | 20 ++--- docs/classes/GenericError.html | 10 +-- docs/classes/InMemoryCache.html | 4 +- docs/classes/LocalStorageCache.html | 10 +-- docs/classes/MfaRequiredError.html | 12 +-- docs/classes/MissingRefreshTokenError.html | 14 ++-- docs/classes/PopupCancelledError.html | 12 +-- docs/classes/PopupTimeoutError.html | 12 +-- docs/classes/TimeoutError.html | 10 +-- docs/classes/User.html | 42 +++++----- docs/functions/createAuth0Client.html | 2 +- docs/index.html | 2 +- docs/interfaces/Auth0ClientOptions.html | 38 ++++----- docs/interfaces/AuthorizationParams.html | 30 +++---- docs/interfaces/DecodedToken.html | 6 +- docs/interfaces/GetTokenSilentlyOptions.html | 10 +-- docs/interfaces/GetTokenWithPopupOptions.html | 6 +- docs/interfaces/ICache.html | 10 +-- docs/interfaces/IdToken.html | 78 +++++++++---------- docs/interfaces/LogoutOptions.html | 10 +-- docs/interfaces/LogoutUrlOptions.html | 6 +- docs/interfaces/PopupConfigOptions.html | 6 +- docs/interfaces/PopupLoginOptions.html | 4 +- docs/interfaces/RedirectLoginOptions.html | 12 +-- docs/interfaces/RedirectLoginResult.html | 4 +- docs/types/CacheEntry.html | 2 +- docs/types/CacheKeyData.html | 2 +- docs/types/CacheLocation.html | 2 +- docs/types/Cacheable.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 +- 40 files changed, 224 insertions(+), 218 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f4ed0c81..5621fd78f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # Change Log +## [v2.1.1](https://github.com/auth0/auth0-spa-js/tree/v2.1.1) (2023-07-18) +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.1.0...v2.1.1) + +**Changed** +- Do not lowercase org_name claim [\#1117](https://github.com/auth0/auth0-spa-js/pull/1117) ([frederikprijck](https://github.com/frederikprijck)) + ## [v2.1.0](https://github.com/auth0/auth0-spa-js/tree/v2.1.0) (2023-07-13) [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.8...v2.1.0) diff --git a/docs/classes/Auth0Client.html b/docs/classes/Auth0Client.html index 540c3d4f6..ed349937a 100644 --- a/docs/classes/Auth0Client.html +++ b/docs/classes/Auth0Client.html @@ -23,7 +23,7 @@

Hierarchy

+
  • Defined in Auth0Client.ts:114
    • @@ -60,7 +60,7 @@

    Parameters

    options: Auth0ClientOptions

    Returns Auth0Client

    +
  • Defined in Auth0Client.ts:141

    • Methods

    @@ -92,7 +92,7 @@

    Parameters

    Optional options: GetTokenSilentlyOptions

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:565

    • getIdTokenClaims

    +
  • Defined in Auth0Client.ts:429

    • getTokenSilently

    Returns Promise<GetTokenSilentlyVerboseResponse>

    +
  • Defined in Auth0Client.ts:590

  • Fetches a new access token and returns it.

    @@ -131,7 +131,7 @@

    Parameters

    Optional options: GetTokenSilentlyOptions

    • Returns Promise<string>

    +
  • Defined in Auth0Client.ts:599

    • getTokenWithPopup

    Returns Promise<undefined | string>

    +
  • Defined in Auth0Client.ts:744

    • getUser

    Returns Promise<undefined | TUser>

    +
  • Defined in Auth0Client.ts:416

    • handleRedirectCallback

    Returns Promise<RedirectLoginResult<TAppState>>

    +
  • Defined in Auth0Client.ts:481

    • isAuthenticated

    +
  • Defined in Auth0Client.ts:784

    • loginWithPopup

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:349

    • loginWithRedirect

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:446

    • logout

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:829
    • diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index 8e84144f0..92ba36fc6 100644 --- a/docs/classes/AuthenticationError.html +++ b/docs/classes/AuthenticationError.html @@ -26,7 +26,7 @@

    Hierarchy

    • AuthenticationError
    +
  • Defined in errors.ts:25
    • @@ -68,31 +68,31 @@
    appState: anyReturns AuthenticationError
    +
  • Defined in errors.ts:26

    • Properties

    appState

    appState: any = null
    +
  • Defined in errors.ts:30

    • error

    error: string
    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • state

    state: string
    +
  • Defined in errors.ts:29

    • Methods

    @@ -113,7 +113,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/CacheKey.html b/docs/classes/CacheKey.html index a1a07c02a..49d10537e 100644 --- a/docs/classes/CacheKey.html +++ b/docs/classes/CacheKey.html @@ -20,7 +20,7 @@

    Hierarchy

    • CacheKey
    +
  • Defined in cache/shared.ts:12
    • @@ -62,34 +62,34 @@
    prefix: stringOptional suffix: string

    Returns CacheKey

    +
  • Defined in cache/shared.ts:17

    • Properties

    Optional audience

    audience?: string
    +
  • Defined in cache/shared.ts:15

    • clientId

    clientId: string
    +
  • Defined in cache/shared.ts:13

    • prefix

    prefix: string = CACHE_KEY_PREFIX
    +
  • Defined in cache/shared.ts:19

    • Optional scope

    scope?: string
    +
  • Defined in cache/shared.ts:14

    • Optional suffix

    suffix?: string
    +
  • Defined in cache/shared.ts:20

    • Methods

    @@ -103,7 +103,7 @@

    Returns

    A string representation of the key

    Returns string

    +
  • Defined in cache/shared.ts:31

    • Static fromCacheEntry

    Returns CacheKey

    +
  • Defined in cache/shared.ts:53

    • Static fromKey

    Returns CacheKey

    +
  • Defined in cache/shared.ts:42
    • diff --git a/docs/classes/GenericError.html b/docs/classes/GenericError.html index d27482fee..e7b01adc5 100644 --- a/docs/classes/GenericError.html +++ b/docs/classes/GenericError.html @@ -31,7 +31,7 @@

    Hierarchy

  • MfaRequiredError
  • MissingRefreshTokenError
    • +
  • Defined in errors.ts:4
    • @@ -67,19 +67,19 @@
    error_description: string
    <

    Returns GenericError

    +
  • Defined in errors.ts:5

    • Properties

    error

    error: string
    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • Methods

    @@ -99,7 +99,7 @@
    error: : string

    Returns GenericError

    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/InMemoryCache.html b/docs/classes/InMemoryCache.html index 89b7044ae..1c8a15f35 100644 --- a/docs/classes/InMemoryCache.html +++ b/docs/classes/InMemoryCache.html @@ -20,7 +20,7 @@

    Hierarchy

    • InMemoryCache
    +
  • Defined in cache/cache-memory.ts:3
    • @@ -48,7 +48,7 @@

    Properties

    enclosedCache

    enclosedCache: ICache = ...
    +
  • Defined in cache/cache-memory.ts:4
    • diff --git a/docs/classes/LocalStorageCache.html b/docs/classes/LocalStorageCache.html index c5c51e281..184d3343e 100644 --- a/docs/classes/LocalStorageCache.html +++ b/docs/classes/LocalStorageCache.html @@ -24,7 +24,7 @@

    Implements

    +
  • Defined in cache/cache-localstorage.ts:3
    • @@ -59,7 +59,7 @@

    allKeysReturns string[]

    +
  • Defined in cache/cache-localstorage.ts:26

    • get

      @@ -78,7 +78,7 @@
      key: string

    Returns MaybePromise<undefined | T>

    +
  • Defined in cache/cache-localstorage.ts:8

    • remove

      @@ -92,7 +92,7 @@
      key: string

    Returns void

    +
  • Defined in cache/cache-localstorage.ts:22

    • set

    +
  • Defined in cache/cache-localstorage.ts:4
    • diff --git a/docs/classes/MfaRequiredError.html b/docs/classes/MfaRequiredError.html index 08d29ddd8..ef4d360f7 100644 --- a/docs/classes/MfaRequiredError.html +++ b/docs/classes/MfaRequiredError.html @@ -25,7 +25,7 @@

    Hierarchy

    • MfaRequiredError
    +
  • Defined in errors.ts:72
    • @@ -64,7 +64,7 @@
    mfa_token: string
    Returns MfaRequiredError
    +
  • Defined in errors.ts:73

    • Properties

    @@ -72,18 +72,18 @@

    errorerror: string

    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • mfa_token

    mfa_token: string
    +
  • Defined in errors.ts:76

    • Methods

    @@ -104,7 +104,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/MissingRefreshTokenError.html b/docs/classes/MissingRefreshTokenError.html index 6e916fddb..ad2cfa5cd 100644 --- a/docs/classes/MissingRefreshTokenError.html +++ b/docs/classes/MissingRefreshTokenError.html @@ -25,7 +25,7 @@

    Hierarchy

    • MissingRefreshTokenError
    +
  • Defined in errors.ts:87
    • @@ -63,31 +63,31 @@
    scope: string

    Returns MissingRefreshTokenError

    +
  • Defined in errors.ts:88

    • Properties

    audience

    audience: string
    +
  • Defined in errors.ts:88

    • error

    error: string
    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • scope

    scope: string
    +
  • Defined in errors.ts:88

    • Methods

    @@ -108,7 +108,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/PopupCancelledError.html b/docs/classes/PopupCancelledError.html index 25df14a22..bcd0c3cb5 100644 --- a/docs/classes/PopupCancelledError.html +++ b/docs/classes/PopupCancelledError.html @@ -25,7 +25,7 @@

    Hierarchy

    • PopupCancelledError
    +
  • Defined in errors.ts:61
    • @@ -60,7 +60,7 @@
    popup: Window

    Returns PopupCancelledError

    +
  • Defined in errors.ts:62

    • Properties

    @@ -68,18 +68,18 @@

    errorerror: string

    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • popup

    popup: Window
    +
  • Defined in errors.ts:62

    • Methods

    @@ -100,7 +100,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/PopupTimeoutError.html b/docs/classes/PopupTimeoutError.html index b7529cca0..0aa9e0cad 100644 --- a/docs/classes/PopupTimeoutError.html +++ b/docs/classes/PopupTimeoutError.html @@ -25,7 +25,7 @@

    Hierarchy

    • PopupTimeoutError
    +
  • Defined in errors.ts:53
    • @@ -60,7 +60,7 @@
    popup: Window

    Returns PopupTimeoutError

    +
  • Defined in errors.ts:54

    • Properties

    @@ -68,18 +68,18 @@

    errorerror: string

    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • popup

    popup: Window
    +
  • Defined in errors.ts:54

    • Methods

    @@ -100,7 +100,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/TimeoutError.html b/docs/classes/TimeoutError.html index d163892c3..a4a969197 100644 --- a/docs/classes/TimeoutError.html +++ b/docs/classes/TimeoutError.html @@ -28,7 +28,7 @@

    Hierarchy

    +
  • Defined in errors.ts:42
    • @@ -57,7 +57,7 @@

    constructorReturns TimeoutError

    +
  • Defined in errors.ts:43

    • Properties

    @@ -65,13 +65,13 @@

    errorerror: string

    +
  • Defined in errors.ts:5

    • error_description

    error_description: string
    +
  • Defined in errors.ts:5

    • Methods

    @@ -92,7 +92,7 @@
    error_description: Returns GenericError
    +
  • Defined in errors.ts:10
    • diff --git a/docs/classes/User.html b/docs/classes/User.html index a1b678d64..45dcdfca3 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in global.ts:603
    • @@ -70,102 +70,102 @@

    Properties

    Optional address

    address?: string
    +
  • Defined in global.ts:621

    • Optional birthdate

    birthdate?: string
    +
  • Defined in global.ts:616

    • Optional email

    email?: string
    +
  • Defined in global.ts:613

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in global.ts:614

    • Optional family_name

    family_name?: string
    +
  • Defined in global.ts:606

    • Optional gender

    gender?: string
    +
  • Defined in global.ts:615

    • Optional given_name

    given_name?: string
    +
  • Defined in global.ts:605

    • Optional locale

    locale?: string
    +
  • Defined in global.ts:618

    • Optional middle_name

    middle_name?: string
    +
  • Defined in global.ts:607

    • Optional name

    name?: string
    +
  • Defined in global.ts:604

    • Optional nickname

    nickname?: string
    +
  • Defined in global.ts:608

    • Optional phone_number

    phone_number?: string
    +
  • Defined in global.ts:619

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in global.ts:620

    • Optional picture

    picture?: string
    +
  • Defined in global.ts:611

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in global.ts:609

    • Optional profile

    profile?: string
    +
  • Defined in global.ts:610

    • Optional sub

    sub?: string
    +
  • Defined in global.ts:623

    • Optional updated_at

    updated_at?: string
    +
  • Defined in global.ts:622

    • Optional website

    website?: string
    +
  • Defined in global.ts:612

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in global.ts:617
    • diff --git a/docs/functions/createAuth0Client.html b/docs/functions/createAuth0Client.html index 5ef826ef3..d43e91d92 100644 --- a/docs/functions/createAuth0Client.html +++ b/docs/functions/createAuth0Client.html @@ -34,7 +34,7 @@
    options: Returns Promise<Auth0Client>
    +
  • Defined in index.ts:17
    • diff --git a/docs/index.html b/docs/index.html index 1777c2012..6c0204a60 100644 --- a/docs/index.html +++ b/docs/index.html @@ -74,7 +74,7 @@

    Configure Auth0

    Configure the SDK

    Create an Auth0Client instance before rendering or initializing your application. You should only have one instance of the client.

    -
    import { createAuth0Client } from '@auth0/auth0-spa-js';

    //with async/await
    const auth0 = await createAuth0Client({
      domain: '<AUTH0_DOMAIN>',
      clientId: '<AUTH0_CLIENT_ID>',
      authorizationParams: {
        redirect_uri: '<MY_CALLBACK_URL>'
      }
    });

    //or, you can just instantiate the client on it's own
    import { Auth0Client } from '@auth0/auth0-spa-js';

    const auth0 = new Auth0Client({
      domain: '<AUTH0_DOMAIN>',
      clientId: '<AUTH0_CLIENT_ID>',
      authorizationParams: {
        redirect_uri: '<MY_CALLBACK_URL>'
      }
    });

    //if you do this, you'll need to check the session yourself
    try {
      await auth0.getTokenSilently();
    } catch (error) {
      if (error.error !== 'login_required') {
        throw error;
      }
    }
+
    import { createAuth0Client } from '@auth0/auth0-spa-js';

    //with async/await
    const auth0 = await createAuth0Client({
      domain: '<AUTH0_DOMAIN>',
      clientId: '<AUTH0_CLIENT_ID>',
      authorizationParams: {
        redirect_uri: '<MY_CALLBACK_URL>'
      }
    });

    //or, you can just instantiate the client on its own
    import { Auth0Client } from '@auth0/auth0-spa-js';

    const auth0 = new Auth0Client({
      domain: '<AUTH0_DOMAIN>',
      clientId: '<AUTH0_CLIENT_ID>',
      authorizationParams: {
        redirect_uri: '<MY_CALLBACK_URL>'
      }
    });

    //if you do this, you'll need to check the session yourself
    try {
      await auth0.getTokenSilently();
    } catch (error) {
      if (error.error !== 'login_required') {
        throw error;
      }
    }
 
    
 
 
diff --git a/docs/interfaces/Auth0ClientOptions.html b/docs/interfaces/Auth0ClientOptions.html
index 8517a192e..63be85c0c 100644
--- a/docs/interfaces/Auth0ClientOptions.html
+++ b/docs/interfaces/Auth0ClientOptions.html
@@ -22,7 +22,7 @@ 
    Hierarchy
    
 
      
 
    • Auth0ClientOptions
    
+
  • Defined in global.ts:120
    • 
 
    
 
    
 
    
@@ -69,7 +69,7 @@ 
    name: 
 
    version: string
    +
  • Defined in global.ts:200

    • Optional authorizationParams

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

    Optional

    +
  • Defined in global.ts:117

    • Optional authorizeTimeoutInSeconds

    authorizeTimeoutInSeconds?: number
    @@ -86,14 +86,14 @@

    Optional

    +
  • Defined in global.ts:189

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

    +
  • Defined in global.ts:153

    • Optional cacheLocation

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

    OptionalRead more about changing storage options in the Auth0 docs

    +
  • Defined in global.ts:148

    • clientId

    clientId: string

    The Client ID found on your Application settings page

    +
  • Defined in global.ts:134

    • Optional cookieDomain

    cookieDomain?: string
    @@ -121,7 +121,7 @@

    Optional. (eg: .example.com).

    +
  • Defined in global.ts:246

    • domain

    domain: string
    @@ -130,21 +130,21 @@

    domaincustom domains)

    +
  • Defined in global.ts:126

    • Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number

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

    +
  • Defined in global.ts:194

    • Optional issuer

    issuer?: string

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

    +
  • Defined in global.ts:130

    • Optional leeway

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

    Optional

    +
  • Defined in global.ts:140

    • Optional legacySameSiteCookie

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

    Optional

    +
  • Defined in global.ts:214

    • Optional nowProvider

    nowProvider?: (() => number | Promise<number>)
    @@ -181,7 +181,7 @@

    Type declaration

    Returns number | Promise<number>

    +
  • Defined in global.ts:261

    • Optional sessionCheckExpiryDays

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

    Optional

    +
  • Defined in global.ts:233

    • Optional useCookiesForTransactions

    useCookiesForTransactions?: boolean
    @@ -201,7 +201,7 @@

    Notes

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

    +
  • Defined in global.ts:227

    • Optional useFormData

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

    Optional

    +
  • Defined in global.ts:254

    • Optional useRefreshTokens

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

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

    +
  • Defined in global.ts:161

    • Optional useRefreshTokensFallback

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

    Example

    let
    +
  • Defined in global.ts:183
    • diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 9db4bbab5..37a994ae1 100644 --- a/docs/interfaces/AuthorizationParams.html +++ b/docs/interfaces/AuthorizationParams.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in global.ts:3
    • @@ -52,14 +52,14 @@

    Properties

    Optional acr_values

    acr_values?: string
    +
  • Defined in global.ts:56

    • Optional audience

    audience?: string

    The default audience to be used for requesting API access.

    +
  • Defined in global.ts:71

    • Optional connection

    connection?: string
    @@ -68,7 +68,7 @@

    Optional

    +
  • Defined in global.ts:78

    • Optional display

    display?: "page" | "popup" | "touch" | "wap"
    @@ -80,21 +80,21 @@

    Optional

    +
  • Defined in global.ts:10

    • Optional id_token_hint

    id_token_hint?: string

    Previously issued ID Token.

    +
  • Defined in global.ts:36

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

    +
  • Defined in global.ts:94

    • Optional login_hint

    login_hint?: string
    @@ -104,7 +104,7 @@

    OptionalThis currently only affects the classic Lock experience.

    +
  • Defined in global.ts:54

    • Optional max_age

    max_age?: string | number
    @@ -113,7 +113,7 @@

    Optional

    +
  • Defined in global.ts:25

    • Optional organization

    organization?: string
    @@ -125,7 +125,7 @@

    Optional

    +
  • Defined in global.ts:89

    • Optional prompt

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

    Optional

    +
  • Defined in global.ts:18

    • Optional redirect_uri

    redirect_uri?: string
    @@ -148,7 +148,7 @@

    Optional

    +
  • Defined in global.ts:103

    • Optional scope

    scope?: string
    @@ -158,7 +158,7 @@

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

    +
  • Defined in global.ts:66

    • Optional screen_hint

    screen_hint?: string
    @@ -168,7 +168,7 @@

    OptionalThis only affects the New Universal Login Experience.

    +
  • Defined in global.ts:45

    • Optional ui_locales

    ui_locales?: string
    @@ -176,7 +176,7 @@

    Optional'fr-CA fr en'.

    +
  • Defined in global.ts:31
    • diff --git a/docs/interfaces/DecodedToken.html b/docs/interfaces/DecodedToken.html index ac7076022..b9a62395d 100644 --- a/docs/interfaces/DecodedToken.html +++ b/docs/interfaces/DecodedToken.html @@ -20,7 +20,7 @@

    Hierarchy

    • DecodedToken
    +
  • Defined in cache/shared.ts:64
    • @@ -37,12 +37,12 @@

    Properties

    claims

    claims: IdToken
    +
  • Defined in cache/shared.ts:65

    • user

    user: User
    +
  • Defined in cache/shared.ts:66
    • diff --git a/docs/interfaces/GetTokenSilentlyOptions.html b/docs/interfaces/GetTokenSilentlyOptions.html index 47ff6d0d3..3123f2ed9 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • GetTokenSilentlyOptions
    +
  • Defined in global.ts:352
    • @@ -63,7 +63,7 @@
    Optional scope

    The scope that was used in the authentication request

    +
  • Defined in global.ts:364

    • Optional cacheMode

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

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

    +
  • Defined in global.ts:359

    • Optional detailedResponse

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

    OptionalThe default is false.

    +
  • Defined in global.ts:403

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in global.ts:395
    • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 723be7918..0c6595bf1 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • GetTokenWithPopupOptions
    +
  • Defined in global.ts:406
    • @@ -43,7 +43,7 @@

    Optional

    +
  • Defined in global.ts:117

    • Optional cacheMode

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

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

    +
  • Defined in global.ts:412
    • diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 655d70f64..370f33f9c 100644 --- a/docs/interfaces/ICache.html +++ b/docs/interfaces/ICache.html @@ -24,7 +24,7 @@

    Implemented by

    +
  • Defined in cache/shared.ts:99
    • @@ -46,7 +46,7 @@

    Optional

    Returns MaybePromise<string[]>

    +
  • Defined in cache/shared.ts:103

    • get

      @@ -64,7 +64,7 @@

      Parameters

      key: string

    Returns MaybePromise<undefined | T>

    +
  • Defined in cache/shared.ts:101

    • remove

      @@ -77,7 +77,7 @@

      Parameters

      key: string

    Returns MaybePromise<void>

    +
  • Defined in cache/shared.ts:102

    • set

    Returns MaybePromise<void>

    +
  • Defined in cache/shared.ts:100
    • diff --git a/docs/interfaces/IdToken.html b/docs/interfaces/IdToken.html index ba822be72..e09a0b921 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in global.ts:561
    • @@ -76,192 +76,192 @@

    Properties

    __raw

    __raw: string
    +
  • Defined in global.ts:562

    • Optional acr

    acr?: string
    +
  • Defined in global.ts:593

    • Optional address

    address?: string
    +
  • Defined in global.ts:580

    • Optional amr

    amr?: string[]
    +
  • Defined in global.ts:594

    • Optional at_hash

    at_hash?: string
    +
  • Defined in global.ts:591

    • Optional aud

    aud?: string
    +
  • Defined in global.ts:583

    • Optional auth_time

    auth_time?: string
    +
  • Defined in global.ts:590

    • Optional azp

    azp?: string
    +
  • Defined in global.ts:588

    • Optional birthdate

    birthdate?: string
    +
  • Defined in global.ts:575

    • Optional c_hash

    c_hash?: string
    +
  • Defined in global.ts:592

    • Optional cnf

    cnf?: string
    +
  • Defined in global.ts:596

    • Optional email

    email?: string
    +
  • Defined in global.ts:572

    • Optional email_verified

    email_verified?: boolean
    +
  • Defined in global.ts:573

    • Optional exp

    exp?: number
    +
  • Defined in global.ts:584

    • Optional family_name

    family_name?: string
    +
  • Defined in global.ts:565

    • Optional gender

    gender?: string
    +
  • Defined in global.ts:574

    • Optional given_name

    given_name?: string
    +
  • Defined in global.ts:564

    • Optional iat

    iat?: number
    +
  • Defined in global.ts:586

    • Optional iss

    iss?: string
    +
  • Defined in global.ts:582

    • Optional jti

    jti?: string
    +
  • Defined in global.ts:587

    • Optional locale

    locale?: string
    +
  • Defined in global.ts:577

    • Optional middle_name

    middle_name?: string
    +
  • Defined in global.ts:566

    • Optional name

    name?: string
    +
  • Defined in global.ts:563

    • Optional nbf

    nbf?: number
    +
  • Defined in global.ts:585

    • Optional nickname

    nickname?: string
    +
  • Defined in global.ts:567

    • Optional nonce

    nonce?: string
    +
  • Defined in global.ts:589

    • Optional org_id

    org_id?: string
    +
  • Defined in global.ts:598

    • Optional org_name

    org_name?: string
    +
  • Defined in global.ts:599

    • Optional phone_number

    phone_number?: string
    +
  • Defined in global.ts:578

    • Optional phone_number_verified

    phone_number_verified?: boolean
    +
  • Defined in global.ts:579

    • Optional picture

    picture?: string
    +
  • Defined in global.ts:570

    • Optional preferred_username

    preferred_username?: string
    +
  • Defined in global.ts:568

    • Optional profile

    profile?: string
    +
  • Defined in global.ts:569

    • Optional sid

    sid?: string
    +
  • Defined in global.ts:597

    • Optional sub_jwk

    sub_jwk?: string
    +
  • Defined in global.ts:595

    • Optional updated_at

    updated_at?: string
    +
  • Defined in global.ts:581

    • Optional website

    website?: string
    +
  • Defined in global.ts:571

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in global.ts:576
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 0672f39d7..7c9717471 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • LogoutOptions
    +
  • Defined in global.ts:460
    • @@ -47,7 +47,7 @@

    Optional

    +
  • Defined in global.ts:425

    • Optional logoutParams

    logoutParams?: {
        federated?: boolean;
        returnTo?: string;
        [key: string]: any;
    }
    @@ -79,7 +79,7 @@
    Optional returnTo
    +
  • Defined in global.ts:431

    • Optional onRedirect

    onRedirect?: ((url: string) => Promise<void>)
    @@ -104,7 +104,7 @@

    Parameters

    url: string

    Returns Promise<void>

    +
  • Defined in global.ts:472

    • Optional openUrl

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

    Example

    import<
    +
  • Defined in global.ts:495
    • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 73bccc088..c09aa0729 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    +
  • Defined in global.ts:415
    • @@ -44,7 +44,7 @@

    OptionalRead more about how redirecting after logout works

    +
  • Defined in global.ts:425

    • Optional logoutParams

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

    +
  • Defined in global.ts:431
    • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index af8f5bd97..aca1dba74 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • PopupConfigOptions
    +
  • Defined in global.ts:337
    • @@ -41,7 +41,7 @@

    Optional

    +
  • Defined in global.ts:349

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in global.ts:342
    • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 3f51ac54c..2cb58f6cd 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -24,7 +24,7 @@

    Hierarchy

    +
  • Defined in global.ts:335
    • @@ -44,7 +44,7 @@

    Optional

    +
  • Defined in global.ts:117
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 731097772..abdc5751f 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

    • RedirectLoginOptions
    +
  • Defined in global.ts:283
    • @@ -49,7 +49,7 @@

    Optional

    Used to store state before doing the redirect

    +
  • Defined in global.ts:288

    • Optional authorizationParams

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

    Optional

    +
  • Defined in global.ts:117

    • Optional fragment

    fragment?: string

    Used to add to the URL fragment before redirecting

    +
  • Defined in global.ts:292

    • Optional onRedirect

    onRedirect?: ((url: string) => Promise<void>)
    @@ -90,7 +90,7 @@

    Parameters

    url: string

    Returns Promise<void>

    +
  • Defined in global.ts:304

    • Optional openUrl

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

    Parameters

    url: string

    Returns void | Promise<void>

    +
  • Defined in global.ts:325
    • diff --git a/docs/interfaces/RedirectLoginResult.html b/docs/interfaces/RedirectLoginResult.html index 91daa401c..20acb6bd0 100644 --- a/docs/interfaces/RedirectLoginResult.html +++ b/docs/interfaces/RedirectLoginResult.html @@ -25,7 +25,7 @@

    Hierarchy

    • RedirectLoginResult
    +
  • Defined in global.ts:328
    • @@ -43,7 +43,7 @@

    Optional

    State stored when the redirect request was made

    +
  • Defined in global.ts:332
    • diff --git a/docs/types/CacheEntry.html b/docs/types/CacheEntry.html index 54ba9838e..aed53ac03 100644 --- a/docs/types/CacheEntry.html +++ b/docs/types/CacheEntry.html @@ -38,7 +38,7 @@
    Optional refresh_token
    scope: string
    +
  • Defined in cache/shared.ts:74
    • diff --git a/docs/types/CacheKeyData.html b/docs/types/CacheKeyData.html index 8313e34a3..5fd77121e 100644 --- a/docs/types/CacheKeyData.html +++ b/docs/types/CacheKeyData.html @@ -26,7 +26,7 @@
    clientId:
    Optional scope?: string
    +
  • Defined in cache/shared.ts:6
    • diff --git a/docs/types/CacheLocation.html b/docs/types/CacheLocation.html index 21a795738..5caf1a7f6 100644 --- a/docs/types/CacheLocation.html +++ b/docs/types/CacheLocation.html @@ -19,7 +19,7 @@

    Type alias CacheLocation

    The possible locations where tokens can be stored

    +
  • Defined in global.ts:267
    • diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index 77b1c1e6d..11e8d8000 100644 --- a/docs/types/Cacheable.html +++ b/docs/types/Cacheable.html @@ -17,7 +17,7 @@

    Type alias Cacheable

    Cacheable: WrappedCacheEntry | KeyManifestEntry
    +
  • Defined in cache/shared.ts:95
    • diff --git a/docs/types/GetTokenSilentlyVerboseResponse.html b/docs/types/GetTokenSilentlyVerboseResponse.html index 971b671cd..035c00a78 100644 --- a/docs/types/GetTokenSilentlyVerboseResponse.html +++ b/docs/types/GetTokenSilentlyVerboseResponse.html @@ -17,7 +17,7 @@

    Type alias GetTokenSilentlyVerboseResponse

    GetTokenSilentlyVerboseResponse: Omit<TokenEndpointResponse, "refresh_token">
    +
  • Defined in global.ts:638
    • diff --git a/docs/types/KeyManifestEntry.html b/docs/types/KeyManifestEntry.html index 039152f60..37c14906b 100644 --- a/docs/types/KeyManifestEntry.html +++ b/docs/types/KeyManifestEntry.html @@ -22,7 +22,7 @@

    Type declaration

  • keys: string[]
    • +
  • Defined in cache/shared.ts:91
    • diff --git a/docs/types/MaybePromise.html b/docs/types/MaybePromise.html index 696cb17b7..d55e335d5 100644 --- a/docs/types/MaybePromise.html +++ b/docs/types/MaybePromise.html @@ -22,7 +22,7 @@

    Type Parameters

  • T

    • +
  • Defined in cache/shared.ts:97
    • diff --git a/docs/types/TokenEndpointResponse.html b/docs/types/TokenEndpointResponse.html index 04a602aec..ae035aded 100644 --- a/docs/types/TokenEndpointResponse.html +++ b/docs/types/TokenEndpointResponse.html @@ -30,7 +30,7 @@
    Optional refresh_token
    Optional scope?: string
    +
  • Defined in global.ts:521
    • diff --git a/docs/types/WrappedCacheEntry.html b/docs/types/WrappedCacheEntry.html index 8803b0e98..6b2066fb0 100644 --- a/docs/types/WrappedCacheEntry.html +++ b/docs/types/WrappedCacheEntry.html @@ -24,7 +24,7 @@
    body:
    expiresAt: number
    +
  • Defined in cache/shared.ts:86
    • diff --git a/package-lock.json b/package-lock.json index 4df36e747..6e59fc757 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-spa-js", - "version": "2.1.0", + "version": "2.1.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-spa-js", - "version": "2.1.0", + "version": "2.1.1", "license": "MIT", "devDependencies": { "@auth0/component-cdn-uploader": "github:auth0/component-cdn-uploader#v2.2.2", diff --git a/package.json b/package.json index 84983b513..500ea6c9c 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.1.0", + "version": "2.1.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 6bbb04c10..9972c23b5 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.1.0'; +export default '2.1.1';