diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ae6541b4..fb1e51823 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,15 +1,28 @@ # Change Log +## [v2.0.5](https://github.com/auth0/auth0-spa-js/tree/v2.0.5) (2023-05-22) + +[Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.4...v2.0.5) + +**Changed** + +- distinguish between missing and invalid state [\#1099](https://github.com/auth0/auth0-spa-js/pull/1099) ([frederikprijck](https://github.com/frederikprijck)) +- Allow sync openUrl [\#1087](https://github.com/auth0/auth0-spa-js/pull/1087) ([adamjmcgrath](https://github.com/adamjmcgrath)) + ## [v2.0.4](https://github.com/auth0/auth0-spa-js/tree/v2.0.4) (2023-02-22) + [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.3...v2.0.4) **Fixed** + - Correctly expose missing_refresh_token error from worker [\#1080](https://github.com/auth0/auth0-spa-js/pull/1080) ([frederikprijck](https://github.com/frederikprijck)) ## [v2.0.3](https://github.com/auth0/auth0-spa-js/tree/v2.0.3) (2023-02-04) + [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.2...v2.0.3) **Fixed** + - Ensure cookieDomain is used when using legacy Cookiestorage [\#1071](https://github.com/auth0/auth0-spa-js/pull/1071) ([frederikprijck](https://github.com/frederikprijck)) - Ensure to only clear current client cache when logging out [\#1068](https://github.com/auth0/auth0-spa-js/pull/1068) ([frederikprijck](https://github.com/frederikprijck)) @@ -26,12 +39,15 @@ This patch release is identical to `2.0.1` but has been released to ensure tooli Even though 2.0.1 was not vulnerable for the related [CVE](https://unit42.paloaltonetworks.com/jsonwebtoken-vulnerability-cve-2022-23529/) because of the fact that `jsonwebtoken` is a devDependency, we are cutting a release to ensure build tools no longer report our SDK as vulnerable to the mentioned CVE. ## [v2.0.1](https://github.com/auth0/auth0-spa-js/tree/v2.0.1) (2022-12-08) + [Full Changelog](https://github.com/auth0/auth0-spa-js/compare/v2.0.0...v2.0.1) **Changed** + - Add openUrl and deprecate onRedirect [\#1058](https://github.com/auth0/auth0-spa-js/pull/1058) ([frederikprijck](https://github.com/frederikprijck)) **Fixed** + - Export MissingRefreshTokenError [\#1043](https://github.com/auth0/auth0-spa-js/pull/1043) ([frederikprijck](https://github.com/frederikprijck)) ## [v2.0.0](https://github.com/auth0/auth0-spa-js/tree/v2.0.0) (2022-10-27) diff --git a/docs/classes/Auth0Client.html b/docs/classes/Auth0Client.html index 804036db6..0519230db 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:564

    • getIdTokenClaims

    +
  • Defined in Auth0Client.ts:428

    • getTokenSilently

    Returns Promise<GetTokenSilentlyVerboseResponse>

    +
  • Defined in Auth0Client.ts:589

  • Fetches a new access token and returns it.

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

    Parameters

    Optional options: GetTokenSilentlyOptions

    • Returns Promise<string>

    +
  • Defined in Auth0Client.ts:598

    • getTokenWithPopup

    Returns Promise<undefined | string>

    +
  • Defined in Auth0Client.ts:743

    • getUser

    Returns Promise<undefined | TUser>

    +
  • Defined in Auth0Client.ts:415

    • handleRedirectCallback

    Returns Promise<RedirectLoginResult<TAppState>>

    +
  • Defined in Auth0Client.ts:480

    • isAuthenticated

    +
  • Defined in Auth0Client.ts:783

    • loginWithPopup

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:348

    • loginWithRedirect

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:445

    • logout

    Returns Promise<void>

    +
  • Defined in Auth0Client.ts:828
    • diff --git a/docs/classes/AuthenticationError.html b/docs/classes/AuthenticationError.html index c1c986752..39beb2dec 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 c54d36c3c..68e4914a0 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 52abd0e7c..9f1ff922f 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 17a8a6557..97fcaf120 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 ae4622e46..4d6f9de85 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

    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 e8008959c..53c1deb35 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 85a79df5e..b7041e825 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 c97ee0513..7a924161c 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 887d3a9d7..21f2dc22d 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 3867b6776..55b74ccea 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 355de9622..48398f204 100644 --- a/docs/classes/User.html +++ b/docs/classes/User.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

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

    Properties

    Optional address

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

    • Optional birthdate

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

    • Optional email

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

    • Optional email_verified

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

    • Optional family_name

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

    • Optional gender

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

    • Optional given_name

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

    • Optional locale

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

    • Optional middle_name

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

    • Optional name

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

    • Optional nickname

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

    • Optional phone_number

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

    • Optional phone_number_verified

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

    • Optional picture

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

    • Optional preferred_username

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

    • Optional profile

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

    • Optional sub

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

    • Optional updated_at

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

    • Optional website

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

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in global.ts:613
    • diff --git a/docs/functions/createAuth0Client.html b/docs/functions/createAuth0Client.html index 7c08eee7b..5038dcf99 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/interfaces/Auth0ClientOptions.html b/docs/interfaces/Auth0ClientOptions.html index ed446e09b..fea154f01 100644 --- a/docs/interfaces/Auth0ClientOptions.html +++ b/docs/interfaces/Auth0ClientOptions.html @@ -22,7 +22,7 @@

    Hierarchy

    • Auth0ClientOptions
    +
  • Defined in global.ts:117
    • @@ -69,7 +69,7 @@
    name:
    version: string
    +
  • Defined in global.ts:197

    • Optional authorizationParams

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

    Optional

    +
  • Defined in global.ts:114

    • Optional authorizeTimeoutInSeconds

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

    Optional

    +
  • Defined in global.ts:186

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

    • Optional cacheLocation

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

    OptionalRead more about changing storage options in the Auth0 docs

    +
  • Defined in global.ts:145

    • clientId

    clientId: string

    The Client ID found on your Application settings page

    +
  • Defined in global.ts:131

    • Optional cookieDomain

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

    Optional. (eg: .example.com).

    +
  • Defined in global.ts:243

    • domain

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

    domaincustom domains)

    +
  • Defined in global.ts:123

    • Optional httpTimeoutInSeconds

    httpTimeoutInSeconds?: number

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

    +
  • Defined in global.ts:191

    • Optional issuer

    issuer?: string

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

    +
  • Defined in global.ts:127

    • Optional leeway

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

    Optional

    +
  • Defined in global.ts:137

    • Optional legacySameSiteCookie

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

    Optional

    +
  • Defined in global.ts:211

    • Optional nowProvider

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

    Type declaration

    Returns number | Promise<number>

    +
  • Defined in global.ts:258

    • Optional sessionCheckExpiryDays

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

    Optional

    +
  • Defined in global.ts:230

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

    • Optional useFormData

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

    Optional

    +
  • Defined in global.ts:251

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

    • Optional useRefreshTokensFallback

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

    Example

    let
    +
  • Defined in global.ts:180
    • diff --git a/docs/interfaces/AuthorizationParams.html b/docs/interfaces/AuthorizationParams.html index 0c6a2940a..d43dc0c4e 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:91

    • 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
    @@ -122,7 +122,7 @@

    Optionalorg_id claim in your user's ID Token.

    +
  • Defined in global.ts:86

    • Optional prompt

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

    Optional

    +
  • Defined in global.ts:18

    • Optional redirect_uri

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

    Optional

    +
  • Defined in global.ts:100

    • Optional scope

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

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

    +
  • Defined in global.ts:66

    • Optional screen_hint

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

    OptionalThis only affects the New Universal Login Experience.

    +
  • Defined in global.ts:45

    • Optional ui_locales

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

    Optional'fr-CA fr en'.

    +
  • Defined in global.ts:31
    • diff --git a/docs/interfaces/DecodedToken.html b/docs/interfaces/DecodedToken.html index 3818725e5..b924ae150 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 fa244e28e..9ef727b18 100644 --- a/docs/interfaces/GetTokenSilentlyOptions.html +++ b/docs/interfaces/GetTokenSilentlyOptions.html @@ -20,7 +20,7 @@

    Hierarchy

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

    The scope that was used in the authentication request

    +
  • Defined in global.ts:361

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

    • Optional detailedResponse

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

    OptionalThe default is false.

    +
  • Defined in global.ts:400

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in global.ts:392
    • diff --git a/docs/interfaces/GetTokenWithPopupOptions.html b/docs/interfaces/GetTokenWithPopupOptions.html index 548e29073..ebdcf4107 100644 --- a/docs/interfaces/GetTokenWithPopupOptions.html +++ b/docs/interfaces/GetTokenWithPopupOptions.html @@ -22,7 +22,7 @@

    Hierarchy

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

    Optional

    +
  • Defined in global.ts:114

    • 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:409
    • diff --git a/docs/interfaces/ICache.html b/docs/interfaces/ICache.html index 1d67f5ebc..840218927 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

    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 07b87dd31..ef176907c 100644 --- a/docs/interfaces/IdToken.html +++ b/docs/interfaces/IdToken.html @@ -23,7 +23,7 @@

    Hierarchy

    Indexable

    [key: string]: any
    +
  • Defined in global.ts:558
    • @@ -75,187 +75,187 @@

    Properties

    __raw

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

    • Optional acr

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

    • Optional address

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

    • Optional amr

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

    • Optional at_hash

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

    • Optional aud

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

    • Optional auth_time

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

    • Optional azp

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

    • Optional birthdate

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

    • Optional c_hash

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

    • Optional cnf

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

    • Optional email

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

    • Optional email_verified

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

    • Optional exp

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

    • Optional family_name

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

    • Optional gender

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

    • Optional given_name

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

    • Optional iat

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

    • Optional iss

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

    • Optional jti

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

    • Optional locale

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

    • Optional middle_name

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

    • Optional name

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

    • Optional nbf

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

    • Optional nickname

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

    • Optional nonce

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

    • Optional org_id

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

    • Optional phone_number

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

    • Optional phone_number_verified

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

    • Optional picture

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

    • Optional preferred_username

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

    • Optional profile

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

    • Optional sid

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

    • Optional sub_jwk

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

    • Optional updated_at

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

    • Optional website

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

    • Optional zoneinfo

    zoneinfo?: string
    +
  • Defined in global.ts:573
    • diff --git a/docs/interfaces/LogoutOptions.html b/docs/interfaces/LogoutOptions.html index 8baeb71c2..4eca8689b 100644 --- a/docs/interfaces/LogoutOptions.html +++ b/docs/interfaces/LogoutOptions.html @@ -22,7 +22,7 @@

    Hierarchy

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

    Optional

    +
  • Defined in global.ts:422

    • Optional logoutParams

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

    • Optional onRedirect

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

    Parameters

    url: string

    Returns Promise<void>

    +
  • Defined in global.ts:469

    • Optional openUrl

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

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

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

    -

    Example

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

    await auth0.logout({
      async openUrl(url) {
        await Browser.open({ url });
      }
    });
    +
  • Defined in global.ts:492
    • diff --git a/docs/interfaces/LogoutUrlOptions.html b/docs/interfaces/LogoutUrlOptions.html index 1cc386778..e3b5247d2 100644 --- a/docs/interfaces/LogoutUrlOptions.html +++ b/docs/interfaces/LogoutUrlOptions.html @@ -22,7 +22,7 @@

    Hierarchy

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

    OptionalRead more about how redirecting after logout works

    +
  • Defined in global.ts:422

    • 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:428
    • diff --git a/docs/interfaces/PopupConfigOptions.html b/docs/interfaces/PopupConfigOptions.html index 353485af1..3ec84a9bd 100644 --- a/docs/interfaces/PopupConfigOptions.html +++ b/docs/interfaces/PopupConfigOptions.html @@ -20,7 +20,7 @@

    Hierarchy

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

    Optional

    +
  • Defined in global.ts:346

    • Optional timeoutInSeconds

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

    Optional

    +
  • Defined in global.ts:339
    • diff --git a/docs/interfaces/PopupLoginOptions.html b/docs/interfaces/PopupLoginOptions.html index 477f78ca0..f0bbe2d8e 100644 --- a/docs/interfaces/PopupLoginOptions.html +++ b/docs/interfaces/PopupLoginOptions.html @@ -24,7 +24,7 @@

    Hierarchy

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

    Optional

    +
  • Defined in global.ts:114
    • diff --git a/docs/interfaces/RedirectLoginOptions.html b/docs/interfaces/RedirectLoginOptions.html index 5f35105fc..982a1f1f7 100644 --- a/docs/interfaces/RedirectLoginOptions.html +++ b/docs/interfaces/RedirectLoginOptions.html @@ -27,7 +27,7 @@

    Hierarchy

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

    Optional

    Used to store state before doing the redirect

    +
  • Defined in global.ts:285

    • Optional authorizationParams

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

    Optional

    +
  • Defined in global.ts:114

    • Optional fragment

    fragment?: string

    Used to add to the URL fragment before redirecting

    +
  • Defined in global.ts:289

    • Optional onRedirect

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

    Parameters

    url: string

    Returns Promise<void>

    +
  • Defined in global.ts:301

    • Optional openUrl

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

    Type declaration

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

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

        -

        Example

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

        const client = new Auth0Client({
          async openUrl(url) {
            await Browser.open({ url });
          }
        });
        @@ -111,9 +114,9 @@

        Parameters

        • url: string
        -

        Returns Promise<void>

    +
  • Defined in global.ts:322
    • diff --git a/docs/interfaces/RedirectLoginResult.html b/docs/interfaces/RedirectLoginResult.html index 4915dec8f..540a253fe 100644 --- a/docs/interfaces/RedirectLoginResult.html +++ b/docs/interfaces/RedirectLoginResult.html @@ -25,7 +25,7 @@

    Hierarchy

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

    Optional

    State stored when the redirect request was made

    +
  • Defined in global.ts:329
    • diff --git a/docs/types/CacheEntry.html b/docs/types/CacheEntry.html index f58555607..040cce781 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 27bd5bdbd..fa2995e40 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 216034f7c..262b37219 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:264
    • diff --git a/docs/types/Cacheable.html b/docs/types/Cacheable.html index d8ff55b1a..37345bd40 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 199145818..78985501e 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:634
    • diff --git a/docs/types/KeyManifestEntry.html b/docs/types/KeyManifestEntry.html index 11f7f3a1d..92850190c 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 804870c7f..bfea06407 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 54d9163a4..fb38d67a5 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:518
    • diff --git a/docs/types/WrappedCacheEntry.html b/docs/types/WrappedCacheEntry.html index b9dc2e7e6..03fac0086 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 5072a98d4..b87cf1511 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@auth0/auth0-spa-js", - "version": "2.0.4", + "version": "2.0.5", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@auth0/auth0-spa-js", - "version": "2.0.4", + "version": "2.0.5", "license": "MIT", "devDependencies": { "@auth0/component-cdn-uploader": "github:auth0/component-cdn-uploader#v2.2.2", diff --git a/package.json b/package.json index b001d3639..2b24edbb1 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.0.4", + "version": "2.0.5", "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 9938f966d..db725a88b 100644 --- a/src/version.ts +++ b/src/version.ts @@ -1 +1 @@ -export default '2.0.4'; +export default '2.0.5';